ShellPkg: acpiview: Add support for parsing FACS

[mirror_edk2.git] / ShellPkg / Library / UefiShellAcpiViewCommandLib / Parsers / Fadt / FadtParser.c

diff --git a/ShellPkg/Library/UefiShellAcpiViewCommandLib/Parsers/Fadt/FadtParser.c b/ShellPkg/Library/UefiShellAcpiViewCommandLib/Parsers/Fadt/FadtParser.c
index e40c9ef8ee4b3285faf8c6edf3cb6236ee367397..5b8cc174f16afb3d4feb6a518952e60c6564ee34 100644 (file)
--- a/ShellPkg/Library/UefiShellAcpiViewCommandLib/Parsers/Fadt/FadtParser.c
+++ b/ShellPkg/Library/UefiShellAcpiViewCommandLib/Parsers/Fadt/FadtParser.c
@@ -5,17 +5,21 @@
   SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
   @par Reference(s):\r
-    - ACPI 6.2 Specification - Errata A, September 2017\r
+    - ACPI 6.3 Specification - January 2019\r
 **/\r
 \r
 #include <IndustryStandard/Acpi.h>\r
 #include <Library/UefiLib.h>\r
 #include "AcpiParser.h"\r
 #include "AcpiTableParser.h"\r
+#include "AcpiView.h"\r
 \r
 // Local variables\r
 STATIC CONST UINT32* DsdtAddress;\r
 STATIC CONST UINT64* X_DsdtAddress;\r
+STATIC CONST UINT32* Flags;\r
+STATIC CONST UINT32* FirmwareCtrl;\r
+STATIC CONST UINT64* X_FirmwareCtrl;\r
 STATIC CONST UINT8*  FadtMinorRevision;\r
 STATIC ACPI_DESCRIPTION_HEADER_INFO AcpiHdrInfo;\r
 \r
@@ -24,6 +28,21 @@ STATIC ACPI_DESCRIPTION_HEADER_INFO AcpiHdrInfo;
 **/\r
 #define HW_REDUCED_ACPI   BIT20\r
 \r
+/**\r
+  Offset to the FACS signature from the start of the FACS.\r
+**/\r
+#define FACS_SIGNATURE_OFFSET   0\r
+\r
+/**\r
+  Offset to the FACS revision from the start of the FACS.\r
+**/\r
+#define FACS_VERSION_OFFSET     32\r
+\r
+/**\r
+  Offset to the FACS length from the start of the FACS.\r
+**/\r
+#define FACS_LENGTH_OFFSET      4\r
+\r
 /**\r
   Get the ACPI XSDT header info.\r
 **/\r
@@ -113,7 +132,8 @@ ValidateFlags (
 **/\r
 STATIC CONST ACPI_PARSER FadtParser[] = {\r
   PARSE_ACPI_HEADER (&AcpiHdrInfo),\r
-  {L"FIRMWARE_CTRL", 4, 36, L"0x%x", NULL, NULL, ValidateFirmwareCtrl, NULL},\r
+  {L"FIRMWARE_CTRL", 4, 36, L"0x%x", NULL, (VOID**)&FirmwareCtrl,\r
+    ValidateFirmwareCtrl, NULL},\r
   {L"DSDT", 4, 40, L"0x%x", NULL, (VOID**)&DsdtAddress, NULL, NULL},\r
   {L"Reserved", 1, 44, L"%x", NULL, NULL, NULL, NULL},\r
   {L"Preferred_PM_Profile", 1, 45, L"0x%x", NULL, NULL, NULL, NULL},\r
@@ -150,13 +170,13 @@ STATIC CONST ACPI_PARSER FadtParser[] = {
   {L"CENTURY", 1, 108, L"0x%x", NULL, NULL, NULL, NULL},\r
   {L"IAPC_BOOT_ARCH", 2, 109, L"0x%x", NULL, NULL, NULL, NULL},\r
   {L"Reserved", 1, 111, L"0x%x", NULL, NULL, NULL, NULL},\r
-  {L"Flags", 4, 112, L"0x%x", NULL, NULL, ValidateFlags, NULL},\r
+  {L"Flags", 4, 112, L"0x%x", NULL, (VOID**)&Flags, ValidateFlags, NULL},\r
   {L"RESET_REG", 12, 116, NULL, DumpGas, NULL, NULL, NULL},\r
   {L"RESET_VALUE", 1, 128, L"0x%x", NULL, NULL, NULL, NULL},\r
   {L"ARM_BOOT_ARCH", 2, 129, L"0x%x", NULL, NULL, NULL, NULL},\r
   {L"FADT Minor Version", 1, 131, L"0x%x", NULL, (VOID**)&FadtMinorRevision,\r
     NULL, NULL},\r
-  {L"X_FIRMWARE_CTRL", 8, 132, L"0x%lx", NULL, NULL,\r
+  {L"X_FIRMWARE_CTRL", 8, 132, L"0x%lx", NULL, (VOID**)&X_FirmwareCtrl,\r
     ValidateXFirmwareCtrl, NULL},\r
   {L"X_DSDT", 8, 140, L"0x%lx", NULL, (VOID**)&X_DsdtAddress, NULL, NULL},\r
   {L"X_PM1a_EVT_BLK", 12, 148, NULL, DumpGas, NULL, NULL, NULL},\r
@@ -192,7 +212,13 @@ ParseAcpiFadt (
   IN UINT8   AcpiTableRevision\r
   )\r
 {\r
-  UINT8*  DsdtPtr;\r
+  EFI_STATUS              Status;\r
+  UINT8*                  DsdtPtr;\r
+  UINT8*                  FirmwareCtrlPtr;\r
+  UINT32                  FacsSignature;\r
+  UINT32                  FacsLength;\r
+  UINT8                   FacsRevision;\r
+  PARSE_ACPI_TABLE_PROC   FacsParserProc;\r
 \r
   ParseAcpi (\r
     Trace,\r
@@ -214,6 +240,60 @@ ParseAcpiFadt (
     }\r
   }\r
 \r
+  // If X_FIRMWARE_CTRL is not zero then use X_FIRMWARE_CTRL and ignore\r
+  // FIRMWARE_CTRL, else use FIRMWARE_CTRL.\r
+  if ((X_FirmwareCtrl != NULL) && (*X_FirmwareCtrl != 0)) {\r
+    FirmwareCtrlPtr = (UINT8*)(UINTN)(*X_FirmwareCtrl);\r
+  } else if ((FirmwareCtrl != NULL) && (*FirmwareCtrl != 0)) {\r
+    FirmwareCtrlPtr = (UINT8*)(UINTN)(*FirmwareCtrl);\r
+  } else {\r
+    FirmwareCtrlPtr = NULL;\r
+    // if HW_REDUCED_ACPI flag is not set, both FIRMWARE_CTRL and\r
+    // X_FIRMWARE_CTRL cannot be zero, and the FACS Table must be\r
+    // present.\r
+    if ((Trace) &&\r
+        (Flags != NULL) &&\r
+        ((*Flags & EFI_ACPI_6_3_HW_REDUCED_ACPI) != 0)) {\r
+      IncrementErrorCount ();\r
+      Print (L"ERROR: No FACS table found, "\r
+               L"both X_FIRMWARE_CTRL and FIRMWARE_CTRL are zero.\n");\r
+    }\r
+  }\r
+\r
+  if (FirmwareCtrlPtr != NULL) {\r
+    // The FACS table does not have a standard ACPI table header. Therefore,\r
+    // the signature, length and version needs to be initially parsed.\r
+    // The FACS signature is 4 bytes starting at offset 0.\r
+    FacsSignature = *(UINT32*)(FirmwareCtrlPtr + FACS_SIGNATURE_OFFSET);\r
+\r
+    // The FACS length is 4 bytes starting at offset 4.\r
+    FacsLength = *(UINT32*)(FirmwareCtrlPtr + FACS_LENGTH_OFFSET);\r
+\r
+    // The FACS version is 1 byte starting at offset 32.\r
+    FacsRevision = *(UINT8*)(FirmwareCtrlPtr + FACS_VERSION_OFFSET);\r
+\r
+    Trace = ProcessTableReportOptions (\r
+              FacsSignature,\r
+              FirmwareCtrlPtr,\r
+              FacsLength\r
+              );\r
+\r
+    Status = GetParser (FacsSignature, &FacsParserProc);\r
+    if (EFI_ERROR (Status)) {\r
+      Print (\r
+        L"ERROR: No registered parser found for FACS.\n"\r
+        );\r
+      return;\r
+    }\r
+\r
+    FacsParserProc (\r
+      Trace,\r
+      FirmwareCtrlPtr,\r
+      FacsLength,\r
+      FacsRevision\r
+      );\r
+  }\r
+\r
   // If X_DSDT is not zero then use X_DSDT and ignore DSDT,\r
   // else use DSDT.\r
   if (*X_DsdtAddress != 0) {\r