psscope.c revision 1.1.1.2.4.2 1 1.1.1.2.4.2 rmind /******************************************************************************
2 1.1.1.2.4.2 rmind *
3 1.1.1.2.4.2 rmind * Module Name: psscope - Parser scope stack management routines
4 1.1.1.2.4.2 rmind *
5 1.1.1.2.4.2 rmind *****************************************************************************/
6 1.1.1.2.4.2 rmind
7 1.1.1.2.4.2 rmind /*
8 1.1.1.2.4.2 rmind * Copyright (C) 2000 - 2011, Intel Corp.
9 1.1.1.2.4.2 rmind * All rights reserved.
10 1.1.1.2.4.2 rmind *
11 1.1.1.2.4.2 rmind * Redistribution and use in source and binary forms, with or without
12 1.1.1.2.4.2 rmind * modification, are permitted provided that the following conditions
13 1.1.1.2.4.2 rmind * are met:
14 1.1.1.2.4.2 rmind * 1. Redistributions of source code must retain the above copyright
15 1.1.1.2.4.2 rmind * notice, this list of conditions, and the following disclaimer,
16 1.1.1.2.4.2 rmind * without modification.
17 1.1.1.2.4.2 rmind * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 1.1.1.2.4.2 rmind * substantially similar to the "NO WARRANTY" disclaimer below
19 1.1.1.2.4.2 rmind * ("Disclaimer") and any redistribution must be conditioned upon
20 1.1.1.2.4.2 rmind * including a substantially similar Disclaimer requirement for further
21 1.1.1.2.4.2 rmind * binary redistribution.
22 1.1.1.2.4.2 rmind * 3. Neither the names of the above-listed copyright holders nor the names
23 1.1.1.2.4.2 rmind * of any contributors may be used to endorse or promote products derived
24 1.1.1.2.4.2 rmind * from this software without specific prior written permission.
25 1.1.1.2.4.2 rmind *
26 1.1.1.2.4.2 rmind * Alternatively, this software may be distributed under the terms of the
27 1.1.1.2.4.2 rmind * GNU General Public License ("GPL") version 2 as published by the Free
28 1.1.1.2.4.2 rmind * Software Foundation.
29 1.1.1.2.4.2 rmind *
30 1.1.1.2.4.2 rmind * NO WARRANTY
31 1.1.1.2.4.2 rmind * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 1.1.1.2.4.2 rmind * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 1.1.1.2.4.2 rmind * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 1.1.1.2.4.2 rmind * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 1.1.1.2.4.2 rmind * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 1.1.1.2.4.2 rmind * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 1.1.1.2.4.2 rmind * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 1.1.1.2.4.2 rmind * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 1.1.1.2.4.2 rmind * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 1.1.1.2.4.2 rmind * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 1.1.1.2.4.2 rmind * POSSIBILITY OF SUCH DAMAGES.
42 1.1.1.2.4.2 rmind */
43 1.1.1.2.4.2 rmind
44 1.1.1.2.4.2 rmind
45 1.1.1.2.4.2 rmind #include "acpi.h"
46 1.1.1.2.4.2 rmind #include "accommon.h"
47 1.1.1.2.4.2 rmind #include "acparser.h"
48 1.1.1.2.4.2 rmind
49 1.1.1.2.4.2 rmind #define _COMPONENT ACPI_PARSER
50 1.1.1.2.4.2 rmind ACPI_MODULE_NAME ("psscope")
51 1.1.1.2.4.2 rmind
52 1.1.1.2.4.2 rmind
53 1.1.1.2.4.2 rmind /*******************************************************************************
54 1.1.1.2.4.2 rmind *
55 1.1.1.2.4.2 rmind * FUNCTION: AcpiPsGetParentScope
56 1.1.1.2.4.2 rmind *
57 1.1.1.2.4.2 rmind * PARAMETERS: ParserState - Current parser state object
58 1.1.1.2.4.2 rmind *
59 1.1.1.2.4.2 rmind * RETURN: Pointer to an Op object
60 1.1.1.2.4.2 rmind *
61 1.1.1.2.4.2 rmind * DESCRIPTION: Get parent of current op being parsed
62 1.1.1.2.4.2 rmind *
63 1.1.1.2.4.2 rmind ******************************************************************************/
64 1.1.1.2.4.2 rmind
65 1.1.1.2.4.2 rmind ACPI_PARSE_OBJECT *
66 1.1.1.2.4.2 rmind AcpiPsGetParentScope (
67 1.1.1.2.4.2 rmind ACPI_PARSE_STATE *ParserState)
68 1.1.1.2.4.2 rmind {
69 1.1.1.2.4.2 rmind
70 1.1.1.2.4.2 rmind return (ParserState->Scope->ParseScope.Op);
71 1.1.1.2.4.2 rmind }
72 1.1.1.2.4.2 rmind
73 1.1.1.2.4.2 rmind
74 1.1.1.2.4.2 rmind /*******************************************************************************
75 1.1.1.2.4.2 rmind *
76 1.1.1.2.4.2 rmind * FUNCTION: AcpiPsHasCompletedScope
77 1.1.1.2.4.2 rmind *
78 1.1.1.2.4.2 rmind * PARAMETERS: ParserState - Current parser state object
79 1.1.1.2.4.2 rmind *
80 1.1.1.2.4.2 rmind * RETURN: Boolean, TRUE = scope completed.
81 1.1.1.2.4.2 rmind *
82 1.1.1.2.4.2 rmind * DESCRIPTION: Is parsing of current argument complete? Determined by
83 1.1.1.2.4.2 rmind * 1) AML pointer is at or beyond the end of the scope
84 1.1.1.2.4.2 rmind * 2) The scope argument count has reached zero.
85 1.1.1.2.4.2 rmind *
86 1.1.1.2.4.2 rmind ******************************************************************************/
87 1.1.1.2.4.2 rmind
88 1.1.1.2.4.2 rmind BOOLEAN
89 1.1.1.2.4.2 rmind AcpiPsHasCompletedScope (
90 1.1.1.2.4.2 rmind ACPI_PARSE_STATE *ParserState)
91 1.1.1.2.4.2 rmind {
92 1.1.1.2.4.2 rmind
93 1.1.1.2.4.2 rmind return ((BOOLEAN)
94 1.1.1.2.4.2 rmind ((ParserState->Aml >= ParserState->Scope->ParseScope.ArgEnd ||
95 1.1.1.2.4.2 rmind !ParserState->Scope->ParseScope.ArgCount)));
96 1.1.1.2.4.2 rmind }
97 1.1.1.2.4.2 rmind
98 1.1.1.2.4.2 rmind
99 1.1.1.2.4.2 rmind /*******************************************************************************
100 1.1.1.2.4.2 rmind *
101 1.1.1.2.4.2 rmind * FUNCTION: AcpiPsInitScope
102 1.1.1.2.4.2 rmind *
103 1.1.1.2.4.2 rmind * PARAMETERS: ParserState - Current parser state object
104 1.1.1.2.4.2 rmind * Root - the Root Node of this new scope
105 1.1.1.2.4.2 rmind *
106 1.1.1.2.4.2 rmind * RETURN: Status
107 1.1.1.2.4.2 rmind *
108 1.1.1.2.4.2 rmind * DESCRIPTION: Allocate and init a new scope object
109 1.1.1.2.4.2 rmind *
110 1.1.1.2.4.2 rmind ******************************************************************************/
111 1.1.1.2.4.2 rmind
112 1.1.1.2.4.2 rmind ACPI_STATUS
113 1.1.1.2.4.2 rmind AcpiPsInitScope (
114 1.1.1.2.4.2 rmind ACPI_PARSE_STATE *ParserState,
115 1.1.1.2.4.2 rmind ACPI_PARSE_OBJECT *RootOp)
116 1.1.1.2.4.2 rmind {
117 1.1.1.2.4.2 rmind ACPI_GENERIC_STATE *Scope;
118 1.1.1.2.4.2 rmind
119 1.1.1.2.4.2 rmind
120 1.1.1.2.4.2 rmind ACPI_FUNCTION_TRACE_PTR (PsInitScope, RootOp);
121 1.1.1.2.4.2 rmind
122 1.1.1.2.4.2 rmind
123 1.1.1.2.4.2 rmind Scope = AcpiUtCreateGenericState ();
124 1.1.1.2.4.2 rmind if (!Scope)
125 1.1.1.2.4.2 rmind {
126 1.1.1.2.4.2 rmind return_ACPI_STATUS (AE_NO_MEMORY);
127 1.1.1.2.4.2 rmind }
128 1.1.1.2.4.2 rmind
129 1.1.1.2.4.2 rmind Scope->Common.DescriptorType = ACPI_DESC_TYPE_STATE_RPSCOPE;
130 1.1.1.2.4.2 rmind Scope->ParseScope.Op = RootOp;
131 1.1.1.2.4.2 rmind Scope->ParseScope.ArgCount = ACPI_VAR_ARGS;
132 1.1.1.2.4.2 rmind Scope->ParseScope.ArgEnd = ParserState->AmlEnd;
133 1.1.1.2.4.2 rmind Scope->ParseScope.PkgEnd = ParserState->AmlEnd;
134 1.1.1.2.4.2 rmind
135 1.1.1.2.4.2 rmind ParserState->Scope = Scope;
136 1.1.1.2.4.2 rmind ParserState->StartOp = RootOp;
137 1.1.1.2.4.2 rmind
138 1.1.1.2.4.2 rmind return_ACPI_STATUS (AE_OK);
139 1.1.1.2.4.2 rmind }
140 1.1.1.2.4.2 rmind
141 1.1.1.2.4.2 rmind
142 1.1.1.2.4.2 rmind /*******************************************************************************
143 1.1.1.2.4.2 rmind *
144 1.1.1.2.4.2 rmind * FUNCTION: AcpiPsPushScope
145 1.1.1.2.4.2 rmind *
146 1.1.1.2.4.2 rmind * PARAMETERS: ParserState - Current parser state object
147 1.1.1.2.4.2 rmind * Op - Current op to be pushed
148 1.1.1.2.4.2 rmind * RemainingArgs - List of args remaining
149 1.1.1.2.4.2 rmind * ArgCount - Fixed or variable number of args
150 1.1.1.2.4.2 rmind *
151 1.1.1.2.4.2 rmind * RETURN: Status
152 1.1.1.2.4.2 rmind *
153 1.1.1.2.4.2 rmind * DESCRIPTION: Push current op to begin parsing its argument
154 1.1.1.2.4.2 rmind *
155 1.1.1.2.4.2 rmind ******************************************************************************/
156 1.1.1.2.4.2 rmind
157 1.1.1.2.4.2 rmind ACPI_STATUS
158 1.1.1.2.4.2 rmind AcpiPsPushScope (
159 1.1.1.2.4.2 rmind ACPI_PARSE_STATE *ParserState,
160 1.1.1.2.4.2 rmind ACPI_PARSE_OBJECT *Op,
161 1.1.1.2.4.2 rmind UINT32 RemainingArgs,
162 1.1.1.2.4.2 rmind UINT32 ArgCount)
163 1.1.1.2.4.2 rmind {
164 1.1.1.2.4.2 rmind ACPI_GENERIC_STATE *Scope;
165 1.1.1.2.4.2 rmind
166 1.1.1.2.4.2 rmind
167 1.1.1.2.4.2 rmind ACPI_FUNCTION_TRACE_PTR (PsPushScope, Op);
168 1.1.1.2.4.2 rmind
169 1.1.1.2.4.2 rmind
170 1.1.1.2.4.2 rmind Scope = AcpiUtCreateGenericState ();
171 1.1.1.2.4.2 rmind if (!Scope)
172 1.1.1.2.4.2 rmind {
173 1.1.1.2.4.2 rmind return_ACPI_STATUS (AE_NO_MEMORY);
174 1.1.1.2.4.2 rmind }
175 1.1.1.2.4.2 rmind
176 1.1.1.2.4.2 rmind Scope->Common.DescriptorType = ACPI_DESC_TYPE_STATE_PSCOPE;
177 1.1.1.2.4.2 rmind Scope->ParseScope.Op = Op;
178 1.1.1.2.4.2 rmind Scope->ParseScope.ArgList = RemainingArgs;
179 1.1.1.2.4.2 rmind Scope->ParseScope.ArgCount = ArgCount;
180 1.1.1.2.4.2 rmind Scope->ParseScope.PkgEnd = ParserState->PkgEnd;
181 1.1.1.2.4.2 rmind
182 1.1.1.2.4.2 rmind /* Push onto scope stack */
183 1.1.1.2.4.2 rmind
184 1.1.1.2.4.2 rmind AcpiUtPushGenericState (&ParserState->Scope, Scope);
185 1.1.1.2.4.2 rmind
186 1.1.1.2.4.2 rmind if (ArgCount == ACPI_VAR_ARGS)
187 1.1.1.2.4.2 rmind {
188 1.1.1.2.4.2 rmind /* Multiple arguments */
189 1.1.1.2.4.2 rmind
190 1.1.1.2.4.2 rmind Scope->ParseScope.ArgEnd = ParserState->PkgEnd;
191 1.1.1.2.4.2 rmind }
192 1.1.1.2.4.2 rmind else
193 1.1.1.2.4.2 rmind {
194 1.1.1.2.4.2 rmind /* Single argument */
195 1.1.1.2.4.2 rmind
196 1.1.1.2.4.2 rmind Scope->ParseScope.ArgEnd = ACPI_TO_POINTER (ACPI_MAX_PTR);
197 1.1.1.2.4.2 rmind }
198 1.1.1.2.4.2 rmind
199 1.1.1.2.4.2 rmind return_ACPI_STATUS (AE_OK);
200 1.1.1.2.4.2 rmind }
201 1.1.1.2.4.2 rmind
202 1.1.1.2.4.2 rmind
203 1.1.1.2.4.2 rmind /*******************************************************************************
204 1.1.1.2.4.2 rmind *
205 1.1.1.2.4.2 rmind * FUNCTION: AcpiPsPopScope
206 1.1.1.2.4.2 rmind *
207 1.1.1.2.4.2 rmind * PARAMETERS: ParserState - Current parser state object
208 1.1.1.2.4.2 rmind * Op - Where the popped op is returned
209 1.1.1.2.4.2 rmind * ArgList - Where the popped "next argument" is
210 1.1.1.2.4.2 rmind * returned
211 1.1.1.2.4.2 rmind * ArgCount - Count of objects in ArgList
212 1.1.1.2.4.2 rmind *
213 1.1.1.2.4.2 rmind * RETURN: Status
214 1.1.1.2.4.2 rmind *
215 1.1.1.2.4.2 rmind * DESCRIPTION: Return to parsing a previous op
216 1.1.1.2.4.2 rmind *
217 1.1.1.2.4.2 rmind ******************************************************************************/
218 1.1.1.2.4.2 rmind
219 1.1.1.2.4.2 rmind void
220 1.1.1.2.4.2 rmind AcpiPsPopScope (
221 1.1.1.2.4.2 rmind ACPI_PARSE_STATE *ParserState,
222 1.1.1.2.4.2 rmind ACPI_PARSE_OBJECT **Op,
223 1.1.1.2.4.2 rmind UINT32 *ArgList,
224 1.1.1.2.4.2 rmind UINT32 *ArgCount)
225 1.1.1.2.4.2 rmind {
226 1.1.1.2.4.2 rmind ACPI_GENERIC_STATE *Scope = ParserState->Scope;
227 1.1.1.2.4.2 rmind
228 1.1.1.2.4.2 rmind
229 1.1.1.2.4.2 rmind ACPI_FUNCTION_TRACE (PsPopScope);
230 1.1.1.2.4.2 rmind
231 1.1.1.2.4.2 rmind
232 1.1.1.2.4.2 rmind /* Only pop the scope if there is in fact a next scope */
233 1.1.1.2.4.2 rmind
234 1.1.1.2.4.2 rmind if (Scope->Common.Next)
235 1.1.1.2.4.2 rmind {
236 1.1.1.2.4.2 rmind Scope = AcpiUtPopGenericState (&ParserState->Scope);
237 1.1.1.2.4.2 rmind
238 1.1.1.2.4.2 rmind /* Return to parsing previous op */
239 1.1.1.2.4.2 rmind
240 1.1.1.2.4.2 rmind *Op = Scope->ParseScope.Op;
241 1.1.1.2.4.2 rmind *ArgList = Scope->ParseScope.ArgList;
242 1.1.1.2.4.2 rmind *ArgCount = Scope->ParseScope.ArgCount;
243 1.1.1.2.4.2 rmind ParserState->PkgEnd = Scope->ParseScope.PkgEnd;
244 1.1.1.2.4.2 rmind
245 1.1.1.2.4.2 rmind /* All done with this scope state structure */
246 1.1.1.2.4.2 rmind
247 1.1.1.2.4.2 rmind AcpiUtDeleteGenericState (Scope);
248 1.1.1.2.4.2 rmind }
249 1.1.1.2.4.2 rmind else
250 1.1.1.2.4.2 rmind {
251 1.1.1.2.4.2 rmind /* Empty parse stack, prepare to fetch next opcode */
252 1.1.1.2.4.2 rmind
253 1.1.1.2.4.2 rmind *Op = NULL;
254 1.1.1.2.4.2 rmind *ArgList = 0;
255 1.1.1.2.4.2 rmind *ArgCount = 0;
256 1.1.1.2.4.2 rmind }
257 1.1.1.2.4.2 rmind
258 1.1.1.2.4.2 rmind ACPI_DEBUG_PRINT ((ACPI_DB_PARSE,
259 1.1.1.2.4.2 rmind "Popped Op %p Args %X\n", *Op, *ArgCount));
260 1.1.1.2.4.2 rmind return_VOID;
261 1.1.1.2.4.2 rmind }
262 1.1.1.2.4.2 rmind
263 1.1.1.2.4.2 rmind
264 1.1.1.2.4.2 rmind /*******************************************************************************
265 1.1.1.2.4.2 rmind *
266 1.1.1.2.4.2 rmind * FUNCTION: AcpiPsCleanupScope
267 1.1.1.2.4.2 rmind *
268 1.1.1.2.4.2 rmind * PARAMETERS: ParserState - Current parser state object
269 1.1.1.2.4.2 rmind *
270 1.1.1.2.4.2 rmind * RETURN: None
271 1.1.1.2.4.2 rmind *
272 1.1.1.2.4.2 rmind * DESCRIPTION: Destroy available list, remaining stack levels, and return
273 1.1.1.2.4.2 rmind * root scope
274 1.1.1.2.4.2 rmind *
275 1.1.1.2.4.2 rmind ******************************************************************************/
276 1.1.1.2.4.2 rmind
277 1.1.1.2.4.2 rmind void
278 1.1.1.2.4.2 rmind AcpiPsCleanupScope (
279 1.1.1.2.4.2 rmind ACPI_PARSE_STATE *ParserState)
280 1.1.1.2.4.2 rmind {
281 1.1.1.2.4.2 rmind ACPI_GENERIC_STATE *Scope;
282 1.1.1.2.4.2 rmind
283 1.1.1.2.4.2 rmind
284 1.1.1.2.4.2 rmind ACPI_FUNCTION_TRACE_PTR (PsCleanupScope, ParserState);
285 1.1.1.2.4.2 rmind
286 1.1.1.2.4.2 rmind
287 1.1.1.2.4.2 rmind if (!ParserState)
288 1.1.1.2.4.2 rmind {
289 1.1.1.2.4.2 rmind return_VOID;
290 1.1.1.2.4.2 rmind }
291 1.1.1.2.4.2 rmind
292 1.1.1.2.4.2 rmind /* Delete anything on the scope stack */
293 1.1.1.2.4.2 rmind
294 1.1.1.2.4.2 rmind while (ParserState->Scope)
295 1.1.1.2.4.2 rmind {
296 1.1.1.2.4.2 rmind Scope = AcpiUtPopGenericState (&ParserState->Scope);
297 1.1.1.2.4.2 rmind AcpiUtDeleteGenericState (Scope);
298 1.1.1.2.4.2 rmind }
299 1.1.1.2.4.2 rmind
300 1.1.1.2.4.2 rmind return_VOID;
301 1.1.1.2.4.2 rmind }
302 1.1.1.2.4.2 rmind
303