ShellPkg: Add acpiview tool to dump ACPI tables
[mirror_edk2.git] / ShellPkg / Library / UefiShellAcpiViewCommandLib / Parsers / Slit / SlitParser.c
1 /**\r
2   SLIT table parser\r
3 \r
4   Copyright (c) 2016 - 2018, ARM Limited. All rights reserved.\r
5   This program and the accompanying materials\r
6   are licensed and made available under the terms and conditions of the BSD License\r
7   which accompanies this distribution.  The full text of the license may be found at\r
8   http://opensource.org/licenses/bsd-license.php\r
9 \r
10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12 \r
13   @par Reference(s):\r
14     - ACPI 6.2 Specification - Errata A, September 2017\r
15 **/\r
16 \r
17 #include <IndustryStandard/Acpi.h>\r
18 #include <Library/PrintLib.h>\r
19 #include <Library/UefiLib.h>\r
20 #include "AcpiParser.h"\r
21 #include "AcpiTableParser.h"\r
22 \r
23 // Local Variables\r
24 STATIC CONST UINT64* SlitSystemLocalityCount;\r
25 STATIC ACPI_DESCRIPTION_HEADER_INFO AcpiHdrInfo;\r
26 \r
27 /** An ACPI_PARSER array describing the ACPI SLIT table.\r
28 */\r
29 STATIC CONST ACPI_PARSER SlitParser[] = {\r
30   PARSE_ACPI_HEADER (&AcpiHdrInfo),\r
31   {L"Number of System Localities", 8, 36, L"0x%lx", NULL,\r
32    (VOID**)&SlitSystemLocalityCount, NULL, NULL}\r
33 };\r
34 \r
35 /** Macro to get the value of a System Locality\r
36 */\r
37 #define SLIT_ELEMENT(Ptr, i, j) *(Ptr + (i * LocalityCount) + j)\r
38 \r
39 /** This function parses the ACPI SLIT table.\r
40   When trace is enabled this function parses the SLIT table and\r
41   traces the ACPI table fields.\r
42 \r
43   This function also validates System Localities for the following:\r
44     - Diagonal elements have a normalized value of 10\r
45     - Relative distance from System Locality at i*N+j is same as\r
46       j*N+i\r
47 \r
48   @param [in] Trace              If TRUE, trace the ACPI fields.\r
49   @param [in] Ptr                Pointer to the start of the buffer.\r
50   @param [in] AcpiTableLength    Length of the ACPI table.\r
51   @param [in] AcpiTableRevision  Revision of the ACPI table.\r
52 */\r
53 VOID\r
54 EFIAPI\r
55 ParseAcpiSlit (\r
56   IN BOOLEAN Trace,\r
57   IN UINT8*  Ptr,\r
58   IN UINT32  AcpiTableLength,\r
59   IN UINT8   AcpiTableRevision\r
60   )\r
61 {\r
62   UINT32 Offset;\r
63   UINT64 i;\r
64   UINT64 j;\r
65   UINT64 LocalityCount;\r
66   UINT8* LocalityPtr;\r
67   CHAR16 Buffer[80];  // Used for AsciiName param of ParseAcpi\r
68 \r
69   if (!Trace) {\r
70     return;\r
71   }\r
72 \r
73   Offset = ParseAcpi (\r
74              TRUE,\r
75              0,\r
76              "SLIT",\r
77              Ptr,\r
78              AcpiTableLength,\r
79              PARSER_PARAMS (SlitParser)\r
80              );\r
81   LocalityPtr = Ptr + Offset;\r
82 \r
83   LocalityCount = *SlitSystemLocalityCount;\r
84   // We only print the Localities if the count is less than 16\r
85   // If the locality count is more than 16 then refer to the\r
86   // raw data dump.\r
87   if (LocalityCount < 16) {\r
88     UnicodeSPrint (\r
89       Buffer,\r
90       sizeof (Buffer),\r
91       L"Entry[0x%lx][0x%lx]",\r
92       LocalityCount,\r
93       LocalityCount\r
94       );\r
95     PrintFieldName (0, Buffer);\r
96     Print (L"\n");\r
97     Print (L"       ");\r
98     for (j = 0; j < LocalityCount; j++) {\r
99       Print (L" (%3d) ", j);\r
100     }\r
101     Print (L"\n");\r
102     for (i = 0; i < LocalityCount; i++) {\r
103       Print (L" (%3d) ", i);\r
104       for (j = 0; j < LocalityCount; j++) {\r
105         Print (L"  %3d  ", SLIT_ELEMENT (LocalityPtr, i, j));\r
106       }\r
107       Print (L"\n");\r
108     }\r
109   }\r
110 \r
111   // Validate\r
112   for (i = 0; i < LocalityCount; i++) {\r
113     for (j = 0; j < LocalityCount; j++) {\r
114       // Element[x][x] must be equal to 10\r
115       if ((i == j) && (SLIT_ELEMENT (LocalityPtr, i, j) != 10)) {\r
116         IncrementErrorCount ();\r
117         Print (\r
118           L"ERROR: Diagonal Element[0x%lx][0x%lx] (%3d)."\r
119             " Normalized Value is not 10\n",\r
120           i,\r
121           j,\r
122           SLIT_ELEMENT (LocalityPtr, i, j)\r
123           );\r
124       }\r
125       // Element[i][j] must be equal to Element[j][i]\r
126       if (SLIT_ELEMENT (LocalityPtr, i, j) !=\r
127           SLIT_ELEMENT (LocalityPtr, j, i)) {\r
128         IncrementErrorCount ();\r
129         Print (\r
130           L"ERROR: Relative distances for Element[0x%lx][0x%lx] (%3d) and \n"\r
131            "Element[0x%lx][0x%lx] (%3d) do not match.\n",\r
132           i,\r
133           j,\r
134           SLIT_ELEMENT (LocalityPtr, i, j),\r
135           j,\r
136           i,\r
137           SLIT_ELEMENT (LocalityPtr, j, i)\r
138           );\r
139       }\r
140     }\r
141   }\r
142 }\r