1 2 /****************************************************************************** 3 * 4 * Name: acpixf.h - External interfaces to the ACPI subsystem 5 * 6 *****************************************************************************/ 7 8 /* 9 * Copyright (C) 2000 - 2011, 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 0x20120320 51 52 #include "acconfig.h" 53 #include "actypes.h" 54 #include "actbl.h" 55 56 extern u8 acpi_gbl_permanent_mmap; 57 58 /* 59 * Globals that are publicly available, allowing for 60 * run time configuration 61 */ 62 extern u32 acpi_dbg_level; 63 extern u32 acpi_dbg_layer; 64 extern u8 acpi_gbl_enable_interpreter_slack; 65 extern u8 acpi_gbl_all_methods_serialized; 66 extern u8 acpi_gbl_create_osi_method; 67 extern u8 acpi_gbl_use_default_register_widths; 68 extern acpi_name acpi_gbl_trace_method_name; 69 extern u32 acpi_gbl_trace_flags; 70 extern bool acpi_gbl_enable_aml_debug_object; 71 extern u8 acpi_gbl_copy_dsdt_locally; 72 extern u8 acpi_gbl_truncate_io_addresses; 73 extern u8 acpi_gbl_disable_auto_repair; 74 75 /* 76 * Hardware-reduced prototypes. All interfaces that use these macros will 77 * be configured out of the ACPICA build if the ACPI_REDUCED_HARDWARE flag 78 * is set to TRUE. 79 */ 80 #if (!ACPI_REDUCED_HARDWARE) 81 #define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \ 82 prototype; 83 84 #define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \ 85 prototype; 86 87 #define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \ 88 prototype; 89 90 #else 91 #define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \ 92 static ACPI_INLINE prototype {return(AE_NOT_CONFIGURED);} 93 94 #define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \ 95 static ACPI_INLINE prototype {return(AE_OK);} 96 97 #define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \ 98 static ACPI_INLINE prototype {} 99 100 #endif /* !ACPI_REDUCED_HARDWARE */ 101 102 extern u32 acpi_current_gpe_count; 103 extern struct acpi_table_fadt acpi_gbl_FADT; 104 extern u8 acpi_gbl_system_awake_and_running; 105 extern u8 acpi_gbl_reduced_hardware; /* ACPI 5.0 */ 106 107 extern u32 acpi_rsdt_forced; 108 /* 109 * Global interfaces 110 */ 111 acpi_status 112 acpi_initialize_tables(struct acpi_table_desc *initial_storage, 113 u32 initial_table_count, u8 allow_resize); 114 115 acpi_status __init acpi_initialize_subsystem(void); 116 117 acpi_status acpi_enable_subsystem(u32 flags); 118 119 acpi_status acpi_initialize_objects(u32 flags); 120 121 acpi_status acpi_terminate(void); 122 123 #ifdef ACPI_FUTURE_USAGE 124 acpi_status acpi_subsystem_status(void); 125 #endif 126 127 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable(void)) 128 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_disable(void)) 129 130 #ifdef ACPI_FUTURE_USAGE 131 acpi_status acpi_get_system_info(struct acpi_buffer *ret_buffer); 132 #endif 133 134 const char *acpi_format_exception(acpi_status exception); 135 136 acpi_status acpi_purge_cached_objects(void); 137 138 acpi_status acpi_install_interface(acpi_string interface_name); 139 140 acpi_status acpi_remove_interface(acpi_string interface_name); 141 142 u32 143 acpi_check_address_range(acpi_adr_space_type space_id, 144 acpi_physical_address address, 145 acpi_size length, u8 warn); 146 147 /* 148 * ACPI Memory management 149 */ 150 void *acpi_allocate(u32 size); 151 152 void *acpi_callocate(u32 size); 153 154 void acpi_free(void *address); 155 156 /* 157 * ACPI table manipulation interfaces 158 */ 159 acpi_status acpi_reallocate_root_table(void); 160 161 acpi_status acpi_find_root_pointer(acpi_size *rsdp_address); 162 163 acpi_status acpi_load_tables(void); 164 165 acpi_status acpi_load_table(struct acpi_table_header *table_ptr); 166 167 acpi_status acpi_unload_table_id(acpi_owner_id id); 168 169 acpi_status 170 acpi_get_table_header(acpi_string signature, 171 u32 instance, 172 struct acpi_table_header *out_table_header); 173 174 acpi_status 175 acpi_get_table_with_size(acpi_string signature, 176 u32 instance, struct acpi_table_header **out_table, 177 acpi_size *tbl_size); 178 acpi_status 179 acpi_get_table(acpi_string signature, 180 u32 instance, struct acpi_table_header **out_table); 181 182 acpi_status 183 acpi_get_table_by_index(u32 table_index, 184 struct acpi_table_header **out_table); 185 186 acpi_status 187 acpi_install_table_handler(acpi_tbl_handler handler, void *context); 188 189 acpi_status acpi_remove_table_handler(acpi_tbl_handler handler); 190 191 /* 192 * Namespace and name interfaces 193 */ 194 acpi_status 195 acpi_walk_namespace(acpi_object_type type, 196 acpi_handle start_object, 197 u32 max_depth, 198 acpi_walk_callback pre_order_visit, 199 acpi_walk_callback post_order_visit, 200 void *context, void **return_value); 201 202 acpi_status 203 acpi_get_devices(const char *HID, 204 acpi_walk_callback user_function, 205 void *context, void **return_value); 206 207 acpi_status 208 acpi_get_name(acpi_handle object, 209 u32 name_type, struct acpi_buffer *ret_path_ptr); 210 211 acpi_status 212 acpi_get_handle(acpi_handle parent, 213 acpi_string pathname, acpi_handle * ret_handle); 214 215 acpi_status 216 acpi_attach_data(acpi_handle object, acpi_object_handler handler, void *data); 217 218 acpi_status acpi_detach_data(acpi_handle object, acpi_object_handler handler); 219 220 acpi_status 221 acpi_get_data(acpi_handle object, acpi_object_handler handler, void **data); 222 223 acpi_status 224 acpi_debug_trace(char *name, u32 debug_level, u32 debug_layer, u32 flags); 225 226 /* 227 * Object manipulation and enumeration 228 */ 229 acpi_status 230 acpi_evaluate_object(acpi_handle object, 231 acpi_string pathname, 232 struct acpi_object_list *parameter_objects, 233 struct acpi_buffer *return_object_buffer); 234 235 acpi_status 236 acpi_evaluate_object_typed(acpi_handle object, 237 acpi_string pathname, 238 struct acpi_object_list *external_params, 239 struct acpi_buffer *return_buffer, 240 acpi_object_type return_type); 241 242 acpi_status 243 acpi_get_object_info(acpi_handle object, 244 struct acpi_device_info **return_buffer); 245 246 acpi_status acpi_install_method(u8 *buffer); 247 248 acpi_status 249 acpi_get_next_object(acpi_object_type type, 250 acpi_handle parent, 251 acpi_handle child, acpi_handle * out_handle); 252 253 acpi_status acpi_get_type(acpi_handle object, acpi_object_type * out_type); 254 255 acpi_status acpi_get_id(acpi_handle object, acpi_owner_id * out_type); 256 257 acpi_status acpi_get_parent(acpi_handle object, acpi_handle * out_handle); 258 259 /* 260 * Handler interfaces 261 */ 262 acpi_status 263 acpi_install_initialization_handler(acpi_init_handler handler, u32 function); 264 265 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 266 acpi_install_global_event_handler 267 (ACPI_GBL_EVENT_HANDLER handler, void *context)) 268 269 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 270 acpi_install_fixed_event_handler(u32 271 acpi_event, 272 acpi_event_handler 273 handler, 274 void 275 *context)) 276 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 277 acpi_remove_fixed_event_handler(u32 acpi_event, 278 acpi_event_handler 279 handler)) 280 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 281 acpi_install_gpe_handler(acpi_handle 282 gpe_device, 283 u32 gpe_number, 284 u32 type, 285 acpi_gpe_handler 286 address, 287 void *context)) 288 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 289 acpi_remove_gpe_handler(acpi_handle gpe_device, 290 u32 gpe_number, 291 acpi_gpe_handler 292 address)) 293 acpi_status 294 acpi_install_notify_handler(acpi_handle device, 295 u32 handler_type, 296 acpi_notify_handler handler, void *context); 297 298 acpi_status 299 acpi_remove_notify_handler(acpi_handle device, 300 u32 handler_type, acpi_notify_handler handler); 301 302 acpi_status 303 acpi_install_address_space_handler(acpi_handle device, 304 acpi_adr_space_type space_id, 305 acpi_adr_space_handler handler, 306 acpi_adr_space_setup setup, void *context); 307 308 acpi_status 309 acpi_remove_address_space_handler(acpi_handle device, 310 acpi_adr_space_type space_id, 311 acpi_adr_space_handler handler); 312 313 #ifdef ACPI_FUTURE_USAGE 314 acpi_status acpi_install_exception_handler(acpi_exception_handler handler); 315 #endif 316 317 acpi_status acpi_install_interface_handler(acpi_interface_handler handler); 318 319 /* 320 * Global Lock interfaces 321 */ 322 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 323 acpi_acquire_global_lock(u16 timeout, 324 u32 *handle)) 325 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 326 acpi_release_global_lock(u32 handle)) 327 328 /* 329 * Interfaces to AML mutex objects 330 */ 331 acpi_status 332 acpi_acquire_mutex(acpi_handle handle, acpi_string pathname, u16 timeout); 333 334 acpi_status acpi_release_mutex(acpi_handle handle, acpi_string pathname); 335 336 /* 337 * Fixed Event interfaces 338 */ 339 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 340 acpi_enable_event(u32 event, u32 flags)) 341 342 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 343 acpi_disable_event(u32 event, u32 flags)) 344 345 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_clear_event(u32 event)) 346 347 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 348 acpi_get_event_status(u32 event, 349 acpi_event_status 350 *event_status)) 351 /* 352 * General Purpose Event (GPE) Interfaces 353 */ 354 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_update_all_gpes(void)) 355 356 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 357 acpi_enable_gpe(acpi_handle gpe_device, 358 u32 gpe_number)) 359 360 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 361 acpi_disable_gpe(acpi_handle gpe_device, 362 u32 gpe_number)) 363 364 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 365 acpi_clear_gpe(acpi_handle gpe_device, 366 u32 gpe_number)) 367 368 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 369 acpi_set_gpe(acpi_handle gpe_device, 370 u32 gpe_number, u8 action)) 371 372 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 373 acpi_finish_gpe(acpi_handle gpe_device, 374 u32 gpe_number)) 375 376 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 377 acpi_setup_gpe_for_wake(acpi_handle 378 parent_device, 379 acpi_handle gpe_device, 380 u32 gpe_number)) 381 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 382 acpi_set_gpe_wake_mask(acpi_handle gpe_device, 383 u32 gpe_number, 384 u8 action)) 385 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 386 acpi_get_gpe_status(acpi_handle gpe_device, 387 u32 gpe_number, 388 acpi_event_status 389 *event_status)) 390 391 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_disable_all_gpes(void)) 392 393 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable_all_runtime_gpes(void)) 394 395 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 396 acpi_get_gpe_device(u32 gpe_index, 397 acpi_handle * gpe_device)) 398 399 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 400 acpi_install_gpe_block(acpi_handle gpe_device, 401 struct 402 acpi_generic_address 403 *gpe_block_address, 404 u32 register_count, 405 u32 interrupt_number)) 406 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 407 acpi_remove_gpe_block(acpi_handle gpe_device)) 408 409 /* 410 * Resource interfaces 411 */ 412 typedef 413 acpi_status(*acpi_walk_resource_callback) (struct acpi_resource * resource, 414 void *context); 415 416 acpi_status 417 acpi_get_vendor_resource(acpi_handle device, 418 char *name, 419 struct acpi_vendor_uuid *uuid, 420 struct acpi_buffer *ret_buffer); 421 422 acpi_status 423 acpi_get_current_resources(acpi_handle device, struct acpi_buffer *ret_buffer); 424 425 #ifdef ACPI_FUTURE_USAGE 426 acpi_status 427 acpi_get_possible_resources(acpi_handle device, struct acpi_buffer *ret_buffer); 428 #endif 429 430 acpi_status 431 acpi_get_event_resources(acpi_handle device_handle, 432 struct acpi_buffer *ret_buffer); 433 434 acpi_status 435 acpi_walk_resources(acpi_handle device, 436 char *name, 437 acpi_walk_resource_callback user_function, void *context); 438 439 acpi_status 440 acpi_set_current_resources(acpi_handle device, struct acpi_buffer *in_buffer); 441 442 acpi_status 443 acpi_get_irq_routing_table(acpi_handle device, struct acpi_buffer *ret_buffer); 444 445 acpi_status 446 acpi_resource_to_address64(struct acpi_resource *resource, 447 struct acpi_resource_address64 *out); 448 449 acpi_status 450 acpi_buffer_to_resource(u8 *aml_buffer, 451 u16 aml_buffer_length, 452 struct acpi_resource **resource_ptr); 453 454 /* 455 * Hardware (ACPI device) interfaces 456 */ 457 acpi_status acpi_reset(void); 458 459 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 460 acpi_read_bit_register(u32 register_id, 461 u32 *return_value)) 462 463 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 464 acpi_write_bit_register(u32 register_id, 465 u32 value)) 466 467 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 468 acpi_set_firmware_waking_vector(u32 469 physical_address)) 470 471 #if ACPI_MACHINE_WIDTH == 64 472 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 473 acpi_set_firmware_waking_vector64(u64 474 physical_address)) 475 #endif 476 477 acpi_status acpi_read(u64 *value, struct acpi_generic_address *reg); 478 479 acpi_status acpi_write(u64 value, struct acpi_generic_address *reg); 480 481 /* 482 * Sleep/Wake interfaces 483 */ 484 acpi_status 485 acpi_get_sleep_type_data(u8 sleep_state, u8 * slp_typ_a, u8 * slp_typ_b); 486 487 acpi_status acpi_enter_sleep_state_prep(u8 sleep_state); 488 489 acpi_status asmlinkage acpi_enter_sleep_state(u8 sleep_state, u8 flags); 490 491 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status asmlinkage acpi_enter_sleep_state_s4bios(void)) 492 493 acpi_status acpi_leave_sleep_state_prep(u8 sleep_state, u8 flags); 494 495 acpi_status acpi_leave_sleep_state(u8 sleep_state); 496 497 /* 498 * ACPI Timer interfaces 499 */ 500 #ifdef ACPI_FUTURE_USAGE 501 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 502 acpi_get_timer_resolution(u32 *resolution)) 503 504 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_get_timer(u32 *ticks)) 505 506 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status 507 acpi_get_timer_duration(u32 start_ticks, 508 u32 end_ticks, 509 u32 *time_elapsed)) 510 #endif /* ACPI_FUTURE_USAGE */ 511 512 /* 513 * Error/Warning output 514 */ 515 void ACPI_INTERNAL_VAR_XFACE 516 acpi_error(const char *module_name, 517 u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3); 518 519 void ACPI_INTERNAL_VAR_XFACE 520 acpi_exception(const char *module_name, 521 u32 line_number, 522 acpi_status status, const char *format, ...) ACPI_PRINTF_LIKE(4); 523 524 void ACPI_INTERNAL_VAR_XFACE 525 acpi_warning(const char *module_name, 526 u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3); 527 528 void ACPI_INTERNAL_VAR_XFACE 529 acpi_info(const char *module_name, 530 u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3); 531 532 /* 533 * Debug output 534 */ 535 #ifdef ACPI_DEBUG_OUTPUT 536 537 void ACPI_INTERNAL_VAR_XFACE 538 acpi_debug_print(u32 requested_debug_level, 539 u32 line_number, 540 const char *function_name, 541 const char *module_name, 542 u32 component_id, const char *format, ...) ACPI_PRINTF_LIKE(6); 543 544 void ACPI_INTERNAL_VAR_XFACE 545 acpi_debug_print_raw(u32 requested_debug_level, 546 u32 line_number, 547 const char *function_name, 548 const char *module_name, 549 u32 component_id, 550 const char *format, ...) ACPI_PRINTF_LIKE(6); 551 #endif 552 553 #endif /* __ACXFACE_H__ */ 554