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