From c57273b0d88617dc88b065486c647c21757ce1a7 Mon Sep 17 00:00:00 2001 From: niry Date: Thu, 8 Jan 2009 04:47:41 +0000 Subject: [PATCH] Change the file headers and some function comments. git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@7206 6f19259b-4bc3-4df7-8a09-765794883524 --- .../Universal/Network/MnpDxe/ComponentName.c | 20 +++---- .../Universal/Network/MnpDxe/MnpConfig.c | 57 ++++++++----------- .../Universal/Network/MnpDxe/MnpDriver.c | 53 +++++++++-------- .../Universal/Network/MnpDxe/MnpDriver.h | 24 +++----- .../Universal/Network/MnpDxe/MnpImpl.h | 14 ++--- MdeModulePkg/Universal/Network/MnpDxe/MnpIo.c | 16 +----- .../Universal/Network/MnpDxe/MnpMain.c | 15 +---- 7 files changed, 77 insertions(+), 122 deletions(-) diff --git a/MdeModulePkg/Universal/Network/MnpDxe/ComponentName.c b/MdeModulePkg/Universal/Network/MnpDxe/ComponentName.c index 4091dee0cf..0283179065 100644 --- a/MdeModulePkg/Universal/Network/MnpDxe/ComponentName.c +++ b/MdeModulePkg/Universal/Network/MnpDxe/ComponentName.c @@ -1,21 +1,15 @@ /** @file + UEFI Component Name(2) protocol implementation for MnpDxe driver. -Copyright (c) 2005 - 2007, Intel Corporation -All rights reserved. This program and the accompanying materials -are licensed and made available under the terms and conditions of the BSD License -which accompanies this distribution. The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php +Copyright (c) 2005 - 2007, Intel Corporation.
+All rights reserved. This program and the accompanying materials are licensed +and made available under the terms and conditions of the BSD License which +accompanies this distribution. The full text of the license may be found at +http://opensource.org/licenses/bsd-license.php THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. -Module Name: - - ComponentName.c - -Abstract: - - **/ @@ -233,7 +227,7 @@ MnpComponentNameGetDriverName ( This->SupportedLanguages, mMnpDriverNameTable, DriverName, - (BOOLEAN)(This == &gMnpComponentName) + (BOOLEAN) (This == &gMnpComponentName) ); } diff --git a/MdeModulePkg/Universal/Network/MnpDxe/MnpConfig.c b/MdeModulePkg/Universal/Network/MnpDxe/MnpConfig.c index e29f0978f1..94bbe18847 100644 --- a/MdeModulePkg/Universal/Network/MnpDxe/MnpConfig.c +++ b/MdeModulePkg/Universal/Network/MnpDxe/MnpConfig.c @@ -1,23 +1,15 @@ /** @file + Implementation of Managed Network Protocol private services. -Copyright (c) 2005 - 2008, Intel Corporation -All rights reserved. This program and the accompanying materials -are licensed and made available under the terms and conditions of the BSD License -which accompanies this distribution. The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php +Copyright (c) 2005 - 2008, Intel Corporation.
+All rights reserved. This program and the accompanying materials are licensed +and made available under the terms and conditions of the BSD License which +accompanies this distribution. The full text of the license may be found at +http://opensource.org/licenses/bsd-license.php THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. -Module Name: - - MnpConfig.c - -Abstract: - - Implementation of Managed Network Protocol private services. - - **/ @@ -59,8 +51,8 @@ EFI_MANAGED_NETWORK_CONFIG_DATA mMnpDefaultConfigData = { @param MnpServiceData Pointer to the mnp service context data. @retval EFI_SUCCESS The receive filters is configured. - @retval EFI_OUT_OF_RESOURCES The receive filters can't be configured due to lack - of memory resource. + @retval EFI_OUT_OF_RESOURCES The receive filters can't be configured due to + lack of memory resource. **/ EFI_STATUS @@ -210,14 +202,14 @@ MnpConfigReceiveFilters ( } /** - Add some NET_BUF into MnpServiceData->FreeNbufQue. The buffer length of - the NET_BUF is specified by MnpServiceData->BufferLength. + Add Count of net buffers to MnpServiceData->FreeNbufQue. The length of the net + buffer is specified by MnpServiceData->BufferLength. @param MnpServiceData Pointer to the MNP_SERVICE_DATA. @param Count Number of NET_BUFFERs to add. - @retval EFI_SUCCESS The specified amount of NET_BUFs are allocated and - added into MnpServiceData->FreeNbufQue. + @retval EFI_SUCCESS The specified amount of NET_BUFs are allocated + and added to MnpServiceData->FreeNbufQue. @retval EFI_OUT_OF_RESOURCES Failed to allocate a NET_BUF structure. **/ @@ -270,7 +262,8 @@ MnpAddFreeNbuf ( @param MnpServiceData Pointer to the MNP_SERVICE_DATA. - @return Pointer to the allocated free NET_BUF structure, if NULL the operation is failed. + @return Pointer to the allocated free NET_BUF structure, if NULL the + operation is failed. **/ NET_BUF * @@ -712,21 +705,21 @@ MnpTokenExist ( /** Cancel the token specified by Arg if it matches the token in Item. - @param Map Pointer to the NET_MAP. - @param Item Pointer to the NET_MAP_ITEM - @param Arg Pointer to the Arg, it's a pointer to the token to - cancel. + @param Map Pointer to the NET_MAP. + @param Item Pointer to the NET_MAP_ITEM + @param Arg Pointer to the Arg, it's a pointer to the token to + cancel. - @retval EFI_SUCCESS The Arg is NULL, and the token in Item is - cancelled, or the Arg isn't NULL, and the token in - Item is different from the Arg. - @retval EFI_ABORTED The Arg isn't NULL, the token in Item mathces the - Arg, and the token is cancelled. + @retval EFI_SUCCESS The Arg is NULL, and the token in Item is cancelled, + or the Arg isn't NULL, and the token in Item is + different from the Arg. + @retval EFI_ABORTED The Arg isn't NULL, the token in Item mathces the + Arg, and the token is cancelled. **/ EFI_STATUS MnpCancelTokens ( - IN NET_MAP *Map, + IN OUT NET_MAP *Map, IN NET_MAP_ITEM *Item, IN VOID *Arg ) @@ -838,7 +831,7 @@ MnpStopSnp ( @param MnpServiceData Pointer to the mnp service context data. @param IsConfigUpdate The instance is reconfigured or it's the first time - the instanced is configured. + the instanced is configured. @param EnableSystemPoll Enable the system polling or not. @retval EFI_SUCCESS The managed network is started and some diff --git a/MdeModulePkg/Universal/Network/MnpDxe/MnpDriver.c b/MdeModulePkg/Universal/Network/MnpDxe/MnpDriver.c index b6c0138b51..d4aaac33bd 100644 --- a/MdeModulePkg/Universal/Network/MnpDxe/MnpDriver.c +++ b/MdeModulePkg/Universal/Network/MnpDxe/MnpDriver.c @@ -1,21 +1,15 @@ /** @file + Implementation of driver entry point and driver binding protocol. -Copyright (c) 2005 - 2008, Intel Corporation -All rights reserved. This program and the accompanying materials -are licensed and made available under the terms and conditions of the BSD License -which accompanies this distribution. The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php +Copyright (c) 2005 - 2008, Intel Corporation.
+All rights reserved. This program and the accompanying materials are licensed +and made available under the terms and conditions of the BSD License which +accompanies this distribution. The full text of the license may be found at +http://opensource.org/licenses/bsd-license.php THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. -Module Name: - - MnpDriver.c - -Abstract: - - **/ #include "MnpDriver.h" @@ -284,10 +278,10 @@ MnpDriverBindingStop ( not NULL, then the I/O services are added to the existing child handle. - @retval EFI_SUCCES The child handle was created with the I/O - services. - @retval EFI_OUT_OF_RESOURCES There are not enough resources availabe to create - the child. + @retval EFI_SUCCES The protocol was added to ChildHandle. + @retval EFI_INVALID_PARAMETER ChildHandle is NULL. + @retval EFI_OUT_OF_RESOURCES There are not enough resources availabe to + create the child. @retval other The child handle was not created. **/ @@ -295,7 +289,7 @@ EFI_STATUS EFIAPI MnpServiceBindingCreateChild ( IN EFI_SERVICE_BINDING_PROTOCOL *This, - IN EFI_HANDLE *ChildHandle + IN OUT EFI_HANDLE *ChildHandle ) { EFI_STATUS Status; @@ -391,17 +385,22 @@ ErrorExit: /** Destroys a child handle with a set of I/O services. - - @param This Protocol instance pointer. + + The DestroyChild() function does the opposite of CreateChild(). It removes a + protocol that was installed by CreateChild() from ChildHandle. If the removed + protocol is the last protocol on ChildHandle, then ChildHandle is destroyed. + + @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL + instance. @param ChildHandle Handle of the child to destroy. - @retval EFI_SUCCES The I/O services were removed from the child - handle. - @retval EFI_UNSUPPORTED The child handle does not support the I/O services - that are being removed. - @retval EFI_INVALID_PARAMETER Child handle is not a valid EFI Handle. - @retval EFI_ACCESS_DENIED The child handle could not be destroyed because - its I/O services are being used. + @retval EFI_SUCCES The protocol was removed from ChildHandle. + @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that + is being removed. + @retval EFI_INVALID_PARAMETER ChildHandle is not a valid UEFI handle. + @retval EFI_ACCESS_DENIED The protocol could not be removed from the + ChildHandle because its services are being + used. @retval other The child handle was not destroyed. **/ @@ -524,7 +523,7 @@ MnpServiceBindingDestroyChild ( @param ImageHandle The image handle of the driver. @param SystemTable The system table. - @retval EFI_SUCCES the driver binding and component name protocols are + @retval EFI_SUCCES The driver binding and component name protocols are successfully installed. @retval other failed. diff --git a/MdeModulePkg/Universal/Network/MnpDxe/MnpDriver.h b/MdeModulePkg/Universal/Network/MnpDxe/MnpDriver.h index 3be0e8751e..03aee05bc4 100644 --- a/MdeModulePkg/Universal/Network/MnpDxe/MnpDriver.h +++ b/MdeModulePkg/Universal/Network/MnpDxe/MnpDriver.h @@ -1,26 +1,20 @@ /** @file - -Copyright (c) 2005 - 2007, Intel Corporation -All rights reserved. This program and the accompanying materials -are licensed and made available under the terms and conditions of the BSD License -which accompanies this distribution. The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php + Declaration of strctures and functions for MnpDxe driver. + +Copyright (c) 2005 - 2007, Intel Corporation.
+All rights reserved. This program and the accompanying materials are licensed +and made available under the terms and conditions of the BSD License which +accompanies this distribution. The full text of the license may be found at +http://opensource.org/licenses/bsd-license.php THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. -Module Name: - - MnpDriver.h - -Abstract: - - **/ #ifndef _MNP_DRIVER_H_ #define _MNP_DRIVER_H_ -#include +#include #include #include @@ -194,7 +188,7 @@ EFI_STATUS EFIAPI MnpServiceBindingCreateChild ( IN EFI_SERVICE_BINDING_PROTOCOL *This, - IN EFI_HANDLE *ChildHandle + IN OUT EFI_HANDLE *ChildHandle ); /** diff --git a/MdeModulePkg/Universal/Network/MnpDxe/MnpImpl.h b/MdeModulePkg/Universal/Network/MnpDxe/MnpImpl.h index 7fa8bc8f74..1bad960893 100644 --- a/MdeModulePkg/Universal/Network/MnpDxe/MnpImpl.h +++ b/MdeModulePkg/Universal/Network/MnpDxe/MnpImpl.h @@ -1,6 +1,7 @@ /** @file - -Copyright (c) 2005 - 2008, Intel Corporation + Declaration of structures and functions of MnpDxe driver. + +Copyright (c) 2005 - 2008, Intel Corporation.
All rights reserved. This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at @@ -9,13 +10,6 @@ http://opensource.org/licenses/bsd-license.php THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. -Module Name: - - MnpImpl.h - -Abstract: - - **/ #ifndef _MNP_IMPL_H_ @@ -179,7 +173,7 @@ MnpTokenExist ( **/ EFI_STATUS MnpCancelTokens ( - IN NET_MAP *Map, + IN OUT NET_MAP *Map, IN NET_MAP_ITEM *Item, IN VOID *Arg ); diff --git a/MdeModulePkg/Universal/Network/MnpDxe/MnpIo.c b/MdeModulePkg/Universal/Network/MnpDxe/MnpIo.c index 0347dc7f1f..d63bad00b8 100644 --- a/MdeModulePkg/Universal/Network/MnpDxe/MnpIo.c +++ b/MdeModulePkg/Universal/Network/MnpDxe/MnpIo.c @@ -1,6 +1,7 @@ /** @file - -Copyright (c) 2005 - 2007, Intel Corporation + Implementation of Managed Network Protocol I/O functions. + +Copyright (c) 2005 - 2007, Intel Corporation.
All rights reserved. This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at @@ -9,15 +10,6 @@ http://opensource.org/licenses/bsd-license.php THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. -Module Name: - - MnpIo.c - -Abstract: - - Implementation of Managed Network Protocol I/O functions. - - **/ #include "MnpImpl.h" @@ -1071,8 +1063,6 @@ MnpCheckPacketTimeout ( @param Context Pointer to the context data registered to the event. - @return None. - **/ VOID EFIAPI diff --git a/MdeModulePkg/Universal/Network/MnpDxe/MnpMain.c b/MdeModulePkg/Universal/Network/MnpDxe/MnpMain.c index ea055323cd..a30eb12a29 100644 --- a/MdeModulePkg/Universal/Network/MnpDxe/MnpMain.c +++ b/MdeModulePkg/Universal/Network/MnpDxe/MnpMain.c @@ -1,6 +1,7 @@ /** @file + Implementation of Managed Network Protocol public services. -Copyright (c) 2005 - 2007, Intel Corporation +Copyright (c) 2005 - 2007, Intel Corporation.
All rights reserved. This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at @@ -9,21 +10,11 @@ http://opensource.org/licenses/bsd-license.php THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. -Module Name: - - MnpMain.c - -Abstract: - - Implementation of Managed Network Protocol public services. - - **/ - +#include "MnpImpl.h" #include #include -#include "MnpImpl.h" /** -- 2.39.2