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 #include <linux/property.h> 31 32 /* TBD: Make dynamic */ 33 #define ACPI_MAX_HANDLES 10 34 struct acpi_handle_list { 35 u32 count; 36 acpi_handle handles[ACPI_MAX_HANDLES]; 37 }; 38 39 /* acpi_utils.h */ 40 acpi_status 41 acpi_extract_package(union acpi_object *package, 42 struct acpi_buffer *format, struct acpi_buffer *buffer); 43 acpi_status 44 acpi_evaluate_integer(acpi_handle handle, 45 acpi_string pathname, 46 struct acpi_object_list *arguments, unsigned long long *data); 47 acpi_status 48 acpi_evaluate_reference(acpi_handle handle, 49 acpi_string pathname, 50 struct acpi_object_list *arguments, 51 struct acpi_handle_list *list); 52 acpi_status 53 acpi_evaluate_ost(acpi_handle handle, u32 source_event, u32 status_code, 54 struct acpi_buffer *status_buf); 55 56 acpi_status 57 acpi_get_physical_device_location(acpi_handle handle, struct acpi_pld_info **pld); 58 59 bool acpi_has_method(acpi_handle handle, char *name); 60 acpi_status acpi_execute_simple_method(acpi_handle handle, char *method, 61 u64 arg); 62 acpi_status acpi_evaluate_ej0(acpi_handle handle); 63 acpi_status acpi_evaluate_lck(acpi_handle handle, int lock); 64 bool acpi_ata_match(acpi_handle handle); 65 bool acpi_bay_match(acpi_handle handle); 66 bool acpi_dock_match(acpi_handle handle); 67 68 bool acpi_check_dsm(acpi_handle handle, const u8 *uuid, int rev, u64 funcs); 69 union acpi_object *acpi_evaluate_dsm(acpi_handle handle, const u8 *uuid, 70 int rev, int func, union acpi_object *argv4); 71 72 static inline union acpi_object * 73 acpi_evaluate_dsm_typed(acpi_handle handle, const u8 *uuid, int rev, int func, 74 union acpi_object *argv4, acpi_object_type type) 75 { 76 union acpi_object *obj; 77 78 obj = acpi_evaluate_dsm(handle, uuid, rev, func, argv4); 79 if (obj && obj->type != type) { 80 ACPI_FREE(obj); 81 obj = NULL; 82 } 83 84 return obj; 85 } 86 87 #define ACPI_INIT_DSM_ARGV4(cnt, eles) \ 88 { \ 89 .package.type = ACPI_TYPE_PACKAGE, \ 90 .package.count = (cnt), \ 91 .package.elements = (eles) \ 92 } 93 94 #ifdef CONFIG_ACPI 95 96 #include <linux/proc_fs.h> 97 98 #define ACPI_BUS_FILE_ROOT "acpi" 99 extern struct proc_dir_entry *acpi_root_dir; 100 101 enum acpi_bus_device_type { 102 ACPI_BUS_TYPE_DEVICE = 0, 103 ACPI_BUS_TYPE_POWER, 104 ACPI_BUS_TYPE_PROCESSOR, 105 ACPI_BUS_TYPE_THERMAL, 106 ACPI_BUS_TYPE_POWER_BUTTON, 107 ACPI_BUS_TYPE_SLEEP_BUTTON, 108 ACPI_BUS_DEVICE_TYPE_COUNT 109 }; 110 111 struct acpi_driver; 112 struct acpi_device; 113 114 /* 115 * ACPI Scan Handler 116 * ----------------- 117 */ 118 119 struct acpi_hotplug_profile { 120 struct kobject kobj; 121 int (*scan_dependent)(struct acpi_device *adev); 122 void (*notify_online)(struct acpi_device *adev); 123 bool enabled:1; 124 bool demand_offline:1; 125 }; 126 127 static inline struct acpi_hotplug_profile *to_acpi_hotplug_profile( 128 struct kobject *kobj) 129 { 130 return container_of(kobj, struct acpi_hotplug_profile, kobj); 131 } 132 133 struct acpi_scan_handler { 134 const struct acpi_device_id *ids; 135 struct list_head list_node; 136 bool (*match)(char *idstr, const struct acpi_device_id **matchid); 137 int (*attach)(struct acpi_device *dev, const struct acpi_device_id *id); 138 void (*detach)(struct acpi_device *dev); 139 void (*bind)(struct device *phys_dev); 140 void (*unbind)(struct device *phys_dev); 141 struct acpi_hotplug_profile hotplug; 142 }; 143 144 /* 145 * ACPI Hotplug Context 146 * -------------------- 147 */ 148 149 struct acpi_hotplug_context { 150 struct acpi_device *self; 151 int (*notify)(struct acpi_device *, u32); 152 void (*uevent)(struct acpi_device *, u32); 153 void (*fixup)(struct acpi_device *); 154 }; 155 156 /* 157 * ACPI Driver 158 * ----------- 159 */ 160 161 typedef int (*acpi_op_add) (struct acpi_device * device); 162 typedef int (*acpi_op_remove) (struct acpi_device * device); 163 typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event); 164 165 struct acpi_device_ops { 166 acpi_op_add add; 167 acpi_op_remove remove; 168 acpi_op_notify notify; 169 }; 170 171 #define ACPI_DRIVER_ALL_NOTIFY_EVENTS 0x1 /* system AND device events */ 172 173 struct acpi_driver { 174 char name[80]; 175 char class[80]; 176 const struct acpi_device_id *ids; /* Supported Hardware IDs */ 177 unsigned int flags; 178 struct acpi_device_ops ops; 179 struct device_driver drv; 180 struct module *owner; 181 }; 182 183 /* 184 * ACPI Device 185 * ----------- 186 */ 187 188 /* Status (_STA) */ 189 190 struct acpi_device_status { 191 u32 present:1; 192 u32 enabled:1; 193 u32 show_in_ui:1; 194 u32 functional:1; 195 u32 battery_present:1; 196 u32 reserved:27; 197 }; 198 199 /* Flags */ 200 201 struct acpi_device_flags { 202 u32 dynamic_status:1; 203 u32 removable:1; 204 u32 ejectable:1; 205 u32 power_manageable:1; 206 u32 match_driver:1; 207 u32 initialized:1; 208 u32 visited:1; 209 u32 hotplug_notify:1; 210 u32 is_dock_station:1; 211 u32 reserved:23; 212 }; 213 214 /* File System */ 215 216 struct acpi_device_dir { 217 struct proc_dir_entry *entry; 218 }; 219 220 #define acpi_device_dir(d) ((d)->dir.entry) 221 222 /* Plug and Play */ 223 224 typedef char acpi_bus_id[8]; 225 typedef unsigned long acpi_bus_address; 226 typedef char acpi_device_name[40]; 227 typedef char acpi_device_class[20]; 228 229 struct acpi_hardware_id { 230 struct list_head list; 231 char *id; 232 }; 233 234 struct acpi_pnp_type { 235 u32 hardware_id:1; 236 u32 bus_address:1; 237 u32 platform_id:1; 238 u32 reserved:29; 239 }; 240 241 struct acpi_device_pnp { 242 acpi_bus_id bus_id; /* Object name */ 243 struct acpi_pnp_type type; /* ID type */ 244 acpi_bus_address bus_address; /* _ADR */ 245 char *unique_id; /* _UID */ 246 struct list_head ids; /* _HID and _CIDs */ 247 acpi_device_name device_name; /* Driver-determined */ 248 acpi_device_class device_class; /* " */ 249 union acpi_object *str_obj; /* unicode string for _STR method */ 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 /* 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 is_acpi_node(struct fwnode_handle *fwnode) 382 { 383 return fwnode && fwnode->type == FWNODE_ACPI; 384 } 385 386 static inline struct acpi_device *acpi_node(struct fwnode_handle *fwnode) 387 { 388 return fwnode ? container_of(fwnode, struct acpi_device, fwnode) : NULL; 389 } 390 391 static inline struct fwnode_handle *acpi_fwnode_handle(struct acpi_device *adev) 392 { 393 return &adev->fwnode; 394 } 395 396 static inline void *acpi_driver_data(struct acpi_device *d) 397 { 398 return d->driver_data; 399 } 400 401 #define to_acpi_device(d) container_of(d, struct acpi_device, dev) 402 #define to_acpi_driver(d) container_of(d, struct acpi_driver, drv) 403 404 static inline void acpi_set_device_status(struct acpi_device *adev, u32 sta) 405 { 406 *((u32 *)&adev->status) = sta; 407 } 408 409 static inline void acpi_set_hp_context(struct acpi_device *adev, 410 struct acpi_hotplug_context *hp) 411 { 412 hp->self = adev; 413 adev->hp = hp; 414 } 415 416 void acpi_initialize_hp_context(struct acpi_device *adev, 417 struct acpi_hotplug_context *hp, 418 int (*notify)(struct acpi_device *, u32), 419 void (*uevent)(struct acpi_device *, u32)); 420 421 /* acpi_device.dev.bus == &acpi_bus_type */ 422 extern struct bus_type acpi_bus_type; 423 424 /* 425 * Events 426 * ------ 427 */ 428 429 struct acpi_bus_event { 430 struct list_head node; 431 acpi_device_class device_class; 432 acpi_bus_id bus_id; 433 u32 type; 434 u32 data; 435 }; 436 437 extern struct kobject *acpi_kobj; 438 extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int); 439 void acpi_bus_private_data_handler(acpi_handle, void *); 440 int acpi_bus_get_private_data(acpi_handle, void **); 441 int acpi_bus_attach_private_data(acpi_handle, void *); 442 void acpi_bus_detach_private_data(acpi_handle); 443 extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32); 444 extern int register_acpi_notifier(struct notifier_block *); 445 extern int unregister_acpi_notifier(struct notifier_block *); 446 447 /* 448 * External Functions 449 */ 450 451 int acpi_bus_get_device(acpi_handle handle, struct acpi_device **device); 452 struct acpi_device *acpi_bus_get_acpi_device(acpi_handle handle); 453 void acpi_bus_put_acpi_device(struct acpi_device *adev); 454 acpi_status acpi_bus_get_status_handle(acpi_handle handle, 455 unsigned long long *sta); 456 int acpi_bus_get_status(struct acpi_device *device); 457 458 int acpi_bus_set_power(acpi_handle handle, int state); 459 const char *acpi_power_state_string(int state); 460 int acpi_device_get_power(struct acpi_device *device, int *state); 461 int acpi_device_set_power(struct acpi_device *device, int state); 462 int acpi_bus_init_power(struct acpi_device *device); 463 int acpi_device_fix_up_power(struct acpi_device *device); 464 int acpi_bus_update_power(acpi_handle handle, int *state_p); 465 int acpi_device_update_power(struct acpi_device *device, int *state_p); 466 bool acpi_bus_power_manageable(acpi_handle handle); 467 468 #ifdef CONFIG_PM 469 bool acpi_bus_can_wakeup(acpi_handle handle); 470 #else 471 static inline bool acpi_bus_can_wakeup(acpi_handle handle) { return false; } 472 #endif 473 474 void acpi_scan_lock_acquire(void); 475 void acpi_scan_lock_release(void); 476 void acpi_lock_hp_context(void); 477 void acpi_unlock_hp_context(void); 478 int acpi_scan_add_handler(struct acpi_scan_handler *handler); 479 int acpi_bus_register_driver(struct acpi_driver *driver); 480 void acpi_bus_unregister_driver(struct acpi_driver *driver); 481 int acpi_bus_scan(acpi_handle handle); 482 void acpi_bus_trim(struct acpi_device *start); 483 acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd); 484 int acpi_match_device_ids(struct acpi_device *device, 485 const struct acpi_device_id *ids); 486 int acpi_create_dir(struct acpi_device *); 487 void acpi_remove_dir(struct acpi_device *); 488 489 static inline bool acpi_device_enumerated(struct acpi_device *adev) 490 { 491 return adev && adev->flags.initialized && adev->flags.visited; 492 } 493 494 /** 495 * module_acpi_driver(acpi_driver) - Helper macro for registering an ACPI driver 496 * @__acpi_driver: acpi_driver struct 497 * 498 * Helper macro for ACPI drivers which do not do anything special in module 499 * init/exit. This eliminates a lot of boilerplate. Each module may only 500 * use this macro once, and calling it replaces module_init() and module_exit() 501 */ 502 #define module_acpi_driver(__acpi_driver) \ 503 module_driver(__acpi_driver, acpi_bus_register_driver, \ 504 acpi_bus_unregister_driver) 505 506 /* 507 * Bind physical devices with ACPI devices 508 */ 509 struct acpi_bus_type { 510 struct list_head list; 511 const char *name; 512 bool (*match)(struct device *dev); 513 struct acpi_device * (*find_companion)(struct device *); 514 void (*setup)(struct device *); 515 void (*cleanup)(struct device *); 516 }; 517 int register_acpi_bus_type(struct acpi_bus_type *); 518 int unregister_acpi_bus_type(struct acpi_bus_type *); 519 int acpi_bind_one(struct device *dev, struct acpi_device *adev); 520 int acpi_unbind_one(struct device *dev); 521 522 struct acpi_pci_root { 523 struct acpi_device * device; 524 struct pci_bus *bus; 525 u16 segment; 526 struct resource secondary; /* downstream bus range */ 527 528 u32 osc_support_set; /* _OSC state of support bits */ 529 u32 osc_control_set; /* _OSC state of control bits */ 530 phys_addr_t mcfg_addr; 531 }; 532 533 /* helper */ 534 535 struct acpi_device *acpi_find_child_device(struct acpi_device *parent, 536 u64 address, bool check_children); 537 int acpi_is_root_bridge(acpi_handle); 538 struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle); 539 540 int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state); 541 int acpi_disable_wakeup_device_power(struct acpi_device *dev); 542 543 #ifdef CONFIG_PM 544 acpi_status acpi_add_pm_notifier(struct acpi_device *adev, struct device *dev, 545 void (*work_func)(struct work_struct *work)); 546 acpi_status acpi_remove_pm_notifier(struct acpi_device *adev); 547 int acpi_pm_device_sleep_state(struct device *, int *, int); 548 int acpi_pm_device_run_wake(struct device *, bool); 549 #else 550 static inline acpi_status acpi_add_pm_notifier(struct acpi_device *adev, 551 struct device *dev, 552 void (*work_func)(struct work_struct *work)) 553 { 554 return AE_SUPPORT; 555 } 556 static inline acpi_status acpi_remove_pm_notifier(struct acpi_device *adev) 557 { 558 return AE_SUPPORT; 559 } 560 static inline int acpi_pm_device_sleep_state(struct device *d, int *p, int m) 561 { 562 if (p) 563 *p = ACPI_STATE_D0; 564 565 return (m >= ACPI_STATE_D0 && m <= ACPI_STATE_D3_COLD) ? 566 m : ACPI_STATE_D0; 567 } 568 static inline int acpi_pm_device_run_wake(struct device *dev, bool enable) 569 { 570 return -ENODEV; 571 } 572 #endif 573 574 #ifdef CONFIG_PM_SLEEP 575 int acpi_pm_device_sleep_wake(struct device *, bool); 576 #else 577 static inline int acpi_pm_device_sleep_wake(struct device *dev, bool enable) 578 { 579 return -ENODEV; 580 } 581 #endif 582 583 #ifdef CONFIG_ACPI_SLEEP 584 u32 acpi_target_system_state(void); 585 #else 586 static inline u32 acpi_target_system_state(void) { return ACPI_STATE_S0; } 587 #endif 588 589 static inline bool acpi_device_power_manageable(struct acpi_device *adev) 590 { 591 return adev->flags.power_manageable; 592 } 593 594 static inline bool acpi_device_can_wakeup(struct acpi_device *adev) 595 { 596 return adev->wakeup.flags.valid; 597 } 598 599 static inline bool acpi_device_can_poweroff(struct acpi_device *adev) 600 { 601 return adev->power.states[ACPI_STATE_D3_COLD].flags.os_accessible; 602 } 603 604 #else /* CONFIG_ACPI */ 605 606 static inline int register_acpi_bus_type(void *bus) { return 0; } 607 static inline int unregister_acpi_bus_type(void *bus) { return 0; } 608 609 #endif /* CONFIG_ACPI */ 610 611 #endif /*__ACPI_BUS_H__*/ 612