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