include/linux/acpi.h

   1 /* SPDX-License-Identifier: GPL-2.0-or-later */
   2 /*
   3  * acpi.h - ACPI Interface
   4  *
   5  * Copyright (C) 2001 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
   6  */
   7
   8 #ifndef _LINUX_ACPI_H
   9 #define _LINUX_ACPI_H
  10
  11 #include <linux/errno.h>
  12 #include <linux/ioport.h>       /* for struct resource */
  13 #include <linux/resource_ext.h>
  14 #include <linux/device.h>
  15 #include <linux/mod_devicetable.h>
  16 #include <linux/property.h>
  17 #include <linux/uuid.h>
  18 #include <linux/node.h>
  19
  20 struct irq_domain;
  21 struct irq_domain_ops;
  22
  23 #ifndef _LINUX
  24 #define _LINUX
  25 #endif
  26 #include <acpi/acpi.h>
  27 #include <acpi/acpi_numa.h>
  28
  29 #ifdef  CONFIG_ACPI
  30
  31 #include <linux/list.h>
  32 #include <linux/dynamic_debug.h>
  33 #include <linux/module.h>
  34 #include <linux/mutex.h>
  35 #include <linux/fw_table.h>
  36
  37 #include <acpi/acpi_bus.h>
  38 #include <acpi/acpi_drivers.h>
  39 #include <acpi/acpi_io.h>
  40 #include <asm/acpi.h>
  41
  42 #ifdef CONFIG_ACPI_TABLE_LIB
  43 #define EXPORT_SYMBOL_ACPI_LIB(x) EXPORT_SYMBOL_NS_GPL(x, ACPI)
  44 #define __init_or_acpilib
  45 #define __initdata_or_acpilib
  46 #else
  47 #define EXPORT_SYMBOL_ACPI_LIB(x)
  48 #define __init_or_acpilib __init
  49 #define __initdata_or_acpilib __initdata
  50 #endif
  51
  52 static inline acpi_handle acpi_device_handle(struct acpi_device *adev)
  53 {
  54         return adev ? adev->handle : NULL;
  55 }
  56
  57 #define ACPI_COMPANION(dev)             to_acpi_device_node((dev)->fwnode)
  58 #define ACPI_COMPANION_SET(dev, adev)   set_primary_fwnode(dev, (adev) ? \
  59         acpi_fwnode_handle(adev) : NULL)
  60 #define ACPI_HANDLE(dev)                acpi_device_handle(ACPI_COMPANION(dev))
  61 #define ACPI_HANDLE_FWNODE(fwnode)      \
  62                                 acpi_device_handle(to_acpi_device_node(fwnode))
  63
  64 static inline struct fwnode_handle *acpi_alloc_fwnode_static(void)
  65 {
  66         struct fwnode_handle *fwnode;
  67
  68         fwnode = kzalloc(sizeof(struct fwnode_handle), GFP_KERNEL);
  69         if (!fwnode)
  70                 return NULL;
  71
  72         fwnode_init(fwnode, &acpi_static_fwnode_ops);
  73
  74         return fwnode;
  75 }
  76
  77 static inline void acpi_free_fwnode_static(struct fwnode_handle *fwnode)
  78 {
  79         if (WARN_ON(!is_acpi_static_node(fwnode)))
  80                 return;
  81
  82         kfree(fwnode);
  83 }
  84
  85 static inline bool has_acpi_companion(struct device *dev)
  86 {
  87         return is_acpi_device_node(dev->fwnode);
  88 }
  89
  90 static inline void acpi_preset_companion(struct device *dev,
  91                                          struct acpi_device *parent, u64 addr)
  92 {
  93         ACPI_COMPANION_SET(dev, acpi_find_child_device(parent, addr, false));
  94 }
  95
  96 static inline const char *acpi_dev_name(struct acpi_device *adev)
  97 {
  98         return dev_name(&adev->dev);
  99 }
 100
 101 struct device *acpi_get_first_physical_node(struct acpi_device *adev);
 102
 103 enum acpi_irq_model_id {
 104         ACPI_IRQ_MODEL_PIC = 0,
 105         ACPI_IRQ_MODEL_IOAPIC,
 106         ACPI_IRQ_MODEL_IOSAPIC,
 107         ACPI_IRQ_MODEL_PLATFORM,
 108         ACPI_IRQ_MODEL_GIC,
 109         ACPI_IRQ_MODEL_LPIC,
 110         ACPI_IRQ_MODEL_RINTC,
 111         ACPI_IRQ_MODEL_COUNT
 112 };
 113
 114 extern enum acpi_irq_model_id   acpi_irq_model;
 115
 116 enum acpi_interrupt_id {
 117         ACPI_INTERRUPT_PMI      = 1,
 118         ACPI_INTERRUPT_INIT,
 119         ACPI_INTERRUPT_CPEI,
 120         ACPI_INTERRUPT_COUNT
 121 };
 122
 123 #define ACPI_SPACE_MEM          0
 124
 125 enum acpi_address_range_id {
 126         ACPI_ADDRESS_RANGE_MEMORY = 1,
 127         ACPI_ADDRESS_RANGE_RESERVED = 2,
 128         ACPI_ADDRESS_RANGE_ACPI = 3,
 129         ACPI_ADDRESS_RANGE_NVS  = 4,
 130         ACPI_ADDRESS_RANGE_COUNT
 131 };
 132
 133
 134 /* Table Handlers */
 135 typedef int (*acpi_tbl_table_handler)(struct acpi_table_header *table);
 136
 137 /* Debugger support */
 138
 139 struct acpi_debugger_ops {
 140         int (*create_thread)(acpi_osd_exec_callback function, void *context);
 141         ssize_t (*write_log)(const char *msg);
 142         ssize_t (*read_cmd)(char *buffer, size_t length);
 143         int (*wait_command_ready)(bool single_step, char *buffer, size_t length);
 144         int (*notify_command_complete)(void);
 145 };
 146
 147 struct acpi_debugger {
 148         const struct acpi_debugger_ops *ops;
 149         struct module *owner;
 150         struct mutex lock;
 151 };
 152
 153 #ifdef CONFIG_ACPI_DEBUGGER
 154 int __init acpi_debugger_init(void);
 155 int acpi_register_debugger(struct module *owner,
 156                            const struct acpi_debugger_ops *ops);
 157 void acpi_unregister_debugger(const struct acpi_debugger_ops *ops);
 158 int acpi_debugger_create_thread(acpi_osd_exec_callback function, void *context);
 159 ssize_t acpi_debugger_write_log(const char *msg);
 160 ssize_t acpi_debugger_read_cmd(char *buffer, size_t buffer_length);
 161 int acpi_debugger_wait_command_ready(void);
 162 int acpi_debugger_notify_command_complete(void);
 163 #else
 164 static inline int acpi_debugger_init(void)
 165 {
 166         return -ENODEV;
 167 }
 168
 169 static inline int acpi_register_debugger(struct module *owner,
 170                                          const struct acpi_debugger_ops *ops)
 171 {
 172         return -ENODEV;
 173 }
 174
 175 static inline void acpi_unregister_debugger(const struct acpi_debugger_ops *ops)
 176 {
 177 }
 178
 179 static inline int acpi_debugger_create_thread(acpi_osd_exec_callback function,
 180                                               void *context)
 181 {
 182         return -ENODEV;
 183 }
 184
 185 static inline int acpi_debugger_write_log(const char *msg)
 186 {
 187         return -ENODEV;
 188 }
 189
 190 static inline int acpi_debugger_read_cmd(char *buffer, u32 buffer_length)
 191 {
 192         return -ENODEV;
 193 }
 194
 195 static inline int acpi_debugger_wait_command_ready(void)
 196 {
 197         return -ENODEV;
 198 }
 199
 200 static inline int acpi_debugger_notify_command_complete(void)
 201 {
 202         return -ENODEV;
 203 }
 204 #endif
 205
 206 #define BAD_MADT_ENTRY(entry, end) (                                        \
 207                 (!entry) || (unsigned long)entry + sizeof(*entry) > end ||  \
 208                 ((struct acpi_subtable_header *)entry)->length < sizeof(*entry))
 209
 210 void __iomem *__acpi_map_table(unsigned long phys, unsigned long size);
 211 void __acpi_unmap_table(void __iomem *map, unsigned long size);
 212 int early_acpi_boot_init(void);
 213 int acpi_boot_init (void);
 214 void acpi_boot_table_prepare (void);
 215 void acpi_boot_table_init (void);
 216 int acpi_mps_check (void);
 217 int acpi_numa_init (void);
 218
 219 int acpi_locate_initial_tables (void);
 220 void acpi_reserve_initial_tables (void);
 221 void acpi_table_init_complete (void);
 222 int acpi_table_init (void);
 223
 224 int acpi_table_parse(char *id, acpi_tbl_table_handler handler);
 225 int __init_or_acpilib acpi_table_parse_entries(char *id,
 226                 unsigned long table_size, int entry_id,
 227                 acpi_tbl_entry_handler handler, unsigned int max_entries);
 228 int __init_or_acpilib acpi_table_parse_entries_array(char *id,
 229                 unsigned long table_size, struct acpi_subtable_proc *proc,
 230                 int proc_num, unsigned int max_entries);
 231 int acpi_table_parse_madt(enum acpi_madt_type id,
 232                           acpi_tbl_entry_handler handler,
 233                           unsigned int max_entries);
 234 int __init_or_acpilib
 235 acpi_table_parse_cedt(enum acpi_cedt_type id,
 236                       acpi_tbl_entry_handler_arg handler_arg, void *arg);
 237
 238 int acpi_parse_mcfg (struct acpi_table_header *header);
 239 void acpi_table_print_madt_entry (struct acpi_subtable_header *madt);
 240
 241 #if defined(CONFIG_X86) || defined(CONFIG_LOONGARCH)
 242 void acpi_numa_processor_affinity_init (struct acpi_srat_cpu_affinity *pa);
 243 #else
 244 static inline void
 245 acpi_numa_processor_affinity_init(struct acpi_srat_cpu_affinity *pa) { }
 246 #endif
 247
 248 void acpi_numa_x2apic_affinity_init(struct acpi_srat_x2apic_cpu_affinity *pa);
 249
 250 #if defined(CONFIG_ARM64) || defined(CONFIG_LOONGARCH)
 251 void acpi_arch_dma_setup(struct device *dev);
 252 #else
 253 static inline void acpi_arch_dma_setup(struct device *dev) { }
 254 #endif
 255
 256 #ifdef CONFIG_ARM64
 257 void acpi_numa_gicc_affinity_init(struct acpi_srat_gicc_affinity *pa);
 258 #else
 259 static inline void
 260 acpi_numa_gicc_affinity_init(struct acpi_srat_gicc_affinity *pa) { }
 261 #endif
 262
 263 #ifdef CONFIG_RISCV
 264 void acpi_numa_rintc_affinity_init(struct acpi_srat_rintc_affinity *pa);
 265 #else
 266 static inline void acpi_numa_rintc_affinity_init(struct acpi_srat_rintc_affinity *pa) { }
 267 #endif
 268
 269 #ifndef PHYS_CPUID_INVALID
 270 typedef u32 phys_cpuid_t;
 271 #define PHYS_CPUID_INVALID (phys_cpuid_t)(-1)
 272 #endif
 273
 274 static inline bool invalid_logical_cpuid(u32 cpuid)
 275 {
 276         return (int)cpuid < 0;
 277 }
 278
 279 static inline bool invalid_phys_cpuid(phys_cpuid_t phys_id)
 280 {
 281         return phys_id == PHYS_CPUID_INVALID;
 282 }
 283
 284
 285 int __init acpi_get_madt_revision(void);
 286
 287 /* Validate the processor object's proc_id */
 288 bool acpi_duplicate_processor_id(int proc_id);
 289 /* Processor _CTS control */
 290 struct acpi_processor_power;
 291
 292 #ifdef CONFIG_ACPI_PROCESSOR_CSTATE
 293 bool acpi_processor_claim_cst_control(void);
 294 int acpi_processor_evaluate_cst(acpi_handle handle, u32 cpu,
 295                                 struct acpi_processor_power *info);
 296 #else
 297 static inline bool acpi_processor_claim_cst_control(void) { return false; }
 298 static inline int acpi_processor_evaluate_cst(acpi_handle handle, u32 cpu,
 299                                               struct acpi_processor_power *info)
 300 {
 301         return -ENODEV;
 302 }
 303 #endif
 304
 305 #ifdef CONFIG_ACPI_HOTPLUG_CPU
 306 /* Arch dependent functions for cpu hotplug support */
 307 int acpi_map_cpu(acpi_handle handle, phys_cpuid_t physid, u32 acpi_id,
 308                  int *pcpu);
 309 int acpi_unmap_cpu(int cpu);
 310 #endif /* CONFIG_ACPI_HOTPLUG_CPU */
 311
 312 acpi_handle acpi_get_processor_handle(int cpu);
 313
 314 #ifdef CONFIG_ACPI_HOTPLUG_IOAPIC
 315 int acpi_get_ioapic_id(acpi_handle handle, u32 gsi_base, u64 *phys_addr);
 316 #endif
 317
 318 int acpi_register_ioapic(acpi_handle handle, u64 phys_addr, u32 gsi_base);
 319 int acpi_unregister_ioapic(acpi_handle handle, u32 gsi_base);
 320 int acpi_ioapic_registered(acpi_handle handle, u32 gsi_base);
 321 void acpi_irq_stats_init(void);
 322 extern u32 acpi_irq_handled;
 323 extern u32 acpi_irq_not_handled;
 324 extern unsigned int acpi_sci_irq;
 325 extern bool acpi_no_s5;
 326 #define INVALID_ACPI_IRQ        ((unsigned)-1)
 327 static inline bool acpi_sci_irq_valid(void)
 328 {
 329         return acpi_sci_irq != INVALID_ACPI_IRQ;
 330 }
 331
 332 extern int sbf_port;
 333 extern unsigned long acpi_realmode_flags;
 334
 335 int acpi_register_gsi (struct device *dev, u32 gsi, int triggering, int polarity);
 336 int acpi_gsi_to_irq (u32 gsi, unsigned int *irq);
 337 int acpi_isa_irq_to_gsi (unsigned isa_irq, u32 *gsi);
 338
 339 void acpi_set_irq_model(enum acpi_irq_model_id model,
 340                         struct fwnode_handle *(*)(u32));
 341 void acpi_set_gsi_to_irq_fallback(u32 (*)(u32));
 342
 343 struct irq_domain *acpi_irq_create_hierarchy(unsigned int flags,
 344                                              unsigned int size,
 345                                              struct fwnode_handle *fwnode,
 346                                              const struct irq_domain_ops *ops,
 347                                              void *host_data);
 348
 349 #ifdef CONFIG_X86_IO_APIC
 350 extern int acpi_get_override_irq(u32 gsi, int *trigger, int *polarity);
 351 #else
 352 static inline int acpi_get_override_irq(u32 gsi, int *trigger, int *polarity)
 353 {
 354         return -1;
 355 }
 356 #endif
 357 /*
 358  * This function undoes the effect of one call to acpi_register_gsi().
 359  * If this matches the last registration, any IRQ resources for gsi
 360  * are freed.
 361  */
 362 void acpi_unregister_gsi (u32 gsi);
 363
 364 struct pci_dev;
 365
 366 struct acpi_prt_entry *acpi_pci_irq_lookup(struct pci_dev *dev, int pin);
 367 int acpi_pci_irq_enable (struct pci_dev *dev);
 368 void acpi_penalize_isa_irq(int irq, int active);
 369 bool acpi_isa_irq_available(int irq);
 370 #ifdef CONFIG_PCI
 371 void acpi_penalize_sci_irq(int irq, int trigger, int polarity);
 372 #else
 373 static inline void acpi_penalize_sci_irq(int irq, int trigger,
 374                                         int polarity)
 375 {
 376 }
 377 #endif
 378 void acpi_pci_irq_disable (struct pci_dev *dev);
 379
 380 extern int ec_read(u8 addr, u8 *val);
 381 extern int ec_write(u8 addr, u8 val);
 382 extern int ec_transaction(u8 command,
 383                           const u8 *wdata, unsigned wdata_len,
 384                           u8 *rdata, unsigned rdata_len);
 385 extern acpi_handle ec_get_handle(void);
 386
 387 extern bool acpi_is_pnp_device(struct acpi_device *);
 388
 389 #if defined(CONFIG_ACPI_WMI) || defined(CONFIG_ACPI_WMI_MODULE)
 390
 391 typedef void (*wmi_notify_handler) (union acpi_object *data, void *context);
 392
 393 int wmi_instance_count(const char *guid);
 394
 395 extern acpi_status wmi_evaluate_method(const char *guid, u8 instance,
 396                                         u32 method_id,
 397                                         const struct acpi_buffer *in,
 398                                         struct acpi_buffer *out);
 399 extern acpi_status wmi_query_block(const char *guid, u8 instance,
 400                                         struct acpi_buffer *out);
 401 extern acpi_status wmi_set_block(const char *guid, u8 instance,
 402                                         const struct acpi_buffer *in);
 403 extern acpi_status wmi_install_notify_handler(const char *guid,
 404                                         wmi_notify_handler handler, void *data);
 405 extern acpi_status wmi_remove_notify_handler(const char *guid);
 406 extern bool wmi_has_guid(const char *guid);
 407 extern char *wmi_get_acpi_device_uid(const char *guid);
 408
 409 #endif  /* CONFIG_ACPI_WMI */
 410
 411 #define ACPI_VIDEO_OUTPUT_SWITCHING                     0x0001
 412 #define ACPI_VIDEO_DEVICE_POSTING                       0x0002
 413 #define ACPI_VIDEO_ROM_AVAILABLE                        0x0004
 414 #define ACPI_VIDEO_BACKLIGHT                            0x0008
 415 #define ACPI_VIDEO_BACKLIGHT_FORCE_VENDOR               0x0010
 416 #define ACPI_VIDEO_BACKLIGHT_FORCE_VIDEO                0x0020
 417 #define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VENDOR        0x0040
 418 #define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VIDEO         0x0080
 419 #define ACPI_VIDEO_BACKLIGHT_DMI_VENDOR                 0x0100
 420 #define ACPI_VIDEO_BACKLIGHT_DMI_VIDEO                  0x0200
 421 #define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VENDOR          0x0400
 422 #define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VIDEO           0x0800
 423
 424 extern char acpi_video_backlight_string[];
 425 extern long acpi_is_video_device(acpi_handle handle);
 426
 427 extern void acpi_osi_setup(char *str);
 428 extern bool acpi_osi_is_win8(void);
 429
 430 #ifdef CONFIG_ACPI_THERMAL_LIB
 431 int thermal_acpi_active_trip_temp(struct acpi_device *adev, int id, int *ret_temp);
 432 int thermal_acpi_passive_trip_temp(struct acpi_device *adev, int *ret_temp);
 433 int thermal_acpi_hot_trip_temp(struct acpi_device *adev, int *ret_temp);
 434 int thermal_acpi_critical_trip_temp(struct acpi_device *adev, int *ret_temp);
 435 #endif
 436
 437 #ifdef CONFIG_ACPI_HMAT
 438 int acpi_get_genport_coordinates(u32 uid, struct access_coordinate *coord);
 439 #else
 440 static inline int acpi_get_genport_coordinates(u32 uid,
 441                                                struct access_coordinate *coord)
 442 {
 443         return -EOPNOTSUPP;
 444 }
 445 #endif
 446
 447 #ifdef CONFIG_ACPI_NUMA
 448 int acpi_map_pxm_to_node(int pxm);
 449 int acpi_get_node(acpi_handle handle);
 450
 451 /**
 452  * pxm_to_online_node - Map proximity ID to online node
 453  * @pxm: ACPI proximity ID
 454  *
 455  * This is similar to pxm_to_node(), but always returns an online
 456  * node.  When the mapped node from a given proximity ID is offline, it
 457  * looks up the node distance table and returns the nearest online node.
 458  *
 459  * ACPI device drivers, which are called after the NUMA initialization has
 460  * completed in the kernel, can call this interface to obtain their device
 461  * NUMA topology from ACPI tables.  Such drivers do not have to deal with
 462  * offline nodes.  A node may be offline when SRAT memory entry does not exist,
 463  * or NUMA is disabled, ex. "numa=off" on x86.
 464  */
 465 static inline int pxm_to_online_node(int pxm)
 466 {
 467         int node = pxm_to_node(pxm);
 468
 469         return numa_map_to_online_node(node);
 470 }
 471 #else
 472 static inline int pxm_to_online_node(int pxm)
 473 {
 474         return 0;
 475 }
 476 static inline int acpi_map_pxm_to_node(int pxm)
 477 {
 478         return 0;
 479 }
 480 static inline int acpi_get_node(acpi_handle handle)
 481 {
 482         return 0;
 483 }
 484 #endif
 485 extern int pnpacpi_disabled;
 486
 487 #define PXM_INVAL       (-1)
 488
 489 bool acpi_dev_resource_memory(struct acpi_resource *ares, struct resource *res);
 490 bool acpi_dev_resource_io(struct acpi_resource *ares, struct resource *res);
 491 bool acpi_dev_resource_address_space(struct acpi_resource *ares,
 492                                      struct resource_win *win);
 493 bool acpi_dev_resource_ext_address_space(struct acpi_resource *ares,
 494                                          struct resource_win *win);
 495 unsigned long acpi_dev_irq_flags(u8 triggering, u8 polarity, u8 shareable, u8 wake_capable);
 496 unsigned int acpi_dev_get_irq_type(int triggering, int polarity);
 497 bool acpi_dev_resource_interrupt(struct acpi_resource *ares, int index,
 498                                  struct resource *res);
 499
 500 void acpi_dev_free_resource_list(struct list_head *list);
 501 int acpi_dev_get_resources(struct acpi_device *adev, struct list_head *list,
 502                            int (*preproc)(struct acpi_resource *, void *),
 503                            void *preproc_data);
 504 int acpi_dev_get_dma_resources(struct acpi_device *adev,
 505                                struct list_head *list);
 506 int acpi_dev_get_memory_resources(struct acpi_device *adev, struct list_head *list);
 507 int acpi_dev_filter_resource_type(struct acpi_resource *ares,
 508                                   unsigned long types);
 509
 510 static inline int acpi_dev_filter_resource_type_cb(struct acpi_resource *ares,
 511                                                    void *arg)
 512 {
 513         return acpi_dev_filter_resource_type(ares, (unsigned long)arg);
 514 }
 515
 516 struct acpi_device *acpi_resource_consumer(struct resource *res);
 517
 518 int acpi_check_resource_conflict(const struct resource *res);
 519
 520 int acpi_check_region(resource_size_t start, resource_size_t n,
 521                       const char *name);
 522
 523 int acpi_resources_are_enforced(void);
 524
 525 #ifdef CONFIG_HIBERNATION
 526 extern int acpi_check_s4_hw_signature;
 527 #endif
 528
 529 #ifdef CONFIG_PM_SLEEP
 530 void __init acpi_old_suspend_ordering(void);
 531 void __init acpi_nvs_nosave(void);
 532 void __init acpi_nvs_nosave_s3(void);
 533 void __init acpi_sleep_no_blacklist(void);
 534 #endif /* CONFIG_PM_SLEEP */
 535
 536 int acpi_register_wakeup_handler(
 537         int wake_irq, bool (*wakeup)(void *context), void *context);
 538 void acpi_unregister_wakeup_handler(
 539         bool (*wakeup)(void *context), void *context);
 540
 541 struct acpi_osc_context {
 542         char *uuid_str;                 /* UUID string */
 543         int rev;
 544         struct acpi_buffer cap;         /* list of DWORD capabilities */
 545         struct acpi_buffer ret;         /* free by caller if success */
 546 };
 547
 548 acpi_status acpi_run_osc(acpi_handle handle, struct acpi_osc_context *context);
 549
 550 /* Number of _OSC capability DWORDS depends on bridge type */
 551 #define OSC_PCI_CAPABILITY_DWORDS               3
 552 #define OSC_CXL_CAPABILITY_DWORDS               5
 553
 554 /* Indexes into _OSC Capabilities Buffer (DWORDs 2 to 5 are device-specific) */
 555 #define OSC_QUERY_DWORD                         0       /* DWORD 1 */
 556 #define OSC_SUPPORT_DWORD                       1       /* DWORD 2 */
 557 #define OSC_CONTROL_DWORD                       2       /* DWORD 3 */
 558 #define OSC_EXT_SUPPORT_DWORD                   3       /* DWORD 4 */
 559 #define OSC_EXT_CONTROL_DWORD                   4       /* DWORD 5 */
 560
 561 /* _OSC Capabilities DWORD 1: Query/Control and Error Returns (generic) */
 562 #define OSC_QUERY_ENABLE                        0x00000001  /* input */
 563 #define OSC_REQUEST_ERROR                       0x00000002  /* return */
 564 #define OSC_INVALID_UUID_ERROR                  0x00000004  /* return */
 565 #define OSC_INVALID_REVISION_ERROR              0x00000008  /* return */
 566 #define OSC_CAPABILITIES_MASK_ERROR             0x00000010  /* return */
 567
 568 /* Platform-Wide Capabilities _OSC: Capabilities DWORD 2: Support Field */
 569 #define OSC_SB_PAD_SUPPORT                      0x00000001
 570 #define OSC_SB_PPC_OST_SUPPORT                  0x00000002
 571 #define OSC_SB_PR3_SUPPORT                      0x00000004
 572 #define OSC_SB_HOTPLUG_OST_SUPPORT              0x00000008
 573 #define OSC_SB_APEI_SUPPORT                     0x00000010
 574 #define OSC_SB_CPC_SUPPORT                      0x00000020
 575 #define OSC_SB_CPCV2_SUPPORT                    0x00000040
 576 #define OSC_SB_PCLPI_SUPPORT                    0x00000080
 577 #define OSC_SB_OSLPI_SUPPORT                    0x00000100
 578 #define OSC_SB_FAST_THERMAL_SAMPLING_SUPPORT    0x00000200
 579 #define OSC_SB_OVER_16_PSTATES_SUPPORT          0x00000400
 580 #define OSC_SB_GED_SUPPORT                      0x00000800
 581 #define OSC_SB_CPC_DIVERSE_HIGH_SUPPORT         0x00001000
 582 #define OSC_SB_IRQ_RESOURCE_SOURCE_SUPPORT      0x00002000
 583 #define OSC_SB_CPC_FLEXIBLE_ADR_SPACE           0x00004000
 584 #define OSC_SB_GENERIC_INITIATOR_SUPPORT        0x00020000
 585 #define OSC_SB_NATIVE_USB4_SUPPORT              0x00040000
 586 #define OSC_SB_BATTERY_CHARGE_LIMITING_SUPPORT  0x00080000
 587 #define OSC_SB_PRM_SUPPORT                      0x00200000
 588 #define OSC_SB_FFH_OPR_SUPPORT                  0x00400000
 589
 590 extern bool osc_sb_apei_support_acked;
 591 extern bool osc_pc_lpi_support_confirmed;
 592 extern bool osc_sb_native_usb4_support_confirmed;
 593 extern bool osc_sb_cppc2_support_acked;
 594 extern bool osc_cpc_flexible_adr_space_confirmed;
 595
 596 /* USB4 Capabilities */
 597 #define OSC_USB_USB3_TUNNELING                  0x00000001
 598 #define OSC_USB_DP_TUNNELING                    0x00000002
 599 #define OSC_USB_PCIE_TUNNELING                  0x00000004
 600 #define OSC_USB_XDOMAIN                         0x00000008
 601
 602 extern u32 osc_sb_native_usb4_control;
 603
 604 /* PCI Host Bridge _OSC: Capabilities DWORD 2: Support Field */
 605 #define OSC_PCI_EXT_CONFIG_SUPPORT              0x00000001
 606 #define OSC_PCI_ASPM_SUPPORT                    0x00000002
 607 #define OSC_PCI_CLOCK_PM_SUPPORT                0x00000004
 608 #define OSC_PCI_SEGMENT_GROUPS_SUPPORT          0x00000008
 609 #define OSC_PCI_MSI_SUPPORT                     0x00000010
 610 #define OSC_PCI_EDR_SUPPORT                     0x00000080
 611 #define OSC_PCI_HPX_TYPE_3_SUPPORT              0x00000100
 612
 613 /* PCI Host Bridge _OSC: Capabilities DWORD 3: Control Field */
 614 #define OSC_PCI_EXPRESS_NATIVE_HP_CONTROL       0x00000001
 615 #define OSC_PCI_SHPC_NATIVE_HP_CONTROL          0x00000002
 616 #define OSC_PCI_EXPRESS_PME_CONTROL             0x00000004
 617 #define OSC_PCI_EXPRESS_AER_CONTROL             0x00000008
 618 #define OSC_PCI_EXPRESS_CAPABILITY_CONTROL      0x00000010
 619 #define OSC_PCI_EXPRESS_LTR_CONTROL             0x00000020
 620 #define OSC_PCI_EXPRESS_DPC_CONTROL             0x00000080
 621
 622 /* CXL _OSC: Capabilities DWORD 4: Support Field */
 623 #define OSC_CXL_1_1_PORT_REG_ACCESS_SUPPORT     0x00000001
 624 #define OSC_CXL_2_0_PORT_DEV_REG_ACCESS_SUPPORT 0x00000002
 625 #define OSC_CXL_PROTOCOL_ERR_REPORTING_SUPPORT  0x00000004
 626 #define OSC_CXL_NATIVE_HP_SUPPORT               0x00000008
 627
 628 /* CXL _OSC: Capabilities DWORD 5: Control Field */
 629 #define OSC_CXL_ERROR_REPORTING_CONTROL         0x00000001
 630
 631 static inline u32 acpi_osc_ctx_get_pci_control(struct acpi_osc_context *context)
 632 {
 633         u32 *ret = context->ret.pointer;
 634
 635         return ret[OSC_CONTROL_DWORD];
 636 }
 637
 638 static inline u32 acpi_osc_ctx_get_cxl_control(struct acpi_osc_context *context)
 639 {
 640         u32 *ret = context->ret.pointer;
 641
 642         return ret[OSC_EXT_CONTROL_DWORD];
 643 }
 644
 645 #define ACPI_GSB_ACCESS_ATTRIB_QUICK            0x00000002
 646 #define ACPI_GSB_ACCESS_ATTRIB_SEND_RCV         0x00000004
 647 #define ACPI_GSB_ACCESS_ATTRIB_BYTE             0x00000006
 648 #define ACPI_GSB_ACCESS_ATTRIB_WORD             0x00000008
 649 #define ACPI_GSB_ACCESS_ATTRIB_BLOCK            0x0000000A
 650 #define ACPI_GSB_ACCESS_ATTRIB_MULTIBYTE        0x0000000B
 651 #define ACPI_GSB_ACCESS_ATTRIB_WORD_CALL        0x0000000C
 652 #define ACPI_GSB_ACCESS_ATTRIB_BLOCK_CALL       0x0000000D
 653 #define ACPI_GSB_ACCESS_ATTRIB_RAW_BYTES        0x0000000E
 654 #define ACPI_GSB_ACCESS_ATTRIB_RAW_PROCESS      0x0000000F
 655
 656 /* Enable _OST when all relevant hotplug operations are enabled */
 657 #if defined(CONFIG_ACPI_HOTPLUG_CPU) &&                 \
 658         defined(CONFIG_ACPI_HOTPLUG_MEMORY) &&          \
 659         defined(CONFIG_ACPI_CONTAINER)
 660 #define ACPI_HOTPLUG_OST
 661 #endif
 662
 663 /* _OST Source Event Code (OSPM Action) */
 664 #define ACPI_OST_EC_OSPM_SHUTDOWN               0x100
 665 #define ACPI_OST_EC_OSPM_EJECT                  0x103
 666 #define ACPI_OST_EC_OSPM_INSERTION              0x200
 667
 668 /* _OST General Processing Status Code */
 669 #define ACPI_OST_SC_SUCCESS                     0x0
 670 #define ACPI_OST_SC_NON_SPECIFIC_FAILURE        0x1
 671 #define ACPI_OST_SC_UNRECOGNIZED_NOTIFY         0x2
 672
 673 /* _OST OS Shutdown Processing (0x100) Status Code */
 674 #define ACPI_OST_SC_OS_SHUTDOWN_DENIED          0x80
 675 #define ACPI_OST_SC_OS_SHUTDOWN_IN_PROGRESS     0x81
 676 #define ACPI_OST_SC_OS_SHUTDOWN_COMPLETED       0x82
 677 #define ACPI_OST_SC_OS_SHUTDOWN_NOT_SUPPORTED   0x83
 678
 679 /* _OST Ejection Request (0x3, 0x103) Status Code */
 680 #define ACPI_OST_SC_EJECT_NOT_SUPPORTED         0x80
 681 #define ACPI_OST_SC_DEVICE_IN_USE               0x81
 682 #define ACPI_OST_SC_DEVICE_BUSY                 0x82
 683 #define ACPI_OST_SC_EJECT_DEPENDENCY_BUSY       0x83
 684 #define ACPI_OST_SC_EJECT_IN_PROGRESS           0x84
 685
 686 /* _OST Insertion Request (0x200) Status Code */
 687 #define ACPI_OST_SC_INSERT_IN_PROGRESS          0x80
 688 #define ACPI_OST_SC_DRIVER_LOAD_FAILURE         0x81
 689 #define ACPI_OST_SC_INSERT_NOT_SUPPORTED        0x82
 690
 691 enum acpi_predicate {
 692         all_versions,
 693         less_than_or_equal,
 694         equal,
 695         greater_than_or_equal,
 696 };
 697
 698 /* Table must be terminted by a NULL entry */
 699 struct acpi_platform_list {
 700         char    oem_id[ACPI_OEM_ID_SIZE+1];
 701         char    oem_table_id[ACPI_OEM_TABLE_ID_SIZE+1];
 702         u32     oem_revision;
 703         char    *table;
 704         enum acpi_predicate pred;
 705         char    *reason;
 706         u32     data;
 707 };
 708 int acpi_match_platform_list(const struct acpi_platform_list *plat);
 709
 710 extern void acpi_early_init(void);
 711 extern void acpi_subsystem_init(void);
 712
 713 extern int acpi_nvs_register(__u64 start, __u64 size);
 714
 715 extern int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
 716                                     void *data);
 717
 718 const struct acpi_device_id *acpi_match_acpi_device(const struct acpi_device_id *ids,
 719                                                     const struct acpi_device *adev);
 720
 721 const struct acpi_device_id *acpi_match_device(const struct acpi_device_id *ids,
 722                                                const struct device *dev);
 723
 724 const void *acpi_device_get_match_data(const struct device *dev);
 725 extern bool acpi_driver_match_device(struct device *dev,
 726                                      const struct device_driver *drv);
 727 int acpi_device_uevent_modalias(const struct device *, struct kobj_uevent_env *);
 728 int acpi_device_modalias(struct device *, char *, int);
 729
 730 struct platform_device *acpi_create_platform_device(struct acpi_device *,
 731                                                     const struct property_entry *);
 732 #define ACPI_PTR(_ptr)  (_ptr)
 733
 734 static inline void acpi_device_set_enumerated(struct acpi_device *adev)
 735 {
 736         adev->flags.visited = true;
 737 }
 738
 739 static inline void acpi_device_clear_enumerated(struct acpi_device *adev)
 740 {
 741         adev->flags.visited = false;
 742 }
 743
 744 enum acpi_reconfig_event  {
 745         ACPI_RECONFIG_DEVICE_ADD = 0,
 746         ACPI_RECONFIG_DEVICE_REMOVE,
 747 };
 748
 749 int acpi_reconfig_notifier_register(struct notifier_block *nb);
 750 int acpi_reconfig_notifier_unregister(struct notifier_block *nb);
 751
 752 #ifdef CONFIG_ACPI_GTDT
 753 int acpi_gtdt_init(struct acpi_table_header *table, int *platform_timer_count);
 754 int acpi_gtdt_map_ppi(int type);
 755 bool acpi_gtdt_c3stop(int type);
 756 int acpi_arch_timer_mem_init(struct arch_timer_mem *timer_mem, int *timer_count);
 757 #endif
 758
 759 #ifndef ACPI_HAVE_ARCH_SET_ROOT_POINTER
 760 static inline void acpi_arch_set_root_pointer(u64 addr)
 761 {
 762 }
 763 #endif
 764
 765 #ifndef ACPI_HAVE_ARCH_GET_ROOT_POINTER
 766 static inline u64 acpi_arch_get_root_pointer(void)
 767 {
 768         return 0;
 769 }
 770 #endif
 771
 772 int acpi_get_local_u64_address(acpi_handle handle, u64 *addr);
 773 int acpi_get_local_address(acpi_handle handle, u32 *addr);
 774 const char *acpi_get_subsystem_id(acpi_handle handle);
 775
 776 #else   /* !CONFIG_ACPI */
 777
 778 #define acpi_disabled 1
 779
 780 #define ACPI_COMPANION(dev)             (NULL)
 781 #define ACPI_COMPANION_SET(dev, adev)   do { } while (0)
 782 #define ACPI_HANDLE(dev)                (NULL)
 783 #define ACPI_HANDLE_FWNODE(fwnode)      (NULL)
 784
 785 /* Get rid of the -Wunused-variable for adev */
 786 #define acpi_dev_uid_match(adev, uid2)                  (adev && false)
 787 #define acpi_dev_hid_uid_match(adev, hid2, uid2)        (adev && false)
 788
 789 struct fwnode_handle;
 790
 791 static inline bool acpi_dev_found(const char *hid)
 792 {
 793         return false;
 794 }
 795
 796 static inline bool acpi_dev_present(const char *hid, const char *uid, s64 hrv)
 797 {
 798         return false;
 799 }
 800
 801 struct acpi_device;
 802
 803 static inline int acpi_dev_uid_to_integer(struct acpi_device *adev, u64 *integer)
 804 {
 805         return -ENODEV;
 806 }
 807
 808 static inline struct acpi_device *
 809 acpi_dev_get_first_match_dev(const char *hid, const char *uid, s64 hrv)
 810 {
 811         return NULL;
 812 }
 813
 814 static inline bool acpi_reduced_hardware(void)
 815 {
 816         return false;
 817 }
 818
 819 static inline void acpi_dev_put(struct acpi_device *adev) {}
 820
 821 static inline bool is_acpi_node(const struct fwnode_handle *fwnode)
 822 {
 823         return false;
 824 }
 825
 826 static inline bool is_acpi_device_node(const struct fwnode_handle *fwnode)
 827 {
 828         return false;
 829 }
 830
 831 static inline struct acpi_device *to_acpi_device_node(const struct fwnode_handle *fwnode)
 832 {
 833         return NULL;
 834 }
 835
 836 static inline bool is_acpi_data_node(const struct fwnode_handle *fwnode)
 837 {
 838         return false;
 839 }
 840
 841 static inline struct acpi_data_node *to_acpi_data_node(const struct fwnode_handle *fwnode)
 842 {
 843         return NULL;
 844 }
 845
 846 static inline bool acpi_data_node_match(const struct fwnode_handle *fwnode,
 847                                         const char *name)
 848 {
 849         return false;
 850 }
 851
 852 static inline struct fwnode_handle *acpi_fwnode_handle(struct acpi_device *adev)
 853 {
 854         return NULL;
 855 }
 856
 857 static inline bool has_acpi_companion(struct device *dev)
 858 {
 859         return false;
 860 }
 861
 862 static inline void acpi_preset_companion(struct device *dev,
 863                                          struct acpi_device *parent, u64 addr)
 864 {
 865 }
 866
 867 static inline const char *acpi_dev_name(struct acpi_device *adev)
 868 {
 869         return NULL;
 870 }
 871
 872 static inline struct device *acpi_get_first_physical_node(struct acpi_device *adev)
 873 {
 874         return NULL;
 875 }
 876
 877 static inline void acpi_early_init(void) { }
 878 static inline void acpi_subsystem_init(void) { }
 879
 880 static inline int early_acpi_boot_init(void)
 881 {
 882         return 0;
 883 }
 884 static inline int acpi_boot_init(void)
 885 {
 886         return 0;
 887 }
 888
 889 static inline void acpi_boot_table_prepare(void)
 890 {
 891 }
 892
 893 static inline void acpi_boot_table_init(void)
 894 {
 895 }
 896
 897 static inline int acpi_mps_check(void)
 898 {
 899         return 0;
 900 }
 901
 902 static inline int acpi_check_resource_conflict(struct resource *res)
 903 {
 904         return 0;
 905 }
 906
 907 static inline int acpi_check_region(resource_size_t start, resource_size_t n,
 908                                     const char *name)
 909 {
 910         return 0;
 911 }
 912
 913 struct acpi_table_header;
 914 static inline int acpi_table_parse(char *id,
 915                                 int (*handler)(struct acpi_table_header *))
 916 {
 917         return -ENODEV;
 918 }
 919
 920 static inline int acpi_nvs_register(__u64 start, __u64 size)
 921 {
 922         return 0;
 923 }
 924
 925 static inline int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
 926                                            void *data)
 927 {
 928         return 0;
 929 }
 930
 931 struct acpi_device_id;
 932
 933 static inline const struct acpi_device_id *acpi_match_acpi_device(
 934         const struct acpi_device_id *ids, const struct acpi_device *adev)
 935 {
 936         return NULL;
 937 }
 938
 939 static inline const struct acpi_device_id *acpi_match_device(
 940         const struct acpi_device_id *ids, const struct device *dev)
 941 {
 942         return NULL;
 943 }
 944
 945 static inline const void *acpi_device_get_match_data(const struct device *dev)
 946 {
 947         return NULL;
 948 }
 949
 950 static inline bool acpi_driver_match_device(struct device *dev,
 951                                             const struct device_driver *drv)
 952 {
 953         return false;
 954 }
 955
 956 static inline bool acpi_check_dsm(acpi_handle handle, const guid_t *guid,
 957                                   u64 rev, u64 funcs)
 958 {
 959         return false;
 960 }
 961
 962 static inline union acpi_object *acpi_evaluate_dsm(acpi_handle handle,
 963                                                    const guid_t *guid,
 964                                                    u64 rev, u64 func,
 965                                                    union acpi_object *argv4)
 966 {
 967         return NULL;
 968 }
 969
 970 static inline union acpi_object *acpi_evaluate_dsm_typed(acpi_handle handle,
 971                                                          const guid_t *guid,
 972                                                          u64 rev, u64 func,
 973                                                          union acpi_object *argv4,
 974                                                          acpi_object_type type)
 975 {
 976         return NULL;
 977 }
 978
 979 static inline int acpi_device_uevent_modalias(const struct device *dev,
 980                                 struct kobj_uevent_env *env)
 981 {
 982         return -ENODEV;
 983 }
 984
 985 static inline int acpi_device_modalias(struct device *dev,
 986                                 char *buf, int size)
 987 {
 988         return -ENODEV;
 989 }
 990
 991 static inline struct platform_device *
 992 acpi_create_platform_device(struct acpi_device *adev,
 993                             const struct property_entry *properties)
 994 {
 995         return NULL;
 996 }
 997
 998 static inline bool acpi_dma_supported(const struct acpi_device *adev)
 999 {
1000         return false;
1001 }
1002
1003 static inline enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev)
1004 {
1005         return DEV_DMA_NOT_SUPPORTED;
1006 }
1007
1008 static inline int acpi_dma_get_range(struct device *dev, const struct bus_dma_region **map)
1009 {
1010         return -ENODEV;
1011 }
1012
1013 static inline int acpi_dma_configure(struct device *dev,
1014                                      enum dev_dma_attr attr)
1015 {
1016         return 0;
1017 }
1018
1019 static inline int acpi_dma_configure_id(struct device *dev,
1020                                         enum dev_dma_attr attr,
1021                                         const u32 *input_id)
1022 {
1023         return 0;
1024 }
1025
1026 #define ACPI_PTR(_ptr)  (NULL)
1027
1028 static inline void acpi_device_set_enumerated(struct acpi_device *adev)
1029 {
1030 }
1031
1032 static inline void acpi_device_clear_enumerated(struct acpi_device *adev)
1033 {
1034 }
1035
1036 static inline int acpi_reconfig_notifier_register(struct notifier_block *nb)
1037 {
1038         return -EINVAL;
1039 }
1040
1041 static inline int acpi_reconfig_notifier_unregister(struct notifier_block *nb)
1042 {
1043         return -EINVAL;
1044 }
1045
1046 static inline struct acpi_device *acpi_resource_consumer(struct resource *res)
1047 {
1048         return NULL;
1049 }
1050
1051 static inline int acpi_get_local_address(acpi_handle handle, u32 *addr)
1052 {
1053         return -ENODEV;
1054 }
1055
1056 static inline const char *acpi_get_subsystem_id(acpi_handle handle)
1057 {
1058         return ERR_PTR(-ENODEV);
1059 }
1060
1061 static inline int acpi_register_wakeup_handler(int wake_irq,
1062         bool (*wakeup)(void *context), void *context)
1063 {
1064         return -ENXIO;
1065 }
1066
1067 static inline void acpi_unregister_wakeup_handler(
1068         bool (*wakeup)(void *context), void *context) { }
1069
1070 struct acpi_osc_context;
1071 static inline u32 acpi_osc_ctx_get_pci_control(struct acpi_osc_context *context)
1072 {
1073         return 0;
1074 }
1075
1076 static inline u32 acpi_osc_ctx_get_cxl_control(struct acpi_osc_context *context)
1077 {
1078         return 0;
1079 }
1080
1081 static inline bool acpi_sleep_state_supported(u8 sleep_state)
1082 {
1083         return false;
1084 }
1085
1086 static inline acpi_handle acpi_get_processor_handle(int cpu)
1087 {
1088         return NULL;
1089 }
1090
1091 #endif  /* !CONFIG_ACPI */
1092
1093 extern void arch_post_acpi_subsys_init(void);
1094
1095 #ifdef CONFIG_ACPI_HOTPLUG_IOAPIC
1096 int acpi_ioapic_add(acpi_handle root);
1097 #else
1098 static inline int acpi_ioapic_add(acpi_handle root) { return 0; }
1099 #endif
1100
1101 #ifdef CONFIG_ACPI
1102 void acpi_os_set_prepare_sleep(int (*func)(u8 sleep_state,
1103                                u32 pm1a_ctrl,  u32 pm1b_ctrl));
1104
1105 acpi_status acpi_os_prepare_sleep(u8 sleep_state,
1106                                   u32 pm1a_control, u32 pm1b_control);
1107
1108 void acpi_os_set_prepare_extended_sleep(int (*func)(u8 sleep_state,
1109                                         u32 val_a,  u32 val_b));
1110
1111 acpi_status acpi_os_prepare_extended_sleep(u8 sleep_state,
1112                                            u32 val_a, u32 val_b);
1113 #if defined(CONFIG_SUSPEND) && defined(CONFIG_X86)
1114 struct acpi_s2idle_dev_ops {
1115         struct list_head list_node;
1116         void (*prepare)(void);
1117         void (*check)(void);
1118         void (*restore)(void);
1119 };
1120 int acpi_register_lps0_dev(struct acpi_s2idle_dev_ops *arg);
1121 void acpi_unregister_lps0_dev(struct acpi_s2idle_dev_ops *arg);
1122 int acpi_get_lps0_constraint(struct acpi_device *adev);
1123 #else /* CONFIG_SUSPEND && CONFIG_X86 */
1124 static inline int acpi_get_lps0_constraint(struct device *dev)
1125 {
1126         return ACPI_STATE_UNKNOWN;
1127 }
1128 #endif /* CONFIG_SUSPEND && CONFIG_X86 */
1129 void arch_reserve_mem_area(acpi_physical_address addr, size_t size);
1130 #else
1131 #define acpi_os_set_prepare_sleep(func, pm1a_ctrl, pm1b_ctrl) do { } while (0)
1132 #endif
1133
1134 #if defined(CONFIG_ACPI) && defined(CONFIG_PM)
1135 int acpi_dev_suspend(struct device *dev, bool wakeup);
1136 int acpi_dev_resume(struct device *dev);
1137 int acpi_subsys_runtime_suspend(struct device *dev);
1138 int acpi_subsys_runtime_resume(struct device *dev);
1139 int acpi_dev_pm_attach(struct device *dev, bool power_on);
1140 bool acpi_storage_d3(struct device *dev);
1141 bool acpi_dev_state_d0(struct device *dev);
1142 #else
1143 static inline int acpi_subsys_runtime_suspend(struct device *dev) { return 0; }
1144 static inline int acpi_subsys_runtime_resume(struct device *dev) { return 0; }
1145 static inline int acpi_dev_pm_attach(struct device *dev, bool power_on)
1146 {
1147         return 0;
1148 }
1149 static inline bool acpi_storage_d3(struct device *dev)
1150 {
1151         return false;
1152 }
1153 static inline bool acpi_dev_state_d0(struct device *dev)
1154 {
1155         return true;
1156 }
1157 #endif
1158
1159 #if defined(CONFIG_ACPI) && defined(CONFIG_PM_SLEEP)
1160 int acpi_subsys_prepare(struct device *dev);
1161 void acpi_subsys_complete(struct device *dev);
1162 int acpi_subsys_suspend_late(struct device *dev);
1163 int acpi_subsys_suspend_noirq(struct device *dev);
1164 int acpi_subsys_suspend(struct device *dev);
1165 int acpi_subsys_freeze(struct device *dev);
1166 int acpi_subsys_poweroff(struct device *dev);
1167 int acpi_subsys_restore_early(struct device *dev);
1168 #else
1169 static inline int acpi_subsys_prepare(struct device *dev) { return 0; }
1170 static inline void acpi_subsys_complete(struct device *dev) {}
1171 static inline int acpi_subsys_suspend_late(struct device *dev) { return 0; }
1172 static inline int acpi_subsys_suspend_noirq(struct device *dev) { return 0; }
1173 static inline int acpi_subsys_suspend(struct device *dev) { return 0; }
1174 static inline int acpi_subsys_freeze(struct device *dev) { return 0; }
1175 static inline int acpi_subsys_poweroff(struct device *dev) { return 0; }
1176 static inline int acpi_subsys_restore_early(struct device *dev) { return 0; }
1177 #endif
1178
1179 #if defined(CONFIG_ACPI_EC) && defined(CONFIG_PM_SLEEP)
1180 void acpi_ec_mark_gpe_for_wake(void);
1181 void acpi_ec_set_gpe_wake_mask(u8 action);
1182 #else
1183 static inline void acpi_ec_mark_gpe_for_wake(void) {}
1184 static inline void acpi_ec_set_gpe_wake_mask(u8 action) {}
1185 #endif
1186
1187 #ifdef CONFIG_ACPI
1188 char *acpi_handle_path(acpi_handle handle);
1189 __printf(3, 4)
1190 void acpi_handle_printk(const char *level, acpi_handle handle,
1191                         const char *fmt, ...);
1192 void acpi_evaluation_failure_warn(acpi_handle handle, const char *name,
1193                                   acpi_status status);
1194 #else   /* !CONFIG_ACPI */
1195 static inline __printf(3, 4) void
1196 acpi_handle_printk(const char *level, void *handle, const char *fmt, ...) {}
1197 static inline void acpi_evaluation_failure_warn(acpi_handle handle,
1198                                                 const char *name,
1199                                                 acpi_status status) {}
1200 #endif  /* !CONFIG_ACPI */
1201
1202 #if defined(CONFIG_ACPI) && defined(CONFIG_DYNAMIC_DEBUG)
1203 __printf(3, 4)
1204 void __acpi_handle_debug(struct _ddebug *descriptor, acpi_handle handle, const char *fmt, ...);
1205 #endif
1206
1207 /*
1208  * acpi_handle_<level>: Print message with ACPI prefix and object path
1209  *
1210  * These interfaces acquire the global namespace mutex to obtain an object
1211  * path.  In interrupt context, it shows the object path as <n/a>.
1212  */
1213 #define acpi_handle_emerg(handle, fmt, ...)                             \
1214         acpi_handle_printk(KERN_EMERG, handle, fmt, ##__VA_ARGS__)
1215 #define acpi_handle_alert(handle, fmt, ...)                             \
1216         acpi_handle_printk(KERN_ALERT, handle, fmt, ##__VA_ARGS__)
1217 #define acpi_handle_crit(handle, fmt, ...)                              \
1218         acpi_handle_printk(KERN_CRIT, handle, fmt, ##__VA_ARGS__)
1219 #define acpi_handle_err(handle, fmt, ...)                               \
1220         acpi_handle_printk(KERN_ERR, handle, fmt, ##__VA_ARGS__)
1221 #define acpi_handle_warn(handle, fmt, ...)                              \
1222         acpi_handle_printk(KERN_WARNING, handle, fmt, ##__VA_ARGS__)
1223 #define acpi_handle_notice(handle, fmt, ...)                            \
1224         acpi_handle_printk(KERN_NOTICE, handle, fmt, ##__VA_ARGS__)
1225 #define acpi_handle_info(handle, fmt, ...)                              \
1226         acpi_handle_printk(KERN_INFO, handle, fmt, ##__VA_ARGS__)
1227
1228 #if defined(DEBUG)
1229 #define acpi_handle_debug(handle, fmt, ...)                             \
1230         acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__)
1231 #else
1232 #if defined(CONFIG_DYNAMIC_DEBUG)
1233 #define acpi_handle_debug(handle, fmt, ...)                             \
1234         _dynamic_func_call(fmt, __acpi_handle_debug,                    \
1235                            handle, pr_fmt(fmt), ##__VA_ARGS__)
1236 #else
1237 #define acpi_handle_debug(handle, fmt, ...)                             \
1238 ({                                                                      \
1239         if (0)                                                          \
1240                 acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__); \
1241         0;                                                              \
1242 })
1243 #endif
1244 #endif
1245
1246 #if defined(CONFIG_ACPI) && defined(CONFIG_GPIOLIB)
1247 bool acpi_gpio_get_irq_resource(struct acpi_resource *ares,
1248                                 struct acpi_resource_gpio **agpio);
1249 bool acpi_gpio_get_io_resource(struct acpi_resource *ares,
1250                                struct acpi_resource_gpio **agpio);
1251 int acpi_dev_gpio_irq_wake_get_by(struct acpi_device *adev, const char *con_id, int index,
1252                                   bool *wake_capable);
1253 #else
1254 static inline bool acpi_gpio_get_irq_resource(struct acpi_resource *ares,
1255                                               struct acpi_resource_gpio **agpio)
1256 {
1257         return false;
1258 }
1259 static inline bool acpi_gpio_get_io_resource(struct acpi_resource *ares,
1260                                              struct acpi_resource_gpio **agpio)
1261 {
1262         return false;
1263 }
1264 static inline int acpi_dev_gpio_irq_wake_get_by(struct acpi_device *adev, const char *con_id,
1265                                                 int index, bool *wake_capable)
1266 {
1267         return -ENXIO;
1268 }
1269 #endif
1270
1271 static inline int acpi_dev_gpio_irq_wake_get(struct acpi_device *adev, int index,
1272                                              bool *wake_capable)
1273 {
1274         return acpi_dev_gpio_irq_wake_get_by(adev, NULL, index, wake_capable);
1275 }
1276
1277 static inline int acpi_dev_gpio_irq_get_by(struct acpi_device *adev, const char *con_id,
1278                                            int index)
1279 {
1280         return acpi_dev_gpio_irq_wake_get_by(adev, con_id, index, NULL);
1281 }
1282
1283 static inline int acpi_dev_gpio_irq_get(struct acpi_device *adev, int index)
1284 {
1285         return acpi_dev_gpio_irq_wake_get_by(adev, NULL, index, NULL);
1286 }
1287
1288 /* Device properties */
1289
1290 #ifdef CONFIG_ACPI
1291 int acpi_dev_get_property(const struct acpi_device *adev, const char *name,
1292                           acpi_object_type type, const union acpi_object **obj);
1293 int __acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
1294                                 const char *name, size_t index, size_t num_args,
1295                                 struct fwnode_reference_args *args);
1296
1297 static inline int acpi_node_get_property_reference(
1298                                 const struct fwnode_handle *fwnode,
1299                                 const char *name, size_t index,
1300                                 struct fwnode_reference_args *args)
1301 {
1302         return __acpi_node_get_property_reference(fwnode, name, index,
1303                 NR_FWNODE_REFERENCE_ARGS, args);
1304 }
1305
1306 static inline bool acpi_dev_has_props(const struct acpi_device *adev)
1307 {
1308         return !list_empty(&adev->data.properties);
1309 }
1310
1311 struct acpi_device_properties *
1312 acpi_data_add_props(struct acpi_device_data *data, const guid_t *guid,
1313                     union acpi_object *properties);
1314
1315 int acpi_node_prop_get(const struct fwnode_handle *fwnode, const char *propname,
1316                        void **valptr);
1317
1318 struct fwnode_handle *acpi_get_next_subnode(const struct fwnode_handle *fwnode,
1319                                             struct fwnode_handle *child);
1320
1321 struct acpi_probe_entry;
1322 typedef bool (*acpi_probe_entry_validate_subtbl)(struct acpi_subtable_header *,
1323                                                  struct acpi_probe_entry *);
1324
1325 #define ACPI_TABLE_ID_LEN       5
1326
1327 /**
1328  * struct acpi_probe_entry - boot-time probing entry
1329  * @id:                 ACPI table name
1330  * @type:               Optional subtable type to match
1331  *                      (if @id contains subtables)
1332  * @subtable_valid:     Optional callback to check the validity of
1333  *                      the subtable
1334  * @probe_table:        Callback to the driver being probed when table
1335  *                      match is successful
1336  * @probe_subtbl:       Callback to the driver being probed when table and
1337  *                      subtable match (and optional callback is successful)
1338  * @driver_data:        Sideband data provided back to the driver
1339  */
1340 struct acpi_probe_entry {
1341         __u8 id[ACPI_TABLE_ID_LEN];
1342         __u8 type;
1343         acpi_probe_entry_validate_subtbl subtable_valid;
1344         union {
1345                 acpi_tbl_table_handler probe_table;
1346                 acpi_tbl_entry_handler probe_subtbl;
1347         };
1348         kernel_ulong_t driver_data;
1349 };
1350
1351 void arch_sort_irqchip_probe(struct acpi_probe_entry *ap_head, int nr);
1352
1353 #define ACPI_DECLARE_PROBE_ENTRY(table, name, table_id, subtable,       \
1354                                  valid, data, fn)                       \
1355         static const struct acpi_probe_entry __acpi_probe_##name        \
1356                 __used __section("__" #table "_acpi_probe_table") = {   \
1357                         .id = table_id,                                 \
1358                         .type = subtable,                               \
1359                         .subtable_valid = valid,                        \
1360                         .probe_table = fn,                              \
1361                         .driver_data = data,                            \
1362                 }
1363
1364 #define ACPI_DECLARE_SUBTABLE_PROBE_ENTRY(table, name, table_id,        \
1365                                           subtable, valid, data, fn)    \
1366         static const struct acpi_probe_entry __acpi_probe_##name        \
1367                 __used __section("__" #table "_acpi_probe_table") = {   \
1368                         .id = table_id,                                 \
1369                         .type = subtable,                               \
1370                         .subtable_valid = valid,                        \
1371                         .probe_subtbl = fn,                             \
1372                         .driver_data = data,                            \
1373                 }
1374
1375 #define ACPI_PROBE_TABLE(name)          __##name##_acpi_probe_table
1376 #define ACPI_PROBE_TABLE_END(name)      __##name##_acpi_probe_table_end
1377
1378 int __acpi_probe_device_table(struct acpi_probe_entry *start, int nr);
1379
1380 #define acpi_probe_device_table(t)                                      \
1381         ({                                                              \
1382                 extern struct acpi_probe_entry ACPI_PROBE_TABLE(t),     \
1383                                                ACPI_PROBE_TABLE_END(t); \
1384                 __acpi_probe_device_table(&ACPI_PROBE_TABLE(t),         \
1385                                           (&ACPI_PROBE_TABLE_END(t) -   \
1386                                            &ACPI_PROBE_TABLE(t)));      \
1387         })
1388 #else
1389 static inline int acpi_dev_get_property(struct acpi_device *adev,
1390                                         const char *name, acpi_object_type type,
1391                                         const union acpi_object **obj)
1392 {
1393         return -ENXIO;
1394 }
1395
1396 static inline int
1397 __acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
1398                                 const char *name, size_t index, size_t num_args,
1399                                 struct fwnode_reference_args *args)
1400 {
1401         return -ENXIO;
1402 }
1403
1404 static inline int
1405 acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
1406                                  const char *name, size_t index,
1407                                  struct fwnode_reference_args *args)
1408 {
1409         return -ENXIO;
1410 }
1411
1412 static inline int acpi_node_prop_get(const struct fwnode_handle *fwnode,
1413                                      const char *propname,
1414                                      void **valptr)
1415 {
1416         return -ENXIO;
1417 }
1418
1419 static inline struct fwnode_handle *
1420 acpi_get_next_subnode(const struct fwnode_handle *fwnode,
1421                       struct fwnode_handle *child)
1422 {
1423         return NULL;
1424 }
1425
1426 static inline struct fwnode_handle *
1427 acpi_graph_get_next_endpoint(const struct fwnode_handle *fwnode,
1428                              struct fwnode_handle *prev)
1429 {
1430         return ERR_PTR(-ENXIO);
1431 }
1432
1433 static inline int
1434 acpi_graph_get_remote_endpoint(const struct fwnode_handle *fwnode,
1435                                struct fwnode_handle **remote,
1436                                struct fwnode_handle **port,
1437                                struct fwnode_handle **endpoint)
1438 {
1439         return -ENXIO;
1440 }
1441
1442 #define ACPI_DECLARE_PROBE_ENTRY(table, name, table_id, subtable, valid, data, fn) \
1443         static const void * __acpi_table_##name[]                       \
1444                 __attribute__((unused))                                 \
1445                  = { (void *) table_id,                                 \
1446                      (void *) subtable,                                 \
1447                      (void *) valid,                                    \
1448                      (void *) fn,                                       \
1449                      (void *) data }
1450
1451 #define acpi_probe_device_table(t)      ({ int __r = 0; __r;})
1452 #endif
1453
1454 #ifdef CONFIG_ACPI_TABLE_UPGRADE
1455 void acpi_table_upgrade(void);
1456 #else
1457 static inline void acpi_table_upgrade(void) { }
1458 #endif
1459
1460 #if defined(CONFIG_ACPI) && defined(CONFIG_ACPI_WATCHDOG)
1461 extern bool acpi_has_watchdog(void);
1462 #else
1463 static inline bool acpi_has_watchdog(void) { return false; }
1464 #endif
1465
1466 #ifdef CONFIG_ACPI_SPCR_TABLE
1467 extern bool qdf2400_e44_present;
1468 int acpi_parse_spcr(bool enable_earlycon, bool enable_console);
1469 #else
1470 static inline int acpi_parse_spcr(bool enable_earlycon, bool enable_console)
1471 {
1472         return 0;
1473 }
1474 #endif
1475
1476 #if IS_ENABLED(CONFIG_ACPI_GENERIC_GSI)
1477 int acpi_irq_get(acpi_handle handle, unsigned int index, struct resource *res);
1478 #else
1479 static inline
1480 int acpi_irq_get(acpi_handle handle, unsigned int index, struct resource *res)
1481 {
1482         return -EINVAL;
1483 }
1484 #endif
1485
1486 #ifdef CONFIG_ACPI_LPIT
1487 int lpit_read_residency_count_address(u64 *address);
1488 #else
1489 static inline int lpit_read_residency_count_address(u64 *address)
1490 {
1491         return -EINVAL;
1492 }
1493 #endif
1494
1495 #ifdef CONFIG_ACPI_PROCESSOR_IDLE
1496 #ifndef arch_get_idle_state_flags
1497 static inline unsigned int arch_get_idle_state_flags(u32 arch_flags)
1498 {
1499         return 0;
1500 }
1501 #endif
1502 #endif /* CONFIG_ACPI_PROCESSOR_IDLE */
1503
1504 #ifdef CONFIG_ACPI_PPTT
1505 int acpi_pptt_cpu_is_thread(unsigned int cpu);
1506 int find_acpi_cpu_topology(unsigned int cpu, int level);
1507 int find_acpi_cpu_topology_cluster(unsigned int cpu);
1508 int find_acpi_cpu_topology_package(unsigned int cpu);
1509 int find_acpi_cpu_topology_hetero_id(unsigned int cpu);
1510 #else
1511 static inline int acpi_pptt_cpu_is_thread(unsigned int cpu)
1512 {
1513         return -EINVAL;
1514 }
1515 static inline int find_acpi_cpu_topology(unsigned int cpu, int level)
1516 {
1517         return -EINVAL;
1518 }
1519 static inline int find_acpi_cpu_topology_cluster(unsigned int cpu)
1520 {
1521         return -EINVAL;
1522 }
1523 static inline int find_acpi_cpu_topology_package(unsigned int cpu)
1524 {
1525         return -EINVAL;
1526 }
1527 static inline int find_acpi_cpu_topology_hetero_id(unsigned int cpu)
1528 {
1529         return -EINVAL;
1530 }
1531 #endif
1532
1533 void acpi_arch_init(void);
1534
1535 #ifdef CONFIG_ACPI_PCC
1536 void acpi_init_pcc(void);
1537 #else
1538 static inline void acpi_init_pcc(void) { }
1539 #endif
1540
1541 #ifdef CONFIG_ACPI_FFH
1542 void acpi_init_ffh(void);
1543 extern int acpi_ffh_address_space_arch_setup(void *handler_ctxt,
1544                                              void **region_ctxt);
1545 extern int acpi_ffh_address_space_arch_handler(acpi_integer *value,
1546                                                void *region_context);
1547 #else
1548 static inline void acpi_init_ffh(void) { }
1549 #endif
1550
1551 #ifdef CONFIG_ACPI
1552 extern void acpi_device_notify(struct device *dev);
1553 extern void acpi_device_notify_remove(struct device *dev);
1554 #else
1555 static inline void acpi_device_notify(struct device *dev) { }
1556 static inline void acpi_device_notify_remove(struct device *dev) { }
1557 #endif
1558
1559 static inline void acpi_use_parent_companion(struct device *dev)
1560 {
1561         ACPI_COMPANION_SET(dev, ACPI_COMPANION(dev->parent));
1562 }
1563
1564 #ifdef CONFIG_ACPI_HMAT
1565 int hmat_update_target_coordinates(int nid, struct access_coordinate *coord,
1566                                    enum access_coordinate_class access);
1567 #else
1568 static inline int hmat_update_target_coordinates(int nid,
1569                                                  struct access_coordinate *coord,
1570                                                  enum access_coordinate_class access)
1571 {
1572         return -EOPNOTSUPP;
1573 }
1574 #endif
1575
1576 #ifdef CONFIG_ACPI_NUMA
1577 bool acpi_node_backed_by_real_pxm(int nid);
1578 #else
1579 static inline bool acpi_node_backed_by_real_pxm(int nid)
1580 {
1581         return false;
1582 }
1583 #endif
1584
1585 #endif  /*_LINUX_ACPI_H*/