/** @file\r
- EFI Driver Configuration Protocol\r
+ UEFI Driver Configuration2 Protocol\r
\r
- Copyright (c) 2006, Intel Corporation \r
- All rights reserved. This program and the accompanying materials \r
- are licensed and made available under the terms and conditions of the BSD License \r
- which accompanies this distribution. The full text of the license may be found at \r
- http://opensource.org/licenses/bsd-license.php \r
+ Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+ This program and the accompanying materials\r
+ are licensed and made available under the terms and conditions of the BSD License\r
+ which accompanies this distribution. The full text of the license may be found at\r
+ http://opensource.org/licenses/bsd-license.php\r
\r
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
+ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef __EFI_DRIVER_CONFIGURATION2_H__\r
#define __EFI_DRIVER_CONFIGURATION2_H__\r
\r
-//\r
-// Global ID for the Driver Configuration Protocol defined in UEFI 2.0\r
-//\r
+///\r
+/// Global ID for the Driver Configuration Protocol defined in UEFI 2.0\r
+///\r
#define EFI_DRIVER_CONFIGURATION2_PROTOCOL_GUID \\r
{ \\r
0xbfd7dc1d, 0x24f1, 0x40d9, {0x82, 0xe7, 0x2e, 0x09, 0xbb, 0x6b, 0x4e, 0xbe } \\r
}\r
- \r
+\r
typedef struct _EFI_DRIVER_CONFIGURATION2_PROTOCOL EFI_DRIVER_CONFIGURATION2_PROTOCOL;\r
\r
typedef enum {\r
+ ///\r
+ /// The controller is still in a usable state. No actions\r
+ /// are required before this controller can be used again.\r
+ ///\r
EfiDriverConfigurationActionNone = 0,\r
+ ///\r
+ /// The driver has detected that the controller is not in a\r
+ /// usable state, and it needs to be stopped.\r
+ ///\r
EfiDriverConfigurationActionStopController = 1,\r
+ ///\r
+ /// This controller needs to be stopped and restarted\r
+ /// before it can be used again.\r
+ ///\r
EfiDriverConfigurationActionRestartController = 2,\r
+ ///\r
+ /// A configuration change has been made that requires the platform to be restarted before\r
+ /// the controller can be used again.\r
+ ///\r
EfiDriverConfigurationActionRestartPlatform = 3,\r
EfiDriverConfigurationActionMaximum\r
} EFI_DRIVER_CONFIGURATION_ACTION_REQUIRED;\r
#define EFI_DRIVER_CONFIGURATION_PERORMANCE_DEFAULTS 0x00000003\r
\r
/**\r
- Allows the user to set controller specific options for a controller that a \r
+ Allows the user to set controller specific options for a controller that a\r
driver is currently managing.\r
\r
- @param This A pointer to the EFI_DRIVER_CONFIGURATION_ PROTOCOL instance.\r
+ @param This A pointer to the EFI_DRIVER_CONFIGURATION2_PROTOCOL instance.\r
@param ControllerHandle The handle of the controller to set options on.\r
@param ChildHandle The handle of the child controller to set options on. This\r
is an optional parameter that may be NULL. It will be NULL\r
- for device drivers, and for a bus drivers that wish to set\r
+ for device drivers, and for bus drivers that wish to set\r
options for the bus controller. It will not be NULL for a\r
bus driver that wishes to set options for one of its child\r
controllers.\r
- @param Language A pointer to a three character ISO 639-2 language identifier.\r
- This is the language of the user interface that should be\r
- presented to the user, and it must match one of the languages\r
- specified in SupportedLanguages. The number of languages\r
+ @param Language A Null-terminated ASCII string that contains one or more RFC 4646\r
+ language codes. This is the list of language codes that this\r
+ protocol supports. The number of languages\r
supported by a driver is up to the driver writer.\r
@param ActionRequired A pointer to the action that the calling agent is required\r
to perform when this function returns. See "Related\r
\r
@retval EFI_SUCCESS The driver specified by This successfully set the\r
configuration options for the controller specified\r
- by ControllerHandle..\r
+ by ControllerHandle.\r
@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE.\r
@retval EFI_INVALID_PARAMETER ActionRequired is NULL.\r
ControllerHandle and ChildHandle.\r
@retval EFI_UNSUPPORTED The driver specified by This does not support the\r
language specified by Language.\r
- @retval EFI_DEVICE_ERROR A device error occurred while attempt to set the\r
+ @retval EFI_DEVICE_ERROR A device error occurred while attempting to set the\r
configuration options for the controller specified\r
by ControllerHandle and ChildHandle.\r
@retval EFI_OUT_RESOURCES There are not enough resources available to set the\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_DRIVER_CONFIGURATION2_SET_OPTIONS) (\r
+(EFIAPI *EFI_DRIVER_CONFIGURATION2_SET_OPTIONS)(\r
IN EFI_DRIVER_CONFIGURATION2_PROTOCOL *This,\r
IN EFI_HANDLE ControllerHandle,\r
IN EFI_HANDLE ChildHandle OPTIONAL,\r
/**\r
Tests to see if a controller's current configuration options are valid.\r
\r
- @param This A pointer to the EFI_DRIVER_CONFIGURATION_PROTOCOL instance.\r
+ @param This A pointer to the EFI_DRIVER_CONFIGURATION2_PROTOCOL instance.\r
@param ControllerHandle The handle of the controller to test if it's current\r
configuration options are valid.\r
@param ChildHandle The handle of the child controller to test if it's current\r
configuration options are valid. This is an optional\r
parameter that may be NULL. It will be NULL for device\r
- drivers. It will also be NULL for a bus drivers that wish\r
+ drivers. It will also be NULL for bus drivers that wish\r
to test the configuration options for the bus controller.\r
It will not be NULL for a bus driver that wishes to test\r
configuration options for one of its child controllers.\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_DRIVER_CONFIGURATION2_OPTIONS_VALID) (\r
+(EFIAPI *EFI_DRIVER_CONFIGURATION2_OPTIONS_VALID)(\r
IN EFI_DRIVER_CONFIGURATION2_PROTOCOL *This,\r
IN EFI_HANDLE ControllerHandle,\r
IN EFI_HANDLE ChildHandle OPTIONAL\r
/**\r
Forces a driver to set the default configuration options for a controller.\r
\r
- @param This A pointer to the EFI_DRIVER_CONFIGURATION_ PROTOCOL instance.\r
+ @param This A pointer to the EFI_DRIVER_CONFIGURATION2_PROTOCOL instance.\r
@param ControllerHandle The handle of the controller to force default configuration options on.\r
- @param 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 a 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.\r
+ @param 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.\r
@param 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.\r
- @param ActionRequired A pointer to the action that the calling agent is required to perform when this function returns. See "Related Definitions" in Section 9.1for a list of the actions that the calling agent is required to perform prior to accessing ControllerHandle again.\r
+ @param 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.\r
\r
@retval EFI_SUCCESS The driver specified by This successfully forced the default configuration options on the controller specified by ControllerHandle and ChildHandle.\r
@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_DRIVER_CONFIGURATION2_FORCE_DEFAULTS) (\r
+(EFIAPI *EFI_DRIVER_CONFIGURATION2_FORCE_DEFAULTS)(\r
IN EFI_DRIVER_CONFIGURATION2_PROTOCOL *This,\r
IN EFI_HANDLE ControllerHandle,\r
IN EFI_HANDLE ChildHandle OPTIONAL,\r
OUT EFI_DRIVER_CONFIGURATION_ACTION_REQUIRED *ActionRequired\r
);\r
\r
-\r
-//\r
-//\r
+///\r
+/// Used to set configuration options for a controller that an EFI Driver is managing.\r
+///\r
struct _EFI_DRIVER_CONFIGURATION2_PROTOCOL {\r
EFI_DRIVER_CONFIGURATION2_SET_OPTIONS SetOptions;\r
EFI_DRIVER_CONFIGURATION2_OPTIONS_VALID OptionsValid;\r
EFI_DRIVER_CONFIGURATION2_FORCE_DEFAULTS ForceDefaults;\r
+ ///\r
+ /// A Null-terminated ASCII string that contains one or more RFC 4646\r
+ /// language codes. This is the list of language codes that this protocol supports.\r
+ ///\r
CHAR8 *SupportedLanguages;\r
};\r
\r
-/**\r
- Interface structure for the Driver Configuration Protocol.\r
-\r
- @par Protocol Description: \r
- Used to set configuration options for a controller that an EFI Driver is managing.\r
-\r
- @param SetOptions Allows the use to set drivers specific configuration \r
- options for a controller that the driver is currently managing.\r
- \r
- @param OptionsValid Tests to see if a controller's current configuration \r
- options are valid. \r
- \r
- @param ForceDefaults Forces a driver to set the default configuration options \r
- for a controller.\r
-\r
- @param SupportedLanguages A Null-terminated ASCII string that contains one or more \r
- ISO 639-2 language codes. This is the list of language \r
- codes that this protocol supports.\r
-\r
-**/\r
-\r
extern EFI_GUID gEfiDriverConfiguration2ProtocolGuid;\r
\r
#endif\r
projects / mirror_edk2.git / blobdiff