nsxfeval.c revision 7c478bd95313f5f23a4c958a745db2134aa03244
/*******************************************************************************
*
* Module Name: nsxfeval - Public interfaces to the ACPI subsystem
* ACPI Object evaluation interfaces
* $Revision: 17 $
*
******************************************************************************/
/******************************************************************************
*
* 1. Copyright Notice
*
* Some or all of this work - Copyright (c) 1999 - 2005, 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
* 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
* 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
* compliance with all laws, regulations, orders, or other restrictions of the
* U.S. Export Administration Regulations. Licensee agrees that neither it nor
* 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 __NSXFEVAL_C__
#include "acpi.h"
#include "acnamesp.h"
#include "acinterp.h"
#define _COMPONENT ACPI_NAMESPACE
ACPI_MODULE_NAME ("nsxfeval")
/*******************************************************************************
*
* FUNCTION: AcpiEvaluateObjectTyped
*
* PARAMETERS: Handle - Object handle (optional)
* Pathname - Object pathname (optional)
* ExternalParams - List of parameters to pass to method,
* terminated by NULL. May be NULL
* if no parameters are being passed.
* ReturnBuffer - Where to put method's return value (if
* any). If NULL, no value is returned.
* ReturnType - Expected type of return object
*
* RETURN: Status
*
* DESCRIPTION: Find and evaluate the given object, passing the given
* parameters if necessary. One of "Handle" or "Pathname" must
* be valid (non-null)
*
******************************************************************************/
{
ACPI_FUNCTION_TRACE ("AcpiEvaluateObjectTyped");
/* Return buffer must be valid */
if (!ReturnBuffer)
{
}
{
}
/* Evaluate the object */
if (ACPI_FAILURE (Status))
{
}
/* Type ANY means "don't care" */
if (ReturnType == ACPI_TYPE_ANY)
{
}
if (ReturnBuffer->Length == 0)
{
/* Error because caller specifically asked for a return value */
"No return value\n"));
}
/* Examine the object type returned from EvaluateObject */
{
}
/* Return object type does not match requested type */
"Incorrect return type [%s] requested [%s]\n",
if (MustFree)
{
/* Caller used ACPI_ALLOCATE_BUFFER, free the return buffer */
}
ReturnBuffer->Length = 0;
}
/*******************************************************************************
*
* FUNCTION: AcpiEvaluateObject
*
* PARAMETERS: Handle - Object handle (optional)
* Pathname - Object pathname (optional)
* ExternalParams - List of parameters to pass to method,
* terminated by NULL. May be NULL
* if no parameters are being passed.
* ReturnBuffer - Where to put method's return value (if
* any). If NULL, no value is returned.
*
* RETURN: Status
*
* DESCRIPTION: Find and evaluate the given object, passing the given
* parameters if necessary. One of "Handle" or "Pathname" must
* be valid (non-null)
*
******************************************************************************/
{
UINT32 i;
ACPI_FUNCTION_TRACE ("AcpiEvaluateObject");
/*
* If there are parameters to be passed to the object
* (which must be a control method), the external objects
* must be converted to internal objects
*/
{
/*
* Allocate a new parameter block for the internal objects
* Add 1 to count to allow for null terminated internal list
*/
sizeof (void *));
if (!Info.Parameters)
{
}
/*
* Convert each external object in the list to an
* internal object
*/
for (i = 0; i < ExternalParams->Count; i++)
{
&Info.Parameters[i]);
if (ACPI_FAILURE (Status))
{
}
}
}
/*
* Three major cases:
* 1) Fully qualified pathname
* 2) No handle, not fully qualified pathname (error)
* 3) Valid handle
*/
if ((Pathname) &&
(AcpiNsValidRootPrefix (Pathname[0])))
{
/*
* The path is fully qualified, just evaluate by name
*/
}
else if (!Handle)
{
/*
* A handle is optional iff a fully qualified pathname
* is specified. Since we've already handled fully
* qualified names above, this is an error
*/
if (!Pathname)
{
"Both Handle and Pathname are NULL\n"));
}
else
{
"Handle is NULL and Pathname is relative\n"));
}
}
else
{
/*
* We get here if we have a handle -- and if we have a
* pathname it is relative. The handle will be validated
* in the lower procedures
*/
if (!Pathname)
{
/*
* The null pathname case means the handle is for
* the actual object to be evaluated
*/
}
else
{
/*
* Both a Handle and a relative Pathname
*/
}
}
/*
* If we are expecting a return value, and all went well above,
* copy the return value to an external object.
*/
if (ReturnBuffer)
{
if (!Info.ReturnObject)
{
ReturnBuffer->Length = 0;
}
else
{
{
/*
* If we received a NS Node as a return object, this means that
* the object we are evaluating has nothing interesting to
* return (such as a mutex, etc.) We return an error because
* these types are essentially unsupported by this interface.
* We don't check up front because this makes it easier to add
* support for various types at a later date if necessary.
*/
ReturnBuffer->Length = 0;
}
if (ACPI_SUCCESS (Status))
{
/*
* Find out how large a buffer is needed
* to contain the returned object
*/
if (ACPI_SUCCESS (Status))
{
if (ACPI_FAILURE (Status))
{
/*
* Caller's buffer is too small or a new one can't be allocated
*/
"Needed buffer size %X, %s\n",
}
else
{
/*
* We have enough space for the object, build it
*/
}
}
}
}
}
if (Info.ReturnObject)
{
/*
* Delete the internal return object. NOTE: Interpreter
* must be locked to avoid race condition.
*/
if (ACPI_SUCCESS (Status2))
{
/*
* Delete the internal return object. (Or at least
* decrement the reference count by one)
*/
}
}
/*
* Free the input parameter list (if we created one),
*/
if (Info.Parameters)
{
/* Free the allocated parameter block */
}
}
/*******************************************************************************
*
* FUNCTION: AcpiWalkNamespace
*
* PARAMETERS: Type - ACPI_OBJECT_TYPE to search for
* StartObject - Handle in namespace where search begins
* MaxDepth - Depth to which search is to reach
* UserFunction - Called when an object of "Type" is found
* Context - Passed to user function
* ReturnValue - Location where return value of
* UserFunction is put if terminated early
*
* RETURNS Return value from the UserFunction if terminated early.
* Otherwise, returns NULL.
*
* DESCRIPTION: Performs a modified depth-first walk of the namespace tree,
* starting (and ending) at the object specified by StartHandle.
* The UserFunction is called whenever an object that matches
* the type parameter is found. If the user function returns
* a non-zero value, the search is terminated immediately and this
* value is returned to the caller.
*
* The point of this procedure is to provide a generic namespace
* walk routine that can be called from multiple places to
* provide multiple services; the User Function can be tailored
* to each task, whether it is a print function, a compare
* function, etc.
*
******************************************************************************/
void *Context,
void **ReturnValue)
{
ACPI_FUNCTION_TRACE ("AcpiWalkNamespace");
/* Parameter validation */
if ((Type > ACPI_TYPE_EXTERNAL_MAX) ||
(!MaxDepth) ||
(!UserFunction))
{
}
/*
* Lock the namespace around the walk.
* to the user function - since this function
* must be allowed to make Acpi calls itself.
*/
if (ACPI_FAILURE (Status))
{
}
(void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
}
/*******************************************************************************
*
* FUNCTION: AcpiNsGetDeviceCallback
*
* PARAMETERS: Callback from AcpiGetDevice
*
* RETURN: Status
*
* DESCRIPTION: Takes callbacks from WalkNamespace and filters out all non-
* present devices, or if they specified a HID, it filters based
* on that.
*
******************************************************************************/
static ACPI_STATUS
void *Context,
void **ReturnValue)
{
if (ACPI_FAILURE (Status))
{
return (Status);
}
if (ACPI_FAILURE (Status))
{
return (Status);
}
if (!Node)
{
return (AE_BAD_PARAMETER);
}
/* Run _STA to determine if device is present */
if (ACPI_FAILURE (Status))
{
return (AE_CTRL_DEPTH);
}
if (!(Flags & 0x01))
{
/* Don't return at the device or children of the device if not there */
return (AE_CTRL_DEPTH);
}
/* Filter based on device HID & CID */
{
if (Status == AE_NOT_FOUND)
{
return (AE_OK);
}
else if (ACPI_FAILURE (Status))
{
return (AE_CTRL_DEPTH);
}
{
/* Get the list of Compatible IDs */
if (Status == AE_NOT_FOUND)
{
return (AE_OK);
}
else if (ACPI_FAILURE (Status))
{
return (AE_CTRL_DEPTH);
}
/* Walk the CID list */
{
sizeof (ACPI_COMPATIBLE_ID)) != 0)
{
ACPI_MEM_FREE (Cid);
return (AE_OK);
}
}
ACPI_MEM_FREE (Cid);
}
}
return (Status);
}
/*******************************************************************************
*
* FUNCTION: AcpiGetDevices
*
* PARAMETERS: HID - HID to search for. Can be NULL.
* UserFunction - Called when a matching object is found
* Context - Passed to user function
* ReturnValue - Location where return value of
* UserFunction is put if terminated early
*
* RETURNS Return value from the UserFunction if terminated early.
* Otherwise, returns NULL.
*
* DESCRIPTION: Performs a modified depth-first walk of the namespace tree,
* starting (and ending) at the object specified by StartHandle.
* The UserFunction is called whenever an object of type
* Device is found. If the user function returns
* a non-zero value, the search is terminated immediately and this
* value is returned to the caller.
*
* This is a wrapper for WalkNamespace, but the callback performs
* additional filtering. Please see AcpiGetDeviceCallback.
*
******************************************************************************/
char *HID,
void *Context,
void **ReturnValue)
{
ACPI_FUNCTION_TRACE ("AcpiGetDevices");
/* Parameter validation */
if (!UserFunction)
{
}
/*
* We're going to call their callback from OUR callback, so we need
* to know what it is, and their context parameter.
*/
/*
* Lock the namespace around the walk.
* to the user function - since this function
* must be allowed to make Acpi calls itself.
*/
if (ACPI_FAILURE (Status))
{
}
(void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
}
/*******************************************************************************
*
* FUNCTION: AcpiAttachData
*
* PARAMETERS: ObjHandle - Namespace node
* Handler - Handler for this attachment
* Data - Pointer to data to be attached
*
* RETURN: Status
*
* DESCRIPTION: Attach arbitrary data and handler to a namespace node.
*
******************************************************************************/
void *Data)
{
/* Parameter validation */
if (!ObjHandle ||
!Handler ||
!Data)
{
return (AE_BAD_PARAMETER);
}
if (ACPI_FAILURE (Status))
{
return (Status);
}
/* Convert and validate the handle */
if (!Node)
{
goto UnlockAndExit;
}
(void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
return (Status);
}
/*******************************************************************************
*
* FUNCTION: AcpiDetachData
*
* PARAMETERS: ObjHandle - Namespace node handle
* Handler - Handler used in call to AcpiAttachData
*
* RETURN: Status
*
* DESCRIPTION: Remove data that was previously attached to a node.
*
******************************************************************************/
{
/* Parameter validation */
if (!ObjHandle ||
!Handler)
{
return (AE_BAD_PARAMETER);
}
if (ACPI_FAILURE (Status))
{
return (Status);
}
/* Convert and validate the handle */
if (!Node)
{
goto UnlockAndExit;
}
(void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
return (Status);
}
/*******************************************************************************
*
* FUNCTION: AcpiGetData
*
* PARAMETERS: ObjHandle - Namespace node
* Handler - Handler used in call to AttachData
* Data - Where the data is returned
*
* RETURN: Status
*
* DESCRIPTION: Retrieve data that was previously attached to a namespace node.
*
******************************************************************************/
void **Data)
{
/* Parameter validation */
if (!ObjHandle ||
!Handler ||
!Data)
{
return (AE_BAD_PARAMETER);
}
if (ACPI_FAILURE (Status))
{
return (Status);
}
/* Convert and validate the handle */
if (!Node)
{
goto UnlockAndExit;
}
(void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
return (Status);
}