1 /******************************************************************************
2 *
3 * Module Name: apdump - Dump routines for ACPI tables (acpidump)
4 *
5 *****************************************************************************/
6
7 /******************************************************************************
8 *
9 * 1. Copyright Notice
10 *
11 * Some or all of this work - Copyright (c) 1999 - 2023, Intel Corp.
12 * All rights reserved.
13 *
14 * 2. License
15 *
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
19 * property rights.
20 *
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
27 *
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
36 *
37 * The above copyright and patent license is granted only if the following
38 * conditions are met:
39 *
40 * 3. Conditions
41 *
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
53 *
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
64 * make.
65 *
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
70 * distribution.
71 *
72 * 3.4. Intel retains all right, title, and interest in and to the Original
73 * Intel Code.
74 *
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
79 *
80 * 4. Disclaimer and Export Compliance
81 *
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88 * PARTICULAR PURPOSE.
89 *
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97 * LIMITED REMEDY.
98 *
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government. In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
113 *
114 *****************************************************************************
115 *
116 * Alternatively, you may choose to be licensed under the terms of the
117 * following license:
118 *
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
121 * are met:
122 * 1. Redistributions of source code must retain the above copyright
123 * notice, this list of conditions, and the following disclaimer,
124 * without modification.
125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126 * substantially similar to the "NO WARRANTY" disclaimer below
127 * ("Disclaimer") and any redistribution must be conditioned upon
128 * including a substantially similar Disclaimer requirement for further
129 * binary redistribution.
130 * 3. Neither the names of the above-listed copyright holders nor the names
131 * of any contributors may be used to endorse or promote products derived
132 * from this software without specific prior written permission.
133 *
134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145 *
146 * Alternatively, you may choose to be licensed under the terms of the
147 * GNU General Public License ("GPL") version 2 as published by the Free
148 * Software Foundation.
149 *
150 *****************************************************************************/
151
152 #include "acpidump.h"
153
154
155 /* Local prototypes */
156
157 static int
158 ApDumpTableBuffer (
159 ACPI_TABLE_HEADER *Table,
160 UINT32 Instance,
161 ACPI_PHYSICAL_ADDRESS Address);
162
163
164 /******************************************************************************
165 *
166 * FUNCTION: ApIsValidHeader
167 *
168 * PARAMETERS: Table - Pointer to table to be validated
169 *
170 * RETURN: TRUE if the header appears to be valid. FALSE otherwise
171 *
172 * DESCRIPTION: Check for a valid ACPI table header
173 *
174 ******************************************************************************/
175
176 BOOLEAN
ApIsValidHeader(ACPI_TABLE_HEADER * Table)177 ApIsValidHeader (
178 ACPI_TABLE_HEADER *Table)
179 {
180
181 if (!ACPI_VALIDATE_RSDP_SIG (Table->Signature))
182 {
183 /* Make sure signature is all ASCII and a valid ACPI name */
184
185 if (!AcpiUtValidNameseg (Table->Signature))
186 {
187 fprintf (stderr, "Table signature (0x%8.8X) is invalid\n",
188 *(UINT32 *) Table->Signature);
189 return (FALSE);
190 }
191
192 /* Check for minimum table length */
193
194 if (Table->Length < sizeof (ACPI_TABLE_HEADER))
195 {
196 fprintf (stderr, "Table length (0x%8.8X) is invalid\n",
197 Table->Length);
198 return (FALSE);
199 }
200 }
201
202 return (TRUE);
203 }
204
205
206 /******************************************************************************
207 *
208 * FUNCTION: ApIsValidChecksum
209 *
210 * PARAMETERS: Table - Pointer to table to be validated
211 *
212 * RETURN: TRUE if the checksum appears to be valid. FALSE otherwise.
213 *
214 * DESCRIPTION: Check for a valid ACPI table checksum.
215 *
216 ******************************************************************************/
217
218 BOOLEAN
ApIsValidChecksum(ACPI_TABLE_HEADER * Table)219 ApIsValidChecksum (
220 ACPI_TABLE_HEADER *Table)
221 {
222 ACPI_STATUS Status;
223 ACPI_TABLE_RSDP *Rsdp;
224
225
226 if (ACPI_VALIDATE_RSDP_SIG (Table->Signature))
227 {
228 /*
229 * Checksum for RSDP.
230 * Note: Other checksums are computed during the table dump.
231 */
232 Rsdp = ACPI_CAST_PTR (ACPI_TABLE_RSDP, Table);
233 Status = AcpiTbValidateRsdp (Rsdp);
234 }
235 else
236 {
237 /* We don't have to check for a CDAT here, since CDAT is not in the RSDT/XSDT */
238
239 Status = AcpiUtVerifyChecksum (Table, Table->Length);
240 }
241
242 if (ACPI_FAILURE (Status))
243 {
244 fprintf (stderr, "%4.4s: Warning: wrong checksum in table\n",
245 Table->Signature);
246 }
247
248 return (AE_OK);
249 }
250
251
252 /******************************************************************************
253 *
254 * FUNCTION: ApGetTableLength
255 *
256 * PARAMETERS: Table - Pointer to the table
257 *
258 * RETURN: Table length
259 *
260 * DESCRIPTION: Obtain table length according to table signature.
261 *
262 ******************************************************************************/
263
264 UINT32
ApGetTableLength(ACPI_TABLE_HEADER * Table)265 ApGetTableLength (
266 ACPI_TABLE_HEADER *Table)
267 {
268 ACPI_TABLE_RSDP *Rsdp;
269
270
271 /* Check if table is valid */
272
273 if (!ApIsValidHeader (Table))
274 {
275 return (0);
276 }
277
278 if (ACPI_VALIDATE_RSDP_SIG (Table->Signature))
279 {
280 Rsdp = ACPI_CAST_PTR (ACPI_TABLE_RSDP, Table);
281 return (AcpiTbGetRsdpLength (Rsdp));
282 }
283
284 /* Normal ACPI table */
285
286 return (Table->Length);
287 }
288
289
290 /******************************************************************************
291 *
292 * FUNCTION: ApDumpTableBuffer
293 *
294 * PARAMETERS: Table - ACPI table to be dumped
295 * Instance - ACPI table instance no. to be dumped
296 * Address - Physical address of the table
297 *
298 * RETURN: None
299 *
300 * DESCRIPTION: Dump an ACPI table in standard ASCII hex format, with a
301 * header that is compatible with the AcpiXtract utility.
302 *
303 ******************************************************************************/
304
305 static int
ApDumpTableBuffer(ACPI_TABLE_HEADER * Table,UINT32 Instance,ACPI_PHYSICAL_ADDRESS Address)306 ApDumpTableBuffer (
307 ACPI_TABLE_HEADER *Table,
308 UINT32 Instance,
309 ACPI_PHYSICAL_ADDRESS Address)
310 {
311 UINT32 TableLength;
312
313
314 TableLength = ApGetTableLength (Table);
315
316 /* Print only the header if requested */
317
318 if (Gbl_SummaryMode)
319 {
320 AcpiTbPrintTableHeader (Address, Table);
321 return (0);
322 }
323
324 /* Dump to binary file if requested */
325
326 if (Gbl_BinaryMode)
327 {
328 return (ApWriteToBinaryFile (Table, Instance));
329 }
330
331 /*
332 * Dump the table with header for use with acpixtract utility.
333 * Note: simplest to just always emit a 64-bit address. AcpiXtract
334 * utility can handle this.
335 */
336 fprintf (Gbl_OutputFile, "%4.4s @ 0x%8.8X%8.8X\n",
337 Table->Signature, ACPI_FORMAT_UINT64 (Address));
338
339 AcpiUtDumpBufferToFile (Gbl_OutputFile,
340 ACPI_CAST_PTR (UINT8, Table), TableLength,
341 DB_BYTE_DISPLAY, 0);
342 fprintf (Gbl_OutputFile, "\n");
343 return (0);
344 }
345
346
347 /******************************************************************************
348 *
349 * FUNCTION: ApDumpAllTables
350 *
351 * PARAMETERS: None
352 *
353 * RETURN: Status
354 *
355 * DESCRIPTION: Get all tables from the RSDT/XSDT (or at least all of the
356 * tables that we can possibly get).
357 *
358 ******************************************************************************/
359
360 int
ApDumpAllTables(void)361 ApDumpAllTables (
362 void)
363 {
364 ACPI_TABLE_HEADER *Table;
365 UINT32 Instance = 0;
366 ACPI_PHYSICAL_ADDRESS Address;
367 ACPI_STATUS Status;
368 int TableStatus;
369 UINT32 i;
370
371
372 /* Get and dump all available ACPI tables */
373
374 for (i = 0; i < AP_MAX_ACPI_FILES; i++)
375 {
376 Status = AcpiOsGetTableByIndex (i, &Table, &Instance, &Address);
377 if (ACPI_FAILURE (Status))
378 {
379 /* AE_LIMIT means that no more tables are available */
380
381 if (Status == AE_LIMIT)
382 {
383 return (0);
384 }
385 else if (i == 0)
386 {
387 fprintf (stderr, "Could not get ACPI tables, %s\n",
388 AcpiFormatException (Status));
389 return (-1);
390 }
391 else
392 {
393 fprintf (stderr, "Could not get ACPI table at index %u, %s\n",
394 i, AcpiFormatException (Status));
395 continue;
396 }
397 }
398
399 TableStatus = ApDumpTableBuffer (Table, Instance, Address);
400 ACPI_FREE (Table);
401
402 if (TableStatus)
403 {
404 break;
405 }
406 }
407
408 /* Something seriously bad happened if the loop terminates here */
409
410 return (-1);
411 }
412
413
414 /******************************************************************************
415 *
416 * FUNCTION: ApDumpTableByAddress
417 *
418 * PARAMETERS: AsciiAddress - Address for requested ACPI table
419 *
420 * RETURN: Status
421 *
422 * DESCRIPTION: Get an ACPI table via a physical address and dump it.
423 *
424 ******************************************************************************/
425
426 int
ApDumpTableByAddress(char * AsciiAddress)427 ApDumpTableByAddress (
428 char *AsciiAddress)
429 {
430 ACPI_PHYSICAL_ADDRESS Address;
431 ACPI_TABLE_HEADER *Table;
432 ACPI_STATUS Status;
433 int TableStatus;
434 UINT64 LongAddress;
435
436
437 /* Convert argument to an integer physical address */
438
439 Status = AcpiUtStrtoul64 (AsciiAddress, &LongAddress);
440 if (ACPI_FAILURE (Status))
441 {
442 fprintf (stderr, "%s: Could not convert to a physical address\n",
443 AsciiAddress);
444 return (-1);
445 }
446
447 Address = (ACPI_PHYSICAL_ADDRESS) LongAddress;
448 Status = AcpiOsGetTableByAddress (Address, &Table);
449 if (ACPI_FAILURE (Status))
450 {
451 fprintf (stderr, "Could not get table at 0x%8.8X%8.8X, %s\n",
452 ACPI_FORMAT_UINT64 (Address),
453 AcpiFormatException (Status));
454 return (-1);
455 }
456
457 TableStatus = ApDumpTableBuffer (Table, 0, Address);
458 ACPI_FREE (Table);
459 return (TableStatus);
460 }
461
462
463 /******************************************************************************
464 *
465 * FUNCTION: ApDumpTableByName
466 *
467 * PARAMETERS: Signature - Requested ACPI table signature
468 *
469 * RETURN: Status
470 *
471 * DESCRIPTION: Get an ACPI table via a signature and dump it. Handles
472 * multiple tables with the same signature (SSDTs).
473 *
474 ******************************************************************************/
475
476 int
ApDumpTableByName(char * Signature)477 ApDumpTableByName (
478 char *Signature)
479 {
480 char LocalSignature [ACPI_NAMESEG_SIZE + 1];
481 UINT32 Instance;
482 ACPI_TABLE_HEADER *Table;
483 ACPI_PHYSICAL_ADDRESS Address;
484 ACPI_STATUS Status;
485 int TableStatus;
486
487
488 if (strlen (Signature) != ACPI_NAMESEG_SIZE)
489 {
490 fprintf (stderr,
491 "Invalid table signature [%s]: must be exactly 4 characters\n",
492 Signature);
493 return (-1);
494 }
495
496 /* Table signatures are expected to be uppercase */
497
498 strcpy (LocalSignature, Signature);
499 AcpiUtStrupr (LocalSignature);
500
501 /* To be friendly, handle tables whose signatures do not match the name */
502
503 if (ACPI_COMPARE_NAMESEG (LocalSignature, "FADT"))
504 {
505 strcpy (LocalSignature, ACPI_SIG_FADT);
506 }
507 else if (ACPI_COMPARE_NAMESEG (LocalSignature, "MADT"))
508 {
509 strcpy (LocalSignature, ACPI_SIG_MADT);
510 }
511
512 /* Dump all instances of this signature (to handle multiple SSDTs) */
513
514 for (Instance = 0; Instance < AP_MAX_ACPI_FILES; Instance++)
515 {
516 Status = AcpiOsGetTableByName (LocalSignature, Instance,
517 &Table, &Address);
518 if (ACPI_FAILURE (Status))
519 {
520 /* AE_LIMIT means that no more tables are available */
521
522 if (Status == AE_LIMIT)
523 {
524 return (0);
525 }
526
527 fprintf (stderr,
528 "Could not get ACPI table with signature [%s], %s\n",
529 LocalSignature, AcpiFormatException (Status));
530 return (-1);
531 }
532
533 TableStatus = ApDumpTableBuffer (Table, Instance, Address);
534 ACPI_FREE (Table);
535
536 if (TableStatus)
537 {
538 break;
539 }
540 }
541
542 /* Something seriously bad happened if the loop terminates here */
543
544 return (-1);
545 }
546
547
548 /******************************************************************************
549 *
550 * FUNCTION: ApDumpTableFromFile
551 *
552 * PARAMETERS: Pathname - File containing the binary ACPI table
553 *
554 * RETURN: Status
555 *
556 * DESCRIPTION: Dump an ACPI table from a binary file
557 *
558 ******************************************************************************/
559
560 int
ApDumpTableFromFile(char * Pathname)561 ApDumpTableFromFile (
562 char *Pathname)
563 {
564 ACPI_TABLE_HEADER *Table;
565 UINT32 FileSize = 0;
566 int TableStatus = -1;
567
568
569 /* Get the entire ACPI table from the file */
570
571 Table = ApGetTableFromFile (Pathname, &FileSize);
572 if (!Table)
573 {
574 return (-1);
575 }
576
577 if (!AcpiUtValidNameseg (Table->Signature))
578 {
579 fprintf (stderr,
580 "No valid ACPI signature was found in input file %s\n",
581 Pathname);
582 }
583
584 /* File must be at least as long as the table length */
585
586 if (Table->Length > FileSize)
587 {
588 fprintf (stderr,
589 "Table length (0x%X) is too large for input file (0x%X) %s\n",
590 Table->Length, FileSize, Pathname);
591 goto Exit;
592 }
593
594 if (Gbl_VerboseMode)
595 {
596 fprintf (stderr,
597 "Input file: %s contains table [%4.4s], 0x%X (%u) bytes\n",
598 Pathname, Table->Signature, FileSize, FileSize);
599 }
600
601 TableStatus = ApDumpTableBuffer (Table, 0, 0);
602
603 Exit:
604 ACPI_FREE (Table);
605 return (TableStatus);
606 }
607
