]> git.proxmox.com Git - mirror_edk2.git/blame - MdeModulePkg/Include/Library/BootLogoLib.h
MdeModulePkg/S3SmmInitDone.h: Fix copyright coding style error.
[mirror_edk2.git] / MdeModulePkg / Include / Library / BootLogoLib.h
CommitLineData
8dfe7fd2
RN
1/** @file\r
2 This library is only intended to be used by PlatformBootManagerLib\r
3 to show progress bar and LOGO.\r
4\r
d1102dba 5Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>\r
8dfe7fd2
RN
6This program and the accompanying materials are licensed and made available under\r
7the terms and conditions of the BSD License that accompanies this distribution.\r
8The full text of the license may be found at\r
9http://opensource.org/licenses/bsd-license.php.\r
10\r
11THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
12WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
13\r
14**/\r
15\r
16#ifndef _BOOT_LOGO_LIB_H_\r
17#define _BOOT_LOGO_LIB_H_\r
18\r
19#include <Protocol/PlatformLogo.h>\r
10fa5abf 20#include <Protocol/GraphicsOutput.h>\r
8dfe7fd2
RN
21\r
22/**\r
e0ac9c8a 23 Show LOGO returned from Edkii Platform Logo protocol on all consoles.\r
8dfe7fd2
RN
24**/\r
25EFI_STATUS\r
26EFIAPI\r
27BootLogoEnableLogo (\r
e0ac9c8a 28 VOID\r
8dfe7fd2
RN
29 );\r
30\r
31\r
32/**\r
d1102dba 33 Use SystemTable ConOut to turn on video based Simple Text Out consoles. The\r
8dfe7fd2
RN
34 Simple Text Out screens will now be synced up with all non-video output devices.\r
35\r
36 @retval EFI_SUCCESS UGA devices are back in text mode and synced up.\r
37\r
38**/\r
39EFI_STATUS\r
40EFIAPI\r
41BootLogoDisableLogo (\r
42 VOID\r
43 );\r
44\r
45/**\r
46\r
47 Update progress bar with title above it. It only works in Graphics mode.\r
48\r
49 @param TitleForeground Foreground color for Title.\r
50 @param TitleBackground Background color for Title.\r
51 @param Title Title above progress bar.\r
52 @param ProgressColor Progress bar color.\r
53 @param Progress Progress (0-100)\r
54 @param PreviousValue The previous value of the progress.\r
55\r
56 @retval EFI_STATUS Successly update the progress bar\r
57\r
58**/\r
59EFI_STATUS\r
60EFIAPI\r
61BootLogoUpdateProgress (\r
62 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL TitleForeground,\r
63 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL TitleBackground,\r
64 IN CHAR16 *Title,\r
65 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL ProgressColor,\r
66 IN UINTN Progress,\r
67 IN UINTN PreviousValue\r
68 );\r
69\r
70#endif\r