drivers/acpi/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 - 2015, 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 #include "acpidump.h"
 117
 118
 119 /* Local prototypes */
 120
 121 static int
 122 ApDumpTableBuffer (
 123     ACPI_TABLE_HEADER       *Table,
 124     UINT32                  Instance,
 125     ACPI_PHYSICAL_ADDRESS   Address);
 126
 127
 128 /******************************************************************************
 129  *
 130  * FUNCTION:    ApIsValidHeader
 131  *
 132  * PARAMETERS:  Table               - Pointer to table to be validated
 133  *
 134  * RETURN:      TRUE if the header appears to be valid. FALSE otherwise
 135  *
 136  * DESCRIPTION: Check for a valid ACPI table header
 137  *
 138  ******************************************************************************/
 139
 140 BOOLEAN
 141 ApIsValidHeader (
 142     ACPI_TABLE_HEADER       *Table)
 143 {
 144
 145     if (!ACPI_VALIDATE_RSDP_SIG (Table->Signature))
 146     {
 147         /* Make sure signature is all ASCII and a valid ACPI name */
 148
 149         if (!AcpiUtValidAcpiName (Table->Signature))
 150         {
 151             AcpiLogError ("Table signature (0x%8.8X) is invalid\n",
 152                 *(UINT32 *) Table->Signature);
 153             return (FALSE);
 154         }
 155
 156         /* Check for minimum table length */
 157
 158         if (Table->Length < sizeof (ACPI_TABLE_HEADER))
 159         {
 160             AcpiLogError ("Table length (0x%8.8X) is invalid\n",
 161                 Table->Length);
 162             return (FALSE);
 163         }
 164     }
 165
 166     return (TRUE);
 167 }
 168
 169
 170 /******************************************************************************
 171  *
 172  * FUNCTION:    ApIsValidChecksum
 173  *
 174  * PARAMETERS:  Table               - Pointer to table to be validated
 175  *
 176  * RETURN:      TRUE if the checksum appears to be valid. FALSE otherwise.
 177  *
 178  * DESCRIPTION: Check for a valid ACPI table checksum.
 179  *
 180  ******************************************************************************/
 181
 182 BOOLEAN
 183 ApIsValidChecksum (
 184     ACPI_TABLE_HEADER       *Table)
 185 {
 186     ACPI_STATUS             Status;
 187     ACPI_TABLE_RSDP         *Rsdp;
 188
 189
 190     if (ACPI_VALIDATE_RSDP_SIG (Table->Signature))
 191     {
 192         /*
 193          * Checksum for RSDP.
 194          * Note: Other checksums are computed during the table dump.
 195          */
 196         Rsdp = ACPI_CAST_PTR (ACPI_TABLE_RSDP, Table);
 197         Status = AcpiTbValidateRsdp (Rsdp);
 198     }
 199     else
 200     {
 201         Status = AcpiTbVerifyChecksum (Table, Table->Length);
 202     }
 203
 204     if (ACPI_FAILURE (Status))
 205     {
 206         AcpiLogError ("%4.4s: Warning: wrong checksum in table\n",
 207             Table->Signature);
 208     }
 209
 210     return (AE_OK);
 211 }
 212
 213
 214 /******************************************************************************
 215  *
 216  * FUNCTION:    ApGetTableLength
 217  *
 218  * PARAMETERS:  Table               - Pointer to the table
 219  *
 220  * RETURN:      Table length
 221  *
 222  * DESCRIPTION: Obtain table length according to table signature.
 223  *
 224  ******************************************************************************/
 225
 226 UINT32
 227 ApGetTableLength (
 228     ACPI_TABLE_HEADER       *Table)
 229 {
 230     ACPI_TABLE_RSDP         *Rsdp;
 231
 232
 233     /* Check if table is valid */
 234
 235     if (!ApIsValidHeader (Table))
 236     {
 237         return (0);
 238     }
 239
 240     if (ACPI_VALIDATE_RSDP_SIG (Table->Signature))
 241     {
 242         Rsdp = ACPI_CAST_PTR (ACPI_TABLE_RSDP, Table);
 243         return (AcpiTbGetRsdpLength (Rsdp));
 244     }
 245
 246     /* Normal ACPI table */
 247
 248     return (Table->Length);
 249 }
 250
 251
 252 /******************************************************************************
 253  *
 254  * FUNCTION:    ApDumpTableBuffer
 255  *
 256  * PARAMETERS:  Table               - ACPI table to be dumped
 257  *              Instance            - ACPI table instance no. to be dumped
 258  *              Address             - Physical address of the table
 259  *
 260  * RETURN:      None
 261  *
 262  * DESCRIPTION: Dump an ACPI table in standard ASCII hex format, with a
 263  *              header that is compatible with the AcpiXtract utility.
 264  *
 265  ******************************************************************************/
 266
 267 static int
 268 ApDumpTableBuffer (
 269     ACPI_TABLE_HEADER       *Table,
 270     UINT32                  Instance,
 271     ACPI_PHYSICAL_ADDRESS   Address)
 272 {
 273     UINT32                  TableLength;
 274
 275
 276     TableLength = ApGetTableLength (Table);
 277
 278     /* Print only the header if requested */
 279
 280     if (Gbl_SummaryMode)
 281     {
 282         AcpiTbPrintTableHeader (Address, Table);
 283         return (0);
 284     }
 285
 286     /* Dump to binary file if requested */
 287
 288     if (Gbl_BinaryMode)
 289     {
 290         return (ApWriteToBinaryFile (Table, Instance));
 291     }
 292
 293     /*
 294      * Dump the table with header for use with acpixtract utility.
 295      * Note: simplest to just always emit a 64-bit address. AcpiXtract
 296      * utility can handle this.
 297      */
 298     AcpiUtFilePrintf (Gbl_OutputFile, "%4.4s @ 0x%8.8X%8.8X\n",
 299         Table->Signature, ACPI_FORMAT_UINT64 (Address));
 300
 301     AcpiUtDumpBufferToFile (Gbl_OutputFile,
 302         ACPI_CAST_PTR (UINT8, Table), TableLength,
 303         DB_BYTE_DISPLAY, 0);
 304     AcpiUtFilePrintf (Gbl_OutputFile, "\n");
 305     return (0);
 306 }
 307
 308
 309 /******************************************************************************
 310  *
 311  * FUNCTION:    ApDumpAllTables
 312  *
 313  * PARAMETERS:  None
 314  *
 315  * RETURN:      Status
 316  *
 317  * DESCRIPTION: Get all tables from the RSDT/XSDT (or at least all of the
 318  *              tables that we can possibly get).
 319  *
 320  ******************************************************************************/
 321
 322 int
 323 ApDumpAllTables (
 324     void)
 325 {
 326     ACPI_TABLE_HEADER       *Table;
 327     UINT32                  Instance = 0;
 328     ACPI_PHYSICAL_ADDRESS   Address;
 329     ACPI_STATUS             Status;
 330     int                     TableStatus;
 331     UINT32                  i;
 332
 333
 334     /* Get and dump all available ACPI tables */
 335
 336     for (i = 0; i < AP_MAX_ACPI_FILES; i++)
 337     {
 338         Status = AcpiOsGetTableByIndex (i, &Table, &Instance, &Address);
 339         if (ACPI_FAILURE (Status))
 340         {
 341             /* AE_LIMIT means that no more tables are available */
 342
 343             if (Status == AE_LIMIT)
 344             {
 345                 return (0);
 346             }
 347             else if (i == 0)
 348             {
 349                 AcpiLogError ("Could not get ACPI tables, %s\n",
 350                     AcpiFormatException (Status));
 351                 return (-1);
 352             }
 353             else
 354             {
 355                 AcpiLogError ("Could not get ACPI table at index %u, %s\n",
 356                     i, AcpiFormatException (Status));
 357                 continue;
 358             }
 359         }
 360
 361         TableStatus = ApDumpTableBuffer (Table, Instance, Address);
 362         ACPI_FREE (Table);
 363
 364         if (TableStatus)
 365         {
 366             break;
 367         }
 368     }
 369
 370     /* Something seriously bad happened if the loop terminates here */
 371
 372     return (-1);
 373 }
 374
 375
 376 /******************************************************************************
 377  *
 378  * FUNCTION:    ApDumpTableByAddress
 379  *
 380  * PARAMETERS:  AsciiAddress        - Address for requested ACPI table
 381  *
 382  * RETURN:      Status
 383  *
 384  * DESCRIPTION: Get an ACPI table via a physical address and dump it.
 385  *
 386  ******************************************************************************/
 387
 388 int
 389 ApDumpTableByAddress (
 390     char                    *AsciiAddress)
 391 {
 392     ACPI_PHYSICAL_ADDRESS   Address;
 393     ACPI_TABLE_HEADER       *Table;
 394     ACPI_STATUS             Status;
 395     int                     TableStatus;
 396     UINT64                  LongAddress;
 397
 398
 399     /* Convert argument to an integer physical address */
 400
 401     Status = AcpiUtStrtoul64 (AsciiAddress, 0, &LongAddress);
 402     if (ACPI_FAILURE (Status))
 403     {
 404         AcpiLogError ("%s: Could not convert to a physical address\n",
 405             AsciiAddress);
 406         return (-1);
 407     }
 408
 409     Address = (ACPI_PHYSICAL_ADDRESS) LongAddress;
 410     Status = AcpiOsGetTableByAddress (Address, &Table);
 411     if (ACPI_FAILURE (Status))
 412     {
 413         AcpiLogError ("Could not get table at 0x%8.8X%8.8X, %s\n",
 414             ACPI_FORMAT_UINT64 (Address),
 415             AcpiFormatException (Status));
 416         return (-1);
 417     }
 418
 419     TableStatus = ApDumpTableBuffer (Table, 0, Address);
 420     ACPI_FREE (Table);
 421     return (TableStatus);
 422 }
 423
 424
 425 /******************************************************************************
 426  *
 427  * FUNCTION:    ApDumpTableByName
 428  *
 429  * PARAMETERS:  Signature           - Requested ACPI table signature
 430  *
 431  * RETURN:      Status
 432  *
 433  * DESCRIPTION: Get an ACPI table via a signature and dump it. Handles
 434  *              multiple tables with the same signature (SSDTs).
 435  *
 436  ******************************************************************************/
 437
 438 int
 439 ApDumpTableByName (
 440     char                    *Signature)
 441 {
 442     char                    LocalSignature [ACPI_NAME_SIZE + 1];
 443     UINT32                  Instance;
 444     ACPI_TABLE_HEADER       *Table;
 445     ACPI_PHYSICAL_ADDRESS   Address;
 446     ACPI_STATUS             Status;
 447     int                     TableStatus;
 448
 449
 450     if (ACPI_STRLEN (Signature) != ACPI_NAME_SIZE)
 451     {
 452         AcpiLogError (
 453             "Invalid table signature [%s]: must be exactly 4 characters\n",
 454             Signature);
 455         return (-1);
 456     }
 457
 458     /* Table signatures are expected to be uppercase */
 459
 460     ACPI_STRCPY (LocalSignature, Signature);
 461     AcpiUtStrupr (LocalSignature);
 462
 463     /* To be friendly, handle tables whose signatures do not match the name */
 464
 465     if (ACPI_COMPARE_NAME (LocalSignature, "FADT"))
 466     {
 467         ACPI_STRCPY (LocalSignature, ACPI_SIG_FADT);
 468     }
 469     else if (ACPI_COMPARE_NAME (LocalSignature, "MADT"))
 470     {
 471         ACPI_STRCPY (LocalSignature, ACPI_SIG_MADT);
 472     }
 473
 474     /* Dump all instances of this signature (to handle multiple SSDTs) */
 475
 476     for (Instance = 0; Instance < AP_MAX_ACPI_FILES; Instance++)
 477     {
 478         Status = AcpiOsGetTableByName (LocalSignature, Instance,
 479             &Table, &Address);
 480         if (ACPI_FAILURE (Status))
 481         {
 482             /* AE_LIMIT means that no more tables are available */
 483
 484             if (Status == AE_LIMIT)
 485             {
 486                 return (0);
 487             }
 488
 489             AcpiLogError (
 490                 "Could not get ACPI table with signature [%s], %s\n",
 491                 LocalSignature, AcpiFormatException (Status));
 492             return (-1);
 493         }
 494
 495         TableStatus = ApDumpTableBuffer (Table, Instance, Address);
 496         ACPI_FREE (Table);
 497
 498         if (TableStatus)
 499         {
 500             break;
 501         }
 502     }
 503
 504     /* Something seriously bad happened if the loop terminates here */
 505
 506     return (-1);
 507 }
 508
 509
 510 /******************************************************************************
 511  *
 512  * FUNCTION:    ApDumpTableFromFile
 513  *
 514  * PARAMETERS:  Pathname            - File containing the binary ACPI table
 515  *
 516  * RETURN:      Status
 517  *
 518  * DESCRIPTION: Dump an ACPI table from a binary file
 519  *
 520  ******************************************************************************/
 521
 522 int
 523 ApDumpTableFromFile (
 524     char                    *Pathname)
 525 {
 526     ACPI_TABLE_HEADER       *Table;
 527     UINT32                  FileSize = 0;
 528     int                     TableStatus = -1;
 529
 530
 531     /* Get the entire ACPI table from the file */
 532
 533     Table = ApGetTableFromFile (Pathname, &FileSize);
 534     if (!Table)
 535     {
 536         return (-1);
 537     }
 538
 539     /* File must be at least as long as the table length */
 540
 541     if (Table->Length > FileSize)
 542     {
 543         AcpiLogError (
 544             "Table length (0x%X) is too large for input file (0x%X) %s\n",
 545             Table->Length, FileSize, Pathname);
 546         goto Exit;
 547     }
 548
 549     if (Gbl_VerboseMode)
 550     {
 551         AcpiLogError (
 552             "Input file:  %s contains table [%4.4s], 0x%X (%u) bytes\n",
 553             Pathname, Table->Signature, FileSize, FileSize);
 554     }
 555
 556     TableStatus = ApDumpTableBuffer (Table, 0, 0);
 557
 558 Exit:
 559     ACPI_FREE (Table);
 560     return (TableStatus);
 561 }