From d9de7921820356119b178ee56fc50064c247265e Mon Sep 17 00:00:00 2001
From: niruiyu <niruiyu@6f19259b-4bc3-4df7-8a09-765794883524>
Date: Wed, 6 Jul 2011 03:44:35 +0000
Subject: [PATCH] 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@11985 6f19259b-4bc3-4df7-8a09-765794883524
---
 MdePkg/Include/Protocol/PlatformDriverOverride.h | 11 +++++------
 MdePkg/Include/Uefi/UefiSpec.h                   |  6 +++---
 2 files changed, 8 insertions(+), 9 deletions(-)

diff --git a/MdePkg/Include/Protocol/PlatformDriverOverride.h b/MdePkg/Include/Protocol/PlatformDriverOverride.h
index c9d55216ea..0fe42fc0a6 100644
--- a/MdePkg/Include/Protocol/PlatformDriverOverride.h
+++ b/MdePkg/Include/Protocol/PlatformDriverOverride.h
@@ -1,7 +1,7 @@
 /** @file
   Platform Driver Override protocol as defined in the UEFI 2.1 specification.
 
-  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        
@@ -43,7 +43,7 @@ typedef struct _EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL  EFI_PLATFORM_DRIVER_OVERR
   @retval EFI_SUCCESS           The driver override for ControllerHandle was returned in
                                 DriverImageHandle.                                      
   @retval EFI_NOT_FOUND         A driver override for ControllerHandle was not found.
-  @retval EFI_INVALID_PARAMETER The handle specified by ControllerHandle is not a valid handle.
+  @retval EFI_INVALID_PARAMETER The handle specified by ControllerHandle is NULL.
   @retval EFI_INVALID_PARAMETER DriverImageHandle is not a handle that was returned on a
                                 previous call to GetDriver().                           
                                    
@@ -59,8 +59,7 @@ EFI_STATUS
 /**                                                                 
   Retrieves the device path of the platform override driver for a controller in the system.
     
-  @param  This                  A pointer to the EFI_PLATFORM_DRIVER_OVERRIDE_
-                                PROTOCOL instance.                            
+  @param  This                  A pointer to the EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL instance.
   @param  ControllerHandle      The device handle of the controller to check if a driver override
                                 exists.                                                          
   @param  DriverImagePath       On input, a pointer to the previous driver device path returned by
@@ -72,7 +71,7 @@ EFI_STATUS
                                 DriverImageHandle.                                      
   @retval EFI_UNSUPPORTED       The operation is not supported.                                
   @retval EFI_NOT_FOUND         A driver override for ControllerHandle was not found.
-  @retval EFI_INVALID_PARAMETER The handle specified by ControllerHandle is not a valid handle.
+  @retval EFI_INVALID_PARAMETER The handle specified by ControllerHandle is NULL.
   @retval EFI_INVALID_PARAMETER DriverImagePath is not a device path that was returned on a
                                 previous call to GetDriverPath().                          
                                    
@@ -106,7 +105,7 @@ EFI_STATUS
   @retval EFI_NOT_FOUND         DriverImagePath is not a device path that was returned on a prior
                                 call to GetDriverPath() for the controller specified by          
                                 ControllerHandle.                                                
-  @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid device handle.
+  @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.
   @retval EFI_INVALID_PARAMETER DriverImagePath is not a valid device path.
   @retval EFI_INVALID_PARAMETER DriverImageHandle is not a valid image handle.
                                    
diff --git a/MdePkg/Include/Uefi/UefiSpec.h b/MdePkg/Include/Uefi/UefiSpec.h
index b6441c612a..7dbac451b2 100644
--- a/MdePkg/Include/Uefi/UefiSpec.h
+++ b/MdePkg/Include/Uefi/UefiSpec.h
@@ -306,7 +306,7 @@ EFI_STATUS
                                 2) On entry, no drivers are managing ControllerHandle.
                                 3) DriverImageHandle is not NULL, and on entry
                                    DriverImageHandle is not managing ControllerHandle.
-  @retval EFI_INVALID_PARAMETER 1) ControllerHandle is not a valid EFI_HANDLE.
+  @retval EFI_INVALID_PARAMETER 1) ControllerHandle is NULL.
                                 2) DriverImageHandle is not NULL, and it is not a valid EFI_HANDLE.
                                 3) ChildHandle is not NULL, and it is not a valid EFI_HANDLE.
                                 4) DriverImageHandle does not support the EFI_DRIVER_BINDING_PROTOCOL.
@@ -1304,8 +1304,8 @@ EFI_STATUS
                                 that required the protocol interface.
 
   @retval EFI_SUCCESS           The protocol instance was closed.
-  @retval EFI_INVALID_PARAMETER 1) Handle is not a valid EFI_HANDLE.
-                                2) AgentHandle is not a valid EFI_HANDLE.
+  @retval EFI_INVALID_PARAMETER 1) Handle is NULL.
+                                2) AgentHandle is NULL.
                                 3) ControllerHandle is not NULL and ControllerHandle is not a valid EFI_HANDLE.
                                 4) Protocol is NULL.
   @retval EFI_NOT_FOUND         1) Handle does not support the protocol specified by Protocol.