1 /******************************************************************************
3 * Name: acutils.h -- prototypes for the common (subsystem-wide) procedures
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2005, R. Byron Moore
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
47 extern const u8 acpi_gbl_resource_aml_sizes[];
49 /* Strings used by the disassembler and debugger resource dump routines */
51 #if defined(ACPI_DISASSEMBLER) || defined (ACPI_DEBUGGER)
53 extern const char *acpi_gbl_BMdecode[2];
54 extern const char *acpi_gbl_config_decode[4];
55 extern const char *acpi_gbl_consume_decode[2];
56 extern const char *acpi_gbl_DECdecode[2];
57 extern const char *acpi_gbl_HEdecode[2];
58 extern const char *acpi_gbl_io_decode[2];
59 extern const char *acpi_gbl_LLdecode[2];
60 extern const char *acpi_gbl_max_decode[2];
61 extern const char *acpi_gbl_MEMdecode[4];
62 extern const char *acpi_gbl_min_decode[2];
63 extern const char *acpi_gbl_MTPdecode[4];
64 extern const char *acpi_gbl_RNGdecode[4];
65 extern const char *acpi_gbl_RWdecode[2];
66 extern const char *acpi_gbl_SHRdecode[2];
67 extern const char *acpi_gbl_SIZdecode[4];
68 extern const char *acpi_gbl_TRSdecode[2];
69 extern const char *acpi_gbl_TTPdecode[2];
70 extern const char *acpi_gbl_TYPdecode[4];
73 /* Types for Resource descriptor entries */
75 #define ACPI_INVALID_RESOURCE 0
76 #define ACPI_FIXED_LENGTH 1
77 #define ACPI_VARIABLE_LENGTH 2
78 #define ACPI_SMALL_VARIABLE_LENGTH 3
81 acpi_status(*acpi_pkg_callback) (u8 object_type,
82 union acpi_operand_object * source_object,
83 union acpi_generic_state * state,
86 struct acpi_pkg_info {
93 #define REF_INCREMENT (u16) 0
94 #define REF_DECREMENT (u16) 1
95 #define REF_FORCE_DELETE (u16) 2
97 /* acpi_ut_dump_buffer */
99 #define DB_BYTE_DISPLAY 1
100 #define DB_WORD_DISPLAY 2
101 #define DB_DWORD_DISPLAY 4
102 #define DB_QWORD_DISPLAY 8
105 * utglobal - Global data structures and procedures
107 void acpi_ut_init_globals(void);
109 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
111 char *acpi_ut_get_mutex_name(u32 mutex_id);
115 char *acpi_ut_get_type_name(acpi_object_type type);
117 char *acpi_ut_get_node_name(void *object);
119 char *acpi_ut_get_descriptor_name(void *object);
121 char *acpi_ut_get_object_type_name(union acpi_operand_object *obj_desc);
123 char *acpi_ut_get_region_name(u8 space_id);
125 char *acpi_ut_get_event_name(u32 event_id);
127 char acpi_ut_hex_to_ascii_char(acpi_integer integer, u32 position);
129 u8 acpi_ut_valid_object_type(acpi_object_type type);
132 * utinit - miscellaneous initialization and shutdown
134 acpi_status acpi_ut_hardware_initialize(void);
136 void acpi_ut_subsystem_shutdown(void);
138 acpi_status acpi_ut_validate_fadt(void);
141 * utclib - Local implementations of C library functions
143 #ifndef ACPI_USE_SYSTEM_CLIBRARY
145 acpi_size acpi_ut_strlen(const char *string);
147 char *acpi_ut_strcpy(char *dst_string, const char *src_string);
149 char *acpi_ut_strncpy(char *dst_string,
150 const char *src_string, acpi_size count);
152 int acpi_ut_memcmp(const char *buffer1, const char *buffer2, acpi_size count);
154 int acpi_ut_strncmp(const char *string1, const char *string2, acpi_size count);
156 int acpi_ut_strcmp(const char *string1, const char *string2);
158 char *acpi_ut_strcat(char *dst_string, const char *src_string);
160 char *acpi_ut_strncat(char *dst_string,
161 const char *src_string, acpi_size count);
163 u32 acpi_ut_strtoul(const char *string, char **terminator, u32 base);
165 char *acpi_ut_strstr(char *string1, char *string2);
167 void *acpi_ut_memcpy(void *dest, const void *src, acpi_size count);
169 void *acpi_ut_memset(void *dest, acpi_native_uint value, acpi_size count);
171 int acpi_ut_to_upper(int c);
173 int acpi_ut_to_lower(int c);
175 extern const u8 _acpi_ctype[];
177 #define _ACPI_XA 0x00 /* extra alphabetic - not supported */
178 #define _ACPI_XS 0x40 /* extra space */
179 #define _ACPI_BB 0x00 /* BEL, BS, etc. - not supported */
180 #define _ACPI_CN 0x20 /* CR, FF, HT, NL, VT */
181 #define _ACPI_DI 0x04 /* '0'-'9' */
182 #define _ACPI_LO 0x02 /* 'a'-'z' */
183 #define _ACPI_PU 0x10 /* punctuation */
184 #define _ACPI_SP 0x08 /* space */
185 #define _ACPI_UP 0x01 /* 'A'-'Z' */
186 #define _ACPI_XD 0x80 /* '0'-'9', 'A'-'F', 'a'-'f' */
188 #define ACPI_IS_DIGIT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_DI))
189 #define ACPI_IS_SPACE(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_SP))
190 #define ACPI_IS_XDIGIT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_XD))
191 #define ACPI_IS_UPPER(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_UP))
192 #define ACPI_IS_LOWER(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO))
193 #define ACPI_IS_PRINT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP | _ACPI_DI | _ACPI_SP | _ACPI_PU))
194 #define ACPI_IS_ALPHA(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP))
196 #endif /* ACPI_USE_SYSTEM_CLIBRARY */
199 * utcopy - Object construction and conversion interfaces
202 acpi_ut_build_simple_object(union acpi_operand_object *obj,
203 union acpi_object *user_obj,
204 u8 * data_space, u32 * buffer_space_used);
207 acpi_ut_build_package_object(union acpi_operand_object *obj,
208 u8 * buffer, u32 * space_used);
211 acpi_ut_copy_iobject_to_eobject(union acpi_operand_object *obj,
212 struct acpi_buffer *ret_buffer);
215 acpi_ut_copy_eobject_to_iobject(union acpi_object *obj,
216 union acpi_operand_object **internal_obj);
219 acpi_ut_copy_isimple_to_isimple(union acpi_operand_object *source_obj,
220 union acpi_operand_object *dest_obj);
223 acpi_ut_copy_iobject_to_iobject(union acpi_operand_object *source_desc,
224 union acpi_operand_object **dest_desc,
225 struct acpi_walk_state *walk_state);
228 * utcreate - Object creation
231 acpi_ut_update_object_reference(union acpi_operand_object *object, u16 action);
234 * utdebug - Debug interfaces
236 void acpi_ut_init_stack_ptr_trace(void);
238 void acpi_ut_track_stack_ptr(void);
241 acpi_ut_trace(u32 line_number,
242 const char *function_name, char *module_name, u32 component_id);
245 acpi_ut_trace_ptr(u32 line_number,
246 const char *function_name,
247 char *module_name, u32 component_id, void *pointer);
250 acpi_ut_trace_u32(u32 line_number,
251 const char *function_name,
252 char *module_name, u32 component_id, u32 integer);
255 acpi_ut_trace_str(u32 line_number,
256 const char *function_name,
257 char *module_name, u32 component_id, char *string);
260 acpi_ut_exit(u32 line_number,
261 const char *function_name, char *module_name, u32 component_id);
264 acpi_ut_status_exit(u32 line_number,
265 const char *function_name,
266 char *module_name, u32 component_id, acpi_status status);
269 acpi_ut_value_exit(u32 line_number,
270 const char *function_name,
271 char *module_name, u32 component_id, acpi_integer value);
274 acpi_ut_ptr_exit(u32 line_number,
275 const char *function_name,
276 char *module_name, u32 component_id, u8 * ptr);
278 void acpi_ut_report_info(char *module_name, u32 line_number, u32 component_id);
280 void acpi_ut_report_error(char *module_name, u32 line_number, u32 component_id);
283 acpi_ut_report_warning(char *module_name, u32 line_number, u32 component_id);
285 void acpi_ut_dump_buffer(u8 * buffer, u32 count, u32 display, u32 component_id);
287 void ACPI_INTERNAL_VAR_XFACE
288 acpi_ut_debug_print(u32 requested_debug_level,
290 const char *function_name,
292 u32 component_id, char *format, ...) ACPI_PRINTF_LIKE_FUNC;
294 void ACPI_INTERNAL_VAR_XFACE
295 acpi_ut_debug_print_raw(u32 requested_debug_level,
297 const char *function_name,
300 char *format, ...) ACPI_PRINTF_LIKE_FUNC;
303 * utdelete - Object deletion and reference counts
305 void acpi_ut_add_reference(union acpi_operand_object *object);
307 void acpi_ut_remove_reference(union acpi_operand_object *object);
309 void acpi_ut_delete_internal_package_object(union acpi_operand_object *object);
311 void acpi_ut_delete_internal_simple_object(union acpi_operand_object *object);
313 void acpi_ut_delete_internal_object_list(union acpi_operand_object **obj_list);
316 * uteval - object evaluation
318 acpi_status acpi_ut_osi_implementation(struct acpi_walk_state *walk_state);
321 acpi_ut_evaluate_object(struct acpi_namespace_node *prefix_node,
323 u32 expected_return_btypes,
324 union acpi_operand_object **return_desc);
327 acpi_ut_evaluate_numeric_object(char *object_name,
328 struct acpi_namespace_node *device_node,
329 acpi_integer * address);
332 acpi_ut_execute_HID(struct acpi_namespace_node *device_node,
333 struct acpi_device_id *hid);
336 acpi_ut_execute_CID(struct acpi_namespace_node *device_node,
337 struct acpi_compatible_id_list **return_cid_list);
340 acpi_ut_execute_STA(struct acpi_namespace_node *device_node,
344 acpi_ut_execute_UID(struct acpi_namespace_node *device_node,
345 struct acpi_device_id *uid);
348 acpi_ut_execute_sxds(struct acpi_namespace_node *device_node, u8 * highest);
351 * utobject - internal object create/delete/cache routines
353 union acpi_operand_object *acpi_ut_create_internal_object_dbg(char *module_name,
359 void *acpi_ut_allocate_object_desc_dbg(char *module_name,
360 u32 line_number, u32 component_id);
362 #define acpi_ut_create_internal_object(t) acpi_ut_create_internal_object_dbg (_acpi_module_name,__LINE__,_COMPONENT,t)
363 #define acpi_ut_allocate_object_desc() acpi_ut_allocate_object_desc_dbg (_acpi_module_name,__LINE__,_COMPONENT)
365 void acpi_ut_delete_object_desc(union acpi_operand_object *object);
367 u8 acpi_ut_valid_internal_object(void *object);
369 union acpi_operand_object *acpi_ut_create_buffer_object(acpi_size buffer_size);
371 union acpi_operand_object *acpi_ut_create_string_object(acpi_size string_size);
374 acpi_ut_get_object_size(union acpi_operand_object *obj, acpi_size * obj_length);
377 * utstate - Generic state creation/cache routines
380 acpi_ut_push_generic_state(union acpi_generic_state **list_head,
381 union acpi_generic_state *state);
383 union acpi_generic_state *acpi_ut_pop_generic_state(union acpi_generic_state
386 union acpi_generic_state *acpi_ut_create_generic_state(void);
388 struct acpi_thread_state *acpi_ut_create_thread_state(void);
390 union acpi_generic_state *acpi_ut_create_update_state(union acpi_operand_object
391 *object, u16 action);
393 union acpi_generic_state *acpi_ut_create_pkg_state(void *internal_object,
394 void *external_object,
398 acpi_ut_create_update_state_and_push(union acpi_operand_object *object,
400 union acpi_generic_state **state_list);
402 #ifdef ACPI_FUTURE_USAGE
404 acpi_ut_create_pkg_state_and_push(void *internal_object,
405 void *external_object,
407 union acpi_generic_state **state_list);
408 #endif /* ACPI_FUTURE_USAGE */
410 union acpi_generic_state *acpi_ut_create_control_state(void);
412 void acpi_ut_delete_generic_state(union acpi_generic_state *state);
418 acpi_ut_divide(acpi_integer in_dividend,
419 acpi_integer in_divisor,
420 acpi_integer * out_quotient, acpi_integer * out_remainder);
423 acpi_ut_short_divide(acpi_integer in_dividend,
425 acpi_integer * out_quotient, u32 * out_remainder);
430 acpi_status acpi_ut_allocate_owner_id(acpi_owner_id * owner_id);
432 void acpi_ut_release_owner_id(acpi_owner_id * owner_id);
435 acpi_ut_walk_package_tree(union acpi_operand_object *source_object,
437 acpi_pkg_callback walk_callback, void *context);
439 void acpi_ut_strupr(char *src_string);
441 void acpi_ut_print_string(char *string, u8 max_length);
443 u8 acpi_ut_valid_acpi_name(u32 name);
445 u8 acpi_ut_valid_acpi_character(char character);
448 acpi_ut_strtoul64(char *string, u32 base, acpi_integer * ret_integer);
450 /* Values for Base above (16=Hex, 10=Decimal) */
452 #define ACPI_ANY_BASE 0
454 acpi_status acpi_ut_validate_resource(void *aml, u8 * return_index);
456 u32 acpi_ut_get_descriptor_length(void *aml);
458 u16 acpi_ut_get_resource_length(void *aml);
460 u8 acpi_ut_get_resource_header_length(void *aml);
462 u8 acpi_ut_get_resource_type(void *aml);
465 acpi_ut_get_resource_end_tag(union acpi_operand_object *obj_desc,
468 u8 acpi_ut_generate_checksum(u8 * buffer, u32 length);
470 u32 acpi_ut_dword_byte_swap(u32 value);
472 void acpi_ut_set_integer_width(u8 revision);
474 #ifdef ACPI_DEBUG_OUTPUT
476 acpi_ut_display_init_pathname(u8 type,
477 struct acpi_namespace_node *obj_handle,
483 * utmutex - mutex support
485 acpi_status acpi_ut_mutex_initialize(void);
487 void acpi_ut_mutex_terminate(void);
489 acpi_status acpi_ut_acquire_mutex(acpi_mutex_handle mutex_id);
491 acpi_status acpi_ut_release_mutex(acpi_mutex_handle mutex_id);
494 * utalloc - memory allocation and object caching
496 acpi_status acpi_ut_create_caches(void);
498 acpi_status acpi_ut_delete_caches(void);
500 acpi_status acpi_ut_validate_buffer(struct acpi_buffer *buffer);
503 acpi_ut_initialize_buffer(struct acpi_buffer *buffer,
504 acpi_size required_length);
506 void *acpi_ut_allocate(acpi_size size, u32 component, char *module, u32 line);
508 void *acpi_ut_callocate(acpi_size size, u32 component, char *module, u32 line);
510 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
511 void *acpi_ut_allocate_and_track(acpi_size size,
512 u32 component, char *module, u32 line);
514 void *acpi_ut_callocate_and_track(acpi_size size,
515 u32 component, char *module, u32 line);
518 acpi_ut_free_and_track(void *address, u32 component, char *module, u32 line);
520 #ifdef ACPI_FUTURE_USAGE
521 void acpi_ut_dump_allocation_info(void);
522 #endif /* ACPI_FUTURE_USAGE */
524 void acpi_ut_dump_allocations(u32 component, char *module);
527 #endif /* _ACUTILS_H */