dbfileio.c revision 83174
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: 47 $ 6 * 7 ******************************************************************************/ 8 9/****************************************************************************** 10 * 11 * 1. Copyright Notice 12 * 13 * Some or all of this work - Copyright (c) 1999, 2000, 2001, 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 "acpi.h" 120#include "acdebug.h" 121#include "acnamesp.h" 122#include "acparser.h" 123#include "acevents.h" 124#include "actables.h" 125 126#ifdef ENABLE_DEBUGGER 127 128#define _COMPONENT ACPI_DEBUGGER 129 MODULE_NAME ("dbfileio") 130 131 132#ifdef ACPI_APPLICATION 133#include <stdio.h> 134FILE *AcpiGbl_DebugFile = NULL; 135#endif 136 137 138/* 139 * NOTE: this is here for lack of a better place. It is used in all 140 * flavors of the debugger, need LCD file 141 */ 142 143/******************************************************************************* 144 * 145 * FUNCTION: AcpiDbMatchArgument 146 * 147 * PARAMETERS: UserArgument - User command line 148 * Arguments - Array of commands to match against 149 * 150 * RETURN: Index into command array or ACPI_TYPE_NOT_FOUND if not found 151 * 152 * DESCRIPTION: Search command array for a command match 153 * 154 ******************************************************************************/ 155 156ACPI_OBJECT_TYPE8 157AcpiDbMatchArgument ( 158 NATIVE_CHAR *UserArgument, 159 ARGUMENT_INFO *Arguments) 160{ 161 UINT32 i; 162 163 164 if (!UserArgument || UserArgument[0] == 0) 165 { 166 return (ACPI_TYPE_NOT_FOUND); 167 } 168 169 for (i = 0; Arguments[i].Name; i++) 170 { 171 if (STRSTR (Arguments[i].Name, UserArgument) == Arguments[i].Name) 172 { 173 return ((ACPI_OBJECT_TYPE8) i); 174 } 175 } 176 177 /* Argument not recognized */ 178 179 return (ACPI_TYPE_NOT_FOUND); 180} 181 182 183/******************************************************************************* 184 * 185 * FUNCTION: AcpiDbCloseDebugFile 186 * 187 * PARAMETERS: None 188 * 189 * RETURN: Status 190 * 191 * DESCRIPTION: If open, close the current debug output file 192 * 193 ******************************************************************************/ 194 195void 196AcpiDbCloseDebugFile ( 197 void) 198{ 199 200#ifdef ACPI_APPLICATION 201 202 if (AcpiGbl_DebugFile) 203 { 204 fclose (AcpiGbl_DebugFile); 205 AcpiGbl_DebugFile = NULL; 206 AcpiGbl_DbOutputToFile = FALSE; 207 AcpiOsPrintf ("Debug output file %s closed\n", AcpiGbl_DbDebugFilename); 208 } 209#endif 210 211} 212 213 214/******************************************************************************* 215 * 216 * FUNCTION: AcpiDbOpenDebugFile 217 * 218 * PARAMETERS: Name - Filename to open 219 * 220 * RETURN: Status 221 * 222 * DESCRIPTION: Open a file where debug output will be directed. 223 * 224 ******************************************************************************/ 225 226void 227AcpiDbOpenDebugFile ( 228 NATIVE_CHAR *Name) 229{ 230 231#ifdef ACPI_APPLICATION 232 233 AcpiDbCloseDebugFile (); 234 AcpiGbl_DebugFile = fopen (Name, "w+"); 235 if (AcpiGbl_DebugFile) 236 { 237 AcpiOsPrintf ("Debug output file %s opened\n", Name); 238 STRCPY (AcpiGbl_DbDebugFilename, Name); 239 AcpiGbl_DbOutputToFile = TRUE; 240 } 241 else 242 { 243 AcpiOsPrintf ("Could not open debug file %s\n", Name); 244 } 245 246#endif 247} 248 249 250#ifdef ACPI_APPLICATION 251/******************************************************************************* 252 * 253 * FUNCTION: AcpiDbLoadTable 254 * 255 * PARAMETERS: fp - File that contains table 256 * TablePtr - Return value, buffer with table 257 * TableLenght - Return value, length of table 258 * 259 * RETURN: Status 260 * 261 * DESCRIPTION: Load the DSDT from the file pointer 262 * 263 ******************************************************************************/ 264 265ACPI_STATUS 266AcpiDbLoadTable( 267 FILE *fp, 268 ACPI_TABLE_HEADER **TablePtr, 269 UINT32 *TableLength) 270{ 271 ACPI_TABLE_HEADER TableHeader; 272 UINT8 *AmlPtr; 273 UINT32 AmlLength; 274 UINT32 Actual; 275 ACPI_STATUS Status; 276 277 278 /* Read the table header */ 279 280 if (fread (&TableHeader, 1, sizeof (TableHeader), fp) != sizeof (ACPI_TABLE_HEADER)) 281 { 282 AcpiOsPrintf ("Couldn't read the table header\n"); 283 return (AE_BAD_SIGNATURE); 284 } 285 286 287 /* Validate the table header/length */ 288 289 Status = AcpiTbValidateTableHeader (&TableHeader); 290 if ((ACPI_FAILURE (Status)) || 291 (TableHeader.Length > 524288)) /* 1/2 Mbyte should be enough */ 292 { 293 AcpiOsPrintf ("Table header is invalid!\n"); 294 return (AE_ERROR); 295 } 296 297 298 /* We only support a limited number of table types */ 299 300 if (STRNCMP ((char *) TableHeader.Signature, DSDT_SIG, 4) && 301 STRNCMP ((char *) TableHeader.Signature, PSDT_SIG, 4) && 302 STRNCMP ((char *) TableHeader.Signature, SSDT_SIG, 4)) 303 { 304 AcpiOsPrintf ("Table signature is invalid\n"); 305 DUMP_BUFFER (&TableHeader, sizeof (ACPI_TABLE_HEADER)); 306 return (AE_ERROR); 307 } 308 309 /* Allocate a buffer for the table */ 310 311 *TableLength = TableHeader.Length; 312 *TablePtr = ACPI_MEM_ALLOCATE ((size_t) *TableLength); 313 if (!*TablePtr) 314 { 315 AcpiOsPrintf ("Could not allocate memory for ACPI table %4.4s (size=%X)\n", 316 TableHeader.Signature, TableHeader.Length); 317 return (AE_NO_MEMORY); 318 } 319 320 321 AmlPtr = (UINT8 *) *TablePtr + sizeof (TableHeader); 322 AmlLength = *TableLength - sizeof (TableHeader); 323 324 /* Copy the header to the buffer */ 325 326 MEMCPY (*TablePtr, &TableHeader, sizeof (TableHeader)); 327 328 /* Get the rest of the table */ 329 330 Actual = fread (AmlPtr, 1, (size_t) AmlLength, fp); 331 if (Actual == AmlLength) 332 { 333 return (AE_OK); 334 } 335 336 if (Actual > 0) 337 { 338 AcpiOsPrintf ("Warning - reading table, asked for %X got %X\n", AmlLength, Actual); 339 return (AE_OK); 340 } 341 342 343 AcpiOsPrintf ("Error - could not read the table file\n"); 344 ACPI_MEM_FREE (*TablePtr); 345 *TablePtr = NULL; 346 *TableLength = 0; 347 348 return (AE_ERROR); 349} 350#endif 351 352 353/******************************************************************************* 354 * 355 * FUNCTION: AeLocalLoadTable 356 * 357 * PARAMETERS: TablePtr - pointer to a buffer containing the entire 358 * table to be loaded 359 * 360 * RETURN: Status 361 * 362 * DESCRIPTION: This function is called to load a table from the caller's 363 * buffer. The buffer must contain an entire ACPI Table including 364 * a valid header. The header fields will be verified, and if it 365 * is determined that the table is invalid, the call will fail. 366 * 367 * If the call fails an appropriate status will be returned. 368 * 369 ******************************************************************************/ 370 371ACPI_STATUS 372AeLocalLoadTable ( 373 ACPI_TABLE_HEADER *TablePtr) 374{ 375 ACPI_STATUS Status; 376 ACPI_TABLE_DESC TableInfo; 377 378 379 FUNCTION_TRACE ("AeLocalLoadTable"); 380 381 if (!TablePtr) 382 { 383 return_ACPI_STATUS (AE_BAD_PARAMETER); 384 } 385 386 /* Install the new table into the local data structures */ 387 388 TableInfo.Pointer = TablePtr; 389 390 Status = AcpiTbInstallTable (NULL, &TableInfo); 391 if (ACPI_FAILURE (Status)) 392 { 393 /* Free table allocated by AcpiTbGetTable */ 394 395 AcpiTbDeleteSingleTable (&TableInfo); 396 return_ACPI_STATUS (Status); 397 } 398 399 400#ifndef PARSER_ONLY 401 Status = AcpiNsLoadTable (TableInfo.InstalledDesc, AcpiGbl_RootNode); 402 if (ACPI_FAILURE (Status)) 403 { 404 /* Uninstall table and free the buffer */ 405 406 AcpiTbUninstallTable (TableInfo.InstalledDesc); 407 return_ACPI_STATUS (Status); 408 } 409#endif 410 411 return_ACPI_STATUS (Status); 412} 413 414 415/******************************************************************************* 416 * 417 * FUNCTION: AcpiDbLoadAcpiTable 418 * 419 * PARAMETERS: Filname - File where table is located 420 * 421 * RETURN: Status 422 * 423 * DESCRIPTION: Load an ACPI table from a file 424 * 425 ******************************************************************************/ 426 427ACPI_STATUS 428AcpiDbLoadAcpiTable ( 429 NATIVE_CHAR *Filename) 430{ 431#ifdef ACPI_APPLICATION 432 FILE *fp; 433 ACPI_STATUS Status; 434 ACPI_TABLE_HEADER *TablePtr; 435 UINT32 TableLength; 436 437 438 /* Open the file */ 439 440 fp = fopen (Filename, "rb"); 441 if (!fp) 442 { 443 AcpiOsPrintf ("Could not open file %s\n", Filename); 444 return (AE_ERROR); 445 } 446 447 448 /* Get the entire file */ 449 450 AcpiOsPrintf ("Loading Acpi table from file %s\n", Filename); 451 Status = AcpiDbLoadTable (fp, &TablePtr, &TableLength); 452 fclose(fp); 453 454 if (ACPI_FAILURE (Status)) 455 { 456 AcpiOsPrintf ("Couldn't get table from the file\n"); 457 return (Status); 458 } 459 460 461 /* Attempt to recognize and install the table */ 462 Status = AeLocalLoadTable (TablePtr); 463 464 if (ACPI_FAILURE (Status)) 465 { 466 if (Status == AE_EXIST) 467 { 468 AcpiOsPrintf ("Table %4.4s is already installed\n", 469 &TablePtr->Signature); 470 } 471 472 else 473 { 474 AcpiOsPrintf ("Could not install table, %s\n", 475 AcpiFormatException (Status)); 476 } 477 478 ACPI_MEM_FREE (TablePtr); 479 return (Status); 480 } 481 482 AcpiOsPrintf ("%4.4s at %p successfully installed and loaded\n", 483 &TablePtr->Signature, TablePtr); 484 485 AcpiGbl_AcpiHardwarePresent = FALSE; 486 487#endif /* ACPI_APPLICATION */ 488 return (AE_OK); 489} 490 491 492#endif /* ENABLE_DEBUGGER */ 493 494