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