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

     /******************************************************************************
      *
      * Module Name: dmtbdump - Dump ACPI data tables that contain no AML code
      *
      *****************************************************************************/
     
     /******************************************************************************
      *
      * 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/acdisasm.h>
   #include <contrib/dev/acpica/include/actables.h>
   
   /* This module used for application-level code only */
   
   #define _COMPONENT          ACPI_CA_DISASSEMBLER
           ACPI_MODULE_NAME    ("dmtbdump")
   
   
   /* Local prototypes */
   
   static void
   AcpiDmValidateFadtLength (
       UINT32                  Revision,
       UINT32                  Length);
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AcpiDmDumpBuffer
    *
    * PARAMETERS:  Table               - ACPI Table or subtable
    *              BufferOffset        - Offset of buffer from Table above
    *              Length              - Length of the buffer
    *              AbsoluteOffset      - Offset of buffer in the main ACPI table
    *              Header              - Name of the buffer field (printed on the
    *                                    first line only.)
    *
    * RETURN:      None
    *
    * DESCRIPTION: Format the contents of an arbitrary length data buffer (in the
    *              disassembler output format.)
    *
    ******************************************************************************/
   
   void
   AcpiDmDumpBuffer (
       void                    *Table,
       UINT32                  BufferOffset,
       UINT32                  Length,
       UINT32                  AbsoluteOffset,
       char                    *Header)
   {
       UINT8                   *Buffer;
       UINT8                   BufChar;
       UINT32                  i;
       UINT32                  j;
   
   
       if (!Length)
       {
           return;
       }
   
       Buffer = ACPI_CAST_PTR (UINT8, Table) + BufferOffset;
       i = 0;
   
       while (i < Length)
       {
           if ((Length > 16) && (i != 0))
           {
           if ((Length - i) < 16)
               AcpiOsPrintf ("\n/* %3.3Xh %4.4u %3u */                            ", AbsoluteOffset, AbsoluteOffset, Length - i);
           else
               AcpiOsPrintf ("\n/* %3.3Xh %4.4u  16 */                            ", AbsoluteOffset, AbsoluteOffset);
           }
           AbsoluteOffset += 16;
   
           /* Emit the raw data bytes*/
   
           for (j = 0; j < 16; j++)
           {
               if (i + j >= Length)
               {
                   /* Dump fill spaces */
   
                   AcpiOsPrintf ("%*s", (48 - (3 * (Length -i))), " ");
                   break;
               }
               AcpiOsPrintf ("%.02X ", Buffer[(ACPI_SIZE) i + j]);
           }
   
           /* Emit the ASCII equivalent to the raw data bytes */
   
           for (j = 0; j < 16; j++)
           {
               if (i + j >= Length)
               {
                   AcpiOsPrintf (" */\\\n");
                   return;
               }
   
               /*
                * Add comment characters so rest of line is ignored when
                * compiled
                */
               if (j == 0)
               {
                   AcpiOsPrintf ("/* ");
               }
   
               BufChar = Buffer[(ACPI_SIZE) i + j];
               if (isprint (BufChar))
               {
                   AcpiOsPrintf ("%c", BufChar);
               }
               else
               {
                   AcpiOsPrintf (".");
               }
           }
   
           /* Done with that line. */
           /* Close the comment and insert a backslash - line continuation character */
   
           if (Length > 16)
           {
               AcpiOsPrintf (" */\\");
           }
           else
           {
               AcpiOsPrintf (" */\\");
           }
   
           i += 16; /* Point to next line */
       }
   
       AcpiOsPrintf ("\n");
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AcpiDmDumpUnicode
    *
    * PARAMETERS:  Table               - ACPI Table or subtable
    *              BufferOffset        - Offset of buffer from Table above
    *              ByteLength          - Length of the buffer
    *
    * RETURN:      None
    *
    * DESCRIPTION: Validate and dump the contents of a buffer that contains
    *              unicode data. The output is a standard ASCII string. If it
    *              appears that the data is not unicode, the buffer is dumped
    *              as hex characters.
    *
    ******************************************************************************/
   
   void
   AcpiDmDumpUnicode (
       void                    *Table,
       UINT32                  BufferOffset,
       UINT32                  ByteLength)
   {
       UINT8                   *Buffer;
       UINT32                  Length;
       UINT32                  i;
   
   
       Buffer = ((UINT8 *) Table) + BufferOffset;
       Length = ByteLength - 2; /* Last two bytes are the null terminator */
   
       /* Ensure all low bytes are entirely printable ASCII */
   
       for (i = 0; i < Length; i += 2)
       {
           if (!isprint (Buffer[i]))
           {
               goto DumpRawBuffer;
           }
       }
   
       /* Ensure all high bytes are zero */
   
       for (i = 1; i < Length; i += 2)
       {
           if (Buffer[i])
           {
               goto DumpRawBuffer;
           }
       }
   
       /* Dump the buffer as a normal string */
   
       AcpiOsPrintf ("\"");
       for (i = 0; i < Length; i += 2)
       {
           AcpiOsPrintf ("%c", Buffer[i]);
       }
   
       AcpiOsPrintf ("\"\n");
       return;
   
   DumpRawBuffer:
       AcpiDmDumpBuffer (Table, BufferOffset, ByteLength,
           BufferOffset, NULL);
       AcpiOsPrintf ("\n");
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AcpiDmDumpRsdp
    *
    * PARAMETERS:  Table               - A RSDP
    *
    * RETURN:      Length of the table (there is not always a length field,
    *              use revision or length if available (ACPI 2.0+))
    *
    * DESCRIPTION: Format the contents of a RSDP
    *
    ******************************************************************************/
   
   UINT32
   AcpiDmDumpRsdp (
       ACPI_TABLE_HEADER       *Table)
   {
       ACPI_TABLE_RSDP         *Rsdp = ACPI_CAST_PTR (ACPI_TABLE_RSDP, Table);
       UINT32                  Length = sizeof (ACPI_RSDP_COMMON);
       UINT8                   Checksum;
       ACPI_STATUS             Status;
   
   
       /* Dump the common ACPI 1.0 portion */
   
       Status = AcpiDmDumpTable (Length, 0, Table, 0, AcpiDmTableInfoRsdp1);
       if (ACPI_FAILURE (Status))
       {
           return (Length);
       }
   
       /* Validate the first checksum */
   
       Checksum = AcpiUtGenerateChecksum (Rsdp, sizeof (ACPI_RSDP_COMMON),
           Rsdp->Checksum);
       if (Checksum != Rsdp->Checksum)
       {
           AcpiOsPrintf ("/* Incorrect Checksum above, should be 0x%2.2X */\n",
               Checksum);
       }
   
       /* The RSDP for ACPI 2.0+ contains more data and has a Length field */
   
       if (Rsdp->Revision > 0)
       {
           Length = Rsdp->Length;
           Status = AcpiDmDumpTable (Length, 0, Table, 0, AcpiDmTableInfoRsdp2);
           if (ACPI_FAILURE (Status))
           {
               return (Length);
           }
   
           /* Validate the extended checksum over entire RSDP */
   
           Checksum = AcpiUtGenerateChecksum (Rsdp, sizeof (ACPI_TABLE_RSDP),
               Rsdp->ExtendedChecksum);
           if (Checksum != Rsdp->ExtendedChecksum)
           {
               AcpiOsPrintf (
                   "/* Incorrect Extended Checksum above, should be 0x%2.2X */\n",
                   Checksum);
           }
       }
   
       return (Length);
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AcpiDmDumpRsdt
    *
    * PARAMETERS:  Table               - A RSDT
    *
    * RETURN:      None
    *
    * DESCRIPTION: Format the contents of a RSDT
    *
    ******************************************************************************/
   
   void
   AcpiDmDumpRsdt (
       ACPI_TABLE_HEADER       *Table)
   {
       UINT32                  *Array;
       UINT32                  Entries;
       UINT32                  Offset;
       UINT32                  i;
   
   
       /* Point to start of table pointer array */
   
       Array = ACPI_CAST_PTR (ACPI_TABLE_RSDT, Table)->TableOffsetEntry;
       Offset = sizeof (ACPI_TABLE_HEADER);
   
       /* RSDT uses 32-bit pointers */
   
       Entries = (Table->Length - sizeof (ACPI_TABLE_HEADER)) / sizeof (UINT32);
   
       for (i = 0; i < Entries; i++)
       {
           AcpiDmLineHeader2 (Offset, sizeof (UINT32), "ACPI Table Address", i);
           AcpiOsPrintf ("%8.8X\n", Array[i]);
           Offset += sizeof (UINT32);
       }
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AcpiDmDumpXsdt
    *
    * PARAMETERS:  Table               - A XSDT
    *
    * RETURN:      None
    *
    * DESCRIPTION: Format the contents of a XSDT
    *
    ******************************************************************************/
   
   void
   AcpiDmDumpXsdt (
       ACPI_TABLE_HEADER       *Table)
   {
       UINT64                  *Array;
       UINT32                  Entries;
       UINT32                  Offset;
       UINT32                  i;
   
   
       /* Point to start of table pointer array */
   
       Array = ACPI_CAST_PTR (ACPI_TABLE_XSDT, Table)->TableOffsetEntry;
       Offset = sizeof (ACPI_TABLE_HEADER);
   
       /* XSDT uses 64-bit pointers */
   
       Entries = (Table->Length - sizeof (ACPI_TABLE_HEADER)) / sizeof (UINT64);
   
       for (i = 0; i < Entries; i++)
       {
           AcpiDmLineHeader2 (Offset, sizeof (UINT64), "ACPI Table Address", i);
           AcpiOsPrintf ("%8.8X%8.8X\n", ACPI_FORMAT_UINT64 (Array[i]));
           Offset += sizeof (UINT64);
       }
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AcpiDmDumpFadt
    *
    * PARAMETERS:  Table               - A FADT
    *
    * RETURN:      None
    *
    * DESCRIPTION: Format the contents of a FADT
    *
    * NOTE:        We cannot depend on the FADT version to indicate the actual
    *              contents of the FADT because of BIOS bugs. The table length
    *              is the only reliable indicator.
    *
    ******************************************************************************/
   
   void
   AcpiDmDumpFadt (
       ACPI_TABLE_HEADER       *Table)
   {
       ACPI_STATUS             Status;
   
   
       /* Always dump the minimum FADT revision 1 fields (ACPI 1.0) */
   
       Status = AcpiDmDumpTable (Table->Length, 0, Table, 0,
           AcpiDmTableInfoFadt1);
       if (ACPI_FAILURE (Status))
       {
           return;
       }
   
       /* Check for FADT revision 2 fields (ACPI 1.0B MS extensions) */
   
       if ((Table->Length > ACPI_FADT_V1_SIZE) &&
           (Table->Length <= ACPI_FADT_V2_SIZE))
       {
           Status = AcpiDmDumpTable (Table->Length, 0, Table, 0,
               AcpiDmTableInfoFadt2);
           if (ACPI_FAILURE (Status))
           {
               return;
           }
       }
   
       /* Check for FADT revision 3/4 fields and up (ACPI 2.0+ extended data) */
   
       else if (Table->Length > ACPI_FADT_V2_SIZE)
       {
           Status = AcpiDmDumpTable (Table->Length, 0, Table, 0,
               AcpiDmTableInfoFadt3);
           if (ACPI_FAILURE (Status))
           {
               return;
           }
   
           /* Check for FADT revision 5 fields and up (ACPI 5.0+) */
   
           if (Table->Length > ACPI_FADT_V3_SIZE)
           {
               Status = AcpiDmDumpTable (Table->Length, 0, Table, 0,
                   AcpiDmTableInfoFadt5);
               if (ACPI_FAILURE (Status))
               {
                   return;
               }
           }
   
           /* Check for FADT revision 6 fields and up (ACPI 6.0+) */
   
           if (Table->Length > ACPI_FADT_V3_SIZE)
           {
               Status = AcpiDmDumpTable (Table->Length, 0, Table, 0,
                   AcpiDmTableInfoFadt6);
               if (ACPI_FAILURE (Status))
               {
                   return;
               }
           }
       }
   
       /* Validate various fields in the FADT, including length */
   
       AcpiTbCreateLocalFadt (Table, Table->Length);
   
       /* Validate FADT length against the revision */
   
       AcpiDmValidateFadtLength (Table->Revision, Table->Length);
   }
   
   
   /*******************************************************************************
    *
    * FUNCTION:    AcpiDmValidateFadtLength
    *
    * PARAMETERS:  Revision            - FADT revision (Header->Revision)
    *              Length              - FADT length (Header->Length
    *
    * RETURN:      None
    *
    * DESCRIPTION: Check the FADT revision against the expected table length for
    *              that revision. Issue a warning if the length is not what was
    *              expected. This seems to be such a common BIOS bug that the
    *              FADT revision has been rendered virtually meaningless.
    *
    ******************************************************************************/
   
   static void
   AcpiDmValidateFadtLength (
       UINT32                  Revision,
       UINT32                  Length)
   {
       UINT32                  ExpectedLength;
   
   
       switch (Revision)
       {
       case 0:
   
           AcpiOsPrintf ("// ACPI Warning: Invalid FADT revision: 0\n");
           return;
   
       case 1:
   
           ExpectedLength = ACPI_FADT_V1_SIZE;
           break;
   
       case 2:
   
           ExpectedLength = ACPI_FADT_V2_SIZE;
           break;
   
       case 3:
       case 4:
   
           ExpectedLength = ACPI_FADT_V3_SIZE;
           break;
   
       case 5:
   
           ExpectedLength = ACPI_FADT_V5_SIZE;
           break;
   
       default:
   
           return;
       }
   
       if (Length == ExpectedLength)
       {
           return;
       }
   
       AcpiOsPrintf (
           "\n// ACPI Warning: FADT revision %X does not match length: "
           "found %X expected %X\n",
           Revision, Length, ExpectedLength);
   }

Cache object: b2170bba24b34db58d9680f881803837