include/linux/pci_hotplug.h

   1 /*
   2  * PCI HotPlug Core Functions
   3  *
   4  * Copyright (C) 1995,2001 Compaq Computer Corporation
   5  * Copyright (C) 2001 Greg Kroah-Hartman (greg@kroah.com)
   6  * Copyright (C) 2001 IBM Corp.
   7  *
   8  * All rights reserved.
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or (at
  13  * your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful, but
  16  * WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
  18  * NON INFRINGEMENT.  See the GNU General Public License for more
  19  * details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  24  *
  25  * Send feedback to <kristen.c.accardi@intel.com>
  26  *
  27  */
  28 #ifndef _PCI_HOTPLUG_H
  29 #define _PCI_HOTPLUG_H
  30
  31 /* These values come from the PCI Express Spec */
  32 enum pcie_link_width {
  33         PCIE_LNK_WIDTH_RESRV    = 0x00,
  34         PCIE_LNK_X1             = 0x01,
  35         PCIE_LNK_X2             = 0x02,
  36         PCIE_LNK_X4             = 0x04,
  37         PCIE_LNK_X8             = 0x08,
  38         PCIE_LNK_X12            = 0x0C,
  39         PCIE_LNK_X16            = 0x10,
  40         PCIE_LNK_X32            = 0x20,
  41         PCIE_LNK_WIDTH_UNKNOWN  = 0xFF,
  42 };
  43
  44 /**
  45  * struct hotplug_slot_ops -the callbacks that the hotplug pci core can use
  46  * @owner: The module owner of this structure
  47  * @mod_name: The module name (KBUILD_MODNAME) of this structure
  48  * @enable_slot: Called when the user wants to enable a specific pci slot
  49  * @disable_slot: Called when the user wants to disable a specific pci slot
  50  * @set_attention_status: Called to set the specific slot's attention LED to
  51  * the specified value
  52  * @hardware_test: Called to run a specified hardware test on the specified
  53  * slot.
  54  * @get_power_status: Called to get the current power status of a slot.
  55  *      If this field is NULL, the value passed in the struct hotplug_slot_info
  56  *      will be used when this value is requested by a user.
  57  * @get_attention_status: Called to get the current attention status of a slot.
  58  *      If this field is NULL, the value passed in the struct hotplug_slot_info
  59  *      will be used when this value is requested by a user.
  60  * @get_latch_status: Called to get the current latch status of a slot.
  61  *      If this field is NULL, the value passed in the struct hotplug_slot_info
  62  *      will be used when this value is requested by a user.
  63  * @get_adapter_status: Called to get see if an adapter is present in the slot or not.
  64  *      If this field is NULL, the value passed in the struct hotplug_slot_info
  65  *      will be used when this value is requested by a user.
  66  * @reset_slot: Optional interface to allow override of a bus reset for the
  67  *      slot for cases where a secondary bus reset can result in spurious
  68  *      hotplug events or where a slot can be reset independent of the bus.
  69  *
  70  * The table of function pointers that is passed to the hotplug pci core by a
  71  * hotplug pci driver.  These functions are called by the hotplug pci core when
  72  * the user wants to do something to a specific slot (query it for information,
  73  * set an LED, enable / disable power, etc.)
  74  */
  75 struct hotplug_slot_ops {
  76         struct module *owner;
  77         const char *mod_name;
  78         int (*enable_slot)              (struct hotplug_slot *slot);
  79         int (*disable_slot)             (struct hotplug_slot *slot);
  80         int (*set_attention_status)     (struct hotplug_slot *slot, u8 value);
  81         int (*hardware_test)            (struct hotplug_slot *slot, u32 value);
  82         int (*get_power_status)         (struct hotplug_slot *slot, u8 *value);
  83         int (*get_attention_status)     (struct hotplug_slot *slot, u8 *value);
  84         int (*get_latch_status)         (struct hotplug_slot *slot, u8 *value);
  85         int (*get_adapter_status)       (struct hotplug_slot *slot, u8 *value);
  86         int (*reset_slot)               (struct hotplug_slot *slot, int probe);
  87 };
  88
  89 /**
  90  * struct hotplug_slot_info - used to notify the hotplug pci core of the state of the slot
  91  * @power_status: if power is enabled or not (1/0)
  92  * @attention_status: if the attention light is enabled or not (1/0)
  93  * @latch_status: if the latch (if any) is open or closed (1/0)
  94  * @adapter_status: if there is a pci board present in the slot or not (1/0)
  95  *
  96  * Used to notify the hotplug pci core of the status of a specific slot.
  97  */
  98 struct hotplug_slot_info {
  99         u8      power_status;
 100         u8      attention_status;
 101         u8      latch_status;
 102         u8      adapter_status;
 103 };
 104
 105 /**
 106  * struct hotplug_slot - used to register a physical slot with the hotplug pci core
 107  * @ops: pointer to the &struct hotplug_slot_ops to be used for this slot
 108  * @info: pointer to the &struct hotplug_slot_info for the initial values for
 109  * this slot.
 110  * @release: called during pci_hp_deregister to free memory allocated in a
 111  * hotplug_slot structure.
 112  * @private: used by the hotplug pci controller driver to store whatever it
 113  * needs.
 114  */
 115 struct hotplug_slot {
 116         struct hotplug_slot_ops         *ops;
 117         struct hotplug_slot_info        *info;
 118         void (*release) (struct hotplug_slot *slot);
 119         void                            *private;
 120
 121         /* Variables below this are for use only by the hotplug pci core. */
 122         struct list_head                slot_list;
 123         struct pci_slot                 *pci_slot;
 124 };
 125 #define to_hotplug_slot(n) container_of(n, struct hotplug_slot, kobj)
 126
 127 static inline const char *hotplug_slot_name(const struct hotplug_slot *slot)
 128 {
 129         return pci_slot_name(slot->pci_slot);
 130 }
 131
 132 int __pci_hp_register(struct hotplug_slot *slot, struct pci_bus *pbus, int nr,
 133                       const char *name, struct module *owner,
 134                       const char *mod_name);
 135 int pci_hp_deregister(struct hotplug_slot *slot);
 136 int __must_check pci_hp_change_slot_info(struct hotplug_slot *slot,
 137                                          struct hotplug_slot_info *info);
 138
 139 /* use a define to avoid include chaining to get THIS_MODULE & friends */
 140 #define pci_hp_register(slot, pbus, devnr, name) \
 141         __pci_hp_register(slot, pbus, devnr, name, THIS_MODULE, KBUILD_MODNAME)
 142
 143 /* PCI Setting Record (Type 0) */
 144 struct hpp_type0 {
 145         u32 revision;
 146         u8  cache_line_size;
 147         u8  latency_timer;
 148         u8  enable_serr;
 149         u8  enable_perr;
 150 };
 151
 152 /* PCI-X Setting Record (Type 1) */
 153 struct hpp_type1 {
 154         u32 revision;
 155         u8  max_mem_read;
 156         u8  avg_max_split;
 157         u16 tot_max_split;
 158 };
 159
 160 /* PCI Express Setting Record (Type 2) */
 161 struct hpp_type2 {
 162         u32 revision;
 163         u32 unc_err_mask_and;
 164         u32 unc_err_mask_or;
 165         u32 unc_err_sever_and;
 166         u32 unc_err_sever_or;
 167         u32 cor_err_mask_and;
 168         u32 cor_err_mask_or;
 169         u32 adv_err_cap_and;
 170         u32 adv_err_cap_or;
 171         u16 pci_exp_devctl_and;
 172         u16 pci_exp_devctl_or;
 173         u16 pci_exp_lnkctl_and;
 174         u16 pci_exp_lnkctl_or;
 175         u32 sec_unc_err_sever_and;
 176         u32 sec_unc_err_sever_or;
 177         u32 sec_unc_err_mask_and;
 178         u32 sec_unc_err_mask_or;
 179 };
 180
 181 struct hotplug_params {
 182         struct hpp_type0 *t0;           /* Type0: NULL if not available */
 183         struct hpp_type1 *t1;           /* Type1: NULL if not available */
 184         struct hpp_type2 *t2;           /* Type2: NULL if not available */
 185         struct hpp_type0 type0_data;
 186         struct hpp_type1 type1_data;
 187         struct hpp_type2 type2_data;
 188 };
 189
 190 #ifdef CONFIG_ACPI
 191 #include <acpi/acpi.h>
 192 #include <acpi/acpi_bus.h>
 193 int pci_get_hp_params(struct pci_dev *dev, struct hotplug_params *hpp);
 194 int acpi_get_hp_hw_control_from_firmware(struct pci_dev *dev, u32 flags);
 195 int acpi_pci_check_ejectable(struct pci_bus *pbus, acpi_handle handle);
 196 int acpi_pci_detect_ejectable(acpi_handle handle);
 197 #else
 198 static inline int pci_get_hp_params(struct pci_dev *dev,
 199                                     struct hotplug_params *hpp)
 200 {
 201         return -ENODEV;
 202 }
 203 #endif
 204
 205 void pci_configure_slot(struct pci_dev *dev);
 206 #endif
 207