/** @file\r
- The file provides the protocol to retrieve configuration\r
- information for a device that a UEFI driver is about to start.\r
+ UEFI Platform to Driver Configuration Protocol is defined in UEFI specification.\r
+ \r
+ This is a protocol that is optionally produced by the platform and optionally consumed \r
+ by a UEFI Driver in its Start() function. This protocol allows the driver to receive \r
+ configuration information as part of being started.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation \r
All rights reserved. This program and the accompanying materials \r
);\r
\r
\r
-/**\r
- @par Protocol Description:\r
- The EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL is used by the\r
- UEFI driver to query the platform for configuration information.\r
- The UEFI driver calls Query() multiple times to get\r
- configuration information from the platform. For every call to\r
- Query() there must be a matching call to Response() so the\r
- UEFI driver can inform the platform how it used the\r
- information passed in from Query(). It's legal for a UEFI\r
- driver to use Response() to inform the platform it does not\r
- understand the data returned via Query() and thus no action was\r
- taken.\r
-\r
- @param Query Called by the UEFI Driver Start() function to\r
- get configuration information from the\r
- platform.\r
- \r
- @param Response Called by the UEFI Driver Start() function\r
- to let the platform know how UEFI driver\r
- processed the data return from Query.\r
- \r
-\r
-**/\r
+///\r
+/// The EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL is used by the\r
+/// UEFI driver to query the platform for configuration information.\r
+/// The UEFI driver calls Query() multiple times to get\r
+/// configuration information from the platform. For every call to\r
+/// Query() there must be a matching call to Response() so the\r
+/// UEFI driver can inform the platform how it used the\r
+/// information passed in from Query(). It's legal for a UEFI\r
+/// driver to use Response() to inform the platform it does not\r
+/// understand the data returned via Query() and thus no action was\r
+/// 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
used.\r
**/\r
typedef struct {\r
- ///\r
- /// A pointer to the DMTF SM CLP command line null-terminated string that the \r
- /// driver is required to parse and process when this EFI_SUCCESS The platform \r
- /// return parameter information for ControllerHandle. EFI_NOT_FOUND Instance \r
- /// was not found. EFI_INVALID_PARAMETER ControllerHandle is not a valid \r
- /// EFI_HANDLE. EFI_INVALID_PARAMETER Instance is zero. 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
- ///\r
- CHAR8 *CLPCommand;\r
- \r
- ///\r
- /// The length of the CLP Command in bytes.\r
- ///\r
- UINT32 CLPCommandLength;\r
- \r
- ///\r
- /// A pointer to the CLP return status string that the driver is required to\r
- /// provide to the calling agent. 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
- ///\r
- CHAR8 *CLPReturnString;\r
- \r
- ///\r
- /// The length of the CLP return status string in bytes.\r
- ///\r
- UINT32 CLPReturnStringLength;\r
- \r
- ///\r
- /// 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
- ///\r
- UINT8 CLPCmdStatus;\r
- UINT8 CLPErrorValue;\r
- \r
- ///\r
- /// 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
- UINT16 CLPMsgCode;\r
+ CHAR8 *CLPCommand; ///< A pointer to the DMTF SM CLP command line null-terminated string that the \r
+ ///< driver is required to parse and process when this EFI_SUCCESS The platform \r
+ ///< return parameter information for ControllerHandle. EFI_NOT_FOUND Instance \r
+ ///< was not found. EFI_INVALID_PARAMETER ControllerHandle is not a valid \r
+ ///< EFI_HANDLE. EFI_INVALID_PARAMETER Instance is zero. 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 CLP return status string that the driver is required to\r
+ ///< provide to the calling agent. 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
} EFI_CONFIGURE_CLP_PARAMETER_BLK;\r
\r
\r
projects / mirror_edk2.git / blobdiff