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 acpi_status
  54 acpi_evaluate_hotplug_ost(acpi_handle handle, u32 source_event,
  55                         u32 status_code, struct acpi_buffer *status_buf);
  56
  57 acpi_status
  58 acpi_get_physical_device_location(acpi_handle handle, struct acpi_pld_info **pld);
  59 #ifdef CONFIG_ACPI
  60
  61 #include <linux/proc_fs.h>
  62
  63 #define ACPI_BUS_FILE_ROOT      "acpi"
  64 extern struct proc_dir_entry *acpi_root_dir;
  65
  66 enum acpi_bus_removal_type {
  67         ACPI_BUS_REMOVAL_NORMAL = 0,
  68         ACPI_BUS_REMOVAL_EJECT,
  69         ACPI_BUS_REMOVAL_SUPRISE,
  70         ACPI_BUS_REMOVAL_TYPE_COUNT
  71 };
  72
  73 enum acpi_bus_device_type {
  74         ACPI_BUS_TYPE_DEVICE = 0,
  75         ACPI_BUS_TYPE_POWER,
  76         ACPI_BUS_TYPE_PROCESSOR,
  77         ACPI_BUS_TYPE_THERMAL,
  78         ACPI_BUS_TYPE_POWER_BUTTON,
  79         ACPI_BUS_TYPE_SLEEP_BUTTON,
  80         ACPI_BUS_DEVICE_TYPE_COUNT
  81 };
  82
  83 struct acpi_driver;
  84 struct acpi_device;
  85
  86 /*
  87  * ACPI Driver
  88  * -----------
  89  */
  90
  91 typedef int (*acpi_op_add) (struct acpi_device * device);
  92 typedef int (*acpi_op_remove) (struct acpi_device * device, int type);
  93 typedef int (*acpi_op_start) (struct acpi_device * device);
  94 typedef int (*acpi_op_bind) (struct acpi_device * device);
  95 typedef int (*acpi_op_unbind) (struct acpi_device * device);
  96 typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event);
  97
  98 struct acpi_bus_ops {
  99         u32 acpi_op_add:1;
 100         u32 acpi_op_start:1;
 101 };
 102
 103 struct acpi_device_ops {
 104         acpi_op_add add;
 105         acpi_op_remove remove;
 106         acpi_op_start start;
 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 eject_pending:1;
 152         u32 reserved:23;
 153 };
 154
 155 /* File System */
 156
 157 struct acpi_device_dir {
 158         struct proc_dir_entry *entry;
 159 };
 160
 161 #define acpi_device_dir(d)      ((d)->dir.entry)
 162
 163 /* Plug and Play */
 164
 165 typedef char acpi_bus_id[8];
 166 typedef unsigned long acpi_bus_address;
 167 typedef char acpi_device_name[40];
 168 typedef char acpi_device_class[20];
 169
 170 struct acpi_hardware_id {
 171         struct list_head list;
 172         char *id;
 173 };
 174
 175 struct acpi_device_pnp {
 176         acpi_bus_id bus_id;     /* Object name */
 177         acpi_bus_address bus_address;   /* _ADR */
 178         char *unique_id;        /* _UID */
 179         struct list_head ids;           /* _HID and _CIDs */
 180         acpi_device_name device_name;   /* Driver-determined */
 181         acpi_device_class device_class; /*        "          */
 182         union acpi_object *str_obj;     /* unicode string for _STR method */
 183 };
 184
 185 #define acpi_device_bid(d)      ((d)->pnp.bus_id)
 186 #define acpi_device_adr(d)      ((d)->pnp.bus_address)
 187 const char *acpi_device_hid(struct acpi_device *device);
 188 #define acpi_device_name(d)     ((d)->pnp.device_name)
 189 #define acpi_device_class(d)    ((d)->pnp.device_class)
 190
 191 /* Power Management */
 192
 193 struct acpi_device_power_flags {
 194         u32 explicit_get:1;     /* _PSC present? */
 195         u32 power_resources:1;  /* Power resources */
 196         u32 inrush_current:1;   /* Serialize Dx->D0 */
 197         u32 power_removed:1;    /* Optimize Dx->D0 */
 198         u32 reserved:28;
 199 };
 200
 201 struct acpi_device_power_state {
 202         struct {
 203                 u8 valid:1;
 204                 u8 explicit_set:1;      /* _PSx present? */
 205                 u8 reserved:6;
 206         } flags;
 207         int power;              /* % Power (compared to D0) */
 208         int latency;            /* Dx->D0 time (microseconds) */
 209         struct acpi_handle_list resources;      /* Power resources referenced */
 210 };
 211
 212 struct acpi_device_power {
 213         int state;              /* Current state */
 214         struct acpi_device_power_flags flags;
 215         struct acpi_device_power_state states[ACPI_D_STATE_COUNT];      /* Power states (D0-D3Cold) */
 216 };
 217
 218 /* Performance Management */
 219
 220 struct acpi_device_perf_flags {
 221         u8 reserved:8;
 222 };
 223
 224 struct acpi_device_perf_state {
 225         struct {
 226                 u8 valid:1;
 227                 u8 reserved:7;
 228         } flags;
 229         u8 power;               /* % Power (compared to P0) */
 230         u8 performance;         /* % Performance (    "   ) */
 231         int latency;            /* Px->P0 time (microseconds) */
 232 };
 233
 234 struct acpi_device_perf {
 235         int state;
 236         struct acpi_device_perf_flags flags;
 237         int state_count;
 238         struct acpi_device_perf_state *states;
 239 };
 240
 241 /* Wakeup Management */
 242 struct acpi_device_wakeup_flags {
 243         u8 valid:1;             /* Can successfully enable wakeup? */
 244         u8 run_wake:1;          /* Run-Wake GPE devices */
 245         u8 notifier_present:1;  /* Wake-up notify handler has been installed */
 246 };
 247
 248 struct acpi_device_wakeup {
 249         acpi_handle gpe_device;
 250         u64 gpe_number;
 251         u64 sleep_state;
 252         struct acpi_handle_list resources;
 253         struct acpi_device_wakeup_flags flags;
 254         int prepare_count;
 255 };
 256
 257 struct acpi_device_physical_node {
 258         u8 node_id;
 259         struct list_head node;
 260         struct device *dev;
 261 };
 262
 263 /* set maximum of physical nodes to 32 for expansibility */
 264 #define ACPI_MAX_PHYSICAL_NODE  32
 265
 266 /* Device */
 267 struct acpi_device {
 268         int device_type;
 269         acpi_handle handle;             /* no handle for fixed hardware */
 270         struct acpi_device *parent;
 271         struct list_head children;
 272         struct list_head node;
 273         struct list_head wakeup_list;
 274         struct acpi_device_status status;
 275         struct acpi_device_flags flags;
 276         struct acpi_device_pnp pnp;
 277         struct acpi_device_power power;
 278         struct acpi_device_wakeup wakeup;
 279         struct acpi_device_perf performance;
 280         struct acpi_device_dir dir;
 281         struct acpi_device_ops ops;
 282         struct acpi_driver *driver;
 283         void *driver_data;
 284         struct device dev;
 285         struct acpi_bus_ops bus_ops;    /* workaround for different code path for hotplug */
 286         enum acpi_bus_removal_type removal_type;        /* indicate for different removal type */
 287         u8 physical_node_count;
 288         struct list_head physical_node_list;
 289         struct mutex physical_node_lock;
 290         DECLARE_BITMAP(physical_node_id_bitmap, ACPI_MAX_PHYSICAL_NODE);
 291 };
 292
 293 static inline void *acpi_driver_data(struct acpi_device *d)
 294 {
 295         return d->driver_data;
 296 }
 297
 298 #define to_acpi_device(d)       container_of(d, struct acpi_device, dev)
 299 #define to_acpi_driver(d)       container_of(d, struct acpi_driver, drv)
 300
 301 /* acpi_device.dev.bus == &acpi_bus_type */
 302 extern struct bus_type acpi_bus_type;
 303
 304 /*
 305  * Events
 306  * ------
 307  */
 308
 309 struct acpi_bus_event {
 310         struct list_head node;
 311         acpi_device_class device_class;
 312         acpi_bus_id bus_id;
 313         u32 type;
 314         u32 data;
 315 };
 316
 317 struct acpi_eject_event {
 318         acpi_handle     handle;
 319         u32             event;
 320 };
 321
 322 extern struct kobject *acpi_kobj;
 323 extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int);
 324 void acpi_bus_private_data_handler(acpi_handle, void *);
 325 int acpi_bus_get_private_data(acpi_handle, void **);
 326 extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32);
 327 extern int register_acpi_notifier(struct notifier_block *);
 328 extern int unregister_acpi_notifier(struct notifier_block *);
 329
 330 extern int register_acpi_bus_notifier(struct notifier_block *nb);
 331 extern void unregister_acpi_bus_notifier(struct notifier_block *nb);
 332 /*
 333  * External Functions
 334  */
 335
 336 int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device);
 337 void acpi_bus_data_handler(acpi_handle handle, void *context);
 338 acpi_status acpi_bus_get_status_handle(acpi_handle handle,
 339                                        unsigned long long *sta);
 340 int acpi_bus_get_status(struct acpi_device *device);
 341 int acpi_bus_set_power(acpi_handle handle, int state);
 342 int acpi_device_set_power(struct acpi_device *device, int state);
 343 int acpi_bus_update_power(acpi_handle handle, int *state_p);
 344 bool acpi_bus_power_manageable(acpi_handle handle);
 345 bool acpi_bus_can_wakeup(acpi_handle handle);
 346 int acpi_power_resource_register_device(struct device *dev, acpi_handle handle);
 347 void acpi_power_resource_unregister_device(struct device *dev, acpi_handle handle);
 348 #ifdef CONFIG_ACPI_PROC_EVENT
 349 int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data);
 350 int acpi_bus_generate_proc_event4(const char *class, const char *bid, u8 type, int data);
 351 int acpi_bus_receive_event(struct acpi_bus_event *event);
 352 #else
 353 static inline int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data)
 354         { return 0; }
 355 #endif
 356 int acpi_bus_register_driver(struct acpi_driver *driver);
 357 void acpi_bus_unregister_driver(struct acpi_driver *driver);
 358 int acpi_bus_add(struct acpi_device **child, struct acpi_device *parent,
 359                  acpi_handle handle, int type);
 360 void acpi_bus_hot_remove_device(void *context);
 361 int acpi_bus_trim(struct acpi_device *start, int rmdevice);
 362 int acpi_bus_start(struct acpi_device *device);
 363 acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
 364 int acpi_match_device_ids(struct acpi_device *device,
 365                           const struct acpi_device_id *ids);
 366 int acpi_create_dir(struct acpi_device *);
 367 void acpi_remove_dir(struct acpi_device *);
 368
 369
 370 /**
 371  * module_acpi_driver(acpi_driver) - Helper macro for registering an ACPI driver
 372  * @__acpi_driver: acpi_driver struct
 373  *
 374  * Helper macro for ACPI drivers which do not do anything special in module
 375  * init/exit. This eliminates a lot of boilerplate. Each module may only
 376  * use this macro once, and calling it replaces module_init() and module_exit()
 377  */
 378 #define module_acpi_driver(__acpi_driver) \
 379         module_driver(__acpi_driver, acpi_bus_register_driver, \
 380                       acpi_bus_unregister_driver)
 381
 382 /*
 383  * Bind physical devices with ACPI devices
 384  */
 385 struct acpi_bus_type {
 386         struct list_head list;
 387         struct bus_type *bus;
 388         /* For general devices under the bus */
 389         int (*find_device) (struct device *, acpi_handle *);
 390         /* For bridges, such as PCI root bridge, IDE controller */
 391         int (*find_bridge) (struct device *, acpi_handle *);
 392 };
 393 int register_acpi_bus_type(struct acpi_bus_type *);
 394 int unregister_acpi_bus_type(struct acpi_bus_type *);
 395
 396 struct acpi_pci_root {
 397         struct list_head node;
 398         struct acpi_device * device;
 399         struct acpi_pci_id id;
 400         struct pci_bus *bus;
 401         u16 segment;
 402         struct resource secondary;      /* downstream bus range */
 403
 404         u32 osc_support_set;    /* _OSC state of support bits */
 405         u32 osc_control_set;    /* _OSC state of control bits */
 406         phys_addr_t mcfg_addr;
 407 };
 408
 409 /* helper */
 410 acpi_handle acpi_get_child(acpi_handle, u64);
 411 int acpi_is_root_bridge(acpi_handle);
 412 acpi_handle acpi_get_pci_rootbridge_handle(unsigned int, unsigned int);
 413 struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle);
 414 #define DEVICE_ACPI_HANDLE(dev) ((acpi_handle)((dev)->archdata.acpi_handle))
 415
 416 int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state);
 417 int acpi_disable_wakeup_device_power(struct acpi_device *dev);
 418
 419 #ifdef CONFIG_PM
 420 acpi_status acpi_add_pm_notifier(struct acpi_device *adev,
 421                                  acpi_notify_handler handler, void *context);
 422 acpi_status acpi_remove_pm_notifier(struct acpi_device *adev,
 423                                     acpi_notify_handler handler);
 424 int acpi_device_power_state(struct device *dev, struct acpi_device *adev,
 425                             u32 target_state, int d_max_in, int *d_min_p);
 426 int acpi_pm_device_sleep_state(struct device *, int *, int);
 427 #else
 428 static inline acpi_status acpi_add_pm_notifier(struct acpi_device *adev,
 429                                                acpi_notify_handler handler,
 430                                                void *context)
 431 {
 432         return AE_SUPPORT;
 433 }
 434 static inline acpi_status acpi_remove_pm_notifier(struct acpi_device *adev,
 435                                                   acpi_notify_handler handler)
 436 {
 437         return AE_SUPPORT;
 438 }
 439 static inline int __acpi_device_power_state(int m, int *p)
 440 {
 441         if (p)
 442                 *p = ACPI_STATE_D0;
 443         return (m >= ACPI_STATE_D0 && m <= ACPI_STATE_D3) ? m : ACPI_STATE_D0;
 444 }
 445 static inline int acpi_device_power_state(struct device *dev,
 446                                           struct acpi_device *adev,
 447                                           u32 target_state, int d_max_in,
 448                                           int *d_min_p)
 449 {
 450         return __acpi_device_power_state(d_max_in, d_min_p);
 451 }
 452 static inline int acpi_pm_device_sleep_state(struct device *d, int *p, int m)
 453 {
 454         return __acpi_device_power_state(m, p);
 455 }
 456 #endif
 457
 458 #ifdef CONFIG_PM_RUNTIME
 459 int __acpi_device_run_wake(struct acpi_device *, bool);
 460 int acpi_pm_device_run_wake(struct device *, bool);
 461 #else
 462 static inline int __acpi_device_run_wake(struct acpi_device *adev, bool en)
 463 {
 464         return -ENODEV;
 465 }
 466 static inline int acpi_pm_device_run_wake(struct device *dev, bool enable)
 467 {
 468         return -ENODEV;
 469 }
 470 #endif
 471
 472 #ifdef CONFIG_PM_SLEEP
 473 u32 acpi_target_system_state(void);
 474 int __acpi_device_sleep_wake(struct acpi_device *, u32, bool);
 475 int acpi_pm_device_sleep_wake(struct device *, bool);
 476 #else
 477 static inline u32 acpi_target_system_state(void) { return ACPI_STATE_S0; }
 478 static inline int __acpi_device_sleep_wake(struct acpi_device *adev,
 479                                            u32 target_state, bool enable)
 480 {
 481         return -ENODEV;
 482 }
 483 static inline int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
 484 {
 485         return -ENODEV;
 486 }
 487 #endif
 488
 489 static inline bool acpi_device_power_manageable(struct acpi_device *adev)
 490 {
 491         return adev->flags.power_manageable;
 492 }
 493
 494 static inline bool acpi_device_can_wakeup(struct acpi_device *adev)
 495 {
 496         return adev->wakeup.flags.valid;
 497 }
 498
 499 #else   /* CONFIG_ACPI */
 500
 501 static inline int register_acpi_bus_type(void *bus) { return 0; }
 502 static inline int unregister_acpi_bus_type(void *bus) { return 0; }
 503
 504 #endif                          /* CONFIG_ACPI */
 505
 506 #endif /*__ACPI_BUS_H__*/