]> git.proxmox.com Git - mirror_edk2.git/blob - IntelFrameworkPkg/Library/FrameworkUefiLib/UefiLibPrint.c
9c80d01a55de78f76422f7dd04e4060eb8206423
[mirror_edk2.git] / IntelFrameworkPkg / Library / FrameworkUefiLib / UefiLibPrint.c
1 /** @file
2 Mde UEFI library API implementation.
3 Print to StdErr or ConOut defined in EFI_SYSTEM_TABLE
4
5 Copyright (c) 2007 - 2009, 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
10
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.
13
14 **/
15
16 #include "UefiLibInternal.h"
17
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 }
35 };
36
37 /**
38 Internal function which prints a formatted Unicode string to the console output device
39 specified by Console
40
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().
47
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.
51
52 @return The number of Unicode characters in the produced
53 output buffer not including the Null-terminator.
54 **/
55 UINTN
56 InternalPrint (
57 IN CONST CHAR16 *Format,
58 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *Console,
59 IN VA_LIST Marker
60 )
61 {
62 UINTN Return;
63 CHAR16 *Buffer;
64 UINTN BufferSize;
65
66 ASSERT (Format != NULL);
67 ASSERT (((UINTN) Format & BIT0) == 0);
68
69 BufferSize = (PcdGet32 (PcdUefiLibMaxPrintBufferSize) + 1) * sizeof (CHAR16);
70
71 Buffer = (CHAR16 *) AllocatePool(BufferSize);
72 ASSERT (Buffer != NULL);
73
74 Return = UnicodeVSPrint (Buffer, BufferSize, Format, Marker);
75
76 if (Console != NULL && Return > 0) {
77 //
78 // To be extra safe make sure Console has been initialized
79 //
80 Console->OutputString (Console, Buffer);
81 }
82
83 FreePool (Buffer);
84
85 return Return;
86 }
87
88 /**
89 Prints a formatted Unicode string to the console output device specified by
90 ConOut defined in the EFI_SYSTEM_TABLE.
91
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().
99
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.
103
104 @return Number of Unicode characters printed to ConOut.
105
106 **/
107 UINTN
108 EFIAPI
109 Print (
110 IN CONST CHAR16 *Format,
111 ...
112 )
113 {
114 VA_LIST Marker;
115 UINTN Return;
116
117 VA_START (Marker, Format);
118
119 Return = InternalPrint (Format, gST->ConOut, Marker);
120
121 VA_END (Marker);
122
123 return Return;
124 }
125
126 /**
127 Prints a formatted Unicode string to the console output device specified by
128 StdErr defined in the EFI_SYSTEM_TABLE.
129
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().
137
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.
141
142 @return Number of Unicode characters printed to StdErr.
143
144 **/
145 UINTN
146 EFIAPI
147 ErrorPrint (
148 IN CONST CHAR16 *Format,
149 ...
150 )
151 {
152 VA_LIST Marker;
153 UINTN Return;
154
155 VA_START (Marker, Format);
156
157 Return = InternalPrint( Format, gST->StdErr, Marker);
158
159 VA_END (Marker);
160
161 return Return;
162 }
163
164
165 /**
166 Internal function which prints a formatted ASCII string to the console output device
167 specified by Console
168
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.
173
174 If Format is NULL, then ASSERT().
175
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.
179
180 @return The number of Unicode characters in the produced
181 output buffer not including the Null-terminator.
182
183 **/
184 UINTN
185 AsciiInternalPrint (
186 IN CONST CHAR8 *Format,
187 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *Console,
188 IN VA_LIST Marker
189 )
190 {
191 UINTN Return;
192 CHAR16 *Buffer;
193 UINTN BufferSize;
194
195 ASSERT (Format != NULL);
196
197 BufferSize = (PcdGet32 (PcdUefiLibMaxPrintBufferSize) + 1) * sizeof (CHAR16);
198
199 Buffer = (CHAR16 *) AllocatePool(BufferSize);
200 ASSERT (Buffer != NULL);
201
202 Return = UnicodeVSPrintAsciiFormat (Buffer, BufferSize, Format, Marker);
203
204 if (Console != NULL) {
205 //
206 // To be extra safe make sure Console has been initialized
207 //
208 Console->OutputString (Console, Buffer);
209 }
210
211 FreePool (Buffer);
212
213 return Return;
214 }
215
216 /**
217 Prints a formatted ASCII string to the console output device specified by
218 ConOut defined in the EFI_SYSTEM_TABLE.
219
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().
226
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.
230
231 @return Number of ASCII characters printed to ConOut.
232
233 **/
234 UINTN
235 EFIAPI
236 AsciiPrint (
237 IN CONST CHAR8 *Format,
238 ...
239 )
240 {
241 VA_LIST Marker;
242 UINTN Return;
243 ASSERT (Format != NULL);
244
245 VA_START (Marker, Format);
246
247 Return = AsciiInternalPrint( Format, gST->ConOut, Marker);
248
249 VA_END (Marker);
250
251 return Return;
252 }
253
254 /**
255 Prints a formatted ASCII string to the console output device specified by
256 StdErr defined in the EFI_SYSTEM_TABLE.
257
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().
264
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.
268
269 @return Number of ASCII characters printed to ConErr.
270
271 **/
272 UINTN
273 EFIAPI
274 AsciiErrorPrint (
275 IN CONST CHAR8 *Format,
276 ...
277 )
278 {
279 VA_LIST Marker;
280 UINTN Return;
281
282 ASSERT (Format != NULL);
283
284 VA_START (Marker, Format);
285
286 Return = AsciiInternalPrint( Format, gST->StdErr, Marker);
287
288 VA_END (Marker);
289
290 return Return;
291 }
292
293 /**
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.
296
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.
303
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.
308
309 @param PointX X coordinate to print the string.
310 @param PointY Y coordinate to print the string.
311 @param Foreground The foreground 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.
321
322 @return Number of Unicode Characters printed. Zero means no any character
323 displayed successfully.
324
325 **/
326 UINTN
327 InternalPrintGraphic (
328 IN UINTN PointX,
329 IN UINTN PointY,
330 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *Foreground,
331 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *Background,
332 IN CHAR16 *Buffer,
333 IN UINTN PrintNum
334 )
335 {
336 EFI_STATUS Status;
337 UINT32 HorizontalResolution;
338 UINT32 VerticalResolution;
339 UINT32 ColorDepth;
340 UINT32 RefreshRate;
341 EFI_HII_FONT_PROTOCOL *HiiFont;
342 EFI_IMAGE_OUTPUT *Blt;
343 EFI_FONT_DISPLAY_INFO FontInfo;
344 EFI_HII_ROW_INFO *RowInfoArray;
345 UINTN RowInfoArraySize;
346 EFI_GRAPHICS_OUTPUT_PROTOCOL *GraphicsOutput;
347 EFI_UGA_DRAW_PROTOCOL *UgaDraw;
348 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *Sto;
349 EFI_HANDLE ConsoleHandle;
350
351 HorizontalResolution = 0;
352 VerticalResolution = 0;
353 Blt = NULL;
354 RowInfoArray = NULL;
355
356 ConsoleHandle = gST->ConsoleOutHandle;
357
358 Status = gBS->HandleProtocol (
359 ConsoleHandle,
360 &gEfiGraphicsOutputProtocolGuid,
361 (VOID **) &GraphicsOutput
362 );
363
364 UgaDraw = NULL;
365 if (EFI_ERROR (Status) && FeaturePcdGet (PcdUgaConsumeSupport)) {
366 //
367 // If no GOP available, try to open UGA Draw protocol if supported.
368 //
369 GraphicsOutput = NULL;
370
371 Status = gBS->HandleProtocol (
372 ConsoleHandle,
373 &gEfiUgaDrawProtocolGuid,
374 (VOID **) &UgaDraw
375 );
376 }
377 if (EFI_ERROR (Status)) {
378 goto Error;
379 }
380
381 Status = gBS->HandleProtocol (
382 ConsoleHandle,
383 &gEfiSimpleTextOutProtocolGuid,
384 (VOID **) &Sto
385 );
386
387 if (EFI_ERROR (Status)) {
388 goto Error;
389 }
390
391 if (GraphicsOutput != NULL) {
392 HorizontalResolution = GraphicsOutput->Mode->Info->HorizontalResolution;
393 VerticalResolution = GraphicsOutput->Mode->Info->VerticalResolution;
394 } else if (UgaDraw != NULL && FeaturePcdGet (PcdUgaConsumeSupport)) {
395 UgaDraw->GetMode (UgaDraw, &HorizontalResolution, &VerticalResolution, &ColorDepth, &RefreshRate);
396 } else {
397 goto Error;
398 }
399
400 ASSERT ((HorizontalResolution != 0) && (VerticalResolution !=0));
401
402 Status = gBS->LocateProtocol (&gEfiHiiFontProtocolGuid, NULL, (VOID **) &HiiFont);
403 if (EFI_ERROR (Status)) {
404 goto Error;
405 }
406
407 Blt = (EFI_IMAGE_OUTPUT *) AllocateZeroPool (sizeof (EFI_IMAGE_OUTPUT));
408 ASSERT (Blt != NULL);
409
410 Blt->Width = (UINT16) (HorizontalResolution);
411 Blt->Height = (UINT16) (VerticalResolution);
412
413 ZeroMem (&FontInfo, sizeof (EFI_FONT_DISPLAY_INFO));
414
415 if (Foreground != NULL) {
416 CopyMem (&FontInfo.ForegroundColor, Foreground, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL));
417 } else {
418 CopyMem (
419 &FontInfo.ForegroundColor,
420 &mEfiColors[Sto->Mode->Attribute & 0x0f],
421 sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL)
422 );
423 }
424 if (Background != NULL) {
425 CopyMem (&FontInfo.BackgroundColor, Background, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL));
426 } else {
427 CopyMem (
428 &FontInfo.BackgroundColor,
429 &mEfiColors[Sto->Mode->Attribute >> 4],
430 sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL)
431 );
432 }
433
434 if (GraphicsOutput != NULL) {
435 Blt->Image.Screen = GraphicsOutput;
436
437 Status = HiiFont->StringToImage (
438 HiiFont,
439 EFI_HII_IGNORE_IF_NO_GLYPH | EFI_HII_OUT_FLAG_CLIP |
440 EFI_HII_OUT_FLAG_CLIP_CLEAN_X | EFI_HII_OUT_FLAG_CLIP_CLEAN_Y |
441 EFI_HII_IGNORE_LINE_BREAK | EFI_HII_DIRECT_TO_SCREEN,
442 Buffer,
443 &FontInfo,
444 &Blt,
445 PointX,
446 PointY,
447 &RowInfoArray,
448 &RowInfoArraySize,
449 NULL
450 );
451 if (EFI_ERROR (Status)) {
452 goto Error;
453 }
454
455 } else if (FeaturePcdGet (PcdUgaConsumeSupport)) {
456 ASSERT (UgaDraw!= NULL);
457
458 Blt->Image.Bitmap = AllocateZeroPool (Blt->Width * Blt->Height * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL));
459 ASSERT (Blt->Image.Bitmap != NULL);
460
461 //
462 // StringToImage only support blt'ing image to device using GOP protocol. If GOP is not supported in this platform,
463 // we ask StringToImage to print the string to blt buffer, then blt to device using UgaDraw.
464 //
465 Status = HiiFont->StringToImage (
466 HiiFont,
467 EFI_HII_IGNORE_IF_NO_GLYPH,
468 Buffer,
469 &FontInfo,
470 &Blt,
471 PointX,
472 PointY,
473 &RowInfoArray,
474 &RowInfoArraySize,
475 NULL
476 );
477
478 if (!EFI_ERROR (Status)) {
479 ASSERT (RowInfoArray != NULL);
480 //
481 // Line breaks are handled by caller of DrawUnicodeWeightAtCursorN, so the updated parameter RowInfoArraySize by StringToImage will
482 // always be 1 or 0 (if there is no valid Unicode Char can be printed). ASSERT here to make sure.
483 //
484 ASSERT (RowInfoArraySize <= 1);
485
486 Status = UgaDraw->Blt (
487 UgaDraw,
488 (EFI_UGA_PIXEL *) Blt->Image.Bitmap,
489 EfiUgaBltBufferToVideo,
490 PointX,
491 PointY,
492 PointX,
493 PointY,
494 RowInfoArray[0].LineWidth,
495 RowInfoArray[0].LineHeight,
496 Blt->Width * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL)
497 );
498 } else {
499 goto Error;
500 }
501 FreePool (Blt->Image.Bitmap);
502 } else {
503 goto Error;
504 }
505 //
506 // Calculate the number of actual printed characters
507 //
508 PrintNum = RowInfoArray[0].EndIndex - RowInfoArray[0].StartIndex + 1;
509
510 FreePool (RowInfoArray);
511 FreePool (Blt);
512 return PrintNum;
513
514 Error:
515 if (Blt != NULL) {
516 FreePool (Blt);
517 }
518 return 0;
519 }
520
521 /**
522 Prints a formatted Unicode string to a graphics console device specified by
523 ConsoleOutputHandle defined in the EFI_SYSTEM_TABLE at the given (X,Y) coordinates.
524
525 This function prints a formatted Unicode string to the graphics console device
526 specified by ConsoleOutputHandle in EFI_SYSTEM_TABLE and returns the number of
527 Unicode characters displayed, not including partial characters that may be clipped
528 by the right edge of the display. If the length of the formatted Unicode string is
529 greater than PcdUefiLibMaxPrintBufferSize, then at most the first
530 PcdUefiLibMaxPrintBufferSize characters are printed.The EFI_HII_FONT_PROTOCOL
531 StringToImage() service is used to convert the string to a bitmap using the glyphs
532 registered with the HII database. No wrapping is performed, so any portions of the
533 string the fall outside the active display region will not be displayed. Please see
534 Section 27.2.6 of the UEFI Specification for a description of the supported string
535 format including the set of control codes supported by the StringToImage() service.
536
537 If a graphics console device is not associated with the ConsoleOutputHandle
538 defined in the EFI_SYSTEM_TABLE then no string is printed, and 0 is returned.
539 If the EFI_HII_FONT_PROTOCOL is not present in the handle database, then no
540 string is printed, and 0 is returned.
541 If Format is NULL, then ASSERT().
542 If Format is not aligned on a 16-bit boundary, then ASSERT().
543
544 @param PointX X coordinate to print the string.
545 @param PointY Y coordinate to print the string.
546 @param ForeGround The foreground color of the string being printed. This is
547 an optional parameter that may be NULL. If it is NULL,
548 then the foreground color of the current ConOut device
549 in the EFI_SYSTEM_TABLE is used.
550 @param BackGround The background color of the string being printed. This is
551 an optional parameter that may be NULL. If it is NULL,
552 then the background color of the current ConOut device
553 in the EFI_SYSTEM_TABLE is used.
554 @param Format Null-terminated Unicode format string. See Print Library
555 for the supported format string syntax.
556 @param ... Variable argument list whose contents are accessed based on
557 the format string specified by Format.
558
559 @return The number of Unicode characters printed.
560
561 **/
562 UINTN
563 EFIAPI
564 PrintXY (
565 IN UINTN PointX,
566 IN UINTN PointY,
567 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *ForeGround, OPTIONAL
568 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BackGround, OPTIONAL
569 IN CONST CHAR16 *Format,
570 ...
571 )
572 {
573 VA_LIST Marker;
574 CHAR16 *Buffer;
575 UINTN BufferSize;
576 UINTN PrintNum;
577 UINTN ReturnNum;
578
579 ASSERT (Format != NULL);
580 ASSERT (((UINTN) Format & BIT0) == 0);
581
582 VA_START (Marker, Format);
583
584 BufferSize = (PcdGet32 (PcdUefiLibMaxPrintBufferSize) + 1) * sizeof (CHAR16);
585
586 Buffer = (CHAR16 *) AllocatePool (BufferSize);
587 ASSERT (Buffer != NULL);
588
589 PrintNum = UnicodeVSPrint (Buffer, BufferSize, Format, Marker);
590
591 ReturnNum = InternalPrintGraphic (PointX, PointY, ForeGround, BackGround, Buffer, PrintNum);
592
593 FreePool (Buffer);
594
595 return ReturnNum;
596 }
597
598 /**
599 Prints a formatted ASCII string to a graphics console device specified by
600 ConsoleOutputHandle defined in the EFI_SYSTEM_TABLE at the given (X,Y) coordinates.
601
602 This function prints a formatted ASCII string to the graphics console device
603 specified by ConsoleOutputHandle in EFI_SYSTEM_TABLE and returns the number of
604 ASCII characters displayed, not including partial characters that may be clipped
605 by the right edge of the display. If the length of the formatted ASCII string is
606 greater than PcdUefiLibMaxPrintBufferSize, then at most the first
607 PcdUefiLibMaxPrintBufferSize characters are printed.The EFI_HII_FONT_PROTOCOL
608 StringToImage() service is used to convert the string to a bitmap using the glyphs
609 registered with the HII database. No wrapping is performed, so any portions of the
610 string the fall outside the active display region will not be displayed. Please see
611 Section 27.2.6 of the UEFI Specification for a description of the supported string
612 format including the set of control codes supported by the StringToImage() service.
613
614 If a graphics console device is not associated with the ConsoleOutputHandle
615 defined in the EFI_SYSTEM_TABLE then no string is printed, and 0 is returned.
616 If the EFI_HII_FONT_PROTOCOL is not present in the handle database, then no
617 string is printed, and 0 is returned.
618 If Format is NULL, then ASSERT().
619
620 @param PointX X coordinate to print the string.
621 @param PointY Y coordinate to print the string.
622 @param ForeGround The foreground color of the string being printed. This is
623 an optional parameter that may be NULL. If it is NULL,
624 then the foreground color of the current ConOut device
625 in the EFI_SYSTEM_TABLE is used.
626 @param BackGround The background color of the string being printed. This is
627 an optional parameter that may be NULL. If it is NULL,
628 then the background color of the current ConOut device
629 in the EFI_SYSTEM_TABLE is used.
630 @param Format Null-terminated ASCII format string. See Print Library
631 for the supported format string syntax.
632 @param ... Variable argument list whose contents are accessed based on
633 the format string specified by Format.
634
635 @return The number of ASCII characters printed.
636
637 **/
638 UINTN
639 EFIAPI
640 AsciiPrintXY (
641 IN UINTN PointX,
642 IN UINTN PointY,
643 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *ForeGround, OPTIONAL
644 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BackGround, OPTIONAL
645 IN CONST CHAR8 *Format,
646 ...
647 )
648 {
649 VA_LIST Marker;
650 CHAR16 *Buffer;
651 UINTN BufferSize;
652 UINTN PrintNum;
653 UINTN ReturnNum;
654
655 ASSERT (Format != NULL);
656
657 VA_START (Marker, Format);
658
659 BufferSize = (PcdGet32 (PcdUefiLibMaxPrintBufferSize) + 1) * sizeof (CHAR16);
660
661 Buffer = (CHAR16 *) AllocatePool (BufferSize);
662 ASSERT (Buffer != NULL);
663
664 PrintNum = UnicodeSPrintAsciiFormat (Buffer, BufferSize, Format, Marker);
665
666 ReturnNum = InternalPrintGraphic (PointX, PointY, ForeGround, BackGround, Buffer, PrintNum);
667
668 FreePool (Buffer);
669
670 return ReturnNum;
671 }
672