blob: a87ef1c8d46bbaacf43b75361b9062e048a3c47a [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/******************************************************************************
2 *
3 * Name: acutils.h -- prototypes for the common (subsystem-wide) procedures
4 *
5 *****************************************************************************/
6
7/*
Bob Moore6c9deb72007-02-02 19:48:24 +03008 * Copyright (C) 2000 - 2007, R. Byron Moore
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 * 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
Bob Moore96db2552005-11-02 00:00:00 -050047extern const u8 acpi_gbl_resource_aml_sizes[];
48
Bob Mooredefba1d2005-12-16 17:05:00 -050049/* Strings used by the disassembler and debugger resource dump routines */
50
51#if defined(ACPI_DISASSEMBLER) || defined (ACPI_DEBUGGER)
52
Bob Mooreb229cf92006-04-21 17:15:00 -040053extern const char *acpi_gbl_bm_decode[];
54extern const char *acpi_gbl_config_decode[];
55extern const char *acpi_gbl_consume_decode[];
56extern const char *acpi_gbl_dec_decode[];
57extern const char *acpi_gbl_he_decode[];
58extern const char *acpi_gbl_io_decode[];
59extern const char *acpi_gbl_ll_decode[];
60extern const char *acpi_gbl_max_decode[];
61extern const char *acpi_gbl_mem_decode[];
62extern const char *acpi_gbl_min_decode[];
63extern const char *acpi_gbl_mtp_decode[];
64extern const char *acpi_gbl_rng_decode[];
65extern const char *acpi_gbl_rw_decode[];
66extern const char *acpi_gbl_shr_decode[];
67extern const char *acpi_gbl_siz_decode[];
68extern const char *acpi_gbl_trs_decode[];
69extern const char *acpi_gbl_ttp_decode[];
70extern const char *acpi_gbl_typ_decode[];
Bob Mooredefba1d2005-12-16 17:05:00 -050071#endif
72
Bob Moore96db2552005-11-02 00:00:00 -050073/* Types for Resource descriptor entries */
74
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
79
Linus Torvalds1da177e2005-04-16 15:20:36 -070080typedef
Bob Moore616861242006-03-17 16:44:00 -050081acpi_status(*acpi_walk_aml_callback) (u8 * aml,
82 u32 length,
83 u32 offset,
Bob Mooreb229cf92006-04-21 17:15:00 -040084 u8 resource_index, void **context);
Bob Moore616861242006-03-17 16:44:00 -050085
86typedef
Len Brown4be44fc2005-08-05 00:44:28 -040087acpi_status(*acpi_pkg_callback) (u8 object_type,
88 union acpi_operand_object * source_object,
89 union acpi_generic_state * state,
90 void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -070091
Len Brown4be44fc2005-08-05 00:44:28 -040092struct acpi_pkg_info {
93 u8 *free_space;
94 acpi_size length;
95 u32 object_space;
96 u32 num_packages;
Linus Torvalds1da177e2005-04-16 15:20:36 -070097};
98
99#define REF_INCREMENT (u16) 0
100#define REF_DECREMENT (u16) 1
101#define REF_FORCE_DELETE (u16) 2
102
103/* acpi_ut_dump_buffer */
104
105#define DB_BYTE_DISPLAY 1
106#define DB_WORD_DISPLAY 2
107#define DB_DWORD_DISPLAY 4
108#define DB_QWORD_DISPLAY 8
109
Robert Moore44f6c012005-04-18 22:49:35 -0400110/*
111 * utglobal - Global data structures and procedures
112 */
Len Brown4be44fc2005-08-05 00:44:28 -0400113void acpi_ut_init_globals(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115#if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
116
Len Brown4be44fc2005-08-05 00:44:28 -0400117char *acpi_ut_get_mutex_name(u32 mutex_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118
119#endif
120
Len Brown4be44fc2005-08-05 00:44:28 -0400121char *acpi_ut_get_type_name(acpi_object_type type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122
Len Brown4be44fc2005-08-05 00:44:28 -0400123char *acpi_ut_get_node_name(void *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124
Len Brown4be44fc2005-08-05 00:44:28 -0400125char *acpi_ut_get_descriptor_name(void *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126
Len Brown4be44fc2005-08-05 00:44:28 -0400127char *acpi_ut_get_object_type_name(union acpi_operand_object *obj_desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128
Len Brown4be44fc2005-08-05 00:44:28 -0400129char *acpi_ut_get_region_name(u8 space_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130
Len Brown4be44fc2005-08-05 00:44:28 -0400131char *acpi_ut_get_event_name(u32 event_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132
Len Brown4be44fc2005-08-05 00:44:28 -0400133char acpi_ut_hex_to_ascii_char(acpi_integer integer, u32 position);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134
Len Brown4be44fc2005-08-05 00:44:28 -0400135u8 acpi_ut_valid_object_type(acpi_object_type type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136
137/*
Robert Moore44f6c012005-04-18 22:49:35 -0400138 * utinit - miscellaneous initialization and shutdown
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139 */
Len Brown4be44fc2005-08-05 00:44:28 -0400140acpi_status acpi_ut_hardware_initialize(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141
Len Brown4be44fc2005-08-05 00:44:28 -0400142void acpi_ut_subsystem_shutdown(void);
Robert Moore44f6c012005-04-18 22:49:35 -0400143
Robert Moore44f6c012005-04-18 22:49:35 -0400144/*
145 * utclib - Local implementations of C library functions
146 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147#ifndef ACPI_USE_SYSTEM_CLIBRARY
148
Len Brown4be44fc2005-08-05 00:44:28 -0400149acpi_size acpi_ut_strlen(const char *string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150
Len Brown4be44fc2005-08-05 00:44:28 -0400151char *acpi_ut_strcpy(char *dst_string, const char *src_string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152
Len Brown4be44fc2005-08-05 00:44:28 -0400153char *acpi_ut_strncpy(char *dst_string,
154 const char *src_string, acpi_size count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155
Len Brown4be44fc2005-08-05 00:44:28 -0400156int acpi_ut_memcmp(const char *buffer1, const char *buffer2, acpi_size count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157
Len Brown4be44fc2005-08-05 00:44:28 -0400158int acpi_ut_strncmp(const char *string1, const char *string2, acpi_size count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159
Len Brown4be44fc2005-08-05 00:44:28 -0400160int acpi_ut_strcmp(const char *string1, const char *string2);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161
Len Brown4be44fc2005-08-05 00:44:28 -0400162char *acpi_ut_strcat(char *dst_string, const char *src_string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163
Len Brown4be44fc2005-08-05 00:44:28 -0400164char *acpi_ut_strncat(char *dst_string,
165 const char *src_string, acpi_size count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166
Len Brown4be44fc2005-08-05 00:44:28 -0400167u32 acpi_ut_strtoul(const char *string, char **terminator, u32 base);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168
Len Brown4be44fc2005-08-05 00:44:28 -0400169char *acpi_ut_strstr(char *string1, char *string2);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170
Len Brown4be44fc2005-08-05 00:44:28 -0400171void *acpi_ut_memcpy(void *dest, const void *src, acpi_size count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172
Len Brown4be44fc2005-08-05 00:44:28 -0400173void *acpi_ut_memset(void *dest, acpi_native_uint value, acpi_size count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174
Len Brown4be44fc2005-08-05 00:44:28 -0400175int acpi_ut_to_upper(int c);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176
Len Brown4be44fc2005-08-05 00:44:28 -0400177int acpi_ut_to_lower(int c);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178
179extern const u8 _acpi_ctype[];
180
Len Brown4be44fc2005-08-05 00:44:28 -0400181#define _ACPI_XA 0x00 /* extra alphabetic - not supported */
182#define _ACPI_XS 0x40 /* extra space */
183#define _ACPI_BB 0x00 /* BEL, BS, etc. - not supported */
184#define _ACPI_CN 0x20 /* CR, FF, HT, NL, VT */
185#define _ACPI_DI 0x04 /* '0'-'9' */
186#define _ACPI_LO 0x02 /* 'a'-'z' */
187#define _ACPI_PU 0x10 /* punctuation */
188#define _ACPI_SP 0x08 /* space */
189#define _ACPI_UP 0x01 /* 'A'-'Z' */
190#define _ACPI_XD 0x80 /* '0'-'9', 'A'-'F', 'a'-'f' */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191
192#define ACPI_IS_DIGIT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_DI))
193#define ACPI_IS_SPACE(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_SP))
194#define ACPI_IS_XDIGIT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_XD))
195#define ACPI_IS_UPPER(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_UP))
196#define ACPI_IS_LOWER(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO))
197#define ACPI_IS_PRINT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP | _ACPI_DI | _ACPI_SP | _ACPI_PU))
198#define ACPI_IS_ALPHA(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199
Len Brown4be44fc2005-08-05 00:44:28 -0400200#endif /* ACPI_USE_SYSTEM_CLIBRARY */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201
Robert Moore44f6c012005-04-18 22:49:35 -0400202/*
203 * utcopy - Object construction and conversion interfaces
204 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400206acpi_ut_build_simple_object(union acpi_operand_object *obj,
207 union acpi_object *user_obj,
208 u8 * data_space, u32 * buffer_space_used);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209
210acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400211acpi_ut_build_package_object(union acpi_operand_object *obj,
212 u8 * buffer, u32 * space_used);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213
214acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400215acpi_ut_copy_iobject_to_eobject(union acpi_operand_object *obj,
216 struct acpi_buffer *ret_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217
218acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400219acpi_ut_copy_eobject_to_iobject(union acpi_object *obj,
220 union acpi_operand_object **internal_obj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221
222acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400223acpi_ut_copy_isimple_to_isimple(union acpi_operand_object *source_obj,
224 union acpi_operand_object *dest_obj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225
226acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400227acpi_ut_copy_iobject_to_iobject(union acpi_operand_object *source_desc,
228 union acpi_operand_object **dest_desc,
229 struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230
231/*
Robert Moore44f6c012005-04-18 22:49:35 -0400232 * utcreate - Object creation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400235acpi_ut_update_object_reference(union acpi_operand_object *object, u16 action);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236
237/*
Robert Moore44f6c012005-04-18 22:49:35 -0400238 * utdebug - Debug interfaces
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239 */
Len Brown4be44fc2005-08-05 00:44:28 -0400240void acpi_ut_init_stack_ptr_trace(void);
241
242void acpi_ut_track_stack_ptr(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243
244void
Len Brown4be44fc2005-08-05 00:44:28 -0400245acpi_ut_trace(u32 line_number,
246 const char *function_name, char *module_name, u32 component_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247
248void
Len Brown4be44fc2005-08-05 00:44:28 -0400249acpi_ut_trace_ptr(u32 line_number,
250 const char *function_name,
251 char *module_name, u32 component_id, void *pointer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252
253void
Len Brown4be44fc2005-08-05 00:44:28 -0400254acpi_ut_trace_u32(u32 line_number,
255 const char *function_name,
256 char *module_name, u32 component_id, u32 integer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257
258void
Len Brown4be44fc2005-08-05 00:44:28 -0400259acpi_ut_trace_str(u32 line_number,
260 const char *function_name,
261 char *module_name, u32 component_id, char *string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262
263void
Len Brown4be44fc2005-08-05 00:44:28 -0400264acpi_ut_exit(u32 line_number,
265 const char *function_name, char *module_name, u32 component_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266
267void
Len Brown4be44fc2005-08-05 00:44:28 -0400268acpi_ut_status_exit(u32 line_number,
269 const char *function_name,
270 char *module_name, u32 component_id, acpi_status status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271
272void
Len Brown4be44fc2005-08-05 00:44:28 -0400273acpi_ut_value_exit(u32 line_number,
274 const char *function_name,
275 char *module_name, u32 component_id, acpi_integer value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276
277void
Len Brown4be44fc2005-08-05 00:44:28 -0400278acpi_ut_ptr_exit(u32 line_number,
279 const char *function_name,
280 char *module_name, u32 component_id, u8 * ptr);
281
Bob Mooreb8e4d892006-01-27 16:43:00 -0500282void acpi_ut_dump_buffer(u8 * buffer, u32 count, u32 display, u32 component_id);
283
Bob Moore793c2382006-03-31 00:00:00 -0500284void acpi_ut_dump_buffer2(u8 * buffer, u32 count, u32 display);
285
Bob Moore4a90c7e2006-01-13 16:22:00 -0500286void acpi_ut_report_error(char *module_name, u32 line_number);
Len Brown4be44fc2005-08-05 00:44:28 -0400287
Bob Moore4a90c7e2006-01-13 16:22:00 -0500288void acpi_ut_report_info(char *module_name, u32 line_number);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289
Bob Moore4a90c7e2006-01-13 16:22:00 -0500290void acpi_ut_report_warning(char *module_name, u32 line_number);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291
Bob Mooreb8e4d892006-01-27 16:43:00 -0500292/* Error and message reporting interfaces */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293
294void ACPI_INTERNAL_VAR_XFACE
Len Brown4be44fc2005-08-05 00:44:28 -0400295acpi_ut_debug_print(u32 requested_debug_level,
296 u32 line_number,
297 const char *function_name,
298 char *module_name,
Bob Mooreb8e4d892006-01-27 16:43:00 -0500299 u32 component_id, char *format, ...) ACPI_PRINTF_LIKE(6);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300
301void ACPI_INTERNAL_VAR_XFACE
Len Brown4be44fc2005-08-05 00:44:28 -0400302acpi_ut_debug_print_raw(u32 requested_debug_level,
303 u32 line_number,
304 const char *function_name,
305 char *module_name,
306 u32 component_id,
Bob Mooreb8e4d892006-01-27 16:43:00 -0500307 char *format, ...) ACPI_PRINTF_LIKE(6);
308
309void ACPI_INTERNAL_VAR_XFACE
310acpi_ut_error(char *module_name,
311 u32 line_number, char *format, ...) ACPI_PRINTF_LIKE(3);
312
313void ACPI_INTERNAL_VAR_XFACE
314acpi_ut_exception(char *module_name,
315 u32 line_number,
316 acpi_status status, char *format, ...) ACPI_PRINTF_LIKE(4);
317
318void ACPI_INTERNAL_VAR_XFACE
319acpi_ut_warning(char *module_name,
320 u32 line_number, char *format, ...) ACPI_PRINTF_LIKE(3);
321
322void ACPI_INTERNAL_VAR_XFACE
323acpi_ut_info(char *module_name,
324 u32 line_number, char *format, ...) ACPI_PRINTF_LIKE(3);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325
326/*
Robert Moore44f6c012005-04-18 22:49:35 -0400327 * utdelete - Object deletion and reference counts
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328 */
Len Brown4be44fc2005-08-05 00:44:28 -0400329void acpi_ut_add_reference(union acpi_operand_object *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330
Len Brown4be44fc2005-08-05 00:44:28 -0400331void acpi_ut_remove_reference(union acpi_operand_object *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332
Len Brown4be44fc2005-08-05 00:44:28 -0400333void acpi_ut_delete_internal_package_object(union acpi_operand_object *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334
Len Brown4be44fc2005-08-05 00:44:28 -0400335void acpi_ut_delete_internal_simple_object(union acpi_operand_object *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336
Len Brown4be44fc2005-08-05 00:44:28 -0400337void acpi_ut_delete_internal_object_list(union acpi_operand_object **obj_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338
339/*
Robert Moore44f6c012005-04-18 22:49:35 -0400340 * uteval - object evaluation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341 */
Len Brown4be44fc2005-08-05 00:44:28 -0400342acpi_status acpi_ut_osi_implementation(struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343
344acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400345acpi_ut_evaluate_object(struct acpi_namespace_node *prefix_node,
346 char *path,
347 u32 expected_return_btypes,
348 union acpi_operand_object **return_desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349
350acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400351acpi_ut_evaluate_numeric_object(char *object_name,
352 struct acpi_namespace_node *device_node,
353 acpi_integer * address);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354
355acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400356acpi_ut_execute_HID(struct acpi_namespace_node *device_node,
357 struct acpi_device_id *hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358
359acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400360acpi_ut_execute_CID(struct acpi_namespace_node *device_node,
361 struct acpi_compatible_id_list **return_cid_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362
363acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400364acpi_ut_execute_STA(struct acpi_namespace_node *device_node,
365 u32 * status_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366
367acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400368acpi_ut_execute_UID(struct acpi_namespace_node *device_node,
369 struct acpi_device_id *uid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370
371acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400372acpi_ut_execute_sxds(struct acpi_namespace_node *device_node, u8 * highest);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373
374/*
Robert Moore44f6c012005-04-18 22:49:35 -0400375 * utobject - internal object create/delete/cache routines
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376 */
Len Brown4be44fc2005-08-05 00:44:28 -0400377union acpi_operand_object *acpi_ut_create_internal_object_dbg(char *module_name,
378 u32 line_number,
379 u32 component_id,
380 acpi_object_type
381 type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382
Len Brown4be44fc2005-08-05 00:44:28 -0400383void *acpi_ut_allocate_object_desc_dbg(char *module_name,
384 u32 line_number, u32 component_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385
Robert Mooref9f46012005-07-08 00:00:00 -0400386#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)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388
Len Brown4be44fc2005-08-05 00:44:28 -0400389void acpi_ut_delete_object_desc(union acpi_operand_object *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390
Len Brown4be44fc2005-08-05 00:44:28 -0400391u8 acpi_ut_valid_internal_object(void *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392
Bob Moore6287ee32007-04-03 19:59:37 -0400393union acpi_operand_object *acpi_ut_create_package_object(u32 count);
394
Len Brown4be44fc2005-08-05 00:44:28 -0400395union acpi_operand_object *acpi_ut_create_buffer_object(acpi_size buffer_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396
Len Brown4be44fc2005-08-05 00:44:28 -0400397union acpi_operand_object *acpi_ut_create_string_object(acpi_size string_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400400acpi_ut_get_object_size(union acpi_operand_object *obj, acpi_size * obj_length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401
402/*
Robert Moore44f6c012005-04-18 22:49:35 -0400403 * utstate - Generic state creation/cache routines
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405void
Len Brown4be44fc2005-08-05 00:44:28 -0400406acpi_ut_push_generic_state(union acpi_generic_state **list_head,
407 union acpi_generic_state *state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408
Len Brown4be44fc2005-08-05 00:44:28 -0400409union acpi_generic_state *acpi_ut_pop_generic_state(union acpi_generic_state
410 **list_head);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411
Len Brown4be44fc2005-08-05 00:44:28 -0400412union acpi_generic_state *acpi_ut_create_generic_state(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413
Len Brown4be44fc2005-08-05 00:44:28 -0400414struct acpi_thread_state *acpi_ut_create_thread_state(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415
Len Brown4be44fc2005-08-05 00:44:28 -0400416union acpi_generic_state *acpi_ut_create_update_state(union acpi_operand_object
417 *object, u16 action);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418
Len Brown4be44fc2005-08-05 00:44:28 -0400419union acpi_generic_state *acpi_ut_create_pkg_state(void *internal_object,
420 void *external_object,
421 u16 index);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422
423acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400424acpi_ut_create_update_state_and_push(union acpi_operand_object *object,
425 u16 action,
426 union acpi_generic_state **state_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427
Robert Moore44f6c012005-04-18 22:49:35 -0400428#ifdef ACPI_FUTURE_USAGE
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400430acpi_ut_create_pkg_state_and_push(void *internal_object,
431 void *external_object,
432 u16 index,
433 union acpi_generic_state **state_list);
434#endif /* ACPI_FUTURE_USAGE */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435
Len Brown4be44fc2005-08-05 00:44:28 -0400436union acpi_generic_state *acpi_ut_create_control_state(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437
Len Brown4be44fc2005-08-05 00:44:28 -0400438void acpi_ut_delete_generic_state(union acpi_generic_state *state);
Robert Moore44f6c012005-04-18 22:49:35 -0400439
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440/*
Robert Moore44f6c012005-04-18 22:49:35 -0400441 * utmath
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400444acpi_ut_divide(acpi_integer in_dividend,
445 acpi_integer in_divisor,
446 acpi_integer * out_quotient, acpi_integer * out_remainder);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447
448acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400449acpi_ut_short_divide(acpi_integer in_dividend,
450 u32 divisor,
451 acpi_integer * out_quotient, u32 * out_remainder);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452
Robert Moore44f6c012005-04-18 22:49:35 -0400453/*
454 * utmisc
455 */
Bob Moore84fb2c92007-02-02 19:48:19 +0300456const char *acpi_ut_validate_exception(acpi_status status);
457
Bob Moore793c2382006-03-31 00:00:00 -0500458u8 acpi_ut_is_aml_table(struct acpi_table_header *table);
459
Len Brown4be44fc2005-08-05 00:44:28 -0400460acpi_status acpi_ut_allocate_owner_id(acpi_owner_id * owner_id);
Robert Mooref9f46012005-07-08 00:00:00 -0400461
Len Brown4be44fc2005-08-05 00:44:28 -0400462void acpi_ut_release_owner_id(acpi_owner_id * owner_id);
Robert Mooref9f46012005-07-08 00:00:00 -0400463
464acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400465acpi_ut_walk_package_tree(union acpi_operand_object *source_object,
466 void *target_object,
467 acpi_pkg_callback walk_callback, void *context);
Robert Moore44f6c012005-04-18 22:49:35 -0400468
Len Brown4be44fc2005-08-05 00:44:28 -0400469void acpi_ut_strupr(char *src_string);
Robert Moore44f6c012005-04-18 22:49:35 -0400470
Len Brown4be44fc2005-08-05 00:44:28 -0400471void acpi_ut_print_string(char *string, u8 max_length);
Robert Moore44f6c012005-04-18 22:49:35 -0400472
Len Brown4be44fc2005-08-05 00:44:28 -0400473u8 acpi_ut_valid_acpi_name(u32 name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474
Bob Moore3d81b232007-02-02 19:48:19 +0300475acpi_name acpi_ut_repair_name(char *name);
Bob Moore793c2382006-03-31 00:00:00 -0500476
477u8 acpi_ut_valid_acpi_char(char character, acpi_native_uint position);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478
479acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400480acpi_ut_strtoul64(char *string, u32 base, acpi_integer * ret_integer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481
482/* Values for Base above (16=Hex, 10=Decimal) */
483
484#define ACPI_ANY_BASE 0
485
Bob Moore616861242006-03-17 16:44:00 -0500486u32 acpi_ut_dword_byte_swap(u32 value);
487
488void acpi_ut_set_integer_width(u8 revision);
489
490#ifdef ACPI_DEBUG_OUTPUT
491void
492acpi_ut_display_init_pathname(u8 type,
493 struct acpi_namespace_node *obj_handle,
494 char *path);
495#endif
496
497/*
498 * utresrc
499 */
500acpi_status
501acpi_ut_walk_aml_resources(u8 * aml,
502 acpi_size aml_length,
Len Brownfd350942007-05-09 23:34:35 -0400503 acpi_walk_aml_callback user_function,
504 void **context);
Bob Moore616861242006-03-17 16:44:00 -0500505
Bob Moore96db2552005-11-02 00:00:00 -0500506acpi_status acpi_ut_validate_resource(void *aml, u8 * return_index);
507
Bob Moore08978312005-10-21 00:00:00 -0400508u32 acpi_ut_get_descriptor_length(void *aml);
509
510u16 acpi_ut_get_resource_length(void *aml);
511
Bob Moore96db2552005-11-02 00:00:00 -0500512u8 acpi_ut_get_resource_header_length(void *aml);
513
Bob Moore08978312005-10-21 00:00:00 -0400514u8 acpi_ut_get_resource_type(void *aml);
515
Bob Moore96db2552005-11-02 00:00:00 -0500516acpi_status
517acpi_ut_get_resource_end_tag(union acpi_operand_object *obj_desc,
518 u8 ** end_tag);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520/*
Robert Moore73459f72005-06-24 00:00:00 -0400521 * utmutex - mutex support
522 */
Len Brown4be44fc2005-08-05 00:44:28 -0400523acpi_status acpi_ut_mutex_initialize(void);
Robert Moore73459f72005-06-24 00:00:00 -0400524
Len Brown4be44fc2005-08-05 00:44:28 -0400525void acpi_ut_mutex_terminate(void);
Robert Moore73459f72005-06-24 00:00:00 -0400526
Len Brown4be44fc2005-08-05 00:44:28 -0400527acpi_status acpi_ut_acquire_mutex(acpi_mutex_handle mutex_id);
Robert Moore73459f72005-06-24 00:00:00 -0400528
Len Brown4be44fc2005-08-05 00:44:28 -0400529acpi_status acpi_ut_release_mutex(acpi_mutex_handle mutex_id);
Robert Moore73459f72005-06-24 00:00:00 -0400530
531/*
Robert Moore44f6c012005-04-18 22:49:35 -0400532 * utalloc - memory allocation and object caching
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533 */
Len Brown4be44fc2005-08-05 00:44:28 -0400534acpi_status acpi_ut_create_caches(void);
535
536acpi_status acpi_ut_delete_caches(void);
537
538acpi_status acpi_ut_validate_buffer(struct acpi_buffer *buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539
Robert Moore73459f72005-06-24 00:00:00 -0400540acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400541acpi_ut_initialize_buffer(struct acpi_buffer *buffer,
542 acpi_size required_length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543
Len Brown4be44fc2005-08-05 00:44:28 -0400544void *acpi_ut_allocate(acpi_size size, u32 component, char *module, u32 line);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545
Bob Moore616861242006-03-17 16:44:00 -0500546void *acpi_ut_allocate_zeroed(acpi_size size,
547 u32 component, char *module, u32 line);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549#ifdef ACPI_DBG_TRACK_ALLOCATIONS
Len Brown4be44fc2005-08-05 00:44:28 -0400550void *acpi_ut_allocate_and_track(acpi_size size,
551 u32 component, char *module, u32 line);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552
Bob Moore616861242006-03-17 16:44:00 -0500553void *acpi_ut_allocate_zeroed_and_track(acpi_size size,
554 u32 component, char *module, u32 line);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555
556void
Len Brown4be44fc2005-08-05 00:44:28 -0400557acpi_ut_free_and_track(void *address, u32 component, char *module, u32 line);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558
Robert Moore44f6c012005-04-18 22:49:35 -0400559#ifdef ACPI_FUTURE_USAGE
Len Brown4be44fc2005-08-05 00:44:28 -0400560void acpi_ut_dump_allocation_info(void);
561#endif /* ACPI_FUTURE_USAGE */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562
Len Brown4be44fc2005-08-05 00:44:28 -0400563void acpi_ut_dump_allocations(u32 component, char *module);
Bob Moore616861242006-03-17 16:44:00 -0500564
565acpi_status
566acpi_ut_create_list(char *list_name,
567 u16 object_size, struct acpi_memory_list **return_cache);
568
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569#endif
570
Len Brown4be44fc2005-08-05 00:44:28 -0400571#endif /* _ACUTILS_H */