1 /******************************************************************************
3 * Module Name: acparser.h - AML Parser subcomponent prototypes and defines
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2003, 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 *****************************************************************************/
116 /* $DragonFly: src/sys/contrib/dev/acpica/Attic/acparser.h,v 1.1 2003/09/24 03:32:15 drhodus Exp $ */
119 #ifndef __ACPARSER_H__
120 #define __ACPARSER_H__
123 #define OP_HAS_RETURN_VALUE 1
125 /* variable # arguments */
127 #define ACPI_VAR_ARGS ACPI_UINT32_MAX
130 #define ACPI_PARSE_DELETE_TREE 0x0001
131 #define ACPI_PARSE_NO_TREE_DELETE 0x0000
132 #define ACPI_PARSE_TREE_MASK 0x0001
134 #define ACPI_PARSE_LOAD_PASS1 0x0010
135 #define ACPI_PARSE_LOAD_PASS2 0x0020
136 #define ACPI_PARSE_EXECUTE 0x0030
137 #define ACPI_PARSE_MODE_MASK 0x0030
139 #define ACPI_PARSE_DEFERRED_OP 0x0100
141 /* Parser external interfaces */
150 ACPI_NAMESPACE_NODE *MethodNode,
151 ACPI_OPERAND_OBJECT **Params,
152 ACPI_OPERAND_OBJECT **ReturnObjDesc);
155 /******************************************************************************
159 *****************************************************************************/
162 /* psargs - Parse AML opcode arguments */
165 AcpiPsGetNextPackageEnd (
166 ACPI_PARSE_STATE *ParserState);
169 AcpiPsGetNextPackageLength (
170 ACPI_PARSE_STATE *ParserState);
173 AcpiPsGetNextNamestring (
174 ACPI_PARSE_STATE *ParserState);
177 AcpiPsGetNextSimpleArg (
178 ACPI_PARSE_STATE *ParserState,
180 ACPI_PARSE_OBJECT *Arg);
183 AcpiPsGetNextNamepath (
184 ACPI_WALK_STATE *WalkState,
185 ACPI_PARSE_STATE *ParserState,
186 ACPI_PARSE_OBJECT *Arg,
191 ACPI_PARSE_STATE *ParserState);
195 ACPI_WALK_STATE *WalkState,
196 ACPI_PARSE_STATE *ParserState,
198 ACPI_PARSE_OBJECT **ReturnArg);
205 ACPI_PARSE_OBJECT *Scope,
211 ACPI_PARSE_OBJECT *Op);
214 /* psopcode - AML Opcode information */
216 const ACPI_OPCODE_INFO *
217 AcpiPsGetOpcodeInfo (
221 AcpiPsGetOpcodeName (
225 /* psparse - top level parsing routines */
228 AcpiPsGetOpcodeSize (
232 AcpiPsCompleteThisOp (
233 ACPI_WALK_STATE *WalkState,
234 ACPI_PARSE_OBJECT *Op);
237 AcpiPsNextParseState (
238 ACPI_WALK_STATE *WalkState,
239 ACPI_PARSE_OBJECT *Op,
240 ACPI_STATUS CallbackStatus);
244 ACPI_WALK_STATE *WalkState,
245 ACPI_PARSE_OBJECT **OutOp);
248 AcpiPsDeleteParseTree (
249 ACPI_PARSE_OBJECT *root);
253 ACPI_WALK_STATE *WalkState);
257 ACPI_WALK_STATE *WalkState);
263 ACPI_PARSE_DOWNWARDS DescendingCallback,
264 ACPI_PARSE_UPWARDS AscendingCallback,
265 ACPI_PARSE_OBJECT **RootObject);
269 ACPI_PARSE_STATE *state);
272 /* psscope - Scope stack management routines */
277 ACPI_PARSE_STATE *ParserState,
278 ACPI_PARSE_OBJECT *Root);
281 AcpiPsGetParentScope (
282 ACPI_PARSE_STATE *state);
285 AcpiPsHasCompletedScope (
286 ACPI_PARSE_STATE *ParserState);
290 ACPI_PARSE_STATE *ParserState,
291 ACPI_PARSE_OBJECT **Op,
297 ACPI_PARSE_STATE *ParserState,
298 ACPI_PARSE_OBJECT *Op,
299 UINT32 RemainingArgs,
304 ACPI_PARSE_STATE *state);
307 /* pstree - parse tree manipulation routines */
311 ACPI_PARSE_OBJECT *op,
312 ACPI_PARSE_OBJECT *arg);
316 ACPI_PARSE_OBJECT *Scope,
323 ACPI_PARSE_OBJECT *op,
328 ACPI_PARSE_OBJECT *op);
332 ACPI_PARSE_OBJECT *Origin,
333 ACPI_PARSE_OBJECT *Op);
336 /* pswalk - parse tree walk routines */
339 AcpiPsWalkParsedAml (
340 ACPI_PARSE_OBJECT *StartOp,
341 ACPI_PARSE_OBJECT *EndOp,
342 ACPI_OPERAND_OBJECT *MthDesc,
343 ACPI_NAMESPACE_NODE *StartNode,
344 ACPI_OPERAND_OBJECT **Params,
345 ACPI_OPERAND_OBJECT **CallerReturnDesc,
346 ACPI_OWNER_ID OwnerId,
347 ACPI_PARSE_DOWNWARDS DescendingCallback,
348 ACPI_PARSE_UPWARDS AscendingCallback);
351 AcpiPsGetNextWalkOp (
352 ACPI_WALK_STATE *WalkState,
353 ACPI_PARSE_OBJECT *Op,
354 ACPI_PARSE_UPWARDS AscendingCallback);
357 AcpiPsDeleteCompletedOp (
358 ACPI_WALK_STATE *WalkState);
361 /* psutils - parser utilities */
364 AcpiPsCreateScopeOp (
369 ACPI_PARSE_OBJECT *op,
378 ACPI_PARSE_OBJECT *Op);
381 AcpiPsDeleteParseCache (
385 AcpiPsIsLeadingChar (
394 ACPI_PARSE_OBJECT *op);
398 ACPI_PARSE_OBJECT *op,
402 /* psdump - display parser tree */
408 ACPI_PARSE_OBJECT *Op);
414 ACPI_PARSE_OBJECT *Op);
418 ACPI_PARSE_OBJECT *op);
421 #endif /* __ACPARSER_H__ */