2 Graphics Output Protocol from the UEFI 2.0 specification.
4 Abstraction of a very simple graphics device.
6 Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR>
7 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 FILE_LICENCE ( BSD3 );
22 #define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID \
24 0x9042a9de, 0x23dc, 0x4a38, {0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a } \
27 typedef struct _EFI_GRAPHICS_OUTPUT_PROTOCOL EFI_GRAPHICS_OUTPUT_PROTOCOL;
38 /// A pixel is 32-bits and byte zero represents red, byte one represents green,
39 /// byte two represents blue, and byte three is reserved. This is the definition
40 /// for the physical frame buffer. The byte values for the red, green, and blue
41 /// components represent the color intensity. This color intensity value range
42 /// from a minimum intensity of 0 to maximum intensity of 255.
44 PixelRedGreenBlueReserved8BitPerColor,
46 /// A pixel is 32-bits and byte zero represents blue, byte one represents green,
47 /// byte two represents red, and byte three is reserved. This is the definition
48 /// for the physical frame buffer. The byte values for the red, green, and blue
49 /// components represent the color intensity. This color intensity value range
50 /// from a minimum intensity of 0 to maximum intensity of 255.
52 PixelBlueGreenRedReserved8BitPerColor,
54 /// The Pixel definition of the physical frame buffer.
58 /// This mode does not support a physical frame buffer.
62 /// Valid EFI_GRAPHICS_PIXEL_FORMAT enum values are less than this value.
65 } EFI_GRAPHICS_PIXEL_FORMAT;
69 /// The version of this data structure. A value of zero represents the
70 /// EFI_GRAPHICS_OUTPUT_MODE_INFORMATION structure as defined in this specification.
74 /// The size of video screen in pixels in the X dimension.
76 UINT32 HorizontalResolution;
78 /// The size of video screen in pixels in the Y dimension.
80 UINT32 VerticalResolution;
82 /// Enumeration that defines the physical format of the pixel. A value of PixelBltOnly
83 /// implies that a linear frame buffer is not available for this mode.
85 EFI_GRAPHICS_PIXEL_FORMAT PixelFormat;
87 /// This bit-mask is only valid if PixelFormat is set to PixelPixelBitMask.
88 /// A bit being set defines what bits are used for what purpose such as Red, Green, Blue, or Reserved.
90 EFI_PIXEL_BITMASK PixelInformation;
92 /// Defines the number of pixel elements per video memory line.
94 UINT32 PixelsPerScanLine;
95 } EFI_GRAPHICS_OUTPUT_MODE_INFORMATION;
98 Returns information for an available graphics mode that the graphics device
99 and the set of active video output devices supports.
101 @param This The EFI_GRAPHICS_OUTPUT_PROTOCOL instance.
102 @param ModeNumber The mode number to return information on.
103 @param SizeOfInfo A pointer to the size, in bytes, of the Info buffer.
104 @param Info A pointer to callee allocated buffer that returns information about ModeNumber.
106 @retval EFI_SUCCESS Valid mode information was returned.
107 @retval EFI_DEVICE_ERROR A hardware error occurred trying to retrieve the video mode.
108 @retval EFI_INVALID_PARAMETER ModeNumber is not valid.
113 (EFIAPI *EFI_GRAPHICS_OUTPUT_PROTOCOL_QUERY_MODE)(
114 IN EFI_GRAPHICS_OUTPUT_PROTOCOL *This,
115 IN UINT32 ModeNumber,
116 OUT UINTN *SizeOfInfo,
117 OUT EFI_GRAPHICS_OUTPUT_MODE_INFORMATION **Info
121 Set the video device into the specified mode and clears the visible portions of
122 the output display to black.
124 @param This The EFI_GRAPHICS_OUTPUT_PROTOCOL instance.
125 @param ModeNumber Abstraction that defines the current video mode.
127 @retval EFI_SUCCESS The graphics mode specified by ModeNumber was selected.
128 @retval EFI_DEVICE_ERROR The device had an error and could not complete the request.
129 @retval EFI_UNSUPPORTED ModeNumber is not supported by this device.
134 (EFIAPI *EFI_GRAPHICS_OUTPUT_PROTOCOL_SET_MODE)(
135 IN EFI_GRAPHICS_OUTPUT_PROTOCOL *This,
144 } EFI_GRAPHICS_OUTPUT_BLT_PIXEL;
147 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Pixel;
149 } EFI_GRAPHICS_OUTPUT_BLT_PIXEL_UNION;
152 /// actions for BltOperations
156 /// Write data from the BltBuffer pixel (0, 0)
157 /// directly to every pixel of the video display rectangle
158 /// (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height).
159 /// Only one pixel will be used from the BltBuffer. Delta is NOT used.
164 /// Read data from the video display rectangle
165 /// (SourceX, SourceY) (SourceX + Width, SourceY + Height) and place it in
166 /// the BltBuffer rectangle (DestinationX, DestinationY )
167 /// (DestinationX + Width, DestinationY + Height). If DestinationX or
168 /// DestinationY is not zero then Delta must be set to the length in bytes
169 /// of a row in the BltBuffer.
171 EfiBltVideoToBltBuffer,
174 /// Write data from the BltBuffer rectangle
175 /// (SourceX, SourceY) (SourceX + Width, SourceY + Height) directly to the
176 /// video display rectangle (DestinationX, DestinationY)
177 /// (DestinationX + Width, DestinationY + Height). If SourceX or SourceY is
178 /// not zero then Delta must be set to the length in bytes of a row in the
184 /// Copy from the video display rectangle (SourceX, SourceY)
185 /// (SourceX + Width, SourceY + Height) to the video display rectangle
186 /// (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height).
187 /// The BltBuffer and Delta are not used in this mode.
191 EfiGraphicsOutputBltOperationMax
192 } EFI_GRAPHICS_OUTPUT_BLT_OPERATION;
195 Blt a rectangle of pixels on the graphics screen. Blt stands for BLock Transfer.
197 @param This Protocol instance pointer.
198 @param BltBuffer The data to transfer to the graphics screen.
199 Size is at least Width*Height*sizeof(EFI_GRAPHICS_OUTPUT_BLT_PIXEL).
200 @param BltOperation The operation to perform when copying BltBuffer on to the graphics screen.
201 @param SourceX The X coordinate of source for the BltOperation.
202 @param SourceY The Y coordinate of source for the BltOperation.
203 @param DestinationX The X coordinate of destination for the BltOperation.
204 @param DestinationY The Y coordinate of destination for the BltOperation.
205 @param Width The width of a rectangle in the blt rectangle in pixels.
206 @param Height The height of a rectangle in the blt rectangle in pixels.
207 @param Delta Not used for EfiBltVideoFill or the EfiBltVideoToVideo operation.
208 If a Delta of zero is used, the entire BltBuffer is being operated on.
209 If a subrectangle of the BltBuffer is being used then Delta
210 represents the number of bytes in a row of the BltBuffer.
212 @retval EFI_SUCCESS BltBuffer was drawn to the graphics screen.
213 @retval EFI_INVALID_PARAMETER BltOperation is not valid.
214 @retval EFI_DEVICE_ERROR The device had an error and could not complete the request.
219 (EFIAPI *EFI_GRAPHICS_OUTPUT_PROTOCOL_BLT)(
220 IN EFI_GRAPHICS_OUTPUT_PROTOCOL *This,
221 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer, OPTIONAL
222 IN EFI_GRAPHICS_OUTPUT_BLT_OPERATION BltOperation,
225 IN UINTN DestinationX,
226 IN UINTN DestinationY,
229 IN UINTN Delta OPTIONAL
234 /// The number of modes supported by QueryMode() and SetMode().
238 /// Current Mode of the graphics device. Valid mode numbers are 0 to MaxMode -1.
242 /// Pointer to read-only EFI_GRAPHICS_OUTPUT_MODE_INFORMATION data.
244 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION *Info;
246 /// Size of Info structure in bytes.
250 /// Base address of graphics linear frame buffer.
251 /// Offset zero in FrameBufferBase represents the upper left pixel of the display.
253 EFI_PHYSICAL_ADDRESS FrameBufferBase;
255 /// Amount of frame buffer needed to support the active mode as defined by
256 /// PixelsPerScanLine xVerticalResolution x PixelElementSize.
258 UINTN FrameBufferSize;
259 } EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE;
262 /// Provides a basic abstraction to set video modes and copy pixels to and from
263 /// the graphics controller's frame buffer. The linear address of the hardware
264 /// frame buffer is also exposed so software can write directly to the video hardware.
266 struct _EFI_GRAPHICS_OUTPUT_PROTOCOL {
267 EFI_GRAPHICS_OUTPUT_PROTOCOL_QUERY_MODE QueryMode;
268 EFI_GRAPHICS_OUTPUT_PROTOCOL_SET_MODE SetMode;
269 EFI_GRAPHICS_OUTPUT_PROTOCOL_BLT Blt;
271 /// Pointer to EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE data.
273 EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE *Mode;
276 extern EFI_GUID gEfiGraphicsOutputProtocolGuid;