dbfileio.c revision 73561
1243044Sjkim/******************************************************************************* 2243044Sjkim * 3243044Sjkim * Module Name: dbfileio - Debugger file I/O commands. These can't usually 4243044Sjkim * be used when running the debugger in Ring 0 (Kernel mode) 5243044Sjkim * $Revision: 38 $ 6243044Sjkim * 7243044Sjkim ******************************************************************************/ 8243044Sjkim 9243044Sjkim/****************************************************************************** 10243044Sjkim * 11243044Sjkim * 1. Copyright Notice 12243044Sjkim * 13243044Sjkim * Some or all of this work - Copyright (c) 1999, 2000, 2001, Intel Corp. 14243044Sjkim * All rights reserved. 15243044Sjkim * 16243044Sjkim * 2. License 17243044Sjkim * 18243044Sjkim * 2.1. This is your license from Intel Corp. under its intellectual property 19243044Sjkim * rights. You may have additional license terms from the party that provided 20243044Sjkim * you this software, covering your right to use that party's intellectual 21243044Sjkim * property rights. 22243044Sjkim * 23243044Sjkim * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 24243044Sjkim * copy of the source code appearing in this file ("Covered Code") an 25243044Sjkim * irrevocable, perpetual, worldwide license under Intel's copyrights in the 26243044Sjkim * base code distributed originally by Intel ("Original Intel Code") to copy, 27243044Sjkim * make derivatives, distribute, use and display any portion of the Covered 28243044Sjkim * Code in any form, with the right to sublicense such rights; and 29243044Sjkim * 30243044Sjkim * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 31243044Sjkim * license (with the right to sublicense), under only those claims of Intel 32243044Sjkim * patents that are infringed by the Original Intel Code, to make, use, sell, 33243044Sjkim * offer to sell, and import the Covered Code and derivative works thereof 34243044Sjkim * solely to the minimum extent necessary to exercise the above copyright 35243044Sjkim * license, and in no event shall the patent license extend to any additions 36243044Sjkim * to or modifications of the Original Intel Code. No other license or right 37243044Sjkim * is granted directly or by implication, estoppel or otherwise; 38243044Sjkim * 39243044Sjkim * The above copyright and patent license is granted only if the following 40243044Sjkim * conditions are met: 41243044Sjkim * 42243044Sjkim * 3. Conditions 43243044Sjkim * 44243044Sjkim * 3.1. Redistribution of Source with Rights to Further Distribute Source. 45243044Sjkim * Redistribution of source code of any substantial portion of the Covered 46243044Sjkim * Code or modification with rights to further distribute source must include 47243044Sjkim * the above Copyright Notice, the above License, this list of Conditions, 48243044Sjkim * and the following Disclaimer and Export Compliance provision. In addition, 49243044Sjkim * Licensee must cause all Covered Code to which Licensee contributes to 50243044Sjkim * contain a file documenting the changes Licensee made to create that Covered 51243044Sjkim * Code and the date of any change. Licensee must include in that file the 52243044Sjkim * documentation of any changes made by any predecessor Licensee. Licensee 53243044Sjkim * must include a prominent statement that the modification is derived, 54243044Sjkim * directly or indirectly, from Original Intel Code. 55243044Sjkim * 56243044Sjkim * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 57243044Sjkim * Redistribution of source code of any substantial portion of the Covered 58243044Sjkim * Code or modification without rights to further distribute source must 59243044Sjkim * include the following Disclaimer and Export Compliance provision in the 60243044Sjkim * documentation and/or other materials provided with distribution. In 61243044Sjkim * addition, Licensee may not authorize further sublicense of source of any 62243044Sjkim * portion of the Covered Code, and must include terms to the effect that the 63243044Sjkim * license from Licensee to its licensee is limited to the intellectual 64243044Sjkim * property embodied in the software Licensee provides to its licensee, and 65243044Sjkim * not to intellectual property embodied in modifications its licensee may 66243044Sjkim * make. 67243044Sjkim * 68243044Sjkim * 3.3. Redistribution of Executable. Redistribution in executable form of any 69243044Sjkim * substantial portion of the Covered Code or modification must reproduce the 70243044Sjkim * above Copyright Notice, and the following Disclaimer and Export Compliance 71243044Sjkim * provision in the documentation and/or other materials provided with the 72243044Sjkim * distribution. 73243044Sjkim * 74243044Sjkim * 3.4. Intel retains all right, title, and interest in and to the Original 75243044Sjkim * Intel Code. 76243044Sjkim * 77243044Sjkim * 3.5. Neither the name Intel nor any other trademark owned or controlled by 78243044Sjkim * Intel shall be used in advertising or otherwise to promote the sale, use or 79243044Sjkim * other dealings in products derived from or relating to the Covered Code 80243044Sjkim * without prior written authorization from Intel. 81243044Sjkim * 82243044Sjkim * 4. Disclaimer and Export Compliance 83243044Sjkim * 84243044Sjkim * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 85243044Sjkim * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 86243044Sjkim * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 87243044Sjkim * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 88243044Sjkim * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 89243044Sjkim * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 90243044Sjkim * PARTICULAR PURPOSE. 91243044Sjkim * 92243044Sjkim * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 93243044Sjkim * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 94243044Sjkim * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 95243044Sjkim * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 96243044Sjkim * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 97243044Sjkim * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 98243044Sjkim * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 99243044Sjkim * LIMITED REMEDY. 100243044Sjkim * 101243044Sjkim * 4.3. Licensee shall not export, either directly or indirectly, any of this 102243044Sjkim * software or system incorporating such software without first obtaining any 103243044Sjkim * required license or other approval from the U. S. Department of Commerce or 104243044Sjkim * any other agency or department of the United States Government. In the 105243044Sjkim * event Licensee exports any such software from the United States or 106243044Sjkim * re-exports any such software from a foreign destination, Licensee shall 107243044Sjkim * ensure that the distribution and export/re-export of the software is in 108243044Sjkim * compliance with all laws, regulations, orders, or other restrictions of the 109243044Sjkim * U.S. Export Administration Regulations. Licensee agrees that neither it nor 110243044Sjkim * any of its subsidiaries will export/re-export any technical data, process, 111243044Sjkim * software, or service, directly or indirectly, to any country for which the 112243044Sjkim * United States government or any agency thereof requires an export license, 113243044Sjkim * other governmental approval, or letter of assurance, without first obtaining 114243044Sjkim * such license, approval or letter. 115243044Sjkim * 116243044Sjkim *****************************************************************************/ 117243044Sjkim 118243044Sjkim 119243044Sjkim#include "acpi.h" 120243044Sjkim#include "acdebug.h" 121243044Sjkim#include "acnamesp.h" 122243044Sjkim#include "acparser.h" 123243044Sjkim#include "acevents.h" 124243044Sjkim#include "actables.h" 125243044Sjkim 126243044Sjkim#ifdef ENABLE_DEBUGGER 127243044Sjkim 128243044Sjkim#define _COMPONENT DEBUGGER 129243044Sjkim MODULE_NAME ("dbfileio") 130243044Sjkim 131243044Sjkim 132243044SjkimACPI_PARSE_OBJECT *root; 133243044Sjkim 134243044Sjkim#ifdef ACPI_APPLICATION 135243044Sjkim#include <stdio.h> 136243044SjkimFILE *DebugFile = NULL; 137243044Sjkim#endif 138243044Sjkim 139243044Sjkim 140243044Sjkim/* 141243044Sjkim * NOTE: this is here for lack of a better place. It is used in all 142243044Sjkim * flavors of the debugger, need LCD file 143243044Sjkim */ 144243044Sjkim 145243044Sjkim/******************************************************************************* 146243044Sjkim * 147243044Sjkim * FUNCTION: AcpiDbMatchArgument 148243044Sjkim * 149243044Sjkim * PARAMETERS: UserArgument - User command line 150243044Sjkim * Arguments - Array of commands to match against 151243044Sjkim * 152243044Sjkim * RETURN: Index into command array or ACPI_TYPE_NOT_FOUND if not found 153243044Sjkim * 154243044Sjkim * DESCRIPTION: Search command array for a command match 155243044Sjkim * 156243044Sjkim ******************************************************************************/ 157243044Sjkim 158243044SjkimOBJECT_TYPE_INTERNAL 159243044SjkimAcpiDbMatchArgument ( 160243044Sjkim NATIVE_CHAR *UserArgument, 161243044Sjkim ARGUMENT_INFO *Arguments) 162243044Sjkim{ 163243044Sjkim UINT32 i; 164243044Sjkim 165243044Sjkim 166243044Sjkim if (!UserArgument || UserArgument[0] == 0) 167243044Sjkim { 168243044Sjkim return (ACPI_TYPE_NOT_FOUND); 169243044Sjkim } 170243044Sjkim 171243044Sjkim for (i = 0; Arguments[i].Name; i++) 172243044Sjkim { 173243044Sjkim if (STRSTR (Arguments[i].Name, UserArgument) == Arguments[i].Name) 174243044Sjkim { 175243044Sjkim return ((OBJECT_TYPE_INTERNAL) i); 176243044Sjkim } 177243044Sjkim } 178243044Sjkim 179243044Sjkim /* Argument not recognized */ 180243044Sjkim 181243044Sjkim return (ACPI_TYPE_NOT_FOUND); 182243044Sjkim} 183243044Sjkim 184243044Sjkim 185243044Sjkim/******************************************************************************* 186243044Sjkim * 187243044Sjkim * FUNCTION: AcpiDbCloseDebugFile 188243044Sjkim * 189243044Sjkim * PARAMETERS: None 190243044Sjkim * 191243044Sjkim * RETURN: Status 192243044Sjkim * 193243044Sjkim * DESCRIPTION: If open, close the current debug output file 194243044Sjkim * 195243044Sjkim ******************************************************************************/ 196243044Sjkim 197243044Sjkimvoid 198243044SjkimAcpiDbCloseDebugFile ( 199243044Sjkim void) 200243044Sjkim{ 201243044Sjkim 202243044Sjkim#ifdef ACPI_APPLICATION 203243044Sjkim 204243044Sjkim if (DebugFile) 205243044Sjkim { 206243044Sjkim fclose (DebugFile); 207243044Sjkim DebugFile = NULL; 208243044Sjkim OutputToFile = FALSE; 209243044Sjkim AcpiOsPrintf ("Debug output file %s closed\n", DebugFilename); 210243044Sjkim } 211243044Sjkim#endif 212243044Sjkim 213243044Sjkim} 214243044Sjkim 215243044Sjkim 216243044Sjkim/******************************************************************************* 217243044Sjkim * 218243044Sjkim * FUNCTION: AcpiDbOpenDebugFile 219243044Sjkim * 220243044Sjkim * PARAMETERS: Name - Filename to open 221243044Sjkim * 222243044Sjkim * RETURN: Status 223243044Sjkim * 224243044Sjkim * DESCRIPTION: Open a file where debug output will be directed. 225243044Sjkim * 226243044Sjkim ******************************************************************************/ 227243044Sjkim 228243044Sjkimvoid 229243044SjkimAcpiDbOpenDebugFile ( 230243044Sjkim NATIVE_CHAR *Name) 231243044Sjkim{ 232243044Sjkim 233243044Sjkim#ifdef ACPI_APPLICATION 234243044Sjkim 235243044Sjkim AcpiDbCloseDebugFile (); 236243044Sjkim DebugFile = fopen (Name, "w+"); 237243044Sjkim if (DebugFile) 238243044Sjkim { 239243044Sjkim AcpiOsPrintf ("Debug output file %s opened\n", Name); 240243044Sjkim STRCPY (DebugFilename, Name); 241243044Sjkim OutputToFile = TRUE; 242243044Sjkim } 243243044Sjkim else 244243044Sjkim { 245243044Sjkim AcpiOsPrintf ("Could not open debug file %s\n", Name); 246243044Sjkim } 247243044Sjkim 248243044Sjkim#endif 249243044Sjkim} 250243044Sjkim 251243044Sjkim 252243044Sjkim#ifdef ACPI_APPLICATION 253243044Sjkim/******************************************************************************* 254243044Sjkim * 255243044Sjkim * FUNCTION: AcpiDbLoadTable 256243044Sjkim * 257243044Sjkim * PARAMETERS: fp - File that contains table 258243044Sjkim * TablePtr - Return value, buffer with table 259243044Sjkim * TableLenght - Return value, length of table 260243044Sjkim * 261243044Sjkim * RETURN: Status 262243044Sjkim * 263243044Sjkim * DESCRIPTION: Load the DSDT from the file pointer 264243044Sjkim * 265243044Sjkim ******************************************************************************/ 266243044Sjkim 267243044SjkimACPI_STATUS 268243044SjkimAcpiDbLoadTable( 269243044Sjkim FILE *fp, 270243044Sjkim ACPI_TABLE_HEADER **TablePtr, 271243044Sjkim UINT32 *TableLength) 272243044Sjkim{ 273 ACPI_TABLE_HEADER TableHeader; 274 UINT8 *AmlPtr; 275 UINT32 AmlLength; 276 UINT32 Actual; 277 ACPI_STATUS Status; 278 279 280 /* Read the table header */ 281 282 if (fread (&TableHeader, 1, sizeof (TableHeader), fp) != sizeof (ACPI_TABLE_HEADER)) 283 { 284 AcpiOsPrintf ("Couldn't read the table header\n"); 285 return (AE_BAD_SIGNATURE); 286 } 287 288 289 /* Validate the table header/length */ 290 291 Status = AcpiTbValidateTableHeader (&TableHeader); 292 if ((ACPI_FAILURE (Status)) || 293 (TableHeader.Length > 524288)) /* 1/2 Mbyte should be enough */ 294 { 295 AcpiOsPrintf ("Table header is invalid!\n"); 296 return (AE_ERROR); 297 } 298 299 300 /* We only support a limited number of table types */ 301 302 if (STRNCMP ((char *) TableHeader.Signature, DSDT_SIG, 4) && 303 STRNCMP ((char *) TableHeader.Signature, PSDT_SIG, 4) && 304 STRNCMP ((char *) TableHeader.Signature, SSDT_SIG, 4)) 305 { 306 AcpiOsPrintf ("Table signature is invalid\n"); 307 DUMP_BUFFER (&TableHeader, sizeof (ACPI_TABLE_HEADER)); 308 return (AE_ERROR); 309 } 310 311 /* Allocate a buffer for the table */ 312 313 *TableLength = TableHeader.Length; 314 *TablePtr = (ACPI_TABLE_HEADER *) AcpiCmAllocate ((size_t) *TableLength); 315 if (!*TablePtr) 316 { 317 AcpiOsPrintf ("Could not allocate memory for the table (size=%X)\n", TableHeader.Length); 318 return (AE_NO_MEMORY); 319 } 320 321 322 AmlPtr = (UINT8 *) *TablePtr + sizeof (TableHeader); 323 AmlLength = *TableLength - sizeof (TableHeader); 324 325 /* Copy the header to the buffer */ 326 327 MEMCPY (*TablePtr, &TableHeader, sizeof (TableHeader)); 328 329 /* Get the rest of the table */ 330 331 Actual = fread (AmlPtr, 1, (size_t) AmlLength, fp); 332 if (Actual == AmlLength) 333 { 334 return (AE_OK); 335 } 336 337 if (Actual > 0) 338 { 339 AcpiOsPrintf ("Warning - reading table, asked for %X got %X\n", AmlLength, Actual); 340 return (AE_OK); 341 } 342 343 344 AcpiOsPrintf ("Error - could not read the table file\n"); 345 AcpiCmFree (*TablePtr); 346 *TablePtr = NULL; 347 *TableLength = 0; 348 349 return (AE_ERROR); 350} 351#endif 352 353 354/******************************************************************************* 355 * 356 * FUNCTION: AeLocalLoadTable 357 * 358 * PARAMETERS: TablePtr - pointer to a buffer containing the entire 359 * table to be loaded 360 * 361 * RETURN: Status 362 * 363 * DESCRIPTION: This function is called to load a table from the caller's 364 * buffer. The buffer must contain an entire ACPI Table including 365 * a valid header. The header fields will be verified, and if it 366 * is determined that the table is invalid, the call will fail. 367 * 368 * If the call fails an appropriate status will be returned. 369 * 370 ******************************************************************************/ 371 372ACPI_STATUS 373AeLocalLoadTable ( 374 ACPI_TABLE_HEADER *TablePtr) 375{ 376 ACPI_STATUS Status; 377 ACPI_TABLE_DESC TableInfo; 378 379 380 FUNCTION_TRACE ("AeLocalLoadTable"); 381 382 if (!TablePtr) 383 { 384 return_ACPI_STATUS (AE_BAD_PARAMETER); 385 } 386 387 /* Install the new table into the local data structures */ 388 389 TableInfo.Pointer = TablePtr; 390 391 Status = AcpiTbInstallTable (NULL, &TableInfo); 392 if (ACPI_FAILURE (Status)) 393 { 394 /* Free table allocated by AcpiTbGetTable */ 395 396 AcpiTbDeleteSingleTable (&TableInfo); 397 return_ACPI_STATUS (Status); 398 } 399 400 401#ifndef PARSER_ONLY 402 Status = AcpiNsLoadTable (TableInfo.InstalledDesc, AcpiGbl_RootNode); 403 if (ACPI_FAILURE (Status)) 404 { 405 /* Uninstall table and free the buffer */ 406 407 AcpiTbUninstallTable (TableInfo.InstalledDesc); 408 return_ACPI_STATUS (Status); 409 } 410#endif 411 412 return_ACPI_STATUS (Status); 413} 414 415 416/******************************************************************************* 417 * 418 * FUNCTION: AcpiDbLoadAcpiTable 419 * 420 * PARAMETERS: Filname - File where table is located 421 * 422 * RETURN: Status 423 * 424 * DESCRIPTION: Load an ACPI table from a file 425 * 426 ******************************************************************************/ 427 428ACPI_STATUS 429AcpiDbLoadAcpiTable ( 430 NATIVE_CHAR *Filename) 431{ 432#ifdef ACPI_APPLICATION 433 FILE *fp; 434 ACPI_STATUS Status; 435 ACPI_TABLE_HEADER *TablePtr; 436 UINT32 TableLength; 437 438 439 /* Open the file */ 440 441 fp = fopen (Filename, "rb"); 442 if (!fp) 443 { 444 AcpiOsPrintf ("Could not open file %s\n", Filename); 445 return (AE_ERROR); 446 } 447 448 449 /* Get the entire file */ 450 451 AcpiOsPrintf ("Loading Acpi table from file %s\n", Filename); 452 Status = AcpiDbLoadTable (fp, &TablePtr, &TableLength); 453 fclose(fp); 454 455 if (ACPI_FAILURE (Status)) 456 { 457 AcpiOsPrintf ("Couldn't get table from the file\n"); 458 return (Status); 459 } 460 461 462 /* Attempt to recognize and install the table */ 463 Status = AeLocalLoadTable (TablePtr); 464 465 if (ACPI_FAILURE (Status)) 466 { 467 if (Status == AE_EXIST) 468 { 469 AcpiOsPrintf ("Table %4.4s is already installed\n", 470 &TablePtr->Signature); 471 } 472 else 473 { 474 AcpiOsPrintf ("Could not install table, %s\n", 475 AcpiCmFormatException (Status)); 476 } 477 AcpiCmFree (TablePtr); 478 return (Status); 479 } 480 481 AcpiOsPrintf ("%4.4s at %p successfully installed and loaded\n", 482 &TablePtr->Signature, TablePtr); 483 484 AcpiGbl_AcpiHardwarePresent = FALSE; 485 486#endif /* ACPI_APPLICATION */ 487 return (AE_OK); 488} 489 490 491#endif /* ENABLE_DEBUGGER */ 492 493