freebsd-dev/sys/contrib/dev/acpica/utxface.c

538 lines
16 KiB
C

/******************************************************************************
*
* Module Name: cmxface - External interfaces for "global" ACPI functions
* $Revision: 64 $
*
*****************************************************************************/
/******************************************************************************
*
* 1. Copyright Notice
*
* Some or all of this work - Copyright (c) 1999, 2000, 2001, 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.
*
*****************************************************************************/
#define __CMXFACE_C__
#include "acpi.h"
#include "acevents.h"
#include "achware.h"
#include "acnamesp.h"
#include "acinterp.h"
#include "amlcode.h"
#include "acdebug.h"
#define _COMPONENT MISCELLANEOUS
MODULE_NAME ("cmxface")
/*******************************************************************************
*
* FUNCTION: AcpiInitializeSubsystem
*
* PARAMETERS: None
*
* RETURN: Status
*
* DESCRIPTION: Initializes all global variables. This is the first function
* called, so any early initialization belongs here.
*
******************************************************************************/
ACPI_STATUS
AcpiInitializeSubsystem (
void)
{
ACPI_STATUS Status;
FUNCTION_TRACE ("AcpiInitializeSubsystem");
/* Initialize all globals used by the subsystem */
AcpiCmInitGlobals ();
/* Initialize the OS-Dependent layer */
Status = AcpiOsInitialize ();
if (ACPI_FAILURE (Status))
{
REPORT_ERROR (("OSD failed to initialize, %s\n",
AcpiCmFormatException (Status)));
return_ACPI_STATUS (Status);
}
/* Create the default mutex objects */
Status = AcpiCmMutexInitialize ();
if (ACPI_FAILURE (Status))
{
REPORT_ERROR (("Global mutex creation failure, %s\n",
AcpiCmFormatException (Status)));
return_ACPI_STATUS (Status);
}
/*
* Initialize the namespace manager and
* the root of the namespace tree
*/
Status = AcpiNsRootInitialize ();
if (ACPI_FAILURE (Status))
{
REPORT_ERROR (("Namespace initialization failure, %s\n",
AcpiCmFormatException (Status)));
return_ACPI_STATUS (Status);
}
/* If configured, initialize the AML debugger */
DEBUGGER_EXEC (AcpiDbInitialize ());
return_ACPI_STATUS (Status);
}
/*******************************************************************************
*
* FUNCTION: AcpiEnableSubsystem
*
* PARAMETERS: Flags - Init/enable Options
*
* RETURN: Status
*
* DESCRIPTION: Completes the subsystem initialization including hardware.
* Puts system into ACPI mode if it isn't already.
*
******************************************************************************/
ACPI_STATUS
AcpiEnableSubsystem (
UINT32 Flags)
{
ACPI_STATUS Status = AE_OK;
FUNCTION_TRACE ("AcpiEnableSubsystem");
/* Sanity check the FADT for valid values */
Status = AcpiCmValidateFadt ();
if (ACPI_FAILURE (Status))
{
return_ACPI_STATUS (Status);
}
/*
* Install the default OpRegion handlers. These are
* installed unless other handlers have already been
* installed via the InstallAddressSpaceHandler interface
*/
if (!(Flags & ACPI_NO_ADDRESS_SPACE_INIT))
{
DEBUG_PRINT (TRACE_EXEC, ("[Init] Installing default address space handlers\n"));
Status = AcpiEvInstallDefaultAddressSpaceHandlers ();
if (ACPI_FAILURE (Status))
{
return_ACPI_STATUS (Status);
}
}
/*
* We must initialize the hardware before we can enable ACPI.
*/
if (!(Flags & ACPI_NO_HARDWARE_INIT))
{
DEBUG_PRINT (TRACE_EXEC, ("[Init] Initializing ACPI hardware\n"));
Status = AcpiHwInitialize ();
if (ACPI_FAILURE (Status))
{
return_ACPI_STATUS (Status);
}
}
/*
* Enable ACPI on this platform
*/
if (!(Flags & ACPI_NO_ACPI_ENABLE))
{
DEBUG_PRINT (TRACE_EXEC, ("[Init] Going into ACPI mode\n"));
Status = AcpiEnable ();
if (ACPI_FAILURE (Status))
{
DEBUG_PRINT(ACPI_WARN, ("AcpiEnable failed.\n"));
return_ACPI_STATUS (Status);
}
}
/*
* Note:
* We must have the hardware AND events initialized before we can execute
* ANY control methods SAFELY. Any control method can require ACPI hardware
* support, so the hardware MUST be initialized before execution!
*/
if (!(Flags & ACPI_NO_EVENT_INIT))
{
DEBUG_PRINT (TRACE_EXEC, ("[Init] Initializing ACPI events\n"));
Status = AcpiEvInitialize ();
if (ACPI_FAILURE (Status))
{
return_ACPI_STATUS (Status);
}
}
/*
* Initialize all device objects in the namespace
* This runs the _STA and _INI methods.
*/
if (!(Flags & ACPI_NO_DEVICE_INIT))
{
DEBUG_PRINT (TRACE_EXEC, ("[Init] Initializing ACPI Devices\n"));
Status = AcpiNsInitializeDevices ();
if (ACPI_FAILURE (Status))
{
return_ACPI_STATUS (Status);
}
}
/*
* Initialize the objects that remain uninitialized. This
* runs the executable AML that is part of the declaration of OpRegions
* and Fields.
*/
if (!(Flags & ACPI_NO_OBJECT_INIT))
{
DEBUG_PRINT (TRACE_EXEC, ("[Init] Initializing ACPI Objects\n"));
Status = AcpiNsInitializeObjects ();
if (ACPI_FAILURE (Status))
{
return_ACPI_STATUS (Status);
}
}
return_ACPI_STATUS (Status);
}
/*******************************************************************************
*
* FUNCTION: AcpiTerminate
*
* PARAMETERS: None
*
* RETURN: Status
*
* DESCRIPTION: Shutdown the ACPI subsystem. Release all resources.
*
******************************************************************************/
ACPI_STATUS
AcpiTerminate (void)
{
FUNCTION_TRACE ("AcpiTerminate");
/* Terminate the AML Debuger if present */
DEBUGGER_EXEC(AcpiGbl_DbTerminateThreads = TRUE);
/* TBD: [Investigate] This is no longer needed?*/
/* AcpiCmReleaseMutex (ACPI_MTX_DEBUG_CMD_READY); */
/* Shutdown and free all resources */
AcpiCmSubsystemShutdown ();
/* Free the mutex objects */
AcpiCmMutexTerminate ();
/* Now we can shutdown the OS-dependent layer */
AcpiOsTerminate ();
return_ACPI_STATUS (AE_OK);
}
/******************************************************************************
*
* FUNCTION: AcpiGetSystemInfo
*
* PARAMETERS: OutBuffer - a pointer to a buffer to receive the
* resources for the device
* BufferLength - the number of bytes available in the buffer
*
* RETURN: Status - the status of the call
*
* DESCRIPTION: This function is called to get information about the current
* state of the ACPI subsystem. It will return system information
* in the OutBuffer.
*
* If the function fails an appropriate status will be returned
* and the value of OutBuffer is undefined.
*
******************************************************************************/
ACPI_STATUS
AcpiGetSystemInfo (
ACPI_BUFFER *OutBuffer)
{
ACPI_SYSTEM_INFO *InfoPtr;
UINT32 i;
FUNCTION_TRACE ("AcpiGetSystemInfo");
/*
* Must have a valid buffer
*/
if ((!OutBuffer) ||
(!OutBuffer->Pointer))
{
return_ACPI_STATUS (AE_BAD_PARAMETER);
}
if (OutBuffer->Length < sizeof (ACPI_SYSTEM_INFO))
{
/*
* Caller's buffer is too small
*/
OutBuffer->Length = sizeof (ACPI_SYSTEM_INFO);
return_ACPI_STATUS (AE_BUFFER_OVERFLOW);
}
/*
* Set return length and get data
*/
OutBuffer->Length = sizeof (ACPI_SYSTEM_INFO);
InfoPtr = (ACPI_SYSTEM_INFO *) OutBuffer->Pointer;
InfoPtr->AcpiCaVersion = ACPI_CA_VERSION;
/* System flags (ACPI capabilities) */
InfoPtr->Flags = AcpiGbl_SystemFlags;
/* Timer resolution - 24 or 32 bits */
if (!AcpiGbl_FADT)
{
InfoPtr->TimerResolution = 0;
}
else if (AcpiGbl_FADT->TmrValExt == 0)
{
InfoPtr->TimerResolution = 24;
}
else
{
InfoPtr->TimerResolution = 32;
}
/* Clear the reserved fields */
InfoPtr->Reserved1 = 0;
InfoPtr->Reserved2 = 0;
/* Current debug levels */
InfoPtr->DebugLayer = AcpiDbgLayer;
InfoPtr->DebugLevel = AcpiDbgLevel;
/* Current status of the ACPI tables, per table type */
InfoPtr->NumTableTypes = NUM_ACPI_TABLES;
for (i = 0; i < NUM_ACPI_TABLES; i++)
{
InfoPtr->TableInfo[i].Count = AcpiGbl_AcpiTables[i].Count;
}
return_ACPI_STATUS (AE_OK);
}
/******************************************************************************
*
* FUNCTION: AcpiFormatException
*
* PARAMETERS: OutBuffer - a pointer to a buffer to receive the
* exception name
*
* RETURN: Status - the status of the call
*
* DESCRIPTION: This function translates an ACPI exception into an ASCII string.
*
******************************************************************************/
ACPI_STATUS
AcpiFormatException (
ACPI_STATUS Exception,
ACPI_BUFFER *OutBuffer)
{
UINT32 Length;
NATIVE_CHAR *FormattedException;
FUNCTION_TRACE ("AcpiFormatException");
/*
* Must have a valid buffer
*/
if ((!OutBuffer) ||
(!OutBuffer->Pointer))
{
return_ACPI_STATUS (AE_BAD_PARAMETER);
}
/* Convert the exception code (Handles bad exception codes) */
FormattedException = AcpiCmFormatException (Exception);
/*
* Get length of string and check if it will fit in caller's buffer
*/
Length = STRLEN (FormattedException);
if (OutBuffer->Length < Length)
{
OutBuffer->Length = Length;
return_ACPI_STATUS (AE_BUFFER_OVERFLOW);
}
/* Copy the string, all done */
STRCPY (OutBuffer->Pointer, FormattedException);
return_ACPI_STATUS (AE_OK);
}