include/linux/acpi.h

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