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_2PT5GB = 0x14,
66 PCIE_LNK_SPEED_UNKNOWN = 0xFF,
67};
68
69/**
70 * struct hotplug_slot_ops -the callbacks that the hotplug pci core can use
71 * @owner: The module owner of this structure
72 * @mod_name: The module name (KBUILD_MODNAME) of this structure
73 * @enable_slot: Called when the user wants to enable a specific pci slot
74 * @disable_slot: Called when the user wants to disable a specific pci slot
75 * @set_attention_status: Called to set the specific slot's attention LED to
76 * the specified value
77 * @hardware_test: Called to run a specified hardware test on the specified
78 * slot.
79 * @get_power_status: Called to get the current power status of a slot.
80 * If this field is NULL, the value passed in the struct hotplug_slot_info
81 * will be used when this value is requested by a user.
82 * @get_attention_status: Called to get the current attention status of a slot.
83 * If this field is NULL, the value passed in the struct hotplug_slot_info
84 * will be used when this value is requested by a user.
85 * @get_latch_status: Called to get the current latch status of a slot.
86 * If this field is NULL, the value passed in the struct hotplug_slot_info
87 * will be used when this value is requested by a user.
88 * @get_adapter_status: Called to get see if an adapter is present in the slot or not.
89 * If this field is NULL, the value passed in the struct hotplug_slot_info
90 * will be used when this value is requested by a user.
91 * @get_max_bus_speed: Called to get the max bus speed for a slot.
92 * If this field is NULL, the value passed in the struct hotplug_slot_info
93 * will be used when this value is requested by a user.
94 * @get_cur_bus_speed: Called to get the current bus speed for a slot.
95 * If this field is NULL, the value passed in the struct hotplug_slot_info
96 * will be used when this value is requested by a user.
97 *
98 * The table of function pointers that is passed to the hotplug pci core by a
99 * hotplug pci driver. These functions are called by the hotplug pci core when
100 * the user wants to do something to a specific slot (query it for information,
101 * set an LED, enable / disable power, etc.)
102 */
103struct hotplug_slot_ops {
104 struct module *owner;
105 const char *mod_name;
106 int (*enable_slot) (struct hotplug_slot *slot);
107 int (*disable_slot) (struct hotplug_slot *slot);
108 int (*set_attention_status) (struct hotplug_slot *slot, u8 value);
109 int (*hardware_test) (struct hotplug_slot *slot, u32 value);
110 int (*get_power_status) (struct hotplug_slot *slot, u8 *value);
111 int (*get_attention_status) (struct hotplug_slot *slot, u8 *value);
112 int (*get_latch_status) (struct hotplug_slot *slot, u8 *value);
113 int (*get_adapter_status) (struct hotplug_slot *slot, u8 *value);
114 int (*get_max_bus_speed) (struct hotplug_slot *slot, enum pci_bus_speed *value);
115 int (*get_cur_bus_speed) (struct hotplug_slot *slot, enum pci_bus_speed *value);
116};
117
118/**
119 * struct hotplug_slot_info - used to notify the hotplug pci core of the state of the slot
120 * @power: if power is enabled or not (1/0)
121 * @attention_status: if the attention light is enabled or not (1/0)
122 * @latch_status: if the latch (if any) is open or closed (1/0)
123 * @adapter_present: if there is a pci board present in the slot or not (1/0)
124 * @address: (domain << 16 | bus << 8 | dev)
125 *
126 * Used to notify the hotplug pci core of the status of a specific slot.
127 */
128struct hotplug_slot_info {
129 u8 power_status;
130 u8 attention_status;
131 u8 latch_status;
132 u8 adapter_status;
133 enum pci_bus_speed max_bus_speed;
134 enum pci_bus_speed cur_bus_speed;
135};
136
137/**
138 * struct hotplug_slot - used to register a physical slot with the hotplug pci core
139 * @ops: pointer to the &struct hotplug_slot_ops to be used for this slot
140 * @info: pointer to the &struct hotplug_slot_info for the initial values for
141 * this slot.
142 * @release: called during pci_hp_deregister to free memory allocated in a
143 * hotplug_slot structure.
144 * @private: used by the hotplug pci controller driver to store whatever it
145 * needs.
146 */
147struct hotplug_slot {
148 struct hotplug_slot_ops *ops;
149 struct hotplug_slot_info *info;
150 void (*release) (struct hotplug_slot *slot);
151 void *private;
152
153 /* Variables below this are for use only by the hotplug pci core. */
154 struct list_head slot_list;
155 struct pci_slot *pci_slot;
156};
157#define to_hotplug_slot(n) container_of(n, struct hotplug_slot, kobj)
158
159static inline const char *hotplug_slot_name(const struct hotplug_slot *slot)
160{
161 return pci_slot_name(slot->pci_slot);
162}
163
164extern int __pci_hp_register(struct hotplug_slot *slot, struct pci_bus *pbus,
165 int nr, const char *name,
166 struct module *owner, const char *mod_name);
167extern int pci_hp_deregister(struct hotplug_slot *slot);
168extern int __must_check pci_hp_change_slot_info (struct hotplug_slot *slot,
169 struct hotplug_slot_info *info);
170
171static inline int pci_hp_register(struct hotplug_slot *slot,
172 struct pci_bus *pbus,
173 int devnr, const char *name)
174{
175 return __pci_hp_register(slot, pbus, devnr, name,
176 THIS_MODULE, KBUILD_MODNAME);
177}
178
179/* PCI Setting Record (Type 0) */
180struct 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) */
189struct 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) */
197struct 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
217struct hotplug_params {
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;
224};
225
226#ifdef CONFIG_ACPI
227#include <acpi/acpi.h>
228#include <acpi/acpi_bus.h>
229extern acpi_status acpi_get_hp_params_from_firmware(struct pci_bus *bus,
230 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(struct pci_bus *pbus);
234#endif
235#endif
236