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