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