Merged in the following trackers from EDK:

[mirror_edk2.git] / MdeModulePkg / Universal / HiiDatabaseDxe / HiiDatabase.h

diff --git a/MdeModulePkg/Universal/HiiDatabaseDxe/HiiDatabase.h b/MdeModulePkg/Universal/HiiDatabaseDxe/HiiDatabase.h
index f19813298edfff2d11d0d7639751db57c448d4fd..bbd366edece9c1f84654e514d9d14142b02311ef 100644 (file)
--- a/MdeModulePkg/Universal/HiiDatabaseDxe/HiiDatabase.h
+++ b/MdeModulePkg/Universal/HiiDatabaseDxe/HiiDatabase.h
@@ -1,6 +1,6 @@
 /** @file\r
 \r
-Copyright (c) 2007, Intel Corporation\r
+Copyright (c) 2007 - 2008, Intel Corporation\r
 All rights reserved. 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
@@ -47,6 +47,8 @@ Revision History
 #include <Library/BaseLib.h>\r
 #include <Library/DevicePathLib.h>\r
 #include <Library/MemoryAllocationLib.h>\r
+#include <Library/IfrSupportLib.h>\r
+#include <Library/HiiLib.h>\r
 \r
 #define HII_DATABASE_NOTIFY_GUID \\r
   { \\r
@@ -495,7 +497,8 @@ FindGlyphBlock (
   @retval EFI_SUCCESS             The string was successfully rendered.\r
   @retval EFI_OUT_OF_RESOURCES    Unable to allocate an output buffer for\r
                                   RowInfoArray or Blt.\r
-  @retval EFI_INVALID_PARAMETER   The String was NULL.\r
+  @retval EFI_INVALID_PARAMETER The String or Blt.\r
+  @retval EFI_INVALID_PARAMETER Flags were invalid combination..\r
 \r
 **/\r
 EFI_STATUS\r
@@ -567,7 +570,10 @@ HiiStringToImage (
   @retval EFI_SUCCESS             The string was successfully rendered.\r
   @retval EFI_OUT_OF_RESOURCES    Unable to allocate an output buffer for\r
                                   RowInfoArray or Blt.\r
-  @retval EFI_INVALID_PARAMETER   The String was NULL.\r
+  @retval EFI_INVALID_PARAMETER The Blt or PackageList was NULL.\r
+  @retval EFI_INVALID_PARAMETER Flags were invalid combination.\r
+  @retval EFI_NOT_FOUND         The specified PackageList is not in the Database or the stringid is not \r
+                          in the specified PackageList. \r
 \r
 **/\r
 EFI_STATUS\r
@@ -616,7 +622,7 @@ EFIAPI
 HiiGetGlyph (\r
   IN  CONST EFI_HII_FONT_PROTOCOL    *This,\r
   IN  CHAR16                         Char,\r
-  IN  CONST EFI_FONT_DISPLAY_INFO    *StringInfo,\r
+  IN  CONST EFI_FONT_DISPLAY_INFO    *StringInfo, OPTIONAL\r
   OUT EFI_IMAGE_OUTPUT               **Blt,\r
   OUT UINTN                          *Baseline OPTIONAL\r
   )\r
@@ -635,7 +641,8 @@ HiiGetGlyph (
                                   returned font handle or points to NULL if there\r
                                   are no more matching fonts.\r
   @param  StringInfoIn            Upon entry, points to the font to return\r
-                                  information about.\r
+                                  information about. If NULL, then the information about the system default \r
+                                  font will be returned.\r
   @param  StringInfoOut           Upon return, contains the matching font's\r
                                   information.  If NULL, then no information is\r
                                   returned. It's caller's responsibility to free\r
@@ -647,9 +654,9 @@ HiiGetGlyph (
   @retval EFI_SUCCESS             Matching font returned successfully.\r
   @retval EFI_NOT_FOUND           No matching font was found.\r
   @retval EFI_INVALID_PARAMETER   StringInfoIn is NULL.\r
+  @retval EFI_INVALID_PARAMETER  StringInfoIn->FontInfoMask is an invalid combination.\r
   @retval EFI_OUT_OF_RESOURCES    There were insufficient resources to complete the\r
                                   request.\r
-\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
@@ -706,15 +713,15 @@ HiiNewImage (
   @param  ImageId                 The image's id,, which is unique within\r
                                   PackageList.\r
   @param  Image                   Points to the image.\r
-  @param  ImageSize               On entry, points to the size of the buffer\r
-                                  pointed to by Image, in bytes. On return, points\r
-                                  to the length of the image, in bytes.\r
 \r
   @retval EFI_SUCCESS             The new image was returned successfully.\r
   @retval EFI_NOT_FOUND           The image specified by ImageId is not available.\r
+                                                 The specified PackageList is not in the database.\r
   @retval EFI_BUFFER_TOO_SMALL    The buffer specified by ImageSize is too small to\r
                                   hold the image.\r
   @retval EFI_INVALID_PARAMETER   The Image or ImageSize was NULL.\r
+  @retval EFI_OUT_OF_RESOURCES   The bitmap could not be retrieved because there was not\r
+                                                       enough memory.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -723,8 +730,7 @@ HiiGetImage (
   IN  CONST EFI_HII_IMAGE_PROTOCOL   *This,\r
   IN  EFI_HII_HANDLE                 PackageList,\r
   IN  EFI_IMAGE_ID                   ImageId,\r
-  OUT EFI_IMAGE_INPUT                *Image,\r
-  OUT UINTN                          *ImageSize\r
+  OUT EFI_IMAGE_INPUT                *Image\r
   )\r
 ;\r
 \r
@@ -741,7 +747,7 @@ HiiGetImage (
 \r
   @retval EFI_SUCCESS             The new image was updated successfully.\r
   @retval EFI_NOT_FOUND           The image specified by ImageId is not in the\r
-                                  database.\r
+                                                database. The specified PackageList is not in the database.\r
   @retval EFI_INVALID_PARAMETER   The Image was NULL.\r
 \r
 **/\r
@@ -821,9 +827,9 @@ HiiDrawImage (
 \r
   @retval EFI_SUCCESS             The image was successfully drawn.\r
   @retval EFI_OUT_OF_RESOURCES    Unable to allocate an output buffer for Blt.\r
-  @retval EFI_INVALID_PARAMETER   The Image was NULL.\r
-  @retval EFI_NOT_FOUND           The specified packagelist could not be found in\r
-                                  current database.\r
+  @retval EFI_INVALID_PARAMETER  The Blt was NULL.\r
+  @retval EFI_NOT_FOUND          The image specified by ImageId is not in the database. \r
+                           The specified PackageList is not in the database.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -914,7 +920,9 @@ HiiNewString (
   @retval EFI_NOT_FOUND           The string specified by StringId is not\r
                                   available.\r
   @retval EFI_NOT_FOUND           The string specified by StringId is available but\r
-                                  not in the specified language.\r
+                                                not in the specified language.\r
+                                                The specified PackageList is not in the database.\r
+  @retval EFI_INVALID_LANGUAGE   - The string specified by StringId is available but\r
   @retval EFI_BUFFER_TOO_SMALL    The buffer specified by StringSize is too small\r
                                   to  hold the string.\r
   @retval EFI_INVALID_PARAMETER   The String or Language or StringSize was NULL.\r
@@ -1029,8 +1037,9 @@ HiiGetLanguages (
                                   too small to hold the returned information.\r
                                   SecondLanguageSize is updated to hold the size of\r
                                   the buffer required.\r
-  @retval EFI_NOT_FOUND           The language specified by FirstLanguage is not\r
+  @retval EFI_INVALID_LANGUAGE           The language specified by FirstLanguage is not\r
                                   present in the specified package list.\r
+  @retval EFI_NOT_FOUND          The specified PackageList is not in the Database.                                \r
 \r
 **/\r
 EFI_STATUS\r
@@ -1091,9 +1100,7 @@ HiiNewPackageList (
 \r
   @retval EFI_SUCCESS             The data associated with the Handle was removed\r
                                   from  the HII database.\r
-  @retval EFI_NOT_FOUND           The specified PackageList could not be found in\r
-                                  database.\r
-  @retval EFI_INVALID_PARAMETER   The Handle was not valid.\r
+  @retval EFI_NOT_FOUND           The specified Handle is not in database.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -1119,9 +1126,8 @@ HiiRemovePackageList (
   @retval EFI_SUCCESS             The HII database was successfully updated.\r
   @retval EFI_OUT_OF_RESOURCES    Unable to allocate enough memory for the updated\r
                                   database.\r
-  @retval EFI_INVALID_PARAMETER   Handle or PackageList was NULL.\r
-  @retval EFI_NOT_FOUND           The Handle was not valid or could not be found in\r
-                                  database.\r
+  @retval EFI_INVALID_PARAMETER  PackageList was NULL.\r
+  @retval EFI_NOT_FOUND          The specified Handle is not in database.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -1154,6 +1160,7 @@ HiiUpdatePackageList (
   @param  Handle                  An array of EFI_HII_HANDLE instances returned.\r
 \r
   @retval EFI_SUCCESS             The matching handles are outputed successfully.\r
+                                                HandleBufferLength is updated with the actual length.\r
   @retval EFI_BUFFER_TO_SMALL     The HandleBufferLength parameter indicates that\r
                                   Handle is too small to support the number of\r
                                   handles. HandleBufferLength is updated with a\r
@@ -1161,6 +1168,10 @@ HiiUpdatePackageList (
   @retval EFI_NOT_FOUND           No matching handle could not be found in\r
                                   database.\r
   @retval EFI_INVALID_PARAMETER   Handle or HandleBufferLength was NULL.\r
+  @retval EFI_INVALID_PARAMETER  PackageType is not a EFI_HII_PACKAGE_TYPE_GUID but\r
+                         PackageGuid is not NULL, PackageType is a EFI_HII_\r
+                         PACKAGE_TYPE_GUID but PackageGuid is NULL.\r
+  \r
 \r
 **/\r
 EFI_STATUS\r
@@ -1271,7 +1282,8 @@ HiiRegisterPackageNotify (
                                   unregistered.\r
 \r
   @retval EFI_SUCCESS             Notification is unregistered successfully.\r
-  @retval EFI_INVALID_PARAMETER   The Handle is invalid.\r
+  @retval EFI_NOT_FOUND          The incoming notification handle does not exist \r
+                           in current hii database.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -1511,7 +1523,7 @@ HiiConfigRoutingExportConfig (
 **/\r
 EFI_STATUS\r
 EFIAPI\r
-HiiConfigRoutingRoutConfig (\r
+HiiConfigRoutingRouteConfig (\r
   IN  CONST EFI_HII_CONFIG_ROUTING_PROTOCOL  *This,\r
   IN  CONST EFI_STRING                       Configuration,\r
   OUT EFI_STRING                             *Progress\r