acpica/dispatcher/dswstate.c

db2bae30SDana Myers/******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * Module Name: dswstate - Dispatcher parse tree walk management 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#include "acpi.h"
aa2aa9a6SDana Myers#include "accommon.h"
db2bae30SDana Myers#include "acparser.h"
db2bae30SDana Myers#include "acdispat.h"
db2bae30SDana Myers#include "acnamesp.h"
db2bae30SDana Myers
db2bae30SDana Myers#define _COMPONENT          ACPI_DISPATCHER
db2bae30SDana Myers        ACPI_MODULE_NAME    ("dswstate")
db2bae30SDana Myers
db2bae30SDana Myers/* Local prototypes */
db2bae30SDana Myers
db2bae30SDana Myersstatic ACPI_STATUS
db2bae30SDana MyersAcpiDsResultStackPush (
db2bae30SDana Myers    ACPI_WALK_STATE         *WalkState);
db2bae30SDana Myers
db2bae30SDana Myersstatic ACPI_STATUS
db2bae30SDana MyersAcpiDsResultStackPop (
db2bae30SDana Myers    ACPI_WALK_STATE         *WalkState);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiDsResultPop
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  Object              - Where to return the popped object
db2bae30SDana Myers *              WalkState           - Current Walk state
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Status
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Pop an object off the top of this walk's result stack
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersACPI_STATUS
db2bae30SDana MyersAcpiDsResultPop (
db2bae30SDana Myers    ACPI_OPERAND_OBJECT     **Object,
db2bae30SDana Myers    ACPI_WALK_STATE         *WalkState)
db2bae30SDana Myers{
db2bae30SDana Myers    UINT32                  Index;
db2bae30SDana Myers    ACPI_GENERIC_STATE      *State;
db2bae30SDana Myers    ACPI_STATUS             Status;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_NAME (DsResultPop);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    State = WalkState->Results;
db2bae30SDana Myers
db2bae30SDana Myers    /* Incorrect state of result stack */
db2bae30SDana Myers
db2bae30SDana Myers    if (State && !WalkState->ResultCount)
db2bae30SDana Myers    {
db2bae30SDana Myers        ACPI_ERROR ((AE_INFO, "No results on result stack"));
db2bae30SDana Myers        return (AE_AML_INTERNAL);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    if (!State && WalkState->ResultCount)
db2bae30SDana Myers    {
db2bae30SDana Myers        ACPI_ERROR ((AE_INFO, "No result state for result stack"));
db2bae30SDana Myers        return (AE_AML_INTERNAL);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Empty result stack */
db2bae30SDana Myers
db2bae30SDana Myers    if (!State)
db2bae30SDana Myers    {
db2bae30SDana Myers        ACPI_ERROR ((AE_INFO, "Result stack is empty! State=%p", WalkState));
db2bae30SDana Myers        return (AE_AML_NO_RETURN_VALUE);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Return object of the top element and clean that top element result stack */
db2bae30SDana Myers
db2bae30SDana Myers    WalkState->ResultCount--;
aa2aa9a6SDana Myers    Index = (UINT32) WalkState->ResultCount % ACPI_RESULTS_FRAME_OBJ_NUM;
db2bae30SDana Myers
db2bae30SDana Myers    *Object = State->Results.ObjDesc [Index];
db2bae30SDana Myers    if (!*Object)
db2bae30SDana Myers    {
db2bae30SDana Myers        ACPI_ERROR ((AE_INFO, "No result objects on result stack, State=%p",
db2bae30SDana Myers            WalkState));
db2bae30SDana Myers        return (AE_AML_NO_RETURN_VALUE);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    State->Results.ObjDesc [Index] = NULL;
db2bae30SDana Myers    if (Index == 0)
db2bae30SDana Myers    {
db2bae30SDana Myers        Status = AcpiDsResultStackPop (WalkState);
db2bae30SDana Myers        if (ACPI_FAILURE (Status))
db2bae30SDana Myers        {
db2bae30SDana Myers            return (Status);
db2bae30SDana Myers        }
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
db2bae30SDana Myers        "Obj=%p [%s] Index=%X State=%p Num=%X\n", *Object,
db2bae30SDana Myers        AcpiUtGetObjectTypeName (*Object),
db2bae30SDana Myers        Index, WalkState, WalkState->ResultCount));
db2bae30SDana Myers
db2bae30SDana Myers    return (AE_OK);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiDsResultPush
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  Object              - Where to return the popped object
db2bae30SDana Myers *              WalkState           - Current Walk state
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Status
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Push an object onto the current result stack
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersACPI_STATUS
db2bae30SDana MyersAcpiDsResultPush (
db2bae30SDana Myers    ACPI_OPERAND_OBJECT     *Object,
db2bae30SDana Myers    ACPI_WALK_STATE         *WalkState)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_GENERIC_STATE      *State;
db2bae30SDana Myers    ACPI_STATUS             Status;
db2bae30SDana Myers    UINT32                  Index;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_NAME (DsResultPush);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    if (WalkState->ResultCount > WalkState->ResultSize)
db2bae30SDana Myers    {
db2bae30SDana Myers        ACPI_ERROR ((AE_INFO, "Result stack is full"));
db2bae30SDana Myers        return (AE_AML_INTERNAL);
db2bae30SDana Myers    }
db2bae30SDana Myers    else if (WalkState->ResultCount == WalkState->ResultSize)
db2bae30SDana Myers    {
db2bae30SDana Myers        /* Extend the result stack */
db2bae30SDana Myers
db2bae30SDana Myers        Status = AcpiDsResultStackPush (WalkState);
db2bae30SDana Myers        if (ACPI_FAILURE (Status))
db2bae30SDana Myers        {
db2bae30SDana Myers            ACPI_ERROR ((AE_INFO, "Failed to extend the result stack"));
db2bae30SDana Myers            return (Status);
db2bae30SDana Myers        }
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    if (!(WalkState->ResultCount < WalkState->ResultSize))
db2bae30SDana Myers    {
db2bae30SDana Myers        ACPI_ERROR ((AE_INFO, "No free elements in result stack"));
db2bae30SDana Myers        return (AE_AML_INTERNAL);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    State = WalkState->Results;
db2bae30SDana Myers    if (!State)
db2bae30SDana Myers    {
db2bae30SDana Myers        ACPI_ERROR ((AE_INFO, "No result stack frame during push"));
db2bae30SDana Myers        return (AE_AML_INTERNAL);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    if (!Object)
db2bae30SDana Myers    {
db2bae30SDana Myers        ACPI_ERROR ((AE_INFO,
26f3cdf0SGordon Ross            "Null Object! Obj=%p State=%p Num=%u",
db2bae30SDana Myers            Object, WalkState, WalkState->ResultCount));
db2bae30SDana Myers        return (AE_BAD_PARAMETER);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Assign the address of object to the top free element of result stack */
db2bae30SDana Myers
aa2aa9a6SDana Myers    Index = (UINT32) WalkState->ResultCount % ACPI_RESULTS_FRAME_OBJ_NUM;
db2bae30SDana Myers    State->Results.ObjDesc [Index] = Object;
db2bae30SDana Myers    WalkState->ResultCount++;
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Obj=%p [%s] State=%p Num=%X Cur=%X\n",
db2bae30SDana Myers        Object, AcpiUtGetObjectTypeName ((ACPI_OPERAND_OBJECT *) Object),
db2bae30SDana Myers        WalkState, WalkState->ResultCount, WalkState->CurrentResult));
db2bae30SDana Myers
db2bae30SDana Myers    return (AE_OK);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiDsResultStackPush
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  WalkState           - Current Walk state
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Status
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Push an object onto the WalkState result stack
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana Myersstatic ACPI_STATUS
db2bae30SDana MyersAcpiDsResultStackPush (
db2bae30SDana Myers    ACPI_WALK_STATE         *WalkState)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_GENERIC_STATE      *State;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_NAME (DsResultStackPush);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    /* Check for stack overflow */
db2bae30SDana Myers
db2bae30SDana Myers    if (((UINT32) WalkState->ResultSize + ACPI_RESULTS_FRAME_OBJ_NUM) >
db2bae30SDana Myers        ACPI_RESULTS_OBJ_NUM_MAX)
db2bae30SDana Myers    {
26f3cdf0SGordon Ross        ACPI_ERROR ((AE_INFO, "Result stack overflow: State=%p Num=%u",
db2bae30SDana Myers            WalkState, WalkState->ResultSize));
db2bae30SDana Myers        return (AE_STACK_OVERFLOW);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    State = AcpiUtCreateGenericState ();
db2bae30SDana Myers    if (!State)
db2bae30SDana Myers    {
db2bae30SDana Myers        return (AE_NO_MEMORY);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    State->Common.DescriptorType = ACPI_DESC_TYPE_STATE_RESULT;
db2bae30SDana Myers    AcpiUtPushGenericState (&WalkState->Results, State);
db2bae30SDana Myers
db2bae30SDana Myers    /* Increase the length of the result stack by the length of frame */
db2bae30SDana Myers
db2bae30SDana Myers    WalkState->ResultSize += ACPI_RESULTS_FRAME_OBJ_NUM;
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Results=%p State=%p\n",
db2bae30SDana Myers        State, WalkState));
db2bae30SDana Myers
db2bae30SDana Myers    return (AE_OK);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiDsResultStackPop
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  WalkState           - Current Walk state
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Status
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Pop an object off of the WalkState result stack
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana Myersstatic ACPI_STATUS
db2bae30SDana MyersAcpiDsResultStackPop (
db2bae30SDana Myers    ACPI_WALK_STATE         *WalkState)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_GENERIC_STATE      *State;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_NAME (DsResultStackPop);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    /* Check for stack underflow */
db2bae30SDana Myers
db2bae30SDana Myers    if (WalkState->Results == NULL)
db2bae30SDana Myers    {
*385cc6b4SJerry Jelinek        ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
*385cc6b4SJerry Jelinek            "Result stack underflow - State=%p\n", WalkState));
db2bae30SDana Myers        return (AE_AML_NO_OPERAND);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    if (WalkState->ResultSize < ACPI_RESULTS_FRAME_OBJ_NUM)
db2bae30SDana Myers    {
db2bae30SDana Myers        ACPI_ERROR ((AE_INFO, "Insufficient result stack size"));
db2bae30SDana Myers        return (AE_AML_INTERNAL);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    State = AcpiUtPopGenericState (&WalkState->Results);
db2bae30SDana Myers    AcpiUtDeleteGenericState (State);
db2bae30SDana Myers
db2bae30SDana Myers    /* Decrease the length of result stack by the length of frame */
db2bae30SDana Myers
db2bae30SDana Myers    WalkState->ResultSize -= ACPI_RESULTS_FRAME_OBJ_NUM;
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
db2bae30SDana Myers        "Result=%p RemainingResults=%X State=%p\n",
db2bae30SDana Myers        State, WalkState->ResultCount, WalkState));
db2bae30SDana Myers
db2bae30SDana Myers    return (AE_OK);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiDsObjStackPush
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  Object              - Object to push
db2bae30SDana Myers *              WalkState           - Current Walk state
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Status
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Push an object onto this walk's object/operand stack
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersACPI_STATUS
db2bae30SDana MyersAcpiDsObjStackPush (
db2bae30SDana Myers    void                    *Object,
db2bae30SDana Myers    ACPI_WALK_STATE         *WalkState)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_FUNCTION_NAME (DsObjStackPush);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    /* Check for stack overflow */
db2bae30SDana Myers
db2bae30SDana Myers    if (WalkState->NumOperands >= ACPI_OBJ_NUM_OPERANDS)
db2bae30SDana Myers    {
db2bae30SDana Myers        ACPI_ERROR ((AE_INFO,
26f3cdf0SGordon Ross            "Object stack overflow! Obj=%p State=%p #Ops=%u",
db2bae30SDana Myers            Object, WalkState, WalkState->NumOperands));
db2bae30SDana Myers        return (AE_STACK_OVERFLOW);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Put the object onto the stack */
db2bae30SDana Myers
db2bae30SDana Myers    WalkState->Operands [WalkState->OperandIndex] = Object;
db2bae30SDana Myers    WalkState->NumOperands++;
db2bae30SDana Myers
db2bae30SDana Myers    /* For the usual order of filling the operand stack */
db2bae30SDana Myers
db2bae30SDana Myers    WalkState->OperandIndex++;
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Obj=%p [%s] State=%p #Ops=%X\n",
db2bae30SDana Myers        Object, AcpiUtGetObjectTypeName ((ACPI_OPERAND_OBJECT *) Object),
db2bae30SDana Myers        WalkState, WalkState->NumOperands));
db2bae30SDana Myers
db2bae30SDana Myers    return (AE_OK);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiDsObjStackPop
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  PopCount            - Number of objects/entries to pop
db2bae30SDana Myers *              WalkState           - Current Walk state
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Status
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Pop this walk's object stack. Objects on the stack are NOT
db2bae30SDana Myers *              deleted by this routine.
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersACPI_STATUS
db2bae30SDana MyersAcpiDsObjStackPop (
db2bae30SDana Myers    UINT32                  PopCount,
db2bae30SDana Myers    ACPI_WALK_STATE         *WalkState)
db2bae30SDana Myers{
db2bae30SDana Myers    UINT32                  i;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_NAME (DsObjStackPop);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    for (i = 0; i < PopCount; i++)
db2bae30SDana Myers    {
db2bae30SDana Myers        /* Check for stack underflow */
db2bae30SDana Myers
db2bae30SDana Myers        if (WalkState->NumOperands == 0)
db2bae30SDana Myers        {
db2bae30SDana Myers            ACPI_ERROR ((AE_INFO,
26f3cdf0SGordon Ross                "Object stack underflow! Count=%X State=%p #Ops=%u",
db2bae30SDana Myers                PopCount, WalkState, WalkState->NumOperands));
db2bae30SDana Myers            return (AE_STACK_UNDERFLOW);
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        /* Just set the stack entry to null */
db2bae30SDana Myers
db2bae30SDana Myers        WalkState->NumOperands--;
db2bae30SDana Myers        WalkState->Operands [WalkState->NumOperands] = NULL;
db2bae30SDana Myers    }
db2bae30SDana Myers
26f3cdf0SGordon Ross    ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Count=%X State=%p #Ops=%u\n",
db2bae30SDana Myers        PopCount, WalkState, WalkState->NumOperands));
db2bae30SDana Myers
db2bae30SDana Myers    return (AE_OK);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiDsObjStackPopAndDelete
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  PopCount            - Number of objects/entries to pop
db2bae30SDana Myers *              WalkState           - Current Walk state
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Status
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Pop this walk's object stack and delete each object that is
db2bae30SDana Myers *              popped off.
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana Myersvoid
db2bae30SDana MyersAcpiDsObjStackPopAndDelete (
db2bae30SDana Myers    UINT32                  PopCount,
db2bae30SDana Myers    ACPI_WALK_STATE         *WalkState)
db2bae30SDana Myers{
db2bae30SDana Myers    INT32                   i;
db2bae30SDana Myers    ACPI_OPERAND_OBJECT     *ObjDesc;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_NAME (DsObjStackPopAndDelete);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    if (PopCount == 0)
db2bae30SDana Myers    {
db2bae30SDana Myers        return;
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    for (i = (INT32) PopCount - 1; i >= 0; i--)
db2bae30SDana Myers    {
db2bae30SDana Myers        if (WalkState->NumOperands == 0)
db2bae30SDana Myers        {
db2bae30SDana Myers            return;
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        /* Pop the stack and delete an object if present in this stack entry */
db2bae30SDana Myers
db2bae30SDana Myers        WalkState->NumOperands--;
db2bae30SDana Myers        ObjDesc = WalkState->Operands [i];
db2bae30SDana Myers        if (ObjDesc)
db2bae30SDana Myers        {
db2bae30SDana Myers            AcpiUtRemoveReference (WalkState->Operands [i]);
db2bae30SDana Myers            WalkState->Operands [i] = NULL;
db2bae30SDana Myers        }
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Count=%X State=%p #Ops=%X\n",
db2bae30SDana Myers        PopCount, WalkState, WalkState->NumOperands));
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiDsGetCurrentWalkState
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  Thread          - Get current active state for this Thread
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Pointer to the current walk state
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Get the walk state that is at the head of the list (the "current"
db2bae30SDana Myers *              walk state.)
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersACPI_WALK_STATE *
db2bae30SDana MyersAcpiDsGetCurrentWalkState (
db2bae30SDana Myers    ACPI_THREAD_STATE       *Thread)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_FUNCTION_NAME (DsGetCurrentWalkState);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    if (!Thread)
db2bae30SDana Myers    {
db2bae30SDana Myers        return (NULL);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_DEBUG_PRINT ((ACPI_DB_PARSE, "Current WalkState %p\n",
db2bae30SDana Myers        Thread->WalkStateList));
db2bae30SDana Myers
db2bae30SDana Myers    return (Thread->WalkStateList);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiDsPushWalkState
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  WalkState       - State to push
db2bae30SDana Myers *              Thread          - Thread state object
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      None
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Place the Thread state at the head of the state list
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana Myersvoid
db2bae30SDana MyersAcpiDsPushWalkState (
db2bae30SDana Myers    ACPI_WALK_STATE         *WalkState,
db2bae30SDana Myers    ACPI_THREAD_STATE       *Thread)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_FUNCTION_TRACE (DsPushWalkState);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    WalkState->Next = Thread->WalkStateList;
db2bae30SDana Myers    Thread->WalkStateList = WalkState;
db2bae30SDana Myers
db2bae30SDana Myers    return_VOID;
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiDsPopWalkState
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  Thread      - Current thread state
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      A WalkState object popped from the thread's stack
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Remove and return the walkstate object that is at the head of
db2bae30SDana Myers *              the walk stack for the given walk list. NULL indicates that
db2bae30SDana Myers *              the list is empty.
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersACPI_WALK_STATE *
db2bae30SDana MyersAcpiDsPopWalkState (
db2bae30SDana Myers    ACPI_THREAD_STATE       *Thread)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_WALK_STATE         *WalkState;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_TRACE (DsPopWalkState);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    WalkState = Thread->WalkStateList;
db2bae30SDana Myers
db2bae30SDana Myers    if (WalkState)
db2bae30SDana Myers    {
db2bae30SDana Myers        /* Next walk state becomes the current walk state */
db2bae30SDana Myers
db2bae30SDana Myers        Thread->WalkStateList = WalkState->Next;
db2bae30SDana Myers
db2bae30SDana Myers        /*
db2bae30SDana Myers         * Don't clear the NEXT field, this serves as an indicator
db2bae30SDana Myers         * that there is a parent WALK STATE
db2bae30SDana Myers         * Do Not: WalkState->Next = NULL;
db2bae30SDana Myers         */
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    return_PTR (WalkState);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiDsCreateWalkState
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  OwnerId         - ID for object creation
db2bae30SDana Myers *              Origin          - Starting point for this walk
db2bae30SDana Myers *              MethodDesc      - Method object
db2bae30SDana Myers *              Thread          - Current thread state
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Pointer to the new walk state.
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Allocate and initialize a new walk state. The current walk
db2bae30SDana Myers *              state is set to this new state.
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersACPI_WALK_STATE *
db2bae30SDana MyersAcpiDsCreateWalkState (
db2bae30SDana Myers    ACPI_OWNER_ID           OwnerId,
db2bae30SDana Myers    ACPI_PARSE_OBJECT       *Origin,
db2bae30SDana Myers    ACPI_OPERAND_OBJECT     *MethodDesc,
db2bae30SDana Myers    ACPI_THREAD_STATE       *Thread)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_WALK_STATE         *WalkState;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_TRACE (DsCreateWalkState);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    WalkState = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_WALK_STATE));
db2bae30SDana Myers    if (!WalkState)
db2bae30SDana Myers    {
db2bae30SDana Myers        return_PTR (NULL);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    WalkState->DescriptorType = ACPI_DESC_TYPE_WALK;
db2bae30SDana Myers    WalkState->MethodDesc = MethodDesc;
db2bae30SDana Myers    WalkState->OwnerId = OwnerId;
db2bae30SDana Myers    WalkState->Origin = Origin;
db2bae30SDana Myers    WalkState->Thread = Thread;
db2bae30SDana Myers
db2bae30SDana Myers    WalkState->ParserState.StartOp = Origin;
db2bae30SDana Myers
db2bae30SDana Myers    /* Init the method args/local */
db2bae30SDana Myers
db2bae30SDana Myers#if (!defined (ACPI_NO_METHOD_EXECUTION) && !defined (ACPI_CONSTANT_EVAL_ONLY))
db2bae30SDana Myers    AcpiDsMethodDataInit (WalkState);
db2bae30SDana Myers#endif
db2bae30SDana Myers
db2bae30SDana Myers    /* Put the new state at the head of the walk list */
db2bae30SDana Myers
db2bae30SDana Myers    if (Thread)
db2bae30SDana Myers    {
db2bae30SDana Myers        AcpiDsPushWalkState (WalkState, Thread);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    return_PTR (WalkState);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiDsInitAmlWalk
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  WalkState       - New state to be initialized
db2bae30SDana Myers *              Op              - Current parse op
db2bae30SDana Myers *              MethodNode      - Control method NS node, if any
db2bae30SDana Myers *              AmlStart        - Start of AML
db2bae30SDana Myers *              AmlLength       - Length of AML
db2bae30SDana Myers *              Info            - Method info block (params, etc.)
db2bae30SDana Myers *              PassNumber      - 1, 2, or 3
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Status
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Initialize a walk state for a pass 1 or 2 parse tree walk
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersACPI_STATUS
db2bae30SDana MyersAcpiDsInitAmlWalk (
db2bae30SDana Myers    ACPI_WALK_STATE         *WalkState,
db2bae30SDana Myers    ACPI_PARSE_OBJECT       *Op,
db2bae30SDana Myers    ACPI_NAMESPACE_NODE     *MethodNode,
db2bae30SDana Myers    UINT8                   *AmlStart,
db2bae30SDana Myers    UINT32                  AmlLength,
db2bae30SDana Myers    ACPI_EVALUATE_INFO      *Info,
db2bae30SDana Myers    UINT8                   PassNumber)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_STATUS             Status;
db2bae30SDana Myers    ACPI_PARSE_STATE        *ParserState = &WalkState->ParserState;
db2bae30SDana Myers    ACPI_PARSE_OBJECT       *ExtraOp;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_TRACE (DsInitAmlWalk);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    WalkState->ParserState.Aml =
db2bae30SDana Myers    WalkState->ParserState.AmlStart = AmlStart;
db2bae30SDana Myers    WalkState->ParserState.AmlEnd =
db2bae30SDana Myers    WalkState->ParserState.PkgEnd = AmlStart + AmlLength;
db2bae30SDana Myers
db2bae30SDana Myers    /* The NextOp of the NextWalk will be the beginning of the method */
db2bae30SDana Myers
db2bae30SDana Myers    WalkState->NextOp = NULL;
db2bae30SDana Myers    WalkState->PassNumber = PassNumber;
db2bae30SDana Myers
db2bae30SDana Myers    if (Info)
db2bae30SDana Myers    {
db2bae30SDana Myers        WalkState->Params = Info->Parameters;
db2bae30SDana Myers        WalkState->CallerReturnDesc = &Info->ReturnObject;
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    Status = AcpiPsInitScope (&WalkState->ParserState, Op);
db2bae30SDana Myers    if (ACPI_FAILURE (Status))
db2bae30SDana Myers    {
db2bae30SDana Myers        return_ACPI_STATUS (Status);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    if (MethodNode)
db2bae30SDana Myers    {
db2bae30SDana Myers        WalkState->ParserState.StartNode = MethodNode;
db2bae30SDana Myers        WalkState->WalkType = ACPI_WALK_METHOD;
db2bae30SDana Myers        WalkState->MethodNode = MethodNode;
db2bae30SDana Myers        WalkState->MethodDesc = AcpiNsGetAttachedObject (MethodNode);
db2bae30SDana Myers
db2bae30SDana Myers        /* Push start scope on scope stack and make it current  */
db2bae30SDana Myers
*385cc6b4SJerry Jelinek        Status = AcpiDsScopeStackPush (
*385cc6b4SJerry Jelinek            MethodNode, ACPI_TYPE_METHOD, WalkState);
db2bae30SDana Myers        if (ACPI_FAILURE (Status))
db2bae30SDana Myers        {
db2bae30SDana Myers            return_ACPI_STATUS (Status);
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        /* Init the method arguments */
db2bae30SDana Myers
db2bae30SDana Myers        Status = AcpiDsMethodDataInitArgs (WalkState->Params,
db2bae30SDana Myers                    ACPI_METHOD_NUM_ARGS, WalkState);
db2bae30SDana Myers        if (ACPI_FAILURE (Status))
db2bae30SDana Myers        {
db2bae30SDana Myers            return_ACPI_STATUS (Status);
db2bae30SDana Myers        }
db2bae30SDana Myers    }
db2bae30SDana Myers    else
db2bae30SDana Myers    {
db2bae30SDana Myers        /*
db2bae30SDana Myers         * Setup the current scope.
db2bae30SDana Myers         * Find a Named Op that has a namespace node associated with it.
db2bae30SDana Myers         * search upwards from this Op. Current scope is the first
db2bae30SDana Myers         * Op with a namespace node.
db2bae30SDana Myers         */
db2bae30SDana Myers        ExtraOp = ParserState->StartOp;
db2bae30SDana Myers        while (ExtraOp && !ExtraOp->Common.Node)
db2bae30SDana Myers        {
db2bae30SDana Myers            ExtraOp = ExtraOp->Common.Parent;
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        if (!ExtraOp)
db2bae30SDana Myers        {
db2bae30SDana Myers            ParserState->StartNode = NULL;
db2bae30SDana Myers        }
db2bae30SDana Myers        else
db2bae30SDana Myers        {
db2bae30SDana Myers            ParserState->StartNode = ExtraOp->Common.Node;
db2bae30SDana Myers        }
db2bae30SDana Myers
db2bae30SDana Myers        if (ParserState->StartNode)
db2bae30SDana Myers        {
db2bae30SDana Myers            /* Push start scope on scope stack and make it current  */
db2bae30SDana Myers
db2bae30SDana Myers            Status = AcpiDsScopeStackPush (ParserState->StartNode,
db2bae30SDana Myers                ParserState->StartNode->Type, WalkState);
db2bae30SDana Myers            if (ACPI_FAILURE (Status))
db2bae30SDana Myers            {
db2bae30SDana Myers                return_ACPI_STATUS (Status);
db2bae30SDana Myers            }
db2bae30SDana Myers        }
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    Status = AcpiDsInitCallbacks (WalkState, PassNumber);
db2bae30SDana Myers    return_ACPI_STATUS (Status);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiDsDeleteWalkState
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  WalkState       - State to delete
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Status
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Delete a walk state including all internal data structures
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana Myersvoid
db2bae30SDana MyersAcpiDsDeleteWalkState (
db2bae30SDana Myers    ACPI_WALK_STATE         *WalkState)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_GENERIC_STATE      *State;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_TRACE_PTR (DsDeleteWalkState, WalkState);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    if (!WalkState)
db2bae30SDana Myers    {
*385cc6b4SJerry Jelinek        return_VOID;
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    if (WalkState->DescriptorType != ACPI_DESC_TYPE_WALK)
db2bae30SDana Myers    {
db2bae30SDana Myers        ACPI_ERROR ((AE_INFO, "%p is not a valid walk state",
db2bae30SDana Myers            WalkState));
*385cc6b4SJerry Jelinek        return_VOID;
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* There should not be any open scopes */
db2bae30SDana Myers
db2bae30SDana Myers    if (WalkState->ParserState.Scope)
db2bae30SDana Myers    {
db2bae30SDana Myers        ACPI_ERROR ((AE_INFO, "%p walk still has a scope list",
db2bae30SDana Myers            WalkState));
db2bae30SDana Myers        AcpiPsCleanupScope (&WalkState->ParserState);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Always must free any linked control states */
db2bae30SDana Myers
db2bae30SDana Myers    while (WalkState->ControlState)
db2bae30SDana Myers    {
db2bae30SDana Myers        State = WalkState->ControlState;
db2bae30SDana Myers        WalkState->ControlState = State->Common.Next;
db2bae30SDana Myers
db2bae30SDana Myers        AcpiUtDeleteGenericState (State);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Always must free any linked parse states */
db2bae30SDana Myers
db2bae30SDana Myers    while (WalkState->ScopeInfo)
db2bae30SDana Myers    {
db2bae30SDana Myers        State = WalkState->ScopeInfo;
db2bae30SDana Myers        WalkState->ScopeInfo = State->Common.Next;
db2bae30SDana Myers
db2bae30SDana Myers        AcpiUtDeleteGenericState (State);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Always must free any stacked result states */
db2bae30SDana Myers
db2bae30SDana Myers    while (WalkState->Results)
db2bae30SDana Myers    {
db2bae30SDana Myers        State = WalkState->Results;
db2bae30SDana Myers        WalkState->Results = State->Common.Next;
db2bae30SDana Myers
db2bae30SDana Myers        AcpiUtDeleteGenericState (State);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FREE (WalkState);
db2bae30SDana Myers    return_VOID;
db2bae30SDana Myers}