include/acpi/acpi_bus.h

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