1 /****************************************************************************** 2 * 3 * Name: acpixf.h - External interfaces to the ACPI subsystem 4 * 5 *****************************************************************************/ 6 7 /* 8 * Copyright (C) 2000 - 2014, Intel Corp. 9 * All rights reserved. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions, and the following disclaimer, 16 * without modification. 17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 18 * substantially similar to the "NO WARRANTY" disclaimer below 19 * ("Disclaimer") and any redistribution must be conditioned upon 20 * including a substantially similar Disclaimer requirement for further 21 * binary redistribution. 22 * 3. Neither the names of the above-listed copyright holders nor the names 23 * of any contributors may be used to endorse or promote products derived 24 * from this software without specific prior written permission. 25 * 26 * Alternatively, this software may be distributed under the terms of the 27 * GNU General Public License ("GPL") version 2 as published by the Free 28 * Software Foundation. 29 * 30 * NO WARRANTY 31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR 34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 41 * POSSIBILITY OF SUCH DAMAGES. 42 */ 43 44 #ifndef __ACXFACE_H__ 45 #define __ACXFACE_H__ 46 47 /* Current ACPICA subsystem version in YYYYMMDD format */ 48 49 #define ACPI_CA_VERSION 0x20140214 50 51 #include <acpi/acconfig.h> 52 #include <acpi/actypes.h> 53 #include <acpi/actbl.h> 54 #include <acpi/acbuffer.h> 55 56 extern u8 acpi_gbl_permanent_mmap; 57 58 /* 59 * Globals that are publically available 60 */ 61 extern u32 acpi_current_gpe_count; 62 extern struct acpi_table_fadt acpi_gbl_FADT; 63 extern u8 acpi_gbl_system_awake_and_running; 64 extern u8 acpi_gbl_reduced_hardware; /* ACPI 5.0 */ 65 extern u8 acpi_gbl_osi_data; 66 67 /* Runtime configuration of debug print levels */ 68 69 extern u32 acpi_dbg_level; 70 extern u32 acpi_dbg_layer; 71 72 /* ACPICA runtime options */ 73 74 extern u8 acpi_gbl_auto_serialize_methods; 75 extern u8 acpi_gbl_copy_dsdt_locally; 76 extern u8 acpi_gbl_create_osi_method; 77 extern u8 acpi_gbl_disable_auto_repair; 78 extern u8 acpi_gbl_disable_ssdt_table_install; 79 extern u8 acpi_gbl_do_not_use_xsdt; 80 extern u8 acpi_gbl_enable_aml_debug_object; 81 extern u8 acpi_gbl_enable_interpreter_slack; 82 extern u32 acpi_gbl_trace_flags; 83 extern acpi_name acpi_gbl_trace_method_name; 84 extern u8 acpi_gbl_truncate_io_addresses; 85 extern u8 acpi_gbl_use32_bit_fadt_addresses; 86 extern u8 acpi_gbl_use_default_register_widths; 87 88 /* 89 * Hardware-reduced prototypes. All interfaces that use these macros will 90 * be configured out of the ACPICA build if the ACPI_REDUCED_HARDWARE flag 91 * is set to TRUE. 92 */ 93 #if (!ACPI_REDUCED_HARDWARE) 94 #define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \ 95 prototype; 96 97 #define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \ 98 prototype; 99 100 #define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \ 101 prototype; 102 103 #else 104 #define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \ 105 static ACPI_INLINE prototype {return(AE_NOT_CONFIGURED);} 106 107 #define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \ 108 static ACPI_INLINE prototype {return(AE_OK);} 109 110 #define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \ 111 static ACPI_INLINE prototype {return;} 112 113 #endif /* !ACPI_REDUCED_HARDWARE */ 114 115 /* 116 * Initialization 117 */ 118 acpi_status __init 119 acpi_initialize_tables(struct acpi_table_desc *initial_storage, 120 u32 initial_table_count, u8 allow_resize); 121 122 acpi_status __init acpi_initialize_subsystem(void); 123 124 acpi_status __init acpi_enable_subsystem(u32 flags); 125 126 acpi_status __init acpi_initialize_objects(u32 flags); 127 128 acpi_status __init acpi_terminate(void); 129 130 /* 131 * Miscellaneous global interfaces 132 */ 133 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable(void)) 134 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_disable(void)) 135 #ifdef ACPI_FUTURE_USAGE 136 acpi_status acpi_subsystem_status(void); 137 #endif 138 139 #ifdef ACPI_FUTURE_USAGE 140 acpi_status acpi_get_system_info(struct acpi_buffer *ret_buffer); 141 #endif 142 143 acpi_status acpi_get_statistics(struct acpi_statistics *stats); 144 145 const char *acpi_format_exception(acpi_status exception); 146 147 acpi_status acpi_purge_cached_objects(void); 148 149 acpi_status acpi_install_interface(acpi_string interface_name); 150 151 acpi_status acpi_remove_interface(acpi_string interface_name); 152 153 acpi_status acpi_update_interfaces(u8 action); 154 155 u32 156 acpi_check_address_range(acpi_adr_space_type space_id, 157 acpi_physical_address address, 158 acpi_size length, u8 warn); 159 160 acpi_status 161 acpi_decode_pld_buffer(u8 *in_buffer, 162 acpi_size length, struct acpi_pld_info **return_buffer); 163 164 /* 165 * ACPI table load/unload interfaces 166 */ 167 acpi_status __init 168 acpi_install_table(acpi_physical_address address, u8 physical); 169 170 acpi_status acpi_load_table(struct acpi_table_header *table); 171 172 acpi_status acpi_unload_parent_table(acpi_handle object); 173 174 acpi_status __init acpi_load_tables(void); 175 176 /* 177 * ACPI table manipulation interfaces 178 */ 179 acpi_status __init acpi_reallocate_root_table(void); 180 181 acpi_status __init acpi_find_root_pointer(acpi_size *rsdp_address); 182 183 acpi_status acpi_unload_table_id(acpi_owner_id id); 184 185 acpi_status 186 acpi_get_table_header(acpi_string signature, 187 u32 instance, struct acpi_table_header *out_table_header); 188 189 acpi_status 190 acpi_get_table_with_size(acpi_string signature, 191 u32 instance, struct acpi_table_header **out_table, 192 acpi_size *tbl_size); 193 194 acpi_status 195 acpi_get_table(acpi_string signature, 196 u32 instance, struct acpi_table_header **out_table); 197 198 acpi_status 199 acpi_get_table_by_index(u32 table_index, struct acpi_table_header **out_table); 200 201 acpi_status 202 acpi_install_table_handler(acpi_table_handler handler, void *context); 203 204 acpi_status acpi_remove_table_handler(acpi_table_handler handler); 205 206 /* 207 * Namespace and name interfaces 208 */ 209 acpi_status 210 acpi_walk_namespace(acpi_object_type type, 211 acpi_handle start_object, 212 u32 max_depth, 213 acpi_walk_callback descending_callback, 214 acpi_walk_callback ascending_callback, 215 void *context, void **return_value); 216 217 acpi_status 218 acpi_get_devices(const char *HID, 219 acpi_walk_callback user_function, 220 void *context, void **return_value); 221 222 acpi_status 223 acpi_get_name(acpi_handle object, 224 u32 name_type, struct acpi_buffer *ret_path_ptr); 225 226 acpi_status 227 acpi_get_handle(acpi_handle parent, 228 acpi_string pathname, acpi_handle * ret_handle); 229 230 acpi_status 231 acpi_attach_data(acpi_handle object, acpi_object_handler handler, void *data); 232 233 acpi_status acpi_detach_data(acpi_handle object, acpi_object_handler handler); 234 235 acpi_status 236 acpi_get_data_full(acpi_handle object, acpi_object_handler handler, void **data, 237 void (*callback)(void *)); 238 239 acpi_status 240 acpi_get_data(acpi_handle object, acpi_object_handler handler, void **data); 241 242 acpi_status 243 acpi_debug_trace(char *name, u32 debug_level, u32 debug_layer, u32 flags); 244 245 /* 246 * Object manipulation and enumeration 247 */ 248 acpi_status 249 acpi_evaluate_object(acpi_handle object, 250 acpi_string pathname, 251 struct acpi_object_list *parameter_objects, 252 struct acpi_buffer *return_object_buffer); 253 254 acpi_status 255 acpi_evaluate_object_typed(acpi_handle object, 256 acpi_string pathname, 257 struct acpi_object_list *external_params, 258 struct acpi_buffer *return_buffer, 259 acpi_object_type return_type); 260 261 acpi_status 262 acpi_get_object_info(acpi_handle object, 263 struct acpi_device_info **return_buffer); 264 265 acpi_status acpi_install_method(u8 *buffer); 266 267 acpi_status 268 acpi_get_next_object(acpi_object_type type, 269 acpi_handle parent, 270 acpi_handle child, acpi_handle * out_handle); 271 272 acpi_status acpi_get_type(acpi_handle object, acpi_object_type * out_type); 273 274 acpi_status acpi_get_id(acpi_handle object, acpi_owner_id * out_type); 275 276 acpi_status acpi_get_parent(acpi_handle object, acpi_handle * out_handle); 277 278 /* 279 * Handler interfaces 280 */ 281 acpi_status 282 acpi_install_initialization_handler(acpi_init_handler handler, u32 function); 283 284 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 285 acpi_install_sci_handler(acpi_sci_handler 286 address, 287 void *context)) 288 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 289 acpi_remove_sci_handler(acpi_sci_handler 290 address)) 291 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 292 acpi_install_global_event_handler 293 (acpi_gbl_event_handler handler, 294 void *context)) 295 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 296 acpi_install_fixed_event_handler(u32 297 acpi_event, 298 acpi_event_handler 299 handler, 300 void 301 *context)) 302 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 303 acpi_remove_fixed_event_handler(u32 acpi_event, 304 acpi_event_handler 305 handler)) 306 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 307 acpi_install_gpe_handler(acpi_handle 308 gpe_device, 309 u32 gpe_number, 310 u32 type, 311 acpi_gpe_handler 312 address, 313 void *context)) 314 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 315 acpi_remove_gpe_handler(acpi_handle gpe_device, 316 u32 gpe_number, 317 acpi_gpe_handler 318 address)) 319 acpi_status acpi_install_notify_handler(acpi_handle device, u32 handler_type, 320 acpi_notify_handler handler, 321 void *context); 322 323 acpi_status 324 acpi_remove_notify_handler(acpi_handle device, 325 u32 handler_type, acpi_notify_handler handler); 326 327 acpi_status 328 acpi_install_address_space_handler(acpi_handle device, 329 acpi_adr_space_type space_id, 330 acpi_adr_space_handler handler, 331 acpi_adr_space_setup setup, void *context); 332 333 acpi_status 334 acpi_remove_address_space_handler(acpi_handle device, 335 acpi_adr_space_type space_id, 336 acpi_adr_space_handler handler); 337 338 #ifdef ACPI_FUTURE_USAGE 339 acpi_status acpi_install_exception_handler(acpi_exception_handler handler); 340 #endif 341 342 acpi_status acpi_install_interface_handler(acpi_interface_handler handler); 343 344 /* 345 * Global Lock interfaces 346 */ 347 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 348 acpi_acquire_global_lock(u16 timeout, 349 u32 *handle)) 350 351 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 352 acpi_release_global_lock(u32 handle)) 353 354 /* 355 * Interfaces to AML mutex objects 356 */ 357 acpi_status 358 acpi_acquire_mutex(acpi_handle handle, acpi_string pathname, u16 timeout); 359 360 acpi_status acpi_release_mutex(acpi_handle handle, acpi_string pathname); 361 362 /* 363 * Fixed Event interfaces 364 */ 365 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 366 acpi_enable_event(u32 event, u32 flags)) 367 368 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 369 acpi_disable_event(u32 event, u32 flags)) 370 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_clear_event(u32 event)) 371 372 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 373 acpi_get_event_status(u32 event, 374 acpi_event_status 375 *event_status)) 376 377 /* 378 * General Purpose Event (GPE) Interfaces 379 */ 380 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_update_all_gpes(void)) 381 382 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 383 acpi_enable_gpe(acpi_handle gpe_device, 384 u32 gpe_number)) 385 386 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 387 acpi_disable_gpe(acpi_handle gpe_device, 388 u32 gpe_number)) 389 390 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 391 acpi_clear_gpe(acpi_handle gpe_device, 392 u32 gpe_number)) 393 394 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 395 acpi_set_gpe(acpi_handle gpe_device, 396 u32 gpe_number, u8 action)) 397 398 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 399 acpi_finish_gpe(acpi_handle gpe_device, 400 u32 gpe_number)) 401 402 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 403 acpi_setup_gpe_for_wake(acpi_handle 404 parent_device, 405 acpi_handle gpe_device, 406 u32 gpe_number)) 407 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 408 acpi_set_gpe_wake_mask(acpi_handle gpe_device, 409 u32 gpe_number, 410 u8 action)) 411 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 412 acpi_get_gpe_status(acpi_handle gpe_device, 413 u32 gpe_number, 414 acpi_event_status 415 *event_status)) 416 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_disable_all_gpes(void)) 417 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable_all_runtime_gpes(void)) 418 419 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 420 acpi_get_gpe_device(u32 gpe_index, 421 acpi_handle * gpe_device)) 422 423 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 424 acpi_install_gpe_block(acpi_handle gpe_device, 425 struct 426 acpi_generic_address 427 *gpe_block_address, 428 u32 register_count, 429 u32 interrupt_number)) 430 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 431 acpi_remove_gpe_block(acpi_handle gpe_device)) 432 433 /* 434 * Resource interfaces 435 */ 436 typedef 437 acpi_status(*acpi_walk_resource_callback) (struct acpi_resource * resource, 438 void *context); 439 440 acpi_status 441 acpi_get_vendor_resource(acpi_handle device, 442 char *name, 443 struct acpi_vendor_uuid *uuid, 444 struct acpi_buffer *ret_buffer); 445 446 acpi_status 447 acpi_get_current_resources(acpi_handle device, struct acpi_buffer *ret_buffer); 448 449 #ifdef ACPI_FUTURE_USAGE 450 acpi_status 451 acpi_get_possible_resources(acpi_handle device, struct acpi_buffer *ret_buffer); 452 #endif 453 454 acpi_status 455 acpi_get_event_resources(acpi_handle device_handle, 456 struct acpi_buffer *ret_buffer); 457 458 acpi_status 459 acpi_walk_resource_buffer(struct acpi_buffer *buffer, 460 acpi_walk_resource_callback user_function, 461 void *context); 462 463 acpi_status 464 acpi_walk_resources(acpi_handle device, 465 char *name, 466 acpi_walk_resource_callback user_function, void *context); 467 468 acpi_status 469 acpi_set_current_resources(acpi_handle device, struct acpi_buffer *in_buffer); 470 471 acpi_status 472 acpi_get_irq_routing_table(acpi_handle device, struct acpi_buffer *ret_buffer); 473 474 acpi_status 475 acpi_resource_to_address64(struct acpi_resource *resource, 476 struct acpi_resource_address64 *out); 477 478 acpi_status 479 acpi_buffer_to_resource(u8 *aml_buffer, 480 u16 aml_buffer_length, 481 struct acpi_resource **resource_ptr); 482 483 /* 484 * Hardware (ACPI device) interfaces 485 */ 486 acpi_status acpi_reset(void); 487 488 acpi_status acpi_read(u64 *value, struct acpi_generic_address *reg); 489 490 acpi_status acpi_write(u64 value, struct acpi_generic_address *reg); 491 492 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 493 acpi_read_bit_register(u32 register_id, 494 u32 *return_value)) 495 496 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 497 acpi_write_bit_register(u32 register_id, 498 u32 value)) 499 500 /* 501 * Sleep/Wake interfaces 502 */ 503 acpi_status 504 acpi_get_sleep_type_data(u8 sleep_state, u8 *slp_typ_a, u8 *slp_typ_b); 505 506 acpi_status acpi_enter_sleep_state_prep(u8 sleep_state); 507 508 acpi_status acpi_enter_sleep_state(u8 sleep_state); 509 510 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enter_sleep_state_s4bios(void)) 511 512 acpi_status acpi_leave_sleep_state_prep(u8 sleep_state); 513 514 acpi_status acpi_leave_sleep_state(u8 sleep_state); 515 516 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 517 acpi_set_firmware_waking_vector(u32 518 physical_address)) 519 #if ACPI_MACHINE_WIDTH == 64 520 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 521 acpi_set_firmware_waking_vector64(u64 522 physical_address)) 523 #endif 524 /* 525 * ACPI Timer interfaces 526 */ 527 #ifdef ACPI_FUTURE_USAGE 528 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 529 acpi_get_timer_resolution(u32 *resolution)) 530 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_get_timer(u32 *ticks)) 531 532 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 533 acpi_get_timer_duration(u32 start_ticks, 534 u32 end_ticks, 535 u32 *time_elapsed)) 536 #endif /* ACPI_FUTURE_USAGE */ 537 538 /* 539 * Error/Warning output 540 */ 541 ACPI_PRINTF_LIKE(3) 542 void ACPI_INTERNAL_VAR_XFACE 543 acpi_error(const char *module_name, u32 line_number, const char *format, ...); 544 545 ACPI_PRINTF_LIKE(4) 546 void ACPI_INTERNAL_VAR_XFACE 547 acpi_exception(const char *module_name, 548 u32 line_number, acpi_status status, const char *format, ...); 549 550 ACPI_PRINTF_LIKE(3) 551 void ACPI_INTERNAL_VAR_XFACE 552 acpi_warning(const char *module_name, u32 line_number, const char *format, ...); 553 554 ACPI_PRINTF_LIKE(3) 555 void ACPI_INTERNAL_VAR_XFACE 556 acpi_info(const char *module_name, u32 line_number, const char *format, ...); 557 558 ACPI_PRINTF_LIKE(3) 559 void ACPI_INTERNAL_VAR_XFACE 560 acpi_bios_error(const char *module_name, 561 u32 line_number, const char *format, ...); 562 563 ACPI_PRINTF_LIKE(3) 564 void ACPI_INTERNAL_VAR_XFACE 565 acpi_bios_warning(const char *module_name, 566 u32 line_number, const char *format, ...); 567 568 /* 569 * Debug output 570 */ 571 #ifdef ACPI_DEBUG_OUTPUT 572 573 ACPI_PRINTF_LIKE(6) 574 void ACPI_INTERNAL_VAR_XFACE 575 acpi_debug_print(u32 requested_debug_level, 576 u32 line_number, 577 const char *function_name, 578 const char *module_name, 579 u32 component_id, const char *format, ...); 580 581 ACPI_PRINTF_LIKE(6) 582 void ACPI_INTERNAL_VAR_XFACE 583 acpi_debug_print_raw(u32 requested_debug_level, 584 u32 line_number, 585 const char *function_name, 586 const char *module_name, 587 u32 component_id, const char *format, ...); 588 #endif 589 590 #endif /* __ACXFACE_H__ */ 591