BootMaintenanceMangerUiLib: Save mode info for later use.

[mirror_edk2.git] / MdeModulePkg / Library / BootMaintenanceManagerUiLib / BootMaintenanceManagerCustomizedUiSupport.h

/** @file\r
  This library class defines a set of interfaces to be used by customize Ui module\r
\r
Copyright (c) 2016, 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
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
#ifndef __BOOT_MAINTENANCE_MANAGER_UI_LIB_H__\r
#define __BOOT_MAINTENANCE_MANAGER_UI_LIB_H__\r
\r
/**\r
  Create Time Out Menu in the page.\r
\r
  @param[in]    HiiHandle           The hii handle for the Uiapp driver.\r
  @param[in]    StartOpCodeHandle   The opcode handle to save the new opcode.\r
\r
**/\r
VOID\r
BmmCreateTimeOutMenu (\r
  IN EFI_HII_HANDLE              HiiHandle,\r
  IN VOID                        *StartOpCodeHandle\r
  );\r
\r
/**\r
  Create the dynamic item to allow user to set the "BootNext" vaule.\r
\r
  @param CallbackData    The BMM context data.\r
\r
**/\r
VOID\r
BmmCreateBootNextMenu(\r
  IN EFI_HII_HANDLE              HiiHandle,\r
  IN VOID                        *StartOpCodeHandle\r
  );\r
\r
/**\r
  Create Boot Option menu in the page.\r
\r
  @param[in]    HiiHandle           The hii handle for the Uiapp driver.\r
  @param[in]    StartOpCodeHandle   The opcode handle to save the new opcode.\r
\r
**/\r
VOID\r
BmmCreateBootOptionMenu (\r
  IN EFI_HII_HANDLE              HiiHandle,\r
  IN VOID                        *StartOpCodeHandle\r
  );\r
\r
/**\r
  Create Driver Option menu in the page.\r
\r
  @param[in]    HiiHandle           The hii handle for the Uiapp driver.\r
  @param[in]    StartOpCodeHandle   The opcode handle to save the new opcode.\r
\r
**/\r
VOID\r
BmmCreateDriverOptionMenu (\r
  IN EFI_HII_HANDLE              HiiHandle,\r
  IN VOID                        *StartOpCodeHandle\r
  );\r
\r
/**\r
  Create Com Option menu in the page.\r
\r
  @param[in]    HiiHandle           The hii handle for the Uiapp driver.\r
  @param[in]    StartOpCodeHandle   The opcode handle to save the new opcode.\r
\r
**/\r
VOID\r
BmmCreateComOptionMenu (\r
  IN EFI_HII_HANDLE              HiiHandle,\r
  IN VOID                        *StartOpCodeHandle\r
  );\r
\r
/**\r
  Create Com Option menu in the page.\r
\r
  @param[in]    HiiHandle           The hii handle for the Uiapp driver.\r
  @param[in]    StartOpCodeHandle   The opcode handle to save the new opcode.\r
\r
**/\r
VOID\r
BmmCreateBootFromFileMenu (\r
  IN EFI_HII_HANDLE              HiiHandle,\r
  IN VOID                        *StartOpCodeHandle\r
  );\r
\r
/**\r
  Create empty line menu in the front page.\r
\r
  @param    HiiHandle           The hii handle for the Uiapp driver.\r
  @param    StartOpCodeHandle   The opcode handle to save the new opcode.\r
\r
**/\r
VOID\r
BmmCreateEmptyLine (\r
  IN EFI_HII_HANDLE              HiiHandle,\r
  IN VOID                        *StartOpCodeHandle\r
  );\r
\r
/**\r
  Rename the driver name if necessary.\r
\r
  @param    DriverName          Input the driver name.\r
  @param    NewDriverName       Return the new driver name.\r
  @param    EmptyLineAfter      Whether need to insert empty line.\r
\r
  @retval   New driver name if compared, else NULL.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *DRIVER_SPECIAL_HANDLER)(\r
  IN  CHAR16                   *DriverName,\r
  OUT CHAR16                   **NewName,\r
  OUT BOOLEAN                  *EmptyLineAfter\r
);\r
\r
/**\r
  Search the drivers in the system which need to show in the front page\r
  and insert the menu to the front page.\r
\r
  @param    HiiHandle           The hii handle for the Uiapp driver.\r
  @param    ClassGuid           The class guid for the driver which is the target.\r
  @param    StartOpCodeHandle   The opcode handle to save the new opcode.\r
  @param    SpecialHandler      The pointer to the specail handler function, if any.\r
\r
  @retval   EFI_SUCCESS         Search the driver success\r
\r
**/\r
EFI_STATUS\r
BmmListThirdPartyDrivers (\r
  IN EFI_HII_HANDLE              HiiHandle,\r
  IN EFI_GUID                    *ClassGuid,\r
  IN DRIVER_SPECIAL_HANDLER      SpecialHandlerFn,\r
  IN VOID                        *StartOpCodeHandle\r
  );\r
\r
#endif\r