sys/contrib/dev/acpica-unix-20050309/interpreter/dispatcher/dswscope.c

   1 /******************************************************************************
   2  *
   3  * Module Name: dswscope - Scope stack manipulation
   4  *              $Revision: 61 $
   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 #define __DSWSCOPE_C__
 118
 119 #include "acpi.h"
 120 #include "acdispat.h"
 121
 122
 123 #define _COMPONENT          ACPI_DISPATCHER
 124         ACPI_MODULE_NAME    ("dswscope")
 125
 126
 127 #define STACK_POP(head) head
 128
 129
 130 /****************************************************************************
 131  *
 132  * FUNCTION:    AcpiDsScopeStackClear
 133  *
 134  * PARAMETERS:  None
 135  *
 136  * DESCRIPTION: Pop (and free) everything on the scope stack except the
 137  *              root scope object (which remains at the stack top.)
 138  *
 139  ***************************************************************************/
 140
 141 void
 142 AcpiDsScopeStackClear (
 143     ACPI_WALK_STATE         *WalkState)
 144 {
 145     ACPI_GENERIC_STATE      *ScopeInfo;
 146
 147     ACPI_FUNCTION_NAME ("DsScopeStackClear");
 148
 149
 150     while (WalkState->ScopeInfo)
 151     {
 152         /* Pop a scope off the stack */
 153
 154         ScopeInfo = WalkState->ScopeInfo;
 155         WalkState->ScopeInfo = ScopeInfo->Scope.Next;
 156
 157         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
 158             "Popped object type (%s)\n", AcpiUtGetTypeName (ScopeInfo->Common.Value)));
 159         AcpiUtDeleteGenericState (ScopeInfo);
 160     }
 161 }
 162
 163
 164 /****************************************************************************
 165  *
 166  * FUNCTION:    AcpiDsScopeStackPush
 167  *
 168  * PARAMETERS:  *Node,              - Name to be made current
 169  *              Type,               - Type of frame being pushed
 170  *
 171  * DESCRIPTION: Push the current scope on the scope stack, and make the
 172  *              passed Node current.
 173  *
 174  ***************************************************************************/
 175
 176 ACPI_STATUS
 177 AcpiDsScopeStackPush (
 178     ACPI_NAMESPACE_NODE     *Node,
 179     ACPI_OBJECT_TYPE        Type,
 180     ACPI_WALK_STATE         *WalkState)
 181 {
 182     ACPI_GENERIC_STATE      *ScopeInfo;
 183     ACPI_GENERIC_STATE      *OldScopeInfo;
 184
 185
 186     ACPI_FUNCTION_TRACE ("DsScopeStackPush");
 187
 188
 189     if (!Node)
 190     {
 191         /* Invalid scope   */
 192
 193         ACPI_REPORT_ERROR (("DsScopeStackPush: null scope passed\n"));
 194         return_ACPI_STATUS (AE_BAD_PARAMETER);
 195     }
 196
 197     /* Make sure object type is valid */
 198
 199     if (!AcpiUtValidObjectType (Type))
 200     {
 201         ACPI_REPORT_WARNING (("DsScopeStackPush: Invalid object type: 0x%X\n", Type));
 202     }
 203
 204     /* Allocate a new scope object */
 205
 206     ScopeInfo = AcpiUtCreateGenericState ();
 207     if (!ScopeInfo)
 208     {
 209         return_ACPI_STATUS (AE_NO_MEMORY);
 210     }
 211
 212     /* Init new scope object */
 213
 214     ScopeInfo->Common.DataType  = ACPI_DESC_TYPE_STATE_WSCOPE;
 215     ScopeInfo->Scope.Node       = Node;
 216     ScopeInfo->Common.Value     = (UINT16) Type;
 217
 218     WalkState->ScopeDepth++;
 219
 220     ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
 221         "[%.2d] Pushed scope ", (UINT32) WalkState->ScopeDepth));
 222
 223     OldScopeInfo = WalkState->ScopeInfo;
 224     if (OldScopeInfo)
 225     {
 226         ACPI_DEBUG_PRINT_RAW ((ACPI_DB_EXEC,
 227             "[%4.4s] (%s)",
 228             AcpiUtGetNodeName (OldScopeInfo->Scope.Node),
 229             AcpiUtGetTypeName (OldScopeInfo->Common.Value)));
 230     }
 231     else
 232     {
 233         ACPI_DEBUG_PRINT_RAW ((ACPI_DB_EXEC,
 234             "[\\___] (%s)", "ROOT"));
 235     }
 236
 237     ACPI_DEBUG_PRINT_RAW ((ACPI_DB_EXEC,
 238         ", New scope -> [%4.4s] (%s)\n",
 239         AcpiUtGetNodeName (ScopeInfo->Scope.Node),
 240         AcpiUtGetTypeName (ScopeInfo->Common.Value)));
 241
 242     /* Push new scope object onto stack */
 243
 244     AcpiUtPushGenericState (&WalkState->ScopeInfo, ScopeInfo);
 245     return_ACPI_STATUS (AE_OK);
 246 }
 247
 248
 249 /****************************************************************************
 250  *
 251  * FUNCTION:    AcpiDsScopeStackPop
 252  *
 253  * PARAMETERS:  Type                - The type of frame to be found
 254  *
 255  * DESCRIPTION: Pop the scope stack until a frame of the requested type
 256  *              is found.
 257  *
 258  * RETURN:      Count of frames popped.  If no frame of the requested type
 259  *              was found, the count is returned as a negative number and
 260  *              the scope stack is emptied (which sets the current scope
 261  *              to the root).  If the scope stack was empty at entry, the
 262  *              function is a no-op and returns 0.
 263  *
 264  ***************************************************************************/
 265
 266 ACPI_STATUS
 267 AcpiDsScopeStackPop (
 268     ACPI_WALK_STATE         *WalkState)
 269 {
 270     ACPI_GENERIC_STATE      *ScopeInfo;
 271     ACPI_GENERIC_STATE      *NewScopeInfo;
 272
 273
 274     ACPI_FUNCTION_TRACE ("DsScopeStackPop");
 275
 276
 277     /*
 278      * Pop scope info object off the stack.
 279      */
 280     ScopeInfo = AcpiUtPopGenericState (&WalkState->ScopeInfo);
 281     if (!ScopeInfo)
 282     {
 283         return_ACPI_STATUS (AE_STACK_UNDERFLOW);
 284     }
 285
 286     WalkState->ScopeDepth--;
 287
 288     ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
 289         "[%.2d] Popped scope [%4.4s] (%s), New scope -> ",
 290         (UINT32) WalkState->ScopeDepth,
 291         AcpiUtGetNodeName (ScopeInfo->Scope.Node),
 292         AcpiUtGetTypeName (ScopeInfo->Common.Value)));
 293
 294     NewScopeInfo = WalkState->ScopeInfo;
 295     if (NewScopeInfo)
 296     {
 297         ACPI_DEBUG_PRINT_RAW ((ACPI_DB_EXEC,
 298             "[%4.4s] (%s)\n",
 299             AcpiUtGetNodeName (NewScopeInfo->Scope.Node),
 300             AcpiUtGetTypeName (NewScopeInfo->Common.Value)));
 301     }
 302     else
 303     {
 304         ACPI_DEBUG_PRINT_RAW ((ACPI_DB_EXEC,
 305             "[\\___] (ROOT)\n"));
 306     }
 307
 308     AcpiUtDeleteGenericState (ScopeInfo);
 309     return_ACPI_STATUS (AE_OK);
 310 }
 311
 312