Code Scrub for Protocol and Ppi Definition

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

diff --git a/MdePkg/Include/Protocol/BusSpecificDriverOverride.h b/MdePkg/Include/Protocol/BusSpecificDriverOverride.h
index 1251236ac86a84f99d99f06e6d42691a1414986d..14d24d31c44fdf2c1d508f94c3e23263e259f0db 100644 (file)
--- a/MdePkg/Include/Protocol/BusSpecificDriverOverride.h
+++ b/MdePkg/Include/Protocol/BusSpecificDriverOverride.h
@@ -1,7 +1,12 @@
 /** @file\r
-  Bus Specific Driver Override protocol as defined in the EFI 1.1 specification.\r
+  Bus Specific Driver Override protocol as defined in the UEFI 2.0 specification.\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \r
+  Bus drivers that have a bus specific algorithm for matching drivers to controllers are\r
+  required to produce this protocol for each controller. For example, a PCI Bus Driver will produce an\r
+  instance of this protocol for every PCI controller that has a PCI option ROM that contains one or\r
+  more UEFI drivers. The protocol instance is attached to the handle of the PCI controller.\r
+\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
@@ -47,7 +52,7 @@ typedef struct _EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL  EFI_BUS_SPECIFIC_DRIV
 **/   \r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_GET_DRIVER) (\r
+(EFIAPI *EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_GET_DRIVER)(\r
   IN EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL              *This,\r
   IN OUT EFI_HANDLE                                         *DriverImageHandle\r
   );\r
@@ -55,6 +60,16 @@ EFI_STATUS
 //\r
 // Interface structure for the Bus Specific Driver Override Protocol\r
 //\r
+/**\r
+  @par Protocol Description:\r
+  This protocol matches one or more drivers to a controller. This protocol is produced by a bus driver,\r
+  and it is installed on the child handles of buses that require a bus specific algorithm for matching\r
+  drivers to controllers.\r
+\r
+  @param GetDriver\r
+  Uses a bus specific algorithm to retrieve a driver image handle for a controller.\r
+ \r
+**/\r
 struct _EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL {\r
   EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_GET_DRIVER GetDriver;\r
 };\r