xref: /freebsd-src/sys/contrib/dev/acpica/components/parser/psparse.c (revision 804fe2660352e090f4481f2c1d646b508859e79a)
1a159c266SJung-uk Kim /******************************************************************************
2a159c266SJung-uk Kim  *
3a159c266SJung-uk Kim  * Module Name: psparse - Parser top level AML parse routines
4a159c266SJung-uk Kim  *
5a159c266SJung-uk Kim  *****************************************************************************/
6a159c266SJung-uk Kim 
70d84335fSJung-uk Kim /******************************************************************************
80d84335fSJung-uk Kim  *
90d84335fSJung-uk Kim  * 1. Copyright Notice
100d84335fSJung-uk Kim  *
11*804fe266SJung-uk Kim  * Some or all of this work - Copyright (c) 1999 - 2024, Intel Corp.
12a159c266SJung-uk Kim  * All rights reserved.
13a159c266SJung-uk Kim  *
140d84335fSJung-uk Kim  * 2. License
150d84335fSJung-uk Kim  *
160d84335fSJung-uk Kim  * 2.1. This is your license from Intel Corp. under its intellectual property
170d84335fSJung-uk Kim  * rights. You may have additional license terms from the party that provided
180d84335fSJung-uk Kim  * you this software, covering your right to use that party's intellectual
190d84335fSJung-uk Kim  * property rights.
200d84335fSJung-uk Kim  *
210d84335fSJung-uk Kim  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
220d84335fSJung-uk Kim  * copy of the source code appearing in this file ("Covered Code") an
230d84335fSJung-uk Kim  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
240d84335fSJung-uk Kim  * base code distributed originally by Intel ("Original Intel Code") to copy,
250d84335fSJung-uk Kim  * make derivatives, distribute, use and display any portion of the Covered
260d84335fSJung-uk Kim  * Code in any form, with the right to sublicense such rights; and
270d84335fSJung-uk Kim  *
280d84335fSJung-uk Kim  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
290d84335fSJung-uk Kim  * license (with the right to sublicense), under only those claims of Intel
300d84335fSJung-uk Kim  * patents that are infringed by the Original Intel Code, to make, use, sell,
310d84335fSJung-uk Kim  * offer to sell, and import the Covered Code and derivative works thereof
320d84335fSJung-uk Kim  * solely to the minimum extent necessary to exercise the above copyright
330d84335fSJung-uk Kim  * license, and in no event shall the patent license extend to any additions
340d84335fSJung-uk Kim  * to or modifications of the Original Intel Code. No other license or right
350d84335fSJung-uk Kim  * is granted directly or by implication, estoppel or otherwise;
360d84335fSJung-uk Kim  *
370d84335fSJung-uk Kim  * The above copyright and patent license is granted only if the following
380d84335fSJung-uk Kim  * conditions are met:
390d84335fSJung-uk Kim  *
400d84335fSJung-uk Kim  * 3. Conditions
410d84335fSJung-uk Kim  *
420d84335fSJung-uk Kim  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
430d84335fSJung-uk Kim  * Redistribution of source code of any substantial portion of the Covered
440d84335fSJung-uk Kim  * Code or modification with rights to further distribute source must include
450d84335fSJung-uk Kim  * the above Copyright Notice, the above License, this list of Conditions,
460d84335fSJung-uk Kim  * and the following Disclaimer and Export Compliance provision. In addition,
470d84335fSJung-uk Kim  * Licensee must cause all Covered Code to which Licensee contributes to
480d84335fSJung-uk Kim  * contain a file documenting the changes Licensee made to create that Covered
490d84335fSJung-uk Kim  * Code and the date of any change. Licensee must include in that file the
500d84335fSJung-uk Kim  * documentation of any changes made by any predecessor Licensee. Licensee
510d84335fSJung-uk Kim  * must include a prominent statement that the modification is derived,
520d84335fSJung-uk Kim  * directly or indirectly, from Original Intel Code.
530d84335fSJung-uk Kim  *
540d84335fSJung-uk Kim  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
550d84335fSJung-uk Kim  * Redistribution of source code of any substantial portion of the Covered
560d84335fSJung-uk Kim  * Code or modification without rights to further distribute source must
570d84335fSJung-uk Kim  * include the following Disclaimer and Export Compliance provision in the
580d84335fSJung-uk Kim  * documentation and/or other materials provided with distribution. In
590d84335fSJung-uk Kim  * addition, Licensee may not authorize further sublicense of source of any
600d84335fSJung-uk Kim  * portion of the Covered Code, and must include terms to the effect that the
610d84335fSJung-uk Kim  * license from Licensee to its licensee is limited to the intellectual
620d84335fSJung-uk Kim  * property embodied in the software Licensee provides to its licensee, and
630d84335fSJung-uk Kim  * not to intellectual property embodied in modifications its licensee may
640d84335fSJung-uk Kim  * make.
650d84335fSJung-uk Kim  *
660d84335fSJung-uk Kim  * 3.3. Redistribution of Executable. Redistribution in executable form of any
670d84335fSJung-uk Kim  * substantial portion of the Covered Code or modification must reproduce the
680d84335fSJung-uk Kim  * above Copyright Notice, and the following Disclaimer and Export Compliance
690d84335fSJung-uk Kim  * provision in the documentation and/or other materials provided with the
700d84335fSJung-uk Kim  * distribution.
710d84335fSJung-uk Kim  *
720d84335fSJung-uk Kim  * 3.4. Intel retains all right, title, and interest in and to the Original
730d84335fSJung-uk Kim  * Intel Code.
740d84335fSJung-uk Kim  *
750d84335fSJung-uk Kim  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
760d84335fSJung-uk Kim  * Intel shall be used in advertising or otherwise to promote the sale, use or
770d84335fSJung-uk Kim  * other dealings in products derived from or relating to the Covered Code
780d84335fSJung-uk Kim  * without prior written authorization from Intel.
790d84335fSJung-uk Kim  *
800d84335fSJung-uk Kim  * 4. Disclaimer and Export Compliance
810d84335fSJung-uk Kim  *
820d84335fSJung-uk Kim  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
830d84335fSJung-uk Kim  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
840d84335fSJung-uk Kim  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
850d84335fSJung-uk Kim  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
860d84335fSJung-uk Kim  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
870d84335fSJung-uk Kim  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
880d84335fSJung-uk Kim  * PARTICULAR PURPOSE.
890d84335fSJung-uk Kim  *
900d84335fSJung-uk Kim  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
910d84335fSJung-uk Kim  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
920d84335fSJung-uk Kim  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
930d84335fSJung-uk Kim  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
940d84335fSJung-uk Kim  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
950d84335fSJung-uk Kim  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
960d84335fSJung-uk Kim  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
970d84335fSJung-uk Kim  * LIMITED REMEDY.
980d84335fSJung-uk Kim  *
990d84335fSJung-uk Kim  * 4.3. Licensee shall not export, either directly or indirectly, any of this
1000d84335fSJung-uk Kim  * software or system incorporating such software without first obtaining any
1010d84335fSJung-uk Kim  * required license or other approval from the U. S. Department of Commerce or
1020d84335fSJung-uk Kim  * any other agency or department of the United States Government. In the
1030d84335fSJung-uk Kim  * event Licensee exports any such software from the United States or
1040d84335fSJung-uk Kim  * re-exports any such software from a foreign destination, Licensee shall
1050d84335fSJung-uk Kim  * ensure that the distribution and export/re-export of the software is in
1060d84335fSJung-uk Kim  * compliance with all laws, regulations, orders, or other restrictions of the
1070d84335fSJung-uk Kim  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
1080d84335fSJung-uk Kim  * any of its subsidiaries will export/re-export any technical data, process,
1090d84335fSJung-uk Kim  * software, or service, directly or indirectly, to any country for which the
1100d84335fSJung-uk Kim  * United States government or any agency thereof requires an export license,
1110d84335fSJung-uk Kim  * other governmental approval, or letter of assurance, without first obtaining
1120d84335fSJung-uk Kim  * such license, approval or letter.
1130d84335fSJung-uk Kim  *
1140d84335fSJung-uk Kim  *****************************************************************************
1150d84335fSJung-uk Kim  *
1160d84335fSJung-uk Kim  * Alternatively, you may choose to be licensed under the terms of the
1170d84335fSJung-uk Kim  * following license:
1180d84335fSJung-uk Kim  *
119a159c266SJung-uk Kim  * Redistribution and use in source and binary forms, with or without
120a159c266SJung-uk Kim  * modification, are permitted provided that the following conditions
121a159c266SJung-uk Kim  * are met:
122a159c266SJung-uk Kim  * 1. Redistributions of source code must retain the above copyright
123a159c266SJung-uk Kim  *    notice, this list of conditions, and the following disclaimer,
124a159c266SJung-uk Kim  *    without modification.
125a159c266SJung-uk Kim  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126a159c266SJung-uk Kim  *    substantially similar to the "NO WARRANTY" disclaimer below
127a159c266SJung-uk Kim  *    ("Disclaimer") and any redistribution must be conditioned upon
128a159c266SJung-uk Kim  *    including a substantially similar Disclaimer requirement for further
129a159c266SJung-uk Kim  *    binary redistribution.
130a159c266SJung-uk Kim  * 3. Neither the names of the above-listed copyright holders nor the names
131a159c266SJung-uk Kim  *    of any contributors may be used to endorse or promote products derived
132a159c266SJung-uk Kim  *    from this software without specific prior written permission.
133a159c266SJung-uk Kim  *
1340d84335fSJung-uk Kim  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
1350d84335fSJung-uk Kim  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
1360d84335fSJung-uk Kim  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
1370d84335fSJung-uk Kim  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
1380d84335fSJung-uk Kim  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
1390d84335fSJung-uk Kim  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
1400d84335fSJung-uk Kim  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
1410d84335fSJung-uk Kim  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
1420d84335fSJung-uk Kim  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
1430d84335fSJung-uk Kim  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
1440d84335fSJung-uk Kim  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
1450d84335fSJung-uk Kim  *
1460d84335fSJung-uk Kim  * Alternatively, you may choose to be licensed under the terms of the
147a159c266SJung-uk Kim  * GNU General Public License ("GPL") version 2 as published by the Free
148a159c266SJung-uk Kim  * Software Foundation.
149a159c266SJung-uk Kim  *
1500d84335fSJung-uk Kim  *****************************************************************************/
151a159c266SJung-uk Kim 
152a159c266SJung-uk Kim /*
153a159c266SJung-uk Kim  * Parse the AML and build an operation tree as most interpreters,
154a159c266SJung-uk Kim  * like Perl, do. Parsing is done by hand rather than with a YACC
155a159c266SJung-uk Kim  * generated parser to tightly constrain stack and dynamic memory
156a159c266SJung-uk Kim  * usage. At the same time, parsing is kept flexible and the code
157a159c266SJung-uk Kim  * fairly compact by parsing based on a list of AML opcode
158a159c266SJung-uk Kim  * templates in AmlOpInfo[]
159a159c266SJung-uk Kim  */
160a159c266SJung-uk Kim 
161a159c266SJung-uk Kim #include <contrib/dev/acpica/include/acpi.h>
162a159c266SJung-uk Kim #include <contrib/dev/acpica/include/accommon.h>
163a159c266SJung-uk Kim #include <contrib/dev/acpica/include/acparser.h>
164a159c266SJung-uk Kim #include <contrib/dev/acpica/include/acdispat.h>
165a159c266SJung-uk Kim #include <contrib/dev/acpica/include/amlcode.h>
166a159c266SJung-uk Kim #include <contrib/dev/acpica/include/acinterp.h>
167af051161SJung-uk Kim #include <contrib/dev/acpica/include/acnamesp.h>
168a159c266SJung-uk Kim 
169a159c266SJung-uk Kim #define _COMPONENT          ACPI_PARSER
170a159c266SJung-uk Kim         ACPI_MODULE_NAME    ("psparse")
171a159c266SJung-uk Kim 
172a159c266SJung-uk Kim 
173a159c266SJung-uk Kim /*******************************************************************************
174a159c266SJung-uk Kim  *
175a159c266SJung-uk Kim  * FUNCTION:    AcpiPsGetOpcodeSize
176a159c266SJung-uk Kim  *
177a159c266SJung-uk Kim  * PARAMETERS:  Opcode          - An AML opcode
178a159c266SJung-uk Kim  *
179a159c266SJung-uk Kim  * RETURN:      Size of the opcode, in bytes (1 or 2)
180a159c266SJung-uk Kim  *
181a159c266SJung-uk Kim  * DESCRIPTION: Get the size of the current opcode.
182a159c266SJung-uk Kim  *
183a159c266SJung-uk Kim  ******************************************************************************/
184a159c266SJung-uk Kim 
185a159c266SJung-uk Kim UINT32
186a159c266SJung-uk Kim AcpiPsGetOpcodeSize (
187a159c266SJung-uk Kim     UINT32                  Opcode)
188a159c266SJung-uk Kim {
189a159c266SJung-uk Kim 
190a159c266SJung-uk Kim     /* Extended (2-byte) opcode if > 255 */
191a159c266SJung-uk Kim 
192a159c266SJung-uk Kim     if (Opcode > 0x00FF)
193a159c266SJung-uk Kim     {
194a159c266SJung-uk Kim         return (2);
195a159c266SJung-uk Kim     }
196a159c266SJung-uk Kim 
197a159c266SJung-uk Kim     /* Otherwise, just a single byte opcode */
198a159c266SJung-uk Kim 
199a159c266SJung-uk Kim     return (1);
200a159c266SJung-uk Kim }
201a159c266SJung-uk Kim 
202a159c266SJung-uk Kim 
203a159c266SJung-uk Kim /*******************************************************************************
204a159c266SJung-uk Kim  *
205a159c266SJung-uk Kim  * FUNCTION:    AcpiPsPeekOpcode
206a159c266SJung-uk Kim  *
207a159c266SJung-uk Kim  * PARAMETERS:  ParserState         - A parser state object
208a159c266SJung-uk Kim  *
209a159c266SJung-uk Kim  * RETURN:      Next AML opcode
210a159c266SJung-uk Kim  *
211a159c266SJung-uk Kim  * DESCRIPTION: Get next AML opcode (without incrementing AML pointer)
212a159c266SJung-uk Kim  *
213a159c266SJung-uk Kim  ******************************************************************************/
214a159c266SJung-uk Kim 
215a159c266SJung-uk Kim UINT16
216a159c266SJung-uk Kim AcpiPsPeekOpcode (
217a159c266SJung-uk Kim     ACPI_PARSE_STATE        *ParserState)
218a159c266SJung-uk Kim {
219a159c266SJung-uk Kim     UINT8                   *Aml;
220a159c266SJung-uk Kim     UINT16                  Opcode;
221a159c266SJung-uk Kim 
222a159c266SJung-uk Kim 
223a159c266SJung-uk Kim     Aml = ParserState->Aml;
224a159c266SJung-uk Kim     Opcode = (UINT16) ACPI_GET8 (Aml);
225a159c266SJung-uk Kim 
2260d84335fSJung-uk Kim     if (Opcode == AML_EXTENDED_PREFIX)
227a159c266SJung-uk Kim     {
228a159c266SJung-uk Kim         /* Extended opcode, get the second opcode byte */
229a159c266SJung-uk Kim 
230a159c266SJung-uk Kim         Aml++;
231a159c266SJung-uk Kim         Opcode = (UINT16) ((Opcode << 8) | ACPI_GET8 (Aml));
232a159c266SJung-uk Kim     }
233a159c266SJung-uk Kim 
234a159c266SJung-uk Kim     return (Opcode);
235a159c266SJung-uk Kim }
236a159c266SJung-uk Kim 
237a159c266SJung-uk Kim 
238a159c266SJung-uk Kim /*******************************************************************************
239a159c266SJung-uk Kim  *
240a159c266SJung-uk Kim  * FUNCTION:    AcpiPsCompleteThisOp
241a159c266SJung-uk Kim  *
242a159c266SJung-uk Kim  * PARAMETERS:  WalkState       - Current State
243a159c266SJung-uk Kim  *              Op              - Op to complete
244a159c266SJung-uk Kim  *
245a159c266SJung-uk Kim  * RETURN:      Status
246a159c266SJung-uk Kim  *
247a159c266SJung-uk Kim  * DESCRIPTION: Perform any cleanup at the completion of an Op.
248a159c266SJung-uk Kim  *
249a159c266SJung-uk Kim  ******************************************************************************/
250a159c266SJung-uk Kim 
251a159c266SJung-uk Kim ACPI_STATUS
252a159c266SJung-uk Kim AcpiPsCompleteThisOp (
253a159c266SJung-uk Kim     ACPI_WALK_STATE         *WalkState,
254a159c266SJung-uk Kim     ACPI_PARSE_OBJECT       *Op)
255a159c266SJung-uk Kim {
256a159c266SJung-uk Kim     ACPI_PARSE_OBJECT       *Prev;
257a159c266SJung-uk Kim     ACPI_PARSE_OBJECT       *Next;
258a159c266SJung-uk Kim     const ACPI_OPCODE_INFO  *ParentInfo;
259a159c266SJung-uk Kim     ACPI_PARSE_OBJECT       *ReplacementOp = NULL;
260a159c266SJung-uk Kim     ACPI_STATUS             Status = AE_OK;
261a159c266SJung-uk Kim 
262a159c266SJung-uk Kim 
263a159c266SJung-uk Kim     ACPI_FUNCTION_TRACE_PTR (PsCompleteThisOp, Op);
264a159c266SJung-uk Kim 
265a159c266SJung-uk Kim 
266a159c266SJung-uk Kim     /* Check for null Op, can happen if AML code is corrupt */
267a159c266SJung-uk Kim 
268a159c266SJung-uk Kim     if (!Op)
269a159c266SJung-uk Kim     {
270a159c266SJung-uk Kim         return_ACPI_STATUS (AE_OK);  /* OK for now */
271a159c266SJung-uk Kim     }
272a159c266SJung-uk Kim 
273fe0f0bbbSJung-uk Kim     AcpiExStopTraceOpcode (Op, WalkState);
274fe0f0bbbSJung-uk Kim 
275a159c266SJung-uk Kim     /* Delete this op and the subtree below it if asked to */
276a159c266SJung-uk Kim 
277a159c266SJung-uk Kim     if (((WalkState->ParseFlags & ACPI_PARSE_TREE_MASK) != ACPI_PARSE_DELETE_TREE) ||
278a159c266SJung-uk Kim          (WalkState->OpInfo->Class == AML_CLASS_ARGUMENT))
279a159c266SJung-uk Kim     {
280a159c266SJung-uk Kim         return_ACPI_STATUS (AE_OK);
281a159c266SJung-uk Kim     }
282a159c266SJung-uk Kim 
283a159c266SJung-uk Kim     /* Make sure that we only delete this subtree */
284a159c266SJung-uk Kim 
285a159c266SJung-uk Kim     if (Op->Common.Parent)
286a159c266SJung-uk Kim     {
287a159c266SJung-uk Kim         Prev = Op->Common.Parent->Common.Value.Arg;
288a159c266SJung-uk Kim         if (!Prev)
289a159c266SJung-uk Kim         {
290a159c266SJung-uk Kim             /* Nothing more to do */
291a159c266SJung-uk Kim 
292a159c266SJung-uk Kim             goto Cleanup;
293a159c266SJung-uk Kim         }
294a159c266SJung-uk Kim 
295a159c266SJung-uk Kim         /*
296a159c266SJung-uk Kim          * Check if we need to replace the operator and its subtree
297a159c266SJung-uk Kim          * with a return value op (placeholder op)
298a159c266SJung-uk Kim          */
299a159c266SJung-uk Kim         ParentInfo = AcpiPsGetOpcodeInfo (Op->Common.Parent->Common.AmlOpcode);
300a159c266SJung-uk Kim 
301a159c266SJung-uk Kim         switch (ParentInfo->Class)
302a159c266SJung-uk Kim         {
303a159c266SJung-uk Kim         case AML_CLASS_CONTROL:
304a9d8d09cSJung-uk Kim 
305a159c266SJung-uk Kim             break;
306a159c266SJung-uk Kim 
307a159c266SJung-uk Kim         case AML_CLASS_CREATE:
308a159c266SJung-uk Kim             /*
309a159c266SJung-uk Kim              * These opcodes contain TermArg operands. The current
310a159c266SJung-uk Kim              * op must be replaced by a placeholder return op
311a159c266SJung-uk Kim              */
312f8146b88SJung-uk Kim             ReplacementOp = AcpiPsAllocOp (
313f8146b88SJung-uk Kim                 AML_INT_RETURN_VALUE_OP, Op->Common.Aml);
314a159c266SJung-uk Kim             if (!ReplacementOp)
315a159c266SJung-uk Kim             {
316a159c266SJung-uk Kim                 Status = AE_NO_MEMORY;
317a159c266SJung-uk Kim             }
318a159c266SJung-uk Kim             break;
319a159c266SJung-uk Kim 
320a159c266SJung-uk Kim         case AML_CLASS_NAMED_OBJECT:
321a159c266SJung-uk Kim             /*
322a159c266SJung-uk Kim              * These opcodes contain TermArg operands. The current
323a159c266SJung-uk Kim              * op must be replaced by a placeholder return op
324a159c266SJung-uk Kim              */
325a159c266SJung-uk Kim             if ((Op->Common.Parent->Common.AmlOpcode == AML_REGION_OP)       ||
326a159c266SJung-uk Kim                 (Op->Common.Parent->Common.AmlOpcode == AML_DATA_REGION_OP)  ||
327a159c266SJung-uk Kim                 (Op->Common.Parent->Common.AmlOpcode == AML_BUFFER_OP)       ||
328a159c266SJung-uk Kim                 (Op->Common.Parent->Common.AmlOpcode == AML_PACKAGE_OP)      ||
329a159c266SJung-uk Kim                 (Op->Common.Parent->Common.AmlOpcode == AML_BANK_FIELD_OP)   ||
3300d84335fSJung-uk Kim                 (Op->Common.Parent->Common.AmlOpcode == AML_VARIABLE_PACKAGE_OP))
331a159c266SJung-uk Kim             {
332f8146b88SJung-uk Kim                 ReplacementOp = AcpiPsAllocOp (
333f8146b88SJung-uk Kim                     AML_INT_RETURN_VALUE_OP, Op->Common.Aml);
334a159c266SJung-uk Kim                 if (!ReplacementOp)
335a159c266SJung-uk Kim                 {
336a159c266SJung-uk Kim                     Status = AE_NO_MEMORY;
337a159c266SJung-uk Kim                 }
338a159c266SJung-uk Kim             }
339a159c266SJung-uk Kim             else if ((Op->Common.Parent->Common.AmlOpcode == AML_NAME_OP) &&
340a159c266SJung-uk Kim                      (WalkState->PassNumber <= ACPI_IMODE_LOAD_PASS2))
341a159c266SJung-uk Kim             {
342a159c266SJung-uk Kim                 if ((Op->Common.AmlOpcode == AML_BUFFER_OP) ||
343a159c266SJung-uk Kim                     (Op->Common.AmlOpcode == AML_PACKAGE_OP) ||
3440d84335fSJung-uk Kim                     (Op->Common.AmlOpcode == AML_VARIABLE_PACKAGE_OP))
345a159c266SJung-uk Kim                 {
346fe0f0bbbSJung-uk Kim                     ReplacementOp = AcpiPsAllocOp (Op->Common.AmlOpcode,
347fe0f0bbbSJung-uk Kim                         Op->Common.Aml);
348a159c266SJung-uk Kim                     if (!ReplacementOp)
349a159c266SJung-uk Kim                     {
350a159c266SJung-uk Kim                         Status = AE_NO_MEMORY;
351a159c266SJung-uk Kim                     }
352a159c266SJung-uk Kim                     else
353a159c266SJung-uk Kim                     {
354a159c266SJung-uk Kim                         ReplacementOp->Named.Data = Op->Named.Data;
355a159c266SJung-uk Kim                         ReplacementOp->Named.Length = Op->Named.Length;
356a159c266SJung-uk Kim                     }
357a159c266SJung-uk Kim                 }
358a159c266SJung-uk Kim             }
359a159c266SJung-uk Kim             break;
360a159c266SJung-uk Kim 
361a159c266SJung-uk Kim         default:
362a159c266SJung-uk Kim 
363f8146b88SJung-uk Kim             ReplacementOp = AcpiPsAllocOp (
364f8146b88SJung-uk Kim                 AML_INT_RETURN_VALUE_OP, Op->Common.Aml);
365a159c266SJung-uk Kim             if (!ReplacementOp)
366a159c266SJung-uk Kim             {
367a159c266SJung-uk Kim                 Status = AE_NO_MEMORY;
368a159c266SJung-uk Kim             }
369a159c266SJung-uk Kim         }
370a159c266SJung-uk Kim 
371a159c266SJung-uk Kim         /* We must unlink this op from the parent tree */
372a159c266SJung-uk Kim 
373a159c266SJung-uk Kim         if (Prev == Op)
374a159c266SJung-uk Kim         {
375a159c266SJung-uk Kim             /* This op is the first in the list */
376a159c266SJung-uk Kim 
377a159c266SJung-uk Kim             if (ReplacementOp)
378a159c266SJung-uk Kim             {
379a159c266SJung-uk Kim                 ReplacementOp->Common.Parent = Op->Common.Parent;
380a159c266SJung-uk Kim                 ReplacementOp->Common.Value.Arg = NULL;
381a159c266SJung-uk Kim                 ReplacementOp->Common.Node = Op->Common.Node;
382a159c266SJung-uk Kim                 Op->Common.Parent->Common.Value.Arg = ReplacementOp;
383a159c266SJung-uk Kim                 ReplacementOp->Common.Next = Op->Common.Next;
384a159c266SJung-uk Kim             }
385a159c266SJung-uk Kim             else
386a159c266SJung-uk Kim             {
387a159c266SJung-uk Kim                 Op->Common.Parent->Common.Value.Arg = Op->Common.Next;
388a159c266SJung-uk Kim             }
389a159c266SJung-uk Kim         }
390a159c266SJung-uk Kim 
391a159c266SJung-uk Kim         /* Search the parent list */
392a159c266SJung-uk Kim 
393a159c266SJung-uk Kim         else while (Prev)
394a159c266SJung-uk Kim         {
395a159c266SJung-uk Kim             /* Traverse all siblings in the parent's argument list */
396a159c266SJung-uk Kim 
397a159c266SJung-uk Kim             Next = Prev->Common.Next;
398a159c266SJung-uk Kim             if (Next == Op)
399a159c266SJung-uk Kim             {
400a159c266SJung-uk Kim                 if (ReplacementOp)
401a159c266SJung-uk Kim                 {
402a159c266SJung-uk Kim                     ReplacementOp->Common.Parent = Op->Common.Parent;
403a159c266SJung-uk Kim                     ReplacementOp->Common.Value.Arg = NULL;
404a159c266SJung-uk Kim                     ReplacementOp->Common.Node = Op->Common.Node;
405a159c266SJung-uk Kim                     Prev->Common.Next = ReplacementOp;
406a159c266SJung-uk Kim                     ReplacementOp->Common.Next = Op->Common.Next;
407a159c266SJung-uk Kim                     Next = NULL;
408a159c266SJung-uk Kim                 }
409a159c266SJung-uk Kim                 else
410a159c266SJung-uk Kim                 {
411a159c266SJung-uk Kim                     Prev->Common.Next = Op->Common.Next;
412a159c266SJung-uk Kim                     Next = NULL;
413a159c266SJung-uk Kim                 }
414a159c266SJung-uk Kim             }
415a159c266SJung-uk Kim             Prev = Next;
416a159c266SJung-uk Kim         }
417a159c266SJung-uk Kim     }
418a159c266SJung-uk Kim 
419a159c266SJung-uk Kim 
420a159c266SJung-uk Kim Cleanup:
421a159c266SJung-uk Kim 
422a159c266SJung-uk Kim     /* Now we can actually delete the subtree rooted at Op */
423a159c266SJung-uk Kim 
424a159c266SJung-uk Kim     AcpiPsDeleteParseTree (Op);
425a159c266SJung-uk Kim     return_ACPI_STATUS (Status);
426a159c266SJung-uk Kim }
427a159c266SJung-uk Kim 
428a159c266SJung-uk Kim 
429a159c266SJung-uk Kim /*******************************************************************************
430a159c266SJung-uk Kim  *
431a159c266SJung-uk Kim  * FUNCTION:    AcpiPsNextParseState
432a159c266SJung-uk Kim  *
433a159c266SJung-uk Kim  * PARAMETERS:  WalkState           - Current state
434a159c266SJung-uk Kim  *              Op                  - Current parse op
435a159c266SJung-uk Kim  *              CallbackStatus      - Status from previous operation
436a159c266SJung-uk Kim  *
437a159c266SJung-uk Kim  * RETURN:      Status
438a159c266SJung-uk Kim  *
439a159c266SJung-uk Kim  * DESCRIPTION: Update the parser state based upon the return exception from
440a159c266SJung-uk Kim  *              the parser callback.
441a159c266SJung-uk Kim  *
442a159c266SJung-uk Kim  ******************************************************************************/
443a159c266SJung-uk Kim 
444a159c266SJung-uk Kim ACPI_STATUS
445a159c266SJung-uk Kim AcpiPsNextParseState (
446a159c266SJung-uk Kim     ACPI_WALK_STATE         *WalkState,
447a159c266SJung-uk Kim     ACPI_PARSE_OBJECT       *Op,
448a159c266SJung-uk Kim     ACPI_STATUS             CallbackStatus)
449a159c266SJung-uk Kim {
450a159c266SJung-uk Kim     ACPI_PARSE_STATE        *ParserState = &WalkState->ParserState;
451a159c266SJung-uk Kim     ACPI_STATUS             Status = AE_CTRL_PENDING;
452a159c266SJung-uk Kim 
453a159c266SJung-uk Kim 
454a159c266SJung-uk Kim     ACPI_FUNCTION_TRACE_PTR (PsNextParseState, Op);
455a159c266SJung-uk Kim 
456a159c266SJung-uk Kim 
457a159c266SJung-uk Kim     switch (CallbackStatus)
458a159c266SJung-uk Kim     {
459a159c266SJung-uk Kim     case AE_CTRL_TERMINATE:
460a159c266SJung-uk Kim         /*
461a159c266SJung-uk Kim          * A control method was terminated via a RETURN statement.
462a159c266SJung-uk Kim          * The walk of this method is complete.
463a159c266SJung-uk Kim          */
464a159c266SJung-uk Kim         ParserState->Aml = ParserState->AmlEnd;
465a159c266SJung-uk Kim         Status = AE_CTRL_TERMINATE;
466a159c266SJung-uk Kim         break;
467a159c266SJung-uk Kim 
468a159c266SJung-uk Kim     case AE_CTRL_BREAK:
469a159c266SJung-uk Kim 
470a159c266SJung-uk Kim         ParserState->Aml = WalkState->AmlLastWhile;
471a159c266SJung-uk Kim         WalkState->ControlState->Common.Value = FALSE;
472a159c266SJung-uk Kim         Status = AE_CTRL_BREAK;
473a159c266SJung-uk Kim         break;
474a159c266SJung-uk Kim 
475a159c266SJung-uk Kim     case AE_CTRL_CONTINUE:
476a159c266SJung-uk Kim 
477a159c266SJung-uk Kim         ParserState->Aml = WalkState->AmlLastWhile;
478a159c266SJung-uk Kim         Status = AE_CTRL_CONTINUE;
479a159c266SJung-uk Kim         break;
480a159c266SJung-uk Kim 
481a159c266SJung-uk Kim     case AE_CTRL_PENDING:
482a159c266SJung-uk Kim 
483a159c266SJung-uk Kim         ParserState->Aml = WalkState->AmlLastWhile;
484a159c266SJung-uk Kim         break;
485a159c266SJung-uk Kim 
486a159c266SJung-uk Kim #if 0
487a159c266SJung-uk Kim     case AE_CTRL_SKIP:
488a159c266SJung-uk Kim 
489a159c266SJung-uk Kim         ParserState->Aml = ParserState->Scope->ParseScope.PkgEnd;
490a159c266SJung-uk Kim         Status = AE_OK;
491a159c266SJung-uk Kim         break;
492a159c266SJung-uk Kim #endif
493a159c266SJung-uk Kim 
494a159c266SJung-uk Kim     case AE_CTRL_TRUE:
495a159c266SJung-uk Kim         /*
496a159c266SJung-uk Kim          * Predicate of an IF was true, and we are at the matching ELSE.
497a159c266SJung-uk Kim          * Just close out this package
498a159c266SJung-uk Kim          */
499a159c266SJung-uk Kim         ParserState->Aml = AcpiPsGetNextPackageEnd (ParserState);
500a159c266SJung-uk Kim         Status = AE_CTRL_PENDING;
501a159c266SJung-uk Kim         break;
502a159c266SJung-uk Kim 
503a159c266SJung-uk Kim     case AE_CTRL_FALSE:
504a159c266SJung-uk Kim         /*
505a159c266SJung-uk Kim          * Either an IF/WHILE Predicate was false or we encountered a BREAK
506a159c266SJung-uk Kim          * opcode. In both cases, we do not execute the rest of the
507a159c266SJung-uk Kim          * package;  We simply close out the parent (finishing the walk of
508a159c266SJung-uk Kim          * this branch of the tree) and continue execution at the parent
509a159c266SJung-uk Kim          * level.
510a159c266SJung-uk Kim          */
511a159c266SJung-uk Kim         ParserState->Aml = ParserState->Scope->ParseScope.PkgEnd;
512a159c266SJung-uk Kim 
513a159c266SJung-uk Kim         /* In the case of a BREAK, just force a predicate (if any) to FALSE */
514a159c266SJung-uk Kim 
515a159c266SJung-uk Kim         WalkState->ControlState->Common.Value = FALSE;
516a159c266SJung-uk Kim         Status = AE_CTRL_END;
517a159c266SJung-uk Kim         break;
518a159c266SJung-uk Kim 
519a159c266SJung-uk Kim     case AE_CTRL_TRANSFER:
520a159c266SJung-uk Kim 
521a159c266SJung-uk Kim         /* A method call (invocation) -- transfer control */
522a159c266SJung-uk Kim 
523a159c266SJung-uk Kim         Status = AE_CTRL_TRANSFER;
524a159c266SJung-uk Kim         WalkState->PrevOp = Op;
525a159c266SJung-uk Kim         WalkState->MethodCallOp = Op;
526a159c266SJung-uk Kim         WalkState->MethodCallNode = (Op->Common.Value.Arg)->Common.Node;
527a159c266SJung-uk Kim 
528a159c266SJung-uk Kim         /* Will return value (if any) be used by the caller? */
529a159c266SJung-uk Kim 
530a159c266SJung-uk Kim         WalkState->ReturnUsed = AcpiDsIsResultUsed (Op, WalkState);
531a159c266SJung-uk Kim         break;
532a159c266SJung-uk Kim 
533a159c266SJung-uk Kim     default:
534a159c266SJung-uk Kim 
535a159c266SJung-uk Kim         Status = CallbackStatus;
536385fb5d9SJung-uk Kim         if (ACPI_CNTL_EXCEPTION (CallbackStatus))
537a159c266SJung-uk Kim         {
538a159c266SJung-uk Kim             Status = AE_OK;
539a159c266SJung-uk Kim         }
540a159c266SJung-uk Kim         break;
541a159c266SJung-uk Kim     }
542a159c266SJung-uk Kim 
543a159c266SJung-uk Kim     return_ACPI_STATUS (Status);
544a159c266SJung-uk Kim }
545a159c266SJung-uk Kim 
546a159c266SJung-uk Kim 
547a159c266SJung-uk Kim /*******************************************************************************
548a159c266SJung-uk Kim  *
549a159c266SJung-uk Kim  * FUNCTION:    AcpiPsParseAml
550a159c266SJung-uk Kim  *
551a159c266SJung-uk Kim  * PARAMETERS:  WalkState       - Current state
552a159c266SJung-uk Kim  *
553a159c266SJung-uk Kim  *
554a159c266SJung-uk Kim  * RETURN:      Status
555a159c266SJung-uk Kim  *
556a159c266SJung-uk Kim  * DESCRIPTION: Parse raw AML and return a tree of ops
557a159c266SJung-uk Kim  *
558a159c266SJung-uk Kim  ******************************************************************************/
559a159c266SJung-uk Kim 
560a159c266SJung-uk Kim ACPI_STATUS
561a159c266SJung-uk Kim AcpiPsParseAml (
562a159c266SJung-uk Kim     ACPI_WALK_STATE         *WalkState)
563a159c266SJung-uk Kim {
564a159c266SJung-uk Kim     ACPI_STATUS             Status;
565a159c266SJung-uk Kim     ACPI_THREAD_STATE       *Thread;
566a159c266SJung-uk Kim     ACPI_THREAD_STATE       *PrevWalkList = AcpiGbl_CurrentWalkList;
567a159c266SJung-uk Kim     ACPI_WALK_STATE         *PreviousWalkState;
568a159c266SJung-uk Kim 
569a159c266SJung-uk Kim 
570a159c266SJung-uk Kim     ACPI_FUNCTION_TRACE (PsParseAml);
571a159c266SJung-uk Kim 
572a159c266SJung-uk Kim     ACPI_DEBUG_PRINT ((ACPI_DB_PARSE,
573a159c266SJung-uk Kim         "Entered with WalkState=%p Aml=%p size=%X\n",
574a159c266SJung-uk Kim         WalkState, WalkState->ParserState.Aml,
575a159c266SJung-uk Kim         WalkState->ParserState.AmlSize));
576a159c266SJung-uk Kim 
577a159c266SJung-uk Kim     if (!WalkState->ParserState.Aml)
578a159c266SJung-uk Kim     {
579ff879b07SJung-uk Kim         return_ACPI_STATUS (AE_BAD_ADDRESS);
580a159c266SJung-uk Kim     }
581a159c266SJung-uk Kim 
582a159c266SJung-uk Kim     /* Create and initialize a new thread state */
583a159c266SJung-uk Kim 
584a159c266SJung-uk Kim     Thread = AcpiUtCreateThreadState ();
585a159c266SJung-uk Kim     if (!Thread)
586a159c266SJung-uk Kim     {
587a159c266SJung-uk Kim         if (WalkState->MethodDesc)
588a159c266SJung-uk Kim         {
589a159c266SJung-uk Kim             /* Executing a control method - additional cleanup */
590a159c266SJung-uk Kim 
591a159c266SJung-uk Kim             AcpiDsTerminateControlMethod (WalkState->MethodDesc, WalkState);
592a159c266SJung-uk Kim         }
593a159c266SJung-uk Kim 
594a159c266SJung-uk Kim         AcpiDsDeleteWalkState (WalkState);
595a159c266SJung-uk Kim         return_ACPI_STATUS (AE_NO_MEMORY);
596a159c266SJung-uk Kim     }
597a159c266SJung-uk Kim 
598a159c266SJung-uk Kim     WalkState->Thread = Thread;
599a159c266SJung-uk Kim 
600a159c266SJung-uk Kim     /*
601a159c266SJung-uk Kim      * If executing a method, the starting SyncLevel is this method's
602a159c266SJung-uk Kim      * SyncLevel
603a159c266SJung-uk Kim      */
604a159c266SJung-uk Kim     if (WalkState->MethodDesc)
605a159c266SJung-uk Kim     {
606f8146b88SJung-uk Kim         WalkState->Thread->CurrentSyncLevel =
607f8146b88SJung-uk Kim             WalkState->MethodDesc->Method.SyncLevel;
608a159c266SJung-uk Kim     }
609a159c266SJung-uk Kim 
610a159c266SJung-uk Kim     AcpiDsPushWalkState (WalkState, Thread);
611a159c266SJung-uk Kim 
612a159c266SJung-uk Kim     /*
613a159c266SJung-uk Kim      * This global allows the AML debugger to get a handle to the currently
614a159c266SJung-uk Kim      * executing control method.
615a159c266SJung-uk Kim      */
616a159c266SJung-uk Kim     AcpiGbl_CurrentWalkList = Thread;
617a159c266SJung-uk Kim 
618a159c266SJung-uk Kim     /*
619a159c266SJung-uk Kim      * Execute the walk loop as long as there is a valid Walk State. This
620a159c266SJung-uk Kim      * handles nested control method invocations without recursion.
621a159c266SJung-uk Kim      */
622a159c266SJung-uk Kim     ACPI_DEBUG_PRINT ((ACPI_DB_PARSE, "State=%p\n", WalkState));
623a159c266SJung-uk Kim 
624a159c266SJung-uk Kim     Status = AE_OK;
625a159c266SJung-uk Kim     while (WalkState)
626a159c266SJung-uk Kim     {
627a159c266SJung-uk Kim         if (ACPI_SUCCESS (Status))
628a159c266SJung-uk Kim         {
629a159c266SJung-uk Kim             /*
630a159c266SJung-uk Kim              * The ParseLoop executes AML until the method terminates
631a159c266SJung-uk Kim              * or calls another method.
632a159c266SJung-uk Kim              */
633a159c266SJung-uk Kim             Status = AcpiPsParseLoop (WalkState);
634a159c266SJung-uk Kim         }
635a159c266SJung-uk Kim 
636a159c266SJung-uk Kim         ACPI_DEBUG_PRINT ((ACPI_DB_PARSE,
637a159c266SJung-uk Kim             "Completed one call to walk loop, %s State=%p\n",
638a159c266SJung-uk Kim             AcpiFormatException (Status), WalkState));
639a159c266SJung-uk Kim 
64090b566fdSJung-uk Kim         if (WalkState->MethodPathname && WalkState->MethodIsNested)
64190b566fdSJung-uk Kim         {
64290b566fdSJung-uk Kim             /* Optional object evaluation log */
64390b566fdSJung-uk Kim 
64490b566fdSJung-uk Kim             ACPI_DEBUG_PRINT_RAW ((ACPI_DB_EVALUATION, "%-26s:  %*s%s\n",
64590b566fdSJung-uk Kim                 "   Exit nested method",
64690b566fdSJung-uk Kim                 (WalkState->MethodNestingDepth + 1) * 3, " ",
64790b566fdSJung-uk Kim                 &WalkState->MethodPathname[1]));
64890b566fdSJung-uk Kim 
64990b566fdSJung-uk Kim             ACPI_FREE (WalkState->MethodPathname);
65090b566fdSJung-uk Kim             WalkState->MethodIsNested = FALSE;
65190b566fdSJung-uk Kim         }
652a159c266SJung-uk Kim         if (Status == AE_CTRL_TRANSFER)
653a159c266SJung-uk Kim         {
654a159c266SJung-uk Kim             /*
655a159c266SJung-uk Kim              * A method call was detected.
656a159c266SJung-uk Kim              * Transfer control to the called control method
657a159c266SJung-uk Kim              */
658a159c266SJung-uk Kim             Status = AcpiDsCallControlMethod (Thread, WalkState, NULL);
659a159c266SJung-uk Kim             if (ACPI_FAILURE (Status))
660a159c266SJung-uk Kim             {
661a159c266SJung-uk Kim                 Status = AcpiDsMethodError (Status, WalkState);
662a159c266SJung-uk Kim             }
663a159c266SJung-uk Kim 
664a159c266SJung-uk Kim             /*
665f15e9afbSJung-uk Kim              * If the transfer to the new method method call worked,
666f15e9afbSJung-uk Kim              * a new walk state was created -- get it
667a159c266SJung-uk Kim              */
668a159c266SJung-uk Kim             WalkState = AcpiDsGetCurrentWalkState (Thread);
669a159c266SJung-uk Kim             continue;
670a159c266SJung-uk Kim         }
671a159c266SJung-uk Kim         else if (Status == AE_CTRL_TERMINATE)
672a159c266SJung-uk Kim         {
673a159c266SJung-uk Kim             Status = AE_OK;
674a159c266SJung-uk Kim         }
675a159c266SJung-uk Kim         else if ((Status != AE_OK) && (WalkState->MethodDesc))
676a159c266SJung-uk Kim         {
677a159c266SJung-uk Kim             /* Either the method parse or actual execution failed */
678a159c266SJung-uk Kim 
679493deb39SJung-uk Kim             AcpiExExitInterpreter ();
680af051161SJung-uk Kim             if (Status == AE_ABORT_METHOD)
681af051161SJung-uk Kim             {
682af051161SJung-uk Kim                 AcpiNsPrintNodePathname (
683cd6518c7SJung-uk Kim                     WalkState->MethodNode, "Aborting method");
684af051161SJung-uk Kim                 AcpiOsPrintf ("\n");
685af051161SJung-uk Kim             }
686af051161SJung-uk Kim             else
687af051161SJung-uk Kim             {
688cd6518c7SJung-uk Kim                 ACPI_ERROR_METHOD ("Aborting method",
689a159c266SJung-uk Kim                     WalkState->MethodNode, NULL, Status);
690af051161SJung-uk Kim             }
691493deb39SJung-uk Kim             AcpiExEnterInterpreter ();
692a159c266SJung-uk Kim 
693a159c266SJung-uk Kim             /* Check for possible multi-thread reentrancy problem */
694a159c266SJung-uk Kim 
695a159c266SJung-uk Kim             if ((Status == AE_ALREADY_EXISTS) &&
696f8146b88SJung-uk Kim                 (!(WalkState->MethodDesc->Method.InfoFlags &
697f8146b88SJung-uk Kim                     ACPI_METHOD_SERIALIZED)))
698a159c266SJung-uk Kim             {
699a159c266SJung-uk Kim                 /*
700a159c266SJung-uk Kim                  * Method is not serialized and tried to create an object
701a159c266SJung-uk Kim                  * twice. The probable cause is that the method cannot
702a159c266SJung-uk Kim                  * handle reentrancy. Mark as "pending serialized" now, and
703a159c266SJung-uk Kim                  * then mark "serialized" when the last thread exits.
704a159c266SJung-uk Kim                  */
705a159c266SJung-uk Kim                 WalkState->MethodDesc->Method.InfoFlags |=
706a159c266SJung-uk Kim                     ACPI_METHOD_SERIALIZED_PENDING;
707a159c266SJung-uk Kim             }
708a159c266SJung-uk Kim         }
709a159c266SJung-uk Kim 
710a159c266SJung-uk Kim         /* We are done with this walk, move on to the parent if any */
711a159c266SJung-uk Kim 
712a159c266SJung-uk Kim         WalkState = AcpiDsPopWalkState (Thread);
713a159c266SJung-uk Kim 
714a159c266SJung-uk Kim         /* Reset the current scope to the beginning of scope stack */
715a159c266SJung-uk Kim 
716a159c266SJung-uk Kim         AcpiDsScopeStackClear (WalkState);
717a159c266SJung-uk Kim 
718a159c266SJung-uk Kim         /*
719a159c266SJung-uk Kim          * If we just returned from the execution of a control method or if we
720a159c266SJung-uk Kim          * encountered an error during the method parse phase, there's lots of
721a159c266SJung-uk Kim          * cleanup to do
722a159c266SJung-uk Kim          */
723f8146b88SJung-uk Kim         if (((WalkState->ParseFlags & ACPI_PARSE_MODE_MASK) ==
724493deb39SJung-uk Kim             ACPI_PARSE_EXECUTE &&
725493deb39SJung-uk Kim             !(WalkState->ParseFlags & ACPI_PARSE_MODULE_LEVEL)) ||
726a159c266SJung-uk Kim             (ACPI_FAILURE (Status)))
727a159c266SJung-uk Kim         {
728a159c266SJung-uk Kim             AcpiDsTerminateControlMethod (WalkState->MethodDesc, WalkState);
729a159c266SJung-uk Kim         }
730a159c266SJung-uk Kim 
731a159c266SJung-uk Kim         /* Delete this walk state and all linked control states */
732a159c266SJung-uk Kim 
733a159c266SJung-uk Kim         AcpiPsCleanupScope (&WalkState->ParserState);
734a159c266SJung-uk Kim         PreviousWalkState = WalkState;
735a159c266SJung-uk Kim 
736a159c266SJung-uk Kim         ACPI_DEBUG_PRINT ((ACPI_DB_PARSE,
737a159c266SJung-uk Kim             "ReturnValue=%p, ImplicitValue=%p State=%p\n",
738a159c266SJung-uk Kim             WalkState->ReturnDesc, WalkState->ImplicitReturnObj, WalkState));
739a159c266SJung-uk Kim 
740a159c266SJung-uk Kim         /* Check if we have restarted a preempted walk */
741a159c266SJung-uk Kim 
742a159c266SJung-uk Kim         WalkState = AcpiDsGetCurrentWalkState (Thread);
743a159c266SJung-uk Kim         if (WalkState)
744a159c266SJung-uk Kim         {
745a159c266SJung-uk Kim             if (ACPI_SUCCESS (Status))
746a159c266SJung-uk Kim             {
747a159c266SJung-uk Kim                 /*
748a159c266SJung-uk Kim                  * There is another walk state, restart it.
749a159c266SJung-uk Kim                  * If the method return value is not used by the parent,
750a159c266SJung-uk Kim                  * The object is deleted
751a159c266SJung-uk Kim                  */
752a159c266SJung-uk Kim                 if (!PreviousWalkState->ReturnDesc)
753a159c266SJung-uk Kim                 {
754a159c266SJung-uk Kim                     /*
755a159c266SJung-uk Kim                      * In slack mode execution, if there is no return value
756a159c266SJung-uk Kim                      * we should implicitly return zero (0) as a default value.
757a159c266SJung-uk Kim                      */
758a159c266SJung-uk Kim                     if (AcpiGbl_EnableInterpreterSlack &&
759a159c266SJung-uk Kim                         !PreviousWalkState->ImplicitReturnObj)
760a159c266SJung-uk Kim                     {
761a159c266SJung-uk Kim                         PreviousWalkState->ImplicitReturnObj =
762a159c266SJung-uk Kim                             AcpiUtCreateIntegerObject ((UINT64) 0);
763a159c266SJung-uk Kim                         if (!PreviousWalkState->ImplicitReturnObj)
764a159c266SJung-uk Kim                         {
765a159c266SJung-uk Kim                             return_ACPI_STATUS (AE_NO_MEMORY);
766a159c266SJung-uk Kim                         }
767a159c266SJung-uk Kim                     }
768a159c266SJung-uk Kim 
769a159c266SJung-uk Kim                     /* Restart the calling control method */
770a159c266SJung-uk Kim 
771a159c266SJung-uk Kim                     Status = AcpiDsRestartControlMethod (WalkState,
772a159c266SJung-uk Kim                         PreviousWalkState->ImplicitReturnObj);
773a159c266SJung-uk Kim                 }
774a159c266SJung-uk Kim                 else
775a159c266SJung-uk Kim                 {
776a159c266SJung-uk Kim                     /*
777a159c266SJung-uk Kim                      * We have a valid return value, delete any implicit
778a159c266SJung-uk Kim                      * return value.
779a159c266SJung-uk Kim                      */
780a159c266SJung-uk Kim                     AcpiDsClearImplicitReturn (PreviousWalkState);
781a159c266SJung-uk Kim 
782a159c266SJung-uk Kim                     Status = AcpiDsRestartControlMethod (WalkState,
783a159c266SJung-uk Kim                         PreviousWalkState->ReturnDesc);
784a159c266SJung-uk Kim                 }
785a159c266SJung-uk Kim                 if (ACPI_SUCCESS (Status))
786a159c266SJung-uk Kim                 {
787a159c266SJung-uk Kim                     WalkState->WalkType |= ACPI_WALK_METHOD_RESTART;
788a159c266SJung-uk Kim                 }
789a159c266SJung-uk Kim             }
790a159c266SJung-uk Kim             else
791a159c266SJung-uk Kim             {
792a159c266SJung-uk Kim                 /* On error, delete any return object or implicit return */
793a159c266SJung-uk Kim 
794a159c266SJung-uk Kim                 AcpiUtRemoveReference (PreviousWalkState->ReturnDesc);
795a159c266SJung-uk Kim                 AcpiDsClearImplicitReturn (PreviousWalkState);
796a159c266SJung-uk Kim             }
797a159c266SJung-uk Kim         }
798a159c266SJung-uk Kim 
799a159c266SJung-uk Kim         /*
800a159c266SJung-uk Kim          * Just completed a 1st-level method, save the final internal return
801a159c266SJung-uk Kim          * value (if any)
802a159c266SJung-uk Kim          */
803a159c266SJung-uk Kim         else if (PreviousWalkState->CallerReturnDesc)
804a159c266SJung-uk Kim         {
805a159c266SJung-uk Kim             if (PreviousWalkState->ImplicitReturnObj)
806a159c266SJung-uk Kim             {
807a159c266SJung-uk Kim                 *(PreviousWalkState->CallerReturnDesc) =
808a159c266SJung-uk Kim                     PreviousWalkState->ImplicitReturnObj;
809a159c266SJung-uk Kim             }
810a159c266SJung-uk Kim             else
811a159c266SJung-uk Kim             {
812a159c266SJung-uk Kim                  /* NULL if no return value */
813a159c266SJung-uk Kim 
814a159c266SJung-uk Kim                 *(PreviousWalkState->CallerReturnDesc) =
815a159c266SJung-uk Kim                     PreviousWalkState->ReturnDesc;
816a159c266SJung-uk Kim             }
817a159c266SJung-uk Kim         }
818a159c266SJung-uk Kim         else
819a159c266SJung-uk Kim         {
820a159c266SJung-uk Kim             if (PreviousWalkState->ReturnDesc)
821a159c266SJung-uk Kim             {
822a159c266SJung-uk Kim                 /* Caller doesn't want it, must delete it */
823a159c266SJung-uk Kim 
824a159c266SJung-uk Kim                 AcpiUtRemoveReference (PreviousWalkState->ReturnDesc);
825a159c266SJung-uk Kim             }
826a159c266SJung-uk Kim             if (PreviousWalkState->ImplicitReturnObj)
827a159c266SJung-uk Kim             {
828a159c266SJung-uk Kim                 /* Caller doesn't want it, must delete it */
829a159c266SJung-uk Kim 
830a159c266SJung-uk Kim                 AcpiUtRemoveReference (PreviousWalkState->ImplicitReturnObj);
831a159c266SJung-uk Kim             }
832a159c266SJung-uk Kim         }
833a159c266SJung-uk Kim 
834a159c266SJung-uk Kim         AcpiDsDeleteWalkState (PreviousWalkState);
835a159c266SJung-uk Kim     }
836a159c266SJung-uk Kim 
837a159c266SJung-uk Kim     /* Normal exit */
838a159c266SJung-uk Kim 
839a159c266SJung-uk Kim     AcpiExReleaseAllMutexes (Thread);
840a159c266SJung-uk Kim     AcpiUtDeleteGenericState (ACPI_CAST_PTR (ACPI_GENERIC_STATE, Thread));
841a159c266SJung-uk Kim     AcpiGbl_CurrentWalkList = PrevWalkList;
842a159c266SJung-uk Kim     return_ACPI_STATUS (Status);
843a159c266SJung-uk Kim }
844