summaryrefslogtreecommitdiff
path: root/MdePkg/Include/Protocol/DriverFamilyOverride.h
diff options
context:
space:
mode:
Diffstat (limited to 'MdePkg/Include/Protocol/DriverFamilyOverride.h')
-rw-r--r--MdePkg/Include/Protocol/DriverFamilyOverride.h70
1 files changed, 70 insertions, 0 deletions
diff --git a/MdePkg/Include/Protocol/DriverFamilyOverride.h b/MdePkg/Include/Protocol/DriverFamilyOverride.h
new file mode 100644
index 0000000000..7295d9b825
--- /dev/null
+++ b/MdePkg/Include/Protocol/DriverFamilyOverride.h
@@ -0,0 +1,70 @@
+/** @file
+ EFI Driver Family Protocol
+
+ Copyright (c) 2007, Intel Corporation
+ All rights reserved. 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
+
+ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+
+**/
+
+#ifndef __EFI_DRIVER_FAMILY_OVERRIDE_H__
+#define __EFI_DRIVER_FAMILY_OVERRIDE_H__
+
+#define EFI_DRIVER_FAMILY_OVERRIDE_PROTOCOL_GUID \
+ { \
+ 0xb1ee129e, 0xda36, 0x4181, { 0x91, 0xf8, 0x4, 0xa4, 0x92, 0x37, 0x66, 0xa7 } \
+ }
+
+typedef struct _EFI_DRIVER_FAMILY_OVERRIDE_PROTOCOL EFI_DRIVER_FAMILY_OVERRIDE_PROTOCOL;
+
+//
+// Prototypes for the Driver Family Override Protocol
+//
+//
+/**
+ This function returns the version value associated with the driver specified by This.
+
+ Retrieves the version of the driver that is used by the EFI Boot Service ConnectController()
+ to sort the set of Driver Binding Protocols in order from highest priority to lowest priority.
+ For drivers that support the Driver Family Override Protocol, those drivers are sorted so that
+ the drivers with higher values returned by GetVersion() are high priority that drivers that
+ return lower values from GetVersion().
+
+ @param This A pointer to the EFI_DRIVER_FAMILY_OVERRIDE_PROTOCOL instance.
+
+ @return The version value associated with the driver specified by This.
+
+**/
+typedef
+UINT32
+(EFIAPI *EFI_DRIVER_FAMILY_OVERRIDE_GET_VERSION) (
+ IN EFI_DRIVER_FAMILY_OVERRIDE_PROTOCOL *This
+ );
+
+/**
+ When installed, the Driver Family Override Protocol produces a GUID that represets
+ a family of drivers. Drivers with the same GUID are members of the same family
+ When drivers are connected to controllers, drivers with a higher revision value
+ in the same driver family are connected with a higher priority than drivers
+ with a lower revision value in the same driver family. The EFI Boot Service
+ Connect Controller uses five rules to build a prioritied list of drivers when
+ a request is made to connect a driver to a controller. The Driver Family Protocol
+ rule is between the Platform Specific Driver Override Protocol and above the
+ Bus Specific Driver Override Protocol
+
+ @param FamilyGuid A pointer to the GUID that represnets the family of drivers
+ that the driver producing this protocol is a member.
+
+**/
+struct _EFI_DRIVER_FAMILY_OVERRIDE_PROTOCOL {
+ EFI_DRIVER_FAMILY_OVERRIDE_GET_VERSION GetVersion;
+};
+
+extern EFI_GUID gEfiDriverFamilyOverrideProtocolGuid;
+
+#endif