Change the file headers and some function comments.
authorniry <niry@6f19259b-4bc3-4df7-8a09-765794883524>
Thu, 8 Jan 2009 04:47:41 +0000 (04:47 +0000)
committerniry <niry@6f19259b-4bc3-4df7-8a09-765794883524>
Thu, 8 Jan 2009 04:47:41 +0000 (04:47 +0000)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@7206 6f19259b-4bc3-4df7-8a09-765794883524

MdeModulePkg/Universal/Network/MnpDxe/ComponentName.c
MdeModulePkg/Universal/Network/MnpDxe/MnpConfig.c
MdeModulePkg/Universal/Network/MnpDxe/MnpDriver.c
MdeModulePkg/Universal/Network/MnpDxe/MnpDriver.h
MdeModulePkg/Universal/Network/MnpDxe/MnpImpl.h
MdeModulePkg/Universal/Network/MnpDxe/MnpIo.c
MdeModulePkg/Universal/Network/MnpDxe/MnpMain.c

index 4091dee..0283179 100644 (file)
@@ -1,21 +1,15 @@
 /** @file\r
+    UEFI Component Name(2) protocol implementation for MnpDxe driver.\r
 \r
-Copyright (c) 2005 - 2007, 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 - 2007, 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
-  ComponentName.c\r
-\r
-Abstract:\r
-\r
-\r
 **/\r
 \r
 \r
@@ -233,7 +227,7 @@ MnpComponentNameGetDriverName (
            This->SupportedLanguages,\r
            mMnpDriverNameTable,\r
            DriverName,\r
-           (BOOLEAN)(This == &gMnpComponentName)\r
+           (BOOLEAN) (This == &gMnpComponentName)\r
            );\r
 }\r
 \r
index e29f097..94bbe18 100644 (file)
@@ -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
index b6c0138..d4aaac3 100644 (file)
@@ -1,21 +1,15 @@
 /** @file\r
+    Implementation of driver entry point and driver binding protocol.\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
-  MnpDriver.c\r
-\r
-Abstract:\r
-\r
-\r
 **/\r
 \r
 #include "MnpDriver.h"\r
@@ -284,10 +278,10 @@ MnpDriverBindingStop (
                                  not NULL, then the I/O services are  added to the\r
                                  existing child handle.\r
 \r
-  @retval EFI_SUCCES             The child handle was created with the I/O\r
-                                 services.\r
-  @retval EFI_OUT_OF_RESOURCES   There are not enough resources availabe to create\r
-                                 the child.\r
+  @retval EFI_SUCCES             The protocol was added to ChildHandle. \r
+  @retval EFI_INVALID_PARAMETER  ChildHandle is NULL. \r
+  @retval EFI_OUT_OF_RESOURCES   There are not enough resources availabe to \r
+                                 create the child.\r
   @retval other                  The child handle was not created.\r
 \r
 **/\r
@@ -295,7 +289,7 @@ EFI_STATUS
 EFIAPI\r
 MnpServiceBindingCreateChild (\r
   IN EFI_SERVICE_BINDING_PROTOCOL  *This,\r
-  IN EFI_HANDLE                    *ChildHandle\r
+  IN OUT EFI_HANDLE                *ChildHandle\r
   )\r
 {\r
   EFI_STATUS         Status;\r
@@ -391,17 +385,22 @@ ErrorExit:
 \r
 /**\r
   Destroys a child handle with a set of I/O services.\r
-\r
-  @param  This                   Protocol instance pointer.\r
+   \r
+  The DestroyChild() function does the opposite of CreateChild(). It removes a \r
+  protocol that was installed by CreateChild() from ChildHandle. If the removed \r
+  protocol is the last protocol on ChildHandle, then ChildHandle is destroyed. \r
+   \r
+  @param  This                   Pointer to the EFI_SERVICE_BINDING_PROTOCOL \r
+                                 instance.\r
   @param  ChildHandle            Handle of the child to destroy.\r
 \r
-  @retval EFI_SUCCES             The I/O services were removed from the child\r
-                                 handle.\r
-  @retval EFI_UNSUPPORTED        The child handle does not support the I/O services\r
-                                  that are being removed.\r
-  @retval EFI_INVALID_PARAMETER  Child handle is not a valid EFI Handle.\r
-  @retval EFI_ACCESS_DENIED      The child handle could not be destroyed because\r
-                                 its  I/O services are being used.\r
+  @retval EFI_SUCCES             The protocol was removed from ChildHandle. \r
+  @retval EFI_UNSUPPORTED        ChildHandle does not support the protocol that\r
+                                 is being removed.\r
+  @retval EFI_INVALID_PARAMETER  ChildHandle is not a valid UEFI handle.\r
+  @retval EFI_ACCESS_DENIED      The protocol could not be removed from the\r
+                                 ChildHandle because its services are being\r
+                                 used.\r
   @retval other                  The child handle was not destroyed.\r
 \r
 **/\r
@@ -524,7 +523,7 @@ MnpServiceBindingDestroyChild (
   @param  ImageHandle   The image handle of the driver.\r
   @param  SystemTable   The system table.\r
 \r
-  @retval EFI_SUCCES       the driver binding and component name protocols are \r
+  @retval EFI_SUCCES       The driver binding and component name protocols are \r
                            successfully installed.\r
   @retval other            failed.\r
 \r
index 3be0e87..03aee05 100644 (file)
@@ -1,26 +1,20 @@
 /** @file\r
-\r
-Copyright (c) 2005 - 2007, 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
+    Declaration of strctures and functions for MnpDxe driver.\r
+    \r
+Copyright (c) 2005 - 2007, 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
-  MnpDriver.h\r
-\r
-Abstract:\r
-\r
-\r
 **/\r
 \r
 #ifndef _MNP_DRIVER_H_\r
 #define _MNP_DRIVER_H_\r
-#include <PiDxe.h>\r
+#include <Uefi.h>\r
 \r
 #include <Protocol/ManagedNetwork.h>\r
 #include <Protocol/SimpleNetwork.h>\r
@@ -194,7 +188,7 @@ EFI_STATUS
 EFIAPI\r
 MnpServiceBindingCreateChild (\r
   IN EFI_SERVICE_BINDING_PROTOCOL  *This,\r
-  IN EFI_HANDLE                    *ChildHandle\r
+  IN OUT EFI_HANDLE                *ChildHandle\r
   );\r
 \r
 /**\r
index 7fa8bc8..1bad960 100644 (file)
@@ -1,6 +1,7 @@
 /** @file\r
-\r
-Copyright (c) 2005 - 2008, Intel Corporation\r
+    Declaration of structures and functions of MnpDxe driver.\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
@@ -9,13 +10,6 @@ http://opensource.org/licenses/bsd-license.php
 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
-  MnpImpl.h\r
-\r
-Abstract:\r
-\r
-\r
 **/\r
 \r
 #ifndef _MNP_IMPL_H_\r
@@ -179,7 +173,7 @@ MnpTokenExist (
 **/\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
index 0347dc7..d63bad0 100644 (file)
@@ -1,6 +1,7 @@
 /** @file\r
-\r
-Copyright (c) 2005 - 2007, Intel Corporation\r
+    Implementation of Managed Network Protocol I/O functions.\r
+    \r
+Copyright (c) 2005 - 2007, 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
@@ -9,15 +10,6 @@ http://opensource.org/licenses/bsd-license.php
 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
-  MnpIo.c\r
-\r
-Abstract:\r
-\r
-  Implementation of Managed Network Protocol I/O functions.\r
-\r
-\r
 **/\r
 \r
 #include "MnpImpl.h"\r
@@ -1071,8 +1063,6 @@ MnpCheckPacketTimeout (
   @param  Context               Pointer to the context data registered to the\r
                                 event.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 EFIAPI\r
index ea05532..a30eb12 100644 (file)
@@ -1,6 +1,7 @@
 /** @file\r
+    Implementation of Managed Network Protocol public services.\r
 \r
-Copyright (c) 2005 - 2007, Intel Corporation\r
+Copyright (c) 2005 - 2007, 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
@@ -9,21 +10,11 @@ http://opensource.org/licenses/bsd-license.php
 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
-  MnpMain.c\r
-\r
-Abstract:\r
-\r
-  Implementation of Managed Network Protocol public services.\r
-\r
-\r
 **/\r
-\r
+#include "MnpImpl.h"\r
 #include <Library/BaseMemoryLib.h>\r
 #include <Library/BaseLib.h>\r
 \r
-#include "MnpImpl.h"\r
 \r
 \r
 /**\r