1. Mark the network volatile variables as deprecated in code comments and remove...

[mirror_edk2.git] / MdeModulePkg / Universal / Network / Tcp4Dxe / Tcp4Func.h

diff --git a/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Func.h b/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Func.h
index b0edceaab9ac79d3e52b359b107caab17e1f149f..53b7aac8ae988f9072e97498c4aa5faaae071483 100644 (file)
--- a/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Func.h
+++ b/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Func.h
@@ -1,7 +1,8 @@
 /** @file\r
+  Tcp function header file.\r
 \r
-Copyright (c) 2005 - 2006, Intel Corporation<BR>\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2005 - 2014, 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<BR>\r
@@ -107,7 +108,7 @@ TcpGetIss (
 **/\r
 VOID\r
 TcpInitTcbLocal (\r
-  IN TCP_CB *Tcb\r
+  IN OUT TCP_CB *Tcb\r
   );\r
 \r
 /**\r
@@ -121,9 +122,9 @@ 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
 /**\r
@@ -148,8 +149,8 @@ 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
 //\r
@@ -187,8 +188,8 @@ TcpSendIpPacket (
 **/\r
 INTN\r
 TcpToSendData (\r
-  IN TCP_CB *Tcb,\r
-  IN INTN Force\r
+  IN OUT TCP_CB *Tcb,\r
+  IN     INTN Force\r
   );\r
 \r
 /**\r
@@ -199,7 +200,7 @@ TcpToSendData (
 **/\r
 VOID\r
 TcpToSendAck (\r
-  IN TCP_CB *Tcb\r
+  IN OUT TCP_CB *Tcb\r
   );\r
 \r
 /**\r
@@ -210,7 +211,7 @@ TcpToSendAck (
 **/\r
 VOID\r
 TcpSendAck (\r
-  IN TCP_CB *Tcb\r
+  IN OUT TCP_CB *Tcb\r
   );\r
 \r
 /**\r
@@ -224,7 +225,7 @@ TcpSendAck (
 **/\r
 INTN\r
 TcpSendZeroProbe (\r
-  IN TCP_CB *Tcb\r
+  IN OUT TCP_CB *Tcb\r
   );\r
 \r
 /**\r
@@ -240,7 +241,7 @@ TcpSendZeroProbe (
 **/\r
 INTN\r
 TcpDeliverData (\r
-  IN TCP_CB *Tcb\r
+  IN OUT TCP_CB *Tcb\r
   );\r
 \r
 /**\r
@@ -432,7 +433,7 @@ TcpGetMaxSndNxt (
 VOID\r
 TcpIcmpInput (\r
   IN NET_BUF     *Nbuf,\r
-  IN ICMP_ERROR  IcmpErr,\r
+  IN UINT8       IcmpErr,\r
   IN UINT32      Src,\r
   IN UINT32      Dst\r
   );\r
@@ -482,8 +483,8 @@ TcpSeqAcceptable (
 **/\r
 VOID\r
 TcpFastRecover (\r
-  IN TCP_CB  *Tcb,\r
-  IN TCP_SEG *Seg\r
+  IN OUT TCP_CB  *Tcb,\r
+  IN     TCP_SEG *Seg\r
   );\r
 \r
 /**\r
@@ -495,8 +496,8 @@ TcpFastRecover (
 **/\r
 VOID\r
 TcpFastLossRecover (\r
-  IN TCP_CB  *Tcb,\r
-  IN TCP_SEG *Seg\r
+  IN OUT TCP_CB  *Tcb,\r
+  IN     TCP_SEG *Seg\r
   );\r
 \r
 /**\r
@@ -508,8 +509,8 @@ TcpFastLossRecover (
 **/\r
 VOID\r
 TcpComputeRtt (\r
-  IN TCP_CB *Tcb,\r
-  IN UINT32 Measure\r
+  IN OUT TCP_CB *Tcb,\r
+  IN     UINT32 Measure\r
   );\r
 \r
 /**\r
@@ -534,8 +535,8 @@ TcpTrimInWnd (
 **/\r
 VOID\r
 TcpQueueData (\r
-  IN TCP_CB  *Tcb,\r
-  IN NET_BUF *Nbuf\r
+  IN OUT TCP_CB  *Tcb,\r
+  IN     NET_BUF *Nbuf\r
   );\r
 \r
 /**\r
@@ -583,8 +584,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
 /**\r
@@ -596,7 +597,7 @@ TcpFormatNetbuf (
 **/\r
 VOID\r
 TcpOnAppConnect (\r
-  IN TCP_CB  *Tcb\r
+  IN OUT TCP_CB  *Tcb\r
   );\r
 \r
 /**\r
@@ -620,7 +621,7 @@ TcpOnAppConsume (
 **/\r
 VOID\r
 TcpOnAppClose (\r
-  IN TCP_CB *Tcb\r
+  IN OUT TCP_CB *Tcb\r
   );\r
 \r
 /**\r
@@ -636,7 +637,7 @@ TcpOnAppClose (
 **/\r
 INTN\r
 TcpOnAppSend (\r
-  IN TCP_CB *Tcb\r
+  IN OUT TCP_CB *Tcb\r
   );\r
 \r
 /**\r
@@ -674,7 +675,7 @@ TcpResetConnection (
 **/\r
 VOID\r
 TcpClose (\r
-  IN TCP_CB *Tcb\r
+  IN OUT TCP_CB *Tcb\r
   );\r
 \r
 /**\r
@@ -701,9 +702,9 @@ TcpTicking (
 **/\r
 VOID\r
 TcpSetTimer (\r
-  IN TCP_CB *Tcb,\r
-  IN UINT16 Timer,\r
-  IN UINT32 TimeOut\r
+  IN OUT TCP_CB *Tcb,\r
+  IN     UINT16 Timer,\r
+  IN     UINT32 TimeOut\r
   );\r
 \r
 /**\r
@@ -715,8 +716,8 @@ TcpSetTimer (
 **/\r
 VOID\r
 TcpClearTimer (\r
-  IN TCP_CB *Tcb,\r
-  IN UINT16 Timer\r
+  IN OUT TCP_CB *Tcb,\r
+  IN     UINT16 Timer\r
   );\r
 \r
 /**\r
@@ -727,7 +728,7 @@ TcpClearTimer (
 **/\r
 VOID\r
 TcpClearAllTimer (\r
-  IN TCP_CB *Tcb\r
+  IN OUT TCP_CB *Tcb\r
   );\r
 \r
 /**\r
@@ -738,7 +739,7 @@ TcpClearAllTimer (
 **/\r
 VOID\r
 TcpSetProbeTimer (\r
-  IN TCP_CB *Tcb\r
+  IN OUT TCP_CB *Tcb\r
   );\r
 \r
 /**\r
@@ -749,7 +750,7 @@ TcpSetProbeTimer (
 **/\r
 VOID\r
 TcpSetKeepaliveTimer (\r
-  IN TCP_CB *Tcb\r
+  IN OUT TCP_CB *Tcb\r
   );\r
 \r
 /**\r
@@ -760,32 +761,7 @@ TcpSetKeepaliveTimer (
 **/\r
 VOID\r
 TcpBackoffRto (\r
-  IN TCP_CB *Tcb\r
-  );\r
-\r
-/**\r
-  Set the Tdp4 variable data.\r
-\r
-  @param  Tcp4Service           Pointer to Tcp4 service data.\r
-\r
-  @retval EFI_OUT_OF_RESOURCES  There are not enough resources to set the variable.\r
-  @retval other                 Set variable failed.\r
-\r
-**/\r
-EFI_STATUS\r
-TcpSetVariableData (\r
-  IN TCP4_SERVICE_DATA  *Tcp4Service\r
-  );\r
-\r
-/**\r
-  Clear the variable and free the resource.\r
-\r
-  @param  Tcp4Service           Pointer to Tcp4 service data.\r
-\r
-**/\r
-VOID\r
-TcpClearVariableData (\r
-  IN TCP4_SERVICE_DATA  *Tcp4Service\r
+  IN OUT TCP_CB *Tcb\r
   );\r
 \r
 /**\r