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 655ccfe8c3b42ca3d4cf6b9a42ceb9698a2ff818..9e0f1e0f02c2c65754d4fe70c0e2d6f3c9f2239b 100644 (file)
--- a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiTcp4Io.h
+++ b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiTcp4Io.h
@@ -1,7 +1,8 @@
-/*++\r
+/** @file\r
+  iSCSI Tcp4 IO related definitions.\r
 \r
-Copyright (c) 2004 - 2007, Intel Corporation\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
@@ -9,21 +10,13 @@ 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
-  IScsiTcp4Io.h\r
-\r
-Abstract:\r
-\r
-  iSCSI Tcp4 IO related definitions.\r
-\r
---*/\r
+**/\r
 \r
 #ifndef _ISCSI_TCP4_IO_H_\r
 #define _ISCSI_TCP4_IO_H_\r
 \r
 #include <Library/NetLib.h>\r
-#include <protocol/Tcp4.h>\r
+#include <Protocol/Tcp4.h>\r
 \r
 typedef struct _TCP4_IO_CONFIG_DATA {\r
   EFI_IPv4_ADDRESS  LocalIp;\r
@@ -52,6 +45,17 @@ typedef struct _TCP4_IO {
   BOOLEAN                   IsCloseDone;\r
 } TCP4_IO;\r
 \r
+/**\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
+  @retval EFI_SUCCESS    The TCP socket is created and configured.\r
+  @retval Others         Failed to create the TCP socket or configure it.\r
+**/\r
 EFI_STATUS\r
 Tcp4IoCreateSocket (\r
   IN EFI_HANDLE           Image,\r
@@ -60,28 +64,73 @@ Tcp4IoCreateSocket (
   IN TCP4_IO              *Tcp4Io\r
   );\r
 \r
+/**\r
+  Destroy the socket.\r
+\r
+  @param[in]  Tcp4Io The Tcp4Io which wraps the socket to be destroyeds.\r
+**/\r
 VOID\r
 Tcp4IoDestroySocket (\r
   IN TCP4_IO  *Tcp4Io\r
   );\r
 \r
+/**\r
+  Connect to the other endpoint of the TCP socket.\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               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, 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
+  Transmit the Packet to the other endpoint of the socket.\r
+\r
+  @param[in]   Tcp4Io          The Tcp4Io wrapping the TCP socket.\r
+  @param[in]   Packet          The packet to transmit.\r
+\r
+  @retval EFI_SUCCESS          The packet is trasmitted.\r
+  @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
+  @retval Others               Other errors as indicated.\r
+**/\r
 EFI_STATUS\r
 Tcp4IoTransmit (\r
   IN TCP4_IO  *Tcp4Io,\r
   IN NET_BUF  *Packet\r
   );\r
 \r
+/**\r
+  Receive data from the socket.\r
+\r
+  @param[in]  Tcp4Io           The Tcp4Io which wraps the socket to be destroyed.\r
+  @param[in]  Packet           The buffer to hold the data copy from the soket rx buffer.\r
+  @param[in]  AsyncMode        Is this receive asyncronous or not.\r
+  @param[in]  Timeout          The time to wait for receiving the amount of data the Packet\r
+                               can hold.\r
+\r
+  @retval EFI_SUCCESS          The required amount of data is received from the socket.\r
+  @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               Other errors as indicated.\r
+**/\r
 EFI_STATUS\r
 Tcp4IoReceive (\r
   IN TCP4_IO    *Tcp4Io,\r