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