/** @file\r
- EFI Driver Configuration Protocol\r
+ UEFI Driver Configuration2 Protocol\r
\r
- Copyright (c) 2006, Intel Corporation \r
+ Copyright (c) 2006 - 2008, 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
#ifndef __EFI_DRIVER_CONFIGURATION2_H__\r
#define __EFI_DRIVER_CONFIGURATION2_H__\r
\r
-#include <PiDxe.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
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
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 3066\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
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
**/\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 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
**/\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 3066\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