xref: /openbmc/linux/drivers/acpi/acpica/acutils.h (revision 79f08d9e)
1 /******************************************************************************
2  *
3  * Name: acutils.h -- prototypes for the common (subsystem-wide) procedures
4  *
5  *****************************************************************************/
6 
7 /*
8  * Copyright (C) 2000 - 2013, 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_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 extern FILE *acpi_gbl_output_file;
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 #define ACPI_MSG_ERROR          "ACPI Error: "
119 #define ACPI_MSG_EXCEPTION      "ACPI Exception: "
120 #define ACPI_MSG_WARNING        "ACPI Warning: "
121 #define ACPI_MSG_INFO           "ACPI: "
122 
123 #define ACPI_MSG_BIOS_ERROR     "ACPI BIOS Error (bug): "
124 #define ACPI_MSG_BIOS_WARNING   "ACPI BIOS Warning (bug): "
125 
126 /*
127  * Common message suffix
128  */
129 #define ACPI_MSG_SUFFIX \
130 	acpi_os_printf (" (%8.8X/%s-%u)\n", ACPI_CA_VERSION, module_name, line_number)
131 
132 /* Types for Resource descriptor entries */
133 
134 #define ACPI_INVALID_RESOURCE           0
135 #define ACPI_FIXED_LENGTH               1
136 #define ACPI_VARIABLE_LENGTH            2
137 #define ACPI_SMALL_VARIABLE_LENGTH      3
138 
139 typedef
140 acpi_status(*acpi_walk_aml_callback) (u8 *aml,
141 				      u32 length,
142 				      u32 offset,
143 				      u8 resource_index, void **context);
144 
145 typedef
146 acpi_status(*acpi_pkg_callback) (u8 object_type,
147 				 union acpi_operand_object *source_object,
148 				 union acpi_generic_state * state,
149 				 void *context);
150 
151 struct acpi_pkg_info {
152 	u8 *free_space;
153 	acpi_size length;
154 	u32 object_space;
155 	u32 num_packages;
156 };
157 
158 /* Object reference counts */
159 
160 #define REF_INCREMENT       (u16) 0
161 #define REF_DECREMENT       (u16) 1
162 
163 /* acpi_ut_dump_buffer */
164 
165 #define DB_BYTE_DISPLAY     1
166 #define DB_WORD_DISPLAY     2
167 #define DB_DWORD_DISPLAY    4
168 #define DB_QWORD_DISPLAY    8
169 
170 /*
171  * utglobal - Global data structures and procedures
172  */
173 acpi_status acpi_ut_init_globals(void);
174 
175 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
176 
177 char *acpi_ut_get_mutex_name(u32 mutex_id);
178 
179 const char *acpi_ut_get_notify_name(u32 notify_value);
180 
181 #endif
182 
183 char *acpi_ut_get_type_name(acpi_object_type type);
184 
185 char *acpi_ut_get_node_name(void *object);
186 
187 char *acpi_ut_get_descriptor_name(void *object);
188 
189 const char *acpi_ut_get_reference_name(union acpi_operand_object *object);
190 
191 char *acpi_ut_get_object_type_name(union acpi_operand_object *obj_desc);
192 
193 char *acpi_ut_get_region_name(u8 space_id);
194 
195 char *acpi_ut_get_event_name(u32 event_id);
196 
197 char acpi_ut_hex_to_ascii_char(u64 integer, u32 position);
198 
199 u8 acpi_ut_valid_object_type(acpi_object_type type);
200 
201 /*
202  * utinit - miscellaneous initialization and shutdown
203  */
204 acpi_status acpi_ut_hardware_initialize(void);
205 
206 void acpi_ut_subsystem_shutdown(void);
207 
208 /*
209  * utclib - Local implementations of C library functions
210  */
211 #ifndef ACPI_USE_SYSTEM_CLIBRARY
212 
213 acpi_size acpi_ut_strlen(const char *string);
214 
215 char *acpi_ut_strcpy(char *dst_string, const char *src_string);
216 
217 char *acpi_ut_strncpy(char *dst_string,
218 		      const char *src_string, acpi_size count);
219 
220 int acpi_ut_memcmp(const char *buffer1, const char *buffer2, acpi_size count);
221 
222 int acpi_ut_strncmp(const char *string1, const char *string2, acpi_size count);
223 
224 int acpi_ut_strcmp(const char *string1, const char *string2);
225 
226 char *acpi_ut_strcat(char *dst_string, const char *src_string);
227 
228 char *acpi_ut_strncat(char *dst_string,
229 		      const char *src_string, acpi_size count);
230 
231 u32 acpi_ut_strtoul(const char *string, char **terminator, u32 base);
232 
233 char *acpi_ut_strstr(char *string1, char *string2);
234 
235 void *acpi_ut_memcpy(void *dest, const void *src, acpi_size count);
236 
237 void *acpi_ut_memset(void *dest, u8 value, acpi_size count);
238 
239 int acpi_ut_to_upper(int c);
240 
241 int acpi_ut_to_lower(int c);
242 
243 extern const u8 _acpi_ctype[];
244 
245 #define _ACPI_XA     0x00	/* extra alphabetic - not supported */
246 #define _ACPI_XS     0x40	/* extra space */
247 #define _ACPI_BB     0x00	/* BEL, BS, etc. - not supported */
248 #define _ACPI_CN     0x20	/* CR, FF, HT, NL, VT */
249 #define _ACPI_DI     0x04	/* '0'-'9' */
250 #define _ACPI_LO     0x02	/* 'a'-'z' */
251 #define _ACPI_PU     0x10	/* punctuation */
252 #define _ACPI_SP     0x08	/* space */
253 #define _ACPI_UP     0x01	/* 'A'-'Z' */
254 #define _ACPI_XD     0x80	/* '0'-'9', 'A'-'F', 'a'-'f' */
255 
256 #define ACPI_IS_DIGIT(c)  (_acpi_ctype[(unsigned char)(c)] & (_ACPI_DI))
257 #define ACPI_IS_SPACE(c)  (_acpi_ctype[(unsigned char)(c)] & (_ACPI_SP))
258 #define ACPI_IS_XDIGIT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_XD))
259 #define ACPI_IS_UPPER(c)  (_acpi_ctype[(unsigned char)(c)] & (_ACPI_UP))
260 #define ACPI_IS_LOWER(c)  (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO))
261 #define ACPI_IS_PRINT(c)  (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP | _ACPI_DI | _ACPI_SP | _ACPI_PU))
262 #define ACPI_IS_ALPHA(c)  (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP))
263 
264 #endif				/* !ACPI_USE_SYSTEM_CLIBRARY */
265 
266 #define ACPI_IS_ASCII(c)  ((c) < 0x80)
267 
268 /*
269  * utcopy - Object construction and conversion interfaces
270  */
271 acpi_status
272 acpi_ut_build_simple_object(union acpi_operand_object *obj,
273 			    union acpi_object *user_obj,
274 			    u8 *data_space, u32 *buffer_space_used);
275 
276 acpi_status
277 acpi_ut_build_package_object(union acpi_operand_object *obj,
278 			     u8 *buffer, u32 *space_used);
279 
280 acpi_status
281 acpi_ut_copy_iobject_to_eobject(union acpi_operand_object *obj,
282 				struct acpi_buffer *ret_buffer);
283 
284 acpi_status
285 acpi_ut_copy_eobject_to_iobject(union acpi_object *obj,
286 				union acpi_operand_object **internal_obj);
287 
288 acpi_status
289 acpi_ut_copy_isimple_to_isimple(union acpi_operand_object *source_obj,
290 				union acpi_operand_object *dest_obj);
291 
292 acpi_status
293 acpi_ut_copy_iobject_to_iobject(union acpi_operand_object *source_desc,
294 				union acpi_operand_object **dest_desc,
295 				struct acpi_walk_state *walk_state);
296 
297 /*
298  * utcreate - Object creation
299  */
300 acpi_status
301 acpi_ut_update_object_reference(union acpi_operand_object *object, u16 action);
302 
303 /*
304  * utdebug - Debug interfaces
305  */
306 void acpi_ut_init_stack_ptr_trace(void);
307 
308 void acpi_ut_track_stack_ptr(void);
309 
310 void
311 acpi_ut_trace(u32 line_number,
312 	      const char *function_name,
313 	      const char *module_name, u32 component_id);
314 
315 void
316 acpi_ut_trace_ptr(u32 line_number,
317 		  const char *function_name,
318 		  const char *module_name, u32 component_id, void *pointer);
319 
320 void
321 acpi_ut_trace_u32(u32 line_number,
322 		  const char *function_name,
323 		  const char *module_name, u32 component_id, u32 integer);
324 
325 void
326 acpi_ut_trace_str(u32 line_number,
327 		  const char *function_name,
328 		  const char *module_name, u32 component_id, char *string);
329 
330 void
331 acpi_ut_exit(u32 line_number,
332 	     const char *function_name,
333 	     const char *module_name, u32 component_id);
334 
335 void
336 acpi_ut_status_exit(u32 line_number,
337 		    const char *function_name,
338 		    const char *module_name,
339 		    u32 component_id, acpi_status status);
340 
341 void
342 acpi_ut_value_exit(u32 line_number,
343 		   const char *function_name,
344 		   const char *module_name, u32 component_id, u64 value);
345 
346 void
347 acpi_ut_ptr_exit(u32 line_number,
348 		 const char *function_name,
349 		 const char *module_name, u32 component_id, u8 *ptr);
350 
351 void
352 acpi_ut_debug_dump_buffer(u8 *buffer, u32 count, u32 display, u32 component_id);
353 
354 void acpi_ut_dump_buffer(u8 *buffer, u32 count, u32 display, u32 offset);
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 			char *path,
381 			u32 expected_return_btypes,
382 			union acpi_operand_object **return_desc);
383 
384 acpi_status
385 acpi_ut_evaluate_numeric_object(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_SUB(struct acpi_namespace_node *device_node,
410 		    struct acpi_pnp_device_id **return_id);
411 
412 acpi_status
413 acpi_ut_execute_CID(struct acpi_namespace_node *device_node,
414 		    struct acpi_pnp_device_id_list ** return_cid_list);
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 const union acpi_predefined_info *acpi_ut_match_resource_name(char *name);
489 
490 void
491 acpi_ut_display_predefined_method(char *buffer,
492 				  const union acpi_predefined_info *this_name,
493 				  u8 multi_line);
494 
495 void acpi_ut_get_expected_return_types(char *buffer, u32 expected_btypes);
496 
497 u32 acpi_ut_get_resource_bit_width(char *buffer, u16 types);
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 #ifdef	ACPI_FUTURE_USAGE
526 acpi_status
527 acpi_ut_create_pkg_state_and_push(void *internal_object,
528 				  void *external_object,
529 				  u16 index,
530 				  union acpi_generic_state **state_list);
531 #endif				/* ACPI_FUTURE_USAGE */
532 
533 union acpi_generic_state *acpi_ut_create_control_state(void);
534 
535 void acpi_ut_delete_generic_state(union acpi_generic_state *state);
536 
537 /*
538  * utmath
539  */
540 acpi_status
541 acpi_ut_divide(u64 in_dividend,
542 	       u64 in_divisor, u64 *out_quotient, u64 *out_remainder);
543 
544 acpi_status
545 acpi_ut_short_divide(u64 in_dividend,
546 		     u32 divisor, u64 *out_quotient, u32 *out_remainder);
547 
548 /*
549  * utmisc
550  */
551 const struct acpi_exception_info *acpi_ut_validate_exception(acpi_status
552 							     status);
553 
554 u8 acpi_ut_is_pci_root_bridge(char *id);
555 
556 u8 acpi_ut_is_aml_table(struct acpi_table_header *table);
557 
558 acpi_status
559 acpi_ut_walk_package_tree(union acpi_operand_object *source_object,
560 			  void *target_object,
561 			  acpi_pkg_callback walk_callback, void *context);
562 
563 /* Values for Base above (16=Hex, 10=Decimal) */
564 
565 #define ACPI_ANY_BASE        0
566 
567 u32 acpi_ut_dword_byte_swap(u32 value);
568 
569 void acpi_ut_set_integer_width(u8 revision);
570 
571 #ifdef ACPI_DEBUG_OUTPUT
572 void
573 acpi_ut_display_init_pathname(u8 type,
574 			      struct acpi_namespace_node *obj_handle,
575 			      char *path);
576 #endif
577 
578 /*
579  * utownerid - Support for Table/Method Owner IDs
580  */
581 acpi_status acpi_ut_allocate_owner_id(acpi_owner_id * owner_id);
582 
583 void acpi_ut_release_owner_id(acpi_owner_id * owner_id);
584 
585 /*
586  * utresrc
587  */
588 acpi_status
589 acpi_ut_walk_aml_resources(struct acpi_walk_state *walk_state,
590 			   u8 *aml,
591 			   acpi_size aml_length,
592 			   acpi_walk_aml_callback user_function,
593 			   void **context);
594 
595 acpi_status
596 acpi_ut_validate_resource(struct acpi_walk_state *walk_state,
597 			  void *aml, u8 *return_index);
598 
599 u32 acpi_ut_get_descriptor_length(void *aml);
600 
601 u16 acpi_ut_get_resource_length(void *aml);
602 
603 u8 acpi_ut_get_resource_header_length(void *aml);
604 
605 u8 acpi_ut_get_resource_type(void *aml);
606 
607 acpi_status
608 acpi_ut_get_resource_end_tag(union acpi_operand_object *obj_desc, u8 **end_tag);
609 
610 /*
611  * utstring - String and character utilities
612  */
613 void acpi_ut_strupr(char *src_string);
614 
615 void acpi_ut_strlwr(char *src_string);
616 
617 int acpi_ut_stricmp(char *string1, char *string2);
618 
619 acpi_status acpi_ut_strtoul64(char *string, u32 base, u64 *ret_integer);
620 
621 void acpi_ut_print_string(char *string, u16 max_length);
622 
623 void ut_convert_backslashes(char *pathname);
624 
625 u8 acpi_ut_valid_acpi_name(char *name);
626 
627 u8 acpi_ut_valid_acpi_char(char character, u32 position);
628 
629 void acpi_ut_repair_name(char *name);
630 
631 #if defined (ACPI_DEBUGGER) || defined (ACPI_APPLICATION)
632 u8 acpi_ut_safe_strcpy(char *dest, acpi_size dest_size, char *source);
633 
634 u8 acpi_ut_safe_strcat(char *dest, acpi_size dest_size, char *source);
635 
636 u8
637 acpi_ut_safe_strncat(char *dest,
638 		     acpi_size dest_size,
639 		     char *source, acpi_size max_transfer_length);
640 #endif
641 
642 /*
643  * utmutex - mutex support
644  */
645 acpi_status acpi_ut_mutex_initialize(void);
646 
647 void acpi_ut_mutex_terminate(void);
648 
649 acpi_status acpi_ut_acquire_mutex(acpi_mutex_handle mutex_id);
650 
651 acpi_status acpi_ut_release_mutex(acpi_mutex_handle mutex_id);
652 
653 /*
654  * utalloc - memory allocation and object caching
655  */
656 acpi_status acpi_ut_create_caches(void);
657 
658 acpi_status acpi_ut_delete_caches(void);
659 
660 acpi_status acpi_ut_validate_buffer(struct acpi_buffer *buffer);
661 
662 acpi_status
663 acpi_ut_initialize_buffer(struct acpi_buffer *buffer,
664 			  acpi_size required_length);
665 
666 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
667 void *acpi_ut_allocate_and_track(acpi_size size,
668 				 u32 component, const char *module, u32 line);
669 
670 void *acpi_ut_allocate_zeroed_and_track(acpi_size size,
671 					u32 component,
672 					const char *module, u32 line);
673 
674 void
675 acpi_ut_free_and_track(void *address,
676 		       u32 component, const char *module, u32 line);
677 
678 #ifdef	ACPI_FUTURE_USAGE
679 void acpi_ut_dump_allocation_info(void);
680 #endif				/* ACPI_FUTURE_USAGE */
681 
682 void acpi_ut_dump_allocations(u32 component, const char *module);
683 
684 acpi_status
685 acpi_ut_create_list(char *list_name,
686 		    u16 object_size, struct acpi_memory_list **return_cache);
687 
688 #endif				/* ACPI_DBG_TRACK_ALLOCATIONS */
689 
690 /*
691  * utaddress - address range check
692  */
693 acpi_status
694 acpi_ut_add_address_range(acpi_adr_space_type space_id,
695 			  acpi_physical_address address,
696 			  u32 length, struct acpi_namespace_node *region_node);
697 
698 void
699 acpi_ut_remove_address_range(acpi_adr_space_type space_id,
700 			     struct acpi_namespace_node *region_node);
701 
702 u32
703 acpi_ut_check_address_range(acpi_adr_space_type space_id,
704 			    acpi_physical_address address, u32 length, u8 warn);
705 
706 void acpi_ut_delete_address_lists(void);
707 
708 /*
709  * utxferror - various error/warning output functions
710  */
711 void ACPI_INTERNAL_VAR_XFACE
712 acpi_ut_predefined_warning(const char *module_name,
713 			   u32 line_number,
714 			   char *pathname,
715 			   u8 node_flags, const char *format, ...);
716 
717 void ACPI_INTERNAL_VAR_XFACE
718 acpi_ut_predefined_info(const char *module_name,
719 			u32 line_number,
720 			char *pathname, u8 node_flags, const char *format, ...);
721 
722 void ACPI_INTERNAL_VAR_XFACE
723 acpi_ut_predefined_bios_error(const char *module_name,
724 			      u32 line_number,
725 			      char *pathname,
726 			      u8 node_flags, const char *format, ...);
727 
728 void
729 acpi_ut_namespace_error(const char *module_name,
730 			u32 line_number,
731 			const char *internal_name, acpi_status lookup_status);
732 
733 void
734 acpi_ut_method_error(const char *module_name,
735 		     u32 line_number,
736 		     const char *message,
737 		     struct acpi_namespace_node *node,
738 		     const char *path, acpi_status lookup_status);
739 
740 #endif				/* _ACUTILS_H */
741