acparser.h revision b4e104eaeb8cd4329a23e0e4ebf166681b1d182d 
1/******************************************************************************
2 *
3 * Module Name: acparser.h - AML Parser subcomponent prototypes and defines
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2011, Intel Corp.
9 * 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 __ACPARSER_H__
45#define __ACPARSER_H__
46
47#define OP_HAS_RETURN_VALUE             1
48
49/* Variable number of arguments. This field must be 32 bits */
50
51#define ACPI_VAR_ARGS                   ACPI_UINT32_MAX
52
53#define ACPI_PARSE_DELETE_TREE          0x0001
54#define ACPI_PARSE_NO_TREE_DELETE       0x0000
55#define ACPI_PARSE_TREE_MASK            0x0001
56
57#define ACPI_PARSE_LOAD_PASS1           0x0010
58#define ACPI_PARSE_LOAD_PASS2           0x0020
59#define ACPI_PARSE_EXECUTE              0x0030
60#define ACPI_PARSE_MODE_MASK            0x0030
61
62#define ACPI_PARSE_DEFERRED_OP          0x0100
63#define ACPI_PARSE_DISASSEMBLE          0x0200
64
65#define ACPI_PARSE_MODULE_LEVEL         0x0400
66
67/******************************************************************************
68 *
69 * Parser interfaces
70 *
71 *****************************************************************************/
72
73/*
74 * psxface - Parser external interfaces
75 */
76acpi_status acpi_ps_execute_method(struct acpi_evaluate_info *info);
77
78/*
79 * psargs - Parse AML opcode arguments
80 */
81u8 *acpi_ps_get_next_package_end(struct acpi_parse_state *parser_state);
82
83char *acpi_ps_get_next_namestring(struct acpi_parse_state *parser_state);
84
85void
86acpi_ps_get_next_simple_arg(struct acpi_parse_state *parser_state,
87			    u32 arg_type, union acpi_parse_object *arg);
88
89acpi_status
90acpi_ps_get_next_namepath(struct acpi_walk_state *walk_state,
91			  struct acpi_parse_state *parser_state,
92			  union acpi_parse_object *arg, u8 method_call);
93
94acpi_status
95acpi_ps_get_next_arg(struct acpi_walk_state *walk_state,
96		     struct acpi_parse_state *parser_state,
97		     u32 arg_type, union acpi_parse_object **return_arg);
98
99/*
100 * psfind
101 */
102union acpi_parse_object *acpi_ps_find_name(union acpi_parse_object *scope,
103					   u32 name, u32 opcode);
104
105union acpi_parse_object *acpi_ps_get_parent(union acpi_parse_object *op);
106
107/*
108 * psopcode - AML Opcode information
109 */
110const struct acpi_opcode_info *acpi_ps_get_opcode_info(u16 opcode);
111
112char *acpi_ps_get_opcode_name(u16 opcode);
113
114u8 acpi_ps_get_argument_count(u32 op_type);
115
116/*
117 * psparse - top level parsing routines
118 */
119acpi_status acpi_ps_parse_aml(struct acpi_walk_state *walk_state);
120
121u32 acpi_ps_get_opcode_size(u32 opcode);
122
123u16 acpi_ps_peek_opcode(struct acpi_parse_state *state);
124
125acpi_status
126acpi_ps_complete_this_op(struct acpi_walk_state *walk_state,
127			 union acpi_parse_object *op);
128
129acpi_status
130acpi_ps_next_parse_state(struct acpi_walk_state *walk_state,
131			 union acpi_parse_object *op,
132			 acpi_status callback_status);
133
134/*
135 * psloop - main parse loop
136 */
137acpi_status acpi_ps_parse_loop(struct acpi_walk_state *walk_state);
138
139/*
140 * psscope - Scope stack management routines
141 */
142acpi_status
143acpi_ps_init_scope(struct acpi_parse_state *parser_state,
144		   union acpi_parse_object *root);
145
146union acpi_parse_object *acpi_ps_get_parent_scope(struct acpi_parse_state
147						  *state);
148
149u8 acpi_ps_has_completed_scope(struct acpi_parse_state *parser_state);
150
151void
152acpi_ps_pop_scope(struct acpi_parse_state *parser_state,
153		  union acpi_parse_object **op,
154		  u32 * arg_list, u32 * arg_count);
155
156acpi_status
157acpi_ps_push_scope(struct acpi_parse_state *parser_state,
158		   union acpi_parse_object *op,
159		   u32 remaining_args, u32 arg_count);
160
161void acpi_ps_cleanup_scope(struct acpi_parse_state *state);
162
163/*
164 * pstree - parse tree manipulation routines
165 */
166void
167acpi_ps_append_arg(union acpi_parse_object *op, union acpi_parse_object *arg);
168
169union acpi_parse_object *acpi_ps_find(union acpi_parse_object *scope,
170				      char *path, u16 opcode, u32 create);
171
172union acpi_parse_object *acpi_ps_get_arg(union acpi_parse_object *op, u32 argn);
173
174#ifdef	ACPI_FUTURE_USAGE
175union acpi_parse_object *acpi_ps_get_depth_next(union acpi_parse_object *origin,
176						union acpi_parse_object *op);
177#endif				/* ACPI_FUTURE_USAGE */
178
179/*
180 * pswalk - parse tree walk routines
181 */
182acpi_status
183acpi_ps_walk_parsed_aml(union acpi_parse_object *start_op,
184			union acpi_parse_object *end_op,
185			union acpi_operand_object *mth_desc,
186			struct acpi_namespace_node *start_node,
187			union acpi_operand_object **params,
188			union acpi_operand_object **caller_return_desc,
189			acpi_owner_id owner_id,
190			acpi_parse_downwards descending_callback,
191			acpi_parse_upwards ascending_callback);
192
193acpi_status
194acpi_ps_get_next_walk_op(struct acpi_walk_state *walk_state,
195			 union acpi_parse_object *op,
196			 acpi_parse_upwards ascending_callback);
197
198acpi_status acpi_ps_delete_completed_op(struct acpi_walk_state *walk_state);
199
200void acpi_ps_delete_parse_tree(union acpi_parse_object *root);
201
202/*
203 * psutils - parser utilities
204 */
205union acpi_parse_object *acpi_ps_create_scope_op(void);
206
207void acpi_ps_init_op(union acpi_parse_object *op, u16 opcode);
208
209union acpi_parse_object *acpi_ps_alloc_op(u16 opcode);
210
211void acpi_ps_free_op(union acpi_parse_object *op);
212
213u8 acpi_ps_is_leading_char(u32 c);
214
215u8 acpi_ps_is_prefix_char(u32 c);
216
217#ifdef	ACPI_FUTURE_USAGE
218u32 acpi_ps_get_name(union acpi_parse_object *op);
219#endif				/* ACPI_FUTURE_USAGE */
220
221void acpi_ps_set_name(union acpi_parse_object *op, u32 name);
222
223/*
224 * psdump - display parser tree
225 */
226u32
227acpi_ps_sprint_path(char *buffer_start,
228		    u32 buffer_size, union acpi_parse_object *op);
229
230u32
231acpi_ps_sprint_op(char *buffer_start,
232		  u32 buffer_size, union acpi_parse_object *op);
233
234void acpi_ps_show(union acpi_parse_object *op);
235
236#endif				/* __ACPARSER_H__ */
237