drivers/acpi/components/debugger/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  *
   6  ******************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2015, Intel Corp.
  13  * All rights reserved.
  14  *
  15  * 2. License
  16  *
  17  * 2.1. This is your license from Intel Corp. under its intellectual property
  18  * rights. You may have additional license terms from the party that provided
  19  * you this software, covering your right to use that party's intellectual
  20  * property rights.
  21  *
  22  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  23  * copy of the source code appearing in this file ("Covered Code") an
  24  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  25  * base code distributed originally by Intel ("Original Intel Code") to copy,
  26  * make derivatives, distribute, use and display any portion of the Covered
  27  * Code in any form, with the right to sublicense such rights; and
  28  *
  29  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  30  * license (with the right to sublicense), under only those claims of Intel
  31  * patents that are infringed by the Original Intel Code, to make, use, sell,
  32  * offer to sell, and import the Covered Code and derivative works thereof
  33  * solely to the minimum extent necessary to exercise the above copyright
  34  * license, and in no event shall the patent license extend to any additions
  35  * to or modifications of the Original Intel Code. No other license or right
  36  * is granted directly or by implication, estoppel or otherwise;
  37  *
  38  * The above copyright and patent license is granted only if the following
  39  * conditions are met:
  40  *
  41  * 3. Conditions
  42  *
  43  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  44  * Redistribution of source code of any substantial portion of the Covered
  45  * Code or modification with rights to further distribute source must include
  46  * the above Copyright Notice, the above License, this list of Conditions,
  47  * and the following Disclaimer and Export Compliance provision. In addition,
  48  * Licensee must cause all Covered Code to which Licensee contributes to
  49  * contain a file documenting the changes Licensee made to create that Covered
  50  * Code and the date of any change. Licensee must include in that file the
  51  * documentation of any changes made by any predecessor Licensee. Licensee
  52  * must include a prominent statement that the modification is derived,
  53  * directly or indirectly, from Original Intel Code.
  54  *
  55  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  56  * Redistribution of source code of any substantial portion of the Covered
  57  * Code or modification without rights to further distribute source must
  58  * include the following Disclaimer and Export Compliance provision in the
  59  * documentation and/or other materials provided with distribution. In
  60  * addition, Licensee may not authorize further sublicense of source of any
  61  * portion of the Covered Code, and must include terms to the effect that the
  62  * license from Licensee to its licensee is limited to the intellectual
  63  * property embodied in the software Licensee provides to its licensee, and
  64  * not to intellectual property embodied in modifications its licensee may
  65  * make.
  66  *
  67  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  68  * substantial portion of the Covered Code or modification must reproduce the
  69  * above Copyright Notice, and the following Disclaimer and Export Compliance
  70  * provision in the documentation and/or other materials provided with the
  71  * distribution.
  72  *
  73  * 3.4. Intel retains all right, title, and interest in and to the Original
  74  * Intel Code.
  75  *
  76  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  77  * Intel shall be used in advertising or otherwise to promote the sale, use or
  78  * other dealings in products derived from or relating to the Covered Code
  79  * without prior written authorization from Intel.
  80  *
  81  * 4. Disclaimer and Export Compliance
  82  *
  83  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  84  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  85  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
  86  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
  87  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
  88  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  89  * PARTICULAR PURPOSE.
  90  *
  91  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  92  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  93  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  94  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  95  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  96  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
  97  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  98  * LIMITED REMEDY.
  99  *
 100  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 101  * software or system incorporating such software without first obtaining any
 102  * required license or other approval from the U. S. Department of Commerce or
 103  * any other agency or department of the United States Government. In the
 104  * event Licensee exports any such software from the United States or
 105  * re-exports any such software from a foreign destination, Licensee shall
 106  * ensure that the distribution and export/re-export of the software is in
 107  * compliance with all laws, regulations, orders, or other restrictions of the
 108  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 109  * any of its subsidiaries will export/re-export any technical data, process,
 110  * software, or service, directly or indirectly, to any country for which the
 111  * United States government or any agency thereof requires an export license,
 112  * other governmental approval, or letter of assurance, without first obtaining
 113  * such license, approval or letter.
 114  *
 115  *****************************************************************************/
 116
 117 #include "acpi.h"
 118 #include "accommon.h"
 119 #include "acdebug.h"
 120 #include "actables.h"
 121
 122 #if (defined ACPI_DEBUGGER || defined ACPI_DISASSEMBLER)
 123
 124 #define _COMPONENT          ACPI_CA_DEBUGGER
 125         ACPI_MODULE_NAME    ("dbfileio")
 126
 127 #ifdef ACPI_DEBUGGER
 128
 129 /*******************************************************************************
 130  *
 131  * FUNCTION:    AcpiDbCloseDebugFile
 132  *
 133  * PARAMETERS:  None
 134  *
 135  * RETURN:      None
 136  *
 137  * DESCRIPTION: If open, close the current debug output file
 138  *
 139  ******************************************************************************/
 140
 141 void
 142 AcpiDbCloseDebugFile (
 143     void)
 144 {
 145
 146 #ifdef ACPI_APPLICATION
 147
 148     if (AcpiGbl_DebugFile)
 149     {
 150        fclose (AcpiGbl_DebugFile);
 151        AcpiGbl_DebugFile = NULL;
 152        AcpiGbl_DbOutputToFile = FALSE;
 153        AcpiOsPrintf ("Debug output file %s closed\n", AcpiGbl_DbDebugFilename);
 154     }
 155 #endif
 156 }
 157
 158
 159 /*******************************************************************************
 160  *
 161  * FUNCTION:    AcpiDbOpenDebugFile
 162  *
 163  * PARAMETERS:  Name                - Filename to open
 164  *
 165  * RETURN:      None
 166  *
 167  * DESCRIPTION: Open a file where debug output will be directed.
 168  *
 169  ******************************************************************************/
 170
 171 void
 172 AcpiDbOpenDebugFile (
 173     char                    *Name)
 174 {
 175
 176 #ifdef ACPI_APPLICATION
 177
 178     AcpiDbCloseDebugFile ();
 179     AcpiGbl_DebugFile = fopen (Name, "w+");
 180     if (!AcpiGbl_DebugFile)
 181     {
 182         AcpiOsPrintf ("Could not open debug file %s\n", Name);
 183         return;
 184     }
 185
 186     AcpiOsPrintf ("Debug output file %s opened\n", Name);
 187     ACPI_STRNCPY (AcpiGbl_DbDebugFilename, Name,
 188         sizeof (AcpiGbl_DbDebugFilename));
 189     AcpiGbl_DbOutputToFile = TRUE;
 190
 191 #endif
 192 }
 193 #endif
 194
 195
 196 #ifdef ACPI_APPLICATION
 197 #include "acapps.h"
 198
 199 /*******************************************************************************
 200  *
 201  * FUNCTION:    AeLocalLoadTable
 202  *
 203  * PARAMETERS:  Table           - pointer to a buffer containing the entire
 204  *                                table to be loaded
 205  *
 206  * RETURN:      Status
 207  *
 208  * DESCRIPTION: This function is called to load a table from the caller's
 209  *              buffer. The buffer must contain an entire ACPI Table including
 210  *              a valid header. The header fields will be verified, and if it
 211  *              is determined that the table is invalid, the call will fail.
 212  *
 213  ******************************************************************************/
 214
 215 static ACPI_STATUS
 216 AeLocalLoadTable (
 217     ACPI_TABLE_HEADER       *Table)
 218 {
 219     ACPI_STATUS             Status = AE_OK;
 220 /*    ACPI_TABLE_DESC         TableInfo; */
 221
 222
 223     ACPI_FUNCTION_TRACE (AeLocalLoadTable);
 224 #if 0
 225
 226
 227     if (!Table)
 228     {
 229         return_ACPI_STATUS (AE_BAD_PARAMETER);
 230     }
 231
 232     TableInfo.Pointer = Table;
 233     Status = AcpiTbRecognizeTable (&TableInfo, ACPI_TABLE_ALL);
 234     if (ACPI_FAILURE (Status))
 235     {
 236         return_ACPI_STATUS (Status);
 237     }
 238
 239     /* Install the new table into the local data structures */
 240
 241     Status = AcpiTbInitTableDescriptor (&TableInfo);
 242     if (ACPI_FAILURE (Status))
 243     {
 244         if (Status == AE_ALREADY_EXISTS)
 245         {
 246             /* Table already exists, no error */
 247
 248             Status = AE_OK;
 249         }
 250
 251         /* Free table allocated by AcpiTbGetTable */
 252
 253         AcpiTbDeleteSingleTable (&TableInfo);
 254         return_ACPI_STATUS (Status);
 255     }
 256
 257 #if (!defined (ACPI_NO_METHOD_EXECUTION) && !defined (ACPI_CONSTANT_EVAL_ONLY))
 258
 259     Status = AcpiNsLoadTable (TableInfo.InstalledDesc, AcpiGbl_RootNode);
 260     if (ACPI_FAILURE (Status))
 261     {
 262         /* Uninstall table and free the buffer */
 263
 264         AcpiTbDeleteTablesByType (ACPI_TABLE_ID_DSDT);
 265         return_ACPI_STATUS (Status);
 266     }
 267 #endif
 268 #endif
 269
 270     return_ACPI_STATUS (Status);
 271 }
 272 #endif
 273
 274
 275 /*******************************************************************************
 276  *
 277  * FUNCTION:    AcpiDbGetTableFromFile
 278  *
 279  * PARAMETERS:  Filename        - File where table is located
 280  *              ReturnTable     - Where a pointer to the table is returned
 281  *
 282  * RETURN:      Status
 283  *
 284  * DESCRIPTION: Load an ACPI table from a file
 285  *
 286  ******************************************************************************/
 287
 288 ACPI_STATUS
 289 AcpiDbGetTableFromFile (
 290     char                    *Filename,
 291     ACPI_TABLE_HEADER       **ReturnTable,
 292     BOOLEAN                 MustBeAmlFile)
 293 {
 294 #ifdef ACPI_APPLICATION
 295     ACPI_STATUS             Status;
 296     ACPI_TABLE_HEADER       *Table;
 297     BOOLEAN                 IsAmlTable = TRUE;
 298
 299
 300     Status = AcpiUtReadTableFromFile (Filename, &Table);
 301     if (ACPI_FAILURE (Status))
 302     {
 303         return (Status);
 304     }
 305
 306     if (MustBeAmlFile)
 307     {
 308         IsAmlTable = AcpiUtIsAmlTable (Table);
 309         if (!IsAmlTable)
 310         {
 311             ACPI_EXCEPTION ((AE_INFO, AE_OK,
 312                 "Input for -e is not an AML table: "
 313                 "\"%4.4s\" (must be DSDT/SSDT)",
 314                 Table->Signature));
 315             return (AE_TYPE);
 316         }
 317     }
 318
 319     if (IsAmlTable)
 320     {
 321         /* Attempt to recognize and install the table */
 322
 323         Status = AeLocalLoadTable (Table);
 324         if (ACPI_FAILURE (Status))
 325         {
 326             if (Status == AE_ALREADY_EXISTS)
 327             {
 328                 AcpiOsPrintf ("Table %4.4s is already installed\n",
 329                     Table->Signature);
 330             }
 331             else
 332             {
 333                 AcpiOsPrintf ("Could not install table, %s\n",
 334                     AcpiFormatException (Status));
 335             }
 336
 337             return (Status);
 338         }
 339
 340         AcpiTbPrintTableHeader (0, Table);
 341
 342         fprintf (stderr,
 343             "Acpi table [%4.4s] successfully installed and loaded\n",
 344             Table->Signature);
 345     }
 346
 347     AcpiGbl_AcpiHardwarePresent = FALSE;
 348     if (ReturnTable)
 349     {
 350         *ReturnTable = Table;
 351     }
 352
 353
 354 #endif  /* ACPI_APPLICATION */
 355     return (AE_OK);
 356 }
 357
 358 #endif  /* ACPI_DEBUGGER */