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_NUM_OF,
 384         ACPI_DEVICE_SWNODE_DEV_NUM_ENTRIES
 385 };
 386
 387 enum acpi_device_swnode_port_props {
 388         ACPI_DEVICE_SWNODE_PORT_REG,
 389         ACPI_DEVICE_SWNODE_PORT_NUM_OF,
 390         ACPI_DEVICE_SWNODE_PORT_NUM_ENTRIES
 391 };
 392
 393 enum acpi_device_swnode_ep_props {
 394         ACPI_DEVICE_SWNODE_EP_REMOTE_EP,
 395         ACPI_DEVICE_SWNODE_EP_BUS_TYPE,
 396         ACPI_DEVICE_SWNODE_EP_REG,
 397         ACPI_DEVICE_SWNODE_EP_CLOCK_LANES,
 398         ACPI_DEVICE_SWNODE_EP_DATA_LANES,
 399         ACPI_DEVICE_SWNODE_EP_LANE_POLARITIES,
 400         /* TX only */
 401         ACPI_DEVICE_SWNODE_EP_LINK_FREQUENCIES,
 402         ACPI_DEVICE_SWNODE_EP_NUM_OF,
 403         ACPI_DEVICE_SWNODE_EP_NUM_ENTRIES
 404 };
 405
 406 /*
 407  * Each device has a root software node plus two times as many nodes as the
 408  * number of CSI-2 ports.
 409  */
 410 #define ACPI_DEVICE_SWNODE_PORT(port)   (2 * (port) + 1)
 411 #define ACPI_DEVICE_SWNODE_EP(endpoint) \
 412                 (ACPI_DEVICE_SWNODE_PORT(endpoint) + 1)
 413
 414 /**
 415  * struct acpi_device_software_node_port - MIPI DisCo for Imaging CSI-2 port
 416  * @port_name: Port name.
 417  * @data_lanes: "data-lanes" property values.
 418  * @lane_polarities: "lane-polarities" property values.
 419  * @link_frequencies: "link_frequencies" property values.
 420  * @port_nr: Port number.
 421  * @crs_crs2_local: _CRS CSI2 record present (i.e. this is a transmitter one).
 422  * @port_props: Port properties.
 423  * @ep_props: Endpoint properties.
 424  * @remote_ep: Reference to the remote endpoint.
 425  */
 426 struct acpi_device_software_node_port {
 427         char port_name[ACPI_DEVICE_SWNODE_PORT_NAME_LENGTH + 1];
 428         u32 data_lanes[ACPI_DEVICE_CSI2_DATA_LANES];
 429         u32 lane_polarities[ACPI_DEVICE_CSI2_DATA_LANES + 1 /* clock lane */];
 430         u64 link_frequencies[ACPI_DEVICE_CSI2_DATA_LANES];
 431         unsigned int port_nr;
 432         bool crs_csi2_local;
 433
 434         struct property_entry port_props[ACPI_DEVICE_SWNODE_PORT_NUM_ENTRIES];
 435         struct property_entry ep_props[ACPI_DEVICE_SWNODE_EP_NUM_ENTRIES];
 436
 437         struct software_node_ref_args remote_ep[1];
 438 };
 439
 440 /**
 441  * struct acpi_device_software_nodes - Software nodes for an ACPI device
 442  * @dev_props: Device properties.
 443  * @nodes: Software nodes for root as well as ports and endpoints.
 444  * @nodeprts: Array of software node pointers, for (un)registering them.
 445  * @ports: Information related to each port and endpoint within a port.
 446  * @num_ports: The number of ports.
 447  */
 448 struct acpi_device_software_nodes {
 449         struct property_entry dev_props[ACPI_DEVICE_SWNODE_DEV_NUM_ENTRIES];
 450         struct software_node *nodes;
 451         const struct software_node **nodeptrs;
 452         struct acpi_device_software_node_port *ports;
 453         unsigned int num_ports;
 454 };
 455
 456 /* Device */
 457 struct acpi_device {
 458         u32 pld_crc;
 459         int device_type;
 460         acpi_handle handle;             /* no handle for fixed hardware */
 461         struct fwnode_handle fwnode;
 462         struct list_head wakeup_list;
 463         struct list_head del_list;
 464         struct acpi_device_status status;
 465         struct acpi_device_flags flags;
 466         struct acpi_device_pnp pnp;
 467         struct acpi_device_power power;
 468         struct acpi_device_wakeup wakeup;
 469         struct acpi_device_perf performance;
 470         struct acpi_device_dir dir;
 471         struct acpi_device_data data;
 472         struct acpi_scan_handler *handler;
 473         struct acpi_hotplug_context *hp;
 474         struct acpi_device_software_nodes *swnodes;
 475         const struct acpi_gpio_mapping *driver_gpios;
 476         void *driver_data;
 477         struct device dev;
 478         unsigned int physical_node_count;
 479         unsigned int dep_unmet;
 480         struct list_head physical_node_list;
 481         struct mutex physical_node_lock;
 482         void (*remove)(struct acpi_device *);
 483 };
 484
 485 /* Non-device subnode */
 486 struct acpi_data_node {
 487         const char *name;
 488         acpi_handle handle;
 489         struct fwnode_handle fwnode;
 490         struct fwnode_handle *parent;
 491         struct acpi_device_data data;
 492         struct list_head sibling;
 493         struct kobject kobj;
 494         struct completion kobj_done;
 495 };
 496
 497 extern const struct fwnode_operations acpi_device_fwnode_ops;
 498 extern const struct fwnode_operations acpi_data_fwnode_ops;
 499 extern const struct fwnode_operations acpi_static_fwnode_ops;
 500
 501 bool is_acpi_device_node(const struct fwnode_handle *fwnode);
 502 bool is_acpi_data_node(const struct fwnode_handle *fwnode);
 503
 504 static inline bool is_acpi_node(const struct fwnode_handle *fwnode)
 505 {
 506         return (is_acpi_device_node(fwnode) || is_acpi_data_node(fwnode));
 507 }
 508
 509 #define to_acpi_device_node(__fwnode)                                   \
 510         ({                                                              \
 511                 typeof(__fwnode) __to_acpi_device_node_fwnode = __fwnode; \
 512                                                                         \
 513                 is_acpi_device_node(__to_acpi_device_node_fwnode) ?     \
 514                         container_of(__to_acpi_device_node_fwnode,      \
 515                                      struct acpi_device, fwnode) :      \
 516                         NULL;                                           \
 517         })
 518
 519 #define to_acpi_data_node(__fwnode)                                     \
 520         ({                                                              \
 521                 typeof(__fwnode) __to_acpi_data_node_fwnode = __fwnode; \
 522                                                                         \
 523                 is_acpi_data_node(__to_acpi_data_node_fwnode) ?         \
 524                         container_of(__to_acpi_data_node_fwnode,        \
 525                                      struct acpi_data_node, fwnode) :   \
 526                         NULL;                                           \
 527         })
 528
 529 static inline bool is_acpi_static_node(const struct fwnode_handle *fwnode)
 530 {
 531         return !IS_ERR_OR_NULL(fwnode) &&
 532                 fwnode->ops == &acpi_static_fwnode_ops;
 533 }
 534
 535 static inline bool acpi_data_node_match(const struct fwnode_handle *fwnode,
 536                                         const char *name)
 537 {
 538         return is_acpi_data_node(fwnode) ?
 539                 (!strcmp(to_acpi_data_node(fwnode)->name, name)) : false;
 540 }
 541
 542 static inline struct fwnode_handle *acpi_fwnode_handle(struct acpi_device *adev)
 543 {
 544         return &adev->fwnode;
 545 }
 546
 547 static inline void *acpi_driver_data(struct acpi_device *d)
 548 {
 549         return d->driver_data;
 550 }
 551
 552 #define to_acpi_device(d)       container_of(d, struct acpi_device, dev)
 553 #define to_acpi_driver(d)       container_of(d, struct acpi_driver, drv)
 554
 555 static inline struct acpi_device *acpi_dev_parent(struct acpi_device *adev)
 556 {
 557         if (adev->dev.parent)
 558                 return to_acpi_device(adev->dev.parent);
 559
 560         return NULL;
 561 }
 562
 563 static inline void acpi_set_device_status(struct acpi_device *adev, u32 sta)
 564 {
 565         *((u32 *)&adev->status) = sta;
 566 }
 567
 568 static inline void acpi_set_hp_context(struct acpi_device *adev,
 569                                        struct acpi_hotplug_context *hp)
 570 {
 571         hp->self = adev;
 572         adev->hp = hp;
 573 }
 574
 575 void acpi_initialize_hp_context(struct acpi_device *adev,
 576                                 struct acpi_hotplug_context *hp,
 577                                 int (*notify)(struct acpi_device *, u32),
 578                                 void (*uevent)(struct acpi_device *, u32));
 579
 580 /* acpi_device.dev.bus == &acpi_bus_type */
 581 extern struct bus_type acpi_bus_type;
 582
 583 int acpi_bus_for_each_dev(int (*fn)(struct device *, void *), void *data);
 584 int acpi_dev_for_each_child(struct acpi_device *adev,
 585                             int (*fn)(struct acpi_device *, void *), void *data);
 586 int acpi_dev_for_each_child_reverse(struct acpi_device *adev,
 587                                     int (*fn)(struct acpi_device *, void *),
 588                                     void *data);
 589
 590 /*
 591  * Events
 592  * ------
 593  */
 594
 595 struct acpi_bus_event {
 596         struct list_head node;
 597         acpi_device_class device_class;
 598         acpi_bus_id bus_id;
 599         u32 type;
 600         u32 data;
 601 };
 602
 603 extern struct kobject *acpi_kobj;
 604 extern int acpi_bus_generate_netlink_event(const char*, const char*, u8, int);
 605 void acpi_bus_private_data_handler(acpi_handle, void *);
 606 int acpi_bus_get_private_data(acpi_handle, void **);
 607 int acpi_bus_attach_private_data(acpi_handle, void *);
 608 void acpi_bus_detach_private_data(acpi_handle);
 609 int acpi_dev_install_notify_handler(struct acpi_device *adev,
 610                                     u32 handler_type,
 611                                     acpi_notify_handler handler, void *context);
 612 void acpi_dev_remove_notify_handler(struct acpi_device *adev,
 613                                     u32 handler_type,
 614                                     acpi_notify_handler handler);
 615 extern int acpi_notifier_call_chain(struct acpi_device *, u32, u32);
 616 extern int register_acpi_notifier(struct notifier_block *);
 617 extern int unregister_acpi_notifier(struct notifier_block *);
 618
 619 /*
 620  * External Functions
 621  */
 622
 623 acpi_status acpi_bus_get_status_handle(acpi_handle handle,
 624                                        unsigned long long *sta);
 625 int acpi_bus_get_status(struct acpi_device *device);
 626
 627 int acpi_bus_set_power(acpi_handle handle, int state);
 628 const char *acpi_power_state_string(int state);
 629 int acpi_device_set_power(struct acpi_device *device, int state);
 630 int acpi_bus_init_power(struct acpi_device *device);
 631 int acpi_device_fix_up_power(struct acpi_device *device);
 632 void acpi_device_fix_up_power_extended(struct acpi_device *adev);
 633 int acpi_bus_update_power(acpi_handle handle, int *state_p);
 634 int acpi_device_update_power(struct acpi_device *device, int *state_p);
 635 bool acpi_bus_power_manageable(acpi_handle handle);
 636 void acpi_dev_power_up_children_with_adr(struct acpi_device *adev);
 637 u8 acpi_dev_power_state_for_wake(struct acpi_device *adev);
 638 int acpi_device_power_add_dependent(struct acpi_device *adev,
 639                                     struct device *dev);
 640 void acpi_device_power_remove_dependent(struct acpi_device *adev,
 641                                         struct device *dev);
 642
 643 #ifdef CONFIG_PM
 644 bool acpi_bus_can_wakeup(acpi_handle handle);
 645 #else
 646 static inline bool acpi_bus_can_wakeup(acpi_handle handle) { return false; }
 647 #endif
 648
 649 void acpi_scan_lock_acquire(void);
 650 void acpi_scan_lock_release(void);
 651 void acpi_lock_hp_context(void);
 652 void acpi_unlock_hp_context(void);
 653 int acpi_scan_add_handler(struct acpi_scan_handler *handler);
 654 int acpi_bus_register_driver(struct acpi_driver *driver);
 655 void acpi_bus_unregister_driver(struct acpi_driver *driver);
 656 int acpi_bus_scan(acpi_handle handle);
 657 void acpi_bus_trim(struct acpi_device *start);
 658 acpi_status acpi_bus_get_ejd(acpi_handle handle, acpi_handle * ejd);
 659 int acpi_match_device_ids(struct acpi_device *device,
 660                           const struct acpi_device_id *ids);
 661 void acpi_set_modalias(struct acpi_device *adev, const char *default_id,
 662                        char *modalias, size_t len);
 663
 664 static inline bool acpi_device_enumerated(struct acpi_device *adev)
 665 {
 666         return adev && adev->flags.initialized && adev->flags.visited;
 667 }
 668
 669 /**
 670  * module_acpi_driver(acpi_driver) - Helper macro for registering an ACPI driver
 671  * @__acpi_driver: acpi_driver struct
 672  *
 673  * Helper macro for ACPI drivers which do not do anything special in module
 674  * init/exit. This eliminates a lot of boilerplate. Each module may only
 675  * use this macro once, and calling it replaces module_init() and module_exit()
 676  */
 677 #define module_acpi_driver(__acpi_driver) \
 678         module_driver(__acpi_driver, acpi_bus_register_driver, \
 679                       acpi_bus_unregister_driver)
 680
 681 /*
 682  * Bind physical devices with ACPI devices
 683  */
 684 struct acpi_bus_type {
 685         struct list_head list;
 686         const char *name;
 687         bool (*match)(struct device *dev);
 688         struct acpi_device * (*find_companion)(struct device *);
 689         void (*setup)(struct device *);
 690 };
 691 int register_acpi_bus_type(struct acpi_bus_type *);
 692 int unregister_acpi_bus_type(struct acpi_bus_type *);
 693 int acpi_bind_one(struct device *dev, struct acpi_device *adev);
 694 int acpi_unbind_one(struct device *dev);
 695
 696 enum acpi_bridge_type {
 697         ACPI_BRIDGE_TYPE_PCIE = 1,
 698         ACPI_BRIDGE_TYPE_CXL,
 699 };
 700
 701 struct acpi_pci_root {
 702         struct acpi_device * device;
 703         struct pci_bus *bus;
 704         u16 segment;
 705         int bridge_type;
 706         struct resource secondary;      /* downstream bus range */
 707
 708         u32 osc_support_set;            /* _OSC state of support bits */
 709         u32 osc_control_set;            /* _OSC state of control bits */
 710         u32 osc_ext_support_set;        /* _OSC state of extended support bits */
 711         u32 osc_ext_control_set;        /* _OSC state of extended control bits */
 712         phys_addr_t mcfg_addr;
 713 };
 714
 715 /* helper */
 716
 717 bool acpi_dma_supported(const struct acpi_device *adev);
 718 enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev);
 719 int acpi_iommu_fwspec_init(struct device *dev, u32 id,
 720                            struct fwnode_handle *fwnode,
 721                            const struct iommu_ops *ops);
 722 int acpi_dma_get_range(struct device *dev, const struct bus_dma_region **map);
 723 int acpi_dma_configure_id(struct device *dev, enum dev_dma_attr attr,
 724                            const u32 *input_id);
 725 static inline int acpi_dma_configure(struct device *dev,
 726                                      enum dev_dma_attr attr)
 727 {
 728         return acpi_dma_configure_id(dev, attr, NULL);
 729 }
 730 struct acpi_device *acpi_find_child_device(struct acpi_device *parent,
 731                                            u64 address, bool check_children);
 732 struct acpi_device *acpi_find_child_by_adr(struct acpi_device *adev,
 733                                            acpi_bus_address adr);
 734 int acpi_is_root_bridge(acpi_handle);
 735 struct acpi_pci_root *acpi_pci_find_root(acpi_handle handle);
 736
 737 int acpi_enable_wakeup_device_power(struct acpi_device *dev, int state);
 738 int acpi_disable_wakeup_device_power(struct acpi_device *dev);
 739
 740 #ifdef CONFIG_X86
 741 bool acpi_device_override_status(struct acpi_device *adev, unsigned long long *status);
 742 bool acpi_quirk_skip_acpi_ac_and_battery(void);
 743 int acpi_install_cmos_rtc_space_handler(acpi_handle handle);
 744 void acpi_remove_cmos_rtc_space_handler(acpi_handle handle);
 745 #else
 746 static inline bool acpi_device_override_status(struct acpi_device *adev,
 747                                                unsigned long long *status)
 748 {
 749         return false;
 750 }
 751 static inline bool acpi_quirk_skip_acpi_ac_and_battery(void)
 752 {
 753         return false;
 754 }
 755 static inline int acpi_install_cmos_rtc_space_handler(acpi_handle handle)
 756 {
 757         return 1;
 758 }
 759 static inline void acpi_remove_cmos_rtc_space_handler(acpi_handle handle)
 760 {
 761 }
 762 #endif
 763
 764 #if IS_ENABLED(CONFIG_X86_ANDROID_TABLETS)
 765 bool acpi_quirk_skip_i2c_client_enumeration(struct acpi_device *adev);
 766 int acpi_quirk_skip_serdev_enumeration(struct device *controller_parent, bool *skip);
 767 bool acpi_quirk_skip_gpio_event_handlers(void);
 768 #else
 769 static inline bool acpi_quirk_skip_i2c_client_enumeration(struct acpi_device *adev)
 770 {
 771         return false;
 772 }
 773 static inline int
 774 acpi_quirk_skip_serdev_enumeration(struct device *controller_parent, bool *skip)
 775 {
 776         *skip = false;
 777         return 0;
 778 }
 779 static inline bool acpi_quirk_skip_gpio_event_handlers(void)
 780 {
 781         return false;
 782 }
 783 #endif
 784
 785 #ifdef CONFIG_PM
 786 void acpi_pm_wakeup_event(struct device *dev);
 787 acpi_status acpi_add_pm_notifier(struct acpi_device *adev, struct device *dev,
 788                         void (*func)(struct acpi_device_wakeup_context *context));
 789 acpi_status acpi_remove_pm_notifier(struct acpi_device *adev);
 790 bool acpi_pm_device_can_wakeup(struct device *dev);
 791 int acpi_pm_device_sleep_state(struct device *, int *, int);
 792 int acpi_pm_set_device_wakeup(struct device *dev, bool enable);
 793 #else
 794 static inline void acpi_pm_wakeup_event(struct device *dev)
 795 {
 796 }
 797 static inline acpi_status acpi_add_pm_notifier(struct acpi_device *adev,
 798                                                struct device *dev,
 799                                                void (*func)(struct acpi_device_wakeup_context *context))
 800 {
 801         return AE_SUPPORT;
 802 }
 803 static inline acpi_status acpi_remove_pm_notifier(struct acpi_device *adev)
 804 {
 805         return AE_SUPPORT;
 806 }
 807 static inline bool acpi_pm_device_can_wakeup(struct device *dev)
 808 {
 809         return false;
 810 }
 811 static inline int acpi_pm_device_sleep_state(struct device *d, int *p, int m)
 812 {
 813         if (p)
 814                 *p = ACPI_STATE_D0;
 815
 816         return (m >= ACPI_STATE_D0 && m <= ACPI_STATE_D3_COLD) ?
 817                 m : ACPI_STATE_D0;
 818 }
 819 static inline int acpi_pm_set_device_wakeup(struct device *dev, bool enable)
 820 {
 821         return -ENODEV;
 822 }
 823 #endif
 824
 825 #ifdef CONFIG_ACPI_SYSTEM_POWER_STATES_SUPPORT
 826 bool acpi_sleep_state_supported(u8 sleep_state);
 827 #else
 828 static inline bool acpi_sleep_state_supported(u8 sleep_state) { return false; }
 829 #endif
 830
 831 #ifdef CONFIG_ACPI_SLEEP
 832 u32 acpi_target_system_state(void);
 833 #else
 834 static inline u32 acpi_target_system_state(void) { return ACPI_STATE_S0; }
 835 #endif
 836
 837 static inline bool acpi_device_power_manageable(struct acpi_device *adev)
 838 {
 839         return adev->flags.power_manageable;
 840 }
 841
 842 static inline bool acpi_device_can_wakeup(struct acpi_device *adev)
 843 {
 844         return adev->wakeup.flags.valid;
 845 }
 846
 847 static inline bool acpi_device_can_poweroff(struct acpi_device *adev)
 848 {
 849         return adev->power.states[ACPI_STATE_D3_COLD].flags.valid ||
 850                 ((acpi_gbl_FADT.header.revision < 6) &&
 851                 adev->power.states[ACPI_STATE_D3_HOT].flags.explicit_set);
 852 }
 853
 854 bool acpi_dev_uid_match(struct acpi_device *adev, const char *uid2);
 855 bool acpi_dev_hid_uid_match(struct acpi_device *adev, const char *hid2, const char *uid2);
 856 int acpi_dev_uid_to_integer(struct acpi_device *adev, u64 *integer);
 857
 858 void acpi_dev_clear_dependencies(struct acpi_device *supplier);
 859 bool acpi_dev_ready_for_enumeration(const struct acpi_device *device);
 860 struct acpi_device *acpi_dev_get_next_consumer_dev(struct acpi_device *supplier,
 861                                                    struct acpi_device *start);
 862
 863 /**
 864  * for_each_acpi_consumer_dev - iterate over the consumer ACPI devices for a
 865  *                              given supplier
 866  * @supplier: Pointer to the supplier's ACPI device
 867  * @consumer: Pointer to &struct acpi_device to hold the consumer, initially NULL
 868  */
 869 #define for_each_acpi_consumer_dev(supplier, consumer)                  \
 870         for (consumer = acpi_dev_get_next_consumer_dev(supplier, NULL); \
 871              consumer;                                                  \
 872              consumer = acpi_dev_get_next_consumer_dev(supplier, consumer))
 873
 874 struct acpi_device *
 875 acpi_dev_get_next_match_dev(struct acpi_device *adev, const char *hid, const char *uid, s64 hrv);
 876 struct acpi_device *
 877 acpi_dev_get_first_match_dev(const char *hid, const char *uid, s64 hrv);
 878
 879 /**
 880  * for_each_acpi_dev_match - iterate over ACPI devices that matching the criteria
 881  * @adev: pointer to the matching ACPI device, NULL at the end of the loop
 882  * @hid: Hardware ID of the device.
 883  * @uid: Unique ID of the device, pass NULL to not check _UID
 884  * @hrv: Hardware Revision of the device, pass -1 to not check _HRV
 885  *
 886  * The caller is responsible for invoking acpi_dev_put() on the returned device.
 887  */
 888 #define for_each_acpi_dev_match(adev, hid, uid, hrv)                    \
 889         for (adev = acpi_dev_get_first_match_dev(hid, uid, hrv);        \
 890              adev;                                                      \
 891              adev = acpi_dev_get_next_match_dev(adev, hid, uid, hrv))
 892
 893 static inline struct acpi_device *acpi_dev_get(struct acpi_device *adev)
 894 {
 895         return adev ? to_acpi_device(get_device(&adev->dev)) : NULL;
 896 }
 897
 898 static inline void acpi_dev_put(struct acpi_device *adev)
 899 {
 900         if (adev)
 901                 put_device(&adev->dev);
 902 }
 903
 904 struct acpi_device *acpi_fetch_acpi_dev(acpi_handle handle);
 905 struct acpi_device *acpi_get_acpi_dev(acpi_handle handle);
 906
 907 static inline void acpi_put_acpi_dev(struct acpi_device *adev)
 908 {
 909         acpi_dev_put(adev);
 910 }
 911 #else   /* CONFIG_ACPI */
 912
 913 static inline int register_acpi_bus_type(void *bus) { return 0; }
 914 static inline int unregister_acpi_bus_type(void *bus) { return 0; }
 915
 916 #endif                          /* CONFIG_ACPI */
 917
 918 #endif /*__ACPI_BUS_H__*/