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/kobject.h>      /* for KOBJ_NAME_LEN */
  40 #include <linux/mutex.h>
  41 #include <linux/pci_hotplug.h>
  42
  43 #define dbg(format, arg...)                                     \
  44         do {                                                    \
  45                 if (acpiphp_debug)                              \
  46                         printk(KERN_DEBUG "%s: " format,        \
  47                                 MY_NAME , ## arg);              \
  48         } while (0)
  49 #define err(format, arg...) printk(KERN_ERR "%s: " format, MY_NAME , ## arg)
  50 #define info(format, arg...) printk(KERN_INFO "%s: " format, MY_NAME , ## arg)
  51 #define warn(format, arg...) printk(KERN_WARNING "%s: " format, MY_NAME , ## arg)
  52
  53 /* name size which is used for entries in pcihpfs */
  54 #define SLOT_NAME_SIZE  KOBJ_NAME_LEN           /* {_SUN} */
  55
  56 struct acpiphp_bridge;
  57 struct acpiphp_slot;
  58
  59 /*
  60  * struct slot - slot information for each *physical* slot
  61  */
  62 struct slot {
  63         struct hotplug_slot     *hotplug_slot;
  64         struct acpiphp_slot     *acpi_slot;
  65         struct hotplug_slot_info info;
  66         char name[SLOT_NAME_SIZE];
  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 type;
  83         int nr_slots;
  84
  85         u32 flags;
  86
  87         /* This bus (host bridge) or Secondary bus (PCI-to-PCI bridge) */
  88         struct pci_bus *pci_bus;
  89
  90         /* PCI-to-PCI bridge device */
  91         struct pci_dev *pci_dev;
  92
  93         /* ACPI 2.0 _HPP parameters */
  94         struct hotplug_params hpp;
  95
  96         spinlock_t res_lock;
  97 };
  98
  99
 100 /**
 101  * struct acpiphp_slot - PCI slot information
 102  *
 103  * PCI slot information for each *physical* PCI slot
 104  */
 105 struct acpiphp_slot {
 106         struct acpiphp_slot *next;
 107         struct acpiphp_bridge *bridge;  /* parent */
 108         struct list_head funcs;         /* one slot may have different
 109                                            objects (i.e. for each function) */
 110         struct slot *slot;
 111         struct mutex crit_sect;
 112
 113         u8              device;         /* pci device# */
 114
 115         u32             sun;            /* ACPI _SUN (slot unique number) */
 116         u32             slotno;         /* slot number relative to bridge */
 117         u32             flags;          /* see below */
 118 };
 119
 120
 121 /**
 122  * struct acpiphp_func - PCI function information
 123  *
 124  * PCI function information for each object in ACPI namespace
 125  * typically 8 objects per slot (i.e. for each PCI function)
 126  */
 127 struct acpiphp_func {
 128         struct acpiphp_slot *slot;      /* parent */
 129         struct acpiphp_bridge *bridge;  /* Ejectable PCI-to-PCI bridge */
 130
 131         struct list_head sibling;
 132         struct pci_dev *pci_dev;
 133         struct notifier_block nb;
 134         acpi_handle     handle;
 135
 136         u8              function;       /* pci function# */
 137         u32             flags;          /* see below */
 138 };
 139
 140 /**
 141  * struct acpiphp_attention_info - device specific attention registration
 142  *
 143  * ACPI has no generic method of setting/getting attention status
 144  * this allows for device specific driver registration
 145  */
 146 struct acpiphp_attention_info
 147 {
 148         int (*set_attn)(struct hotplug_slot *slot, u8 status);
 149         int (*get_attn)(struct hotplug_slot *slot, u8 *status);
 150         struct module *owner;
 151 };
 152
 153 struct acpiphp_ioapic {
 154         struct pci_dev *dev;
 155         u32 gsi_base;
 156         struct list_head list;
 157 };
 158
 159 /* PCI bus bridge HID */
 160 #define ACPI_PCI_HOST_HID               "PNP0A03"
 161
 162 /* PCI BRIDGE type */
 163 #define BRIDGE_TYPE_HOST                0
 164 #define BRIDGE_TYPE_P2P                 1
 165
 166 /* ACPI _STA method value (ignore bit 4; battery present) */
 167 #define ACPI_STA_PRESENT                (0x00000001)
 168 #define ACPI_STA_ENABLED                (0x00000002)
 169 #define ACPI_STA_SHOW_IN_UI             (0x00000004)
 170 #define ACPI_STA_FUNCTIONING            (0x00000008)
 171 #define ACPI_STA_ALL                    (0x0000000f)
 172
 173 /* bridge flags */
 174 #define BRIDGE_HAS_STA          (0x00000001)
 175 #define BRIDGE_HAS_EJ0          (0x00000002)
 176 #define BRIDGE_HAS_HPP          (0x00000004)
 177 #define BRIDGE_HAS_PS0          (0x00000010)
 178 #define BRIDGE_HAS_PS1          (0x00000020)
 179 #define BRIDGE_HAS_PS2          (0x00000040)
 180 #define BRIDGE_HAS_PS3          (0x00000080)
 181
 182 /* slot flags */
 183
 184 #define SLOT_POWEREDON          (0x00000001)
 185 #define SLOT_ENABLED            (0x00000002)
 186 #define SLOT_MULTIFUNCTION      (0x00000004)
 187
 188 /* function flags */
 189
 190 #define FUNC_HAS_STA            (0x00000001)
 191 #define FUNC_HAS_EJ0            (0x00000002)
 192 #define FUNC_HAS_PS0            (0x00000010)
 193 #define FUNC_HAS_PS1            (0x00000020)
 194 #define FUNC_HAS_PS2            (0x00000040)
 195 #define FUNC_HAS_PS3            (0x00000080)
 196 #define FUNC_HAS_DCK            (0x00000100)
 197
 198 /* function prototypes */
 199
 200 /* acpiphp_core.c */
 201 extern int acpiphp_register_attention(struct acpiphp_attention_info*info);
 202 extern int acpiphp_unregister_attention(struct acpiphp_attention_info *info);
 203 extern int acpiphp_register_hotplug_slot(struct acpiphp_slot *slot);
 204 extern void acpiphp_unregister_hotplug_slot(struct acpiphp_slot *slot);
 205
 206 /* acpiphp_glue.c */
 207 extern int acpiphp_glue_init (void);
 208 extern void acpiphp_glue_exit (void);
 209 extern int acpiphp_get_num_slots (void);
 210 typedef int (*acpiphp_callback)(struct acpiphp_slot *slot, void *data);
 211
 212 extern int acpiphp_enable_slot (struct acpiphp_slot *slot);
 213 extern int acpiphp_disable_slot (struct acpiphp_slot *slot);
 214 extern int acpiphp_eject_slot (struct acpiphp_slot *slot);
 215 extern u8 acpiphp_get_power_status (struct acpiphp_slot *slot);
 216 extern u8 acpiphp_get_attention_status (struct acpiphp_slot *slot);
 217 extern u8 acpiphp_get_latch_status (struct acpiphp_slot *slot);
 218 extern u8 acpiphp_get_adapter_status (struct acpiphp_slot *slot);
 219 extern u32 acpiphp_get_address (struct acpiphp_slot *slot);
 220
 221 /* variables */
 222 extern int acpiphp_debug;
 223
 224 #endif /* _ACPIPHP_H */