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