[go: nahoru, domu]

1/******************************************************************************
2 *
3 * Name: acutils.h -- prototypes for the common (subsystem-wide) procedures
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2014, 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
47extern const u8 acpi_gbl_resource_aml_sizes[];
48extern 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
54extern const char *acpi_gbl_bm_decode[];
55extern const char *acpi_gbl_config_decode[];
56extern const char *acpi_gbl_consume_decode[];
57extern const char *acpi_gbl_dec_decode[];
58extern const char *acpi_gbl_he_decode[];
59extern const char *acpi_gbl_io_decode[];
60extern const char *acpi_gbl_ll_decode[];
61extern const char *acpi_gbl_max_decode[];
62extern const char *acpi_gbl_mem_decode[];
63extern const char *acpi_gbl_min_decode[];
64extern const char *acpi_gbl_mtp_decode[];
65extern const char *acpi_gbl_rng_decode[];
66extern const char *acpi_gbl_rw_decode[];
67extern const char *acpi_gbl_shr_decode[];
68extern const char *acpi_gbl_siz_decode[];
69extern const char *acpi_gbl_trs_decode[];
70extern const char *acpi_gbl_ttp_decode[];
71extern const char *acpi_gbl_typ_decode[];
72extern const char *acpi_gbl_ppc_decode[];
73extern const char *acpi_gbl_ior_decode[];
74extern const char *acpi_gbl_dts_decode[];
75extern const char *acpi_gbl_ct_decode[];
76extern const char *acpi_gbl_sbt_decode[];
77extern const char *acpi_gbl_am_decode[];
78extern const char *acpi_gbl_sm_decode[];
79extern const char *acpi_gbl_wm_decode[];
80extern const char *acpi_gbl_cph_decode[];
81extern const char *acpi_gbl_cpo_decode[];
82extern const char *acpi_gbl_dp_decode[];
83extern const char *acpi_gbl_ed_decode[];
84extern const char *acpi_gbl_bpb_decode[];
85extern const char *acpi_gbl_sb_decode[];
86extern const char *acpi_gbl_fc_decode[];
87extern 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#define ACPI_MSG_ERROR          "ACPI Error: "
118#define ACPI_MSG_EXCEPTION      "ACPI Exception: "
119#define ACPI_MSG_WARNING        "ACPI Warning: "
120#define ACPI_MSG_INFO           "ACPI: "
121
122#define ACPI_MSG_BIOS_ERROR     "ACPI BIOS Error (bug): "
123#define ACPI_MSG_BIOS_WARNING   "ACPI BIOS Warning (bug): "
124
125/*
126 * Common message suffix
127 */
128#define ACPI_MSG_SUFFIX \
129	acpi_os_printf (" (%8.8X/%s-%u)\n", ACPI_CA_VERSION, module_name, line_number)
130
131/* Types for Resource descriptor entries */
132
133#define ACPI_INVALID_RESOURCE           0
134#define ACPI_FIXED_LENGTH               1
135#define ACPI_VARIABLE_LENGTH            2
136#define ACPI_SMALL_VARIABLE_LENGTH      3
137
138typedef
139acpi_status(*acpi_walk_aml_callback) (u8 *aml,
140				      u32 length,
141				      u32 offset,
142				      u8 resource_index, void **context);
143
144typedef
145acpi_status(*acpi_pkg_callback) (u8 object_type,
146				 union acpi_operand_object *source_object,
147				 union acpi_generic_state * state,
148				 void *context);
149
150struct acpi_pkg_info {
151	u8 *free_space;
152	acpi_size length;
153	u32 object_space;
154	u32 num_packages;
155};
156
157/* Object reference counts */
158
159#define REF_INCREMENT       (u16) 0
160#define REF_DECREMENT       (u16) 1
161
162/* acpi_ut_dump_buffer */
163
164#define DB_BYTE_DISPLAY     1
165#define DB_WORD_DISPLAY     2
166#define DB_DWORD_DISPLAY    4
167#define DB_QWORD_DISPLAY    8
168
169/*
170 * utglobal - Global data structures and procedures
171 */
172acpi_status acpi_ut_init_globals(void);
173
174#if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
175
176char *acpi_ut_get_mutex_name(u32 mutex_id);
177
178const char *acpi_ut_get_notify_name(u32 notify_value, acpi_object_type type);
179#endif
180
181char *acpi_ut_get_type_name(acpi_object_type type);
182
183char *acpi_ut_get_node_name(void *object);
184
185char *acpi_ut_get_descriptor_name(void *object);
186
187const char *acpi_ut_get_reference_name(union acpi_operand_object *object);
188
189char *acpi_ut_get_object_type_name(union acpi_operand_object *obj_desc);
190
191char *acpi_ut_get_region_name(u8 space_id);
192
193char *acpi_ut_get_event_name(u32 event_id);
194
195char acpi_ut_hex_to_ascii_char(u64 integer, u32 position);
196
197u8 acpi_ut_ascii_char_to_hex(int hex_char);
198
199u8 acpi_ut_valid_object_type(acpi_object_type type);
200
201/*
202 * utinit - miscellaneous initialization and shutdown
203 */
204acpi_status acpi_ut_hardware_initialize(void);
205
206void acpi_ut_subsystem_shutdown(void);
207
208/*
209 * utclib - Local implementations of C library functions
210 */
211#ifndef ACPI_USE_SYSTEM_CLIBRARY
212
213acpi_size acpi_ut_strlen(const char *string);
214
215char *acpi_ut_strchr(const char *string, int ch);
216
217char *acpi_ut_strcpy(char *dst_string, const char *src_string);
218
219char *acpi_ut_strncpy(char *dst_string,
220		      const char *src_string, acpi_size count);
221
222int acpi_ut_memcmp(const char *buffer1, const char *buffer2, acpi_size count);
223
224int acpi_ut_strncmp(const char *string1, const char *string2, acpi_size count);
225
226int acpi_ut_strcmp(const char *string1, const char *string2);
227
228char *acpi_ut_strcat(char *dst_string, const char *src_string);
229
230char *acpi_ut_strncat(char *dst_string,
231		      const char *src_string, acpi_size count);
232
233u32 acpi_ut_strtoul(const char *string, char **terminator, u32 base);
234
235char *acpi_ut_strstr(char *string1, char *string2);
236
237void *acpi_ut_memcpy(void *dest, const void *src, acpi_size count);
238
239void *acpi_ut_memset(void *dest, u8 value, acpi_size count);
240
241int acpi_ut_to_upper(int c);
242
243int acpi_ut_to_lower(int c);
244
245extern const u8 _acpi_ctype[];
246
247#define _ACPI_XA     0x00	/* extra alphabetic - not supported */
248#define _ACPI_XS     0x40	/* extra space */
249#define _ACPI_BB     0x00	/* BEL, BS, etc. - not supported */
250#define _ACPI_CN     0x20	/* CR, FF, HT, NL, VT */
251#define _ACPI_DI     0x04	/* '0'-'9' */
252#define _ACPI_LO     0x02	/* 'a'-'z' */
253#define _ACPI_PU     0x10	/* punctuation */
254#define _ACPI_SP     0x08	/* space */
255#define _ACPI_UP     0x01	/* 'A'-'Z' */
256#define _ACPI_XD     0x80	/* '0'-'9', 'A'-'F', 'a'-'f' */
257
258#define ACPI_IS_DIGIT(c)  (_acpi_ctype[(unsigned char)(c)] & (_ACPI_DI))
259#define ACPI_IS_SPACE(c)  (_acpi_ctype[(unsigned char)(c)] & (_ACPI_SP))
260#define ACPI_IS_XDIGIT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_XD))
261#define ACPI_IS_UPPER(c)  (_acpi_ctype[(unsigned char)(c)] & (_ACPI_UP))
262#define ACPI_IS_LOWER(c)  (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO))
263#define ACPI_IS_PRINT(c)  (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP | _ACPI_DI | _ACPI_XS | _ACPI_PU))
264#define ACPI_IS_ALPHA(c)  (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP))
265
266#endif				/* !ACPI_USE_SYSTEM_CLIBRARY */
267
268#define ACPI_IS_ASCII(c)  ((c) < 0x80)
269
270/*
271 * utcopy - Object construction and conversion interfaces
272 */
273acpi_status
274acpi_ut_build_simple_object(union acpi_operand_object *obj,
275			    union acpi_object *user_obj,
276			    u8 *data_space, u32 *buffer_space_used);
277
278acpi_status
279acpi_ut_build_package_object(union acpi_operand_object *obj,
280			     u8 *buffer, u32 *space_used);
281
282acpi_status
283acpi_ut_copy_iobject_to_eobject(union acpi_operand_object *obj,
284				struct acpi_buffer *ret_buffer);
285
286acpi_status
287acpi_ut_copy_eobject_to_iobject(union acpi_object *obj,
288				union acpi_operand_object **internal_obj);
289
290acpi_status
291acpi_ut_copy_isimple_to_isimple(union acpi_operand_object *source_obj,
292				union acpi_operand_object *dest_obj);
293
294acpi_status
295acpi_ut_copy_iobject_to_iobject(union acpi_operand_object *source_desc,
296				union acpi_operand_object **dest_desc,
297				struct acpi_walk_state *walk_state);
298
299/*
300 * utcreate - Object creation
301 */
302acpi_status
303acpi_ut_update_object_reference(union acpi_operand_object *object, u16 action);
304
305/*
306 * utdebug - Debug interfaces
307 */
308void acpi_ut_init_stack_ptr_trace(void);
309
310void acpi_ut_track_stack_ptr(void);
311
312void
313acpi_ut_trace(u32 line_number,
314	      const char *function_name,
315	      const char *module_name, u32 component_id);
316
317void
318acpi_ut_trace_ptr(u32 line_number,
319		  const char *function_name,
320		  const char *module_name, u32 component_id, void *pointer);
321
322void
323acpi_ut_trace_u32(u32 line_number,
324		  const char *function_name,
325		  const char *module_name, u32 component_id, u32 integer);
326
327void
328acpi_ut_trace_str(u32 line_number,
329		  const char *function_name,
330		  const char *module_name, u32 component_id, char *string);
331
332void
333acpi_ut_exit(u32 line_number,
334	     const char *function_name,
335	     const char *module_name, u32 component_id);
336
337void
338acpi_ut_status_exit(u32 line_number,
339		    const char *function_name,
340		    const char *module_name,
341		    u32 component_id, acpi_status status);
342
343void
344acpi_ut_value_exit(u32 line_number,
345		   const char *function_name,
346		   const char *module_name, u32 component_id, u64 value);
347
348void
349acpi_ut_ptr_exit(u32 line_number,
350		 const char *function_name,
351		 const char *module_name, u32 component_id, u8 *ptr);
352
353void
354acpi_ut_debug_dump_buffer(u8 *buffer, u32 count, u32 display, u32 component_id);
355
356void acpi_ut_dump_buffer(u8 *buffer, u32 count, u32 display, u32 offset);
357
358#ifdef ACPI_APPLICATION
359void
360acpi_ut_dump_buffer_to_file(ACPI_FILE file,
361			    u8 *buffer,
362			    u32 count, u32 display, u32 base_offset);
363#endif
364
365void acpi_ut_report_error(char *module_name, u32 line_number);
366
367void acpi_ut_report_info(char *module_name, u32 line_number);
368
369void acpi_ut_report_warning(char *module_name, u32 line_number);
370
371/*
372 * utdelete - Object deletion and reference counts
373 */
374void acpi_ut_add_reference(union acpi_operand_object *object);
375
376void acpi_ut_remove_reference(union acpi_operand_object *object);
377
378void acpi_ut_delete_internal_package_object(union acpi_operand_object *object);
379
380void acpi_ut_delete_internal_simple_object(union acpi_operand_object *object);
381
382void acpi_ut_delete_internal_object_list(union acpi_operand_object **obj_list);
383
384/*
385 * uteval - object evaluation
386 */
387acpi_status
388acpi_ut_evaluate_object(struct acpi_namespace_node *prefix_node,
389			char *path,
390			u32 expected_return_btypes,
391			union acpi_operand_object **return_desc);
392
393acpi_status
394acpi_ut_evaluate_numeric_object(char *object_name,
395				struct acpi_namespace_node *device_node,
396				u64 *value);
397
398acpi_status
399acpi_ut_execute_STA(struct acpi_namespace_node *device_node, u32 *status_flags);
400
401acpi_status
402acpi_ut_execute_power_methods(struct acpi_namespace_node *device_node,
403			      const char **method_names,
404			      u8 method_count, u8 *out_values);
405
406/*
407 * utfileio - file operations
408 */
409#ifdef ACPI_APPLICATION
410acpi_status
411acpi_ut_read_table_from_file(char *filename, struct acpi_table_header **table);
412#endif
413
414/*
415 * utids - device ID support
416 */
417acpi_status
418acpi_ut_execute_HID(struct acpi_namespace_node *device_node,
419		    struct acpi_pnp_device_id ** return_id);
420
421acpi_status
422acpi_ut_execute_UID(struct acpi_namespace_node *device_node,
423		    struct acpi_pnp_device_id ** return_id);
424
425acpi_status
426acpi_ut_execute_SUB(struct acpi_namespace_node *device_node,
427		    struct acpi_pnp_device_id **return_id);
428
429acpi_status
430acpi_ut_execute_CID(struct acpi_namespace_node *device_node,
431		    struct acpi_pnp_device_id_list ** return_cid_list);
432
433/*
434 * utlock - reader/writer locks
435 */
436acpi_status acpi_ut_create_rw_lock(struct acpi_rw_lock *lock);
437
438void acpi_ut_delete_rw_lock(struct acpi_rw_lock *lock);
439
440acpi_status acpi_ut_acquire_read_lock(struct acpi_rw_lock *lock);
441
442acpi_status acpi_ut_release_read_lock(struct acpi_rw_lock *lock);
443
444acpi_status acpi_ut_acquire_write_lock(struct acpi_rw_lock *lock);
445
446void acpi_ut_release_write_lock(struct acpi_rw_lock *lock);
447
448/*
449 * utobject - internal object create/delete/cache routines
450 */
451union acpi_operand_object *acpi_ut_create_internal_object_dbg(const char
452							      *module_name,
453							      u32 line_number,
454							      u32 component_id,
455							      acpi_object_type
456							      type);
457
458void *acpi_ut_allocate_object_desc_dbg(const char *module_name,
459				       u32 line_number, u32 component_id);
460
461#define acpi_ut_create_internal_object(t) acpi_ut_create_internal_object_dbg (_acpi_module_name,__LINE__,_COMPONENT,t)
462#define acpi_ut_allocate_object_desc()  acpi_ut_allocate_object_desc_dbg (_acpi_module_name,__LINE__,_COMPONENT)
463
464void acpi_ut_delete_object_desc(union acpi_operand_object *object);
465
466u8 acpi_ut_valid_internal_object(void *object);
467
468union acpi_operand_object *acpi_ut_create_package_object(u32 count);
469
470union acpi_operand_object *acpi_ut_create_integer_object(u64 value);
471
472union acpi_operand_object *acpi_ut_create_buffer_object(acpi_size buffer_size);
473
474union acpi_operand_object *acpi_ut_create_string_object(acpi_size string_size);
475
476acpi_status
477acpi_ut_get_object_size(union acpi_operand_object *obj, acpi_size * obj_length);
478
479/*
480 * utosi - Support for the _OSI predefined control method
481 */
482acpi_status acpi_ut_initialize_interfaces(void);
483
484acpi_status acpi_ut_interface_terminate(void);
485
486acpi_status acpi_ut_install_interface(acpi_string interface_name);
487
488acpi_status acpi_ut_remove_interface(acpi_string interface_name);
489
490acpi_status acpi_ut_update_interfaces(u8 action);
491
492struct acpi_interface_info *acpi_ut_get_interface(acpi_string interface_name);
493
494acpi_status acpi_ut_osi_implementation(struct acpi_walk_state *walk_state);
495
496/*
497 * utpredef - support for predefined names
498 */
499const union acpi_predefined_info *acpi_ut_get_next_predefined_method(const union
500								     acpi_predefined_info
501								     *this_name);
502
503const union acpi_predefined_info *acpi_ut_match_predefined_method(char *name);
504
505const union acpi_predefined_info *acpi_ut_match_resource_name(char *name);
506
507void
508acpi_ut_display_predefined_method(char *buffer,
509				  const union acpi_predefined_info *this_name,
510				  u8 multi_line);
511
512void acpi_ut_get_expected_return_types(char *buffer, u32 expected_btypes);
513
514u32 acpi_ut_get_resource_bit_width(char *buffer, u16 types);
515
516/*
517 * utstate - Generic state creation/cache routines
518 */
519void
520acpi_ut_push_generic_state(union acpi_generic_state **list_head,
521			   union acpi_generic_state *state);
522
523union acpi_generic_state *acpi_ut_pop_generic_state(union acpi_generic_state
524						    **list_head);
525
526union acpi_generic_state *acpi_ut_create_generic_state(void);
527
528struct acpi_thread_state *acpi_ut_create_thread_state(void);
529
530union acpi_generic_state *acpi_ut_create_update_state(union acpi_operand_object
531						      *object, u16 action);
532
533union acpi_generic_state *acpi_ut_create_pkg_state(void *internal_object,
534						   void *external_object,
535						   u16 index);
536
537acpi_status
538acpi_ut_create_update_state_and_push(union acpi_operand_object *object,
539				     u16 action,
540				     union acpi_generic_state **state_list);
541
542#ifdef	ACPI_FUTURE_USAGE
543acpi_status
544acpi_ut_create_pkg_state_and_push(void *internal_object,
545				  void *external_object,
546				  u16 index,
547				  union acpi_generic_state **state_list);
548#endif				/* ACPI_FUTURE_USAGE */
549
550union acpi_generic_state *acpi_ut_create_control_state(void);
551
552void acpi_ut_delete_generic_state(union acpi_generic_state *state);
553
554/*
555 * utmath
556 */
557acpi_status
558acpi_ut_divide(u64 in_dividend,
559	       u64 in_divisor, u64 *out_quotient, u64 *out_remainder);
560
561acpi_status
562acpi_ut_short_divide(u64 in_dividend,
563		     u32 divisor, u64 *out_quotient, u32 *out_remainder);
564
565/*
566 * utmisc
567 */
568const struct acpi_exception_info *acpi_ut_validate_exception(acpi_status
569							     status);
570
571u8 acpi_ut_is_pci_root_bridge(char *id);
572
573u8 acpi_ut_is_aml_table(struct acpi_table_header *table);
574
575acpi_status
576acpi_ut_walk_package_tree(union acpi_operand_object *source_object,
577			  void *target_object,
578			  acpi_pkg_callback walk_callback, void *context);
579
580/* Values for Base above (16=Hex, 10=Decimal) */
581
582#define ACPI_ANY_BASE        0
583
584u32 acpi_ut_dword_byte_swap(u32 value);
585
586void acpi_ut_set_integer_width(u8 revision);
587
588#ifdef ACPI_DEBUG_OUTPUT
589void
590acpi_ut_display_init_pathname(u8 type,
591			      struct acpi_namespace_node *obj_handle,
592			      char *path);
593#endif
594
595/*
596 * utownerid - Support for Table/Method Owner IDs
597 */
598acpi_status acpi_ut_allocate_owner_id(acpi_owner_id * owner_id);
599
600void acpi_ut_release_owner_id(acpi_owner_id * owner_id);
601
602/*
603 * utresrc
604 */
605acpi_status
606acpi_ut_walk_aml_resources(struct acpi_walk_state *walk_state,
607			   u8 *aml,
608			   acpi_size aml_length,
609			   acpi_walk_aml_callback user_function,
610			   void **context);
611
612acpi_status
613acpi_ut_validate_resource(struct acpi_walk_state *walk_state,
614			  void *aml, u8 *return_index);
615
616u32 acpi_ut_get_descriptor_length(void *aml);
617
618u16 acpi_ut_get_resource_length(void *aml);
619
620u8 acpi_ut_get_resource_header_length(void *aml);
621
622u8 acpi_ut_get_resource_type(void *aml);
623
624acpi_status
625acpi_ut_get_resource_end_tag(union acpi_operand_object *obj_desc, u8 **end_tag);
626
627/*
628 * utstring - String and character utilities
629 */
630void acpi_ut_strupr(char *src_string);
631
632void acpi_ut_strlwr(char *src_string);
633
634int acpi_ut_stricmp(char *string1, char *string2);
635
636acpi_status acpi_ut_strtoul64(char *string, u32 base, u64 *ret_integer);
637
638void acpi_ut_print_string(char *string, u16 max_length);
639
640void ut_convert_backslashes(char *pathname);
641
642u8 acpi_ut_valid_acpi_name(char *name);
643
644u8 acpi_ut_valid_acpi_char(char character, u32 position);
645
646void acpi_ut_repair_name(char *name);
647
648#if defined (ACPI_DEBUGGER) || defined (ACPI_APPLICATION)
649u8 acpi_ut_safe_strcpy(char *dest, acpi_size dest_size, char *source);
650
651u8 acpi_ut_safe_strcat(char *dest, acpi_size dest_size, char *source);
652
653u8
654acpi_ut_safe_strncat(char *dest,
655		     acpi_size dest_size,
656		     char *source, acpi_size max_transfer_length);
657#endif
658
659/*
660 * utmutex - mutex support
661 */
662acpi_status acpi_ut_mutex_initialize(void);
663
664void acpi_ut_mutex_terminate(void);
665
666acpi_status acpi_ut_acquire_mutex(acpi_mutex_handle mutex_id);
667
668acpi_status acpi_ut_release_mutex(acpi_mutex_handle mutex_id);
669
670/*
671 * utalloc - memory allocation and object caching
672 */
673acpi_status acpi_ut_create_caches(void);
674
675acpi_status acpi_ut_delete_caches(void);
676
677acpi_status acpi_ut_validate_buffer(struct acpi_buffer *buffer);
678
679acpi_status
680acpi_ut_initialize_buffer(struct acpi_buffer *buffer,
681			  acpi_size required_length);
682
683#ifdef ACPI_DBG_TRACK_ALLOCATIONS
684void *acpi_ut_allocate_and_track(acpi_size size,
685				 u32 component, const char *module, u32 line);
686
687void *acpi_ut_allocate_zeroed_and_track(acpi_size size,
688					u32 component,
689					const char *module, u32 line);
690
691void
692acpi_ut_free_and_track(void *address,
693		       u32 component, const char *module, u32 line);
694
695#ifdef	ACPI_FUTURE_USAGE
696void acpi_ut_dump_allocation_info(void);
697#endif				/* ACPI_FUTURE_USAGE */
698
699void acpi_ut_dump_allocations(u32 component, const char *module);
700
701acpi_status
702acpi_ut_create_list(char *list_name,
703		    u16 object_size, struct acpi_memory_list **return_cache);
704
705#endif				/* ACPI_DBG_TRACK_ALLOCATIONS */
706
707/*
708 * utaddress - address range check
709 */
710acpi_status
711acpi_ut_add_address_range(acpi_adr_space_type space_id,
712			  acpi_physical_address address,
713			  u32 length, struct acpi_namespace_node *region_node);
714
715void
716acpi_ut_remove_address_range(acpi_adr_space_type space_id,
717			     struct acpi_namespace_node *region_node);
718
719u32
720acpi_ut_check_address_range(acpi_adr_space_type space_id,
721			    acpi_physical_address address, u32 length, u8 warn);
722
723void acpi_ut_delete_address_lists(void);
724
725/*
726 * utxferror - various error/warning output functions
727 */
728void ACPI_INTERNAL_VAR_XFACE
729acpi_ut_predefined_warning(const char *module_name,
730			   u32 line_number,
731			   char *pathname,
732			   u8 node_flags, const char *format, ...);
733
734void ACPI_INTERNAL_VAR_XFACE
735acpi_ut_predefined_info(const char *module_name,
736			u32 line_number,
737			char *pathname, u8 node_flags, const char *format, ...);
738
739void ACPI_INTERNAL_VAR_XFACE
740acpi_ut_predefined_bios_error(const char *module_name,
741			      u32 line_number,
742			      char *pathname,
743			      u8 node_flags, const char *format, ...);
744
745void
746acpi_ut_namespace_error(const char *module_name,
747			u32 line_number,
748			const char *internal_name, acpi_status lookup_status);
749
750void
751acpi_ut_method_error(const char *module_name,
752		     u32 line_number,
753		     const char *message,
754		     struct acpi_namespace_node *node,
755		     const char *path, acpi_status lookup_status);
756
757/*
758 * Utility functions for ACPI names and IDs
759 */
760const struct ah_predefined_name *acpi_ah_match_predefined_name(char *nameseg);
761
762const struct ah_device_id *acpi_ah_match_hardware_id(char *hid);
763
764const char *acpi_ah_match_uuid(u8 *data);
765
766/*
767 * utprint - printf/vprintf output functions
768 */
769const char *acpi_ut_scan_number(const char *string, u64 *number_ptr);
770
771const char *acpi_ut_print_number(char *string, u64 number);
772
773int
774acpi_ut_vsnprintf(char *string,
775		  acpi_size size, const char *format, va_list args);
776
777int acpi_ut_snprintf(char *string, acpi_size size, const char *format, ...);
778
779#ifdef ACPI_APPLICATION
780int acpi_ut_file_vprintf(ACPI_FILE file, const char *format, va_list args);
781
782int acpi_ut_file_printf(ACPI_FILE file, const char *format, ...);
783#endif
784
785/*
786 * utuuid -- UUID support functions
787 */
788void acpi_ut_convert_string_to_uuid(char *in_string, u8 *uuid_buffer);
789
790#endif				/* _ACUTILS_H */
791