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