pci_hotplug.h 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109
  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. * struct hotplug_slot_ops -the callbacks that the hotplug pci core can use
  18. * @enable_slot: Called when the user wants to enable a specific pci slot
  19. * @disable_slot: Called when the user wants to disable a specific pci slot
  20. * @set_attention_status: Called to set the specific slot's attention LED to
  21. * the specified value
  22. * @hardware_test: Called to run a specified hardware test on the specified
  23. * slot.
  24. * @get_power_status: Called to get the current power status of a slot.
  25. * @get_attention_status: Called to get the current attention status of a slot.
  26. * @get_latch_status: Called to get the current latch status of a slot.
  27. * @get_adapter_status: Called to get see if an adapter is present in the slot or not.
  28. * @reset_slot: Optional interface to allow override of a bus reset for the
  29. * slot for cases where a secondary bus reset can result in spurious
  30. * hotplug events or where a slot can be reset independent of the bus.
  31. *
  32. * The table of function pointers that is passed to the hotplug pci core by a
  33. * hotplug pci driver. These functions are called by the hotplug pci core when
  34. * the user wants to do something to a specific slot (query it for information,
  35. * set an LED, enable / disable power, etc.)
  36. */
  37. struct hotplug_slot_ops {
  38. int (*enable_slot) (struct hotplug_slot *slot);
  39. int (*disable_slot) (struct hotplug_slot *slot);
  40. int (*set_attention_status) (struct hotplug_slot *slot, u8 value);
  41. int (*hardware_test) (struct hotplug_slot *slot, u32 value);
  42. int (*get_power_status) (struct hotplug_slot *slot, u8 *value);
  43. int (*get_attention_status) (struct hotplug_slot *slot, u8 *value);
  44. int (*get_latch_status) (struct hotplug_slot *slot, u8 *value);
  45. int (*get_adapter_status) (struct hotplug_slot *slot, u8 *value);
  46. int (*reset_slot) (struct hotplug_slot *slot, int probe);
  47. };
  48. /**
  49. * struct hotplug_slot - used to register a physical slot with the hotplug pci core
  50. * @ops: pointer to the &struct hotplug_slot_ops to be used for this slot
  51. * @owner: The module owner of this structure
  52. * @mod_name: The module name (KBUILD_MODNAME) of this structure
  53. */
  54. struct hotplug_slot {
  55. const struct hotplug_slot_ops *ops;
  56. /* Variables below this are for use only by the hotplug pci core. */
  57. struct list_head slot_list;
  58. struct pci_slot *pci_slot;
  59. struct module *owner;
  60. const char *mod_name;
  61. };
  62. static inline const char *hotplug_slot_name(const struct hotplug_slot *slot)
  63. {
  64. return pci_slot_name(slot->pci_slot);
  65. }
  66. int __pci_hp_register(struct hotplug_slot *slot, struct pci_bus *pbus, int nr,
  67. const char *name, struct module *owner,
  68. const char *mod_name);
  69. int __pci_hp_initialize(struct hotplug_slot *slot, struct pci_bus *bus, int nr,
  70. const char *name, struct module *owner,
  71. const char *mod_name);
  72. int pci_hp_add(struct hotplug_slot *slot);
  73. void pci_hp_del(struct hotplug_slot *slot);
  74. void pci_hp_destroy(struct hotplug_slot *slot);
  75. void pci_hp_deregister(struct hotplug_slot *slot);
  76. /* use a define to avoid include chaining to get THIS_MODULE & friends */
  77. #define pci_hp_register(slot, pbus, devnr, name) \
  78. __pci_hp_register(slot, pbus, devnr, name, THIS_MODULE, KBUILD_MODNAME)
  79. #define pci_hp_initialize(slot, bus, nr, name) \
  80. __pci_hp_initialize(slot, bus, nr, name, THIS_MODULE, KBUILD_MODNAME)
  81. #ifdef CONFIG_ACPI
  82. #include <linux/acpi.h>
  83. bool pciehp_is_native(struct pci_dev *bridge);
  84. int acpi_get_hp_hw_control_from_firmware(struct pci_dev *bridge);
  85. bool shpchp_is_native(struct pci_dev *bridge);
  86. int acpi_pci_check_ejectable(struct pci_bus *pbus, acpi_handle handle);
  87. int acpi_pci_detect_ejectable(acpi_handle handle);
  88. #else
  89. static inline int acpi_get_hp_hw_control_from_firmware(struct pci_dev *bridge)
  90. {
  91. return 0;
  92. }
  93. static inline bool pciehp_is_native(struct pci_dev *bridge) { return true; }
  94. static inline bool shpchp_is_native(struct pci_dev *bridge) { return true; }
  95. #endif
  96. static inline bool hotplug_is_native(struct pci_dev *bridge)
  97. {
  98. return pciehp_is_native(bridge) || shpchp_is_native(bridge);
  99. }
  100. #endif