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