acpica/dispatcher/dswscope.c

db2bae30SDana Myers/******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * Module Name: dswscope - Scope stack manipulation
db2bae30SDana Myers *
db2bae30SDana Myers *****************************************************************************/
db2bae30SDana Myers
26f3cdf0SGordon Ross/*
*cb565728SJerry 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 "acdispat.h"
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers#define _COMPONENT          ACPI_DISPATCHER
db2bae30SDana Myers        ACPI_MODULE_NAME    ("dswscope")
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/****************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiDsScopeStackClear
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  WalkState       - Current state
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      None
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Pop (and free) everything on the scope stack except the
db2bae30SDana Myers *              root scope object (which remains at the stack top.)
db2bae30SDana Myers *
db2bae30SDana Myers ***************************************************************************/
db2bae30SDana Myers
db2bae30SDana Myersvoid
db2bae30SDana MyersAcpiDsScopeStackClear (
db2bae30SDana Myers    ACPI_WALK_STATE         *WalkState)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_GENERIC_STATE      *ScopeInfo;
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_NAME (DsScopeStackClear);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    while (WalkState->ScopeInfo)
db2bae30SDana Myers    {
db2bae30SDana Myers        /* Pop a scope off the stack */
db2bae30SDana Myers
db2bae30SDana Myers        ScopeInfo = WalkState->ScopeInfo;
db2bae30SDana Myers        WalkState->ScopeInfo = ScopeInfo->Scope.Next;
db2bae30SDana Myers
db2bae30SDana Myers        ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
db2bae30SDana Myers            "Popped object type (%s)\n",
db2bae30SDana Myers            AcpiUtGetTypeName (ScopeInfo->Common.Value)));
*cb565728SJerry Jelinek
db2bae30SDana Myers        AcpiUtDeleteGenericState (ScopeInfo);
db2bae30SDana Myers    }
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/****************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiDsScopeStackPush
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  Node            - Name to be made current
db2bae30SDana Myers *              Type            - Type of frame being pushed
db2bae30SDana Myers *              WalkState       - Current state
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Status
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Push the current scope on the scope stack, and make the
db2bae30SDana Myers *              passed Node current.
db2bae30SDana Myers *
db2bae30SDana Myers ***************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersACPI_STATUS
db2bae30SDana MyersAcpiDsScopeStackPush (
db2bae30SDana Myers    ACPI_NAMESPACE_NODE     *Node,
db2bae30SDana Myers    ACPI_OBJECT_TYPE        Type,
db2bae30SDana Myers    ACPI_WALK_STATE         *WalkState)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_GENERIC_STATE      *ScopeInfo;
db2bae30SDana Myers    ACPI_GENERIC_STATE      *OldScopeInfo;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_TRACE (DsScopeStackPush);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    if (!Node)
db2bae30SDana Myers    {
db2bae30SDana Myers        /* Invalid scope   */
db2bae30SDana Myers
db2bae30SDana Myers        ACPI_ERROR ((AE_INFO, "Null scope parameter"));
db2bae30SDana Myers        return_ACPI_STATUS (AE_BAD_PARAMETER);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Make sure object type is valid */
db2bae30SDana Myers
db2bae30SDana Myers    if (!AcpiUtValidObjectType (Type))
db2bae30SDana Myers    {
db2bae30SDana Myers        ACPI_WARNING ((AE_INFO,
db2bae30SDana Myers            "Invalid object type: 0x%X", Type));
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Allocate a new scope object */
db2bae30SDana Myers
db2bae30SDana Myers    ScopeInfo = AcpiUtCreateGenericState ();
db2bae30SDana Myers    if (!ScopeInfo)
db2bae30SDana Myers    {
db2bae30SDana Myers        return_ACPI_STATUS (AE_NO_MEMORY);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Init new scope object */
db2bae30SDana Myers
db2bae30SDana Myers    ScopeInfo->Common.DescriptorType = ACPI_DESC_TYPE_STATE_WSCOPE;
db2bae30SDana Myers    ScopeInfo->Scope.Node = Node;
db2bae30SDana Myers    ScopeInfo->Common.Value = (UINT16) Type;
db2bae30SDana Myers
db2bae30SDana Myers    WalkState->ScopeDepth++;
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
db2bae30SDana Myers        "[%.2d] Pushed scope ", (UINT32) WalkState->ScopeDepth));
db2bae30SDana Myers
db2bae30SDana Myers    OldScopeInfo = WalkState->ScopeInfo;
db2bae30SDana Myers    if (OldScopeInfo)
db2bae30SDana Myers    {
db2bae30SDana Myers        ACPI_DEBUG_PRINT_RAW ((ACPI_DB_EXEC,
db2bae30SDana Myers            "[%4.4s] (%s)",
db2bae30SDana Myers            AcpiUtGetNodeName (OldScopeInfo->Scope.Node),
db2bae30SDana Myers            AcpiUtGetTypeName (OldScopeInfo->Common.Value)));
db2bae30SDana Myers    }
db2bae30SDana Myers    else
db2bae30SDana Myers    {
db2bae30SDana Myers        ACPI_DEBUG_PRINT_RAW ((ACPI_DB_EXEC,
db2bae30SDana Myers            "[\\___] (%s)", "ROOT"));
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_DEBUG_PRINT_RAW ((ACPI_DB_EXEC,
db2bae30SDana Myers        ", New scope -> [%4.4s] (%s)\n",
db2bae30SDana Myers        AcpiUtGetNodeName (ScopeInfo->Scope.Node),
db2bae30SDana Myers        AcpiUtGetTypeName (ScopeInfo->Common.Value)));
db2bae30SDana Myers
db2bae30SDana Myers    /* Push new scope object onto stack */
db2bae30SDana Myers
db2bae30SDana Myers    AcpiUtPushGenericState (&WalkState->ScopeInfo, ScopeInfo);
db2bae30SDana Myers    return_ACPI_STATUS (AE_OK);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/****************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiDsScopeStackPop
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  WalkState       - Current state
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Status
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Pop the scope stack once.
db2bae30SDana Myers *
db2bae30SDana Myers ***************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersACPI_STATUS
db2bae30SDana MyersAcpiDsScopeStackPop (
db2bae30SDana Myers    ACPI_WALK_STATE         *WalkState)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_GENERIC_STATE      *ScopeInfo;
db2bae30SDana Myers    ACPI_GENERIC_STATE      *NewScopeInfo;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_TRACE (DsScopeStackPop);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    /*
db2bae30SDana Myers     * Pop scope info object off the stack.
db2bae30SDana Myers     */
db2bae30SDana Myers    ScopeInfo = AcpiUtPopGenericState (&WalkState->ScopeInfo);
db2bae30SDana Myers    if (!ScopeInfo)
db2bae30SDana Myers    {
db2bae30SDana Myers        return_ACPI_STATUS (AE_STACK_UNDERFLOW);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    WalkState->ScopeDepth--;
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
db2bae30SDana Myers        "[%.2d] Popped scope [%4.4s] (%s), New scope -> ",
db2bae30SDana Myers        (UINT32) WalkState->ScopeDepth,
db2bae30SDana Myers        AcpiUtGetNodeName (ScopeInfo->Scope.Node),
db2bae30SDana Myers        AcpiUtGetTypeName (ScopeInfo->Common.Value)));
db2bae30SDana Myers
db2bae30SDana Myers    NewScopeInfo = WalkState->ScopeInfo;
db2bae30SDana Myers    if (NewScopeInfo)
db2bae30SDana Myers    {
db2bae30SDana Myers        ACPI_DEBUG_PRINT_RAW ((ACPI_DB_EXEC,
db2bae30SDana Myers            "[%4.4s] (%s)\n",
db2bae30SDana Myers            AcpiUtGetNodeName (NewScopeInfo->Scope.Node),
db2bae30SDana Myers            AcpiUtGetTypeName (NewScopeInfo->Common.Value)));
db2bae30SDana Myers    }
db2bae30SDana Myers    else
db2bae30SDana Myers    {
db2bae30SDana Myers        ACPI_DEBUG_PRINT_RAW ((ACPI_DB_EXEC,
db2bae30SDana Myers            "[\\___] (ROOT)\n"));
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    AcpiUtDeleteGenericState (ScopeInfo);
db2bae30SDana Myers    return_ACPI_STATUS (AE_OK);
db2bae30SDana Myers}