3 * Screen handling functions
5 * Copyright (c) 2006 Christoph Pfisterer
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
15 * * Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the
20 * * Neither the name of Christoph Pfisterer nor the names of the
21 * contributors may be used to endorse or promote products derived
22 * from this software without specific prior written permission.
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
27 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
28 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
29 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
30 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 #include "../refind/screen.h"
39 #include "../refind/lib.h"
40 #include "../include/refit_call_wrapper.h"
42 #include <efiUgaDraw.h>
43 #include <efiConsoleControl.h>
45 #ifndef __MAKEWITH_GNUEFI
46 #define LibLocateProtocol EfiLibLocateProtocol
49 // Console defines and variables
51 static EFI_GUID ConsoleControlProtocolGuid
= EFI_CONSOLE_CONTROL_PROTOCOL_GUID
;
52 static EFI_CONSOLE_CONTROL_PROTOCOL
*ConsoleControl
= NULL
;
54 static EFI_GUID UgaDrawProtocolGuid
= EFI_UGA_DRAW_PROTOCOL_GUID
;
55 static EFI_UGA_DRAW_PROTOCOL
*UgaDraw
= NULL
;
57 static EFI_GUID GraphicsOutputProtocolGuid
= EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID
;
58 static EFI_GRAPHICS_OUTPUT_PROTOCOL
*GraphicsOutput
= NULL
;
60 static BOOLEAN egHasGraphics
= FALSE
;
61 static UINTN egScreenWidth
= 800;
62 static UINTN egScreenHeight
= 600;
68 VOID
egInitScreen(VOID
)
70 EFI_STATUS Status
= EFI_SUCCESS
;
71 UINT32 UGAWidth
, UGAHeight
, UGADepth
, UGARefreshRate
;
74 Status
= LibLocateProtocol(&ConsoleControlProtocolGuid
, (VOID
**) &ConsoleControl
);
75 if (EFI_ERROR(Status
))
76 ConsoleControl
= NULL
;
78 Status
= LibLocateProtocol(&UgaDrawProtocolGuid
, (VOID
**) &UgaDraw
);
79 if (EFI_ERROR(Status
))
82 Status
= LibLocateProtocol(&GraphicsOutputProtocolGuid
, (VOID
**) &GraphicsOutput
);
83 if (EFI_ERROR(Status
))
84 GraphicsOutput
= NULL
;
87 egHasGraphics
= FALSE
;
88 if (GraphicsOutput
!= NULL
) {
89 egScreenWidth
= GraphicsOutput
->Mode
->Info
->HorizontalResolution
;
90 egScreenHeight
= GraphicsOutput
->Mode
->Info
->VerticalResolution
;
92 } else if (UgaDraw
!= NULL
) {
93 Status
= refit_call5_wrapper(UgaDraw
->GetMode
, UgaDraw
, &UGAWidth
, &UGAHeight
, &UGADepth
, &UGARefreshRate
);
94 if (EFI_ERROR(Status
)) {
95 UgaDraw
= NULL
; // graphics not available
97 egScreenWidth
= UGAWidth
;
98 egScreenHeight
= UGAHeight
;
104 // Sets the screen resolution to the specified value, if possible.
105 // If the specified value is not valid, displays a warning with the valid
106 // modes on UEFI systems, or silently fails on EFI 1.x systems. Note that
107 // this function attempts to set ANY screen resolution, even 0x0 or
108 // ridiculously large values.
109 // Returns TRUE if successful, FALSE if not.
110 BOOLEAN
egSetScreenSize(IN UINTN ScreenWidth
, IN UINTN ScreenHeight
) {
111 EFI_STATUS Status
= EFI_SUCCESS
;
112 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
*Info
;
115 BOOLEAN ModeSet
= FALSE
;
116 UINT32 UGAWidth
, UGAHeight
, UGADepth
, UGARefreshRate
;
118 if (GraphicsOutput
!= NULL
) { // GOP mode (UEFI)
119 // Do a loop through the modes to see if the specified one is available;
120 // and if so, switch to it....
121 while ((Status
== EFI_SUCCESS
) && (!ModeSet
)) {
122 Status
= refit_call4_wrapper(GraphicsOutput
->QueryMode
, GraphicsOutput
, ModeNum
, &Size
, &Info
);
123 if ((Status
== EFI_SUCCESS
) && (Size
>= sizeof(*Info
)) &&
124 (Info
->HorizontalResolution
== ScreenWidth
) && (Info
->VerticalResolution
== ScreenHeight
)) {
125 Status
= refit_call2_wrapper(GraphicsOutput
->SetMode
, GraphicsOutput
, ModeNum
);
126 ModeSet
= (Status
== EFI_SUCCESS
);
132 egScreenWidth
= ScreenWidth
;
133 egScreenHeight
= ScreenHeight
;
134 } else {// If unsuccessful, display an error message for the user....
136 Print(L
"Error setting graphics mode %d x %d; using default mode!\nAvailable modes are:\n", ScreenWidth
, ScreenHeight
);
138 Status
= EFI_SUCCESS
;
139 while (Status
== EFI_SUCCESS
) {
140 Status
= refit_call4_wrapper(GraphicsOutput
->QueryMode
, GraphicsOutput
, ModeNum
, &Size
, &Info
);
141 if ((Status
== EFI_SUCCESS
) && (Size
>= sizeof(*Info
))) {
142 Print(L
"Mode %d: %d x %d\n", ModeNum
, Info
->HorizontalResolution
, Info
->VerticalResolution
);
149 } else if (UgaDraw
!= NULL
) { // UGA mode (EFI 1.x)
150 // Try to use current color depth & refresh rate for new mode. Maybe not the best choice
151 // in all cases, but I don't know how to probe for alternatives....
152 Status
= refit_call5_wrapper(UgaDraw
->GetMode
, UgaDraw
, &UGAWidth
, &UGAHeight
, &UGADepth
, &UGARefreshRate
);
153 Status
= refit_call5_wrapper(UgaDraw
->SetMode
, UgaDraw
, ScreenWidth
, ScreenHeight
, UGADepth
, UGARefreshRate
);
154 if (Status
== EFI_SUCCESS
) {
155 egScreenWidth
= ScreenWidth
;
156 egScreenHeight
= ScreenHeight
;
159 // TODO: Find a list of supported modes and display it.
160 // NOTE: Below doesn't actually appear unless we explicitly switch to text mode.
161 // This is just a placeholder until something better can be done....
162 Print(L
"Error setting graphics mode %d x %d; unsupported mode!\n");
166 } // BOOLEAN egSetScreenSize()
168 VOID
egGetScreenSize(OUT UINTN
*ScreenWidth
, OUT UINTN
*ScreenHeight
)
170 if (ScreenWidth
!= NULL
)
171 *ScreenWidth
= egScreenWidth
;
172 if (ScreenHeight
!= NULL
)
173 *ScreenHeight
= egScreenHeight
;
177 // Returns the mode that was actually set.
178 UINT32
egSetTextMode(UINT32 RequestedMode
) {
179 UINTN i
= 0, Width
, Height
;
180 UINT32 UsedMode
= ST
->ConOut
->Mode
->Mode
;
184 if (RequestedMode
!= ST
->ConOut
->Mode
->Mode
) {
185 Status
= refit_call2_wrapper(ST
->ConOut
->SetMode
, ST
->ConOut
, RequestedMode
);
186 if (Status
== EFI_SUCCESS
) {
187 UsedMode
= RequestedMode
;
190 Print(L
"Error setting text mode %d; available modes are:\n", ST
->ConOut
->Mode
->Mode
);
192 Status
= refit_call4_wrapper(ST
->ConOut
->QueryMode
, ST
->ConOut
, i
, &Width
, &Height
);
193 if (Status
== EFI_SUCCESS
)
194 Print(L
"Mode: %d: %d x %d\n", i
, Width
, Height
);
201 } // if/else successful change
202 } // if need to change mode
204 } // UINT32 egSetTextMode()
206 CHAR16
* egScreenDescription(VOID
)
208 CHAR16
*GraphicsInfo
, *TextInfo
= NULL
;
210 GraphicsInfo
= AllocateZeroPool(256 * sizeof(CHAR16
));
211 if (GraphicsInfo
== NULL
)
212 return L
"memory allocation error";
215 if (GraphicsOutput
!= NULL
) {
216 SPrint(GraphicsInfo
, 255, L
"Graphics Output (UEFI), %dx%d", egScreenWidth
, egScreenHeight
);
217 } else if (UgaDraw
!= NULL
) {
218 GraphicsInfo
= AllocateZeroPool(256 * sizeof(CHAR16
));
219 SPrint(GraphicsInfo
, 255, L
"UGA Draw (EFI 1.10), %dx%d", egScreenWidth
, egScreenHeight
);
221 MyFreePool(GraphicsInfo
);
222 MyFreePool(TextInfo
);
223 return L
"Internal Error";
225 if (!AllowGraphicsMode
) { // graphics-capable HW, but in text mode
226 TextInfo
= AllocateZeroPool(256 * sizeof(CHAR16
));
227 SPrint(TextInfo
, 255, L
"(in %dx%d text mode)", ConWidth
, ConHeight
);
228 MergeStrings(&GraphicsInfo
, TextInfo
, L
' ');
231 SPrint(GraphicsInfo
, 255, L
"Text-foo console, %dx%d", ConWidth
, ConHeight
);
233 MyFreePool(TextInfo
);
237 BOOLEAN
egHasGraphicsMode(VOID
)
239 return egHasGraphics
;
242 BOOLEAN
egIsGraphicsModeEnabled(VOID
)
244 EFI_CONSOLE_CONTROL_SCREEN_MODE CurrentMode
;
246 if (ConsoleControl
!= NULL
) {
247 refit_call4_wrapper(ConsoleControl
->GetMode
, ConsoleControl
, &CurrentMode
, NULL
, NULL
);
248 return (CurrentMode
== EfiConsoleControlScreenGraphics
) ? TRUE
: FALSE
;
254 VOID
egSetGraphicsModeEnabled(IN BOOLEAN Enable
)
256 EFI_CONSOLE_CONTROL_SCREEN_MODE CurrentMode
;
257 EFI_CONSOLE_CONTROL_SCREEN_MODE NewMode
;
259 if (ConsoleControl
!= NULL
) {
260 refit_call4_wrapper(ConsoleControl
->GetMode
, ConsoleControl
, &CurrentMode
, NULL
, NULL
);
262 NewMode
= Enable
? EfiConsoleControlScreenGraphics
263 : EfiConsoleControlScreenText
;
264 if (CurrentMode
!= NewMode
)
265 refit_call2_wrapper(ConsoleControl
->SetMode
, ConsoleControl
, NewMode
);
270 // Drawing to the screen
273 VOID
egClearScreen(IN EG_PIXEL
*Color
)
275 EFI_UGA_PIXEL FillColor
;
280 FillColor
.Red
= Color
->r
;
281 FillColor
.Green
= Color
->g
;
282 FillColor
.Blue
= Color
->b
;
283 FillColor
.Reserved
= 0;
285 if (GraphicsOutput
!= NULL
) {
286 // EFI_GRAPHICS_OUTPUT_BLT_PIXEL and EFI_UGA_PIXEL have the same
287 // layout, and the header from TianoCore actually defines them
288 // to be the same type.
289 refit_call10_wrapper(GraphicsOutput
->Blt
, GraphicsOutput
, (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*)&FillColor
, EfiBltVideoFill
,
290 0, 0, 0, 0, egScreenWidth
, egScreenHeight
, 0);
291 } else if (UgaDraw
!= NULL
) {
292 refit_call10_wrapper(UgaDraw
->Blt
, UgaDraw
, &FillColor
, EfiUgaVideoFill
,
293 0, 0, 0, 0, egScreenWidth
, egScreenHeight
, 0);
297 VOID
egDrawImage(IN EG_IMAGE
*Image
, IN UINTN ScreenPosX
, IN UINTN ScreenPosY
)
302 if (Image
->HasAlpha
) {
303 Image
->HasAlpha
= FALSE
;
304 egSetPlane(PLPTR(Image
, a
), 0, Image
->Width
* Image
->Height
);
307 if (GraphicsOutput
!= NULL
) {
308 refit_call10_wrapper(GraphicsOutput
->Blt
, GraphicsOutput
, (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*)Image
->PixelData
, EfiBltBufferToVideo
,
309 0, 0, ScreenPosX
, ScreenPosY
, Image
->Width
, Image
->Height
, 0);
310 } else if (UgaDraw
!= NULL
) {
311 refit_call10_wrapper(UgaDraw
->Blt
, UgaDraw
, (EFI_UGA_PIXEL
*)Image
->PixelData
, EfiUgaBltBufferToVideo
,
312 0, 0, ScreenPosX
, ScreenPosY
, Image
->Width
, Image
->Height
, 0);
316 VOID
egDrawImageArea(IN EG_IMAGE
*Image
,
317 IN UINTN AreaPosX
, IN UINTN AreaPosY
,
318 IN UINTN AreaWidth
, IN UINTN AreaHeight
,
319 IN UINTN ScreenPosX
, IN UINTN ScreenPosY
)
324 egRestrictImageArea(Image
, AreaPosX
, AreaPosY
, &AreaWidth
, &AreaHeight
);
328 if (Image
->HasAlpha
) {
329 Image
->HasAlpha
= FALSE
;
330 egSetPlane(PLPTR(Image
, a
), 0, Image
->Width
* Image
->Height
);
333 if (GraphicsOutput
!= NULL
) {
334 refit_call10_wrapper(GraphicsOutput
->Blt
, GraphicsOutput
, (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*)Image
->PixelData
, EfiBltBufferToVideo
,
335 AreaPosX
, AreaPosY
, ScreenPosX
, ScreenPosY
, AreaWidth
, AreaHeight
, Image
->Width
* 4);
336 } else if (UgaDraw
!= NULL
) {
337 refit_call10_wrapper(UgaDraw
->Blt
, UgaDraw
, (EFI_UGA_PIXEL
*)Image
->PixelData
, EfiUgaBltBufferToVideo
,
338 AreaPosX
, AreaPosY
, ScreenPosX
, ScreenPosY
, AreaWidth
, AreaHeight
, Image
->Width
* 4);
342 // Display a message in the center of the screen, surrounded by a box of the
343 // specified color. For the moment, uses graphics calls only. (It still works
344 // in text mode on GOP/UEFI systems, but not on UGA/EFI 1.x systems.)
345 VOID
egDisplayMessage(IN CHAR16
*Text
, EG_PIXEL
*BGColor
) {
346 UINTN BoxWidth
, BoxHeight
;
349 if ((Text
!= NULL
) && (BGColor
!= NULL
)) {
350 BoxWidth
= (StrLen(Text
) + 2) * FONT_CELL_WIDTH
;
351 if (BoxWidth
> egScreenWidth
)
352 BoxWidth
= egScreenWidth
;
353 BoxHeight
= 2 * FONT_CELL_HEIGHT
;
354 Box
= egCreateFilledImage(BoxWidth
, BoxHeight
, FALSE
, BGColor
);
355 egRenderText(Text
, Box
, FONT_CELL_WIDTH
, FONT_CELL_HEIGHT
/ 2);
356 egDrawImage(Box
, (egScreenWidth
- BoxWidth
) / 2, (egScreenHeight
- BoxHeight
) / 2);
357 } // if non-NULL inputs
358 } // VOID egDisplayMessage()
364 VOID
egScreenShot(VOID
)
369 UINTN FileDataLength
;
375 // allocate a buffer for the whole screen
376 Image
= egCreateImage(egScreenWidth
, egScreenHeight
, FALSE
);
378 Print(L
"Error egCreateImage returned NULL\n");
382 // get full screen image
383 if (GraphicsOutput
!= NULL
) {
384 refit_call10_wrapper(GraphicsOutput
->Blt
, GraphicsOutput
, (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*)Image
->PixelData
, EfiBltVideoToBltBuffer
,
385 0, 0, 0, 0, Image
->Width
, Image
->Height
, 0);
386 } else if (UgaDraw
!= NULL
) {
387 refit_call10_wrapper(UgaDraw
->Blt
, UgaDraw
, (EFI_UGA_PIXEL
*)Image
->PixelData
, EfiUgaVideoToBltBuffer
,
388 0, 0, 0, 0, Image
->Width
, Image
->Height
, 0);
392 egEncodeBMP(Image
, &FileData
, &FileDataLength
);
394 if (FileData
== NULL
) {
395 Print(L
"Error egEncodeBMP returned NULL\n");
399 // save to file on the ESP
400 Status
= egSaveFile(NULL
, L
"screenshot.bmp", FileData
, FileDataLength
);
402 if (EFI_ERROR(Status
)) {
403 Print(L
"Error egSaveFile: %x\n", Status
);
409 // DEBUG: switch to text mode
411 egSetGraphicsModeEnabled(FALSE
);
412 refit_call3_wrapper(BS
->WaitForEvent
, 1, &ST
->ConIn
->WaitForKey
, &Index
);