nspredef.c revision 26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers/******************************************************************************
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Module Name: nspredef - Validation of ACPI predefined methods and objects
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers *****************************************************************************/
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * Copyright (C) 2000 - 2011, Intel Corp.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * All rights reserved.
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * Redistribution and use in source and binary forms, with or without
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * modification, are permitted provided that the following conditions
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * 1. Redistributions of source code must retain the above copyright
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * notice, this list of conditions, and the following disclaimer,
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * without modification.
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * 2. Redistributions in binary form must reproduce at minimum a disclaimer
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * substantially similar to the "NO WARRANTY" disclaimer below
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * ("Disclaimer") and any redistribution must be conditioned upon
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * including a substantially similar Disclaimer requirement for further
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * binary redistribution.
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * 3. Neither the names of the above-listed copyright holders nor the names
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * of any contributors may be used to endorse or promote products derived
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * from this software without specific prior written permission.
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * Alternatively, this software may be distributed under the terms of the
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * GNU General Public License ("GPL") version 2 as published by the Free
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * Software Foundation.
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * NO WARRANTY
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * POSSIBILITY OF SUCH DAMAGES.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers/*******************************************************************************
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * This module validates predefined ACPI objects that appear in the namespace,
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * at the time they are evaluated (via AcpiEvaluateObject). The purpose of this
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * validation is to detect problems with BIOS-exposed predefined ACPI objects
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * before the results are returned to the ACPI-related drivers.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * There are several areas that are validated:
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * 1) The number of input arguments as defined by the method/object in the
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * ASL is validated against the ACPI specification.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * 2) The type of the return object (if any) is validated against the ACPI
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * specification.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * 3) For returned package objects, the count of package elements is
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * validated, as well as the type of each package element. Nested
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * packages are supported.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * For any problems found, a warning message is issued.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers ******************************************************************************/
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers/* Local prototypes */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Names for the types that can be returned by the predefined objects.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Used for warning messages. Must be in the same order as the ACPI_RTYPEs
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myersstatic const char *AcpiRtypeNames[] =
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers "/Reference",
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers/*******************************************************************************
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * FUNCTION: AcpiNsCheckPredefinedNames
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * PARAMETERS: Node - Namespace node for the method/object
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * UserParamCount - Number of parameters actually passed
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * ReturnStatus - Status from the object evaluation
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * ReturnObjectPtr - Pointer to the object returned from the
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * evaluation of a method or object
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * RETURN: Status
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * DESCRIPTION: Check an ACPI name for a match in the predefined name list.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers ******************************************************************************/
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers ACPI_OPERAND_OBJECT *ReturnObject = *ReturnObjectPtr;
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Match the name for this method/object against the predefined list */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers Predefined = AcpiNsCheckForPredefinedName (Node);
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers /* Get the full pathname to the object, for use in warning messages */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers return (AE_OK); /* Could not get pathname, ignore */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Check that the parameter count for this method matches the ASL
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * definition. For predefined names, ensure that both the caller and
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * the method itself are in accordance with the ACPI specification.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers AcpiNsCheckParameterCount (Pathname, Node, UserParamCount, Predefined);
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* If not a predefined name, we cannot validate the return object */
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * If the method failed or did not actually return an object, we cannot
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * validate the return object
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers if ((ReturnStatus != AE_OK) && (ReturnStatus != AE_CTRL_RETURN_VALUE))
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * If there is no return value, check if we require a return value for
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * this predefined name. Either one return value is expected, or none,
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * for both methods and other objects.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Exit now if there is no return object. Warning if one was expected.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers (!(Predefined->Info.ExpectedBtypes & ACPI_RTYPE_NONE)))
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers ACPI_WARN_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS,
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers "Missing expected return value"));
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * 1) We have a return value, but if one wasn't expected, just exit, this is
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * not a problem. For example, if the "Implicit Return" feature is
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * enabled, methods will always return a value.
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * 2) If the return value can be of any type, then we cannot perform any
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * validation, exit.
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers (Predefined->Info.ExpectedBtypes == ACPI_RTYPE_ALL))
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers /* Create the parameter data block for object validation */
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers Data = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_PREDEFINED_DATA));
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * Check that the type of the main return object is what is expected
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * for this predefined name
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers Status = AcpiNsCheckObjectType (Data, ReturnObjectPtr,
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers Predefined->Info.ExpectedBtypes, ACPI_NOT_PACKAGE_ELEMENT);
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * For returned Package objects, check the type of all sub-objects.
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * Note: Package may have been newly created by call above.
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross if ((*ReturnObjectPtr)->Common.Type == ACPI_TYPE_PACKAGE)
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers Status = AcpiNsCheckPackage (Data, ReturnObjectPtr);
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * The return object was OK, or it was successfully repaired above.
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * Now make some additional checks such as verifying that package
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * objects are sorted correctly (if required) or buffer objects have
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * the correct data width (bytes vs. dwords). These repairs are
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * performed on a per-name basis, i.e., the code is specific to
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * particular predefined names.
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers Status = AcpiNsComplexRepairs (Data, Node, Status, ReturnObjectPtr);
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * If the object validation failed or if we successfully repaired one
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * or more objects, mark the parent node to suppress further warning
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * messages during the next evaluation of the same method/object.
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers if (ACPI_FAILURE (Status) || (Data->Flags & ACPI_OBJECT_REPAIRED))
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers/*******************************************************************************
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * FUNCTION: AcpiNsCheckParameterCount
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * PARAMETERS: Pathname - Full pathname to the node (for error msgs)
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Node - Namespace node for the method/object
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * UserParamCount - Number of args passed in by the caller
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Predefined - Pointer to entry in predefined name table
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * RETURN: None
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * DESCRIPTION: Check that the declared (in ASL/AML) parameter count for a
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * predefined name is what is expected (i.e., what is defined in
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * the ACPI specification for this predefined name.)
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers ******************************************************************************/
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Methods have 0-7 parameters. All other types have zero. */
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * Check the parameter count for non-predefined methods/objects.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Warning if too few or too many arguments have been passed by the
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * caller. An incorrect number of arguments may not cause the method
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * to fail. However, the method will fail if there are too few
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * arguments and the method attempts to use one of the missing ones.
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers ACPI_WARN_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS,
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers "Insufficient arguments - needs %u, found %u",
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers ACPI_WARN_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS,
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers "Excess arguments - needs %u, found %u",
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * Validate the user-supplied parameter count.
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * Allow two different legal argument counts (_SCP, etc.)
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers RequiredParamsCurrent = Predefined->Info.ParamCount & 0x0F;
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers RequiredParamsOld = Predefined->Info.ParamCount >> 4;
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers ACPI_WARN_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS,
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers "Parameter count mismatch - "
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers "caller passed %u, ACPI requires %u",
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Check that the ASL-defined parameter count is what is expected for
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * this predefined name (parameter count as defined by the ACPI
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * specification)
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers ACPI_WARN_PREDEFINED ((AE_INFO, Pathname, Node->Flags,
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers "Parameter count mismatch - ASL declared %u, ACPI requires %u",
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers/*******************************************************************************
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * FUNCTION: AcpiNsCheckForPredefinedName
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * PARAMETERS: Node - Namespace node for the method/object
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * RETURN: Pointer to entry in predefined table. NULL indicates not found.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * DESCRIPTION: Check an object name against the predefined object list.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers ******************************************************************************/
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Quick check for a predefined name, first character must be underscore */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Search info table for a predefined method/object name */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers if (ACPI_COMPARE_NAME (Node->Name.Ascii, ThisName->Info.Name))
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Skip next entry in the table if this name returns a Package
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * (next entry contains the package info)
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers if (ThisName->Info.ExpectedBtypes & ACPI_RTYPE_PACKAGE)
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers/*******************************************************************************
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * FUNCTION: AcpiNsCheckPackage
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * PARAMETERS: Data - Pointer to validation data structure
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * ReturnObjectPtr - Pointer to the object returned from the
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * evaluation of a method or object
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * RETURN: Status
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * DESCRIPTION: Check a returned package object for the correct count and
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * correct type of all sub-objects.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers ******************************************************************************/
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers ACPI_OPERAND_OBJECT *ReturnObject = *ReturnObjectPtr;
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* The package info for this name is in the next table entry */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers "%s Validating return Package of Type %X, Count %X\n",
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers Data->Pathname, Package->RetInfo.Type, ReturnObject->Package.Count));
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * For variable-length Packages, we can safely remove all embedded
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * and trailing NULL package elements
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross AcpiNsRemoveNullElements (Data, Package->RetInfo.Type, ReturnObject);
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Extract package count and elements array */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* The package must have at least one element, else invalid */
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers ACPI_WARN_PREDEFINED ((AE_INFO, Data->Pathname, Data->NodeFlags,
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers "Return Package has no elements (empty)"));
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Decode the type of the expected package contents
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * PTYPE1 packages contain no subpackages
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * PTYPE2 packages contain sub-packages
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * The package count is fixed and there are no sub-packages
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * If package is too small, exit.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * If package is larger than expected, issue warning but continue
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers ExpectedCount = Package->RetInfo.Count1 + Package->RetInfo.Count2;
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross "%s: Return Package is larger than needed - "
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross "found %u, expected %u\n",
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Validate all elements of the returned package */
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers Status = AcpiNsCheckPackageElements (Data, Elements,
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers Package->RetInfo.ObjectType1, Package->RetInfo.Count1,
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers Package->RetInfo.ObjectType2, Package->RetInfo.Count2, 0);
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * The package count is variable, there are no sub-packages, and all
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * elements must be of the same type
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers for (i = 0; i < Count; i++)
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * The package count is variable, there are no sub-packages. There are
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * a fixed number of required elements, and a variable number of
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * optional elements.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Check if package is at least as large as the minimum required
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Variable number of sub-objects */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers for (i = 0; i < Count; i++)
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* These are the required package elements (0, 1, or 2) */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* These are the optional package elements */
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers /* First element is the (Integer) revision */
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers /* Examine the sub-packages */
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers Status = AcpiNsCheckPackageList (Data, Package, Elements, Count);
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* First element is the (Integer) count of sub-packages to follow */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Count cannot be larger than the parent package length, but allow it
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * to be smaller. The >= accounts for the Integer above.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers ExpectedCount = (UINT32) (*Elements)->Integer.Value;
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers /* Examine the sub-packages */
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers Status = AcpiNsCheckPackageList (Data, Package, Elements, Count);
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * These types all return a single Package that consists of a
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * variable number of sub-Packages.
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * First, ensure that the first element is a sub-Package. If not,
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * the BIOS may have incorrectly returned the object as a single
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * package instead of a Package of Packages (a common error if
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * there is only one entry). We may be able to repair this by
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * wrapping the returned Package with a new outer Package.
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers if (*Elements && ((*Elements)->Common.Type != ACPI_TYPE_PACKAGE))
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers /* Create the new outer package and populate it */
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers Status = AcpiNsRepairPackageList (Data, ReturnObjectPtr);
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers /* Update locals to point to the new package (of 1 element) */
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers /* Examine the sub-packages */
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers Status = AcpiNsCheckPackageList (Data, Package, Elements, Count);
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers /* Should not get here if predefined info table is correct */
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers ACPI_WARN_PREDEFINED ((AE_INFO, Data->Pathname, Data->NodeFlags,
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers "Invalid internal return type in table entry: %X",
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers /* Error exit for the case with an incorrect package count */
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers ACPI_WARN_PREDEFINED ((AE_INFO, Data->Pathname, Data->NodeFlags,
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers "Return Package is too small - found %u elements, expected %u",
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers/*******************************************************************************
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * FUNCTION: AcpiNsCheckPackageList
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * PARAMETERS: Data - Pointer to validation data structure
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * Package - Pointer to package-specific info for method
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * Elements - Element list of parent package. All elements
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * of this list should be of type Package.
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * Count - Count of subpackages
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * RETURN: Status
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * DESCRIPTION: Examine a list of subpackages
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers ******************************************************************************/
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * Validate each sub-Package in the parent Package
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * NOTE: assumes list of sub-packages contains no NULL elements.
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * Any NULL elements should have been removed by earlier call
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * to AcpiNsRemoveNullElements.
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers for (i = 0; i < Count; i++)
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers /* Each sub-object must be of type Package */
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers Status = AcpiNsCheckObjectType (Data, &SubPackage,
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers /* Examine the different types of expected sub-packages */
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers /* Each subpackage has a fixed number of elements */
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers ExpectedCount = Package->RetInfo.Count1 + Package->RetInfo.Count2;
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers Status = AcpiNsCheckPackageElements (Data, SubElements,
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers /* Each sub-package has a fixed length */
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers /* Check the type of each sub-package element */
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers for (j = 0; j < ExpectedCount; j++)
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers Status = AcpiNsCheckObjectType (Data, &SubElements[j],
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers /* Each sub-package has a variable but minimum length */
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers /* Check the type of each sub-package element */
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers Status = AcpiNsCheckPackageElements (Data, SubElements,
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * First element is the (Integer) count of elements, including
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * the count field (the ACPI name is NumElements)
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers Status = AcpiNsCheckObjectType (Data, SubElements,
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * Make sure package is large enough for the Count and is
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * is as large as the minimum size
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers ExpectedCount = (UINT32) (*SubElements)->Integer.Value;
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers if (SubPackage->Package.Count < Package->RetInfo.Count1)
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * Either the NumEntries element was originally zero or it was
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * a NULL element and repaired to an Integer of value zero.
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * In either case, repair it by setting NumEntries to be the
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * actual size of the subpackage.
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers /* Check the type of each sub-package element */
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers Status = AcpiNsCheckPackageElements (Data, (SubElements + 1),
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers default: /* Should not get here, type was validated by caller */
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers /* The sub-package count was smaller than required */
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers ACPI_WARN_PREDEFINED ((AE_INFO, Data->Pathname, Data->NodeFlags,
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers "Return Sub-Package[%u] is too small - found %u elements, expected %u",
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers/*******************************************************************************
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * FUNCTION: AcpiNsCheckPackageElements
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * PARAMETERS: Data - Pointer to validation data structure
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Elements - Pointer to the package elements array
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Type1 - Object type for first group
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Count1 - Count for first group
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Type2 - Object type for second group
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Count2 - Count for second group
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * StartIndex - Start of the first group of elements
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * RETURN: Status
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * DESCRIPTION: Check that all elements of a package are of the correct object
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * type. Supports up to two groups of different object types.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers ******************************************************************************/
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Up to two groups of package elements are supported by the data
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * structure. All elements in each group must be of the same type.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * The second group can have a count of zero.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers for (i = 0; i < Count1; i++)
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers Status = AcpiNsCheckObjectType (Data, ThisElement,
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers for (i = 0; i < Count2; i++)
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers Status = AcpiNsCheckObjectType (Data, ThisElement,
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers/*******************************************************************************
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * FUNCTION: AcpiNsCheckObjectType
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * PARAMETERS: Data - Pointer to validation data structure
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * ReturnObjectPtr - Pointer to the object returned from the
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * evaluation of a method or object
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * ExpectedBtypes - Bitmap of expected return type(s)
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * PackageIndex - Index of object within parent package (if
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * applicable - ACPI_NOT_PACKAGE_ELEMENT
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * otherwise)
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * RETURN: Status
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * DESCRIPTION: Check the type of the return object against the expected object
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * type(s). Use of Btype allows multiple expected object types.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers ******************************************************************************/
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers ACPI_OPERAND_OBJECT *ReturnObject = *ReturnObjectPtr;
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * If we get a NULL ReturnObject here, it is a NULL package element.
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * Since all extraneous NULL package elements were removed earlier by a
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * call to AcpiNsRemoveNullElements, this is an unexpected NULL element.
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross * We will attempt to repair it.
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross Status = AcpiNsRepairNullElement (Data, ExpectedBtypes,
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* A Namespace node should not get here, but make sure */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers if (ACPI_GET_DESCRIPTOR_TYPE (ReturnObject) == ACPI_DESC_TYPE_NAMED)
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers ACPI_WARN_PREDEFINED ((AE_INFO, Data->Pathname, Data->NodeFlags,
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers "Invalid return type - Found a Namespace node [%4.4s] type %s",
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Convert the object type (ACPI_TYPE_xxx) to a bitmapped object type.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * The bitmapped type allows multiple possible return types.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Note, the cases below must handle all of the possible types returned
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * from all of the predefined names (including elements of returned
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Not one of the supported objects, must be incorrect */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Is the object one of the expected types? */
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross /* For reference objects, check that the reference type is correct */
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross if (ReturnObject->Common.Type == ACPI_TYPE_LOCAL_REFERENCE)
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross Status = AcpiNsCheckReference (Data, ReturnObject);
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross /* Type mismatch -- attempt repair of the returned object */
26f3cdf03f1adcc98f6d3d99843ee71e9229a8c0Gordon Ross Status = AcpiNsRepairObject (Data, ExpectedBtypes,
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Create a string with all expected types for this predefined object */
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers AcpiNsGetExpectedTypes (TypeBuffer, ExpectedBtypes);
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers ACPI_WARN_PREDEFINED ((AE_INFO, Data->Pathname, Data->NodeFlags,
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers "Return type mismatch - found %s, expected %s",
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers AcpiUtGetObjectTypeName (ReturnObject), TypeBuffer));
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers ACPI_WARN_PREDEFINED ((AE_INFO, Data->Pathname, Data->NodeFlags,
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers "Return Package type mismatch at index %u - "
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers AcpiUtGetObjectTypeName (ReturnObject), TypeBuffer));
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers/*******************************************************************************
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * FUNCTION: AcpiNsCheckReference
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * PARAMETERS: Data - Pointer to validation data structure
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * ReturnObject - Object returned from the evaluation of a
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * method or object
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * RETURN: Status
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * DESCRIPTION: Check a returned reference object for the correct reference
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * type. The only reference type that can be returned from a
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * predefined method is a named reference. All others are invalid.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers ******************************************************************************/
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Check the reference object for the correct reference type (opcode).
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * The only type of reference that can be converted to an ACPI_OBJECT is
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * a reference to a named object (reference class: NAME)
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers if (ReturnObject->Reference.Class == ACPI_REFCLASS_NAME)
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers ACPI_WARN_PREDEFINED ((AE_INFO, Data->Pathname, Data->NodeFlags,
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers "Return type mismatch - unexpected reference object type [%s] %2.2X",
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers/*******************************************************************************
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * FUNCTION: AcpiNsGetExpectedTypes
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * PARAMETERS: Buffer - Pointer to where the string is returned
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * ExpectedBtypes - Bitmap of expected return type(s)
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * RETURN: Buffer is populated with type names.
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * DESCRIPTION: Translate the expected types bitmap into a string of ascii
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers * names of expected types, for use in warning messages.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers ******************************************************************************/
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers for (i = 0; i < ACPI_NUM_RTYPES; i++)
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers /* If one of the expected types, concatenate the name of this type */
571909175b4f9a1ef15ec4afead6d6d463dbe760Dana Myers j = 0; /* Use name separator from now on */