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 "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 };
  66
  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         int type;
  79         int nr_slots;
  80
  81         u32 flags;
  82
  83         /* This bus (host bridge) or Secondary bus (PCI-to-PCI bridge) */
  84         struct pci_bus *pci_bus;
  85
  86         /* PCI-to-PCI bridge device */
  87         struct pci_dev *pci_dev;
  88
  89         /* ACPI 2.0 _HPP parameters */
  90         struct hotplug_params hpp;
  91
  92         spinlock_t res_lock;
  93 };
  94
  95
  96 /**
  97  * struct acpiphp_slot - PCI slot information
  98  *
  99  * PCI slot information for each *physical* PCI slot
 100  */
 101 struct acpiphp_slot {
 102         struct acpiphp_slot *next;
 103         struct acpiphp_bridge *bridge;  /* parent */
 104         struct list_head funcs;         /* one slot may have different
 105                                            objects (i.e. for each function) */
 106         struct slot *slot;
 107         struct mutex crit_sect;
 108
 109         u8              device;         /* pci device# */
 110
 111         u32             sun;            /* ACPI _SUN (slot unique number) */
 112         u32             slotno;         /* slot number relative to bridge */
 113         u32             flags;          /* see below */
 114 };
 115
 116
 117 /**
 118  * struct acpiphp_func - PCI function information
 119  *
 120  * PCI function information for each object in ACPI namespace
 121  * typically 8 objects per slot (i.e. for each PCI function)
 122  */
 123 struct acpiphp_func {
 124         struct acpiphp_slot *slot;      /* parent */
 125
 126         struct list_head sibling;
 127         struct pci_dev *pci_dev;
 128
 129         acpi_handle     handle;
 130
 131         u8              function;       /* pci function# */
 132         u32             flags;          /* see below */
 133 };
 134
 135 /**
 136  * struct acpiphp_attention_info - device specific attention registration
 137  *
 138  * ACPI has no generic method of setting/getting attention status
 139  * this allows for device specific driver registration
 140  */
 141 struct acpiphp_attention_info
 142 {
 143         int (*set_attn)(struct hotplug_slot *slot, u8 status);
 144         int (*get_attn)(struct hotplug_slot *slot, u8 *status);
 145         struct module *owner;
 146 };
 147
 148
 149 struct dependent_device {
 150         struct list_head device_list;
 151         struct list_head pci_list;
 152         acpi_handle handle;
 153         struct acpiphp_func *func;
 154 };
 155
 156
 157 struct acpiphp_dock_station {
 158         acpi_handle handle;
 159         u32 last_dock_time;
 160         u32 flags;
 161         struct acpiphp_func *dock_bridge;
 162         struct list_head dependent_devices;
 163         struct list_head pci_dependent_devices;
 164 };
 165
 166
 167 /* PCI bus bridge HID */
 168 #define ACPI_PCI_HOST_HID               "PNP0A03"
 169
 170 /* PCI BRIDGE type */
 171 #define BRIDGE_TYPE_HOST                0
 172 #define BRIDGE_TYPE_P2P                 1
 173
 174 /* ACPI _STA method value (ignore bit 4; battery present) */
 175 #define ACPI_STA_PRESENT                (0x00000001)
 176 #define ACPI_STA_ENABLED                (0x00000002)
 177 #define ACPI_STA_SHOW_IN_UI             (0x00000004)
 178 #define ACPI_STA_FUNCTIONING            (0x00000008)
 179 #define ACPI_STA_ALL                    (0x0000000f)
 180
 181 /* bridge flags */
 182 #define BRIDGE_HAS_STA          (0x00000001)
 183 #define BRIDGE_HAS_EJ0          (0x00000002)
 184 #define BRIDGE_HAS_HPP          (0x00000004)
 185 #define BRIDGE_HAS_PS0          (0x00000010)
 186 #define BRIDGE_HAS_PS1          (0x00000020)
 187 #define BRIDGE_HAS_PS2          (0x00000040)
 188 #define BRIDGE_HAS_PS3          (0x00000080)
 189
 190 /* slot flags */
 191
 192 #define SLOT_POWEREDON          (0x00000001)
 193 #define SLOT_ENABLED            (0x00000002)
 194 #define SLOT_MULTIFUNCTION      (0x00000004)
 195
 196 /* function flags */
 197
 198 #define FUNC_HAS_STA            (0x00000001)
 199 #define FUNC_HAS_EJ0            (0x00000002)
 200 #define FUNC_HAS_PS0            (0x00000010)
 201 #define FUNC_HAS_PS1            (0x00000020)
 202 #define FUNC_HAS_PS2            (0x00000040)
 203 #define FUNC_HAS_PS3            (0x00000080)
 204 #define FUNC_HAS_DCK            (0x00000100)
 205 #define FUNC_IS_DD              (0x00000200)
 206
 207 /* dock station flags */
 208 #define DOCK_DOCKING            (0x00000001)
 209 #define DOCK_HAS_BRIDGE         (0x00000002)
 210
 211 /* function prototypes */
 212
 213 /* acpiphp_core.c */
 214 extern int acpiphp_register_attention(struct acpiphp_attention_info*info);
 215 extern int acpiphp_unregister_attention(struct acpiphp_attention_info *info);
 216 extern int acpiphp_register_hotplug_slot(struct acpiphp_slot *slot);
 217 extern void acpiphp_unregister_hotplug_slot(struct acpiphp_slot *slot);
 218
 219 /* acpiphp_glue.c */
 220 extern int acpiphp_glue_init (void);
 221 extern void acpiphp_glue_exit (void);
 222 extern int acpiphp_get_num_slots (void);
 223 typedef int (*acpiphp_callback)(struct acpiphp_slot *slot, void *data);
 224 void handle_hotplug_event_func(acpi_handle, u32, void*);
 225
 226 extern int acpiphp_enable_slot (struct acpiphp_slot *slot);
 227 extern int acpiphp_disable_slot (struct acpiphp_slot *slot);
 228 extern u8 acpiphp_get_power_status (struct acpiphp_slot *slot);
 229 extern u8 acpiphp_get_attention_status (struct acpiphp_slot *slot);
 230 extern u8 acpiphp_get_latch_status (struct acpiphp_slot *slot);
 231 extern u8 acpiphp_get_adapter_status (struct acpiphp_slot *slot);
 232 extern u32 acpiphp_get_address (struct acpiphp_slot *slot);
 233
 234 /* acpiphp_dock.c */
 235 extern int find_dock_station(void);
 236 extern void remove_dock_station(void);
 237 extern void add_dependent_device(struct dependent_device *new_dd);
 238 extern void add_pci_dependent_device(struct dependent_device *new_dd);
 239 extern struct dependent_device *get_dependent_device(acpi_handle handle);
 240 extern int is_dependent_device(acpi_handle handle);
 241 extern int detect_dependent_devices(acpi_handle *bridge_handle);
 242 extern struct dependent_device *alloc_dependent_device(acpi_handle handle);
 243
 244 /* variables */
 245 extern int acpiphp_debug;
 246
 247 #endif /* _ACPIPHP_H */