]>
Commit | Line | Data |
---|---|---|
1 | /** @file\r | |
2 | Mde UEFI library API implementation.\r | |
3 | Print to StdErr or ConOut defined in EFI_SYSTEM_TABLE\r | |
4 | \r | |
5 | Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r | |
6 | This program and the accompanying materials\r | |
7 | are licensed and made available under the terms and conditions of the BSD License\r | |
8 | which accompanies this distribution. The full text of the license may be found at\r | |
9 | http://opensource.org/licenses/bsd-license.php.\r | |
10 | \r | |
11 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
12 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
13 | \r | |
14 | **/\r | |
15 | \r | |
16 | #include "UefiLibInternal.h"\r | |
17 | \r | |
18 | GLOBAL_REMOVE_IF_UNREFERENCED EFI_GRAPHICS_OUTPUT_BLT_PIXEL mEfiColors[16] = {\r | |
19 | { 0x00, 0x00, 0x00, 0x00 },\r | |
20 | { 0x98, 0x00, 0x00, 0x00 },\r | |
21 | { 0x00, 0x98, 0x00, 0x00 },\r | |
22 | { 0x98, 0x98, 0x00, 0x00 },\r | |
23 | { 0x00, 0x00, 0x98, 0x00 },\r | |
24 | { 0x98, 0x00, 0x98, 0x00 },\r | |
25 | { 0x00, 0x98, 0x98, 0x00 },\r | |
26 | { 0x98, 0x98, 0x98, 0x00 },\r | |
27 | { 0x10, 0x10, 0x10, 0x00 },\r | |
28 | { 0xff, 0x10, 0x10, 0x00 },\r | |
29 | { 0x10, 0xff, 0x10, 0x00 },\r | |
30 | { 0xff, 0xff, 0x10, 0x00 },\r | |
31 | { 0x10, 0x10, 0xff, 0x00 },\r | |
32 | { 0xf0, 0x10, 0xff, 0x00 },\r | |
33 | { 0x10, 0xff, 0xff, 0x00 },\r | |
34 | { 0xff, 0xff, 0xff, 0x00 }\r | |
35 | };\r | |
36 | \r | |
37 | /**\r | |
38 | Internal function which prints a formatted Unicode string to the console output device\r | |
39 | specified by Console\r | |
40 | \r | |
41 | This function prints a formatted Unicode string to the console output device\r | |
42 | specified by Console and returns the number of Unicode characters that printed\r | |
43 | to it. If the length of the formatted Unicode string is greater than PcdUefiLibMaxPrintBufferSize,\r | |
44 | then only the first PcdUefiLibMaxPrintBufferSize characters are sent to Console.\r | |
45 | If Format is NULL, then ASSERT().\r | |
46 | If Format is not aligned on a 16-bit boundary, then ASSERT().\r | |
47 | \r | |
48 | @param Format A Null-terminated Unicode format string.\r | |
49 | @param Console The output console.\r | |
50 | @param Marker A VA_LIST marker for the variable argument list.\r | |
51 | \r | |
52 | @return The number of Unicode characters in the produced\r | |
53 | output buffer, not including the Null-terminator.\r | |
54 | **/\r | |
55 | UINTN\r | |
56 | InternalPrint (\r | |
57 | IN CONST CHAR16 *Format,\r | |
58 | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *Console,\r | |
59 | IN VA_LIST Marker\r | |
60 | )\r | |
61 | {\r | |
62 | EFI_STATUS Status;\r | |
63 | UINTN Return;\r | |
64 | CHAR16 *Buffer;\r | |
65 | UINTN BufferSize;\r | |
66 | \r | |
67 | ASSERT (Format != NULL);\r | |
68 | ASSERT (((UINTN) Format & BIT0) == 0);\r | |
69 | ASSERT (Console != NULL);\r | |
70 | \r | |
71 | BufferSize = (PcdGet32 (PcdUefiLibMaxPrintBufferSize) + 1) * sizeof (CHAR16);\r | |
72 | \r | |
73 | Buffer = (CHAR16 *) AllocatePool(BufferSize);\r | |
74 | ASSERT (Buffer != NULL);\r | |
75 | \r | |
76 | Return = UnicodeVSPrint (Buffer, BufferSize, Format, Marker);\r | |
77 | \r | |
78 | if (Console != NULL && Return > 0) {\r | |
79 | //\r | |
80 | // To be extra safe make sure Console has been initialized\r | |
81 | //\r | |
82 | Status = Console->OutputString (Console, Buffer);\r | |
83 | if (EFI_ERROR (Status)) {\r | |
84 | Return = 0;\r | |
85 | }\r | |
86 | }\r | |
87 | \r | |
88 | FreePool (Buffer);\r | |
89 | \r | |
90 | return Return;\r | |
91 | }\r | |
92 | \r | |
93 | /**\r | |
94 | Prints a formatted Unicode string to the console output device specified by\r | |
95 | ConOut defined in the EFI_SYSTEM_TABLE.\r | |
96 | \r | |
97 | This function prints a formatted Unicode string to the console output device\r | |
98 | specified by ConOut in EFI_SYSTEM_TABLE and returns the number of Unicode\r | |
99 | characters that printed to ConOut. If the length of the formatted Unicode\r | |
100 | string is greater than PcdUefiLibMaxPrintBufferSize, then only the first\r | |
101 | PcdUefiLibMaxPrintBufferSize characters are sent to ConOut.\r | |
102 | If Format is NULL, then ASSERT().\r | |
103 | If Format is not aligned on a 16-bit boundary, then ASSERT().\r | |
104 | If gST->ConOut is NULL, then ASSERT().\r | |
105 | \r | |
106 | @param Format A Null-terminated Unicode format string.\r | |
107 | @param ... A Variable argument list whose contents are accessed based\r | |
108 | on the format string specified by Format.\r | |
109 | \r | |
110 | @return The number of Unicode characters printed to ConOut.\r | |
111 | \r | |
112 | **/\r | |
113 | UINTN\r | |
114 | EFIAPI\r | |
115 | Print (\r | |
116 | IN CONST CHAR16 *Format,\r | |
117 | ...\r | |
118 | )\r | |
119 | {\r | |
120 | VA_LIST Marker;\r | |
121 | UINTN Return;\r | |
122 | \r | |
123 | VA_START (Marker, Format);\r | |
124 | \r | |
125 | Return = InternalPrint (Format, gST->ConOut, Marker);\r | |
126 | \r | |
127 | VA_END (Marker);\r | |
128 | \r | |
129 | return Return;\r | |
130 | }\r | |
131 | \r | |
132 | /**\r | |
133 | Prints a formatted Unicode string to the console output device specified by\r | |
134 | StdErr defined in the EFI_SYSTEM_TABLE.\r | |
135 | \r | |
136 | This function prints a formatted Unicode string to the console output device\r | |
137 | specified by StdErr in EFI_SYSTEM_TABLE and returns the number of Unicode\r | |
138 | characters that printed to StdErr. If the length of the formatted Unicode\r | |
139 | string is greater than PcdUefiLibMaxPrintBufferSize, then only the first\r | |
140 | PcdUefiLibMaxPrintBufferSize characters are sent to StdErr.\r | |
141 | If Format is NULL, then ASSERT().\r | |
142 | If Format is not aligned on a 16-bit boundary, then ASSERT().\r | |
143 | If gST->StdErr is NULL, then ASSERT().\r | |
144 | \r | |
145 | @param Format A Null-terminated Unicode format string.\r | |
146 | @param ... Variable argument list whose contents are accessed based\r | |
147 | on the format string specified by Format.\r | |
148 | \r | |
149 | @return The number of Unicode characters printed to StdErr.\r | |
150 | \r | |
151 | **/\r | |
152 | UINTN\r | |
153 | EFIAPI\r | |
154 | ErrorPrint (\r | |
155 | IN CONST CHAR16 *Format,\r | |
156 | ...\r | |
157 | )\r | |
158 | {\r | |
159 | VA_LIST Marker;\r | |
160 | UINTN Return;\r | |
161 | \r | |
162 | VA_START (Marker, Format);\r | |
163 | \r | |
164 | Return = InternalPrint( Format, gST->StdErr, Marker);\r | |
165 | \r | |
166 | VA_END (Marker);\r | |
167 | \r | |
168 | return Return;\r | |
169 | }\r | |
170 | \r | |
171 | \r | |
172 | /**\r | |
173 | Internal function which prints a formatted ASCII string to the console output device\r | |
174 | specified by Console\r | |
175 | \r | |
176 | This function prints a formatted ASCII string to the console output device\r | |
177 | specified by Console and returns the number of ASCII characters that printed\r | |
178 | to it. If the length of the formatted ASCII string is greater than PcdUefiLibMaxPrintBufferSize,\r | |
179 | then only the first PcdUefiLibMaxPrintBufferSize characters are sent to Console.\r | |
180 | \r | |
181 | If Format is NULL, then ASSERT().\r | |
182 | \r | |
183 | @param Format A Null-terminated ASCII format string.\r | |
184 | @param Console The output console.\r | |
185 | @param Marker VA_LIST marker for the variable argument list.\r | |
186 | \r | |
187 | @return The number of Unicode characters in the produced\r | |
188 | output buffer not including the Null-terminator.\r | |
189 | \r | |
190 | **/\r | |
191 | UINTN\r | |
192 | AsciiInternalPrint (\r | |
193 | IN CONST CHAR8 *Format,\r | |
194 | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *Console,\r | |
195 | IN VA_LIST Marker\r | |
196 | )\r | |
197 | {\r | |
198 | EFI_STATUS Status;\r | |
199 | UINTN Return;\r | |
200 | CHAR16 *Buffer;\r | |
201 | UINTN BufferSize;\r | |
202 | \r | |
203 | ASSERT (Format != NULL);\r | |
204 | ASSERT (Console != NULL);\r | |
205 | \r | |
206 | BufferSize = (PcdGet32 (PcdUefiLibMaxPrintBufferSize) + 1) * sizeof (CHAR16);\r | |
207 | \r | |
208 | Buffer = (CHAR16 *) AllocatePool(BufferSize);\r | |
209 | ASSERT (Buffer != NULL);\r | |
210 | \r | |
211 | Return = UnicodeVSPrintAsciiFormat (Buffer, BufferSize, Format, Marker);\r | |
212 | \r | |
213 | if (Console != NULL) {\r | |
214 | //\r | |
215 | // To be extra safe make sure Console has been initialized\r | |
216 | //\r | |
217 | Status = Console->OutputString (Console, Buffer);\r | |
218 | if (EFI_ERROR (Status)) {\r | |
219 | Return = 0;\r | |
220 | }\r | |
221 | }\r | |
222 | \r | |
223 | FreePool (Buffer);\r | |
224 | \r | |
225 | return Return;\r | |
226 | }\r | |
227 | \r | |
228 | /**\r | |
229 | Prints a formatted ASCII string to the console output device specified by\r | |
230 | ConOut defined in the EFI_SYSTEM_TABLE.\r | |
231 | \r | |
232 | This function prints a formatted ASCII string to the console output device\r | |
233 | specified by ConOut in EFI_SYSTEM_TABLE and returns the number of ASCII\r | |
234 | characters that printed to ConOut. If the length of the formatted ASCII\r | |
235 | string is greater than PcdUefiLibMaxPrintBufferSize, then only the first\r | |
236 | PcdUefiLibMaxPrintBufferSize characters are sent to ConOut.\r | |
237 | If Format is NULL, then ASSERT().\r | |
238 | If gST->ConOut is NULL, then ASSERT().\r | |
239 | \r | |
240 | @param Format A Null-terminated ASCII format string.\r | |
241 | @param ... Variable argument list whose contents are accessed based\r | |
242 | on the format string specified by Format.\r | |
243 | \r | |
244 | @return The number of ASCII characters printed to ConOut.\r | |
245 | \r | |
246 | **/\r | |
247 | UINTN\r | |
248 | EFIAPI\r | |
249 | AsciiPrint (\r | |
250 | IN CONST CHAR8 *Format,\r | |
251 | ...\r | |
252 | )\r | |
253 | {\r | |
254 | VA_LIST Marker;\r | |
255 | UINTN Return;\r | |
256 | ASSERT (Format != NULL);\r | |
257 | \r | |
258 | VA_START (Marker, Format);\r | |
259 | \r | |
260 | Return = AsciiInternalPrint( Format, gST->ConOut, Marker);\r | |
261 | \r | |
262 | VA_END (Marker);\r | |
263 | \r | |
264 | return Return;\r | |
265 | }\r | |
266 | \r | |
267 | /**\r | |
268 | Prints a formatted ASCII string to the console output device specified by\r | |
269 | StdErr defined in the EFI_SYSTEM_TABLE.\r | |
270 | \r | |
271 | This function prints a formatted ASCII string to the console output device\r | |
272 | specified by StdErr in EFI_SYSTEM_TABLE and returns the number of ASCII\r | |
273 | characters that printed to StdErr. If the length of the formatted ASCII\r | |
274 | string is greater than PcdUefiLibMaxPrintBufferSize, then only the first\r | |
275 | PcdUefiLibMaxPrintBufferSize characters are sent to StdErr.\r | |
276 | If Format is NULL, then ASSERT().\r | |
277 | If gST->StdErr is NULL, then ASSERT().\r | |
278 | \r | |
279 | @param Format A Null-terminated ASCII format string.\r | |
280 | @param ... Variable argument list whose contents are accessed based\r | |
281 | on the format string specified by Format.\r | |
282 | \r | |
283 | @return The number of ASCII characters printed to ConErr.\r | |
284 | \r | |
285 | **/\r | |
286 | UINTN\r | |
287 | EFIAPI\r | |
288 | AsciiErrorPrint (\r | |
289 | IN CONST CHAR8 *Format,\r | |
290 | ...\r | |
291 | )\r | |
292 | {\r | |
293 | VA_LIST Marker;\r | |
294 | UINTN Return;\r | |
295 | \r | |
296 | ASSERT (Format != NULL);\r | |
297 | \r | |
298 | VA_START (Marker, Format);\r | |
299 | \r | |
300 | Return = AsciiInternalPrint( Format, gST->StdErr, Marker);\r | |
301 | \r | |
302 | VA_END (Marker);\r | |
303 | \r | |
304 | return Return;\r | |
305 | }\r | |
306 | \r | |
307 | /**\r | |
308 | Internal function to print a formatted Unicode string to a graphics console device specified by\r | |
309 | ConsoleOutputHandle defined in the EFI_SYSTEM_TABLE at the given (X,Y) coordinates.\r | |
310 | \r | |
311 | This function prints a formatted Unicode string to the graphics console device\r | |
312 | specified by ConsoleOutputHandle in EFI_SYSTEM_TABLE and returns the number of\r | |
313 | Unicode characters printed. The EFI_HII_FONT_PROTOCOL is used to convert the\r | |
314 | string to a bitmap using the glyphs registered with the\r | |
315 | HII database. No wrapping is performed, so any portions of the string the fall\r | |
316 | outside the active display region will not be displayed.\r | |
317 | \r | |
318 | If a graphics console device is not associated with the ConsoleOutputHandle\r | |
319 | defined in the EFI_SYSTEM_TABLE then no string is printed, and 0 is returned.\r | |
320 | If the EFI_HII_FONT_PROTOCOL is not present in the handle database, then no\r | |
321 | string is printed, and 0 is returned.\r | |
322 | \r | |
323 | @param PointX An X coordinate to print the string.\r | |
324 | @param PointY A Y coordinate to print the string.\r | |
325 | @param Foreground The foreground color of the string being printed. This is\r | |
326 | an optional parameter that may be NULL. If it is NULL,\r | |
327 | then the foreground color of the current ConOut device\r | |
328 | in the EFI_SYSTEM_TABLE is used.\r | |
329 | @param Background The background color of the string being printed. This is\r | |
330 | an optional parameter that may be NULL. If it is NULL,\r | |
331 | then the background color of the current ConOut device\r | |
332 | in the EFI_SYSTEM_TABLE is used.\r | |
333 | @param Buffer A Null-terminated Unicode formatted string.\r | |
334 | @param PrintNum The number of Unicode formatted string to be printed.\r | |
335 | \r | |
336 | @return The number of Unicode Characters printed. Zero means no any character\r | |
337 | displayed successfully.\r | |
338 | \r | |
339 | **/\r | |
340 | UINTN\r | |
341 | InternalPrintGraphic (\r | |
342 | IN UINTN PointX,\r | |
343 | IN UINTN PointY,\r | |
344 | IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *Foreground,\r | |
345 | IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *Background,\r | |
346 | IN CHAR16 *Buffer,\r | |
347 | IN UINTN PrintNum\r | |
348 | )\r | |
349 | {\r | |
350 | EFI_STATUS Status;\r | |
351 | UINT32 HorizontalResolution;\r | |
352 | UINT32 VerticalResolution;\r | |
353 | UINT32 ColorDepth;\r | |
354 | UINT32 RefreshRate;\r | |
355 | EFI_HII_FONT_PROTOCOL *HiiFont;\r | |
356 | EFI_IMAGE_OUTPUT *Blt;\r | |
357 | EFI_FONT_DISPLAY_INFO FontInfo;\r | |
358 | EFI_HII_ROW_INFO *RowInfoArray;\r | |
359 | UINTN RowInfoArraySize;\r | |
360 | EFI_GRAPHICS_OUTPUT_PROTOCOL *GraphicsOutput;\r | |
361 | EFI_UGA_DRAW_PROTOCOL *UgaDraw;\r | |
362 | EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *Sto;\r | |
363 | EFI_HANDLE ConsoleHandle;\r | |
364 | UINTN Width;\r | |
365 | UINTN Height;\r | |
366 | UINTN Delta;\r | |
367 | \r | |
368 | HorizontalResolution = 0;\r | |
369 | VerticalResolution = 0;\r | |
370 | Blt = NULL;\r | |
371 | RowInfoArray = NULL;\r | |
372 | \r | |
373 | ConsoleHandle = gST->ConsoleOutHandle;\r | |
374 | \r | |
375 | ASSERT( ConsoleHandle != NULL);\r | |
376 | \r | |
377 | Status = gBS->HandleProtocol (\r | |
378 | ConsoleHandle,\r | |
379 | &gEfiGraphicsOutputProtocolGuid,\r | |
380 | (VOID **) &GraphicsOutput\r | |
381 | );\r | |
382 | \r | |
383 | UgaDraw = NULL;\r | |
384 | if (EFI_ERROR (Status) && FeaturePcdGet (PcdUgaConsumeSupport)) {\r | |
385 | //\r | |
386 | // If no GOP available, try to open UGA Draw protocol if supported.\r | |
387 | //\r | |
388 | GraphicsOutput = NULL;\r | |
389 | \r | |
390 | Status = gBS->HandleProtocol (\r | |
391 | ConsoleHandle,\r | |
392 | &gEfiUgaDrawProtocolGuid,\r | |
393 | (VOID **) &UgaDraw\r | |
394 | );\r | |
395 | }\r | |
396 | if (EFI_ERROR (Status)) {\r | |
397 | goto Error;\r | |
398 | }\r | |
399 | \r | |
400 | Status = gBS->HandleProtocol (\r | |
401 | ConsoleHandle,\r | |
402 | &gEfiSimpleTextOutProtocolGuid,\r | |
403 | (VOID **) &Sto\r | |
404 | );\r | |
405 | \r | |
406 | if (EFI_ERROR (Status)) {\r | |
407 | goto Error;\r | |
408 | }\r | |
409 | \r | |
410 | if (GraphicsOutput != NULL) {\r | |
411 | HorizontalResolution = GraphicsOutput->Mode->Info->HorizontalResolution;\r | |
412 | VerticalResolution = GraphicsOutput->Mode->Info->VerticalResolution;\r | |
413 | } else if (UgaDraw != NULL && FeaturePcdGet (PcdUgaConsumeSupport)) {\r | |
414 | UgaDraw->GetMode (UgaDraw, &HorizontalResolution, &VerticalResolution, &ColorDepth, &RefreshRate);\r | |
415 | } else {\r | |
416 | goto Error;\r | |
417 | }\r | |
418 | \r | |
419 | ASSERT ((HorizontalResolution != 0) && (VerticalResolution !=0));\r | |
420 | \r | |
421 | Status = gBS->LocateProtocol (&gEfiHiiFontProtocolGuid, NULL, (VOID **) &HiiFont);\r | |
422 | if (EFI_ERROR (Status)) {\r | |
423 | goto Error;\r | |
424 | }\r | |
425 | \r | |
426 | Blt = (EFI_IMAGE_OUTPUT *) AllocateZeroPool (sizeof (EFI_IMAGE_OUTPUT));\r | |
427 | ASSERT (Blt != NULL);\r | |
428 | \r | |
429 | Blt->Width = (UINT16) (HorizontalResolution);\r | |
430 | Blt->Height = (UINT16) (VerticalResolution);\r | |
431 | \r | |
432 | ZeroMem (&FontInfo, sizeof (EFI_FONT_DISPLAY_INFO));\r | |
433 | \r | |
434 | if (Foreground != NULL) {\r | |
435 | CopyMem (&FontInfo.ForegroundColor, Foreground, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL));\r | |
436 | } else {\r | |
437 | CopyMem (\r | |
438 | &FontInfo.ForegroundColor,\r | |
439 | &mEfiColors[Sto->Mode->Attribute & 0x0f],\r | |
440 | sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL)\r | |
441 | );\r | |
442 | }\r | |
443 | if (Background != NULL) {\r | |
444 | CopyMem (&FontInfo.BackgroundColor, Background, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL));\r | |
445 | } else {\r | |
446 | CopyMem (\r | |
447 | &FontInfo.BackgroundColor,\r | |
448 | &mEfiColors[Sto->Mode->Attribute >> 4],\r | |
449 | sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL)\r | |
450 | );\r | |
451 | }\r | |
452 | \r | |
453 | if (GraphicsOutput != NULL) {\r | |
454 | Blt->Image.Screen = GraphicsOutput;\r | |
455 | \r | |
456 | Status = HiiFont->StringToImage (\r | |
457 | HiiFont,\r | |
458 | EFI_HII_IGNORE_IF_NO_GLYPH | EFI_HII_OUT_FLAG_CLIP |\r | |
459 | EFI_HII_OUT_FLAG_CLIP_CLEAN_X | EFI_HII_OUT_FLAG_CLIP_CLEAN_Y |\r | |
460 | EFI_HII_IGNORE_LINE_BREAK | EFI_HII_DIRECT_TO_SCREEN,\r | |
461 | Buffer,\r | |
462 | &FontInfo,\r | |
463 | &Blt,\r | |
464 | PointX,\r | |
465 | PointY,\r | |
466 | &RowInfoArray,\r | |
467 | &RowInfoArraySize,\r | |
468 | NULL\r | |
469 | );\r | |
470 | if (EFI_ERROR (Status)) {\r | |
471 | goto Error;\r | |
472 | }\r | |
473 | \r | |
474 | } else if (FeaturePcdGet (PcdUgaConsumeSupport)) {\r | |
475 | ASSERT (UgaDraw!= NULL);\r | |
476 | \r | |
477 | //\r | |
478 | // Ensure Width * Height * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL) doesn't overflow.\r | |
479 | //\r | |
480 | if (Blt->Width > DivU64x32 (MAX_UINTN, Blt->Height * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL))) {\r | |
481 | goto Error;\r | |
482 | }\r | |
483 | \r | |
484 | Blt->Image.Bitmap = AllocateZeroPool ((UINT32) Blt->Width * Blt->Height * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL));\r | |
485 | ASSERT (Blt->Image.Bitmap != NULL);\r | |
486 | \r | |
487 | //\r | |
488 | // StringToImage only support blt'ing image to device using GOP protocol. If GOP is not supported in this platform,\r | |
489 | // we ask StringToImage to print the string to blt buffer, then blt to device using UgaDraw.\r | |
490 | //\r | |
491 | Status = HiiFont->StringToImage (\r | |
492 | HiiFont,\r | |
493 | EFI_HII_IGNORE_IF_NO_GLYPH | EFI_HII_OUT_FLAG_CLIP |\r | |
494 | EFI_HII_OUT_FLAG_CLIP_CLEAN_X | EFI_HII_OUT_FLAG_CLIP_CLEAN_Y |\r | |
495 | EFI_HII_IGNORE_LINE_BREAK,\r | |
496 | Buffer,\r | |
497 | &FontInfo,\r | |
498 | &Blt,\r | |
499 | PointX,\r | |
500 | PointY,\r | |
501 | &RowInfoArray,\r | |
502 | &RowInfoArraySize,\r | |
503 | NULL\r | |
504 | );\r | |
505 | \r | |
506 | if (!EFI_ERROR (Status)) {\r | |
507 | ASSERT (RowInfoArray != NULL);\r | |
508 | //\r | |
509 | // Explicit Line break characters are ignored, so the updated parameter RowInfoArraySize by StringToImage will\r | |
510 | // always be 1 or 0 (if there is no valid Unicode Char can be printed). ASSERT here to make sure.\r | |
511 | //\r | |
512 | ASSERT (RowInfoArraySize <= 1);\r | |
513 | \r | |
514 | if (RowInfoArraySize != 0) {\r | |
515 | Width = RowInfoArray[0].LineWidth;\r | |
516 | Height = RowInfoArray[0].LineHeight;\r | |
517 | Delta = Blt->Width * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL);\r | |
518 | } else {\r | |
519 | Width = 0;\r | |
520 | Height = 0;\r | |
521 | Delta = 0;\r | |
522 | }\r | |
523 | Status = UgaDraw->Blt (\r | |
524 | UgaDraw,\r | |
525 | (EFI_UGA_PIXEL *) Blt->Image.Bitmap,\r | |
526 | EfiUgaBltBufferToVideo,\r | |
527 | PointX,\r | |
528 | PointY,\r | |
529 | PointX,\r | |
530 | PointY,\r | |
531 | Width,\r | |
532 | Height,\r | |
533 | Delta\r | |
534 | );\r | |
535 | } else {\r | |
536 | goto Error;\r | |
537 | }\r | |
538 | FreePool (Blt->Image.Bitmap);\r | |
539 | } else {\r | |
540 | goto Error;\r | |
541 | }\r | |
542 | //\r | |
543 | // Calculate the number of actual printed characters\r | |
544 | //\r | |
545 | if (RowInfoArraySize != 0) {\r | |
546 | PrintNum = RowInfoArray[0].EndIndex - RowInfoArray[0].StartIndex + 1;\r | |
547 | } else {\r | |
548 | PrintNum = 0;\r | |
549 | }\r | |
550 | \r | |
551 | FreePool (RowInfoArray);\r | |
552 | FreePool (Blt);\r | |
553 | return PrintNum;\r | |
554 | \r | |
555 | Error:\r | |
556 | if (Blt != NULL) {\r | |
557 | FreePool (Blt);\r | |
558 | }\r | |
559 | return 0;\r | |
560 | }\r | |
561 | \r | |
562 | /**\r | |
563 | Prints a formatted Unicode string to a graphics console device specified by\r | |
564 | ConsoleOutputHandle defined in the EFI_SYSTEM_TABLE at the given (X,Y) coordinates.\r | |
565 | \r | |
566 | This function prints a formatted Unicode string to the graphics console device\r | |
567 | specified by ConsoleOutputHandle in EFI_SYSTEM_TABLE and returns the number of\r | |
568 | Unicode characters displayed, not including partial characters that may be clipped\r | |
569 | by the right edge of the display. If the length of the formatted Unicode string is\r | |
570 | greater than PcdUefiLibMaxPrintBufferSize, then at most the first\r | |
571 | PcdUefiLibMaxPrintBufferSize characters are printed.The EFI_HII_FONT_PROTOCOL\r | |
572 | StringToImage() service is used to convert the string to a bitmap using the glyphs\r | |
573 | registered with the HII database. No wrapping is performed, so any portions of the\r | |
574 | string the fall outside the active display region will not be displayed. Please see\r | |
575 | Section 27.2.6 of the UEFI Specification for a description of the supported string\r | |
576 | format including the set of control codes supported by the StringToImage() service.\r | |
577 | \r | |
578 | If a graphics console device is not associated with the ConsoleOutputHandle\r | |
579 | defined in the EFI_SYSTEM_TABLE then no string is printed, and 0 is returned.\r | |
580 | If the EFI_HII_FONT_PROTOCOL is not present in the handle database, then no\r | |
581 | string is printed, and 0 is returned.\r | |
582 | If Format is NULL, then ASSERT().\r | |
583 | If Format is not aligned on a 16-bit boundary, then ASSERT().\r | |
584 | If gST->ConsoleOutputHandle is NULL, then ASSERT().\r | |
585 | \r | |
586 | @param PointX An X coordinate to print the string.\r | |
587 | @param PointY A Y coordinate to print the string.\r | |
588 | @param ForeGround The foreground color of the string being printed. This is\r | |
589 | an optional parameter that may be NULL. If it is NULL,\r | |
590 | then the foreground color of the current ConOut device\r | |
591 | in the EFI_SYSTEM_TABLE is used.\r | |
592 | @param BackGround The background color of the string being printed. This is\r | |
593 | an optional parameter that may be NULL. If it is NULL,\r | |
594 | then the background color of the current ConOut device\r | |
595 | in the EFI_SYSTEM_TABLE is used.\r | |
596 | @param Format A Null-terminated Unicode format string. See Print Library\r | |
597 | for the supported format string syntax.\r | |
598 | @param ... A Variable argument list whose contents are accessed based on\r | |
599 | the format string specified by Format.\r | |
600 | \r | |
601 | @return The number of Unicode characters printed.\r | |
602 | \r | |
603 | **/\r | |
604 | UINTN\r | |
605 | EFIAPI\r | |
606 | PrintXY (\r | |
607 | IN UINTN PointX,\r | |
608 | IN UINTN PointY,\r | |
609 | IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *ForeGround, OPTIONAL\r | |
610 | IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BackGround, OPTIONAL\r | |
611 | IN CONST CHAR16 *Format,\r | |
612 | ...\r | |
613 | )\r | |
614 | {\r | |
615 | VA_LIST Marker;\r | |
616 | CHAR16 *Buffer;\r | |
617 | UINTN BufferSize;\r | |
618 | UINTN PrintNum;\r | |
619 | UINTN ReturnNum;\r | |
620 | \r | |
621 | ASSERT (Format != NULL);\r | |
622 | ASSERT (((UINTN) Format & BIT0) == 0);\r | |
623 | \r | |
624 | VA_START (Marker, Format);\r | |
625 | \r | |
626 | BufferSize = (PcdGet32 (PcdUefiLibMaxPrintBufferSize) + 1) * sizeof (CHAR16);\r | |
627 | \r | |
628 | Buffer = (CHAR16 *) AllocatePool (BufferSize);\r | |
629 | ASSERT (Buffer != NULL);\r | |
630 | \r | |
631 | PrintNum = UnicodeVSPrint (Buffer, BufferSize, Format, Marker);\r | |
632 | \r | |
633 | VA_END (Marker);\r | |
634 | \r | |
635 | ReturnNum = InternalPrintGraphic (PointX, PointY, ForeGround, BackGround, Buffer, PrintNum);\r | |
636 | \r | |
637 | FreePool (Buffer);\r | |
638 | \r | |
639 | return ReturnNum;\r | |
640 | }\r | |
641 | \r | |
642 | /**\r | |
643 | Prints a formatted ASCII string to a graphics console device specified by\r | |
644 | ConsoleOutputHandle defined in the EFI_SYSTEM_TABLE at the given (X,Y) coordinates.\r | |
645 | \r | |
646 | This function prints a formatted ASCII string to the graphics console device\r | |
647 | specified by ConsoleOutputHandle in EFI_SYSTEM_TABLE and returns the number of\r | |
648 | ASCII characters displayed, not including partial characters that may be clipped\r | |
649 | by the right edge of the display. If the length of the formatted ASCII string is\r | |
650 | greater than PcdUefiLibMaxPrintBufferSize, then at most the first\r | |
651 | PcdUefiLibMaxPrintBufferSize characters are printed.The EFI_HII_FONT_PROTOCOL\r | |
652 | StringToImage() service is used to convert the string to a bitmap using the glyphs\r | |
653 | registered with the HII database. No wrapping is performed, so any portions of the\r | |
654 | string the fall outside the active display region will not be displayed. Please see\r | |
655 | Section 27.2.6 of the UEFI Specification for a description of the supported string\r | |
656 | format including the set of control codes supported by the StringToImage() service.\r | |
657 | \r | |
658 | If a graphics console device is not associated with the ConsoleOutputHandle\r | |
659 | defined in the EFI_SYSTEM_TABLE then no string is printed, and 0 is returned.\r | |
660 | If the EFI_HII_FONT_PROTOCOL is not present in the handle database, then no\r | |
661 | string is printed, and 0 is returned.\r | |
662 | If Format is NULL, then ASSERT().\r | |
663 | If gST->ConsoleOutputHandle is NULL, then ASSERT().\r | |
664 | \r | |
665 | @param PointX An X coordinate to print the string.\r | |
666 | @param PointY A Y coordinate to print the string.\r | |
667 | @param ForeGround The foreground color of the string being printed. This is\r | |
668 | an optional parameter that may be NULL. If it is NULL,\r | |
669 | then the foreground color of the current ConOut device\r | |
670 | in the EFI_SYSTEM_TABLE is used.\r | |
671 | @param BackGround The background color of the string being printed. This is\r | |
672 | an optional parameter that may be NULL. If it is NULL,\r | |
673 | then the background color of the current ConOut device\r | |
674 | in the EFI_SYSTEM_TABLE is used.\r | |
675 | @param Format A Null-terminated ASCII format string. See Print Library\r | |
676 | for the supported format string syntax.\r | |
677 | @param ... Variable argument list whose contents are accessed based on\r | |
678 | the format string specified by Format.\r | |
679 | \r | |
680 | @return The number of ASCII characters printed.\r | |
681 | \r | |
682 | **/\r | |
683 | UINTN\r | |
684 | EFIAPI\r | |
685 | AsciiPrintXY (\r | |
686 | IN UINTN PointX,\r | |
687 | IN UINTN PointY,\r | |
688 | IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *ForeGround, OPTIONAL\r | |
689 | IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BackGround, OPTIONAL\r | |
690 | IN CONST CHAR8 *Format,\r | |
691 | ...\r | |
692 | )\r | |
693 | {\r | |
694 | VA_LIST Marker;\r | |
695 | CHAR16 *Buffer;\r | |
696 | UINTN BufferSize;\r | |
697 | UINTN PrintNum;\r | |
698 | UINTN ReturnNum;\r | |
699 | \r | |
700 | ASSERT (Format != NULL);\r | |
701 | \r | |
702 | VA_START (Marker, Format);\r | |
703 | \r | |
704 | BufferSize = (PcdGet32 (PcdUefiLibMaxPrintBufferSize) + 1) * sizeof (CHAR16);\r | |
705 | \r | |
706 | Buffer = (CHAR16 *) AllocatePool (BufferSize);\r | |
707 | ASSERT (Buffer != NULL);\r | |
708 | \r | |
709 | PrintNum = UnicodeSPrintAsciiFormat (Buffer, BufferSize, Format, Marker);\r | |
710 | \r | |
711 | VA_END (Marker);\r | |
712 | \r | |
713 | ReturnNum = InternalPrintGraphic (PointX, PointY, ForeGround, BackGround, Buffer, PrintNum);\r | |
714 | \r | |
715 | FreePool (Buffer);\r | |
716 | \r | |
717 | return ReturnNum;\r | |
718 | }\r | |
719 | \r | |
720 | /**\r | |
721 | Appends a formatted Unicode string to a Null-terminated Unicode string\r | |
722 | \r | |
723 | This function appends a formatted Unicode string to the Null-terminated\r | |
724 | Unicode string specified by String. String is optional and may be NULL.\r | |
725 | Storage for the formatted Unicode string returned is allocated using\r | |
726 | AllocatePool(). The pointer to the appended string is returned. The caller\r | |
727 | is responsible for freeing the returned string.\r | |
728 | \r | |
729 | If String is not NULL and not aligned on a 16-bit boundary, then ASSERT().\r | |
730 | If FormatString is NULL, then ASSERT().\r | |
731 | If FormatString is not aligned on a 16-bit boundary, then ASSERT().\r | |
732 | \r | |
733 | @param[in] String A Null-terminated Unicode string.\r | |
734 | @param[in] FormatString A Null-terminated Unicode format string.\r | |
735 | @param[in] Marker VA_LIST marker for the variable argument list.\r | |
736 | \r | |
737 | @retval NULL There was not enough available memory.\r | |
738 | @return Null-terminated Unicode string is that is the formatted\r | |
739 | string appended to String.\r | |
740 | **/\r | |
741 | CHAR16*\r | |
742 | EFIAPI\r | |
743 | CatVSPrint (\r | |
744 | IN CHAR16 *String, OPTIONAL\r | |
745 | IN CONST CHAR16 *FormatString,\r | |
746 | IN VA_LIST Marker\r | |
747 | )\r | |
748 | {\r | |
749 | UINTN CharactersRequired;\r | |
750 | UINTN SizeRequired;\r | |
751 | CHAR16 *BufferToReturn;\r | |
752 | VA_LIST ExtraMarker;\r | |
753 | \r | |
754 | VA_COPY (ExtraMarker, Marker);\r | |
755 | CharactersRequired = SPrintLength(FormatString, ExtraMarker);\r | |
756 | VA_END (ExtraMarker);\r | |
757 | \r | |
758 | if (String != NULL) {\r | |
759 | SizeRequired = StrSize(String) + (CharactersRequired * sizeof(CHAR16));\r | |
760 | } else {\r | |
761 | SizeRequired = sizeof(CHAR16) + (CharactersRequired * sizeof(CHAR16));\r | |
762 | }\r | |
763 | \r | |
764 | BufferToReturn = AllocatePool(SizeRequired);\r | |
765 | \r | |
766 | if (BufferToReturn == NULL) {\r | |
767 | return NULL;\r | |
768 | } else {\r | |
769 | BufferToReturn[0] = L'\0';\r | |
770 | }\r | |
771 | \r | |
772 | if (String != NULL) {\r | |
773 | StrCpyS(BufferToReturn, SizeRequired / sizeof(CHAR16), String);\r | |
774 | }\r | |
775 | \r | |
776 | UnicodeVSPrint(BufferToReturn + StrLen(BufferToReturn), (CharactersRequired+1) * sizeof(CHAR16), FormatString, Marker);\r | |
777 | \r | |
778 | ASSERT(StrSize(BufferToReturn)==SizeRequired);\r | |
779 | \r | |
780 | return (BufferToReturn);\r | |
781 | }\r | |
782 | \r | |
783 | /**\r | |
784 | Appends a formatted Unicode string to a Null-terminated Unicode string\r | |
785 | \r | |
786 | This function appends a formatted Unicode string to the Null-terminated\r | |
787 | Unicode string specified by String. String is optional and may be NULL.\r | |
788 | Storage for the formatted Unicode string returned is allocated using\r | |
789 | AllocatePool(). The pointer to the appended string is returned. The caller\r | |
790 | is responsible for freeing the returned string.\r | |
791 | \r | |
792 | If String is not NULL and not aligned on a 16-bit boundary, then ASSERT().\r | |
793 | If FormatString is NULL, then ASSERT().\r | |
794 | If FormatString is not aligned on a 16-bit boundary, then ASSERT().\r | |
795 | \r | |
796 | @param[in] String A Null-terminated Unicode string.\r | |
797 | @param[in] FormatString A Null-terminated Unicode format string.\r | |
798 | @param[in] ... The variable argument list whose contents are\r | |
799 | accessed based on the format string specified by\r | |
800 | FormatString.\r | |
801 | \r | |
802 | @retval NULL There was not enough available memory.\r | |
803 | @return Null-terminated Unicode string is that is the formatted\r | |
804 | string appended to String.\r | |
805 | **/\r | |
806 | CHAR16 *\r | |
807 | EFIAPI\r | |
808 | CatSPrint (\r | |
809 | IN CHAR16 *String, OPTIONAL\r | |
810 | IN CONST CHAR16 *FormatString,\r | |
811 | ...\r | |
812 | )\r | |
813 | {\r | |
814 | VA_LIST Marker;\r | |
815 | CHAR16 *NewString;\r | |
816 | \r | |
817 | VA_START (Marker, FormatString);\r | |
818 | NewString = CatVSPrint(String, FormatString, Marker);\r | |
819 | VA_END (Marker);\r | |
820 | return NewString;\r | |
821 | }\r | |
822 | \r |