1 /* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */
2 /******************************************************************************
4 * Name: acutils.h -- prototypes for the common (subsystem-wide) procedures
6 * Copyright (C) 2000 - 2021, Intel Corp.
8 *****************************************************************************/
13 extern const u8 acpi_gbl_resource_aml_sizes[];
14 extern const u8 acpi_gbl_resource_aml_serial_bus_sizes[];
16 /* Strings used by the disassembler and debugger resource dump routines */
18 #if defined(ACPI_DEBUG_OUTPUT) || defined (ACPI_DISASSEMBLER) || defined (ACPI_DEBUGGER)
20 extern const char *acpi_gbl_bm_decode[];
21 extern const char *acpi_gbl_config_decode[];
22 extern const char *acpi_gbl_consume_decode[];
23 extern const char *acpi_gbl_dec_decode[];
24 extern const char *acpi_gbl_he_decode[];
25 extern const char *acpi_gbl_io_decode[];
26 extern const char *acpi_gbl_ll_decode[];
27 extern const char *acpi_gbl_max_decode[];
28 extern const char *acpi_gbl_mem_decode[];
29 extern const char *acpi_gbl_min_decode[];
30 extern const char *acpi_gbl_mtp_decode[];
31 extern const char *acpi_gbl_phy_decode[];
32 extern const char *acpi_gbl_rng_decode[];
33 extern const char *acpi_gbl_rw_decode[];
34 extern const char *acpi_gbl_shr_decode[];
35 extern const char *acpi_gbl_siz_decode[];
36 extern const char *acpi_gbl_trs_decode[];
37 extern const char *acpi_gbl_ttp_decode[];
38 extern const char *acpi_gbl_typ_decode[];
39 extern const char *acpi_gbl_ppc_decode[];
40 extern const char *acpi_gbl_ior_decode[];
41 extern const char *acpi_gbl_dts_decode[];
42 extern const char *acpi_gbl_ct_decode[];
43 extern const char *acpi_gbl_sbt_decode[];
44 extern const char *acpi_gbl_am_decode[];
45 extern const char *acpi_gbl_sm_decode[];
46 extern const char *acpi_gbl_wm_decode[];
47 extern const char *acpi_gbl_cph_decode[];
48 extern const char *acpi_gbl_cpo_decode[];
49 extern const char *acpi_gbl_dp_decode[];
50 extern const char *acpi_gbl_ed_decode[];
51 extern const char *acpi_gbl_bpb_decode[];
52 extern const char *acpi_gbl_sb_decode[];
53 extern const char *acpi_gbl_fc_decode[];
54 extern const char *acpi_gbl_pt_decode[];
55 extern const char *acpi_gbl_ptyp_decode[];
59 * For the iASL compiler case, the output is redirected to stderr so that
60 * any of the various ACPI errors and warnings do not appear in the output
61 * files, for either the compiler or disassembler portions of the tool.
63 #ifdef ACPI_ASL_COMPILER
67 #define ACPI_MSG_REDIRECT_BEGIN \
68 FILE *output_file = acpi_gbl_output_file; \
69 acpi_os_redirect_output (stderr);
71 #define ACPI_MSG_REDIRECT_END \
72 acpi_os_redirect_output (output_file);
76 * non-iASL case - no redirection, nothing to do
78 #define ACPI_MSG_REDIRECT_BEGIN
79 #define ACPI_MSG_REDIRECT_END
83 * Common error message prefixes
85 #ifndef ACPI_MSG_ERROR
86 #define ACPI_MSG_ERROR "ACPI Error: "
88 #ifndef ACPI_MSG_WARNING
89 #define ACPI_MSG_WARNING "ACPI Warning: "
92 #define ACPI_MSG_INFO "ACPI: "
95 #ifndef ACPI_MSG_BIOS_ERROR
96 #define ACPI_MSG_BIOS_ERROR "Firmware Error (ACPI): "
98 #ifndef ACPI_MSG_BIOS_WARNING
99 #define ACPI_MSG_BIOS_WARNING "Firmware Warning (ACPI): "
103 * Common message suffix
105 #define ACPI_MSG_SUFFIX \
106 acpi_os_printf (" (%8.8X/%s-%u)\n", ACPI_CA_VERSION, module_name, line_number)
108 /* Flags to indicate implicit or explicit string-to-integer conversion */
110 #define ACPI_IMPLICIT_CONVERSION TRUE
111 #define ACPI_NO_IMPLICIT_CONVERSION FALSE
113 /* Types for Resource descriptor entries */
115 #define ACPI_INVALID_RESOURCE 0
116 #define ACPI_FIXED_LENGTH 1
117 #define ACPI_VARIABLE_LENGTH 2
118 #define ACPI_SMALL_VARIABLE_LENGTH 3
121 acpi_status (*acpi_walk_aml_callback) (u8 *aml,
124 u8 resource_index, void **context);
127 acpi_status (*acpi_pkg_callback) (u8 object_type,
128 union acpi_operand_object * source_object,
129 union acpi_generic_state * state,
132 struct acpi_pkg_info {
139 /* Object reference counts */
141 #define REF_INCREMENT (u16) 0
142 #define REF_DECREMENT (u16) 1
144 /* acpi_ut_dump_buffer */
146 #define DB_BYTE_DISPLAY 0x01
147 #define DB_WORD_DISPLAY 0x02
148 #define DB_DWORD_DISPLAY 0x04
149 #define DB_QWORD_DISPLAY 0x08
150 #define DB_DISPLAY_DATA_ONLY 0x10
153 * utascii - ASCII utilities
155 u8 acpi_ut_valid_nameseg(char *signature);
157 u8 acpi_ut_valid_name_char(char character, u32 position);
159 void acpi_ut_check_and_repair_ascii(u8 *name, char *repaired_name, u32 count);
162 * utnonansi - Non-ANSI C library functions
164 void acpi_ut_strupr(char *src_string);
166 void acpi_ut_strlwr(char *src_string);
168 int acpi_ut_stricmp(char *string1, char *string2);
171 * utstrsuppt - string-to-integer conversion support functions
173 acpi_status acpi_ut_convert_octal_string(char *string, u64 *return_value);
175 acpi_status acpi_ut_convert_decimal_string(char *string, u64 *return_value_ptr);
177 acpi_status acpi_ut_convert_hex_string(char *string, u64 *return_value_ptr);
179 char acpi_ut_remove_whitespace(char **string);
181 char acpi_ut_remove_leading_zeros(char **string);
183 u8 acpi_ut_detect_hex_prefix(char **string);
185 void acpi_ut_remove_hex_prefix(char **string);
187 u8 acpi_ut_detect_octal_prefix(char **string);
190 * utstrtoul64 - string-to-integer conversion functions
192 acpi_status acpi_ut_strtoul64(char *string, u64 *ret_integer);
194 u64 acpi_ut_explicit_strtoul64(char *string);
196 u64 acpi_ut_implicit_strtoul64(char *string);
199 * utglobal - Global data structures and procedures
201 acpi_status acpi_ut_init_globals(void);
203 const char *acpi_ut_get_mutex_name(u32 mutex_id);
205 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
207 const char *acpi_ut_get_notify_name(u32 notify_value, acpi_object_type type);
210 const char *acpi_ut_get_type_name(acpi_object_type type);
212 const char *acpi_ut_get_node_name(void *object);
214 const char *acpi_ut_get_descriptor_name(void *object);
216 const char *acpi_ut_get_reference_name(union acpi_operand_object *object);
218 const char *acpi_ut_get_object_type_name(union acpi_operand_object *obj_desc);
220 const char *acpi_ut_get_region_name(u8 space_id);
222 const char *acpi_ut_get_event_name(u32 event_id);
224 const char *acpi_ut_get_argument_type_name(u32 arg_type);
226 char acpi_ut_hex_to_ascii_char(u64 integer, u32 position);
228 acpi_status acpi_ut_ascii_to_hex_byte(char *two_ascii_chars, u8 *return_byte);
230 u8 acpi_ut_ascii_char_to_hex(int hex_char);
232 u8 acpi_ut_valid_object_type(acpi_object_type type);
235 * utinit - miscellaneous initialization and shutdown
237 acpi_status acpi_ut_hardware_initialize(void);
239 void acpi_ut_subsystem_shutdown(void);
242 * utcopy - Object construction and conversion interfaces
245 acpi_ut_build_simple_object(union acpi_operand_object *obj,
246 union acpi_object *user_obj,
247 u8 *data_space, u32 *buffer_space_used);
250 acpi_ut_build_package_object(union acpi_operand_object *obj,
251 u8 *buffer, u32 *space_used);
254 acpi_ut_copy_iobject_to_eobject(union acpi_operand_object *obj,
255 struct acpi_buffer *ret_buffer);
258 acpi_ut_copy_eobject_to_iobject(union acpi_object *obj,
259 union acpi_operand_object **internal_obj);
262 acpi_ut_copy_isimple_to_isimple(union acpi_operand_object *source_obj,
263 union acpi_operand_object *dest_obj);
266 acpi_ut_copy_iobject_to_iobject(union acpi_operand_object *source_desc,
267 union acpi_operand_object **dest_desc,
268 struct acpi_walk_state *walk_state);
271 * utcreate - Object creation
274 acpi_ut_update_object_reference(union acpi_operand_object *object, u16 action);
277 * utdebug - Debug interfaces
279 void acpi_ut_init_stack_ptr_trace(void);
281 void acpi_ut_track_stack_ptr(void);
284 acpi_ut_trace(u32 line_number,
285 const char *function_name,
286 const char *module_name, u32 component_id);
289 acpi_ut_trace_ptr(u32 line_number,
290 const char *function_name,
291 const char *module_name,
292 u32 component_id, const void *pointer);
295 acpi_ut_trace_u32(u32 line_number,
296 const char *function_name,
297 const char *module_name, u32 component_id, u32 integer);
300 acpi_ut_trace_str(u32 line_number,
301 const char *function_name,
302 const char *module_name,
303 u32 component_id, const char *string);
306 acpi_ut_exit(u32 line_number,
307 const char *function_name,
308 const char *module_name, u32 component_id);
311 acpi_ut_status_exit(u32 line_number,
312 const char *function_name,
313 const char *module_name,
314 u32 component_id, acpi_status status);
317 acpi_ut_value_exit(u32 line_number,
318 const char *function_name,
319 const char *module_name, u32 component_id, u64 value);
322 acpi_ut_ptr_exit(u32 line_number,
323 const char *function_name,
324 const char *module_name, u32 component_id, u8 *ptr);
327 acpi_ut_str_exit(u32 line_number,
328 const char *function_name,
329 const char *module_name, u32 component_id, const char *string);
332 acpi_ut_debug_dump_buffer(u8 *buffer, u32 count, u32 display, u32 component_id);
334 void acpi_ut_dump_buffer(u8 *buffer, u32 count, u32 display, u32 offset);
336 #ifdef ACPI_APPLICATION
338 acpi_ut_dump_buffer_to_file(ACPI_FILE file,
340 u32 count, u32 display, u32 base_offset);
343 void acpi_ut_report_error(char *module_name, u32 line_number);
345 void acpi_ut_report_info(char *module_name, u32 line_number);
347 void acpi_ut_report_warning(char *module_name, u32 line_number);
350 * utdelete - Object deletion and reference counts
352 void acpi_ut_add_reference(union acpi_operand_object *object);
354 void acpi_ut_remove_reference(union acpi_operand_object *object);
356 void acpi_ut_delete_internal_package_object(union acpi_operand_object *object);
358 void acpi_ut_delete_internal_simple_object(union acpi_operand_object *object);
360 void acpi_ut_delete_internal_object_list(union acpi_operand_object **obj_list);
363 * uteval - object evaluation
366 acpi_ut_evaluate_object(struct acpi_namespace_node *prefix_node,
368 u32 expected_return_btypes,
369 union acpi_operand_object **return_desc);
372 acpi_ut_evaluate_numeric_object(const char *object_name,
373 struct acpi_namespace_node *device_node,
377 acpi_ut_execute_STA(struct acpi_namespace_node *device_node, u32 *status_flags);
380 acpi_ut_execute_power_methods(struct acpi_namespace_node *device_node,
381 const char **method_names,
382 u8 method_count, u8 *out_values);
385 * utids - device ID support
388 acpi_ut_execute_HID(struct acpi_namespace_node *device_node,
389 struct acpi_pnp_device_id ** return_id);
392 acpi_ut_execute_UID(struct acpi_namespace_node *device_node,
393 struct acpi_pnp_device_id ** return_id);
396 acpi_ut_execute_CID(struct acpi_namespace_node *device_node,
397 struct acpi_pnp_device_id_list ** return_cid_list);
400 acpi_ut_execute_CLS(struct acpi_namespace_node *device_node,
401 struct acpi_pnp_device_id **return_id);
404 * utlock - reader/writer locks
406 acpi_status acpi_ut_create_rw_lock(struct acpi_rw_lock *lock);
408 void acpi_ut_delete_rw_lock(struct acpi_rw_lock *lock);
410 acpi_status acpi_ut_acquire_read_lock(struct acpi_rw_lock *lock);
412 acpi_status acpi_ut_release_read_lock(struct acpi_rw_lock *lock);
414 acpi_status acpi_ut_acquire_write_lock(struct acpi_rw_lock *lock);
416 void acpi_ut_release_write_lock(struct acpi_rw_lock *lock);
419 * utobject - internal object create/delete/cache routines
421 union acpi_operand_object *acpi_ut_create_internal_object_dbg(const char
428 void *acpi_ut_allocate_object_desc_dbg(const char *module_name,
429 u32 line_number, u32 component_id);
431 #define acpi_ut_create_internal_object(t) acpi_ut_create_internal_object_dbg (_acpi_module_name,__LINE__,_COMPONENT,t)
432 #define acpi_ut_allocate_object_desc() acpi_ut_allocate_object_desc_dbg (_acpi_module_name,__LINE__,_COMPONENT)
434 void acpi_ut_delete_object_desc(union acpi_operand_object *object);
436 u8 acpi_ut_valid_internal_object(void *object);
438 union acpi_operand_object *acpi_ut_create_package_object(u32 count);
440 union acpi_operand_object *acpi_ut_create_integer_object(u64 value);
442 union acpi_operand_object *acpi_ut_create_buffer_object(acpi_size buffer_size);
444 union acpi_operand_object *acpi_ut_create_string_object(acpi_size string_size);
447 acpi_ut_get_object_size(union acpi_operand_object *obj, acpi_size *obj_length);
450 * utosi - Support for the _OSI predefined control method
452 acpi_status acpi_ut_initialize_interfaces(void);
454 acpi_status acpi_ut_interface_terminate(void);
456 acpi_status acpi_ut_install_interface(acpi_string interface_name);
458 acpi_status acpi_ut_remove_interface(acpi_string interface_name);
460 acpi_status acpi_ut_update_interfaces(u8 action);
462 struct acpi_interface_info *acpi_ut_get_interface(acpi_string interface_name);
464 acpi_status acpi_ut_osi_implementation(struct acpi_walk_state *walk_state);
467 * utpredef - support for predefined names
469 const union acpi_predefined_info *acpi_ut_get_next_predefined_method(const union
473 const union acpi_predefined_info *acpi_ut_match_predefined_method(char *name);
475 void acpi_ut_get_expected_return_types(char *buffer, u32 expected_btypes);
477 #if (defined ACPI_ASL_COMPILER || defined ACPI_HELP_APP)
478 const union acpi_predefined_info *acpi_ut_match_resource_name(char *name);
481 acpi_ut_display_predefined_method(char *buffer,
482 const union acpi_predefined_info *this_name,
485 u32 acpi_ut_get_resource_bit_width(char *buffer, u16 types);
489 * utstate - Generic state creation/cache routines
492 acpi_ut_push_generic_state(union acpi_generic_state **list_head,
493 union acpi_generic_state *state);
495 union acpi_generic_state *acpi_ut_pop_generic_state(union acpi_generic_state
498 union acpi_generic_state *acpi_ut_create_generic_state(void);
500 struct acpi_thread_state *acpi_ut_create_thread_state(void);
502 union acpi_generic_state *acpi_ut_create_update_state(union acpi_operand_object
503 *object, u16 action);
505 union acpi_generic_state *acpi_ut_create_pkg_state(void *internal_object,
506 void *external_object,
510 acpi_ut_create_update_state_and_push(union acpi_operand_object *object,
512 union acpi_generic_state **state_list);
514 union acpi_generic_state *acpi_ut_create_control_state(void);
516 void acpi_ut_delete_generic_state(union acpi_generic_state *state);
522 acpi_ut_divide(u64 in_dividend,
523 u64 in_divisor, u64 *out_quotient, u64 *out_remainder);
526 acpi_ut_short_divide(u64 in_dividend,
527 u32 divisor, u64 *out_quotient, u32 *out_remainder);
530 acpi_ut_short_multiply(u64 in_multiplicand, u32 multiplier, u64 *outproduct);
532 acpi_status acpi_ut_short_shift_left(u64 operand, u32 count, u64 *out_result);
534 acpi_status acpi_ut_short_shift_right(u64 operand, u32 count, u64 *out_result);
539 const struct acpi_exception_info *acpi_ut_validate_exception(acpi_status
542 u8 acpi_ut_is_pci_root_bridge(char *id);
544 #if (defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP || defined ACPI_NAMES_APP)
545 u8 acpi_ut_is_aml_table(struct acpi_table_header *table);
549 acpi_ut_walk_package_tree(union acpi_operand_object *source_object,
551 acpi_pkg_callback walk_callback, void *context);
553 /* Values for Base above (16=Hex, 10=Decimal) */
555 #define ACPI_ANY_BASE 0
557 u32 acpi_ut_dword_byte_swap(u32 value);
559 void acpi_ut_set_integer_width(u8 revision);
561 #ifdef ACPI_DEBUG_OUTPUT
563 acpi_ut_display_init_pathname(u8 type,
564 struct acpi_namespace_node *obj_handle,
569 * utownerid - Support for Table/Method Owner IDs
571 acpi_status acpi_ut_allocate_owner_id(acpi_owner_id *owner_id);
573 void acpi_ut_release_owner_id(acpi_owner_id *owner_id);
579 acpi_ut_walk_aml_resources(struct acpi_walk_state *walk_state,
581 acpi_size aml_length,
582 acpi_walk_aml_callback user_function,
586 acpi_ut_validate_resource(struct acpi_walk_state *walk_state,
587 void *aml, u8 *return_index);
589 u32 acpi_ut_get_descriptor_length(void *aml);
591 u16 acpi_ut_get_resource_length(void *aml);
593 u8 acpi_ut_get_resource_header_length(void *aml);
595 u8 acpi_ut_get_resource_type(void *aml);
598 acpi_ut_get_resource_end_tag(union acpi_operand_object *obj_desc, u8 **end_tag);
601 * utstring - String and character utilities
603 void acpi_ut_print_string(char *string, u16 max_length);
605 #if defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP
606 void ut_convert_backslashes(char *pathname);
609 void acpi_ut_repair_name(char *name);
611 #if defined (ACPI_DEBUGGER) || defined (ACPI_APPLICATION) || defined (ACPI_DEBUG_OUTPUT)
612 u8 acpi_ut_safe_strcpy(char *dest, acpi_size dest_size, char *source);
614 void acpi_ut_safe_strncpy(char *dest, char *source, acpi_size dest_size);
616 u8 acpi_ut_safe_strcat(char *dest, acpi_size dest_size, char *source);
619 acpi_ut_safe_strncat(char *dest,
621 char *source, acpi_size max_transfer_length);
625 * utmutex - mutex support
627 acpi_status acpi_ut_mutex_initialize(void);
629 void acpi_ut_mutex_terminate(void);
631 acpi_status acpi_ut_acquire_mutex(acpi_mutex_handle mutex_id);
633 acpi_status acpi_ut_release_mutex(acpi_mutex_handle mutex_id);
636 * utalloc - memory allocation and object caching
638 acpi_status acpi_ut_create_caches(void);
640 acpi_status acpi_ut_delete_caches(void);
642 acpi_status acpi_ut_validate_buffer(struct acpi_buffer *buffer);
645 acpi_ut_initialize_buffer(struct acpi_buffer *buffer,
646 acpi_size required_length);
648 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
649 void *acpi_ut_allocate_and_track(acpi_size size,
650 u32 component, const char *module, u32 line);
652 void *acpi_ut_allocate_zeroed_and_track(acpi_size size,
654 const char *module, u32 line);
657 acpi_ut_free_and_track(void *address,
658 u32 component, const char *module, u32 line);
660 void acpi_ut_dump_allocation_info(void);
662 void acpi_ut_dump_allocations(u32 component, const char *module);
665 acpi_ut_create_list(const char *list_name,
666 u16 object_size, struct acpi_memory_list **return_cache);
668 #endif /* ACPI_DBG_TRACK_ALLOCATIONS */
671 * utaddress - address range check
674 acpi_ut_add_address_range(acpi_adr_space_type space_id,
675 acpi_physical_address address,
676 u32 length, struct acpi_namespace_node *region_node);
679 acpi_ut_remove_address_range(acpi_adr_space_type space_id,
680 struct acpi_namespace_node *region_node);
683 acpi_ut_check_address_range(acpi_adr_space_type space_id,
684 acpi_physical_address address, u32 length, u8 warn);
686 void acpi_ut_delete_address_lists(void);
689 * utxferror - various error/warning output functions
692 void ACPI_INTERNAL_VAR_XFACE
693 acpi_ut_predefined_warning(const char *module_name,
696 u16 node_flags, const char *format, ...);
699 void ACPI_INTERNAL_VAR_XFACE
700 acpi_ut_predefined_info(const char *module_name,
703 u16 node_flags, const char *format, ...);
706 void ACPI_INTERNAL_VAR_XFACE
707 acpi_ut_predefined_bios_error(const char *module_name,
710 u16 node_flags, const char *format, ...);
713 acpi_ut_prefixed_namespace_error(const char *module_name,
715 union acpi_generic_state *prefix_scope,
716 const char *internal_name,
717 acpi_status lookup_status);
720 acpi_ut_method_error(const char *module_name,
723 struct acpi_namespace_node *node,
724 const char *path, acpi_status lookup_status);
727 * Utility functions for ACPI names and IDs
729 const struct ah_predefined_name *acpi_ah_match_predefined_name(char *nameseg);
731 const struct ah_device_id *acpi_ah_match_hardware_id(char *hid);
733 const char *acpi_ah_match_uuid(u8 *data);
736 * utuuid -- UUID support functions
738 #if (defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP || defined ACPI_HELP_APP)
739 void acpi_ut_convert_string_to_uuid(char *in_string, u8 *uuid_buffer);
741 acpi_status acpi_ut_convert_uuid_to_string(char *uuid_buffer, char *out_string);
744 #endif /* _ACUTILS_H */