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 void __init acpi_check_s4_hw_signature(int check);
 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
 584 /* USB4 Capabilities */
 585 #define OSC_USB_USB3_TUNNELING                  0x00000001
 586 #define OSC_USB_DP_TUNNELING                    0x00000002
 587 #define OSC_USB_PCIE_TUNNELING                  0x00000004
 588 #define OSC_USB_XDOMAIN                         0x00000008
 589
 590 extern u32 osc_sb_native_usb4_control;
 591
 592 /* PCI Host Bridge _OSC: Capabilities DWORD 2: Support Field */
 593 #define OSC_PCI_EXT_CONFIG_SUPPORT              0x00000001
 594 #define OSC_PCI_ASPM_SUPPORT                    0x00000002
 595 #define OSC_PCI_CLOCK_PM_SUPPORT                0x00000004
 596 #define OSC_PCI_SEGMENT_GROUPS_SUPPORT          0x00000008
 597 #define OSC_PCI_MSI_SUPPORT                     0x00000010
 598 #define OSC_PCI_EDR_SUPPORT                     0x00000080
 599 #define OSC_PCI_HPX_TYPE_3_SUPPORT              0x00000100
 600
 601 /* PCI Host Bridge _OSC: Capabilities DWORD 3: Control Field */
 602 #define OSC_PCI_EXPRESS_NATIVE_HP_CONTROL       0x00000001
 603 #define OSC_PCI_SHPC_NATIVE_HP_CONTROL          0x00000002
 604 #define OSC_PCI_EXPRESS_PME_CONTROL             0x00000004
 605 #define OSC_PCI_EXPRESS_AER_CONTROL             0x00000008
 606 #define OSC_PCI_EXPRESS_CAPABILITY_CONTROL      0x00000010
 607 #define OSC_PCI_EXPRESS_LTR_CONTROL             0x00000020
 608 #define OSC_PCI_EXPRESS_DPC_CONTROL             0x00000080
 609
 610 #define ACPI_GSB_ACCESS_ATTRIB_QUICK            0x00000002
 611 #define ACPI_GSB_ACCESS_ATTRIB_SEND_RCV         0x00000004
 612 #define ACPI_GSB_ACCESS_ATTRIB_BYTE             0x00000006
 613 #define ACPI_GSB_ACCESS_ATTRIB_WORD             0x00000008
 614 #define ACPI_GSB_ACCESS_ATTRIB_BLOCK            0x0000000A
 615 #define ACPI_GSB_ACCESS_ATTRIB_MULTIBYTE        0x0000000B
 616 #define ACPI_GSB_ACCESS_ATTRIB_WORD_CALL        0x0000000C
 617 #define ACPI_GSB_ACCESS_ATTRIB_BLOCK_CALL       0x0000000D
 618 #define ACPI_GSB_ACCESS_ATTRIB_RAW_BYTES        0x0000000E
 619 #define ACPI_GSB_ACCESS_ATTRIB_RAW_PROCESS      0x0000000F
 620
 621 /* Enable _OST when all relevant hotplug operations are enabled */
 622 #if defined(CONFIG_ACPI_HOTPLUG_CPU) &&                 \
 623         defined(CONFIG_ACPI_HOTPLUG_MEMORY) &&          \
 624         defined(CONFIG_ACPI_CONTAINER)
 625 #define ACPI_HOTPLUG_OST
 626 #endif
 627
 628 /* _OST Source Event Code (OSPM Action) */
 629 #define ACPI_OST_EC_OSPM_SHUTDOWN               0x100
 630 #define ACPI_OST_EC_OSPM_EJECT                  0x103
 631 #define ACPI_OST_EC_OSPM_INSERTION              0x200
 632
 633 /* _OST General Processing Status Code */
 634 #define ACPI_OST_SC_SUCCESS                     0x0
 635 #define ACPI_OST_SC_NON_SPECIFIC_FAILURE        0x1
 636 #define ACPI_OST_SC_UNRECOGNIZED_NOTIFY         0x2
 637
 638 /* _OST OS Shutdown Processing (0x100) Status Code */
 639 #define ACPI_OST_SC_OS_SHUTDOWN_DENIED          0x80
 640 #define ACPI_OST_SC_OS_SHUTDOWN_IN_PROGRESS     0x81
 641 #define ACPI_OST_SC_OS_SHUTDOWN_COMPLETED       0x82
 642 #define ACPI_OST_SC_OS_SHUTDOWN_NOT_SUPPORTED   0x83
 643
 644 /* _OST Ejection Request (0x3, 0x103) Status Code */
 645 #define ACPI_OST_SC_EJECT_NOT_SUPPORTED         0x80
 646 #define ACPI_OST_SC_DEVICE_IN_USE               0x81
 647 #define ACPI_OST_SC_DEVICE_BUSY                 0x82
 648 #define ACPI_OST_SC_EJECT_DEPENDENCY_BUSY       0x83
 649 #define ACPI_OST_SC_EJECT_IN_PROGRESS           0x84
 650
 651 /* _OST Insertion Request (0x200) Status Code */
 652 #define ACPI_OST_SC_INSERT_IN_PROGRESS          0x80
 653 #define ACPI_OST_SC_DRIVER_LOAD_FAILURE         0x81
 654 #define ACPI_OST_SC_INSERT_NOT_SUPPORTED        0x82
 655
 656 enum acpi_predicate {
 657         all_versions,
 658         less_than_or_equal,
 659         equal,
 660         greater_than_or_equal,
 661 };
 662
 663 /* Table must be terminted by a NULL entry */
 664 struct acpi_platform_list {
 665         char    oem_id[ACPI_OEM_ID_SIZE+1];
 666         char    oem_table_id[ACPI_OEM_TABLE_ID_SIZE+1];
 667         u32     oem_revision;
 668         char    *table;
 669         enum acpi_predicate pred;
 670         char    *reason;
 671         u32     data;
 672 };
 673 int acpi_match_platform_list(const struct acpi_platform_list *plat);
 674
 675 extern void acpi_early_init(void);
 676 extern void acpi_subsystem_init(void);
 677 extern void arch_post_acpi_subsys_init(void);
 678
 679 extern int acpi_nvs_register(__u64 start, __u64 size);
 680
 681 extern int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
 682                                     void *data);
 683
 684 const struct acpi_device_id *acpi_match_device(const struct acpi_device_id *ids,
 685                                                const struct device *dev);
 686
 687 const void *acpi_device_get_match_data(const struct device *dev);
 688 extern bool acpi_driver_match_device(struct device *dev,
 689                                      const struct device_driver *drv);
 690 int acpi_device_uevent_modalias(struct device *, struct kobj_uevent_env *);
 691 int acpi_device_modalias(struct device *, char *, int);
 692
 693 struct platform_device *acpi_create_platform_device(struct acpi_device *,
 694                                                     struct property_entry *);
 695 #define ACPI_PTR(_ptr)  (_ptr)
 696
 697 static inline void acpi_device_set_enumerated(struct acpi_device *adev)
 698 {
 699         adev->flags.visited = true;
 700 }
 701
 702 static inline void acpi_device_clear_enumerated(struct acpi_device *adev)
 703 {
 704         adev->flags.visited = false;
 705 }
 706
 707 enum acpi_reconfig_event  {
 708         ACPI_RECONFIG_DEVICE_ADD = 0,
 709         ACPI_RECONFIG_DEVICE_REMOVE,
 710 };
 711
 712 int acpi_reconfig_notifier_register(struct notifier_block *nb);
 713 int acpi_reconfig_notifier_unregister(struct notifier_block *nb);
 714
 715 #ifdef CONFIG_ACPI_GTDT
 716 int acpi_gtdt_init(struct acpi_table_header *table, int *platform_timer_count);
 717 int acpi_gtdt_map_ppi(int type);
 718 bool acpi_gtdt_c3stop(int type);
 719 int acpi_arch_timer_mem_init(struct arch_timer_mem *timer_mem, int *timer_count);
 720 #endif
 721
 722 #ifndef ACPI_HAVE_ARCH_SET_ROOT_POINTER
 723 static inline void acpi_arch_set_root_pointer(u64 addr)
 724 {
 725 }
 726 #endif
 727
 728 #ifndef ACPI_HAVE_ARCH_GET_ROOT_POINTER
 729 static inline u64 acpi_arch_get_root_pointer(void)
 730 {
 731         return 0;
 732 }
 733 #endif
 734
 735 int acpi_get_local_address(acpi_handle handle, u32 *addr);
 736
 737 #else   /* !CONFIG_ACPI */
 738
 739 #define acpi_disabled 1
 740
 741 #define ACPI_COMPANION(dev)             (NULL)
 742 #define ACPI_COMPANION_SET(dev, adev)   do { } while (0)
 743 #define ACPI_HANDLE(dev)                (NULL)
 744 #define ACPI_HANDLE_FWNODE(fwnode)      (NULL)
 745 #define ACPI_DEVICE_CLASS(_cls, _msk)   .cls = (0), .cls_msk = (0),
 746
 747 #include <acpi/acpi_numa.h>
 748
 749 struct fwnode_handle;
 750
 751 static inline bool acpi_dev_found(const char *hid)
 752 {
 753         return false;
 754 }
 755
 756 static inline bool acpi_dev_present(const char *hid, const char *uid, s64 hrv)
 757 {
 758         return false;
 759 }
 760
 761 struct acpi_device;
 762
 763 static inline bool
 764 acpi_dev_hid_uid_match(struct acpi_device *adev, const char *hid2, const char *uid2)
 765 {
 766         return false;
 767 }
 768
 769 static inline struct acpi_device *
 770 acpi_dev_get_first_match_dev(const char *hid, const char *uid, s64 hrv)
 771 {
 772         return NULL;
 773 }
 774
 775 static inline bool acpi_reduced_hardware(void)
 776 {
 777         return false;
 778 }
 779
 780 static inline void acpi_dev_put(struct acpi_device *adev) {}
 781
 782 static inline bool is_acpi_node(const struct fwnode_handle *fwnode)
 783 {
 784         return false;
 785 }
 786
 787 static inline bool is_acpi_device_node(const struct fwnode_handle *fwnode)
 788 {
 789         return false;
 790 }
 791
 792 static inline struct acpi_device *to_acpi_device_node(const struct fwnode_handle *fwnode)
 793 {
 794         return NULL;
 795 }
 796
 797 static inline bool is_acpi_data_node(const struct fwnode_handle *fwnode)
 798 {
 799         return false;
 800 }
 801
 802 static inline struct acpi_data_node *to_acpi_data_node(const struct fwnode_handle *fwnode)
 803 {
 804         return NULL;
 805 }
 806
 807 static inline bool acpi_data_node_match(const struct fwnode_handle *fwnode,
 808                                         const char *name)
 809 {
 810         return false;
 811 }
 812
 813 static inline struct fwnode_handle *acpi_fwnode_handle(struct acpi_device *adev)
 814 {
 815         return NULL;
 816 }
 817
 818 static inline bool has_acpi_companion(struct device *dev)
 819 {
 820         return false;
 821 }
 822
 823 static inline void acpi_preset_companion(struct device *dev,
 824                                          struct acpi_device *parent, u64 addr)
 825 {
 826 }
 827
 828 static inline const char *acpi_dev_name(struct acpi_device *adev)
 829 {
 830         return NULL;
 831 }
 832
 833 static inline struct device *acpi_get_first_physical_node(struct acpi_device *adev)
 834 {
 835         return NULL;
 836 }
 837
 838 static inline void acpi_early_init(void) { }
 839 static inline void acpi_subsystem_init(void) { }
 840
 841 static inline int early_acpi_boot_init(void)
 842 {
 843         return 0;
 844 }
 845 static inline int acpi_boot_init(void)
 846 {
 847         return 0;
 848 }
 849
 850 static inline void acpi_boot_table_prepare(void)
 851 {
 852 }
 853
 854 static inline void acpi_boot_table_init(void)
 855 {
 856 }
 857
 858 static inline int acpi_mps_check(void)
 859 {
 860         return 0;
 861 }
 862
 863 static inline int acpi_check_resource_conflict(struct resource *res)
 864 {
 865         return 0;
 866 }
 867
 868 static inline int acpi_check_region(resource_size_t start, resource_size_t n,
 869                                     const char *name)
 870 {
 871         return 0;
 872 }
 873
 874 struct acpi_table_header;
 875 static inline int acpi_table_parse(char *id,
 876                                 int (*handler)(struct acpi_table_header *))
 877 {
 878         return -ENODEV;
 879 }
 880
 881 static inline int acpi_nvs_register(__u64 start, __u64 size)
 882 {
 883         return 0;
 884 }
 885
 886 static inline int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
 887                                            void *data)
 888 {
 889         return 0;
 890 }
 891
 892 struct acpi_device_id;
 893
 894 static inline const struct acpi_device_id *acpi_match_device(
 895         const struct acpi_device_id *ids, const struct device *dev)
 896 {
 897         return NULL;
 898 }
 899
 900 static inline const void *acpi_device_get_match_data(const struct device *dev)
 901 {
 902         return NULL;
 903 }
 904
 905 static inline bool acpi_driver_match_device(struct device *dev,
 906                                             const struct device_driver *drv)
 907 {
 908         return false;
 909 }
 910
 911 static inline union acpi_object *acpi_evaluate_dsm(acpi_handle handle,
 912                                                    const guid_t *guid,
 913                                                    u64 rev, u64 func,
 914                                                    union acpi_object *argv4)
 915 {
 916         return NULL;
 917 }
 918
 919 static inline int acpi_device_uevent_modalias(struct device *dev,
 920                                 struct kobj_uevent_env *env)
 921 {
 922         return -ENODEV;
 923 }
 924
 925 static inline int acpi_device_modalias(struct device *dev,
 926                                 char *buf, int size)
 927 {
 928         return -ENODEV;
 929 }
 930
 931 static inline struct platform_device *
 932 acpi_create_platform_device(struct acpi_device *adev,
 933                             struct property_entry *properties)
 934 {
 935         return NULL;
 936 }
 937
 938 static inline bool acpi_dma_supported(const struct acpi_device *adev)
 939 {
 940         return false;
 941 }
 942
 943 static inline enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev)
 944 {
 945         return DEV_DMA_NOT_SUPPORTED;
 946 }
 947
 948 static inline int acpi_dma_get_range(struct device *dev, u64 *dma_addr,
 949                                      u64 *offset, u64 *size)
 950 {
 951         return -ENODEV;
 952 }
 953
 954 static inline int acpi_dma_configure(struct device *dev,
 955                                      enum dev_dma_attr attr)
 956 {
 957         return 0;
 958 }
 959
 960 static inline int acpi_dma_configure_id(struct device *dev,
 961                                         enum dev_dma_attr attr,
 962                                         const u32 *input_id)
 963 {
 964         return 0;
 965 }
 966
 967 #define ACPI_PTR(_ptr)  (NULL)
 968
 969 static inline void acpi_device_set_enumerated(struct acpi_device *adev)
 970 {
 971 }
 972
 973 static inline void acpi_device_clear_enumerated(struct acpi_device *adev)
 974 {
 975 }
 976
 977 static inline int acpi_reconfig_notifier_register(struct notifier_block *nb)
 978 {
 979         return -EINVAL;
 980 }
 981
 982 static inline int acpi_reconfig_notifier_unregister(struct notifier_block *nb)
 983 {
 984         return -EINVAL;
 985 }
 986
 987 static inline struct acpi_device *acpi_resource_consumer(struct resource *res)
 988 {
 989         return NULL;
 990 }
 991
 992 static inline int acpi_get_local_address(acpi_handle handle, u32 *addr)
 993 {
 994         return -ENODEV;
 995 }
 996
 997 static inline int acpi_register_wakeup_handler(int wake_irq,
 998         bool (*wakeup)(void *context), void *context)
 999 {
1000         return -ENXIO;
1001 }
1002
1003 static inline void acpi_unregister_wakeup_handler(
1004         bool (*wakeup)(void *context), void *context) { }
1005
1006 #endif  /* !CONFIG_ACPI */
1007
1008 #ifdef CONFIG_ACPI_HOTPLUG_IOAPIC
1009 int acpi_ioapic_add(acpi_handle root);
1010 #else
1011 static inline int acpi_ioapic_add(acpi_handle root) { return 0; }
1012 #endif
1013
1014 #ifdef CONFIG_ACPI
1015 void acpi_os_set_prepare_sleep(int (*func)(u8 sleep_state,
1016                                u32 pm1a_ctrl,  u32 pm1b_ctrl));
1017
1018 acpi_status acpi_os_prepare_sleep(u8 sleep_state,
1019                                   u32 pm1a_control, u32 pm1b_control);
1020
1021 void acpi_os_set_prepare_extended_sleep(int (*func)(u8 sleep_state,
1022                                         u32 val_a,  u32 val_b));
1023
1024 acpi_status acpi_os_prepare_extended_sleep(u8 sleep_state,
1025                                            u32 val_a, u32 val_b);
1026 #ifdef CONFIG_X86
1027 struct acpi_s2idle_dev_ops {
1028         struct list_head list_node;
1029         void (*prepare)(void);
1030         void (*restore)(void);
1031 };
1032 int acpi_register_lps0_dev(struct acpi_s2idle_dev_ops *arg);
1033 void acpi_unregister_lps0_dev(struct acpi_s2idle_dev_ops *arg);
1034 #endif /* CONFIG_X86 */
1035 #ifndef CONFIG_IA64
1036 void arch_reserve_mem_area(acpi_physical_address addr, size_t size);
1037 #else
1038 static inline void arch_reserve_mem_area(acpi_physical_address addr,
1039                                           size_t size)
1040 {
1041 }
1042 #endif /* CONFIG_X86 */
1043 #else
1044 #define acpi_os_set_prepare_sleep(func, pm1a_ctrl, pm1b_ctrl) do { } while (0)
1045 #endif
1046
1047 #if defined(CONFIG_ACPI) && defined(CONFIG_PM)
1048 int acpi_dev_suspend(struct device *dev, bool wakeup);
1049 int acpi_dev_resume(struct device *dev);
1050 int acpi_subsys_runtime_suspend(struct device *dev);
1051 int acpi_subsys_runtime_resume(struct device *dev);
1052 int acpi_dev_pm_attach(struct device *dev, bool power_on);
1053 bool acpi_storage_d3(struct device *dev);
1054 bool acpi_dev_state_d0(struct device *dev);
1055 #else
1056 static inline int acpi_subsys_runtime_suspend(struct device *dev) { return 0; }
1057 static inline int acpi_subsys_runtime_resume(struct device *dev) { return 0; }
1058 static inline int acpi_dev_pm_attach(struct device *dev, bool power_on)
1059 {
1060         return 0;
1061 }
1062 static inline bool acpi_storage_d3(struct device *dev)
1063 {
1064         return false;
1065 }
1066 static inline bool acpi_dev_state_d0(struct device *dev)
1067 {
1068         return true;
1069 }
1070 #endif
1071
1072 #if defined(CONFIG_ACPI) && defined(CONFIG_PM_SLEEP)
1073 int acpi_subsys_prepare(struct device *dev);
1074 void acpi_subsys_complete(struct device *dev);
1075 int acpi_subsys_suspend_late(struct device *dev);
1076 int acpi_subsys_suspend_noirq(struct device *dev);
1077 int acpi_subsys_suspend(struct device *dev);
1078 int acpi_subsys_freeze(struct device *dev);
1079 int acpi_subsys_poweroff(struct device *dev);
1080 void acpi_ec_mark_gpe_for_wake(void);
1081 void acpi_ec_set_gpe_wake_mask(u8 action);
1082 #else
1083 static inline int acpi_subsys_prepare(struct device *dev) { return 0; }
1084 static inline void acpi_subsys_complete(struct device *dev) {}
1085 static inline int acpi_subsys_suspend_late(struct device *dev) { return 0; }
1086 static inline int acpi_subsys_suspend_noirq(struct device *dev) { return 0; }
1087 static inline int acpi_subsys_suspend(struct device *dev) { return 0; }
1088 static inline int acpi_subsys_freeze(struct device *dev) { return 0; }
1089 static inline int acpi_subsys_poweroff(struct device *dev) { return 0; }
1090 static inline void acpi_ec_mark_gpe_for_wake(void) {}
1091 static inline void acpi_ec_set_gpe_wake_mask(u8 action) {}
1092 #endif
1093
1094 #ifdef CONFIG_ACPI
1095 __printf(3, 4)
1096 void acpi_handle_printk(const char *level, acpi_handle handle,
1097                         const char *fmt, ...);
1098 void acpi_evaluation_failure_warn(acpi_handle handle, const char *name,
1099                                   acpi_status status);
1100 #else   /* !CONFIG_ACPI */
1101 static inline __printf(3, 4) void
1102 acpi_handle_printk(const char *level, void *handle, const char *fmt, ...) {}
1103 static inline void acpi_evaluation_failure_warn(acpi_handle handle,
1104                                                 const char *name,
1105                                                 acpi_status status) {}
1106 #endif  /* !CONFIG_ACPI */
1107
1108 #if defined(CONFIG_ACPI) && defined(CONFIG_DYNAMIC_DEBUG)
1109 __printf(3, 4)
1110 void __acpi_handle_debug(struct _ddebug *descriptor, acpi_handle handle, const char *fmt, ...);
1111 #endif
1112
1113 /*
1114  * acpi_handle_<level>: Print message with ACPI prefix and object path
1115  *
1116  * These interfaces acquire the global namespace mutex to obtain an object
1117  * path.  In interrupt context, it shows the object path as <n/a>.
1118  */
1119 #define acpi_handle_emerg(handle, fmt, ...)                             \
1120         acpi_handle_printk(KERN_EMERG, handle, fmt, ##__VA_ARGS__)
1121 #define acpi_handle_alert(handle, fmt, ...)                             \
1122         acpi_handle_printk(KERN_ALERT, handle, fmt, ##__VA_ARGS__)
1123 #define acpi_handle_crit(handle, fmt, ...)                              \
1124         acpi_handle_printk(KERN_CRIT, handle, fmt, ##__VA_ARGS__)
1125 #define acpi_handle_err(handle, fmt, ...)                               \
1126         acpi_handle_printk(KERN_ERR, handle, fmt, ##__VA_ARGS__)
1127 #define acpi_handle_warn(handle, fmt, ...)                              \
1128         acpi_handle_printk(KERN_WARNING, handle, fmt, ##__VA_ARGS__)
1129 #define acpi_handle_notice(handle, fmt, ...)                            \
1130         acpi_handle_printk(KERN_NOTICE, handle, fmt, ##__VA_ARGS__)
1131 #define acpi_handle_info(handle, fmt, ...)                              \
1132         acpi_handle_printk(KERN_INFO, handle, fmt, ##__VA_ARGS__)
1133
1134 #if defined(DEBUG)
1135 #define acpi_handle_debug(handle, fmt, ...)                             \
1136         acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__)
1137 #else
1138 #if defined(CONFIG_DYNAMIC_DEBUG)
1139 #define acpi_handle_debug(handle, fmt, ...)                             \
1140         _dynamic_func_call(fmt, __acpi_handle_debug,                    \
1141                            handle, pr_fmt(fmt), ##__VA_ARGS__)
1142 #else
1143 #define acpi_handle_debug(handle, fmt, ...)                             \
1144 ({                                                                      \
1145         if (0)                                                          \
1146                 acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__); \
1147         0;                                                              \
1148 })
1149 #endif
1150 #endif
1151
1152 #if defined(CONFIG_ACPI) && defined(CONFIG_GPIOLIB)
1153 bool acpi_gpio_get_irq_resource(struct acpi_resource *ares,
1154                                 struct acpi_resource_gpio **agpio);
1155 bool acpi_gpio_get_io_resource(struct acpi_resource *ares,
1156                                struct acpi_resource_gpio **agpio);
1157 int acpi_dev_gpio_irq_get_by(struct acpi_device *adev, const char *name, int index);
1158 #else
1159 static inline bool acpi_gpio_get_irq_resource(struct acpi_resource *ares,
1160                                               struct acpi_resource_gpio **agpio)
1161 {
1162         return false;
1163 }
1164 static inline bool acpi_gpio_get_io_resource(struct acpi_resource *ares,
1165                                              struct acpi_resource_gpio **agpio)
1166 {
1167         return false;
1168 }
1169 static inline int acpi_dev_gpio_irq_get_by(struct acpi_device *adev,
1170                                            const char *name, int index)
1171 {
1172         return -ENXIO;
1173 }
1174 #endif
1175
1176 static inline int acpi_dev_gpio_irq_get(struct acpi_device *adev, int index)
1177 {
1178         return acpi_dev_gpio_irq_get_by(adev, NULL, index);
1179 }
1180
1181 /* Device properties */
1182
1183 #ifdef CONFIG_ACPI
1184 int acpi_dev_get_property(const struct acpi_device *adev, const char *name,
1185                           acpi_object_type type, const union acpi_object **obj);
1186 int __acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
1187                                 const char *name, size_t index, size_t num_args,
1188                                 struct fwnode_reference_args *args);
1189
1190 static inline int acpi_node_get_property_reference(
1191                                 const struct fwnode_handle *fwnode,
1192                                 const char *name, size_t index,
1193                                 struct fwnode_reference_args *args)
1194 {
1195         return __acpi_node_get_property_reference(fwnode, name, index,
1196                 NR_FWNODE_REFERENCE_ARGS, args);
1197 }
1198
1199 static inline bool acpi_dev_has_props(const struct acpi_device *adev)
1200 {
1201         return !list_empty(&adev->data.properties);
1202 }
1203
1204 struct acpi_device_properties *
1205 acpi_data_add_props(struct acpi_device_data *data, const guid_t *guid,
1206                     const union acpi_object *properties);
1207
1208 int acpi_node_prop_get(const struct fwnode_handle *fwnode, const char *propname,
1209                        void **valptr);
1210
1211 struct fwnode_handle *acpi_get_next_subnode(const struct fwnode_handle *fwnode,
1212                                             struct fwnode_handle *child);
1213
1214 struct acpi_probe_entry;
1215 typedef bool (*acpi_probe_entry_validate_subtbl)(struct acpi_subtable_header *,
1216                                                  struct acpi_probe_entry *);
1217
1218 #define ACPI_TABLE_ID_LEN       5
1219
1220 /**
1221  * struct acpi_probe_entry - boot-time probing entry
1222  * @id:                 ACPI table name
1223  * @type:               Optional subtable type to match
1224  *                      (if @id contains subtables)
1225  * @subtable_valid:     Optional callback to check the validity of
1226  *                      the subtable
1227  * @probe_table:        Callback to the driver being probed when table
1228  *                      match is successful
1229  * @probe_subtbl:       Callback to the driver being probed when table and
1230  *                      subtable match (and optional callback is successful)
1231  * @driver_data:        Sideband data provided back to the driver
1232  */
1233 struct acpi_probe_entry {
1234         __u8 id[ACPI_TABLE_ID_LEN];
1235         __u8 type;
1236         acpi_probe_entry_validate_subtbl subtable_valid;
1237         union {
1238                 acpi_tbl_table_handler probe_table;
1239                 acpi_tbl_entry_handler probe_subtbl;
1240         };
1241         kernel_ulong_t driver_data;
1242 };
1243
1244 #define ACPI_DECLARE_PROBE_ENTRY(table, name, table_id, subtable,       \
1245                                  valid, data, fn)                       \
1246         static const struct acpi_probe_entry __acpi_probe_##name        \
1247                 __used __section("__" #table "_acpi_probe_table") = {   \
1248                         .id = table_id,                                 \
1249                         .type = subtable,                               \
1250                         .subtable_valid = valid,                        \
1251                         .probe_table = fn,                              \
1252                         .driver_data = data,                            \
1253                 }
1254
1255 #define ACPI_DECLARE_SUBTABLE_PROBE_ENTRY(table, name, table_id,        \
1256                                           subtable, valid, data, fn)    \
1257         static const struct acpi_probe_entry __acpi_probe_##name        \
1258                 __used __section("__" #table "_acpi_probe_table") = {   \
1259                         .id = table_id,                                 \
1260                         .type = subtable,                               \
1261                         .subtable_valid = valid,                        \
1262                         .probe_subtbl = fn,                             \
1263                         .driver_data = data,                            \
1264                 }
1265
1266 #define ACPI_PROBE_TABLE(name)          __##name##_acpi_probe_table
1267 #define ACPI_PROBE_TABLE_END(name)      __##name##_acpi_probe_table_end
1268
1269 int __acpi_probe_device_table(struct acpi_probe_entry *start, int nr);
1270
1271 #define acpi_probe_device_table(t)                                      \
1272         ({                                                              \
1273                 extern struct acpi_probe_entry ACPI_PROBE_TABLE(t),     \
1274                                                ACPI_PROBE_TABLE_END(t); \
1275                 __acpi_probe_device_table(&ACPI_PROBE_TABLE(t),         \
1276                                           (&ACPI_PROBE_TABLE_END(t) -   \
1277                                            &ACPI_PROBE_TABLE(t)));      \
1278         })
1279 #else
1280 static inline int acpi_dev_get_property(struct acpi_device *adev,
1281                                         const char *name, acpi_object_type type,
1282                                         const union acpi_object **obj)
1283 {
1284         return -ENXIO;
1285 }
1286
1287 static inline int
1288 __acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
1289                                 const char *name, size_t index, size_t num_args,
1290                                 struct fwnode_reference_args *args)
1291 {
1292         return -ENXIO;
1293 }
1294
1295 static inline int
1296 acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
1297                                  const char *name, size_t index,
1298                                  struct fwnode_reference_args *args)
1299 {
1300         return -ENXIO;
1301 }
1302
1303 static inline int acpi_node_prop_get(const struct fwnode_handle *fwnode,
1304                                      const char *propname,
1305                                      void **valptr)
1306 {
1307         return -ENXIO;
1308 }
1309
1310 static inline struct fwnode_handle *
1311 acpi_get_next_subnode(const struct fwnode_handle *fwnode,
1312                       struct fwnode_handle *child)
1313 {
1314         return NULL;
1315 }
1316
1317 static inline struct fwnode_handle *
1318 acpi_graph_get_next_endpoint(const struct fwnode_handle *fwnode,
1319                              struct fwnode_handle *prev)
1320 {
1321         return ERR_PTR(-ENXIO);
1322 }
1323
1324 static inline int
1325 acpi_graph_get_remote_endpoint(const struct fwnode_handle *fwnode,
1326                                struct fwnode_handle **remote,
1327                                struct fwnode_handle **port,
1328                                struct fwnode_handle **endpoint)
1329 {
1330         return -ENXIO;
1331 }
1332
1333 #define ACPI_DECLARE_PROBE_ENTRY(table, name, table_id, subtable, valid, data, fn) \
1334         static const void * __acpi_table_##name[]                       \
1335                 __attribute__((unused))                                 \
1336                  = { (void *) table_id,                                 \
1337                      (void *) subtable,                                 \
1338                      (void *) valid,                                    \
1339                      (void *) fn,                                       \
1340                      (void *) data }
1341
1342 #define acpi_probe_device_table(t)      ({ int __r = 0; __r;})
1343 #endif
1344
1345 #ifdef CONFIG_ACPI_TABLE_UPGRADE
1346 void acpi_table_upgrade(void);
1347 #else
1348 static inline void acpi_table_upgrade(void) { }
1349 #endif
1350
1351 #if defined(CONFIG_ACPI) && defined(CONFIG_ACPI_WATCHDOG)
1352 extern bool acpi_has_watchdog(void);
1353 #else
1354 static inline bool acpi_has_watchdog(void) { return false; }
1355 #endif
1356
1357 #ifdef CONFIG_ACPI_SPCR_TABLE
1358 extern bool qdf2400_e44_present;
1359 int acpi_parse_spcr(bool enable_earlycon, bool enable_console);
1360 #else
1361 static inline int acpi_parse_spcr(bool enable_earlycon, bool enable_console)
1362 {
1363         return 0;
1364 }
1365 #endif
1366
1367 #if IS_ENABLED(CONFIG_ACPI_GENERIC_GSI)
1368 int acpi_irq_get(acpi_handle handle, unsigned int index, struct resource *res);
1369 #else
1370 static inline
1371 int acpi_irq_get(acpi_handle handle, unsigned int index, struct resource *res)
1372 {
1373         return -EINVAL;
1374 }
1375 #endif
1376
1377 #ifdef CONFIG_ACPI_LPIT
1378 int lpit_read_residency_count_address(u64 *address);
1379 #else
1380 static inline int lpit_read_residency_count_address(u64 *address)
1381 {
1382         return -EINVAL;
1383 }
1384 #endif
1385
1386 #ifdef CONFIG_ACPI_PPTT
1387 int acpi_pptt_cpu_is_thread(unsigned int cpu);
1388 int find_acpi_cpu_topology(unsigned int cpu, int level);
1389 int find_acpi_cpu_topology_cluster(unsigned int cpu);
1390 int find_acpi_cpu_topology_package(unsigned int cpu);
1391 int find_acpi_cpu_topology_hetero_id(unsigned int cpu);
1392 int find_acpi_cpu_cache_topology(unsigned int cpu, int level);
1393 #else
1394 static inline int acpi_pptt_cpu_is_thread(unsigned int cpu)
1395 {
1396         return -EINVAL;
1397 }
1398 static inline int find_acpi_cpu_topology(unsigned int cpu, int level)
1399 {
1400         return -EINVAL;
1401 }
1402 static inline int find_acpi_cpu_topology_cluster(unsigned int cpu)
1403 {
1404         return -EINVAL;
1405 }
1406 static inline int find_acpi_cpu_topology_package(unsigned int cpu)
1407 {
1408         return -EINVAL;
1409 }
1410 static inline int find_acpi_cpu_topology_hetero_id(unsigned int cpu)
1411 {
1412         return -EINVAL;
1413 }
1414 static inline int find_acpi_cpu_cache_topology(unsigned int cpu, int level)
1415 {
1416         return -EINVAL;
1417 }
1418 #endif
1419
1420 #ifdef CONFIG_ACPI_PCC
1421 void acpi_init_pcc(void);
1422 #else
1423 static inline void acpi_init_pcc(void) { }
1424 #endif
1425
1426 #ifdef CONFIG_ACPI
1427 extern void acpi_device_notify(struct device *dev);
1428 extern void acpi_device_notify_remove(struct device *dev);
1429 #else
1430 static inline void acpi_device_notify(struct device *dev) { }
1431 static inline void acpi_device_notify_remove(struct device *dev) { }
1432 #endif
1433
1434 #endif  /*_LINUX_ACPI_H*/