UiApp: Update copyright info, cover old code existed in old BdsDxe driver.

[mirror_edk2.git] / MdeModulePkg / Application / UiApp / Ui.h

/** @file\r
  FrontPage routines to handle the callbacks and browser calls\r
\r
Copyright (c) 2011 - 2015, Intel Corporation. All rights reserved.<BR>\r
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
\r
#ifndef _BDS_MODULE_H_\r
#define _BDS_MODULE_H_\r
\r
#include <PiDxe.h>\r
#include <IndustryStandard/PeImage.h>\r
#include <IndustryStandard/SmBios.h>\r
\r
#include <Guid/MdeModuleHii.h>\r
#include <Guid/FileSystemVolumeLabelInfo.h>\r
#include <Guid/HiiPlatformSetupFormset.h>\r
#include <Guid/GlobalVariable.h>\r
#include <Guid/CapsuleVendor.h>\r
#include <Guid/StatusCodeDataTypeId.h>\r
#include <Guid/FileInfo.h>\r
#include <Guid/HiiBootMaintenanceFormset.h>\r
\r
#include <Protocol/LoadFile.h>\r
#include <Protocol/DevicePath.h>\r
#include <Protocol/HiiConfigRouting.h>\r
#include <Protocol/Smbios.h>\r
#include <Protocol/UgaDraw.h>\r
#include <Protocol/BlockIo.h>\r
#include <Protocol/GenericMemoryTest.h>\r
#include <Protocol/FormBrowser2.h>\r
#include <Protocol/HiiConfigAccess.h>\r
#include <Protocol/GraphicsOutput.h>\r
#include <Protocol/SimpleFileSystem.h>\r
#include <Protocol/HiiDatabase.h>\r
#include <Protocol/HiiString.h>\r
#include <Protocol/SerialIo.h>\r
#include <Protocol/SimpleTextInEx.h>\r
#include <Protocol/DriverHealth.h>\r
#include <Protocol/DevicePathToText.h>\r
\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/PrintLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/PerformanceLib.h>\r
#include <Library/ReportStatusCodeLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
#include <Library/HobLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/DevicePathLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/CapsuleLib.h>\r
#include <Library/HiiLib.h>\r
#include <Library/DevicePathLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/UefiHiiServicesLib.h>\r
\r
#include <Library/UefiBootManagerLib.h>\r
\r
#pragma pack(1)\r
\r
///\r
/// HII specific Vendor Device Path definition.\r
///\r
typedef struct {\r
  VENDOR_DEVICE_PATH             VendorDevicePath;\r
  EFI_DEVICE_PATH_PROTOCOL       End;\r
} HII_VENDOR_DEVICE_PATH;\r
\r
#pragma pack()\r
\r
\r
//\r
//The interface functions related to the Setup Browser Reset Reminder feature\r
//\r
/**\r
  Enable the setup browser reset reminder feature.\r
  This routine is used in a platform tip. If the platform policy needs the feature, use the routine to enable it.\r
\r
**/\r
VOID\r
EFIAPI\r
EnableResetReminderFeature (\r
  VOID\r
  );\r
\r
/**\r
  Disable the setup browser reset reminder feature.\r
  This routine is used in a platform tip. If the platform policy does not want the feature, use the routine to disable it.\r
\r
**/\r
VOID\r
EFIAPI\r
DisableResetReminderFeature (\r
  VOID\r
  );\r
\r
/**\r
  Record the info that a reset is required.\r
  A module boolean variable is used to record whether a reset is required.\r
\r
**/\r
VOID\r
EFIAPI\r
EnableResetRequired (\r
  VOID\r
  );\r
\r
\r
/**\r
  Record the info that no reset is required.\r
  A module boolean variable is used to record whether a reset is required.\r
\r
**/\r
VOID\r
EFIAPI\r
DisableResetRequired (\r
  VOID\r
  );\r
\r
/**\r
  Check whether platform policy enables the reset reminder feature. The default is enabled.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
IsResetReminderFeatureEnable (\r
  VOID\r
  );\r
\r
/**\r
  Check if the user changed any option setting that needs a system reset to be effective.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
IsResetRequired (\r
  VOID\r
  );\r
\r
/**\r
  Check whether a reset is needed, and finish the reset reminder feature.\r
  If a reset is needed, pop up a menu to notice user, and finish the feature\r
  according to the user selection.\r
\r
**/\r
VOID\r
EFIAPI\r
SetupResetReminder (\r
  VOID\r
  );\r
\r
/**\r
  This function converts an input device structure to a Unicode string.\r
\r
  @param DevPath                  A pointer to the device path structure.\r
\r
  @return A new allocated Unicode string that represents the device path.\r
\r
**/\r
CHAR16 *\r
UiDevicePathToStr (\r
  IN EFI_DEVICE_PATH_PROTOCOL     *DevPath\r
  );\r
#endif\r