sync comments on data structure to follow latest UEFI spec.

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

diff --git a/MdePkg/Include/Protocol/HiiConfigRouting.h b/MdePkg/Include/Protocol/HiiConfigRouting.h
index 34beb2fbb257025cdba84b67a9fa24e317c12e99..09fb182442115a041a273035afecd18948796279 100644 (file)
--- a/MdePkg/Include/Protocol/HiiConfigRouting.h
+++ b/MdePkg/Include/Protocol/HiiConfigRouting.h
@@ -45,7 +45,7 @@ typedef struct _EFI_HII_CONFIG_ROUTING_PROTOCOL EFI_HII_CONFIG_ROUTING_PROTOCOL;
   They must have an additional description indicating the type of\r
   alternative configuration the string represents,\r
   "ALTCFG=<StringToken>". That <StringToken> (when converted from\r
-  Hex UNICODE to binary) is a reference to a string in the\r
+  hexadecimal (encoded as text) to binary) is a reference to a string in the\r
   associated string pack. As an example, assume that the Request\r
   string is:\r
   GUID=...&NAME=00480050&PATH=...&Fred&George&Ron&Neville A result\r
@@ -118,7 +118,10 @@ EFI_STATUS
 );\r
 \r
 /**\r
-   \r
+  This function allows the caller to request the current configuration \r
+  for the entirety of the current HII database and returns the data in\r
+  a null-terminated string.\r
+\r
   This function allows the caller to request the current\r
   configuration for all of the current HII database. The results\r
   include both the current and alternate configurations as\r
@@ -126,11 +129,11 @@ EFI_STATUS
   \r
   @param This     Points to the EFI_HII_CONFIG_ROUTING_PROTOCOL instance.\r
   \r
-  @param Results  A null-terminated Unicode string in\r
-                  <MultiConfigAltResp> format which has all\r
-                  values filled in for the names in the Request\r
-                  string. String to be allocated by this\r
-                  function. De-allocation is up to the caller.\r
+  @param Results  A null-terminated string in <MultiConfigAltResp>\r
+                  format which has all values filled in for the\r
+                  names in the Request string.\r
+                  String to be allocated by this function.\r
+                  De-allocation is up to the caller.\r
   \r
   @retval EFI_SUCCESS             The Results string is filled with the\r
                                   values corresponding to all requested\r
@@ -168,8 +171,7 @@ EFI_STATUS
 \r
   @param This           Points to the EFI_HII_CONFIG_ROUTING_PROTOCOL instance.\r
 \r
-  @param Configuration  A null-terminated Unicode string in\r
-                        <MulltiConfigResp> format.\r
+  @param Configuration  A null-terminated string in <MulltiConfigResp> format.\r
 \r
   @param Progress       A pointer to a string filled in with the\r
                         offset of the most recent '&' before the\r
@@ -210,15 +212,14 @@ EFI_STATUS
   consists of a list of <BlockName> formatted names. It uses the\r
   offset in the name to determine the index into the Block to\r
   start the extraction and the width of each name to determine the\r
-  number of bytes to extract. These are mapped to a UNICODE value\r
+  number of bytes to extract. These are mapped to a string\r
   using the equivalent of the C "%x" format (with optional leading\r
   spaces). The call fails if, for any (offset, width) pair in\r
   ConfigRequest, offset+value >= BlockSize.\r
 \r
   @param This      Points to the EFI_HII_CONFIG_ROUTING_PROTOCOL instance.\r
 \r
-  @param ConfigRequest  A null-terminated Unicode string in\r
-                        <ConfigRequest> format.\r
+  @param ConfigRequest  A null-terminated string in <ConfigRequest> format.\r
 \r
   @param Block      Array of bytes defining the block's\r
                     configuration.\r
@@ -293,8 +294,7 @@ EFI_STATUS
 \r
   @param This           Points to the EFI_HII_CONFIG_ROUTING_PROTOCOL instance.\r
 \r
-  @param ConfigResp     A null-terminated Unicode string in\r
-                        <ConfigResp> format.\r
+  @param ConfigResp     A null-terminated string in <ConfigResp> format.\r
 \r
   @param Block          A possibly null array of bytes\r
                         representing the current block. Only\r
@@ -348,8 +348,8 @@ EFI_STATUS
   This helper function is to be called by drivers to extract portions of \r
   a larger configuration string.\r
           \r
-  @param This              A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL instance.    \r
-  @param Configuration     A null-terminated Unicode string in <MultiConfigAltResp> format.\r
+  @param This              A pointer to the EFI_HII_CONFIG_ROUTING_PROTOCOL instance.\r
+  @param Configuration     A null-terminated string in <MultiConfigAltResp> format.\r
   @param Guid              A pointer to the GUID value to search for in the \r
                            routing portion of the ConfigResp string when retrieving \r
                            the requested data. If Guid is NULL, then all GUID \r