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