9344f09215
https://bugzilla.tianocore.org/show_bug.cgi?id=1373 Replace BSD 2-Clause License with BSD+Patent License. This change is based on the following emails: https://lists.01.org/pipermail/edk2-devel/2019-February/036260.html https://lists.01.org/pipermail/edk2-devel/2018-October/030385.html RFCs with detailed process for the license change: V3: https://lists.01.org/pipermail/edk2-devel/2019-March/038116.html V2: https://lists.01.org/pipermail/edk2-devel/2019-March/037669.html V1: https://lists.01.org/pipermail/edk2-devel/2019-March/037500.html Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com> Reviewed-by: Liming Gao <liming.gao@intel.com>
135 lines
6.4 KiB
C
135 lines
6.4 KiB
C
/** @file
|
|
Platform Driver Override protocol as defined in the UEFI 2.1 specification.
|
|
|
|
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#ifndef __EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL_H__
|
|
#define __EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL_H__
|
|
|
|
///
|
|
/// Global ID for the Platform Driver Override Protocol
|
|
///
|
|
#define EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL_GUID \
|
|
{ \
|
|
0x6b30c738, 0xa391, 0x11d4, {0x9a, 0x3b, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \
|
|
}
|
|
|
|
typedef struct _EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL;
|
|
|
|
//
|
|
// Prototypes for the Platform Driver Override Protocol
|
|
//
|
|
|
|
/**
|
|
Retrieves the image handle of the platform override driver for a controller in the system.
|
|
|
|
@param This A pointer to the EFI_PLATFORM_DRIVER_OVERRIDE_
|
|
PROTOCOL instance.
|
|
@param ControllerHandle The device handle of the controller to check if a driver override
|
|
exists.
|
|
@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.
|
|
|
|
@retval EFI_SUCCESS The driver override for ControllerHandle was returned in
|
|
DriverImageHandle.
|
|
@retval EFI_NOT_FOUND A driver override for ControllerHandle was not found.
|
|
@retval EFI_INVALID_PARAMETER The handle specified by ControllerHandle is NULL.
|
|
@retval EFI_INVALID_PARAMETER DriverImageHandle is not a handle that was returned on a
|
|
previous call to GetDriver().
|
|
|
|
**/
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EFI_PLATFORM_DRIVER_OVERRIDE_GET_DRIVER)(
|
|
IN EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL *This,
|
|
IN EFI_HANDLE ControllerHandle,
|
|
IN OUT EFI_HANDLE *DriverImageHandle
|
|
);
|
|
|
|
/**
|
|
Retrieves the device path of the platform override driver for a controller in the system.
|
|
|
|
@param This A pointer to the EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL instance.
|
|
@param ControllerHandle The device handle of the controller to check if a driver override
|
|
exists.
|
|
@param DriverImagePath On input, a pointer to the previous driver device path returned by
|
|
GetDriverPath(). On output, a pointer to the next driver
|
|
device path. Passing in a pointer to NULL will return the first
|
|
driver device path for ControllerHandle.
|
|
|
|
@retval EFI_SUCCESS The driver override for ControllerHandle was returned in
|
|
DriverImageHandle.
|
|
@retval EFI_UNSUPPORTED The operation is not supported.
|
|
@retval EFI_NOT_FOUND A driver override for ControllerHandle was not found.
|
|
@retval EFI_INVALID_PARAMETER The handle specified by ControllerHandle is NULL.
|
|
@retval EFI_INVALID_PARAMETER DriverImagePath is not a device path that was returned on a
|
|
previous call to GetDriverPath().
|
|
|
|
**/
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EFI_PLATFORM_DRIVER_OVERRIDE_GET_DRIVER_PATH)(
|
|
IN EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL *This,
|
|
IN EFI_HANDLE ControllerHandle,
|
|
IN OUT EFI_DEVICE_PATH_PROTOCOL **DriverImagePath
|
|
);
|
|
|
|
/**
|
|
Used to associate a driver image handle with a device path that was returned on a prior call to the
|
|
GetDriverPath() service. This driver image handle will then be available through the
|
|
GetDriver() service.
|
|
|
|
@param This A pointer to the EFI_PLATFORM_DRIVER_OVERRIDE_
|
|
PROTOCOL instance.
|
|
@param ControllerHandle The device handle of the controller.
|
|
@param DriverImagePath A pointer to the driver device path that was returned in a prior
|
|
call to GetDriverPath().
|
|
@param DriverImageHandle The driver image handle that was returned by LoadImage()
|
|
when the driver specified by DriverImagePath was loaded
|
|
into memory.
|
|
|
|
@retval EFI_SUCCESS The association between DriverImagePath and
|
|
DriverImageHandle was established for the controller specified
|
|
by ControllerHandle.
|
|
@retval EFI_UNSUPPORTED The operation is not supported.
|
|
@retval EFI_NOT_FOUND DriverImagePath is not a device path that was returned on a prior
|
|
call to GetDriverPath() for the controller specified by
|
|
ControllerHandle.
|
|
@retval EFI_INVALID_PARAMETER ControllerHandle is NULL.
|
|
@retval EFI_INVALID_PARAMETER DriverImagePath is not a valid device path.
|
|
@retval EFI_INVALID_PARAMETER DriverImageHandle is not a valid image handle.
|
|
|
|
**/
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *EFI_PLATFORM_DRIVER_OVERRIDE_DRIVER_LOADED)(
|
|
IN EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL *This,
|
|
IN EFI_HANDLE ControllerHandle,
|
|
IN EFI_DEVICE_PATH_PROTOCOL *DriverImagePath,
|
|
IN EFI_HANDLE DriverImageHandle
|
|
);
|
|
|
|
///
|
|
/// This protocol matches one or more drivers to a controller. A platform driver
|
|
/// produces this protocol, and it is installed on a separate handle. This protocol
|
|
/// is used by the ConnectController() boot service to select the best driver
|
|
/// for a controller. All of the drivers returned by this protocol have a higher
|
|
/// precedence than drivers found from an EFI Bus Specific Driver Override Protocol
|
|
/// or drivers found from the general UEFI driver Binding search algorithm. If more
|
|
/// than one driver is returned by this protocol, then the drivers are returned in
|
|
/// order from highest precedence to lowest precedence.
|
|
///
|
|
struct _EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL {
|
|
EFI_PLATFORM_DRIVER_OVERRIDE_GET_DRIVER GetDriver;
|
|
EFI_PLATFORM_DRIVER_OVERRIDE_GET_DRIVER_PATH GetDriverPath;
|
|
EFI_PLATFORM_DRIVER_OVERRIDE_DRIVER_LOADED DriverLoaded;
|
|
};
|
|
|
|
extern EFI_GUID gEfiPlatformDriverOverrideProtocolGuid;
|
|
|
|
#endif
|