2 This is the main routine for initializing the Graphics Console support routines.
4 Copyright (c) 2006 - 2011, 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 // Determine the number of text modes that this protocol can support
565 Status
= GraphicsConsoleConOutSetMode (&Private
->SimpleTextOutput
, 0);
566 if (EFI_ERROR (Status
)) {
571 GraphicsConsoleConOutOutputString (&Private
->SimpleTextOutput
, (CHAR16
*)L
"Graphics Console Started\n\r");
575 // Install protocol interfaces for the Graphics Console device.
577 Status
= gBS
->InstallMultipleProtocolInterfaces (
579 &gEfiSimpleTextOutProtocolGuid
,
580 &Private
->SimpleTextOutput
,
585 if (EFI_ERROR (Status
)) {
587 // Close the GOP and UGA Draw Protocol
589 if (Private
->GraphicsOutput
!= NULL
) {
592 &gEfiGraphicsOutputProtocolGuid
,
593 This
->DriverBindingHandle
,
596 } else if (FeaturePcdGet (PcdUgaConsumeSupport
)) {
599 &gEfiUgaDrawProtocolGuid
,
600 This
->DriverBindingHandle
,
605 if (Private
->LineBuffer
!= NULL
) {
606 FreePool (Private
->LineBuffer
);
609 if (Private
->ModeData
!= NULL
) {
610 FreePool (Private
->ModeData
);
623 Stop this driver on Controller by removing Simple Text Out protocol
624 and closing the Graphics Output Protocol or UGA Draw protocol on Controller.
625 (UGA Draw protocol could be skipped if PcdUgaConsumeSupport is set to FALSE.)
628 @param This Protocol instance pointer.
629 @param Controller Handle of device to stop driver on
630 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
631 children is zero stop the entire bus driver.
632 @param ChildHandleBuffer List of Child Handles to Stop.
634 @retval EFI_SUCCESS This driver is removed Controller.
635 @retval EFI_NOT_STARTED Simple Text Out protocol could not be found the
637 @retval other This driver was not removed from this device.
642 GraphicsConsoleControllerDriverStop (
643 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
644 IN EFI_HANDLE Controller
,
645 IN UINTN NumberOfChildren
,
646 IN EFI_HANDLE
*ChildHandleBuffer
650 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*SimpleTextOutput
;
651 GRAPHICS_CONSOLE_DEV
*Private
;
653 Status
= gBS
->OpenProtocol (
655 &gEfiSimpleTextOutProtocolGuid
,
656 (VOID
**) &SimpleTextOutput
,
657 This
->DriverBindingHandle
,
659 EFI_OPEN_PROTOCOL_GET_PROTOCOL
661 if (EFI_ERROR (Status
)) {
662 return EFI_NOT_STARTED
;
665 Private
= GRAPHICS_CONSOLE_CON_OUT_DEV_FROM_THIS (SimpleTextOutput
);
667 Status
= gBS
->UninstallProtocolInterface (
669 &gEfiSimpleTextOutProtocolGuid
,
670 &Private
->SimpleTextOutput
673 if (!EFI_ERROR (Status
)) {
675 // Close the GOP or UGA IO Protocol
677 if (Private
->GraphicsOutput
!= NULL
) {
680 &gEfiGraphicsOutputProtocolGuid
,
681 This
->DriverBindingHandle
,
684 } else if (FeaturePcdGet (PcdUgaConsumeSupport
)) {
687 &gEfiUgaDrawProtocolGuid
,
688 This
->DriverBindingHandle
,
693 if (Private
->LineBuffer
!= NULL
) {
694 FreePool (Private
->LineBuffer
);
697 if (Private
->ModeData
!= NULL
) {
698 FreePool (Private
->ModeData
);
702 // Free our instance data
711 Check if the current specific mode supported the user defined resolution
712 for the Graphics Console device based on Graphics Output Protocol.
714 If yes, set the graphic devcice's current mode to this specific mode.
716 @param GraphicsOutput Graphics Output Protocol instance pointer.
717 @param HorizontalResolution User defined horizontal resolution
718 @param VerticalResolution User defined vertical resolution.
719 @param CurrentModeNumber Current specific mode to be check.
721 @retval EFI_SUCCESS The mode is supported.
722 @retval EFI_UNSUPPORTED The specific mode is out of range of graphics
724 @retval other The specific mode does not support user defined
725 resolution or failed to set the current mode to the
726 specific mode on graphics device.
731 EFI_GRAPHICS_OUTPUT_PROTOCOL
*GraphicsOutput
,
732 IN UINT32 HorizontalResolution
,
733 IN UINT32 VerticalResolution
,
734 OUT UINT32
*CurrentModeNumber
740 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
*Info
;
743 Status
= EFI_SUCCESS
;
744 MaxMode
= GraphicsOutput
->Mode
->MaxMode
;
746 for (ModeNumber
= 0; ModeNumber
< MaxMode
; ModeNumber
++) {
747 Status
= GraphicsOutput
->QueryMode (
753 if (!EFI_ERROR (Status
)) {
754 if ((Info
->HorizontalResolution
== HorizontalResolution
) &&
755 (Info
->VerticalResolution
== VerticalResolution
)) {
756 if ((GraphicsOutput
->Mode
->Info
->HorizontalResolution
== HorizontalResolution
) &&
757 (GraphicsOutput
->Mode
->Info
->VerticalResolution
== VerticalResolution
)) {
759 // If video device has been set to this mode, we do not need to SetMode again
764 Status
= GraphicsOutput
->SetMode (GraphicsOutput
, ModeNumber
);
765 if (!EFI_ERROR (Status
)) {
775 if (ModeNumber
== GraphicsOutput
->Mode
->MaxMode
) {
776 Status
= EFI_UNSUPPORTED
;
779 *CurrentModeNumber
= ModeNumber
;
785 Locate HII Database protocol and HII Font protocol.
787 @retval EFI_SUCCESS HII Database protocol and HII Font protocol
788 are located successfully.
789 @return other Failed to locate HII Database protocol or
794 EfiLocateHiiProtocol (
803 // There should only be one - so buffer size is this
805 Size
= sizeof (EFI_HANDLE
);
807 Status
= gBS
->LocateHandle (
809 &gEfiHiiDatabaseProtocolGuid
,
815 if (EFI_ERROR (Status
)) {
819 Status
= gBS
->HandleProtocol (
821 &gEfiHiiDatabaseProtocolGuid
,
822 (VOID
**) &mHiiDatabase
825 if (EFI_ERROR (Status
)) {
829 Status
= gBS
->HandleProtocol (
831 &gEfiHiiFontProtocolGuid
,
838 // Body of the STO functions
842 Reset the text output device hardware and optionally run diagnostics.
844 Implements SIMPLE_TEXT_OUTPUT.Reset().
845 If ExtendeVerification is TRUE, then perform dependent Graphics Console
846 device reset, and set display mode to mode 0.
847 If ExtendedVerification is FALSE, only set display mode to mode 0.
849 @param This Protocol instance pointer.
850 @param ExtendedVerification Indicates that the driver may perform a more
851 exhaustive verification operation of the device
854 @retval EFI_SUCCESS The text output device was reset.
855 @retval EFI_DEVICE_ERROR The text output device is not functioning correctly and
861 GraphicsConsoleConOutReset (
862 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
863 IN BOOLEAN ExtendedVerification
866 This
->SetAttribute (This
, EFI_TEXT_ATTR (This
->Mode
->Attribute
& 0x0F, EFI_BACKGROUND_BLACK
));
867 return This
->SetMode (This
, 0);
872 Write a Unicode string to the output device.
874 Implements SIMPLE_TEXT_OUTPUT.OutputString().
875 The Unicode string will be converted to Glyphs and will be
876 sent to the Graphics Console.
878 @param This Protocol instance pointer.
879 @param WString The NULL-terminated Unicode string to be displayed
880 on the output device(s). All output devices must
881 also support the Unicode drawing defined in this file.
883 @retval EFI_SUCCESS The string was output to the device.
884 @retval EFI_DEVICE_ERROR The device reported an error while attempting to output
886 @retval EFI_UNSUPPORTED The output device's mode is not currently in a
888 @retval EFI_WARN_UNKNOWN_GLYPH This warning code indicates that some of the
889 characters in the Unicode string could not be
890 rendered and were skipped.
895 GraphicsConsoleConOutOutputString (
896 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
900 GRAPHICS_CONSOLE_DEV
*Private
;
901 EFI_GRAPHICS_OUTPUT_PROTOCOL
*GraphicsOutput
;
902 EFI_UGA_DRAW_PROTOCOL
*UgaDraw
;
911 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground
;
912 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background
;
917 INT32 OriginAttribute
;
920 Status
= EFI_SUCCESS
;
922 OldTpl
= gBS
->RaiseTPL (TPL_NOTIFY
);
926 Mode
= This
->Mode
->Mode
;
927 Private
= GRAPHICS_CONSOLE_CON_OUT_DEV_FROM_THIS (This
);
928 GraphicsOutput
= Private
->GraphicsOutput
;
929 UgaDraw
= Private
->UgaDraw
;
931 MaxColumn
= Private
->ModeData
[Mode
].Columns
;
932 MaxRow
= Private
->ModeData
[Mode
].Rows
;
933 DeltaX
= (UINTN
) Private
->ModeData
[Mode
].DeltaX
;
934 DeltaY
= (UINTN
) Private
->ModeData
[Mode
].DeltaY
;
935 Width
= MaxColumn
* EFI_GLYPH_WIDTH
;
936 Height
= (MaxRow
- 1) * EFI_GLYPH_HEIGHT
;
937 Delta
= Width
* sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
);
940 // The Attributes won't change when during the time OutputString is called
942 GetTextColors (This
, &Foreground
, &Background
);
951 OriginAttribute
= This
->Mode
->Attribute
;
953 while (*WString
!= L
'\0') {
955 if (*WString
== CHAR_BACKSPACE
) {
957 // If the cursor is at the left edge of the display, then move the cursor
960 if (This
->Mode
->CursorColumn
== 0 && This
->Mode
->CursorRow
> 0) {
961 This
->Mode
->CursorRow
--;
962 This
->Mode
->CursorColumn
= (INT32
) (MaxColumn
- 1);
963 This
->OutputString (This
, SpaceStr
);
965 This
->Mode
->CursorRow
--;
966 This
->Mode
->CursorColumn
= (INT32
) (MaxColumn
- 1);
967 } else if (This
->Mode
->CursorColumn
> 0) {
969 // If the cursor is not at the left edge of the display, then move the cursor
972 This
->Mode
->CursorColumn
--;
973 This
->OutputString (This
, SpaceStr
);
975 This
->Mode
->CursorColumn
--;
980 } else if (*WString
== CHAR_LINEFEED
) {
982 // If the cursor is at the bottom of the display, then scroll the display one
983 // row, and do not update the cursor position. Otherwise, move the cursor
986 if (This
->Mode
->CursorRow
== (INT32
) (MaxRow
- 1)) {
987 if (GraphicsOutput
!= NULL
) {
989 // Scroll Screen Up One Row
991 GraphicsOutput
->Blt (
996 DeltaY
+ EFI_GLYPH_HEIGHT
,
1005 // Print Blank Line at last line
1007 GraphicsOutput
->Blt (
1019 } else if (FeaturePcdGet (PcdUgaConsumeSupport
)) {
1021 // Scroll Screen Up One Row
1028 DeltaY
+ EFI_GLYPH_HEIGHT
,
1037 // Print Blank Line at last line
1041 (EFI_UGA_PIXEL
*) (UINTN
) &Background
,
1053 This
->Mode
->CursorRow
++;
1058 } else if (*WString
== CHAR_CARRIAGE_RETURN
) {
1060 // Move the cursor to the beginning of the current row.
1062 This
->Mode
->CursorColumn
= 0;
1065 } else if (*WString
== WIDE_CHAR
) {
1067 This
->Mode
->Attribute
|= EFI_WIDE_ATTRIBUTE
;
1070 } else if (*WString
== NARROW_CHAR
) {
1072 This
->Mode
->Attribute
&= (~ (UINT32
) EFI_WIDE_ATTRIBUTE
);
1077 // Print the character at the current cursor position and move the cursor
1078 // right one column. If this moves the cursor past the right edge of the
1079 // display, then the line should wrap to the beginning of the next line. This
1080 // is equivalent to inserting a CR and an LF. Note that if the cursor is at the
1081 // bottom of the display, and the line wraps, then the display will be scrolled
1083 // If wide char is going to be displayed, need to display one character at a time
1084 // Or, need to know the display length of a certain string.
1086 // Index is used to determine how many character width units (wide = 2, narrow = 1)
1087 // Count is used to determine how many characters are used regardless of their attributes
1089 for (Count
= 0, Index
= 0; (This
->Mode
->CursorColumn
+ Index
) < MaxColumn
; Count
++, Index
++) {
1090 if (WString
[Count
] == CHAR_NULL
||
1091 WString
[Count
] == CHAR_BACKSPACE
||
1092 WString
[Count
] == CHAR_LINEFEED
||
1093 WString
[Count
] == CHAR_CARRIAGE_RETURN
||
1094 WString
[Count
] == WIDE_CHAR
||
1095 WString
[Count
] == NARROW_CHAR
) {
1099 // Is the wide attribute on?
1101 if ((This
->Mode
->Attribute
& EFI_WIDE_ATTRIBUTE
) != 0) {
1103 // If wide, add one more width unit than normal since we are going to increment at the end of the for loop
1107 // This is the end-case where if we are at column 79 and about to print a wide character
1108 // We should prevent this from happening because we will wrap inappropriately. We should
1109 // not print this character until the next line.
1111 if ((This
->Mode
->CursorColumn
+ Index
+ 1) > MaxColumn
) {
1118 Status
= DrawUnicodeWeightAtCursorN (This
, WString
, Count
);
1119 if (EFI_ERROR (Status
)) {
1123 // At the end of line, output carriage return and line feed
1126 This
->Mode
->CursorColumn
+= (INT32
) Index
;
1127 if (This
->Mode
->CursorColumn
> (INT32
) MaxColumn
) {
1128 This
->Mode
->CursorColumn
-= 2;
1129 This
->OutputString (This
, SpaceStr
);
1132 if (This
->Mode
->CursorColumn
>= (INT32
) MaxColumn
) {
1134 This
->OutputString (This
, mCrLfString
);
1140 This
->Mode
->Attribute
= OriginAttribute
;
1145 Status
= EFI_WARN_UNKNOWN_GLYPH
;
1148 gBS
->RestoreTPL (OldTpl
);
1154 Verifies that all characters in a Unicode string can be output to the
1157 Implements SIMPLE_TEXT_OUTPUT.TestString().
1158 If one of the characters in the *Wstring is neither valid valid Unicode
1159 drawing characters, not ASCII code, then this function will return
1162 @param This Protocol instance pointer.
1163 @param WString The NULL-terminated Unicode string to be examined for the output
1166 @retval EFI_SUCCESS The device(s) are capable of rendering the output string.
1167 @retval EFI_UNSUPPORTED Some of the characters in the Unicode string cannot be
1168 rendered by one or more of the output devices mapped
1174 GraphicsConsoleConOutTestString (
1175 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
1182 EFI_IMAGE_OUTPUT
*Blt
;
1187 while (WString
[Count
] != 0) {
1188 Status
= mHiiFont
->GetGlyph (
1201 if (EFI_ERROR (Status
)) {
1202 return EFI_UNSUPPORTED
;
1211 Returns information for an available text mode that the output device(s)
1214 Implements SIMPLE_TEXT_OUTPUT.QueryMode().
1215 It returnes information for an available text mode that the Graphics Console supports.
1216 In this driver,we only support text mode 80x25, which is defined as mode 0.
1218 @param This Protocol instance pointer.
1219 @param ModeNumber The mode number to return information on.
1220 @param Columns The returned columns of the requested mode.
1221 @param Rows The returned rows of the requested mode.
1223 @retval EFI_SUCCESS The requested mode information is returned.
1224 @retval EFI_UNSUPPORTED The mode number is not valid.
1229 GraphicsConsoleConOutQueryMode (
1230 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
1231 IN UINTN ModeNumber
,
1236 GRAPHICS_CONSOLE_DEV
*Private
;
1240 if (ModeNumber
>= (UINTN
) This
->Mode
->MaxMode
) {
1241 return EFI_UNSUPPORTED
;
1244 OldTpl
= gBS
->RaiseTPL (TPL_NOTIFY
);
1245 Status
= EFI_SUCCESS
;
1247 Private
= GRAPHICS_CONSOLE_CON_OUT_DEV_FROM_THIS (This
);
1249 *Columns
= Private
->ModeData
[ModeNumber
].Columns
;
1250 *Rows
= Private
->ModeData
[ModeNumber
].Rows
;
1252 if (*Columns
<= 0 || *Rows
<= 0) {
1253 Status
= EFI_UNSUPPORTED
;
1259 gBS
->RestoreTPL (OldTpl
);
1265 Sets the output device(s) to a specified mode.
1267 Implements SIMPLE_TEXT_OUTPUT.SetMode().
1268 Set the Graphics Console to a specified mode. In this driver, we only support mode 0.
1270 @param This Protocol instance pointer.
1271 @param ModeNumber The text mode to set.
1273 @retval EFI_SUCCESS The requested text mode is set.
1274 @retval EFI_DEVICE_ERROR The requested text mode cannot be set because of
1275 Graphics Console device error.
1276 @retval EFI_UNSUPPORTED The text mode number is not valid.
1281 GraphicsConsoleConOutSetMode (
1282 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
1287 GRAPHICS_CONSOLE_DEV
*Private
;
1288 GRAPHICS_CONSOLE_MODE_DATA
*ModeData
;
1289 EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*NewLineBuffer
;
1290 UINT32 HorizontalResolution
;
1291 UINT32 VerticalResolution
;
1292 EFI_GRAPHICS_OUTPUT_PROTOCOL
*GraphicsOutput
;
1293 EFI_UGA_DRAW_PROTOCOL
*UgaDraw
;
1298 OldTpl
= gBS
->RaiseTPL (TPL_NOTIFY
);
1300 Private
= GRAPHICS_CONSOLE_CON_OUT_DEV_FROM_THIS (This
);
1301 GraphicsOutput
= Private
->GraphicsOutput
;
1302 UgaDraw
= Private
->UgaDraw
;
1303 ModeData
= &(Private
->ModeData
[ModeNumber
]);
1306 // Make sure the requested mode number is supported
1308 if (ModeNumber
>= (UINTN
) This
->Mode
->MaxMode
) {
1309 Status
= EFI_UNSUPPORTED
;
1313 if (ModeData
->Columns
<= 0 && ModeData
->Rows
<= 0) {
1314 Status
= EFI_UNSUPPORTED
;
1318 // Attempt to allocate a line buffer for the requested mode number
1320 NewLineBuffer
= AllocatePool (sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
) * ModeData
->Columns
* EFI_GLYPH_WIDTH
* EFI_GLYPH_HEIGHT
);
1322 if (NewLineBuffer
== NULL
) {
1324 // The new line buffer could not be allocated, so return an error.
1325 // No changes to the state of the current console have been made, so the current console is still valid
1327 Status
= EFI_OUT_OF_RESOURCES
;
1331 // If the mode has been set at least one other time, then LineBuffer will not be NULL
1333 if (Private
->LineBuffer
!= NULL
) {
1335 // Clear the current text window on the current graphics console
1337 This
->ClearScreen (This
);
1340 // If the new mode is the same as the old mode, then just return EFI_SUCCESS
1342 if ((INT32
) ModeNumber
== This
->Mode
->Mode
) {
1343 FreePool (NewLineBuffer
);
1344 Status
= EFI_SUCCESS
;
1348 // Otherwise, the size of the text console and/or the GOP/UGA mode will be changed,
1349 // so erase the cursor, and free the LineBuffer for the current mode
1353 FreePool (Private
->LineBuffer
);
1356 // Assign the current line buffer to the newly allocated line buffer
1358 Private
->LineBuffer
= NewLineBuffer
;
1360 if (GraphicsOutput
!= NULL
) {
1361 if (ModeData
->GopModeNumber
!= GraphicsOutput
->Mode
->Mode
) {
1363 // Either no graphics mode is currently set, or it is set to the wrong resolution, so set the new graphics mode
1365 Status
= GraphicsOutput
->SetMode (GraphicsOutput
, ModeData
->GopModeNumber
);
1366 if (EFI_ERROR (Status
)) {
1368 // The mode set operation failed
1374 // The current graphics mode is correct, so simply clear the entire display
1376 Status
= GraphicsOutput
->Blt (
1378 &mGraphicsEfiColors
[0],
1385 ModeData
->GopHeight
,
1389 } else if (FeaturePcdGet (PcdUgaConsumeSupport
)) {
1391 // Get the current UGA Draw mode information
1393 Status
= UgaDraw
->GetMode (
1395 &HorizontalResolution
,
1396 &VerticalResolution
,
1400 if (EFI_ERROR (Status
) || HorizontalResolution
!= ModeData
->GopWidth
|| VerticalResolution
!= ModeData
->GopHeight
) {
1402 // Either no graphics mode is currently set, or it is set to the wrong resolution, so set the new graphics mode
1404 Status
= UgaDraw
->SetMode (
1407 ModeData
->GopHeight
,
1411 if (EFI_ERROR (Status
)) {
1413 // The mode set operation failed
1419 // The current graphics mode is correct, so simply clear the entire display
1421 Status
= UgaDraw
->Blt (
1423 (EFI_UGA_PIXEL
*) (UINTN
) &mGraphicsEfiColors
[0],
1430 ModeData
->GopHeight
,
1437 // The new mode is valid, so commit the mode change
1439 This
->Mode
->Mode
= (INT32
) ModeNumber
;
1442 // Move the text cursor to the upper left hand corner of the display and flush it
1444 This
->Mode
->CursorColumn
= 0;
1445 This
->Mode
->CursorRow
= 0;
1449 Status
= EFI_SUCCESS
;
1452 gBS
->RestoreTPL (OldTpl
);
1458 Sets the background and foreground colors for the OutputString () and
1459 ClearScreen () functions.
1461 Implements SIMPLE_TEXT_OUTPUT.SetAttribute().
1463 @param This Protocol instance pointer.
1464 @param Attribute The attribute to set. Bits 0..3 are the foreground
1465 color, and bits 4..6 are the background color.
1466 All other bits are undefined and must be zero.
1468 @retval EFI_SUCCESS The requested attribute is set.
1469 @retval EFI_DEVICE_ERROR The requested attribute cannot be set due to Graphics Console port error.
1470 @retval EFI_UNSUPPORTED The attribute requested is not defined.
1475 GraphicsConsoleConOutSetAttribute (
1476 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
1482 if ((Attribute
| 0xFF) != 0xFF) {
1483 return EFI_UNSUPPORTED
;
1486 if ((INT32
) Attribute
== This
->Mode
->Attribute
) {
1490 OldTpl
= gBS
->RaiseTPL (TPL_NOTIFY
);
1494 This
->Mode
->Attribute
= (INT32
) Attribute
;
1498 gBS
->RestoreTPL (OldTpl
);
1505 Clears the output device(s) display to the currently selected background
1508 Implements SIMPLE_TEXT_OUTPUT.ClearScreen().
1510 @param This Protocol instance pointer.
1512 @retval EFI_SUCCESS The operation completed successfully.
1513 @retval EFI_DEVICE_ERROR The device had an error and could not complete the request.
1514 @retval EFI_UNSUPPORTED The output device is not in a valid text mode.
1519 GraphicsConsoleConOutClearScreen (
1520 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
1524 GRAPHICS_CONSOLE_DEV
*Private
;
1525 GRAPHICS_CONSOLE_MODE_DATA
*ModeData
;
1526 EFI_GRAPHICS_OUTPUT_PROTOCOL
*GraphicsOutput
;
1527 EFI_UGA_DRAW_PROTOCOL
*UgaDraw
;
1528 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground
;
1529 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background
;
1532 OldTpl
= gBS
->RaiseTPL (TPL_NOTIFY
);
1534 Private
= GRAPHICS_CONSOLE_CON_OUT_DEV_FROM_THIS (This
);
1535 GraphicsOutput
= Private
->GraphicsOutput
;
1536 UgaDraw
= Private
->UgaDraw
;
1537 ModeData
= &(Private
->ModeData
[This
->Mode
->Mode
]);
1539 GetTextColors (This
, &Foreground
, &Background
);
1540 if (GraphicsOutput
!= NULL
) {
1541 Status
= GraphicsOutput
->Blt (
1550 ModeData
->GopHeight
,
1553 } else if (FeaturePcdGet (PcdUgaConsumeSupport
)) {
1554 Status
= UgaDraw
->Blt (
1556 (EFI_UGA_PIXEL
*) (UINTN
) &Background
,
1563 ModeData
->GopHeight
,
1567 Status
= EFI_UNSUPPORTED
;
1570 This
->Mode
->CursorColumn
= 0;
1571 This
->Mode
->CursorRow
= 0;
1575 gBS
->RestoreTPL (OldTpl
);
1582 Sets the current coordinates of the cursor position.
1584 Implements SIMPLE_TEXT_OUTPUT.SetCursorPosition().
1586 @param This Protocol instance pointer.
1587 @param Column The position to set the cursor to. Must be greater than or
1588 equal to zero and less than the number of columns and rows
1590 @param Row The position to set the cursor to. Must be greater than or
1591 equal to zero and less than the number of columns and rows
1594 @retval EFI_SUCCESS The operation completed successfully.
1595 @retval EFI_DEVICE_ERROR The device had an error and could not complete the request.
1596 @retval EFI_UNSUPPORTED The output device is not in a valid text mode, or the
1597 cursor position is invalid for the current mode.
1602 GraphicsConsoleConOutSetCursorPosition (
1603 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
1608 GRAPHICS_CONSOLE_DEV
*Private
;
1609 GRAPHICS_CONSOLE_MODE_DATA
*ModeData
;
1613 Status
= EFI_SUCCESS
;
1615 OldTpl
= gBS
->RaiseTPL (TPL_NOTIFY
);
1617 Private
= GRAPHICS_CONSOLE_CON_OUT_DEV_FROM_THIS (This
);
1618 ModeData
= &(Private
->ModeData
[This
->Mode
->Mode
]);
1620 if ((Column
>= ModeData
->Columns
) || (Row
>= ModeData
->Rows
)) {
1621 Status
= EFI_UNSUPPORTED
;
1625 if ((This
->Mode
->CursorColumn
== (INT32
) Column
) && (This
->Mode
->CursorRow
== (INT32
) Row
)) {
1626 Status
= EFI_SUCCESS
;
1632 This
->Mode
->CursorColumn
= (INT32
) Column
;
1633 This
->Mode
->CursorRow
= (INT32
) Row
;
1638 gBS
->RestoreTPL (OldTpl
);
1645 Makes the cursor visible or invisible.
1647 Implements SIMPLE_TEXT_OUTPUT.EnableCursor().
1649 @param This Protocol instance pointer.
1650 @param Visible If TRUE, the cursor is set to be visible, If FALSE,
1651 the cursor is set to be invisible.
1653 @retval EFI_SUCCESS The operation completed successfully.
1658 GraphicsConsoleConOutEnableCursor (
1659 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
1665 OldTpl
= gBS
->RaiseTPL (TPL_NOTIFY
);
1669 This
->Mode
->CursorVisible
= Visible
;
1673 gBS
->RestoreTPL (OldTpl
);
1678 Gets Graphics Console devcie's foreground color and background color.
1680 @param This Protocol instance pointer.
1681 @param Foreground Returned text foreground color.
1682 @param Background Returned text background color.
1684 @retval EFI_SUCCESS It returned always.
1689 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
1690 OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*Foreground
,
1691 OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*Background
1696 Attribute
= This
->Mode
->Attribute
& 0x7F;
1698 *Foreground
= mGraphicsEfiColors
[Attribute
& 0x0f];
1699 *Background
= mGraphicsEfiColors
[Attribute
>> 4];
1705 Draw Unicode string on the Graphics Console device's screen.
1707 @param This Protocol instance pointer.
1708 @param UnicodeWeight One Unicode string to be displayed.
1709 @param Count The count of Unicode string.
1711 @retval EFI_OUT_OF_RESOURCES If no memory resource to use.
1712 @retval EFI_UNSUPPORTED If no Graphics Output protocol and UGA Draw
1714 @retval EFI_SUCCESS Drawing Unicode string implemented successfully.
1718 DrawUnicodeWeightAtCursorN (
1719 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
1720 IN CHAR16
*UnicodeWeight
,
1725 GRAPHICS_CONSOLE_DEV
*Private
;
1726 EFI_IMAGE_OUTPUT
*Blt
;
1728 EFI_FONT_DISPLAY_INFO
*FontInfo
;
1729 EFI_UGA_DRAW_PROTOCOL
*UgaDraw
;
1730 EFI_HII_ROW_INFO
*RowInfoArray
;
1731 UINTN RowInfoArraySize
;
1733 Private
= GRAPHICS_CONSOLE_CON_OUT_DEV_FROM_THIS (This
);
1734 Blt
= (EFI_IMAGE_OUTPUT
*) AllocateZeroPool (sizeof (EFI_IMAGE_OUTPUT
));
1736 return EFI_OUT_OF_RESOURCES
;
1739 Blt
->Width
= (UINT16
) (Private
->ModeData
[This
->Mode
->Mode
].GopWidth
);
1740 Blt
->Height
= (UINT16
) (Private
->ModeData
[This
->Mode
->Mode
].GopHeight
);
1742 String
= AllocateCopyPool ((Count
+ 1) * sizeof (CHAR16
), UnicodeWeight
);
1743 if (String
== NULL
) {
1745 return EFI_OUT_OF_RESOURCES
;
1748 // Set the end character
1750 *(String
+ Count
) = L
'\0';
1752 FontInfo
= (EFI_FONT_DISPLAY_INFO
*) AllocateZeroPool (sizeof (EFI_FONT_DISPLAY_INFO
));
1753 if (FontInfo
== NULL
) {
1756 return EFI_OUT_OF_RESOURCES
;
1759 // Get current foreground and background colors.
1761 GetTextColors (This
, &FontInfo
->ForegroundColor
, &FontInfo
->BackgroundColor
);
1763 if (Private
->GraphicsOutput
!= NULL
) {
1765 // If Graphics Output protocol exists, using HII Font protocol to draw.
1767 Blt
->Image
.Screen
= Private
->GraphicsOutput
;
1769 Status
= mHiiFont
->StringToImage (
1771 EFI_HII_IGNORE_IF_NO_GLYPH
| EFI_HII_DIRECT_TO_SCREEN
| EFI_HII_IGNORE_LINE_BREAK
,
1775 This
->Mode
->CursorColumn
* EFI_GLYPH_WIDTH
+ Private
->ModeData
[This
->Mode
->Mode
].DeltaX
,
1776 This
->Mode
->CursorRow
* EFI_GLYPH_HEIGHT
+ Private
->ModeData
[This
->Mode
->Mode
].DeltaY
,
1782 } else if (FeaturePcdGet (PcdUgaConsumeSupport
)) {
1784 // If Graphics Output protocol cannot be found and PcdUgaConsumeSupport enabled,
1785 // using UGA Draw protocol to draw.
1787 ASSERT (Private
->UgaDraw
!= NULL
);
1789 UgaDraw
= Private
->UgaDraw
;
1791 Blt
->Image
.Bitmap
= AllocateZeroPool (Blt
->Width
* Blt
->Height
* sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
));
1792 if (Blt
->Image
.Bitmap
== NULL
) {
1795 return EFI_OUT_OF_RESOURCES
;
1798 RowInfoArray
= NULL
;
1800 // StringToImage only support blt'ing image to device using GOP protocol. If GOP is not supported in this platform,
1801 // we ask StringToImage to print the string to blt buffer, then blt to device using UgaDraw.
1803 Status
= mHiiFont
->StringToImage (
1805 EFI_HII_IGNORE_IF_NO_GLYPH
| EFI_HII_IGNORE_LINE_BREAK
,
1809 This
->Mode
->CursorColumn
* EFI_GLYPH_WIDTH
+ Private
->ModeData
[This
->Mode
->Mode
].DeltaX
,
1810 This
->Mode
->CursorRow
* EFI_GLYPH_HEIGHT
+ Private
->ModeData
[This
->Mode
->Mode
].DeltaY
,
1816 if (!EFI_ERROR (Status
)) {
1818 // Line breaks are handled by caller of DrawUnicodeWeightAtCursorN, so the updated parameter RowInfoArraySize by StringToImage will
1819 // always be 1 or 0 (if there is no valid Unicode Char can be printed). ASSERT here to make sure.
1821 ASSERT (RowInfoArraySize
<= 1);
1823 Status
= UgaDraw
->Blt (
1825 (EFI_UGA_PIXEL
*) Blt
->Image
.Bitmap
,
1826 EfiUgaBltBufferToVideo
,
1827 This
->Mode
->CursorColumn
* EFI_GLYPH_WIDTH
+ Private
->ModeData
[This
->Mode
->Mode
].DeltaX
,
1828 (This
->Mode
->CursorRow
) * EFI_GLYPH_HEIGHT
+ Private
->ModeData
[This
->Mode
->Mode
].DeltaY
,
1829 This
->Mode
->CursorColumn
* EFI_GLYPH_WIDTH
+ Private
->ModeData
[This
->Mode
->Mode
].DeltaX
,
1830 (This
->Mode
->CursorRow
) * EFI_GLYPH_HEIGHT
+ Private
->ModeData
[This
->Mode
->Mode
].DeltaY
,
1831 RowInfoArray
[0].LineWidth
,
1832 RowInfoArray
[0].LineHeight
,
1833 Blt
->Width
* sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
)
1837 FreePool (RowInfoArray
);
1838 FreePool (Blt
->Image
.Bitmap
);
1840 Status
= EFI_UNSUPPORTED
;
1846 if (String
!= NULL
) {
1849 if (FontInfo
!= NULL
) {
1850 FreePool (FontInfo
);
1856 Flush the cursor on the screen.
1858 If CursorVisible is FALSE, nothing to do and return directly.
1859 If CursorVisible is TRUE,
1860 i) If the cursor shows on screen, it will be erased.
1861 ii) If the cursor does not show on screen, it will be shown.
1863 @param This Protocol instance pointer.
1865 @retval EFI_SUCCESS The cursor is erased successfully.
1870 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
1873 GRAPHICS_CONSOLE_DEV
*Private
;
1874 EFI_SIMPLE_TEXT_OUTPUT_MODE
*CurrentMode
;
1877 EFI_GRAPHICS_OUTPUT_PROTOCOL
*GraphicsOutput
;
1878 EFI_UGA_DRAW_PROTOCOL
*UgaDraw
;
1879 EFI_GRAPHICS_OUTPUT_BLT_PIXEL_UNION Foreground
;
1880 EFI_GRAPHICS_OUTPUT_BLT_PIXEL_UNION Background
;
1881 EFI_GRAPHICS_OUTPUT_BLT_PIXEL_UNION BltChar
[EFI_GLYPH_HEIGHT
][EFI_GLYPH_WIDTH
];
1885 CurrentMode
= This
->Mode
;
1887 if (!CurrentMode
->CursorVisible
) {
1891 Private
= GRAPHICS_CONSOLE_CON_OUT_DEV_FROM_THIS (This
);
1892 GraphicsOutput
= Private
->GraphicsOutput
;
1893 UgaDraw
= Private
->UgaDraw
;
1896 // In this driver, only narrow character was supported.
1899 // Blt a character to the screen
1901 GlyphX
= (CurrentMode
->CursorColumn
* EFI_GLYPH_WIDTH
) + Private
->ModeData
[CurrentMode
->Mode
].DeltaX
;
1902 GlyphY
= (CurrentMode
->CursorRow
* EFI_GLYPH_HEIGHT
) + Private
->ModeData
[CurrentMode
->Mode
].DeltaY
;
1903 if (GraphicsOutput
!= NULL
) {
1904 GraphicsOutput
->Blt (
1906 (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*) BltChar
,
1907 EfiBltVideoToBltBuffer
,
1914 EFI_GLYPH_WIDTH
* sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
)
1916 } else if (FeaturePcdGet (PcdUgaConsumeSupport
)) {
1919 (EFI_UGA_PIXEL
*) (UINTN
) BltChar
,
1920 EfiUgaVideoToBltBuffer
,
1927 EFI_GLYPH_WIDTH
* sizeof (EFI_UGA_PIXEL
)
1931 GetTextColors (This
, &Foreground
.Pixel
, &Background
.Pixel
);
1934 // Convert Monochrome bitmap of the Glyph to BltBuffer structure
1936 for (PosY
= 0; PosY
< EFI_GLYPH_HEIGHT
; PosY
++) {
1937 for (PosX
= 0; PosX
< EFI_GLYPH_WIDTH
; PosX
++) {
1938 if ((mCursorGlyph
.GlyphCol1
[PosY
] & (BIT0
<< PosX
)) != 0) {
1939 BltChar
[PosY
][EFI_GLYPH_WIDTH
- PosX
- 1].Raw
^= Foreground
.Raw
;
1944 if (GraphicsOutput
!= NULL
) {
1945 GraphicsOutput
->Blt (
1947 (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*) BltChar
,
1948 EfiBltBufferToVideo
,
1955 EFI_GLYPH_WIDTH
* sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
)
1957 } else if (FeaturePcdGet (PcdUgaConsumeSupport
)) {
1960 (EFI_UGA_PIXEL
*) (UINTN
) BltChar
,
1961 EfiUgaBltBufferToVideo
,
1968 EFI_GLYPH_WIDTH
* sizeof (EFI_UGA_PIXEL
)
1976 HII Database Protocol notification event handler.
1978 Register font package when HII Database Protocol has been installed.
1980 @param[in] Event Event whose notification function is being invoked.
1981 @param[in] Context Pointer to the notification function's context.
1985 RegisterFontPackage (
1991 EFI_HII_SIMPLE_FONT_PACKAGE_HDR
*SimplifiedFont
;
1992 UINT32 PackageLength
;
1995 EFI_HII_DATABASE_PROTOCOL
*HiiDatabase
;
1998 // Locate HII Database Protocol
2000 Status
= gBS
->LocateProtocol (
2001 &gEfiHiiDatabaseProtocolGuid
,
2003 (VOID
**) &HiiDatabase
2005 ASSERT_EFI_ERROR (Status
);
2008 // Add 4 bytes to the header for entire length for HiiAddPackages use only.
2010 // +--------------------------------+ <-- Package
2012 // | PackageLength(4 bytes) |
2014 // |--------------------------------| <-- SimplifiedFont
2016 // |EFI_HII_SIMPLE_FONT_PACKAGE_HDR |
2018 // |--------------------------------| <-- Location
2020 // | gUsStdNarrowGlyphData |
2022 // +--------------------------------+
2024 PackageLength
= sizeof (EFI_HII_SIMPLE_FONT_PACKAGE_HDR
) + mNarrowFontSize
+ 4;
2025 Package
= AllocateZeroPool (PackageLength
);
2026 ASSERT (Package
!= NULL
);
2028 WriteUnaligned32((UINT32
*) Package
,PackageLength
);
2029 SimplifiedFont
= (EFI_HII_SIMPLE_FONT_PACKAGE_HDR
*) (Package
+ 4);
2030 SimplifiedFont
->Header
.Length
= (UINT32
) (PackageLength
- 4);
2031 SimplifiedFont
->Header
.Type
= EFI_HII_PACKAGE_SIMPLE_FONTS
;
2032 SimplifiedFont
->NumberOfNarrowGlyphs
= (UINT16
) (mNarrowFontSize
/ sizeof (EFI_NARROW_GLYPH
));
2034 Location
= (UINT8
*) (&SimplifiedFont
->NumberOfWideGlyphs
+ 1);
2035 CopyMem (Location
, gUsStdNarrowGlyphData
, mNarrowFontSize
);
2038 // Add this simplified font package to a package list then install it.
2040 mHiiHandle
= HiiAddPackages (
2041 &mFontPackageListGuid
,
2046 ASSERT (mHiiHandle
!= NULL
);
2051 The user Entry Point for module GraphicsConsole. The user code starts with this function.
2053 @param[in] ImageHandle The firmware allocated handle for the EFI image.
2054 @param[in] SystemTable A pointer to the EFI System Table.
2056 @retval EFI_SUCCESS The entry point is executed successfully.
2057 @return other Some error occurs when executing this entry point.
2062 InitializeGraphicsConsole (
2063 IN EFI_HANDLE ImageHandle
,
2064 IN EFI_SYSTEM_TABLE
*SystemTable
2070 // Register notify function on HII Database Protocol to add font package.
2072 EfiCreateProtocolNotifyEvent (
2073 &gEfiHiiDatabaseProtocolGuid
,
2075 RegisterFontPackage
,
2081 // Install driver model protocol(s).
2083 Status
= EfiLibInstallDriverBindingComponentName2 (
2086 &gGraphicsConsoleDriverBinding
,
2088 &gGraphicsConsoleComponentName
,
2089 &gGraphicsConsoleComponentName2
2091 ASSERT_EFI_ERROR (Status
);