Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 | * |
Kristen Carlson Accardi | fb5f4d7 | 2006-09-29 10:30:27 -0700 | [diff] [blame] | 25 | * Send feedback to <kristen.c.accardi@intel.com> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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_attribute { |
| 71 | struct attribute attr; |
| 72 | ssize_t (*show)(struct hotplug_slot *, char *); |
| 73 | ssize_t (*store)(struct hotplug_slot *, const char *, size_t); |
| 74 | }; |
| 75 | #define to_hotplug_attr(n) container_of(n, struct hotplug_slot_attribute, attr); |
| 76 | |
| 77 | /** |
| 78 | * struct hotplug_slot_ops -the callbacks that the hotplug pci core can use |
| 79 | * @owner: The module owner of this structure |
| 80 | * @enable_slot: Called when the user wants to enable a specific pci slot |
| 81 | * @disable_slot: Called when the user wants to disable a specific pci slot |
| 82 | * @set_attention_status: Called to set the specific slot's attention LED to |
| 83 | * the specified value |
| 84 | * @hardware_test: Called to run a specified hardware test on the specified |
| 85 | * slot. |
| 86 | * @get_power_status: Called to get the current power status of a slot. |
| 87 | * If this field is NULL, the value passed in the struct hotplug_slot_info |
| 88 | * will be used when this value is requested by a user. |
| 89 | * @get_attention_status: Called to get the current attention status of a slot. |
| 90 | * If this field is NULL, the value passed in the struct hotplug_slot_info |
| 91 | * will be used when this value is requested by a user. |
| 92 | * @get_latch_status: Called to get the current latch status of a slot. |
| 93 | * If this field is NULL, the value passed in the struct hotplug_slot_info |
| 94 | * will be used when this value is requested by a user. |
| 95 | * @get_adapter_status: Called to get see if an adapter is present in the slot or not. |
| 96 | * If this field is NULL, the value passed in the struct hotplug_slot_info |
| 97 | * will be used when this value is requested by a user. |
| 98 | * @get_address: Called to get pci address of a slot. |
| 99 | * If this field is NULL, the value passed in the struct hotplug_slot_info |
| 100 | * will be used when this value is requested by a user. |
| 101 | * @get_max_bus_speed: Called to get the max bus speed for a slot. |
| 102 | * If this field is NULL, the value passed in the struct hotplug_slot_info |
| 103 | * will be used when this value is requested by a user. |
| 104 | * @get_cur_bus_speed: Called to get the current bus speed for a slot. |
| 105 | * If this field is NULL, the value passed in the struct hotplug_slot_info |
| 106 | * will be used when this value is requested by a user. |
| 107 | * |
| 108 | * The table of function pointers that is passed to the hotplug pci core by a |
| 109 | * hotplug pci driver. These functions are called by the hotplug pci core when |
| 110 | * the user wants to do something to a specific slot (query it for information, |
| 111 | * set an LED, enable / disable power, etc.) |
| 112 | */ |
| 113 | struct hotplug_slot_ops { |
| 114 | struct module *owner; |
| 115 | int (*enable_slot) (struct hotplug_slot *slot); |
| 116 | int (*disable_slot) (struct hotplug_slot *slot); |
| 117 | int (*set_attention_status) (struct hotplug_slot *slot, u8 value); |
| 118 | int (*hardware_test) (struct hotplug_slot *slot, u32 value); |
| 119 | int (*get_power_status) (struct hotplug_slot *slot, u8 *value); |
| 120 | int (*get_attention_status) (struct hotplug_slot *slot, u8 *value); |
| 121 | int (*get_latch_status) (struct hotplug_slot *slot, u8 *value); |
| 122 | int (*get_adapter_status) (struct hotplug_slot *slot, u8 *value); |
| 123 | int (*get_address) (struct hotplug_slot *slot, u32 *value); |
| 124 | int (*get_max_bus_speed) (struct hotplug_slot *slot, enum pci_bus_speed *value); |
| 125 | int (*get_cur_bus_speed) (struct hotplug_slot *slot, enum pci_bus_speed *value); |
| 126 | }; |
| 127 | |
| 128 | /** |
| 129 | * struct hotplug_slot_info - used to notify the hotplug pci core of the state of the slot |
| 130 | * @power: if power is enabled or not (1/0) |
| 131 | * @attention_status: if the attention light is enabled or not (1/0) |
| 132 | * @latch_status: if the latch (if any) is open or closed (1/0) |
| 133 | * @adapter_present: if there is a pci board present in the slot or not (1/0) |
| 134 | * @address: (domain << 16 | bus << 8 | dev) |
| 135 | * |
| 136 | * Used to notify the hotplug pci core of the status of a specific slot. |
| 137 | */ |
| 138 | struct hotplug_slot_info { |
| 139 | u8 power_status; |
| 140 | u8 attention_status; |
| 141 | u8 latch_status; |
| 142 | u8 adapter_status; |
| 143 | u32 address; |
| 144 | enum pci_bus_speed max_bus_speed; |
| 145 | enum pci_bus_speed cur_bus_speed; |
| 146 | }; |
| 147 | |
| 148 | /** |
| 149 | * struct hotplug_slot - used to register a physical slot with the hotplug pci core |
| 150 | * @name: the name of the slot being registered. This string must |
| 151 | * be unique amoung slots registered on this system. |
| 152 | * @ops: pointer to the &struct hotplug_slot_ops to be used for this slot |
Steven Cole | eaae4b3 | 2005-05-03 18:38:30 -0600 | [diff] [blame] | 153 | * @info: pointer to the &struct hotplug_slot_info for the initial values for |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 154 | * this slot. |
| 155 | * @release: called during pci_hp_deregister to free memory allocated in a |
| 156 | * hotplug_slot structure. |
| 157 | * @private: used by the hotplug pci controller driver to store whatever it |
| 158 | * needs. |
| 159 | */ |
| 160 | struct hotplug_slot { |
| 161 | char *name; |
| 162 | struct hotplug_slot_ops *ops; |
| 163 | struct hotplug_slot_info *info; |
| 164 | void (*release) (struct hotplug_slot *slot); |
| 165 | void *private; |
| 166 | |
| 167 | /* Variables below this are for use only by the hotplug pci core. */ |
| 168 | struct list_head slot_list; |
| 169 | struct kobject kobj; |
| 170 | }; |
| 171 | #define to_hotplug_slot(n) container_of(n, struct hotplug_slot, kobj) |
| 172 | |
| 173 | extern int pci_hp_register (struct hotplug_slot *slot); |
| 174 | extern int pci_hp_deregister (struct hotplug_slot *slot); |
Greg Kroah-Hartman | 660a0e8 | 2006-08-28 11:43:25 -0700 | [diff] [blame] | 175 | extern int __must_check pci_hp_change_slot_info (struct hotplug_slot *slot, |
| 176 | struct hotplug_slot_info *info); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 177 | extern struct subsystem pci_hotplug_slots_subsys; |
| 178 | |
Kenji Kaneshige | e22b7350 | 2006-05-02 10:57:14 +0900 | [diff] [blame] | 179 | /* PCI Setting Record (Type 0) */ |
| 180 | struct hpp_type0 { |
| 181 | u32 revision; |
| 182 | u8 cache_line_size; |
| 183 | u8 latency_timer; |
| 184 | u8 enable_serr; |
| 185 | u8 enable_perr; |
| 186 | }; |
| 187 | |
| 188 | /* PCI-X Setting Record (Type 1) */ |
| 189 | struct hpp_type1 { |
| 190 | u32 revision; |
| 191 | u8 max_mem_read; |
| 192 | u8 avg_max_split; |
| 193 | u16 tot_max_split; |
| 194 | }; |
| 195 | |
| 196 | /* PCI Express Setting Record (Type 2) */ |
| 197 | struct hpp_type2 { |
| 198 | u32 revision; |
| 199 | u32 unc_err_mask_and; |
| 200 | u32 unc_err_mask_or; |
| 201 | u32 unc_err_sever_and; |
| 202 | u32 unc_err_sever_or; |
| 203 | u32 cor_err_mask_and; |
| 204 | u32 cor_err_mask_or; |
| 205 | u32 adv_err_cap_and; |
| 206 | u32 adv_err_cap_or; |
| 207 | u16 pci_exp_devctl_and; |
| 208 | u16 pci_exp_devctl_or; |
| 209 | u16 pci_exp_lnkctl_and; |
| 210 | u16 pci_exp_lnkctl_or; |
| 211 | u32 sec_unc_err_sever_and; |
| 212 | u32 sec_unc_err_sever_or; |
| 213 | u32 sec_unc_err_mask_and; |
| 214 | u32 sec_unc_err_mask_or; |
| 215 | }; |
| 216 | |
Kristen Accardi | 783c49f | 2006-03-03 10:16:05 -0800 | [diff] [blame] | 217 | struct hotplug_params { |
Kenji Kaneshige | e22b7350 | 2006-05-02 10:57:14 +0900 | [diff] [blame] | 218 | struct hpp_type0 *t0; /* Type0: NULL if not available */ |
| 219 | struct hpp_type1 *t1; /* Type1: NULL if not available */ |
| 220 | struct hpp_type2 *t2; /* Type2: NULL if not available */ |
| 221 | struct hpp_type0 type0_data; |
| 222 | struct hpp_type1 type1_data; |
| 223 | struct hpp_type2 type2_data; |
Kristen Accardi | 783c49f | 2006-03-03 10:16:05 -0800 | [diff] [blame] | 224 | }; |
| 225 | |
| 226 | #ifdef CONFIG_ACPI |
| 227 | #include <acpi/acpi.h> |
| 228 | #include <acpi/acpi_bus.h> |
| 229 | #include <acpi/actypes.h> |
| 230 | extern acpi_status acpi_run_oshp(acpi_handle handle); |
Kenji Kaneshige | 7430e34 | 2006-05-02 10:54:50 +0900 | [diff] [blame] | 231 | extern acpi_status acpi_get_hp_params_from_firmware(struct pci_bus *bus, |
Kristen Accardi | 783c49f | 2006-03-03 10:16:05 -0800 | [diff] [blame] | 232 | struct hotplug_params *hpp); |
Kristen Accardi | 783c49f | 2006-03-03 10:16:05 -0800 | [diff] [blame] | 233 | int acpi_root_bridge(acpi_handle handle); |
| 234 | #endif |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 235 | #endif |
| 236 | |