• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 - 2016, Intel Corporation. All rights reserved.<BR>
6 This program and the accompanying materials are licensed and made available under
7 the terms and conditions of the BSD License that accompanies this distribution.
8 The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php.
10 
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
13 
14 **/
15 
16 #ifndef _BOOT_LOGO_LIB_H_
17 #define _BOOT_LOGO_LIB_H_
18 
19 #include <Protocol/PlatformLogo.h>
20 #include <Protocol/GraphicsOutput.h>
21 
22 /**
23   Show LOGO returned from Edkii Platform Logo protocol on all consoles.
24 **/
25 EFI_STATUS
26 EFIAPI
27 BootLogoEnableLogo (
28   VOID
29   );
30 
31 
32 /**
33   Use SystemTable ConOut to turn on video based Simple Text Out consoles. The
34   Simple Text Out screens will now be synced up with all non-video output devices.
35 
36   @retval EFI_SUCCESS     UGA devices are back in text mode and synced up.
37 
38 **/
39 EFI_STATUS
40 EFIAPI
41 BootLogoDisableLogo (
42   VOID
43   );
44 
45 /**
46 
47   Update progress bar with title above it. It only works in Graphics mode.
48 
49   @param TitleForeground Foreground color for Title.
50   @param TitleBackground Background color for Title.
51   @param Title           Title above progress bar.
52   @param ProgressColor   Progress bar color.
53   @param Progress        Progress (0-100)
54   @param PreviousValue   The previous value of the progress.
55 
56   @retval  EFI_STATUS    Successly update the progress bar
57 
58 **/
59 EFI_STATUS
60 EFIAPI
61 BootLogoUpdateProgress (
62   IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL TitleForeground,
63   IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL TitleBackground,
64   IN CHAR16                        *Title,
65   IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL ProgressColor,
66   IN UINTN                         Progress,
67   IN UINTN                         PreviousValue
68   );
69 
70 #endif
71