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