]> git.proxmox.com Git - mirror_edk2.git/blame_incremental - MdeModulePkg/Universal/HiiDatabaseDxe/String.c
projects / mirror_edk2.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
MdeModulePkg/HiiDatabaseDxe: Fix a variable is uninitialized.
[mirror_edk2.git] / MdeModulePkg / Universal / HiiDatabaseDxe / String.c
... / ...
CommitLineData
1/** @file\r
2Implementation for EFI_HII_STRING_PROTOCOL.\r
3\r
4\r
5Copyright (c) 2007 - 2015, Intel Corporation. All rights reserved.<BR>\r
6(C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>\r
7This program and the accompanying materials\r
8are licensed and made available under the terms and conditions of the BSD License\r
9which accompanies this distribution. The full text of the license may be found at\r
10http://opensource.org/licenses/bsd-license.php\r
11\r
12THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
13WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
14\r
15**/\r
16\r
17\r
18#include "HiiDatabase.h"\r
19\r
20CHAR16 mLanguageWindow[16] = {\r
21 0x0000, 0x0080, 0x0100, 0x0300,\r
22 0x2000, 0x2080, 0x2100, 0x3000,\r
23 0x0080, 0x00C0, 0x0400, 0x0600,\r
24 0x0900, 0x3040, 0x30A0, 0xFF00\r
25};\r
26\r
27\r
28/**\r
29 This function checks whether a global font info is referred by local\r
30 font info list or not. (i.e. HII_FONT_INFO is generated.) If not, create\r
31 a HII_FONT_INFO to refer it locally.\r
32\r
33 This is a internal function.\r
34\r
35\r
36 @param Private Hii database private structure.\r
37 @param StringPackage HII string package instance.\r
38 @param FontId Font identifer, which must be unique within the string package.\r
39 @param DuplicateEnable If true, duplicate HII_FONT_INFO which refers to\r
40 the same EFI_FONT_INFO is permitted. Otherwise it\r
41 is not allowed.\r
42 @param GlobalFontInfo Input a global font info which specify a\r
43 EFI_FONT_INFO.\r
44 @param LocalFontInfo Output a local font info which refers to a\r
45 EFI_FONT_INFO.\r
46\r
47 @retval TRUE Already referred before calling this function.\r
48 @retval FALSE Not referred before calling this function.\r
49\r
50**/\r
51BOOLEAN\r
52ReferFontInfoLocally (\r
53 IN HII_DATABASE_PRIVATE_DATA *Private,\r
54 IN HII_STRING_PACKAGE_INSTANCE *StringPackage,\r
55 IN UINT8 FontId,\r
56 IN BOOLEAN DuplicateEnable,\r
57 IN HII_GLOBAL_FONT_INFO *GlobalFontInfo,\r
58 OUT HII_FONT_INFO **LocalFontInfo\r
59 )\r
60{\r
61 HII_FONT_INFO *LocalFont;\r
62 LIST_ENTRY *Link;\r
63\r
64 ASSERT (Private != NULL && StringPackage != NULL && GlobalFontInfo != NULL && LocalFontInfo != NULL);\r
65\r
66 if (!DuplicateEnable) {\r
67 for (Link = StringPackage->FontInfoList.ForwardLink;\r
68 Link != &StringPackage->FontInfoList;\r
69 Link = Link->ForwardLink\r
70 ) {\r
71 LocalFont = CR (Link, HII_FONT_INFO, Entry, HII_FONT_INFO_SIGNATURE);\r
72 if (LocalFont->GlobalEntry == &GlobalFontInfo->Entry) {\r
73 //\r
74 // Already referred by local font info list, return directly.\r
75 //\r
76 *LocalFontInfo = LocalFont;\r
77 return TRUE;\r
78 }\r
79 }\r
80 }\r
81 // FontId identifies EFI_FONT_INFO in local string package uniquely.\r
82 // GlobalEntry points to a HII_GLOBAL_FONT_INFO which identifies\r
83 // EFI_FONT_INFO uniquely in whole hii database.\r
84 //\r
85 LocalFont = (HII_FONT_INFO *) AllocateZeroPool (sizeof (HII_FONT_INFO));\r
86 ASSERT (LocalFont != NULL);\r
87\r
88 LocalFont->Signature = HII_FONT_INFO_SIGNATURE;\r
89 LocalFont->FontId = FontId;\r
90 LocalFont->GlobalEntry = &GlobalFontInfo->Entry;\r
91 InsertTailList (&StringPackage->FontInfoList, &LocalFont->Entry);\r
92\r
93 *LocalFontInfo = LocalFont;\r
94 return FALSE;\r
95}\r
96\r
97\r
98/**\r
99 Convert Ascii string text to unicode string test.\r
100\r
101 This is a internal function.\r
102\r
103\r
104 @param StringDest Buffer to store the string text. If it is NULL,\r
105 only the size will be returned.\r
106 @param StringSrc Points to current null-terminated string.\r
107 @param BufferSize Length of the buffer.\r
108\r
109 @retval EFI_SUCCESS The string text was outputed successfully.\r
110 @retval EFI_BUFFER_TOO_SMALL Buffer is insufficient to store the found string\r
111 text. BufferSize is updated to the required buffer\r
112 size.\r
113\r
114**/\r
115EFI_STATUS\r
116ConvertToUnicodeText (\r
117 OUT EFI_STRING StringDest,\r
118 IN CHAR8 *StringSrc,\r
119 IN OUT UINTN *BufferSize\r
120 )\r
121{\r
122 UINTN StringSize;\r
123 UINTN Index;\r
124\r
125 ASSERT (StringSrc != NULL && BufferSize != NULL);\r
126\r
127 StringSize = AsciiStrSize (StringSrc) * 2;\r
128 if (*BufferSize < StringSize || StringDest == NULL) {\r
129 *BufferSize = StringSize;\r
130 return EFI_BUFFER_TOO_SMALL;\r
131 }\r
132\r
133 for (Index = 0; Index < AsciiStrLen (StringSrc); Index++) {\r
134 StringDest[Index] = (CHAR16) StringSrc[Index];\r
135 }\r
136\r
137 StringDest[Index] = 0;\r
138 return EFI_SUCCESS;\r
139}\r
140\r
141\r
142/**\r
143 Calculate the size of StringSrc and output it. If StringDest is not NULL,\r
144 copy string text from src to dest.\r
145\r
146 This is a internal function.\r
147\r
148 @param StringDest Buffer to store the string text. If it is NULL,\r
149 only the size will be returned.\r
150 @param StringSrc Points to current null-terminated string.\r
151 @param BufferSize Length of the buffer.\r
152\r
153 @retval EFI_SUCCESS The string text was outputed successfully.\r
154 @retval EFI_BUFFER_TOO_SMALL Buffer is insufficient to store the found string\r
155 text. BufferSize is updated to the required buffer\r
156 size.\r
157\r
158**/\r
159EFI_STATUS\r
160GetUnicodeStringTextOrSize (\r
161 OUT EFI_STRING StringDest, OPTIONAL\r
162 IN UINT8 *StringSrc,\r
163 IN OUT UINTN *BufferSize\r
164 )\r
165{\r
166 UINTN StringSize;\r
167 UINT8 *StringPtr;\r
168\r
169 ASSERT (StringSrc != NULL && BufferSize != NULL);\r
170\r
171 StringSize = sizeof (CHAR16);\r
172 StringPtr = StringSrc;\r
173 while (ReadUnaligned16 ((UINT16 *) StringPtr) != 0) {\r
174 StringSize += sizeof (CHAR16);\r
175 StringPtr += sizeof (CHAR16);\r
176 }\r
177\r
178 if (*BufferSize < StringSize) {\r
179 *BufferSize = StringSize;\r
180 return EFI_BUFFER_TOO_SMALL;\r
181 }\r
182 if (StringDest != NULL) {\r
183 CopyMem (StringDest, StringSrc, StringSize);\r
184 }\r
185\r
186 *BufferSize = StringSize;\r
187 return EFI_SUCCESS;\r
188}\r
189\r
190\r
191/**\r
192 Copy string font info to a buffer.\r
193\r
194 This is a internal function.\r
195\r
196 @param StringPackage Hii string package instance.\r
197 @param FontId Font identifier which is unique in a string\r
198 package.\r
199 @param StringFontInfo Buffer to record the output font info. It's\r
200 caller's responsibility to free this buffer.\r
201\r
202 @retval EFI_SUCCESS The string font is outputed successfully.\r
203 @retval EFI_NOT_FOUND The specified font id does not exist.\r
204\r
205**/\r
206EFI_STATUS\r
207GetStringFontInfo (\r
208 IN HII_STRING_PACKAGE_INSTANCE *StringPackage,\r
209 IN UINT8 FontId,\r
210 OUT EFI_FONT_INFO **StringFontInfo\r
211 )\r
212{\r
213 LIST_ENTRY *Link;\r
214 HII_FONT_INFO *FontInfo;\r
215 HII_GLOBAL_FONT_INFO *GlobalFont;\r
216\r
217 ASSERT (StringFontInfo != NULL && StringPackage != NULL);\r
218\r
219 for (Link = StringPackage->FontInfoList.ForwardLink; Link != &StringPackage->FontInfoList; Link = Link->ForwardLink) {\r
220 FontInfo = CR (Link, HII_FONT_INFO, Entry, HII_FONT_INFO_SIGNATURE);\r
221 if (FontInfo->FontId == FontId) {\r
222 GlobalFont = CR (FontInfo->GlobalEntry, HII_GLOBAL_FONT_INFO, Entry, HII_GLOBAL_FONT_INFO_SIGNATURE);\r
223 *StringFontInfo = (EFI_FONT_INFO *) AllocateZeroPool (GlobalFont->FontInfoSize);\r
224 if (*StringFontInfo == NULL) {\r
225 return EFI_OUT_OF_RESOURCES;\r
226 }\r
227 CopyMem (*StringFontInfo, GlobalFont->FontInfo, GlobalFont->FontInfoSize);\r
228 return EFI_SUCCESS;\r
229 }\r
230 }\r
231\r
232 return EFI_NOT_FOUND;\r
233}\r
234\r
235\r
236/**\r
237 Parse all string blocks to find a String block specified by StringId.\r
238 If StringId = (EFI_STRING_ID) (-1), find out all EFI_HII_SIBT_FONT blocks\r
239 within this string package and backup its information. If LastStringId is \r
240 specified, the string id of last string block will also be output.\r
241 If StringId = 0, output the string id of last string block (EFI_HII_SIBT_STRING).\r
242\r
243 @param Private Hii database private structure.\r
244 @param StringPackage Hii string package instance.\r
245 @param StringId The string's id, which is unique within\r
246 PackageList.\r
247 @param BlockType Output the block type of found string block.\r
248 @param StringBlockAddr Output the block address of found string block.\r
249 @param StringTextOffset Offset, relative to the found block address, of\r
250 the string text information.\r
251 @param LastStringId Output the last string id when StringId = 0 or StringId = -1.\r
252 @param StartStringId The first id in the skip block which StringId in the block.\r
253\r
254 @retval EFI_SUCCESS The string text and font is retrieved\r
255 successfully.\r
256 @retval EFI_NOT_FOUND The specified text or font info can not be found\r
257 out.\r
258 @retval EFI_OUT_OF_RESOURCES The system is out of resources to accomplish the\r
259 task.\r
260\r
261**/\r
262EFI_STATUS\r
263FindStringBlock (\r
264 IN HII_DATABASE_PRIVATE_DATA *Private,\r
265 IN HII_STRING_PACKAGE_INSTANCE *StringPackage,\r
266 IN EFI_STRING_ID StringId,\r
267 OUT UINT8 *BlockType, OPTIONAL\r
268 OUT UINT8 **StringBlockAddr, OPTIONAL\r
269 OUT UINTN *StringTextOffset, OPTIONAL\r
270 OUT EFI_STRING_ID *LastStringId, OPTIONAL\r
271 OUT EFI_STRING_ID *StartStringId OPTIONAL\r
272 )\r
273{\r
274 UINT8 *BlockHdr;\r
275 EFI_STRING_ID CurrentStringId;\r
276 UINTN BlockSize;\r
277 UINTN Index;\r
278 UINT8 *StringTextPtr;\r
279 UINTN Offset;\r
280 HII_FONT_INFO *LocalFont;\r
281 EFI_FONT_INFO *FontInfo;\r
282 HII_GLOBAL_FONT_INFO *GlobalFont;\r
283 UINTN FontInfoSize;\r
284 UINT16 StringCount;\r
285 UINT16 SkipCount;\r
286 EFI_HII_FONT_STYLE FontStyle;\r
287 UINT16 FontSize;\r
288 UINT8 Length8;\r
289 EFI_HII_SIBT_EXT2_BLOCK Ext2;\r
290 UINT8 FontId;\r
291 UINT32 Length32;\r
292 UINTN StringSize;\r
293 CHAR16 Zero;\r
294\r
295 ASSERT (StringPackage != NULL);\r
296 ASSERT (StringPackage->Signature == HII_STRING_PACKAGE_SIGNATURE);\r
297\r
298 CurrentStringId = 1;\r
299 StringSize = 0;\r
300\r
301 if (StringId != (EFI_STRING_ID) (-1) && StringId != 0) {\r
302 ASSERT (BlockType != NULL && StringBlockAddr != NULL && StringTextOffset != NULL);\r
303 if (StringId > StringPackage->MaxStringId) {\r
304 return EFI_NOT_FOUND;\r
305 }\r
306 } else {\r
307 ASSERT (Private != NULL && Private->Signature == HII_DATABASE_PRIVATE_DATA_SIGNATURE);\r
308 if (StringId == 0 && LastStringId != NULL) {\r
309 *LastStringId = StringPackage->MaxStringId;\r
310 return EFI_SUCCESS;\r
311 }\r
312 }\r
313\r
314 ZeroMem (&Zero, sizeof (CHAR16));\r
315\r
316 //\r
317 // Parse the string blocks to get the string text and font.\r
318 //\r
319 BlockHdr = StringPackage->StringBlock;\r
320 BlockSize = 0;\r
321 Offset = 0;\r
322 while (*BlockHdr != EFI_HII_SIBT_END) {\r
323 switch (*BlockHdr) {\r
324 case EFI_HII_SIBT_STRING_SCSU:\r
325 Offset = sizeof (EFI_HII_STRING_BLOCK);\r
326 StringTextPtr = BlockHdr + Offset;\r
327 BlockSize += Offset + AsciiStrSize ((CHAR8 *) StringTextPtr);\r
328 CurrentStringId++;\r
329 break;\r
330\r
331 case EFI_HII_SIBT_STRING_SCSU_FONT:\r
332 Offset = sizeof (EFI_HII_SIBT_STRING_SCSU_FONT_BLOCK) - sizeof (UINT8);\r
333 StringTextPtr = BlockHdr + Offset;\r
334 BlockSize += Offset + AsciiStrSize ((CHAR8 *) StringTextPtr);\r
335 CurrentStringId++;\r
336 break;\r
337\r
338 case EFI_HII_SIBT_STRINGS_SCSU:\r
339 CopyMem (&StringCount, BlockHdr + sizeof (EFI_HII_STRING_BLOCK), sizeof (UINT16));\r
340 StringTextPtr = (UINT8*)((UINTN)BlockHdr + sizeof (EFI_HII_SIBT_STRINGS_SCSU_BLOCK) - sizeof (UINT8));\r
341 BlockSize += StringTextPtr - BlockHdr;\r
342\r
343 for (Index = 0; Index < StringCount; Index++) {\r
344 BlockSize += AsciiStrSize ((CHAR8 *) StringTextPtr);\r
345 if (CurrentStringId == StringId) {\r
346 ASSERT (BlockType != NULL && StringBlockAddr != NULL && StringTextOffset != NULL);\r
347 *BlockType = *BlockHdr;\r
348 *StringBlockAddr = BlockHdr;\r
349 *StringTextOffset = StringTextPtr - BlockHdr;\r
350 return EFI_SUCCESS;\r
351 }\r
352 StringTextPtr = StringTextPtr + AsciiStrSize ((CHAR8 *) StringTextPtr);\r
353 CurrentStringId++;\r
354 }\r
355 break;\r
356\r
357 case EFI_HII_SIBT_STRINGS_SCSU_FONT:\r
358 CopyMem (\r
359 &StringCount,\r
360 (UINT8*)((UINTN)BlockHdr + sizeof (EFI_HII_STRING_BLOCK) + sizeof (UINT8)),\r
361 sizeof (UINT16)\r
362 );\r
363 StringTextPtr = (UINT8*)((UINTN)BlockHdr + sizeof (EFI_HII_SIBT_STRINGS_SCSU_FONT_BLOCK) - sizeof (UINT8));\r
364 BlockSize += StringTextPtr - BlockHdr;\r
365\r
366 for (Index = 0; Index < StringCount; Index++) {\r
367 BlockSize += AsciiStrSize ((CHAR8 *) StringTextPtr);\r
368 if (CurrentStringId == StringId) {\r
369 ASSERT (BlockType != NULL && StringBlockAddr != NULL && StringTextOffset != NULL);\r
370 *BlockType = *BlockHdr;\r
371 *StringBlockAddr = BlockHdr;\r
372 *StringTextOffset = StringTextPtr - BlockHdr;\r
373 return EFI_SUCCESS;\r
374 }\r
375 StringTextPtr = StringTextPtr + AsciiStrSize ((CHAR8 *) StringTextPtr);\r
376 CurrentStringId++;\r
377 }\r
378 break;\r
379\r
380 case EFI_HII_SIBT_STRING_UCS2:\r
381 Offset = sizeof (EFI_HII_STRING_BLOCK);\r
382 StringTextPtr = BlockHdr + Offset;\r
383 //\r
384 // Use StringSize to store the size of the specified string, including the NULL\r
385 // terminator.\r
386 //\r
387 GetUnicodeStringTextOrSize (NULL, StringTextPtr, &StringSize);\r
388 BlockSize += Offset + StringSize;\r
389 CurrentStringId++;\r
390 break;\r
391\r
392 case EFI_HII_SIBT_STRING_UCS2_FONT:\r
393 Offset = sizeof (EFI_HII_SIBT_STRING_UCS2_FONT_BLOCK) - sizeof (CHAR16);\r
394 StringTextPtr = BlockHdr + Offset;\r
395 //\r
396 // Use StrSize to store the size of the specified string, including the NULL\r
397 // terminator.\r
398 //\r
399 GetUnicodeStringTextOrSize (NULL, StringTextPtr, &StringSize);\r
400 BlockSize += Offset + StringSize;\r
401 CurrentStringId++;\r
402 break;\r
403\r
404 case EFI_HII_SIBT_STRINGS_UCS2:\r
405 Offset = sizeof (EFI_HII_SIBT_STRINGS_UCS2_BLOCK) - sizeof (CHAR16);\r
406 StringTextPtr = BlockHdr + Offset;\r
407 BlockSize += Offset;\r
408 CopyMem (&StringCount, BlockHdr + sizeof (EFI_HII_STRING_BLOCK), sizeof (UINT16));\r
409 for (Index = 0; Index < StringCount; Index++) {\r
410 GetUnicodeStringTextOrSize (NULL, StringTextPtr, &StringSize);\r
411 BlockSize += StringSize;\r
412 if (CurrentStringId == StringId) {\r
413 ASSERT (BlockType != NULL && StringBlockAddr != NULL && StringTextOffset != NULL);\r
414 *BlockType = *BlockHdr;\r
415 *StringBlockAddr = BlockHdr;\r
416 *StringTextOffset = StringTextPtr - BlockHdr;\r
417 return EFI_SUCCESS;\r
418 }\r
419 StringTextPtr = StringTextPtr + StringSize;\r
420 CurrentStringId++;\r
421 }\r
422 break;\r
423\r
424 case EFI_HII_SIBT_STRINGS_UCS2_FONT:\r
425 Offset = sizeof (EFI_HII_SIBT_STRINGS_UCS2_FONT_BLOCK) - sizeof (CHAR16);\r
426 StringTextPtr = BlockHdr + Offset;\r
427 BlockSize += Offset;\r
428 CopyMem (\r
429 &StringCount,\r
430 (UINT8*)((UINTN)BlockHdr + sizeof (EFI_HII_STRING_BLOCK) + sizeof (UINT8)),\r
431 sizeof (UINT16)\r
432 );\r
433 for (Index = 0; Index < StringCount; Index++) {\r
434 GetUnicodeStringTextOrSize (NULL, StringTextPtr, &StringSize);\r
435 BlockSize += StringSize;\r
436 if (CurrentStringId == StringId) {\r
437 ASSERT (BlockType != NULL && StringBlockAddr != NULL && StringTextOffset != NULL);\r
438 *BlockType = *BlockHdr;\r
439 *StringBlockAddr = BlockHdr;\r
440 *StringTextOffset = StringTextPtr - BlockHdr;\r
441 return EFI_SUCCESS;\r
442 }\r
443 StringTextPtr = StringTextPtr + StringSize;\r
444 CurrentStringId++;\r
445 }\r
446 break;\r
447\r
448 case EFI_HII_SIBT_DUPLICATE:\r
449 if (CurrentStringId == StringId) {\r
450 //\r
451 // Incoming StringId is an id of a duplicate string block.\r
452 // Update the StringId to be the previous string block.\r
453 // Go back to the header of string block to search.\r
454 //\r
455 CopyMem (\r
456 &StringId,\r
457 BlockHdr + sizeof (EFI_HII_STRING_BLOCK),\r
458 sizeof (EFI_STRING_ID)\r
459 );\r
460 ASSERT (StringId != CurrentStringId);\r
461 CurrentStringId = 1;\r
462 BlockSize = 0;\r
463 } else {\r
464 BlockSize += sizeof (EFI_HII_SIBT_DUPLICATE_BLOCK);\r
465 CurrentStringId++;\r
466 }\r
467 break;\r
468\r
469 case EFI_HII_SIBT_SKIP1:\r
470 SkipCount = (UINT16) (*(UINT8*)((UINTN)BlockHdr + sizeof (EFI_HII_STRING_BLOCK)));\r
471 CurrentStringId = (UINT16) (CurrentStringId + SkipCount);\r
472 BlockSize += sizeof (EFI_HII_SIBT_SKIP1_BLOCK);\r
473 break;\r
474\r
475 case EFI_HII_SIBT_SKIP2:\r
476 CopyMem (&SkipCount, BlockHdr + sizeof (EFI_HII_STRING_BLOCK), sizeof (UINT16));\r
477 CurrentStringId = (UINT16) (CurrentStringId + SkipCount);\r
478 BlockSize += sizeof (EFI_HII_SIBT_SKIP2_BLOCK);\r
479 break;\r
480\r
481 case EFI_HII_SIBT_EXT1:\r
482 CopyMem (\r
483 &Length8,\r
484 (UINT8*)((UINTN)BlockHdr + sizeof (EFI_HII_STRING_BLOCK) + sizeof (UINT8)),\r
485 sizeof (UINT8)\r
486 );\r
487 BlockSize += Length8;\r
488 break;\r
489\r
490 case EFI_HII_SIBT_EXT2:\r
491 CopyMem (&Ext2, BlockHdr, sizeof (EFI_HII_SIBT_EXT2_BLOCK));\r
492 if (Ext2.BlockType2 == EFI_HII_SIBT_FONT && StringId == (EFI_STRING_ID) (-1)) {\r
493 //\r
494 // Find the relationship between global font info and the font info of\r
495 // this EFI_HII_SIBT_FONT block then backup its information in local package.\r
496 //\r
497 BlockHdr += sizeof (EFI_HII_SIBT_EXT2_BLOCK);\r
498 CopyMem (&FontId, BlockHdr, sizeof (UINT8));\r
499 BlockHdr ++;\r
500 CopyMem (&FontSize, BlockHdr, sizeof (UINT16));\r
501 BlockHdr += sizeof (UINT16);\r
502 CopyMem (&FontStyle, BlockHdr, sizeof (EFI_HII_FONT_STYLE));\r
503 BlockHdr += sizeof (EFI_HII_FONT_STYLE);\r
504 GetUnicodeStringTextOrSize (NULL, BlockHdr, &StringSize);\r
505\r
506 FontInfoSize = sizeof (EFI_FONT_INFO) - sizeof (CHAR16) + StringSize;\r
507 FontInfo = (EFI_FONT_INFO *) AllocateZeroPool (FontInfoSize);\r
508 if (FontInfo == NULL) {\r
509 return EFI_OUT_OF_RESOURCES;\r
510 }\r
511 FontInfo->FontStyle = FontStyle;\r
512 FontInfo->FontSize = FontSize;\r
513 CopyMem (FontInfo->FontName, BlockHdr, StringSize);\r
514\r
515 //\r
516 // If find the corresponding global font info, save the relationship.\r
517 // Otherwise ignore this EFI_HII_SIBT_FONT block.\r
518 //\r
519 if (IsFontInfoExisted (Private, FontInfo, NULL, NULL, &GlobalFont)) {\r
520 ReferFontInfoLocally (Private, StringPackage, FontId, TRUE, GlobalFont, &LocalFont);\r
521 }\r
522\r
523 //\r
524 // Since string package tool set FontId initially to 0 and increases it\r
525 // progressively by one, StringPackage->FondId always represents an unique\r
526 // and available FontId.\r
527 // \r
528 StringPackage->FontId++;\r
529\r
530 FreePool (FontInfo);\r
531 }\r
532\r
533 BlockSize += Ext2.Length;\r
534\r
535 break;\r
536\r
537 case EFI_HII_SIBT_EXT4:\r
538 CopyMem (\r
539 &Length32,\r
540 (UINT8*)((UINTN)BlockHdr + sizeof (EFI_HII_STRING_BLOCK) + sizeof (UINT8)),\r
541 sizeof (UINT32)\r
542 );\r
543\r
544 BlockSize += Length32;\r
545 break;\r
546\r
547 default:\r
548 break;\r
549 }\r
550\r
551 if (StringId > 0 && StringId != (EFI_STRING_ID)(-1)) {\r
552 ASSERT (BlockType != NULL && StringBlockAddr != NULL && StringTextOffset != NULL);\r
553 *BlockType = *BlockHdr;\r
554 *StringBlockAddr = BlockHdr;\r
555 *StringTextOffset = Offset;\r
556\r
557 if (StringId == CurrentStringId - 1) {\r
558 //\r
559 // if only one skip item, return EFI_NOT_FOUND.\r
560 //\r
561 if(*BlockType == EFI_HII_SIBT_SKIP2 || *BlockType == EFI_HII_SIBT_SKIP1) {\r
562 return EFI_NOT_FOUND;\r
563 } else {\r
564 return EFI_SUCCESS;\r
565 }\r
566 }\r
567\r
568 if (StringId < CurrentStringId - 1) {\r
569 return EFI_NOT_FOUND;\r
570 }\r
571 }\r
572 BlockHdr = StringPackage->StringBlock + BlockSize;\r
573 if (StartStringId != NULL) {\r
574 *StartStringId = CurrentStringId;\r
575 }\r
576 }\r
577 \r
578 //\r
579 // Get last string ID\r
580 //\r
581 if (StringId == (EFI_STRING_ID) (-1) && LastStringId != NULL) {\r
582 *LastStringId = (EFI_STRING_ID) (CurrentStringId - 1);\r
583 return EFI_SUCCESS;\r
584 }\r
585\r
586 return EFI_NOT_FOUND;\r
587}\r
588\r
589\r
590/**\r
591 Parse all string blocks to get a string specified by StringId.\r
592\r
593 This is a internal function.\r
594\r
595 @param Private Hii database private structure.\r
596 @param StringPackage Hii string package instance.\r
597 @param StringId The string's id, which is unique within\r
598 PackageList.\r
599 @param String Points to retrieved null-terminated string.\r
600 @param StringSize On entry, points to the size of the buffer pointed\r
601 to by String, in bytes. On return, points to the\r
602 length of the string, in bytes.\r
603 @param StringFontInfo If not NULL, allocate a buffer to record the\r
604 output font info. It's caller's responsibility to\r
605 free this buffer.\r
606\r
607 @retval EFI_SUCCESS The string text and font is retrieved\r
608 successfully.\r
609 @retval EFI_NOT_FOUND The specified text or font info can not be found\r
610 out.\r
611 @retval EFI_BUFFER_TOO_SMALL The buffer specified by StringSize is too small to\r
612 hold the string.\r
613\r
614**/\r
615EFI_STATUS\r
616GetStringWorker (\r
617 IN HII_DATABASE_PRIVATE_DATA *Private,\r
618 IN HII_STRING_PACKAGE_INSTANCE *StringPackage,\r
619 IN EFI_STRING_ID StringId,\r
620 OUT EFI_STRING String,\r
621 IN OUT UINTN *StringSize, OPTIONAL\r
622 OUT EFI_FONT_INFO **StringFontInfo OPTIONAL\r
623 )\r
624{\r
625 UINT8 *StringTextPtr;\r
626 UINT8 BlockType;\r
627 UINT8 *StringBlockAddr;\r
628 UINTN StringTextOffset;\r
629 EFI_STATUS Status;\r
630 UINT8 FontId;\r
631\r
632 ASSERT (StringPackage != NULL);\r
633 ASSERT (Private != NULL && Private->Signature == HII_DATABASE_PRIVATE_DATA_SIGNATURE);\r
634\r
635 //\r
636 // Find the specified string block\r
637 //\r
638 Status = FindStringBlock (\r
639 Private,\r
640 StringPackage,\r
641 StringId,\r
642 &BlockType,\r
643 &StringBlockAddr,\r
644 &StringTextOffset,\r
645 NULL,\r
646 NULL\r
647 );\r
648 if (EFI_ERROR (Status)) {\r
649 return Status;\r
650 }\r
651\r
652 if (StringSize == NULL) {\r
653 //\r
654 // String text buffer is not requested\r
655 //\r
656 return EFI_SUCCESS;\r
657 }\r
658\r
659 //\r
660 // Get the string text.\r
661 //\r
662 StringTextPtr = StringBlockAddr + StringTextOffset;\r
663 switch (BlockType) {\r
664 case EFI_HII_SIBT_STRING_SCSU:\r
665 case EFI_HII_SIBT_STRING_SCSU_FONT:\r
666 case EFI_HII_SIBT_STRINGS_SCSU:\r
667 case EFI_HII_SIBT_STRINGS_SCSU_FONT:\r
668 Status = ConvertToUnicodeText (String, (CHAR8 *) StringTextPtr, StringSize);\r
669 break;\r
670 case EFI_HII_SIBT_STRING_UCS2:\r
671 case EFI_HII_SIBT_STRING_UCS2_FONT:\r
672 case EFI_HII_SIBT_STRINGS_UCS2:\r
673 case EFI_HII_SIBT_STRINGS_UCS2_FONT:\r
674 Status = GetUnicodeStringTextOrSize (String, StringTextPtr, StringSize);\r
675 break;\r
676 default:\r
677 return EFI_NOT_FOUND;\r
678 }\r
679 if (EFI_ERROR (Status)) {\r
680 return Status;\r
681 }\r
682\r
683 //\r
684 // Get the string font. The FontId 0 is the default font for those string blocks which \r
685 // do not specify a font identifier. If default font is not specified, return NULL.\r
686 //\r
687 if (StringFontInfo != NULL) {\r
688 switch (BlockType) {\r
689 case EFI_HII_SIBT_STRING_SCSU_FONT:\r
690 case EFI_HII_SIBT_STRINGS_SCSU_FONT:\r
691 case EFI_HII_SIBT_STRING_UCS2_FONT:\r
692 case EFI_HII_SIBT_STRINGS_UCS2_FONT:\r
693 FontId = *(StringBlockAddr + sizeof (EFI_HII_STRING_BLOCK));\r
694 break;\r
695 default:\r
696 FontId = 0;\r
697 }\r
698 Status = GetStringFontInfo (StringPackage, FontId, StringFontInfo);\r
699 if (Status == EFI_NOT_FOUND) {\r
700 *StringFontInfo = NULL;\r
701 }\r
702 }\r
703\r
704 return EFI_SUCCESS;\r
705}\r
706\r
707/**\r
708 If GetStringBlock find the StringId's string is not saved in the exist string block,\r
709 this function will create the UCS2 string block to save the string; also split the \r
710 skip block into two or one skip block.\r
711\r
712 This is a internal function.\r
713 \r
714 @param StringPackage Hii string package instance.\r
715 @param StartStringId The first id in the skip block which StringId in the block.\r
716 @param StringId The string's id, which is unique within\r
717 PackageList. \r
718 @param BlockType Output the block type of found string block. \r
719 @param StringBlockAddr Output the block address of found string block. \r
720 @param FontBlock whether this string block has font info.\r
721\r
722 @retval EFI_SUCCESS The string font is outputed successfully.\r
723 @retval EFI_OUT_OF_RESOURCES NO resource for the memory to save the new string block.\r
724\r
725**/\r
726EFI_STATUS\r
727InsertLackStringBlock (\r
728 IN OUT HII_STRING_PACKAGE_INSTANCE *StringPackage,\r
729 IN EFI_STRING_ID StartStringId,\r
730 IN EFI_STRING_ID StringId,\r
731 IN OUT UINT8 *BlockType,\r
732 IN OUT UINT8 **StringBlockAddr,\r
733 IN BOOLEAN FontBlock\r
734 )\r
735{\r
736 UINT8 *BlockPtr;\r
737 UINT8 *StringBlock;\r
738 UINT32 SkipLen; \r
739 UINT32 OldBlockSize;\r
740 UINT32 NewBlockSize;\r
741 UINT32 FrontSkipNum;\r
742 UINT32 NewUCSBlockLen;\r
743 UINT8 *OldStringAddr;\r
744 UINT32 IdCount;\r
745\r
746 FrontSkipNum = 0;\r
747 SkipLen = 0;\r
748 OldStringAddr = *StringBlockAddr;\r
749 \r
750 ASSERT (*BlockType == EFI_HII_SIBT_SKIP1 || *BlockType == EFI_HII_SIBT_SKIP2);\r
751 //\r
752 // Old skip block size.\r
753 //\r
754 if (*BlockType == EFI_HII_SIBT_SKIP1) {\r
755 SkipLen = sizeof (EFI_HII_SIBT_SKIP1_BLOCK);\r
756 IdCount = *(UINT8*)(OldStringAddr + sizeof (EFI_HII_STRING_BLOCK));\r
757 } else {\r
758 SkipLen = sizeof (EFI_HII_SIBT_SKIP2_BLOCK);\r
759 IdCount = *(UINT16*)(OldStringAddr + sizeof (EFI_HII_STRING_BLOCK));\r
760 } \r
761\r
762 //\r
763 // New create UCS or UCS2 block size.\r
764 //\r
765 if (FontBlock) {\r
766 NewUCSBlockLen = sizeof (EFI_HII_SIBT_STRING_UCS2_FONT_BLOCK);\r
767 } else {\r
768 NewUCSBlockLen = sizeof (EFI_HII_SIBT_STRING_UCS2_BLOCK);\r
769 }\r
770\r
771 OldBlockSize = StringPackage->StringPkgHdr->Header.Length - StringPackage->StringPkgHdr->HdrSize;\r
772\r
773 if (StartStringId == StringId) {\r
774 //\r
775 // New block + [Skip block]\r
776 //\r
777 if (IdCount > 1) {\r
778 NewBlockSize = OldBlockSize + NewUCSBlockLen;\r
779 } else {\r
780 NewBlockSize = OldBlockSize + NewUCSBlockLen - SkipLen;\r
781 }\r
782 } else if (StartStringId + IdCount - 1 == StringId){\r
783 //\r
784 // Skip block + New block\r
785 //\r
786 NewBlockSize = OldBlockSize + NewUCSBlockLen;\r
787 FrontSkipNum = StringId - StartStringId;\r
788 } else {\r
789 //\r
790 // Skip block + New block + [Skip block]\r
791 //\r
792 NewBlockSize = OldBlockSize + NewUCSBlockLen + SkipLen;\r
793 FrontSkipNum = StringId - StartStringId;\r
794 }\r
795\r
796 StringBlock = (UINT8 *) AllocateZeroPool (NewBlockSize);\r
797 if (StringBlock == NULL) {\r
798 return EFI_OUT_OF_RESOURCES;\r
799 }\r
800\r
801 //\r
802 // Copy old block in front of skip block.\r
803 //\r
804 CopyMem (StringBlock, StringPackage->StringBlock, OldStringAddr - StringPackage->StringBlock); \r
805 BlockPtr = StringBlock + (OldStringAddr - StringPackage->StringBlock);\r
806\r
807 if (FrontSkipNum > 0) {\r
808 *BlockPtr = *BlockType;\r
809 if (*BlockType == EFI_HII_SIBT_SKIP1) {\r
810 *(BlockPtr + sizeof (EFI_HII_STRING_BLOCK)) = (UINT8) FrontSkipNum;\r
811 } else {\r
812 *(UINT16 *)(BlockPtr + sizeof (EFI_HII_STRING_BLOCK)) = (UINT16) FrontSkipNum;\r
813 }\r
814 BlockPtr += SkipLen;\r
815 }\r
816\r
817 //\r
818 // Create a EFI_HII_SIBT_STRING_UCS2_FONT_BLOCK\r
819 //\r
820 *StringBlockAddr = BlockPtr;\r
821 if (FontBlock) {\r
822 *BlockPtr = EFI_HII_SIBT_STRING_UCS2_FONT;\r
823 } else {\r
824 *BlockPtr = EFI_HII_SIBT_STRING_UCS2;\r
825 }\r
826 BlockPtr += NewUCSBlockLen;\r
827\r
828 if (IdCount > FrontSkipNum + 1) {\r
829 *BlockPtr = *BlockType;\r
830 if (*BlockType == EFI_HII_SIBT_SKIP1) {\r
831 *(BlockPtr + sizeof (EFI_HII_STRING_BLOCK)) = (UINT8) (IdCount - FrontSkipNum - 1);\r
832 } else {\r
833 *(UINT16 *)(BlockPtr + sizeof (EFI_HII_STRING_BLOCK)) = (UINT16) (IdCount - FrontSkipNum - 1);\r
834 }\r
835 BlockPtr += SkipLen;\r
836 }\r
837\r
838 //\r
839 // Append a EFI_HII_SIBT_END block to the end.\r
840 //\r
841 CopyMem (BlockPtr, OldStringAddr + SkipLen, OldBlockSize - (OldStringAddr - StringPackage->StringBlock) - SkipLen); \r
842\r
843 if (FontBlock) {\r
844 *BlockType = EFI_HII_SIBT_STRING_UCS2_FONT;\r
845 } else {\r
846 *BlockType = EFI_HII_SIBT_STRING_UCS2;\r
847 }\r
848 FreePool (StringPackage->StringBlock);\r
849 StringPackage->StringBlock = StringBlock;\r
850 StringPackage->StringPkgHdr->Header.Length += NewBlockSize - OldBlockSize;\r
851\r
852 return EFI_SUCCESS;\r
853}\r
854\r
855/**\r
856 Parse all string blocks to set a String specified by StringId.\r
857\r
858 This is a internal function.\r
859\r
860 @param Private HII database driver private structure.\r
861 @param StringPackage HII string package instance.\r
862 @param StringId The string's id, which is unique within\r
863 PackageList.\r
864 @param String Points to the new null-terminated string.\r
865 @param StringFontInfo Points to the input font info.\r
866\r
867 @retval EFI_SUCCESS The string was updated successfully.\r
868 @retval EFI_NOT_FOUND The string specified by StringId is not in the\r
869 database.\r
870 @retval EFI_INVALID_PARAMETER The String or Language was NULL.\r
871 @retval EFI_INVALID_PARAMETER The specified StringFontInfo does not exist in\r
872 current database.\r
873 @retval EFI_OUT_OF_RESOURCES The system is out of resources to accomplish the\r
874 task.\r
875\r
876**/\r
877EFI_STATUS\r
878SetStringWorker (\r
879 IN HII_DATABASE_PRIVATE_DATA *Private,\r
880 IN OUT HII_STRING_PACKAGE_INSTANCE *StringPackage,\r
881 IN EFI_STRING_ID StringId,\r
882 IN EFI_STRING String,\r
883 IN EFI_FONT_INFO *StringFontInfo OPTIONAL\r
884 )\r
885{\r
886 UINT8 *StringTextPtr;\r
887 UINT8 BlockType;\r
888 UINT8 *StringBlockAddr;\r
889 UINTN StringTextOffset;\r
890 EFI_STATUS Status;\r
891 UINT8 *Block;\r
892 UINT8 *BlockPtr;\r
893 UINTN BlockSize;\r
894 UINTN OldBlockSize;\r
895 HII_FONT_INFO *LocalFont;\r
896 HII_GLOBAL_FONT_INFO *GlobalFont;\r
897 BOOLEAN Referred;\r
898 EFI_HII_SIBT_EXT2_BLOCK Ext2;\r
899 UINTN StringSize;\r
900 UINTN TmpSize;\r
901 EFI_STRING_ID StartStringId;\r
902\r
903 StartStringId = 0;\r
904 StringSize = 0;\r
905 ASSERT (Private != NULL && StringPackage != NULL && String != NULL);\r
906 ASSERT (Private->Signature == HII_DATABASE_PRIVATE_DATA_SIGNATURE);\r
907 //\r
908 // Find the specified string block\r
909 //\r
910 Status = FindStringBlock (\r
911 Private,\r
912 StringPackage,\r
913 StringId,\r
914 &BlockType,\r
915 &StringBlockAddr,\r
916 &StringTextOffset,\r
917 NULL,\r
918 &StartStringId\r
919 );\r
920 if (EFI_ERROR (Status) && (BlockType == EFI_HII_SIBT_SKIP1 || BlockType == EFI_HII_SIBT_SKIP2)) {\r
921 Status = InsertLackStringBlock(StringPackage, \r
922 StartStringId, \r
923 StringId, \r
924 &BlockType,\r
925 &StringBlockAddr,\r
926 (BOOLEAN)(StringFontInfo != NULL)\r
927 );\r
928 if (EFI_ERROR (Status)) {\r
929 return Status;\r
930 }\r
931 if (StringFontInfo != NULL) {\r
932 StringTextOffset = sizeof (EFI_HII_SIBT_STRING_UCS2_FONT_BLOCK) - sizeof (CHAR16);\r
933 } else {\r
934 StringTextOffset = sizeof (EFI_HII_SIBT_STRING_UCS2_BLOCK) - sizeof (CHAR16);\r
935 }\r
936 }\r
937\r
938 LocalFont = NULL;\r
939 GlobalFont = NULL;\r
940 Referred = FALSE;\r
941\r
942 //\r
943 // The input StringFontInfo should exist in current database if specified.\r
944 //\r
945 if (StringFontInfo != NULL) {\r
946 if (!IsFontInfoExisted (Private, StringFontInfo, NULL, NULL, &GlobalFont)) {\r
947 return EFI_INVALID_PARAMETER;\r
948 } else {\r
949 Referred = ReferFontInfoLocally (\r
950 Private, \r
951 StringPackage, \r
952 StringPackage->FontId, \r
953 FALSE, \r
954 GlobalFont, \r
955 &LocalFont\r
956 );\r
957 if (!Referred) {\r
958 StringPackage->FontId++;\r
959 }\r
960 }\r
961 //\r
962 // Update the FontId of the specified string block to input font info.\r
963 //\r
964 switch (BlockType) {\r
965 case EFI_HII_SIBT_STRING_SCSU_FONT: \r
966 case EFI_HII_SIBT_STRINGS_SCSU_FONT:\r
967 case EFI_HII_SIBT_STRING_UCS2_FONT:\r
968 case EFI_HII_SIBT_STRINGS_UCS2_FONT:\r
969 *(StringBlockAddr + sizeof (EFI_HII_STRING_BLOCK)) = LocalFont->FontId;\r
970 break;\r
971 default:\r
972 //\r
973 // When modify the font info of these blocks, the block type should be updated\r
974 // to contain font info thus the whole structure should be revised.\r
975 // It is recommended to use tool to modify the block type not in the code.\r
976 // \r
977 return EFI_UNSUPPORTED;\r
978 }\r
979 }\r
980\r
981 OldBlockSize = StringPackage->StringPkgHdr->Header.Length - StringPackage->StringPkgHdr->HdrSize;\r
982\r
983 //\r
984 // Set the string text and font.\r
985 //\r
986 StringTextPtr = StringBlockAddr + StringTextOffset;\r
987 switch (BlockType) {\r
988 case EFI_HII_SIBT_STRING_SCSU:\r
989 case EFI_HII_SIBT_STRING_SCSU_FONT:\r
990 case EFI_HII_SIBT_STRINGS_SCSU:\r
991 case EFI_HII_SIBT_STRINGS_SCSU_FONT:\r
992 BlockSize = OldBlockSize + StrLen (String);\r
993 BlockSize -= AsciiStrSize ((CHAR8 *) StringTextPtr);\r
994 Block = AllocateZeroPool (BlockSize);\r
995 if (Block == NULL) {\r
996 return EFI_OUT_OF_RESOURCES;\r
997 }\r
998\r
999 CopyMem (Block, StringPackage->StringBlock, StringTextPtr - StringPackage->StringBlock);\r
1000 BlockPtr = Block + (StringTextPtr - StringPackage->StringBlock);\r
1001\r
1002 while (*String != 0) {\r
1003 *BlockPtr++ = (CHAR8) *String++;\r
1004 }\r
1005 *BlockPtr++ = 0;\r
1006\r
1007 \r
1008 TmpSize = OldBlockSize - (StringTextPtr - StringPackage->StringBlock) - AsciiStrSize ((CHAR8 *) StringTextPtr);\r
1009 CopyMem (\r
1010 BlockPtr,\r
1011 StringTextPtr + AsciiStrSize ((CHAR8 *)StringTextPtr),\r
1012 TmpSize\r
1013 );\r
1014\r
1015 FreePool (StringPackage->StringBlock);\r
1016 StringPackage->StringBlock = Block;\r
1017 StringPackage->StringPkgHdr->Header.Length += (UINT32) (BlockSize - OldBlockSize);\r
1018 break;\r
1019\r
1020 case EFI_HII_SIBT_STRING_UCS2:\r
1021 case EFI_HII_SIBT_STRING_UCS2_FONT:\r
1022 case EFI_HII_SIBT_STRINGS_UCS2:\r
1023 case EFI_HII_SIBT_STRINGS_UCS2_FONT:\r
1024 //\r
1025 // Use StrSize to store the size of the specified string, including the NULL\r
1026 // terminator.\r
1027 //\r
1028 GetUnicodeStringTextOrSize (NULL, StringTextPtr, &StringSize);\r
1029\r
1030 BlockSize = OldBlockSize + StrSize (String) - StringSize;\r
1031 Block = AllocateZeroPool (BlockSize);\r
1032 if (Block == NULL) {\r
1033 return EFI_OUT_OF_RESOURCES;\r
1034 }\r
1035\r
1036 CopyMem (Block, StringPackage->StringBlock, StringTextPtr - StringPackage->StringBlock);\r
1037 BlockPtr = Block + (StringTextPtr - StringPackage->StringBlock);\r
1038\r
1039 CopyMem (BlockPtr, String, StrSize (String));\r
1040 BlockPtr += StrSize (String);\r
1041\r
1042 CopyMem (\r
1043 BlockPtr,\r
1044 StringTextPtr + StringSize,\r
1045 OldBlockSize - (StringTextPtr - StringPackage->StringBlock) - StringSize\r
1046 );\r
1047\r
1048 FreePool (StringPackage->StringBlock);\r
1049 StringPackage->StringBlock = Block;\r
1050 StringPackage->StringPkgHdr->Header.Length += (UINT32) (BlockSize - OldBlockSize);\r
1051 break;\r
1052\r
1053 default:\r
1054 return EFI_NOT_FOUND;\r
1055 }\r
1056\r
1057 //\r
1058 // Insert a new EFI_HII_SIBT_FONT_BLOCK to the header of string block, if incoming\r
1059 // StringFontInfo does not exist in current string package.\r
1060 //\r
1061 // This new block does not impact on the value of StringId.\r
1062 //\r
1063 //\r
1064 if (StringFontInfo == NULL || Referred) {\r
1065 return EFI_SUCCESS;\r
1066 }\r
1067\r
1068 OldBlockSize = StringPackage->StringPkgHdr->Header.Length - StringPackage->StringPkgHdr->HdrSize;\r
1069 BlockSize = OldBlockSize + sizeof (EFI_HII_SIBT_FONT_BLOCK) - sizeof (CHAR16) +\r
1070 StrSize (GlobalFont->FontInfo->FontName);\r
1071\r
1072 Block = AllocateZeroPool (BlockSize);\r
1073 if (Block == NULL) {\r
1074 return EFI_OUT_OF_RESOURCES;\r
1075 }\r
1076\r
1077 BlockPtr = Block;\r
1078 Ext2.Header.BlockType = EFI_HII_SIBT_EXT2;\r
1079 Ext2.BlockType2 = EFI_HII_SIBT_FONT;\r
1080 Ext2.Length = (UINT16) (BlockSize - OldBlockSize);\r
1081 CopyMem (BlockPtr, &Ext2, sizeof (EFI_HII_SIBT_EXT2_BLOCK));\r
1082 BlockPtr += sizeof (EFI_HII_SIBT_EXT2_BLOCK);\r
1083\r
1084 *BlockPtr = LocalFont->FontId;\r
1085 BlockPtr ++;\r
1086 CopyMem (BlockPtr, &GlobalFont->FontInfo->FontSize, sizeof (UINT16));\r
1087 BlockPtr += sizeof (UINT16);\r
1088 CopyMem (BlockPtr, &GlobalFont->FontInfo->FontStyle, sizeof (UINT32));\r
1089 BlockPtr += sizeof (UINT32);\r
1090 CopyMem (\r
1091 BlockPtr,\r
1092 GlobalFont->FontInfo->FontName,\r
1093 StrSize (GlobalFont->FontInfo->FontName)\r
1094 );\r
1095 BlockPtr += StrSize (GlobalFont->FontInfo->FontName);\r
1096\r
1097 CopyMem (BlockPtr, StringPackage->StringBlock, OldBlockSize);\r
1098\r
1099 FreePool (StringPackage->StringBlock);\r
1100 StringPackage->StringBlock = Block;\r
1101 StringPackage->StringPkgHdr->Header.Length += Ext2.Length;\r
1102\r
1103 return EFI_SUCCESS;\r
1104\r
1105}\r
1106\r
1107\r
1108/**\r
1109 This function adds the string String to the group of strings owned by PackageList, with the\r
1110 specified font information StringFontInfo and returns a new string id. \r
1111 The new string identifier is guaranteed to be unique within the package list. \r
1112 That new string identifier is reserved for all languages in the package list. \r
1113\r
1114\r
1115 @param This A pointer to the EFI_HII_STRING_PROTOCOL instance.\r
1116 @param PackageList Handle of the package list where this string will\r
1117 be added.\r
1118 @param StringId On return, contains the new strings id, which is\r
1119 unique within PackageList.\r
1120 @param Language Points to the language for the new string.\r
1121 @param LanguageName Points to the printable language name to associate\r
1122 with the passed in Language field.If LanguageName\r
1123 is not NULL and the string package header's\r
1124 LanguageName associated with a given Language is\r
1125 not zero, the LanguageName being passed in will\r
1126 be ignored.\r
1127 @param String Points to the new null-terminated string.\r
1128 @param StringFontInfo Points to the new string's font information or\r
1129 NULL if the string should have the default system\r
1130 font, size and style.\r
1131\r
1132 @retval EFI_SUCCESS The new string was added successfully.\r
1133 @retval EFI_NOT_FOUND The specified PackageList could not be found in\r
1134 database.\r
1135 @retval EFI_OUT_OF_RESOURCES Could not add the string due to lack of resources.\r
1136 @retval EFI_INVALID_PARAMETER String is NULL or StringId is NULL or Language is\r
1137 NULL.\r
1138 @retval EFI_INVALID_PARAMETER The specified StringFontInfo does not exist in\r
1139 current database.\r
1140\r
1141**/\r
1142EFI_STATUS\r
1143EFIAPI\r
1144HiiNewString (\r
1145 IN CONST EFI_HII_STRING_PROTOCOL *This,\r
1146 IN EFI_HII_HANDLE PackageList,\r
1147 OUT EFI_STRING_ID *StringId,\r
1148 IN CONST CHAR8 *Language,\r
1149 IN CONST CHAR16 *LanguageName, OPTIONAL\r
1150 IN CONST EFI_STRING String,\r
1151 IN CONST EFI_FONT_INFO *StringFontInfo OPTIONAL\r
1152 )\r
1153{\r
1154 EFI_STATUS Status;\r
1155 LIST_ENTRY *Link;\r
1156 HII_DATABASE_PRIVATE_DATA *Private;\r
1157 HII_DATABASE_RECORD *DatabaseRecord;\r
1158 HII_DATABASE_PACKAGE_LIST_INSTANCE *PackageListNode;\r
1159 HII_STRING_PACKAGE_INSTANCE *StringPackage;\r
1160 UINT32 HeaderSize;\r
1161 UINT32 BlockSize;\r
1162 UINT32 OldBlockSize;\r
1163 UINT8 *StringBlock;\r
1164 UINT8 *BlockPtr;\r
1165 UINT32 Ucs2BlockSize;\r
1166 UINT32 FontBlockSize;\r
1167 UINT32 Ucs2FontBlockSize;\r
1168 EFI_HII_SIBT_EXT2_BLOCK Ext2;\r
1169 HII_FONT_INFO *LocalFont;\r
1170 HII_GLOBAL_FONT_INFO *GlobalFont;\r
1171 EFI_STRING_ID NewStringId;\r
1172 EFI_STRING_ID NextStringId;\r
1173 EFI_STRING_ID Index;\r
1174 HII_STRING_PACKAGE_INSTANCE *MatchStringPackage;\r
1175 BOOLEAN NewStringPackageCreated;\r
1176\r
1177\r
1178 if (This == NULL || String == NULL || StringId == NULL || Language == NULL || PackageList == NULL) {\r
1179 return EFI_INVALID_PARAMETER;\r
1180 }\r
1181\r
1182 if (!IsHiiHandleValid (PackageList)) {\r
1183 return EFI_NOT_FOUND;\r
1184 }\r
1185\r
1186 Private = HII_STRING_DATABASE_PRIVATE_DATA_FROM_THIS (This);\r
1187 GlobalFont = NULL;\r
1188\r
1189 //\r
1190 // If StringFontInfo specify a paritcular font, it should exist in current database.\r
1191 //\r
1192 if (StringFontInfo != NULL) {\r
1193 if (!IsFontInfoExisted (Private, (EFI_FONT_INFO *) StringFontInfo, NULL, NULL, &GlobalFont)) {\r
1194 return EFI_INVALID_PARAMETER;\r
1195 }\r
1196 }\r
1197\r
1198 //\r
1199 // Get the matching package list.\r
1200 //\r
1201 PackageListNode = NULL;\r
1202 for (Link = Private->DatabaseList.ForwardLink; Link != &Private->DatabaseList; Link = Link->ForwardLink) {\r
1203 DatabaseRecord = CR (Link, HII_DATABASE_RECORD, DatabaseEntry, HII_DATABASE_RECORD_SIGNATURE);\r
1204 if (DatabaseRecord->Handle == PackageList) {\r
1205 PackageListNode = DatabaseRecord->PackageList;\r
1206 break;\r
1207 }\r
1208 }\r
1209 if (PackageListNode == NULL) {\r
1210 return EFI_NOT_FOUND;\r
1211 }\r
1212\r
1213 Status = EFI_SUCCESS;\r
1214 NewStringPackageCreated = FALSE;\r
1215 NewStringId = 0;\r
1216 NextStringId = 0;\r
1217 StringPackage = NULL;\r
1218 MatchStringPackage = NULL;\r
1219 for (Link = PackageListNode->StringPkgHdr.ForwardLink;\r
1220 Link != &PackageListNode->StringPkgHdr;\r
1221 Link = Link->ForwardLink\r
1222 ) {\r
1223 StringPackage = CR (Link, HII_STRING_PACKAGE_INSTANCE, StringEntry, HII_STRING_PACKAGE_SIGNATURE);\r
1224 //\r
1225 // Create a string block and corresponding font block if exists, then append them\r
1226 // to the end of the string package.\r
1227 //\r
1228 Status = FindStringBlock (\r
1229 Private,\r
1230 StringPackage,\r
1231 0,\r
1232 NULL,\r
1233 NULL,\r
1234 NULL,\r
1235 &NextStringId,\r
1236 NULL\r
1237 );\r
1238 if (EFI_ERROR (Status)) {\r
1239 goto Done;\r
1240 }\r
1241 //\r
1242 // Make sure that new StringId is same in all String Packages for the different language.\r
1243 //\r
1244 if (NewStringId != 0 && NewStringId != NextStringId) {\r
1245 ASSERT (FALSE);\r
1246 Status = EFI_INVALID_PARAMETER;\r
1247 goto Done;\r
1248 }\r
1249 NewStringId = NextStringId;\r
1250 //\r
1251 // Get the matched string package with language.\r
1252 //\r
1253 if (HiiCompareLanguage (StringPackage->StringPkgHdr->Language, (CHAR8 *) Language)) {\r
1254 MatchStringPackage = StringPackage;\r
1255 } else {\r
1256 OldBlockSize = StringPackage->StringPkgHdr->Header.Length - StringPackage->StringPkgHdr->HdrSize;\r
1257 //\r
1258 // Create a blank EFI_HII_SIBT_STRING_UCS2_BLOCK to reserve new string ID.\r
1259 //\r
1260 Ucs2BlockSize = (UINT32) sizeof (EFI_HII_SIBT_STRING_UCS2_BLOCK);\r
1261\r
1262 StringBlock = (UINT8 *) AllocateZeroPool (OldBlockSize + Ucs2BlockSize);\r
1263 if (StringBlock == NULL) {\r
1264 Status = EFI_OUT_OF_RESOURCES;\r
1265 goto Done;\r
1266 }\r
1267 //\r
1268 // Copy original string blocks, except the EFI_HII_SIBT_END.\r
1269 //\r
1270 CopyMem (StringBlock, StringPackage->StringBlock, OldBlockSize - sizeof (EFI_HII_SIBT_END_BLOCK));\r
1271 //\r
1272 // Create a blank EFI_HII_SIBT_STRING_UCS2 block\r
1273 //\r
1274 BlockPtr = StringBlock + OldBlockSize - sizeof (EFI_HII_SIBT_END_BLOCK);\r
1275 *BlockPtr = EFI_HII_SIBT_STRING_UCS2;\r
1276 BlockPtr += sizeof (EFI_HII_SIBT_STRING_UCS2_BLOCK);\r
1277\r
1278 //\r
1279 // Append a EFI_HII_SIBT_END block to the end.\r
1280 //\r
1281 *BlockPtr = EFI_HII_SIBT_END;\r
1282 FreePool (StringPackage->StringBlock);\r
1283 StringPackage->StringBlock = StringBlock;\r
1284 StringPackage->StringPkgHdr->Header.Length += Ucs2BlockSize;\r
1285 PackageListNode->PackageListHdr.PackageLength += Ucs2BlockSize;\r
1286 }\r
1287 }\r
1288 if (NewStringId == 0) {\r
1289 //\r
1290 // No string package is found.\r
1291 // Create new string package. StringId 1 is reserved for Language Name string.\r
1292 //\r
1293 *StringId = 2;\r
1294 } else {\r
1295 //\r
1296 // Set new StringId\r
1297 //\r
1298 *StringId = (EFI_STRING_ID) (NewStringId + 1);\r
1299 }\r
1300\r
1301 if (MatchStringPackage != NULL) {\r
1302 StringPackage = MatchStringPackage;\r
1303 } else {\r
1304 //\r
1305 // LanguageName is required to create a new string package.\r
1306 //\r
1307 if (LanguageName == NULL) {\r
1308 Status = EFI_INVALID_PARAMETER;\r
1309 goto Done;\r
1310 }\r
1311\r
1312 StringPackage = AllocateZeroPool (sizeof (HII_STRING_PACKAGE_INSTANCE));\r
1313 if (StringPackage == NULL) {\r
1314 Status = EFI_OUT_OF_RESOURCES;\r
1315 goto Done;\r
1316 }\r
1317\r
1318 StringPackage->Signature = HII_STRING_PACKAGE_SIGNATURE;\r
1319 StringPackage->MaxStringId = *StringId;\r
1320 StringPackage->FontId = 0;\r
1321 InitializeListHead (&StringPackage->FontInfoList);\r
1322\r
1323 //\r
1324 // Fill in the string package header\r
1325 //\r
1326 HeaderSize = (UINT32) (AsciiStrSize ((CHAR8 *) Language) - 1 + sizeof (EFI_HII_STRING_PACKAGE_HDR));\r
1327 StringPackage->StringPkgHdr = AllocateZeroPool (HeaderSize);\r
1328 if (StringPackage->StringPkgHdr == NULL) {\r
1329 FreePool (StringPackage);\r
1330 Status = EFI_OUT_OF_RESOURCES;\r
1331 goto Done;\r
1332 }\r
1333 StringPackage->StringPkgHdr->Header.Type = EFI_HII_PACKAGE_STRINGS;\r
1334 StringPackage->StringPkgHdr->HdrSize = HeaderSize;\r
1335 StringPackage->StringPkgHdr->StringInfoOffset = HeaderSize;\r
1336 CopyMem (StringPackage->StringPkgHdr->LanguageWindow, mLanguageWindow, 16 * sizeof (CHAR16));\r
1337 StringPackage->StringPkgHdr->LanguageName = 1;\r
1338 AsciiStrCpyS (StringPackage->StringPkgHdr->Language, (HeaderSize - OFFSET_OF(EFI_HII_STRING_PACKAGE_HDR,Language)) / sizeof (CHAR8), (CHAR8 *) Language);\r
1339\r
1340 //\r
1341 // Calculate the length of the string blocks, including string block to record\r
1342 // printable language full name and EFI_HII_SIBT_END_BLOCK.\r
1343 //\r
1344 Ucs2BlockSize = (UINT32) (StrSize ((CHAR16 *) LanguageName) + \r
1345 (*StringId - 1) * sizeof (EFI_HII_SIBT_STRING_UCS2_BLOCK) - sizeof (CHAR16));\r
1346\r
1347 BlockSize = Ucs2BlockSize + sizeof (EFI_HII_SIBT_END_BLOCK);\r
1348 StringPackage->StringBlock = (UINT8 *) AllocateZeroPool (BlockSize);\r
1349 if (StringPackage->StringBlock == NULL) {\r
1350 FreePool (StringPackage->StringPkgHdr);\r
1351 FreePool (StringPackage);\r
1352 Status = EFI_OUT_OF_RESOURCES;\r
1353 goto Done;\r
1354 }\r
1355\r
1356 //\r
1357 // Insert the string block of printable language full name\r
1358 //\r
1359 BlockPtr = StringPackage->StringBlock;\r
1360 *BlockPtr = EFI_HII_SIBT_STRING_UCS2;\r
1361 BlockPtr += sizeof (EFI_HII_STRING_BLOCK);\r
1362 CopyMem (BlockPtr, (EFI_STRING) LanguageName, StrSize ((EFI_STRING) LanguageName));\r
1363 BlockPtr += StrSize ((EFI_STRING) LanguageName);\r
1364 for (Index = 2; Index <= *StringId - 1; Index ++) {\r
1365 *BlockPtr = EFI_HII_SIBT_STRING_UCS2;\r
1366 BlockPtr += sizeof (EFI_HII_SIBT_STRING_UCS2_BLOCK);\r
1367 }\r
1368 //\r
1369 // Insert the end block\r
1370 //\r
1371 *BlockPtr = EFI_HII_SIBT_END;\r
1372\r
1373 //\r
1374 // Append this string package node to string package array in this package list.\r
1375 //\r
1376 StringPackage->StringPkgHdr->Header.Length = HeaderSize + BlockSize;\r
1377 PackageListNode->PackageListHdr.PackageLength += StringPackage->StringPkgHdr->Header.Length;\r
1378 InsertTailList (&PackageListNode->StringPkgHdr, &StringPackage->StringEntry);\r
1379 NewStringPackageCreated = TRUE;\r
1380 }\r
1381\r
1382 OldBlockSize = StringPackage->StringPkgHdr->Header.Length - StringPackage->StringPkgHdr->HdrSize;\r
1383\r
1384 if (StringFontInfo == NULL) {\r
1385 //\r
1386 // Create a EFI_HII_SIBT_STRING_UCS2_BLOCK since font info is not specified.\r
1387 //\r
1388 Ucs2BlockSize = (UINT32) (StrSize (String) + sizeof (EFI_HII_SIBT_STRING_UCS2_BLOCK)\r
1389 - sizeof (CHAR16));\r
1390\r
1391 StringBlock = (UINT8 *) AllocateZeroPool (OldBlockSize + Ucs2BlockSize);\r
1392 if (StringBlock == NULL) {\r
1393 Status = EFI_OUT_OF_RESOURCES;\r
1394 goto Done;\r
1395 }\r
1396 //\r
1397 // Copy original string blocks, except the EFI_HII_SIBT_END.\r
1398 //\r
1399 CopyMem (StringBlock, StringPackage->StringBlock, OldBlockSize - sizeof (EFI_HII_SIBT_END_BLOCK));\r
1400 //\r
1401 // Create a EFI_HII_SIBT_STRING_UCS2 block\r
1402 //\r
1403 BlockPtr = StringBlock + OldBlockSize - sizeof (EFI_HII_SIBT_END_BLOCK);\r
1404 *BlockPtr = EFI_HII_SIBT_STRING_UCS2;\r
1405 BlockPtr += sizeof (EFI_HII_STRING_BLOCK);\r
1406 CopyMem (BlockPtr, (EFI_STRING) String, StrSize ((EFI_STRING) String));\r
1407 BlockPtr += StrSize ((EFI_STRING) String);\r
1408\r
1409 //\r
1410 // Append a EFI_HII_SIBT_END block to the end.\r
1411 //\r
1412 *BlockPtr = EFI_HII_SIBT_END;\r
1413 FreePool (StringPackage->StringBlock);\r
1414 StringPackage->StringBlock = StringBlock;\r
1415 StringPackage->StringPkgHdr->Header.Length += Ucs2BlockSize;\r
1416 PackageListNode->PackageListHdr.PackageLength += Ucs2BlockSize;\r
1417\r
1418 } else {\r
1419 //\r
1420 // StringFontInfo is specified here. If there is a EFI_HII_SIBT_FONT_BLOCK\r
1421 // which refers to this font info, create a EFI_HII_SIBT_STRING_UCS2_FONT block\r
1422 // only. Otherwise create a EFI_HII_SIBT_FONT block with a EFI_HII_SIBT_STRING\r
1423 // _UCS2_FONT block.\r
1424 //\r
1425 Ucs2FontBlockSize = (UINT32) (StrSize (String) + sizeof (EFI_HII_SIBT_STRING_UCS2_FONT_BLOCK) -\r
1426 sizeof (CHAR16));\r
1427 if (ReferFontInfoLocally (Private, StringPackage, StringPackage->FontId, FALSE, GlobalFont, &LocalFont)) {\r
1428 //\r
1429 // Create a EFI_HII_SIBT_STRING_UCS2_FONT block only.\r
1430 //\r
1431 StringBlock = (UINT8 *) AllocateZeroPool (OldBlockSize + Ucs2FontBlockSize);\r
1432 if (StringBlock == NULL) {\r
1433 Status = EFI_OUT_OF_RESOURCES;\r
1434 goto Done;\r
1435 }\r
1436 //\r
1437 // Copy original string blocks, except the EFI_HII_SIBT_END.\r
1438 //\r
1439 CopyMem (StringBlock, StringPackage->StringBlock, OldBlockSize - sizeof (EFI_HII_SIBT_END_BLOCK));\r
1440 //\r
1441 // Create a EFI_HII_SIBT_STRING_UCS2_FONT_BLOCK\r
1442 //\r
1443 BlockPtr = StringBlock + OldBlockSize - sizeof (EFI_HII_SIBT_END_BLOCK);\r
1444 *BlockPtr = EFI_HII_SIBT_STRING_UCS2_FONT;\r
1445 BlockPtr += sizeof (EFI_HII_STRING_BLOCK);\r
1446 *BlockPtr = LocalFont->FontId;\r
1447 BlockPtr ++;\r
1448 CopyMem (BlockPtr, (EFI_STRING) String, StrSize ((EFI_STRING) String));\r
1449 BlockPtr += StrSize ((EFI_STRING) String);\r
1450\r
1451 //\r
1452 // Append a EFI_HII_SIBT_END block to the end.\r
1453 //\r
1454 *BlockPtr = EFI_HII_SIBT_END;\r
1455 FreePool (StringPackage->StringBlock);\r
1456 StringPackage->StringBlock = StringBlock;\r
1457 StringPackage->StringPkgHdr->Header.Length += Ucs2FontBlockSize;\r
1458 PackageListNode->PackageListHdr.PackageLength += Ucs2FontBlockSize;\r
1459\r
1460 } else {\r
1461 //\r
1462 // EFI_HII_SIBT_FONT_BLOCK does not exist in current string package, so\r
1463 // create a EFI_HII_SIBT_FONT block to record the font info, then generate\r
1464 // a EFI_HII_SIBT_STRING_UCS2_FONT block to record the incoming string.\r
1465 //\r
1466 FontBlockSize = (UINT32) (StrSize (((EFI_FONT_INFO *) StringFontInfo)->FontName) +\r
1467 sizeof (EFI_HII_SIBT_FONT_BLOCK) - sizeof (CHAR16));\r
1468 StringBlock = (UINT8 *) AllocateZeroPool (OldBlockSize + FontBlockSize + Ucs2FontBlockSize);\r
1469 if (StringBlock == NULL) {\r
1470 Status = EFI_OUT_OF_RESOURCES;\r
1471 goto Done;\r
1472 }\r
1473 //\r
1474 // Copy original string blocks, except the EFI_HII_SIBT_END.\r
1475 //\r
1476 CopyMem (StringBlock, StringPackage->StringBlock, OldBlockSize - sizeof (EFI_HII_SIBT_END_BLOCK));\r
1477\r
1478 //\r
1479 // Create a EFI_HII_SIBT_FONT block firstly and then backup its info in string\r
1480 // package instance for future reference.\r
1481 //\r
1482 BlockPtr = StringBlock + OldBlockSize - sizeof (EFI_HII_SIBT_END_BLOCK);\r
1483\r
1484 Ext2.Header.BlockType = EFI_HII_SIBT_EXT2;\r
1485 Ext2.BlockType2 = EFI_HII_SIBT_FONT;\r
1486 Ext2.Length = (UINT16) FontBlockSize;\r
1487 CopyMem (BlockPtr, &Ext2, sizeof (EFI_HII_SIBT_EXT2_BLOCK));\r
1488 BlockPtr += sizeof (EFI_HII_SIBT_EXT2_BLOCK);\r
1489\r
1490 *BlockPtr = LocalFont->FontId;\r
1491 BlockPtr ++;\r
1492 CopyMem (BlockPtr, &((EFI_FONT_INFO *) StringFontInfo)->FontSize, sizeof (UINT16));\r
1493 BlockPtr += sizeof (UINT16);\r
1494 CopyMem (BlockPtr, &((EFI_FONT_INFO *) StringFontInfo)->FontStyle, sizeof (EFI_HII_FONT_STYLE));\r
1495 BlockPtr += sizeof (EFI_HII_FONT_STYLE);\r
1496 CopyMem (\r
1497 BlockPtr,\r
1498 &((EFI_FONT_INFO *) StringFontInfo)->FontName,\r
1499 StrSize (((EFI_FONT_INFO *) StringFontInfo)->FontName)\r
1500 );\r
1501 BlockPtr += StrSize (((EFI_FONT_INFO *) StringFontInfo)->FontName);\r
1502 //\r
1503 // Create a EFI_HII_SIBT_STRING_UCS2_FONT_BLOCK\r
1504 //\r
1505 *BlockPtr = EFI_HII_SIBT_STRING_UCS2_FONT;\r
1506 BlockPtr += sizeof (EFI_HII_STRING_BLOCK);\r
1507 *BlockPtr = LocalFont->FontId;\r
1508 BlockPtr ++;\r
1509 CopyMem (BlockPtr, (EFI_STRING) String, StrSize ((EFI_STRING) String));\r
1510 BlockPtr += StrSize ((EFI_STRING) String);\r
1511\r
1512 //\r
1513 // Append a EFI_HII_SIBT_END block to the end.\r
1514 //\r
1515 *BlockPtr = EFI_HII_SIBT_END;\r
1516 FreePool (StringPackage->StringBlock);\r
1517 StringPackage->StringBlock = StringBlock;\r
1518 StringPackage->StringPkgHdr->Header.Length += FontBlockSize + Ucs2FontBlockSize;\r
1519 PackageListNode->PackageListHdr.PackageLength += FontBlockSize + Ucs2FontBlockSize;\r
1520\r
1521 //\r
1522 // Increase the FontId to make it unique since we already add \r
1523 // a EFI_HII_SIBT_FONT block to this string package.\r
1524 //\r
1525 StringPackage->FontId++;\r
1526 }\r
1527 }\r
1528\r
1529Done:\r
1530 if (!EFI_ERROR (Status) && NewStringPackageCreated) {\r
1531 //\r
1532 // Trigger any registered notification function for new string package\r
1533 //\r
1534 Status = InvokeRegisteredFunction (\r
1535 Private,\r
1536 EFI_HII_DATABASE_NOTIFY_NEW_PACK,\r
1537 (VOID *) StringPackage,\r
1538 EFI_HII_PACKAGE_STRINGS,\r
1539 PackageList\r
1540 );\r
1541 }\r
1542\r
1543 if (!EFI_ERROR (Status)) {\r
1544 //\r
1545 // Update MaxString Id to new StringId\r
1546 //\r
1547 for (Link = PackageListNode->StringPkgHdr.ForwardLink;\r
1548 Link != &PackageListNode->StringPkgHdr;\r
1549 Link = Link->ForwardLink\r
1550 ) {\r
1551 StringPackage = CR (Link, HII_STRING_PACKAGE_INSTANCE, StringEntry, HII_STRING_PACKAGE_SIGNATURE);\r
1552 StringPackage->MaxStringId = *StringId;\r
1553 }\r
1554 } else if (NewStringPackageCreated) {\r
1555 //\r
1556 // Free the allocated new string Package when new string can't be added.\r
1557 //\r
1558 RemoveEntryList (&StringPackage->StringEntry);\r
1559 FreePool (StringPackage->StringBlock);\r
1560 FreePool (StringPackage->StringPkgHdr);\r
1561 FreePool (StringPackage);\r
1562 }\r
1563\r
1564 return Status;\r
1565}\r
1566\r
1567\r
1568/**\r
1569 This function retrieves the string specified by StringId which is associated\r
1570 with the specified PackageList in the language Language and copies it into\r
1571 the buffer specified by String.\r
1572\r
1573 @param This A pointer to the EFI_HII_STRING_PROTOCOL instance.\r
1574 @param Language Points to the language for the retrieved string.\r
1575 @param PackageList The package list in the HII database to search for\r
1576 the specified string.\r
1577 @param StringId The string's id, which is unique within\r
1578 PackageList.\r
1579 @param String Points to the new null-terminated string.\r
1580 @param StringSize On entry, points to the size of the buffer pointed\r
1581 to by String, in bytes. On return, points to the\r
1582 length of the string, in bytes.\r
1583 @param StringFontInfo If not NULL, points to the string's font\r
1584 information. It's caller's responsibility to free\r
1585 this buffer.\r
1586\r
1587 @retval EFI_SUCCESS The string was returned successfully.\r
1588 @retval EFI_NOT_FOUND The string specified by StringId is not available.\r
1589 @retval EFI_NOT_FOUND The string specified by StringId is available but\r
1590 not in the specified language.\r
1591 The specified PackageList is not in the database.\r
1592 @retval EFI_INVALID_LANGUAGE - The string specified by StringId is available but\r
1593 @retval EFI_BUFFER_TOO_SMALL The buffer specified by StringSize is too small to\r
1594 hold the string.\r
1595 @retval EFI_INVALID_PARAMETER The Language or StringSize was NULL.\r
1596 @retval EFI_INVALID_PARAMETER The value referenced by StringSize was not zero and String was NULL.\r
1597 @retval EFI_OUT_OF_RESOURCES There were insufficient resources to complete the\r
1598 request.\r
1599\r
1600**/\r
1601EFI_STATUS\r
1602EFIAPI\r
1603HiiGetString (\r
1604 IN CONST EFI_HII_STRING_PROTOCOL *This,\r
1605 IN CONST CHAR8 *Language,\r
1606 IN EFI_HII_HANDLE PackageList,\r
1607 IN EFI_STRING_ID StringId,\r
1608 OUT EFI_STRING String,\r
1609 IN OUT UINTN *StringSize,\r
1610 OUT EFI_FONT_INFO **StringFontInfo OPTIONAL\r
1611 )\r
1612{\r
1613 EFI_STATUS Status;\r
1614 LIST_ENTRY *Link;\r
1615 HII_DATABASE_PRIVATE_DATA *Private;\r
1616 HII_DATABASE_RECORD *DatabaseRecord;\r
1617 HII_DATABASE_PACKAGE_LIST_INSTANCE *PackageListNode;\r
1618 HII_STRING_PACKAGE_INSTANCE *StringPackage;\r
1619\r
1620 if (This == NULL || Language == NULL || StringId < 1 || StringSize == NULL || PackageList == NULL) {\r
1621 return EFI_INVALID_PARAMETER;\r
1622 }\r
1623\r
1624 if (String == NULL && *StringSize != 0) {\r
1625 return EFI_INVALID_PARAMETER;\r
1626 }\r
1627\r
1628 if (!IsHiiHandleValid (PackageList)) {\r
1629 return EFI_NOT_FOUND;\r
1630 }\r
1631\r
1632 Private = HII_STRING_DATABASE_PRIVATE_DATA_FROM_THIS (This);\r
1633 PackageListNode = NULL;\r
1634\r
1635 for (Link = Private->DatabaseList.ForwardLink; Link != &Private->DatabaseList; Link = Link->ForwardLink) {\r
1636 DatabaseRecord = CR (Link, HII_DATABASE_RECORD, DatabaseEntry, HII_DATABASE_RECORD_SIGNATURE);\r
1637 if (DatabaseRecord->Handle == PackageList) {\r
1638 PackageListNode = DatabaseRecord->PackageList;\r
1639 break;\r
1640 }\r
1641 }\r
1642\r
1643 if (PackageListNode != NULL) {\r
1644 //\r
1645 // First search: to match the StringId in the specified language.\r
1646 //\r
1647 for (Link = PackageListNode->StringPkgHdr.ForwardLink;\r
1648 Link != &PackageListNode->StringPkgHdr;\r
1649 Link = Link->ForwardLink\r
1650 ) {\r
1651 StringPackage = CR (Link, HII_STRING_PACKAGE_INSTANCE, StringEntry, HII_STRING_PACKAGE_SIGNATURE);\r
1652 if (HiiCompareLanguage (StringPackage->StringPkgHdr->Language, (CHAR8 *) Language)) {\r
1653 Status = GetStringWorker (Private, StringPackage, StringId, String, StringSize, StringFontInfo);\r
1654 if (Status != EFI_NOT_FOUND) {\r
1655 return Status;\r
1656 }\r
1657 }\r
1658 }\r
1659 //\r
1660 // Second search: to match the StringId in other available languages if exist.\r
1661 //\r
1662 for (Link = PackageListNode->StringPkgHdr.ForwardLink; \r
1663 Link != &PackageListNode->StringPkgHdr;\r
1664 Link = Link->ForwardLink\r
1665 ) {\r
1666 StringPackage = CR (Link, HII_STRING_PACKAGE_INSTANCE, StringEntry, HII_STRING_PACKAGE_SIGNATURE); \r
1667 Status = GetStringWorker (Private, StringPackage, StringId, NULL, NULL, NULL);\r
1668 if (!EFI_ERROR (Status)) {\r
1669 return EFI_INVALID_LANGUAGE;\r
1670 }\r
1671 } \r
1672 }\r
1673\r
1674 return EFI_NOT_FOUND;\r
1675}\r
1676\r
1677\r
1678\r
1679/**\r
1680 This function updates the string specified by StringId in the specified PackageList to the text\r
1681 specified by String and, optionally, the font information specified by StringFontInfo.\r
1682\r
1683 @param This A pointer to the EFI_HII_STRING_PROTOCOL instance.\r
1684 @param PackageList The package list containing the strings.\r
1685 @param StringId The string's id, which is unique within\r
1686 PackageList.\r
1687 @param Language Points to the language for the updated string.\r
1688 @param String Points to the new null-terminated string.\r
1689 @param StringFontInfo Points to the string's font information or NULL if\r
1690 the string font information is not changed.\r
1691\r
1692 @retval EFI_SUCCESS The string was updated successfully.\r
1693 @retval EFI_NOT_FOUND The string specified by StringId is not in the\r
1694 database.\r
1695 @retval EFI_INVALID_PARAMETER The String or Language was NULL.\r
1696 @retval EFI_INVALID_PARAMETER The specified StringFontInfo does not exist in\r
1697 current database.\r
1698 @retval EFI_OUT_OF_RESOURCES The system is out of resources to accomplish the\r
1699 task.\r
1700\r
1701**/\r
1702EFI_STATUS\r
1703EFIAPI\r
1704HiiSetString (\r
1705 IN CONST EFI_HII_STRING_PROTOCOL *This,\r
1706 IN EFI_HII_HANDLE PackageList,\r
1707 IN EFI_STRING_ID StringId,\r
1708 IN CONST CHAR8 *Language,\r
1709 IN CONST EFI_STRING String,\r
1710 IN CONST EFI_FONT_INFO *StringFontInfo OPTIONAL\r
1711 )\r
1712{\r
1713 EFI_STATUS Status;\r
1714 LIST_ENTRY *Link;\r
1715 HII_DATABASE_PRIVATE_DATA *Private;\r
1716 HII_DATABASE_RECORD *DatabaseRecord;\r
1717 HII_DATABASE_PACKAGE_LIST_INSTANCE *PackageListNode;\r
1718 HII_STRING_PACKAGE_INSTANCE *StringPackage;\r
1719 UINT32 OldPackageLen;\r
1720\r
1721 if (This == NULL || Language == NULL || StringId < 1 || String == NULL || PackageList == NULL) {\r
1722 return EFI_INVALID_PARAMETER;\r
1723 }\r
1724\r
1725 if (!IsHiiHandleValid (PackageList)) {\r
1726 return EFI_NOT_FOUND;\r
1727 }\r
1728\r
1729 Private = HII_STRING_DATABASE_PRIVATE_DATA_FROM_THIS (This);\r
1730 PackageListNode = NULL;\r
1731\r
1732 for (Link = Private->DatabaseList.ForwardLink; Link != &Private->DatabaseList; Link = Link->ForwardLink) {\r
1733 DatabaseRecord = CR (Link, HII_DATABASE_RECORD, DatabaseEntry, HII_DATABASE_RECORD_SIGNATURE);\r
1734 if (DatabaseRecord->Handle == PackageList) {\r
1735 PackageListNode = (HII_DATABASE_PACKAGE_LIST_INSTANCE *) (DatabaseRecord->PackageList);\r
1736 }\r
1737 }\r
1738\r
1739 if (PackageListNode != NULL) {\r
1740 for (Link = PackageListNode->StringPkgHdr.ForwardLink;\r
1741 Link != &PackageListNode->StringPkgHdr;\r
1742 Link = Link->ForwardLink\r
1743 ) {\r
1744 StringPackage = CR (Link, HII_STRING_PACKAGE_INSTANCE, StringEntry, HII_STRING_PACKAGE_SIGNATURE);\r
1745 if (HiiCompareLanguage (StringPackage->StringPkgHdr->Language, (CHAR8 *) Language)) {\r
1746 OldPackageLen = StringPackage->StringPkgHdr->Header.Length;\r
1747 Status = SetStringWorker (\r
1748 Private,\r
1749 StringPackage,\r
1750 StringId,\r
1751 (EFI_STRING) String,\r
1752 (EFI_FONT_INFO *) StringFontInfo\r
1753 );\r
1754 if (EFI_ERROR (Status)) {\r
1755 return Status;\r
1756 }\r
1757 PackageListNode->PackageListHdr.PackageLength += StringPackage->StringPkgHdr->Header.Length - OldPackageLen;\r
1758 return EFI_SUCCESS;\r
1759 }\r
1760 }\r
1761 }\r
1762\r
1763 return EFI_NOT_FOUND;\r
1764}\r
1765\r
1766\r
1767\r
1768/**\r
1769 This function returns the list of supported languages, in the format specified\r
1770 in Appendix M of UEFI 2.1 spec.\r
1771\r
1772 @param This A pointer to the EFI_HII_STRING_PROTOCOL instance.\r
1773 @param PackageList The package list to examine.\r
1774 @param Languages Points to the buffer to hold the returned\r
1775 null-terminated ASCII string.\r
1776 @param LanguagesSize On entry, points to the size of the buffer pointed\r
1777 to by Languages, in bytes. On return, points to\r
1778 the length of Languages, in bytes.\r
1779\r
1780 @retval EFI_SUCCESS The languages were returned successfully.\r
1781 @retval EFI_INVALID_PARAMETER The LanguagesSize was NULL.\r
1782 @retval EFI_INVALID_PARAMETER The value referenced by LanguagesSize is not zero and Languages is NULL.\r
1783 @retval EFI_BUFFER_TOO_SMALL The LanguagesSize is too small to hold the list of\r
1784 supported languages. LanguageSize is updated to\r
1785 contain the required size.\r
1786 @retval EFI_NOT_FOUND Could not find string package in specified\r
1787 packagelist.\r
1788\r
1789**/\r
1790EFI_STATUS\r
1791EFIAPI\r
1792HiiGetLanguages (\r
1793 IN CONST EFI_HII_STRING_PROTOCOL *This,\r
1794 IN EFI_HII_HANDLE PackageList,\r
1795 IN OUT CHAR8 *Languages,\r
1796 IN OUT UINTN *LanguagesSize\r
1797 )\r
1798{\r
1799 LIST_ENTRY *Link;\r
1800 HII_DATABASE_PRIVATE_DATA *Private;\r
1801 HII_DATABASE_RECORD *DatabaseRecord;\r
1802 HII_DATABASE_PACKAGE_LIST_INSTANCE *PackageListNode;\r
1803 HII_STRING_PACKAGE_INSTANCE *StringPackage;\r
1804 UINTN ResultSize;\r
1805\r
1806 if (This == NULL || LanguagesSize == NULL || PackageList == NULL) {\r
1807 return EFI_INVALID_PARAMETER;\r
1808 }\r
1809 if (*LanguagesSize != 0 && Languages == NULL) {\r
1810 return EFI_INVALID_PARAMETER;\r
1811 }\r
1812 if (!IsHiiHandleValid (PackageList)) {\r
1813 return EFI_NOT_FOUND;\r
1814 }\r
1815\r
1816 Private = HII_STRING_DATABASE_PRIVATE_DATA_FROM_THIS (This);\r
1817\r
1818 PackageListNode = NULL;\r
1819 for (Link = Private->DatabaseList.ForwardLink; Link != &Private->DatabaseList; Link = Link->ForwardLink) {\r
1820 DatabaseRecord = CR (Link, HII_DATABASE_RECORD, DatabaseEntry, HII_DATABASE_RECORD_SIGNATURE);\r
1821 if (DatabaseRecord->Handle == PackageList) {\r
1822 PackageListNode = DatabaseRecord->PackageList;\r
1823 break;\r
1824 }\r
1825 }\r
1826 if (PackageListNode == NULL) {\r
1827 return EFI_NOT_FOUND;\r
1828 }\r
1829\r
1830 //\r
1831 // Search the languages in the specified packagelist.\r
1832 //\r
1833 ResultSize = 0;\r
1834 for (Link = PackageListNode->StringPkgHdr.ForwardLink;\r
1835 Link != &PackageListNode->StringPkgHdr;\r
1836 Link = Link->ForwardLink\r
1837 ) {\r
1838 StringPackage = CR (Link, HII_STRING_PACKAGE_INSTANCE, StringEntry, HII_STRING_PACKAGE_SIGNATURE);\r
1839 ResultSize += AsciiStrSize (StringPackage->StringPkgHdr->Language);\r
1840 if (ResultSize <= *LanguagesSize) {\r
1841 AsciiStrCpyS (Languages, *LanguagesSize / sizeof (CHAR8), StringPackage->StringPkgHdr->Language);\r
1842 Languages += AsciiStrSize (StringPackage->StringPkgHdr->Language);\r
1843 *(Languages - 1) = L';';\r
1844 }\r
1845 }\r
1846 if (ResultSize == 0) {\r
1847 return EFI_NOT_FOUND;\r
1848 }\r
1849\r
1850 if (*LanguagesSize < ResultSize) {\r
1851 *LanguagesSize = ResultSize;\r
1852 return EFI_BUFFER_TOO_SMALL;\r
1853 }\r
1854\r
1855 *(Languages - 1) = 0;\r
1856 return EFI_SUCCESS;\r
1857}\r
1858\r
1859\r
1860/**\r
1861 Each string package has associated with it a single primary language and zero\r
1862 or more secondary languages. This routine returns the secondary languages\r
1863 associated with a package list.\r
1864\r
1865 @param This A pointer to the EFI_HII_STRING_PROTOCOL instance.\r
1866 @param PackageList The package list to examine.\r
1867 @param PrimaryLanguage Points to the null-terminated ASCII string that specifies\r
1868 the primary language. Languages are specified in the\r
1869 format specified in Appendix M of the UEFI 2.0 specification.\r
1870 @param SecondaryLanguages Points to the buffer to hold the returned null-terminated\r
1871 ASCII string that describes the list of\r
1872 secondary languages for the specified\r
1873 PrimaryLanguage. If there are no secondary\r
1874 languages, the function returns successfully, but\r
1875 this is set to NULL.\r
1876 @param SecondaryLanguagesSize On entry, points to the size of the buffer pointed\r
1877 to by SecondaryLanguages, in bytes. On return,\r
1878 points to the length of SecondaryLanguages in bytes.\r
1879\r
1880 @retval EFI_SUCCESS Secondary languages were correctly returned.\r
1881 @retval EFI_INVALID_PARAMETER PrimaryLanguage or SecondaryLanguagesSize was NULL.\r
1882 @retval EFI_INVALID_PARAMETER The value referenced by SecondaryLanguagesSize is not\r
1883 zero and SecondaryLanguages is NULL.\r
1884 @retval EFI_BUFFER_TOO_SMALL The buffer specified by SecondaryLanguagesSize is\r
1885 too small to hold the returned information.\r
1886 SecondaryLanguageSize is updated to hold the size of\r
1887 the buffer required.\r
1888 @retval EFI_INVALID_LANGUAGE The language specified by PrimaryLanguage is not\r
1889 present in the specified package list.\r
1890 @retval EFI_NOT_FOUND The specified PackageList is not in the Database.\r
1891\r
1892**/\r
1893EFI_STATUS\r
1894EFIAPI\r
1895HiiGetSecondaryLanguages (\r
1896 IN CONST EFI_HII_STRING_PROTOCOL *This,\r
1897 IN EFI_HII_HANDLE PackageList,\r
1898 IN CONST CHAR8 *PrimaryLanguage,\r
1899 IN OUT CHAR8 *SecondaryLanguages,\r
1900 IN OUT UINTN *SecondaryLanguagesSize\r
1901 )\r
1902{\r
1903 LIST_ENTRY *Link;\r
1904 LIST_ENTRY *Link1;\r
1905 HII_DATABASE_PRIVATE_DATA *Private;\r
1906 HII_DATABASE_RECORD *DatabaseRecord;\r
1907 HII_DATABASE_PACKAGE_LIST_INSTANCE *PackageListNode;\r
1908 HII_STRING_PACKAGE_INSTANCE *StringPackage;\r
1909 CHAR8 *Languages;\r
1910 UINTN ResultSize;\r
1911\r
1912 if (This == NULL || PackageList == NULL || PrimaryLanguage == NULL || SecondaryLanguagesSize == NULL) {\r
1913 return EFI_INVALID_PARAMETER;\r
1914 }\r
1915 if (SecondaryLanguages == NULL && *SecondaryLanguagesSize != 0) {\r
1916 return EFI_INVALID_PARAMETER;\r
1917 }\r
1918 if (!IsHiiHandleValid (PackageList)) {\r
1919 return EFI_NOT_FOUND;\r
1920 }\r
1921\r
1922 Private = HII_STRING_DATABASE_PRIVATE_DATA_FROM_THIS (This);\r
1923\r
1924 PackageListNode = NULL; \r
1925 for (Link = Private->DatabaseList.ForwardLink; Link != &Private->DatabaseList; Link = Link->ForwardLink) {\r
1926 DatabaseRecord = CR (Link, HII_DATABASE_RECORD, DatabaseEntry, HII_DATABASE_RECORD_SIGNATURE);\r
1927 if (DatabaseRecord->Handle == PackageList) {\r
1928 PackageListNode = (HII_DATABASE_PACKAGE_LIST_INSTANCE *) (DatabaseRecord->PackageList);\r
1929 break;\r
1930 }\r
1931 }\r
1932 if (PackageListNode == NULL) {\r
1933 return EFI_NOT_FOUND;\r
1934 }\r
1935 \r
1936 Languages = NULL;\r
1937 ResultSize = 0;\r
1938 for (Link1 = PackageListNode->StringPkgHdr.ForwardLink;\r
1939 Link1 != &PackageListNode->StringPkgHdr;\r
1940 Link1 = Link1->ForwardLink\r
1941 ) {\r
1942 StringPackage = CR (Link1, HII_STRING_PACKAGE_INSTANCE, StringEntry, HII_STRING_PACKAGE_SIGNATURE);\r
1943 if (HiiCompareLanguage (StringPackage->StringPkgHdr->Language, (CHAR8 *) PrimaryLanguage)) {\r
1944 Languages = StringPackage->StringPkgHdr->Language;\r
1945 //\r
1946 // Language is a series of ';' terminated strings, first one is primary\r
1947 // language and following with other secondary languages or NULL if no\r
1948 // secondary languages any more.\r
1949 //\r
1950 Languages = AsciiStrStr (Languages, ";");\r
1951 if (Languages == NULL) {\r
1952 break;\r
1953 }\r
1954 Languages++;\r
1955\r
1956 ResultSize = AsciiStrSize (Languages);\r
1957 if (ResultSize <= *SecondaryLanguagesSize) {\r
1958 AsciiStrCpyS (SecondaryLanguages, *SecondaryLanguagesSize / sizeof (CHAR8), Languages);\r
1959 } else {\r
1960 *SecondaryLanguagesSize = ResultSize;\r
1961 return EFI_BUFFER_TOO_SMALL;\r
1962 }\r
1963\r
1964 return EFI_SUCCESS;\r
1965 }\r
1966 }\r
1967\r
1968 return EFI_INVALID_LANGUAGE;\r
1969}\r
1970\r
1971/**\r
1972 Converts the ascii character of the string from uppercase to lowercase.\r
1973 This is a internal function.\r
1974\r
1975 @param ConfigString String to be converted\r
1976\r
1977**/\r
1978VOID\r
1979EFIAPI\r
1980AsciiHiiToLower (\r
1981 IN CHAR8 *ConfigString\r
1982 )\r
1983{\r
1984 ASSERT (ConfigString != NULL);\r
1985\r
1986 //\r
1987 // Convert all hex digits in range [A-F] in the configuration header to [a-f]\r
1988 //\r
1989 for (; *ConfigString != '\0'; ConfigString++) {\r
1990 if ( *ConfigString >= 'A' && *ConfigString <= 'Z') {\r
1991 *ConfigString = (CHAR8) (*ConfigString - 'A' + 'a');\r
1992 }\r
1993 }\r
1994}\r
1995\r
1996/**\r
1997 Compare whether two names of languages are identical.\r
1998\r
1999 @param Language1 Name of language 1 from StringPackage\r
2000 @param Language2 Name of language 2 to be compared with language 1.\r
2001\r
2002 @retval TRUE same\r
2003 @retval FALSE not same\r
2004\r
2005**/\r
2006BOOLEAN\r
2007HiiCompareLanguage (\r
2008 IN CHAR8 *Language1,\r
2009 IN CHAR8 *Language2\r
2010 )\r
2011{\r
2012 UINTN Index;\r
2013 UINTN StrLen;\r
2014 CHAR8 *Lan1;\r
2015 CHAR8 *Lan2;\r
2016\r
2017 //\r
2018 // Convert to lower to compare.\r
2019 //\r
2020 StrLen = AsciiStrSize (Language1);\r
2021 Lan1 = AllocateZeroPool (StrLen);\r
2022 ASSERT (Lan1 != NULL);\r
2023 AsciiStrCpyS(Lan1, StrLen / sizeof (CHAR8), Language1);\r
2024 AsciiHiiToLower (Lan1);\r
2025\r
2026 StrLen = AsciiStrSize (Language2);\r
2027 Lan2 = AllocateZeroPool (StrLen);\r
2028 ASSERT (Lan2 != NULL);\r
2029 AsciiStrCpyS(Lan2, StrLen / sizeof (CHAR8), Language2);\r
2030 AsciiHiiToLower (Lan2);\r
2031\r
2032 //\r
2033 // Compare the Primary Language in Language1 to Language2\r
2034 //\r
2035 for (Index = 0; Lan1[Index] != 0 && Lan1[Index] != ';'; Index++) {\r
2036 if (Lan1[Index] != Lan2[Index]) {\r
2037 //\r
2038 // Return FALSE if any characters are different.\r
2039 //\r
2040 FreePool (Lan1);\r
2041 FreePool (Lan2);\r
2042 return FALSE;\r
2043 }\r
2044 }\r
2045\r
2046 FreePool (Lan1);\r
2047 FreePool (Lan2);\r
2048\r
2049 //\r
2050 // Only return TRUE if Language2[Index] is a Null-terminator which means\r
2051 // the Primary Language in Language1 is the same length as Language2. If\r
2052 // Language2[Index] is not a Null-terminator, then Language2 is longer than\r
2053 // the Primary Language in Language1, and FALSE must be returned.\r
2054 //\r
2055 return (BOOLEAN) (Language2[Index] == 0);\r
2056}\r
EFI Development Kit II mirror for PVE