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