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