1 /******************************************************************************
3 * Module Name: acparser.h - AML Parser subcomponent prototypes and defines
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999, 2000, Intel Corp.
13 * All rights reserved.
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
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
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;
38 * The above copyright and patent license is granted only if the following
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.
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
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
73 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
81 * 4. Disclaimer and Export Compliance
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
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
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.
115 *****************************************************************************/
118 #ifndef __ACPARSER_H__
119 #define __ACPARSER_H__
122 #define OP_HAS_RETURN_VALUE 1
124 /* variable # arguments */
126 #define ACPI_VAR_ARGS ACPI_UINT32_MAX
128 /* maximum virtual address */
130 #define ACPI_MAX_AML ((UINT8 *)(~0UL))
133 #define ACPI_PARSE_DELETE_TREE 0x0001
134 #define ACPI_PARSE_NO_TREE_DELETE 0x0000
135 #define ACPI_PARSE_TREE_MASK 0x0001
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
142 /* psapi - Parser external interfaces */
151 ACPI_NAMESPACE_NODE *MethodNode,
152 ACPI_OPERAND_OBJECT **Params,
153 ACPI_OPERAND_OBJECT **ReturnObjDesc);
157 AcpiPsIsNamespaceObjectOp (
160 AcpiPsIsNamespaceOp (
164 /******************************************************************************
168 *****************************************************************************/
171 /* psargs - Parse AML opcode arguments */
174 AcpiPsGetNextPackageEnd (
175 ACPI_PARSE_STATE *ParserState);
178 AcpiPsGetNextPackageLength (
179 ACPI_PARSE_STATE *ParserState);
182 AcpiPsGetNextNamestring (
183 ACPI_PARSE_STATE *ParserState);
186 AcpiPsGetNextSimpleArg (
187 ACPI_PARSE_STATE *ParserState,
188 UINT32 ArgType, /* type of argument */
189 ACPI_PARSE_OBJECT *Arg); /* (OUT) argument data */
192 AcpiPsGetNextNamepath (
193 ACPI_PARSE_STATE *ParserState,
194 ACPI_PARSE_OBJECT *Arg,
200 ACPI_PARSE_STATE *ParserState);
204 ACPI_PARSE_STATE *ParserState,
209 /* psopcode - AML Opcode information */
212 AcpiPsGetOpcodeInfo (
216 AcpiPsGetOpcodeName (
220 /* psparse - top level parsing routines */
225 ACPI_PARSE_OBJECT *Op,
226 ACPI_WALK_STATE *WalkState,
227 ACPI_PARSE_OBJECT **OutOp);
230 AcpiPsDeleteParseTree (
231 ACPI_PARSE_OBJECT *root);
235 ACPI_WALK_STATE *WalkState);
239 ACPI_PARSE_OBJECT *StartScope,
243 ACPI_NAMESPACE_NODE *MethodNode,
244 ACPI_OPERAND_OBJECT **Params,
245 ACPI_OPERAND_OBJECT **CallerReturnDesc,
246 ACPI_PARSE_DOWNWARDS DescendingCallback,
247 ACPI_PARSE_UPWARDS AscendingCallback);
253 ACPI_PARSE_DOWNWARDS DescendingCallback,
254 ACPI_PARSE_UPWARDS AscendingCallback,
255 ACPI_PARSE_OBJECT **RootObject);
259 ACPI_PARSE_STATE *state);
262 /* psscope - Scope stack management routines */
267 ACPI_PARSE_STATE *ParserState,
268 ACPI_PARSE_OBJECT *Root);
271 AcpiPsGetParentScope (
272 ACPI_PARSE_STATE *state);
275 AcpiPsHasCompletedScope (
276 ACPI_PARSE_STATE *ParserState);
280 ACPI_PARSE_STATE *ParserState,
281 ACPI_PARSE_OBJECT **Op,
287 ACPI_PARSE_STATE *ParserState,
288 ACPI_PARSE_OBJECT *Op,
289 UINT32 RemainingArgs,
294 ACPI_PARSE_STATE *state);
297 /* pstree - parse tree manipulation routines */
301 ACPI_PARSE_OBJECT *op,
302 ACPI_PARSE_OBJECT *arg);
306 ACPI_PARSE_OBJECT *Scope,
313 ACPI_PARSE_OBJECT *op,
318 ACPI_PARSE_OBJECT *op);
322 ACPI_PARSE_OBJECT *Origin,
323 ACPI_PARSE_OBJECT *Op);
326 /* pswalk - parse tree walk routines */
329 AcpiPsWalkParsedAml (
330 ACPI_PARSE_OBJECT *StartOp,
331 ACPI_PARSE_OBJECT *EndOp,
332 ACPI_OPERAND_OBJECT *MthDesc,
333 ACPI_NAMESPACE_NODE *StartNode,
334 ACPI_OPERAND_OBJECT **Params,
335 ACPI_OPERAND_OBJECT **CallerReturnDesc,
336 ACPI_OWNER_ID OwnerId,
337 ACPI_PARSE_DOWNWARDS DescendingCallback,
338 ACPI_PARSE_UPWARDS AscendingCallback);
341 AcpiPsGetNextWalkOp (
342 ACPI_WALK_STATE *WalkState,
343 ACPI_PARSE_OBJECT *Op,
344 ACPI_PARSE_UPWARDS AscendingCallback);
347 /* psutils - parser utilities */
357 ACPI_PARSE_OBJECT *op,
366 ACPI_PARSE_OBJECT *Op);
369 AcpiPsDeleteParseCache (
373 AcpiPsIsLeadingChar (
401 AcpiPsIsCreateFieldOp (
406 ACPI_PARSE_OBJECT *op);
410 ACPI_PARSE_OBJECT *op);
414 ACPI_PARSE_OBJECT *op,
418 /* psdump - display parser tree */
422 NATIVE_CHAR *BufferStart,
424 ACPI_PARSE_OBJECT *Op);
428 NATIVE_CHAR *BufferStart,
430 ACPI_PARSE_OBJECT *Op);
434 ACPI_PARSE_OBJECT *op);
437 #endif /* __ACPARSER_H__ */