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