7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek/******************************************************************************
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Module Name: nsarguments - Validation of args for ACPI predefined methods
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek *****************************************************************************/
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Copyright (C) 2000 - 2016, Intel Corp.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * All rights reserved.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Redistribution and use in source and binary forms, with or without
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * modification, are permitted provided that the following conditions
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * 1. Redistributions of source code must retain the above copyright
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * notice, this list of conditions, and the following disclaimer,
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * without modification.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * 2. Redistributions in binary form must reproduce at minimum a disclaimer
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * substantially similar to the "NO WARRANTY" disclaimer below
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * ("Disclaimer") and any redistribution must be conditioned upon
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * including a substantially similar Disclaimer requirement for further
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * binary redistribution.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * 3. Neither the names of the above-listed copyright holders nor the names
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * of any contributors may be used to endorse or promote products derived
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * from this software without specific prior written permission.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Alternatively, this software may be distributed under the terms of the
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * GNU General Public License ("GPL") version 2 as published by the Free
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Software Foundation.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * NO WARRANTY
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * POSSIBILITY OF SUCH DAMAGES.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek/*******************************************************************************
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * FUNCTION: AcpiNsCheckArgumentTypes
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * PARAMETERS: Info - Method execution information block
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * RETURN: None
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * DESCRIPTION: Check the incoming argument count and all argument types
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * against the argument type list for a predefined name.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek ******************************************************************************/
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek /* If not a predefined name, cannot typecheck args */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek ArgTypeList = Info->Predefined->Info.ArgumentList;
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek ArgCount = METHOD_GET_ARG_COUNT (ArgTypeList);
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek /* Typecheck all arguments */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek for (i = 0; ((i < ArgCount) && (i < Info->ParamCount)); i++)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek UserArgType = Info->Parameters[i]->Common.Type;
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek ACPI_WARN_PREDEFINED ((AE_INFO, Info->FullPathname, ACPI_WARN_ALWAYS,
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek "Argument #%u type mismatch - "
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek/*******************************************************************************
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * FUNCTION: AcpiNsCheckAcpiCompliance
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * PARAMETERS: Pathname - Full pathname to the node (for error msgs)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Node - Namespace node for the method/object
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Predefined - Pointer to entry in predefined name table
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * RETURN: None
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * DESCRIPTION: Check that the declared parameter count (in ASL/AML) for a
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * predefined name is what is expected (matches what is defined in
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * the ACPI specification for this predefined name.)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek ******************************************************************************/
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek /* Get the ACPI-required arg count from the predefined info table */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek METHOD_GET_ARG_COUNT (Predefined->Info.ArgumentList);
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * If this object is not a control method, we can check if the ACPI
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * spec requires that it be a method.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek /* Object requires args, must be implemented as a method */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek ACPI_BIOS_ERROR_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS,
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek "Object (%s) must be a control method with %u arguments",
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek AcpiUtGetTypeName (Node->Type), RequiredParamCount));
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek else if (!RequiredParamCount && !Predefined->Info.ExpectedBtypes)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek /* Object requires no args and no return value, must be a method */
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek ACPI_BIOS_ERROR_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS,
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek "Object (%s) must be a control method "
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek "with no arguments and no return value",
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * This is a control method.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Check that the ASL/AML-defined parameter count for this method
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * matches the ACPI-required parameter count
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Some methods are allowed to have a "minimum" number of args (_SCP)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * because their definition in ACPI has changed over time.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Note: These are BIOS errors in the declaration of the object
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek AmlParamCount = Node->Object->Method.ParamCount;
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek ACPI_BIOS_ERROR_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS,
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek "Insufficient arguments - "
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek "ASL declared %u, ACPI requires %u",
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek else if ((AmlParamCount > RequiredParamCount) &&
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek !(Predefined->Info.ArgumentList & ARG_COUNT_IS_MINIMUM))
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek ACPI_BIOS_ERROR_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS,
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek "Excess arguments - "
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek "ASL declared %u, ACPI requires %u",
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek/*******************************************************************************
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * FUNCTION: AcpiNsCheckArgumentCount
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * PARAMETERS: Pathname - Full pathname to the node (for error msgs)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Node - Namespace node for the method/object
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * UserParamCount - Number of args passed in by the caller
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Predefined - Pointer to entry in predefined name table
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * RETURN: None
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * DESCRIPTION: Check that incoming argument count matches the declared
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * parameter count (in the ASL/AML) for an object.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek ******************************************************************************/
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Not a predefined name. Check the incoming user argument count
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * against the count that is specified in the method/object.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek ACPI_INFO_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS,
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek "%u arguments were passed to a non-method ACPI object (%s)",
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek UserParamCount, AcpiUtGetTypeName (Node->Type)));
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * This is a control method. Check the parameter count.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * We can only check the incoming argument count against the
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * argument count declared for the method in the ASL/AML.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Emit a message if too few or too many arguments have been passed
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * by the caller.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Note: Too many arguments will not cause the method to
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * fail. However, the method will fail if there are too few
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * arguments and the method attempts to use one of the missing ones.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek AmlParamCount = Node->Object->Method.ParamCount;
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek ACPI_WARN_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS,
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek "Insufficient arguments - "
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek "Caller passed %u, method requires %u",
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek ACPI_INFO_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS,
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek "Excess arguments - "
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek "Caller passed %u, method requires %u",
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * This is a predefined name. Validate the user-supplied parameter
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * count against the ACPI specification. We don't validate against
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * the method itself because what is important here is that the
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * caller is in conformance with the spec. (The arg count for the
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * method was checked against the ACPI spec earlier.)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * Some methods are allowed to have a "minimum" number of args (_SCP)
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek * because their definition in ACPI has changed over time.
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek METHOD_GET_ARG_COUNT (Predefined->Info.ArgumentList);
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek ACPI_WARN_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS,
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek "Insufficient arguments - "
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek "Caller passed %u, ACPI requires %u",
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek else if ((UserParamCount > RequiredParamCount) &&
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek !(Predefined->Info.ArgumentList & ARG_COUNT_IS_MINIMUM))
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek ACPI_INFO_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS,
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek "Excess arguments - "
7b1019a6d29ccb7999dc76cba3dde1c627e8e609Jerry Jelinek "Caller passed %u, ACPI requires %u",