SecurityPkg: Cache TPM interface type info

Cache TPM interface type info to avoid excessive interface ID register read

Cc: Long Qin <qin.long@intel.com>
Cc: Yao Jiewen <jiewen.yao@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Chao Zhang <chao.b.zhang@intel.com>
Reviewed-by: Long Qin <qin.long@intel.com>

5 files changed, 27 insertions, 106 deletions

diff --git a/SecurityPkg/Tcg/Tcg2Config/Tcg2ConfigDxe.inf b/SecurityPkg/Tcg/Tcg2Config/Tcg2ConfigDxe.inf
index 38fa331701..a52709669a 100644
--- a/SecurityPkg/Tcg/Tcg2Config/Tcg2ConfigDxe.inf
+++ b/SecurityPkg/Tcg/Tcg2Config/Tcg2ConfigDxe.inf
@@ -4,7 +4,7 @@
 #  By this module, user may select TPM device, clear TPM state, etc.

 #  NOTE: This module is only for reference only, each platform should have its own setup page.

 #

-# Copyright (c) 2015 - 2017, Intel Corporation. All rights reserved.<BR>

+# Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.<BR>

 # This program and the accompanying materials

 # are licensed and made available under the terms and conditions of the BSD License

 # which accompanies this distribution. The full text of the license may be found at

@@ -79,6 +79,7 @@
   gEfiSecurityPkgTokenSpaceGuid.PcdTpmBaseAddress             ## CONSUMES

   gEfiSecurityPkgTokenSpaceGuid.PcdTcgPhysicalPresenceInterfaceVer  ## CONSUMES

   gEfiSecurityPkgTokenSpaceGuid.PcdTpm2AcpiTableRev           ## CONSUMES

+  gEfiSecurityPkgTokenSpaceGuid.PcdActiveTpmInterfaceType     ## CONSUMES

 

 [Depex]

   gEfiTcg2ProtocolGuid              AND

diff --git a/SecurityPkg/Tcg/Tcg2Config/Tcg2ConfigImpl.c b/SecurityPkg/Tcg/Tcg2Config/Tcg2ConfigImpl.c
index 4195b6c68f..af97628e2c 100644
--- a/SecurityPkg/Tcg/Tcg2Config/Tcg2ConfigImpl.c
+++ b/SecurityPkg/Tcg/Tcg2Config/Tcg2ConfigImpl.c
@@ -2,7 +2,7 @@
   HII Config Access protocol implementation of TCG2 configuration module.

   NOTE: This module is only for reference only, each platform should have its own setup page.

 

-Copyright (c) 2015 - 2017, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.<BR>

 (C) Copyright 2018 Hewlett Packard Enterprise Development LP<BR>

 This program and the accompanying materials 

 are licensed and made available under the terms and conditions of the BSD License 

@@ -17,7 +17,9 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include "Tcg2ConfigImpl.h"

 #include <Library/PcdLib.h>

 #include <Library/Tpm2CommandLib.h>

+#include <Library/Tpm2DeviceLib.h>

 #include <Library/IoLib.h>

+

 #include <Guid/TpmInstance.h>

 

 #include <IndustryStandard/TpmPtp.h>

@@ -61,41 +63,6 @@ HII_VENDOR_DEVICE_PATH          mTcg2HiiVendorDevicePath = {
 UINT8  mCurrentPpRequest;

 

 /**

-  Return PTP interface type.

-

-  @param[in] Register                Pointer to PTP register.

-

-  @return PTP interface type.

-**/

-UINT8

-GetPtpInterface (

-  IN VOID *Register

-  )

-{

-  PTP_CRB_INTERFACE_IDENTIFIER  InterfaceId;

-  PTP_FIFO_INTERFACE_CAPABILITY InterfaceCapability;

-

-  //

-  // Check interface id

-  //

-  InterfaceId.Uint32 = MmioRead32 ((UINTN)&((PTP_CRB_REGISTERS *)Register)->InterfaceId);

-  InterfaceCapability.Uint32 = MmioRead32 ((UINTN)&((PTP_FIFO_REGISTERS *)Register)->InterfaceCapability);

-

-  if ((InterfaceId.Bits.InterfaceType == PTP_INTERFACE_IDENTIFIER_INTERFACE_TYPE_CRB) &&

-      (InterfaceId.Bits.InterfaceVersion == PTP_INTERFACE_IDENTIFIER_INTERFACE_VERSION_CRB) &&

-      (InterfaceId.Bits.CapCRB != 0)) {

-    return TPM_DEVICE_INTERFACE_PTP_CRB;

-  }

-  if ((InterfaceId.Bits.InterfaceType == PTP_INTERFACE_IDENTIFIER_INTERFACE_TYPE_FIFO) &&

-      (InterfaceId.Bits.InterfaceVersion == PTP_INTERFACE_IDENTIFIER_INTERFACE_VERSION_FIFO) &&

-      (InterfaceId.Bits.CapFIFO != 0) &&

-      (InterfaceCapability.Bits.InterfaceVersion == INTERFACE_CAPABILITY_INTERFACE_VERSION_PTP)) {

-    return TPM_DEVICE_INTERFACE_PTP_FIFO;

-  }

-  return TPM_DEVICE_INTERFACE_TIS;

-}

-

-/**

   Return if PTP CRB is supported.

 

   @param[in] Register                Pointer to PTP register.

@@ -153,6 +120,7 @@ IsPtpFifoSupported (
 

 /**

   Set PTP interface type.

+  Do not update PcdActiveTpmInterfaceType here because interface change only happens on next _TPM_INIT

 

   @param[in] Register                Pointer to PTP register.

   @param[in] PtpInterface            PTP interface type.

@@ -168,12 +136,12 @@ SetPtpInterface (
   IN UINT8                PtpInterface

   )

 {

-  UINT8                         PtpInterfaceCurrent;

+  TPM2_PTP_INTERFACE_TYPE       PtpInterfaceCurrent;

   PTP_CRB_INTERFACE_IDENTIFIER  InterfaceId;

 

-  PtpInterfaceCurrent = GetPtpInterface (Register);

-  if ((PtpInterfaceCurrent != TPM_DEVICE_INTERFACE_PTP_FIFO) && 

-      (PtpInterfaceCurrent != TPM_DEVICE_INTERFACE_PTP_CRB)) {

+  PtpInterfaceCurrent = PcdGet8(PcdActiveTpmInterfaceType);

+  if ((PtpInterfaceCurrent != Tpm2PtpInterfaceFifo) &&

+      (PtpInterfaceCurrent != Tpm2PtpInterfaceCrb)) {

     return EFI_UNSUPPORTED;

   }

   InterfaceId.Uint32 = MmioRead32 ((UINTN)&((PTP_CRB_REGISTERS *)Register)->InterfaceId);

@@ -182,14 +150,14 @@ SetPtpInterface (
   }

 

   switch (PtpInterface) {

-  case TPM_DEVICE_INTERFACE_PTP_FIFO:

+  case Tpm2PtpInterfaceFifo:

     if (InterfaceId.Bits.CapFIFO == 0) {

       return EFI_UNSUPPORTED;

     }

     InterfaceId.Bits.InterfaceSelector = PTP_INTERFACE_IDENTIFIER_INTERFACE_SELECTOR_FIFO;

     MmioWrite32 ((UINTN)&((PTP_CRB_REGISTERS *)Register)->InterfaceId, InterfaceId.Uint32);

     return EFI_SUCCESS;

-  case TPM_DEVICE_INTERFACE_PTP_CRB:

+  case Tpm2PtpInterfaceCrb:

     if (InterfaceId.Bits.CapCRB == 0) {

       return EFI_UNSUPPORTED;

     }

@@ -825,7 +793,7 @@ InstallTcg2ConfigForm (
   TPML_PCR_SELECTION              Pcrs;

   CHAR16                          TempBuffer[1024];

   TCG2_CONFIGURATION_INFO         Tcg2ConfigInfo;

-  UINT8                           TpmDeviceInterfaceDetected;

+  TPM2_PTP_INTERFACE_TYPE         TpmDeviceInterfaceDetected;

 

   DriverHandle = NULL;

   ConfigAccess = &PrivateData->ConfigAccess;

@@ -930,15 +898,15 @@ InstallTcg2ConfigForm (
   // Update TPM device interface type

   //

   if (PrivateData->TpmDeviceDetected == TPM_DEVICE_2_0_DTPM) {

-    TpmDeviceInterfaceDetected = GetPtpInterface ((VOID *) (UINTN) PcdGet64 (PcdTpmBaseAddress));

+    TpmDeviceInterfaceDetected = PcdGet8(PcdActiveTpmInterfaceType);

     switch (TpmDeviceInterfaceDetected) {

-    case TPM_DEVICE_INTERFACE_TIS:

+    case Tpm2PtpInterfaceTis:

       HiiSetString (PrivateData->HiiHandle, STRING_TOKEN (STR_TCG2_DEVICE_INTERFACE_STATE_CONTENT), L"TIS", NULL);

       break;

-    case TPM_DEVICE_INTERFACE_PTP_FIFO:

+    case Tpm2PtpInterfaceFifo:

       HiiSetString (PrivateData->HiiHandle, STRING_TOKEN (STR_TCG2_DEVICE_INTERFACE_STATE_CONTENT), L"PTP FIFO", NULL);

       break;

-    case TPM_DEVICE_INTERFACE_PTP_CRB:

+    case Tpm2PtpInterfaceCrb:

       HiiSetString (PrivateData->HiiHandle, STRING_TOKEN (STR_TCG2_DEVICE_INTERFACE_STATE_CONTENT), L"PTP CRB", NULL);

       break;

      default:

@@ -948,13 +916,13 @@ InstallTcg2ConfigForm (
 

     Tcg2ConfigInfo.TpmDeviceInterfaceAttempt = TpmDeviceInterfaceDetected;

     switch (TpmDeviceInterfaceDetected) {

-    case TPM_DEVICE_INTERFACE_TIS:

+    case Tpm2PtpInterfaceTis:

       Tcg2ConfigInfo.TpmDeviceInterfacePtpFifoSupported = FALSE;

       Tcg2ConfigInfo.TpmDeviceInterfacePtpCrbSupported  = FALSE;

       HiiSetString (PrivateData->HiiHandle, STRING_TOKEN (STR_TCG2_DEVICE_INTERFACE_CAPABILITY_CONTENT), L"TIS", NULL);

       break;

-    case TPM_DEVICE_INTERFACE_PTP_FIFO:

-    case TPM_DEVICE_INTERFACE_PTP_CRB:

+    case Tpm2PtpInterfaceFifo:

+    case Tpm2PtpInterfaceCrb:

       Tcg2ConfigInfo.TpmDeviceInterfacePtpFifoSupported = IsPtpFifoSupported((VOID *) (UINTN) PcdGet64 (PcdTpmBaseAddress));

       Tcg2ConfigInfo.TpmDeviceInterfacePtpCrbSupported  = IsPtpCrbSupported((VOID *) (UINTN) PcdGet64 (PcdTpmBaseAddress));

       TempBuffer[0] = 0;

diff --git a/SecurityPkg/Tcg/Tcg2Smm/Tcg2Smm.c b/SecurityPkg/Tcg/Tcg2Smm/Tcg2Smm.c
index f0c92462cf..26f1fbdf8c 100644
--- a/SecurityPkg/Tcg/Tcg2Smm/Tcg2Smm.c
+++ b/SecurityPkg/Tcg/Tcg2Smm/Tcg2Smm.c
@@ -22,56 +22,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 

 #include "Tcg2Smm.h"

 

-typedef enum {

-  PtpInterfaceTis,

-  PtpInterfaceFifo,

-  PtpInterfaceCrb,

-  PtpInterfaceMax,

-} PTP_INTERFACE_TYPE;

-

-/**

-  Return PTP interface type.

-

-  @param[in] Register                Pointer to PTP register.

-

-  @return PTP interface type.

-**/

-PTP_INTERFACE_TYPE

-GetPtpInterface (

-  IN VOID *Register

-  )

-{

-  PTP_CRB_INTERFACE_IDENTIFIER  InterfaceId;

-  PTP_FIFO_INTERFACE_CAPABILITY InterfaceCapability;

-

-  //

-  // Check interface id

-  //

-  InterfaceId.Uint32 = MmioRead32 ((UINTN)&((PTP_CRB_REGISTERS *)Register)->InterfaceId);

-  InterfaceCapability.Uint32 = MmioRead32 ((UINTN)&((PTP_FIFO_REGISTERS *)Register)->InterfaceCapability);

-

-  if (InterfaceId.Bits.InterfaceType == PTP_INTERFACE_IDENTIFIER_INTERFACE_TYPE_TIS) {

-    return PtpInterfaceTis;

-  }

-

-  if ((InterfaceId.Bits.InterfaceType == PTP_INTERFACE_IDENTIFIER_INTERFACE_TYPE_CRB) &&

-      (InterfaceId.Bits.InterfaceVersion == PTP_INTERFACE_IDENTIFIER_INTERFACE_VERSION_CRB) &&

-      (InterfaceId.Bits.CapCRB != 0)) {

-    return PtpInterfaceCrb;

-  }

-

-  if ((InterfaceId.Bits.InterfaceType == PTP_INTERFACE_IDENTIFIER_INTERFACE_TYPE_FIFO) &&

-      (InterfaceId.Bits.InterfaceVersion == PTP_INTERFACE_IDENTIFIER_INTERFACE_VERSION_FIFO) &&

-      (InterfaceId.Bits.CapFIFO != 0) &&

-      (InterfaceCapability.Bits.InterfaceVersion == INTERFACE_CAPABILITY_INTERFACE_VERSION_PTP)) {

-    return PtpInterfaceFifo;

-  }

-

-  //

-  // No Ptp interface available

-  //

-  return PtpInterfaceMax;

-}

 

 EFI_TPM2_ACPI_TABLE  mTpm2AcpiTemplate = {

   {

@@ -785,7 +735,7 @@ PublishTpm2 (
   UINTN                          TableKey;

   UINT64                         OemTableId;

   EFI_TPM2_ACPI_CONTROL_AREA     *ControlArea;

-  PTP_INTERFACE_TYPE             InterfaceType;

+  TPM2_PTP_INTERFACE_TYPE        InterfaceType;

 

   mTpm2AcpiTemplate.Header.Revision = PcdGet8(PcdTpm2AcpiTableRev);

   DEBUG((DEBUG_INFO, "Tpm2 ACPI table revision is %d\n", mTpm2AcpiTemplate.Header.Revision));

@@ -812,9 +762,9 @@ PublishTpm2 (
     sizeof(mTpm2AcpiTemplate)

     );

 

-  InterfaceType = GetPtpInterface ((VOID *) (UINTN) PcdGet64 (PcdTpmBaseAddress));

+  InterfaceType = PcdGet8(PcdActiveTpmInterfaceType);

   switch (InterfaceType) {

-  case PtpInterfaceCrb:

+  case Tpm2PtpInterfaceCrb:

     mTpm2AcpiTemplate.StartMethod = EFI_TPM2_ACPI_TABLE_START_METHOD_COMMAND_RESPONSE_BUFFER_INTERFACE;

     mTpm2AcpiTemplate.AddressOfControlArea = PcdGet64 (PcdTpmBaseAddress) + 0x40;

     ControlArea = (EFI_TPM2_ACPI_CONTROL_AREA *)(UINTN)mTpm2AcpiTemplate.AddressOfControlArea;

@@ -823,8 +773,8 @@ PublishTpm2 (
     ControlArea->Command      = PcdGet64 (PcdTpmBaseAddress) + 0x80;

     ControlArea->Response     = PcdGet64 (PcdTpmBaseAddress) + 0x80;

     break;

-  case PtpInterfaceFifo:

-  case PtpInterfaceTis:

+  case Tpm2PtpInterfaceFifo:

+  case Tpm2PtpInterfaceTis:

     break;

   default:

     DEBUG((EFI_D_ERROR, "TPM2 InterfaceType get error! %d\n", InterfaceType));

diff --git a/SecurityPkg/Tcg/Tcg2Smm/Tcg2Smm.h b/SecurityPkg/Tcg/Tcg2Smm/Tcg2Smm.h
index 732452cb35..e3a14e8339 100644
--- a/SecurityPkg/Tcg/Tcg2Smm/Tcg2Smm.h
+++ b/SecurityPkg/Tcg/Tcg2Smm/Tcg2Smm.h
@@ -40,6 +40,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include <Library/IoLib.h>

 #include <Library/PrintLib.h>

 #include <Library/PcdLib.h>

+#include <Library/Tpm2DeviceLib.h>

 

 #include <IndustryStandard/TpmPtp.h>

 

diff --git a/SecurityPkg/Tcg/Tcg2Smm/Tcg2Smm.inf b/SecurityPkg/Tcg/Tcg2Smm/Tcg2Smm.inf
index 81f74959a4..168f9779e6 100644
--- a/SecurityPkg/Tcg/Tcg2Smm/Tcg2Smm.inf
+++ b/SecurityPkg/Tcg/Tcg2Smm/Tcg2Smm.inf
@@ -85,6 +85,7 @@
   gEfiSecurityPkgTokenSpaceGuid.PcdTpmPlatformClass                 ## SOMETIMES_CONSUMES

   gEfiSecurityPkgTokenSpaceGuid.PcdTpm2CurrentIrqNum            ## CONSUMES

   gEfiSecurityPkgTokenSpaceGuid.PcdTpm2PossibleIrqNumBuf        ## CONSUMES

+  gEfiSecurityPkgTokenSpaceGuid.PcdActiveTpmInterfaceType       ## CONSUMES

 

 [Depex]

   gEfiAcpiTableProtocolGuid AND