xref: /openbmc/linux/drivers/acpi/acpica/acutils.h (revision e8254a8e)
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 - 2022, 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  * utcksum - Checksum utilities
163  */
164 u8 acpi_ut_generate_checksum(void *table, u32 length, u8 original_checksum);
165 
166 u8 acpi_ut_checksum(u8 *buffer, u32 length);
167 
168 acpi_status
169 acpi_ut_verify_cdat_checksum(struct acpi_table_cdat *cdat_table, u32 length);
170 
171 acpi_status
172 acpi_ut_verify_checksum(struct acpi_table_header *table, u32 length);
173 
174 /*
175  * utnonansi - Non-ANSI C library functions
176  */
177 void acpi_ut_strupr(char *src_string);
178 
179 void acpi_ut_strlwr(char *src_string);
180 
181 int acpi_ut_stricmp(char *string1, char *string2);
182 
183 /*
184  * utstrsuppt - string-to-integer conversion support functions
185  */
186 acpi_status acpi_ut_convert_octal_string(char *string, u64 *return_value);
187 
188 acpi_status acpi_ut_convert_decimal_string(char *string, u64 *return_value_ptr);
189 
190 acpi_status acpi_ut_convert_hex_string(char *string, u64 *return_value_ptr);
191 
192 char acpi_ut_remove_whitespace(char **string);
193 
194 char acpi_ut_remove_leading_zeros(char **string);
195 
196 u8 acpi_ut_detect_hex_prefix(char **string);
197 
198 void acpi_ut_remove_hex_prefix(char **string);
199 
200 u8 acpi_ut_detect_octal_prefix(char **string);
201 
202 /*
203  * utstrtoul64 - string-to-integer conversion functions
204  */
205 acpi_status acpi_ut_strtoul64(char *string, u64 *ret_integer);
206 
207 u64 acpi_ut_explicit_strtoul64(char *string);
208 
209 u64 acpi_ut_implicit_strtoul64(char *string);
210 
211 /*
212  * utglobal - Global data structures and procedures
213  */
214 acpi_status acpi_ut_init_globals(void);
215 
216 const char *acpi_ut_get_mutex_name(u32 mutex_id);
217 
218 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
219 
220 const char *acpi_ut_get_notify_name(u32 notify_value, acpi_object_type type);
221 #endif
222 
223 const char *acpi_ut_get_type_name(acpi_object_type type);
224 
225 const char *acpi_ut_get_node_name(void *object);
226 
227 const char *acpi_ut_get_descriptor_name(void *object);
228 
229 const char *acpi_ut_get_reference_name(union acpi_operand_object *object);
230 
231 const char *acpi_ut_get_object_type_name(union acpi_operand_object *obj_desc);
232 
233 const char *acpi_ut_get_region_name(u8 space_id);
234 
235 const char *acpi_ut_get_event_name(u32 event_id);
236 
237 const char *acpi_ut_get_argument_type_name(u32 arg_type);
238 
239 char acpi_ut_hex_to_ascii_char(u64 integer, u32 position);
240 
241 acpi_status acpi_ut_ascii_to_hex_byte(char *two_ascii_chars, u8 *return_byte);
242 
243 u8 acpi_ut_ascii_char_to_hex(int hex_char);
244 
245 u8 acpi_ut_valid_object_type(acpi_object_type type);
246 
247 /*
248  * utinit - miscellaneous initialization and shutdown
249  */
250 acpi_status acpi_ut_hardware_initialize(void);
251 
252 void acpi_ut_subsystem_shutdown(void);
253 
254 /*
255  * utcopy - Object construction and conversion interfaces
256  */
257 acpi_status
258 acpi_ut_build_simple_object(union acpi_operand_object *obj,
259 			    union acpi_object *user_obj,
260 			    u8 *data_space, u32 *buffer_space_used);
261 
262 acpi_status
263 acpi_ut_build_package_object(union acpi_operand_object *obj,
264 			     u8 *buffer, u32 *space_used);
265 
266 acpi_status
267 acpi_ut_copy_iobject_to_eobject(union acpi_operand_object *obj,
268 				struct acpi_buffer *ret_buffer);
269 
270 acpi_status
271 acpi_ut_copy_eobject_to_iobject(union acpi_object *obj,
272 				union acpi_operand_object **internal_obj);
273 
274 acpi_status
275 acpi_ut_copy_isimple_to_isimple(union acpi_operand_object *source_obj,
276 				union acpi_operand_object *dest_obj);
277 
278 acpi_status
279 acpi_ut_copy_iobject_to_iobject(union acpi_operand_object *source_desc,
280 				union acpi_operand_object **dest_desc,
281 				struct acpi_walk_state *walk_state);
282 
283 /*
284  * utcreate - Object creation
285  */
286 acpi_status
287 acpi_ut_update_object_reference(union acpi_operand_object *object, u16 action);
288 
289 /*
290  * utdebug - Debug interfaces
291  */
292 void acpi_ut_init_stack_ptr_trace(void);
293 
294 void acpi_ut_track_stack_ptr(void);
295 
296 void
297 acpi_ut_trace(u32 line_number,
298 	      const char *function_name,
299 	      const char *module_name, u32 component_id);
300 
301 void
302 acpi_ut_trace_ptr(u32 line_number,
303 		  const char *function_name,
304 		  const char *module_name,
305 		  u32 component_id, const void *pointer);
306 
307 void
308 acpi_ut_trace_u32(u32 line_number,
309 		  const char *function_name,
310 		  const char *module_name, u32 component_id, u32 integer);
311 
312 void
313 acpi_ut_trace_str(u32 line_number,
314 		  const char *function_name,
315 		  const char *module_name,
316 		  u32 component_id, const char *string);
317 
318 void
319 acpi_ut_exit(u32 line_number,
320 	     const char *function_name,
321 	     const char *module_name, u32 component_id);
322 
323 void
324 acpi_ut_status_exit(u32 line_number,
325 		    const char *function_name,
326 		    const char *module_name,
327 		    u32 component_id, acpi_status status);
328 
329 void
330 acpi_ut_value_exit(u32 line_number,
331 		   const char *function_name,
332 		   const char *module_name, u32 component_id, u64 value);
333 
334 void
335 acpi_ut_ptr_exit(u32 line_number,
336 		 const char *function_name,
337 		 const char *module_name, u32 component_id, u8 *ptr);
338 
339 void
340 acpi_ut_str_exit(u32 line_number,
341 		 const char *function_name,
342 		 const char *module_name, u32 component_id, const char *string);
343 
344 void
345 acpi_ut_debug_dump_buffer(u8 *buffer, u32 count, u32 display, u32 component_id);
346 
347 void acpi_ut_dump_buffer(u8 *buffer, u32 count, u32 display, u32 offset);
348 
349 #ifdef ACPI_APPLICATION
350 void
351 acpi_ut_dump_buffer_to_file(ACPI_FILE file,
352 			    u8 *buffer,
353 			    u32 count, u32 display, u32 base_offset);
354 #endif
355 
356 void acpi_ut_report_error(char *module_name, u32 line_number);
357 
358 void acpi_ut_report_info(char *module_name, u32 line_number);
359 
360 void acpi_ut_report_warning(char *module_name, u32 line_number);
361 
362 /*
363  * utdelete - Object deletion and reference counts
364  */
365 void acpi_ut_add_reference(union acpi_operand_object *object);
366 
367 void acpi_ut_remove_reference(union acpi_operand_object *object);
368 
369 void acpi_ut_delete_internal_package_object(union acpi_operand_object *object);
370 
371 void acpi_ut_delete_internal_simple_object(union acpi_operand_object *object);
372 
373 void acpi_ut_delete_internal_object_list(union acpi_operand_object **obj_list);
374 
375 /*
376  * uteval - object evaluation
377  */
378 acpi_status
379 acpi_ut_evaluate_object(struct acpi_namespace_node *prefix_node,
380 			const char *path,
381 			u32 expected_return_btypes,
382 			union acpi_operand_object **return_desc);
383 
384 acpi_status
385 acpi_ut_evaluate_numeric_object(const char *object_name,
386 				struct acpi_namespace_node *device_node,
387 				u64 *value);
388 
389 acpi_status
390 acpi_ut_execute_STA(struct acpi_namespace_node *device_node, u32 *status_flags);
391 
392 acpi_status
393 acpi_ut_execute_power_methods(struct acpi_namespace_node *device_node,
394 			      const char **method_names,
395 			      u8 method_count, u8 *out_values);
396 
397 /*
398  * utids - device ID support
399  */
400 acpi_status
401 acpi_ut_execute_HID(struct acpi_namespace_node *device_node,
402 		    struct acpi_pnp_device_id ** return_id);
403 
404 acpi_status
405 acpi_ut_execute_UID(struct acpi_namespace_node *device_node,
406 		    struct acpi_pnp_device_id ** return_id);
407 
408 acpi_status
409 acpi_ut_execute_CID(struct acpi_namespace_node *device_node,
410 		    struct acpi_pnp_device_id_list ** return_cid_list);
411 
412 acpi_status
413 acpi_ut_execute_CLS(struct acpi_namespace_node *device_node,
414 		    struct acpi_pnp_device_id **return_id);
415 
416 /*
417  * utlock - reader/writer locks
418  */
419 acpi_status acpi_ut_create_rw_lock(struct acpi_rw_lock *lock);
420 
421 void acpi_ut_delete_rw_lock(struct acpi_rw_lock *lock);
422 
423 acpi_status acpi_ut_acquire_read_lock(struct acpi_rw_lock *lock);
424 
425 acpi_status acpi_ut_release_read_lock(struct acpi_rw_lock *lock);
426 
427 acpi_status acpi_ut_acquire_write_lock(struct acpi_rw_lock *lock);
428 
429 void acpi_ut_release_write_lock(struct acpi_rw_lock *lock);
430 
431 /*
432  * utobject - internal object create/delete/cache routines
433  */
434 union acpi_operand_object *acpi_ut_create_internal_object_dbg(const char
435 							      *module_name,
436 							      u32 line_number,
437 							      u32 component_id,
438 							      acpi_object_type
439 							      type);
440 
441 void *acpi_ut_allocate_object_desc_dbg(const char *module_name,
442 				       u32 line_number, u32 component_id);
443 
444 #define acpi_ut_create_internal_object(t) acpi_ut_create_internal_object_dbg (_acpi_module_name,__LINE__,_COMPONENT,t)
445 #define acpi_ut_allocate_object_desc()  acpi_ut_allocate_object_desc_dbg (_acpi_module_name,__LINE__,_COMPONENT)
446 
447 void acpi_ut_delete_object_desc(union acpi_operand_object *object);
448 
449 u8 acpi_ut_valid_internal_object(void *object);
450 
451 union acpi_operand_object *acpi_ut_create_package_object(u32 count);
452 
453 union acpi_operand_object *acpi_ut_create_integer_object(u64 value);
454 
455 union acpi_operand_object *acpi_ut_create_buffer_object(acpi_size buffer_size);
456 
457 union acpi_operand_object *acpi_ut_create_string_object(acpi_size string_size);
458 
459 acpi_status
460 acpi_ut_get_object_size(union acpi_operand_object *obj, acpi_size *obj_length);
461 
462 /*
463  * utosi - Support for the _OSI predefined control method
464  */
465 acpi_status acpi_ut_initialize_interfaces(void);
466 
467 acpi_status acpi_ut_interface_terminate(void);
468 
469 acpi_status acpi_ut_install_interface(acpi_string interface_name);
470 
471 acpi_status acpi_ut_remove_interface(acpi_string interface_name);
472 
473 acpi_status acpi_ut_update_interfaces(u8 action);
474 
475 struct acpi_interface_info *acpi_ut_get_interface(acpi_string interface_name);
476 
477 acpi_status acpi_ut_osi_implementation(struct acpi_walk_state *walk_state);
478 
479 /*
480  * utpredef - support for predefined names
481  */
482 const union acpi_predefined_info *acpi_ut_get_next_predefined_method(const union
483 								     acpi_predefined_info
484 								     *this_name);
485 
486 const union acpi_predefined_info *acpi_ut_match_predefined_method(char *name);
487 
488 void acpi_ut_get_expected_return_types(char *buffer, u32 expected_btypes);
489 
490 #if (defined ACPI_ASL_COMPILER || defined ACPI_HELP_APP)
491 const union acpi_predefined_info *acpi_ut_match_resource_name(char *name);
492 
493 void
494 acpi_ut_display_predefined_method(char *buffer,
495 				  const union acpi_predefined_info *this_name,
496 				  u8 multi_line);
497 
498 u32 acpi_ut_get_resource_bit_width(char *buffer, u16 types);
499 #endif
500 
501 /*
502  * utstate - Generic state creation/cache routines
503  */
504 void
505 acpi_ut_push_generic_state(union acpi_generic_state **list_head,
506 			   union acpi_generic_state *state);
507 
508 union acpi_generic_state *acpi_ut_pop_generic_state(union acpi_generic_state
509 						    **list_head);
510 
511 union acpi_generic_state *acpi_ut_create_generic_state(void);
512 
513 struct acpi_thread_state *acpi_ut_create_thread_state(void);
514 
515 union acpi_generic_state *acpi_ut_create_update_state(union acpi_operand_object
516 						      *object, u16 action);
517 
518 union acpi_generic_state *acpi_ut_create_pkg_state(void *internal_object,
519 						   void *external_object,
520 						   u32 index);
521 
522 acpi_status
523 acpi_ut_create_update_state_and_push(union acpi_operand_object *object,
524 				     u16 action,
525 				     union acpi_generic_state **state_list);
526 
527 union acpi_generic_state *acpi_ut_create_control_state(void);
528 
529 void acpi_ut_delete_generic_state(union acpi_generic_state *state);
530 
531 /*
532  * utmath
533  */
534 acpi_status
535 acpi_ut_divide(u64 in_dividend,
536 	       u64 in_divisor, u64 *out_quotient, u64 *out_remainder);
537 
538 acpi_status
539 acpi_ut_short_divide(u64 in_dividend,
540 		     u32 divisor, u64 *out_quotient, u32 *out_remainder);
541 
542 acpi_status
543 acpi_ut_short_multiply(u64 in_multiplicand, u32 multiplier, u64 *outproduct);
544 
545 acpi_status acpi_ut_short_shift_left(u64 operand, u32 count, u64 *out_result);
546 
547 acpi_status acpi_ut_short_shift_right(u64 operand, u32 count, u64 *out_result);
548 
549 /*
550  * utmisc
551  */
552 const struct acpi_exception_info *acpi_ut_validate_exception(acpi_status
553 							     status);
554 
555 u8 acpi_ut_is_pci_root_bridge(char *id);
556 
557 #if (defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP || defined ACPI_NAMES_APP)
558 u8 acpi_ut_is_aml_table(struct acpi_table_header *table);
559 #endif
560 
561 acpi_status
562 acpi_ut_walk_package_tree(union acpi_operand_object *source_object,
563 			  void *target_object,
564 			  acpi_pkg_callback walk_callback, void *context);
565 
566 /* Values for Base above (16=Hex, 10=Decimal) */
567 
568 #define ACPI_ANY_BASE        0
569 
570 u32 acpi_ut_dword_byte_swap(u32 value);
571 
572 void acpi_ut_set_integer_width(u8 revision);
573 
574 #ifdef ACPI_DEBUG_OUTPUT
575 void
576 acpi_ut_display_init_pathname(u8 type,
577 			      struct acpi_namespace_node *obj_handle,
578 			      const char *path);
579 #endif
580 
581 /*
582  * utownerid - Support for Table/Method Owner IDs
583  */
584 acpi_status acpi_ut_allocate_owner_id(acpi_owner_id *owner_id);
585 
586 void acpi_ut_release_owner_id(acpi_owner_id *owner_id);
587 
588 /*
589  * utresrc
590  */
591 acpi_status
592 acpi_ut_walk_aml_resources(struct acpi_walk_state *walk_state,
593 			   u8 *aml,
594 			   acpi_size aml_length,
595 			   acpi_walk_aml_callback user_function,
596 			   void **context);
597 
598 acpi_status
599 acpi_ut_validate_resource(struct acpi_walk_state *walk_state,
600 			  void *aml, u8 *return_index);
601 
602 u32 acpi_ut_get_descriptor_length(void *aml);
603 
604 u16 acpi_ut_get_resource_length(void *aml);
605 
606 u8 acpi_ut_get_resource_header_length(void *aml);
607 
608 u8 acpi_ut_get_resource_type(void *aml);
609 
610 acpi_status
611 acpi_ut_get_resource_end_tag(union acpi_operand_object *obj_desc, u8 **end_tag);
612 
613 /*
614  * utstring - String and character utilities
615  */
616 void acpi_ut_print_string(char *string, u16 max_length);
617 
618 #if defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP
619 void ut_convert_backslashes(char *pathname);
620 #endif
621 
622 void acpi_ut_repair_name(char *name);
623 
624 #if defined (ACPI_DEBUGGER) || defined (ACPI_APPLICATION) || defined (ACPI_DEBUG_OUTPUT)
625 u8 acpi_ut_safe_strcpy(char *dest, acpi_size dest_size, char *source);
626 
627 void acpi_ut_safe_strncpy(char *dest, char *source, acpi_size dest_size);
628 
629 u8 acpi_ut_safe_strcat(char *dest, acpi_size dest_size, char *source);
630 
631 u8
632 acpi_ut_safe_strncat(char *dest,
633 		     acpi_size dest_size,
634 		     char *source, acpi_size max_transfer_length);
635 #endif
636 
637 /*
638  * utmutex - mutex support
639  */
640 acpi_status acpi_ut_mutex_initialize(void);
641 
642 void acpi_ut_mutex_terminate(void);
643 
644 acpi_status acpi_ut_acquire_mutex(acpi_mutex_handle mutex_id);
645 
646 acpi_status acpi_ut_release_mutex(acpi_mutex_handle mutex_id);
647 
648 /*
649  * utalloc - memory allocation and object caching
650  */
651 acpi_status acpi_ut_create_caches(void);
652 
653 acpi_status acpi_ut_delete_caches(void);
654 
655 acpi_status acpi_ut_validate_buffer(struct acpi_buffer *buffer);
656 
657 acpi_status
658 acpi_ut_initialize_buffer(struct acpi_buffer *buffer,
659 			  acpi_size required_length);
660 
661 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
662 void *acpi_ut_allocate_and_track(acpi_size size,
663 				 u32 component, const char *module, u32 line);
664 
665 void *acpi_ut_allocate_zeroed_and_track(acpi_size size,
666 					u32 component,
667 					const char *module, u32 line);
668 
669 void
670 acpi_ut_free_and_track(void *address,
671 		       u32 component, const char *module, u32 line);
672 
673 void acpi_ut_dump_allocation_info(void);
674 
675 void acpi_ut_dump_allocations(u32 component, const char *module);
676 
677 acpi_status
678 acpi_ut_create_list(const char *list_name,
679 		    u16 object_size, struct acpi_memory_list **return_cache);
680 
681 #endif				/* ACPI_DBG_TRACK_ALLOCATIONS */
682 
683 /*
684  * utaddress - address range check
685  */
686 acpi_status
687 acpi_ut_add_address_range(acpi_adr_space_type space_id,
688 			  acpi_physical_address address,
689 			  u32 length, struct acpi_namespace_node *region_node);
690 
691 void
692 acpi_ut_remove_address_range(acpi_adr_space_type space_id,
693 			     struct acpi_namespace_node *region_node);
694 
695 u32
696 acpi_ut_check_address_range(acpi_adr_space_type space_id,
697 			    acpi_physical_address address, u32 length, u8 warn);
698 
699 void acpi_ut_delete_address_lists(void);
700 
701 /*
702  * utxferror - various error/warning output functions
703  */
704 ACPI_PRINTF_LIKE(5)
705 void ACPI_INTERNAL_VAR_XFACE
706 acpi_ut_predefined_warning(const char *module_name,
707 			   u32 line_number,
708 			   char *pathname,
709 			   u16 node_flags, const char *format, ...);
710 
711 ACPI_PRINTF_LIKE(5)
712 void ACPI_INTERNAL_VAR_XFACE
713 acpi_ut_predefined_info(const char *module_name,
714 			u32 line_number,
715 			char *pathname,
716 			u16 node_flags, const char *format, ...);
717 
718 ACPI_PRINTF_LIKE(5)
719 void ACPI_INTERNAL_VAR_XFACE
720 acpi_ut_predefined_bios_error(const char *module_name,
721 			      u32 line_number,
722 			      char *pathname,
723 			      u16 node_flags, const char *format, ...);
724 
725 void
726 acpi_ut_prefixed_namespace_error(const char *module_name,
727 				 u32 line_number,
728 				 union acpi_generic_state *prefix_scope,
729 				 const char *internal_name,
730 				 acpi_status lookup_status);
731 
732 void
733 acpi_ut_method_error(const char *module_name,
734 		     u32 line_number,
735 		     const char *message,
736 		     struct acpi_namespace_node *node,
737 		     const char *path, acpi_status lookup_status);
738 
739 /*
740  * Utility functions for ACPI names and IDs
741  */
742 const struct ah_predefined_name *acpi_ah_match_predefined_name(char *nameseg);
743 
744 const struct ah_device_id *acpi_ah_match_hardware_id(char *hid);
745 
746 const char *acpi_ah_match_uuid(u8 *data);
747 
748 /*
749  * utuuid -- UUID support functions
750  */
751 #if (defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP || defined ACPI_HELP_APP)
752 void acpi_ut_convert_string_to_uuid(char *in_string, u8 *uuid_buffer);
753 
754 acpi_status acpi_ut_convert_uuid_to_string(char *uuid_buffer, char *out_string);
755 #endif
756 
757 #endif				/* _ACUTILS_H */
758