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