code scrub fix

[mirror_edk2.git] / MdeModulePkg / Universal / Network / MnpDxe / MnpIo.c

diff --git a/MdeModulePkg/Universal/Network/MnpDxe/MnpIo.c b/MdeModulePkg/Universal/Network/MnpDxe/MnpIo.c
index d63bad00b88c8c4accfe9eb34721959b2e9a4385..b5d1785cb1fe5f6547333b567d34703983917885 100644 (file)
--- a/MdeModulePkg/Universal/Network/MnpDxe/MnpIo.c
+++ b/MdeModulePkg/Universal/Network/MnpDxe/MnpIo.c
@@ -1,7 +1,8 @@
 /** @file\r
-    Implementation of Managed Network Protocol I/O functions.\r
-    \r
-Copyright (c) 2005 - 2007, Intel Corporation. <BR>\r
+  Implementation of Managed Network Protocol I/O functions.\r
+  \r
+Copyright (c) 2005 - 2007, Intel Corporation.<BR>\r
+\r
 All rights reserved. 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
@@ -22,8 +23,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 /**\r
   Validates the Mnp transmit token.\r
 \r
-  @param  Instance              Pointer to the Mnp instance context data.\r
-  @param  Token                 Pointer to the transmit token to check.\r
+  @param[in]  Instance              Pointer to the Mnp instance context data.\r
+  @param[in]  Token                 Pointer to the transmit token to check.\r
 \r
   @return The Token is valid or not.\r
 \r
@@ -115,7 +116,7 @@ MnpIsValidTxToken (
   @param  PktBuf                Pointer to record the address of the packet.\r
   @param  PktLen                Pointer to a UINT32 variable used to record the\r
                                 packet's length.\r
-\r
+   \r
 **/\r
 VOID\r
 MnpBuildTxPacket (\r
@@ -179,10 +180,10 @@ MnpBuildTxPacket (
 /**\r
   Synchronously send out the packet.\r
 \r
-  @param  MnpServiceData        Pointer to the mnp service context data.\r
-  @param  Packet                Pointer to the pakcet buffer.\r
-  @param  Length                The length of the packet.\r
-  @param  Token                 Pointer to the token the packet generated from.\r
+  @param[in]  MnpServiceData        Pointer to the mnp service context data.\r
+  @param[in]  Packet                Pointer to the pakcet buffer.\r
+  @param[in]  Length                The length of the packet.\r
+  @param[in]  Token                 Pointer to the token the packet generated from.\r
 \r
   @retval EFI_SUCCESS           The packet is sent out.\r
   @retval EFI_TIMEOUT           Time out occurs, the packet isn't sent.\r
@@ -296,7 +297,7 @@ SIGNAL_TOKEN:
 /**\r
   Try to deliver the received packet to the instance.\r
 \r
-  @param  Instance              Pointer to the mnp instance context data.\r
+  @param[in]  Instance          Pointer to the mnp instance context data.\r
 \r
   @retval EFI_SUCCESS           The received packet is delivered, or there is no\r
                                 packet to deliver, or there is no available receive\r
@@ -392,8 +393,6 @@ MnpInstanceDeliverPacket (
 \r
   @param  MnpServiceData        Pointer to the mnp service context data.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 MnpDeliverPacket (\r
@@ -421,9 +420,9 @@ MnpDeliverPacket (
   Recycle the RxData and other resources used to hold and deliver the received\r
   packet.\r
 \r
-  @param  Event                 The event this notify function registered to.\r
-  @param  Context               Pointer to the context data registerd to the Event.\r
-\r
+  @param  Event             The event this notify function registered to.\r
+  @param  Context           Pointer to the context data registerd to the Event.\r
+  \r
 **/\r
 VOID\r
 EFIAPI\r
@@ -468,12 +467,10 @@ MnpRecycleRxData (
 /**\r
   Queue the received packet into instance's receive queue.\r
 \r
-  @param  Instance              Pointer to the mnp instance context data.\r
-  @param  RxDataWrap            Pointer to the Wrap structure containing the\r
+  @param  Instance          Pointer to the mnp instance context data.\r
+  @param  RxDataWrap        Pointer to the Wrap structure containing the\r
                                 received data and other information.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 MnpQueueRcvdPacket (\r
@@ -525,13 +522,13 @@ MnpQueueRcvdPacket (
 /**\r
   Match the received packet with the instance receive filters.\r
 \r
-  @param  Instance              Pointer to the mnp instance context data.\r
-  @param  RxData                Pointer to the EFI_MANAGED_NETWORK_RECEIVE_DATA.\r
-  @param  GroupAddress          Pointer to the GroupAddress, the GroupAddress is\r
+  @param[in]  Instance          Pointer to the mnp instance context data.\r
+  @param[in]  RxData            Pointer to the EFI_MANAGED_NETWORK_RECEIVE_DATA.\r
+  @param[in]  GroupAddress      Pointer to the GroupAddress, the GroupAddress is\r
                                 non-NULL and it contains the destination multicast\r
                                 mac address of the received packet if the packet\r
                                 destinated to a multicast mac address.\r
-  @param  PktAttr               The received packets attribute.\r
+  @param[in]  PktAttr           The received packets attribute.\r
 \r
   @return The received packet matches the instance's receive filters or not.\r
 \r
@@ -603,18 +600,16 @@ MnpMatchPacket (
 /**\r
   Analyse the received packets.\r
 \r
-  @param  MnpServiceData        Pointer to the mnp service context data.\r
-  @param  Nbuf                  Pointer to the net buffer holding the received\r
-                                packet.\r
-  @param  RxData                Pointer to the buffer used to save the analysed\r
-                                result in EFI_MANAGED_NETWORK_RECEIVE_DATA.\r
-  @param  GroupAddress          Pointer to pointer to a MNP_GROUP_ADDRESS used to\r
-                                pass out the address of the multicast address the\r
-                                received packet destinated to.\r
-  @param  PktAttr               Pointer to the buffer used to save the analysed\r
-                                packet attribute.\r
-\r
-  @return None.\r
+  @param  MnpServiceData    Pointer to the mnp service context data.\r
+  @param  Nbuf              Pointer to the net buffer holding the received\r
+                            packet.\r
+  @param  RxData            Pointer to the buffer used to save the analysed\r
+                            result in EFI_MANAGED_NETWORK_RECEIVE_DATA.\r
+  @param  GroupAddress      Pointer to pointer to a MNP_GROUP_ADDRESS used to\r
+                            pass out the address of the multicast address the\r
+                            received packet destinated to.\r
+  @param  PktAttr           Pointer to the buffer used to save the analysed\r
+                            packet attribute.\r
 \r
 **/\r
 VOID\r
@@ -707,8 +702,8 @@ MnpAnalysePacket (
 /**\r
   Wrap the RxData.\r
 \r
-  @param  Instance              Pointer to the mnp instance context data.\r
-  @param  RxData                Pointer to the receive data to wrap.\r
+  @param[in]  Instance              Pointer to the mnp instance context data.\r
+  @param[in]  RxData                Pointer to the receive data to wrap.\r
 \r
   @return Pointer to a MNP_RXDATA_WRAP which wraps the RxData.\r
 \r
@@ -763,11 +758,9 @@ MnpWrapRxData (
   Enqueue the received the packets to the instances belonging to the\r
   MnpServiceData.\r
 \r
-  @param  MnpServiceData        Pointer to the mnp service context data.\r
-  @param  Nbuf                  Pointer to the net buffer representing the received\r
-                                packet.\r
-\r
-  @return None.\r
+  @param  MnpServiceData    Pointer to the mnp service context data.\r
+  @param  Nbuf              Pointer to the net buffer representing the received\r
+                            packet.\r
 \r
 **/\r
 VOID\r
@@ -840,7 +833,7 @@ MnpEnqueuePacket (
 /**\r
   Try to receive a packet and deliver it.\r
 \r
-  @param  MnpServiceData        Pointer to the mnp service context data.\r
+  @param[in]  MnpServiceData    Pointer to the mnp service context data.\r
 \r
   @retval EFI_SUCCESS           add return value to function comment\r
   @retval EFI_NOT_STARTED       The simple network protocol is not started.\r
@@ -992,10 +985,10 @@ EXIT:
 /**\r
   Remove the received packets if timeout occurs.\r
 \r
-  @param  Event                 The event this notify function registered to.\r
-  @param  Context               Pointer to the context data registered to the\r
-                                event.\r
-   \r
+  @param  Event             The event this notify function registered to.\r
+  @param  Context           Pointer to the context data registered to the\r
+                            event.\r
+  \r
 **/\r
 VOID\r
 EFIAPI\r
@@ -1059,9 +1052,9 @@ MnpCheckPacketTimeout (
   Poll to receive the packets from Snp. This function is either called by upperlayer\r
   protocols/applications or the system poll timer notify mechanism.\r
 \r
-  @param  Event                 The event this notify function registered to.\r
-  @param  Context               Pointer to the context data registered to the\r
-                                event.\r
+  @param  Event             The event this notify function registered to.\r
+  @param  Context           Pointer to the context data registered to the\r
+                            event.\r
 \r
 **/\r
 VOID\r