[Change summary]:

[mirror_edk2.git] / MdeModulePkg / Universal / Network / UefiPxeBcDxe / PxeBcMtftp.h

diff --git a/MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcMtftp.h b/MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcMtftp.h
index 85598cb6ab12016a2d51409837ed7ac456ac29f7..4d795a239d179534acd2d7907853fb1f6e38090b 100644 (file)
--- a/MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcMtftp.h
+++ b/MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcMtftp.h
@@ -1,6 +1,7 @@
 /** @file\r
-\r
-Copyright (c) 2007, Intel Corporation\r
+  Mtftp routines for PxeBc.\r
+    \r
+Copyright (c) 2007 - 2009, 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,42 +10,32 @@ 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
-  PxeBcMtftp.h\r
-\r
-Abstract:\r
-\r
-  Mtftp routines for PxeBc\r
-\r
-\r
 **/\r
 \r
 #ifndef __EFI_PXEBC_MTFTP_H__\r
 #define __EFI_PXEBC_MTFTP_H__\r
 \r
-enum {\r
-  PXE_MTFTP_OPTION_BLKSIZE_INDEX,\r
-  PXE_MTFTP_OPTION_TIMEOUT_INDEX,\r
-  PXE_MTFTP_OPTION_TSIZE_INDEX,\r
-  PXE_MTFTP_OPTION_MULTICAST_INDEX,\r
-  PXE_MTFTP_OPTION_MAXIMUM_INDEX\r
-};\r
+#define PXE_MTFTP_OPTION_BLKSIZE_INDEX   0\r
+#define PXE_MTFTP_OPTION_TIMEOUT_INDEX   1\r
+#define PXE_MTFTP_OPTION_TSIZE_INDEX     2\r
+#define PXE_MTFTP_OPTION_MULTICAST_INDEX 3\r
+#define PXE_MTFTP_OPTION_MAXIMUM_INDEX   4\r
 \r
 \r
 /**\r
   This function is to get size of a file by Tftp.\r
-\r
+  \r
   @param  Private        Pointer to PxeBc private data\r
   @param  Config         Pointer to Mtftp configuration data\r
   @param  Filename       Pointer to file name\r
   @param  BlockSize      Pointer to block size\r
   @param  BufferSize     Pointer to buffer size\r
 \r
-  @return EFI_SUCCESS\r
-  @return EFI_NOT_FOUND\r
-  @return EFI_DEVICE_ERROR\r
-\r
+  @retval EFI_SUCCESS        Get the size of file success\r
+  @retval EFI_NOT_FOUND      Parse the tftp ptions failed.\r
+  @retval EFI_DEVICE_ERROR   The network device encountered an error during this operation.\r
+  @retval Other              Has not get the size of the file.\r
+  \r
 **/\r
 EFI_STATUS\r
 PxeBcTftpGetFileSize (\r
@@ -53,8 +44,7 @@ PxeBcTftpGetFileSize (
   IN UINT8                      *Filename,\r
   IN UINTN                      *BlockSize,\r
   IN OUT UINT64                 *BufferSize\r
-  )\r
-;\r
+  );\r
 \r
 \r
 /**\r
@@ -68,9 +58,10 @@ PxeBcTftpGetFileSize (
   @param  BufferSize     Pointer to buffer size\r
   @param  DontUseBuffer  Indicate whether with a receive buffer\r
 \r
-  @return EFI_SUCCESS\r
-  @return EFI_DEVICE_ERROR\r
-\r
+  @retval EFI_SUCCESS        Read the data success from the special file.\r
+  @retval EFI_DEVICE_ERROR   The network device encountered an error during this operation.\r
+  @retval other              Read data from file failed.\r
+  \r
 **/\r
 EFI_STATUS\r
 PxeBcTftpReadFile (\r
@@ -81,8 +72,7 @@ PxeBcTftpReadFile (
   IN UINT8                      *BufferPtr,\r
   IN OUT UINT64                 *BufferSize,\r
   IN BOOLEAN                    DontUseBuffer\r
-  )\r
-;\r
+  );\r
 \r
 \r
 /**\r
@@ -96,9 +86,10 @@ PxeBcTftpReadFile (
   @param  BufferPtr      Pointer to buffer\r
   @param  BufferSize     Pointer to buffer size\r
 \r
-  @return EFI_SUCCESS\r
-  @return EFI_DEVICE_ERROR\r
-\r
+  @retval EFI_SUCCESS        Write the data success into the special file.\r
+  @retval EFI_DEVICE_ERROR   The network device encountered an error during this operation.\r
+  @retval other              Write data into file failed.\r
+  \r
 **/\r
 EFI_STATUS\r
 PxeBcTftpWriteFile (\r
@@ -109,24 +100,24 @@ PxeBcTftpWriteFile (
   IN UINTN                      *BlockSize,\r
   IN UINT8                      *BufferPtr,\r
   IN OUT UINT64                 *BufferSize\r
-  )\r
-;\r
+  );\r
 \r
 \r
 /**\r
-  This function is to get data of a directory by Tftp.\r
-\r
-  @param  Private        Pointer to PxeBc private data\r
-  @param  Config         Pointer to Mtftp configuration data\r
-  @param  Filename       Pointer to file name\r
-  @param  BlockSize      Pointer to block size\r
-  @param  BufferPtr      Pointer to buffer\r
-  @param  BufferSize     Pointer to buffer size\r
-  @param  DontUseBuffer  Indicate whether with a receive buffer\r
-\r
-  @return EFI_SUCCES\r
-  @return EFI_DEVICE_ERROR\r
-\r
+  This function is to get data(file) from a directory(may be a server) by Tftp.\r
+\r
+  @param  Private        Pointer to PxeBc private data.\r
+  @param  Config         Pointer to Mtftp configuration data.\r
+  @param  Filename       Pointer to file name.\r
+  @param  BlockSize      Pointer to block size.\r
+  @param  BufferPtr      Pointer to buffer.\r
+  @param  BufferSize     Pointer to buffer size.\r
+  @param  DontUseBuffer  Indicate whether with a receive buffer.\r
+\r
+  @retval EFI_SUCCES         Get the data from the file included in directory success. \r
+  @retval EFI_DEVICE_ERROR   The network device encountered an error during this operation.\r
+  @retval other              Operation failed.\r
+  \r
 **/\r
 EFI_STATUS\r
 PxeBcTftpReadDirectory (\r
@@ -137,8 +128,7 @@ PxeBcTftpReadDirectory (
   IN UINT8                         *BufferPtr,\r
   IN OUT UINT64                    *BufferSize,\r
   IN BOOLEAN                       DontUseBuffer\r
-  )\r
-;\r
+  );\r
 \r
 #endif\r
 \r