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