2 Mde UEFI library API implemention.
3 Print to StdErr or ConOut defined in EFI_SYSTEM_TABLE
5 Copyright (c) 2007, Intel Corporation<BR>
6 All rights reserved. This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 #include "UefiLibInternal.h"
18 GLOBAL_REMOVE_IF_UNREFERENCED EFI_GRAPHICS_OUTPUT_BLT_PIXEL mEfiColors
[16] = {
19 { 0x00, 0x00, 0x00, 0x00 },
20 { 0x98, 0x00, 0x00, 0x00 },
21 { 0x00, 0x98, 0x00, 0x00 },
22 { 0x98, 0x98, 0x00, 0x00 },
23 { 0x00, 0x00, 0x98, 0x00 },
24 { 0x98, 0x00, 0x98, 0x00 },
25 { 0x00, 0x98, 0x98, 0x00 },
26 { 0x98, 0x98, 0x98, 0x00 },
27 { 0x10, 0x10, 0x10, 0x00 },
28 { 0xff, 0x10, 0x10, 0x00 },
29 { 0x10, 0xff, 0x10, 0x00 },
30 { 0xff, 0xff, 0x10, 0x00 },
31 { 0x10, 0x10, 0xff, 0x00 },
32 { 0xf0, 0x10, 0xff, 0x00 },
33 { 0x10, 0xff, 0xff, 0x00 },
34 { 0xff, 0xff, 0xff, 0x00 }
38 Internal function which prints a formatted Unicode string to the console output device
41 This function prints a formatted Unicode string to the console output device
42 specified by Console and returns the number of Unicode characters that printed
43 to it. If the length of the formatted Unicode string is greater than PcdUefiLibMaxPrintBufferSize,
44 then only the first PcdUefiLibMaxPrintBufferSize characters are sent to Console.
45 If Format is NULL, then ASSERT().
46 If Format is not aligned on a 16-bit boundary, then ASSERT().
48 @param Format Null-terminated Unicode format string.
49 @param Console The output console.
50 @param Marker VA_LIST marker for the variable argument list.
52 @return The number of Unicode characters in the produced
53 output buffer not including the Null-terminator.
57 IN CONST CHAR16
*Format
,
58 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*Console
,
66 ASSERT (Format
!= NULL
);
67 ASSERT (((UINTN
) Format
& BIT0
) == 0);
69 BufferSize
= (PcdGet32 (PcdUefiLibMaxPrintBufferSize
) + 1) * sizeof (CHAR16
);
71 Buffer
= (CHAR16
*) AllocatePool(BufferSize
);
72 ASSERT (Buffer
!= NULL
);
74 Return
= UnicodeVSPrint (Buffer
, BufferSize
, Format
, Marker
);
76 if (Console
!= NULL
&& Return
> 0) {
78 // To be extra safe make sure Console has been initialized
80 Console
->OutputString (Console
, Buffer
);
89 Prints a formatted Unicode string to the console output device specified by
90 ConOut defined in the EFI_SYSTEM_TABLE.
92 This function prints a formatted Unicode string to the console output device
93 specified by ConOut in EFI_SYSTEM_TABLE and returns the number of Unicode
94 characters that printed to ConOut. If the length of the formatted Unicode
95 string is greater than PcdUefiLibMaxPrintBufferSize, then only the first
96 PcdUefiLibMaxPrintBufferSize characters are sent to ConOut.
97 If Format is NULL, then ASSERT().
98 If Format is not aligned on a 16-bit boundary, then ASSERT().
100 @param Format Null-terminated Unicode format string.
101 @param ... Variable argument list whose contents are accessed based
102 on the format string specified by Format.
104 @return Number of Unicode characters printed to ConOut.
110 IN CONST CHAR16
*Format
,
117 VA_START (Marker
, Format
);
119 Return
= InternalPrint (Format
, gST
->ConOut
, Marker
);
127 Prints a formatted Unicode string to the console output device specified by
128 StdErr defined in the EFI_SYSTEM_TABLE.
130 This function prints a formatted Unicode string to the console output device
131 specified by StdErr in EFI_SYSTEM_TABLE and returns the number of Unicode
132 characters that printed to StdErr. If the length of the formatted Unicode
133 string is greater than PcdUefiLibMaxPrintBufferSize, then only the first
134 PcdUefiLibMaxPrintBufferSize characters are sent to StdErr.
135 If Format is NULL, then ASSERT().
136 If Format is not aligned on a 16-bit boundary, then ASSERT().
138 @param Format Null-terminated Unicode format string.
139 @param ... Variable argument list whose contents are accessed based
140 on the format string specified by Format.
142 @return Number of Unicode characters printed to StdErr.
148 IN CONST CHAR16
*Format
,
155 VA_START (Marker
, Format
);
157 Return
= InternalPrint( Format
, gST
->StdErr
, Marker
);
166 Internal function which prints a formatted ASCII string to the console output device
169 This function prints a formatted ASCII string to the console output device
170 specified by Console and returns the number of ASCII characters that printed
171 to it. If the length of the formatted ASCII string is greater than PcdUefiLibMaxPrintBufferSize,
172 then only the first PcdUefiLibMaxPrintBufferSize characters are sent to Console.
174 If Format is NULL, then ASSERT().
176 @param Format Null-terminated ASCII format string.
177 @param Console The output console.
178 @param Marker VA_LIST marker for the variable argument list.
180 @return The number of Unicode characters in the produced
181 output buffer not including the Null-terminator.
186 IN CONST CHAR8
*Format
,
187 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*Console
,
195 ASSERT (Format
!= NULL
);
197 BufferSize
= (PcdGet32 (PcdUefiLibMaxPrintBufferSize
) + 1) * sizeof (CHAR16
);
199 Buffer
= (CHAR16
*) AllocatePool(BufferSize
);
200 ASSERT (Buffer
!= NULL
);
202 Return
= UnicodeVSPrintAsciiFormat (Buffer
, BufferSize
, Format
, Marker
);
204 if (Console
!= NULL
) {
206 // To be extra safe make sure Console has been initialized
208 Console
->OutputString (Console
, Buffer
);
217 Prints a formatted ASCII string to the console output device specified by
218 ConOut defined in the EFI_SYSTEM_TABLE.
220 This function prints a formatted ASCII string to the console output device
221 specified by ConOut in EFI_SYSTEM_TABLE and returns the number of ASCII
222 characters that printed to ConOut. If the length of the formatted ASCII
223 string is greater than PcdUefiLibMaxPrintBufferSize, then only the first
224 PcdUefiLibMaxPrintBufferSize characters are sent to ConOut.
225 If Format is NULL, then ASSERT().
227 @param Format Null-terminated ASCII format string.
228 @param ... Variable argument list whose contents are accessed based
229 on the format string specified by Format.
231 @return Number of ASCII characters printed to ConOut.
237 IN CONST CHAR8
*Format
,
243 ASSERT (Format
!= NULL
);
245 VA_START (Marker
, Format
);
247 Return
= AsciiInternalPrint( Format
, gST
->ConOut
, Marker
);
255 Prints a formatted ASCII string to the console output device specified by
256 StdErr defined in the EFI_SYSTEM_TABLE.
258 This function prints a formatted ASCII string to the console output device
259 specified by StdErr in EFI_SYSTEM_TABLE and returns the number of ASCII
260 characters that printed to StdErr. If the length of the formatted ASCII
261 string is greater than PcdUefiLibMaxPrintBufferSize, then only the first
262 PcdUefiLibMaxPrintBufferSize characters are sent to StdErr.
263 If Format is NULL, then ASSERT().
265 @param Format Null-terminated ASCII format string.
266 @param ... Variable argument list whose contents are accessed based
267 on the format string specified by Format.
269 @return Number of ASCII characters printed to ConErr.
275 IN CONST CHAR8
*Format
,
282 ASSERT (Format
!= NULL
);
284 VA_START (Marker
, Format
);
286 Return
= AsciiInternalPrint( Format
, gST
->StdErr
, Marker
);
294 Internal function to print a formatted Unicode string to a graphics console device specified by
295 ConsoleOutputHandle defined in the EFI_SYSTEM_TABLE at the given (X,Y) coordinates.
297 This function prints a formatted Unicode string to the graphics console device
298 specified by ConsoleOutputHandle in EFI_SYSTEM_TABLE and returns the number of
299 Unicode characters printed. The EFI_HII_FONT_PROTOCOL is used to convert the
300 string to a bitmap using the glyphs registered with the
301 HII database. No wrapping is performed, so any portions of the string the fall
302 outside the active display region will not be displayed.
304 If a graphics console device is not associated with the ConsoleOutputHandle
305 defined in the EFI_SYSTEM_TABLE then no string is printed, and 0 is returned.
306 If the EFI_HII_FONT_PROTOCOL is not present in the handle database, then no
307 string is printed, and 0 is returned.
309 @param X X coordinate to print the string.
310 @param Y Y coordinate to print the string.
311 @param Foreground The forground color of the string being printed. This is
312 an optional parameter that may be NULL. If it is NULL,
313 then the foreground color of the current ConOut device
314 in the EFI_SYSTEM_TABLE is used.
315 @param Background The background color of the string being printed. This is
316 an optional parameter that may be NULL. If it is NULL,
317 then the background color of the current ConOut device
318 in the EFI_SYSTEM_TABLE is used.
319 @param Buffer Null-terminated Unicode formatted string.
320 @param PrintNum The number of Unicode formatted string to be printed.
322 @return Number of Unicode Characters printed. Zero means no any character
323 displayed successfully.
327 InternalPrintGraphic (
330 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*Foreground
,
331 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*Background
,
338 CHAR16
*UnicodeWeight
;
339 UINT32 HorizontalResolution
;
340 UINT32 VerticalResolution
;
344 EFI_HII_FONT_PROTOCOL
*HiiFont
;
345 EFI_IMAGE_OUTPUT
*Blt
;
346 EFI_FONT_DISPLAY_INFO FontInfo
;
347 EFI_HII_ROW_INFO
*RowInfoArray
;
348 UINTN RowInfoArraySize
;
349 EFI_GRAPHICS_OUTPUT_PROTOCOL
*GraphicsOutput
;
350 EFI_UGA_DRAW_PROTOCOL
*UgaDraw
;
351 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*Sto
;
352 EFI_HANDLE ConsoleHandle
;
354 HorizontalResolution
= 0;
355 VerticalResolution
= 0;
358 ConsoleHandle
= gST
->ConsoleOutHandle
;
360 Status
= gBS
->HandleProtocol (
362 &gEfiGraphicsOutputProtocolGuid
,
363 (VOID
**) &GraphicsOutput
367 if (EFI_ERROR (Status
) && FeaturePcdGet (PcdUgaConsumeSupport
)) {
369 // If no GOP available, try to open UGA Draw protocol if supported.
371 GraphicsOutput
= NULL
;
373 Status
= gBS
->HandleProtocol (
375 &gEfiUgaDrawProtocolGuid
,
379 if (EFI_ERROR (Status
)) {
383 Status
= gBS
->HandleProtocol (
385 &gEfiSimpleTextOutProtocolGuid
,
389 if (EFI_ERROR (Status
)) {
393 if (GraphicsOutput
!= NULL
) {
394 HorizontalResolution
= GraphicsOutput
->Mode
->Info
->HorizontalResolution
;
395 VerticalResolution
= GraphicsOutput
->Mode
->Info
->VerticalResolution
;
396 } else if (UgaDraw
!= NULL
) {
397 UgaDraw
->GetMode (UgaDraw
, &HorizontalResolution
, &VerticalResolution
, &ColorDepth
, &RefreshRate
);
399 Status
= EFI_UNSUPPORTED
;
403 ASSERT ((HorizontalResolution
!= 0) && (VerticalResolution
!=0));
405 Status
= gBS
->LocateProtocol (&gEfiHiiFontProtocolGuid
, NULL
, (VOID
**) &HiiFont
);
406 if (EFI_ERROR (Status
)) {
410 UnicodeWeight
= Buffer
;
412 for (Index
= 0; UnicodeWeight
[Index
] != 0; Index
++) {
413 if (UnicodeWeight
[Index
] == CHAR_BACKSPACE
||
414 UnicodeWeight
[Index
] == CHAR_LINEFEED
||
415 UnicodeWeight
[Index
] == CHAR_CARRIAGE_RETURN
) {
416 UnicodeWeight
[Index
] = 0;
420 LineBufferLen
= sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
) * HorizontalResolution
* EFI_GLYPH_HEIGHT
;
421 if (EFI_GLYPH_WIDTH
* EFI_GLYPH_HEIGHT
* sizeof(EFI_GRAPHICS_OUTPUT_BLT_PIXEL
) * PrintNum
> LineBufferLen
) {
422 Status
= EFI_INVALID_PARAMETER
;
426 Blt
= (EFI_IMAGE_OUTPUT
*) AllocateZeroPool (sizeof (EFI_IMAGE_OUTPUT
));
427 ASSERT (Blt
!= NULL
);
429 Blt
->Width
= (UINT16
) (HorizontalResolution
);
430 Blt
->Height
= (UINT16
) (VerticalResolution
);
432 ZeroMem (&FontInfo
, sizeof (EFI_FONT_DISPLAY_INFO
));
434 if (Foreground
!= NULL
) {
435 CopyMem (&FontInfo
.ForegroundColor
, Foreground
, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
));
438 &FontInfo
.ForegroundColor
,
439 &mEfiColors
[Sto
->Mode
->Attribute
& 0x0f],
440 sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
)
443 if (Background
!= NULL
) {
444 CopyMem (&FontInfo
.BackgroundColor
, Background
, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
));
447 &FontInfo
.BackgroundColor
,
448 &mEfiColors
[Sto
->Mode
->Attribute
>> 4],
449 sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
)
453 if (GraphicsOutput
!= NULL
) {
454 Blt
->Image
.Screen
= GraphicsOutput
;
456 Status
= HiiFont
->StringToImage (
458 EFI_HII_IGNORE_IF_NO_GLYPH
| EFI_HII_DIRECT_TO_SCREEN
,
469 } else if (UgaDraw
!= NULL
) {
471 Blt
->Image
.Bitmap
= AllocateZeroPool (Blt
->Width
* Blt
->Height
* sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
));
472 ASSERT (Blt
->Image
.Bitmap
!= NULL
);
476 // StringToImage only support blt'ing image to device using GOP protocol. If GOP is not supported in this platform,
477 // we ask StringToImage to print the string to blt buffer, then blt to device using UgaDraw.
479 Status
= HiiFont
->StringToImage (
481 EFI_HII_IGNORE_IF_NO_GLYPH
,
492 if (!EFI_ERROR (Status
)) {
493 ASSERT (RowInfoArray
!= NULL
);
495 // Line breaks are handled by caller of DrawUnicodeWeightAtCursorN, so the updated parameter RowInfoArraySize by StringToImage will
496 // always be 1 or 0 (if there is no valid Unicode Char can be printed). ASSERT here to make sure.
498 ASSERT (RowInfoArraySize
<= 1);
500 Status
= UgaDraw
->Blt (
502 (EFI_UGA_PIXEL
*) Blt
->Image
.Bitmap
,
503 EfiUgaBltBufferToVideo
,
508 RowInfoArray
[0].LineWidth
,
509 RowInfoArray
[0].LineHeight
,
510 Blt
->Width
* sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL
)
514 FreePool (RowInfoArray
);
515 FreePool (Blt
->Image
.Bitmap
);
518 Status
= EFI_UNSUPPORTED
;
524 if (EFI_ERROR (Status
)) {
532 Prints a formatted Unicode string to a graphics console device specified by
533 ConsoleOutputHandle defined in the EFI_SYSTEM_TABLE at the given (X,Y) coordinates.
535 This function prints a formatted Unicode string to the graphics console device
536 specified by ConsoleOutputHandle in EFI_SYSTEM_TABLE and returns the number of
537 Unicode characters printed. If the length of the formatted Unicode string is
538 greater than PcdUefiLibMaxPrintBufferSize, then only the first
539 PcdUefiLibMaxPrintBufferSize characters are printed. The EFI_HII_FONT_PROTOCOL
540 is used to convert the string to a bitmap using the glyphs registered with the
541 HII database. No wrapping is performed, so any portions of the string the fall
542 outside the active display region will not be displayed.
544 If a graphics console device is not associated with the ConsoleOutputHandle
545 defined in the EFI_SYSTEM_TABLE then no string is printed, and 0 is returned.
546 If the EFI_HII_FONT_PROTOCOL is not present in the handle database, then no
547 string is printed, and 0 is returned.
548 If Format is NULL, then ASSERT().
549 If Format is not aligned on a 16-bit boundary, then ASSERT().
551 @param X X coordinate to print the string.
552 @param Y Y coordinate to print the string.
553 @param ForeGround The forground color of the string being printed. This is
554 an optional parameter that may be NULL. If it is NULL,
555 then the foreground color of the current ConOut device
556 in the EFI_SYSTEM_TABLE is used.
557 @param BackGround The background color of the string being printed. This is
558 an optional parameter that may be NULL. If it is NULL,
559 then the background color of the current ConOut device
560 in the EFI_SYSTEM_TABLE is used.
561 @param Format Null-terminated Unicode format string. See Print Library
562 for the supported format string syntax.
563 @param ... Variable argument list whose contents are accessed based on
564 the format string specified by Format.
566 @return The number of Unicode characters printed.
574 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*ForeGround
, OPTIONAL
575 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*BackGround
, OPTIONAL
576 IN CONST CHAR16
*Format
,
586 ASSERT (Format
!= NULL
);
587 ASSERT (((UINTN
) Format
& BIT0
) == 0);
589 VA_START (Marker
, Format
);
591 BufferSize
= (PcdGet32 (PcdUefiLibMaxPrintBufferSize
) + 1) * sizeof (CHAR16
);
593 Buffer
= (CHAR16
*) AllocatePool (BufferSize
);
594 ASSERT (Buffer
!= NULL
);
596 PrintNum
= UnicodeVSPrint (Buffer
, BufferSize
, Format
, Marker
);
598 ReturnNum
= InternalPrintGraphic (X
, Y
, ForeGround
, BackGround
, Buffer
, PrintNum
);
606 Prints a formatted ASCII string to a graphics console device specified by
607 ConsoleOutputHandle defined in the EFI_SYSTEM_TABLE at the given (X,Y) coordinates.
609 This function prints a formatted ASCII string to the graphics console device
610 specified by ConsoleOutputHandle in EFI_SYSTEM_TABLE and returns the number of
611 ASCII characters printed. If the length of the formatted ASCII string is
612 greater than PcdUefiLibMaxPrintBufferSize, then only the first
613 PcdUefiLibMaxPrintBufferSize characters are printed. The EFI_HII_FONT_PROTOCOL
614 is used to convert the string to a bitmap using the glyphs registered with the
615 HII database. No wrapping is performed, so any portions of the string the fall
616 outside the active display region will not be displayed.
618 If a graphics console device is not associated with the ConsoleOutputHandle
619 defined in the EFI_SYSTEM_TABLE then no string is printed, and 0 is returned.
620 If the EFI_HII_FONT_PROTOCOL is not present in the handle database, then no
621 string is printed, and 0 is returned.
622 If Format is NULL, then ASSERT().
624 @param X X coordinate to print the string.
625 @param Y Y coordinate to print the string.
626 @param ForeGround The forground color of the string being printed. This is
627 an optional parameter that may be NULL. If it is NULL,
628 then the foreground color of the current ConOut device
629 in the EFI_SYSTEM_TABLE is used.
630 @param BackGround The background color of the string being printed. This is
631 an optional parameter that may be NULL. If it is NULL,
632 then the background color of the current ConOut device
633 in the EFI_SYSTEM_TABLE is used.
634 @param Format Null-terminated ASCII format string. See Print Library
635 for the supported format string syntax.
636 @param ... Variable argument list whose contents are accessed based on
637 the format string specified by Format.
639 @return The number of ASCII characters printed.
647 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*ForeGround
, OPTIONAL
648 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL
*BackGround
, OPTIONAL
649 IN CONST CHAR8
*Format
,
659 ASSERT (Format
!= NULL
);
661 VA_START (Marker
, Format
);
663 BufferSize
= (PcdGet32 (PcdUefiLibMaxPrintBufferSize
) + 1) * sizeof (CHAR16
);
665 Buffer
= (CHAR16
*) AllocatePool (BufferSize
);
666 ASSERT (Buffer
!= NULL
);
668 PrintNum
= UnicodeSPrintAsciiFormat (Buffer
, BufferSize
, Format
, Marker
);
670 ReturnNum
= InternalPrintGraphic (X
, Y
, ForeGround
, BackGround
, Buffer
, PrintNum
);