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