[Change summary]:

[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..dad64ae447d251ead855d39de0e3b9efcba91aed 100644 (file)
--- a/MdeModulePkg/Universal/Network/Tcp4Dxe/SockImpl.c
+++ b/MdeModulePkg/Universal/Network/Tcp4Dxe/SockImpl.c
@@ -1,6 +1,7 @@
 /** @file\r
+  Implementation of the Socket.\r
 \r
-Copyright (c) 2005 - 2006, Intel Corporation<BR>\r
+Copyright (c) 2005 - 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
@@ -41,7 +42,7 @@ SockTcpDataToRcv (
 **/\r
 VOID\r
 SockProcessSndToken (\r
-  IN SOCKET *Sock\r
+  IN OUT SOCKET *Sock\r
   );\r
 \r
 /**\r
@@ -148,7 +149,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 +205,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
@@ -214,7 +215,7 @@ SockProcessRcvToken (
 \r
   ASSERT (Sock != NULL);\r
 \r
-  ASSERT (SOCK_STREAM == Sock->Type);\r
+  ASSERT (SockStream == Sock->Type);\r
 \r
   RxData = RcvToken->Packet.RxData;\r
 \r
@@ -242,7 +243,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 +359,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 +383,7 @@ SockWakeConnToken (
 **/\r
 VOID\r
 SockWakeListenToken (\r
-  IN SOCKET *Sock\r
+  IN OUT SOCKET *Sock\r
   )\r
 {\r
   SOCKET                *Parent;\r
@@ -470,7 +471,7 @@ SockWakeRcvToken (
 **/\r
 VOID\r
 SockProcessSndToken (\r
-  IN SOCKET *Sock\r
+  IN OUT SOCKET *Sock\r
   )\r
 {\r
   UINT32                  FreeSpace;\r
@@ -480,7 +481,7 @@ SockProcessSndToken (
   EFI_TCP4_TRANSMIT_DATA  *TxData;\r
   EFI_STATUS              Status;\r
 \r
-  ASSERT ((Sock != NULL) && (SOCK_STREAM == Sock->Type));\r
+  ASSERT ((Sock != NULL) && (SockStream == Sock->Type));\r
 \r
   FreeSpace = SockGetFreeSpace (Sock, SOCK_SND_BUF);\r
 \r
@@ -556,7 +557,7 @@ SockCreate (
   EFI_STATUS  Status;\r
 \r
   ASSERT ((SockInitData != NULL) && (SockInitData->ProtoHandler != NULL));\r
-  ASSERT (SockInitData->Type == SOCK_STREAM);\r
+  ASSERT (SockInitData->Type == SockStream);\r
   ASSERT ((SockInitData->ProtoData != NULL) && (SockInitData->DataSize <= PROTO_RESERVED_LEN));\r
 \r
   Parent = SockInitData->Parent;\r
@@ -712,14 +713,14 @@ OnError:
 **/\r
 VOID\r
 SockDestroy (\r
-  IN SOCKET *Sock\r
+  IN OUT SOCKET *Sock\r
   )\r
 {\r
   VOID        *SockProtocol;\r
   EFI_GUID    *ProtocolGuid;\r
   EFI_STATUS  Status;\r
 \r
-  ASSERT (SOCK_STREAM == Sock->Type);\r
+  ASSERT (SockStream == Sock->Type);\r
 \r
   if (Sock->DestroyCallback != NULL) {\r
     Sock->DestroyCallback (Sock, Sock->Context);\r
@@ -804,14 +805,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
@@ -872,13 +873,13 @@ SockConnFlush (
   Set the state of the socket.\r
 \r
   @param  Sock                  Pointer to the socket.\r
-  @param  State                 The new state to be set.\r
+  @param  State                 The new socket state to be set.\r
 \r
 **/\r
 VOID\r
 SockSetState (\r
-  IN SOCKET     *Sock,\r
-  IN SOCK_STATE State\r
+  IN OUT SOCKET     *Sock,\r
+  IN     UINT8      State\r
   )\r
 {\r
   Sock->State = State;\r
@@ -972,7 +973,7 @@ SockConnEstablished (
 **/\r
 VOID\r
 SockConnClosed (\r
-  IN SOCKET *Sock\r
+  IN OUT SOCKET *Sock\r
   )\r
 {\r
   if (Sock->CloseToken != NULL) {\r
@@ -1069,7 +1070,7 @@ SockGetDataToSend (
   IN UINT8       *Dest\r
   )\r
 {\r
-  ASSERT ((Sock != NULL) && SOCK_STREAM == Sock->Type);\r
+  ASSERT ((Sock != NULL) && SockStream == Sock->Type);\r
 \r
   return NetbufQueCopy (\r
           Sock->SndBuffer.DataQueue,\r
@@ -1094,9 +1095,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 +1162,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 +1200,7 @@ SockRcvdErr (
 **/\r
 VOID\r
 SockNoMoreData (\r
-  IN SOCKET *Sock\r
+  IN OUT SOCKET *Sock\r
   )\r
 {\r
   EFI_STATUS  Err;\r