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 #define dbg(format, arg...)                                     \
  43         do {                                                    \
  44                 if (acpiphp_debug)                              \
  45                         printk(KERN_DEBUG "%s: " format,        \
  46                                 MY_NAME , ## arg);              \
  47         } while (0)
  48 #define err(format, arg...) printk(KERN_ERR "%s: " format, MY_NAME , ## arg)
  49 #define info(format, arg...) printk(KERN_INFO "%s: " format, MY_NAME , ## arg)
  50 #define warn(format, arg...) printk(KERN_WARNING "%s: " format, MY_NAME , ## arg)
  51
  52 struct acpiphp_context;
  53 struct acpiphp_bridge;
  54 struct acpiphp_slot;
  55
  56 /*
  57  * struct slot - slot information for each *physical* slot
  58  */
  59 struct slot {
  60         struct hotplug_slot     *hotplug_slot;
  61         struct acpiphp_slot     *acpi_slot;
  62         struct hotplug_slot_info info;
  63         unsigned int sun;       /* ACPI _SUN (Slot User Number) value */
  64 };
  65
  66 static inline const char *slot_name(struct slot *slot)
  67 {
  68         return hotplug_slot_name(slot->hotplug_slot);
  69 }
  70
  71 /*
  72  * struct acpiphp_bridge - PCI bridge information
  73  *
  74  * for each bridge device in ACPI namespace
  75  */
  76 struct acpiphp_bridge {
  77         struct list_head list;
  78         struct list_head slots;
  79         struct kref ref;
  80
  81         struct acpiphp_context *context;
  82
  83         int nr_slots;
  84
  85         /* This bus (host bridge) or Secondary bus (PCI-to-PCI bridge) */
  86         struct pci_bus *pci_bus;
  87
  88         /* PCI-to-PCI bridge device */
  89         struct pci_dev *pci_dev;
  90 };
  91
  92
  93 /*
  94  * struct acpiphp_slot - PCI slot information
  95  *
  96  * PCI slot information for each *physical* PCI slot
  97  */
  98 struct acpiphp_slot {
  99         struct list_head node;
 100         struct pci_bus *bus;
 101         struct list_head funcs;         /* one slot may have different
 102                                            objects (i.e. for each function) */
 103         struct slot *slot;
 104         struct mutex crit_sect;
 105
 106         u8              device;         /* pci device# */
 107         u32             flags;          /* see below */
 108 };
 109
 110
 111 /*
 112  * struct acpiphp_func - PCI function information
 113  *
 114  * PCI function information for each object in ACPI namespace
 115  * typically 8 objects per slot (i.e. for each PCI function)
 116  */
 117 struct acpiphp_func {
 118         struct acpiphp_bridge *parent;
 119         struct acpiphp_slot *slot;
 120
 121         struct list_head sibling;
 122
 123         u8              function;       /* pci function# */
 124         u32             flags;          /* see below */
 125 };
 126
 127 struct acpiphp_context {
 128         acpi_handle handle;
 129         struct acpiphp_func func;
 130         struct acpiphp_bridge *bridge;
 131         unsigned int refcount;
 132 };
 133
 134 static inline struct acpiphp_context *func_to_context(struct acpiphp_func *func)
 135 {
 136         return container_of(func, struct acpiphp_context, func);
 137 }
 138
 139 static inline acpi_handle func_to_handle(struct acpiphp_func *func)
 140 {
 141         return func_to_context(func)->handle;
 142 }
 143
 144 /*
 145  * struct acpiphp_attention_info - device specific attention registration
 146  *
 147  * ACPI has no generic method of setting/getting attention status
 148  * this allows for device specific driver registration
 149  */
 150 struct acpiphp_attention_info
 151 {
 152         int (*set_attn)(struct hotplug_slot *slot, u8 status);
 153         int (*get_attn)(struct hotplug_slot *slot, u8 *status);
 154         struct module *owner;
 155 };
 156
 157 /* ACPI _STA method value (ignore bit 4; battery present) */
 158 #define ACPI_STA_ALL                    (0x0000000f)
 159
 160 /* slot flags */
 161
 162 #define SLOT_ENABLED            (0x00000001)
 163
 164 /* function flags */
 165
 166 #define FUNC_HAS_STA            (0x00000001)
 167 #define FUNC_HAS_EJ0            (0x00000002)
 168 #define FUNC_HAS_DCK            (0x00000004)
 169
 170 /* function prototypes */
 171
 172 /* acpiphp_core.c */
 173 int acpiphp_register_attention(struct acpiphp_attention_info*info);
 174 int acpiphp_unregister_attention(struct acpiphp_attention_info *info);
 175 int acpiphp_register_hotplug_slot(struct acpiphp_slot *slot, unsigned int sun);
 176 void acpiphp_unregister_hotplug_slot(struct acpiphp_slot *slot);
 177
 178 /* acpiphp_glue.c */
 179 typedef int (*acpiphp_callback)(struct acpiphp_slot *slot, void *data);
 180
 181 int acpiphp_enable_slot(struct acpiphp_slot *slot);
 182 int acpiphp_disable_and_eject_slot(struct acpiphp_slot *slot);
 183 u8 acpiphp_get_power_status(struct acpiphp_slot *slot);
 184 u8 acpiphp_get_attention_status(struct acpiphp_slot *slot);
 185 u8 acpiphp_get_latch_status(struct acpiphp_slot *slot);
 186 u8 acpiphp_get_adapter_status(struct acpiphp_slot *slot);
 187
 188 /* variables */
 189 extern bool acpiphp_debug;
 190 extern bool acpiphp_disabled;
 191
 192 #endif /* _ACPIPHP_H */