Fix the comments in the core interface to follow the 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@11933 6f19259b-4bc3-4df7-8a09-765794883524

7 files changed, 16 insertions, 18 deletions

diff --git a/MdePkg/Include/Protocol/ComponentName.h b/MdePkg/Include/Protocol/ComponentName.h
index 47afd0d1c5..26dec3c101 100644
--- a/MdePkg/Include/Protocol/ComponentName.h
+++ b/MdePkg/Include/Protocol/ComponentName.h
@@ -3,7 +3,7 @@
   This protocol is used to retrieve user readable names of EFI Drivers 

   and controllers managed by EFI Drivers.

 

-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>

 This program and the accompanying materials are licensed and made available under 

 the terms and conditions of the BSD License that accompanies this distribution.  

 The full text of the license may be found at

@@ -88,7 +88,7 @@ EFI_STATUS
   @retval EFI_SUCCESS           The Unicode string for the user-readable name in the

                                 language specified by Language for the driver

                                 specified by This was returned in 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 EFI_HANDLE.

   @retval EFI_INVALID_PARAMETER Language is NULL.

   @retval EFI_INVALID_PARAMETER ControllerName is NULL.

diff --git a/MdePkg/Include/Protocol/ComponentName2.h b/MdePkg/Include/Protocol/ComponentName2.h
index 19bc1b10a9..b4e8a4d9a4 100644
--- a/MdePkg/Include/Protocol/ComponentName2.h
+++ b/MdePkg/Include/Protocol/ComponentName2.h
@@ -3,7 +3,7 @@
   This protocol is used to retrieve user readable names of drivers 

   and controllers managed by UEFI Drivers.

 

-  Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>

+  Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>

   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        

@@ -119,8 +119,7 @@ EFI_STATUS
                                 driver specified by This was

                                 returned in 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 EFI_HANDLE.

diff --git a/MdePkg/Include/Protocol/DriverDiagnostics.h b/MdePkg/Include/Protocol/DriverDiagnostics.h
index 2861773386..8acb27e52c 100644
--- a/MdePkg/Include/Protocol/DriverDiagnostics.h
+++ b/MdePkg/Include/Protocol/DriverDiagnostics.h
@@ -1,7 +1,7 @@
 /** @file

   EFI Driver Diagnostics Protocol

 

-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>

 This program and the accompanying materials are licensed and made available under 

 the terms and conditions of the BSD License that accompanies this distribution.  

 The full text of the license may be found at

@@ -73,7 +73,7 @@ typedef enum {
 

   @retval EFI_SUCCESS           The controller specified by ControllerHandle and

                                 ChildHandle passed the diagnostic.

-  @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 EFI_HANDLE.

   @retval EFI_INVALID_PARAMETER Language is NULL.

   @retval EFI_INVALID_PARAMETER ErrorType is NULL.

diff --git a/MdePkg/Include/Protocol/DriverDiagnostics2.h b/MdePkg/Include/Protocol/DriverDiagnostics2.h
index aaa77c60bc..ab6323bb50 100644
--- a/MdePkg/Include/Protocol/DriverDiagnostics2.h
+++ b/MdePkg/Include/Protocol/DriverDiagnostics2.h
@@ -1,7 +1,7 @@
 /** @file

   UEFI Driver Diagnostics2 Protocol

 

-  Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>

+  Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>

   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        

@@ -59,7 +59,7 @@ typedef struct _EFI_DRIVER_DIAGNOSTICS2_PROTOCOL  EFI_DRIVER_DIAGNOSTICS2_PROTOC
   @retval EFI_ACCESS_DENIED     The request for initiating diagnostics was unable

                                 to be complete due to some underlying hardware or

                                 software state.

-  @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 EFI_HANDLE.

   @retval EFI_INVALID_PARAMETER Language is NULL.

   @retval EFI_INVALID_PARAMETER ErrorType is NULL.

diff --git a/MdePkg/Include/Protocol/PlatformToDriverConfiguration.h b/MdePkg/Include/Protocol/PlatformToDriverConfiguration.h
index 657c9e8c34..2af08a7af1 100644
--- a/MdePkg/Include/Protocol/PlatformToDriverConfiguration.h
+++ b/MdePkg/Include/Protocol/PlatformToDriverConfiguration.h
@@ -99,8 +99,7 @@ typedef struct _EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL EFI_PLATFORM_TO_DR
 

   @retval EFI_NOT_FOUND         No more unread Instance exists.

 

-  @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid

-                                EFI_HANDLE.

+  @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.

 

   @retval EFI_INVALID_PARAMETER Instance is NULL.

 

@@ -235,7 +234,7 @@ typedef enum {
   

   @retval EFI_NOT_FOUND         Instance was not found.

   

-  @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.

+  @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.

  

   @retval EFI_INVALID_PARAMETER Instance is zero.

   

diff --git a/MdePkg/Include/Protocol/ServiceBinding.h b/MdePkg/Include/Protocol/ServiceBinding.h
index a0a9e12251..34ac2f667d 100644
--- a/MdePkg/Include/Protocol/ServiceBinding.h
+++ b/MdePkg/Include/Protocol/ServiceBinding.h
@@ -5,7 +5,7 @@
   It provides services that are required to create and destroy child 

   handles that support a given set of protocols.

 

-  Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>

+  Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>

   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        

@@ -62,7 +62,7 @@ EFI_STATUS
 

   @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 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

                                 because its services are being used.

   @retval other                 The child handle was not destroyed

diff --git a/MdePkg/Include/Uefi/UefiSpec.h b/MdePkg/Include/Uefi/UefiSpec.h
index ff0bab0aaa..b6441c612a 100644
--- a/MdePkg/Include/Uefi/UefiSpec.h
+++ b/MdePkg/Include/Uefi/UefiSpec.h
@@ -276,7 +276,7 @@ EFI_STATUS
                                 2) No drivers were connected to ControllerHandle, but

                                 RemainingDevicePath is not NULL, and it is an End Device

                                 Path Node.

-  @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.

+  @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.

   @retval EFI_NOT_FOUND         1) There are no EFI_DRIVER_BINDING_PROTOCOL instances

                                 present in the system.

                                 2) No drivers were connected to ControllerHandle.

@@ -1167,7 +1167,7 @@ EFI_STATUS
   @retval EFI_ACCESS_DENIED     The protocol interface could not be reinstalled,

                                 because OldInterface is still being used by a

                                 driver that will not release it.

-  @retval EFI_INVALID_PARAMETER Handle is not a valid EFI_HANDLE.

+  @retval EFI_INVALID_PARAMETER Handle is NULL.

   @retval EFI_INVALID_PARAMETER Protocol is NULL.

 

 **/

@@ -1193,7 +1193,7 @@ EFI_STATUS
   @retval EFI_NOT_FOUND         The interface was not found.

   @retval EFI_ACCESS_DENIED     The interface was not removed because the interface

                                 is still being used by a driver.

-  @retval EFI_INVALID_PARAMETER Handle is not a valid EFI_HANDLE.

+  @retval EFI_INVALID_PARAMETER Handle is NULL.

   @retval EFI_INVALID_PARAMETER Protocol is NULL.

 

 **/

@@ -1233,7 +1233,7 @@ EFI_STATUS
 

   @retval EFI_SUCCESS           The interface information for the specified protocol was returned.

   @retval EFI_UNSUPPORTED       The device does not support the specified protocol.

-  @retval EFI_INVALID_PARAMETER Handle is not a valid EFI_HANDLE.

+  @retval EFI_INVALID_PARAMETER Handle is NULL.

   @retval EFI_INVALID_PARAMETER Protocol is NULL.

   @retval EFI_INVALID_PARAMETER Interface is NULL.