Pileus Git - ~andy/linux/blob - 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 /* TBD: Make dynamic */
  32 #define ACPI_MAX_HANDLES        10
  33 struct acpi_handle_list {
  34         u32 count;
  35         acpi_handle handles[ACPI_MAX_HANDLES];
  36 };
  37
  38 /* acpi_utils.h */
  39 acpi_status
  40 acpi_extract_package(union acpi_object *package,
  41                      struct acpi_buffer *format, struct acpi_buffer *buffer);
  42 acpi_status
  43 acpi_evaluate_integer(acpi_handle handle,
  44                       acpi_string pathname,
  45                       struct acpi_object_list *arguments, unsigned long long *data);
  46 acpi_status
  47 acpi_evaluate_reference(acpi_handle handle,
  48                         acpi_string pathname,
  49                         struct acpi_object_list *arguments,
  50                         struct acpi_handle_list *list);
  51 acpi_status
  52 acpi_evaluate_hotplug_ost(acpi_handle handle, u32 source_event,
  53                         u32 status_code, struct acpi_buffer *status_buf);
  54
  55 acpi_status
  56 acpi_get_physical_device_location(acpi_handle handle, struct acpi_pld_info **pld);
  57
  58 bool acpi_has_method(acpi_handle handle, char *name);
  59 acpi_status acpi_execute_simple_method(acpi_handle handle, char *method,
  60                                        u64 arg);
  61 acpi_status acpi_evaluate_ej0(acpi_handle handle);
  62 acpi_status acpi_evaluate_lck(acpi_handle handle, int lock);
  63 bool acpi_ata_match(acpi_handle handle);
  64 bool acpi_bay_match(acpi_handle handle);
  65 bool acpi_dock_match(acpi_handle handle);
  66
  67 #ifdef CONFIG_ACPI
  68
  69 #include <linux/proc_fs.h>
  70
  71 #define ACPI_BUS_FILE_ROOT      "acpi"
  72 extern struct proc_dir_entry *acpi_root_dir;
  73
  74 enum acpi_bus_device_type {
  75         ACPI_BUS_TYPE_DEVICE = 0,
  76         ACPI_BUS_TYPE_POWER,
  77         ACPI_BUS_TYPE_PROCESSOR,
  78         ACPI_BUS_TYPE_THERMAL,
  79         ACPI_BUS_TYPE_POWER_BUTTON,
  80         ACPI_BUS_TYPE_SLEEP_BUTTON,
  81         ACPI_BUS_DEVICE_TYPE_COUNT
  82 };
  83
  84 struct acpi_driver;
  85 struct acpi_device;
  86
  87 /*
  88  * ACPI Scan Handler
  89  * -----------------
  90  */
  91
  92 struct acpi_hotplug_profile {
  93         struct kobject kobj;
  94         int (*scan_dependent)(struct acpi_device *adev);
  95         bool enabled:1;
  96         bool demand_offline:1;
  97 };
  98
  99 static inline struct acpi_hotplug_profile *to_acpi_hotplug_profile(
 100                                                 struct kobject *kobj)
 101 {
 102         return container_of(kobj, struct acpi_hotplug_profile, kobj);
 103 }
 104
 105 struct acpi_scan_handler {
 106         const struct acpi_device_id *ids;
 107         struct list_head list_node;
 108         int (*attach)(struct acpi_device *dev, const struct acpi_device_id *id);
 109         void (*detach)(struct acpi_device *dev);
 110         struct acpi_hotplug_profile hotplug;
 111 };
 112
 113 /*
 114  * ACPI Driver
 115  * -----------
 116  */
 117
 118 typedef int (*acpi_op_add) (struct acpi_device * device);
 119 typedef int (*acpi_op_remove) (struct acpi_device * device);
 120 typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event);
 121
 122 struct acpi_device_ops {
 123         acpi_op_add add;
 124         acpi_op_remove remove;
 125         acpi_op_notify notify;
 126 };
 127
 128 #define ACPI_DRIVER_ALL_NOTIFY_EVENTS   0x1     /* system AND device events */
 129
 130 struct acpi_driver {
 131         char name[80];
 132         char class[80];
 133         const struct acpi_device_id *ids; /* Supported Hardware IDs */
 134         unsigned int flags;
 135         struct acpi_device_ops ops;
 136         struct device_driver drv;
 137         struct module *owner;
 138 };
 139
 140 /*
 141  * ACPI Device
 142  * -----------
 143  */
 144
 145 /* Status (_STA) */
 146
 147 struct acpi_device_status {
 148         u32 present:1;
 149         u32 enabled:1;
 150         u32 show_in_ui:1;
 151         u32 functional:1;
 152         u32 battery_present:1;
 153         u32 reserved:27;
 154 };
 155
 156 /* Flags */
 157
 158 struct acpi_device_flags {
 159         u32 dynamic_status:1;
 160         u32 removable:1;
 161         u32 ejectable:1;
 162         u32 power_manageable:1;
 163         u32 match_driver:1;
 164         u32 initialized:1;
 165         u32 visited:1;
 166         u32 reserved:25;
 167 };
 168
 169 /* File System */
 170
 171 struct acpi_device_dir {
 172         struct proc_dir_entry *entry;
 173 };
 174
 175 #define acpi_device_dir(d)      ((d)->dir.entry)
 176
 177 /* Plug and Play */
 178
 179 typedef char acpi_bus_id[8];
 180 typedef unsigned long acpi_bus_address;
 181 typedef char acpi_device_name[40];
 182 typedef char acpi_device_class[20];
 183
 184 struct acpi_hardware_id {
 185         struct list_head list;
 186         char *id;
 187 };
 188
 189 struct acpi_pnp_type {
 190         u32 hardware_id:1;
 191         u32 bus_address:1;
 192         u32 reserved:30;
 193 };
 194
 195 struct acpi_device_pnp {
 196         acpi_bus_id bus_id;             /* Object name */
 197         struct acpi_pnp_type type;      /* ID type */
 198         acpi_bus_address bus_address;   /* _ADR */
 199         char *unique_id;                /* _UID */
 200         struct list_head ids;           /* _HID and _CIDs */
 201         acpi_device_name device_name;   /* Driver-determined */
 202         acpi_device_class device_class; /*        "          */
 203         union acpi_object *str_obj;     /* unicode string for _STR method */
 204         unsigned long sun;              /* _SUN */
 205 };
 206
 207 #define acpi_device_bid(d)      ((d)->pnp.bus_id)
 208 #define acpi_device_adr(d)      ((d)->pnp.bus_address)
 209 const char *acpi_device_hid(struct acpi_device *device);
 210 #define acpi_device_name(d)     ((d)->pnp.device_name)
 211 #define acpi_device_class(d)    ((d)->pnp.device_class)
 212
 213 /* Power Management */
 214
 215 struct acpi_device_power_flags {
 216         u32 explicit_get:1;     /* _PSC present? */
 217         u32 power_resources:1;  /* Power resources */
 218         u32 inrush_current:1;   /* Serialize Dx->D0 */
 219         u32 power_removed:1;    /* Optimize Dx->D0 */
 220         u32 ignore_parent:1;    /* Power is independent of parent power state */
 221         u32 reserved:27;
 222 };
 223
 224 struct acpi_device_power_state {
 225         struct {
 226                 u8 valid:1;
 227                 u8 os_accessible:1;
 228                 u8 explicit_set:1;      /* _PSx present? */
 229                 u8 reserved:6;
 230         } flags;
 231         int power;              /* % Power (compared to D0) */
 232         int latency;            /* Dx->D0 time (microseconds) */
 233         struct list_head resources;     /* Power resources referenced */
 234 };
 235
 236 struct acpi_device_power {
 237         int state;              /* Current state */
 238         struct acpi_device_power_flags flags;
 239         struct acpi_device_power_state states[ACPI_D_STATE_COUNT];      /* Power states (D0-D3Cold) */
 240 };
 241
 242 /* Performance Management */
 243
 244 struct acpi_device_perf_flags {
 245         u8 reserved:8;
 246 };
 247
 248 struct acpi_device_perf_state {
 249         struct {
 250                 u8 valid:1;
 251                 u8 reserved:7;
 252         } flags;
 253         u8 power;               /* % Power (compared to P0) */
 254         u8 performance;         /* % Performance (    "   ) */
 255         int latency;            /* Px->P0 time (microseconds) */
 256 };
 257
 258 struct acpi_device_perf {
 259         int state;
 260         struct acpi_device_perf_flags flags;
 261         int state_count;
 262         struct acpi_device_perf_state *states;
 263 };
 264
 265 /* Wakeup Management */
 266 struct acpi_device_wakeup_flags {
 267         u8 valid:1;             /* Can successfully enable wakeup? */
 268         u8 run_wake:1;          /* Run-Wake GPE devices */
 269         u8 notifier_present:1;  /* Wake-up notify handler has been installed */
 270 };
 271
 272 struct acpi_device_wakeup {
 273         acpi_handle gpe_device;
 274         u64 gpe_number;
 275         u64 sleep_state;
 276         struct list_head resources;
 277         struct acpi_device_wakeup_flags flags;
 278         int prepare_count;
 279 };
 280
 281 struct acpi_device_physical_node {
 282         unsigned int node_id;
 283         struct list_head node;
 284         struct device *dev;
 285         bool put_online:1;
 286 };
 287
 288 /* Device */
 289 struct acpi_device {
 290         int device_type;
 291         acpi_handle handle;             /* no handle for fixed hardware */
 292         struct acpi_device *parent;
 293         struct list_head children;
 294         struct list_head node;
 295         struct list_head wakeup_list;
 296         struct list_head del_list;
 297         struct acpi_device_status status;
 298         struct acpi_device_flags flags;
 299         struct acpi_device_pnp pnp;
 300         struct acpi_device_power power;
 301         struct acpi_device_wakeup wakeup;
 302         struct acpi_device_perf performance;
 303         struct acpi_device_dir dir;
 304         struct acpi_scan_handler *handler;
 305         struct acpi_driver *driver;
 306         void *driver_data;
 307         struct device dev;
 308         unsigned int physical_node_count;
 309         struct list_head physical_node_list;
 310         struct mutex physical_node_lock;
 311         void (*remove)(struct acpi_device *);
 312 };
 313
 314 static inline void *acpi_driver_data(struct acpi_device *d)
 315 {
 316         return d->driver_data;
 317 }
 318
 319 #define to_acpi_device(d)       container_of(d, struct acpi_device, dev)
 320 #define to_acpi_driver(d)       container_of(d, struct acpi_driver, drv)
 321
 322 static inline void acpi_set_device_status(struct acpi_device *adev, u32 sta)
 323 {
 324         *((u32 *)&adev->status) = sta;
 325 }
 326
 327 /* acpi_device.dev.bus == &acpi_bus_type */
 328 extern struct bus_type acpi_bus_type;
 329
 330 /*
 331  * Events
 332  * ------
 333  */
 334
 335 struct acpi_bus_event {
 336         struct list_head node;
 337         acpi_device_class device_class;
 338         acpi_bus_id bus_id;
 339         u32 type;
 340         u32 data;
 341 };
 342
 343 extern struct kobject *acpi_kobj;
 344 extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int);
 345 void acpi_bus_private_data_handler(acpi_handle, void *);
 346 int acpi_bus_get_private_data(acpi_handle, void **);
 347 extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32);
 348 extern int register_acpi_notifier(struct notifier_block *);
 349 extern int unregister_acpi_notifier(struct notifier_block *);
 350
 351 /*
 352  * External Functions
 353  */
 354
 355 int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device);
 356 acpi_status acpi_bus_get_status_handle(acpi_handle handle,
 357                                        unsigned long long *sta);
 358 int acpi_bus_get_status(struct acpi_device *device);
 359
 360 int acpi_bus_set_power(acpi_handle handle, int state);
 361 const char *acpi_power_state_string(int state);
 362 int acpi_device_get_power(struct acpi_device *device, int *state);
 363 int acpi_device_set_power(struct acpi_device *device, int state);
 364 int acpi_bus_init_power(struct acpi_device *device);
 365 int acpi_device_fix_up_power(struct acpi_device *device);
 366 int acpi_bus_update_power(acpi_handle handle, int *state_p);
 367 bool acpi_bus_power_manageable(acpi_handle handle);
 368
 369 #ifdef CONFIG_PM
 370 bool acpi_bus_can_wakeup(acpi_handle handle);
 371 #else
 372 static inline bool acpi_bus_can_wakeup(acpi_handle handle) { return false; }
 373 #endif
 374
 375 void acpi_scan_lock_acquire(void);
 376 void acpi_scan_lock_release(void);
 377 int acpi_scan_add_handler(struct acpi_scan_handler *handler);
 378 int acpi_bus_register_driver(struct acpi_driver *driver);
 379 void acpi_bus_unregister_driver(struct acpi_driver *driver);
 380 int acpi_bus_scan(acpi_handle handle);
 381 void acpi_bus_trim(struct acpi_device *start);
 382 acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
 383 int acpi_match_device_ids(struct acpi_device *device,
 384                           const struct acpi_device_id *ids);
 385 int acpi_create_dir(struct acpi_device *);
 386 void acpi_remove_dir(struct acpi_device *);
 387
 388 static inline bool acpi_device_enumerated(struct acpi_device *adev)
 389 {
 390         return adev && adev->flags.initialized && adev->flags.visited;
 391 }
 392
 393 typedef void (*acpi_hp_callback)(void *data, u32 src);
 394
 395 acpi_status acpi_hotplug_execute(acpi_hp_callback func, void *data, u32 src);
 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         const char *name;
 415         bool (*match)(struct device *dev);
 416         struct acpi_device * (*find_companion)(struct device *);
 417         void (*setup)(struct device *);
 418         void (*cleanup)(struct device *);
 419 };
 420 int register_acpi_bus_type(struct acpi_bus_type *);
 421 int unregister_acpi_bus_type(struct acpi_bus_type *);
 422
 423 struct acpi_pci_root {
 424         struct acpi_device * device;
 425         struct pci_bus *bus;
 426         u16 segment;
 427         struct resource secondary;      /* downstream bus range */
 428
 429         u32 osc_support_set;    /* _OSC state of support bits */
 430         u32 osc_control_set;    /* _OSC state of control bits */
 431         phys_addr_t mcfg_addr;
 432 };
 433
 434 /* helper */
 435
 436 struct acpi_device *acpi_find_child_device(struct acpi_device *parent,
 437                                            u64 address, bool check_children);
 438 int acpi_is_root_bridge(acpi_handle);
 439 struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle);
 440
 441 int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state);
 442 int acpi_disable_wakeup_device_power(struct acpi_device *dev);
 443
 444 #ifdef CONFIG_PM
 445 acpi_status acpi_add_pm_notifier(struct acpi_device *adev,
 446                                  acpi_notify_handler handler, void *context);
 447 acpi_status acpi_remove_pm_notifier(struct acpi_device *adev,
 448                                     acpi_notify_handler handler);
 449 int acpi_pm_device_sleep_state(struct device *, int *, int);
 450 #else
 451 static inline acpi_status acpi_add_pm_notifier(struct acpi_device *adev,
 452                                                acpi_notify_handler handler,
 453                                                void *context)
 454 {
 455         return AE_SUPPORT;
 456 }
 457 static inline acpi_status acpi_remove_pm_notifier(struct acpi_device *adev,
 458                                                   acpi_notify_handler handler)
 459 {
 460         return AE_SUPPORT;
 461 }
 462 static inline int acpi_pm_device_sleep_state(struct device *d, int *p, int m)
 463 {
 464         if (p)
 465                 *p = ACPI_STATE_D0;
 466
 467         return (m >= ACPI_STATE_D0 && m <= ACPI_STATE_D3_COLD) ?
 468                 m : ACPI_STATE_D0;
 469 }
 470 #endif
 471
 472 #ifdef CONFIG_PM_RUNTIME
 473 int __acpi_device_run_wake(struct acpi_device *, bool);
 474 int acpi_pm_device_run_wake(struct device *, bool);
 475 #else
 476 static inline int __acpi_device_run_wake(struct acpi_device *adev, bool en)
 477 {
 478         return -ENODEV;
 479 }
 480 static inline int acpi_pm_device_run_wake(struct device *dev, bool enable)
 481 {
 482         return -ENODEV;
 483 }
 484 #endif
 485
 486 #ifdef CONFIG_PM_SLEEP
 487 int __acpi_device_sleep_wake(struct acpi_device *, u32, bool);
 488 int acpi_pm_device_sleep_wake(struct device *, bool);
 489 #else
 490 static inline int __acpi_device_sleep_wake(struct acpi_device *adev,
 491                                            u32 target_state, bool enable)
 492 {
 493         return -ENODEV;
 494 }
 495 static inline int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
 496 {
 497         return -ENODEV;
 498 }
 499 #endif
 500
 501 #ifdef CONFIG_ACPI_SLEEP
 502 u32 acpi_target_system_state(void);
 503 #else
 504 static inline u32 acpi_target_system_state(void) { return ACPI_STATE_S0; }
 505 #endif
 506
 507 static inline bool acpi_device_power_manageable(struct acpi_device *adev)
 508 {
 509         return adev->flags.power_manageable;
 510 }
 511
 512 static inline bool acpi_device_can_wakeup(struct acpi_device *adev)
 513 {
 514         return adev->wakeup.flags.valid;
 515 }
 516
 517 static inline bool acpi_device_can_poweroff(struct acpi_device *adev)
 518 {
 519         return adev->power.states[ACPI_STATE_D3_COLD].flags.os_accessible;
 520 }
 521
 522 #else   /* CONFIG_ACPI */
 523
 524 static inline int register_acpi_bus_type(void *bus) { return 0; }
 525 static inline int unregister_acpi_bus_type(void *bus) { return 0; }
 526
 527 #endif                          /* CONFIG_ACPI */
 528
 529 #endif /*__ACPI_BUS_H__*/