• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 char acpi_ut_hex_to_ascii_char(u64 integer, u32 position);
236 
237 acpi_status acpi_ut_ascii_to_hex_byte(char *two_ascii_chars, u8 *return_byte);
238 
239 u8 acpi_ut_ascii_char_to_hex(int hex_char);
240 
241 u8 acpi_ut_valid_object_type(acpi_object_type type);
242 
243 /*
244  * utinit - miscellaneous initialization and shutdown
245  */
246 acpi_status acpi_ut_hardware_initialize(void);
247 
248 void acpi_ut_subsystem_shutdown(void);
249 
250 /*
251  * utcopy - Object construction and conversion interfaces
252  */
253 acpi_status
254 acpi_ut_build_simple_object(union acpi_operand_object *obj,
255 			    union acpi_object *user_obj,
256 			    u8 *data_space, u32 *buffer_space_used);
257 
258 acpi_status
259 acpi_ut_build_package_object(union acpi_operand_object *obj,
260 			     u8 *buffer, u32 *space_used);
261 
262 acpi_status
263 acpi_ut_copy_iobject_to_eobject(union acpi_operand_object *obj,
264 				struct acpi_buffer *ret_buffer);
265 
266 acpi_status
267 acpi_ut_copy_eobject_to_iobject(union acpi_object *obj,
268 				union acpi_operand_object **internal_obj);
269 
270 acpi_status
271 acpi_ut_copy_isimple_to_isimple(union acpi_operand_object *source_obj,
272 				union acpi_operand_object *dest_obj);
273 
274 acpi_status
275 acpi_ut_copy_iobject_to_iobject(union acpi_operand_object *source_desc,
276 				union acpi_operand_object **dest_desc,
277 				struct acpi_walk_state *walk_state);
278 
279 /*
280  * utcreate - Object creation
281  */
282 acpi_status
283 acpi_ut_update_object_reference(union acpi_operand_object *object, u16 action);
284 
285 /*
286  * utdebug - Debug interfaces
287  */
288 void acpi_ut_init_stack_ptr_trace(void);
289 
290 void acpi_ut_track_stack_ptr(void);
291 
292 void
293 acpi_ut_trace(u32 line_number,
294 	      const char *function_name,
295 	      const char *module_name, u32 component_id);
296 
297 void
298 acpi_ut_trace_ptr(u32 line_number,
299 		  const char *function_name,
300 		  const char *module_name,
301 		  u32 component_id, const void *pointer);
302 
303 void
304 acpi_ut_trace_u32(u32 line_number,
305 		  const char *function_name,
306 		  const char *module_name, u32 component_id, u32 integer);
307 
308 void
309 acpi_ut_trace_str(u32 line_number,
310 		  const char *function_name,
311 		  const char *module_name,
312 		  u32 component_id, const char *string);
313 
314 void
315 acpi_ut_exit(u32 line_number,
316 	     const char *function_name,
317 	     const char *module_name, u32 component_id);
318 
319 void
320 acpi_ut_status_exit(u32 line_number,
321 		    const char *function_name,
322 		    const char *module_name,
323 		    u32 component_id, acpi_status status);
324 
325 void
326 acpi_ut_value_exit(u32 line_number,
327 		   const char *function_name,
328 		   const char *module_name, u32 component_id, u64 value);
329 
330 void
331 acpi_ut_ptr_exit(u32 line_number,
332 		 const char *function_name,
333 		 const char *module_name, u32 component_id, u8 *ptr);
334 
335 void
336 acpi_ut_str_exit(u32 line_number,
337 		 const char *function_name,
338 		 const char *module_name, u32 component_id, const char *string);
339 
340 void
341 acpi_ut_debug_dump_buffer(u8 *buffer, u32 count, u32 display, u32 component_id);
342 
343 void acpi_ut_dump_buffer(u8 *buffer, u32 count, u32 display, u32 offset);
344 
345 #ifdef ACPI_APPLICATION
346 void
347 acpi_ut_dump_buffer_to_file(ACPI_FILE file,
348 			    u8 *buffer,
349 			    u32 count, u32 display, u32 base_offset);
350 #endif
351 
352 void acpi_ut_report_error(char *module_name, u32 line_number);
353 
354 void acpi_ut_report_info(char *module_name, u32 line_number);
355 
356 void acpi_ut_report_warning(char *module_name, u32 line_number);
357 
358 /*
359  * utdelete - Object deletion and reference counts
360  */
361 void acpi_ut_add_reference(union acpi_operand_object *object);
362 
363 void acpi_ut_remove_reference(union acpi_operand_object *object);
364 
365 void acpi_ut_delete_internal_package_object(union acpi_operand_object *object);
366 
367 void acpi_ut_delete_internal_simple_object(union acpi_operand_object *object);
368 
369 void acpi_ut_delete_internal_object_list(union acpi_operand_object **obj_list);
370 
371 /*
372  * uteval - object evaluation
373  */
374 acpi_status
375 acpi_ut_evaluate_object(struct acpi_namespace_node *prefix_node,
376 			const char *path,
377 			u32 expected_return_btypes,
378 			union acpi_operand_object **return_desc);
379 
380 acpi_status
381 acpi_ut_evaluate_numeric_object(const char *object_name,
382 				struct acpi_namespace_node *device_node,
383 				u64 *value);
384 
385 acpi_status
386 acpi_ut_execute_STA(struct acpi_namespace_node *device_node, u32 *status_flags);
387 
388 acpi_status
389 acpi_ut_execute_power_methods(struct acpi_namespace_node *device_node,
390 			      const char **method_names,
391 			      u8 method_count, u8 *out_values);
392 
393 /*
394  * utids - device ID support
395  */
396 acpi_status
397 acpi_ut_execute_HID(struct acpi_namespace_node *device_node,
398 		    struct acpi_pnp_device_id ** return_id);
399 
400 acpi_status
401 acpi_ut_execute_UID(struct acpi_namespace_node *device_node,
402 		    struct acpi_pnp_device_id ** return_id);
403 
404 acpi_status
405 acpi_ut_execute_CID(struct acpi_namespace_node *device_node,
406 		    struct acpi_pnp_device_id_list ** return_cid_list);
407 
408 acpi_status
409 acpi_ut_execute_CLS(struct acpi_namespace_node *device_node,
410 		    struct acpi_pnp_device_id **return_id);
411 
412 /*
413  * utlock - reader/writer locks
414  */
415 acpi_status acpi_ut_create_rw_lock(struct acpi_rw_lock *lock);
416 
417 void acpi_ut_delete_rw_lock(struct acpi_rw_lock *lock);
418 
419 acpi_status acpi_ut_acquire_read_lock(struct acpi_rw_lock *lock);
420 
421 acpi_status acpi_ut_release_read_lock(struct acpi_rw_lock *lock);
422 
423 acpi_status acpi_ut_acquire_write_lock(struct acpi_rw_lock *lock);
424 
425 void acpi_ut_release_write_lock(struct acpi_rw_lock *lock);
426 
427 /*
428  * utobject - internal object create/delete/cache routines
429  */
430 union acpi_operand_object *acpi_ut_create_internal_object_dbg(const char
431 							      *module_name,
432 							      u32 line_number,
433 							      u32 component_id,
434 							      acpi_object_type
435 							      type);
436 
437 void *acpi_ut_allocate_object_desc_dbg(const char *module_name,
438 				       u32 line_number, u32 component_id);
439 
440 #define acpi_ut_create_internal_object(t) acpi_ut_create_internal_object_dbg (_acpi_module_name,__LINE__,_COMPONENT,t)
441 #define acpi_ut_allocate_object_desc()  acpi_ut_allocate_object_desc_dbg (_acpi_module_name,__LINE__,_COMPONENT)
442 
443 void acpi_ut_delete_object_desc(union acpi_operand_object *object);
444 
445 u8 acpi_ut_valid_internal_object(void *object);
446 
447 union acpi_operand_object *acpi_ut_create_package_object(u32 count);
448 
449 union acpi_operand_object *acpi_ut_create_integer_object(u64 value);
450 
451 union acpi_operand_object *acpi_ut_create_buffer_object(acpi_size buffer_size);
452 
453 union acpi_operand_object *acpi_ut_create_string_object(acpi_size string_size);
454 
455 acpi_status
456 acpi_ut_get_object_size(union acpi_operand_object *obj, acpi_size *obj_length);
457 
458 /*
459  * utosi - Support for the _OSI predefined control method
460  */
461 acpi_status acpi_ut_initialize_interfaces(void);
462 
463 acpi_status acpi_ut_interface_terminate(void);
464 
465 acpi_status acpi_ut_install_interface(acpi_string interface_name);
466 
467 acpi_status acpi_ut_remove_interface(acpi_string interface_name);
468 
469 acpi_status acpi_ut_update_interfaces(u8 action);
470 
471 struct acpi_interface_info *acpi_ut_get_interface(acpi_string interface_name);
472 
473 acpi_status acpi_ut_osi_implementation(struct acpi_walk_state *walk_state);
474 
475 /*
476  * utpredef - support for predefined names
477  */
478 const union acpi_predefined_info *acpi_ut_get_next_predefined_method(const union
479 								     acpi_predefined_info
480 								     *this_name);
481 
482 const union acpi_predefined_info *acpi_ut_match_predefined_method(char *name);
483 
484 void acpi_ut_get_expected_return_types(char *buffer, u32 expected_btypes);
485 
486 #if (defined ACPI_ASL_COMPILER || defined ACPI_HELP_APP)
487 const union acpi_predefined_info *acpi_ut_match_resource_name(char *name);
488 
489 void
490 acpi_ut_display_predefined_method(char *buffer,
491 				  const union acpi_predefined_info *this_name,
492 				  u8 multi_line);
493 
494 u32 acpi_ut_get_resource_bit_width(char *buffer, u16 types);
495 #endif
496 
497 /*
498  * utstate - Generic state creation/cache routines
499  */
500 void
501 acpi_ut_push_generic_state(union acpi_generic_state **list_head,
502 			   union acpi_generic_state *state);
503 
504 union acpi_generic_state *acpi_ut_pop_generic_state(union acpi_generic_state
505 						    **list_head);
506 
507 union acpi_generic_state *acpi_ut_create_generic_state(void);
508 
509 struct acpi_thread_state *acpi_ut_create_thread_state(void);
510 
511 union acpi_generic_state *acpi_ut_create_update_state(union acpi_operand_object
512 						      *object, u16 action);
513 
514 union acpi_generic_state *acpi_ut_create_pkg_state(void *internal_object,
515 						   void *external_object,
516 						   u16 index);
517 
518 acpi_status
519 acpi_ut_create_update_state_and_push(union acpi_operand_object *object,
520 				     u16 action,
521 				     union acpi_generic_state **state_list);
522 
523 union acpi_generic_state *acpi_ut_create_control_state(void);
524 
525 void acpi_ut_delete_generic_state(union acpi_generic_state *state);
526 
527 /*
528  * utmath
529  */
530 acpi_status
531 acpi_ut_divide(u64 in_dividend,
532 	       u64 in_divisor, u64 *out_quotient, u64 *out_remainder);
533 
534 acpi_status
535 acpi_ut_short_divide(u64 in_dividend,
536 		     u32 divisor, u64 *out_quotient, u32 *out_remainder);
537 
538 /*
539  * utmisc
540  */
541 const struct acpi_exception_info *acpi_ut_validate_exception(acpi_status
542 							     status);
543 
544 u8 acpi_ut_is_pci_root_bridge(char *id);
545 
546 #if (defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP || defined ACPI_NAMES_APP)
547 u8 acpi_ut_is_aml_table(struct acpi_table_header *table);
548 #endif
549 
550 acpi_status
551 acpi_ut_walk_package_tree(union acpi_operand_object *source_object,
552 			  void *target_object,
553 			  acpi_pkg_callback walk_callback, void *context);
554 
555 /* Values for Base above (16=Hex, 10=Decimal) */
556 
557 #define ACPI_ANY_BASE        0
558 
559 u32 acpi_ut_dword_byte_swap(u32 value);
560 
561 void acpi_ut_set_integer_width(u8 revision);
562 
563 #ifdef ACPI_DEBUG_OUTPUT
564 void
565 acpi_ut_display_init_pathname(u8 type,
566 			      struct acpi_namespace_node *obj_handle,
567 			      const char *path);
568 #endif
569 
570 /*
571  * utownerid - Support for Table/Method Owner IDs
572  */
573 acpi_status acpi_ut_allocate_owner_id(acpi_owner_id *owner_id);
574 
575 void acpi_ut_release_owner_id(acpi_owner_id *owner_id);
576 
577 /*
578  * utresrc
579  */
580 acpi_status
581 acpi_ut_walk_aml_resources(struct acpi_walk_state *walk_state,
582 			   u8 *aml,
583 			   acpi_size aml_length,
584 			   acpi_walk_aml_callback user_function,
585 			   void **context);
586 
587 acpi_status
588 acpi_ut_validate_resource(struct acpi_walk_state *walk_state,
589 			  void *aml, u8 *return_index);
590 
591 u32 acpi_ut_get_descriptor_length(void *aml);
592 
593 u16 acpi_ut_get_resource_length(void *aml);
594 
595 u8 acpi_ut_get_resource_header_length(void *aml);
596 
597 u8 acpi_ut_get_resource_type(void *aml);
598 
599 acpi_status
600 acpi_ut_get_resource_end_tag(union acpi_operand_object *obj_desc, u8 **end_tag);
601 
602 /*
603  * utstring - String and character utilities
604  */
605 void acpi_ut_print_string(char *string, u16 max_length);
606 
607 #if defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP
608 void ut_convert_backslashes(char *pathname);
609 #endif
610 
611 void acpi_ut_repair_name(char *name);
612 
613 #if defined (ACPI_DEBUGGER) || defined (ACPI_APPLICATION)
614 u8 acpi_ut_safe_strcpy(char *dest, acpi_size dest_size, char *source);
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 void ACPI_INTERNAL_VAR_XFACE
692 acpi_ut_predefined_warning(const char *module_name,
693 			   u32 line_number,
694 			   char *pathname,
695 			   u8 node_flags, const char *format, ...);
696 
697 void ACPI_INTERNAL_VAR_XFACE
698 acpi_ut_predefined_info(const char *module_name,
699 			u32 line_number,
700 			char *pathname, u8 node_flags, const char *format, ...);
701 
702 void ACPI_INTERNAL_VAR_XFACE
703 acpi_ut_predefined_bios_error(const char *module_name,
704 			      u32 line_number,
705 			      char *pathname,
706 			      u8 node_flags, const char *format, ...);
707 
708 void
709 acpi_ut_namespace_error(const char *module_name,
710 			u32 line_number,
711 			const char *internal_name, acpi_status lookup_status);
712 
713 void
714 acpi_ut_method_error(const char *module_name,
715 		     u32 line_number,
716 		     const char *message,
717 		     struct acpi_namespace_node *node,
718 		     const char *path, acpi_status lookup_status);
719 
720 /*
721  * Utility functions for ACPI names and IDs
722  */
723 const struct ah_predefined_name *acpi_ah_match_predefined_name(char *nameseg);
724 
725 const struct ah_device_id *acpi_ah_match_hardware_id(char *hid);
726 
727 const char *acpi_ah_match_uuid(u8 *data);
728 
729 /*
730  * utuuid -- UUID support functions
731  */
732 #if (defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP || defined ACPI_HELP_APP)
733 void acpi_ut_convert_string_to_uuid(char *in_string, u8 *uuid_buffer);
734 #endif
735 
736 #endif				/* _ACUTILS_H */
737