CryptoPkg/BaseCryptLib: Make comments consistent with the function

Correct the unaligned parameter names in comments (BaseCryptLib.h and
HMAC-SHA256 wrapper implementation)

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Dandan Bi <dandan.bi@intel.com>
Reviewed-by: Qin Long <qin.long@intel.com>

diff --git a/CryptoPkg/Include/Library/BaseCryptLib.h b/CryptoPkg/Include/Library/BaseCryptLib.h
index 45dac3b4c10c4ad1f9de1c8309530c8107fe96dd..9cc4776c305690f137bb4937109f900de1c79798 100644 (file)
--- a/CryptoPkg/Include/Library/BaseCryptLib.h
+++ b/CryptoPkg/Include/Library/BaseCryptLib.h
@@ -994,11 +994,11 @@ HmacMd5Update (
   finalized by HmacMd5Final(). Behavior with invalid HMAC-MD5 context is undefined.\r
 \r
   If HmacMd5Context is NULL, then return FALSE.\r
   finalized by HmacMd5Final(). Behavior with invalid HMAC-MD5 context is undefined.\r
 \r
   If HmacMd5Context is NULL, then return FALSE.\r

-  If HashValue is NULL, then return FALSE.\r
+  If HmacValue is NULL, then return FALSE.\r

   If this interface is not supported, then return FALSE.\r
 \r
   @param[in, out]  HmacMd5Context  Pointer to the HMAC-MD5 context.\r
   If this interface is not supported, then return FALSE.\r
 \r
   @param[in, out]  HmacMd5Context  Pointer to the HMAC-MD5 context.\r

-  @param[out]      HashValue       Pointer to a buffer that receives the HMAC-MD5 digest\r
+  @param[out]      HmacValue       Pointer to a buffer that receives the HMAC-MD5 digest\r

                                    value (16 bytes).\r
 \r
   @retval TRUE   HMAC-MD5 digest computation succeeded.\r
                                    value (16 bytes).\r
 \r
   @retval TRUE   HMAC-MD5 digest computation succeeded.\r


@@ -1112,11 +1112,11 @@ HmacSha1Update (
   not be finalized by HmacSha1Final(). Behavior with invalid HMAC-SHA1 context is undefined.\r
 \r
   If HmacSha1Context is NULL, then return FALSE.\r
   not be finalized by HmacSha1Final(). Behavior with invalid HMAC-SHA1 context is undefined.\r
 \r
   If HmacSha1Context is NULL, then return FALSE.\r

-  If HashValue is NULL, then return FALSE.\r
+  If HmacValue is NULL, then return FALSE.\r

   If this interface is not supported, then return FALSE.\r
 \r
   @param[in, out]  HmacSha1Context  Pointer to the HMAC-SHA1 context.\r
   If this interface is not supported, then return FALSE.\r
 \r
   @param[in, out]  HmacSha1Context  Pointer to the HMAC-SHA1 context.\r

-  @param[out]      HashValue        Pointer to a buffer that receives the HMAC-SHA1 digest\r
+  @param[out]      HmacValue        Pointer to a buffer that receives the HMAC-SHA1 digest\r

                                     value (20 bytes).\r
 \r
   @retval TRUE   HMAC-SHA1 digest computation succeeded.\r
                                     value (20 bytes).\r
 \r
   @retval TRUE   HMAC-SHA1 digest computation succeeded.\r


@@ -1230,11 +1230,11 @@ HmacSha256Update (
   not be finalized by HmacSha256Final(). Behavior with invalid HMAC-SHA256 context is undefined.\r
 \r
   If HmacSha256Context is NULL, then return FALSE.\r
   not be finalized by HmacSha256Final(). Behavior with invalid HMAC-SHA256 context is undefined.\r
 \r
   If HmacSha256Context is NULL, then return FALSE.\r

-  If HashValue is NULL, then return FALSE.\r
+  If HmacValue is NULL, then return FALSE.\r

   If this interface is not supported, then return FALSE.\r
 \r
   @param[in, out]  HmacSha256Context  Pointer to the HMAC-SHA256 context.\r
   If this interface is not supported, then return FALSE.\r
 \r
   @param[in, out]  HmacSha256Context  Pointer to the HMAC-SHA256 context.\r

-  @param[out]      HashValue          Pointer to a buffer that receives the HMAC-SHA256 digest\r
+  @param[out]      HmacValue          Pointer to a buffer that receives the HMAC-SHA256 digest\r

                                       value (32 bytes).\r
 \r
   @retval TRUE   HMAC-SHA256 digest computation succeeded.\r
                                       value (32 bytes).\r
 \r
   @retval TRUE   HMAC-SHA256 digest computation succeeded.\r

diff --git a/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256.c b/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256.c
index 5d349dc0850bae5bf582b6ac0806f7df49181145..7726e404f62741014152760c4e0ad5cd9ddbb4e6 100644 (file)
--- a/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256.c
+++ b/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256.c
@@ -161,10 +161,10 @@ HmacSha256Update (
   not be finalized by HmacSha256Final(). Behavior with invalid HMAC-SHA256 context is undefined.\r
 \r
   If HmacSha256Context is NULL, then return FALSE.\r
   not be finalized by HmacSha256Final(). Behavior with invalid HMAC-SHA256 context is undefined.\r
 \r
   If HmacSha256Context is NULL, then return FALSE.\r

-  If HashValue is NULL, then return FALSE.\r
+  If HmacValue is NULL, then return FALSE.\r

 \r
   @param[in, out]  HmacSha256Context  Pointer to the HMAC-SHA256 context.\r
 \r
   @param[in, out]  HmacSha256Context  Pointer to the HMAC-SHA256 context.\r

-  @param[out]      HashValue          Pointer to a buffer that receives the HMAC-SHA256 digest\r
+  @param[out]      HmacValue          Pointer to a buffer that receives the HMAC-SHA256 digest\r

                                       value (32 bytes).\r
 \r
   @retval TRUE   HMAC-SHA256 digest computation succeeded.\r
                                       value (32 bytes).\r
 \r
   @retval TRUE   HMAC-SHA256 digest computation succeeded.\r

diff --git a/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256Null.c b/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256Null.c
index 48704e1091d2b1890948487bb1d86ac91f7a5270..35abddaa92b67b14630eaf677e8a66c67b30f0d2 100644 (file)
--- a/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256Null.c
+++ b/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256Null.c
@@ -109,7 +109,7 @@ HmacSha256Update (
   Return FALSE to indicate this interface is not supported.\r
 \r
   @param[in, out]  HmacSha256Context  Pointer to the HMAC-SHA256 context.\r
   Return FALSE to indicate this interface is not supported.\r
 \r
   @param[in, out]  HmacSha256Context  Pointer to the HMAC-SHA256 context.\r

-  @param[out]      HashValue          Pointer to a buffer that receives the HMAC-SHA256 digest\r
+  @param[out]      HmacValue          Pointer to a buffer that receives the HMAC-SHA256 digest\r

                                       value (32 bytes).\r
 \r
   @retval FALSE  This interface is not supported.\r
                                       value (32 bytes).\r
 \r
   @retval FALSE  This interface is not supported.\r