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