MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Include / Library / BootLogoLib.h

/** @file\r
  This library is only intended to be used by PlatformBootManagerLib\r
  to show progress bar and LOGO.\r
\r
Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _BOOT_LOGO_LIB_H_\r
#define _BOOT_LOGO_LIB_H_\r
\r
#include <Protocol/PlatformLogo.h>\r
#include <Protocol/GraphicsOutput.h>\r
\r
/**\r
  Show LOGO returned from Edkii Platform Logo protocol on all consoles.\r
**/\r
EFI_STATUS\r
EFIAPI\r
BootLogoEnableLogo (\r
  VOID\r
  );\r
\r
\r
/**\r
  Use SystemTable ConOut to turn on video based Simple Text Out consoles. The\r
  Simple Text Out screens will now be synced up with all non-video output devices.\r
\r
  @retval EFI_SUCCESS     UGA devices are back in text mode and synced up.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
BootLogoDisableLogo (\r
  VOID\r
  );\r
\r
/**\r
\r
  Update progress bar with title above it. It only works in Graphics mode.\r
\r
  @param TitleForeground Foreground color for Title.\r
  @param TitleBackground Background color for Title.\r
  @param Title           Title above progress bar.\r
  @param ProgressColor   Progress bar color.\r
  @param Progress        Progress (0-100)\r
  @param PreviousValue   The previous value of the progress.\r
\r
  @retval  EFI_STATUS    Successly update the progress bar\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
BootLogoUpdateProgress (\r
  IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL TitleForeground,\r
  IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL TitleBackground,\r
  IN CHAR16                        *Title,\r
  IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL ProgressColor,\r
  IN UINTN                         Progress,\r
  IN UINTN                         PreviousValue\r
  );\r
\r
#endif\r