acpica/namespace/nsarguments.c

0001 /******************************************************************************
0002  *
0003  * Module Name: nsarguments - Validation of args for ACPI predefined methods
0004  *
0005  *****************************************************************************/
0006
0007 /******************************************************************************
0008  *
0009  * 1. Copyright Notice
0010  *
0011  * Some or all of this work - Copyright (c) 1999 - 2024, Intel Corp.
0012  * All rights reserved.
0013  *
0014  * 2. License
0015  *
0016  * 2.1. This is your license from Intel Corp. under its intellectual property
0017  * rights. You may have additional license terms from the party that provided
0018  * you this software, covering your right to use that party's intellectual
0019  * property rights.
0020  *
0021  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
0022  * copy of the source code appearing in this file ("Covered Code") an
0023  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
0024  * base code distributed originally by Intel ("Original Intel Code") to copy,
0025  * make derivatives, distribute, use and display any portion of the Covered
0026  * Code in any form, with the right to sublicense such rights; and
0027  *
0028  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
0029  * license (with the right to sublicense), under only those claims of Intel
0030  * patents that are infringed by the Original Intel Code, to make, use, sell,
0031  * offer to sell, and import the Covered Code and derivative works thereof
0032  * solely to the minimum extent necessary to exercise the above copyright
0033  * license, and in no event shall the patent license extend to any additions
0034  * to or modifications of the Original Intel Code. No other license or right
0035  * is granted directly or by implication, estoppel or otherwise;
0036  *
0037  * The above copyright and patent license is granted only if the following
0038  * conditions are met:
0039  *
0040  * 3. Conditions
0041  *
0042  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
0043  * Redistribution of source code of any substantial portion of the Covered
0044  * Code or modification with rights to further distribute source must include
0045  * the above Copyright Notice, the above License, this list of Conditions,
0046  * and the following Disclaimer and Export Compliance provision. In addition,
0047  * Licensee must cause all Covered Code to which Licensee contributes to
0048  * contain a file documenting the changes Licensee made to create that Covered
0049  * Code and the date of any change. Licensee must include in that file the
0050  * documentation of any changes made by any predecessor Licensee. Licensee
0051  * must include a prominent statement that the modification is derived,
0052  * directly or indirectly, from Original Intel Code.
0053  *
0054  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
0055  * Redistribution of source code of any substantial portion of the Covered
0056  * Code or modification without rights to further distribute source must
0057  * include the following Disclaimer and Export Compliance provision in the
0058  * documentation and/or other materials provided with distribution. In
0059  * addition, Licensee may not authorize further sublicense of source of any
0060  * portion of the Covered Code, and must include terms to the effect that the
0061  * license from Licensee to its licensee is limited to the intellectual
0062  * property embodied in the software Licensee provides to its licensee, and
0063  * not to intellectual property embodied in modifications its licensee may
0064  * make.
0065  *
0066  * 3.3. Redistribution of Executable. Redistribution in executable form of any
0067  * substantial portion of the Covered Code or modification must reproduce the
0068  * above Copyright Notice, and the following Disclaimer and Export Compliance
0069  * provision in the documentation and/or other materials provided with the
0070  * distribution.
0071  *
0072  * 3.4. Intel retains all right, title, and interest in and to the Original
0073  * Intel Code.
0074  *
0075  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
0076  * Intel shall be used in advertising or otherwise to promote the sale, use or
0077  * other dealings in products derived from or relating to the Covered Code
0078  * without prior written authorization from Intel.
0079  *
0080  * 4. Disclaimer and Export Compliance
0081  *
0082  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
0083  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
0084  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
0085  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
0086  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
0087  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
0088  * PARTICULAR PURPOSE.
0089  *
0090  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
0091  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
0092  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
0093  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
0094  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
0095  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
0096  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
0097  * LIMITED REMEDY.
0098  *
0099  * 4.3. Licensee shall not export, either directly or indirectly, any of this
0100  * software or system incorporating such software without first obtaining any
0101  * required license or other approval from the U. S. Department of Commerce or
0102  * any other agency or department of the United States Government. In the
0103  * event Licensee exports any such software from the United States or
0104  * re-exports any such software from a foreign destination, Licensee shall
0105  * ensure that the distribution and export/re-export of the software is in
0106  * compliance with all laws, regulations, orders, or other restrictions of the
0107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
0108  * any of its subsidiaries will export/re-export any technical data, process,
0109  * software, or service, directly or indirectly, to any country for which the
0110  * United States government or any agency thereof requires an export license,
0111  * other governmental approval, or letter of assurance, without first obtaining
0112  * such license, approval or letter.
0113  *
0114  *****************************************************************************
0115  *
0116  * Alternatively, you may choose to be licensed under the terms of the
0117  * following license:
0118  *
0119  * Redistribution and use in source and binary forms, with or without
0120  * modification, are permitted provided that the following conditions
0121  * are met:
0122  * 1. Redistributions of source code must retain the above copyright
0123  *    notice, this list of conditions, and the following disclaimer,
0124  *    without modification.
0125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
0126  *    substantially similar to the "NO WARRANTY" disclaimer below
0127  *    ("Disclaimer") and any redistribution must be conditioned upon
0128  *    including a substantially similar Disclaimer requirement for further
0129  *    binary redistribution.
0130  * 3. Neither the names of the above-listed copyright holders nor the names
0131  *    of any contributors may be used to endorse or promote products derived
0132  *    from this software without specific prior written permission.
0133  *
0134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
0135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
0136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
0137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
0138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
0139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
0140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
0141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
0142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
0143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
0144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0145  *
0146  * Alternatively, you may choose to be licensed under the terms of the
0147  * GNU General Public License ("GPL") version 2 as published by the Free
0148  * Software Foundation.
0149  *
0150  *****************************************************************************/
0151
0152 #include "acpi.h"
0153 #include "accommon.h"
0154 #include "acnamesp.h"
0155 #include "acpredef.h"
0156
0157
0158 #define _COMPONENT          ACPI_NAMESPACE
0159         ACPI_MODULE_NAME    ("nsarguments")
0160
0161
0162 /*******************************************************************************
0163  *
0164  * FUNCTION:    AcpiNsCheckArgumentTypes
0165  *
0166  * PARAMETERS:  Info            - Method execution information block
0167  *
0168  * RETURN:      None
0169  *
0170  * DESCRIPTION: Check the incoming argument count and all argument types
0171  *              against the argument type list for a predefined name.
0172  *
0173  ******************************************************************************/
0174
0175 void
0176 AcpiNsCheckArgumentTypes (
0177     ACPI_EVALUATE_INFO          *Info)
0178 {
0179     UINT16                      ArgTypeList;
0180     UINT8                       ArgCount;
0181     UINT8                       ArgType;
0182     UINT8                       UserArgType;
0183     UINT32                      i;
0184
0185
0186     /*
0187      * If not a predefined name, cannot typecheck args, because
0188      * we have no idea what argument types are expected.
0189      * Also, ignore typecheck if warnings/errors if this method
0190      * has already been evaluated at least once -- in order
0191      * to suppress repetitive messages.
0192      */
0193     if (!Info->Predefined || (Info->Node->Flags & ANOBJ_EVALUATED))
0194     {
0195         return;
0196     }
0197
0198     ArgTypeList = Info->Predefined->Info.ArgumentList;
0199     ArgCount = METHOD_GET_ARG_COUNT (ArgTypeList);
0200
0201     /* Typecheck all arguments */
0202
0203     for (i = 0; ((i < ArgCount) && (i < Info->ParamCount)); i++)
0204     {
0205         ArgType = METHOD_GET_NEXT_TYPE (ArgTypeList);
0206         UserArgType = Info->Parameters[i]->Common.Type;
0207
0208         /* No typechecking for ACPI_TYPE_ANY */
0209
0210         if ((UserArgType != ArgType) && (ArgType != ACPI_TYPE_ANY))
0211         {
0212             ACPI_WARN_PREDEFINED ((AE_INFO, Info->FullPathname, ACPI_WARN_ALWAYS,
0213                 "Argument #%u type mismatch - "
0214                 "Found [%s], ACPI requires [%s]", (i + 1),
0215                 AcpiUtGetTypeName (UserArgType),
0216                 AcpiUtGetTypeName (ArgType)));
0217
0218             /* Prevent any additional typechecking for this method */
0219
0220             Info->Node->Flags |= ANOBJ_EVALUATED;
0221         }
0222     }
0223 }
0224
0225
0226 /*******************************************************************************
0227  *
0228  * FUNCTION:    AcpiNsCheckAcpiCompliance
0229  *
0230  * PARAMETERS:  Pathname        - Full pathname to the node (for error msgs)
0231  *              Node            - Namespace node for the method/object
0232  *              Predefined      - Pointer to entry in predefined name table
0233  *
0234  * RETURN:      None
0235  *
0236  * DESCRIPTION: Check that the declared parameter count (in ASL/AML) for a
0237  *              predefined name is what is expected (matches what is defined in
0238  *              the ACPI specification for this predefined name.)
0239  *
0240  ******************************************************************************/
0241
0242 void
0243 AcpiNsCheckAcpiCompliance (
0244     char                        *Pathname,
0245     ACPI_NAMESPACE_NODE         *Node,
0246     const ACPI_PREDEFINED_INFO  *Predefined)
0247 {
0248     UINT32                      AmlParamCount;
0249     UINT32                      RequiredParamCount;
0250
0251
0252     if (!Predefined || (Node->Flags & ANOBJ_EVALUATED))
0253     {
0254         return;
0255     }
0256
0257     /* Get the ACPI-required arg count from the predefined info table */
0258
0259     RequiredParamCount =
0260         METHOD_GET_ARG_COUNT (Predefined->Info.ArgumentList);
0261
0262     /*
0263      * If this object is not a control method, we can check if the ACPI
0264      * spec requires that it be a method.
0265      */
0266     if (Node->Type != ACPI_TYPE_METHOD)
0267     {
0268         if (RequiredParamCount > 0)
0269         {
0270             /* Object requires args, must be implemented as a method */
0271
0272             ACPI_BIOS_ERROR_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS,
0273                 "Object (%s) must be a control method with %u arguments",
0274                 AcpiUtGetTypeName (Node->Type), RequiredParamCount));
0275         }
0276         else if (!RequiredParamCount && !Predefined->Info.ExpectedBtypes)
0277         {
0278             /* Object requires no args and no return value, must be a method */
0279
0280             ACPI_BIOS_ERROR_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS,
0281                 "Object (%s) must be a control method "
0282                 "with no arguments and no return value",
0283                 AcpiUtGetTypeName (Node->Type)));
0284         }
0285
0286         return;
0287     }
0288
0289     /*
0290      * This is a control method.
0291      * Check that the ASL/AML-defined parameter count for this method
0292      * matches the ACPI-required parameter count
0293      *
0294      * Some methods are allowed to have a "minimum" number of args (_SCP)
0295      * because their definition in ACPI has changed over time.
0296      *
0297      * Note: These are BIOS errors in the declaration of the object
0298      */
0299     AmlParamCount = Node->Object->Method.ParamCount;
0300
0301     if (AmlParamCount < RequiredParamCount)
0302     {
0303         ACPI_BIOS_ERROR_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS,
0304             "Insufficient arguments - "
0305             "ASL declared %u, ACPI requires %u",
0306             AmlParamCount, RequiredParamCount));
0307     }
0308     else if ((AmlParamCount > RequiredParamCount) &&
0309         !(Predefined->Info.ArgumentList & ARG_COUNT_IS_MINIMUM))
0310     {
0311         ACPI_BIOS_ERROR_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS,
0312             "Excess arguments - "
0313             "ASL declared %u, ACPI requires %u",
0314             AmlParamCount, RequiredParamCount));
0315     }
0316 }
0317
0318
0319 /*******************************************************************************
0320  *
0321  * FUNCTION:    AcpiNsCheckArgumentCount
0322  *
0323  * PARAMETERS:  Pathname        - Full pathname to the node (for error msgs)
0324  *              Node            - Namespace node for the method/object
0325  *              UserParamCount  - Number of args passed in by the caller
0326  *              Predefined      - Pointer to entry in predefined name table
0327  *
0328  * RETURN:      None
0329  *
0330  * DESCRIPTION: Check that incoming argument count matches the declared
0331  *              parameter count (in the ASL/AML) for an object.
0332  *
0333  ******************************************************************************/
0334
0335 void
0336 AcpiNsCheckArgumentCount (
0337     char                        *Pathname,
0338     ACPI_NAMESPACE_NODE         *Node,
0339     UINT32                      UserParamCount,
0340     const ACPI_PREDEFINED_INFO  *Predefined)
0341 {
0342     UINT32                      AmlParamCount;
0343     UINT32                      RequiredParamCount;
0344
0345
0346     if (Node->Flags & ANOBJ_EVALUATED)
0347     {
0348         return;
0349     }
0350
0351     if (!Predefined)
0352     {
0353         /*
0354          * Not a predefined name. Check the incoming user argument count
0355          * against the count that is specified in the method/object.
0356          */
0357         if (Node->Type != ACPI_TYPE_METHOD)
0358         {
0359             if (UserParamCount)
0360             {
0361                 ACPI_INFO_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS,
0362                     "%u arguments were passed to a non-method ACPI object (%s)",
0363                     UserParamCount, AcpiUtGetTypeName (Node->Type)));
0364             }
0365
0366             return;
0367         }
0368
0369         /*
0370          * This is a control method. Check the parameter count.
0371          * We can only check the incoming argument count against the
0372          * argument count declared for the method in the ASL/AML.
0373          *
0374          * Emit a message if too few or too many arguments have been passed
0375          * by the caller.
0376          *
0377          * Note: Too many arguments will not cause the method to
0378          * fail. However, the method will fail if there are too few
0379          * arguments and the method attempts to use one of the missing ones.
0380          */
0381         AmlParamCount = Node->Object->Method.ParamCount;
0382
0383         if (UserParamCount < AmlParamCount)
0384         {
0385             ACPI_WARN_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS,
0386                 "Insufficient arguments - "
0387                 "Caller passed %u, method requires %u",
0388                 UserParamCount, AmlParamCount));
0389         }
0390         else if (UserParamCount > AmlParamCount)
0391         {
0392             ACPI_INFO_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS,
0393                 "Excess arguments - "
0394                 "Caller passed %u, method requires %u",
0395                 UserParamCount, AmlParamCount));
0396         }
0397
0398         return;
0399     }
0400
0401     /*
0402      * This is a predefined name. Validate the user-supplied parameter
0403      * count against the ACPI specification. We don't validate against
0404      * the method itself because what is important here is that the
0405      * caller is in conformance with the spec. (The arg count for the
0406      * method was checked against the ACPI spec earlier.)
0407      *
0408      * Some methods are allowed to have a "minimum" number of args (_SCP)
0409      * because their definition in ACPI has changed over time.
0410      */
0411     RequiredParamCount =
0412         METHOD_GET_ARG_COUNT (Predefined->Info.ArgumentList);
0413
0414     if (UserParamCount < RequiredParamCount)
0415     {
0416         ACPI_WARN_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS,
0417             "Insufficient arguments - "
0418             "Caller passed %u, ACPI requires %u",
0419             UserParamCount, RequiredParamCount));
0420     }
0421     else if ((UserParamCount > RequiredParamCount) &&
0422         !(Predefined->Info.ArgumentList & ARG_COUNT_IS_MINIMUM))
0423     {
0424         ACPI_INFO_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS,
0425             "Excess arguments - "
0426             "Caller passed %u, ACPI requires %u",
0427             UserParamCount, RequiredParamCount));
0428     }
0429 }