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