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