- Generated on Fri Nov 15 2024 18:01:35 for TianoCore EDK2 by
1.9.6
|
TianoCore EDK2 master
|
#include <Protocol/DriverConfiguration2.h>Go to the source code of this file.
Data Structures | |
| struct | _EFI_DRIVER_CONFIGURATION_PROTOCOL |
Macros | |
| #define | EFI_DRIVER_CONFIGURATION_PROTOCOL_GUID |
Typedefs | |
| typedef struct _EFI_DRIVER_CONFIGURATION_PROTOCOL | EFI_DRIVER_CONFIGURATION_PROTOCOL |
| typedef EFI_STATUS(EFIAPI * | EFI_DRIVER_CONFIGURATION_SET_OPTIONS) (IN EFI_DRIVER_CONFIGURATION_PROTOCOL *This, IN EFI_HANDLE ControllerHandle, IN EFI_HANDLE ChildHandle OPTIONAL, IN CHAR8 *Language, OUT EFI_DRIVER_CONFIGURATION_ACTION_REQUIRED *ActionRequired) |
| typedef EFI_STATUS(EFIAPI * | EFI_DRIVER_CONFIGURATION_OPTIONS_VALID) (IN EFI_DRIVER_CONFIGURATION_PROTOCOL *This, IN EFI_HANDLE ControllerHandle, IN EFI_HANDLE ChildHandle OPTIONAL) |
| typedef EFI_STATUS(EFIAPI * | EFI_DRIVER_CONFIGURATION_FORCE_DEFAULTS) (IN EFI_DRIVER_CONFIGURATION_PROTOCOL *This, IN EFI_HANDLE ControllerHandle, IN EFI_HANDLE ChildHandle OPTIONAL, IN UINT32 DefaultType, OUT EFI_DRIVER_CONFIGURATION_ACTION_REQUIRED *ActionRequired) |
Variables | |
| EFI_GUID | gEfiDriverConfigurationProtocolGuid |
EFI Driver Configuration Protocol
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent
Definition in file DriverConfiguration.h.
| #define EFI_DRIVER_CONFIGURATION_PROTOCOL_GUID |
Global ID for the Driver Configuration Protocol defined in EFI 1.1
Definition at line 17 of file DriverConfiguration.h.
| typedef EFI_STATUS(EFIAPI * EFI_DRIVER_CONFIGURATION_FORCE_DEFAULTS) (IN EFI_DRIVER_CONFIGURATION_PROTOCOL *This, IN EFI_HANDLE ControllerHandle, IN EFI_HANDLE ChildHandle OPTIONAL, IN UINT32 DefaultType, OUT EFI_DRIVER_CONFIGURATION_ACTION_REQUIRED *ActionRequired) |
Forces a driver to set the default configuration options for a controller.
| This | A pointer to the EFI_DRIVER_CONFIGURATION_PROTOCOL instance. |
| ControllerHandle | The handle of the controller to force default configuration options on. |
| ChildHandle | The handle of the child controller to force default configuration options on This is an optional parameter that may be NULL. It will be NULL for device drivers. It will also be NULL for bus drivers that wish to force default configuration options for the bus controller. It will not be NULL for a bus driver that wishes to force default configuration options for one of its child controllers. |
| DefaultType | The type of default configuration options to force on the controller specified by ControllerHandle and ChildHandle. See Table 9-1 for legal values. A DefaultType of 0x00000000 must be supported by this protocol. |
| ActionRequired | A pointer to the action that the calling agent is required to perform when this function returns. See "Related Definitions" in Section 9.1 for a list of the actions that the calling agent is required to perform prior to accessing ControllerHandle again. |
| EFI_SUCCESS | The driver specified by This successfully forced the default configuration options on the controller specified by ControllerHandle and ChildHandle. |
| EFI_INVALID_PARAMETER | ControllerHandle is not a valid EFI_HANDLE. |
| EFI_INVALID_PARAMETER | ChildHandle is not NULL and it is not a valid EFI_HANDLE. |
| EFI_INVALID_PARAMETER | ActionRequired is NULL. |
| EFI_UNSUPPORTED | The driver specified by This does not support forcing the default configuration options on the controller specified by ControllerHandle and ChildHandle. |
| EFI_UNSUPPORTED | The driver specified by This does not support the configuration type specified by DefaultType. |
| EFI_DEVICE_ERROR | A device error occurred while attempt to force the default configuration options on the controller specified by ControllerHandle and ChildHandle. |
| EFI_OUT_RESOURCES | There are not enough resources available to force the default configuration options on the controller specified by ControllerHandle and ChildHandle. |
Definition at line 133 of file DriverConfiguration.h.
| typedef EFI_STATUS(EFIAPI * EFI_DRIVER_CONFIGURATION_OPTIONS_VALID) (IN EFI_DRIVER_CONFIGURATION_PROTOCOL *This, IN EFI_HANDLE ControllerHandle, IN EFI_HANDLE ChildHandle OPTIONAL) |
Tests to see if a controller's current configuration options are valid.
| This | A pointer to the EFI_DRIVER_CONFIGURATION_PROTOCOL instance. |
| ControllerHandle | The handle of the controller to test if it's current configuration options are valid. |
| ChildHandle | The handle of the child controller to test if it's current configuration options are valid. This is an optional parameter that may be NULL. It will be NULL for device drivers. It will also be NULL for bus drivers that wish to test the configuration options for the bus controller. It will not be NULL for a bus driver that wishes to test configuration options for one of its child controllers. |
| EFI_SUCCESS | The controller specified by ControllerHandle and ChildHandle that is being managed by the driver specified by This has a valid set of configuration options. |
| EFI_INVALID_PARAMETER | ControllerHandle is not a valid EFI_HANDLE. |
| EFI_INVALID_PARAMETER | ChildHandle is not NULL and it is not a valid EFI_HANDLE. |
| EFI_UNSUPPORTED | The driver specified by This is not currently managing the controller specified by ControllerHandle and ChildHandle. |
| EFI_DEVICE_ERROR | The controller specified by ControllerHandle and ChildHandle that is being managed by the driver specified by This has an invalid set of configuration options. |
Definition at line 106 of file DriverConfiguration.h.
Definition at line 22 of file DriverConfiguration.h.
| typedef EFI_STATUS(EFIAPI * EFI_DRIVER_CONFIGURATION_SET_OPTIONS) (IN EFI_DRIVER_CONFIGURATION_PROTOCOL *This, IN EFI_HANDLE ControllerHandle, IN EFI_HANDLE ChildHandle OPTIONAL, IN CHAR8 *Language, OUT EFI_DRIVER_CONFIGURATION_ACTION_REQUIRED *ActionRequired) |
Allows the user to set controller specific options for a controller that a driver is currently managing.
| This | A pointer to the EFI_DRIVER_CONFIGURATION_PROTOCOL instance. |
| ControllerHandle | The handle of the controller to set options on. |
| ChildHandle | The handle of the child controller to set options on. This is an optional parameter that may be NULL. It will be NULL for device drivers, and for bus drivers that wish to set options for the bus controller. It will not be NULL for a bus driver that wishes to set options for one of its child controllers. |
| Language | A pointer to a three character ISO 639-2 language identifier. This is the language of the user interface that should be presented to the user, and it must match one of the languages specified in SupportedLanguages. The number of languages supported by a driver is up to the driver writer. |
| ActionRequired | A pointer to the action that the calling agent is required to perform when this function returns. See "Related Definitions" for a list of the actions that the calling agent is required to perform prior to accessing ControllerHandle again. |
| EFI_SUCCESS | The driver specified by This successfully set the configuration options for the controller specified by ControllerHandle.. |
| EFI_INVALID_PARAMETER | ControllerHandle is not a valid EFI_HANDLE. |
| EFI_INVALID_PARAMETER | ChildHandle is not NULL and it is not a valid EFI_HANDLE. |
| EFI_INVALID_PARAMETER | ActionRequired is NULL. |
| EFI_UNSUPPORTED | The driver specified by This does not support setting configuration options for the controller specified by ControllerHandle and ChildHandle. |
| EFI_UNSUPPORTED | The driver specified by This does not support the language specified by Language. |
| EFI_DEVICE_ERROR | A device error occurred while attempt to set the configuration options for the controller specified by ControllerHandle and ChildHandle. |
| EFI_OUT_RESOURCES | There are not enough resources available to set the configuration options for the controller specified by ControllerHandle and ChildHandle. |
Definition at line 67 of file DriverConfiguration.h.
1.9.6