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