sys/contrib/dev/acpica/source/tools/acpidump/apdump.c

   1 /******************************************************************************
   2  *
   3  * Module Name: apdump - Dump routines for ACPI tables (acpidump)
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
  12  * All rights reserved.
  13  *
  14  * 2. License
  15  *
  16  * 2.1. This is your license from Intel Corp. under its intellectual property
  17  * rights. You may have additional license terms from the party that provided
  18  * you this software, covering your right to use that party's intellectual
  19  * property rights.
  20  *
  21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  22  * copy of the source code appearing in this file ("Covered Code") an
  23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  24  * base code distributed originally by Intel ("Original Intel Code") to copy,
  25  * make derivatives, distribute, use and display any portion of the Covered
  26  * Code in any form, with the right to sublicense such rights; and
  27  *
  28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  29  * license (with the right to sublicense), under only those claims of Intel
  30  * patents that are infringed by the Original Intel Code, to make, use, sell,
  31  * offer to sell, and import the Covered Code and derivative works thereof
  32  * solely to the minimum extent necessary to exercise the above copyright
  33  * license, and in no event shall the patent license extend to any additions
  34  * to or modifications of the Original Intel Code. No other license or right
  35  * is granted directly or by implication, estoppel or otherwise;
  36  *
  37  * The above copyright and patent license is granted only if the following
  38  * conditions are met:
  39  *
  40  * 3. Conditions
  41  *
  42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  43  * Redistribution of source code of any substantial portion of the Covered
  44  * Code or modification with rights to further distribute source must include
  45  * the above Copyright Notice, the above License, this list of Conditions,
  46  * and the following Disclaimer and Export Compliance provision. In addition,
  47  * Licensee must cause all Covered Code to which Licensee contributes to
  48  * contain a file documenting the changes Licensee made to create that Covered
  49  * Code and the date of any change. Licensee must include in that file the
  50  * documentation of any changes made by any predecessor Licensee. Licensee
  51  * must include a prominent statement that the modification is derived,
  52  * directly or indirectly, from Original Intel Code.
  53  *
  54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  55  * Redistribution of source code of any substantial portion of the Covered
  56  * Code or modification without rights to further distribute source must
  57  * include the following Disclaimer and Export Compliance provision in the
  58  * documentation and/or other materials provided with distribution. In
  59  * addition, Licensee may not authorize further sublicense of source of any
  60  * portion of the Covered Code, and must include terms to the effect that the
  61  * license from Licensee to its licensee is limited to the intellectual
  62  * property embodied in the software Licensee provides to its licensee, and
  63  * not to intellectual property embodied in modifications its licensee may
  64  * make.
  65  *
  66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  67  * substantial portion of the Covered Code or modification must reproduce the
  68  * above Copyright Notice, and the following Disclaimer and Export Compliance
  69  * provision in the documentation and/or other materials provided with the
  70  * distribution.
  71  *
  72  * 3.4. Intel retains all right, title, and interest in and to the Original
  73  * Intel Code.
  74  *
  75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  76  * Intel shall be used in advertising or otherwise to promote the sale, use or
  77  * other dealings in products derived from or relating to the Covered Code
  78  * without prior written authorization from Intel.
  79  *
  80  * 4. Disclaimer and Export Compliance
  81  *
  82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  83  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
  85  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
  86  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
  87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  88  * PARTICULAR PURPOSE.
  89  *
  90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
  96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  97  * LIMITED REMEDY.
  98  *
  99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 100  * software or system incorporating such software without first obtaining any
 101  * required license or other approval from the U. S. Department of Commerce or
 102  * any other agency or department of the United States Government. In the
 103  * event Licensee exports any such software from the United States or
 104  * re-exports any such software from a foreign destination, Licensee shall
 105  * ensure that the distribution and export/re-export of the software is in
 106  * compliance with all laws, regulations, orders, or other restrictions of the
 107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 108  * any of its subsidiaries will export/re-export any technical data, process,
 109  * software, or service, directly or indirectly, to any country for which the
 110  * United States government or any agency thereof requires an export license,
 111  * other governmental approval, or letter of assurance, without first obtaining
 112  * such license, approval or letter.
 113  *
 114  *****************************************************************************
 115  *
 116  * Alternatively, you may choose to be licensed under the terms of the
 117  * following license:
 118  *
 119  * Redistribution and use in source and binary forms, with or without
 120  * modification, are permitted provided that the following conditions
 121  * are met:
 122  * 1. Redistributions of source code must retain the above copyright
 123  *    notice, this list of conditions, and the following disclaimer,
 124  *    without modification.
 125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
 126  *    substantially similar to the "NO WARRANTY" disclaimer below
 127  *    ("Disclaimer") and any redistribution must be conditioned upon
 128  *    including a substantially similar Disclaimer requirement for further
 129  *    binary redistribution.
 130  * 3. Neither the names of the above-listed copyright holders nor the names
 131  *    of any contributors may be used to endorse or promote products derived
 132  *    from this software without specific prior written permission.
 133  *
 134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 145  *
 146  * Alternatively, you may choose to be licensed under the terms of the
 147  * GNU General Public License ("GPL") version 2 as published by the Free
 148  * Software Foundation.
 149  *
 150  *****************************************************************************/
 151
 152 #include "acpidump.h"
 153
 154
 155 /* Local prototypes */
 156
 157 static int
 158 ApDumpTableBuffer (
 159     ACPI_TABLE_HEADER       *Table,
 160     UINT32                  Instance,
 161     ACPI_PHYSICAL_ADDRESS   Address);
 162
 163
 164 /******************************************************************************
 165  *
 166  * FUNCTION:    ApIsValidHeader
 167  *
 168  * PARAMETERS:  Table               - Pointer to table to be validated
 169  *
 170  * RETURN:      TRUE if the header appears to be valid. FALSE otherwise
 171  *
 172  * DESCRIPTION: Check for a valid ACPI table header
 173  *
 174  ******************************************************************************/
 175
 176 BOOLEAN
 177 ApIsValidHeader (
 178     ACPI_TABLE_HEADER       *Table)
 179 {
 180
 181     if (!ACPI_VALIDATE_RSDP_SIG (Table->Signature))
 182     {
 183         /* Make sure signature is all ASCII and a valid ACPI name */
 184
 185         if (!AcpiUtValidNameseg (Table->Signature))
 186         {
 187             fprintf (stderr, "Table signature (0x%8.8X) is invalid\n",
 188                 *(UINT32 *) Table->Signature);
 189             return (FALSE);
 190         }
 191
 192         /* Check for minimum table length */
 193
 194         if (Table->Length < sizeof (ACPI_TABLE_HEADER))
 195         {
 196             fprintf (stderr, "Table length (0x%8.8X) is invalid\n",
 197                 Table->Length);
 198             return (FALSE);
 199         }
 200     }
 201
 202     return (TRUE);
 203 }
 204
 205
 206 /******************************************************************************
 207  *
 208  * FUNCTION:    ApIsValidChecksum
 209  *
 210  * PARAMETERS:  Table               - Pointer to table to be validated
 211  *
 212  * RETURN:      TRUE if the checksum appears to be valid. FALSE otherwise.
 213  *
 214  * DESCRIPTION: Check for a valid ACPI table checksum.
 215  *
 216  ******************************************************************************/
 217
 218 BOOLEAN
 219 ApIsValidChecksum (
 220     ACPI_TABLE_HEADER       *Table)
 221 {
 222     ACPI_STATUS             Status;
 223     ACPI_TABLE_RSDP         *Rsdp;
 224
 225
 226     if (ACPI_VALIDATE_RSDP_SIG (Table->Signature))
 227     {
 228         /*
 229          * Checksum for RSDP.
 230          * Note: Other checksums are computed during the table dump.
 231          */
 232         Rsdp = ACPI_CAST_PTR (ACPI_TABLE_RSDP, Table);
 233         Status = AcpiTbValidateRsdp (Rsdp);
 234     }
 235     else
 236     {
 237         Status = AcpiTbVerifyChecksum (Table, Table->Length);
 238     }
 239
 240     if (ACPI_FAILURE (Status))
 241     {
 242         fprintf (stderr, "%4.4s: Warning: wrong checksum in table\n",
 243             Table->Signature);
 244     }
 245
 246     return (AE_OK);
 247 }
 248
 249
 250 /******************************************************************************
 251  *
 252  * FUNCTION:    ApGetTableLength
 253  *
 254  * PARAMETERS:  Table               - Pointer to the table
 255  *
 256  * RETURN:      Table length
 257  *
 258  * DESCRIPTION: Obtain table length according to table signature.
 259  *
 260  ******************************************************************************/
 261
 262 UINT32
 263 ApGetTableLength (
 264     ACPI_TABLE_HEADER       *Table)
 265 {
 266     ACPI_TABLE_RSDP         *Rsdp;
 267
 268
 269     /* Check if table is valid */
 270
 271     if (!ApIsValidHeader (Table))
 272     {
 273         return (0);
 274     }
 275
 276     if (ACPI_VALIDATE_RSDP_SIG (Table->Signature))
 277     {
 278         Rsdp = ACPI_CAST_PTR (ACPI_TABLE_RSDP, Table);
 279         return (AcpiTbGetRsdpLength (Rsdp));
 280     }
 281
 282     /* Normal ACPI table */
 283
 284     return (Table->Length);
 285 }
 286
 287
 288 /******************************************************************************
 289  *
 290  * FUNCTION:    ApDumpTableBuffer
 291  *
 292  * PARAMETERS:  Table               - ACPI table to be dumped
 293  *              Instance            - ACPI table instance no. to be dumped
 294  *              Address             - Physical address of the table
 295  *
 296  * RETURN:      None
 297  *
 298  * DESCRIPTION: Dump an ACPI table in standard ASCII hex format, with a
 299  *              header that is compatible with the AcpiXtract utility.
 300  *
 301  ******************************************************************************/
 302
 303 static int
 304 ApDumpTableBuffer (
 305     ACPI_TABLE_HEADER       *Table,
 306     UINT32                  Instance,
 307     ACPI_PHYSICAL_ADDRESS   Address)
 308 {
 309     UINT32                  TableLength;
 310
 311
 312     TableLength = ApGetTableLength (Table);
 313
 314     /* Print only the header if requested */
 315
 316     if (Gbl_SummaryMode)
 317     {
 318         AcpiTbPrintTableHeader (Address, Table);
 319         return (0);
 320     }
 321
 322     /* Dump to binary file if requested */
 323
 324     if (Gbl_BinaryMode)
 325     {
 326         return (ApWriteToBinaryFile (Table, Instance));
 327     }
 328
 329     /*
 330      * Dump the table with header for use with acpixtract utility.
 331      * Note: simplest to just always emit a 64-bit address. AcpiXtract
 332      * utility can handle this.
 333      */
 334     fprintf (Gbl_OutputFile, "%4.4s @ 0x%8.8X%8.8X\n",
 335         Table->Signature, ACPI_FORMAT_UINT64 (Address));
 336
 337     AcpiUtDumpBufferToFile (Gbl_OutputFile,
 338         ACPI_CAST_PTR (UINT8, Table), TableLength,
 339         DB_BYTE_DISPLAY, 0);
 340     fprintf (Gbl_OutputFile, "\n");
 341     return (0);
 342 }
 343
 344
 345 /******************************************************************************
 346  *
 347  * FUNCTION:    ApDumpAllTables
 348  *
 349  * PARAMETERS:  None
 350  *
 351  * RETURN:      Status
 352  *
 353  * DESCRIPTION: Get all tables from the RSDT/XSDT (or at least all of the
 354  *              tables that we can possibly get).
 355  *
 356  ******************************************************************************/
 357
 358 int
 359 ApDumpAllTables (
 360     void)
 361 {
 362     ACPI_TABLE_HEADER       *Table;
 363     UINT32                  Instance = 0;
 364     ACPI_PHYSICAL_ADDRESS   Address;
 365     ACPI_STATUS             Status;
 366     int                     TableStatus;
 367     UINT32                  i;
 368
 369
 370     /* Get and dump all available ACPI tables */
 371
 372     for (i = 0; i < AP_MAX_ACPI_FILES; i++)
 373     {
 374         Status = AcpiOsGetTableByIndex (i, &Table, &Instance, &Address);
 375         if (ACPI_FAILURE (Status))
 376         {
 377             /* AE_LIMIT means that no more tables are available */
 378
 379             if (Status == AE_LIMIT)
 380             {
 381                 return (0);
 382             }
 383             else if (i == 0)
 384             {
 385                 fprintf (stderr, "Could not get ACPI tables, %s\n",
 386                     AcpiFormatException (Status));
 387                 return (-1);
 388             }
 389             else
 390             {
 391                 fprintf (stderr, "Could not get ACPI table at index %u, %s\n",
 392                     i, AcpiFormatException (Status));
 393                 continue;
 394             }
 395         }
 396
 397         TableStatus = ApDumpTableBuffer (Table, Instance, Address);
 398         ACPI_FREE (Table);
 399
 400         if (TableStatus)
 401         {
 402             break;
 403         }
 404     }
 405
 406     /* Something seriously bad happened if the loop terminates here */
 407
 408     return (-1);
 409 }
 410
 411
 412 /******************************************************************************
 413  *
 414  * FUNCTION:    ApDumpTableByAddress
 415  *
 416  * PARAMETERS:  AsciiAddress        - Address for requested ACPI table
 417  *
 418  * RETURN:      Status
 419  *
 420  * DESCRIPTION: Get an ACPI table via a physical address and dump it.
 421  *
 422  ******************************************************************************/
 423
 424 int
 425 ApDumpTableByAddress (
 426     char                    *AsciiAddress)
 427 {
 428     ACPI_PHYSICAL_ADDRESS   Address;
 429     ACPI_TABLE_HEADER       *Table;
 430     ACPI_STATUS             Status;
 431     int                     TableStatus;
 432     UINT64                  LongAddress;
 433
 434
 435     /* Convert argument to an integer physical address */
 436
 437     Status = AcpiUtStrtoul64 (AsciiAddress, &LongAddress);
 438     if (ACPI_FAILURE (Status))
 439     {
 440         fprintf (stderr, "%s: Could not convert to a physical address\n",
 441             AsciiAddress);
 442         return (-1);
 443     }
 444
 445     Address = (ACPI_PHYSICAL_ADDRESS) LongAddress;
 446     Status = AcpiOsGetTableByAddress (Address, &Table);
 447     if (ACPI_FAILURE (Status))
 448     {
 449         fprintf (stderr, "Could not get table at 0x%8.8X%8.8X, %s\n",
 450             ACPI_FORMAT_UINT64 (Address),
 451             AcpiFormatException (Status));
 452         return (-1);
 453     }
 454
 455     TableStatus = ApDumpTableBuffer (Table, 0, Address);
 456     ACPI_FREE (Table);
 457     return (TableStatus);
 458 }
 459
 460
 461 /******************************************************************************
 462  *
 463  * FUNCTION:    ApDumpTableByName
 464  *
 465  * PARAMETERS:  Signature           - Requested ACPI table signature
 466  *
 467  * RETURN:      Status
 468  *
 469  * DESCRIPTION: Get an ACPI table via a signature and dump it. Handles
 470  *              multiple tables with the same signature (SSDTs).
 471  *
 472  ******************************************************************************/
 473
 474 int
 475 ApDumpTableByName (
 476     char                    *Signature)
 477 {
 478     char                    LocalSignature [ACPI_NAME_SIZE + 1];
 479     UINT32                  Instance;
 480     ACPI_TABLE_HEADER       *Table;
 481     ACPI_PHYSICAL_ADDRESS   Address;
 482     ACPI_STATUS             Status;
 483     int                     TableStatus;
 484
 485
 486     if (strlen (Signature) != ACPI_NAME_SIZE)
 487     {
 488         fprintf (stderr,
 489             "Invalid table signature [%s]: must be exactly 4 characters\n",
 490             Signature);
 491         return (-1);
 492     }
 493
 494     /* Table signatures are expected to be uppercase */
 495
 496     strcpy (LocalSignature, Signature);
 497     AcpiUtStrupr (LocalSignature);
 498
 499     /* To be friendly, handle tables whose signatures do not match the name */
 500
 501     if (ACPI_COMPARE_NAME (LocalSignature, "FADT"))
 502     {
 503         strcpy (LocalSignature, ACPI_SIG_FADT);
 504     }
 505     else if (ACPI_COMPARE_NAME (LocalSignature, "MADT"))
 506     {
 507         strcpy (LocalSignature, ACPI_SIG_MADT);
 508     }
 509
 510     /* Dump all instances of this signature (to handle multiple SSDTs) */
 511
 512     for (Instance = 0; Instance < AP_MAX_ACPI_FILES; Instance++)
 513     {
 514         Status = AcpiOsGetTableByName (LocalSignature, Instance,
 515             &Table, &Address);
 516         if (ACPI_FAILURE (Status))
 517         {
 518             /* AE_LIMIT means that no more tables are available */
 519
 520             if (Status == AE_LIMIT)
 521             {
 522                 return (0);
 523             }
 524
 525             fprintf (stderr,
 526                 "Could not get ACPI table with signature [%s], %s\n",
 527                 LocalSignature, AcpiFormatException (Status));
 528             return (-1);
 529         }
 530
 531         TableStatus = ApDumpTableBuffer (Table, Instance, Address);
 532         ACPI_FREE (Table);
 533
 534         if (TableStatus)
 535         {
 536             break;
 537         }
 538     }
 539
 540     /* Something seriously bad happened if the loop terminates here */
 541
 542     return (-1);
 543 }
 544
 545
 546 /******************************************************************************
 547  *
 548  * FUNCTION:    ApDumpTableFromFile
 549  *
 550  * PARAMETERS:  Pathname            - File containing the binary ACPI table
 551  *
 552  * RETURN:      Status
 553  *
 554  * DESCRIPTION: Dump an ACPI table from a binary file
 555  *
 556  ******************************************************************************/
 557
 558 int
 559 ApDumpTableFromFile (
 560     char                    *Pathname)
 561 {
 562     ACPI_TABLE_HEADER       *Table;
 563     UINT32                  FileSize = 0;
 564     int                     TableStatus = -1;
 565
 566
 567     /* Get the entire ACPI table from the file */
 568
 569     Table = ApGetTableFromFile (Pathname, &FileSize);
 570     if (!Table)
 571     {
 572         return (-1);
 573     }
 574
 575     if (!AcpiUtValidNameseg (Table->Signature))
 576     {
 577         fprintf (stderr,
 578             "No valid ACPI signature was found in input file %s\n",
 579             Pathname);
 580     }
 581
 582     /* File must be at least as long as the table length */
 583
 584     if (Table->Length > FileSize)
 585     {
 586         fprintf (stderr,
 587             "Table length (0x%X) is too large for input file (0x%X) %s\n",
 588             Table->Length, FileSize, Pathname);
 589         goto Exit;
 590     }
 591
 592     if (Gbl_VerboseMode)
 593     {
 594         fprintf (stderr,
 595             "Input file:  %s contains table [%4.4s], 0x%X (%u) bytes\n",
 596             Pathname, Table->Signature, FileSize, FileSize);
 597     }
 598
 599     TableStatus = ApDumpTableBuffer (Table, 0, 0);
 600
 601 Exit:
 602     ACPI_FREE (Table);
 603     return (TableStatus);
 604 }