1 /******************************************************************************
3 * Module Name: acparser.h - AML Parser subcomponent prototypes and defines
6 *****************************************************************************/
9 * Copyright (C) 2000, 2001 R. Byron Moore
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
27 #ifndef __ACPARSER_H__
28 #define __ACPARSER_H__
31 #define OP_HAS_RETURN_VALUE 1
33 /* variable # arguments */
35 #define ACPI_VAR_ARGS ACPI_UINT32_MAX
37 /* maximum virtual address */
39 #define ACPI_MAX_AML ((u8 *)(~0UL))
42 #define ACPI_PARSE_DELETE_TREE 0x0001
43 #define ACPI_PARSE_NO_TREE_DELETE 0x0000
44 #define ACPI_PARSE_TREE_MASK 0x0001
46 #define ACPI_PARSE_LOAD_PASS1 0x0010
47 #define ACPI_PARSE_LOAD_PASS2 0x0020
48 #define ACPI_PARSE_EXECUTE 0x0030
49 #define ACPI_PARSE_MODE_MASK 0x0030
51 /* psapi - Parser external interfaces */
60 ACPI_NAMESPACE_NODE *method_node,
61 ACPI_OPERAND_OBJECT **params,
62 ACPI_OPERAND_OBJECT **return_obj_desc);
66 acpi_ps_is_namespace_object_op (
69 acpi_ps_is_namespace_op (
73 /******************************************************************************
77 *****************************************************************************/
80 /* psargs - Parse AML opcode arguments */
83 acpi_ps_get_next_package_end (
84 ACPI_PARSE_STATE *parser_state);
87 acpi_ps_get_next_package_length (
88 ACPI_PARSE_STATE *parser_state);
91 acpi_ps_get_next_namestring (
92 ACPI_PARSE_STATE *parser_state);
95 acpi_ps_get_next_simple_arg (
96 ACPI_PARSE_STATE *parser_state,
97 u32 arg_type, /* type of argument */
98 ACPI_PARSE_OBJECT *arg); /* (OUT) argument data */
101 acpi_ps_get_next_namepath (
102 ACPI_PARSE_STATE *parser_state,
103 ACPI_PARSE_OBJECT *arg,
108 acpi_ps_get_next_field (
109 ACPI_PARSE_STATE *parser_state);
112 acpi_ps_get_next_arg (
113 ACPI_PARSE_STATE *parser_state,
118 /* psopcode - AML Opcode information */
121 acpi_ps_get_opcode_info (
125 acpi_ps_get_opcode_name (
129 /* psparse - top level parsing routines */
132 acpi_ps_find_object (
134 ACPI_PARSE_OBJECT *op,
135 ACPI_WALK_STATE *walk_state,
136 ACPI_PARSE_OBJECT **out_op);
139 acpi_ps_delete_parse_tree (
140 ACPI_PARSE_OBJECT *root);
144 ACPI_WALK_STATE *walk_state);
148 ACPI_PARSE_OBJECT *start_scope,
152 ACPI_NAMESPACE_NODE *method_node,
153 ACPI_OPERAND_OBJECT **params,
154 ACPI_OPERAND_OBJECT **caller_return_desc,
155 ACPI_PARSE_DOWNWARDS descending_callback,
156 ACPI_PARSE_UPWARDS ascending_callback);
159 acpi_ps_parse_table (
162 ACPI_PARSE_DOWNWARDS descending_callback,
163 ACPI_PARSE_UPWARDS ascending_callback,
164 ACPI_PARSE_OBJECT **root_object);
167 acpi_ps_peek_opcode (
168 ACPI_PARSE_STATE *state);
171 /* psscope - Scope stack management routines */
176 ACPI_PARSE_STATE *parser_state,
177 ACPI_PARSE_OBJECT *root);
180 acpi_ps_get_parent_scope (
181 ACPI_PARSE_STATE *state);
184 acpi_ps_has_completed_scope (
185 ACPI_PARSE_STATE *parser_state);
189 ACPI_PARSE_STATE *parser_state,
190 ACPI_PARSE_OBJECT **op,
196 ACPI_PARSE_STATE *parser_state,
197 ACPI_PARSE_OBJECT *op,
202 acpi_ps_cleanup_scope (
203 ACPI_PARSE_STATE *state);
206 /* pstree - parse tree manipulation routines */
210 ACPI_PARSE_OBJECT *op,
211 ACPI_PARSE_OBJECT *arg);
215 ACPI_PARSE_OBJECT *scope,
222 ACPI_PARSE_OBJECT *op,
227 ACPI_PARSE_OBJECT *op);
230 acpi_ps_get_depth_next (
231 ACPI_PARSE_OBJECT *origin,
232 ACPI_PARSE_OBJECT *op);
235 /* pswalk - parse tree walk routines */
238 acpi_ps_walk_parsed_aml (
239 ACPI_PARSE_OBJECT *start_op,
240 ACPI_PARSE_OBJECT *end_op,
241 ACPI_OPERAND_OBJECT *mth_desc,
242 ACPI_NAMESPACE_NODE *start_node,
243 ACPI_OPERAND_OBJECT **params,
244 ACPI_OPERAND_OBJECT **caller_return_desc,
245 ACPI_OWNER_ID owner_id,
246 ACPI_PARSE_DOWNWARDS descending_callback,
247 ACPI_PARSE_UPWARDS ascending_callback);
250 acpi_ps_get_next_walk_op (
251 ACPI_WALK_STATE *walk_state,
252 ACPI_PARSE_OBJECT *op,
253 ACPI_PARSE_UPWARDS ascending_callback);
256 /* psutils - parser utilities */
260 acpi_ps_create_state (
266 ACPI_PARSE_OBJECT *op,
275 ACPI_PARSE_OBJECT *op);
278 acpi_ps_delete_parse_cache (
282 acpi_ps_is_leading_char (
286 acpi_ps_is_prefix_char (
290 acpi_ps_is_named_op (
298 acpi_ps_is_deferred_op (
302 acpi_ps_is_bytelist_op(
310 acpi_ps_is_create_field_op (
314 acpi_ps_to_extended_op(
315 ACPI_PARSE_OBJECT *op);
319 ACPI_PARSE_OBJECT *op);
323 ACPI_PARSE_OBJECT *op,
327 /* psdump - display parser tree */
330 acpi_ps_sprint_path (
331 NATIVE_CHAR *buffer_start,
333 ACPI_PARSE_OBJECT *op);
337 NATIVE_CHAR *buffer_start,
339 ACPI_PARSE_OBJECT *op);
343 ACPI_PARSE_OBJECT *op);
346 #endif /* __ACPARSER_H__ */