FreeBSD/Linux Kernel Cross Reference
sys/contrib/dev/acpica/components/dispatcher/dsargs.c

     /******************************************************************************
      *
      * Module Name: dsargs - Support for execution of dynamic arguments for static
      *                       objects (regions, fields, buffer fields, etc.)
      *
      *****************************************************************************/
     
     /******************************************************************************
      *
     * 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/acparser.h>
   #include <contrib/dev/acpica/include/amlcode.h>
   #include <contrib/dev/acpica/include/acdispat.h>
   #include <contrib/dev/acpica/include/acnamesp.h>
   
   #define _COMPONENT          ACPI_DISPATCHER
           ACPI_MODULE_NAME    ("dsargs")
   
   /* Local prototypes */
   
   static ACPI_STATUS
   AcpiDsExecuteArguments (
       ACPI_NAMESPACE_NODE     *Node,
       ACPI_NAMESPACE_NODE     *ScopeNode,
       UINT32                  AmlLength,
       UINT8                   *AmlStart);
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AcpiDsExecuteArguments
    *
    * PARAMETERS:  Node                - Object NS node
    *              ScopeNode           - Parent NS node
    *              AmlLength           - Length of executable AML
    *              AmlStart            - Pointer to the AML
    *
    * RETURN:      Status.
    *
    * DESCRIPTION: Late (deferred) execution of region or field arguments
    *
    ******************************************************************************/
   
   static ACPI_STATUS
   AcpiDsExecuteArguments (
       ACPI_NAMESPACE_NODE     *Node,
       ACPI_NAMESPACE_NODE     *ScopeNode,
       UINT32                  AmlLength,
       UINT8                   *AmlStart)
   {
       ACPI_STATUS             Status;
       ACPI_PARSE_OBJECT       *Op;
       ACPI_WALK_STATE         *WalkState;
   
   
       ACPI_FUNCTION_TRACE_PTR (DsExecuteArguments, AmlStart);
   
   
       /* Allocate a new parser op to be the root of the parsed tree */
   
       Op = AcpiPsAllocOp (AML_INT_EVAL_SUBTREE_OP, AmlStart);
       if (!Op)
       {
           return_ACPI_STATUS (AE_NO_MEMORY);
       }
   
       /* Save the Node for use in AcpiPsParseAml */
   
       Op->Common.Node = ScopeNode;
   
       /* Create and initialize a new parser state */
   
       WalkState = AcpiDsCreateWalkState (0, NULL, NULL, NULL);
       if (!WalkState)
       {
           Status = AE_NO_MEMORY;
           goto Cleanup;
       }
   
       Status = AcpiDsInitAmlWalk (WalkState, Op, NULL, AmlStart,
           AmlLength, NULL, ACPI_IMODE_LOAD_PASS1);
       if (ACPI_FAILURE (Status))
       {
           AcpiDsDeleteWalkState (WalkState);
           goto Cleanup;
       }
   
       /* Mark this parse as a deferred opcode */
   
       WalkState->ParseFlags = ACPI_PARSE_DEFERRED_OP;
       WalkState->DeferredNode = Node;
   
       /* Pass1: Parse the entire declaration */
   
       Status = AcpiPsParseAml (WalkState);
       if (ACPI_FAILURE (Status))
       {
           goto Cleanup;
       }
   
       /* Get and init the Op created above */
   
       Op->Common.Node = Node;
       AcpiPsDeleteParseTree (Op);
   
       /* Evaluate the deferred arguments */
   
       Op = AcpiPsAllocOp (AML_INT_EVAL_SUBTREE_OP, AmlStart);
       if (!Op)
       {
           return_ACPI_STATUS (AE_NO_MEMORY);
       }
   
       Op->Common.Node = ScopeNode;
   
       /* Create and initialize a new parser state */
   
       WalkState = AcpiDsCreateWalkState (0, NULL, NULL, NULL);
       if (!WalkState)
       {
           Status = AE_NO_MEMORY;
           goto Cleanup;
       }
   
       /* Execute the opcode and arguments */
   
       Status = AcpiDsInitAmlWalk (WalkState, Op, NULL, AmlStart,
           AmlLength, NULL, ACPI_IMODE_EXECUTE);
       if (ACPI_FAILURE (Status))
       {
           AcpiDsDeleteWalkState (WalkState);
           goto Cleanup;
       }
   
       /* Mark this execution as a deferred opcode */
   
       WalkState->DeferredNode = Node;
       Status = AcpiPsParseAml (WalkState);
   
   Cleanup:
       AcpiPsDeleteParseTree (Op);
       return_ACPI_STATUS (Status);
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AcpiDsGetBufferFieldArguments
    *
    * PARAMETERS:  ObjDesc         - A valid BufferField object
    *
    * RETURN:      Status.
    *
    * DESCRIPTION: Get BufferField Buffer and Index. This implements the late
    *              evaluation of these field attributes.
    *
    ******************************************************************************/
   
   ACPI_STATUS
   AcpiDsGetBufferFieldArguments (
       ACPI_OPERAND_OBJECT     *ObjDesc)
   {
       ACPI_OPERAND_OBJECT     *ExtraDesc;
       ACPI_NAMESPACE_NODE     *Node;
       ACPI_STATUS             Status;
   
   
       ACPI_FUNCTION_TRACE_PTR (DsGetBufferFieldArguments, ObjDesc);
   
   
       if (ObjDesc->Common.Flags & AOPOBJ_DATA_VALID)
       {
           return_ACPI_STATUS (AE_OK);
       }
   
       /* Get the AML pointer (method object) and BufferField node */
   
       ExtraDesc = AcpiNsGetSecondaryObject (ObjDesc);
       Node = ObjDesc->BufferField.Node;
   
       ACPI_DEBUG_EXEC (AcpiUtDisplayInitPathname (
           ACPI_TYPE_BUFFER_FIELD, Node, NULL));
   
       ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "[%4.4s] BufferField Arg Init\n",
           AcpiUtGetNodeName (Node)));
   
       /* Execute the AML code for the TermArg arguments */
   
       Status = AcpiDsExecuteArguments (Node, Node->Parent,
           ExtraDesc->Extra.AmlLength, ExtraDesc->Extra.AmlStart);
       return_ACPI_STATUS (Status);
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AcpiDsGetBankFieldArguments
    *
    * PARAMETERS:  ObjDesc         - A valid BankField object
    *
    * RETURN:      Status.
    *
    * DESCRIPTION: Get BankField BankValue. This implements the late
    *              evaluation of these field attributes.
    *
    ******************************************************************************/
   
   ACPI_STATUS
   AcpiDsGetBankFieldArguments (
       ACPI_OPERAND_OBJECT     *ObjDesc)
   {
       ACPI_OPERAND_OBJECT     *ExtraDesc;
       ACPI_NAMESPACE_NODE     *Node;
       ACPI_STATUS             Status;
   
   
       ACPI_FUNCTION_TRACE_PTR (DsGetBankFieldArguments, ObjDesc);
   
   
       if (ObjDesc->Common.Flags & AOPOBJ_DATA_VALID)
       {
           return_ACPI_STATUS (AE_OK);
       }
   
       /* Get the AML pointer (method object) and BankField node */
   
       ExtraDesc = AcpiNsGetSecondaryObject (ObjDesc);
       Node = ObjDesc->BankField.Node;
   
       ACPI_DEBUG_EXEC (AcpiUtDisplayInitPathname (
           ACPI_TYPE_LOCAL_BANK_FIELD, Node, NULL));
   
       ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "[%4.4s] BankField Arg Init\n",
           AcpiUtGetNodeName (Node)));
   
       /* Execute the AML code for the TermArg arguments */
   
       Status = AcpiDsExecuteArguments (Node, Node->Parent,
           ExtraDesc->Extra.AmlLength, ExtraDesc->Extra.AmlStart);
       return_ACPI_STATUS (Status);
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AcpiDsGetBufferArguments
    *
    * PARAMETERS:  ObjDesc         - A valid Buffer object
    *
    * RETURN:      Status.
    *
    * DESCRIPTION: Get Buffer length and initializer byte list. This implements
    *              the late evaluation of these attributes.
    *
    ******************************************************************************/
   
   ACPI_STATUS
   AcpiDsGetBufferArguments (
       ACPI_OPERAND_OBJECT     *ObjDesc)
   {
       ACPI_NAMESPACE_NODE     *Node;
       ACPI_STATUS             Status;
   
   
       ACPI_FUNCTION_TRACE_PTR (DsGetBufferArguments, ObjDesc);
   
   
       if (ObjDesc->Common.Flags & AOPOBJ_DATA_VALID)
       {
           return_ACPI_STATUS (AE_OK);
       }
   
       /* Get the Buffer node */
   
       Node = ObjDesc->Buffer.Node;
       if (!Node)
       {
           ACPI_ERROR ((AE_INFO,
               "No pointer back to namespace node in buffer object %p",
               ObjDesc));
           return_ACPI_STATUS (AE_AML_INTERNAL);
       }
   
       ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Buffer Arg Init\n"));
   
       /* Execute the AML code for the TermArg arguments */
   
       Status = AcpiDsExecuteArguments (Node, Node,
           ObjDesc->Buffer.AmlLength, ObjDesc->Buffer.AmlStart);
       return_ACPI_STATUS (Status);
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AcpiDsGetPackageArguments
    *
    * PARAMETERS:  ObjDesc         - A valid Package object
    *
    * RETURN:      Status.
    *
    * DESCRIPTION: Get Package length and initializer byte list. This implements
    *              the late evaluation of these attributes.
    *
    ******************************************************************************/
   
   ACPI_STATUS
   AcpiDsGetPackageArguments (
       ACPI_OPERAND_OBJECT     *ObjDesc)
   {
       ACPI_NAMESPACE_NODE     *Node;
       ACPI_STATUS             Status;
   
   
       ACPI_FUNCTION_TRACE_PTR (DsGetPackageArguments, ObjDesc);
   
   
       if (ObjDesc->Common.Flags & AOPOBJ_DATA_VALID)
       {
           return_ACPI_STATUS (AE_OK);
       }
   
       /* Get the Package node */
   
       Node = ObjDesc->Package.Node;
       if (!Node)
       {
           ACPI_ERROR ((AE_INFO,
               "No pointer back to namespace node in package %p", ObjDesc));
           return_ACPI_STATUS (AE_AML_INTERNAL);
       }
   
       ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Package Argument Init, AML Ptr: %p\n",
           ObjDesc->Package.AmlStart));
   
       /* Execute the AML code for the TermArg arguments */
   
       Status = AcpiDsExecuteArguments (Node, Node,
           ObjDesc->Package.AmlLength, ObjDesc->Package.AmlStart);
   
       return_ACPI_STATUS (Status);
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AcpiDsGetRegionArguments
    *
    * PARAMETERS:  ObjDesc         - A valid region object
    *
    * RETURN:      Status.
    *
    * DESCRIPTION: Get region address and length. This implements the late
    *              evaluation of these region attributes.
    *
    ******************************************************************************/
   
   ACPI_STATUS
   AcpiDsGetRegionArguments (
       ACPI_OPERAND_OBJECT     *ObjDesc)
   {
       ACPI_NAMESPACE_NODE     *Node;
       ACPI_STATUS             Status;
       ACPI_OPERAND_OBJECT     *ExtraDesc;
   
   
       ACPI_FUNCTION_TRACE_PTR (DsGetRegionArguments, ObjDesc);
   
   
       if (ObjDesc->Region.Flags & AOPOBJ_DATA_VALID)
       {
           return_ACPI_STATUS (AE_OK);
       }
   
       ExtraDesc = AcpiNsGetSecondaryObject (ObjDesc);
       if (!ExtraDesc)
       {
           return_ACPI_STATUS (AE_NOT_EXIST);
       }
   
       /* Get the Region node */
   
       Node = ObjDesc->Region.Node;
   
       ACPI_DEBUG_EXEC (AcpiUtDisplayInitPathname (
           ACPI_TYPE_REGION, Node, NULL));
   
       ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
           "[%4.4s] OpRegion Arg Init at AML %p\n",
           AcpiUtGetNodeName (Node), ExtraDesc->Extra.AmlStart));
   
       /* Execute the argument AML */
   
       Status = AcpiDsExecuteArguments (Node, ExtraDesc->Extra.ScopeNode,
           ExtraDesc->Extra.AmlLength, ExtraDesc->Extra.AmlStart);
       if (ACPI_FAILURE (Status))
       {
           return_ACPI_STATUS (Status);
       }
   
       Status = AcpiUtAddAddressRange (ObjDesc->Region.SpaceId,
           ObjDesc->Region.Address, ObjDesc->Region.Length, Node);
       return_ACPI_STATUS (Status);
   }

Cache object: e989cb8046e9d15cdfc72503750b59a1