LXR linux/include/linux/pci

   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        RH_KABI_RESERVE(1)
  50        RH_KABI_RESERVE(2)
  51        RH_KABI_RESERVE(3)
  52        RH_KABI_RESERVE(4)
  53        RH_KABI_RESERVE(5)
  54        RH_KABI_RESERVE(6)
  55        RH_KABI_RESERVE(7)
  56        RH_KABI_RESERVE(8)
  57};
  58
  59/**
  60 * struct hotplug_slot - used to register a physical slot with the hotplug pci core
  61 * @ops: pointer to the &struct hotplug_slot_ops to be used for this slot
  62 * @owner: The module owner of this structure
  63 * @mod_name: The module name (KBUILD_MODNAME) of this structure
  64 */
  65struct hotplug_slot {
  66        const struct hotplug_slot_ops   *ops;
  67
  68        /* Variables below this are for use only by the hotplug pci core. */
  69        struct list_head                slot_list;
  70        struct pci_slot                 *pci_slot;
  71        struct module                   *owner;
  72        const char                      *mod_name;
  73
  74        RH_KABI_RESERVE(1)
  75        RH_KABI_RESERVE(2)
  76        RH_KABI_RESERVE(3)
  77        RH_KABI_RESERVE(4)
  78        RH_KABI_RESERVE(5)
  79        RH_KABI_RESERVE(6)
  80        RH_KABI_RESERVE(7)
  81        RH_KABI_RESERVE(8)
  82};
  83
  84static inline const char *hotplug_slot_name(const struct hotplug_slot *slot)
  85{
  86        return pci_slot_name(slot->pci_slot);
  87}
  88
  89int __pci_hp_register(struct hotplug_slot *slot, struct pci_bus *pbus, int nr,
  90                      const char *name, struct module *owner,
  91                      const char *mod_name);
  92int __pci_hp_initialize(struct hotplug_slot *slot, struct pci_bus *bus, int nr,
  93                        const char *name, struct module *owner,
  94                        const char *mod_name);
  95int pci_hp_add(struct hotplug_slot *slot);
  96
  97void pci_hp_del(struct hotplug_slot *slot);
  98void pci_hp_destroy(struct hotplug_slot *slot);
  99void pci_hp_deregister(struct hotplug_slot *slot);
 100
 101/* use a define to avoid include chaining to get THIS_MODULE & friends */
 102#define pci_hp_register(slot, pbus, devnr, name) \
 103        __pci_hp_register(slot, pbus, devnr, name, THIS_MODULE, KBUILD_MODNAME)
 104#define pci_hp_initialize(slot, bus, nr, name) \
 105        __pci_hp_initialize(slot, bus, nr, name, THIS_MODULE, KBUILD_MODNAME)
 106
 107#ifdef CONFIG_ACPI
 108#include <linux/acpi.h>
 109bool pciehp_is_native(struct pci_dev *bridge);
 110int acpi_get_hp_hw_control_from_firmware(struct pci_dev *bridge);
 111bool shpchp_is_native(struct pci_dev *bridge);
 112int acpi_pci_check_ejectable(struct pci_bus *pbus, acpi_handle handle);
 113int acpi_pci_detect_ejectable(acpi_handle handle);
 114#else
 115static inline int acpi_get_hp_hw_control_from_firmware(struct pci_dev *bridge)
 116{
 117        return 0;
 118}
 119static inline bool pciehp_is_native(struct pci_dev *bridge) { return true; }
 120static inline bool shpchp_is_native(struct pci_dev *bridge) { return true; }
 121#endif
 122
 123static inline bool hotplug_is_native(struct pci_dev *bridge)
 124{
 125        return pciehp_is_native(bridge) || shpchp_is_native(bridge);
 126}
 127#endif
 128