1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
|
/*++
Copyright (c) 2006, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Module Name:
Strings.c
Abstract:
This file contains the string processing code to the HII database.
--*/
#include "HiiDatabase.h"
VOID
AsciiToUnicode (
IN UINT8 *Lang,
IN UINT16 *Language
)
{
UINT8 Count;
//
// Convert the ASCII Lang variable to a Unicode Language variable
//
for (Count = 0; Count < 3; Count++) {
Language[Count] = (CHAR16) Lang[Count];
}
}
EFI_STATUS
EFIAPI
HiiTestString (
IN EFI_HII_PROTOCOL *This,
IN CHAR16 *StringToTest,
IN OUT UINT32 *FirstMissing,
OUT UINT32 *GlyphBufferSize
)
/*++
Routine Description:
Test if all of the characters in a string have corresponding font characters.
Arguments:
Returns:
--*/
{
EFI_HII_GLOBAL_DATA *GlobalData;
EFI_HII_DATA *HiiData;
UINTN Count;
BOOLEAN Narrow;
UINTN Location;
UINT8 GlyphCol1[19];
if (This == NULL) {
return EFI_INVALID_PARAMETER;
}
HiiData = EFI_HII_DATA_FROM_THIS (This);
GlobalData = HiiData->GlobalData;
Count = 0;
Narrow = TRUE;
ZeroMem (GlyphCol1, sizeof (GlyphCol1));
//
// Walk through the string until you hit the null terminator
//
for (; StringToTest[*FirstMissing] != 0x00; (*FirstMissing)++) {
Location = *FirstMissing;
//
// Rewind through the string looking for a glyph width identifier
//
for (; Location != 0; Location--) {
if (StringToTest[Location] == NARROW_CHAR || StringToTest[Location] == WIDE_CHAR) {
//
// We found something that identifies what glyph database to look in
//
if (StringToTest[Location] == WIDE_CHAR) {
Narrow = FALSE;
} else {
Narrow = TRUE;
}
}
}
if (Narrow) {
if (CompareMem (
GlobalData->NarrowGlyphs[StringToTest[*FirstMissing]].GlyphCol1,
&mUnknownGlyph,
NARROW_GLYPH_ARRAY_SIZE
) == 0
) {
//
// Break since this glyph isn't defined
//
return EFI_NOT_FOUND;
}
} else {
//
// Can compare wide glyph against only GlyphCol1 since GlyphCol1 and GlyphCol2 are contiguous - just give correct size
//
if (CompareMem (
GlobalData->WideGlyphs[StringToTest[*FirstMissing]].GlyphCol1,
&mUnknownGlyph,
WIDE_GLYPH_ARRAY_SIZE
) == 0
) {
//
// Break since this glyph isn't defined
//
return EFI_NOT_FOUND;
}
}
Count++;
}
if (Narrow) {
*GlyphBufferSize = (UINT32) (Count * sizeof (EFI_NARROW_GLYPH));
} else {
*GlyphBufferSize = (UINT32) (Count * sizeof (EFI_WIDE_GLYPH));
}
return EFI_SUCCESS;
}
EFI_STATUS
HiiNewString2 (
IN EFI_HII_PROTOCOL *This,
IN CHAR16 *Language,
IN EFI_HII_HANDLE Handle,
IN OUT STRING_REF *Reference,
IN CHAR16 *NewString,
IN BOOLEAN ResetStrings
)
/*++
Routine Description:
This function allows a new String to be added to an already existing String Package.
We will make a buffer the size of the package + EfiStrSize of the new string. We will
copy the string package that first gets changed and the following language packages until
we encounter the NULL string package. All this time we will ensure that the offsets have
been adjusted.
Arguments:
This - Pointer to the HII protocol.
Language - Pointer to buffer which contains the language code of this NewString.
Handle - Handle of the package instance to be processed.
Reference - The token number for the string. If 0, new string token to be returned through this parameter.
NewString - Buffer pointer for the new string.
ResetStrings - Indicate if we are resetting a string.
Returns:
EFI_SUCCESS - The string has been added or reset to Hii database.
EFI_INVALID_PARAMETER - Some parameter passed in is invalid.
--*/
{
EFI_HII_PACKAGE_INSTANCE *PackageInstance;
EFI_HII_PACKAGE_INSTANCE *StringPackageInstance;
EFI_HII_DATA *HiiData;
EFI_HII_STRING_PACK *StringPack;
EFI_HII_STRING_PACK *NewStringPack;
EFI_HII_HANDLE_DATABASE *HandleDatabase;
EFI_HII_PACKAGE_INSTANCE *NewBuffer;
UINT8 *Location;
UINT8 *StringLocation;
RELOFST *StringPointer;
UINTN Count;
UINTN Size;
UINTN Index;
UINTN SecondIndex;
BOOLEAN AddString;
EFI_STATUS Status;
UINTN Increment;
UINTN StringCount;
UINT32 TotalStringCount;
UINT32 OriginalStringCount;
RELOFST StringSize;
UINT32 Length;
RELOFST Offset;
if (This == NULL) {
return EFI_INVALID_PARAMETER;
}
HiiData = EFI_HII_DATA_FROM_THIS (This);
HandleDatabase = HiiData->DatabaseHead;
PackageInstance = NULL;
AddString = FALSE;
Increment = 0;
StringCount = 0;
TotalStringCount = 0;
OriginalStringCount = 0;
//
// Check numeric value against the head of the database
//
for (; HandleDatabase != NULL; HandleDatabase = HandleDatabase->NextHandleDatabase) {
//
// Match the numeric value with the database entry - if matched, extract PackageInstance
//
if (Handle == HandleDatabase->Handle) {
PackageInstance = HandleDatabase->Buffer;
if (ResetStrings) {
TotalStringCount = HandleDatabase->NumberOfTokens;
}
break;
}
}
//
// No handle was found - error condition
//
if (PackageInstance == NULL) {
return EFI_INVALID_PARAMETER;
}
Status = ValidatePack (This, PackageInstance, &StringPackageInstance, &TotalStringCount);
//
// This sets Count to 0 or the size of the IfrData. We intend to use Count as an offset value
//
Count = StringPackageInstance->IfrSize;
//
// This is the size of the complete series of string packs
//
Size = StringPackageInstance->StringSize;
//
// Based on if there is IFR data in this package instance, determine
// what the location is of the beginning of the string data.
//
if (StringPackageInstance->IfrSize > 0) {
Location = (UINT8 *) (&StringPackageInstance->IfrData) + StringPackageInstance->IfrSize;
} else {
Location = (UINT8 *) (&StringPackageInstance->IfrData);
}
//
// We allocate a buffer which is big enough for both adding and resetting string.
// The size is slightly larger than the real size of the packages when we are resetting a string.
//
NewBuffer = AllocateZeroPool (
sizeof (EFI_HII_PACKAGE_INSTANCE) -
2 * sizeof (VOID *) +
StringPackageInstance->IfrSize +
StringPackageInstance->StringSize +
sizeof (RELOFST) +
StrSize (NewString)
);
ASSERT (NewBuffer);
//
// Copy data to new buffer
//
NewBuffer->Handle = StringPackageInstance->Handle;
NewBuffer->IfrSize = StringPackageInstance->IfrSize;
//
// The worst case scenario for sizing is that we are adding a new string (not replacing one) and there was not a string
// package to begin with.
//
NewBuffer->StringSize = StringPackageInstance->StringSize + StrSize (NewString) + sizeof (EFI_HII_STRING_PACK);
if (StringPackageInstance->IfrSize > 0) {
CopyMem (&NewBuffer->IfrData, &StringPackageInstance->IfrData, StringPackageInstance->IfrSize);
}
StringPack = (EFI_HII_STRING_PACK *) Location;
//
// There may be multiple instances packed together of strings
// so we must walk the self describing structures until we encounter
// what we are looking for. In the meantime, copy everything we encounter
// to the new buffer.
//
CopyMem (&Length, &StringPack->Header.Length, sizeof (UINT32));
for (; Length != 0;) {
//
// If passed in Language ISO value is in this string pack's language string
// then we are dealing with the strings we want.
//
CopyMem (&Offset, &StringPack->LanguageNameString, sizeof (RELOFST));
Status = HiiCompareLanguage ((CHAR16 *) ((CHAR8 *) (StringPack) + Offset), Language);
if (!EFI_ERROR (Status)) {
break;
}
CopyMem (((CHAR8 *) (&NewBuffer->IfrData) + Count), StringPack, Length);
Count = Count + Length;
StringPack = (EFI_HII_STRING_PACK *) ((CHAR8 *) (StringPack) + Length);
CopyMem (&Length, &StringPack->Header.Length, sizeof (UINT32));
}
//
// Found the language pack to update on a particular handle
// We need to Copy the Contents of this pack and adjust the offset values associated
// with adding/changing a string. This is a particular piece of code that screams for
// it being prone to programming error.
//
//
// Copy the string package up to the string data
//
StringPointer = (RELOFST *) (StringPack + 1);
CopyMem (
((CHAR8 *) (&NewBuffer->IfrData) + Count),
StringPack,
(UINTN) ((UINTN) (StringPointer) - (UINTN) (StringPack))
);
//
// Determine the number of StringPointers
//
if (!ResetStrings) {
CopyMem (&TotalStringCount, &StringPack->NumStringPointers, sizeof (RELOFST));
} else {
//
// If we are resetting the strings, use the original value when exported
//
CopyMem (&OriginalStringCount, &StringPack->NumStringPointers, sizeof (RELOFST));
((EFI_HII_STRING_PACK *) ((CHAR8 *) (&NewBuffer->IfrData) + Count))->LanguageNameString -=
(
(RELOFST) (OriginalStringCount - TotalStringCount) *
sizeof (RELOFST)
);
((EFI_HII_STRING_PACK *) ((CHAR8 *) (&NewBuffer->IfrData) + Count))->PrintableLanguageName -=
(
(RELOFST) (OriginalStringCount - TotalStringCount) *
sizeof (RELOFST)
);
((EFI_HII_STRING_PACK *) ((CHAR8 *) (&NewBuffer->IfrData) + Count))->NumStringPointers = TotalStringCount;
*Reference = (STRING_REF) (TotalStringCount);
}
//
// If the token value is not valid, error out
//
if ((*Reference >= TotalStringCount) && !ResetStrings) {
gBS->FreePool (NewBuffer);
return EFI_INVALID_PARAMETER;
}
//
// If Reference is 0, update it with what the new token reference will be and turn the AddString flag on
//
if (*Reference == 0) {
*Reference = (STRING_REF) (TotalStringCount);
AddString = TRUE;
}
if (AddString) {
((EFI_HII_STRING_PACK *) ((CHAR8 *) (&NewBuffer->IfrData) + Count))->LanguageNameString += sizeof (RELOFST);
((EFI_HII_STRING_PACK *) ((CHAR8 *) (&NewBuffer->IfrData) + Count))->PrintableLanguageName += sizeof (RELOFST);
((EFI_HII_STRING_PACK *) ((CHAR8 *) (&NewBuffer->IfrData) + Count))->NumStringPointers++;
}
//
// Increment offset by amount of copied data
//
Count = Count + ((UINTN) (StringPointer) - (UINTN) StringPack);
for (Index = 0; Index < TotalStringCount; Index++) {
//
// If we are pointing to the size of the changing string value
// then cache the old string value so you know what the difference is
//
if (Index == *Reference) {
CopyMem (&Offset, &StringPointer[Index], sizeof (RELOFST));
StringLocation = ((UINT8 *) (StringPack) + Offset);
for (SecondIndex = 0;
(StringLocation[SecondIndex] != 0) || (StringLocation[SecondIndex + 1] != 0);
SecondIndex = SecondIndex + 2
)
;
SecondIndex = SecondIndex + 2;
Size = SecondIndex;
//
// NewString is a passed in local string which is assumed to be aligned
//
Size = StrSize (NewString) - Size;
}
//
// If we are about to copy the offset of the string that follows the changed string make
// sure that the offsets are adjusted accordingly
//
if ((Index > *Reference) && !ResetStrings) {
CopyMem (&Offset, &StringPointer[Index], sizeof (RELOFST));
Offset = (RELOFST) (Offset + Size);
CopyMem (&StringPointer[Index], &Offset, sizeof (RELOFST));
}
//
// If we are adding a string that means we will have an extra string pointer that will affect all string offsets
//
if (AddString) {
CopyMem (&Offset, &StringPointer[Index], sizeof (RELOFST));
Offset = (UINT32) (Offset + sizeof (RELOFST));
CopyMem (&StringPointer[Index], &Offset, sizeof (RELOFST));
}
//
// If resetting the strings, we need to reduce the offset by the difference in the strings
//
if (ResetStrings) {
CopyMem (&Length, &StringPointer[Index], sizeof (RELOFST));
Length = Length - ((RELOFST) (OriginalStringCount - TotalStringCount) * sizeof (RELOFST));
CopyMem (&StringPointer[Index], &Length, sizeof (RELOFST));
}
//
// Notice that if the string was being added as a new token, we don't have to worry about the
// offsets changing in the other indexes
//
CopyMem (((CHAR8 *) (&NewBuffer->IfrData) + Count), &StringPointer[Index], sizeof (RELOFST));
Count = Count + sizeof (RELOFST);
StringCount++;
}
//
// If we are adding a new string the above for loop did not copy the offset for us
//
if (AddString) {
//
// Since the Index is pointing to the beginning of the first string, we need to gather the size of the previous
// offset's string and create an offset to our new string.
//
CopyMem (&Offset, &StringPointer[Index - 1], sizeof (RELOFST));
StringLocation = (UINT8 *) StringPack;
StringLocation = StringLocation + Offset - sizeof (RELOFST);
//
// Since StringPack is a packed structure, we need to size it carefully (byte-wise) to avoid alignment issues
//
for (Length = 0;
(StringLocation[Length] != 0) || (StringLocation[Length + 1] != 0);
Length = (RELOFST) (Length + 2)
)
;
Length = (RELOFST) (Length + 2);
StringSize = (RELOFST) (Offset + Length);
//
// Copy the new string offset
//
CopyMem (((CHAR8 *) (&NewBuffer->IfrData) + Count), &StringSize, sizeof (RELOFST));
Count = Count + sizeof (RELOFST);
CopyMem (&Length, &StringPack->Header.Length, sizeof (UINT32));
Length = Length + sizeof (RELOFST);
CopyMem (&StringPack->Header.Length, &Length, sizeof (UINT32));
}
//
// Set Location to the First String
//
if (ResetStrings) {
Index = OriginalStringCount;
}
//
// Set Location to the First String
//
Location = (UINT8 *) &StringPointer[Index];
Index = 0;
//
// Keep copying strings until you run into two CHAR16's in a row that are NULL
//
do {
if ((*Reference == Increment) && !AddString) {
StringLocation = ((UINT8 *) (&NewBuffer->IfrData) + Count);
CopyMem (StringLocation, NewString, StrSize (NewString));
//
// Advance the destination location by Count number of bytes
//
Count = Count + StrSize (NewString);
//
// Add the difference between the new string and the old string to the length
//
CopyMem (&Length, &StringPack->Header.Length, sizeof (UINT32));
//
// Since StringPack is a packed structure, we need to size it carefully (byte-wise) to avoid alignment issues
//
StringLocation = (UINT8 *) &Location[Index];
for (Offset = 0;
(StringLocation[Offset] != 0) || (StringLocation[Offset + 1] != 0);
Offset = (RELOFST) (Offset + 2)
)
;
Offset = (RELOFST) (Offset + 2);
Length = Length + (UINT32) StrSize (NewString) - Offset;
CopyMem (&StringPack->Header.Length, &Length, sizeof (UINT32));
} else {
StringLocation = (UINT8 *) &Location[Index];
for (Offset = 0;
(StringLocation[Offset] != 0) || (StringLocation[Offset + 1] != 0);
Offset = (RELOFST) (Offset + 2)
)
;
Offset = (RELOFST) (Offset + 2);
CopyMem (((CHAR8 *) (&NewBuffer->IfrData) + Count), StringLocation, Offset);
//
// Advance the destination location by Count number of bytes
//
Count = Count + Offset;
}
//
// Retrieve the number of characters to advance the index - should land at beginning of next string
//
Index = Index + Offset;
Increment++;
StringCount--;
Offset = 0;
} while (StringCount > 0);
//
// If we are adding a new string, then the above do/while will not suffice
//
if (AddString) {
Offset = (RELOFST) StrSize (NewString);
CopyMem (((CHAR8 *) (&NewBuffer->IfrData) + Count), NewString, Offset);
Count = Count + StrSize (NewString);
CopyMem (&Length, &StringPack->Header.Length, sizeof (UINT32));
Length = Length + (UINT32) StrSize (NewString);
CopyMem (&StringPack->Header.Length, &Length, sizeof (UINT32));
}
if (ResetStrings) {
//
// Skip the remainder of strings in the string package
//
StringCount = OriginalStringCount - TotalStringCount;
while (StringCount > 0) {
StringLocation = (UINT8 *) &Location[Index];
for (Offset = 0;
(StringLocation[Offset] != 0) || (StringLocation[Offset + 1] != 0);
Offset = (RELOFST) (Offset + 2)
)
;
Offset = (RELOFST) (Offset + 2);
Index = Index + Offset;
StringCount--;
//
// Adjust the size of the string pack by the string size we just skipped.
// Also reduce the length by the size of a RelativeOffset value since we
// obviously would have skipped that as well.
//
CopyMem (&Length, &StringPack->Header.Length, sizeof (UINT32));
Length = Length - Offset - sizeof (RELOFST);
CopyMem (&StringPack->Header.Length, &Length, sizeof (UINT32));
}
}
StringPack = (EFI_HII_STRING_PACK *) &Location[Index];
CopyMem (&Length, &StringPack->Header.Length, sizeof (UINT32));
for (; Length != 0;) {
CopyMem (((CHAR8 *) (&NewBuffer->IfrData) + Count), StringPack, Length);
Count = Count + Length;
StringPack = (EFI_HII_STRING_PACK *) ((CHAR8 *) (StringPack) + Length);
CopyMem (&Length, &StringPack->Header.Length, sizeof (UINT32));
}
//
// Copy the null terminator to the new buffer
//
CopyMem (((CHAR8 *) (&NewBuffer->IfrData) + Count), StringPack, sizeof (EFI_HII_STRING_PACK));
//
// Based on if there is IFR data in this package instance, determine
// what the location is of the beginning of the string data.
//
if (StringPackageInstance->IfrSize > 0) {
Location = (UINT8 *) (&StringPackageInstance->IfrData) + StringPackageInstance->IfrSize;
StringPack = (EFI_HII_STRING_PACK *) Location;
Location = (UINT8 *) (&NewBuffer->IfrData) + NewBuffer->IfrSize;
NewStringPack = (EFI_HII_STRING_PACK *) Location;
} else {
StringPack = (EFI_HII_STRING_PACK *) (&StringPackageInstance->IfrData);
NewStringPack = (EFI_HII_STRING_PACK *) (&NewBuffer->IfrData);
}
CopyMem (&Length, &StringPack->Header.Length, sizeof (UINT32));
for (; Length != 0;) {
//
// Since we updated the old version of the string data as we moved things over
// And we had a chicken-egg problem with the data we copied, let's post-fix the new
// buffer with accurate length data.
//
CopyMem (&Count, &NewStringPack->Header.Length, sizeof (UINT32));
CopyMem (&NewStringPack->Header.Length, &StringPack->Header.Length, sizeof (UINT32));
CopyMem (&StringPack->Header.Length, &Count, sizeof (UINT32));
CopyMem (&Count, &NewStringPack->Header.Length, sizeof (UINT32));
NewStringPack = (EFI_HII_STRING_PACK *) ((CHAR8 *) (NewStringPack) + Count);
CopyMem (&Count, &StringPack->Header.Length, sizeof (UINT32));
StringPack = (EFI_HII_STRING_PACK *) ((CHAR8 *) (StringPack) + Count);
CopyMem (&Length, &StringPack->Header.Length, sizeof (UINT32));
}
GetPackSize ((VOID *) ((CHAR8 *) (&NewBuffer->IfrData) + NewBuffer->IfrSize), &NewBuffer->StringSize, NULL);
//
// Search through the handles until the requested handle is found.
//
for (HandleDatabase = HiiData->DatabaseHead;
HandleDatabase->Handle != 0;
HandleDatabase = HandleDatabase->NextHandleDatabase
) {
if (HandleDatabase->Handle == StringPackageInstance->Handle) {
//
// Free the previous buffer associated with this handle, and assign the new buffer to the handle
//
gBS->FreePool (HandleDatabase->Buffer);
HandleDatabase->Buffer = NewBuffer;
break;
}
}
return EFI_SUCCESS;
}
EFI_STATUS
EFIAPI
HiiNewString (
IN EFI_HII_PROTOCOL *This,
IN CHAR16 *Language,
IN EFI_HII_HANDLE Handle,
IN OUT STRING_REF *Reference,
IN CHAR16 *NewString
)
/*++
Routine Description:
This function allows a new String to be added to an already existing String Package.
We will make a buffer the size of the package + StrSize of the new string. We will
copy the string package that first gets changed and the following language packages until
we encounter the NULL string package. All this time we will ensure that the offsets have
been adjusted.
Arguments:
Returns:
--*/
{
UINTN Index;
CHAR16 *LangCodes;
CHAR16 Lang[4];
STRING_REF OriginalValue;
EFI_STATUS Status;
//
// To avoid a warning 4 uninitialized variable warning
//
Status = EFI_SUCCESS;
Status = HiiGetPrimaryLanguages (
This,
Handle,
&LangCodes
);
if (!EFI_ERROR (Status)) {
OriginalValue = *Reference;
if (Language == NULL) {
for (Index = 0; LangCodes[Index] != 0; Index += 3) {
*Reference = OriginalValue;
CopyMem (Lang, &LangCodes[Index], 6);
Lang[3] = 0;
Status = HiiNewString2 (
This,
Lang,
Handle,
Reference,
NewString,
FALSE
);
}
} else {
Status = HiiNewString2 (
This,
Language,
Handle,
Reference,
NewString,
FALSE
);
}
gBS->FreePool (LangCodes);
}
return Status;
}
EFI_STATUS
EFIAPI
HiiResetStrings (
IN EFI_HII_PROTOCOL *This,
IN EFI_HII_HANDLE Handle
)
/*++
Routine Description:
This function removes any new strings that were added after the initial string export for this handle.
Arguments:
Returns:
--*/
{
UINTN Index;
CHAR16 *LangCodes;
CHAR16 Lang[4];
STRING_REF Reference;
CHAR16 NewString;
EFI_STATUS Status;
Reference = 1;
NewString = 0;
HiiGetPrimaryLanguages (
This,
Handle,
&LangCodes
);
for (Index = 0; LangCodes[Index] != 0; Index += 3) {
CopyMem (Lang, &LangCodes[Index], 6);
Lang[3] = 0;
Status = HiiNewString2 (
This,
Lang,
Handle,
&Reference,
&NewString,
TRUE
);
}
gBS->FreePool (LangCodes);
return EFI_SUCCESS;
}
EFI_STATUS
EFIAPI
HiiGetString (
IN EFI_HII_PROTOCOL *This,
IN EFI_HII_HANDLE Handle,
IN STRING_REF Token,
IN BOOLEAN Raw,
IN CHAR16 *LanguageString,
IN OUT UINTN *BufferLengthTemp,
OUT EFI_STRING StringBuffer
)
/*++
Routine Description:
This function extracts a string from a package already registered with the EFI HII database.
Arguments:
This - A pointer to the EFI_HII_PROTOCOL instance.
Handle - The HII handle on which the string resides.
Token - The string token assigned to the string.
Raw - If TRUE, the string is returned unedited in the internal storage format described
above. If false, the string returned is edited by replacing <cr> with <space>
and by removing special characters such as the <wide> prefix.
LanguageString - Pointer to a NULL-terminated string containing a single ISO 639-2 language
identifier, indicating the language to print. If the LanguageString is empty (starts
with a NULL), the default system language will be used to determine the language.
BufferLength - Length of the StringBuffer. If the status reports that the buffer width is too
small, this parameter is filled with the length of the buffer needed.
StringBuffer - The buffer designed to receive the characters in the string. Type EFI_STRING is
defined in String.
Returns:
EFI_INVALID_PARAMETER - If input parameter is invalid.
EFI_BUFFER_TOO_SMALL - If the *BufferLength is too small.
EFI_SUCCESS - Operation is successful.
--*/
{
EFI_HII_PACKAGE_INSTANCE *PackageInstance;
EFI_HII_PACKAGE_INSTANCE *StringPackageInstance;
EFI_HII_DATA *HiiData;
EFI_HII_HANDLE_DATABASE *HandleDatabase;
EFI_HII_STRING_PACK *StringPack;
RELOFST *StringPointer;
EFI_STATUS Status;
UINTN DataSize;
CHAR8 Lang[3];
CHAR16 Language[3];
UINT32 Length;
UINTN Count;
RELOFST Offset;
UINT16 *Local;
UINT16 Zero;
UINT16 Narrow;
UINT16 Wide;
UINT16 NoBreak;
BOOLEAN LangFound;
UINT16 *BufferLength = (UINT16 *) BufferLengthTemp;
if (This == NULL) {
return EFI_INVALID_PARAMETER;
}
LangFound = TRUE;
DataSize = sizeof (Lang);
HiiData = EFI_HII_DATA_FROM_THIS (This);
PackageInstance = NULL;
Zero = 0;
Narrow = NARROW_CHAR;
Wide = WIDE_CHAR;
NoBreak = NON_BREAKING_CHAR;
//
// Check numeric value against the head of the database
//
for (HandleDatabase = HiiData->DatabaseHead;
HandleDatabase != NULL;
HandleDatabase = HandleDatabase->NextHandleDatabase
) {
//
// Match the numeric value with the database entry - if matched, extract PackageInstance
//
if (Handle == HandleDatabase->Handle) {
PackageInstance = HandleDatabase->Buffer;
break;
}
}
//
// No handle was found - error condition
//
if (PackageInstance == NULL) {
return EFI_INVALID_PARAMETER;
}
Status = ValidatePack (This, PackageInstance, &StringPackageInstance, NULL);
//
// If there is no specified language, assume the system default language
//
if (LanguageString == NULL) {
//
// Get system default language
//
Status = gRT->GetVariable (
(CHAR16 *) L"Lang",
&gEfiGlobalVariableGuid,
NULL,
&DataSize,
Lang
);
if (EFI_ERROR (Status)) {
//
// If Lang doesn't exist, just use the first language you find
//
LangFound = FALSE;
goto LangNotFound;
}
//
// Convert the ASCII Lang variable to a Unicode Language variable
//
AsciiToUnicode ((UINT8 *)Lang, Language);
} else {
//
// Copy input ISO value to Language variable
//
CopyMem (Language, LanguageString, 6);
}
//
// Based on if there is IFR data in this package instance, determine
// what the location is of the beginning of the string data.
//
LangNotFound:
if (StringPackageInstance->IfrSize > 0) {
StringPack = (EFI_HII_STRING_PACK *) ((CHAR8 *) (&StringPackageInstance->IfrData) + StringPackageInstance->IfrSize);
} else {
StringPack = (EFI_HII_STRING_PACK *) (&StringPackageInstance->IfrData);
}
//
// If Token is 0, extract entire string package
//
if (Token == 0) {
//
// Compute the entire string pack length, including all languages' and the terminating pack's.
//
Length = 0;
while (0 != StringPack->Header.Length) {
Length += StringPack->Header.Length;
StringPack = (VOID*)(((UINT8*)StringPack) + StringPack->Header.Length);
}
//
// Back to the start of package.
//
StringPack = (VOID*)(((UINT8*)StringPack) - Length);
//
// Terminating zero sub-pack.
//
Length += sizeof (EFI_HII_STRING_PACK);
//
// If trying to get the entire string package and have insufficient space. Return error.
//
if (Length > *BufferLength || StringBuffer == NULL) {
*BufferLength = (UINT16)Length;
return EFI_BUFFER_TOO_SMALL;
}
//
// Copy the Pack to the caller's buffer.
//
*BufferLength = (UINT16)Length;
CopyMem (StringBuffer, StringPack, Length);
return EFI_SUCCESS;
}
//
// There may be multiple instances packed together of strings
// so we must walk the self describing structures until we encounter
// what we are looking for, and then extract the string we are looking for
//
CopyMem (&Length, &StringPack->Header.Length, sizeof (UINT32));
for (; Length != 0;) {
//
// If passed in Language ISO value is in this string pack's language string
// then we are dealing with the strings we want.
//
CopyMem (&Offset, &StringPack->LanguageNameString, sizeof (RELOFST));
Status = HiiCompareLanguage ((CHAR16 *) ((CHAR8 *) (StringPack) + Offset), Language);
//
// If we cannot find the lang variable, we skip this check and use the first language available
//
if (LangFound) {
if (EFI_ERROR (Status)) {
StringPack = (EFI_HII_STRING_PACK *) ((CHAR8 *) (StringPack) + Length);
CopyMem (&Length, &StringPack->Header.Length, sizeof (UINT32));
continue;
}
}
StringPointer = (RELOFST *) (StringPack + 1);
//
// We have the right string package - size it, and copy it to the StringBuffer
//
if (Token >= StringPack->NumStringPointers) {
return EFI_INVALID_PARAMETER;
} else {
CopyMem (&Offset, &StringPointer[Token], sizeof (RELOFST));
}
//
// Since StringPack is a packed structure, we need to determine the string's
// size safely, thus byte-wise. Post-increment the size to include the null-terminator
//
Local = (UINT16 *) ((CHAR8 *) (StringPack) + Offset);
for (Count = 0; CompareMem (&Local[Count], &Zero, 2); Count++)
;
Count++;
Count = Count * sizeof (CHAR16);;
if (*BufferLength >= Count && StringBuffer != NULL) {
//
// Copy the string to the user's buffer
//
if (Raw) {
CopyMem (StringBuffer, Local, Count);
} else {
for (Count = 0; CompareMem (Local, &Zero, 2); Local++) {
//
// Skip "Narraw, Wide, NoBreak"
//
if (CompareMem (Local, &Narrow, 2) &&
CompareMem (Local, &Wide, 2) &&
CompareMem (Local, &NoBreak, 2)) {
CopyMem (&StringBuffer[Count++], Local, 2);
}
}
//
// Add "NULL" at the end.
//
CopyMem (&StringBuffer[Count], &Zero, 2);
Count++;
Count *= sizeof (CHAR16);
}
*BufferLength = (UINT16) Count;
return EFI_SUCCESS;
} else {
*BufferLength = (UINT16) Count;
return EFI_BUFFER_TOO_SMALL;
}
}
LangFound = FALSE;
goto LangNotFound;
}
EFI_STATUS
EFIAPI
HiiGetLine (
IN EFI_HII_PROTOCOL *This,
IN EFI_HII_HANDLE Handle,
IN STRING_REF Token,
IN OUT UINT16 *Index,
IN UINT16 LineWidth,
IN CHAR16 *LanguageString,
IN OUT UINT16 *BufferLength,
OUT EFI_STRING StringBuffer
)
/*++
Routine Description:
This function allows a program to extract a part of a string of not more than a given width.
With repeated calls, this allows a calling program to extract "lines" of text that fit inside
columns. The effort of measuring the fit of strings inside columns is localized to this call.
Arguments:
Returns:
--*/
{
UINTN Count;
EFI_HII_PACKAGE_INSTANCE *PackageInstance;
EFI_HII_PACKAGE_INSTANCE *StringPackageInstance;
EFI_HII_DATA *HiiData;
EFI_HII_HANDLE_DATABASE *HandleDatabase;
EFI_HII_STRING_PACK *StringPack;
RELOFST *StringPointer;
CHAR16 *Location;
EFI_STATUS Status;
UINTN DataSize;
CHAR8 Lang[3];
CHAR16 Language[3];
if (This == NULL) {
return EFI_INVALID_PARAMETER;
}
HiiData = EFI_HII_DATA_FROM_THIS (This);
HandleDatabase = HiiData->DatabaseHead;
PackageInstance = NULL;
DataSize = 4;
//
// Check numeric value against the head of the database
//
for (; HandleDatabase != NULL; HandleDatabase = HandleDatabase->NextHandleDatabase) {
//
// Match the numeric value with the database entry - if matched, extract PackageInstance
//
if (Handle == HandleDatabase->Handle) {
PackageInstance = HandleDatabase->Buffer;
}
}
//
// No handle was found - error condition
//
if (PackageInstance == NULL) {
return EFI_INVALID_PARAMETER;
}
Status = ValidatePack (This, PackageInstance, &StringPackageInstance, NULL);
//
// If there is no specified language, assume the system default language
//
if (LanguageString == NULL) {
//
// Get system default language
//
Status = gRT->GetVariable (
(CHAR16 *) L"Lang",
&gEfiGlobalVariableGuid,
NULL,
&DataSize,
Lang
);
if (EFI_ERROR (Status)) {
return Status;
}
//
// Convert the ASCII Lang variable to a Unicode Language variable
//
AsciiToUnicode ((UINT8 *)Lang, Language);
} else {
//
// Copy input ISO value to Language variable
//
CopyMem (Language, LanguageString, 6);
}
//
// Based on if there is IFR data in this package instance, determine
// what the location is of the beginning of the string data.
//
if (StringPackageInstance->IfrSize > 0) {
StringPack = (EFI_HII_STRING_PACK *) ((CHAR8 *) (&StringPackageInstance->IfrData) + StringPackageInstance->IfrSize);
} else {
StringPack = (EFI_HII_STRING_PACK *) (&StringPackageInstance->IfrData);
}
StringPointer = (RELOFST *) (StringPack + 1);
//
// There may be multiple instances packed together of strings
// so we must walk the self describing structures until we encounter
// what we are looking for, and then extract the string we are looking for
//
for (; StringPack->Header.Length != 0;) {
//
// If passed in Language ISO value is in this string pack's language string
// then we are dealing with the strings we want.
//
Status = HiiCompareLanguage ((CHAR16 *) ((CHAR8 *) (StringPack) + StringPack->LanguageNameString), Language);
if (EFI_ERROR (Status)) {
StringPack = (EFI_HII_STRING_PACK *) ((CHAR8 *) (StringPack) + StringPack->Header.Length);
continue;
}
Location = (CHAR16 *) ((CHAR8 *) (StringPack) + StringPointer[Token] +*Index * 2);
//
// If the size of the remaining string is less than the LineWidth
// then copy the entire thing
//
if (StrSize (Location) <= LineWidth) {
if (*BufferLength >= StrSize (Location)) {
StrCpy (StringBuffer, Location);
return EFI_SUCCESS;
} else {
*BufferLength = (UINT16) StrSize (Location);
return EFI_BUFFER_TOO_SMALL;
}
} else {
//
// Rewind the string from the maximum size until we see a space the break the line
//
for (Count = LineWidth; Location[Count] != 0x0020; Count--)
;
//
// Put the index at the next character
//
*Index = (UINT16) (Count + 1);
if (*BufferLength >= Count) {
StrnCpy (StringBuffer, Location, Count);
return EFI_SUCCESS;
} else {
*BufferLength = (UINT16) Count;
return EFI_BUFFER_TOO_SMALL;
}
}
}
return EFI_SUCCESS;
}
EFI_STATUS
HiiCompareLanguage (
IN CHAR16 *LanguageStringLocation,
IN CHAR16 *Language
)
{
UINT8 *Local;
UINTN Index;
CHAR16 *InputString;
CHAR16 *OriginalInputString;
//
// Allocate a temporary buffer for InputString
//
InputString = AllocateZeroPool (0x100);
ASSERT (InputString);
OriginalInputString = InputString;
Local = (UINT8 *) LanguageStringLocation;
//
// Determine the size of this packed string safely (e.g. access by byte), post-increment
// to include the null-terminator
//
for (Index = 0; Local[Index] != 0; Index = Index + 2)
;
//
// MARMAR Index = Index + 2;
//
// This is a packed structure that this location comes from, so let's make sure
// the value is aligned by copying it to a local variable and working on it.
//
CopyMem (InputString, LanguageStringLocation, Index);
for (Index = 0; Index < 3; Index++) {
InputString[Index] = (CHAR16) (InputString[Index] | 0x20);
Language[Index] = (CHAR16) (Language[Index] | 0x20);
}
//
// If the Language is the same return success
//
if (CompareMem (LanguageStringLocation, Language, 6) == 0) {
gBS->FreePool (InputString);
return EFI_SUCCESS;
}
//
// Skip the first three letters that comprised the primary language,
// see if what is being compared against is a secondary language
//
InputString = InputString + 3;
//
// If the Language is not the same as the Primary language, see if there are any
// secondary languages, and if there are see if we have a match. If not, return an error.
//
for (Index = 0; InputString[Index] != 0; Index = Index + 3) {
//
// Getting in here means we have a secondary language
//
if (CompareMem (&InputString[Index], Language, 6) == 0) {
gBS->FreePool (InputString);
return EFI_SUCCESS;
}
}
//
// If nothing was found, return the error
//
gBS->FreePool (OriginalInputString);
return EFI_NOT_FOUND;
}
|