Fix the comments to follow UEFI Spec regarding how to check an EFI_HANDLE is valid/invalid.

Signed-off-by: niruiyu
Reviewed-by: lgao4

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@11979 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
niruiyu 2011-07-05 09:21:22 +00:00
parent fd94fb3be9
commit 15ee13fca7
17 changed files with 38 additions and 38 deletions

View File

@ -1,7 +1,7 @@
/** @file /** @file
UEFI Component Name(2) protocol implementation for Dhcp6 driver. UEFI Component Name(2) protocol implementation for Dhcp6 driver.
Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR> Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
@ -115,7 +115,7 @@ Dhcp6ComponentNameGetDriverName (
driver specified by This was returned in driver specified by This was returned in
DriverName. DriverName.
@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE. @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.
@retval EFI_INVALID_PARAMETER ChildHandle is not NULL, and it is not a valid @retval EFI_INVALID_PARAMETER ChildHandle is not NULL, and it is not a valid
EFI_HANDLE. EFI_HANDLE.
@ -281,7 +281,7 @@ Dhcp6ComponentNameGetDriverName (
driver specified by This was returned in driver specified by This was returned in
DriverName. DriverName.
@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE. @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.
@retval EFI_INVALID_PARAMETER ChildHandle is not NULL, and it is not a valid @retval EFI_INVALID_PARAMETER ChildHandle is not NULL, and it is not a valid
EFI_HANDLE. EFI_HANDLE.

View File

@ -2,7 +2,7 @@
Driver Binding functions and Service Binding functions Driver Binding functions and Service Binding functions
implementationfor for Dhcp6 Driver. implementationfor for Dhcp6 Driver.
Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR> Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
@ -686,7 +686,7 @@ ON_ERROR:
@retval EFI_SUCCES The protocol was removed from ChildHandle. @retval EFI_SUCCES The protocol was removed from ChildHandle.
@retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed. @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed.
@retval EFI_INVALID_PARAMETER Child handle is not a valid UEFI Handle. @retval EFI_INVALID_PARAMETER Child handle is NULL.
@retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle @retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle
because its services are being used. because its services are being used.
@retval other The child handle was not destroyed @retval other The child handle was not destroyed

View File

@ -2,7 +2,7 @@
Driver Binding functions and Service Binding functions Driver Binding functions and Service Binding functions
declaration for Dhcp6 Driver. declaration for Dhcp6 Driver.
Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR> Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
@ -139,7 +139,7 @@ Dhcp6ServiceBindingCreateChild (
@retval EFI_SUCCES The protocol was removed from ChildHandle. @retval EFI_SUCCES The protocol was removed from ChildHandle.
@retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed. @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed.
@retval EFI_INVALID_PARAMETER Child handle is not a valid UEFI Handle. @retval EFI_INVALID_PARAMETER Child handle is NULL.
@retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle @retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle
because its services are being used. because its services are being used.
@retval other The child handle was not destroyed @retval other The child handle was not destroyed

View File

@ -2,7 +2,7 @@
Implementation of EFI_COMPONENT_NAME_PROTOCOL and Implementation of EFI_COMPONENT_NAME_PROTOCOL and
EFI_COMPONENT_NAME2_PROTOCOL protocol. EFI_COMPONENT_NAME2_PROTOCOL protocol.
Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR> Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
@ -118,7 +118,7 @@ Ip6ComponentNameGetDriverName (
driver specified by This was returned in driver specified by This was returned in
DriverName. DriverName.
@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE. @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.
@retval EFI_INVALID_PARAMETER ChildHandle is not NULL, and it is not a valid @retval EFI_INVALID_PARAMETER ChildHandle is not NULL, and it is not a valid
EFI_HANDLE. EFI_HANDLE.
@ -282,7 +282,7 @@ Ip6ComponentNameGetDriverName (
driver specified by This was returned in driver specified by This was returned in
DriverName. DriverName.
@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE. @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.
@retval EFI_INVALID_PARAMETER ChildHandle is not NULL, and it is not a valid @retval EFI_INVALID_PARAMETER ChildHandle is not NULL, and it is not a valid
EFI_HANDLE. EFI_HANDLE.

View File

@ -1,7 +1,7 @@
/** @file /** @file
The driver binding and service binding protocol for IP6 driver. The driver binding and service binding protocol for IP6 driver.
Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR> Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
@ -800,7 +800,7 @@ ON_ERROR:
handle. handle.
@retval EFI_UNSUPPORTED The child handle does not support the I/O services @retval EFI_UNSUPPORTED The child handle does not support the I/O services
that are being removed. that are being removed.
@retval EFI_INVALID_PARAMETER Child handle is not a valid EFI Handle. @retval EFI_INVALID_PARAMETER Child handle is NULL.
@retval EFI_ACCESS_DENIED The child handle could not be destroyed because @retval EFI_ACCESS_DENIED The child handle could not be destroyed because
its I/O services are being used. its I/O services are being used.
@retval other The child handle was not destroyed. @retval other The child handle was not destroyed.

View File

@ -1,7 +1,7 @@
/** @file /** @file
The driver binding and service binding protocol for IP6 driver. The driver binding and service binding protocol for IP6 driver.
Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR> Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
@ -169,7 +169,7 @@ Ip6ServiceBindingCreateChild (
handle. handle.
@retval EFI_UNSUPPORTED The child handle does not support the I/O services @retval EFI_UNSUPPORTED The child handle does not support the I/O services
that are being removed. that are being removed.
@retval EFI_INVALID_PARAMETER Child handle is not a valid EFI Handle. @retval EFI_INVALID_PARAMETER Child handle is NULL.
@retval EFI_ACCESS_DENIED The child handle could not be destroyed because @retval EFI_ACCESS_DENIED The child handle could not be destroyed because
its I/O services are being used. its I/O services are being used.
@retval other The child handle was not destroyed. @retval other The child handle was not destroyed.

View File

@ -1,7 +1,7 @@
/** @file /** @file
UEFI Component Name(2) protocol implementation for IPsec driver. UEFI Component Name(2) protocol implementation for IPsec driver.
Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR> Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
@ -116,7 +116,7 @@ IpSecComponentNameGetDriverName (
driver specified by This was returned in driver specified by This was returned in
DriverName. DriverName.
@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE. @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.
@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid
EFI_HANDLE. EFI_HANDLE.
@ -279,7 +279,7 @@ IpSecComponentNameGetDriverName (
driver specified by This was returned in driver specified by This was returned in
DriverName. DriverName.
@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE. @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.
@retval EFI_INVALID_PARAMETER ChildHandle is not NULL, and it is not a valid @retval EFI_INVALID_PARAMETER ChildHandle is not NULL, and it is not a valid
EFI_HANDLE. EFI_HANDLE.

View File

@ -1,7 +1,7 @@
/** @file /** @file
UEFI Component Name(2) protocol implementation for Mtftp6 driver. UEFI Component Name(2) protocol implementation for Mtftp6 driver.
Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR> Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
@ -114,7 +114,7 @@ Mtftp6ComponentNameGetDriverName (
driver specified by This was returned in driver specified by This was returned in
DriverName. DriverName.
@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE. @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.
@retval EFI_INVALID_PARAMETER ChildHandle is not NULL, and it is not a valid @retval EFI_INVALID_PARAMETER ChildHandle is not NULL, and it is not a valid
EFI_HANDLE. EFI_HANDLE.
@ -277,7 +277,7 @@ Mtftp6ComponentNameGetDriverName (
driver specified by This was returned in driver specified by This was returned in
DriverName. DriverName.
@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE. @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.
@retval EFI_INVALID_PARAMETER ChildHandle is not NULL, and it is not a valid @retval EFI_INVALID_PARAMETER ChildHandle is not NULL, and it is not a valid
EFI_HANDLE. EFI_HANDLE.

View File

@ -612,7 +612,7 @@ ON_ERROR:
@retval EFI_SUCCES The protocol was removed from ChildHandle. @retval EFI_SUCCES The protocol was removed from ChildHandle.
@retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed. @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed.
@retval EFI_INVALID_PARAMETER Child handle is not a valid UEFI Handle. @retval EFI_INVALID_PARAMETER Child handle is NULL.
@retval Others The child handle was not destroyed @retval Others The child handle was not destroyed
**/ **/

View File

@ -137,7 +137,7 @@ Mtftp6ServiceBindingCreateChild (
@retval EFI_SUCCES The protocol was removed from ChildHandle. @retval EFI_SUCCES The protocol was removed from ChildHandle.
@retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed. @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed.
@retval EFI_INVALID_PARAMETER Child handle is not a valid UEFI Handle. @retval EFI_INVALID_PARAMETER Child handle is NULL.
@retval Others The child handle was not destroyed @retval Others The child handle was not destroyed
**/ **/

View File

@ -2,7 +2,7 @@
Implementation of protocols EFI_COMPONENT_NAME_PROTOCOL and Implementation of protocols EFI_COMPONENT_NAME_PROTOCOL and
EFI_COMPONENT_NAME2_PROTOCOL. EFI_COMPONENT_NAME2_PROTOCOL.
Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR> Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
@ -116,7 +116,7 @@ TcpComponentNameGetDriverName (
driver specified by This was returned in driver specified by This was returned in
DriverName. DriverName.
@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE. @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.
@retval EFI_INVALID_PARAMETER ChildHandle is not NULL, and it is not a valid @retval EFI_INVALID_PARAMETER ChildHandle is not NULL, and it is not a valid
EFI_HANDLE. EFI_HANDLE.
@ -275,7 +275,7 @@ TcpComponentNameGetDriverName (
driver specified by This was returned in driver specified by This was returned in
DriverName. DriverName.
@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE. @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.
@retval EFI_INVALID_PARAMETER ChildHandle is not NULL, and it is not a valid @retval EFI_INVALID_PARAMETER ChildHandle is not NULL, and it is not a valid
EFI_HANDLE. EFI_HANDLE.

View File

@ -823,7 +823,7 @@ TcpServiceBindingCreateChild (
@retval EFI_SUCCES The protocol was removed from ChildHandle. @retval EFI_SUCCES The protocol was removed from ChildHandle.
@retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed. @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed.
@retval EFI_INVALID_PARAMETER Child handle is not a valid UEFI Handle. @retval EFI_INVALID_PARAMETER Child handle is NULL.
@retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle @retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle
because its services are being used. because its services are being used.
@retval other The child handle was not destroyed. @retval other The child handle was not destroyed.

View File

@ -1,7 +1,7 @@
/** @file /** @file
The prototype of driver binding and service binding protocol for TCP driver. The prototype of driver binding and service binding protocol for TCP driver.
Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR> Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
@ -214,7 +214,7 @@ TcpServiceBindingCreateChild (
@retval EFI_SUCCES The protocol was removed from ChildHandle. @retval EFI_SUCCES The protocol was removed from ChildHandle.
@retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed. @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed.
@retval EFI_INVALID_PARAMETER The child handle is not a valid UEFI Handle. @retval EFI_INVALID_PARAMETER The child handle is NULL.
@retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle @retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle
because its services are being used. because its services are being used.
@retval other The child handle was not destroyed. @retval other The child handle was not destroyed.

View File

@ -1,7 +1,7 @@
/** @file /** @file
UEFI Component Name(2) protocol implementation for UDP6 driver. UEFI Component Name(2) protocol implementation for UDP6 driver.
Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR> Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
@ -117,7 +117,7 @@ Udp6ComponentNameGetDriverName (
driver specified by This was returned in driver specified by This was returned in
DriverName. DriverName.
@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE. @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.
@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid
EFI_HANDLE. EFI_HANDLE.
@ -281,7 +281,7 @@ Udp6ComponentNameGetDriverName (
driver specified by This was returned in driver specified by This was returned in
DriverName. DriverName.
@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE. @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.
@retval EFI_INVALID_PARAMETER ChildHandle is not NULL, and it is not a valid @retval EFI_INVALID_PARAMETER ChildHandle is not NULL, and it is not a valid
EFI_HANDLE. EFI_HANDLE.

View File

@ -1,7 +1,7 @@
/** @file /** @file
Driver Binding functions and Service Binding functions for the Network driver module. Driver Binding functions and Service Binding functions for the Network driver module.
Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR> Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
@ -398,7 +398,7 @@ ON_ERROR:
handle. handle.
@retval EFI_UNSUPPORTED The child handle does not support the I/O services @retval EFI_UNSUPPORTED The child handle does not support the I/O services
that are being removed. that are being removed.
@retval EFI_INVALID_PARAMETER Child handle is not a valid EFI Handle. @retval EFI_INVALID_PARAMETER Child handle is NULL.
@retval EFI_ACCESS_DENIED The child handle could not be destroyed because @retval EFI_ACCESS_DENIED The child handle could not be destroyed because
its I/O services are being used. its I/O services are being used.
@retval other The child handle was not destroyed. @retval other The child handle was not destroyed.

View File

@ -1,7 +1,7 @@
/** @file /** @file
Driver Binding functions and Service Binding functions for the Network driver module. Driver Binding functions and Service Binding functions for the Network driver module.
Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR> Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
@ -165,7 +165,7 @@ Udp6ServiceBindingCreateChild (
handle. handle.
@retval EFI_UNSUPPORTED The child handle does not support the I/O services @retval EFI_UNSUPPORTED The child handle does not support the I/O services
that are being removed. that are being removed.
@retval EFI_INVALID_PARAMETER Child handle is not a valid EFI Handle. @retval EFI_INVALID_PARAMETER Child handle is NULL.
@retval EFI_ACCESS_DENIED The child handle could not be destroyed because @retval EFI_ACCESS_DENIED The child handle could not be destroyed because
its I/O services are being used. its I/O services are being used.
@retval other The child handle was not destroyed. @retval other The child handle was not destroyed.

View File

@ -1,7 +1,7 @@
/** @file /** @file
UEFI Component Name(2) protocol implementation for UefiPxeBc driver. UEFI Component Name(2) protocol implementation for UefiPxeBc driver.
Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR> Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
@ -114,7 +114,7 @@ PxeBcComponentNameGetDriverName (
driver specified by This was returned in driver specified by This was returned in
DriverName. DriverName.
@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE. @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.
@retval EFI_INVALID_PARAMETER ChildHandle is not NULL, and it is not a valid @retval EFI_INVALID_PARAMETER ChildHandle is not NULL, and it is not a valid
EFI_HANDLE. EFI_HANDLE.
@ -280,7 +280,7 @@ PxeBcComponentNameGetDriverName (
driver specified by This was returned in driver specified by This was returned in
DriverName. DriverName.
@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE. @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.
@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid
EFI_HANDLE. EFI_HANDLE.