drivers/pci/hotplug/acpiphp.h

   1 /*
   2  * ACPI PCI Hot Plug Controller Driver
   3  *
   4  * Copyright (C) 1995,2001 Compaq Computer Corporation
   5  * Copyright (C) 2001 Greg Kroah-Hartman (greg@kroah.com)
   6  * Copyright (C) 2001 IBM Corp.
   7  * Copyright (C) 2002 Hiroshi Aono (h-aono@ap.jp.nec.com)
   8  * Copyright (C) 2002,2003 Takayoshi Kochi (t-kochi@bq.jp.nec.com)
   9  * Copyright (C) 2002,2003 NEC Corporation
  10  * Copyright (C) 2003-2005 Matthew Wilcox (matthew.wilcox@hp.com)
  11  * Copyright (C) 2003-2005 Hewlett Packard
  12  *
  13  * All rights reserved.
  14  *
  15  * This program is free software; you can redistribute it and/or modify
  16  * it under the terms of the GNU General Public License as published by
  17  * the Free Software Foundation; either version 2 of the License, or (at
  18  * your option) any later version.
  19  *
  20  * This program is distributed in the hope that it will be useful, but
  21  * WITHOUT ANY WARRANTY; without even the implied warranty of
  22  * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
  23  * NON INFRINGEMENT.  See the GNU General Public License for more
  24  * details.
  25  *
  26  * You should have received a copy of the GNU General Public License
  27  * along with this program; if not, write to the Free Software
  28  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  29  *
  30  * Send feedback to <gregkh@us.ibm.com>,
  31  *                  <t-kochi@bq.jp.nec.com>
  32  *
  33  */
  34
  35 #ifndef _ACPIPHP_H
  36 #define _ACPIPHP_H
  37
  38 #include <linux/acpi.h>
  39 #include <linux/mutex.h>
  40 #include <linux/pci_hotplug.h>
  41
  42 struct acpiphp_context;
  43 struct acpiphp_bridge;
  44 struct acpiphp_slot;
  45
  46 /*
  47  * struct slot - slot information for each *physical* slot
  48  */
  49 struct slot {
  50         struct hotplug_slot     *hotplug_slot;
  51         struct acpiphp_slot     *acpi_slot;
  52         struct hotplug_slot_info info;
  53         unsigned int sun;       /* ACPI _SUN (Slot User Number) value */
  54 };
  55
  56 static inline const char *slot_name(struct slot *slot)
  57 {
  58         return hotplug_slot_name(slot->hotplug_slot);
  59 }
  60
  61 /*
  62  * struct acpiphp_bridge - PCI bridge information
  63  *
  64  * for each bridge device in ACPI namespace
  65  */
  66 struct acpiphp_bridge {
  67         struct list_head list;
  68         struct list_head slots;
  69         struct kref ref;
  70
  71         struct acpiphp_context *context;
  72
  73         int nr_slots;
  74
  75         /* This bus (host bridge) or Secondary bus (PCI-to-PCI bridge) */
  76         struct pci_bus *pci_bus;
  77
  78         /* PCI-to-PCI bridge device */
  79         struct pci_dev *pci_dev;
  80
  81         bool is_going_away;
  82 };
  83
  84
  85 /*
  86  * struct acpiphp_slot - PCI slot information
  87  *
  88  * PCI slot information for each *physical* PCI slot
  89  */
  90 struct acpiphp_slot {
  91         struct list_head node;
  92         struct pci_bus *bus;
  93         struct list_head funcs;         /* one slot may have different
  94                                            objects (i.e. for each function) */
  95         struct slot *slot;
  96
  97         u8              device;         /* pci device# */
  98         u32             flags;          /* see below */
  99 };
 100
 101
 102 /*
 103  * struct acpiphp_func - PCI function information
 104  *
 105  * PCI function information for each object in ACPI namespace
 106  * typically 8 objects per slot (i.e. for each PCI function)
 107  */
 108 struct acpiphp_func {
 109         struct acpiphp_bridge *parent;
 110         struct acpiphp_slot *slot;
 111
 112         struct list_head sibling;
 113
 114         u8              function;       /* pci function# */
 115         u32             flags;          /* see below */
 116 };
 117
 118 struct acpiphp_context {
 119         struct acpi_hotplug_context hp;
 120         struct acpiphp_func func;
 121         struct acpiphp_bridge *bridge;
 122         unsigned int refcount;
 123 };
 124
 125 static inline struct acpiphp_context *to_acpiphp_context(struct acpi_hotplug_context *hp)
 126 {
 127         return container_of(hp, struct acpiphp_context, hp);
 128 }
 129
 130 static inline struct acpiphp_context *func_to_context(struct acpiphp_func *func)
 131 {
 132         return container_of(func, struct acpiphp_context, func);
 133 }
 134
 135 static inline struct acpi_device *func_to_acpi_device(struct acpiphp_func *func)
 136 {
 137         return func_to_context(func)->hp.self;
 138 }
 139
 140 static inline acpi_handle func_to_handle(struct acpiphp_func *func)
 141 {
 142         return func_to_acpi_device(func)->handle;
 143 }
 144
 145 struct acpiphp_root_context {
 146         struct acpi_hotplug_context hp;
 147         struct acpiphp_bridge *root_bridge;
 148 };
 149
 150 static inline struct acpiphp_root_context *to_acpiphp_root_context(struct acpi_hotplug_context *hp)
 151 {
 152         return container_of(hp, struct acpiphp_root_context, hp);
 153 }
 154
 155 /*
 156  * struct acpiphp_attention_info - device specific attention registration
 157  *
 158  * ACPI has no generic method of setting/getting attention status
 159  * this allows for device specific driver registration
 160  */
 161 struct acpiphp_attention_info
 162 {
 163         int (*set_attn)(struct hotplug_slot *slot, u8 status);
 164         int (*get_attn)(struct hotplug_slot *slot, u8 *status);
 165         struct module *owner;
 166 };
 167
 168 /* ACPI _STA method value (ignore bit 4; battery present) */
 169 #define ACPI_STA_ALL                    (0x0000000f)
 170
 171 /* slot flags */
 172
 173 #define SLOT_ENABLED            (0x00000001)
 174 #define SLOT_IS_GOING_AWAY      (0x00000002)
 175
 176 /* function flags */
 177
 178 #define FUNC_HAS_STA            (0x00000001)
 179 #define FUNC_HAS_EJ0            (0x00000002)
 180
 181 /* function prototypes */
 182
 183 /* acpiphp_core.c */
 184 int acpiphp_register_attention(struct acpiphp_attention_info *info);
 185 int acpiphp_unregister_attention(struct acpiphp_attention_info *info);
 186 int acpiphp_register_hotplug_slot(struct acpiphp_slot *slot, unsigned int sun);
 187 void acpiphp_unregister_hotplug_slot(struct acpiphp_slot *slot);
 188
 189 /* acpiphp_glue.c */
 190 typedef int (*acpiphp_callback)(struct acpiphp_slot *slot, void *data);
 191
 192 int acpiphp_enable_slot(struct acpiphp_slot *slot);
 193 int acpiphp_disable_slot(struct acpiphp_slot *slot);
 194 u8 acpiphp_get_power_status(struct acpiphp_slot *slot);
 195 u8 acpiphp_get_attention_status(struct acpiphp_slot *slot);
 196 u8 acpiphp_get_latch_status(struct acpiphp_slot *slot);
 197 u8 acpiphp_get_adapter_status(struct acpiphp_slot *slot);
 198
 199 /* variables */
 200 extern bool acpiphp_disabled;
 201
 202 #endif /* _ACPIPHP_H */