1 /* SPDX-License-Identifier: GPL-2.0-or-later */ 2 /* 3 * acpi_bus.h - ACPI Bus Driver ($Revision: 22 $) 4 * 5 * Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com> 6 * Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com> 7 */ 8 9 #ifndef __ACPI_BUS_H__ 10 #define __ACPI_BUS_H__ 11 12 #include <linux/completion.h> 13 #include <linux/container_of.h> 14 #include <linux/device.h> 15 #include <linux/kobject.h> 16 #include <linux/mutex.h> 17 #include <linux/property.h> 18 #include <linux/types.h> 19 20 struct acpi_handle_list { 21 u32 count; 22 acpi_handle *handles; 23 }; 24 25 /* acpi_utils.h */ 26 acpi_status 27 acpi_extract_package(union acpi_object *package, 28 struct acpi_buffer *format, struct acpi_buffer *buffer); 29 acpi_status 30 acpi_evaluate_integer(acpi_handle handle, 31 acpi_string pathname, 32 struct acpi_object_list *arguments, unsigned long long *data); 33 bool acpi_evaluate_reference(acpi_handle handle, acpi_string pathname, 34 struct acpi_object_list *arguments, 35 struct acpi_handle_list *list); 36 bool acpi_handle_list_equal(struct acpi_handle_list *list1, 37 struct acpi_handle_list *list2); 38 void acpi_handle_list_replace(struct acpi_handle_list *dst, 39 struct acpi_handle_list *src); 40 void acpi_handle_list_free(struct acpi_handle_list *list); 41 bool acpi_device_dep(acpi_handle target, acpi_handle match); 42 acpi_status 43 acpi_evaluate_ost(acpi_handle handle, u32 source_event, u32 status_code, 44 struct acpi_buffer *status_buf); 45 46 acpi_status 47 acpi_get_physical_device_location(acpi_handle handle, struct acpi_pld_info **pld); 48 49 bool acpi_has_method(acpi_handle handle, char *name); 50 acpi_status acpi_execute_simple_method(acpi_handle handle, char *method, 51 u64 arg); 52 acpi_status acpi_evaluate_ej0(acpi_handle handle); 53 acpi_status acpi_evaluate_lck(acpi_handle handle, int lock); 54 acpi_status acpi_evaluate_reg(acpi_handle handle, u8 space_id, u32 function); 55 bool acpi_ata_match(acpi_handle handle); 56 bool acpi_bay_match(acpi_handle handle); 57 bool acpi_dock_match(acpi_handle handle); 58 59 bool acpi_check_dsm(acpi_handle handle, const guid_t *guid, u64 rev, u64 funcs); 60 union acpi_object *acpi_evaluate_dsm(acpi_handle handle, const guid_t *guid, 61 u64 rev, u64 func, union acpi_object *argv4); 62 #ifdef CONFIG_ACPI 63 static inline union acpi_object * 64 acpi_evaluate_dsm_typed(acpi_handle handle, const guid_t *guid, u64 rev, 65 u64 func, union acpi_object *argv4, 66 acpi_object_type type) 67 { 68 union acpi_object *obj; 69 70 obj = acpi_evaluate_dsm(handle, guid, rev, func, argv4); 71 if (obj && obj->type != type) { 72 ACPI_FREE(obj); 73 obj = NULL; 74 } 75 76 return obj; 77 } 78 #endif 79 80 #define ACPI_INIT_DSM_ARGV4(cnt, eles) \ 81 { \ 82 .package.type = ACPI_TYPE_PACKAGE, \ 83 .package.count = (cnt), \ 84 .package.elements = (eles) \ 85 } 86 87 bool acpi_dev_found(const char *hid); 88 bool acpi_dev_present(const char *hid, const char *uid, s64 hrv); 89 bool acpi_reduced_hardware(void); 90 91 #ifdef CONFIG_ACPI 92 93 struct proc_dir_entry; 94 95 #define ACPI_BUS_FILE_ROOT "acpi" 96 extern struct proc_dir_entry *acpi_root_dir; 97 98 enum acpi_bus_device_type { 99 ACPI_BUS_TYPE_DEVICE = 0, 100 ACPI_BUS_TYPE_POWER, 101 ACPI_BUS_TYPE_PROCESSOR, 102 ACPI_BUS_TYPE_THERMAL, 103 ACPI_BUS_TYPE_POWER_BUTTON, 104 ACPI_BUS_TYPE_SLEEP_BUTTON, 105 ACPI_BUS_TYPE_ECDT_EC, 106 ACPI_BUS_DEVICE_TYPE_COUNT 107 }; 108 109 struct acpi_driver; 110 struct acpi_device; 111 112 /* 113 * ACPI Scan Handler 114 * ----------------- 115 */ 116 117 struct acpi_hotplug_profile { 118 struct kobject kobj; 119 int (*scan_dependent)(struct acpi_device *adev); 120 void (*notify_online)(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 struct list_head list_node; 133 const struct acpi_device_id *ids; 134 bool (*match)(const 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 (*post_eject)(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 typedef int (*acpi_hp_notify) (struct acpi_device *, u32); 149 typedef void (*acpi_hp_uevent) (struct acpi_device *, u32); 150 typedef void (*acpi_hp_fixup) (struct acpi_device *); 151 152 struct acpi_hotplug_context { 153 struct acpi_device *self; 154 acpi_hp_notify notify; 155 acpi_hp_uevent uevent; 156 acpi_hp_fixup fixup; 157 }; 158 159 /* 160 * ACPI Driver 161 * ----------- 162 */ 163 164 typedef int (*acpi_op_add) (struct acpi_device * device); 165 typedef void (*acpi_op_remove) (struct acpi_device *device); 166 typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event); 167 168 struct acpi_device_ops { 169 acpi_op_add add; 170 acpi_op_remove remove; 171 acpi_op_notify notify; 172 }; 173 174 #define ACPI_DRIVER_ALL_NOTIFY_EVENTS 0x1 /* system AND device events */ 175 176 struct acpi_driver { 177 char name[80]; 178 char class[80]; 179 const struct acpi_device_id *ids; /* Supported Hardware IDs */ 180 unsigned int flags; 181 struct acpi_device_ops ops; 182 struct device_driver drv; 183 }; 184 185 /* 186 * ACPI Device 187 * ----------- 188 */ 189 190 /* Status (_STA) */ 191 192 struct acpi_device_status { 193 u32 present:1; 194 u32 enabled:1; 195 u32 show_in_ui:1; 196 u32 functional:1; 197 u32 battery_present:1; 198 u32 reserved:27; 199 }; 200 201 /* Flags */ 202 203 struct acpi_device_flags { 204 u32 dynamic_status:1; 205 u32 removable:1; 206 u32 ejectable:1; 207 u32 power_manageable:1; 208 u32 match_driver:1; 209 u32 initialized:1; 210 u32 visited:1; 211 u32 hotplug_notify:1; 212 u32 is_dock_station:1; 213 u32 of_compatible_ok:1; 214 u32 coherent_dma:1; 215 u32 cca_seen:1; 216 u32 enumeration_by_parent:1; 217 u32 honor_deps:1; 218 u32 reserved:18; 219 }; 220 221 /* File System */ 222 223 struct acpi_device_dir { 224 struct proc_dir_entry *entry; 225 }; 226 227 #define acpi_device_dir(d) ((d)->dir.entry) 228 229 /* Plug and Play */ 230 231 typedef char acpi_bus_id[8]; 232 typedef u64 acpi_bus_address; 233 typedef char acpi_device_name[40]; 234 typedef char acpi_device_class[20]; 235 236 struct acpi_hardware_id { 237 struct list_head list; 238 const char *id; 239 }; 240 241 struct acpi_pnp_type { 242 u32 hardware_id:1; 243 u32 bus_address:1; 244 u32 platform_id:1; 245 u32 backlight:1; 246 u32 reserved:28; 247 }; 248 249 struct acpi_device_pnp { 250 acpi_bus_id bus_id; /* Object name */ 251 int instance_no; /* Instance number of this object */ 252 struct acpi_pnp_type type; /* ID type */ 253 acpi_bus_address bus_address; /* _ADR */ 254 char *unique_id; /* _UID */ 255 struct list_head ids; /* _HID and _CIDs */ 256 acpi_device_name device_name; /* Driver-determined */ 257 acpi_device_class device_class; /* " */ 258 union acpi_object *str_obj; /* unicode string for _STR method */ 259 }; 260 261 #define acpi_device_bid(d) ((d)->pnp.bus_id) 262 #define acpi_device_adr(d) ((d)->pnp.bus_address) 263 const char *acpi_device_hid(struct acpi_device *device); 264 #define acpi_device_uid(d) ((d)->pnp.unique_id) 265 #define acpi_device_name(d) ((d)->pnp.device_name) 266 #define acpi_device_class(d) ((d)->pnp.device_class) 267 268 /* Power Management */ 269 270 struct acpi_device_power_flags { 271 u32 explicit_get:1; /* _PSC present? */ 272 u32 power_resources:1; /* Power resources */ 273 u32 inrush_current:1; /* Serialize Dx->D0 */ 274 u32 power_removed:1; /* Optimize Dx->D0 */ 275 u32 ignore_parent:1; /* Power is independent of parent power state */ 276 u32 dsw_present:1; /* _DSW present? */ 277 u32 reserved:26; 278 }; 279 280 struct acpi_device_power_state { 281 struct list_head resources; /* Power resources referenced */ 282 struct { 283 u8 valid:1; 284 u8 explicit_set:1; /* _PSx present? */ 285 u8 reserved:6; 286 } flags; 287 int power; /* % Power (compared to D0) */ 288 int latency; /* Dx->D0 time (microseconds) */ 289 }; 290 291 struct acpi_device_power { 292 int state; /* Current state */ 293 struct acpi_device_power_flags flags; 294 struct acpi_device_power_state states[ACPI_D_STATE_COUNT]; /* Power states (D0-D3Cold) */ 295 u8 state_for_enumeration; /* Deepest power state for enumeration */ 296 }; 297 298 struct acpi_dep_data { 299 struct list_head node; 300 acpi_handle supplier; 301 acpi_handle consumer; 302 bool honor_dep; 303 bool met; 304 bool free_when_met; 305 }; 306 307 /* Performance Management */ 308 309 struct acpi_device_perf_flags { 310 u8 reserved:8; 311 }; 312 313 struct acpi_device_perf_state { 314 struct { 315 u8 valid:1; 316 u8 reserved:7; 317 } flags; 318 u8 power; /* % Power (compared to P0) */ 319 u8 performance; /* % Performance ( " ) */ 320 int latency; /* Px->P0 time (microseconds) */ 321 }; 322 323 struct acpi_device_perf { 324 int state; 325 struct acpi_device_perf_flags flags; 326 int state_count; 327 struct acpi_device_perf_state *states; 328 }; 329 330 /* Wakeup Management */ 331 struct acpi_device_wakeup_flags { 332 u8 valid:1; /* Can successfully enable wakeup? */ 333 u8 notifier_present:1; /* Wake-up notify handler has been installed */ 334 }; 335 336 struct acpi_device_wakeup_context { 337 void (*func)(struct acpi_device_wakeup_context *context); 338 struct device *dev; 339 }; 340 341 struct acpi_device_wakeup { 342 acpi_handle gpe_device; 343 u64 gpe_number; 344 u64 sleep_state; 345 struct list_head resources; 346 struct acpi_device_wakeup_flags flags; 347 struct acpi_device_wakeup_context context; 348 struct wakeup_source *ws; 349 int prepare_count; 350 int enable_count; 351 }; 352 353 struct acpi_device_physical_node { 354 struct list_head node; 355 struct device *dev; 356 unsigned int node_id; 357 bool put_online:1; 358 }; 359 360 struct acpi_device_properties { 361 struct list_head list; 362 const guid_t *guid; 363 union acpi_object *properties; 364 void **bufs; 365 }; 366 367 /* ACPI Device Specific Data (_DSD) */ 368 struct acpi_device_data { 369 const union acpi_object *pointer; 370 struct list_head properties; 371 const union acpi_object *of_compatible; 372 struct list_head subnodes; 373 }; 374 375 struct acpi_gpio_mapping; 376 377 #define ACPI_DEVICE_SWNODE_ROOT 0 378 379 /* 380 * The maximum expected number of CSI-2 data lanes. 381 * 382 * This number is not expected to ever have to be equal to or greater than the 383 * number of bits in an unsigned long variable, but if it needs to be increased 384 * above that limit, code will need to be adjusted accordingly. 385 */ 386 #define ACPI_DEVICE_CSI2_DATA_LANES 8 387 388 #define ACPI_DEVICE_SWNODE_PORT_NAME_LENGTH 8 389 390 enum acpi_device_swnode_dev_props { 391 ACPI_DEVICE_SWNODE_DEV_ROTATION, 392 ACPI_DEVICE_SWNODE_DEV_CLOCK_FREQUENCY, 393 ACPI_DEVICE_SWNODE_DEV_LED_MAX_MICROAMP, 394 ACPI_DEVICE_SWNODE_DEV_FLASH_MAX_MICROAMP, 395 ACPI_DEVICE_SWNODE_DEV_FLASH_MAX_TIMEOUT_US, 396 ACPI_DEVICE_SWNODE_DEV_NUM_OF, 397 ACPI_DEVICE_SWNODE_DEV_NUM_ENTRIES 398 }; 399 400 enum acpi_device_swnode_port_props { 401 ACPI_DEVICE_SWNODE_PORT_REG, 402 ACPI_DEVICE_SWNODE_PORT_NUM_OF, 403 ACPI_DEVICE_SWNODE_PORT_NUM_ENTRIES 404 }; 405 406 enum acpi_device_swnode_ep_props { 407 ACPI_DEVICE_SWNODE_EP_REMOTE_EP, 408 ACPI_DEVICE_SWNODE_EP_BUS_TYPE, 409 ACPI_DEVICE_SWNODE_EP_REG, 410 ACPI_DEVICE_SWNODE_EP_CLOCK_LANES, 411 ACPI_DEVICE_SWNODE_EP_DATA_LANES, 412 ACPI_DEVICE_SWNODE_EP_LANE_POLARITIES, 413 /* TX only */ 414 ACPI_DEVICE_SWNODE_EP_LINK_FREQUENCIES, 415 ACPI_DEVICE_SWNODE_EP_NUM_OF, 416 ACPI_DEVICE_SWNODE_EP_NUM_ENTRIES 417 }; 418 419 /* 420 * Each device has a root software node plus two times as many nodes as the 421 * number of CSI-2 ports. 422 */ 423 #define ACPI_DEVICE_SWNODE_PORT(port) (2 * (port) + 1) 424 #define ACPI_DEVICE_SWNODE_EP(endpoint) \ 425 (ACPI_DEVICE_SWNODE_PORT(endpoint) + 1) 426 427 /** 428 * struct acpi_device_software_node_port - MIPI DisCo for Imaging CSI-2 port 429 * @port_name: Port name. 430 * @data_lanes: "data-lanes" property values. 431 * @lane_polarities: "lane-polarities" property values. 432 * @link_frequencies: "link_frequencies" property values. 433 * @port_nr: Port number. 434 * @crs_crs2_local: _CRS CSI2 record present (i.e. this is a transmitter one). 435 * @port_props: Port properties. 436 * @ep_props: Endpoint properties. 437 * @remote_ep: Reference to the remote endpoint. 438 */ 439 struct acpi_device_software_node_port { 440 char port_name[ACPI_DEVICE_SWNODE_PORT_NAME_LENGTH + 1]; 441 u32 data_lanes[ACPI_DEVICE_CSI2_DATA_LANES]; 442 u32 lane_polarities[ACPI_DEVICE_CSI2_DATA_LANES + 1 /* clock lane */]; 443 u64 link_frequencies[ACPI_DEVICE_CSI2_DATA_LANES]; 444 unsigned int port_nr; 445 bool crs_csi2_local; 446 447 struct property_entry port_props[ACPI_DEVICE_SWNODE_PORT_NUM_ENTRIES]; 448 struct property_entry ep_props[ACPI_DEVICE_SWNODE_EP_NUM_ENTRIES]; 449 450 struct software_node_ref_args remote_ep[1]; 451 }; 452 453 /** 454 * struct acpi_device_software_nodes - Software nodes for an ACPI device 455 * @dev_props: Device properties. 456 * @nodes: Software nodes for root as well as ports and endpoints. 457 * @nodeprts: Array of software node pointers, for (un)registering them. 458 * @ports: Information related to each port and endpoint within a port. 459 * @num_ports: The number of ports. 460 */ 461 struct acpi_device_software_nodes { 462 struct property_entry dev_props[ACPI_DEVICE_SWNODE_DEV_NUM_ENTRIES]; 463 struct software_node *nodes; 464 const struct software_node **nodeptrs; 465 struct acpi_device_software_node_port *ports; 466 unsigned int num_ports; 467 }; 468 469 /* Device */ 470 struct acpi_device { 471 u32 pld_crc; 472 int device_type; 473 acpi_handle handle; /* no handle for fixed hardware */ 474 struct fwnode_handle fwnode; 475 struct list_head wakeup_list; 476 struct list_head del_list; 477 struct acpi_device_status status; 478 struct acpi_device_flags flags; 479 struct acpi_device_pnp pnp; 480 struct acpi_device_power power; 481 struct acpi_device_wakeup wakeup; 482 struct acpi_device_perf performance; 483 struct acpi_device_dir dir; 484 struct acpi_device_data data; 485 struct acpi_scan_handler *handler; 486 struct acpi_hotplug_context *hp; 487 struct acpi_device_software_nodes *swnodes; 488 const struct acpi_gpio_mapping *driver_gpios; 489 void *driver_data; 490 struct device dev; 491 unsigned int physical_node_count; 492 unsigned int dep_unmet; 493 struct list_head physical_node_list; 494 struct mutex physical_node_lock; 495 void (*remove)(struct acpi_device *); 496 }; 497 498 /* Non-device subnode */ 499 struct acpi_data_node { 500 struct list_head sibling; 501 const char *name; 502 acpi_handle handle; 503 struct fwnode_handle fwnode; 504 struct fwnode_handle *parent; 505 struct acpi_device_data data; 506 struct kobject kobj; 507 struct completion kobj_done; 508 }; 509 510 extern const struct fwnode_operations acpi_device_fwnode_ops; 511 extern const struct fwnode_operations acpi_data_fwnode_ops; 512 extern const struct fwnode_operations acpi_static_fwnode_ops; 513 514 bool is_acpi_device_node(const struct fwnode_handle *fwnode); 515 bool is_acpi_data_node(const struct fwnode_handle *fwnode); 516 517 static inline bool is_acpi_node(const struct fwnode_handle *fwnode) 518 { 519 return (is_acpi_device_node(fwnode) || is_acpi_data_node(fwnode)); 520 } 521 522 #define to_acpi_device_node(__fwnode) \ 523 ({ \ 524 typeof(__fwnode) __to_acpi_device_node_fwnode = __fwnode; \ 525 \ 526 is_acpi_device_node(__to_acpi_device_node_fwnode) ? \ 527 container_of(__to_acpi_device_node_fwnode, \ 528 struct acpi_device, fwnode) : \ 529 NULL; \ 530 }) 531 532 #define to_acpi_data_node(__fwnode) \ 533 ({ \ 534 typeof(__fwnode) __to_acpi_data_node_fwnode = __fwnode; \ 535 \ 536 is_acpi_data_node(__to_acpi_data_node_fwnode) ? \ 537 container_of(__to_acpi_data_node_fwnode, \ 538 struct acpi_data_node, fwnode) : \ 539 NULL; \ 540 }) 541 542 static inline bool is_acpi_static_node(const struct fwnode_handle *fwnode) 543 { 544 return !IS_ERR_OR_NULL(fwnode) && 545 fwnode->ops == &acpi_static_fwnode_ops; 546 } 547 548 static inline bool acpi_data_node_match(const struct fwnode_handle *fwnode, 549 const char *name) 550 { 551 return is_acpi_data_node(fwnode) ? 552 (!strcmp(to_acpi_data_node(fwnode)->name, name)) : false; 553 } 554 555 static inline struct fwnode_handle *acpi_fwnode_handle(struct acpi_device *adev) 556 { 557 return &adev->fwnode; 558 } 559 560 static inline void *acpi_driver_data(struct acpi_device *d) 561 { 562 return d->driver_data; 563 } 564 565 #define to_acpi_device(d) container_of(d, struct acpi_device, dev) 566 #define to_acpi_driver(d) container_of_const(d, struct acpi_driver, drv) 567 568 static inline struct acpi_device *acpi_dev_parent(struct acpi_device *adev) 569 { 570 if (adev->dev.parent) 571 return to_acpi_device(adev->dev.parent); 572 573 return NULL; 574 } 575 576 static inline void acpi_set_device_status(struct acpi_device *adev, u32 sta) 577 { 578 *((u32 *)&adev->status) = sta; 579 } 580 581 static inline void acpi_set_hp_context(struct acpi_device *adev, 582 struct acpi_hotplug_context *hp) 583 { 584 hp->self = adev; 585 adev->hp = hp; 586 } 587 588 void acpi_initialize_hp_context(struct acpi_device *adev, 589 struct acpi_hotplug_context *hp, 590 acpi_hp_notify notify, acpi_hp_uevent uevent); 591 592 /* acpi_device.dev.bus == &acpi_bus_type */ 593 extern const struct bus_type acpi_bus_type; 594 595 int acpi_bus_for_each_dev(int (*fn)(struct device *, void *), void *data); 596 int acpi_dev_for_each_child(struct acpi_device *adev, 597 int (*fn)(struct acpi_device *, void *), void *data); 598 int acpi_dev_for_each_child_reverse(struct acpi_device *adev, 599 int (*fn)(struct acpi_device *, void *), 600 void *data); 601 602 /* 603 * Events 604 * ------ 605 */ 606 607 struct acpi_bus_event { 608 struct list_head node; 609 acpi_device_class device_class; 610 acpi_bus_id bus_id; 611 u32 type; 612 u32 data; 613 }; 614 615 extern struct kobject *acpi_kobj; 616 extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int); 617 void acpi_bus_private_data_handler(acpi_handle, void *); 618 int acpi_bus_get_private_data(acpi_handle, void **); 619 int acpi_bus_attach_private_data(acpi_handle, void *); 620 void acpi_bus_detach_private_data(acpi_handle); 621 int acpi_dev_install_notify_handler(struct acpi_device *adev, 622 u32 handler_type, 623 acpi_notify_handler handler, void *context); 624 void acpi_dev_remove_notify_handler(struct acpi_device *adev, 625 u32 handler_type, 626 acpi_notify_handler handler); 627 extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32); 628 extern int register_acpi_notifier(struct notifier_block *); 629 extern int unregister_acpi_notifier(struct notifier_block *); 630 631 /* 632 * External Functions 633 */ 634 635 acpi_status acpi_bus_get_status_handle(acpi_handle handle, 636 unsigned long long *sta); 637 int acpi_bus_get_status(struct acpi_device *device); 638 639 int acpi_bus_set_power(acpi_handle handle, int state); 640 const char *acpi_power_state_string(int state); 641 int acpi_device_set_power(struct acpi_device *device, int state); 642 int acpi_bus_init_power(struct acpi_device *device); 643 int acpi_device_fix_up_power(struct acpi_device *device); 644 void acpi_device_fix_up_power_extended(struct acpi_device *adev); 645 void acpi_device_fix_up_power_children(struct acpi_device *adev); 646 int acpi_bus_update_power(acpi_handle handle, int *state_p); 647 int acpi_device_update_power(struct acpi_device *device, int *state_p); 648 bool acpi_bus_power_manageable(acpi_handle handle); 649 void acpi_dev_power_up_children_with_adr(struct acpi_device *adev); 650 u8 acpi_dev_power_state_for_wake(struct acpi_device *adev); 651 int acpi_device_power_add_dependent(struct acpi_device *adev, 652 struct device *dev); 653 void acpi_device_power_remove_dependent(struct acpi_device *adev, 654 struct device *dev); 655 656 #ifdef CONFIG_PM 657 bool acpi_bus_can_wakeup(acpi_handle handle); 658 #else 659 static inline bool acpi_bus_can_wakeup(acpi_handle handle) { return false; } 660 #endif 661 662 void acpi_scan_lock_acquire(void); 663 void acpi_scan_lock_release(void); 664 void acpi_lock_hp_context(void); 665 void acpi_unlock_hp_context(void); 666 int acpi_scan_add_handler(struct acpi_scan_handler *handler); 667 /* 668 * use a macro to avoid include chaining to get THIS_MODULE 669 */ 670 #define acpi_bus_register_driver(drv) \ 671 __acpi_bus_register_driver(drv, THIS_MODULE) 672 int __acpi_bus_register_driver(struct acpi_driver *driver, struct module *owner); 673 void acpi_bus_unregister_driver(struct acpi_driver *driver); 674 int acpi_bus_scan(acpi_handle handle); 675 void acpi_bus_trim(struct acpi_device *start); 676 acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd); 677 int acpi_match_device_ids(struct acpi_device *device, 678 const struct acpi_device_id *ids); 679 void acpi_set_modalias(struct acpi_device *adev, const char *default_id, 680 char *modalias, size_t len); 681 682 static inline bool acpi_device_enumerated(struct acpi_device *adev) 683 { 684 return adev && adev->flags.initialized && adev->flags.visited; 685 } 686 687 /** 688 * module_acpi_driver(acpi_driver) - Helper macro for registering an ACPI driver 689 * @__acpi_driver: acpi_driver struct 690 * 691 * Helper macro for ACPI drivers which do not do anything special in module 692 * init/exit. This eliminates a lot of boilerplate. Each module may only 693 * use this macro once, and calling it replaces module_init() and module_exit() 694 */ 695 #define module_acpi_driver(__acpi_driver) \ 696 module_driver(__acpi_driver, acpi_bus_register_driver, \ 697 acpi_bus_unregister_driver) 698 699 /* 700 * Bind physical devices with ACPI devices 701 */ 702 struct acpi_bus_type { 703 struct list_head list; 704 const char *name; 705 bool (*match)(struct device *dev); 706 struct acpi_device * (*find_companion)(struct device *); 707 void (*setup)(struct device *); 708 }; 709 int register_acpi_bus_type(struct acpi_bus_type *); 710 int unregister_acpi_bus_type(struct acpi_bus_type *); 711 int acpi_bind_one(struct device *dev, struct acpi_device *adev); 712 int acpi_unbind_one(struct device *dev); 713 714 enum acpi_bridge_type { 715 ACPI_BRIDGE_TYPE_PCIE = 1, 716 ACPI_BRIDGE_TYPE_CXL, 717 }; 718 719 struct acpi_pci_root { 720 struct acpi_device * device; 721 struct pci_bus *bus; 722 u16 segment; 723 int bridge_type; 724 struct resource secondary; /* downstream bus range */ 725 726 u32 osc_support_set; /* _OSC state of support bits */ 727 u32 osc_control_set; /* _OSC state of control bits */ 728 u32 osc_ext_support_set; /* _OSC state of extended support bits */ 729 u32 osc_ext_control_set; /* _OSC state of extended control bits */ 730 phys_addr_t mcfg_addr; 731 }; 732 733 /* helper */ 734 735 struct iommu_ops; 736 737 bool acpi_dma_supported(const struct acpi_device *adev); 738 enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev); 739 int acpi_iommu_fwspec_init(struct device *dev, u32 id, 740 struct fwnode_handle *fwnode); 741 int acpi_dma_get_range(struct device *dev, const struct bus_dma_region **map); 742 int acpi_dma_configure_id(struct device *dev, enum dev_dma_attr attr, 743 const u32 *input_id); 744 static inline int acpi_dma_configure(struct device *dev, 745 enum dev_dma_attr attr) 746 { 747 return acpi_dma_configure_id(dev, attr, NULL); 748 } 749 struct acpi_device *acpi_find_child_device(struct acpi_device *parent, 750 u64 address, bool check_children); 751 struct acpi_device *acpi_find_child_by_adr(struct acpi_device *adev, 752 acpi_bus_address adr); 753 int acpi_is_root_bridge(acpi_handle); 754 struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle); 755 756 int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state); 757 int acpi_disable_wakeup_device_power(struct acpi_device *dev); 758 759 #ifdef CONFIG_X86 760 bool acpi_device_override_status(struct acpi_device *adev, unsigned long long *status); 761 bool acpi_quirk_skip_acpi_ac_and_battery(void); 762 int acpi_install_cmos_rtc_space_handler(acpi_handle handle); 763 void acpi_remove_cmos_rtc_space_handler(acpi_handle handle); 764 int acpi_quirk_skip_serdev_enumeration(struct device *controller_parent, bool *skip); 765 #else 766 static inline bool acpi_device_override_status(struct acpi_device *adev, 767 unsigned long long *status) 768 { 769 return false; 770 } 771 static inline bool acpi_quirk_skip_acpi_ac_and_battery(void) 772 { 773 return false; 774 } 775 static inline int acpi_install_cmos_rtc_space_handler(acpi_handle handle) 776 { 777 return 1; 778 } 779 static inline void acpi_remove_cmos_rtc_space_handler(acpi_handle handle) 780 { 781 } 782 static inline int 783 acpi_quirk_skip_serdev_enumeration(struct device *controller_parent, bool *skip) 784 { 785 *skip = false; 786 return 0; 787 } 788 #endif 789 790 #if IS_ENABLED(CONFIG_X86_ANDROID_TABLETS) 791 bool acpi_quirk_skip_i2c_client_enumeration(struct acpi_device *adev); 792 bool acpi_quirk_skip_gpio_event_handlers(void); 793 #else 794 static inline bool acpi_quirk_skip_i2c_client_enumeration(struct acpi_device *adev) 795 { 796 return false; 797 } 798 static inline bool acpi_quirk_skip_gpio_event_handlers(void) 799 { 800 return false; 801 } 802 #endif 803 804 #ifdef CONFIG_PM 805 void acpi_pm_wakeup_event(struct device *dev); 806 acpi_status acpi_add_pm_notifier(struct acpi_device *adev, struct device *dev, 807 void (*func)(struct acpi_device_wakeup_context *context)); 808 acpi_status acpi_remove_pm_notifier(struct acpi_device *adev); 809 bool acpi_pm_device_can_wakeup(struct device *dev); 810 int acpi_pm_device_sleep_state(struct device *, int *, int); 811 int acpi_pm_set_device_wakeup(struct device *dev, bool enable); 812 #else 813 static inline void acpi_pm_wakeup_event(struct device *dev) 814 { 815 } 816 static inline acpi_status acpi_add_pm_notifier(struct acpi_device *adev, 817 struct device *dev, 818 void (*func)(struct acpi_device_wakeup_context *context)) 819 { 820 return AE_SUPPORT; 821 } 822 static inline acpi_status acpi_remove_pm_notifier(struct acpi_device *adev) 823 { 824 return AE_SUPPORT; 825 } 826 static inline bool acpi_pm_device_can_wakeup(struct device *dev) 827 { 828 return false; 829 } 830 static inline int acpi_pm_device_sleep_state(struct device *d, int *p, int m) 831 { 832 if (p) 833 *p = ACPI_STATE_D0; 834 835 return (m >= ACPI_STATE_D0 && m <= ACPI_STATE_D3_COLD) ? 836 m : ACPI_STATE_D0; 837 } 838 static inline int acpi_pm_set_device_wakeup(struct device *dev, bool enable) 839 { 840 return -ENODEV; 841 } 842 #endif 843 844 #ifdef CONFIG_ACPI_SYSTEM_POWER_STATES_SUPPORT 845 bool acpi_sleep_state_supported(u8 sleep_state); 846 #else 847 static inline bool acpi_sleep_state_supported(u8 sleep_state) { return false; } 848 #endif 849 850 #ifdef CONFIG_ACPI_SLEEP 851 u32 acpi_target_system_state(void); 852 #else 853 static inline u32 acpi_target_system_state(void) { return ACPI_STATE_S0; } 854 #endif 855 856 static inline bool acpi_device_power_manageable(struct acpi_device *adev) 857 { 858 return adev->flags.power_manageable; 859 } 860 861 static inline bool acpi_device_can_wakeup(struct acpi_device *adev) 862 { 863 return adev->wakeup.flags.valid; 864 } 865 866 static inline bool acpi_device_can_poweroff(struct acpi_device *adev) 867 { 868 return adev->power.states[ACPI_STATE_D3_COLD].flags.valid || 869 ((acpi_gbl_FADT.header.revision < 6) && 870 adev->power.states[ACPI_STATE_D3_HOT].flags.explicit_set); 871 } 872 873 int acpi_dev_uid_to_integer(struct acpi_device *adev, u64 *integer); 874 875 static inline bool acpi_dev_hid_match(struct acpi_device *adev, const char *hid2) 876 { 877 const char *hid1 = acpi_device_hid(adev); 878 879 return hid1 && hid2 && !strcmp(hid1, hid2); 880 } 881 882 static inline bool acpi_str_uid_match(struct acpi_device *adev, const char *uid2) 883 { 884 const char *uid1 = acpi_device_uid(adev); 885 886 return uid1 && uid2 && !strcmp(uid1, uid2); 887 } 888 889 static inline bool acpi_int_uid_match(struct acpi_device *adev, u64 uid2) 890 { 891 u64 uid1; 892 893 return !acpi_dev_uid_to_integer(adev, &uid1) && uid1 == uid2; 894 } 895 896 #define TYPE_ENTRY(type, x) \ 897 const type: x, \ 898 type: x 899 900 #define ACPI_STR_TYPES(match) \ 901 TYPE_ENTRY(unsigned char *, match), \ 902 TYPE_ENTRY(signed char *, match), \ 903 TYPE_ENTRY(char *, match), \ 904 TYPE_ENTRY(void *, match) 905 906 /** 907 * acpi_dev_uid_match - Match device by supplied UID 908 * @adev: ACPI device to match. 909 * @uid2: Unique ID of the device. 910 * 911 * Matches UID in @adev with given @uid2. 912 * 913 * Returns: %true if matches, %false otherwise. 914 */ 915 #define acpi_dev_uid_match(adev, uid2) \ 916 _Generic(uid2, \ 917 /* Treat @uid2 as a string for acpi string types */ \ 918 ACPI_STR_TYPES(acpi_str_uid_match), \ 919 /* Treat as an integer otherwise */ \ 920 default: acpi_int_uid_match)(adev, uid2) 921 922 /** 923 * acpi_dev_hid_uid_match - Match device by supplied HID and UID 924 * @adev: ACPI device to match. 925 * @hid2: Hardware ID of the device. 926 * @uid2: Unique ID of the device, pass NULL to not check _UID. 927 * 928 * Matches HID and UID in @adev with given @hid2 and @uid2. Absence of @uid2 929 * will be treated as a match. If user wants to validate @uid2, it should be 930 * done before calling this function. 931 * 932 * Returns: %true if matches or @uid2 is NULL, %false otherwise. 933 */ 934 #define acpi_dev_hid_uid_match(adev, hid2, uid2) \ 935 (acpi_dev_hid_match(adev, hid2) && \ 936 /* Distinguish integer 0 from NULL @uid2 */ \ 937 (_Generic(uid2, ACPI_STR_TYPES(!(uid2)), default: 0) || \ 938 acpi_dev_uid_match(adev, uid2))) 939 940 void acpi_dev_clear_dependencies(struct acpi_device *supplier); 941 bool acpi_dev_ready_for_enumeration(const struct acpi_device *device); 942 struct acpi_device *acpi_dev_get_next_consumer_dev(struct acpi_device *supplier, 943 struct acpi_device *start); 944 945 /** 946 * for_each_acpi_consumer_dev - iterate over the consumer ACPI devices for a 947 * given supplier 948 * @supplier: Pointer to the supplier's ACPI device 949 * @consumer: Pointer to &struct acpi_device to hold the consumer, initially NULL 950 */ 951 #define for_each_acpi_consumer_dev(supplier, consumer) \ 952 for (consumer = acpi_dev_get_next_consumer_dev(supplier, NULL); \ 953 consumer; \ 954 consumer = acpi_dev_get_next_consumer_dev(supplier, consumer)) 955 956 struct acpi_device * 957 acpi_dev_get_next_match_dev(struct acpi_device *adev, const char *hid, const char *uid, s64 hrv); 958 struct acpi_device * 959 acpi_dev_get_first_match_dev(const char *hid, const char *uid, s64 hrv); 960 961 /** 962 * for_each_acpi_dev_match - iterate over ACPI devices that matching the criteria 963 * @adev: pointer to the matching ACPI device, NULL at the end of the loop 964 * @hid: Hardware ID of the device. 965 * @uid: Unique ID of the device, pass NULL to not check _UID 966 * @hrv: Hardware Revision of the device, pass -1 to not check _HRV 967 * 968 * The caller is responsible for invoking acpi_dev_put() on the returned device. 969 */ 970 #define for_each_acpi_dev_match(adev, hid, uid, hrv) \ 971 for (adev = acpi_dev_get_first_match_dev(hid, uid, hrv); \ 972 adev; \ 973 adev = acpi_dev_get_next_match_dev(adev, hid, uid, hrv)) 974 975 static inline struct acpi_device *acpi_dev_get(struct acpi_device *adev) 976 { 977 return adev ? to_acpi_device(get_device(&adev->dev)) : NULL; 978 } 979 980 static inline void acpi_dev_put(struct acpi_device *adev) 981 { 982 if (adev) 983 put_device(&adev->dev); 984 } 985 986 struct acpi_device *acpi_fetch_acpi_dev(acpi_handle handle); 987 struct acpi_device *acpi_get_acpi_dev(acpi_handle handle); 988 989 static inline void acpi_put_acpi_dev(struct acpi_device *adev) 990 { 991 acpi_dev_put(adev); 992 } 993 994 int acpi_wait_for_acpi_ipmi(void); 995 996 #else /* CONFIG_ACPI */ 997 998 static inline int register_acpi_bus_type(void *bus) { return 0; } 999 static inline int unregister_acpi_bus_type(void *bus) { return 0; } 1000 1001 static inline int acpi_wait_for_acpi_ipmi(void) { return 0; } 1002 1003 #endif /* CONFIG_ACPI */ 1004 1005 #endif /*__ACPI_BUS_H__*/ 1006