Ampere Altra Mt. Jade: Upstream bugfixes, improvements, and features

Platform/Ampere/JadePkg/AcpiTables/Dsdt.asl

@@ -1,6 +1,6 @@
 /** @file
 
-  Copyright (c) 2020 - 2023, Ampere Computing LLC. All rights reserved.<BR>
+  Copyright (c) 2020 - 2024, Ampere Computing LLC. All rights reserved.<BR>
 
   SPDX-License-Identifier: BSD-2-Clause-Patent
 
@@ -1020,6 +1020,22 @@ DefinitionBlock("Dsdt.aml", "DSDT", 0x02, "Ampere", "Jade", 1) {
       }
     }
 
+    //
+    // LED Device
+    //
+    Device (LED) {
+      Name (_HID, "AMPC0008")
+      Name (_CCA, ONE)
+      Name (_STR, Unicode ("Altra LED Device"))
+
+      Name (_DSD, Package () {
+        ToUUID ("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
+        Package () {
+          Package () { "uuid", Package (4) { 0x5598273c, 0xa49611ea, 0xbb370242, 0xac130002 }},
+        }
+      })
+    }
+
     Include ("PCI-S0.Rca01.asi")
     Include ("PCI-S0.asi")
     Include ("PCI-S1.asi")

Platform/Ampere/JadePkg/Drivers/AcpiPlatformDxe/AcpiApei.c

@@ -1,6 +1,6 @@
 /** @file
 
-  Copyright (c) 2020 - 2021, Ampere Computing LLC. All rights reserved.<BR>
+  Copyright (c) 2020 - 2024, Ampere Computing LLC. All rights reserved.<BR>
 
   SPDX-License-Identifier: BSD-2-Clause-Patent
 
@@ -17,6 +17,70 @@
 UINT8 AMPERE_GUID[16] = {0x8d, 0x89, 0xed, 0xe8, 0x16, 0xdf, 0xcc, 0x43, 0x8e, 0xcc, 0x54, 0xf0, 0x60, 0xef, 0x15, 0x7f};
 CHAR8 DEFAULT_BERT_REBOOT_MSG[BERT_MSG_SIZE] = "Unknown reboot reason";
 
+BOOLEAN
+IsBertStatusValid (
+  BERT_ERROR_STATUS *BertStatus
+  )
+{
+  if (CompareMem (BertStatus->Guid, AMPERE_GUID, sizeof (AMPERE_GUID)) == 0) {
+    if (BertStatus->BertRev == CURRENT_BERT_VERSION) {
+      return TRUE;
+    }
+  }
+
+  return FALSE;
+}
+
+/*
+  Create a default BertErrorStatus In SPINOR
+ */
+VOID
+CreateDefaultBertStatus (
+  VOID
+  )
+{
+  UINTN Length = sizeof (BERT_ERROR_STATUS);
+  BERT_ERROR_STATUS BertStatus = { 0 };
+
+  CopyMem (BertStatus.Guid, AMPERE_GUID, sizeof (AMPERE_GUID));
+  BertStatus.BertRev = CURRENT_BERT_VERSION;
+  BertStatus.DefaultBert = 1;
+  BertStatus.Overflow = 0;
+  BertStatus.PendingUefi = 0;
+  BertStatus.PendingBmc = 0;
+
+  FlashEraseCommand (BERT_SPI_ADDRESS_STATUS, Length);
+  FlashWriteCommand (
+    BERT_SPI_ADDRESS_STATUS,
+    &BertStatus,
+    Length
+    );
+}
+
+/*
+  Update BertErrorStatus In SPINOR
+ */
+VOID
+UpdateBertStatus (
+  BERT_ERROR_STATUS *BertStatus
+  )
+{
+  UINTN Length = sizeof (BERT_ERROR_STATUS);
+
+  BertStatus->DefaultBert = 1;
+  BertStatus->PendingUefi = 0;
+  if (BertStatus->PendingBmc == 0) {
+    BertStatus->Overflow = 0;
+  }
+
+  FlashEraseCommand (BERT_SPI_ADDRESS_STATUS, Length);
+  FlashWriteCommand (
+    BERT_SPI_ADDRESS_STATUS,
+    BertStatus,
+    Length
+    );
+}
+
 STATIC VOID
 AcpiApeiUninstallTable (
   UINT32 Signature
@@ -118,17 +182,16 @@ AdjustBERTRegionLen (
  * Retrieve Bert data from SPI NOR
  */
 VOID
+EFIAPI
 PullBertSpinorData (
-  APEI_CRASH_DUMP_DATA *BertErrorData
+  UINT8 *BertData,
+  UINT64 BertSpiAddress,
+  UINTN Length
   )
 {
-  UINTN Length;
-
-  Length = sizeof (*BertErrorData);
-
   FlashReadCommand (
-    BERT_FLASH_OFFSET,
-    BertErrorData,
+    BertSpiAddress,
+    BertData,
     Length
     );
 }
@@ -198,81 +261,18 @@ WrapBertErrorData (
  */
 VOID
 CreateDefaultBertData (
-  APEI_BERT_ERROR_DATA *Data
+  APEI_CRASH_DUMP_DATA *Data
   )
 {
-  Data->Type = RAS_TYPE_BERT_PAYLOAD3;
+  Data->Vendor.Type = RAS_TYPE_BERT_PAYLOAD3;
+  Data->BertRev = CURRENT_BERT_VERSION;
   AsciiStrCpyS (
-    Data->Msg,
+    Data->Vendor.Msg,
     BERT_MSG_SIZE,
     DEFAULT_BERT_REBOOT_MSG
     );
 }
 
-/*
- * Ensures BertErrorData In SPINOR matches
- * the record produced by CreateDefaultBertData.
- * @param  Bed    Crash dump Data
- */
-VOID
-WriteSpinorDefaultBertTable (
-  APEI_CRASH_DUMP_DATA *Bed
-  )
-{
-  UINT8                BertRev;
-  UINTN                Length;
-  UINT64               Offset;
-  UINT32               MsgDiff;
-  APEI_BERT_ERROR_DATA DefaultData = {0};
-
-  CreateDefaultBertData (&DefaultData);
-  if ((Bed->Vendor.Type != DefaultData.Type)) {
-    Offset = BERT_FLASH_OFFSET +
-             OFFSET_OF (APEI_CRASH_DUMP_DATA, Vendor) +
-             OFFSET_OF (APEI_BERT_ERROR_DATA, Type);
-    Length = sizeof (DefaultData.Type);
-    FlashEraseCommand (Offset, Length);
-    FlashWriteCommand (Offset, &(DefaultData.Type), Length);
-  }
-
-  if ((Bed->Vendor.SubType != DefaultData.SubType)) {
-    Offset = BERT_FLASH_OFFSET +
-             OFFSET_OF (APEI_CRASH_DUMP_DATA, Vendor) +
-             OFFSET_OF (APEI_BERT_ERROR_DATA, SubType);
-    Length = sizeof (DefaultData.SubType);
-    FlashEraseCommand (Offset, Length);
-    FlashWriteCommand (Offset, &(DefaultData.SubType), Length);
-  }
-
-  if ((Bed->Vendor.Instance != DefaultData.Instance)) {
-    Offset = BERT_FLASH_OFFSET +
-             OFFSET_OF (APEI_CRASH_DUMP_DATA, Vendor) +
-             OFFSET_OF (APEI_BERT_ERROR_DATA, Instance);
-    Length = sizeof (DefaultData.Instance);
-    FlashEraseCommand (Offset, Length);
-    FlashWriteCommand (Offset, &(DefaultData.Instance), Length);
-  }
-
-  MsgDiff = AsciiStrnCmp (Bed->Vendor.Msg, DefaultData.Msg, BERT_MSG_SIZE);
-  if (MsgDiff != 0) {
-    Offset = BERT_FLASH_OFFSET +
-             OFFSET_OF (APEI_CRASH_DUMP_DATA, Vendor) +
-             OFFSET_OF (APEI_BERT_ERROR_DATA, Msg);
-    Length = sizeof (DefaultData.Msg);
-    FlashEraseCommand (Offset, Length);
-    FlashWriteCommand (Offset, &(DefaultData.Msg), Length);
-  }
-
-  if (Bed->BertRev != CURRENT_BERT_VERSION) {
-    Offset = BERT_FLASH_OFFSET + OFFSET_OF (APEI_CRASH_DUMP_DATA, BertRev);
-    Length = sizeof (Bed->BertRev);
-    BertRev = CURRENT_BERT_VERSION;
-    FlashEraseCommand (Offset, Length);
-    FlashWriteCommand (Offset, &BertRev, Length);
-  }
-
-}
-
 /*
  * Checks Status of NV_SI_RAS_BERT_ENABLED
  * Returns TRUE if enabled and FALSE if disabled
@@ -308,10 +308,6 @@ WriteDDRBertTable (
 {
   VOID *Blk = (VOID *)BERT_DDR_OFFSET;
 
-  /*
-   * writing sizeof data to ddr produces alignment error
-   * this is a temporary workaround
-   */
   CopyMem (Blk, Data, BERT_DDR_LENGTH);
 }
 
@@ -324,24 +320,41 @@ AcpiPopulateBert (
   )
 {
   APEI_CRASH_DUMP_BERT_ERROR *DDRError;
+  BERT_ERROR_STATUS          BertStatus;
 
-  DDRError =
-    (APEI_CRASH_DUMP_BERT_ERROR *)
-    AllocateZeroPool (sizeof (APEI_CRASH_DUMP_BERT_ERROR));
+  DDRError = (APEI_CRASH_DUMP_BERT_ERROR *)AllocateZeroPool (BERT_DDR_LENGTH);
 
   if (DDRError == NULL) {
     return EFI_OUT_OF_RESOURCES;
   }
 
   if (IsBertEnabled ()) {
-    PullBertSpinorData (&(DDRError->Bed));
-    if ((DDRError->Bed.BertRev == CURRENT_BERT_VERSION)) {
-      WrapBertErrorData (DDRError);
-      WriteDDRBertTable (DDRError);
+    PullBertSpinorData ((UINT8 *)&BertStatus, BERT_SPI_ADDRESS_STATUS, sizeof (BERT_ERROR_STATUS));
+    if (IsBertStatusValid (&BertStatus)) {
+      if (BertStatus.PendingUefi == 1) {
+        PullBertSpinorData ((UINT8 *)&(DDRError->Bed), BERT_FLASH_OFFSET, sizeof (APEI_CRASH_DUMP_DATA));
+        if (DDRError->Bed.BertRev == BertStatus.BertRev) {
+          WrapBertErrorData (DDRError);
+          WriteDDRBertTable (DDRError);
+        } else {
+          // If we are here something is out of sync. Reinit BERT section
+          FlashEraseCommand (BERT_FLASH_OFFSET, 0x1000);
+          CreateDefaultBertStatus ();
+          goto AcpiPopulateBertEnd;
+        }
+      } else if (BertStatus.DefaultBert == 1) {
+        CreateDefaultBertData (&(DDRError->Bed));
+        WrapBertErrorData (DDRError);
+        WriteDDRBertTable (DDRError);
+      }
+      UpdateBertStatus (&BertStatus);
+    } else {
+      FlashEraseCommand (BERT_FLASH_OFFSET, 0x1000);
+      CreateDefaultBertStatus ();
     }
-    WriteSpinorDefaultBertTable (&(DDRError->Bed));
   }
 
+AcpiPopulateBertEnd:
   FreePool (DDRError);
   return EFI_SUCCESS;
 }

Platform/Ampere/JadePkg/Drivers/AcpiPlatformDxe/AcpiApei.h

@@ -1,6 +1,6 @@
 /** @file
 
-  Copyright (c) 2020 - 2021, Ampere Computing LLC. All rights reserved.<BR>
+  Copyright (c) 2020 - 2024, Ampere Computing LLC. All rights reserved.<BR>
 
   SPDX-License-Identifier: BSD-2-Clause-Patent
 
@@ -46,7 +46,7 @@
 #define RASIP_CRASH_SIZE             0x1000
 #define HEST_NUM_ENTRIES_PER_SOC     3
 
-#define CURRENT_BERT_VERSION         0x11
+#define CURRENT_BERT_VERSION         0x12
 #define BERT_FLASH_OFFSET            0x91B30000ULL
 #define BERT_DDR_OFFSET              0x88230000ULL
 #define BERT_DDR_LENGTH              0x50000
@@ -75,12 +75,67 @@ typedef struct {
   EFI_ACPI_6_3_GENERIC_ERROR_DATA_ENTRY_STRUCTURE Ged;
   APEI_CRASH_DUMP_DATA                            Bed;
 } APEI_CRASH_DUMP_BERT_ERROR;
+
+/*
+ * The BERT regions is 0x50000 in size. The SPI-NOR sector size is 0x1000 (4KB).
+ * So there is 80 sectors available for BERT errors.
+ *
+ * BERT error record must be persistent across boots on catastrophic errors
+ * until the BMC and UEFI have had a chance to retrieve the information. To
+ * support this, the BERT is sectioned off into two different sections.
+ *
+ *  -----------------------------------
+ *  | BERT Error Record               | sectors 0-61 (4KB * 62 = 248KB)
+ *  |                                 |
+ *  -----------------------------------
+ *  | Unused/Reserved                 | sectors 62-78 (4KB * 17 = 68KB)
+ *  |                                 |
+ *  -----------------------------------
+ *  | BERT Error Record Status        | sector 79 (4KB x 1 = 4KB)
+ *  |                                 | offset 79 * 0x1000 = 0x4F000
+ *  -----------------------------------
+ *
+ *   BERT Error Record:
+ *     - Catastrophic Full BERT Error Record (persistent until read by BMC and UEFI)
+ *   BERT Error Record Status:
+ *     - DefaultBert: Indicate Default Bert Present
+ *       - Set by UEFI on boot and cleared by SCP on shutdown, reboot, or crash
+ *       - 0 = Default BERT not valid
+ *       - 1 = Default BERT valid
+ *     - Overflow: Indicate Full Crash Capture overflow before
+ *       - Set by SCP if PendingUefi or PendingBMC was set and to be cleared by UEFI
+ *         if PendingUefi and PendingBMC are cleared.
+ *       - 0 = No overflow
+ *       - 1 = Record has overflowed
+ *     - PendingUefi: Indicate Pending UEFI detection
+ *       - Set by SCP and to be cleared by UEFI
+ *       - 0 = Pending UEFI detection not valid
+ *       - 1 = Pending UEFI detection valid
+ *     - PendingBmc:  Indicate Pending BMC detection
+ *       - Set by SCP and to be cleared by BMC
+ *       - 0 = Pending BMC detection not valid
+ *       - 1 = Pending BMC detection valid
+ */
+
+typedef struct {
+  UINT8  Guid[16];             /* [0x00] set to AMPERE_GUID */
+  UINT8  BertRev;              /* [0x10] set to BERT revision */
+  UINT8  Reserved0[7];         /* [----] Reserved */
+  UINT8  DefaultBert;          /* [0x18] Indicate Default Bert Present */
+  UINT8  Overflow;             /* [----] Indicate Full Crash Capture overflow detected */
+  UINT8  PendingUefi;          /* [----] Indicate Pending UEFI detection */
+  UINT8  PendingBmc;           /* [----] Indicate Pending BMC detection */
+  UINT8  Reserved1[4];         /* [----] Reserved */
+} BERT_ERROR_STATUS;
+
+#define BERT_SPI_ADDRESS_STATUS      (BERT_FLASH_OFFSET + 0x4F000)
+
 #pragma pack()
 
 VOID
 EFIAPI
 CreateDefaultBertData (
-  APEI_BERT_ERROR_DATA *Data
+  APEI_CRASH_DUMP_DATA *Data
   );
 
 VOID
@@ -92,7 +147,9 @@ WrapBertErrorData (
 VOID
 EFIAPI
 PullBertSpinorData (
-  APEI_CRASH_DUMP_DATA *BertErrorData
+  UINT8 *BertData,
+  UINT64 BertSpiAddress,
+  UINTN Length
   );
 
 VOID