nspredef.c revision aa2aa9a662539940ddbc8610da5a3a874ebd7503
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers/******************************************************************************
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Module Name: nspredef - Validation of ACPI predefined methods and objects
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers *****************************************************************************/
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers/******************************************************************************
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * 1. Copyright Notice
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Some or all of this work - Copyright (c) 1999 - 2009, Intel Corp.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * All rights reserved.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * 2. License
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * 2.1. This is your license from Intel Corp. under its intellectual property
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * rights. You may have additional license terms from the party that provided
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * you this software, covering your right to use that party's intellectual
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * property rights.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * copy of the source code appearing in this file ("Covered Code") an
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * irrevocable, perpetual, worldwide license under Intel's copyrights in the
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * base code distributed originally by Intel ("Original Intel Code") to copy,
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * make derivatives, distribute, use and display any portion of the Covered
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Code in any form, with the right to sublicense such rights; and
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * license (with the right to sublicense), under only those claims of Intel
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * patents that are infringed by the Original Intel Code, to make, use, sell,
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * offer to sell, and import the Covered Code and derivative works thereof
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * solely to the minimum extent necessary to exercise the above copyright
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * license, and in no event shall the patent license extend to any additions
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * to or modifications of the Original Intel Code. No other license or right
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * is granted directly or by implication, estoppel or otherwise;
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * The above copyright and patent license is granted only if the following
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * conditions are met:
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * 3. Conditions
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * 3.1. Redistribution of Source with Rights to Further Distribute Source.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Redistribution of source code of any substantial portion of the Covered
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Code or modification with rights to further distribute source must include
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * the above Copyright Notice, the above License, this list of Conditions,
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * and the following Disclaimer and Export Compliance provision. In addition,
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Licensee must cause all Covered Code to which Licensee contributes to
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * contain a file documenting the changes Licensee made to create that Covered
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Code and the date of any change. Licensee must include in that file the
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * documentation of any changes made by any predecessor Licensee. Licensee
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * must include a prominent statement that the modification is derived,
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * directly or indirectly, from Original Intel Code.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Redistribution of source code of any substantial portion of the Covered
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Code or modification without rights to further distribute source must
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * include the following Disclaimer and Export Compliance provision in the
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * documentation and/or other materials provided with distribution. In
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * addition, Licensee may not authorize further sublicense of source of any
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * portion of the Covered Code, and must include terms to the effect that the
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * license from Licensee to its licensee is limited to the intellectual
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * property embodied in the software Licensee provides to its licensee, and
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * not to intellectual property embodied in modifications its licensee may
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * 3.3. Redistribution of Executable. Redistribution in executable form of any
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * substantial portion of the Covered Code or modification must reproduce the
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * above Copyright Notice, and the following Disclaimer and Export Compliance
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * provision in the documentation and/or other materials provided with the
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * distribution.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * 3.4. Intel retains all right, title, and interest in and to the Original
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Intel Code.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * 3.5. Neither the name Intel nor any other trademark owned or controlled by
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Intel shall be used in advertising or otherwise to promote the sale, use or
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * other dealings in products derived from or relating to the Covered Code
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * without prior written authorization from Intel.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * 4. Disclaimer and Export Compliance
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * PARTICULAR PURPOSE.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * LIMITED REMEDY.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * 4.3. Licensee shall not export, either directly or indirectly, any of this
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * software or system incorporating such software without first obtaining any
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * required license or other approval from the U. S. Department of Commerce or
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * any other agency or department of the United States Government. In the
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * event Licensee exports any such software from the United States or
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * re-exports any such software from a foreign destination, Licensee shall
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * ensure that the distribution and export/re-export of the software is in
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * compliance with all laws, regulations, orders, or other restrictions of the
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * U.S. Export Administration Regulations. Licensee agrees that neither it nor
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * any of its subsidiaries will export/re-export any technical data, process,
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * software, or service, directly or indirectly, to any country for which the
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * United States government or any agency thereof requires an export license,
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * other governmental approval, or letter of assurance, without first obtaining
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * such license, approval or letter.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers *****************************************************************************/
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
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);
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Get the full pathname to the object, for use in error 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 */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* If the method failed, we cannot validate the return object */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers if ((ReturnStatus != AE_OK) && (ReturnStatus != AE_CTRL_RETURN_VALUE))
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Only validate the return value on the first successful evaluation of
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * the method. This ensures that any warnings will only be emitted during
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * the very first evaluation of the method/object.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Mark the node as having been successfully evaluated */
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)))
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * We have a return value, but if one wasn't expected, just exit, this is
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * not a problem
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * For example, if the "Implicit Return" feature is enabled, methods will
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * always return a value
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Check that the type of the return object is what is expected for
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * this predefined name
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers Status = AcpiNsCheckObjectType (Pathname, ReturnObjectPtr,
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers Predefined->Info.ExpectedBtypes, ACPI_NOT_PACKAGE);
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* For returned Package objects, check the type of all sub-objects */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers if (ReturnObject->Common.Type == ACPI_TYPE_PACKAGE)
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers Status = AcpiNsCheckPackage (Pathname, ReturnObjectPtr, Predefined);
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. */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Argument count check 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.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers "%s: Insufficient arguments - needs %d, found %d",
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers "%s: Excess arguments - needs %d, found %d",
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Allow two different legal argument counts (_SCP, etc.) */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers RequiredParamsCurrent = Predefined->Info.ParamCount & 0x0F;
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers RequiredParamsOld = Predefined->Info.ParamCount >> 4;
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Validate the user-supplied parameter count */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers "%s: Parameter count mismatch - "
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers "caller passed %d, ACPI requires %d",
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers Pathname, UserParamCount, RequiredParamsCurrent));
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Only validate the argument count on the first successful evaluation of
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * the method. This ensures that any warnings will only be emitted during
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * the very first evaluation of the method/object.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Check that the ASL-defined parameter count is what is expected for
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * this predefined name.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers "%s: Parameter count mismatch - ASL declared %d, ACPI requires %d",
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 /* Return pointer to this table entry */
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
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * PARAMETERS: Pathname - Full pathname to the node (for error msgs)
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * ReturnObjectPtr - Pointer to the object returned from the
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * evaluation of a method or object
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Predefined - Pointer to entry in predefined name table
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",
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers Pathname, Package->RetInfo.Type, ReturnObject->Package.Count));
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Extract package count and elements array */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* The package must have at least one element, else invalid */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers "%s: Return Package has no elements (empty)", Pathname));
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;
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers "%s: Return Package is larger than needed - "
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers "found %u, expected %u", Pathname, Count, ExpectedCount));
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Validate all elements of the returned package */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers Status = AcpiNsCheckPackageElements (Pathname, 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 Status = AcpiNsCheckObjectType (Pathname, Elements,
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 Status = AcpiNsCheckObjectType (Pathname, Elements,
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* These are the optional package elements */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers Status = AcpiNsCheckObjectType (Pathname, Elements,
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* First element is the (Integer) count of sub-packages to follow */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers Status = AcpiNsCheckObjectType (Pathname, Elements,
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;
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Now we can walk the sub-packages */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /*lint -fallthrough */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * These types all return a single package that consists of a variable
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * number of sub-packages
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers for (i = 0; i < Count; i++)
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Each sub-object must be of type Package */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers Status = AcpiNsCheckObjectType (Pathname, &SubPackage,
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Examine the different types of sub-packages */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Each subpackage has a fixed number of elements */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers Package->RetInfo.Count1 + Package->RetInfo.Count2;
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers Status = AcpiNsCheckPackageElements (Pathname, SubElements,
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Each sub-package has a fixed length */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Check the type of each sub-package element */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers for (j = 0; j < ExpectedCount; j++)
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers Status = AcpiNsCheckObjectType (Pathname, &SubElements[j],
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Each sub-package has a variable but minimum length */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Check the type of each sub-package element */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers Status = AcpiNsCheckPackageElements (Pathname, SubElements,
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* First element is the (Integer) count of elements to follow */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers Status = AcpiNsCheckObjectType (Pathname, SubElements,
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Make sure package is large enough for the Count */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers ExpectedCount = (UINT32) (*SubElements)->Integer.Value;
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Check the type of each sub-package element */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Should not get here if predefined info table is correct */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers "%s: Invalid internal return type in table entry: %X",
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Error exit for the case with an incorrect package count */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers ACPI_WARNING ((AE_INFO, "%s: Return Package is too small - "
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers "found %u, expected %u", Pathname, Count, ExpectedCount));
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers/*******************************************************************************
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * FUNCTION: AcpiNsCheckPackageElements
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * PARAMETERS: Pathname - Full pathname to the node (for error msgs)
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++)
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers Status = AcpiNsCheckObjectType (Pathname, ThisElement,
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers for (i = 0; i < Count2; i++)
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers Status = AcpiNsCheckObjectType (Pathname, ThisElement,
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers/*******************************************************************************
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * FUNCTION: AcpiNsCheckObjectType
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * PARAMETERS: Pathname - Full pathname to the node (for error msgs)
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
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * applicable - ACPI_NOT_PACKAGE 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;
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * If we get a NULL ReturnObject here, it is a NULL package element,
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * and this is always an error.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* A Namespace node should not get here, but make sure */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers if (ACPI_GET_DESCRIPTOR_TYPE (ReturnObject) == ACPI_DESC_TYPE_NAMED)
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers "%s: 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? */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Type mismatch -- attempt repair of the returned object */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers Status = AcpiNsRepairObject (ExpectedBtypes, PackageIndex,
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* For reference objects, check that the reference type is correct */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers if (ReturnObject->Common.Type == ACPI_TYPE_LOCAL_REFERENCE)
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers Status = AcpiNsCheckReference (Pathname, ReturnObject);
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Create a string with all expected types for this predefined object */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers for (i = 0; i < ACPI_NUM_RTYPES; i++)
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* If one of the expected types, concatenate the name of this type */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers j = 0; /* Use name separator from now on */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers "%s: Return type mismatch - found %s, expected %s",
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers Pathname, AcpiUtGetObjectTypeName (ReturnObject), TypeBuffer));
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers "%s: Return Package type mismatch at index %u - "
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers AcpiUtGetObjectTypeName (ReturnObject), TypeBuffer));
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers/*******************************************************************************
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * FUNCTION: AcpiNsCheckReference
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * PARAMETERS: Pathname - Full pathname to the node (for error msgs)
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)
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers "%s: Return type mismatch - "
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers "unexpected reference object type [%s] %2.2X",
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers/*******************************************************************************
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * FUNCTION: AcpiNsRepairObject
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * PARAMETERS: Pathname - Full pathname to the node (for error msgs)
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * PackageIndex - Used to determine if target is in a package
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * ReturnObjectPtr - Pointer to the object returned from the
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * evaluation of a method or object
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * RETURN: Status. AE_OK if repair was successful.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * DESCRIPTION: Attempt to repair/convert a return object of a type that was
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * not expected.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers ******************************************************************************/
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers ACPI_OPERAND_OBJECT *ReturnObject = *ReturnObjectPtr;
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Have a Buffer, expected a String, convert. Use a ToString
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * conversion, no transform performed on the buffer data. The best
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * example of this is the _BIF method, where the string data from
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * the battery is often (incorrectly) returned as buffer object(s).
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Allocate a new string object */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * Copy the raw buffer data with no transform. String is already NULL
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * terminated at Length+1.
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers /* Install the new return object */
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * If the object is a package element, we need to:
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * 1. Decrement the reference count of the orignal object, it was
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * incremented when building the package
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * 2. Increment the reference count of the new object, it will be
aa2aa9a662539940ddbc8610da5a3a874ebd7503Dana Myers * decremented when releasing the package