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