drivers/acpica/dswscope.c

0001 /******************************************************************************
0002  *
0003  * Module Name: dswscope - Scope stack manipulation
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 #define __DSWSCOPE_C__
0117
0118 #include "acpi.h"
0119 #include "accommon.h"
0120 #include "acdispat.h"
0121
0122
0123 #define _COMPONENT          ACPI_DISPATCHER
0124         ACPI_MODULE_NAME    ("dswscope")
0125
0126
0127 /****************************************************************************
0128  *
0129  * FUNCTION:    AcpiDsScopeStackClear
0130  *
0131  * PARAMETERS:  WalkState       - Current state
0132  *
0133  * RETURN:      None
0134  *
0135  * DESCRIPTION: Pop (and free) everything on the scope stack except the
0136  *              root scope object (which remains at the stack top.)
0137  *
0138  ***************************************************************************/
0139
0140 void
0141 AcpiDsScopeStackClear (
0142     ACPI_WALK_STATE         *WalkState)
0143 {
0144     ACPI_GENERIC_STATE      *ScopeInfo;
0145
0146     ACPI_FUNCTION_NAME (DsScopeStackClear);
0147
0148
0149     while (WalkState->ScopeInfo)
0150     {
0151         /* Pop a scope off the stack */
0152
0153         ScopeInfo = WalkState->ScopeInfo;
0154         WalkState->ScopeInfo = ScopeInfo->Scope.Next;
0155
0156         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
0157             "Popped object type (%s)\n",
0158             AcpiUtGetTypeName (ScopeInfo->Common.Value)));
0159         AcpiUtDeleteGenericState (ScopeInfo);
0160     }
0161 }
0162
0163
0164 /****************************************************************************
0165  *
0166  * FUNCTION:    AcpiDsScopeStackPush
0167  *
0168  * PARAMETERS:  Node            - Name to be made current
0169  *              Type            - Type of frame being pushed
0170  *              WalkState       - Current state
0171  *
0172  * RETURN:      Status
0173  *
0174  * DESCRIPTION: Push the current scope on the scope stack, and make the
0175  *              passed Node current.
0176  *
0177  ***************************************************************************/
0178
0179 ACPI_STATUS
0180 AcpiDsScopeStackPush (
0181     ACPI_NAMESPACE_NODE     *Node,
0182     ACPI_OBJECT_TYPE        Type,
0183     ACPI_WALK_STATE         *WalkState)
0184 {
0185     ACPI_GENERIC_STATE      *ScopeInfo;
0186     ACPI_GENERIC_STATE      *OldScopeInfo;
0187
0188
0189     ACPI_FUNCTION_TRACE (DsScopeStackPush);
0190
0191
0192     if (!Node)
0193     {
0194         /* Invalid scope   */
0195
0196         ACPI_ERROR ((AE_INFO, "Null scope parameter"));
0197         return_ACPI_STATUS (AE_BAD_PARAMETER);
0198     }
0199
0200     /* Make sure object type is valid */
0201
0202     if (!AcpiUtValidObjectType (Type))
0203     {
0204         ACPI_WARNING ((AE_INFO,
0205             "Invalid object type: 0x%X", Type));
0206     }
0207
0208     /* Allocate a new scope object */
0209
0210     ScopeInfo = AcpiUtCreateGenericState ();
0211     if (!ScopeInfo)
0212     {
0213         return_ACPI_STATUS (AE_NO_MEMORY);
0214     }
0215
0216     /* Init new scope object */
0217
0218     ScopeInfo->Common.DescriptorType = ACPI_DESC_TYPE_STATE_WSCOPE;
0219     ScopeInfo->Scope.Node = Node;
0220     ScopeInfo->Common.Value = (UINT16) Type;
0221
0222     WalkState->ScopeDepth++;
0223
0224     ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
0225         "[%.2d] Pushed scope ", (UINT32) WalkState->ScopeDepth));
0226
0227     OldScopeInfo = WalkState->ScopeInfo;
0228     if (OldScopeInfo)
0229     {
0230         ACPI_DEBUG_PRINT_RAW ((ACPI_DB_EXEC,
0231             "[%4.4s] (%s)",
0232             AcpiUtGetNodeName (OldScopeInfo->Scope.Node),
0233             AcpiUtGetTypeName (OldScopeInfo->Common.Value)));
0234     }
0235     else
0236     {
0237         ACPI_DEBUG_PRINT_RAW ((ACPI_DB_EXEC,
0238             "[\\___] (%s)", "ROOT"));
0239     }
0240
0241     ACPI_DEBUG_PRINT_RAW ((ACPI_DB_EXEC,
0242         ", New scope -> [%4.4s] (%s)\n",
0243         AcpiUtGetNodeName (ScopeInfo->Scope.Node),
0244         AcpiUtGetTypeName (ScopeInfo->Common.Value)));
0245
0246     /* Push new scope object onto stack */
0247
0248     AcpiUtPushGenericState (&WalkState->ScopeInfo, ScopeInfo);
0249     return_ACPI_STATUS (AE_OK);
0250 }
0251
0252
0253 /****************************************************************************
0254  *
0255  * FUNCTION:    AcpiDsScopeStackPop
0256  *
0257  * PARAMETERS:  WalkState       - Current state
0258  *
0259  * RETURN:      Status
0260  *
0261  * DESCRIPTION: Pop the scope stack once.
0262  *
0263  ***************************************************************************/
0264
0265 ACPI_STATUS
0266 AcpiDsScopeStackPop (
0267     ACPI_WALK_STATE         *WalkState)
0268 {
0269     ACPI_GENERIC_STATE      *ScopeInfo;
0270     ACPI_GENERIC_STATE      *NewScopeInfo;
0271
0272
0273     ACPI_FUNCTION_TRACE (DsScopeStackPop);
0274
0275
0276     /*
0277      * Pop scope info object off the stack.
0278      */
0279     ScopeInfo = AcpiUtPopGenericState (&WalkState->ScopeInfo);
0280     if (!ScopeInfo)
0281     {
0282         return_ACPI_STATUS (AE_STACK_UNDERFLOW);
0283     }
0284
0285     WalkState->ScopeDepth--;
0286
0287     ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
0288         "[%.2d] Popped scope [%4.4s] (%s), New scope -> ",
0289         (UINT32) WalkState->ScopeDepth,
0290         AcpiUtGetNodeName (ScopeInfo->Scope.Node),
0291         AcpiUtGetTypeName (ScopeInfo->Common.Value)));
0292
0293     NewScopeInfo = WalkState->ScopeInfo;
0294     if (NewScopeInfo)
0295     {
0296         ACPI_DEBUG_PRINT_RAW ((ACPI_DB_EXEC,
0297             "[%4.4s] (%s)\n",
0298             AcpiUtGetNodeName (NewScopeInfo->Scope.Node),
0299             AcpiUtGetTypeName (NewScopeInfo->Common.Value)));
0300     }
0301     else
0302     {
0303         ACPI_DEBUG_PRINT_RAW ((ACPI_DB_EXEC,
0304             "[\\___] (ROOT)\n"));
0305     }
0306
0307     AcpiUtDeleteGenericState (ScopeInfo);
0308     return_ACPI_STATUS (AE_OK);
0309 }
0310
0311