1) Add in support for Framework VFR file which specify all VAR Store correctly. This...

[mirror_edk2.git] / EdkCompatibilityPkg / Compatibility / FrameworkHiiToUefiHiiThunk / SetupBrowser.c

diff --git a/EdkCompatibilityPkg/Compatibility/FrameworkHiiToUefiHiiThunk/SetupBrowser.c b/EdkCompatibilityPkg/Compatibility/FrameworkHiiToUefiHiiThunk/SetupBrowser.c
index 5e391127cf6cc942effac3729d047fc78ed7977b..ebfbdeceb1940b091a870d15321ff462b61213a0 100644 (file)
--- a/EdkCompatibilityPkg/Compatibility/FrameworkHiiToUefiHiiThunk/SetupBrowser.c
+++ b/EdkCompatibilityPkg/Compatibility/FrameworkHiiToUefiHiiThunk/SetupBrowser.c
@@ -15,6 +15,26 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 #include "HiiDatabase.h"\r
 \r
+/**\r
+  This is the Framework Setup Browser interface which displays a FormSet.\r
+\r
+  @param This           The EFI_FORM_BROWSER_PROTOCOL context.\r
+  @param UseDatabase    TRUE if the FormSet is from HII database. The Thunk implementation\r
+                        only support UseDatabase is TRUE.\r
+  @param Handle         The Handle buffer.\r
+  @param HandleCount    The number of Handle in the Handle Buffer. It must be 1 for this implementation.\r
+  @param Packet         The pointer to data buffer containing IFR and String package. Not supported.\r
+  @param CallbackHandle Not supported.\r
+  @param NvMapOverride  The buffer is used only when there is no NV variable to define the \r
+                        current settings and the caller needs to provide to the browser the\r
+                        current settings for the the "fake" NV variable. If used, no saving of\r
+                        an NV variable is possbile. This parameter is also ignored if Handle is NULL.\r
+\r
+  @retval EFI_SUCCESS             If the Formset is displayed correctly.\r
+  @retval EFI_UNSUPPORTED         If UseDatabase is FALSE or HandleCount is not 1.\r
+  @retval EFI_INVALID_PARAMETER   If the *Handle passed in is not found in the database.\r
+**/\r
+\r
 EFI_STATUS\r
 EFIAPI \r
 ThunkSendForm (\r
@@ -75,6 +95,26 @@ ThunkSendForm (
   return Status;\r
 }\r
 \r
+/** \r
+\r
+  Rountine used to display a generic dialog interface and return \r
+  the Key or Input from user input.\r
+\r
+  @param NumberOfLines The number of lines for the dialog box.\r
+  @param HotKey        Defines if a single character is parsed (TRUE) and returned in KeyValue\r
+                       or if a string is returned in StringBuffer.\r
+  @param MaximumStringSize The maximum size in bytes of a typed-in string.\r
+  @param StringBuffer  On return contains the typed-in string if HotKey\r
+         is FALSE.\r
+  @param KeyValue      The EFI_INPUT_KEY value returned if HotKey is TRUE.\r
+  @param String        The pointer to the first string in the list of strings\r
+                       that comprise the dialog box.\r
+  @param ...           A series of NumberOfLines text strings that will be used\r
+                       to construct the dialog box.\r
+  @retval EFI_SUCCESS  The dialog is created successfully and user interaction was received.\r
+  @retval EFI_DEVICE_ERROR The user typed in an ESC.\r
+  @retval EFI_INVALID_PARAMETER One of the parameters was invalid.(StringBuffer == NULL && HotKey == FALSE).\r
+**/\r
 EFI_STATUS\r
 EFIAPI \r
 ThunkCreatePopUp (\r