FreeBSD/Linux Kernel Cross Reference
sys/contrib/dev/acpica/common/dmtables.c

     /******************************************************************************
      *
      * Module Name: dmtables - disassembler ACPI table support
      *
      *****************************************************************************/
     
     /******************************************************************************
      *
      * 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/compiler/aslcompiler.h>
   #include <contrib/dev/acpica/include/acdispat.h>
   #include <contrib/dev/acpica/include/acnamesp.h>
   #include <contrib/dev/acpica/include/actables.h>
   #include <contrib/dev/acpica/include/acparser.h>
   #include <contrib/dev/acpica/include/acapps.h>
   #include <contrib/dev/acpica/include/acmacros.h>
   #include <contrib/dev/acpica/include/acconvert.h>
   
   
   #define _COMPONENT          ACPI_TOOLS
           ACPI_MODULE_NAME    ("dmtables")
   
   
   /* Local prototypes */
   
   static void
   AdCreateTableHeader (
       char                    *Filename,
       ACPI_TABLE_HEADER       *Table);
   
   static ACPI_STATUS
   AdStoreTable (
       ACPI_TABLE_HEADER       *Table,
       UINT32                  *TableIndex);
   
   
   extern ACPI_TABLE_DESC      LocalTables[1];
   extern ACPI_PARSE_OBJECT    *AcpiGbl_ParseOpRoot;
   
   
   /******************************************************************************
    *
    * FUNCTION:    AdDisassemblerHeader
    *
    * PARAMETERS:  Filename            - Input file for the table
    *              TableType           - Either AML or DataTable
    *
    * RETURN:      None
    *
    * DESCRIPTION: Create the disassembler header, including ACPICA signon with
    *              current time and date.
    *
    *****************************************************************************/
   
   void
   AdDisassemblerHeader (
       char                    *Filename,
       UINT8                   TableType)
   {
       time_t                  Timer;
   
   
       time (&Timer);
   
       /* Header and input table info */
   
       AcpiOsPrintf ("/*\n");
       AcpiOsPrintf (ACPI_COMMON_HEADER (AML_DISASSEMBLER_NAME, " * "));
   
       if (TableType == ACPI_IS_AML_TABLE)
       {
           if (AcpiGbl_CstyleDisassembly)
           {
               AcpiOsPrintf (
                   " * Disassembling to symbolic ASL+ operators\n"
                   " *\n");
           }
           else
           {
               AcpiOsPrintf (
                   " * Disassembling to non-symbolic legacy ASL operators\n"
                   " *\n");
           }
       }
   
       AcpiOsPrintf (" * Disassembly of %s, %s", Filename, ctime (&Timer));
       AcpiOsPrintf (" *\n");
   }
   
   
   /******************************************************************************
    *
    * FUNCTION:    AdCreateTableHeader
    *
    * PARAMETERS:  Filename            - Input file for the table
    *              Table               - Pointer to the raw table
    *
    * RETURN:      None
    *
    * DESCRIPTION: Create the ASL table header, including ACPICA signon with
    *              current time and date.
    *
    *****************************************************************************/
   
   static void
   AdCreateTableHeader (
       char                    *Filename,
       ACPI_TABLE_HEADER       *Table)
   {
       UINT8                   Checksum;
   
   
       /* Reset globals for External statements */
   
       AcpiGbl_NumExternalMethods = 0;
       AcpiGbl_ResolvedExternalMethods = 0;
   
       /*
        * Print file header and dump original table header
        */
       AdDisassemblerHeader (Filename, ACPI_IS_AML_TABLE);
   
       AcpiOsPrintf (" * Original Table Header:\n");
       AcpiOsPrintf (" *     Signature        \"%4.4s\"\n",    Table->Signature);
       AcpiOsPrintf (" *     Length           0x%8.8X (%u)\n", Table->Length, Table->Length);
   
       /* Print and validate the revision */
   
       AcpiOsPrintf (" *     Revision         0x%2.2X",      Table->Revision);
   
       switch (Table->Revision)
       {
       case 0:
   
           AcpiOsPrintf (" **** Invalid Revision");
           break;
   
       case 1:
   
           /* Revision of DSDT controls the ACPI integer width */
   
           if (ACPI_COMPARE_NAMESEG (Table->Signature, ACPI_SIG_DSDT))
           {
               AcpiOsPrintf (" **** 32-bit table (V1), no 64-bit math support");
           }
           break;
   
       default:
   
           break;
       }
   
       /* Print and validate the table checksum */
   
       AcpiOsPrintf ("\n *     Checksum         0x%2.2X",        Table->Checksum);
   
       Checksum = AcpiUtChecksum (ACPI_CAST_PTR (UINT8, Table), Table->Length);
       if (Checksum)
       {
           AcpiOsPrintf (" **** Incorrect checksum, should be 0x%2.2X",
               (UINT8) (Table->Checksum - Checksum));
       }
   
       AcpiOsPrintf ("\n");
       AcpiOsPrintf (" *     OEM ID           \"%.6s\"\n",     Table->OemId);
       AcpiOsPrintf (" *     OEM Table ID     \"%.8s\"\n",     Table->OemTableId);
       AcpiOsPrintf (" *     OEM Revision     0x%8.8X (%u)\n", Table->OemRevision, Table->OemRevision);
       AcpiOsPrintf (" *     Compiler ID      \"%.4s\"\n",     Table->AslCompilerId);
       AcpiOsPrintf (" *     Compiler Version 0x%8.8X (%u)\n", Table->AslCompilerRevision, Table->AslCompilerRevision);
       AcpiOsPrintf (" */\n");
   
       /*
        * Print comments that come before this definition block.
        */
       if (AcpiGbl_CaptureComments)
       {
           ASL_CV_PRINT_ONE_COMMENT(AcpiGbl_ParseOpRoot,AML_COMMENT_STANDARD, NULL, 0);
       }
   
       /*
        * Open the ASL definition block.
        *
        * Note: the AMLFilename string is left zero-length in order to just let
        * the compiler create it when the disassembled file is compiled. This
        * makes it easier to rename the disassembled ASL file if needed.
        */
       AcpiOsPrintf (
           "DefinitionBlock (\"\", \"%4.4s\", %u, \"%.6s\", \"%.8s\", 0x%8.8X)\n",
           Table->Signature, Table->Revision,
           Table->OemId, Table->OemTableId, Table->OemRevision);
   }
   
   
   /******************************************************************************
    *
    * FUNCTION:    AdDisplayTables
    *
    * PARAMETERS:  Filename            - Input file for the table
    *              Table               - Pointer to the raw table
    *
    * RETURN:      Status
    *
    * DESCRIPTION: Display (disassemble) loaded tables and dump raw tables
    *
    *****************************************************************************/
   
   ACPI_STATUS
   AdDisplayTables (
       char                    *Filename,
       ACPI_TABLE_HEADER       *Table)
   {
   
   
       if (!AcpiGbl_ParseOpRoot)
       {
           return (AE_NOT_EXIST);
       }
   
       if (!AcpiGbl_DmOpt_Listing)
       {
           AdCreateTableHeader (Filename, Table);
       }
   
       AcpiDmDisassemble (NULL, AcpiGbl_ParseOpRoot, ACPI_UINT32_MAX);
       MpEmitMappingInfo ();
   
       if (AcpiGbl_DmOpt_Listing)
       {
           AcpiOsPrintf ("\n\nTable Header:\n");
           AcpiUtDebugDumpBuffer ((UINT8 *) Table, sizeof (ACPI_TABLE_HEADER),
               DB_BYTE_DISPLAY, ACPI_UINT32_MAX);
   
           AcpiOsPrintf ("Table Body (Length 0x%X)\n", Table->Length);
           AcpiUtDebugDumpBuffer (((UINT8 *) Table + sizeof (ACPI_TABLE_HEADER)),
               Table->Length, DB_BYTE_DISPLAY, ACPI_UINT32_MAX);
       }
   
       return (AE_OK);
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AdStoreTable
    *
    * PARAMETERS:  Table               - Table header
    *              TableIndex          - Where the table index is returned
    *
    * RETURN:      Status and table index.
    *
    * DESCRIPTION: Add an ACPI table to the global table list
    *
    ******************************************************************************/
   
   static ACPI_STATUS
   AdStoreTable (
       ACPI_TABLE_HEADER       *Table,
       UINT32                  *TableIndex)
   {
       ACPI_STATUS             Status;
       ACPI_TABLE_DESC         *TableDesc;
   
   
       Status = AcpiTbGetNextTableDescriptor (TableIndex, &TableDesc);
       if (ACPI_FAILURE (Status))
       {
           return (Status);
       }
   
       /* Initialize added table */
   
       AcpiTbInitTableDescriptor (TableDesc, ACPI_PTR_TO_PHYSADDR (Table),
           ACPI_TABLE_ORIGIN_INTERNAL_VIRTUAL, Table);
       Status = AcpiTbValidateTable (TableDesc);
       return (Status);
   }
   
   
   /******************************************************************************
    *
    * FUNCTION:    AdGetLocalTables
    *
    * PARAMETERS:  None
    *
    * RETURN:      Status
    *
    * DESCRIPTION: Get the ACPI tables from either memory or a file
    *
    *****************************************************************************/
   
   ACPI_STATUS
   AdGetLocalTables (
       void)
   {
       ACPI_STATUS             Status;
       ACPI_TABLE_HEADER       TableHeader;
       ACPI_TABLE_HEADER       *NewTable;
       UINT32                  TableIndex;
   
   
       /* Get the DSDT via table override */
   
       ACPI_MOVE_32_TO_32 (TableHeader.Signature, ACPI_SIG_DSDT);
       Status = AcpiOsTableOverride (&TableHeader, &NewTable);
       if (ACPI_FAILURE (Status) || !NewTable)
       {
           fprintf (stderr, "Could not obtain DSDT\n");
           return (AE_NO_ACPI_TABLES);
       }
   
       AdWriteTable (NewTable, NewTable->Length,
           ACPI_SIG_DSDT, NewTable->OemTableId);
   
       /* Store DSDT in the Table Manager */
   
       Status = AdStoreTable (NewTable, &TableIndex);
       if (ACPI_FAILURE (Status))
       {
           fprintf (stderr, "Could not store DSDT\n");
           return (AE_NO_ACPI_TABLES);
       }
   
       return (AE_OK);
   }
   
   
   /******************************************************************************
    *
    * FUNCTION:    AdParseTable
    *
    * PARAMETERS:  Table               - Pointer to the raw table
    *              OwnerId             - Returned OwnerId of the table
    *              LoadTable           - If add table to the global table list
    *              External            - If this is an external table
    *
    * RETURN:      Status
    *
    * DESCRIPTION: Parse an ACPI AML table
    *
    *****************************************************************************/
   
   ACPI_STATUS
   AdParseTable (
       ACPI_TABLE_HEADER       *Table,
       ACPI_OWNER_ID           *OwnerId,
       BOOLEAN                 LoadTable,
       BOOLEAN                 External)
   {
       ACPI_STATUS             Status = AE_OK;
       ACPI_WALK_STATE         *WalkState;
       UINT8                   *AmlStart;
       UINT32                  AmlLength;
       UINT32                  TableIndex;
   
   
       if (!Table)
       {
           return (AE_NOT_EXIST);
       }
   
       /* Pass 1:  Parse everything except control method bodies */
   
       fprintf (stderr, "Pass 1 parse of [%4.4s]\n", (char *) Table->Signature);
   
       AmlLength = Table->Length - sizeof (ACPI_TABLE_HEADER);
       AmlStart = ((UINT8 *) Table + sizeof (ACPI_TABLE_HEADER));
   
       AcpiUtSetIntegerWidth (Table->Revision);
   
       /* Create the root object */
   
       AcpiGbl_ParseOpRoot = AcpiPsCreateScopeOp (AmlStart);
       if (!AcpiGbl_ParseOpRoot)
       {
           return (AE_NO_MEMORY);
       }
   
   #ifdef ACPI_ASL_COMPILER
       if (AcpiGbl_CaptureComments)
       {
           AcpiGbl_ParseOpRoot->Common.CvFilename = AcpiGbl_FileTreeRoot->Filename;
       }
       else
       {
           AcpiGbl_ParseOpRoot->Common.CvFilename = NULL;
       }
   #endif
   
       /* Create and initialize a new walk state */
   
       WalkState = AcpiDsCreateWalkState (0, AcpiGbl_ParseOpRoot, NULL, NULL);
       if (!WalkState)
       {
           return (AE_NO_MEMORY);
       }
   
       Status = AcpiDsInitAmlWalk (WalkState, AcpiGbl_ParseOpRoot,
           NULL, AmlStart, AmlLength, NULL, ACPI_IMODE_LOAD_PASS1);
       if (ACPI_FAILURE (Status))
       {
           return (Status);
       }
   
       WalkState->ParseFlags &= ~ACPI_PARSE_DELETE_TREE;
   
       Status = AcpiPsParseAml (WalkState);
       if (ACPI_FAILURE (Status))
       {
           return (Status);
       }
   
       /* If LoadTable is FALSE, we are parsing the last loaded table */
   
       TableIndex = AcpiGbl_RootTableList.CurrentTableCount - 1;
   
       /* Pass 2 */
   
       if (LoadTable)
       {
           Status = AdStoreTable (Table, &TableIndex);
           if (ACPI_FAILURE (Status))
           {
               return (Status);
           }
           Status = AcpiTbAllocateOwnerId (TableIndex);
           if (ACPI_FAILURE (Status))
           {
               return (Status);
           }
           if (OwnerId)
           {
               Status = AcpiTbGetOwnerId (TableIndex, OwnerId);
               if (ACPI_FAILURE (Status))
               {
                   return (Status);
               }
           }
       }
   
       fprintf (stderr, "Pass 2 parse of [%4.4s]\n", (char *) Table->Signature);
   
       Status = AcpiNsOneCompleteParse (ACPI_IMODE_LOAD_PASS2, TableIndex, NULL);
       if (ACPI_FAILURE (Status))
       {
           return (Status);
       }
   
       /* No need to parse control methods of external table */
   
       if (External)
       {
           return (AE_OK);
       }
   
       /*
        * Pass 3: Parse control methods and link their parse trees
        * into the main parse tree
        */
       fprintf (stderr,
           "Parsing Deferred Opcodes (Methods/Buffers/Packages/Regions)\n");
   
       (void) AcpiDmParseDeferredOps (AcpiGbl_ParseOpRoot);
       fprintf (stderr, "\n");
   
       /* Process Resource Templates */
   
       AcpiDmFindResources (AcpiGbl_ParseOpRoot);
   
       fprintf (stderr, "Parsing completed\n");
       return (AE_OK);
   }

Cache object: 21e07dd59e5c9d8d11b7656c02e34b2a