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