Code scrub for Universal\Console\GraphicsConsoleDxe.

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

/**@file\r
Framework to UEFI 2.1 Setup Browser Thunk. The file consume EFI_FORM_BROWSER2_PROTOCOL\r
to produce a EFI_FORM_BROWSER_PROTOCOL.\r
\r
Copyright (c) 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
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\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
  IN  EFI_FORM_BROWSER_PROTOCOL         *This,\r
  IN  BOOLEAN                           UseDatabase,\r
  IN  FRAMEWORK_EFI_HII_HANDLE          *Handle,\r
  IN  UINTN                             HandleCount,\r
  IN  FRAMEWORK_EFI_IFR_PACKET          *Packet, OPTIONAL\r
  IN  EFI_HANDLE                        CallbackHandle, OPTIONAL\r
  IN  UINT8                             *NvMapOverride, OPTIONAL\r
  IN  FRAMEWORK_EFI_SCREEN_DESCRIPTOR   *ScreenDimensions, OPTIONAL\r
  OUT BOOLEAN                           *ResetRequired OPTIONAL\r
  )\r
{\r
  EFI_STATUS                        Status;\r
  EFI_BROWSER_ACTION_REQUEST        ActionRequest;\r
  HII_THUNK_CONTEXT                 *ThunkContext;\r
  HII_THUNK_PRIVATE_DATA            *Private;\r
  EFI_FORMBROWSER_THUNK_PRIVATE_DATA *BrowserPrivate;\r
\r
  if (!UseDatabase) {\r
    //\r
    // ThunkSendForm only support displays forms registered into the HII database.\r
    //\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  if (HandleCount != 1 ) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  BrowserPrivate = EFI_FORMBROWSER_THUNK_PRIVATE_DATA_FROM_THIS (This);\r
  Private = BrowserPrivate->ThunkPrivate;\r
\r
  ThunkContext = FwHiiHandleToThunkContext (Private, *Handle);\r
  if (ThunkContext == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (NvMapOverride != NULL) {\r
    ThunkContext->NvMapOverride = NvMapOverride;\r
  }\r
\r
  Status = mFormBrowser2Protocol->SendForm (\r
                                    mFormBrowser2Protocol,\r
                                    &ThunkContext->UefiHiiHandle,\r
                                    1,\r
                                    NULL,\r
                                    0,\r
                                    (EFI_SCREEN_DESCRIPTOR *) ScreenDimensions,\r
                                    &ActionRequest\r
                                    );\r
\r
  if (ActionRequest == EFI_BROWSER_ACTION_REQUEST_RESET) {\r
    *ResetRequired = TRUE;\r
  }\r
  \r
  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
  IN  UINTN                           NumberOfLines,\r
  IN  BOOLEAN                         HotKey,\r
  IN  UINTN                           MaximumStringSize,\r
  OUT CHAR16                          *StringBuffer,\r
  OUT EFI_INPUT_KEY                   *KeyValue,\r
  IN  CHAR16                          *String,\r
  ...\r
  )\r
{\r
  EFI_STATUS                        Status;\r
  VA_LIST                           Marker;\r
\r
  if (HotKey != TRUE) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  VA_START (Marker, String);\r
  \r
  Status = IfrLibCreatePopUp2 (NumberOfLines, KeyValue, String, Marker);\r
\r
  VA_END (Marker);\r
  \r
  return Status;\r
}\r
\r