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