FreeBSD/Linux Kernel Cross Reference
sys/contrib/dev/acpica/components/disassembler/dmresrc.c

     /*******************************************************************************
      *
      * Module Name: dmresrc.c - Resource Descriptor disassembly
      *
      ******************************************************************************/
     
     /******************************************************************************
      *
      * 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/amlcode.h>
   #include <contrib/dev/acpica/include/acdisasm.h>
   
   
   #define _COMPONENT          ACPI_CA_DEBUGGER
           ACPI_MODULE_NAME    ("dbresrc")
   
   
   /* Dispatch tables for Resource disassembly functions */
   
   static ACPI_RESOURCE_HANDLER    AcpiGbl_DmResourceDispatch [] =
   {
       /* Small descriptors */
   
       NULL,                           /* 0x00, Reserved */
       NULL,                           /* 0x01, Reserved */
       NULL,                           /* 0x02, Reserved */
       NULL,                           /* 0x03, Reserved */
       AcpiDmIrqDescriptor,            /* 0x04, ACPI_RESOURCE_NAME_IRQ_FORMAT */
       AcpiDmDmaDescriptor,            /* 0x05, ACPI_RESOURCE_NAME_DMA_FORMAT */
       AcpiDmStartDependentDescriptor, /* 0x06, ACPI_RESOURCE_NAME_START_DEPENDENT */
       AcpiDmEndDependentDescriptor,   /* 0x07, ACPI_RESOURCE_NAME_END_DEPENDENT */
       AcpiDmIoDescriptor,             /* 0x08, ACPI_RESOURCE_NAME_IO_PORT */
       AcpiDmFixedIoDescriptor,        /* 0x09, ACPI_RESOURCE_NAME_FIXED_IO_PORT */
       AcpiDmFixedDmaDescriptor,       /* 0x0A, ACPI_RESOURCE_NAME_FIXED_DMA */
       NULL,                           /* 0x0B, Reserved */
       NULL,                           /* 0x0C, Reserved */
       NULL,                           /* 0x0D, Reserved */
       AcpiDmVendorSmallDescriptor,    /* 0x0E, ACPI_RESOURCE_NAME_SMALL_VENDOR */
       NULL,                           /* 0x0F, ACPI_RESOURCE_NAME_END_TAG (not used) */
   
       /* Large descriptors */
   
       NULL,                           /* 0x00, Reserved */
       AcpiDmMemory24Descriptor,       /* 0x01, ACPI_RESOURCE_NAME_MEMORY_24 */
       AcpiDmGenericRegisterDescriptor,/* 0x02, ACPI_RESOURCE_NAME_GENERIC_REGISTER */
       NULL,                           /* 0x03, Reserved */
       AcpiDmVendorLargeDescriptor,    /* 0x04, ACPI_RESOURCE_NAME_LARGE_VENDOR */
       AcpiDmMemory32Descriptor,       /* 0x05, ACPI_RESOURCE_NAME_MEMORY_32 */
       AcpiDmFixedMemory32Descriptor,  /* 0x06, ACPI_RESOURCE_NAME_FIXED_MEMORY_32 */
       AcpiDmDwordDescriptor,          /* 0x07, ACPI_RESOURCE_NAME_DWORD_ADDRESS_SPACE */
       AcpiDmWordDescriptor,           /* 0x08, ACPI_RESOURCE_NAME_WORD_ADDRESS_SPACE */
       AcpiDmInterruptDescriptor,      /* 0x09, ACPI_RESOURCE_NAME_EXTENDED_XRUPT */
       AcpiDmQwordDescriptor,          /* 0x0A, ACPI_RESOURCE_NAME_QWORD_ADDRESS_SPACE */
       AcpiDmExtendedDescriptor,       /* 0x0B, ACPI_RESOURCE_NAME_EXTENDED_ADDRESS_SPACE */
       AcpiDmGpioDescriptor,           /* 0x0C, ACPI_RESOURCE_NAME_GPIO */
       AcpiDmPinFunctionDescriptor,    /* 0x0D, ACPI_RESOURCE_NAME_PIN_FUNCTION */
       AcpiDmSerialBusDescriptor,      /* 0x0E, ACPI_RESOURCE_NAME_SERIAL_BUS */
       AcpiDmPinConfigDescriptor,      /* 0x0F, ACPI_RESOURCE_NAME_PIN_CONFIG */
       AcpiDmPinGroupDescriptor,       /* 0x10, ACPI_RESOURCE_NAME_PIN_GROUP */
       AcpiDmPinGroupFunctionDescriptor, /* 0x11, ACPI_RESOURCE_NAME_PIN_GROUP_FUNCTION */
       AcpiDmPinGroupConfigDescriptor, /* 0x12, ACPI_RESOURCE_NAME_PIN_GROUP_CONFIG */
   };
   
   
   /* Only used for single-threaded applications */
   /* TBD: remove when name is passed as parameter to the dump functions */
   
   static UINT32               ResourceName;
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AcpiDmDescriptorName
    *
    * PARAMETERS:  None
    *
    * RETURN:      None
    *
    * DESCRIPTION: Emit a name for the descriptor if one is present (indicated
    *              by the name being changed from the default name.) A name is only
    *              emitted if a reference to the descriptor has been made somewhere
    *              in the original ASL code.
    *
    ******************************************************************************/
   
   void
   AcpiDmDescriptorName (
       void)
   {
   
       if (ResourceName == ACPI_DEFAULT_RESNAME)
       {
           return;
       }
   
       AcpiOsPrintf ("%4.4s", (char *) &ResourceName);
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AcpiDmDumpInteger*
    *
    * PARAMETERS:  Value               - Value to emit
    *              Name                - Associated name (emitted as a comment)
    *
    * RETURN:      None
    *
    * DESCRIPTION: Integer output helper functions
    *
    ******************************************************************************/
   
   void
   AcpiDmDumpInteger8 (
       UINT8                   Value,
       const char              *Name)
   {
       AcpiOsPrintf ("0x%2.2X,               // %s\n", Value, Name);
   }
   
   void
   AcpiDmDumpInteger16 (
       UINT16                  Value,
       const char              *Name)
   {
       AcpiOsPrintf ("0x%4.4X,             // %s\n", Value, Name);
   }
   
   void
   AcpiDmDumpInteger32 (
       UINT32                  Value,
       const char              *Name)
   {
       AcpiOsPrintf ("0x%8.8X,         // %s\n", Value, Name);
   }
   
   void
   AcpiDmDumpInteger64 (
       UINT64                  Value,
       const char              *Name)
   {
       AcpiOsPrintf ("0x%8.8X%8.8X, // %s\n", ACPI_FORMAT_UINT64 (Value), Name);
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AcpiDmBitList
    *
    * PARAMETERS:  Mask            - 16-bit value corresponding to 16 interrupt
    *                                or DMA values
    *
    * RETURN:      None
    *
    * DESCRIPTION: Dump a bit mask as a list of individual interrupt/DMA levels.
    *
    ******************************************************************************/
   
   void
   AcpiDmBitList (
       UINT16                  Mask)
   {
       UINT32                  i;
       BOOLEAN                 Previous = FALSE;
   
   
       /* Open the initializer list */
   
       AcpiOsPrintf ("{");
   
       /* Examine each bit */
   
       for (i = 0; i < 16; i++)
       {
           /* Only interested in bits that are set to 1 */
   
           if (Mask & 1)
           {
               if (Previous)
               {
                   AcpiOsPrintf (",");
               }
   
               Previous = TRUE;
               AcpiOsPrintf ("%u", i);
           }
   
           Mask >>= 1;
       }
   
       /* Close list */
   
       AcpiOsPrintf ("}\n");
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AcpiDmResourceTemplate
    *
    * PARAMETERS:  Info            - Current parse tree walk info
    *              ByteData        - Pointer to the byte list data
    *              ByteCount       - Length of the byte list
    *
    * RETURN:      None
    *
    * DESCRIPTION: Dump the contents of a Resource Template containing a set of
    *              Resource Descriptors.
    *
    ******************************************************************************/
   
   void
   AcpiDmResourceTemplate (
       ACPI_OP_WALK_INFO       *Info,
       ACPI_PARSE_OBJECT       *Op,
       UINT8                   *ByteData,
       UINT32                  ByteCount)
   {
       ACPI_STATUS             Status;
       UINT32                  CurrentByteOffset;
       UINT8                   ResourceType;
       UINT32                  ResourceLength;
       void                    *Aml;
       UINT32                  Level;
       BOOLEAN                 DependentFns = FALSE;
       UINT8                   ResourceIndex;
       ACPI_NAMESPACE_NODE     *Node;
   
   
       if (Op->Asl.AmlOpcode != AML_FIELD_OP)
       {
           Info->MappingOp = Op;
       }
   
       Level = Info->Level;
       ResourceName = ACPI_DEFAULT_RESNAME;
       Node = Op->Common.Node;
       if (Node)
       {
           Node = Node->Child;
       }
   
       for (CurrentByteOffset = 0; CurrentByteOffset < ByteCount;)
       {
           Aml = &ByteData[CurrentByteOffset];
   
           /* Get the descriptor type and length */
   
           ResourceType = AcpiUtGetResourceType (Aml);
           ResourceLength = AcpiUtGetResourceLength (Aml);
   
           /* Validate the Resource Type and Resource Length */
   
           Status = AcpiUtValidateResource (NULL, Aml, &ResourceIndex);
           if (ACPI_FAILURE (Status))
           {
               AcpiOsPrintf (
                   "/*** Could not validate Resource, type (%X) %s***/\n",
                   ResourceType, AcpiFormatException (Status));
               return;
           }
   
           /* Point to next descriptor */
   
           CurrentByteOffset += AcpiUtGetDescriptorLength (Aml);
   
           /* Descriptor pre-processing */
   
           switch (ResourceType)
           {
           case ACPI_RESOURCE_NAME_START_DEPENDENT:
   
               /* Finish a previous StartDependentFns */
   
               if (DependentFns)
               {
                   Level--;
                   AcpiDmIndent (Level);
                   AcpiOsPrintf ("}\n");
               }
               break;
   
           case ACPI_RESOURCE_NAME_END_DEPENDENT:
   
               Level--;
               DependentFns = FALSE;
               break;
   
           case ACPI_RESOURCE_NAME_END_TAG:
   
               /* Normal exit, the resource list is finished */
   
               if (DependentFns)
               {
                   /*
                    * Close an open StartDependentDescriptor. This indicates a
                    * missing EndDependentDescriptor.
                    */
                   Level--;
   
                   /* Go ahead and insert EndDependentFn() */
   
                   AcpiDmEndDependentDescriptor (Info, Aml, ResourceLength, Level);
   
                   AcpiDmIndent (Level);
                   AcpiOsPrintf (
                       "/*** Disassembler: inserted "
                       "missing EndDependentFn () ***/\n");
               }
               return;
   
           default:
   
               break;
           }
   
           /* Disassemble the resource structure */
   
           if (Node)
           {
               ResourceName = Node->Name.Integer;
               Node = Node->Peer;
           }
   
           AcpiGbl_DmResourceDispatch [ResourceIndex] (
               Info, Aml, ResourceLength, Level);
   
           /* Descriptor post-processing */
   
           if (ResourceType == ACPI_RESOURCE_NAME_START_DEPENDENT)
           {
               DependentFns = TRUE;
               Level++;
           }
       }
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AcpiDmIsResourceTemplate
    *
    * PARAMETERS:  WalkState           - Current walk info
    *              Op                  - Buffer Op to be examined
    *
    * RETURN:      Status. AE_OK if valid template
    *
    * DESCRIPTION: Walk a byte list to determine if it consists of a valid set
    *              of resource descriptors. Nothing is output.
    *
    ******************************************************************************/
   
   ACPI_STATUS
   AcpiDmIsResourceTemplate (
       ACPI_WALK_STATE         *WalkState,
       ACPI_PARSE_OBJECT       *Op)
   {
       ACPI_STATUS             Status;
       ACPI_PARSE_OBJECT       *NextOp;
       UINT8                   *Aml;
       UINT8                   *EndAml;
       UINT32                  BufferLength;
       UINT32                  DeclaredBufferLength;
   
   
       /* This op must be a buffer */
   
       if (Op->Common.AmlOpcode != AML_BUFFER_OP)
       {
           return (AE_TYPE);
       }
   
       /*
        * Get the declared length of the buffer.
        * This is the nn in "Buffer (nn)"
        */
       NextOp = Op->Common.Value.Arg;
       if (!NextOp)
       {
           AcpiOsPrintf ("NULL byte list in buffer\n");
           return (AE_TYPE);
       }
   
       DeclaredBufferLength = NextOp->Common.Value.Size;
   
       /* Get the length of the raw initialization byte list */
   
       NextOp = NextOp->Common.Next;
       if (!NextOp)
       {
           return (AE_TYPE);
       }
   
       Aml = NextOp->Named.Data;
       BufferLength = NextOp->Common.Value.Size;
   
       /*
        * Any buffer smaller than one byte cannot possibly be a resource
        * template. Two bytes could possibly be a "NULL" resource template
        * with a lone end tag descriptor (as generated via
        * "ResourceTemplate(){}"), but this would be an extremely unusual
        * case, as the template would be essentially useless. The disassembler
        * therefore does not recognize any two-byte buffer as a resource
        * template.
        */
       if (BufferLength <= 2)
       {
           return (AE_TYPE);
       }
   
       /*
        * Not a template if declared buffer length != actual length of the
        * initialization byte list. Because the resource macros will create
        * a buffer of the exact required length (buffer length will be equal
        * to the actual length).
        *
        * NOTE (April 2017): Resource templates with this issue have been
        * seen in the field. We still don't want to attempt to disassemble
        * a buffer like this to a resource template because this output
        * would not match the original input buffer (it would be shorter
        * than the original when the disassembled code is recompiled).
        * Basically, a buffer like this appears to be hand crafted in the
        * first place, so just emitting a buffer object instead of a
        * resource template more closely resembles the original ASL code.
        */
       if (DeclaredBufferLength != BufferLength)
       {
           return (AE_TYPE);
       }
   
       /* Walk the byte list, abort on any invalid descriptor type or length */
   
       Status = AcpiUtWalkAmlResources (WalkState, Aml, BufferLength,
           NULL, ACPI_CAST_INDIRECT_PTR (void, &EndAml));
       if (ACPI_FAILURE (Status))
       {
           return (AE_TYPE);
       }
   
       /*
        * For the resource template to be valid, one EndTag must appear
        * at the very end of the ByteList, not before. (For proper disassembly
        * of a ResourceTemplate, the buffer must not have any extra data after
        * the EndTag.)
        */
       if ((Aml + BufferLength - sizeof (AML_RESOURCE_END_TAG)) != EndAml)
       {
           return (AE_AML_NO_RESOURCE_END_TAG);
       }
   
       /*
        * All resource descriptors are valid, therefore this list appears
        * to be a valid resource template
        */
       return (AE_OK);
   }

Cache object: 12fc7597a479beaee563b57c85b351e3