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.
37 * Modifications copyright (c) 2012 Roderick W. Smith
39 * Modifications distributed under the terms of the GNU General Public
40 * License (GPL) version 3 (GPLv3), a copy of which must be distributed
41 * with this source code or binaries made from it.
46 #include "../refind/screen.h"
47 #include "../refind/lib.h"
48 #include "../include/refit_call_wrapper.h"
50 #include <efiUgaDraw.h>
51 #include <efiConsoleControl.h>
53 #ifndef __MAKEWITH_GNUEFI
54 #define LibLocateProtocol EfiLibLocateProtocol
57 // Console defines and variables
59 static EFI_GUID ConsoleControlProtocolGuid
= EFI_CONSOLE_CONTROL_PROTOCOL_GUID
;
60 static EFI_CONSOLE_CONTROL_PROTOCOL
*ConsoleControl
= NULL
;
62 static EFI_GUID UgaDrawProtocolGuid
= EFI_UGA_DRAW_PROTOCOL_GUID
;
63 static EFI_UGA_DRAW_PROTOCOL
*UgaDraw
= NULL
;
65 static EFI_GUID GraphicsOutputProtocolGuid
= EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID
;
66 static EFI_GRAPHICS_OUTPUT_PROTOCOL
*GraphicsOutput
= NULL
;
68 static BOOLEAN egHasGraphics
= FALSE
;
69 static UINTN egScreenWidth
= 800;
70 static UINTN egScreenHeight
= 600;
76 VOID
egInitScreen(VOID
)
78 EFI_STATUS Status
= EFI_SUCCESS
;
79 UINT32 UGAWidth
, UGAHeight
, UGADepth
, UGARefreshRate
;
82 Status
= LibLocateProtocol(&ConsoleControlProtocolGuid
, (VOID
**) &ConsoleControl
);
83 if (EFI_ERROR(Status
))
84 ConsoleControl
= NULL
;
86 Status
= LibLocateProtocol(&UgaDrawProtocolGuid
, (VOID
**) &UgaDraw
);
87 if (EFI_ERROR(Status
))
90 Status
= LibLocateProtocol(&GraphicsOutputProtocolGuid
, (VOID
**) &GraphicsOutput
);
91 if (EFI_ERROR(Status
))
92 GraphicsOutput
= NULL
;
95 egHasGraphics
= FALSE
;
96 if (GraphicsOutput
!= NULL
) {
97 egScreenWidth
= GraphicsOutput
->Mode
->Info
->HorizontalResolution
;
98 egScreenHeight
= GraphicsOutput
->Mode
->Info
->VerticalResolution
;
100 } else if (UgaDraw
!= NULL
) {
101 Status
= refit_call5_wrapper(UgaDraw
->GetMode
, UgaDraw
, &UGAWidth
, &UGAHeight
, &UGADepth
, &UGARefreshRate
);
102 if (EFI_ERROR(Status
)) {
103 UgaDraw
= NULL
; // graphics not available
105 egScreenWidth
= UGAWidth
;
106 egScreenHeight
= UGAHeight
;
107 egHasGraphics
= TRUE
;
112 // Sets the screen resolution to the specified value, if possible. If *ScreenHeight
113 // is 0 and GOP mode is detected, assume that *ScreenWidth contains a GOP mode
114 // number rather than a horizontal resolution. If the specified resolution is not
115 // valid, displays a warning with the valid modes on GOP (UEFI) systems, or silently
116 // fails on UGA (EFI 1.x) systems. Note that this function attempts to set ANY screen
117 // resolution, even 0x0 or ridiculously large values.
118 // Upon success, returns actual screen resolution in *ScreenWidth and *ScreenHeight.
119 // These values are unchanged upon failure.
120 // Returns TRUE if successful, FALSE if not.
121 BOOLEAN
egSetScreenSize(IN OUT UINTN
*ScreenWidth
, IN OUT UINTN
*ScreenHeight
) {
122 EFI_STATUS Status
= EFI_SUCCESS
;
123 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
*Info
;
126 BOOLEAN ModeSet
= FALSE
;
127 UINT32 UGAWidth
, UGAHeight
, UGADepth
, UGARefreshRate
;
129 if (GraphicsOutput
!= NULL
) { // GOP mode (UEFI)
130 if (*ScreenHeight
== 0) { // User specified a mode number (stored in *ScreenWidth); use it directly
131 if (*ScreenWidth
== GraphicsOutput
->Mode
->Mode
) { // user requested current mode; do nothing
133 *ScreenWidth
= Info
->HorizontalResolution
;
134 *ScreenHeight
= Info
->VerticalResolution
;
136 ModeNum
= (UINT32
) *ScreenWidth
;
137 Status
= refit_call4_wrapper(GraphicsOutput
->QueryMode
, GraphicsOutput
, ModeNum
, &Size
, &Info
);
138 if (Status
== EFI_SUCCESS
) {
139 Status
= refit_call2_wrapper(GraphicsOutput
->SetMode
, GraphicsOutput
, ModeNum
);
140 if (Status
== EFI_SUCCESS
) {
142 *ScreenWidth
= Info
->HorizontalResolution
;
143 *ScreenHeight
= Info
->VerticalResolution
;
145 } // if queried mode OK
148 // User specified width & height; must find mode -- but only if change is required....
150 Status
= refit_call4_wrapper(GraphicsOutput
->QueryMode
, GraphicsOutput
, GraphicsOutput
->Mode
->Mode
, &Size
, &Info
);
151 if ((Status
== EFI_SUCCESS
) && (Info
->HorizontalResolution
== *ScreenWidth
) &&
152 (Info
->VerticalResolution
== *ScreenHeight
)) {
153 ModeSet
= TRUE
; // user requested current mode; do nothing
155 // Do a loop through the modes to see if the specified one is available;
156 // and if so, switch to it....
158 Status
= refit_call4_wrapper(GraphicsOutput
->QueryMode
, GraphicsOutput
, ModeNum
, &Size
, &Info
);
159 if ((Status
== EFI_SUCCESS
) && (Size
>= sizeof(*Info
)) &&
160 (Info
->HorizontalResolution
== *ScreenWidth
) && (Info
->VerticalResolution
== *ScreenHeight
)) {
161 Status
= refit_call2_wrapper(GraphicsOutput
->SetMode
, GraphicsOutput
, ModeNum
);
162 ModeSet
= (Status
== EFI_SUCCESS
);
164 } while ((++ModeNum
< GraphicsOutput
->Mode
->MaxMode
) && !ModeSet
);
169 egScreenWidth
= *ScreenWidth
;
170 egScreenHeight
= *ScreenHeight
;
171 } else {// If unsuccessful, display an error message for the user....
173 Print(L
"Error setting graphics mode %d x %d; using default mode!\nAvailable modes are:\n", *ScreenWidth
, *ScreenHeight
);
176 Status
= refit_call4_wrapper(GraphicsOutput
->QueryMode
, GraphicsOutput
, ModeNum
, &Size
, &Info
);
177 if ((Status
== EFI_SUCCESS
) && (Info
!= NULL
)) {
178 Print(L
"Mode %d: %d x %d\n", ModeNum
, Info
->HorizontalResolution
, Info
->VerticalResolution
);
180 } while (++ModeNum
< GraphicsOutput
->Mode
->MaxMode
);
185 } else if (UgaDraw
!= NULL
) { // UGA mode (EFI 1.x)
186 // Try to use current color depth & refresh rate for new mode. Maybe not the best choice
187 // in all cases, but I don't know how to probe for alternatives....
188 Status
= refit_call5_wrapper(UgaDraw
->GetMode
, UgaDraw
, &UGAWidth
, &UGAHeight
, &UGADepth
, &UGARefreshRate
);
189 Status
= refit_call5_wrapper(UgaDraw
->SetMode
, UgaDraw
, *ScreenWidth
, *ScreenHeight
, UGADepth
, UGARefreshRate
);
190 if (Status
== EFI_SUCCESS
) {
191 egScreenWidth
= *ScreenWidth
;
192 egScreenHeight
= *ScreenHeight
;
195 // TODO: Find a list of supported modes and display it.
196 // NOTE: Below doesn't actually appear unless we explicitly switch to text mode.
197 // This is just a placeholder until something better can be done....
198 Print(L
"Error setting graphics mode %d x %d; unsupported mode!\n");
202 } // BOOLEAN egSetScreenSize()
204 VOID
egGetScreenSize(OUT UINTN
*ScreenWidth
, OUT UINTN
*ScreenHeight
)
206 if (ScreenWidth
!= NULL
)
207 *ScreenWidth
= egScreenWidth
;
208 if (ScreenHeight
!= NULL
)
209 *ScreenHeight
= egScreenHeight
;
213 // Returns the mode that was actually set.
214 UINT32
egSetTextMode(UINT32 RequestedMode
) {
215 UINTN i
= 0, Width
, Height
;
216 UINT32 UsedMode
= ST
->ConOut
->Mode
->Mode
;
219 if (RequestedMode
!= ST
->ConOut
->Mode
->Mode
) {
220 Status
= refit_call2_wrapper(ST
->ConOut
->SetMode
, ST
->ConOut
, RequestedMode
);
221 if (Status
== EFI_SUCCESS
) {
222 UsedMode
= RequestedMode
;
225 Print(L
"Error setting text mode %d; available modes are:\n", RequestedMode
);
227 Status
= refit_call4_wrapper(ST
->ConOut
->QueryMode
, ST
->ConOut
, i
, &Width
, &Height
);
228 if (Status
== EFI_SUCCESS
)
229 Print(L
"Mode %d: %d x %d\n", i
, Width
, Height
);
230 } while (++i
< ST
->ConOut
->Mode
->MaxMode
);
234 } // if/else successful change
235 } // if need to change mode
237 } // UINT32 egSetTextMode()
239 CHAR16
* egScreenDescription(VOID
)
241 CHAR16
*GraphicsInfo
, *TextInfo
= NULL
;
243 GraphicsInfo
= AllocateZeroPool(256 * sizeof(CHAR16
));
244 if (GraphicsInfo
== NULL
)
245 return L
"memory allocation error";
248 if (GraphicsOutput
!= NULL
) {
249 SPrint(GraphicsInfo
, 255, L
"Graphics Output (UEFI), %dx%d", egScreenWidth
, egScreenHeight
);
250 } else if (UgaDraw
!= NULL
) {
251 GraphicsInfo
= AllocateZeroPool(256 * sizeof(CHAR16
));
252 SPrint(GraphicsInfo
, 255, L
"UGA Draw (EFI 1.10), %dx%d", egScreenWidth
, egScreenHeight
);
254 MyFreePool(GraphicsInfo
);
255 MyFreePool(TextInfo
);
256 return L
"Internal Error";
258 if (!AllowGraphicsMode
) { // graphics-capable HW, but in text mode
259 TextInfo
= AllocateZeroPool(256 * sizeof(CHAR16
));
260 SPrint(TextInfo
, 255, L
"(in %dx%d text mode)", ConWidth
, ConHeight
);
261 MergeStrings(&GraphicsInfo
, TextInfo
, L
' ');
264 SPrint(GraphicsInfo
, 255, L
"Text-foo console, %dx%d", ConWidth
, ConHeight
);
266 MyFreePool(TextInfo
);
270 BOOLEAN
egHasGraphicsMode(VOID
)
272 return egHasGraphics
;
275 BOOLEAN
egIsGraphicsModeEnabled(VOID
)
277 EFI_CONSOLE_CONTROL_SCREEN_MODE CurrentMode
;
279 if (ConsoleControl
!= NULL
) {
280 refit_call4_wrapper(ConsoleControl
->GetMode
, ConsoleControl
, &CurrentMode
, NULL
, NULL
);
281 return (CurrentMode
== EfiConsoleControlScreenGraphics
) ? TRUE
: FALSE
;
287 VOID
egSetGraphicsModeEnabled(IN BOOLEAN Enable
)
289 EFI_CONSOLE_CONTROL_SCREEN_MODE CurrentMode
;
290 EFI_CONSOLE_CONTROL_SCREEN_MODE NewMode
;
292 if (ConsoleControl
!= NULL
) {
293 refit_call4_wrapper(ConsoleControl
->GetMode
, ConsoleControl
, &CurrentMode
, NULL
, NULL
);
295 NewMode
= Enable
? EfiConsoleControlScreenGraphics
296 : EfiConsoleControlScreenText
;
297 if (CurrentMode
!= NewMode
)
298 refit_call2_wrapper(ConsoleControl
->SetMode
, ConsoleControl
, NewMode
);
303 // Drawing to the screen
306 VOID
egClearScreen(IN EG_PIXEL
*Color
)
308 EFI_UGA_PIXEL FillColor
;
314 FillColor
.Red
= Color
->r
;
315 FillColor
.Green
= Color
->g
;
316 FillColor
.Blue
= Color
->b
;
319 FillColor
.Green
= 0x0;
320 FillColor
.Blue
= 0x0;
322 FillColor
.Reserved
= 0;
324 if (GraphicsOutput
!= NULL
) {
325 // EFI_GRAPHICS_OUTPUT_BLT_PIXEL and EFI_UGA_PIXEL have the same
326 // layout, and the header from TianoCore actually defines them
327 // to be the same type.
328 refit_call10_wrapper(GraphicsOutput
->Blt
, GraphicsOutput
, (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*)&FillColor
, EfiBltVideoFill
,
329 0, 0, 0, 0, egScreenWidth
, egScreenHeight
, 0);
330 } else if (UgaDraw
!= NULL
) {
331 refit_call10_wrapper(UgaDraw
->Blt
, UgaDraw
, &FillColor
, EfiUgaVideoFill
, 0, 0, 0, 0, egScreenWidth
, egScreenHeight
, 0);
335 VOID
egDrawImage(IN EG_IMAGE
*Image
, IN UINTN ScreenPosX
, IN UINTN ScreenPosY
)
340 if (Image
->HasAlpha
) {
341 Image
->HasAlpha
= FALSE
;
342 egSetPlane(PLPTR(Image
, a
), 0, Image
->Width
* Image
->Height
);
345 if (GraphicsOutput
!= NULL
) {
346 refit_call10_wrapper(GraphicsOutput
->Blt
, GraphicsOutput
, (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*)Image
->PixelData
, EfiBltBufferToVideo
,
347 0, 0, ScreenPosX
, ScreenPosY
, Image
->Width
, Image
->Height
, 0);
348 } else if (UgaDraw
!= NULL
) {
349 refit_call10_wrapper(UgaDraw
->Blt
, UgaDraw
, (EFI_UGA_PIXEL
*)Image
->PixelData
, EfiUgaBltBufferToVideo
,
350 0, 0, ScreenPosX
, ScreenPosY
, Image
->Width
, Image
->Height
, 0);
354 VOID
egDrawImageArea(IN EG_IMAGE
*Image
,
355 IN UINTN AreaPosX
, IN UINTN AreaPosY
,
356 IN UINTN AreaWidth
, IN UINTN AreaHeight
,
357 IN UINTN ScreenPosX
, IN UINTN ScreenPosY
)
362 egRestrictImageArea(Image
, AreaPosX
, AreaPosY
, &AreaWidth
, &AreaHeight
);
366 if (Image
->HasAlpha
) {
367 Image
->HasAlpha
= FALSE
;
368 egSetPlane(PLPTR(Image
, a
), 0, Image
->Width
* Image
->Height
);
371 if (GraphicsOutput
!= NULL
) {
372 refit_call10_wrapper(GraphicsOutput
->Blt
, GraphicsOutput
, (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*)Image
->PixelData
, EfiBltBufferToVideo
,
373 AreaPosX
, AreaPosY
, ScreenPosX
, ScreenPosY
, AreaWidth
, AreaHeight
, Image
->Width
* 4);
374 } else if (UgaDraw
!= NULL
) {
375 refit_call10_wrapper(UgaDraw
->Blt
, UgaDraw
, (EFI_UGA_PIXEL
*)Image
->PixelData
, EfiUgaBltBufferToVideo
,
376 AreaPosX
, AreaPosY
, ScreenPosX
, ScreenPosY
, AreaWidth
, AreaHeight
, Image
->Width
* 4);
380 // Display a message in the center of the screen, surrounded by a box of the
381 // specified color. For the moment, uses graphics calls only. (It still works
382 // in text mode on GOP/UEFI systems, but not on UGA/EFI 1.x systems.)
383 VOID
egDisplayMessage(IN CHAR16
*Text
, EG_PIXEL
*BGColor
) {
384 UINTN BoxWidth
, BoxHeight
;
387 if ((Text
!= NULL
) && (BGColor
!= NULL
)) {
388 BoxWidth
= (StrLen(Text
) + 2) * FONT_CELL_WIDTH
;
389 if (BoxWidth
> egScreenWidth
)
390 BoxWidth
= egScreenWidth
;
391 BoxHeight
= 2 * FONT_CELL_HEIGHT
;
392 Box
= egCreateFilledImage(BoxWidth
, BoxHeight
, FALSE
, BGColor
);
393 egRenderText(Text
, Box
, FONT_CELL_WIDTH
, FONT_CELL_HEIGHT
/ 2);
394 egDrawImage(Box
, (egScreenWidth
- BoxWidth
) / 2, (egScreenHeight
- BoxHeight
) / 2);
395 } // if non-NULL inputs
396 } // VOID egDisplayMessage()
402 VOID
egScreenShot(VOID
)
407 UINTN FileDataLength
;
413 // allocate a buffer for the whole screen
414 Image
= egCreateImage(egScreenWidth
, egScreenHeight
, FALSE
);
416 Print(L
"Error egCreateImage returned NULL\n");
420 // get full screen image
421 if (GraphicsOutput
!= NULL
) {
422 refit_call10_wrapper(GraphicsOutput
->Blt
, GraphicsOutput
, (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*)Image
->PixelData
, EfiBltVideoToBltBuffer
,
423 0, 0, 0, 0, Image
->Width
, Image
->Height
, 0);
424 } else if (UgaDraw
!= NULL
) {
425 refit_call10_wrapper(UgaDraw
->Blt
, UgaDraw
, (EFI_UGA_PIXEL
*)Image
->PixelData
, EfiUgaVideoToBltBuffer
,
426 0, 0, 0, 0, Image
->Width
, Image
->Height
, 0);
430 egEncodeBMP(Image
, &FileData
, &FileDataLength
);
432 if (FileData
== NULL
) {
433 Print(L
"Error egEncodeBMP returned NULL\n");
437 // save to file on the ESP
438 Status
= egSaveFile(NULL
, L
"screenshot.bmp", FileData
, FileDataLength
);
440 if (EFI_ERROR(Status
)) {
441 Print(L
"Error egSaveFile: %x\n", Status
);
447 // DEBUG: switch to text mode
449 egSetGraphicsModeEnabled(FALSE
);
450 refit_call3_wrapper(BS
->WaitForEvent
, 1, &ST
->ConIn
->WaitForKey
, &Index
);