From: Star Zeng <star.zeng@intel.com>
Date: Tue, 13 Sep 2016 11:12:07 +0000 (+0800)
Subject: SecurityPkg/TPM2: Update function header of GetDigestFromDigestList()
X-Git-Tag: edk2-stable201903~5741
X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=commitdiff_plain;h=f28ab8494664411ac9b3ec22b82d714d8a3ca4c1

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 197d649586..1a837fd11f 100644
--- a/SecurityPkg/Include/Library/Tpm2CommandLib.h
+++ b/SecurityPkg/Include/Library/Tpm2CommandLib.h
@@ -991,19 +991,19 @@ GetHashSizeFromAlgo (
 /**
   This function get digest from digest list.
 
-  @param HashAlg    digest algorithm
-  @param DigestList digest list
-  @param Digest     digest
+  @param[in]  HashAlg       Digest algorithm
+  @param[in]  DigestList    Digest list
+  @param[out] Digest        Digest
 
-  @retval EFI_SUCCESS   Sha1Digest is found and returned.
-  @retval EFI_NOT_FOUND Sha1Digest is not found.
+  @retval EFI_SUCCESS       Digest is found and returned.
+  @retval EFI_NOT_FOUND     Digest is not found.
 **/
 EFI_STATUS
 EFIAPI
 GetDigestFromDigestList(
   IN TPMI_ALG_HASH      HashAlg,
   IN TPML_DIGEST_VALUES *DigestList,
-  IN VOID               *Digest
+  OUT VOID              *Digest
   );
 
 #endif
diff --git a/SecurityPkg/Library/Tpm2CommandLib/Tpm2Help.c b/SecurityPkg/Library/Tpm2CommandLib/Tpm2Help.c
index b40c2ab09d..2df18dfe07 100644
--- a/SecurityPkg/Library/Tpm2CommandLib/Tpm2Help.c
+++ b/SecurityPkg/Library/Tpm2CommandLib/Tpm2Help.c
@@ -168,19 +168,19 @@ CopyAuthSessionResponse (
 /**
   This function get digest from digest list.
 
-  @param HashAlg    digest algorithm
-  @param DigestList digest list
-  @param Digest     digest
+  @param[in]  HashAlg       Digest algorithm
+  @param[in]  DigestList    Digest list
+  @param[out] Digest        Digest
 
-  @retval EFI_SUCCESS   Sha1Digest is found and returned.
-  @retval EFI_NOT_FOUND Sha1Digest is not found.
+  @retval EFI_SUCCESS       Digest is found and returned.
+  @retval EFI_NOT_FOUND     Digest is not found.
 **/
 EFI_STATUS
 EFIAPI
 GetDigestFromDigestList (
   IN TPMI_ALG_HASH      HashAlg,
   IN TPML_DIGEST_VALUES *DigestList,
-  IN VOID               *Digest
+  OUT VOID              *Digest
   )
 {
   UINTN  Index;
@@ -199,4 +199,4 @@ GetDigestFromDigestList (
   }
 
   return EFI_NOT_FOUND;
-}
\ No newline at end of file
+}