Fix the IN OUT modifier for parameters.

[mirror_edk2.git] / MdeModulePkg / Universal / Network / Tcp4Dxe / SockImpl.c

diff --git a/MdeModulePkg/Universal/Network/Tcp4Dxe/SockImpl.c b/MdeModulePkg/Universal/Network/Tcp4Dxe/SockImpl.c
index 1e27bfbf97ce9800faada45497a816072000e313..b8a8258bedeb2711ba19f9824da32562d3670e72 100644 (file)
--- a/MdeModulePkg/Universal/Network/Tcp4Dxe/SockImpl.c
+++ b/MdeModulePkg/Universal/Network/Tcp4Dxe/SockImpl.c
@@ -41,7 +41,7 @@ SockTcpDataToRcv (
 **/\r
 VOID\r
 SockProcessSndToken (\r
-  IN SOCKET *Sock\r
+  IN OUT SOCKET *Sock\r
   );\r
 \r
 /**\r
@@ -148,7 +148,7 @@ SockTcpDataToRcv (
   @param  Sock                  Pointer to the socket.\r
   @param  TcpRxData             Pointer to the application provided receive buffer.\r
   @param  RcvdBytes             The maximum length of the data can be copied.\r
-  @param  IsOOB                 If TURE the data is OOB, else the data is normal.\r
+  @param  IsOOB                 If TURE the data is OOB, FALSE the data is normal.\r
 \r
 **/\r
 VOID\r
@@ -204,8 +204,8 @@ SockSetTcpRxData (
 **/\r
 UINT32\r
 SockProcessRcvToken (\r
-  IN SOCKET        *Sock,\r
-  IN SOCK_IO_TOKEN *RcvToken\r
+  IN     SOCKET        *Sock,\r
+  IN OUT SOCK_IO_TOKEN *RcvToken\r
   )\r
 {\r
   UINT32                 TokenRcvdBytes;\r
@@ -242,7 +242,7 @@ SockProcessRcvToken (
   the buffer to socket send buffer,then try to send it.\r
 \r
   @param  Sock                  Pointer to the socket.\r
-  @param  TcpTxData             Pointer to the tcp txdata.\r
+  @param  TcpTxData             Pointer to the application provided send buffer.\r
 \r
   @retval EFI_SUCCESS           The operation is completed successfully.\r
   @retval EFI_OUT_OF_RESOURCES  Failed due to resource limit.\r
@@ -358,7 +358,7 @@ SockFlushPendingToken (
 **/\r
 VOID\r
 SockWakeConnToken (\r
-  IN SOCKET *Sock\r
+  IN OUT SOCKET *Sock\r
   )\r
 {\r
   ASSERT (Sock->ConnectionToken != NULL);\r
@@ -382,7 +382,7 @@ SockWakeConnToken (
 **/\r
 VOID\r
 SockWakeListenToken (\r
-  IN SOCKET *Sock\r
+  IN OUT SOCKET *Sock\r
   )\r
 {\r
   SOCKET                *Parent;\r
@@ -470,7 +470,7 @@ SockWakeRcvToken (
 **/\r
 VOID\r
 SockProcessSndToken (\r
-  IN SOCKET *Sock\r
+  IN OUT SOCKET *Sock\r
   )\r
 {\r
   UINT32                  FreeSpace;\r
@@ -712,7 +712,7 @@ OnError:
 **/\r
 VOID\r
 SockDestroy (\r
-  IN SOCKET *Sock\r
+  IN OUT SOCKET *Sock\r
   )\r
 {\r
   VOID        *SockProtocol;\r
@@ -804,14 +804,14 @@ FreeSock:
 \r
 \r
 /**\r
-  Flush the socket.\r
+  Flush the sndBuffer and rcvBuffer of socket.\r
 \r
   @param  Sock                  Pointer to the socket.\r
 \r
 **/\r
 VOID\r
 SockConnFlush (\r
-  IN SOCKET *Sock\r
+  IN OUT SOCKET *Sock\r
   )\r
 {\r
   SOCKET  *Child;\r
@@ -877,8 +877,8 @@ SockConnFlush (
 **/\r
 VOID\r
 SockSetState (\r
-  IN SOCKET     *Sock,\r
-  IN SOCK_STATE State\r
+  IN OUT SOCKET     *Sock,\r
+  IN     SOCK_STATE State\r
   )\r
 {\r
   Sock->State = State;\r
@@ -972,7 +972,7 @@ SockConnEstablished (
 **/\r
 VOID\r
 SockConnClosed (\r
-  IN SOCKET *Sock\r
+  IN OUT SOCKET *Sock\r
   )\r
 {\r
   if (Sock->CloseToken != NULL) {\r
@@ -1094,9 +1094,9 @@ SockGetDataToSend (
 **/\r
 VOID\r
 SockDataRcvd (\r
-  IN SOCKET    *Sock,\r
-  IN NET_BUF   *NetBuffer,\r
-  IN UINT32    UrgLen\r
+  IN     SOCKET    *Sock,\r
+  IN OUT NET_BUF   *NetBuffer,\r
+  IN     UINT32    UrgLen\r
   )\r
 {\r
   ASSERT ((Sock != NULL) && (Sock->RcvBuffer.DataQueue != NULL) &&\r
@@ -1161,8 +1161,8 @@ SockGetFreeSpace (
 **/\r
 VOID\r
 SockRcvdErr (\r
-  IN SOCKET       *Sock,\r
-  IN EFI_STATUS   Error\r
+  IN OUT SOCKET       *Sock,\r
+  IN     EFI_STATUS   Error\r
   )\r
 {\r
   SOCK_TOKEN  *SockToken;\r
@@ -1199,7 +1199,7 @@ SockRcvdErr (
 **/\r
 VOID\r
 SockNoMoreData (\r
-  IN SOCKET *Sock\r
+  IN OUT SOCKET *Sock\r
   )\r
 {\r
   EFI_STATUS  Err;\r