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