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