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 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 20 */ 21 22 #ifndef __ACPI_BUS_H__ 23 #define __ACPI_BUS_H__ 24 25 #include <linux/device.h> 26 #include <linux/property.h> 27 28 /* TBD: Make dynamic */ 29 #define ACPI_MAX_HANDLES 10 30 struct acpi_handle_list { 31 u32 count; 32 acpi_handle handles[ACPI_MAX_HANDLES]; 33 }; 34 35 /* acpi_utils.h */ 36 acpi_status 37 acpi_extract_package(union acpi_object *package, 38 struct acpi_buffer *format, struct acpi_buffer *buffer); 39 acpi_status 40 acpi_evaluate_integer(acpi_handle handle, 41 acpi_string pathname, 42 struct acpi_object_list *arguments, unsigned long long *data); 43 acpi_status 44 acpi_evaluate_reference(acpi_handle handle, 45 acpi_string pathname, 46 struct acpi_object_list *arguments, 47 struct acpi_handle_list *list); 48 acpi_status 49 acpi_evaluate_ost(acpi_handle handle, u32 source_event, u32 status_code, 50 struct acpi_buffer *status_buf); 51 52 acpi_status 53 acpi_get_physical_device_location(acpi_handle handle, struct acpi_pld_info **pld); 54 55 bool acpi_has_method(acpi_handle handle, char *name); 56 acpi_status acpi_execute_simple_method(acpi_handle handle, char *method, 57 u64 arg); 58 acpi_status acpi_evaluate_ej0(acpi_handle handle); 59 acpi_status acpi_evaluate_lck(acpi_handle handle, int lock); 60 bool acpi_ata_match(acpi_handle handle); 61 bool acpi_bay_match(acpi_handle handle); 62 bool acpi_dock_match(acpi_handle handle); 63 64 bool acpi_check_dsm(acpi_handle handle, const u8 *uuid, u64 rev, u64 funcs); 65 union acpi_object *acpi_evaluate_dsm(acpi_handle handle, const u8 *uuid, 66 u64 rev, u64 func, union acpi_object *argv4); 67 68 static inline union acpi_object * 69 acpi_evaluate_dsm_typed(acpi_handle handle, const u8 *uuid, u64 rev, u64 func, 70 union acpi_object *argv4, acpi_object_type type) 71 { 72 union acpi_object *obj; 73 74 obj = acpi_evaluate_dsm(handle, uuid, rev, func, argv4); 75 if (obj && obj->type != type) { 76 ACPI_FREE(obj); 77 obj = NULL; 78 } 79 80 return obj; 81 } 82 83 #define ACPI_INIT_DSM_ARGV4(cnt, eles) \ 84 { \ 85 .package.type = ACPI_TYPE_PACKAGE, \ 86 .package.count = (cnt), \ 87 .package.elements = (eles) \ 88 } 89 90 bool acpi_dev_found(const char *hid); 91 bool acpi_dev_present(const char *hid, const char *uid, s64 hrv); 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 void (*notify_online)(struct acpi_device *adev); 122 bool enabled:1; 123 bool demand_offline:1; 124 }; 125 126 static inline struct acpi_hotplug_profile *to_acpi_hotplug_profile( 127 struct kobject *kobj) 128 { 129 return container_of(kobj, struct acpi_hotplug_profile, kobj); 130 } 131 132 struct acpi_scan_handler { 133 const struct acpi_device_id *ids; 134 struct list_head list_node; 135 bool (*match)(const char *idstr, const struct acpi_device_id **matchid); 136 int (*attach)(struct acpi_device *dev, const struct acpi_device_id *id); 137 void (*detach)(struct acpi_device *dev); 138 void (*bind)(struct device *phys_dev); 139 void (*unbind)(struct device *phys_dev); 140 struct acpi_hotplug_profile hotplug; 141 }; 142 143 /* 144 * ACPI Hotplug Context 145 * -------------------- 146 */ 147 148 struct acpi_hotplug_context { 149 struct acpi_device *self; 150 int (*notify)(struct acpi_device *, u32); 151 void (*uevent)(struct acpi_device *, u32); 152 void (*fixup)(struct acpi_device *); 153 }; 154 155 /* 156 * ACPI Driver 157 * ----------- 158 */ 159 160 typedef int (*acpi_op_add) (struct acpi_device * device); 161 typedef int (*acpi_op_remove) (struct acpi_device * device); 162 typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event); 163 164 struct acpi_device_ops { 165 acpi_op_add add; 166 acpi_op_remove remove; 167 acpi_op_notify notify; 168 }; 169 170 #define ACPI_DRIVER_ALL_NOTIFY_EVENTS 0x1 /* system AND device events */ 171 172 struct acpi_driver { 173 char name[80]; 174 char class[80]; 175 const struct acpi_device_id *ids; /* Supported Hardware IDs */ 176 unsigned int flags; 177 struct acpi_device_ops ops; 178 struct device_driver drv; 179 struct module *owner; 180 }; 181 182 /* 183 * ACPI Device 184 * ----------- 185 */ 186 187 /* Status (_STA) */ 188 189 struct acpi_device_status { 190 u32 present:1; 191 u32 enabled:1; 192 u32 show_in_ui:1; 193 u32 functional:1; 194 u32 battery_present:1; 195 u32 reserved:27; 196 }; 197 198 /* Flags */ 199 200 struct acpi_device_flags { 201 u32 dynamic_status:1; 202 u32 removable:1; 203 u32 ejectable:1; 204 u32 power_manageable:1; 205 u32 match_driver:1; 206 u32 initialized:1; 207 u32 visited:1; 208 u32 hotplug_notify:1; 209 u32 is_dock_station:1; 210 u32 of_compatible_ok:1; 211 u32 coherent_dma:1; 212 u32 cca_seen:1; 213 u32 spi_i2c_slave:1; 214 u32 reserved:19; 215 }; 216 217 /* File System */ 218 219 struct acpi_device_dir { 220 struct proc_dir_entry *entry; 221 }; 222 223 #define acpi_device_dir(d) ((d)->dir.entry) 224 225 /* Plug and Play */ 226 227 typedef char acpi_bus_id[8]; 228 typedef unsigned long acpi_bus_address; 229 typedef char acpi_device_name[40]; 230 typedef char acpi_device_class[20]; 231 232 struct acpi_hardware_id { 233 struct list_head list; 234 const char *id; 235 }; 236 237 struct acpi_pnp_type { 238 u32 hardware_id:1; 239 u32 bus_address:1; 240 u32 platform_id:1; 241 u32 reserved:29; 242 }; 243 244 struct acpi_device_pnp { 245 acpi_bus_id bus_id; /* Object name */ 246 struct acpi_pnp_type type; /* ID type */ 247 acpi_bus_address bus_address; /* _ADR */ 248 char *unique_id; /* _UID */ 249 struct list_head ids; /* _HID and _CIDs */ 250 acpi_device_name device_name; /* Driver-determined */ 251 acpi_device_class device_class; /* " */ 252 union acpi_object *str_obj; /* unicode string for _STR method */ 253 }; 254 255 #define acpi_device_bid(d) ((d)->pnp.bus_id) 256 #define acpi_device_adr(d) ((d)->pnp.bus_address) 257 const char *acpi_device_hid(struct acpi_device *device); 258 #define acpi_device_uid(d) ((d)->pnp.unique_id) 259 #define acpi_device_name(d) ((d)->pnp.device_name) 260 #define acpi_device_class(d) ((d)->pnp.device_class) 261 262 /* Power Management */ 263 264 struct acpi_device_power_flags { 265 u32 explicit_get:1; /* _PSC present? */ 266 u32 power_resources:1; /* Power resources */ 267 u32 inrush_current:1; /* Serialize Dx->D0 */ 268 u32 power_removed:1; /* Optimize Dx->D0 */ 269 u32 ignore_parent:1; /* Power is independent of parent power state */ 270 u32 dsw_present:1; /* _DSW present? */ 271 u32 reserved:26; 272 }; 273 274 struct acpi_device_power_state { 275 struct { 276 u8 valid:1; 277 u8 explicit_set:1; /* _PSx present? */ 278 u8 reserved:6; 279 } flags; 280 int power; /* % Power (compared to D0) */ 281 int latency; /* Dx->D0 time (microseconds) */ 282 struct list_head resources; /* Power resources referenced */ 283 }; 284 285 struct acpi_device_power { 286 int state; /* Current state */ 287 struct acpi_device_power_flags flags; 288 struct acpi_device_power_state states[ACPI_D_STATE_COUNT]; /* Power states (D0-D3Cold) */ 289 }; 290 291 /* Performance Management */ 292 293 struct acpi_device_perf_flags { 294 u8 reserved:8; 295 }; 296 297 struct acpi_device_perf_state { 298 struct { 299 u8 valid:1; 300 u8 reserved:7; 301 } flags; 302 u8 power; /* % Power (compared to P0) */ 303 u8 performance; /* % Performance ( " ) */ 304 int latency; /* Px->P0 time (microseconds) */ 305 }; 306 307 struct acpi_device_perf { 308 int state; 309 struct acpi_device_perf_flags flags; 310 int state_count; 311 struct acpi_device_perf_state *states; 312 }; 313 314 /* Wakeup Management */ 315 struct acpi_device_wakeup_flags { 316 u8 valid:1; /* Can successfully enable wakeup? */ 317 u8 run_wake:1; /* Run-Wake GPE devices */ 318 u8 notifier_present:1; /* Wake-up notify handler has been installed */ 319 u8 enabled:1; /* Enabled for wakeup */ 320 }; 321 322 struct acpi_device_wakeup_context { 323 struct work_struct work; 324 struct device *dev; 325 }; 326 327 struct acpi_device_wakeup { 328 acpi_handle gpe_device; 329 u64 gpe_number; 330 u64 sleep_state; 331 struct list_head resources; 332 struct acpi_device_wakeup_flags flags; 333 struct acpi_device_wakeup_context context; 334 struct wakeup_source *ws; 335 int prepare_count; 336 }; 337 338 struct acpi_device_physical_node { 339 unsigned int node_id; 340 struct list_head node; 341 struct device *dev; 342 bool put_online:1; 343 }; 344 345 /* ACPI Device Specific Data (_DSD) */ 346 struct acpi_device_data { 347 const union acpi_object *pointer; 348 const union acpi_object *properties; 349 const union acpi_object *of_compatible; 350 struct list_head subnodes; 351 }; 352 353 struct acpi_gpio_mapping; 354 355 /* Device */ 356 struct acpi_device { 357 int device_type; 358 acpi_handle handle; /* no handle for fixed hardware */ 359 struct fwnode_handle fwnode; 360 struct acpi_device *parent; 361 struct list_head children; 362 struct list_head node; 363 struct list_head wakeup_list; 364 struct list_head del_list; 365 struct acpi_device_status status; 366 struct acpi_device_flags flags; 367 struct acpi_device_pnp pnp; 368 struct acpi_device_power power; 369 struct acpi_device_wakeup wakeup; 370 struct acpi_device_perf performance; 371 struct acpi_device_dir dir; 372 struct acpi_device_data data; 373 struct acpi_scan_handler *handler; 374 struct acpi_hotplug_context *hp; 375 struct acpi_driver *driver; 376 const struct acpi_gpio_mapping *driver_gpios; 377 void *driver_data; 378 struct device dev; 379 unsigned int physical_node_count; 380 unsigned int dep_unmet; 381 struct list_head physical_node_list; 382 struct mutex physical_node_lock; 383 void (*remove)(struct acpi_device *); 384 }; 385 386 /* Non-device subnode */ 387 struct acpi_data_node { 388 const char *name; 389 acpi_handle handle; 390 struct fwnode_handle fwnode; 391 struct fwnode_handle *parent; 392 struct acpi_device_data data; 393 struct list_head sibling; 394 struct kobject kobj; 395 struct completion kobj_done; 396 }; 397 398 static inline bool is_acpi_node(struct fwnode_handle *fwnode) 399 { 400 return !IS_ERR_OR_NULL(fwnode) && (fwnode->type == FWNODE_ACPI 401 || fwnode->type == FWNODE_ACPI_DATA); 402 } 403 404 static inline bool is_acpi_device_node(struct fwnode_handle *fwnode) 405 { 406 return !IS_ERR_OR_NULL(fwnode) && fwnode->type == FWNODE_ACPI; 407 } 408 409 static inline struct acpi_device *to_acpi_device_node(struct fwnode_handle *fwnode) 410 { 411 return is_acpi_device_node(fwnode) ? 412 container_of(fwnode, struct acpi_device, fwnode) : NULL; 413 } 414 415 static inline bool is_acpi_data_node(struct fwnode_handle *fwnode) 416 { 417 return fwnode && fwnode->type == FWNODE_ACPI_DATA; 418 } 419 420 static inline struct acpi_data_node *to_acpi_data_node(struct fwnode_handle *fwnode) 421 { 422 return is_acpi_data_node(fwnode) ? 423 container_of(fwnode, struct acpi_data_node, fwnode) : NULL; 424 } 425 426 static inline bool acpi_data_node_match(struct fwnode_handle *fwnode, 427 const char *name) 428 { 429 return is_acpi_data_node(fwnode) ? 430 (!strcmp(to_acpi_data_node(fwnode)->name, name)) : false; 431 } 432 433 static inline struct fwnode_handle *acpi_fwnode_handle(struct acpi_device *adev) 434 { 435 return &adev->fwnode; 436 } 437 438 static inline void *acpi_driver_data(struct acpi_device *d) 439 { 440 return d->driver_data; 441 } 442 443 #define to_acpi_device(d) container_of(d, struct acpi_device, dev) 444 #define to_acpi_driver(d) container_of(d, struct acpi_driver, drv) 445 446 static inline void acpi_set_device_status(struct acpi_device *adev, u32 sta) 447 { 448 *((u32 *)&adev->status) = sta; 449 } 450 451 static inline void acpi_set_hp_context(struct acpi_device *adev, 452 struct acpi_hotplug_context *hp) 453 { 454 hp->self = adev; 455 adev->hp = hp; 456 } 457 458 void acpi_initialize_hp_context(struct acpi_device *adev, 459 struct acpi_hotplug_context *hp, 460 int (*notify)(struct acpi_device *, u32), 461 void (*uevent)(struct acpi_device *, u32)); 462 463 /* acpi_device.dev.bus == &acpi_bus_type */ 464 extern struct bus_type acpi_bus_type; 465 466 /* 467 * Events 468 * ------ 469 */ 470 471 struct acpi_bus_event { 472 struct list_head node; 473 acpi_device_class device_class; 474 acpi_bus_id bus_id; 475 u32 type; 476 u32 data; 477 }; 478 479 extern struct kobject *acpi_kobj; 480 extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int); 481 void acpi_bus_private_data_handler(acpi_handle, void *); 482 int acpi_bus_get_private_data(acpi_handle, void **); 483 int acpi_bus_attach_private_data(acpi_handle, void *); 484 void acpi_bus_detach_private_data(acpi_handle); 485 extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32); 486 extern int register_acpi_notifier(struct notifier_block *); 487 extern int unregister_acpi_notifier(struct notifier_block *); 488 489 /* 490 * External Functions 491 */ 492 493 int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device); 494 struct acpi_device *acpi_bus_get_acpi_device(acpi_handle handle); 495 void acpi_bus_put_acpi_device(struct acpi_device *adev); 496 acpi_status acpi_bus_get_status_handle(acpi_handle handle, 497 unsigned long long *sta); 498 int acpi_bus_get_status(struct acpi_device *device); 499 500 int acpi_bus_set_power(acpi_handle handle, int state); 501 const char *acpi_power_state_string(int state); 502 int acpi_device_get_power(struct acpi_device *device, int *state); 503 int acpi_device_set_power(struct acpi_device *device, int state); 504 int acpi_bus_init_power(struct acpi_device *device); 505 int acpi_device_fix_up_power(struct acpi_device *device); 506 int acpi_bus_update_power(acpi_handle handle, int *state_p); 507 int acpi_device_update_power(struct acpi_device *device, int *state_p); 508 bool acpi_bus_power_manageable(acpi_handle handle); 509 510 #ifdef CONFIG_PM 511 bool acpi_bus_can_wakeup(acpi_handle handle); 512 #else 513 static inline bool acpi_bus_can_wakeup(acpi_handle handle) { return false; } 514 #endif 515 516 void acpi_scan_lock_acquire(void); 517 void acpi_scan_lock_release(void); 518 void acpi_lock_hp_context(void); 519 void acpi_unlock_hp_context(void); 520 int acpi_scan_add_handler(struct acpi_scan_handler *handler); 521 int acpi_bus_register_driver(struct acpi_driver *driver); 522 void acpi_bus_unregister_driver(struct acpi_driver *driver); 523 int acpi_bus_scan(acpi_handle handle); 524 void acpi_bus_trim(struct acpi_device *start); 525 acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd); 526 int acpi_match_device_ids(struct acpi_device *device, 527 const struct acpi_device_id *ids); 528 void acpi_set_modalias(struct acpi_device *adev, const char *default_id, 529 char *modalias, size_t len); 530 int acpi_create_dir(struct acpi_device *); 531 void acpi_remove_dir(struct acpi_device *); 532 533 static inline bool acpi_device_enumerated(struct acpi_device *adev) 534 { 535 return adev && adev->flags.initialized && adev->flags.visited; 536 } 537 538 /** 539 * module_acpi_driver(acpi_driver) - Helper macro for registering an ACPI driver 540 * @__acpi_driver: acpi_driver struct 541 * 542 * Helper macro for ACPI drivers which do not do anything special in module 543 * init/exit. This eliminates a lot of boilerplate. Each module may only 544 * use this macro once, and calling it replaces module_init() and module_exit() 545 */ 546 #define module_acpi_driver(__acpi_driver) \ 547 module_driver(__acpi_driver, acpi_bus_register_driver, \ 548 acpi_bus_unregister_driver) 549 550 /* 551 * Bind physical devices with ACPI devices 552 */ 553 struct acpi_bus_type { 554 struct list_head list; 555 const char *name; 556 bool (*match)(struct device *dev); 557 struct acpi_device * (*find_companion)(struct device *); 558 void (*setup)(struct device *); 559 void (*cleanup)(struct device *); 560 }; 561 int register_acpi_bus_type(struct acpi_bus_type *); 562 int unregister_acpi_bus_type(struct acpi_bus_type *); 563 int acpi_bind_one(struct device *dev, struct acpi_device *adev); 564 int acpi_unbind_one(struct device *dev); 565 566 struct acpi_pci_root { 567 struct acpi_device * device; 568 struct pci_bus *bus; 569 u16 segment; 570 struct resource secondary; /* downstream bus range */ 571 572 u32 osc_support_set; /* _OSC state of support bits */ 573 u32 osc_control_set; /* _OSC state of control bits */ 574 phys_addr_t mcfg_addr; 575 }; 576 577 /* helper */ 578 579 bool acpi_dma_supported(struct acpi_device *adev); 580 enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev); 581 int acpi_dma_configure(struct device *dev, enum dev_dma_attr attr); 582 void acpi_dma_deconfigure(struct device *dev); 583 584 struct acpi_device *acpi_find_child_device(struct acpi_device *parent, 585 u64 address, bool check_children); 586 int acpi_is_root_bridge(acpi_handle); 587 struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle); 588 589 int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state); 590 int acpi_disable_wakeup_device_power(struct acpi_device *dev); 591 592 #ifdef CONFIG_X86 593 bool acpi_device_always_present(struct acpi_device *adev); 594 #else 595 static inline bool acpi_device_always_present(struct acpi_device *adev) 596 { 597 return false; 598 } 599 #endif 600 601 #ifdef CONFIG_PM 602 acpi_status acpi_add_pm_notifier(struct acpi_device *adev, struct device *dev, 603 void (*work_func)(struct work_struct *work)); 604 acpi_status acpi_remove_pm_notifier(struct acpi_device *adev); 605 int acpi_pm_device_sleep_state(struct device *, int *, int); 606 int acpi_pm_device_run_wake(struct device *, bool); 607 #else 608 static inline acpi_status acpi_add_pm_notifier(struct acpi_device *adev, 609 struct device *dev, 610 void (*work_func)(struct work_struct *work)) 611 { 612 return AE_SUPPORT; 613 } 614 static inline acpi_status acpi_remove_pm_notifier(struct acpi_device *adev) 615 { 616 return AE_SUPPORT; 617 } 618 static inline int acpi_pm_device_sleep_state(struct device *d, int *p, int m) 619 { 620 if (p) 621 *p = ACPI_STATE_D0; 622 623 return (m >= ACPI_STATE_D0 && m <= ACPI_STATE_D3_COLD) ? 624 m : ACPI_STATE_D0; 625 } 626 static inline int acpi_pm_device_run_wake(struct device *dev, bool enable) 627 { 628 return -ENODEV; 629 } 630 #endif 631 632 #ifdef CONFIG_PM_SLEEP 633 int acpi_pm_device_sleep_wake(struct device *, bool); 634 #else 635 static inline int acpi_pm_device_sleep_wake(struct device *dev, bool enable) 636 { 637 return -ENODEV; 638 } 639 #endif 640 641 #ifdef CONFIG_ACPI_SLEEP 642 u32 acpi_target_system_state(void); 643 #else 644 static inline u32 acpi_target_system_state(void) { return ACPI_STATE_S0; } 645 #endif 646 647 static inline bool acpi_device_power_manageable(struct acpi_device *adev) 648 { 649 return adev->flags.power_manageable; 650 } 651 652 static inline bool acpi_device_can_wakeup(struct acpi_device *adev) 653 { 654 return adev->wakeup.flags.valid; 655 } 656 657 static inline bool acpi_device_can_poweroff(struct acpi_device *adev) 658 { 659 return adev->power.states[ACPI_STATE_D3_COLD].flags.valid || 660 ((acpi_gbl_FADT.header.revision < 6) && 661 adev->power.states[ACPI_STATE_D3_HOT].flags.explicit_set); 662 } 663 664 #else /* CONFIG_ACPI */ 665 666 static inline int register_acpi_bus_type(void *bus) { return 0; } 667 static inline int unregister_acpi_bus_type(void *bus) { return 0; } 668 669 #endif /* CONFIG_ACPI */ 670 671 #endif /*__ACPI_BUS_H__*/ 672