MdeModulePkg/Library/BootMaintenanceManagerUiLib/BootMaintenanceManagerCustomizedUiSupport.h

   1 /** @file
   2   This library class defines a set of interfaces to be used by customize Ui module
   3
   4 Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>
   5 SPDX-License-Identifier: BSD-2-Clause-Patent
   6
   7 **/
   8
   9 #ifndef __BOOT_MAINTENANCE_MANAGER_UI_LIB_H__
  10 #define __BOOT_MAINTENANCE_MANAGER_UI_LIB_H__
  11
  12 /**
  13   Create Time Out Menu in the page.
  14
  15   @param[in]    HiiHandle           The hii handle for the Uiapp driver.
  16   @param[in]    StartOpCodeHandle   The opcode handle to save the new opcode.
  17
  18 **/
  19 VOID
  20 BmmCreateTimeOutMenu (
  21   IN EFI_HII_HANDLE              HiiHandle,
  22   IN VOID                        *StartOpCodeHandle
  23   );
  24
  25 /**
  26   Create the dynamic item to allow user to set the "BootNext" vaule.
  27
  28   @param[in]    HiiHandle           The hii handle for the Uiapp driver.
  29   @param[in]    StartOpCodeHandle   The opcode handle to save the new opcode.
  30
  31 **/
  32 VOID
  33 BmmCreateBootNextMenu(
  34   IN EFI_HII_HANDLE              HiiHandle,
  35   IN VOID                        *StartOpCodeHandle
  36   );
  37
  38 /**
  39   Create Boot Option menu in the page.
  40
  41   @param[in]    HiiHandle           The hii handle for the Uiapp driver.
  42   @param[in]    StartOpCodeHandle   The opcode handle to save the new opcode.
  43
  44 **/
  45 VOID
  46 BmmCreateBootOptionMenu (
  47   IN EFI_HII_HANDLE              HiiHandle,
  48   IN VOID                        *StartOpCodeHandle
  49   );
  50
  51 /**
  52   Create Driver Option menu in the page.
  53
  54   @param[in]    HiiHandle           The hii handle for the Uiapp driver.
  55   @param[in]    StartOpCodeHandle   The opcode handle to save the new opcode.
  56
  57 **/
  58 VOID
  59 BmmCreateDriverOptionMenu (
  60   IN EFI_HII_HANDLE              HiiHandle,
  61   IN VOID                        *StartOpCodeHandle
  62   );
  63
  64 /**
  65   Create Com Option menu in the page.
  66
  67   @param[in]    HiiHandle           The hii handle for the Uiapp driver.
  68   @param[in]    StartOpCodeHandle   The opcode handle to save the new opcode.
  69
  70 **/
  71 VOID
  72 BmmCreateComOptionMenu (
  73   IN EFI_HII_HANDLE              HiiHandle,
  74   IN VOID                        *StartOpCodeHandle
  75   );
  76
  77 /**
  78   Create Com Option menu in the page.
  79
  80   @param[in]    HiiHandle           The hii handle for the Uiapp driver.
  81   @param[in]    StartOpCodeHandle   The opcode handle to save the new opcode.
  82
  83 **/
  84 VOID
  85 BmmCreateBootFromFileMenu (
  86   IN EFI_HII_HANDLE              HiiHandle,
  87   IN VOID                        *StartOpCodeHandle
  88   );
  89
  90 /**
  91   Create empty line menu in the front page.
  92
  93   @param    HiiHandle           The hii handle for the Uiapp driver.
  94   @param    StartOpCodeHandle   The opcode handle to save the new opcode.
  95
  96 **/
  97 VOID
  98 BmmCreateEmptyLine (
  99   IN EFI_HII_HANDLE              HiiHandle,
 100   IN VOID                        *StartOpCodeHandle
 101   );
 102
 103 /**
 104   Rename the driver name if necessary.
 105
 106   @param    DriverName          Input the driver name.
 107   @param    NewDriverName       Return the new driver name.
 108   @param    EmptyLineAfter      Whether need to insert empty line.
 109
 110   @retval   New driver name if compared, else NULL.
 111
 112 **/
 113 typedef
 114 EFI_STATUS
 115 (EFIAPI *DRIVER_SPECIAL_HANDLER)(
 116   IN  CHAR16                   *DriverName,
 117   OUT CHAR16                   **NewName,
 118   OUT BOOLEAN                  *EmptyLineAfter
 119 );
 120
 121 /**
 122   Search the drivers in the system which need to show in the front page
 123   and insert the menu to the front page.
 124
 125   @param    HiiHandle           The hii handle for the Uiapp driver.
 126   @param    ClassGuid           The class guid for the driver which is the target.
 127   @param    SpecialHandlerFn      The pointer to the specail handler function, if any.
 128   @param    StartOpCodeHandle   The opcode handle to save the new opcode.
 129
 130   @retval   EFI_SUCCESS         Search the driver success
 131
 132 **/
 133 EFI_STATUS
 134 BmmListThirdPartyDrivers (
 135   IN EFI_HII_HANDLE              HiiHandle,
 136   IN EFI_GUID                    *ClassGuid,
 137   IN DRIVER_SPECIAL_HANDLER      SpecialHandlerFn,
 138   IN VOID                        *StartOpCodeHandle
 139   );
 140
 141 #endif