2 Provides string functions, linked list functions, math functions, synchronization
3 functions, file path functions, and CPU architecture-specific functions.
5 Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>
6 Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>
7 This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php.
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
21 // Definitions for architecture-specific types
23 #if defined (MDE_CPU_IA32)
25 /// The IA-32 architecture context buffer used by SetJump() and LongJump().
34 } BASE_LIBRARY_JUMP_BUFFER
;
36 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 4
38 #endif // defined (MDE_CPU_IA32)
40 #if defined (MDE_CPU_X64)
42 /// The x64 architecture context buffer used by SetJump() and LongJump().
56 UINT8 XmmBuffer
[160]; ///< XMM6-XMM15.
57 } BASE_LIBRARY_JUMP_BUFFER
;
59 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 8
61 #endif // defined (MDE_CPU_X64)
63 #if defined (MDE_CPU_EBC)
65 /// The EBC context buffer used by SetJump() and LongJump().
73 } BASE_LIBRARY_JUMP_BUFFER
;
75 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 8
77 #endif // defined (MDE_CPU_EBC)
79 #if defined (MDE_CPU_ARM)
82 UINT32 R3
; ///< A copy of R13.
93 } BASE_LIBRARY_JUMP_BUFFER
;
95 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 4
97 #endif // defined (MDE_CPU_ARM)
99 #if defined (MDE_CPU_AARCH64)
125 } BASE_LIBRARY_JUMP_BUFFER
;
127 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 8
129 #endif // defined (MDE_CPU_AARCH64)
138 Returns the length of a Null-terminated Unicode string.
140 This function is similar as strlen_s defined in C11.
142 If String is not aligned on a 16-bit boundary, then ASSERT().
144 @param String A pointer to a Null-terminated Unicode string.
145 @param MaxSize The maximum number of Destination Unicode
146 char, including terminating null char.
148 @retval 0 If String is NULL.
149 @retval MaxSize If there is no null character in the first MaxSize characters of String.
150 @return The number of characters that percede the terminating null character.
156 IN CONST CHAR16
*String
,
161 Returns the size of a Null-terminated Unicode string in bytes, including the
164 This function returns the size of the Null-terminated Unicode string
165 specified by String in bytes, including the Null terminator.
167 If String is not aligned on a 16-bit boundary, then ASSERT().
169 @param String A pointer to a Null-terminated Unicode string.
170 @param MaxSize The maximum number of Destination Unicode
171 char, including the Null terminator.
173 @retval 0 If String is NULL.
174 @retval (sizeof (CHAR16) * (MaxSize + 1))
175 If there is no Null terminator in the first MaxSize characters of
177 @return The size of the Null-terminated Unicode string in bytes, including
184 IN CONST CHAR16
*String
,
189 Copies the string pointed to by Source (including the terminating null char)
190 to the array pointed to by Destination.
192 This function is similar as strcpy_s defined in C11.
194 If Destination is not aligned on a 16-bit boundary, then ASSERT().
195 If Source is not aligned on a 16-bit boundary, then ASSERT().
196 If an error would be returned, then the function will also ASSERT().
198 If an error is returned, then the Destination is unmodified.
200 @param Destination A pointer to a Null-terminated Unicode string.
201 @param DestMax The maximum number of Destination Unicode
202 char, including terminating null char.
203 @param Source A pointer to a Null-terminated Unicode string.
205 @retval RETURN_SUCCESS String is copied.
206 @retval RETURN_BUFFER_TOO_SMALL If DestMax is NOT greater than StrLen(Source).
207 @retval RETURN_INVALID_PARAMETER If Destination is NULL.
209 If PcdMaximumUnicodeStringLength is not zero,
210 and DestMax is greater than
211 PcdMaximumUnicodeStringLength.
213 @retval RETURN_ACCESS_DENIED If Source and Destination overlap.
218 OUT CHAR16
*Destination
,
220 IN CONST CHAR16
*Source
224 Copies not more than Length successive char from the string pointed to by
225 Source to the array pointed to by Destination. If no null char is copied from
226 Source, then Destination[Length] is always set to null.
228 This function is similar as strncpy_s defined in C11.
230 If Length > 0 and Destination is not aligned on a 16-bit boundary, then ASSERT().
231 If Length > 0 and Source is not aligned on a 16-bit boundary, then ASSERT().
232 If an error would be returned, then the function will also ASSERT().
234 If an error is returned, then the Destination is unmodified.
236 @param Destination A pointer to a Null-terminated Unicode string.
237 @param DestMax The maximum number of Destination Unicode
238 char, including terminating null char.
239 @param Source A pointer to a Null-terminated Unicode string.
240 @param Length The maximum number of Unicode characters to copy.
242 @retval RETURN_SUCCESS String is copied.
243 @retval RETURN_BUFFER_TOO_SMALL If DestMax is NOT greater than
244 MIN(StrLen(Source), Length).
245 @retval RETURN_INVALID_PARAMETER If Destination is NULL.
247 If PcdMaximumUnicodeStringLength is not zero,
248 and DestMax is greater than
249 PcdMaximumUnicodeStringLength.
251 @retval RETURN_ACCESS_DENIED If Source and Destination overlap.
256 OUT CHAR16
*Destination
,
258 IN CONST CHAR16
*Source
,
263 Appends a copy of the string pointed to by Source (including the terminating
264 null char) to the end of the string pointed to by Destination.
266 This function is similar as strcat_s defined in C11.
268 If Destination is not aligned on a 16-bit boundary, then ASSERT().
269 If Source is not aligned on a 16-bit boundary, then ASSERT().
270 If an error would be returned, then the function will also ASSERT().
272 If an error is returned, then the Destination is unmodified.
274 @param Destination A pointer to a Null-terminated Unicode string.
275 @param DestMax The maximum number of Destination Unicode
276 char, including terminating null char.
277 @param Source A pointer to a Null-terminated Unicode string.
279 @retval RETURN_SUCCESS String is appended.
280 @retval RETURN_BAD_BUFFER_SIZE If DestMax is NOT greater than
282 @retval RETURN_BUFFER_TOO_SMALL If (DestMax - StrLen(Destination)) is NOT
283 greater than StrLen(Source).
284 @retval RETURN_INVALID_PARAMETER If Destination is NULL.
286 If PcdMaximumUnicodeStringLength is not zero,
287 and DestMax is greater than
288 PcdMaximumUnicodeStringLength.
290 @retval RETURN_ACCESS_DENIED If Source and Destination overlap.
295 IN OUT CHAR16
*Destination
,
297 IN CONST CHAR16
*Source
301 Appends not more than Length successive char from the string pointed to by
302 Source to the end of the string pointed to by Destination. If no null char is
303 copied from Source, then Destination[StrLen(Destination) + Length] is always
306 This function is similar as strncat_s defined in C11.
308 If Destination is not aligned on a 16-bit boundary, then ASSERT().
309 If Source is not aligned on a 16-bit boundary, then ASSERT().
310 If an error would be returned, then the function will also ASSERT().
312 If an error is returned, then the Destination is unmodified.
314 @param Destination A pointer to a Null-terminated Unicode string.
315 @param DestMax The maximum number of Destination Unicode
316 char, including terminating null char.
317 @param Source A pointer to a Null-terminated Unicode string.
318 @param Length The maximum number of Unicode characters to copy.
320 @retval RETURN_SUCCESS String is appended.
321 @retval RETURN_BAD_BUFFER_SIZE If DestMax is NOT greater than
323 @retval RETURN_BUFFER_TOO_SMALL If (DestMax - StrLen(Destination)) is NOT
324 greater than MIN(StrLen(Source), Length).
325 @retval RETURN_INVALID_PARAMETER If Destination is NULL.
327 If PcdMaximumUnicodeStringLength is not zero,
328 and DestMax is greater than
329 PcdMaximumUnicodeStringLength.
331 @retval RETURN_ACCESS_DENIED If Source and Destination overlap.
336 IN OUT CHAR16
*Destination
,
338 IN CONST CHAR16
*Source
,
343 Convert a Null-terminated Unicode decimal string to a value of type UINTN.
345 This function outputs a value of type UINTN by interpreting the contents of
346 the Unicode string specified by String as a decimal number. The format of the
347 input Unicode string String is:
349 [spaces] [decimal digits].
351 The valid decimal digit character is in the range [0-9]. The function will
352 ignore the pad space, which includes spaces or tab characters, before
353 [decimal digits]. The running zero in the beginning of [decimal digits] will
354 be ignored. Then, the function stops at the first character that is a not a
355 valid decimal character or a Null-terminator, whichever one comes first.
357 If String is NULL, then ASSERT().
358 If Data is NULL, then ASSERT().
359 If String is not aligned in a 16-bit boundary, then ASSERT().
360 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
361 PcdMaximumUnicodeStringLength Unicode characters, not including the
362 Null-terminator, then ASSERT().
364 If String has no valid decimal digits in the above format, then 0 is stored
365 at the location pointed to by Data.
366 If the number represented by String exceeds the range defined by UINTN, then
367 MAX_UINTN is stored at the location pointed to by Data.
369 If EndPointer is not NULL, a pointer to the character that stopped the scan
370 is stored at the location pointed to by EndPointer. If String has no valid
371 decimal digits right after the optional pad spaces, the value of String is
372 stored at the location pointed to by EndPointer.
374 @param String Pointer to a Null-terminated Unicode string.
375 @param EndPointer Pointer to character that stops scan.
376 @param Data Pointer to the converted value.
378 @retval RETURN_SUCCESS Value is translated from String.
379 @retval RETURN_INVALID_PARAMETER If String is NULL.
381 If PcdMaximumUnicodeStringLength is not
382 zero, and String contains more than
383 PcdMaximumUnicodeStringLength Unicode
384 characters, not including the
386 @retval RETURN_UNSUPPORTED If the number represented by String exceeds
387 the range defined by UINTN.
393 IN CONST CHAR16
*String
,
394 OUT CHAR16
**EndPointer
, OPTIONAL
399 Convert a Null-terminated Unicode decimal string to a value of type UINT64.
401 This function outputs a value of type UINT64 by interpreting the contents of
402 the Unicode string specified by String as a decimal number. The format of the
403 input Unicode string String is:
405 [spaces] [decimal digits].
407 The valid decimal digit character is in the range [0-9]. The function will
408 ignore the pad space, which includes spaces or tab characters, before
409 [decimal digits]. The running zero in the beginning of [decimal digits] will
410 be ignored. Then, the function stops at the first character that is a not a
411 valid decimal character or a Null-terminator, whichever one comes first.
413 If String is NULL, then ASSERT().
414 If Data is NULL, then ASSERT().
415 If String is not aligned in a 16-bit boundary, then ASSERT().
416 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
417 PcdMaximumUnicodeStringLength Unicode characters, not including the
418 Null-terminator, then ASSERT().
420 If String has no valid decimal digits in the above format, then 0 is stored
421 at the location pointed to by Data.
422 If the number represented by String exceeds the range defined by UINT64, then
423 MAX_UINT64 is stored at the location pointed to by Data.
425 If EndPointer is not NULL, a pointer to the character that stopped the scan
426 is stored at the location pointed to by EndPointer. If String has no valid
427 decimal digits right after the optional pad spaces, the value of String is
428 stored at the location pointed to by EndPointer.
430 @param String Pointer to a Null-terminated Unicode string.
431 @param EndPointer Pointer to character that stops scan.
432 @param Data Pointer to the converted value.
434 @retval RETURN_SUCCESS Value is translated from String.
435 @retval RETURN_INVALID_PARAMETER If String is NULL.
437 If PcdMaximumUnicodeStringLength is not
438 zero, and String contains more than
439 PcdMaximumUnicodeStringLength Unicode
440 characters, not including the
442 @retval RETURN_UNSUPPORTED If the number represented by String exceeds
443 the range defined by UINT64.
448 StrDecimalToUint64S (
449 IN CONST CHAR16
*String
,
450 OUT CHAR16
**EndPointer
, OPTIONAL
455 Convert a Null-terminated Unicode hexadecimal string to a value of type
458 This function outputs a value of type UINTN by interpreting the contents of
459 the Unicode string specified by String as a hexadecimal number. The format of
460 the input Unicode string String is:
462 [spaces][zeros][x][hexadecimal digits].
464 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
465 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix.
466 If "x" appears in the input string, it must be prefixed with at least one 0.
467 The function will ignore the pad space, which includes spaces or tab
468 characters, before [zeros], [x] or [hexadecimal digit]. The running zero
469 before [x] or [hexadecimal digit] will be ignored. Then, the decoding starts
470 after [x] or the first valid hexadecimal digit. Then, the function stops at
471 the first character that is a not a valid hexadecimal character or NULL,
472 whichever one comes first.
474 If String is NULL, then ASSERT().
475 If Data is NULL, then ASSERT().
476 If String is not aligned in a 16-bit boundary, then ASSERT().
477 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
478 PcdMaximumUnicodeStringLength Unicode characters, not including the
479 Null-terminator, then ASSERT().
481 If String has no valid hexadecimal digits in the above format, then 0 is
482 stored at the location pointed to by Data.
483 If the number represented by String exceeds the range defined by UINTN, then
484 MAX_UINTN is stored at the location pointed to by Data.
486 If EndPointer is not NULL, a pointer to the character that stopped the scan
487 is stored at the location pointed to by EndPointer. If String has no valid
488 hexadecimal digits right after the optional pad spaces, the value of String
489 is stored at the location pointed to by EndPointer.
491 @param String Pointer to a Null-terminated Unicode string.
492 @param EndPointer Pointer to character that stops scan.
493 @param Data Pointer to the converted value.
495 @retval RETURN_SUCCESS Value is translated from String.
496 @retval RETURN_INVALID_PARAMETER If String is NULL.
498 If PcdMaximumUnicodeStringLength is not
499 zero, and String contains more than
500 PcdMaximumUnicodeStringLength Unicode
501 characters, not including the
503 @retval RETURN_UNSUPPORTED If the number represented by String exceeds
504 the range defined by UINTN.
510 IN CONST CHAR16
*String
,
511 OUT CHAR16
**EndPointer
, OPTIONAL
516 Convert a Null-terminated Unicode hexadecimal string to a value of type
519 This function outputs a value of type UINT64 by interpreting the contents of
520 the Unicode string specified by String as a hexadecimal number. The format of
521 the input Unicode string String is:
523 [spaces][zeros][x][hexadecimal digits].
525 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
526 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix.
527 If "x" appears in the input string, it must be prefixed with at least one 0.
528 The function will ignore the pad space, which includes spaces or tab
529 characters, before [zeros], [x] or [hexadecimal digit]. The running zero
530 before [x] or [hexadecimal digit] will be ignored. Then, the decoding starts
531 after [x] or the first valid hexadecimal digit. Then, the function stops at
532 the first character that is a not a valid hexadecimal character or NULL,
533 whichever one comes first.
535 If String is NULL, then ASSERT().
536 If Data is NULL, then ASSERT().
537 If String is not aligned in a 16-bit boundary, then ASSERT().
538 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
539 PcdMaximumUnicodeStringLength Unicode characters, not including the
540 Null-terminator, then ASSERT().
542 If String has no valid hexadecimal digits in the above format, then 0 is
543 stored at the location pointed to by Data.
544 If the number represented by String exceeds the range defined by UINT64, then
545 MAX_UINT64 is stored at the location pointed to by Data.
547 If EndPointer is not NULL, a pointer to the character that stopped the scan
548 is stored at the location pointed to by EndPointer. If String has no valid
549 hexadecimal digits right after the optional pad spaces, the value of String
550 is stored at the location pointed to by EndPointer.
552 @param String Pointer to a Null-terminated Unicode string.
553 @param EndPointer Pointer to character that stops scan.
554 @param Data Pointer to the converted value.
556 @retval RETURN_SUCCESS Value is translated from String.
557 @retval RETURN_INVALID_PARAMETER If String is NULL.
559 If PcdMaximumUnicodeStringLength is not
560 zero, and String contains more than
561 PcdMaximumUnicodeStringLength Unicode
562 characters, not including the
564 @retval RETURN_UNSUPPORTED If the number represented by String exceeds
565 the range defined by UINT64.
571 IN CONST CHAR16
*String
,
572 OUT CHAR16
**EndPointer
, OPTIONAL
577 Returns the length of a Null-terminated Ascii string.
579 This function is similar as strlen_s defined in C11.
581 @param String A pointer to a Null-terminated Ascii string.
582 @param MaxSize The maximum number of Destination Ascii
583 char, including terminating null char.
585 @retval 0 If String is NULL.
586 @retval MaxSize If there is no null character in the first MaxSize characters of String.
587 @return The number of characters that percede the terminating null character.
593 IN CONST CHAR8
*String
,
598 Returns the size of a Null-terminated Ascii string in bytes, including the
601 This function returns the size of the Null-terminated Ascii string specified
602 by String in bytes, including the Null terminator.
604 @param String A pointer to a Null-terminated Ascii string.
605 @param MaxSize The maximum number of Destination Ascii
606 char, including the Null terminator.
608 @retval 0 If String is NULL.
609 @retval (sizeof (CHAR8) * (MaxSize + 1))
610 If there is no Null terminator in the first MaxSize characters of
612 @return The size of the Null-terminated Ascii string in bytes, including the
619 IN CONST CHAR8
*String
,
624 Copies the string pointed to by Source (including the terminating null char)
625 to the array pointed to by Destination.
627 This function is similar as strcpy_s defined in C11.
629 If an error would be returned, then the function will also ASSERT().
631 If an error is returned, then the Destination is unmodified.
633 @param Destination A pointer to a Null-terminated Ascii string.
634 @param DestMax The maximum number of Destination Ascii
635 char, including terminating null char.
636 @param Source A pointer to a Null-terminated Ascii string.
638 @retval RETURN_SUCCESS String is copied.
639 @retval RETURN_BUFFER_TOO_SMALL If DestMax is NOT greater than StrLen(Source).
640 @retval RETURN_INVALID_PARAMETER If Destination is NULL.
642 If PcdMaximumAsciiStringLength is not zero,
643 and DestMax is greater than
644 PcdMaximumAsciiStringLength.
646 @retval RETURN_ACCESS_DENIED If Source and Destination overlap.
651 OUT CHAR8
*Destination
,
653 IN CONST CHAR8
*Source
657 Copies not more than Length successive char from the string pointed to by
658 Source to the array pointed to by Destination. If no null char is copied from
659 Source, then Destination[Length] is always set to null.
661 This function is similar as strncpy_s defined in C11.
663 If an error would be returned, then the function will also ASSERT().
665 If an error is returned, then the Destination is unmodified.
667 @param Destination A pointer to a Null-terminated Ascii string.
668 @param DestMax The maximum number of Destination Ascii
669 char, including terminating null char.
670 @param Source A pointer to a Null-terminated Ascii string.
671 @param Length The maximum number of Ascii characters to copy.
673 @retval RETURN_SUCCESS String is copied.
674 @retval RETURN_BUFFER_TOO_SMALL If DestMax is NOT greater than
675 MIN(StrLen(Source), Length).
676 @retval RETURN_INVALID_PARAMETER If Destination is NULL.
678 If PcdMaximumAsciiStringLength is not zero,
679 and DestMax is greater than
680 PcdMaximumAsciiStringLength.
682 @retval RETURN_ACCESS_DENIED If Source and Destination overlap.
687 OUT CHAR8
*Destination
,
689 IN CONST CHAR8
*Source
,
694 Appends a copy of the string pointed to by Source (including the terminating
695 null char) to the end of the string pointed to by Destination.
697 This function is similar as strcat_s defined in C11.
699 If an error would be returned, then the function will also ASSERT().
701 If an error is returned, then the Destination is unmodified.
703 @param Destination A pointer to a Null-terminated Ascii string.
704 @param DestMax The maximum number of Destination Ascii
705 char, including terminating null char.
706 @param Source A pointer to a Null-terminated Ascii string.
708 @retval RETURN_SUCCESS String is appended.
709 @retval RETURN_BAD_BUFFER_SIZE If DestMax is NOT greater than
711 @retval RETURN_BUFFER_TOO_SMALL If (DestMax - StrLen(Destination)) is NOT
712 greater than StrLen(Source).
713 @retval RETURN_INVALID_PARAMETER If Destination is NULL.
715 If PcdMaximumAsciiStringLength is not zero,
716 and DestMax is greater than
717 PcdMaximumAsciiStringLength.
719 @retval RETURN_ACCESS_DENIED If Source and Destination overlap.
724 IN OUT CHAR8
*Destination
,
726 IN CONST CHAR8
*Source
730 Appends not more than Length successive char from the string pointed to by
731 Source to the end of the string pointed to by Destination. If no null char is
732 copied from Source, then Destination[StrLen(Destination) + Length] is always
735 This function is similar as strncat_s defined in C11.
737 If an error would be returned, then the function will also ASSERT().
739 If an error is returned, then the Destination is unmodified.
741 @param Destination A pointer to a Null-terminated Ascii string.
742 @param DestMax The maximum number of Destination Ascii
743 char, including terminating null char.
744 @param Source A pointer to a Null-terminated Ascii string.
745 @param Length The maximum number of Ascii characters to copy.
747 @retval RETURN_SUCCESS String is appended.
748 @retval RETURN_BAD_BUFFER_SIZE If DestMax is NOT greater than
750 @retval RETURN_BUFFER_TOO_SMALL If (DestMax - StrLen(Destination)) is NOT
751 greater than MIN(StrLen(Source), Length).
752 @retval RETURN_INVALID_PARAMETER If Destination is NULL.
754 If PcdMaximumAsciiStringLength is not zero,
755 and DestMax is greater than
756 PcdMaximumAsciiStringLength.
758 @retval RETURN_ACCESS_DENIED If Source and Destination overlap.
763 IN OUT CHAR8
*Destination
,
765 IN CONST CHAR8
*Source
,
770 Convert a Null-terminated Ascii decimal string to a value of type UINTN.
772 This function outputs a value of type UINTN by interpreting the contents of
773 the Ascii string specified by String as a decimal number. The format of the
774 input Ascii string String is:
776 [spaces] [decimal digits].
778 The valid decimal digit character is in the range [0-9]. The function will
779 ignore the pad space, which includes spaces or tab characters, before
780 [decimal digits]. The running zero in the beginning of [decimal digits] will
781 be ignored. Then, the function stops at the first character that is a not a
782 valid decimal character or a Null-terminator, whichever one comes first.
784 If String is NULL, then ASSERT().
785 If Data is NULL, then ASSERT().
786 If PcdMaximumAsciiStringLength is not zero, and String contains more than
787 PcdMaximumAsciiStringLength Ascii characters, not including the
788 Null-terminator, then ASSERT().
790 If String has no valid decimal digits in the above format, then 0 is stored
791 at the location pointed to by Data.
792 If the number represented by String exceeds the range defined by UINTN, then
793 MAX_UINTN is stored at the location pointed to by Data.
795 If EndPointer is not NULL, a pointer to the character that stopped the scan
796 is stored at the location pointed to by EndPointer. If String has no valid
797 decimal digits right after the optional pad spaces, the value of String is
798 stored at the location pointed to by EndPointer.
800 @param String Pointer to a Null-terminated Ascii string.
801 @param EndPointer Pointer to character that stops scan.
802 @param Data Pointer to the converted value.
804 @retval RETURN_SUCCESS Value is translated from String.
805 @retval RETURN_INVALID_PARAMETER If String is NULL.
807 If PcdMaximumAsciiStringLength is not zero,
808 and String contains more than
809 PcdMaximumAsciiStringLength Ascii
810 characters, not including the
812 @retval RETURN_UNSUPPORTED If the number represented by String exceeds
813 the range defined by UINTN.
818 AsciiStrDecimalToUintnS (
819 IN CONST CHAR8
*String
,
820 OUT CHAR8
**EndPointer
, OPTIONAL
825 Convert a Null-terminated Ascii decimal string to a value of type UINT64.
827 This function outputs a value of type UINT64 by interpreting the contents of
828 the Ascii string specified by String as a decimal number. The format of the
829 input Ascii string String is:
831 [spaces] [decimal digits].
833 The valid decimal digit character is in the range [0-9]. The function will
834 ignore the pad space, which includes spaces or tab characters, before
835 [decimal digits]. The running zero in the beginning of [decimal digits] will
836 be ignored. Then, the function stops at the first character that is a not a
837 valid decimal character or a Null-terminator, whichever one comes first.
839 If String is NULL, then ASSERT().
840 If Data is NULL, then ASSERT().
841 If PcdMaximumAsciiStringLength is not zero, and String contains more than
842 PcdMaximumAsciiStringLength Ascii characters, not including the
843 Null-terminator, then ASSERT().
845 If String has no valid decimal digits in the above format, then 0 is stored
846 at the location pointed to by Data.
847 If the number represented by String exceeds the range defined by UINT64, then
848 MAX_UINT64 is stored at the location pointed to by Data.
850 If EndPointer is not NULL, a pointer to the character that stopped the scan
851 is stored at the location pointed to by EndPointer. If String has no valid
852 decimal digits right after the optional pad spaces, the value of String is
853 stored at the location pointed to by EndPointer.
855 @param String Pointer to a Null-terminated Ascii string.
856 @param EndPointer Pointer to character that stops scan.
857 @param Data Pointer to the converted value.
859 @retval RETURN_SUCCESS Value is translated from String.
860 @retval RETURN_INVALID_PARAMETER If String is NULL.
862 If PcdMaximumAsciiStringLength is not zero,
863 and String contains more than
864 PcdMaximumAsciiStringLength Ascii
865 characters, not including the
867 @retval RETURN_UNSUPPORTED If the number represented by String exceeds
868 the range defined by UINT64.
873 AsciiStrDecimalToUint64S (
874 IN CONST CHAR8
*String
,
875 OUT CHAR8
**EndPointer
, OPTIONAL
880 Convert a Null-terminated Ascii hexadecimal string to a value of type UINTN.
882 This function outputs a value of type UINTN by interpreting the contents of
883 the Ascii string specified by String as a hexadecimal number. The format of
884 the input Ascii string String is:
886 [spaces][zeros][x][hexadecimal digits].
888 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
889 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix. If
890 "x" appears in the input string, it must be prefixed with at least one 0. The
891 function will ignore the pad space, which includes spaces or tab characters,
892 before [zeros], [x] or [hexadecimal digits]. The running zero before [x] or
893 [hexadecimal digits] will be ignored. Then, the decoding starts after [x] or
894 the first valid hexadecimal digit. Then, the function stops at the first
895 character that is a not a valid hexadecimal character or Null-terminator,
896 whichever on comes first.
898 If String is NULL, then ASSERT().
899 If Data is NULL, then ASSERT().
900 If PcdMaximumAsciiStringLength is not zero, and String contains more than
901 PcdMaximumAsciiStringLength Ascii characters, not including the
902 Null-terminator, then ASSERT().
904 If String has no valid hexadecimal digits in the above format, then 0 is
905 stored at the location pointed to by Data.
906 If the number represented by String exceeds the range defined by UINTN, then
907 MAX_UINTN is stored at the location pointed to by Data.
909 If EndPointer is not NULL, a pointer to the character that stopped the scan
910 is stored at the location pointed to by EndPointer. If String has no valid
911 hexadecimal digits right after the optional pad spaces, the value of String
912 is stored at the location pointed to by EndPointer.
914 @param String Pointer to a Null-terminated Ascii string.
915 @param EndPointer Pointer to character that stops scan.
916 @param Data Pointer to the converted value.
918 @retval RETURN_SUCCESS Value is translated from String.
919 @retval RETURN_INVALID_PARAMETER If String is NULL.
921 If PcdMaximumAsciiStringLength is not zero,
922 and String contains more than
923 PcdMaximumAsciiStringLength Ascii
924 characters, not including the
926 @retval RETURN_UNSUPPORTED If the number represented by String exceeds
927 the range defined by UINTN.
932 AsciiStrHexToUintnS (
933 IN CONST CHAR8
*String
,
934 OUT CHAR8
**EndPointer
, OPTIONAL
939 Convert a Null-terminated Ascii hexadecimal string to a value of type UINT64.
941 This function outputs a value of type UINT64 by interpreting the contents of
942 the Ascii string specified by String as a hexadecimal number. The format of
943 the input Ascii string String is:
945 [spaces][zeros][x][hexadecimal digits].
947 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
948 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix. If
949 "x" appears in the input string, it must be prefixed with at least one 0. The
950 function will ignore the pad space, which includes spaces or tab characters,
951 before [zeros], [x] or [hexadecimal digits]. The running zero before [x] or
952 [hexadecimal digits] will be ignored. Then, the decoding starts after [x] or
953 the first valid hexadecimal digit. Then, the function stops at the first
954 character that is a not a valid hexadecimal character or Null-terminator,
955 whichever on comes first.
957 If String is NULL, then ASSERT().
958 If Data is NULL, then ASSERT().
959 If PcdMaximumAsciiStringLength is not zero, and String contains more than
960 PcdMaximumAsciiStringLength Ascii characters, not including the
961 Null-terminator, then ASSERT().
963 If String has no valid hexadecimal digits in the above format, then 0 is
964 stored at the location pointed to by Data.
965 If the number represented by String exceeds the range defined by UINT64, then
966 MAX_UINT64 is stored at the location pointed to by Data.
968 If EndPointer is not NULL, a pointer to the character that stopped the scan
969 is stored at the location pointed to by EndPointer. If String has no valid
970 hexadecimal digits right after the optional pad spaces, the value of String
971 is stored at the location pointed to by EndPointer.
973 @param String Pointer to a Null-terminated Ascii string.
974 @param EndPointer Pointer to character that stops scan.
975 @param Data Pointer to the converted value.
977 @retval RETURN_SUCCESS Value is translated from String.
978 @retval RETURN_INVALID_PARAMETER If String is NULL.
980 If PcdMaximumAsciiStringLength is not zero,
981 and String contains more than
982 PcdMaximumAsciiStringLength Ascii
983 characters, not including the
985 @retval RETURN_UNSUPPORTED If the number represented by String exceeds
986 the range defined by UINT64.
991 AsciiStrHexToUint64S (
992 IN CONST CHAR8
*String
,
993 OUT CHAR8
**EndPointer
, OPTIONAL
998 #ifndef DISABLE_NEW_DEPRECATED_INTERFACES
1001 [ATTENTION] This function is deprecated for security reason.
1003 Copies one Null-terminated Unicode string to another Null-terminated Unicode
1004 string and returns the new Unicode string.
1006 This function copies the contents of the Unicode string Source to the Unicode
1007 string Destination, and returns Destination. If Source and Destination
1008 overlap, then the results are undefined.
1010 If Destination is NULL, then ASSERT().
1011 If Destination is not aligned on a 16-bit boundary, then ASSERT().
1012 If Source is NULL, then ASSERT().
1013 If Source is not aligned on a 16-bit boundary, then ASSERT().
1014 If Source and Destination overlap, then ASSERT().
1015 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
1016 PcdMaximumUnicodeStringLength Unicode characters not including the
1017 Null-terminator, then ASSERT().
1019 @param Destination The pointer to a Null-terminated Unicode string.
1020 @param Source The pointer to a Null-terminated Unicode string.
1022 @return Destination.
1028 OUT CHAR16
*Destination
,
1029 IN CONST CHAR16
*Source
1034 [ATTENTION] This function is deprecated for security reason.
1036 Copies up to a specified length from one Null-terminated Unicode string to
1037 another Null-terminated Unicode string and returns the new Unicode string.
1039 This function copies the contents of the Unicode string Source to the Unicode
1040 string Destination, and returns Destination. At most, Length Unicode
1041 characters are copied from Source to Destination. If Length is 0, then
1042 Destination is returned unmodified. If Length is greater that the number of
1043 Unicode characters in Source, then Destination is padded with Null Unicode
1044 characters. If Source and Destination overlap, then the results are
1047 If Length > 0 and Destination is NULL, then ASSERT().
1048 If Length > 0 and Destination is not aligned on a 16-bit boundary, then ASSERT().
1049 If Length > 0 and Source is NULL, then ASSERT().
1050 If Length > 0 and Source is not aligned on a 16-bit boundary, then ASSERT().
1051 If Source and Destination overlap, then ASSERT().
1052 If PcdMaximumUnicodeStringLength is not zero, and Length is greater than
1053 PcdMaximumUnicodeStringLength, then ASSERT().
1054 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
1055 PcdMaximumUnicodeStringLength Unicode characters, not including the Null-terminator,
1058 @param Destination The pointer to a Null-terminated Unicode string.
1059 @param Source The pointer to a Null-terminated Unicode string.
1060 @param Length The maximum number of Unicode characters to copy.
1062 @return Destination.
1068 OUT CHAR16
*Destination
,
1069 IN CONST CHAR16
*Source
,
1072 #endif // !defined (DISABLE_NEW_DEPRECATED_INTERFACES)
1075 Returns the length of a Null-terminated Unicode string.
1077 This function returns the number of Unicode characters in the Null-terminated
1078 Unicode string specified by String.
1080 If String is NULL, then ASSERT().
1081 If String is not aligned on a 16-bit boundary, then ASSERT().
1082 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
1083 PcdMaximumUnicodeStringLength Unicode characters not including the
1084 Null-terminator, then ASSERT().
1086 @param String Pointer to a Null-terminated Unicode string.
1088 @return The length of String.
1094 IN CONST CHAR16
*String
1099 Returns the size of a Null-terminated Unicode string in bytes, including the
1102 This function returns the size, in bytes, of the Null-terminated Unicode string
1103 specified by String.
1105 If String is NULL, then ASSERT().
1106 If String is not aligned on a 16-bit boundary, then ASSERT().
1107 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
1108 PcdMaximumUnicodeStringLength Unicode characters not including the
1109 Null-terminator, then ASSERT().
1111 @param String The pointer to a Null-terminated Unicode string.
1113 @return The size of String.
1119 IN CONST CHAR16
*String
1124 Compares two Null-terminated Unicode strings, and returns the difference
1125 between the first mismatched Unicode characters.
1127 This function compares the Null-terminated Unicode string FirstString to the
1128 Null-terminated Unicode string SecondString. If FirstString is identical to
1129 SecondString, then 0 is returned. Otherwise, the value returned is the first
1130 mismatched Unicode character in SecondString subtracted from the first
1131 mismatched Unicode character in FirstString.
1133 If FirstString is NULL, then ASSERT().
1134 If FirstString is not aligned on a 16-bit boundary, then ASSERT().
1135 If SecondString is NULL, then ASSERT().
1136 If SecondString is not aligned on a 16-bit boundary, then ASSERT().
1137 If PcdMaximumUnicodeStringLength is not zero, and FirstString contains more
1138 than PcdMaximumUnicodeStringLength Unicode characters not including the
1139 Null-terminator, then ASSERT().
1140 If PcdMaximumUnicodeStringLength is not zero, and SecondString contains more
1141 than PcdMaximumUnicodeStringLength Unicode characters, not including the
1142 Null-terminator, then ASSERT().
1144 @param FirstString The pointer to a Null-terminated Unicode string.
1145 @param SecondString The pointer to a Null-terminated Unicode string.
1147 @retval 0 FirstString is identical to SecondString.
1148 @return others FirstString is not identical to SecondString.
1154 IN CONST CHAR16
*FirstString
,
1155 IN CONST CHAR16
*SecondString
1160 Compares up to a specified length the contents of two Null-terminated Unicode strings,
1161 and returns the difference between the first mismatched Unicode characters.
1163 This function compares the Null-terminated Unicode string FirstString to the
1164 Null-terminated Unicode string SecondString. At most, Length Unicode
1165 characters will be compared. If Length is 0, then 0 is returned. If
1166 FirstString is identical to SecondString, then 0 is returned. Otherwise, the
1167 value returned is the first mismatched Unicode character in SecondString
1168 subtracted from the first mismatched Unicode character in FirstString.
1170 If Length > 0 and FirstString is NULL, then ASSERT().
1171 If Length > 0 and FirstString is not aligned on a 16-bit boundary, then ASSERT().
1172 If Length > 0 and SecondString is NULL, then ASSERT().
1173 If Length > 0 and SecondString is not aligned on a 16-bit boundary, then ASSERT().
1174 If PcdMaximumUnicodeStringLength is not zero, and Length is greater than
1175 PcdMaximumUnicodeStringLength, then ASSERT().
1176 If PcdMaximumUnicodeStringLength is not zero, and FirstString contains more than
1177 PcdMaximumUnicodeStringLength Unicode characters, not including the Null-terminator,
1179 If PcdMaximumUnicodeStringLength is not zero, and SecondString contains more than
1180 PcdMaximumUnicodeStringLength Unicode characters, not including the Null-terminator,
1183 @param FirstString The pointer to a Null-terminated Unicode string.
1184 @param SecondString The pointer to a Null-terminated Unicode string.
1185 @param Length The maximum number of Unicode characters to compare.
1187 @retval 0 FirstString is identical to SecondString.
1188 @return others FirstString is not identical to SecondString.
1194 IN CONST CHAR16
*FirstString
,
1195 IN CONST CHAR16
*SecondString
,
1200 #ifndef DISABLE_NEW_DEPRECATED_INTERFACES
1203 [ATTENTION] This function is deprecated for security reason.
1205 Concatenates one Null-terminated Unicode string to another Null-terminated
1206 Unicode string, and returns the concatenated Unicode string.
1208 This function concatenates two Null-terminated Unicode strings. The contents
1209 of Null-terminated Unicode string Source are concatenated to the end of
1210 Null-terminated Unicode string Destination. The Null-terminated concatenated
1211 Unicode String is returned. If Source and Destination overlap, then the
1212 results are undefined.
1214 If Destination is NULL, then ASSERT().
1215 If Destination is not aligned on a 16-bit boundary, then ASSERT().
1216 If Source is NULL, then ASSERT().
1217 If Source is not aligned on a 16-bit boundary, then ASSERT().
1218 If Source and Destination overlap, then ASSERT().
1219 If PcdMaximumUnicodeStringLength is not zero, and Destination contains more
1220 than PcdMaximumUnicodeStringLength Unicode characters, not including the
1221 Null-terminator, then ASSERT().
1222 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
1223 PcdMaximumUnicodeStringLength Unicode characters, not including the
1224 Null-terminator, then ASSERT().
1225 If PcdMaximumUnicodeStringLength is not zero, and concatenating Destination
1226 and Source results in a Unicode string with more than
1227 PcdMaximumUnicodeStringLength Unicode characters, not including the
1228 Null-terminator, then ASSERT().
1230 @param Destination The pointer to a Null-terminated Unicode string.
1231 @param Source The pointer to a Null-terminated Unicode string.
1233 @return Destination.
1239 IN OUT CHAR16
*Destination
,
1240 IN CONST CHAR16
*Source
1245 [ATTENTION] This function is deprecated for security reason.
1247 Concatenates up to a specified length one Null-terminated Unicode to the end
1248 of another Null-terminated Unicode string, and returns the concatenated
1251 This function concatenates two Null-terminated Unicode strings. The contents
1252 of Null-terminated Unicode string Source are concatenated to the end of
1253 Null-terminated Unicode string Destination, and Destination is returned. At
1254 most, Length Unicode characters are concatenated from Source to the end of
1255 Destination, and Destination is always Null-terminated. If Length is 0, then
1256 Destination is returned unmodified. If Source and Destination overlap, then
1257 the results are undefined.
1259 If Destination is NULL, then ASSERT().
1260 If Length > 0 and Destination is not aligned on a 16-bit boundary, then ASSERT().
1261 If Length > 0 and Source is NULL, then ASSERT().
1262 If Length > 0 and Source is not aligned on a 16-bit boundary, then ASSERT().
1263 If Source and Destination overlap, then ASSERT().
1264 If PcdMaximumUnicodeStringLength is not zero, and Length is greater than
1265 PcdMaximumUnicodeStringLength, then ASSERT().
1266 If PcdMaximumUnicodeStringLength is not zero, and Destination contains more
1267 than PcdMaximumUnicodeStringLength Unicode characters, not including the
1268 Null-terminator, then ASSERT().
1269 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
1270 PcdMaximumUnicodeStringLength Unicode characters, not including the
1271 Null-terminator, then ASSERT().
1272 If PcdMaximumUnicodeStringLength is not zero, and concatenating Destination
1273 and Source results in a Unicode string with more than PcdMaximumUnicodeStringLength
1274 Unicode characters, not including the Null-terminator, then ASSERT().
1276 @param Destination The pointer to a Null-terminated Unicode string.
1277 @param Source The pointer to a Null-terminated Unicode string.
1278 @param Length The maximum number of Unicode characters to concatenate from
1281 @return Destination.
1287 IN OUT CHAR16
*Destination
,
1288 IN CONST CHAR16
*Source
,
1291 #endif // !defined (DISABLE_NEW_DEPRECATED_INTERFACES)
1294 Returns the first occurrence of a Null-terminated Unicode sub-string
1295 in a Null-terminated Unicode string.
1297 This function scans the contents of the Null-terminated Unicode string
1298 specified by String and returns the first occurrence of SearchString.
1299 If SearchString is not found in String, then NULL is returned. If
1300 the length of SearchString is zero, then String is returned.
1302 If String is NULL, then ASSERT().
1303 If String is not aligned on a 16-bit boundary, then ASSERT().
1304 If SearchString is NULL, then ASSERT().
1305 If SearchString is not aligned on a 16-bit boundary, then ASSERT().
1307 If PcdMaximumUnicodeStringLength is not zero, and SearchString
1308 or String contains more than PcdMaximumUnicodeStringLength Unicode
1309 characters, not including the Null-terminator, then ASSERT().
1311 @param String The pointer to a Null-terminated Unicode string.
1312 @param SearchString The pointer to a Null-terminated Unicode string to search for.
1314 @retval NULL If the SearchString does not appear in String.
1315 @return others If there is a match.
1321 IN CONST CHAR16
*String
,
1322 IN CONST CHAR16
*SearchString
1326 Convert a Null-terminated Unicode decimal string to a value of
1329 This function returns a value of type UINTN by interpreting the contents
1330 of the Unicode string specified by String as a decimal number. The format
1331 of the input Unicode string String is:
1333 [spaces] [decimal digits].
1335 The valid decimal digit character is in the range [0-9]. The
1336 function will ignore the pad space, which includes spaces or
1337 tab characters, before [decimal digits]. The running zero in the
1338 beginning of [decimal digits] will be ignored. Then, the function
1339 stops at the first character that is a not a valid decimal character
1340 or a Null-terminator, whichever one comes first.
1342 If String is NULL, then ASSERT().
1343 If String is not aligned in a 16-bit boundary, then ASSERT().
1344 If String has only pad spaces, then 0 is returned.
1345 If String has no pad spaces or valid decimal digits,
1347 If the number represented by String overflows according
1348 to the range defined by UINTN, then MAX_UINTN is returned.
1350 If PcdMaximumUnicodeStringLength is not zero, and String contains
1351 more than PcdMaximumUnicodeStringLength Unicode characters not including
1352 the Null-terminator, then ASSERT().
1354 @param String The pointer to a Null-terminated Unicode string.
1356 @retval Value translated from String.
1362 IN CONST CHAR16
*String
1366 Convert a Null-terminated Unicode decimal string to a value of
1369 This function returns a value of type UINT64 by interpreting the contents
1370 of the Unicode string specified by String as a decimal number. The format
1371 of the input Unicode string String is:
1373 [spaces] [decimal digits].
1375 The valid decimal digit character is in the range [0-9]. The
1376 function will ignore the pad space, which includes spaces or
1377 tab characters, before [decimal digits]. The running zero in the
1378 beginning of [decimal digits] will be ignored. Then, the function
1379 stops at the first character that is a not a valid decimal character
1380 or a Null-terminator, whichever one comes first.
1382 If String is NULL, then ASSERT().
1383 If String is not aligned in a 16-bit boundary, then ASSERT().
1384 If String has only pad spaces, then 0 is returned.
1385 If String has no pad spaces or valid decimal digits,
1387 If the number represented by String overflows according
1388 to the range defined by UINT64, then MAX_UINT64 is returned.
1390 If PcdMaximumUnicodeStringLength is not zero, and String contains
1391 more than PcdMaximumUnicodeStringLength Unicode characters not including
1392 the Null-terminator, then ASSERT().
1394 @param String The pointer to a Null-terminated Unicode string.
1396 @retval Value translated from String.
1401 StrDecimalToUint64 (
1402 IN CONST CHAR16
*String
1407 Convert a Null-terminated Unicode hexadecimal string to a value of type UINTN.
1409 This function returns a value of type UINTN by interpreting the contents
1410 of the Unicode string specified by String as a hexadecimal number.
1411 The format of the input Unicode string String is:
1413 [spaces][zeros][x][hexadecimal digits].
1415 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
1416 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix.
1417 If "x" appears in the input string, it must be prefixed with at least one 0.
1418 The function will ignore the pad space, which includes spaces or tab characters,
1419 before [zeros], [x] or [hexadecimal digit]. The running zero before [x] or
1420 [hexadecimal digit] will be ignored. Then, the decoding starts after [x] or the
1421 first valid hexadecimal digit. Then, the function stops at the first character
1422 that is a not a valid hexadecimal character or NULL, whichever one comes first.
1424 If String is NULL, then ASSERT().
1425 If String is not aligned in a 16-bit boundary, then ASSERT().
1426 If String has only pad spaces, then zero is returned.
1427 If String has no leading pad spaces, leading zeros or valid hexadecimal digits,
1428 then zero is returned.
1429 If the number represented by String overflows according to the range defined by
1430 UINTN, then MAX_UINTN is returned.
1432 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
1433 PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator,
1436 @param String The pointer to a Null-terminated Unicode string.
1438 @retval Value translated from String.
1444 IN CONST CHAR16
*String
1449 Convert a Null-terminated Unicode hexadecimal string to a value of type UINT64.
1451 This function returns a value of type UINT64 by interpreting the contents
1452 of the Unicode string specified by String as a hexadecimal number.
1453 The format of the input Unicode string String is
1455 [spaces][zeros][x][hexadecimal digits].
1457 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
1458 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix.
1459 If "x" appears in the input string, it must be prefixed with at least one 0.
1460 The function will ignore the pad space, which includes spaces or tab characters,
1461 before [zeros], [x] or [hexadecimal digit]. The running zero before [x] or
1462 [hexadecimal digit] will be ignored. Then, the decoding starts after [x] or the
1463 first valid hexadecimal digit. Then, the function stops at the first character that is
1464 a not a valid hexadecimal character or NULL, whichever one comes first.
1466 If String is NULL, then ASSERT().
1467 If String is not aligned in a 16-bit boundary, then ASSERT().
1468 If String has only pad spaces, then zero is returned.
1469 If String has no leading pad spaces, leading zeros or valid hexadecimal digits,
1470 then zero is returned.
1471 If the number represented by String overflows according to the range defined by
1472 UINT64, then MAX_UINT64 is returned.
1474 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
1475 PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator,
1478 @param String The pointer to a Null-terminated Unicode string.
1480 @retval Value translated from String.
1486 IN CONST CHAR16
*String
1490 Convert a Null-terminated Unicode string to IPv6 address and prefix length.
1492 This function outputs a value of type IPv6_ADDRESS and may output a value
1493 of type UINT8 by interpreting the contents of the Unicode string specified
1494 by String. The format of the input Unicode string String is as follows:
1498 X contains one to four hexadecimal digit characters in the range [0-9], [a-f] and
1499 [A-F]. X is converted to a value of type UINT16, whose low byte is stored in low
1500 memory address and high byte is stored in high memory address. P contains decimal
1501 digit characters in the range [0-9]. The running zero in the beginning of P will
1502 be ignored. /P is optional.
1504 When /P is not in the String, the function stops at the first character that is
1505 not a valid hexadecimal digit character after eight X's are converted.
1507 When /P is in the String, the function stops at the first character that is not
1508 a valid decimal digit character after P is converted.
1510 "::" can be used to compress one or more groups of X when X contains only 0.
1511 The "::" can only appear once in the String.
1513 If String is NULL, then ASSERT().
1515 If Address is NULL, then ASSERT().
1517 If String is not aligned in a 16-bit boundary, then ASSERT().
1519 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
1520 PcdMaximumUnicodeStringLength Unicode characters, not including the
1521 Null-terminator, then ASSERT().
1523 If EndPointer is not NULL and Address is translated from String, a pointer
1524 to the character that stopped the scan is stored at the location pointed to
1527 @param String Pointer to a Null-terminated Unicode string.
1528 @param EndPointer Pointer to character that stops scan.
1529 @param Address Pointer to the converted IPv6 address.
1530 @param PrefixLength Pointer to the converted IPv6 address prefix
1531 length. MAX_UINT8 is returned when /P is
1534 @retval RETURN_SUCCESS Address is translated from String.
1535 @retval RETURN_INVALID_PARAMETER If String is NULL.
1537 @retval RETURN_UNSUPPORTED If X contains more than four hexadecimal
1539 If String contains "::" and number of X
1541 If P starts with character that is not a
1542 valid decimal digit character.
1543 If the decimal number converted from P
1550 IN CONST CHAR16
*String
,
1551 OUT CHAR16
**EndPointer
, OPTIONAL
1552 OUT IPv6_ADDRESS
*Address
,
1553 OUT UINT8
*PrefixLength OPTIONAL
1557 Convert a Null-terminated Unicode string to IPv4 address and prefix length.
1559 This function outputs a value of type IPv4_ADDRESS and may output a value
1560 of type UINT8 by interpreting the contents of the Unicode string specified
1561 by String. The format of the input Unicode string String is as follows:
1565 D and P are decimal digit characters in the range [0-9]. The running zero in
1566 the beginning of D and P will be ignored. /P is optional.
1568 When /P is not in the String, the function stops at the first character that is
1569 not a valid decimal digit character after four D's are converted.
1571 When /P is in the String, the function stops at the first character that is not
1572 a valid decimal digit character after P is converted.
1574 If String is NULL, then ASSERT().
1576 If Address is NULL, then ASSERT().
1578 If String is not aligned in a 16-bit boundary, then ASSERT().
1580 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
1581 PcdMaximumUnicodeStringLength Unicode characters, not including the
1582 Null-terminator, then ASSERT().
1584 If EndPointer is not NULL and Address is translated from String, a pointer
1585 to the character that stopped the scan is stored at the location pointed to
1588 @param String Pointer to a Null-terminated Unicode string.
1589 @param EndPointer Pointer to character that stops scan.
1590 @param Address Pointer to the converted IPv4 address.
1591 @param PrefixLength Pointer to the converted IPv4 address prefix
1592 length. MAX_UINT8 is returned when /P is
1595 @retval RETURN_SUCCESS Address is translated from String.
1596 @retval RETURN_INVALID_PARAMETER If String is NULL.
1598 @retval RETURN_UNSUPPORTED If String is not in the correct format.
1599 If any decimal number converted from D
1601 If the decimal number converted from P
1608 IN CONST CHAR16
*String
,
1609 OUT CHAR16
**EndPointer
, OPTIONAL
1610 OUT IPv4_ADDRESS
*Address
,
1611 OUT UINT8
*PrefixLength OPTIONAL
1614 #define GUID_STRING_LENGTH 36
1617 Convert a Null-terminated Unicode GUID string to a value of type
1620 This function outputs a GUID value by interpreting the contents of
1621 the Unicode string specified by String. The format of the input
1622 Unicode string String consists of 36 characters, as follows:
1624 aabbccdd-eeff-gghh-iijj-kkllmmnnoopp
1626 The pairs aa - pp are two characters in the range [0-9], [a-f] and
1627 [A-F], with each pair representing a single byte hexadecimal value.
1629 The mapping between String and the EFI_GUID structure is as follows:
1647 If String is NULL, then ASSERT().
1648 If Guid is NULL, then ASSERT().
1649 If String is not aligned in a 16-bit boundary, then ASSERT().
1651 @param String Pointer to a Null-terminated Unicode string.
1652 @param Guid Pointer to the converted GUID.
1654 @retval RETURN_SUCCESS Guid is translated from String.
1655 @retval RETURN_INVALID_PARAMETER If String is NULL.
1657 @retval RETURN_UNSUPPORTED If String is not as the above format.
1663 IN CONST CHAR16
*String
,
1668 Convert a Null-terminated Unicode hexadecimal string to a byte array.
1670 This function outputs a byte array by interpreting the contents of
1671 the Unicode string specified by String in hexadecimal format. The format of
1672 the input Unicode string String is:
1676 X is a hexadecimal digit character in the range [0-9], [a-f] and [A-F].
1677 The function decodes every two hexadecimal digit characters as one byte. The
1678 decoding stops after Length of characters and outputs Buffer containing
1681 If String is not aligned in a 16-bit boundary, then ASSERT().
1683 If String is NULL, then ASSERT().
1685 If Buffer is NULL, then ASSERT().
1687 If Length is not multiple of 2, then ASSERT().
1689 If PcdMaximumUnicodeStringLength is not zero and Length is greater than
1690 PcdMaximumUnicodeStringLength, then ASSERT().
1692 If MaxBufferSize is less than (Length / 2), then ASSERT().
1694 @param String Pointer to a Null-terminated Unicode string.
1695 @param Length The number of Unicode characters to decode.
1696 @param Buffer Pointer to the converted bytes array.
1697 @param MaxBufferSize The maximum size of Buffer.
1699 @retval RETURN_SUCCESS Buffer is translated from String.
1700 @retval RETURN_INVALID_PARAMETER If String is NULL.
1702 If Length is not multiple of 2.
1703 If PcdMaximumUnicodeStringLength is not zero,
1704 and Length is greater than
1705 PcdMaximumUnicodeStringLength.
1706 @retval RETURN_UNSUPPORTED If Length of characters from String contain
1707 a character that is not valid hexadecimal
1708 digit characters, or a Null-terminator.
1709 @retval RETURN_BUFFER_TOO_SMALL If MaxBufferSize is less than (Length / 2).
1714 IN CONST CHAR16
*String
,
1717 IN UINTN MaxBufferSize
1720 #ifndef DISABLE_NEW_DEPRECATED_INTERFACES
1723 [ATTENTION] This function is deprecated for security reason.
1725 Convert a Null-terminated Unicode string to a Null-terminated
1726 ASCII string and returns the ASCII string.
1728 This function converts the content of the Unicode string Source
1729 to the ASCII string Destination by copying the lower 8 bits of
1730 each Unicode character. It returns Destination.
1732 The caller is responsible to make sure Destination points to a buffer with size
1733 equal or greater than ((StrLen (Source) + 1) * sizeof (CHAR8)) in bytes.
1735 If any Unicode characters in Source contain non-zero value in
1736 the upper 8 bits, then ASSERT().
1738 If Destination is NULL, then ASSERT().
1739 If Source is NULL, then ASSERT().
1740 If Source is not aligned on a 16-bit boundary, then ASSERT().
1741 If Source and Destination overlap, then ASSERT().
1743 If PcdMaximumUnicodeStringLength is not zero, and Source contains
1744 more than PcdMaximumUnicodeStringLength Unicode characters not including
1745 the Null-terminator, then ASSERT().
1747 If PcdMaximumAsciiStringLength is not zero, and Source contains more
1748 than PcdMaximumAsciiStringLength Unicode characters not including the
1749 Null-terminator, then ASSERT().
1751 @param Source The pointer to a Null-terminated Unicode string.
1752 @param Destination The pointer to a Null-terminated ASCII string.
1754 @return Destination.
1759 UnicodeStrToAsciiStr (
1760 IN CONST CHAR16
*Source
,
1761 OUT CHAR8
*Destination
1764 #endif // !defined (DISABLE_NEW_DEPRECATED_INTERFACES)
1767 Convert a Null-terminated Unicode string to a Null-terminated
1770 This function is similar to AsciiStrCpyS.
1772 This function converts the content of the Unicode string Source
1773 to the ASCII string Destination by copying the lower 8 bits of
1774 each Unicode character. The function terminates the ASCII string
1775 Destination by appending a Null-terminator character at the end.
1777 The caller is responsible to make sure Destination points to a buffer with size
1778 equal or greater than ((StrLen (Source) + 1) * sizeof (CHAR8)) in bytes.
1780 If any Unicode characters in Source contain non-zero value in
1781 the upper 8 bits, then ASSERT().
1783 If Source is not aligned on a 16-bit boundary, then ASSERT().
1784 If an error would be returned, then the function will also ASSERT().
1786 If an error is returned, then the Destination is unmodified.
1788 @param Source The pointer to a Null-terminated Unicode string.
1789 @param Destination The pointer to a Null-terminated ASCII string.
1790 @param DestMax The maximum number of Destination Ascii
1791 char, including terminating null char.
1793 @retval RETURN_SUCCESS String is converted.
1794 @retval RETURN_BUFFER_TOO_SMALL If DestMax is NOT greater than StrLen(Source).
1795 @retval RETURN_INVALID_PARAMETER If Destination is NULL.
1797 If PcdMaximumAsciiStringLength is not zero,
1798 and DestMax is greater than
1799 PcdMaximumAsciiStringLength.
1800 If PcdMaximumUnicodeStringLength is not zero,
1801 and DestMax is greater than
1802 PcdMaximumUnicodeStringLength.
1804 @retval RETURN_ACCESS_DENIED If Source and Destination overlap.
1809 UnicodeStrToAsciiStrS (
1810 IN CONST CHAR16
*Source
,
1811 OUT CHAR8
*Destination
,
1816 Convert not more than Length successive characters from a Null-terminated
1817 Unicode string to a Null-terminated Ascii string. If no null char is copied
1818 from Source, then Destination[Length] is always set to null.
1820 This function converts not more than Length successive characters from the
1821 Unicode string Source to the Ascii string Destination by copying the lower 8
1822 bits of each Unicode character. The function terminates the Ascii string
1823 Destination by appending a Null-terminator character at the end.
1825 The caller is responsible to make sure Destination points to a buffer with size
1826 equal or greater than ((StrLen (Source) + 1) * sizeof (CHAR8)) in bytes.
1828 If any Unicode characters in Source contain non-zero value in the upper 8
1829 bits, then ASSERT().
1830 If Source is not aligned on a 16-bit boundary, then ASSERT().
1831 If an error would be returned, then the function will also ASSERT().
1833 If an error is returned, then the Destination is unmodified.
1835 @param Source The pointer to a Null-terminated Unicode string.
1836 @param Length The maximum number of Unicode characters to
1838 @param Destination The pointer to a Null-terminated Ascii string.
1839 @param DestMax The maximum number of Destination Ascii
1840 char, including terminating null char.
1841 @param DestinationLength The number of Unicode characters converted.
1843 @retval RETURN_SUCCESS String is converted.
1844 @retval RETURN_INVALID_PARAMETER If Destination is NULL.
1846 If DestinationLength is NULL.
1847 If PcdMaximumAsciiStringLength is not zero,
1848 and Length or DestMax is greater than
1849 PcdMaximumAsciiStringLength.
1850 If PcdMaximumUnicodeStringLength is not
1851 zero, and Length or DestMax is greater than
1852 PcdMaximumUnicodeStringLength.
1854 @retval RETURN_BUFFER_TOO_SMALL If DestMax is NOT greater than
1855 MIN(StrLen(Source), Length).
1856 @retval RETURN_ACCESS_DENIED If Source and Destination overlap.
1861 UnicodeStrnToAsciiStrS (
1862 IN CONST CHAR16
*Source
,
1864 OUT CHAR8
*Destination
,
1866 OUT UINTN
*DestinationLength
1869 #ifndef DISABLE_NEW_DEPRECATED_INTERFACES
1872 [ATTENTION] This function is deprecated for security reason.
1874 Copies one Null-terminated ASCII string to another Null-terminated ASCII
1875 string and returns the new ASCII string.
1877 This function copies the contents of the ASCII string Source to the ASCII
1878 string Destination, and returns Destination. If Source and Destination
1879 overlap, then the results are undefined.
1881 If Destination is NULL, then ASSERT().
1882 If Source is NULL, then ASSERT().
1883 If Source and Destination overlap, then ASSERT().
1884 If PcdMaximumAsciiStringLength is not zero and Source contains more than
1885 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
1888 @param Destination The pointer to a Null-terminated ASCII string.
1889 @param Source The pointer to a Null-terminated ASCII string.
1897 OUT CHAR8
*Destination
,
1898 IN CONST CHAR8
*Source
1903 [ATTENTION] This function is deprecated for security reason.
1905 Copies up to a specified length one Null-terminated ASCII string to another
1906 Null-terminated ASCII string and returns the new ASCII string.
1908 This function copies the contents of the ASCII string Source to the ASCII
1909 string Destination, and returns Destination. At most, Length ASCII characters
1910 are copied from Source to Destination. If Length is 0, then Destination is
1911 returned unmodified. If Length is greater that the number of ASCII characters
1912 in Source, then Destination is padded with Null ASCII characters. If Source
1913 and Destination overlap, then the results are undefined.
1915 If Destination is NULL, then ASSERT().
1916 If Source is NULL, then ASSERT().
1917 If Source and Destination overlap, then ASSERT().
1918 If PcdMaximumAsciiStringLength is not zero, and Length is greater than
1919 PcdMaximumAsciiStringLength, then ASSERT().
1920 If PcdMaximumAsciiStringLength is not zero, and Source contains more than
1921 PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator,
1924 @param Destination The pointer to a Null-terminated ASCII string.
1925 @param Source The pointer to a Null-terminated ASCII string.
1926 @param Length The maximum number of ASCII characters to copy.
1934 OUT CHAR8
*Destination
,
1935 IN CONST CHAR8
*Source
,
1938 #endif // !defined (DISABLE_NEW_DEPRECATED_INTERFACES)
1941 Returns the length of a Null-terminated ASCII string.
1943 This function returns the number of ASCII characters in the Null-terminated
1944 ASCII string specified by String.
1946 If Length > 0 and Destination is NULL, then ASSERT().
1947 If Length > 0 and Source is NULL, then ASSERT().
1948 If PcdMaximumAsciiStringLength is not zero and String contains more than
1949 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
1952 @param String The pointer to a Null-terminated ASCII string.
1954 @return The length of String.
1960 IN CONST CHAR8
*String
1965 Returns the size of a Null-terminated ASCII string in bytes, including the
1968 This function returns the size, in bytes, of the Null-terminated ASCII string
1969 specified by String.
1971 If String is NULL, then ASSERT().
1972 If PcdMaximumAsciiStringLength is not zero and String contains more than
1973 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
1976 @param String The pointer to a Null-terminated ASCII string.
1978 @return The size of String.
1984 IN CONST CHAR8
*String
1989 Compares two Null-terminated ASCII strings, and returns the difference
1990 between the first mismatched ASCII characters.
1992 This function compares the Null-terminated ASCII string FirstString to the
1993 Null-terminated ASCII string SecondString. If FirstString is identical to
1994 SecondString, then 0 is returned. Otherwise, the value returned is the first
1995 mismatched ASCII character in SecondString subtracted from the first
1996 mismatched ASCII character in FirstString.
1998 If FirstString is NULL, then ASSERT().
1999 If SecondString is NULL, then ASSERT().
2000 If PcdMaximumAsciiStringLength is not zero and FirstString contains more than
2001 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
2003 If PcdMaximumAsciiStringLength is not zero and SecondString contains more
2004 than PcdMaximumAsciiStringLength ASCII characters not including the
2005 Null-terminator, then ASSERT().
2007 @param FirstString The pointer to a Null-terminated ASCII string.
2008 @param SecondString The pointer to a Null-terminated ASCII string.
2010 @retval ==0 FirstString is identical to SecondString.
2011 @retval !=0 FirstString is not identical to SecondString.
2017 IN CONST CHAR8
*FirstString
,
2018 IN CONST CHAR8
*SecondString
2023 Performs a case insensitive comparison of two Null-terminated ASCII strings,
2024 and returns the difference between the first mismatched ASCII characters.
2026 This function performs a case insensitive comparison of the Null-terminated
2027 ASCII string FirstString to the Null-terminated ASCII string SecondString. If
2028 FirstString is identical to SecondString, then 0 is returned. Otherwise, the
2029 value returned is the first mismatched lower case ASCII character in
2030 SecondString subtracted from the first mismatched lower case ASCII character
2033 If FirstString is NULL, then ASSERT().
2034 If SecondString is NULL, then ASSERT().
2035 If PcdMaximumAsciiStringLength is not zero and FirstString contains more than
2036 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
2038 If PcdMaximumAsciiStringLength is not zero and SecondString contains more
2039 than PcdMaximumAsciiStringLength ASCII characters not including the
2040 Null-terminator, then ASSERT().
2042 @param FirstString The pointer to a Null-terminated ASCII string.
2043 @param SecondString The pointer to a Null-terminated ASCII string.
2045 @retval ==0 FirstString is identical to SecondString using case insensitive
2047 @retval !=0 FirstString is not identical to SecondString using case
2048 insensitive comparisons.
2054 IN CONST CHAR8
*FirstString
,
2055 IN CONST CHAR8
*SecondString
2060 Compares two Null-terminated ASCII strings with maximum lengths, and returns
2061 the difference between the first mismatched ASCII characters.
2063 This function compares the Null-terminated ASCII string FirstString to the
2064 Null-terminated ASCII string SecondString. At most, Length ASCII characters
2065 will be compared. If Length is 0, then 0 is returned. If FirstString is
2066 identical to SecondString, then 0 is returned. Otherwise, the value returned
2067 is the first mismatched ASCII character in SecondString subtracted from the
2068 first mismatched ASCII character in FirstString.
2070 If Length > 0 and FirstString is NULL, then ASSERT().
2071 If Length > 0 and SecondString is NULL, then ASSERT().
2072 If PcdMaximumAsciiStringLength is not zero, and Length is greater than
2073 PcdMaximumAsciiStringLength, then ASSERT().
2074 If PcdMaximumAsciiStringLength is not zero, and FirstString contains more than
2075 PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator,
2077 If PcdMaximumAsciiStringLength is not zero, and SecondString contains more than
2078 PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator,
2081 @param FirstString The pointer to a Null-terminated ASCII string.
2082 @param SecondString The pointer to a Null-terminated ASCII string.
2083 @param Length The maximum number of ASCII characters for compare.
2085 @retval ==0 FirstString is identical to SecondString.
2086 @retval !=0 FirstString is not identical to SecondString.
2092 IN CONST CHAR8
*FirstString
,
2093 IN CONST CHAR8
*SecondString
,
2098 #ifndef DISABLE_NEW_DEPRECATED_INTERFACES
2101 [ATTENTION] This function is deprecated for security reason.
2103 Concatenates one Null-terminated ASCII string to another Null-terminated
2104 ASCII string, and returns the concatenated ASCII string.
2106 This function concatenates two Null-terminated ASCII strings. The contents of
2107 Null-terminated ASCII string Source are concatenated to the end of Null-
2108 terminated ASCII string Destination. The Null-terminated concatenated ASCII
2111 If Destination is NULL, then ASSERT().
2112 If Source is NULL, then ASSERT().
2113 If PcdMaximumAsciiStringLength is not zero and Destination contains more than
2114 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
2116 If PcdMaximumAsciiStringLength is not zero and Source contains more than
2117 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
2119 If PcdMaximumAsciiStringLength is not zero and concatenating Destination and
2120 Source results in a ASCII string with more than PcdMaximumAsciiStringLength
2121 ASCII characters, then ASSERT().
2123 @param Destination The pointer to a Null-terminated ASCII string.
2124 @param Source The pointer to a Null-terminated ASCII string.
2132 IN OUT CHAR8
*Destination
,
2133 IN CONST CHAR8
*Source
2138 [ATTENTION] This function is deprecated for security reason.
2140 Concatenates up to a specified length one Null-terminated ASCII string to
2141 the end of another Null-terminated ASCII string, and returns the
2142 concatenated ASCII string.
2144 This function concatenates two Null-terminated ASCII strings. The contents
2145 of Null-terminated ASCII string Source are concatenated to the end of Null-
2146 terminated ASCII string Destination, and Destination is returned. At most,
2147 Length ASCII characters are concatenated from Source to the end of
2148 Destination, and Destination is always Null-terminated. If Length is 0, then
2149 Destination is returned unmodified. If Source and Destination overlap, then
2150 the results are undefined.
2152 If Length > 0 and Destination is NULL, then ASSERT().
2153 If Length > 0 and Source is NULL, then ASSERT().
2154 If Source and Destination overlap, then ASSERT().
2155 If PcdMaximumAsciiStringLength is not zero, and Length is greater than
2156 PcdMaximumAsciiStringLength, then ASSERT().
2157 If PcdMaximumAsciiStringLength is not zero, and Destination contains more than
2158 PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator,
2160 If PcdMaximumAsciiStringLength is not zero, and Source contains more than
2161 PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator,
2163 If PcdMaximumAsciiStringLength is not zero, and concatenating Destination and
2164 Source results in a ASCII string with more than PcdMaximumAsciiStringLength
2165 ASCII characters, not including the Null-terminator, then ASSERT().
2167 @param Destination The pointer to a Null-terminated ASCII string.
2168 @param Source The pointer to a Null-terminated ASCII string.
2169 @param Length The maximum number of ASCII characters to concatenate from
2178 IN OUT CHAR8
*Destination
,
2179 IN CONST CHAR8
*Source
,
2182 #endif // !defined (DISABLE_NEW_DEPRECATED_INTERFACES)
2185 Returns the first occurrence of a Null-terminated ASCII sub-string
2186 in a Null-terminated ASCII string.
2188 This function scans the contents of the ASCII string specified by String
2189 and returns the first occurrence of SearchString. If SearchString is not
2190 found in String, then NULL is returned. If the length of SearchString is zero,
2191 then String is returned.
2193 If String is NULL, then ASSERT().
2194 If SearchString is NULL, then ASSERT().
2196 If PcdMaximumAsciiStringLength is not zero, and SearchString or
2197 String contains more than PcdMaximumAsciiStringLength Unicode characters
2198 not including the Null-terminator, then ASSERT().
2200 @param String The pointer to a Null-terminated ASCII string.
2201 @param SearchString The pointer to a Null-terminated ASCII string to search for.
2203 @retval NULL If the SearchString does not appear in String.
2204 @retval others If there is a match return the first occurrence of SearchingString.
2205 If the length of SearchString is zero,return String.
2211 IN CONST CHAR8
*String
,
2212 IN CONST CHAR8
*SearchString
2217 Convert a Null-terminated ASCII decimal string to a value of type
2220 This function returns a value of type UINTN by interpreting the contents
2221 of the ASCII string String as a decimal number. The format of the input
2222 ASCII string String is:
2224 [spaces] [decimal digits].
2226 The valid decimal digit character is in the range [0-9]. The function will
2227 ignore the pad space, which includes spaces or tab characters, before the digits.
2228 The running zero in the beginning of [decimal digits] will be ignored. Then, the
2229 function stops at the first character that is a not a valid decimal character or
2230 Null-terminator, whichever on comes first.
2232 If String has only pad spaces, then 0 is returned.
2233 If String has no pad spaces or valid decimal digits, then 0 is returned.
2234 If the number represented by String overflows according to the range defined by
2235 UINTN, then MAX_UINTN is returned.
2236 If String is NULL, then ASSERT().
2237 If PcdMaximumAsciiStringLength is not zero, and String contains more than
2238 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
2241 @param String The pointer to a Null-terminated ASCII string.
2243 @retval The value translated from String.
2248 AsciiStrDecimalToUintn (
2249 IN CONST CHAR8
*String
2254 Convert a Null-terminated ASCII decimal string to a value of type
2257 This function returns a value of type UINT64 by interpreting the contents
2258 of the ASCII string String as a decimal number. The format of the input
2259 ASCII string String is:
2261 [spaces] [decimal digits].
2263 The valid decimal digit character is in the range [0-9]. The function will
2264 ignore the pad space, which includes spaces or tab characters, before the digits.
2265 The running zero in the beginning of [decimal digits] will be ignored. Then, the
2266 function stops at the first character that is a not a valid decimal character or
2267 Null-terminator, whichever on comes first.
2269 If String has only pad spaces, then 0 is returned.
2270 If String has no pad spaces or valid decimal digits, then 0 is returned.
2271 If the number represented by String overflows according to the range defined by
2272 UINT64, then MAX_UINT64 is returned.
2273 If String is NULL, then ASSERT().
2274 If PcdMaximumAsciiStringLength is not zero, and String contains more than
2275 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
2278 @param String The pointer to a Null-terminated ASCII string.
2280 @retval Value translated from String.
2285 AsciiStrDecimalToUint64 (
2286 IN CONST CHAR8
*String
2291 Convert a Null-terminated ASCII hexadecimal string to a value of type UINTN.
2293 This function returns a value of type UINTN by interpreting the contents of
2294 the ASCII string String as a hexadecimal number. The format of the input ASCII
2297 [spaces][zeros][x][hexadecimal digits].
2299 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
2300 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix. If "x"
2301 appears in the input string, it must be prefixed with at least one 0. The function
2302 will ignore the pad space, which includes spaces or tab characters, before [zeros],
2303 [x] or [hexadecimal digits]. The running zero before [x] or [hexadecimal digits]
2304 will be ignored. Then, the decoding starts after [x] or the first valid hexadecimal
2305 digit. Then, the function stops at the first character that is a not a valid
2306 hexadecimal character or Null-terminator, whichever on comes first.
2308 If String has only pad spaces, then 0 is returned.
2309 If String has no leading pad spaces, leading zeros or valid hexadecimal digits, then
2312 If the number represented by String overflows according to the range defined by UINTN,
2313 then MAX_UINTN is returned.
2314 If String is NULL, then ASSERT().
2315 If PcdMaximumAsciiStringLength is not zero,
2316 and String contains more than PcdMaximumAsciiStringLength ASCII characters not including
2317 the Null-terminator, then ASSERT().
2319 @param String The pointer to a Null-terminated ASCII string.
2321 @retval Value translated from String.
2326 AsciiStrHexToUintn (
2327 IN CONST CHAR8
*String
2332 Convert a Null-terminated ASCII hexadecimal string to a value of type UINT64.
2334 This function returns a value of type UINT64 by interpreting the contents of
2335 the ASCII string String as a hexadecimal number. The format of the input ASCII
2338 [spaces][zeros][x][hexadecimal digits].
2340 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
2341 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix. If "x"
2342 appears in the input string, it must be prefixed with at least one 0. The function
2343 will ignore the pad space, which includes spaces or tab characters, before [zeros],
2344 [x] or [hexadecimal digits]. The running zero before [x] or [hexadecimal digits]
2345 will be ignored. Then, the decoding starts after [x] or the first valid hexadecimal
2346 digit. Then, the function stops at the first character that is a not a valid
2347 hexadecimal character or Null-terminator, whichever on comes first.
2349 If String has only pad spaces, then 0 is returned.
2350 If String has no leading pad spaces, leading zeros or valid hexadecimal digits, then
2353 If the number represented by String overflows according to the range defined by UINT64,
2354 then MAX_UINT64 is returned.
2355 If String is NULL, then ASSERT().
2356 If PcdMaximumAsciiStringLength is not zero,
2357 and String contains more than PcdMaximumAsciiStringLength ASCII characters not including
2358 the Null-terminator, then ASSERT().
2360 @param String The pointer to a Null-terminated ASCII string.
2362 @retval Value translated from String.
2367 AsciiStrHexToUint64 (
2368 IN CONST CHAR8
*String
2372 Convert a Null-terminated ASCII string to IPv6 address and prefix length.
2374 This function outputs a value of type IPv6_ADDRESS and may output a value
2375 of type UINT8 by interpreting the contents of the ASCII string specified
2376 by String. The format of the input ASCII string String is as follows:
2380 X contains one to four hexadecimal digit characters in the range [0-9], [a-f] and
2381 [A-F]. X is converted to a value of type UINT16, whose low byte is stored in low
2382 memory address and high byte is stored in high memory address. P contains decimal
2383 digit characters in the range [0-9]. The running zero in the beginning of P will
2384 be ignored. /P is optional.
2386 When /P is not in the String, the function stops at the first character that is
2387 not a valid hexadecimal digit character after eight X's are converted.
2389 When /P is in the String, the function stops at the first character that is not
2390 a valid decimal digit character after P is converted.
2392 "::" can be used to compress one or more groups of X when X contains only 0.
2393 The "::" can only appear once in the String.
2395 If String is NULL, then ASSERT().
2397 If Address is NULL, then ASSERT().
2399 If EndPointer is not NULL and Address is translated from String, a pointer
2400 to the character that stopped the scan is stored at the location pointed to
2403 @param String Pointer to a Null-terminated ASCII string.
2404 @param EndPointer Pointer to character that stops scan.
2405 @param Address Pointer to the converted IPv6 address.
2406 @param PrefixLength Pointer to the converted IPv6 address prefix
2407 length. MAX_UINT8 is returned when /P is
2410 @retval RETURN_SUCCESS Address is translated from String.
2411 @retval RETURN_INVALID_PARAMETER If String is NULL.
2413 @retval RETURN_UNSUPPORTED If X contains more than four hexadecimal
2415 If String contains "::" and number of X
2417 If P starts with character that is not a
2418 valid decimal digit character.
2419 If the decimal number converted from P
2425 AsciiStrToIpv6Address (
2426 IN CONST CHAR8
*String
,
2427 OUT CHAR8
**EndPointer
, OPTIONAL
2428 OUT IPv6_ADDRESS
*Address
,
2429 OUT UINT8
*PrefixLength OPTIONAL
2433 Convert a Null-terminated ASCII string to IPv4 address and prefix length.
2435 This function outputs a value of type IPv4_ADDRESS and may output a value
2436 of type UINT8 by interpreting the contents of the ASCII string specified
2437 by String. The format of the input ASCII string String is as follows:
2441 D and P are decimal digit characters in the range [0-9]. The running zero in
2442 the beginning of D and P will be ignored. /P is optional.
2444 When /P is not in the String, the function stops at the first character that is
2445 not a valid decimal digit character after four D's are converted.
2447 When /P is in the String, the function stops at the first character that is not
2448 a valid decimal digit character after P is converted.
2450 If String is NULL, then ASSERT().
2452 If Address is NULL, then ASSERT().
2454 If EndPointer is not NULL and Address is translated from String, a pointer
2455 to the character that stopped the scan is stored at the location pointed to
2458 @param String Pointer to a Null-terminated ASCII string.
2459 @param EndPointer Pointer to character that stops scan.
2460 @param Address Pointer to the converted IPv4 address.
2461 @param PrefixLength Pointer to the converted IPv4 address prefix
2462 length. MAX_UINT8 is returned when /P is
2465 @retval RETURN_SUCCESS Address is translated from String.
2466 @retval RETURN_INVALID_PARAMETER If String is NULL.
2468 @retval RETURN_UNSUPPORTED If String is not in the correct format.
2469 If any decimal number converted from D
2471 If the decimal number converted from P
2477 AsciiStrToIpv4Address (
2478 IN CONST CHAR8
*String
,
2479 OUT CHAR8
**EndPointer
, OPTIONAL
2480 OUT IPv4_ADDRESS
*Address
,
2481 OUT UINT8
*PrefixLength OPTIONAL
2485 Convert a Null-terminated ASCII GUID string to a value of type
2488 This function outputs a GUID value by interpreting the contents of
2489 the ASCII string specified by String. The format of the input
2490 ASCII string String consists of 36 characters, as follows:
2492 aabbccdd-eeff-gghh-iijj-kkllmmnnoopp
2494 The pairs aa - pp are two characters in the range [0-9], [a-f] and
2495 [A-F], with each pair representing a single byte hexadecimal value.
2497 The mapping between String and the EFI_GUID structure is as follows:
2515 If String is NULL, then ASSERT().
2516 If Guid is NULL, then ASSERT().
2518 @param String Pointer to a Null-terminated ASCII string.
2519 @param Guid Pointer to the converted GUID.
2521 @retval RETURN_SUCCESS Guid is translated from String.
2522 @retval RETURN_INVALID_PARAMETER If String is NULL.
2524 @retval RETURN_UNSUPPORTED If String is not as the above format.
2530 IN CONST CHAR8
*String
,
2535 Convert a Null-terminated ASCII hexadecimal string to a byte array.
2537 This function outputs a byte array by interpreting the contents of
2538 the ASCII string specified by String in hexadecimal format. The format of
2539 the input ASCII string String is:
2543 X is a hexadecimal digit character in the range [0-9], [a-f] and [A-F].
2544 The function decodes every two hexadecimal digit characters as one byte. The
2545 decoding stops after Length of characters and outputs Buffer containing
2548 If String is NULL, then ASSERT().
2550 If Buffer is NULL, then ASSERT().
2552 If Length is not multiple of 2, then ASSERT().
2554 If PcdMaximumAsciiStringLength is not zero and Length is greater than
2555 PcdMaximumAsciiStringLength, then ASSERT().
2557 If MaxBufferSize is less than (Length / 2), then ASSERT().
2559 @param String Pointer to a Null-terminated ASCII string.
2560 @param Length The number of ASCII characters to decode.
2561 @param Buffer Pointer to the converted bytes array.
2562 @param MaxBufferSize The maximum size of Buffer.
2564 @retval RETURN_SUCCESS Buffer is translated from String.
2565 @retval RETURN_INVALID_PARAMETER If String is NULL.
2567 If Length is not multiple of 2.
2568 If PcdMaximumAsciiStringLength is not zero,
2569 and Length is greater than
2570 PcdMaximumAsciiStringLength.
2571 @retval RETURN_UNSUPPORTED If Length of characters from String contain
2572 a character that is not valid hexadecimal
2573 digit characters, or a Null-terminator.
2574 @retval RETURN_BUFFER_TOO_SMALL If MaxBufferSize is less than (Length / 2).
2578 AsciiStrHexToBytes (
2579 IN CONST CHAR8
*String
,
2582 IN UINTN MaxBufferSize
2585 #ifndef DISABLE_NEW_DEPRECATED_INTERFACES
2588 [ATTENTION] This function is deprecated for security reason.
2590 Convert one Null-terminated ASCII string to a Null-terminated
2591 Unicode string and returns the Unicode string.
2593 This function converts the contents of the ASCII string Source to the Unicode
2594 string Destination, and returns Destination. The function terminates the
2595 Unicode string Destination by appending a Null-terminator character at the end.
2596 The caller is responsible to make sure Destination points to a buffer with size
2597 equal or greater than ((AsciiStrLen (Source) + 1) * sizeof (CHAR16)) in bytes.
2599 If Destination is NULL, then ASSERT().
2600 If Destination is not aligned on a 16-bit boundary, then ASSERT().
2601 If Source is NULL, then ASSERT().
2602 If Source and Destination overlap, then ASSERT().
2603 If PcdMaximumAsciiStringLength is not zero, and Source contains more than
2604 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
2606 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
2607 PcdMaximumUnicodeStringLength ASCII characters not including the
2608 Null-terminator, then ASSERT().
2610 @param Source The pointer to a Null-terminated ASCII string.
2611 @param Destination The pointer to a Null-terminated Unicode string.
2613 @return Destination.
2618 AsciiStrToUnicodeStr (
2619 IN CONST CHAR8
*Source
,
2620 OUT CHAR16
*Destination
2623 #endif // !defined (DISABLE_NEW_DEPRECATED_INTERFACES)
2626 Convert one Null-terminated ASCII string to a Null-terminated
2629 This function is similar to StrCpyS.
2631 This function converts the contents of the ASCII string Source to the Unicode
2632 string Destination. The function terminates the Unicode string Destination by
2633 appending a Null-terminator character at the end.
2635 The caller is responsible to make sure Destination points to a buffer with size
2636 equal or greater than ((AsciiStrLen (Source) + 1) * sizeof (CHAR16)) in bytes.
2638 If Destination is not aligned on a 16-bit boundary, then ASSERT().
2639 If an error would be returned, then the function will also ASSERT().
2641 If an error is returned, then the Destination is unmodified.
2643 @param Source The pointer to a Null-terminated ASCII string.
2644 @param Destination The pointer to a Null-terminated Unicode string.
2645 @param DestMax The maximum number of Destination Unicode
2646 char, including terminating null char.
2648 @retval RETURN_SUCCESS String is converted.
2649 @retval RETURN_BUFFER_TOO_SMALL If DestMax is NOT greater than StrLen(Source).
2650 @retval RETURN_INVALID_PARAMETER If Destination is NULL.
2652 If PcdMaximumUnicodeStringLength is not zero,
2653 and DestMax is greater than
2654 PcdMaximumUnicodeStringLength.
2655 If PcdMaximumAsciiStringLength is not zero,
2656 and DestMax is greater than
2657 PcdMaximumAsciiStringLength.
2659 @retval RETURN_ACCESS_DENIED If Source and Destination overlap.
2664 AsciiStrToUnicodeStrS (
2665 IN CONST CHAR8
*Source
,
2666 OUT CHAR16
*Destination
,
2671 Convert not more than Length successive characters from a Null-terminated
2672 Ascii string to a Null-terminated Unicode string. If no null char is copied
2673 from Source, then Destination[Length] is always set to null.
2675 This function converts not more than Length successive characters from the
2676 Ascii string Source to the Unicode string Destination. The function
2677 terminates the Unicode string Destination by appending a Null-terminator
2678 character at the end.
2680 The caller is responsible to make sure Destination points to a buffer with
2681 size not smaller than
2682 ((MIN(AsciiStrLen(Source), Length) + 1) * sizeof (CHAR8)) in bytes.
2684 If Destination is not aligned on a 16-bit boundary, then ASSERT().
2685 If an error would be returned, then the function will also ASSERT().
2687 If an error is returned, then Destination and DestinationLength are
2690 @param Source The pointer to a Null-terminated Ascii string.
2691 @param Length The maximum number of Ascii characters to convert.
2692 @param Destination The pointer to a Null-terminated Unicode string.
2693 @param DestMax The maximum number of Destination Unicode char,
2694 including terminating null char.
2695 @param DestinationLength The number of Ascii characters converted.
2697 @retval RETURN_SUCCESS String is converted.
2698 @retval RETURN_INVALID_PARAMETER If Destination is NULL.
2700 If DestinationLength is NULL.
2701 If PcdMaximumUnicodeStringLength is not
2702 zero, and Length or DestMax is greater than
2703 PcdMaximumUnicodeStringLength.
2704 If PcdMaximumAsciiStringLength is not zero,
2705 and Length or DestMax is greater than
2706 PcdMaximumAsciiStringLength.
2708 @retval RETURN_BUFFER_TOO_SMALL If DestMax is NOT greater than
2709 MIN(AsciiStrLen(Source), Length).
2710 @retval RETURN_ACCESS_DENIED If Source and Destination overlap.
2715 AsciiStrnToUnicodeStrS (
2716 IN CONST CHAR8
*Source
,
2718 OUT CHAR16
*Destination
,
2720 OUT UINTN
*DestinationLength
2724 Convert a Unicode character to upper case only if
2725 it maps to a valid small-case ASCII character.
2727 This internal function only deal with Unicode character
2728 which maps to a valid small-case ASCII character, i.e.
2729 L'a' to L'z'. For other Unicode character, the input character
2730 is returned directly.
2732 @param Char The character to convert.
2734 @retval LowerCharacter If the Char is with range L'a' to L'z'.
2735 @retval Unchanged Otherwise.
2745 Converts a lowercase Ascii character to upper one.
2747 If Chr is lowercase Ascii character, then converts it to upper one.
2749 If Value >= 0xA0, then ASSERT().
2750 If (Value & 0x0F) >= 0x0A, then ASSERT().
2752 @param Chr one Ascii character
2754 @return The uppercase value of Ascii character
2764 Converts an 8-bit value to an 8-bit BCD value.
2766 Converts the 8-bit value specified by Value to BCD. The BCD value is
2769 If Value >= 100, then ASSERT().
2771 @param Value The 8-bit value to convert to BCD. Range 0..99.
2773 @return The BCD value.
2784 Converts an 8-bit BCD value to an 8-bit value.
2786 Converts the 8-bit BCD value specified by Value to an 8-bit value. The 8-bit
2789 If Value >= 0xA0, then ASSERT().
2790 If (Value & 0x0F) >= 0x0A, then ASSERT().
2792 @param Value The 8-bit BCD value to convert to an 8-bit value.
2794 @return The 8-bit value is returned.
2804 // File Path Manipulation Functions
2808 Removes the last directory or file entry in a path.
2810 @param[in, out] Path The pointer to the path to modify.
2812 @retval FALSE Nothing was found to remove.
2813 @retval TRUE A directory or file was removed.
2822 Function to clean up paths.
2823 - Single periods in the path are removed.
2824 - Double periods in the path are removed along with a single parent directory.
2825 - Forward slashes L'/' are converted to backward slashes L'\'.
2827 This will be done inline and the existing buffer may be larger than required
2830 @param[in] Path The pointer to the string containing the path.
2832 @return Returns Path, otherwise returns NULL to indicate that an error has occurred.
2836 PathCleanUpDirectories(
2841 // Linked List Functions and Macros
2845 Initializes the head node of a doubly linked list that is declared as a
2846 global variable in a module.
2848 Initializes the forward and backward links of a new linked list. After
2849 initializing a linked list with this macro, the other linked list functions
2850 may be used to add and remove nodes from the linked list. This macro results
2851 in smaller executables by initializing the linked list in the data section,
2852 instead if calling the InitializeListHead() function to perform the
2853 equivalent operation.
2855 @param ListHead The head note of a list to initialize.
2858 #define INITIALIZE_LIST_HEAD_VARIABLE(ListHead) {&(ListHead), &(ListHead)}
2862 Checks whether FirstEntry and SecondEntry are part of the same doubly-linked
2865 If FirstEntry is NULL, then ASSERT().
2866 If FirstEntry->ForwardLink is NULL, then ASSERT().
2867 If FirstEntry->BackLink is NULL, then ASSERT().
2868 If SecondEntry is NULL, then ASSERT();
2869 If PcdMaximumLinkedListLength is not zero, and List contains more than
2870 PcdMaximumLinkedListLength nodes, then ASSERT().
2872 @param FirstEntry A pointer to a node in a linked list.
2873 @param SecondEntry A pointer to the node to locate.
2875 @retval TRUE SecondEntry is in the same doubly-linked list as FirstEntry.
2876 @retval FALSE SecondEntry isn't in the same doubly-linked list as FirstEntry,
2877 or FirstEntry is invalid.
2883 IN CONST LIST_ENTRY
*FirstEntry
,
2884 IN CONST LIST_ENTRY
*SecondEntry
2889 Initializes the head node of a doubly linked list, and returns the pointer to
2890 the head node of the doubly linked list.
2892 Initializes the forward and backward links of a new linked list. After
2893 initializing a linked list with this function, the other linked list
2894 functions may be used to add and remove nodes from the linked list. It is up
2895 to the caller of this function to allocate the memory for ListHead.
2897 If ListHead is NULL, then ASSERT().
2899 @param ListHead A pointer to the head node of a new doubly linked list.
2906 InitializeListHead (
2907 IN OUT LIST_ENTRY
*ListHead
2912 Adds a node to the beginning of a doubly linked list, and returns the pointer
2913 to the head node of the doubly linked list.
2915 Adds the node Entry at the beginning of the doubly linked list denoted by
2916 ListHead, and returns ListHead.
2918 If ListHead is NULL, then ASSERT().
2919 If Entry is NULL, then ASSERT().
2920 If ListHead was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or
2921 InitializeListHead(), then ASSERT().
2922 If PcdMaximumLinkedListLength is not zero, and prior to insertion the number
2923 of nodes in ListHead, including the ListHead node, is greater than or
2924 equal to PcdMaximumLinkedListLength, then ASSERT().
2926 @param ListHead A pointer to the head node of a doubly linked list.
2927 @param Entry A pointer to a node that is to be inserted at the beginning
2928 of a doubly linked list.
2936 IN OUT LIST_ENTRY
*ListHead
,
2937 IN OUT LIST_ENTRY
*Entry
2942 Adds a node to the end of a doubly linked list, and returns the pointer to
2943 the head node of the doubly linked list.
2945 Adds the node Entry to the end of the doubly linked list denoted by ListHead,
2946 and returns ListHead.
2948 If ListHead is NULL, then ASSERT().
2949 If Entry is NULL, then ASSERT().
2950 If ListHead was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or
2951 InitializeListHead(), then ASSERT().
2952 If PcdMaximumLinkedListLength is not zero, and prior to insertion the number
2953 of nodes in ListHead, including the ListHead node, is greater than or
2954 equal to PcdMaximumLinkedListLength, then ASSERT().
2956 @param ListHead A pointer to the head node of a doubly linked list.
2957 @param Entry A pointer to a node that is to be added at the end of the
2966 IN OUT LIST_ENTRY
*ListHead
,
2967 IN OUT LIST_ENTRY
*Entry
2972 Retrieves the first node of a doubly linked list.
2974 Returns the first node of a doubly linked list. List must have been
2975 initialized with INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead().
2976 If List is empty, then List is returned.
2978 If List is NULL, then ASSERT().
2979 If List was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or
2980 InitializeListHead(), then ASSERT().
2981 If PcdMaximumLinkedListLength is not zero, and the number of nodes
2982 in List, including the List node, is greater than or equal to
2983 PcdMaximumLinkedListLength, then ASSERT().
2985 @param List A pointer to the head node of a doubly linked list.
2987 @return The first node of a doubly linked list.
2988 @retval List The list is empty.
2994 IN CONST LIST_ENTRY
*List
2999 Retrieves the next node of a doubly linked list.
3001 Returns the node of a doubly linked list that follows Node.
3002 List must have been initialized with INTIALIZE_LIST_HEAD_VARIABLE()
3003 or InitializeListHead(). If List is empty, then List is returned.
3005 If List is NULL, then ASSERT().
3006 If Node is NULL, then ASSERT().
3007 If List was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or
3008 InitializeListHead(), then ASSERT().
3009 If PcdMaximumLinkedListLength is not zero, and List contains more than
3010 PcdMaximumLinkedListLength nodes, then ASSERT().
3011 If PcdVerifyNodeInList is TRUE and Node is not a node in List, then ASSERT().
3013 @param List A pointer to the head node of a doubly linked list.
3014 @param Node A pointer to a node in the doubly linked list.
3016 @return The pointer to the next node if one exists. Otherwise List is returned.
3022 IN CONST LIST_ENTRY
*List
,
3023 IN CONST LIST_ENTRY
*Node
3028 Retrieves the previous node of a doubly linked list.
3030 Returns the node of a doubly linked list that precedes Node.
3031 List must have been initialized with INTIALIZE_LIST_HEAD_VARIABLE()
3032 or InitializeListHead(). If List is empty, then List is returned.
3034 If List is NULL, then ASSERT().
3035 If Node is NULL, then ASSERT().
3036 If List was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or
3037 InitializeListHead(), then ASSERT().
3038 If PcdMaximumLinkedListLength is not zero, and List contains more than
3039 PcdMaximumLinkedListLength nodes, then ASSERT().
3040 If PcdVerifyNodeInList is TRUE and Node is not a node in List, then ASSERT().
3042 @param List A pointer to the head node of a doubly linked list.
3043 @param Node A pointer to a node in the doubly linked list.
3045 @return The pointer to the previous node if one exists. Otherwise List is returned.
3051 IN CONST LIST_ENTRY
*List
,
3052 IN CONST LIST_ENTRY
*Node
3057 Checks to see if a doubly linked list is empty or not.
3059 Checks to see if the doubly linked list is empty. If the linked list contains
3060 zero nodes, this function returns TRUE. Otherwise, it returns FALSE.
3062 If ListHead is NULL, then ASSERT().
3063 If ListHead was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or
3064 InitializeListHead(), then ASSERT().
3065 If PcdMaximumLinkedListLength is not zero, and the number of nodes
3066 in List, including the List node, is greater than or equal to
3067 PcdMaximumLinkedListLength, then ASSERT().
3069 @param ListHead A pointer to the head node of a doubly linked list.
3071 @retval TRUE The linked list is empty.
3072 @retval FALSE The linked list is not empty.
3078 IN CONST LIST_ENTRY
*ListHead
3083 Determines if a node in a doubly linked list is the head node of a the same
3084 doubly linked list. This function is typically used to terminate a loop that
3085 traverses all the nodes in a doubly linked list starting with the head node.
3087 Returns TRUE if Node is equal to List. Returns FALSE if Node is one of the
3088 nodes in the doubly linked list specified by List. List must have been
3089 initialized with INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead().
3091 If List is NULL, then ASSERT().
3092 If Node is NULL, then ASSERT().
3093 If List was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead(),
3095 If PcdMaximumLinkedListLength is not zero, and the number of nodes
3096 in List, including the List node, is greater than or equal to
3097 PcdMaximumLinkedListLength, then ASSERT().
3098 If PcdVerifyNodeInList is TRUE and Node is not a node in List the and Node is not equal
3099 to List, then ASSERT().
3101 @param List A pointer to the head node of a doubly linked list.
3102 @param Node A pointer to a node in the doubly linked list.
3104 @retval TRUE Node is the head of the doubly-linked list pointed by List.
3105 @retval FALSE Node is not the head of the doubly-linked list pointed by List.
3111 IN CONST LIST_ENTRY
*List
,
3112 IN CONST LIST_ENTRY
*Node
3117 Determines if a node the last node in a doubly linked list.
3119 Returns TRUE if Node is the last node in the doubly linked list specified by
3120 List. Otherwise, FALSE is returned. List must have been initialized with
3121 INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead().
3123 If List is NULL, then ASSERT().
3124 If Node is NULL, then ASSERT().
3125 If List was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or
3126 InitializeListHead(), then ASSERT().
3127 If PcdMaximumLinkedListLength is not zero, and the number of nodes
3128 in List, including the List node, is greater than or equal to
3129 PcdMaximumLinkedListLength, then ASSERT().
3130 If PcdVerifyNodeInList is TRUE and Node is not a node in List, then ASSERT().
3132 @param List A pointer to the head node of a doubly linked list.
3133 @param Node A pointer to a node in the doubly linked list.
3135 @retval TRUE Node is the last node in the linked list.
3136 @retval FALSE Node is not the last node in the linked list.
3142 IN CONST LIST_ENTRY
*List
,
3143 IN CONST LIST_ENTRY
*Node
3148 Swaps the location of two nodes in a doubly linked list, and returns the
3149 first node after the swap.
3151 If FirstEntry is identical to SecondEntry, then SecondEntry is returned.
3152 Otherwise, the location of the FirstEntry node is swapped with the location
3153 of the SecondEntry node in a doubly linked list. SecondEntry must be in the
3154 same double linked list as FirstEntry and that double linked list must have
3155 been initialized with INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead().
3156 SecondEntry is returned after the nodes are swapped.
3158 If FirstEntry is NULL, then ASSERT().
3159 If SecondEntry is NULL, then ASSERT().
3160 If PcdVerifyNodeInList is TRUE and SecondEntry and FirstEntry are not in the
3161 same linked list, then ASSERT().
3162 If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
3163 linked list containing the FirstEntry and SecondEntry nodes, including
3164 the FirstEntry and SecondEntry nodes, is greater than or equal to
3165 PcdMaximumLinkedListLength, then ASSERT().
3167 @param FirstEntry A pointer to a node in a linked list.
3168 @param SecondEntry A pointer to another node in the same linked list.
3170 @return SecondEntry.
3176 IN OUT LIST_ENTRY
*FirstEntry
,
3177 IN OUT LIST_ENTRY
*SecondEntry
3182 Removes a node from a doubly linked list, and returns the node that follows
3185 Removes the node Entry from a doubly linked list. It is up to the caller of
3186 this function to release the memory used by this node if that is required. On
3187 exit, the node following Entry in the doubly linked list is returned. If
3188 Entry is the only node in the linked list, then the head node of the linked
3191 If Entry is NULL, then ASSERT().
3192 If Entry is the head node of an empty list, then ASSERT().
3193 If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
3194 linked list containing Entry, including the Entry node, is greater than
3195 or equal to PcdMaximumLinkedListLength, then ASSERT().
3197 @param Entry A pointer to a node in a linked list.
3205 IN CONST LIST_ENTRY
*Entry
3213 Shifts a 64-bit integer left between 0 and 63 bits. The low bits are filled
3214 with zeros. The shifted value is returned.
3216 This function shifts the 64-bit value Operand to the left by Count bits. The
3217 low Count bits are set to zero. The shifted value is returned.
3219 If Count is greater than 63, then ASSERT().
3221 @param Operand The 64-bit operand to shift left.
3222 @param Count The number of bits to shift left.
3224 @return Operand << Count.
3236 Shifts a 64-bit integer right between 0 and 63 bits. This high bits are
3237 filled with zeros. The shifted value is returned.
3239 This function shifts the 64-bit value Operand to the right by Count bits. The
3240 high Count bits are set to zero. The shifted value is returned.
3242 If Count is greater than 63, then ASSERT().
3244 @param Operand The 64-bit operand to shift right.
3245 @param Count The number of bits to shift right.
3247 @return Operand >> Count
3259 Shifts a 64-bit integer right between 0 and 63 bits. The high bits are filled
3260 with original integer's bit 63. The shifted value is returned.
3262 This function shifts the 64-bit value Operand to the right by Count bits. The
3263 high Count bits are set to bit 63 of Operand. The shifted value is returned.
3265 If Count is greater than 63, then ASSERT().
3267 @param Operand The 64-bit operand to shift right.
3268 @param Count The number of bits to shift right.
3270 @return Operand >> Count
3282 Rotates a 32-bit integer left between 0 and 31 bits, filling the low bits
3283 with the high bits that were rotated.
3285 This function rotates the 32-bit value Operand to the left by Count bits. The
3286 low Count bits are fill with the high Count bits of Operand. The rotated
3289 If Count is greater than 31, then ASSERT().
3291 @param Operand The 32-bit operand to rotate left.
3292 @param Count The number of bits to rotate left.
3294 @return Operand << Count
3306 Rotates a 32-bit integer right between 0 and 31 bits, filling the high bits
3307 with the low bits that were rotated.
3309 This function rotates the 32-bit value Operand to the right by Count bits.
3310 The high Count bits are fill with the low Count bits of Operand. The rotated
3313 If Count is greater than 31, then ASSERT().
3315 @param Operand The 32-bit operand to rotate right.
3316 @param Count The number of bits to rotate right.
3318 @return Operand >> Count
3330 Rotates a 64-bit integer left between 0 and 63 bits, filling the low bits
3331 with the high bits that were rotated.
3333 This function rotates the 64-bit value Operand to the left by Count bits. The
3334 low Count bits are fill with the high Count bits of Operand. The rotated
3337 If Count is greater than 63, then ASSERT().
3339 @param Operand The 64-bit operand to rotate left.
3340 @param Count The number of bits to rotate left.
3342 @return Operand << Count
3354 Rotates a 64-bit integer right between 0 and 63 bits, filling the high bits
3355 with the high low bits that were rotated.
3357 This function rotates the 64-bit value Operand to the right by Count bits.
3358 The high Count bits are fill with the low Count bits of Operand. The rotated
3361 If Count is greater than 63, then ASSERT().
3363 @param Operand The 64-bit operand to rotate right.
3364 @param Count The number of bits to rotate right.
3366 @return Operand >> Count
3378 Returns the bit position of the lowest bit set in a 32-bit value.
3380 This function computes the bit position of the lowest bit set in the 32-bit
3381 value specified by Operand. If Operand is zero, then -1 is returned.
3382 Otherwise, a value between 0 and 31 is returned.
3384 @param Operand The 32-bit operand to evaluate.
3386 @retval 0..31 The lowest bit set in Operand was found.
3387 @retval -1 Operand is zero.
3398 Returns the bit position of the lowest bit set in a 64-bit value.
3400 This function computes the bit position of the lowest bit set in the 64-bit
3401 value specified by Operand. If Operand is zero, then -1 is returned.
3402 Otherwise, a value between 0 and 63 is returned.
3404 @param Operand The 64-bit operand to evaluate.
3406 @retval 0..63 The lowest bit set in Operand was found.
3407 @retval -1 Operand is zero.
3419 Returns the bit position of the highest bit set in a 32-bit value. Equivalent
3422 This function computes the bit position of the highest bit set in the 32-bit
3423 value specified by Operand. If Operand is zero, then -1 is returned.
3424 Otherwise, a value between 0 and 31 is returned.
3426 @param Operand The 32-bit operand to evaluate.
3428 @retval 0..31 Position of the highest bit set in Operand if found.
3429 @retval -1 Operand is zero.
3440 Returns the bit position of the highest bit set in a 64-bit value. Equivalent
3443 This function computes the bit position of the highest bit set in the 64-bit
3444 value specified by Operand. If Operand is zero, then -1 is returned.
3445 Otherwise, a value between 0 and 63 is returned.
3447 @param Operand The 64-bit operand to evaluate.
3449 @retval 0..63 Position of the highest bit set in Operand if found.
3450 @retval -1 Operand is zero.
3461 Returns the value of the highest bit set in a 32-bit value. Equivalent to
3464 This function computes the value of the highest bit set in the 32-bit value
3465 specified by Operand. If Operand is zero, then zero is returned.
3467 @param Operand The 32-bit operand to evaluate.
3469 @return 1 << HighBitSet32(Operand)
3470 @retval 0 Operand is zero.
3481 Returns the value of the highest bit set in a 64-bit value. Equivalent to
3484 This function computes the value of the highest bit set in the 64-bit value
3485 specified by Operand. If Operand is zero, then zero is returned.
3487 @param Operand The 64-bit operand to evaluate.
3489 @return 1 << HighBitSet64(Operand)
3490 @retval 0 Operand is zero.
3501 Switches the endianness of a 16-bit integer.
3503 This function swaps the bytes in a 16-bit unsigned value to switch the value
3504 from little endian to big endian or vice versa. The byte swapped value is
3507 @param Value A 16-bit unsigned value.
3509 @return The byte swapped Value.
3520 Switches the endianness of a 32-bit integer.
3522 This function swaps the bytes in a 32-bit unsigned value to switch the value
3523 from little endian to big endian or vice versa. The byte swapped value is
3526 @param Value A 32-bit unsigned value.
3528 @return The byte swapped Value.
3539 Switches the endianness of a 64-bit integer.
3541 This function swaps the bytes in a 64-bit unsigned value to switch the value
3542 from little endian to big endian or vice versa. The byte swapped value is
3545 @param Value A 64-bit unsigned value.
3547 @return The byte swapped Value.
3558 Multiples a 64-bit unsigned integer by a 32-bit unsigned integer and
3559 generates a 64-bit unsigned result.
3561 This function multiples the 64-bit unsigned value Multiplicand by the 32-bit
3562 unsigned value Multiplier and generates a 64-bit unsigned result. This 64-
3563 bit unsigned result is returned.
3565 @param Multiplicand A 64-bit unsigned value.
3566 @param Multiplier A 32-bit unsigned value.
3568 @return Multiplicand * Multiplier
3574 IN UINT64 Multiplicand
,
3575 IN UINT32 Multiplier
3580 Multiples a 64-bit unsigned integer by a 64-bit unsigned integer and
3581 generates a 64-bit unsigned result.
3583 This function multiples the 64-bit unsigned value Multiplicand by the 64-bit
3584 unsigned value Multiplier and generates a 64-bit unsigned result. This 64-
3585 bit unsigned result is returned.
3587 @param Multiplicand A 64-bit unsigned value.
3588 @param Multiplier A 64-bit unsigned value.
3590 @return Multiplicand * Multiplier.
3596 IN UINT64 Multiplicand
,
3597 IN UINT64 Multiplier
3602 Multiples a 64-bit signed integer by a 64-bit signed integer and generates a
3603 64-bit signed result.
3605 This function multiples the 64-bit signed value Multiplicand by the 64-bit
3606 signed value Multiplier and generates a 64-bit signed result. This 64-bit
3607 signed result is returned.
3609 @param Multiplicand A 64-bit signed value.
3610 @param Multiplier A 64-bit signed value.
3612 @return Multiplicand * Multiplier
3618 IN INT64 Multiplicand
,
3624 Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates
3625 a 64-bit unsigned result.
3627 This function divides the 64-bit unsigned value Dividend by the 32-bit
3628 unsigned value Divisor and generates a 64-bit unsigned quotient. This
3629 function returns the 64-bit unsigned quotient.
3631 If Divisor is 0, then ASSERT().
3633 @param Dividend A 64-bit unsigned value.
3634 @param Divisor A 32-bit unsigned value.
3636 @return Dividend / Divisor.
3648 Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates
3649 a 32-bit unsigned remainder.
3651 This function divides the 64-bit unsigned value Dividend by the 32-bit
3652 unsigned value Divisor and generates a 32-bit remainder. This function
3653 returns the 32-bit unsigned remainder.
3655 If Divisor is 0, then ASSERT().
3657 @param Dividend A 64-bit unsigned value.
3658 @param Divisor A 32-bit unsigned value.
3660 @return Dividend % Divisor.
3672 Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates
3673 a 64-bit unsigned result and an optional 32-bit unsigned remainder.
3675 This function divides the 64-bit unsigned value Dividend by the 32-bit
3676 unsigned value Divisor and generates a 64-bit unsigned quotient. If Remainder
3677 is not NULL, then the 32-bit unsigned remainder is returned in Remainder.
3678 This function returns the 64-bit unsigned quotient.
3680 If Divisor is 0, then ASSERT().
3682 @param Dividend A 64-bit unsigned value.
3683 @param Divisor A 32-bit unsigned value.
3684 @param Remainder A pointer to a 32-bit unsigned value. This parameter is
3685 optional and may be NULL.
3687 @return Dividend / Divisor.
3692 DivU64x32Remainder (
3695 OUT UINT32
*Remainder OPTIONAL
3700 Divides a 64-bit unsigned integer by a 64-bit unsigned integer and generates
3701 a 64-bit unsigned result and an optional 64-bit unsigned remainder.
3703 This function divides the 64-bit unsigned value Dividend by the 64-bit
3704 unsigned value Divisor and generates a 64-bit unsigned quotient. If Remainder
3705 is not NULL, then the 64-bit unsigned remainder is returned in Remainder.
3706 This function returns the 64-bit unsigned quotient.
3708 If Divisor is 0, then ASSERT().
3710 @param Dividend A 64-bit unsigned value.
3711 @param Divisor A 64-bit unsigned value.
3712 @param Remainder A pointer to a 64-bit unsigned value. This parameter is
3713 optional and may be NULL.
3715 @return Dividend / Divisor.
3720 DivU64x64Remainder (
3723 OUT UINT64
*Remainder OPTIONAL
3728 Divides a 64-bit signed integer by a 64-bit signed integer and generates a
3729 64-bit signed result and a optional 64-bit signed remainder.
3731 This function divides the 64-bit signed value Dividend by the 64-bit signed
3732 value Divisor and generates a 64-bit signed quotient. If Remainder is not
3733 NULL, then the 64-bit signed remainder is returned in Remainder. This
3734 function returns the 64-bit signed quotient.
3736 It is the caller's responsibility to not call this function with a Divisor of 0.
3737 If Divisor is 0, then the quotient and remainder should be assumed to be
3738 the largest negative integer.
3740 If Divisor is 0, then ASSERT().
3742 @param Dividend A 64-bit signed value.
3743 @param Divisor A 64-bit signed value.
3744 @param Remainder A pointer to a 64-bit signed value. This parameter is
3745 optional and may be NULL.
3747 @return Dividend / Divisor.
3752 DivS64x64Remainder (
3755 OUT INT64
*Remainder OPTIONAL
3760 Reads a 16-bit value from memory that may be unaligned.
3762 This function returns the 16-bit value pointed to by Buffer. The function
3763 guarantees that the read operation does not produce an alignment fault.
3765 If the Buffer is NULL, then ASSERT().
3767 @param Buffer The pointer to a 16-bit value that may be unaligned.
3769 @return The 16-bit value read from Buffer.
3775 IN CONST UINT16
*Buffer
3780 Writes a 16-bit value to memory that may be unaligned.
3782 This function writes the 16-bit value specified by Value to Buffer. Value is
3783 returned. The function guarantees that the write operation does not produce
3786 If the Buffer is NULL, then ASSERT().
3788 @param Buffer The pointer to a 16-bit value that may be unaligned.
3789 @param Value 16-bit value to write to Buffer.
3791 @return The 16-bit value to write to Buffer.
3803 Reads a 24-bit value from memory that may be unaligned.
3805 This function returns the 24-bit value pointed to by Buffer. The function
3806 guarantees that the read operation does not produce an alignment fault.
3808 If the Buffer is NULL, then ASSERT().
3810 @param Buffer The pointer to a 24-bit value that may be unaligned.
3812 @return The 24-bit value read from Buffer.
3818 IN CONST UINT32
*Buffer
3823 Writes a 24-bit value to memory that may be unaligned.
3825 This function writes the 24-bit value specified by Value to Buffer. Value is
3826 returned. The function guarantees that the write operation does not produce
3829 If the Buffer is NULL, then ASSERT().
3831 @param Buffer The pointer to a 24-bit value that may be unaligned.
3832 @param Value 24-bit value to write to Buffer.
3834 @return The 24-bit value to write to Buffer.
3846 Reads a 32-bit value from memory that may be unaligned.
3848 This function returns the 32-bit value pointed to by Buffer. The function
3849 guarantees that the read operation does not produce an alignment fault.
3851 If the Buffer is NULL, then ASSERT().
3853 @param Buffer The pointer to a 32-bit value that may be unaligned.
3855 @return The 32-bit value read from Buffer.
3861 IN CONST UINT32
*Buffer
3866 Writes a 32-bit value to memory that may be unaligned.
3868 This function writes the 32-bit value specified by Value to Buffer. Value is
3869 returned. The function guarantees that the write operation does not produce
3872 If the Buffer is NULL, then ASSERT().
3874 @param Buffer The pointer to a 32-bit value that may be unaligned.
3875 @param Value 32-bit value to write to Buffer.
3877 @return The 32-bit value to write to Buffer.
3889 Reads a 64-bit value from memory that may be unaligned.
3891 This function returns the 64-bit value pointed to by Buffer. The function
3892 guarantees that the read operation does not produce an alignment fault.
3894 If the Buffer is NULL, then ASSERT().
3896 @param Buffer The pointer to a 64-bit value that may be unaligned.
3898 @return The 64-bit value read from Buffer.
3904 IN CONST UINT64
*Buffer
3909 Writes a 64-bit value to memory that may be unaligned.
3911 This function writes the 64-bit value specified by Value to Buffer. Value is
3912 returned. The function guarantees that the write operation does not produce
3915 If the Buffer is NULL, then ASSERT().
3917 @param Buffer The pointer to a 64-bit value that may be unaligned.
3918 @param Value 64-bit value to write to Buffer.
3920 @return The 64-bit value to write to Buffer.
3932 // Bit Field Functions
3936 Returns a bit field from an 8-bit value.
3938 Returns the bitfield specified by the StartBit and the EndBit from Operand.
3940 If 8-bit operations are not supported, then ASSERT().
3941 If StartBit is greater than 7, then ASSERT().
3942 If EndBit is greater than 7, then ASSERT().
3943 If EndBit is less than StartBit, then ASSERT().
3945 @param Operand Operand on which to perform the bitfield operation.
3946 @param StartBit The ordinal of the least significant bit in the bit field.
3948 @param EndBit The ordinal of the most significant bit in the bit field.
3951 @return The bit field read.
3964 Writes a bit field to an 8-bit value, and returns the result.
3966 Writes Value to the bit field specified by the StartBit and the EndBit in
3967 Operand. All other bits in Operand are preserved. The new 8-bit value is
3970 If 8-bit operations are not supported, then ASSERT().
3971 If StartBit is greater than 7, then ASSERT().
3972 If EndBit is greater than 7, then ASSERT().
3973 If EndBit is less than StartBit, then ASSERT().
3974 If Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
3976 @param Operand Operand on which to perform the bitfield operation.
3977 @param StartBit The ordinal of the least significant bit in the bit field.
3979 @param EndBit The ordinal of the most significant bit in the bit field.
3981 @param Value New value of the bit field.
3983 @return The new 8-bit value.
3997 Reads a bit field from an 8-bit value, performs a bitwise OR, and returns the
4000 Performs a bitwise OR between the bit field specified by StartBit
4001 and EndBit in Operand and the value specified by OrData. All other bits in
4002 Operand are preserved. The new 8-bit value is returned.
4004 If 8-bit operations are not supported, then ASSERT().
4005 If StartBit is greater than 7, then ASSERT().
4006 If EndBit is greater than 7, then ASSERT().
4007 If EndBit is less than StartBit, then ASSERT().
4008 If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4010 @param Operand Operand on which to perform the bitfield operation.
4011 @param StartBit The ordinal of the least significant bit in the bit field.
4013 @param EndBit The ordinal of the most significant bit in the bit field.
4015 @param OrData The value to OR with the read value from the value
4017 @return The new 8-bit value.
4031 Reads a bit field from an 8-bit value, performs a bitwise AND, and returns
4034 Performs a bitwise AND between the bit field specified by StartBit and EndBit
4035 in Operand and the value specified by AndData. All other bits in Operand are
4036 preserved. The new 8-bit value is returned.
4038 If 8-bit operations are not supported, then ASSERT().
4039 If StartBit is greater than 7, then ASSERT().
4040 If EndBit is greater than 7, then ASSERT().
4041 If EndBit is less than StartBit, then ASSERT().
4042 If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4044 @param Operand Operand on which to perform the bitfield operation.
4045 @param StartBit The ordinal of the least significant bit in the bit field.
4047 @param EndBit The ordinal of the most significant bit in the bit field.
4049 @param AndData The value to AND with the read value from the value.
4051 @return The new 8-bit value.
4065 Reads a bit field from an 8-bit value, performs a bitwise AND followed by a
4066 bitwise OR, and returns the result.
4068 Performs a bitwise AND between the bit field specified by StartBit and EndBit
4069 in Operand and the value specified by AndData, followed by a bitwise
4070 OR with value specified by OrData. All other bits in Operand are
4071 preserved. The new 8-bit value is returned.
4073 If 8-bit operations are not supported, then ASSERT().
4074 If StartBit is greater than 7, then ASSERT().
4075 If EndBit is greater than 7, then ASSERT().
4076 If EndBit is less than StartBit, then ASSERT().
4077 If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4078 If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4080 @param Operand Operand on which to perform the bitfield operation.
4081 @param StartBit The ordinal of the least significant bit in the bit field.
4083 @param EndBit The ordinal of the most significant bit in the bit field.
4085 @param AndData The value to AND with the read value from the value.
4086 @param OrData The value to OR with the result of the AND operation.
4088 @return The new 8-bit value.
4093 BitFieldAndThenOr8 (
4103 Returns a bit field from a 16-bit value.
4105 Returns the bitfield specified by the StartBit and the EndBit from Operand.
4107 If 16-bit operations are not supported, then ASSERT().
4108 If StartBit is greater than 15, then ASSERT().
4109 If EndBit is greater than 15, then ASSERT().
4110 If EndBit is less than StartBit, then ASSERT().
4112 @param Operand Operand on which to perform the bitfield operation.
4113 @param StartBit The ordinal of the least significant bit in the bit field.
4115 @param EndBit The ordinal of the most significant bit in the bit field.
4118 @return The bit field read.
4131 Writes a bit field to a 16-bit value, and returns the result.
4133 Writes Value to the bit field specified by the StartBit and the EndBit in
4134 Operand. All other bits in Operand are preserved. The new 16-bit value is
4137 If 16-bit operations are not supported, then ASSERT().
4138 If StartBit is greater than 15, then ASSERT().
4139 If EndBit is greater than 15, then ASSERT().
4140 If EndBit is less than StartBit, then ASSERT().
4141 If Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4143 @param Operand Operand on which to perform the bitfield operation.
4144 @param StartBit The ordinal of the least significant bit in the bit field.
4146 @param EndBit The ordinal of the most significant bit in the bit field.
4148 @param Value New value of the bit field.
4150 @return The new 16-bit value.
4164 Reads a bit field from a 16-bit value, performs a bitwise OR, and returns the
4167 Performs a bitwise OR between the bit field specified by StartBit
4168 and EndBit in Operand and the value specified by OrData. All other bits in
4169 Operand are preserved. The new 16-bit value is returned.
4171 If 16-bit operations are not supported, then ASSERT().
4172 If StartBit is greater than 15, then ASSERT().
4173 If EndBit is greater than 15, then ASSERT().
4174 If EndBit is less than StartBit, then ASSERT().
4175 If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4177 @param Operand Operand on which to perform the bitfield operation.
4178 @param StartBit The ordinal of the least significant bit in the bit field.
4180 @param EndBit The ordinal of the most significant bit in the bit field.
4182 @param OrData The value to OR with the read value from the value
4184 @return The new 16-bit value.
4198 Reads a bit field from a 16-bit value, performs a bitwise AND, and returns
4201 Performs a bitwise AND between the bit field specified by StartBit and EndBit
4202 in Operand and the value specified by AndData. All other bits in Operand are
4203 preserved. The new 16-bit value is returned.
4205 If 16-bit operations are not supported, then ASSERT().
4206 If StartBit is greater than 15, then ASSERT().
4207 If EndBit is greater than 15, then ASSERT().
4208 If EndBit is less than StartBit, then ASSERT().
4209 If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4211 @param Operand Operand on which to perform the bitfield operation.
4212 @param StartBit The ordinal of the least significant bit in the bit field.
4214 @param EndBit The ordinal of the most significant bit in the bit field.
4216 @param AndData The value to AND with the read value from the value
4218 @return The new 16-bit value.
4232 Reads a bit field from a 16-bit value, performs a bitwise AND followed by a
4233 bitwise OR, and returns the result.
4235 Performs a bitwise AND between the bit field specified by StartBit and EndBit
4236 in Operand and the value specified by AndData, followed by a bitwise
4237 OR with value specified by OrData. All other bits in Operand are
4238 preserved. The new 16-bit value is returned.
4240 If 16-bit operations are not supported, then ASSERT().
4241 If StartBit is greater than 15, then ASSERT().
4242 If EndBit is greater than 15, then ASSERT().
4243 If EndBit is less than StartBit, then ASSERT().
4244 If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4245 If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4247 @param Operand Operand on which to perform the bitfield operation.
4248 @param StartBit The ordinal of the least significant bit in the bit field.
4250 @param EndBit The ordinal of the most significant bit in the bit field.
4252 @param AndData The value to AND with the read value from the value.
4253 @param OrData The value to OR with the result of the AND operation.
4255 @return The new 16-bit value.
4260 BitFieldAndThenOr16 (
4270 Returns a bit field from a 32-bit value.
4272 Returns the bitfield specified by the StartBit and the EndBit from Operand.
4274 If 32-bit operations are not supported, then ASSERT().
4275 If StartBit is greater than 31, then ASSERT().
4276 If EndBit is greater than 31, then ASSERT().
4277 If EndBit is less than StartBit, then ASSERT().
4279 @param Operand Operand on which to perform the bitfield operation.
4280 @param StartBit The ordinal of the least significant bit in the bit field.
4282 @param EndBit The ordinal of the most significant bit in the bit field.
4285 @return The bit field read.
4298 Writes a bit field to a 32-bit value, and returns the result.
4300 Writes Value to the bit field specified by the StartBit and the EndBit in
4301 Operand. All other bits in Operand are preserved. The new 32-bit value is
4304 If 32-bit operations are not supported, then ASSERT().
4305 If StartBit is greater than 31, then ASSERT().
4306 If EndBit is greater than 31, then ASSERT().
4307 If EndBit is less than StartBit, then ASSERT().
4308 If Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4310 @param Operand Operand on which to perform the bitfield operation.
4311 @param StartBit The ordinal of the least significant bit in the bit field.
4313 @param EndBit The ordinal of the most significant bit in the bit field.
4315 @param Value New value of the bit field.
4317 @return The new 32-bit value.
4331 Reads a bit field from a 32-bit value, performs a bitwise OR, and returns the
4334 Performs a bitwise OR between the bit field specified by StartBit
4335 and EndBit in Operand and the value specified by OrData. All other bits in
4336 Operand are preserved. The new 32-bit value is returned.
4338 If 32-bit operations are not supported, then ASSERT().
4339 If StartBit is greater than 31, then ASSERT().
4340 If EndBit is greater than 31, then ASSERT().
4341 If EndBit is less than StartBit, then ASSERT().
4342 If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4344 @param Operand Operand on which to perform the bitfield operation.
4345 @param StartBit The ordinal of the least significant bit in the bit field.
4347 @param EndBit The ordinal of the most significant bit in the bit field.
4349 @param OrData The value to OR with the read value from the value.
4351 @return The new 32-bit value.
4365 Reads a bit field from a 32-bit value, performs a bitwise AND, and returns
4368 Performs a bitwise AND between the bit field specified by StartBit and EndBit
4369 in Operand and the value specified by AndData. All other bits in Operand are
4370 preserved. The new 32-bit value is returned.
4372 If 32-bit operations are not supported, then ASSERT().
4373 If StartBit is greater than 31, then ASSERT().
4374 If EndBit is greater than 31, then ASSERT().
4375 If EndBit is less than StartBit, then ASSERT().
4376 If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4378 @param Operand Operand on which to perform the bitfield operation.
4379 @param StartBit The ordinal of the least significant bit in the bit field.
4381 @param EndBit The ordinal of the most significant bit in the bit field.
4383 @param AndData The value to AND with the read value from the value
4385 @return The new 32-bit value.
4399 Reads a bit field from a 32-bit value, performs a bitwise AND followed by a
4400 bitwise OR, and returns the result.
4402 Performs a bitwise AND between the bit field specified by StartBit and EndBit
4403 in Operand and the value specified by AndData, followed by a bitwise
4404 OR with value specified by OrData. All other bits in Operand are
4405 preserved. The new 32-bit value is returned.
4407 If 32-bit operations are not supported, then ASSERT().
4408 If StartBit is greater than 31, then ASSERT().
4409 If EndBit is greater than 31, then ASSERT().
4410 If EndBit is less than StartBit, then ASSERT().
4411 If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4412 If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4414 @param Operand Operand on which to perform the bitfield operation.
4415 @param StartBit The ordinal of the least significant bit in the bit field.
4417 @param EndBit The ordinal of the most significant bit in the bit field.
4419 @param AndData The value to AND with the read value from the value.
4420 @param OrData The value to OR with the result of the AND operation.
4422 @return The new 32-bit value.
4427 BitFieldAndThenOr32 (
4437 Returns a bit field from a 64-bit value.
4439 Returns the bitfield specified by the StartBit and the EndBit from Operand.
4441 If 64-bit operations are not supported, then ASSERT().
4442 If StartBit is greater than 63, then ASSERT().
4443 If EndBit is greater than 63, then ASSERT().
4444 If EndBit is less than StartBit, then ASSERT().
4446 @param Operand Operand on which to perform the bitfield operation.
4447 @param StartBit The ordinal of the least significant bit in the bit field.
4449 @param EndBit The ordinal of the most significant bit in the bit field.
4452 @return The bit field read.
4465 Writes a bit field to a 64-bit value, and returns the result.
4467 Writes Value to the bit field specified by the StartBit and the EndBit in
4468 Operand. All other bits in Operand are preserved. The new 64-bit value is
4471 If 64-bit operations are not supported, then ASSERT().
4472 If StartBit is greater than 63, then ASSERT().
4473 If EndBit is greater than 63, then ASSERT().
4474 If EndBit is less than StartBit, then ASSERT().
4475 If Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4477 @param Operand Operand on which to perform the bitfield operation.
4478 @param StartBit The ordinal of the least significant bit in the bit field.
4480 @param EndBit The ordinal of the most significant bit in the bit field.
4482 @param Value New value of the bit field.
4484 @return The new 64-bit value.
4498 Reads a bit field from a 64-bit value, performs a bitwise OR, and returns the
4501 Performs a bitwise OR between the bit field specified by StartBit
4502 and EndBit in Operand and the value specified by OrData. All other bits in
4503 Operand are preserved. The new 64-bit value is returned.
4505 If 64-bit operations are not supported, then ASSERT().
4506 If StartBit is greater than 63, then ASSERT().
4507 If EndBit is greater than 63, then ASSERT().
4508 If EndBit is less than StartBit, then ASSERT().
4509 If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4511 @param Operand Operand on which to perform the bitfield operation.
4512 @param StartBit The ordinal of the least significant bit in the bit field.
4514 @param EndBit The ordinal of the most significant bit in the bit field.
4516 @param OrData The value to OR with the read value from the value
4518 @return The new 64-bit value.
4532 Reads a bit field from a 64-bit value, performs a bitwise AND, and returns
4535 Performs a bitwise AND between the bit field specified by StartBit and EndBit
4536 in Operand and the value specified by AndData. All other bits in Operand are
4537 preserved. The new 64-bit value is returned.
4539 If 64-bit operations are not supported, then ASSERT().
4540 If StartBit is greater than 63, then ASSERT().
4541 If EndBit is greater than 63, then ASSERT().
4542 If EndBit is less than StartBit, then ASSERT().
4543 If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4545 @param Operand Operand on which to perform the bitfield operation.
4546 @param StartBit The ordinal of the least significant bit in the bit field.
4548 @param EndBit The ordinal of the most significant bit in the bit field.
4550 @param AndData The value to AND with the read value from the value
4552 @return The new 64-bit value.
4566 Reads a bit field from a 64-bit value, performs a bitwise AND followed by a
4567 bitwise OR, and returns the result.
4569 Performs a bitwise AND between the bit field specified by StartBit and EndBit
4570 in Operand and the value specified by AndData, followed by a bitwise
4571 OR with value specified by OrData. All other bits in Operand are
4572 preserved. The new 64-bit value is returned.
4574 If 64-bit operations are not supported, then ASSERT().
4575 If StartBit is greater than 63, then ASSERT().
4576 If EndBit is greater than 63, then ASSERT().
4577 If EndBit is less than StartBit, then ASSERT().
4578 If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4579 If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4581 @param Operand Operand on which to perform the bitfield operation.
4582 @param StartBit The ordinal of the least significant bit in the bit field.
4584 @param EndBit The ordinal of the most significant bit in the bit field.
4586 @param AndData The value to AND with the read value from the value.
4587 @param OrData The value to OR with the result of the AND operation.
4589 @return The new 64-bit value.
4594 BitFieldAndThenOr64 (
4603 Reads a bit field from a 32-bit value, counts and returns
4604 the number of set bits.
4606 Counts the number of set bits in the bit field specified by
4607 StartBit and EndBit in Operand. The count is returned.
4609 If StartBit is greater than 31, then ASSERT().
4610 If EndBit is greater than 31, then ASSERT().
4611 If EndBit is less than StartBit, then ASSERT().
4613 @param Operand Operand on which to perform the bitfield operation.
4614 @param StartBit The ordinal of the least significant bit in the bit field.
4616 @param EndBit The ordinal of the most significant bit in the bit field.
4619 @return The number of bits set between StartBit and EndBit.
4624 BitFieldCountOnes32 (
4631 Reads a bit field from a 64-bit value, counts and returns
4632 the number of set bits.
4634 Counts the number of set bits in the bit field specified by
4635 StartBit and EndBit in Operand. The count is returned.
4637 If StartBit is greater than 63, then ASSERT().
4638 If EndBit is greater than 63, then ASSERT().
4639 If EndBit is less than StartBit, then ASSERT().
4641 @param Operand Operand on which to perform the bitfield operation.
4642 @param StartBit The ordinal of the least significant bit in the bit field.
4644 @param EndBit The ordinal of the most significant bit in the bit field.
4647 @return The number of bits set between StartBit and EndBit.
4652 BitFieldCountOnes64 (
4659 // Base Library Checksum Functions
4663 Returns the sum of all elements in a buffer in unit of UINT8.
4664 During calculation, the carry bits are dropped.
4666 This function calculates the sum of all elements in a buffer
4667 in unit of UINT8. The carry bits in result of addition are dropped.
4668 The result is returned as UINT8. If Length is Zero, then Zero is
4671 If Buffer is NULL, then ASSERT().
4672 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
4674 @param Buffer The pointer to the buffer to carry out the sum operation.
4675 @param Length The size, in bytes, of Buffer.
4677 @return Sum The sum of Buffer with carry bits dropped during additions.
4683 IN CONST UINT8
*Buffer
,
4689 Returns the two's complement checksum of all elements in a buffer
4692 This function first calculates the sum of the 8-bit values in the
4693 buffer specified by Buffer and Length. The carry bits in the result
4694 of addition are dropped. Then, the two's complement of the sum is
4695 returned. If Length is 0, then 0 is returned.
4697 If Buffer is NULL, then ASSERT().
4698 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
4700 @param Buffer The pointer to the buffer to carry out the checksum operation.
4701 @param Length The size, in bytes, of Buffer.
4703 @return Checksum The two's complement checksum of Buffer.
4708 CalculateCheckSum8 (
4709 IN CONST UINT8
*Buffer
,
4715 Returns the sum of all elements in a buffer of 16-bit values. During
4716 calculation, the carry bits are dropped.
4718 This function calculates the sum of the 16-bit values in the buffer
4719 specified by Buffer and Length. The carry bits in result of addition are dropped.
4720 The 16-bit result is returned. If Length is 0, then 0 is returned.
4722 If Buffer is NULL, then ASSERT().
4723 If Buffer is not aligned on a 16-bit boundary, then ASSERT().
4724 If Length is not aligned on a 16-bit boundary, then ASSERT().
4725 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
4727 @param Buffer The pointer to the buffer to carry out the sum operation.
4728 @param Length The size, in bytes, of Buffer.
4730 @return Sum The sum of Buffer with carry bits dropped during additions.
4736 IN CONST UINT16
*Buffer
,
4742 Returns the two's complement checksum of all elements in a buffer of
4745 This function first calculates the sum of the 16-bit values in the buffer
4746 specified by Buffer and Length. The carry bits in the result of addition
4747 are dropped. Then, the two's complement of the sum is returned. If Length
4748 is 0, then 0 is returned.
4750 If Buffer is NULL, then ASSERT().
4751 If Buffer is not aligned on a 16-bit boundary, then ASSERT().
4752 If Length is not aligned on a 16-bit boundary, then ASSERT().
4753 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
4755 @param Buffer The pointer to the buffer to carry out the checksum operation.
4756 @param Length The size, in bytes, of Buffer.
4758 @return Checksum The two's complement checksum of Buffer.
4763 CalculateCheckSum16 (
4764 IN CONST UINT16
*Buffer
,
4770 Returns the sum of all elements in a buffer of 32-bit values. During
4771 calculation, the carry bits are dropped.
4773 This function calculates the sum of the 32-bit values in the buffer
4774 specified by Buffer and Length. The carry bits in result of addition are dropped.
4775 The 32-bit result is returned. If Length is 0, then 0 is returned.
4777 If Buffer is NULL, then ASSERT().
4778 If Buffer is not aligned on a 32-bit boundary, then ASSERT().
4779 If Length is not aligned on a 32-bit boundary, then ASSERT().
4780 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
4782 @param Buffer The pointer to the buffer to carry out the sum operation.
4783 @param Length The size, in bytes, of Buffer.
4785 @return Sum The sum of Buffer with carry bits dropped during additions.
4791 IN CONST UINT32
*Buffer
,
4797 Returns the two's complement checksum of all elements in a buffer of
4800 This function first calculates the sum of the 32-bit values in the buffer
4801 specified by Buffer and Length. The carry bits in the result of addition
4802 are dropped. Then, the two's complement of the sum is returned. If Length
4803 is 0, then 0 is returned.
4805 If Buffer is NULL, then ASSERT().
4806 If Buffer is not aligned on a 32-bit boundary, then ASSERT().
4807 If Length is not aligned on a 32-bit boundary, then ASSERT().
4808 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
4810 @param Buffer The pointer to the buffer to carry out the checksum operation.
4811 @param Length The size, in bytes, of Buffer.
4813 @return Checksum The two's complement checksum of Buffer.
4818 CalculateCheckSum32 (
4819 IN CONST UINT32
*Buffer
,
4825 Returns the sum of all elements in a buffer of 64-bit values. During
4826 calculation, the carry bits are dropped.
4828 This function calculates the sum of the 64-bit values in the buffer
4829 specified by Buffer and Length. The carry bits in result of addition are dropped.
4830 The 64-bit result is returned. If Length is 0, then 0 is returned.
4832 If Buffer is NULL, then ASSERT().
4833 If Buffer is not aligned on a 64-bit boundary, then ASSERT().
4834 If Length is not aligned on a 64-bit boundary, then ASSERT().
4835 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
4837 @param Buffer The pointer to the buffer to carry out the sum operation.
4838 @param Length The size, in bytes, of Buffer.
4840 @return Sum The sum of Buffer with carry bits dropped during additions.
4846 IN CONST UINT64
*Buffer
,
4852 Returns the two's complement checksum of all elements in a buffer of
4855 This function first calculates the sum of the 64-bit values in the buffer
4856 specified by Buffer and Length. The carry bits in the result of addition
4857 are dropped. Then, the two's complement of the sum is returned. If Length
4858 is 0, then 0 is returned.
4860 If Buffer is NULL, then ASSERT().
4861 If Buffer is not aligned on a 64-bit boundary, then ASSERT().
4862 If Length is not aligned on a 64-bit boundary, then ASSERT().
4863 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
4865 @param Buffer The pointer to the buffer to carry out the checksum operation.
4866 @param Length The size, in bytes, of Buffer.
4868 @return Checksum The two's complement checksum of Buffer.
4873 CalculateCheckSum64 (
4874 IN CONST UINT64
*Buffer
,
4879 Computes and returns a 32-bit CRC for a data buffer.
4880 CRC32 value bases on ITU-T V.42.
4882 If Buffer is NULL, then ASSERT().
4883 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
4885 @param[in] Buffer A pointer to the buffer on which the 32-bit CRC is to be computed.
4886 @param[in] Length The number of bytes in the buffer Data.
4888 @retval Crc32 The 32-bit CRC was computed for the data buffer.
4899 // Base Library CPU Functions
4903 Function entry point used when a stack switch is requested with SwitchStack()
4905 @param Context1 Context1 parameter passed into SwitchStack().
4906 @param Context2 Context2 parameter passed into SwitchStack().
4911 (EFIAPI
*SWITCH_STACK_ENTRY_POINT
)(
4912 IN VOID
*Context1
, OPTIONAL
4913 IN VOID
*Context2 OPTIONAL
4918 Used to serialize load and store operations.
4920 All loads and stores that proceed calls to this function are guaranteed to be
4921 globally visible when this function returns.
4932 Saves the current CPU context that can be restored with a call to LongJump()
4935 Saves the current CPU context in the buffer specified by JumpBuffer and
4936 returns 0. The initial call to SetJump() must always return 0. Subsequent
4937 calls to LongJump() cause a non-zero value to be returned by SetJump().
4939 If JumpBuffer is NULL, then ASSERT().
4940 For Itanium processors, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().
4942 NOTE: The structure BASE_LIBRARY_JUMP_BUFFER is CPU architecture specific.
4943 The same structure must never be used for more than one CPU architecture context.
4944 For example, a BASE_LIBRARY_JUMP_BUFFER allocated by an IA-32 module must never be used from an x64 module.
4945 SetJump()/LongJump() is not currently supported for the EBC processor type.
4947 @param JumpBuffer A pointer to CPU context buffer.
4949 @retval 0 Indicates a return from SetJump().
4956 OUT BASE_LIBRARY_JUMP_BUFFER
*JumpBuffer
4961 Restores the CPU context that was saved with SetJump().
4963 Restores the CPU context from the buffer specified by JumpBuffer. This
4964 function never returns to the caller. Instead is resumes execution based on
4965 the state of JumpBuffer.
4967 If JumpBuffer is NULL, then ASSERT().
4968 For Itanium processors, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().
4969 If Value is 0, then ASSERT().
4971 @param JumpBuffer A pointer to CPU context buffer.
4972 @param Value The value to return when the SetJump() context is
4973 restored and must be non-zero.
4979 IN BASE_LIBRARY_JUMP_BUFFER
*JumpBuffer
,
4985 Enables CPU interrupts.
4996 Disables CPU interrupts.
5007 Disables CPU interrupts and returns the interrupt state prior to the disable
5010 @retval TRUE CPU interrupts were enabled on entry to this call.
5011 @retval FALSE CPU interrupts were disabled on entry to this call.
5016 SaveAndDisableInterrupts (
5022 Enables CPU interrupts for the smallest window required to capture any
5028 EnableDisableInterrupts (
5034 Retrieves the current CPU interrupt state.
5036 Returns TRUE if interrupts are currently enabled. Otherwise
5039 @retval TRUE CPU interrupts are enabled.
5040 @retval FALSE CPU interrupts are disabled.
5051 Set the current CPU interrupt state.
5053 Sets the current CPU interrupt state to the state specified by
5054 InterruptState. If InterruptState is TRUE, then interrupts are enabled. If
5055 InterruptState is FALSE, then interrupts are disabled. InterruptState is
5058 @param InterruptState TRUE if interrupts should enabled. FALSE if
5059 interrupts should be disabled.
5061 @return InterruptState
5067 IN BOOLEAN InterruptState
5072 Requests CPU to pause for a short period of time.
5074 Requests CPU to pause for a short period of time. Typically used in MP
5075 systems to prevent memory starvation while waiting for a spin lock.
5086 Transfers control to a function starting with a new stack.
5088 Transfers control to the function specified by EntryPoint using the
5089 new stack specified by NewStack and passing in the parameters specified
5090 by Context1 and Context2. Context1 and Context2 are optional and may
5091 be NULL. The function EntryPoint must never return. This function
5092 supports a variable number of arguments following the NewStack parameter.
5093 These additional arguments are ignored on IA-32, x64, and EBC architectures.
5094 Itanium processors expect one additional parameter of type VOID * that specifies
5095 the new backing store pointer.
5097 If EntryPoint is NULL, then ASSERT().
5098 If NewStack is NULL, then ASSERT().
5100 @param EntryPoint A pointer to function to call with the new stack.
5101 @param Context1 A pointer to the context to pass into the EntryPoint
5103 @param Context2 A pointer to the context to pass into the EntryPoint
5105 @param NewStack A pointer to the new stack to use for the EntryPoint
5107 @param ... This variable argument list is ignored for IA-32, x64, and
5108 EBC architectures. For Itanium processors, this variable
5109 argument list is expected to contain a single parameter of
5110 type VOID * that specifies the new backing store pointer.
5117 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
5118 IN VOID
*Context1
, OPTIONAL
5119 IN VOID
*Context2
, OPTIONAL
5126 Generates a breakpoint on the CPU.
5128 Generates a breakpoint on the CPU. The breakpoint must be implemented such
5129 that code can resume normal execution after the breakpoint.
5140 Executes an infinite loop.
5142 Forces the CPU to execute an infinite loop. A debugger may be used to skip
5143 past the loop and the code that follows the loop must execute properly. This
5144 implies that the infinite loop must not cause the code that follow it to be
5156 Uses as a barrier to stop speculative execution.
5158 Ensures that no later instruction will execute speculatively, until all prior
5159 instructions have completed.
5164 SpeculationBarrier (
5169 #if defined (MDE_CPU_IA32) || defined (MDE_CPU_X64)
5171 /// IA32 and x64 Specific Functions.
5172 /// Byte packed structure for 16-bit Real Mode EFLAGS.
5176 UINT32 CF
:1; ///< Carry Flag.
5177 UINT32 Reserved_0
:1; ///< Reserved.
5178 UINT32 PF
:1; ///< Parity Flag.
5179 UINT32 Reserved_1
:1; ///< Reserved.
5180 UINT32 AF
:1; ///< Auxiliary Carry Flag.
5181 UINT32 Reserved_2
:1; ///< Reserved.
5182 UINT32 ZF
:1; ///< Zero Flag.
5183 UINT32 SF
:1; ///< Sign Flag.
5184 UINT32 TF
:1; ///< Trap Flag.
5185 UINT32 IF
:1; ///< Interrupt Enable Flag.
5186 UINT32 DF
:1; ///< Direction Flag.
5187 UINT32 OF
:1; ///< Overflow Flag.
5188 UINT32 IOPL
:2; ///< I/O Privilege Level.
5189 UINT32 NT
:1; ///< Nested Task.
5190 UINT32 Reserved_3
:1; ///< Reserved.
5196 /// Byte packed structure for EFLAGS/RFLAGS.
5197 /// 32-bits on IA-32.
5198 /// 64-bits on x64. The upper 32-bits on x64 are reserved.
5202 UINT32 CF
:1; ///< Carry Flag.
5203 UINT32 Reserved_0
:1; ///< Reserved.
5204 UINT32 PF
:1; ///< Parity Flag.
5205 UINT32 Reserved_1
:1; ///< Reserved.
5206 UINT32 AF
:1; ///< Auxiliary Carry Flag.
5207 UINT32 Reserved_2
:1; ///< Reserved.
5208 UINT32 ZF
:1; ///< Zero Flag.
5209 UINT32 SF
:1; ///< Sign Flag.
5210 UINT32 TF
:1; ///< Trap Flag.
5211 UINT32 IF
:1; ///< Interrupt Enable Flag.
5212 UINT32 DF
:1; ///< Direction Flag.
5213 UINT32 OF
:1; ///< Overflow Flag.
5214 UINT32 IOPL
:2; ///< I/O Privilege Level.
5215 UINT32 NT
:1; ///< Nested Task.
5216 UINT32 Reserved_3
:1; ///< Reserved.
5217 UINT32 RF
:1; ///< Resume Flag.
5218 UINT32 VM
:1; ///< Virtual 8086 Mode.
5219 UINT32 AC
:1; ///< Alignment Check.
5220 UINT32 VIF
:1; ///< Virtual Interrupt Flag.
5221 UINT32 VIP
:1; ///< Virtual Interrupt Pending.
5222 UINT32 ID
:1; ///< ID Flag.
5223 UINT32 Reserved_4
:10; ///< Reserved.
5229 /// Byte packed structure for Control Register 0 (CR0).
5230 /// 32-bits on IA-32.
5231 /// 64-bits on x64. The upper 32-bits on x64 are reserved.
5235 UINT32 PE
:1; ///< Protection Enable.
5236 UINT32 MP
:1; ///< Monitor Coprocessor.
5237 UINT32 EM
:1; ///< Emulation.
5238 UINT32 TS
:1; ///< Task Switched.
5239 UINT32 ET
:1; ///< Extension Type.
5240 UINT32 NE
:1; ///< Numeric Error.
5241 UINT32 Reserved_0
:10; ///< Reserved.
5242 UINT32 WP
:1; ///< Write Protect.
5243 UINT32 Reserved_1
:1; ///< Reserved.
5244 UINT32 AM
:1; ///< Alignment Mask.
5245 UINT32 Reserved_2
:10; ///< Reserved.
5246 UINT32 NW
:1; ///< Mot Write-through.
5247 UINT32 CD
:1; ///< Cache Disable.
5248 UINT32 PG
:1; ///< Paging.
5254 /// Byte packed structure for Control Register 4 (CR4).
5255 /// 32-bits on IA-32.
5256 /// 64-bits on x64. The upper 32-bits on x64 are reserved.
5260 UINT32 VME
:1; ///< Virtual-8086 Mode Extensions.
5261 UINT32 PVI
:1; ///< Protected-Mode Virtual Interrupts.
5262 UINT32 TSD
:1; ///< Time Stamp Disable.
5263 UINT32 DE
:1; ///< Debugging Extensions.
5264 UINT32 PSE
:1; ///< Page Size Extensions.
5265 UINT32 PAE
:1; ///< Physical Address Extension.
5266 UINT32 MCE
:1; ///< Machine Check Enable.
5267 UINT32 PGE
:1; ///< Page Global Enable.
5268 UINT32 PCE
:1; ///< Performance Monitoring Counter
5270 UINT32 OSFXSR
:1; ///< Operating System Support for
5271 ///< FXSAVE and FXRSTOR instructions
5272 UINT32 OSXMMEXCPT
:1; ///< Operating System Support for
5273 ///< Unmasked SIMD Floating Point
5275 UINT32 Reserved_0
:2; ///< Reserved.
5276 UINT32 VMXE
:1; ///< VMX Enable
5277 UINT32 Reserved_1
:18; ///< Reserved.
5283 /// Byte packed structure for a segment descriptor in a GDT/LDT.
5302 } IA32_SEGMENT_DESCRIPTOR
;
5305 /// Byte packed structure for an IDTR, GDTR, LDTR descriptor.
5314 #define IA32_IDT_GATE_TYPE_TASK 0x85
5315 #define IA32_IDT_GATE_TYPE_INTERRUPT_16 0x86
5316 #define IA32_IDT_GATE_TYPE_TRAP_16 0x87
5317 #define IA32_IDT_GATE_TYPE_INTERRUPT_32 0x8E
5318 #define IA32_IDT_GATE_TYPE_TRAP_32 0x8F
5320 #define IA32_GDT_TYPE_TSS 0x9
5321 #define IA32_GDT_ALIGNMENT 8
5323 #if defined (MDE_CPU_IA32)
5325 /// Byte packed structure for an IA-32 Interrupt Gate Descriptor.
5329 UINT32 OffsetLow
:16; ///< Offset bits 15..0.
5330 UINT32 Selector
:16; ///< Selector.
5331 UINT32 Reserved_0
:8; ///< Reserved.
5332 UINT32 GateType
:8; ///< Gate Type. See #defines above.
5333 UINT32 OffsetHigh
:16; ///< Offset bits 31..16.
5336 } IA32_IDT_GATE_DESCRIPTOR
;
5340 // IA32 Task-State Segment Definition
5343 UINT16 PreviousTaskLink
;
5377 UINT16 LDTSegmentSelector
;
5380 UINT16 IOMapBaseAddress
;
5381 } IA32_TASK_STATE_SEGMENT
;
5385 UINT32 LimitLow
:16; ///< Segment Limit 15..00
5386 UINT32 BaseLow
:16; ///< Base Address 15..00
5387 UINT32 BaseMid
:8; ///< Base Address 23..16
5388 UINT32 Type
:4; ///< Type (1 0 B 1)
5389 UINT32 Reserved_43
:1; ///< 0
5390 UINT32 DPL
:2; ///< Descriptor Privilege Level
5391 UINT32 P
:1; ///< Segment Present
5392 UINT32 LimitHigh
:4; ///< Segment Limit 19..16
5393 UINT32 AVL
:1; ///< Available for use by system software
5394 UINT32 Reserved_52
:2; ///< 0 0
5395 UINT32 G
:1; ///< Granularity
5396 UINT32 BaseHigh
:8; ///< Base Address 31..24
5399 } IA32_TSS_DESCRIPTOR
;
5402 #endif // defined (MDE_CPU_IA32)
5404 #if defined (MDE_CPU_X64)
5406 /// Byte packed structure for an x64 Interrupt Gate Descriptor.
5410 UINT32 OffsetLow
:16; ///< Offset bits 15..0.
5411 UINT32 Selector
:16; ///< Selector.
5412 UINT32 Reserved_0
:8; ///< Reserved.
5413 UINT32 GateType
:8; ///< Gate Type. See #defines above.
5414 UINT32 OffsetHigh
:16; ///< Offset bits 31..16.
5415 UINT32 OffsetUpper
:32; ///< Offset bits 63..32.
5416 UINT32 Reserved_1
:32; ///< Reserved.
5422 } IA32_IDT_GATE_DESCRIPTOR
;
5426 // IA32 Task-State Segment Definition
5436 UINT16 Reserved_100
;
5437 UINT16 IOMapBaseAddress
;
5438 } IA32_TASK_STATE_SEGMENT
;
5442 UINT32 LimitLow
:16; ///< Segment Limit 15..00
5443 UINT32 BaseLow
:16; ///< Base Address 15..00
5444 UINT32 BaseMidl
:8; ///< Base Address 23..16
5445 UINT32 Type
:4; ///< Type (1 0 B 1)
5446 UINT32 Reserved_43
:1; ///< 0
5447 UINT32 DPL
:2; ///< Descriptor Privilege Level
5448 UINT32 P
:1; ///< Segment Present
5449 UINT32 LimitHigh
:4; ///< Segment Limit 19..16
5450 UINT32 AVL
:1; ///< Available for use by system software
5451 UINT32 Reserved_52
:2; ///< 0 0
5452 UINT32 G
:1; ///< Granularity
5453 UINT32 BaseMidh
:8; ///< Base Address 31..24
5454 UINT32 BaseHigh
:32; ///< Base Address 63..32
5455 UINT32 Reserved_96
:32; ///< Reserved
5461 } IA32_TSS_DESCRIPTOR
;
5464 #endif // defined (MDE_CPU_X64)
5467 /// Byte packed structure for an FP/SSE/SSE2 context.
5474 /// Structures for the 16-bit real mode thunks.
5527 IA32_EFLAGS32 EFLAGS
;
5537 } IA32_REGISTER_SET
;
5540 /// Byte packed structure for an 16-bit real mode thunks.
5543 IA32_REGISTER_SET
*RealModeState
;
5544 VOID
*RealModeBuffer
;
5545 UINT32 RealModeBufferSize
;
5546 UINT32 ThunkAttributes
;
5549 #define THUNK_ATTRIBUTE_BIG_REAL_MODE 0x00000001
5550 #define THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 0x00000002
5551 #define THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL 0x00000004
5554 /// Type definition for representing labels in NASM source code that allow for
5555 /// the patching of immediate operands of IA32 and X64 instructions.
5557 /// While the type is technically defined as a function type (note: not a
5558 /// pointer-to-function type), such labels in NASM source code never stand for
5559 /// actual functions, and identifiers declared with this function type should
5560 /// never be called. This is also why the EFIAPI calling convention specifier
5561 /// is missing from the typedef, and why the typedef does not follow the usual
5562 /// edk2 coding style for function (or pointer-to-function) typedefs. The VOID
5563 /// return type and the VOID argument list are merely artifacts.
5565 typedef VOID (X86_ASSEMBLY_PATCH_LABEL
) (VOID
);
5568 Retrieves CPUID information.
5570 Executes the CPUID instruction with EAX set to the value specified by Index.
5571 This function always returns Index.
5572 If Eax is not NULL, then the value of EAX after CPUID is returned in Eax.
5573 If Ebx is not NULL, then the value of EBX after CPUID is returned in Ebx.
5574 If Ecx is not NULL, then the value of ECX after CPUID is returned in Ecx.
5575 If Edx is not NULL, then the value of EDX after CPUID is returned in Edx.
5576 This function is only available on IA-32 and x64.
5578 @param Index The 32-bit value to load into EAX prior to invoking the CPUID
5580 @param Eax The pointer to the 32-bit EAX value returned by the CPUID
5581 instruction. This is an optional parameter that may be NULL.
5582 @param Ebx The pointer to the 32-bit EBX value returned by the CPUID
5583 instruction. This is an optional parameter that may be NULL.
5584 @param Ecx The pointer to the 32-bit ECX value returned by the CPUID
5585 instruction. This is an optional parameter that may be NULL.
5586 @param Edx The pointer to the 32-bit EDX value returned by the CPUID
5587 instruction. This is an optional parameter that may be NULL.
5596 OUT UINT32
*Eax
, OPTIONAL
5597 OUT UINT32
*Ebx
, OPTIONAL
5598 OUT UINT32
*Ecx
, OPTIONAL
5599 OUT UINT32
*Edx OPTIONAL
5604 Retrieves CPUID information using an extended leaf identifier.
5606 Executes the CPUID instruction with EAX set to the value specified by Index
5607 and ECX set to the value specified by SubIndex. This function always returns
5608 Index. This function is only available on IA-32 and x64.
5610 If Eax is not NULL, then the value of EAX after CPUID is returned in Eax.
5611 If Ebx is not NULL, then the value of EBX after CPUID is returned in Ebx.
5612 If Ecx is not NULL, then the value of ECX after CPUID is returned in Ecx.
5613 If Edx is not NULL, then the value of EDX after CPUID is returned in Edx.
5615 @param Index The 32-bit value to load into EAX prior to invoking the
5617 @param SubIndex The 32-bit value to load into ECX prior to invoking the
5619 @param Eax The pointer to the 32-bit EAX value returned by the CPUID
5620 instruction. This is an optional parameter that may be
5622 @param Ebx The pointer to the 32-bit EBX value returned by the CPUID
5623 instruction. This is an optional parameter that may be
5625 @param Ecx The pointer to the 32-bit ECX value returned by the CPUID
5626 instruction. This is an optional parameter that may be
5628 @param Edx The pointer to the 32-bit EDX value returned by the CPUID
5629 instruction. This is an optional parameter that may be
5640 OUT UINT32
*Eax
, OPTIONAL
5641 OUT UINT32
*Ebx
, OPTIONAL
5642 OUT UINT32
*Ecx
, OPTIONAL
5643 OUT UINT32
*Edx OPTIONAL
5648 Set CD bit and clear NW bit of CR0 followed by a WBINVD.
5650 Disables the caches by setting the CD bit of CR0 to 1, clearing the NW bit of CR0 to 0,
5651 and executing a WBINVD instruction. This function is only available on IA-32 and x64.
5662 Perform a WBINVD and clear both the CD and NW bits of CR0.
5664 Enables the caches by executing a WBINVD instruction and then clear both the CD and NW
5665 bits of CR0 to 0. This function is only available on IA-32 and x64.
5676 Returns the lower 32-bits of a Machine Specific Register(MSR).
5678 Reads and returns the lower 32-bits of the MSR specified by Index.
5679 No parameter checking is performed on Index, and some Index values may cause
5680 CPU exceptions. The caller must either guarantee that Index is valid, or the
5681 caller must set up exception handlers to catch the exceptions. This function
5682 is only available on IA-32 and x64.
5684 @param Index The 32-bit MSR index to read.
5686 @return The lower 32 bits of the MSR identified by Index.
5697 Writes a 32-bit value to a Machine Specific Register(MSR), and returns the value.
5698 The upper 32-bits of the MSR are set to zero.
5700 Writes the 32-bit value specified by Value to the MSR specified by Index. The
5701 upper 32-bits of the MSR write are set to zero. The 32-bit value written to
5702 the MSR is returned. No parameter checking is performed on Index or Value,
5703 and some of these may cause CPU exceptions. The caller must either guarantee
5704 that Index and Value are valid, or the caller must establish proper exception
5705 handlers. This function is only available on IA-32 and x64.
5707 @param Index The 32-bit MSR index to write.
5708 @param Value The 32-bit value to write to the MSR.
5722 Reads a 64-bit MSR, performs a bitwise OR on the lower 32-bits, and
5723 writes the result back to the 64-bit MSR.
5725 Reads the 64-bit MSR specified by Index, performs a bitwise OR
5726 between the lower 32-bits of the read result and the value specified by
5727 OrData, and writes the result to the 64-bit MSR specified by Index. The lower
5728 32-bits of the value written to the MSR is returned. No parameter checking is
5729 performed on Index or OrData, and some of these may cause CPU exceptions. The
5730 caller must either guarantee that Index and OrData are valid, or the caller
5731 must establish proper exception handlers. This function is only available on
5734 @param Index The 32-bit MSR index to write.
5735 @param OrData The value to OR with the read value from the MSR.
5737 @return The lower 32-bit value written to the MSR.
5749 Reads a 64-bit MSR, performs a bitwise AND on the lower 32-bits, and writes
5750 the result back to the 64-bit MSR.
5752 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
5753 lower 32-bits of the read result and the value specified by AndData, and
5754 writes the result to the 64-bit MSR specified by Index. The lower 32-bits of
5755 the value written to the MSR is returned. No parameter checking is performed
5756 on Index or AndData, and some of these may cause CPU exceptions. The caller
5757 must either guarantee that Index and AndData are valid, or the caller must
5758 establish proper exception handlers. This function is only available on IA-32
5761 @param Index The 32-bit MSR index to write.
5762 @param AndData The value to AND with the read value from the MSR.
5764 @return The lower 32-bit value written to the MSR.
5776 Reads a 64-bit MSR, performs a bitwise AND followed by a bitwise OR
5777 on the lower 32-bits, and writes the result back to the 64-bit MSR.
5779 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
5780 lower 32-bits of the read result and the value specified by AndData
5781 preserving the upper 32-bits, performs a bitwise OR between the
5782 result of the AND operation and the value specified by OrData, and writes the
5783 result to the 64-bit MSR specified by Address. The lower 32-bits of the value
5784 written to the MSR is returned. No parameter checking is performed on Index,
5785 AndData, or OrData, and some of these may cause CPU exceptions. The caller
5786 must either guarantee that Index, AndData, and OrData are valid, or the
5787 caller must establish proper exception handlers. This function is only
5788 available on IA-32 and x64.
5790 @param Index The 32-bit MSR index to write.
5791 @param AndData The value to AND with the read value from the MSR.
5792 @param OrData The value to OR with the result of the AND operation.
5794 @return The lower 32-bit value written to the MSR.
5807 Reads a bit field of an MSR.
5809 Reads the bit field in the lower 32-bits of a 64-bit MSR. The bit field is
5810 specified by the StartBit and the EndBit. The value of the bit field is
5811 returned. The caller must either guarantee that Index is valid, or the caller
5812 must set up exception handlers to catch the exceptions. This function is only
5813 available on IA-32 and x64.
5815 If StartBit is greater than 31, then ASSERT().
5816 If EndBit is greater than 31, then ASSERT().
5817 If EndBit is less than StartBit, then ASSERT().
5819 @param Index The 32-bit MSR index to read.
5820 @param StartBit The ordinal of the least significant bit in the bit field.
5822 @param EndBit The ordinal of the most significant bit in the bit field.
5825 @return The bit field read from the MSR.
5830 AsmMsrBitFieldRead32 (
5838 Writes a bit field to an MSR.
5840 Writes Value to a bit field in the lower 32-bits of a 64-bit MSR. The bit
5841 field is specified by the StartBit and the EndBit. All other bits in the
5842 destination MSR are preserved. The lower 32-bits of the MSR written is
5843 returned. The caller must either guarantee that Index and the data written
5844 is valid, or the caller must set up exception handlers to catch the exceptions.
5845 This function is only available on IA-32 and x64.
5847 If StartBit is greater than 31, then ASSERT().
5848 If EndBit is greater than 31, then ASSERT().
5849 If EndBit is less than StartBit, then ASSERT().
5850 If Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
5852 @param Index The 32-bit MSR index to write.
5853 @param StartBit The ordinal of the least significant bit in the bit field.
5855 @param EndBit The ordinal of the most significant bit in the bit field.
5857 @param Value New value of the bit field.
5859 @return The lower 32-bit of the value written to the MSR.
5864 AsmMsrBitFieldWrite32 (
5873 Reads a bit field in a 64-bit MSR, performs a bitwise OR, and writes the
5874 result back to the bit field in the 64-bit MSR.
5876 Reads the 64-bit MSR specified by Index, performs a bitwise OR
5877 between the read result and the value specified by OrData, and writes the
5878 result to the 64-bit MSR specified by Index. The lower 32-bits of the value
5879 written to the MSR are returned. Extra left bits in OrData are stripped. The
5880 caller must either guarantee that Index and the data written is valid, or
5881 the caller must set up exception handlers to catch the exceptions. This
5882 function is only available on IA-32 and x64.
5884 If StartBit is greater than 31, then ASSERT().
5885 If EndBit is greater than 31, then ASSERT().
5886 If EndBit is less than StartBit, then ASSERT().
5887 If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
5889 @param Index The 32-bit MSR index to write.
5890 @param StartBit The ordinal of the least significant bit in the bit field.
5892 @param EndBit The ordinal of the most significant bit in the bit field.
5894 @param OrData The value to OR with the read value from the MSR.
5896 @return The lower 32-bit of the value written to the MSR.
5901 AsmMsrBitFieldOr32 (
5910 Reads a bit field in a 64-bit MSR, performs a bitwise AND, and writes the
5911 result back to the bit field in the 64-bit MSR.
5913 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
5914 read result and the value specified by AndData, and writes the result to the
5915 64-bit MSR specified by Index. The lower 32-bits of the value written to the
5916 MSR are returned. Extra left bits in AndData are stripped. The caller must
5917 either guarantee that Index and the data written is valid, or the caller must
5918 set up exception handlers to catch the exceptions. This function is only
5919 available on IA-32 and x64.
5921 If StartBit is greater than 31, then ASSERT().
5922 If EndBit is greater than 31, then ASSERT().
5923 If EndBit is less than StartBit, then ASSERT().
5924 If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
5926 @param Index The 32-bit MSR index to write.
5927 @param StartBit The ordinal of the least significant bit in the bit field.
5929 @param EndBit The ordinal of the most significant bit in the bit field.
5931 @param AndData The value to AND with the read value from the MSR.
5933 @return The lower 32-bit of the value written to the MSR.
5938 AsmMsrBitFieldAnd32 (
5947 Reads a bit field in a 64-bit MSR, performs a bitwise AND followed by a
5948 bitwise OR, and writes the result back to the bit field in the
5951 Reads the 64-bit MSR specified by Index, performs a bitwise AND followed by a
5952 bitwise OR between the read result and the value specified by
5953 AndData, and writes the result to the 64-bit MSR specified by Index. The
5954 lower 32-bits of the value written to the MSR are returned. Extra left bits
5955 in both AndData and OrData are stripped. The caller must either guarantee
5956 that Index and the data written is valid, or the caller must set up exception
5957 handlers to catch the exceptions. This function is only available on IA-32
5960 If StartBit is greater than 31, then ASSERT().
5961 If EndBit is greater than 31, then ASSERT().
5962 If EndBit is less than StartBit, then ASSERT().
5963 If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
5964 If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
5966 @param Index The 32-bit MSR index to write.
5967 @param StartBit The ordinal of the least significant bit in the bit field.
5969 @param EndBit The ordinal of the most significant bit in the bit field.
5971 @param AndData The value to AND with the read value from the MSR.
5972 @param OrData The value to OR with the result of the AND operation.
5974 @return The lower 32-bit of the value written to the MSR.
5979 AsmMsrBitFieldAndThenOr32 (
5989 Returns a 64-bit Machine Specific Register(MSR).
5991 Reads and returns the 64-bit MSR specified by Index. No parameter checking is
5992 performed on Index, and some Index values may cause CPU exceptions. The
5993 caller must either guarantee that Index is valid, or the caller must set up
5994 exception handlers to catch the exceptions. This function is only available
5997 @param Index The 32-bit MSR index to read.
5999 @return The value of the MSR identified by Index.
6010 Writes a 64-bit value to a Machine Specific Register(MSR), and returns the
6013 Writes the 64-bit value specified by Value to the MSR specified by Index. The
6014 64-bit value written to the MSR is returned. No parameter checking is
6015 performed on Index or Value, and some of these may cause CPU exceptions. The
6016 caller must either guarantee that Index and Value are valid, or the caller
6017 must establish proper exception handlers. This function is only available on
6020 @param Index The 32-bit MSR index to write.
6021 @param Value The 64-bit value to write to the MSR.
6035 Reads a 64-bit MSR, performs a bitwise OR, and writes the result
6036 back to the 64-bit MSR.
6038 Reads the 64-bit MSR specified by Index, performs a bitwise OR
6039 between the read result and the value specified by OrData, and writes the
6040 result to the 64-bit MSR specified by Index. The value written to the MSR is
6041 returned. No parameter checking is performed on Index or OrData, and some of
6042 these may cause CPU exceptions. The caller must either guarantee that Index
6043 and OrData are valid, or the caller must establish proper exception handlers.
6044 This function is only available on IA-32 and x64.
6046 @param Index The 32-bit MSR index to write.
6047 @param OrData The value to OR with the read value from the MSR.
6049 @return The value written back to the MSR.
6061 Reads a 64-bit MSR, performs a bitwise AND, and writes the result back to the
6064 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
6065 read result and the value specified by OrData, and writes the result to the
6066 64-bit MSR specified by Index. The value written to the MSR is returned. No
6067 parameter checking is performed on Index or OrData, and some of these may
6068 cause CPU exceptions. The caller must either guarantee that Index and OrData
6069 are valid, or the caller must establish proper exception handlers. This
6070 function is only available on IA-32 and x64.
6072 @param Index The 32-bit MSR index to write.
6073 @param AndData The value to AND with the read value from the MSR.
6075 @return The value written back to the MSR.
6087 Reads a 64-bit MSR, performs a bitwise AND followed by a bitwise
6088 OR, and writes the result back to the 64-bit MSR.
6090 Reads the 64-bit MSR specified by Index, performs a bitwise AND between read
6091 result and the value specified by AndData, performs a bitwise OR
6092 between the result of the AND operation and the value specified by OrData,
6093 and writes the result to the 64-bit MSR specified by Index. The value written
6094 to the MSR is returned. No parameter checking is performed on Index, AndData,
6095 or OrData, and some of these may cause CPU exceptions. The caller must either
6096 guarantee that Index, AndData, and OrData are valid, or the caller must
6097 establish proper exception handlers. This function is only available on IA-32
6100 @param Index The 32-bit MSR index to write.
6101 @param AndData The value to AND with the read value from the MSR.
6102 @param OrData The value to OR with the result of the AND operation.
6104 @return The value written back to the MSR.
6117 Reads a bit field of an MSR.
6119 Reads the bit field in the 64-bit MSR. The bit field is specified by the
6120 StartBit and the EndBit. The value of the bit field is returned. The caller
6121 must either guarantee that Index is valid, or the caller must set up
6122 exception handlers to catch the exceptions. This function is only available
6125 If StartBit is greater than 63, then ASSERT().
6126 If EndBit is greater than 63, then ASSERT().
6127 If EndBit is less than StartBit, then ASSERT().
6129 @param Index The 32-bit MSR index to read.
6130 @param StartBit The ordinal of the least significant bit in the bit field.
6132 @param EndBit The ordinal of the most significant bit in the bit field.
6135 @return The value read from the MSR.
6140 AsmMsrBitFieldRead64 (
6148 Writes a bit field to an MSR.
6150 Writes Value to a bit field in a 64-bit MSR. The bit field is specified by
6151 the StartBit and the EndBit. All other bits in the destination MSR are
6152 preserved. The MSR written is returned. The caller must either guarantee
6153 that Index and the data written is valid, or the caller must set up exception
6154 handlers to catch the exceptions. This function is only available on IA-32 and x64.
6156 If StartBit is greater than 63, then ASSERT().
6157 If EndBit is greater than 63, then ASSERT().
6158 If EndBit is less than StartBit, then ASSERT().
6159 If Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
6161 @param Index The 32-bit MSR index to write.
6162 @param StartBit The ordinal of the least significant bit in the bit field.
6164 @param EndBit The ordinal of the most significant bit in the bit field.
6166 @param Value New value of the bit field.
6168 @return The value written back to the MSR.
6173 AsmMsrBitFieldWrite64 (
6182 Reads a bit field in a 64-bit MSR, performs a bitwise OR, and
6183 writes the result back to the bit field in the 64-bit MSR.
6185 Reads the 64-bit MSR specified by Index, performs a bitwise OR
6186 between the read result and the value specified by OrData, and writes the
6187 result to the 64-bit MSR specified by Index. The value written to the MSR is
6188 returned. Extra left bits in OrData are stripped. The caller must either
6189 guarantee that Index and the data written is valid, or the caller must set up
6190 exception handlers to catch the exceptions. This function is only available
6193 If StartBit is greater than 63, then ASSERT().
6194 If EndBit is greater than 63, then ASSERT().
6195 If EndBit is less than StartBit, then ASSERT().
6196 If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
6198 @param Index The 32-bit MSR index to write.
6199 @param StartBit The ordinal of the least significant bit in the bit field.
6201 @param EndBit The ordinal of the most significant bit in the bit field.
6203 @param OrData The value to OR with the read value from the bit field.
6205 @return The value written back to the MSR.
6210 AsmMsrBitFieldOr64 (
6219 Reads a bit field in a 64-bit MSR, performs a bitwise AND, and writes the
6220 result back to the bit field in the 64-bit MSR.
6222 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
6223 read result and the value specified by AndData, and writes the result to the
6224 64-bit MSR specified by Index. The value written to the MSR is returned.
6225 Extra left bits in AndData are stripped. The caller must either guarantee
6226 that Index and the data written is valid, or the caller must set up exception
6227 handlers to catch the exceptions. This function is only available on IA-32
6230 If StartBit is greater than 63, then ASSERT().
6231 If EndBit is greater than 63, then ASSERT().
6232 If EndBit is less than StartBit, then ASSERT().
6233 If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
6235 @param Index The 32-bit MSR index to write.
6236 @param StartBit The ordinal of the least significant bit in the bit field.
6238 @param EndBit The ordinal of the most significant bit in the bit field.
6240 @param AndData The value to AND with the read value from the bit field.
6242 @return The value written back to the MSR.
6247 AsmMsrBitFieldAnd64 (
6256 Reads a bit field in a 64-bit MSR, performs a bitwise AND followed by a
6257 bitwise OR, and writes the result back to the bit field in the
6260 Reads the 64-bit MSR specified by Index, performs a bitwise AND followed by
6261 a bitwise OR between the read result and the value specified by
6262 AndData, and writes the result to the 64-bit MSR specified by Index. The
6263 value written to the MSR is returned. Extra left bits in both AndData and
6264 OrData are stripped. The caller must either guarantee that Index and the data
6265 written is valid, or the caller must set up exception handlers to catch the
6266 exceptions. This function is only available on IA-32 and x64.
6268 If StartBit is greater than 63, then ASSERT().
6269 If EndBit is greater than 63, then ASSERT().
6270 If EndBit is less than StartBit, then ASSERT().
6271 If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
6272 If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
6274 @param Index The 32-bit MSR index to write.
6275 @param StartBit The ordinal of the least significant bit in the bit field.
6277 @param EndBit The ordinal of the most significant bit in the bit field.
6279 @param AndData The value to AND with the read value from the bit field.
6280 @param OrData The value to OR with the result of the AND operation.
6282 @return The value written back to the MSR.
6287 AsmMsrBitFieldAndThenOr64 (
6297 Reads the current value of the EFLAGS register.
6299 Reads and returns the current value of the EFLAGS register. This function is
6300 only available on IA-32 and x64. This returns a 32-bit value on IA-32 and a
6301 64-bit value on x64.
6303 @return EFLAGS on IA-32 or RFLAGS on x64.
6314 Reads the current value of the Control Register 0 (CR0).
6316 Reads and returns the current value of CR0. This function is only available
6317 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
6320 @return The value of the Control Register 0 (CR0).
6331 Reads the current value of the Control Register 2 (CR2).
6333 Reads and returns the current value of CR2. This function is only available
6334 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
6337 @return The value of the Control Register 2 (CR2).
6348 Reads the current value of the Control Register 3 (CR3).
6350 Reads and returns the current value of CR3. This function is only available
6351 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
6354 @return The value of the Control Register 3 (CR3).
6365 Reads the current value of the Control Register 4 (CR4).
6367 Reads and returns the current value of CR4. This function is only available
6368 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
6371 @return The value of the Control Register 4 (CR4).
6382 Writes a value to Control Register 0 (CR0).
6384 Writes and returns a new value to CR0. This function is only available on
6385 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
6387 @param Cr0 The value to write to CR0.
6389 @return The value written to CR0.
6400 Writes a value to Control Register 2 (CR2).
6402 Writes and returns a new value to CR2. This function is only available on
6403 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
6405 @param Cr2 The value to write to CR2.
6407 @return The value written to CR2.
6418 Writes a value to Control Register 3 (CR3).
6420 Writes and returns a new value to CR3. This function is only available on
6421 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
6423 @param Cr3 The value to write to CR3.
6425 @return The value written to CR3.
6436 Writes a value to Control Register 4 (CR4).
6438 Writes and returns a new value to CR4. This function is only available on
6439 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
6441 @param Cr4 The value to write to CR4.
6443 @return The value written to CR4.
6454 Reads the current value of Debug Register 0 (DR0).
6456 Reads and returns the current value of DR0. This function is only available
6457 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
6460 @return The value of Debug Register 0 (DR0).
6471 Reads the current value of Debug Register 1 (DR1).
6473 Reads and returns the current value of DR1. This function is only available
6474 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
6477 @return The value of Debug Register 1 (DR1).
6488 Reads the current value of Debug Register 2 (DR2).
6490 Reads and returns the current value of DR2. This function is only available
6491 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
6494 @return The value of Debug Register 2 (DR2).
6505 Reads the current value of Debug Register 3 (DR3).
6507 Reads and returns the current value of DR3. This function is only available
6508 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
6511 @return The value of Debug Register 3 (DR3).
6522 Reads the current value of Debug Register 4 (DR4).
6524 Reads and returns the current value of DR4. This function is only available
6525 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
6528 @return The value of Debug Register 4 (DR4).
6539 Reads the current value of Debug Register 5 (DR5).
6541 Reads and returns the current value of DR5. This function is only available
6542 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
6545 @return The value of Debug Register 5 (DR5).
6556 Reads the current value of Debug Register 6 (DR6).
6558 Reads and returns the current value of DR6. This function is only available
6559 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
6562 @return The value of Debug Register 6 (DR6).
6573 Reads the current value of Debug Register 7 (DR7).
6575 Reads and returns the current value of DR7. This function is only available
6576 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
6579 @return The value of Debug Register 7 (DR7).
6590 Writes a value to Debug Register 0 (DR0).
6592 Writes and returns a new value to DR0. This function is only available on
6593 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
6595 @param Dr0 The value to write to Dr0.
6597 @return The value written to Debug Register 0 (DR0).
6608 Writes a value to Debug Register 1 (DR1).
6610 Writes and returns a new value to DR1. This function is only available on
6611 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
6613 @param Dr1 The value to write to Dr1.
6615 @return The value written to Debug Register 1 (DR1).
6626 Writes a value to Debug Register 2 (DR2).
6628 Writes and returns a new value to DR2. This function is only available on
6629 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
6631 @param Dr2 The value to write to Dr2.
6633 @return The value written to Debug Register 2 (DR2).
6644 Writes a value to Debug Register 3 (DR3).
6646 Writes and returns a new value to DR3. This function is only available on
6647 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
6649 @param Dr3 The value to write to Dr3.
6651 @return The value written to Debug Register 3 (DR3).
6662 Writes a value to Debug Register 4 (DR4).
6664 Writes and returns a new value to DR4. This function is only available on
6665 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
6667 @param Dr4 The value to write to Dr4.
6669 @return The value written to Debug Register 4 (DR4).
6680 Writes a value to Debug Register 5 (DR5).
6682 Writes and returns a new value to DR5. This function is only available on
6683 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
6685 @param Dr5 The value to write to Dr5.
6687 @return The value written to Debug Register 5 (DR5).
6698 Writes a value to Debug Register 6 (DR6).
6700 Writes and returns a new value to DR6. This function is only available on
6701 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
6703 @param Dr6 The value to write to Dr6.
6705 @return The value written to Debug Register 6 (DR6).
6716 Writes a value to Debug Register 7 (DR7).
6718 Writes and returns a new value to DR7. This function is only available on
6719 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
6721 @param Dr7 The value to write to Dr7.
6723 @return The value written to Debug Register 7 (DR7).
6734 Reads the current value of Code Segment Register (CS).
6736 Reads and returns the current value of CS. This function is only available on
6739 @return The current value of CS.
6750 Reads the current value of Data Segment Register (DS).
6752 Reads and returns the current value of DS. This function is only available on
6755 @return The current value of DS.
6766 Reads the current value of Extra Segment Register (ES).
6768 Reads and returns the current value of ES. This function is only available on
6771 @return The current value of ES.
6782 Reads the current value of FS Data Segment Register (FS).
6784 Reads and returns the current value of FS. This function is only available on
6787 @return The current value of FS.
6798 Reads the current value of GS Data Segment Register (GS).
6800 Reads and returns the current value of GS. This function is only available on
6803 @return The current value of GS.
6814 Reads the current value of Stack Segment Register (SS).
6816 Reads and returns the current value of SS. This function is only available on
6819 @return The current value of SS.
6830 Reads the current value of Task Register (TR).
6832 Reads and returns the current value of TR. This function is only available on
6835 @return The current value of TR.
6846 Reads the current Global Descriptor Table Register(GDTR) descriptor.
6848 Reads and returns the current GDTR descriptor and returns it in Gdtr. This
6849 function is only available on IA-32 and x64.
6851 If Gdtr is NULL, then ASSERT().
6853 @param Gdtr The pointer to a GDTR descriptor.
6859 OUT IA32_DESCRIPTOR
*Gdtr
6864 Writes the current Global Descriptor Table Register (GDTR) descriptor.
6866 Writes and the current GDTR descriptor specified by Gdtr. This function is
6867 only available on IA-32 and x64.
6869 If Gdtr is NULL, then ASSERT().
6871 @param Gdtr The pointer to a GDTR descriptor.
6877 IN CONST IA32_DESCRIPTOR
*Gdtr
6882 Reads the current Interrupt Descriptor Table Register(IDTR) descriptor.
6884 Reads and returns the current IDTR descriptor and returns it in Idtr. This
6885 function is only available on IA-32 and x64.
6887 If Idtr is NULL, then ASSERT().
6889 @param Idtr The pointer to a IDTR descriptor.
6895 OUT IA32_DESCRIPTOR
*Idtr
6900 Writes the current Interrupt Descriptor Table Register(IDTR) descriptor.
6902 Writes the current IDTR descriptor and returns it in Idtr. This function is
6903 only available on IA-32 and x64.
6905 If Idtr is NULL, then ASSERT().
6907 @param Idtr The pointer to a IDTR descriptor.
6913 IN CONST IA32_DESCRIPTOR
*Idtr
6918 Reads the current Local Descriptor Table Register(LDTR) selector.
6920 Reads and returns the current 16-bit LDTR descriptor value. This function is
6921 only available on IA-32 and x64.
6923 @return The current selector of LDT.
6934 Writes the current Local Descriptor Table Register (LDTR) selector.
6936 Writes and the current LDTR descriptor specified by Ldtr. This function is
6937 only available on IA-32 and x64.
6939 @param Ldtr 16-bit LDTR selector value.
6950 Save the current floating point/SSE/SSE2 context to a buffer.
6952 Saves the current floating point/SSE/SSE2 state to the buffer specified by
6953 Buffer. Buffer must be aligned on a 16-byte boundary. This function is only
6954 available on IA-32 and x64.
6956 If Buffer is NULL, then ASSERT().
6957 If Buffer is not aligned on a 16-byte boundary, then ASSERT().
6959 @param Buffer The pointer to a buffer to save the floating point/SSE/SSE2 context.
6965 OUT IA32_FX_BUFFER
*Buffer
6970 Restores the current floating point/SSE/SSE2 context from a buffer.
6972 Restores the current floating point/SSE/SSE2 state from the buffer specified
6973 by Buffer. Buffer must be aligned on a 16-byte boundary. This function is
6974 only available on IA-32 and x64.
6976 If Buffer is NULL, then ASSERT().
6977 If Buffer is not aligned on a 16-byte boundary, then ASSERT().
6978 If Buffer was not saved with AsmFxSave(), then ASSERT().
6980 @param Buffer The pointer to a buffer to save the floating point/SSE/SSE2 context.
6986 IN CONST IA32_FX_BUFFER
*Buffer
6991 Reads the current value of 64-bit MMX Register #0 (MM0).
6993 Reads and returns the current value of MM0. This function is only available
6996 @return The current value of MM0.
7007 Reads the current value of 64-bit MMX Register #1 (MM1).
7009 Reads and returns the current value of MM1. This function is only available
7012 @return The current value of MM1.
7023 Reads the current value of 64-bit MMX Register #2 (MM2).
7025 Reads and returns the current value of MM2. This function is only available
7028 @return The current value of MM2.
7039 Reads the current value of 64-bit MMX Register #3 (MM3).
7041 Reads and returns the current value of MM3. This function is only available
7044 @return The current value of MM3.
7055 Reads the current value of 64-bit MMX Register #4 (MM4).
7057 Reads and returns the current value of MM4. This function is only available
7060 @return The current value of MM4.
7071 Reads the current value of 64-bit MMX Register #5 (MM5).
7073 Reads and returns the current value of MM5. This function is only available
7076 @return The current value of MM5.
7087 Reads the current value of 64-bit MMX Register #6 (MM6).
7089 Reads and returns the current value of MM6. This function is only available
7092 @return The current value of MM6.
7103 Reads the current value of 64-bit MMX Register #7 (MM7).
7105 Reads and returns the current value of MM7. This function is only available
7108 @return The current value of MM7.
7119 Writes the current value of 64-bit MMX Register #0 (MM0).
7121 Writes the current value of MM0. This function is only available on IA32 and
7124 @param Value The 64-bit value to write to MM0.
7135 Writes the current value of 64-bit MMX Register #1 (MM1).
7137 Writes the current value of MM1. This function is only available on IA32 and
7140 @param Value The 64-bit value to write to MM1.
7151 Writes the current value of 64-bit MMX Register #2 (MM2).
7153 Writes the current value of MM2. This function is only available on IA32 and
7156 @param Value The 64-bit value to write to MM2.
7167 Writes the current value of 64-bit MMX Register #3 (MM3).
7169 Writes the current value of MM3. This function is only available on IA32 and
7172 @param Value The 64-bit value to write to MM3.
7183 Writes the current value of 64-bit MMX Register #4 (MM4).
7185 Writes the current value of MM4. This function is only available on IA32 and
7188 @param Value The 64-bit value to write to MM4.
7199 Writes the current value of 64-bit MMX Register #5 (MM5).
7201 Writes the current value of MM5. This function is only available on IA32 and
7204 @param Value The 64-bit value to write to MM5.
7215 Writes the current value of 64-bit MMX Register #6 (MM6).
7217 Writes the current value of MM6. This function is only available on IA32 and
7220 @param Value The 64-bit value to write to MM6.
7231 Writes the current value of 64-bit MMX Register #7 (MM7).
7233 Writes the current value of MM7. This function is only available on IA32 and
7236 @param Value The 64-bit value to write to MM7.
7247 Reads the current value of Time Stamp Counter (TSC).
7249 Reads and returns the current value of TSC. This function is only available
7252 @return The current value of TSC
7263 Reads the current value of a Performance Counter (PMC).
7265 Reads and returns the current value of performance counter specified by
7266 Index. This function is only available on IA-32 and x64.
7268 @param Index The 32-bit Performance Counter index to read.
7270 @return The value of the PMC specified by Index.
7281 Sets up a monitor buffer that is used by AsmMwait().
7283 Executes a MONITOR instruction with the register state specified by Eax, Ecx
7284 and Edx. Returns Eax. This function is only available on IA-32 and x64.
7286 @param Eax The value to load into EAX or RAX before executing the MONITOR
7288 @param Ecx The value to load into ECX or RCX before executing the MONITOR
7290 @param Edx The value to load into EDX or RDX before executing the MONITOR
7306 Executes an MWAIT instruction.
7308 Executes an MWAIT instruction with the register state specified by Eax and
7309 Ecx. Returns Eax. This function is only available on IA-32 and x64.
7311 @param Eax The value to load into EAX or RAX before executing the MONITOR
7313 @param Ecx The value to load into ECX or RCX before executing the MONITOR
7328 Executes a WBINVD instruction.
7330 Executes a WBINVD instruction. This function is only available on IA-32 and
7342 Executes a INVD instruction.
7344 Executes a INVD instruction. This function is only available on IA-32 and
7356 Flushes a cache line from all the instruction and data caches within the
7357 coherency domain of the CPU.
7359 Flushed the cache line specified by LinearAddress, and returns LinearAddress.
7360 This function is only available on IA-32 and x64.
7362 @param LinearAddress The address of the cache line to flush. If the CPU is
7363 in a physical addressing mode, then LinearAddress is a
7364 physical address. If the CPU is in a virtual
7365 addressing mode, then LinearAddress is a virtual
7368 @return LinearAddress.
7373 IN VOID
*LinearAddress
7378 Enables the 32-bit paging mode on the CPU.
7380 Enables the 32-bit paging mode on the CPU. CR0, CR3, CR4, and the page tables
7381 must be properly initialized prior to calling this service. This function
7382 assumes the current execution mode is 32-bit protected mode. This function is
7383 only available on IA-32. After the 32-bit paging mode is enabled, control is
7384 transferred to the function specified by EntryPoint using the new stack
7385 specified by NewStack and passing in the parameters specified by Context1 and
7386 Context2. Context1 and Context2 are optional and may be NULL. The function
7387 EntryPoint must never return.
7389 If the current execution mode is not 32-bit protected mode, then ASSERT().
7390 If EntryPoint is NULL, then ASSERT().
7391 If NewStack is NULL, then ASSERT().
7393 There are a number of constraints that must be followed before calling this
7395 1) Interrupts must be disabled.
7396 2) The caller must be in 32-bit protected mode with flat descriptors. This
7397 means all descriptors must have a base of 0 and a limit of 4GB.
7398 3) CR0 and CR4 must be compatible with 32-bit protected mode with flat
7400 4) CR3 must point to valid page tables that will be used once the transition
7401 is complete, and those page tables must guarantee that the pages for this
7402 function and the stack are identity mapped.
7404 @param EntryPoint A pointer to function to call with the new stack after
7406 @param Context1 A pointer to the context to pass into the EntryPoint
7407 function as the first parameter after paging is enabled.
7408 @param Context2 A pointer to the context to pass into the EntryPoint
7409 function as the second parameter after paging is enabled.
7410 @param NewStack A pointer to the new stack to use for the EntryPoint
7411 function after paging is enabled.
7417 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
7418 IN VOID
*Context1
, OPTIONAL
7419 IN VOID
*Context2
, OPTIONAL
7425 Disables the 32-bit paging mode on the CPU.
7427 Disables the 32-bit paging mode on the CPU and returns to 32-bit protected
7428 mode. This function assumes the current execution mode is 32-paged protected
7429 mode. This function is only available on IA-32. After the 32-bit paging mode
7430 is disabled, control is transferred to the function specified by EntryPoint
7431 using the new stack specified by NewStack and passing in the parameters
7432 specified by Context1 and Context2. Context1 and Context2 are optional and
7433 may be NULL. The function EntryPoint must never return.
7435 If the current execution mode is not 32-bit paged mode, then ASSERT().
7436 If EntryPoint is NULL, then ASSERT().
7437 If NewStack is NULL, then ASSERT().
7439 There are a number of constraints that must be followed before calling this
7441 1) Interrupts must be disabled.
7442 2) The caller must be in 32-bit paged mode.
7443 3) CR0, CR3, and CR4 must be compatible with 32-bit paged mode.
7444 4) CR3 must point to valid page tables that guarantee that the pages for
7445 this function and the stack are identity mapped.
7447 @param EntryPoint A pointer to function to call with the new stack after
7449 @param Context1 A pointer to the context to pass into the EntryPoint
7450 function as the first parameter after paging is disabled.
7451 @param Context2 A pointer to the context to pass into the EntryPoint
7452 function as the second parameter after paging is
7454 @param NewStack A pointer to the new stack to use for the EntryPoint
7455 function after paging is disabled.
7460 AsmDisablePaging32 (
7461 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
7462 IN VOID
*Context1
, OPTIONAL
7463 IN VOID
*Context2
, OPTIONAL
7469 Enables the 64-bit paging mode on the CPU.
7471 Enables the 64-bit paging mode on the CPU. CR0, CR3, CR4, and the page tables
7472 must be properly initialized prior to calling this service. This function
7473 assumes the current execution mode is 32-bit protected mode with flat
7474 descriptors. This function is only available on IA-32. After the 64-bit
7475 paging mode is enabled, control is transferred to the function specified by
7476 EntryPoint using the new stack specified by NewStack and passing in the
7477 parameters specified by Context1 and Context2. Context1 and Context2 are
7478 optional and may be 0. The function EntryPoint must never return.
7480 If the current execution mode is not 32-bit protected mode with flat
7481 descriptors, then ASSERT().
7482 If EntryPoint is 0, then ASSERT().
7483 If NewStack is 0, then ASSERT().
7485 @param Cs The 16-bit selector to load in the CS before EntryPoint
7486 is called. The descriptor in the GDT that this selector
7487 references must be setup for long mode.
7488 @param EntryPoint The 64-bit virtual address of the function to call with
7489 the new stack after paging is enabled.
7490 @param Context1 The 64-bit virtual address of the context to pass into
7491 the EntryPoint function as the first parameter after
7493 @param Context2 The 64-bit virtual address of the context to pass into
7494 the EntryPoint function as the second parameter after
7496 @param NewStack The 64-bit virtual address of the new stack to use for
7497 the EntryPoint function after paging is enabled.
7504 IN UINT64 EntryPoint
,
7505 IN UINT64 Context1
, OPTIONAL
7506 IN UINT64 Context2
, OPTIONAL
7512 Disables the 64-bit paging mode on the CPU.
7514 Disables the 64-bit paging mode on the CPU and returns to 32-bit protected
7515 mode. This function assumes the current execution mode is 64-paging mode.
7516 This function is only available on x64. After the 64-bit paging mode is
7517 disabled, control is transferred to the function specified by EntryPoint
7518 using the new stack specified by NewStack and passing in the parameters
7519 specified by Context1 and Context2. Context1 and Context2 are optional and
7520 may be 0. The function EntryPoint must never return.
7522 If the current execution mode is not 64-bit paged mode, then ASSERT().
7523 If EntryPoint is 0, then ASSERT().
7524 If NewStack is 0, then ASSERT().
7526 @param Cs The 16-bit selector to load in the CS before EntryPoint
7527 is called. The descriptor in the GDT that this selector
7528 references must be setup for 32-bit protected mode.
7529 @param EntryPoint The 64-bit virtual address of the function to call with
7530 the new stack after paging is disabled.
7531 @param Context1 The 64-bit virtual address of the context to pass into
7532 the EntryPoint function as the first parameter after
7534 @param Context2 The 64-bit virtual address of the context to pass into
7535 the EntryPoint function as the second parameter after
7537 @param NewStack The 64-bit virtual address of the new stack to use for
7538 the EntryPoint function after paging is disabled.
7543 AsmDisablePaging64 (
7545 IN UINT32 EntryPoint
,
7546 IN UINT32 Context1
, OPTIONAL
7547 IN UINT32 Context2
, OPTIONAL
7553 // 16-bit thunking services
7557 Retrieves the properties for 16-bit thunk functions.
7559 Computes the size of the buffer and stack below 1MB required to use the
7560 AsmPrepareThunk16(), AsmThunk16() and AsmPrepareAndThunk16() functions. This
7561 buffer size is returned in RealModeBufferSize, and the stack size is returned
7562 in ExtraStackSize. If parameters are passed to the 16-bit real mode code,
7563 then the actual minimum stack size is ExtraStackSize plus the maximum number
7564 of bytes that need to be passed to the 16-bit real mode code.
7566 If RealModeBufferSize is NULL, then ASSERT().
7567 If ExtraStackSize is NULL, then ASSERT().
7569 @param RealModeBufferSize A pointer to the size of the buffer below 1MB
7570 required to use the 16-bit thunk functions.
7571 @param ExtraStackSize A pointer to the extra size of stack below 1MB
7572 that the 16-bit thunk functions require for
7573 temporary storage in the transition to and from
7579 AsmGetThunk16Properties (
7580 OUT UINT32
*RealModeBufferSize
,
7581 OUT UINT32
*ExtraStackSize
7586 Prepares all structures a code required to use AsmThunk16().
7588 Prepares all structures and code required to use AsmThunk16().
7590 This interface is limited to be used in either physical mode or virtual modes with paging enabled where the
7591 virtual to physical mappings for ThunkContext.RealModeBuffer is mapped 1:1.
7593 If ThunkContext is NULL, then ASSERT().
7595 @param ThunkContext A pointer to the context structure that describes the
7596 16-bit real mode code to call.
7602 IN OUT THUNK_CONTEXT
*ThunkContext
7607 Transfers control to a 16-bit real mode entry point and returns the results.
7609 Transfers control to a 16-bit real mode entry point and returns the results.
7610 AsmPrepareThunk16() must be called with ThunkContext before this function is used.
7611 This function must be called with interrupts disabled.
7613 The register state from the RealModeState field of ThunkContext is restored just prior
7614 to calling the 16-bit real mode entry point. This includes the EFLAGS field of RealModeState,
7615 which is used to set the interrupt state when a 16-bit real mode entry point is called.
7616 Control is transferred to the 16-bit real mode entry point specified by the CS and Eip fields of RealModeState.
7617 The stack is initialized to the SS and ESP fields of RealModeState. Any parameters passed to
7618 the 16-bit real mode code must be populated by the caller at SS:ESP prior to calling this function.
7619 The 16-bit real mode entry point is invoked with a 16-bit CALL FAR instruction,
7620 so when accessing stack contents, the 16-bit real mode code must account for the 16-bit segment
7621 and 16-bit offset of the return address that were pushed onto the stack. The 16-bit real mode entry
7622 point must exit with a RETF instruction. The register state is captured into RealModeState immediately
7623 after the RETF instruction is executed.
7625 If EFLAGS specifies interrupts enabled, or any of the 16-bit real mode code enables interrupts,
7626 or any of the 16-bit real mode code makes a SW interrupt, then the caller is responsible for making sure
7627 the IDT at address 0 is initialized to handle any HW or SW interrupts that may occur while in 16-bit real mode.
7629 If EFLAGS specifies interrupts enabled, or any of the 16-bit real mode code enables interrupts,
7630 then the caller is responsible for making sure the 8259 PIC is in a state compatible with 16-bit real mode.
7631 This includes the base vectors, the interrupt masks, and the edge/level trigger mode.
7633 If THUNK_ATTRIBUTE_BIG_REAL_MODE is set in the ThunkAttributes field of ThunkContext, then the user code
7634 is invoked in big real mode. Otherwise, the user code is invoked in 16-bit real mode with 64KB segment limits.
7636 If neither THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 nor THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL are set in
7637 ThunkAttributes, then it is assumed that the user code did not enable the A20 mask, and no attempt is made to
7638 disable the A20 mask.
7640 If THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 is set and THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL is clear in
7641 ThunkAttributes, then attempt to use the INT 15 service to disable the A20 mask. If this INT 15 call fails,
7642 then attempt to disable the A20 mask by directly accessing the 8042 keyboard controller I/O ports.
7644 If THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 is clear and THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL is set in
7645 ThunkAttributes, then attempt to disable the A20 mask by directly accessing the 8042 keyboard controller I/O ports.
7647 If ThunkContext is NULL, then ASSERT().
7648 If AsmPrepareThunk16() was not previously called with ThunkContext, then ASSERT().
7649 If both THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 and THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL are set in
7650 ThunkAttributes, then ASSERT().
7652 This interface is limited to be used in either physical mode or virtual modes with paging enabled where the
7653 virtual to physical mappings for ThunkContext.RealModeBuffer are mapped 1:1.
7655 @param ThunkContext A pointer to the context structure that describes the
7656 16-bit real mode code to call.
7662 IN OUT THUNK_CONTEXT
*ThunkContext
7667 Prepares all structures and code for a 16-bit real mode thunk, transfers
7668 control to a 16-bit real mode entry point, and returns the results.
7670 Prepares all structures and code for a 16-bit real mode thunk, transfers
7671 control to a 16-bit real mode entry point, and returns the results. If the
7672 caller only need to perform a single 16-bit real mode thunk, then this
7673 service should be used. If the caller intends to make more than one 16-bit
7674 real mode thunk, then it is more efficient if AsmPrepareThunk16() is called
7675 once and AsmThunk16() can be called for each 16-bit real mode thunk.
7677 This interface is limited to be used in either physical mode or virtual modes with paging enabled where the
7678 virtual to physical mappings for ThunkContext.RealModeBuffer is mapped 1:1.
7680 See AsmPrepareThunk16() and AsmThunk16() for the detailed description and ASSERT() conditions.
7682 @param ThunkContext A pointer to the context structure that describes the
7683 16-bit real mode code to call.
7688 AsmPrepareAndThunk16 (
7689 IN OUT THUNK_CONTEXT
*ThunkContext
7693 Generates a 16-bit random number through RDRAND instruction.
7695 if Rand is NULL, then ASSERT().
7697 @param[out] Rand Buffer pointer to store the random result.
7699 @retval TRUE RDRAND call was successful.
7700 @retval FALSE Failed attempts to call RDRAND.
7710 Generates a 32-bit random number through RDRAND instruction.
7712 if Rand is NULL, then ASSERT().
7714 @param[out] Rand Buffer pointer to store the random result.
7716 @retval TRUE RDRAND call was successful.
7717 @retval FALSE Failed attempts to call RDRAND.
7727 Generates a 64-bit random number through RDRAND instruction.
7729 if Rand is NULL, then ASSERT().
7731 @param[out] Rand Buffer pointer to store the random result.
7733 @retval TRUE RDRAND call was successful.
7734 @retval FALSE Failed attempts to call RDRAND.
7744 Load given selector into TR register.
7746 @param[in] Selector Task segment selector
7755 Performs a serializing operation on all load-from-memory instructions that
7756 were issued prior the AsmLfence function.
7758 Executes a LFENCE instruction. This function is only available on IA-32 and x64.
7768 Patch the immediate operand of an IA32 or X64 instruction such that the byte,
7769 word, dword or qword operand is encoded at the end of the instruction's
7770 binary representation.
7772 This function should be used to update object code that was compiled with
7773 NASM from assembly source code. Example:
7777 mov eax, strict dword 0 ; the imm32 zero operand will be patched
7783 X86_ASSEMBLY_PATCH_LABEL gPatchCr3;
7784 PatchInstructionX86 (gPatchCr3, AsmReadCr3 (), 4);
7786 @param[out] InstructionEnd Pointer right past the instruction to patch. The
7787 immediate operand to patch is expected to
7788 comprise the trailing bytes of the instruction.
7789 If InstructionEnd is closer to address 0 than
7790 ValueSize permits, then ASSERT().
7792 @param[in] PatchValue The constant to write to the immediate operand.
7793 The caller is responsible for ensuring that
7794 PatchValue can be represented in the byte, word,
7795 dword or qword operand (as indicated through
7796 ValueSize); otherwise ASSERT().
7798 @param[in] ValueSize The size of the operand in bytes; must be 1, 2,
7799 4, or 8. ASSERT() otherwise.
7803 PatchInstructionX86 (
7804 OUT X86_ASSEMBLY_PATCH_LABEL
*InstructionEnd
,
7805 IN UINT64 PatchValue
,
7809 #endif // defined (MDE_CPU_IA32) || defined (MDE_CPU_X64)
7810 #endif // !defined (__BASE_LIB__)