blob: d8307b2987e371b706ac7e0c96359606fb5cd900 [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/*
Len Brown75a44ce2008-04-23 23:00:13 -04008 * Copyright (C) 2000 - 2008, Intel Corp.
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 */
Yi Yangb417d402008-08-04 10:30:09 +0800113acpi_status 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
Zhang Rui514d18d2008-04-10 19:06:44 +0400119const char *acpi_ut_get_notify_name(u32 notify_value);
120
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121#endif
122
Len Brown4be44fc2005-08-05 00:44:28 -0400123char *acpi_ut_get_type_name(acpi_object_type type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124
Len Brown4be44fc2005-08-05 00:44:28 -0400125char *acpi_ut_get_node_name(void *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126
Len Brown4be44fc2005-08-05 00:44:28 -0400127char *acpi_ut_get_descriptor_name(void *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128
Bob Mooref02a99a2008-08-04 10:40:09 +0800129const char *acpi_ut_get_reference_name(union acpi_operand_object *object);
130
Len Brown4be44fc2005-08-05 00:44:28 -0400131char *acpi_ut_get_object_type_name(union acpi_operand_object *obj_desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132
Len Brown4be44fc2005-08-05 00:44:28 -0400133char *acpi_ut_get_region_name(u8 space_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134
Len Brown4be44fc2005-08-05 00:44:28 -0400135char *acpi_ut_get_event_name(u32 event_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136
Len Brown4be44fc2005-08-05 00:44:28 -0400137char acpi_ut_hex_to_ascii_char(acpi_integer integer, u32 position);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138
Len Brown4be44fc2005-08-05 00:44:28 -0400139u8 acpi_ut_valid_object_type(acpi_object_type type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140
141/*
Robert Moore44f6c012005-04-18 22:49:35 -0400142 * utinit - miscellaneous initialization and shutdown
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143 */
Len Brown4be44fc2005-08-05 00:44:28 -0400144acpi_status acpi_ut_hardware_initialize(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145
Len Brown4be44fc2005-08-05 00:44:28 -0400146void acpi_ut_subsystem_shutdown(void);
Robert Moore44f6c012005-04-18 22:49:35 -0400147
Robert Moore44f6c012005-04-18 22:49:35 -0400148/*
149 * utclib - Local implementations of C library functions
150 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151#ifndef ACPI_USE_SYSTEM_CLIBRARY
152
Len Brown4be44fc2005-08-05 00:44:28 -0400153acpi_size acpi_ut_strlen(const char *string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154
Len Brown4be44fc2005-08-05 00:44:28 -0400155char *acpi_ut_strcpy(char *dst_string, const char *src_string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156
Len Brown4be44fc2005-08-05 00:44:28 -0400157char *acpi_ut_strncpy(char *dst_string,
158 const char *src_string, acpi_size count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159
Len Brown4be44fc2005-08-05 00:44:28 -0400160int acpi_ut_memcmp(const char *buffer1, const char *buffer2, acpi_size count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161
Len Brown4be44fc2005-08-05 00:44:28 -0400162int acpi_ut_strncmp(const char *string1, const char *string2, acpi_size count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163
Len Brown4be44fc2005-08-05 00:44:28 -0400164int acpi_ut_strcmp(const char *string1, const char *string2);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165
Len Brown4be44fc2005-08-05 00:44:28 -0400166char *acpi_ut_strcat(char *dst_string, const char *src_string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167
Len Brown4be44fc2005-08-05 00:44:28 -0400168char *acpi_ut_strncat(char *dst_string,
169 const char *src_string, acpi_size count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170
Len Brown4be44fc2005-08-05 00:44:28 -0400171u32 acpi_ut_strtoul(const char *string, char **terminator, u32 base);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172
Len Brown4be44fc2005-08-05 00:44:28 -0400173char *acpi_ut_strstr(char *string1, char *string2);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174
Len Brown4be44fc2005-08-05 00:44:28 -0400175void *acpi_ut_memcpy(void *dest, const void *src, acpi_size count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176
Bob Moore67a119f2008-06-10 13:42:13 +0800177void *acpi_ut_memset(void *dest, u8 value, acpi_size count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178
Len Brown4be44fc2005-08-05 00:44:28 -0400179int acpi_ut_to_upper(int c);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180
Len Brown4be44fc2005-08-05 00:44:28 -0400181int acpi_ut_to_lower(int c);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182
183extern const u8 _acpi_ctype[];
184
Len Brown4be44fc2005-08-05 00:44:28 -0400185#define _ACPI_XA 0x00 /* extra alphabetic - not supported */
186#define _ACPI_XS 0x40 /* extra space */
187#define _ACPI_BB 0x00 /* BEL, BS, etc. - not supported */
188#define _ACPI_CN 0x20 /* CR, FF, HT, NL, VT */
189#define _ACPI_DI 0x04 /* '0'-'9' */
190#define _ACPI_LO 0x02 /* 'a'-'z' */
191#define _ACPI_PU 0x10 /* punctuation */
192#define _ACPI_SP 0x08 /* space */
193#define _ACPI_UP 0x01 /* 'A'-'Z' */
194#define _ACPI_XD 0x80 /* '0'-'9', 'A'-'F', 'a'-'f' */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195
196#define ACPI_IS_DIGIT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_DI))
197#define ACPI_IS_SPACE(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_SP))
198#define ACPI_IS_XDIGIT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_XD))
199#define ACPI_IS_UPPER(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_UP))
200#define ACPI_IS_LOWER(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO))
201#define ACPI_IS_PRINT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP | _ACPI_DI | _ACPI_SP | _ACPI_PU))
202#define ACPI_IS_ALPHA(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203
Len Brown4be44fc2005-08-05 00:44:28 -0400204#endif /* ACPI_USE_SYSTEM_CLIBRARY */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205
Robert Moore44f6c012005-04-18 22:49:35 -0400206/*
207 * utcopy - Object construction and conversion interfaces
208 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400210acpi_ut_build_simple_object(union acpi_operand_object *obj,
211 union acpi_object *user_obj,
212 u8 * data_space, u32 * buffer_space_used);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213
214acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400215acpi_ut_build_package_object(union acpi_operand_object *obj,
216 u8 * buffer, u32 * space_used);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217
218acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400219acpi_ut_copy_iobject_to_eobject(union acpi_operand_object *obj,
220 struct acpi_buffer *ret_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221
222acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400223acpi_ut_copy_eobject_to_iobject(union acpi_object *obj,
224 union acpi_operand_object **internal_obj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225
226acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400227acpi_ut_copy_isimple_to_isimple(union acpi_operand_object *source_obj,
228 union acpi_operand_object *dest_obj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229
230acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400231acpi_ut_copy_iobject_to_iobject(union acpi_operand_object *source_desc,
232 union acpi_operand_object **dest_desc,
233 struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234
235/*
Robert Moore44f6c012005-04-18 22:49:35 -0400236 * utcreate - Object creation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400239acpi_ut_update_object_reference(union acpi_operand_object *object, u16 action);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240
241/*
Robert Moore44f6c012005-04-18 22:49:35 -0400242 * utdebug - Debug interfaces
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243 */
Len Brown4be44fc2005-08-05 00:44:28 -0400244void acpi_ut_init_stack_ptr_trace(void);
245
246void acpi_ut_track_stack_ptr(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247
248void
Len Brown4be44fc2005-08-05 00:44:28 -0400249acpi_ut_trace(u32 line_number,
Bob Moore4b8ed632008-06-10 13:55:53 +0800250 const char *function_name,
251 const char *module_name, u32 component_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252
253void
Len Brown4be44fc2005-08-05 00:44:28 -0400254acpi_ut_trace_ptr(u32 line_number,
255 const char *function_name,
Bob Moore4b8ed632008-06-10 13:55:53 +0800256 const char *module_name, u32 component_id, void *pointer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257
258void
Len Brown4be44fc2005-08-05 00:44:28 -0400259acpi_ut_trace_u32(u32 line_number,
260 const char *function_name,
Bob Moore4b8ed632008-06-10 13:55:53 +0800261 const char *module_name, u32 component_id, u32 integer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262
263void
Len Brown4be44fc2005-08-05 00:44:28 -0400264acpi_ut_trace_str(u32 line_number,
265 const char *function_name,
Bob Moore4b8ed632008-06-10 13:55:53 +0800266 const char *module_name, u32 component_id, char *string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267
268void
Len Brown4be44fc2005-08-05 00:44:28 -0400269acpi_ut_exit(u32 line_number,
Bob Moore4b8ed632008-06-10 13:55:53 +0800270 const char *function_name,
271 const char *module_name, u32 component_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272
273void
Len Brown4be44fc2005-08-05 00:44:28 -0400274acpi_ut_status_exit(u32 line_number,
275 const char *function_name,
Bob Moore4b8ed632008-06-10 13:55:53 +0800276 const char *module_name,
277 u32 component_id, acpi_status status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278
279void
Len Brown4be44fc2005-08-05 00:44:28 -0400280acpi_ut_value_exit(u32 line_number,
281 const char *function_name,
Bob Moore4b8ed632008-06-10 13:55:53 +0800282 const char *module_name,
283 u32 component_id, acpi_integer value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284
285void
Len Brown4be44fc2005-08-05 00:44:28 -0400286acpi_ut_ptr_exit(u32 line_number,
287 const char *function_name,
Bob Moore4b8ed632008-06-10 13:55:53 +0800288 const char *module_name, u32 component_id, u8 *ptr);
Len Brown4be44fc2005-08-05 00:44:28 -0400289
Bob Mooreb8e4d892006-01-27 16:43:00 -0500290void acpi_ut_dump_buffer(u8 * buffer, u32 count, u32 display, u32 component_id);
291
Bob Moore793c2382006-03-31 00:00:00 -0500292void acpi_ut_dump_buffer2(u8 * buffer, u32 count, u32 display);
293
Bob Moore4a90c7e2006-01-13 16:22:00 -0500294void acpi_ut_report_error(char *module_name, u32 line_number);
Len Brown4be44fc2005-08-05 00:44:28 -0400295
Bob Moore4a90c7e2006-01-13 16:22:00 -0500296void acpi_ut_report_info(char *module_name, u32 line_number);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297
Bob Moore4a90c7e2006-01-13 16:22:00 -0500298void acpi_ut_report_warning(char *module_name, u32 line_number);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299
Bob Mooreb8e4d892006-01-27 16:43:00 -0500300/* Error and message reporting interfaces */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301
302void ACPI_INTERNAL_VAR_XFACE
Len Brown4be44fc2005-08-05 00:44:28 -0400303acpi_ut_debug_print(u32 requested_debug_level,
304 u32 line_number,
305 const char *function_name,
Bob Moore4b8ed632008-06-10 13:55:53 +0800306 const char *module_name,
307 u32 component_id,
308 const char *format, ...) ACPI_PRINTF_LIKE(6);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309
310void ACPI_INTERNAL_VAR_XFACE
Len Brown4be44fc2005-08-05 00:44:28 -0400311acpi_ut_debug_print_raw(u32 requested_debug_level,
312 u32 line_number,
313 const char *function_name,
Bob Moore4b8ed632008-06-10 13:55:53 +0800314 const char *module_name,
Len Brown4be44fc2005-08-05 00:44:28 -0400315 u32 component_id,
Bob Moore4b8ed632008-06-10 13:55:53 +0800316 const char *format, ...) ACPI_PRINTF_LIKE(6);
Bob Mooreb8e4d892006-01-27 16:43:00 -0500317
318void ACPI_INTERNAL_VAR_XFACE
Bob Moore4b8ed632008-06-10 13:55:53 +0800319acpi_ut_error(const char *module_name,
320 u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
Bob Mooreb8e4d892006-01-27 16:43:00 -0500321
322void ACPI_INTERNAL_VAR_XFACE
Bob Moore4b8ed632008-06-10 13:55:53 +0800323acpi_ut_exception(const char *module_name,
Bob Mooreb8e4d892006-01-27 16:43:00 -0500324 u32 line_number,
Bob Moore4b8ed632008-06-10 13:55:53 +0800325 acpi_status status,
326 const char *format, ...) ACPI_PRINTF_LIKE(4);
Bob Mooreb8e4d892006-01-27 16:43:00 -0500327
328void ACPI_INTERNAL_VAR_XFACE
Bob Moore4b8ed632008-06-10 13:55:53 +0800329acpi_ut_warning(const char *module_name,
330 u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
Bob Mooreb8e4d892006-01-27 16:43:00 -0500331
332void ACPI_INTERNAL_VAR_XFACE
Bob Moore4b8ed632008-06-10 13:55:53 +0800333acpi_ut_info(const char *module_name,
334 u32 line_number, const char *format, ...) ACPI_PRINTF_LIKE(3);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335
336/*
Robert Moore44f6c012005-04-18 22:49:35 -0400337 * utdelete - Object deletion and reference counts
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338 */
Len Brown4be44fc2005-08-05 00:44:28 -0400339void acpi_ut_add_reference(union acpi_operand_object *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340
Len Brown4be44fc2005-08-05 00:44:28 -0400341void acpi_ut_remove_reference(union acpi_operand_object *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342
Len Brown4be44fc2005-08-05 00:44:28 -0400343void acpi_ut_delete_internal_package_object(union acpi_operand_object *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344
Len Brown4be44fc2005-08-05 00:44:28 -0400345void acpi_ut_delete_internal_simple_object(union acpi_operand_object *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346
Len Brown4be44fc2005-08-05 00:44:28 -0400347void acpi_ut_delete_internal_object_list(union acpi_operand_object **obj_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348
349/*
Robert Moore44f6c012005-04-18 22:49:35 -0400350 * uteval - object evaluation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351 */
Len Brown4be44fc2005-08-05 00:44:28 -0400352acpi_status acpi_ut_osi_implementation(struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353
354acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400355acpi_ut_evaluate_object(struct acpi_namespace_node *prefix_node,
356 char *path,
357 u32 expected_return_btypes,
358 union acpi_operand_object **return_desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359
360acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400361acpi_ut_evaluate_numeric_object(char *object_name,
362 struct acpi_namespace_node *device_node,
363 acpi_integer * address);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364
365acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400366acpi_ut_execute_HID(struct acpi_namespace_node *device_node,
Thomas Renninger8c8eb782007-07-23 14:43:32 +0200367 struct acpica_device_id *hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368
369acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400370acpi_ut_execute_CID(struct acpi_namespace_node *device_node,
371 struct acpi_compatible_id_list **return_cid_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372
373acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400374acpi_ut_execute_STA(struct acpi_namespace_node *device_node,
375 u32 * status_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376
377acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400378acpi_ut_execute_UID(struct acpi_namespace_node *device_node,
Thomas Renninger8c8eb782007-07-23 14:43:32 +0200379 struct acpica_device_id *uid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380
381acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400382acpi_ut_execute_sxds(struct acpi_namespace_node *device_node, u8 * highest);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383
384/*
Robert Moore44f6c012005-04-18 22:49:35 -0400385 * utobject - internal object create/delete/cache routines
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386 */
Bob Moore4b8ed632008-06-10 13:55:53 +0800387union acpi_operand_object *acpi_ut_create_internal_object_dbg(const char
388 *module_name,
Len Brown4be44fc2005-08-05 00:44:28 -0400389 u32 line_number,
390 u32 component_id,
391 acpi_object_type
392 type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393
Bob Moore4b8ed632008-06-10 13:55:53 +0800394void *acpi_ut_allocate_object_desc_dbg(const char *module_name,
Len Brown4be44fc2005-08-05 00:44:28 -0400395 u32 line_number, u32 component_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396
Robert Mooref9f46012005-07-08 00:00:00 -0400397#define acpi_ut_create_internal_object(t) acpi_ut_create_internal_object_dbg (_acpi_module_name,__LINE__,_COMPONENT,t)
398#define acpi_ut_allocate_object_desc() acpi_ut_allocate_object_desc_dbg (_acpi_module_name,__LINE__,_COMPONENT)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399
Len Brown4be44fc2005-08-05 00:44:28 -0400400void acpi_ut_delete_object_desc(union acpi_operand_object *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401
Len Brown4be44fc2005-08-05 00:44:28 -0400402u8 acpi_ut_valid_internal_object(void *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403
Bob Moore6287ee32007-04-03 19:59:37 -0400404union acpi_operand_object *acpi_ut_create_package_object(u32 count);
405
Len Brown4be44fc2005-08-05 00:44:28 -0400406union acpi_operand_object *acpi_ut_create_buffer_object(acpi_size buffer_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407
Len Brown4be44fc2005-08-05 00:44:28 -0400408union acpi_operand_object *acpi_ut_create_string_object(acpi_size string_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400411acpi_ut_get_object_size(union acpi_operand_object *obj, acpi_size * obj_length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412
413/*
Robert Moore44f6c012005-04-18 22:49:35 -0400414 * utstate - Generic state creation/cache routines
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416void
Len Brown4be44fc2005-08-05 00:44:28 -0400417acpi_ut_push_generic_state(union acpi_generic_state **list_head,
418 union acpi_generic_state *state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419
Len Brown4be44fc2005-08-05 00:44:28 -0400420union acpi_generic_state *acpi_ut_pop_generic_state(union acpi_generic_state
421 **list_head);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422
Len Brown4be44fc2005-08-05 00:44:28 -0400423union acpi_generic_state *acpi_ut_create_generic_state(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424
Len Brown4be44fc2005-08-05 00:44:28 -0400425struct acpi_thread_state *acpi_ut_create_thread_state(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426
Len Brown4be44fc2005-08-05 00:44:28 -0400427union acpi_generic_state *acpi_ut_create_update_state(union acpi_operand_object
428 *object, u16 action);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429
Len Brown4be44fc2005-08-05 00:44:28 -0400430union acpi_generic_state *acpi_ut_create_pkg_state(void *internal_object,
431 void *external_object,
432 u16 index);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433
434acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400435acpi_ut_create_update_state_and_push(union acpi_operand_object *object,
436 u16 action,
437 union acpi_generic_state **state_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438
Robert Moore44f6c012005-04-18 22:49:35 -0400439#ifdef ACPI_FUTURE_USAGE
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400441acpi_ut_create_pkg_state_and_push(void *internal_object,
442 void *external_object,
443 u16 index,
444 union acpi_generic_state **state_list);
445#endif /* ACPI_FUTURE_USAGE */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446
Len Brown4be44fc2005-08-05 00:44:28 -0400447union acpi_generic_state *acpi_ut_create_control_state(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448
Len Brown4be44fc2005-08-05 00:44:28 -0400449void acpi_ut_delete_generic_state(union acpi_generic_state *state);
Robert Moore44f6c012005-04-18 22:49:35 -0400450
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451/*
Robert Moore44f6c012005-04-18 22:49:35 -0400452 * utmath
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400455acpi_ut_divide(acpi_integer in_dividend,
456 acpi_integer in_divisor,
457 acpi_integer * out_quotient, acpi_integer * out_remainder);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458
459acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400460acpi_ut_short_divide(acpi_integer in_dividend,
461 u32 divisor,
462 acpi_integer * out_quotient, u32 * out_remainder);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463
Robert Moore44f6c012005-04-18 22:49:35 -0400464/*
465 * utmisc
466 */
Bob Moore84fb2c92007-02-02 19:48:19 +0300467const char *acpi_ut_validate_exception(acpi_status status);
468
Bob Moore793c2382006-03-31 00:00:00 -0500469u8 acpi_ut_is_aml_table(struct acpi_table_header *table);
470
Len Brown4be44fc2005-08-05 00:44:28 -0400471acpi_status acpi_ut_allocate_owner_id(acpi_owner_id * owner_id);
Robert Mooref9f46012005-07-08 00:00:00 -0400472
Len Brown4be44fc2005-08-05 00:44:28 -0400473void acpi_ut_release_owner_id(acpi_owner_id * owner_id);
Robert Mooref9f46012005-07-08 00:00:00 -0400474
475acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400476acpi_ut_walk_package_tree(union acpi_operand_object *source_object,
477 void *target_object,
478 acpi_pkg_callback walk_callback, void *context);
Robert Moore44f6c012005-04-18 22:49:35 -0400479
Len Brown4be44fc2005-08-05 00:44:28 -0400480void acpi_ut_strupr(char *src_string);
Robert Moore44f6c012005-04-18 22:49:35 -0400481
Len Brown4be44fc2005-08-05 00:44:28 -0400482void acpi_ut_print_string(char *string, u8 max_length);
Robert Moore44f6c012005-04-18 22:49:35 -0400483
Len Brown4be44fc2005-08-05 00:44:28 -0400484u8 acpi_ut_valid_acpi_name(u32 name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485
Bob Moore3d81b232007-02-02 19:48:19 +0300486acpi_name acpi_ut_repair_name(char *name);
Bob Moore793c2382006-03-31 00:00:00 -0500487
Bob Moore67a119f2008-06-10 13:42:13 +0800488u8 acpi_ut_valid_acpi_char(char character, u32 position);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489
490acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400491acpi_ut_strtoul64(char *string, u32 base, acpi_integer * ret_integer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492
493/* Values for Base above (16=Hex, 10=Decimal) */
494
495#define ACPI_ANY_BASE 0
496
Bob Moore616861242006-03-17 16:44:00 -0500497u32 acpi_ut_dword_byte_swap(u32 value);
498
499void acpi_ut_set_integer_width(u8 revision);
500
501#ifdef ACPI_DEBUG_OUTPUT
502void
503acpi_ut_display_init_pathname(u8 type,
504 struct acpi_namespace_node *obj_handle,
505 char *path);
506#endif
507
508/*
509 * utresrc
510 */
511acpi_status
512acpi_ut_walk_aml_resources(u8 * aml,
513 acpi_size aml_length,
Len Brownfd350942007-05-09 23:34:35 -0400514 acpi_walk_aml_callback user_function,
515 void **context);
Bob Moore616861242006-03-17 16:44:00 -0500516
Bob Moore96db2552005-11-02 00:00:00 -0500517acpi_status acpi_ut_validate_resource(void *aml, u8 * return_index);
518
Bob Moore08978312005-10-21 00:00:00 -0400519u32 acpi_ut_get_descriptor_length(void *aml);
520
521u16 acpi_ut_get_resource_length(void *aml);
522
Bob Moore96db2552005-11-02 00:00:00 -0500523u8 acpi_ut_get_resource_header_length(void *aml);
524
Bob Moore08978312005-10-21 00:00:00 -0400525u8 acpi_ut_get_resource_type(void *aml);
526
Bob Moore96db2552005-11-02 00:00:00 -0500527acpi_status
528acpi_ut_get_resource_end_tag(union acpi_operand_object *obj_desc,
529 u8 ** end_tag);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531/*
Robert Moore73459f72005-06-24 00:00:00 -0400532 * utmutex - mutex support
533 */
Len Brown4be44fc2005-08-05 00:44:28 -0400534acpi_status acpi_ut_mutex_initialize(void);
Robert Moore73459f72005-06-24 00:00:00 -0400535
Len Brown4be44fc2005-08-05 00:44:28 -0400536void acpi_ut_mutex_terminate(void);
Robert Moore73459f72005-06-24 00:00:00 -0400537
Len Brown4be44fc2005-08-05 00:44:28 -0400538acpi_status acpi_ut_acquire_mutex(acpi_mutex_handle mutex_id);
Robert Moore73459f72005-06-24 00:00:00 -0400539
Len Brown4be44fc2005-08-05 00:44:28 -0400540acpi_status acpi_ut_release_mutex(acpi_mutex_handle mutex_id);
Robert Moore73459f72005-06-24 00:00:00 -0400541
542/*
Robert Moore44f6c012005-04-18 22:49:35 -0400543 * utalloc - memory allocation and object caching
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544 */
Len Brown4be44fc2005-08-05 00:44:28 -0400545acpi_status acpi_ut_create_caches(void);
546
547acpi_status acpi_ut_delete_caches(void);
548
549acpi_status acpi_ut_validate_buffer(struct acpi_buffer *buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550
Robert Moore73459f72005-06-24 00:00:00 -0400551acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400552acpi_ut_initialize_buffer(struct acpi_buffer *buffer,
553 acpi_size required_length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554
Bob Moore4b8ed632008-06-10 13:55:53 +0800555void *acpi_ut_allocate(acpi_size size,
556 u32 component, const char *module, u32 line);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557
Bob Moore616861242006-03-17 16:44:00 -0500558void *acpi_ut_allocate_zeroed(acpi_size size,
Bob Moore4b8ed632008-06-10 13:55:53 +0800559 u32 component, const char *module, u32 line);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561#ifdef ACPI_DBG_TRACK_ALLOCATIONS
Len Brown4be44fc2005-08-05 00:44:28 -0400562void *acpi_ut_allocate_and_track(acpi_size size,
Bob Moore4b8ed632008-06-10 13:55:53 +0800563 u32 component, const char *module, u32 line);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564
Bob Moore616861242006-03-17 16:44:00 -0500565void *acpi_ut_allocate_zeroed_and_track(acpi_size size,
Bob Moore4b8ed632008-06-10 13:55:53 +0800566 u32 component,
567 const char *module, u32 line);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568
569void
Bob Moore4b8ed632008-06-10 13:55:53 +0800570acpi_ut_free_and_track(void *address,
571 u32 component, const char *module, u32 line);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572
Robert Moore44f6c012005-04-18 22:49:35 -0400573#ifdef ACPI_FUTURE_USAGE
Len Brown4be44fc2005-08-05 00:44:28 -0400574void acpi_ut_dump_allocation_info(void);
575#endif /* ACPI_FUTURE_USAGE */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576
Bob Moore4b8ed632008-06-10 13:55:53 +0800577void acpi_ut_dump_allocations(u32 component, const char *module);
Bob Moore616861242006-03-17 16:44:00 -0500578
579acpi_status
580acpi_ut_create_list(char *list_name,
581 u16 object_size, struct acpi_memory_list **return_cache);
582
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583#endif
584
Len Brown4be44fc2005-08-05 00:44:28 -0400585#endif /* _ACUTILS_H */