MdePkg[all]  1.08
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
BusSpecificDriverOverride.h File Reference

Data Structures

struct  _EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL
 

Macros

#define EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL_GUID
 

Typedefs

typedef struct
_EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL 
EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL
 
typedef EFI_STATUS(EFIAPIEFI_BUS_SPECIFIC_DRIVER_OVERRIDE_GET_DRIVER )(IN EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL *This, IN OUT EFI_HANDLE *DriverImageHandle)
 

Variables

EFI_GUID gEfiBusSpecificDriverOverrideProtocolGuid
 

Detailed Description

Bus Specific Driver Override protocol as defined in the UEFI 2.0 specification.

Bus drivers that have a bus specific algorithm for matching drivers to controllers are required to produce this protocol for each controller. For example, a PCI Bus Driver will produce an instance of this protocol for every PCI controller that has a PCI option ROM that contains one or more UEFI drivers. The protocol instance is attached to the handle of the PCI controller.

Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Macro Definition Documentation

#define EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL_GUID
Value:
{ \
0x3bc1b285, 0x8a15, 0x4a82, {0xaa, 0xbf, 0x4d, 0x7d, 0x13, 0xfb, 0x32, 0x65 } \
}

Global ID for the Bus Specific Driver Override Protocol

Typedef Documentation

typedef 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.

Parameters
ThisA pointer to the EFI_BUS_SPECIFIC_DRIVER_ OVERRIDE_PROTOCOL instance.
DriverImageHandleOn input, a pointer to the previous driver image handle returned by GetDriver(). On output, a pointer to the next driver image handle. Passing in a NULL, will return the first driver image handle.
Return values
EFI_SUCCESSA bus specific override driver is returned in DriverImageHandle.
EFI_NOT_FOUNDThe end of the list of override drivers was reached. A bus specific override driver is not returned in DriverImageHandle.
EFI_INVALID_PARAMETERDriverImageHandle is not a handle that was returned on a previous call to GetDriver().

Variable Documentation

EFI_GUID gEfiBusSpecificDriverOverrideProtocolGuid