reactos/drivers/bus/acpi/acpica/parser/psscope.c

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