PlatformDriverOverride.h File Reference

Go to the source code of this file.

Classes
struct	_EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL

Macros
#define	EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL_GUID

Typedefs
typedef struct _EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL	EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL
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)
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)
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)

Variables
EFI_GUID	gEfiPlatformDriverOverrideProtocolGuid

Detailed Description

Platform Driver Override protocol as defined in the UEFI 2.1 specification.

Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Macro Definition Documentation

EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL_GUID

#define EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL_GUID

Value:

  { \
    0x6b30c738, 0xa391, 0x11d4, {0x9a, 0x3b, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \
  }

Global ID for the Platform Driver Override Protocol

Typedef Documentation

EFI_PLATFORM_DRIVER_OVERRIDE_DRIVER_LOADED

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)

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.

Parameters

This	A pointer to the EFI_PLATFORM_DRIVER_OVERRIDE_ PROTOCOL instance.
ControllerHandle	The device handle of the controller.
DriverImagePath	A pointer to the driver device path that was returned in a prior call to GetDriverPath().
DriverImageHandle	The driver image handle that was returned by LoadImage() when the driver specified by DriverImagePath was loaded into memory.

Return values

EFI_SUCCESS	The association between DriverImagePath and DriverImageHandle was established for the controller specified by ControllerHandle.
EFI_UNSUPPORTED	The operation is not supported.
EFI_NOT_FOUND	DriverImagePath is not a device path that was returned on a prior call to GetDriverPath() for the controller specified by ControllerHandle.
EFI_INVALID_PARAMETER	ControllerHandle is NULL.
EFI_INVALID_PARAMETER	DriverImagePath is not a valid device path.
EFI_INVALID_PARAMETER	DriverImageHandle is not a valid image handle.

EFI_PLATFORM_DRIVER_OVERRIDE_GET_DRIVER

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 image handle of the platform override driver for a controller in the system.

Parameters

This	A pointer to the EFI_PLATFORM_DRIVER_OVERRIDE_ PROTOCOL instance.
ControllerHandle	The device handle of the controller to check if a driver override exists.
DriverImageHandle	On input, a pointer to the previous driver image handle returned by GetDriver(). On output, a pointer to the next driver image handle.

Return values

EFI_SUCCESS	The driver override for ControllerHandle was returned in DriverImageHandle.
EFI_NOT_FOUND	A driver override for ControllerHandle was not found.
EFI_INVALID_PARAMETER	The handle specified by ControllerHandle is NULL.
EFI_INVALID_PARAMETER	DriverImageHandle is not a handle that was returned on a previous call to GetDriver().

EFI_PLATFORM_DRIVER_OVERRIDE_GET_DRIVER_PATH

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)

Retrieves the device path of the platform override driver for a controller in the system.

Parameters

This	A pointer to the EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL instance.
ControllerHandle	The device handle of the controller to check if a driver override exists.
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.

Return values

EFI_SUCCESS	The driver override for ControllerHandle was returned in DriverImageHandle.
EFI_UNSUPPORTED	The operation is not supported.
EFI_NOT_FOUND	A driver override for ControllerHandle was not found.
EFI_INVALID_PARAMETER	The handle specified by ControllerHandle is NULL.
EFI_INVALID_PARAMETER	DriverImagePath is not a device path that was returned on a previous call to GetDriverPath().

EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL

typedef struct _EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL

Variable Documentation

gEfiPlatformDriverOverrideProtocolGuid

EFI_GUID gEfiPlatformDriverOverrideProtocolGuid

extern