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