Add comments for functions and fix some coding style issue.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6885 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 40 insertions, 39 deletions

diff --git a/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Timer.c b/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Timer.c
index 3c02c53912..65c98de048 100644
--- a/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Timer.c
+++ b/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Timer.c
@@ -24,31 +24,67 @@ Abstract:
 

 UINT32    mTcpTick = 1000;

 

+/**

+  Connect timeout handler.

+

+  @param  Tcb      Pointer to the TCP_CB of this TCP instance.

+

+**/

 VOID

 TcpConnectTimeout (

   IN TCP_CB *Tcb

   );

 

+/**

+  Timeout handler for TCP retransmission timer.

+

+  @param  Tcb      Pointer to the TCP_CB of this TCP instance.

+

+**/

 VOID

 TcpRexmitTimeout (

   IN TCP_CB *Tcb

   );

+  

+/**

+  Timeout handler for window probe timer.

 

+  @param  Tcb      Pointer to the TCP_CB of this TCP instance.

+

+**/

 VOID

 TcpProbeTimeout (

   IN TCP_CB *Tcb

   );

 

+/**

+  Timeout handler for keepalive timer.

+

+  @param  Tcb      Pointer to the TCP_CB of this TCP instance.

+

+**/

 VOID

 TcpKeepaliveTimeout (

   IN TCP_CB *Tcb

   );

 

+/**

+  Timeout handler for FIN_WAIT_2 timer.

+

+  @param  Tcb      Pointer to the TCP_CB of this TCP instance.

+

+**/

 VOID

 TcpFinwait2Timeout (

   IN TCP_CB *Tcb

   );

 

+/**

+  Timeout handler for 2MSL timer.

+

+  @param  Tcb      Pointer to the TCP_CB of this TCP instance.

+

+**/

 VOID

 Tcp2MSLTimeout (

   IN TCP_CB *Tcb

@@ -63,14 +99,11 @@ TCP_TIMER_HANDLER mTcpTimerHandler[TCP_TIMER_NUMBER] = {
   Tcp2MSLTimeout,

 };

 

-

 /**

   Close the TCP connection.

 

   @param  Tcb      Pointer to the TCP_CB of this TCP instance.

 

-  @return None.

-

 **/

 VOID

 TcpClose (

@@ -89,8 +122,6 @@ TcpClose (
 

   @param  Tcb      Pointer to the TCP_CB of this TCP instance.

 

-  @return None.

-

 **/

 VOID

 TcpConnectTimeout (

@@ -123,8 +154,6 @@ TcpConnectTimeout (
 

   @param  Tcb      Pointer to the TCP_CB of this TCP instance.

 

-  @return None.

-

 **/

 VOID

 TcpRexmitTimeout (

@@ -148,7 +177,7 @@ TcpRexmitTimeout (
   Tcb->LossRecover  = Tcb->SndNxt;

 

   Tcb->LossTimes++;

-  if (Tcb->LossTimes > Tcb->MaxRexmit &&

+  if ((Tcb->LossTimes > Tcb->MaxRexmit) &&

       !TCP_TIMER_ON (Tcb->EnabledTimer, TCP_TIMER_CONNECT)) {

 

     DEBUG ((EFI_D_ERROR, "TcpRexmitTimeout: connection closed "

@@ -167,7 +196,6 @@ TcpRexmitTimeout (
   TcpSetTimer (Tcb, TCP_TIMER_REXMIT, Tcb->Rto);

 

   Tcb->CongestState = TCP_CONGEST_LOSS;

-

   TCP_CLEAR_FLG (Tcb->CtrlFlag, TCP_CTRL_RTT_ON);

 }

 

@@ -177,8 +205,6 @@ TcpRexmitTimeout (
 

   @param  Tcb      Pointer to the TCP_CB of this TCP instance.

 

-  @return None.

-

 **/

 VOID

 TcpProbeTimeout (

@@ -207,8 +233,6 @@ TcpProbeTimeout (
 

   @param  Tcb      Pointer to the TCP_CB of this TCP instance.

 

-  @return None.

-

 **/

 VOID

 TcpKeepaliveTimeout (

@@ -240,8 +264,6 @@ TcpKeepaliveTimeout (
 

   @param  Tcb      Pointer to the TCP_CB of this TCP instance.

 

-  @return None.

-

 **/

 VOID

 TcpFinwait2Timeout (

@@ -260,8 +282,6 @@ TcpFinwait2Timeout (
 

   @param  Tcb      Pointer to the TCP_CB of this TCP instance.

 

-  @return None.

-

 **/

 VOID

 Tcp2MSLTimeout (

@@ -276,14 +296,11 @@ Tcp2MSLTimeout (
 

 

 /**

-  Update the timer status and the next expire time

-  according to the timers to expire in a specific

-  future time slot.

+  Update the timer status and the next expire time according to the timers 

+  to expire in a specific future time slot.

 

   @param  Tcb      Pointer to the TCP_CB of this TCP instance.

 

-  @return None.

-

 **/

 VOID

 TcpUpdateTimer (

@@ -318,8 +335,6 @@ TcpUpdateTimer (
   @param  Timer    The index of the timer to be enabled.

   @param  TimeOut  The timeout value of this timer.

 

-  @return None.

-

 **/

 VOID

 TcpSetTimer (

@@ -341,8 +356,6 @@ TcpSetTimer (
   @param  Tcb      Pointer to the TCP_CB of this TCP instance.

   @param  Timer    The index of the timer to be cleared.

 

-  @return None.

-

 **/

 VOID

 TcpClearTimer (

@@ -360,8 +373,6 @@ TcpClearTimer (
 

   @param  Tcb      Pointer to the TCP_CB of this TCP instance.

 

-  @return None.

-

 **/

 VOID

 TcpClearAllTimer (

@@ -378,8 +389,6 @@ TcpClearAllTimer (
 

   @param  Tcb      Pointer to the TCP_CB of this TCP instance.

 

-  @return None.

-

 **/

 VOID

 TcpSetProbeTimer (

@@ -410,8 +419,6 @@ TcpSetProbeTimer (
 

   @param  Tcb      Pointer to the TCP_CB of this TCP instance.

 

-  @return None.

-

 **/

 VOID

 TcpSetKeepaliveTimer (

@@ -448,8 +455,6 @@ TcpSetKeepaliveTimer (
 

   @param  Tcb      Pointer to the TCP_CB of this TCP instance.

 

-  @return None.

-

 **/

 VOID

 TcpBackoffRto (

@@ -481,9 +486,7 @@ TcpBackoffRto (
 /**

   Heart beat timer handler.

 

-  @param  Context  Context of the timer event, ignored.

-

-  @return None.

+  @param  Context        Context of the timer event, ignored.

 

 **/

 VOID

@@ -572,8 +575,6 @@ NextConnection:
   @param  Event    Timer event signaled, ignored.

   @param  Context  Context of the timer event, ignored.

 

-  @return None.

-

 **/

 VOID

 EFIAPI