nspredef.c revision aa2aa9a662539940ddbc8610da5a3a874ebd7503
/******************************************************************************
*
* Module Name: nspredef - Validation of ACPI predefined methods and objects
*
*****************************************************************************/
/******************************************************************************
*
* 1. Copyright Notice
*
* Some or all of this work - Copyright (c) 1999 - 2009, 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 __NSPREDEF_C__
#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:
*
* 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
char *Pathname,
const ACPI_PREDEFINED_INFO *Predefined);
static ACPI_STATUS
char *Pathname,
static ACPI_STATUS
char *Pathname,
static ACPI_STATUS
char *Pathname,
static ACPI_STATUS
/*
* 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",
};
#define ACPI_NOT_PACKAGE ACPI_UINT32_MAX
/*******************************************************************************
*
* FUNCTION: AcpiNsCheckPredefinedNames
*
* 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.
*
******************************************************************************/
{
const ACPI_PREDEFINED_INFO *Predefined;
char *Pathname;
/* Get the full pathname to the object, for use in error messages */
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.
*/
/* If not a predefined name, we cannot validate the return object */
if (!Predefined)
{
goto Exit;
}
/* If the method failed, we cannot validate the return object */
{
goto Exit;
}
/*
* Only validate the return value on the first successful evaluation of
* the method. This ensures that any warnings will only be emitted during
*/
{
goto Exit;
}
/* Mark the node as having been successfully evaluated */
/*
* 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)
{
{
"%s: Missing expected return value", Pathname));
}
goto Exit;
}
/*
* 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
*/
{
goto Exit;
}
/*
* Check that the type of the return object is what is expected for
* this predefined name
*/
if (ACPI_FAILURE (Status))
{
goto Exit;
}
/* For returned Package objects, check the type of all sub-objects */
{
}
Exit:
return (Status);
}
/*******************************************************************************
*
* FUNCTION: AcpiNsCheckParameterCount
*
* PARAMETERS: Pathname - Full pathname to the node (for error msgs)
* UserParamCount - Number of args passed in by the caller
* Predefined - Pointer to entry in predefined name table
*
* RETURN: None
*
* predefined name is what is expected (i.e., what is defined in
* the ACPI specification for this predefined name.)
*
******************************************************************************/
void
char *Pathname,
const ACPI_PREDEFINED_INFO *Predefined)
{
/* Methods have 0-7 parameters. All other types have zero. */
ParamCount = 0;
{
}
if (!Predefined)
{
/*
* 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)
{
"%s: Insufficient arguments - needs %d, found %d",
}
else if (UserParamCount > ParamCount)
{
"%s: Excess arguments - needs %d, found %d",
}
return;
}
/* Allow two different legal argument counts (_SCP, etc.) */
if (UserParamCount != ACPI_UINT32_MAX)
{
/* Validate the user-supplied parameter count */
if ((UserParamCount != RequiredParamsCurrent) &&
{
"%s: Parameter count mismatch - "
"caller passed %d, ACPI requires %d",
}
}
/*
* Only validate the argument count on the first successful evaluation of
* the method. This ensures that any warnings will only be emitted during
*/
{
return;
}
/*
* Check that the ASL-defined parameter count is what is expected for
* this predefined name.
*/
if ((ParamCount != RequiredParamsCurrent) &&
(ParamCount != RequiredParamsOld))
{
"%s: Parameter count mismatch - ASL declared %d, ACPI requires %d",
}
}
/*******************************************************************************
*
* FUNCTION: AcpiNsCheckForPredefinedName
*
*
* 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 *
{
const ACPI_PREDEFINED_INFO *ThisName;
/* Quick check for a predefined name, first character must be underscore */
{
return (NULL);
}
{
{
/* Return pointer to this table entry */
return (ThisName);
}
/*
* Skip next entry in the table if this name returns a Package
* (next entry contains the package info)
*/
{
ThisName++;
}
ThisName++;
}
return (NULL);
}
/*******************************************************************************
*
* FUNCTION: AcpiNsCheckPackage
*
* PARAMETERS: Pathname - Full pathname to the node (for error msgs)
* ReturnObjectPtr - Pointer to the object returned from the
* evaluation of a method or object
* Predefined - Pointer to entry in predefined name table
*
* RETURN: Status
*
* DESCRIPTION: Check a returned package object for the correct count and
* correct type of all sub-objects.
*
******************************************************************************/
static ACPI_STATUS
char *Pathname,
const ACPI_PREDEFINED_INFO *Predefined)
{
const ACPI_PREDEFINED_INFO *Package;
UINT32 i;
UINT32 j;
/* The package info for this name is in the next table entry */
"%s Validating return Package of Type %X, Count %X\n",
/* Extract package count and elements array */
/* The package must have at least one element, else invalid */
if (!Count)
{
"%s: Return Package has no elements (empty)", Pathname));
return (AE_AML_OPERAND_VALUE);
}
/*
* Decode the type of the expected package contents
*
* PTYPE1 packages contain no subpackages
* PTYPE2 packages contain sub-packages
*/
{
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
*/
if (Count < ExpectedCount)
{
goto PackageTooSmall;
}
else if (Count > ExpectedCount)
{
"%s: Return Package is larger than needed - "
}
/* Validate all elements of the returned package */
if (ACPI_FAILURE (Status))
{
return (Status);
}
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++)
{
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
*/
if (Count < ExpectedCount)
{
goto PackageTooSmall;
}
/* Variable number of sub-objects */
for (i = 0; i < Count; i++)
{
{
/* These are the required package elements (0, 1, or 2) */
if (ACPI_FAILURE (Status))
{
return (Status);
}
}
else
{
/* These are the optional package elements */
if (ACPI_FAILURE (Status))
{
return (Status);
}
}
Elements++;
}
break;
case ACPI_PTYPE2_PKG_COUNT:
/* First element is the (Integer) count of sub-packages to follow */
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.
*/
if (ExpectedCount >= Count)
{
goto PackageTooSmall;
}
Elements++;
/* Now we can walk the sub-packages */
/*lint -fallthrough */
case ACPI_PTYPE2:
case ACPI_PTYPE2_FIXED:
case ACPI_PTYPE2_MIN:
case ACPI_PTYPE2_COUNT:
/*
* These types all return a single package that consists of a variable
* number of sub-packages
*/
for (i = 0; i < Count; i++)
{
SubPackage = *Elements;
/* Each sub-object must be of type Package */
ACPI_RTYPE_PACKAGE, i);
if (ACPI_FAILURE (Status))
{
return (Status);
}
/* Examine the different types of sub-packages */
{
case ACPI_PTYPE2:
case ACPI_PTYPE2_PKG_COUNT:
/* Each subpackage has a fixed number of elements */
{
goto PackageTooSmall;
}
if (ACPI_FAILURE (Status))
{
return (Status);
}
break;
case ACPI_PTYPE2_FIXED:
/* Each sub-package has a fixed length */
{
goto PackageTooSmall;
}
/* Check the type of each sub-package element */
for (j = 0; j < ExpectedCount; j++)
{
if (ACPI_FAILURE (Status))
{
return (Status);
}
}
break;
case ACPI_PTYPE2_MIN:
/* Each sub-package has a variable but minimum length */
{
goto PackageTooSmall;
}
/* Check the type of each sub-package element */
if (ACPI_FAILURE (Status))
{
return (Status);
}
break;
case ACPI_PTYPE2_COUNT:
/* First element is the (Integer) count of elements to follow */
ACPI_RTYPE_INTEGER, 0);
if (ACPI_FAILURE (Status))
{
return (Status);
}
/* Make sure package is large enough for the Count */
{
goto PackageTooSmall;
}
/* Check the type of each sub-package element */
(SubElements + 1),
if (ACPI_FAILURE (Status))
{
return (Status);
}
break;
default:
break;
}
Elements++;
}
break;
default:
/* Should not get here if predefined info table is correct */
"%s: Invalid internal return type in table entry: %X",
return (AE_AML_INTERNAL);
}
return (AE_OK);
/* Error exit for the case with an incorrect package count */
return (AE_AML_OPERAND_VALUE);
}
/*******************************************************************************
*
* FUNCTION: AcpiNsCheckPackageElements
*
* PARAMETERS: Pathname - Full pathname to the node (for error msgs)
* 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
char *Pathname,
{
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++)
{
Type1, i + StartIndex);
if (ACPI_FAILURE (Status))
{
return (Status);
}
ThisElement++;
}
for (i = 0; i < Count2; i++)
{
if (ACPI_FAILURE (Status))
{
return (Status);
}
ThisElement++;
}
return (AE_OK);
}
/*******************************************************************************
*
* FUNCTION: AcpiNsCheckObjectType
*
* PARAMETERS: Pathname - Full pathname to the node (for error msgs)
* 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 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
char *Pathname,
{
UINT32 i;
UINT32 j;
/*
* If we get a NULL ReturnObject here, it is a NULL package element,
* and this is always an error.
*/
if (!ReturnObject)
{
goto TypeErrorExit;
}
/* A Namespace node should not get here, but make sure */
{
"%s: Invalid return type - Found a Namespace node [%4.4s] type %s",
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)
*/
{
case ACPI_TYPE_INTEGER:
break;
case ACPI_TYPE_BUFFER:
break;
case ACPI_TYPE_STRING:
break;
case ACPI_TYPE_PACKAGE:
break;
break;
default:
/* Not one of the supported objects, must be incorrect */
goto TypeErrorExit;
}
/* Is the object one of the expected types? */
if (!(ReturnBtype & ExpectedBtypes))
{
/* Type mismatch -- attempt repair of the returned object */
if (ACPI_SUCCESS (Status))
{
return (Status);
}
goto TypeErrorExit;
}
/* For reference objects, check that the reference type is correct */
{
}
return (Status);
/* Create a string with all expected types for this predefined object */
j = 1;
TypeBuffer[0] = 0;
for (i = 0; i < ACPI_NUM_RTYPES; i++)
{
/* If one of the expected types, concatenate the name of this type */
if (ExpectedBtypes & ThisRtype)
{
j = 0; /* Use name separator from now on */
}
}
if (PackageIndex == ACPI_NOT_PACKAGE)
{
"%s: Return type mismatch - found %s, expected %s",
}
else
{
"%s: Return Package type mismatch at index %u - "
}
return (AE_AML_OPERAND_TYPE);
}
/*******************************************************************************
*
* FUNCTION: AcpiNsCheckReference
*
* PARAMETERS: Pathname - Full pathname to the node (for error msgs)
* 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
char *Pathname,
{
/*
* 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)
*/
{
return (AE_OK);
}
"%s: Return type mismatch - "
"unexpected reference object type [%s] %2.2X",
return (AE_AML_OPERAND_TYPE);
}
/*******************************************************************************
*
* FUNCTION: AcpiNsRepairObject
*
* PARAMETERS: Pathname - Full pathname to the node (for error msgs)
* PackageIndex - Used to determine if target is in a package
* ReturnObjectPtr - Pointer to the object returned from the
* evaluation of a method or object
*
* RETURN: Status. AE_OK if repair was successful.
*
* not expected.
*
******************************************************************************/
static ACPI_STATUS
{
{
case ACPI_TYPE_BUFFER:
if (!(ExpectedBtypes & ACPI_RTYPE_STRING))
{
return (AE_AML_OPERAND_TYPE);
}
/*
* Have a Buffer, expected a String, convert. Use a ToString
* conversion, no transform performed on the buffer data. The best
* example of this is the _BIF method, where the string data from
* the battery is often (incorrectly) returned as buffer object(s).
*/
Length = 0;
{
Length++;
}
/* Allocate a new string object */
if (!NewObject)
{
return (AE_NO_MEMORY);
}
/*
* Copy the raw buffer data with no transform. String is already NULL
* terminated at Length+1.
*/
/* Install the new return object */
/*
* If the object is a package element, we need to:
* 1. Decrement the reference count of the orignal object, it was
* incremented when building the package
* 2. Increment the reference count of the new object, it will be
* decremented when releasing the package
*/
if (PackageIndex != ACPI_NOT_PACKAGE)
{
}
return (AE_OK);
default:
break;
}
return (AE_AML_OPERAND_TYPE);
}