1/******************************************************************************
2 *
3 * Module Name: acparser.h - AML Parser subcomponent prototypes and defines
4 * $Revision: 62 $
5 *
6 *****************************************************************************/
7
8/******************************************************************************
9 *
10 * 1. Copyright Notice
11 *
12 * Some or all of this work - Copyright (c) 1999 - 2002, Intel Corp.
13 * All rights reserved.
14 *
15 * 2. License
16 *
17 * 2.1. This is your license from Intel Corp. under its intellectual property
18 * rights. You may have additional license terms from the party that provided
19 * you this software, covering your right to use that party's intellectual
20 * property rights.
21 *
22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23 * copy of the source code appearing in this file ("Covered Code") an
24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25 * base code distributed originally by Intel ("Original Intel Code") to copy,
26 * make derivatives, distribute, use and display any portion of the Covered
27 * Code in any form, with the right to sublicense such rights; and
28 *
29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30 * license (with the right to sublicense), under only those claims of Intel
31 * patents that are infringed by the Original Intel Code, to make, use, sell,
32 * offer to sell, and import the Covered Code and derivative works thereof
33 * solely to the minimum extent necessary to exercise the above copyright
34 * license, and in no event shall the patent license extend to any additions
35 * to or modifications of the Original Intel Code. No other license or right
36 * is granted directly or by implication, estoppel or otherwise;
37 *
38 * The above copyright and patent license is granted only if the following
39 * conditions are met:
40 *
41 * 3. Conditions
42 *
43 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44 * Redistribution of source code of any substantial portion of the Covered
45 * Code or modification with rights to further distribute source must include
46 * the above Copyright Notice, the above License, this list of Conditions,
47 * and the following Disclaimer and Export Compliance provision. In addition,
48 * Licensee must cause all Covered Code to which Licensee contributes to
49 * contain a file documenting the changes Licensee made to create that Covered
50 * Code and the date of any change. Licensee must include in that file the
51 * documentation of any changes made by any predecessor Licensee. Licensee
52 * must include a prominent statement that the modification is derived,
53 * directly or indirectly, from Original Intel Code.
54 *
55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56 * Redistribution of source code of any substantial portion of the Covered
57 * Code or modification without rights to further distribute source must
58 * include the following Disclaimer and Export Compliance provision in the
59 * documentation and/or other materials provided with distribution. In
60 * addition, Licensee may not authorize further sublicense of source of any
61 * portion of the Covered Code, and must include terms to the effect that the
62 * license from Licensee to its licensee is limited to the intellectual
63 * property embodied in the software Licensee provides to its licensee, and
64 * not to intellectual property embodied in modifications its licensee may
65 * make.
66 *
67 * 3.3. Redistribution of Executable. Redistribution in executable form of any
68 * substantial portion of the Covered Code or modification must reproduce the
69 * above Copyright Notice, and the following Disclaimer and Export Compliance
70 * provision in the documentation and/or other materials provided with the
71 * distribution.
72 *
73 * 3.4. Intel retains all right, title, and interest in and to the Original
74 * Intel Code.
75 *
76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77 * Intel shall be used in advertising or otherwise to promote the sale, use or
78 * other dealings in products derived from or relating to the Covered Code
79 * without prior written authorization from Intel.
80 *
81 * 4. Disclaimer and Export Compliance
82 *
83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
89 * PARTICULAR PURPOSE.
90 *
91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
98 * LIMITED REMEDY.
99 *
100 * 4.3. Licensee shall not export, either directly or indirectly, any of this
101 * software or system incorporating such software without first obtaining any
102 * required license or other approval from the U. S. Department of Commerce or
103 * any other agency or department of the United States Government. In the
104 * event Licensee exports any such software from the United States or
105 * re-exports any such software from a foreign destination, Licensee shall
106 * ensure that the distribution and export/re-export of the software is in
107 * compliance with all laws, regulations, orders, or other restrictions of the
108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109 * any of its subsidiaries will export/re-export any technical data, process,
110 * software, or service, directly or indirectly, to any country for which the
111 * United States government or any agency thereof requires an export license,
112 * other governmental approval, or letter of assurance, without first obtaining
113 * such license, approval or letter.
114 *
115 *****************************************************************************/
116
117
118#ifndef __ACPARSER_H__
119#define __ACPARSER_H__
120
121
122#define OP_HAS_RETURN_VALUE 1
123
124/* variable # arguments */
125
126#define ACPI_VAR_ARGS ACPI_UINT32_MAX
127
128
129#define ACPI_PARSE_DELETE_TREE 0x0001
130#define ACPI_PARSE_NO_TREE_DELETE 0x0000
131#define ACPI_PARSE_TREE_MASK 0x0001
132
133#define ACPI_PARSE_LOAD_PASS1 0x0010
134#define ACPI_PARSE_LOAD_PASS2 0x0020
135#define ACPI_PARSE_EXECUTE 0x0030
136#define ACPI_PARSE_MODE_MASK 0x0030
137
138#define ACPI_PARSE_DEFERRED_OP 0x0100
139
140/* Parser external interfaces */
141
142ACPI_STATUS
143AcpiPsxLoadTable (
144 UINT8 *PcodeAddr,
145 UINT32 PcodeLength);
146
147ACPI_STATUS
148AcpiPsxExecute (
149 ACPI_NAMESPACE_NODE *MethodNode,
150 ACPI_OPERAND_OBJECT **Params,
151 ACPI_OPERAND_OBJECT **ReturnObjDesc);
152
153
154/******************************************************************************
155 *
156 * Parser interfaces
157 *
158 *****************************************************************************/
159
160
161/* psargs - Parse AML opcode arguments */
162
163UINT8 *
164AcpiPsGetNextPackageEnd (
165 ACPI_PARSE_STATE *ParserState);
166
167UINT32
168AcpiPsGetNextPackageLength (
169 ACPI_PARSE_STATE *ParserState);
170
171NATIVE_CHAR *
172AcpiPsGetNextNamestring (
173 ACPI_PARSE_STATE *ParserState);
174
175void
176AcpiPsGetNextSimpleArg (
177 ACPI_PARSE_STATE *ParserState,
178 UINT32 ArgType,
179 ACPI_PARSE_OBJECT *Arg);
180
181ACPI_STATUS
182AcpiPsGetNextNamepath (
183 ACPI_PARSE_STATE *ParserState,
184 ACPI_PARSE_OBJECT *Arg,
185 UINT32 *ArgCount,
186 BOOLEAN MethodCall);
187
188ACPI_PARSE_OBJECT *
189AcpiPsGetNextField (
190 ACPI_PARSE_STATE *ParserState);
191
192ACPI_STATUS
193AcpiPsGetNextArg (
194 ACPI_PARSE_STATE *ParserState,
195 UINT32 ArgType,
196 UINT32 *ArgCount,
197 ACPI_PARSE_OBJECT **ReturnArg);
198
199
200/* psfind */
201
202ACPI_PARSE_OBJECT *
203AcpiPsFindName (
204 ACPI_PARSE_OBJECT *Scope,
205 UINT32 Name,
206 UINT32 Opcode);
207
208ACPI_PARSE_OBJECT*
209AcpiPsGetParent (
210 ACPI_PARSE_OBJECT *Op);
211
212
213/* psopcode - AML Opcode information */
214
215const ACPI_OPCODE_INFO *
216AcpiPsGetOpcodeInfo (
217 UINT16 Opcode);
218
219NATIVE_CHAR *
220AcpiPsGetOpcodeName (
221 UINT16 Opcode);
222
223
224/* psparse - top level parsing routines */
225
226UINT32
227AcpiPsGetOpcodeSize (
228 UINT32 Opcode);
229
230void
231AcpiPsCompleteThisOp (
232 ACPI_WALK_STATE *WalkState,
233 ACPI_PARSE_OBJECT *Op);
234
235ACPI_STATUS
236AcpiPsNextParseState (
237 ACPI_WALK_STATE *WalkState,
238 ACPI_PARSE_OBJECT *Op,
239 ACPI_STATUS CallbackStatus);
240
241ACPI_STATUS
242AcpiPsFindObject (
243 ACPI_WALK_STATE *WalkState,
244 ACPI_PARSE_OBJECT **OutOp);
245
246void
247AcpiPsDeleteParseTree (
248 ACPI_PARSE_OBJECT *root);
249
250ACPI_STATUS
251AcpiPsParseLoop (
252 ACPI_WALK_STATE *WalkState);
253
254ACPI_STATUS
255AcpiPsParseAml (
256 ACPI_WALK_STATE *WalkState);
257
258ACPI_STATUS
259AcpiPsParseTable (
260 UINT8 *aml,
261 UINT32 amlSize,
262 ACPI_PARSE_DOWNWARDS DescendingCallback,
263 ACPI_PARSE_UPWARDS AscendingCallback,
264 ACPI_PARSE_OBJECT **RootObject);
265
266UINT16
267AcpiPsPeekOpcode (
268 ACPI_PARSE_STATE *state);
269
270
271/* psscope - Scope stack management routines */
272
273
274ACPI_STATUS
275AcpiPsInitScope (
276 ACPI_PARSE_STATE *ParserState,
277 ACPI_PARSE_OBJECT *Root);
278
279ACPI_PARSE_OBJECT *
280AcpiPsGetParentScope (
281 ACPI_PARSE_STATE *state);
282
283BOOLEAN
284AcpiPsHasCompletedScope (
285 ACPI_PARSE_STATE *ParserState);
286
287void
288AcpiPsPopScope (
289 ACPI_PARSE_STATE *ParserState,
290 ACPI_PARSE_OBJECT **Op,
291 UINT32 *ArgList,
292 UINT32 *ArgCount);
293
294ACPI_STATUS
295AcpiPsPushScope (
296 ACPI_PARSE_STATE *ParserState,
297 ACPI_PARSE_OBJECT *Op,
298 UINT32 RemainingArgs,
299 UINT32 ArgCount);
300
301void
302AcpiPsCleanupScope (
303 ACPI_PARSE_STATE *state);
304
305
306/* pstree - parse tree manipulation routines */
307
308void
309AcpiPsAppendArg(
310 ACPI_PARSE_OBJECT *op,
311 ACPI_PARSE_OBJECT *arg);
312
313ACPI_PARSE_OBJECT*
314AcpiPsFind (
315 ACPI_PARSE_OBJECT *Scope,
316 NATIVE_CHAR *Path,
317 UINT16 Opcode,
318 UINT32 Create);
319
320ACPI_PARSE_OBJECT *
321AcpiPsGetArg(
322 ACPI_PARSE_OBJECT *op,
323 UINT32 argn);
324
325ACPI_PARSE_OBJECT *
326AcpiPsGetChild (
327 ACPI_PARSE_OBJECT *op);
328
329ACPI_PARSE_OBJECT *
330AcpiPsGetDepthNext (
331 ACPI_PARSE_OBJECT *Origin,
332 ACPI_PARSE_OBJECT *Op);
333
334
335/* pswalk - parse tree walk routines */
336
337ACPI_STATUS
338AcpiPsWalkParsedAml (
339 ACPI_PARSE_OBJECT *StartOp,
340 ACPI_PARSE_OBJECT *EndOp,
341 ACPI_OPERAND_OBJECT *MthDesc,
342 ACPI_NAMESPACE_NODE *StartNode,
343 ACPI_OPERAND_OBJECT **Params,
344 ACPI_OPERAND_OBJECT **CallerReturnDesc,
345 ACPI_OWNER_ID OwnerId,
346 ACPI_PARSE_DOWNWARDS DescendingCallback,
347 ACPI_PARSE_UPWARDS AscendingCallback);
348
349ACPI_STATUS
350AcpiPsGetNextWalkOp (
351 ACPI_WALK_STATE *WalkState,
352 ACPI_PARSE_OBJECT *Op,
353 ACPI_PARSE_UPWARDS AscendingCallback);
354
355ACPI_STATUS
356AcpiPsDeleteCompletedOp (
357 ACPI_WALK_STATE *WalkState);
358
359
360/* psutils - parser utilities */
361
362ACPI_PARSE_OBJECT *
363AcpiPsCreateScopeOp (
364 void);
365
366void
367AcpiPsInitOp (
368 ACPI_PARSE_OBJECT *op,
369 UINT16 opcode);
370
371ACPI_PARSE_OBJECT *
372AcpiPsAllocOp (
373 UINT16 opcode);
374
375void
376AcpiPsFreeOp (
377 ACPI_PARSE_OBJECT *Op);
378
379void
380AcpiPsDeleteParseCache (
381 void);
382
383BOOLEAN
384AcpiPsIsLeadingChar (
385 UINT32 c);
386
387BOOLEAN
388AcpiPsIsPrefixChar (
389 UINT32 c);
390
391UINT32
392AcpiPsGetName(
393 ACPI_PARSE_OBJECT *op);
394
395void
396AcpiPsSetName(
397 ACPI_PARSE_OBJECT *op,
398 UINT32 name);
399
400
401/* psdump - display parser tree */
402
403UINT32
404AcpiPsSprintPath (
405 NATIVE_CHAR *BufferStart,
406 UINT32 BufferSize,
407 ACPI_PARSE_OBJECT *Op);
408
409UINT32
410AcpiPsSprintOp (
411 NATIVE_CHAR *BufferStart,
412 UINT32 BufferSize,
413 ACPI_PARSE_OBJECT *Op);
414
415void
416AcpiPsShow (
417 ACPI_PARSE_OBJECT *op);
418
419
420#endif /* __ACPARSER_H__ */
2 *
3 * Module Name: acparser.h - AML Parser subcomponent prototypes and defines
4 * $Revision: 62 $
5 *
6 *****************************************************************************/
7
8/******************************************************************************
9 *
10 * 1. Copyright Notice
11 *
12 * Some or all of this work - Copyright (c) 1999 - 2002, Intel Corp.
13 * All rights reserved.
14 *
15 * 2. License
16 *
17 * 2.1. This is your license from Intel Corp. under its intellectual property
18 * rights. You may have additional license terms from the party that provided
19 * you this software, covering your right to use that party's intellectual
20 * property rights.
21 *
22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23 * copy of the source code appearing in this file ("Covered Code") an
24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25 * base code distributed originally by Intel ("Original Intel Code") to copy,
26 * make derivatives, distribute, use and display any portion of the Covered
27 * Code in any form, with the right to sublicense such rights; and
28 *
29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30 * license (with the right to sublicense), under only those claims of Intel
31 * patents that are infringed by the Original Intel Code, to make, use, sell,
32 * offer to sell, and import the Covered Code and derivative works thereof
33 * solely to the minimum extent necessary to exercise the above copyright
34 * license, and in no event shall the patent license extend to any additions
35 * to or modifications of the Original Intel Code. No other license or right
36 * is granted directly or by implication, estoppel or otherwise;
37 *
38 * The above copyright and patent license is granted only if the following
39 * conditions are met:
40 *
41 * 3. Conditions
42 *
43 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44 * Redistribution of source code of any substantial portion of the Covered
45 * Code or modification with rights to further distribute source must include
46 * the above Copyright Notice, the above License, this list of Conditions,
47 * and the following Disclaimer and Export Compliance provision. In addition,
48 * Licensee must cause all Covered Code to which Licensee contributes to
49 * contain a file documenting the changes Licensee made to create that Covered
50 * Code and the date of any change. Licensee must include in that file the
51 * documentation of any changes made by any predecessor Licensee. Licensee
52 * must include a prominent statement that the modification is derived,
53 * directly or indirectly, from Original Intel Code.
54 *
55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56 * Redistribution of source code of any substantial portion of the Covered
57 * Code or modification without rights to further distribute source must
58 * include the following Disclaimer and Export Compliance provision in the
59 * documentation and/or other materials provided with distribution. In
60 * addition, Licensee may not authorize further sublicense of source of any
61 * portion of the Covered Code, and must include terms to the effect that the
62 * license from Licensee to its licensee is limited to the intellectual
63 * property embodied in the software Licensee provides to its licensee, and
64 * not to intellectual property embodied in modifications its licensee may
65 * make.
66 *
67 * 3.3. Redistribution of Executable. Redistribution in executable form of any
68 * substantial portion of the Covered Code or modification must reproduce the
69 * above Copyright Notice, and the following Disclaimer and Export Compliance
70 * provision in the documentation and/or other materials provided with the
71 * distribution.
72 *
73 * 3.4. Intel retains all right, title, and interest in and to the Original
74 * Intel Code.
75 *
76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77 * Intel shall be used in advertising or otherwise to promote the sale, use or
78 * other dealings in products derived from or relating to the Covered Code
79 * without prior written authorization from Intel.
80 *
81 * 4. Disclaimer and Export Compliance
82 *
83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
89 * PARTICULAR PURPOSE.
90 *
91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
98 * LIMITED REMEDY.
99 *
100 * 4.3. Licensee shall not export, either directly or indirectly, any of this
101 * software or system incorporating such software without first obtaining any
102 * required license or other approval from the U. S. Department of Commerce or
103 * any other agency or department of the United States Government. In the
104 * event Licensee exports any such software from the United States or
105 * re-exports any such software from a foreign destination, Licensee shall
106 * ensure that the distribution and export/re-export of the software is in
107 * compliance with all laws, regulations, orders, or other restrictions of the
108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109 * any of its subsidiaries will export/re-export any technical data, process,
110 * software, or service, directly or indirectly, to any country for which the
111 * United States government or any agency thereof requires an export license,
112 * other governmental approval, or letter of assurance, without first obtaining
113 * such license, approval or letter.
114 *
115 *****************************************************************************/
116
117
118#ifndef __ACPARSER_H__
119#define __ACPARSER_H__
120
121
122#define OP_HAS_RETURN_VALUE 1
123
124/* variable # arguments */
125
126#define ACPI_VAR_ARGS ACPI_UINT32_MAX
127
128
129#define ACPI_PARSE_DELETE_TREE 0x0001
130#define ACPI_PARSE_NO_TREE_DELETE 0x0000
131#define ACPI_PARSE_TREE_MASK 0x0001
132
133#define ACPI_PARSE_LOAD_PASS1 0x0010
134#define ACPI_PARSE_LOAD_PASS2 0x0020
135#define ACPI_PARSE_EXECUTE 0x0030
136#define ACPI_PARSE_MODE_MASK 0x0030
137
138#define ACPI_PARSE_DEFERRED_OP 0x0100
139
140/* Parser external interfaces */
141
142ACPI_STATUS
143AcpiPsxLoadTable (
144 UINT8 *PcodeAddr,
145 UINT32 PcodeLength);
146
147ACPI_STATUS
148AcpiPsxExecute (
149 ACPI_NAMESPACE_NODE *MethodNode,
150 ACPI_OPERAND_OBJECT **Params,
151 ACPI_OPERAND_OBJECT **ReturnObjDesc);
152
153
154/******************************************************************************
155 *
156 * Parser interfaces
157 *
158 *****************************************************************************/
159
160
161/* psargs - Parse AML opcode arguments */
162
163UINT8 *
164AcpiPsGetNextPackageEnd (
165 ACPI_PARSE_STATE *ParserState);
166
167UINT32
168AcpiPsGetNextPackageLength (
169 ACPI_PARSE_STATE *ParserState);
170
171NATIVE_CHAR *
172AcpiPsGetNextNamestring (
173 ACPI_PARSE_STATE *ParserState);
174
175void
176AcpiPsGetNextSimpleArg (
177 ACPI_PARSE_STATE *ParserState,
178 UINT32 ArgType,
179 ACPI_PARSE_OBJECT *Arg);
180
181ACPI_STATUS
182AcpiPsGetNextNamepath (
183 ACPI_PARSE_STATE *ParserState,
184 ACPI_PARSE_OBJECT *Arg,
185 UINT32 *ArgCount,
186 BOOLEAN MethodCall);
187
188ACPI_PARSE_OBJECT *
189AcpiPsGetNextField (
190 ACPI_PARSE_STATE *ParserState);
191
192ACPI_STATUS
193AcpiPsGetNextArg (
194 ACPI_PARSE_STATE *ParserState,
195 UINT32 ArgType,
196 UINT32 *ArgCount,
197 ACPI_PARSE_OBJECT **ReturnArg);
198
199
200/* psfind */
201
202ACPI_PARSE_OBJECT *
203AcpiPsFindName (
204 ACPI_PARSE_OBJECT *Scope,
205 UINT32 Name,
206 UINT32 Opcode);
207
208ACPI_PARSE_OBJECT*
209AcpiPsGetParent (
210 ACPI_PARSE_OBJECT *Op);
211
212
213/* psopcode - AML Opcode information */
214
215const ACPI_OPCODE_INFO *
216AcpiPsGetOpcodeInfo (
217 UINT16 Opcode);
218
219NATIVE_CHAR *
220AcpiPsGetOpcodeName (
221 UINT16 Opcode);
222
223
224/* psparse - top level parsing routines */
225
226UINT32
227AcpiPsGetOpcodeSize (
228 UINT32 Opcode);
229
230void
231AcpiPsCompleteThisOp (
232 ACPI_WALK_STATE *WalkState,
233 ACPI_PARSE_OBJECT *Op);
234
235ACPI_STATUS
236AcpiPsNextParseState (
237 ACPI_WALK_STATE *WalkState,
238 ACPI_PARSE_OBJECT *Op,
239 ACPI_STATUS CallbackStatus);
240
241ACPI_STATUS
242AcpiPsFindObject (
243 ACPI_WALK_STATE *WalkState,
244 ACPI_PARSE_OBJECT **OutOp);
245
246void
247AcpiPsDeleteParseTree (
248 ACPI_PARSE_OBJECT *root);
249
250ACPI_STATUS
251AcpiPsParseLoop (
252 ACPI_WALK_STATE *WalkState);
253
254ACPI_STATUS
255AcpiPsParseAml (
256 ACPI_WALK_STATE *WalkState);
257
258ACPI_STATUS
259AcpiPsParseTable (
260 UINT8 *aml,
261 UINT32 amlSize,
262 ACPI_PARSE_DOWNWARDS DescendingCallback,
263 ACPI_PARSE_UPWARDS AscendingCallback,
264 ACPI_PARSE_OBJECT **RootObject);
265
266UINT16
267AcpiPsPeekOpcode (
268 ACPI_PARSE_STATE *state);
269
270
271/* psscope - Scope stack management routines */
272
273
274ACPI_STATUS
275AcpiPsInitScope (
276 ACPI_PARSE_STATE *ParserState,
277 ACPI_PARSE_OBJECT *Root);
278
279ACPI_PARSE_OBJECT *
280AcpiPsGetParentScope (
281 ACPI_PARSE_STATE *state);
282
283BOOLEAN
284AcpiPsHasCompletedScope (
285 ACPI_PARSE_STATE *ParserState);
286
287void
288AcpiPsPopScope (
289 ACPI_PARSE_STATE *ParserState,
290 ACPI_PARSE_OBJECT **Op,
291 UINT32 *ArgList,
292 UINT32 *ArgCount);
293
294ACPI_STATUS
295AcpiPsPushScope (
296 ACPI_PARSE_STATE *ParserState,
297 ACPI_PARSE_OBJECT *Op,
298 UINT32 RemainingArgs,
299 UINT32 ArgCount);
300
301void
302AcpiPsCleanupScope (
303 ACPI_PARSE_STATE *state);
304
305
306/* pstree - parse tree manipulation routines */
307
308void
309AcpiPsAppendArg(
310 ACPI_PARSE_OBJECT *op,
311 ACPI_PARSE_OBJECT *arg);
312
313ACPI_PARSE_OBJECT*
314AcpiPsFind (
315 ACPI_PARSE_OBJECT *Scope,
316 NATIVE_CHAR *Path,
317 UINT16 Opcode,
318 UINT32 Create);
319
320ACPI_PARSE_OBJECT *
321AcpiPsGetArg(
322 ACPI_PARSE_OBJECT *op,
323 UINT32 argn);
324
325ACPI_PARSE_OBJECT *
326AcpiPsGetChild (
327 ACPI_PARSE_OBJECT *op);
328
329ACPI_PARSE_OBJECT *
330AcpiPsGetDepthNext (
331 ACPI_PARSE_OBJECT *Origin,
332 ACPI_PARSE_OBJECT *Op);
333
334
335/* pswalk - parse tree walk routines */
336
337ACPI_STATUS
338AcpiPsWalkParsedAml (
339 ACPI_PARSE_OBJECT *StartOp,
340 ACPI_PARSE_OBJECT *EndOp,
341 ACPI_OPERAND_OBJECT *MthDesc,
342 ACPI_NAMESPACE_NODE *StartNode,
343 ACPI_OPERAND_OBJECT **Params,
344 ACPI_OPERAND_OBJECT **CallerReturnDesc,
345 ACPI_OWNER_ID OwnerId,
346 ACPI_PARSE_DOWNWARDS DescendingCallback,
347 ACPI_PARSE_UPWARDS AscendingCallback);
348
349ACPI_STATUS
350AcpiPsGetNextWalkOp (
351 ACPI_WALK_STATE *WalkState,
352 ACPI_PARSE_OBJECT *Op,
353 ACPI_PARSE_UPWARDS AscendingCallback);
354
355ACPI_STATUS
356AcpiPsDeleteCompletedOp (
357 ACPI_WALK_STATE *WalkState);
358
359
360/* psutils - parser utilities */
361
362ACPI_PARSE_OBJECT *
363AcpiPsCreateScopeOp (
364 void);
365
366void
367AcpiPsInitOp (
368 ACPI_PARSE_OBJECT *op,
369 UINT16 opcode);
370
371ACPI_PARSE_OBJECT *
372AcpiPsAllocOp (
373 UINT16 opcode);
374
375void
376AcpiPsFreeOp (
377 ACPI_PARSE_OBJECT *Op);
378
379void
380AcpiPsDeleteParseCache (
381 void);
382
383BOOLEAN
384AcpiPsIsLeadingChar (
385 UINT32 c);
386
387BOOLEAN
388AcpiPsIsPrefixChar (
389 UINT32 c);
390
391UINT32
392AcpiPsGetName(
393 ACPI_PARSE_OBJECT *op);
394
395void
396AcpiPsSetName(
397 ACPI_PARSE_OBJECT *op,
398 UINT32 name);
399
400
401/* psdump - display parser tree */
402
403UINT32
404AcpiPsSprintPath (
405 NATIVE_CHAR *BufferStart,
406 UINT32 BufferSize,
407 ACPI_PARSE_OBJECT *Op);
408
409UINT32
410AcpiPsSprintOp (
411 NATIVE_CHAR *BufferStart,
412 UINT32 BufferSize,
413 ACPI_PARSE_OBJECT *Op);
414
415void
416AcpiPsShow (
417 ACPI_PARSE_OBJECT *op);
418
419
420#endif /* __ACPARSER_H__ */