linux/include/linux/acpi.h
<<
>>
Prefs
   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
  30#ifndef _LINUX
  31#define _LINUX
  32#endif
  33#include <acpi/acpi.h>
  34
  35#ifdef  CONFIG_ACPI
  36
  37#include <linux/list.h>
  38#include <linux/mod_devicetable.h>
  39#include <linux/dynamic_debug.h>
  40#include <linux/module.h>
  41#include <linux/mutex.h>
  42
  43#include <acpi/acpi_bus.h>
  44#include <acpi/acpi_drivers.h>
  45#include <acpi/acpi_numa.h>
  46#include <acpi/acpi_io.h>
  47#include <asm/acpi.h>
  48
  49static inline acpi_handle acpi_device_handle(struct acpi_device *adev)
  50{
  51        return adev ? adev->handle : NULL;
  52}
  53
  54#define ACPI_COMPANION(dev)             to_acpi_device_node((dev)->fwnode)
  55#define ACPI_COMPANION_SET(dev, adev)   set_primary_fwnode(dev, (adev) ? \
  56        acpi_fwnode_handle(adev) : NULL)
  57#define ACPI_HANDLE(dev)                acpi_device_handle(ACPI_COMPANION(dev))
  58
  59/**
  60 * ACPI_DEVICE_CLASS - macro used to describe an ACPI device with
  61 * the PCI-defined class-code information
  62 *
  63 * @_cls : the class, subclass, prog-if triple for this device
  64 * @_msk : the class mask for this device
  65 *
  66 * This macro is used to create a struct acpi_device_id that matches a
  67 * specific PCI class. The .id and .driver_data fields will be left
  68 * initialized with the default value.
  69 */
  70#define ACPI_DEVICE_CLASS(_cls, _msk)   .cls = (_cls), .cls_msk = (_msk),
  71
  72static inline bool has_acpi_companion(struct device *dev)
  73{
  74        return is_acpi_device_node(dev->fwnode);
  75}
  76
  77static inline void acpi_preset_companion(struct device *dev,
  78                                         struct acpi_device *parent, u64 addr)
  79{
  80        ACPI_COMPANION_SET(dev, acpi_find_child_device(parent, addr, NULL));
  81}
  82
  83static inline const char *acpi_dev_name(struct acpi_device *adev)
  84{
  85        return dev_name(&adev->dev);
  86}
  87
  88enum acpi_irq_model_id {
  89        ACPI_IRQ_MODEL_PIC = 0,
  90        ACPI_IRQ_MODEL_IOAPIC,
  91        ACPI_IRQ_MODEL_IOSAPIC,
  92        ACPI_IRQ_MODEL_PLATFORM,
  93        ACPI_IRQ_MODEL_GIC,
  94        ACPI_IRQ_MODEL_COUNT
  95};
  96
  97extern enum acpi_irq_model_id   acpi_irq_model;
  98
  99enum acpi_interrupt_id {
 100        ACPI_INTERRUPT_PMI      = 1,
 101        ACPI_INTERRUPT_INIT,
 102        ACPI_INTERRUPT_CPEI,
 103        ACPI_INTERRUPT_COUNT
 104};
 105
 106#define ACPI_SPACE_MEM          0
 107
 108enum acpi_address_range_id {
 109        ACPI_ADDRESS_RANGE_MEMORY = 1,
 110        ACPI_ADDRESS_RANGE_RESERVED = 2,
 111        ACPI_ADDRESS_RANGE_ACPI = 3,
 112        ACPI_ADDRESS_RANGE_NVS  = 4,
 113        ACPI_ADDRESS_RANGE_COUNT
 114};
 115
 116
 117/* Table Handlers */
 118
 119typedef int (*acpi_tbl_table_handler)(struct acpi_table_header *table);
 120
 121typedef int (*acpi_tbl_entry_handler)(struct acpi_subtable_header *header,
 122                                      const unsigned long end);
 123
 124/* Debugger support */
 125
 126struct acpi_debugger_ops {
 127        int (*create_thread)(acpi_osd_exec_callback function, void *context);
 128        ssize_t (*write_log)(const char *msg);
 129        ssize_t (*read_cmd)(char *buffer, size_t length);
 130        int (*wait_command_ready)(bool single_step, char *buffer, size_t length);
 131        int (*notify_command_complete)(void);
 132};
 133
 134struct acpi_debugger {
 135        const struct acpi_debugger_ops *ops;
 136        struct module *owner;
 137        struct mutex lock;
 138};
 139
 140#ifdef CONFIG_ACPI_DEBUGGER
 141int __init acpi_debugger_init(void);
 142int acpi_register_debugger(struct module *owner,
 143                           const struct acpi_debugger_ops *ops);
 144void acpi_unregister_debugger(const struct acpi_debugger_ops *ops);
 145int acpi_debugger_create_thread(acpi_osd_exec_callback function, void *context);
 146ssize_t acpi_debugger_write_log(const char *msg);
 147ssize_t acpi_debugger_read_cmd(char *buffer, size_t buffer_length);
 148int acpi_debugger_wait_command_ready(void);
 149int acpi_debugger_notify_command_complete(void);
 150#else
 151static inline int acpi_debugger_init(void)
 152{
 153        return -ENODEV;
 154}
 155
 156static inline int acpi_register_debugger(struct module *owner,
 157                                         const struct acpi_debugger_ops *ops)
 158{
 159        return -ENODEV;
 160}
 161
 162static inline void acpi_unregister_debugger(const struct acpi_debugger_ops *ops)
 163{
 164}
 165
 166static inline int acpi_debugger_create_thread(acpi_osd_exec_callback function,
 167                                              void *context)
 168{
 169        return -ENODEV;
 170}
 171
 172static inline int acpi_debugger_write_log(const char *msg)
 173{
 174        return -ENODEV;
 175}
 176
 177static inline int acpi_debugger_read_cmd(char *buffer, u32 buffer_length)
 178{
 179        return -ENODEV;
 180}
 181
 182static inline int acpi_debugger_wait_command_ready(void)
 183{
 184        return -ENODEV;
 185}
 186
 187static inline int acpi_debugger_notify_command_complete(void)
 188{
 189        return -ENODEV;
 190}
 191#endif
 192
 193#ifdef CONFIG_ACPI_INITRD_TABLE_OVERRIDE
 194void acpi_initrd_override(void *data, size_t size);
 195#else
 196static inline void acpi_initrd_override(void *data, size_t size)
 197{
 198}
 199#endif
 200
 201#define BAD_MADT_ENTRY(entry, end) (                                        \
 202                (!entry) || (unsigned long)entry + sizeof(*entry) > end ||  \
 203                ((struct acpi_subtable_header *)entry)->length < sizeof(*entry))
 204
 205struct acpi_subtable_proc {
 206        int id;
 207        acpi_tbl_entry_handler handler;
 208        int count;
 209};
 210
 211char * __acpi_map_table (unsigned long phys_addr, unsigned long size);
 212void __acpi_unmap_table(char *map, unsigned long size);
 213int early_acpi_boot_init(void);
 214int acpi_boot_init (void);
 215void acpi_boot_table_init (void);
 216int acpi_mps_check (void);
 217int acpi_numa_init (void);
 218
 219int acpi_table_init (void);
 220int acpi_table_parse(char *id, acpi_tbl_table_handler handler);
 221int __init acpi_parse_entries(char *id, unsigned long table_size,
 222                              acpi_tbl_entry_handler handler,
 223                              struct acpi_table_header *table_header,
 224                              int entry_id, unsigned int max_entries);
 225int __init acpi_table_parse_entries(char *id, unsigned long table_size,
 226                              int entry_id,
 227                              acpi_tbl_entry_handler handler,
 228                              unsigned int max_entries);
 229int __init acpi_table_parse_entries(char *id, unsigned long table_size,
 230                              int entry_id,
 231                              acpi_tbl_entry_handler handler,
 232                              unsigned int max_entries);
 233int __init acpi_table_parse_entries_array(char *id, unsigned long table_size,
 234                              struct acpi_subtable_proc *proc, int proc_num,
 235                              unsigned int max_entries);
 236int acpi_table_parse_madt(enum acpi_madt_type id,
 237                          acpi_tbl_entry_handler handler,
 238                          unsigned int max_entries);
 239int acpi_parse_mcfg (struct acpi_table_header *header);
 240void acpi_table_print_madt_entry (struct acpi_subtable_header *madt);
 241
 242/* the following four functions are architecture-dependent */
 243void acpi_numa_slit_init (struct acpi_table_slit *slit);
 244void acpi_numa_processor_affinity_init (struct acpi_srat_cpu_affinity *pa);
 245void acpi_numa_x2apic_affinity_init(struct acpi_srat_x2apic_cpu_affinity *pa);
 246int acpi_numa_memory_affinity_init (struct acpi_srat_mem_affinity *ma);
 247void acpi_numa_arch_fixup(void);
 248
 249#ifndef PHYS_CPUID_INVALID
 250typedef u32 phys_cpuid_t;
 251#define PHYS_CPUID_INVALID (phys_cpuid_t)(-1)
 252#endif
 253
 254static inline bool invalid_logical_cpuid(u32 cpuid)
 255{
 256        return (int)cpuid < 0;
 257}
 258
 259static inline bool invalid_phys_cpuid(phys_cpuid_t phys_id)
 260{
 261        return phys_id == PHYS_CPUID_INVALID;
 262}
 263
 264#ifdef CONFIG_ACPI_HOTPLUG_CPU
 265/* Arch dependent functions for cpu hotplug support */
 266int acpi_map_cpu(acpi_handle handle, phys_cpuid_t physid, int *pcpu);
 267int acpi_unmap_cpu(int cpu);
 268#endif /* CONFIG_ACPI_HOTPLUG_CPU */
 269
 270#ifdef CONFIG_ACPI_HOTPLUG_IOAPIC
 271int acpi_get_ioapic_id(acpi_handle handle, u32 gsi_base, u64 *phys_addr);
 272#endif
 273
 274int acpi_register_ioapic(acpi_handle handle, u64 phys_addr, u32 gsi_base);
 275int acpi_unregister_ioapic(acpi_handle handle, u32 gsi_base);
 276int acpi_ioapic_registered(acpi_handle handle, u32 gsi_base);
 277void acpi_irq_stats_init(void);
 278extern u32 acpi_irq_handled;
 279extern u32 acpi_irq_not_handled;
 280extern unsigned int acpi_sci_irq;
 281#define INVALID_ACPI_IRQ        ((unsigned)-1)
 282static inline bool acpi_sci_irq_valid(void)
 283{
 284        return acpi_sci_irq != INVALID_ACPI_IRQ;
 285}
 286
 287extern int sbf_port;
 288extern unsigned long acpi_realmode_flags;
 289
 290int acpi_register_gsi (struct device *dev, u32 gsi, int triggering, int polarity);
 291int acpi_gsi_to_irq (u32 gsi, unsigned int *irq);
 292int acpi_isa_irq_to_gsi (unsigned isa_irq, u32 *gsi);
 293
 294void acpi_set_irq_model(enum acpi_irq_model_id model,
 295                        struct fwnode_handle *fwnode);
 296
 297#ifdef CONFIG_X86_IO_APIC
 298extern int acpi_get_override_irq(u32 gsi, int *trigger, int *polarity);
 299#else
 300#define acpi_get_override_irq(gsi, trigger, polarity) (-1)
 301#endif
 302/*
 303 * This function undoes the effect of one call to acpi_register_gsi().
 304 * If this matches the last registration, any IRQ resources for gsi
 305 * are freed.
 306 */
 307void acpi_unregister_gsi (u32 gsi);
 308
 309struct pci_dev;
 310
 311int acpi_pci_irq_enable (struct pci_dev *dev);
 312void acpi_penalize_isa_irq(int irq, int active);
 313bool acpi_isa_irq_available(int irq);
 314void acpi_penalize_sci_irq(int irq, int trigger, int polarity);
 315void acpi_pci_irq_disable (struct pci_dev *dev);
 316
 317extern int ec_read(u8 addr, u8 *val);
 318extern int ec_write(u8 addr, u8 val);
 319extern int ec_transaction(u8 command,
 320                          const u8 *wdata, unsigned wdata_len,
 321                          u8 *rdata, unsigned rdata_len);
 322extern acpi_handle ec_get_handle(void);
 323
 324extern bool acpi_is_pnp_device(struct acpi_device *);
 325
 326#if defined(CONFIG_ACPI_WMI) || defined(CONFIG_ACPI_WMI_MODULE)
 327
 328typedef void (*wmi_notify_handler) (u32 value, void *context);
 329
 330extern acpi_status wmi_evaluate_method(const char *guid, u8 instance,
 331                                        u32 method_id,
 332                                        const struct acpi_buffer *in,
 333                                        struct acpi_buffer *out);
 334extern acpi_status wmi_query_block(const char *guid, u8 instance,
 335                                        struct acpi_buffer *out);
 336extern acpi_status wmi_set_block(const char *guid, u8 instance,
 337                                        const struct acpi_buffer *in);
 338extern acpi_status wmi_install_notify_handler(const char *guid,
 339                                        wmi_notify_handler handler, void *data);
 340extern acpi_status wmi_remove_notify_handler(const char *guid);
 341extern acpi_status wmi_get_event_data(u32 event, struct acpi_buffer *out);
 342extern bool wmi_has_guid(const char *guid);
 343
 344#endif  /* CONFIG_ACPI_WMI */
 345
 346#define ACPI_VIDEO_OUTPUT_SWITCHING                     0x0001
 347#define ACPI_VIDEO_DEVICE_POSTING                       0x0002
 348#define ACPI_VIDEO_ROM_AVAILABLE                        0x0004
 349#define ACPI_VIDEO_BACKLIGHT                            0x0008
 350#define ACPI_VIDEO_BACKLIGHT_FORCE_VENDOR               0x0010
 351#define ACPI_VIDEO_BACKLIGHT_FORCE_VIDEO                0x0020
 352#define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VENDOR        0x0040
 353#define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VIDEO         0x0080
 354#define ACPI_VIDEO_BACKLIGHT_DMI_VENDOR                 0x0100
 355#define ACPI_VIDEO_BACKLIGHT_DMI_VIDEO                  0x0200
 356#define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VENDOR          0x0400
 357#define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VIDEO           0x0800
 358
 359extern char acpi_video_backlight_string[];
 360extern long acpi_is_video_device(acpi_handle handle);
 361extern int acpi_blacklisted(void);
 362extern void acpi_dmi_osi_linux(int enable, const struct dmi_system_id *d);
 363extern void acpi_osi_setup(char *str);
 364extern bool acpi_osi_is_win8(void);
 365
 366#ifdef CONFIG_ACPI_NUMA
 367int acpi_map_pxm_to_online_node(int pxm);
 368int acpi_get_node(acpi_handle handle);
 369#else
 370static inline int acpi_map_pxm_to_online_node(int pxm)
 371{
 372        return 0;
 373}
 374static inline int acpi_get_node(acpi_handle handle)
 375{
 376        return 0;
 377}
 378#endif
 379extern int acpi_paddr_to_node(u64 start_addr, u64 size);
 380
 381extern int pnpacpi_disabled;
 382
 383#define PXM_INVAL       (-1)
 384
 385bool acpi_dev_resource_memory(struct acpi_resource *ares, struct resource *res);
 386bool acpi_dev_resource_io(struct acpi_resource *ares, struct resource *res);
 387bool acpi_dev_resource_address_space(struct acpi_resource *ares,
 388                                     struct resource_win *win);
 389bool acpi_dev_resource_ext_address_space(struct acpi_resource *ares,
 390                                         struct resource_win *win);
 391unsigned long acpi_dev_irq_flags(u8 triggering, u8 polarity, u8 shareable);
 392unsigned int acpi_dev_get_irq_type(int triggering, int polarity);
 393bool acpi_dev_resource_interrupt(struct acpi_resource *ares, int index,
 394                                 struct resource *res);
 395
 396void acpi_dev_free_resource_list(struct list_head *list);
 397int acpi_dev_get_resources(struct acpi_device *adev, struct list_head *list,
 398                           int (*preproc)(struct acpi_resource *, void *),
 399                           void *preproc_data);
 400int acpi_dev_filter_resource_type(struct acpi_resource *ares,
 401                                  unsigned long types);
 402
 403static inline int acpi_dev_filter_resource_type_cb(struct acpi_resource *ares,
 404                                                   void *arg)
 405{
 406        return acpi_dev_filter_resource_type(ares, (unsigned long)arg);
 407}
 408
 409int acpi_check_resource_conflict(const struct resource *res);
 410
 411int acpi_check_region(resource_size_t start, resource_size_t n,
 412                      const char *name);
 413
 414int acpi_resources_are_enforced(void);
 415
 416#ifdef CONFIG_HIBERNATION
 417void __init acpi_no_s4_hw_signature(void);
 418#endif
 419
 420#ifdef CONFIG_PM_SLEEP
 421void __init acpi_old_suspend_ordering(void);
 422void __init acpi_nvs_nosave(void);
 423void __init acpi_nvs_nosave_s3(void);
 424#endif /* CONFIG_PM_SLEEP */
 425
 426struct acpi_osc_context {
 427        char *uuid_str;                 /* UUID string */
 428        int rev;
 429        struct acpi_buffer cap;         /* list of DWORD capabilities */
 430        struct acpi_buffer ret;         /* free by caller if success */
 431};
 432
 433acpi_status acpi_str_to_uuid(char *str, u8 *uuid);
 434acpi_status acpi_run_osc(acpi_handle handle, struct acpi_osc_context *context);
 435
 436/* Indexes into _OSC Capabilities Buffer (DWORDs 2 & 3 are device-specific) */
 437#define OSC_QUERY_DWORD                         0       /* DWORD 1 */
 438#define OSC_SUPPORT_DWORD                       1       /* DWORD 2 */
 439#define OSC_CONTROL_DWORD                       2       /* DWORD 3 */
 440
 441/* _OSC Capabilities DWORD 1: Query/Control and Error Returns (generic) */
 442#define OSC_QUERY_ENABLE                        0x00000001  /* input */
 443#define OSC_REQUEST_ERROR                       0x00000002  /* return */
 444#define OSC_INVALID_UUID_ERROR                  0x00000004  /* return */
 445#define OSC_INVALID_REVISION_ERROR              0x00000008  /* return */
 446#define OSC_CAPABILITIES_MASK_ERROR             0x00000010  /* return */
 447
 448/* Platform-Wide Capabilities _OSC: Capabilities DWORD 2: Support Field */
 449#define OSC_SB_PAD_SUPPORT                      0x00000001
 450#define OSC_SB_PPC_OST_SUPPORT                  0x00000002
 451#define OSC_SB_PR3_SUPPORT                      0x00000004
 452#define OSC_SB_HOTPLUG_OST_SUPPORT              0x00000008
 453#define OSC_SB_APEI_SUPPORT                     0x00000010
 454#define OSC_SB_CPC_SUPPORT                      0x00000020
 455
 456extern bool osc_sb_apei_support_acked;
 457
 458/* PCI Host Bridge _OSC: Capabilities DWORD 2: Support Field */
 459#define OSC_PCI_EXT_CONFIG_SUPPORT              0x00000001
 460#define OSC_PCI_ASPM_SUPPORT                    0x00000002
 461#define OSC_PCI_CLOCK_PM_SUPPORT                0x00000004
 462#define OSC_PCI_SEGMENT_GROUPS_SUPPORT          0x00000008
 463#define OSC_PCI_MSI_SUPPORT                     0x00000010
 464#define OSC_PCI_SUPPORT_MASKS                   0x0000001f
 465
 466/* PCI Host Bridge _OSC: Capabilities DWORD 3: Control Field */
 467#define OSC_PCI_EXPRESS_NATIVE_HP_CONTROL       0x00000001
 468#define OSC_PCI_SHPC_NATIVE_HP_CONTROL          0x00000002
 469#define OSC_PCI_EXPRESS_PME_CONTROL             0x00000004
 470#define OSC_PCI_EXPRESS_AER_CONTROL             0x00000008
 471#define OSC_PCI_EXPRESS_CAPABILITY_CONTROL      0x00000010
 472#define OSC_PCI_CONTROL_MASKS                   0x0000001f
 473
 474#define ACPI_GSB_ACCESS_ATTRIB_QUICK            0x00000002
 475#define ACPI_GSB_ACCESS_ATTRIB_SEND_RCV         0x00000004
 476#define ACPI_GSB_ACCESS_ATTRIB_BYTE             0x00000006
 477#define ACPI_GSB_ACCESS_ATTRIB_WORD             0x00000008
 478#define ACPI_GSB_ACCESS_ATTRIB_BLOCK            0x0000000A
 479#define ACPI_GSB_ACCESS_ATTRIB_MULTIBYTE        0x0000000B
 480#define ACPI_GSB_ACCESS_ATTRIB_WORD_CALL        0x0000000C
 481#define ACPI_GSB_ACCESS_ATTRIB_BLOCK_CALL       0x0000000D
 482#define ACPI_GSB_ACCESS_ATTRIB_RAW_BYTES        0x0000000E
 483#define ACPI_GSB_ACCESS_ATTRIB_RAW_PROCESS      0x0000000F
 484
 485extern acpi_status acpi_pci_osc_control_set(acpi_handle handle,
 486                                             u32 *mask, u32 req);
 487
 488/* Enable _OST when all relevant hotplug operations are enabled */
 489#if defined(CONFIG_ACPI_HOTPLUG_CPU) &&                 \
 490        defined(CONFIG_ACPI_HOTPLUG_MEMORY) &&          \
 491        defined(CONFIG_ACPI_CONTAINER)
 492#define ACPI_HOTPLUG_OST
 493#endif
 494
 495/* _OST Source Event Code (OSPM Action) */
 496#define ACPI_OST_EC_OSPM_SHUTDOWN               0x100
 497#define ACPI_OST_EC_OSPM_EJECT                  0x103
 498#define ACPI_OST_EC_OSPM_INSERTION              0x200
 499
 500/* _OST General Processing Status Code */
 501#define ACPI_OST_SC_SUCCESS                     0x0
 502#define ACPI_OST_SC_NON_SPECIFIC_FAILURE        0x1
 503#define ACPI_OST_SC_UNRECOGNIZED_NOTIFY         0x2
 504
 505/* _OST OS Shutdown Processing (0x100) Status Code */
 506#define ACPI_OST_SC_OS_SHUTDOWN_DENIED          0x80
 507#define ACPI_OST_SC_OS_SHUTDOWN_IN_PROGRESS     0x81
 508#define ACPI_OST_SC_OS_SHUTDOWN_COMPLETED       0x82
 509#define ACPI_OST_SC_OS_SHUTDOWN_NOT_SUPPORTED   0x83
 510
 511/* _OST Ejection Request (0x3, 0x103) Status Code */
 512#define ACPI_OST_SC_EJECT_NOT_SUPPORTED         0x80
 513#define ACPI_OST_SC_DEVICE_IN_USE               0x81
 514#define ACPI_OST_SC_DEVICE_BUSY                 0x82
 515#define ACPI_OST_SC_EJECT_DEPENDENCY_BUSY       0x83
 516#define ACPI_OST_SC_EJECT_IN_PROGRESS           0x84
 517
 518/* _OST Insertion Request (0x200) Status Code */
 519#define ACPI_OST_SC_INSERT_IN_PROGRESS          0x80
 520#define ACPI_OST_SC_DRIVER_LOAD_FAILURE         0x81
 521#define ACPI_OST_SC_INSERT_NOT_SUPPORTED        0x82
 522
 523extern void acpi_early_init(void);
 524extern void acpi_subsystem_init(void);
 525
 526extern int acpi_nvs_register(__u64 start, __u64 size);
 527
 528extern int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
 529                                    void *data);
 530
 531const struct acpi_device_id *acpi_match_device(const struct acpi_device_id *ids,
 532                                               const struct device *dev);
 533
 534extern bool acpi_driver_match_device(struct device *dev,
 535                                     const struct device_driver *drv);
 536int acpi_device_uevent_modalias(struct device *, struct kobj_uevent_env *);
 537int acpi_device_modalias(struct device *, char *, int);
 538void acpi_walk_dep_device_list(acpi_handle handle);
 539
 540struct platform_device *acpi_create_platform_device(struct acpi_device *);
 541#define ACPI_PTR(_ptr)  (_ptr)
 542
 543#else   /* !CONFIG_ACPI */
 544
 545#define acpi_disabled 1
 546
 547#define ACPI_COMPANION(dev)             (NULL)
 548#define ACPI_COMPANION_SET(dev, adev)   do { } while (0)
 549#define ACPI_HANDLE(dev)                (NULL)
 550#define ACPI_DEVICE_CLASS(_cls, _msk)   .cls = (0), .cls_msk = (0),
 551
 552struct fwnode_handle;
 553
 554static inline bool is_acpi_node(struct fwnode_handle *fwnode)
 555{
 556        return false;
 557}
 558
 559static inline bool is_acpi_device_node(struct fwnode_handle *fwnode)
 560{
 561        return false;
 562}
 563
 564static inline struct acpi_device *to_acpi_device_node(struct fwnode_handle *fwnode)
 565{
 566        return NULL;
 567}
 568
 569static inline bool is_acpi_data_node(struct fwnode_handle *fwnode)
 570{
 571        return false;
 572}
 573
 574static inline struct acpi_data_node *to_acpi_data_node(struct fwnode_handle *fwnode)
 575{
 576        return NULL;
 577}
 578
 579static inline struct fwnode_handle *acpi_fwnode_handle(struct acpi_device *adev)
 580{
 581        return NULL;
 582}
 583
 584static inline bool has_acpi_companion(struct device *dev)
 585{
 586        return false;
 587}
 588
 589static inline void acpi_preset_companion(struct device *dev,
 590                                         struct acpi_device *parent, u64 addr)
 591{
 592}
 593
 594static inline const char *acpi_dev_name(struct acpi_device *adev)
 595{
 596        return NULL;
 597}
 598
 599static inline void acpi_early_init(void) { }
 600static inline void acpi_subsystem_init(void) { }
 601
 602static inline int early_acpi_boot_init(void)
 603{
 604        return 0;
 605}
 606static inline int acpi_boot_init(void)
 607{
 608        return 0;
 609}
 610
 611static inline void acpi_boot_table_init(void)
 612{
 613        return;
 614}
 615
 616static inline int acpi_mps_check(void)
 617{
 618        return 0;
 619}
 620
 621static inline int acpi_check_resource_conflict(struct resource *res)
 622{
 623        return 0;
 624}
 625
 626static inline int acpi_check_region(resource_size_t start, resource_size_t n,
 627                                    const char *name)
 628{
 629        return 0;
 630}
 631
 632struct acpi_table_header;
 633static inline int acpi_table_parse(char *id,
 634                                int (*handler)(struct acpi_table_header *))
 635{
 636        return -ENODEV;
 637}
 638
 639static inline int acpi_nvs_register(__u64 start, __u64 size)
 640{
 641        return 0;
 642}
 643
 644static inline int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
 645                                           void *data)
 646{
 647        return 0;
 648}
 649
 650struct acpi_device_id;
 651
 652static inline const struct acpi_device_id *acpi_match_device(
 653        const struct acpi_device_id *ids, const struct device *dev)
 654{
 655        return NULL;
 656}
 657
 658static inline bool acpi_driver_match_device(struct device *dev,
 659                                            const struct device_driver *drv)
 660{
 661        return false;
 662}
 663
 664static inline int acpi_device_uevent_modalias(struct device *dev,
 665                                struct kobj_uevent_env *env)
 666{
 667        return -ENODEV;
 668}
 669
 670static inline int acpi_device_modalias(struct device *dev,
 671                                char *buf, int size)
 672{
 673        return -ENODEV;
 674}
 675
 676static inline bool acpi_dma_supported(struct acpi_device *adev)
 677{
 678        return false;
 679}
 680
 681static inline enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev)
 682{
 683        return DEV_DMA_NOT_SUPPORTED;
 684}
 685
 686#define ACPI_PTR(_ptr)  (NULL)
 687
 688#endif  /* !CONFIG_ACPI */
 689
 690#ifdef CONFIG_ACPI
 691void acpi_os_set_prepare_sleep(int (*func)(u8 sleep_state,
 692                               u32 pm1a_ctrl,  u32 pm1b_ctrl));
 693
 694acpi_status acpi_os_prepare_sleep(u8 sleep_state,
 695                                  u32 pm1a_control, u32 pm1b_control);
 696
 697void acpi_os_set_prepare_extended_sleep(int (*func)(u8 sleep_state,
 698                                        u32 val_a,  u32 val_b));
 699
 700acpi_status acpi_os_prepare_extended_sleep(u8 sleep_state,
 701                                           u32 val_a, u32 val_b);
 702
 703#ifdef CONFIG_X86
 704void arch_reserve_mem_area(acpi_physical_address addr, size_t size);
 705#else
 706static inline void arch_reserve_mem_area(acpi_physical_address addr,
 707                                          size_t size)
 708{
 709}
 710#endif /* CONFIG_X86 */
 711#else
 712#define acpi_os_set_prepare_sleep(func, pm1a_ctrl, pm1b_ctrl) do { } while (0)
 713#endif
 714
 715#if defined(CONFIG_ACPI) && defined(CONFIG_PM)
 716int acpi_dev_runtime_suspend(struct device *dev);
 717int acpi_dev_runtime_resume(struct device *dev);
 718int acpi_subsys_runtime_suspend(struct device *dev);
 719int acpi_subsys_runtime_resume(struct device *dev);
 720struct acpi_device *acpi_dev_pm_get_node(struct device *dev);
 721int acpi_dev_pm_attach(struct device *dev, bool power_on);
 722#else
 723static inline int acpi_dev_runtime_suspend(struct device *dev) { return 0; }
 724static inline int acpi_dev_runtime_resume(struct device *dev) { return 0; }
 725static inline int acpi_subsys_runtime_suspend(struct device *dev) { return 0; }
 726static inline int acpi_subsys_runtime_resume(struct device *dev) { return 0; }
 727static inline struct acpi_device *acpi_dev_pm_get_node(struct device *dev)
 728{
 729        return NULL;
 730}
 731static inline int acpi_dev_pm_attach(struct device *dev, bool power_on)
 732{
 733        return -ENODEV;
 734}
 735#endif
 736
 737#if defined(CONFIG_ACPI) && defined(CONFIG_PM_SLEEP)
 738int acpi_dev_suspend_late(struct device *dev);
 739int acpi_dev_resume_early(struct device *dev);
 740int acpi_subsys_prepare(struct device *dev);
 741void acpi_subsys_complete(struct device *dev);
 742int acpi_subsys_suspend_late(struct device *dev);
 743int acpi_subsys_resume_early(struct device *dev);
 744int acpi_subsys_suspend(struct device *dev);
 745int acpi_subsys_freeze(struct device *dev);
 746#else
 747static inline int acpi_dev_suspend_late(struct device *dev) { return 0; }
 748static inline int acpi_dev_resume_early(struct device *dev) { return 0; }
 749static inline int acpi_subsys_prepare(struct device *dev) { return 0; }
 750static inline void acpi_subsys_complete(struct device *dev) {}
 751static inline int acpi_subsys_suspend_late(struct device *dev) { return 0; }
 752static inline int acpi_subsys_resume_early(struct device *dev) { return 0; }
 753static inline int acpi_subsys_suspend(struct device *dev) { return 0; }
 754static inline int acpi_subsys_freeze(struct device *dev) { return 0; }
 755#endif
 756
 757#ifdef CONFIG_ACPI
 758__printf(3, 4)
 759void acpi_handle_printk(const char *level, acpi_handle handle,
 760                        const char *fmt, ...);
 761#else   /* !CONFIG_ACPI */
 762static inline __printf(3, 4) void
 763acpi_handle_printk(const char *level, void *handle, const char *fmt, ...) {}
 764#endif  /* !CONFIG_ACPI */
 765
 766#if defined(CONFIG_ACPI) && defined(CONFIG_DYNAMIC_DEBUG)
 767__printf(3, 4)
 768void __acpi_handle_debug(struct _ddebug *descriptor, acpi_handle handle, const char *fmt, ...);
 769#else
 770#define __acpi_handle_debug(descriptor, handle, fmt, ...)               \
 771        acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__);
 772#endif
 773
 774/*
 775 * acpi_handle_<level>: Print message with ACPI prefix and object path
 776 *
 777 * These interfaces acquire the global namespace mutex to obtain an object
 778 * path.  In interrupt context, it shows the object path as <n/a>.
 779 */
 780#define acpi_handle_emerg(handle, fmt, ...)                             \
 781        acpi_handle_printk(KERN_EMERG, handle, fmt, ##__VA_ARGS__)
 782#define acpi_handle_alert(handle, fmt, ...)                             \
 783        acpi_handle_printk(KERN_ALERT, handle, fmt, ##__VA_ARGS__)
 784#define acpi_handle_crit(handle, fmt, ...)                              \
 785        acpi_handle_printk(KERN_CRIT, handle, fmt, ##__VA_ARGS__)
 786#define acpi_handle_err(handle, fmt, ...)                               \
 787        acpi_handle_printk(KERN_ERR, handle, fmt, ##__VA_ARGS__)
 788#define acpi_handle_warn(handle, fmt, ...)                              \
 789        acpi_handle_printk(KERN_WARNING, handle, fmt, ##__VA_ARGS__)
 790#define acpi_handle_notice(handle, fmt, ...)                            \
 791        acpi_handle_printk(KERN_NOTICE, handle, fmt, ##__VA_ARGS__)
 792#define acpi_handle_info(handle, fmt, ...)                              \
 793        acpi_handle_printk(KERN_INFO, handle, fmt, ##__VA_ARGS__)
 794
 795#if defined(DEBUG)
 796#define acpi_handle_debug(handle, fmt, ...)                             \
 797        acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__)
 798#else
 799#if defined(CONFIG_DYNAMIC_DEBUG)
 800#define acpi_handle_debug(handle, fmt, ...)                             \
 801do {                                                                    \
 802        DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt);                 \
 803        if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT))          \
 804                __acpi_handle_debug(&descriptor, handle, pr_fmt(fmt),   \
 805                                ##__VA_ARGS__);                         \
 806} while (0)
 807#else
 808#define acpi_handle_debug(handle, fmt, ...)                             \
 809({                                                                      \
 810        if (0)                                                          \
 811                acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__); \
 812        0;                                                              \
 813})
 814#endif
 815#endif
 816
 817struct acpi_gpio_params {
 818        unsigned int crs_entry_index;
 819        unsigned int line_index;
 820        bool active_low;
 821};
 822
 823struct acpi_gpio_mapping {
 824        const char *name;
 825        const struct acpi_gpio_params *data;
 826        unsigned int size;
 827};
 828
 829#if defined(CONFIG_ACPI) && defined(CONFIG_GPIOLIB)
 830int acpi_dev_add_driver_gpios(struct acpi_device *adev,
 831                              const struct acpi_gpio_mapping *gpios);
 832
 833static inline void acpi_dev_remove_driver_gpios(struct acpi_device *adev)
 834{
 835        if (adev)
 836                adev->driver_gpios = NULL;
 837}
 838
 839int acpi_dev_gpio_irq_get(struct acpi_device *adev, int index);
 840#else
 841static inline int acpi_dev_add_driver_gpios(struct acpi_device *adev,
 842                              const struct acpi_gpio_mapping *gpios)
 843{
 844        return -ENXIO;
 845}
 846static inline void acpi_dev_remove_driver_gpios(struct acpi_device *adev) {}
 847
 848static inline int acpi_dev_gpio_irq_get(struct acpi_device *adev, int index)
 849{
 850        return -ENXIO;
 851}
 852#endif
 853
 854/* Device properties */
 855
 856#define MAX_ACPI_REFERENCE_ARGS 8
 857struct acpi_reference_args {
 858        struct acpi_device *adev;
 859        size_t nargs;
 860        u64 args[MAX_ACPI_REFERENCE_ARGS];
 861};
 862
 863#ifdef CONFIG_ACPI
 864int acpi_dev_get_property(struct acpi_device *adev, const char *name,
 865                          acpi_object_type type, const union acpi_object **obj);
 866int acpi_node_get_property_reference(struct fwnode_handle *fwnode,
 867                                     const char *name, size_t index,
 868                                     struct acpi_reference_args *args);
 869
 870int acpi_node_prop_get(struct fwnode_handle *fwnode, const char *propname,
 871                       void **valptr);
 872int acpi_dev_prop_read_single(struct acpi_device *adev, const char *propname,
 873                              enum dev_prop_type proptype, void *val);
 874int acpi_node_prop_read(struct fwnode_handle *fwnode, const char *propname,
 875                        enum dev_prop_type proptype, void *val, size_t nval);
 876int acpi_dev_prop_read(struct acpi_device *adev, const char *propname,
 877                       enum dev_prop_type proptype, void *val, size_t nval);
 878
 879struct fwnode_handle *acpi_get_next_subnode(struct device *dev,
 880                                            struct fwnode_handle *subnode);
 881
 882struct acpi_probe_entry;
 883typedef bool (*acpi_probe_entry_validate_subtbl)(struct acpi_subtable_header *,
 884                                                 struct acpi_probe_entry *);
 885
 886#define ACPI_TABLE_ID_LEN       5
 887
 888/**
 889 * struct acpi_probe_entry - boot-time probing entry
 890 * @id:                 ACPI table name
 891 * @type:               Optional subtable type to match
 892 *                      (if @id contains subtables)
 893 * @subtable_valid:     Optional callback to check the validity of
 894 *                      the subtable
 895 * @probe_table:        Callback to the driver being probed when table
 896 *                      match is successful
 897 * @probe_subtbl:       Callback to the driver being probed when table and
 898 *                      subtable match (and optional callback is successful)
 899 * @driver_data:        Sideband data provided back to the driver
 900 */
 901struct acpi_probe_entry {
 902        __u8 id[ACPI_TABLE_ID_LEN];
 903        __u8 type;
 904        acpi_probe_entry_validate_subtbl subtable_valid;
 905        union {
 906                acpi_tbl_table_handler probe_table;
 907                acpi_tbl_entry_handler probe_subtbl;
 908        };
 909        kernel_ulong_t driver_data;
 910};
 911
 912#define ACPI_DECLARE_PROBE_ENTRY(table, name, table_id, subtable, valid, data, fn)      \
 913        static const struct acpi_probe_entry __acpi_probe_##name        \
 914                __used __section(__##table##_acpi_probe_table)          \
 915                 = {                                                    \
 916                        .id = table_id,                                 \
 917                        .type = subtable,                               \
 918                        .subtable_valid = valid,                        \
 919                        .probe_table = (acpi_tbl_table_handler)fn,      \
 920                        .driver_data = data,                            \
 921                   }
 922
 923#define ACPI_PROBE_TABLE(name)          __##name##_acpi_probe_table
 924#define ACPI_PROBE_TABLE_END(name)      __##name##_acpi_probe_table_end
 925
 926int __acpi_probe_device_table(struct acpi_probe_entry *start, int nr);
 927
 928#define acpi_probe_device_table(t)                                      \
 929        ({                                                              \
 930                extern struct acpi_probe_entry ACPI_PROBE_TABLE(t),     \
 931                                               ACPI_PROBE_TABLE_END(t); \
 932                __acpi_probe_device_table(&ACPI_PROBE_TABLE(t),         \
 933                                          (&ACPI_PROBE_TABLE_END(t) -   \
 934                                           &ACPI_PROBE_TABLE(t)));      \
 935        })
 936#else
 937static inline int acpi_dev_get_property(struct acpi_device *adev,
 938                                        const char *name, acpi_object_type type,
 939                                        const union acpi_object **obj)
 940{
 941        return -ENXIO;
 942}
 943
 944static inline int acpi_node_get_property_reference(struct fwnode_handle *fwnode,
 945                                const char *name, size_t index,
 946                                struct acpi_reference_args *args)
 947{
 948        return -ENXIO;
 949}
 950
 951static inline int acpi_node_prop_get(struct fwnode_handle *fwnode,
 952                                     const char *propname,
 953                                     void **valptr)
 954{
 955        return -ENXIO;
 956}
 957
 958static inline int acpi_dev_prop_get(struct acpi_device *adev,
 959                                    const char *propname,
 960                                    void **valptr)
 961{
 962        return -ENXIO;
 963}
 964
 965static inline int acpi_dev_prop_read_single(struct acpi_device *adev,
 966                                            const char *propname,
 967                                            enum dev_prop_type proptype,
 968                                            void *val)
 969{
 970        return -ENXIO;
 971}
 972
 973static inline int acpi_node_prop_read(struct fwnode_handle *fwnode,
 974                                      const char *propname,
 975                                      enum dev_prop_type proptype,
 976                                      void *val, size_t nval)
 977{
 978        return -ENXIO;
 979}
 980
 981static inline int acpi_dev_prop_read(struct acpi_device *adev,
 982                                     const char *propname,
 983                                     enum dev_prop_type proptype,
 984                                     void *val, size_t nval)
 985{
 986        return -ENXIO;
 987}
 988
 989static inline struct fwnode_handle *acpi_get_next_subnode(struct device *dev,
 990                                                struct fwnode_handle *subnode)
 991{
 992        return NULL;
 993}
 994
 995#define ACPI_DECLARE_PROBE_ENTRY(table, name, table_id, subtable, validate, data, fn) \
 996        static const void * __acpi_table_##name[]                       \
 997                __attribute__((unused))                                 \
 998                 = { (void *) table_id,                                 \
 999                     (void *) subtable,                                 \
1000                     (void *) valid,                                    \
1001                     (void *) fn,                                       \
1002                     (void *) data }
1003
1004#define acpi_probe_device_table(t)      ({ int __r = 0; __r;})
1005#endif
1006
1007#endif  /*_LINUX_ACPI_H*/
1008