Back to home page

Quest Cross Reference

 
 

    


Warning, cross-references for /kernel/drivers/acpica/psxface.c need to be fixed.

0001 /******************************************************************************
0002  *
0003  * Module Name: psxface - Parser external interfaces
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 __PSXFACE_C__
0117 
0118 #include "acpi.h"
0119 #include "accommon.h"
0120 #include "acparser.h"
0121 #include "acdispat.h"
0122 #include "acinterp.h"
0123 #include "amlcode.h"
0124 
0125 
0126 #define _COMPONENT          ACPI_PARSER
0127         ACPI_MODULE_NAME    ("psxface")
0128 
0129 /* Local Prototypes */
0130 
0131 static void
0132 AcpiPsStartTrace (
0133     ACPI_EVALUATE_INFO      *Info);
0134 
0135 static void
0136 AcpiPsStopTrace (
0137     ACPI_EVALUATE_INFO      *Info);
0138 
0139 static void
0140 AcpiPsUpdateParameterList (
0141     ACPI_EVALUATE_INFO      *Info,
0142     UINT16                  Action);
0143 
0144 
0145 /*******************************************************************************
0146  *
0147  * FUNCTION:    AcpiDebugTrace
0148  *
0149  * PARAMETERS:  MethodName      - Valid ACPI name string
0150  *              DebugLevel      - Optional level mask. 0 to use default
0151  *              DebugLayer      - Optional layer mask. 0 to use default
0152  *              Flags           - bit 1: one shot(1) or persistent(0)
0153  *
0154  * RETURN:      Status
0155  *
0156  * DESCRIPTION: External interface to enable debug tracing during control
0157  *              method execution
0158  *
0159  ******************************************************************************/
0160 
0161 ACPI_STATUS
0162 AcpiDebugTrace (
0163     char                    *Name,
0164     UINT32                  DebugLevel,
0165     UINT32                  DebugLayer,
0166     UINT32                  Flags)
0167 {
0168     ACPI_STATUS             Status;
0169 
0170 
0171     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
0172     if (ACPI_FAILURE (Status))
0173     {
0174         return (Status);
0175     }
0176 
0177     /* TBDs: Validate name, allow full path or just nameseg */
0178 
0179     AcpiGbl_TraceMethodName = *ACPI_CAST_PTR (UINT32, Name);
0180     AcpiGbl_TraceFlags = Flags;
0181 
0182     if (DebugLevel)
0183     {
0184         AcpiGbl_TraceDbgLevel = DebugLevel;
0185     }
0186     if (DebugLayer)
0187     {
0188         AcpiGbl_TraceDbgLayer = DebugLayer;
0189     }
0190 
0191     (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
0192     return (AE_OK);
0193 }
0194 
0195 
0196 /*******************************************************************************
0197  *
0198  * FUNCTION:    AcpiPsStartTrace
0199  *
0200  * PARAMETERS:  Info        - Method info struct
0201  *
0202  * RETURN:      None
0203  *
0204  * DESCRIPTION: Start control method execution trace
0205  *
0206  ******************************************************************************/
0207 
0208 static void
0209 AcpiPsStartTrace (
0210     ACPI_EVALUATE_INFO      *Info)
0211 {
0212     ACPI_STATUS             Status;
0213 
0214 
0215     ACPI_FUNCTION_ENTRY ();
0216 
0217 
0218     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
0219     if (ACPI_FAILURE (Status))
0220     {
0221         return;
0222     }
0223 
0224     if ((!AcpiGbl_TraceMethodName) ||
0225         (AcpiGbl_TraceMethodName != Info->ResolvedNode->Name.Integer))
0226     {
0227         goto Exit;
0228     }
0229 
0230     AcpiGbl_OriginalDbgLevel = AcpiDbgLevel;
0231     AcpiGbl_OriginalDbgLayer = AcpiDbgLayer;
0232 
0233     AcpiDbgLevel = 0x00FFFFFF;
0234     AcpiDbgLayer = ACPI_UINT32_MAX;
0235 
0236     if (AcpiGbl_TraceDbgLevel)
0237     {
0238         AcpiDbgLevel = AcpiGbl_TraceDbgLevel;
0239     }
0240     if (AcpiGbl_TraceDbgLayer)
0241     {
0242         AcpiDbgLayer = AcpiGbl_TraceDbgLayer;
0243     }
0244 
0245 
0246 Exit:
0247     (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
0248 }
0249 
0250 
0251 /*******************************************************************************
0252  *
0253  * FUNCTION:    AcpiPsStopTrace
0254  *
0255  * PARAMETERS:  Info        - Method info struct
0256  *
0257  * RETURN:      None
0258  *
0259  * DESCRIPTION: Stop control method execution trace
0260  *
0261  ******************************************************************************/
0262 
0263 static void
0264 AcpiPsStopTrace (
0265     ACPI_EVALUATE_INFO      *Info)
0266 {
0267     ACPI_STATUS             Status;
0268 
0269 
0270     ACPI_FUNCTION_ENTRY ();
0271 
0272 
0273     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
0274     if (ACPI_FAILURE (Status))
0275     {
0276         return;
0277     }
0278 
0279     if ((!AcpiGbl_TraceMethodName) ||
0280         (AcpiGbl_TraceMethodName != Info->ResolvedNode->Name.Integer))
0281     {
0282         goto Exit;
0283     }
0284 
0285     /* Disable further tracing if type is one-shot */
0286 
0287     if (AcpiGbl_TraceFlags & 1)
0288     {
0289         AcpiGbl_TraceMethodName = 0;
0290         AcpiGbl_TraceDbgLevel = 0;
0291         AcpiGbl_TraceDbgLayer = 0;
0292     }
0293 
0294     AcpiDbgLevel = AcpiGbl_OriginalDbgLevel;
0295     AcpiDbgLayer = AcpiGbl_OriginalDbgLayer;
0296 
0297 Exit:
0298     (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
0299 }
0300 
0301 
0302 /*******************************************************************************
0303  *
0304  * FUNCTION:    AcpiPsExecuteMethod
0305  *
0306  * PARAMETERS:  Info            - Method info block, contains:
0307  *                  Node            - Method Node to execute
0308  *                  ObjDesc         - Method object
0309  *                  Parameters      - List of parameters to pass to the method,
0310  *                                    terminated by NULL. Params itself may be
0311  *                                    NULL if no parameters are being passed.
0312  *                  ReturnObject    - Where to put method's return value (if
0313  *                                    any). If NULL, no value is returned.
0314  *                  ParameterType   - Type of Parameter list
0315  *                  ReturnObject    - Where to put method's return value (if
0316  *                                    any). If NULL, no value is returned.
0317  *                  PassNumber      - Parse or execute pass
0318  *
0319  * RETURN:      Status
0320  *
0321  * DESCRIPTION: Execute a control method
0322  *
0323  ******************************************************************************/
0324 
0325 ACPI_STATUS
0326 AcpiPsExecuteMethod (
0327     ACPI_EVALUATE_INFO      *Info)
0328 {
0329     ACPI_STATUS             Status;
0330     ACPI_PARSE_OBJECT       *Op;
0331     ACPI_WALK_STATE         *WalkState;
0332 
0333 
0334     ACPI_FUNCTION_TRACE (PsExecuteMethod);
0335 
0336 
0337     /* Validate the Info and method Node */
0338 
0339     if (!Info || !Info->ResolvedNode)
0340     {
0341         return_ACPI_STATUS (AE_NULL_ENTRY);
0342     }
0343 
0344     /* Init for new method, wait on concurrency semaphore */
0345 
0346     Status = AcpiDsBeginMethodExecution (Info->ResolvedNode, Info->ObjDesc, NULL);
0347     if (ACPI_FAILURE (Status))
0348     {
0349         return_ACPI_STATUS (Status);
0350     }
0351 
0352     /*
0353      * The caller "owns" the parameters, so give each one an extra reference
0354      */
0355     AcpiPsUpdateParameterList (Info, REF_INCREMENT);
0356 
0357     /* Begin tracing if requested */
0358 
0359     AcpiPsStartTrace (Info);
0360 
0361     /*
0362      * Execute the method. Performs parse simultaneously
0363      */
0364     ACPI_DEBUG_PRINT ((ACPI_DB_PARSE,
0365         "**** Begin Method Parse/Execute [%4.4s] **** Node=%p Obj=%p\n",
0366         Info->ResolvedNode->Name.Ascii, Info->ResolvedNode, Info->ObjDesc));
0367 
0368     /* Create and init a Root Node */
0369 
0370     Op = AcpiPsCreateScopeOp ();
0371     if (!Op)
0372     {
0373         Status = AE_NO_MEMORY;
0374         goto Cleanup;
0375     }
0376 
0377     /* Create and initialize a new walk state */
0378 
0379     Info->PassNumber = ACPI_IMODE_EXECUTE;
0380     WalkState = AcpiDsCreateWalkState (
0381                     Info->ObjDesc->Method.OwnerId, NULL, NULL, NULL);
0382     if (!WalkState)
0383     {
0384         Status = AE_NO_MEMORY;
0385         goto Cleanup;
0386     }
0387 
0388     Status = AcpiDsInitAmlWalk (WalkState, Op, Info->ResolvedNode,
0389                 Info->ObjDesc->Method.AmlStart,
0390                 Info->ObjDesc->Method.AmlLength, Info, Info->PassNumber);
0391     if (ACPI_FAILURE (Status))
0392     {
0393         AcpiDsDeleteWalkState (WalkState);
0394         goto Cleanup;
0395     }
0396 
0397     /* Invoke an internal method if necessary */
0398 
0399     if (Info->ObjDesc->Method.MethodFlags & AML_METHOD_INTERNAL_ONLY)
0400     {
0401         Status = Info->ObjDesc->Method.Implementation (WalkState);
0402         Info->ReturnObject = WalkState->ReturnDesc;
0403 
0404         /* Cleanup states */
0405 
0406         AcpiDsScopeStackClear (WalkState);
0407         AcpiPsCleanupScope (&WalkState->ParserState);
0408         AcpiDsTerminateControlMethod (WalkState->MethodDesc, WalkState);
0409         AcpiDsDeleteWalkState (WalkState);
0410         goto Cleanup;
0411     }
0412 
0413     /*
0414      * Start method evaluation with an implicit return of zero. This is done
0415      * for Windows compatibility.
0416      */
0417     if (AcpiGbl_EnableInterpreterSlack)
0418     {
0419         WalkState->ImplicitReturnObj =
0420             AcpiUtCreateInternalObject (ACPI_TYPE_INTEGER);
0421         if (!WalkState->ImplicitReturnObj)
0422         {
0423             Status = AE_NO_MEMORY;
0424             AcpiDsDeleteWalkState (WalkState);
0425             goto Cleanup;
0426         }
0427 
0428         WalkState->ImplicitReturnObj->Integer.Value = 0;
0429     }
0430 
0431     /* Parse the AML */
0432 
0433     Status = AcpiPsParseAml (WalkState);
0434 
0435     /* WalkState was deleted by ParseAml */
0436 
0437 Cleanup:
0438     AcpiPsDeleteParseTree (Op);
0439 
0440     /* End optional tracing */
0441 
0442     AcpiPsStopTrace (Info);
0443 
0444     /* Take away the extra reference that we gave the parameters above */
0445 
0446     AcpiPsUpdateParameterList (Info, REF_DECREMENT);
0447 
0448     /* Exit now if error above */
0449 
0450     if (ACPI_FAILURE (Status))
0451     {
0452         return_ACPI_STATUS (Status);
0453     }
0454 
0455     /*
0456      * If the method has returned an object, signal this to the caller with
0457      * a control exception code
0458      */
0459     if (Info->ReturnObject)
0460     {
0461         ACPI_DEBUG_PRINT ((ACPI_DB_PARSE, "Method returned ObjDesc=%p\n",
0462             Info->ReturnObject));
0463         ACPI_DUMP_STACK_ENTRY (Info->ReturnObject);
0464 
0465         Status = AE_CTRL_RETURN_VALUE;
0466     }
0467 
0468     return_ACPI_STATUS (Status);
0469 }
0470 
0471 
0472 /*******************************************************************************
0473  *
0474  * FUNCTION:    AcpiPsUpdateParameterList
0475  *
0476  * PARAMETERS:  Info            - See ACPI_EVALUATE_INFO
0477  *                                (Used: ParameterType and Parameters)
0478  *              Action          - Add or Remove reference
0479  *
0480  * RETURN:      Status
0481  *
0482  * DESCRIPTION: Update reference count on all method parameter objects
0483  *
0484  ******************************************************************************/
0485 
0486 static void
0487 AcpiPsUpdateParameterList (
0488     ACPI_EVALUATE_INFO      *Info,
0489     UINT16                  Action)
0490 {
0491     UINT32                  i;
0492 
0493 
0494     if (Info->Parameters)
0495     {
0496         /* Update reference count for each parameter */
0497 
0498         for (i = 0; Info->Parameters[i]; i++)
0499         {
0500             /* Ignore errors, just do them all */
0501 
0502             (void) AcpiUtUpdateObjectReference (Info->Parameters[i], Action);
0503         }
0504     }
0505 }
0506 
0507