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/DevicePath.h>
  34 #include <Protocol/HiiConfigRouting.h>
  35 #include <Protocol/Smbios.h>
  36 #include <Protocol/UgaDraw.h>
  37 #include <Protocol/BlockIo.h>
  38 #include <Protocol/GenericMemoryTest.h>
  39 #include <Protocol/FormBrowser2.h>
  40 #include <Protocol/HiiConfigAccess.h>
  41 #include <Protocol/GraphicsOutput.h>
  42 #include <Protocol/SimpleFileSystem.h>
  43 #include <Protocol/HiiDatabase.h>
  44 #include <Protocol/HiiString.h>
  45 #include <Protocol/SerialIo.h>
  46 #include <Protocol/SimpleTextInEx.h>
  47 #include <Protocol/DriverHealth.h>
  48 #include <Protocol/DevicePathToText.h>
  49
  50 #include <Library/UefiDriverEntryPoint.h>
  51 #include <Library/PrintLib.h>
  52 #include <Library/DebugLib.h>
  53 #include <Library/BaseMemoryLib.h>
  54 #include <Library/UefiBootServicesTableLib.h>
  55 #include <Library/UefiLib.h>
  56 #include <Library/MemoryAllocationLib.h>
  57 #include <Library/PerformanceLib.h>
  58 #include <Library/ReportStatusCodeLib.h>
  59 #include <Library/UefiRuntimeServicesTableLib.h>
  60 #include <Library/HobLib.h>
  61 #include <Library/BaseLib.h>
  62 #include <Library/DevicePathLib.h>
  63 #include <Library/PcdLib.h>
  64 #include <Library/CapsuleLib.h>
  65 #include <Library/HiiLib.h>
  66 #include <Library/DevicePathLib.h>
  67 #include <Library/PcdLib.h>
  68 #include <Library/UefiHiiServicesLib.h>
  69
  70 #include <Library/UefiBootManagerLib.h>
  71
  72 #pragma pack(1)
  73
  74 ///
  75 /// HII specific Vendor Device Path definition.
  76 ///
  77 typedef struct {
  78   VENDOR_DEVICE_PATH             VendorDevicePath;
  79   EFI_DEVICE_PATH_PROTOCOL       End;
  80 } HII_VENDOR_DEVICE_PATH;
  81
  82 #pragma pack()
  83
  84
  85 //
  86 //The interface functions related to the Setup Browser Reset Reminder feature
  87 //
  88 /**
  89   Enable the setup browser reset reminder feature.
  90   This routine is used in a platform tip. If the platform policy needs the feature, use the routine to enable it.
  91
  92 **/
  93 VOID
  94 EFIAPI
  95 EnableResetReminderFeature (
  96   VOID
  97   );
  98
  99 /**
 100   Disable the setup browser reset reminder feature.
 101   This routine is used in a platform tip. If the platform policy does not want the feature, use the routine to disable it.
 102
 103 **/
 104 VOID
 105 EFIAPI
 106 DisableResetReminderFeature (
 107   VOID
 108   );
 109
 110 /**
 111   Record the info that a reset is required.
 112   A module boolean variable is used to record whether a reset is required.
 113
 114 **/
 115 VOID
 116 EFIAPI
 117 EnableResetRequired (
 118   VOID
 119   );
 120
 121
 122 /**
 123   Record the info that no reset is required.
 124   A module boolean variable is used to record whether a reset is required.
 125
 126 **/
 127 VOID
 128 EFIAPI
 129 DisableResetRequired (
 130   VOID
 131   );
 132
 133 /**
 134   Check whether platform policy enables the reset reminder feature. The default is enabled.
 135
 136 **/
 137 BOOLEAN
 138 EFIAPI
 139 IsResetReminderFeatureEnable (
 140   VOID
 141   );
 142
 143 /**
 144   Check if the user changed any option setting that needs a system reset to be effective.
 145
 146 **/
 147 BOOLEAN
 148 EFIAPI
 149 IsResetRequired (
 150   VOID
 151   );
 152
 153 /**
 154   Check whether a reset is needed, and finish the reset reminder feature.
 155   If a reset is needed, pop up a menu to notice user, and finish the feature
 156   according to the user selection.
 157
 158 **/
 159 VOID
 160 EFIAPI
 161 SetupResetReminder (
 162   VOID
 163   );
 164
 165 /**
 166   This function converts an input device structure to a Unicode string.
 167
 168   @param DevPath                  A pointer to the device path structure.
 169
 170   @return A new allocated Unicode string that represents the device path.
 171
 172 **/
 173 CHAR16 *
 174 UiDevicePathToStr (
 175   IN EFI_DEVICE_PATH_PROTOCOL     *DevPath
 176   );
 177 #endif