Change the file headers and some function comments.

[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 e29f0978f13fc5dbc788d07fb8fecde2d3ba9b3b..94bbe18847e37fb3e484bc646ba0152147cdd5d8 100644 (file)
--- a/MdeModulePkg/Universal/Network/MnpDxe/MnpConfig.c
+++ b/MdeModulePkg/Universal/Network/MnpDxe/MnpConfig.c
@@ -1,23 +1,15 @@
 /** @file\r
+  Implementation of Managed Network Protocol private services.\r
 \r
-Copyright (c) 2005 - 2008, Intel Corporation\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
+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
 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
-Module Name:\r
-\r
-  MnpConfig.c\r
-\r
-Abstract:\r
-\r
-  Implementation of Managed Network Protocol private services.\r
-\r
-\r
 **/\r
 \r
 \r
@@ -59,8 +51,8 @@ EFI_MANAGED_NETWORK_CONFIG_DATA mMnpDefaultConfigData = {
   @param  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 lack\r
-                                of memory resource.\r
+  @retval EFI_OUT_OF_RESOURCES  The receive filters can't be configured due to \r
+                                lack of memory resource.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -210,14 +202,14 @@ MnpConfigReceiveFilters (
 }\r
 \r
 /**\r
-  Add some NET_BUF into MnpServiceData->FreeNbufQue. The buffer length of\r
-  the NET_BUF is specified by MnpServiceData->BufferLength.\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
 \r
-  @retval EFI_SUCCESS           The specified amount of NET_BUFs are allocated and\r
-                                added into MnpServiceData->FreeNbufQue.\r
+  @retval EFI_SUCCESS           The specified amount of NET_BUFs are allocated \r
+                                and added to MnpServiceData->FreeNbufQue.\r
   @retval EFI_OUT_OF_RESOURCES  Failed to allocate a NET_BUF structure.\r
 \r
 **/\r
@@ -270,7 +262,8 @@ MnpAddFreeNbuf (
 \r
   @param  MnpServiceData        Pointer to the MNP_SERVICE_DATA.\r
 \r
-  @return Pointer to the allocated free NET_BUF structure, if NULL the operation is failed.\r
+  @return     Pointer to the allocated free NET_BUF structure, if NULL the \r
+              operation is failed.\r
 \r
 **/\r
 NET_BUF *\r
@@ -712,21 +705,21 @@ MnpTokenExist (
 /**\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  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
 \r
-  @retval EFI_SUCCESS           The Arg is NULL, and the token in Item is\r
-                                cancelled, or the Arg isn't NULL, and the token in\r
-                                Item is different from the Arg.\r
-  @retval EFI_ABORTED           The Arg isn't NULL, the token in Item mathces the\r
-                                Arg, and the token is cancelled.\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
+                            different from the Arg.\r
+  @retval EFI_ABORTED       The Arg isn't NULL, the token in Item mathces the\r
+                            Arg, and the token is cancelled.\r
 \r
 **/\r
 EFI_STATUS\r
 MnpCancelTokens (\r
-  IN NET_MAP       *Map,\r
+  IN OUT NET_MAP   *Map,\r
   IN NET_MAP_ITEM  *Item,\r
   IN VOID          *Arg\r
   )\r
@@ -838,7 +831,7 @@ MnpStopSnp (
 \r
   @param  MnpServiceData        Pointer to the mnp service context data.\r
   @param  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
 \r
   @retval EFI_SUCCESS           The managed network is started and some\r