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