2 This is the main routine for initializing the Graphics Console support routines.
4 Copyright (c) 2006 - 2009, 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
),
45 { 80, 25, 0, 0, 0, 0 }, // Mode 0
46 { 80, 50, 0, 0, 0, 0 }, // Mode 1
47 { 100,31, 0, 0, 0, 0 }, // Mode 2
48 { 0, 0, 0, 0, 0, 0 } // Mode 3
50 (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*) NULL
53 EFI_HII_DATABASE_PROTOCOL
*mHiiDatabase
;
54 EFI_HII_FONT_PROTOCOL
*mHiiFont
;
55 EFI_HII_HANDLE mHiiHandle
;
56 EFI_EVENT mHiiRegistration
;
58 EFI_GUID mFontPackageListGuid
= {0xf5f219d3, 0x7006, 0x4648, {0xac, 0x8d, 0xd6, 0x1d, 0xfb, 0x7b, 0xc6, 0xad}};
60 CHAR16 mCrLfString
[3] = { CHAR_CARRIAGE_RETURN
, CHAR_LINEFEED
, CHAR_NULL
};
62 EFI_GRAPHICS_OUTPUT_BLT_PIXEL mGraphicsEfiColors
[16] = {
66 {0x00, 0x00, 0x00, 0x00}, // BLACK
67 {0x98, 0x00, 0x00, 0x00}, // LIGHTBLUE
68 {0x00, 0x98, 0x00, 0x00}, // LIGHGREEN
69 {0x98, 0x98, 0x00, 0x00}, // LIGHCYAN
70 {0x00, 0x00, 0x98, 0x00}, // LIGHRED
71 {0x98, 0x00, 0x98, 0x00}, // MAGENTA
72 {0x00, 0x98, 0x98, 0x00}, // BROWN
73 {0x98, 0x98, 0x98, 0x00}, // LIGHTGRAY
74 {0x30, 0x30, 0x30, 0x00}, // DARKGRAY - BRIGHT BLACK
75 {0xff, 0x00, 0x00, 0x00}, // BLUE
76 {0x00, 0xff, 0x00, 0x00}, // LIME
77 {0xff, 0xff, 0x00, 0x00}, // CYAN
78 {0x00, 0x00, 0xff, 0x00}, // RED
79 {0xff, 0x00, 0xff, 0x00}, // FUCHSIA
80 {0x00, 0xff, 0xff, 0x00}, // YELLOW
81 {0xff, 0xff, 0xff, 0x00} // WHITE
84 EFI_NARROW_GLYPH mCursorGlyph
= {
87 { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xFF, 0xFF, 0xFF }
90 CHAR16 SpaceStr
[] = { NARROW_CHAR
, ' ', 0 };
92 EFI_DRIVER_BINDING_PROTOCOL gGraphicsConsoleDriverBinding
= {
93 GraphicsConsoleControllerDriverSupported
,
94 GraphicsConsoleControllerDriverStart
,
95 GraphicsConsoleControllerDriverStop
,
102 Test to see if Graphics Console could be supported on the Controller.
104 Graphics Console could be supported if Graphics Output Protocol or UGA Draw
105 Protocol exists on the Controller. (UGA Draw Protocol could be skipped
106 if PcdUgaConsumeSupport is set to FALSE.)
108 @param This Protocol instance pointer.
109 @param Controller Handle of device to test.
110 @param RemainingDevicePath Optional parameter use to pick a specific child
113 @retval EFI_SUCCESS This driver supports this device.
114 @retval other This driver does not support this device.
119 GraphicsConsoleControllerDriverSupported (
120 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
121 IN EFI_HANDLE Controller
,
122 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
126 EFI_GRAPHICS_OUTPUT_PROTOCOL
*GraphicsOutput
;
127 EFI_UGA_DRAW_PROTOCOL
*UgaDraw
;
128 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
130 GraphicsOutput
= NULL
;
133 // Open the IO Abstraction(s) needed to perform the supported test
135 Status
= gBS
->OpenProtocol (
137 &gEfiGraphicsOutputProtocolGuid
,
138 (VOID
**) &GraphicsOutput
,
139 This
->DriverBindingHandle
,
141 EFI_OPEN_PROTOCOL_BY_DRIVER
144 if (EFI_ERROR (Status
) && FeaturePcdGet (PcdUgaConsumeSupport
)) {
146 // Open Graphics Output Protocol failed, try to open UGA Draw Protocol
148 Status
= gBS
->OpenProtocol (
150 &gEfiUgaDrawProtocolGuid
,
152 This
->DriverBindingHandle
,
154 EFI_OPEN_PROTOCOL_BY_DRIVER
157 if (EFI_ERROR (Status
)) {
162 // We need to ensure that we do not layer on top of a virtual handle.
163 // We need to ensure that the handles produced by the conspliter do not
166 Status
= gBS
->OpenProtocol (
168 &gEfiDevicePathProtocolGuid
,
169 (VOID
**) &DevicePath
,
170 This
->DriverBindingHandle
,
172 EFI_OPEN_PROTOCOL_BY_DRIVER
174 if (!EFI_ERROR (Status
)) {
177 &gEfiDevicePathProtocolGuid
,
178 This
->DriverBindingHandle
,
186 // Does Hii Exist? If not, we aren't ready to run
188 Status
= EfiLocateHiiProtocol ();
191 // Close the I/O Abstraction(s) used to perform the supported test
194 if (GraphicsOutput
!= NULL
) {
197 &gEfiGraphicsOutputProtocolGuid
,
198 This
->DriverBindingHandle
,
201 } else if (FeaturePcdGet (PcdUgaConsumeSupport
)) {
204 &gEfiUgaDrawProtocolGuid
,
205 This
->DriverBindingHandle
,
214 Start this driver on Controller by opening Graphics Output protocol or
215 UGA Draw protocol, and installing Simple Text Out protocol on Controller.
216 (UGA Draw protocol could be skipped if PcdUgaConsumeSupport is set to FALSE.)
218 @param This Protocol instance pointer.
219 @param Controller Handle of device to bind driver to
220 @param RemainingDevicePath Optional parameter use to pick a specific child
223 @retval EFI_SUCCESS This driver is added to Controller.
224 @retval other This driver does not support this device.
229 GraphicsConsoleControllerDriverStart (
230 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
231 IN EFI_HANDLE Controller
,
232 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
236 GRAPHICS_CONSOLE_DEV
*Private
;
237 UINT32 HorizontalResolution
;
238 UINT32 VerticalResolution
;
245 EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE
*Mode
;
249 // Initialize the Graphics Console device instance
251 Private
= AllocateCopyPool (
252 sizeof (GRAPHICS_CONSOLE_DEV
),
253 &mGraphicsConsoleDevTemplate
255 if (Private
== NULL
) {
256 return EFI_OUT_OF_RESOURCES
;
259 Private
->SimpleTextOutput
.Mode
= &(Private
->SimpleTextOutputMode
);
261 Status
= gBS
->OpenProtocol (
263 &gEfiGraphicsOutputProtocolGuid
,
264 (VOID
**) &Private
->GraphicsOutput
,
265 This
->DriverBindingHandle
,
267 EFI_OPEN_PROTOCOL_BY_DRIVER
270 if (EFI_ERROR(Status
) && FeaturePcdGet (PcdUgaConsumeSupport
)) {
271 Status
= gBS
->OpenProtocol (
273 &gEfiUgaDrawProtocolGuid
,
274 (VOID
**) &Private
->UgaDraw
,
275 This
->DriverBindingHandle
,
277 EFI_OPEN_PROTOCOL_BY_DRIVER
281 if (EFI_ERROR (Status
)) {
286 // If the current mode information can not be retrieved, then attempt to set the default mode
287 // of 800x600, 32 bit color, 60 Hz refresh.
289 HorizontalResolution
= 800;
290 VerticalResolution
= 600;
292 if (Private
->GraphicsOutput
!= NULL
) {
294 // The console is build on top of Graphics Output Protocol, find the mode number
295 // for the user-defined mode; if there are multiple video devices,
296 // graphic console driver will set all the video devices to the same mode.
298 Status
= CheckModeSupported (
299 Private
->GraphicsOutput
,
300 CURRENT_HORIZONTAL_RESOLUTION
,
301 CURRENT_VERTICAL_RESOLUTION
,
304 if (!EFI_ERROR(Status
)) {
306 // Update default mode to current mode
308 HorizontalResolution
= CURRENT_HORIZONTAL_RESOLUTION
;
309 VerticalResolution
= CURRENT_VERTICAL_RESOLUTION
;
312 // if not supporting current mode, try 800x600 which is required by UEFI/EFI spec
314 Status
= CheckModeSupported (
315 Private
->GraphicsOutput
,
322 Mode
= Private
->GraphicsOutput
->Mode
;
324 if (EFI_ERROR (Status
) || (Mode
->MaxMode
!= 0)) {
326 // Set default mode failed or device don't support default mode, then get the current mode information
328 HorizontalResolution
= Mode
->Info
->HorizontalResolution
;
329 VerticalResolution
= Mode
->Info
->VerticalResolution
;
330 ModeNumber
= Mode
->Mode
;
332 } else if (FeaturePcdGet (PcdUgaConsumeSupport
)) {
334 // At first try to set user-defined resolution
338 Status
= Private
->UgaDraw
->SetMode (
340 CURRENT_HORIZONTAL_RESOLUTION
,
341 CURRENT_VERTICAL_RESOLUTION
,
345 if (!EFI_ERROR (Status
)) {
346 HorizontalResolution
= CURRENT_HORIZONTAL_RESOLUTION
;
347 VerticalResolution
= CURRENT_VERTICAL_RESOLUTION
;
348 } else if (FeaturePcdGet (PcdUgaConsumeSupport
)) {
350 // Try to set 800*600 which is required by UEFI/EFI spec
352 Status
= Private
->UgaDraw
->SetMode (
354 HorizontalResolution
,
359 if (EFI_ERROR (Status
)) {
360 Status
= Private
->UgaDraw
->GetMode (
362 &HorizontalResolution
,
367 if (EFI_ERROR (Status
)) {
372 Status
= EFI_UNSUPPORTED
;
378 // Compute the maximum number of text Rows and Columns that this current graphics mode can support
380 Columns
= HorizontalResolution
/ EFI_GLYPH_WIDTH
;
381 Rows
= VerticalResolution
/ EFI_GLYPH_HEIGHT
;
384 // See if the mode is too small to support the required 80x25 text mode
386 if (Columns
< 80 || Rows
< 25) {
390 // Add Mode #0 that must be 80x25
393 Private
->ModeData
[MaxMode
].GopWidth
= HorizontalResolution
;
394 Private
->ModeData
[MaxMode
].GopHeight
= VerticalResolution
;
395 Private
->ModeData
[MaxMode
].GopModeNumber
= ModeNumber
;
396 Private
->ModeData
[MaxMode
].DeltaX
= (HorizontalResolution
- (80 * EFI_GLYPH_WIDTH
)) >> 1;
397 Private
->ModeData
[MaxMode
].DeltaY
= (VerticalResolution
- (25 * EFI_GLYPH_HEIGHT
)) >> 1;
401 // If it is possible to support Mode #1 - 80x50, than add it as an active mode
404 Private
->ModeData
[MaxMode
].GopWidth
= HorizontalResolution
;
405 Private
->ModeData
[MaxMode
].GopHeight
= VerticalResolution
;
406 Private
->ModeData
[MaxMode
].GopModeNumber
= ModeNumber
;
407 Private
->ModeData
[MaxMode
].DeltaX
= (HorizontalResolution
- (80 * EFI_GLYPH_WIDTH
)) >> 1;
408 Private
->ModeData
[MaxMode
].DeltaY
= (VerticalResolution
- (50 * EFI_GLYPH_HEIGHT
)) >> 1;
413 // If it is not to support Mode #1 - 80x50, then skip it
416 Private
->ModeData
[MaxMode
].Columns
= 0;
417 Private
->ModeData
[MaxMode
].Rows
= 0;
418 Private
->ModeData
[MaxMode
].GopWidth
= HorizontalResolution
;
419 Private
->ModeData
[MaxMode
].GopHeight
= VerticalResolution
;
420 Private
->ModeData
[MaxMode
].GopModeNumber
= ModeNumber
;
421 Private
->ModeData
[MaxMode
].DeltaX
= 0;
422 Private
->ModeData
[MaxMode
].DeltaY
= 0;
427 // Add Mode #2 that must be 100x31 (graphic mode >= 800x600)
429 if (Columns
>= 100 && Rows
>= 31) {
430 Private
->ModeData
[MaxMode
].GopWidth
= HorizontalResolution
;
431 Private
->ModeData
[MaxMode
].GopHeight
= VerticalResolution
;
432 Private
->ModeData
[MaxMode
].GopModeNumber
= ModeNumber
;
433 Private
->ModeData
[MaxMode
].DeltaX
= (HorizontalResolution
- (100 * EFI_GLYPH_WIDTH
)) >> 1;
434 Private
->ModeData
[MaxMode
].DeltaY
= (VerticalResolution
- (31 * EFI_GLYPH_HEIGHT
)) >> 1;
439 // Add Mode #3 that uses the entire display for user-defined mode
441 if (HorizontalResolution
> 800 && VerticalResolution
> 600) {
442 Private
->ModeData
[MaxMode
].Columns
= HorizontalResolution
/EFI_GLYPH_WIDTH
;
443 Private
->ModeData
[MaxMode
].Rows
= VerticalResolution
/EFI_GLYPH_HEIGHT
;
444 Private
->ModeData
[MaxMode
].GopWidth
= HorizontalResolution
;
445 Private
->ModeData
[MaxMode
].GopHeight
= VerticalResolution
;
446 Private
->ModeData
[MaxMode
].GopModeNumber
= ModeNumber
;
447 Private
->ModeData
[MaxMode
].DeltaX
= (HorizontalResolution
% EFI_GLYPH_WIDTH
) >> 1;
448 Private
->ModeData
[MaxMode
].DeltaY
= (VerticalResolution
% EFI_GLYPH_HEIGHT
) >> 1;
453 // Update the maximum number of modes
455 Private
->SimpleTextOutputMode
.MaxMode
= (INT32
) MaxMode
;
458 // Determine the number of text modes that this protocol can support
460 Status
= GraphicsConsoleConOutSetMode (&Private
->SimpleTextOutput
, 0);
461 if (EFI_ERROR (Status
)) {
466 GraphicsConsoleConOutOutputString (&Private
->SimpleTextOutput
, (CHAR16
*)L
"Graphics Console Started\n\r");
470 // Install protocol interfaces for the Graphics Console device.
472 Status
= gBS
->InstallMultipleProtocolInterfaces (
474 &gEfiSimpleTextOutProtocolGuid
,
475 &Private
->SimpleTextOutput
,
480 if (EFI_ERROR (Status
)) {
482 // Close the GOP and UGA Draw Protocol
484 if (Private
->GraphicsOutput
!= NULL
) {
487 &gEfiGraphicsOutputProtocolGuid
,
488 This
->DriverBindingHandle
,
491 } else if (FeaturePcdGet (PcdUgaConsumeSupport
)) {
494 &gEfiUgaDrawProtocolGuid
,
495 This
->DriverBindingHandle
,
500 if (Private
->LineBuffer
!= NULL
) {
501 FreePool (Private
->LineBuffer
);
514 Stop this driver on Controller by removing Simple Text Out protocol
515 and closing the Graphics Output Protocol or UGA Draw protocol on Controller.
516 (UGA Draw protocol could be skipped if PcdUgaConsumeSupport is set to FALSE.)
519 @param This Protocol instance pointer.
520 @param Controller Handle of device to stop driver on
521 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
522 children is zero stop the entire bus driver.
523 @param ChildHandleBuffer List of Child Handles to Stop.
525 @retval EFI_SUCCESS This driver is removed Controller.
526 @retval EFI_NOT_STARTED Simple Text Out protocol could not be found the
528 @retval other This driver was not removed from this device.
533 GraphicsConsoleControllerDriverStop (
534 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
535 IN EFI_HANDLE Controller
,
536 IN UINTN NumberOfChildren
,
537 IN EFI_HANDLE
*ChildHandleBuffer
541 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*SimpleTextOutput
;
542 GRAPHICS_CONSOLE_DEV
*Private
;
544 Status
= gBS
->OpenProtocol (
546 &gEfiSimpleTextOutProtocolGuid
,
547 (VOID
**) &SimpleTextOutput
,
548 This
->DriverBindingHandle
,
550 EFI_OPEN_PROTOCOL_GET_PROTOCOL
552 if (EFI_ERROR (Status
)) {
553 return EFI_NOT_STARTED
;
556 Private
= GRAPHICS_CONSOLE_CON_OUT_DEV_FROM_THIS (SimpleTextOutput
);
558 Status
= gBS
->UninstallProtocolInterface (
560 &gEfiSimpleTextOutProtocolGuid
,
561 &Private
->SimpleTextOutput
564 if (!EFI_ERROR (Status
)) {
566 // Close the GOP or UGA IO Protocol
568 if (Private
->GraphicsOutput
!= NULL
) {
571 &gEfiGraphicsOutputProtocolGuid
,
572 This
->DriverBindingHandle
,
575 } else if (FeaturePcdGet (PcdUgaConsumeSupport
)) {
578 &gEfiUgaDrawProtocolGuid
,
579 This
->DriverBindingHandle
,
584 if (Private
->LineBuffer
!= NULL
) {
585 FreePool (Private
->LineBuffer
);
589 // Free our instance data
598 Check if the current specific mode supported the user defined resolution
599 for the Graphics Console device based on Graphics Output Protocol.
601 If yes, set the graphic devcice's current mode to this specific mode.
603 @param GraphicsOutput Graphics Output Protocol instance pointer.
604 @param HorizontalResolution User defined horizontal resolution
605 @param VerticalResolution User defined vertical resolution.
606 @param CurrentModeNumber Current specific mode to be check.
608 @retval EFI_SUCCESS The mode is supported.
609 @retval EFI_UNSUPPORTED The specific mode is out of range of graphics
611 @retval other The specific mode does not support user defined
612 resolution or failed to set the current mode to the
613 specific mode on graphics device.
618 EFI_GRAPHICS_OUTPUT_PROTOCOL
*GraphicsOutput
,
619 IN UINT32 HorizontalResolution
,
620 IN UINT32 VerticalResolution
,
621 OUT UINT32
*CurrentModeNumber
627 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
*Info
;
630 Status
= EFI_SUCCESS
;
631 MaxMode
= GraphicsOutput
->Mode
->MaxMode
;
633 for (ModeNumber
= 0; ModeNumber
< MaxMode
; ModeNumber
++) {
634 Status
= GraphicsOutput
->QueryMode (
640 if (!EFI_ERROR (Status
)) {
641 if ((Info
->HorizontalResolution
== HorizontalResolution
) &&
642 (Info
->VerticalResolution
== VerticalResolution
)) {
643 Status
= GraphicsOutput
->SetMode (GraphicsOutput
, ModeNumber
);
644 if (!EFI_ERROR (Status
)) {
653 if (ModeNumber
== GraphicsOutput
->Mode
->MaxMode
) {
654 Status
= EFI_UNSUPPORTED
;
657 *CurrentModeNumber
= ModeNumber
;
663 Locate HII Database protocol and HII Font protocol.
665 @retval EFI_SUCCESS HII Database protocol and HII Font protocol
666 are located successfully.
667 @return other Failed to locate HII Database protocol or
672 EfiLocateHiiProtocol (
681 // There should only be one - so buffer size is this
683 Size
= sizeof (EFI_HANDLE
);
685 Status
= gBS
->LocateHandle (
687 &gEfiHiiDatabaseProtocolGuid
,
693 if (EFI_ERROR (Status
)) {
697 Status
= gBS
->HandleProtocol (
699 &gEfiHiiDatabaseProtocolGuid
,
700 (VOID
**) &mHiiDatabase
703 if (EFI_ERROR (Status
)) {
707 Status
= gBS
->HandleProtocol (
709 &gEfiHiiFontProtocolGuid
,
716 // Body of the STO functions
720 Reset the text output device hardware and optionally run diagnostics.
722 Implements SIMPLE_TEXT_OUTPUT.Reset().
723 If ExtendeVerification is TRUE, then perform dependent Graphics Console
724 device reset, and set display mode to mode 0.
725 If ExtendedVerification is FALSE, only set display mode to mode 0.
727 @param This Protocol instance pointer.
728 @param ExtendedVerification Indicates that the driver may perform a more
729 exhaustive verification operation of the device
732 @retval EFI_SUCCESS The text output device was reset.
733 @retval EFI_DEVICE_ERROR The text output device is not functioning correctly and
739 GraphicsConsoleConOutReset (
740 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
741 IN BOOLEAN ExtendedVerification
744 This
->SetAttribute (This
, EFI_TEXT_ATTR (This
->Mode
->Attribute
& 0x0F, EFI_BACKGROUND_BLACK
));
745 return This
->SetMode (This
, 0);
750 Write a Unicode string to the output device.
752 Implements SIMPLE_TEXT_OUTPUT.OutputString().
753 The Unicode string will be converted to Glyphs and will be
754 sent to the Graphics Console.
756 @param This Protocol instance pointer.
757 @param WString The NULL-terminated Unicode string to be displayed
758 on the output device(s). All output devices must
759 also support the Unicode drawing defined in this file.
761 @retval EFI_SUCCESS The string was output to the device.
762 @retval EFI_DEVICE_ERROR The device reported an error while attempting to output
764 @retval EFI_UNSUPPORTED The output device's mode is not currently in a
766 @retval EFI_WARN_UNKNOWN_GLYPH This warning code indicates that some of the
767 characters in the Unicode string could not be
768 rendered and were skipped.
773 GraphicsConsoleConOutOutputString (
774 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
778 GRAPHICS_CONSOLE_DEV
*Private
;
779 EFI_GRAPHICS_OUTPUT_PROTOCOL
*GraphicsOutput
;
780 EFI_UGA_DRAW_PROTOCOL
*UgaDraw
;
789 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground
;
790 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background
;
795 INT32 OriginAttribute
;
798 Status
= EFI_SUCCESS
;
800 OldTpl
= gBS
->RaiseTPL (TPL_NOTIFY
);
804 Mode
= This
->Mode
->Mode
;
805 Private
= GRAPHICS_CONSOLE_CON_OUT_DEV_FROM_THIS (This
);
806 GraphicsOutput
= Private
->GraphicsOutput
;
807 UgaDraw
= Private
->UgaDraw
;
809 MaxColumn
= Private
->ModeData
[Mode
].Columns
;
810 MaxRow
= Private
->ModeData
[Mode
].Rows
;
811 DeltaX
= Private
->ModeData
[Mode
].DeltaX
;
812 DeltaY
= Private
->ModeData
[Mode
].DeltaY
;
813 Width
= MaxColumn
* EFI_GLYPH_WIDTH
;
814 Height
= (MaxRow
- 1) * EFI_GLYPH_HEIGHT
;
815 Delta
= Width
* sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
);
818 // The Attributes won't change when during the time OutputString is called
820 GetTextColors (This
, &Foreground
, &Background
);
829 OriginAttribute
= This
->Mode
->Attribute
;
831 while (*WString
!= L
'\0') {
833 if (*WString
== CHAR_BACKSPACE
) {
835 // If the cursor is at the left edge of the display, then move the cursor
838 if (This
->Mode
->CursorColumn
== 0 && This
->Mode
->CursorRow
> 0) {
839 This
->Mode
->CursorRow
--;
840 This
->Mode
->CursorColumn
= (INT32
) (MaxColumn
- 1);
841 This
->OutputString (This
, SpaceStr
);
843 This
->Mode
->CursorRow
--;
844 This
->Mode
->CursorColumn
= (INT32
) (MaxColumn
- 1);
845 } else if (This
->Mode
->CursorColumn
> 0) {
847 // If the cursor is not at the left edge of the display, then move the cursor
850 This
->Mode
->CursorColumn
--;
851 This
->OutputString (This
, SpaceStr
);
853 This
->Mode
->CursorColumn
--;
858 } else if (*WString
== CHAR_LINEFEED
) {
860 // If the cursor is at the bottom of the display, then scroll the display one
861 // row, and do not update the cursor position. Otherwise, move the cursor
864 if (This
->Mode
->CursorRow
== (INT32
) (MaxRow
- 1)) {
865 if (GraphicsOutput
!= NULL
) {
867 // Scroll Screen Up One Row
869 GraphicsOutput
->Blt (
874 DeltaY
+ EFI_GLYPH_HEIGHT
,
883 // Print Blank Line at last line
885 GraphicsOutput
->Blt (
897 } else if (FeaturePcdGet (PcdUgaConsumeSupport
)) {
899 // Scroll Screen Up One Row
906 DeltaY
+ EFI_GLYPH_HEIGHT
,
915 // Print Blank Line at last line
919 (EFI_UGA_PIXEL
*) (UINTN
) &Background
,
931 This
->Mode
->CursorRow
++;
936 } else if (*WString
== CHAR_CARRIAGE_RETURN
) {
938 // Move the cursor to the beginning of the current row.
940 This
->Mode
->CursorColumn
= 0;
943 } else if (*WString
== WIDE_CHAR
) {
945 This
->Mode
->Attribute
|= EFI_WIDE_ATTRIBUTE
;
948 } else if (*WString
== NARROW_CHAR
) {
950 This
->Mode
->Attribute
&= (~ (UINT32
) EFI_WIDE_ATTRIBUTE
);
955 // Print the character at the current cursor position and move the cursor
956 // right one column. If this moves the cursor past the right edge of the
957 // display, then the line should wrap to the beginning of the next line. This
958 // is equivalent to inserting a CR and an LF. Note that if the cursor is at the
959 // bottom of the display, and the line wraps, then the display will be scrolled
961 // If wide char is going to be displayed, need to display one character at a time
962 // Or, need to know the display length of a certain string.
964 // Index is used to determine how many character width units (wide = 2, narrow = 1)
965 // Count is used to determine how many characters are used regardless of their attributes
967 for (Count
= 0, Index
= 0; (This
->Mode
->CursorColumn
+ Index
) < MaxColumn
; Count
++, Index
++) {
968 if (WString
[Count
] == CHAR_NULL
||
969 WString
[Count
] == CHAR_BACKSPACE
||
970 WString
[Count
] == CHAR_LINEFEED
||
971 WString
[Count
] == CHAR_CARRIAGE_RETURN
||
972 WString
[Count
] == WIDE_CHAR
||
973 WString
[Count
] == NARROW_CHAR
) {
977 // Is the wide attribute on?
979 if ((This
->Mode
->Attribute
& EFI_WIDE_ATTRIBUTE
) != 0) {
981 // If wide, add one more width unit than normal since we are going to increment at the end of the for loop
985 // This is the end-case where if we are at column 79 and about to print a wide character
986 // We should prevent this from happening because we will wrap inappropriately. We should
987 // not print this character until the next line.
989 if ((This
->Mode
->CursorColumn
+ Index
+ 1) > MaxColumn
) {
996 Status
= DrawUnicodeWeightAtCursorN (This
, WString
, Count
);
997 if (EFI_ERROR (Status
)) {
1001 // At the end of line, output carriage return and line feed
1004 This
->Mode
->CursorColumn
+= (INT32
) Index
;
1005 if (This
->Mode
->CursorColumn
> (INT32
) MaxColumn
) {
1006 This
->Mode
->CursorColumn
-= 2;
1007 This
->OutputString (This
, SpaceStr
);
1010 if (This
->Mode
->CursorColumn
>= (INT32
) MaxColumn
) {
1012 This
->OutputString (This
, mCrLfString
);
1018 This
->Mode
->Attribute
= OriginAttribute
;
1023 Status
= EFI_WARN_UNKNOWN_GLYPH
;
1026 gBS
->RestoreTPL (OldTpl
);
1032 Verifies that all characters in a Unicode string can be output to the
1035 Implements SIMPLE_TEXT_OUTPUT.TestString().
1036 If one of the characters in the *Wstring is neither valid valid Unicode
1037 drawing characters, not ASCII code, then this function will return
1040 @param This Protocol instance pointer.
1041 @param WString The NULL-terminated Unicode string to be examined for the output
1044 @retval EFI_SUCCESS The device(s) are capable of rendering the output string.
1045 @retval EFI_UNSUPPORTED Some of the characters in the Unicode string cannot be
1046 rendered by one or more of the output devices mapped
1052 GraphicsConsoleConOutTestString (
1053 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
1060 EFI_IMAGE_OUTPUT
*Blt
;
1065 while (WString
[Count
] != 0) {
1066 Status
= mHiiFont
->GetGlyph (
1079 if (EFI_ERROR (Status
)) {
1080 return EFI_UNSUPPORTED
;
1089 Returns information for an available text mode that the output device(s)
1092 Implements SIMPLE_TEXT_OUTPUT.QueryMode().
1093 It returnes information for an available text mode that the Graphics Console supports.
1094 In this driver,we only support text mode 80x25, which is defined as mode 0.
1096 @param This Protocol instance pointer.
1097 @param ModeNumber The mode number to return information on.
1098 @param Columns The returned columns of the requested mode.
1099 @param Rows The returned rows of the requested mode.
1101 @retval EFI_SUCCESS The requested mode information is returned.
1102 @retval EFI_UNSUPPORTED The mode number is not valid.
1107 GraphicsConsoleConOutQueryMode (
1108 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
1109 IN UINTN ModeNumber
,
1114 GRAPHICS_CONSOLE_DEV
*Private
;
1118 if (ModeNumber
>= (UINTN
) This
->Mode
->MaxMode
) {
1119 return EFI_UNSUPPORTED
;
1122 OldTpl
= gBS
->RaiseTPL (TPL_NOTIFY
);
1123 Status
= EFI_SUCCESS
;
1125 Private
= GRAPHICS_CONSOLE_CON_OUT_DEV_FROM_THIS (This
);
1127 *Columns
= Private
->ModeData
[ModeNumber
].Columns
;
1128 *Rows
= Private
->ModeData
[ModeNumber
].Rows
;
1130 if (*Columns
<= 0 && *Rows
<= 0) {
1131 Status
= EFI_UNSUPPORTED
;
1137 gBS
->RestoreTPL (OldTpl
);
1143 Sets the output device(s) to a specified mode.
1145 Implements SIMPLE_TEXT_OUTPUT.SetMode().
1146 Set the Graphics Console to a specified mode. In this driver, we only support mode 0.
1148 @param This Protocol instance pointer.
1149 @param ModeNumber The text mode to set.
1151 @retval EFI_SUCCESS The requested text mode is set.
1152 @retval EFI_DEVICE_ERROR The requested text mode cannot be set because of
1153 Graphics Console device error.
1154 @retval EFI_UNSUPPORTED The text mode number is not valid.
1159 GraphicsConsoleConOutSetMode (
1160 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
1165 GRAPHICS_CONSOLE_DEV
*Private
;
1166 GRAPHICS_CONSOLE_MODE_DATA
*ModeData
;
1167 EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*NewLineBuffer
;
1168 UINT32 HorizontalResolution
;
1169 UINT32 VerticalResolution
;
1170 EFI_GRAPHICS_OUTPUT_PROTOCOL
*GraphicsOutput
;
1171 EFI_UGA_DRAW_PROTOCOL
*UgaDraw
;
1176 OldTpl
= gBS
->RaiseTPL (TPL_NOTIFY
);
1178 Private
= GRAPHICS_CONSOLE_CON_OUT_DEV_FROM_THIS (This
);
1179 GraphicsOutput
= Private
->GraphicsOutput
;
1180 UgaDraw
= Private
->UgaDraw
;
1181 ModeData
= &(Private
->ModeData
[ModeNumber
]);
1183 if (ModeData
->Columns
<= 0 && ModeData
->Rows
<= 0) {
1184 Status
= EFI_UNSUPPORTED
;
1189 // Make sure the requested mode number is supported
1191 if (ModeNumber
>= (UINTN
) This
->Mode
->MaxMode
) {
1192 Status
= EFI_UNSUPPORTED
;
1196 if (ModeData
->Columns
<= 0 && ModeData
->Rows
<= 0) {
1197 Status
= EFI_UNSUPPORTED
;
1201 // Attempt to allocate a line buffer for the requested mode number
1203 NewLineBuffer
= AllocatePool (sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
) * ModeData
->Columns
* EFI_GLYPH_WIDTH
* EFI_GLYPH_HEIGHT
);
1205 if (NewLineBuffer
== NULL
) {
1207 // The new line buffer could not be allocated, so return an error.
1208 // No changes to the state of the current console have been made, so the current console is still valid
1210 Status
= EFI_OUT_OF_RESOURCES
;
1214 // If the mode has been set at least one other time, then LineBuffer will not be NULL
1216 if (Private
->LineBuffer
!= NULL
) {
1218 // Clear the current text window on the current graphics console
1220 This
->ClearScreen (This
);
1223 // If the new mode is the same as the old mode, then just return EFI_SUCCESS
1225 if ((INT32
) ModeNumber
== This
->Mode
->Mode
) {
1226 FreePool (NewLineBuffer
);
1227 Status
= EFI_SUCCESS
;
1231 // Otherwise, the size of the text console and/or the GOP/UGA mode will be changed,
1232 // so erase the cursor, and free the LineBuffer for the current mode
1236 FreePool (Private
->LineBuffer
);
1239 // Assign the current line buffer to the newly allocated line buffer
1241 Private
->LineBuffer
= NewLineBuffer
;
1243 if (GraphicsOutput
!= NULL
) {
1244 if (ModeData
->GopModeNumber
!= GraphicsOutput
->Mode
->Mode
) {
1246 // Either no graphics mode is currently set, or it is set to the wrong resolution, so set the new graphics mode
1248 Status
= GraphicsOutput
->SetMode (GraphicsOutput
, ModeData
->GopModeNumber
);
1249 if (EFI_ERROR (Status
)) {
1251 // The mode set operation failed
1257 // The current graphics mode is correct, so simply clear the entire display
1259 Status
= GraphicsOutput
->Blt (
1261 &mGraphicsEfiColors
[0],
1268 ModeData
->GopHeight
,
1272 } else if (FeaturePcdGet (PcdUgaConsumeSupport
)) {
1274 // Get the current UGA Draw mode information
1276 Status
= UgaDraw
->GetMode (
1278 &HorizontalResolution
,
1279 &VerticalResolution
,
1283 if (EFI_ERROR (Status
) || HorizontalResolution
!= ModeData
->GopWidth
|| VerticalResolution
!= ModeData
->GopHeight
) {
1285 // Either no graphics mode is currently set, or it is set to the wrong resolution, so set the new graphics mode
1287 Status
= UgaDraw
->SetMode (
1290 ModeData
->GopHeight
,
1294 if (EFI_ERROR (Status
)) {
1296 // The mode set operation failed
1302 // The current graphics mode is correct, so simply clear the entire display
1304 Status
= UgaDraw
->Blt (
1306 (EFI_UGA_PIXEL
*) (UINTN
) &mGraphicsEfiColors
[0],
1313 ModeData
->GopHeight
,
1320 // The new mode is valid, so commit the mode change
1322 This
->Mode
->Mode
= (INT32
) ModeNumber
;
1325 // Move the text cursor to the upper left hand corner of the display and enable it
1327 This
->SetCursorPosition (This
, 0, 0);
1329 Status
= EFI_SUCCESS
;
1332 gBS
->RestoreTPL (OldTpl
);
1338 Sets the background and foreground colors for the OutputString () and
1339 ClearScreen () functions.
1341 Implements SIMPLE_TEXT_OUTPUT.SetAttribute().
1343 @param This Protocol instance pointer.
1344 @param Attribute The attribute to set. Bits 0..3 are the foreground
1345 color, and bits 4..6 are the background color.
1346 All other bits are undefined and must be zero.
1348 @retval EFI_SUCCESS The requested attribute is set.
1349 @retval EFI_DEVICE_ERROR The requested attribute cannot be set due to Graphics Console port error.
1350 @retval EFI_UNSUPPORTED The attribute requested is not defined.
1355 GraphicsConsoleConOutSetAttribute (
1356 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
1362 if ((Attribute
| 0xFF) != 0xFF) {
1363 return EFI_UNSUPPORTED
;
1366 if ((INT32
) Attribute
== This
->Mode
->Attribute
) {
1370 OldTpl
= gBS
->RaiseTPL (TPL_NOTIFY
);
1374 This
->Mode
->Attribute
= (INT32
) Attribute
;
1378 gBS
->RestoreTPL (OldTpl
);
1385 Clears the output device(s) display to the currently selected background
1388 Implements SIMPLE_TEXT_OUTPUT.ClearScreen().
1390 @param This Protocol instance pointer.
1392 @retval EFI_SUCCESS The operation completed successfully.
1393 @retval EFI_DEVICE_ERROR The device had an error and could not complete the request.
1394 @retval EFI_UNSUPPORTED The output device is not in a valid text mode.
1399 GraphicsConsoleConOutClearScreen (
1400 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
1404 GRAPHICS_CONSOLE_DEV
*Private
;
1405 GRAPHICS_CONSOLE_MODE_DATA
*ModeData
;
1406 EFI_GRAPHICS_OUTPUT_PROTOCOL
*GraphicsOutput
;
1407 EFI_UGA_DRAW_PROTOCOL
*UgaDraw
;
1408 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground
;
1409 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background
;
1412 OldTpl
= gBS
->RaiseTPL (TPL_NOTIFY
);
1414 Private
= GRAPHICS_CONSOLE_CON_OUT_DEV_FROM_THIS (This
);
1415 GraphicsOutput
= Private
->GraphicsOutput
;
1416 UgaDraw
= Private
->UgaDraw
;
1417 ModeData
= &(Private
->ModeData
[This
->Mode
->Mode
]);
1419 GetTextColors (This
, &Foreground
, &Background
);
1420 if (GraphicsOutput
!= NULL
) {
1421 Status
= GraphicsOutput
->Blt (
1430 ModeData
->GopHeight
,
1433 } else if (FeaturePcdGet (PcdUgaConsumeSupport
)) {
1434 Status
= UgaDraw
->Blt (
1436 (EFI_UGA_PIXEL
*) (UINTN
) &Background
,
1443 ModeData
->GopHeight
,
1447 Status
= EFI_UNSUPPORTED
;
1450 This
->Mode
->CursorColumn
= 0;
1451 This
->Mode
->CursorRow
= 0;
1455 gBS
->RestoreTPL (OldTpl
);
1462 Sets the current coordinates of the cursor position.
1464 Implements SIMPLE_TEXT_OUTPUT.SetCursorPosition().
1466 @param This Protocol instance pointer.
1467 @param Column The position to set the cursor to. Must be greater than or
1468 equal to zero and less than the number of columns and rows
1470 @param Row The position to set the cursor to. Must be greater than or
1471 equal to zero and less than the number of columns and rows
1474 @retval EFI_SUCCESS The operation completed successfully.
1475 @retval EFI_DEVICE_ERROR The device had an error and could not complete the request.
1476 @retval EFI_UNSUPPORTED The output device is not in a valid text mode, or the
1477 cursor position is invalid for the current mode.
1482 GraphicsConsoleConOutSetCursorPosition (
1483 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
1488 GRAPHICS_CONSOLE_DEV
*Private
;
1489 GRAPHICS_CONSOLE_MODE_DATA
*ModeData
;
1493 Status
= EFI_SUCCESS
;
1495 OldTpl
= gBS
->RaiseTPL (TPL_NOTIFY
);
1497 Private
= GRAPHICS_CONSOLE_CON_OUT_DEV_FROM_THIS (This
);
1498 ModeData
= &(Private
->ModeData
[This
->Mode
->Mode
]);
1500 if ((Column
>= ModeData
->Columns
) || (Row
>= ModeData
->Rows
)) {
1501 Status
= EFI_UNSUPPORTED
;
1505 if ((This
->Mode
->CursorColumn
== (INT32
) Column
) && (This
->Mode
->CursorRow
== (INT32
) Row
)) {
1506 Status
= EFI_SUCCESS
;
1512 This
->Mode
->CursorColumn
= (INT32
) Column
;
1513 This
->Mode
->CursorRow
= (INT32
) Row
;
1518 gBS
->RestoreTPL (OldTpl
);
1525 Makes the cursor visible or invisible.
1527 Implements SIMPLE_TEXT_OUTPUT.EnableCursor().
1529 @param This Protocol instance pointer.
1530 @param Visible If TRUE, the cursor is set to be visible, If FALSE,
1531 the cursor is set to be invisible.
1533 @retval EFI_SUCCESS The operation completed successfully.
1538 GraphicsConsoleConOutEnableCursor (
1539 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
1545 OldTpl
= gBS
->RaiseTPL (TPL_NOTIFY
);
1549 This
->Mode
->CursorVisible
= Visible
;
1553 gBS
->RestoreTPL (OldTpl
);
1558 Gets Graphics Console devcie's foreground color and background color.
1560 @param This Protocol instance pointer.
1561 @param Foreground Returned text foreground color.
1562 @param Background Returned text background color.
1564 @retval EFI_SUCCESS It returned always.
1569 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
1570 OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*Foreground
,
1571 OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*Background
1576 Attribute
= This
->Mode
->Attribute
& 0x7F;
1578 *Foreground
= mGraphicsEfiColors
[Attribute
& 0x0f];
1579 *Background
= mGraphicsEfiColors
[Attribute
>> 4];
1585 Draw Unicode string on the Graphics Console device's screen.
1587 @param This Protocol instance pointer.
1588 @param UnicodeWeight One Unicode string to be displayed.
1589 @param Count The count of Unicode string.
1591 @retval EFI_OUT_OF_RESOURCES If no memory resource to use.
1592 @retval EFI_UNSUPPORTED If no Graphics Output protocol and UGA Draw
1594 @retval EFI_SUCCESS Drawing Unicode string implemented successfully.
1598 DrawUnicodeWeightAtCursorN (
1599 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
,
1600 IN CHAR16
*UnicodeWeight
,
1605 GRAPHICS_CONSOLE_DEV
*Private
;
1606 EFI_IMAGE_OUTPUT
*Blt
;
1608 EFI_FONT_DISPLAY_INFO
*FontInfo
;
1609 EFI_UGA_DRAW_PROTOCOL
*UgaDraw
;
1610 EFI_HII_ROW_INFO
*RowInfoArray
;
1611 UINTN RowInfoArraySize
;
1613 Private
= GRAPHICS_CONSOLE_CON_OUT_DEV_FROM_THIS (This
);
1614 Blt
= (EFI_IMAGE_OUTPUT
*) AllocateZeroPool (sizeof (EFI_IMAGE_OUTPUT
));
1616 return EFI_OUT_OF_RESOURCES
;
1619 Blt
->Width
= (UINT16
) (Private
->ModeData
[This
->Mode
->Mode
].GopWidth
);
1620 Blt
->Height
= (UINT16
) (Private
->ModeData
[This
->Mode
->Mode
].GopHeight
);
1622 String
= AllocateCopyPool ((Count
+ 1) * sizeof (CHAR16
), UnicodeWeight
);
1623 if (String
== NULL
) {
1625 return EFI_OUT_OF_RESOURCES
;
1628 // Set the end character
1630 *(String
+ Count
) = L
'\0';
1632 FontInfo
= (EFI_FONT_DISPLAY_INFO
*) AllocateZeroPool (sizeof (EFI_FONT_DISPLAY_INFO
));
1633 if (FontInfo
== NULL
) {
1636 return EFI_OUT_OF_RESOURCES
;
1639 // Get current foreground and background colors.
1641 GetTextColors (This
, &FontInfo
->ForegroundColor
, &FontInfo
->BackgroundColor
);
1643 if (Private
->GraphicsOutput
!= NULL
) {
1645 // If Graphics Output protocol exists, using HII Font protocol to draw.
1647 Blt
->Image
.Screen
= Private
->GraphicsOutput
;
1649 Status
= mHiiFont
->StringToImage (
1651 EFI_HII_IGNORE_IF_NO_GLYPH
| EFI_HII_DIRECT_TO_SCREEN
| EFI_HII_IGNORE_LINE_BREAK
,
1655 This
->Mode
->CursorColumn
* EFI_GLYPH_WIDTH
+ Private
->ModeData
[This
->Mode
->Mode
].DeltaX
,
1656 This
->Mode
->CursorRow
* EFI_GLYPH_HEIGHT
+ Private
->ModeData
[This
->Mode
->Mode
].DeltaY
,
1662 } else if (FeaturePcdGet (PcdUgaConsumeSupport
)) {
1664 // If Graphics Output protocol cannot be found and PcdUgaConsumeSupport enabled,
1665 // using UGA Draw protocol to draw.
1667 ASSERT (Private
->UgaDraw
!= NULL
);
1669 UgaDraw
= Private
->UgaDraw
;
1671 Blt
->Image
.Bitmap
= AllocateZeroPool (Blt
->Width
* Blt
->Height
* sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
));
1672 if (Blt
->Image
.Bitmap
== NULL
) {
1675 return EFI_OUT_OF_RESOURCES
;
1678 RowInfoArray
= NULL
;
1680 // StringToImage only support blt'ing image to device using GOP protocol. If GOP is not supported in this platform,
1681 // we ask StringToImage to print the string to blt buffer, then blt to device using UgaDraw.
1683 Status
= mHiiFont
->StringToImage (
1685 EFI_HII_IGNORE_IF_NO_GLYPH
| EFI_HII_IGNORE_LINE_BREAK
,
1689 This
->Mode
->CursorColumn
* EFI_GLYPH_WIDTH
+ Private
->ModeData
[This
->Mode
->Mode
].DeltaX
,
1690 This
->Mode
->CursorRow
* EFI_GLYPH_HEIGHT
+ Private
->ModeData
[This
->Mode
->Mode
].DeltaY
,
1696 if (!EFI_ERROR (Status
)) {
1698 // Line breaks are handled by caller of DrawUnicodeWeightAtCursorN, so the updated parameter RowInfoArraySize by StringToImage will
1699 // always be 1 or 0 (if there is no valid Unicode Char can be printed). ASSERT here to make sure.
1701 ASSERT (RowInfoArraySize
<= 1);
1703 Status
= UgaDraw
->Blt (
1705 (EFI_UGA_PIXEL
*) Blt
->Image
.Bitmap
,
1706 EfiUgaBltBufferToVideo
,
1707 This
->Mode
->CursorColumn
* EFI_GLYPH_WIDTH
+ Private
->ModeData
[This
->Mode
->Mode
].DeltaX
,
1708 (This
->Mode
->CursorRow
) * EFI_GLYPH_HEIGHT
+ Private
->ModeData
[This
->Mode
->Mode
].DeltaY
,
1709 This
->Mode
->CursorColumn
* EFI_GLYPH_WIDTH
+ Private
->ModeData
[This
->Mode
->Mode
].DeltaX
,
1710 (This
->Mode
->CursorRow
) * EFI_GLYPH_HEIGHT
+ Private
->ModeData
[This
->Mode
->Mode
].DeltaY
,
1711 RowInfoArray
[0].LineWidth
,
1712 RowInfoArray
[0].LineHeight
,
1713 Blt
->Width
* sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
)
1717 FreePool (RowInfoArray
);
1718 FreePool (Blt
->Image
.Bitmap
);
1720 Status
= EFI_UNSUPPORTED
;
1726 if (String
!= NULL
) {
1729 if (FontInfo
!= NULL
) {
1730 FreePool (FontInfo
);
1736 Erase the cursor on the screen.
1738 @param This Protocol instance pointer.
1740 @retval EFI_SUCCESS The cursor is erased successfully.
1745 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*This
1748 GRAPHICS_CONSOLE_DEV
*Private
;
1749 EFI_SIMPLE_TEXT_OUTPUT_MODE
*CurrentMode
;
1752 EFI_GRAPHICS_OUTPUT_PROTOCOL
*GraphicsOutput
;
1753 EFI_UGA_DRAW_PROTOCOL
*UgaDraw
;
1754 EFI_GRAPHICS_OUTPUT_BLT_PIXEL_UNION Foreground
;
1755 EFI_GRAPHICS_OUTPUT_BLT_PIXEL_UNION Background
;
1756 EFI_GRAPHICS_OUTPUT_BLT_PIXEL_UNION BltChar
[EFI_GLYPH_HEIGHT
][EFI_GLYPH_WIDTH
];
1760 CurrentMode
= This
->Mode
;
1762 if (!CurrentMode
->CursorVisible
) {
1766 Private
= GRAPHICS_CONSOLE_CON_OUT_DEV_FROM_THIS (This
);
1767 GraphicsOutput
= Private
->GraphicsOutput
;
1768 UgaDraw
= Private
->UgaDraw
;
1771 // In this driver, only narrow character was supported.
1774 // Blt a character to the screen
1776 GlyphX
= (CurrentMode
->CursorColumn
* EFI_GLYPH_WIDTH
) + Private
->ModeData
[CurrentMode
->Mode
].DeltaX
;
1777 GlyphY
= (CurrentMode
->CursorRow
* EFI_GLYPH_HEIGHT
) + Private
->ModeData
[CurrentMode
->Mode
].DeltaY
;
1778 if (GraphicsOutput
!= NULL
) {
1779 GraphicsOutput
->Blt (
1781 (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*) BltChar
,
1782 EfiBltVideoToBltBuffer
,
1789 EFI_GLYPH_WIDTH
* sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
)
1791 } else if (FeaturePcdGet (PcdUgaConsumeSupport
)) {
1794 (EFI_UGA_PIXEL
*) (UINTN
) BltChar
,
1795 EfiUgaVideoToBltBuffer
,
1802 EFI_GLYPH_WIDTH
* sizeof (EFI_UGA_PIXEL
)
1806 GetTextColors (This
, &Foreground
.Pixel
, &Background
.Pixel
);
1809 // Convert Monochrome bitmap of the Glyph to BltBuffer structure
1811 for (PosY
= 0; PosY
< EFI_GLYPH_HEIGHT
; PosY
++) {
1812 for (PosX
= 0; PosX
< EFI_GLYPH_WIDTH
; PosX
++) {
1813 if ((mCursorGlyph
.GlyphCol1
[PosY
] & (BIT0
<< PosX
)) != 0) {
1814 BltChar
[PosY
][EFI_GLYPH_WIDTH
- PosX
- 1].Raw
^= Foreground
.Raw
;
1819 if (GraphicsOutput
!= NULL
) {
1820 GraphicsOutput
->Blt (
1822 (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*) BltChar
,
1823 EfiBltBufferToVideo
,
1830 EFI_GLYPH_WIDTH
* sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
)
1832 } else if (FeaturePcdGet (PcdUgaConsumeSupport
)) {
1835 (EFI_UGA_PIXEL
*) (UINTN
) BltChar
,
1836 EfiUgaBltBufferToVideo
,
1843 EFI_GLYPH_WIDTH
* sizeof (EFI_UGA_PIXEL
)
1851 HII Database Protocol notification event handler.
1853 Register font package when HII Database Protocol has been installed.
1855 @param[in] Event Event whose notification function is being invoked.
1856 @param[in] Context Pointer to the notification function's context.
1860 RegisterFontPackage (
1866 EFI_HII_SIMPLE_FONT_PACKAGE_HDR
*SimplifiedFont
;
1867 UINT32 PackageLength
;
1870 EFI_HII_DATABASE_PROTOCOL
*HiiDatabase
;
1873 // Locate HII Database Protocol
1875 Status
= gBS
->LocateProtocol (
1876 &gEfiHiiDatabaseProtocolGuid
,
1878 (VOID
**) &HiiDatabase
1880 ASSERT_EFI_ERROR (Status
);
1883 // Add 4 bytes to the header for entire length for HiiAddPackages use only.
1885 // +--------------------------------+ <-- Package
1887 // | PackageLength(4 bytes) |
1889 // |--------------------------------| <-- SimplifiedFont
1891 // |EFI_HII_SIMPLE_FONT_PACKAGE_HDR |
1893 // |--------------------------------| <-- Location
1895 // | gUsStdNarrowGlyphData |
1897 // +--------------------------------+
1899 PackageLength
= sizeof (EFI_HII_SIMPLE_FONT_PACKAGE_HDR
) + mNarrowFontSize
+ 4;
1900 Package
= AllocateZeroPool (PackageLength
);
1901 ASSERT (Package
!= NULL
);
1903 WriteUnaligned32((UINT32
*) Package
,PackageLength
);
1904 SimplifiedFont
= (EFI_HII_SIMPLE_FONT_PACKAGE_HDR
*) (Package
+ 4);
1905 SimplifiedFont
->Header
.Length
= (UINT32
) (PackageLength
- 4);
1906 SimplifiedFont
->Header
.Type
= EFI_HII_PACKAGE_SIMPLE_FONTS
;
1907 SimplifiedFont
->NumberOfNarrowGlyphs
= (UINT16
) (mNarrowFontSize
/ sizeof (EFI_NARROW_GLYPH
));
1909 Location
= (UINT8
*) (&SimplifiedFont
->NumberOfWideGlyphs
+ 1);
1910 CopyMem (Location
, gUsStdNarrowGlyphData
, mNarrowFontSize
);
1913 // Add this simplified font package to a package list then install it.
1915 mHiiHandle
= HiiAddPackages (
1916 &mFontPackageListGuid
,
1921 ASSERT (mHiiHandle
!= NULL
);
1926 The user Entry Point for module GraphicsConsole. The user code starts with this function.
1928 @param[in] ImageHandle The firmware allocated handle for the EFI image.
1929 @param[in] SystemTable A pointer to the EFI System Table.
1931 @retval EFI_SUCCESS The entry point is executed successfully.
1932 @return other Some error occurs when executing this entry point.
1937 InitializeGraphicsConsole (
1938 IN EFI_HANDLE ImageHandle
,
1939 IN EFI_SYSTEM_TABLE
*SystemTable
1945 // Register notify function on HII Database Protocol to add font package.
1947 EfiCreateProtocolNotifyEvent (
1948 &gEfiHiiDatabaseProtocolGuid
,
1950 RegisterFontPackage
,
1956 // Install driver model protocol(s).
1958 Status
= EfiLibInstallDriverBindingComponentName2 (
1961 &gGraphicsConsoleDriverBinding
,
1963 &gGraphicsConsoleComponentName
,
1964 &gGraphicsConsoleComponentName2
1966 ASSERT_EFI_ERROR (Status
);