blob: ceeec0b7ccb1764b1e8bc1bd4b7e91ef1f7b372c [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 Moorefbb7a2d2014-02-08 09:42:25 +08008 * Copyright (C) 2000 - 2014, 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[];
Lin Minge0fe0a82011-11-16 14:38:13 +080048extern const u8 acpi_gbl_resource_aml_serial_bus_sizes[];
Bob Moore96db2552005-11-02 00:00:00 -050049
Bob Mooredefba1d2005-12-16 17:05:00 -050050/* Strings used by the disassembler and debugger resource dump routines */
51
Lv Zheng33348612014-02-08 09:42:46 +080052#if defined(ACPI_DEBUG_OUTPUT) || defined (ACPI_DISASSEMBLER) || defined (ACPI_DEBUGGER)
Bob Mooredefba1d2005-12-16 17:05:00 -050053
Bob Mooreb229cf92006-04-21 17:15:00 -040054extern const char *acpi_gbl_bm_decode[];
55extern const char *acpi_gbl_config_decode[];
56extern const char *acpi_gbl_consume_decode[];
57extern const char *acpi_gbl_dec_decode[];
58extern const char *acpi_gbl_he_decode[];
59extern const char *acpi_gbl_io_decode[];
60extern const char *acpi_gbl_ll_decode[];
61extern const char *acpi_gbl_max_decode[];
62extern const char *acpi_gbl_mem_decode[];
63extern const char *acpi_gbl_min_decode[];
64extern const char *acpi_gbl_mtp_decode[];
65extern const char *acpi_gbl_rng_decode[];
66extern const char *acpi_gbl_rw_decode[];
67extern const char *acpi_gbl_shr_decode[];
68extern const char *acpi_gbl_siz_decode[];
69extern const char *acpi_gbl_trs_decode[];
70extern const char *acpi_gbl_ttp_decode[];
71extern const char *acpi_gbl_typ_decode[];
Lv Zheng6d33b6b2012-10-31 02:25:05 +000072extern const char *acpi_gbl_ppc_decode[];
73extern const char *acpi_gbl_ior_decode[];
74extern const char *acpi_gbl_dts_decode[];
75extern const char *acpi_gbl_ct_decode[];
76extern const char *acpi_gbl_sbt_decode[];
77extern const char *acpi_gbl_am_decode[];
78extern const char *acpi_gbl_sm_decode[];
79extern const char *acpi_gbl_wm_decode[];
80extern const char *acpi_gbl_cph_decode[];
81extern const char *acpi_gbl_cpo_decode[];
82extern const char *acpi_gbl_dp_decode[];
83extern const char *acpi_gbl_ed_decode[];
84extern const char *acpi_gbl_bpb_decode[];
85extern const char *acpi_gbl_sb_decode[];
86extern const char *acpi_gbl_fc_decode[];
87extern const char *acpi_gbl_pt_decode[];
Bob Mooredefba1d2005-12-16 17:05:00 -050088#endif
89
Bob Mooreb6872ff2013-06-08 00:58:00 +000090/*
91 * For the iASL compiler case, the output is redirected to stderr so that
92 * any of the various ACPI errors and warnings do not appear in the output
93 * files, for either the compiler or disassembler portions of the tool.
94 */
95#ifdef ACPI_ASL_COMPILER
96
97#include <stdio.h>
98extern FILE *acpi_gbl_output_file;
99
100#define ACPI_MSG_REDIRECT_BEGIN \
101 FILE *output_file = acpi_gbl_output_file; \
102 acpi_os_redirect_output (stderr);
103
104#define ACPI_MSG_REDIRECT_END \
105 acpi_os_redirect_output (output_file);
106
107#else
108/*
109 * non-iASL case - no redirection, nothing to do
110 */
111#define ACPI_MSG_REDIRECT_BEGIN
112#define ACPI_MSG_REDIRECT_END
113#endif
114
115/*
116 * Common error message prefixes
117 */
118#define ACPI_MSG_ERROR "ACPI Error: "
119#define ACPI_MSG_EXCEPTION "ACPI Exception: "
120#define ACPI_MSG_WARNING "ACPI Warning: "
121#define ACPI_MSG_INFO "ACPI: "
122
123#define ACPI_MSG_BIOS_ERROR "ACPI BIOS Error (bug): "
124#define ACPI_MSG_BIOS_WARNING "ACPI BIOS Warning (bug): "
125
126/*
127 * Common message suffix
128 */
129#define ACPI_MSG_SUFFIX \
130 acpi_os_printf (" (%8.8X/%s-%u)\n", ACPI_CA_VERSION, module_name, line_number)
131
Bob Moore96db2552005-11-02 00:00:00 -0500132/* Types for Resource descriptor entries */
133
134#define ACPI_INVALID_RESOURCE 0
135#define ACPI_FIXED_LENGTH 1
136#define ACPI_VARIABLE_LENGTH 2
137#define ACPI_SMALL_VARIABLE_LENGTH 3
138
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139typedef
Lv Zheng6d33b6b2012-10-31 02:25:05 +0000140acpi_status(*acpi_walk_aml_callback) (u8 *aml,
Bob Moore616861242006-03-17 16:44:00 -0500141 u32 length,
142 u32 offset,
Bob Mooreb229cf92006-04-21 17:15:00 -0400143 u8 resource_index, void **context);
Bob Moore616861242006-03-17 16:44:00 -0500144
145typedef
Len Brown4be44fc2005-08-05 00:44:28 -0400146acpi_status(*acpi_pkg_callback) (u8 object_type,
Lv Zheng6d33b6b2012-10-31 02:25:05 +0000147 union acpi_operand_object *source_object,
Len Brown4be44fc2005-08-05 00:44:28 -0400148 union acpi_generic_state * state,
149 void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150
Len Brown4be44fc2005-08-05 00:44:28 -0400151struct acpi_pkg_info {
152 u8 *free_space;
153 acpi_size length;
154 u32 object_space;
155 u32 num_packages;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156};
157
Bob Moore60f3deb2013-04-12 00:25:29 +0000158/* Object reference counts */
159
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160#define REF_INCREMENT (u16) 0
161#define REF_DECREMENT (u16) 1
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162
163/* acpi_ut_dump_buffer */
164
165#define DB_BYTE_DISPLAY 1
166#define DB_WORD_DISPLAY 2
167#define DB_DWORD_DISPLAY 4
168#define DB_QWORD_DISPLAY 8
169
Robert Moore44f6c012005-04-18 22:49:35 -0400170/*
171 * utglobal - Global data structures and procedures
172 */
Yi Yangb417d402008-08-04 10:30:09 +0800173acpi_status acpi_ut_init_globals(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175#if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
176
Len Brown4be44fc2005-08-05 00:44:28 -0400177char *acpi_ut_get_mutex_name(u32 mutex_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178
Zhang Rui514d18d2008-04-10 19:06:44 +0400179const char *acpi_ut_get_notify_name(u32 notify_value);
180
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181#endif
182
Len Brown4be44fc2005-08-05 00:44:28 -0400183char *acpi_ut_get_type_name(acpi_object_type type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184
Len Brown4be44fc2005-08-05 00:44:28 -0400185char *acpi_ut_get_node_name(void *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186
Len Brown4be44fc2005-08-05 00:44:28 -0400187char *acpi_ut_get_descriptor_name(void *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188
Bob Mooref02a99a2008-08-04 10:40:09 +0800189const char *acpi_ut_get_reference_name(union acpi_operand_object *object);
190
Len Brown4be44fc2005-08-05 00:44:28 -0400191char *acpi_ut_get_object_type_name(union acpi_operand_object *obj_desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192
Len Brown4be44fc2005-08-05 00:44:28 -0400193char *acpi_ut_get_region_name(u8 space_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194
Len Brown4be44fc2005-08-05 00:44:28 -0400195char *acpi_ut_get_event_name(u32 event_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196
Bob Moore5df7e6c2010-01-21 10:06:32 +0800197char acpi_ut_hex_to_ascii_char(u64 integer, u32 position);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198
Len Brown4be44fc2005-08-05 00:44:28 -0400199u8 acpi_ut_valid_object_type(acpi_object_type type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200
201/*
Robert Moore44f6c012005-04-18 22:49:35 -0400202 * utinit - miscellaneous initialization and shutdown
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203 */
Len Brown4be44fc2005-08-05 00:44:28 -0400204acpi_status acpi_ut_hardware_initialize(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205
Len Brown4be44fc2005-08-05 00:44:28 -0400206void acpi_ut_subsystem_shutdown(void);
Robert Moore44f6c012005-04-18 22:49:35 -0400207
Robert Moore44f6c012005-04-18 22:49:35 -0400208/*
209 * utclib - Local implementations of C library functions
210 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211#ifndef ACPI_USE_SYSTEM_CLIBRARY
212
Len Brown4be44fc2005-08-05 00:44:28 -0400213acpi_size acpi_ut_strlen(const char *string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214
Len Brown4be44fc2005-08-05 00:44:28 -0400215char *acpi_ut_strcpy(char *dst_string, const char *src_string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216
Len Brown4be44fc2005-08-05 00:44:28 -0400217char *acpi_ut_strncpy(char *dst_string,
218 const char *src_string, acpi_size count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219
Len Brown4be44fc2005-08-05 00:44:28 -0400220int acpi_ut_memcmp(const char *buffer1, const char *buffer2, acpi_size count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221
Len Brown4be44fc2005-08-05 00:44:28 -0400222int acpi_ut_strncmp(const char *string1, const char *string2, acpi_size count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223
Len Brown4be44fc2005-08-05 00:44:28 -0400224int acpi_ut_strcmp(const char *string1, const char *string2);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225
Len Brown4be44fc2005-08-05 00:44:28 -0400226char *acpi_ut_strcat(char *dst_string, const char *src_string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227
Len Brown4be44fc2005-08-05 00:44:28 -0400228char *acpi_ut_strncat(char *dst_string,
229 const char *src_string, acpi_size count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230
Len Brown4be44fc2005-08-05 00:44:28 -0400231u32 acpi_ut_strtoul(const char *string, char **terminator, u32 base);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232
Len Brown4be44fc2005-08-05 00:44:28 -0400233char *acpi_ut_strstr(char *string1, char *string2);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234
Len Brown4be44fc2005-08-05 00:44:28 -0400235void *acpi_ut_memcpy(void *dest, const void *src, acpi_size count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236
Bob Moore67a119f2008-06-10 13:42:13 +0800237void *acpi_ut_memset(void *dest, u8 value, acpi_size count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238
Len Brown4be44fc2005-08-05 00:44:28 -0400239int acpi_ut_to_upper(int c);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240
Len Brown4be44fc2005-08-05 00:44:28 -0400241int acpi_ut_to_lower(int c);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242
243extern const u8 _acpi_ctype[];
244
Len Brown4be44fc2005-08-05 00:44:28 -0400245#define _ACPI_XA 0x00 /* extra alphabetic - not supported */
246#define _ACPI_XS 0x40 /* extra space */
247#define _ACPI_BB 0x00 /* BEL, BS, etc. - not supported */
248#define _ACPI_CN 0x20 /* CR, FF, HT, NL, VT */
249#define _ACPI_DI 0x04 /* '0'-'9' */
250#define _ACPI_LO 0x02 /* 'a'-'z' */
251#define _ACPI_PU 0x10 /* punctuation */
252#define _ACPI_SP 0x08 /* space */
253#define _ACPI_UP 0x01 /* 'A'-'Z' */
254#define _ACPI_XD 0x80 /* '0'-'9', 'A'-'F', 'a'-'f' */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255
256#define ACPI_IS_DIGIT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_DI))
257#define ACPI_IS_SPACE(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_SP))
258#define ACPI_IS_XDIGIT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_XD))
259#define ACPI_IS_UPPER(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_UP))
260#define ACPI_IS_LOWER(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO))
261#define ACPI_IS_PRINT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP | _ACPI_DI | _ACPI_SP | _ACPI_PU))
262#define ACPI_IS_ALPHA(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263
Lv Zheng6d33b6b2012-10-31 02:25:05 +0000264#endif /* !ACPI_USE_SYSTEM_CLIBRARY */
265
266#define ACPI_IS_ASCII(c) ((c) < 0x80)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267
Robert Moore44f6c012005-04-18 22:49:35 -0400268/*
269 * utcopy - Object construction and conversion interfaces
270 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400272acpi_ut_build_simple_object(union acpi_operand_object *obj,
273 union acpi_object *user_obj,
Lv Zheng6d33b6b2012-10-31 02:25:05 +0000274 u8 *data_space, u32 *buffer_space_used);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275
276acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400277acpi_ut_build_package_object(union acpi_operand_object *obj,
Lv Zheng6d33b6b2012-10-31 02:25:05 +0000278 u8 *buffer, u32 *space_used);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279
280acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400281acpi_ut_copy_iobject_to_eobject(union acpi_operand_object *obj,
282 struct acpi_buffer *ret_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283
284acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400285acpi_ut_copy_eobject_to_iobject(union acpi_object *obj,
286 union acpi_operand_object **internal_obj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287
288acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400289acpi_ut_copy_isimple_to_isimple(union acpi_operand_object *source_obj,
290 union acpi_operand_object *dest_obj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291
292acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400293acpi_ut_copy_iobject_to_iobject(union acpi_operand_object *source_desc,
294 union acpi_operand_object **dest_desc,
295 struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296
297/*
Robert Moore44f6c012005-04-18 22:49:35 -0400298 * utcreate - Object creation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400301acpi_ut_update_object_reference(union acpi_operand_object *object, u16 action);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302
303/*
Robert Moore44f6c012005-04-18 22:49:35 -0400304 * utdebug - Debug interfaces
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305 */
Len Brown4be44fc2005-08-05 00:44:28 -0400306void acpi_ut_init_stack_ptr_trace(void);
307
308void acpi_ut_track_stack_ptr(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309
310void
Len Brown4be44fc2005-08-05 00:44:28 -0400311acpi_ut_trace(u32 line_number,
Bob Moore4b8ed632008-06-10 13:55:53 +0800312 const char *function_name,
313 const char *module_name, u32 component_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314
315void
Len Brown4be44fc2005-08-05 00:44:28 -0400316acpi_ut_trace_ptr(u32 line_number,
317 const char *function_name,
Bob Moore4b8ed632008-06-10 13:55:53 +0800318 const char *module_name, u32 component_id, void *pointer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319
320void
Len Brown4be44fc2005-08-05 00:44:28 -0400321acpi_ut_trace_u32(u32 line_number,
322 const char *function_name,
Bob Moore4b8ed632008-06-10 13:55:53 +0800323 const char *module_name, u32 component_id, u32 integer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324
325void
Len Brown4be44fc2005-08-05 00:44:28 -0400326acpi_ut_trace_str(u32 line_number,
327 const char *function_name,
Bob Moore4b8ed632008-06-10 13:55:53 +0800328 const char *module_name, u32 component_id, char *string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329
330void
Len Brown4be44fc2005-08-05 00:44:28 -0400331acpi_ut_exit(u32 line_number,
Bob Moore4b8ed632008-06-10 13:55:53 +0800332 const char *function_name,
333 const char *module_name, u32 component_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334
335void
Len Brown4be44fc2005-08-05 00:44:28 -0400336acpi_ut_status_exit(u32 line_number,
337 const char *function_name,
Bob Moore4b8ed632008-06-10 13:55:53 +0800338 const char *module_name,
339 u32 component_id, acpi_status status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340
341void
Len Brown4be44fc2005-08-05 00:44:28 -0400342acpi_ut_value_exit(u32 line_number,
343 const char *function_name,
Bob Moore5df7e6c2010-01-21 10:06:32 +0800344 const char *module_name, u32 component_id, u64 value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345
346void
Len Brown4be44fc2005-08-05 00:44:28 -0400347acpi_ut_ptr_exit(u32 line_number,
348 const char *function_name,
Bob Moore4b8ed632008-06-10 13:55:53 +0800349 const char *module_name, u32 component_id, u8 *ptr);
Len Brown4be44fc2005-08-05 00:44:28 -0400350
Bob Moore97171c62012-10-31 02:28:11 +0000351void
352acpi_ut_debug_dump_buffer(u8 *buffer, u32 count, u32 display, u32 component_id);
Bob Mooreb8e4d892006-01-27 16:43:00 -0500353
Bob Moore97171c62012-10-31 02:28:11 +0000354void acpi_ut_dump_buffer(u8 *buffer, u32 count, u32 display, u32 offset);
Bob Moore793c2382006-03-31 00:00:00 -0500355
Bob Moore4a90c7e2006-01-13 16:22:00 -0500356void acpi_ut_report_error(char *module_name, u32 line_number);
Len Brown4be44fc2005-08-05 00:44:28 -0400357
Bob Moore4a90c7e2006-01-13 16:22:00 -0500358void acpi_ut_report_info(char *module_name, u32 line_number);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359
Bob Moore4a90c7e2006-01-13 16:22:00 -0500360void acpi_ut_report_warning(char *module_name, u32 line_number);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362/*
Robert Moore44f6c012005-04-18 22:49:35 -0400363 * utdelete - Object deletion and reference counts
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 */
Len Brown4be44fc2005-08-05 00:44:28 -0400365void acpi_ut_add_reference(union acpi_operand_object *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366
Len Brown4be44fc2005-08-05 00:44:28 -0400367void acpi_ut_remove_reference(union acpi_operand_object *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368
Len Brown4be44fc2005-08-05 00:44:28 -0400369void acpi_ut_delete_internal_package_object(union acpi_operand_object *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370
Len Brown4be44fc2005-08-05 00:44:28 -0400371void acpi_ut_delete_internal_simple_object(union acpi_operand_object *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372
Len Brown4be44fc2005-08-05 00:44:28 -0400373void acpi_ut_delete_internal_object_list(union acpi_operand_object **obj_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374
375/*
Robert Moore44f6c012005-04-18 22:49:35 -0400376 * uteval - object evaluation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400379acpi_ut_evaluate_object(struct acpi_namespace_node *prefix_node,
380 char *path,
381 u32 expected_return_btypes,
382 union acpi_operand_object **return_desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383
384acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400385acpi_ut_evaluate_numeric_object(char *object_name,
386 struct acpi_namespace_node *device_node,
Bob Moore5df7e6c2010-01-21 10:06:32 +0800387 u64 *value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388
389acpi_status
Bob Moore15b8dd52009-06-29 13:39:29 +0800390acpi_ut_execute_STA(struct acpi_namespace_node *device_node, u32 *status_flags);
391
392acpi_status
393acpi_ut_execute_power_methods(struct acpi_namespace_node *device_node,
394 const char **method_names,
395 u8 method_count, u8 *out_values);
396
397/*
398 * utids - device ID support
399 */
400acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400401acpi_ut_execute_HID(struct acpi_namespace_node *device_node,
Lv Zheng78e25fe2012-10-31 02:25:24 +0000402 struct acpi_pnp_device_id ** return_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403
404acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400405acpi_ut_execute_UID(struct acpi_namespace_node *device_node,
Lv Zheng78e25fe2012-10-31 02:25:24 +0000406 struct acpi_pnp_device_id ** return_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407
408acpi_status
Bob Moore413fc3f2012-10-31 02:28:38 +0000409acpi_ut_execute_SUB(struct acpi_namespace_node *device_node,
410 struct acpi_pnp_device_id **return_id);
411
412acpi_status
Bob Moore15b8dd52009-06-29 13:39:29 +0800413acpi_ut_execute_CID(struct acpi_namespace_node *device_node,
Lv Zheng78e25fe2012-10-31 02:25:24 +0000414 struct acpi_pnp_device_id_list ** return_cid_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415
416/*
Bob Moore8a335a232009-03-09 16:31:04 +0800417 * utlock - reader/writer locks
418 */
419acpi_status acpi_ut_create_rw_lock(struct acpi_rw_lock *lock);
420
421void acpi_ut_delete_rw_lock(struct acpi_rw_lock *lock);
422
423acpi_status acpi_ut_acquire_read_lock(struct acpi_rw_lock *lock);
424
425acpi_status acpi_ut_release_read_lock(struct acpi_rw_lock *lock);
426
427acpi_status acpi_ut_acquire_write_lock(struct acpi_rw_lock *lock);
428
429void acpi_ut_release_write_lock(struct acpi_rw_lock *lock);
430
431/*
Robert Moore44f6c012005-04-18 22:49:35 -0400432 * utobject - internal object create/delete/cache routines
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433 */
Bob Moore4b8ed632008-06-10 13:55:53 +0800434union acpi_operand_object *acpi_ut_create_internal_object_dbg(const char
435 *module_name,
Len Brown4be44fc2005-08-05 00:44:28 -0400436 u32 line_number,
437 u32 component_id,
438 acpi_object_type
439 type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440
Bob Moore4b8ed632008-06-10 13:55:53 +0800441void *acpi_ut_allocate_object_desc_dbg(const char *module_name,
Len Brown4be44fc2005-08-05 00:44:28 -0400442 u32 line_number, u32 component_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443
Robert Mooref9f46012005-07-08 00:00:00 -0400444#define acpi_ut_create_internal_object(t) acpi_ut_create_internal_object_dbg (_acpi_module_name,__LINE__,_COMPONENT,t)
445#define acpi_ut_allocate_object_desc() acpi_ut_allocate_object_desc_dbg (_acpi_module_name,__LINE__,_COMPONENT)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446
Len Brown4be44fc2005-08-05 00:44:28 -0400447void acpi_ut_delete_object_desc(union acpi_operand_object *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448
Len Brown4be44fc2005-08-05 00:44:28 -0400449u8 acpi_ut_valid_internal_object(void *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450
Bob Moore6287ee32007-04-03 19:59:37 -0400451union acpi_operand_object *acpi_ut_create_package_object(u32 count);
452
Bob Moore502f7ef2009-11-12 09:49:50 +0800453union acpi_operand_object *acpi_ut_create_integer_object(u64 value);
454
Len Brown4be44fc2005-08-05 00:44:28 -0400455union acpi_operand_object *acpi_ut_create_buffer_object(acpi_size buffer_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456
Len Brown4be44fc2005-08-05 00:44:28 -0400457union acpi_operand_object *acpi_ut_create_string_object(acpi_size string_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400460acpi_ut_get_object_size(union acpi_operand_object *obj, acpi_size * obj_length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461
462/*
Lin Mingb0ed7a92010-08-06 09:35:51 +0800463 * utosi - Support for the _OSI predefined control method
464 */
465acpi_status acpi_ut_initialize_interfaces(void);
466
Jung-uk Kim388a9902013-04-12 00:24:34 +0000467acpi_status acpi_ut_interface_terminate(void);
Lin Mingb0ed7a92010-08-06 09:35:51 +0800468
469acpi_status acpi_ut_install_interface(acpi_string interface_name);
470
471acpi_status acpi_ut_remove_interface(acpi_string interface_name);
472
Lv Zheng2cf9f5b2013-07-22 16:08:16 +0800473acpi_status acpi_ut_update_interfaces(u8 action);
474
Lin Mingb0ed7a92010-08-06 09:35:51 +0800475struct acpi_interface_info *acpi_ut_get_interface(acpi_string interface_name);
476
477acpi_status acpi_ut_osi_implementation(struct acpi_walk_state *walk_state);
478
479/*
Bob Moorec34c82b2013-04-12 00:24:22 +0000480 * utpredef - support for predefined names
481 */
482const union acpi_predefined_info *acpi_ut_get_next_predefined_method(const union
483 acpi_predefined_info
484 *this_name);
485
486const union acpi_predefined_info *acpi_ut_match_predefined_method(char *name);
487
488const union acpi_predefined_info *acpi_ut_match_resource_name(char *name);
489
490void
491acpi_ut_display_predefined_method(char *buffer,
492 const union acpi_predefined_info *this_name,
493 u8 multi_line);
494
495void acpi_ut_get_expected_return_types(char *buffer, u32 expected_btypes);
496
497u32 acpi_ut_get_resource_bit_width(char *buffer, u16 types);
498
499/*
Robert Moore44f6c012005-04-18 22:49:35 -0400500 * utstate - Generic state creation/cache routines
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502void
Len Brown4be44fc2005-08-05 00:44:28 -0400503acpi_ut_push_generic_state(union acpi_generic_state **list_head,
504 union acpi_generic_state *state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505
Len Brown4be44fc2005-08-05 00:44:28 -0400506union acpi_generic_state *acpi_ut_pop_generic_state(union acpi_generic_state
507 **list_head);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508
Len Brown4be44fc2005-08-05 00:44:28 -0400509union acpi_generic_state *acpi_ut_create_generic_state(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510
Len Brown4be44fc2005-08-05 00:44:28 -0400511struct acpi_thread_state *acpi_ut_create_thread_state(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512
Len Brown4be44fc2005-08-05 00:44:28 -0400513union acpi_generic_state *acpi_ut_create_update_state(union acpi_operand_object
514 *object, u16 action);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515
Len Brown4be44fc2005-08-05 00:44:28 -0400516union acpi_generic_state *acpi_ut_create_pkg_state(void *internal_object,
517 void *external_object,
518 u16 index);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519
520acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400521acpi_ut_create_update_state_and_push(union acpi_operand_object *object,
522 u16 action,
523 union acpi_generic_state **state_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524
Robert Moore44f6c012005-04-18 22:49:35 -0400525#ifdef ACPI_FUTURE_USAGE
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400527acpi_ut_create_pkg_state_and_push(void *internal_object,
528 void *external_object,
529 u16 index,
530 union acpi_generic_state **state_list);
531#endif /* ACPI_FUTURE_USAGE */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532
Len Brown4be44fc2005-08-05 00:44:28 -0400533union acpi_generic_state *acpi_ut_create_control_state(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534
Len Brown4be44fc2005-08-05 00:44:28 -0400535void acpi_ut_delete_generic_state(union acpi_generic_state *state);
Robert Moore44f6c012005-04-18 22:49:35 -0400536
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537/*
Robert Moore44f6c012005-04-18 22:49:35 -0400538 * utmath
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540acpi_status
Bob Moore5df7e6c2010-01-21 10:06:32 +0800541acpi_ut_divide(u64 in_dividend,
542 u64 in_divisor, u64 *out_quotient, u64 *out_remainder);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543
544acpi_status
Bob Moore5df7e6c2010-01-21 10:06:32 +0800545acpi_ut_short_divide(u64 in_dividend,
546 u32 divisor, u64 *out_quotient, u32 *out_remainder);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547
Robert Moore44f6c012005-04-18 22:49:35 -0400548/*
549 * utmisc
550 */
Bob Mooreae1b4762013-03-08 09:22:39 +0000551const struct acpi_exception_info *acpi_ut_validate_exception(acpi_status
552 status);
Bob Moore84fb2c92007-02-02 19:48:19 +0300553
Bob Moore15b8dd52009-06-29 13:39:29 +0800554u8 acpi_ut_is_pci_root_bridge(char *id);
555
Bob Moore793c2382006-03-31 00:00:00 -0500556u8 acpi_ut_is_aml_table(struct acpi_table_header *table);
557
Robert Mooref9f46012005-07-08 00:00:00 -0400558acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400559acpi_ut_walk_package_tree(union acpi_operand_object *source_object,
560 void *target_object,
561 acpi_pkg_callback walk_callback, void *context);
Robert Moore44f6c012005-04-18 22:49:35 -0400562
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563/* Values for Base above (16=Hex, 10=Decimal) */
564
565#define ACPI_ANY_BASE 0
566
Bob Moore616861242006-03-17 16:44:00 -0500567u32 acpi_ut_dword_byte_swap(u32 value);
568
569void acpi_ut_set_integer_width(u8 revision);
570
571#ifdef ACPI_DEBUG_OUTPUT
572void
573acpi_ut_display_init_pathname(u8 type,
574 struct acpi_namespace_node *obj_handle,
575 char *path);
576#endif
577
578/*
Bob Moore42f8fb72013-01-11 13:08:51 +0100579 * utownerid - Support for Table/Method Owner IDs
580 */
581acpi_status acpi_ut_allocate_owner_id(acpi_owner_id * owner_id);
582
583void acpi_ut_release_owner_id(acpi_owner_id * owner_id);
584
585/*
Bob Moore616861242006-03-17 16:44:00 -0500586 * utresrc
587 */
588acpi_status
Bob Moore886308e2012-12-19 05:38:07 +0000589acpi_ut_walk_aml_resources(struct acpi_walk_state *walk_state,
590 u8 *aml,
Bob Moore616861242006-03-17 16:44:00 -0500591 acpi_size aml_length,
Len Brownfd350942007-05-09 23:34:35 -0400592 acpi_walk_aml_callback user_function,
593 void **context);
Bob Moore616861242006-03-17 16:44:00 -0500594
Bob Moore886308e2012-12-19 05:38:07 +0000595acpi_status
596acpi_ut_validate_resource(struct acpi_walk_state *walk_state,
597 void *aml, u8 *return_index);
Bob Moore96db2552005-11-02 00:00:00 -0500598
Bob Moore08978312005-10-21 00:00:00 -0400599u32 acpi_ut_get_descriptor_length(void *aml);
600
601u16 acpi_ut_get_resource_length(void *aml);
602
Bob Moore96db2552005-11-02 00:00:00 -0500603u8 acpi_ut_get_resource_header_length(void *aml);
604
Bob Moore08978312005-10-21 00:00:00 -0400605u8 acpi_ut_get_resource_type(void *aml);
606
Bob Moore96db2552005-11-02 00:00:00 -0500607acpi_status
Lv Zheng6d33b6b2012-10-31 02:25:05 +0000608acpi_ut_get_resource_end_tag(union acpi_operand_object *obj_desc, u8 **end_tag);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610/*
Bob Moore42f8fb72013-01-11 13:08:51 +0100611 * utstring - String and character utilities
612 */
613void acpi_ut_strupr(char *src_string);
614
615void acpi_ut_strlwr(char *src_string);
616
617int acpi_ut_stricmp(char *string1, char *string2);
618
619acpi_status acpi_ut_strtoul64(char *string, u32 base, u64 *ret_integer);
620
Bob Moore0fb3adf2013-07-17 09:48:40 +0800621void acpi_ut_print_string(char *string, u16 max_length);
Bob Moore42f8fb72013-01-11 13:08:51 +0100622
623void ut_convert_backslashes(char *pathname);
624
Bob Moorede8e7db2013-06-08 00:59:44 +0000625u8 acpi_ut_valid_acpi_name(char *name);
Bob Moore42f8fb72013-01-11 13:08:51 +0100626
627u8 acpi_ut_valid_acpi_char(char character, u32 position);
628
629void acpi_ut_repair_name(char *name);
630
Bob Moore73424472013-10-29 09:29:21 +0800631#if defined (ACPI_DEBUGGER) || defined (ACPI_APPLICATION)
632u8 acpi_ut_safe_strcpy(char *dest, acpi_size dest_size, char *source);
633
634u8 acpi_ut_safe_strcat(char *dest, acpi_size dest_size, char *source);
635
636u8
637acpi_ut_safe_strncat(char *dest,
638 acpi_size dest_size,
639 char *source, acpi_size max_transfer_length);
640#endif
641
Bob Moore42f8fb72013-01-11 13:08:51 +0100642/*
Robert Moore73459f72005-06-24 00:00:00 -0400643 * utmutex - mutex support
644 */
Len Brown4be44fc2005-08-05 00:44:28 -0400645acpi_status acpi_ut_mutex_initialize(void);
Robert Moore73459f72005-06-24 00:00:00 -0400646
Len Brown4be44fc2005-08-05 00:44:28 -0400647void acpi_ut_mutex_terminate(void);
Robert Moore73459f72005-06-24 00:00:00 -0400648
Len Brown4be44fc2005-08-05 00:44:28 -0400649acpi_status acpi_ut_acquire_mutex(acpi_mutex_handle mutex_id);
Robert Moore73459f72005-06-24 00:00:00 -0400650
Len Brown4be44fc2005-08-05 00:44:28 -0400651acpi_status acpi_ut_release_mutex(acpi_mutex_handle mutex_id);
Robert Moore73459f72005-06-24 00:00:00 -0400652
653/*
Robert Moore44f6c012005-04-18 22:49:35 -0400654 * utalloc - memory allocation and object caching
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 */
Len Brown4be44fc2005-08-05 00:44:28 -0400656acpi_status acpi_ut_create_caches(void);
657
658acpi_status acpi_ut_delete_caches(void);
659
660acpi_status acpi_ut_validate_buffer(struct acpi_buffer *buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661
Robert Moore73459f72005-06-24 00:00:00 -0400662acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400663acpi_ut_initialize_buffer(struct acpi_buffer *buffer,
664 acpi_size required_length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666#ifdef ACPI_DBG_TRACK_ALLOCATIONS
Len Brown4be44fc2005-08-05 00:44:28 -0400667void *acpi_ut_allocate_and_track(acpi_size size,
Bob Moore4b8ed632008-06-10 13:55:53 +0800668 u32 component, const char *module, u32 line);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669
Bob Moore616861242006-03-17 16:44:00 -0500670void *acpi_ut_allocate_zeroed_and_track(acpi_size size,
Bob Moore4b8ed632008-06-10 13:55:53 +0800671 u32 component,
672 const char *module, u32 line);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673
674void
Bob Moore4b8ed632008-06-10 13:55:53 +0800675acpi_ut_free_and_track(void *address,
676 u32 component, const char *module, u32 line);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677
Robert Moore44f6c012005-04-18 22:49:35 -0400678#ifdef ACPI_FUTURE_USAGE
Len Brown4be44fc2005-08-05 00:44:28 -0400679void acpi_ut_dump_allocation_info(void);
680#endif /* ACPI_FUTURE_USAGE */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681
Bob Moore4b8ed632008-06-10 13:55:53 +0800682void acpi_ut_dump_allocations(u32 component, const char *module);
Bob Moore616861242006-03-17 16:44:00 -0500683
684acpi_status
685acpi_ut_create_list(char *list_name,
686 u16 object_size, struct acpi_memory_list **return_cache);
687
Bob Moorecc84e262010-09-15 14:09:14 +0800688#endif /* ACPI_DBG_TRACK_ALLOCATIONS */
689
690/*
Lin Mingf654c0f2012-01-12 13:10:32 +0800691 * utaddress - address range check
692 */
693acpi_status
694acpi_ut_add_address_range(acpi_adr_space_type space_id,
695 acpi_physical_address address,
696 u32 length, struct acpi_namespace_node *region_node);
697
698void
699acpi_ut_remove_address_range(acpi_adr_space_type space_id,
700 struct acpi_namespace_node *region_node);
701
702u32
703acpi_ut_check_address_range(acpi_adr_space_type space_id,
704 acpi_physical_address address, u32 length, u8 warn);
705
706void acpi_ut_delete_address_lists(void);
707
708/*
Bob Moorecc84e262010-09-15 14:09:14 +0800709 * utxferror - various error/warning output functions
710 */
711void ACPI_INTERNAL_VAR_XFACE
712acpi_ut_predefined_warning(const char *module_name,
713 u32 line_number,
714 char *pathname,
715 u8 node_flags, const char *format, ...);
716
717void ACPI_INTERNAL_VAR_XFACE
718acpi_ut_predefined_info(const char *module_name,
719 u32 line_number,
720 char *pathname, u8 node_flags, const char *format, ...);
721
Bob Mooree1405ca2013-05-30 09:59:21 +0800722void ACPI_INTERNAL_VAR_XFACE
723acpi_ut_predefined_bios_error(const char *module_name,
724 u32 line_number,
725 char *pathname,
726 u8 node_flags, const char *format, ...);
727
Bob Moorecc84e262010-09-15 14:09:14 +0800728void
729acpi_ut_namespace_error(const char *module_name,
730 u32 line_number,
731 const char *internal_name, acpi_status lookup_status);
732
733void
734acpi_ut_method_error(const char *module_name,
735 u32 line_number,
736 const char *message,
737 struct acpi_namespace_node *node,
738 const char *path, acpi_status lookup_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739
Len Brown4be44fc2005-08-05 00:44:28 -0400740#endif /* _ACUTILS_H */