1244 lines
39 KiB
C
1244 lines
39 KiB
C
/******************************************************************************
|
|
*
|
|
* Module Name: nspredef - Validation of ACPI predefined methods and objects
|
|
*
|
|
*****************************************************************************/
|
|
|
|
/*
|
|
* Copyright (C) 2000 - 2012, Intel Corp.
|
|
* All rights reserved.
|
|
*
|
|
* 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.
|
|
*
|
|
* Alternatively, this software may be distributed under the terms of the
|
|
* GNU General Public License ("GPL") version 2 as published by the Free
|
|
* Software Foundation.
|
|
*
|
|
* NO WARRANTY
|
|
* 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 MERCHANTIBILITY AND FITNESS FOR
|
|
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
* HOLDERS OR CONTRIBUTORS BE LIABLE FOR 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 DAMAGES.
|
|
*/
|
|
|
|
#define ACPI_CREATE_PREDEFINED_TABLE
|
|
|
|
#include "acpi.h"
|
|
#include "accommon.h"
|
|
#include "acnamesp.h"
|
|
#include "acpredef.h"
|
|
|
|
|
|
#define _COMPONENT ACPI_NAMESPACE
|
|
ACPI_MODULE_NAME ("nspredef")
|
|
|
|
|
|
/*******************************************************************************
|
|
*
|
|
* This module validates predefined ACPI objects that appear in the namespace,
|
|
* at the time they are evaluated (via AcpiEvaluateObject). The purpose of this
|
|
* validation is to detect problems with BIOS-exposed predefined ACPI objects
|
|
* before the results are returned to the ACPI-related drivers.
|
|
*
|
|
* There are several areas that are validated:
|
|
*
|
|
* 1) The number of input arguments as defined by the method/object in the
|
|
* ASL is validated against the ACPI specification.
|
|
* 2) The type of the return object (if any) is validated against the ACPI
|
|
* specification.
|
|
* 3) For returned package objects, the count of package elements is
|
|
* validated, as well as the type of each package element. Nested
|
|
* packages are supported.
|
|
*
|
|
* For any problems found, a warning message is issued.
|
|
*
|
|
******************************************************************************/
|
|
|
|
|
|
/* Local prototypes */
|
|
|
|
static ACPI_STATUS
|
|
AcpiNsCheckPackage (
|
|
ACPI_PREDEFINED_DATA *Data,
|
|
ACPI_OPERAND_OBJECT **ReturnObjectPtr);
|
|
|
|
static ACPI_STATUS
|
|
AcpiNsCheckPackageList (
|
|
ACPI_PREDEFINED_DATA *Data,
|
|
const ACPI_PREDEFINED_INFO *Package,
|
|
ACPI_OPERAND_OBJECT **Elements,
|
|
UINT32 Count);
|
|
|
|
static ACPI_STATUS
|
|
AcpiNsCheckPackageElements (
|
|
ACPI_PREDEFINED_DATA *Data,
|
|
ACPI_OPERAND_OBJECT **Elements,
|
|
UINT8 Type1,
|
|
UINT32 Count1,
|
|
UINT8 Type2,
|
|
UINT32 Count2,
|
|
UINT32 StartIndex);
|
|
|
|
static ACPI_STATUS
|
|
AcpiNsCheckObjectType (
|
|
ACPI_PREDEFINED_DATA *Data,
|
|
ACPI_OPERAND_OBJECT **ReturnObjectPtr,
|
|
UINT32 ExpectedBtypes,
|
|
UINT32 PackageIndex);
|
|
|
|
static ACPI_STATUS
|
|
AcpiNsCheckReference (
|
|
ACPI_PREDEFINED_DATA *Data,
|
|
ACPI_OPERAND_OBJECT *ReturnObject);
|
|
|
|
static void
|
|
AcpiNsGetExpectedTypes (
|
|
char *Buffer,
|
|
UINT32 ExpectedBtypes);
|
|
|
|
/*
|
|
* Names for the types that can be returned by the predefined objects.
|
|
* Used for warning messages. Must be in the same order as the ACPI_RTYPEs
|
|
*/
|
|
static const char *AcpiRtypeNames[] =
|
|
{
|
|
"/Integer",
|
|
"/String",
|
|
"/Buffer",
|
|
"/Package",
|
|
"/Reference",
|
|
};
|
|
|
|
|
|
/*******************************************************************************
|
|
*
|
|
* FUNCTION: AcpiNsCheckPredefinedNames
|
|
*
|
|
* PARAMETERS: Node - Namespace node for the method/object
|
|
* UserParamCount - Number of parameters actually passed
|
|
* ReturnStatus - Status from the object evaluation
|
|
* ReturnObjectPtr - Pointer to the object returned from the
|
|
* evaluation of a method or object
|
|
*
|
|
* RETURN: Status
|
|
*
|
|
* DESCRIPTION: Check an ACPI name for a match in the predefined name list.
|
|
*
|
|
******************************************************************************/
|
|
|
|
ACPI_STATUS
|
|
AcpiNsCheckPredefinedNames (
|
|
ACPI_NAMESPACE_NODE *Node,
|
|
UINT32 UserParamCount,
|
|
ACPI_STATUS ReturnStatus,
|
|
ACPI_OPERAND_OBJECT **ReturnObjectPtr)
|
|
{
|
|
ACPI_OPERAND_OBJECT *ReturnObject = *ReturnObjectPtr;
|
|
ACPI_STATUS Status = AE_OK;
|
|
const ACPI_PREDEFINED_INFO *Predefined;
|
|
char *Pathname;
|
|
ACPI_PREDEFINED_DATA *Data;
|
|
|
|
|
|
/* Match the name for this method/object against the predefined list */
|
|
|
|
Predefined = AcpiNsCheckForPredefinedName (Node);
|
|
|
|
/* Get the full pathname to the object, for use in warning messages */
|
|
|
|
Pathname = AcpiNsGetExternalPathname (Node);
|
|
if (!Pathname)
|
|
{
|
|
return (AE_OK); /* Could not get pathname, ignore */
|
|
}
|
|
|
|
/*
|
|
* Check that the parameter count for this method matches the ASL
|
|
* definition. For predefined names, ensure that both the caller and
|
|
* the method itself are in accordance with the ACPI specification.
|
|
*/
|
|
AcpiNsCheckParameterCount (Pathname, Node, UserParamCount, Predefined);
|
|
|
|
/* If not a predefined name, we cannot validate the return object */
|
|
|
|
if (!Predefined)
|
|
{
|
|
goto Cleanup;
|
|
}
|
|
|
|
/*
|
|
* If the method failed or did not actually return an object, we cannot
|
|
* validate the return object
|
|
*/
|
|
if ((ReturnStatus != AE_OK) && (ReturnStatus != AE_CTRL_RETURN_VALUE))
|
|
{
|
|
goto Cleanup;
|
|
}
|
|
|
|
/*
|
|
* If there is no return value, check if we require a return value for
|
|
* this predefined name. Either one return value is expected, or none,
|
|
* for both methods and other objects.
|
|
*
|
|
* Exit now if there is no return object. Warning if one was expected.
|
|
*/
|
|
if (!ReturnObject)
|
|
{
|
|
if ((Predefined->Info.ExpectedBtypes) &&
|
|
(!(Predefined->Info.ExpectedBtypes & ACPI_RTYPE_NONE)))
|
|
{
|
|
ACPI_WARN_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS,
|
|
"Missing expected return value"));
|
|
|
|
Status = AE_AML_NO_RETURN_VALUE;
|
|
}
|
|
goto Cleanup;
|
|
}
|
|
|
|
/*
|
|
* Return value validation and possible repair.
|
|
*
|
|
* 1) Don't perform return value validation/repair if this feature
|
|
* has been disabled via a global option.
|
|
*
|
|
* 2) We have a return value, but if one wasn't expected, just exit,
|
|
* this is not a problem. For example, if the "Implicit Return"
|
|
* feature is enabled, methods will always return a value.
|
|
*
|
|
* 3) If the return value can be of any type, then we cannot perform
|
|
* any validation, just exit.
|
|
*/
|
|
if (AcpiGbl_DisableAutoRepair ||
|
|
(!Predefined->Info.ExpectedBtypes) ||
|
|
(Predefined->Info.ExpectedBtypes == ACPI_RTYPE_ALL))
|
|
{
|
|
goto Cleanup;
|
|
}
|
|
|
|
/* Create the parameter data block for object validation */
|
|
|
|
Data = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_PREDEFINED_DATA));
|
|
if (!Data)
|
|
{
|
|
goto Cleanup;
|
|
}
|
|
Data->Predefined = Predefined;
|
|
Data->Node = Node;
|
|
Data->NodeFlags = Node->Flags;
|
|
Data->Pathname = Pathname;
|
|
|
|
/*
|
|
* Check that the type of the main return object is what is expected
|
|
* for this predefined name
|
|
*/
|
|
Status = AcpiNsCheckObjectType (Data, ReturnObjectPtr,
|
|
Predefined->Info.ExpectedBtypes, ACPI_NOT_PACKAGE_ELEMENT);
|
|
if (ACPI_FAILURE (Status))
|
|
{
|
|
goto Exit;
|
|
}
|
|
|
|
/*
|
|
* For returned Package objects, check the type of all sub-objects.
|
|
* Note: Package may have been newly created by call above.
|
|
*/
|
|
if ((*ReturnObjectPtr)->Common.Type == ACPI_TYPE_PACKAGE)
|
|
{
|
|
Data->ParentPackage = *ReturnObjectPtr;
|
|
Status = AcpiNsCheckPackage (Data, ReturnObjectPtr);
|
|
if (ACPI_FAILURE (Status))
|
|
{
|
|
goto Exit;
|
|
}
|
|
}
|
|
|
|
/*
|
|
* The return object was OK, or it was successfully repaired above.
|
|
* Now make some additional checks such as verifying that package
|
|
* objects are sorted correctly (if required) or buffer objects have
|
|
* the correct data width (bytes vs. dwords). These repairs are
|
|
* performed on a per-name basis, i.e., the code is specific to
|
|
* particular predefined names.
|
|
*/
|
|
Status = AcpiNsComplexRepairs (Data, Node, Status, ReturnObjectPtr);
|
|
|
|
Exit:
|
|
/*
|
|
* If the object validation failed or if we successfully repaired one
|
|
* or more objects, mark the parent node to suppress further warning
|
|
* messages during the next evaluation of the same method/object.
|
|
*/
|
|
if (ACPI_FAILURE (Status) || (Data->Flags & ACPI_OBJECT_REPAIRED))
|
|
{
|
|
Node->Flags |= ANOBJ_EVALUATED;
|
|
}
|
|
ACPI_FREE (Data);
|
|
|
|
Cleanup:
|
|
ACPI_FREE (Pathname);
|
|
return (Status);
|
|
}
|
|
|
|
|
|
/*******************************************************************************
|
|
*
|
|
* FUNCTION: AcpiNsCheckParameterCount
|
|
*
|
|
* PARAMETERS: Pathname - Full pathname to the node (for error msgs)
|
|
* Node - Namespace node for the method/object
|
|
* UserParamCount - Number of args passed in by the caller
|
|
* Predefined - Pointer to entry in predefined name table
|
|
*
|
|
* RETURN: None
|
|
*
|
|
* DESCRIPTION: Check that the declared (in ASL/AML) parameter count for a
|
|
* predefined name is what is expected (i.e., what is defined in
|
|
* the ACPI specification for this predefined name.)
|
|
*
|
|
******************************************************************************/
|
|
|
|
void
|
|
AcpiNsCheckParameterCount (
|
|
char *Pathname,
|
|
ACPI_NAMESPACE_NODE *Node,
|
|
UINT32 UserParamCount,
|
|
const ACPI_PREDEFINED_INFO *Predefined)
|
|
{
|
|
UINT32 ParamCount;
|
|
UINT32 RequiredParamsCurrent;
|
|
UINT32 RequiredParamsOld;
|
|
|
|
|
|
/* Methods have 0-7 parameters. All other types have zero. */
|
|
|
|
ParamCount = 0;
|
|
if (Node->Type == ACPI_TYPE_METHOD)
|
|
{
|
|
ParamCount = Node->Object->Method.ParamCount;
|
|
}
|
|
|
|
if (!Predefined)
|
|
{
|
|
/*
|
|
* Check the parameter count for non-predefined methods/objects.
|
|
*
|
|
* Warning if too few or too many arguments have been passed by the
|
|
* caller. An incorrect number of arguments may not cause the method
|
|
* to fail. However, the method will fail if there are too few
|
|
* arguments and the method attempts to use one of the missing ones.
|
|
*/
|
|
if (UserParamCount < ParamCount)
|
|
{
|
|
ACPI_WARN_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS,
|
|
"Insufficient arguments - needs %u, found %u",
|
|
ParamCount, UserParamCount));
|
|
}
|
|
else if (UserParamCount > ParamCount)
|
|
{
|
|
ACPI_WARN_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS,
|
|
"Excess arguments - needs %u, found %u",
|
|
ParamCount, UserParamCount));
|
|
}
|
|
return;
|
|
}
|
|
|
|
/*
|
|
* Validate the user-supplied parameter count.
|
|
* Allow two different legal argument counts (_SCP, etc.)
|
|
*/
|
|
RequiredParamsCurrent = Predefined->Info.ParamCount & 0x0F;
|
|
RequiredParamsOld = Predefined->Info.ParamCount >> 4;
|
|
|
|
if (UserParamCount != ACPI_UINT32_MAX)
|
|
{
|
|
if ((UserParamCount != RequiredParamsCurrent) &&
|
|
(UserParamCount != RequiredParamsOld))
|
|
{
|
|
ACPI_WARN_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS,
|
|
"Parameter count mismatch - "
|
|
"caller passed %u, ACPI requires %u",
|
|
UserParamCount, RequiredParamsCurrent));
|
|
}
|
|
}
|
|
|
|
/*
|
|
* Check that the ASL-defined parameter count is what is expected for
|
|
* this predefined name (parameter count as defined by the ACPI
|
|
* specification)
|
|
*/
|
|
if ((ParamCount != RequiredParamsCurrent) &&
|
|
(ParamCount != RequiredParamsOld))
|
|
{
|
|
ACPI_WARN_PREDEFINED ((AE_INFO, Pathname, Node->Flags,
|
|
"Parameter count mismatch - ASL declared %u, ACPI requires %u",
|
|
ParamCount, RequiredParamsCurrent));
|
|
}
|
|
}
|
|
|
|
|
|
/*******************************************************************************
|
|
*
|
|
* FUNCTION: AcpiNsCheckForPredefinedName
|
|
*
|
|
* PARAMETERS: Node - Namespace node for the method/object
|
|
*
|
|
* RETURN: Pointer to entry in predefined table. NULL indicates not found.
|
|
*
|
|
* DESCRIPTION: Check an object name against the predefined object list.
|
|
*
|
|
******************************************************************************/
|
|
|
|
const ACPI_PREDEFINED_INFO *
|
|
AcpiNsCheckForPredefinedName (
|
|
ACPI_NAMESPACE_NODE *Node)
|
|
{
|
|
const ACPI_PREDEFINED_INFO *ThisName;
|
|
|
|
|
|
/* Quick check for a predefined name, first character must be underscore */
|
|
|
|
if (Node->Name.Ascii[0] != '_')
|
|
{
|
|
return (NULL);
|
|
}
|
|
|
|
/* Search info table for a predefined method/object name */
|
|
|
|
ThisName = PredefinedNames;
|
|
while (ThisName->Info.Name[0])
|
|
{
|
|
if (ACPI_COMPARE_NAME (Node->Name.Ascii, ThisName->Info.Name))
|
|
{
|
|
return (ThisName);
|
|
}
|
|
|
|
/*
|
|
* Skip next entry in the table if this name returns a Package
|
|
* (next entry contains the package info)
|
|
*/
|
|
if (ThisName->Info.ExpectedBtypes & ACPI_RTYPE_PACKAGE)
|
|
{
|
|
ThisName++;
|
|
}
|
|
|
|
ThisName++;
|
|
}
|
|
|
|
return (NULL); /* Not found */
|
|
}
|
|
|
|
|
|
/*******************************************************************************
|
|
*
|
|
* FUNCTION: AcpiNsCheckPackage
|
|
*
|
|
* PARAMETERS: Data - Pointer to validation data structure
|
|
* ReturnObjectPtr - Pointer to the object returned from the
|
|
* evaluation of a method or object
|
|
*
|
|
* RETURN: Status
|
|
*
|
|
* DESCRIPTION: Check a returned package object for the correct count and
|
|
* correct type of all sub-objects.
|
|
*
|
|
******************************************************************************/
|
|
|
|
static ACPI_STATUS
|
|
AcpiNsCheckPackage (
|
|
ACPI_PREDEFINED_DATA *Data,
|
|
ACPI_OPERAND_OBJECT **ReturnObjectPtr)
|
|
{
|
|
ACPI_OPERAND_OBJECT *ReturnObject = *ReturnObjectPtr;
|
|
const ACPI_PREDEFINED_INFO *Package;
|
|
ACPI_OPERAND_OBJECT **Elements;
|
|
ACPI_STATUS Status = AE_OK;
|
|
UINT32 ExpectedCount;
|
|
UINT32 Count;
|
|
UINT32 i;
|
|
|
|
|
|
ACPI_FUNCTION_NAME (NsCheckPackage);
|
|
|
|
|
|
/* The package info for this name is in the next table entry */
|
|
|
|
Package = Data->Predefined + 1;
|
|
|
|
ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
|
|
"%s Validating return Package of Type %X, Count %X\n",
|
|
Data->Pathname, Package->RetInfo.Type, ReturnObject->Package.Count));
|
|
|
|
/*
|
|
* For variable-length Packages, we can safely remove all embedded
|
|
* and trailing NULL package elements
|
|
*/
|
|
AcpiNsRemoveNullElements (Data, Package->RetInfo.Type, ReturnObject);
|
|
|
|
/* Extract package count and elements array */
|
|
|
|
Elements = ReturnObject->Package.Elements;
|
|
Count = ReturnObject->Package.Count;
|
|
|
|
/* The package must have at least one element, else invalid */
|
|
|
|
if (!Count)
|
|
{
|
|
ACPI_WARN_PREDEFINED ((AE_INFO, Data->Pathname, Data->NodeFlags,
|
|
"Return Package has no elements (empty)"));
|
|
|
|
return (AE_AML_OPERAND_VALUE);
|
|
}
|
|
|
|
/*
|
|
* Decode the type of the expected package contents
|
|
*
|
|
* PTYPE1 packages contain no subpackages
|
|
* PTYPE2 packages contain sub-packages
|
|
*/
|
|
switch (Package->RetInfo.Type)
|
|
{
|
|
case ACPI_PTYPE1_FIXED:
|
|
|
|
/*
|
|
* The package count is fixed and there are no sub-packages
|
|
*
|
|
* If package is too small, exit.
|
|
* If package is larger than expected, issue warning but continue
|
|
*/
|
|
ExpectedCount = Package->RetInfo.Count1 + Package->RetInfo.Count2;
|
|
if (Count < ExpectedCount)
|
|
{
|
|
goto PackageTooSmall;
|
|
}
|
|
else if (Count > ExpectedCount)
|
|
{
|
|
ACPI_DEBUG_PRINT ((ACPI_DB_REPAIR,
|
|
"%s: Return Package is larger than needed - "
|
|
"found %u, expected %u\n",
|
|
Data->Pathname, Count, ExpectedCount));
|
|
}
|
|
|
|
/* Validate all elements of the returned package */
|
|
|
|
Status = AcpiNsCheckPackageElements (Data, Elements,
|
|
Package->RetInfo.ObjectType1, Package->RetInfo.Count1,
|
|
Package->RetInfo.ObjectType2, Package->RetInfo.Count2, 0);
|
|
break;
|
|
|
|
|
|
case ACPI_PTYPE1_VAR:
|
|
|
|
/*
|
|
* The package count is variable, there are no sub-packages, and all
|
|
* elements must be of the same type
|
|
*/
|
|
for (i = 0; i < Count; i++)
|
|
{
|
|
Status = AcpiNsCheckObjectType (Data, Elements,
|
|
Package->RetInfo.ObjectType1, i);
|
|
if (ACPI_FAILURE (Status))
|
|
{
|
|
return (Status);
|
|
}
|
|
Elements++;
|
|
}
|
|
break;
|
|
|
|
|
|
case ACPI_PTYPE1_OPTION:
|
|
|
|
/*
|
|
* The package count is variable, there are no sub-packages. There are
|
|
* a fixed number of required elements, and a variable number of
|
|
* optional elements.
|
|
*
|
|
* Check if package is at least as large as the minimum required
|
|
*/
|
|
ExpectedCount = Package->RetInfo3.Count;
|
|
if (Count < ExpectedCount)
|
|
{
|
|
goto PackageTooSmall;
|
|
}
|
|
|
|
/* Variable number of sub-objects */
|
|
|
|
for (i = 0; i < Count; i++)
|
|
{
|
|
if (i < Package->RetInfo3.Count)
|
|
{
|
|
/* These are the required package elements (0, 1, or 2) */
|
|
|
|
Status = AcpiNsCheckObjectType (Data, Elements,
|
|
Package->RetInfo3.ObjectType[i], i);
|
|
if (ACPI_FAILURE (Status))
|
|
{
|
|
return (Status);
|
|
}
|
|
}
|
|
else
|
|
{
|
|
/* These are the optional package elements */
|
|
|
|
Status = AcpiNsCheckObjectType (Data, Elements,
|
|
Package->RetInfo3.TailObjectType, i);
|
|
if (ACPI_FAILURE (Status))
|
|
{
|
|
return (Status);
|
|
}
|
|
}
|
|
Elements++;
|
|
}
|
|
break;
|
|
|
|
|
|
case ACPI_PTYPE2_REV_FIXED:
|
|
|
|
/* First element is the (Integer) revision */
|
|
|
|
Status = AcpiNsCheckObjectType (Data, Elements,
|
|
ACPI_RTYPE_INTEGER, 0);
|
|
if (ACPI_FAILURE (Status))
|
|
{
|
|
return (Status);
|
|
}
|
|
|
|
Elements++;
|
|
Count--;
|
|
|
|
/* Examine the sub-packages */
|
|
|
|
Status = AcpiNsCheckPackageList (Data, Package, Elements, Count);
|
|
break;
|
|
|
|
|
|
case ACPI_PTYPE2_PKG_COUNT:
|
|
|
|
/* First element is the (Integer) count of sub-packages to follow */
|
|
|
|
Status = AcpiNsCheckObjectType (Data, Elements,
|
|
ACPI_RTYPE_INTEGER, 0);
|
|
if (ACPI_FAILURE (Status))
|
|
{
|
|
return (Status);
|
|
}
|
|
|
|
/*
|
|
* Count cannot be larger than the parent package length, but allow it
|
|
* to be smaller. The >= accounts for the Integer above.
|
|
*/
|
|
ExpectedCount = (UINT32) (*Elements)->Integer.Value;
|
|
if (ExpectedCount >= Count)
|
|
{
|
|
goto PackageTooSmall;
|
|
}
|
|
|
|
Count = ExpectedCount;
|
|
Elements++;
|
|
|
|
/* Examine the sub-packages */
|
|
|
|
Status = AcpiNsCheckPackageList (Data, Package, Elements, Count);
|
|
break;
|
|
|
|
|
|
case ACPI_PTYPE2:
|
|
case ACPI_PTYPE2_FIXED:
|
|
case ACPI_PTYPE2_MIN:
|
|
case ACPI_PTYPE2_COUNT:
|
|
case ACPI_PTYPE2_FIX_VAR:
|
|
|
|
/*
|
|
* These types all return a single Package that consists of a
|
|
* variable number of sub-Packages.
|
|
*
|
|
* First, ensure that the first element is a sub-Package. If not,
|
|
* the BIOS may have incorrectly returned the object as a single
|
|
* package instead of a Package of Packages (a common error if
|
|
* there is only one entry). We may be able to repair this by
|
|
* wrapping the returned Package with a new outer Package.
|
|
*/
|
|
if (*Elements && ((*Elements)->Common.Type != ACPI_TYPE_PACKAGE))
|
|
{
|
|
/* Create the new outer package and populate it */
|
|
|
|
Status = AcpiNsWrapWithPackage (Data, *Elements, ReturnObjectPtr);
|
|
if (ACPI_FAILURE (Status))
|
|
{
|
|
return (Status);
|
|
}
|
|
|
|
/* Update locals to point to the new package (of 1 element) */
|
|
|
|
ReturnObject = *ReturnObjectPtr;
|
|
Elements = ReturnObject->Package.Elements;
|
|
Count = 1;
|
|
}
|
|
|
|
/* Examine the sub-packages */
|
|
|
|
Status = AcpiNsCheckPackageList (Data, Package, Elements, Count);
|
|
break;
|
|
|
|
|
|
default:
|
|
|
|
/* Should not get here if predefined info table is correct */
|
|
|
|
ACPI_WARN_PREDEFINED ((AE_INFO, Data->Pathname, Data->NodeFlags,
|
|
"Invalid internal return type in table entry: %X",
|
|
Package->RetInfo.Type));
|
|
|
|
return (AE_AML_INTERNAL);
|
|
}
|
|
|
|
return (Status);
|
|
|
|
|
|
PackageTooSmall:
|
|
|
|
/* Error exit for the case with an incorrect package count */
|
|
|
|
ACPI_WARN_PREDEFINED ((AE_INFO, Data->Pathname, Data->NodeFlags,
|
|
"Return Package is too small - found %u elements, expected %u",
|
|
Count, ExpectedCount));
|
|
|
|
return (AE_AML_OPERAND_VALUE);
|
|
}
|
|
|
|
|
|
/*******************************************************************************
|
|
*
|
|
* FUNCTION: AcpiNsCheckPackageList
|
|
*
|
|
* PARAMETERS: Data - Pointer to validation data structure
|
|
* Package - Pointer to package-specific info for method
|
|
* Elements - Element list of parent package. All elements
|
|
* of this list should be of type Package.
|
|
* Count - Count of subpackages
|
|
*
|
|
* RETURN: Status
|
|
*
|
|
* DESCRIPTION: Examine a list of subpackages
|
|
*
|
|
******************************************************************************/
|
|
|
|
static ACPI_STATUS
|
|
AcpiNsCheckPackageList (
|
|
ACPI_PREDEFINED_DATA *Data,
|
|
const ACPI_PREDEFINED_INFO *Package,
|
|
ACPI_OPERAND_OBJECT **Elements,
|
|
UINT32 Count)
|
|
{
|
|
ACPI_OPERAND_OBJECT *SubPackage;
|
|
ACPI_OPERAND_OBJECT **SubElements;
|
|
ACPI_STATUS Status;
|
|
UINT32 ExpectedCount;
|
|
UINT32 i;
|
|
UINT32 j;
|
|
|
|
|
|
/*
|
|
* Validate each sub-Package in the parent Package
|
|
*
|
|
* NOTE: assumes list of sub-packages contains no NULL elements.
|
|
* Any NULL elements should have been removed by earlier call
|
|
* to AcpiNsRemoveNullElements.
|
|
*/
|
|
for (i = 0; i < Count; i++)
|
|
{
|
|
SubPackage = *Elements;
|
|
SubElements = SubPackage->Package.Elements;
|
|
Data->ParentPackage = SubPackage;
|
|
|
|
/* Each sub-object must be of type Package */
|
|
|
|
Status = AcpiNsCheckObjectType (Data, &SubPackage,
|
|
ACPI_RTYPE_PACKAGE, i);
|
|
if (ACPI_FAILURE (Status))
|
|
{
|
|
return (Status);
|
|
}
|
|
|
|
/* Examine the different types of expected sub-packages */
|
|
|
|
Data->ParentPackage = SubPackage;
|
|
switch (Package->RetInfo.Type)
|
|
{
|
|
case ACPI_PTYPE2:
|
|
case ACPI_PTYPE2_PKG_COUNT:
|
|
case ACPI_PTYPE2_REV_FIXED:
|
|
|
|
/* Each subpackage has a fixed number of elements */
|
|
|
|
ExpectedCount = Package->RetInfo.Count1 + Package->RetInfo.Count2;
|
|
if (SubPackage->Package.Count < ExpectedCount)
|
|
{
|
|
goto PackageTooSmall;
|
|
}
|
|
|
|
Status = AcpiNsCheckPackageElements (Data, SubElements,
|
|
Package->RetInfo.ObjectType1,
|
|
Package->RetInfo.Count1,
|
|
Package->RetInfo.ObjectType2,
|
|
Package->RetInfo.Count2, 0);
|
|
if (ACPI_FAILURE (Status))
|
|
{
|
|
return (Status);
|
|
}
|
|
break;
|
|
|
|
|
|
case ACPI_PTYPE2_FIX_VAR:
|
|
/*
|
|
* Each subpackage has a fixed number of elements and an
|
|
* optional element
|
|
*/
|
|
ExpectedCount = Package->RetInfo.Count1 + Package->RetInfo.Count2;
|
|
if (SubPackage->Package.Count < ExpectedCount)
|
|
{
|
|
goto PackageTooSmall;
|
|
}
|
|
|
|
Status = AcpiNsCheckPackageElements (Data, SubElements,
|
|
Package->RetInfo.ObjectType1,
|
|
Package->RetInfo.Count1,
|
|
Package->RetInfo.ObjectType2,
|
|
SubPackage->Package.Count - Package->RetInfo.Count1, 0);
|
|
if (ACPI_FAILURE (Status))
|
|
{
|
|
return (Status);
|
|
}
|
|
break;
|
|
|
|
|
|
case ACPI_PTYPE2_FIXED:
|
|
|
|
/* Each sub-package has a fixed length */
|
|
|
|
ExpectedCount = Package->RetInfo2.Count;
|
|
if (SubPackage->Package.Count < ExpectedCount)
|
|
{
|
|
goto PackageTooSmall;
|
|
}
|
|
|
|
/* Check the type of each sub-package element */
|
|
|
|
for (j = 0; j < ExpectedCount; j++)
|
|
{
|
|
Status = AcpiNsCheckObjectType (Data, &SubElements[j],
|
|
Package->RetInfo2.ObjectType[j], j);
|
|
if (ACPI_FAILURE (Status))
|
|
{
|
|
return (Status);
|
|
}
|
|
}
|
|
break;
|
|
|
|
|
|
case ACPI_PTYPE2_MIN:
|
|
|
|
/* Each sub-package has a variable but minimum length */
|
|
|
|
ExpectedCount = Package->RetInfo.Count1;
|
|
if (SubPackage->Package.Count < ExpectedCount)
|
|
{
|
|
goto PackageTooSmall;
|
|
}
|
|
|
|
/* Check the type of each sub-package element */
|
|
|
|
Status = AcpiNsCheckPackageElements (Data, SubElements,
|
|
Package->RetInfo.ObjectType1,
|
|
SubPackage->Package.Count, 0, 0, 0);
|
|
if (ACPI_FAILURE (Status))
|
|
{
|
|
return (Status);
|
|
}
|
|
break;
|
|
|
|
|
|
case ACPI_PTYPE2_COUNT:
|
|
|
|
/*
|
|
* First element is the (Integer) count of elements, including
|
|
* the count field (the ACPI name is NumElements)
|
|
*/
|
|
Status = AcpiNsCheckObjectType (Data, SubElements,
|
|
ACPI_RTYPE_INTEGER, 0);
|
|
if (ACPI_FAILURE (Status))
|
|
{
|
|
return (Status);
|
|
}
|
|
|
|
/*
|
|
* Make sure package is large enough for the Count and is
|
|
* is as large as the minimum size
|
|
*/
|
|
ExpectedCount = (UINT32) (*SubElements)->Integer.Value;
|
|
if (SubPackage->Package.Count < ExpectedCount)
|
|
{
|
|
goto PackageTooSmall;
|
|
}
|
|
if (SubPackage->Package.Count < Package->RetInfo.Count1)
|
|
{
|
|
ExpectedCount = Package->RetInfo.Count1;
|
|
goto PackageTooSmall;
|
|
}
|
|
if (ExpectedCount == 0)
|
|
{
|
|
/*
|
|
* Either the NumEntries element was originally zero or it was
|
|
* a NULL element and repaired to an Integer of value zero.
|
|
* In either case, repair it by setting NumEntries to be the
|
|
* actual size of the subpackage.
|
|
*/
|
|
ExpectedCount = SubPackage->Package.Count;
|
|
(*SubElements)->Integer.Value = ExpectedCount;
|
|
}
|
|
|
|
/* Check the type of each sub-package element */
|
|
|
|
Status = AcpiNsCheckPackageElements (Data, (SubElements + 1),
|
|
Package->RetInfo.ObjectType1,
|
|
(ExpectedCount - 1), 0, 0, 1);
|
|
if (ACPI_FAILURE (Status))
|
|
{
|
|
return (Status);
|
|
}
|
|
break;
|
|
|
|
|
|
default: /* Should not get here, type was validated by caller */
|
|
|
|
return (AE_AML_INTERNAL);
|
|
}
|
|
|
|
Elements++;
|
|
}
|
|
|
|
return (AE_OK);
|
|
|
|
|
|
PackageTooSmall:
|
|
|
|
/* The sub-package count was smaller than required */
|
|
|
|
ACPI_WARN_PREDEFINED ((AE_INFO, Data->Pathname, Data->NodeFlags,
|
|
"Return Sub-Package[%u] is too small - found %u elements, expected %u",
|
|
i, SubPackage->Package.Count, ExpectedCount));
|
|
|
|
return (AE_AML_OPERAND_VALUE);
|
|
}
|
|
|
|
|
|
/*******************************************************************************
|
|
*
|
|
* FUNCTION: AcpiNsCheckPackageElements
|
|
*
|
|
* PARAMETERS: Data - Pointer to validation data structure
|
|
* Elements - Pointer to the package elements array
|
|
* Type1 - Object type for first group
|
|
* Count1 - Count for first group
|
|
* Type2 - Object type for second group
|
|
* Count2 - Count for second group
|
|
* StartIndex - Start of the first group of elements
|
|
*
|
|
* RETURN: Status
|
|
*
|
|
* DESCRIPTION: Check that all elements of a package are of the correct object
|
|
* type. Supports up to two groups of different object types.
|
|
*
|
|
******************************************************************************/
|
|
|
|
static ACPI_STATUS
|
|
AcpiNsCheckPackageElements (
|
|
ACPI_PREDEFINED_DATA *Data,
|
|
ACPI_OPERAND_OBJECT **Elements,
|
|
UINT8 Type1,
|
|
UINT32 Count1,
|
|
UINT8 Type2,
|
|
UINT32 Count2,
|
|
UINT32 StartIndex)
|
|
{
|
|
ACPI_OPERAND_OBJECT **ThisElement = Elements;
|
|
ACPI_STATUS Status;
|
|
UINT32 i;
|
|
|
|
|
|
/*
|
|
* Up to two groups of package elements are supported by the data
|
|
* structure. All elements in each group must be of the same type.
|
|
* The second group can have a count of zero.
|
|
*/
|
|
for (i = 0; i < Count1; i++)
|
|
{
|
|
Status = AcpiNsCheckObjectType (Data, ThisElement,
|
|
Type1, i + StartIndex);
|
|
if (ACPI_FAILURE (Status))
|
|
{
|
|
return (Status);
|
|
}
|
|
ThisElement++;
|
|
}
|
|
|
|
for (i = 0; i < Count2; i++)
|
|
{
|
|
Status = AcpiNsCheckObjectType (Data, ThisElement,
|
|
Type2, (i + Count1 + StartIndex));
|
|
if (ACPI_FAILURE (Status))
|
|
{
|
|
return (Status);
|
|
}
|
|
ThisElement++;
|
|
}
|
|
|
|
return (AE_OK);
|
|
}
|
|
|
|
|
|
/*******************************************************************************
|
|
*
|
|
* FUNCTION: AcpiNsCheckObjectType
|
|
*
|
|
* PARAMETERS: Data - Pointer to validation data structure
|
|
* ReturnObjectPtr - Pointer to the object returned from the
|
|
* evaluation of a method or object
|
|
* ExpectedBtypes - Bitmap of expected return type(s)
|
|
* PackageIndex - Index of object within parent package (if
|
|
* applicable - ACPI_NOT_PACKAGE_ELEMENT
|
|
* otherwise)
|
|
*
|
|
* RETURN: Status
|
|
*
|
|
* DESCRIPTION: Check the type of the return object against the expected object
|
|
* type(s). Use of Btype allows multiple expected object types.
|
|
*
|
|
******************************************************************************/
|
|
|
|
static ACPI_STATUS
|
|
AcpiNsCheckObjectType (
|
|
ACPI_PREDEFINED_DATA *Data,
|
|
ACPI_OPERAND_OBJECT **ReturnObjectPtr,
|
|
UINT32 ExpectedBtypes,
|
|
UINT32 PackageIndex)
|
|
{
|
|
ACPI_OPERAND_OBJECT *ReturnObject = *ReturnObjectPtr;
|
|
ACPI_STATUS Status = AE_OK;
|
|
UINT32 ReturnBtype;
|
|
char TypeBuffer[48]; /* Room for 5 types */
|
|
|
|
|
|
/*
|
|
* If we get a NULL ReturnObject here, it is a NULL package element.
|
|
* Since all extraneous NULL package elements were removed earlier by a
|
|
* call to AcpiNsRemoveNullElements, this is an unexpected NULL element.
|
|
* We will attempt to repair it.
|
|
*/
|
|
if (!ReturnObject)
|
|
{
|
|
Status = AcpiNsRepairNullElement (Data, ExpectedBtypes,
|
|
PackageIndex, ReturnObjectPtr);
|
|
if (ACPI_SUCCESS (Status))
|
|
{
|
|
return (AE_OK); /* Repair was successful */
|
|
}
|
|
goto TypeErrorExit;
|
|
}
|
|
|
|
/* A Namespace node should not get here, but make sure */
|
|
|
|
if (ACPI_GET_DESCRIPTOR_TYPE (ReturnObject) == ACPI_DESC_TYPE_NAMED)
|
|
{
|
|
ACPI_WARN_PREDEFINED ((AE_INFO, Data->Pathname, Data->NodeFlags,
|
|
"Invalid return type - Found a Namespace node [%4.4s] type %s",
|
|
ReturnObject->Node.Name.Ascii,
|
|
AcpiUtGetTypeName (ReturnObject->Node.Type)));
|
|
return (AE_AML_OPERAND_TYPE);
|
|
}
|
|
|
|
/*
|
|
* Convert the object type (ACPI_TYPE_xxx) to a bitmapped object type.
|
|
* The bitmapped type allows multiple possible return types.
|
|
*
|
|
* Note, the cases below must handle all of the possible types returned
|
|
* from all of the predefined names (including elements of returned
|
|
* packages)
|
|
*/
|
|
switch (ReturnObject->Common.Type)
|
|
{
|
|
case ACPI_TYPE_INTEGER:
|
|
ReturnBtype = ACPI_RTYPE_INTEGER;
|
|
break;
|
|
|
|
case ACPI_TYPE_BUFFER:
|
|
ReturnBtype = ACPI_RTYPE_BUFFER;
|
|
break;
|
|
|
|
case ACPI_TYPE_STRING:
|
|
ReturnBtype = ACPI_RTYPE_STRING;
|
|
break;
|
|
|
|
case ACPI_TYPE_PACKAGE:
|
|
ReturnBtype = ACPI_RTYPE_PACKAGE;
|
|
break;
|
|
|
|
case ACPI_TYPE_LOCAL_REFERENCE:
|
|
ReturnBtype = ACPI_RTYPE_REFERENCE;
|
|
break;
|
|
|
|
default:
|
|
/* Not one of the supported objects, must be incorrect */
|
|
|
|
goto TypeErrorExit;
|
|
}
|
|
|
|
/* Is the object one of the expected types? */
|
|
|
|
if (ReturnBtype & ExpectedBtypes)
|
|
{
|
|
/* For reference objects, check that the reference type is correct */
|
|
|
|
if (ReturnObject->Common.Type == ACPI_TYPE_LOCAL_REFERENCE)
|
|
{
|
|
Status = AcpiNsCheckReference (Data, ReturnObject);
|
|
}
|
|
|
|
return (Status);
|
|
}
|
|
|
|
/* Type mismatch -- attempt repair of the returned object */
|
|
|
|
Status = AcpiNsRepairObject (Data, ExpectedBtypes,
|
|
PackageIndex, ReturnObjectPtr);
|
|
if (ACPI_SUCCESS (Status))
|
|
{
|
|
return (AE_OK); /* Repair was successful */
|
|
}
|
|
|
|
|
|
TypeErrorExit:
|
|
|
|
/* Create a string with all expected types for this predefined object */
|
|
|
|
AcpiNsGetExpectedTypes (TypeBuffer, ExpectedBtypes);
|
|
|
|
if (PackageIndex == ACPI_NOT_PACKAGE_ELEMENT)
|
|
{
|
|
ACPI_WARN_PREDEFINED ((AE_INFO, Data->Pathname, Data->NodeFlags,
|
|
"Return type mismatch - found %s, expected %s",
|
|
AcpiUtGetObjectTypeName (ReturnObject), TypeBuffer));
|
|
}
|
|
else
|
|
{
|
|
ACPI_WARN_PREDEFINED ((AE_INFO, Data->Pathname, Data->NodeFlags,
|
|
"Return Package type mismatch at index %u - "
|
|
"found %s, expected %s", PackageIndex,
|
|
AcpiUtGetObjectTypeName (ReturnObject), TypeBuffer));
|
|
}
|
|
|
|
return (AE_AML_OPERAND_TYPE);
|
|
}
|
|
|
|
|
|
/*******************************************************************************
|
|
*
|
|
* FUNCTION: AcpiNsCheckReference
|
|
*
|
|
* PARAMETERS: Data - Pointer to validation data structure
|
|
* ReturnObject - Object returned from the evaluation of a
|
|
* method or object
|
|
*
|
|
* RETURN: Status
|
|
*
|
|
* DESCRIPTION: Check a returned reference object for the correct reference
|
|
* type. The only reference type that can be returned from a
|
|
* predefined method is a named reference. All others are invalid.
|
|
*
|
|
******************************************************************************/
|
|
|
|
static ACPI_STATUS
|
|
AcpiNsCheckReference (
|
|
ACPI_PREDEFINED_DATA *Data,
|
|
ACPI_OPERAND_OBJECT *ReturnObject)
|
|
{
|
|
|
|
/*
|
|
* Check the reference object for the correct reference type (opcode).
|
|
* The only type of reference that can be converted to an ACPI_OBJECT is
|
|
* a reference to a named object (reference class: NAME)
|
|
*/
|
|
if (ReturnObject->Reference.Class == ACPI_REFCLASS_NAME)
|
|
{
|
|
return (AE_OK);
|
|
}
|
|
|
|
ACPI_WARN_PREDEFINED ((AE_INFO, Data->Pathname, Data->NodeFlags,
|
|
"Return type mismatch - unexpected reference object type [%s] %2.2X",
|
|
AcpiUtGetReferenceName (ReturnObject),
|
|
ReturnObject->Reference.Class));
|
|
|
|
return (AE_AML_OPERAND_TYPE);
|
|
}
|
|
|
|
|
|
/*******************************************************************************
|
|
*
|
|
* FUNCTION: AcpiNsGetExpectedTypes
|
|
*
|
|
* PARAMETERS: Buffer - Pointer to where the string is returned
|
|
* ExpectedBtypes - Bitmap of expected return type(s)
|
|
*
|
|
* RETURN: Buffer is populated with type names.
|
|
*
|
|
* DESCRIPTION: Translate the expected types bitmap into a string of ascii
|
|
* names of expected types, for use in warning messages.
|
|
*
|
|
******************************************************************************/
|
|
|
|
static void
|
|
AcpiNsGetExpectedTypes (
|
|
char *Buffer,
|
|
UINT32 ExpectedBtypes)
|
|
{
|
|
UINT32 ThisRtype;
|
|
UINT32 i;
|
|
UINT32 j;
|
|
|
|
|
|
j = 1;
|
|
Buffer[0] = 0;
|
|
ThisRtype = ACPI_RTYPE_INTEGER;
|
|
|
|
for (i = 0; i < ACPI_NUM_RTYPES; i++)
|
|
{
|
|
/* If one of the expected types, concatenate the name of this type */
|
|
|
|
if (ExpectedBtypes & ThisRtype)
|
|
{
|
|
ACPI_STRCAT (Buffer, &AcpiRtypeNames[i][j]);
|
|
j = 0; /* Use name separator from now on */
|
|
}
|
|
ThisRtype <<= 1; /* Next Rtype */
|
|
}
|
|
}
|