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_bridge;
  53 struct acpiphp_slot;
  54
  55 /*
  56  * struct slot - slot information for each *physical* slot
  57  */
  58 struct slot {
  59         struct hotplug_slot     *hotplug_slot;
  60         struct acpiphp_slot     *acpi_slot;
  61         struct hotplug_slot_info info;
  62 };
  63
  64 static inline const char *slot_name(struct slot *slot)
  65 {
  66         return hotplug_slot_name(slot->hotplug_slot);
  67 }
  68
  69 /*
  70  * struct acpiphp_bridge - PCI bridge information
  71  *
  72  * for each bridge device in ACPI namespace
  73  */
  74 struct acpiphp_bridge {
  75         struct list_head list;
  76         acpi_handle handle;
  77         struct acpiphp_slot *slots;
  78
  79         /* Ejectable PCI-to-PCI bridge (PCI bridge and PCI function) */
  80         struct acpiphp_func *func;
  81
  82         int nr_slots;
  83
  84         u32 flags;
  85
  86         /* This bus (host bridge) or Secondary bus (PCI-to-PCI bridge) */
  87         struct pci_bus *pci_bus;
  88
  89         /* PCI-to-PCI bridge device */
  90         struct pci_dev *pci_dev;
  91 };
  92
  93
  94 /*
  95  * struct acpiphp_slot - PCI slot information
  96  *
  97  * PCI slot information for each *physical* PCI slot
  98  */
  99 struct acpiphp_slot {
 100         struct acpiphp_slot *next;
 101         struct acpiphp_bridge *bridge;  /* parent */
 102         struct list_head funcs;         /* one slot may have different
 103                                            objects (i.e. for each function) */
 104         struct slot *slot;
 105         struct mutex crit_sect;
 106
 107         u8              device;         /* pci device# */
 108
 109         unsigned long long sun;         /* ACPI _SUN (slot unique number) */
 110         u32             flags;          /* see below */
 111 };
 112
 113
 114 /*
 115  * struct acpiphp_func - PCI function information
 116  *
 117  * PCI function information for each object in ACPI namespace
 118  * typically 8 objects per slot (i.e. for each PCI function)
 119  */
 120 struct acpiphp_func {
 121         struct acpiphp_slot *slot;      /* parent */
 122         struct acpiphp_bridge *bridge;  /* Ejectable PCI-to-PCI bridge */
 123
 124         struct list_head sibling;
 125         struct notifier_block nb;
 126         acpi_handle     handle;
 127
 128         u8              function;       /* pci function# */
 129         u32             flags;          /* see below */
 130 };
 131
 132 /*
 133  * struct acpiphp_attention_info - device specific attention registration
 134  *
 135  * ACPI has no generic method of setting/getting attention status
 136  * this allows for device specific driver registration
 137  */
 138 struct acpiphp_attention_info
 139 {
 140         int (*set_attn)(struct hotplug_slot *slot, u8 status);
 141         int (*get_attn)(struct hotplug_slot *slot, u8 *status);
 142         struct module *owner;
 143 };
 144
 145 /* PCI bus bridge HID */
 146 #define ACPI_PCI_HOST_HID               "PNP0A03"
 147
 148 /* ACPI _STA method value (ignore bit 4; battery present) */
 149 #define ACPI_STA_PRESENT                (0x00000001)
 150 #define ACPI_STA_ENABLED                (0x00000002)
 151 #define ACPI_STA_SHOW_IN_UI             (0x00000004)
 152 #define ACPI_STA_FUNCTIONING            (0x00000008)
 153 #define ACPI_STA_ALL                    (0x0000000f)
 154
 155 /* bridge flags */
 156 #define BRIDGE_HAS_EJ0          (0x00000001)
 157
 158 /* slot flags */
 159
 160 #define SLOT_POWEREDON          (0x00000001)
 161 #define SLOT_ENABLED            (0x00000002)
 162 #define SLOT_MULTIFUNCTION      (0x00000004)
 163
 164 /* function flags */
 165
 166 #define FUNC_HAS_STA            (0x00000001)
 167 #define FUNC_HAS_EJ0            (0x00000002)
 168 #define FUNC_HAS_PS0            (0x00000010)
 169 #define FUNC_HAS_PS1            (0x00000020)
 170 #define FUNC_HAS_PS2            (0x00000040)
 171 #define FUNC_HAS_PS3            (0x00000080)
 172 #define FUNC_HAS_DCK            (0x00000100)
 173
 174 /* function prototypes */
 175
 176 /* acpiphp_core.c */
 177 int acpiphp_register_attention(struct acpiphp_attention_info*info);
 178 int acpiphp_unregister_attention(struct acpiphp_attention_info *info);
 179 int acpiphp_register_hotplug_slot(struct acpiphp_slot *slot);
 180 void acpiphp_unregister_hotplug_slot(struct acpiphp_slot *slot);
 181
 182 /* acpiphp_glue.c */
 183 int acpiphp_glue_init(void);
 184 void acpiphp_glue_exit(void);
 185 typedef int (*acpiphp_callback)(struct acpiphp_slot *slot, void *data);
 186
 187 int acpiphp_enable_slot(struct acpiphp_slot *slot);
 188 int acpiphp_disable_slot(struct acpiphp_slot *slot);
 189 int acpiphp_eject_slot(struct acpiphp_slot *slot);
 190 u8 acpiphp_get_power_status(struct acpiphp_slot *slot);
 191 u8 acpiphp_get_attention_status(struct acpiphp_slot *slot);
 192 u8 acpiphp_get_latch_status(struct acpiphp_slot *slot);
 193 u8 acpiphp_get_adapter_status(struct acpiphp_slot *slot);
 194
 195 /* variables */
 196 extern bool acpiphp_debug;
 197
 198 #endif /* _ACPIPHP_H */