Add comments for functions and fix some coding style issue.

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

diff --git a/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Driver.c b/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Driver.c
index cfdfbe68f29151ab28527b687262a8d6a68b6601..c51962ba9ebaf172f671403139f10a0d05131ee2 100644 (file)
--- a/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Driver.c
+++ b/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Driver.c
@@ -21,7 +21,7 @@ Abstract:
 #include "Tcp4Main.h"\r
 \r
 \r
-UINT16                               mTcp4RandomPort;\r
+UINT16                                mTcp4RandomPort;\r
 extern EFI_COMPONENT_NAME_PROTOCOL    gTcp4ComponentName;\r
 extern EFI_COMPONENT_NAME2_PROTOCOL   gTcp4ComponentName2;\r
 \r
@@ -78,8 +78,6 @@ EFI_SERVICE_BINDING_PROTOCOL mTcp4ServiceBinding = {
 /**\r
   Create and start the heartbeat timer for TCP driver.\r
 \r
-  None.\r
-\r
   @retval EFI_SUCCESS            The timer is successfully created and started.\r
   @retval other                  The timer is not created.\r
 \r
@@ -124,13 +122,11 @@ Tcp4CreateTimer (
 /**\r
   Stop and destroy the heartbeat timer for TCP driver.\r
   \r
-  None\r
-  \r
-  None\r
-\r
 **/\r
 VOID\r
-Tcp4DestroyTimer ()\r
+Tcp4DestroyTimer (\r
+  VOID\r
+  )\r
 {\r
   ASSERT (mTcp4Timer.RefCnt > 0);\r
 \r
@@ -146,8 +142,7 @@ Tcp4DestroyTimer ()
 }\r
 \r
 /**\r
-  The entry point for Tcp4 driver. \r
-  Used to install Tcp4 driver on the ImageHandle.\r
+  The entry point for Tcp4 driver, used to install Tcp4 driver on the ImageHandle.\r
 \r
   @param  ImageHandle   The firmware allocated handle for this\r
                         driver image.\r
@@ -184,7 +179,7 @@ Tcp4DriverEntryPoint (
   //\r
   Seed            = NetRandomInitSeed ();\r
   mTcpGlobalIss   = NET_RANDOM (Seed) % mTcpGlobalIss;\r
-  mTcp4RandomPort = (UINT16) ( TCP4_PORT_KNOWN +\r
+  mTcp4RandomPort = (UINT16) (TCP4_PORT_KNOWN +\r
                     (UINT16) (NET_RANDOM(Seed) % TCP4_PORT_KNOWN));\r
 \r
   return Status;\r
@@ -207,9 +202,9 @@ Tcp4DriverEntryPoint (
 EFI_STATUS\r
 EFIAPI\r
 Tcp4DriverBindingSupported (\r
-  IN EFI_DRIVER_BINDING_PROTOCOL  * This,\r
+  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
   IN EFI_HANDLE                   ControllerHandle,\r
-  IN EFI_DEVICE_PATH_PROTOCOL     * RemainingDevicePath OPTIONAL\r
+  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL\r
   )\r
 {\r
   EFI_STATUS  Status;\r
@@ -262,9 +257,9 @@ Tcp4DriverBindingSupported (
 EFI_STATUS\r
 EFIAPI\r
 Tcp4DriverBindingStart (\r
-  IN EFI_DRIVER_BINDING_PROTOCOL  * This,\r
+  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
   IN EFI_HANDLE                   ControllerHandle,\r
-  IN EFI_DEVICE_PATH_PROTOCOL     * RemainingDevicePath OPTIONAL\r
+  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL\r
   )\r
 {\r
   EFI_STATUS               Status;\r
@@ -464,6 +459,17 @@ Tcp4DriverBindingStop (
   return Status;\r
 }\r
 \r
+/**\r
+  Open Ip4 and device path protocols for a created socket, and insert it in \r
+  socket list.\r
+  \r
+  @param  This                Pointer to the socket just created\r
+  @param  Context             Context of the socket\r
+  \r
+  @retval EFI_SUCCESS         This protocol is installed successfully.\r
+  @retval other               Some error occured.\r
+  \r
+**/\r
 EFI_STATUS\r
 Tcp4CreateSocketCallback (\r
   IN SOCKET  *This,\r
@@ -519,6 +525,13 @@ Tcp4CreateSocketCallback (
   return Status;\r
 }\r
 \r
+/**\r
+  Close Ip4 and device path protocols for a socket, and remove it from socket list. \r
+    \r
+  @param  This                Pointer to the socket to be removed\r
+  @param  Context             Context of the socket\r
+  \r
+**/\r
 VOID\r
 Tcp4DestroySocketCallback (\r
   IN SOCKET  *This,\r