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
|
/*++
Copyright (c) 2004 - 2007, 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:
String.c
Abstract:
Unicode string primatives
--*/
#include "Tiano.h"
#include "EfiDriverLib.h"
#include "EfiCommonLib.h"
VOID
EfiStrCpy (
IN CHAR16 *Destination,
IN CHAR16 *Source
)
/*++
Routine Description:
Copy the Unicode string Source to Destination.
Arguments:
Destination - Location to copy string
Source - String to copy
Returns:
NONE
--*/
{
while (*Source) {
*(Destination++) = *(Source++);
}
*Destination = 0;
}
VOID
EfiStrnCpy (
OUT CHAR16 *Dst,
IN CHAR16 *Src,
IN UINTN Length
)
/*++
Routine Description:
Copy a string from source to destination
Arguments:
Dst Destination string
Src Source string
Length Length of destination string
Returns:
--*/
{
UINTN Index;
UINTN SrcLen;
SrcLen = EfiStrLen (Src);
Index = 0;
while (Index < Length && Index < SrcLen) {
Dst[Index] = Src[Index];
Index++;
}
for (Index = SrcLen; Index < Length; Index++) {
Dst[Index] = 0;
}
}
UINTN
EfiStrLen (
IN CHAR16 *String
)
/*++
Routine Description:
Return the number of Unicode characters in String. This is not the same as
the length of the string in bytes.
Arguments:
String - String to process
Returns:
Number of Unicode characters in String
--*/
{
UINTN Length;
for (Length=0; *String; String++, Length++);
return Length;
}
UINTN
EfiStrSize (
IN CHAR16 *String
)
/*++
Routine Description:
Return the number bytes in the Unicode String. This is not the same as
the length of the string in characters. The string size includes the NULL
Arguments:
String - String to process
Returns:
Number of bytes in String
--*/
{
return ((EfiStrLen (String) + 1) * sizeof (CHAR16));
}
INTN
EfiStrCmp (
IN CHAR16 *String,
IN CHAR16 *String2
)
/*++
Routine Description:
Compare the Unicode string pointed by String to the string pointed by String2.
Arguments:
String - String to process
String2 - The other string to process
Returns:
Return a positive integer if String is lexicall greater than String2; Zero if
the two strings are identical; and a negative interger if String is lexically
less than String2.
--*/
{
while (*String) {
if (*String != *String2) {
break;
}
String += 1;
String2 += 1;
}
return *String - *String2;
}
INTN
EfiStrnCmp (
IN CHAR16 *String,
IN CHAR16 *String2,
IN UINTN Length
)
/*++
Routine Description:
This function compares the Unicode string String to the Unicode
string String2 for len characters. If the first len characters
of String is identical to the first len characters of String2,
then 0 is returned. If substring of String sorts lexicographically
after String2, the function returns a number greater than 0. If
substring of String sorts lexicographically before String2, the
function returns a number less than 0.
Arguments:
String - Compare to String2
String2 - Compare to String
Length - Number of Unicode characters to compare
Returns:
0 - The substring of String and String2 is identical.
> 0 - The substring of String sorts lexicographically after String2
< 0 - The substring of String sorts lexicographically before String2
--*/
{
while (*String && Length != 0) {
if (*String != *String2) {
break;
}
String += 1;
String2 += 1;
Length -= 1;
}
return Length > 0 ? *String - *String2 : 0;
}
VOID
EfiStrCat (
IN CHAR16 *Destination,
IN CHAR16 *Source
)
/*++
Routine Description:
Concatinate Source on the end of Destination
Arguments:
Destination - String to added to the end of.
Source - String to concatinate.
Returns:
NONE
--*/
{
EfiStrCpy (Destination + EfiStrLen (Destination), Source);
}
VOID
EfiStrnCat (
IN CHAR16 *Dest,
IN CHAR16 *Src,
IN UINTN Length
)
/*++
Routine Description:
Concatinate Source on the end of Destination
Arguments:
Dst Destination string
Src Source string
Length Length of destination string
Returns:
--*/
{
EfiStrnCpy (Dest + EfiStrLen (Dest), Src, Length);
}
UINTN
EfiAsciiStrLen (
IN CHAR8 *String
)
/*++
Routine Description:
Return the number of Ascii characters in String. This is not the same as
the length of the string in bytes.
Arguments:
String - String to process
Returns:
Number of Ascii characters in String
--*/
{
UINTN Length;
for (Length=0; *String; String++, Length++);
return Length;
}
CHAR8 *
EfiAsciiStrCpy (
IN CHAR8 *Destination,
IN CHAR8 *Source
)
/*++
Routine Description:
Copy the Ascii string Source to Destination.
Arguments:
Destination - Location to copy string
Source - String to copy
Returns:
Pointer just pass the end of Destination
--*/
{
while (*Source) {
*(Destination++) = *(Source++);
}
*Destination = 0;
return Destination + 1;
}
VOID
EfiAsciiStrnCpy (
OUT CHAR8 *Dst,
IN CHAR8 *Src,
IN UINTN Length
)
/*++
Routine Description:
Copy the Ascii string from source to destination
Arguments:
Dst Destination string
Src Source string
Length Length of destination string
Returns:
--*/
{
UINTN Index;
UINTN SrcLen;
SrcLen = EfiAsciiStrLen (Src);
Index = 0;
while (Index < Length && Index < SrcLen) {
Dst[Index] = Src[Index];
Index++;
}
for (Index = SrcLen; Index < Length; Index++) {
Dst[Index] = 0;
}
}
UINTN
EfiAsciiStrSize (
IN CHAR8 *String
)
/*++
Routine Description:
Return the number bytes in the Ascii String. This is not the same as
the length of the string in characters. The string size includes the NULL
Arguments:
String - String to process
Returns:
Number of bytes in String
--*/
{
return (EfiAsciiStrLen (String) + 1);
}
INTN
EfiAsciiStrCmp (
IN CHAR8 *String,
IN CHAR8 *String2
)
/*++
Routine Description:
Compare the Ascii string pointed by String to the string pointed by String2.
Arguments:
String - String to process
String2 - The other string to process
Returns:
Return a positive integer if String is lexicall greater than String2; Zero if
the two strings are identical; and a negative interger if String is lexically
less than String2.
--*/
{
while (*String) {
if (*String != *String2) {
break;
}
String += 1;
String2 += 1;
}
return *String - *String2;
}
INTN
EfiAsciiStrnCmp (
IN CHAR8 *String,
IN CHAR8 *String2,
IN UINTN Length
)
{
if (Length == 0) {
return 0;
}
while ((*String != '\0') &&
(*String == *String2) &&
(Length > 1)) {
String++;
String2++;
Length--;
}
return *String - *String2;
}
VOID
EfiAsciiStrCat (
IN CHAR8 *Destination,
IN CHAR8 *Source
)
/*++
Routine Description:
Concatinate Source on the end of Destination
Arguments:
Destination - String to added to the end of.
Source - String to concatinate.
Returns:
NONE
--*/
{
EfiAsciiStrCpy (Destination + EfiAsciiStrLen (Destination), Source);
}
VOID
EfiAsciiStrnCat (
IN CHAR8 *Destination,
IN CHAR8 *Source,
IN UINTN Length
)
/*++
Routine Description:
Concatinate Source on the end of Destination
Arguments:
Destination - String to added to the end of.
Source - String to concatinate.
Returns:
NONE
--*/
{
EfiAsciiStrnCpy (Destination + EfiAsciiStrLen (Destination), Source, Length);
}
BOOLEAN
IsHexDigit (
OUT UINT8 *Digit,
IN CHAR16 Char
)
/*++
Routine Description:
Determines if a Unicode character is a hexadecimal digit.
The test is case insensitive.
Arguments:
Digit - Pointer to byte that receives the value of the hex character.
Char - Unicode character to test.
Returns:
TRUE - If the character is a hexadecimal digit.
FALSE - Otherwise.
--*/
{
if ((Char >= L'0') && (Char <= L'9')) {
*Digit = (UINT8) (Char - L'0');
return TRUE;
}
if ((Char >= L'A') && (Char <= L'F')) {
*Digit = (UINT8) (Char - L'A' + 0x0A);
return TRUE;
}
if ((Char >= L'a') && (Char <= L'f')) {
*Digit = (UINT8) (Char - L'a' + 0x0A);
return TRUE;
}
return FALSE;
}
CHAR16
NibbleToHexChar (
IN UINT8 Nibble
)
/*++
Routine Description:
Converts the low nibble of a byte to hex unicode character.
Arguments:
Nibble - lower nibble of a byte.
Returns:
Hex unicode character.
--*/
{
Nibble &= 0x0F;
if (Nibble <= 0x9) {
return (CHAR16)(Nibble + L'0');
}
return (CHAR16)(Nibble - 0xA + L'A');
}
EFI_STATUS
HexStringToBuf (
IN OUT UINT8 *Buf,
IN OUT UINTN *Len,
IN CHAR16 *Str,
OUT UINTN *ConvertedStrLen OPTIONAL
)
/*++
Routine Description:
Converts Unicode string to binary buffer.
The conversion may be partial.
The first character in the string that is not hex digit stops the conversion.
At a minimum, any blob of data could be represented as a hex string.
Arguments:
Buf - Pointer to buffer that receives the data.
Len - Length in bytes of the buffer to hold converted data.
If routine return with EFI_SUCCESS, containing length of converted data.
If routine return with EFI_BUFFER_TOO_SMALL, containg length of buffer desired.
Str - String to be converted from.
ConvertedStrLen - Length of the Hex String consumed.
Returns:
EFI_SUCCESS: Routine Success.
EFI_BUFFER_TOO_SMALL: The buffer is too small to hold converted data.
EFI_
--*/
{
UINTN HexCnt;
UINTN Idx;
UINTN BufferLength;
UINT8 Digit;
UINT8 Byte;
//
// Find out how many hex characters the string has.
//
for (Idx = 0, HexCnt = 0; IsHexDigit (&Digit, Str[Idx]); Idx++, HexCnt++);
if (HexCnt == 0) {
*Len = 0;
return EFI_SUCCESS;
}
//
// Two Unicode characters make up 1 buffer byte. Round up.
//
BufferLength = (HexCnt + 1) / 2;
//
// Test if buffer is passed enough.
//
if (BufferLength > (*Len)) {
*Len = BufferLength;
return EFI_BUFFER_TOO_SMALL;
}
*Len = BufferLength;
for (Idx = 0; Idx < HexCnt; Idx++) {
IsHexDigit (&Digit, Str[HexCnt - 1 - Idx]);
//
// For odd charaters, write the lower nibble for each buffer byte,
// and for even characters, the upper nibble.
//
if ((Idx & 1) == 0) {
Byte = Digit;
} else {
Byte = Buf[Idx / 2];
Byte &= 0x0F;
Byte = (UINT8)(Byte | (Digit << 4));
}
Buf[Idx / 2] = Byte;
}
if (ConvertedStrLen != NULL) {
*ConvertedStrLen = HexCnt;
}
return EFI_SUCCESS;
}
EFI_STATUS
BufToHexString (
IN OUT CHAR16 *Str,
IN OUT UINTN *HexStringBufferLength,
IN UINT8 *Buf,
IN UINTN Len
)
/*++
Routine Description:
Converts binary buffer to Unicode string.
At a minimum, any blob of data could be represented as a hex string.
Arguments:
Str - Pointer to the string.
HexStringBufferLength - Length in bytes of buffer to hold the hex string. Includes tailing '\0' character.
If routine return with EFI_SUCCESS, containing length of hex string buffer.
If routine return with EFI_BUFFER_TOO_SMALL, containg length of hex string buffer desired.
Buf - Buffer to be converted from.
Len - Length in bytes of the buffer to be converted.
Returns:
EFI_SUCCESS: Routine success.
EFI_BUFFER_TOO_SMALL: The hex string buffer is too small.
--*/
{
UINTN Idx;
UINT8 Byte;
UINTN StrLen;
//
// Make sure string is either passed or allocate enough.
// It takes 2 Unicode characters (4 bytes) to represent 1 byte of the binary buffer.
// Plus the Unicode termination character.
//
StrLen = Len * 2;
if (StrLen > ((*HexStringBufferLength) - 1)) {
*HexStringBufferLength = StrLen + 1;
return EFI_BUFFER_TOO_SMALL;
}
*HexStringBufferLength = StrLen + 1;
//
// Ends the string.
//
Str[StrLen] = L'\0';
for (Idx = 0; Idx < Len; Idx++) {
Byte = Buf[Idx];
Str[StrLen - 1 - Idx * 2] = NibbleToHexChar (Byte);
Str[StrLen - 2 - Idx * 2] = NibbleToHexChar ((UINT8)(Byte >> 4));
}
return EFI_SUCCESS;
}
VOID
EfiStrTrim (
IN OUT CHAR16 *str,
IN CHAR16 CharC
)
/*++
Routine Description:
Removes (trims) specified leading and trailing characters from a string.
Arguments:
str - Pointer to the null-terminated string to be trimmed. On return,
str will hold the trimmed string.
CharC - Character will be trimmed from str.
Returns:
--*/
{
CHAR16 *p1;
CHAR16 *p2;
if (*str == 0) {
return;
}
//
// Trim off the leading and trailing characters c
//
for (p1 = str; *p1 && *p1 == CharC; p1++) {
;
}
p2 = str;
if (p2 == p1) {
while (*p1) {
p2++;
p1++;
}
} else {
while (*p1) {
*p2 = *p1;
p1++;
p2++;
}
*p2 = 0;
}
for (p1 = str + EfiStrLen(str) - 1; p1 >= str && *p1 == CharC; p1--) {
;
}
if (p1 != str + EfiStrLen(str) - 1) {
*(p1 + 1) = 0;
}
}
CHAR16*
EfiStrStr (
IN CHAR16 *String,
IN CHAR16 *StrCharSet
)
/*++
Routine Description:
Find a substring.
Arguments:
String - Null-terminated string to search.
StrCharSet - Null-terminated string to search for.
Returns:
The address of the first occurrence of the matching substring if successful, or NULL otherwise.
--*/
{
CHAR16 *Src;
CHAR16 *Sub;
Src = String;
Sub = StrCharSet;
while ((*String != L'\0') && (*StrCharSet != L'\0')) {
if (*String++ != *StrCharSet) {
String = ++Src;
StrCharSet = Sub;
} else {
StrCharSet++;
}
}
if (*StrCharSet == L'\0') {
return Src;
} else {
return NULL;
}
}
CHAR8*
EfiAsciiStrStr (
IN CHAR8 *String,
IN CHAR8 *StrCharSet
)
/*++
Routine Description:
Find a Ascii substring.
Arguments:
String - Null-terminated Ascii string to search.
StrCharSet - Null-terminated Ascii string to search for.
Returns:
The address of the first occurrence of the matching Ascii substring if successful, or NULL otherwise.
--*/
{
CHAR8 *Src;
CHAR8 *Sub;
Src = String;
Sub = StrCharSet;
while ((*String != '\0') && (*StrCharSet != '\0')) {
if (*String++ != *StrCharSet) {
String = ++Src;
StrCharSet = Sub;
} else {
StrCharSet++;
}
}
if (*StrCharSet == '\0') {
return Src;
} else {
return NULL;
}
}
|