include/linux/acpi.h

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