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