Add new MTRR Test Point test (#314)

## Description

Add a new MTRR Test Point test that runs at Ready to Boot. This test
checks the systems MTRRs at Ready to Boot versus the expected MTRR
settings the platform publishes. Additional refactoring was done so that
in the future MTRRs can be tested at other stages of boot if desired.

- [ ] Impacts functionality?
- [ ] Impacts security?
- [ ] Breaking change?
- [x] Includes tests?
- [ ] Includes documentation?
- [x] Backport to release branch?

## How This Was Tested

Tested on Intel physical platforms. MTRRs were correctly read and
validated at Ready to Boot.

## Integration Instructions

Enable bit 6 in byte 4 of the
`gMinPlatformPkgTokenSpaceGuid.PcdTestPointIbvPlatformFeature` PCD to
actually run the test. Additionally, a platform will need to create
their version of the function `GetPlatformMtrrCacheData`. This returns
the expected MTRR cache settings will be at ready to boot which will be
used for verification.

Author: kenlautner

MinPlatformPkg/Include/Library/TestPointCheckLib.h

@@ -522,6 +522,25 @@ TestPointReadyToBootTcgMorEnabled (
   VOID
   );
 
+/**
+  This service verifies MTRR settings at Ready to Boot
+
+  Test subject: MTRRs at Ready to Boot
+  Test overview: Verifies MTRR settings.
+  Reporting mechanism: Set ADAPTER_INFO_PLATFORM_TEST_POINT_STRUCT.
+                       Dumps results to the debug log.
+
+  Examples of settings verified: No MTRR overlap, DXE data memory is writeback, flash region may be UC, MMIO is UC, etc.
+
+  @retval EFI_SUCCESS         The test point check was performed successfully.
+  @retval EFI_UNSUPPORTED     The test point check is not supported on this platform.
+**/
+EFI_STATUS
+EFIAPI
+TestPointReadyToBootMtrrFunctional (
+  VOID
+  );
+
 /**
   This service verifies SMI handler profiling.
 
@@ -771,6 +790,7 @@ TestPointPciEnumerationDonePcieGenSpeed (
 #define TEST_POINT_BYTE4_READY_TO_BOOT_UEFI_CONSOLE_VARIABLE_FUNCTIONAL                     BIT3
 #define TEST_POINT_BYTE4_READY_TO_BOOT_ACPI_TABLE_FUNCTIONAL                                BIT4
 #define TEST_POINT_BYTE4_READY_TO_BOOT_GCD_RESOURCE_FUNCTIONAL                              BIT5
+#define TEST_POINT_BYTE4_READY_TO_BOOT_MTRR_CACHE_VALID                                     BIT6
 #define   TEST_POINT_BYTE4_READY_TO_BOOT_MEMORY_TYPE_INFORMATION_FUNCTIONAL_ERROR_CODE           L"0x04000000"
 #define   TEST_POINT_BYTE4_READY_TO_BOOT_MEMORY_TYPE_INFORMATION_FUNCTIONAL_ERROR_STRING         L"Invalid Memory Type Information\r\n"
 #define   TEST_POINT_BYTE4_READY_TO_BOOT_UEFI_MEMORY_ATTRIBUTE_TABLE_FUNCTIONAL_ERROR_CODE       L"0x04010000"
@@ -783,6 +803,8 @@ TestPointPciEnumerationDonePcieGenSpeed (
 #define   TEST_POINT_BYTE4_READY_TO_BOOT_ACPI_TABLE_FUNCTIONAL_ERROR_STRING                      L"Invalid ACPI Table\r\n"
 #define   TEST_POINT_BYTE4_READY_TO_BOOT_GCD_RESOURCE_FUNCTIONAL_ERROR_CODE                      L"0x04050000"
 #define   TEST_POINT_BYTE4_READY_TO_BOOT_GCD_RESOURCE_FUNCTIONAL_ERROR_STRING                    L"Invalid GCD Resource\r\n"
+#define   TEST_POINT_BYTE4_READY_TO_BOOT_MTRR_CACHE_VALID_ERROR_CODE                             L"0x04060000"
+#define   TEST_POINT_BYTE4_READY_TO_BOOT_MTRR_CACHE_VALID_ERROR_STRING                           L"Invalid MTRR cache type\r\n"
 
 #define TEST_POINT_BYTE5_READY_TO_BOOT_UEFI_SECURE_BOOT_ENABLED                             BIT0
 #define TEST_POINT_BYTE5_READY_TO_BOOT_PI_SIGNED_FV_BOOT_ENABLED                            BIT1

MinPlatformPkg/Include/Library/TestPointMtrrInfoLib.h

@@ -0,0 +1,51 @@
+/** @file
+TestPointMtrrInfoLib.h
+
+An interface for platforms to define the expected MTRR cache types for specific
+regions.  Create an array of VARIABLE_MTRR_INFO structures for every MTRR range
+that you want to validate.  If any of the checked regions don't have the matching
+caching type the test will report an error for the failing range and return.
+
+Copyright (c) Microsoft Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent
+
+**/
+
+#ifndef TEST_POINT_MTRR_INFO_LIB_H_
+#define TEST_POINT_MTRR_INFO_LIB_H_
+
+#include <Uefi.h>
+
+typedef struct {
+  UINT64     BaseAddress;
+  UINT64     Type;
+} VARIABLE_MTRR_INFO;
+
+typedef enum {
+  EndOfDxe,
+  ReadyToLock,
+  ReadyToBoot,
+  ExitBootServices,
+  MaxBootPoint
+} BOOT_POINT;
+
+/**
+  Assigns the input parameter pointer to a static array of VARIABLE_MTRR_INFO structures and returns
+  the length of the array.
+
+  @param[out]       CheckedMtrrs  Pointer to the head of an array of VARIABLE_MTRR_INFO structures.
+                                  The caller shall not free this array.
+  @param[in]        Boot          Enum value that represents the stage of boot which we want the comparisons
+                                  to be made.
+
+  @retval           UINTN         Length of the returned array.
+
+**/
+UINTN
+EFIAPI
+GetPlatformMtrrCacheData (
+  OUT VARIABLE_MTRR_INFO **CheckedMtrrs,
+  IN  BOOT_POINT         Boot
+  );
+
+#endif

MinPlatformPkg/Library/TestPointMtrrInfoLibNull/TestPointMtrrInfoLibNull.c

@@ -0,0 +1,39 @@
+/** @file
+TestPointMtrrInfoLibNull.c
+
+An interface for platforms to define the expected MTRR cache types for specific
+regions.  Create an array of VARIABLE_MTRR_INFO structures for every MTRR range
+that you want to validate.  If any of the checked regions don't have the matching
+caching type the test will report an error for the failing range and return.
+
+Copyright (c) Microsoft Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent
+
+**/
+
+#include <Uefi.h>
+
+#include <Library/TestPointMtrrInfoLib.h>
+
+/**
+  Assigns the input parameter pointer to a static array of VARIABLE_MTRR_INFO structures and returns
+  the length of the array.
+
+  @param[out]       CheckedMtrrs  Pointer to the head of an array of VARIABLE_MTRR_INFO structures.
+                                  The caller shall not free this array.
+  @param[in]        Boot          Enum value that represents the stage of boot which we want the comparisons
+                                  to be made.
+
+  @retval           UINTN         Length of the returned array.
+
+**/
+UINTN
+EFIAPI
+GetPlatformMtrrCacheData (
+  OUT VARIABLE_MTRR_INFO **CheckedMtrrs,
+  IN  BOOT_POINT         Boot
+
+  )
+{
+  return 0;
+}

MinPlatformPkg/Library/TestPointMtrrInfoLibNull/TestPointMtrrInfoLibNull.inf

@@ -0,0 +1,25 @@
+## @file
+# TestPointMtrrInfoLibNull.inf
+#
+# Null implementation of the TestPointMtrrInfoLib class that doesn't return any MTRRs that we want to check.
+# This is for compatibility purposes.
+#
+##
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# SPDX-License-Identifier: BSD-2-Clause-Patent
+##
+
+[Defines]
+  INF_VERSION         = 0x00010006
+  BASE_NAME           = TestPointMtrrInfoLibNull
+  FILE_GUID           = b015a43a-7ca3-4c68-80dd-5a9840bbf2bb
+  VERSION_STRING      = 1.0
+  MODULE_TYPE         = BASE
+  LIBRARY_CLASS       = TestPointMtrrInfoLib
+
+[Sources]
+  TestPointMtrrInfoLibNull.c
+
+[Packages]
+  MdePkg/MdePkg.dec
+  MinPlatformPkg/MinPlatformPkg.dec

MinPlatformPkg/MinPlatformPkg.dec

@@ -91,6 +91,7 @@
   LargeVariableReadLib|Include/Library/LargeVariableReadLib.h
   LargeVariableWriteLib|Include/Library/LargeVariableWriteLib.h
   TestPointPciSpeedInfoLib|Include/Library/TestPointPciSpeedInfoLib.h
+  TestPointMtrrInfoLib|Include/Library/TestPointMtrrInfoLib.h
 
   PhatAcpiLib|Include/Library/PhatAcpiLib.h
 

MinPlatformPkg/MinPlatformPkg.dsc

@@ -88,6 +88,7 @@
   NULL|MdePkg/Library/StackCheckLibNull/StackCheckLibNull.inf # MU_CHANGE: /GS and -fstack-protector support
   TestPointCheckLib|MinPlatformPkg/Test/Library/TestPointCheckLibNull/TestPointCheckLibNull.inf
   TestPointPciSpeedInfoLib|MinPlatformPkg/Library/TestPointPciSpeedInfoLibNull/TestPointPciSpeedInfoLibNull.inf
+  TestPointMtrrInfoLib|MinPlatformPkg/Library/TestPointMtrrInfoLibNull/TestPointMtrrInfoLibNull.inf
 
 [LibraryClasses.common.SEC]
   TestPointCheckLib|MinPlatformPkg/Test/Library/TestPointCheckLib/SecTestPointCheckLib.inf
@@ -225,6 +226,7 @@
   MinPlatformPkg/Test/TestPointStubDxe/TestPointStubDxeMm.inf
   MinPlatformPkg/Test/TestPointDumpApp/TestPointDumpApp.inf
   MinPlatformPkg/Library/TestPointPciSpeedInfoLibNull/TestPointPciSpeedInfoLibNull.inf
+  MinPlatformPkg/Library/TestPointMtrrInfoLibNull/TestPointMtrrInfoLibNull.inf
 
   MinPlatformPkg/Library/BaseVariableReadLibNull/BaseVariableReadLibNull.inf
   MinPlatformPkg/Library/SmmVariableReadLib/StandaloneMmVariableReadLib.inf

MinPlatformPkg/PlatformInit/PlatformInitDxe/PlatformInitDxe.c

@@ -147,6 +147,7 @@ OnReadyToBootLater (
   TestPointReadyToBootHstiTableFunctional ();
   TestPointReadyToBootAcpiTableFunctional ();
   TestPointReadyToBootGcdResourceFunctional ();
+  TestPointReadyToBootMtrrFunctional (); // MU_CHANGE
 
   TestPointDxeSmmReadyToBootSmiHandlerInstrument ();
   TestPointDxeSmmReadyToBootSmmPageProtection ();
@@ -155,6 +156,7 @@ OnReadyToBootLater (
   TestPointReadyToBootPiSignedFvBootEnabled ();
   TestPointReadyToBootTcgTrustedBootEnabled ();
   TestPointReadyToBootTcgMorEnabled ();
+
   TestPointReadyToBootEsrtTableFunctional ();
 }
 

MinPlatformPkg/Test/Library/TestPointCheckLib/DxeCheckMtrr.c

@@ -0,0 +1,145 @@
+/** @file
+
+Copyright (c) Microsoft Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent
+
+**/
+
+#include <Uefi.h>
+#include <Library/TestPointCheckLib.h>
+#include <Library/TestPointLib.h>
+#include <Library/DebugLib.h>
+#include <Library/HobLib.h>
+#include <Library/BaseMemoryLib.h>
+#include <Library/MtrrLib.h>
+#include <Library/TestPointMtrrInfoLib.h>
+#include "TestPointCheckMtrr.h"
+
+EFI_STATUS
+TestPointCheckMtrrForDxe (
+  IN MTRR_SETTINGS  *Mtrrs,
+  IN VARIABLE_MTRR  *VariableMtrr
+  )
+{
+  UINTN               VariableMtrrIndex;
+  UINTN               VariableMtrrCount;
+  VARIABLE_MTRR_INFO  *ExpectedMtrrs;
+  UINTN               ExpectedMtrrsIndex;
+  UINTN               ExpectedMtrrsCount;
+  BOOLEAN             Found;
+
+  ExpectedMtrrsCount = GetPlatformMtrrCacheData (&ExpectedMtrrs, ReadyToBoot);
+  VariableMtrrCount  = GetVariableMtrrCount ();
+
+  if ((ExpectedMtrrs == NULL) || (ExpectedMtrrsCount == 0)) {
+    return EFI_NOT_FOUND;
+  }
+
+  //
+  // Check if the MTRR types match
+  //
+  for (VariableMtrrIndex = 0; VariableMtrrIndex < VariableMtrrCount; VariableMtrrIndex++) {
+    Found = FALSE;
+    if (!VariableMtrr[VariableMtrrIndex].Valid) {
+      continue;
+    }
+
+    for (ExpectedMtrrsIndex = 0; ExpectedMtrrsIndex < ExpectedMtrrsCount; ExpectedMtrrsIndex++) {
+      if (ExpectedMtrrs[ExpectedMtrrsIndex].BaseAddress == VariableMtrr[VariableMtrrIndex].BaseAddress) {
+        if (ExpectedMtrrs[ExpectedMtrrsIndex].Type != VariableMtrr[VariableMtrrIndex].Type) {
+          DEBUG ((
+            DEBUG_ERROR,
+            "The Mtrr with BaseAddress: 0x%016lx has the incorrect cache type: %d!  Expected: %d\n",
+            VariableMtrr[VariableMtrrIndex].BaseAddress,
+            VariableMtrr[VariableMtrrIndex].Type,
+            ExpectedMtrrs[ExpectedMtrrsIndex].Type
+            ));
+          return EFI_SECURITY_VIOLATION;
+        }
+
+        Found = TRUE;
+        DEBUG ((DEBUG_INFO, "Found MTRR at address %016lx and it has the expected caching type\n", VariableMtrr[VariableMtrrIndex].BaseAddress));
+        break;
+      }
+    }
+
+    if (!Found) {
+      DEBUG ((
+        DEBUG_INFO,
+        "The Mtrr with BaseAddress: 0x%016lx did not have a policy to check against.\n",
+        VariableMtrr[VariableMtrrIndex].BaseAddress
+        ));
+    }
+  }
+
+  return EFI_SUCCESS;
+}
+
+EFI_STATUS
+TestPointCheckMtrr (
+  VOID
+  )
+{
+  EFI_STATUS     Status;
+  MTRR_SETTINGS  LocalMtrrs;
+  MTRR_SETTINGS  *Mtrrs;
+  UINTN          Index;
+  UINTN          VariableMtrrCount;
+  BOOLEAN        Result;
+  VARIABLE_MTRR  VariableMtrr[MTRR_NUMBER_OF_VARIABLE_MTRR];
+
+  DEBUG ((DEBUG_INFO, "==== TestPointCheckMtrr - Enter\n"));
+
+  MtrrGetAllMtrrs (&LocalMtrrs);
+  Mtrrs = &LocalMtrrs;
+  DEBUG ((DEBUG_INFO, "MTRR Default Type: %016lx\n", Mtrrs->MtrrDefType));
+  for (Index = 0; Index < MTRR_NUMBER_OF_FIXED_MTRR; Index++) {
+    DEBUG ((DEBUG_INFO, "Fixed MTRR[%02d]   : %016lx\n", Index, Mtrrs->Fixed.Mtrr[Index]));
+  }
+
+  VariableMtrrCount = GetVariableMtrrCount ();
+  for (Index = 0; Index < VariableMtrrCount; Index++) {
+    DEBUG ((
+      DEBUG_INFO,
+      "Variable MTRR[%02d]: Base=%016lx Mask=%016lx\n",
+      Index,
+      Mtrrs->Variables.Mtrr[Index].Base,
+      Mtrrs->Variables.Mtrr[Index].Mask
+      ));
+  }
+
+  DEBUG ((DEBUG_INFO, "\n"));
+  DEBUG ((DEBUG_INFO, "==== TestPointCheckMtrr - Exit\n"));
+
+  //
+  // Check Mask
+  //
+  Status = TestPointCheckMtrrMask (Mtrrs);
+  if (EFI_ERROR (Status)) {
+    Result = FALSE;
+  } else {
+    ZeroMem (VariableMtrr, sizeof (VariableMtrr));
+    TestPointMtrrConvert (Mtrrs, VariableMtrr);
+
+    Status = TestPointCheckMtrrForDxe (Mtrrs, VariableMtrr);
+
+    if (EFI_ERROR (Status)) {
+      Result = FALSE;
+    } else {
+      Result = TRUE;
+    }
+  }
+
+  // Print error string if we failed
+  if (!Result) {
+    TestPointLibAppendErrorString (
+      PLATFORM_TEST_POINT_ROLE_PLATFORM_IBV,
+      TEST_POINT_IMPLEMENTATION_ID_PLATFORM_PEI,
+      TEST_POINT_BYTE4_READY_TO_BOOT_MTRR_CACHE_VALID_ERROR_CODE \
+      TEST_POINT_READY_TO_BOOT \
+      TEST_POINT_BYTE4_READY_TO_BOOT_MTRR_CACHE_VALID_ERROR_STRING
+      );
+  }
+
+  return Status;
+}