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