blob: 1e256c5bda20675e73c1dbccd736cfc56606aebc [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
Bob Moore06a63e32014-04-04 12:37:44 +0800179const char *acpi_ut_get_notify_name(u32 notify_value, acpi_object_type type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180#endif
181
Len Brown4be44fc2005-08-05 00:44:28 -0400182char *acpi_ut_get_type_name(acpi_object_type type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183
Len Brown4be44fc2005-08-05 00:44:28 -0400184char *acpi_ut_get_node_name(void *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185
Len Brown4be44fc2005-08-05 00:44:28 -0400186char *acpi_ut_get_descriptor_name(void *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187
Bob Mooref02a99a2008-08-04 10:40:09 +0800188const char *acpi_ut_get_reference_name(union acpi_operand_object *object);
189
Len Brown4be44fc2005-08-05 00:44:28 -0400190char *acpi_ut_get_object_type_name(union acpi_operand_object *obj_desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191
Len Brown4be44fc2005-08-05 00:44:28 -0400192char *acpi_ut_get_region_name(u8 space_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193
Len Brown4be44fc2005-08-05 00:44:28 -0400194char *acpi_ut_get_event_name(u32 event_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195
Bob Moore5df7e6c2010-01-21 10:06:32 +0800196char acpi_ut_hex_to_ascii_char(u64 integer, u32 position);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197
Len Brown4be44fc2005-08-05 00:44:28 -0400198u8 acpi_ut_valid_object_type(acpi_object_type type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199
200/*
Robert Moore44f6c012005-04-18 22:49:35 -0400201 * utinit - miscellaneous initialization and shutdown
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202 */
Len Brown4be44fc2005-08-05 00:44:28 -0400203acpi_status acpi_ut_hardware_initialize(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204
Len Brown4be44fc2005-08-05 00:44:28 -0400205void acpi_ut_subsystem_shutdown(void);
Robert Moore44f6c012005-04-18 22:49:35 -0400206
Robert Moore44f6c012005-04-18 22:49:35 -0400207/*
208 * utclib - Local implementations of C library functions
209 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210#ifndef ACPI_USE_SYSTEM_CLIBRARY
211
Len Brown4be44fc2005-08-05 00:44:28 -0400212acpi_size acpi_ut_strlen(const char *string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213
Len Brown4be44fc2005-08-05 00:44:28 -0400214char *acpi_ut_strcpy(char *dst_string, const char *src_string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215
Len Brown4be44fc2005-08-05 00:44:28 -0400216char *acpi_ut_strncpy(char *dst_string,
217 const char *src_string, acpi_size count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218
Len Brown4be44fc2005-08-05 00:44:28 -0400219int acpi_ut_memcmp(const char *buffer1, const char *buffer2, acpi_size count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220
Len Brown4be44fc2005-08-05 00:44:28 -0400221int acpi_ut_strncmp(const char *string1, const char *string2, acpi_size count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222
Len Brown4be44fc2005-08-05 00:44:28 -0400223int acpi_ut_strcmp(const char *string1, const char *string2);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224
Len Brown4be44fc2005-08-05 00:44:28 -0400225char *acpi_ut_strcat(char *dst_string, const char *src_string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226
Len Brown4be44fc2005-08-05 00:44:28 -0400227char *acpi_ut_strncat(char *dst_string,
228 const char *src_string, acpi_size count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229
Len Brown4be44fc2005-08-05 00:44:28 -0400230u32 acpi_ut_strtoul(const char *string, char **terminator, u32 base);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231
Len Brown4be44fc2005-08-05 00:44:28 -0400232char *acpi_ut_strstr(char *string1, char *string2);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233
Len Brown4be44fc2005-08-05 00:44:28 -0400234void *acpi_ut_memcpy(void *dest, const void *src, acpi_size count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235
Bob Moore67a119f2008-06-10 13:42:13 +0800236void *acpi_ut_memset(void *dest, u8 value, acpi_size count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237
Len Brown4be44fc2005-08-05 00:44:28 -0400238int acpi_ut_to_upper(int c);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239
Len Brown4be44fc2005-08-05 00:44:28 -0400240int acpi_ut_to_lower(int c);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241
242extern const u8 _acpi_ctype[];
243
Len Brown4be44fc2005-08-05 00:44:28 -0400244#define _ACPI_XA 0x00 /* extra alphabetic - not supported */
245#define _ACPI_XS 0x40 /* extra space */
246#define _ACPI_BB 0x00 /* BEL, BS, etc. - not supported */
247#define _ACPI_CN 0x20 /* CR, FF, HT, NL, VT */
248#define _ACPI_DI 0x04 /* '0'-'9' */
249#define _ACPI_LO 0x02 /* 'a'-'z' */
250#define _ACPI_PU 0x10 /* punctuation */
251#define _ACPI_SP 0x08 /* space */
252#define _ACPI_UP 0x01 /* 'A'-'Z' */
253#define _ACPI_XD 0x80 /* '0'-'9', 'A'-'F', 'a'-'f' */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254
255#define ACPI_IS_DIGIT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_DI))
256#define ACPI_IS_SPACE(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_SP))
257#define ACPI_IS_XDIGIT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_XD))
258#define ACPI_IS_UPPER(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_UP))
259#define ACPI_IS_LOWER(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO))
260#define ACPI_IS_PRINT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP | _ACPI_DI | _ACPI_SP | _ACPI_PU))
261#define ACPI_IS_ALPHA(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262
Lv Zheng6d33b6b2012-10-31 02:25:05 +0000263#endif /* !ACPI_USE_SYSTEM_CLIBRARY */
264
265#define ACPI_IS_ASCII(c) ((c) < 0x80)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266
Robert Moore44f6c012005-04-18 22:49:35 -0400267/*
268 * utcopy - Object construction and conversion interfaces
269 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400271acpi_ut_build_simple_object(union acpi_operand_object *obj,
272 union acpi_object *user_obj,
Lv Zheng6d33b6b2012-10-31 02:25:05 +0000273 u8 *data_space, u32 *buffer_space_used);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274
275acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400276acpi_ut_build_package_object(union acpi_operand_object *obj,
Lv Zheng6d33b6b2012-10-31 02:25:05 +0000277 u8 *buffer, u32 *space_used);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278
279acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400280acpi_ut_copy_iobject_to_eobject(union acpi_operand_object *obj,
281 struct acpi_buffer *ret_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282
283acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400284acpi_ut_copy_eobject_to_iobject(union acpi_object *obj,
285 union acpi_operand_object **internal_obj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286
287acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400288acpi_ut_copy_isimple_to_isimple(union acpi_operand_object *source_obj,
289 union acpi_operand_object *dest_obj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290
291acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400292acpi_ut_copy_iobject_to_iobject(union acpi_operand_object *source_desc,
293 union acpi_operand_object **dest_desc,
294 struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295
296/*
Robert Moore44f6c012005-04-18 22:49:35 -0400297 * utcreate - Object creation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400300acpi_ut_update_object_reference(union acpi_operand_object *object, u16 action);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301
302/*
Robert Moore44f6c012005-04-18 22:49:35 -0400303 * utdebug - Debug interfaces
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304 */
Len Brown4be44fc2005-08-05 00:44:28 -0400305void acpi_ut_init_stack_ptr_trace(void);
306
307void acpi_ut_track_stack_ptr(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308
309void
Len Brown4be44fc2005-08-05 00:44:28 -0400310acpi_ut_trace(u32 line_number,
Bob Moore4b8ed632008-06-10 13:55:53 +0800311 const char *function_name,
312 const char *module_name, u32 component_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313
314void
Len Brown4be44fc2005-08-05 00:44:28 -0400315acpi_ut_trace_ptr(u32 line_number,
316 const char *function_name,
Bob Moore4b8ed632008-06-10 13:55:53 +0800317 const char *module_name, u32 component_id, void *pointer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318
319void
Len Brown4be44fc2005-08-05 00:44:28 -0400320acpi_ut_trace_u32(u32 line_number,
321 const char *function_name,
Bob Moore4b8ed632008-06-10 13:55:53 +0800322 const char *module_name, u32 component_id, u32 integer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323
324void
Len Brown4be44fc2005-08-05 00:44:28 -0400325acpi_ut_trace_str(u32 line_number,
326 const char *function_name,
Bob Moore4b8ed632008-06-10 13:55:53 +0800327 const char *module_name, u32 component_id, char *string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328
329void
Len Brown4be44fc2005-08-05 00:44:28 -0400330acpi_ut_exit(u32 line_number,
Bob Moore4b8ed632008-06-10 13:55:53 +0800331 const char *function_name,
332 const char *module_name, u32 component_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333
334void
Len Brown4be44fc2005-08-05 00:44:28 -0400335acpi_ut_status_exit(u32 line_number,
336 const char *function_name,
Bob Moore4b8ed632008-06-10 13:55:53 +0800337 const char *module_name,
338 u32 component_id, acpi_status status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339
340void
Len Brown4be44fc2005-08-05 00:44:28 -0400341acpi_ut_value_exit(u32 line_number,
342 const char *function_name,
Bob Moore5df7e6c2010-01-21 10:06:32 +0800343 const char *module_name, u32 component_id, u64 value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344
345void
Len Brown4be44fc2005-08-05 00:44:28 -0400346acpi_ut_ptr_exit(u32 line_number,
347 const char *function_name,
Bob Moore4b8ed632008-06-10 13:55:53 +0800348 const char *module_name, u32 component_id, u8 *ptr);
Len Brown4be44fc2005-08-05 00:44:28 -0400349
Bob Moore97171c62012-10-31 02:28:11 +0000350void
351acpi_ut_debug_dump_buffer(u8 *buffer, u32 count, u32 display, u32 component_id);
Bob Mooreb8e4d892006-01-27 16:43:00 -0500352
Bob Moore97171c62012-10-31 02:28:11 +0000353void acpi_ut_dump_buffer(u8 *buffer, u32 count, u32 display, u32 offset);
Bob Moore793c2382006-03-31 00:00:00 -0500354
Bob Moore4a90c7e2006-01-13 16:22:00 -0500355void acpi_ut_report_error(char *module_name, u32 line_number);
Len Brown4be44fc2005-08-05 00:44:28 -0400356
Bob Moore4a90c7e2006-01-13 16:22:00 -0500357void acpi_ut_report_info(char *module_name, u32 line_number);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358
Bob Moore4a90c7e2006-01-13 16:22:00 -0500359void acpi_ut_report_warning(char *module_name, u32 line_number);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361/*
Robert Moore44f6c012005-04-18 22:49:35 -0400362 * utdelete - Object deletion and reference counts
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363 */
Len Brown4be44fc2005-08-05 00:44:28 -0400364void acpi_ut_add_reference(union acpi_operand_object *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365
Len Brown4be44fc2005-08-05 00:44:28 -0400366void acpi_ut_remove_reference(union acpi_operand_object *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367
Len Brown4be44fc2005-08-05 00:44:28 -0400368void acpi_ut_delete_internal_package_object(union acpi_operand_object *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369
Len Brown4be44fc2005-08-05 00:44:28 -0400370void acpi_ut_delete_internal_simple_object(union acpi_operand_object *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371
Len Brown4be44fc2005-08-05 00:44:28 -0400372void acpi_ut_delete_internal_object_list(union acpi_operand_object **obj_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373
374/*
Robert Moore44f6c012005-04-18 22:49:35 -0400375 * uteval - object evaluation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400378acpi_ut_evaluate_object(struct acpi_namespace_node *prefix_node,
379 char *path,
380 u32 expected_return_btypes,
381 union acpi_operand_object **return_desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382
383acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400384acpi_ut_evaluate_numeric_object(char *object_name,
385 struct acpi_namespace_node *device_node,
Bob Moore5df7e6c2010-01-21 10:06:32 +0800386 u64 *value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387
388acpi_status
Bob Moore15b8dd52009-06-29 13:39:29 +0800389acpi_ut_execute_STA(struct acpi_namespace_node *device_node, u32 *status_flags);
390
391acpi_status
392acpi_ut_execute_power_methods(struct acpi_namespace_node *device_node,
393 const char **method_names,
394 u8 method_count, u8 *out_values);
395
396/*
397 * utids - device ID support
398 */
399acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400400acpi_ut_execute_HID(struct acpi_namespace_node *device_node,
Lv Zheng78e25fe2012-10-31 02:25:24 +0000401 struct acpi_pnp_device_id ** return_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402
403acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400404acpi_ut_execute_UID(struct acpi_namespace_node *device_node,
Lv Zheng78e25fe2012-10-31 02:25:24 +0000405 struct acpi_pnp_device_id ** return_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406
407acpi_status
Bob Moore413fc3f2012-10-31 02:28:38 +0000408acpi_ut_execute_SUB(struct acpi_namespace_node *device_node,
409 struct acpi_pnp_device_id **return_id);
410
411acpi_status
Bob Moore15b8dd52009-06-29 13:39:29 +0800412acpi_ut_execute_CID(struct acpi_namespace_node *device_node,
Lv Zheng78e25fe2012-10-31 02:25:24 +0000413 struct acpi_pnp_device_id_list ** return_cid_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414
415/*
Bob Moore8a335a232009-03-09 16:31:04 +0800416 * utlock - reader/writer locks
417 */
418acpi_status acpi_ut_create_rw_lock(struct acpi_rw_lock *lock);
419
420void acpi_ut_delete_rw_lock(struct acpi_rw_lock *lock);
421
422acpi_status acpi_ut_acquire_read_lock(struct acpi_rw_lock *lock);
423
424acpi_status acpi_ut_release_read_lock(struct acpi_rw_lock *lock);
425
426acpi_status acpi_ut_acquire_write_lock(struct acpi_rw_lock *lock);
427
428void acpi_ut_release_write_lock(struct acpi_rw_lock *lock);
429
430/*
Robert Moore44f6c012005-04-18 22:49:35 -0400431 * utobject - internal object create/delete/cache routines
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432 */
Bob Moore4b8ed632008-06-10 13:55:53 +0800433union acpi_operand_object *acpi_ut_create_internal_object_dbg(const char
434 *module_name,
Len Brown4be44fc2005-08-05 00:44:28 -0400435 u32 line_number,
436 u32 component_id,
437 acpi_object_type
438 type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439
Bob Moore4b8ed632008-06-10 13:55:53 +0800440void *acpi_ut_allocate_object_desc_dbg(const char *module_name,
Len Brown4be44fc2005-08-05 00:44:28 -0400441 u32 line_number, u32 component_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442
Robert Mooref9f46012005-07-08 00:00:00 -0400443#define acpi_ut_create_internal_object(t) acpi_ut_create_internal_object_dbg (_acpi_module_name,__LINE__,_COMPONENT,t)
444#define acpi_ut_allocate_object_desc() acpi_ut_allocate_object_desc_dbg (_acpi_module_name,__LINE__,_COMPONENT)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445
Len Brown4be44fc2005-08-05 00:44:28 -0400446void acpi_ut_delete_object_desc(union acpi_operand_object *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447
Len Brown4be44fc2005-08-05 00:44:28 -0400448u8 acpi_ut_valid_internal_object(void *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449
Bob Moore6287ee32007-04-03 19:59:37 -0400450union acpi_operand_object *acpi_ut_create_package_object(u32 count);
451
Bob Moore502f7ef2009-11-12 09:49:50 +0800452union acpi_operand_object *acpi_ut_create_integer_object(u64 value);
453
Len Brown4be44fc2005-08-05 00:44:28 -0400454union acpi_operand_object *acpi_ut_create_buffer_object(acpi_size buffer_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455
Len Brown4be44fc2005-08-05 00:44:28 -0400456union acpi_operand_object *acpi_ut_create_string_object(acpi_size string_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400459acpi_ut_get_object_size(union acpi_operand_object *obj, acpi_size * obj_length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460
461/*
Lin Mingb0ed7a92010-08-06 09:35:51 +0800462 * utosi - Support for the _OSI predefined control method
463 */
464acpi_status acpi_ut_initialize_interfaces(void);
465
Jung-uk Kim388a9902013-04-12 00:24:34 +0000466acpi_status acpi_ut_interface_terminate(void);
Lin Mingb0ed7a92010-08-06 09:35:51 +0800467
468acpi_status acpi_ut_install_interface(acpi_string interface_name);
469
470acpi_status acpi_ut_remove_interface(acpi_string interface_name);
471
Lv Zheng2cf9f5b2013-07-22 16:08:16 +0800472acpi_status acpi_ut_update_interfaces(u8 action);
473
Lin Mingb0ed7a92010-08-06 09:35:51 +0800474struct acpi_interface_info *acpi_ut_get_interface(acpi_string interface_name);
475
476acpi_status acpi_ut_osi_implementation(struct acpi_walk_state *walk_state);
477
478/*
Bob Moorec34c82b2013-04-12 00:24:22 +0000479 * utpredef - support for predefined names
480 */
481const union acpi_predefined_info *acpi_ut_get_next_predefined_method(const union
482 acpi_predefined_info
483 *this_name);
484
485const union acpi_predefined_info *acpi_ut_match_predefined_method(char *name);
486
487const union acpi_predefined_info *acpi_ut_match_resource_name(char *name);
488
489void
490acpi_ut_display_predefined_method(char *buffer,
491 const union acpi_predefined_info *this_name,
492 u8 multi_line);
493
494void acpi_ut_get_expected_return_types(char *buffer, u32 expected_btypes);
495
496u32 acpi_ut_get_resource_bit_width(char *buffer, u16 types);
497
498/*
Robert Moore44f6c012005-04-18 22:49:35 -0400499 * utstate - Generic state creation/cache routines
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501void
Len Brown4be44fc2005-08-05 00:44:28 -0400502acpi_ut_push_generic_state(union acpi_generic_state **list_head,
503 union acpi_generic_state *state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504
Len Brown4be44fc2005-08-05 00:44:28 -0400505union acpi_generic_state *acpi_ut_pop_generic_state(union acpi_generic_state
506 **list_head);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507
Len Brown4be44fc2005-08-05 00:44:28 -0400508union acpi_generic_state *acpi_ut_create_generic_state(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509
Len Brown4be44fc2005-08-05 00:44:28 -0400510struct acpi_thread_state *acpi_ut_create_thread_state(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511
Len Brown4be44fc2005-08-05 00:44:28 -0400512union acpi_generic_state *acpi_ut_create_update_state(union acpi_operand_object
513 *object, u16 action);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514
Len Brown4be44fc2005-08-05 00:44:28 -0400515union acpi_generic_state *acpi_ut_create_pkg_state(void *internal_object,
516 void *external_object,
517 u16 index);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518
519acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400520acpi_ut_create_update_state_and_push(union acpi_operand_object *object,
521 u16 action,
522 union acpi_generic_state **state_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523
Robert Moore44f6c012005-04-18 22:49:35 -0400524#ifdef ACPI_FUTURE_USAGE
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400526acpi_ut_create_pkg_state_and_push(void *internal_object,
527 void *external_object,
528 u16 index,
529 union acpi_generic_state **state_list);
530#endif /* ACPI_FUTURE_USAGE */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531
Len Brown4be44fc2005-08-05 00:44:28 -0400532union acpi_generic_state *acpi_ut_create_control_state(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533
Len Brown4be44fc2005-08-05 00:44:28 -0400534void acpi_ut_delete_generic_state(union acpi_generic_state *state);
Robert Moore44f6c012005-04-18 22:49:35 -0400535
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536/*
Robert Moore44f6c012005-04-18 22:49:35 -0400537 * utmath
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539acpi_status
Bob Moore5df7e6c2010-01-21 10:06:32 +0800540acpi_ut_divide(u64 in_dividend,
541 u64 in_divisor, u64 *out_quotient, u64 *out_remainder);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542
543acpi_status
Bob Moore5df7e6c2010-01-21 10:06:32 +0800544acpi_ut_short_divide(u64 in_dividend,
545 u32 divisor, u64 *out_quotient, u32 *out_remainder);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546
Robert Moore44f6c012005-04-18 22:49:35 -0400547/*
548 * utmisc
549 */
Bob Mooreae1b4762013-03-08 09:22:39 +0000550const struct acpi_exception_info *acpi_ut_validate_exception(acpi_status
551 status);
Bob Moore84fb2c92007-02-02 19:48:19 +0300552
Bob Moore15b8dd52009-06-29 13:39:29 +0800553u8 acpi_ut_is_pci_root_bridge(char *id);
554
Bob Moore793c2382006-03-31 00:00:00 -0500555u8 acpi_ut_is_aml_table(struct acpi_table_header *table);
556
Robert Mooref9f46012005-07-08 00:00:00 -0400557acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400558acpi_ut_walk_package_tree(union acpi_operand_object *source_object,
559 void *target_object,
560 acpi_pkg_callback walk_callback, void *context);
Robert Moore44f6c012005-04-18 22:49:35 -0400561
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562/* Values for Base above (16=Hex, 10=Decimal) */
563
564#define ACPI_ANY_BASE 0
565
Bob Moore616861242006-03-17 16:44:00 -0500566u32 acpi_ut_dword_byte_swap(u32 value);
567
568void acpi_ut_set_integer_width(u8 revision);
569
570#ifdef ACPI_DEBUG_OUTPUT
571void
572acpi_ut_display_init_pathname(u8 type,
573 struct acpi_namespace_node *obj_handle,
574 char *path);
575#endif
576
577/*
Bob Moore42f8fb72013-01-11 13:08:51 +0100578 * utownerid - Support for Table/Method Owner IDs
579 */
580acpi_status acpi_ut_allocate_owner_id(acpi_owner_id * owner_id);
581
582void acpi_ut_release_owner_id(acpi_owner_id * owner_id);
583
584/*
Bob Moore616861242006-03-17 16:44:00 -0500585 * utresrc
586 */
587acpi_status
Bob Moore886308e2012-12-19 05:38:07 +0000588acpi_ut_walk_aml_resources(struct acpi_walk_state *walk_state,
589 u8 *aml,
Bob Moore616861242006-03-17 16:44:00 -0500590 acpi_size aml_length,
Len Brownfd350942007-05-09 23:34:35 -0400591 acpi_walk_aml_callback user_function,
592 void **context);
Bob Moore616861242006-03-17 16:44:00 -0500593
Bob Moore886308e2012-12-19 05:38:07 +0000594acpi_status
595acpi_ut_validate_resource(struct acpi_walk_state *walk_state,
596 void *aml, u8 *return_index);
Bob Moore96db2552005-11-02 00:00:00 -0500597
Bob Moore08978312005-10-21 00:00:00 -0400598u32 acpi_ut_get_descriptor_length(void *aml);
599
600u16 acpi_ut_get_resource_length(void *aml);
601
Bob Moore96db2552005-11-02 00:00:00 -0500602u8 acpi_ut_get_resource_header_length(void *aml);
603
Bob Moore08978312005-10-21 00:00:00 -0400604u8 acpi_ut_get_resource_type(void *aml);
605
Bob Moore96db2552005-11-02 00:00:00 -0500606acpi_status
Lv Zheng6d33b6b2012-10-31 02:25:05 +0000607acpi_ut_get_resource_end_tag(union acpi_operand_object *obj_desc, u8 **end_tag);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609/*
Bob Moore42f8fb72013-01-11 13:08:51 +0100610 * utstring - String and character utilities
611 */
612void acpi_ut_strupr(char *src_string);
613
614void acpi_ut_strlwr(char *src_string);
615
616int acpi_ut_stricmp(char *string1, char *string2);
617
618acpi_status acpi_ut_strtoul64(char *string, u32 base, u64 *ret_integer);
619
Bob Moore0fb3adf2013-07-17 09:48:40 +0800620void acpi_ut_print_string(char *string, u16 max_length);
Bob Moore42f8fb72013-01-11 13:08:51 +0100621
622void ut_convert_backslashes(char *pathname);
623
Bob Moorede8e7db2013-06-08 00:59:44 +0000624u8 acpi_ut_valid_acpi_name(char *name);
Bob Moore42f8fb72013-01-11 13:08:51 +0100625
626u8 acpi_ut_valid_acpi_char(char character, u32 position);
627
628void acpi_ut_repair_name(char *name);
629
Bob Moore73424472013-10-29 09:29:21 +0800630#if defined (ACPI_DEBUGGER) || defined (ACPI_APPLICATION)
631u8 acpi_ut_safe_strcpy(char *dest, acpi_size dest_size, char *source);
632
633u8 acpi_ut_safe_strcat(char *dest, acpi_size dest_size, char *source);
634
635u8
636acpi_ut_safe_strncat(char *dest,
637 acpi_size dest_size,
638 char *source, acpi_size max_transfer_length);
639#endif
640
Bob Moore42f8fb72013-01-11 13:08:51 +0100641/*
Robert Moore73459f72005-06-24 00:00:00 -0400642 * utmutex - mutex support
643 */
Len Brown4be44fc2005-08-05 00:44:28 -0400644acpi_status acpi_ut_mutex_initialize(void);
Robert Moore73459f72005-06-24 00:00:00 -0400645
Len Brown4be44fc2005-08-05 00:44:28 -0400646void acpi_ut_mutex_terminate(void);
Robert Moore73459f72005-06-24 00:00:00 -0400647
Len Brown4be44fc2005-08-05 00:44:28 -0400648acpi_status acpi_ut_acquire_mutex(acpi_mutex_handle mutex_id);
Robert Moore73459f72005-06-24 00:00:00 -0400649
Len Brown4be44fc2005-08-05 00:44:28 -0400650acpi_status acpi_ut_release_mutex(acpi_mutex_handle mutex_id);
Robert Moore73459f72005-06-24 00:00:00 -0400651
652/*
Robert Moore44f6c012005-04-18 22:49:35 -0400653 * utalloc - memory allocation and object caching
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654 */
Len Brown4be44fc2005-08-05 00:44:28 -0400655acpi_status acpi_ut_create_caches(void);
656
657acpi_status acpi_ut_delete_caches(void);
658
659acpi_status acpi_ut_validate_buffer(struct acpi_buffer *buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660
Robert Moore73459f72005-06-24 00:00:00 -0400661acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400662acpi_ut_initialize_buffer(struct acpi_buffer *buffer,
663 acpi_size required_length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665#ifdef ACPI_DBG_TRACK_ALLOCATIONS
Len Brown4be44fc2005-08-05 00:44:28 -0400666void *acpi_ut_allocate_and_track(acpi_size size,
Bob Moore4b8ed632008-06-10 13:55:53 +0800667 u32 component, const char *module, u32 line);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668
Bob Moore616861242006-03-17 16:44:00 -0500669void *acpi_ut_allocate_zeroed_and_track(acpi_size size,
Bob Moore4b8ed632008-06-10 13:55:53 +0800670 u32 component,
671 const char *module, u32 line);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672
673void
Bob Moore4b8ed632008-06-10 13:55:53 +0800674acpi_ut_free_and_track(void *address,
675 u32 component, const char *module, u32 line);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676
Robert Moore44f6c012005-04-18 22:49:35 -0400677#ifdef ACPI_FUTURE_USAGE
Len Brown4be44fc2005-08-05 00:44:28 -0400678void acpi_ut_dump_allocation_info(void);
679#endif /* ACPI_FUTURE_USAGE */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680
Bob Moore4b8ed632008-06-10 13:55:53 +0800681void acpi_ut_dump_allocations(u32 component, const char *module);
Bob Moore616861242006-03-17 16:44:00 -0500682
683acpi_status
684acpi_ut_create_list(char *list_name,
685 u16 object_size, struct acpi_memory_list **return_cache);
686
Bob Moorecc84e262010-09-15 14:09:14 +0800687#endif /* ACPI_DBG_TRACK_ALLOCATIONS */
688
689/*
Lin Mingf654c0f2012-01-12 13:10:32 +0800690 * utaddress - address range check
691 */
692acpi_status
693acpi_ut_add_address_range(acpi_adr_space_type space_id,
694 acpi_physical_address address,
695 u32 length, struct acpi_namespace_node *region_node);
696
697void
698acpi_ut_remove_address_range(acpi_adr_space_type space_id,
699 struct acpi_namespace_node *region_node);
700
701u32
702acpi_ut_check_address_range(acpi_adr_space_type space_id,
703 acpi_physical_address address, u32 length, u8 warn);
704
705void acpi_ut_delete_address_lists(void);
706
707/*
Bob Moorecc84e262010-09-15 14:09:14 +0800708 * utxferror - various error/warning output functions
709 */
710void ACPI_INTERNAL_VAR_XFACE
711acpi_ut_predefined_warning(const char *module_name,
712 u32 line_number,
713 char *pathname,
714 u8 node_flags, const char *format, ...);
715
716void ACPI_INTERNAL_VAR_XFACE
717acpi_ut_predefined_info(const char *module_name,
718 u32 line_number,
719 char *pathname, u8 node_flags, const char *format, ...);
720
Bob Mooree1405ca2013-05-30 09:59:21 +0800721void ACPI_INTERNAL_VAR_XFACE
722acpi_ut_predefined_bios_error(const char *module_name,
723 u32 line_number,
724 char *pathname,
725 u8 node_flags, const char *format, ...);
726
Bob Moorecc84e262010-09-15 14:09:14 +0800727void
728acpi_ut_namespace_error(const char *module_name,
729 u32 line_number,
730 const char *internal_name, acpi_status lookup_status);
731
732void
733acpi_ut_method_error(const char *module_name,
734 u32 line_number,
735 const char *message,
736 struct acpi_namespace_node *node,
737 const char *path, acpi_status lookup_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738
Bob Mooreb944b292014-04-04 12:37:35 +0800739/*
740 * Utility functions for ACPI names and IDs
741 */
742const struct ah_predefined_name *acpi_ah_match_predefined_name(char *nameseg);
743
Lv Zhenge2b90352014-04-04 12:39:50 +0800744const struct ah_device_id *acpi_ah_match_hardware_id(char *hid);
Bob Mooreb944b292014-04-04 12:37:35 +0800745
Len Brown4be44fc2005-08-05 00:44:28 -0400746#endif /* _ACUTILS_H */