Back to home page

Quest Cross Reference

 
 

    


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

0001 /*******************************************************************************
0002  *
0003  * Module Name: utstate - state object support procedures
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 
0117 #define __UTSTATE_C__
0118 
0119 #include "acpi.h"
0120 #include "accommon.h"
0121 
0122 #define _COMPONENT          ACPI_UTILITIES
0123         ACPI_MODULE_NAME    ("utstate")
0124 
0125 
0126 /*******************************************************************************
0127  *
0128  * FUNCTION:    AcpiUtCreatePkgStateAndPush
0129  *
0130  * PARAMETERS:  Object          - Object to be added to the new state
0131  *              Action          - Increment/Decrement
0132  *              StateList       - List the state will be added to
0133  *
0134  * RETURN:      Status
0135  *
0136  * DESCRIPTION: Create a new state and push it
0137  *
0138  ******************************************************************************/
0139 
0140 ACPI_STATUS
0141 AcpiUtCreatePkgStateAndPush (
0142     void                    *InternalObject,
0143     void                    *ExternalObject,
0144     UINT16                  Index,
0145     ACPI_GENERIC_STATE      **StateList)
0146 {
0147     ACPI_GENERIC_STATE       *State;
0148 
0149 
0150     ACPI_FUNCTION_ENTRY ();
0151 
0152 
0153     State = AcpiUtCreatePkgState (InternalObject, ExternalObject, Index);
0154     if (!State)
0155     {
0156         return (AE_NO_MEMORY);
0157     }
0158 
0159     AcpiUtPushGenericState (StateList, State);
0160     return (AE_OK);
0161 }
0162 
0163 
0164 /*******************************************************************************
0165  *
0166  * FUNCTION:    AcpiUtPushGenericState
0167  *
0168  * PARAMETERS:  ListHead            - Head of the state stack
0169  *              State               - State object to push
0170  *
0171  * RETURN:      None
0172  *
0173  * DESCRIPTION: Push a state object onto a state stack
0174  *
0175  ******************************************************************************/
0176 
0177 void
0178 AcpiUtPushGenericState (
0179     ACPI_GENERIC_STATE      **ListHead,
0180     ACPI_GENERIC_STATE      *State)
0181 {
0182     ACPI_FUNCTION_TRACE (UtPushGenericState);
0183 
0184 
0185     /* Push the state object onto the front of the list (stack) */
0186 
0187     State->Common.Next = *ListHead;
0188     *ListHead = State;
0189 
0190     return_VOID;
0191 }
0192 
0193 
0194 /*******************************************************************************
0195  *
0196  * FUNCTION:    AcpiUtPopGenericState
0197  *
0198  * PARAMETERS:  ListHead            - Head of the state stack
0199  *
0200  * RETURN:      The popped state object
0201  *
0202  * DESCRIPTION: Pop a state object from a state stack
0203  *
0204  ******************************************************************************/
0205 
0206 ACPI_GENERIC_STATE *
0207 AcpiUtPopGenericState (
0208     ACPI_GENERIC_STATE      **ListHead)
0209 {
0210     ACPI_GENERIC_STATE      *State;
0211 
0212 
0213     ACPI_FUNCTION_TRACE (UtPopGenericState);
0214 
0215 
0216     /* Remove the state object at the head of the list (stack) */
0217 
0218     State = *ListHead;
0219     if (State)
0220     {
0221         /* Update the list head */
0222 
0223         *ListHead = State->Common.Next;
0224     }
0225 
0226     return_PTR (State);
0227 }
0228 
0229 
0230 /*******************************************************************************
0231  *
0232  * FUNCTION:    AcpiUtCreateGenericState
0233  *
0234  * PARAMETERS:  None
0235  *
0236  * RETURN:      The new state object. NULL on failure.
0237  *
0238  * DESCRIPTION: Create a generic state object.  Attempt to obtain one from
0239  *              the global state cache;  If none available, create a new one.
0240  *
0241  ******************************************************************************/
0242 
0243 ACPI_GENERIC_STATE *
0244 AcpiUtCreateGenericState (
0245     void)
0246 {
0247     ACPI_GENERIC_STATE      *State;
0248 
0249 
0250     ACPI_FUNCTION_ENTRY ();
0251 
0252 
0253     State = AcpiOsAcquireObject (AcpiGbl_StateCache);
0254     if (State)
0255     {
0256         /* Initialize */
0257         State->Common.DescriptorType = ACPI_DESC_TYPE_STATE;
0258     }
0259 
0260     return (State);
0261 }
0262 
0263 
0264 /*******************************************************************************
0265  *
0266  * FUNCTION:    AcpiUtCreateThreadState
0267  *
0268  * PARAMETERS:  None
0269  *
0270  * RETURN:      New Thread State. NULL on failure
0271  *
0272  * DESCRIPTION: Create a "Thread State" - a flavor of the generic state used
0273  *              to track per-thread info during method execution
0274  *
0275  ******************************************************************************/
0276 
0277 ACPI_THREAD_STATE *
0278 AcpiUtCreateThreadState (
0279     void)
0280 {
0281     ACPI_GENERIC_STATE      *State;
0282 
0283 
0284     ACPI_FUNCTION_TRACE (UtCreateThreadState);
0285 
0286 
0287     /* Create the generic state object */
0288 
0289     State = AcpiUtCreateGenericState ();
0290     if (!State)
0291     {
0292         return_PTR (NULL);
0293     }
0294 
0295     /* Init fields specific to the update struct */
0296 
0297     State->Common.DescriptorType = ACPI_DESC_TYPE_STATE_THREAD;
0298     State->Thread.ThreadId = AcpiOsGetThreadId ();
0299 
0300     /* Check for invalid thread ID - zero is very bad, it will break things */
0301 
0302     if (!State->Thread.ThreadId)
0303     {
0304         ACPI_ERROR ((AE_INFO, "Invalid zero ID from AcpiOsGetThreadId"));
0305         State->Thread.ThreadId = (ACPI_THREAD_ID) 1;
0306     }
0307 
0308     return_PTR ((ACPI_THREAD_STATE *) State);
0309 }
0310 
0311 
0312 /*******************************************************************************
0313  *
0314  * FUNCTION:    AcpiUtCreateUpdateState
0315  *
0316  * PARAMETERS:  Object          - Initial Object to be installed in the state
0317  *              Action          - Update action to be performed
0318  *
0319  * RETURN:      New state object, null on failure
0320  *
0321  * DESCRIPTION: Create an "Update State" - a flavor of the generic state used
0322  *              to update reference counts and delete complex objects such
0323  *              as packages.
0324  *
0325  ******************************************************************************/
0326 
0327 ACPI_GENERIC_STATE *
0328 AcpiUtCreateUpdateState (
0329     ACPI_OPERAND_OBJECT     *Object,
0330     UINT16                  Action)
0331 {
0332     ACPI_GENERIC_STATE      *State;
0333 
0334 
0335     ACPI_FUNCTION_TRACE_PTR (UtCreateUpdateState, Object);
0336 
0337 
0338     /* Create the generic state object */
0339 
0340     State = AcpiUtCreateGenericState ();
0341     if (!State)
0342     {
0343         return_PTR (NULL);
0344     }
0345 
0346     /* Init fields specific to the update struct */
0347 
0348     State->Common.DescriptorType = ACPI_DESC_TYPE_STATE_UPDATE;
0349     State->Update.Object = Object;
0350     State->Update.Value = Action;
0351 
0352     return_PTR (State);
0353 }
0354 
0355 
0356 /*******************************************************************************
0357  *
0358  * FUNCTION:    AcpiUtCreatePkgState
0359  *
0360  * PARAMETERS:  Object          - Initial Object to be installed in the state
0361  *              Action          - Update action to be performed
0362  *
0363  * RETURN:      New state object, null on failure
0364  *
0365  * DESCRIPTION: Create a "Package State"
0366  *
0367  ******************************************************************************/
0368 
0369 ACPI_GENERIC_STATE *
0370 AcpiUtCreatePkgState (
0371     void                    *InternalObject,
0372     void                    *ExternalObject,
0373     UINT16                  Index)
0374 {
0375     ACPI_GENERIC_STATE      *State;
0376 
0377 
0378     ACPI_FUNCTION_TRACE_PTR (UtCreatePkgState, InternalObject);
0379 
0380 
0381     /* Create the generic state object */
0382 
0383     State = AcpiUtCreateGenericState ();
0384     if (!State)
0385     {
0386         return_PTR (NULL);
0387     }
0388 
0389     /* Init fields specific to the update struct */
0390 
0391     State->Common.DescriptorType = ACPI_DESC_TYPE_STATE_PACKAGE;
0392     State->Pkg.SourceObject = (ACPI_OPERAND_OBJECT *) InternalObject;
0393     State->Pkg.DestObject = ExternalObject;
0394     State->Pkg.Index= Index;
0395     State->Pkg.NumPackages = 1;
0396 
0397     return_PTR (State);
0398 }
0399 
0400 
0401 /*******************************************************************************
0402  *
0403  * FUNCTION:    AcpiUtCreateControlState
0404  *
0405  * PARAMETERS:  None
0406  *
0407  * RETURN:      New state object, null on failure
0408  *
0409  * DESCRIPTION: Create a "Control State" - a flavor of the generic state used
0410  *              to support nested IF/WHILE constructs in the AML.
0411  *
0412  ******************************************************************************/
0413 
0414 ACPI_GENERIC_STATE *
0415 AcpiUtCreateControlState (
0416     void)
0417 {
0418     ACPI_GENERIC_STATE      *State;
0419 
0420 
0421     ACPI_FUNCTION_TRACE (UtCreateControlState);
0422 
0423 
0424     /* Create the generic state object */
0425 
0426     State = AcpiUtCreateGenericState ();
0427     if (!State)
0428     {
0429         return_PTR (NULL);
0430     }
0431 
0432     /* Init fields specific to the control struct */
0433 
0434     State->Common.DescriptorType = ACPI_DESC_TYPE_STATE_CONTROL;
0435     State->Common.State = ACPI_CONTROL_CONDITIONAL_EXECUTING;
0436 
0437     return_PTR (State);
0438 }
0439 
0440 
0441 /*******************************************************************************
0442  *
0443  * FUNCTION:    AcpiUtDeleteGenericState
0444  *
0445  * PARAMETERS:  State               - The state object to be deleted
0446  *
0447  * RETURN:      None
0448  *
0449  * DESCRIPTION: Release a state object to the state cache. NULL state objects
0450  *              are ignored.
0451  *
0452  ******************************************************************************/
0453 
0454 void
0455 AcpiUtDeleteGenericState (
0456     ACPI_GENERIC_STATE      *State)
0457 {
0458     ACPI_FUNCTION_TRACE (UtDeleteGenericState);
0459 
0460 
0461     /* Ignore null state */
0462 
0463     if (State)
0464     {
0465         (void) AcpiOsReleaseObject (AcpiGbl_StateCache, State);
0466     }
0467     return_VOID;
0468 }
0469 
0470