Scrubbed some files for IP4

[mirror_edk2.git] / MdeModulePkg / Universal / Network / Ip4Dxe / Ip4If.c

diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4If.c b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4If.c
index 083876a3875016c760a624a16d098ed3d032475d..dfd58406c2d302a0d3b343810e6c90c98a13557a 100644 (file)
--- a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4If.c
+++ b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4If.c
@@ -80,7 +80,7 @@ Ip4CancelFrameArp (
 /**\r
   Wrap a transmit request into a newly allocated IP4_LINK_TX_TOKEN.\r
 \r
-  @param  Interface             The interface to send out from\r
+  @param  Interface             The interface to send out to.\r
   @param  IpInstance            The IpInstance that transmit the packet.  NULL if\r
                                 the packet is sent by the IP4 driver itself.\r
   @param  Packet                The packet to transmit\r
@@ -511,9 +511,9 @@ Ip4CreateInterface (
 **/\r
 EFI_STATUS\r
 Ip4SetAddress (\r
-  IN  IP4_INTERFACE         *Interface,\r
-  IN  IP4_ADDR              IpAddr,\r
-  IN  IP4_ADDR              SubnetMask\r
+  IN OUT IP4_INTERFACE      *Interface,\r
+  IN     IP4_ADDR           IpAddr,\r
+  IN     IP4_ADDR           SubnetMask\r
   )\r
 {\r
   EFI_ARP_CONFIG_DATA       ArpConfig;\r
@@ -613,7 +613,7 @@ ON_ERROR:
 \r
 \r
 /**\r
-  Fileter function to cancel all the frame related to an IP instance.\r
+  Filter function to cancel all the frame related to an IP instance.\r
 \r
   @param  Frame                 The transmit request to test whether to cancel\r
   @param  Context               The context which is the Ip instance that issued\r
@@ -681,7 +681,7 @@ Ip4CancelReceive (
 \r
   @param  Interface             The interface used by the IpInstance\r
   @param  IpInstance            The Ip instance that free the interface. NULL if\r
-                                the  Ip driver is releasing the default interface.\r
+                                the Ip driver is releasing the default interface.\r
 \r
   @retval EFI_SUCCESS           The interface use IpInstance is freed.\r
 \r
@@ -815,28 +815,22 @@ Ip4OnArpResolvedDpc (
   Ip4FreeArpQue (ArpQue, EFI_SUCCESS);\r
 }\r
 \r
+/**\r
+  Request Ip4OnArpResolvedDpc as a DPC at TPL_CALLBACK.\r
+\r
+  @param  Event                 The Arp request event.\r
+  @param  Context               The context of the callback, a point to the ARP\r
+                                queue.\r
+\r
+  @return None\r
+\r
+**/\r
 VOID\r
 EFIAPI\r
 Ip4OnArpResolved (\r
   IN EFI_EVENT              Event,\r
   IN VOID                   *Context\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Request Ip4OnArpResolvedDpc as a DPC at TPL_CALLBACK\r
-\r
-Arguments:\r
-\r
-  Event   - The Arp request event\r
-  Context - The context of the callback, a point to the ARP queue\r
-\r
-Returns:\r
-\r
-  None\r
-\r
---*/\r
 {\r
   //\r
   // Request Ip4OnArpResolvedDpc as a DPC at TPL_CALLBACK\r
@@ -879,28 +873,21 @@ Ip4OnFrameSentDpc (
   Ip4FreeLinkTxToken (Token);\r
 }\r
 \r
+/**\r
+  Request Ip4OnFrameSentDpc as a DPC at TPL_CALLBACK.\r
+\r
+  @param  Event                 The transmit token's event.\r
+  @param  Context               Context which is point to the token.\r
+\r
+  @return None\r
+\r
+**/\r
 VOID\r
 EFIAPI\r
 Ip4OnFrameSent (\r
   IN EFI_EVENT               Event,\r
   IN VOID                    *Context\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Request Ip4OnFrameSentDpc as a DPC at TPL_CALLBACK\r
-\r
-Arguments:\r
-\r
-  Event   - The transmit token's event\r
-  Context - Context which is point to the token.\r
-\r
-Returns:\r
-\r
-  None.\r
-\r
---*/\r
 {\r
   //\r
   // Request Ip4OnFrameSentDpc as a DPC at TPL_CALLBACK\r
@@ -929,6 +916,7 @@ Returns:
   @retval EFI_OUT_OF_RESOURCES  Failed to allocate resource to send the frame\r
   @retval EFI_NO_MAPPING        Can't resolve the MAC for the nexthop\r
   @retval EFI_SUCCESS           The packet is successfully transmitted.\r
+  @retval other                 Other error occurs.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -1196,6 +1184,7 @@ Returns:
   @retval EFI_ALREADY_STARTED   There is already a pending receive request.\r
   @retval EFI_OUT_OF_RESOURCES  Failed to allocate resource to receive\r
   @retval EFI_SUCCESS           The recieve request has been started.\r
+  @retval other                 Other error occurs.\r
 \r
 **/\r
 EFI_STATUS\r