acpica/parser/psparse.c

db2bae30SDana Myers/******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * Module Name: psparse - Parser top level AML parse routines
db2bae30SDana Myers *
db2bae30SDana Myers *****************************************************************************/
db2bae30SDana Myers
26f3cdf0SGordon Ross/*
*385cc6b4SJerry Jelinek * Copyright (C) 2000 - 2016, Intel Corp.
db2bae30SDana Myers * All rights reserved.
db2bae30SDana Myers *
26f3cdf0SGordon Ross * Redistribution and use in source and binary forms, with or without
26f3cdf0SGordon Ross * modification, are permitted provided that the following conditions
26f3cdf0SGordon Ross * are met:
26f3cdf0SGordon Ross * 1. Redistributions of source code must retain the above copyright
26f3cdf0SGordon Ross *    notice, this list of conditions, and the following disclaimer,
26f3cdf0SGordon Ross *    without modification.
26f3cdf0SGordon Ross * 2. Redistributions in binary form must reproduce at minimum a disclaimer
26f3cdf0SGordon Ross *    substantially similar to the "NO WARRANTY" disclaimer below
26f3cdf0SGordon Ross *    ("Disclaimer") and any redistribution must be conditioned upon
26f3cdf0SGordon Ross *    including a substantially similar Disclaimer requirement for further
26f3cdf0SGordon Ross *    binary redistribution.
26f3cdf0SGordon Ross * 3. Neither the names of the above-listed copyright holders nor the names
26f3cdf0SGordon Ross *    of any contributors may be used to endorse or promote products derived
26f3cdf0SGordon Ross *    from this software without specific prior written permission.
db2bae30SDana Myers *
26f3cdf0SGordon Ross * Alternatively, this software may be distributed under the terms of the
26f3cdf0SGordon Ross * GNU General Public License ("GPL") version 2 as published by the Free
26f3cdf0SGordon Ross * Software Foundation.
db2bae30SDana Myers *
26f3cdf0SGordon Ross * NO WARRANTY
26f3cdf0SGordon Ross * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26f3cdf0SGordon Ross * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26f3cdf0SGordon Ross * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
26f3cdf0SGordon Ross * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26f3cdf0SGordon Ross * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26f3cdf0SGordon Ross * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26f3cdf0SGordon Ross * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26f3cdf0SGordon Ross * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26f3cdf0SGordon Ross * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
26f3cdf0SGordon Ross * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26f3cdf0SGordon Ross * POSSIBILITY OF SUCH DAMAGES.
26f3cdf0SGordon Ross */
db2bae30SDana Myers
db2bae30SDana Myers/*
db2bae30SDana Myers * Parse the AML and build an operation tree as most interpreters,
db2bae30SDana Myers * like Perl, do. Parsing is done by hand rather than with a YACC
db2bae30SDana Myers * generated parser to tightly constrain stack and dynamic memory
db2bae30SDana Myers * usage. At the same time, parsing is kept flexible and the code
db2bae30SDana Myers * fairly compact by parsing based on a list of AML opcode
db2bae30SDana Myers * templates in AmlOpInfo[]
db2bae30SDana Myers */
db2bae30SDana Myers
db2bae30SDana Myers#include "acpi.h"
aa2aa9a6SDana Myers#include "accommon.h"
db2bae30SDana Myers#include "acparser.h"
db2bae30SDana Myers#include "acdispat.h"
db2bae30SDana Myers#include "amlcode.h"
db2bae30SDana Myers#include "acinterp.h"
db2bae30SDana Myers
db2bae30SDana Myers#define _COMPONENT          ACPI_PARSER
db2bae30SDana Myers        ACPI_MODULE_NAME    ("psparse")
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiPsGetOpcodeSize
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  Opcode          - An AML opcode
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Size of the opcode, in bytes (1 or 2)
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Get the size of the current opcode.
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersUINT32
db2bae30SDana MyersAcpiPsGetOpcodeSize (
db2bae30SDana Myers    UINT32                  Opcode)
db2bae30SDana Myers{
db2bae30SDana Myers
db2bae30SDana Myers    /* Extended (2-byte) opcode if > 255 */
db2bae30SDana Myers
db2bae30SDana Myers    if (Opcode > 0x00FF)
db2bae30SDana Myers    {
db2bae30SDana Myers        return (2);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Otherwise, just a single byte opcode */
db2bae30SDana Myers
db2bae30SDana Myers    return (1);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiPsPeekOpcode
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  ParserState         - A parser state object
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Next AML opcode
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Get next AML opcode (without incrementing AML pointer)
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersUINT16
db2bae30SDana MyersAcpiPsPeekOpcode (
db2bae30SDana Myers    ACPI_PARSE_STATE        *ParserState)
db2bae30SDana Myers{
db2bae30SDana Myers    UINT8                   *Aml;
db2bae30SDana Myers    UINT16                  Opcode;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    Aml = ParserState->Aml;
db2bae30SDana Myers    Opcode = (UINT16) ACPI_GET8 (Aml);
db2bae30SDana Myers
db2bae30SDana Myers    if (Opcode == AML_EXTENDED_OP_PREFIX)
db2bae30SDana Myers    {
db2bae30SDana Myers        /* Extended opcode, get the second opcode byte */
db2bae30SDana Myers
db2bae30SDana Myers        Aml++;
db2bae30SDana Myers        Opcode = (UINT16) ((Opcode << 8) | ACPI_GET8 (Aml));
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    return (Opcode);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiPsCompleteThisOp
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  WalkState       - Current State
db2bae30SDana Myers *              Op              - Op to complete
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Status
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Perform any cleanup at the completion of an Op.
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersACPI_STATUS
db2bae30SDana MyersAcpiPsCompleteThisOp (
db2bae30SDana Myers    ACPI_WALK_STATE         *WalkState,
db2bae30SDana Myers    ACPI_PARSE_OBJECT       *Op)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_PARSE_OBJECT       *Prev;
db2bae30SDana Myers    ACPI_PARSE_OBJECT       *Next;
db2bae30SDana Myers    const ACPI_OPCODE_INFO  *ParentInfo;
db2bae30SDana Myers    ACPI_PARSE_OBJECT       *ReplacementOp = NULL;
aa2aa9a6SDana Myers    ACPI_STATUS             Status = AE_OK;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_TRACE_PTR (PsCompleteThisOp, Op);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    /* Check for null Op, can happen if AML code is corrupt */
db2bae30SDana Myers
db2bae30SDana Myers    if (!Op)
db2bae30SDana Myers    {
db2bae30SDana Myers        return_ACPI_STATUS (AE_OK);  /* OK for now */
db2bae30SDana Myers    }
db2bae30SDana Myers
*385cc6b4SJerry Jelinek    AcpiExStopTraceOpcode (Op, WalkState);
*385cc6b4SJerry Jelinek
db2bae30SDana Myers    /* Delete this op and the subtree below it if asked to */
db2bae30SDana Myers
db2bae30SDana Myers    if (((WalkState->ParseFlags & ACPI_PARSE_TREE_MASK) != ACPI_PARSE_DELETE_TREE) ||
db2bae30SDana Myers         (WalkState->OpInfo->Class == AML_CLASS_ARGUMENT))
db2bae30SDana Myers    {
db2bae30SDana Myers        return_ACPI_STATUS (AE_OK);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Make sure that we only delete this subtree */
db2bae30SDana Myers
db2bae30SDana Myers    if (Op->Common.Parent)
db2bae30SDana Myers    {
db2bae30SDana Myers        Prev = Op->Common.Parent->Common.Value.Arg;
db2bae30SDana Myers        if (!Prev)
db2bae30SDana Myers        {
db2bae30SDana Myers            /* Nothing more to do */
db2bae30SDana Myers
db2bae30SDana Myers            goto Cleanup;
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        /*
db2bae30SDana Myers         * Check if we need to replace the operator and its subtree
db2bae30SDana Myers         * with a return value op (placeholder op)
db2bae30SDana Myers         */
db2bae30SDana Myers        ParentInfo = AcpiPsGetOpcodeInfo (Op->Common.Parent->Common.AmlOpcode);
db2bae30SDana Myers
db2bae30SDana Myers        switch (ParentInfo->Class)
db2bae30SDana Myers        {
db2bae30SDana Myers        case AML_CLASS_CONTROL:
*385cc6b4SJerry Jelinek
db2bae30SDana Myers            break;
db2bae30SDana Myers
db2bae30SDana Myers        case AML_CLASS_CREATE:
db2bae30SDana Myers            /*
db2bae30SDana Myers             * These opcodes contain TermArg operands. The current
db2bae30SDana Myers             * op must be replaced by a placeholder return op
db2bae30SDana Myers             */
*385cc6b4SJerry Jelinek            ReplacementOp = AcpiPsAllocOp (
*385cc6b4SJerry Jelinek                AML_INT_RETURN_VALUE_OP, Op->Common.Aml);
db2bae30SDana Myers            if (!ReplacementOp)
db2bae30SDana Myers            {
aa2aa9a6SDana Myers                Status = AE_NO_MEMORY;
db2bae30SDana Myers            }
db2bae30SDana Myers            break;
db2bae30SDana Myers
db2bae30SDana Myers        case AML_CLASS_NAMED_OBJECT:
db2bae30SDana Myers            /*
db2bae30SDana Myers             * These opcodes contain TermArg operands. The current
db2bae30SDana Myers             * op must be replaced by a placeholder return op
db2bae30SDana Myers             */
db2bae30SDana Myers            if ((Op->Common.Parent->Common.AmlOpcode == AML_REGION_OP)       ||
db2bae30SDana Myers                (Op->Common.Parent->Common.AmlOpcode == AML_DATA_REGION_OP)  ||
db2bae30SDana Myers                (Op->Common.Parent->Common.AmlOpcode == AML_BUFFER_OP)       ||
db2bae30SDana Myers                (Op->Common.Parent->Common.AmlOpcode == AML_PACKAGE_OP)      ||
db2bae30SDana Myers                (Op->Common.Parent->Common.AmlOpcode == AML_BANK_FIELD_OP)   ||
db2bae30SDana Myers                (Op->Common.Parent->Common.AmlOpcode == AML_VAR_PACKAGE_OP))
db2bae30SDana Myers            {
*385cc6b4SJerry Jelinek                ReplacementOp = AcpiPsAllocOp (
*385cc6b4SJerry Jelinek                    AML_INT_RETURN_VALUE_OP, Op->Common.Aml);
db2bae30SDana Myers                if (!ReplacementOp)
db2bae30SDana Myers                {
aa2aa9a6SDana Myers                    Status = AE_NO_MEMORY;
db2bae30SDana Myers                }
db2bae30SDana Myers            }
db2bae30SDana Myers            else if ((Op->Common.Parent->Common.AmlOpcode == AML_NAME_OP) &&
db2bae30SDana Myers                     (WalkState->PassNumber <= ACPI_IMODE_LOAD_PASS2))
db2bae30SDana Myers            {
db2bae30SDana Myers                if ((Op->Common.AmlOpcode == AML_BUFFER_OP) ||
db2bae30SDana Myers                    (Op->Common.AmlOpcode == AML_PACKAGE_OP) ||
db2bae30SDana Myers                    (Op->Common.AmlOpcode == AML_VAR_PACKAGE_OP))
db2bae30SDana Myers                {
*385cc6b4SJerry Jelinek                    ReplacementOp = AcpiPsAllocOp (Op->Common.AmlOpcode,
*385cc6b4SJerry Jelinek                        Op->Common.Aml);
db2bae30SDana Myers                    if (!ReplacementOp)
db2bae30SDana Myers                    {
aa2aa9a6SDana Myers                        Status = AE_NO_MEMORY;
db2bae30SDana Myers                    }
aa2aa9a6SDana Myers                    else
aa2aa9a6SDana Myers                    {
db2bae30SDana Myers                        ReplacementOp->Named.Data = Op->Named.Data;
db2bae30SDana Myers                        ReplacementOp->Named.Length = Op->Named.Length;
db2bae30SDana Myers                    }
db2bae30SDana Myers                }
aa2aa9a6SDana Myers            }
db2bae30SDana Myers            break;
db2bae30SDana Myers
db2bae30SDana Myers        default:
db2bae30SDana Myers
*385cc6b4SJerry Jelinek            ReplacementOp = AcpiPsAllocOp (
*385cc6b4SJerry Jelinek                AML_INT_RETURN_VALUE_OP, Op->Common.Aml);
db2bae30SDana Myers            if (!ReplacementOp)
db2bae30SDana Myers            {
aa2aa9a6SDana Myers                Status = AE_NO_MEMORY;
db2bae30SDana Myers            }
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        /* We must unlink this op from the parent tree */
db2bae30SDana Myers
db2bae30SDana Myers        if (Prev == Op)
db2bae30SDana Myers        {
db2bae30SDana Myers            /* This op is the first in the list */
db2bae30SDana Myers
db2bae30SDana Myers            if (ReplacementOp)
db2bae30SDana Myers            {
db2bae30SDana Myers                ReplacementOp->Common.Parent = Op->Common.Parent;
db2bae30SDana Myers                ReplacementOp->Common.Value.Arg = NULL;
db2bae30SDana Myers                ReplacementOp->Common.Node = Op->Common.Node;
db2bae30SDana Myers                Op->Common.Parent->Common.Value.Arg = ReplacementOp;
db2bae30SDana Myers                ReplacementOp->Common.Next = Op->Common.Next;
db2bae30SDana Myers            }
db2bae30SDana Myers            else
db2bae30SDana Myers            {
db2bae30SDana Myers                Op->Common.Parent->Common.Value.Arg = Op->Common.Next;
db2bae30SDana Myers            }
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        /* Search the parent list */
db2bae30SDana Myers
db2bae30SDana Myers        else while (Prev)
db2bae30SDana Myers        {
db2bae30SDana Myers            /* Traverse all siblings in the parent's argument list */
db2bae30SDana Myers
db2bae30SDana Myers            Next = Prev->Common.Next;
db2bae30SDana Myers            if (Next == Op)
db2bae30SDana Myers            {
db2bae30SDana Myers                if (ReplacementOp)
db2bae30SDana Myers                {
db2bae30SDana Myers                    ReplacementOp->Common.Parent = Op->Common.Parent;
db2bae30SDana Myers                    ReplacementOp->Common.Value.Arg = NULL;
db2bae30SDana Myers                    ReplacementOp->Common.Node = Op->Common.Node;
db2bae30SDana Myers                    Prev->Common.Next = ReplacementOp;
db2bae30SDana Myers                    ReplacementOp->Common.Next = Op->Common.Next;
db2bae30SDana Myers                    Next = NULL;
db2bae30SDana Myers                }
db2bae30SDana Myers                else
db2bae30SDana Myers                {
db2bae30SDana Myers                    Prev->Common.Next = Op->Common.Next;
db2bae30SDana Myers                    Next = NULL;
db2bae30SDana Myers                }
db2bae30SDana Myers            }
db2bae30SDana Myers            Prev = Next;
db2bae30SDana Myers        }
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana MyersCleanup:
db2bae30SDana Myers
db2bae30SDana Myers    /* Now we can actually delete the subtree rooted at Op */
db2bae30SDana Myers
db2bae30SDana Myers    AcpiPsDeleteParseTree (Op);
aa2aa9a6SDana Myers    return_ACPI_STATUS (Status);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiPsNextParseState
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  WalkState           - Current state
db2bae30SDana Myers *              Op                  - Current parse op
db2bae30SDana Myers *              CallbackStatus      - Status from previous operation
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Status
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Update the parser state based upon the return exception from
db2bae30SDana Myers *              the parser callback.
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersACPI_STATUS
db2bae30SDana MyersAcpiPsNextParseState (
db2bae30SDana Myers    ACPI_WALK_STATE         *WalkState,
db2bae30SDana Myers    ACPI_PARSE_OBJECT       *Op,
db2bae30SDana Myers    ACPI_STATUS             CallbackStatus)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_PARSE_STATE        *ParserState = &WalkState->ParserState;
db2bae30SDana Myers    ACPI_STATUS             Status = AE_CTRL_PENDING;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_TRACE_PTR (PsNextParseState, Op);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    switch (CallbackStatus)
db2bae30SDana Myers    {
db2bae30SDana Myers    case AE_CTRL_TERMINATE:
db2bae30SDana Myers        /*
db2bae30SDana Myers         * A control method was terminated via a RETURN statement.
db2bae30SDana Myers         * The walk of this method is complete.
db2bae30SDana Myers         */
db2bae30SDana Myers        ParserState->Aml = ParserState->AmlEnd;
db2bae30SDana Myers        Status = AE_CTRL_TERMINATE;
db2bae30SDana Myers        break;
db2bae30SDana Myers
db2bae30SDana Myers    case AE_CTRL_BREAK:
db2bae30SDana Myers
db2bae30SDana Myers        ParserState->Aml = WalkState->AmlLastWhile;
db2bae30SDana Myers        WalkState->ControlState->Common.Value = FALSE;
db2bae30SDana Myers        Status = AE_CTRL_BREAK;
db2bae30SDana Myers        break;
db2bae30SDana Myers
db2bae30SDana Myers    case AE_CTRL_CONTINUE:
db2bae30SDana Myers
db2bae30SDana Myers        ParserState->Aml = WalkState->AmlLastWhile;
db2bae30SDana Myers        Status = AE_CTRL_CONTINUE;
db2bae30SDana Myers        break;
db2bae30SDana Myers
db2bae30SDana Myers    case AE_CTRL_PENDING:
db2bae30SDana Myers
db2bae30SDana Myers        ParserState->Aml = WalkState->AmlLastWhile;
db2bae30SDana Myers        break;
db2bae30SDana Myers
db2bae30SDana Myers#if 0
db2bae30SDana Myers    case AE_CTRL_SKIP:
db2bae30SDana Myers
db2bae30SDana Myers        ParserState->Aml = ParserState->Scope->ParseScope.PkgEnd;
db2bae30SDana Myers        Status = AE_OK;
db2bae30SDana Myers        break;
db2bae30SDana Myers#endif
db2bae30SDana Myers
db2bae30SDana Myers    case AE_CTRL_TRUE:
db2bae30SDana Myers        /*
db2bae30SDana Myers         * Predicate of an IF was true, and we are at the matching ELSE.
db2bae30SDana Myers         * Just close out this package
db2bae30SDana Myers         */
db2bae30SDana Myers        ParserState->Aml = AcpiPsGetNextPackageEnd (ParserState);
db2bae30SDana Myers        Status = AE_CTRL_PENDING;
db2bae30SDana Myers        break;
db2bae30SDana Myers
db2bae30SDana Myers    case AE_CTRL_FALSE:
db2bae30SDana Myers        /*
db2bae30SDana Myers         * Either an IF/WHILE Predicate was false or we encountered a BREAK
db2bae30SDana Myers         * opcode. In both cases, we do not execute the rest of the
db2bae30SDana Myers         * package;  We simply close out the parent (finishing the walk of
db2bae30SDana Myers         * this branch of the tree) and continue execution at the parent
db2bae30SDana Myers         * level.
db2bae30SDana Myers         */
db2bae30SDana Myers        ParserState->Aml = ParserState->Scope->ParseScope.PkgEnd;
db2bae30SDana Myers
db2bae30SDana Myers        /* In the case of a BREAK, just force a predicate (if any) to FALSE */
db2bae30SDana Myers
db2bae30SDana Myers        WalkState->ControlState->Common.Value = FALSE;
db2bae30SDana Myers        Status = AE_CTRL_END;
db2bae30SDana Myers        break;
db2bae30SDana Myers
db2bae30SDana Myers    case AE_CTRL_TRANSFER:
db2bae30SDana Myers
db2bae30SDana Myers        /* A method call (invocation) -- transfer control */
db2bae30SDana Myers
db2bae30SDana Myers        Status = AE_CTRL_TRANSFER;
db2bae30SDana Myers        WalkState->PrevOp = Op;
db2bae30SDana Myers        WalkState->MethodCallOp = Op;
db2bae30SDana Myers        WalkState->MethodCallNode = (Op->Common.Value.Arg)->Common.Node;
db2bae30SDana Myers
db2bae30SDana Myers        /* Will return value (if any) be used by the caller? */
db2bae30SDana Myers
db2bae30SDana Myers        WalkState->ReturnUsed = AcpiDsIsResultUsed (Op, WalkState);
db2bae30SDana Myers        break;
db2bae30SDana Myers
db2bae30SDana Myers    default:
db2bae30SDana Myers
db2bae30SDana Myers        Status = CallbackStatus;
db2bae30SDana Myers        if ((CallbackStatus & AE_CODE_MASK) == AE_CODE_CONTROL)
db2bae30SDana Myers        {
db2bae30SDana Myers            Status = AE_OK;
db2bae30SDana Myers        }
db2bae30SDana Myers        break;
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    return_ACPI_STATUS (Status);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiPsParseAml
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  WalkState       - Current state
db2bae30SDana Myers *
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Status
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Parse raw AML and return a tree of ops
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersACPI_STATUS
db2bae30SDana MyersAcpiPsParseAml (
db2bae30SDana Myers    ACPI_WALK_STATE         *WalkState)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_STATUS             Status;
db2bae30SDana Myers    ACPI_THREAD_STATE       *Thread;
db2bae30SDana Myers    ACPI_THREAD_STATE       *PrevWalkList = AcpiGbl_CurrentWalkList;
db2bae30SDana Myers    ACPI_WALK_STATE         *PreviousWalkState;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_TRACE (PsParseAml);
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_DEBUG_PRINT ((ACPI_DB_PARSE,
db2bae30SDana Myers        "Entered with WalkState=%p Aml=%p size=%X\n",
db2bae30SDana Myers        WalkState, WalkState->ParserState.Aml,
db2bae30SDana Myers        WalkState->ParserState.AmlSize));
db2bae30SDana Myers
aa2aa9a6SDana Myers    if (!WalkState->ParserState.Aml)
aa2aa9a6SDana Myers    {
aa2aa9a6SDana Myers        return_ACPI_STATUS (AE_NULL_OBJECT);
aa2aa9a6SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Create and initialize a new thread state */
db2bae30SDana Myers
db2bae30SDana Myers    Thread = AcpiUtCreateThreadState ();
db2bae30SDana Myers    if (!Thread)
db2bae30SDana Myers    {
aa2aa9a6SDana Myers        if (WalkState->MethodDesc)
aa2aa9a6SDana Myers        {
aa2aa9a6SDana Myers            /* Executing a control method - additional cleanup */
aa2aa9a6SDana Myers
aa2aa9a6SDana Myers            AcpiDsTerminateControlMethod (WalkState->MethodDesc, WalkState);
aa2aa9a6SDana Myers        }
aa2aa9a6SDana Myers
db2bae30SDana Myers        AcpiDsDeleteWalkState (WalkState);
db2bae30SDana Myers        return_ACPI_STATUS (AE_NO_MEMORY);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    WalkState->Thread = Thread;
db2bae30SDana Myers
db2bae30SDana Myers    /*
db2bae30SDana Myers     * If executing a method, the starting SyncLevel is this method's
db2bae30SDana Myers     * SyncLevel
db2bae30SDana Myers     */
db2bae30SDana Myers    if (WalkState->MethodDesc)
db2bae30SDana Myers    {
*385cc6b4SJerry Jelinek        WalkState->Thread->CurrentSyncLevel =
*385cc6b4SJerry Jelinek            WalkState->MethodDesc->Method.SyncLevel;
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    AcpiDsPushWalkState (WalkState, Thread);
db2bae30SDana Myers
db2bae30SDana Myers    /*
db2bae30SDana Myers     * This global allows the AML debugger to get a handle to the currently
db2bae30SDana Myers     * executing control method.
db2bae30SDana Myers     */
db2bae30SDana Myers    AcpiGbl_CurrentWalkList = Thread;
db2bae30SDana Myers
db2bae30SDana Myers    /*
db2bae30SDana Myers     * Execute the walk loop as long as there is a valid Walk State. This
db2bae30SDana Myers     * handles nested control method invocations without recursion.
db2bae30SDana Myers     */
db2bae30SDana Myers    ACPI_DEBUG_PRINT ((ACPI_DB_PARSE, "State=%p\n", WalkState));
db2bae30SDana Myers
db2bae30SDana Myers    Status = AE_OK;
db2bae30SDana Myers    while (WalkState)
db2bae30SDana Myers    {
db2bae30SDana Myers        if (ACPI_SUCCESS (Status))
db2bae30SDana Myers        {
db2bae30SDana Myers            /*
db2bae30SDana Myers             * The ParseLoop executes AML until the method terminates
db2bae30SDana Myers             * or calls another method.
db2bae30SDana Myers             */
db2bae30SDana Myers            Status = AcpiPsParseLoop (WalkState);
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        ACPI_DEBUG_PRINT ((ACPI_DB_PARSE,
db2bae30SDana Myers            "Completed one call to walk loop, %s State=%p\n",
db2bae30SDana Myers            AcpiFormatException (Status), WalkState));
db2bae30SDana Myers
db2bae30SDana Myers        if (Status == AE_CTRL_TRANSFER)
db2bae30SDana Myers        {
db2bae30SDana Myers            /*
db2bae30SDana Myers             * A method call was detected.
db2bae30SDana Myers             * Transfer control to the called control method
db2bae30SDana Myers             */
db2bae30SDana Myers            Status = AcpiDsCallControlMethod (Thread, WalkState, NULL);
db2bae30SDana Myers            if (ACPI_FAILURE (Status))
db2bae30SDana Myers            {
db2bae30SDana Myers                Status = AcpiDsMethodError (Status, WalkState);
db2bae30SDana Myers            }
db2bae30SDana Myers
db2bae30SDana Myers            /*
*385cc6b4SJerry Jelinek             * If the transfer to the new method method call worked
*385cc6b4SJerry Jelinek             *, a new walk state was created -- get it
db2bae30SDana Myers             */
db2bae30SDana Myers            WalkState = AcpiDsGetCurrentWalkState (Thread);
db2bae30SDana Myers            continue;
db2bae30SDana Myers        }
db2bae30SDana Myers        else if (Status == AE_CTRL_TERMINATE)
db2bae30SDana Myers        {
db2bae30SDana Myers            Status = AE_OK;
db2bae30SDana Myers        }
db2bae30SDana Myers        else if ((Status != AE_OK) && (WalkState->MethodDesc))
db2bae30SDana Myers        {
db2bae30SDana Myers            /* Either the method parse or actual execution failed */
db2bae30SDana Myers
db2bae30SDana Myers            ACPI_ERROR_METHOD ("Method parse/execution failed",
db2bae30SDana Myers                WalkState->MethodNode, NULL, Status);
db2bae30SDana Myers
db2bae30SDana Myers            /* Check for possible multi-thread reentrancy problem */
db2bae30SDana Myers
db2bae30SDana Myers            if ((Status == AE_ALREADY_EXISTS) &&
*385cc6b4SJerry Jelinek                (!(WalkState->MethodDesc->Method.InfoFlags &
*385cc6b4SJerry Jelinek                    ACPI_METHOD_SERIALIZED)))
db2bae30SDana Myers            {
db2bae30SDana Myers                /*
26f3cdf0SGordon Ross                 * Method is not serialized and tried to create an object
26f3cdf0SGordon Ross                 * twice. The probable cause is that the method cannot
26f3cdf0SGordon Ross                 * handle reentrancy. Mark as "pending serialized" now, and
26f3cdf0SGordon Ross                 * then mark "serialized" when the last thread exits.
db2bae30SDana Myers                 */
26f3cdf0SGordon Ross                WalkState->MethodDesc->Method.InfoFlags |=
26f3cdf0SGordon Ross                    ACPI_METHOD_SERIALIZED_PENDING;
db2bae30SDana Myers            }
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        /* We are done with this walk, move on to the parent if any */
db2bae30SDana Myers
db2bae30SDana Myers        WalkState = AcpiDsPopWalkState (Thread);
db2bae30SDana Myers
db2bae30SDana Myers        /* Reset the current scope to the beginning of scope stack */
db2bae30SDana Myers
db2bae30SDana Myers        AcpiDsScopeStackClear (WalkState);
db2bae30SDana Myers
db2bae30SDana Myers        /*
db2bae30SDana Myers         * If we just returned from the execution of a control method or if we
db2bae30SDana Myers         * encountered an error during the method parse phase, there's lots of
db2bae30SDana Myers         * cleanup to do
db2bae30SDana Myers         */
*385cc6b4SJerry Jelinek        if (((WalkState->ParseFlags & ACPI_PARSE_MODE_MASK) ==
*385cc6b4SJerry Jelinek            ACPI_PARSE_EXECUTE) ||
db2bae30SDana Myers            (ACPI_FAILURE (Status)))
db2bae30SDana Myers        {
db2bae30SDana Myers            AcpiDsTerminateControlMethod (WalkState->MethodDesc, WalkState);
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        /* Delete this walk state and all linked control states */
db2bae30SDana Myers
db2bae30SDana Myers        AcpiPsCleanupScope (&WalkState->ParserState);
db2bae30SDana Myers        PreviousWalkState = WalkState;
db2bae30SDana Myers
db2bae30SDana Myers        ACPI_DEBUG_PRINT ((ACPI_DB_PARSE,
db2bae30SDana Myers            "ReturnValue=%p, ImplicitValue=%p State=%p\n",
db2bae30SDana Myers            WalkState->ReturnDesc, WalkState->ImplicitReturnObj, WalkState));
db2bae30SDana Myers
db2bae30SDana Myers        /* Check if we have restarted a preempted walk */
db2bae30SDana Myers
db2bae30SDana Myers        WalkState = AcpiDsGetCurrentWalkState (Thread);
db2bae30SDana Myers        if (WalkState)
db2bae30SDana Myers        {
db2bae30SDana Myers            if (ACPI_SUCCESS (Status))
db2bae30SDana Myers            {
db2bae30SDana Myers                /*
db2bae30SDana Myers                 * There is another walk state, restart it.
db2bae30SDana Myers                 * If the method return value is not used by the parent,
db2bae30SDana Myers                 * The object is deleted
db2bae30SDana Myers                 */
db2bae30SDana Myers                if (!PreviousWalkState->ReturnDesc)
db2bae30SDana Myers                {
db2bae30SDana Myers                    /*
db2bae30SDana Myers                     * In slack mode execution, if there is no return value
db2bae30SDana Myers                     * we should implicitly return zero (0) as a default value.
db2bae30SDana Myers                     */
db2bae30SDana Myers                    if (AcpiGbl_EnableInterpreterSlack &&
db2bae30SDana Myers                        !PreviousWalkState->ImplicitReturnObj)
db2bae30SDana Myers                    {
db2bae30SDana Myers                        PreviousWalkState->ImplicitReturnObj =
57190917SDana Myers                            AcpiUtCreateIntegerObject ((UINT64) 0);
db2bae30SDana Myers                        if (!PreviousWalkState->ImplicitReturnObj)
db2bae30SDana Myers                        {
db2bae30SDana Myers                            return_ACPI_STATUS (AE_NO_MEMORY);
db2bae30SDana Myers                        }
db2bae30SDana Myers                    }
db2bae30SDana Myers
db2bae30SDana Myers                    /* Restart the calling control method */
db2bae30SDana Myers
db2bae30SDana Myers                    Status = AcpiDsRestartControlMethod (WalkState,
db2bae30SDana Myers                        PreviousWalkState->ImplicitReturnObj);
db2bae30SDana Myers                }
db2bae30SDana Myers                else
db2bae30SDana Myers                {
db2bae30SDana Myers                    /*
db2bae30SDana Myers                     * We have a valid return value, delete any implicit
db2bae30SDana Myers                     * return value.
db2bae30SDana Myers                     */
db2bae30SDana Myers                    AcpiDsClearImplicitReturn (PreviousWalkState);
db2bae30SDana Myers
db2bae30SDana Myers                    Status = AcpiDsRestartControlMethod (WalkState,
db2bae30SDana Myers                        PreviousWalkState->ReturnDesc);
db2bae30SDana Myers                }
db2bae30SDana Myers                if (ACPI_SUCCESS (Status))
db2bae30SDana Myers                {
db2bae30SDana Myers                    WalkState->WalkType |= ACPI_WALK_METHOD_RESTART;
db2bae30SDana Myers                }
db2bae30SDana Myers            }
db2bae30SDana Myers            else
db2bae30SDana Myers            {
aa2aa9a6SDana Myers                /* On error, delete any return object or implicit return */
db2bae30SDana Myers
db2bae30SDana Myers                AcpiUtRemoveReference (PreviousWalkState->ReturnDesc);
aa2aa9a6SDana Myers                AcpiDsClearImplicitReturn (PreviousWalkState);
db2bae30SDana Myers            }
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        /*
db2bae30SDana Myers         * Just completed a 1st-level method, save the final internal return
db2bae30SDana Myers         * value (if any)
db2bae30SDana Myers         */
db2bae30SDana Myers        else if (PreviousWalkState->CallerReturnDesc)
db2bae30SDana Myers        {
db2bae30SDana Myers            if (PreviousWalkState->ImplicitReturnObj)
db2bae30SDana Myers            {
db2bae30SDana Myers                *(PreviousWalkState->CallerReturnDesc) =
db2bae30SDana Myers                    PreviousWalkState->ImplicitReturnObj;
db2bae30SDana Myers            }
db2bae30SDana Myers            else
db2bae30SDana Myers            {
db2bae30SDana Myers                 /* NULL if no return value */
db2bae30SDana Myers
db2bae30SDana Myers                *(PreviousWalkState->CallerReturnDesc) =
db2bae30SDana Myers                    PreviousWalkState->ReturnDesc;
db2bae30SDana Myers            }
db2bae30SDana Myers        }
db2bae30SDana Myers        else
db2bae30SDana Myers        {
db2bae30SDana Myers            if (PreviousWalkState->ReturnDesc)
db2bae30SDana Myers            {
db2bae30SDana Myers                /* Caller doesn't want it, must delete it */
db2bae30SDana Myers
db2bae30SDana Myers                AcpiUtRemoveReference (PreviousWalkState->ReturnDesc);
db2bae30SDana Myers            }
db2bae30SDana Myers            if (PreviousWalkState->ImplicitReturnObj)
db2bae30SDana Myers            {
db2bae30SDana Myers                /* Caller doesn't want it, must delete it */
db2bae30SDana Myers
db2bae30SDana Myers                AcpiUtRemoveReference (PreviousWalkState->ImplicitReturnObj);
db2bae30SDana Myers            }
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        AcpiDsDeleteWalkState (PreviousWalkState);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Normal exit */
db2bae30SDana Myers
db2bae30SDana Myers    AcpiExReleaseAllMutexes (Thread);
db2bae30SDana Myers    AcpiUtDeleteGenericState (ACPI_CAST_PTR (ACPI_GENERIC_STATE, Thread));
db2bae30SDana Myers    AcpiGbl_CurrentWalkList = PrevWalkList;
db2bae30SDana Myers    return_ACPI_STATUS (Status);
db2bae30SDana Myers}