MdeModulePkg: Clean up source files

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

diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiTcp4Io.h b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiTcp4Io.h
index 86c2f86e0432e5a4e1ff45a1cf3131a825f4b8ba..9e0f1e0f02c2c65754d4fe70c0e2d6f3c9f2239b 100644 (file)
--- a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiTcp4Io.h
+++ b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiTcp4Io.h
@@ -1,8 +1,8 @@
 /** @file\r
-  IScsi Tcp4 IO related definitions.\r
+  iSCSI Tcp4 IO related definitions.\r
 \r
-Copyright (c) 2004 - 2008, Intel Corporation.<BR>\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2004 - 2018, 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
@@ -46,13 +46,13 @@ typedef struct _TCP4_IO {
 } TCP4_IO;\r
 \r
 /**\r
-  Create a TCP socket with the specified configuration data. \r
+  Create a TCP socket with the specified configuration data.\r
 \r
   @param[in]  Image      The handle of the driver image.\r
   @param[in]  Controller The handle of the controller.\r
   @param[in]  ConfigData The Tcp4 configuration data.\r
   @param[in]  Tcp4Io     The Tcp4Io.\r
-  \r
+\r
   @retval EFI_SUCCESS    The TCP socket is created and configured.\r
   @retval Others         Failed to create the TCP socket or configure it.\r
 **/\r
@@ -65,7 +65,7 @@ Tcp4IoCreateSocket (
   );\r
 \r
 /**\r
-  Destroy the socket. \r
+  Destroy the socket.\r
 \r
   @param[in]  Tcp4Io The Tcp4Io which wraps the socket to be destroyeds.\r
 **/\r
@@ -77,27 +77,27 @@ Tcp4IoDestroySocket (
 /**\r
   Connect to the other endpoint of the TCP socket.\r
 \r
-  @param[in]  Tcp4Io  The Tcp4Io wrapping the TCP socket.\r
-  @param[in]  Timeout The time to wait for connection done.\r
-  \r
+  @param[in, out]  Tcp4Io    The Tcp4Io wrapping the TCP socket.\r
+  @param[in]       Timeout   The time to wait for connection done.\r
+\r
   @retval EFI_SUCCESS          Connect to the other endpoint of the TCP socket successfully.\r
   @retval EFI_TIMEOUT          Failed to connect to the other endpoint of the TCP socket in the                               specified time period.\r
-  @retval Others               Some expected error happened.\r
+  @retval Others               Other errors as indicated.\r
 **/\r
 EFI_STATUS\r
 Tcp4IoConnect (\r
-  IN TCP4_IO    *Tcp4Io,\r
-  IN EFI_EVENT  Timeout\r
+  IN OUT TCP4_IO    *Tcp4Io,\r
+  IN EFI_EVENT      Timeout\r
   );\r
 \r
 /**\r
   Reset the socket.\r
 \r
-  @param[in]  Tcp4Io The Tcp4Io wrapping the TCP socket.\r
+  @param[in, out]  Tcp4Io The Tcp4Io wrapping the TCP socket.\r
 **/\r
 VOID\r
 Tcp4IoReset (\r
-  IN TCP4_IO  *Tcp4Io\r
+  IN OUT TCP4_IO  *Tcp4Io\r
   );\r
 \r
 /**\r
@@ -105,10 +105,10 @@ Tcp4IoReset (
 \r
   @param[in]   Tcp4Io          The Tcp4Io wrapping the TCP socket.\r
   @param[in]   Packet          The packet to transmit.\r
-  \r
+\r
   @retval EFI_SUCCESS          The packet is trasmitted.\r
   @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
-  @retval Others               Some expected error happened.\r
+  @retval Others               Other errors as indicated.\r
 **/\r
 EFI_STATUS\r
 Tcp4IoTransmit (\r
@@ -129,7 +129,7 @@ Tcp4IoTransmit (
   @retval EFI_OUT_OF_RESOURCES Failed to allocate momery.\r
   @retval EFI_TIMEOUT          Failed to receive the required amount of data in the\r
                                specified time period.\r
-  @retval Others               Some expected error happened.\r
+  @retval Others               Other errors as indicated.\r
 **/\r
 EFI_STATUS\r
 Tcp4IoReceive (\r