blob: e0adbc1f52ede3f85cb5d2768f6fda517c711c35 [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>
Bob Mooreb6872ff2013-06-08 00:58:00 +000098
99#define ACPI_MSG_REDIRECT_BEGIN \
100 FILE *output_file = acpi_gbl_output_file; \
101 acpi_os_redirect_output (stderr);
102
103#define ACPI_MSG_REDIRECT_END \
104 acpi_os_redirect_output (output_file);
105
106#else
107/*
108 * non-iASL case - no redirection, nothing to do
109 */
110#define ACPI_MSG_REDIRECT_BEGIN
111#define ACPI_MSG_REDIRECT_END
112#endif
113
114/*
115 * Common error message prefixes
116 */
117#define ACPI_MSG_ERROR "ACPI Error: "
118#define ACPI_MSG_EXCEPTION "ACPI Exception: "
119#define ACPI_MSG_WARNING "ACPI Warning: "
120#define ACPI_MSG_INFO "ACPI: "
121
122#define ACPI_MSG_BIOS_ERROR "ACPI BIOS Error (bug): "
123#define ACPI_MSG_BIOS_WARNING "ACPI BIOS Warning (bug): "
124
125/*
126 * Common message suffix
127 */
128#define ACPI_MSG_SUFFIX \
129 acpi_os_printf (" (%8.8X/%s-%u)\n", ACPI_CA_VERSION, module_name, line_number)
130
Bob Moore96db2552005-11-02 00:00:00 -0500131/* Types for Resource descriptor entries */
132
133#define ACPI_INVALID_RESOURCE 0
134#define ACPI_FIXED_LENGTH 1
135#define ACPI_VARIABLE_LENGTH 2
136#define ACPI_SMALL_VARIABLE_LENGTH 3
137
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138typedef
Lv Zheng6d33b6b2012-10-31 02:25:05 +0000139acpi_status(*acpi_walk_aml_callback) (u8 *aml,
Bob Moore616861242006-03-17 16:44:00 -0500140 u32 length,
141 u32 offset,
Bob Mooreb229cf92006-04-21 17:15:00 -0400142 u8 resource_index, void **context);
Bob Moore616861242006-03-17 16:44:00 -0500143
144typedef
Len Brown4be44fc2005-08-05 00:44:28 -0400145acpi_status(*acpi_pkg_callback) (u8 object_type,
Lv Zheng6d33b6b2012-10-31 02:25:05 +0000146 union acpi_operand_object *source_object,
Len Brown4be44fc2005-08-05 00:44:28 -0400147 union acpi_generic_state * state,
148 void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149
Len Brown4be44fc2005-08-05 00:44:28 -0400150struct acpi_pkg_info {
151 u8 *free_space;
152 acpi_size length;
153 u32 object_space;
154 u32 num_packages;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155};
156
Bob Moore60f3deb2013-04-12 00:25:29 +0000157/* Object reference counts */
158
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159#define REF_INCREMENT (u16) 0
160#define REF_DECREMENT (u16) 1
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161
162/* acpi_ut_dump_buffer */
163
164#define DB_BYTE_DISPLAY 1
165#define DB_WORD_DISPLAY 2
166#define DB_DWORD_DISPLAY 4
167#define DB_QWORD_DISPLAY 8
168
Robert Moore44f6c012005-04-18 22:49:35 -0400169/*
170 * utglobal - Global data structures and procedures
171 */
Yi Yangb417d402008-08-04 10:30:09 +0800172acpi_status acpi_ut_init_globals(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174#if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
175
Len Brown4be44fc2005-08-05 00:44:28 -0400176char *acpi_ut_get_mutex_name(u32 mutex_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177
Bob Moore06a63e32014-04-04 12:37:44 +0800178const char *acpi_ut_get_notify_name(u32 notify_value, acpi_object_type type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179#endif
180
Len Brown4be44fc2005-08-05 00:44:28 -0400181char *acpi_ut_get_type_name(acpi_object_type type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182
Len Brown4be44fc2005-08-05 00:44:28 -0400183char *acpi_ut_get_node_name(void *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184
Len Brown4be44fc2005-08-05 00:44:28 -0400185char *acpi_ut_get_descriptor_name(void *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186
Bob Mooref02a99a2008-08-04 10:40:09 +0800187const char *acpi_ut_get_reference_name(union acpi_operand_object *object);
188
Len Brown4be44fc2005-08-05 00:44:28 -0400189char *acpi_ut_get_object_type_name(union acpi_operand_object *obj_desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190
Len Brown4be44fc2005-08-05 00:44:28 -0400191char *acpi_ut_get_region_name(u8 space_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192
Len Brown4be44fc2005-08-05 00:44:28 -0400193char *acpi_ut_get_event_name(u32 event_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194
Bob Moore5df7e6c2010-01-21 10:06:32 +0800195char acpi_ut_hex_to_ascii_char(u64 integer, u32 position);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196
Len Brown4be44fc2005-08-05 00:44:28 -0400197u8 acpi_ut_valid_object_type(acpi_object_type type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198
199/*
Robert Moore44f6c012005-04-18 22:49:35 -0400200 * utinit - miscellaneous initialization and shutdown
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 */
Len Brown4be44fc2005-08-05 00:44:28 -0400202acpi_status acpi_ut_hardware_initialize(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203
Len Brown4be44fc2005-08-05 00:44:28 -0400204void acpi_ut_subsystem_shutdown(void);
Robert Moore44f6c012005-04-18 22:49:35 -0400205
Robert Moore44f6c012005-04-18 22:49:35 -0400206/*
207 * utclib - Local implementations of C library functions
208 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209#ifndef ACPI_USE_SYSTEM_CLIBRARY
210
Len Brown4be44fc2005-08-05 00:44:28 -0400211acpi_size acpi_ut_strlen(const char *string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212
Len Brown4be44fc2005-08-05 00:44:28 -0400213char *acpi_ut_strcpy(char *dst_string, const char *src_string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214
Len Brown4be44fc2005-08-05 00:44:28 -0400215char *acpi_ut_strncpy(char *dst_string,
216 const char *src_string, acpi_size count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217
Len Brown4be44fc2005-08-05 00:44:28 -0400218int acpi_ut_memcmp(const char *buffer1, const char *buffer2, acpi_size count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219
Len Brown4be44fc2005-08-05 00:44:28 -0400220int acpi_ut_strncmp(const char *string1, const char *string2, acpi_size count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221
Len Brown4be44fc2005-08-05 00:44:28 -0400222int acpi_ut_strcmp(const char *string1, const char *string2);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223
Len Brown4be44fc2005-08-05 00:44:28 -0400224char *acpi_ut_strcat(char *dst_string, const char *src_string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225
Len Brown4be44fc2005-08-05 00:44:28 -0400226char *acpi_ut_strncat(char *dst_string,
227 const char *src_string, acpi_size count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228
Len Brown4be44fc2005-08-05 00:44:28 -0400229u32 acpi_ut_strtoul(const char *string, char **terminator, u32 base);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230
Len Brown4be44fc2005-08-05 00:44:28 -0400231char *acpi_ut_strstr(char *string1, char *string2);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232
Len Brown4be44fc2005-08-05 00:44:28 -0400233void *acpi_ut_memcpy(void *dest, const void *src, acpi_size count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234
Bob Moore67a119f2008-06-10 13:42:13 +0800235void *acpi_ut_memset(void *dest, u8 value, acpi_size count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236
Len Brown4be44fc2005-08-05 00:44:28 -0400237int acpi_ut_to_upper(int c);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238
Len Brown4be44fc2005-08-05 00:44:28 -0400239int acpi_ut_to_lower(int c);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240
241extern const u8 _acpi_ctype[];
242
Len Brown4be44fc2005-08-05 00:44:28 -0400243#define _ACPI_XA 0x00 /* extra alphabetic - not supported */
244#define _ACPI_XS 0x40 /* extra space */
245#define _ACPI_BB 0x00 /* BEL, BS, etc. - not supported */
246#define _ACPI_CN 0x20 /* CR, FF, HT, NL, VT */
247#define _ACPI_DI 0x04 /* '0'-'9' */
248#define _ACPI_LO 0x02 /* 'a'-'z' */
249#define _ACPI_PU 0x10 /* punctuation */
250#define _ACPI_SP 0x08 /* space */
251#define _ACPI_UP 0x01 /* 'A'-'Z' */
252#define _ACPI_XD 0x80 /* '0'-'9', 'A'-'F', 'a'-'f' */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253
254#define ACPI_IS_DIGIT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_DI))
255#define ACPI_IS_SPACE(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_SP))
256#define ACPI_IS_XDIGIT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_XD))
257#define ACPI_IS_UPPER(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_UP))
258#define ACPI_IS_LOWER(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO))
Lv Zhengae8ffc72014-07-08 10:06:05 +0800259#define ACPI_IS_PRINT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP | _ACPI_DI | _ACPI_XS | _ACPI_PU))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260#define ACPI_IS_ALPHA(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261
Lv Zheng6d33b6b2012-10-31 02:25:05 +0000262#endif /* !ACPI_USE_SYSTEM_CLIBRARY */
263
264#define ACPI_IS_ASCII(c) ((c) < 0x80)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265
Robert Moore44f6c012005-04-18 22:49:35 -0400266/*
267 * utcopy - Object construction and conversion interfaces
268 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400270acpi_ut_build_simple_object(union acpi_operand_object *obj,
271 union acpi_object *user_obj,
Lv Zheng6d33b6b2012-10-31 02:25:05 +0000272 u8 *data_space, u32 *buffer_space_used);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273
274acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400275acpi_ut_build_package_object(union acpi_operand_object *obj,
Lv Zheng6d33b6b2012-10-31 02:25:05 +0000276 u8 *buffer, u32 *space_used);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277
278acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400279acpi_ut_copy_iobject_to_eobject(union acpi_operand_object *obj,
280 struct acpi_buffer *ret_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281
282acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400283acpi_ut_copy_eobject_to_iobject(union acpi_object *obj,
284 union acpi_operand_object **internal_obj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285
286acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400287acpi_ut_copy_isimple_to_isimple(union acpi_operand_object *source_obj,
288 union acpi_operand_object *dest_obj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289
290acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400291acpi_ut_copy_iobject_to_iobject(union acpi_operand_object *source_desc,
292 union acpi_operand_object **dest_desc,
293 struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294
295/*
Robert Moore44f6c012005-04-18 22:49:35 -0400296 * utcreate - Object creation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400299acpi_ut_update_object_reference(union acpi_operand_object *object, u16 action);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300
301/*
Robert Moore44f6c012005-04-18 22:49:35 -0400302 * utdebug - Debug interfaces
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303 */
Len Brown4be44fc2005-08-05 00:44:28 -0400304void acpi_ut_init_stack_ptr_trace(void);
305
306void acpi_ut_track_stack_ptr(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307
308void
Len Brown4be44fc2005-08-05 00:44:28 -0400309acpi_ut_trace(u32 line_number,
Bob Moore4b8ed632008-06-10 13:55:53 +0800310 const char *function_name,
311 const char *module_name, u32 component_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312
313void
Len Brown4be44fc2005-08-05 00:44:28 -0400314acpi_ut_trace_ptr(u32 line_number,
315 const char *function_name,
Bob Moore4b8ed632008-06-10 13:55:53 +0800316 const char *module_name, u32 component_id, void *pointer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317
318void
Len Brown4be44fc2005-08-05 00:44:28 -0400319acpi_ut_trace_u32(u32 line_number,
320 const char *function_name,
Bob Moore4b8ed632008-06-10 13:55:53 +0800321 const char *module_name, u32 component_id, u32 integer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322
323void
Len Brown4be44fc2005-08-05 00:44:28 -0400324acpi_ut_trace_str(u32 line_number,
325 const char *function_name,
Bob Moore4b8ed632008-06-10 13:55:53 +0800326 const char *module_name, u32 component_id, char *string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327
328void
Len Brown4be44fc2005-08-05 00:44:28 -0400329acpi_ut_exit(u32 line_number,
Bob Moore4b8ed632008-06-10 13:55:53 +0800330 const char *function_name,
331 const char *module_name, u32 component_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332
333void
Len Brown4be44fc2005-08-05 00:44:28 -0400334acpi_ut_status_exit(u32 line_number,
335 const char *function_name,
Bob Moore4b8ed632008-06-10 13:55:53 +0800336 const char *module_name,
337 u32 component_id, acpi_status status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338
339void
Len Brown4be44fc2005-08-05 00:44:28 -0400340acpi_ut_value_exit(u32 line_number,
341 const char *function_name,
Bob Moore5df7e6c2010-01-21 10:06:32 +0800342 const char *module_name, u32 component_id, u64 value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343
344void
Len Brown4be44fc2005-08-05 00:44:28 -0400345acpi_ut_ptr_exit(u32 line_number,
346 const char *function_name,
Bob Moore4b8ed632008-06-10 13:55:53 +0800347 const char *module_name, u32 component_id, u8 *ptr);
Len Brown4be44fc2005-08-05 00:44:28 -0400348
Bob Moore97171c62012-10-31 02:28:11 +0000349void
350acpi_ut_debug_dump_buffer(u8 *buffer, u32 count, u32 display, u32 component_id);
Bob Mooreb8e4d892006-01-27 16:43:00 -0500351
Bob Moore97171c62012-10-31 02:28:11 +0000352void acpi_ut_dump_buffer(u8 *buffer, u32 count, u32 display, u32 offset);
Bob Moore793c2382006-03-31 00:00:00 -0500353
Bob Moore4a90c7e2006-01-13 16:22:00 -0500354void acpi_ut_report_error(char *module_name, u32 line_number);
Len Brown4be44fc2005-08-05 00:44:28 -0400355
Bob Moore4a90c7e2006-01-13 16:22:00 -0500356void acpi_ut_report_info(char *module_name, u32 line_number);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357
Bob Moore4a90c7e2006-01-13 16:22:00 -0500358void acpi_ut_report_warning(char *module_name, u32 line_number);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360/*
Robert Moore44f6c012005-04-18 22:49:35 -0400361 * utdelete - Object deletion and reference counts
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362 */
Len Brown4be44fc2005-08-05 00:44:28 -0400363void acpi_ut_add_reference(union acpi_operand_object *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364
Len Brown4be44fc2005-08-05 00:44:28 -0400365void acpi_ut_remove_reference(union acpi_operand_object *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366
Len Brown4be44fc2005-08-05 00:44:28 -0400367void acpi_ut_delete_internal_package_object(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_simple_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_object_list(union acpi_operand_object **obj_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372
373/*
Robert Moore44f6c012005-04-18 22:49:35 -0400374 * uteval - object evaluation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400377acpi_ut_evaluate_object(struct acpi_namespace_node *prefix_node,
378 char *path,
379 u32 expected_return_btypes,
380 union acpi_operand_object **return_desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381
382acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400383acpi_ut_evaluate_numeric_object(char *object_name,
384 struct acpi_namespace_node *device_node,
Bob Moore5df7e6c2010-01-21 10:06:32 +0800385 u64 *value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386
387acpi_status
Bob Moore15b8dd52009-06-29 13:39:29 +0800388acpi_ut_execute_STA(struct acpi_namespace_node *device_node, u32 *status_flags);
389
390acpi_status
391acpi_ut_execute_power_methods(struct acpi_namespace_node *device_node,
392 const char **method_names,
393 u8 method_count, u8 *out_values);
394
395/*
Lv Zhenge7403042014-07-08 10:06:12 +0800396 * utfileio - file operations
397 */
398#ifdef ACPI_APPLICATION
399acpi_status
400acpi_ut_read_table_from_file(char *filename, struct acpi_table_header **table);
401#endif
402
403/*
Bob Moore15b8dd52009-06-29 13:39:29 +0800404 * utids - device ID support
405 */
406acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400407acpi_ut_execute_HID(struct acpi_namespace_node *device_node,
Lv Zheng78e25fe2012-10-31 02:25:24 +0000408 struct acpi_pnp_device_id ** return_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409
410acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400411acpi_ut_execute_UID(struct acpi_namespace_node *device_node,
Lv Zheng78e25fe2012-10-31 02:25:24 +0000412 struct acpi_pnp_device_id ** return_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413
414acpi_status
Bob Moore413fc3f2012-10-31 02:28:38 +0000415acpi_ut_execute_SUB(struct acpi_namespace_node *device_node,
416 struct acpi_pnp_device_id **return_id);
417
418acpi_status
Bob Moore15b8dd52009-06-29 13:39:29 +0800419acpi_ut_execute_CID(struct acpi_namespace_node *device_node,
Lv Zheng78e25fe2012-10-31 02:25:24 +0000420 struct acpi_pnp_device_id_list ** return_cid_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421
422/*
Bob Moore8a335a232009-03-09 16:31:04 +0800423 * utlock - reader/writer locks
424 */
425acpi_status acpi_ut_create_rw_lock(struct acpi_rw_lock *lock);
426
427void acpi_ut_delete_rw_lock(struct acpi_rw_lock *lock);
428
429acpi_status acpi_ut_acquire_read_lock(struct acpi_rw_lock *lock);
430
431acpi_status acpi_ut_release_read_lock(struct acpi_rw_lock *lock);
432
433acpi_status acpi_ut_acquire_write_lock(struct acpi_rw_lock *lock);
434
435void acpi_ut_release_write_lock(struct acpi_rw_lock *lock);
436
437/*
Robert Moore44f6c012005-04-18 22:49:35 -0400438 * utobject - internal object create/delete/cache routines
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439 */
Bob Moore4b8ed632008-06-10 13:55:53 +0800440union acpi_operand_object *acpi_ut_create_internal_object_dbg(const char
441 *module_name,
Len Brown4be44fc2005-08-05 00:44:28 -0400442 u32 line_number,
443 u32 component_id,
444 acpi_object_type
445 type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446
Bob Moore4b8ed632008-06-10 13:55:53 +0800447void *acpi_ut_allocate_object_desc_dbg(const char *module_name,
Len Brown4be44fc2005-08-05 00:44:28 -0400448 u32 line_number, u32 component_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449
Robert Mooref9f46012005-07-08 00:00:00 -0400450#define acpi_ut_create_internal_object(t) acpi_ut_create_internal_object_dbg (_acpi_module_name,__LINE__,_COMPONENT,t)
451#define acpi_ut_allocate_object_desc() acpi_ut_allocate_object_desc_dbg (_acpi_module_name,__LINE__,_COMPONENT)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452
Len Brown4be44fc2005-08-05 00:44:28 -0400453void acpi_ut_delete_object_desc(union acpi_operand_object *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454
Len Brown4be44fc2005-08-05 00:44:28 -0400455u8 acpi_ut_valid_internal_object(void *object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456
Bob Moore6287ee32007-04-03 19:59:37 -0400457union acpi_operand_object *acpi_ut_create_package_object(u32 count);
458
Bob Moore502f7ef2009-11-12 09:49:50 +0800459union acpi_operand_object *acpi_ut_create_integer_object(u64 value);
460
Len Brown4be44fc2005-08-05 00:44:28 -0400461union acpi_operand_object *acpi_ut_create_buffer_object(acpi_size buffer_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462
Len Brown4be44fc2005-08-05 00:44:28 -0400463union acpi_operand_object *acpi_ut_create_string_object(acpi_size string_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400466acpi_ut_get_object_size(union acpi_operand_object *obj, acpi_size * obj_length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467
468/*
Lin Mingb0ed7a92010-08-06 09:35:51 +0800469 * utosi - Support for the _OSI predefined control method
470 */
471acpi_status acpi_ut_initialize_interfaces(void);
472
Jung-uk Kim388a9902013-04-12 00:24:34 +0000473acpi_status acpi_ut_interface_terminate(void);
Lin Mingb0ed7a92010-08-06 09:35:51 +0800474
475acpi_status acpi_ut_install_interface(acpi_string interface_name);
476
477acpi_status acpi_ut_remove_interface(acpi_string interface_name);
478
Lv Zheng2cf9f5b2013-07-22 16:08:16 +0800479acpi_status acpi_ut_update_interfaces(u8 action);
480
Lin Mingb0ed7a92010-08-06 09:35:51 +0800481struct acpi_interface_info *acpi_ut_get_interface(acpi_string interface_name);
482
483acpi_status acpi_ut_osi_implementation(struct acpi_walk_state *walk_state);
484
485/*
Bob Moorec34c82b2013-04-12 00:24:22 +0000486 * utpredef - support for predefined names
487 */
488const union acpi_predefined_info *acpi_ut_get_next_predefined_method(const union
489 acpi_predefined_info
490 *this_name);
491
492const union acpi_predefined_info *acpi_ut_match_predefined_method(char *name);
493
494const union acpi_predefined_info *acpi_ut_match_resource_name(char *name);
495
496void
497acpi_ut_display_predefined_method(char *buffer,
498 const union acpi_predefined_info *this_name,
499 u8 multi_line);
500
501void acpi_ut_get_expected_return_types(char *buffer, u32 expected_btypes);
502
503u32 acpi_ut_get_resource_bit_width(char *buffer, u16 types);
504
505/*
Robert Moore44f6c012005-04-18 22:49:35 -0400506 * utstate - Generic state creation/cache routines
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508void
Len Brown4be44fc2005-08-05 00:44:28 -0400509acpi_ut_push_generic_state(union acpi_generic_state **list_head,
510 union acpi_generic_state *state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511
Len Brown4be44fc2005-08-05 00:44:28 -0400512union acpi_generic_state *acpi_ut_pop_generic_state(union acpi_generic_state
513 **list_head);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514
Len Brown4be44fc2005-08-05 00:44:28 -0400515union acpi_generic_state *acpi_ut_create_generic_state(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516
Len Brown4be44fc2005-08-05 00:44:28 -0400517struct acpi_thread_state *acpi_ut_create_thread_state(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518
Len Brown4be44fc2005-08-05 00:44:28 -0400519union acpi_generic_state *acpi_ut_create_update_state(union acpi_operand_object
520 *object, u16 action);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521
Len Brown4be44fc2005-08-05 00:44:28 -0400522union acpi_generic_state *acpi_ut_create_pkg_state(void *internal_object,
523 void *external_object,
524 u16 index);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525
526acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400527acpi_ut_create_update_state_and_push(union acpi_operand_object *object,
528 u16 action,
529 union acpi_generic_state **state_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530
Robert Moore44f6c012005-04-18 22:49:35 -0400531#ifdef ACPI_FUTURE_USAGE
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400533acpi_ut_create_pkg_state_and_push(void *internal_object,
534 void *external_object,
535 u16 index,
536 union acpi_generic_state **state_list);
537#endif /* ACPI_FUTURE_USAGE */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538
Len Brown4be44fc2005-08-05 00:44:28 -0400539union acpi_generic_state *acpi_ut_create_control_state(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540
Len Brown4be44fc2005-08-05 00:44:28 -0400541void acpi_ut_delete_generic_state(union acpi_generic_state *state);
Robert Moore44f6c012005-04-18 22:49:35 -0400542
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543/*
Robert Moore44f6c012005-04-18 22:49:35 -0400544 * utmath
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546acpi_status
Bob Moore5df7e6c2010-01-21 10:06:32 +0800547acpi_ut_divide(u64 in_dividend,
548 u64 in_divisor, u64 *out_quotient, u64 *out_remainder);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549
550acpi_status
Bob Moore5df7e6c2010-01-21 10:06:32 +0800551acpi_ut_short_divide(u64 in_dividend,
552 u32 divisor, u64 *out_quotient, u32 *out_remainder);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553
Robert Moore44f6c012005-04-18 22:49:35 -0400554/*
555 * utmisc
556 */
Bob Mooreae1b4762013-03-08 09:22:39 +0000557const struct acpi_exception_info *acpi_ut_validate_exception(acpi_status
558 status);
Bob Moore84fb2c92007-02-02 19:48:19 +0300559
Bob Moore15b8dd52009-06-29 13:39:29 +0800560u8 acpi_ut_is_pci_root_bridge(char *id);
561
Bob Moore793c2382006-03-31 00:00:00 -0500562u8 acpi_ut_is_aml_table(struct acpi_table_header *table);
563
Robert Mooref9f46012005-07-08 00:00:00 -0400564acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400565acpi_ut_walk_package_tree(union acpi_operand_object *source_object,
566 void *target_object,
567 acpi_pkg_callback walk_callback, void *context);
Robert Moore44f6c012005-04-18 22:49:35 -0400568
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569/* Values for Base above (16=Hex, 10=Decimal) */
570
571#define ACPI_ANY_BASE 0
572
Bob Moore616861242006-03-17 16:44:00 -0500573u32 acpi_ut_dword_byte_swap(u32 value);
574
575void acpi_ut_set_integer_width(u8 revision);
576
577#ifdef ACPI_DEBUG_OUTPUT
578void
579acpi_ut_display_init_pathname(u8 type,
580 struct acpi_namespace_node *obj_handle,
581 char *path);
582#endif
583
584/*
Bob Moore42f8fb72013-01-11 13:08:51 +0100585 * utownerid - Support for Table/Method Owner IDs
586 */
587acpi_status acpi_ut_allocate_owner_id(acpi_owner_id * owner_id);
588
589void acpi_ut_release_owner_id(acpi_owner_id * owner_id);
590
591/*
Bob Moore616861242006-03-17 16:44:00 -0500592 * utresrc
593 */
594acpi_status
Bob Moore886308e2012-12-19 05:38:07 +0000595acpi_ut_walk_aml_resources(struct acpi_walk_state *walk_state,
596 u8 *aml,
Bob Moore616861242006-03-17 16:44:00 -0500597 acpi_size aml_length,
Len Brownfd350942007-05-09 23:34:35 -0400598 acpi_walk_aml_callback user_function,
599 void **context);
Bob Moore616861242006-03-17 16:44:00 -0500600
Bob Moore886308e2012-12-19 05:38:07 +0000601acpi_status
602acpi_ut_validate_resource(struct acpi_walk_state *walk_state,
603 void *aml, u8 *return_index);
Bob Moore96db2552005-11-02 00:00:00 -0500604
Bob Moore08978312005-10-21 00:00:00 -0400605u32 acpi_ut_get_descriptor_length(void *aml);
606
607u16 acpi_ut_get_resource_length(void *aml);
608
Bob Moore96db2552005-11-02 00:00:00 -0500609u8 acpi_ut_get_resource_header_length(void *aml);
610
Bob Moore08978312005-10-21 00:00:00 -0400611u8 acpi_ut_get_resource_type(void *aml);
612
Bob Moore96db2552005-11-02 00:00:00 -0500613acpi_status
Lv Zheng6d33b6b2012-10-31 02:25:05 +0000614acpi_ut_get_resource_end_tag(union acpi_operand_object *obj_desc, u8 **end_tag);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616/*
Bob Moore42f8fb72013-01-11 13:08:51 +0100617 * utstring - String and character utilities
618 */
619void acpi_ut_strupr(char *src_string);
620
621void acpi_ut_strlwr(char *src_string);
622
623int acpi_ut_stricmp(char *string1, char *string2);
624
625acpi_status acpi_ut_strtoul64(char *string, u32 base, u64 *ret_integer);
626
Bob Moore0fb3adf2013-07-17 09:48:40 +0800627void acpi_ut_print_string(char *string, u16 max_length);
Bob Moore42f8fb72013-01-11 13:08:51 +0100628
629void ut_convert_backslashes(char *pathname);
630
Bob Moorede8e7db2013-06-08 00:59:44 +0000631u8 acpi_ut_valid_acpi_name(char *name);
Bob Moore42f8fb72013-01-11 13:08:51 +0100632
633u8 acpi_ut_valid_acpi_char(char character, u32 position);
634
635void acpi_ut_repair_name(char *name);
636
Bob Moore73424472013-10-29 09:29:21 +0800637#if defined (ACPI_DEBUGGER) || defined (ACPI_APPLICATION)
638u8 acpi_ut_safe_strcpy(char *dest, acpi_size dest_size, char *source);
639
640u8 acpi_ut_safe_strcat(char *dest, acpi_size dest_size, char *source);
641
642u8
643acpi_ut_safe_strncat(char *dest,
644 acpi_size dest_size,
645 char *source, acpi_size max_transfer_length);
646#endif
647
Bob Moore42f8fb72013-01-11 13:08:51 +0100648/*
Robert Moore73459f72005-06-24 00:00:00 -0400649 * utmutex - mutex support
650 */
Len Brown4be44fc2005-08-05 00:44:28 -0400651acpi_status acpi_ut_mutex_initialize(void);
Robert Moore73459f72005-06-24 00:00:00 -0400652
Len Brown4be44fc2005-08-05 00:44:28 -0400653void acpi_ut_mutex_terminate(void);
Robert Moore73459f72005-06-24 00:00:00 -0400654
Len Brown4be44fc2005-08-05 00:44:28 -0400655acpi_status acpi_ut_acquire_mutex(acpi_mutex_handle mutex_id);
Robert Moore73459f72005-06-24 00:00:00 -0400656
Len Brown4be44fc2005-08-05 00:44:28 -0400657acpi_status acpi_ut_release_mutex(acpi_mutex_handle mutex_id);
Robert Moore73459f72005-06-24 00:00:00 -0400658
659/*
Robert Moore44f6c012005-04-18 22:49:35 -0400660 * utalloc - memory allocation and object caching
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661 */
Len Brown4be44fc2005-08-05 00:44:28 -0400662acpi_status acpi_ut_create_caches(void);
663
664acpi_status acpi_ut_delete_caches(void);
665
666acpi_status acpi_ut_validate_buffer(struct acpi_buffer *buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667
Robert Moore73459f72005-06-24 00:00:00 -0400668acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400669acpi_ut_initialize_buffer(struct acpi_buffer *buffer,
670 acpi_size required_length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672#ifdef ACPI_DBG_TRACK_ALLOCATIONS
Len Brown4be44fc2005-08-05 00:44:28 -0400673void *acpi_ut_allocate_and_track(acpi_size size,
Bob Moore4b8ed632008-06-10 13:55:53 +0800674 u32 component, const char *module, u32 line);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675
Bob Moore616861242006-03-17 16:44:00 -0500676void *acpi_ut_allocate_zeroed_and_track(acpi_size size,
Bob Moore4b8ed632008-06-10 13:55:53 +0800677 u32 component,
678 const char *module, u32 line);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679
680void
Bob Moore4b8ed632008-06-10 13:55:53 +0800681acpi_ut_free_and_track(void *address,
682 u32 component, const char *module, u32 line);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683
Robert Moore44f6c012005-04-18 22:49:35 -0400684#ifdef ACPI_FUTURE_USAGE
Len Brown4be44fc2005-08-05 00:44:28 -0400685void acpi_ut_dump_allocation_info(void);
686#endif /* ACPI_FUTURE_USAGE */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687
Bob Moore4b8ed632008-06-10 13:55:53 +0800688void acpi_ut_dump_allocations(u32 component, const char *module);
Bob Moore616861242006-03-17 16:44:00 -0500689
690acpi_status
691acpi_ut_create_list(char *list_name,
692 u16 object_size, struct acpi_memory_list **return_cache);
693
Bob Moorecc84e262010-09-15 14:09:14 +0800694#endif /* ACPI_DBG_TRACK_ALLOCATIONS */
695
696/*
Lin Mingf654c0f2012-01-12 13:10:32 +0800697 * utaddress - address range check
698 */
699acpi_status
700acpi_ut_add_address_range(acpi_adr_space_type space_id,
701 acpi_physical_address address,
702 u32 length, struct acpi_namespace_node *region_node);
703
704void
705acpi_ut_remove_address_range(acpi_adr_space_type space_id,
706 struct acpi_namespace_node *region_node);
707
708u32
709acpi_ut_check_address_range(acpi_adr_space_type space_id,
710 acpi_physical_address address, u32 length, u8 warn);
711
712void acpi_ut_delete_address_lists(void);
713
714/*
Bob Moorecc84e262010-09-15 14:09:14 +0800715 * utxferror - various error/warning output functions
716 */
717void ACPI_INTERNAL_VAR_XFACE
718acpi_ut_predefined_warning(const char *module_name,
719 u32 line_number,
720 char *pathname,
721 u8 node_flags, const char *format, ...);
722
723void ACPI_INTERNAL_VAR_XFACE
724acpi_ut_predefined_info(const char *module_name,
725 u32 line_number,
726 char *pathname, u8 node_flags, const char *format, ...);
727
Bob Mooree1405ca2013-05-30 09:59:21 +0800728void ACPI_INTERNAL_VAR_XFACE
729acpi_ut_predefined_bios_error(const char *module_name,
730 u32 line_number,
731 char *pathname,
732 u8 node_flags, const char *format, ...);
733
Bob Moorecc84e262010-09-15 14:09:14 +0800734void
735acpi_ut_namespace_error(const char *module_name,
736 u32 line_number,
737 const char *internal_name, acpi_status lookup_status);
738
739void
740acpi_ut_method_error(const char *module_name,
741 u32 line_number,
742 const char *message,
743 struct acpi_namespace_node *node,
744 const char *path, acpi_status lookup_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745
Bob Mooreb944b292014-04-04 12:37:35 +0800746/*
747 * Utility functions for ACPI names and IDs
748 */
749const struct ah_predefined_name *acpi_ah_match_predefined_name(char *nameseg);
750
Lv Zhenge2b90352014-04-04 12:39:50 +0800751const struct ah_device_id *acpi_ah_match_hardware_id(char *hid);
Bob Mooreb944b292014-04-04 12:37:35 +0800752
Len Brown4be44fc2005-08-05 00:44:28 -0400753#endif /* _ACUTILS_H */