dbfileio.c revision 91116
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: 59 $ 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 "acparser.h" 123#include "acevents.h" 124#include "actables.h" 125 126#ifdef ENABLE_DEBUGGER 127 128#define _COMPONENT ACPI_DEBUGGER 129 ACPI_MODULE_NAME ("dbfileio") 130 131 132/* 133 * NOTE: this is here for lack of a better place. It is used in all 134 * flavors of the debugger, need LCD file 135 */ 136#ifdef ACPI_APPLICATION 137#include <stdio.h> 138FILE *AcpiGbl_DebugFile = NULL; 139#endif 140 141 142ACPI_TABLE_HEADER *AcpiGbl_DbTablePtr = NULL; 143 144 145/******************************************************************************* 146 * 147 * FUNCTION: AcpiDbMatchArgument 148 * 149 * PARAMETERS: UserArgument - User command line 150 * Arguments - Array of commands to match against 151 * 152 * RETURN: Index into command array or ACPI_TYPE_NOT_FOUND if not found 153 * 154 * DESCRIPTION: Search command array for a command match 155 * 156 ******************************************************************************/ 157 158ACPI_OBJECT_TYPE 159AcpiDbMatchArgument ( 160 NATIVE_CHAR *UserArgument, 161 ARGUMENT_INFO *Arguments) 162{ 163 UINT32 i; 164 165 166 if (!UserArgument || UserArgument[0] == 0) 167 { 168 return (ACPI_TYPE_NOT_FOUND); 169 } 170 171 for (i = 0; Arguments[i].Name; i++) 172 { 173 if (ACPI_STRSTR (Arguments[i].Name, UserArgument) == Arguments[i].Name) 174 { 175 return (i); 176 } 177 } 178 179 /* Argument not recognized */ 180 181 return (ACPI_TYPE_NOT_FOUND); 182} 183 184 185/******************************************************************************* 186 * 187 * FUNCTION: AcpiDbCloseDebugFile 188 * 189 * PARAMETERS: None 190 * 191 * RETURN: Status 192 * 193 * DESCRIPTION: If open, close the current debug output file 194 * 195 ******************************************************************************/ 196 197void 198AcpiDbCloseDebugFile ( 199 void) 200{ 201 202#ifdef ACPI_APPLICATION 203 204 if (AcpiGbl_DebugFile) 205 { 206 fclose (AcpiGbl_DebugFile); 207 AcpiGbl_DebugFile = NULL; 208 AcpiGbl_DbOutputToFile = FALSE; 209 AcpiOsPrintf ("Debug output file %s closed\n", AcpiGbl_DbDebugFilename); 210 } 211#endif 212 213} 214 215 216/******************************************************************************* 217 * 218 * FUNCTION: AcpiDbOpenDebugFile 219 * 220 * PARAMETERS: Name - Filename to open 221 * 222 * RETURN: Status 223 * 224 * DESCRIPTION: Open a file where debug output will be directed. 225 * 226 ******************************************************************************/ 227 228void 229AcpiDbOpenDebugFile ( 230 NATIVE_CHAR *Name) 231{ 232 233#ifdef ACPI_APPLICATION 234 235 AcpiDbCloseDebugFile (); 236 AcpiGbl_DebugFile = fopen (Name, "w+"); 237 if (AcpiGbl_DebugFile) 238 { 239 AcpiOsPrintf ("Debug output file %s opened\n", Name); 240 ACPI_STRCPY (AcpiGbl_DbDebugFilename, Name); 241 AcpiGbl_DbOutputToFile = TRUE; 242 } 243 else 244 { 245 AcpiOsPrintf ("Could not open debug file %s\n", Name); 246 } 247 248#endif 249} 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 267ACPI_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 > 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 (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 /* Install the new table into the local data structures */ 389 390 TableInfo.Pointer = TablePtr; 391 392 Status = AcpiTbInstallTable (NULL, &TableInfo); 393 if (ACPI_FAILURE (Status)) 394 { 395 /* Free table allocated by AcpiTbGetTable */ 396 397 AcpiTbDeleteSingleTable (&TableInfo); 398 return_ACPI_STATUS (Status); 399 } 400 401 402#ifndef PARSER_ONLY 403 Status = AcpiNsLoadTable (TableInfo.InstalledDesc, AcpiGbl_RootNode); 404 if (ACPI_FAILURE (Status)) 405 { 406 /* Uninstall table and free the buffer */ 407 408 AcpiTbDeleteAcpiTable (ACPI_TABLE_DSDT); 409 return_ACPI_STATUS (Status); 410 } 411#endif 412 413 return_ACPI_STATUS (Status); 414} 415 416 417/******************************************************************************* 418 * 419 * FUNCTION: AcpiDbLoadAcpiTable 420 * 421 * PARAMETERS: Filname - File where table is located 422 * 423 * RETURN: Status 424 * 425 * DESCRIPTION: Load an ACPI table from a file 426 * 427 ******************************************************************************/ 428 429ACPI_STATUS 430AcpiDbLoadAcpiTable ( 431 NATIVE_CHAR *Filename) 432{ 433#ifdef ACPI_APPLICATION 434 FILE *fp; 435 ACPI_STATUS Status; 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, &AcpiGbl_DbTablePtr, &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 /* Attempt to recognize and install the table */ 462 463 Status = AeLocalLoadTable (AcpiGbl_DbTablePtr); 464 if (ACPI_FAILURE (Status)) 465 { 466 if (Status == AE_ALREADY_EXISTS) 467 { 468 AcpiOsPrintf ("Table %4.4s is already installed\n", 469 &AcpiGbl_DbTablePtr->Signature); 470 } 471 else 472 { 473 AcpiOsPrintf ("Could not install table, %s\n", 474 AcpiFormatException (Status)); 475 } 476 477 return (Status); 478 } 479 480 AcpiOsPrintf ("%4.4s at %p successfully installed and loaded\n", 481 &AcpiGbl_DbTablePtr->Signature, AcpiGbl_DbTablePtr); 482 483 AcpiGbl_AcpiHardwarePresent = FALSE; 484 485#endif /* ACPI_APPLICATION */ 486 return (AE_OK); 487} 488 489 490#endif /* ENABLE_DEBUGGER */ 491 492