]>
Commit | Line | Data |
---|---|---|
bf231ea6 | 1 | /** @file\r |
91496a54 | 2 | Library supports diplaying graphical splash screen,\r |
3 | locking of keyboard input and printing character on\r | |
4 | screen.\r | |
00c4901b | 5 | \r |
2f50ef83 | 6 | Copyright (c) 2006 - 2008, Intel Corporation.<BR>\r |
bf231ea6 A |
7 | All rights reserved. This program and the accompanying materials \r |
8 | are licensed and made available under the terms and conditions of the BSD License \r | |
9 | which accompanies this distribution. The full text of the license may be found at \r | |
10 | http://opensource.org/licenses/bsd-license.php \r | |
00c4901b | 11 | \r |
bf231ea6 A |
12 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r |
13 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
14 | \r | |
15 | **/\r | |
00c4901b | 16 | \r |
7540e754 A |
17 | #ifndef __EFI_GRAPHICS_LIB_H__\r |
18 | #define __EFI_GRAPHICS_LIB_H__\r | |
19 | \r | |
20 | #include <Protocol/GraphicsOutput.h>\r | |
00c4901b | 21 | \r |
bf231ea6 A |
22 | \r |
23 | /**\r | |
24 | Return the graphics image file named FileNameGuid into Image and return it's\r | |
25 | size in ImageSize. All Firmware Volumes (FV) in the system are searched for the\r | |
26 | file name.\r | |
7d582d6b | 27 | \r |
28 | @param[in] FileNameGuid File Name of graphics file in the FV(s).\r | |
bf231ea6 | 29 | @param[out] Image Pointer to pointer to return graphics image. If NULL, a \r |
7d582d6b | 30 | buffer will be allocated.\r |
bf231ea6 | 31 | @param[out] ImageSize Size of the graphics Image in bytes. Zero if no image found.\r |
7d582d6b | 32 | \r |
33 | @retval EFI_INVALID_PARAMETER invalid parameter\r | |
bf231ea6 A |
34 | @retval EFI_UNSUPPORTED Range can not be erased\r |
35 | @retval EFI_SUCCESS Image and ImageSize are valid. \r | |
36 | @retval EFI_BUFFER_TOO_SMALL Image not big enough. ImageSize has required size\r | |
37 | @retval EFI_NOT_FOUND FileNameGuid not found\r | |
7d582d6b | 38 | \r |
bf231ea6 | 39 | **/\r |
00c4901b | 40 | EFI_STATUS\r |
2f50ef83 | 41 | EFIAPI\r |
00c4901b | 42 | GetGraphicsBitMapFromFV (\r |
43 | IN EFI_GUID *FileNameGuid,\r | |
44 | OUT VOID **Image,\r | |
45 | OUT UINTN *ImageSize\r | |
bf231ea6 | 46 | );\r |
00c4901b | 47 | \r |
7d582d6b | 48 | /**\r |
49 | Return the graphics image file named FileNameGuid into Image and return it's\r | |
50 | size in ImageSize. All Firmware Volumes (FV) in the system are searched for the\r | |
51 | file name.\r | |
52 | \r | |
53 | @param[in] ImageHandle The driver image handle of the caller. The parameter is used to\r | |
54 | optimize the loading of the image file so that the FV from which\r | |
55 | the driver image is loaded will be tried first. \r | |
56 | @param[in] FileNameGuid File Name of graphics file in the FV(s).\r | |
57 | @param[out] Image Pointer to pointer to return graphics image. If NULL, a \r | |
58 | buffer will be allocated.\r | |
59 | @param[out] ImageSize Size of the graphics Image in bytes. Zero if no image found.\r | |
60 | \r | |
61 | @retval EFI_INVALID_PARAMETER invalid parameter\r | |
62 | @retval EFI_UNSUPPORTED Range can not be erased\r | |
63 | @retval EFI_SUCCESS Image and ImageSize are valid. \r | |
64 | @retval EFI_BUFFER_TOO_SMALL Image not big enough. ImageSize has required size\r | |
65 | @retval EFI_NOT_FOUND FileNameGuid not found\r | |
66 | \r | |
67 | **/\r | |
68 | EFI_STATUS\r | |
2f50ef83 | 69 | EFIAPI\r |
7d582d6b | 70 | GetGraphicsBitMapFromFVEx (\r |
71 | IN EFI_HANDLE ImageHandle,\r | |
72 | IN EFI_GUID *FileNameGuid,\r | |
73 | OUT VOID **Image,\r | |
74 | OUT UINTN *ImageSize\r | |
75 | );\r | |
00c4901b | 76 | \r |
00c4901b | 77 | \r |
bf231ea6 A |
78 | /**\r |
79 | Use Console Control to turn off UGA based Simple Text Out consoles from going\r | |
80 | to the UGA device. Put up LogoFile on every UGA device that is a console\r | |
7d582d6b | 81 | \r |
82 | @param[in] LogoFile File name of logo to display on the center of the screen.\r | |
83 | \r | |
bf231ea6 A |
84 | @retval EFI_SUCCESS ConsoleControl has been flipped to graphics and logo displayed.\r |
85 | @retval EFI_UNSUPPORTED Logo not found\r | |
00c4901b | 86 | \r |
bf231ea6 | 87 | **/\r |
00c4901b | 88 | EFI_STATUS\r |
2f50ef83 | 89 | EFIAPI\r |
00c4901b | 90 | EnableQuietBoot (\r |
91 | IN EFI_GUID *LogoFile\r | |
bf231ea6 | 92 | );\r |
00c4901b | 93 | \r |
7d582d6b | 94 | /**\r |
95 | Use Console Control to turn off GOP/UGA based Simple Text Out consoles from going\r | |
96 | to the UGA device. Put up LogoFile on every UGA device that is a console\r | |
97 | \r | |
98 | @param LogoFile File name of logo to display on the center of the screen.\r | |
99 | @param ImageHandle The driver image handle of the caller. The parameter is used to\r | |
100 | optimize the loading of the logo file so that the FV from which\r | |
101 | the driver image is loaded will be tried first.\r | |
102 | \r | |
103 | @retval EFI_SUCCESS ConsoleControl has been flipped to graphics and logo displayed.\r | |
104 | @retval EFI_UNSUPPORTED Logo not found\r | |
105 | \r | |
106 | **/\r | |
107 | EFI_STATUS\r | |
2f50ef83 | 108 | EFIAPI\r |
7d582d6b | 109 | EnableQuietBootEx (\r |
110 | IN EFI_GUID *LogoFile,\r | |
111 | IN EFI_HANDLE ImageHandle\r | |
112 | );\r | |
113 | \r | |
00c4901b | 114 | \r |
bf231ea6 A |
115 | /**\r |
116 | Use Console Control to turn on UGA based Simple Text Out consoles. The UGA \r | |
117 | Simple Text Out screens will now be synced up with all non UGA output devices\r | |
7d582d6b | 118 | \r |
bf231ea6 | 119 | @retval EFI_SUCCESS UGA devices are back in text mode and synced up.\r |
00c4901b | 120 | \r |
bf231ea6 | 121 | **/\r |
00c4901b | 122 | EFI_STATUS\r |
2f50ef83 | 123 | EFIAPI\r |
00c4901b | 124 | DisableQuietBoot (\r |
125 | VOID\r | |
bf231ea6 | 126 | );\r |
00c4901b | 127 | \r |
00c4901b | 128 | \r |
bf231ea6 | 129 | /**\r |
00c4901b | 130 | Use Console Control Protocol to lock the Console In Spliter virtual handle. \r |
131 | This is the ConInHandle and ConIn handle in the EFI system table. All key\r | |
132 | presses will be ignored until the Password is typed in. The only way to\r | |
133 | disable the password is to type it in to a ConIn device.\r | |
7d582d6b | 134 | \r |
135 | @param[in] Password Password used to lock ConIn device.\r | |
136 | \r | |
bf231ea6 A |
137 | @retval EFI_SUCCESS ConsoleControl has been flipped to graphics and logo\r |
138 | displayed.\r | |
139 | @retval EFI_UNSUPPORTED Password not found\r | |
00c4901b | 140 | \r |
bf231ea6 A |
141 | **/\r |
142 | EFI_STATUS\r | |
2f50ef83 | 143 | EFIAPI\r |
bf231ea6 A |
144 | LockKeyboards (\r |
145 | IN CHAR16 *Password\r | |
146 | );\r | |
147 | \r | |
148 | \r | |
149 | /**\r | |
7d582d6b | 150 | Print to graphics screen at the given X,Y coordinates of the graphics screen.\r |
151 | see definition of Print to find rules for constructing Fmt.\r | |
152 | \r | |
153 | @param[in] X Row to start printing at\r | |
154 | @param[in] Y Column to start printing at\r | |
2f50ef83 | 155 | @param[in] ForeGround Foreground color\r |
65e3009c | 156 | @param[in] BackGround background color\r |
7d582d6b | 157 | @param[in] Fmt Print format sting. See definition of Print\r |
158 | @param[in] ... Argumnet stream defined by Fmt string\r | |
159 | \r | |
7d9333a9 | 160 | @return Number of Characters printed.\r |
bf231ea6 A |
161 | \r |
162 | **/\r | |
00c4901b | 163 | UINTN\r |
164 | EFIAPI\r | |
165 | PrintXY (\r | |
166 | IN UINTN X,\r | |
167 | IN UINTN Y,\r | |
2f50ef83 | 168 | IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *ForeGround, OPTIONAL\r |
65e3009c | 169 | IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BackGround, OPTIONAL\r |
00c4901b | 170 | IN CHAR16 *Fmt,\r |
171 | ...\r | |
bf231ea6 | 172 | );\r |
00c4901b | 173 | \r |
174 | \r | |
175 | #endif\r |