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