X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=MdePkg%2FInclude%2FProtocol%2FBusSpecificDriverOverride.h;h=2e7f1cc52293717d354982d654cb4df316fe9e92;hb=be85bf89b35a6335fd495f869f4bbcc6de233ac4;hp=1c3fe35c4708bf710445323a255809861d1d9c85;hpb=8b13229b469f05ec22d76098b052bd6e943fecee;p=mirror_edk2.git

diff --git a/MdePkg/Include/Protocol/BusSpecificDriverOverride.h b/MdePkg/Include/Protocol/BusSpecificDriverOverride.h
index 1c3fe35c47..2e7f1cc522 100644
--- a/MdePkg/Include/Protocol/BusSpecificDriverOverride.h
+++ b/MdePkg/Include/Protocol/BusSpecificDriverOverride.h
@@ -1,8 +1,13 @@
 /** @file
   Bus Specific Driver Override protocol as defined in the UEFI 2.0 specification.
 
-  Copyright (c) 2006, Intel Corporation                                                         
-  All rights reserved. This program and the accompanying materials                          
+  Bus drivers that have a bus specific algorithm for matching drivers to controllers are
+  required to produce this protocol for each controller. For example, a PCI Bus Driver will produce an
+  instance of this protocol for every PCI controller that has a PCI option ROM that contains one or
+  more UEFI drivers. The protocol instance is attached to the handle of the PCI controller.
+
+  Copyright (c) 2006 - 2008, 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        
   http://opensource.org/licenses/bsd-license.php                                            
@@ -15,9 +20,9 @@
 #ifndef _EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL_H_
 #define _EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL_H_
 
-//
-// Global ID for the Bus Specific Driver Override Protocol
-//
+///
+/// Global ID for the Bus Specific Driver Override Protocol
+///
 #define EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL_GUID \
   { \
     0x3bc1b285, 0x8a15, 0x4a82, {0xaa, 0xbf, 0x4d, 0x7d, 0x13, 0xfb, 0x32, 0x65 } \
@@ -37,14 +42,15 @@ typedef struct _EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL  EFI_BUS_SPECIFIC_DRIV
   @param  DriverImageHandle     On input, a pointer to the previous driver image handle returned
                                 by GetDriver(). On output, a pointer to the next driver         
                                 image handle. Passing in a NULL, will return the first driver   
-                                image handle.                                                     
-                                
+                                image handle.
+
   @retval EFI_SUCCESS           A bus specific override driver is returned in DriverImageHandle.
   @retval EFI_NOT_FOUND         The end of the list of override drivers was reached.
+                                A bus specific override driver is not returned in DriverImageHandle.
   @retval EFI_INVALID_PARAMETER DriverImageHandle is not a handle that was returned on a
-                                previous call to GetDriver().                           
-                                   
-**/   
+                                previous call to GetDriver().
+
+**/
 typedef
 EFI_STATUS
 (EFIAPI *EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_GET_DRIVER)(
@@ -52,9 +58,11 @@ EFI_STATUS
   IN OUT EFI_HANDLE                                         *DriverImageHandle
   );
 
-//
-// Interface structure for the Bus Specific Driver Override Protocol
-//
+///
+/// This protocol matches one or more drivers to a controller. This protocol is produced by a bus driver,
+/// and it is installed on the child handles of buses that require a bus specific algorithm for matching
+/// drivers to controllers.
+///
 struct _EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL {
   EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_GET_DRIVER GetDriver;
 };