1 /******************************************************************************
3 * Module Name: acparser.h - AML Parser subcomponent prototypes and defines
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2015, 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.
44 #ifndef __ACPARSER_H__
45 #define __ACPARSER_H__
48 #define OP_HAS_RETURN_VALUE 1
50 /* Variable number of arguments. This field must be 32 bits */
52 #define ACPI_VAR_ARGS ACPI_UINT32_MAX
55 #define ACPI_PARSE_DELETE_TREE 0x0001
56 #define ACPI_PARSE_NO_TREE_DELETE 0x0000
57 #define ACPI_PARSE_TREE_MASK 0x0001
59 #define ACPI_PARSE_LOAD_PASS1 0x0010
60 #define ACPI_PARSE_LOAD_PASS2 0x0020
61 #define ACPI_PARSE_EXECUTE 0x0030
62 #define ACPI_PARSE_MODE_MASK 0x0030
64 #define ACPI_PARSE_DEFERRED_OP 0x0100
65 #define ACPI_PARSE_DISASSEMBLE 0x0200
67 #define ACPI_PARSE_MODULE_LEVEL 0x0400
69 /******************************************************************************
73 *****************************************************************************/
75 extern const UINT8 AcpiGbl_ShortOpIndex[];
76 extern const UINT8 AcpiGbl_LongOpIndex[];
80 * psxface - Parser external interfaces
84 ACPI_EVALUATE_INFO *Info);
88 * psargs - Parse AML opcode arguments
91 AcpiPsGetNextPackageEnd (
92 ACPI_PARSE_STATE *ParserState);
95 AcpiPsGetNextNamestring (
96 ACPI_PARSE_STATE *ParserState);
99 AcpiPsGetNextSimpleArg (
100 ACPI_PARSE_STATE *ParserState,
102 ACPI_PARSE_OBJECT *Arg);
105 AcpiPsGetNextNamepath (
106 ACPI_WALK_STATE *WalkState,
107 ACPI_PARSE_STATE *ParserState,
108 ACPI_PARSE_OBJECT *Arg,
113 ACPI_WALK_STATE *WalkState,
114 ACPI_PARSE_STATE *ParserState,
116 ACPI_PARSE_OBJECT **ReturnArg);
124 ACPI_PARSE_OBJECT *Scope,
130 ACPI_PARSE_OBJECT *Op);
134 * psobject - support for parse object processing
138 ACPI_WALK_STATE *WalkState,
140 ACPI_PARSE_OBJECT *UnnamedOp,
141 ACPI_PARSE_OBJECT **Op);
145 ACPI_WALK_STATE *WalkState,
147 ACPI_PARSE_OBJECT **NewOp);
151 ACPI_WALK_STATE *WalkState,
152 ACPI_PARSE_OBJECT **Op,
156 AcpiPsCompleteFinalOp (
157 ACPI_WALK_STATE *WalkState,
158 ACPI_PARSE_OBJECT *Op,
163 * psopinfo - AML Opcode information
165 const ACPI_OPCODE_INFO *
166 AcpiPsGetOpcodeInfo (
170 AcpiPsGetOpcodeName (
174 AcpiPsGetArgumentCount (
179 * psparse - top level parsing routines
183 ACPI_WALK_STATE *WalkState);
186 AcpiPsGetOpcodeSize (
191 ACPI_PARSE_STATE *state);
194 AcpiPsCompleteThisOp (
195 ACPI_WALK_STATE *WalkState,
196 ACPI_PARSE_OBJECT *Op);
199 AcpiPsNextParseState (
200 ACPI_WALK_STATE *WalkState,
201 ACPI_PARSE_OBJECT *Op,
202 ACPI_STATUS CallbackStatus);
206 * psloop - main parse loop
210 ACPI_WALK_STATE *WalkState);
214 * psscope - Scope stack management routines
218 ACPI_PARSE_STATE *ParserState,
219 ACPI_PARSE_OBJECT *Root);
222 AcpiPsGetParentScope (
223 ACPI_PARSE_STATE *state);
226 AcpiPsHasCompletedScope (
227 ACPI_PARSE_STATE *ParserState);
231 ACPI_PARSE_STATE *ParserState,
232 ACPI_PARSE_OBJECT **Op,
238 ACPI_PARSE_STATE *ParserState,
239 ACPI_PARSE_OBJECT *Op,
240 UINT32 RemainingArgs,
245 ACPI_PARSE_STATE *state);
249 * pstree - parse tree manipulation routines
253 ACPI_PARSE_OBJECT *op,
254 ACPI_PARSE_OBJECT *arg);
258 ACPI_PARSE_OBJECT *Scope,
265 ACPI_PARSE_OBJECT *op,
270 ACPI_PARSE_OBJECT *Origin,
271 ACPI_PARSE_OBJECT *Op);
275 * pswalk - parse tree walk routines
278 AcpiPsWalkParsedAml (
279 ACPI_PARSE_OBJECT *StartOp,
280 ACPI_PARSE_OBJECT *EndOp,
281 ACPI_OPERAND_OBJECT *MthDesc,
282 ACPI_NAMESPACE_NODE *StartNode,
283 ACPI_OPERAND_OBJECT **Params,
284 ACPI_OPERAND_OBJECT **CallerReturnDesc,
285 ACPI_OWNER_ID OwnerId,
286 ACPI_PARSE_DOWNWARDS DescendingCallback,
287 ACPI_PARSE_UPWARDS AscendingCallback);
290 AcpiPsGetNextWalkOp (
291 ACPI_WALK_STATE *WalkState,
292 ACPI_PARSE_OBJECT *Op,
293 ACPI_PARSE_UPWARDS AscendingCallback);
296 AcpiPsDeleteCompletedOp (
297 ACPI_WALK_STATE *WalkState);
300 AcpiPsDeleteParseTree (
301 ACPI_PARSE_OBJECT *root);
305 * psutils - parser utilities
308 AcpiPsCreateScopeOp (
313 ACPI_PARSE_OBJECT *op,
322 ACPI_PARSE_OBJECT *Op);
325 AcpiPsIsLeadingChar (
330 ACPI_PARSE_OBJECT *op);
334 ACPI_PARSE_OBJECT *op,
339 * psdump - display parser tree
345 ACPI_PARSE_OBJECT *Op);
351 ACPI_PARSE_OBJECT *Op);
355 ACPI_PARSE_OBJECT *op);
358 #endif /* __ACPARSER_H__ */