/** @file | |
Functions declaration for Bus Specific Driver Override protocol. | |
Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR> | |
SPDX-License-Identifier: BSD-2-Clause-Patent | |
**/ | |
#ifndef _EFI_PCI_DRIVER_OVERRRIDE_H_ | |
#define _EFI_PCI_DRIVER_OVERRRIDE_H_ | |
#define DRIVER_OVERRIDE_SIGNATURE SIGNATURE_32 ('d', 'r', 'o', 'v') | |
// | |
// PCI driver override driver image list | |
// | |
typedef struct { | |
UINT32 Signature; | |
LIST_ENTRY Link; | |
EFI_HANDLE DriverImageHandle; | |
EFI_DEVICE_PATH_PROTOCOL *DriverImagePath; | |
} PCI_DRIVER_OVERRIDE_LIST; | |
#define DRIVER_OVERRIDE_FROM_LINK(a) \ | |
CR (a, PCI_DRIVER_OVERRIDE_LIST, Link, DRIVER_OVERRIDE_SIGNATURE) | |
/** | |
Initializes a PCI Driver Override Instance. | |
@param PciIoDevice PCI Device instance. | |
**/ | |
VOID | |
InitializePciDriverOverrideInstance ( | |
IN OUT PCI_IO_DEVICE *PciIoDevice | |
); | |
/** | |
Add an overriding driver image. | |
@param PciIoDevice Instance of PciIo device. | |
@param DriverImageHandle Image handle of newly added driver image. | |
@param DriverImagePath Device path of newly added driver image. | |
@retval EFI_SUCCESS Successfully added driver. | |
@retval EFI_OUT_OF_RESOURCES No memory resource for new driver instance. | |
@retval other Some error occurred when locating gEfiLoadedImageProtocolGuid. | |
**/ | |
EFI_STATUS | |
AddDriver ( | |
IN PCI_IO_DEVICE *PciIoDevice, | |
IN EFI_HANDLE DriverImageHandle, | |
IN EFI_DEVICE_PATH_PROTOCOL *DriverImagePath | |
); | |
/** | |
Uses a bus specific algorithm to retrieve a driver image handle for a controller. | |
@param This A pointer to the EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL instance. | |
@param DriverImageHandle On 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. | |
@retval EFI_SUCCESS A bus specific override driver is returned in DriverImageHandle. | |
@retval EFI_NOT_FOUND The end of the list of override drivers was reached. | |
A bus specific override driver is not returned in DriverImageHandle. | |
@retval EFI_INVALID_PARAMETER DriverImageHandle is not a handle that was returned on a | |
previous call to GetDriver(). | |
**/ | |
EFI_STATUS | |
EFIAPI | |
GetDriver ( | |
IN EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL *This, | |
IN OUT EFI_HANDLE *DriverImageHandle | |
); | |
#endif |