]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/DriverConfiguration.h
Formalize comments for Protocols and PPIs.
[mirror_edk2.git] / MdePkg / Include / Protocol / DriverConfiguration.h
index f4f0c7aeb22a71283dc4c9da8ead54467fc0c8aa..547fd8e557d254d2eb4d21159214ad3e48ca2428 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   EFI Driver Configuration 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
   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
-  Module Name:  DriverConfiguration.h\r
-\r
 **/\r
 \r
 #ifndef __EFI_DRIVER_CONFIGURATION_H__\r
 #define __EFI_DRIVER_CONFIGURATION_H__\r
 \r
-//\r
-// Global ID for the Driver Configuration Protocol defined in EFI 1.10\r
-//\r
+#include <Protocol/DriverConfiguration2.h>\r
+\r
+///\r
+/// Global ID for the Driver Configuration Protocol defined in UEFI 2.0\r
+///\r
 #define EFI_DRIVER_CONFIGURATION_PROTOCOL_GUID \\r
   { \\r
     0x107a772b, 0xd5e1, 0x11d4, {0x9a, 0x46, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \\r
   }\r
-\r
-//\r
-// Global ID for the Driver Configuration Protocol defined in UEFI 2.0\r
-//\r
-#define UEFI_DRIVER_CONFIGURATION_PROTOCOL_GUID \\r
-  { \\r
-    0xbfd7dc1d, 0x24f1, 0x40d9, {0x82, 0xe7, 0x2e, 0x09, 0xbb, 0x6b, 0x4e, 0xbe } \\r
-  }\r
-  \r
\r
 typedef struct _EFI_DRIVER_CONFIGURATION_PROTOCOL  EFI_DRIVER_CONFIGURATION_PROTOCOL;\r
 \r
-typedef enum {\r
-  EfiDriverConfigurationActionNone              = 0,\r
-  EfiDriverConfigurationActionStopController    = 1,\r
-  EfiDriverConfigurationActionRestartController = 2,\r
-  EfiDriverConfigurationActionRestartPlatform   = 3,\r
-  EfiDriverConfigurationActionMaximum\r
-} EFI_DRIVER_CONFIGURATION_ACTION_REQUIRED;\r
-\r
-#define EFI_DRIVER_CONFIGURATION_SAFE_DEFAULTS          0x00000000\r
-#define EFI_DRIVER_CONFIGURATION_MANUFACTURING_DEFAULTS 0x00000001\r
-#define EFI_DRIVER_CONFIGURATION_CUSTOM_DEFAULTS        0x00000002\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
   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_CONFIGURATION_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
@@ -92,7 +71,7 @@ typedef enum {
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_DRIVER_CONFIGURATION_SET_OPTIONS) (\r
+(EFIAPI *EFI_DRIVER_CONFIGURATION_SET_OPTIONS)(\r
   IN EFI_DRIVER_CONFIGURATION_PROTOCOL                        *This,\r
   IN  EFI_HANDLE                                              ControllerHandle,\r
   IN  EFI_HANDLE                                              ChildHandle  OPTIONAL,\r
@@ -131,7 +110,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_DRIVER_CONFIGURATION_OPTIONS_VALID) (\r
+(EFIAPI *EFI_DRIVER_CONFIGURATION_OPTIONS_VALID)(\r
   IN EFI_DRIVER_CONFIGURATION_PROTOCOL                        *This,\r
   IN  EFI_HANDLE                                              ControllerHandle,\r
   IN  EFI_HANDLE                                              ChildHandle  OPTIONAL\r
@@ -140,7 +119,7 @@ EFI_STATUS
 /**\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_CONFIGURATION_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
@@ -158,7 +137,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_DRIVER_CONFIGURATION_FORCE_DEFAULTS) (\r
+(EFIAPI *EFI_DRIVER_CONFIGURATION_FORCE_DEFAULTS)(\r
   IN EFI_DRIVER_CONFIGURATION_PROTOCOL                        *This,\r
   IN  EFI_HANDLE                                              ControllerHandle,\r
   IN  EFI_HANDLE                                              ChildHandle  OPTIONAL,\r
@@ -167,37 +146,22 @@ EFI_STATUS
   );\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_CONFIGURATION_PROTOCOL {\r
   EFI_DRIVER_CONFIGURATION_SET_OPTIONS    SetOptions;\r
   EFI_DRIVER_CONFIGURATION_OPTIONS_VALID  OptionsValid;\r
   EFI_DRIVER_CONFIGURATION_FORCE_DEFAULTS ForceDefaults;\r
+  ///\r
+  /// 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
   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 gEfiDriverConfigurationProtocolGuid;\r
-extern EFI_GUID gUefiDriverConfigurationProtocolGuid;\r
 \r
 #endif\r