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