drivers/acpica/psscope.c

0001 /******************************************************************************
0002  *
0003  * Module Name: psscope - Parser scope stack management routines
0004  *
0005  *****************************************************************************/
0006
0007 /******************************************************************************
0008  *
0009  * 1. Copyright Notice
0010  *
0011  * Some or all of this work - Copyright (c) 1999 - 2009, Intel Corp.
0012  * All rights reserved.
0013  *
0014  * 2. License
0015  *
0016  * 2.1. This is your license from Intel Corp. under its intellectual property
0017  * rights.  You may have additional license terms from the party that provided
0018  * you this software, covering your right to use that party's intellectual
0019  * property rights.
0020  *
0021  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
0022  * copy of the source code appearing in this file ("Covered Code") an
0023  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
0024  * base code distributed originally by Intel ("Original Intel Code") to copy,
0025  * make derivatives, distribute, use and display any portion of the Covered
0026  * Code in any form, with the right to sublicense such rights; and
0027  *
0028  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
0029  * license (with the right to sublicense), under only those claims of Intel
0030  * patents that are infringed by the Original Intel Code, to make, use, sell,
0031  * offer to sell, and import the Covered Code and derivative works thereof
0032  * solely to the minimum extent necessary to exercise the above copyright
0033  * license, and in no event shall the patent license extend to any additions
0034  * to or modifications of the Original Intel Code.  No other license or right
0035  * is granted directly or by implication, estoppel or otherwise;
0036  *
0037  * The above copyright and patent license is granted only if the following
0038  * conditions are met:
0039  *
0040  * 3. Conditions
0041  *
0042  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
0043  * Redistribution of source code of any substantial portion of the Covered
0044  * Code or modification with rights to further distribute source must include
0045  * the above Copyright Notice, the above License, this list of Conditions,
0046  * and the following Disclaimer and Export Compliance provision.  In addition,
0047  * Licensee must cause all Covered Code to which Licensee contributes to
0048  * contain a file documenting the changes Licensee made to create that Covered
0049  * Code and the date of any change.  Licensee must include in that file the
0050  * documentation of any changes made by any predecessor Licensee.  Licensee
0051  * must include a prominent statement that the modification is derived,
0052  * directly or indirectly, from Original Intel Code.
0053  *
0054  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
0055  * Redistribution of source code of any substantial portion of the Covered
0056  * Code or modification without rights to further distribute source must
0057  * include the following Disclaimer and Export Compliance provision in the
0058  * documentation and/or other materials provided with distribution.  In
0059  * addition, Licensee may not authorize further sublicense of source of any
0060  * portion of the Covered Code, and must include terms to the effect that the
0061  * license from Licensee to its licensee is limited to the intellectual
0062  * property embodied in the software Licensee provides to its licensee, and
0063  * not to intellectual property embodied in modifications its licensee may
0064  * make.
0065  *
0066  * 3.3. Redistribution of Executable. Redistribution in executable form of any
0067  * substantial portion of the Covered Code or modification must reproduce the
0068  * above Copyright Notice, and the following Disclaimer and Export Compliance
0069  * provision in the documentation and/or other materials provided with the
0070  * distribution.
0071  *
0072  * 3.4. Intel retains all right, title, and interest in and to the Original
0073  * Intel Code.
0074  *
0075  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
0076  * Intel shall be used in advertising or otherwise to promote the sale, use or
0077  * other dealings in products derived from or relating to the Covered Code
0078  * without prior written authorization from Intel.
0079  *
0080  * 4. Disclaimer and Export Compliance
0081  *
0082  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
0083  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
0084  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
0085  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
0086  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
0087  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
0088  * PARTICULAR PURPOSE.
0089  *
0090  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
0091  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
0092  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
0093  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
0094  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
0095  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
0096  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
0097  * LIMITED REMEDY.
0098  *
0099  * 4.3. Licensee shall not export, either directly or indirectly, any of this
0100  * software or system incorporating such software without first obtaining any
0101  * required license or other approval from the U. S. Department of Commerce or
0102  * any other agency or department of the United States Government.  In the
0103  * event Licensee exports any such software from the United States or
0104  * re-exports any such software from a foreign destination, Licensee shall
0105  * ensure that the distribution and export/re-export of the software is in
0106  * compliance with all laws, regulations, orders, or other restrictions of the
0107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
0108  * any of its subsidiaries will export/re-export any technical data, process,
0109  * software, or service, directly or indirectly, to any country for which the
0110  * United States government or any agency thereof requires an export license,
0111  * other governmental approval, or letter of assurance, without first obtaining
0112  * such license, approval or letter.
0113  *
0114  *****************************************************************************/
0115
0116
0117 #include "acpi.h"
0118 #include "accommon.h"
0119 #include "acparser.h"
0120
0121 #define _COMPONENT          ACPI_PARSER
0122         ACPI_MODULE_NAME    ("psscope")
0123
0124
0125 /*******************************************************************************
0126  *
0127  * FUNCTION:    AcpiPsGetParentScope
0128  *
0129  * PARAMETERS:  ParserState         - Current parser state object
0130  *
0131  * RETURN:      Pointer to an Op object
0132  *
0133  * DESCRIPTION: Get parent of current op being parsed
0134  *
0135  ******************************************************************************/
0136
0137 ACPI_PARSE_OBJECT *
0138 AcpiPsGetParentScope (
0139     ACPI_PARSE_STATE        *ParserState)
0140 {
0141
0142     return (ParserState->Scope->ParseScope.Op);
0143 }
0144
0145
0146 /*******************************************************************************
0147  *
0148  * FUNCTION:    AcpiPsHasCompletedScope
0149  *
0150  * PARAMETERS:  ParserState         - Current parser state object
0151  *
0152  * RETURN:      Boolean, TRUE = scope completed.
0153  *
0154  * DESCRIPTION: Is parsing of current argument complete?  Determined by
0155  *              1) AML pointer is at or beyond the end of the scope
0156  *              2) The scope argument count has reached zero.
0157  *
0158  ******************************************************************************/
0159
0160 BOOLEAN
0161 AcpiPsHasCompletedScope (
0162     ACPI_PARSE_STATE        *ParserState)
0163 {
0164
0165     return ((BOOLEAN)
0166             ((ParserState->Aml >= ParserState->Scope->ParseScope.ArgEnd ||
0167              !ParserState->Scope->ParseScope.ArgCount)));
0168 }
0169
0170
0171 /*******************************************************************************
0172  *
0173  * FUNCTION:    AcpiPsInitScope
0174  *
0175  * PARAMETERS:  ParserState         - Current parser state object
0176  *              Root                - the Root Node of this new scope
0177  *
0178  * RETURN:      Status
0179  *
0180  * DESCRIPTION: Allocate and init a new scope object
0181  *
0182  ******************************************************************************/
0183
0184 ACPI_STATUS
0185 AcpiPsInitScope (
0186     ACPI_PARSE_STATE        *ParserState,
0187     ACPI_PARSE_OBJECT       *RootOp)
0188 {
0189     ACPI_GENERIC_STATE      *Scope;
0190
0191
0192     ACPI_FUNCTION_TRACE_PTR (PsInitScope, RootOp);
0193
0194
0195     Scope = AcpiUtCreateGenericState ();
0196     if (!Scope)
0197     {
0198         return_ACPI_STATUS (AE_NO_MEMORY);
0199     }
0200
0201     Scope->Common.DescriptorType = ACPI_DESC_TYPE_STATE_RPSCOPE;
0202     Scope->ParseScope.Op = RootOp;
0203     Scope->ParseScope.ArgCount = ACPI_VAR_ARGS;
0204     Scope->ParseScope.ArgEnd = ParserState->AmlEnd;
0205     Scope->ParseScope.PkgEnd = ParserState->AmlEnd;
0206
0207     ParserState->Scope = Scope;
0208     ParserState->StartOp = RootOp;
0209
0210     return_ACPI_STATUS (AE_OK);
0211 }
0212
0213
0214 /*******************************************************************************
0215  *
0216  * FUNCTION:    AcpiPsPushScope
0217  *
0218  * PARAMETERS:  ParserState         - Current parser state object
0219  *              Op                  - Current op to be pushed
0220  *              RemainingArgs       - List of args remaining
0221  *              ArgCount            - Fixed or variable number of args
0222  *
0223  * RETURN:      Status
0224  *
0225  * DESCRIPTION: Push current op to begin parsing its argument
0226  *
0227  ******************************************************************************/
0228
0229 ACPI_STATUS
0230 AcpiPsPushScope (
0231     ACPI_PARSE_STATE        *ParserState,
0232     ACPI_PARSE_OBJECT       *Op,
0233     UINT32                  RemainingArgs,
0234     UINT32                  ArgCount)
0235 {
0236     ACPI_GENERIC_STATE      *Scope;
0237
0238
0239     ACPI_FUNCTION_TRACE_PTR (PsPushScope, Op);
0240
0241
0242     Scope = AcpiUtCreateGenericState ();
0243     if (!Scope)
0244     {
0245         return_ACPI_STATUS (AE_NO_MEMORY);
0246     }
0247
0248     Scope->Common.DescriptorType = ACPI_DESC_TYPE_STATE_PSCOPE;
0249     Scope->ParseScope.Op = Op;
0250     Scope->ParseScope.ArgList = RemainingArgs;
0251     Scope->ParseScope.ArgCount = ArgCount;
0252     Scope->ParseScope.PkgEnd = ParserState->PkgEnd;
0253
0254     /* Push onto scope stack */
0255
0256     AcpiUtPushGenericState (&ParserState->Scope, Scope);
0257
0258     if (ArgCount == ACPI_VAR_ARGS)
0259     {
0260         /* Multiple arguments */
0261
0262         Scope->ParseScope.ArgEnd = ParserState->PkgEnd;
0263     }
0264     else
0265     {
0266         /* Single argument */
0267
0268         Scope->ParseScope.ArgEnd = ACPI_TO_POINTER (ACPI_MAX_PTR);
0269     }
0270
0271     return_ACPI_STATUS (AE_OK);
0272 }
0273
0274
0275 /*******************************************************************************
0276  *
0277  * FUNCTION:    AcpiPsPopScope
0278  *
0279  * PARAMETERS:  ParserState         - Current parser state object
0280  *              Op                  - Where the popped op is returned
0281  *              ArgList             - Where the popped "next argument" is
0282  *                                    returned
0283  *              ArgCount            - Count of objects in ArgList
0284  *
0285  * RETURN:      Status
0286  *
0287  * DESCRIPTION: Return to parsing a previous op
0288  *
0289  ******************************************************************************/
0290
0291 void
0292 AcpiPsPopScope (
0293     ACPI_PARSE_STATE        *ParserState,
0294     ACPI_PARSE_OBJECT       **Op,
0295     UINT32                  *ArgList,
0296     UINT32                  *ArgCount)
0297 {
0298     ACPI_GENERIC_STATE      *Scope = ParserState->Scope;
0299
0300
0301     ACPI_FUNCTION_TRACE (PsPopScope);
0302
0303
0304     /* Only pop the scope if there is in fact a next scope */
0305
0306     if (Scope->Common.Next)
0307     {
0308         Scope = AcpiUtPopGenericState (&ParserState->Scope);
0309
0310         /* Return to parsing previous op */
0311
0312         *Op                 = Scope->ParseScope.Op;
0313         *ArgList            = Scope->ParseScope.ArgList;
0314         *ArgCount           = Scope->ParseScope.ArgCount;
0315         ParserState->PkgEnd = Scope->ParseScope.PkgEnd;
0316
0317         /* All done with this scope state structure */
0318
0319         AcpiUtDeleteGenericState (Scope);
0320     }
0321     else
0322     {
0323         /* Empty parse stack, prepare to fetch next opcode */
0324
0325         *Op       = NULL;
0326         *ArgList  = 0;
0327         *ArgCount = 0;
0328     }
0329
0330     ACPI_DEBUG_PRINT ((ACPI_DB_PARSE,
0331         "Popped Op %p Args %X\n", *Op, *ArgCount));
0332     return_VOID;
0333 }
0334
0335
0336 /*******************************************************************************
0337  *
0338  * FUNCTION:    AcpiPsCleanupScope
0339  *
0340  * PARAMETERS:  ParserState         - Current parser state object
0341  *
0342  * RETURN:      None
0343  *
0344  * DESCRIPTION: Destroy available list, remaining stack levels, and return
0345  *              root scope
0346  *
0347  ******************************************************************************/
0348
0349 void
0350 AcpiPsCleanupScope (
0351     ACPI_PARSE_STATE        *ParserState)
0352 {
0353     ACPI_GENERIC_STATE      *Scope;
0354
0355
0356     ACPI_FUNCTION_TRACE_PTR (PsCleanupScope, ParserState);
0357
0358
0359     if (!ParserState)
0360     {
0361         return_VOID;
0362     }
0363
0364     /* Delete anything on the scope stack */
0365
0366     while (ParserState->Scope)
0367     {
0368         Scope = AcpiUtPopGenericState (&ParserState->Scope);
0369         AcpiUtDeleteGenericState (Scope);
0370     }
0371
0372     return_VOID;
0373 }
0374