2 This is the main routine for initializing the Graphics Console support routines.
4 Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #include "GraphicsConsole.h"
18 // Graphics Console Device Private Data template
20 GRAPHICS_CONSOLE_DEV mGraphicsConsoleDevTemplate
= {
21 GRAPHICS_CONSOLE_DEV_SIGNATURE
,
22 (EFI_GRAPHICS_OUTPUT_PROTOCOL
*) NULL
,
23 (EFI_UGA_DRAW_PROTOCOL
*) NULL
,
25 GraphicsConsoleConOutReset
,
26 GraphicsConsoleConOutOutputString
,
27 GraphicsConsoleConOutTestString
,
28 GraphicsConsoleConOutQueryMode
,
29 GraphicsConsoleConOutSetMode
,
30 GraphicsConsoleConOutSetAttribute
,
31 GraphicsConsoleConOutClearScreen
,
32 GraphicsConsoleConOutSetCursorPosition
,
33 GraphicsConsoleConOutEnableCursor
,
34 (EFI_SIMPLE_TEXT_OUTPUT_MODE
*) NULL
39 EFI_TEXT_ATTR(EFI_LIGHTGRAY
, EFI_BLACK
),
44 (GRAPHICS_CONSOLE_MODE_DATA
*) NULL
,
45 (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*) NULL
48 GRAPHICS_CONSOLE_MODE_DATA mGraphicsConsoleModeData
[] = {
51 // New modes can be added here.
52 // The last entry is specific for full screen mode.
57 EFI_HII_DATABASE_PROTOCOL
*mHiiDatabase
;
58 EFI_HII_FONT_PROTOCOL
*mHiiFont
;
59 EFI_HII_HANDLE mHiiHandle
;
60 EFI_EVENT mHiiRegistration
;
62 EFI_GUID mFontPackageListGuid
= {0xf5f219d3, 0x7006, 0x4648, {0xac, 0x8d, 0xd6, 0x1d, 0xfb, 0x7b, 0xc6, 0xad}};
64 CHAR16 mCrLfString
[3] = { CHAR_CARRIAGE_RETURN
, CHAR_LINEFEED
, CHAR_NULL
};
66 EFI_GRAPHICS_OUTPUT_BLT_PIXEL mGraphicsEfiColors
[16] = {
70 {0x00, 0x00, 0x00, 0x00}, // BLACK
71 {0x98, 0x00, 0x00, 0x00}, // LIGHTBLUE
72 {0x00, 0x98, 0x00, 0x00}, // LIGHGREEN
73 {0x98, 0x98, 0x00, 0x00}, // LIGHCYAN
74 {0x00, 0x00, 0x98, 0x00}, // LIGHRED
75 {0x98, 0x00, 0x98, 0x00}, // MAGENTA
76 {0x00, 0x98, 0x98, 0x00}, // BROWN
77 {0x98, 0x98, 0x98, 0x00}, // LIGHTGRAY
78 {0x30, 0x30, 0x30, 0x00}, // DARKGRAY - BRIGHT BLACK
79 {0xff, 0x00, 0x00, 0x00}, // BLUE
80 {0x00, 0xff, 0x00, 0x00}, // LIME
81 {0xff, 0xff, 0x00, 0x00}, // CYAN
82 {0x00, 0x00, 0xff, 0x00}, // RED
83 {0xff, 0x00, 0xff, 0x00}, // FUCHSIA
84 {0x00, 0xff, 0xff, 0x00}, // YELLOW
85 {0xff, 0xff, 0xff, 0x00} // WHITE
88 EFI_NARROW_GLYPH mCursorGlyph
= {
91 { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xFF, 0xFF, 0xFF }
94 CHAR16 SpaceStr
[] = { NARROW_CHAR
, ' ', 0 };
96 EFI_DRIVER_BINDING_PROTOCOL gGraphicsConsoleDriverBinding
= {
97 GraphicsConsoleControllerDriverSupported
,
98 GraphicsConsoleControllerDriverStart
,
99 GraphicsConsoleControllerDriverStop
,
106 Test to see if Graphics Console could be supported on the Controller.
108 Graphics Console could be supported if Graphics Output Protocol or UGA Draw
109 Protocol exists on the Controller. (UGA Draw Protocol could be skipped
110 if PcdUgaConsumeSupport is set to FALSE.)
112 @param This Protocol instance pointer.
113 @param Controller Handle of device to test.
114 @param RemainingDevicePath Optional parameter use to pick a specific child
117 @retval EFI_SUCCESS This driver supports this device.
118 @retval other This driver does not support this device.
123 GraphicsConsoleControllerDriverSupported (
124 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
125 IN EFI_HANDLE Controller
,
126 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
130 EFI_GRAPHICS_OUTPUT_PROTOCOL
*GraphicsOutput
;
131 EFI_UGA_DRAW_PROTOCOL
*UgaDraw
;
132 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
134 GraphicsOutput
= NULL
;
137 // Open the IO Abstraction(s) needed to perform the supported test
139 Status
= gBS
->OpenProtocol (
141 &gEfiGraphicsOutputProtocolGuid
,
142 (VOID
**) &GraphicsOutput
,
143 This
->DriverBindingHandle
,
145 EFI_OPEN_PROTOCOL_BY_DRIVER
148 if (EFI_ERROR (Status
) && FeaturePcdGet (PcdUgaConsumeSupport
)) {
150 // Open Graphics Output Protocol failed, try to open UGA Draw Protocol
152 Status
= gBS
->OpenProtocol (
154 &gEfiUgaDrawProtocolGuid
,
156 This
->DriverBindingHandle
,
158 EFI_OPEN_PROTOCOL_BY_DRIVER
161 if (EFI_ERROR (Status
)) {
166 // We need to ensure that we do not layer on top of a virtual handle.
167 // We need to ensure that the handles produced by the conspliter do not
170 Status
= gBS
->OpenProtocol (
172 &gEfiDevicePathProtocolGuid
,
173 (VOID
**) &DevicePath
,
174 This
->DriverBindingHandle
,
176 EFI_OPEN_PROTOCOL_BY_DRIVER
178 if (!EFI_ERROR (Status
)) {
181 &gEfiDevicePathProtocolGuid
,
182 This
->DriverBindingHandle
,
190 // Does Hii Exist? If not, we aren't ready to run
192 Status
= EfiLocateHiiProtocol ();
195 // Close the I/O Abstraction(s) used to perform the supported test
198 if (GraphicsOutput
!= NULL
) {
201 &gEfiGraphicsOutputProtocolGuid
,
202 This
->DriverBindingHandle
,
205 } else if (FeaturePcdGet (PcdUgaConsumeSupport
)) {
208 &gEfiUgaDrawProtocolGuid
,
209 This
->DriverBindingHandle
,
217 Initialize all the text modes which the graphics console supports.
219 It returns information for available text modes that the graphics can support.
221 @param[in] HorizontalResolution The size of video screen in pixels in the X dimension.
222 @param[in] VerticalResolution The size of video screen in pixels in the Y dimension.
223 @param[in] GopModeNumber The graphics mode number which graphis console is based on.
224 @param[out] TextModeCount The total number of text modes that graphics console supports.
225 @param[out] TextModeData The buffer to the text modes column and row information.
226 Caller is responsible to free it when it's non-NULL.
228 @retval EFI_SUCCESS The supporting mode information is returned.
229 @retval EFI_INVALID_PARAMETER The parameters are invalid.
233 InitializeGraphicsConsoleTextMode (
234 IN UINT32 HorizontalResolution
,
235 IN UINT32 VerticalResolution
,
236 IN UINT32 GopModeNumber
,
237 OUT UINTN
*TextModeCount
,
238 OUT GRAPHICS_CONSOLE_MODE_DATA
**TextModeData
243 GRAPHICS_CONSOLE_MODE_DATA
*ModeBuffer
;
244 GRAPHICS_CONSOLE_MODE_DATA
*NewModeBuffer
;
250 if ((TextModeCount
== NULL
) || (TextModeData
== NULL
)) {
251 return EFI_INVALID_PARAMETER
;
254 Count
= sizeof (mGraphicsConsoleModeData
) / sizeof (GRAPHICS_CONSOLE_MODE_DATA
);
257 // Compute the maximum number of text Rows and Columns that this current graphics mode can support.
258 // To make graphics console work well, MaxColumns and MaxRows should not be zero.
260 MaxColumns
= HorizontalResolution
/ EFI_GLYPH_WIDTH
;
261 MaxRows
= VerticalResolution
/ EFI_GLYPH_HEIGHT
;
264 // According to UEFI spec, all output devices support at least 80x25 text mode.
266 ASSERT ((MaxColumns
>= 80) && (MaxRows
>= 25));
269 // Add full screen mode to the last entry.
271 mGraphicsConsoleModeData
[Count
- 1].Columns
= MaxColumns
;
272 mGraphicsConsoleModeData
[Count
- 1].Rows
= MaxRows
;
275 // Get defined mode buffer pointer.
277 ModeBuffer
= mGraphicsConsoleModeData
;
280 // Here we make sure that the final mode exposed does not include the duplicated modes,
281 // and does not include the invalid modes which exceed the max column and row.
282 // Reserve 2 modes for 80x25, 80x50 of graphics console.
284 NewModeBuffer
= AllocateZeroPool (sizeof (GRAPHICS_CONSOLE_MODE_DATA
) * (Count
+ 2));
285 ASSERT (NewModeBuffer
!= NULL
);
288 // Mode 0 and mode 1 is for 80x25, 80x50 according to UEFI spec.
292 NewModeBuffer
[ValidCount
].Columns
= 80;
293 NewModeBuffer
[ValidCount
].Rows
= 25;
294 NewModeBuffer
[ValidCount
].GopWidth
= HorizontalResolution
;
295 NewModeBuffer
[ValidCount
].GopHeight
= VerticalResolution
;
296 NewModeBuffer
[ValidCount
].GopModeNumber
= GopModeNumber
;
297 NewModeBuffer
[ValidCount
].DeltaX
= (HorizontalResolution
- (NewModeBuffer
[ValidCount
].Columns
* EFI_GLYPH_WIDTH
)) >> 1;
298 NewModeBuffer
[ValidCount
].DeltaY
= (VerticalResolution
- (NewModeBuffer
[ValidCount
].Rows
* EFI_GLYPH_HEIGHT
)) >> 1;
301 if ((MaxColumns
>= 80) && (MaxRows
>= 50)) {
302 NewModeBuffer
[ValidCount
].Columns
= 80;
303 NewModeBuffer
[ValidCount
].Rows
= 50;
304 NewModeBuffer
[ValidCount
].DeltaX
= (HorizontalResolution
- (80 * EFI_GLYPH_WIDTH
)) >> 1;
305 NewModeBuffer
[ValidCount
].DeltaY
= (VerticalResolution
- (50 * EFI_GLYPH_HEIGHT
)) >> 1;
307 NewModeBuffer
[ValidCount
].GopWidth
= HorizontalResolution
;
308 NewModeBuffer
[ValidCount
].GopHeight
= VerticalResolution
;
309 NewModeBuffer
[ValidCount
].GopModeNumber
= GopModeNumber
;
313 // Start from mode 2 to put the valid mode other than 80x25 and 80x50 in the output mode buffer.
315 for (Index
= 0; Index
< Count
; Index
++) {
316 if ((ModeBuffer
[Index
].Columns
== 0) || (ModeBuffer
[Index
].Rows
== 0) ||
317 (ModeBuffer
[Index
].Columns
> MaxColumns
) || (ModeBuffer
[Index
].Rows
> MaxRows
)) {
319 // Skip the pre-defined mode which is invalid or exceeds the max column and row.
323 for (ValidIndex
= 0; ValidIndex
< ValidCount
; ValidIndex
++) {
324 if ((ModeBuffer
[Index
].Columns
== NewModeBuffer
[ValidIndex
].Columns
) &&
325 (ModeBuffer
[Index
].Rows
== NewModeBuffer
[ValidIndex
].Rows
)) {
327 // Skip the duplicated mode.
332 if (ValidIndex
== ValidCount
) {
333 NewModeBuffer
[ValidCount
].Columns
= ModeBuffer
[Index
].Columns
;
334 NewModeBuffer
[ValidCount
].Rows
= ModeBuffer
[Index
].Rows
;
335 NewModeBuffer
[ValidCount
].GopWidth
= HorizontalResolution
;
336 NewModeBuffer
[ValidCount
].GopHeight
= VerticalResolution
;
337 NewModeBuffer
[ValidCount
].GopModeNumber
= GopModeNumber
;
338 NewModeBuffer
[ValidCount
].DeltaX
= (HorizontalResolution
- (NewModeBuffer
[ValidCount
].Columns
* EFI_GLYPH_WIDTH
)) >> 1;
339 NewModeBuffer
[ValidCount
].DeltaY
= (VerticalResolution
- (NewModeBuffer
[ValidCount
].Rows
* EFI_GLYPH_HEIGHT
)) >> 1;
345 for (Index
= 0; Index
< ValidCount
; Index
++) {
346 DEBUG ((EFI_D_INFO
, "Graphics - Mode %d, Column = %d, Row = %d\n",
347 Index
, NewModeBuffer
[Index
].Columns
, NewModeBuffer
[Index
].Rows
));
352 // Return valid mode count and mode information buffer.
354 *TextModeCount
= ValidCount
;
355 *TextModeData
= NewModeBuffer
;
360 Start this driver on Controller by opening Graphics Output protocol or
361 UGA Draw protocol, and installing Simple Text Out protocol on Controller.
362 (UGA Draw protocol could be skipped if PcdUgaConsumeSupport is set to FALSE.)
364 @param This Protocol instance pointer.
365 @param Controller Handle of device to bind driver to
366 @param RemainingDevicePath Optional parameter use to pick a specific child
369 @retval EFI_SUCCESS This driver is added to Controller.
370 @retval other This driver does not support this device.
375 GraphicsConsoleControllerDriverStart (
376 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
377 IN EFI_HANDLE Controller
,
378 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
382 GRAPHICS_CONSOLE_DEV
*Private
;
383 UINT32 HorizontalResolution
;
384 UINT32 VerticalResolution
;
390 EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE
*Mode
;
392 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
*Info
;
397 // Initialize the Graphics Console device instance
399 Private
= AllocateCopyPool (
400 sizeof (GRAPHICS_CONSOLE_DEV
),
401 &mGraphicsConsoleDevTemplate
403 if (Private
== NULL
) {
404 return EFI_OUT_OF_RESOURCES
;
407 Private
->SimpleTextOutput
.Mode
= &(Private
->SimpleTextOutputMode
);
409 Status
= gBS
->OpenProtocol (
411 &gEfiGraphicsOutputProtocolGuid
,
412 (VOID
**) &Private
->GraphicsOutput
,
413 This
->DriverBindingHandle
,
415 EFI_OPEN_PROTOCOL_BY_DRIVER
418 if (EFI_ERROR(Status
) && FeaturePcdGet (PcdUgaConsumeSupport
)) {
419 Status
= gBS
->OpenProtocol (
421 &gEfiUgaDrawProtocolGuid
,
422 (VOID
**) &Private
->UgaDraw
,
423 This
->DriverBindingHandle
,
425 EFI_OPEN_PROTOCOL_BY_DRIVER
429 if (EFI_ERROR (Status
)) {
433 HorizontalResolution
= PcdGet32 (PcdVideoHorizontalResolution
);
434 VerticalResolution
= PcdGet32 (PcdVideoVerticalResolution
);
436 if (Private
->GraphicsOutput
!= NULL
) {
438 // The console is build on top of Graphics Output Protocol, find the mode number
439 // for the user-defined mode; if there are multiple video devices,
440 // graphic console driver will set all the video devices to the same mode.
442 if ((HorizontalResolution
== 0x0) || (VerticalResolution
== 0x0)) {
444 // Find the highest resolution which GOP supports.
446 MaxMode
= Private
->GraphicsOutput
->Mode
->MaxMode
;
448 for (ModeIndex
= 0; ModeIndex
< MaxMode
; ModeIndex
++) {
449 Status
= Private
->GraphicsOutput
->QueryMode (
450 Private
->GraphicsOutput
,
455 if (!EFI_ERROR (Status
)) {
456 if ((Info
->HorizontalResolution
>= HorizontalResolution
) &&
457 (Info
->VerticalResolution
>= VerticalResolution
)) {
458 HorizontalResolution
= Info
->HorizontalResolution
;
459 VerticalResolution
= Info
->VerticalResolution
;
460 ModeNumber
= ModeIndex
;
465 if ((HorizontalResolution
== 0x0) || (VerticalResolution
== 0x0)) {
466 Status
= EFI_UNSUPPORTED
;
471 // Use user-defined resolution
473 Status
= CheckModeSupported (
474 Private
->GraphicsOutput
,
475 HorizontalResolution
,
479 if (EFI_ERROR (Status
)) {
481 // if not supporting current mode, try 800x600 which is required by UEFI/EFI spec
483 Status
= CheckModeSupported (
484 Private
->GraphicsOutput
,
489 Mode
= Private
->GraphicsOutput
->Mode
;
490 if (EFI_ERROR (Status
) && Mode
->MaxMode
!= 0) {
492 // Set default mode failed or device don't support default mode, then get the current mode information
494 HorizontalResolution
= Mode
->Info
->HorizontalResolution
;
495 VerticalResolution
= Mode
->Info
->VerticalResolution
;
496 ModeNumber
= Mode
->Mode
;
500 } else if (FeaturePcdGet (PcdUgaConsumeSupport
)) {
502 // At first try to set user-defined resolution
506 Status
= Private
->UgaDraw
->SetMode (
508 HorizontalResolution
,
513 if (EFI_ERROR (Status
)) {
515 // Try to set 800*600 which is required by UEFI/EFI spec
517 Status
= Private
->UgaDraw
->SetMode (
524 if (EFI_ERROR (Status
)) {
525 Status
= Private
->UgaDraw
->GetMode (
527 &HorizontalResolution
,
532 if (EFI_ERROR (Status
)) {
537 Status
= EFI_UNSUPPORTED
;
543 // Initialize the mode which GraphicsConsole supports.
545 Status
= InitializeGraphicsConsoleTextMode (
546 HorizontalResolution
,
553 if (EFI_ERROR (Status
)) {
558 // Update the maximum number of modes
560 Private
->SimpleTextOutputMode
.MaxMode
= (INT32
) MaxMode
;
563 Status
= GraphicsConsoleConOutSetMode (&Private
->SimpleTextOutput
, 0);
564 if (EFI_ERROR (Status
)) {
567 Status
= GraphicsConsoleConOutOutputString (&Private
->SimpleTextOutput
, (CHAR16
*)L
"Graphics Console Started\n\r");
568 if (EFI_ERROR (Status
)) {
574 // Install protocol interfaces for the Graphics Console device.
576 Status
= gBS
->InstallMultipleProtocolInterfaces (
578 &gEfiSimpleTextOutProtocolGuid
,
579 &Private
->SimpleTextOutput
,
584 if (EFI_ERROR (Status
)) {
586 // Close the GOP and UGA Draw Protocol
588 if (Private
->GraphicsOutput
!= NULL
) {
591 &gEfiGraphicsOutputProtocolGuid
,
592 This
->DriverBindingHandle
,
595 } else if (FeaturePcdGet (PcdUgaConsumeSupport
)) {
598 &gEfiUgaDrawProtocolGuid
,
599 This
->DriverBindingHandle
,
604 if (Private
->LineBuffer
!= NULL
) {
605 FreePool (Private
->LineBuffer
);
608 if (Private
->ModeData
!= NULL
) {
609 FreePool (Private
->ModeData
);
622 Stop this driver on Controller by removing Simple Text Out protocol
623 and closing the Graphics Output Protocol or UGA Draw protocol on Controller.
624 (UGA Draw protocol could be skipped if PcdUgaConsumeSupport is set to FALSE.)
627 @param This Protocol instance pointer.
628 @param Controller Handle of device to stop driver on
629 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
630 children is zero stop the entire bus driver.
631 @param ChildHandleBuffer List of Child Handles to Stop.
633 @retval EFI_SUCCESS This driver is removed Controller.
634 @retval EFI_NOT_STARTED Simple Text Out protocol could not be found the
636 @retval other This driver was not removed from this device.
641 GraphicsConsoleControllerDriverStop (
642 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
643 IN EFI_HANDLE Controller
,
644 IN UINTN NumberOfChildren
,
645 IN EFI_HANDLE
*ChildHandleBuffer
649 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*SimpleTextOutput
;
650 GRAPHICS_CONSOLE_DEV
*Private
;
652 Status
= gBS
->OpenProtocol (
654 &gEfiSimpleTextOutProtocolGuid
,
655 (VOID
**) &SimpleTextOutput
,
656 This
->DriverBindingHandle
,
658 EFI_OPEN_PROTOCOL_GET_PROTOCOL
660 if (EFI_ERROR (Status
)) {
661 return EFI_NOT_STARTED
;
664 Private
= GRAPHICS_CONSOLE_CON_OUT_DEV_FROM_THIS (SimpleTextOutput
);
666 Status
= gBS
->UninstallProtocolInterface (
668 &gEfiSimpleTextOutProtocolGuid
,
669 &Private
->SimpleTextOutput
672 if (!EFI_ERROR (Status
)) {
674 // Close the GOP or UGA IO Protocol
676 if (Private
->GraphicsOutput
!= NULL
) {
679 &gEfiGraphicsOutputProtocolGuid
,
680 This
->DriverBindingHandle
,
683 } else if (FeaturePcdGet (PcdUgaConsumeSupport
)) {
686 &gEfiUgaDrawProtocolGuid
,
687 This
->DriverBindingHandle
,
692 if (Private
->LineBuffer
!= NULL
) {
693 FreePool (Private
->LineBuffer
);
696 if (Private
->ModeData
!= NULL
) {
697 FreePool (Private
->ModeData
);
701 // Free our instance data
710 Check if the current specific mode supported the user defined resolution
711 for the Graphics Console device based on Graphics Output Protocol.
713 If yes, set the graphic devcice's current mode to this specific mode.
715 @param GraphicsOutput Graphics Output Protocol instance pointer.
716 @param HorizontalResolution User defined horizontal resolution
717 @param VerticalResolution User defined vertical resolution.
718 @param CurrentModeNumber Current specific mode to be check.
720 @retval EFI_SUCCESS The mode is supported.
721 @retval EFI_UNSUPPORTED The specific mode is out of range of graphics
723 @retval other The specific mode does not support user defined
724 resolution or failed to set the current mode to the
725 specific mode on graphics device.
730 EFI_GRAPHICS_OUTPUT_PROTOCOL
*GraphicsOutput
,
731 IN UINT32 HorizontalResolution
,
732 IN UINT32 VerticalResolution
,
733 OUT UINT32
*CurrentModeNumber
739 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
*Info
;
742 Status
= EFI_SUCCESS
;
743 MaxMode
= GraphicsOutput
->Mode
->MaxMode
;
745 for (ModeNumber
= 0; ModeNumber
< MaxMode
; ModeNumber
++) {
746 Status
= GraphicsOutput
->QueryMode (
752 if (!EFI_ERROR (Status
)) {
753 if ((Info
->HorizontalResolution
== HorizontalResolution
) &&
754 (Info
->VerticalResolution
== VerticalResolution
)) {
755 if ((GraphicsOutput
->Mode
->Info
->HorizontalResolution
== HorizontalResolution
) &&
756 (GraphicsOutput
->Mode
->Info
->VerticalResolution
== VerticalResolution
)) {
758 // If video device has been set to this mode, we do not need to SetMode again
763 Status
= GraphicsOutput
->SetMode (GraphicsOutput
, ModeNumber
);
764 if (!EFI_ERROR (Status
)) {
774 if (ModeNumber
== GraphicsOutput
->Mode
->MaxMode
) {
775 Status
= EFI_UNSUPPORTED
;
778 *CurrentModeNumber
= ModeNumber
;
784 Locate HII Database protocol and HII Font protocol.
786 @retval EFI_SUCCESS HII Database protocol and HII Font protocol
787 are located successfully.
788 @return other Failed to locate HII Database protocol or
793 EfiLocateHiiProtocol (
802 // There should only be one - so buffer size is this
804 Size
= sizeof (EFI_HANDLE
);
806 Status
= gBS
->LocateHandle (
808 &gEfiHiiDatabaseProtocolGuid
,
814 if (EFI_ERROR (Status
)) {
818 Status
= gBS
->HandleProtocol (
820 &gEfiHiiDatabaseProtocolGuid
,
821 (VOID
**) &mHiiDatabase
824 if (EFI_ERROR (Status
)) {
828 Status
= gBS
->HandleProtocol (
830 &gEfiHiiFontProtocolGuid
,
837 // Body of the STO functions
841 Reset the text output device hardware and optionally run diagnostics.
843 Implements SIMPLE_TEXT_OUTPUT.Reset().
844 If ExtendeVerification is TRUE, then perform dependent Graphics Console
845 device reset, and set display mode to mode 0.
846 If ExtendedVerification is FALSE, only set display mode to mode 0.
848 @param This Protocol instance pointer.
849 @param ExtendedVerification Indicates that the driver may perform a more
850 exhaustive verification operation of the device
853 @retval EFI_SUCCESS The text output device was reset.
854 @retval EFI_DEVICE_ERROR The text output device is not functioning correctly and
860 GraphicsConsoleConOutReset (
861 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
862 IN BOOLEAN ExtendedVerification
866 Status
= This
->SetMode (This
, 0);
867 if (EFI_ERROR (Status
)) {
870 Status
= This
->SetAttribute (This
, EFI_TEXT_ATTR (This
->Mode
->Attribute
& 0x0F, EFI_BACKGROUND_BLACK
));
876 Write a Unicode string to the output device.
878 Implements SIMPLE_TEXT_OUTPUT.OutputString().
879 The Unicode string will be converted to Glyphs and will be
880 sent to the Graphics Console.
882 @param This Protocol instance pointer.
883 @param WString The NULL-terminated Unicode string to be displayed
884 on the output device(s). All output devices must
885 also support the Unicode drawing defined in this file.
887 @retval EFI_SUCCESS The string was output to the device.
888 @retval EFI_DEVICE_ERROR The device reported an error while attempting to output
890 @retval EFI_UNSUPPORTED The output device's mode is not currently in a
892 @retval EFI_WARN_UNKNOWN_GLYPH This warning code indicates that some of the
893 characters in the Unicode string could not be
894 rendered and were skipped.
899 GraphicsConsoleConOutOutputString (
900 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
904 GRAPHICS_CONSOLE_DEV
*Private
;
905 EFI_GRAPHICS_OUTPUT_PROTOCOL
*GraphicsOutput
;
906 EFI_UGA_DRAW_PROTOCOL
*UgaDraw
;
915 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground
;
916 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background
;
921 INT32 OriginAttribute
;
924 if (This
->Mode
->Mode
== -1) {
926 // If current mode is not valid, return error.
928 return EFI_UNSUPPORTED
;
931 Status
= EFI_SUCCESS
;
933 OldTpl
= gBS
->RaiseTPL (TPL_NOTIFY
);
937 Mode
= This
->Mode
->Mode
;
938 Private
= GRAPHICS_CONSOLE_CON_OUT_DEV_FROM_THIS (This
);
939 GraphicsOutput
= Private
->GraphicsOutput
;
940 UgaDraw
= Private
->UgaDraw
;
942 MaxColumn
= Private
->ModeData
[Mode
].Columns
;
943 MaxRow
= Private
->ModeData
[Mode
].Rows
;
944 DeltaX
= (UINTN
) Private
->ModeData
[Mode
].DeltaX
;
945 DeltaY
= (UINTN
) Private
->ModeData
[Mode
].DeltaY
;
946 Width
= MaxColumn
* EFI_GLYPH_WIDTH
;
947 Height
= (MaxRow
- 1) * EFI_GLYPH_HEIGHT
;
948 Delta
= Width
* sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
);
951 // The Attributes won't change when during the time OutputString is called
953 GetTextColors (This
, &Foreground
, &Background
);
962 OriginAttribute
= This
->Mode
->Attribute
;
964 while (*WString
!= L
'\0') {
966 if (*WString
== CHAR_BACKSPACE
) {
968 // If the cursor is at the left edge of the display, then move the cursor
971 if (This
->Mode
->CursorColumn
== 0 && This
->Mode
->CursorRow
> 0) {
972 This
->Mode
->CursorRow
--;
973 This
->Mode
->CursorColumn
= (INT32
) (MaxColumn
- 1);
974 This
->OutputString (This
, SpaceStr
);
976 This
->Mode
->CursorRow
--;
977 This
->Mode
->CursorColumn
= (INT32
) (MaxColumn
- 1);
978 } else if (This
->Mode
->CursorColumn
> 0) {
980 // If the cursor is not at the left edge of the display, then move the cursor
983 This
->Mode
->CursorColumn
--;
984 This
->OutputString (This
, SpaceStr
);
986 This
->Mode
->CursorColumn
--;
991 } else if (*WString
== CHAR_LINEFEED
) {
993 // If the cursor is at the bottom of the display, then scroll the display one
994 // row, and do not update the cursor position. Otherwise, move the cursor
997 if (This
->Mode
->CursorRow
== (INT32
) (MaxRow
- 1)) {
998 if (GraphicsOutput
!= NULL
) {
1000 // Scroll Screen Up One Row
1002 GraphicsOutput
->Blt (
1007 DeltaY
+ EFI_GLYPH_HEIGHT
,
1016 // Print Blank Line at last line
1018 GraphicsOutput
->Blt (
1030 } else if (FeaturePcdGet (PcdUgaConsumeSupport
)) {
1032 // Scroll Screen Up One Row
1039 DeltaY
+ EFI_GLYPH_HEIGHT
,
1048 // Print Blank Line at last line
1052 (EFI_UGA_PIXEL
*) (UINTN
) &Background
,
1064 This
->Mode
->CursorRow
++;
1069 } else if (*WString
== CHAR_CARRIAGE_RETURN
) {
1071 // Move the cursor to the beginning of the current row.
1073 This
->Mode
->CursorColumn
= 0;
1076 } else if (*WString
== WIDE_CHAR
) {
1078 This
->Mode
->Attribute
|= EFI_WIDE_ATTRIBUTE
;
1081 } else if (*WString
== NARROW_CHAR
) {
1083 This
->Mode
->Attribute
&= (~ (UINT32
) EFI_WIDE_ATTRIBUTE
);
1088 // Print the character at the current cursor position and move the cursor
1089 // right one column. If this moves the cursor past the right edge of the
1090 // display, then the line should wrap to the beginning of the next line. This
1091 // is equivalent to inserting a CR and an LF. Note that if the cursor is at the
1092 // bottom of the display, and the line wraps, then the display will be scrolled
1094 // If wide char is going to be displayed, need to display one character at a time
1095 // Or, need to know the display length of a certain string.
1097 // Index is used to determine how many character width units (wide = 2, narrow = 1)
1098 // Count is used to determine how many characters are used regardless of their attributes
1100 for (Count
= 0, Index
= 0; (This
->Mode
->CursorColumn
+ Index
) < MaxColumn
; Count
++, Index
++) {
1101 if (WString
[Count
] == CHAR_NULL
||
1102 WString
[Count
] == CHAR_BACKSPACE
||
1103 WString
[Count
] == CHAR_LINEFEED
||
1104 WString
[Count
] == CHAR_CARRIAGE_RETURN
||
1105 WString
[Count
] == WIDE_CHAR
||
1106 WString
[Count
] == NARROW_CHAR
) {
1110 // Is the wide attribute on?
1112 if ((This
->Mode
->Attribute
& EFI_WIDE_ATTRIBUTE
) != 0) {
1114 // If wide, add one more width unit than normal since we are going to increment at the end of the for loop
1118 // This is the end-case where if we are at column 79 and about to print a wide character
1119 // We should prevent this from happening because we will wrap inappropriately. We should
1120 // not print this character until the next line.
1122 if ((This
->Mode
->CursorColumn
+ Index
+ 1) > MaxColumn
) {
1129 Status
= DrawUnicodeWeightAtCursorN (This
, WString
, Count
);
1130 if (EFI_ERROR (Status
)) {
1134 // At the end of line, output carriage return and line feed
1137 This
->Mode
->CursorColumn
+= (INT32
) Index
;
1138 if (This
->Mode
->CursorColumn
> (INT32
) MaxColumn
) {
1139 This
->Mode
->CursorColumn
-= 2;
1140 This
->OutputString (This
, SpaceStr
);
1143 if (This
->Mode
->CursorColumn
>= (INT32
) MaxColumn
) {
1145 This
->OutputString (This
, mCrLfString
);
1151 This
->Mode
->Attribute
= OriginAttribute
;
1156 Status
= EFI_WARN_UNKNOWN_GLYPH
;
1159 gBS
->RestoreTPL (OldTpl
);
1165 Verifies that all characters in a Unicode string can be output to the
1168 Implements SIMPLE_TEXT_OUTPUT.TestString().
1169 If one of the characters in the *Wstring is neither valid valid Unicode
1170 drawing characters, not ASCII code, then this function will return
1173 @param This Protocol instance pointer.
1174 @param WString The NULL-terminated Unicode string to be examined for the output
1177 @retval EFI_SUCCESS The device(s) are capable of rendering the output string.
1178 @retval EFI_UNSUPPORTED Some of the characters in the Unicode string cannot be
1179 rendered by one or more of the output devices mapped
1185 GraphicsConsoleConOutTestString (
1186 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
1193 EFI_IMAGE_OUTPUT
*Blt
;
1198 while (WString
[Count
] != 0) {
1199 Status
= mHiiFont
->GetGlyph (
1212 if (EFI_ERROR (Status
)) {
1213 return EFI_UNSUPPORTED
;
1222 Returns information for an available text mode that the output device(s)
1225 Implements SIMPLE_TEXT_OUTPUT.QueryMode().
1226 It returnes information for an available text mode that the Graphics Console supports.
1227 In this driver,we only support text mode 80x25, which is defined as mode 0.
1229 @param This Protocol instance pointer.
1230 @param ModeNumber The mode number to return information on.
1231 @param Columns The returned columns of the requested mode.
1232 @param Rows The returned rows of the requested mode.
1234 @retval EFI_SUCCESS The requested mode information is returned.
1235 @retval EFI_UNSUPPORTED The mode number is not valid.
1240 GraphicsConsoleConOutQueryMode (
1241 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
1242 IN UINTN ModeNumber
,
1247 GRAPHICS_CONSOLE_DEV
*Private
;
1251 if (ModeNumber
>= (UINTN
) This
->Mode
->MaxMode
) {
1252 return EFI_UNSUPPORTED
;
1255 OldTpl
= gBS
->RaiseTPL (TPL_NOTIFY
);
1256 Status
= EFI_SUCCESS
;
1258 Private
= GRAPHICS_CONSOLE_CON_OUT_DEV_FROM_THIS (This
);
1260 *Columns
= Private
->ModeData
[ModeNumber
].Columns
;
1261 *Rows
= Private
->ModeData
[ModeNumber
].Rows
;
1263 if (*Columns
<= 0 || *Rows
<= 0) {
1264 Status
= EFI_UNSUPPORTED
;
1270 gBS
->RestoreTPL (OldTpl
);
1276 Sets the output device(s) to a specified mode.
1278 Implements SIMPLE_TEXT_OUTPUT.SetMode().
1279 Set the Graphics Console to a specified mode. In this driver, we only support mode 0.
1281 @param This Protocol instance pointer.
1282 @param ModeNumber The text mode to set.
1284 @retval EFI_SUCCESS The requested text mode is set.
1285 @retval EFI_DEVICE_ERROR The requested text mode cannot be set because of
1286 Graphics Console device error.
1287 @retval EFI_UNSUPPORTED The text mode number is not valid.
1292 GraphicsConsoleConOutSetMode (
1293 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
1298 GRAPHICS_CONSOLE_DEV
*Private
;
1299 GRAPHICS_CONSOLE_MODE_DATA
*ModeData
;
1300 EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*NewLineBuffer
;
1301 UINT32 HorizontalResolution
;
1302 UINT32 VerticalResolution
;
1303 EFI_GRAPHICS_OUTPUT_PROTOCOL
*GraphicsOutput
;
1304 EFI_UGA_DRAW_PROTOCOL
*UgaDraw
;
1309 OldTpl
= gBS
->RaiseTPL (TPL_NOTIFY
);
1311 Private
= GRAPHICS_CONSOLE_CON_OUT_DEV_FROM_THIS (This
);
1312 GraphicsOutput
= Private
->GraphicsOutput
;
1313 UgaDraw
= Private
->UgaDraw
;
1316 // Make sure the requested mode number is supported
1318 if (ModeNumber
>= (UINTN
) This
->Mode
->MaxMode
) {
1319 Status
= EFI_UNSUPPORTED
;
1323 ModeData
= &(Private
->ModeData
[ModeNumber
]);
1325 if (ModeData
->Columns
<= 0 && ModeData
->Rows
<= 0) {
1326 Status
= EFI_UNSUPPORTED
;
1331 // If the mode has been set at least one other time, then LineBuffer will not be NULL
1333 if (Private
->LineBuffer
!= NULL
) {
1335 // If the new mode is the same as the old mode, then just return EFI_SUCCESS
1337 if ((INT32
) ModeNumber
== This
->Mode
->Mode
) {
1339 // Clear the current text window on the current graphics console
1341 This
->ClearScreen (This
);
1342 Status
= EFI_SUCCESS
;
1346 // Otherwise, the size of the text console and/or the GOP/UGA mode will be changed,
1347 // so erase the cursor, and free the LineBuffer for the current mode
1351 FreePool (Private
->LineBuffer
);
1355 // Attempt to allocate a line buffer for the requested mode number
1357 NewLineBuffer
= AllocatePool (sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
) * ModeData
->Columns
* EFI_GLYPH_WIDTH
* EFI_GLYPH_HEIGHT
);
1359 if (NewLineBuffer
== NULL
) {
1361 // The new line buffer could not be allocated, so return an error.
1362 // No changes to the state of the current console have been made, so the current console is still valid
1364 Status
= EFI_OUT_OF_RESOURCES
;
1369 // Assign the current line buffer to the newly allocated line buffer
1371 Private
->LineBuffer
= NewLineBuffer
;
1373 if (GraphicsOutput
!= NULL
) {
1374 if (ModeData
->GopModeNumber
!= GraphicsOutput
->Mode
->Mode
) {
1376 // Either no graphics mode is currently set, or it is set to the wrong resolution, so set the new graphics mode
1378 Status
= GraphicsOutput
->SetMode (GraphicsOutput
, ModeData
->GopModeNumber
);
1379 if (EFI_ERROR (Status
)) {
1381 // The mode set operation failed
1387 // The current graphics mode is correct, so simply clear the entire display
1389 Status
= GraphicsOutput
->Blt (
1391 &mGraphicsEfiColors
[0],
1398 ModeData
->GopHeight
,
1402 } else if (FeaturePcdGet (PcdUgaConsumeSupport
)) {
1404 // Get the current UGA Draw mode information
1406 Status
= UgaDraw
->GetMode (
1408 &HorizontalResolution
,
1409 &VerticalResolution
,
1413 if (EFI_ERROR (Status
) || HorizontalResolution
!= ModeData
->GopWidth
|| VerticalResolution
!= ModeData
->GopHeight
) {
1415 // Either no graphics mode is currently set, or it is set to the wrong resolution, so set the new graphics mode
1417 Status
= UgaDraw
->SetMode (
1420 ModeData
->GopHeight
,
1424 if (EFI_ERROR (Status
)) {
1426 // The mode set operation failed
1432 // The current graphics mode is correct, so simply clear the entire display
1434 Status
= UgaDraw
->Blt (
1436 (EFI_UGA_PIXEL
*) (UINTN
) &mGraphicsEfiColors
[0],
1443 ModeData
->GopHeight
,
1450 // The new mode is valid, so commit the mode change
1452 This
->Mode
->Mode
= (INT32
) ModeNumber
;
1455 // Move the text cursor to the upper left hand corner of the display and flush it
1457 This
->Mode
->CursorColumn
= 0;
1458 This
->Mode
->CursorRow
= 0;
1462 Status
= EFI_SUCCESS
;
1465 gBS
->RestoreTPL (OldTpl
);
1471 Sets the background and foreground colors for the OutputString () and
1472 ClearScreen () functions.
1474 Implements SIMPLE_TEXT_OUTPUT.SetAttribute().
1476 @param This Protocol instance pointer.
1477 @param Attribute The attribute to set. Bits 0..3 are the foreground
1478 color, and bits 4..6 are the background color.
1479 All other bits are undefined and must be zero.
1481 @retval EFI_SUCCESS The requested attribute is set.
1482 @retval EFI_DEVICE_ERROR The requested attribute cannot be set due to Graphics Console port error.
1483 @retval EFI_UNSUPPORTED The attribute requested is not defined.
1488 GraphicsConsoleConOutSetAttribute (
1489 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
1495 if ((Attribute
| 0xFF) != 0xFF) {
1496 return EFI_UNSUPPORTED
;
1499 if (This
->Mode
->Mode
== -1) {
1501 // If current mode is not valid, return error.
1503 return EFI_UNSUPPORTED
;
1506 if ((INT32
) Attribute
== This
->Mode
->Attribute
) {
1510 OldTpl
= gBS
->RaiseTPL (TPL_NOTIFY
);
1514 This
->Mode
->Attribute
= (INT32
) Attribute
;
1518 gBS
->RestoreTPL (OldTpl
);
1525 Clears the output device(s) display to the currently selected background
1528 Implements SIMPLE_TEXT_OUTPUT.ClearScreen().
1530 @param This Protocol instance pointer.
1532 @retval EFI_SUCCESS The operation completed successfully.
1533 @retval EFI_DEVICE_ERROR The device had an error and could not complete the request.
1534 @retval EFI_UNSUPPORTED The output device is not in a valid text mode.
1539 GraphicsConsoleConOutClearScreen (
1540 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
1544 GRAPHICS_CONSOLE_DEV
*Private
;
1545 GRAPHICS_CONSOLE_MODE_DATA
*ModeData
;
1546 EFI_GRAPHICS_OUTPUT_PROTOCOL
*GraphicsOutput
;
1547 EFI_UGA_DRAW_PROTOCOL
*UgaDraw
;
1548 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground
;
1549 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background
;
1552 if (This
->Mode
->Mode
== -1) {
1554 // If current mode is not valid, return error.
1556 return EFI_UNSUPPORTED
;
1559 OldTpl
= gBS
->RaiseTPL (TPL_NOTIFY
);
1561 Private
= GRAPHICS_CONSOLE_CON_OUT_DEV_FROM_THIS (This
);
1562 GraphicsOutput
= Private
->GraphicsOutput
;
1563 UgaDraw
= Private
->UgaDraw
;
1564 ModeData
= &(Private
->ModeData
[This
->Mode
->Mode
]);
1566 GetTextColors (This
, &Foreground
, &Background
);
1567 if (GraphicsOutput
!= NULL
) {
1568 Status
= GraphicsOutput
->Blt (
1577 ModeData
->GopHeight
,
1580 } else if (FeaturePcdGet (PcdUgaConsumeSupport
)) {
1581 Status
= UgaDraw
->Blt (
1583 (EFI_UGA_PIXEL
*) (UINTN
) &Background
,
1590 ModeData
->GopHeight
,
1594 Status
= EFI_UNSUPPORTED
;
1597 This
->Mode
->CursorColumn
= 0;
1598 This
->Mode
->CursorRow
= 0;
1602 gBS
->RestoreTPL (OldTpl
);
1609 Sets the current coordinates of the cursor position.
1611 Implements SIMPLE_TEXT_OUTPUT.SetCursorPosition().
1613 @param This Protocol instance pointer.
1614 @param Column The position to set the cursor to. Must be greater than or
1615 equal to zero and less than the number of columns and rows
1617 @param Row The position to set the cursor to. Must be greater than or
1618 equal to zero and less than the number of columns and rows
1621 @retval EFI_SUCCESS The operation completed successfully.
1622 @retval EFI_DEVICE_ERROR The device had an error and could not complete the request.
1623 @retval EFI_UNSUPPORTED The output device is not in a valid text mode, or the
1624 cursor position is invalid for the current mode.
1629 GraphicsConsoleConOutSetCursorPosition (
1630 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
1635 GRAPHICS_CONSOLE_DEV
*Private
;
1636 GRAPHICS_CONSOLE_MODE_DATA
*ModeData
;
1640 if (This
->Mode
->Mode
== -1) {
1642 // If current mode is not valid, return error.
1644 return EFI_UNSUPPORTED
;
1647 Status
= EFI_SUCCESS
;
1649 OldTpl
= gBS
->RaiseTPL (TPL_NOTIFY
);
1651 Private
= GRAPHICS_CONSOLE_CON_OUT_DEV_FROM_THIS (This
);
1652 ModeData
= &(Private
->ModeData
[This
->Mode
->Mode
]);
1654 if ((Column
>= ModeData
->Columns
) || (Row
>= ModeData
->Rows
)) {
1655 Status
= EFI_UNSUPPORTED
;
1659 if ((This
->Mode
->CursorColumn
== (INT32
) Column
) && (This
->Mode
->CursorRow
== (INT32
) Row
)) {
1660 Status
= EFI_SUCCESS
;
1666 This
->Mode
->CursorColumn
= (INT32
) Column
;
1667 This
->Mode
->CursorRow
= (INT32
) Row
;
1672 gBS
->RestoreTPL (OldTpl
);
1679 Makes the cursor visible or invisible.
1681 Implements SIMPLE_TEXT_OUTPUT.EnableCursor().
1683 @param This Protocol instance pointer.
1684 @param Visible If TRUE, the cursor is set to be visible, If FALSE,
1685 the cursor is set to be invisible.
1687 @retval EFI_SUCCESS The operation completed successfully.
1688 @retval EFI_UNSUPPORTED The output device's mode is not currently in a
1694 GraphicsConsoleConOutEnableCursor (
1695 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
1701 if (This
->Mode
->Mode
== -1) {
1703 // If current mode is not valid, return error.
1705 return EFI_UNSUPPORTED
;
1708 OldTpl
= gBS
->RaiseTPL (TPL_NOTIFY
);
1712 This
->Mode
->CursorVisible
= Visible
;
1716 gBS
->RestoreTPL (OldTpl
);
1721 Gets Graphics Console devcie's foreground color and background color.
1723 @param This Protocol instance pointer.
1724 @param Foreground Returned text foreground color.
1725 @param Background Returned text background color.
1727 @retval EFI_SUCCESS It returned always.
1732 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
1733 OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*Foreground
,
1734 OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*Background
1739 Attribute
= This
->Mode
->Attribute
& 0x7F;
1741 *Foreground
= mGraphicsEfiColors
[Attribute
& 0x0f];
1742 *Background
= mGraphicsEfiColors
[Attribute
>> 4];
1748 Draw Unicode string on the Graphics Console device's screen.
1750 @param This Protocol instance pointer.
1751 @param UnicodeWeight One Unicode string to be displayed.
1752 @param Count The count of Unicode string.
1754 @retval EFI_OUT_OF_RESOURCES If no memory resource to use.
1755 @retval EFI_UNSUPPORTED If no Graphics Output protocol and UGA Draw
1757 @retval EFI_SUCCESS Drawing Unicode string implemented successfully.
1761 DrawUnicodeWeightAtCursorN (
1762 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
1763 IN CHAR16
*UnicodeWeight
,
1768 GRAPHICS_CONSOLE_DEV
*Private
;
1769 EFI_IMAGE_OUTPUT
*Blt
;
1771 EFI_FONT_DISPLAY_INFO
*FontInfo
;
1772 EFI_UGA_DRAW_PROTOCOL
*UgaDraw
;
1773 EFI_HII_ROW_INFO
*RowInfoArray
;
1774 UINTN RowInfoArraySize
;
1776 Private
= GRAPHICS_CONSOLE_CON_OUT_DEV_FROM_THIS (This
);
1777 Blt
= (EFI_IMAGE_OUTPUT
*) AllocateZeroPool (sizeof (EFI_IMAGE_OUTPUT
));
1779 return EFI_OUT_OF_RESOURCES
;
1782 Blt
->Width
= (UINT16
) (Private
->ModeData
[This
->Mode
->Mode
].GopWidth
);
1783 Blt
->Height
= (UINT16
) (Private
->ModeData
[This
->Mode
->Mode
].GopHeight
);
1785 String
= AllocateCopyPool ((Count
+ 1) * sizeof (CHAR16
), UnicodeWeight
);
1786 if (String
== NULL
) {
1788 return EFI_OUT_OF_RESOURCES
;
1791 // Set the end character
1793 *(String
+ Count
) = L
'\0';
1795 FontInfo
= (EFI_FONT_DISPLAY_INFO
*) AllocateZeroPool (sizeof (EFI_FONT_DISPLAY_INFO
));
1796 if (FontInfo
== NULL
) {
1799 return EFI_OUT_OF_RESOURCES
;
1802 // Get current foreground and background colors.
1804 GetTextColors (This
, &FontInfo
->ForegroundColor
, &FontInfo
->BackgroundColor
);
1806 if (Private
->GraphicsOutput
!= NULL
) {
1808 // If Graphics Output protocol exists, using HII Font protocol to draw.
1810 Blt
->Image
.Screen
= Private
->GraphicsOutput
;
1812 Status
= mHiiFont
->StringToImage (
1814 EFI_HII_IGNORE_IF_NO_GLYPH
| EFI_HII_DIRECT_TO_SCREEN
| EFI_HII_IGNORE_LINE_BREAK
,
1818 This
->Mode
->CursorColumn
* EFI_GLYPH_WIDTH
+ Private
->ModeData
[This
->Mode
->Mode
].DeltaX
,
1819 This
->Mode
->CursorRow
* EFI_GLYPH_HEIGHT
+ Private
->ModeData
[This
->Mode
->Mode
].DeltaY
,
1825 } else if (FeaturePcdGet (PcdUgaConsumeSupport
)) {
1827 // If Graphics Output protocol cannot be found and PcdUgaConsumeSupport enabled,
1828 // using UGA Draw protocol to draw.
1830 ASSERT (Private
->UgaDraw
!= NULL
);
1832 UgaDraw
= Private
->UgaDraw
;
1834 Blt
->Image
.Bitmap
= AllocateZeroPool (Blt
->Width
* Blt
->Height
* sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
));
1835 if (Blt
->Image
.Bitmap
== NULL
) {
1838 return EFI_OUT_OF_RESOURCES
;
1841 RowInfoArray
= NULL
;
1843 // StringToImage only support blt'ing image to device using GOP protocol. If GOP is not supported in this platform,
1844 // we ask StringToImage to print the string to blt buffer, then blt to device using UgaDraw.
1846 Status
= mHiiFont
->StringToImage (
1848 EFI_HII_IGNORE_IF_NO_GLYPH
| EFI_HII_IGNORE_LINE_BREAK
,
1852 This
->Mode
->CursorColumn
* EFI_GLYPH_WIDTH
+ Private
->ModeData
[This
->Mode
->Mode
].DeltaX
,
1853 This
->Mode
->CursorRow
* EFI_GLYPH_HEIGHT
+ Private
->ModeData
[This
->Mode
->Mode
].DeltaY
,
1859 if (!EFI_ERROR (Status
)) {
1861 // Line breaks are handled by caller of DrawUnicodeWeightAtCursorN, so the updated parameter RowInfoArraySize by StringToImage will
1862 // always be 1 or 0 (if there is no valid Unicode Char can be printed). ASSERT here to make sure.
1864 ASSERT (RowInfoArraySize
<= 1);
1866 Status
= UgaDraw
->Blt (
1868 (EFI_UGA_PIXEL
*) Blt
->Image
.Bitmap
,
1869 EfiUgaBltBufferToVideo
,
1870 This
->Mode
->CursorColumn
* EFI_GLYPH_WIDTH
+ Private
->ModeData
[This
->Mode
->Mode
].DeltaX
,
1871 (This
->Mode
->CursorRow
) * EFI_GLYPH_HEIGHT
+ Private
->ModeData
[This
->Mode
->Mode
].DeltaY
,
1872 This
->Mode
->CursorColumn
* EFI_GLYPH_WIDTH
+ Private
->ModeData
[This
->Mode
->Mode
].DeltaX
,
1873 (This
->Mode
->CursorRow
) * EFI_GLYPH_HEIGHT
+ Private
->ModeData
[This
->Mode
->Mode
].DeltaY
,
1874 RowInfoArray
[0].LineWidth
,
1875 RowInfoArray
[0].LineHeight
,
1876 Blt
->Width
* sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
)
1880 FreePool (RowInfoArray
);
1881 FreePool (Blt
->Image
.Bitmap
);
1883 Status
= EFI_UNSUPPORTED
;
1889 if (String
!= NULL
) {
1892 if (FontInfo
!= NULL
) {
1893 FreePool (FontInfo
);
1899 Flush the cursor on the screen.
1901 If CursorVisible is FALSE, nothing to do and return directly.
1902 If CursorVisible is TRUE,
1903 i) If the cursor shows on screen, it will be erased.
1904 ii) If the cursor does not show on screen, it will be shown.
1906 @param This Protocol instance pointer.
1908 @retval EFI_SUCCESS The cursor is erased successfully.
1913 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
1916 GRAPHICS_CONSOLE_DEV
*Private
;
1917 EFI_SIMPLE_TEXT_OUTPUT_MODE
*CurrentMode
;
1920 EFI_GRAPHICS_OUTPUT_PROTOCOL
*GraphicsOutput
;
1921 EFI_UGA_DRAW_PROTOCOL
*UgaDraw
;
1922 EFI_GRAPHICS_OUTPUT_BLT_PIXEL_UNION Foreground
;
1923 EFI_GRAPHICS_OUTPUT_BLT_PIXEL_UNION Background
;
1924 EFI_GRAPHICS_OUTPUT_BLT_PIXEL_UNION BltChar
[EFI_GLYPH_HEIGHT
][EFI_GLYPH_WIDTH
];
1928 CurrentMode
= This
->Mode
;
1930 if (!CurrentMode
->CursorVisible
) {
1934 Private
= GRAPHICS_CONSOLE_CON_OUT_DEV_FROM_THIS (This
);
1935 GraphicsOutput
= Private
->GraphicsOutput
;
1936 UgaDraw
= Private
->UgaDraw
;
1939 // In this driver, only narrow character was supported.
1942 // Blt a character to the screen
1944 GlyphX
= (CurrentMode
->CursorColumn
* EFI_GLYPH_WIDTH
) + Private
->ModeData
[CurrentMode
->Mode
].DeltaX
;
1945 GlyphY
= (CurrentMode
->CursorRow
* EFI_GLYPH_HEIGHT
) + Private
->ModeData
[CurrentMode
->Mode
].DeltaY
;
1946 if (GraphicsOutput
!= NULL
) {
1947 GraphicsOutput
->Blt (
1949 (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*) BltChar
,
1950 EfiBltVideoToBltBuffer
,
1957 EFI_GLYPH_WIDTH
* sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
)
1959 } else if (FeaturePcdGet (PcdUgaConsumeSupport
)) {
1962 (EFI_UGA_PIXEL
*) (UINTN
) BltChar
,
1963 EfiUgaVideoToBltBuffer
,
1970 EFI_GLYPH_WIDTH
* sizeof (EFI_UGA_PIXEL
)
1974 GetTextColors (This
, &Foreground
.Pixel
, &Background
.Pixel
);
1977 // Convert Monochrome bitmap of the Glyph to BltBuffer structure
1979 for (PosY
= 0; PosY
< EFI_GLYPH_HEIGHT
; PosY
++) {
1980 for (PosX
= 0; PosX
< EFI_GLYPH_WIDTH
; PosX
++) {
1981 if ((mCursorGlyph
.GlyphCol1
[PosY
] & (BIT0
<< PosX
)) != 0) {
1982 BltChar
[PosY
][EFI_GLYPH_WIDTH
- PosX
- 1].Raw
^= Foreground
.Raw
;
1987 if (GraphicsOutput
!= NULL
) {
1988 GraphicsOutput
->Blt (
1990 (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*) BltChar
,
1991 EfiBltBufferToVideo
,
1998 EFI_GLYPH_WIDTH
* sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
)
2000 } else if (FeaturePcdGet (PcdUgaConsumeSupport
)) {
2003 (EFI_UGA_PIXEL
*) (UINTN
) BltChar
,
2004 EfiUgaBltBufferToVideo
,
2011 EFI_GLYPH_WIDTH
* sizeof (EFI_UGA_PIXEL
)
2019 HII Database Protocol notification event handler.
2021 Register font package when HII Database Protocol has been installed.
2023 @param[in] Event Event whose notification function is being invoked.
2024 @param[in] Context Pointer to the notification function's context.
2028 RegisterFontPackage (
2034 EFI_HII_SIMPLE_FONT_PACKAGE_HDR
*SimplifiedFont
;
2035 UINT32 PackageLength
;
2038 EFI_HII_DATABASE_PROTOCOL
*HiiDatabase
;
2041 // Locate HII Database Protocol
2043 Status
= gBS
->LocateProtocol (
2044 &gEfiHiiDatabaseProtocolGuid
,
2046 (VOID
**) &HiiDatabase
2048 ASSERT_EFI_ERROR (Status
);
2051 // Add 4 bytes to the header for entire length for HiiAddPackages use only.
2053 // +--------------------------------+ <-- Package
2055 // | PackageLength(4 bytes) |
2057 // |--------------------------------| <-- SimplifiedFont
2059 // |EFI_HII_SIMPLE_FONT_PACKAGE_HDR |
2061 // |--------------------------------| <-- Location
2063 // | gUsStdNarrowGlyphData |
2065 // +--------------------------------+
2067 PackageLength
= sizeof (EFI_HII_SIMPLE_FONT_PACKAGE_HDR
) + mNarrowFontSize
+ 4;
2068 Package
= AllocateZeroPool (PackageLength
);
2069 ASSERT (Package
!= NULL
);
2071 WriteUnaligned32((UINT32
*) Package
,PackageLength
);
2072 SimplifiedFont
= (EFI_HII_SIMPLE_FONT_PACKAGE_HDR
*) (Package
+ 4);
2073 SimplifiedFont
->Header
.Length
= (UINT32
) (PackageLength
- 4);
2074 SimplifiedFont
->Header
.Type
= EFI_HII_PACKAGE_SIMPLE_FONTS
;
2075 SimplifiedFont
->NumberOfNarrowGlyphs
= (UINT16
) (mNarrowFontSize
/ sizeof (EFI_NARROW_GLYPH
));
2077 Location
= (UINT8
*) (&SimplifiedFont
->NumberOfWideGlyphs
+ 1);
2078 CopyMem (Location
, gUsStdNarrowGlyphData
, mNarrowFontSize
);
2081 // Add this simplified font package to a package list then install it.
2083 mHiiHandle
= HiiAddPackages (
2084 &mFontPackageListGuid
,
2089 ASSERT (mHiiHandle
!= NULL
);
2094 The user Entry Point for module GraphicsConsole. The user code starts with this function.
2096 @param[in] ImageHandle The firmware allocated handle for the EFI image.
2097 @param[in] SystemTable A pointer to the EFI System Table.
2099 @retval EFI_SUCCESS The entry point is executed successfully.
2100 @return other Some error occurs when executing this entry point.
2105 InitializeGraphicsConsole (
2106 IN EFI_HANDLE ImageHandle
,
2107 IN EFI_SYSTEM_TABLE
*SystemTable
2113 // Register notify function on HII Database Protocol to add font package.
2115 EfiCreateProtocolNotifyEvent (
2116 &gEfiHiiDatabaseProtocolGuid
,
2118 RegisterFontPackage
,
2124 // Install driver model protocol(s).
2126 Status
= EfiLibInstallDriverBindingComponentName2 (
2129 &gGraphicsConsoleDriverBinding
,
2131 &gGraphicsConsoleComponentName
,
2132 &gGraphicsConsoleComponentName2
2134 ASSERT_EFI_ERROR (Status
);