code scrub fix

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

diff --git a/MdeModulePkg/Universal/Network/MnpDxe/MnpConfig.c b/MdeModulePkg/Universal/Network/MnpDxe/MnpConfig.c
index 94bbe18847e37fb3e484bc646ba0152147cdd5d8..9ed0f3ffd7bb4cd1306213041dd54583981ed969 100644 (file)
--- a/MdeModulePkg/Universal/Network/MnpDxe/MnpConfig.c
+++ b/MdeModulePkg/Universal/Network/MnpDxe/MnpConfig.c
@@ -1,11 +1,11 @@
 /** @file\r
   Implementation of Managed Network Protocol private services.\r
 /** @file\r
   Implementation of Managed Network Protocol private services.\r

-\r
-Copyright (c) 2005 - 2008, Intel Corporation. <BR> \r
-All rights reserved. This program and the accompanying materials are licensed \r
-and made available under the terms and conditions of the BSD License which \r
-accompanies this distribution. The full text of the license may be found at \r
-http://opensource.org/licenses/bsd-license.php \r
+  \r
+Copyright (c) 2005 - 2008, Intel Corporation.<BR>\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
+http://opensource.org/licenses/bsd-license.php\r

 \r
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r


@@ -48,7 +48,7 @@ EFI_MANAGED_NETWORK_CONFIG_DATA mMnpDefaultConfigData = {
   Configure the Snp receive filters according to the instances' receive filter\r
   settings.\r
 \r
   Configure the Snp receive filters according to the instances' receive filter\r
   settings.\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           The receive filters is configured.\r
   @retval EFI_OUT_OF_RESOURCES  The receive filters can't be configured due to \r
 \r
   @retval EFI_SUCCESS           The receive filters is configured.\r
   @retval EFI_OUT_OF_RESOURCES  The receive filters can't be configured due to \r


@@ -205,8 +205,8 @@ MnpConfigReceiveFilters (
   Add Count of net buffers to MnpServiceData->FreeNbufQue. The length of the net\r
   buffer is specified by MnpServiceData->BufferLength. \r
 \r
   Add Count of net buffers to MnpServiceData->FreeNbufQue. The length of the net\r
   buffer is specified by MnpServiceData->BufferLength. \r
 \r

-  @param  MnpServiceData        Pointer to the MNP_SERVICE_DATA.\r
-  @param  Count                 Number of NET_BUFFERs to add.\r
+  @param[in]  MnpServiceData    Pointer to the MNP_SERVICE_DATA.\r
+  @param[in]  Count             Number of NET_BUFFERs to add.\r

 \r
   @retval EFI_SUCCESS           The specified amount of NET_BUFs are allocated \r
                                 and added to MnpServiceData->FreeNbufQue.\r
 \r
   @retval EFI_SUCCESS           The specified amount of NET_BUFs are allocated \r
                                 and added to MnpServiceData->FreeNbufQue.\r


@@ -260,7 +260,7 @@ MnpAddFreeNbuf (
   in the queue, first try to allocate some and add them into the queue, then\r
   fetch the NET_BUF from the updated FreeNbufQue.\r
 \r
   in the queue, first try to allocate some and add them into the queue, then\r
   fetch the NET_BUF from the updated FreeNbufQue.\r
 \r

-  @param  MnpServiceData        Pointer to the MNP_SERVICE_DATA.\r
+  @param[in]  MnpServiceData        Pointer to the MNP_SERVICE_DATA.\r

 \r
   @return     Pointer to the allocated free NET_BUF structure, if NULL the \r
               operation is failed.\r
 \r
   @return     Pointer to the allocated free NET_BUF structure, if NULL the \r
               operation is failed.\r


@@ -335,7 +335,7 @@ ON_EXIT:
 \r
   @param  MnpServiceData        Pointer to the mnp service context data.\r
   @param  Nbuf                  Pointer to the NET_BUF to free.\r
 \r
   @param  MnpServiceData        Pointer to the mnp service context data.\r
   @param  Nbuf                  Pointer to the NET_BUF to free.\r

-\r
+  \r

 **/\r
 VOID\r
 MnpFreeNbuf (\r
 **/\r
 VOID\r
 MnpFreeNbuf (\r


@@ -367,9 +367,9 @@ MnpFreeNbuf (
 /**\r
   Initialize the mnp service context data.\r
 \r
 /**\r
   Initialize the mnp service context data.\r
 \r

-  @param  MnpServiceData        Pointer to the mnp service context data.\r
-  @param  ImageHandle           The driver image handle.\r
-  @param  ControllerHandle      Handle of device to bind driver to.\r
+  @param[in]  MnpServiceData        Pointer to the mnp service context data.\r
+  @param[in]  ImageHandle           The driver image handle.\r
+  @param[in]  ControllerHandle      Handle of device to bind driver to.\r

 \r
   @retval EFI_SUCCESS           The mnp service context is initialized.\r
   @retval Other                 Some error occurs.\r
 \r
   @retval EFI_SUCCESS           The mnp service context is initialized.\r
   @retval Other                 Some error occurs.\r


@@ -555,7 +555,7 @@ ERROR:
 \r
   @param  MnpServiceData        Pointer to the mnp service context data.\r
   @param  ImageHandle           The driver image handle.\r
 \r
   @param  MnpServiceData        Pointer to the mnp service context data.\r
   @param  ImageHandle           The driver image handle.\r

-\r
+  \r

 **/\r
 VOID\r
 MnpFlushServiceData (\r
 **/\r
 VOID\r
 MnpFlushServiceData (\r


@@ -616,8 +616,8 @@ MnpFlushServiceData (
 /**\r
   Initialize the mnp instance context data.\r
 \r
 /**\r
   Initialize the mnp instance context data.\r
 \r

-  @param  MnpServiceData        Pointer to the mnp service context data.\r
-  @param  Instance              Pointer to the mnp instance context data to\r
+  @param[in]  MnpServiceData    Pointer to the mnp service context data.\r
+  @param[in]  Instance          Pointer to the mnp instance context data to\r

                                 initialize.\r
 \r
 **/\r
                                 initialize.\r
 \r
 **/\r


@@ -667,9 +667,9 @@ MnpInitializeInstanceData (
 /**\r
   Check whether the token specified by Arg maches the token in Item.\r
 \r
 /**\r
   Check whether the token specified by Arg maches the token in Item.\r
 \r

-  @param  Map                   Pointer to the NET_MAP.\r
-  @param  Item                  Pointer to the NET_MAP_ITEM\r
-  @param  Arg                   Pointer to the Arg, it's a pointer to the token to\r
+  @param[in]  Map               Pointer to the NET_MAP.\r
+  @param[in]  Item              Pointer to the NET_MAP_ITEM\r
+  @param[in]  Arg               Pointer to the Arg, it's a pointer to the token to\r

                                 check.\r
 \r
   @retval EFI_SUCCESS           The token specified by Arg is different from the\r
                                 check.\r
 \r
   @retval EFI_SUCCESS           The token specified by Arg is different from the\r


@@ -705,10 +705,10 @@ MnpTokenExist (
 /**\r
   Cancel the token specified by Arg if it matches the token in Item.\r
 \r
 /**\r
   Cancel the token specified by Arg if it matches the token in Item.\r
 \r

-  @param  Map               Pointer to the NET_MAP.\r
-  @param  Item              Pointer to the NET_MAP_ITEM\r
-  @param  Arg               Pointer to the Arg, it's a pointer to the token to \r
-                            cancel.\r
+  @param[in, out]  Map          Pointer to the NET_MAP.\r
+  @param[in]       Item         Pointer to the NET_MAP_ITEM\r
+  @param[in]       Arg          Pointer to the Arg, it's a pointer to the token to\r
+                                cancel.\r

 \r
   @retval EFI_SUCCESS       The Arg is NULL, and the token in Item is cancelled, \r
                             or the Arg isn't NULL, and the token in Item is\r
 \r
   @retval EFI_SUCCESS       The Arg is NULL, and the token in Item is cancelled, \r
                             or the Arg isn't NULL, and the token in Item is\r


@@ -760,7 +760,7 @@ MnpCancelTokens (
 /**\r
   Start and initialize the simple network.\r
 \r
 /**\r
   Start and initialize the simple network.\r
 \r

-  @param  Snp                   Pointer to the simple network protocol.\r
+  @param[in]  Snp               Pointer to the simple network protocol.\r

 \r
   @retval EFI_SUCCESS           The simple network protocol is started.\r
   @retval Other                 Some error occurs.\r
 \r
   @retval EFI_SUCCESS           The simple network protocol is started.\r
   @retval Other                 Some error occurs.\r


@@ -794,7 +794,7 @@ MnpStartSnp (
 /**\r
   Stop the simple network.\r
 \r
 /**\r
   Stop the simple network.\r
 \r

-  @param  Snp                   Pointer to the simple network protocol.\r
+  @param[in]  Snp               Pointer to the simple network protocol.\r

 \r
   @retval EFI_SUCCESS           The simple network is stopped.\r
   @retval Other                 Some error occurs.\r
 \r
   @retval EFI_SUCCESS           The simple network is stopped.\r
   @retval Other                 Some error occurs.\r


@@ -829,10 +829,10 @@ MnpStopSnp (
   Start the managed network, this function is called when one instance is configured\r
   or reconfigured.\r
 \r
   Start the managed network, this function is called when one instance is configured\r
   or reconfigured.\r
 \r

-  @param  MnpServiceData        Pointer to the mnp service context data.\r
-  @param  IsConfigUpdate        The instance is reconfigured or it's the first time\r
+  @param[in]  MnpServiceData    Pointer to the mnp service context data.\r
+  @param[in]  IsConfigUpdate    The instance is reconfigured or it's the first time\r

                                 the instanced is configured.\r
                                 the instanced is configured.\r

-  @param  EnableSystemPoll      Enable the system polling or not.\r
+  @param[in]  EnableSystemPoll  Enable the system polling or not.\r

 \r
   @retval EFI_SUCCESS           The managed network is started and some\r
                                 configuration is updated.\r
 \r
   @retval EFI_SUCCESS           The managed network is started and some\r
                                 configuration is updated.\r


@@ -921,7 +921,7 @@ ErrorExit:
 /**\r
   Stop the managed network.\r
 \r
 /**\r
   Stop the managed network.\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           The managed network is stopped.\r
   @retval Other                 Some error occurs.\r
 \r
   @retval EFI_SUCCESS           The managed network is stopped.\r
   @retval Other                 Some error occurs.\r


@@ -1021,8 +1021,8 @@ MnpFlushRcvdDataQueue (
 /**\r
   Configure the Instance using ConfigData.\r
 \r
 /**\r
   Configure the Instance using ConfigData.\r
 \r

-  @param  Instance              Pointer to the mnp instance context data.\r
-  @param  ConfigData            Pointer to the configuration data used to configure\r
+  @param[in]  Instance          Pointer to the mnp instance context data.\r
+  @param[in]  ConfigData        Pointer to the configuration data used to configure\r

                                 the isntance.\r
 \r
   @retval EFI_SUCCESS           The Instance is configured.\r
                                 the isntance.\r
 \r
   @retval EFI_SUCCESS           The Instance is configured.\r


@@ -1162,11 +1162,11 @@ MnpConfigureInstance (
   Add a group address control block which controls the MacAddress for\r
   this instance.\r
 \r
   Add a group address control block which controls the MacAddress for\r
   this instance.\r
 \r

-  @param  Instance              Pointer to the mnp instance context data.\r
-  @param  CtrlBlk               Pointer to the group address control block.\r
-  @param  GroupAddress          Pointer to the group adress.\r
-  @param  MacAddress            Pointer to the mac address.\r
-  @param  HwAddressSize         The hardware address size.\r
+  @param[in]  Instance              Pointer to the mnp instance context data.\r
+  @param[in]  CtrlBlk               Pointer to the group address control block.\r
+  @param[in]  GroupAddress          Pointer to the group adress.\r
+  @param[in]  MacAddress            Pointer to the mac address.\r
+  @param[in]  HwAddressSize         The hardware address size.\r

 \r
   @retval EFI_SUCCESS           The group address control block is added.\r
   @retval EFI_OUT_OF_RESOURCE   Failed due to lack of memory resources.\r
 \r
   @retval EFI_SUCCESS           The group address control block is added.\r
   @retval EFI_OUT_OF_RESOURCE   Failed due to lack of memory resources.\r


@@ -1231,8 +1231,8 @@ MnpGroupOpAddCtrlBlk (
   Delete a group control block from the instance. If the controlled group address's\r
   reference count reaches zero, the group address is removed too.\r
 \r
   Delete a group control block from the instance. If the controlled group address's\r
   reference count reaches zero, the group address is removed too.\r
 \r

-  @param  Instance              Pointer to the instance context data.\r
-  @param  CtrlBlk               Pointer to the group control block to delete.\r
+  @param[in]  Instance              Pointer to the instance context data.\r
+  @param[in]  CtrlBlk               Pointer to the group control block to delete.\r

 \r
   @return The group address controlled by the control block is no longer used or not.\r
 \r
 \r
   @return The group address controlled by the control block is no longer used or not.\r
 \r


@@ -1283,11 +1283,11 @@ MnpGroupOpDelCtrlBlk (
 /**\r
   Do the group operations for this instance.\r
 \r
 /**\r
   Do the group operations for this instance.\r
 \r

-  @param  Instance              Pointer to the instance context data.\r
-  @param  JoinFlag              Set to TRUE to join a group. Set to TRUE to leave a\r
+  @param[in]  Instance          Pointer to the instance context data.\r
+  @param[in]  JoinFlag          Set to TRUE to join a group. Set to TRUE to leave a\r

                                 group/groups.\r
                                 group/groups.\r

-  @param  MacAddress            Pointer to the group address to join or leave.\r
-  @param  CtrlBlk               Pointer to the group control block if JoinFlag if\r
+  @param[in]  MacAddress        Pointer to the group address to join or leave.\r
+  @param[in]  CtrlBlk           Pointer to the group control block if JoinFlag if\r

                                 FALSE.\r
 \r
   @retval EFI_SUCCESS           The group operation finished.\r
                                 FALSE.\r
 \r
   @retval EFI_SUCCESS           The group operation finished.\r