include/linux/acpi.h

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