1 /******************************************************************************
3 * Name: acutils.h -- prototypes for the common (subsystem-wide) procedures
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2006, 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_walk_aml_callback) (u8 * aml,
84 u8 resource_index, void *context);
87 acpi_status(*acpi_pkg_callback) (u8 object_type,
88 union acpi_operand_object * source_object,
89 union acpi_generic_state * state,
92 struct acpi_pkg_info {
99 #define REF_INCREMENT (u16) 0
100 #define REF_DECREMENT (u16) 1
101 #define REF_FORCE_DELETE (u16) 2
103 /* acpi_ut_dump_buffer */
105 #define DB_BYTE_DISPLAY 1
106 #define DB_WORD_DISPLAY 2
107 #define DB_DWORD_DISPLAY 4
108 #define DB_QWORD_DISPLAY 8
111 * utglobal - Global data structures and procedures
113 void acpi_ut_init_globals(void);
115 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
117 char *acpi_ut_get_mutex_name(u32 mutex_id);
121 char *acpi_ut_get_type_name(acpi_object_type type);
123 char *acpi_ut_get_node_name(void *object);
125 char *acpi_ut_get_descriptor_name(void *object);
127 char *acpi_ut_get_object_type_name(union acpi_operand_object *obj_desc);
129 char *acpi_ut_get_region_name(u8 space_id);
131 char *acpi_ut_get_event_name(u32 event_id);
133 char acpi_ut_hex_to_ascii_char(acpi_integer integer, u32 position);
135 u8 acpi_ut_valid_object_type(acpi_object_type type);
138 * utinit - miscellaneous initialization and shutdown
140 acpi_status acpi_ut_hardware_initialize(void);
142 void acpi_ut_subsystem_shutdown(void);
144 acpi_status acpi_ut_validate_fadt(void);
147 * utclib - Local implementations of C library functions
149 #ifndef ACPI_USE_SYSTEM_CLIBRARY
151 acpi_size acpi_ut_strlen(const char *string);
153 char *acpi_ut_strcpy(char *dst_string, const char *src_string);
155 char *acpi_ut_strncpy(char *dst_string,
156 const char *src_string, acpi_size count);
158 int acpi_ut_memcmp(const char *buffer1, const char *buffer2, acpi_size count);
160 int acpi_ut_strncmp(const char *string1, const char *string2, acpi_size count);
162 int acpi_ut_strcmp(const char *string1, const char *string2);
164 char *acpi_ut_strcat(char *dst_string, const char *src_string);
166 char *acpi_ut_strncat(char *dst_string,
167 const char *src_string, acpi_size count);
169 u32 acpi_ut_strtoul(const char *string, char **terminator, u32 base);
171 char *acpi_ut_strstr(char *string1, char *string2);
173 void *acpi_ut_memcpy(void *dest, const void *src, acpi_size count);
175 void *acpi_ut_memset(void *dest, acpi_native_uint value, acpi_size count);
177 int acpi_ut_to_upper(int c);
179 int acpi_ut_to_lower(int c);
181 extern const u8 _acpi_ctype[];
183 #define _ACPI_XA 0x00 /* extra alphabetic - not supported */
184 #define _ACPI_XS 0x40 /* extra space */
185 #define _ACPI_BB 0x00 /* BEL, BS, etc. - not supported */
186 #define _ACPI_CN 0x20 /* CR, FF, HT, NL, VT */
187 #define _ACPI_DI 0x04 /* '0'-'9' */
188 #define _ACPI_LO 0x02 /* 'a'-'z' */
189 #define _ACPI_PU 0x10 /* punctuation */
190 #define _ACPI_SP 0x08 /* space */
191 #define _ACPI_UP 0x01 /* 'A'-'Z' */
192 #define _ACPI_XD 0x80 /* '0'-'9', 'A'-'F', 'a'-'f' */
194 #define ACPI_IS_DIGIT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_DI))
195 #define ACPI_IS_SPACE(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_SP))
196 #define ACPI_IS_XDIGIT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_XD))
197 #define ACPI_IS_UPPER(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_UP))
198 #define ACPI_IS_LOWER(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO))
199 #define ACPI_IS_PRINT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP | _ACPI_DI | _ACPI_SP | _ACPI_PU))
200 #define ACPI_IS_ALPHA(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP))
202 #endif /* ACPI_USE_SYSTEM_CLIBRARY */
205 * utcopy - Object construction and conversion interfaces
208 acpi_ut_build_simple_object(union acpi_operand_object *obj,
209 union acpi_object *user_obj,
210 u8 * data_space, u32 * buffer_space_used);
213 acpi_ut_build_package_object(union acpi_operand_object *obj,
214 u8 * buffer, u32 * space_used);
217 acpi_ut_copy_iobject_to_eobject(union acpi_operand_object *obj,
218 struct acpi_buffer *ret_buffer);
221 acpi_ut_copy_eobject_to_iobject(union acpi_object *obj,
222 union acpi_operand_object **internal_obj);
225 acpi_ut_copy_isimple_to_isimple(union acpi_operand_object *source_obj,
226 union acpi_operand_object *dest_obj);
229 acpi_ut_copy_iobject_to_iobject(union acpi_operand_object *source_desc,
230 union acpi_operand_object **dest_desc,
231 struct acpi_walk_state *walk_state);
234 * utcreate - Object creation
237 acpi_ut_update_object_reference(union acpi_operand_object *object, u16 action);
240 * utdebug - Debug interfaces
242 void acpi_ut_init_stack_ptr_trace(void);
244 void acpi_ut_track_stack_ptr(void);
247 acpi_ut_trace(u32 line_number,
248 const char *function_name, char *module_name, u32 component_id);
251 acpi_ut_trace_ptr(u32 line_number,
252 const char *function_name,
253 char *module_name, u32 component_id, void *pointer);
256 acpi_ut_trace_u32(u32 line_number,
257 const char *function_name,
258 char *module_name, u32 component_id, u32 integer);
261 acpi_ut_trace_str(u32 line_number,
262 const char *function_name,
263 char *module_name, u32 component_id, char *string);
266 acpi_ut_exit(u32 line_number,
267 const char *function_name, char *module_name, u32 component_id);
270 acpi_ut_status_exit(u32 line_number,
271 const char *function_name,
272 char *module_name, u32 component_id, acpi_status status);
275 acpi_ut_value_exit(u32 line_number,
276 const char *function_name,
277 char *module_name, u32 component_id, acpi_integer value);
280 acpi_ut_ptr_exit(u32 line_number,
281 const char *function_name,
282 char *module_name, u32 component_id, u8 * ptr);
284 void acpi_ut_dump_buffer(u8 * buffer, u32 count, u32 display, u32 component_id);
286 void acpi_ut_report_error(char *module_name, u32 line_number);
288 void acpi_ut_report_info(char *module_name, u32 line_number);
290 void acpi_ut_report_warning(char *module_name, u32 line_number);
292 /* Error and message reporting interfaces */
294 void ACPI_INTERNAL_VAR_XFACE
295 acpi_ut_debug_print(u32 requested_debug_level,
297 const char *function_name,
299 u32 component_id, char *format, ...) ACPI_PRINTF_LIKE(6);
301 void ACPI_INTERNAL_VAR_XFACE
302 acpi_ut_debug_print_raw(u32 requested_debug_level,
304 const char *function_name,
307 char *format, ...) ACPI_PRINTF_LIKE(6);
309 void ACPI_INTERNAL_VAR_XFACE
310 acpi_ut_error(char *module_name,
311 u32 line_number, char *format, ...) ACPI_PRINTF_LIKE(3);
313 void ACPI_INTERNAL_VAR_XFACE
314 acpi_ut_exception(char *module_name,
316 acpi_status status, char *format, ...) ACPI_PRINTF_LIKE(4);
318 void ACPI_INTERNAL_VAR_XFACE
319 acpi_ut_warning(char *module_name,
320 u32 line_number, char *format, ...) ACPI_PRINTF_LIKE(3);
322 void ACPI_INTERNAL_VAR_XFACE
323 acpi_ut_info(char *module_name,
324 u32 line_number, char *format, ...) ACPI_PRINTF_LIKE(3);
327 * utdelete - Object deletion and reference counts
329 void acpi_ut_add_reference(union acpi_operand_object *object);
331 void acpi_ut_remove_reference(union acpi_operand_object *object);
333 void acpi_ut_delete_internal_package_object(union acpi_operand_object *object);
335 void acpi_ut_delete_internal_simple_object(union acpi_operand_object *object);
337 void acpi_ut_delete_internal_object_list(union acpi_operand_object **obj_list);
340 * uteval - object evaluation
342 acpi_status acpi_ut_osi_implementation(struct acpi_walk_state *walk_state);
345 acpi_ut_evaluate_object(struct acpi_namespace_node *prefix_node,
347 u32 expected_return_btypes,
348 union acpi_operand_object **return_desc);
351 acpi_ut_evaluate_numeric_object(char *object_name,
352 struct acpi_namespace_node *device_node,
353 acpi_integer * address);
356 acpi_ut_execute_HID(struct acpi_namespace_node *device_node,
357 struct acpi_device_id *hid);
360 acpi_ut_execute_CID(struct acpi_namespace_node *device_node,
361 struct acpi_compatible_id_list **return_cid_list);
364 acpi_ut_execute_STA(struct acpi_namespace_node *device_node,
368 acpi_ut_execute_UID(struct acpi_namespace_node *device_node,
369 struct acpi_device_id *uid);
372 acpi_ut_execute_sxds(struct acpi_namespace_node *device_node, u8 * highest);
375 * utobject - internal object create/delete/cache routines
377 union acpi_operand_object *acpi_ut_create_internal_object_dbg(char *module_name,
383 void *acpi_ut_allocate_object_desc_dbg(char *module_name,
384 u32 line_number, u32 component_id);
386 #define acpi_ut_create_internal_object(t) acpi_ut_create_internal_object_dbg (_acpi_module_name,__LINE__,_COMPONENT,t)
387 #define acpi_ut_allocate_object_desc() acpi_ut_allocate_object_desc_dbg (_acpi_module_name,__LINE__,_COMPONENT)
389 void acpi_ut_delete_object_desc(union acpi_operand_object *object);
391 u8 acpi_ut_valid_internal_object(void *object);
393 union acpi_operand_object *acpi_ut_create_buffer_object(acpi_size buffer_size);
395 union acpi_operand_object *acpi_ut_create_string_object(acpi_size string_size);
398 acpi_ut_get_object_size(union acpi_operand_object *obj, acpi_size * obj_length);
401 * utstate - Generic state creation/cache routines
404 acpi_ut_push_generic_state(union acpi_generic_state **list_head,
405 union acpi_generic_state *state);
407 union acpi_generic_state *acpi_ut_pop_generic_state(union acpi_generic_state
410 union acpi_generic_state *acpi_ut_create_generic_state(void);
412 struct acpi_thread_state *acpi_ut_create_thread_state(void);
414 union acpi_generic_state *acpi_ut_create_update_state(union acpi_operand_object
415 *object, u16 action);
417 union acpi_generic_state *acpi_ut_create_pkg_state(void *internal_object,
418 void *external_object,
422 acpi_ut_create_update_state_and_push(union acpi_operand_object *object,
424 union acpi_generic_state **state_list);
426 #ifdef ACPI_FUTURE_USAGE
428 acpi_ut_create_pkg_state_and_push(void *internal_object,
429 void *external_object,
431 union acpi_generic_state **state_list);
432 #endif /* ACPI_FUTURE_USAGE */
434 union acpi_generic_state *acpi_ut_create_control_state(void);
436 void acpi_ut_delete_generic_state(union acpi_generic_state *state);
442 acpi_ut_divide(acpi_integer in_dividend,
443 acpi_integer in_divisor,
444 acpi_integer * out_quotient, acpi_integer * out_remainder);
447 acpi_ut_short_divide(acpi_integer in_dividend,
449 acpi_integer * out_quotient, u32 * out_remainder);
454 acpi_status acpi_ut_allocate_owner_id(acpi_owner_id * owner_id);
456 void acpi_ut_release_owner_id(acpi_owner_id * owner_id);
459 acpi_ut_walk_package_tree(union acpi_operand_object *source_object,
461 acpi_pkg_callback walk_callback, void *context);
463 void acpi_ut_strupr(char *src_string);
465 void acpi_ut_print_string(char *string, u8 max_length);
467 u8 acpi_ut_valid_acpi_name(u32 name);
469 u8 acpi_ut_valid_acpi_character(char character);
472 acpi_ut_strtoul64(char *string, u32 base, acpi_integer * ret_integer);
474 /* Values for Base above (16=Hex, 10=Decimal) */
476 #define ACPI_ANY_BASE 0
478 u32 acpi_ut_dword_byte_swap(u32 value);
480 void acpi_ut_set_integer_width(u8 revision);
482 #ifdef ACPI_DEBUG_OUTPUT
484 acpi_ut_display_init_pathname(u8 type,
485 struct acpi_namespace_node *obj_handle,
493 acpi_ut_walk_aml_resources(u8 * aml,
494 acpi_size aml_length,
495 acpi_walk_aml_callback user_function, void *context);
497 acpi_status acpi_ut_validate_resource(void *aml, u8 * return_index);
499 u32 acpi_ut_get_descriptor_length(void *aml);
501 u16 acpi_ut_get_resource_length(void *aml);
503 u8 acpi_ut_get_resource_header_length(void *aml);
505 u8 acpi_ut_get_resource_type(void *aml);
508 acpi_ut_get_resource_end_tag(union acpi_operand_object *obj_desc,
512 * utmutex - mutex support
514 acpi_status acpi_ut_mutex_initialize(void);
516 void acpi_ut_mutex_terminate(void);
518 acpi_status acpi_ut_acquire_mutex(acpi_mutex_handle mutex_id);
520 acpi_status acpi_ut_release_mutex(acpi_mutex_handle mutex_id);
523 * utalloc - memory allocation and object caching
525 acpi_status acpi_ut_create_caches(void);
527 acpi_status acpi_ut_delete_caches(void);
529 acpi_status acpi_ut_validate_buffer(struct acpi_buffer *buffer);
532 acpi_ut_initialize_buffer(struct acpi_buffer *buffer,
533 acpi_size required_length);
535 void *acpi_ut_allocate(acpi_size size, u32 component, char *module, u32 line);
537 void *acpi_ut_allocate_zeroed(acpi_size size,
538 u32 component, char *module, u32 line);
540 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
541 void *acpi_ut_allocate_and_track(acpi_size size,
542 u32 component, char *module, u32 line);
544 void *acpi_ut_allocate_zeroed_and_track(acpi_size size,
545 u32 component, char *module, u32 line);
548 acpi_ut_free_and_track(void *address, u32 component, char *module, u32 line);
550 #ifdef ACPI_FUTURE_USAGE
551 void acpi_ut_dump_allocation_info(void);
552 #endif /* ACPI_FUTURE_USAGE */
554 void acpi_ut_dump_allocations(u32 component, char *module);
557 acpi_ut_create_list(char *list_name,
558 u16 object_size, struct acpi_memory_list **return_cache);
562 #endif /* _ACUTILS_H */