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