2 Graphics Output Protocol from the UEFI 2.0 specification.
4 Abstraction of a very simple graphics device.
6 Copyright (c) 2006 - 2008, Intel Corporation
7 All rights reserved. This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 #ifndef __GRAPHICS_OUTPUT_H__
18 #define __GRAPHICS_OUTPUT_H__
20 #define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID \
22 0x9042a9de, 0x23dc, 0x4a38, {0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a } \
25 typedef struct _EFI_GRAPHICS_OUTPUT_PROTOCOL EFI_GRAPHICS_OUTPUT_PROTOCOL
;
35 PixelRedGreenBlueReserved8BitPerColor
,
36 PixelBlueGreenRedReserved8BitPerColor
,
40 } EFI_GRAPHICS_PIXEL_FORMAT
;
44 UINT32 HorizontalResolution
;
45 UINT32 VerticalResolution
;
46 EFI_GRAPHICS_PIXEL_FORMAT PixelFormat
;
47 EFI_PIXEL_BITMASK PixelInformation
;
48 UINT32 PixelsPerScanLine
;
49 } EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
;
52 Return the current video mode information.
54 @param This Protocol instance pointer.
55 @param ModeNumber The mode number to return information on.
56 @param SizeOfInfo A pointer to the size, in bytes, of the Info buffer.
57 @param Info A pointer to callee allocated buffer that returns information about ModeNumber.
59 @retval EFI_SUCCESS Mode information returned.
60 @retval EFI_BUFFER_TOO_SMALL The Info buffer was too small.
61 @retval EFI_DEVICE_ERROR A hardware error occurred trying to retrieve the video mode.
62 @retval EFI_NOT_STARTED Video display is not initialized. Call SetMode ()
63 @retval EFI_INVALID_PARAMETER One of the input args was NULL.
68 (EFIAPI
*EFI_GRAPHICS_OUTPUT_PROTOCOL_QUERY_MODE
)(
69 IN EFI_GRAPHICS_OUTPUT_PROTOCOL
*This
,
71 OUT UINTN
*SizeOfInfo
,
72 OUT EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
**Info
76 Return the current video mode information.
78 @param This Protocol instance pointer.
79 @param ModeNumber The mode number to be set.
81 @retval EFI_SUCCESS Graphics mode was changed.
82 @retval EFI_DEVICE_ERROR The device had an error and could not complete the request.
83 @retval EFI_UNSUPPORTED ModeNumber is not supported by this device.
88 (EFIAPI
*EFI_GRAPHICS_OUTPUT_PROTOCOL_SET_MODE
)(
89 IN EFI_GRAPHICS_OUTPUT_PROTOCOL
*This
,
98 } EFI_GRAPHICS_OUTPUT_BLT_PIXEL
;
101 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Pixel
;
103 } EFI_GRAPHICS_OUTPUT_BLT_PIXEL_UNION
;
107 EfiBltVideoToBltBuffer
,
110 EfiGraphicsOutputBltOperationMax
111 } EFI_GRAPHICS_OUTPUT_BLT_OPERATION
;
114 The following table defines actions for BltOperations:
116 <B>EfiBltVideoFill</B> - Write data from the BltBuffer pixel (SourceX, SourceY)
117 directly to every pixel of the video display rectangle
118 (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height).
119 Only one pixel will be used from the BltBuffer. Delta is NOT used.
121 <B>EfiBltVideoToBltBuffer</B> - Read data from the video display rectangle
122 (SourceX, SourceY) (SourceX + Width, SourceY + Height) and place it in
123 the BltBuffer rectangle (DestinationX, DestinationY )
124 (DestinationX + Width, DestinationY + Height). If DestinationX or
125 DestinationY is not zero then Delta must be set to the length in bytes
126 of a row in the BltBuffer.
128 <B>EfiBltBufferToVideo</B> - Write data from the BltBuffer rectangle
129 (SourceX, SourceY) (SourceX + Width, SourceY + Height) directly to the
130 video display rectangle (DestinationX, DestinationY)
131 (DestinationX + Width, DestinationY + Height). If SourceX or SourceY is
132 not zero then Delta must be set to the length in bytes of a row in the
135 <B>EfiBltVideoToVideo</B> - Copy from the video display rectangle (SourceX, SourceY)
136 (SourceX + Width, SourceY + Height) .to the video display rectangle
137 (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height).
138 The BltBuffer and Delta are not used in this mode.
140 @param This Protocol instance pointer.
141 @param BltBuffer Buffer containing data to blit into video buffer. This
142 buffer has a size of Width*Height*sizeof(EFI_GRAPHICS_OUTPUT_BLT_PIXEL)
143 @param BltOperation Operation to perform on BlitBuffer and video memory
144 @param SourceX X coordinate of source for the BltBuffer.
145 @param SourceY Y coordinate of source for the BltBuffer.
146 @param DestinationX X coordinate of destination for the BltBuffer.
147 @param DestinationY Y coordinate of destination for the BltBuffer.
148 @param Width Width of rectangle in BltBuffer in pixels.
149 @param Height Hight of rectangle in BltBuffer in pixels.
150 @param Delta OPTIONAL
152 @retval EFI_SUCCESS The Blt operation completed.
153 @retval EFI_INVALID_PARAMETER BltOperation is not valid.
154 @retval EFI_DEVICE_ERROR A hardware error occured writting to the video buffer.
159 (EFIAPI
*EFI_GRAPHICS_OUTPUT_PROTOCOL_BLT
)(
160 IN EFI_GRAPHICS_OUTPUT_PROTOCOL
*This
,
161 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*BltBuffer
, OPTIONAL
162 IN EFI_GRAPHICS_OUTPUT_BLT_OPERATION BltOperation
,
165 IN UINTN DestinationX
,
166 IN UINTN DestinationY
,
169 IN UINTN Delta OPTIONAL
175 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
*Info
;
177 EFI_PHYSICAL_ADDRESS FrameBufferBase
;
178 UINTN FrameBufferSize
;
179 } EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE
;
182 @par Protocol Description:
183 Provides a basic abstraction to set video modes and copy pixels to and from
184 the graphics controller's frame buffer. The linear address of the hardware
185 frame buffer is also exposed so software can write directly to the video hardware.
188 Returns information for an available graphics mode that the graphics device
189 and the set of active video output devices supports.
192 Set the video device into the specified mode and clears the visible portions
193 of the output display to black.
196 Software abstraction to draw on the video device's frame buffer.
199 Pointer to EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE data.
202 struct _EFI_GRAPHICS_OUTPUT_PROTOCOL
{
203 EFI_GRAPHICS_OUTPUT_PROTOCOL_QUERY_MODE QueryMode
;
204 EFI_GRAPHICS_OUTPUT_PROTOCOL_SET_MODE SetMode
;
205 EFI_GRAPHICS_OUTPUT_PROTOCOL_BLT Blt
;
206 EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE
*Mode
;
209 extern EFI_GUID gEfiGraphicsOutputProtocolGuid
;