Update function description per UEFI2.3d. The main changes include:

[mirror_edk2.git] / MdePkg / Include / Protocol / PlatformToDriverConfiguration.h

diff --git a/MdePkg/Include/Protocol/PlatformToDriverConfiguration.h b/MdePkg/Include/Protocol/PlatformToDriverConfiguration.h
index c7ffd21b5d6dcf08c8bf1ad1d1344982ec9aaff8..657c9e8c34e487d2ba5b6457f10cac52c143983b 100644 (file)
--- a/MdePkg/Include/Protocol/PlatformToDriverConfiguration.h
+++ b/MdePkg/Include/Protocol/PlatformToDriverConfiguration.h
@@ -5,7 +5,7 @@
   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 - 2009, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2006 - 2011, 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
@@ -289,14 +289,15 @@ struct _EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL {
   used.\r
 **/\r
 typedef struct {\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 function is called. \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 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
+  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