36f53fd3668bf809e52acb68df5d575065d5c9ee
[mirror_edk2.git] / CorebootPayloadPkg / Library / PlatformBootManagerLib / PlatformBootManager.h
1 /**@file
2 Head file for BDS Platform specific code
3
4 Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
9
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
12 **/
13
14 #ifndef _PLATFORM_BOOT_MANAGER_H
15 #define _PLATFORM_BOOT_MANAGER_H
16
17 #include <PiDxe.h>
18 #include <Protocol/LoadedImage.h>
19
20 #include <Library/DebugLib.h>
21 #include <Library/BaseMemoryLib.h>
22 #include <Library/UefiBootServicesTableLib.h>
23 #include <Library/UefiRuntimeServicesTableLib.h>
24 #include <Library/MemoryAllocationLib.h>
25 #include <Library/BaseLib.h>
26 #include <Library/UefiRuntimeServicesTableLib.h>
27 #include <Library/UefiLib.h>
28 #include <Library/UefiBootManagerLib.h>
29 #include <Library/PcdLib.h>
30 #include <Library/DevicePathLib.h>
31 #include <Library/HiiLib.h>
32 #include <Library/PrintLib.h>
33 #include <Library/DxeServicesLib.h>
34 #include <Library/BootLogoLib.h>
35
36
37 typedef struct {
38 EFI_DEVICE_PATH_PROTOCOL *DevicePath;
39 UINTN ConnectType;
40 } PLATFORM_CONSOLE_CONNECT_ENTRY;
41
42 extern PLATFORM_CONSOLE_CONNECT_ENTRY gPlatformConsole[];
43
44 #define gEndEntire \
45 { \
46 END_DEVICE_PATH_TYPE,\
47 END_ENTIRE_DEVICE_PATH_SUBTYPE,\
48 { END_DEVICE_PATH_LENGTH, 0 },\
49 }
50
51 #define CONSOLE_OUT BIT0
52 #define CONSOLE_IN BIT1
53 #define STD_ERROR BIT2
54
55 typedef struct {
56 VENDOR_DEVICE_PATH VendorDevicePath;
57 UINT32 Instance;
58 } WIN_NT_VENDOR_DEVICE_PATH_NODE;
59
60 //
61 // Below is the platform console device path
62 //
63 typedef struct {
64 VENDOR_DEVICE_PATH NtBus;
65 WIN_NT_VENDOR_DEVICE_PATH_NODE SerialDevice;
66 UART_DEVICE_PATH Uart;
67 VENDOR_DEVICE_PATH TerminalType;
68 EFI_DEVICE_PATH_PROTOCOL End;
69 } NT_ISA_SERIAL_DEVICE_PATH;
70
71 typedef struct {
72 VENDOR_DEVICE_PATH NtBus;
73 WIN_NT_VENDOR_DEVICE_PATH_NODE NtGopDevice;
74 EFI_DEVICE_PATH_PROTOCOL End;
75 } NT_PLATFORM_GOP_DEVICE_PATH;
76
77 /**
78 Use SystemTable Conout to stop video based Simple Text Out consoles from going
79 to the video device. Put up LogoFile on every video device that is a console.
80
81 @param[in] LogoFile File name of logo to display on the center of the screen.
82
83 @retval EFI_SUCCESS ConsoleControl has been flipped to graphics and logo displayed.
84 @retval EFI_UNSUPPORTED Logo not found
85
86 **/
87 EFI_STATUS
88 PlatformBootManagerEnableQuietBoot (
89 IN EFI_GUID *LogoFile
90 );
91
92 /**
93 Use SystemTable Conout to turn on video based Simple Text Out consoles. The
94 Simple Text Out screens will now be synced up with all non video output devices
95
96 @retval EFI_SUCCESS UGA devices are back in text mode and synced up.
97
98 **/
99 EFI_STATUS
100 PlatformBootManagerDisableQuietBoot (
101 VOID
102 );
103
104 /**
105 Show progress bar with title above it. It only works in Graphics mode.
106
107 @param TitleForeground Foreground color for Title.
108 @param TitleBackground Background color for Title.
109 @param Title Title above progress bar.
110 @param ProgressColor Progress bar color.
111 @param Progress Progress (0-100)
112 @param PreviousValue The previous value of the progress.
113
114 @retval EFI_STATUS Success update the progress bar
115
116 **/
117 EFI_STATUS
118 PlatformBootManagerShowProgress (
119 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL TitleForeground,
120 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL TitleBackground,
121 IN CHAR16 *Title,
122 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL ProgressColor,
123 IN UINTN Progress,
124 IN UINTN PreviousValue
125 );
126
127 #endif // _PLATFORM_BOOT_MANAGER_H