include/acpi/acpi_bus.h

   1 /*
   2  *  acpi_bus.h - ACPI Bus Driver ($Revision: 22 $)
   3  *
   4  *  Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
   5  *  Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
   6  *
   7  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   8  *
   9  *  This program is free software; you can redistribute it and/or modify
  10  *  it under the terms of the GNU General Public License as published by
  11  *  the Free Software Foundation; either version 2 of the License, or (at
  12  *  your option) any later version.
  13  *
  14  *  This program is distributed in the hope that it will be useful, but
  15  *  WITHOUT ANY WARRANTY; without even the implied warranty of
  16  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  *  General Public License for more details.
  18  *
  19  *  You should have received a copy of the GNU General Public License along
  20  *  with this program; if not, write to the Free Software Foundation, Inc.,
  21  *  59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
  22  *
  23  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  24  */
  25
  26 #ifndef __ACPI_BUS_H__
  27 #define __ACPI_BUS_H__
  28
  29 #include <linux/device.h>
  30
  31 #include <acpi/acpi.h>
  32
  33 /* TBD: Make dynamic */
  34 #define ACPI_MAX_HANDLES        10
  35 struct acpi_handle_list {
  36         u32 count;
  37         acpi_handle handles[ACPI_MAX_HANDLES];
  38 };
  39
  40 /* acpi_utils.h */
  41 acpi_status
  42 acpi_extract_package(union acpi_object *package,
  43                      struct acpi_buffer *format, struct acpi_buffer *buffer);
  44 acpi_status
  45 acpi_evaluate_integer(acpi_handle handle,
  46                       acpi_string pathname,
  47                       struct acpi_object_list *arguments, unsigned long long *data);
  48 acpi_status
  49 acpi_evaluate_reference(acpi_handle handle,
  50                         acpi_string pathname,
  51                         struct acpi_object_list *arguments,
  52                         struct acpi_handle_list *list);
  53
  54 #ifdef CONFIG_ACPI
  55
  56 #include <linux/proc_fs.h>
  57
  58 #define ACPI_BUS_FILE_ROOT      "acpi"
  59 extern struct proc_dir_entry *acpi_root_dir;
  60
  61 enum acpi_bus_removal_type {
  62         ACPI_BUS_REMOVAL_NORMAL = 0,
  63         ACPI_BUS_REMOVAL_EJECT,
  64         ACPI_BUS_REMOVAL_SUPRISE,
  65         ACPI_BUS_REMOVAL_TYPE_COUNT
  66 };
  67
  68 enum acpi_bus_device_type {
  69         ACPI_BUS_TYPE_DEVICE = 0,
  70         ACPI_BUS_TYPE_POWER,
  71         ACPI_BUS_TYPE_PROCESSOR,
  72         ACPI_BUS_TYPE_THERMAL,
  73         ACPI_BUS_TYPE_POWER_BUTTON,
  74         ACPI_BUS_TYPE_SLEEP_BUTTON,
  75         ACPI_BUS_DEVICE_TYPE_COUNT
  76 };
  77
  78 struct acpi_driver;
  79 struct acpi_device;
  80
  81 /*
  82  * ACPI Driver
  83  * -----------
  84  */
  85
  86 typedef int (*acpi_op_add) (struct acpi_device * device);
  87 typedef int (*acpi_op_remove) (struct acpi_device * device, int type);
  88 typedef int (*acpi_op_start) (struct acpi_device * device);
  89 typedef int (*acpi_op_suspend) (struct acpi_device * device,
  90                                 pm_message_t state);
  91 typedef int (*acpi_op_resume) (struct acpi_device * device);
  92 typedef int (*acpi_op_bind) (struct acpi_device * device);
  93 typedef int (*acpi_op_unbind) (struct acpi_device * device);
  94 typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event);
  95
  96 struct acpi_bus_ops {
  97         u32 acpi_op_add:1;
  98         u32 acpi_op_start:1;
  99 };
 100
 101 struct acpi_device_ops {
 102         acpi_op_add add;
 103         acpi_op_remove remove;
 104         acpi_op_start start;
 105         acpi_op_suspend suspend;
 106         acpi_op_resume resume;
 107         acpi_op_bind bind;
 108         acpi_op_unbind unbind;
 109         acpi_op_notify notify;
 110 };
 111
 112 #define ACPI_DRIVER_ALL_NOTIFY_EVENTS   0x1     /* system AND device events */
 113
 114 struct acpi_driver {
 115         char name[80];
 116         char class[80];
 117         const struct acpi_device_id *ids; /* Supported Hardware IDs */
 118         unsigned int flags;
 119         struct acpi_device_ops ops;
 120         struct device_driver drv;
 121         struct module *owner;
 122 };
 123
 124 /*
 125  * ACPI Device
 126  * -----------
 127  */
 128
 129 /* Status (_STA) */
 130
 131 struct acpi_device_status {
 132         u32 present:1;
 133         u32 enabled:1;
 134         u32 show_in_ui:1;
 135         u32 functional:1;
 136         u32 battery_present:1;
 137         u32 reserved:27;
 138 };
 139
 140 /* Flags */
 141
 142 struct acpi_device_flags {
 143         u32 dynamic_status:1;
 144         u32 bus_address:1;
 145         u32 removable:1;
 146         u32 ejectable:1;
 147         u32 lockable:1;
 148         u32 suprise_removal_ok:1;
 149         u32 power_manageable:1;
 150         u32 performance_manageable:1;
 151         u32 reserved:24;
 152 };
 153
 154 /* File System */
 155
 156 struct acpi_device_dir {
 157         struct proc_dir_entry *entry;
 158 };
 159
 160 #define acpi_device_dir(d)      ((d)->dir.entry)
 161
 162 /* Plug and Play */
 163
 164 typedef char acpi_bus_id[8];
 165 typedef unsigned long acpi_bus_address;
 166 typedef char acpi_device_name[40];
 167 typedef char acpi_device_class[20];
 168
 169 struct acpi_hardware_id {
 170         struct list_head list;
 171         char *id;
 172 };
 173
 174 struct acpi_device_pnp {
 175         acpi_bus_id bus_id;     /* Object name */
 176         acpi_bus_address bus_address;   /* _ADR */
 177         char *unique_id;        /* _UID */
 178         struct list_head ids;           /* _HID and _CIDs */
 179         acpi_device_name device_name;   /* Driver-determined */
 180         acpi_device_class device_class; /*        "          */
 181 };
 182
 183 #define acpi_device_bid(d)      ((d)->pnp.bus_id)
 184 #define acpi_device_adr(d)      ((d)->pnp.bus_address)
 185 const char *acpi_device_hid(struct acpi_device *device);
 186 #define acpi_device_name(d)     ((d)->pnp.device_name)
 187 #define acpi_device_class(d)    ((d)->pnp.device_class)
 188
 189 /* Power Management */
 190
 191 struct acpi_device_power_flags {
 192         u32 explicit_get:1;     /* _PSC present? */
 193         u32 power_resources:1;  /* Power resources */
 194         u32 inrush_current:1;   /* Serialize Dx->D0 */
 195         u32 power_removed:1;    /* Optimize Dx->D0 */
 196         u32 reserved:28;
 197 };
 198
 199 struct acpi_device_power_state {
 200         struct {
 201                 u8 valid:1;
 202                 u8 explicit_set:1;      /* _PSx present? */
 203                 u8 reserved:6;
 204         } flags;
 205         int power;              /* % Power (compared to D0) */
 206         int latency;            /* Dx->D0 time (microseconds) */
 207         struct acpi_handle_list resources;      /* Power resources referenced */
 208 };
 209
 210 struct acpi_device_power {
 211         int state;              /* Current state */
 212         struct acpi_device_power_flags flags;
 213         struct acpi_device_power_state states[ACPI_D_STATE_COUNT];      /* Power states (D0-D3Cold) */
 214 };
 215
 216 /* Performance Management */
 217
 218 struct acpi_device_perf_flags {
 219         u8 reserved:8;
 220 };
 221
 222 struct acpi_device_perf_state {
 223         struct {
 224                 u8 valid:1;
 225                 u8 reserved:7;
 226         } flags;
 227         u8 power;               /* % Power (compared to P0) */
 228         u8 performance;         /* % Performance (    "   ) */
 229         int latency;            /* Px->P0 time (microseconds) */
 230 };
 231
 232 struct acpi_device_perf {
 233         int state;
 234         struct acpi_device_perf_flags flags;
 235         int state_count;
 236         struct acpi_device_perf_state *states;
 237 };
 238
 239 /* Wakeup Management */
 240 struct acpi_device_wakeup_flags {
 241         u8 valid:1;             /* Can successfully enable wakeup? */
 242         u8 run_wake:1;          /* Run-Wake GPE devices */
 243         u8 notifier_present:1;  /* Wake-up notify handler has been installed */
 244 };
 245
 246 struct acpi_device_wakeup {
 247         acpi_handle gpe_device;
 248         u64 gpe_number;
 249         u64 sleep_state;
 250         struct acpi_handle_list resources;
 251         struct acpi_device_wakeup_flags flags;
 252         int prepare_count;
 253 };
 254
 255 /* Device */
 256
 257 struct acpi_device {
 258         int device_type;
 259         acpi_handle handle;             /* no handle for fixed hardware */
 260         struct acpi_device *parent;
 261         struct list_head children;
 262         struct list_head node;
 263         struct list_head wakeup_list;
 264         struct acpi_device_status status;
 265         struct acpi_device_flags flags;
 266         struct acpi_device_pnp pnp;
 267         struct acpi_device_power power;
 268         struct acpi_device_wakeup wakeup;
 269         struct acpi_device_perf performance;
 270         struct acpi_device_dir dir;
 271         struct acpi_device_ops ops;
 272         struct acpi_driver *driver;
 273         void *driver_data;
 274         struct device dev;
 275         struct acpi_bus_ops bus_ops;    /* workaround for different code path for hotplug */
 276         enum acpi_bus_removal_type removal_type;        /* indicate for different removal type */
 277 };
 278
 279 static inline void *acpi_driver_data(struct acpi_device *d)
 280 {
 281         return d->driver_data;
 282 }
 283
 284 #define to_acpi_device(d)       container_of(d, struct acpi_device, dev)
 285 #define to_acpi_driver(d)       container_of(d, struct acpi_driver, drv)
 286
 287 /* acpi_device.dev.bus == &acpi_bus_type */
 288 extern struct bus_type acpi_bus_type;
 289
 290 /*
 291  * Events
 292  * ------
 293  */
 294
 295 struct acpi_bus_event {
 296         struct list_head node;
 297         acpi_device_class device_class;
 298         acpi_bus_id bus_id;
 299         u32 type;
 300         u32 data;
 301 };
 302
 303 extern struct kobject *acpi_kobj;
 304 extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int);
 305 void acpi_bus_private_data_handler(acpi_handle, void *);
 306 int acpi_bus_get_private_data(acpi_handle, void **);
 307 extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32);
 308 extern int register_acpi_notifier(struct notifier_block *);
 309 extern int unregister_acpi_notifier(struct notifier_block *);
 310
 311 extern int register_acpi_bus_notifier(struct notifier_block *nb);
 312 extern void unregister_acpi_bus_notifier(struct notifier_block *nb);
 313 /*
 314  * External Functions
 315  */
 316
 317 int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device);
 318 void acpi_bus_data_handler(acpi_handle handle, void *context);
 319 acpi_status acpi_bus_get_status_handle(acpi_handle handle,
 320                                        unsigned long long *sta);
 321 int acpi_bus_get_status(struct acpi_device *device);
 322 int acpi_bus_set_power(acpi_handle handle, int state);
 323 int acpi_bus_update_power(acpi_handle handle, int *state_p);
 324 bool acpi_bus_power_manageable(acpi_handle handle);
 325 bool acpi_bus_can_wakeup(acpi_handle handle);
 326 #ifdef CONFIG_ACPI_PROC_EVENT
 327 int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data);
 328 int acpi_bus_generate_proc_event4(const char *class, const char *bid, u8 type, int data);
 329 int acpi_bus_receive_event(struct acpi_bus_event *event);
 330 #else
 331 static inline int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data)
 332         { return 0; }
 333 #endif
 334 int acpi_bus_register_driver(struct acpi_driver *driver);
 335 void acpi_bus_unregister_driver(struct acpi_driver *driver);
 336 int acpi_bus_add(struct acpi_device **child, struct acpi_device *parent,
 337                  acpi_handle handle, int type);
 338 int acpi_bus_trim(struct acpi_device *start, int rmdevice);
 339 int acpi_bus_start(struct acpi_device *device);
 340 acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
 341 int acpi_match_device_ids(struct acpi_device *device,
 342                           const struct acpi_device_id *ids);
 343 int acpi_create_dir(struct acpi_device *);
 344 void acpi_remove_dir(struct acpi_device *);
 345
 346 /*
 347  * Bind physical devices with ACPI devices
 348  */
 349 struct acpi_bus_type {
 350         struct list_head list;
 351         struct bus_type *bus;
 352         /* For general devices under the bus */
 353         int (*find_device) (struct device *, acpi_handle *);
 354         /* For bridges, such as PCI root bridge, IDE controller */
 355         int (*find_bridge) (struct device *, acpi_handle *);
 356 };
 357 int register_acpi_bus_type(struct acpi_bus_type *);
 358 int unregister_acpi_bus_type(struct acpi_bus_type *);
 359 struct device *acpi_get_physical_device(acpi_handle);
 360
 361 struct acpi_pci_root {
 362         struct list_head node;
 363         struct acpi_device * device;
 364         struct acpi_pci_id id;
 365         struct pci_bus *bus;
 366         u16 segment;
 367         struct resource secondary;      /* downstream bus range */
 368
 369         u32 osc_support_set;    /* _OSC state of support bits */
 370         u32 osc_control_set;    /* _OSC state of control bits */
 371 };
 372
 373 /* helper */
 374 acpi_handle acpi_get_child(acpi_handle, u64);
 375 int acpi_is_root_bridge(acpi_handle);
 376 acpi_handle acpi_get_pci_rootbridge_handle(unsigned int, unsigned int);
 377 struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle);
 378 #define DEVICE_ACPI_HANDLE(dev) ((acpi_handle)((dev)->archdata.acpi_handle))
 379
 380 int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state);
 381 int acpi_disable_wakeup_device_power(struct acpi_device *dev);
 382
 383 #ifdef CONFIG_PM
 384 int acpi_pm_device_sleep_state(struct device *, int *);
 385 #else
 386 static inline int acpi_pm_device_sleep_state(struct device *d, int *p)
 387 {
 388         if (p)
 389                 *p = ACPI_STATE_D0;
 390         return ACPI_STATE_D3;
 391 }
 392 #endif
 393
 394 #ifdef CONFIG_PM_SLEEP
 395 int acpi_pm_device_sleep_wake(struct device *, bool);
 396 #else
 397 static inline int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
 398 {
 399         return -ENODEV;
 400 }
 401 #endif
 402
 403 #endif                          /* CONFIG_ACPI */
 404
 405 #endif /*__ACPI_BUS_H__*/