summaryrefslogtreecommitdiffstats
path: root/MdePkg/Include/Protocol/PlatformDriverOverride.h
diff options
context:
space:
mode:
Diffstat (limited to 'MdePkg/Include/Protocol/PlatformDriverOverride.h')
-rw-r--r--MdePkg/Include/Protocol/PlatformDriverOverride.h96
1 files changed, 48 insertions, 48 deletions
diff --git a/MdePkg/Include/Protocol/PlatformDriverOverride.h b/MdePkg/Include/Protocol/PlatformDriverOverride.h
index 0fe42fc0a6..ee97e060dc 100644
--- a/MdePkg/Include/Protocol/PlatformDriverOverride.h
+++ b/MdePkg/Include/Protocol/PlatformDriverOverride.h
@@ -1,14 +1,14 @@
/** @file
Platform Driver Override protocol as defined in the UEFI 2.1 specification.
- Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
- 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
+ Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
+ 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.
+ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
@@ -29,24 +29,24 @@ typedef struct _EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL EFI_PLATFORM_DRIVER_OVERR
// 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.
+ PROTOCOL instance.
@param ControllerHandle The device handle of the controller to check if a driver override
- exists.
+ 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.
-
+ by GetDriver(). On output, a pointer to the next driver
+ image handle.
+
@retval EFI_SUCCESS The driver override for ControllerHandle was returned in
- DriverImageHandle.
+ 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().
-
+ previous call to GetDriver().
+
**/
typedef
EFI_STATUS
@@ -56,25 +56,25 @@ EFI_STATUS
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.
+ 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.
+ 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().
-
+ previous call to GetDriverPath().
+
**/
typedef
EFI_STATUS
@@ -84,31 +84,31 @@ EFI_STATUS
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.
-
+ 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.
+ 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().
+ 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
+ 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.
+ 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.
+ 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
@@ -120,13 +120,13 @@ EFI_STATUS
);
///
-/// 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
+/// 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 {
generated by cgit v1.2.3 (git 2.25.1) at 2024-07-11 23:20:10 +0000