Loading...
1/* SPDX-License-Identifier: GPL-2.0+ */
2/*
3 * PCI HotPlug Core Functions
4 *
5 * Copyright (C) 1995,2001 Compaq Computer Corporation
6 * Copyright (C) 2001 Greg Kroah-Hartman (greg@kroah.com)
7 * Copyright (C) 2001 IBM Corp.
8 *
9 * All rights reserved.
10 *
11 * Send feedback to <kristen.c.accardi@intel.com>
12 *
13 */
14#ifndef _PCI_HOTPLUG_H
15#define _PCI_HOTPLUG_H
16
17/**
18 * struct hotplug_slot_ops -the callbacks that the hotplug pci core can use
19 * @enable_slot: Called when the user wants to enable a specific pci slot
20 * @disable_slot: Called when the user wants to disable a specific pci slot
21 * @set_attention_status: Called to set the specific slot's attention LED to
22 * the specified value
23 * @hardware_test: Called to run a specified hardware test on the specified
24 * slot.
25 * @get_power_status: Called to get the current power status of a slot.
26 * @get_attention_status: Called to get the current attention status of a slot.
27 * @get_latch_status: Called to get the current latch status of a slot.
28 * @get_adapter_status: Called to get see if an adapter is present in the slot or not.
29 * @reset_slot: Optional interface to allow override of a bus reset for the
30 * slot for cases where a secondary bus reset can result in spurious
31 * hotplug events or where a slot can be reset independent of the bus.
32 *
33 * The table of function pointers that is passed to the hotplug pci core by a
34 * hotplug pci driver. These functions are called by the hotplug pci core when
35 * the user wants to do something to a specific slot (query it for information,
36 * set an LED, enable / disable power, etc.)
37 */
38struct hotplug_slot_ops {
39 int (*enable_slot) (struct hotplug_slot *slot);
40 int (*disable_slot) (struct hotplug_slot *slot);
41 int (*set_attention_status) (struct hotplug_slot *slot, u8 value);
42 int (*hardware_test) (struct hotplug_slot *slot, u32 value);
43 int (*get_power_status) (struct hotplug_slot *slot, u8 *value);
44 int (*get_attention_status) (struct hotplug_slot *slot, u8 *value);
45 int (*get_latch_status) (struct hotplug_slot *slot, u8 *value);
46 int (*get_adapter_status) (struct hotplug_slot *slot, u8 *value);
47 int (*reset_slot) (struct hotplug_slot *slot, int probe);
48};
49
50/**
51 * struct hotplug_slot - used to register a physical slot with the hotplug pci core
52 * @ops: pointer to the &struct hotplug_slot_ops to be used for this slot
53 * @slot_list: internal list used to track hotplug PCI slots
54 * @pci_slot: represents a physical slot
55 * @owner: The module owner of this structure
56 * @mod_name: The module name (KBUILD_MODNAME) of this structure
57 */
58struct hotplug_slot {
59 const struct hotplug_slot_ops *ops;
60
61 /* Variables below this are for use only by the hotplug pci core. */
62 struct list_head slot_list;
63 struct pci_slot *pci_slot;
64 struct module *owner;
65 const char *mod_name;
66};
67
68static inline const char *hotplug_slot_name(const struct hotplug_slot *slot)
69{
70 return pci_slot_name(slot->pci_slot);
71}
72
73int __pci_hp_register(struct hotplug_slot *slot, struct pci_bus *pbus, int nr,
74 const char *name, struct module *owner,
75 const char *mod_name);
76int __pci_hp_initialize(struct hotplug_slot *slot, struct pci_bus *bus, int nr,
77 const char *name, struct module *owner,
78 const char *mod_name);
79int pci_hp_add(struct hotplug_slot *slot);
80
81void pci_hp_del(struct hotplug_slot *slot);
82void pci_hp_destroy(struct hotplug_slot *slot);
83void pci_hp_deregister(struct hotplug_slot *slot);
84
85/* use a define to avoid include chaining to get THIS_MODULE & friends */
86#define pci_hp_register(slot, pbus, devnr, name) \
87 __pci_hp_register(slot, pbus, devnr, name, THIS_MODULE, KBUILD_MODNAME)
88#define pci_hp_initialize(slot, bus, nr, name) \
89 __pci_hp_initialize(slot, bus, nr, name, THIS_MODULE, KBUILD_MODNAME)
90
91#ifdef CONFIG_ACPI
92#include <linux/acpi.h>
93bool pciehp_is_native(struct pci_dev *bridge);
94int acpi_get_hp_hw_control_from_firmware(struct pci_dev *bridge);
95bool shpchp_is_native(struct pci_dev *bridge);
96int acpi_pci_check_ejectable(struct pci_bus *pbus, acpi_handle handle);
97int acpi_pci_detect_ejectable(acpi_handle handle);
98#else
99static inline int acpi_get_hp_hw_control_from_firmware(struct pci_dev *bridge)
100{
101 return 0;
102}
103static inline bool pciehp_is_native(struct pci_dev *bridge) { return true; }
104static inline bool shpchp_is_native(struct pci_dev *bridge) { return true; }
105#endif
106
107static inline bool hotplug_is_native(struct pci_dev *bridge)
108{
109 return pciehp_is_native(bridge) || shpchp_is_native(bridge);
110}
111#endif
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 * struct hotplug_slot_ops -the callbacks that the hotplug pci core can use
33 * @owner: The module owner of this structure
34 * @mod_name: The module name (KBUILD_MODNAME) of this structure
35 * @enable_slot: Called when the user wants to enable a specific pci slot
36 * @disable_slot: Called when the user wants to disable a specific pci slot
37 * @set_attention_status: Called to set the specific slot's attention LED to
38 * the specified value
39 * @hardware_test: Called to run a specified hardware test on the specified
40 * slot.
41 * @get_power_status: Called to get the current power status of a slot.
42 * If this field is NULL, the value passed in the struct hotplug_slot_info
43 * will be used when this value is requested by a user.
44 * @get_attention_status: Called to get the current attention status of a slot.
45 * If this field is NULL, the value passed in the struct hotplug_slot_info
46 * will be used when this value is requested by a user.
47 * @get_latch_status: Called to get the current latch status of a slot.
48 * If this field is NULL, the value passed in the struct hotplug_slot_info
49 * will be used when this value is requested by a user.
50 * @get_adapter_status: Called to get see if an adapter is present in the slot or not.
51 * If this field is NULL, the value passed in the struct hotplug_slot_info
52 * will be used when this value is requested by a user.
53 * @reset_slot: Optional interface to allow override of a bus reset for the
54 * slot for cases where a secondary bus reset can result in spurious
55 * hotplug events or where a slot can be reset independent of the bus.
56 *
57 * The table of function pointers that is passed to the hotplug pci core by a
58 * hotplug pci driver. These functions are called by the hotplug pci core when
59 * the user wants to do something to a specific slot (query it for information,
60 * set an LED, enable / disable power, etc.)
61 */
62struct hotplug_slot_ops {
63 struct module *owner;
64 const char *mod_name;
65 int (*enable_slot) (struct hotplug_slot *slot);
66 int (*disable_slot) (struct hotplug_slot *slot);
67 int (*set_attention_status) (struct hotplug_slot *slot, u8 value);
68 int (*hardware_test) (struct hotplug_slot *slot, u32 value);
69 int (*get_power_status) (struct hotplug_slot *slot, u8 *value);
70 int (*get_attention_status) (struct hotplug_slot *slot, u8 *value);
71 int (*get_latch_status) (struct hotplug_slot *slot, u8 *value);
72 int (*get_adapter_status) (struct hotplug_slot *slot, u8 *value);
73 int (*reset_slot) (struct hotplug_slot *slot, int probe);
74};
75
76/**
77 * struct hotplug_slot_info - used to notify the hotplug pci core of the state of the slot
78 * @power_status: if power is enabled or not (1/0)
79 * @attention_status: if the attention light is enabled or not (1/0)
80 * @latch_status: if the latch (if any) is open or closed (1/0)
81 * @adapter_status: if there is a pci board present in the slot or not (1/0)
82 *
83 * Used to notify the hotplug pci core of the status of a specific slot.
84 */
85struct hotplug_slot_info {
86 u8 power_status;
87 u8 attention_status;
88 u8 latch_status;
89 u8 adapter_status;
90};
91
92/**
93 * struct hotplug_slot - used to register a physical slot with the hotplug pci core
94 * @ops: pointer to the &struct hotplug_slot_ops to be used for this slot
95 * @info: pointer to the &struct hotplug_slot_info for the initial values for
96 * this slot.
97 * @release: called during pci_hp_deregister to free memory allocated in a
98 * hotplug_slot structure.
99 * @private: used by the hotplug pci controller driver to store whatever it
100 * needs.
101 */
102struct hotplug_slot {
103 struct hotplug_slot_ops *ops;
104 struct hotplug_slot_info *info;
105 void (*release) (struct hotplug_slot *slot);
106 void *private;
107
108 /* Variables below this are for use only by the hotplug pci core. */
109 struct list_head slot_list;
110 struct pci_slot *pci_slot;
111};
112
113static inline const char *hotplug_slot_name(const struct hotplug_slot *slot)
114{
115 return pci_slot_name(slot->pci_slot);
116}
117
118int __pci_hp_register(struct hotplug_slot *slot, struct pci_bus *pbus, int nr,
119 const char *name, struct module *owner,
120 const char *mod_name);
121int pci_hp_deregister(struct hotplug_slot *slot);
122int __must_check pci_hp_change_slot_info(struct hotplug_slot *slot,
123 struct hotplug_slot_info *info);
124
125/* use a define to avoid include chaining to get THIS_MODULE & friends */
126#define pci_hp_register(slot, pbus, devnr, name) \
127 __pci_hp_register(slot, pbus, devnr, name, THIS_MODULE, KBUILD_MODNAME)
128
129/* PCI Setting Record (Type 0) */
130struct hpp_type0 {
131 u32 revision;
132 u8 cache_line_size;
133 u8 latency_timer;
134 u8 enable_serr;
135 u8 enable_perr;
136};
137
138/* PCI-X Setting Record (Type 1) */
139struct hpp_type1 {
140 u32 revision;
141 u8 max_mem_read;
142 u8 avg_max_split;
143 u16 tot_max_split;
144};
145
146/* PCI Express Setting Record (Type 2) */
147struct hpp_type2 {
148 u32 revision;
149 u32 unc_err_mask_and;
150 u32 unc_err_mask_or;
151 u32 unc_err_sever_and;
152 u32 unc_err_sever_or;
153 u32 cor_err_mask_and;
154 u32 cor_err_mask_or;
155 u32 adv_err_cap_and;
156 u32 adv_err_cap_or;
157 u16 pci_exp_devctl_and;
158 u16 pci_exp_devctl_or;
159 u16 pci_exp_lnkctl_and;
160 u16 pci_exp_lnkctl_or;
161 u32 sec_unc_err_sever_and;
162 u32 sec_unc_err_sever_or;
163 u32 sec_unc_err_mask_and;
164 u32 sec_unc_err_mask_or;
165};
166
167struct hotplug_params {
168 struct hpp_type0 *t0; /* Type0: NULL if not available */
169 struct hpp_type1 *t1; /* Type1: NULL if not available */
170 struct hpp_type2 *t2; /* Type2: NULL if not available */
171 struct hpp_type0 type0_data;
172 struct hpp_type1 type1_data;
173 struct hpp_type2 type2_data;
174};
175
176#ifdef CONFIG_ACPI
177#include <linux/acpi.h>
178int pci_get_hp_params(struct pci_dev *dev, struct hotplug_params *hpp);
179int acpi_get_hp_hw_control_from_firmware(struct pci_dev *dev, u32 flags);
180int acpi_pci_check_ejectable(struct pci_bus *pbus, acpi_handle handle);
181int acpi_pci_detect_ejectable(acpi_handle handle);
182#else
183static inline int pci_get_hp_params(struct pci_dev *dev,
184 struct hotplug_params *hpp)
185{
186 return -ENODEV;
187}
188#endif
189#endif