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  * @get_max_bus_speed: Called to get the max bus speed for a slot.
  67  *      If this field is NULL, the value passed in the struct hotplug_slot_info
  68  *      will be used when this value is requested by a user.
  69  * @get_cur_bus_speed: Called to get the current bus speed for a slot.
  70  *      If this field is NULL, the value passed in the struct hotplug_slot_info
  71  *      will be used when this value is requested by a user.
  72  *
  73  * The table of function pointers that is passed to the hotplug pci core by a
  74  * hotplug pci driver.  These functions are called by the hotplug pci core when
  75  * the user wants to do something to a specific slot (query it for information,
  76  * set an LED, enable / disable power, etc.)
  77  */
  78 struct hotplug_slot_ops {
  79         struct module *owner;
  80         const char *mod_name;
  81         int (*enable_slot)              (struct hotplug_slot *slot);
  82         int (*disable_slot)             (struct hotplug_slot *slot);
  83         int (*set_attention_status)     (struct hotplug_slot *slot, u8 value);
  84         int (*hardware_test)            (struct hotplug_slot *slot, u32 value);
  85         int (*get_power_status)         (struct hotplug_slot *slot, u8 *value);
  86         int (*get_attention_status)     (struct hotplug_slot *slot, u8 *value);
  87         int (*get_latch_status)         (struct hotplug_slot *slot, u8 *value);
  88         int (*get_adapter_status)       (struct hotplug_slot *slot, u8 *value);
  89         int (*get_max_bus_speed)        (struct hotplug_slot *slot, enum pci_bus_speed *value);
  90         int (*get_cur_bus_speed)        (struct hotplug_slot *slot, enum pci_bus_speed *value);
  91 };
  92
  93 /**
  94  * struct hotplug_slot_info - used to notify the hotplug pci core of the state of the slot
  95  * @power: if power is enabled or not (1/0)
  96  * @attention_status: if the attention light is enabled or not (1/0)
  97  * @latch_status: if the latch (if any) is open or closed (1/0)
  98  * @adapter_present: if there is a pci board present in the slot or not (1/0)
  99  * @address: (domain << 16 | bus << 8 | dev)
 100  *
 101  * Used to notify the hotplug pci core of the status of a specific slot.
 102  */
 103 struct hotplug_slot_info {
 104         u8      power_status;
 105         u8      attention_status;
 106         u8      latch_status;
 107         u8      adapter_status;
 108         enum pci_bus_speed      max_bus_speed;
 109         enum pci_bus_speed      cur_bus_speed;
 110 };
 111
 112 /**
 113  * struct hotplug_slot - used to register a physical slot with the hotplug pci core
 114  * @ops: pointer to the &struct hotplug_slot_ops to be used for this slot
 115  * @info: pointer to the &struct hotplug_slot_info for the initial values for
 116  * this slot.
 117  * @release: called during pci_hp_deregister to free memory allocated in a
 118  * hotplug_slot structure.
 119  * @private: used by the hotplug pci controller driver to store whatever it
 120  * needs.
 121  */
 122 struct hotplug_slot {
 123         struct hotplug_slot_ops         *ops;
 124         struct hotplug_slot_info        *info;
 125         void (*release) (struct hotplug_slot *slot);
 126         void                            *private;
 127
 128         /* Variables below this are for use only by the hotplug pci core. */
 129         struct list_head                slot_list;
 130         struct pci_slot                 *pci_slot;
 131 };
 132 #define to_hotplug_slot(n) container_of(n, struct hotplug_slot, kobj)
 133
 134 static inline const char *hotplug_slot_name(const struct hotplug_slot *slot)
 135 {
 136         return pci_slot_name(slot->pci_slot);
 137 }
 138
 139 extern int __pci_hp_register(struct hotplug_slot *slot, struct pci_bus *pbus,
 140                              int nr, const char *name,
 141                              struct module *owner, const char *mod_name);
 142 extern int pci_hp_deregister(struct hotplug_slot *slot);
 143 extern int __must_check pci_hp_change_slot_info (struct hotplug_slot *slot,
 144                                                  struct hotplug_slot_info *info);
 145
 146 static inline int pci_hp_register(struct hotplug_slot *slot,
 147                                   struct pci_bus *pbus,
 148                                   int devnr, const char *name)
 149 {
 150         return __pci_hp_register(slot, pbus, devnr, name,
 151                                  THIS_MODULE, KBUILD_MODNAME);
 152 }
 153
 154 /* PCI Setting Record (Type 0) */
 155 struct hpp_type0 {
 156         u32 revision;
 157         u8  cache_line_size;
 158         u8  latency_timer;
 159         u8  enable_serr;
 160         u8  enable_perr;
 161 };
 162
 163 /* PCI-X Setting Record (Type 1) */
 164 struct hpp_type1 {
 165         u32 revision;
 166         u8  max_mem_read;
 167         u8  avg_max_split;
 168         u16 tot_max_split;
 169 };
 170
 171 /* PCI Express Setting Record (Type 2) */
 172 struct hpp_type2 {
 173         u32 revision;
 174         u32 unc_err_mask_and;
 175         u32 unc_err_mask_or;
 176         u32 unc_err_sever_and;
 177         u32 unc_err_sever_or;
 178         u32 cor_err_mask_and;
 179         u32 cor_err_mask_or;
 180         u32 adv_err_cap_and;
 181         u32 adv_err_cap_or;
 182         u16 pci_exp_devctl_and;
 183         u16 pci_exp_devctl_or;
 184         u16 pci_exp_lnkctl_and;
 185         u16 pci_exp_lnkctl_or;
 186         u32 sec_unc_err_sever_and;
 187         u32 sec_unc_err_sever_or;
 188         u32 sec_unc_err_mask_and;
 189         u32 sec_unc_err_mask_or;
 190 };
 191
 192 struct hotplug_params {
 193         struct hpp_type0 *t0;           /* Type0: NULL if not available */
 194         struct hpp_type1 *t1;           /* Type1: NULL if not available */
 195         struct hpp_type2 *t2;           /* Type2: NULL if not available */
 196         struct hpp_type0 type0_data;
 197         struct hpp_type1 type1_data;
 198         struct hpp_type2 type2_data;
 199 };
 200
 201 #ifdef CONFIG_ACPI
 202 #include <acpi/acpi.h>
 203 #include <acpi/acpi_bus.h>
 204 int pci_get_hp_params(struct pci_dev *dev, struct hotplug_params *hpp);
 205 int acpi_get_hp_hw_control_from_firmware(struct pci_dev *dev, u32 flags);
 206 int acpi_pci_check_ejectable(struct pci_bus *pbus, acpi_handle handle);
 207 int acpi_pci_detect_ejectable(acpi_handle handle);
 208 #else
 209 static inline int pci_get_hp_params(struct pci_dev *dev,
 210                                     struct hotplug_params *hpp)
 211 {
 212         return -ENODEV;
 213 }
 214 #endif
 215
 216 void pci_configure_slot(struct pci_dev *dev);
 217 #endif
 218