psscope.c revision 7b1019a6d29ccb7999dc76cba3dde1c627e8e609
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy/******************************************************************************
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy *
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * Module Name: psscope - Parser scope stack management routines
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy *
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy *****************************************************************************/
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy/*
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * Copyright (C) 2000 - 2016, Intel Corp.
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * All rights reserved.
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy *
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * Redistribution and use in source and binary forms, with or without
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * modification, are permitted provided that the following conditions
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * are met:
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * 1. Redistributions of source code must retain the above copyright
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * notice, this list of conditions, and the following disclaimer,
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * without modification.
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * 2. Redistributions in binary form must reproduce at minimum a disclaimer
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * substantially similar to the "NO WARRANTY" disclaimer below
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * ("Disclaimer") and any redistribution must be conditioned upon
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * including a substantially similar Disclaimer requirement for further
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * binary redistribution.
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * 3. Neither the names of the above-listed copyright holders nor the names
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * of any contributors may be used to endorse or promote products derived
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * from this software without specific prior written permission.
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy *
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * Alternatively, this software may be distributed under the terms of the
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * GNU General Public License ("GPL") version 2 as published by the Free
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * Software Foundation.
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy *
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * NO WARRANTY
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * POSSIBILITY OF SUCH DAMAGES.
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy */
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy#include "acpi.h"
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy#include "accommon.h"
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy#include "acparser.h"
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy#define _COMPONENT ACPI_PARSER
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy ACPI_MODULE_NAME ("psscope")
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy/*******************************************************************************
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy *
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * FUNCTION: AcpiPsGetParentScope
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy *
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * PARAMETERS: ParserState - Current parser state object
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy *
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * RETURN: Pointer to an Op object
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy *
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * DESCRIPTION: Get parent of current op being parsed
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy *
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy ******************************************************************************/
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren KennedyACPI_PARSE_OBJECT *
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren KennedyAcpiPsGetParentScope (
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy ACPI_PARSE_STATE *ParserState)
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy{
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy return (ParserState->Scope->ParseScope.Op);
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy}
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy/*******************************************************************************
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy *
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * FUNCTION: AcpiPsHasCompletedScope
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy *
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * PARAMETERS: ParserState - Current parser state object
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy *
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * RETURN: Boolean, TRUE = scope completed.
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy *
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * DESCRIPTION: Is parsing of current argument complete? Determined by
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * 1) AML pointer is at or beyond the end of the scope
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * 2) The scope argument count has reached zero.
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy *
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy ******************************************************************************/
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren KennedyBOOLEAN
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren KennedyAcpiPsHasCompletedScope (
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy ACPI_PARSE_STATE *ParserState)
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy{
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy return ((BOOLEAN)
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy ((ParserState->Aml >= ParserState->Scope->ParseScope.ArgEnd ||
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy !ParserState->Scope->ParseScope.ArgCount)));
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy}
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy/*******************************************************************************
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy *
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * FUNCTION: AcpiPsInitScope
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy *
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * PARAMETERS: ParserState - Current parser state object
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * Root - the Root Node of this new scope
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy *
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * RETURN: Status
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy *
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * DESCRIPTION: Allocate and init a new scope object
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy *
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy ******************************************************************************/
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren KennedyACPI_STATUS
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren KennedyAcpiPsInitScope (
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy ACPI_PARSE_STATE *ParserState,
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy ACPI_PARSE_OBJECT *RootOp)
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy{
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy ACPI_GENERIC_STATE *Scope;
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy ACPI_FUNCTION_TRACE_PTR (PsInitScope, RootOp);
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy Scope = AcpiUtCreateGenericState ();
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy if (!Scope)
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy {
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy return_ACPI_STATUS (AE_NO_MEMORY);
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy }
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy Scope->Common.DescriptorType = ACPI_DESC_TYPE_STATE_RPSCOPE;
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy Scope->ParseScope.Op = RootOp;
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy Scope->ParseScope.ArgCount = ACPI_VAR_ARGS;
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy Scope->ParseScope.ArgEnd = ParserState->AmlEnd;
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy Scope->ParseScope.PkgEnd = ParserState->AmlEnd;
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy ParserState->Scope = Scope;
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy ParserState->StartOp = RootOp;
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy return_ACPI_STATUS (AE_OK);
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy}
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy/*******************************************************************************
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy *
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * FUNCTION: AcpiPsPushScope
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy *
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * PARAMETERS: ParserState - Current parser state object
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * Op - Current op to be pushed
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * RemainingArgs - List of args remaining
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * ArgCount - Fixed or variable number of args
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy *
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * RETURN: Status
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy *
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * DESCRIPTION: Push current op to begin parsing its argument
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy *
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy ******************************************************************************/
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren KennedyACPI_STATUS
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren KennedyAcpiPsPushScope (
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy ACPI_PARSE_STATE *ParserState,
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy ACPI_PARSE_OBJECT *Op,
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy UINT32 RemainingArgs,
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy UINT32 ArgCount)
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy{
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy ACPI_GENERIC_STATE *Scope;
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy ACPI_FUNCTION_TRACE_PTR (PsPushScope, Op);
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy Scope = AcpiUtCreateGenericState ();
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy if (!Scope)
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy {
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy return_ACPI_STATUS (AE_NO_MEMORY);
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy }
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy Scope->Common.DescriptorType = ACPI_DESC_TYPE_STATE_PSCOPE;
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy Scope->ParseScope.Op = Op;
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy Scope->ParseScope.ArgList = RemainingArgs;
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy Scope->ParseScope.ArgCount = ArgCount;
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy Scope->ParseScope.PkgEnd = ParserState->PkgEnd;
/* Push onto scope stack */
AcpiUtPushGenericState (&ParserState->Scope, Scope);
if (ArgCount == ACPI_VAR_ARGS)
{
/* Multiple arguments */
Scope->ParseScope.ArgEnd = ParserState->PkgEnd;
}
else
{
/* Single argument */
Scope->ParseScope.ArgEnd = ACPI_TO_POINTER (ACPI_MAX_PTR);
}
return_ACPI_STATUS (AE_OK);
}
/*******************************************************************************
*
* FUNCTION: AcpiPsPopScope
*
* PARAMETERS: ParserState - Current parser state object
* Op - Where the popped op is returned
* ArgList - Where the popped "next argument" is
* returned
* ArgCount - Count of objects in ArgList
*
* RETURN: Status
*
* DESCRIPTION: Return to parsing a previous op
*
******************************************************************************/
void
AcpiPsPopScope (
ACPI_PARSE_STATE *ParserState,
ACPI_PARSE_OBJECT **Op,
UINT32 *ArgList,
UINT32 *ArgCount)
{
ACPI_GENERIC_STATE *Scope = ParserState->Scope;
ACPI_FUNCTION_TRACE (PsPopScope);
/* Only pop the scope if there is in fact a next scope */
if (Scope->Common.Next)
{
Scope = AcpiUtPopGenericState (&ParserState->Scope);
/* Return to parsing previous op */
*Op = Scope->ParseScope.Op;
*ArgList = Scope->ParseScope.ArgList;
*ArgCount = Scope->ParseScope.ArgCount;
ParserState->PkgEnd = Scope->ParseScope.PkgEnd;
/* All done with this scope state structure */
AcpiUtDeleteGenericState (Scope);
}
else
{
/* Empty parse stack, prepare to fetch next opcode */
*Op = NULL;
*ArgList = 0;
*ArgCount = 0;
}
ACPI_DEBUG_PRINT ((ACPI_DB_PARSE,
"Popped Op %p Args %X\n", *Op, *ArgCount));
return_VOID;
}
/*******************************************************************************
*
* FUNCTION: AcpiPsCleanupScope
*
* PARAMETERS: ParserState - Current parser state object
*
* RETURN: None
*
* DESCRIPTION: Destroy available list, remaining stack levels, and return
* root scope
*
******************************************************************************/
void
AcpiPsCleanupScope (
ACPI_PARSE_STATE *ParserState)
{
ACPI_GENERIC_STATE *Scope;
ACPI_FUNCTION_TRACE_PTR (PsCleanupScope, ParserState);
if (!ParserState)
{
return_VOID;
}
/* Delete anything on the scope stack */
while (ParserState->Scope)
{
Scope = AcpiUtPopGenericState (&ParserState->Scope);
AcpiUtDeleteGenericState (Scope);
}
return_VOID;
}