acparser.h revision 347:04ff98e42cf2 
1/******************************************************************************
2 *
3 * Module Name: acparser.h - AML Parser subcomponent prototypes and defines
4 *       $Revision: 76 $
5 *
6 *****************************************************************************/
7
8/******************************************************************************
9 *
10 * 1. Copyright Notice
11 *
12 * Some or all of this work - Copyright (c) 1999 - 2005, 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#define ACPI_PARSE_DISASSEMBLE          0x0200
140
141
142/******************************************************************************
143 *
144 * Parser interfaces
145 *
146 *****************************************************************************/
147
148
149/*
150 * psxface - Parser external interfaces
151 */
152ACPI_STATUS
153AcpiPsxLoadTable (
154    UINT8                   *PcodeAddr,
155    UINT32                  PcodeLength);
156
157ACPI_STATUS
158AcpiPsxExecute (
159    ACPI_PARAMETER_INFO     *Info);
160
161
162/*
163 * psargs - Parse AML opcode arguments
164 */
165UINT8 *
166AcpiPsGetNextPackageEnd (
167    ACPI_PARSE_STATE        *ParserState);
168
169char *
170AcpiPsGetNextNamestring (
171    ACPI_PARSE_STATE        *ParserState);
172
173void
174AcpiPsGetNextSimpleArg (
175    ACPI_PARSE_STATE        *ParserState,
176    UINT32                  ArgType,
177    ACPI_PARSE_OBJECT       *Arg);
178
179ACPI_STATUS
180AcpiPsGetNextNamepath (
181    ACPI_WALK_STATE         *WalkState,
182    ACPI_PARSE_STATE        *ParserState,
183    ACPI_PARSE_OBJECT       *Arg,
184    BOOLEAN                 MethodCall);
185
186ACPI_STATUS
187AcpiPsGetNextArg (
188    ACPI_WALK_STATE         *WalkState,
189    ACPI_PARSE_STATE        *ParserState,
190    UINT32                  ArgType,
191    ACPI_PARSE_OBJECT       **ReturnArg);
192
193
194/*
195 * psfind
196 */
197ACPI_PARSE_OBJECT *
198AcpiPsFindName (
199    ACPI_PARSE_OBJECT       *Scope,
200    UINT32                  Name,
201    UINT32                  Opcode);
202
203ACPI_PARSE_OBJECT*
204AcpiPsGetParent (
205    ACPI_PARSE_OBJECT       *Op);
206
207
208/*
209 * psopcode - AML Opcode information
210 */
211const ACPI_OPCODE_INFO *
212AcpiPsGetOpcodeInfo (
213    UINT16                  Opcode);
214
215char *
216AcpiPsGetOpcodeName (
217    UINT16                  Opcode);
218
219
220/*
221 * psparse - top level parsing routines
222 */
223ACPI_STATUS
224AcpiPsParseAml (
225    ACPI_WALK_STATE         *WalkState);
226
227UINT32
228AcpiPsGetOpcodeSize (
229    UINT32                  Opcode);
230
231UINT16
232AcpiPsPeekOpcode (
233    ACPI_PARSE_STATE        *state);
234
235ACPI_STATUS
236AcpiPsCompleteThisOp (
237    ACPI_WALK_STATE         *WalkState,
238    ACPI_PARSE_OBJECT       *Op);
239
240ACPI_STATUS
241AcpiPsNextParseState (
242    ACPI_WALK_STATE         *WalkState,
243    ACPI_PARSE_OBJECT       *Op,
244    ACPI_STATUS             CallbackStatus);
245
246
247/*
248 * psloop - main parse loop
249 */
250ACPI_STATUS
251AcpiPsParseLoop (
252    ACPI_WALK_STATE         *WalkState);
253
254
255/*
256 * psscope - Scope stack management routines
257 */
258ACPI_STATUS
259AcpiPsInitScope (
260    ACPI_PARSE_STATE        *ParserState,
261    ACPI_PARSE_OBJECT       *Root);
262
263ACPI_PARSE_OBJECT *
264AcpiPsGetParentScope (
265    ACPI_PARSE_STATE        *state);
266
267BOOLEAN
268AcpiPsHasCompletedScope (
269    ACPI_PARSE_STATE        *ParserState);
270
271void
272AcpiPsPopScope (
273    ACPI_PARSE_STATE        *ParserState,
274    ACPI_PARSE_OBJECT       **Op,
275    UINT32                  *ArgList,
276    UINT32                  *ArgCount);
277
278ACPI_STATUS
279AcpiPsPushScope (
280    ACPI_PARSE_STATE        *ParserState,
281    ACPI_PARSE_OBJECT       *Op,
282    UINT32                  RemainingArgs,
283    UINT32                  ArgCount);
284
285void
286AcpiPsCleanupScope (
287    ACPI_PARSE_STATE        *state);
288
289
290/*
291 * pstree - parse tree manipulation routines
292 */
293void
294AcpiPsAppendArg(
295    ACPI_PARSE_OBJECT       *op,
296    ACPI_PARSE_OBJECT       *arg);
297
298ACPI_PARSE_OBJECT*
299AcpiPsFind (
300    ACPI_PARSE_OBJECT       *Scope,
301    char                    *Path,
302    UINT16                  Opcode,
303    UINT32                  Create);
304
305ACPI_PARSE_OBJECT *
306AcpiPsGetArg(
307    ACPI_PARSE_OBJECT       *op,
308    UINT32                   argn);
309
310ACPI_PARSE_OBJECT *
311AcpiPsGetDepthNext (
312    ACPI_PARSE_OBJECT       *Origin,
313    ACPI_PARSE_OBJECT       *Op);
314
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
337ACPI_STATUS
338AcpiPsDeleteCompletedOp (
339    ACPI_WALK_STATE         *WalkState);
340
341void
342AcpiPsDeleteParseTree (
343    ACPI_PARSE_OBJECT       *root);
344
345
346/*
347 * psutils - parser utilities
348 */
349ACPI_PARSE_OBJECT *
350AcpiPsCreateScopeOp (
351    void);
352
353void
354AcpiPsInitOp (
355    ACPI_PARSE_OBJECT       *op,
356    UINT16                  opcode);
357
358ACPI_PARSE_OBJECT *
359AcpiPsAllocOp (
360    UINT16                  opcode);
361
362void
363AcpiPsFreeOp (
364    ACPI_PARSE_OBJECT       *Op);
365
366BOOLEAN
367AcpiPsIsLeadingChar (
368    UINT32                  c);
369
370BOOLEAN
371AcpiPsIsPrefixChar (
372    UINT32                  c);
373
374UINT32
375AcpiPsGetName(
376    ACPI_PARSE_OBJECT       *op);
377
378void
379AcpiPsSetName(
380    ACPI_PARSE_OBJECT       *op,
381    UINT32                  name);
382
383
384/*
385 * psdump - display parser tree
386 */
387UINT32
388AcpiPsSprintPath (
389    char                    *BufferStart,
390    UINT32                  BufferSize,
391    ACPI_PARSE_OBJECT       *Op);
392
393UINT32
394AcpiPsSprintOp (
395    char                    *BufferStart,
396    UINT32                  BufferSize,
397    ACPI_PARSE_OBJECT       *Op);
398
399void
400AcpiPsShow (
401    ACPI_PARSE_OBJECT       *op);
402
403
404#endif /* __ACPARSER_H__ */
405