drivers/hotplug/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 <greg@kroah.com>
  26  *
  27  */
  28 #ifndef _PCI_HOTPLUG_H
  29 #define _PCI_HOTPLUG_H
  30
  31
  32 /* These values come from the PCI Hotplug Spec */
  33 enum pci_bus_speed {
  34         PCI_SPEED_33MHz                 = 0x00,
  35         PCI_SPEED_66MHz                 = 0x01,
  36         PCI_SPEED_66MHz_PCIX            = 0x02,
  37         PCI_SPEED_100MHz_PCIX           = 0x03,
  38         PCI_SPEED_133MHz_PCIX           = 0x04,
  39         PCI_SPEED_66MHz_PCIX_ECC        = 0x05,
  40         PCI_SPEED_100MHz_PCIX_ECC       = 0x06,
  41         PCI_SPEED_133MHz_PCIX_ECC       = 0x07,
  42         PCI_SPEED_66MHz_PCIX_266        = 0x09,
  43         PCI_SPEED_100MHz_PCIX_266       = 0x0a,
  44         PCI_SPEED_133MHz_PCIX_266       = 0x0b,
  45         PCI_SPEED_66MHz_PCIX_533        = 0x11,
  46         PCI_SPEED_100MHz_PCIX_533       = 0x12,
  47         PCI_SPEED_133MHz_PCIX_533       = 0x13,
  48         PCI_SPEED_UNKNOWN               = 0xff,
  49 };
  50
  51 /* These values come from the PCI Express Spec */
  52 enum pcie_link_width {
  53         PCIE_LNK_WIDTH_RESRV    = 0x00,
  54         PCIE_LNK_X1             = 0x01,
  55         PCIE_LNK_X2             = 0x02,
  56         PCIE_LNK_X4             = 0x04,
  57         PCIE_LNK_X8             = 0x08,
  58         PCIE_LNK_X12            = 0x0C,
  59         PCIE_LNK_X16            = 0x10,
  60         PCIE_LNK_X32            = 0x20,
  61         PCIE_LNK_WIDTH_UNKNOWN  = 0xFF,
  62 };
  63
  64 enum pcie_link_speed {
  65         PCIE_2PT5GB             = 0x14,
  66         PCIE_LNK_SPEED_UNKNOWN  = 0xFF,
  67 };
  68
  69 struct hotplug_slot;
  70 struct hotplug_slot_core;
  71
  72 /**
  73  * struct hotplug_slot_ops -the callbacks that the hotplug pci core can use
  74  * @owner: The module owner of this structure
  75  * @enable_slot: Called when the user wants to enable a specific pci slot
  76  * @disable_slot: Called when the user wants to disable a specific pci slot
  77  * @set_attention_status: Called to set the specific slot's attention LED to
  78  * the specified value
  79  * @hardware_test: Called to run a specified hardware test on the specified
  80  * slot.
  81  * @get_power_status: Called to get the current power status of a slot.
  82  *      If this field is NULL, the value passed in the struct hotplug_slot_info
  83  *      will be used when this value is requested by a user.
  84  * @get_attention_status: Called to get the current attention status of a slot.
  85  *      If this field is NULL, the value passed in the struct hotplug_slot_info
  86  *      will be used when this value is requested by a user.
  87  * @get_latch_status: Called to get the current latch status of a slot.
  88  *      If this field is NULL, the value passed in the struct hotplug_slot_info
  89  *      will be used when this value is requested by a user.
  90  * @get_adapter_status: Called to get see if an adapter is present in the slot or not.
  91  *      If this field is NULL, the value passed in the struct hotplug_slot_info
  92  *      will be used when this value is requested by a user.
  93  * @get_address: Called to get pci address of a slot.
  94  *      If this field is NULL, the value passed in the struct hotplug_slot_info
  95  *      will be used when this value is requested by a user.
  96  * @get_max_bus_speed: Called to get the max bus speed for a slot.
  97  *      If this field is NULL, the value passed in the struct hotplug_slot_info
  98  *      will be used when this value is requested by a user.
  99  * @get_cur_bus_speed: Called to get the current bus speed for a slot.
 100  *      If this field is NULL, the value passed in the struct hotplug_slot_info
 101  *      will be used when this value is requested by a user.
 102  *
 103  * The table of function pointers that is passed to the hotplug pci core by a
 104  * hotplug pci driver.  These functions are called by the hotplug pci core when
 105  * the user wants to do something to a specific slot (query it for information,
 106  * set an LED, enable / disable power, etc.)
 107  */
 108 struct hotplug_slot_ops {
 109         struct module *owner;
 110         int (*enable_slot)              (struct hotplug_slot *slot);
 111         int (*disable_slot)             (struct hotplug_slot *slot);
 112         int (*set_attention_status)     (struct hotplug_slot *slot, u8 value);
 113         int (*hardware_test)            (struct hotplug_slot *slot, u32 value);
 114         int (*get_power_status)         (struct hotplug_slot *slot, u8 *value);
 115         int (*get_attention_status)     (struct hotplug_slot *slot, u8 *value);
 116         int (*get_latch_status)         (struct hotplug_slot *slot, u8 *value);
 117         int (*get_adapter_status)       (struct hotplug_slot *slot, u8 *value);
 118         int (*get_address)              (struct hotplug_slot *slot, u32 *value);
 119         int (*get_max_bus_speed)        (struct hotplug_slot *slot, enum pci_bus_speed *value);
 120         int (*get_cur_bus_speed)        (struct hotplug_slot *slot, enum pci_bus_speed *value);
 121 };
 122
 123 /**
 124  * struct hotplug_slot_info - used to notify the hotplug pci core of the state of the slot
 125  * @power: if power is enabled or not (1/0)
 126  * @attention_status: if the attention light is enabled or not (1/0)
 127  * @latch_status: if the latch (if any) is open or closed (1/0)
 128  * @adapter_present: if there is a pci board present in the slot or not (1/0)
 129  * @address: (domain << 16 | bus << 8 | dev)
 130  *
 131  * Used to notify the hotplug pci core of the status of a specific slot.
 132  */
 133 struct hotplug_slot_info {
 134         u8      power_status;
 135         u8      attention_status;
 136         u8      latch_status;
 137         u8      adapter_status;
 138         u32     address;
 139         enum pci_bus_speed      max_bus_speed;
 140         enum pci_bus_speed      cur_bus_speed;
 141 };
 142
 143 /**
 144  * struct hotplug_slot - used to register a physical slot with the hotplug pci core
 145  * @name: the name of the slot being registered.  This string must
 146  * be unique amoung slots registered on this system.
 147  * @ops: pointer to the &struct hotplug_slot_ops to be used for this slot
 148  * @info: pointer to the &struct hotplug_slot_info for the inital values for
 149  * this slot.
 150  * @private: used by the hotplug pci controller driver to store whatever it
 151  * needs.
 152  */
 153 struct hotplug_slot {
 154         char                            *name;
 155         struct hotplug_slot_ops         *ops;
 156         struct hotplug_slot_info        *info;
 157         void                            *private;
 158
 159         /* Variables below this are for use only by the hotplug pci core. */
 160         struct list_head                slot_list;
 161         struct hotplug_slot_core        *core_priv;
 162 };
 163
 164 extern int pci_hp_register              (struct hotplug_slot *slot);
 165 extern int pci_hp_deregister            (struct hotplug_slot *slot);
 166 extern int pci_hp_change_slot_info      (const char *name,
 167                                          struct hotplug_slot_info *info);
 168
 169 struct pci_dev_wrapped {
 170         struct pci_dev  *dev;
 171         void            *data;
 172 };
 173
 174 struct pci_bus_wrapped {
 175         struct pci_bus  *bus;
 176         void            *data;
 177 };
 178
 179 struct pci_visit {
 180         int (* pre_visit_pci_bus)       (struct pci_bus_wrapped *,
 181                                          struct pci_dev_wrapped *);
 182         int (* post_visit_pci_bus)      (struct pci_bus_wrapped *,
 183                                          struct pci_dev_wrapped *);
 184
 185         int (* pre_visit_pci_dev)       (struct pci_dev_wrapped *,
 186                                          struct pci_bus_wrapped *);
 187         int (* visit_pci_dev)           (struct pci_dev_wrapped *,
 188                                          struct pci_bus_wrapped *);
 189         int (* post_visit_pci_dev)      (struct pci_dev_wrapped *,
 190                                          struct pci_bus_wrapped *);
 191 };
 192
 193 extern int pci_visit_dev        (struct pci_visit *fn,
 194                                  struct pci_dev_wrapped *wrapped_dev,
 195                                  struct pci_bus_wrapped *wrapped_parent);
 196
 197 int pci_bus_read_config_byte (struct pci_bus *bus, unsigned int devfn, int where, u8 *val);
 198 int pci_bus_read_config_word (struct pci_bus *bus, unsigned int devfn, int where, u16 *val);
 199 int pci_bus_read_config_dword (struct pci_bus *bus, unsigned int devfn, int where, u32 *val);
 200 int pci_bus_write_config_byte(struct pci_bus *bus, unsigned int devfn, int where, u8 val);
 201 int pci_bus_write_config_word(struct pci_bus *bus, unsigned int devfn, int where, u16 val);
 202 int pci_bus_write_config_dword(struct pci_bus *bus, unsigned int devfn, int where, u32 val);
 203
 204 /*
 205  * Compatibility functions.  Don't use these, use the
 206  * pci_bus_*() functions above.
 207  */
 208
 209 extern int pci_read_config_byte_nodev   (struct pci_ops *ops, u8 bus, u8 device,
 210                                          u8 function, int where, u8 *val);
 211 extern int pci_read_config_word_nodev   (struct pci_ops *ops, u8 bus, u8 device,
 212                                          u8 function, int where, u16 *val);
 213 extern int pci_read_config_dword_nodev  (struct pci_ops *ops, u8 bus, u8 device,
 214                                          u8 function, int where, u32 *val);
 215
 216 extern int pci_write_config_byte_nodev  (struct pci_ops *ops, u8 bus, u8 device,
 217                                          u8 function, int where, u8 val);
 218 extern int pci_write_config_word_nodev  (struct pci_ops *ops, u8 bus, u8 device,
 219                                          u8 function, int where, u16 val);
 220 extern int pci_write_config_dword_nodev (struct pci_ops *ops, u8 bus, u8 device,
 221                                          u8 function, int where, u32 val);
 222
 223
 224 #endif
 225