Update the Tpm12.h to the TCG TPM spec 1.2 revision

[mirror_edk2.git] / MdePkg / Include / Protocol / PlatformDriverOverride.h

diff --git a/MdePkg/Include/Protocol/PlatformDriverOverride.h b/MdePkg/Include/Protocol/PlatformDriverOverride.h
index fc3b5abb29dbb333f5ef722f2b65d135dc1d6c87..d11f431a1ab88a54816ce7cedc7a9a044bc4582a 100644 (file)
--- a/MdePkg/Include/Protocol/PlatformDriverOverride.h
+++ b/MdePkg/Include/Protocol/PlatformDriverOverride.h
@@ -1,7 +1,7 @@
 /** @file\r
   Platform Driver Override protocol as defined in the UEFI 2.1 specification.\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 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
@@ -15,9 +15,9 @@
 #ifndef __EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL_H__\r
 #define __EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL_H__\r
 \r
-//\r
-// Global ID for the Platform Driver Override Protocol\r
-//\r
+///\r
+/// Global ID for the Platform Driver Override Protocol\r
+///\r
 #define EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL_GUID \\r
   { \\r
     0x6b30c738, 0xa391, 0x11d4, {0x9a, 0x3b, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \\r
@@ -63,9 +63,10 @@ EFI_STATUS
                                 PROTOCOL instance.                            \r
   @param  ControllerHandle      The device handle of the controller to check if a driver override\r
                                 exists.                                                          \r
-  @param  DriverImageHandle     On input, a pointer to the previous driver image handle returned\r
-                                by GetDriverPath(). On output, a pointer to the next driver         \r
-                                device path.\r
+  @param  DriverImagePath       On input, a pointer to the previous driver device path returned by\r
+                                GetDriverPath(). On output, a pointer to the next driver\r
+                                device path. Passing in a pointer to NULL will return the first\r
+                                driver device path for ControllerHandle.\r
                                 \r
   @retval EFI_SUCCESS           The driver override for ControllerHandle was returned in\r
                                 DriverImageHandle.                                      \r
@@ -119,9 +120,16 @@ EFI_STATUS
   IN EFI_HANDLE                                     DriverImageHandle\r
   );\r
 \r
-//\r
-// Interface structure for the Platform Driver Override Protocol\r
-//\r
+///\r
+/// This protocol matches one or more drivers to a controller. A platform driver \r
+/// produces this protocol, and it is installed on a separate handle. This protocol \r
+/// is used by the ConnectController() boot service to select the best driver \r
+/// for a controller. All of the drivers returned by this protocol have a higher \r
+/// precedence than drivers found from an EFI Bus Specific Driver Override Protocol \r
+/// or drivers found from the general UEFI driver Binding search algorithm. If more \r
+/// than one driver is returned by this protocol, then the drivers are returned in \r
+/// order from highest precedence to lowest precedence.\r
+///\r
 struct _EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL {\r
   EFI_PLATFORM_DRIVER_OVERRIDE_GET_DRIVER       GetDriver;\r
   EFI_PLATFORM_DRIVER_OVERRIDE_GET_DRIVER_PATH  GetDriverPath;\r