]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Universal/Network/IScsiDxe/Md5.h
Clean up the private GUID definition in module Level.
[mirror_edk2.git] / MdeModulePkg / Universal / Network / IScsiDxe / Md5.h
index dd59626f3731369d559a5ecacbf0d017c659c54b..8de4e869b4b4e9089b57293231d53efafde5176f 100644 (file)
@@ -1,8 +1,8 @@
 /** @file\r
-  Header file for Md5\r
+  Header file for Md5.\r
 \r
-Copyright (c) 2004 - 2008, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2004 - 2008, 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
 http://opensource.org/licenses/bsd-license.php\r
@@ -10,23 +10,16 @@ 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
 #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/BaseMemoryLib.h>\r
 #include <Library/NetLib.h>\r
-\r
\r
 #define MD5_HASHSIZE  16\r
 \r
 typedef struct _MD5_CTX {\r
@@ -40,55 +33,48 @@ typedef struct _MD5_CTX {
 /**\r
   Initialize four 32-bits chaining variables and use them to do the Md5 transform.\r
 \r
-  @param  Md5Ctx[in]  the data structure of Md5\r
-\r
-  @retval EFI_SUCCESS initialization is ok\r
+  @param[out]  Md5Ctx The data structure of Md5.\r
 \r
+  @retval EFI_SUCCESS Initialization is ok.\r
 **/\r
 EFI_STATUS\r
 MD5Init (\r
-  IN MD5_CTX  *Md5Ctx\r
-  )\r
-;\r
+  OUT MD5_CTX  *Md5Ctx\r
+  );\r
 \r
 /**\r
   the external interface of Md5 algorithm\r
 \r
-  @param  Md5Ctx[in]  the data structure of storing the original data\r
-                      segment and the final result.\r
-\r
-  @param  Data[in]    the data wanted to be transformed.\r
-\r
-  @param  DataLen[in] the length of data.\r
-\r
-  @retval EFI_SUCCESS the transform is ok.\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
+  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  Md5Ctx[in]   the data structure of storing the original data\r
-                       segment and the final result.\r
-\r
-  @param  HashVal[out] the final 128-bits output.\r
+  Accumulate the MD5 value of every data segment and generate the finial\r
+  result according to MD5 algorithm.\r
 \r
-  @retval EFI_SUCCESS  the transform is ok.\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
+  IN  OUT MD5_CTX  *Md5Ctx,\r
+  OUT UINT8        *HashVal\r
+  );\r
 \r
-#endif // _MD5_H\r
+#endif \r