3 Copyright (c) 2006, Intel Corporation
4 All rights reserved. This program and the accompanying materials
5 are licensed and made available under the terms and conditions of the BSD License
6 which accompanies this distribution. The full text of the license may be found at
7 http://opensource.org/licenses/bsd-license.php
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
21 #ifndef __EFI_GRAPHICS_LIB_H__
22 #define __EFI_GRAPHICS_LIB_H__
24 #include <Protocol/GraphicsOutput.h>
27 GetGraphicsBitMapFromFV (
28 IN EFI_GUID
*FileNameGuid
,
36 Return the graphics image file named FileNameGuid into Image and return it's
37 size in ImageSize. All Firmware Volumes (FV) in the system are searched for the
42 FileNameGuid - File Name of graphics file in the FV(s).
44 Image - Pointer to pointer to return graphics image. If NULL, a
45 buffer will be allocated.
47 ImageSize - Size of the graphics Image in bytes. Zero if no image found.
52 EFI_SUCCESS - Image and ImageSize are valid.
53 EFI_BUFFER_TOO_SMALL - Image not big enough. ImageSize has required size
54 EFI_NOT_FOUND - FileNameGuid not found
62 IN UINTN BmpImageSize
,
64 IN OUT UINTN
*UgaBltSize
,
65 OUT UINTN
*PixelHeight
,
72 Convert a *.BMP graphics image to a UGA blt buffer. If a NULL UgaBlt buffer
73 is passed in a UgaBlt buffer will be allocated by this routine. If a UgaBlt
74 buffer is passed in it will be used if it is big enough.
78 BmpImage - Pointer to BMP file
80 BmpImageSize - Number of bytes in BmpImage
82 UgaBlt - Buffer containing UGA version of BmpImage.
84 UgaBltSize - Size of UgaBlt in bytes.
86 PixelHeight - Height of UgaBlt/BmpImage in pixels
88 PixelWidth - Width of UgaBlt/BmpImage in pixels
93 EFI_SUCCESS - UgaBlt and UgaBltSize are returned.
94 EFI_UNSUPPORTED - BmpImage is not a valid *.BMP image
95 EFI_BUFFER_TOO_SMALL - The passed in UgaBlt buffer is not big enough.
96 UgaBltSize will contain the required size.
103 IN EFI_GUID
*LogoFile
109 Use Console Control to turn off UGA based Simple Text Out consoles from going
110 to the UGA device. Put up LogoFile on every UGA device that is a console
114 LogoFile - File name of logo to display on the center of the screen.
119 EFI_SUCCESS - ConsoleControl has been flipped to graphics and logo
121 EFI_UNSUPPORTED - Logo not found
134 Use Console Control to turn on UGA based Simple Text Out consoles. The UGA
135 Simple Text Out screens will now be synced up with all non UGA output devices
143 EFI_SUCCESS - UGA devices are back in text mode and synced up.
144 EFI_UNSUPPORTED - Logo not found
156 Use Console Control Protocol to lock the Console In Spliter virtual handle.
157 This is the ConInHandle and ConIn handle in the EFI system table. All key
158 presses will be ignored until the Password is typed in. The only way to
159 disable the password is to type it in to a ConIn device.
162 Password - Password used to lock ConIn device
167 EFI_SUCCESS - ConsoleControl has been flipped to graphics and logo
169 EFI_UNSUPPORTED - Logo not found
179 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*Foreground
, OPTIONAL
180 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*Background
, OPTIONAL