blob: 5fa21e03a62fab36741ff303f72adf6ce0361ba0 [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/*
8 * Copyright (C) 2000 - 2005, R. Byron Moore
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
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
53extern const char *acpi_gbl_BMdecode[2];
54extern const char *acpi_gbl_config_decode[4];
55extern const char *acpi_gbl_consume_decode[2];
56extern const char *acpi_gbl_DECdecode[2];
57extern const char *acpi_gbl_HEdecode[2];
58extern const char *acpi_gbl_io_decode[2];
59extern const char *acpi_gbl_LLdecode[2];
60extern const char *acpi_gbl_max_decode[2];
61extern const char *acpi_gbl_MEMdecode[4];
62extern const char *acpi_gbl_min_decode[2];
63extern const char *acpi_gbl_MTPdecode[4];
64extern const char *acpi_gbl_RNGdecode[4];
65extern const char *acpi_gbl_RWdecode[2];
66extern const char *acpi_gbl_SHRdecode[2];
67extern const char *acpi_gbl_SIZdecode[4];
68extern const char *acpi_gbl_TRSdecode[2];
69extern const char *acpi_gbl_TTPdecode[2];
70extern const char *acpi_gbl_TYPdecode[4];
71#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
Len Brown4be44fc2005-08-05 00:44:28 -040081acpi_status(*acpi_pkg_callback) (u8 object_type,
82 union acpi_operand_object * source_object,
83 union acpi_generic_state * state,
84 void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
Len Brown4be44fc2005-08-05 00:44:28 -040086struct acpi_pkg_info {
87 u8 *free_space;
88 acpi_size length;
89 u32 object_space;
90 u32 num_packages;
Linus Torvalds1da177e2005-04-16 15:20:36 -070091};
92
93#define REF_INCREMENT (u16) 0
94#define REF_DECREMENT (u16) 1
95#define REF_FORCE_DELETE (u16) 2
96
97/* acpi_ut_dump_buffer */
98
99#define DB_BYTE_DISPLAY 1
100#define DB_WORD_DISPLAY 2
101#define DB_DWORD_DISPLAY 4
102#define DB_QWORD_DISPLAY 8
103
Robert Moore44f6c012005-04-18 22:49:35 -0400104/*
105 * utglobal - Global data structures and procedures
106 */
Len Brown4be44fc2005-08-05 00:44:28 -0400107void acpi_ut_init_globals(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109#if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
110
Len Brown4be44fc2005-08-05 00:44:28 -0400111char *acpi_ut_get_mutex_name(u32 mutex_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112
113#endif
114
Len Brown4be44fc2005-08-05 00:44:28 -0400115char *acpi_ut_get_type_name(acpi_object_type type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116
Len Brown4be44fc2005-08-05 00:44:28 -0400117char *acpi_ut_get_node_name(void *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118
Len Brown4be44fc2005-08-05 00:44:28 -0400119char *acpi_ut_get_descriptor_name(void *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120
Len Brown4be44fc2005-08-05 00:44:28 -0400121char *acpi_ut_get_object_type_name(union acpi_operand_object *obj_desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122
Len Brown4be44fc2005-08-05 00:44:28 -0400123char *acpi_ut_get_region_name(u8 space_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124
Len Brown4be44fc2005-08-05 00:44:28 -0400125char *acpi_ut_get_event_name(u32 event_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126
Len Brown4be44fc2005-08-05 00:44:28 -0400127char acpi_ut_hex_to_ascii_char(acpi_integer integer, u32 position);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128
Len Brown4be44fc2005-08-05 00:44:28 -0400129u8 acpi_ut_valid_object_type(acpi_object_type type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130
131/*
Robert Moore44f6c012005-04-18 22:49:35 -0400132 * utinit - miscellaneous initialization and shutdown
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 */
Len Brown4be44fc2005-08-05 00:44:28 -0400134acpi_status acpi_ut_hardware_initialize(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135
Len Brown4be44fc2005-08-05 00:44:28 -0400136void acpi_ut_subsystem_shutdown(void);
Robert Moore44f6c012005-04-18 22:49:35 -0400137
Len Brown4be44fc2005-08-05 00:44:28 -0400138acpi_status acpi_ut_validate_fadt(void);
Robert Moore44f6c012005-04-18 22:49:35 -0400139
140/*
141 * utclib - Local implementations of C library functions
142 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143#ifndef ACPI_USE_SYSTEM_CLIBRARY
144
Len Brown4be44fc2005-08-05 00:44:28 -0400145acpi_size acpi_ut_strlen(const char *string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146
Len Brown4be44fc2005-08-05 00:44:28 -0400147char *acpi_ut_strcpy(char *dst_string, const char *src_string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148
Len Brown4be44fc2005-08-05 00:44:28 -0400149char *acpi_ut_strncpy(char *dst_string,
150 const char *src_string, acpi_size count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151
Len Brown4be44fc2005-08-05 00:44:28 -0400152int acpi_ut_memcmp(const char *buffer1, const char *buffer2, acpi_size count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153
Len Brown4be44fc2005-08-05 00:44:28 -0400154int acpi_ut_strncmp(const char *string1, const char *string2, acpi_size count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155
Len Brown4be44fc2005-08-05 00:44:28 -0400156int acpi_ut_strcmp(const char *string1, const char *string2);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157
Len Brown4be44fc2005-08-05 00:44:28 -0400158char *acpi_ut_strcat(char *dst_string, const char *src_string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159
Len Brown4be44fc2005-08-05 00:44:28 -0400160char *acpi_ut_strncat(char *dst_string,
161 const char *src_string, acpi_size count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162
Len Brown4be44fc2005-08-05 00:44:28 -0400163u32 acpi_ut_strtoul(const char *string, char **terminator, u32 base);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164
Len Brown4be44fc2005-08-05 00:44:28 -0400165char *acpi_ut_strstr(char *string1, char *string2);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166
Len Brown4be44fc2005-08-05 00:44:28 -0400167void *acpi_ut_memcpy(void *dest, const void *src, acpi_size count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168
Len Brown4be44fc2005-08-05 00:44:28 -0400169void *acpi_ut_memset(void *dest, acpi_native_uint value, acpi_size count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170
Len Brown4be44fc2005-08-05 00:44:28 -0400171int acpi_ut_to_upper(int c);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172
Len Brown4be44fc2005-08-05 00:44:28 -0400173int acpi_ut_to_lower(int c);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174
175extern const u8 _acpi_ctype[];
176
Len Brown4be44fc2005-08-05 00:44:28 -0400177#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' */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187
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))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195
Len Brown4be44fc2005-08-05 00:44:28 -0400196#endif /* ACPI_USE_SYSTEM_CLIBRARY */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197
Robert Moore44f6c012005-04-18 22:49:35 -0400198/*
199 * utcopy - Object construction and conversion interfaces
200 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400202acpi_ut_build_simple_object(union acpi_operand_object *obj,
203 union acpi_object *user_obj,
204 u8 * data_space, u32 * buffer_space_used);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205
206acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400207acpi_ut_build_package_object(union acpi_operand_object *obj,
208 u8 * buffer, u32 * space_used);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209
210acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400211acpi_ut_copy_iobject_to_eobject(union acpi_operand_object *obj,
212 struct acpi_buffer *ret_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213
214acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400215acpi_ut_copy_eobject_to_iobject(union acpi_object *obj,
216 union acpi_operand_object **internal_obj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217
218acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400219acpi_ut_copy_isimple_to_isimple(union acpi_operand_object *source_obj,
220 union acpi_operand_object *dest_obj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221
222acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400223acpi_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);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226
227/*
Robert Moore44f6c012005-04-18 22:49:35 -0400228 * utcreate - Object creation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400231acpi_ut_update_object_reference(union acpi_operand_object *object, u16 action);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232
233/*
Robert Moore44f6c012005-04-18 22:49:35 -0400234 * utdebug - Debug interfaces
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235 */
Len Brown4be44fc2005-08-05 00:44:28 -0400236void acpi_ut_init_stack_ptr_trace(void);
237
238void acpi_ut_track_stack_ptr(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239
240void
Len Brown4be44fc2005-08-05 00:44:28 -0400241acpi_ut_trace(u32 line_number,
242 const char *function_name, char *module_name, u32 component_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243
244void
Len Brown4be44fc2005-08-05 00:44:28 -0400245acpi_ut_trace_ptr(u32 line_number,
246 const char *function_name,
247 char *module_name, u32 component_id, void *pointer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248
249void
Len Brown4be44fc2005-08-05 00:44:28 -0400250acpi_ut_trace_u32(u32 line_number,
251 const char *function_name,
252 char *module_name, u32 component_id, u32 integer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253
254void
Len Brown4be44fc2005-08-05 00:44:28 -0400255acpi_ut_trace_str(u32 line_number,
256 const char *function_name,
257 char *module_name, u32 component_id, char *string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258
259void
Len Brown4be44fc2005-08-05 00:44:28 -0400260acpi_ut_exit(u32 line_number,
261 const char *function_name, char *module_name, u32 component_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262
263void
Len Brown4be44fc2005-08-05 00:44:28 -0400264acpi_ut_status_exit(u32 line_number,
265 const char *function_name,
266 char *module_name, u32 component_id, acpi_status status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267
268void
Len Brown4be44fc2005-08-05 00:44:28 -0400269acpi_ut_value_exit(u32 line_number,
270 const char *function_name,
271 char *module_name, u32 component_id, acpi_integer value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272
273void
Len Brown4be44fc2005-08-05 00:44:28 -0400274acpi_ut_ptr_exit(u32 line_number,
275 const char *function_name,
276 char *module_name, u32 component_id, u8 * ptr);
277
278void acpi_ut_report_info(char *module_name, u32 line_number, u32 component_id);
279
280void acpi_ut_report_error(char *module_name, u32 line_number, u32 component_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281
282void
Len Brown4be44fc2005-08-05 00:44:28 -0400283acpi_ut_report_warning(char *module_name, u32 line_number, u32 component_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284
Len Brown4be44fc2005-08-05 00:44:28 -0400285void acpi_ut_dump_buffer(u8 * buffer, u32 count, u32 display, u32 component_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286
287void ACPI_INTERNAL_VAR_XFACE
Len Brown4be44fc2005-08-05 00:44:28 -0400288acpi_ut_debug_print(u32 requested_debug_level,
289 u32 line_number,
290 const char *function_name,
291 char *module_name,
292 u32 component_id, char *format, ...) ACPI_PRINTF_LIKE_FUNC;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293
294void ACPI_INTERNAL_VAR_XFACE
Len Brown4be44fc2005-08-05 00:44:28 -0400295acpi_ut_debug_print_raw(u32 requested_debug_level,
296 u32 line_number,
297 const char *function_name,
298 char *module_name,
299 u32 component_id,
300 char *format, ...) ACPI_PRINTF_LIKE_FUNC;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301
302/*
Robert Moore44f6c012005-04-18 22:49:35 -0400303 * utdelete - Object deletion and reference counts
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304 */
Len Brown4be44fc2005-08-05 00:44:28 -0400305void acpi_ut_add_reference(union acpi_operand_object *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306
Len Brown4be44fc2005-08-05 00:44:28 -0400307void acpi_ut_remove_reference(union acpi_operand_object *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308
Len Brown4be44fc2005-08-05 00:44:28 -0400309void acpi_ut_delete_internal_package_object(union acpi_operand_object *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310
Len Brown4be44fc2005-08-05 00:44:28 -0400311void acpi_ut_delete_internal_simple_object(union acpi_operand_object *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312
Len Brown4be44fc2005-08-05 00:44:28 -0400313void acpi_ut_delete_internal_object_list(union acpi_operand_object **obj_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314
315/*
Robert Moore44f6c012005-04-18 22:49:35 -0400316 * uteval - object evaluation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317 */
Len Brown4be44fc2005-08-05 00:44:28 -0400318acpi_status acpi_ut_osi_implementation(struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319
320acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400321acpi_ut_evaluate_object(struct acpi_namespace_node *prefix_node,
322 char *path,
323 u32 expected_return_btypes,
324 union acpi_operand_object **return_desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325
326acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400327acpi_ut_evaluate_numeric_object(char *object_name,
328 struct acpi_namespace_node *device_node,
329 acpi_integer * address);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330
331acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400332acpi_ut_execute_HID(struct acpi_namespace_node *device_node,
333 struct acpi_device_id *hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334
335acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400336acpi_ut_execute_CID(struct acpi_namespace_node *device_node,
337 struct acpi_compatible_id_list **return_cid_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338
339acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400340acpi_ut_execute_STA(struct acpi_namespace_node *device_node,
341 u32 * status_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342
343acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400344acpi_ut_execute_UID(struct acpi_namespace_node *device_node,
345 struct acpi_device_id *uid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346
347acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400348acpi_ut_execute_sxds(struct acpi_namespace_node *device_node, u8 * highest);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349
350/*
Robert Moore44f6c012005-04-18 22:49:35 -0400351 * utobject - internal object create/delete/cache routines
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 */
Len Brown4be44fc2005-08-05 00:44:28 -0400353union acpi_operand_object *acpi_ut_create_internal_object_dbg(char *module_name,
354 u32 line_number,
355 u32 component_id,
356 acpi_object_type
357 type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358
Len Brown4be44fc2005-08-05 00:44:28 -0400359void *acpi_ut_allocate_object_desc_dbg(char *module_name,
360 u32 line_number, u32 component_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361
Robert Mooref9f46012005-07-08 00:00:00 -0400362#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)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364
Len Brown4be44fc2005-08-05 00:44:28 -0400365void acpi_ut_delete_object_desc(union acpi_operand_object *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366
Len Brown4be44fc2005-08-05 00:44:28 -0400367u8 acpi_ut_valid_internal_object(void *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368
Len Brown4be44fc2005-08-05 00:44:28 -0400369union acpi_operand_object *acpi_ut_create_buffer_object(acpi_size buffer_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370
Len Brown4be44fc2005-08-05 00:44:28 -0400371union acpi_operand_object *acpi_ut_create_string_object(acpi_size string_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400374acpi_ut_get_object_size(union acpi_operand_object *obj, acpi_size * obj_length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375
376/*
Robert Moore44f6c012005-04-18 22:49:35 -0400377 * utstate - Generic state creation/cache routines
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379void
Len Brown4be44fc2005-08-05 00:44:28 -0400380acpi_ut_push_generic_state(union acpi_generic_state **list_head,
381 union acpi_generic_state *state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382
Len Brown4be44fc2005-08-05 00:44:28 -0400383union acpi_generic_state *acpi_ut_pop_generic_state(union acpi_generic_state
384 **list_head);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385
Len Brown4be44fc2005-08-05 00:44:28 -0400386union acpi_generic_state *acpi_ut_create_generic_state(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387
Len Brown4be44fc2005-08-05 00:44:28 -0400388struct acpi_thread_state *acpi_ut_create_thread_state(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389
Len Brown4be44fc2005-08-05 00:44:28 -0400390union acpi_generic_state *acpi_ut_create_update_state(union acpi_operand_object
391 *object, u16 action);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392
Len Brown4be44fc2005-08-05 00:44:28 -0400393union acpi_generic_state *acpi_ut_create_pkg_state(void *internal_object,
394 void *external_object,
395 u16 index);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396
397acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400398acpi_ut_create_update_state_and_push(union acpi_operand_object *object,
399 u16 action,
400 union acpi_generic_state **state_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401
Robert Moore44f6c012005-04-18 22:49:35 -0400402#ifdef ACPI_FUTURE_USAGE
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400404acpi_ut_create_pkg_state_and_push(void *internal_object,
405 void *external_object,
406 u16 index,
407 union acpi_generic_state **state_list);
408#endif /* ACPI_FUTURE_USAGE */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409
Len Brown4be44fc2005-08-05 00:44:28 -0400410union acpi_generic_state *acpi_ut_create_control_state(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411
Len Brown4be44fc2005-08-05 00:44:28 -0400412void acpi_ut_delete_generic_state(union acpi_generic_state *state);
Robert Moore44f6c012005-04-18 22:49:35 -0400413
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414/*
Robert Moore44f6c012005-04-18 22:49:35 -0400415 * utmath
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400418acpi_ut_divide(acpi_integer in_dividend,
419 acpi_integer in_divisor,
420 acpi_integer * out_quotient, acpi_integer * out_remainder);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421
422acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400423acpi_ut_short_divide(acpi_integer in_dividend,
424 u32 divisor,
425 acpi_integer * out_quotient, u32 * out_remainder);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426
Robert Moore44f6c012005-04-18 22:49:35 -0400427/*
428 * utmisc
429 */
Len Brown4be44fc2005-08-05 00:44:28 -0400430acpi_status acpi_ut_allocate_owner_id(acpi_owner_id * owner_id);
Robert Mooref9f46012005-07-08 00:00:00 -0400431
Len Brown4be44fc2005-08-05 00:44:28 -0400432void acpi_ut_release_owner_id(acpi_owner_id * owner_id);
Robert Mooref9f46012005-07-08 00:00:00 -0400433
434acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400435acpi_ut_walk_package_tree(union acpi_operand_object *source_object,
436 void *target_object,
437 acpi_pkg_callback walk_callback, void *context);
Robert Moore44f6c012005-04-18 22:49:35 -0400438
Len Brown4be44fc2005-08-05 00:44:28 -0400439void acpi_ut_strupr(char *src_string);
Robert Moore44f6c012005-04-18 22:49:35 -0400440
Len Brown4be44fc2005-08-05 00:44:28 -0400441void acpi_ut_print_string(char *string, u8 max_length);
Robert Moore44f6c012005-04-18 22:49:35 -0400442
Len Brown4be44fc2005-08-05 00:44:28 -0400443u8 acpi_ut_valid_acpi_name(u32 name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444
Len Brown4be44fc2005-08-05 00:44:28 -0400445u8 acpi_ut_valid_acpi_character(char character);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446
447acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400448acpi_ut_strtoul64(char *string, u32 base, acpi_integer * ret_integer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449
450/* Values for Base above (16=Hex, 10=Decimal) */
451
452#define ACPI_ANY_BASE 0
453
Bob Moore96db2552005-11-02 00:00:00 -0500454acpi_status acpi_ut_validate_resource(void *aml, u8 * return_index);
455
Bob Moore08978312005-10-21 00:00:00 -0400456u32 acpi_ut_get_descriptor_length(void *aml);
457
458u16 acpi_ut_get_resource_length(void *aml);
459
Bob Moore96db2552005-11-02 00:00:00 -0500460u8 acpi_ut_get_resource_header_length(void *aml);
461
Bob Moore08978312005-10-21 00:00:00 -0400462u8 acpi_ut_get_resource_type(void *aml);
463
Bob Moore96db2552005-11-02 00:00:00 -0500464acpi_status
465acpi_ut_get_resource_end_tag(union acpi_operand_object *obj_desc,
466 u8 ** end_tag);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467
Len Brown4be44fc2005-08-05 00:44:28 -0400468u8 acpi_ut_generate_checksum(u8 * buffer, u32 length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469
Len Brown4be44fc2005-08-05 00:44:28 -0400470u32 acpi_ut_dword_byte_swap(u32 value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471
Len Brown4be44fc2005-08-05 00:44:28 -0400472void acpi_ut_set_integer_width(u8 revision);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473
474#ifdef ACPI_DEBUG_OUTPUT
475void
Len Brown4be44fc2005-08-05 00:44:28 -0400476acpi_ut_display_init_pathname(u8 type,
477 struct acpi_namespace_node *obj_handle,
478 char *path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479
480#endif
481
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482/*
Robert Moore73459f72005-06-24 00:00:00 -0400483 * utmutex - mutex support
484 */
Len Brown4be44fc2005-08-05 00:44:28 -0400485acpi_status acpi_ut_mutex_initialize(void);
Robert Moore73459f72005-06-24 00:00:00 -0400486
Len Brown4be44fc2005-08-05 00:44:28 -0400487void acpi_ut_mutex_terminate(void);
Robert Moore73459f72005-06-24 00:00:00 -0400488
Len Brown4be44fc2005-08-05 00:44:28 -0400489acpi_status acpi_ut_acquire_mutex(acpi_mutex_handle mutex_id);
Robert Moore73459f72005-06-24 00:00:00 -0400490
Len Brown4be44fc2005-08-05 00:44:28 -0400491acpi_status acpi_ut_release_mutex(acpi_mutex_handle mutex_id);
Robert Moore73459f72005-06-24 00:00:00 -0400492
493/*
Robert Moore44f6c012005-04-18 22:49:35 -0400494 * utalloc - memory allocation and object caching
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495 */
Len Brown4be44fc2005-08-05 00:44:28 -0400496acpi_status acpi_ut_create_caches(void);
497
498acpi_status acpi_ut_delete_caches(void);
499
500acpi_status acpi_ut_validate_buffer(struct acpi_buffer *buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501
Robert Moore73459f72005-06-24 00:00:00 -0400502acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400503acpi_ut_initialize_buffer(struct acpi_buffer *buffer,
504 acpi_size required_length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505
Len Brown4be44fc2005-08-05 00:44:28 -0400506void *acpi_ut_allocate(acpi_size size, u32 component, char *module, u32 line);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507
Len Brown4be44fc2005-08-05 00:44:28 -0400508void *acpi_ut_callocate(acpi_size size, u32 component, char *module, u32 line);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510#ifdef ACPI_DBG_TRACK_ALLOCATIONS
Len Brown4be44fc2005-08-05 00:44:28 -0400511void *acpi_ut_allocate_and_track(acpi_size size,
512 u32 component, char *module, u32 line);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513
Len Brown4be44fc2005-08-05 00:44:28 -0400514void *acpi_ut_callocate_and_track(acpi_size size,
515 u32 component, char *module, u32 line);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516
517void
Len Brown4be44fc2005-08-05 00:44:28 -0400518acpi_ut_free_and_track(void *address, u32 component, char *module, u32 line);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519
Robert Moore44f6c012005-04-18 22:49:35 -0400520#ifdef ACPI_FUTURE_USAGE
Len Brown4be44fc2005-08-05 00:44:28 -0400521void acpi_ut_dump_allocation_info(void);
522#endif /* ACPI_FUTURE_USAGE */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523
Len Brown4be44fc2005-08-05 00:44:28 -0400524void acpi_ut_dump_allocations(u32 component, char *module);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525#endif
526
Len Brown4be44fc2005-08-05 00:44:28 -0400527#endif /* _ACUTILS_H */