]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/PlatformToDriverConfiguration.h
MdePkg: Apply uncrustify changes
[mirror_edk2.git] / MdePkg / Include / Protocol / PlatformToDriverConfiguration.h
index fdb80f044d571b1ac5b537f5927ee1e9c1f87050..48b83893fe712fc6780123555ee710603ed8fe90 100644 (file)
 #define EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL_GUID  \\r
   { 0x642cd590, 0x8059, 0x4c0a, { 0xa9, 0x58, 0xc5, 0xec, 0x7, 0xd2, 0x3c, 0x4b } }\r
 \r
-\r
 typedef struct _EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL;\r
 \r
-\r
 /**\r
   The UEFI driver must call Query early in the Start() function\r
   before any time consuming operations are performed. If\r
@@ -128,7 +126,7 @@ EFI_STATUS
   OUT       EFI_GUID    **ParameterTypeGuid,\r
   OUT       VOID        **ParameterBlock,\r
   OUT       UINTN       *ParameterBlockSize\r
-);\r
+  );\r
 \r
 typedef enum {\r
   ///\r
@@ -141,7 +139,7 @@ typedef enum {
   ///  this controller can be used again with the updated\r
   ///  configuration settings.\r
   ///\r
-  EfiPlatformConfigurationActionNone              = 0,\r
+  EfiPlatformConfigurationActionNone = 0,\r
 \r
   ///\r
   ///  The driver has detected that the controller specified\r
@@ -150,7 +148,7 @@ typedef enum {
   ///  DisconnectControservice to perform this operation, and\r
   ///  it should be performed as soon as possible.\r
   ///\r
-  EfiPlatformConfigurationActionStopController    = 1,\r
+  EfiPlatformConfigurationActionStopController = 1,\r
 \r
   ///\r
   ///  This controller specified by ControllerHandle needs to\r
@@ -171,7 +169,7 @@ typedef enum {
   ///  delayed until all of the configuration options have\r
   ///  been set.\r
   ///\r
-  EfiPlatformConfigurationActionRestartPlatform   = 3,\r
+  EfiPlatformConfigurationActionRestartPlatform = 3,\r
 \r
   ///\r
   ///  The controller specified by ControllerHandle is still\r
@@ -184,7 +182,7 @@ typedef enum {
   ///  configuration settings are not guaranteed to persist\r
   ///  after ControllerHandle is stopped.\r
   ///\r
-  EfiPlatformConfigurationActionNvramFailed       = 4,\r
+  EfiPlatformConfigurationActionNvramFailed = 4,\r
 \r
   ///\r
   /// The controller specified by ControllerHandle is still\r
@@ -198,11 +196,10 @@ typedef enum {
   /// ParameterTypeGuid is supported by the platform, Query\r
   /// should return EFI_NOT_FOUND.\r
   ///\r
-  EfiPlatformConfigurationActionUnsupportedGuid   = 5,\r
+  EfiPlatformConfigurationActionUnsupportedGuid = 5,\r
   EfiPlatformConfigurationActionMaximum\r
 } EFI_PLATFORM_CONFIGURATION_ACTION;\r
 \r
-\r
 /**\r
   The UEFI driver repeatedly calls Query, processes the\r
   information returned by the platform, and calls Response passing\r
@@ -264,10 +261,9 @@ EFI_STATUS
   IN CONST  UINTN       *Instance,\r
   IN CONST  EFI_GUID    *ParameterTypeGuid,\r
   IN CONST  VOID        *ParameterBlock,\r
-  IN CONST  UINTN       ParameterBlockSize ,\r
+  IN CONST  UINTN       ParameterBlockSize,\r
   IN CONST  EFI_PLATFORM_CONFIGURATION_ACTION ConfigurationAction\r
-);\r
-\r
+  );\r
 \r
 ///\r
 /// The EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL is used by the\r
@@ -282,12 +278,10 @@ EFI_STATUS
 /// taken.\r
 ///\r
 struct _EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL {\r
-  EFI_PLATFORM_TO_DRIVER_CONFIGURATION_QUERY    Query;\r
-  EFI_PLATFORM_TO_DRIVER_CONFIGURATION_RESPONSE Response;\r
+  EFI_PLATFORM_TO_DRIVER_CONFIGURATION_QUERY       Query;\r
+  EFI_PLATFORM_TO_DRIVER_CONFIGURATION_RESPONSE    Response;\r
 };\r
 \r
-\r
-\r
 #define EFI_PLATFORM_TO_DRIVER_CONFIGURATION_CLP_GUID   \\r
   {0x345ecc0e, 0xcb6, 0x4b75, { 0xbb, 0x57, 0x1b, 0x12, 0x9c, 0x47, 0x33,0x3e } }\r
 \r
@@ -304,46 +298,43 @@ struct _EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL {
   used.\r
 **/\r
 typedef struct {\r
-  CHAR8   *CLPCommand;        ///<  A pointer to the null-terminated UTF-8 string that specifies the DMTF SM CLP command\r
-                              ///<  line that the driver is required to parse and process when this function is called.\r
-                              ///<  See the DMTF SM CLP Specification 1.0 Final Standard for details on the\r
-                              ///<  format and syntax of the CLP command line string. CLPCommand buffer\r
-                              ///<  is allocated by the producer of the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOOL.\r
-  UINT32  CLPCommandLength;   ///< The length of the CLP Command in bytes.\r
-  CHAR8   *CLPReturnString;   ///<  A pointer to the null-terminated UTF-8 string that indicates the CLP return status\r
-                              ///<  that the driver is required to provide to the calling agent.\r
-                              ///<  The calling agent may parse and/ or pass\r
-                              ///<  this for processing and user feedback. The SM CLP Command Response string\r
-                              ///<  buffer is filled in by the UEFI driver in the "keyword=value" format\r
-                              ///<  described in the SM CLP Specification, unless otherwise requested via the SM\r
-                              ///<  CLP Coutput option in the Command Line string buffer. UEFI driver's support\r
-                              ///<  for this default "keyword=value" output format is required if the UEFI\r
-                              ///<  driver supports this protocol, while support for other SM CLP output\r
-                              ///<  formats is optional (the UEFI Driver should return an EFI_UNSUPPORTED if\r
-                              ///<  the SM CLP Coutput option requested by the caller is not supported by the\r
-                              ///<  UEFI Driver). CLPReturnString buffer is allocated by the consumer of the\r
-                              ///<  EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOC OL and undefined prior to the call to\r
-                              ///<  Response().\r
-  UINT32  CLPReturnStringLength; ///< The length of the CLP return status string in bytes.\r
-  UINT8   CLPCmdStatus;       ///<  SM CLP Command Status (see DMTF SM CLP Specification 1.0 Final Standard -\r
-                              ///<  Table 4) CLPErrorValue SM CLP Processing Error Value (see DMTF SM\r
-                              ///<  CLP Specification 1.0 Final Standard - Table 6). This field is filled in by\r
-                              ///<  the consumer of the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOC\r
-                              ///<  OL and undefined prior to the call to Response().\r
-  UINT8   CLPErrorValue;      ///<  SM CLP Processing Error Value (see DMTF SM CLP Specification 1.0 Final Standard - Table 6).\r
-                              ///<  This field is filled in by the consumer of the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL and undefined prior to the call to Response().\r
-  UINT16  CLPMsgCode;         ///<  Bit 15: OEM Message Code Flag 0 = Message Code is an SM CLP Probable\r
-                              ///<  Cause Value. (see SM CLP Specification Table 11) 1 = Message Code is OEM\r
-                              ///<  Specific Bits 14-0: Message Code This field is filled in by the consumer of\r
-                              ///<  the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOC OL and undefined prior to the call to\r
-                              ///<  Response().\r
-\r
+  CHAR8     *CLPCommand;           ///<  A pointer to the null-terminated UTF-8 string that specifies the DMTF SM CLP command\r
+                                   ///<  line that the driver is required to parse and process when this function is called.\r
+                                   ///<  See the DMTF SM CLP Specification 1.0 Final Standard for details on the\r
+                                   ///<  format and syntax of the CLP command line string. CLPCommand buffer\r
+                                   ///<  is allocated by the producer of the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOOL.\r
+  UINT32    CLPCommandLength;      ///< The length of the CLP Command in bytes.\r
+  CHAR8     *CLPReturnString;      ///<  A pointer to the null-terminated UTF-8 string that indicates the CLP return status\r
+                                   ///<  that the driver is required to provide to the calling agent.\r
+                                   ///<  The calling agent may parse and/ or pass\r
+                                   ///<  this for processing and user feedback. The SM CLP Command Response string\r
+                                   ///<  buffer is filled in by the UEFI driver in the "keyword=value" format\r
+                                   ///<  described in the SM CLP Specification, unless otherwise requested via the SM\r
+                                   ///<  CLP Coutput option in the Command Line string buffer. UEFI driver's support\r
+                                   ///<  for this default "keyword=value" output format is required if the UEFI\r
+                                   ///<  driver supports this protocol, while support for other SM CLP output\r
+                                   ///<  formats is optional (the UEFI Driver should return an EFI_UNSUPPORTED if\r
+                                   ///<  the SM CLP Coutput option requested by the caller is not supported by the\r
+                                   ///<  UEFI Driver). CLPReturnString buffer is allocated by the consumer of the\r
+                                   ///<  EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOC OL and undefined prior to the call to\r
+                                   ///<  Response().\r
+  UINT32    CLPReturnStringLength; ///< The length of the CLP return status string in bytes.\r
+  UINT8     CLPCmdStatus;          ///<  SM CLP Command Status (see DMTF SM CLP Specification 1.0 Final Standard -\r
+                                   ///<  Table 4) CLPErrorValue SM CLP Processing Error Value (see DMTF SM\r
+                                   ///<  CLP Specification 1.0 Final Standard - Table 6). This field is filled in by\r
+                                   ///<  the consumer of the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOC\r
+                                   ///<  OL and undefined prior to the call to Response().\r
+  UINT8     CLPErrorValue;         ///<  SM CLP Processing Error Value (see DMTF SM CLP Specification 1.0 Final Standard - Table 6).\r
+                                   ///<  This field is filled in by the consumer of the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL and undefined prior to the call to Response().\r
+  UINT16    CLPMsgCode;            ///<  Bit 15: OEM Message Code Flag 0 = Message Code is an SM CLP Probable\r
+                                   ///<  Cause Value. (see SM CLP Specification Table 11) 1 = Message Code is OEM\r
+                                   ///<  Specific Bits 14-0: Message Code This field is filled in by the consumer of\r
+                                   ///<  the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOC OL and undefined prior to the call to\r
+                                   ///<  Response().\r
 } EFI_CONFIGURE_CLP_PARAMETER_BLK;\r
 \r
+extern EFI_GUID  gEfiPlatformToDriverConfigurationClpGuid;\r
 \r
-\r
-extern EFI_GUID gEfiPlatformToDriverConfigurationClpGuid;\r
-\r
-extern EFI_GUID gEfiPlatformToDriverConfigurationProtocolGuid;\r
+extern EFI_GUID  gEfiPlatformToDriverConfigurationProtocolGuid;\r
 \r
 #endif\r