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