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