Formalize comments for Protocols and PPIs.

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

diff --git a/MdePkg/Include/Protocol/BusSpecificDriverOverride.h b/MdePkg/Include/Protocol/BusSpecificDriverOverride.h
index c446940567de70c89e241b6030f2d8b51b108df5..83a87c6711d267f23b25df664032a0aa66b03c8f 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
@@ -10,16 +15,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:  BusSpecificDriverOverride.h\r
-\r
 **/\r
 \r
 #ifndef _EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL_H_\r
 #define _EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL_H_\r
 \r
-//\r
-// Global ID for the Bus Specific Driver Override Protocol\r
-//\r
+///\r
+/// Global ID for the Bus Specific Driver Override Protocol\r
+///\r
 #define EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL_GUID \\r
   { \\r
     0x3bc1b285, 0x8a15, 0x4a82, {0xaa, 0xbf, 0x4d, 0x7d, 0x13, 0xfb, 0x32, 0x65 } \\r
@@ -49,14 +52,16 @@ 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
 \r
-//\r
-// Interface structure for the Bus Specific Driver Override Protocol\r
-//\r
+///\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
 struct _EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL {\r
   EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_GET_DRIVER GetDriver;\r
 };\r