1 /******************************************************************************
3 * Name: acutils.h -- prototypes for the common (subsystem-wide) procedures
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2016, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
47 extern const u8 acpi_gbl_resource_aml_sizes
[];
48 extern const u8 acpi_gbl_resource_aml_serial_bus_sizes
[];
50 /* Strings used by the disassembler and debugger resource dump routines */
52 #if defined(ACPI_DEBUG_OUTPUT) || defined (ACPI_DISASSEMBLER) || defined (ACPI_DEBUGGER)
54 extern const char *acpi_gbl_bm_decode
[];
55 extern const char *acpi_gbl_config_decode
[];
56 extern const char *acpi_gbl_consume_decode
[];
57 extern const char *acpi_gbl_dec_decode
[];
58 extern const char *acpi_gbl_he_decode
[];
59 extern const char *acpi_gbl_io_decode
[];
60 extern const char *acpi_gbl_ll_decode
[];
61 extern const char *acpi_gbl_max_decode
[];
62 extern const char *acpi_gbl_mem_decode
[];
63 extern const char *acpi_gbl_min_decode
[];
64 extern const char *acpi_gbl_mtp_decode
[];
65 extern const char *acpi_gbl_rng_decode
[];
66 extern const char *acpi_gbl_rw_decode
[];
67 extern const char *acpi_gbl_shr_decode
[];
68 extern const char *acpi_gbl_siz_decode
[];
69 extern const char *acpi_gbl_trs_decode
[];
70 extern const char *acpi_gbl_ttp_decode
[];
71 extern const char *acpi_gbl_typ_decode
[];
72 extern const char *acpi_gbl_ppc_decode
[];
73 extern const char *acpi_gbl_ior_decode
[];
74 extern const char *acpi_gbl_dts_decode
[];
75 extern const char *acpi_gbl_ct_decode
[];
76 extern const char *acpi_gbl_sbt_decode
[];
77 extern const char *acpi_gbl_am_decode
[];
78 extern const char *acpi_gbl_sm_decode
[];
79 extern const char *acpi_gbl_wm_decode
[];
80 extern const char *acpi_gbl_cph_decode
[];
81 extern const char *acpi_gbl_cpo_decode
[];
82 extern const char *acpi_gbl_dp_decode
[];
83 extern const char *acpi_gbl_ed_decode
[];
84 extern const char *acpi_gbl_bpb_decode
[];
85 extern const char *acpi_gbl_sb_decode
[];
86 extern const char *acpi_gbl_fc_decode
[];
87 extern const char *acpi_gbl_pt_decode
[];
91 * For the iASL compiler case, the output is redirected to stderr so that
92 * any of the various ACPI errors and warnings do not appear in the output
93 * files, for either the compiler or disassembler portions of the tool.
95 #ifdef ACPI_ASL_COMPILER
99 #define ACPI_MSG_REDIRECT_BEGIN \
100 FILE *output_file = acpi_gbl_output_file; \
101 acpi_os_redirect_output (stderr);
103 #define ACPI_MSG_REDIRECT_END \
104 acpi_os_redirect_output (output_file);
108 * non-iASL case - no redirection, nothing to do
110 #define ACPI_MSG_REDIRECT_BEGIN
111 #define ACPI_MSG_REDIRECT_END
115 * Common error message prefixes
117 #define ACPI_MSG_ERROR "ACPI Error: "
118 #define ACPI_MSG_EXCEPTION "ACPI Exception: "
119 #define ACPI_MSG_WARNING "ACPI Warning: "
120 #define ACPI_MSG_INFO "ACPI: "
122 #define ACPI_MSG_BIOS_ERROR "ACPI BIOS Error (bug): "
123 #define ACPI_MSG_BIOS_WARNING "ACPI BIOS Warning (bug): "
126 * Common message suffix
128 #define ACPI_MSG_SUFFIX \
129 acpi_os_printf (" (%8.8X/%s-%u)\n", ACPI_CA_VERSION, module_name, line_number)
131 /* Types for Resource descriptor entries */
133 #define ACPI_INVALID_RESOURCE 0
134 #define ACPI_FIXED_LENGTH 1
135 #define ACPI_VARIABLE_LENGTH 2
136 #define ACPI_SMALL_VARIABLE_LENGTH 3
139 acpi_status(*acpi_walk_aml_callback
) (u8
*aml
,
142 u8 resource_index
, void **context
);
145 acpi_status(*acpi_pkg_callback
) (u8 object_type
,
146 union acpi_operand_object
*source_object
,
147 union acpi_generic_state
* state
,
150 struct acpi_pkg_info
{
157 /* Object reference counts */
159 #define REF_INCREMENT (u16) 0
160 #define REF_DECREMENT (u16) 1
162 /* acpi_ut_dump_buffer */
164 #define DB_BYTE_DISPLAY 1
165 #define DB_WORD_DISPLAY 2
166 #define DB_DWORD_DISPLAY 4
167 #define DB_QWORD_DISPLAY 8
170 * utnonansi - Non-ANSI C library functions
172 void acpi_ut_strupr(char *src_string
);
174 void acpi_ut_strlwr(char *src_string
);
176 int acpi_ut_stricmp(char *string1
, char *string2
);
179 acpi_ut_strtoul64(char *string
,
180 u32 base
, u32 max_integer_byte_width
, u64
*ret_integer
);
182 /* Values for max_integer_byte_width above */
184 #define ACPI_MAX32_BYTE_WIDTH 4
185 #define ACPI_MAX64_BYTE_WIDTH 8
188 * utglobal - Global data structures and procedures
190 acpi_status
acpi_ut_init_globals(void);
192 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
194 const char *acpi_ut_get_mutex_name(u32 mutex_id
);
196 const char *acpi_ut_get_notify_name(u32 notify_value
, acpi_object_type type
);
199 const char *acpi_ut_get_type_name(acpi_object_type type
);
201 const char *acpi_ut_get_node_name(void *object
);
203 const char *acpi_ut_get_descriptor_name(void *object
);
205 const char *acpi_ut_get_reference_name(union acpi_operand_object
*object
);
207 const char *acpi_ut_get_object_type_name(union acpi_operand_object
*obj_desc
);
209 const char *acpi_ut_get_region_name(u8 space_id
);
211 const char *acpi_ut_get_event_name(u32 event_id
);
213 char acpi_ut_hex_to_ascii_char(u64 integer
, u32 position
);
215 u8
acpi_ut_ascii_char_to_hex(int hex_char
);
217 u8
acpi_ut_valid_object_type(acpi_object_type type
);
220 * utinit - miscellaneous initialization and shutdown
222 acpi_status
acpi_ut_hardware_initialize(void);
224 void acpi_ut_subsystem_shutdown(void);
227 * utcopy - Object construction and conversion interfaces
230 acpi_ut_build_simple_object(union acpi_operand_object
*obj
,
231 union acpi_object
*user_obj
,
232 u8
*data_space
, u32
*buffer_space_used
);
235 acpi_ut_build_package_object(union acpi_operand_object
*obj
,
236 u8
*buffer
, u32
*space_used
);
239 acpi_ut_copy_iobject_to_eobject(union acpi_operand_object
*obj
,
240 struct acpi_buffer
*ret_buffer
);
243 acpi_ut_copy_eobject_to_iobject(union acpi_object
*obj
,
244 union acpi_operand_object
**internal_obj
);
247 acpi_ut_copy_isimple_to_isimple(union acpi_operand_object
*source_obj
,
248 union acpi_operand_object
*dest_obj
);
251 acpi_ut_copy_iobject_to_iobject(union acpi_operand_object
*source_desc
,
252 union acpi_operand_object
**dest_desc
,
253 struct acpi_walk_state
*walk_state
);
256 * utcreate - Object creation
259 acpi_ut_update_object_reference(union acpi_operand_object
*object
, u16 action
);
262 * utdebug - Debug interfaces
264 void acpi_ut_init_stack_ptr_trace(void);
266 void acpi_ut_track_stack_ptr(void);
269 acpi_ut_trace(u32 line_number
,
270 const char *function_name
,
271 const char *module_name
, u32 component_id
);
274 acpi_ut_trace_ptr(u32 line_number
,
275 const char *function_name
,
276 const char *module_name
, u32 component_id
, void *pointer
);
279 acpi_ut_trace_u32(u32 line_number
,
280 const char *function_name
,
281 const char *module_name
, u32 component_id
, u32 integer
);
284 acpi_ut_trace_str(u32 line_number
,
285 const char *function_name
,
286 const char *module_name
, u32 component_id
, char *string
);
289 acpi_ut_exit(u32 line_number
,
290 const char *function_name
,
291 const char *module_name
, u32 component_id
);
294 acpi_ut_status_exit(u32 line_number
,
295 const char *function_name
,
296 const char *module_name
,
297 u32 component_id
, acpi_status status
);
300 acpi_ut_value_exit(u32 line_number
,
301 const char *function_name
,
302 const char *module_name
, u32 component_id
, u64 value
);
305 acpi_ut_ptr_exit(u32 line_number
,
306 const char *function_name
,
307 const char *module_name
, u32 component_id
, u8
*ptr
);
310 acpi_ut_debug_dump_buffer(u8
*buffer
, u32 count
, u32 display
, u32 component_id
);
312 void acpi_ut_dump_buffer(u8
*buffer
, u32 count
, u32 display
, u32 offset
);
314 #ifdef ACPI_APPLICATION
316 acpi_ut_dump_buffer_to_file(ACPI_FILE file
,
318 u32 count
, u32 display
, u32 base_offset
);
321 void acpi_ut_report_error(char *module_name
, u32 line_number
);
323 void acpi_ut_report_info(char *module_name
, u32 line_number
);
325 void acpi_ut_report_warning(char *module_name
, u32 line_number
);
328 * utdelete - Object deletion and reference counts
330 void acpi_ut_add_reference(union acpi_operand_object
*object
);
332 void acpi_ut_remove_reference(union acpi_operand_object
*object
);
334 void acpi_ut_delete_internal_package_object(union acpi_operand_object
*object
);
336 void acpi_ut_delete_internal_simple_object(union acpi_operand_object
*object
);
338 void acpi_ut_delete_internal_object_list(union acpi_operand_object
**obj_list
);
341 * uteval - object evaluation
344 acpi_ut_evaluate_object(struct acpi_namespace_node
*prefix_node
,
346 u32 expected_return_btypes
,
347 union acpi_operand_object
**return_desc
);
350 acpi_ut_evaluate_numeric_object(char *object_name
,
351 struct acpi_namespace_node
*device_node
,
355 acpi_ut_execute_STA(struct acpi_namespace_node
*device_node
, u32
*status_flags
);
358 acpi_ut_execute_power_methods(struct acpi_namespace_node
*device_node
,
359 const char **method_names
,
360 u8 method_count
, u8
*out_values
);
363 * utids - device ID support
366 acpi_ut_execute_HID(struct acpi_namespace_node
*device_node
,
367 struct acpi_pnp_device_id
** return_id
);
370 acpi_ut_execute_UID(struct acpi_namespace_node
*device_node
,
371 struct acpi_pnp_device_id
** return_id
);
374 acpi_ut_execute_CID(struct acpi_namespace_node
*device_node
,
375 struct acpi_pnp_device_id_list
** return_cid_list
);
378 acpi_ut_execute_CLS(struct acpi_namespace_node
*device_node
,
379 struct acpi_pnp_device_id
**return_id
);
382 * utlock - reader/writer locks
384 acpi_status
acpi_ut_create_rw_lock(struct acpi_rw_lock
*lock
);
386 void acpi_ut_delete_rw_lock(struct acpi_rw_lock
*lock
);
388 acpi_status
acpi_ut_acquire_read_lock(struct acpi_rw_lock
*lock
);
390 acpi_status
acpi_ut_release_read_lock(struct acpi_rw_lock
*lock
);
392 acpi_status
acpi_ut_acquire_write_lock(struct acpi_rw_lock
*lock
);
394 void acpi_ut_release_write_lock(struct acpi_rw_lock
*lock
);
397 * utobject - internal object create/delete/cache routines
399 union acpi_operand_object
*acpi_ut_create_internal_object_dbg(const char
406 void *acpi_ut_allocate_object_desc_dbg(const char *module_name
,
407 u32 line_number
, u32 component_id
);
409 #define acpi_ut_create_internal_object(t) acpi_ut_create_internal_object_dbg (_acpi_module_name,__LINE__,_COMPONENT,t)
410 #define acpi_ut_allocate_object_desc() acpi_ut_allocate_object_desc_dbg (_acpi_module_name,__LINE__,_COMPONENT)
412 void acpi_ut_delete_object_desc(union acpi_operand_object
*object
);
414 u8
acpi_ut_valid_internal_object(void *object
);
416 union acpi_operand_object
*acpi_ut_create_package_object(u32 count
);
418 union acpi_operand_object
*acpi_ut_create_integer_object(u64 value
);
420 union acpi_operand_object
*acpi_ut_create_buffer_object(acpi_size buffer_size
);
422 union acpi_operand_object
*acpi_ut_create_string_object(acpi_size string_size
);
425 acpi_ut_get_object_size(union acpi_operand_object
*obj
, acpi_size
* obj_length
);
428 * utosi - Support for the _OSI predefined control method
430 acpi_status
acpi_ut_initialize_interfaces(void);
432 acpi_status
acpi_ut_interface_terminate(void);
434 acpi_status
acpi_ut_install_interface(acpi_string interface_name
);
436 acpi_status
acpi_ut_remove_interface(acpi_string interface_name
);
438 acpi_status
acpi_ut_update_interfaces(u8 action
);
440 struct acpi_interface_info
*acpi_ut_get_interface(acpi_string interface_name
);
442 acpi_status
acpi_ut_osi_implementation(struct acpi_walk_state
*walk_state
);
445 * utpredef - support for predefined names
447 const union acpi_predefined_info
*acpi_ut_get_next_predefined_method(const union
451 const union acpi_predefined_info
*acpi_ut_match_predefined_method(char *name
);
453 void acpi_ut_get_expected_return_types(char *buffer
, u32 expected_btypes
);
455 #if (defined ACPI_ASL_COMPILER || defined ACPI_HELP_APP)
456 const union acpi_predefined_info
*acpi_ut_match_resource_name(char *name
);
459 acpi_ut_display_predefined_method(char *buffer
,
460 const union acpi_predefined_info
*this_name
,
463 u32
acpi_ut_get_resource_bit_width(char *buffer
, u16 types
);
467 * utstate - Generic state creation/cache routines
470 acpi_ut_push_generic_state(union acpi_generic_state
**list_head
,
471 union acpi_generic_state
*state
);
473 union acpi_generic_state
*acpi_ut_pop_generic_state(union acpi_generic_state
476 union acpi_generic_state
*acpi_ut_create_generic_state(void);
478 struct acpi_thread_state
*acpi_ut_create_thread_state(void);
480 union acpi_generic_state
*acpi_ut_create_update_state(union acpi_operand_object
481 *object
, u16 action
);
483 union acpi_generic_state
*acpi_ut_create_pkg_state(void *internal_object
,
484 void *external_object
,
488 acpi_ut_create_update_state_and_push(union acpi_operand_object
*object
,
490 union acpi_generic_state
**state_list
);
492 union acpi_generic_state
*acpi_ut_create_control_state(void);
494 void acpi_ut_delete_generic_state(union acpi_generic_state
*state
);
500 acpi_ut_divide(u64 in_dividend
,
501 u64 in_divisor
, u64
*out_quotient
, u64
*out_remainder
);
504 acpi_ut_short_divide(u64 in_dividend
,
505 u32 divisor
, u64
*out_quotient
, u32
*out_remainder
);
510 const struct acpi_exception_info
*acpi_ut_validate_exception(acpi_status
513 u8
acpi_ut_is_pci_root_bridge(char *id
);
515 #if (defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP || defined ACPI_NAMES_APP)
516 u8
acpi_ut_is_aml_table(struct acpi_table_header
*table
);
520 acpi_ut_walk_package_tree(union acpi_operand_object
*source_object
,
522 acpi_pkg_callback walk_callback
, void *context
);
524 /* Values for Base above (16=Hex, 10=Decimal) */
526 #define ACPI_ANY_BASE 0
528 u32
acpi_ut_dword_byte_swap(u32 value
);
530 void acpi_ut_set_integer_width(u8 revision
);
532 #ifdef ACPI_DEBUG_OUTPUT
534 acpi_ut_display_init_pathname(u8 type
,
535 struct acpi_namespace_node
*obj_handle
,
540 * utownerid - Support for Table/Method Owner IDs
542 acpi_status
acpi_ut_allocate_owner_id(acpi_owner_id
* owner_id
);
544 void acpi_ut_release_owner_id(acpi_owner_id
* owner_id
);
550 acpi_ut_walk_aml_resources(struct acpi_walk_state
*walk_state
,
552 acpi_size aml_length
,
553 acpi_walk_aml_callback user_function
,
557 acpi_ut_validate_resource(struct acpi_walk_state
*walk_state
,
558 void *aml
, u8
*return_index
);
560 u32
acpi_ut_get_descriptor_length(void *aml
);
562 u16
acpi_ut_get_resource_length(void *aml
);
564 u8
acpi_ut_get_resource_header_length(void *aml
);
566 u8
acpi_ut_get_resource_type(void *aml
);
569 acpi_ut_get_resource_end_tag(union acpi_operand_object
*obj_desc
, u8
**end_tag
);
572 * utstring - String and character utilities
574 void acpi_ut_print_string(char *string
, u16 max_length
);
576 #if defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP
577 void ut_convert_backslashes(char *pathname
);
580 u8
acpi_ut_valid_acpi_name(char *name
);
582 u8
acpi_ut_valid_acpi_char(char character
, u32 position
);
584 void acpi_ut_repair_name(char *name
);
586 #if defined (ACPI_DEBUGGER) || defined (ACPI_APPLICATION)
587 u8
acpi_ut_safe_strcpy(char *dest
, acpi_size dest_size
, char *source
);
589 u8
acpi_ut_safe_strcat(char *dest
, acpi_size dest_size
, char *source
);
592 acpi_ut_safe_strncat(char *dest
,
594 char *source
, acpi_size max_transfer_length
);
598 * utmutex - mutex support
600 acpi_status
acpi_ut_mutex_initialize(void);
602 void acpi_ut_mutex_terminate(void);
604 acpi_status
acpi_ut_acquire_mutex(acpi_mutex_handle mutex_id
);
606 acpi_status
acpi_ut_release_mutex(acpi_mutex_handle mutex_id
);
609 * utalloc - memory allocation and object caching
611 acpi_status
acpi_ut_create_caches(void);
613 acpi_status
acpi_ut_delete_caches(void);
615 acpi_status
acpi_ut_validate_buffer(struct acpi_buffer
*buffer
);
618 acpi_ut_initialize_buffer(struct acpi_buffer
*buffer
,
619 acpi_size required_length
);
621 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
622 void *acpi_ut_allocate_and_track(acpi_size size
,
623 u32 component
, const char *module
, u32 line
);
625 void *acpi_ut_allocate_zeroed_and_track(acpi_size size
,
627 const char *module
, u32 line
);
630 acpi_ut_free_and_track(void *address
,
631 u32 component
, const char *module
, u32 line
);
633 void acpi_ut_dump_allocation_info(void);
635 void acpi_ut_dump_allocations(u32 component
, const char *module
);
638 acpi_ut_create_list(char *list_name
,
639 u16 object_size
, struct acpi_memory_list
**return_cache
);
641 #endif /* ACPI_DBG_TRACK_ALLOCATIONS */
644 * utaddress - address range check
647 acpi_ut_add_address_range(acpi_adr_space_type space_id
,
648 acpi_physical_address address
,
649 u32 length
, struct acpi_namespace_node
*region_node
);
652 acpi_ut_remove_address_range(acpi_adr_space_type space_id
,
653 struct acpi_namespace_node
*region_node
);
656 acpi_ut_check_address_range(acpi_adr_space_type space_id
,
657 acpi_physical_address address
, u32 length
, u8 warn
);
659 void acpi_ut_delete_address_lists(void);
662 * utxferror - various error/warning output functions
664 void ACPI_INTERNAL_VAR_XFACE
665 acpi_ut_predefined_warning(const char *module_name
,
668 u8 node_flags
, const char *format
, ...);
670 void ACPI_INTERNAL_VAR_XFACE
671 acpi_ut_predefined_info(const char *module_name
,
673 char *pathname
, u8 node_flags
, const char *format
, ...);
675 void ACPI_INTERNAL_VAR_XFACE
676 acpi_ut_predefined_bios_error(const char *module_name
,
679 u8 node_flags
, const char *format
, ...);
682 acpi_ut_namespace_error(const char *module_name
,
684 const char *internal_name
, acpi_status lookup_status
);
687 acpi_ut_method_error(const char *module_name
,
690 struct acpi_namespace_node
*node
,
691 const char *path
, acpi_status lookup_status
);
694 * Utility functions for ACPI names and IDs
696 const struct ah_predefined_name
*acpi_ah_match_predefined_name(char *nameseg
);
698 const struct ah_device_id
*acpi_ah_match_hardware_id(char *hid
);
700 const char *acpi_ah_match_uuid(u8
*data
);
703 * utprint - printf/vprintf output functions
705 const char *acpi_ut_scan_number(const char *string
, u64
*number_ptr
);
707 const char *acpi_ut_print_number(char *string
, u64 number
);
710 acpi_ut_vsnprintf(char *string
,
711 acpi_size size
, const char *format
, va_list args
);
713 int acpi_ut_snprintf(char *string
, acpi_size size
, const char *format
, ...);
715 #ifdef ACPI_APPLICATION
716 int acpi_ut_file_vprintf(ACPI_FILE file
, const char *format
, va_list args
);
718 int acpi_ut_file_printf(ACPI_FILE file
, const char *format
, ...);
722 * utuuid -- UUID support functions
724 #if (defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP || defined ACPI_HELP_APP)
725 void acpi_ut_convert_string_to_uuid(char *in_string
, u8
*uuid_buffer
);
728 #endif /* _ACUTILS_H */