SecurityPkg:Tpm2DeviceLibDTpm: Support TPM command cancel

[mirror_edk2.git] / SecurityPkg / Library / Tpm2DeviceLibDTpm / Tpm2Ptp.c

diff --git a/SecurityPkg/Library/Tpm2DeviceLibDTpm/Tpm2Ptp.c b/SecurityPkg/Library/Tpm2DeviceLibDTpm/Tpm2Ptp.c
index a627bbdedf7a220221b1512f379c87dc42c8339d..d9df2646994d0351345c76b423b1467b7279b52e 100644 (file)
--- a/SecurityPkg/Library/Tpm2DeviceLibDTpm/Tpm2Ptp.c
+++ b/SecurityPkg/Library/Tpm2DeviceLibDTpm/Tpm2Ptp.c
@@ -1,7 +1,7 @@
 /** @file\r
   PTP (Platform TPM Profile) CRB (Command Response Buffer) interface used by dTPM2.0 library.\r
 \r
-Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.<BR>\r
 This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
@@ -52,7 +52,7 @@ typedef enum {
   @retval    FALSE   TPM PTP is not found.\r
 **/\r
 BOOLEAN\r
-IsPtpPresence (\r
+Tpm2IsPtpPresence (\r
   IN VOID *Reg\r
   )\r
 {\r
@@ -117,7 +117,7 @@ PtpCrbRequestUseTpm (
 {\r
   EFI_STATUS                        Status;\r
 \r
-  if (!IsPtpPresence (CrbReg)) {\r
+  if (!Tpm2IsPtpPresence (CrbReg)) {\r
     return EFI_NOT_FOUND;\r
   }\r
 \r
@@ -240,8 +240,26 @@ PtpCrbTpmCommand (
              PTP_TIMEOUT_MAX\r
              );\r
   if (EFI_ERROR (Status)) {\r
-    Status = EFI_DEVICE_ERROR;\r
-    goto Exit;\r
+    //\r
+    // Command Completion check timeout. Cancel the currently executing command by writing TPM_CRB_CTRL_CANCEL,\r
+    // Expect TPM_RC_CANCELLED or successfully completed response.\r
+    //\r
+    MmioWrite32((UINTN)&CrbReg->CrbControlCancel, PTP_CRB_CONTROL_CANCEL);\r
+    Status = PtpCrbWaitRegisterBits (\r
+               &CrbReg->CrbControlStart,\r
+               0,\r
+               PTP_CRB_CONTROL_START,\r
+               PTP_TIMEOUT_B\r
+               );\r
+    MmioWrite32((UINTN)&CrbReg->CrbControlCancel, 0);\r
+\r
+    if (EFI_ERROR(Status)) {\r
+      //\r
+      // Still in Command Execution state. Try to goIdle, the behavior is agnostic.\r
+      //\r
+      Status = EFI_DEVICE_ERROR;\r
+      goto Exit;\r
+    }\r
   }\r
 \r
   //\r
@@ -353,14 +371,14 @@ TisPcRequestUseTpm (
   @return PTP interface type.\r
 **/\r
 PTP_INTERFACE_TYPE\r
-GetPtpInterface (\r
+Tpm2GetPtpInterface (\r
   IN VOID *Register\r
   )\r
 {\r
   PTP_CRB_INTERFACE_IDENTIFIER  InterfaceId;\r
   PTP_FIFO_INTERFACE_CAPABILITY InterfaceCapability;\r
 \r
-  if (!IsPtpPresence (Register)) {\r
+  if (!Tpm2IsPtpPresence (Register)) {\r
     return PtpInterfaceMax;\r
   }\r
   //\r
@@ -401,7 +419,7 @@ DumpPtpInfo (
   UINT8                         Rid;\r
   PTP_INTERFACE_TYPE            PtpInterface;\r
 \r
-  if (!IsPtpPresence (Register)) {\r
+  if (!Tpm2IsPtpPresence (Register)) {\r
     return ;\r
   }\r
 \r
@@ -440,7 +458,7 @@ DumpPtpInfo (
   Vid = 0xFFFF;\r
   Did = 0xFFFF;\r
   Rid = 0xFF;\r
-  PtpInterface = GetPtpInterface (Register);\r
+  PtpInterface = Tpm2GetPtpInterface (Register);\r
   DEBUG ((EFI_D_INFO, "PtpInterface - %x\n", PtpInterface));\r
   switch (PtpInterface) {\r
   case PtpInterfaceCrb:\r
@@ -485,7 +503,7 @@ DTpm2SubmitCommand (
 {\r
   PTP_INTERFACE_TYPE  PtpInterface;\r
 \r
-  PtpInterface = GetPtpInterface ((VOID *) (UINTN) PcdGet64 (PcdTpmBaseAddress));\r
+  PtpInterface = Tpm2GetPtpInterface ((VOID *) (UINTN) PcdGet64 (PcdTpmBaseAddress));\r
   switch (PtpInterface) {\r
   case PtpInterfaceCrb:\r
     return PtpCrbTpmCommand (\r
@@ -524,7 +542,7 @@ DTpm2RequestUseTpm (
 {\r
   PTP_INTERFACE_TYPE  PtpInterface;\r
 \r
-  PtpInterface = GetPtpInterface ((VOID *) (UINTN) PcdGet64 (PcdTpmBaseAddress));\r
+  PtpInterface = Tpm2GetPtpInterface ((VOID *) (UINTN) PcdGet64 (PcdTpmBaseAddress));\r
   switch (PtpInterface) {\r
   case PtpInterfaceCrb:\r
     return PtpCrbRequestUseTpm ((PTP_CRB_REGISTERS_PTR) (UINTN) PcdGet64 (PcdTpmBaseAddress));\r