acpica/parser/psscope.c

db2bae30SDana Myers/******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * Module Name: psscope - Parser scope stack 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
db2bae30SDana Myers#define _COMPONENT          ACPI_PARSER
db2bae30SDana Myers        ACPI_MODULE_NAME    ("psscope")
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiPsGetParentScope
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  ParserState         - Current parser state object
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Pointer to an Op object
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Get parent of current op being parsed
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersACPI_PARSE_OBJECT *
db2bae30SDana MyersAcpiPsGetParentScope (
db2bae30SDana Myers    ACPI_PARSE_STATE        *ParserState)
db2bae30SDana Myers{
db2bae30SDana Myers
db2bae30SDana Myers    return (ParserState->Scope->ParseScope.Op);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiPsHasCompletedScope
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  ParserState         - Current parser state object
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Boolean, TRUE = scope completed.
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Is parsing of current argument complete?  Determined by
db2bae30SDana Myers *              1) AML pointer is at or beyond the end of the scope
db2bae30SDana Myers *              2) The scope argument count has reached zero.
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersBOOLEAN
db2bae30SDana MyersAcpiPsHasCompletedScope (
db2bae30SDana Myers    ACPI_PARSE_STATE        *ParserState)
db2bae30SDana Myers{
db2bae30SDana Myers
db2bae30SDana Myers    return ((BOOLEAN)
db2bae30SDana Myers            ((ParserState->Aml >= ParserState->Scope->ParseScope.ArgEnd ||
db2bae30SDana Myers             !ParserState->Scope->ParseScope.ArgCount)));
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiPsInitScope
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  ParserState         - Current parser state object
db2bae30SDana Myers *              Root                - the Root Node of this new scope
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Status
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Allocate and init a new scope object
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersACPI_STATUS
db2bae30SDana MyersAcpiPsInitScope (
db2bae30SDana Myers    ACPI_PARSE_STATE        *ParserState,
db2bae30SDana Myers    ACPI_PARSE_OBJECT       *RootOp)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_GENERIC_STATE      *Scope;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_TRACE_PTR (PsInitScope, RootOp);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    Scope = AcpiUtCreateGenericState ();
db2bae30SDana Myers    if (!Scope)
db2bae30SDana Myers    {
db2bae30SDana Myers        return_ACPI_STATUS (AE_NO_MEMORY);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    Scope->Common.DescriptorType = ACPI_DESC_TYPE_STATE_RPSCOPE;
db2bae30SDana Myers    Scope->ParseScope.Op = RootOp;
db2bae30SDana Myers    Scope->ParseScope.ArgCount = ACPI_VAR_ARGS;
db2bae30SDana Myers    Scope->ParseScope.ArgEnd = ParserState->AmlEnd;
db2bae30SDana Myers    Scope->ParseScope.PkgEnd = ParserState->AmlEnd;
db2bae30SDana Myers
db2bae30SDana Myers    ParserState->Scope = Scope;
db2bae30SDana Myers    ParserState->StartOp = RootOp;
db2bae30SDana Myers
db2bae30SDana Myers    return_ACPI_STATUS (AE_OK);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiPsPushScope
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  ParserState         - Current parser state object
db2bae30SDana Myers *              Op                  - Current op to be pushed
db2bae30SDana Myers *              RemainingArgs       - List of args remaining
db2bae30SDana Myers *              ArgCount            - Fixed or variable number of args
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Status
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Push current op to begin parsing its argument
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersACPI_STATUS
db2bae30SDana MyersAcpiPsPushScope (
db2bae30SDana Myers    ACPI_PARSE_STATE        *ParserState,
db2bae30SDana Myers    ACPI_PARSE_OBJECT       *Op,
db2bae30SDana Myers    UINT32                  RemainingArgs,
db2bae30SDana Myers    UINT32                  ArgCount)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_GENERIC_STATE      *Scope;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_TRACE_PTR (PsPushScope, Op);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    Scope = AcpiUtCreateGenericState ();
db2bae30SDana Myers    if (!Scope)
db2bae30SDana Myers    {
db2bae30SDana Myers        return_ACPI_STATUS (AE_NO_MEMORY);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    Scope->Common.DescriptorType = ACPI_DESC_TYPE_STATE_PSCOPE;
db2bae30SDana Myers    Scope->ParseScope.Op = Op;
db2bae30SDana Myers    Scope->ParseScope.ArgList = RemainingArgs;
db2bae30SDana Myers    Scope->ParseScope.ArgCount = ArgCount;
db2bae30SDana Myers    Scope->ParseScope.PkgEnd = ParserState->PkgEnd;
db2bae30SDana Myers
db2bae30SDana Myers    /* Push onto scope stack */
db2bae30SDana Myers
db2bae30SDana Myers    AcpiUtPushGenericState (&ParserState->Scope, Scope);
db2bae30SDana Myers
db2bae30SDana Myers    if (ArgCount == ACPI_VAR_ARGS)
db2bae30SDana Myers    {
db2bae30SDana Myers        /* Multiple arguments */
db2bae30SDana Myers
db2bae30SDana Myers        Scope->ParseScope.ArgEnd = ParserState->PkgEnd;
db2bae30SDana Myers    }
db2bae30SDana Myers    else
db2bae30SDana Myers    {
db2bae30SDana Myers        /* Single argument */
db2bae30SDana Myers
db2bae30SDana Myers        Scope->ParseScope.ArgEnd = ACPI_TO_POINTER (ACPI_MAX_PTR);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    return_ACPI_STATUS (AE_OK);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiPsPopScope
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  ParserState         - Current parser state object
db2bae30SDana Myers *              Op                  - Where the popped op is returned
db2bae30SDana Myers *              ArgList             - Where the popped "next argument" is
db2bae30SDana Myers *                                    returned
db2bae30SDana Myers *              ArgCount            - Count of objects in ArgList
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Status
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Return to parsing a previous op
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana Myersvoid
db2bae30SDana MyersAcpiPsPopScope (
db2bae30SDana Myers    ACPI_PARSE_STATE        *ParserState,
db2bae30SDana Myers    ACPI_PARSE_OBJECT       **Op,
db2bae30SDana Myers    UINT32                  *ArgList,
db2bae30SDana Myers    UINT32                  *ArgCount)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_GENERIC_STATE      *Scope = ParserState->Scope;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_TRACE (PsPopScope);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    /* Only pop the scope if there is in fact a next scope */
db2bae30SDana Myers
db2bae30SDana Myers    if (Scope->Common.Next)
db2bae30SDana Myers    {
db2bae30SDana Myers        Scope = AcpiUtPopGenericState (&ParserState->Scope);
db2bae30SDana Myers
db2bae30SDana Myers        /* Return to parsing previous op */
db2bae30SDana Myers
db2bae30SDana Myers        *Op = Scope->ParseScope.Op;
db2bae30SDana Myers        *ArgList = Scope->ParseScope.ArgList;
db2bae30SDana Myers        *ArgCount = Scope->ParseScope.ArgCount;
db2bae30SDana Myers        ParserState->PkgEnd = Scope->ParseScope.PkgEnd;
db2bae30SDana Myers
db2bae30SDana Myers        /* All done with this scope state structure */
db2bae30SDana Myers
db2bae30SDana Myers        AcpiUtDeleteGenericState (Scope);
db2bae30SDana Myers    }
db2bae30SDana Myers    else
db2bae30SDana Myers    {
db2bae30SDana Myers        /* Empty parse stack, prepare to fetch next opcode */
db2bae30SDana Myers
db2bae30SDana Myers        *Op = NULL;
db2bae30SDana Myers        *ArgList = 0;
db2bae30SDana Myers        *ArgCount = 0;
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_DEBUG_PRINT ((ACPI_DB_PARSE,
db2bae30SDana Myers        "Popped Op %p Args %X\n", *Op, *ArgCount));
db2bae30SDana Myers    return_VOID;
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiPsCleanupScope
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  ParserState         - Current parser state object
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      None
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Destroy available list, remaining stack levels, and return
db2bae30SDana Myers *              root scope
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana Myersvoid
db2bae30SDana MyersAcpiPsCleanupScope (
db2bae30SDana Myers    ACPI_PARSE_STATE        *ParserState)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_GENERIC_STATE      *Scope;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_TRACE_PTR (PsCleanupScope, ParserState);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    if (!ParserState)
db2bae30SDana Myers    {
db2bae30SDana Myers        return_VOID;
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    /* Delete anything on the scope stack */
db2bae30SDana Myers
db2bae30SDana Myers    while (ParserState->Scope)
db2bae30SDana Myers    {
db2bae30SDana Myers        Scope = AcpiUtPopGenericState (&ParserState->Scope);
db2bae30SDana Myers        AcpiUtDeleteGenericState (Scope);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    return_VOID;
db2bae30SDana Myers}