Formalize comments for Protocols and PPIs.

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

/** @file\r
  UEFI Driver Family Protocol\r
\r
  Copyright (c) 2007 - 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
  http://opensource.org/licenses/bsd-license.php                                            \r
\r
  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
**/\r
\r
#ifndef __EFI_DRIVER_FAMILY_OVERRIDE_H__\r
#define __EFI_DRIVER_FAMILY_OVERRIDE_H__\r
\r
#define EFI_DRIVER_FAMILY_OVERRIDE_PROTOCOL_GUID \\r
  { \\r
    0xb1ee129e, 0xda36, 0x4181, { 0x91, 0xf8, 0x4, 0xa4, 0x92, 0x37, 0x66, 0xa7 } \\r
  }\r
  \r
typedef struct _EFI_DRIVER_FAMILY_OVERRIDE_PROTOCOL  EFI_DRIVER_FAMILY_OVERRIDE_PROTOCOL;\r
\r
//\r
// Prototypes for the Driver Family Override Protocol\r
//\r
// \r
/**                                                                 \r
  This function returns the version value associated with the driver specified by This.\r
\r
  Retrieves the version of the driver that is used by the EFI Boot Service ConnectController()\r
  to sort the set of Driver Binding Protocols in order from highest priority to lowest priority.\r
  For drivers that support the Driver Family Override Protocol, those drivers are sorted so that\r
  the drivers with higher values returned by GetVersion() are high priority that drivers that\r
  return lower values from GetVersion().\r
\r
  @param  This                  A pointer to the EFI_DRIVER_FAMILY_OVERRIDE_PROTOCOL instance.                            \r
                                \r
  @return The version value associated with the driver specified by This.                                  \r
                                   \r
**/\r
typedef\r
UINT32\r
(EFIAPI *EFI_DRIVER_FAMILY_OVERRIDE_GET_VERSION)(\r
  IN EFI_DRIVER_FAMILY_OVERRIDE_PROTOCOL    *This\r
  );\r
\r
///\r
/// When installed, the Driver Family Override Protocol produces a GUID that represets \r
/// a family of drivers.  Drivers with the same GUID are members of the same family \r
/// When drivers are connected to controllers, drivers with a higher revision value \r
/// in the same driver family are connected with a higher priority than drivers \r
/// with a lower revision value in the same driver family.  The EFI Boot Service\r
/// Connect Controller uses five rules to build a prioritied list of drivers when \r
/// a request is made to connect a driver to a controller.  The Driver Family Protocol\r
/// rule is between the Platform Specific Driver Override Protocol and above the \r
/// Bus Specific Driver Override Protocol.  \r
///\r
struct _EFI_DRIVER_FAMILY_OVERRIDE_PROTOCOL {\r
  EFI_DRIVER_FAMILY_OVERRIDE_GET_VERSION GetVersion;\r
};\r
\r
extern EFI_GUID gEfiDriverFamilyOverrideProtocolGuid;\r
\r
#endif\r