SecurityPkg/TPM2: Update function header of GetDigestFromDigestList()

Update the return status description and use OUT identifier instead of
IN for Digest parameter, no functionality change.

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

diff --git a/SecurityPkg/Include/Library/Tpm2CommandLib.h b/SecurityPkg/Include/Library/Tpm2CommandLib.h
index 197d649586342fcf6bf9557e29dbeb8ffcb1500f..1a837fd11f42876bcb899e7b0bee671612e47598 100644 (file)
--- a/SecurityPkg/Include/Library/Tpm2CommandLib.h
+++ b/SecurityPkg/Include/Library/Tpm2CommandLib.h
@@ -991,19 +991,19 @@ GetHashSizeFromAlgo (
 /**\r
   This function get digest from digest list.\r
 \r
-  @param HashAlg    digest algorithm\r
-  @param DigestList digest list\r
-  @param Digest     digest\r
+  @param[in]  HashAlg       Digest algorithm\r
+  @param[in]  DigestList    Digest list\r
+  @param[out] Digest        Digest\r
 \r
-  @retval EFI_SUCCESS   Sha1Digest is found and returned.\r
-  @retval EFI_NOT_FOUND Sha1Digest is not found.\r
+  @retval EFI_SUCCESS       Digest is found and returned.\r
+  @retval EFI_NOT_FOUND     Digest is not found.\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
 GetDigestFromDigestList(\r
   IN TPMI_ALG_HASH      HashAlg,\r
   IN TPML_DIGEST_VALUES *DigestList,\r
-  IN VOID               *Digest\r
+  OUT VOID              *Digest\r
   );\r
 \r
 #endif\r

diff --git a/SecurityPkg/Library/Tpm2CommandLib/Tpm2Help.c b/SecurityPkg/Library/Tpm2CommandLib/Tpm2Help.c
index b40c2ab09d30186a6cb2540d5f3c097c162b3e11..2df18dfe070ac6dd33baf19b5e676c15a3ca4026 100644 (file)
--- a/SecurityPkg/Library/Tpm2CommandLib/Tpm2Help.c
+++ b/SecurityPkg/Library/Tpm2CommandLib/Tpm2Help.c
@@ -168,19 +168,19 @@ CopyAuthSessionResponse (
 /**\r
   This function get digest from digest list.\r
 \r
-  @param HashAlg    digest algorithm\r
-  @param DigestList digest list\r
-  @param Digest     digest\r
+  @param[in]  HashAlg       Digest algorithm\r
+  @param[in]  DigestList    Digest list\r
+  @param[out] Digest        Digest\r
 \r
-  @retval EFI_SUCCESS   Sha1Digest is found and returned.\r
-  @retval EFI_NOT_FOUND Sha1Digest is not found.\r
+  @retval EFI_SUCCESS       Digest is found and returned.\r
+  @retval EFI_NOT_FOUND     Digest is not found.\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
 GetDigestFromDigestList (\r
   IN TPMI_ALG_HASH      HashAlg,\r
   IN TPML_DIGEST_VALUES *DigestList,\r
-  IN VOID               *Digest\r
+  OUT VOID              *Digest\r
   )\r
 {\r
   UINTN  Index;\r
@@ -199,4 +199,4 @@ GetDigestFromDigestList (
   }\r
 \r
   return EFI_NOT_FOUND;\r
-}
\ No newline at end of file
+}\r