MdePkg: Add definition for new warning code EFI_WARN_FILE_SYSTEM.

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

diff --git a/MdePkg/Include/Protocol/HiiConfigRouting.h b/MdePkg/Include/Protocol/HiiConfigRouting.h
index ceff241fe6914432609cca1d80843f4e7a5a6f10..467a2dcc8201ad3c86c4e9cc841e0136f04c4ff1 100644 (file)
--- a/MdePkg/Include/Protocol/HiiConfigRouting.h
+++ b/MdePkg/Include/Protocol/HiiConfigRouting.h
@@ -5,7 +5,7 @@
   information from configuration applications, routing the\r
   results to the appropriate drivers.\r
   \r
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR>\r
 This program and the accompanying materials are licensed and made available under \r
 the terms and conditions of the BSD License that accompanies this distribution.  \r
 The full text of the license may be found at\r
@@ -99,8 +99,13 @@ typedef struct _EFI_HII_CONFIG_ROUTING_PROTOCOL EFI_HII_CONFIG_ROUTING_PROTOCOL;
                                   to the most recent & before the\r
                                   error, or the beginning of the\r
                                   string.\r
-  @retval EFI_INVALID_PARAMETER   Unknown name.\r
-\r
+  @retval EFI_INVALID_PARAMETER   The ExtractConfig function of the\r
+                                  underlying HII Configuration \r
+                                  Access Protocol returned \r
+                                  EFI_INVALID_PARAMETER. Progress\r
+                                  set to most recent & before the\r
+                                  error or the beginning of the\r
+                                  string.\r
 \r
 **/\r
 typedef\r
@@ -124,11 +129,11 @@ EFI_STATUS
   \r
   @param This     Points to the EFI_HII_CONFIG_ROUTING_PROTOCOL instance.\r
   \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
+  @param  Results Null-terminated Unicode string in\r
+                  <MultiConfigAltResp> format which has all values\r
+                  filled in for the entirety of the current HII \r
+                  database. String to be allocated by the  called \r
+                  function. 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
@@ -305,8 +310,10 @@ EFI_STATUS
 \r
   @param BlockSize      The length of the Block in units of UINT8.\r
                         On input, this is the size of the Block. On\r
-                        output, if successful, contains the index of\r
-                        the last modified byte in the Block.\r
+                        output, if successful, contains the largest \r
+                        index of the modified byte in the Block, or\r
+                        the required buffer size if the Block is not\r
+                        large enough.\r
 \r
   @param Progress       On return, points to an element of the\r
                         ConfigResp string filled in with the offset\r
@@ -328,6 +335,12 @@ EFI_STATUS
                                  value pair. Block is left updated and\r
                                  Progress points at the '&' preceding the first\r
                                  non-<BlockName>.\r
+  @retval EFI_DEVICE_ERROR       Block not large enough. Progress undefined.\r
+  @retval EFI_NOT_FOUND          Target for the specified routing data was not found.\r
+                                 Progress points to the "G" in "GUID" of the errant\r
+                                 routing data.\r
+  @retval EFI_BUFFER_TOO_SMALL   Block not large enough. Progress undefined. \r
+                                 BlockSize is updated with the required buffer size.\r
 \r
 **/\r
 typedef\r