FreeBSD/Linux Kernel Cross Reference
sys/contrib/dev/acpica/components/executer/exsystem.c

     /******************************************************************************
      *
      * Module Name: exsystem - Interface to OS services
      *
      *****************************************************************************/
     
     /******************************************************************************
      *
      * 1. Copyright Notice
     *
     * Some or all of this work - Copyright (c) 1999 - 2022, Intel Corp.
     * All rights reserved.
     *
     * 2. License
     *
     * 2.1. This is your license from Intel Corp. under its intellectual property
     * rights. You may have additional license terms from the party that provided
     * you this software, covering your right to use that party's intellectual
     * property rights.
     *
     * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
     * copy of the source code appearing in this file ("Covered Code") an
     * irrevocable, perpetual, worldwide license under Intel's copyrights in the
     * base code distributed originally by Intel ("Original Intel Code") to copy,
     * make derivatives, distribute, use and display any portion of the Covered
     * Code in any form, with the right to sublicense such rights; and
     *
     * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
     * license (with the right to sublicense), under only those claims of Intel
     * patents that are infringed by the Original Intel Code, to make, use, sell,
     * offer to sell, and import the Covered Code and derivative works thereof
     * solely to the minimum extent necessary to exercise the above copyright
     * license, and in no event shall the patent license extend to any additions
     * to or modifications of the Original Intel Code. No other license or right
     * is granted directly or by implication, estoppel or otherwise;
     *
     * The above copyright and patent license is granted only if the following
     * conditions are met:
     *
     * 3. Conditions
     *
     * 3.1. Redistribution of Source with Rights to Further Distribute Source.
     * Redistribution of source code of any substantial portion of the Covered
     * Code or modification with rights to further distribute source must include
     * the above Copyright Notice, the above License, this list of Conditions,
     * and the following Disclaimer and Export Compliance provision. In addition,
     * Licensee must cause all Covered Code to which Licensee contributes to
     * contain a file documenting the changes Licensee made to create that Covered
     * Code and the date of any change. Licensee must include in that file the
     * documentation of any changes made by any predecessor Licensee. Licensee
     * must include a prominent statement that the modification is derived,
     * directly or indirectly, from Original Intel Code.
     *
     * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
     * Redistribution of source code of any substantial portion of the Covered
     * Code or modification without rights to further distribute source must
     * include the following Disclaimer and Export Compliance provision in the
     * documentation and/or other materials provided with distribution. In
     * addition, Licensee may not authorize further sublicense of source of any
     * portion of the Covered Code, and must include terms to the effect that the
     * license from Licensee to its licensee is limited to the intellectual
     * property embodied in the software Licensee provides to its licensee, and
     * not to intellectual property embodied in modifications its licensee may
     * make.
     *
     * 3.3. Redistribution of Executable. Redistribution in executable form of any
     * substantial portion of the Covered Code or modification must reproduce the
     * above Copyright Notice, and the following Disclaimer and Export Compliance
     * provision in the documentation and/or other materials provided with the
     * distribution.
     *
     * 3.4. Intel retains all right, title, and interest in and to the Original
     * Intel Code.
     *
     * 3.5. Neither the name Intel nor any other trademark owned or controlled by
     * Intel shall be used in advertising or otherwise to promote the sale, use or
     * other dealings in products derived from or relating to the Covered Code
     * without prior written authorization from Intel.
     *
     * 4. Disclaimer and Export Compliance
     *
     * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
     * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
     * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
     * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
     * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
     * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
     * PARTICULAR PURPOSE.
     *
     * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
     * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
     * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
     * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
     * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
     * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
     * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
     * LIMITED REMEDY.
     *
     * 4.3. Licensee shall not export, either directly or indirectly, any of this
    * software or system incorporating such software without first obtaining any
    * required license or other approval from the U. S. Department of Commerce or
    * any other agency or department of the United States Government. In the
    * event Licensee exports any such software from the United States or
    * re-exports any such software from a foreign destination, Licensee shall
    * ensure that the distribution and export/re-export of the software is in
    * compliance with all laws, regulations, orders, or other restrictions of the
    * U.S. Export Administration Regulations. Licensee agrees that neither it nor
    * any of its subsidiaries will export/re-export any technical data, process,
    * software, or service, directly or indirectly, to any country for which the
    * United States government or any agency thereof requires an export license,
    * other governmental approval, or letter of assurance, without first obtaining
    * such license, approval or letter.
    *
    *****************************************************************************
    *
    * Alternatively, you may choose to be licensed under the terms of the
    * following license:
    *
    * Redistribution and use in source and binary forms, with or without
    * modification, are permitted provided that the following conditions
    * are met:
    * 1. Redistributions of source code must retain the above copyright
    *    notice, this list of conditions, and the following disclaimer,
    *    without modification.
    * 2. Redistributions in binary form must reproduce at minimum a disclaimer
    *    substantially similar to the "NO WARRANTY" disclaimer below
    *    ("Disclaimer") and any redistribution must be conditioned upon
    *    including a substantially similar Disclaimer requirement for further
    *    binary redistribution.
    * 3. Neither the names of the above-listed copyright holders nor the names
    *    of any contributors may be used to endorse or promote products derived
    *    from this software without specific prior written permission.
    *
    * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
    * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
    * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
    * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
    * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
    * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
    * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
    * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
    * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
    * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    *
    * Alternatively, you may choose to be licensed under the terms of the
    * GNU General Public License ("GPL") version 2 as published by the Free
    * Software Foundation.
    *
    *****************************************************************************/
   
   #include <contrib/dev/acpica/include/acpi.h>
   #include <contrib/dev/acpica/include/accommon.h>
   #include <contrib/dev/acpica/include/acinterp.h>
   
   #define _COMPONENT          ACPI_EXECUTER
           ACPI_MODULE_NAME    ("exsystem")
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AcpiExSystemWaitSemaphore
    *
    * PARAMETERS:  Semaphore       - Semaphore to wait on
    *              Timeout         - Max time to wait
    *
    * RETURN:      Status
    *
    * DESCRIPTION: Implements a semaphore wait with a check to see if the
    *              semaphore is available immediately. If it is not, the
    *              interpreter is released before waiting.
    *
    ******************************************************************************/
   
   ACPI_STATUS
   AcpiExSystemWaitSemaphore (
       ACPI_SEMAPHORE          Semaphore,
       UINT16                  Timeout)
   {
       ACPI_STATUS             Status;
   
   
       ACPI_FUNCTION_TRACE (ExSystemWaitSemaphore);
   
   
       Status = AcpiOsWaitSemaphore (Semaphore, 1, ACPI_DO_NOT_WAIT);
       if (ACPI_SUCCESS (Status))
       {
           return_ACPI_STATUS (Status);
       }
   
       if (Status == AE_TIME)
       {
           /* We must wait, so unlock the interpreter */
   
           AcpiExExitInterpreter ();
           Status = AcpiOsWaitSemaphore (Semaphore, 1, Timeout);
   
           ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
               "*** Thread awake after blocking, %s\n",
               AcpiFormatException (Status)));
   
           /* Reacquire the interpreter */
   
           AcpiExEnterInterpreter ();
       }
   
       return_ACPI_STATUS (Status);
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AcpiExSystemWaitMutex
    *
    * PARAMETERS:  Mutex           - Mutex to wait on
    *              Timeout         - Max time to wait
    *
    * RETURN:      Status
    *
    * DESCRIPTION: Implements a mutex wait with a check to see if the
    *              mutex is available immediately. If it is not, the
    *              interpreter is released before waiting.
    *
    ******************************************************************************/
   
   ACPI_STATUS
   AcpiExSystemWaitMutex (
       ACPI_MUTEX              Mutex,
       UINT16                  Timeout)
   {
       ACPI_STATUS             Status;
   
   
       ACPI_FUNCTION_TRACE (ExSystemWaitMutex);
   
   
       Status = AcpiOsAcquireMutex (Mutex, ACPI_DO_NOT_WAIT);
       if (ACPI_SUCCESS (Status))
       {
           return_ACPI_STATUS (Status);
       }
   
       if (Status == AE_TIME)
       {
           /* We must wait, so unlock the interpreter */
   
           AcpiExExitInterpreter ();
           Status = AcpiOsAcquireMutex (Mutex, Timeout);
   
           ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
               "*** Thread awake after blocking, %s\n",
               AcpiFormatException (Status)));
   
           /* Reacquire the interpreter */
   
           AcpiExEnterInterpreter ();
       }
   
       return_ACPI_STATUS (Status);
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AcpiExSystemDoStall
    *
    * PARAMETERS:  HowLongUs       - The amount of time to stall,
    *                                in microseconds
    *
    * RETURN:      Status
    *
    * DESCRIPTION: Suspend running thread for specified amount of time.
    *              Note: ACPI specification requires that Stall() does not
    *              relinquish the processor, and delays longer than 100 usec
    *              should use Sleep() instead. We allow stalls up to 255 usec
    *              for compatibility with other interpreters and existing BIOSs.
    *
    ******************************************************************************/
   
   ACPI_STATUS
   AcpiExSystemDoStall (
       UINT32                  HowLongUs)
   {
       ACPI_STATUS             Status = AE_OK;
   
   
       ACPI_FUNCTION_ENTRY ();
   
   
       if (HowLongUs > 255)
       {
           /*
            * Longer than 255 microseconds, this is an error
            *
            * (ACPI specifies 100 usec as max, but this gives some slack in
            * order to support existing BIOSs)
            */
           ACPI_ERROR ((AE_INFO,
               "Time parameter is too large (%u)", HowLongUs));
           Status = AE_AML_OPERAND_VALUE;
       }
       else
       {
           if (HowLongUs > 100)
           {
               ACPI_WARNING ((AE_INFO,
                   "Time parameter %u us > 100 us violating ACPI spec, please fix the firmware.", HowLongUs));
           }
           AcpiOsStall (HowLongUs);
       }
   
       return (Status);
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AcpiExSystemDoSleep
    *
    * PARAMETERS:  HowLongMs       - The amount of time to sleep,
    *                                in milliseconds
    *
    * RETURN:      None
    *
    * DESCRIPTION: Sleep the running thread for specified amount of time.
    *
    ******************************************************************************/
   
   ACPI_STATUS
   AcpiExSystemDoSleep (
       UINT64                  HowLongMs)
   {
       ACPI_FUNCTION_ENTRY ();
   
   
       /* Since this thread will sleep, we must release the interpreter */
   
       AcpiExExitInterpreter ();
   
       /*
        * For compatibility with other ACPI implementations and to prevent
        * accidental deep sleeps, limit the sleep time to something reasonable.
        */
       if (HowLongMs > ACPI_MAX_SLEEP)
       {
           HowLongMs = ACPI_MAX_SLEEP;
       }
   
       AcpiOsSleep (HowLongMs);
   
       /* And now we must get the interpreter again */
   
       AcpiExEnterInterpreter ();
       return (AE_OK);
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AcpiExSystemSignalEvent
    *
    * PARAMETERS:  ObjDesc         - The object descriptor for this op
    *
    * RETURN:      Status
    *
    * DESCRIPTION: Provides an access point to perform synchronization operations
    *              within the AML.
    *
    ******************************************************************************/
   
   ACPI_STATUS
   AcpiExSystemSignalEvent (
       ACPI_OPERAND_OBJECT     *ObjDesc)
   {
       ACPI_STATUS             Status = AE_OK;
   
   
       ACPI_FUNCTION_TRACE (ExSystemSignalEvent);
   
   
       if (ObjDesc)
       {
           Status = AcpiOsSignalSemaphore (ObjDesc->Event.OsSemaphore, 1);
       }
   
       return_ACPI_STATUS (Status);
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AcpiExSystemWaitEvent
    *
    * PARAMETERS:  TimeDesc        - The 'time to delay' object descriptor
    *              ObjDesc         - The object descriptor for this op
    *
    * RETURN:      Status
    *
    * DESCRIPTION: Provides an access point to perform synchronization operations
    *              within the AML. This operation is a request to wait for an
    *              event.
    *
    ******************************************************************************/
   
   ACPI_STATUS
   AcpiExSystemWaitEvent (
       ACPI_OPERAND_OBJECT     *TimeDesc,
       ACPI_OPERAND_OBJECT     *ObjDesc)
   {
       ACPI_STATUS             Status = AE_OK;
   
   
       ACPI_FUNCTION_TRACE (ExSystemWaitEvent);
   
   
       if (ObjDesc)
       {
           Status = AcpiExSystemWaitSemaphore (ObjDesc->Event.OsSemaphore,
               (UINT16) TimeDesc->Integer.Value);
       }
   
       return_ACPI_STATUS (Status);
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AcpiExSystemResetEvent
    *
    * PARAMETERS:  ObjDesc         - The object descriptor for this op
    *
    * RETURN:      Status
    *
    * DESCRIPTION: Reset an event to a known state.
    *
    ******************************************************************************/
   
   ACPI_STATUS
   AcpiExSystemResetEvent (
       ACPI_OPERAND_OBJECT     *ObjDesc)
   {
       ACPI_STATUS             Status = AE_OK;
       ACPI_SEMAPHORE          TempSemaphore;
   
   
       ACPI_FUNCTION_ENTRY ();
   
   
       /*
        * We are going to simply delete the existing semaphore and
        * create a new one!
        */
       Status = AcpiOsCreateSemaphore (ACPI_NO_UNIT_LIMIT, 0, &TempSemaphore);
       if (ACPI_SUCCESS (Status))
       {
           (void) AcpiOsDeleteSemaphore (ObjDesc->Event.OsSemaphore);
           ObjDesc->Event.OsSemaphore = TempSemaphore;
       }
   
       return (Status);
   }

Cache object: c0c6fe04ff15c447cb8c8175b3cf715f