psscope.c revision 151937
167754Smsmith/****************************************************************************** 267754Smsmith * 367754Smsmith * Module Name: psscope - Parser scope stack management routines 4151937Sjkim * $Revision: 1.42 $ 567754Smsmith * 667754Smsmith *****************************************************************************/ 767754Smsmith 867754Smsmith/****************************************************************************** 967754Smsmith * 1067754Smsmith * 1. Copyright Notice 1167754Smsmith * 12151937Sjkim * Some or all of this work - Copyright (c) 1999 - 2005, Intel Corp. 1370243Smsmith * All rights reserved. 1467754Smsmith * 1567754Smsmith * 2. License 1667754Smsmith * 1767754Smsmith * 2.1. This is your license from Intel Corp. under its intellectual property 1867754Smsmith * rights. You may have additional license terms from the party that provided 1967754Smsmith * you this software, covering your right to use that party's intellectual 2067754Smsmith * property rights. 2167754Smsmith * 2267754Smsmith * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 2367754Smsmith * copy of the source code appearing in this file ("Covered Code") an 2467754Smsmith * irrevocable, perpetual, worldwide license under Intel's copyrights in the 2567754Smsmith * base code distributed originally by Intel ("Original Intel Code") to copy, 2667754Smsmith * make derivatives, distribute, use and display any portion of the Covered 2767754Smsmith * Code in any form, with the right to sublicense such rights; and 2867754Smsmith * 2967754Smsmith * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 3067754Smsmith * license (with the right to sublicense), under only those claims of Intel 3167754Smsmith * patents that are infringed by the Original Intel Code, to make, use, sell, 3267754Smsmith * offer to sell, and import the Covered Code and derivative works thereof 3367754Smsmith * solely to the minimum extent necessary to exercise the above copyright 3467754Smsmith * license, and in no event shall the patent license extend to any additions 3567754Smsmith * to or modifications of the Original Intel Code. No other license or right 3667754Smsmith * is granted directly or by implication, estoppel or otherwise; 3767754Smsmith * 3867754Smsmith * The above copyright and patent license is granted only if the following 3967754Smsmith * conditions are met: 4067754Smsmith * 4167754Smsmith * 3. Conditions 4267754Smsmith * 4367754Smsmith * 3.1. Redistribution of Source with Rights to Further Distribute Source. 4467754Smsmith * Redistribution of source code of any substantial portion of the Covered 4567754Smsmith * Code or modification with rights to further distribute source must include 4667754Smsmith * the above Copyright Notice, the above License, this list of Conditions, 4767754Smsmith * and the following Disclaimer and Export Compliance provision. In addition, 4867754Smsmith * Licensee must cause all Covered Code to which Licensee contributes to 4967754Smsmith * contain a file documenting the changes Licensee made to create that Covered 5067754Smsmith * Code and the date of any change. Licensee must include in that file the 5167754Smsmith * documentation of any changes made by any predecessor Licensee. Licensee 5267754Smsmith * must include a prominent statement that the modification is derived, 5367754Smsmith * directly or indirectly, from Original Intel Code. 5467754Smsmith * 5567754Smsmith * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 5667754Smsmith * Redistribution of source code of any substantial portion of the Covered 5767754Smsmith * Code or modification without rights to further distribute source must 5867754Smsmith * include the following Disclaimer and Export Compliance provision in the 5967754Smsmith * documentation and/or other materials provided with distribution. In 6067754Smsmith * addition, Licensee may not authorize further sublicense of source of any 6167754Smsmith * portion of the Covered Code, and must include terms to the effect that the 6267754Smsmith * license from Licensee to its licensee is limited to the intellectual 6367754Smsmith * property embodied in the software Licensee provides to its licensee, and 6467754Smsmith * not to intellectual property embodied in modifications its licensee may 6567754Smsmith * make. 6667754Smsmith * 6767754Smsmith * 3.3. Redistribution of Executable. Redistribution in executable form of any 6867754Smsmith * substantial portion of the Covered Code or modification must reproduce the 6967754Smsmith * above Copyright Notice, and the following Disclaimer and Export Compliance 7067754Smsmith * provision in the documentation and/or other materials provided with the 7167754Smsmith * distribution. 7267754Smsmith * 7367754Smsmith * 3.4. Intel retains all right, title, and interest in and to the Original 7467754Smsmith * Intel Code. 7567754Smsmith * 7667754Smsmith * 3.5. Neither the name Intel nor any other trademark owned or controlled by 7767754Smsmith * Intel shall be used in advertising or otherwise to promote the sale, use or 7867754Smsmith * other dealings in products derived from or relating to the Covered Code 7967754Smsmith * without prior written authorization from Intel. 8067754Smsmith * 8167754Smsmith * 4. Disclaimer and Export Compliance 8267754Smsmith * 8367754Smsmith * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 8467754Smsmith * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 8567754Smsmith * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 8667754Smsmith * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 8767754Smsmith * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 8867754Smsmith * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 8967754Smsmith * PARTICULAR PURPOSE. 9067754Smsmith * 9167754Smsmith * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 9267754Smsmith * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 9367754Smsmith * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 9467754Smsmith * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 9567754Smsmith * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 9667754Smsmith * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 9767754Smsmith * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 9867754Smsmith * LIMITED REMEDY. 9967754Smsmith * 10067754Smsmith * 4.3. Licensee shall not export, either directly or indirectly, any of this 10167754Smsmith * software or system incorporating such software without first obtaining any 10267754Smsmith * required license or other approval from the U. S. Department of Commerce or 10367754Smsmith * any other agency or department of the United States Government. In the 10467754Smsmith * event Licensee exports any such software from the United States or 10567754Smsmith * re-exports any such software from a foreign destination, Licensee shall 10667754Smsmith * ensure that the distribution and export/re-export of the software is in 10767754Smsmith * compliance with all laws, regulations, orders, or other restrictions of the 10867754Smsmith * U.S. Export Administration Regulations. Licensee agrees that neither it nor 10967754Smsmith * any of its subsidiaries will export/re-export any technical data, process, 11067754Smsmith * software, or service, directly or indirectly, to any country for which the 11167754Smsmith * United States government or any agency thereof requires an export license, 11267754Smsmith * other governmental approval, or letter of assurance, without first obtaining 11367754Smsmith * such license, approval or letter. 11467754Smsmith * 11567754Smsmith *****************************************************************************/ 11667754Smsmith 11767754Smsmith 118151600Sobrien#include <contrib/dev/acpica/acpi.h> 119151600Sobrien#include <contrib/dev/acpica/acparser.h> 12067754Smsmith 12177424Smsmith#define _COMPONENT ACPI_PARSER 12291116Smsmith ACPI_MODULE_NAME ("psscope") 12367754Smsmith 12467754Smsmith 12567754Smsmith/******************************************************************************* 12667754Smsmith * 12767754Smsmith * FUNCTION: AcpiPsGetParentScope 12867754Smsmith * 12967754Smsmith * PARAMETERS: ParserState - Current parser state object 13067754Smsmith * 13167754Smsmith * RETURN: Pointer to an Op object 13267754Smsmith * 13367754Smsmith * DESCRIPTION: Get parent of current op being parsed 13467754Smsmith * 13567754Smsmith ******************************************************************************/ 13667754Smsmith 13767754SmsmithACPI_PARSE_OBJECT * 13867754SmsmithAcpiPsGetParentScope ( 13967754Smsmith ACPI_PARSE_STATE *ParserState) 14067754Smsmith{ 141151937Sjkim 14267754Smsmith return (ParserState->Scope->ParseScope.Op); 14367754Smsmith} 14467754Smsmith 14567754Smsmith 14667754Smsmith/******************************************************************************* 14767754Smsmith * 14867754Smsmith * FUNCTION: AcpiPsHasCompletedScope 14967754Smsmith * 15067754Smsmith * PARAMETERS: ParserState - Current parser state object 15167754Smsmith * 15267754Smsmith * RETURN: Boolean, TRUE = scope completed. 15367754Smsmith * 15467754Smsmith * DESCRIPTION: Is parsing of current argument complete? Determined by 15567754Smsmith * 1) AML pointer is at or beyond the end of the scope 15667754Smsmith * 2) The scope argument count has reached zero. 15767754Smsmith * 15867754Smsmith ******************************************************************************/ 15967754Smsmith 16067754SmsmithBOOLEAN 16167754SmsmithAcpiPsHasCompletedScope ( 16267754Smsmith ACPI_PARSE_STATE *ParserState) 16367754Smsmith{ 164151937Sjkim 165151937Sjkim return ((BOOLEAN) 166151937Sjkim ((ParserState->Aml >= ParserState->Scope->ParseScope.ArgEnd || 167151937Sjkim !ParserState->Scope->ParseScope.ArgCount))); 16867754Smsmith} 16967754Smsmith 17067754Smsmith 17167754Smsmith/******************************************************************************* 17267754Smsmith * 17367754Smsmith * FUNCTION: AcpiPsInitScope 17467754Smsmith * 17567754Smsmith * PARAMETERS: ParserState - Current parser state object 17667754Smsmith * Root - the Root Node of this new scope 17767754Smsmith * 17867754Smsmith * RETURN: Status 17967754Smsmith * 18067754Smsmith * DESCRIPTION: Allocate and init a new scope object 18167754Smsmith * 18267754Smsmith ******************************************************************************/ 18367754Smsmith 18467754SmsmithACPI_STATUS 18567754SmsmithAcpiPsInitScope ( 18667754Smsmith ACPI_PARSE_STATE *ParserState, 18767754Smsmith ACPI_PARSE_OBJECT *RootOp) 18867754Smsmith{ 18967754Smsmith ACPI_GENERIC_STATE *Scope; 19067754Smsmith 19167754Smsmith 19291116Smsmith ACPI_FUNCTION_TRACE_PTR ("PsInitScope", RootOp); 19367754Smsmith 19467754Smsmith 19577424Smsmith Scope = AcpiUtCreateGenericState (); 19667754Smsmith if (!Scope) 19767754Smsmith { 19867754Smsmith return_ACPI_STATUS (AE_NO_MEMORY); 19967754Smsmith } 20067754Smsmith 20184491Smsmith Scope->Common.DataType = ACPI_DESC_TYPE_STATE_RPSCOPE; 20267754Smsmith Scope->ParseScope.Op = RootOp; 20367754Smsmith Scope->ParseScope.ArgCount = ACPI_VAR_ARGS; 20467754Smsmith Scope->ParseScope.ArgEnd = ParserState->AmlEnd; 20567754Smsmith Scope->ParseScope.PkgEnd = ParserState->AmlEnd; 20667754Smsmith 20767754Smsmith ParserState->Scope = Scope; 20867754Smsmith ParserState->StartOp = RootOp; 20967754Smsmith 21067754Smsmith return_ACPI_STATUS (AE_OK); 21167754Smsmith} 21267754Smsmith 21367754Smsmith 21467754Smsmith/******************************************************************************* 21567754Smsmith * 21667754Smsmith * FUNCTION: AcpiPsPushScope 21767754Smsmith * 21867754Smsmith * PARAMETERS: ParserState - Current parser state object 21967754Smsmith * Op - Current op to be pushed 22067754Smsmith * RemainingArgs - List of args remaining 22167754Smsmith * ArgCount - Fixed or variable number of args 22267754Smsmith * 22367754Smsmith * RETURN: Status 22467754Smsmith * 22567754Smsmith * DESCRIPTION: Push current op to begin parsing its argument 22667754Smsmith * 22767754Smsmith ******************************************************************************/ 22867754Smsmith 22967754SmsmithACPI_STATUS 23067754SmsmithAcpiPsPushScope ( 23167754Smsmith ACPI_PARSE_STATE *ParserState, 23267754Smsmith ACPI_PARSE_OBJECT *Op, 23367754Smsmith UINT32 RemainingArgs, 23467754Smsmith UINT32 ArgCount) 23567754Smsmith{ 23667754Smsmith ACPI_GENERIC_STATE *Scope; 23767754Smsmith 23867754Smsmith 23991116Smsmith ACPI_FUNCTION_TRACE_PTR ("PsPushScope", Op); 24067754Smsmith 24167754Smsmith 24277424Smsmith Scope = AcpiUtCreateGenericState (); 24367754Smsmith if (!Scope) 24467754Smsmith { 24587031Smsmith return_ACPI_STATUS (AE_NO_MEMORY); 24667754Smsmith } 24767754Smsmith 248151937Sjkim Scope->Common.DataType = ACPI_DESC_TYPE_STATE_PSCOPE; 249151937Sjkim Scope->ParseScope.Op = Op; 250151937Sjkim Scope->ParseScope.ArgList = RemainingArgs; 251151937Sjkim Scope->ParseScope.ArgCount = ArgCount; 252151937Sjkim Scope->ParseScope.PkgEnd = ParserState->PkgEnd; 25367754Smsmith 25467754Smsmith /* Push onto scope stack */ 25567754Smsmith 25677424Smsmith AcpiUtPushGenericState (&ParserState->Scope, Scope); 25767754Smsmith 25867754Smsmith if (ArgCount == ACPI_VAR_ARGS) 25967754Smsmith { 260151937Sjkim /* Multiple arguments */ 26167754Smsmith 26267754Smsmith Scope->ParseScope.ArgEnd = ParserState->PkgEnd; 26367754Smsmith } 26467754Smsmith else 26567754Smsmith { 266151937Sjkim /* Single argument */ 26767754Smsmith 26891116Smsmith Scope->ParseScope.ArgEnd = ACPI_TO_POINTER (ACPI_MAX_PTR); 26967754Smsmith } 27067754Smsmith 27167754Smsmith return_ACPI_STATUS (AE_OK); 27267754Smsmith} 27367754Smsmith 27467754Smsmith 27567754Smsmith/******************************************************************************* 27667754Smsmith * 27767754Smsmith * FUNCTION: AcpiPsPopScope 27867754Smsmith * 27967754Smsmith * PARAMETERS: ParserState - Current parser state object 28067754Smsmith * Op - Where the popped op is returned 28167754Smsmith * ArgList - Where the popped "next argument" is 28267754Smsmith * returned 28367754Smsmith * ArgCount - Count of objects in ArgList 28467754Smsmith * 28567754Smsmith * RETURN: Status 28667754Smsmith * 28767754Smsmith * DESCRIPTION: Return to parsing a previous op 28867754Smsmith * 28967754Smsmith ******************************************************************************/ 29067754Smsmith 29167754Smsmithvoid 29267754SmsmithAcpiPsPopScope ( 29367754Smsmith ACPI_PARSE_STATE *ParserState, 29467754Smsmith ACPI_PARSE_OBJECT **Op, 29567754Smsmith UINT32 *ArgList, 29667754Smsmith UINT32 *ArgCount) 29767754Smsmith{ 29867754Smsmith ACPI_GENERIC_STATE *Scope = ParserState->Scope; 29967754Smsmith 30067754Smsmith 30191116Smsmith ACPI_FUNCTION_TRACE ("PsPopScope"); 30267754Smsmith 30383174Smsmith 304151937Sjkim /* Only pop the scope if there is in fact a next scope */ 305151937Sjkim 30667754Smsmith if (Scope->Common.Next) 30767754Smsmith { 30877424Smsmith Scope = AcpiUtPopGenericState (&ParserState->Scope); 30967754Smsmith 31067754Smsmith /* return to parsing previous op */ 31167754Smsmith 312151937Sjkim *Op = Scope->ParseScope.Op; 313151937Sjkim *ArgList = Scope->ParseScope.ArgList; 314151937Sjkim *ArgCount = Scope->ParseScope.ArgCount; 315151937Sjkim ParserState->PkgEnd = Scope->ParseScope.PkgEnd; 31667754Smsmith 31767754Smsmith /* All done with this scope state structure */ 31867754Smsmith 31977424Smsmith AcpiUtDeleteGenericState (Scope); 32067754Smsmith } 32167754Smsmith else 32267754Smsmith { 32367754Smsmith /* empty parse stack, prepare to fetch next opcode */ 32467754Smsmith 325151937Sjkim *Op = NULL; 326151937Sjkim *ArgList = 0; 327151937Sjkim *ArgCount = 0; 32867754Smsmith } 32967754Smsmith 330151937Sjkim ACPI_DEBUG_PRINT ((ACPI_DB_PARSE, 331151937Sjkim "Popped Op %p Args %X\n", *Op, *ArgCount)); 33267754Smsmith return_VOID; 33367754Smsmith} 33467754Smsmith 33567754Smsmith 33667754Smsmith/******************************************************************************* 33767754Smsmith * 33867754Smsmith * FUNCTION: AcpiPsCleanupScope 33967754Smsmith * 34067754Smsmith * PARAMETERS: ParserState - Current parser state object 34167754Smsmith * 342151937Sjkim * RETURN: None 34367754Smsmith * 34467754Smsmith * DESCRIPTION: Destroy available list, remaining stack levels, and return 34567754Smsmith * root scope 34667754Smsmith * 34767754Smsmith ******************************************************************************/ 34867754Smsmith 34967754Smsmithvoid 35067754SmsmithAcpiPsCleanupScope ( 35167754Smsmith ACPI_PARSE_STATE *ParserState) 35267754Smsmith{ 35367754Smsmith ACPI_GENERIC_STATE *Scope; 35467754Smsmith 355127175Snjl 35691116Smsmith ACPI_FUNCTION_TRACE_PTR ("PsCleanupScope", ParserState); 35767754Smsmith 35867754Smsmith 35967754Smsmith if (!ParserState) 36067754Smsmith { 361127175Snjl return_VOID; 36267754Smsmith } 36367754Smsmith 36467754Smsmith /* Delete anything on the scope stack */ 36567754Smsmith 36667754Smsmith while (ParserState->Scope) 36767754Smsmith { 36877424Smsmith Scope = AcpiUtPopGenericState (&ParserState->Scope); 36977424Smsmith AcpiUtDeleteGenericState (Scope); 37067754Smsmith } 37167754Smsmith 37267754Smsmith return_VOID; 37367754Smsmith} 37467754Smsmith 375