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