]>
Commit | Line | Data |
---|---|---|
1 | /** @file\r | |
2 | Bus Specific Driver Override protocol as defined in the UEFI 2.0 specification.\r | |
3 | \r | |
4 | Bus drivers that have a bus specific algorithm for matching drivers to controllers are\r | |
5 | required to produce this protocol for each controller. For example, a PCI Bus Driver will produce an\r | |
6 | instance of this protocol for every PCI controller that has a PCI option ROM that contains one or\r | |
7 | more UEFI drivers. The protocol instance is attached to the handle of the PCI controller.\r | |
8 | \r | |
9 | Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r | |
10 | SPDX-License-Identifier: BSD-2-Clause-Patent\r | |
11 | \r | |
12 | **/\r | |
13 | \r | |
14 | #ifndef _EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL_H_\r | |
15 | #define _EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL_H_\r | |
16 | \r | |
17 | ///\r | |
18 | /// Global ID for the Bus Specific Driver Override Protocol\r | |
19 | ///\r | |
20 | #define EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL_GUID \\r | |
21 | { \\r | |
22 | 0x3bc1b285, 0x8a15, 0x4a82, {0xaa, 0xbf, 0x4d, 0x7d, 0x13, 0xfb, 0x32, 0x65 } \\r | |
23 | }\r | |
24 | \r | |
25 | typedef struct _EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL;\r | |
26 | \r | |
27 | //\r | |
28 | // Prototypes for the Bus Specific Driver Override Protocol\r | |
29 | //\r | |
30 | \r | |
31 | /**\r | |
32 | Uses a bus specific algorithm to retrieve a driver image handle for a controller.\r | |
33 | \r | |
34 | @param This A pointer to the EFI_BUS_SPECIFIC_DRIVER_\r | |
35 | OVERRIDE_PROTOCOL instance.\r | |
36 | @param DriverImageHandle On input, a pointer to the previous driver image handle returned\r | |
37 | by GetDriver(). On output, a pointer to the next driver\r | |
38 | image handle. Passing in a NULL, will return the first driver\r | |
39 | image handle.\r | |
40 | \r | |
41 | @retval EFI_SUCCESS A bus specific override driver is returned in DriverImageHandle.\r | |
42 | @retval EFI_NOT_FOUND The end of the list of override drivers was reached.\r | |
43 | A bus specific override driver is not returned in DriverImageHandle.\r | |
44 | @retval EFI_INVALID_PARAMETER DriverImageHandle is not a handle that was returned on a\r | |
45 | previous call to GetDriver().\r | |
46 | \r | |
47 | **/\r | |
48 | typedef\r | |
49 | EFI_STATUS\r | |
50 | (EFIAPI *EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_GET_DRIVER)(\r | |
51 | IN EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL *This,\r | |
52 | IN OUT EFI_HANDLE *DriverImageHandle\r | |
53 | );\r | |
54 | \r | |
55 | ///\r | |
56 | /// This protocol matches one or more drivers to a controller. This protocol is produced by a bus driver,\r | |
57 | /// and it is installed on the child handles of buses that require a bus specific algorithm for matching\r | |
58 | /// drivers to controllers.\r | |
59 | ///\r | |
60 | struct _EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL {\r | |
61 | EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_GET_DRIVER GetDriver;\r | |
62 | };\r | |
63 | \r | |
64 | extern EFI_GUID gEfiBusSpecificDriverOverrideProtocolGuid;\r | |
65 | \r | |
66 | #endif\r |