]>
Commit | Line | Data |
---|---|---|
bf231ea6 | 1 | /** @file\r |
8517ee51 | 2 | Library supports displaying graphical splash screen,\r |
91496a54 | 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 | |
bf231ea6 A |
20 | /**\r |
21 | Return the graphics image file named FileNameGuid into Image and return it's\r | |
22 | size in ImageSize. All Firmware Volumes (FV) in the system are searched for the\r | |
23 | file name.\r | |
7d582d6b | 24 | \r |
25 | @param[in] FileNameGuid File Name of graphics file in the FV(s).\r | |
bf231ea6 | 26 | @param[out] Image Pointer to pointer to return graphics image. If NULL, a \r |
7d582d6b | 27 | buffer will be allocated.\r |
bf231ea6 | 28 | @param[out] ImageSize Size of the graphics Image in bytes. Zero if no image found.\r |
7d582d6b | 29 | \r |
8517ee51 | 30 | @retval EFI_SUCCESS The image is found and data and size is returned.\r |
31 | @retval EFI_UNSUPPORTED FvHandle does not support EFI_FIRMWARE_VOLUME2_PROTOCOL.\r | |
32 | @retval EFI_NOT_FOUND The image specified by NameGuid and SectionType can't be found.\r | |
33 | @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the output data buffer or complete the operations.\r | |
ee6c452c | 34 | @retval EFI_DEVICE_ERROR A hardware error occurs during reading from the Firmware Volume.\r |
8517ee51 | 35 | @retval EFI_ACCESS_DENIED The firmware volume containing the searched Firmware File is configured to disallow reads.\r |
7d582d6b | 36 | \r |
bf231ea6 | 37 | **/\r |
00c4901b | 38 | EFI_STATUS\r |
2f50ef83 | 39 | EFIAPI\r |
00c4901b | 40 | GetGraphicsBitMapFromFV (\r |
41 | IN EFI_GUID *FileNameGuid,\r | |
42 | OUT VOID **Image,\r | |
43 | OUT UINTN *ImageSize\r | |
bf231ea6 | 44 | );\r |
00c4901b | 45 | \r |
7d582d6b | 46 | /**\r |
47 | Return the graphics image file named FileNameGuid into Image and return it's\r | |
48 | size in ImageSize. All Firmware Volumes (FV) in the system are searched for the\r | |
49 | file name.\r | |
50 | \r | |
51 | @param[in] ImageHandle The driver image handle of the caller. The parameter is used to\r | |
52 | optimize the loading of the image file so that the FV from which\r | |
53 | the driver image is loaded will be tried first. \r | |
54 | @param[in] FileNameGuid File Name of graphics file in the FV(s).\r | |
55 | @param[out] Image Pointer to pointer to return graphics image. If NULL, a \r | |
56 | buffer will be allocated.\r | |
57 | @param[out] ImageSize Size of the graphics Image in bytes. Zero if no image found.\r | |
58 | \r | |
8517ee51 | 59 | @retval EFI_SUCCESS The image is found and data and size is returned.\r |
60 | @retval EFI_UNSUPPORTED FvHandle does not support EFI_FIRMWARE_VOLUME2_PROTOCOL.\r | |
61 | @retval EFI_NOT_FOUND The image specified by NameGuid and SectionType can't be found.\r | |
62 | @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the output data buffer or complete the operations.\r | |
ee6c452c | 63 | @retval EFI_DEVICE_ERROR A hardware error occurs during reading from the Firmware Volume.\r |
8517ee51 | 64 | @retval EFI_ACCESS_DENIED The firmware volume containing the searched Firmware File is configured to disallow reads.\r |
7d582d6b | 65 | \r |
66 | **/\r | |
67 | EFI_STATUS\r | |
2f50ef83 | 68 | EFIAPI\r |
7d582d6b | 69 | GetGraphicsBitMapFromFVEx (\r |
70 | IN EFI_HANDLE ImageHandle,\r | |
71 | IN EFI_GUID *FileNameGuid,\r | |
72 | OUT VOID **Image,\r | |
73 | OUT UINTN *ImageSize\r | |
74 | );\r | |
00c4901b | 75 | \r |
00c4901b | 76 | \r |
bf231ea6 A |
77 | /**\r |
78 | Use Console Control to turn off UGA based Simple Text Out consoles from going\r | |
79 | to the UGA device. Put up LogoFile on every UGA device that is a console\r | |
7d582d6b | 80 | \r |
81 | @param[in] LogoFile File name of logo to display on the center of the screen.\r | |
82 | \r | |
bf231ea6 A |
83 | @retval EFI_SUCCESS ConsoleControl has been flipped to graphics and logo displayed.\r |
84 | @retval EFI_UNSUPPORTED Logo not found\r | |
00c4901b | 85 | \r |
bf231ea6 | 86 | **/\r |
00c4901b | 87 | EFI_STATUS\r |
2f50ef83 | 88 | EFIAPI\r |
00c4901b | 89 | EnableQuietBoot (\r |
90 | IN EFI_GUID *LogoFile\r | |
bf231ea6 | 91 | );\r |
00c4901b | 92 | \r |
7d582d6b | 93 | /**\r |
94 | Use Console Control to turn off GOP/UGA based Simple Text Out consoles from going\r | |
95 | to the UGA device. Put up LogoFile on every UGA device that is a console\r | |
96 | \r | |
97 | @param LogoFile File name of logo to display on the center of the screen.\r | |
98 | @param ImageHandle The driver image handle of the caller. The parameter is used to\r | |
99 | optimize the loading of the logo file so that the FV from which\r | |
100 | the driver image is loaded will be tried first.\r | |
101 | \r | |
102 | @retval EFI_SUCCESS ConsoleControl has been flipped to graphics and logo displayed.\r | |
103 | @retval EFI_UNSUPPORTED Logo not found\r | |
104 | \r | |
105 | **/\r | |
106 | EFI_STATUS\r | |
2f50ef83 | 107 | EFIAPI\r |
7d582d6b | 108 | EnableQuietBootEx (\r |
109 | IN EFI_GUID *LogoFile,\r | |
110 | IN EFI_HANDLE ImageHandle\r | |
111 | );\r | |
112 | \r | |
00c4901b | 113 | \r |
bf231ea6 A |
114 | /**\r |
115 | Use Console Control to turn on UGA based Simple Text Out consoles. The UGA \r | |
116 | Simple Text Out screens will now be synced up with all non UGA output devices\r | |
7d582d6b | 117 | \r |
bf231ea6 | 118 | @retval EFI_SUCCESS UGA devices are back in text mode and synced up.\r |
00c4901b | 119 | \r |
bf231ea6 | 120 | **/\r |
00c4901b | 121 | EFI_STATUS\r |
2f50ef83 | 122 | EFIAPI\r |
00c4901b | 123 | DisableQuietBoot (\r |
124 | VOID\r | |
bf231ea6 | 125 | );\r |
00c4901b | 126 | \r |
00c4901b | 127 | \r |
bf231ea6 | 128 | /**\r |
00c4901b | 129 | Use Console Control Protocol to lock the Console In Spliter virtual handle. \r |
130 | This is the ConInHandle and ConIn handle in the EFI system table. All key\r | |
131 | presses will be ignored until the Password is typed in. The only way to\r | |
132 | disable the password is to type it in to a ConIn device.\r | |
7d582d6b | 133 | \r |
134 | @param[in] Password Password used to lock ConIn device.\r | |
135 | \r | |
8517ee51 | 136 | @retval EFI_SUCCESS lock the Console In Spliter virtual handle successfully.\r |
bf231ea6 | 137 | @retval EFI_UNSUPPORTED Password not found\r |
00c4901b | 138 | \r |
bf231ea6 A |
139 | **/\r |
140 | EFI_STATUS\r | |
2f50ef83 | 141 | EFIAPI\r |
bf231ea6 A |
142 | LockKeyboards (\r |
143 | IN CHAR16 *Password\r | |
144 | );\r | |
145 | \r | |
00c4901b | 146 | #endif\r |