MdePkg/Include/Protocol/DriverFamilyOverride.h

   1 /** @file
   2   UEFI Driver Family Protocol
   3
   4   Copyright (c) 2007 - 2008, Intel Corporation
   5   All rights reserved. This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef __EFI_DRIVER_FAMILY_OVERRIDE_H__
  16 #define __EFI_DRIVER_FAMILY_OVERRIDE_H__
  17
  18 #define EFI_DRIVER_FAMILY_OVERRIDE_PROTOCOL_GUID \
  19   { \
  20     0xb1ee129e, 0xda36, 0x4181, { 0x91, 0xf8, 0x4, 0xa4, 0x92, 0x37, 0x66, 0xa7 } \
  21   }
  22
  23 typedef struct _EFI_DRIVER_FAMILY_OVERRIDE_PROTOCOL  EFI_DRIVER_FAMILY_OVERRIDE_PROTOCOL;
  24
  25 //
  26 // Prototypes for the Driver Family Override Protocol
  27 //
  28 //
  29 /**
  30   This function returns the version value associated with the driver specified by This.
  31
  32   Retrieves the version of the driver that is used by the EFI Boot Service ConnectController()
  33   to sort the set of Driver Binding Protocols in order from highest priority to lowest priority.
  34   For drivers that support the Driver Family Override Protocol, those drivers are sorted so that
  35   the drivers with higher values returned by GetVersion() are high priority that drivers that
  36   return lower values from GetVersion().
  37
  38   @param  This                  A pointer to the EFI_DRIVER_FAMILY_OVERRIDE_PROTOCOL instance.
  39
  40   @return The version value associated with the driver specified by This.
  41
  42 **/
  43 typedef
  44 UINT32
  45 (EFIAPI *EFI_DRIVER_FAMILY_OVERRIDE_GET_VERSION)(
  46   IN EFI_DRIVER_FAMILY_OVERRIDE_PROTOCOL    *This
  47   );
  48
  49 /**
  50   @par Protocol Description:
  51   When installed, the Driver Family Override Protocol produces a GUID that represets
  52   a family of drivers.  Drivers with the same GUID are members of the same family
  53   When drivers are connected to controllers, drivers with a higher revision value
  54   in the same driver family are connected with a higher priority than drivers
  55   with a lower revision value in the same driver family.  The EFI Boot Service
  56   Connect Controller uses five rules to build a prioritied list of drivers when
  57   a request is made to connect a driver to a controller.  The Driver Family Protocol
  58   rule is between the Platform Specific Driver Override Protocol and above the
  59   Bus Specific Driver Override Protocol.
  60
  61   @param GetVersion
  62   This function returns the version value associated with the driver specified by This.
  63
  64 **/
  65 struct _EFI_DRIVER_FAMILY_OVERRIDE_PROTOCOL {
  66   EFI_DRIVER_FAMILY_OVERRIDE_GET_VERSION GetVersion;
  67 };
  68
  69 extern EFI_GUID gEfiDriverFamilyOverrideProtocolGuid;
  70
  71 #endif