1） delete unused parameter from IScsiCHAPOnRspReceived ()

[mirror_edk2.git] / MdeModulePkg / Universal / Network / IScsiDxe / Md5.h

diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/Md5.h b/MdeModulePkg/Universal/Network/IScsiDxe/Md5.h
index 365b5cbbe6ff43e53eb482397433dc95ae46d742..4198e200dc9d62abfaeccde8872749e6bbbb0315 100644 (file)
--- a/MdeModulePkg/Universal/Network/IScsiDxe/Md5.h
+++ b/MdeModulePkg/Universal/Network/IScsiDxe/Md5.h
@@ -1,6 +1,7 @@
-/*++\r
+/** @file\r
+  Header file for Md5.\r
 \r
-Copyright (c) 2004 - 2008, Intel Corporation\r
+Copyright (c) 2004 - 2008, Intel Corporation.<BR>\r
 All rights reserved. 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
@@ -9,23 +10,15 @@ http://opensource.org/licenses/bsd-license.php
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
-Module Name:\r
-\r
-  Md5.h\r
-\r
-Abstract:\r
-\r
-  Header file for Md5\r
-\r
---*/\r
+**/\r
 \r
 #ifndef _MD5_H_\r
 #define _MD5_H_\r
 \r
-#include <Uefi/UefiBaseType.h>\r
+#include <Uefi.h>\r
 #include <Library/BaseLib.h>\r
 #include <Library/NetLib.h>\r
-\r
+ \r
 #define MD5_HASHSIZE  16\r
 \r
 typedef struct _MD5_CTX {\r
@@ -36,73 +29,51 @@ typedef struct _MD5_CTX {
   UINTN       Count;\r
 } MD5_CTX;\r
 \r
-EFI_STATUS\r
-MD5Init (\r
-  IN MD5_CTX  *Md5Ctx\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  GC_TODO: Add function description\r
+/**\r
+  Initialize four 32-bits chaining variables and use them to do the Md5 transform.\r
 \r
-Arguments:\r
+  @param[out]  Md5Ctx The data structure of Md5.\r
 \r
-  Md5Ctx  - GC_TODO: add argument description\r
-\r
-Returns:\r
+  @retval EFI_SUCCESS Initialization is ok.\r
+**/\r
+EFI_STATUS\r
+MD5Init (\r
+  OUT MD5_CTX  *Md5Ctx\r
+  );\r
 \r
-  EFI_SUCCESS - GC_TODO: Add description for return value\r
+/**\r
+  the external interface of Md5 algorithm\r
 \r
---*/\r
-;\r
+  @param[in, out]  Md5Ctx  The data structure of storing the original data\r
+                           segment and the final result.\r
+  @param[in]       Data    The data wanted to be transformed.\r
+  @param[in]       DataLen The length of data.\r
 \r
+  @retval EFI_SUCCESS The transform is ok.\r
+  @retval Others      Other errors as indicated.\r
+**/\r
 EFI_STATUS\r
 MD5Update (\r
-  IN MD5_CTX  *Md5Ctx,\r
-  IN VOID     *Data,\r
-  IN UINTN    DataLen\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  Md5Ctx  - GC_TODO: add argument description\r
-  Data    - GC_TODO: add argument description\r
-  DataLen - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
-  EFI_SUCCESS - GC_TODO: Add description for return value\r
-\r
---*/\r
-;\r
-\r
+  IN  OUT MD5_CTX  *Md5Ctx,\r
+  IN  VOID         *Data,\r
+  IN  UINTN        DataLen\r
+  );\r
+\r
+/**\r
+  Accumulate the MD5 value of every data segment and generate the finial\r
+  result according to MD5 algorithm.\r
+\r
+  @param[in, out]   Md5Ctx  The data structure of storing the original data\r
+                            segment and the final result.\r
+  @param[out]      HashVal  The final 128-bits output.\r
+\r
+  @retval EFI_SUCCESS  The transform is ok.\r
+  @retval Others       Other errors as indicated.\r
+**/\r
 EFI_STATUS\r
 MD5Final (\r
-  IN  MD5_CTX  *Md5Ctx,\r
-  OUT UINT8    *HashVal\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  Md5Ctx  - GC_TODO: add argument description\r
-  HashVal - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
-  EFI_SUCCESS - GC_TODO: Add description for return value\r
-\r
---*/\r
-;\r
+  IN  OUT MD5_CTX  *Md5Ctx,\r
+  OUT UINT8        *HashVal\r
+  );\r
 \r
-#endif // _MD5_H\r
+#endif \r