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 /**
  27   Use SystemTable ConOut to turn on video based Simple Text Out consoles. The
  28   Simple Text Out screens will now be synced up with all non-video output devices.
  29
  30   @retval EFI_SUCCESS     UGA devices are back in text mode and synced up.
  31
  32 **/
  33 EFI_STATUS
  34 EFIAPI
  35 BootLogoDisableLogo (
  36   VOID
  37   );
  38
  39 /**
  40
  41   Update progress bar with title above it. It only works in Graphics mode.
  42
  43   @param TitleForeground Foreground color for Title.
  44   @param TitleBackground Background color for Title.
  45   @param Title           Title above progress bar.
  46   @param ProgressColor   Progress bar color.
  47   @param Progress        Progress (0-100)
  48   @param PreviousValue   The previous value of the progress.
  49
  50   @retval  EFI_STATUS    Successly update the progress bar
  51
  52 **/
  53 EFI_STATUS
  54 EFIAPI
  55 BootLogoUpdateProgress (
  56   IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL TitleForeground,
  57   IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL TitleBackground,
  58   IN CHAR16                        *Title,
  59   IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL ProgressColor,
  60   IN UINTN                         Progress,
  61   IN UINTN                         PreviousValue
  62   );
  63
  64 #endif