MdeModulePkg/Application/UiApp/Ui.h

   1 /** @file
   2   FrontPage routines to handle the callbacks and browser calls
   3
   4 Copyright (c) 2011 - 2015, Intel Corporation. All rights reserved.<BR>
   5 This program and the accompanying materials
   6 are licensed and made available under the terms and conditions of the BSD License
   7 which accompanies this distribution.  The full text of the license may be found at
   8 http://opensource.org/licenses/bsd-license.php
   9
  10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15
  16 #ifndef _BDS_MODULE_H_
  17 #define _BDS_MODULE_H_
  18
  19 #include <PiDxe.h>
  20 #include <IndustryStandard/PeImage.h>
  21 #include <IndustryStandard/SmBios.h>
  22
  23 #include <Guid/MdeModuleHii.h>
  24 #include <Guid/FileSystemVolumeLabelInfo.h>
  25 #include <Guid/HiiPlatformSetupFormset.h>
  26 #include <Guid/GlobalVariable.h>
  27 #include <Guid/CapsuleVendor.h>
  28 #include <Guid/StatusCodeDataTypeId.h>
  29 #include <Guid/FileInfo.h>
  30 #include <Guid/HiiBootMaintenanceFormset.h>
  31
  32 #include <Protocol/LoadFile.h>
  33 #include <Protocol/LoadedImage.h>
  34 #include <Protocol/DevicePath.h>
  35 #include <Protocol/HiiConfigRouting.h>
  36 #include <Protocol/Smbios.h>
  37 #include <Protocol/UgaDraw.h>
  38 #include <Protocol/BlockIo.h>
  39 #include <Protocol/GenericMemoryTest.h>
  40 #include <Protocol/FormBrowser2.h>
  41 #include <Protocol/HiiConfigAccess.h>
  42 #include <Protocol/GraphicsOutput.h>
  43 #include <Protocol/SimpleFileSystem.h>
  44 #include <Protocol/HiiDatabase.h>
  45 #include <Protocol/HiiString.h>
  46 #include <Protocol/SerialIo.h>
  47 #include <Protocol/SimpleTextInEx.h>
  48 #include <Protocol/DriverHealth.h>
  49 #include <Protocol/DevicePathToText.h>
  50
  51 #include <Library/UefiDriverEntryPoint.h>
  52 #include <Library/PrintLib.h>
  53 #include <Library/DebugLib.h>
  54 #include <Library/BaseMemoryLib.h>
  55 #include <Library/UefiBootServicesTableLib.h>
  56 #include <Library/UefiLib.h>
  57 #include <Library/MemoryAllocationLib.h>
  58 #include <Library/PerformanceLib.h>
  59 #include <Library/ReportStatusCodeLib.h>
  60 #include <Library/UefiRuntimeServicesTableLib.h>
  61 #include <Library/HobLib.h>
  62 #include <Library/BaseLib.h>
  63 #include <Library/DevicePathLib.h>
  64 #include <Library/PcdLib.h>
  65 #include <Library/CapsuleLib.h>
  66 #include <Library/HiiLib.h>
  67 #include <Library/DevicePathLib.h>
  68 #include <Library/PcdLib.h>
  69 #include <Library/UefiHiiServicesLib.h>
  70
  71 #include <Library/UefiBootManagerLib.h>
  72
  73 #pragma pack(1)
  74
  75 ///
  76 /// HII specific Vendor Device Path definition.
  77 ///
  78 typedef struct {
  79   VENDOR_DEVICE_PATH             VendorDevicePath;
  80   EFI_DEVICE_PATH_PROTOCOL       End;
  81 } HII_VENDOR_DEVICE_PATH;
  82
  83 #pragma pack()
  84
  85
  86 //
  87 //The interface functions related to the Setup Browser Reset Reminder feature
  88 //
  89 /**
  90   Enable the setup browser reset reminder feature.
  91   This routine is used in a platform tip. If the platform policy needs the feature, use the routine to enable it.
  92
  93 **/
  94 VOID
  95 EFIAPI
  96 EnableResetReminderFeature (
  97   VOID
  98   );
  99
 100 /**
 101   Disable the setup browser reset reminder feature.
 102   This routine is used in a platform tip. If the platform policy does not want the feature, use the routine to disable it.
 103
 104 **/
 105 VOID
 106 EFIAPI
 107 DisableResetReminderFeature (
 108   VOID
 109   );
 110
 111 /**
 112   Record the info that a reset is required.
 113   A module boolean variable is used to record whether a reset is required.
 114
 115 **/
 116 VOID
 117 EFIAPI
 118 EnableResetRequired (
 119   VOID
 120   );
 121
 122
 123 /**
 124   Record the info that no reset is required.
 125   A module boolean variable is used to record whether a reset is required.
 126
 127 **/
 128 VOID
 129 EFIAPI
 130 DisableResetRequired (
 131   VOID
 132   );
 133
 134 /**
 135   Check whether platform policy enables the reset reminder feature. The default is enabled.
 136
 137 **/
 138 BOOLEAN
 139 EFIAPI
 140 IsResetReminderFeatureEnable (
 141   VOID
 142   );
 143
 144 /**
 145   Check if the user changed any option setting that needs a system reset to be effective.
 146
 147 **/
 148 BOOLEAN
 149 EFIAPI
 150 IsResetRequired (
 151   VOID
 152   );
 153
 154 /**
 155   Check whether a reset is needed, and finish the reset reminder feature.
 156   If a reset is needed, pop up a menu to notice user, and finish the feature
 157   according to the user selection.
 158
 159 **/
 160 VOID
 161 EFIAPI
 162 SetupResetReminder (
 163   VOID
 164   );
 165
 166 /**
 167   This function converts an input device structure to a Unicode string.
 168
 169   @param DevPath                  A pointer to the device path structure.
 170
 171   @return A new allocated Unicode string that represents the device path.
 172
 173 **/
 174 CHAR16 *
 175 UiDevicePathToStr (
 176   IN EFI_DEVICE_PATH_PROTOCOL     *DevPath
 177   );
 178 #endif