acparser.h revision 1.1.1.2.2.2 1 1.1.1.2.2.2 bouyer /******************************************************************************
2 1.1.1.2.2.2 bouyer *
3 1.1.1.2.2.2 bouyer * Module Name: acparser.h - AML Parser subcomponent prototypes and defines
4 1.1.1.2.2.2 bouyer *
5 1.1.1.2.2.2 bouyer *****************************************************************************/
6 1.1.1.2.2.2 bouyer
7 1.1.1.2.2.2 bouyer /*
8 1.1.1.2.2.2 bouyer * Copyright (C) 2000 - 2011, Intel Corp.
9 1.1.1.2.2.2 bouyer * All rights reserved.
10 1.1.1.2.2.2 bouyer *
11 1.1.1.2.2.2 bouyer * Redistribution and use in source and binary forms, with or without
12 1.1.1.2.2.2 bouyer * modification, are permitted provided that the following conditions
13 1.1.1.2.2.2 bouyer * are met:
14 1.1.1.2.2.2 bouyer * 1. Redistributions of source code must retain the above copyright
15 1.1.1.2.2.2 bouyer * notice, this list of conditions, and the following disclaimer,
16 1.1.1.2.2.2 bouyer * without modification.
17 1.1.1.2.2.2 bouyer * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 1.1.1.2.2.2 bouyer * substantially similar to the "NO WARRANTY" disclaimer below
19 1.1.1.2.2.2 bouyer * ("Disclaimer") and any redistribution must be conditioned upon
20 1.1.1.2.2.2 bouyer * including a substantially similar Disclaimer requirement for further
21 1.1.1.2.2.2 bouyer * binary redistribution.
22 1.1.1.2.2.2 bouyer * 3. Neither the names of the above-listed copyright holders nor the names
23 1.1.1.2.2.2 bouyer * of any contributors may be used to endorse or promote products derived
24 1.1.1.2.2.2 bouyer * from this software without specific prior written permission.
25 1.1.1.2.2.2 bouyer *
26 1.1.1.2.2.2 bouyer * Alternatively, this software may be distributed under the terms of the
27 1.1.1.2.2.2 bouyer * GNU General Public License ("GPL") version 2 as published by the Free
28 1.1.1.2.2.2 bouyer * Software Foundation.
29 1.1.1.2.2.2 bouyer *
30 1.1.1.2.2.2 bouyer * NO WARRANTY
31 1.1.1.2.2.2 bouyer * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 1.1.1.2.2.2 bouyer * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 1.1.1.2.2.2 bouyer * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 1.1.1.2.2.2 bouyer * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 1.1.1.2.2.2 bouyer * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 1.1.1.2.2.2 bouyer * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 1.1.1.2.2.2 bouyer * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 1.1.1.2.2.2 bouyer * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 1.1.1.2.2.2 bouyer * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 1.1.1.2.2.2 bouyer * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 1.1.1.2.2.2 bouyer * POSSIBILITY OF SUCH DAMAGES.
42 1.1.1.2.2.2 bouyer */
43 1.1.1.2.2.2 bouyer
44 1.1.1.2.2.2 bouyer
45 1.1.1.2.2.2 bouyer #ifndef __ACPARSER_H__
46 1.1.1.2.2.2 bouyer #define __ACPARSER_H__
47 1.1.1.2.2.2 bouyer
48 1.1.1.2.2.2 bouyer
49 1.1.1.2.2.2 bouyer #define OP_HAS_RETURN_VALUE 1
50 1.1.1.2.2.2 bouyer
51 1.1.1.2.2.2 bouyer /* Variable number of arguments. This field must be 32 bits */
52 1.1.1.2.2.2 bouyer
53 1.1.1.2.2.2 bouyer #define ACPI_VAR_ARGS ACPI_UINT32_MAX
54 1.1.1.2.2.2 bouyer
55 1.1.1.2.2.2 bouyer
56 1.1.1.2.2.2 bouyer #define ACPI_PARSE_DELETE_TREE 0x0001
57 1.1.1.2.2.2 bouyer #define ACPI_PARSE_NO_TREE_DELETE 0x0000
58 1.1.1.2.2.2 bouyer #define ACPI_PARSE_TREE_MASK 0x0001
59 1.1.1.2.2.2 bouyer
60 1.1.1.2.2.2 bouyer #define ACPI_PARSE_LOAD_PASS1 0x0010
61 1.1.1.2.2.2 bouyer #define ACPI_PARSE_LOAD_PASS2 0x0020
62 1.1.1.2.2.2 bouyer #define ACPI_PARSE_EXECUTE 0x0030
63 1.1.1.2.2.2 bouyer #define ACPI_PARSE_MODE_MASK 0x0030
64 1.1.1.2.2.2 bouyer
65 1.1.1.2.2.2 bouyer #define ACPI_PARSE_DEFERRED_OP 0x0100
66 1.1.1.2.2.2 bouyer #define ACPI_PARSE_DISASSEMBLE 0x0200
67 1.1.1.2.2.2 bouyer
68 1.1.1.2.2.2 bouyer #define ACPI_PARSE_MODULE_LEVEL 0x0400
69 1.1.1.2.2.2 bouyer
70 1.1.1.2.2.2 bouyer /******************************************************************************
71 1.1.1.2.2.2 bouyer *
72 1.1.1.2.2.2 bouyer * Parser interfaces
73 1.1.1.2.2.2 bouyer *
74 1.1.1.2.2.2 bouyer *****************************************************************************/
75 1.1.1.2.2.2 bouyer
76 1.1.1.2.2.2 bouyer
77 1.1.1.2.2.2 bouyer /*
78 1.1.1.2.2.2 bouyer * psxface - Parser external interfaces
79 1.1.1.2.2.2 bouyer */
80 1.1.1.2.2.2 bouyer ACPI_STATUS
81 1.1.1.2.2.2 bouyer AcpiPsExecuteMethod (
82 1.1.1.2.2.2 bouyer ACPI_EVALUATE_INFO *Info);
83 1.1.1.2.2.2 bouyer
84 1.1.1.2.2.2 bouyer
85 1.1.1.2.2.2 bouyer /*
86 1.1.1.2.2.2 bouyer * psargs - Parse AML opcode arguments
87 1.1.1.2.2.2 bouyer */
88 1.1.1.2.2.2 bouyer UINT8 *
89 1.1.1.2.2.2 bouyer AcpiPsGetNextPackageEnd (
90 1.1.1.2.2.2 bouyer ACPI_PARSE_STATE *ParserState);
91 1.1.1.2.2.2 bouyer
92 1.1.1.2.2.2 bouyer char *
93 1.1.1.2.2.2 bouyer AcpiPsGetNextNamestring (
94 1.1.1.2.2.2 bouyer ACPI_PARSE_STATE *ParserState);
95 1.1.1.2.2.2 bouyer
96 1.1.1.2.2.2 bouyer void
97 1.1.1.2.2.2 bouyer AcpiPsGetNextSimpleArg (
98 1.1.1.2.2.2 bouyer ACPI_PARSE_STATE *ParserState,
99 1.1.1.2.2.2 bouyer UINT32 ArgType,
100 1.1.1.2.2.2 bouyer ACPI_PARSE_OBJECT *Arg);
101 1.1.1.2.2.2 bouyer
102 1.1.1.2.2.2 bouyer ACPI_STATUS
103 1.1.1.2.2.2 bouyer AcpiPsGetNextNamepath (
104 1.1.1.2.2.2 bouyer ACPI_WALK_STATE *WalkState,
105 1.1.1.2.2.2 bouyer ACPI_PARSE_STATE *ParserState,
106 1.1.1.2.2.2 bouyer ACPI_PARSE_OBJECT *Arg,
107 1.1.1.2.2.2 bouyer BOOLEAN MethodCall);
108 1.1.1.2.2.2 bouyer
109 1.1.1.2.2.2 bouyer ACPI_STATUS
110 1.1.1.2.2.2 bouyer AcpiPsGetNextArg (
111 1.1.1.2.2.2 bouyer ACPI_WALK_STATE *WalkState,
112 1.1.1.2.2.2 bouyer ACPI_PARSE_STATE *ParserState,
113 1.1.1.2.2.2 bouyer UINT32 ArgType,
114 1.1.1.2.2.2 bouyer ACPI_PARSE_OBJECT **ReturnArg);
115 1.1.1.2.2.2 bouyer
116 1.1.1.2.2.2 bouyer
117 1.1.1.2.2.2 bouyer /*
118 1.1.1.2.2.2 bouyer * psfind
119 1.1.1.2.2.2 bouyer */
120 1.1.1.2.2.2 bouyer ACPI_PARSE_OBJECT *
121 1.1.1.2.2.2 bouyer AcpiPsFindName (
122 1.1.1.2.2.2 bouyer ACPI_PARSE_OBJECT *Scope,
123 1.1.1.2.2.2 bouyer UINT32 Name,
124 1.1.1.2.2.2 bouyer UINT32 Opcode);
125 1.1.1.2.2.2 bouyer
126 1.1.1.2.2.2 bouyer ACPI_PARSE_OBJECT*
127 1.1.1.2.2.2 bouyer AcpiPsGetParent (
128 1.1.1.2.2.2 bouyer ACPI_PARSE_OBJECT *Op);
129 1.1.1.2.2.2 bouyer
130 1.1.1.2.2.2 bouyer
131 1.1.1.2.2.2 bouyer /*
132 1.1.1.2.2.2 bouyer * psopcode - AML Opcode information
133 1.1.1.2.2.2 bouyer */
134 1.1.1.2.2.2 bouyer const ACPI_OPCODE_INFO *
135 1.1.1.2.2.2 bouyer AcpiPsGetOpcodeInfo (
136 1.1.1.2.2.2 bouyer UINT16 Opcode);
137 1.1.1.2.2.2 bouyer
138 1.1.1.2.2.2 bouyer char *
139 1.1.1.2.2.2 bouyer AcpiPsGetOpcodeName (
140 1.1.1.2.2.2 bouyer UINT16 Opcode);
141 1.1.1.2.2.2 bouyer
142 1.1.1.2.2.2 bouyer UINT8
143 1.1.1.2.2.2 bouyer AcpiPsGetArgumentCount (
144 1.1.1.2.2.2 bouyer UINT32 OpType);
145 1.1.1.2.2.2 bouyer
146 1.1.1.2.2.2 bouyer
147 1.1.1.2.2.2 bouyer /*
148 1.1.1.2.2.2 bouyer * psparse - top level parsing routines
149 1.1.1.2.2.2 bouyer */
150 1.1.1.2.2.2 bouyer ACPI_STATUS
151 1.1.1.2.2.2 bouyer AcpiPsParseAml (
152 1.1.1.2.2.2 bouyer ACPI_WALK_STATE *WalkState);
153 1.1.1.2.2.2 bouyer
154 1.1.1.2.2.2 bouyer UINT32
155 1.1.1.2.2.2 bouyer AcpiPsGetOpcodeSize (
156 1.1.1.2.2.2 bouyer UINT32 Opcode);
157 1.1.1.2.2.2 bouyer
158 1.1.1.2.2.2 bouyer UINT16
159 1.1.1.2.2.2 bouyer AcpiPsPeekOpcode (
160 1.1.1.2.2.2 bouyer ACPI_PARSE_STATE *state);
161 1.1.1.2.2.2 bouyer
162 1.1.1.2.2.2 bouyer ACPI_STATUS
163 1.1.1.2.2.2 bouyer AcpiPsCompleteThisOp (
164 1.1.1.2.2.2 bouyer ACPI_WALK_STATE *WalkState,
165 1.1.1.2.2.2 bouyer ACPI_PARSE_OBJECT *Op);
166 1.1.1.2.2.2 bouyer
167 1.1.1.2.2.2 bouyer ACPI_STATUS
168 1.1.1.2.2.2 bouyer AcpiPsNextParseState (
169 1.1.1.2.2.2 bouyer ACPI_WALK_STATE *WalkState,
170 1.1.1.2.2.2 bouyer ACPI_PARSE_OBJECT *Op,
171 1.1.1.2.2.2 bouyer ACPI_STATUS CallbackStatus);
172 1.1.1.2.2.2 bouyer
173 1.1.1.2.2.2 bouyer
174 1.1.1.2.2.2 bouyer /*
175 1.1.1.2.2.2 bouyer * psloop - main parse loop
176 1.1.1.2.2.2 bouyer */
177 1.1.1.2.2.2 bouyer ACPI_STATUS
178 1.1.1.2.2.2 bouyer AcpiPsParseLoop (
179 1.1.1.2.2.2 bouyer ACPI_WALK_STATE *WalkState);
180 1.1.1.2.2.2 bouyer
181 1.1.1.2.2.2 bouyer
182 1.1.1.2.2.2 bouyer /*
183 1.1.1.2.2.2 bouyer * psscope - Scope stack management routines
184 1.1.1.2.2.2 bouyer */
185 1.1.1.2.2.2 bouyer ACPI_STATUS
186 1.1.1.2.2.2 bouyer AcpiPsInitScope (
187 1.1.1.2.2.2 bouyer ACPI_PARSE_STATE *ParserState,
188 1.1.1.2.2.2 bouyer ACPI_PARSE_OBJECT *Root);
189 1.1.1.2.2.2 bouyer
190 1.1.1.2.2.2 bouyer ACPI_PARSE_OBJECT *
191 1.1.1.2.2.2 bouyer AcpiPsGetParentScope (
192 1.1.1.2.2.2 bouyer ACPI_PARSE_STATE *state);
193 1.1.1.2.2.2 bouyer
194 1.1.1.2.2.2 bouyer BOOLEAN
195 1.1.1.2.2.2 bouyer AcpiPsHasCompletedScope (
196 1.1.1.2.2.2 bouyer ACPI_PARSE_STATE *ParserState);
197 1.1.1.2.2.2 bouyer
198 1.1.1.2.2.2 bouyer void
199 1.1.1.2.2.2 bouyer AcpiPsPopScope (
200 1.1.1.2.2.2 bouyer ACPI_PARSE_STATE *ParserState,
201 1.1.1.2.2.2 bouyer ACPI_PARSE_OBJECT **Op,
202 1.1.1.2.2.2 bouyer UINT32 *ArgList,
203 1.1.1.2.2.2 bouyer UINT32 *ArgCount);
204 1.1.1.2.2.2 bouyer
205 1.1.1.2.2.2 bouyer ACPI_STATUS
206 1.1.1.2.2.2 bouyer AcpiPsPushScope (
207 1.1.1.2.2.2 bouyer ACPI_PARSE_STATE *ParserState,
208 1.1.1.2.2.2 bouyer ACPI_PARSE_OBJECT *Op,
209 1.1.1.2.2.2 bouyer UINT32 RemainingArgs,
210 1.1.1.2.2.2 bouyer UINT32 ArgCount);
211 1.1.1.2.2.2 bouyer
212 1.1.1.2.2.2 bouyer void
213 1.1.1.2.2.2 bouyer AcpiPsCleanupScope (
214 1.1.1.2.2.2 bouyer ACPI_PARSE_STATE *state);
215 1.1.1.2.2.2 bouyer
216 1.1.1.2.2.2 bouyer
217 1.1.1.2.2.2 bouyer /*
218 1.1.1.2.2.2 bouyer * pstree - parse tree manipulation routines
219 1.1.1.2.2.2 bouyer */
220 1.1.1.2.2.2 bouyer void
221 1.1.1.2.2.2 bouyer AcpiPsAppendArg(
222 1.1.1.2.2.2 bouyer ACPI_PARSE_OBJECT *op,
223 1.1.1.2.2.2 bouyer ACPI_PARSE_OBJECT *arg);
224 1.1.1.2.2.2 bouyer
225 1.1.1.2.2.2 bouyer ACPI_PARSE_OBJECT*
226 1.1.1.2.2.2 bouyer AcpiPsFind (
227 1.1.1.2.2.2 bouyer ACPI_PARSE_OBJECT *Scope,
228 1.1.1.2.2.2 bouyer char *Path,
229 1.1.1.2.2.2 bouyer UINT16 Opcode,
230 1.1.1.2.2.2 bouyer UINT32 Create);
231 1.1.1.2.2.2 bouyer
232 1.1.1.2.2.2 bouyer ACPI_PARSE_OBJECT *
233 1.1.1.2.2.2 bouyer AcpiPsGetArg(
234 1.1.1.2.2.2 bouyer ACPI_PARSE_OBJECT *op,
235 1.1.1.2.2.2 bouyer UINT32 argn);
236 1.1.1.2.2.2 bouyer
237 1.1.1.2.2.2 bouyer ACPI_PARSE_OBJECT *
238 1.1.1.2.2.2 bouyer AcpiPsGetDepthNext (
239 1.1.1.2.2.2 bouyer ACPI_PARSE_OBJECT *Origin,
240 1.1.1.2.2.2 bouyer ACPI_PARSE_OBJECT *Op);
241 1.1.1.2.2.2 bouyer
242 1.1.1.2.2.2 bouyer
243 1.1.1.2.2.2 bouyer /*
244 1.1.1.2.2.2 bouyer * pswalk - parse tree walk routines
245 1.1.1.2.2.2 bouyer */
246 1.1.1.2.2.2 bouyer ACPI_STATUS
247 1.1.1.2.2.2 bouyer AcpiPsWalkParsedAml (
248 1.1.1.2.2.2 bouyer ACPI_PARSE_OBJECT *StartOp,
249 1.1.1.2.2.2 bouyer ACPI_PARSE_OBJECT *EndOp,
250 1.1.1.2.2.2 bouyer ACPI_OPERAND_OBJECT *MthDesc,
251 1.1.1.2.2.2 bouyer ACPI_NAMESPACE_NODE *StartNode,
252 1.1.1.2.2.2 bouyer ACPI_OPERAND_OBJECT **Params,
253 1.1.1.2.2.2 bouyer ACPI_OPERAND_OBJECT **CallerReturnDesc,
254 1.1.1.2.2.2 bouyer ACPI_OWNER_ID OwnerId,
255 1.1.1.2.2.2 bouyer ACPI_PARSE_DOWNWARDS DescendingCallback,
256 1.1.1.2.2.2 bouyer ACPI_PARSE_UPWARDS AscendingCallback);
257 1.1.1.2.2.2 bouyer
258 1.1.1.2.2.2 bouyer ACPI_STATUS
259 1.1.1.2.2.2 bouyer AcpiPsGetNextWalkOp (
260 1.1.1.2.2.2 bouyer ACPI_WALK_STATE *WalkState,
261 1.1.1.2.2.2 bouyer ACPI_PARSE_OBJECT *Op,
262 1.1.1.2.2.2 bouyer ACPI_PARSE_UPWARDS AscendingCallback);
263 1.1.1.2.2.2 bouyer
264 1.1.1.2.2.2 bouyer ACPI_STATUS
265 1.1.1.2.2.2 bouyer AcpiPsDeleteCompletedOp (
266 1.1.1.2.2.2 bouyer ACPI_WALK_STATE *WalkState);
267 1.1.1.2.2.2 bouyer
268 1.1.1.2.2.2 bouyer void
269 1.1.1.2.2.2 bouyer AcpiPsDeleteParseTree (
270 1.1.1.2.2.2 bouyer ACPI_PARSE_OBJECT *root);
271 1.1.1.2.2.2 bouyer
272 1.1.1.2.2.2 bouyer
273 1.1.1.2.2.2 bouyer /*
274 1.1.1.2.2.2 bouyer * psutils - parser utilities
275 1.1.1.2.2.2 bouyer */
276 1.1.1.2.2.2 bouyer ACPI_PARSE_OBJECT *
277 1.1.1.2.2.2 bouyer AcpiPsCreateScopeOp (
278 1.1.1.2.2.2 bouyer void);
279 1.1.1.2.2.2 bouyer
280 1.1.1.2.2.2 bouyer void
281 1.1.1.2.2.2 bouyer AcpiPsInitOp (
282 1.1.1.2.2.2 bouyer ACPI_PARSE_OBJECT *op,
283 1.1.1.2.2.2 bouyer UINT16 opcode);
284 1.1.1.2.2.2 bouyer
285 1.1.1.2.2.2 bouyer ACPI_PARSE_OBJECT *
286 1.1.1.2.2.2 bouyer AcpiPsAllocOp (
287 1.1.1.2.2.2 bouyer UINT16 opcode);
288 1.1.1.2.2.2 bouyer
289 1.1.1.2.2.2 bouyer void
290 1.1.1.2.2.2 bouyer AcpiPsFreeOp (
291 1.1.1.2.2.2 bouyer ACPI_PARSE_OBJECT *Op);
292 1.1.1.2.2.2 bouyer
293 1.1.1.2.2.2 bouyer BOOLEAN
294 1.1.1.2.2.2 bouyer AcpiPsIsLeadingChar (
295 1.1.1.2.2.2 bouyer UINT32 c);
296 1.1.1.2.2.2 bouyer
297 1.1.1.2.2.2 bouyer BOOLEAN
298 1.1.1.2.2.2 bouyer AcpiPsIsPrefixChar (
299 1.1.1.2.2.2 bouyer UINT32 c);
300 1.1.1.2.2.2 bouyer
301 1.1.1.2.2.2 bouyer UINT32
302 1.1.1.2.2.2 bouyer AcpiPsGetName(
303 1.1.1.2.2.2 bouyer ACPI_PARSE_OBJECT *op);
304 1.1.1.2.2.2 bouyer
305 1.1.1.2.2.2 bouyer void
306 1.1.1.2.2.2 bouyer AcpiPsSetName(
307 1.1.1.2.2.2 bouyer ACPI_PARSE_OBJECT *op,
308 1.1.1.2.2.2 bouyer UINT32 name);
309 1.1.1.2.2.2 bouyer
310 1.1.1.2.2.2 bouyer
311 1.1.1.2.2.2 bouyer /*
312 1.1.1.2.2.2 bouyer * psdump - display parser tree
313 1.1.1.2.2.2 bouyer */
314 1.1.1.2.2.2 bouyer UINT32
315 1.1.1.2.2.2 bouyer AcpiPsSprintPath (
316 1.1.1.2.2.2 bouyer char *BufferStart,
317 1.1.1.2.2.2 bouyer UINT32 BufferSize,
318 1.1.1.2.2.2 bouyer ACPI_PARSE_OBJECT *Op);
319 1.1.1.2.2.2 bouyer
320 1.1.1.2.2.2 bouyer UINT32
321 1.1.1.2.2.2 bouyer AcpiPsSprintOp (
322 1.1.1.2.2.2 bouyer char *BufferStart,
323 1.1.1.2.2.2 bouyer UINT32 BufferSize,
324 1.1.1.2.2.2 bouyer ACPI_PARSE_OBJECT *Op);
325 1.1.1.2.2.2 bouyer
326 1.1.1.2.2.2 bouyer void
327 1.1.1.2.2.2 bouyer AcpiPsShow (
328 1.1.1.2.2.2 bouyer ACPI_PARSE_OBJECT *op);
329 1.1.1.2.2.2 bouyer
330 1.1.1.2.2.2 bouyer
331 1.1.1.2.2.2 bouyer #endif /* __ACPARSER_H__ */
332