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