iPXE
BusSpecificDriverOverride.h
Go to the documentation of this file.
1 /** @file
2  Bus Specific Driver Override protocol as defined in the UEFI 2.0 specification.
3 
4  Bus drivers that have a bus specific algorithm for matching drivers to controllers are
5  required to produce this protocol for each controller. For example, a PCI Bus Driver will produce an
6  instance of this protocol for every PCI controller that has a PCI option ROM that contains one or
7  more UEFI drivers. The protocol instance is attached to the handle of the PCI controller.
8 
9  Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>
10  This program and the accompanying materials
11  are licensed and made available under the terms and conditions of the BSD License
12  which accompanies this distribution. The full text of the license may be found at
13  http://opensource.org/licenses/bsd-license.php
14 
15  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
16  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 
18 **/
19 
20 #ifndef _EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL_H_
21 #define _EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL_H_
22 
23 FILE_LICENCE ( BSD3 );
24 
25 ///
26 /// Global ID for the Bus Specific Driver Override Protocol
27 ///
28 #define EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL_GUID \
29  { \
30  0x3bc1b285, 0x8a15, 0x4a82, {0xaa, 0xbf, 0x4d, 0x7d, 0x13, 0xfb, 0x32, 0x65 } \
31  }
32 
34 
35 //
36 // Prototypes for the Bus Specific Driver Override Protocol
37 //
38 
39 /**
40  Uses a bus specific algorithm to retrieve a driver image handle for a controller.
41 
42  @param This A pointer to the EFI_BUS_SPECIFIC_DRIVER_
43  OVERRIDE_PROTOCOL instance.
44  @param DriverImageHandle On input, a pointer to the previous driver image handle returned
45  by GetDriver(). On output, a pointer to the next driver
46  image handle. Passing in a NULL, will return the first driver
47  image handle.
48 
49  @retval EFI_SUCCESS A bus specific override driver is returned in DriverImageHandle.
50  @retval EFI_NOT_FOUND The end of the list of override drivers was reached.
51  A bus specific override driver is not returned in DriverImageHandle.
52  @retval EFI_INVALID_PARAMETER DriverImageHandle is not a handle that was returned on a
53  previous call to GetDriver().
54 
55 **/
56 typedef
60  IN OUT EFI_HANDLE *DriverImageHandle
61  );
62 
63 ///
64 /// This protocol matches one or more drivers to a controller. This protocol is produced by a bus driver,
65 /// and it is installed on the child handles of buses that require a bus specific algorithm for matching
66 /// drivers to controllers.
67 ///
70 };
71 
73 
74 #endif
FILE_LICENCE(BSD3)
EFI_GUID gEfiBusSpecificDriverOverrideProtocolGuid
128 bit buffer containing a unique identifier value.
Definition: Base.h:263
EFI_STATUS(EFIAPI * EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_GET_DRIVER)(IN EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL *This, IN OUT EFI_HANDLE *DriverImageHandle)
Uses a bus specific algorithm to retrieve a driver image handle for a controller.
#define OUT
Definition: mlx_utils.h:29
This protocol matches one or more drivers to a controller.
#define EFIAPI
#define IN
Definition: mlx_utils.h:28
RETURN_STATUS EFI_STATUS
Function return status for EFI API.
Definition: UefiBaseType.h:35
EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_GET_DRIVER GetDriver
Definition: efi.h:55