sys/contrib/dev/acpica-unix-20050211/interpreter/parser/psscope.c

   1 /******************************************************************************
   2  *
   3  * Module Name: psscope - Parser scope stack management routines
   4  *              $Revision: 39 $
   5  *
   6  *****************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2005, Intel Corp.
  13  * All rights reserved.
  14  *
  15  * 2. License
  16  *
  17  * 2.1. This is your license from Intel Corp. under its intellectual property
  18  * rights.  You may have additional license terms from the party that provided
  19  * you this software, covering your right to use that party's intellectual
  20  * property rights.
  21  *
  22  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  23  * copy of the source code appearing in this file ("Covered Code") an
  24  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  25  * base code distributed originally by Intel ("Original Intel Code") to copy,
  26  * make derivatives, distribute, use and display any portion of the Covered
  27  * Code in any form, with the right to sublicense such rights; and
  28  *
  29  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  30  * license (with the right to sublicense), under only those claims of Intel
  31  * patents that are infringed by the Original Intel Code, to make, use, sell,
  32  * offer to sell, and import the Covered Code and derivative works thereof
  33  * solely to the minimum extent necessary to exercise the above copyright
  34  * license, and in no event shall the patent license extend to any additions
  35  * to or modifications of the Original Intel Code.  No other license or right
  36  * is granted directly or by implication, estoppel or otherwise;
  37  *
  38  * The above copyright and patent license is granted only if the following
  39  * conditions are met:
  40  *
  41  * 3. Conditions
  42  *
  43  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  44  * Redistribution of source code of any substantial portion of the Covered
  45  * Code or modification with rights to further distribute source must include
  46  * the above Copyright Notice, the above License, this list of Conditions,
  47  * and the following Disclaimer and Export Compliance provision.  In addition,
  48  * Licensee must cause all Covered Code to which Licensee contributes to
  49  * contain a file documenting the changes Licensee made to create that Covered
  50  * Code and the date of any change.  Licensee must include in that file the
  51  * documentation of any changes made by any predecessor Licensee.  Licensee
  52  * must include a prominent statement that the modification is derived,
  53  * directly or indirectly, from Original Intel Code.
  54  *
  55  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  56  * Redistribution of source code of any substantial portion of the Covered
  57  * Code or modification without rights to further distribute source must
  58  * include the following Disclaimer and Export Compliance provision in the
  59  * documentation and/or other materials provided with distribution.  In
  60  * addition, Licensee may not authorize further sublicense of source of any
  61  * portion of the Covered Code, and must include terms to the effect that the
  62  * license from Licensee to its licensee is limited to the intellectual
  63  * property embodied in the software Licensee provides to its licensee, and
  64  * not to intellectual property embodied in modifications its licensee may
  65  * make.
  66  *
  67  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  68  * substantial portion of the Covered Code or modification must reproduce the
  69  * above Copyright Notice, and the following Disclaimer and Export Compliance
  70  * provision in the documentation and/or other materials provided with the
  71  * distribution.
  72  *
  73  * 3.4. Intel retains all right, title, and interest in and to the Original
  74  * Intel Code.
  75  *
  76  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  77  * Intel shall be used in advertising or otherwise to promote the sale, use or
  78  * other dealings in products derived from or relating to the Covered Code
  79  * without prior written authorization from Intel.
  80  *
  81  * 4. Disclaimer and Export Compliance
  82  *
  83  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  84  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  85  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  86  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  87  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  88  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  89  * PARTICULAR PURPOSE.
  90  *
  91  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  92  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  93  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  94  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  95  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  96  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  97  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  98  * LIMITED REMEDY.
  99  *
 100  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 101  * software or system incorporating such software without first obtaining any
 102  * required license or other approval from the U. S. Department of Commerce or
 103  * any other agency or department of the United States Government.  In the
 104  * event Licensee exports any such software from the United States or
 105  * re-exports any such software from a foreign destination, Licensee shall
 106  * ensure that the distribution and export/re-export of the software is in
 107  * compliance with all laws, regulations, orders, or other restrictions of the
 108  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 109  * any of its subsidiaries will export/re-export any technical data, process,
 110  * software, or service, directly or indirectly, to any country for which the
 111  * United States government or any agency thereof requires an export license,
 112  * other governmental approval, or letter of assurance, without first obtaining
 113  * such license, approval or letter.
 114  *
 115  *****************************************************************************/
 116
 117
 118 #include "acpi.h"
 119 #include "acparser.h"
 120
 121 #define _COMPONENT          ACPI_PARSER
 122         ACPI_MODULE_NAME    ("psscope")
 123
 124
 125 /*******************************************************************************
 126  *
 127  * FUNCTION:    AcpiPsGetParentScope
 128  *
 129  * PARAMETERS:  ParserState         - Current parser state object
 130  *
 131  * RETURN:      Pointer to an Op object
 132  *
 133  * DESCRIPTION: Get parent of current op being parsed
 134  *
 135  ******************************************************************************/
 136
 137 ACPI_PARSE_OBJECT *
 138 AcpiPsGetParentScope (
 139     ACPI_PARSE_STATE        *ParserState)
 140 {
 141     return (ParserState->Scope->ParseScope.Op);
 142 }
 143
 144
 145 /*******************************************************************************
 146  *
 147  * FUNCTION:    AcpiPsHasCompletedScope
 148  *
 149  * PARAMETERS:  ParserState         - Current parser state object
 150  *
 151  * RETURN:      Boolean, TRUE = scope completed.
 152  *
 153  * DESCRIPTION: Is parsing of current argument complete?  Determined by
 154  *              1) AML pointer is at or beyond the end of the scope
 155  *              2) The scope argument count has reached zero.
 156  *
 157  ******************************************************************************/
 158
 159 BOOLEAN
 160 AcpiPsHasCompletedScope (
 161     ACPI_PARSE_STATE        *ParserState)
 162 {
 163     return ((BOOLEAN) ((ParserState->Aml >= ParserState->Scope->ParseScope.ArgEnd ||
 164                         !ParserState->Scope->ParseScope.ArgCount)));
 165 }
 166
 167
 168 /*******************************************************************************
 169  *
 170  * FUNCTION:    AcpiPsInitScope
 171  *
 172  * PARAMETERS:  ParserState         - Current parser state object
 173  *              Root                - the Root Node of this new scope
 174  *
 175  * RETURN:      Status
 176  *
 177  * DESCRIPTION: Allocate and init a new scope object
 178  *
 179  ******************************************************************************/
 180
 181 ACPI_STATUS
 182 AcpiPsInitScope (
 183     ACPI_PARSE_STATE        *ParserState,
 184     ACPI_PARSE_OBJECT       *RootOp)
 185 {
 186     ACPI_GENERIC_STATE      *Scope;
 187
 188
 189     ACPI_FUNCTION_TRACE_PTR ("PsInitScope", RootOp);
 190
 191
 192     Scope = AcpiUtCreateGenericState ();
 193     if (!Scope)
 194     {
 195         return_ACPI_STATUS (AE_NO_MEMORY);
 196     }
 197
 198     Scope->Common.DataType      = ACPI_DESC_TYPE_STATE_RPSCOPE;
 199     Scope->ParseScope.Op        = RootOp;
 200     Scope->ParseScope.ArgCount  = ACPI_VAR_ARGS;
 201     Scope->ParseScope.ArgEnd    = ParserState->AmlEnd;
 202     Scope->ParseScope.PkgEnd    = ParserState->AmlEnd;
 203
 204     ParserState->Scope          = Scope;
 205     ParserState->StartOp        = RootOp;
 206
 207     return_ACPI_STATUS (AE_OK);
 208 }
 209
 210
 211 /*******************************************************************************
 212  *
 213  * FUNCTION:    AcpiPsPushScope
 214  *
 215  * PARAMETERS:  ParserState         - Current parser state object
 216  *              Op                  - Current op to be pushed
 217  *              RemainingArgs       - List of args remaining
 218  *              ArgCount            - Fixed or variable number of args
 219  *
 220  * RETURN:      Status
 221  *
 222  * DESCRIPTION: Push current op to begin parsing its argument
 223  *
 224  ******************************************************************************/
 225
 226 ACPI_STATUS
 227 AcpiPsPushScope (
 228     ACPI_PARSE_STATE        *ParserState,
 229     ACPI_PARSE_OBJECT       *Op,
 230     UINT32                  RemainingArgs,
 231     UINT32                  ArgCount)
 232 {
 233     ACPI_GENERIC_STATE      *Scope;
 234
 235
 236     ACPI_FUNCTION_TRACE_PTR ("PsPushScope", Op);
 237
 238
 239     Scope = AcpiUtCreateGenericState ();
 240     if (!Scope)
 241     {
 242         return_ACPI_STATUS (AE_NO_MEMORY);
 243     }
 244
 245     Scope->Common.DataType         = ACPI_DESC_TYPE_STATE_PSCOPE;
 246     Scope->ParseScope.Op           = Op;
 247     Scope->ParseScope.ArgList      = RemainingArgs;
 248     Scope->ParseScope.ArgCount     = ArgCount;
 249     Scope->ParseScope.PkgEnd       = ParserState->PkgEnd;
 250
 251     /* Push onto scope stack */
 252
 253     AcpiUtPushGenericState (&ParserState->Scope, Scope);
 254
 255     if (ArgCount == ACPI_VAR_ARGS)
 256     {
 257         /* multiple arguments */
 258
 259         Scope->ParseScope.ArgEnd = ParserState->PkgEnd;
 260     }
 261     else
 262     {
 263         /* single argument */
 264
 265         Scope->ParseScope.ArgEnd = ACPI_TO_POINTER (ACPI_MAX_PTR);
 266     }
 267
 268     return_ACPI_STATUS (AE_OK);
 269 }
 270
 271
 272 /*******************************************************************************
 273  *
 274  * FUNCTION:    AcpiPsPopScope
 275  *
 276  * PARAMETERS:  ParserState         - Current parser state object
 277  *              Op                  - Where the popped op is returned
 278  *              ArgList             - Where the popped "next argument" is
 279  *                                    returned
 280  *              ArgCount            - Count of objects in ArgList
 281  *
 282  * RETURN:      Status
 283  *
 284  * DESCRIPTION: Return to parsing a previous op
 285  *
 286  ******************************************************************************/
 287
 288 void
 289 AcpiPsPopScope (
 290     ACPI_PARSE_STATE        *ParserState,
 291     ACPI_PARSE_OBJECT       **Op,
 292     UINT32                  *ArgList,
 293     UINT32                  *ArgCount)
 294 {
 295     ACPI_GENERIC_STATE      *Scope = ParserState->Scope;
 296
 297
 298     ACPI_FUNCTION_TRACE ("PsPopScope");
 299
 300
 301     /*
 302      * Only pop the scope if there is in fact a next scope
 303      */
 304     if (Scope->Common.Next)
 305     {
 306         Scope = AcpiUtPopGenericState (&ParserState->Scope);
 307
 308         /* return to parsing previous op */
 309
 310         *Op                     = Scope->ParseScope.Op;
 311         *ArgList                = Scope->ParseScope.ArgList;
 312         *ArgCount               = Scope->ParseScope.ArgCount;
 313         ParserState->PkgEnd     = Scope->ParseScope.PkgEnd;
 314
 315         /* All done with this scope state structure */
 316
 317         AcpiUtDeleteGenericState (Scope);
 318     }
 319     else
 320     {
 321         /* empty parse stack, prepare to fetch next opcode */
 322
 323         *Op                     = NULL;
 324         *ArgList                = 0;
 325         *ArgCount               = 0;
 326     }
 327
 328     ACPI_DEBUG_PRINT ((ACPI_DB_PARSE, "Popped Op %p Args %X\n", *Op, *ArgCount));
 329     return_VOID;
 330 }
 331
 332
 333 /*******************************************************************************
 334  *
 335  * FUNCTION:    AcpiPsCleanupScope
 336  *
 337  * PARAMETERS:  ParserState         - Current parser state object
 338  *
 339  * RETURN:      Status
 340  *
 341  * DESCRIPTION: Destroy available list, remaining stack levels, and return
 342  *              root scope
 343  *
 344  ******************************************************************************/
 345
 346 void
 347 AcpiPsCleanupScope (
 348     ACPI_PARSE_STATE        *ParserState)
 349 {
 350     ACPI_GENERIC_STATE      *Scope;
 351
 352
 353     ACPI_FUNCTION_TRACE_PTR ("PsCleanupScope", ParserState);
 354
 355
 356     if (!ParserState)
 357     {
 358         return_VOID;
 359     }
 360
 361     /* Delete anything on the scope stack */
 362
 363     while (ParserState->Scope)
 364     {
 365         Scope = AcpiUtPopGenericState (&ParserState->Scope);
 366         AcpiUtDeleteGenericState (Scope);
 367     }
 368
 369     return_VOID;
 370 }
 371