acpica/executer/exsystem.c

db2bae30SDana Myers/******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * Module Name: exsystem - Interface to OS services
db2bae30SDana Myers *
db2bae30SDana Myers *****************************************************************************/
db2bae30SDana Myers
26f3cdf0SGordon Ross/*
*385cc6b4SJerry Jelinek * Copyright (C) 2000 - 2016, Intel Corp.
db2bae30SDana Myers * All rights reserved.
db2bae30SDana Myers *
26f3cdf0SGordon Ross * Redistribution and use in source and binary forms, with or without
26f3cdf0SGordon Ross * modification, are permitted provided that the following conditions
26f3cdf0SGordon Ross * are met:
26f3cdf0SGordon Ross * 1. Redistributions of source code must retain the above copyright
26f3cdf0SGordon Ross *    notice, this list of conditions, and the following disclaimer,
26f3cdf0SGordon Ross *    without modification.
26f3cdf0SGordon Ross * 2. Redistributions in binary form must reproduce at minimum a disclaimer
26f3cdf0SGordon Ross *    substantially similar to the "NO WARRANTY" disclaimer below
26f3cdf0SGordon Ross *    ("Disclaimer") and any redistribution must be conditioned upon
26f3cdf0SGordon Ross *    including a substantially similar Disclaimer requirement for further
26f3cdf0SGordon Ross *    binary redistribution.
26f3cdf0SGordon Ross * 3. Neither the names of the above-listed copyright holders nor the names
26f3cdf0SGordon Ross *    of any contributors may be used to endorse or promote products derived
26f3cdf0SGordon Ross *    from this software without specific prior written permission.
db2bae30SDana Myers *
26f3cdf0SGordon Ross * Alternatively, this software may be distributed under the terms of the
26f3cdf0SGordon Ross * GNU General Public License ("GPL") version 2 as published by the Free
26f3cdf0SGordon Ross * Software Foundation.
db2bae30SDana Myers *
26f3cdf0SGordon Ross * NO WARRANTY
26f3cdf0SGordon Ross * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26f3cdf0SGordon Ross * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26f3cdf0SGordon Ross * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
26f3cdf0SGordon Ross * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26f3cdf0SGordon Ross * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26f3cdf0SGordon Ross * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26f3cdf0SGordon Ross * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26f3cdf0SGordon Ross * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26f3cdf0SGordon Ross * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
26f3cdf0SGordon Ross * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26f3cdf0SGordon Ross * POSSIBILITY OF SUCH DAMAGES.
26f3cdf0SGordon Ross */
db2bae30SDana Myers
db2bae30SDana Myers#include "acpi.h"
aa2aa9a6SDana Myers#include "accommon.h"
db2bae30SDana Myers#include "acinterp.h"
db2bae30SDana Myers
db2bae30SDana Myers#define _COMPONENT          ACPI_EXECUTER
db2bae30SDana Myers        ACPI_MODULE_NAME    ("exsystem")
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiExSystemWaitSemaphore
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  Semaphore       - Semaphore to wait on
db2bae30SDana Myers *              Timeout         - Max time to wait
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Status
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Implements a semaphore wait with a check to see if the
db2bae30SDana Myers *              semaphore is available immediately. If it is not, the
db2bae30SDana Myers *              interpreter is released before waiting.
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersACPI_STATUS
db2bae30SDana MyersAcpiExSystemWaitSemaphore (
db2bae30SDana Myers    ACPI_SEMAPHORE          Semaphore,
db2bae30SDana Myers    UINT16                  Timeout)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_STATUS             Status;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_TRACE (ExSystemWaitSemaphore);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    Status = AcpiOsWaitSemaphore (Semaphore, 1, ACPI_DO_NOT_WAIT);
db2bae30SDana Myers    if (ACPI_SUCCESS (Status))
db2bae30SDana Myers    {
db2bae30SDana Myers        return_ACPI_STATUS (Status);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    if (Status == AE_TIME)
db2bae30SDana Myers    {
db2bae30SDana Myers        /* We must wait, so unlock the interpreter */
db2bae30SDana Myers
*385cc6b4SJerry Jelinek        AcpiExExitInterpreter ();
db2bae30SDana Myers        Status = AcpiOsWaitSemaphore (Semaphore, 1, Timeout);
db2bae30SDana Myers
db2bae30SDana Myers        ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
db2bae30SDana Myers            "*** Thread awake after blocking, %s\n",
db2bae30SDana Myers            AcpiFormatException (Status)));
db2bae30SDana Myers
db2bae30SDana Myers        /* Reacquire the interpreter */
db2bae30SDana Myers
*385cc6b4SJerry Jelinek        AcpiExEnterInterpreter ();
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    return_ACPI_STATUS (Status);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiExSystemWaitMutex
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  Mutex           - Mutex to wait on
db2bae30SDana Myers *              Timeout         - Max time to wait
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Status
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Implements a mutex wait with a check to see if the
db2bae30SDana Myers *              mutex is available immediately. If it is not, the
db2bae30SDana Myers *              interpreter is released before waiting.
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersACPI_STATUS
db2bae30SDana MyersAcpiExSystemWaitMutex (
db2bae30SDana Myers    ACPI_MUTEX              Mutex,
db2bae30SDana Myers    UINT16                  Timeout)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_STATUS             Status;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_TRACE (ExSystemWaitMutex);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    Status = AcpiOsAcquireMutex (Mutex, ACPI_DO_NOT_WAIT);
db2bae30SDana Myers    if (ACPI_SUCCESS (Status))
db2bae30SDana Myers    {
db2bae30SDana Myers        return_ACPI_STATUS (Status);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    if (Status == AE_TIME)
db2bae30SDana Myers    {
db2bae30SDana Myers        /* We must wait, so unlock the interpreter */
db2bae30SDana Myers
*385cc6b4SJerry Jelinek        AcpiExExitInterpreter ();
db2bae30SDana Myers        Status = AcpiOsAcquireMutex (Mutex, Timeout);
db2bae30SDana Myers
db2bae30SDana Myers        ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
db2bae30SDana Myers            "*** Thread awake after blocking, %s\n",
db2bae30SDana Myers            AcpiFormatException (Status)));
db2bae30SDana Myers
db2bae30SDana Myers        /* Reacquire the interpreter */
db2bae30SDana Myers
*385cc6b4SJerry Jelinek        AcpiExEnterInterpreter ();
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    return_ACPI_STATUS (Status);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiExSystemDoStall
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  HowLong         - The amount of time to stall,
db2bae30SDana Myers *                                in microseconds
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Status
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Suspend running thread for specified amount of time.
db2bae30SDana Myers *              Note: ACPI specification requires that Stall() does not
db2bae30SDana Myers *              relinquish the processor, and delays longer than 100 usec
db2bae30SDana Myers *              should use Sleep() instead. We allow stalls up to 255 usec
db2bae30SDana Myers *              for compatibility with other interpreters and existing BIOSs.
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersACPI_STATUS
db2bae30SDana MyersAcpiExSystemDoStall (
db2bae30SDana Myers    UINT32                  HowLong)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_STATUS             Status = AE_OK;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_ENTRY ();
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    if (HowLong > 255) /* 255 microseconds */
db2bae30SDana Myers    {
db2bae30SDana Myers        /*
db2bae30SDana Myers         * Longer than 255 usec, this is an error
db2bae30SDana Myers         *
db2bae30SDana Myers         * (ACPI specifies 100 usec as max, but this gives some slack in
db2bae30SDana Myers         * order to support existing BIOSs)
db2bae30SDana Myers         */
*385cc6b4SJerry Jelinek        ACPI_ERROR ((AE_INFO,
*385cc6b4SJerry Jelinek            "Time parameter is too large (%u)", HowLong));
db2bae30SDana Myers        Status = AE_AML_OPERAND_VALUE;
db2bae30SDana Myers    }
db2bae30SDana Myers    else
db2bae30SDana Myers    {
db2bae30SDana Myers        AcpiOsStall (HowLong);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    return (Status);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
26f3cdf0SGordon Ross * FUNCTION:    AcpiExSystemDoSleep
db2bae30SDana Myers *
26f3cdf0SGordon Ross * PARAMETERS:  HowLong         - The amount of time to sleep,
db2bae30SDana Myers *                                in milliseconds
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      None
db2bae30SDana Myers *
26f3cdf0SGordon Ross * DESCRIPTION: Sleep the running thread for specified amount of time.
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersACPI_STATUS
26f3cdf0SGordon RossAcpiExSystemDoSleep (
26f3cdf0SGordon Ross    UINT64                  HowLong)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_FUNCTION_ENTRY ();
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    /* Since this thread will sleep, we must release the interpreter */
db2bae30SDana Myers
*385cc6b4SJerry Jelinek    AcpiExExitInterpreter ();
db2bae30SDana Myers
26f3cdf0SGordon Ross    /*
26f3cdf0SGordon Ross     * For compatibility with other ACPI implementations and to prevent
26f3cdf0SGordon Ross     * accidental deep sleeps, limit the sleep time to something reasonable.
26f3cdf0SGordon Ross     */
26f3cdf0SGordon Ross    if (HowLong > ACPI_MAX_SLEEP)
26f3cdf0SGordon Ross    {
26f3cdf0SGordon Ross        HowLong = ACPI_MAX_SLEEP;
26f3cdf0SGordon Ross    }
26f3cdf0SGordon Ross
db2bae30SDana Myers    AcpiOsSleep (HowLong);
db2bae30SDana Myers
db2bae30SDana Myers    /* And now we must get the interpreter again */
db2bae30SDana Myers
*385cc6b4SJerry Jelinek    AcpiExEnterInterpreter ();
db2bae30SDana Myers    return (AE_OK);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiExSystemSignalEvent
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  ObjDesc         - The object descriptor for this op
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Status
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Provides an access point to perform synchronization operations
db2bae30SDana Myers *              within the AML.
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersACPI_STATUS
db2bae30SDana MyersAcpiExSystemSignalEvent (
db2bae30SDana Myers    ACPI_OPERAND_OBJECT     *ObjDesc)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_STATUS             Status = AE_OK;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_TRACE (ExSystemSignalEvent);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    if (ObjDesc)
db2bae30SDana Myers    {
db2bae30SDana Myers        Status = AcpiOsSignalSemaphore (ObjDesc->Event.OsSemaphore, 1);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    return_ACPI_STATUS (Status);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiExSystemWaitEvent
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  TimeDesc        - The 'time to delay' object descriptor
db2bae30SDana Myers *              ObjDesc         - The object descriptor for this op
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Status
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Provides an access point to perform synchronization operations
db2bae30SDana Myers *              within the AML. This operation is a request to wait for an
db2bae30SDana Myers *              event.
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersACPI_STATUS
db2bae30SDana MyersAcpiExSystemWaitEvent (
db2bae30SDana Myers    ACPI_OPERAND_OBJECT     *TimeDesc,
db2bae30SDana Myers    ACPI_OPERAND_OBJECT     *ObjDesc)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_STATUS             Status = AE_OK;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_TRACE (ExSystemWaitEvent);
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    if (ObjDesc)
db2bae30SDana Myers    {
db2bae30SDana Myers        Status = AcpiExSystemWaitSemaphore (ObjDesc->Event.OsSemaphore,
db2bae30SDana Myers            (UINT16) TimeDesc->Integer.Value);
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    return_ACPI_STATUS (Status);
db2bae30SDana Myers}
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers/*******************************************************************************
db2bae30SDana Myers *
db2bae30SDana Myers * FUNCTION:    AcpiExSystemResetEvent
db2bae30SDana Myers *
db2bae30SDana Myers * PARAMETERS:  ObjDesc         - The object descriptor for this op
db2bae30SDana Myers *
db2bae30SDana Myers * RETURN:      Status
db2bae30SDana Myers *
db2bae30SDana Myers * DESCRIPTION: Reset an event to a known state.
db2bae30SDana Myers *
db2bae30SDana Myers ******************************************************************************/
db2bae30SDana Myers
db2bae30SDana MyersACPI_STATUS
db2bae30SDana MyersAcpiExSystemResetEvent (
db2bae30SDana Myers    ACPI_OPERAND_OBJECT     *ObjDesc)
db2bae30SDana Myers{
db2bae30SDana Myers    ACPI_STATUS             Status = AE_OK;
db2bae30SDana Myers    ACPI_SEMAPHORE          TempSemaphore;
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    ACPI_FUNCTION_ENTRY ();
db2bae30SDana Myers
db2bae30SDana Myers
db2bae30SDana Myers    /*
db2bae30SDana Myers     * We are going to simply delete the existing semaphore and
db2bae30SDana Myers     * create a new one!
db2bae30SDana Myers     */
db2bae30SDana Myers    Status = AcpiOsCreateSemaphore (ACPI_NO_UNIT_LIMIT, 0, &TempSemaphore);
db2bae30SDana Myers    if (ACPI_SUCCESS (Status))
db2bae30SDana Myers    {
db2bae30SDana Myers        (void) AcpiOsDeleteSemaphore (ObjDesc->Event.OsSemaphore);
db2bae30SDana Myers        ObjDesc->Event.OsSemaphore = TempSemaphore;
db2bae30SDana Myers    }
db2bae30SDana Myers
db2bae30SDana Myers    return (Status);
db2bae30SDana Myers}