include/linux/acpi.h

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