FreeBSD/Linux Kernel Cross Reference
sys/contrib/dev/acpica/components/namespace/nsarguments.c

     /******************************************************************************
      *
      * Module Name: nsarguments - Validation of args for ACPI predefined methods
      *
      *****************************************************************************/
     
     /******************************************************************************
      *
      * 1. Copyright Notice
     *
     * Some or all of this work - Copyright (c) 1999 - 2022, Intel Corp.
     * All rights reserved.
     *
     * 2. License
     *
     * 2.1. This is your license from Intel Corp. under its intellectual property
     * rights. You may have additional license terms from the party that provided
     * you this software, covering your right to use that party's intellectual
     * property rights.
     *
     * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
     * copy of the source code appearing in this file ("Covered Code") an
     * irrevocable, perpetual, worldwide license under Intel's copyrights in the
     * base code distributed originally by Intel ("Original Intel Code") to copy,
     * make derivatives, distribute, use and display any portion of the Covered
     * Code in any form, with the right to sublicense such rights; and
     *
     * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
     * license (with the right to sublicense), under only those claims of Intel
     * patents that are infringed by the Original Intel Code, to make, use, sell,
     * offer to sell, and import the Covered Code and derivative works thereof
     * solely to the minimum extent necessary to exercise the above copyright
     * license, and in no event shall the patent license extend to any additions
     * to or modifications of the Original Intel Code. No other license or right
     * is granted directly or by implication, estoppel or otherwise;
     *
     * The above copyright and patent license is granted only if the following
     * conditions are met:
     *
     * 3. Conditions
     *
     * 3.1. Redistribution of Source with Rights to Further Distribute Source.
     * Redistribution of source code of any substantial portion of the Covered
     * Code or modification with rights to further distribute source must include
     * the above Copyright Notice, the above License, this list of Conditions,
     * and the following Disclaimer and Export Compliance provision. In addition,
     * Licensee must cause all Covered Code to which Licensee contributes to
     * contain a file documenting the changes Licensee made to create that Covered
     * Code and the date of any change. Licensee must include in that file the
     * documentation of any changes made by any predecessor Licensee. Licensee
     * must include a prominent statement that the modification is derived,
     * directly or indirectly, from Original Intel Code.
     *
     * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
     * Redistribution of source code of any substantial portion of the Covered
     * Code or modification without rights to further distribute source must
     * include the following Disclaimer and Export Compliance provision in the
     * documentation and/or other materials provided with distribution. In
     * addition, Licensee may not authorize further sublicense of source of any
     * portion of the Covered Code, and must include terms to the effect that the
     * license from Licensee to its licensee is limited to the intellectual
     * property embodied in the software Licensee provides to its licensee, and
     * not to intellectual property embodied in modifications its licensee may
     * make.
     *
     * 3.3. Redistribution of Executable. Redistribution in executable form of any
     * substantial portion of the Covered Code or modification must reproduce the
     * above Copyright Notice, and the following Disclaimer and Export Compliance
     * provision in the documentation and/or other materials provided with the
     * distribution.
     *
     * 3.4. Intel retains all right, title, and interest in and to the Original
     * Intel Code.
     *
     * 3.5. Neither the name Intel nor any other trademark owned or controlled by
     * Intel shall be used in advertising or otherwise to promote the sale, use or
     * other dealings in products derived from or relating to the Covered Code
     * without prior written authorization from Intel.
     *
     * 4. Disclaimer and Export Compliance
     *
     * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
     * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
     * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
     * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
     * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
     * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
     * PARTICULAR PURPOSE.
     *
     * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
     * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
     * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
     * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
     * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
     * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
     * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
     * LIMITED REMEDY.
     *
     * 4.3. Licensee shall not export, either directly or indirectly, any of this
    * software or system incorporating such software without first obtaining any
    * required license or other approval from the U. S. Department of Commerce or
    * any other agency or department of the United States Government. In the
    * event Licensee exports any such software from the United States or
    * re-exports any such software from a foreign destination, Licensee shall
    * ensure that the distribution and export/re-export of the software is in
    * compliance with all laws, regulations, orders, or other restrictions of the
    * U.S. Export Administration Regulations. Licensee agrees that neither it nor
    * any of its subsidiaries will export/re-export any technical data, process,
    * software, or service, directly or indirectly, to any country for which the
    * United States government or any agency thereof requires an export license,
    * other governmental approval, or letter of assurance, without first obtaining
    * such license, approval or letter.
    *
    *****************************************************************************
    *
    * Alternatively, you may choose to be licensed under the terms of the
    * following license:
    *
    * Redistribution and use in source and binary forms, with or without
    * modification, are permitted provided that the following conditions
    * are met:
    * 1. Redistributions of source code must retain the above copyright
    *    notice, this list of conditions, and the following disclaimer,
    *    without modification.
    * 2. Redistributions in binary form must reproduce at minimum a disclaimer
    *    substantially similar to the "NO WARRANTY" disclaimer below
    *    ("Disclaimer") and any redistribution must be conditioned upon
    *    including a substantially similar Disclaimer requirement for further
    *    binary redistribution.
    * 3. Neither the names of the above-listed copyright holders nor the names
    *    of any contributors may be used to endorse or promote products derived
    *    from this software without specific prior written permission.
    *
    * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
    * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
    * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
    * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
    * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
    * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
    * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
    * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
    * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
    * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    *
    * Alternatively, you may choose to be licensed under the terms of the
    * GNU General Public License ("GPL") version 2 as published by the Free
    * Software Foundation.
    *
    *****************************************************************************/
   
   #include <contrib/dev/acpica/include/acpi.h>
   #include <contrib/dev/acpica/include/accommon.h>
   #include <contrib/dev/acpica/include/acnamesp.h>
   #include <contrib/dev/acpica/include/acpredef.h>
   
   
   #define _COMPONENT          ACPI_NAMESPACE
           ACPI_MODULE_NAME    ("nsarguments")
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AcpiNsCheckArgumentTypes
    *
    * PARAMETERS:  Info            - Method execution information block
    *
    * RETURN:      None
    *
    * DESCRIPTION: Check the incoming argument count and all argument types
    *              against the argument type list for a predefined name.
    *
    ******************************************************************************/
   
   void
   AcpiNsCheckArgumentTypes (
       ACPI_EVALUATE_INFO          *Info)
   {
       UINT16                      ArgTypeList;
       UINT8                       ArgCount;
       UINT8                       ArgType;
       UINT8                       UserArgType;
       UINT32                      i;
   
   
       /*
        * If not a predefined name, cannot typecheck args, because
        * we have no idea what argument types are expected.
        * Also, ignore typecheck if warnings/errors if this method
        * has already been evaluated at least once -- in order
        * to suppress repetitive messages.
        */
       if (!Info->Predefined || (Info->Node->Flags & ANOBJ_EVALUATED))
       {
           return;
       }
   
       ArgTypeList = Info->Predefined->Info.ArgumentList;
       ArgCount = METHOD_GET_ARG_COUNT (ArgTypeList);
   
       /* Typecheck all arguments */
   
       for (i = 0; ((i < ArgCount) && (i < Info->ParamCount)); i++)
       {
           ArgType = METHOD_GET_NEXT_TYPE (ArgTypeList);
           UserArgType = Info->Parameters[i]->Common.Type;
   
           /* No typechecking for ACPI_TYPE_ANY */
   
           if ((UserArgType != ArgType) && (ArgType != ACPI_TYPE_ANY))
           {
               ACPI_WARN_PREDEFINED ((AE_INFO, Info->FullPathname, ACPI_WARN_ALWAYS,
                   "Argument #%u type mismatch - "
                   "Found [%s], ACPI requires [%s]", (i + 1),
                   AcpiUtGetTypeName (UserArgType),
                   AcpiUtGetTypeName (ArgType)));
   
               /* Prevent any additional typechecking for this method */
   
               Info->Node->Flags |= ANOBJ_EVALUATED;
           }
       }
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AcpiNsCheckAcpiCompliance
    *
    * PARAMETERS:  Pathname        - Full pathname to the node (for error msgs)
    *              Node            - Namespace node for the method/object
    *              Predefined      - Pointer to entry in predefined name table
    *
    * RETURN:      None
    *
    * DESCRIPTION: Check that the declared parameter count (in ASL/AML) for a
    *              predefined name is what is expected (matches what is defined in
    *              the ACPI specification for this predefined name.)
    *
    ******************************************************************************/
   
   void
   AcpiNsCheckAcpiCompliance (
       char                        *Pathname,
       ACPI_NAMESPACE_NODE         *Node,
       const ACPI_PREDEFINED_INFO  *Predefined)
   {
       UINT32                      AmlParamCount;
       UINT32                      RequiredParamCount;
   
   
       if (!Predefined || (Node->Flags & ANOBJ_EVALUATED))
       {
           return;
       }
   
       /* Get the ACPI-required arg count from the predefined info table */
   
       RequiredParamCount =
           METHOD_GET_ARG_COUNT (Predefined->Info.ArgumentList);
   
       /*
        * If this object is not a control method, we can check if the ACPI
        * spec requires that it be a method.
        */
       if (Node->Type != ACPI_TYPE_METHOD)
       {
           if (RequiredParamCount > 0)
           {
               /* Object requires args, must be implemented as a method */
   
               ACPI_BIOS_ERROR_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS,
                   "Object (%s) must be a control method with %u arguments",
                   AcpiUtGetTypeName (Node->Type), RequiredParamCount));
           }
           else if (!RequiredParamCount && !Predefined->Info.ExpectedBtypes)
           {
               /* Object requires no args and no return value, must be a method */
   
               ACPI_BIOS_ERROR_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS,
                   "Object (%s) must be a control method "
                   "with no arguments and no return value",
                   AcpiUtGetTypeName (Node->Type)));
           }
   
           return;
       }
   
       /*
        * This is a control method.
        * Check that the ASL/AML-defined parameter count for this method
        * matches the ACPI-required parameter count
        *
        * Some methods are allowed to have a "minimum" number of args (_SCP)
        * because their definition in ACPI has changed over time.
        *
        * Note: These are BIOS errors in the declaration of the object
        */
       AmlParamCount = Node->Object->Method.ParamCount;
   
       if (AmlParamCount < RequiredParamCount)
       {
           ACPI_BIOS_ERROR_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS,
               "Insufficient arguments - "
               "ASL declared %u, ACPI requires %u",
               AmlParamCount, RequiredParamCount));
       }
       else if ((AmlParamCount > RequiredParamCount) &&
           !(Predefined->Info.ArgumentList & ARG_COUNT_IS_MINIMUM))
       {
           ACPI_BIOS_ERROR_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS,
               "Excess arguments - "
               "ASL declared %u, ACPI requires %u",
               AmlParamCount, RequiredParamCount));
       }
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AcpiNsCheckArgumentCount
    *
    * PARAMETERS:  Pathname        - Full pathname to the node (for error msgs)
    *              Node            - Namespace node for the method/object
    *              UserParamCount  - Number of args passed in by the caller
    *              Predefined      - Pointer to entry in predefined name table
    *
    * RETURN:      None
    *
    * DESCRIPTION: Check that incoming argument count matches the declared
    *              parameter count (in the ASL/AML) for an object.
    *
    ******************************************************************************/
   
   void
   AcpiNsCheckArgumentCount (
       char                        *Pathname,
       ACPI_NAMESPACE_NODE         *Node,
       UINT32                      UserParamCount,
       const ACPI_PREDEFINED_INFO  *Predefined)
   {
       UINT32                      AmlParamCount;
       UINT32                      RequiredParamCount;
   
   
       if (Node->Flags & ANOBJ_EVALUATED)
       {
           return;
       }
   
       if (!Predefined)
       {
           /*
            * Not a predefined name. Check the incoming user argument count
            * against the count that is specified in the method/object.
            */
           if (Node->Type != ACPI_TYPE_METHOD)
           {
               if (UserParamCount)
               {
                   ACPI_INFO_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS,
                       "%u arguments were passed to a non-method ACPI object (%s)",
                       UserParamCount, AcpiUtGetTypeName (Node->Type)));
               }
   
               return;
           }
   
           /*
            * This is a control method. Check the parameter count.
            * We can only check the incoming argument count against the
            * argument count declared for the method in the ASL/AML.
            *
            * Emit a message if too few or too many arguments have been passed
            * by the caller.
            *
            * Note: Too many arguments will not cause the method to
            * fail. However, the method will fail if there are too few
            * arguments and the method attempts to use one of the missing ones.
            */
           AmlParamCount = Node->Object->Method.ParamCount;
   
           if (UserParamCount < AmlParamCount)
           {
               ACPI_WARN_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS,
                   "Insufficient arguments - "
                   "Caller passed %u, method requires %u",
                   UserParamCount, AmlParamCount));
           }
           else if (UserParamCount > AmlParamCount)
           {
               ACPI_INFO_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS,
                   "Excess arguments - "
                   "Caller passed %u, method requires %u",
                   UserParamCount, AmlParamCount));
           }
   
           return;
       }
   
       /*
        * This is a predefined name. Validate the user-supplied parameter
        * count against the ACPI specification. We don't validate against
        * the method itself because what is important here is that the
        * caller is in conformance with the spec. (The arg count for the
        * method was checked against the ACPI spec earlier.)
        *
        * Some methods are allowed to have a "minimum" number of args (_SCP)
        * because their definition in ACPI has changed over time.
        */
       RequiredParamCount =
           METHOD_GET_ARG_COUNT (Predefined->Info.ArgumentList);
   
       if (UserParamCount < RequiredParamCount)
       {
           ACPI_WARN_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS,
               "Insufficient arguments - "
               "Caller passed %u, ACPI requires %u",
               UserParamCount, RequiredParamCount));
       }
       else if ((UserParamCount > RequiredParamCount) &&
           !(Predefined->Info.ArgumentList & ARG_COUNT_IS_MINIMUM))
       {
           ACPI_INFO_PREDEFINED ((AE_INFO, Pathname, ACPI_WARN_ALWAYS,
               "Excess arguments - "
               "Caller passed %u, ACPI requires %u",
               UserParamCount, RequiredParamCount));
       }
   }

Cache object: 56418e0bcd941105ad56d1e67c6e00ba