acpica/executer/exsystem.c

0001 /******************************************************************************
0002  *
0003  * Module Name: exsystem - Interface to OS services
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 #include "acinterp.h"
0155
0156 #define _COMPONENT          ACPI_EXECUTER
0157         ACPI_MODULE_NAME    ("exsystem")
0158
0159
0160 /*******************************************************************************
0161  *
0162  * FUNCTION:    AcpiExSystemWaitSemaphore
0163  *
0164  * PARAMETERS:  Semaphore       - Semaphore to wait on
0165  *              Timeout         - Max time to wait
0166  *
0167  * RETURN:      Status
0168  *
0169  * DESCRIPTION: Implements a semaphore wait with a check to see if the
0170  *              semaphore is available immediately. If it is not, the
0171  *              interpreter is released before waiting.
0172  *
0173  ******************************************************************************/
0174
0175 ACPI_STATUS
0176 AcpiExSystemWaitSemaphore (
0177     ACPI_SEMAPHORE          Semaphore,
0178     UINT16                  Timeout)
0179 {
0180     ACPI_STATUS             Status;
0181
0182
0183     ACPI_FUNCTION_TRACE (ExSystemWaitSemaphore);
0184
0185
0186     Status = AcpiOsWaitSemaphore (Semaphore, 1, ACPI_DO_NOT_WAIT);
0187     if (ACPI_SUCCESS (Status))
0188     {
0189         return_ACPI_STATUS (Status);
0190     }
0191
0192     if (Status == AE_TIME)
0193     {
0194         /* We must wait, so unlock the interpreter */
0195
0196         AcpiExExitInterpreter ();
0197         Status = AcpiOsWaitSemaphore (Semaphore, 1, Timeout);
0198
0199         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
0200             "*** Thread awake after blocking, %s\n",
0201             AcpiFormatException (Status)));
0202
0203         /* Reacquire the interpreter */
0204
0205         AcpiExEnterInterpreter ();
0206     }
0207
0208     return_ACPI_STATUS (Status);
0209 }
0210
0211
0212 /*******************************************************************************
0213  *
0214  * FUNCTION:    AcpiExSystemWaitMutex
0215  *
0216  * PARAMETERS:  Mutex           - Mutex to wait on
0217  *              Timeout         - Max time to wait
0218  *
0219  * RETURN:      Status
0220  *
0221  * DESCRIPTION: Implements a mutex wait with a check to see if the
0222  *              mutex is available immediately. If it is not, the
0223  *              interpreter is released before waiting.
0224  *
0225  ******************************************************************************/
0226
0227 ACPI_STATUS
0228 AcpiExSystemWaitMutex (
0229     ACPI_MUTEX              Mutex,
0230     UINT16                  Timeout)
0231 {
0232     ACPI_STATUS             Status;
0233
0234
0235     ACPI_FUNCTION_TRACE (ExSystemWaitMutex);
0236
0237
0238     Status = AcpiOsAcquireMutex (Mutex, ACPI_DO_NOT_WAIT);
0239     if (ACPI_SUCCESS (Status))
0240     {
0241         return_ACPI_STATUS (Status);
0242     }
0243
0244     if (Status == AE_TIME)
0245     {
0246         /* We must wait, so unlock the interpreter */
0247
0248         AcpiExExitInterpreter ();
0249         Status = AcpiOsAcquireMutex (Mutex, Timeout);
0250
0251         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
0252             "*** Thread awake after blocking, %s\n",
0253             AcpiFormatException (Status)));
0254
0255         /* Reacquire the interpreter */
0256
0257         AcpiExEnterInterpreter ();
0258     }
0259
0260     return_ACPI_STATUS (Status);
0261 }
0262
0263
0264 /*******************************************************************************
0265  *
0266  * FUNCTION:    AcpiExSystemDoStall
0267  *
0268  * PARAMETERS:  HowLongUs       - The amount of time to stall,
0269  *                                in microseconds
0270  *
0271  * RETURN:      Status
0272  *
0273  * DESCRIPTION: Suspend running thread for specified amount of time.
0274  *              Note: ACPI specification requires that Stall() does not
0275  *              relinquish the processor, and delays longer than 100 usec
0276  *              should use Sleep() instead. We allow stalls up to 255 usec
0277  *              for compatibility with other interpreters and existing BIOSs.
0278  *
0279  ******************************************************************************/
0280
0281 ACPI_STATUS
0282 AcpiExSystemDoStall (
0283     UINT32                  HowLongUs)
0284 {
0285     ACPI_STATUS             Status = AE_OK;
0286
0287
0288     ACPI_FUNCTION_ENTRY ();
0289
0290
0291     if (HowLongUs > 255)
0292     {
0293         /*
0294          * Longer than 255 microseconds, this is an error
0295          *
0296          * (ACPI specifies 100 usec as max, but this gives some slack in
0297          * order to support existing BIOSs)
0298          */
0299         ACPI_ERROR_ONCE ((AE_INFO,
0300             "Time parameter is too large (%u)", HowLongUs));
0301         Status = AE_AML_OPERAND_VALUE;
0302     }
0303     else
0304     {
0305         if (HowLongUs > 100)
0306         {
0307             ACPI_WARNING_ONCE ((AE_INFO,
0308                 "Time parameter %u us > 100 us violating ACPI spec, please fix the firmware.", HowLongUs));
0309         }
0310         AcpiOsStall (HowLongUs);
0311     }
0312
0313     return (Status);
0314 }
0315
0316
0317 /*******************************************************************************
0318  *
0319  * FUNCTION:    AcpiExSystemDoSleep
0320  *
0321  * PARAMETERS:  HowLongMs       - The amount of time to sleep,
0322  *                                in milliseconds
0323  *
0324  * RETURN:      None
0325  *
0326  * DESCRIPTION: Sleep the running thread for specified amount of time.
0327  *
0328  ******************************************************************************/
0329
0330 ACPI_STATUS
0331 AcpiExSystemDoSleep (
0332     UINT64                  HowLongMs)
0333 {
0334     ACPI_FUNCTION_ENTRY ();
0335
0336
0337     /* Since this thread will sleep, we must release the interpreter */
0338
0339     AcpiExExitInterpreter ();
0340
0341     /*
0342      * For compatibility with other ACPI implementations and to prevent
0343      * accidental deep sleeps, limit the sleep time to something reasonable.
0344      */
0345     if (HowLongMs > ACPI_MAX_SLEEP)
0346     {
0347         HowLongMs = ACPI_MAX_SLEEP;
0348     }
0349
0350     AcpiOsSleep (HowLongMs);
0351
0352     /* And now we must get the interpreter again */
0353
0354     AcpiExEnterInterpreter ();
0355     return (AE_OK);
0356 }
0357
0358
0359 /*******************************************************************************
0360  *
0361  * FUNCTION:    AcpiExSystemSignalEvent
0362  *
0363  * PARAMETERS:  ObjDesc         - The object descriptor for this op
0364  *
0365  * RETURN:      Status
0366  *
0367  * DESCRIPTION: Provides an access point to perform synchronization operations
0368  *              within the AML.
0369  *
0370  ******************************************************************************/
0371
0372 ACPI_STATUS
0373 AcpiExSystemSignalEvent (
0374     ACPI_OPERAND_OBJECT     *ObjDesc)
0375 {
0376     ACPI_STATUS             Status = AE_OK;
0377
0378
0379     ACPI_FUNCTION_TRACE (ExSystemSignalEvent);
0380
0381
0382     if (ObjDesc)
0383     {
0384         Status = AcpiOsSignalSemaphore (ObjDesc->Event.OsSemaphore, 1);
0385     }
0386
0387     return_ACPI_STATUS (Status);
0388 }
0389
0390
0391 /*******************************************************************************
0392  *
0393  * FUNCTION:    AcpiExSystemWaitEvent
0394  *
0395  * PARAMETERS:  TimeDesc        - The 'time to delay' object descriptor
0396  *              ObjDesc         - The object descriptor for this op
0397  *
0398  * RETURN:      Status
0399  *
0400  * DESCRIPTION: Provides an access point to perform synchronization operations
0401  *              within the AML. This operation is a request to wait for an
0402  *              event.
0403  *
0404  ******************************************************************************/
0405
0406 ACPI_STATUS
0407 AcpiExSystemWaitEvent (
0408     ACPI_OPERAND_OBJECT     *TimeDesc,
0409     ACPI_OPERAND_OBJECT     *ObjDesc)
0410 {
0411     ACPI_STATUS             Status = AE_OK;
0412
0413
0414     ACPI_FUNCTION_TRACE (ExSystemWaitEvent);
0415
0416
0417     if (ObjDesc)
0418     {
0419         Status = AcpiExSystemWaitSemaphore (ObjDesc->Event.OsSemaphore,
0420             (UINT16) TimeDesc->Integer.Value);
0421     }
0422
0423     return_ACPI_STATUS (Status);
0424 }
0425
0426
0427 /*******************************************************************************
0428  *
0429  * FUNCTION:    AcpiExSystemResetEvent
0430  *
0431  * PARAMETERS:  ObjDesc         - The object descriptor for this op
0432  *
0433  * RETURN:      Status
0434  *
0435  * DESCRIPTION: Reset an event to a known state.
0436  *
0437  ******************************************************************************/
0438
0439 ACPI_STATUS
0440 AcpiExSystemResetEvent (
0441     ACPI_OPERAND_OBJECT     *ObjDesc)
0442 {
0443     ACPI_STATUS             Status = AE_OK;
0444     ACPI_SEMAPHORE          TempSemaphore;
0445
0446
0447     ACPI_FUNCTION_ENTRY ();
0448
0449
0450     /*
0451      * We are going to simply delete the existing semaphore and
0452      * create a new one!
0453      */
0454     Status = AcpiOsCreateSemaphore (ACPI_NO_UNIT_LIMIT, 0, &TempSemaphore);
0455     if (ACPI_SUCCESS (Status))
0456     {
0457         (void) AcpiOsDeleteSemaphore (ObjDesc->Event.OsSemaphore);
0458         ObjDesc->Event.OsSemaphore = TempSemaphore;
0459     }
0460
0461     return (Status);
0462 }