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