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 Scan Handler
  88  * -----------------
  89  */
  90
  91 enum acpi_hotplug_mode {
  92         AHM_GENERIC = 0,
  93         AHM_CONTAINER,
  94         AHM_COUNT
  95 };
  96
  97 struct acpi_hotplug_profile {
  98         struct kobject kobj;
  99         bool enabled:1;
 100         bool ignore:1;
 101         enum acpi_hotplug_mode mode;
 102 };
 103
 104 static inline struct acpi_hotplug_profile *to_acpi_hotplug_profile(
 105                                                 struct kobject *kobj)
 106 {
 107         return container_of(kobj, struct acpi_hotplug_profile, kobj);
 108 }
 109
 110 struct acpi_scan_handler {
 111         const struct acpi_device_id *ids;
 112         struct list_head list_node;
 113         int (*attach)(struct acpi_device *dev, const struct acpi_device_id *id);
 114         void (*detach)(struct acpi_device *dev);
 115         struct acpi_hotplug_profile hotplug;
 116 };
 117
 118 /*
 119  * ACPI Driver
 120  * -----------
 121  */
 122
 123 typedef int (*acpi_op_add) (struct acpi_device * device);
 124 typedef int (*acpi_op_remove) (struct acpi_device * device);
 125 typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event);
 126
 127 struct acpi_device_ops {
 128         acpi_op_add add;
 129         acpi_op_remove remove;
 130         acpi_op_notify notify;
 131 };
 132
 133 #define ACPI_DRIVER_ALL_NOTIFY_EVENTS   0x1     /* system AND device events */
 134
 135 struct acpi_driver {
 136         char name[80];
 137         char class[80];
 138         const struct acpi_device_id *ids; /* Supported Hardware IDs */
 139         unsigned int flags;
 140         struct acpi_device_ops ops;
 141         struct device_driver drv;
 142         struct module *owner;
 143 };
 144
 145 /*
 146  * ACPI Device
 147  * -----------
 148  */
 149
 150 /* Status (_STA) */
 151
 152 struct acpi_device_status {
 153         u32 present:1;
 154         u32 enabled:1;
 155         u32 show_in_ui:1;
 156         u32 functional:1;
 157         u32 battery_present:1;
 158         u32 reserved:27;
 159 };
 160
 161 /* Flags */
 162
 163 struct acpi_device_flags {
 164         u32 dynamic_status:1;
 165         u32 removable:1;
 166         u32 ejectable:1;
 167         u32 suprise_removal_ok:1;
 168         u32 power_manageable:1;
 169         u32 performance_manageable:1;
 170         u32 eject_pending:1;
 171         u32 match_driver:1;
 172         u32 reserved:24;
 173 };
 174
 175 /* File System */
 176
 177 struct acpi_device_dir {
 178         struct proc_dir_entry *entry;
 179 };
 180
 181 #define acpi_device_dir(d)      ((d)->dir.entry)
 182
 183 /* Plug and Play */
 184
 185 typedef char acpi_bus_id[8];
 186 typedef unsigned long acpi_bus_address;
 187 typedef char acpi_device_name[40];
 188 typedef char acpi_device_class[20];
 189
 190 struct acpi_hardware_id {
 191         struct list_head list;
 192         char *id;
 193 };
 194
 195 struct acpi_pnp_type {
 196         u32 hardware_id:1;
 197         u32 bus_address:1;
 198         u32 reserved:30;
 199 };
 200
 201 struct acpi_device_pnp {
 202         acpi_bus_id bus_id;             /* Object name */
 203         struct acpi_pnp_type type;      /* ID type */
 204         acpi_bus_address bus_address;   /* _ADR */
 205         char *unique_id;                /* _UID */
 206         struct list_head ids;           /* _HID and _CIDs */
 207         acpi_device_name device_name;   /* Driver-determined */
 208         acpi_device_class device_class; /*        "          */
 209         union acpi_object *str_obj;     /* unicode string for _STR method */
 210         unsigned long sun;              /* _SUN */
 211 };
 212
 213 #define acpi_device_bid(d)      ((d)->pnp.bus_id)
 214 #define acpi_device_adr(d)      ((d)->pnp.bus_address)
 215 const char *acpi_device_hid(struct acpi_device *device);
 216 #define acpi_device_name(d)     ((d)->pnp.device_name)
 217 #define acpi_device_class(d)    ((d)->pnp.device_class)
 218
 219 /* Power Management */
 220
 221 struct acpi_device_power_flags {
 222         u32 explicit_get:1;     /* _PSC present? */
 223         u32 power_resources:1;  /* Power resources */
 224         u32 inrush_current:1;   /* Serialize Dx->D0 */
 225         u32 power_removed:1;    /* Optimize Dx->D0 */
 226         u32 reserved:28;
 227 };
 228
 229 struct acpi_device_power_state {
 230         struct {
 231                 u8 valid:1;
 232                 u8 os_accessible:1;
 233                 u8 explicit_set:1;      /* _PSx present? */
 234                 u8 reserved:6;
 235         } flags;
 236         int power;              /* % Power (compared to D0) */
 237         int latency;            /* Dx->D0 time (microseconds) */
 238         struct list_head resources;     /* Power resources referenced */
 239 };
 240
 241 struct acpi_device_power {
 242         int state;              /* Current state */
 243         struct acpi_device_power_flags flags;
 244         struct acpi_device_power_state states[ACPI_D_STATE_COUNT];      /* Power states (D0-D3Cold) */
 245 };
 246
 247 /* Performance Management */
 248
 249 struct acpi_device_perf_flags {
 250         u8 reserved:8;
 251 };
 252
 253 struct acpi_device_perf_state {
 254         struct {
 255                 u8 valid:1;
 256                 u8 reserved:7;
 257         } flags;
 258         u8 power;               /* % Power (compared to P0) */
 259         u8 performance;         /* % Performance (    "   ) */
 260         int latency;            /* Px->P0 time (microseconds) */
 261 };
 262
 263 struct acpi_device_perf {
 264         int state;
 265         struct acpi_device_perf_flags flags;
 266         int state_count;
 267         struct acpi_device_perf_state *states;
 268 };
 269
 270 /* Wakeup Management */
 271 struct acpi_device_wakeup_flags {
 272         u8 valid:1;             /* Can successfully enable wakeup? */
 273         u8 run_wake:1;          /* Run-Wake GPE devices */
 274         u8 notifier_present:1;  /* Wake-up notify handler has been installed */
 275 };
 276
 277 struct acpi_device_wakeup {
 278         acpi_handle gpe_device;
 279         u64 gpe_number;
 280         u64 sleep_state;
 281         struct list_head resources;
 282         struct acpi_device_wakeup_flags flags;
 283         int prepare_count;
 284 };
 285
 286 struct acpi_device_physical_node {
 287         u8 node_id;
 288         struct list_head node;
 289         struct device *dev;
 290 };
 291
 292 /* set maximum of physical nodes to 32 for expansibility */
 293 #define ACPI_MAX_PHYSICAL_NODE  32
 294
 295 /* Device */
 296 struct acpi_device {
 297         int device_type;
 298         acpi_handle handle;             /* no handle for fixed hardware */
 299         struct acpi_device *parent;
 300         struct list_head children;
 301         struct list_head node;
 302         struct list_head wakeup_list;
 303         struct acpi_device_status status;
 304         struct acpi_device_flags flags;
 305         struct acpi_device_pnp pnp;
 306         struct acpi_device_power power;
 307         struct acpi_device_wakeup wakeup;
 308         struct acpi_device_perf performance;
 309         struct acpi_device_dir dir;
 310         struct acpi_scan_handler *handler;
 311         struct acpi_driver *driver;
 312         void *driver_data;
 313         struct device dev;
 314         enum acpi_bus_removal_type removal_type;        /* indicate for different removal type */
 315         u8 physical_node_count;
 316         struct list_head physical_node_list;
 317         struct mutex physical_node_lock;
 318         DECLARE_BITMAP(physical_node_id_bitmap, ACPI_MAX_PHYSICAL_NODE);
 319         struct list_head power_dependent;
 320         void (*remove)(struct acpi_device *);
 321 };
 322
 323 static inline void *acpi_driver_data(struct acpi_device *d)
 324 {
 325         return d->driver_data;
 326 }
 327
 328 #define to_acpi_device(d)       container_of(d, struct acpi_device, dev)
 329 #define to_acpi_driver(d)       container_of(d, struct acpi_driver, drv)
 330
 331 /* acpi_device.dev.bus == &acpi_bus_type */
 332 extern struct bus_type acpi_bus_type;
 333
 334 /*
 335  * Events
 336  * ------
 337  */
 338
 339 struct acpi_bus_event {
 340         struct list_head node;
 341         acpi_device_class device_class;
 342         acpi_bus_id bus_id;
 343         u32 type;
 344         u32 data;
 345 };
 346
 347 struct acpi_eject_event {
 348         struct acpi_device      *device;
 349         u32             event;
 350 };
 351
 352 struct acpi_hp_work {
 353         struct work_struct work;
 354         acpi_handle handle;
 355         u32 type;
 356         void *context;
 357 };
 358 void alloc_acpi_hp_work(acpi_handle handle, u32 type, void *context,
 359                         void (*func)(struct work_struct *work));
 360
 361 extern struct kobject *acpi_kobj;
 362 extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int);
 363 void acpi_bus_private_data_handler(acpi_handle, void *);
 364 int acpi_bus_get_private_data(acpi_handle, void **);
 365 extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32);
 366 extern int register_acpi_notifier(struct notifier_block *);
 367 extern int unregister_acpi_notifier(struct notifier_block *);
 368
 369 extern int register_acpi_bus_notifier(struct notifier_block *nb);
 370 extern void unregister_acpi_bus_notifier(struct notifier_block *nb);
 371 /*
 372  * External Functions
 373  */
 374
 375 int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device);
 376 void acpi_bus_data_handler(acpi_handle handle, void *context);
 377 acpi_status acpi_bus_get_status_handle(acpi_handle handle,
 378                                        unsigned long long *sta);
 379 int acpi_bus_get_status(struct acpi_device *device);
 380
 381 int acpi_bus_set_power(acpi_handle handle, int state);
 382 const char *acpi_power_state_string(int state);
 383 int acpi_device_get_power(struct acpi_device *device, int *state);
 384 int acpi_device_set_power(struct acpi_device *device, int state);
 385 int acpi_bus_init_power(struct acpi_device *device);
 386 int acpi_device_fix_up_power(struct acpi_device *device);
 387 int acpi_bus_update_power(acpi_handle handle, int *state_p);
 388 bool acpi_bus_power_manageable(acpi_handle handle);
 389
 390 #ifdef CONFIG_PM
 391 bool acpi_bus_can_wakeup(acpi_handle handle);
 392 #else
 393 static inline bool acpi_bus_can_wakeup(acpi_handle handle) { return false; }
 394 #endif
 395
 396 #ifdef CONFIG_ACPI_PROC_EVENT
 397 int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data);
 398 int acpi_bus_generate_proc_event4(const char *class, const char *bid, u8 type, int data);
 399 int acpi_bus_receive_event(struct acpi_bus_event *event);
 400 #else
 401 static inline int acpi_bus_generate_proc_event(struct acpi_device *device, u8 type, int data)
 402         { return 0; }
 403 #endif
 404
 405 void acpi_scan_lock_acquire(void);
 406 void acpi_scan_lock_release(void);
 407 int acpi_scan_add_handler(struct acpi_scan_handler *handler);
 408 int acpi_bus_register_driver(struct acpi_driver *driver);
 409 void acpi_bus_unregister_driver(struct acpi_driver *driver);
 410 int acpi_bus_scan(acpi_handle handle);
 411 void acpi_bus_hot_remove_device(void *context);
 412 void acpi_bus_trim(struct acpi_device *start);
 413 acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
 414 int acpi_match_device_ids(struct acpi_device *device,
 415                           const struct acpi_device_id *ids);
 416 int acpi_create_dir(struct acpi_device *);
 417 void acpi_remove_dir(struct acpi_device *);
 418
 419
 420 /**
 421  * module_acpi_driver(acpi_driver) - Helper macro for registering an ACPI driver
 422  * @__acpi_driver: acpi_driver struct
 423  *
 424  * Helper macro for ACPI drivers which do not do anything special in module
 425  * init/exit. This eliminates a lot of boilerplate. Each module may only
 426  * use this macro once, and calling it replaces module_init() and module_exit()
 427  */
 428 #define module_acpi_driver(__acpi_driver) \
 429         module_driver(__acpi_driver, acpi_bus_register_driver, \
 430                       acpi_bus_unregister_driver)
 431
 432 /*
 433  * Bind physical devices with ACPI devices
 434  */
 435 struct acpi_bus_type {
 436         struct list_head list;
 437         const char *name;
 438         bool (*match)(struct device *dev);
 439         int (*find_device) (struct device *, acpi_handle *);
 440         void (*setup)(struct device *);
 441         void (*cleanup)(struct device *);
 442 };
 443 int register_acpi_bus_type(struct acpi_bus_type *);
 444 int unregister_acpi_bus_type(struct acpi_bus_type *);
 445
 446 struct acpi_pci_root {
 447         struct list_head node;
 448         struct acpi_device * device;
 449         struct pci_bus *bus;
 450         u16 segment;
 451         struct resource secondary;      /* downstream bus range */
 452
 453         u32 osc_support_set;    /* _OSC state of support bits */
 454         u32 osc_control_set;    /* _OSC state of control bits */
 455         phys_addr_t mcfg_addr;
 456 };
 457
 458 /* helper */
 459 acpi_handle acpi_find_child(acpi_handle, u64, bool);
 460 static inline acpi_handle acpi_get_child(acpi_handle handle, u64 addr)
 461 {
 462         return acpi_find_child(handle, addr, false);
 463 }
 464 int acpi_is_root_bridge(acpi_handle);
 465 struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle);
 466 #define DEVICE_ACPI_HANDLE(dev) ((acpi_handle)ACPI_HANDLE(dev))
 467
 468 int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state);
 469 int acpi_disable_wakeup_device_power(struct acpi_device *dev);
 470
 471 #ifdef CONFIG_PM
 472 acpi_status acpi_add_pm_notifier(struct acpi_device *adev,
 473                                  acpi_notify_handler handler, void *context);
 474 acpi_status acpi_remove_pm_notifier(struct acpi_device *adev,
 475                                     acpi_notify_handler handler);
 476 int acpi_device_power_state(struct device *dev, struct acpi_device *adev,
 477                             u32 target_state, int d_max_in, int *d_min_p);
 478 int acpi_pm_device_sleep_state(struct device *, int *, int);
 479 void acpi_dev_pm_add_dependent(acpi_handle handle, struct device *depdev);
 480 void acpi_dev_pm_remove_dependent(acpi_handle handle, struct device *depdev);
 481 #else
 482 static inline acpi_status acpi_add_pm_notifier(struct acpi_device *adev,
 483                                                acpi_notify_handler handler,
 484                                                void *context)
 485 {
 486         return AE_SUPPORT;
 487 }
 488 static inline acpi_status acpi_remove_pm_notifier(struct acpi_device *adev,
 489                                                   acpi_notify_handler handler)
 490 {
 491         return AE_SUPPORT;
 492 }
 493 static inline int __acpi_device_power_state(int m, int *p)
 494 {
 495         if (p)
 496                 *p = ACPI_STATE_D0;
 497         return (m >= ACPI_STATE_D0 && m <= ACPI_STATE_D3) ? m : ACPI_STATE_D0;
 498 }
 499 static inline int acpi_device_power_state(struct device *dev,
 500                                           struct acpi_device *adev,
 501                                           u32 target_state, int d_max_in,
 502                                           int *d_min_p)
 503 {
 504         return __acpi_device_power_state(d_max_in, d_min_p);
 505 }
 506 static inline int acpi_pm_device_sleep_state(struct device *d, int *p, int m)
 507 {
 508         return __acpi_device_power_state(m, p);
 509 }
 510 static inline void acpi_dev_pm_add_dependent(acpi_handle handle,
 511                                              struct device *depdev) {}
 512 static inline void acpi_dev_pm_remove_dependent(acpi_handle handle,
 513                                                 struct device *depdev) {}
 514 #endif
 515
 516 #ifdef CONFIG_PM_RUNTIME
 517 int __acpi_device_run_wake(struct acpi_device *, bool);
 518 int acpi_pm_device_run_wake(struct device *, bool);
 519 #else
 520 static inline int __acpi_device_run_wake(struct acpi_device *adev, bool en)
 521 {
 522         return -ENODEV;
 523 }
 524 static inline int acpi_pm_device_run_wake(struct device *dev, bool enable)
 525 {
 526         return -ENODEV;
 527 }
 528 #endif
 529
 530 #ifdef CONFIG_PM_SLEEP
 531 int __acpi_device_sleep_wake(struct acpi_device *, u32, bool);
 532 int acpi_pm_device_sleep_wake(struct device *, bool);
 533 #else
 534 static inline int __acpi_device_sleep_wake(struct acpi_device *adev,
 535                                            u32 target_state, bool enable)
 536 {
 537         return -ENODEV;
 538 }
 539 static inline int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
 540 {
 541         return -ENODEV;
 542 }
 543 #endif
 544
 545 #ifdef CONFIG_ACPI_SLEEP
 546 u32 acpi_target_system_state(void);
 547 #else
 548 static inline u32 acpi_target_system_state(void) { return ACPI_STATE_S0; }
 549 #endif
 550
 551 static inline bool acpi_device_power_manageable(struct acpi_device *adev)
 552 {
 553         return adev->flags.power_manageable;
 554 }
 555
 556 static inline bool acpi_device_can_wakeup(struct acpi_device *adev)
 557 {
 558         return adev->wakeup.flags.valid;
 559 }
 560
 561 static inline bool acpi_device_can_poweroff(struct acpi_device *adev)
 562 {
 563         return adev->power.states[ACPI_STATE_D3_COLD].flags.os_accessible;
 564 }
 565
 566 #else   /* CONFIG_ACPI */
 567
 568 static inline int register_acpi_bus_type(void *bus) { return 0; }
 569 static inline int unregister_acpi_bus_type(void *bus) { return 0; }
 570
 571 #endif                          /* CONFIG_ACPI */
 572
 573 #endif /*__ACPI_BUS_H__*/