Code Scrub for Protocol and Ppi Definition

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

diff --git a/MdePkg/Include/Protocol/PlatformDriverOverride.h b/MdePkg/Include/Protocol/PlatformDriverOverride.h
index 9138c8756a241bffde33249b6eaa8e8093b4855c..71e2a518978cc59f2a732781fd2838644bcac83f 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 EFI 1.1 specification.\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
@@ -50,7 +50,7 @@ typedef struct _EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL  EFI_PLATFORM_DRIVER_OVERR
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_PLATFORM_DRIVER_OVERRIDE_GET_DRIVER) (\r
+(EFIAPI *EFI_PLATFORM_DRIVER_OVERRIDE_GET_DRIVER)(\r
   IN EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL              *This,\r
   IN     EFI_HANDLE                                     ControllerHandle,\r
   IN OUT EFI_HANDLE                                     *DriverImageHandle\r
@@ -78,7 +78,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_PLATFORM_DRIVER_OVERRIDE_GET_DRIVER_PATH) (\r
+(EFIAPI *EFI_PLATFORM_DRIVER_OVERRIDE_GET_DRIVER_PATH)(\r
   IN EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL              *This,\r
   IN     EFI_HANDLE                                     ControllerHandle,\r
   IN OUT EFI_DEVICE_PATH_PROTOCOL                       **DriverImagePath\r
@@ -112,7 +112,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_PLATFORM_DRIVER_OVERRIDE_DRIVER_LOADED) (\r
+(EFIAPI *EFI_PLATFORM_DRIVER_OVERRIDE_DRIVER_LOADED)(\r
   IN EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL          *This,\r
   IN EFI_HANDLE                                     ControllerHandle,\r
   IN EFI_DEVICE_PATH_PROTOCOL                       *DriverImagePath,\r
@@ -122,6 +122,30 @@ EFI_STATUS
 //\r
 // Interface structure for the Platform Driver Override Protocol\r
 //\r
+/**  \r
+  @par Protocol Description:\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
+  @param GetDriver\r
+  Retrieves the image handle of a platform override driver for a controller in the system. \r
+\r
+  @param GetDriverPath\r
+  Retrieves the device path of a platform override driver for a controller in the system. \r
+\r
+  @param DriverLoaded\r
+  This function is used after a driver has been loaded using a device path returned \r
+  by GetDriverPath(). This function associates a device path to an image handle, \r
+  so the image handle can be returned the next time that GetDriver() is called for \r
+  the same controller. \r
+\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