include/acpi/acpi_bus.h

   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/device.h>
  13 #include <linux/property.h>
  14
  15 struct acpi_handle_list {
  16         u32 count;
  17         acpi_handle *handles;
  18 };
  19
  20 /* acpi_utils.h */
  21 acpi_status
  22 acpi_extract_package(union acpi_object *package,
  23                      struct acpi_buffer *format, struct acpi_buffer *buffer);
  24 acpi_status
  25 acpi_evaluate_integer(acpi_handle handle,
  26                       acpi_string pathname,
  27                       struct acpi_object_list *arguments, unsigned long long *data);
  28 bool acpi_evaluate_reference(acpi_handle handle, acpi_string pathname,
  29                              struct acpi_object_list *arguments,
  30                              struct acpi_handle_list *list);
  31 bool acpi_handle_list_equal(struct acpi_handle_list *list1,
  32                             struct acpi_handle_list *list2);
  33 void acpi_handle_list_replace(struct acpi_handle_list *dst,
  34                               struct acpi_handle_list *src);
  35 void acpi_handle_list_free(struct acpi_handle_list *list);
  36 acpi_status
  37 acpi_evaluate_ost(acpi_handle handle, u32 source_event, u32 status_code,
  38                   struct acpi_buffer *status_buf);
  39
  40 acpi_status
  41 acpi_get_physical_device_location(acpi_handle handle, struct acpi_pld_info **pld);
  42
  43 bool acpi_has_method(acpi_handle handle, char *name);
  44 acpi_status acpi_execute_simple_method(acpi_handle handle, char *method,
  45                                        u64 arg);
  46 acpi_status acpi_evaluate_ej0(acpi_handle handle);
  47 acpi_status acpi_evaluate_lck(acpi_handle handle, int lock);
  48 acpi_status acpi_evaluate_reg(acpi_handle handle, u8 space_id, u32 function);
  49 bool acpi_ata_match(acpi_handle handle);
  50 bool acpi_bay_match(acpi_handle handle);
  51 bool acpi_dock_match(acpi_handle handle);
  52
  53 bool acpi_check_dsm(acpi_handle handle, const guid_t *guid, u64 rev, u64 funcs);
  54 union acpi_object *acpi_evaluate_dsm(acpi_handle handle, const guid_t *guid,
  55                         u64 rev, u64 func, union acpi_object *argv4);
  56 #ifdef CONFIG_ACPI
  57 static inline union acpi_object *
  58 acpi_evaluate_dsm_typed(acpi_handle handle, const guid_t *guid, u64 rev,
  59                         u64 func, union acpi_object *argv4,
  60                         acpi_object_type type)
  61 {
  62         union acpi_object *obj;
  63
  64         obj = acpi_evaluate_dsm(handle, guid, rev, func, argv4);
  65         if (obj && obj->type != type) {
  66                 ACPI_FREE(obj);
  67                 obj = NULL;
  68         }
  69
  70         return obj;
  71 }
  72 #endif
  73
  74 #define ACPI_INIT_DSM_ARGV4(cnt, eles)                  \
  75         {                                               \
  76           .package.type = ACPI_TYPE_PACKAGE,            \
  77           .package.count = (cnt),                       \
  78           .package.elements = (eles)                    \
  79         }
  80
  81 bool acpi_dev_found(const char *hid);
  82 bool acpi_dev_present(const char *hid, const char *uid, s64 hrv);
  83 bool acpi_reduced_hardware(void);
  84
  85 #ifdef CONFIG_ACPI
  86
  87 struct proc_dir_entry;
  88
  89 #define ACPI_BUS_FILE_ROOT      "acpi"
  90 extern struct proc_dir_entry *acpi_root_dir;
  91
  92 enum acpi_bus_device_type {
  93         ACPI_BUS_TYPE_DEVICE = 0,
  94         ACPI_BUS_TYPE_POWER,
  95         ACPI_BUS_TYPE_PROCESSOR,
  96         ACPI_BUS_TYPE_THERMAL,
  97         ACPI_BUS_TYPE_POWER_BUTTON,
  98         ACPI_BUS_TYPE_SLEEP_BUTTON,
  99         ACPI_BUS_TYPE_ECDT_EC,
 100         ACPI_BUS_DEVICE_TYPE_COUNT
 101 };
 102
 103 struct acpi_driver;
 104 struct acpi_device;
 105
 106 /*
 107  * ACPI Scan Handler
 108  * -----------------
 109  */
 110
 111 struct acpi_hotplug_profile {
 112         struct kobject kobj;
 113         int (*scan_dependent)(struct acpi_device *adev);
 114         void (*notify_online)(struct acpi_device *adev);
 115         bool enabled:1;
 116         bool demand_offline:1;
 117 };
 118
 119 static inline struct acpi_hotplug_profile *to_acpi_hotplug_profile(
 120                                                 struct kobject *kobj)
 121 {
 122         return container_of(kobj, struct acpi_hotplug_profile, kobj);
 123 }
 124
 125 struct acpi_scan_handler {
 126         const struct acpi_device_id *ids;
 127         struct list_head list_node;
 128         bool (*match)(const char *idstr, const struct acpi_device_id **matchid);
 129         int (*attach)(struct acpi_device *dev, const struct acpi_device_id *id);
 130         void (*detach)(struct acpi_device *dev);
 131         void (*bind)(struct device *phys_dev);
 132         void (*unbind)(struct device *phys_dev);
 133         struct acpi_hotplug_profile hotplug;
 134 };
 135
 136 /*
 137  * ACPI Hotplug Context
 138  * --------------------
 139  */
 140
 141 struct acpi_hotplug_context {
 142         struct acpi_device *self;
 143         int (*notify)(struct acpi_device *, u32);
 144         void (*uevent)(struct acpi_device *, u32);
 145         void (*fixup)(struct acpi_device *);
 146 };
 147
 148 /*
 149  * ACPI Driver
 150  * -----------
 151  */
 152
 153 typedef int (*acpi_op_add) (struct acpi_device * device);
 154 typedef void (*acpi_op_remove) (struct acpi_device *device);
 155 typedef void (*acpi_op_notify) (struct acpi_device * device, u32 event);
 156
 157 struct acpi_device_ops {
 158         acpi_op_add add;
 159         acpi_op_remove remove;
 160         acpi_op_notify notify;
 161 };
 162
 163 #define ACPI_DRIVER_ALL_NOTIFY_EVENTS   0x1     /* system AND device events */
 164
 165 struct acpi_driver {
 166         char name[80];
 167         char class[80];
 168         const struct acpi_device_id *ids; /* Supported Hardware IDs */
 169         unsigned int flags;
 170         struct acpi_device_ops ops;
 171         struct device_driver drv;
 172         struct module *owner;
 173 };
 174
 175 /*
 176  * ACPI Device
 177  * -----------
 178  */
 179
 180 /* Status (_STA) */
 181
 182 struct acpi_device_status {
 183         u32 present:1;
 184         u32 enabled:1;
 185         u32 show_in_ui:1;
 186         u32 functional:1;
 187         u32 battery_present:1;
 188         u32 reserved:27;
 189 };
 190
 191 /* Flags */
 192
 193 struct acpi_device_flags {
 194         u32 dynamic_status:1;
 195         u32 removable:1;
 196         u32 ejectable:1;
 197         u32 power_manageable:1;
 198         u32 match_driver:1;
 199         u32 initialized:1;
 200         u32 visited:1;
 201         u32 hotplug_notify:1;
 202         u32 is_dock_station:1;
 203         u32 of_compatible_ok:1;
 204         u32 coherent_dma:1;
 205         u32 cca_seen:1;
 206         u32 enumeration_by_parent:1;
 207         u32 honor_deps:1;
 208         u32 reserved:18;
 209 };
 210
 211 /* File System */
 212
 213 struct acpi_device_dir {
 214         struct proc_dir_entry *entry;
 215 };
 216
 217 #define acpi_device_dir(d)      ((d)->dir.entry)
 218
 219 /* Plug and Play */
 220
 221 typedef char acpi_bus_id[8];
 222 typedef u64 acpi_bus_address;
 223 typedef char acpi_device_name[40];
 224 typedef char acpi_device_class[20];
 225
 226 struct acpi_hardware_id {
 227         struct list_head list;
 228         const char *id;
 229 };
 230
 231 struct acpi_pnp_type {
 232         u32 hardware_id:1;
 233         u32 bus_address:1;
 234         u32 platform_id:1;
 235         u32 backlight:1;
 236         u32 reserved:28;
 237 };
 238
 239 struct acpi_device_pnp {
 240         acpi_bus_id bus_id;             /* Object name */
 241         int instance_no;                /* Instance number of this object */
 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         u8 state_for_enumeration; /* Deepest power state for enumeration */
 286 };
 287
 288 struct acpi_dep_data {
 289         struct list_head node;
 290         acpi_handle supplier;
 291         acpi_handle consumer;
 292         bool honor_dep;
 293         bool met;
 294         bool free_when_met;
 295 };
 296
 297 /* Performance Management */
 298
 299 struct acpi_device_perf_flags {
 300         u8 reserved:8;
 301 };
 302
 303 struct acpi_device_perf_state {
 304         struct {
 305                 u8 valid:1;
 306                 u8 reserved:7;
 307         } flags;
 308         u8 power;               /* % Power (compared to P0) */
 309         u8 performance;         /* % Performance (    "   ) */
 310         int latency;            /* Px->P0 time (microseconds) */
 311 };
 312
 313 struct acpi_device_perf {
 314         int state;
 315         struct acpi_device_perf_flags flags;
 316         int state_count;
 317         struct acpi_device_perf_state *states;
 318 };
 319
 320 /* Wakeup Management */
 321 struct acpi_device_wakeup_flags {
 322         u8 valid:1;             /* Can successfully enable wakeup? */
 323         u8 notifier_present:1;  /* Wake-up notify handler has been installed */
 324 };
 325
 326 struct acpi_device_wakeup_context {
 327         void (*func)(struct acpi_device_wakeup_context *context);
 328         struct device *dev;
 329 };
 330
 331 struct acpi_device_wakeup {
 332         acpi_handle gpe_device;
 333         u64 gpe_number;
 334         u64 sleep_state;
 335         struct list_head resources;
 336         struct acpi_device_wakeup_flags flags;
 337         struct acpi_device_wakeup_context context;
 338         struct wakeup_source *ws;
 339         int prepare_count;
 340         int enable_count;
 341 };
 342
 343 struct acpi_device_physical_node {
 344         unsigned int node_id;
 345         struct list_head node;
 346         struct device *dev;
 347         bool put_online:1;
 348 };
 349
 350 struct acpi_device_properties {
 351         const guid_t *guid;
 352         union acpi_object *properties;
 353         struct list_head list;
 354         void **bufs;
 355 };
 356
 357 /* ACPI Device Specific Data (_DSD) */
 358 struct acpi_device_data {
 359         const union acpi_object *pointer;
 360         struct list_head properties;
 361         const union acpi_object *of_compatible;
 362         struct list_head subnodes;
 363 };
 364
 365 struct acpi_gpio_mapping;
 366
 367 /* Device */
 368 struct acpi_device {
 369         u32 pld_crc;
 370         int device_type;
 371         acpi_handle handle;             /* no handle for fixed hardware */
 372         struct fwnode_handle fwnode;
 373         struct list_head wakeup_list;
 374         struct list_head del_list;
 375         struct acpi_device_status status;
 376         struct acpi_device_flags flags;
 377         struct acpi_device_pnp pnp;
 378         struct acpi_device_power power;
 379         struct acpi_device_wakeup wakeup;
 380         struct acpi_device_perf performance;
 381         struct acpi_device_dir dir;
 382         struct acpi_device_data data;
 383         struct acpi_scan_handler *handler;
 384         struct acpi_hotplug_context *hp;
 385         const struct acpi_gpio_mapping *driver_gpios;
 386         void *driver_data;
 387         struct device dev;
 388         unsigned int physical_node_count;
 389         unsigned int dep_unmet;
 390         struct list_head physical_node_list;
 391         struct mutex physical_node_lock;
 392         void (*remove)(struct acpi_device *);
 393 };
 394
 395 /* Non-device subnode */
 396 struct acpi_data_node {
 397         const char *name;
 398         acpi_handle handle;
 399         struct fwnode_handle fwnode;
 400         struct fwnode_handle *parent;
 401         struct acpi_device_data data;
 402         struct list_head sibling;
 403         struct kobject kobj;
 404         struct completion kobj_done;
 405 };
 406
 407 extern const struct fwnode_operations acpi_device_fwnode_ops;
 408 extern const struct fwnode_operations acpi_data_fwnode_ops;
 409 extern const struct fwnode_operations acpi_static_fwnode_ops;
 410
 411 bool is_acpi_device_node(const struct fwnode_handle *fwnode);
 412 bool is_acpi_data_node(const struct fwnode_handle *fwnode);
 413
 414 static inline bool is_acpi_node(const struct fwnode_handle *fwnode)
 415 {
 416         return (is_acpi_device_node(fwnode) || is_acpi_data_node(fwnode));
 417 }
 418
 419 #define to_acpi_device_node(__fwnode)                                   \
 420         ({                                                              \
 421                 typeof(__fwnode) __to_acpi_device_node_fwnode = __fwnode; \
 422                                                                         \
 423                 is_acpi_device_node(__to_acpi_device_node_fwnode) ?     \
 424                         container_of(__to_acpi_device_node_fwnode,      \
 425                                      struct acpi_device, fwnode) :      \
 426                         NULL;                                           \
 427         })
 428
 429 #define to_acpi_data_node(__fwnode)                                     \
 430         ({                                                              \
 431                 typeof(__fwnode) __to_acpi_data_node_fwnode = __fwnode; \
 432                                                                         \
 433                 is_acpi_data_node(__to_acpi_data_node_fwnode) ?         \
 434                         container_of(__to_acpi_data_node_fwnode,        \
 435                                      struct acpi_data_node, fwnode) :   \
 436                         NULL;                                           \
 437         })
 438
 439 static inline bool is_acpi_static_node(const struct fwnode_handle *fwnode)
 440 {
 441         return !IS_ERR_OR_NULL(fwnode) &&
 442                 fwnode->ops == &acpi_static_fwnode_ops;
 443 }
 444
 445 static inline bool acpi_data_node_match(const struct fwnode_handle *fwnode,
 446                                         const char *name)
 447 {
 448         return is_acpi_data_node(fwnode) ?
 449                 (!strcmp(to_acpi_data_node(fwnode)->name, name)) : false;
 450 }
 451
 452 static inline struct fwnode_handle *acpi_fwnode_handle(struct acpi_device *adev)
 453 {
 454         return &adev->fwnode;
 455 }
 456
 457 static inline void *acpi_driver_data(struct acpi_device *d)
 458 {
 459         return d->driver_data;
 460 }
 461
 462 #define to_acpi_device(d)       container_of(d, struct acpi_device, dev)
 463 #define to_acpi_driver(d)       container_of(d, struct acpi_driver, drv)
 464
 465 static inline struct acpi_device *acpi_dev_parent(struct acpi_device *adev)
 466 {
 467         if (adev->dev.parent)
 468                 return to_acpi_device(adev->dev.parent);
 469
 470         return NULL;
 471 }
 472
 473 static inline void acpi_set_device_status(struct acpi_device *adev, u32 sta)
 474 {
 475         *((u32 *)&adev->status) = sta;
 476 }
 477
 478 static inline void acpi_set_hp_context(struct acpi_device *adev,
 479                                        struct acpi_hotplug_context *hp)
 480 {
 481         hp->self = adev;
 482         adev->hp = hp;
 483 }
 484
 485 void acpi_initialize_hp_context(struct acpi_device *adev,
 486                                 struct acpi_hotplug_context *hp,
 487                                 int (*notify)(struct acpi_device *, u32),
 488                                 void (*uevent)(struct acpi_device *, u32));
 489
 490 /* acpi_device.dev.bus == &acpi_bus_type */
 491 extern struct bus_type acpi_bus_type;
 492
 493 int acpi_bus_for_each_dev(int (*fn)(struct device *, void *), void *data);
 494 int acpi_dev_for_each_child(struct acpi_device *adev,
 495                             int (*fn)(struct acpi_device *, void *), void *data);
 496 int acpi_dev_for_each_child_reverse(struct acpi_device *adev,
 497                                     int (*fn)(struct acpi_device *, void *),
 498                                     void *data);
 499
 500 /*
 501  * Events
 502  * ------
 503  */
 504
 505 struct acpi_bus_event {
 506         struct list_head node;
 507         acpi_device_class device_class;
 508         acpi_bus_id bus_id;
 509         u32 type;
 510         u32 data;
 511 };
 512
 513 extern struct kobject *acpi_kobj;
 514 extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int);
 515 void acpi_bus_private_data_handler(acpi_handle, void *);
 516 int acpi_bus_get_private_data(acpi_handle, void **);
 517 int acpi_bus_attach_private_data(acpi_handle, void *);
 518 void acpi_bus_detach_private_data(acpi_handle);
 519 int acpi_dev_install_notify_handler(struct acpi_device *adev,
 520                                     u32 handler_type,
 521                                     acpi_notify_handler handler, void *context);
 522 void acpi_dev_remove_notify_handler(struct acpi_device *adev,
 523                                     u32 handler_type,
 524                                     acpi_notify_handler handler);
 525 extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32);
 526 extern int register_acpi_notifier(struct notifier_block *);
 527 extern int unregister_acpi_notifier(struct notifier_block *);
 528
 529 /*
 530  * External Functions
 531  */
 532
 533 acpi_status acpi_bus_get_status_handle(acpi_handle handle,
 534                                        unsigned long long *sta);
 535 int acpi_bus_get_status(struct acpi_device *device);
 536
 537 int acpi_bus_set_power(acpi_handle handle, int state);
 538 const char *acpi_power_state_string(int state);
 539 int acpi_device_set_power(struct acpi_device *device, int state);
 540 int acpi_bus_init_power(struct acpi_device *device);
 541 int acpi_device_fix_up_power(struct acpi_device *device);
 542 void acpi_device_fix_up_power_extended(struct acpi_device *adev);
 543 void acpi_device_fix_up_power_children(struct acpi_device *adev);
 544 int acpi_bus_update_power(acpi_handle handle, int *state_p);
 545 int acpi_device_update_power(struct acpi_device *device, int *state_p);
 546 bool acpi_bus_power_manageable(acpi_handle handle);
 547 void acpi_dev_power_up_children_with_adr(struct acpi_device *adev);
 548 u8 acpi_dev_power_state_for_wake(struct acpi_device *adev);
 549 int acpi_device_power_add_dependent(struct acpi_device *adev,
 550                                     struct device *dev);
 551 void acpi_device_power_remove_dependent(struct acpi_device *adev,
 552                                         struct device *dev);
 553
 554 #ifdef CONFIG_PM
 555 bool acpi_bus_can_wakeup(acpi_handle handle);
 556 #else
 557 static inline bool acpi_bus_can_wakeup(acpi_handle handle) { return false; }
 558 #endif
 559
 560 void acpi_scan_lock_acquire(void);
 561 void acpi_scan_lock_release(void);
 562 void acpi_lock_hp_context(void);
 563 void acpi_unlock_hp_context(void);
 564 int acpi_scan_add_handler(struct acpi_scan_handler *handler);
 565 int acpi_bus_register_driver(struct acpi_driver *driver);
 566 void acpi_bus_unregister_driver(struct acpi_driver *driver);
 567 int acpi_bus_scan(acpi_handle handle);
 568 void acpi_bus_trim(struct acpi_device *start);
 569 acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
 570 int acpi_match_device_ids(struct acpi_device *device,
 571                           const struct acpi_device_id *ids);
 572 void acpi_set_modalias(struct acpi_device *adev, const char *default_id,
 573                        char *modalias, size_t len);
 574
 575 static inline bool acpi_device_enumerated(struct acpi_device *adev)
 576 {
 577         return adev && adev->flags.initialized && adev->flags.visited;
 578 }
 579
 580 /**
 581  * module_acpi_driver(acpi_driver) - Helper macro for registering an ACPI driver
 582  * @__acpi_driver: acpi_driver struct
 583  *
 584  * Helper macro for ACPI drivers which do not do anything special in module
 585  * init/exit. This eliminates a lot of boilerplate. Each module may only
 586  * use this macro once, and calling it replaces module_init() and module_exit()
 587  */
 588 #define module_acpi_driver(__acpi_driver) \
 589         module_driver(__acpi_driver, acpi_bus_register_driver, \
 590                       acpi_bus_unregister_driver)
 591
 592 /*
 593  * Bind physical devices with ACPI devices
 594  */
 595 struct acpi_bus_type {
 596         struct list_head list;
 597         const char *name;
 598         bool (*match)(struct device *dev);
 599         struct acpi_device * (*find_companion)(struct device *);
 600         void (*setup)(struct device *);
 601 };
 602 int register_acpi_bus_type(struct acpi_bus_type *);
 603 int unregister_acpi_bus_type(struct acpi_bus_type *);
 604 int acpi_bind_one(struct device *dev, struct acpi_device *adev);
 605 int acpi_unbind_one(struct device *dev);
 606
 607 enum acpi_bridge_type {
 608         ACPI_BRIDGE_TYPE_PCIE = 1,
 609         ACPI_BRIDGE_TYPE_CXL,
 610 };
 611
 612 struct acpi_pci_root {
 613         struct acpi_device * device;
 614         struct pci_bus *bus;
 615         u16 segment;
 616         int bridge_type;
 617         struct resource secondary;      /* downstream bus range */
 618
 619         u32 osc_support_set;            /* _OSC state of support bits */
 620         u32 osc_control_set;            /* _OSC state of control bits */
 621         u32 osc_ext_support_set;        /* _OSC state of extended support bits */
 622         u32 osc_ext_control_set;        /* _OSC state of extended control bits */
 623         phys_addr_t mcfg_addr;
 624 };
 625
 626 /* helper */
 627
 628 bool acpi_dma_supported(const struct acpi_device *adev);
 629 enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev);
 630 int acpi_iommu_fwspec_init(struct device *dev, u32 id,
 631                            struct fwnode_handle *fwnode,
 632                            const struct iommu_ops *ops);
 633 int acpi_dma_get_range(struct device *dev, const struct bus_dma_region **map);
 634 int acpi_dma_configure_id(struct device *dev, enum dev_dma_attr attr,
 635                            const u32 *input_id);
 636 static inline int acpi_dma_configure(struct device *dev,
 637                                      enum dev_dma_attr attr)
 638 {
 639         return acpi_dma_configure_id(dev, attr, NULL);
 640 }
 641 struct acpi_device *acpi_find_child_device(struct acpi_device *parent,
 642                                            u64 address, bool check_children);
 643 struct acpi_device *acpi_find_child_by_adr(struct acpi_device *adev,
 644                                            acpi_bus_address adr);
 645 int acpi_is_root_bridge(acpi_handle);
 646 struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle);
 647
 648 int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state);
 649 int acpi_disable_wakeup_device_power(struct acpi_device *dev);
 650
 651 #ifdef CONFIG_X86
 652 bool acpi_device_override_status(struct acpi_device *adev, unsigned long long *status);
 653 bool acpi_quirk_skip_acpi_ac_and_battery(void);
 654 int acpi_install_cmos_rtc_space_handler(acpi_handle handle);
 655 void acpi_remove_cmos_rtc_space_handler(acpi_handle handle);
 656 #else
 657 static inline bool acpi_device_override_status(struct acpi_device *adev,
 658                                                unsigned long long *status)
 659 {
 660         return false;
 661 }
 662 static inline bool acpi_quirk_skip_acpi_ac_and_battery(void)
 663 {
 664         return false;
 665 }
 666 static inline int acpi_install_cmos_rtc_space_handler(acpi_handle handle)
 667 {
 668         return 1;
 669 }
 670 static inline void acpi_remove_cmos_rtc_space_handler(acpi_handle handle)
 671 {
 672 }
 673 #endif
 674
 675 #if IS_ENABLED(CONFIG_X86_ANDROID_TABLETS)
 676 bool acpi_quirk_skip_i2c_client_enumeration(struct acpi_device *adev);
 677 int acpi_quirk_skip_serdev_enumeration(struct device *controller_parent, bool *skip);
 678 bool acpi_quirk_skip_gpio_event_handlers(void);
 679 #else
 680 static inline bool acpi_quirk_skip_i2c_client_enumeration(struct acpi_device *adev)
 681 {
 682         return false;
 683 }
 684 static inline int
 685 acpi_quirk_skip_serdev_enumeration(struct device *controller_parent, bool *skip)
 686 {
 687         *skip = false;
 688         return 0;
 689 }
 690 static inline bool acpi_quirk_skip_gpio_event_handlers(void)
 691 {
 692         return false;
 693 }
 694 #endif
 695
 696 #ifdef CONFIG_PM
 697 void acpi_pm_wakeup_event(struct device *dev);
 698 acpi_status acpi_add_pm_notifier(struct acpi_device *adev, struct device *dev,
 699                         void (*func)(struct acpi_device_wakeup_context *context));
 700 acpi_status acpi_remove_pm_notifier(struct acpi_device *adev);
 701 bool acpi_pm_device_can_wakeup(struct device *dev);
 702 int acpi_pm_device_sleep_state(struct device *, int *, int);
 703 int acpi_pm_set_device_wakeup(struct device *dev, bool enable);
 704 #else
 705 static inline void acpi_pm_wakeup_event(struct device *dev)
 706 {
 707 }
 708 static inline acpi_status acpi_add_pm_notifier(struct acpi_device *adev,
 709                                                struct device *dev,
 710                                                void (*func)(struct acpi_device_wakeup_context *context))
 711 {
 712         return AE_SUPPORT;
 713 }
 714 static inline acpi_status acpi_remove_pm_notifier(struct acpi_device *adev)
 715 {
 716         return AE_SUPPORT;
 717 }
 718 static inline bool acpi_pm_device_can_wakeup(struct device *dev)
 719 {
 720         return false;
 721 }
 722 static inline int acpi_pm_device_sleep_state(struct device *d, int *p, int m)
 723 {
 724         if (p)
 725                 *p = ACPI_STATE_D0;
 726
 727         return (m >= ACPI_STATE_D0 && m <= ACPI_STATE_D3_COLD) ?
 728                 m : ACPI_STATE_D0;
 729 }
 730 static inline int acpi_pm_set_device_wakeup(struct device *dev, bool enable)
 731 {
 732         return -ENODEV;
 733 }
 734 #endif
 735
 736 #ifdef CONFIG_ACPI_SYSTEM_POWER_STATES_SUPPORT
 737 bool acpi_sleep_state_supported(u8 sleep_state);
 738 #else
 739 static inline bool acpi_sleep_state_supported(u8 sleep_state) { return false; }
 740 #endif
 741
 742 #ifdef CONFIG_ACPI_SLEEP
 743 u32 acpi_target_system_state(void);
 744 #else
 745 static inline u32 acpi_target_system_state(void) { return ACPI_STATE_S0; }
 746 #endif
 747
 748 static inline bool acpi_device_power_manageable(struct acpi_device *adev)
 749 {
 750         return adev->flags.power_manageable;
 751 }
 752
 753 static inline bool acpi_device_can_wakeup(struct acpi_device *adev)
 754 {
 755         return adev->wakeup.flags.valid;
 756 }
 757
 758 static inline bool acpi_device_can_poweroff(struct acpi_device *adev)
 759 {
 760         return adev->power.states[ACPI_STATE_D3_COLD].flags.valid ||
 761                 ((acpi_gbl_FADT.header.revision < 6) &&
 762                 adev->power.states[ACPI_STATE_D3_HOT].flags.explicit_set);
 763 }
 764
 765 int acpi_dev_uid_to_integer(struct acpi_device *adev, u64 *integer);
 766
 767 static inline bool acpi_dev_hid_match(struct acpi_device *adev, const char *hid2)
 768 {
 769         const char *hid1 = acpi_device_hid(adev);
 770
 771         return hid1 && hid2 && !strcmp(hid1, hid2);
 772 }
 773
 774 static inline bool acpi_str_uid_match(struct acpi_device *adev, const char *uid2)
 775 {
 776         const char *uid1 = acpi_device_uid(adev);
 777
 778         return uid1 && uid2 && !strcmp(uid1, uid2);
 779 }
 780
 781 static inline bool acpi_int_uid_match(struct acpi_device *adev, u64 uid2)
 782 {
 783         u64 uid1;
 784
 785         return !acpi_dev_uid_to_integer(adev, &uid1) && uid1 == uid2;
 786 }
 787
 788 #define TYPE_ENTRY(type, x)                     \
 789         const type: x,                          \
 790         type: x
 791
 792 #define ACPI_STR_TYPES(match)                   \
 793         TYPE_ENTRY(unsigned char *, match),     \
 794         TYPE_ENTRY(signed char *, match),               \
 795         TYPE_ENTRY(char *, match),              \
 796         TYPE_ENTRY(void *, match)
 797
 798 /**
 799  * acpi_dev_uid_match - Match device by supplied UID
 800  * @adev: ACPI device to match.
 801  * @uid2: Unique ID of the device.
 802  *
 803  * Matches UID in @adev with given @uid2.
 804  *
 805  * Returns: %true if matches, %false otherwise.
 806  */
 807 #define acpi_dev_uid_match(adev, uid2)                                  \
 808         _Generic(uid2,                                                  \
 809                  /* Treat @uid2 as a string for acpi string types */    \
 810                  ACPI_STR_TYPES(acpi_str_uid_match),                    \
 811                  /* Treat as an integer otherwise */                    \
 812                  default: acpi_int_uid_match)(adev, uid2)
 813
 814 /**
 815  * acpi_dev_hid_uid_match - Match device by supplied HID and UID
 816  * @adev: ACPI device to match.
 817  * @hid2: Hardware ID of the device.
 818  * @uid2: Unique ID of the device, pass 0 or NULL to not check _UID.
 819  *
 820  * Matches HID and UID in @adev with given @hid2 and @uid2. Absence of @uid2
 821  * will be treated as a match. If user wants to validate @uid2, it should be
 822  * done before calling this function.
 823  *
 824  * Returns: %true if matches or @uid2 is 0 or NULL, %false otherwise.
 825  */
 826 #define acpi_dev_hid_uid_match(adev, hid2, uid2)                        \
 827         (acpi_dev_hid_match(adev, hid2) &&                              \
 828                 (!(uid2) || acpi_dev_uid_match(adev, uid2)))
 829
 830 void acpi_dev_clear_dependencies(struct acpi_device *supplier);
 831 bool acpi_dev_ready_for_enumeration(const struct acpi_device *device);
 832 struct acpi_device *acpi_dev_get_next_consumer_dev(struct acpi_device *supplier,
 833                                                    struct acpi_device *start);
 834
 835 /**
 836  * for_each_acpi_consumer_dev - iterate over the consumer ACPI devices for a
 837  *                              given supplier
 838  * @supplier: Pointer to the supplier's ACPI device
 839  * @consumer: Pointer to &struct acpi_device to hold the consumer, initially NULL
 840  */
 841 #define for_each_acpi_consumer_dev(supplier, consumer)                  \
 842         for (consumer = acpi_dev_get_next_consumer_dev(supplier, NULL); \
 843              consumer;                                                  \
 844              consumer = acpi_dev_get_next_consumer_dev(supplier, consumer))
 845
 846 struct acpi_device *
 847 acpi_dev_get_next_match_dev(struct acpi_device *adev, const char *hid, const char *uid, s64 hrv);
 848 struct acpi_device *
 849 acpi_dev_get_first_match_dev(const char *hid, const char *uid, s64 hrv);
 850
 851 /**
 852  * for_each_acpi_dev_match - iterate over ACPI devices that matching the criteria
 853  * @adev: pointer to the matching ACPI device, NULL at the end of the loop
 854  * @hid: Hardware ID of the device.
 855  * @uid: Unique ID of the device, pass NULL to not check _UID
 856  * @hrv: Hardware Revision of the device, pass -1 to not check _HRV
 857  *
 858  * The caller is responsible for invoking acpi_dev_put() on the returned device.
 859  */
 860 #define for_each_acpi_dev_match(adev, hid, uid, hrv)                    \
 861         for (adev = acpi_dev_get_first_match_dev(hid, uid, hrv);        \
 862              adev;                                                      \
 863              adev = acpi_dev_get_next_match_dev(adev, hid, uid, hrv))
 864
 865 static inline struct acpi_device *acpi_dev_get(struct acpi_device *adev)
 866 {
 867         return adev ? to_acpi_device(get_device(&adev->dev)) : NULL;
 868 }
 869
 870 static inline void acpi_dev_put(struct acpi_device *adev)
 871 {
 872         if (adev)
 873                 put_device(&adev->dev);
 874 }
 875
 876 struct acpi_device *acpi_fetch_acpi_dev(acpi_handle handle);
 877 struct acpi_device *acpi_get_acpi_dev(acpi_handle handle);
 878
 879 static inline void acpi_put_acpi_dev(struct acpi_device *adev)
 880 {
 881         acpi_dev_put(adev);
 882 }
 883 #else   /* CONFIG_ACPI */
 884
 885 static inline int register_acpi_bus_type(void *bus) { return 0; }
 886 static inline int unregister_acpi_bus_type(void *bus) { return 0; }
 887
 888 #endif                          /* CONFIG_ACPI */
 889
 890 #endif /*__ACPI_BUS_H__*/