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 - 2009, 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
118 #include "acpi.h"
119 #include "accommon.h"
120 #include "acdebug.h"
121
122 #ifdef ACPI_APPLICATION
123 #include "actables.h"
124 #endif
125
126 #if (defined ACPI_DEBUGGER || defined ACPI_DISASSEMBLER)
127
128 #define _COMPONENT ACPI_CA_DEBUGGER
129 ACPI_MODULE_NAME ("dbfileio")
130
131 /*
132 * NOTE: this is here for lack of a better place. It is used in all
133 * flavors of the debugger, need LCD file
134 */
135 #ifdef ACPI_APPLICATION
136 #include <stdio.h>
137 FILE *AcpiGbl_DebugFile = NULL;
138 #endif
139
140
141 #ifdef ACPI_DEBUGGER
142
143 /* Local prototypes */
144
145 #ifdef ACPI_APPLICATION
146
147 static ACPI_STATUS
148 AcpiDbCheckTextModeCorruption (
149 UINT8 *Table,
150 UINT32 TableLength,
151 UINT32 FileLength);
152
153 static ACPI_STATUS
154 AeLocalLoadTable (
155 ACPI_TABLE_HEADER *TablePtr);
156 #endif
157
158 /*******************************************************************************
159 *
160 * FUNCTION: AcpiDbCloseDebugFile
161 *
162 * PARAMETERS: None
163 *
164 * RETURN: None
165 *
166 * DESCRIPTION: If open, close the current debug output file
167 *
168 ******************************************************************************/
169
170 void
AcpiDbCloseDebugFile(void)171 AcpiDbCloseDebugFile (
172 void)
173 {
174
175 #ifdef ACPI_APPLICATION
176
177 if (AcpiGbl_DebugFile)
178 {
179 fclose (AcpiGbl_DebugFile);
180 AcpiGbl_DebugFile = NULL;
181 AcpiGbl_DbOutputToFile = FALSE;
182 AcpiOsPrintf ("Debug output file %s closed\n", AcpiGbl_DbDebugFilename);
183 }
184 #endif
185 }
186
187
188 /*******************************************************************************
189 *
190 * FUNCTION: AcpiDbOpenDebugFile
191 *
192 * PARAMETERS: Name - Filename to open
193 *
194 * RETURN: None
195 *
196 * DESCRIPTION: Open a file where debug output will be directed.
197 *
198 ******************************************************************************/
199
200 void
AcpiDbOpenDebugFile(char * Name)201 AcpiDbOpenDebugFile (
202 char *Name)
203 {
204
205 #ifdef ACPI_APPLICATION
206
207 AcpiDbCloseDebugFile ();
208 AcpiGbl_DebugFile = fopen (Name, "w+");
209 if (AcpiGbl_DebugFile)
210 {
211 AcpiOsPrintf ("Debug output file %s opened\n", Name);
212 ACPI_STRCPY (AcpiGbl_DbDebugFilename, Name);
213 AcpiGbl_DbOutputToFile = TRUE;
214 }
215 else
216 {
217 AcpiOsPrintf ("Could not open debug file %s\n", Name);
218 }
219
220 #endif
221 }
222 #endif
223
224
225 #ifdef ACPI_APPLICATION
226 /*******************************************************************************
227 *
228 * FUNCTION: AcpiDbCheckTextModeCorruption
229 *
230 * PARAMETERS: Table - Table buffer
231 * TableLength - Length of table from the table header
232 * FileLength - Length of the file that contains the table
233 *
234 * RETURN: Status
235 *
236 * DESCRIPTION: Check table for text mode file corruption where all linefeed
237 * characters (LF) have been replaced by carriage return linefeed
238 * pairs (CR/LF).
239 *
240 ******************************************************************************/
241
242 static ACPI_STATUS
AcpiDbCheckTextModeCorruption(UINT8 * Table,UINT32 TableLength,UINT32 FileLength)243 AcpiDbCheckTextModeCorruption (
244 UINT8 *Table,
245 UINT32 TableLength,
246 UINT32 FileLength)
247 {
248 UINT32 i;
249 UINT32 Pairs = 0;
250
251
252 if (TableLength != FileLength)
253 {
254 ACPI_WARNING ((AE_INFO,
255 "File length (0x%X) is not the same as the table length (0x%X)",
256 FileLength, TableLength));
257 }
258
259 /* Scan entire table to determine if each LF has been prefixed with a CR */
260
261 for (i = 1; i < FileLength; i++)
262 {
263 if (Table[i] == 0x0A)
264 {
265 if (Table[i - 1] != 0x0D)
266 {
267 /* The LF does not have a preceding CR, table not corrupted */
268
269 return (AE_OK);
270 }
271 else
272 {
273 /* Found a CR/LF pair */
274
275 Pairs++;
276 }
277 i++;
278 }
279 }
280
281 if (!Pairs)
282 {
283 return (AE_OK);
284 }
285
286 /*
287 * Entire table scanned, each CR is part of a CR/LF pair --
288 * meaning that the table was treated as a text file somewhere.
289 *
290 * NOTE: We can't "fix" the table, because any existing CR/LF pairs in the
291 * original table are left untouched by the text conversion process --
292 * meaning that we cannot simply replace CR/LF pairs with LFs.
293 */
294 AcpiOsPrintf ("Table has been corrupted by text mode conversion\n");
295 AcpiOsPrintf ("All LFs (%d) were changed to CR/LF pairs\n", Pairs);
296 AcpiOsPrintf ("Table cannot be repaired!\n");
297 return (AE_BAD_VALUE);
298 }
299
300
301 /*******************************************************************************
302 *
303 * FUNCTION: AcpiDbReadTable
304 *
305 * PARAMETERS: fp - File that contains table
306 * Table - Return value, buffer with table
307 * TableLength - Return value, length of table
308 *
309 * RETURN: Status
310 *
311 * DESCRIPTION: Load the DSDT from the file pointer
312 *
313 ******************************************************************************/
314
315 static ACPI_STATUS
AcpiDbReadTable(FILE * fp,ACPI_TABLE_HEADER ** Table,UINT32 * TableLength)316 AcpiDbReadTable (
317 FILE *fp,
318 ACPI_TABLE_HEADER **Table,
319 UINT32 *TableLength)
320 {
321 ACPI_TABLE_HEADER TableHeader;
322 UINT32 Actual;
323 ACPI_STATUS Status;
324 UINT32 FileSize;
325 BOOLEAN StandardHeader = TRUE;
326
327
328 /* Get the file size */
329
330 fseek (fp, 0, SEEK_END);
331 FileSize = (UINT32) ftell (fp);
332 fseek (fp, 0, SEEK_SET);
333
334 if (FileSize < 4)
335 {
336 return (AE_BAD_HEADER);
337 }
338
339 /* Read the signature */
340
341 if (fread (&TableHeader, 1, 4, fp) != 4)
342 {
343 AcpiOsPrintf ("Could not read the table signature\n");
344 return (AE_BAD_HEADER);
345 }
346
347 fseek (fp, 0, SEEK_SET);
348
349 /* The RSDT and FACS tables do not have standard ACPI headers */
350
351 if (ACPI_COMPARE_NAME (TableHeader.Signature, "RSD ") ||
352 ACPI_COMPARE_NAME (TableHeader.Signature, "FACS"))
353 {
354 *TableLength = FileSize;
355 StandardHeader = FALSE;
356 }
357 else
358 {
359 /* Read the table header */
360
361 if (fread (&TableHeader, 1, sizeof (TableHeader), fp) !=
362 sizeof (ACPI_TABLE_HEADER))
363 {
364 AcpiOsPrintf ("Could not read the table header\n");
365 return (AE_BAD_HEADER);
366 }
367
368 #if 0
369 /* Validate the table header/length */
370
371 Status = AcpiTbValidateTableHeader (&TableHeader);
372 if (ACPI_FAILURE (Status))
373 {
374 AcpiOsPrintf ("Table header is invalid!\n");
375 return (Status);
376 }
377 #endif
378
379 /* File size must be at least as long as the Header-specified length */
380
381 if (TableHeader.Length > FileSize)
382 {
383 AcpiOsPrintf (
384 "TableHeader length [0x%X] greater than the input file size [0x%X]\n",
385 TableHeader.Length, FileSize);
386 return (AE_BAD_HEADER);
387 }
388
389 #ifdef ACPI_OBSOLETE_CODE
390 /* We only support a limited number of table types */
391
392 if (ACPI_STRNCMP ((char *) TableHeader.Signature, DSDT_SIG, 4) &&
393 ACPI_STRNCMP ((char *) TableHeader.Signature, PSDT_SIG, 4) &&
394 ACPI_STRNCMP ((char *) TableHeader.Signature, SSDT_SIG, 4))
395 {
396 AcpiOsPrintf ("Table signature [%4.4s] is invalid or not supported\n",
397 (char *) TableHeader.Signature);
398 ACPI_DUMP_BUFFER (&TableHeader, sizeof (ACPI_TABLE_HEADER));
399 return (AE_ERROR);
400 }
401 #endif
402
403 *TableLength = TableHeader.Length;
404 }
405
406 /* Allocate a buffer for the table */
407
408 *Table = AcpiOsAllocate ((size_t) FileSize);
409 if (!*Table)
410 {
411 AcpiOsPrintf (
412 "Could not allocate memory for ACPI table %4.4s (size=0x%X)\n",
413 TableHeader.Signature, *TableLength);
414 return (AE_NO_MEMORY);
415 }
416
417 /* Get the rest of the table */
418
419 fseek (fp, 0, SEEK_SET);
420 Actual = fread (*Table, 1, (size_t) FileSize, fp);
421 if (Actual == FileSize)
422 {
423 if (StandardHeader)
424 {
425 /* Now validate the checksum */
426
427 Status = AcpiTbChecksum ((void *) *Table,
428 ACPI_CAST_PTR (ACPI_TABLE_HEADER, *Table)->Length);
429
430 if (Status == AE_BAD_CHECKSUM)
431 {
432 Status = AcpiDbCheckTextModeCorruption ((UINT8 *) *Table,
433 FileSize, (*Table)->Length);
434 return (Status);
435 }
436 }
437 return (AE_OK);
438 }
439
440 if (Actual > 0)
441 {
442 AcpiOsPrintf ("Warning - reading table, asked for %X got %X\n",
443 FileSize, Actual);
444 return (AE_OK);
445 }
446
447 AcpiOsPrintf ("Error - could not read the table file\n");
448 AcpiOsFree (*Table);
449 *Table = NULL;
450 *TableLength = 0;
451
452 return (AE_ERROR);
453 }
454
455
456 /*******************************************************************************
457 *
458 * FUNCTION: AeLocalLoadTable
459 *
460 * PARAMETERS: Table - pointer to a buffer containing the entire
461 * table to be loaded
462 *
463 * RETURN: Status
464 *
465 * DESCRIPTION: This function is called to load a table from the caller's
466 * buffer. The buffer must contain an entire ACPI Table including
467 * a valid header. The header fields will be verified, and if it
468 * is determined that the table is invalid, the call will fail.
469 *
470 ******************************************************************************/
471
472 static ACPI_STATUS
AeLocalLoadTable(ACPI_TABLE_HEADER * Table)473 AeLocalLoadTable (
474 ACPI_TABLE_HEADER *Table)
475 {
476 ACPI_STATUS Status = AE_OK;
477 /* ACPI_TABLE_DESC TableInfo; */
478
479
480 ACPI_FUNCTION_TRACE (AeLocalLoadTable);
481 #if 0
482
483
484 if (!Table)
485 {
486 return_ACPI_STATUS (AE_BAD_PARAMETER);
487 }
488
489 TableInfo.Pointer = Table;
490 Status = AcpiTbRecognizeTable (&TableInfo, ACPI_TABLE_ALL);
491 if (ACPI_FAILURE (Status))
492 {
493 return_ACPI_STATUS (Status);
494 }
495
496 /* Install the new table into the local data structures */
497
498 Status = AcpiTbInstallTable (&TableInfo);
499 if (ACPI_FAILURE (Status))
500 {
501 if (Status == AE_ALREADY_EXISTS)
502 {
503 /* Table already exists, no error */
504
505 Status = AE_OK;
506 }
507
508 /* Free table allocated by AcpiTbGetTable */
509
510 AcpiTbDeleteSingleTable (&TableInfo);
511 return_ACPI_STATUS (Status);
512 }
513
514 #if (!defined (ACPI_NO_METHOD_EXECUTION) && !defined (ACPI_CONSTANT_EVAL_ONLY))
515
516 Status = AcpiNsLoadTable (TableInfo.InstalledDesc, AcpiGbl_RootNode);
517 if (ACPI_FAILURE (Status))
518 {
519 /* Uninstall table and free the buffer */
520
521 AcpiTbDeleteTablesByType (ACPI_TABLE_ID_DSDT);
522 return_ACPI_STATUS (Status);
523 }
524 #endif
525 #endif
526
527 return_ACPI_STATUS (Status);
528 }
529
530
531 /*******************************************************************************
532 *
533 * FUNCTION: AcpiDbReadTableFromFile
534 *
535 * PARAMETERS: Filename - File where table is located
536 * Table - Where a pointer to the table is returned
537 *
538 * RETURN: Status
539 *
540 * DESCRIPTION: Get an ACPI table from a file
541 *
542 ******************************************************************************/
543
544 ACPI_STATUS
AcpiDbReadTableFromFile(char * Filename,ACPI_TABLE_HEADER ** Table)545 AcpiDbReadTableFromFile (
546 char *Filename,
547 ACPI_TABLE_HEADER **Table)
548 {
549 FILE *fp;
550 UINT32 TableLength;
551 ACPI_STATUS Status;
552
553
554 /* Open the file */
555
556 fp = fopen (Filename, "rb");
557 if (!fp)
558 {
559 AcpiOsPrintf ("Could not open input file %s\n", Filename);
560 return (AE_ERROR);
561 }
562
563 /* Get the entire file */
564
565 fprintf (stderr, "Loading Acpi table from file %s\n", Filename);
566 Status = AcpiDbReadTable (fp, Table, &TableLength);
567 fclose(fp);
568
569 if (ACPI_FAILURE (Status))
570 {
571 AcpiOsPrintf ("Could not get table from the file\n");
572 return (Status);
573 }
574
575 return (AE_OK);
576 }
577 #endif
578
579
580 /*******************************************************************************
581 *
582 * FUNCTION: AcpiDbGetTableFromFile
583 *
584 * PARAMETERS: Filename - File where table is located
585 * ReturnTable - Where a pointer to the table is returned
586 *
587 * RETURN: Status
588 *
589 * DESCRIPTION: Load an ACPI table from a file
590 *
591 ******************************************************************************/
592
593 ACPI_STATUS
AcpiDbGetTableFromFile(char * Filename,ACPI_TABLE_HEADER ** ReturnTable)594 AcpiDbGetTableFromFile (
595 char *Filename,
596 ACPI_TABLE_HEADER **ReturnTable)
597 {
598 #ifdef ACPI_APPLICATION
599 ACPI_STATUS Status;
600 ACPI_TABLE_HEADER *Table;
601 BOOLEAN IsAmlTable = TRUE;
602
603
604 Status = AcpiDbReadTableFromFile (Filename, &Table);
605 if (ACPI_FAILURE (Status))
606 {
607 return (Status);
608 }
609
610 #ifdef ACPI_DATA_TABLE_DISASSEMBLY
611 IsAmlTable = AcpiUtIsAmlTable (Table);
612 #endif
613
614 if (IsAmlTable)
615 {
616 /* Attempt to recognize and install the table */
617
618 Status = AeLocalLoadTable (Table);
619 if (ACPI_FAILURE (Status))
620 {
621 if (Status == AE_ALREADY_EXISTS)
622 {
623 AcpiOsPrintf ("Table %4.4s is already installed\n",
624 Table->Signature);
625 }
626 else
627 {
628 AcpiOsPrintf ("Could not install table, %s\n",
629 AcpiFormatException (Status));
630 }
631
632 return (Status);
633 }
634
635 fprintf (stderr,
636 "Acpi table [%4.4s] successfully installed and loaded\n",
637 Table->Signature);
638 }
639
640 AcpiGbl_AcpiHardwarePresent = FALSE;
641 if (ReturnTable)
642 {
643 *ReturnTable = Table;
644 }
645
646
647 #endif /* ACPI_APPLICATION */
648 return (AE_OK);
649 }
650
651 #endif /* ACPI_DEBUGGER */
652
653