dbfileio.c revision 102550
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: 68 $ 6 * 7 ******************************************************************************/ 8 9/****************************************************************************** 10 * 11 * 1. Copyright Notice 12 * 13 * Some or all of this work - Copyright (c) 1999 - 2002, 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 "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/* 131 * NOTE: this is here for lack of a better place. It is used in all 132 * flavors of the debugger, need LCD file 133 */ 134#ifdef ACPI_APPLICATION 135#include <stdio.h> 136FILE *AcpiGbl_DebugFile = NULL; 137#endif 138 139 140ACPI_TABLE_HEADER *AcpiGbl_DbTablePtr = NULL; 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_TYPE 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 (ACPI_STRSTR (Arguments[i].Name, UserArgument) == Arguments[i].Name) 172 { 173 return (i); 174 } 175 } 176 177 /* Argument not recognized */ 178 179 return (ACPI_TYPE_NOT_FOUND); 180} 181 182 183#ifdef ACPI_DEBUGGER 184/******************************************************************************* 185 * 186 * FUNCTION: AcpiDbCloseDebugFile 187 * 188 * PARAMETERS: None 189 * 190 * RETURN: Status 191 * 192 * DESCRIPTION: If open, close the current debug output file 193 * 194 ******************************************************************************/ 195 196void 197AcpiDbCloseDebugFile ( 198 void) 199{ 200 201#ifdef ACPI_APPLICATION 202 203 if (AcpiGbl_DebugFile) 204 { 205 fclose (AcpiGbl_DebugFile); 206 AcpiGbl_DebugFile = NULL; 207 AcpiGbl_DbOutputToFile = FALSE; 208 AcpiOsPrintf ("Debug output file %s closed\n", AcpiGbl_DbDebugFilename); 209 } 210#endif 211 212} 213 214 215/******************************************************************************* 216 * 217 * FUNCTION: AcpiDbOpenDebugFile 218 * 219 * PARAMETERS: Name - Filename to open 220 * 221 * RETURN: Status 222 * 223 * DESCRIPTION: Open a file where debug output will be directed. 224 * 225 ******************************************************************************/ 226 227void 228AcpiDbOpenDebugFile ( 229 NATIVE_CHAR *Name) 230{ 231 232#ifdef ACPI_APPLICATION 233 234 AcpiDbCloseDebugFile (); 235 AcpiGbl_DebugFile = fopen (Name, "w+"); 236 if (AcpiGbl_DebugFile) 237 { 238 AcpiOsPrintf ("Debug output file %s opened\n", Name); 239 ACPI_STRCPY (AcpiGbl_DbDebugFilename, Name); 240 AcpiGbl_DbOutputToFile = TRUE; 241 } 242 else 243 { 244 AcpiOsPrintf ("Could not open debug file %s\n", Name); 245 } 246 247#endif 248} 249#endif 250 251 252#ifdef ACPI_APPLICATION 253/******************************************************************************* 254 * 255 * FUNCTION: AcpiDbLoadTable 256 * 257 * PARAMETERS: fp - File that contains table 258 * TablePtr - Return value, buffer with table 259 * TableLenght - Return value, length of table 260 * 261 * RETURN: Status 262 * 263 * DESCRIPTION: Load the DSDT from the file pointer 264 * 265 ******************************************************************************/ 266 267static ACPI_STATUS 268AcpiDbLoadTable( 269 FILE *fp, 270 ACPI_TABLE_HEADER **TablePtr, 271 UINT32 *TableLength) 272{ 273 ACPI_TABLE_HEADER TableHeader; 274 UINT8 *AmlStart; 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 > 0x800000)) /* 8 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 (ACPI_STRNCMP ((char *) TableHeader.Signature, DSDT_SIG, 4) && 303 ACPI_STRNCMP ((char *) TableHeader.Signature, PSDT_SIG, 4) && 304 ACPI_STRNCMP ((char *) TableHeader.Signature, SSDT_SIG, 4)) 305 { 306 AcpiOsPrintf ("Table signature is invalid\n"); 307 ACPI_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 = AcpiOsAllocate ((size_t) *TableLength); 315 if (!*TablePtr) 316 { 317 AcpiOsPrintf ("Could not allocate memory for ACPI table %4.4s (size=%X)\n", 318 TableHeader.Signature, TableHeader.Length); 319 return (AE_NO_MEMORY); 320 } 321 322 323 AmlStart = (UINT8 *) *TablePtr + sizeof (TableHeader); 324 AmlLength = *TableLength - sizeof (TableHeader); 325 326 /* Copy the header to the buffer */ 327 328 ACPI_MEMCPY (*TablePtr, &TableHeader, sizeof (TableHeader)); 329 330 /* Get the rest of the table */ 331 332 Actual = fread (AmlStart, 1, (size_t) AmlLength, fp); 333 if (Actual == AmlLength) 334 { 335 return (AE_OK); 336 } 337 338 if (Actual > 0) 339 { 340 AcpiOsPrintf ("Warning - reading table, asked for %X got %X\n", AmlLength, Actual); 341 return (AE_OK); 342 } 343 344 345 AcpiOsPrintf ("Error - could not read the table file\n"); 346 AcpiOsFree (*TablePtr); 347 *TablePtr = NULL; 348 *TableLength = 0; 349 350 return (AE_ERROR); 351} 352#endif 353 354 355/******************************************************************************* 356 * 357 * FUNCTION: AeLocalLoadTable 358 * 359 * PARAMETERS: TablePtr - pointer to a buffer containing the entire 360 * table to be loaded 361 * 362 * RETURN: Status 363 * 364 * DESCRIPTION: This function is called to load a table from the caller's 365 * buffer. The buffer must contain an entire ACPI Table including 366 * a valid header. The header fields will be verified, and if it 367 * is determined that the table is invalid, the call will fail. 368 * 369 * If the call fails an appropriate status will be returned. 370 * 371 ******************************************************************************/ 372 373ACPI_STATUS 374AeLocalLoadTable ( 375 ACPI_TABLE_HEADER *TablePtr) 376{ 377 ACPI_STATUS Status; 378 ACPI_TABLE_DESC TableInfo; 379 380 381 ACPI_FUNCTION_TRACE ("AeLocalLoadTable"); 382 383 if (!TablePtr) 384 { 385 return_ACPI_STATUS (AE_BAD_PARAMETER); 386 } 387 388 TableInfo.Pointer = TablePtr; 389 Status = AcpiTbRecognizeTable (&TableInfo, ACPI_TABLE_SECONDARY); 390 if (ACPI_FAILURE (Status)) 391 { 392 return_ACPI_STATUS (Status); 393 } 394 395 /* Install the new table into the local data structures */ 396 397 Status = AcpiTbInstallTable (&TableInfo); 398 if (ACPI_FAILURE (Status)) 399 { 400 /* Free table allocated by AcpiTbGetTable */ 401 402 AcpiTbDeleteSingleTable (&TableInfo); 403 return_ACPI_STATUS (Status); 404 } 405 406 407#if (!defined (ACPI_NO_METHOD_EXECUTION) && !defined (ACPI_CONSTANT_EVAL_ONLY)) 408 Status = AcpiNsLoadTable (TableInfo.InstalledDesc, AcpiGbl_RootNode); 409 if (ACPI_FAILURE (Status)) 410 { 411 /* Uninstall table and free the buffer */ 412 413 AcpiTbDeleteAcpiTable (ACPI_TABLE_DSDT); 414 return_ACPI_STATUS (Status); 415 } 416#endif 417 418 return_ACPI_STATUS (Status); 419} 420 421 422#ifdef ACPI_APPLICATION 423ACPI_STATUS 424AcpiDbGetAcpiTable ( 425 NATIVE_CHAR *Filename) 426{ 427 FILE *fp; 428 UINT32 TableLength; 429 ACPI_STATUS Status; 430 431 /* Open the file */ 432 433 fp = fopen (Filename, "rb"); 434 if (!fp) 435 { 436 AcpiOsPrintf ("Could not open file %s\n", Filename); 437 return (AE_ERROR); 438 } 439 440 441 /* Get the entire file */ 442 443 fprintf (stderr, "Loading Acpi table from file %s\n", Filename); 444 Status = AcpiDbLoadTable (fp, &AcpiGbl_DbTablePtr, &TableLength); 445 fclose(fp); 446 447 if (ACPI_FAILURE (Status)) 448 { 449 AcpiOsPrintf ("Couldn't get table from the file\n"); 450 return (Status); 451 } 452 453 return (AE_OK); 454 } 455#endif 456 457/******************************************************************************* 458 * 459 * FUNCTION: AcpiDbLoadAcpiTable 460 * 461 * PARAMETERS: Filname - File where table is located 462 * 463 * RETURN: Status 464 * 465 * DESCRIPTION: Load an ACPI table from a file 466 * 467 ******************************************************************************/ 468 469ACPI_STATUS 470AcpiDbLoadAcpiTable ( 471 NATIVE_CHAR *Filename) 472{ 473#ifdef ACPI_APPLICATION 474 ACPI_STATUS Status; 475 476 477 Status = AcpiDbGetAcpiTable (Filename); 478 if (ACPI_FAILURE (Status)) 479 { 480 return (Status); 481 } 482 483 /* Attempt to recognize and install the table */ 484 485 Status = AeLocalLoadTable (AcpiGbl_DbTablePtr); 486 if (ACPI_FAILURE (Status)) 487 { 488 if (Status == AE_ALREADY_EXISTS) 489 { 490 AcpiOsPrintf ("Table %4.4s is already installed\n", 491 AcpiGbl_DbTablePtr->Signature); 492 } 493 else 494 { 495 AcpiOsPrintf ("Could not install table, %s\n", 496 AcpiFormatException (Status)); 497 } 498 499 return (Status); 500 } 501 502 fprintf (stderr, "Acpi table [%4.4s] successfully installed and loaded\n", 503 AcpiGbl_DbTablePtr->Signature); 504 505 AcpiGbl_AcpiHardwarePresent = FALSE; 506 507#endif /* ACPI_APPLICATION */ 508 return (AE_OK); 509} 510 511 512#endif /* ACPI_DEBUGGER */ 513 514