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_hotplug_ost(acpi_handle handle, u32 source_event,
  53                         u32 status_code, 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 #ifdef CONFIG_ACPI
  68
  69 #include <linux/proc_fs.h>
  70
  71 #define ACPI_BUS_FILE_ROOT      "acpi"
  72 extern struct proc_dir_entry *acpi_root_dir;
  73
  74 enum acpi_bus_device_type {
  75         ACPI_BUS_TYPE_DEVICE = 0,
  76         ACPI_BUS_TYPE_POWER,
  77         ACPI_BUS_TYPE_PROCESSOR,
  78         ACPI_BUS_TYPE_THERMAL,
  79         ACPI_BUS_TYPE_POWER_BUTTON,
  80         ACPI_BUS_TYPE_SLEEP_BUTTON,
  81         ACPI_BUS_DEVICE_TYPE_COUNT
  82 };
  83
  84 struct acpi_driver;
  85 struct acpi_device;
  86
  87 /*
  88  * ACPI Scan Handler
  89  * -----------------
  90  */
  91
  92 struct acpi_hotplug_profile {
  93         struct kobject kobj;
  94         bool enabled:1;
  95         int (*scan_dependent)(struct acpi_device *adev);
  96 };
  97
  98 static inline struct acpi_hotplug_profile *to_acpi_hotplug_profile(
  99                                                 struct kobject *kobj)
 100 {
 101         return container_of(kobj, struct acpi_hotplug_profile, kobj);
 102 }
 103
 104 struct acpi_scan_handler {
 105         const struct acpi_device_id *ids;
 106         struct list_head list_node;
 107         int (*attach)(struct acpi_device *dev, const struct acpi_device_id *id);
 108         void (*detach)(struct acpi_device *dev);
 109         struct acpi_hotplug_profile hotplug;
 110 };
 111
 112 /*
 113  * ACPI Driver
 114  * -----------
 115  */
 116
 117 typedef int (*acpi_op_add) (struct acpi_device * device);
 118 typedef int (*acpi_op_remove) (struct acpi_device * device);
 119 typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event);
 120
 121 struct acpi_device_ops {
 122         acpi_op_add add;
 123         acpi_op_remove remove;
 124         acpi_op_notify notify;
 125 };
 126
 127 #define ACPI_DRIVER_ALL_NOTIFY_EVENTS   0x1     /* system AND device events */
 128
 129 struct acpi_driver {
 130         char name[80];
 131         char class[80];
 132         const struct acpi_device_id *ids; /* Supported Hardware IDs */
 133         unsigned int flags;
 134         struct acpi_device_ops ops;
 135         struct device_driver drv;
 136         struct module *owner;
 137 };
 138
 139 /*
 140  * ACPI Device
 141  * -----------
 142  */
 143
 144 /* Status (_STA) */
 145
 146 struct acpi_device_status {
 147         u32 present:1;
 148         u32 enabled:1;
 149         u32 show_in_ui:1;
 150         u32 functional:1;
 151         u32 battery_present:1;
 152         u32 reserved:27;
 153 };
 154
 155 /* Flags */
 156
 157 struct acpi_device_flags {
 158         u32 dynamic_status:1;
 159         u32 removable:1;
 160         u32 ejectable:1;
 161         u32 power_manageable:1;
 162         u32 match_driver:1;
 163         u32 initialized:1;
 164         u32 visited:1;
 165         u32 reserved:25;
 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 ignore_parent:1;    /* Power is independent of parent power state */
 220         u32 reserved:27;
 221 };
 222
 223 struct acpi_device_power_state {
 224         struct {
 225                 u8 valid:1;
 226                 u8 os_accessible:1;
 227                 u8 explicit_set:1;      /* _PSx present? */
 228                 u8 reserved:6;
 229         } flags;
 230         int power;              /* % Power (compared to D0) */
 231         int latency;            /* Dx->D0 time (microseconds) */
 232         struct list_head resources;     /* Power resources referenced */
 233 };
 234
 235 struct acpi_device_power {
 236         int state;              /* Current state */
 237         struct acpi_device_power_flags flags;
 238         struct acpi_device_power_state states[ACPI_D_STATE_COUNT];      /* Power states (D0-D3Cold) */
 239 };
 240
 241 /* Performance Management */
 242
 243 struct acpi_device_perf_flags {
 244         u8 reserved:8;
 245 };
 246
 247 struct acpi_device_perf_state {
 248         struct {
 249                 u8 valid:1;
 250                 u8 reserved:7;
 251         } flags;
 252         u8 power;               /* % Power (compared to P0) */
 253         u8 performance;         /* % Performance (    "   ) */
 254         int latency;            /* Px->P0 time (microseconds) */
 255 };
 256
 257 struct acpi_device_perf {
 258         int state;
 259         struct acpi_device_perf_flags flags;
 260         int state_count;
 261         struct acpi_device_perf_state *states;
 262 };
 263
 264 /* Wakeup Management */
 265 struct acpi_device_wakeup_flags {
 266         u8 valid:1;             /* Can successfully enable wakeup? */
 267         u8 run_wake:1;          /* Run-Wake GPE devices */
 268         u8 notifier_present:1;  /* Wake-up notify handler has been installed */
 269 };
 270
 271 struct acpi_device_wakeup {
 272         acpi_handle gpe_device;
 273         u64 gpe_number;
 274         u64 sleep_state;
 275         struct list_head resources;
 276         struct acpi_device_wakeup_flags flags;
 277         int prepare_count;
 278 };
 279
 280 struct acpi_device_physical_node {
 281         unsigned int node_id;
 282         struct list_head node;
 283         struct device *dev;
 284         bool put_online:1;
 285 };
 286
 287 /* Device */
 288 struct acpi_device {
 289         int device_type;
 290         acpi_handle handle;             /* no handle for fixed hardware */
 291         struct acpi_device *parent;
 292         struct list_head children;
 293         struct list_head node;
 294         struct list_head wakeup_list;
 295         struct list_head del_list;
 296         struct acpi_device_status status;
 297         struct acpi_device_flags flags;
 298         struct acpi_device_pnp pnp;
 299         struct acpi_device_power power;
 300         struct acpi_device_wakeup wakeup;
 301         struct acpi_device_perf performance;
 302         struct acpi_device_dir dir;
 303         struct acpi_scan_handler *handler;
 304         struct acpi_driver *driver;
 305         void *driver_data;
 306         struct device dev;
 307         unsigned int physical_node_count;
 308         struct list_head physical_node_list;
 309         struct mutex physical_node_lock;
 310         void (*remove)(struct acpi_device *);
 311 };
 312
 313 static inline void *acpi_driver_data(struct acpi_device *d)
 314 {
 315         return d->driver_data;
 316 }
 317
 318 #define to_acpi_device(d)       container_of(d, struct acpi_device, dev)
 319 #define to_acpi_driver(d)       container_of(d, struct acpi_driver, drv)
 320
 321 static inline void acpi_set_device_status(struct acpi_device *adev, u32 sta)
 322 {
 323         *((u32 *)&adev->status) = sta;
 324 }
 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 extern struct kobject *acpi_kobj;
 343 extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int);
 344 void acpi_bus_private_data_handler(acpi_handle, void *);
 345 int acpi_bus_get_private_data(acpi_handle, void **);
 346 extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32);
 347 extern int register_acpi_notifier(struct notifier_block *);
 348 extern int unregister_acpi_notifier(struct notifier_block *);
 349
 350 /*
 351  * External Functions
 352  */
 353
 354 int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device);
 355 acpi_status acpi_bus_get_status_handle(acpi_handle handle,
 356                                        unsigned long long *sta);
 357 int acpi_bus_get_status(struct acpi_device *device);
 358
 359 int acpi_bus_set_power(acpi_handle handle, int state);
 360 const char *acpi_power_state_string(int state);
 361 int acpi_device_get_power(struct acpi_device *device, int *state);
 362 int acpi_device_set_power(struct acpi_device *device, int state);
 363 int acpi_bus_init_power(struct acpi_device *device);
 364 int acpi_device_fix_up_power(struct acpi_device *device);
 365 int acpi_bus_update_power(acpi_handle handle, int *state_p);
 366 bool acpi_bus_power_manageable(acpi_handle handle);
 367
 368 #ifdef CONFIG_PM
 369 bool acpi_bus_can_wakeup(acpi_handle handle);
 370 #else
 371 static inline bool acpi_bus_can_wakeup(acpi_handle handle) { return false; }
 372 #endif
 373
 374 void acpi_scan_lock_acquire(void);
 375 void acpi_scan_lock_release(void);
 376 int acpi_scan_add_handler(struct acpi_scan_handler *handler);
 377 int acpi_bus_register_driver(struct acpi_driver *driver);
 378 void acpi_bus_unregister_driver(struct acpi_driver *driver);
 379 int acpi_bus_scan(acpi_handle handle);
 380 void acpi_bus_trim(struct acpi_device *start);
 381 acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
 382 int acpi_match_device_ids(struct acpi_device *device,
 383                           const struct acpi_device_id *ids);
 384 int acpi_create_dir(struct acpi_device *);
 385 void acpi_remove_dir(struct acpi_device *);
 386
 387 static inline bool acpi_device_enumerated(struct acpi_device *adev)
 388 {
 389         return adev && adev->flags.initialized && adev->flags.visited;
 390 }
 391
 392 typedef void (*acpi_hp_callback)(void *data, u32 src);
 393
 394 acpi_status acpi_hotplug_execute(acpi_hp_callback func, void *data, u32 src);
 395
 396 /**
 397  * module_acpi_driver(acpi_driver) - Helper macro for registering an ACPI driver
 398  * @__acpi_driver: acpi_driver struct
 399  *
 400  * Helper macro for ACPI drivers which do not do anything special in module
 401  * init/exit. This eliminates a lot of boilerplate. Each module may only
 402  * use this macro once, and calling it replaces module_init() and module_exit()
 403  */
 404 #define module_acpi_driver(__acpi_driver) \
 405         module_driver(__acpi_driver, acpi_bus_register_driver, \
 406                       acpi_bus_unregister_driver)
 407
 408 /*
 409  * Bind physical devices with ACPI devices
 410  */
 411 struct acpi_bus_type {
 412         struct list_head list;
 413         const char *name;
 414         bool (*match)(struct device *dev);
 415         int (*find_device) (struct device *, acpi_handle *);
 416         void (*setup)(struct device *);
 417         void (*cleanup)(struct device *);
 418 };
 419 int register_acpi_bus_type(struct acpi_bus_type *);
 420 int unregister_acpi_bus_type(struct acpi_bus_type *);
 421
 422 struct acpi_pci_root {
 423         struct acpi_device * device;
 424         struct pci_bus *bus;
 425         u16 segment;
 426         struct resource secondary;      /* downstream bus range */
 427
 428         u32 osc_support_set;    /* _OSC state of support bits */
 429         u32 osc_control_set;    /* _OSC state of control bits */
 430         phys_addr_t mcfg_addr;
 431 };
 432
 433 /* helper */
 434 acpi_handle acpi_find_child(acpi_handle, u64, bool);
 435 static inline acpi_handle acpi_get_child(acpi_handle handle, u64 addr)
 436 {
 437         return acpi_find_child(handle, addr, false);
 438 }
 439 void acpi_preset_companion(struct device *dev, acpi_handle parent, u64 addr);
 440 int acpi_is_root_bridge(acpi_handle);
 441 struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle);
 442
 443 int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state);
 444 int acpi_disable_wakeup_device_power(struct acpi_device *dev);
 445
 446 #ifdef CONFIG_PM
 447 acpi_status acpi_add_pm_notifier(struct acpi_device *adev,
 448                                  acpi_notify_handler handler, void *context);
 449 acpi_status acpi_remove_pm_notifier(struct acpi_device *adev,
 450                                     acpi_notify_handler handler);
 451 int acpi_pm_device_sleep_state(struct device *, int *, int);
 452 #else
 453 static inline acpi_status acpi_add_pm_notifier(struct acpi_device *adev,
 454                                                acpi_notify_handler handler,
 455                                                void *context)
 456 {
 457         return AE_SUPPORT;
 458 }
 459 static inline acpi_status acpi_remove_pm_notifier(struct acpi_device *adev,
 460                                                   acpi_notify_handler handler)
 461 {
 462         return AE_SUPPORT;
 463 }
 464 static inline int acpi_pm_device_sleep_state(struct device *d, int *p, int m)
 465 {
 466         if (p)
 467                 *p = ACPI_STATE_D0;
 468
 469         return (m >= ACPI_STATE_D0 && m <= ACPI_STATE_D3_COLD) ?
 470                 m : ACPI_STATE_D0;
 471 }
 472 #endif
 473
 474 #ifdef CONFIG_PM_RUNTIME
 475 int __acpi_device_run_wake(struct acpi_device *, bool);
 476 int acpi_pm_device_run_wake(struct device *, bool);
 477 #else
 478 static inline int __acpi_device_run_wake(struct acpi_device *adev, bool en)
 479 {
 480         return -ENODEV;
 481 }
 482 static inline int acpi_pm_device_run_wake(struct device *dev, bool enable)
 483 {
 484         return -ENODEV;
 485 }
 486 #endif
 487
 488 #ifdef CONFIG_PM_SLEEP
 489 int __acpi_device_sleep_wake(struct acpi_device *, u32, bool);
 490 int acpi_pm_device_sleep_wake(struct device *, bool);
 491 #else
 492 static inline int __acpi_device_sleep_wake(struct acpi_device *adev,
 493                                            u32 target_state, bool enable)
 494 {
 495         return -ENODEV;
 496 }
 497 static inline int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
 498 {
 499         return -ENODEV;
 500 }
 501 #endif
 502
 503 #ifdef CONFIG_ACPI_SLEEP
 504 u32 acpi_target_system_state(void);
 505 #else
 506 static inline u32 acpi_target_system_state(void) { return ACPI_STATE_S0; }
 507 #endif
 508
 509 static inline bool acpi_device_power_manageable(struct acpi_device *adev)
 510 {
 511         return adev->flags.power_manageable;
 512 }
 513
 514 static inline bool acpi_device_can_wakeup(struct acpi_device *adev)
 515 {
 516         return adev->wakeup.flags.valid;
 517 }
 518
 519 static inline bool acpi_device_can_poweroff(struct acpi_device *adev)
 520 {
 521         return adev->power.states[ACPI_STATE_D3_COLD].flags.os_accessible;
 522 }
 523
 524 #else   /* CONFIG_ACPI */
 525
 526 static inline int register_acpi_bus_type(void *bus) { return 0; }
 527 static inline int unregister_acpi_bus_type(void *bus) { return 0; }
 528
 529 #endif                          /* CONFIG_ACPI */
 530
 531 #endif /*__ACPI_BUS_H__*/