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