Add comments for functions and fix some coding style issue.

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

diff --git a/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Option.c b/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Option.c
index 95f5a8e44a754655d098607a23898f36f59339e8..35e858fb9a879ae7a61b94347832b439a9ce70a0 100644 (file)
--- a/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Option.c
+++ b/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Option.c
@@ -22,6 +22,14 @@ Abstract:
 \r
 #include "Tcp4Main.h"\r
 \r
+/**\r
+    Get a UINT16 value from buffer.\r
+    \r
+    @param Buf                  Pointer to input buffer.\r
+    \r
+    @return                     The UINT16 value get from buffer.\r
+\r
+**/\r
 UINT16\r
 TcpGetUint16 (\r
   IN UINT8 *Buf\r
@@ -32,17 +40,14 @@ TcpGetUint16 (
   return NTOHS (Value);\r
 }\r
 \r
-// STATIC\r
-// VOID\r
-// TcpPutUint16 (\r
-//   IN UINT8  *Buf,\r
-//   IN UINT16 Data\r
-//   )\r
-// {\r
-//   Data = HTONS (Data);\r
-//   CopyMem (Buf, &Data, sizeof (UINT16));\r
-// }\r
+/**\r
+    Get a UINT32 value from buffer.\r
+    \r
+    @param Buf                  Pointer to input buffer.\r
+    \r
+    @return                     The UINT32 value get from buffer.\r
 \r
+**/\r
 UINT32\r
 TcpGetUint32 (\r
   IN UINT8 *Buf\r
@@ -53,6 +58,13 @@ TcpGetUint32 (
   return NTOHL (Value);\r
 }\r
 \r
+/**\r
+    Put a UINT32 value in buffer.\r
+    \r
+    @param Buf                  Pointer to the buffer.\r
+    @param Data                 The UINT32 Date to put in buffer \r
+\r
+**/\r
 VOID\r
 TcpPutUint32 (\r
   IN UINT8  *Buf,\r
@@ -65,12 +77,11 @@ TcpPutUint32 (
 \r
 \r
 /**\r
-  Compute the window scale value according to the given\r
-  buffer size.\r
+  Compute the window scale value according to the given buffer size.\r
 \r
   @param  Tcb     Pointer to the TCP_CB of this TCP instance.\r
 \r
-  @retval UINT8   The scale value.\r
+  @return         The scale value.\r
 \r
 **/\r
 UINT8\r
@@ -81,7 +92,7 @@ TcpComputeScale (
   UINT8   Scale;\r
   UINT32  BufSize;\r
 \r
-  ASSERT (Tcb && Tcb->Sk);\r
+  ASSERT ((Tcb != NULL) && (Tcb->Sk != NULL));\r
 \r
   BufSize = GET_RCV_BUFFSIZE (Tcb->Sk);\r
 \r
@@ -102,7 +113,7 @@ TcpComputeScale (
   @param  Tcb     Pointer to the TCP_CB of this TCP instance.\r
   @param  Nbuf    Pointer to the buffer to store the options.\r
 \r
-  @return The total length of the TCP option field.\r
+  @return         The total length of the TCP option field.\r
 \r
 **/\r
 UINT16\r
@@ -114,7 +125,7 @@ TcpSynBuildOption (
   UINT8   *Data;\r
   UINT16  Len;\r
 \r
-  ASSERT (Tcb && Nbuf && !Nbuf->Tcp);\r
+  ASSERT ((Tcb != NULL) && (Nbuf != NULL) && (Nbuf->Tcp == NULL));\r
 \r
   Len = 0;\r
 \r
@@ -125,7 +136,7 @@ TcpSynBuildOption (
   //\r
   if (!TCP_FLG_ON (Tcb->CtrlFlag, TCP_CTRL_NO_TS) &&\r
       (!TCP_FLG_ON (TCPSEG_NETBUF (Nbuf)->Flag, TCP_FLG_ACK) ||\r
-      TCP_FLG_ON (Tcb->CtrlFlag, TCP_CTRL_RCVD_TS))) {\r
+        TCP_FLG_ON (Tcb->CtrlFlag, TCP_CTRL_RCVD_TS))) {\r
 \r
     Data = NetbufAllocSpace (\r
             Nbuf,\r
@@ -133,7 +144,7 @@ TcpSynBuildOption (
             NET_BUF_HEAD\r
             );\r
 \r
-    ASSERT (Data);\r
+    ASSERT (Data != NULL);\r
     Len += TCP_OPTION_TS_ALIGNED_LEN;\r
 \r
     TcpPutUint32 (Data, TCP_OPTION_TS_FAST);\r
@@ -148,7 +159,7 @@ TcpSynBuildOption (
   //\r
   if (!TCP_FLG_ON (Tcb->CtrlFlag, TCP_CTRL_NO_WS) &&\r
       (!TCP_FLG_ON (TCPSEG_NETBUF (Nbuf)->Flag, TCP_FLG_ACK) ||\r
-      TCP_FLG_ON (Tcb->CtrlFlag, TCP_CTRL_RCVD_WS))) {\r
+        TCP_FLG_ON (Tcb->CtrlFlag, TCP_CTRL_RCVD_WS))) {\r
 \r
     Data = NetbufAllocSpace (\r
             Nbuf,\r
@@ -156,7 +167,7 @@ TcpSynBuildOption (
             NET_BUF_HEAD\r
             );\r
 \r
-    ASSERT (Data);\r
+    ASSERT (Data != NULL);\r
 \r
     Len += TCP_OPTION_WS_ALIGNED_LEN;\r
     TcpPutUint32 (Data, TCP_OPTION_WS_FAST | TcpComputeScale (Tcb));\r
@@ -166,7 +177,7 @@ TcpSynBuildOption (
   // Build MSS option\r
   //\r
   Data = NetbufAllocSpace (Nbuf, TCP_OPTION_MSS_LEN, 1);\r
-  ASSERT (Data);\r
+  ASSERT (Data != NULL);\r
 \r
   Len += TCP_OPTION_MSS_LEN;\r
   TcpPutUint32 (Data, TCP_OPTION_MSS_FAST | Tcb->RcvMss);\r
@@ -181,7 +192,7 @@ TcpSynBuildOption (
   @param  Tcb     Pointer to the TCP_CB of this TCP instance.\r
   @param  Nbuf    Pointer to the buffer to store the options.\r
 \r
-  @return The total length of the TCP option field.\r
+  @return         The total length of the TCP option field.\r
 \r
 **/\r
 UINT16\r
@@ -193,7 +204,7 @@ TcpBuildOption (
   UINT8   *Data;\r
   UINT16  Len;\r
 \r
-  ASSERT (Tcb && Nbuf && !Nbuf->Tcp);\r
+  ASSERT ((Tcb != NULL) && (Nbuf != NULL) && (Nbuf->Tcp == NULL));\r
   Len = 0;\r
 \r
   //\r
@@ -208,7 +219,7 @@ TcpBuildOption (
             NET_BUF_HEAD\r
             );\r
 \r
-    ASSERT (Data);\r
+    ASSERT (Data != NULL);\r
     Len += TCP_OPTION_TS_ALIGNED_LEN;\r
 \r
     TcpPutUint32 (Data, TCP_OPTION_TS_FAST);\r
@@ -243,7 +254,7 @@ TcpParseOption (
   UINT8 Type;\r
   UINT8 Len;\r
 \r
-  ASSERT (Tcp && Option);\r
+  ASSERT ((Tcp != NULL) && (Option != NULL));\r
 \r
   Option->Flag  = 0;\r
 \r
@@ -333,7 +344,7 @@ TcpParseOption (
     default:\r
       Len = Head[Cur + 1];\r
 \r
-      if (TotalLen - Cur < Len || Len < 2) {\r
+      if ((TotalLen - Cur) < Len || Len < 2) {\r
         return -1;\r
       }\r
 \r