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 /* TBD: Make dynamic */
  32 #define ACPI_MAX_HANDLES        10
  33 struct acpi_handle_list {
  34         u32 count;
  35         acpi_handle handles[ACPI_MAX_HANDLES];
  36 };
  37
  38 /* acpi_utils.h */
  39 acpi_status
  40 acpi_extract_package(union acpi_object *package,
  41                      struct acpi_buffer *format, struct acpi_buffer *buffer);
  42 acpi_status
  43 acpi_evaluate_integer(acpi_handle handle,
  44                       acpi_string pathname,
  45                       struct acpi_object_list *arguments, unsigned long long *data);
  46 acpi_status
  47 acpi_evaluate_reference(acpi_handle handle,
  48                         acpi_string pathname,
  49                         struct acpi_object_list *arguments,
  50                         struct acpi_handle_list *list);
  51 acpi_status
  52 acpi_evaluate_ost(acpi_handle handle, u32 source_event, u32 status_code,
  53                   struct acpi_buffer *status_buf);
  54
  55 acpi_status
  56 acpi_get_physical_device_location(acpi_handle handle, struct acpi_pld_info **pld);
  57
  58 bool acpi_has_method(acpi_handle handle, char *name);
  59 acpi_status acpi_execute_simple_method(acpi_handle handle, char *method,
  60                                        u64 arg);
  61 acpi_status acpi_evaluate_ej0(acpi_handle handle);
  62 acpi_status acpi_evaluate_lck(acpi_handle handle, int lock);
  63 bool acpi_ata_match(acpi_handle handle);
  64 bool acpi_bay_match(acpi_handle handle);
  65 bool acpi_dock_match(acpi_handle handle);
  66
  67 bool acpi_check_dsm(acpi_handle handle, const u8 *uuid, int rev, u64 funcs);
  68 union acpi_object *acpi_evaluate_dsm(acpi_handle handle, const u8 *uuid,
  69                         int rev, int func, union acpi_object *argv4);
  70
  71 static inline union acpi_object *
  72 acpi_evaluate_dsm_typed(acpi_handle handle, const u8 *uuid, int rev, int func,
  73                         union acpi_object *argv4, acpi_object_type type)
  74 {
  75         union acpi_object *obj;
  76
  77         obj = acpi_evaluate_dsm(handle, uuid, rev, func, argv4);
  78         if (obj && obj->type != type) {
  79                 ACPI_FREE(obj);
  80                 obj = NULL;
  81         }
  82
  83         return obj;
  84 }
  85
  86 #define ACPI_INIT_DSM_ARGV4(cnt, eles)                  \
  87         {                                               \
  88           .package.type = ACPI_TYPE_PACKAGE,            \
  89           .package.count = (cnt),                       \
  90           .package.elements = (eles)                    \
  91         }
  92
  93 #ifdef CONFIG_ACPI
  94
  95 #include <linux/proc_fs.h>
  96
  97 #define ACPI_BUS_FILE_ROOT      "acpi"
  98 extern struct proc_dir_entry *acpi_root_dir;
  99
 100 enum acpi_bus_device_type {
 101         ACPI_BUS_TYPE_DEVICE = 0,
 102         ACPI_BUS_TYPE_POWER,
 103         ACPI_BUS_TYPE_PROCESSOR,
 104         ACPI_BUS_TYPE_THERMAL,
 105         ACPI_BUS_TYPE_POWER_BUTTON,
 106         ACPI_BUS_TYPE_SLEEP_BUTTON,
 107         ACPI_BUS_DEVICE_TYPE_COUNT
 108 };
 109
 110 struct acpi_driver;
 111 struct acpi_device;
 112
 113 /*
 114  * ACPI Scan Handler
 115  * -----------------
 116  */
 117
 118 struct acpi_hotplug_profile {
 119         struct kobject kobj;
 120         int (*scan_dependent)(struct acpi_device *adev);
 121         bool enabled:1;
 122         bool demand_offline:1;
 123 };
 124
 125 static inline struct acpi_hotplug_profile *to_acpi_hotplug_profile(
 126                                                 struct kobject *kobj)
 127 {
 128         return container_of(kobj, struct acpi_hotplug_profile, kobj);
 129 }
 130
 131 struct acpi_scan_handler {
 132         const struct acpi_device_id *ids;
 133         struct list_head list_node;
 134         int (*attach)(struct acpi_device *dev, const struct acpi_device_id *id);
 135         void (*detach)(struct acpi_device *dev);
 136         void (*bind)(struct device *phys_dev);
 137         void (*unbind)(struct device *phys_dev);
 138         struct acpi_hotplug_profile hotplug;
 139 };
 140
 141 /*
 142  * ACPI Hotplug Context
 143  * --------------------
 144  */
 145
 146 struct acpi_hotplug_context {
 147         struct acpi_device *self;
 148         int (*notify)(struct acpi_device *, u32);
 149         void (*uevent)(struct acpi_device *, u32);
 150         void (*fixup)(struct acpi_device *);
 151 };
 152
 153 /*
 154  * ACPI Driver
 155  * -----------
 156  */
 157
 158 typedef int (*acpi_op_add) (struct acpi_device * device);
 159 typedef int (*acpi_op_remove) (struct acpi_device * device);
 160 typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event);
 161
 162 struct acpi_device_ops {
 163         acpi_op_add add;
 164         acpi_op_remove remove;
 165         acpi_op_notify notify;
 166 };
 167
 168 #define ACPI_DRIVER_ALL_NOTIFY_EVENTS   0x1     /* system AND device events */
 169
 170 struct acpi_driver {
 171         char name[80];
 172         char class[80];
 173         const struct acpi_device_id *ids; /* Supported Hardware IDs */
 174         unsigned int flags;
 175         struct acpi_device_ops ops;
 176         struct device_driver drv;
 177         struct module *owner;
 178 };
 179
 180 /*
 181  * ACPI Device
 182  * -----------
 183  */
 184
 185 /* Status (_STA) */
 186
 187 struct acpi_device_status {
 188         u32 present:1;
 189         u32 enabled:1;
 190         u32 show_in_ui:1;
 191         u32 functional:1;
 192         u32 battery_present:1;
 193         u32 reserved:27;
 194 };
 195
 196 /* Flags */
 197
 198 struct acpi_device_flags {
 199         u32 dynamic_status:1;
 200         u32 removable:1;
 201         u32 ejectable:1;
 202         u32 power_manageable:1;
 203         u32 match_driver:1;
 204         u32 initialized:1;
 205         u32 visited:1;
 206         u32 no_hotplug:1;
 207         u32 hotplug_notify:1;
 208         u32 is_dock_station:1;
 209         u32 reserved:22;
 210 };
 211
 212 /* File System */
 213
 214 struct acpi_device_dir {
 215         struct proc_dir_entry *entry;
 216 };
 217
 218 #define acpi_device_dir(d)      ((d)->dir.entry)
 219
 220 /* Plug and Play */
 221
 222 typedef char acpi_bus_id[8];
 223 typedef unsigned long acpi_bus_address;
 224 typedef char acpi_device_name[40];
 225 typedef char acpi_device_class[20];
 226
 227 struct acpi_hardware_id {
 228         struct list_head list;
 229         char *id;
 230 };
 231
 232 struct acpi_pnp_type {
 233         u32 hardware_id:1;
 234         u32 bus_address:1;
 235         u32 reserved:30;
 236 };
 237
 238 struct acpi_device_pnp {
 239         acpi_bus_id bus_id;             /* Object name */
 240         struct acpi_pnp_type type;      /* ID type */
 241         acpi_bus_address bus_address;   /* _ADR */
 242         char *unique_id;                /* _UID */
 243         struct list_head ids;           /* _HID and _CIDs */
 244         acpi_device_name device_name;   /* Driver-determined */
 245         acpi_device_class device_class; /*        "          */
 246         union acpi_object *str_obj;     /* unicode string for _STR method */
 247         unsigned long sun;              /* _SUN */
 248 };
 249
 250 #define acpi_device_bid(d)      ((d)->pnp.bus_id)
 251 #define acpi_device_adr(d)      ((d)->pnp.bus_address)
 252 const char *acpi_device_hid(struct acpi_device *device);
 253 #define acpi_device_name(d)     ((d)->pnp.device_name)
 254 #define acpi_device_class(d)    ((d)->pnp.device_class)
 255
 256 /* Power Management */
 257
 258 struct acpi_device_power_flags {
 259         u32 explicit_get:1;     /* _PSC present? */
 260         u32 power_resources:1;  /* Power resources */
 261         u32 inrush_current:1;   /* Serialize Dx->D0 */
 262         u32 power_removed:1;    /* Optimize Dx->D0 */
 263         u32 ignore_parent:1;    /* Power is independent of parent power state */
 264         u32 reserved:27;
 265 };
 266
 267 struct acpi_device_power_state {
 268         struct {
 269                 u8 valid:1;
 270                 u8 os_accessible:1;
 271                 u8 explicit_set:1;      /* _PSx present? */
 272                 u8 reserved:6;
 273         } flags;
 274         int power;              /* % Power (compared to D0) */
 275         int latency;            /* Dx->D0 time (microseconds) */
 276         struct list_head resources;     /* Power resources referenced */
 277 };
 278
 279 struct acpi_device_power {
 280         int state;              /* Current state */
 281         struct acpi_device_power_flags flags;
 282         struct acpi_device_power_state states[ACPI_D_STATE_COUNT];      /* Power states (D0-D3Cold) */
 283 };
 284
 285 /* Performance Management */
 286
 287 struct acpi_device_perf_flags {
 288         u8 reserved:8;
 289 };
 290
 291 struct acpi_device_perf_state {
 292         struct {
 293                 u8 valid:1;
 294                 u8 reserved:7;
 295         } flags;
 296         u8 power;               /* % Power (compared to P0) */
 297         u8 performance;         /* % Performance (    "   ) */
 298         int latency;            /* Px->P0 time (microseconds) */
 299 };
 300
 301 struct acpi_device_perf {
 302         int state;
 303         struct acpi_device_perf_flags flags;
 304         int state_count;
 305         struct acpi_device_perf_state *states;
 306 };
 307
 308 /* Wakeup Management */
 309 struct acpi_device_wakeup_flags {
 310         u8 valid:1;             /* Can successfully enable wakeup? */
 311         u8 run_wake:1;          /* Run-Wake GPE devices */
 312         u8 notifier_present:1;  /* Wake-up notify handler has been installed */
 313 };
 314
 315 struct acpi_device_wakeup {
 316         acpi_handle gpe_device;
 317         u64 gpe_number;
 318         u64 sleep_state;
 319         struct list_head resources;
 320         struct acpi_device_wakeup_flags flags;
 321         int prepare_count;
 322 };
 323
 324 struct acpi_device_physical_node {
 325         unsigned int node_id;
 326         struct list_head node;
 327         struct device *dev;
 328         bool put_online:1;
 329 };
 330
 331 /* Device */
 332 struct acpi_device {
 333         int device_type;
 334         acpi_handle handle;             /* no handle for fixed hardware */
 335         struct acpi_device *parent;
 336         struct list_head children;
 337         struct list_head node;
 338         struct list_head wakeup_list;
 339         struct list_head del_list;
 340         struct acpi_device_status status;
 341         struct acpi_device_flags flags;
 342         struct acpi_device_pnp pnp;
 343         struct acpi_device_power power;
 344         struct acpi_device_wakeup wakeup;
 345         struct acpi_device_perf performance;
 346         struct acpi_device_dir dir;
 347         struct acpi_scan_handler *handler;
 348         struct acpi_hotplug_context *hp;
 349         struct acpi_driver *driver;
 350         void *driver_data;
 351         struct device dev;
 352         unsigned int physical_node_count;
 353         struct list_head physical_node_list;
 354         struct mutex physical_node_lock;
 355         void (*remove)(struct acpi_device *);
 356 };
 357
 358 static inline void *acpi_driver_data(struct acpi_device *d)
 359 {
 360         return d->driver_data;
 361 }
 362
 363 #define to_acpi_device(d)       container_of(d, struct acpi_device, dev)
 364 #define to_acpi_driver(d)       container_of(d, struct acpi_driver, drv)
 365
 366 static inline void acpi_set_device_status(struct acpi_device *adev, u32 sta)
 367 {
 368         *((u32 *)&adev->status) = sta;
 369 }
 370
 371 static inline void acpi_set_hp_context(struct acpi_device *adev,
 372                                        struct acpi_hotplug_context *hp,
 373                                        int (*notify)(struct acpi_device *, u32),
 374                                        void (*uevent)(struct acpi_device *, u32),
 375                                        void (*fixup)(struct acpi_device *))
 376 {
 377         hp->self = adev;
 378         hp->notify = notify;
 379         hp->uevent = uevent;
 380         hp->fixup = fixup;
 381         adev->hp = hp;
 382 }
 383
 384 void acpi_initialize_hp_context(struct acpi_device *adev,
 385                                 struct acpi_hotplug_context *hp,
 386                                 int (*notify)(struct acpi_device *, u32),
 387                                 void (*uevent)(struct acpi_device *, u32));
 388
 389 /* acpi_device.dev.bus == &acpi_bus_type */
 390 extern struct bus_type acpi_bus_type;
 391
 392 /*
 393  * Events
 394  * ------
 395  */
 396
 397 struct acpi_bus_event {
 398         struct list_head node;
 399         acpi_device_class device_class;
 400         acpi_bus_id bus_id;
 401         u32 type;
 402         u32 data;
 403 };
 404
 405 extern struct kobject *acpi_kobj;
 406 extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int);
 407 void acpi_bus_private_data_handler(acpi_handle, void *);
 408 int acpi_bus_get_private_data(acpi_handle, void **);
 409 void acpi_bus_no_hotplug(acpi_handle handle);
 410 extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32);
 411 extern int register_acpi_notifier(struct notifier_block *);
 412 extern int unregister_acpi_notifier(struct notifier_block *);
 413
 414 /*
 415  * External Functions
 416  */
 417
 418 int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device);
 419 struct acpi_device *acpi_bus_get_acpi_device(acpi_handle handle);
 420 void acpi_bus_put_acpi_device(struct acpi_device *adev);
 421 acpi_status acpi_bus_get_status_handle(acpi_handle handle,
 422                                        unsigned long long *sta);
 423 int acpi_bus_get_status(struct acpi_device *device);
 424
 425 int acpi_bus_set_power(acpi_handle handle, int state);
 426 const char *acpi_power_state_string(int state);
 427 int acpi_device_get_power(struct acpi_device *device, int *state);
 428 int acpi_device_set_power(struct acpi_device *device, int state);
 429 int acpi_bus_init_power(struct acpi_device *device);
 430 int acpi_device_fix_up_power(struct acpi_device *device);
 431 int acpi_bus_update_power(acpi_handle handle, int *state_p);
 432 bool acpi_bus_power_manageable(acpi_handle handle);
 433
 434 #ifdef CONFIG_PM
 435 bool acpi_bus_can_wakeup(acpi_handle handle);
 436 #else
 437 static inline bool acpi_bus_can_wakeup(acpi_handle handle) { return false; }
 438 #endif
 439
 440 void acpi_scan_lock_acquire(void);
 441 void acpi_scan_lock_release(void);
 442 void acpi_lock_hp_context(void);
 443 void acpi_unlock_hp_context(void);
 444 int acpi_scan_add_handler(struct acpi_scan_handler *handler);
 445 int acpi_bus_register_driver(struct acpi_driver *driver);
 446 void acpi_bus_unregister_driver(struct acpi_driver *driver);
 447 int acpi_bus_scan(acpi_handle handle);
 448 void acpi_bus_trim(struct acpi_device *start);
 449 acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
 450 int acpi_match_device_ids(struct acpi_device *device,
 451                           const struct acpi_device_id *ids);
 452 int acpi_create_dir(struct acpi_device *);
 453 void acpi_remove_dir(struct acpi_device *);
 454
 455 static inline bool acpi_device_enumerated(struct acpi_device *adev)
 456 {
 457         return adev && adev->flags.initialized && adev->flags.visited;
 458 }
 459
 460 /**
 461  * module_acpi_driver(acpi_driver) - Helper macro for registering an ACPI driver
 462  * @__acpi_driver: acpi_driver struct
 463  *
 464  * Helper macro for ACPI drivers which do not do anything special in module
 465  * init/exit. This eliminates a lot of boilerplate. Each module may only
 466  * use this macro once, and calling it replaces module_init() and module_exit()
 467  */
 468 #define module_acpi_driver(__acpi_driver) \
 469         module_driver(__acpi_driver, acpi_bus_register_driver, \
 470                       acpi_bus_unregister_driver)
 471
 472 /*
 473  * Bind physical devices with ACPI devices
 474  */
 475 struct acpi_bus_type {
 476         struct list_head list;
 477         const char *name;
 478         bool (*match)(struct device *dev);
 479         struct acpi_device * (*find_companion)(struct device *);
 480         void (*setup)(struct device *);
 481         void (*cleanup)(struct device *);
 482 };
 483 int register_acpi_bus_type(struct acpi_bus_type *);
 484 int unregister_acpi_bus_type(struct acpi_bus_type *);
 485
 486 struct acpi_pci_root {
 487         struct acpi_device * device;
 488         struct pci_bus *bus;
 489         u16 segment;
 490         struct resource secondary;      /* downstream bus range */
 491
 492         u32 osc_support_set;    /* _OSC state of support bits */
 493         u32 osc_control_set;    /* _OSC state of control bits */
 494         phys_addr_t mcfg_addr;
 495 };
 496
 497 /* helper */
 498
 499 struct acpi_device *acpi_find_child_device(struct acpi_device *parent,
 500                                            u64 address, bool check_children);
 501 int acpi_is_root_bridge(acpi_handle);
 502 struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle);
 503
 504 int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state);
 505 int acpi_disable_wakeup_device_power(struct acpi_device *dev);
 506
 507 #ifdef CONFIG_PM
 508 acpi_status acpi_add_pm_notifier(struct acpi_device *adev,
 509                                  acpi_notify_handler handler, void *context);
 510 acpi_status acpi_remove_pm_notifier(struct acpi_device *adev,
 511                                     acpi_notify_handler handler);
 512 int acpi_pm_device_sleep_state(struct device *, int *, int);
 513 #else
 514 static inline acpi_status acpi_add_pm_notifier(struct acpi_device *adev,
 515                                                acpi_notify_handler handler,
 516                                                void *context)
 517 {
 518         return AE_SUPPORT;
 519 }
 520 static inline acpi_status acpi_remove_pm_notifier(struct acpi_device *adev,
 521                                                   acpi_notify_handler handler)
 522 {
 523         return AE_SUPPORT;
 524 }
 525 static inline int acpi_pm_device_sleep_state(struct device *d, int *p, int m)
 526 {
 527         if (p)
 528                 *p = ACPI_STATE_D0;
 529
 530         return (m >= ACPI_STATE_D0 && m <= ACPI_STATE_D3_COLD) ?
 531                 m : ACPI_STATE_D0;
 532 }
 533 #endif
 534
 535 #ifdef CONFIG_PM_RUNTIME
 536 int __acpi_device_run_wake(struct acpi_device *, bool);
 537 int acpi_pm_device_run_wake(struct device *, bool);
 538 #else
 539 static inline int __acpi_device_run_wake(struct acpi_device *adev, bool en)
 540 {
 541         return -ENODEV;
 542 }
 543 static inline int acpi_pm_device_run_wake(struct device *dev, bool enable)
 544 {
 545         return -ENODEV;
 546 }
 547 #endif
 548
 549 #ifdef CONFIG_PM_SLEEP
 550 int __acpi_device_sleep_wake(struct acpi_device *, u32, bool);
 551 int acpi_pm_device_sleep_wake(struct device *, bool);
 552 #else
 553 static inline int __acpi_device_sleep_wake(struct acpi_device *adev,
 554                                            u32 target_state, bool enable)
 555 {
 556         return -ENODEV;
 557 }
 558 static inline int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
 559 {
 560         return -ENODEV;
 561 }
 562 #endif
 563
 564 #ifdef CONFIG_ACPI_SLEEP
 565 u32 acpi_target_system_state(void);
 566 #else
 567 static inline u32 acpi_target_system_state(void) { return ACPI_STATE_S0; }
 568 #endif
 569
 570 static inline bool acpi_device_power_manageable(struct acpi_device *adev)
 571 {
 572         return adev->flags.power_manageable;
 573 }
 574
 575 static inline bool acpi_device_can_wakeup(struct acpi_device *adev)
 576 {
 577         return adev->wakeup.flags.valid;
 578 }
 579
 580 static inline bool acpi_device_can_poweroff(struct acpi_device *adev)
 581 {
 582         return adev->power.states[ACPI_STATE_D3_COLD].flags.os_accessible;
 583 }
 584
 585 #else   /* CONFIG_ACPI */
 586
 587 static inline int register_acpi_bus_type(void *bus) { return 0; }
 588 static inline int unregister_acpi_bus_type(void *bus) { return 0; }
 589
 590 #endif                          /* CONFIG_ACPI */
 591
 592 #endif /*__ACPI_BUS_H__*/