MdeModulePkg/Include/Library/BootLogoLib.h

   1 /** @file
   2   This library is only intended to be used by PlatformBootManagerLib
   3   to show progress bar and LOGO.
   4
   5 Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>
   6 SPDX-License-Identifier: BSD-2-Clause-Patent
   7
   8 **/
   9
  10 #ifndef _BOOT_LOGO_LIB_H_
  11 #define _BOOT_LOGO_LIB_H_
  12
  13 #include <Protocol/PlatformLogo.h>
  14 #include <Protocol/GraphicsOutput.h>
  15
  16 /**
  17   Show LOGO returned from Edkii Platform Logo protocol on all consoles.
  18 **/
  19 EFI_STATUS
  20 EFIAPI
  21 BootLogoEnableLogo (
  22   VOID
  23   );
  24
  25 /**
  26   Use SystemTable ConOut to turn on video based Simple Text Out consoles. The
  27   Simple Text Out screens will now be synced up with all non-video output devices.
  28
  29   @retval EFI_SUCCESS     UGA devices are back in text mode and synced up.
  30
  31 **/
  32 EFI_STATUS
  33 EFIAPI
  34 BootLogoDisableLogo (
  35   VOID
  36   );
  37
  38 /**
  39
  40   Update progress bar with title above it. It only works in Graphics mode.
  41
  42   @param TitleForeground Foreground color for Title.
  43   @param TitleBackground Background color for Title.
  44   @param Title           Title above progress bar.
  45   @param ProgressColor   Progress bar color.
  46   @param Progress        Progress (0-100)
  47   @param PreviousValue   The previous value of the progress.
  48
  49   @retval  EFI_STATUS    Successly update the progress bar
  50
  51 **/
  52 EFI_STATUS
  53 EFIAPI
  54 BootLogoUpdateProgress (
  55   IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL  TitleForeground,
  56   IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL  TitleBackground,
  57   IN CHAR16                         *Title,
  58   IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL  ProgressColor,
  59   IN UINTN                          Progress,
  60   IN UINTN                          PreviousValue
  61   );
  62
  63 #endif