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