sys/contrib/dev/acpica/source/tools/acpibin/abcompare.c

   1 /******************************************************************************
   2  *
   3  * Module Name: abcompare - compare AML files
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2021, 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 "acpibin.h"
 153
 154
 155 ACPI_TABLE_HEADER           Header1;
 156 ACPI_TABLE_HEADER           Header2;
 157
 158 #define BUFFER_SIZE         256
 159 char                        Buffer[BUFFER_SIZE];
 160
 161
 162 /* Local prototypes */
 163
 164 static BOOLEAN
 165 AbValidateHeader (
 166     ACPI_TABLE_HEADER       *Header);
 167
 168 static UINT8
 169 AcpiTbSumTable (
 170     void                    *Buffer,
 171     UINT32                  Length);
 172
 173 static char *
 174 AbGetFile (
 175     char                    *Filename,
 176     UINT32                  *FileSize);
 177
 178 static void
 179 AbPrintHeaderInfo (
 180     ACPI_TABLE_HEADER       *Header);
 181
 182 static void
 183 AbPrintHeadersInfo (
 184     ACPI_TABLE_HEADER       *Header,
 185     ACPI_TABLE_HEADER       *Header2);
 186
 187
 188 /******************************************************************************
 189  *
 190  * FUNCTION:    AbValidateHeader
 191  *
 192  * DESCRIPTION: Check for valid ACPI table header
 193  *
 194  ******************************************************************************/
 195
 196 static BOOLEAN
 197 AbValidateHeader (
 198     ACPI_TABLE_HEADER       *Header)
 199 {
 200
 201     if (!AcpiUtValidNameseg (Header->Signature))
 202     {
 203         printf ("Header signature is invalid\n");
 204         return (FALSE);
 205     }
 206
 207     return (TRUE);
 208 }
 209
 210
 211 /*******************************************************************************
 212  *
 213  * FUNCTION:    AcpiTbSumTable
 214  *
 215  * PARAMETERS:  Buffer              - Buffer to checksum
 216  *              Length              - Size of the buffer
 217  *
 218  * RETURNS      8 bit checksum of buffer
 219  *
 220  * DESCRIPTION: Computes an 8 bit checksum of the buffer(length) and returns it.
 221  *
 222  ******************************************************************************/
 223
 224 static UINT8
 225 AcpiTbSumTable (
 226     void                    *Buffer,
 227     UINT32                  Length)
 228 {
 229     const UINT8             *Limit;
 230     const UINT8             *Rover;
 231     UINT8                   Sum = 0;
 232
 233
 234     if (Buffer && Length)
 235     {
 236         /* Buffer and Length are valid */
 237
 238         Limit = (UINT8 *) Buffer + Length;
 239
 240         for (Rover = Buffer; Rover < Limit; Rover++)
 241         {
 242             Sum = (UINT8) (Sum + *Rover);
 243         }
 244     }
 245
 246     return (Sum);
 247 }
 248
 249
 250 /*******************************************************************************
 251  *
 252  * FUNCTION:    AbPrintHeaderInfo
 253  *
 254  * PARAMETERS:  Header              - An ACPI table header
 255  *
 256  * RETURNS      None.
 257  *
 258  * DESCRIPTION: Format and display header contents.
 259  *
 260  ******************************************************************************/
 261
 262 static void
 263 AbPrintHeaderInfo (
 264     ACPI_TABLE_HEADER       *Header)
 265 {
 266
 267     /* Display header information */
 268
 269     printf ("Signature         : %4.4s\n",    Header->Signature);
 270     printf ("Length            : %8.8X\n",    Header->Length);
 271     printf ("Revision          : %2.2X\n",    Header->Revision);
 272     printf ("Checksum          : %2.2X\n",    Header->Checksum);
 273     printf ("OEM ID            : %.6s\n",     Header->OemId);
 274     printf ("OEM Table ID      : %.8s\n",     Header->OemTableId);
 275     printf ("OEM Revision      : %8.8X\n",    Header->OemRevision);
 276     printf ("ASL Compiler ID   : %.4s\n",     Header->AslCompilerId);
 277     printf ("Compiler Revision : %8.8X\n",    Header->AslCompilerRevision);
 278     printf ("\n");
 279 }
 280
 281 static void
 282 AbPrintHeadersInfo (
 283     ACPI_TABLE_HEADER       *Header,
 284     ACPI_TABLE_HEADER       *Header2)
 285 {
 286
 287     /* Display header information for both headers */
 288
 289     printf ("Signature          %8.4s : %4.4s\n",    Header->Signature, Header2->Signature);
 290     printf ("Length             %8.8X : %8.8X\n",    Header->Length, Header2->Length);
 291     printf ("Revision           %8.2X : %2.2X\n",    Header->Revision, Header2->Revision);
 292     printf ("Checksum           %8.2X : %2.2X\n",    Header->Checksum, Header2->Checksum);
 293     printf ("OEM ID             %8.6s : %.6s\n",     Header->OemId, Header2->OemId);
 294     printf ("OEM Table ID       %8.8s : %.8s\n",     Header->OemTableId, Header2->OemTableId);
 295     printf ("OEM Revision       %8.8X : %8.8X\n",    Header->OemRevision, Header2->OemRevision);
 296     printf ("ASL Compiler ID    %8.4s : %.4s\n",     Header->AslCompilerId, Header2->AslCompilerId);
 297     printf ("Compiler Revision  %8.8X : %8.8X\n",    Header->AslCompilerRevision, Header2->AslCompilerRevision);
 298     printf ("\n");
 299 }
 300
 301
 302 /******************************************************************************
 303  *
 304  * FUNCTION:    AbDisplayHeader
 305  *
 306  * DESCRIPTION: Display an ACPI table header
 307  *
 308  ******************************************************************************/
 309
 310 void
 311 AbDisplayHeader (
 312     char                    *FilePath)
 313 {
 314     UINT32                  Actual;
 315     FILE                    *File;
 316
 317
 318     File = fopen (FilePath, "rb");
 319     if (!File)
 320     {
 321         printf ("Could not open file %s\n", FilePath);
 322         return;
 323     }
 324
 325     Actual = fread (&Header1, 1, sizeof (ACPI_TABLE_HEADER), File);
 326     fclose (File);
 327
 328     if (Actual != sizeof (ACPI_TABLE_HEADER))
 329     {
 330         printf ("File %s does not contain a valid ACPI table header\n", FilePath);
 331         return;
 332     }
 333
 334     if (!AbValidateHeader (&Header1))
 335     {
 336         return;
 337     }
 338
 339     AbPrintHeaderInfo (&Header1);
 340 }
 341
 342
 343 /******************************************************************************
 344  *
 345  * FUNCTION:    AbComputeChecksum
 346  *
 347  * DESCRIPTION: Compute proper checksum for an ACPI table
 348  *
 349  ******************************************************************************/
 350
 351 void
 352 AbComputeChecksum (
 353     char                    *FilePath)
 354 {
 355     UINT32                  Actual;
 356     ACPI_TABLE_HEADER       *Table;
 357     UINT8                   Checksum;
 358     FILE                    *File;
 359
 360
 361     File = fopen (FilePath, "rb");
 362     if (!File)
 363     {
 364         printf ("Could not open file %s\n", FilePath);
 365         return;
 366     }
 367
 368     Actual = fread (&Header1, 1, sizeof (ACPI_TABLE_HEADER), File);
 369     if (Actual < sizeof (ACPI_TABLE_HEADER))
 370     {
 371         printf ("File %s does not contain a valid ACPI table header\n", FilePath);
 372         goto Exit1;
 373     }
 374
 375     if (!AbValidateHeader (&Header1))
 376     {
 377         goto Exit1;
 378     }
 379
 380     if (!Gbl_TerseMode)
 381     {
 382         AbPrintHeaderInfo (&Header1);
 383     }
 384
 385     /* Allocate a buffer to hold the entire table */
 386
 387     Table = AcpiOsAllocate (Header1.Length);
 388     if (!Table)
 389     {
 390         printf ("Could not allocate buffer for table\n");
 391         goto Exit1;
 392     }
 393
 394     /* Read the entire table, including header */
 395
 396     fseek (File, 0, SEEK_SET);
 397     Actual = fread (Table, 1, Header1.Length, File);
 398     if (Actual != Header1.Length)
 399     {
 400         printf ("Could not read table, length %u\n", Header1.Length);
 401         goto Exit2;
 402     }
 403
 404     /* Compute the checksum for the table */
 405
 406     Table->Checksum = 0;
 407
 408     Checksum = (UINT8) (0 - AcpiTbSumTable (Table, Table->Length));
 409     printf ("Computed checksum: 0x%X\n\n", Checksum);
 410
 411     if (Header1.Checksum == Checksum)
 412     {
 413         printf ("Checksum OK in AML file, not updating\n");
 414         goto Exit2;
 415     }
 416
 417     /* Open the target file for writing, to update checksum */
 418
 419     fclose (File);
 420     File = fopen (FilePath, "r+b");
 421     if (!File)
 422     {
 423         printf ("Could not open file %s for writing\n", FilePath);
 424         goto Exit2;
 425     }
 426
 427     /* Set the checksum, write the new header */
 428
 429     Header1.Checksum = Checksum;
 430
 431     Actual = fwrite (&Header1, 1, sizeof (ACPI_TABLE_HEADER), File);
 432     if (Actual != sizeof (ACPI_TABLE_HEADER))
 433     {
 434         printf ("Could not write updated table header\n");
 435         goto Exit2;
 436     }
 437
 438     printf ("Wrote new checksum\n");
 439
 440 Exit2:
 441     AcpiOsFree (Table);
 442
 443 Exit1:
 444     if (File)
 445     {
 446         fclose (File);
 447     }
 448     return;
 449 }
 450
 451
 452 /******************************************************************************
 453  *
 454  * FUNCTION:    AbCompareAmlFiles
 455  *
 456  * DESCRIPTION: Compare two AML files
 457  *
 458  ******************************************************************************/
 459
 460 int
 461 AbCompareAmlFiles (
 462     char                    *File1Path,
 463     char                    *File2Path)
 464 {
 465     UINT32                  Actual1;
 466     UINT32                  Actual2;
 467     UINT32                  Offset;
 468     UINT8                   Char1;
 469     UINT8                   Char2;
 470     UINT8                   Mismatches = 0;
 471     BOOLEAN                 HeaderMismatch = FALSE;
 472     FILE                    *File1;
 473     FILE                    *File2;
 474     int                     Status = -1;
 475
 476
 477     File1 = fopen (File1Path, "rb");
 478     if (!File1)
 479     {
 480         printf ("Could not open file %s\n", File1Path);
 481         return (-1);
 482     }
 483
 484     File2 = fopen (File2Path, "rb");
 485     if (!File2)
 486     {
 487         printf ("Could not open file %s\n", File2Path);
 488         goto Exit1;
 489     }
 490
 491     /* Read the ACPI header from each file */
 492
 493     Actual1 = fread (&Header1, 1, sizeof (ACPI_TABLE_HEADER), File1);
 494     if (Actual1 != sizeof (ACPI_TABLE_HEADER))
 495     {
 496         printf ("File %s does not contain an ACPI table header\n", File1Path);
 497         goto Exit2;
 498     }
 499
 500     Actual2 = fread (&Header2, 1, sizeof (ACPI_TABLE_HEADER), File2);
 501     if (Actual2 != sizeof (ACPI_TABLE_HEADER))
 502     {
 503         printf ("File %s does not contain an ACPI table header\n", File2Path);
 504         goto Exit2;
 505     }
 506
 507     if ((!AbValidateHeader (&Header1)) ||
 508         (!AbValidateHeader (&Header2)))
 509     {
 510         goto Exit2;
 511     }
 512
 513     /* Table signatures must match */
 514
 515     if (*((UINT32 *) Header1.Signature) != *((UINT32 *) Header2.Signature))
 516     {
 517         printf ("Table signatures do not match\n");
 518         goto Exit2;
 519     }
 520
 521     if (!Gbl_TerseMode)
 522     {
 523         /* Display header information */
 524
 525         printf ("Comparing %s to %s\n", File1Path, File2Path);
 526         AbPrintHeadersInfo (&Header1, &Header2);
 527     }
 528
 529     if (memcmp (&Header1, &Header2, sizeof (ACPI_TABLE_HEADER)))
 530     {
 531         printf ("Headers do not match exactly\n");
 532         HeaderMismatch = TRUE;
 533     }
 534
 535     /* Do the byte-by-byte compare */
 536
 537     printf ("Compare offset: %u\n", AbGbl_CompareOffset);
 538     if (AbGbl_CompareOffset)
 539     {
 540         if (fseek (File2, AbGbl_CompareOffset, SEEK_CUR))
 541         {
 542             printf ("Seek error on file %s\n", File2Path);
 543             goto Exit2;
 544         }
 545     }
 546
 547     Actual1 = fread (&Char1, 1, 1, File1);
 548     Actual2 = fread (&Char2, 1, 1, File2);
 549     Offset = sizeof (ACPI_TABLE_HEADER);
 550
 551     while ((Actual1 == 1) && (Actual2 == 1))
 552     {
 553         if (Char1 != Char2)
 554         {
 555             printf ("Error - Byte mismatch at offset %8.4X: 0x%2.2X 0x%2.2X\n",
 556                 Offset, Char1, Char2);
 557             Mismatches++;
 558             if ((Mismatches > 100) && (!AbGbl_DisplayAllMiscompares))
 559             {
 560                 printf ("100 Mismatches: Too many mismatches\n");
 561                 goto Exit2;
 562             }
 563         }
 564
 565         Offset++;
 566         Actual1 = fread (&Char1, 1, 1, File1);
 567         Actual2 = fread (&Char2, 1, 1, File2);
 568     }
 569
 570     if (Actual1)
 571     {
 572         printf ("Error - file %s is longer than file %s\n", File1Path, File2Path);
 573         Mismatches++;
 574     }
 575     else if (Actual2)
 576     {
 577         printf ("Error - file %s is shorter than file %s\n", File1Path, File2Path);
 578         Mismatches++;
 579     }
 580     else if (!Mismatches)
 581     {
 582         if (HeaderMismatch)
 583         {
 584             printf ("Files compare exactly after header\n");
 585         }
 586         else
 587         {
 588             printf ("Files compare exactly\n");
 589         }
 590     }
 591
 592     printf ("%u Mismatches found\n", Mismatches);
 593     if (Mismatches == 0)
 594     {
 595         Status = 0;
 596     }
 597
 598 Exit2:
 599     fclose (File2);
 600
 601 Exit1:
 602     fclose (File1);
 603     return (Status);
 604 }
 605
 606
 607 /******************************************************************************
 608  *
 609  * FUNCTION:    AbGetFile
 610  *
 611  * DESCRIPTION: Open a file and read it entirely into a new buffer
 612  *
 613  ******************************************************************************/
 614
 615 static char *
 616 AbGetFile (
 617     char                    *Filename,
 618     UINT32                  *FileSize)
 619 {
 620     FILE                    *File;
 621     UINT32                  Size;
 622     char                    *DataBuffer = NULL;
 623     size_t                  Actual;
 624
 625
 626     /* Binary mode does not alter CR/LF pairs */
 627
 628     File = fopen (Filename, "rb");
 629     if (!File)
 630     {
 631         printf ("Could not open file %s\n", Filename);
 632         return (NULL);
 633     }
 634
 635     /* Need file size to allocate a buffer */
 636
 637     Size = CmGetFileSize (File);
 638     if (Size == ACPI_UINT32_MAX)
 639     {
 640         printf ("Could not get file size (seek) for %s\n", Filename);
 641         goto ErrorExit;
 642     }
 643
 644     /* Allocate a buffer for the entire file */
 645
 646     DataBuffer = calloc (Size, 1);
 647     if (!DataBuffer)
 648     {
 649         printf ("Could not allocate buffer of size %u\n", Size);
 650         goto ErrorExit;
 651     }
 652
 653     /* Read the entire file */
 654
 655     Actual = fread (DataBuffer, 1, Size, File);
 656     if (Actual != Size)
 657     {
 658         printf ("Could not read the input file %s\n", Filename);
 659         free (DataBuffer);
 660         DataBuffer = NULL;
 661         goto ErrorExit;
 662     }
 663
 664     *FileSize = Size;
 665
 666 ErrorExit:
 667     fclose (File);
 668     return (DataBuffer);
 669 }
 670
 671
 672 /******************************************************************************
 673  *
 674  * FUNCTION:    AbDumpAmlFile
 675  *
 676  * DESCRIPTION: Dump a binary AML file to a text file
 677  *
 678  ******************************************************************************/
 679
 680 int
 681 AbDumpAmlFile (
 682     char                    *File1Path,
 683     char                    *File2Path)
 684 {
 685     char                    *FileBuffer;
 686     FILE                    *FileOutHandle;
 687     UINT32                  FileSize = 0;
 688     int                     Status = -1;
 689
 690
 691     /* Get the entire AML file, validate header */
 692
 693     FileBuffer = AbGetFile (File1Path, &FileSize);
 694     if (!FileBuffer)
 695     {
 696         return (-1);
 697     }
 698
 699     printf ("Input file:  %s contains %u (0x%X) bytes\n",
 700         File1Path, FileSize, FileSize);
 701
 702     FileOutHandle = fopen (File2Path, "wb");
 703     if (!FileOutHandle)
 704     {
 705         printf ("Could not open file %s\n", File2Path);
 706         goto Exit1;
 707     }
 708
 709     if (!AbValidateHeader ((ACPI_TABLE_HEADER *) FileBuffer))
 710     {
 711         goto Exit2;
 712     }
 713
 714     /* Convert binary AML to text, using common dump buffer routine */
 715
 716     AcpiGbl_DebugFile = FileOutHandle;
 717     AcpiGbl_DbOutputFlags = ACPI_DB_REDIRECTABLE_OUTPUT;
 718
 719     AcpiOsPrintf ("%4.4s @ 0x%8.8X\n",
 720         ((ACPI_TABLE_HEADER *) FileBuffer)->Signature, 0);
 721
 722     AcpiUtDumpBuffer ((UINT8 *) FileBuffer, FileSize, DB_BYTE_DISPLAY, 0);
 723
 724     /* Summary for the output file */
 725
 726     FileSize = CmGetFileSize (FileOutHandle);
 727     printf ("Output file: %s contains %u (0x%X) bytes\n\n",
 728         File2Path, FileSize, FileSize);
 729
 730     Status = 0;
 731
 732 Exit2:
 733     fclose (FileOutHandle);
 734
 735 Exit1:
 736     free (FileBuffer);
 737     return (Status);
 738 }