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, int rev, u64 funcs); 65 union acpi_object *acpi_evaluate_dsm(acpi_handle handle, const u8 *uuid, 66 int rev, int func, union acpi_object *argv4); 67 68 static inline union acpi_object * 69 acpi_evaluate_dsm_typed(acpi_handle handle, const u8 *uuid, int rev, int 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 #ifdef CONFIG_ACPI 91 92 #include <linux/proc_fs.h> 93 94 #define ACPI_BUS_FILE_ROOT "acpi" 95 extern struct proc_dir_entry *acpi_root_dir; 96 97 enum acpi_bus_device_type { 98 ACPI_BUS_TYPE_DEVICE = 0, 99 ACPI_BUS_TYPE_POWER, 100 ACPI_BUS_TYPE_PROCESSOR, 101 ACPI_BUS_TYPE_THERMAL, 102 ACPI_BUS_TYPE_POWER_BUTTON, 103 ACPI_BUS_TYPE_SLEEP_BUTTON, 104 ACPI_BUS_DEVICE_TYPE_COUNT 105 }; 106 107 struct acpi_driver; 108 struct acpi_device; 109 110 /* 111 * ACPI Scan Handler 112 * ----------------- 113 */ 114 115 struct acpi_hotplug_profile { 116 struct kobject kobj; 117 int (*scan_dependent)(struct acpi_device *adev); 118 void (*notify_online)(struct acpi_device *adev); 119 bool enabled:1; 120 bool demand_offline:1; 121 }; 122 123 static inline struct acpi_hotplug_profile *to_acpi_hotplug_profile( 124 struct kobject *kobj) 125 { 126 return container_of(kobj, struct acpi_hotplug_profile, kobj); 127 } 128 129 struct acpi_scan_handler { 130 const struct acpi_device_id *ids; 131 struct list_head list_node; 132 bool (*match)(char *idstr, const struct acpi_device_id **matchid); 133 int (*attach)(struct acpi_device *dev, const struct acpi_device_id *id); 134 void (*detach)(struct acpi_device *dev); 135 void (*bind)(struct device *phys_dev); 136 void (*unbind)(struct device *phys_dev); 137 struct acpi_hotplug_profile hotplug; 138 }; 139 140 /* 141 * ACPI Hotplug Context 142 * -------------------- 143 */ 144 145 struct acpi_hotplug_context { 146 struct acpi_device *self; 147 int (*notify)(struct acpi_device *, u32); 148 void (*uevent)(struct acpi_device *, u32); 149 void (*fixup)(struct acpi_device *); 150 }; 151 152 /* 153 * ACPI Driver 154 * ----------- 155 */ 156 157 typedef int (*acpi_op_add) (struct acpi_device * device); 158 typedef int (*acpi_op_remove) (struct acpi_device * device); 159 typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event); 160 161 struct acpi_device_ops { 162 acpi_op_add add; 163 acpi_op_remove remove; 164 acpi_op_notify notify; 165 }; 166 167 #define ACPI_DRIVER_ALL_NOTIFY_EVENTS 0x1 /* system AND device events */ 168 169 struct acpi_driver { 170 char name[80]; 171 char class[80]; 172 const struct acpi_device_id *ids; /* Supported Hardware IDs */ 173 unsigned int flags; 174 struct acpi_device_ops ops; 175 struct device_driver drv; 176 struct module *owner; 177 }; 178 179 /* 180 * ACPI Device 181 * ----------- 182 */ 183 184 /* Status (_STA) */ 185 186 struct acpi_device_status { 187 u32 present:1; 188 u32 enabled:1; 189 u32 show_in_ui:1; 190 u32 functional:1; 191 u32 battery_present:1; 192 u32 reserved:27; 193 }; 194 195 /* Flags */ 196 197 struct acpi_device_flags { 198 u32 dynamic_status:1; 199 u32 removable:1; 200 u32 ejectable:1; 201 u32 power_manageable:1; 202 u32 match_driver:1; 203 u32 initialized:1; 204 u32 visited:1; 205 u32 hotplug_notify:1; 206 u32 is_dock_station:1; 207 u32 of_compatible_ok:1; 208 u32 coherent_dma:1; 209 u32 cca_seen:1; 210 u32 reserved:20; 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 }; 250 251 #define acpi_device_bid(d) ((d)->pnp.bus_id) 252 #define acpi_device_adr(d) ((d)->pnp.bus_address) 253 const char *acpi_device_hid(struct acpi_device *device); 254 #define acpi_device_uid(d) ((d)->pnp.unique_id) 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 explicit_set:1; /* _PSx present? */ 274 u8 reserved:6; 275 } flags; 276 int power; /* % Power (compared to D0) */ 277 int latency; /* Dx->D0 time (microseconds) */ 278 struct list_head resources; /* Power resources referenced */ 279 }; 280 281 struct acpi_device_power { 282 int state; /* Current state */ 283 struct acpi_device_power_flags flags; 284 struct acpi_device_power_state states[ACPI_D_STATE_COUNT]; /* Power states (D0-D3Cold) */ 285 }; 286 287 /* Performance Management */ 288 289 struct acpi_device_perf_flags { 290 u8 reserved:8; 291 }; 292 293 struct acpi_device_perf_state { 294 struct { 295 u8 valid:1; 296 u8 reserved:7; 297 } flags; 298 u8 power; /* % Power (compared to P0) */ 299 u8 performance; /* % Performance ( " ) */ 300 int latency; /* Px->P0 time (microseconds) */ 301 }; 302 303 struct acpi_device_perf { 304 int state; 305 struct acpi_device_perf_flags flags; 306 int state_count; 307 struct acpi_device_perf_state *states; 308 }; 309 310 /* Wakeup Management */ 311 struct acpi_device_wakeup_flags { 312 u8 valid:1; /* Can successfully enable wakeup? */ 313 u8 run_wake:1; /* Run-Wake GPE devices */ 314 u8 notifier_present:1; /* Wake-up notify handler has been installed */ 315 u8 enabled:1; /* Enabled for wakeup */ 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 /* ACPI Device Specific Data (_DSD) */ 342 struct acpi_device_data { 343 const union acpi_object *pointer; 344 const union acpi_object *properties; 345 const union acpi_object *of_compatible; 346 }; 347 348 struct acpi_gpio_mapping; 349 350 /* Device */ 351 struct acpi_device { 352 int device_type; 353 acpi_handle handle; /* no handle for fixed hardware */ 354 struct fwnode_handle fwnode; 355 struct acpi_device *parent; 356 struct list_head children; 357 struct list_head node; 358 struct list_head wakeup_list; 359 struct list_head del_list; 360 struct acpi_device_status status; 361 struct acpi_device_flags flags; 362 struct acpi_device_pnp pnp; 363 struct acpi_device_power power; 364 struct acpi_device_wakeup wakeup; 365 struct acpi_device_perf performance; 366 struct acpi_device_dir dir; 367 struct acpi_device_data data; 368 struct acpi_scan_handler *handler; 369 struct acpi_hotplug_context *hp; 370 struct acpi_driver *driver; 371 const struct acpi_gpio_mapping *driver_gpios; 372 void *driver_data; 373 struct device dev; 374 unsigned int physical_node_count; 375 unsigned int dep_unmet; 376 struct list_head physical_node_list; 377 struct mutex physical_node_lock; 378 void (*remove)(struct acpi_device *); 379 }; 380 381 static inline bool acpi_check_dma(struct acpi_device *adev, bool *coherent) 382 { 383 bool ret = false; 384 385 if (!adev) 386 return ret; 387 388 /** 389 * Currently, we only support _CCA=1 (i.e. coherent_dma=1) 390 * This should be equivalent to specifyig dma-coherent for 391 * a device in OF. 392 * 393 * For the case when _CCA=0 (i.e. coherent_dma=0 && cca_seen=1), 394 * There are two cases: 395 * case 1. Do not support and disable DMA. 396 * case 2. Support but rely on arch-specific cache maintenance for 397 * non-coherence DMA operations. 398 * Currently, we implement case 1 above. 399 * 400 * For the case when _CCA is missing (i.e. cca_seen=0) and 401 * platform specifies ACPI_CCA_REQUIRED, we do not support DMA, 402 * and fallback to arch-specific default handling. 403 * 404 * See acpi_init_coherency() for more info. 405 */ 406 if (adev->flags.coherent_dma) { 407 ret = true; 408 if (coherent) 409 *coherent = adev->flags.coherent_dma; 410 } 411 return ret; 412 } 413 414 static inline bool is_acpi_node(struct fwnode_handle *fwnode) 415 { 416 return fwnode && fwnode->type == FWNODE_ACPI; 417 } 418 419 static inline struct acpi_device *to_acpi_node(struct fwnode_handle *fwnode) 420 { 421 return is_acpi_node(fwnode) ? 422 container_of(fwnode, struct acpi_device, fwnode) : NULL; 423 } 424 425 static inline struct fwnode_handle *acpi_fwnode_handle(struct acpi_device *adev) 426 { 427 return &adev->fwnode; 428 } 429 430 static inline void *acpi_driver_data(struct acpi_device *d) 431 { 432 return d->driver_data; 433 } 434 435 #define to_acpi_device(d) container_of(d, struct acpi_device, dev) 436 #define to_acpi_driver(d) container_of(d, struct acpi_driver, drv) 437 438 static inline void acpi_set_device_status(struct acpi_device *adev, u32 sta) 439 { 440 *((u32 *)&adev->status) = sta; 441 } 442 443 static inline void acpi_set_hp_context(struct acpi_device *adev, 444 struct acpi_hotplug_context *hp) 445 { 446 hp->self = adev; 447 adev->hp = hp; 448 } 449 450 void acpi_initialize_hp_context(struct acpi_device *adev, 451 struct acpi_hotplug_context *hp, 452 int (*notify)(struct acpi_device *, u32), 453 void (*uevent)(struct acpi_device *, u32)); 454 455 /* acpi_device.dev.bus == &acpi_bus_type */ 456 extern struct bus_type acpi_bus_type; 457 458 /* 459 * Events 460 * ------ 461 */ 462 463 struct acpi_bus_event { 464 struct list_head node; 465 acpi_device_class device_class; 466 acpi_bus_id bus_id; 467 u32 type; 468 u32 data; 469 }; 470 471 extern struct kobject *acpi_kobj; 472 extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int); 473 void acpi_bus_private_data_handler(acpi_handle, void *); 474 int acpi_bus_get_private_data(acpi_handle, void **); 475 int acpi_bus_attach_private_data(acpi_handle, void *); 476 void acpi_bus_detach_private_data(acpi_handle); 477 extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32); 478 extern int register_acpi_notifier(struct notifier_block *); 479 extern int unregister_acpi_notifier(struct notifier_block *); 480 481 /* 482 * External Functions 483 */ 484 485 int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device); 486 struct acpi_device *acpi_bus_get_acpi_device(acpi_handle handle); 487 void acpi_bus_put_acpi_device(struct acpi_device *adev); 488 acpi_status acpi_bus_get_status_handle(acpi_handle handle, 489 unsigned long long *sta); 490 int acpi_bus_get_status(struct acpi_device *device); 491 492 int acpi_bus_set_power(acpi_handle handle, int state); 493 const char *acpi_power_state_string(int state); 494 int acpi_device_get_power(struct acpi_device *device, int *state); 495 int acpi_device_set_power(struct acpi_device *device, int state); 496 int acpi_bus_init_power(struct acpi_device *device); 497 int acpi_device_fix_up_power(struct acpi_device *device); 498 int acpi_bus_update_power(acpi_handle handle, int *state_p); 499 int acpi_device_update_power(struct acpi_device *device, int *state_p); 500 bool acpi_bus_power_manageable(acpi_handle handle); 501 502 #ifdef CONFIG_PM 503 bool acpi_bus_can_wakeup(acpi_handle handle); 504 #else 505 static inline bool acpi_bus_can_wakeup(acpi_handle handle) { return false; } 506 #endif 507 508 void acpi_scan_lock_acquire(void); 509 void acpi_scan_lock_release(void); 510 void acpi_lock_hp_context(void); 511 void acpi_unlock_hp_context(void); 512 int acpi_scan_add_handler(struct acpi_scan_handler *handler); 513 int acpi_bus_register_driver(struct acpi_driver *driver); 514 void acpi_bus_unregister_driver(struct acpi_driver *driver); 515 int acpi_bus_scan(acpi_handle handle); 516 void acpi_bus_trim(struct acpi_device *start); 517 acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd); 518 int acpi_match_device_ids(struct acpi_device *device, 519 const struct acpi_device_id *ids); 520 int acpi_create_dir(struct acpi_device *); 521 void acpi_remove_dir(struct acpi_device *); 522 523 static inline bool acpi_device_enumerated(struct acpi_device *adev) 524 { 525 return adev && adev->flags.initialized && adev->flags.visited; 526 } 527 528 /** 529 * module_acpi_driver(acpi_driver) - Helper macro for registering an ACPI driver 530 * @__acpi_driver: acpi_driver struct 531 * 532 * Helper macro for ACPI drivers which do not do anything special in module 533 * init/exit. This eliminates a lot of boilerplate. Each module may only 534 * use this macro once, and calling it replaces module_init() and module_exit() 535 */ 536 #define module_acpi_driver(__acpi_driver) \ 537 module_driver(__acpi_driver, acpi_bus_register_driver, \ 538 acpi_bus_unregister_driver) 539 540 /* 541 * Bind physical devices with ACPI devices 542 */ 543 struct acpi_bus_type { 544 struct list_head list; 545 const char *name; 546 bool (*match)(struct device *dev); 547 struct acpi_device * (*find_companion)(struct device *); 548 void (*setup)(struct device *); 549 void (*cleanup)(struct device *); 550 }; 551 int register_acpi_bus_type(struct acpi_bus_type *); 552 int unregister_acpi_bus_type(struct acpi_bus_type *); 553 int acpi_bind_one(struct device *dev, struct acpi_device *adev); 554 int acpi_unbind_one(struct device *dev); 555 556 struct acpi_pci_root { 557 struct acpi_device * device; 558 struct pci_bus *bus; 559 u16 segment; 560 struct resource secondary; /* downstream bus range */ 561 562 u32 osc_support_set; /* _OSC state of support bits */ 563 u32 osc_control_set; /* _OSC state of control bits */ 564 phys_addr_t mcfg_addr; 565 }; 566 567 /* helper */ 568 569 struct acpi_device *acpi_find_child_device(struct acpi_device *parent, 570 u64 address, bool check_children); 571 int acpi_is_root_bridge(acpi_handle); 572 struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle); 573 574 int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state); 575 int acpi_disable_wakeup_device_power(struct acpi_device *dev); 576 577 #ifdef CONFIG_PM 578 acpi_status acpi_add_pm_notifier(struct acpi_device *adev, struct device *dev, 579 void (*work_func)(struct work_struct *work)); 580 acpi_status acpi_remove_pm_notifier(struct acpi_device *adev); 581 int acpi_pm_device_sleep_state(struct device *, int *, int); 582 int acpi_pm_device_run_wake(struct device *, bool); 583 #else 584 static inline acpi_status acpi_add_pm_notifier(struct acpi_device *adev, 585 struct device *dev, 586 void (*work_func)(struct work_struct *work)) 587 { 588 return AE_SUPPORT; 589 } 590 static inline acpi_status acpi_remove_pm_notifier(struct acpi_device *adev) 591 { 592 return AE_SUPPORT; 593 } 594 static inline int acpi_pm_device_sleep_state(struct device *d, int *p, int m) 595 { 596 if (p) 597 *p = ACPI_STATE_D0; 598 599 return (m >= ACPI_STATE_D0 && m <= ACPI_STATE_D3_COLD) ? 600 m : ACPI_STATE_D0; 601 } 602 static inline int acpi_pm_device_run_wake(struct device *dev, bool enable) 603 { 604 return -ENODEV; 605 } 606 #endif 607 608 #ifdef CONFIG_PM_SLEEP 609 int acpi_pm_device_sleep_wake(struct device *, bool); 610 #else 611 static inline int acpi_pm_device_sleep_wake(struct device *dev, bool enable) 612 { 613 return -ENODEV; 614 } 615 #endif 616 617 #ifdef CONFIG_ACPI_SLEEP 618 u32 acpi_target_system_state(void); 619 #else 620 static inline u32 acpi_target_system_state(void) { return ACPI_STATE_S0; } 621 #endif 622 623 static inline bool acpi_device_power_manageable(struct acpi_device *adev) 624 { 625 return adev->flags.power_manageable; 626 } 627 628 static inline bool acpi_device_can_wakeup(struct acpi_device *adev) 629 { 630 return adev->wakeup.flags.valid; 631 } 632 633 static inline bool acpi_device_can_poweroff(struct acpi_device *adev) 634 { 635 return adev->power.states[ACPI_STATE_D3_COLD].flags.valid; 636 } 637 638 #else /* CONFIG_ACPI */ 639 640 static inline int register_acpi_bus_type(void *bus) { return 0; } 641 static inline int unregister_acpi_bus_type(void *bus) { return 0; } 642 643 #endif /* CONFIG_ACPI */ 644 645 #endif /*__ACPI_BUS_H__*/ 646