acpica/utilities/utstate.c

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 - 2024, 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  * Alternatively, you may choose to be licensed under the terms of the
0117  * following license:
0118  *
0119  * Redistribution and use in source and binary forms, with or without
0120  * modification, are permitted provided that the following conditions
0121  * are met:
0122  * 1. Redistributions of source code must retain the above copyright
0123  *    notice, this list of conditions, and the following disclaimer,
0124  *    without modification.
0125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
0126  *    substantially similar to the "NO WARRANTY" disclaimer below
0127  *    ("Disclaimer") and any redistribution must be conditioned upon
0128  *    including a substantially similar Disclaimer requirement for further
0129  *    binary redistribution.
0130  * 3. Neither the names of the above-listed copyright holders nor the names
0131  *    of any contributors may be used to endorse or promote products derived
0132  *    from this software without specific prior written permission.
0133  *
0134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
0135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
0136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
0137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
0138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
0139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
0140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
0141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
0142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
0143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
0144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0145  *
0146  * Alternatively, you may choose to be licensed under the terms of the
0147  * GNU General Public License ("GPL") version 2 as published by the Free
0148  * Software Foundation.
0149  *
0150  *****************************************************************************/
0151
0152 #include "acpi.h"
0153 #include "accommon.h"
0154
0155 #define _COMPONENT          ACPI_UTILITIES
0156         ACPI_MODULE_NAME    ("utstate")
0157
0158
0159 /*******************************************************************************
0160  *
0161  * FUNCTION:    AcpiUtPushGenericState
0162  *
0163  * PARAMETERS:  ListHead            - Head of the state stack
0164  *              State               - State object to push
0165  *
0166  * RETURN:      None
0167  *
0168  * DESCRIPTION: Push a state object onto a state stack
0169  *
0170  ******************************************************************************/
0171
0172 void
0173 AcpiUtPushGenericState (
0174     ACPI_GENERIC_STATE      **ListHead,
0175     ACPI_GENERIC_STATE      *State)
0176 {
0177     ACPI_FUNCTION_ENTRY ();
0178
0179
0180     /* Push the state object onto the front of the list (stack) */
0181
0182     State->Common.Next = *ListHead;
0183     *ListHead = State;
0184     return;
0185 }
0186
0187
0188 /*******************************************************************************
0189  *
0190  * FUNCTION:    AcpiUtPopGenericState
0191  *
0192  * PARAMETERS:  ListHead            - Head of the state stack
0193  *
0194  * RETURN:      The popped state object
0195  *
0196  * DESCRIPTION: Pop a state object from a state stack
0197  *
0198  ******************************************************************************/
0199
0200 ACPI_GENERIC_STATE *
0201 AcpiUtPopGenericState (
0202     ACPI_GENERIC_STATE      **ListHead)
0203 {
0204     ACPI_GENERIC_STATE      *State;
0205
0206
0207     ACPI_FUNCTION_ENTRY ();
0208
0209
0210     /* Remove the state object at the head of the list (stack) */
0211
0212     State = *ListHead;
0213     if (State)
0214     {
0215         /* Update the list head */
0216
0217         *ListHead = State->Common.Next;
0218     }
0219
0220     return (State);
0221 }
0222
0223
0224 /*******************************************************************************
0225  *
0226  * FUNCTION:    AcpiUtCreateGenericState
0227  *
0228  * PARAMETERS:  None
0229  *
0230  * RETURN:      The new state object. NULL on failure.
0231  *
0232  * DESCRIPTION: Create a generic state object. Attempt to obtain one from
0233  *              the global state cache;  If none available, create a new one.
0234  *
0235  ******************************************************************************/
0236
0237 ACPI_GENERIC_STATE *
0238 AcpiUtCreateGenericState (
0239     void)
0240 {
0241     ACPI_GENERIC_STATE      *State;
0242
0243
0244     ACPI_FUNCTION_ENTRY ();
0245
0246
0247     State = AcpiOsAcquireObject (AcpiGbl_StateCache);
0248     if (State)
0249     {
0250         /* Initialize */
0251         State->Common.DescriptorType = ACPI_DESC_TYPE_STATE;
0252     }
0253
0254     return (State);
0255 }
0256
0257
0258 /*******************************************************************************
0259  *
0260  * FUNCTION:    AcpiUtCreateThreadState
0261  *
0262  * PARAMETERS:  None
0263  *
0264  * RETURN:      New Thread State. NULL on failure
0265  *
0266  * DESCRIPTION: Create a "Thread State" - a flavor of the generic state used
0267  *              to track per-thread info during method execution
0268  *
0269  ******************************************************************************/
0270
0271 ACPI_THREAD_STATE *
0272 AcpiUtCreateThreadState (
0273     void)
0274 {
0275     ACPI_GENERIC_STATE      *State;
0276
0277
0278     ACPI_FUNCTION_ENTRY ();
0279
0280
0281     /* Create the generic state object */
0282
0283     State = AcpiUtCreateGenericState ();
0284     if (!State)
0285     {
0286         return (NULL);
0287     }
0288
0289     /* Init fields specific to the update struct */
0290
0291     State->Common.DescriptorType = ACPI_DESC_TYPE_STATE_THREAD;
0292     State->Thread.ThreadId = AcpiOsGetThreadId ();
0293
0294     /* Check for invalid thread ID - zero is very bad, it will break things */
0295
0296     if (!State->Thread.ThreadId)
0297     {
0298         ACPI_ERROR ((AE_INFO, "Invalid zero ID from AcpiOsGetThreadId"));
0299         State->Thread.ThreadId = (ACPI_THREAD_ID) 1;
0300     }
0301
0302     return ((ACPI_THREAD_STATE *) State);
0303 }
0304
0305
0306 /*******************************************************************************
0307  *
0308  * FUNCTION:    AcpiUtCreateUpdateState
0309  *
0310  * PARAMETERS:  Object          - Initial Object to be installed in the state
0311  *              Action          - Update action to be performed
0312  *
0313  * RETURN:      New state object, null on failure
0314  *
0315  * DESCRIPTION: Create an "Update State" - a flavor of the generic state used
0316  *              to update reference counts and delete complex objects such
0317  *              as packages.
0318  *
0319  ******************************************************************************/
0320
0321 ACPI_GENERIC_STATE *
0322 AcpiUtCreateUpdateState (
0323     ACPI_OPERAND_OBJECT     *Object,
0324     UINT16                  Action)
0325 {
0326     ACPI_GENERIC_STATE      *State;
0327
0328
0329     ACPI_FUNCTION_ENTRY ();
0330
0331
0332     /* Create the generic state object */
0333
0334     State = AcpiUtCreateGenericState ();
0335     if (!State)
0336     {
0337         return (NULL);
0338     }
0339
0340     /* Init fields specific to the update struct */
0341
0342     State->Common.DescriptorType = ACPI_DESC_TYPE_STATE_UPDATE;
0343     State->Update.Object = Object;
0344     State->Update.Value = Action;
0345     return (State);
0346 }
0347
0348
0349 /*******************************************************************************
0350  *
0351  * FUNCTION:    AcpiUtCreatePkgState
0352  *
0353  * PARAMETERS:  Object          - Initial Object to be installed in the state
0354  *              Action          - Update action to be performed
0355  *
0356  * RETURN:      New state object, null on failure
0357  *
0358  * DESCRIPTION: Create a "Package State"
0359  *
0360  ******************************************************************************/
0361
0362 ACPI_GENERIC_STATE *
0363 AcpiUtCreatePkgState (
0364     void                    *InternalObject,
0365     void                    *ExternalObject,
0366     UINT32                  Index)
0367 {
0368     ACPI_GENERIC_STATE      *State;
0369
0370
0371     ACPI_FUNCTION_ENTRY ();
0372
0373
0374     /* Create the generic state object */
0375
0376     State = AcpiUtCreateGenericState ();
0377     if (!State)
0378     {
0379         return (NULL);
0380     }
0381
0382     /* Init fields specific to the update struct */
0383
0384     State->Common.DescriptorType = ACPI_DESC_TYPE_STATE_PACKAGE;
0385     State->Pkg.SourceObject = (ACPI_OPERAND_OBJECT *) InternalObject;
0386     State->Pkg.DestObject = ExternalObject;
0387     State->Pkg.Index= Index;
0388     State->Pkg.NumPackages = 1;
0389
0390     return (State);
0391 }
0392
0393
0394 /*******************************************************************************
0395  *
0396  * FUNCTION:    AcpiUtCreateControlState
0397  *
0398  * PARAMETERS:  None
0399  *
0400  * RETURN:      New state object, null on failure
0401  *
0402  * DESCRIPTION: Create a "Control State" - a flavor of the generic state used
0403  *              to support nested IF/WHILE constructs in the AML.
0404  *
0405  ******************************************************************************/
0406
0407 ACPI_GENERIC_STATE *
0408 AcpiUtCreateControlState (
0409     void)
0410 {
0411     ACPI_GENERIC_STATE      *State;
0412
0413
0414     ACPI_FUNCTION_ENTRY ();
0415
0416
0417     /* Create the generic state object */
0418
0419     State = AcpiUtCreateGenericState ();
0420     if (!State)
0421     {
0422         return (NULL);
0423     }
0424
0425     /* Init fields specific to the control struct */
0426
0427     State->Common.DescriptorType = ACPI_DESC_TYPE_STATE_CONTROL;
0428     State->Common.State = ACPI_CONTROL_CONDITIONAL_EXECUTING;
0429
0430     return (State);
0431 }
0432
0433
0434 /*******************************************************************************
0435  *
0436  * FUNCTION:    AcpiUtDeleteGenericState
0437  *
0438  * PARAMETERS:  State               - The state object to be deleted
0439  *
0440  * RETURN:      None
0441  *
0442  * DESCRIPTION: Release a state object to the state cache. NULL state objects
0443  *              are ignored.
0444  *
0445  ******************************************************************************/
0446
0447 void
0448 AcpiUtDeleteGenericState (
0449     ACPI_GENERIC_STATE      *State)
0450 {
0451     ACPI_FUNCTION_ENTRY ();
0452
0453
0454     /* Ignore null state */
0455
0456     if (State)
0457     {
0458         (void) AcpiOsReleaseObject (AcpiGbl_StateCache, State);
0459     }
0460
0461     return;
0462 }