pci_hotplug.h 8.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236
  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. /* These values come from the PCI Hotplug Spec */
  31. enum pci_bus_speed {
  32. PCI_SPEED_33MHz = 0x00,
  33. PCI_SPEED_66MHz = 0x01,
  34. PCI_SPEED_66MHz_PCIX = 0x02,
  35. PCI_SPEED_100MHz_PCIX = 0x03,
  36. PCI_SPEED_133MHz_PCIX = 0x04,
  37. PCI_SPEED_66MHz_PCIX_ECC = 0x05,
  38. PCI_SPEED_100MHz_PCIX_ECC = 0x06,
  39. PCI_SPEED_133MHz_PCIX_ECC = 0x07,
  40. PCI_SPEED_66MHz_PCIX_266 = 0x09,
  41. PCI_SPEED_100MHz_PCIX_266 = 0x0a,
  42. PCI_SPEED_133MHz_PCIX_266 = 0x0b,
  43. PCI_SPEED_66MHz_PCIX_533 = 0x11,
  44. PCI_SPEED_100MHz_PCIX_533 = 0x12,
  45. PCI_SPEED_133MHz_PCIX_533 = 0x13,
  46. PCI_SPEED_UNKNOWN = 0xff,
  47. };
  48. /* These values come from the PCI Express Spec */
  49. enum pcie_link_width {
  50. PCIE_LNK_WIDTH_RESRV = 0x00,
  51. PCIE_LNK_X1 = 0x01,
  52. PCIE_LNK_X2 = 0x02,
  53. PCIE_LNK_X4 = 0x04,
  54. PCIE_LNK_X8 = 0x08,
  55. PCIE_LNK_X12 = 0x0C,
  56. PCIE_LNK_X16 = 0x10,
  57. PCIE_LNK_X32 = 0x20,
  58. PCIE_LNK_WIDTH_UNKNOWN = 0xFF,
  59. };
  60. enum pcie_link_speed {
  61. PCIE_2PT5GB = 0x14,
  62. PCIE_LNK_SPEED_UNKNOWN = 0xFF,
  63. };
  64. struct hotplug_slot;
  65. struct hotplug_slot_attribute {
  66. struct attribute attr;
  67. ssize_t (*show)(struct hotplug_slot *, char *);
  68. ssize_t (*store)(struct hotplug_slot *, const char *, size_t);
  69. };
  70. #define to_hotplug_attr(n) container_of(n, struct hotplug_slot_attribute, attr);
  71. /**
  72. * struct hotplug_slot_ops -the callbacks that the hotplug pci core can use
  73. * @owner: The module owner of this structure
  74. * @enable_slot: Called when the user wants to enable a specific pci slot
  75. * @disable_slot: Called when the user wants to disable a specific pci slot
  76. * @set_attention_status: Called to set the specific slot's attention LED to
  77. * the specified value
  78. * @hardware_test: Called to run a specified hardware test on the specified
  79. * slot.
  80. * @get_power_status: Called to get the current power status of a slot.
  81. * If this field is NULL, the value passed in the struct hotplug_slot_info
  82. * will be used when this value is requested by a user.
  83. * @get_attention_status: Called to get the current attention status of a slot.
  84. * If this field is NULL, the value passed in the struct hotplug_slot_info
  85. * will be used when this value is requested by a user.
  86. * @get_latch_status: Called to get the current latch 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_adapter_status: Called to get see if an adapter is present in the slot or not.
  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_address: Called to get pci address 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_max_bus_speed: Called to get the max bus speed for a slot.
  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_cur_bus_speed: Called to get the current bus speed for 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. *
  102. * The table of function pointers that is passed to the hotplug pci core by a
  103. * hotplug pci driver. These functions are called by the hotplug pci core when
  104. * the user wants to do something to a specific slot (query it for information,
  105. * set an LED, enable / disable power, etc.)
  106. */
  107. struct hotplug_slot_ops {
  108. struct module *owner;
  109. int (*enable_slot) (struct hotplug_slot *slot);
  110. int (*disable_slot) (struct hotplug_slot *slot);
  111. int (*set_attention_status) (struct hotplug_slot *slot, u8 value);
  112. int (*hardware_test) (struct hotplug_slot *slot, u32 value);
  113. int (*get_power_status) (struct hotplug_slot *slot, u8 *value);
  114. int (*get_attention_status) (struct hotplug_slot *slot, u8 *value);
  115. int (*get_latch_status) (struct hotplug_slot *slot, u8 *value);
  116. int (*get_adapter_status) (struct hotplug_slot *slot, u8 *value);
  117. int (*get_address) (struct hotplug_slot *slot, u32 *value);
  118. int (*get_max_bus_speed) (struct hotplug_slot *slot, enum pci_bus_speed *value);
  119. int (*get_cur_bus_speed) (struct hotplug_slot *slot, enum pci_bus_speed *value);
  120. };
  121. /**
  122. * struct hotplug_slot_info - used to notify the hotplug pci core of the state of the slot
  123. * @power: if power is enabled or not (1/0)
  124. * @attention_status: if the attention light is enabled or not (1/0)
  125. * @latch_status: if the latch (if any) is open or closed (1/0)
  126. * @adapter_present: if there is a pci board present in the slot or not (1/0)
  127. * @address: (domain << 16 | bus << 8 | dev)
  128. *
  129. * Used to notify the hotplug pci core of the status of a specific slot.
  130. */
  131. struct hotplug_slot_info {
  132. u8 power_status;
  133. u8 attention_status;
  134. u8 latch_status;
  135. u8 adapter_status;
  136. u32 address;
  137. enum pci_bus_speed max_bus_speed;
  138. enum pci_bus_speed cur_bus_speed;
  139. };
  140. /**
  141. * struct hotplug_slot - used to register a physical slot with the hotplug pci core
  142. * @name: the name of the slot being registered. This string must
  143. * be unique amoung slots registered on this system.
  144. * @ops: pointer to the &struct hotplug_slot_ops to be used for this slot
  145. * @info: pointer to the &struct hotplug_slot_info for the initial values for
  146. * this slot.
  147. * @release: called during pci_hp_deregister to free memory allocated in a
  148. * hotplug_slot structure.
  149. * @private: used by the hotplug pci controller driver to store whatever it
  150. * needs.
  151. */
  152. struct hotplug_slot {
  153. char *name;
  154. struct hotplug_slot_ops *ops;
  155. struct hotplug_slot_info *info;
  156. void (*release) (struct hotplug_slot *slot);
  157. void *private;
  158. /* Variables below this are for use only by the hotplug pci core. */
  159. struct list_head slot_list;
  160. struct kobject kobj;
  161. };
  162. #define to_hotplug_slot(n) container_of(n, struct hotplug_slot, kobj)
  163. extern int pci_hp_register (struct hotplug_slot *slot);
  164. extern int pci_hp_deregister (struct hotplug_slot *slot);
  165. extern int __must_check pci_hp_change_slot_info (struct hotplug_slot *slot,
  166. struct hotplug_slot_info *info);
  167. extern struct subsystem pci_hotplug_slots_subsys;
  168. /* PCI Setting Record (Type 0) */
  169. struct hpp_type0 {
  170. u32 revision;
  171. u8 cache_line_size;
  172. u8 latency_timer;
  173. u8 enable_serr;
  174. u8 enable_perr;
  175. };
  176. /* PCI-X Setting Record (Type 1) */
  177. struct hpp_type1 {
  178. u32 revision;
  179. u8 max_mem_read;
  180. u8 avg_max_split;
  181. u16 tot_max_split;
  182. };
  183. /* PCI Express Setting Record (Type 2) */
  184. struct hpp_type2 {
  185. u32 revision;
  186. u32 unc_err_mask_and;
  187. u32 unc_err_mask_or;
  188. u32 unc_err_sever_and;
  189. u32 unc_err_sever_or;
  190. u32 cor_err_mask_and;
  191. u32 cor_err_mask_or;
  192. u32 adv_err_cap_and;
  193. u32 adv_err_cap_or;
  194. u16 pci_exp_devctl_and;
  195. u16 pci_exp_devctl_or;
  196. u16 pci_exp_lnkctl_and;
  197. u16 pci_exp_lnkctl_or;
  198. u32 sec_unc_err_sever_and;
  199. u32 sec_unc_err_sever_or;
  200. u32 sec_unc_err_mask_and;
  201. u32 sec_unc_err_mask_or;
  202. };
  203. struct hotplug_params {
  204. struct hpp_type0 *t0; /* Type0: NULL if not available */
  205. struct hpp_type1 *t1; /* Type1: NULL if not available */
  206. struct hpp_type2 *t2; /* Type2: NULL if not available */
  207. struct hpp_type0 type0_data;
  208. struct hpp_type1 type1_data;
  209. struct hpp_type2 type2_data;
  210. };
  211. #ifdef CONFIG_ACPI
  212. #include <acpi/acpi.h>
  213. #include <acpi/acpi_bus.h>
  214. #include <acpi/actypes.h>
  215. extern acpi_status acpi_run_oshp(acpi_handle handle);
  216. extern acpi_status acpi_get_hp_params_from_firmware(struct pci_bus *bus,
  217. struct hotplug_params *hpp);
  218. int acpi_root_bridge(acpi_handle handle);
  219. #endif
  220. #endif