Update the copyright notice format

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

diff --git a/MdePkg/Include/Protocol/PlatformDriverOverride.h b/MdePkg/Include/Protocol/PlatformDriverOverride.h
index 1015c50d3ea6e5607d308c3f53365c77d96c90b7..c9d55216ea0edd1e9fac97dc8b87926cbf1975d3 100644 (file)
--- a/MdePkg/Include/Protocol/PlatformDriverOverride.h
+++ b/MdePkg/Include/Protocol/PlatformDriverOverride.h
@@ -1,8 +1,8 @@
 /** @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
-  All rights reserved. This program and the accompanying materials                          \r
+  Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
+  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
   http://opensource.org/licenses/bsd-license.php                                            \r
@@ -10,16 +10,14 @@
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
 \r
-  Module Name:  PlatformDriverOverride.h\r
-\r
 **/\r
 \r
 #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
@@ -52,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
@@ -65,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
@@ -80,7 +79,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
@@ -114,16 +113,23 @@ 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
   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