sys/contrib/dev/acpica/dbfileio.c

   1 /*******************************************************************************
   2  *
   3  * Module Name: dbfileio - Debugger file I/O commands.  These can't usually
   4  *              be used when running the debugger in Ring 0 (Kernel mode)
   5  *              $Revision: 76 $
   6  *
   7  ******************************************************************************/
   8
   9 /******************************************************************************
  10  *
  11  * 1. Copyright Notice
  12  *
  13  * Some or all of this work - Copyright (c) 1999 - 2005, Intel Corp.
  14  * All rights reserved.
  15  *
  16  * 2. License
  17  *
  18  * 2.1. This is your license from Intel Corp. under its intellectual property
  19  * rights.  You may have additional license terms from the party that provided
  20  * you this software, covering your right to use that party's intellectual
  21  * property rights.
  22  *
  23  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  24  * copy of the source code appearing in this file ("Covered Code") an
  25  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  26  * base code distributed originally by Intel ("Original Intel Code") to copy,
  27  * make derivatives, distribute, use and display any portion of the Covered
  28  * Code in any form, with the right to sublicense such rights; and
  29  *
  30  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  31  * license (with the right to sublicense), under only those claims of Intel
  32  * patents that are infringed by the Original Intel Code, to make, use, sell,
  33  * offer to sell, and import the Covered Code and derivative works thereof
  34  * solely to the minimum extent necessary to exercise the above copyright
  35  * license, and in no event shall the patent license extend to any additions
  36  * to or modifications of the Original Intel Code.  No other license or right
  37  * is granted directly or by implication, estoppel or otherwise;
  38  *
  39  * The above copyright and patent license is granted only if the following
  40  * conditions are met:
  41  *
  42  * 3. Conditions
  43  *
  44  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  45  * Redistribution of source code of any substantial portion of the Covered
  46  * Code or modification with rights to further distribute source must include
  47  * the above Copyright Notice, the above License, this list of Conditions,
  48  * and the following Disclaimer and Export Compliance provision.  In addition,
  49  * Licensee must cause all Covered Code to which Licensee contributes to
  50  * contain a file documenting the changes Licensee made to create that Covered
  51  * Code and the date of any change.  Licensee must include in that file the
  52  * documentation of any changes made by any predecessor Licensee.  Licensee
  53  * must include a prominent statement that the modification is derived,
  54  * directly or indirectly, from Original Intel Code.
  55  *
  56  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  57  * Redistribution of source code of any substantial portion of the Covered
  58  * Code or modification without rights to further distribute source must
  59  * include the following Disclaimer and Export Compliance provision in the
  60  * documentation and/or other materials provided with distribution.  In
  61  * addition, Licensee may not authorize further sublicense of source of any
  62  * portion of the Covered Code, and must include terms to the effect that the
  63  * license from Licensee to its licensee is limited to the intellectual
  64  * property embodied in the software Licensee provides to its licensee, and
  65  * not to intellectual property embodied in modifications its licensee may
  66  * make.
  67  *
  68  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  69  * substantial portion of the Covered Code or modification must reproduce the
  70  * above Copyright Notice, and the following Disclaimer and Export Compliance
  71  * provision in the documentation and/or other materials provided with the
  72  * distribution.
  73  *
  74  * 3.4. Intel retains all right, title, and interest in and to the Original
  75  * Intel Code.
  76  *
  77  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  78  * Intel shall be used in advertising or otherwise to promote the sale, use or
  79  * other dealings in products derived from or relating to the Covered Code
  80  * without prior written authorization from Intel.
  81  *
  82  * 4. Disclaimer and Export Compliance
  83  *
  84  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  85  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  86  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  87  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  88  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  89  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  90  * PARTICULAR PURPOSE.
  91  *
  92  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  93  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  94  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  95  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  96  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  97  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  98  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  99  * LIMITED REMEDY.
 100  *
 101  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 102  * software or system incorporating such software without first obtaining any
 103  * required license or other approval from the U. S. Department of Commerce or
 104  * any other agency or department of the United States Government.  In the
 105  * event Licensee exports any such software from the United States or
 106  * re-exports any such software from a foreign destination, Licensee shall
 107  * ensure that the distribution and export/re-export of the software is in
 108  * compliance with all laws, regulations, orders, or other restrictions of the
 109  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 110  * any of its subsidiaries will export/re-export any technical data, process,
 111  * software, or service, directly or indirectly, to any country for which the
 112  * United States government or any agency thereof requires an export license,
 113  * other governmental approval, or letter of assurance, without first obtaining
 114  * such license, approval or letter.
 115  *
 116  *****************************************************************************/
 117
 118
 119 #include <contrib/dev/acpica/acpi.h>
 120 #include <contrib/dev/acpica/acdebug.h>
 121 #include <contrib/dev/acpica/acnamesp.h>
 122 #include <contrib/dev/acpica/actables.h>
 123
 124 #if (defined ACPI_DEBUGGER || defined ACPI_DISASSEMBLER)
 125
 126 #define _COMPONENT          ACPI_CA_DEBUGGER
 127         ACPI_MODULE_NAME    ("dbfileio")
 128
 129 /*
 130  * NOTE: this is here for lack of a better place.  It is used in all
 131  * flavors of the debugger, need LCD file
 132  */
 133 #ifdef ACPI_APPLICATION
 134 #include <stdio.h>
 135 FILE                        *AcpiGbl_DebugFile = NULL;
 136 #endif
 137
 138
 139 #ifdef ACPI_DEBUGGER
 140
 141 /* Local prototypes */
 142
 143 #ifdef ACPI_APPLICATION
 144
 145 static ACPI_STATUS
 146 AcpiDbCheckTextModeCorruption (
 147     UINT8                   *Table,
 148     UINT32                  TableLength,
 149     UINT32                  FileLength);
 150
 151 static ACPI_STATUS
 152 AeLocalLoadTable (
 153     ACPI_TABLE_HEADER       *TablePtr);
 154
 155 #endif
 156
 157 /*******************************************************************************
 158  *
 159  * FUNCTION:    AcpiDbCloseDebugFile
 160  *
 161  * PARAMETERS:  None
 162  *
 163  * RETURN:      None
 164  *
 165  * DESCRIPTION: If open, close the current debug output file
 166  *
 167  ******************************************************************************/
 168
 169 void
 170 AcpiDbCloseDebugFile (
 171     void)
 172 {
 173
 174 #ifdef ACPI_APPLICATION
 175
 176     if (AcpiGbl_DebugFile)
 177     {
 178        fclose (AcpiGbl_DebugFile);
 179        AcpiGbl_DebugFile = NULL;
 180        AcpiGbl_DbOutputToFile = FALSE;
 181        AcpiOsPrintf ("Debug output file %s closed\n", AcpiGbl_DbDebugFilename);
 182     }
 183 #endif
 184 }
 185
 186
 187 /*******************************************************************************
 188  *
 189  * FUNCTION:    AcpiDbOpenDebugFile
 190  *
 191  * PARAMETERS:  Name                - Filename to open
 192  *
 193  * RETURN:      None
 194  *
 195  * DESCRIPTION: Open a file where debug output will be directed.
 196  *
 197  ******************************************************************************/
 198
 199 void
 200 AcpiDbOpenDebugFile (
 201     char                    *Name)
 202 {
 203
 204 #ifdef ACPI_APPLICATION
 205
 206     AcpiDbCloseDebugFile ();
 207     AcpiGbl_DebugFile = fopen (Name, "w+");
 208     if (AcpiGbl_DebugFile)
 209     {
 210         AcpiOsPrintf ("Debug output file %s opened\n", Name);
 211         ACPI_STRCPY (AcpiGbl_DbDebugFilename, Name);
 212         AcpiGbl_DbOutputToFile = TRUE;
 213     }
 214     else
 215     {
 216         AcpiOsPrintf ("Could not open debug file %s\n", Name);
 217     }
 218
 219 #endif
 220 }
 221 #endif
 222
 223
 224 #ifdef ACPI_APPLICATION
 225 /*******************************************************************************
 226  *
 227  * FUNCTION:    AcpiDbCheckTextModeCorruption
 228  *
 229  * PARAMETERS:  Table           - Table buffer
 230  *              TableLength     - Length of table from the table header
 231  *              FileLength      - Length of the file that contains the table
 232  *
 233  * RETURN:      Status
 234  *
 235  * DESCRIPTION: Check table for text mode file corruption where all linefeed
 236  *              characters (LF) have been replaced by carriage return linefeed
 237  *              pairs (CR/LF).
 238  *
 239  ******************************************************************************/
 240
 241 static ACPI_STATUS
 242 AcpiDbCheckTextModeCorruption (
 243     UINT8                   *Table,
 244     UINT32                  TableLength,
 245     UINT32                  FileLength)
 246 {
 247     UINT32                  i;
 248     UINT32                  Pairs = 0;
 249
 250
 251     if (TableLength != FileLength)
 252     {
 253         ACPI_REPORT_WARNING ((
 254             "File length (0x%X) is not the same as the table length (0x%X)\n",
 255             FileLength, TableLength));
 256     }
 257
 258     /* Scan entire table to determine if each LF has been prefixed with a CR */
 259
 260     for (i = 1; i < FileLength; i++)
 261     {
 262         if (Table[i] == 0x0A)
 263         {
 264             if (Table[i - 1] != 0x0D)
 265             {
 266                 /* The LF does not have a preceeding CR, table not corrupted */
 267
 268                 return (AE_OK);
 269             }
 270             else
 271             {
 272                 /* Found a CR/LF pair */
 273
 274                 Pairs++;
 275             }
 276             i++;
 277         }
 278     }
 279
 280     /*
 281      * Entire table scanned, each CR is part of a CR/LF pair --
 282      * meaning that the table was treated as a text file somewhere.
 283      *
 284      * NOTE: We can't "fix" the table, because any existing CR/LF pairs in the
 285      * original table are left untouched by the text conversion process --
 286      * meaning that we cannot simply replace CR/LF pairs with LFs.
 287      */
 288     AcpiOsPrintf ("Table has been corrupted by text mode conversion\n");
 289     AcpiOsPrintf ("All LFs (%d) were changed to CR/LF pairs\n", Pairs);
 290     AcpiOsPrintf ("Table cannot be repaired!\n");
 291     return (AE_BAD_VALUE);
 292 }
 293
 294
 295 /*******************************************************************************
 296  *
 297  * FUNCTION:    AcpiDbReadTable
 298  *
 299  * PARAMETERS:  fp              - File that contains table
 300  *              Table           - Return value, buffer with table
 301  *              TableLength     - Return value, length of table
 302  *
 303  * RETURN:      Status
 304  *
 305  * DESCRIPTION: Load the DSDT from the file pointer
 306  *
 307  ******************************************************************************/
 308
 309 static ACPI_STATUS
 310 AcpiDbReadTable (
 311     FILE                    *fp,
 312     ACPI_TABLE_HEADER       **Table,
 313     UINT32                  *TableLength)
 314 {
 315     ACPI_TABLE_HEADER       TableHeader;
 316     UINT32                  Actual;
 317     ACPI_STATUS             Status;
 318     UINT32                  FileSize;
 319
 320
 321     fseek (fp, 0, SEEK_END);
 322     FileSize = (UINT32) ftell (fp);
 323     fseek (fp, 0, SEEK_SET);
 324
 325     /* Read the table header */
 326
 327     if (fread (&TableHeader, 1, sizeof (TableHeader), fp) !=
 328             sizeof (ACPI_TABLE_HEADER))
 329     {
 330         AcpiOsPrintf ("Could not read the table header\n");
 331         return (AE_BAD_HEADER);
 332     }
 333
 334     /* Validate the table header/length */
 335
 336     Status = AcpiTbValidateTableHeader (&TableHeader);
 337     if (ACPI_FAILURE (Status))
 338     {
 339         AcpiOsPrintf ("Table header is invalid!\n");
 340         return (Status);
 341     }
 342
 343     /* File size must be at least as long as the Header-specified length */
 344
 345     if (TableHeader.Length > FileSize)
 346     {
 347         AcpiOsPrintf (
 348             "TableHeader length [0x%X] greater than the input file size [0x%X]\n",
 349             TableHeader.Length, FileSize);
 350         return (AE_BAD_HEADER);
 351     }
 352
 353     /* We only support a limited number of table types */
 354
 355     if (ACPI_STRNCMP ((char *) TableHeader.Signature, DSDT_SIG, 4) &&
 356         ACPI_STRNCMP ((char *) TableHeader.Signature, PSDT_SIG, 4) &&
 357         ACPI_STRNCMP ((char *) TableHeader.Signature, SSDT_SIG, 4))
 358     {
 359         AcpiOsPrintf ("Table signature [%4.4s] is invalid or not supported\n",
 360             (char *) TableHeader.Signature);
 361         ACPI_DUMP_BUFFER (&TableHeader, sizeof (ACPI_TABLE_HEADER));
 362         return (AE_ERROR);
 363     }
 364
 365     /* Allocate a buffer for the table */
 366
 367     *TableLength = TableHeader.Length;
 368     *Table = AcpiOsAllocate ((size_t) (FileSize));
 369     if (!*Table)
 370     {
 371         AcpiOsPrintf (
 372             "Could not allocate memory for ACPI table %4.4s (size=0x%X)\n",
 373             TableHeader.Signature, TableHeader.Length);
 374         return (AE_NO_MEMORY);
 375     }
 376
 377     /* Get the rest of the table */
 378
 379     fseek (fp, 0, SEEK_SET);
 380     Actual = fread (*Table, 1, (size_t) FileSize, fp);
 381     if (Actual == FileSize)
 382     {
 383         /* Now validate the checksum */
 384
 385         Status = AcpiTbVerifyTableChecksum (*Table);
 386
 387         if (Status == AE_BAD_CHECKSUM)
 388         {
 389             Status = AcpiDbCheckTextModeCorruption ((UINT8 *) *Table,
 390                         FileSize, (*Table)->Length);
 391             return (Status);
 392         }
 393         return (AE_OK);
 394     }
 395
 396     if (Actual > 0)
 397     {
 398         AcpiOsPrintf ("Warning - reading table, asked for %X got %X\n",
 399             FileSize, Actual);
 400         return (AE_OK);
 401     }
 402
 403     AcpiOsPrintf ("Error - could not read the table file\n");
 404     AcpiOsFree (*Table);
 405     *Table = NULL;
 406     *TableLength = 0;
 407
 408     return (AE_ERROR);
 409 }
 410
 411
 412 /*******************************************************************************
 413  *
 414  * FUNCTION:    AeLocalLoadTable
 415  *
 416  * PARAMETERS:  Table           - pointer to a buffer containing the entire
 417  *                                table to be loaded
 418  *
 419  * RETURN:      Status
 420  *
 421  * DESCRIPTION: This function is called to load a table from the caller's
 422  *              buffer.  The buffer must contain an entire ACPI Table including
 423  *              a valid header.  The header fields will be verified, and if it
 424  *              is determined that the table is invalid, the call will fail.
 425  *
 426  ******************************************************************************/
 427
 428 static ACPI_STATUS
 429 AeLocalLoadTable (
 430     ACPI_TABLE_HEADER       *Table)
 431 {
 432     ACPI_STATUS             Status;
 433     ACPI_TABLE_DESC         TableInfo;
 434
 435
 436     ACPI_FUNCTION_TRACE ("AeLocalLoadTable");
 437
 438
 439     if (!Table)
 440     {
 441         return_ACPI_STATUS (AE_BAD_PARAMETER);
 442     }
 443
 444     TableInfo.Pointer = Table;
 445     Status = AcpiTbRecognizeTable (&TableInfo, ACPI_TABLE_ALL);
 446     if (ACPI_FAILURE (Status))
 447     {
 448         return_ACPI_STATUS (Status);
 449     }
 450
 451     /* Install the new table into the local data structures */
 452
 453     Status = AcpiTbInstallTable (&TableInfo);
 454     if (ACPI_FAILURE (Status))
 455     {
 456         if (Status == AE_ALREADY_EXISTS)
 457         {
 458             /* Table already exists, no error */
 459
 460             Status = AE_OK;
 461         }
 462
 463         /* Free table allocated by AcpiTbGetTable */
 464
 465         AcpiTbDeleteSingleTable (&TableInfo);
 466         return_ACPI_STATUS (Status);
 467     }
 468
 469 #if (!defined (ACPI_NO_METHOD_EXECUTION) && !defined (ACPI_CONSTANT_EVAL_ONLY))
 470
 471     Status = AcpiNsLoadTable (TableInfo.InstalledDesc, AcpiGbl_RootNode);
 472     if (ACPI_FAILURE (Status))
 473     {
 474         /* Uninstall table and free the buffer */
 475
 476         AcpiTbDeleteTablesByType (ACPI_TABLE_DSDT);
 477         return_ACPI_STATUS (Status);
 478     }
 479 #endif
 480
 481     return_ACPI_STATUS (Status);
 482 }
 483
 484
 485 /*******************************************************************************
 486  *
 487  * FUNCTION:    AcpiDbReadTableFromFile
 488  *
 489  * PARAMETERS:  Filename         - File where table is located
 490  *              Table            - Where a pointer to the table is returned
 491  *
 492  * RETURN:      Status
 493  *
 494  * DESCRIPTION: Get an ACPI table from a file
 495  *
 496  ******************************************************************************/
 497
 498 ACPI_STATUS
 499 AcpiDbReadTableFromFile (
 500     char                    *Filename,
 501     ACPI_TABLE_HEADER       **Table)
 502 {
 503     FILE                    *fp;
 504     UINT32                  TableLength;
 505     ACPI_STATUS             Status;
 506
 507
 508     /* Open the file */
 509
 510     fp = fopen (Filename, "rb");
 511     if (!fp)
 512     {
 513         AcpiOsPrintf ("Could not open input file %s\n", Filename);
 514         return (AE_ERROR);
 515     }
 516
 517     /* Get the entire file */
 518
 519     fprintf (stderr, "Loading Acpi table from file %s\n", Filename);
 520     Status = AcpiDbReadTable (fp, Table, &TableLength);
 521     fclose(fp);
 522
 523     if (ACPI_FAILURE (Status))
 524     {
 525         AcpiOsPrintf ("Could not get table from the file\n");
 526         return (Status);
 527     }
 528
 529     return (AE_OK);
 530  }
 531 #endif
 532
 533
 534 /*******************************************************************************
 535  *
 536  * FUNCTION:    AcpiDbGetTableFromFile
 537  *
 538  * PARAMETERS:  Filename        - File where table is located
 539  *              ReturnTable     - Where a pointer to the table is returned
 540  *
 541  * RETURN:      Status
 542  *
 543  * DESCRIPTION: Load an ACPI table from a file
 544  *
 545  ******************************************************************************/
 546
 547 ACPI_STATUS
 548 AcpiDbGetTableFromFile (
 549     char                    *Filename,
 550     ACPI_TABLE_HEADER       **ReturnTable)
 551 {
 552 #ifdef ACPI_APPLICATION
 553     ACPI_STATUS             Status;
 554     ACPI_TABLE_HEADER       *Table;
 555
 556
 557     Status = AcpiDbReadTableFromFile (Filename, &Table);
 558     if (ACPI_FAILURE (Status))
 559     {
 560         return (Status);
 561     }
 562
 563    /* Attempt to recognize and install the table */
 564
 565     Status = AeLocalLoadTable (Table);
 566     if (ACPI_FAILURE (Status))
 567     {
 568         if (Status == AE_ALREADY_EXISTS)
 569         {
 570             AcpiOsPrintf ("Table %4.4s is already installed\n",
 571                             Table->Signature);
 572         }
 573         else
 574         {
 575             AcpiOsPrintf ("Could not install table, %s\n",
 576                             AcpiFormatException (Status));
 577         }
 578
 579         return (Status);
 580     }
 581
 582     fprintf (stderr, "Acpi table [%4.4s] successfully installed and loaded\n",
 583                                 Table->Signature);
 584
 585     AcpiGbl_AcpiHardwarePresent = FALSE;
 586     if (ReturnTable)
 587     {
 588         *ReturnTable = Table;
 589     }
 590
 591
 592 #endif  /* ACPI_APPLICATION */
 593     return (AE_OK);
 594 }
 595
 596 #endif  /* ACPI_DEBUGGER */
 597