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