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