SecurityPkg: Tcg2Config: TPM2 ACPI Table Rev Option

Add TPM2 ACPI Table Rev Option in Tcg2Config UI. Rev 4 is defined in
TCG ACPI Specification 00.37

Cc: Star Zeng <star.zeng@intel.com>
Cc: Yao Jiewen <jiewen.yao@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Chao Zhang <chao.b.zhang@intel.com>
Reviewed-by: Star Zeng <star.zeng@intel.com>
Reviewed-by: Yao Jiewen <jiewen.yao@intel.com>

7 files changed, 88 insertions, 2 deletions

diff --git a/SecurityPkg/Tcg/Tcg2Config/Tcg2Config.vfr b/SecurityPkg/Tcg/Tcg2Config/Tcg2Config.vfr
index a1167137f2..1d44c99109 100644
--- a/SecurityPkg/Tcg/Tcg2Config/Tcg2Config.vfr
+++ b/SecurityPkg/Tcg/Tcg2Config/Tcg2Config.vfr
@@ -67,6 +67,22 @@ formset
         text   = STRING_TOKEN(STR_TPM2_ACPI_HID_CONTENT);

 

     text

+      help   = STRING_TOKEN(STR_TPM2_ACPI_REVISION_STATE_HELP),

+      text   = STRING_TOKEN(STR_TPM2_ACPI_REVISION_STATE_PROMPT),

+        text   = STRING_TOKEN(STR_TPM2_ACPI_REVISION_STATE_CONTENT);

+

+    oneof varid  = TCG2_VERSION.Tpm2AcpiTableRev,

+          questionid = KEY_TPM2_ACPI_REVISION,

+          prompt = STRING_TOKEN(STR_TPM2_ACPI_REVISION_PROMPT),

+          help   = STRING_TOKEN(STR_TPM2_ACPI_REVISION_HELP),

+          flags  = INTERACTIVE,

+            option text = STRING_TOKEN(STR_TPM2_ACPI_REVISION_3),     value = TPM2_ACPI_REVISION_3,     flags = RESET_REQUIRED;

+            option text = STRING_TOKEN(STR_TPM2_ACPI_REVISION_4),     value = TPM2_ACPI_REVISION_4,     flags = DEFAULT | MANUFACTURING | RESET_REQUIRED;

+    endoneof;

+

+    subtitle text = STRING_TOKEN(STR_NULL);

+

+    text

       help   = STRING_TOKEN(STR_TCG2_DEVICE_INTERFACE_STATE_HELP),

       text   = STRING_TOKEN(STR_TCG2_DEVICE_INTERFACE_STATE_PROMPT),

         text   = STRING_TOKEN(STR_TCG2_DEVICE_INTERFACE_STATE_CONTENT);

diff --git a/SecurityPkg/Tcg/Tcg2Config/Tcg2ConfigDriver.c b/SecurityPkg/Tcg/Tcg2Config/Tcg2ConfigDriver.c
index 050e43a337..9c590dcb74 100644
--- a/SecurityPkg/Tcg/Tcg2Config/Tcg2ConfigDriver.c
+++ b/SecurityPkg/Tcg/Tcg2Config/Tcg2ConfigDriver.c
@@ -82,6 +82,7 @@ InitializeTcg2VersionInfo (
   TCG2_VERSION                  Tcg2Version;

   UINTN                         DataSize;

   UINT64                        PcdTcg2PpiVersion;

+  UINT8                         PcdTpm2AcpiTableRev;

 

   //

   // Get the PCD value before initializing efi varstore configuration data.

@@ -93,6 +94,8 @@ InitializeTcg2VersionInfo (
     AsciiStrSize ((CHAR8 *) PcdGetPtr (PcdTcgPhysicalPresenceInterfaceVer))

     );

 

+  PcdTpm2AcpiTableRev = PcdGet8 (PcdTpm2AcpiTableRev);

+

   //

   // Initialize efi varstore configuration data.

   //

@@ -175,6 +178,10 @@ InitializeTcg2VersionInfo (
         DEBUG ((DEBUG_WARN, "WARNING: PcdTcgPhysicalPresenceInterfaceVer default value is not same with the default value in VFR\n"));

         DEBUG ((DEBUG_WARN, "WARNING: The default value in VFR has be chosen\n"));

       }

+      if (PcdTpm2AcpiTableRev != Tcg2Version.Tpm2AcpiTableRev) {

+        DEBUG ((DEBUG_WARN, "WARNING: PcdTpm2AcpiTableRev default value is not same with the default value in VFR\n"));

+        DEBUG ((DEBUG_WARN, "WARNING: The default value in VFR has be chosen\n"));

+      }

     }

   }

   FreePool (ConfigRequestHdr);

@@ -206,6 +213,29 @@ InitializeTcg2VersionInfo (
       ASSERT (FALSE);

       break;

   }

+

+  //

+  // Get the PcdTpm2AcpiTableRev value again.

+  // If the PCD value is not equal to the value in variable,

+  // the PCD is not DynamicHii type and does not map to TCG2_VERSION Variable.

+  //

+  PcdTpm2AcpiTableRev = PcdGet8 (PcdTpm2AcpiTableRev);

+  if (PcdTpm2AcpiTableRev != Tcg2Version.Tpm2AcpiTableRev) {

+    DEBUG ((DEBUG_WARN, "WARNING: PcdTpm2AcpiTableRev is not DynamicHii type and does not map to TCG2_VERSION.Tpm2AcpiTableRev\n"));

+    DEBUG ((DEBUG_WARN, "WARNING: The Tpm2 ACPI Revision configuring from setup page will not work\n"));

+  }

+

+  switch (PcdTpm2AcpiTableRev) {

+    case EFI_TPM2_ACPI_TABLE_REVISION_3:

+      HiiSetString (PrivateData->HiiHandle, STRING_TOKEN (STR_TPM2_ACPI_REVISION_STATE_CONTENT), L"Rev 3", NULL);

+      break;

+    case EFI_TPM2_ACPI_TABLE_REVISION_4:

+      HiiSetString (PrivateData->HiiHandle, STRING_TOKEN (STR_TPM2_ACPI_REVISION_STATE_CONTENT), L"Rev 4", NULL);

+      break;

+    default:

+      ASSERT (FALSE);

+      break;

+  }

 }

 

 /**

diff --git a/SecurityPkg/Tcg/Tcg2Config/Tcg2ConfigDxe.inf b/SecurityPkg/Tcg/Tcg2Config/Tcg2ConfigDxe.inf
index 9f21aabf44..38fa331701 100644
--- a/SecurityPkg/Tcg/Tcg2Config/Tcg2ConfigDxe.inf
+++ b/SecurityPkg/Tcg/Tcg2Config/Tcg2ConfigDxe.inf
@@ -78,6 +78,7 @@
   gEfiSecurityPkgTokenSpaceGuid.PcdTcg2HashAlgorithmBitmap    ## CONSUMES

   gEfiSecurityPkgTokenSpaceGuid.PcdTpmBaseAddress             ## CONSUMES

   gEfiSecurityPkgTokenSpaceGuid.PcdTcgPhysicalPresenceInterfaceVer  ## CONSUMES

+  gEfiSecurityPkgTokenSpaceGuid.PcdTpm2AcpiTableRev           ## CONSUMES

 

 [Depex]

   gEfiTcg2ProtocolGuid              AND

diff --git a/SecurityPkg/Tcg/Tcg2Config/Tcg2ConfigImpl.c b/SecurityPkg/Tcg/Tcg2Config/Tcg2ConfigImpl.c
index f4a07c6420..a83000fda1 100644
--- a/SecurityPkg/Tcg/Tcg2Config/Tcg2ConfigImpl.c
+++ b/SecurityPkg/Tcg/Tcg2Config/Tcg2ConfigImpl.c
@@ -481,6 +481,7 @@ Tcg2VersionInfoCallback (
 {

   EFI_INPUT_KEY                 Key;

   UINT64                        PcdTcg2PpiVersion;

+  UINT8                         PcdTpm2AcpiTableRev;

 

   ASSERT (Action == EFI_BROWSER_ACTION_SUBMITTED);

 

@@ -506,6 +507,24 @@ Tcg2VersionInfoCallback (
         NULL

         );

     }

+  } else if (QuestionId == KEY_TPM2_ACPI_REVISION){

+    //

+    // Get the PCD value after EFI_BROWSER_ACTION_SUBMITTED,

+    // the SetVariable to TCG2_VERSION_NAME should have been done.

+    // If the PCD value is not equal to the value set to variable,

+    // the PCD is not DynamicHii type and does not map to the setup option.

+    //

+    PcdTpm2AcpiTableRev = PcdGet8 (PcdTpm2AcpiTableRev);

+

+    if (PcdTpm2AcpiTableRev != Value->u8) {

+      CreatePopUp (

+        EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE,

+        &Key,

+        L"WARNING: PcdTpm2AcpiTableRev is not DynamicHii type and does not map to this option!",

+        L"The Revision configuring by this setup option will not work!",

+        NULL

+        );

+    }

   }

 

   return EFI_SUCCESS;

@@ -607,7 +626,7 @@ Tcg2Callback (
   }

 

   if (Action == EFI_BROWSER_ACTION_SUBMITTED) {

-    if (QuestionId == KEY_TCG2_PPI_VERSION) {

+    if (QuestionId == KEY_TCG2_PPI_VERSION || QuestionId == KEY_TPM2_ACPI_REVISION) {

       return Tcg2VersionInfoCallback (Action, QuestionId, Type, Value);

     }

   }

@@ -971,6 +990,7 @@ InstallTcg2ConfigForm (
   if (EFI_ERROR (Status)) {

     DEBUG ((EFI_D_ERROR, "Tcg2ConfigDriver: Fail to set TCG2_STORAGE_INFO_NAME\n"));

   }

+

   return EFI_SUCCESS;  

 }

 

diff --git a/SecurityPkg/Tcg/Tcg2Config/Tcg2ConfigImpl.h b/SecurityPkg/Tcg/Tcg2Config/Tcg2ConfigImpl.h
index 91d0c275b1..504212baa8 100644
--- a/SecurityPkg/Tcg/Tcg2Config/Tcg2ConfigImpl.h
+++ b/SecurityPkg/Tcg/Tcg2Config/Tcg2ConfigImpl.h
@@ -18,6 +18,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 

 #include <Uefi.h>

 

+#include <IndustryStandard/Tpm2Acpi.h>

+

 #include <Protocol/HiiConfigAccess.h>

 #include <Protocol/HiiConfigRouting.h>

 #include <Protocol/Tcg2Protocol.h>

diff --git a/SecurityPkg/Tcg/Tcg2Config/Tcg2ConfigNvData.h b/SecurityPkg/Tcg/Tcg2Config/Tcg2ConfigNvData.h
index 7868c212d5..5960446421 100644
--- a/SecurityPkg/Tcg/Tcg2Config/Tcg2ConfigNvData.h
+++ b/SecurityPkg/Tcg/Tcg2Config/Tcg2ConfigNvData.h
@@ -29,7 +29,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #define EFI_TCG2_EVENT_LOG_FORMAT_ALL           (EFI_TCG2_EVENT_LOG_FORMAT_TCG_1_2 | EFI_TCG2_EVENT_LOG_FORMAT_TCG_2)

 

 #define TCG2_CONFIGURATION_VARSTORE_ID  0x0001

-#define TCG2_CONFIGURATION_INFO_VARSTORE_ID  0x0002

+#define TCG2_CONFIGURATION_INFO_VARSTORE_ID     0x0002

 #define TCG2_VERSION_VARSTORE_ID        0x0003

 #define TCG2_CONFIGURATION_FORM_ID      0x0001

 

@@ -43,6 +43,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #define KEY_TPM2_PCR_BANKS_REQUEST_4            0x2007

 #define KEY_TPM_DEVICE_INTERFACE                       0x2008

 #define KEY_TCG2_PPI_VERSION                    0x2009

+#define KEY_TPM2_ACPI_REVISION                  0x200A

 

 #define TPM_DEVICE_NULL           0

 #define TPM_DEVICE_1_2            1

@@ -51,6 +52,9 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #define TPM_DEVICE_MAX            TPM_DEVICE_2_0_DTPM

 #define TPM_DEVICE_DEFAULT        TPM_DEVICE_1_2

 

+#define TPM2_ACPI_REVISION_3       3

+#define TPM2_ACPI_REVISION_4       4

+

 #define TPM_DEVICE_INTERFACE_TIS       0

 #define TPM_DEVICE_INTERFACE_PTP_FIFO  1

 #define TPM_DEVICE_INTERFACE_PTP_CRB   2

@@ -72,6 +76,7 @@ typedef struct {
 

 typedef struct {

   UINT64  PpiVersion;

+  UINT8   Tpm2AcpiTableRev;

 } TCG2_VERSION;

 

 typedef struct {

diff --git a/SecurityPkg/Tcg/Tcg2Config/Tcg2ConfigStrings.uni b/SecurityPkg/Tcg/Tcg2Config/Tcg2ConfigStrings.uni
index 414dcec5c2..a7d62bcbe6 100644
--- a/SecurityPkg/Tcg/Tcg2Config/Tcg2ConfigStrings.uni
+++ b/SecurityPkg/Tcg/Tcg2Config/Tcg2ConfigStrings.uni
@@ -38,6 +38,15 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #string STR_TPM2_ACPI_HID_HELP                    #language en-US "HID from TPM2 ACPI Table: ManufacturerID + FirmwareVersion_1"

 #string STR_TPM2_ACPI_HID_CONTENT                 #language en-US ""

 

+#string STR_TPM2_ACPI_REVISION_STATE_PROMPT   #language en-US "Current Rev of TPM2 ACPI Table"

+#string STR_TPM2_ACPI_REVISION_STATE_HELP     #language en-US "Current Rev of TPM2 ACPI Table: Rev 3 or Rev 4"

+#string STR_TPM2_ACPI_REVISION_STATE_CONTENT  #language en-US ""

+

+#string STR_TPM2_ACPI_REVISION_PROMPT          #language en-US "Attempt Rev of TPM2 ACPI Table"

+#string STR_TPM2_ACPI_REVISION_HELP            #language en-US "Rev 3 or Rev 4 (Rev 4 is defined in TCG ACPI Spec 00.37)"

+                                                               "PcdTpm2AcpiTableRev needs to be DynamicHii type and map to this option\n"

+                                                               "Otherwise the version configuring by this setup option will not work"

+

 #string STR_TCG2_DEVICE_INTERFACE_STATE_PROMPT         #language en-US "Current TPM Device Interface"

 #string STR_TCG2_DEVICE_INTERFACE_STATE_HELP           #language en-US "Current TPM Device Interface: TIS, PTP FIFO, PTP CRB"

 #string STR_TCG2_DEVICE_INTERFACE_STATE_CONTENT        #language en-US ""

@@ -74,6 +83,9 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #string STR_TCG2_TPM_1_2                   #language en-US "TPM 1.2"

 #string STR_TCG2_TPM_2_0_DTPM              #language en-US "TPM 2.0"

 

+#string STR_TPM2_ACPI_REVISION_3           #language en-US "Rev 3"

+#string STR_TPM2_ACPI_REVISION_4           #language en-US "Rev 4"

+

 #string STR_TCG2_PPI_VERSION_1_2           #language en-US "1.2"

 #string STR_TCG2_PPI_VERSION_1_3           #language en-US "1.3"