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