acparser.h revision 102550 
1/******************************************************************************
2 *
3 * Module Name: acparser.h - AML Parser subcomponent prototypes and defines
4 *       $Revision: 61 $
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
139/* Parser external interfaces */
140
141ACPI_STATUS
142AcpiPsxLoadTable (
143    UINT8                   *PcodeAddr,
144    UINT32                  PcodeLength);
145
146ACPI_STATUS
147AcpiPsxExecute (
148    ACPI_NAMESPACE_NODE     *MethodNode,
149    ACPI_OPERAND_OBJECT     **Params,
150    ACPI_OPERAND_OBJECT     **ReturnObjDesc);
151
152
153/******************************************************************************
154 *
155 * Parser interfaces
156 *
157 *****************************************************************************/
158
159
160/* psargs - Parse AML opcode arguments */
161
162UINT8 *
163AcpiPsGetNextPackageEnd (
164    ACPI_PARSE_STATE        *ParserState);
165
166UINT32
167AcpiPsGetNextPackageLength (
168    ACPI_PARSE_STATE        *ParserState);
169
170NATIVE_CHAR *
171AcpiPsGetNextNamestring (
172    ACPI_PARSE_STATE        *ParserState);
173
174void
175AcpiPsGetNextSimpleArg (
176    ACPI_PARSE_STATE        *ParserState,
177    UINT32                  ArgType,
178    ACPI_PARSE_OBJECT       *Arg);
179
180ACPI_STATUS
181AcpiPsGetNextNamepath (
182    ACPI_PARSE_STATE        *ParserState,
183    ACPI_PARSE_OBJECT       *Arg,
184    UINT32                  *ArgCount,
185    BOOLEAN                 MethodCall);
186
187ACPI_PARSE_OBJECT *
188AcpiPsGetNextField (
189    ACPI_PARSE_STATE        *ParserState);
190
191ACPI_STATUS
192AcpiPsGetNextArg (
193    ACPI_PARSE_STATE        *ParserState,
194    UINT32                  ArgType,
195    UINT32                  *ArgCount,
196    ACPI_PARSE_OBJECT       **ReturnArg);
197
198
199/* psfind */
200
201ACPI_PARSE_OBJECT *
202AcpiPsFindName (
203    ACPI_PARSE_OBJECT       *Scope,
204    UINT32                  Name,
205    UINT32                  Opcode);
206
207ACPI_PARSE_OBJECT*
208AcpiPsGetParent (
209    ACPI_PARSE_OBJECT       *Op);
210
211
212/* psopcode - AML Opcode information */
213
214const ACPI_OPCODE_INFO *
215AcpiPsGetOpcodeInfo (
216    UINT16                  Opcode);
217
218NATIVE_CHAR *
219AcpiPsGetOpcodeName (
220    UINT16                  Opcode);
221
222
223/* psparse - top level parsing routines */
224
225UINT32
226AcpiPsGetOpcodeSize (
227    UINT32                  Opcode);
228
229void
230AcpiPsCompleteThisOp (
231    ACPI_WALK_STATE         *WalkState,
232    ACPI_PARSE_OBJECT       *Op);
233
234ACPI_STATUS
235AcpiPsNextParseState (
236    ACPI_WALK_STATE         *WalkState,
237    ACPI_PARSE_OBJECT       *Op,
238    ACPI_STATUS             CallbackStatus);
239
240ACPI_STATUS
241AcpiPsFindObject (
242    ACPI_WALK_STATE         *WalkState,
243    ACPI_PARSE_OBJECT       **OutOp);
244
245void
246AcpiPsDeleteParseTree (
247    ACPI_PARSE_OBJECT       *root);
248
249ACPI_STATUS
250AcpiPsParseLoop (
251    ACPI_WALK_STATE         *WalkState);
252
253ACPI_STATUS
254AcpiPsParseAml (
255    ACPI_WALK_STATE         *WalkState);
256
257ACPI_STATUS
258AcpiPsParseTable (
259    UINT8                   *aml,
260    UINT32                  amlSize,
261    ACPI_PARSE_DOWNWARDS    DescendingCallback,
262    ACPI_PARSE_UPWARDS      AscendingCallback,
263    ACPI_PARSE_OBJECT       **RootObject);
264
265UINT16
266AcpiPsPeekOpcode (
267    ACPI_PARSE_STATE        *state);
268
269
270/* psscope - Scope stack management routines */
271
272
273ACPI_STATUS
274AcpiPsInitScope (
275    ACPI_PARSE_STATE        *ParserState,
276    ACPI_PARSE_OBJECT       *Root);
277
278ACPI_PARSE_OBJECT *
279AcpiPsGetParentScope (
280    ACPI_PARSE_STATE        *state);
281
282BOOLEAN
283AcpiPsHasCompletedScope (
284    ACPI_PARSE_STATE        *ParserState);
285
286void
287AcpiPsPopScope (
288    ACPI_PARSE_STATE        *ParserState,
289    ACPI_PARSE_OBJECT       **Op,
290    UINT32                  *ArgList,
291    UINT32                  *ArgCount);
292
293ACPI_STATUS
294AcpiPsPushScope (
295    ACPI_PARSE_STATE        *ParserState,
296    ACPI_PARSE_OBJECT       *Op,
297    UINT32                  RemainingArgs,
298    UINT32                  ArgCount);
299
300void
301AcpiPsCleanupScope (
302    ACPI_PARSE_STATE        *state);
303
304
305/* pstree - parse tree manipulation routines */
306
307void
308AcpiPsAppendArg(
309    ACPI_PARSE_OBJECT       *op,
310    ACPI_PARSE_OBJECT       *arg);
311
312ACPI_PARSE_OBJECT*
313AcpiPsFind (
314    ACPI_PARSE_OBJECT       *Scope,
315    NATIVE_CHAR             *Path,
316    UINT16                  Opcode,
317    UINT32                  Create);
318
319ACPI_PARSE_OBJECT *
320AcpiPsGetArg(
321    ACPI_PARSE_OBJECT       *op,
322    UINT32                   argn);
323
324ACPI_PARSE_OBJECT *
325AcpiPsGetChild (
326    ACPI_PARSE_OBJECT       *op);
327
328ACPI_PARSE_OBJECT *
329AcpiPsGetDepthNext (
330    ACPI_PARSE_OBJECT       *Origin,
331    ACPI_PARSE_OBJECT       *Op);
332
333
334/* pswalk - parse tree walk routines */
335
336ACPI_STATUS
337AcpiPsWalkParsedAml (
338    ACPI_PARSE_OBJECT       *StartOp,
339    ACPI_PARSE_OBJECT       *EndOp,
340    ACPI_OPERAND_OBJECT     *MthDesc,
341    ACPI_NAMESPACE_NODE     *StartNode,
342    ACPI_OPERAND_OBJECT     **Params,
343    ACPI_OPERAND_OBJECT     **CallerReturnDesc,
344    ACPI_OWNER_ID           OwnerId,
345    ACPI_PARSE_DOWNWARDS    DescendingCallback,
346    ACPI_PARSE_UPWARDS      AscendingCallback);
347
348ACPI_STATUS
349AcpiPsGetNextWalkOp (
350    ACPI_WALK_STATE         *WalkState,
351    ACPI_PARSE_OBJECT       *Op,
352    ACPI_PARSE_UPWARDS      AscendingCallback);
353
354ACPI_STATUS
355AcpiPsDeleteCompletedOp (
356    ACPI_WALK_STATE         *WalkState);
357
358
359/* psutils - parser utilities */
360
361ACPI_PARSE_OBJECT *
362AcpiPsCreateScopeOp (
363    void);
364
365void
366AcpiPsInitOp (
367    ACPI_PARSE_OBJECT       *op,
368    UINT16                  opcode);
369
370ACPI_PARSE_OBJECT *
371AcpiPsAllocOp (
372    UINT16                  opcode);
373
374void
375AcpiPsFreeOp (
376    ACPI_PARSE_OBJECT       *Op);
377
378void
379AcpiPsDeleteParseCache (
380    void);
381
382BOOLEAN
383AcpiPsIsLeadingChar (
384    UINT32                  c);
385
386BOOLEAN
387AcpiPsIsPrefixChar (
388    UINT32                  c);
389
390UINT32
391AcpiPsGetName(
392    ACPI_PARSE_OBJECT       *op);
393
394void
395AcpiPsSetName(
396    ACPI_PARSE_OBJECT       *op,
397    UINT32                  name);
398
399
400/* psdump - display parser tree */
401
402UINT32
403AcpiPsSprintPath (
404    NATIVE_CHAR             *BufferStart,
405    UINT32                  BufferSize,
406    ACPI_PARSE_OBJECT       *Op);
407
408UINT32
409AcpiPsSprintOp (
410    NATIVE_CHAR             *BufferStart,
411    UINT32                  BufferSize,
412    ACPI_PARSE_OBJECT       *Op);
413
414void
415AcpiPsShow (
416    ACPI_PARSE_OBJECT       *op);
417
418
419#endif /* __ACPARSER_H__ */
420