1 /******************************************************************************
3 * Module Name: acparser.h - AML Parser subcomponent prototypes and defines
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2005, R. Byron Moore
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
45 #ifndef __ACPARSER_H__
46 #define __ACPARSER_H__
49 #define OP_HAS_RETURN_VALUE 1
51 /* variable # arguments */
53 #define ACPI_VAR_ARGS ACPI_UINT32_MAX
56 #define ACPI_PARSE_DELETE_TREE 0x0001
57 #define ACPI_PARSE_NO_TREE_DELETE 0x0000
58 #define ACPI_PARSE_TREE_MASK 0x0001
60 #define ACPI_PARSE_LOAD_PASS1 0x0010
61 #define ACPI_PARSE_LOAD_PASS2 0x0020
62 #define ACPI_PARSE_EXECUTE 0x0030
63 #define ACPI_PARSE_MODE_MASK 0x0030
65 #define ACPI_PARSE_DEFERRED_OP 0x0100
66 #define ACPI_PARSE_DISASSEMBLE 0x0200
69 /******************************************************************************
73 *****************************************************************************/
77 * psxface - Parser external interfaces
86 struct acpi_parameter_info *info);
90 * psargs - Parse AML opcode arguments
93 acpi_ps_get_next_package_end (
94 struct acpi_parse_state *parser_state);
97 acpi_ps_get_next_namestring (
98 struct acpi_parse_state *parser_state);
101 acpi_ps_get_next_simple_arg (
102 struct acpi_parse_state *parser_state,
104 union acpi_parse_object *arg);
107 acpi_ps_get_next_namepath (
108 struct acpi_walk_state *walk_state,
109 struct acpi_parse_state *parser_state,
110 union acpi_parse_object *arg,
114 acpi_ps_get_next_arg (
115 struct acpi_walk_state *walk_state,
116 struct acpi_parse_state *parser_state,
118 union acpi_parse_object **return_arg);
124 union acpi_parse_object *
126 union acpi_parse_object *scope,
130 union acpi_parse_object*
132 union acpi_parse_object *op);
136 * psopcode - AML Opcode information
138 const struct acpi_opcode_info *
139 acpi_ps_get_opcode_info (
143 acpi_ps_get_opcode_name (
148 * psparse - top level parsing routines
152 struct acpi_walk_state *walk_state);
155 acpi_ps_get_opcode_size (
159 acpi_ps_peek_opcode (
160 struct acpi_parse_state *state);
163 acpi_ps_complete_this_op (
164 struct acpi_walk_state *walk_state,
165 union acpi_parse_object *op);
168 acpi_ps_next_parse_state (
169 struct acpi_walk_state *walk_state,
170 union acpi_parse_object *op,
171 acpi_status callback_status);
175 * psloop - main parse loop
179 struct acpi_walk_state *walk_state);
183 * psscope - Scope stack management routines
187 struct acpi_parse_state *parser_state,
188 union acpi_parse_object *root);
190 union acpi_parse_object *
191 acpi_ps_get_parent_scope (
192 struct acpi_parse_state *state);
195 acpi_ps_has_completed_scope (
196 struct acpi_parse_state *parser_state);
200 struct acpi_parse_state *parser_state,
201 union acpi_parse_object **op,
207 struct acpi_parse_state *parser_state,
208 union acpi_parse_object *op,
213 acpi_ps_cleanup_scope (
214 struct acpi_parse_state *state);
218 * pstree - parse tree manipulation routines
222 union acpi_parse_object *op,
223 union acpi_parse_object *arg);
225 union acpi_parse_object*
227 union acpi_parse_object *scope,
232 union acpi_parse_object *
234 union acpi_parse_object *op,
237 #ifdef ACPI_FUTURE_USAGE
238 union acpi_parse_object *
239 acpi_ps_get_depth_next (
240 union acpi_parse_object *origin,
241 union acpi_parse_object *op);
242 #endif /* ACPI_FUTURE_USAGE */
246 * pswalk - parse tree walk routines
249 acpi_ps_walk_parsed_aml (
250 union acpi_parse_object *start_op,
251 union acpi_parse_object *end_op,
252 union acpi_operand_object *mth_desc,
253 struct acpi_namespace_node *start_node,
254 union acpi_operand_object **params,
255 union acpi_operand_object **caller_return_desc,
256 acpi_owner_id owner_id,
257 acpi_parse_downwards descending_callback,
258 acpi_parse_upwards ascending_callback);
261 acpi_ps_get_next_walk_op (
262 struct acpi_walk_state *walk_state,
263 union acpi_parse_object *op,
264 acpi_parse_upwards ascending_callback);
267 acpi_ps_delete_completed_op (
268 struct acpi_walk_state *walk_state);
271 acpi_ps_delete_parse_tree (
272 union acpi_parse_object *root);
276 * psutils - parser utilities
278 union acpi_parse_object *
279 acpi_ps_create_scope_op (
284 union acpi_parse_object *op,
287 union acpi_parse_object *
293 union acpi_parse_object *op);
296 acpi_ps_is_leading_char (
300 acpi_ps_is_prefix_char (
303 #ifdef ACPI_FUTURE_USAGE
306 union acpi_parse_object *op);
307 #endif /* ACPI_FUTURE_USAGE */
311 union acpi_parse_object *op,
316 * psdump - display parser tree
319 acpi_ps_sprint_path (
322 union acpi_parse_object *op);
328 union acpi_parse_object *op);
332 union acpi_parse_object *op);
335 #endif /* __ACPARSER_H__ */