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