include/linux/pci_hotplug.h

   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  */
  38 struct 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  * @private: used by the hotplug pci controller driver to store whatever it
  54  * needs.
  55  * @owner: The module owner of this structure
  56  * @mod_name: The module name (KBUILD_MODNAME) of this structure
  57  */
  58 struct hotplug_slot {
  59         const struct hotplug_slot_ops   *ops;
  60         void                            *private;
  61
  62         /* Variables below this are for use only by the hotplug pci core. */
  63         struct list_head                slot_list;
  64         struct pci_slot                 *pci_slot;
  65         struct module                   *owner;
  66         const char                      *mod_name;
  67 };
  68
  69 static inline const char *hotplug_slot_name(const struct hotplug_slot *slot)
  70 {
  71         return pci_slot_name(slot->pci_slot);
  72 }
  73
  74 int __pci_hp_register(struct hotplug_slot *slot, struct pci_bus *pbus, int nr,
  75                       const char *name, struct module *owner,
  76                       const char *mod_name);
  77 int __pci_hp_initialize(struct hotplug_slot *slot, struct pci_bus *bus, int nr,
  78                         const char *name, struct module *owner,
  79                         const char *mod_name);
  80 int pci_hp_add(struct hotplug_slot *slot);
  81
  82 void pci_hp_del(struct hotplug_slot *slot);
  83 void pci_hp_destroy(struct hotplug_slot *slot);
  84 void pci_hp_deregister(struct hotplug_slot *slot);
  85
  86 /* use a define to avoid include chaining to get THIS_MODULE & friends */
  87 #define pci_hp_register(slot, pbus, devnr, name) \
  88         __pci_hp_register(slot, pbus, devnr, name, THIS_MODULE, KBUILD_MODNAME)
  89 #define pci_hp_initialize(slot, bus, nr, name) \
  90         __pci_hp_initialize(slot, bus, nr, name, THIS_MODULE, KBUILD_MODNAME)
  91
  92 /* PCI Setting Record (Type 0) */
  93 struct hpp_type0 {
  94         u32 revision;
  95         u8  cache_line_size;
  96         u8  latency_timer;
  97         u8  enable_serr;
  98         u8  enable_perr;
  99 };
 100
 101 /* PCI-X Setting Record (Type 1) */
 102 struct hpp_type1 {
 103         u32 revision;
 104         u8  max_mem_read;
 105         u8  avg_max_split;
 106         u16 tot_max_split;
 107 };
 108
 109 /* PCI Express Setting Record (Type 2) */
 110 struct hpp_type2 {
 111         u32 revision;
 112         u32 unc_err_mask_and;
 113         u32 unc_err_mask_or;
 114         u32 unc_err_sever_and;
 115         u32 unc_err_sever_or;
 116         u32 cor_err_mask_and;
 117         u32 cor_err_mask_or;
 118         u32 adv_err_cap_and;
 119         u32 adv_err_cap_or;
 120         u16 pci_exp_devctl_and;
 121         u16 pci_exp_devctl_or;
 122         u16 pci_exp_lnkctl_and;
 123         u16 pci_exp_lnkctl_or;
 124         u32 sec_unc_err_sever_and;
 125         u32 sec_unc_err_sever_or;
 126         u32 sec_unc_err_mask_and;
 127         u32 sec_unc_err_mask_or;
 128 };
 129
 130 struct hotplug_params {
 131         struct hpp_type0 *t0;           /* Type0: NULL if not available */
 132         struct hpp_type1 *t1;           /* Type1: NULL if not available */
 133         struct hpp_type2 *t2;           /* Type2: NULL if not available */
 134         struct hpp_type0 type0_data;
 135         struct hpp_type1 type1_data;
 136         struct hpp_type2 type2_data;
 137 };
 138
 139 #ifdef CONFIG_ACPI
 140 #include <linux/acpi.h>
 141 int pci_get_hp_params(struct pci_dev *dev, struct hotplug_params *hpp);
 142 bool pciehp_is_native(struct pci_dev *bridge);
 143 int acpi_get_hp_hw_control_from_firmware(struct pci_dev *bridge);
 144 bool shpchp_is_native(struct pci_dev *bridge);
 145 int acpi_pci_check_ejectable(struct pci_bus *pbus, acpi_handle handle);
 146 int acpi_pci_detect_ejectable(acpi_handle handle);
 147 #else
 148 static inline int pci_get_hp_params(struct pci_dev *dev,
 149                                     struct hotplug_params *hpp)
 150 {
 151         return -ENODEV;
 152 }
 153
 154 static inline int acpi_get_hp_hw_control_from_firmware(struct pci_dev *bridge)
 155 {
 156         return 0;
 157 }
 158 static inline bool pciehp_is_native(struct pci_dev *bridge) { return true; }
 159 static inline bool shpchp_is_native(struct pci_dev *bridge) { return true; }
 160 #endif
 161
 162 static inline bool hotplug_is_native(struct pci_dev *bridge)
 163 {
 164         return pciehp_is_native(bridge) || shpchp_is_native(bridge);
 165 }
 166 #endif