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