Add a UNION definition (IP_IO_IP_PROTOOCL) for EFI_IP4/6_PROTOCOL and change IP_IO...

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

diff --git a/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Misc.c b/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Misc.c
index 6d7117a164e586c146ca32d454ca61837fa45b2f..afcaba4ed6829a9bf9aca82cb863ed7874dfa822 100644 (file)
--- a/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Misc.c
+++ b/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Misc.c
@@ -1,23 +1,15 @@
 /** @file\r
+  Misc support routines for tcp.\r
 \r
-Copyright (c) 2005 - 2006, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2005 - 2010, 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
+http://opensource.org/licenses/bsd-license.php<BR>\r
 \r
 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
-  Tcp4Misc.c\r
-\r
-Abstract:\r
-\r
-  Misc support routines for tcp.\r
-\r
-\r
 **/\r
 \r
 \r
@@ -60,7 +52,7 @@ CHAR16   *mTcpStateName[] = {
 **/\r
 VOID\r
 TcpInitTcbLocal (\r
-  IN TCP_CB *Tcb\r
+  IN OUT TCP_CB *Tcb\r
   )\r
 {\r
   //\r
@@ -100,14 +92,14 @@ TcpInitTcbLocal (
 **/\r
 VOID\r
 TcpInitTcbPeer (\r
-  IN TCP_CB     *Tcb,\r
-  IN TCP_SEG    *Seg,\r
-  IN TCP_OPTION *Opt\r
+  IN OUT TCP_CB     *Tcb,\r
+  IN     TCP_SEG    *Seg,\r
+  IN     TCP_OPTION *Opt\r
   )\r
 {\r
   UINT16  RcvMss;\r
 \r
-  ASSERT (Tcb && Seg && Opt);\r
+  ASSERT ((Tcb != NULL) && (Seg != NULL) && (Opt != NULL));\r
   ASSERT (TCP_FLG_ON (Seg->Flag, TCP_FLG_SYN));\r
 \r
   Tcb->SndWnd     = Seg->Wnd;\r
@@ -179,7 +171,7 @@ TcpInitTcbPeer (
   @param  Local                 Pointer to the local (IP, Port).\r
   @param  Remote                Pointer to the remote (IP, Port).\r
 \r
-  @return  Pointer to the TCP_CB with the least number of wildcard, \r
+  @return  Pointer to the TCP_CB with the least number of wildcard,\r
            if NULL no match is found.\r
 \r
 **/\r
@@ -405,7 +397,7 @@ TcpInsertTcb (
 \r
 \r
 /**\r
-  Clone a TCP_CB from Tcb.\r
+  Clone a TCB_CB from Tcb.\r
 \r
   @param  Tcb                   Pointer to the TCP_CB to be cloned.\r
 \r
@@ -440,7 +432,7 @@ TcpCloneTcb (
   Clone->Sk = SockClone (Tcb->Sk);\r
   if (Clone->Sk == NULL) {\r
     DEBUG ((EFI_D_ERROR, "TcpCloneTcb: failed to clone a sock\n"));\r
-    gBS->FreePool (Clone);\r
+    FreePool (Clone);\r
     return NULL;\r
   }\r
 \r
@@ -479,19 +471,19 @@ TcpGetRcvMss (
   IN SOCKET  *Sock\r
   )\r
 {\r
-  EFI_SIMPLE_NETWORK_MODE SnpMode;\r
+  EFI_IP4_MODE_DATA       Ip4Mode;\r
   TCP4_PROTO_DATA         *TcpProto;\r
   EFI_IP4_PROTOCOL        *Ip;\r
 \r
   ASSERT (Sock != NULL);\r
 \r
   TcpProto = (TCP4_PROTO_DATA *) Sock->ProtoReserved;\r
-  Ip       = TcpProto->TcpService->IpIo->Ip;\r
+  Ip       = TcpProto->TcpService->IpIo->Ip.Ip4;\r
   ASSERT (Ip != NULL);\r
 \r
-  Ip->GetModeData (Ip, NULL, NULL, &SnpMode);\r
+  Ip->GetModeData (Ip, &Ip4Mode, NULL, NULL);\r
 \r
-  return (UINT16) (SnpMode.MaxPacketSize - 40);\r
+  return (UINT16) (Ip4Mode.MaxPacketSize - sizeof (TCP_HEAD));\r
 }\r
 \r
 \r
@@ -504,10 +496,13 @@ TcpGetRcvMss (
 **/\r
 VOID\r
 TcpSetState (\r
-  IN TCP_CB *Tcb,\r
-  IN UINT8  State\r
+  IN OUT TCP_CB  *Tcb,\r
+  IN     UINT8   State\r
   )\r
 {\r
+  ASSERT (Tcb->State < (sizeof (mTcpStateName) / sizeof (CHAR16 *)));\r
+  ASSERT (State < (sizeof (mTcpStateName) / sizeof (CHAR16 *)));\r
+\r
   DEBUG (\r
     (EFI_D_INFO,\r
     "Tcb (%p) state %s --> %s\n",\r
@@ -537,6 +532,8 @@ TcpSetState (
 \r
     SockConnClosed (Tcb->Sk);\r
 \r
+    break;\r
+  default:\r
     break;\r
   }\r
 }\r
@@ -572,7 +569,6 @@ TcpChecksum (
   return (UINT16) ~Checksum;\r
 }\r
 \r
-\r
 /**\r
   Translate the information from the head of the received TCP\r
   segment Nbuf contains and fill it into a TCP_SEG structure.\r
@@ -585,8 +581,8 @@ TcpChecksum (
 **/\r
 TCP_SEG *\r
 TcpFormatNetbuf (\r
-  IN TCP_CB  *Tcb,\r
-  IN NET_BUF *Nbuf\r
+  IN     TCP_CB  *Tcb,\r
+  IN OUT NET_BUF *Nbuf\r
   )\r
 {\r
   TCP_SEG   *Seg;\r
@@ -681,7 +677,7 @@ TcpResetConnection (
 **/\r
 VOID\r
 TcpOnAppConnect (\r
-  IN TCP_CB  *Tcb\r
+  IN OUT TCP_CB  *Tcb\r
   )\r
 {\r
   TcpInitTcbLocal (Tcb);\r
@@ -701,7 +697,7 @@ TcpOnAppConnect (
 **/\r
 VOID\r
 TcpOnAppClose (\r
-  IN TCP_CB *Tcb\r
+  IN OUT TCP_CB *Tcb\r
   )\r
 {\r
   ASSERT (Tcb != NULL);\r
@@ -731,6 +727,8 @@ TcpOnAppClose (
   case TCP_CLOSE_WAIT:\r
     TcpSetState (Tcb, TCP_LAST_ACK);\r
     break;\r
+  default:\r
+    break;\r
   }\r
 \r
   TcpToSendData (Tcb, 1);\r
@@ -750,29 +748,25 @@ TcpOnAppClose (
 **/\r
 INTN\r
 TcpOnAppSend (\r
-  IN TCP_CB *Tcb\r
+  IN OUT TCP_CB *Tcb\r
   )\r
 {\r
 \r
   switch (Tcb->State) {\r
   case TCP_CLOSED:\r
     return -1;\r
-    break;\r
 \r
   case TCP_LISTEN:\r
     return -1;\r
-    break;\r
 \r
   case TCP_SYN_SENT:\r
   case TCP_SYN_RCVD:\r
     return 0;\r
-    break;\r
 \r
   case TCP_ESTABLISHED:\r
   case TCP_CLOSE_WAIT:\r
     TcpToSendData (Tcb, 0);\r
     return 0;\r
-    break;\r
 \r
   case TCP_FIN_WAIT_1:\r
   case TCP_FIN_WAIT_2:\r
@@ -780,6 +774,8 @@ TcpOnAppSend (
   case TCP_LAST_ACK:\r
   case TCP_TIME_WAIT:\r
     return -1;\r
+\r
+  default:\r
     break;\r
   }\r
 \r
@@ -794,7 +790,7 @@ TcpOnAppSend (
   @param  Tcb                   Pointer to the TCP_CB of this TCP instance.\r
 \r
 **/\r
-INTN\r
+VOID\r
 TcpOnAppConsume (\r
   IN TCP_CB *Tcb\r
   )\r
@@ -803,17 +799,14 @@ TcpOnAppConsume (
 \r
   switch (Tcb->State) {\r
   case TCP_CLOSED:\r
-    return -1;\r
-    break;\r
+    return;\r
 \r
   case TCP_LISTEN:\r
-    return -1;\r
-    break;\r
+    return;\r
 \r
   case TCP_SYN_SENT:\r
   case TCP_SYN_RCVD:\r
-    return 0;\r
-    break;\r
+    return;\r
 \r
   case TCP_ESTABLISHED:\r
     TcpOld = TcpRcvWinOld (Tcb);\r
@@ -822,13 +815,13 @@ TcpOnAppConsume (
       if (TcpOld < Tcb->RcvMss) {\r
 \r
         DEBUG ((EFI_D_INFO, "TcpOnAppConsume: send a window"\r
-          " update for a window closed Tcb(%p)\n", Tcb));\r
+          " update for a window closed Tcb %p\n", Tcb));\r
 \r
         TcpSendAck (Tcb);\r
       } else if (Tcb->DelayedAck == 0) {\r
 \r
         DEBUG ((EFI_D_INFO, "TcpOnAppConsume: scheduled a delayed"\r
-          " ACK to update window for Tcb(%p)\n", Tcb));\r
+          " ACK to update window for Tcb %p\n", Tcb));\r
 \r
         Tcb->DelayedAck = 1;\r
       }\r
@@ -837,19 +830,18 @@ TcpOnAppConsume (
     break;\r
 \r
   case TCP_CLOSE_WAIT:\r
-    return 0;\r
-    break;\r
+    return;\r
 \r
   case TCP_FIN_WAIT_1:\r
   case TCP_FIN_WAIT_2:\r
   case TCP_CLOSING:\r
   case TCP_LAST_ACK:\r
   case TCP_TIME_WAIT:\r
-    return -1;\r
+    return;\r
+\r
+  default:\r
     break;\r
   }\r
-\r
-  return -1;\r
 }\r
 \r
 \r
@@ -876,6 +868,8 @@ TcpOnAppAbort (
   case TCP_CLOSE_WAIT:\r
     TcpResetConnection (Tcb);\r
     break;\r
+  default:\r
+    break;\r
   }\r
 \r
   TcpSetState (Tcb, TCP_CLOSED);\r
@@ -1034,7 +1028,7 @@ TcpSetVariableData (
              );\r
     }\r
 \r
-    gBS->FreePool (Tcp4Service->MacString);\r
+    FreePool (Tcp4Service->MacString);\r
   }\r
 \r
   Tcp4Service->MacString = NewMacString;\r
@@ -1049,7 +1043,7 @@ TcpSetVariableData (
 \r
 ON_ERROR:\r
 \r
-  gBS->FreePool (Tcp4VariableData);\r
+  FreePool (Tcp4VariableData);\r
 \r
   return Status;\r
 }\r
@@ -1076,7 +1070,7 @@ TcpClearVariableData (
          NULL\r
          );\r
 \r
-  gBS->FreePool (Tcp4Service->MacString);\r
+  FreePool (Tcp4Service->MacString);\r
   Tcp4Service->MacString = NULL;\r
 }\r
 \r
@@ -1099,18 +1093,22 @@ TcpInstallDevicePath (
   TCP_CB             *Tcb;\r
   IPv4_DEVICE_PATH   Ip4DPathNode;\r
   EFI_STATUS         Status;\r
+  TCP_PORTNO         LocalPort;\r
+  TCP_PORTNO         RemotePort;\r
 \r
   TcpProto   = (TCP4_PROTO_DATA *) Sock->ProtoReserved;\r
   TcpService = TcpProto->TcpService;\r
   Tcb        = TcpProto->TcpPcb;\r
 \r
+  LocalPort = NTOHS (Tcb->LocalEnd.Port);\r
+  RemotePort = NTOHS (Tcb->RemoteEnd.Port);\r
   NetLibCreateIPv4DPathNode (\r
     &Ip4DPathNode,\r
     TcpService->ControllerHandle,\r
     Tcb->LocalEnd.Ip,\r
-    NTOHS (Tcb->LocalEnd.Port),\r
+    LocalPort,\r
     Tcb->RemoteEnd.Ip,\r
-    NTOHS (Tcb->RemoteEnd.Port),\r
+    RemotePort,\r
     EFI_IP_PROTO_TCP,\r
     Tcb->UseDefaultAddr\r
     );\r
@@ -1130,7 +1128,7 @@ TcpInstallDevicePath (
                   Sock->DevicePath\r
                   );\r
   if (EFI_ERROR (Status)) {\r
-    gBS->FreePool (Sock->DevicePath);\r
+    FreePool (Sock->DevicePath);\r
   }\r
 \r
   return Status;\r