Loading...
1/* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */
2/******************************************************************************
3 *
4 * Name: acutils.h -- prototypes for the common (subsystem-wide) procedures
5 *
6 * Copyright (C) 2000 - 2023, Intel Corp.
7 *
8 *****************************************************************************/
9
10#ifndef _ACUTILS_H
11#define _ACUTILS_H
12
13extern const u8 acpi_gbl_resource_aml_sizes[];
14extern const u8 acpi_gbl_resource_aml_serial_bus_sizes[];
15
16/* Strings used by the disassembler and debugger resource dump routines */
17
18#if defined(ACPI_DEBUG_OUTPUT) || defined (ACPI_DISASSEMBLER) || defined (ACPI_DEBUGGER)
19
20extern const char *acpi_gbl_bm_decode[];
21extern const char *acpi_gbl_config_decode[];
22extern const char *acpi_gbl_consume_decode[];
23extern const char *acpi_gbl_dec_decode[];
24extern const char *acpi_gbl_he_decode[];
25extern const char *acpi_gbl_io_decode[];
26extern const char *acpi_gbl_ll_decode[];
27extern const char *acpi_gbl_max_decode[];
28extern const char *acpi_gbl_mem_decode[];
29extern const char *acpi_gbl_min_decode[];
30extern const char *acpi_gbl_mtp_decode[];
31extern const char *acpi_gbl_phy_decode[];
32extern const char *acpi_gbl_rng_decode[];
33extern const char *acpi_gbl_rw_decode[];
34extern const char *acpi_gbl_shr_decode[];
35extern const char *acpi_gbl_siz_decode[];
36extern const char *acpi_gbl_trs_decode[];
37extern const char *acpi_gbl_ttp_decode[];
38extern const char *acpi_gbl_typ_decode[];
39extern const char *acpi_gbl_ppc_decode[];
40extern const char *acpi_gbl_ior_decode[];
41extern const char *acpi_gbl_dts_decode[];
42extern const char *acpi_gbl_ct_decode[];
43extern const char *acpi_gbl_sbt_decode[];
44extern const char *acpi_gbl_am_decode[];
45extern const char *acpi_gbl_sm_decode[];
46extern const char *acpi_gbl_wm_decode[];
47extern const char *acpi_gbl_cph_decode[];
48extern const char *acpi_gbl_cpo_decode[];
49extern const char *acpi_gbl_dp_decode[];
50extern const char *acpi_gbl_ed_decode[];
51extern const char *acpi_gbl_bpb_decode[];
52extern const char *acpi_gbl_sb_decode[];
53extern const char *acpi_gbl_fc_decode[];
54extern const char *acpi_gbl_pt_decode[];
55extern const char *acpi_gbl_ptyp_decode[];
56extern const char *acpi_gbl_clock_input_mode[];
57extern const char *acpi_gbl_clock_input_scale[];
58#endif
59
60/*
61 * For the iASL compiler case, the output is redirected to stderr so that
62 * any of the various ACPI errors and warnings do not appear in the output
63 * files, for either the compiler or disassembler portions of the tool.
64 */
65#ifdef ACPI_ASL_COMPILER
66
67#include <stdio.h>
68
69#define ACPI_MSG_REDIRECT_BEGIN \
70 FILE *output_file = acpi_gbl_output_file; \
71 acpi_os_redirect_output (stderr);
72
73#define ACPI_MSG_REDIRECT_END \
74 acpi_os_redirect_output (output_file);
75
76#else
77/*
78 * non-iASL case - no redirection, nothing to do
79 */
80#define ACPI_MSG_REDIRECT_BEGIN
81#define ACPI_MSG_REDIRECT_END
82#endif
83
84/*
85 * Common error message prefixes
86 */
87#ifndef ACPI_MSG_ERROR
88#define ACPI_MSG_ERROR "ACPI Error: "
89#endif
90#ifndef ACPI_MSG_WARNING
91#define ACPI_MSG_WARNING "ACPI Warning: "
92#endif
93#ifndef ACPI_MSG_INFO
94#define ACPI_MSG_INFO "ACPI: "
95#endif
96
97#ifndef ACPI_MSG_BIOS_ERROR
98#define ACPI_MSG_BIOS_ERROR "Firmware Error (ACPI): "
99#endif
100#ifndef ACPI_MSG_BIOS_WARNING
101#define ACPI_MSG_BIOS_WARNING "Firmware Warning (ACPI): "
102#endif
103
104/*
105 * Common message suffix
106 */
107#define ACPI_MSG_SUFFIX \
108 acpi_os_printf (" (%8.8X/%s-%u)\n", ACPI_CA_VERSION, module_name, line_number)
109
110/* Flags to indicate implicit or explicit string-to-integer conversion */
111
112#define ACPI_IMPLICIT_CONVERSION TRUE
113#define ACPI_NO_IMPLICIT_CONVERSION FALSE
114
115/* Types for Resource descriptor entries */
116
117#define ACPI_INVALID_RESOURCE 0
118#define ACPI_FIXED_LENGTH 1
119#define ACPI_VARIABLE_LENGTH 2
120#define ACPI_SMALL_VARIABLE_LENGTH 3
121
122typedef
123acpi_status (*acpi_walk_aml_callback) (u8 *aml,
124 u32 length,
125 u32 offset,
126 u8 resource_index, void **context);
127
128typedef
129acpi_status (*acpi_pkg_callback) (u8 object_type,
130 union acpi_operand_object * source_object,
131 union acpi_generic_state * state,
132 void *context);
133
134struct acpi_pkg_info {
135 u8 *free_space;
136 acpi_size length;
137 u32 object_space;
138 u32 num_packages;
139};
140
141/* Object reference counts */
142
143#define REF_INCREMENT (u16) 0
144#define REF_DECREMENT (u16) 1
145
146/* acpi_ut_dump_buffer */
147
148#define DB_BYTE_DISPLAY 0x01
149#define DB_WORD_DISPLAY 0x02
150#define DB_DWORD_DISPLAY 0x04
151#define DB_QWORD_DISPLAY 0x08
152#define DB_DISPLAY_DATA_ONLY 0x10
153
154/*
155 * utascii - ASCII utilities
156 */
157u8 acpi_ut_valid_nameseg(char *signature);
158
159u8 acpi_ut_valid_name_char(char character, u32 position);
160
161void acpi_ut_check_and_repair_ascii(u8 *name, char *repaired_name, u32 count);
162
163/*
164 * utcksum - Checksum utilities
165 */
166u8 acpi_ut_generate_checksum(void *table, u32 length, u8 original_checksum);
167
168u8 acpi_ut_checksum(u8 *buffer, u32 length);
169
170acpi_status
171acpi_ut_verify_cdat_checksum(struct acpi_table_cdat *cdat_table, u32 length);
172
173acpi_status
174acpi_ut_verify_checksum(struct acpi_table_header *table, u32 length);
175
176/*
177 * utnonansi - Non-ANSI C library functions
178 */
179void acpi_ut_strupr(char *src_string);
180
181void acpi_ut_strlwr(char *src_string);
182
183int acpi_ut_stricmp(char *string1, char *string2);
184
185/*
186 * utstrsuppt - string-to-integer conversion support functions
187 */
188acpi_status acpi_ut_convert_octal_string(char *string, u64 *return_value);
189
190acpi_status acpi_ut_convert_decimal_string(char *string, u64 *return_value_ptr);
191
192acpi_status acpi_ut_convert_hex_string(char *string, u64 *return_value_ptr);
193
194char acpi_ut_remove_whitespace(char **string);
195
196char acpi_ut_remove_leading_zeros(char **string);
197
198u8 acpi_ut_detect_hex_prefix(char **string);
199
200void acpi_ut_remove_hex_prefix(char **string);
201
202u8 acpi_ut_detect_octal_prefix(char **string);
203
204/*
205 * utstrtoul64 - string-to-integer conversion functions
206 */
207acpi_status acpi_ut_strtoul64(char *string, u64 *ret_integer);
208
209u64 acpi_ut_explicit_strtoul64(char *string);
210
211u64 acpi_ut_implicit_strtoul64(char *string);
212
213/*
214 * utglobal - Global data structures and procedures
215 */
216acpi_status acpi_ut_init_globals(void);
217
218const char *acpi_ut_get_mutex_name(u32 mutex_id);
219
220#if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
221
222const char *acpi_ut_get_notify_name(u32 notify_value, acpi_object_type type);
223#endif
224
225const char *acpi_ut_get_type_name(acpi_object_type type);
226
227const char *acpi_ut_get_node_name(void *object);
228
229const char *acpi_ut_get_descriptor_name(void *object);
230
231const char *acpi_ut_get_reference_name(union acpi_operand_object *object);
232
233const char *acpi_ut_get_object_type_name(union acpi_operand_object *obj_desc);
234
235const char *acpi_ut_get_region_name(u8 space_id);
236
237const char *acpi_ut_get_event_name(u32 event_id);
238
239const char *acpi_ut_get_argument_type_name(u32 arg_type);
240
241char acpi_ut_hex_to_ascii_char(u64 integer, u32 position);
242
243acpi_status acpi_ut_ascii_to_hex_byte(char *two_ascii_chars, u8 *return_byte);
244
245u8 acpi_ut_ascii_char_to_hex(int hex_char);
246
247u8 acpi_ut_valid_object_type(acpi_object_type type);
248
249/*
250 * utinit - miscellaneous initialization and shutdown
251 */
252acpi_status acpi_ut_hardware_initialize(void);
253
254void acpi_ut_subsystem_shutdown(void);
255
256/*
257 * utcopy - Object construction and conversion interfaces
258 */
259acpi_status
260acpi_ut_build_simple_object(union acpi_operand_object *obj,
261 union acpi_object *user_obj,
262 u8 *data_space, u32 *buffer_space_used);
263
264acpi_status
265acpi_ut_build_package_object(union acpi_operand_object *obj,
266 u8 *buffer, u32 *space_used);
267
268acpi_status
269acpi_ut_copy_iobject_to_eobject(union acpi_operand_object *obj,
270 struct acpi_buffer *ret_buffer);
271
272acpi_status
273acpi_ut_copy_eobject_to_iobject(union acpi_object *obj,
274 union acpi_operand_object **internal_obj);
275
276acpi_status
277acpi_ut_copy_isimple_to_isimple(union acpi_operand_object *source_obj,
278 union acpi_operand_object *dest_obj);
279
280acpi_status
281acpi_ut_copy_iobject_to_iobject(union acpi_operand_object *source_desc,
282 union acpi_operand_object **dest_desc,
283 struct acpi_walk_state *walk_state);
284
285/*
286 * utcreate - Object creation
287 */
288acpi_status
289acpi_ut_update_object_reference(union acpi_operand_object *object, u16 action);
290
291/*
292 * utdebug - Debug interfaces
293 */
294void acpi_ut_init_stack_ptr_trace(void);
295
296void acpi_ut_track_stack_ptr(void);
297
298void
299acpi_ut_trace(u32 line_number,
300 const char *function_name,
301 const char *module_name, u32 component_id);
302
303void
304acpi_ut_trace_ptr(u32 line_number,
305 const char *function_name,
306 const char *module_name,
307 u32 component_id, const void *pointer);
308
309void
310acpi_ut_trace_u32(u32 line_number,
311 const char *function_name,
312 const char *module_name, u32 component_id, u32 integer);
313
314void
315acpi_ut_trace_str(u32 line_number,
316 const char *function_name,
317 const char *module_name,
318 u32 component_id, const char *string);
319
320void
321acpi_ut_exit(u32 line_number,
322 const char *function_name,
323 const char *module_name, u32 component_id);
324
325void
326acpi_ut_status_exit(u32 line_number,
327 const char *function_name,
328 const char *module_name,
329 u32 component_id, acpi_status status);
330
331void
332acpi_ut_value_exit(u32 line_number,
333 const char *function_name,
334 const char *module_name, u32 component_id, u64 value);
335
336void
337acpi_ut_ptr_exit(u32 line_number,
338 const char *function_name,
339 const char *module_name, u32 component_id, u8 *ptr);
340
341void
342acpi_ut_str_exit(u32 line_number,
343 const char *function_name,
344 const char *module_name, u32 component_id, const char *string);
345
346void
347acpi_ut_debug_dump_buffer(u8 *buffer, u32 count, u32 display, u32 component_id);
348
349void acpi_ut_dump_buffer(u8 *buffer, u32 count, u32 display, u32 offset);
350
351#ifdef ACPI_APPLICATION
352void
353acpi_ut_dump_buffer_to_file(ACPI_FILE file,
354 u8 *buffer,
355 u32 count, u32 display, u32 base_offset);
356#endif
357
358void acpi_ut_report_error(char *module_name, u32 line_number);
359
360void acpi_ut_report_info(char *module_name, u32 line_number);
361
362void acpi_ut_report_warning(char *module_name, u32 line_number);
363
364/*
365 * utdelete - Object deletion and reference counts
366 */
367void acpi_ut_add_reference(union acpi_operand_object *object);
368
369void acpi_ut_remove_reference(union acpi_operand_object *object);
370
371void acpi_ut_delete_internal_package_object(union acpi_operand_object *object);
372
373void acpi_ut_delete_internal_simple_object(union acpi_operand_object *object);
374
375void acpi_ut_delete_internal_object_list(union acpi_operand_object **obj_list);
376
377/*
378 * uteval - object evaluation
379 */
380acpi_status
381acpi_ut_evaluate_object(struct acpi_namespace_node *prefix_node,
382 const char *path,
383 u32 expected_return_btypes,
384 union acpi_operand_object **return_desc);
385
386acpi_status
387acpi_ut_evaluate_numeric_object(const char *object_name,
388 struct acpi_namespace_node *device_node,
389 u64 *value);
390
391acpi_status
392acpi_ut_execute_STA(struct acpi_namespace_node *device_node, u32 *status_flags);
393
394acpi_status
395acpi_ut_execute_power_methods(struct acpi_namespace_node *device_node,
396 const char **method_names,
397 u8 method_count, u8 *out_values);
398
399/*
400 * utids - device ID support
401 */
402acpi_status
403acpi_ut_execute_HID(struct acpi_namespace_node *device_node,
404 struct acpi_pnp_device_id ** return_id);
405
406acpi_status
407acpi_ut_execute_UID(struct acpi_namespace_node *device_node,
408 struct acpi_pnp_device_id ** return_id);
409
410acpi_status
411acpi_ut_execute_CID(struct acpi_namespace_node *device_node,
412 struct acpi_pnp_device_id_list ** return_cid_list);
413
414acpi_status
415acpi_ut_execute_CLS(struct acpi_namespace_node *device_node,
416 struct acpi_pnp_device_id **return_id);
417
418/*
419 * utlock - reader/writer locks
420 */
421acpi_status acpi_ut_create_rw_lock(struct acpi_rw_lock *lock);
422
423void acpi_ut_delete_rw_lock(struct acpi_rw_lock *lock);
424
425acpi_status acpi_ut_acquire_read_lock(struct acpi_rw_lock *lock);
426
427acpi_status acpi_ut_release_read_lock(struct acpi_rw_lock *lock);
428
429acpi_status acpi_ut_acquire_write_lock(struct acpi_rw_lock *lock);
430
431void acpi_ut_release_write_lock(struct acpi_rw_lock *lock);
432
433/*
434 * utobject - internal object create/delete/cache routines
435 */
436union acpi_operand_object *acpi_ut_create_internal_object_dbg(const char
437 *module_name,
438 u32 line_number,
439 u32 component_id,
440 acpi_object_type
441 type);
442
443void *acpi_ut_allocate_object_desc_dbg(const char *module_name,
444 u32 line_number, u32 component_id);
445
446#define acpi_ut_create_internal_object(t) acpi_ut_create_internal_object_dbg (_acpi_module_name,__LINE__,_COMPONENT,t)
447#define acpi_ut_allocate_object_desc() acpi_ut_allocate_object_desc_dbg (_acpi_module_name,__LINE__,_COMPONENT)
448
449void acpi_ut_delete_object_desc(union acpi_operand_object *object);
450
451u8 acpi_ut_valid_internal_object(void *object);
452
453union acpi_operand_object *acpi_ut_create_package_object(u32 count);
454
455union acpi_operand_object *acpi_ut_create_integer_object(u64 value);
456
457union acpi_operand_object *acpi_ut_create_buffer_object(acpi_size buffer_size);
458
459union acpi_operand_object *acpi_ut_create_string_object(acpi_size string_size);
460
461acpi_status
462acpi_ut_get_object_size(union acpi_operand_object *obj, acpi_size *obj_length);
463
464/*
465 * utosi - Support for the _OSI predefined control method
466 */
467acpi_status acpi_ut_initialize_interfaces(void);
468
469acpi_status acpi_ut_interface_terminate(void);
470
471acpi_status acpi_ut_install_interface(acpi_string interface_name);
472
473acpi_status acpi_ut_remove_interface(acpi_string interface_name);
474
475acpi_status acpi_ut_update_interfaces(u8 action);
476
477struct acpi_interface_info *acpi_ut_get_interface(acpi_string interface_name);
478
479acpi_status acpi_ut_osi_implementation(struct acpi_walk_state *walk_state);
480
481/*
482 * utpredef - support for predefined names
483 */
484const union acpi_predefined_info *acpi_ut_get_next_predefined_method(const union
485 acpi_predefined_info
486 *this_name);
487
488const union acpi_predefined_info *acpi_ut_match_predefined_method(char *name);
489
490void acpi_ut_get_expected_return_types(char *buffer, u32 expected_btypes);
491
492#if (defined ACPI_ASL_COMPILER || defined ACPI_HELP_APP)
493const union acpi_predefined_info *acpi_ut_match_resource_name(char *name);
494
495void
496acpi_ut_display_predefined_method(char *buffer,
497 const union acpi_predefined_info *this_name,
498 u8 multi_line);
499
500u32 acpi_ut_get_resource_bit_width(char *buffer, u16 types);
501#endif
502
503/*
504 * utstate - Generic state creation/cache routines
505 */
506void
507acpi_ut_push_generic_state(union acpi_generic_state **list_head,
508 union acpi_generic_state *state);
509
510union acpi_generic_state *acpi_ut_pop_generic_state(union acpi_generic_state
511 **list_head);
512
513union acpi_generic_state *acpi_ut_create_generic_state(void);
514
515struct acpi_thread_state *acpi_ut_create_thread_state(void);
516
517union acpi_generic_state *acpi_ut_create_update_state(union acpi_operand_object
518 *object, u16 action);
519
520union acpi_generic_state *acpi_ut_create_pkg_state(void *internal_object,
521 void *external_object,
522 u32 index);
523
524acpi_status
525acpi_ut_create_update_state_and_push(union acpi_operand_object *object,
526 u16 action,
527 union acpi_generic_state **state_list);
528
529union acpi_generic_state *acpi_ut_create_control_state(void);
530
531void acpi_ut_delete_generic_state(union acpi_generic_state *state);
532
533/*
534 * utmath
535 */
536acpi_status
537acpi_ut_divide(u64 in_dividend,
538 u64 in_divisor, u64 *out_quotient, u64 *out_remainder);
539
540acpi_status
541acpi_ut_short_divide(u64 in_dividend,
542 u32 divisor, u64 *out_quotient, u32 *out_remainder);
543
544acpi_status
545acpi_ut_short_multiply(u64 in_multiplicand, u32 multiplier, u64 *outproduct);
546
547acpi_status acpi_ut_short_shift_left(u64 operand, u32 count, u64 *out_result);
548
549acpi_status acpi_ut_short_shift_right(u64 operand, u32 count, u64 *out_result);
550
551/*
552 * utmisc
553 */
554const struct acpi_exception_info *acpi_ut_validate_exception(acpi_status
555 status);
556
557u8 acpi_ut_is_pci_root_bridge(char *id);
558
559#if (defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP || defined ACPI_NAMES_APP)
560u8 acpi_ut_is_aml_table(struct acpi_table_header *table);
561#endif
562
563acpi_status
564acpi_ut_walk_package_tree(union acpi_operand_object *source_object,
565 void *target_object,
566 acpi_pkg_callback walk_callback, void *context);
567
568/* Values for Base above (16=Hex, 10=Decimal) */
569
570#define ACPI_ANY_BASE 0
571
572u32 acpi_ut_dword_byte_swap(u32 value);
573
574void acpi_ut_set_integer_width(u8 revision);
575
576#ifdef ACPI_DEBUG_OUTPUT
577void
578acpi_ut_display_init_pathname(u8 type,
579 struct acpi_namespace_node *obj_handle,
580 const char *path);
581#endif
582
583/*
584 * utownerid - Support for Table/Method Owner IDs
585 */
586acpi_status acpi_ut_allocate_owner_id(acpi_owner_id *owner_id);
587
588void acpi_ut_release_owner_id(acpi_owner_id *owner_id);
589
590/*
591 * utresrc
592 */
593acpi_status
594acpi_ut_walk_aml_resources(struct acpi_walk_state *walk_state,
595 u8 *aml,
596 acpi_size aml_length,
597 acpi_walk_aml_callback user_function,
598 void **context);
599
600acpi_status
601acpi_ut_validate_resource(struct acpi_walk_state *walk_state,
602 void *aml, u8 *return_index);
603
604u32 acpi_ut_get_descriptor_length(void *aml);
605
606u16 acpi_ut_get_resource_length(void *aml);
607
608u8 acpi_ut_get_resource_header_length(void *aml);
609
610u8 acpi_ut_get_resource_type(void *aml);
611
612acpi_status
613acpi_ut_get_resource_end_tag(union acpi_operand_object *obj_desc, u8 **end_tag);
614
615/*
616 * utstring - String and character utilities
617 */
618void acpi_ut_print_string(char *string, u16 max_length);
619
620#if defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP
621void ut_convert_backslashes(char *pathname);
622#endif
623
624void acpi_ut_repair_name(char *name);
625
626#if defined (ACPI_DEBUGGER) || defined (ACPI_APPLICATION) || defined (ACPI_DEBUG_OUTPUT)
627u8 acpi_ut_safe_strcpy(char *dest, acpi_size dest_size, char *source);
628
629void acpi_ut_safe_strncpy(char *dest, char *source, acpi_size dest_size);
630
631u8 acpi_ut_safe_strcat(char *dest, acpi_size dest_size, char *source);
632
633u8
634acpi_ut_safe_strncat(char *dest,
635 acpi_size dest_size,
636 char *source, acpi_size max_transfer_length);
637#endif
638
639/*
640 * utmutex - mutex support
641 */
642acpi_status acpi_ut_mutex_initialize(void);
643
644void acpi_ut_mutex_terminate(void);
645
646acpi_status acpi_ut_acquire_mutex(acpi_mutex_handle mutex_id);
647
648acpi_status acpi_ut_release_mutex(acpi_mutex_handle mutex_id);
649
650/*
651 * utalloc - memory allocation and object caching
652 */
653acpi_status acpi_ut_create_caches(void);
654
655acpi_status acpi_ut_delete_caches(void);
656
657acpi_status acpi_ut_validate_buffer(struct acpi_buffer *buffer);
658
659acpi_status
660acpi_ut_initialize_buffer(struct acpi_buffer *buffer,
661 acpi_size required_length);
662
663#ifdef ACPI_DBG_TRACK_ALLOCATIONS
664void *acpi_ut_allocate_and_track(acpi_size size,
665 u32 component, const char *module, u32 line);
666
667void *acpi_ut_allocate_zeroed_and_track(acpi_size size,
668 u32 component,
669 const char *module, u32 line);
670
671void
672acpi_ut_free_and_track(void *address,
673 u32 component, const char *module, u32 line);
674
675void acpi_ut_dump_allocation_info(void);
676
677void acpi_ut_dump_allocations(u32 component, const char *module);
678
679acpi_status
680acpi_ut_create_list(const char *list_name,
681 u16 object_size, struct acpi_memory_list **return_cache);
682
683#endif /* ACPI_DBG_TRACK_ALLOCATIONS */
684
685/*
686 * utaddress - address range check
687 */
688acpi_status
689acpi_ut_add_address_range(acpi_adr_space_type space_id,
690 acpi_physical_address address,
691 u32 length, struct acpi_namespace_node *region_node);
692
693void
694acpi_ut_remove_address_range(acpi_adr_space_type space_id,
695 struct acpi_namespace_node *region_node);
696
697u32
698acpi_ut_check_address_range(acpi_adr_space_type space_id,
699 acpi_physical_address address, u32 length, u8 warn);
700
701void acpi_ut_delete_address_lists(void);
702
703/*
704 * utxferror - various error/warning output functions
705 */
706ACPI_PRINTF_LIKE(5)
707void ACPI_INTERNAL_VAR_XFACE
708acpi_ut_predefined_warning(const char *module_name,
709 u32 line_number,
710 char *pathname,
711 u16 node_flags, const char *format, ...);
712
713ACPI_PRINTF_LIKE(5)
714void ACPI_INTERNAL_VAR_XFACE
715acpi_ut_predefined_info(const char *module_name,
716 u32 line_number,
717 char *pathname,
718 u16 node_flags, const char *format, ...);
719
720ACPI_PRINTF_LIKE(5)
721void ACPI_INTERNAL_VAR_XFACE
722acpi_ut_predefined_bios_error(const char *module_name,
723 u32 line_number,
724 char *pathname,
725 u16 node_flags, const char *format, ...);
726
727void
728acpi_ut_prefixed_namespace_error(const char *module_name,
729 u32 line_number,
730 union acpi_generic_state *prefix_scope,
731 const char *internal_name,
732 acpi_status lookup_status);
733
734void
735acpi_ut_method_error(const char *module_name,
736 u32 line_number,
737 const char *message,
738 struct acpi_namespace_node *node,
739 const char *path, acpi_status lookup_status);
740
741/*
742 * Utility functions for ACPI names and IDs
743 */
744const struct ah_predefined_name *acpi_ah_match_predefined_name(char *nameseg);
745
746const struct ah_device_id *acpi_ah_match_hardware_id(char *hid);
747
748const char *acpi_ah_match_uuid(u8 *data);
749
750/*
751 * utuuid -- UUID support functions
752 */
753#if (defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP || defined ACPI_HELP_APP)
754void acpi_ut_convert_string_to_uuid(char *in_string, u8 *uuid_buffer);
755
756acpi_status acpi_ut_convert_uuid_to_string(char *uuid_buffer, char *out_string);
757#endif
758
759#endif /* _ACUTILS_H */
1/* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */
2/******************************************************************************
3 *
4 * Name: acutils.h -- prototypes for the common (subsystem-wide) procedures
5 *
6 * Copyright (C) 2000 - 2018, Intel Corp.
7 *
8 *****************************************************************************/
9
10#ifndef _ACUTILS_H
11#define _ACUTILS_H
12
13extern const u8 acpi_gbl_resource_aml_sizes[];
14extern const u8 acpi_gbl_resource_aml_serial_bus_sizes[];
15
16/* Strings used by the disassembler and debugger resource dump routines */
17
18#if defined(ACPI_DEBUG_OUTPUT) || defined (ACPI_DISASSEMBLER) || defined (ACPI_DEBUGGER)
19
20extern const char *acpi_gbl_bm_decode[];
21extern const char *acpi_gbl_config_decode[];
22extern const char *acpi_gbl_consume_decode[];
23extern const char *acpi_gbl_dec_decode[];
24extern const char *acpi_gbl_he_decode[];
25extern const char *acpi_gbl_io_decode[];
26extern const char *acpi_gbl_ll_decode[];
27extern const char *acpi_gbl_max_decode[];
28extern const char *acpi_gbl_mem_decode[];
29extern const char *acpi_gbl_min_decode[];
30extern const char *acpi_gbl_mtp_decode[];
31extern const char *acpi_gbl_rng_decode[];
32extern const char *acpi_gbl_rw_decode[];
33extern const char *acpi_gbl_shr_decode[];
34extern const char *acpi_gbl_siz_decode[];
35extern const char *acpi_gbl_trs_decode[];
36extern const char *acpi_gbl_ttp_decode[];
37extern const char *acpi_gbl_typ_decode[];
38extern const char *acpi_gbl_ppc_decode[];
39extern const char *acpi_gbl_ior_decode[];
40extern const char *acpi_gbl_dts_decode[];
41extern const char *acpi_gbl_ct_decode[];
42extern const char *acpi_gbl_sbt_decode[];
43extern const char *acpi_gbl_am_decode[];
44extern const char *acpi_gbl_sm_decode[];
45extern const char *acpi_gbl_wm_decode[];
46extern const char *acpi_gbl_cph_decode[];
47extern const char *acpi_gbl_cpo_decode[];
48extern const char *acpi_gbl_dp_decode[];
49extern const char *acpi_gbl_ed_decode[];
50extern const char *acpi_gbl_bpb_decode[];
51extern const char *acpi_gbl_sb_decode[];
52extern const char *acpi_gbl_fc_decode[];
53extern const char *acpi_gbl_pt_decode[];
54extern const char *acpi_gbl_ptyp_decode[];
55#endif
56
57/*
58 * For the iASL compiler case, the output is redirected to stderr so that
59 * any of the various ACPI errors and warnings do not appear in the output
60 * files, for either the compiler or disassembler portions of the tool.
61 */
62#ifdef ACPI_ASL_COMPILER
63
64#include <stdio.h>
65
66#define ACPI_MSG_REDIRECT_BEGIN \
67 FILE *output_file = acpi_gbl_output_file; \
68 acpi_os_redirect_output (stderr);
69
70#define ACPI_MSG_REDIRECT_END \
71 acpi_os_redirect_output (output_file);
72
73#else
74/*
75 * non-iASL case - no redirection, nothing to do
76 */
77#define ACPI_MSG_REDIRECT_BEGIN
78#define ACPI_MSG_REDIRECT_END
79#endif
80
81/*
82 * Common error message prefixes
83 */
84#ifndef ACPI_MSG_ERROR
85#define ACPI_MSG_ERROR "ACPI Error: "
86#endif
87#ifndef ACPI_MSG_WARNING
88#define ACPI_MSG_WARNING "ACPI Warning: "
89#endif
90#ifndef ACPI_MSG_INFO
91#define ACPI_MSG_INFO "ACPI: "
92#endif
93
94#ifndef ACPI_MSG_BIOS_ERROR
95#define ACPI_MSG_BIOS_ERROR "Firmware Error (ACPI): "
96#endif
97#ifndef ACPI_MSG_BIOS_WARNING
98#define ACPI_MSG_BIOS_WARNING "Firmware Warning (ACPI): "
99#endif
100
101/*
102 * Common message suffix
103 */
104#define ACPI_MSG_SUFFIX \
105 acpi_os_printf (" (%8.8X/%s-%u)\n", ACPI_CA_VERSION, module_name, line_number)
106
107/* Flags to indicate implicit or explicit string-to-integer conversion */
108
109#define ACPI_IMPLICIT_CONVERSION TRUE
110#define ACPI_NO_IMPLICIT_CONVERSION FALSE
111
112/* Types for Resource descriptor entries */
113
114#define ACPI_INVALID_RESOURCE 0
115#define ACPI_FIXED_LENGTH 1
116#define ACPI_VARIABLE_LENGTH 2
117#define ACPI_SMALL_VARIABLE_LENGTH 3
118
119typedef
120acpi_status (*acpi_walk_aml_callback) (u8 *aml,
121 u32 length,
122 u32 offset,
123 u8 resource_index, void **context);
124
125typedef
126acpi_status (*acpi_pkg_callback) (u8 object_type,
127 union acpi_operand_object * source_object,
128 union acpi_generic_state * state,
129 void *context);
130
131struct acpi_pkg_info {
132 u8 *free_space;
133 acpi_size length;
134 u32 object_space;
135 u32 num_packages;
136};
137
138/* Object reference counts */
139
140#define REF_INCREMENT (u16) 0
141#define REF_DECREMENT (u16) 1
142
143/* acpi_ut_dump_buffer */
144
145#define DB_BYTE_DISPLAY 1
146#define DB_WORD_DISPLAY 2
147#define DB_DWORD_DISPLAY 4
148#define DB_QWORD_DISPLAY 8
149
150/*
151 * utascii - ASCII utilities
152 */
153u8 acpi_ut_valid_nameseg(char *signature);
154
155u8 acpi_ut_valid_name_char(char character, u32 position);
156
157void acpi_ut_check_and_repair_ascii(u8 *name, char *repaired_name, u32 count);
158
159/*
160 * utnonansi - Non-ANSI C library functions
161 */
162void acpi_ut_strupr(char *src_string);
163
164void acpi_ut_strlwr(char *src_string);
165
166int acpi_ut_stricmp(char *string1, char *string2);
167
168/*
169 * utstrsuppt - string-to-integer conversion support functions
170 */
171acpi_status acpi_ut_convert_octal_string(char *string, u64 *return_value);
172
173acpi_status acpi_ut_convert_decimal_string(char *string, u64 *return_value_ptr);
174
175acpi_status acpi_ut_convert_hex_string(char *string, u64 *return_value_ptr);
176
177char acpi_ut_remove_whitespace(char **string);
178
179char acpi_ut_remove_leading_zeros(char **string);
180
181u8 acpi_ut_detect_hex_prefix(char **string);
182
183u8 acpi_ut_detect_octal_prefix(char **string);
184
185/*
186 * utstrtoul64 - string-to-integer conversion functions
187 */
188acpi_status acpi_ut_strtoul64(char *string, u64 *ret_integer);
189
190u64 acpi_ut_explicit_strtoul64(char *string);
191
192u64 acpi_ut_implicit_strtoul64(char *string);
193
194/*
195 * utglobal - Global data structures and procedures
196 */
197acpi_status acpi_ut_init_globals(void);
198
199const char *acpi_ut_get_mutex_name(u32 mutex_id);
200
201#if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
202
203const char *acpi_ut_get_notify_name(u32 notify_value, acpi_object_type type);
204#endif
205
206const char *acpi_ut_get_type_name(acpi_object_type type);
207
208const char *acpi_ut_get_node_name(void *object);
209
210const char *acpi_ut_get_descriptor_name(void *object);
211
212const char *acpi_ut_get_reference_name(union acpi_operand_object *object);
213
214const char *acpi_ut_get_object_type_name(union acpi_operand_object *obj_desc);
215
216const char *acpi_ut_get_region_name(u8 space_id);
217
218const char *acpi_ut_get_event_name(u32 event_id);
219
220const char *acpi_ut_get_argument_type_name(u32 arg_type);
221
222char acpi_ut_hex_to_ascii_char(u64 integer, u32 position);
223
224acpi_status acpi_ut_ascii_to_hex_byte(char *two_ascii_chars, u8 *return_byte);
225
226u8 acpi_ut_ascii_char_to_hex(int hex_char);
227
228u8 acpi_ut_valid_object_type(acpi_object_type type);
229
230/*
231 * utinit - miscellaneous initialization and shutdown
232 */
233acpi_status acpi_ut_hardware_initialize(void);
234
235void acpi_ut_subsystem_shutdown(void);
236
237/*
238 * utcopy - Object construction and conversion interfaces
239 */
240acpi_status
241acpi_ut_build_simple_object(union acpi_operand_object *obj,
242 union acpi_object *user_obj,
243 u8 *data_space, u32 *buffer_space_used);
244
245acpi_status
246acpi_ut_build_package_object(union acpi_operand_object *obj,
247 u8 *buffer, u32 *space_used);
248
249acpi_status
250acpi_ut_copy_iobject_to_eobject(union acpi_operand_object *obj,
251 struct acpi_buffer *ret_buffer);
252
253acpi_status
254acpi_ut_copy_eobject_to_iobject(union acpi_object *obj,
255 union acpi_operand_object **internal_obj);
256
257acpi_status
258acpi_ut_copy_isimple_to_isimple(union acpi_operand_object *source_obj,
259 union acpi_operand_object *dest_obj);
260
261acpi_status
262acpi_ut_copy_iobject_to_iobject(union acpi_operand_object *source_desc,
263 union acpi_operand_object **dest_desc,
264 struct acpi_walk_state *walk_state);
265
266/*
267 * utcreate - Object creation
268 */
269acpi_status
270acpi_ut_update_object_reference(union acpi_operand_object *object, u16 action);
271
272/*
273 * utdebug - Debug interfaces
274 */
275void acpi_ut_init_stack_ptr_trace(void);
276
277void acpi_ut_track_stack_ptr(void);
278
279void
280acpi_ut_trace(u32 line_number,
281 const char *function_name,
282 const char *module_name, u32 component_id);
283
284void
285acpi_ut_trace_ptr(u32 line_number,
286 const char *function_name,
287 const char *module_name,
288 u32 component_id, const void *pointer);
289
290void
291acpi_ut_trace_u32(u32 line_number,
292 const char *function_name,
293 const char *module_name, u32 component_id, u32 integer);
294
295void
296acpi_ut_trace_str(u32 line_number,
297 const char *function_name,
298 const char *module_name,
299 u32 component_id, const char *string);
300
301void
302acpi_ut_exit(u32 line_number,
303 const char *function_name,
304 const char *module_name, u32 component_id);
305
306void
307acpi_ut_status_exit(u32 line_number,
308 const char *function_name,
309 const char *module_name,
310 u32 component_id, acpi_status status);
311
312void
313acpi_ut_value_exit(u32 line_number,
314 const char *function_name,
315 const char *module_name, u32 component_id, u64 value);
316
317void
318acpi_ut_ptr_exit(u32 line_number,
319 const char *function_name,
320 const char *module_name, u32 component_id, u8 *ptr);
321
322void
323acpi_ut_str_exit(u32 line_number,
324 const char *function_name,
325 const char *module_name, u32 component_id, const char *string);
326
327void
328acpi_ut_debug_dump_buffer(u8 *buffer, u32 count, u32 display, u32 component_id);
329
330void acpi_ut_dump_buffer(u8 *buffer, u32 count, u32 display, u32 offset);
331
332#ifdef ACPI_APPLICATION
333void
334acpi_ut_dump_buffer_to_file(ACPI_FILE file,
335 u8 *buffer,
336 u32 count, u32 display, u32 base_offset);
337#endif
338
339void acpi_ut_report_error(char *module_name, u32 line_number);
340
341void acpi_ut_report_info(char *module_name, u32 line_number);
342
343void acpi_ut_report_warning(char *module_name, u32 line_number);
344
345/*
346 * utdelete - Object deletion and reference counts
347 */
348void acpi_ut_add_reference(union acpi_operand_object *object);
349
350void acpi_ut_remove_reference(union acpi_operand_object *object);
351
352void acpi_ut_delete_internal_package_object(union acpi_operand_object *object);
353
354void acpi_ut_delete_internal_simple_object(union acpi_operand_object *object);
355
356void acpi_ut_delete_internal_object_list(union acpi_operand_object **obj_list);
357
358/*
359 * uteval - object evaluation
360 */
361acpi_status
362acpi_ut_evaluate_object(struct acpi_namespace_node *prefix_node,
363 const char *path,
364 u32 expected_return_btypes,
365 union acpi_operand_object **return_desc);
366
367acpi_status
368acpi_ut_evaluate_numeric_object(const char *object_name,
369 struct acpi_namespace_node *device_node,
370 u64 *value);
371
372acpi_status
373acpi_ut_execute_STA(struct acpi_namespace_node *device_node, u32 *status_flags);
374
375acpi_status
376acpi_ut_execute_power_methods(struct acpi_namespace_node *device_node,
377 const char **method_names,
378 u8 method_count, u8 *out_values);
379
380/*
381 * utids - device ID support
382 */
383acpi_status
384acpi_ut_execute_HID(struct acpi_namespace_node *device_node,
385 struct acpi_pnp_device_id ** return_id);
386
387acpi_status
388acpi_ut_execute_UID(struct acpi_namespace_node *device_node,
389 struct acpi_pnp_device_id ** return_id);
390
391acpi_status
392acpi_ut_execute_CID(struct acpi_namespace_node *device_node,
393 struct acpi_pnp_device_id_list ** return_cid_list);
394
395acpi_status
396acpi_ut_execute_CLS(struct acpi_namespace_node *device_node,
397 struct acpi_pnp_device_id **return_id);
398
399/*
400 * utlock - reader/writer locks
401 */
402acpi_status acpi_ut_create_rw_lock(struct acpi_rw_lock *lock);
403
404void acpi_ut_delete_rw_lock(struct acpi_rw_lock *lock);
405
406acpi_status acpi_ut_acquire_read_lock(struct acpi_rw_lock *lock);
407
408acpi_status acpi_ut_release_read_lock(struct acpi_rw_lock *lock);
409
410acpi_status acpi_ut_acquire_write_lock(struct acpi_rw_lock *lock);
411
412void acpi_ut_release_write_lock(struct acpi_rw_lock *lock);
413
414/*
415 * utobject - internal object create/delete/cache routines
416 */
417union acpi_operand_object *acpi_ut_create_internal_object_dbg(const char
418 *module_name,
419 u32 line_number,
420 u32 component_id,
421 acpi_object_type
422 type);
423
424void *acpi_ut_allocate_object_desc_dbg(const char *module_name,
425 u32 line_number, u32 component_id);
426
427#define acpi_ut_create_internal_object(t) acpi_ut_create_internal_object_dbg (_acpi_module_name,__LINE__,_COMPONENT,t)
428#define acpi_ut_allocate_object_desc() acpi_ut_allocate_object_desc_dbg (_acpi_module_name,__LINE__,_COMPONENT)
429
430void acpi_ut_delete_object_desc(union acpi_operand_object *object);
431
432u8 acpi_ut_valid_internal_object(void *object);
433
434union acpi_operand_object *acpi_ut_create_package_object(u32 count);
435
436union acpi_operand_object *acpi_ut_create_integer_object(u64 value);
437
438union acpi_operand_object *acpi_ut_create_buffer_object(acpi_size buffer_size);
439
440union acpi_operand_object *acpi_ut_create_string_object(acpi_size string_size);
441
442acpi_status
443acpi_ut_get_object_size(union acpi_operand_object *obj, acpi_size *obj_length);
444
445/*
446 * utosi - Support for the _OSI predefined control method
447 */
448acpi_status acpi_ut_initialize_interfaces(void);
449
450acpi_status acpi_ut_interface_terminate(void);
451
452acpi_status acpi_ut_install_interface(acpi_string interface_name);
453
454acpi_status acpi_ut_remove_interface(acpi_string interface_name);
455
456acpi_status acpi_ut_update_interfaces(u8 action);
457
458struct acpi_interface_info *acpi_ut_get_interface(acpi_string interface_name);
459
460acpi_status acpi_ut_osi_implementation(struct acpi_walk_state *walk_state);
461
462/*
463 * utpredef - support for predefined names
464 */
465const union acpi_predefined_info *acpi_ut_get_next_predefined_method(const union
466 acpi_predefined_info
467 *this_name);
468
469const union acpi_predefined_info *acpi_ut_match_predefined_method(char *name);
470
471void acpi_ut_get_expected_return_types(char *buffer, u32 expected_btypes);
472
473#if (defined ACPI_ASL_COMPILER || defined ACPI_HELP_APP)
474const union acpi_predefined_info *acpi_ut_match_resource_name(char *name);
475
476void
477acpi_ut_display_predefined_method(char *buffer,
478 const union acpi_predefined_info *this_name,
479 u8 multi_line);
480
481u32 acpi_ut_get_resource_bit_width(char *buffer, u16 types);
482#endif
483
484/*
485 * utstate - Generic state creation/cache routines
486 */
487void
488acpi_ut_push_generic_state(union acpi_generic_state **list_head,
489 union acpi_generic_state *state);
490
491union acpi_generic_state *acpi_ut_pop_generic_state(union acpi_generic_state
492 **list_head);
493
494union acpi_generic_state *acpi_ut_create_generic_state(void);
495
496struct acpi_thread_state *acpi_ut_create_thread_state(void);
497
498union acpi_generic_state *acpi_ut_create_update_state(union acpi_operand_object
499 *object, u16 action);
500
501union acpi_generic_state *acpi_ut_create_pkg_state(void *internal_object,
502 void *external_object,
503 u32 index);
504
505acpi_status
506acpi_ut_create_update_state_and_push(union acpi_operand_object *object,
507 u16 action,
508 union acpi_generic_state **state_list);
509
510union acpi_generic_state *acpi_ut_create_control_state(void);
511
512void acpi_ut_delete_generic_state(union acpi_generic_state *state);
513
514/*
515 * utmath
516 */
517acpi_status
518acpi_ut_divide(u64 in_dividend,
519 u64 in_divisor, u64 *out_quotient, u64 *out_remainder);
520
521acpi_status
522acpi_ut_short_divide(u64 in_dividend,
523 u32 divisor, u64 *out_quotient, u32 *out_remainder);
524
525acpi_status
526acpi_ut_short_multiply(u64 in_multiplicand, u32 multiplier, u64 *outproduct);
527
528acpi_status acpi_ut_short_shift_left(u64 operand, u32 count, u64 *out_result);
529
530acpi_status acpi_ut_short_shift_right(u64 operand, u32 count, u64 *out_result);
531
532/*
533 * utmisc
534 */
535const struct acpi_exception_info *acpi_ut_validate_exception(acpi_status
536 status);
537
538u8 acpi_ut_is_pci_root_bridge(char *id);
539
540#if (defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP || defined ACPI_NAMES_APP)
541u8 acpi_ut_is_aml_table(struct acpi_table_header *table);
542#endif
543
544acpi_status
545acpi_ut_walk_package_tree(union acpi_operand_object *source_object,
546 void *target_object,
547 acpi_pkg_callback walk_callback, void *context);
548
549/* Values for Base above (16=Hex, 10=Decimal) */
550
551#define ACPI_ANY_BASE 0
552
553u32 acpi_ut_dword_byte_swap(u32 value);
554
555void acpi_ut_set_integer_width(u8 revision);
556
557#ifdef ACPI_DEBUG_OUTPUT
558void
559acpi_ut_display_init_pathname(u8 type,
560 struct acpi_namespace_node *obj_handle,
561 const char *path);
562#endif
563
564/*
565 * utownerid - Support for Table/Method Owner IDs
566 */
567acpi_status acpi_ut_allocate_owner_id(acpi_owner_id *owner_id);
568
569void acpi_ut_release_owner_id(acpi_owner_id *owner_id);
570
571/*
572 * utresrc
573 */
574acpi_status
575acpi_ut_walk_aml_resources(struct acpi_walk_state *walk_state,
576 u8 *aml,
577 acpi_size aml_length,
578 acpi_walk_aml_callback user_function,
579 void **context);
580
581acpi_status
582acpi_ut_validate_resource(struct acpi_walk_state *walk_state,
583 void *aml, u8 *return_index);
584
585u32 acpi_ut_get_descriptor_length(void *aml);
586
587u16 acpi_ut_get_resource_length(void *aml);
588
589u8 acpi_ut_get_resource_header_length(void *aml);
590
591u8 acpi_ut_get_resource_type(void *aml);
592
593acpi_status
594acpi_ut_get_resource_end_tag(union acpi_operand_object *obj_desc, u8 **end_tag);
595
596/*
597 * utstring - String and character utilities
598 */
599void acpi_ut_print_string(char *string, u16 max_length);
600
601#if defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP
602void ut_convert_backslashes(char *pathname);
603#endif
604
605void acpi_ut_repair_name(char *name);
606
607#if defined (ACPI_DEBUGGER) || defined (ACPI_APPLICATION) || defined (ACPI_DEBUG_OUTPUT)
608u8 acpi_ut_safe_strcpy(char *dest, acpi_size dest_size, char *source);
609
610void acpi_ut_safe_strncpy(char *dest, char *source, acpi_size dest_size);
611
612u8 acpi_ut_safe_strcat(char *dest, acpi_size dest_size, char *source);
613
614u8
615acpi_ut_safe_strncat(char *dest,
616 acpi_size dest_size,
617 char *source, acpi_size max_transfer_length);
618#endif
619
620/*
621 * utmutex - mutex support
622 */
623acpi_status acpi_ut_mutex_initialize(void);
624
625void acpi_ut_mutex_terminate(void);
626
627acpi_status acpi_ut_acquire_mutex(acpi_mutex_handle mutex_id);
628
629acpi_status acpi_ut_release_mutex(acpi_mutex_handle mutex_id);
630
631/*
632 * utalloc - memory allocation and object caching
633 */
634acpi_status acpi_ut_create_caches(void);
635
636acpi_status acpi_ut_delete_caches(void);
637
638acpi_status acpi_ut_validate_buffer(struct acpi_buffer *buffer);
639
640acpi_status
641acpi_ut_initialize_buffer(struct acpi_buffer *buffer,
642 acpi_size required_length);
643
644#ifdef ACPI_DBG_TRACK_ALLOCATIONS
645void *acpi_ut_allocate_and_track(acpi_size size,
646 u32 component, const char *module, u32 line);
647
648void *acpi_ut_allocate_zeroed_and_track(acpi_size size,
649 u32 component,
650 const char *module, u32 line);
651
652void
653acpi_ut_free_and_track(void *address,
654 u32 component, const char *module, u32 line);
655
656void acpi_ut_dump_allocation_info(void);
657
658void acpi_ut_dump_allocations(u32 component, const char *module);
659
660acpi_status
661acpi_ut_create_list(const char *list_name,
662 u16 object_size, struct acpi_memory_list **return_cache);
663
664#endif /* ACPI_DBG_TRACK_ALLOCATIONS */
665
666/*
667 * utaddress - address range check
668 */
669acpi_status
670acpi_ut_add_address_range(acpi_adr_space_type space_id,
671 acpi_physical_address address,
672 u32 length, struct acpi_namespace_node *region_node);
673
674void
675acpi_ut_remove_address_range(acpi_adr_space_type space_id,
676 struct acpi_namespace_node *region_node);
677
678u32
679acpi_ut_check_address_range(acpi_adr_space_type space_id,
680 acpi_physical_address address, u32 length, u8 warn);
681
682void acpi_ut_delete_address_lists(void);
683
684/*
685 * utxferror - various error/warning output functions
686 */
687void ACPI_INTERNAL_VAR_XFACE
688acpi_ut_predefined_warning(const char *module_name,
689 u32 line_number,
690 char *pathname,
691 u8 node_flags, const char *format, ...);
692
693void ACPI_INTERNAL_VAR_XFACE
694acpi_ut_predefined_info(const char *module_name,
695 u32 line_number,
696 char *pathname, u8 node_flags, const char *format, ...);
697
698void ACPI_INTERNAL_VAR_XFACE
699acpi_ut_predefined_bios_error(const char *module_name,
700 u32 line_number,
701 char *pathname,
702 u8 node_flags, const char *format, ...);
703
704void
705acpi_ut_prefixed_namespace_error(const char *module_name,
706 u32 line_number,
707 union acpi_generic_state *prefix_scope,
708 const char *internal_name,
709 acpi_status lookup_status);
710
711void
712acpi_ut_method_error(const char *module_name,
713 u32 line_number,
714 const char *message,
715 struct acpi_namespace_node *node,
716 const char *path, acpi_status lookup_status);
717
718/*
719 * Utility functions for ACPI names and IDs
720 */
721const struct ah_predefined_name *acpi_ah_match_predefined_name(char *nameseg);
722
723const struct ah_device_id *acpi_ah_match_hardware_id(char *hid);
724
725const char *acpi_ah_match_uuid(u8 *data);
726
727/*
728 * utuuid -- UUID support functions
729 */
730#if (defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP || defined ACPI_HELP_APP)
731void acpi_ut_convert_string_to_uuid(char *in_string, u8 *uuid_buffer);
732#endif
733
734#endif /* _ACUTILS_H */