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