^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) /* SPDX-License-Identifier: GPL-2.0+ */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) * ACPI PCI Hot Plug Controller Driver
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) * Copyright (C) 1995,2001 Compaq Computer Corporation
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) * Copyright (C) 2001 Greg Kroah-Hartman (greg@kroah.com)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) * Copyright (C) 2001 IBM Corp.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) * Copyright (C) 2002 Hiroshi Aono (h-aono@ap.jp.nec.com)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) * Copyright (C) 2002,2003 Takayoshi Kochi (t-kochi@bq.jp.nec.com)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) * Copyright (C) 2002,2003 NEC Corporation
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) * Copyright (C) 2003-2005 Matthew Wilcox (willy@infradead.org)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) * Copyright (C) 2003-2005 Hewlett Packard
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) * All rights reserved.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) * Send feedback to <gregkh@us.ibm.com>,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) * <t-kochi@bq.jp.nec.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) #ifndef _ACPIPHP_H
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) #define _ACPIPHP_H
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) #include <linux/acpi.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) #include <linux/mutex.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) #include <linux/pci_hotplug.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) struct acpiphp_context;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) struct acpiphp_bridge;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) struct acpiphp_slot;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) * struct slot - slot information for each *physical* slot
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) struct slot {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) struct hotplug_slot hotplug_slot;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) struct acpiphp_slot *acpi_slot;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) unsigned int sun; /* ACPI _SUN (Slot User Number) value */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) static inline const char *slot_name(struct slot *slot)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) return hotplug_slot_name(&slot->hotplug_slot);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) static inline struct slot *to_slot(struct hotplug_slot *hotplug_slot)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) return container_of(hotplug_slot, struct slot, hotplug_slot);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) * struct acpiphp_bridge - PCI bridge information
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) * for each bridge device in ACPI namespace
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) struct acpiphp_bridge {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) struct list_head list;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) struct list_head slots;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) struct kref ref;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) struct acpiphp_context *context;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) int nr_slots;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) /* This bus (host bridge) or Secondary bus (PCI-to-PCI bridge) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) struct pci_bus *pci_bus;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) /* PCI-to-PCI bridge device */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) struct pci_dev *pci_dev;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) bool is_going_away;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) * struct acpiphp_slot - PCI slot information
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) * PCI slot information for each *physical* PCI slot
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) struct acpiphp_slot {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) struct list_head node;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) struct pci_bus *bus;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) struct list_head funcs; /* one slot may have different
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) objects (i.e. for each function) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) struct slot *slot;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) u8 device; /* pci device# */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) u32 flags; /* see below */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) * struct acpiphp_func - PCI function information
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95) * PCI function information for each object in ACPI namespace
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) * typically 8 objects per slot (i.e. for each PCI function)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) struct acpiphp_func {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) struct acpiphp_bridge *parent;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) struct acpiphp_slot *slot;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) struct list_head sibling;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) u8 function; /* pci function# */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) u32 flags; /* see below */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) struct acpiphp_context {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) struct acpi_hotplug_context hp;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) struct acpiphp_func func;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) struct acpiphp_bridge *bridge;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) unsigned int refcount;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) static inline struct acpiphp_context *to_acpiphp_context(struct acpi_hotplug_context *hp)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) return container_of(hp, struct acpiphp_context, hp);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) static inline struct acpiphp_context *func_to_context(struct acpiphp_func *func)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) return container_of(func, struct acpiphp_context, func);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) static inline struct acpi_device *func_to_acpi_device(struct acpiphp_func *func)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) return func_to_context(func)->hp.self;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) static inline acpi_handle func_to_handle(struct acpiphp_func *func)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) return func_to_acpi_device(func)->handle;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) struct acpiphp_root_context {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136) struct acpi_hotplug_context hp;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) struct acpiphp_bridge *root_bridge;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) static inline struct acpiphp_root_context *to_acpiphp_root_context(struct acpi_hotplug_context *hp)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) return container_of(hp, struct acpiphp_root_context, hp);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) * struct acpiphp_attention_info - device specific attention registration
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148) * ACPI has no generic method of setting/getting attention status
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149) * this allows for device specific driver registration
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151) struct acpiphp_attention_info
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153) int (*set_attn)(struct hotplug_slot *slot, u8 status);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154) int (*get_attn)(struct hotplug_slot *slot, u8 *status);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155) struct module *owner;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158) /* ACPI _STA method value (ignore bit 4; battery present) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159) #define ACPI_STA_ALL (0x0000000f)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 161) /* slot flags */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 162)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 163) #define SLOT_ENABLED (0x00000001)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 164) #define SLOT_IS_GOING_AWAY (0x00000002)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 165)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 166) /* function flags */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 167)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 168) #define FUNC_HAS_STA (0x00000001)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 169) #define FUNC_HAS_EJ0 (0x00000002)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 170)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 171) /* function prototypes */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 172)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 173) /* acpiphp_core.c */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 174) int acpiphp_register_attention(struct acpiphp_attention_info *info);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 175) int acpiphp_unregister_attention(struct acpiphp_attention_info *info);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 176) int acpiphp_register_hotplug_slot(struct acpiphp_slot *slot, unsigned int sun);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 177) void acpiphp_unregister_hotplug_slot(struct acpiphp_slot *slot);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 178)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 179) /* acpiphp_glue.c */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 180) typedef int (*acpiphp_callback)(struct acpiphp_slot *slot, void *data);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 181)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 182) int acpiphp_enable_slot(struct acpiphp_slot *slot);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 183) int acpiphp_disable_slot(struct acpiphp_slot *slot);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 184) u8 acpiphp_get_power_status(struct acpiphp_slot *slot);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 185) u8 acpiphp_get_attention_status(struct acpiphp_slot *slot);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 186) u8 acpiphp_get_latch_status(struct acpiphp_slot *slot);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 187) u8 acpiphp_get_adapter_status(struct acpiphp_slot *slot);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 188)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 189) /* variables */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 190) extern bool acpiphp_disabled;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 191)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 192) #endif /* _ACPIPHP_H */