Sync ACPICA with Intel's version 20180508 (from previously 20170831).
[dragonfly.git] / sys / contrib / dev / acpica / source / common / dmtbdump3.c
blob3c1dea6c825711de6d1cfc5b96f2481709acae49
1 /******************************************************************************
3 * Module Name: dmtbdump3 - Dump ACPI data tables that contain no AML code
5 *****************************************************************************/
7 /******************************************************************************
9 * 1. Copyright Notice
11 * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
12 * All rights reserved.
14 * 2. License
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.
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
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;
37 * The above copyright and patent license is granted only if the following
38 * conditions are met:
40 * 3. Conditions
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.
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.
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.
72 * 3.4. Intel retains all right, title, and interest in and to the Original
73 * Intel Code.
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.
80 * 4. Disclaimer and Export Compliance
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.
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.
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.
114 *****************************************************************************
116 * Alternatively, you may choose to be licensed under the terms of the
117 * following license:
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.
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.
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.
150 *****************************************************************************/
152 #include "acpi.h"
153 #include "accommon.h"
154 #include "acdisasm.h"
155 #include "actables.h"
157 /* This module used for application-level code only */
159 #define _COMPONENT ACPI_CA_DISASSEMBLER
160 ACPI_MODULE_NAME ("dmtbdump3")
163 /*******************************************************************************
165 * FUNCTION: AcpiDmDumpSlic
167 * PARAMETERS: Table - A SLIC table
169 * RETURN: None
171 * DESCRIPTION: Format the contents of a SLIC
173 ******************************************************************************/
175 void
176 AcpiDmDumpSlic (
177 ACPI_TABLE_HEADER *Table)
180 (void) AcpiDmDumpTable (Table->Length, sizeof (ACPI_TABLE_HEADER), Table,
181 Table->Length - sizeof (*Table), AcpiDmTableInfoSlic);
185 /*******************************************************************************
187 * FUNCTION: AcpiDmDumpSlit
189 * PARAMETERS: Table - An SLIT
191 * RETURN: None
193 * DESCRIPTION: Format the contents of a SLIT
195 ******************************************************************************/
197 void
198 AcpiDmDumpSlit (
199 ACPI_TABLE_HEADER *Table)
201 ACPI_STATUS Status;
202 UINT32 Offset;
203 UINT8 *Row;
204 UINT32 Localities;
205 UINT32 i;
206 UINT32 j;
209 /* Main table */
211 Status = AcpiDmDumpTable (Table->Length, 0, Table, 0, AcpiDmTableInfoSlit);
212 if (ACPI_FAILURE (Status))
214 return;
217 /* Display the Locality NxN Matrix */
219 Localities = (UINT32) ACPI_CAST_PTR (ACPI_TABLE_SLIT, Table)->LocalityCount;
220 Offset = ACPI_OFFSET (ACPI_TABLE_SLIT, Entry[0]);
221 Row = (UINT8 *) ACPI_CAST_PTR (ACPI_TABLE_SLIT, Table)->Entry;
223 for (i = 0; i < Localities; i++)
225 /* Display one row of the matrix */
227 AcpiDmLineHeader2 (Offset, Localities, "Locality", i);
228 for (j = 0; j < Localities; j++)
230 /* Check for beyond EOT */
232 if (Offset >= Table->Length)
234 AcpiOsPrintf (
235 "\n**** Not enough room in table for all localities\n");
236 return;
239 AcpiOsPrintf ("%2.2X", Row[j]);
240 Offset++;
242 /* Display up to 16 bytes per output row */
244 if ((j+1) < Localities)
246 AcpiOsPrintf (" ");
248 if (j && (((j+1) % 16) == 0))
250 AcpiOsPrintf ("\\\n"); /* With line continuation char */
251 AcpiDmLineHeader (Offset, 0, NULL);
256 /* Point to next row */
258 AcpiOsPrintf ("\n");
259 Row += Localities;
264 /*******************************************************************************
266 * FUNCTION: AcpiDmDumpSrat
268 * PARAMETERS: Table - A SRAT table
270 * RETURN: None
272 * DESCRIPTION: Format the contents of a SRAT
274 ******************************************************************************/
276 void
277 AcpiDmDumpSrat (
278 ACPI_TABLE_HEADER *Table)
280 ACPI_STATUS Status;
281 UINT32 Offset = sizeof (ACPI_TABLE_SRAT);
282 ACPI_SUBTABLE_HEADER *Subtable;
283 ACPI_DMTABLE_INFO *InfoTable;
286 /* Main table */
288 Status = AcpiDmDumpTable (Table->Length, 0, Table, 0, AcpiDmTableInfoSrat);
289 if (ACPI_FAILURE (Status))
291 return;
294 /* Subtables */
296 Subtable = ACPI_ADD_PTR (ACPI_SUBTABLE_HEADER, Table, Offset);
297 while (Offset < Table->Length)
299 /* Common subtable header */
301 AcpiOsPrintf ("\n");
302 Status = AcpiDmDumpTable (Table->Length, Offset, Subtable,
303 Subtable->Length, AcpiDmTableInfoSratHdr);
304 if (ACPI_FAILURE (Status))
306 return;
309 switch (Subtable->Type)
311 case ACPI_SRAT_TYPE_CPU_AFFINITY:
313 InfoTable = AcpiDmTableInfoSrat0;
314 break;
316 case ACPI_SRAT_TYPE_MEMORY_AFFINITY:
318 InfoTable = AcpiDmTableInfoSrat1;
319 break;
321 case ACPI_SRAT_TYPE_X2APIC_CPU_AFFINITY:
323 InfoTable = AcpiDmTableInfoSrat2;
324 break;
326 case ACPI_SRAT_TYPE_GICC_AFFINITY:
328 InfoTable = AcpiDmTableInfoSrat3;
329 break;
331 case ACPI_SRAT_TYPE_GIC_ITS_AFFINITY:
333 InfoTable = AcpiDmTableInfoSrat4;
334 break;
336 default:
337 AcpiOsPrintf ("\n**** Unknown SRAT subtable type 0x%X\n",
338 Subtable->Type);
340 /* Attempt to continue */
342 if (!Subtable->Length)
344 AcpiOsPrintf ("Invalid zero length subtable\n");
345 return;
347 goto NextSubtable;
350 AcpiOsPrintf ("\n");
351 Status = AcpiDmDumpTable (Table->Length, Offset, Subtable,
352 Subtable->Length, InfoTable);
353 if (ACPI_FAILURE (Status))
355 return;
358 NextSubtable:
359 /* Point to next subtable */
361 Offset += Subtable->Length;
362 Subtable = ACPI_ADD_PTR (ACPI_SUBTABLE_HEADER, Subtable,
363 Subtable->Length);
368 /*******************************************************************************
370 * FUNCTION: AcpiDmDumpStao
372 * PARAMETERS: Table - A STAO table
374 * RETURN: None
376 * DESCRIPTION: Format the contents of a STAO. This is a variable-length
377 * table that contains an open-ended number of ASCII strings
378 * at the end of the table.
380 ******************************************************************************/
382 void
383 AcpiDmDumpStao (
384 ACPI_TABLE_HEADER *Table)
386 ACPI_STATUS Status;
387 char *Namepath;
388 UINT32 Length = Table->Length;
389 UINT32 StringLength;
390 UINT32 Offset = sizeof (ACPI_TABLE_STAO);
393 /* Main table */
395 Status = AcpiDmDumpTable (Length, 0, Table, 0, AcpiDmTableInfoStao);
396 if (ACPI_FAILURE (Status))
398 return;
401 /* The rest of the table consists of Namepath strings */
403 while (Offset < Table->Length)
405 Namepath = ACPI_ADD_PTR (char, Table, Offset);
406 StringLength = strlen (Namepath) + 1;
408 AcpiDmLineHeader (Offset, StringLength, "Namestring");
409 AcpiOsPrintf ("\"%s\"\n", Namepath);
411 /* Point to next namepath */
413 Offset += StringLength;
418 /*******************************************************************************
420 * FUNCTION: AcpiDmDumpTcpa
422 * PARAMETERS: Table - A TCPA table
424 * RETURN: None
426 * DESCRIPTION: Format the contents of a TCPA.
428 * NOTE: There are two versions of the table with the same signature:
429 * the client version and the server version. The common
430 * PlatformClass field is used to differentiate the two types of
431 * tables.
433 ******************************************************************************/
435 void
436 AcpiDmDumpTcpa (
437 ACPI_TABLE_HEADER *Table)
439 UINT32 Offset = sizeof (ACPI_TABLE_TCPA_HDR);
440 ACPI_TABLE_TCPA_HDR *CommonHeader = ACPI_CAST_PTR (
441 ACPI_TABLE_TCPA_HDR, Table);
442 ACPI_TABLE_TCPA_HDR *Subtable = ACPI_ADD_PTR (
443 ACPI_TABLE_TCPA_HDR, Table, Offset);
444 ACPI_STATUS Status;
447 /* Main table */
449 Status = AcpiDmDumpTable (Table->Length, 0, Table,
450 0, AcpiDmTableInfoTcpaHdr);
451 if (ACPI_FAILURE (Status))
453 return;
457 * Examine the PlatformClass field to determine the table type.
458 * Either a client or server table. Only one.
460 switch (CommonHeader->PlatformClass)
462 case ACPI_TCPA_CLIENT_TABLE:
464 Status = AcpiDmDumpTable (Table->Length, Offset, Subtable,
465 Table->Length - Offset, AcpiDmTableInfoTcpaClient);
466 break;
468 case ACPI_TCPA_SERVER_TABLE:
470 Status = AcpiDmDumpTable (Table->Length, Offset, Subtable,
471 Table->Length - Offset, AcpiDmTableInfoTcpaServer);
472 break;
474 default:
476 AcpiOsPrintf ("\n**** Unknown TCPA Platform Class 0x%X\n",
477 CommonHeader->PlatformClass);
478 Status = AE_ERROR;
479 break;
482 if (ACPI_FAILURE (Status))
484 AcpiOsPrintf ("\n**** Cannot disassemble TCPA table\n");
489 /*******************************************************************************
491 * FUNCTION: AcpiDmDumpTpm2
493 * PARAMETERS: Table - A TPM2 table
495 * RETURN: None
497 * DESCRIPTION: Format the contents of a TPM2.
499 ******************************************************************************/
501 void
502 AcpiDmDumpTpm2 (
503 ACPI_TABLE_HEADER *Table)
505 UINT32 Offset = sizeof (ACPI_TABLE_TPM2);
506 ACPI_TABLE_TPM2 *CommonHeader = ACPI_CAST_PTR (ACPI_TABLE_TPM2, Table);
507 ACPI_TPM2_TRAILER *Subtable = ACPI_ADD_PTR (ACPI_TPM2_TRAILER, Table, Offset);
508 ACPI_TPM2_ARM_SMC *ArmSubtable;
509 ACPI_STATUS Status;
512 /* Main table */
514 Status = AcpiDmDumpTable (Table->Length, 0, Table, 0, AcpiDmTableInfoTpm2);
515 if (ACPI_FAILURE (Status))
517 return;
520 AcpiOsPrintf ("\n");
521 Status = AcpiDmDumpTable (Table->Length, Offset, Subtable,
522 Table->Length - Offset, AcpiDmTableInfoTpm2a);
523 if (ACPI_FAILURE (Status))
525 return;
528 switch (CommonHeader->StartMethod)
530 case ACPI_TPM2_COMMAND_BUFFER_WITH_ARM_SMC:
532 ArmSubtable = ACPI_ADD_PTR (ACPI_TPM2_ARM_SMC, Subtable,
533 sizeof (ACPI_TPM2_TRAILER));
534 Offset += sizeof (ACPI_TPM2_TRAILER);
536 AcpiOsPrintf ("\n");
537 Status = AcpiDmDumpTable (Table->Length, Offset, ArmSubtable,
538 Table->Length - Offset, AcpiDmTableInfoTpm211);
539 break;
541 default:
542 break;
547 /*******************************************************************************
549 * FUNCTION: AcpiDmDumpVrtc
551 * PARAMETERS: Table - A VRTC table
553 * RETURN: None
555 * DESCRIPTION: Format the contents of a VRTC
557 ******************************************************************************/
559 void
560 AcpiDmDumpVrtc (
561 ACPI_TABLE_HEADER *Table)
563 ACPI_STATUS Status;
564 UINT32 Offset = sizeof (ACPI_TABLE_VRTC);
565 ACPI_VRTC_ENTRY *Subtable;
568 /* Main table */
570 Status = AcpiDmDumpTable (Table->Length, 0, Table, 0, AcpiDmTableInfoVrtc);
571 if (ACPI_FAILURE (Status))
573 return;
576 /* Subtables */
578 Subtable = ACPI_ADD_PTR (ACPI_VRTC_ENTRY, Table, Offset);
579 while (Offset < Table->Length)
581 /* Common subtable header */
583 AcpiOsPrintf ("\n");
584 Status = AcpiDmDumpTable (Table->Length, Offset, Subtable,
585 sizeof (ACPI_VRTC_ENTRY), AcpiDmTableInfoVrtc0);
586 if (ACPI_FAILURE (Status))
588 return;
591 /* Point to next subtable */
593 Offset += sizeof (ACPI_VRTC_ENTRY);
594 Subtable = ACPI_ADD_PTR (ACPI_VRTC_ENTRY, Subtable,
595 sizeof (ACPI_VRTC_ENTRY));
600 /*******************************************************************************
602 * FUNCTION: AcpiDmDumpWdat
604 * PARAMETERS: Table - A WDAT table
606 * RETURN: None
608 * DESCRIPTION: Format the contents of a WDAT
610 ******************************************************************************/
612 void
613 AcpiDmDumpWdat (
614 ACPI_TABLE_HEADER *Table)
616 ACPI_STATUS Status;
617 UINT32 Offset = sizeof (ACPI_TABLE_WDAT);
618 ACPI_WDAT_ENTRY *Subtable;
621 /* Main table */
623 Status = AcpiDmDumpTable (Table->Length, 0, Table, 0, AcpiDmTableInfoWdat);
624 if (ACPI_FAILURE (Status))
626 return;
629 /* Subtables */
631 Subtable = ACPI_ADD_PTR (ACPI_WDAT_ENTRY, Table, Offset);
632 while (Offset < Table->Length)
634 /* Common subtable header */
636 AcpiOsPrintf ("\n");
637 Status = AcpiDmDumpTable (Table->Length, Offset, Subtable,
638 sizeof (ACPI_WDAT_ENTRY), AcpiDmTableInfoWdat0);
639 if (ACPI_FAILURE (Status))
641 return;
644 /* Point to next subtable */
646 Offset += sizeof (ACPI_WDAT_ENTRY);
647 Subtable = ACPI_ADD_PTR (ACPI_WDAT_ENTRY, Subtable,
648 sizeof (ACPI_WDAT_ENTRY));
653 /*******************************************************************************
655 * FUNCTION: AcpiDmDumpWpbt
657 * PARAMETERS: Table - A WPBT table
659 * RETURN: None
661 * DESCRIPTION: Format the contents of a WPBT. This table type consists
662 * of an open-ended arguments buffer at the end of the table.
664 ******************************************************************************/
666 void
667 AcpiDmDumpWpbt (
668 ACPI_TABLE_HEADER *Table)
670 ACPI_STATUS Status;
671 ACPI_TABLE_WPBT *Subtable;
672 UINT32 Length = Table->Length;
673 UINT16 ArgumentsLength;
676 /* Dump the main table */
678 Status = AcpiDmDumpTable (Length, 0, Table, 0, AcpiDmTableInfoWpbt);
679 if (ACPI_FAILURE (Status))
681 return;
684 /* Extract the arguments buffer length from the main table */
686 Subtable = ACPI_CAST_PTR (ACPI_TABLE_WPBT, Table);
687 ArgumentsLength = Subtable->ArgumentsLength;
689 /* Dump the arguments buffer */
691 (void) AcpiDmDumpTable (Table->Length, 0, Table, ArgumentsLength,
692 AcpiDmTableInfoWpbt0);