sys/contrib/dev/acpica/psscope.c

   1 /******************************************************************************
   2  *
   3  * Module Name: psscope - Parser scope stack management routines
   4  *              $Revision: 36 $
   5  *
   6  *****************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2003, 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 /* $DragonFly: src/sys/contrib/dev/acpica/Attic/psscope.c,v 1.1 2003/09/24 03:32:16 drhodus Exp $                                                               */
 117
 118
 119 #include "acpi.h"
 120 #include "acparser.h"
 121
 122 #define _COMPONENT          ACPI_PARSER
 123         ACPI_MODULE_NAME    ("psscope")
 124
 125
 126 /*******************************************************************************
 127  *
 128  * FUNCTION:    AcpiPsGetParentScope
 129  *
 130  * PARAMETERS:  ParserState         - Current parser state object
 131  *
 132  * RETURN:      Pointer to an Op object
 133  *
 134  * DESCRIPTION: Get parent of current op being parsed
 135  *
 136  ******************************************************************************/
 137
 138 ACPI_PARSE_OBJECT *
 139 AcpiPsGetParentScope (
 140     ACPI_PARSE_STATE        *ParserState)
 141 {
 142     return (ParserState->Scope->ParseScope.Op);
 143 }
 144
 145
 146 /*******************************************************************************
 147  *
 148  * FUNCTION:    AcpiPsHasCompletedScope
 149  *
 150  * PARAMETERS:  ParserState         - Current parser state object
 151  *
 152  * RETURN:      Boolean, TRUE = scope completed.
 153  *
 154  * DESCRIPTION: Is parsing of current argument complete?  Determined by
 155  *              1) AML pointer is at or beyond the end of the scope
 156  *              2) The scope argument count has reached zero.
 157  *
 158  ******************************************************************************/
 159
 160 BOOLEAN
 161 AcpiPsHasCompletedScope (
 162     ACPI_PARSE_STATE        *ParserState)
 163 {
 164     return ((BOOLEAN) ((ParserState->Aml >= ParserState->Scope->ParseScope.ArgEnd ||
 165                         !ParserState->Scope->ParseScope.ArgCount)));
 166 }
 167
 168
 169 /*******************************************************************************
 170  *
 171  * FUNCTION:    AcpiPsInitScope
 172  *
 173  * PARAMETERS:  ParserState         - Current parser state object
 174  *              Root                - the Root Node of this new scope
 175  *
 176  * RETURN:      Status
 177  *
 178  * DESCRIPTION: Allocate and init a new scope object
 179  *
 180  ******************************************************************************/
 181
 182 ACPI_STATUS
 183 AcpiPsInitScope (
 184     ACPI_PARSE_STATE        *ParserState,
 185     ACPI_PARSE_OBJECT       *RootOp)
 186 {
 187     ACPI_GENERIC_STATE      *Scope;
 188
 189
 190     ACPI_FUNCTION_TRACE_PTR ("PsInitScope", RootOp);
 191
 192
 193     Scope = AcpiUtCreateGenericState ();
 194     if (!Scope)
 195     {
 196         return_ACPI_STATUS (AE_NO_MEMORY);
 197     }
 198
 199     Scope->Common.DataType      = ACPI_DESC_TYPE_STATE_RPSCOPE;
 200     Scope->ParseScope.Op        = RootOp;
 201     Scope->ParseScope.ArgCount  = ACPI_VAR_ARGS;
 202     Scope->ParseScope.ArgEnd    = ParserState->AmlEnd;
 203     Scope->ParseScope.PkgEnd    = ParserState->AmlEnd;
 204
 205     ParserState->Scope          = Scope;
 206     ParserState->StartOp        = RootOp;
 207
 208     return_ACPI_STATUS (AE_OK);
 209 }
 210
 211
 212 /*******************************************************************************
 213  *
 214  * FUNCTION:    AcpiPsPushScope
 215  *
 216  * PARAMETERS:  ParserState         - Current parser state object
 217  *              Op                  - Current op to be pushed
 218  *              RemainingArgs       - List of args remaining
 219  *              ArgCount            - Fixed or variable number of args
 220  *
 221  * RETURN:      Status
 222  *
 223  * DESCRIPTION: Push current op to begin parsing its argument
 224  *
 225  ******************************************************************************/
 226
 227 ACPI_STATUS
 228 AcpiPsPushScope (
 229     ACPI_PARSE_STATE        *ParserState,
 230     ACPI_PARSE_OBJECT       *Op,
 231     UINT32                  RemainingArgs,
 232     UINT32                  ArgCount)
 233 {
 234     ACPI_GENERIC_STATE      *Scope;
 235
 236
 237     ACPI_FUNCTION_TRACE_PTR ("PsPushScope", Op);
 238
 239
 240     Scope = AcpiUtCreateGenericState ();
 241     if (!Scope)
 242     {
 243         return_ACPI_STATUS (AE_NO_MEMORY);
 244     }
 245
 246
 247     Scope->Common.DataType         = ACPI_DESC_TYPE_STATE_PSCOPE;
 248     Scope->ParseScope.Op           = Op;
 249     Scope->ParseScope.ArgList      = RemainingArgs;
 250     Scope->ParseScope.ArgCount     = ArgCount;
 251     Scope->ParseScope.PkgEnd       = ParserState->PkgEnd;
 252
 253     /* Push onto scope stack */
 254
 255     AcpiUtPushGenericState (&ParserState->Scope, Scope);
 256
 257
 258     if (ArgCount == ACPI_VAR_ARGS)
 259     {
 260         /* multiple arguments */
 261
 262         Scope->ParseScope.ArgEnd = ParserState->PkgEnd;
 263     }
 264
 265     else
 266     {
 267         /* single argument */
 268
 269         Scope->ParseScope.ArgEnd = ACPI_TO_POINTER (ACPI_MAX_PTR);
 270     }
 271
 272     return_ACPI_STATUS (AE_OK);
 273 }
 274
 275
 276 /*******************************************************************************
 277  *
 278  * FUNCTION:    AcpiPsPopScope
 279  *
 280  * PARAMETERS:  ParserState         - Current parser state object
 281  *              Op                  - Where the popped op is returned
 282  *              ArgList             - Where the popped "next argument" is
 283  *                                    returned
 284  *              ArgCount            - Count of objects in ArgList
 285  *
 286  * RETURN:      Status
 287  *
 288  * DESCRIPTION: Return to parsing a previous op
 289  *
 290  ******************************************************************************/
 291
 292 void
 293 AcpiPsPopScope (
 294     ACPI_PARSE_STATE        *ParserState,
 295     ACPI_PARSE_OBJECT       **Op,
 296     UINT32                  *ArgList,
 297     UINT32                  *ArgCount)
 298 {
 299     ACPI_GENERIC_STATE      *Scope = ParserState->Scope;
 300
 301
 302     ACPI_FUNCTION_TRACE ("PsPopScope");
 303
 304
 305     /*
 306      * Only pop the scope if there is in fact a next scope
 307      */
 308     if (Scope->Common.Next)
 309     {
 310         Scope = AcpiUtPopGenericState (&ParserState->Scope);
 311
 312         /* return to parsing previous op */
 313
 314         *Op                     = Scope->ParseScope.Op;
 315         *ArgList                = Scope->ParseScope.ArgList;
 316         *ArgCount               = Scope->ParseScope.ArgCount;
 317         ParserState->PkgEnd     = Scope->ParseScope.PkgEnd;
 318
 319         /* All done with this scope state structure */
 320
 321         AcpiUtDeleteGenericState (Scope);
 322     }
 323
 324     else
 325     {
 326         /* empty parse stack, prepare to fetch next opcode */
 327
 328         *Op                     = NULL;
 329         *ArgList                = 0;
 330         *ArgCount               = 0;
 331     }
 332
 333
 334     ACPI_DEBUG_PRINT ((ACPI_DB_PARSE, "Popped Op %p Args %X\n", *Op, *ArgCount));
 335     return_VOID;
 336 }
 337
 338
 339 /*******************************************************************************
 340  *
 341  * FUNCTION:    AcpiPsCleanupScope
 342  *
 343  * PARAMETERS:  ParserState         - Current parser state object
 344  *
 345  * RETURN:      Status
 346  *
 347  * DESCRIPTION: Destroy available list, remaining stack levels, and return
 348  *              root scope
 349  *
 350  ******************************************************************************/
 351
 352 void
 353 AcpiPsCleanupScope (
 354     ACPI_PARSE_STATE        *ParserState)
 355 {
 356     ACPI_GENERIC_STATE      *Scope;
 357
 358     ACPI_FUNCTION_TRACE_PTR ("PsCleanupScope", ParserState);
 359
 360
 361     if (!ParserState)
 362     {
 363         return;
 364     }
 365
 366
 367     /* Delete anything on the scope stack */
 368
 369     while (ParserState->Scope)
 370     {
 371         Scope = AcpiUtPopGenericState (&ParserState->Scope);
 372         AcpiUtDeleteGenericState (Scope);
 373     }
 374
 375     return_VOID;
 376 }
 377