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