1 /******************************************************************************
3 * Module Name: acparser.h - AML Parser subcomponent prototypes and defines
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2011, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
45 #ifndef __ACPARSER_H__
46 #define __ACPARSER_H__
49 #define OP_HAS_RETURN_VALUE 1
51 /* Variable number of arguments. This field must be 32 bits */
53 #define ACPI_VAR_ARGS ACPI_UINT32_MAX
56 #define ACPI_PARSE_DELETE_TREE 0x0001
57 #define ACPI_PARSE_NO_TREE_DELETE 0x0000
58 #define ACPI_PARSE_TREE_MASK 0x0001
60 #define ACPI_PARSE_LOAD_PASS1 0x0010
61 #define ACPI_PARSE_LOAD_PASS2 0x0020
62 #define ACPI_PARSE_EXECUTE 0x0030
63 #define ACPI_PARSE_MODE_MASK 0x0030
65 #define ACPI_PARSE_DEFERRED_OP 0x0100
66 #define ACPI_PARSE_DISASSEMBLE 0x0200
68 #define ACPI_PARSE_MODULE_LEVEL 0x0400
70 /******************************************************************************
74 *****************************************************************************/
78 * psxface - Parser external interfaces
82 ACPI_EVALUATE_INFO *Info);
86 * psargs - Parse AML opcode arguments
89 AcpiPsGetNextPackageEnd (
90 ACPI_PARSE_STATE *ParserState);
93 AcpiPsGetNextNamestring (
94 ACPI_PARSE_STATE *ParserState);
97 AcpiPsGetNextSimpleArg (
98 ACPI_PARSE_STATE *ParserState,
100 ACPI_PARSE_OBJECT *Arg);
103 AcpiPsGetNextNamepath (
104 ACPI_WALK_STATE *WalkState,
105 ACPI_PARSE_STATE *ParserState,
106 ACPI_PARSE_OBJECT *Arg,
111 ACPI_WALK_STATE *WalkState,
112 ACPI_PARSE_STATE *ParserState,
114 ACPI_PARSE_OBJECT **ReturnArg);
122 ACPI_PARSE_OBJECT *Scope,
128 ACPI_PARSE_OBJECT *Op);
132 * psopcode - AML Opcode information
134 const ACPI_OPCODE_INFO *
135 AcpiPsGetOpcodeInfo (
139 AcpiPsGetOpcodeName (
143 AcpiPsGetArgumentCount (
148 * psparse - top level parsing routines
152 ACPI_WALK_STATE *WalkState);
155 AcpiPsGetOpcodeSize (
160 ACPI_PARSE_STATE *state);
163 AcpiPsCompleteThisOp (
164 ACPI_WALK_STATE *WalkState,
165 ACPI_PARSE_OBJECT *Op);
168 AcpiPsNextParseState (
169 ACPI_WALK_STATE *WalkState,
170 ACPI_PARSE_OBJECT *Op,
171 ACPI_STATUS CallbackStatus);
175 * psloop - main parse loop
179 ACPI_WALK_STATE *WalkState);
183 * psscope - Scope stack management routines
187 ACPI_PARSE_STATE *ParserState,
188 ACPI_PARSE_OBJECT *Root);
191 AcpiPsGetParentScope (
192 ACPI_PARSE_STATE *state);
195 AcpiPsHasCompletedScope (
196 ACPI_PARSE_STATE *ParserState);
200 ACPI_PARSE_STATE *ParserState,
201 ACPI_PARSE_OBJECT **Op,
207 ACPI_PARSE_STATE *ParserState,
208 ACPI_PARSE_OBJECT *Op,
209 UINT32 RemainingArgs,
214 ACPI_PARSE_STATE *state);
218 * pstree - parse tree manipulation routines
222 ACPI_PARSE_OBJECT *op,
223 ACPI_PARSE_OBJECT *arg);
227 ACPI_PARSE_OBJECT *Scope,
234 ACPI_PARSE_OBJECT *op,
239 ACPI_PARSE_OBJECT *Origin,
240 ACPI_PARSE_OBJECT *Op);
244 * pswalk - parse tree walk routines
247 AcpiPsWalkParsedAml (
248 ACPI_PARSE_OBJECT *StartOp,
249 ACPI_PARSE_OBJECT *EndOp,
250 ACPI_OPERAND_OBJECT *MthDesc,
251 ACPI_NAMESPACE_NODE *StartNode,
252 ACPI_OPERAND_OBJECT **Params,
253 ACPI_OPERAND_OBJECT **CallerReturnDesc,
254 ACPI_OWNER_ID OwnerId,
255 ACPI_PARSE_DOWNWARDS DescendingCallback,
256 ACPI_PARSE_UPWARDS AscendingCallback);
259 AcpiPsGetNextWalkOp (
260 ACPI_WALK_STATE *WalkState,
261 ACPI_PARSE_OBJECT *Op,
262 ACPI_PARSE_UPWARDS AscendingCallback);
265 AcpiPsDeleteCompletedOp (
266 ACPI_WALK_STATE *WalkState);
269 AcpiPsDeleteParseTree (
270 ACPI_PARSE_OBJECT *root);
274 * psutils - parser utilities
277 AcpiPsCreateScopeOp (
282 ACPI_PARSE_OBJECT *op,
291 ACPI_PARSE_OBJECT *Op);
294 AcpiPsIsLeadingChar (
303 ACPI_PARSE_OBJECT *op);
307 ACPI_PARSE_OBJECT *op,
312 * psdump - display parser tree
318 ACPI_PARSE_OBJECT *Op);
324 ACPI_PARSE_OBJECT *Op);
328 ACPI_PARSE_OBJECT *op);
331 #endif /* __ACPARSER_H__ */