2 Provides string functions, linked list functions, math functions, synchronization
3 functions, file path functions, and CPU architecture-specific functions.
5 Copyright (c) 2006 - 2017, 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_IPF)
43 /// The Itanium architecture context buffer used by SetJump() and LongJump().
78 UINT64 AfterSpillUNAT
;
84 } BASE_LIBRARY_JUMP_BUFFER
;
86 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 0x10
88 #endif // defined (MDE_CPU_IPF)
90 #if defined (MDE_CPU_X64)
92 /// The x64 architecture context buffer used by SetJump() and LongJump().
106 UINT8 XmmBuffer
[160]; ///< XMM6-XMM15.
107 } BASE_LIBRARY_JUMP_BUFFER
;
109 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 8
111 #endif // defined (MDE_CPU_X64)
113 #if defined (MDE_CPU_EBC)
115 /// The EBC context buffer used by SetJump() and LongJump().
123 } BASE_LIBRARY_JUMP_BUFFER
;
125 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 8
127 #endif // defined (MDE_CPU_EBC)
129 #if defined (MDE_CPU_ARM)
132 UINT32 R3
; ///< A copy of R13.
143 } BASE_LIBRARY_JUMP_BUFFER
;
145 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 4
147 #endif // defined (MDE_CPU_ARM)
149 #if defined (MDE_CPU_AARCH64)
175 } BASE_LIBRARY_JUMP_BUFFER
;
177 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 8
179 #endif // defined (MDE_CPU_AARCH64)
188 Returns the length of a Null-terminated Unicode string.
190 This function is similar as strlen_s defined in C11.
192 If String is not aligned on a 16-bit boundary, then ASSERT().
194 @param String A pointer to a Null-terminated Unicode string.
195 @param MaxSize The maximum number of Destination Unicode
196 char, including terminating null char.
198 @retval 0 If String is NULL.
199 @retval MaxSize If there is no null character in the first MaxSize characters of String.
200 @return The number of characters that percede the terminating null character.
206 IN CONST CHAR16
*String
,
211 Returns the size of a Null-terminated Unicode string in bytes, including the
214 This function returns the size of the Null-terminated Unicode string
215 specified by String in bytes, including the Null terminator.
217 If String is not aligned on a 16-bit boundary, then ASSERT().
219 @param String A pointer to a Null-terminated Unicode string.
220 @param MaxSize The maximum number of Destination Unicode
221 char, including the Null terminator.
223 @retval 0 If String is NULL.
224 @retval (sizeof (CHAR16) * (MaxSize + 1))
225 If there is no Null terminator in the first MaxSize characters of
227 @return The size of the Null-terminated Unicode string in bytes, including
234 IN CONST CHAR16
*String
,
239 Copies the string pointed to by Source (including the terminating null char)
240 to the array pointed to by Destination.
242 This function is similar as strcpy_s defined in C11.
244 If Destination is not aligned on a 16-bit boundary, then ASSERT().
245 If Source is not aligned on a 16-bit boundary, then ASSERT().
246 If an error would be returned, then the function will also ASSERT().
248 If an error is returned, then the Destination is unmodified.
250 @param Destination A pointer to a Null-terminated Unicode string.
251 @param DestMax The maximum number of Destination Unicode
252 char, including terminating null char.
253 @param Source A pointer to a Null-terminated Unicode string.
255 @retval RETURN_SUCCESS String is copied.
256 @retval RETURN_BUFFER_TOO_SMALL If DestMax is NOT greater than StrLen(Source).
257 @retval RETURN_INVALID_PARAMETER If Destination is NULL.
259 If PcdMaximumUnicodeStringLength is not zero,
260 and DestMax is greater than
261 PcdMaximumUnicodeStringLength.
263 @retval RETURN_ACCESS_DENIED If Source and Destination overlap.
268 OUT CHAR16
*Destination
,
270 IN CONST CHAR16
*Source
274 Copies not more than Length successive char from the string pointed to by
275 Source to the array pointed to by Destination. If no null char is copied from
276 Source, then Destination[Length] is always set to null.
278 This function is similar as strncpy_s defined in C11.
280 If Length > 0 and Destination is not aligned on a 16-bit boundary, then ASSERT().
281 If Length > 0 and Source is not aligned on a 16-bit boundary, then ASSERT().
282 If an error would be returned, then the function will also ASSERT().
284 If an error is returned, then the Destination is unmodified.
286 @param Destination A pointer to a Null-terminated Unicode string.
287 @param DestMax The maximum number of Destination Unicode
288 char, including terminating null char.
289 @param Source A pointer to a Null-terminated Unicode string.
290 @param Length The maximum number of Unicode characters to copy.
292 @retval RETURN_SUCCESS String is copied.
293 @retval RETURN_BUFFER_TOO_SMALL If DestMax is NOT greater than
294 MIN(StrLen(Source), Length).
295 @retval RETURN_INVALID_PARAMETER If Destination is NULL.
297 If PcdMaximumUnicodeStringLength is not zero,
298 and DestMax is greater than
299 PcdMaximumUnicodeStringLength.
301 @retval RETURN_ACCESS_DENIED If Source and Destination overlap.
306 OUT CHAR16
*Destination
,
308 IN CONST CHAR16
*Source
,
313 Appends a copy of the string pointed to by Source (including the terminating
314 null char) to the end of the string pointed to by Destination.
316 This function is similar as strcat_s defined in C11.
318 If Destination is not aligned on a 16-bit boundary, then ASSERT().
319 If Source is not aligned on a 16-bit boundary, then ASSERT().
320 If an error would be returned, then the function will also ASSERT().
322 If an error is returned, then the Destination is unmodified.
324 @param Destination A pointer to a Null-terminated Unicode string.
325 @param DestMax The maximum number of Destination Unicode
326 char, including terminating null char.
327 @param Source A pointer to a Null-terminated Unicode string.
329 @retval RETURN_SUCCESS String is appended.
330 @retval RETURN_BAD_BUFFER_SIZE If DestMax is NOT greater than
332 @retval RETURN_BUFFER_TOO_SMALL If (DestMax - StrLen(Destination)) is NOT
333 greater than StrLen(Source).
334 @retval RETURN_INVALID_PARAMETER If Destination is NULL.
336 If PcdMaximumUnicodeStringLength is not zero,
337 and DestMax is greater than
338 PcdMaximumUnicodeStringLength.
340 @retval RETURN_ACCESS_DENIED If Source and Destination overlap.
345 IN OUT CHAR16
*Destination
,
347 IN CONST CHAR16
*Source
351 Appends not more than Length successive char from the string pointed to by
352 Source to the end of the string pointed to by Destination. If no null char is
353 copied from Source, then Destination[StrLen(Destination) + Length] is always
356 This function is similar as strncat_s defined in C11.
358 If Destination is not aligned on a 16-bit boundary, then ASSERT().
359 If Source is not aligned on a 16-bit boundary, then ASSERT().
360 If an error would be returned, then the function will also ASSERT().
362 If an error is returned, then the Destination is unmodified.
364 @param Destination A pointer to a Null-terminated Unicode string.
365 @param DestMax The maximum number of Destination Unicode
366 char, including terminating null char.
367 @param Source A pointer to a Null-terminated Unicode string.
368 @param Length The maximum number of Unicode characters to copy.
370 @retval RETURN_SUCCESS String is appended.
371 @retval RETURN_BAD_BUFFER_SIZE If DestMax is NOT greater than
373 @retval RETURN_BUFFER_TOO_SMALL If (DestMax - StrLen(Destination)) is NOT
374 greater than MIN(StrLen(Source), Length).
375 @retval RETURN_INVALID_PARAMETER If Destination is NULL.
377 If PcdMaximumUnicodeStringLength is not zero,
378 and DestMax is greater than
379 PcdMaximumUnicodeStringLength.
381 @retval RETURN_ACCESS_DENIED If Source and Destination overlap.
386 IN OUT CHAR16
*Destination
,
388 IN CONST CHAR16
*Source
,
393 Convert a Null-terminated Unicode decimal string to a value of type UINTN.
395 This function outputs a value of type UINTN by interpreting the contents of
396 the Unicode string specified by String as a decimal number. The format of the
397 input Unicode string String is:
399 [spaces] [decimal digits].
401 The valid decimal digit character is in the range [0-9]. The function will
402 ignore the pad space, which includes spaces or tab characters, before
403 [decimal digits]. The running zero in the beginning of [decimal digits] will
404 be ignored. Then, the function stops at the first character that is a not a
405 valid decimal character or a Null-terminator, whichever one comes first.
407 If String is NULL, then ASSERT().
408 If Data is NULL, then ASSERT().
409 If String is not aligned in a 16-bit boundary, then ASSERT().
410 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
411 PcdMaximumUnicodeStringLength Unicode characters, not including the
412 Null-terminator, then ASSERT().
414 If String has no valid decimal digits in the above format, then 0 is stored
415 at the location pointed to by Data.
416 If the number represented by String exceeds the range defined by UINTN, then
417 MAX_UINTN is stored at the location pointed to by Data.
419 If EndPointer is not NULL, a pointer to the character that stopped the scan
420 is stored at the location pointed to by EndPointer. If String has no valid
421 decimal digits right after the optional pad spaces, the value of String is
422 stored at the location pointed to by EndPointer.
424 @param String Pointer to a Null-terminated Unicode string.
425 @param EndPointer Pointer to character that stops scan.
426 @param Data Pointer to the converted value.
428 @retval RETURN_SUCCESS Value is translated from String.
429 @retval RETURN_INVALID_PARAMETER If String is NULL.
431 If PcdMaximumUnicodeStringLength is not
432 zero, and String contains more than
433 PcdMaximumUnicodeStringLength Unicode
434 characters, not including the
436 @retval RETURN_UNSUPPORTED If the number represented by String exceeds
437 the range defined by UINTN.
443 IN CONST CHAR16
*String
,
444 OUT CHAR16
**EndPointer
, OPTIONAL
449 Convert a Null-terminated Unicode decimal string to a value of type UINT64.
451 This function outputs a value of type UINT64 by interpreting the contents of
452 the Unicode string specified by String as a decimal number. The format of the
453 input Unicode string String is:
455 [spaces] [decimal digits].
457 The valid decimal digit character is in the range [0-9]. The function will
458 ignore the pad space, which includes spaces or tab characters, before
459 [decimal digits]. The running zero in the beginning of [decimal digits] will
460 be ignored. Then, the function stops at the first character that is a not a
461 valid decimal character or a Null-terminator, whichever one comes first.
463 If String is NULL, then ASSERT().
464 If Data is NULL, then ASSERT().
465 If String is not aligned in a 16-bit boundary, then ASSERT().
466 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
467 PcdMaximumUnicodeStringLength Unicode characters, not including the
468 Null-terminator, then ASSERT().
470 If String has no valid decimal digits in the above format, then 0 is stored
471 at the location pointed to by Data.
472 If the number represented by String exceeds the range defined by UINT64, then
473 MAX_UINT64 is stored at the location pointed to by Data.
475 If EndPointer is not NULL, a pointer to the character that stopped the scan
476 is stored at the location pointed to by EndPointer. If String has no valid
477 decimal digits right after the optional pad spaces, the value of String is
478 stored at the location pointed to by EndPointer.
480 @param String Pointer to a Null-terminated Unicode string.
481 @param EndPointer Pointer to character that stops scan.
482 @param Data Pointer to the converted value.
484 @retval RETURN_SUCCESS Value is translated from String.
485 @retval RETURN_INVALID_PARAMETER If String is NULL.
487 If PcdMaximumUnicodeStringLength is not
488 zero, and String contains more than
489 PcdMaximumUnicodeStringLength Unicode
490 characters, not including the
492 @retval RETURN_UNSUPPORTED If the number represented by String exceeds
493 the range defined by UINT64.
498 StrDecimalToUint64S (
499 IN CONST CHAR16
*String
,
500 OUT CHAR16
**EndPointer
, OPTIONAL
505 Convert a Null-terminated Unicode hexadecimal string to a value of type
508 This function outputs a value of type UINTN by interpreting the contents of
509 the Unicode string specified by String as a hexadecimal number. The format of
510 the input Unicode string String is:
512 [spaces][zeros][x][hexadecimal digits].
514 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
515 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix.
516 If "x" appears in the input string, it must be prefixed with at least one 0.
517 The function will ignore the pad space, which includes spaces or tab
518 characters, before [zeros], [x] or [hexadecimal digit]. The running zero
519 before [x] or [hexadecimal digit] will be ignored. Then, the decoding starts
520 after [x] or the first valid hexadecimal digit. Then, the function stops at
521 the first character that is a not a valid hexadecimal character or NULL,
522 whichever one comes first.
524 If String is NULL, then ASSERT().
525 If Data is NULL, then ASSERT().
526 If String is not aligned in a 16-bit boundary, then ASSERT().
527 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
528 PcdMaximumUnicodeStringLength Unicode characters, not including the
529 Null-terminator, then ASSERT().
531 If String has no valid hexadecimal digits in the above format, then 0 is
532 stored at the location pointed to by Data.
533 If the number represented by String exceeds the range defined by UINTN, then
534 MAX_UINTN is stored at the location pointed to by Data.
536 If EndPointer is not NULL, a pointer to the character that stopped the scan
537 is stored at the location pointed to by EndPointer. If String has no valid
538 hexadecimal digits right after the optional pad spaces, the value of String
539 is stored at the location pointed to by EndPointer.
541 @param String Pointer to a Null-terminated Unicode string.
542 @param EndPointer Pointer to character that stops scan.
543 @param Data Pointer to the converted value.
545 @retval RETURN_SUCCESS Value is translated from String.
546 @retval RETURN_INVALID_PARAMETER If String is NULL.
548 If PcdMaximumUnicodeStringLength is not
549 zero, and String contains more than
550 PcdMaximumUnicodeStringLength Unicode
551 characters, not including the
553 @retval RETURN_UNSUPPORTED If the number represented by String exceeds
554 the range defined by UINTN.
560 IN CONST CHAR16
*String
,
561 OUT CHAR16
**EndPointer
, OPTIONAL
566 Convert a Null-terminated Unicode hexadecimal string to a value of type
569 This function outputs a value of type UINT64 by interpreting the contents of
570 the Unicode string specified by String as a hexadecimal number. The format of
571 the input Unicode string String is:
573 [spaces][zeros][x][hexadecimal digits].
575 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
576 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix.
577 If "x" appears in the input string, it must be prefixed with at least one 0.
578 The function will ignore the pad space, which includes spaces or tab
579 characters, before [zeros], [x] or [hexadecimal digit]. The running zero
580 before [x] or [hexadecimal digit] will be ignored. Then, the decoding starts
581 after [x] or the first valid hexadecimal digit. Then, the function stops at
582 the first character that is a not a valid hexadecimal character or NULL,
583 whichever one comes first.
585 If String is NULL, then ASSERT().
586 If Data is NULL, then ASSERT().
587 If String is not aligned in a 16-bit boundary, then ASSERT().
588 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
589 PcdMaximumUnicodeStringLength Unicode characters, not including the
590 Null-terminator, then ASSERT().
592 If String has no valid hexadecimal digits in the above format, then 0 is
593 stored at the location pointed to by Data.
594 If the number represented by String exceeds the range defined by UINT64, then
595 MAX_UINT64 is stored at the location pointed to by Data.
597 If EndPointer is not NULL, a pointer to the character that stopped the scan
598 is stored at the location pointed to by EndPointer. If String has no valid
599 hexadecimal digits right after the optional pad spaces, the value of String
600 is stored at the location pointed to by EndPointer.
602 @param String Pointer to a Null-terminated Unicode string.
603 @param EndPointer Pointer to character that stops scan.
604 @param Data Pointer to the converted value.
606 @retval RETURN_SUCCESS Value is translated from String.
607 @retval RETURN_INVALID_PARAMETER If String is NULL.
609 If PcdMaximumUnicodeStringLength is not
610 zero, and String contains more than
611 PcdMaximumUnicodeStringLength Unicode
612 characters, not including the
614 @retval RETURN_UNSUPPORTED If the number represented by String exceeds
615 the range defined by UINT64.
621 IN CONST CHAR16
*String
,
622 OUT CHAR16
**EndPointer
, OPTIONAL
627 Returns the length of a Null-terminated Ascii string.
629 This function is similar as strlen_s defined in C11.
631 @param String A pointer to a Null-terminated Ascii string.
632 @param MaxSize The maximum number of Destination Ascii
633 char, including terminating null char.
635 @retval 0 If String is NULL.
636 @retval MaxSize If there is no null character in the first MaxSize characters of String.
637 @return The number of characters that percede the terminating null character.
643 IN CONST CHAR8
*String
,
648 Returns the size of a Null-terminated Ascii string in bytes, including the
651 This function returns the size of the Null-terminated Ascii string specified
652 by String in bytes, including the Null terminator.
654 @param String A pointer to a Null-terminated Ascii string.
655 @param MaxSize The maximum number of Destination Ascii
656 char, including the Null terminator.
658 @retval 0 If String is NULL.
659 @retval (sizeof (CHAR8) * (MaxSize + 1))
660 If there is no Null terminator in the first MaxSize characters of
662 @return The size of the Null-terminated Ascii string in bytes, including the
669 IN CONST CHAR8
*String
,
674 Copies the string pointed to by Source (including the terminating null char)
675 to the array pointed to by Destination.
677 This function is similar as strcpy_s defined in C11.
679 If an error would be returned, then the function will also ASSERT().
681 If an error is returned, then the Destination is unmodified.
683 @param Destination A pointer to a Null-terminated Ascii string.
684 @param DestMax The maximum number of Destination Ascii
685 char, including terminating null char.
686 @param Source A pointer to a Null-terminated Ascii string.
688 @retval RETURN_SUCCESS String is copied.
689 @retval RETURN_BUFFER_TOO_SMALL If DestMax is NOT greater than StrLen(Source).
690 @retval RETURN_INVALID_PARAMETER If Destination is NULL.
692 If PcdMaximumAsciiStringLength is not zero,
693 and DestMax is greater than
694 PcdMaximumAsciiStringLength.
696 @retval RETURN_ACCESS_DENIED If Source and Destination overlap.
701 OUT CHAR8
*Destination
,
703 IN CONST CHAR8
*Source
707 Copies not more than Length successive char from the string pointed to by
708 Source to the array pointed to by Destination. If no null char is copied from
709 Source, then Destination[Length] is always set to null.
711 This function is similar as strncpy_s defined in C11.
713 If an error would be returned, then the function will also ASSERT().
715 If an error is returned, then the Destination is unmodified.
717 @param Destination A pointer to a Null-terminated Ascii string.
718 @param DestMax The maximum number of Destination Ascii
719 char, including terminating null char.
720 @param Source A pointer to a Null-terminated Ascii string.
721 @param Length The maximum number of Ascii characters to copy.
723 @retval RETURN_SUCCESS String is copied.
724 @retval RETURN_BUFFER_TOO_SMALL If DestMax is NOT greater than
725 MIN(StrLen(Source), Length).
726 @retval RETURN_INVALID_PARAMETER If Destination is NULL.
728 If PcdMaximumAsciiStringLength is not zero,
729 and DestMax is greater than
730 PcdMaximumAsciiStringLength.
732 @retval RETURN_ACCESS_DENIED If Source and Destination overlap.
737 OUT CHAR8
*Destination
,
739 IN CONST CHAR8
*Source
,
744 Appends a copy of the string pointed to by Source (including the terminating
745 null char) to the end of the string pointed to by Destination.
747 This function is similar as strcat_s defined in C11.
749 If an error would be returned, then the function will also ASSERT().
751 If an error is returned, then the Destination is unmodified.
753 @param Destination A pointer to a Null-terminated Ascii string.
754 @param DestMax The maximum number of Destination Ascii
755 char, including terminating null char.
756 @param Source A pointer to a Null-terminated Ascii string.
758 @retval RETURN_SUCCESS String is appended.
759 @retval RETURN_BAD_BUFFER_SIZE If DestMax is NOT greater than
761 @retval RETURN_BUFFER_TOO_SMALL If (DestMax - StrLen(Destination)) is NOT
762 greater than StrLen(Source).
763 @retval RETURN_INVALID_PARAMETER If Destination is NULL.
765 If PcdMaximumAsciiStringLength is not zero,
766 and DestMax is greater than
767 PcdMaximumAsciiStringLength.
769 @retval RETURN_ACCESS_DENIED If Source and Destination overlap.
774 IN OUT CHAR8
*Destination
,
776 IN CONST CHAR8
*Source
780 Appends not more than Length successive char from the string pointed to by
781 Source to the end of the string pointed to by Destination. If no null char is
782 copied from Source, then Destination[StrLen(Destination) + Length] is always
785 This function is similar as strncat_s defined in C11.
787 If an error would be returned, then the function will also ASSERT().
789 If an error is returned, then the Destination is unmodified.
791 @param Destination A pointer to a Null-terminated Ascii string.
792 @param DestMax The maximum number of Destination Ascii
793 char, including terminating null char.
794 @param Source A pointer to a Null-terminated Ascii string.
795 @param Length The maximum number of Ascii characters to copy.
797 @retval RETURN_SUCCESS String is appended.
798 @retval RETURN_BAD_BUFFER_SIZE If DestMax is NOT greater than
800 @retval RETURN_BUFFER_TOO_SMALL If (DestMax - StrLen(Destination)) is NOT
801 greater than MIN(StrLen(Source), Length).
802 @retval RETURN_INVALID_PARAMETER If Destination is NULL.
804 If PcdMaximumAsciiStringLength is not zero,
805 and DestMax is greater than
806 PcdMaximumAsciiStringLength.
808 @retval RETURN_ACCESS_DENIED If Source and Destination overlap.
813 IN OUT CHAR8
*Destination
,
815 IN CONST CHAR8
*Source
,
820 Convert a Null-terminated Ascii decimal string to a value of type UINTN.
822 This function outputs a value of type UINTN by interpreting the contents of
823 the Ascii string specified by String as a decimal number. The format of the
824 input Ascii string String is:
826 [spaces] [decimal digits].
828 The valid decimal digit character is in the range [0-9]. The function will
829 ignore the pad space, which includes spaces or tab characters, before
830 [decimal digits]. The running zero in the beginning of [decimal digits] will
831 be ignored. Then, the function stops at the first character that is a not a
832 valid decimal character or a Null-terminator, whichever one comes first.
834 If String is NULL, then ASSERT().
835 If Data is NULL, then ASSERT().
836 If PcdMaximumAsciiStringLength is not zero, and String contains more than
837 PcdMaximumAsciiStringLength Ascii characters, not including the
838 Null-terminator, then ASSERT().
840 If String has no valid decimal digits in the above format, then 0 is stored
841 at the location pointed to by Data.
842 If the number represented by String exceeds the range defined by UINTN, then
843 MAX_UINTN is stored at the location pointed to by Data.
845 If EndPointer is not NULL, a pointer to the character that stopped the scan
846 is stored at the location pointed to by EndPointer. If String has no valid
847 decimal digits right after the optional pad spaces, the value of String is
848 stored at the location pointed to by EndPointer.
850 @param String Pointer to a Null-terminated Ascii string.
851 @param EndPointer Pointer to character that stops scan.
852 @param Data Pointer to the converted value.
854 @retval RETURN_SUCCESS Value is translated from String.
855 @retval RETURN_INVALID_PARAMETER If String is NULL.
857 If PcdMaximumAsciiStringLength is not zero,
858 and String contains more than
859 PcdMaximumAsciiStringLength Ascii
860 characters, not including the
862 @retval RETURN_UNSUPPORTED If the number represented by String exceeds
863 the range defined by UINTN.
868 AsciiStrDecimalToUintnS (
869 IN CONST CHAR8
*String
,
870 OUT CHAR8
**EndPointer
, OPTIONAL
875 Convert a Null-terminated Ascii decimal string to a value of type UINT64.
877 This function outputs a value of type UINT64 by interpreting the contents of
878 the Ascii string specified by String as a decimal number. The format of the
879 input Ascii string String is:
881 [spaces] [decimal digits].
883 The valid decimal digit character is in the range [0-9]. The function will
884 ignore the pad space, which includes spaces or tab characters, before
885 [decimal digits]. The running zero in the beginning of [decimal digits] will
886 be ignored. Then, the function stops at the first character that is a not a
887 valid decimal character or a Null-terminator, whichever one comes first.
889 If String is NULL, then ASSERT().
890 If Data is NULL, then ASSERT().
891 If PcdMaximumAsciiStringLength is not zero, and String contains more than
892 PcdMaximumAsciiStringLength Ascii characters, not including the
893 Null-terminator, then ASSERT().
895 If String has no valid decimal digits in the above format, then 0 is stored
896 at the location pointed to by Data.
897 If the number represented by String exceeds the range defined by UINT64, then
898 MAX_UINT64 is stored at the location pointed to by Data.
900 If EndPointer is not NULL, a pointer to the character that stopped the scan
901 is stored at the location pointed to by EndPointer. If String has no valid
902 decimal digits right after the optional pad spaces, the value of String is
903 stored at the location pointed to by EndPointer.
905 @param String Pointer to a Null-terminated Ascii string.
906 @param EndPointer Pointer to character that stops scan.
907 @param Data Pointer to the converted value.
909 @retval RETURN_SUCCESS Value is translated from String.
910 @retval RETURN_INVALID_PARAMETER If String is NULL.
912 If PcdMaximumAsciiStringLength is not zero,
913 and String contains more than
914 PcdMaximumAsciiStringLength Ascii
915 characters, not including the
917 @retval RETURN_UNSUPPORTED If the number represented by String exceeds
918 the range defined by UINT64.
923 AsciiStrDecimalToUint64S (
924 IN CONST CHAR8
*String
,
925 OUT CHAR8
**EndPointer
, OPTIONAL
930 Convert a Null-terminated Ascii hexadecimal string to a value of type UINTN.
932 This function outputs a value of type UINTN by interpreting the contents of
933 the Ascii string specified by String as a hexadecimal number. The format of
934 the input Ascii string String is:
936 [spaces][zeros][x][hexadecimal digits].
938 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
939 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix. If
940 "x" appears in the input string, it must be prefixed with at least one 0. The
941 function will ignore the pad space, which includes spaces or tab characters,
942 before [zeros], [x] or [hexadecimal digits]. The running zero before [x] or
943 [hexadecimal digits] will be ignored. Then, the decoding starts after [x] or
944 the first valid hexadecimal digit. Then, the function stops at the first
945 character that is a not a valid hexadecimal character or Null-terminator,
946 whichever on comes first.
948 If String is NULL, then ASSERT().
949 If Data is NULL, then ASSERT().
950 If PcdMaximumAsciiStringLength is not zero, and String contains more than
951 PcdMaximumAsciiStringLength Ascii characters, not including the
952 Null-terminator, then ASSERT().
954 If String has no valid hexadecimal digits in the above format, then 0 is
955 stored at the location pointed to by Data.
956 If the number represented by String exceeds the range defined by UINTN, then
957 MAX_UINTN is stored at the location pointed to by Data.
959 If EndPointer is not NULL, a pointer to the character that stopped the scan
960 is stored at the location pointed to by EndPointer. If String has no valid
961 hexadecimal digits right after the optional pad spaces, the value of String
962 is stored at the location pointed to by EndPointer.
964 @param String Pointer to a Null-terminated Ascii string.
965 @param EndPointer Pointer to character that stops scan.
966 @param Data Pointer to the converted value.
968 @retval RETURN_SUCCESS Value is translated from String.
969 @retval RETURN_INVALID_PARAMETER If String is NULL.
971 If PcdMaximumAsciiStringLength is not zero,
972 and String contains more than
973 PcdMaximumAsciiStringLength Ascii
974 characters, not including the
976 @retval RETURN_UNSUPPORTED If the number represented by String exceeds
977 the range defined by UINTN.
982 AsciiStrHexToUintnS (
983 IN CONST CHAR8
*String
,
984 OUT CHAR8
**EndPointer
, OPTIONAL
989 Convert a Null-terminated Ascii hexadecimal string to a value of type UINT64.
991 This function outputs a value of type UINT64 by interpreting the contents of
992 the Ascii string specified by String as a hexadecimal number. The format of
993 the input Ascii string String is:
995 [spaces][zeros][x][hexadecimal digits].
997 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
998 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix. If
999 "x" appears in the input string, it must be prefixed with at least one 0. The
1000 function will ignore the pad space, which includes spaces or tab characters,
1001 before [zeros], [x] or [hexadecimal digits]. The running zero before [x] or
1002 [hexadecimal digits] will be ignored. Then, the decoding starts after [x] or
1003 the first valid hexadecimal digit. Then, the function stops at the first
1004 character that is a not a valid hexadecimal character or Null-terminator,
1005 whichever on comes first.
1007 If String is NULL, then ASSERT().
1008 If Data is NULL, then ASSERT().
1009 If PcdMaximumAsciiStringLength is not zero, and String contains more than
1010 PcdMaximumAsciiStringLength Ascii characters, not including the
1011 Null-terminator, then ASSERT().
1013 If String has no valid hexadecimal digits in the above format, then 0 is
1014 stored at the location pointed to by Data.
1015 If the number represented by String exceeds the range defined by UINT64, then
1016 MAX_UINT64 is stored at the location pointed to by Data.
1018 If EndPointer is not NULL, a pointer to the character that stopped the scan
1019 is stored at the location pointed to by EndPointer. If String has no valid
1020 hexadecimal digits right after the optional pad spaces, the value of String
1021 is stored at the location pointed to by EndPointer.
1023 @param String Pointer to a Null-terminated Ascii string.
1024 @param EndPointer Pointer to character that stops scan.
1025 @param Data Pointer to the converted value.
1027 @retval RETURN_SUCCESS Value is translated from String.
1028 @retval RETURN_INVALID_PARAMETER If String is NULL.
1030 If PcdMaximumAsciiStringLength is not zero,
1031 and String contains more than
1032 PcdMaximumAsciiStringLength Ascii
1033 characters, not including the
1035 @retval RETURN_UNSUPPORTED If the number represented by String exceeds
1036 the range defined by UINT64.
1041 AsciiStrHexToUint64S (
1042 IN CONST CHAR8
*String
,
1043 OUT CHAR8
**EndPointer
, OPTIONAL
1048 #ifndef DISABLE_NEW_DEPRECATED_INTERFACES
1051 [ATTENTION] This function is deprecated for security reason.
1053 Copies one Null-terminated Unicode string to another Null-terminated Unicode
1054 string and returns the new Unicode string.
1056 This function copies the contents of the Unicode string Source to the Unicode
1057 string Destination, and returns Destination. If Source and Destination
1058 overlap, then the results are undefined.
1060 If Destination is NULL, then ASSERT().
1061 If Destination is not aligned on a 16-bit boundary, then ASSERT().
1062 If Source is NULL, then ASSERT().
1063 If Source is not aligned on a 16-bit boundary, then ASSERT().
1064 If Source and Destination overlap, then ASSERT().
1065 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
1066 PcdMaximumUnicodeStringLength Unicode characters not including the
1067 Null-terminator, then ASSERT().
1069 @param Destination The pointer to a Null-terminated Unicode string.
1070 @param Source The pointer to a Null-terminated Unicode string.
1072 @return Destination.
1078 OUT CHAR16
*Destination
,
1079 IN CONST CHAR16
*Source
1084 [ATTENTION] This function is deprecated for security reason.
1086 Copies up to a specified length from one Null-terminated Unicode string to
1087 another Null-terminated Unicode string and returns the new Unicode string.
1089 This function copies the contents of the Unicode string Source to the Unicode
1090 string Destination, and returns Destination. At most, Length Unicode
1091 characters are copied from Source to Destination. If Length is 0, then
1092 Destination is returned unmodified. If Length is greater that the number of
1093 Unicode characters in Source, then Destination is padded with Null Unicode
1094 characters. If Source and Destination overlap, then the results are
1097 If Length > 0 and Destination is NULL, then ASSERT().
1098 If Length > 0 and Destination is not aligned on a 16-bit boundary, then ASSERT().
1099 If Length > 0 and Source is NULL, then ASSERT().
1100 If Length > 0 and Source is not aligned on a 16-bit boundary, then ASSERT().
1101 If Source and Destination overlap, then ASSERT().
1102 If PcdMaximumUnicodeStringLength is not zero, and Length is greater than
1103 PcdMaximumUnicodeStringLength, then ASSERT().
1104 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
1105 PcdMaximumUnicodeStringLength Unicode characters, not including the Null-terminator,
1108 @param Destination The pointer to a Null-terminated Unicode string.
1109 @param Source The pointer to a Null-terminated Unicode string.
1110 @param Length The maximum number of Unicode characters to copy.
1112 @return Destination.
1118 OUT CHAR16
*Destination
,
1119 IN CONST CHAR16
*Source
,
1125 Returns the length of a Null-terminated Unicode string.
1127 This function returns the number of Unicode characters in the Null-terminated
1128 Unicode string specified by String.
1130 If String is NULL, then ASSERT().
1131 If String is not aligned on a 16-bit boundary, then ASSERT().
1132 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
1133 PcdMaximumUnicodeStringLength Unicode characters not including the
1134 Null-terminator, then ASSERT().
1136 @param String Pointer to a Null-terminated Unicode string.
1138 @return The length of String.
1144 IN CONST CHAR16
*String
1149 Returns the size of a Null-terminated Unicode string in bytes, including the
1152 This function returns the size, in bytes, of the Null-terminated Unicode string
1153 specified by String.
1155 If String is NULL, then ASSERT().
1156 If String is not aligned on a 16-bit boundary, then ASSERT().
1157 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
1158 PcdMaximumUnicodeStringLength Unicode characters not including the
1159 Null-terminator, then ASSERT().
1161 @param String The pointer to a Null-terminated Unicode string.
1163 @return The size of String.
1169 IN CONST CHAR16
*String
1174 Compares two Null-terminated Unicode strings, and returns the difference
1175 between the first mismatched Unicode characters.
1177 This function compares the Null-terminated Unicode string FirstString to the
1178 Null-terminated Unicode string SecondString. If FirstString is identical to
1179 SecondString, then 0 is returned. Otherwise, the value returned is the first
1180 mismatched Unicode character in SecondString subtracted from the first
1181 mismatched Unicode character in FirstString.
1183 If FirstString is NULL, then ASSERT().
1184 If FirstString is not aligned on a 16-bit boundary, then ASSERT().
1185 If SecondString is NULL, then ASSERT().
1186 If SecondString is not aligned on a 16-bit boundary, then ASSERT().
1187 If PcdMaximumUnicodeStringLength is not zero, and FirstString contains more
1188 than PcdMaximumUnicodeStringLength Unicode characters not including the
1189 Null-terminator, then ASSERT().
1190 If PcdMaximumUnicodeStringLength is not zero, and SecondString contains more
1191 than PcdMaximumUnicodeStringLength Unicode characters, not including the
1192 Null-terminator, then ASSERT().
1194 @param FirstString The pointer to a Null-terminated Unicode string.
1195 @param SecondString The pointer to a Null-terminated Unicode string.
1197 @retval 0 FirstString is identical to SecondString.
1198 @return others FirstString is not identical to SecondString.
1204 IN CONST CHAR16
*FirstString
,
1205 IN CONST CHAR16
*SecondString
1210 Compares up to a specified length the contents of two Null-terminated Unicode strings,
1211 and returns the difference between the first mismatched Unicode characters.
1213 This function compares the Null-terminated Unicode string FirstString to the
1214 Null-terminated Unicode string SecondString. At most, Length Unicode
1215 characters will be compared. If Length is 0, then 0 is returned. If
1216 FirstString is identical to SecondString, then 0 is returned. Otherwise, the
1217 value returned is the first mismatched Unicode character in SecondString
1218 subtracted from the first mismatched Unicode character in FirstString.
1220 If Length > 0 and FirstString is NULL, then ASSERT().
1221 If Length > 0 and FirstString is not aligned on a 16-bit boundary, then ASSERT().
1222 If Length > 0 and SecondString is NULL, then ASSERT().
1223 If Length > 0 and SecondString is not aligned on a 16-bit boundary, then ASSERT().
1224 If PcdMaximumUnicodeStringLength is not zero, and Length is greater than
1225 PcdMaximumUnicodeStringLength, then ASSERT().
1226 If PcdMaximumUnicodeStringLength is not zero, and FirstString contains more than
1227 PcdMaximumUnicodeStringLength Unicode characters, not including the Null-terminator,
1229 If PcdMaximumUnicodeStringLength is not zero, and SecondString contains more than
1230 PcdMaximumUnicodeStringLength Unicode characters, not including the Null-terminator,
1233 @param FirstString The pointer to a Null-terminated Unicode string.
1234 @param SecondString The pointer to a Null-terminated Unicode string.
1235 @param Length The maximum number of Unicode characters to compare.
1237 @retval 0 FirstString is identical to SecondString.
1238 @return others FirstString is not identical to SecondString.
1244 IN CONST CHAR16
*FirstString
,
1245 IN CONST CHAR16
*SecondString
,
1250 #ifndef DISABLE_NEW_DEPRECATED_INTERFACES
1253 [ATTENTION] This function is deprecated for security reason.
1255 Concatenates one Null-terminated Unicode string to another Null-terminated
1256 Unicode string, and returns the concatenated Unicode string.
1258 This function concatenates two Null-terminated Unicode strings. The contents
1259 of Null-terminated Unicode string Source are concatenated to the end of
1260 Null-terminated Unicode string Destination. The Null-terminated concatenated
1261 Unicode String is returned. If Source and Destination overlap, then the
1262 results are undefined.
1264 If Destination is NULL, then ASSERT().
1265 If Destination is not aligned on a 16-bit boundary, then ASSERT().
1266 If Source is NULL, then ASSERT().
1267 If Source is not aligned on a 16-bit boundary, then ASSERT().
1268 If Source and Destination overlap, then ASSERT().
1269 If PcdMaximumUnicodeStringLength is not zero, and Destination contains more
1270 than PcdMaximumUnicodeStringLength Unicode characters, not including the
1271 Null-terminator, then ASSERT().
1272 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
1273 PcdMaximumUnicodeStringLength Unicode characters, not including the
1274 Null-terminator, then ASSERT().
1275 If PcdMaximumUnicodeStringLength is not zero, and concatenating Destination
1276 and Source results in a Unicode string with more than
1277 PcdMaximumUnicodeStringLength Unicode characters, not including the
1278 Null-terminator, then ASSERT().
1280 @param Destination The pointer to a Null-terminated Unicode string.
1281 @param Source The pointer to a Null-terminated Unicode string.
1283 @return Destination.
1289 IN OUT CHAR16
*Destination
,
1290 IN CONST CHAR16
*Source
1295 [ATTENTION] This function is deprecated for security reason.
1297 Concatenates up to a specified length one Null-terminated Unicode to the end
1298 of another Null-terminated Unicode string, and returns the concatenated
1301 This function concatenates two Null-terminated Unicode strings. The contents
1302 of Null-terminated Unicode string Source are concatenated to the end of
1303 Null-terminated Unicode string Destination, and Destination is returned. At
1304 most, Length Unicode characters are concatenated from Source to the end of
1305 Destination, and Destination is always Null-terminated. If Length is 0, then
1306 Destination is returned unmodified. If Source and Destination overlap, then
1307 the results are undefined.
1309 If Destination is NULL, then ASSERT().
1310 If Length > 0 and Destination is not aligned on a 16-bit boundary, then ASSERT().
1311 If Length > 0 and Source is NULL, then ASSERT().
1312 If Length > 0 and Source is not aligned on a 16-bit boundary, then ASSERT().
1313 If Source and Destination overlap, then ASSERT().
1314 If PcdMaximumUnicodeStringLength is not zero, and Length is greater than
1315 PcdMaximumUnicodeStringLength, then ASSERT().
1316 If PcdMaximumUnicodeStringLength is not zero, and Destination contains more
1317 than PcdMaximumUnicodeStringLength Unicode characters, not including the
1318 Null-terminator, then ASSERT().
1319 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
1320 PcdMaximumUnicodeStringLength Unicode characters, not including the
1321 Null-terminator, then ASSERT().
1322 If PcdMaximumUnicodeStringLength is not zero, and concatenating Destination
1323 and Source results in a Unicode string with more than PcdMaximumUnicodeStringLength
1324 Unicode characters, not including the Null-terminator, then ASSERT().
1326 @param Destination The pointer to a Null-terminated Unicode string.
1327 @param Source The pointer to a Null-terminated Unicode string.
1328 @param Length The maximum number of Unicode characters to concatenate from
1331 @return Destination.
1337 IN OUT CHAR16
*Destination
,
1338 IN CONST CHAR16
*Source
,
1344 Returns the first occurrence of a Null-terminated Unicode sub-string
1345 in a Null-terminated Unicode string.
1347 This function scans the contents of the Null-terminated Unicode string
1348 specified by String and returns the first occurrence of SearchString.
1349 If SearchString is not found in String, then NULL is returned. If
1350 the length of SearchString is zero, then String is returned.
1352 If String is NULL, then ASSERT().
1353 If String is not aligned on a 16-bit boundary, then ASSERT().
1354 If SearchString is NULL, then ASSERT().
1355 If SearchString is not aligned on a 16-bit boundary, then ASSERT().
1357 If PcdMaximumUnicodeStringLength is not zero, and SearchString
1358 or String contains more than PcdMaximumUnicodeStringLength Unicode
1359 characters, not including the Null-terminator, then ASSERT().
1361 @param String The pointer to a Null-terminated Unicode string.
1362 @param SearchString The pointer to a Null-terminated Unicode string to search for.
1364 @retval NULL If the SearchString does not appear in String.
1365 @return others If there is a match.
1371 IN CONST CHAR16
*String
,
1372 IN CONST CHAR16
*SearchString
1376 Convert a Null-terminated Unicode decimal string to a value of
1379 This function returns a value of type UINTN by interpreting the contents
1380 of the Unicode string specified by String as a decimal number. The format
1381 of the input Unicode string String is:
1383 [spaces] [decimal digits].
1385 The valid decimal digit character is in the range [0-9]. The
1386 function will ignore the pad space, which includes spaces or
1387 tab characters, before [decimal digits]. The running zero in the
1388 beginning of [decimal digits] will be ignored. Then, the function
1389 stops at the first character that is a not a valid decimal character
1390 or a Null-terminator, whichever one comes first.
1392 If String is NULL, then ASSERT().
1393 If String is not aligned in a 16-bit boundary, then ASSERT().
1394 If String has only pad spaces, then 0 is returned.
1395 If String has no pad spaces or valid decimal digits,
1397 If the number represented by String overflows according
1398 to the range defined by UINTN, then MAX_UINTN is returned.
1400 If PcdMaximumUnicodeStringLength is not zero, and String contains
1401 more than PcdMaximumUnicodeStringLength Unicode characters not including
1402 the Null-terminator, then ASSERT().
1404 @param String The pointer to a Null-terminated Unicode string.
1406 @retval Value translated from String.
1412 IN CONST CHAR16
*String
1416 Convert a Null-terminated Unicode decimal string to a value of
1419 This function returns a value of type UINT64 by interpreting the contents
1420 of the Unicode string specified by String as a decimal number. The format
1421 of the input Unicode string String is:
1423 [spaces] [decimal digits].
1425 The valid decimal digit character is in the range [0-9]. The
1426 function will ignore the pad space, which includes spaces or
1427 tab characters, before [decimal digits]. The running zero in the
1428 beginning of [decimal digits] will be ignored. Then, the function
1429 stops at the first character that is a not a valid decimal character
1430 or a Null-terminator, whichever one comes first.
1432 If String is NULL, then ASSERT().
1433 If String is not aligned in a 16-bit boundary, then ASSERT().
1434 If String has only pad spaces, then 0 is returned.
1435 If String has no pad spaces or valid decimal digits,
1437 If the number represented by String overflows according
1438 to the range defined by UINT64, then MAX_UINT64 is returned.
1440 If PcdMaximumUnicodeStringLength is not zero, and String contains
1441 more than PcdMaximumUnicodeStringLength Unicode characters not including
1442 the Null-terminator, then ASSERT().
1444 @param String The pointer to a Null-terminated Unicode string.
1446 @retval Value translated from String.
1451 StrDecimalToUint64 (
1452 IN CONST CHAR16
*String
1457 Convert a Null-terminated Unicode hexadecimal string to a value of type UINTN.
1459 This function returns a value of type UINTN by interpreting the contents
1460 of the Unicode string specified by String as a hexadecimal number.
1461 The format of the input Unicode string String is:
1463 [spaces][zeros][x][hexadecimal digits].
1465 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
1466 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix.
1467 If "x" appears in the input string, it must be prefixed with at least one 0.
1468 The function will ignore the pad space, which includes spaces or tab characters,
1469 before [zeros], [x] or [hexadecimal digit]. The running zero before [x] or
1470 [hexadecimal digit] will be ignored. Then, the decoding starts after [x] or the
1471 first valid hexadecimal digit. Then, the function stops at the first character
1472 that is a not a valid hexadecimal character or NULL, whichever one comes first.
1474 If String is NULL, then ASSERT().
1475 If String is not aligned in a 16-bit boundary, then ASSERT().
1476 If String has only pad spaces, then zero is returned.
1477 If String has no leading pad spaces, leading zeros or valid hexadecimal digits,
1478 then zero is returned.
1479 If the number represented by String overflows according to the range defined by
1480 UINTN, then MAX_UINTN is returned.
1482 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
1483 PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator,
1486 @param String The pointer to a Null-terminated Unicode string.
1488 @retval Value translated from String.
1494 IN CONST CHAR16
*String
1499 Convert a Null-terminated Unicode hexadecimal string to a value of type UINT64.
1501 This function returns a value of type UINT64 by interpreting the contents
1502 of the Unicode string specified by String as a hexadecimal number.
1503 The format of the input Unicode string String is
1505 [spaces][zeros][x][hexadecimal digits].
1507 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
1508 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix.
1509 If "x" appears in the input string, it must be prefixed with at least one 0.
1510 The function will ignore the pad space, which includes spaces or tab characters,
1511 before [zeros], [x] or [hexadecimal digit]. The running zero before [x] or
1512 [hexadecimal digit] will be ignored. Then, the decoding starts after [x] or the
1513 first valid hexadecimal digit. Then, the function stops at the first character that is
1514 a not a valid hexadecimal character or NULL, whichever one comes first.
1516 If String is NULL, then ASSERT().
1517 If String is not aligned in a 16-bit boundary, then ASSERT().
1518 If String has only pad spaces, then zero is returned.
1519 If String has no leading pad spaces, leading zeros or valid hexadecimal digits,
1520 then zero is returned.
1521 If the number represented by String overflows according to the range defined by
1522 UINT64, then MAX_UINT64 is returned.
1524 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
1525 PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator,
1528 @param String The pointer to a Null-terminated Unicode string.
1530 @retval Value translated from String.
1536 IN CONST CHAR16
*String
1540 Convert a Null-terminated Unicode string to IPv6 address and prefix length.
1542 This function outputs a value of type IPv6_ADDRESS and may output a value
1543 of type UINT8 by interpreting the contents of the Unicode string specified
1544 by String. The format of the input Unicode string String is as follows:
1548 X contains one to four hexadecimal digit characters in the range [0-9], [a-f] and
1549 [A-F]. X is converted to a value of type UINT16, whose low byte is stored in low
1550 memory address and high byte is stored in high memory address. P contains decimal
1551 digit characters in the range [0-9]. The running zero in the beginning of P will
1552 be ignored. /P is optional.
1554 When /P is not in the String, the function stops at the first character that is
1555 not a valid hexadecimal digit character after eight X's are converted.
1557 When /P is in the String, the function stops at the first character that is not
1558 a valid decimal digit character after P is converted.
1560 "::" can be used to compress one or more groups of X when X contains only 0.
1561 The "::" can only appear once in the String.
1563 If String is NULL, then ASSERT().
1565 If Address is NULL, then ASSERT().
1567 If String is not aligned in a 16-bit boundary, then ASSERT().
1569 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
1570 PcdMaximumUnicodeStringLength Unicode characters, not including the
1571 Null-terminator, then ASSERT().
1573 If EndPointer is not NULL and Address is translated from String, a pointer
1574 to the character that stopped the scan is stored at the location pointed to
1577 @param String Pointer to a Null-terminated Unicode string.
1578 @param EndPointer Pointer to character that stops scan.
1579 @param Address Pointer to the converted IPv6 address.
1580 @param PrefixLength Pointer to the converted IPv6 address prefix
1581 length. MAX_UINT8 is returned when /P is
1584 @retval RETURN_SUCCESS Address is translated from String.
1585 @retval RETURN_INVALID_PARAMETER If String is NULL.
1587 @retval RETURN_UNSUPPORTED If X contains more than four hexadecimal
1589 If String contains "::" and number of X
1591 If P starts with character that is not a
1592 valid decimal digit character.
1593 If the decimal number converted from P
1600 IN CONST CHAR16
*String
,
1601 OUT CHAR16
**EndPointer
, OPTIONAL
1602 OUT IPv6_ADDRESS
*Address
,
1603 OUT UINT8
*PrefixLength OPTIONAL
1607 Convert a Null-terminated Unicode string to IPv4 address and prefix length.
1609 This function outputs a value of type IPv4_ADDRESS and may output a value
1610 of type UINT8 by interpreting the contents of the Unicode string specified
1611 by String. The format of the input Unicode string String is as follows:
1615 D and P are decimal digit characters in the range [0-9]. The running zero in
1616 the beginning of D and P will be ignored. /P is optional.
1618 When /P is not in the String, the function stops at the first character that is
1619 not a valid decimal digit character after four D's are converted.
1621 When /P is in the String, the function stops at the first character that is not
1622 a valid decimal digit character after P is converted.
1624 If String is NULL, then ASSERT().
1626 If Address is NULL, then ASSERT().
1628 If String is not aligned in a 16-bit boundary, then ASSERT().
1630 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
1631 PcdMaximumUnicodeStringLength Unicode characters, not including the
1632 Null-terminator, then ASSERT().
1634 If EndPointer is not NULL and Address is translated from String, a pointer
1635 to the character that stopped the scan is stored at the location pointed to
1638 @param String Pointer to a Null-terminated Unicode string.
1639 @param EndPointer Pointer to character that stops scan.
1640 @param Address Pointer to the converted IPv4 address.
1641 @param PrefixLength Pointer to the converted IPv4 address prefix
1642 length. MAX_UINT8 is returned when /P is
1645 @retval RETURN_SUCCESS Address is translated from String.
1646 @retval RETURN_INVALID_PARAMETER If String is NULL.
1648 @retval RETURN_UNSUPPORTED If String is not in the correct format.
1649 If any decimal number converted from D
1651 If the decimal number converted from P
1658 IN CONST CHAR16
*String
,
1659 OUT CHAR16
**EndPointer
, OPTIONAL
1660 OUT IPv4_ADDRESS
*Address
,
1661 OUT UINT8
*PrefixLength OPTIONAL
1664 #define GUID_STRING_LENGTH 36
1667 Convert a Null-terminated Unicode GUID string to a value of type
1670 This function outputs a GUID value by interpreting the contents of
1671 the Unicode string specified by String. The format of the input
1672 Unicode string String consists of 36 characters, as follows:
1674 aabbccdd-eeff-gghh-iijj-kkllmmnnoopp
1676 The pairs aa - pp are two characters in the range [0-9], [a-f] and
1677 [A-F], with each pair representing a single byte hexadecimal value.
1679 The mapping between String and the EFI_GUID structure is as follows:
1697 If String is NULL, then ASSERT().
1698 If Guid is NULL, then ASSERT().
1699 If String is not aligned in a 16-bit boundary, then ASSERT().
1701 @param String Pointer to a Null-terminated Unicode string.
1702 @param Guid Pointer to the converted GUID.
1704 @retval RETURN_SUCCESS Guid is translated from String.
1705 @retval RETURN_INVALID_PARAMETER If String is NULL.
1707 @retval RETURN_UNSUPPORTED If String is not as the above format.
1713 IN CONST CHAR16
*String
,
1718 Convert a Null-terminated Unicode hexadecimal string to a byte array.
1720 This function outputs a byte array by interpreting the contents of
1721 the Unicode string specified by String in hexadecimal format. The format of
1722 the input Unicode string String is:
1726 X is a hexadecimal digit character in the range [0-9], [a-f] and [A-F].
1727 The function decodes every two hexadecimal digit characters as one byte. The
1728 decoding stops after Length of characters and outputs Buffer containing
1731 If String is not aligned in a 16-bit boundary, then ASSERT().
1733 If String is NULL, then ASSERT().
1735 If Buffer is NULL, then ASSERT().
1737 If Length is not multiple of 2, then ASSERT().
1739 If PcdMaximumUnicodeStringLength is not zero and Length is greater than
1740 PcdMaximumUnicodeStringLength, then ASSERT().
1742 If MaxBufferSize is less than (Length / 2), then ASSERT().
1744 @param String Pointer to a Null-terminated Unicode string.
1745 @param Length The number of Unicode characters to decode.
1746 @param Buffer Pointer to the converted bytes array.
1747 @param MaxBufferSize The maximum size of Buffer.
1749 @retval RETURN_SUCCESS Buffer is translated from String.
1750 @retval RETURN_INVALID_PARAMETER If String is NULL.
1752 If Length is not multiple of 2.
1753 If PcdMaximumUnicodeStringLength is not zero,
1754 and Length is greater than
1755 PcdMaximumUnicodeStringLength.
1756 @retval RETURN_UNSUPPORTED If Length of characters from String contain
1757 a character that is not valid hexadecimal
1758 digit characters, or a Null-terminator.
1759 @retval RETURN_BUFFER_TOO_SMALL If MaxBufferSize is less than (Length / 2).
1764 IN CONST CHAR16
*String
,
1767 IN UINTN MaxBufferSize
1770 #ifndef DISABLE_NEW_DEPRECATED_INTERFACES
1773 [ATTENTION] This function is deprecated for security reason.
1775 Convert a Null-terminated Unicode string to a Null-terminated
1776 ASCII string and returns the ASCII string.
1778 This function converts the content of the Unicode string Source
1779 to the ASCII string Destination by copying the lower 8 bits of
1780 each Unicode character. It returns Destination.
1782 The caller is responsible to make sure Destination points to a buffer with size
1783 equal or greater than ((StrLen (Source) + 1) * sizeof (CHAR8)) in bytes.
1785 If any Unicode characters in Source contain non-zero value in
1786 the upper 8 bits, then ASSERT().
1788 If Destination is NULL, then ASSERT().
1789 If Source is NULL, then ASSERT().
1790 If Source is not aligned on a 16-bit boundary, then ASSERT().
1791 If Source and Destination overlap, then ASSERT().
1793 If PcdMaximumUnicodeStringLength is not zero, and Source contains
1794 more than PcdMaximumUnicodeStringLength Unicode characters not including
1795 the Null-terminator, then ASSERT().
1797 If PcdMaximumAsciiStringLength is not zero, and Source contains more
1798 than PcdMaximumAsciiStringLength Unicode characters not including the
1799 Null-terminator, then ASSERT().
1801 @param Source The pointer to a Null-terminated Unicode string.
1802 @param Destination The pointer to a Null-terminated ASCII string.
1804 @return Destination.
1809 UnicodeStrToAsciiStr (
1810 IN CONST CHAR16
*Source
,
1811 OUT CHAR8
*Destination
1817 Convert a Null-terminated Unicode string to a Null-terminated
1820 This function is similar to AsciiStrCpyS.
1822 This function converts the content of the Unicode string Source
1823 to the ASCII string Destination by copying the lower 8 bits of
1824 each Unicode character. The function terminates the ASCII string
1825 Destination by appending a Null-terminator character at the end.
1827 The caller is responsible to make sure Destination points to a buffer with size
1828 equal or greater than ((StrLen (Source) + 1) * sizeof (CHAR8)) in bytes.
1830 If any Unicode characters in Source contain non-zero value in
1831 the upper 8 bits, then ASSERT().
1833 If Source is not aligned on a 16-bit boundary, then ASSERT().
1834 If an error would be returned, then the function will also ASSERT().
1836 If an error is returned, then the Destination is unmodified.
1838 @param Source The pointer to a Null-terminated Unicode string.
1839 @param Destination The pointer to a Null-terminated ASCII string.
1840 @param DestMax The maximum number of Destination Ascii
1841 char, including terminating null char.
1843 @retval RETURN_SUCCESS String is converted.
1844 @retval RETURN_BUFFER_TOO_SMALL If DestMax is NOT greater than StrLen(Source).
1845 @retval RETURN_INVALID_PARAMETER If Destination is NULL.
1847 If PcdMaximumAsciiStringLength is not zero,
1848 and DestMax is greater than
1849 PcdMaximumAsciiStringLength.
1850 If PcdMaximumUnicodeStringLength is not zero,
1851 and DestMax is greater than
1852 PcdMaximumUnicodeStringLength.
1854 @retval RETURN_ACCESS_DENIED If Source and Destination overlap.
1859 UnicodeStrToAsciiStrS (
1860 IN CONST CHAR16
*Source
,
1861 OUT CHAR8
*Destination
,
1866 Convert not more than Length successive characters from a Null-terminated
1867 Unicode string to a Null-terminated Ascii string. If no null char is copied
1868 from Source, then Destination[Length] is always set to null.
1870 This function converts not more than Length successive characters from the
1871 Unicode string Source to the Ascii string Destination by copying the lower 8
1872 bits of each Unicode character. The function terminates the Ascii string
1873 Destination by appending a Null-terminator character at the end.
1875 The caller is responsible to make sure Destination points to a buffer with size
1876 equal or greater than ((StrLen (Source) + 1) * sizeof (CHAR8)) in bytes.
1878 If any Unicode characters in Source contain non-zero value in the upper 8
1879 bits, then ASSERT().
1880 If Source is not aligned on a 16-bit boundary, then ASSERT().
1881 If an error would be returned, then the function will also ASSERT().
1883 If an error is returned, then the Destination is unmodified.
1885 @param Source The pointer to a Null-terminated Unicode string.
1886 @param Length The maximum number of Unicode characters to
1888 @param Destination The pointer to a Null-terminated Ascii string.
1889 @param DestMax The maximum number of Destination Ascii
1890 char, including terminating null char.
1891 @param DestinationLength The number of Unicode characters converted.
1893 @retval RETURN_SUCCESS String is converted.
1894 @retval RETURN_INVALID_PARAMETER If Destination is NULL.
1896 If DestinationLength is NULL.
1897 If PcdMaximumAsciiStringLength is not zero,
1898 and Length or DestMax is greater than
1899 PcdMaximumAsciiStringLength.
1900 If PcdMaximumUnicodeStringLength is not
1901 zero, and Length or DestMax is greater than
1902 PcdMaximumUnicodeStringLength.
1904 @retval RETURN_BUFFER_TOO_SMALL If DestMax is NOT greater than
1905 MIN(StrLen(Source), Length).
1906 @retval RETURN_ACCESS_DENIED If Source and Destination overlap.
1911 UnicodeStrnToAsciiStrS (
1912 IN CONST CHAR16
*Source
,
1914 OUT CHAR8
*Destination
,
1916 OUT UINTN
*DestinationLength
1919 #ifndef DISABLE_NEW_DEPRECATED_INTERFACES
1922 [ATTENTION] This function is deprecated for security reason.
1924 Copies one Null-terminated ASCII string to another Null-terminated ASCII
1925 string and returns the new ASCII string.
1927 This function copies the contents of the ASCII string Source to the ASCII
1928 string Destination, and returns Destination. If Source and Destination
1929 overlap, then the results are undefined.
1931 If Destination is NULL, then ASSERT().
1932 If Source is NULL, then ASSERT().
1933 If Source and Destination overlap, then ASSERT().
1934 If PcdMaximumAsciiStringLength is not zero and Source contains more than
1935 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
1938 @param Destination The pointer to a Null-terminated ASCII string.
1939 @param Source The pointer to a Null-terminated ASCII string.
1947 OUT CHAR8
*Destination
,
1948 IN CONST CHAR8
*Source
1953 [ATTENTION] This function is deprecated for security reason.
1955 Copies up to a specified length one Null-terminated ASCII string to another
1956 Null-terminated ASCII string and returns the new ASCII string.
1958 This function copies the contents of the ASCII string Source to the ASCII
1959 string Destination, and returns Destination. At most, Length ASCII characters
1960 are copied from Source to Destination. If Length is 0, then Destination is
1961 returned unmodified. If Length is greater that the number of ASCII characters
1962 in Source, then Destination is padded with Null ASCII characters. If Source
1963 and Destination overlap, then the results are undefined.
1965 If Destination is NULL, then ASSERT().
1966 If Source is NULL, then ASSERT().
1967 If Source and Destination overlap, then ASSERT().
1968 If PcdMaximumAsciiStringLength is not zero, and Length is greater than
1969 PcdMaximumAsciiStringLength, then ASSERT().
1970 If PcdMaximumAsciiStringLength is not zero, and Source contains more than
1971 PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator,
1974 @param Destination The pointer to a Null-terminated ASCII string.
1975 @param Source The pointer to a Null-terminated ASCII string.
1976 @param Length The maximum number of ASCII characters to copy.
1984 OUT CHAR8
*Destination
,
1985 IN CONST CHAR8
*Source
,
1991 Returns the length of a Null-terminated ASCII string.
1993 This function returns the number of ASCII characters in the Null-terminated
1994 ASCII string specified by String.
1996 If Length > 0 and Destination is NULL, then ASSERT().
1997 If Length > 0 and Source is NULL, then ASSERT().
1998 If PcdMaximumAsciiStringLength is not zero and String contains more than
1999 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
2002 @param String The pointer to a Null-terminated ASCII string.
2004 @return The length of String.
2010 IN CONST CHAR8
*String
2015 Returns the size of a Null-terminated ASCII string in bytes, including the
2018 This function returns the size, in bytes, of the Null-terminated ASCII string
2019 specified by String.
2021 If String is NULL, then ASSERT().
2022 If PcdMaximumAsciiStringLength is not zero and String contains more than
2023 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
2026 @param String The pointer to a Null-terminated ASCII string.
2028 @return The size of String.
2034 IN CONST CHAR8
*String
2039 Compares two Null-terminated ASCII strings, and returns the difference
2040 between the first mismatched ASCII characters.
2042 This function compares the Null-terminated ASCII string FirstString to the
2043 Null-terminated ASCII string SecondString. If FirstString is identical to
2044 SecondString, then 0 is returned. Otherwise, the value returned is the first
2045 mismatched ASCII character in SecondString subtracted from the first
2046 mismatched ASCII character in FirstString.
2048 If FirstString is NULL, then ASSERT().
2049 If SecondString is NULL, then ASSERT().
2050 If PcdMaximumAsciiStringLength is not zero and FirstString contains more than
2051 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
2053 If PcdMaximumAsciiStringLength is not zero and SecondString contains more
2054 than PcdMaximumAsciiStringLength ASCII characters not including the
2055 Null-terminator, then ASSERT().
2057 @param FirstString The pointer to a Null-terminated ASCII string.
2058 @param SecondString The pointer to a Null-terminated ASCII string.
2060 @retval ==0 FirstString is identical to SecondString.
2061 @retval !=0 FirstString is not identical to SecondString.
2067 IN CONST CHAR8
*FirstString
,
2068 IN CONST CHAR8
*SecondString
2073 Performs a case insensitive comparison of two Null-terminated ASCII strings,
2074 and returns the difference between the first mismatched ASCII characters.
2076 This function performs a case insensitive comparison of the Null-terminated
2077 ASCII string FirstString to the Null-terminated ASCII string SecondString. If
2078 FirstString is identical to SecondString, then 0 is returned. Otherwise, the
2079 value returned is the first mismatched lower case ASCII character in
2080 SecondString subtracted from the first mismatched lower case ASCII character
2083 If FirstString is NULL, then ASSERT().
2084 If SecondString is NULL, then ASSERT().
2085 If PcdMaximumAsciiStringLength is not zero and FirstString contains more than
2086 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
2088 If PcdMaximumAsciiStringLength is not zero and SecondString contains more
2089 than PcdMaximumAsciiStringLength ASCII characters not including the
2090 Null-terminator, then ASSERT().
2092 @param FirstString The pointer to a Null-terminated ASCII string.
2093 @param SecondString The pointer to a Null-terminated ASCII string.
2095 @retval ==0 FirstString is identical to SecondString using case insensitive
2097 @retval !=0 FirstString is not identical to SecondString using case
2098 insensitive comparisons.
2104 IN CONST CHAR8
*FirstString
,
2105 IN CONST CHAR8
*SecondString
2110 Compares two Null-terminated ASCII strings with maximum lengths, and returns
2111 the difference between the first mismatched ASCII characters.
2113 This function compares the Null-terminated ASCII string FirstString to the
2114 Null-terminated ASCII string SecondString. At most, Length ASCII characters
2115 will be compared. If Length is 0, then 0 is returned. If FirstString is
2116 identical to SecondString, then 0 is returned. Otherwise, the value returned
2117 is the first mismatched ASCII character in SecondString subtracted from the
2118 first mismatched ASCII character in FirstString.
2120 If Length > 0 and FirstString is NULL, then ASSERT().
2121 If Length > 0 and SecondString is NULL, then ASSERT().
2122 If PcdMaximumAsciiStringLength is not zero, and Length is greater than
2123 PcdMaximumAsciiStringLength, then ASSERT().
2124 If PcdMaximumAsciiStringLength is not zero, and FirstString contains more than
2125 PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator,
2127 If PcdMaximumAsciiStringLength is not zero, and SecondString contains more than
2128 PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator,
2131 @param FirstString The pointer to a Null-terminated ASCII string.
2132 @param SecondString The pointer to a Null-terminated ASCII string.
2133 @param Length The maximum number of ASCII characters for compare.
2135 @retval ==0 FirstString is identical to SecondString.
2136 @retval !=0 FirstString is not identical to SecondString.
2142 IN CONST CHAR8
*FirstString
,
2143 IN CONST CHAR8
*SecondString
,
2148 #ifndef DISABLE_NEW_DEPRECATED_INTERFACES
2151 [ATTENTION] This function is deprecated for security reason.
2153 Concatenates one Null-terminated ASCII string to another Null-terminated
2154 ASCII string, and returns the concatenated ASCII string.
2156 This function concatenates two Null-terminated ASCII strings. The contents of
2157 Null-terminated ASCII string Source are concatenated to the end of Null-
2158 terminated ASCII string Destination. The Null-terminated concatenated ASCII
2161 If Destination is NULL, then ASSERT().
2162 If Source is NULL, then ASSERT().
2163 If PcdMaximumAsciiStringLength is not zero and Destination contains more than
2164 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
2166 If PcdMaximumAsciiStringLength is not zero and Source contains more than
2167 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
2169 If PcdMaximumAsciiStringLength is not zero and concatenating Destination and
2170 Source results in a ASCII string with more than PcdMaximumAsciiStringLength
2171 ASCII characters, then ASSERT().
2173 @param Destination The pointer to a Null-terminated ASCII string.
2174 @param Source The pointer to a Null-terminated ASCII string.
2182 IN OUT CHAR8
*Destination
,
2183 IN CONST CHAR8
*Source
2188 [ATTENTION] This function is deprecated for security reason.
2190 Concatenates up to a specified length one Null-terminated ASCII string to
2191 the end of another Null-terminated ASCII string, and returns the
2192 concatenated ASCII string.
2194 This function concatenates two Null-terminated ASCII strings. The contents
2195 of Null-terminated ASCII string Source are concatenated to the end of Null-
2196 terminated ASCII string Destination, and Destination is returned. At most,
2197 Length ASCII characters are concatenated from Source to the end of
2198 Destination, and Destination is always Null-terminated. If Length is 0, then
2199 Destination is returned unmodified. If Source and Destination overlap, then
2200 the results are undefined.
2202 If Length > 0 and Destination is NULL, then ASSERT().
2203 If Length > 0 and Source is NULL, then ASSERT().
2204 If Source and Destination overlap, then ASSERT().
2205 If PcdMaximumAsciiStringLength is not zero, and Length is greater than
2206 PcdMaximumAsciiStringLength, then ASSERT().
2207 If PcdMaximumAsciiStringLength is not zero, and Destination contains more than
2208 PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator,
2210 If PcdMaximumAsciiStringLength is not zero, and Source contains more than
2211 PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator,
2213 If PcdMaximumAsciiStringLength is not zero, and concatenating Destination and
2214 Source results in a ASCII string with more than PcdMaximumAsciiStringLength
2215 ASCII characters, not including the Null-terminator, then ASSERT().
2217 @param Destination The pointer to a Null-terminated ASCII string.
2218 @param Source The pointer to a Null-terminated ASCII string.
2219 @param Length The maximum number of ASCII characters to concatenate from
2228 IN OUT CHAR8
*Destination
,
2229 IN CONST CHAR8
*Source
,
2235 Returns the first occurrence of a Null-terminated ASCII sub-string
2236 in a Null-terminated ASCII string.
2238 This function scans the contents of the ASCII string specified by String
2239 and returns the first occurrence of SearchString. If SearchString is not
2240 found in String, then NULL is returned. If the length of SearchString is zero,
2241 then String is returned.
2243 If String is NULL, then ASSERT().
2244 If SearchString is NULL, then ASSERT().
2246 If PcdMaximumAsciiStringLength is not zero, and SearchString or
2247 String contains more than PcdMaximumAsciiStringLength Unicode characters
2248 not including the Null-terminator, then ASSERT().
2250 @param String The pointer to a Null-terminated ASCII string.
2251 @param SearchString The pointer to a Null-terminated ASCII string to search for.
2253 @retval NULL If the SearchString does not appear in String.
2254 @retval others If there is a match return the first occurrence of SearchingString.
2255 If the length of SearchString is zero,return String.
2261 IN CONST CHAR8
*String
,
2262 IN CONST CHAR8
*SearchString
2267 Convert a Null-terminated ASCII decimal string to a value of type
2270 This function returns a value of type UINTN by interpreting the contents
2271 of the ASCII string String as a decimal number. The format of the input
2272 ASCII string String is:
2274 [spaces] [decimal digits].
2276 The valid decimal digit character is in the range [0-9]. The function will
2277 ignore the pad space, which includes spaces or tab characters, before the digits.
2278 The running zero in the beginning of [decimal digits] will be ignored. Then, the
2279 function stops at the first character that is a not a valid decimal character or
2280 Null-terminator, whichever on comes first.
2282 If String has only pad spaces, then 0 is returned.
2283 If String has no pad spaces or valid decimal digits, then 0 is returned.
2284 If the number represented by String overflows according to the range defined by
2285 UINTN, then MAX_UINTN is returned.
2286 If String is NULL, then ASSERT().
2287 If PcdMaximumAsciiStringLength is not zero, and String contains more than
2288 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
2291 @param String The pointer to a Null-terminated ASCII string.
2293 @retval The value translated from String.
2298 AsciiStrDecimalToUintn (
2299 IN CONST CHAR8
*String
2304 Convert a Null-terminated ASCII decimal string to a value of type
2307 This function returns a value of type UINT64 by interpreting the contents
2308 of the ASCII string String as a decimal number. The format of the input
2309 ASCII string String is:
2311 [spaces] [decimal digits].
2313 The valid decimal digit character is in the range [0-9]. The function will
2314 ignore the pad space, which includes spaces or tab characters, before the digits.
2315 The running zero in the beginning of [decimal digits] will be ignored. Then, the
2316 function stops at the first character that is a not a valid decimal character or
2317 Null-terminator, whichever on comes first.
2319 If String has only pad spaces, then 0 is returned.
2320 If String has no pad spaces or valid decimal digits, then 0 is returned.
2321 If the number represented by String overflows according to the range defined by
2322 UINT64, then MAX_UINT64 is returned.
2323 If String is NULL, then ASSERT().
2324 If PcdMaximumAsciiStringLength is not zero, and String contains more than
2325 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
2328 @param String The pointer to a Null-terminated ASCII string.
2330 @retval Value translated from String.
2335 AsciiStrDecimalToUint64 (
2336 IN CONST CHAR8
*String
2341 Convert a Null-terminated ASCII hexadecimal string to a value of type UINTN.
2343 This function returns a value of type UINTN by interpreting the contents of
2344 the ASCII string String as a hexadecimal number. The format of the input ASCII
2347 [spaces][zeros][x][hexadecimal digits].
2349 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
2350 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix. If "x"
2351 appears in the input string, it must be prefixed with at least one 0. The function
2352 will ignore the pad space, which includes spaces or tab characters, before [zeros],
2353 [x] or [hexadecimal digits]. The running zero before [x] or [hexadecimal digits]
2354 will be ignored. Then, the decoding starts after [x] or the first valid hexadecimal
2355 digit. Then, the function stops at the first character that is a not a valid
2356 hexadecimal character or Null-terminator, whichever on comes first.
2358 If String has only pad spaces, then 0 is returned.
2359 If String has no leading pad spaces, leading zeros or valid hexadecimal digits, then
2362 If the number represented by String overflows according to the range defined by UINTN,
2363 then MAX_UINTN is returned.
2364 If String is NULL, then ASSERT().
2365 If PcdMaximumAsciiStringLength is not zero,
2366 and String contains more than PcdMaximumAsciiStringLength ASCII characters not including
2367 the Null-terminator, then ASSERT().
2369 @param String The pointer to a Null-terminated ASCII string.
2371 @retval Value translated from String.
2376 AsciiStrHexToUintn (
2377 IN CONST CHAR8
*String
2382 Convert a Null-terminated ASCII hexadecimal string to a value of type UINT64.
2384 This function returns a value of type UINT64 by interpreting the contents of
2385 the ASCII string String as a hexadecimal number. The format of the input ASCII
2388 [spaces][zeros][x][hexadecimal digits].
2390 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
2391 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix. If "x"
2392 appears in the input string, it must be prefixed with at least one 0. The function
2393 will ignore the pad space, which includes spaces or tab characters, before [zeros],
2394 [x] or [hexadecimal digits]. The running zero before [x] or [hexadecimal digits]
2395 will be ignored. Then, the decoding starts after [x] or the first valid hexadecimal
2396 digit. Then, the function stops at the first character that is a not a valid
2397 hexadecimal character or Null-terminator, whichever on comes first.
2399 If String has only pad spaces, then 0 is returned.
2400 If String has no leading pad spaces, leading zeros or valid hexadecimal digits, then
2403 If the number represented by String overflows according to the range defined by UINT64,
2404 then MAX_UINT64 is returned.
2405 If String is NULL, then ASSERT().
2406 If PcdMaximumAsciiStringLength is not zero,
2407 and String contains more than PcdMaximumAsciiStringLength ASCII characters not including
2408 the Null-terminator, then ASSERT().
2410 @param String The pointer to a Null-terminated ASCII string.
2412 @retval Value translated from String.
2417 AsciiStrHexToUint64 (
2418 IN CONST CHAR8
*String
2421 #ifndef DISABLE_NEW_DEPRECATED_INTERFACES
2424 [ATTENTION] This function is deprecated for security reason.
2426 Convert one Null-terminated ASCII string to a Null-terminated
2427 Unicode string and returns the Unicode string.
2429 This function converts the contents of the ASCII string Source to the Unicode
2430 string Destination, and returns Destination. The function terminates the
2431 Unicode string Destination by appending a Null-terminator character at the end.
2432 The caller is responsible to make sure Destination points to a buffer with size
2433 equal or greater than ((AsciiStrLen (Source) + 1) * sizeof (CHAR16)) in bytes.
2435 If Destination is NULL, then ASSERT().
2436 If Destination is not aligned on a 16-bit boundary, then ASSERT().
2437 If Source is NULL, then ASSERT().
2438 If Source and Destination overlap, then ASSERT().
2439 If PcdMaximumAsciiStringLength is not zero, and Source contains more than
2440 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
2442 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
2443 PcdMaximumUnicodeStringLength ASCII characters not including the
2444 Null-terminator, then ASSERT().
2446 @param Source The pointer to a Null-terminated ASCII string.
2447 @param Destination The pointer to a Null-terminated Unicode string.
2449 @return Destination.
2454 AsciiStrToUnicodeStr (
2455 IN CONST CHAR8
*Source
,
2456 OUT CHAR16
*Destination
2462 Convert one Null-terminated ASCII string to a Null-terminated
2465 This function is similar to StrCpyS.
2467 This function converts the contents of the ASCII string Source to the Unicode
2468 string Destination. The function terminates the Unicode string Destination by
2469 appending a Null-terminator character at the end.
2471 The caller is responsible to make sure Destination points to a buffer with size
2472 equal or greater than ((AsciiStrLen (Source) + 1) * sizeof (CHAR16)) in bytes.
2474 If Destination is not aligned on a 16-bit boundary, then ASSERT().
2475 If an error would be returned, then the function will also ASSERT().
2477 If an error is returned, then the Destination is unmodified.
2479 @param Source The pointer to a Null-terminated ASCII string.
2480 @param Destination The pointer to a Null-terminated Unicode string.
2481 @param DestMax The maximum number of Destination Unicode
2482 char, including terminating null char.
2484 @retval RETURN_SUCCESS String is converted.
2485 @retval RETURN_BUFFER_TOO_SMALL If DestMax is NOT greater than StrLen(Source).
2486 @retval RETURN_INVALID_PARAMETER If Destination is NULL.
2488 If PcdMaximumUnicodeStringLength is not zero,
2489 and DestMax is greater than
2490 PcdMaximumUnicodeStringLength.
2491 If PcdMaximumAsciiStringLength is not zero,
2492 and DestMax is greater than
2493 PcdMaximumAsciiStringLength.
2495 @retval RETURN_ACCESS_DENIED If Source and Destination overlap.
2500 AsciiStrToUnicodeStrS (
2501 IN CONST CHAR8
*Source
,
2502 OUT CHAR16
*Destination
,
2507 Convert not more than Length successive characters from a Null-terminated
2508 Ascii string to a Null-terminated Unicode string. If no null char is copied
2509 from Source, then Destination[Length] is always set to null.
2511 This function converts not more than Length successive characters from the
2512 Ascii string Source to the Unicode string Destination. The function
2513 terminates the Unicode string Destination by appending a Null-terminator
2514 character at the end.
2516 The caller is responsible to make sure Destination points to a buffer with
2517 size not smaller than
2518 ((MIN(AsciiStrLen(Source), Length) + 1) * sizeof (CHAR8)) in bytes.
2520 If Destination is not aligned on a 16-bit boundary, then ASSERT().
2521 If an error would be returned, then the function will also ASSERT().
2523 If an error is returned, then Destination and DestinationLength are
2526 @param Source The pointer to a Null-terminated Ascii string.
2527 @param Length The maximum number of Ascii characters to convert.
2528 @param Destination The pointer to a Null-terminated Unicode string.
2529 @param DestMax The maximum number of Destination Unicode char,
2530 including terminating null char.
2531 @param DestinationLength The number of Ascii characters converted.
2533 @retval RETURN_SUCCESS String is converted.
2534 @retval RETURN_INVALID_PARAMETER If Destination is NULL.
2536 If DestinationLength is NULL.
2537 If PcdMaximumUnicodeStringLength is not
2538 zero, and Length or DestMax is greater than
2539 PcdMaximumUnicodeStringLength.
2540 If PcdMaximumAsciiStringLength is not zero,
2541 and Length or DestMax is greater than
2542 PcdMaximumAsciiStringLength.
2544 @retval RETURN_BUFFER_TOO_SMALL If DestMax is NOT greater than
2545 MIN(AsciiStrLen(Source), Length).
2546 @retval RETURN_ACCESS_DENIED If Source and Destination overlap.
2551 AsciiStrnToUnicodeStrS (
2552 IN CONST CHAR8
*Source
,
2554 OUT CHAR16
*Destination
,
2556 OUT UINTN
*DestinationLength
2560 Converts an 8-bit value to an 8-bit BCD value.
2562 Converts the 8-bit value specified by Value to BCD. The BCD value is
2565 If Value >= 100, then ASSERT().
2567 @param Value The 8-bit value to convert to BCD. Range 0..99.
2569 @return The BCD value.
2580 Converts an 8-bit BCD value to an 8-bit value.
2582 Converts the 8-bit BCD value specified by Value to an 8-bit value. The 8-bit
2585 If Value >= 0xA0, then ASSERT().
2586 If (Value & 0x0F) >= 0x0A, then ASSERT().
2588 @param Value The 8-bit BCD value to convert to an 8-bit value.
2590 @return The 8-bit value is returned.
2600 // File Path Manipulation Functions
2604 Removes the last directory or file entry in a path.
2606 @param[in, out] Path The pointer to the path to modify.
2608 @retval FALSE Nothing was found to remove.
2609 @retval TRUE A directory or file was removed.
2618 Function to clean up paths.
2619 - Single periods in the path are removed.
2620 - Double periods in the path are removed along with a single parent directory.
2621 - Forward slashes L'/' are converted to backward slashes L'\'.
2623 This will be done inline and the existing buffer may be larger than required
2626 @param[in] Path The pointer to the string containing the path.
2628 @return Returns Path, otherwise returns NULL to indicate that an error has occurred.
2632 PathCleanUpDirectories(
2637 // Linked List Functions and Macros
2641 Initializes the head node of a doubly linked list that is declared as a
2642 global variable in a module.
2644 Initializes the forward and backward links of a new linked list. After
2645 initializing a linked list with this macro, the other linked list functions
2646 may be used to add and remove nodes from the linked list. This macro results
2647 in smaller executables by initializing the linked list in the data section,
2648 instead if calling the InitializeListHead() function to perform the
2649 equivalent operation.
2651 @param ListHead The head note of a list to initialize.
2654 #define INITIALIZE_LIST_HEAD_VARIABLE(ListHead) {&(ListHead), &(ListHead)}
2658 Initializes the head node of a doubly linked list, and returns the pointer to
2659 the head node of the doubly linked list.
2661 Initializes the forward and backward links of a new linked list. After
2662 initializing a linked list with this function, the other linked list
2663 functions may be used to add and remove nodes from the linked list. It is up
2664 to the caller of this function to allocate the memory for ListHead.
2666 If ListHead is NULL, then ASSERT().
2668 @param ListHead A pointer to the head node of a new doubly linked list.
2675 InitializeListHead (
2676 IN OUT LIST_ENTRY
*ListHead
2681 Adds a node to the beginning of a doubly linked list, and returns the pointer
2682 to the head node of the doubly linked list.
2684 Adds the node Entry at the beginning of the doubly linked list denoted by
2685 ListHead, and returns ListHead.
2687 If ListHead is NULL, then ASSERT().
2688 If Entry is NULL, then ASSERT().
2689 If ListHead was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or
2690 InitializeListHead(), then ASSERT().
2691 If PcdMaximumLinkedListLength is not zero, and prior to insertion the number
2692 of nodes in ListHead, including the ListHead node, is greater than or
2693 equal to PcdMaximumLinkedListLength, then ASSERT().
2695 @param ListHead A pointer to the head node of a doubly linked list.
2696 @param Entry A pointer to a node that is to be inserted at the beginning
2697 of a doubly linked list.
2705 IN OUT LIST_ENTRY
*ListHead
,
2706 IN OUT LIST_ENTRY
*Entry
2711 Adds a node to the end of a doubly linked list, and returns the pointer to
2712 the head node of the doubly linked list.
2714 Adds the node Entry to the end of the doubly linked list denoted by ListHead,
2715 and returns ListHead.
2717 If ListHead is NULL, then ASSERT().
2718 If Entry is NULL, then ASSERT().
2719 If ListHead was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or
2720 InitializeListHead(), then ASSERT().
2721 If PcdMaximumLinkedListLength is not zero, and prior to insertion the number
2722 of nodes in ListHead, including the ListHead node, is greater than or
2723 equal to PcdMaximumLinkedListLength, then ASSERT().
2725 @param ListHead A pointer to the head node of a doubly linked list.
2726 @param Entry A pointer to a node that is to be added at the end of the
2735 IN OUT LIST_ENTRY
*ListHead
,
2736 IN OUT LIST_ENTRY
*Entry
2741 Retrieves the first node of a doubly linked list.
2743 Returns the first node of a doubly linked list. List must have been
2744 initialized with INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead().
2745 If List is empty, then List is returned.
2747 If List is NULL, then ASSERT().
2748 If List was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or
2749 InitializeListHead(), then ASSERT().
2750 If PcdMaximumLinkedListLength is not zero, and the number of nodes
2751 in List, including the List node, is greater than or equal to
2752 PcdMaximumLinkedListLength, then ASSERT().
2754 @param List A pointer to the head node of a doubly linked list.
2756 @return The first node of a doubly linked list.
2757 @retval List The list is empty.
2763 IN CONST LIST_ENTRY
*List
2768 Retrieves the next node of a doubly linked list.
2770 Returns the node of a doubly linked list that follows Node.
2771 List must have been initialized with INTIALIZE_LIST_HEAD_VARIABLE()
2772 or InitializeListHead(). If List is empty, then List is returned.
2774 If List is NULL, then ASSERT().
2775 If Node is NULL, then ASSERT().
2776 If List was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or
2777 InitializeListHead(), then ASSERT().
2778 If PcdMaximumLinkedListLength is not zero, and List contains more than
2779 PcdMaximumLinkedListLength nodes, then ASSERT().
2780 If PcdVerifyNodeInList is TRUE and Node is not a node in List, then ASSERT().
2782 @param List A pointer to the head node of a doubly linked list.
2783 @param Node A pointer to a node in the doubly linked list.
2785 @return The pointer to the next node if one exists. Otherwise List is returned.
2791 IN CONST LIST_ENTRY
*List
,
2792 IN CONST LIST_ENTRY
*Node
2797 Retrieves the previous node of a doubly linked list.
2799 Returns the node of a doubly linked list that precedes Node.
2800 List must have been initialized with INTIALIZE_LIST_HEAD_VARIABLE()
2801 or InitializeListHead(). If List is empty, then List is returned.
2803 If List is NULL, then ASSERT().
2804 If Node is NULL, then ASSERT().
2805 If List was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or
2806 InitializeListHead(), then ASSERT().
2807 If PcdMaximumLinkedListLength is not zero, and List contains more than
2808 PcdMaximumLinkedListLength nodes, then ASSERT().
2809 If PcdVerifyNodeInList is TRUE and Node is not a node in List, then ASSERT().
2811 @param List A pointer to the head node of a doubly linked list.
2812 @param Node A pointer to a node in the doubly linked list.
2814 @return The pointer to the previous node if one exists. Otherwise List is returned.
2820 IN CONST LIST_ENTRY
*List
,
2821 IN CONST LIST_ENTRY
*Node
2826 Checks to see if a doubly linked list is empty or not.
2828 Checks to see if the doubly linked list is empty. If the linked list contains
2829 zero nodes, this function returns TRUE. Otherwise, it returns FALSE.
2831 If ListHead is NULL, then ASSERT().
2832 If ListHead was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or
2833 InitializeListHead(), then ASSERT().
2834 If PcdMaximumLinkedListLength is not zero, and the number of nodes
2835 in List, including the List node, is greater than or equal to
2836 PcdMaximumLinkedListLength, then ASSERT().
2838 @param ListHead A pointer to the head node of a doubly linked list.
2840 @retval TRUE The linked list is empty.
2841 @retval FALSE The linked list is not empty.
2847 IN CONST LIST_ENTRY
*ListHead
2852 Determines if a node in a doubly linked list is the head node of a the same
2853 doubly linked list. This function is typically used to terminate a loop that
2854 traverses all the nodes in a doubly linked list starting with the head node.
2856 Returns TRUE if Node is equal to List. Returns FALSE if Node is one of the
2857 nodes in the doubly linked list specified by List. List must have been
2858 initialized with INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead().
2860 If List is NULL, then ASSERT().
2861 If Node is NULL, then ASSERT().
2862 If List was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead(),
2864 If PcdMaximumLinkedListLength is not zero, and the number of nodes
2865 in List, including the List node, is greater than or equal to
2866 PcdMaximumLinkedListLength, then ASSERT().
2867 If PcdVerifyNodeInList is TRUE and Node is not a node in List the and Node is not equal
2868 to List, then ASSERT().
2870 @param List A pointer to the head node of a doubly linked list.
2871 @param Node A pointer to a node in the doubly linked list.
2873 @retval TRUE Node is the head of the doubly-linked list pointed by List.
2874 @retval FALSE Node is not the head of the doubly-linked list pointed by List.
2880 IN CONST LIST_ENTRY
*List
,
2881 IN CONST LIST_ENTRY
*Node
2886 Determines if a node the last node in a doubly linked list.
2888 Returns TRUE if Node is the last node in the doubly linked list specified by
2889 List. Otherwise, FALSE is returned. List must have been initialized with
2890 INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead().
2892 If List is NULL, then ASSERT().
2893 If Node is NULL, then ASSERT().
2894 If List was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or
2895 InitializeListHead(), then ASSERT().
2896 If PcdMaximumLinkedListLength is not zero, and the number of nodes
2897 in List, including the List node, is greater than or equal to
2898 PcdMaximumLinkedListLength, then ASSERT().
2899 If PcdVerifyNodeInList is TRUE and Node is not a node in List, then ASSERT().
2901 @param List A pointer to the head node of a doubly linked list.
2902 @param Node A pointer to a node in the doubly linked list.
2904 @retval TRUE Node is the last node in the linked list.
2905 @retval FALSE Node is not the last node in the linked list.
2911 IN CONST LIST_ENTRY
*List
,
2912 IN CONST LIST_ENTRY
*Node
2917 Swaps the location of two nodes in a doubly linked list, and returns the
2918 first node after the swap.
2920 If FirstEntry is identical to SecondEntry, then SecondEntry is returned.
2921 Otherwise, the location of the FirstEntry node is swapped with the location
2922 of the SecondEntry node in a doubly linked list. SecondEntry must be in the
2923 same double linked list as FirstEntry and that double linked list must have
2924 been initialized with INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead().
2925 SecondEntry is returned after the nodes are swapped.
2927 If FirstEntry is NULL, then ASSERT().
2928 If SecondEntry is NULL, then ASSERT().
2929 If PcdVerifyNodeInList is TRUE and SecondEntry and FirstEntry are not in the
2930 same linked list, then ASSERT().
2931 If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
2932 linked list containing the FirstEntry and SecondEntry nodes, including
2933 the FirstEntry and SecondEntry nodes, is greater than or equal to
2934 PcdMaximumLinkedListLength, then ASSERT().
2936 @param FirstEntry A pointer to a node in a linked list.
2937 @param SecondEntry A pointer to another node in the same linked list.
2939 @return SecondEntry.
2945 IN OUT LIST_ENTRY
*FirstEntry
,
2946 IN OUT LIST_ENTRY
*SecondEntry
2951 Removes a node from a doubly linked list, and returns the node that follows
2954 Removes the node Entry from a doubly linked list. It is up to the caller of
2955 this function to release the memory used by this node if that is required. On
2956 exit, the node following Entry in the doubly linked list is returned. If
2957 Entry is the only node in the linked list, then the head node of the linked
2960 If Entry is NULL, then ASSERT().
2961 If Entry is the head node of an empty list, then ASSERT().
2962 If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
2963 linked list containing Entry, including the Entry node, is greater than
2964 or equal to PcdMaximumLinkedListLength, then ASSERT().
2966 @param Entry A pointer to a node in a linked list.
2974 IN CONST LIST_ENTRY
*Entry
2982 Shifts a 64-bit integer left between 0 and 63 bits. The low bits are filled
2983 with zeros. The shifted value is returned.
2985 This function shifts the 64-bit value Operand to the left by Count bits. The
2986 low Count bits are set to zero. The shifted value is returned.
2988 If Count is greater than 63, then ASSERT().
2990 @param Operand The 64-bit operand to shift left.
2991 @param Count The number of bits to shift left.
2993 @return Operand << Count.
3005 Shifts a 64-bit integer right between 0 and 63 bits. This high bits are
3006 filled with zeros. The shifted value is returned.
3008 This function shifts the 64-bit value Operand to the right by Count bits. The
3009 high Count bits are set to zero. The shifted value is returned.
3011 If Count is greater than 63, then ASSERT().
3013 @param Operand The 64-bit operand to shift right.
3014 @param Count The number of bits to shift right.
3016 @return Operand >> Count
3028 Shifts a 64-bit integer right between 0 and 63 bits. The high bits are filled
3029 with original integer's bit 63. The shifted value is returned.
3031 This function shifts the 64-bit value Operand to the right by Count bits. The
3032 high Count bits are set to bit 63 of Operand. The shifted value is returned.
3034 If Count is greater than 63, then ASSERT().
3036 @param Operand The 64-bit operand to shift right.
3037 @param Count The number of bits to shift right.
3039 @return Operand >> Count
3051 Rotates a 32-bit integer left between 0 and 31 bits, filling the low bits
3052 with the high bits that were rotated.
3054 This function rotates the 32-bit value Operand to the left by Count bits. The
3055 low Count bits are fill with the high Count bits of Operand. The rotated
3058 If Count is greater than 31, then ASSERT().
3060 @param Operand The 32-bit operand to rotate left.
3061 @param Count The number of bits to rotate left.
3063 @return Operand << Count
3075 Rotates a 32-bit integer right between 0 and 31 bits, filling the high bits
3076 with the low bits that were rotated.
3078 This function rotates the 32-bit value Operand to the right by Count bits.
3079 The high Count bits are fill with the low Count bits of Operand. The rotated
3082 If Count is greater than 31, then ASSERT().
3084 @param Operand The 32-bit operand to rotate right.
3085 @param Count The number of bits to rotate right.
3087 @return Operand >> Count
3099 Rotates a 64-bit integer left between 0 and 63 bits, filling the low bits
3100 with the high bits that were rotated.
3102 This function rotates the 64-bit value Operand to the left by Count bits. The
3103 low Count bits are fill with the high Count bits of Operand. The rotated
3106 If Count is greater than 63, then ASSERT().
3108 @param Operand The 64-bit operand to rotate left.
3109 @param Count The number of bits to rotate left.
3111 @return Operand << Count
3123 Rotates a 64-bit integer right between 0 and 63 bits, filling the high bits
3124 with the high low bits that were rotated.
3126 This function rotates the 64-bit value Operand to the right by Count bits.
3127 The high Count bits are fill with the low Count bits of Operand. The rotated
3130 If Count is greater than 63, then ASSERT().
3132 @param Operand The 64-bit operand to rotate right.
3133 @param Count The number of bits to rotate right.
3135 @return Operand >> Count
3147 Returns the bit position of the lowest bit set in a 32-bit value.
3149 This function computes the bit position of the lowest bit set in the 32-bit
3150 value specified by Operand. If Operand is zero, then -1 is returned.
3151 Otherwise, a value between 0 and 31 is returned.
3153 @param Operand The 32-bit operand to evaluate.
3155 @retval 0..31 The lowest bit set in Operand was found.
3156 @retval -1 Operand is zero.
3167 Returns the bit position of the lowest bit set in a 64-bit value.
3169 This function computes the bit position of the lowest bit set in the 64-bit
3170 value specified by Operand. If Operand is zero, then -1 is returned.
3171 Otherwise, a value between 0 and 63 is returned.
3173 @param Operand The 64-bit operand to evaluate.
3175 @retval 0..63 The lowest bit set in Operand was found.
3176 @retval -1 Operand is zero.
3188 Returns the bit position of the highest bit set in a 32-bit value. Equivalent
3191 This function computes the bit position of the highest bit set in the 32-bit
3192 value specified by Operand. If Operand is zero, then -1 is returned.
3193 Otherwise, a value between 0 and 31 is returned.
3195 @param Operand The 32-bit operand to evaluate.
3197 @retval 0..31 Position of the highest bit set in Operand if found.
3198 @retval -1 Operand is zero.
3209 Returns the bit position of the highest bit set in a 64-bit value. Equivalent
3212 This function computes the bit position of the highest bit set in the 64-bit
3213 value specified by Operand. If Operand is zero, then -1 is returned.
3214 Otherwise, a value between 0 and 63 is returned.
3216 @param Operand The 64-bit operand to evaluate.
3218 @retval 0..63 Position of the highest bit set in Operand if found.
3219 @retval -1 Operand is zero.
3230 Returns the value of the highest bit set in a 32-bit value. Equivalent to
3233 This function computes the value of the highest bit set in the 32-bit value
3234 specified by Operand. If Operand is zero, then zero is returned.
3236 @param Operand The 32-bit operand to evaluate.
3238 @return 1 << HighBitSet32(Operand)
3239 @retval 0 Operand is zero.
3250 Returns the value of the highest bit set in a 64-bit value. Equivalent to
3253 This function computes the value of the highest bit set in the 64-bit value
3254 specified by Operand. If Operand is zero, then zero is returned.
3256 @param Operand The 64-bit operand to evaluate.
3258 @return 1 << HighBitSet64(Operand)
3259 @retval 0 Operand is zero.
3270 Switches the endianness of a 16-bit integer.
3272 This function swaps the bytes in a 16-bit unsigned value to switch the value
3273 from little endian to big endian or vice versa. The byte swapped value is
3276 @param Value A 16-bit unsigned value.
3278 @return The byte swapped Value.
3289 Switches the endianness of a 32-bit integer.
3291 This function swaps the bytes in a 32-bit unsigned value to switch the value
3292 from little endian to big endian or vice versa. The byte swapped value is
3295 @param Value A 32-bit unsigned value.
3297 @return The byte swapped Value.
3308 Switches the endianness of a 64-bit integer.
3310 This function swaps the bytes in a 64-bit unsigned value to switch the value
3311 from little endian to big endian or vice versa. The byte swapped value is
3314 @param Value A 64-bit unsigned value.
3316 @return The byte swapped Value.
3327 Multiples a 64-bit unsigned integer by a 32-bit unsigned integer and
3328 generates a 64-bit unsigned result.
3330 This function multiples the 64-bit unsigned value Multiplicand by the 32-bit
3331 unsigned value Multiplier and generates a 64-bit unsigned result. This 64-
3332 bit unsigned result is returned.
3334 @param Multiplicand A 64-bit unsigned value.
3335 @param Multiplier A 32-bit unsigned value.
3337 @return Multiplicand * Multiplier
3343 IN UINT64 Multiplicand
,
3344 IN UINT32 Multiplier
3349 Multiples a 64-bit unsigned integer by a 64-bit unsigned integer and
3350 generates a 64-bit unsigned result.
3352 This function multiples the 64-bit unsigned value Multiplicand by the 64-bit
3353 unsigned value Multiplier and generates a 64-bit unsigned result. This 64-
3354 bit unsigned result is returned.
3356 @param Multiplicand A 64-bit unsigned value.
3357 @param Multiplier A 64-bit unsigned value.
3359 @return Multiplicand * Multiplier.
3365 IN UINT64 Multiplicand
,
3366 IN UINT64 Multiplier
3371 Multiples a 64-bit signed integer by a 64-bit signed integer and generates a
3372 64-bit signed result.
3374 This function multiples the 64-bit signed value Multiplicand by the 64-bit
3375 signed value Multiplier and generates a 64-bit signed result. This 64-bit
3376 signed result is returned.
3378 @param Multiplicand A 64-bit signed value.
3379 @param Multiplier A 64-bit signed value.
3381 @return Multiplicand * Multiplier
3387 IN INT64 Multiplicand
,
3393 Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates
3394 a 64-bit unsigned result.
3396 This function divides the 64-bit unsigned value Dividend by the 32-bit
3397 unsigned value Divisor and generates a 64-bit unsigned quotient. This
3398 function returns the 64-bit unsigned quotient.
3400 If Divisor is 0, then ASSERT().
3402 @param Dividend A 64-bit unsigned value.
3403 @param Divisor A 32-bit unsigned value.
3405 @return Dividend / Divisor.
3417 Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates
3418 a 32-bit unsigned remainder.
3420 This function divides the 64-bit unsigned value Dividend by the 32-bit
3421 unsigned value Divisor and generates a 32-bit remainder. This function
3422 returns the 32-bit unsigned remainder.
3424 If Divisor is 0, then ASSERT().
3426 @param Dividend A 64-bit unsigned value.
3427 @param Divisor A 32-bit unsigned value.
3429 @return Dividend % Divisor.
3441 Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates
3442 a 64-bit unsigned result and an optional 32-bit unsigned remainder.
3444 This function divides the 64-bit unsigned value Dividend by the 32-bit
3445 unsigned value Divisor and generates a 64-bit unsigned quotient. If Remainder
3446 is not NULL, then the 32-bit unsigned remainder is returned in Remainder.
3447 This function returns the 64-bit unsigned quotient.
3449 If Divisor is 0, then ASSERT().
3451 @param Dividend A 64-bit unsigned value.
3452 @param Divisor A 32-bit unsigned value.
3453 @param Remainder A pointer to a 32-bit unsigned value. This parameter is
3454 optional and may be NULL.
3456 @return Dividend / Divisor.
3461 DivU64x32Remainder (
3464 OUT UINT32
*Remainder OPTIONAL
3469 Divides a 64-bit unsigned integer by a 64-bit unsigned integer and generates
3470 a 64-bit unsigned result and an optional 64-bit unsigned remainder.
3472 This function divides the 64-bit unsigned value Dividend by the 64-bit
3473 unsigned value Divisor and generates a 64-bit unsigned quotient. If Remainder
3474 is not NULL, then the 64-bit unsigned remainder is returned in Remainder.
3475 This function returns the 64-bit unsigned quotient.
3477 If Divisor is 0, then ASSERT().
3479 @param Dividend A 64-bit unsigned value.
3480 @param Divisor A 64-bit unsigned value.
3481 @param Remainder A pointer to a 64-bit unsigned value. This parameter is
3482 optional and may be NULL.
3484 @return Dividend / Divisor.
3489 DivU64x64Remainder (
3492 OUT UINT64
*Remainder OPTIONAL
3497 Divides a 64-bit signed integer by a 64-bit signed integer and generates a
3498 64-bit signed result and a optional 64-bit signed remainder.
3500 This function divides the 64-bit signed value Dividend by the 64-bit signed
3501 value Divisor and generates a 64-bit signed quotient. If Remainder is not
3502 NULL, then the 64-bit signed remainder is returned in Remainder. This
3503 function returns the 64-bit signed quotient.
3505 It is the caller's responsibility to not call this function with a Divisor of 0.
3506 If Divisor is 0, then the quotient and remainder should be assumed to be
3507 the largest negative integer.
3509 If Divisor is 0, then ASSERT().
3511 @param Dividend A 64-bit signed value.
3512 @param Divisor A 64-bit signed value.
3513 @param Remainder A pointer to a 64-bit signed value. This parameter is
3514 optional and may be NULL.
3516 @return Dividend / Divisor.
3521 DivS64x64Remainder (
3524 OUT INT64
*Remainder OPTIONAL
3529 Reads a 16-bit value from memory that may be unaligned.
3531 This function returns the 16-bit value pointed to by Buffer. The function
3532 guarantees that the read operation does not produce an alignment fault.
3534 If the Buffer is NULL, then ASSERT().
3536 @param Buffer The pointer to a 16-bit value that may be unaligned.
3538 @return The 16-bit value read from Buffer.
3544 IN CONST UINT16
*Buffer
3549 Writes a 16-bit value to memory that may be unaligned.
3551 This function writes the 16-bit value specified by Value to Buffer. Value is
3552 returned. The function guarantees that the write operation does not produce
3555 If the Buffer is NULL, then ASSERT().
3557 @param Buffer The pointer to a 16-bit value that may be unaligned.
3558 @param Value 16-bit value to write to Buffer.
3560 @return The 16-bit value to write to Buffer.
3572 Reads a 24-bit value from memory that may be unaligned.
3574 This function returns the 24-bit value pointed to by Buffer. The function
3575 guarantees that the read operation does not produce an alignment fault.
3577 If the Buffer is NULL, then ASSERT().
3579 @param Buffer The pointer to a 24-bit value that may be unaligned.
3581 @return The 24-bit value read from Buffer.
3587 IN CONST UINT32
*Buffer
3592 Writes a 24-bit value to memory that may be unaligned.
3594 This function writes the 24-bit value specified by Value to Buffer. Value is
3595 returned. The function guarantees that the write operation does not produce
3598 If the Buffer is NULL, then ASSERT().
3600 @param Buffer The pointer to a 24-bit value that may be unaligned.
3601 @param Value 24-bit value to write to Buffer.
3603 @return The 24-bit value to write to Buffer.
3615 Reads a 32-bit value from memory that may be unaligned.
3617 This function returns the 32-bit value pointed to by Buffer. The function
3618 guarantees that the read operation does not produce an alignment fault.
3620 If the Buffer is NULL, then ASSERT().
3622 @param Buffer The pointer to a 32-bit value that may be unaligned.
3624 @return The 32-bit value read from Buffer.
3630 IN CONST UINT32
*Buffer
3635 Writes a 32-bit value to memory that may be unaligned.
3637 This function writes the 32-bit value specified by Value to Buffer. Value is
3638 returned. The function guarantees that the write operation does not produce
3641 If the Buffer is NULL, then ASSERT().
3643 @param Buffer The pointer to a 32-bit value that may be unaligned.
3644 @param Value 32-bit value to write to Buffer.
3646 @return The 32-bit value to write to Buffer.
3658 Reads a 64-bit value from memory that may be unaligned.
3660 This function returns the 64-bit value pointed to by Buffer. The function
3661 guarantees that the read operation does not produce an alignment fault.
3663 If the Buffer is NULL, then ASSERT().
3665 @param Buffer The pointer to a 64-bit value that may be unaligned.
3667 @return The 64-bit value read from Buffer.
3673 IN CONST UINT64
*Buffer
3678 Writes a 64-bit value to memory that may be unaligned.
3680 This function writes the 64-bit value specified by Value to Buffer. Value is
3681 returned. The function guarantees that the write operation does not produce
3684 If the Buffer is NULL, then ASSERT().
3686 @param Buffer The pointer to a 64-bit value that may be unaligned.
3687 @param Value 64-bit value to write to Buffer.
3689 @return The 64-bit value to write to Buffer.
3701 // Bit Field Functions
3705 Returns a bit field from an 8-bit value.
3707 Returns the bitfield specified by the StartBit and the EndBit from Operand.
3709 If 8-bit operations are not supported, then ASSERT().
3710 If StartBit is greater than 7, then ASSERT().
3711 If EndBit is greater than 7, then ASSERT().
3712 If EndBit is less than StartBit, then ASSERT().
3714 @param Operand Operand on which to perform the bitfield operation.
3715 @param StartBit The ordinal of the least significant bit in the bit field.
3717 @param EndBit The ordinal of the most significant bit in the bit field.
3720 @return The bit field read.
3733 Writes a bit field to an 8-bit value, and returns the result.
3735 Writes Value to the bit field specified by the StartBit and the EndBit in
3736 Operand. All other bits in Operand are preserved. The new 8-bit value is
3739 If 8-bit operations are not supported, then ASSERT().
3740 If StartBit is greater than 7, then ASSERT().
3741 If EndBit is greater than 7, then ASSERT().
3742 If EndBit is less than StartBit, then ASSERT().
3743 If Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
3745 @param Operand Operand on which to perform the bitfield operation.
3746 @param StartBit The ordinal of the least significant bit in the bit field.
3748 @param EndBit The ordinal of the most significant bit in the bit field.
3750 @param Value New value of the bit field.
3752 @return The new 8-bit value.
3766 Reads a bit field from an 8-bit value, performs a bitwise OR, and returns the
3769 Performs a bitwise OR between the bit field specified by StartBit
3770 and EndBit in Operand and the value specified by OrData. All other bits in
3771 Operand are preserved. The new 8-bit value is returned.
3773 If 8-bit operations are not supported, then ASSERT().
3774 If StartBit is greater than 7, then ASSERT().
3775 If EndBit is greater than 7, then ASSERT().
3776 If EndBit is less than StartBit, then ASSERT().
3777 If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
3779 @param Operand Operand on which to perform the bitfield operation.
3780 @param StartBit The ordinal of the least significant bit in the bit field.
3782 @param EndBit The ordinal of the most significant bit in the bit field.
3784 @param OrData The value to OR with the read value from the value
3786 @return The new 8-bit value.
3800 Reads a bit field from an 8-bit value, performs a bitwise AND, and returns
3803 Performs a bitwise AND between the bit field specified by StartBit and EndBit
3804 in Operand and the value specified by AndData. All other bits in Operand are
3805 preserved. The new 8-bit value is returned.
3807 If 8-bit operations are not supported, then ASSERT().
3808 If StartBit is greater than 7, then ASSERT().
3809 If EndBit is greater than 7, then ASSERT().
3810 If EndBit is less than StartBit, then ASSERT().
3811 If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
3813 @param Operand Operand on which to perform the bitfield operation.
3814 @param StartBit The ordinal of the least significant bit in the bit field.
3816 @param EndBit The ordinal of the most significant bit in the bit field.
3818 @param AndData The value to AND with the read value from the value.
3820 @return The new 8-bit value.
3834 Reads a bit field from an 8-bit value, performs a bitwise AND followed by a
3835 bitwise OR, and returns the result.
3837 Performs a bitwise AND between the bit field specified by StartBit and EndBit
3838 in Operand and the value specified by AndData, followed by a bitwise
3839 OR with value specified by OrData. All other bits in Operand are
3840 preserved. The new 8-bit value is returned.
3842 If 8-bit operations are not supported, then ASSERT().
3843 If StartBit is greater than 7, then ASSERT().
3844 If EndBit is greater than 7, then ASSERT().
3845 If EndBit is less than StartBit, then ASSERT().
3846 If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
3847 If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
3849 @param Operand Operand on which to perform the bitfield operation.
3850 @param StartBit The ordinal of the least significant bit in the bit field.
3852 @param EndBit The ordinal of the most significant bit in the bit field.
3854 @param AndData The value to AND with the read value from the value.
3855 @param OrData The value to OR with the result of the AND operation.
3857 @return The new 8-bit value.
3862 BitFieldAndThenOr8 (
3872 Returns a bit field from a 16-bit value.
3874 Returns the bitfield specified by the StartBit and the EndBit from Operand.
3876 If 16-bit operations are not supported, then ASSERT().
3877 If StartBit is greater than 15, then ASSERT().
3878 If EndBit is greater than 15, then ASSERT().
3879 If EndBit is less than StartBit, then ASSERT().
3881 @param Operand Operand on which to perform the bitfield operation.
3882 @param StartBit The ordinal of the least significant bit in the bit field.
3884 @param EndBit The ordinal of the most significant bit in the bit field.
3887 @return The bit field read.
3900 Writes a bit field to a 16-bit value, and returns the result.
3902 Writes Value to the bit field specified by the StartBit and the EndBit in
3903 Operand. All other bits in Operand are preserved. The new 16-bit value is
3906 If 16-bit operations are not supported, then ASSERT().
3907 If StartBit is greater than 15, then ASSERT().
3908 If EndBit is greater than 15, then ASSERT().
3909 If EndBit is less than StartBit, then ASSERT().
3910 If Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
3912 @param Operand Operand on which to perform the bitfield operation.
3913 @param StartBit The ordinal of the least significant bit in the bit field.
3915 @param EndBit The ordinal of the most significant bit in the bit field.
3917 @param Value New value of the bit field.
3919 @return The new 16-bit value.
3933 Reads a bit field from a 16-bit value, performs a bitwise OR, and returns the
3936 Performs a bitwise OR between the bit field specified by StartBit
3937 and EndBit in Operand and the value specified by OrData. All other bits in
3938 Operand are preserved. The new 16-bit value is returned.
3940 If 16-bit operations are not supported, then ASSERT().
3941 If StartBit is greater than 15, then ASSERT().
3942 If EndBit is greater than 15, then ASSERT().
3943 If EndBit is less than StartBit, then ASSERT().
3944 If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
3946 @param Operand Operand on which to perform the bitfield operation.
3947 @param StartBit The ordinal of the least significant bit in the bit field.
3949 @param EndBit The ordinal of the most significant bit in the bit field.
3951 @param OrData The value to OR with the read value from the value
3953 @return The new 16-bit value.
3967 Reads a bit field from a 16-bit value, performs a bitwise AND, and returns
3970 Performs a bitwise AND between the bit field specified by StartBit and EndBit
3971 in Operand and the value specified by AndData. All other bits in Operand are
3972 preserved. The new 16-bit value is returned.
3974 If 16-bit operations are not supported, then ASSERT().
3975 If StartBit is greater than 15, then ASSERT().
3976 If EndBit is greater than 15, then ASSERT().
3977 If EndBit is less than StartBit, then ASSERT().
3978 If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
3980 @param Operand Operand on which to perform the bitfield operation.
3981 @param StartBit The ordinal of the least significant bit in the bit field.
3983 @param EndBit The ordinal of the most significant bit in the bit field.
3985 @param AndData The value to AND with the read value from the value
3987 @return The new 16-bit value.
4001 Reads a bit field from a 16-bit value, performs a bitwise AND followed by a
4002 bitwise OR, and returns the result.
4004 Performs a bitwise AND between the bit field specified by StartBit and EndBit
4005 in Operand and the value specified by AndData, followed by a bitwise
4006 OR with value specified by OrData. All other bits in Operand are
4007 preserved. The new 16-bit value is returned.
4009 If 16-bit operations are not supported, then ASSERT().
4010 If StartBit is greater than 15, then ASSERT().
4011 If EndBit is greater than 15, then ASSERT().
4012 If EndBit is less than StartBit, then ASSERT().
4013 If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4014 If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4016 @param Operand Operand on which to perform the bitfield operation.
4017 @param StartBit The ordinal of the least significant bit in the bit field.
4019 @param EndBit The ordinal of the most significant bit in the bit field.
4021 @param AndData The value to AND with the read value from the value.
4022 @param OrData The value to OR with the result of the AND operation.
4024 @return The new 16-bit value.
4029 BitFieldAndThenOr16 (
4039 Returns a bit field from a 32-bit value.
4041 Returns the bitfield specified by the StartBit and the EndBit from Operand.
4043 If 32-bit operations are not supported, then ASSERT().
4044 If StartBit is greater than 31, then ASSERT().
4045 If EndBit is greater than 31, then ASSERT().
4046 If EndBit is less than StartBit, then ASSERT().
4048 @param Operand Operand on which to perform the bitfield operation.
4049 @param StartBit The ordinal of the least significant bit in the bit field.
4051 @param EndBit The ordinal of the most significant bit in the bit field.
4054 @return The bit field read.
4067 Writes a bit field to a 32-bit value, and returns the result.
4069 Writes Value to the bit field specified by the StartBit and the EndBit in
4070 Operand. All other bits in Operand are preserved. The new 32-bit value is
4073 If 32-bit operations are not supported, then ASSERT().
4074 If StartBit is greater than 31, then ASSERT().
4075 If EndBit is greater than 31, then ASSERT().
4076 If EndBit is less than StartBit, then ASSERT().
4077 If Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4079 @param Operand Operand on which to perform the bitfield operation.
4080 @param StartBit The ordinal of the least significant bit in the bit field.
4082 @param EndBit The ordinal of the most significant bit in the bit field.
4084 @param Value New value of the bit field.
4086 @return The new 32-bit value.
4100 Reads a bit field from a 32-bit value, performs a bitwise OR, and returns the
4103 Performs a bitwise OR between the bit field specified by StartBit
4104 and EndBit in Operand and the value specified by OrData. All other bits in
4105 Operand are preserved. The new 32-bit value is returned.
4107 If 32-bit operations are not supported, then ASSERT().
4108 If StartBit is greater than 31, then ASSERT().
4109 If EndBit is greater than 31, then ASSERT().
4110 If EndBit is less than StartBit, then ASSERT().
4111 If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4113 @param Operand Operand on which to perform the bitfield operation.
4114 @param StartBit The ordinal of the least significant bit in the bit field.
4116 @param EndBit The ordinal of the most significant bit in the bit field.
4118 @param OrData The value to OR with the read value from the value.
4120 @return The new 32-bit value.
4134 Reads a bit field from a 32-bit value, performs a bitwise AND, and returns
4137 Performs a bitwise AND between the bit field specified by StartBit and EndBit
4138 in Operand and the value specified by AndData. All other bits in Operand are
4139 preserved. The new 32-bit value is returned.
4141 If 32-bit operations are not supported, then ASSERT().
4142 If StartBit is greater than 31, then ASSERT().
4143 If EndBit is greater than 31, then ASSERT().
4144 If EndBit is less than StartBit, then ASSERT().
4145 If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4147 @param Operand Operand on which to perform the bitfield operation.
4148 @param StartBit The ordinal of the least significant bit in the bit field.
4150 @param EndBit The ordinal of the most significant bit in the bit field.
4152 @param AndData The value to AND with the read value from the value
4154 @return The new 32-bit value.
4168 Reads a bit field from a 32-bit value, performs a bitwise AND followed by a
4169 bitwise OR, and returns the result.
4171 Performs a bitwise AND between the bit field specified by StartBit and EndBit
4172 in Operand and the value specified by AndData, followed by a bitwise
4173 OR with value specified by OrData. All other bits in Operand are
4174 preserved. The new 32-bit value is returned.
4176 If 32-bit operations are not supported, then ASSERT().
4177 If StartBit is greater than 31, then ASSERT().
4178 If EndBit is greater than 31, then ASSERT().
4179 If EndBit is less than StartBit, then ASSERT().
4180 If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4181 If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4183 @param Operand Operand on which to perform the bitfield operation.
4184 @param StartBit The ordinal of the least significant bit in the bit field.
4186 @param EndBit The ordinal of the most significant bit in the bit field.
4188 @param AndData The value to AND with the read value from the value.
4189 @param OrData The value to OR with the result of the AND operation.
4191 @return The new 32-bit value.
4196 BitFieldAndThenOr32 (
4206 Returns a bit field from a 64-bit value.
4208 Returns the bitfield specified by the StartBit and the EndBit from Operand.
4210 If 64-bit operations are not supported, then ASSERT().
4211 If StartBit is greater than 63, then ASSERT().
4212 If EndBit is greater than 63, then ASSERT().
4213 If EndBit is less than StartBit, then ASSERT().
4215 @param Operand Operand on which to perform the bitfield operation.
4216 @param StartBit The ordinal of the least significant bit in the bit field.
4218 @param EndBit The ordinal of the most significant bit in the bit field.
4221 @return The bit field read.
4234 Writes a bit field to a 64-bit value, and returns the result.
4236 Writes Value to the bit field specified by the StartBit and the EndBit in
4237 Operand. All other bits in Operand are preserved. The new 64-bit value is
4240 If 64-bit operations are not supported, then ASSERT().
4241 If StartBit is greater than 63, then ASSERT().
4242 If EndBit is greater than 63, then ASSERT().
4243 If EndBit is less than StartBit, then ASSERT().
4244 If Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4246 @param Operand Operand on which to perform the bitfield operation.
4247 @param StartBit The ordinal of the least significant bit in the bit field.
4249 @param EndBit The ordinal of the most significant bit in the bit field.
4251 @param Value New value of the bit field.
4253 @return The new 64-bit value.
4267 Reads a bit field from a 64-bit value, performs a bitwise OR, and returns the
4270 Performs a bitwise OR between the bit field specified by StartBit
4271 and EndBit in Operand and the value specified by OrData. All other bits in
4272 Operand are preserved. The new 64-bit value is returned.
4274 If 64-bit operations are not supported, then ASSERT().
4275 If StartBit is greater than 63, then ASSERT().
4276 If EndBit is greater than 63, then ASSERT().
4277 If EndBit is less than StartBit, then ASSERT().
4278 If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4280 @param Operand Operand on which to perform the bitfield operation.
4281 @param StartBit The ordinal of the least significant bit in the bit field.
4283 @param EndBit The ordinal of the most significant bit in the bit field.
4285 @param OrData The value to OR with the read value from the value
4287 @return The new 64-bit value.
4301 Reads a bit field from a 64-bit value, performs a bitwise AND, and returns
4304 Performs a bitwise AND between the bit field specified by StartBit and EndBit
4305 in Operand and the value specified by AndData. All other bits in Operand are
4306 preserved. The new 64-bit value is returned.
4308 If 64-bit operations are not supported, then ASSERT().
4309 If StartBit is greater than 63, then ASSERT().
4310 If EndBit is greater than 63, then ASSERT().
4311 If EndBit is less than StartBit, then ASSERT().
4312 If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4314 @param Operand Operand on which to perform the bitfield operation.
4315 @param StartBit The ordinal of the least significant bit in the bit field.
4317 @param EndBit The ordinal of the most significant bit in the bit field.
4319 @param AndData The value to AND with the read value from the value
4321 @return The new 64-bit value.
4335 Reads a bit field from a 64-bit value, performs a bitwise AND followed by a
4336 bitwise OR, and returns the result.
4338 Performs a bitwise AND between the bit field specified by StartBit and EndBit
4339 in Operand and the value specified by AndData, followed by a bitwise
4340 OR with value specified by OrData. All other bits in Operand are
4341 preserved. The new 64-bit value is returned.
4343 If 64-bit operations are not supported, then ASSERT().
4344 If StartBit is greater than 63, then ASSERT().
4345 If EndBit is greater than 63, then ASSERT().
4346 If EndBit is less than StartBit, then ASSERT().
4347 If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4348 If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4350 @param Operand Operand on which to perform the bitfield operation.
4351 @param StartBit The ordinal of the least significant bit in the bit field.
4353 @param EndBit The ordinal of the most significant bit in the bit field.
4355 @param AndData The value to AND with the read value from the value.
4356 @param OrData The value to OR with the result of the AND operation.
4358 @return The new 64-bit value.
4363 BitFieldAndThenOr64 (
4372 // Base Library Checksum Functions
4376 Returns the sum of all elements in a buffer in unit of UINT8.
4377 During calculation, the carry bits are dropped.
4379 This function calculates the sum of all elements in a buffer
4380 in unit of UINT8. The carry bits in result of addition are dropped.
4381 The result is returned as UINT8. If Length is Zero, then Zero is
4384 If Buffer is NULL, then ASSERT().
4385 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
4387 @param Buffer The pointer to the buffer to carry out the sum operation.
4388 @param Length The size, in bytes, of Buffer.
4390 @return Sum The sum of Buffer with carry bits dropped during additions.
4396 IN CONST UINT8
*Buffer
,
4402 Returns the two's complement checksum of all elements in a buffer
4405 This function first calculates the sum of the 8-bit values in the
4406 buffer specified by Buffer and Length. The carry bits in the result
4407 of addition are dropped. Then, the two's complement of the sum is
4408 returned. If Length is 0, then 0 is returned.
4410 If Buffer is NULL, then ASSERT().
4411 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
4413 @param Buffer The pointer to the buffer to carry out the checksum operation.
4414 @param Length The size, in bytes, of Buffer.
4416 @return Checksum The two's complement checksum of Buffer.
4421 CalculateCheckSum8 (
4422 IN CONST UINT8
*Buffer
,
4428 Returns the sum of all elements in a buffer of 16-bit values. During
4429 calculation, the carry bits are dropped.
4431 This function calculates the sum of the 16-bit values in the buffer
4432 specified by Buffer and Length. The carry bits in result of addition are dropped.
4433 The 16-bit result is returned. If Length is 0, then 0 is returned.
4435 If Buffer is NULL, then ASSERT().
4436 If Buffer is not aligned on a 16-bit boundary, then ASSERT().
4437 If Length is not aligned on a 16-bit boundary, then ASSERT().
4438 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
4440 @param Buffer The pointer to the buffer to carry out the sum operation.
4441 @param Length The size, in bytes, of Buffer.
4443 @return Sum The sum of Buffer with carry bits dropped during additions.
4449 IN CONST UINT16
*Buffer
,
4455 Returns the two's complement checksum of all elements in a buffer of
4458 This function first calculates the sum of the 16-bit values in the buffer
4459 specified by Buffer and Length. The carry bits in the result of addition
4460 are dropped. Then, the two's complement of the sum is returned. If Length
4461 is 0, then 0 is returned.
4463 If Buffer is NULL, then ASSERT().
4464 If Buffer is not aligned on a 16-bit boundary, then ASSERT().
4465 If Length is not aligned on a 16-bit boundary, then ASSERT().
4466 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
4468 @param Buffer The pointer to the buffer to carry out the checksum operation.
4469 @param Length The size, in bytes, of Buffer.
4471 @return Checksum The two's complement checksum of Buffer.
4476 CalculateCheckSum16 (
4477 IN CONST UINT16
*Buffer
,
4483 Returns the sum of all elements in a buffer of 32-bit values. During
4484 calculation, the carry bits are dropped.
4486 This function calculates the sum of the 32-bit values in the buffer
4487 specified by Buffer and Length. The carry bits in result of addition are dropped.
4488 The 32-bit result is returned. If Length is 0, then 0 is returned.
4490 If Buffer is NULL, then ASSERT().
4491 If Buffer is not aligned on a 32-bit boundary, then ASSERT().
4492 If Length is not aligned on a 32-bit boundary, then ASSERT().
4493 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
4495 @param Buffer The pointer to the buffer to carry out the sum operation.
4496 @param Length The size, in bytes, of Buffer.
4498 @return Sum The sum of Buffer with carry bits dropped during additions.
4504 IN CONST UINT32
*Buffer
,
4510 Returns the two's complement checksum of all elements in a buffer of
4513 This function first calculates the sum of the 32-bit values in the buffer
4514 specified by Buffer and Length. The carry bits in the result of addition
4515 are dropped. Then, the two's complement of the sum is returned. If Length
4516 is 0, then 0 is returned.
4518 If Buffer is NULL, then ASSERT().
4519 If Buffer is not aligned on a 32-bit boundary, then ASSERT().
4520 If Length is not aligned on a 32-bit boundary, then ASSERT().
4521 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
4523 @param Buffer The pointer to the buffer to carry out the checksum operation.
4524 @param Length The size, in bytes, of Buffer.
4526 @return Checksum The two's complement checksum of Buffer.
4531 CalculateCheckSum32 (
4532 IN CONST UINT32
*Buffer
,
4538 Returns the sum of all elements in a buffer of 64-bit values. During
4539 calculation, the carry bits are dropped.
4541 This function calculates the sum of the 64-bit values in the buffer
4542 specified by Buffer and Length. The carry bits in result of addition are dropped.
4543 The 64-bit result is returned. If Length is 0, then 0 is returned.
4545 If Buffer is NULL, then ASSERT().
4546 If Buffer is not aligned on a 64-bit boundary, then ASSERT().
4547 If Length is not aligned on a 64-bit boundary, then ASSERT().
4548 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
4550 @param Buffer The pointer to the buffer to carry out the sum operation.
4551 @param Length The size, in bytes, of Buffer.
4553 @return Sum The sum of Buffer with carry bits dropped during additions.
4559 IN CONST UINT64
*Buffer
,
4565 Returns the two's complement checksum of all elements in a buffer of
4568 This function first calculates the sum of the 64-bit values in the buffer
4569 specified by Buffer and Length. The carry bits in the result of addition
4570 are dropped. Then, the two's complement of the sum is returned. If Length
4571 is 0, then 0 is returned.
4573 If Buffer is NULL, then ASSERT().
4574 If Buffer is not aligned on a 64-bit boundary, then ASSERT().
4575 If Length is not aligned on a 64-bit boundary, then ASSERT().
4576 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
4578 @param Buffer The pointer to the buffer to carry out the checksum operation.
4579 @param Length The size, in bytes, of Buffer.
4581 @return Checksum The two's complement checksum of Buffer.
4586 CalculateCheckSum64 (
4587 IN CONST UINT64
*Buffer
,
4593 // Base Library CPU Functions
4597 Function entry point used when a stack switch is requested with SwitchStack()
4599 @param Context1 Context1 parameter passed into SwitchStack().
4600 @param Context2 Context2 parameter passed into SwitchStack().
4605 (EFIAPI
*SWITCH_STACK_ENTRY_POINT
)(
4606 IN VOID
*Context1
, OPTIONAL
4607 IN VOID
*Context2 OPTIONAL
4612 Used to serialize load and store operations.
4614 All loads and stores that proceed calls to this function are guaranteed to be
4615 globally visible when this function returns.
4626 Saves the current CPU context that can be restored with a call to LongJump()
4629 Saves the current CPU context in the buffer specified by JumpBuffer and
4630 returns 0. The initial call to SetJump() must always return 0. Subsequent
4631 calls to LongJump() cause a non-zero value to be returned by SetJump().
4633 If JumpBuffer is NULL, then ASSERT().
4634 For Itanium processors, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().
4636 NOTE: The structure BASE_LIBRARY_JUMP_BUFFER is CPU architecture specific.
4637 The same structure must never be used for more than one CPU architecture context.
4638 For example, a BASE_LIBRARY_JUMP_BUFFER allocated by an IA-32 module must never be used from an x64 module.
4639 SetJump()/LongJump() is not currently supported for the EBC processor type.
4641 @param JumpBuffer A pointer to CPU context buffer.
4643 @retval 0 Indicates a return from SetJump().
4649 OUT BASE_LIBRARY_JUMP_BUFFER
*JumpBuffer
4654 Restores the CPU context that was saved with SetJump().
4656 Restores the CPU context from the buffer specified by JumpBuffer. This
4657 function never returns to the caller. Instead is resumes execution based on
4658 the state of JumpBuffer.
4660 If JumpBuffer is NULL, then ASSERT().
4661 For Itanium processors, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().
4662 If Value is 0, then ASSERT().
4664 @param JumpBuffer A pointer to CPU context buffer.
4665 @param Value The value to return when the SetJump() context is
4666 restored and must be non-zero.
4672 IN BASE_LIBRARY_JUMP_BUFFER
*JumpBuffer
,
4678 Enables CPU interrupts.
4689 Disables CPU interrupts.
4700 Disables CPU interrupts and returns the interrupt state prior to the disable
4703 @retval TRUE CPU interrupts were enabled on entry to this call.
4704 @retval FALSE CPU interrupts were disabled on entry to this call.
4709 SaveAndDisableInterrupts (
4715 Enables CPU interrupts for the smallest window required to capture any
4721 EnableDisableInterrupts (
4727 Retrieves the current CPU interrupt state.
4729 Returns TRUE if interrupts are currently enabled. Otherwise
4732 @retval TRUE CPU interrupts are enabled.
4733 @retval FALSE CPU interrupts are disabled.
4744 Set the current CPU interrupt state.
4746 Sets the current CPU interrupt state to the state specified by
4747 InterruptState. If InterruptState is TRUE, then interrupts are enabled. If
4748 InterruptState is FALSE, then interrupts are disabled. InterruptState is
4751 @param InterruptState TRUE if interrupts should enabled. FALSE if
4752 interrupts should be disabled.
4754 @return InterruptState
4760 IN BOOLEAN InterruptState
4765 Requests CPU to pause for a short period of time.
4767 Requests CPU to pause for a short period of time. Typically used in MP
4768 systems to prevent memory starvation while waiting for a spin lock.
4779 Transfers control to a function starting with a new stack.
4781 Transfers control to the function specified by EntryPoint using the
4782 new stack specified by NewStack and passing in the parameters specified
4783 by Context1 and Context2. Context1 and Context2 are optional and may
4784 be NULL. The function EntryPoint must never return. This function
4785 supports a variable number of arguments following the NewStack parameter.
4786 These additional arguments are ignored on IA-32, x64, and EBC architectures.
4787 Itanium processors expect one additional parameter of type VOID * that specifies
4788 the new backing store pointer.
4790 If EntryPoint is NULL, then ASSERT().
4791 If NewStack is NULL, then ASSERT().
4793 @param EntryPoint A pointer to function to call with the new stack.
4794 @param Context1 A pointer to the context to pass into the EntryPoint
4796 @param Context2 A pointer to the context to pass into the EntryPoint
4798 @param NewStack A pointer to the new stack to use for the EntryPoint
4800 @param ... This variable argument list is ignored for IA-32, x64, and
4801 EBC architectures. For Itanium processors, this variable
4802 argument list is expected to contain a single parameter of
4803 type VOID * that specifies the new backing store pointer.
4810 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
4811 IN VOID
*Context1
, OPTIONAL
4812 IN VOID
*Context2
, OPTIONAL
4819 Generates a breakpoint on the CPU.
4821 Generates a breakpoint on the CPU. The breakpoint must be implemented such
4822 that code can resume normal execution after the breakpoint.
4833 Executes an infinite loop.
4835 Forces the CPU to execute an infinite loop. A debugger may be used to skip
4836 past the loop and the code that follows the loop must execute properly. This
4837 implies that the infinite loop must not cause the code that follow it to be
4847 #if defined (MDE_CPU_IPF)
4850 Flush a range of cache lines in the cache coherency domain of the calling
4853 Flushes the cache lines specified by Address and Length. If Address is not aligned
4854 on a cache line boundary, then entire cache line containing Address is flushed.
4855 If Address + Length is not aligned on a cache line boundary, then the entire cache
4856 line containing Address + Length - 1 is flushed. This function may choose to flush
4857 the entire cache if that is more efficient than flushing the specified range. If
4858 Length is 0, the no cache lines are flushed. Address is returned.
4859 This function is only available on Itanium processors.
4861 If Length is greater than (MAX_ADDRESS - Address + 1), then ASSERT().
4863 @param Address The base address of the instruction lines to invalidate. If
4864 the CPU is in a physical addressing mode, then Address is a
4865 physical address. If the CPU is in a virtual addressing mode,
4866 then Address is a virtual address.
4868 @param Length The number of bytes to invalidate from the instruction cache.
4875 AsmFlushCacheRange (
4882 Executes an FC instruction.
4883 Executes an FC instruction on the cache line specified by Address.
4884 The cache line size affected is at least 32-bytes (aligned on a 32-byte boundary).
4885 An implementation may flush a larger region. This function is only available on Itanium processors.
4887 @param Address The Address of cache line to be flushed.
4889 @return The address of FC instruction executed.
4900 Executes an FC.I instruction.
4901 Executes an FC.I instruction on the cache line specified by Address.
4902 The cache line size affected is at least 32-bytes (aligned on a 32-byte boundary).
4903 An implementation may flush a larger region. This function is only available on Itanium processors.
4905 @param Address The Address of cache line to be flushed.
4907 @return The address of the FC.I instruction executed.
4918 Reads the current value of a Processor Identifier Register (CPUID).
4920 Reads and returns the current value of Processor Identifier Register specified by Index.
4921 The Index of largest implemented CPUID (One less than the number of implemented CPUID
4922 registers) is determined by CPUID [3] bits {7:0}.
4923 No parameter checking is performed on Index. If the Index value is beyond the
4924 implemented CPUID register range, a Reserved Register/Field fault may occur. The caller
4925 must either guarantee that Index is valid, or the caller must set up fault handlers to
4926 catch the faults. This function is only available on Itanium processors.
4928 @param Index The 8-bit Processor Identifier Register index to read.
4930 @return The current value of Processor Identifier Register specified by Index.
4941 Reads the current value of 64-bit Processor Status Register (PSR).
4942 This function is only available on Itanium processors.
4944 @return The current value of PSR.
4955 Writes the current value of 64-bit Processor Status Register (PSR).
4957 No parameter checking is performed on Value. All bits of Value corresponding to
4958 reserved fields of PSR must be 0 or a Reserved Register/Field fault may occur.
4959 The caller must either guarantee that Value is valid, or the caller must set up
4960 fault handlers to catch the faults. This function is only available on Itanium processors.
4962 @param Value The 64-bit value to write to PSR.
4964 @return The 64-bit value written to the PSR.
4975 Reads the current value of 64-bit Kernel Register #0 (KR0).
4977 Reads and returns the current value of KR0.
4978 This function is only available on Itanium processors.
4980 @return The current value of KR0.
4991 Reads the current value of 64-bit Kernel Register #1 (KR1).
4993 Reads and returns the current value of KR1.
4994 This function is only available on Itanium processors.
4996 @return The current value of KR1.
5007 Reads the current value of 64-bit Kernel Register #2 (KR2).
5009 Reads and returns the current value of KR2.
5010 This function is only available on Itanium processors.
5012 @return The current value of KR2.
5023 Reads the current value of 64-bit Kernel Register #3 (KR3).
5025 Reads and returns the current value of KR3.
5026 This function is only available on Itanium processors.
5028 @return The current value of KR3.
5039 Reads the current value of 64-bit Kernel Register #4 (KR4).
5041 Reads and returns the current value of KR4.
5042 This function is only available on Itanium processors.
5044 @return The current value of KR4.
5055 Reads the current value of 64-bit Kernel Register #5 (KR5).
5057 Reads and returns the current value of KR5.
5058 This function is only available on Itanium processors.
5060 @return The current value of KR5.
5071 Reads the current value of 64-bit Kernel Register #6 (KR6).
5073 Reads and returns the current value of KR6.
5074 This function is only available on Itanium processors.
5076 @return The current value of KR6.
5087 Reads the current value of 64-bit Kernel Register #7 (KR7).
5089 Reads and returns the current value of KR7.
5090 This function is only available on Itanium processors.
5092 @return The current value of KR7.
5103 Write the current value of 64-bit Kernel Register #0 (KR0).
5105 Writes the current value of KR0. The 64-bit value written to
5106 the KR0 is returned. This function is only available on Itanium processors.
5108 @param Value The 64-bit value to write to KR0.
5110 @return The 64-bit value written to the KR0.
5121 Write the current value of 64-bit Kernel Register #1 (KR1).
5123 Writes the current value of KR1. The 64-bit value written to
5124 the KR1 is returned. This function is only available on Itanium processors.
5126 @param Value The 64-bit value to write to KR1.
5128 @return The 64-bit value written to the KR1.
5139 Write the current value of 64-bit Kernel Register #2 (KR2).
5141 Writes the current value of KR2. The 64-bit value written to
5142 the KR2 is returned. This function is only available on Itanium processors.
5144 @param Value The 64-bit value to write to KR2.
5146 @return The 64-bit value written to the KR2.
5157 Write the current value of 64-bit Kernel Register #3 (KR3).
5159 Writes the current value of KR3. The 64-bit value written to
5160 the KR3 is returned. This function is only available on Itanium processors.
5162 @param Value The 64-bit value to write to KR3.
5164 @return The 64-bit value written to the KR3.
5175 Write the current value of 64-bit Kernel Register #4 (KR4).
5177 Writes the current value of KR4. The 64-bit value written to
5178 the KR4 is returned. This function is only available on Itanium processors.
5180 @param Value The 64-bit value to write to KR4.
5182 @return The 64-bit value written to the KR4.
5193 Write the current value of 64-bit Kernel Register #5 (KR5).
5195 Writes the current value of KR5. The 64-bit value written to
5196 the KR5 is returned. This function is only available on Itanium processors.
5198 @param Value The 64-bit value to write to KR5.
5200 @return The 64-bit value written to the KR5.
5211 Write the current value of 64-bit Kernel Register #6 (KR6).
5213 Writes the current value of KR6. The 64-bit value written to
5214 the KR6 is returned. This function is only available on Itanium processors.
5216 @param Value The 64-bit value to write to KR6.
5218 @return The 64-bit value written to the KR6.
5229 Write the current value of 64-bit Kernel Register #7 (KR7).
5231 Writes the current value of KR7. The 64-bit value written to
5232 the KR7 is returned. This function is only available on Itanium processors.
5234 @param Value The 64-bit value to write to KR7.
5236 @return The 64-bit value written to the KR7.
5247 Reads the current value of Interval Timer Counter Register (ITC).
5249 Reads and returns the current value of ITC.
5250 This function is only available on Itanium processors.
5252 @return The current value of ITC.
5263 Reads the current value of Interval Timer Vector Register (ITV).
5265 Reads and returns the current value of ITV.
5266 This function is only available on Itanium processors.
5268 @return The current value of ITV.
5279 Reads the current value of Interval Timer Match Register (ITM).
5281 Reads and returns the current value of ITM.
5282 This function is only available on Itanium processors.
5284 @return The current value of ITM.
5294 Writes the current value of 64-bit Interval Timer Counter Register (ITC).
5296 Writes the current value of ITC. The 64-bit value written to the ITC is returned.
5297 This function is only available on Itanium processors.
5299 @param Value The 64-bit value to write to ITC.
5301 @return The 64-bit value written to the ITC.
5312 Writes the current value of 64-bit Interval Timer Match Register (ITM).
5314 Writes the current value of ITM. The 64-bit value written to the ITM is returned.
5315 This function is only available on Itanium processors.
5317 @param Value The 64-bit value to write to ITM.
5319 @return The 64-bit value written to the ITM.
5330 Writes the current value of 64-bit Interval Timer Vector Register (ITV).
5332 Writes the current value of ITV. The 64-bit value written to the ITV is returned.
5333 No parameter checking is performed on Value. All bits of Value corresponding to
5334 reserved fields of ITV must be 0 or a Reserved Register/Field fault may occur.
5335 The caller must either guarantee that Value is valid, or the caller must set up
5336 fault handlers to catch the faults.
5337 This function is only available on Itanium processors.
5339 @param Value The 64-bit value to write to ITV.
5341 @return The 64-bit value written to the ITV.
5352 Reads the current value of Default Control Register (DCR).
5354 Reads and returns the current value of DCR. This function is only available on Itanium processors.
5356 @return The current value of DCR.
5367 Reads the current value of Interruption Vector Address Register (IVA).
5369 Reads and returns the current value of IVA. This function is only available on Itanium processors.
5371 @return The current value of IVA.
5381 Reads the current value of Page Table Address Register (PTA).
5383 Reads and returns the current value of PTA. This function is only available on Itanium processors.
5385 @return The current value of PTA.
5396 Writes the current value of 64-bit Default Control Register (DCR).
5398 Writes the current value of DCR. The 64-bit value written to the DCR is returned.
5399 No parameter checking is performed on Value. All bits of Value corresponding to
5400 reserved fields of DCR must be 0 or a Reserved Register/Field fault may occur.
5401 The caller must either guarantee that Value is valid, or the caller must set up
5402 fault handlers to catch the faults.
5403 This function is only available on Itanium processors.
5405 @param Value The 64-bit value to write to DCR.
5407 @return The 64-bit value written to the DCR.
5418 Writes the current value of 64-bit Interruption Vector Address Register (IVA).
5420 Writes the current value of IVA. The 64-bit value written to the IVA is returned.
5421 The size of vector table is 32 K bytes and is 32 K bytes aligned
5422 the low 15 bits of Value is ignored when written.
5423 This function is only available on Itanium processors.
5425 @param Value The 64-bit value to write to IVA.
5427 @return The 64-bit value written to the IVA.
5438 Writes the current value of 64-bit Page Table Address Register (PTA).
5440 Writes the current value of PTA. The 64-bit value written to the PTA is returned.
5441 No parameter checking is performed on Value. All bits of Value corresponding to
5442 reserved fields of DCR must be 0 or a Reserved Register/Field fault may occur.
5443 The caller must either guarantee that Value is valid, or the caller must set up
5444 fault handlers to catch the faults.
5445 This function is only available on Itanium processors.
5447 @param Value The 64-bit value to write to PTA.
5449 @return The 64-bit value written to the PTA.
5459 Reads the current value of Local Interrupt ID Register (LID).
5461 Reads and returns the current value of LID. This function is only available on Itanium processors.
5463 @return The current value of LID.
5474 Reads the current value of External Interrupt Vector Register (IVR).
5476 Reads and returns the current value of IVR. This function is only available on Itanium processors.
5478 @return The current value of IVR.
5489 Reads the current value of Task Priority Register (TPR).
5491 Reads and returns the current value of TPR. This function is only available on Itanium processors.
5493 @return The current value of TPR.
5504 Reads the current value of External Interrupt Request Register #0 (IRR0).
5506 Reads and returns the current value of IRR0. This function is only available on Itanium processors.
5508 @return The current value of IRR0.
5519 Reads the current value of External Interrupt Request Register #1 (IRR1).
5521 Reads and returns the current value of IRR1. This function is only available on Itanium processors.
5523 @return The current value of IRR1.
5534 Reads the current value of External Interrupt Request Register #2 (IRR2).
5536 Reads and returns the current value of IRR2. This function is only available on Itanium processors.
5538 @return The current value of IRR2.
5549 Reads the current value of External Interrupt Request Register #3 (IRR3).
5551 Reads and returns the current value of IRR3. This function is only available on Itanium processors.
5553 @return The current value of IRR3.
5564 Reads the current value of Performance Monitor Vector Register (PMV).
5566 Reads and returns the current value of PMV. This function is only available on Itanium processors.
5568 @return The current value of PMV.
5579 Reads the current value of Corrected Machine Check Vector Register (CMCV).
5581 Reads and returns the current value of CMCV. This function is only available on Itanium processors.
5583 @return The current value of CMCV.
5594 Reads the current value of Local Redirection Register #0 (LRR0).
5596 Reads and returns the current value of LRR0. This function is only available on Itanium processors.
5598 @return The current value of LRR0.
5609 Reads the current value of Local Redirection Register #1 (LRR1).
5611 Reads and returns the current value of LRR1. This function is only available on Itanium processors.
5613 @return The current value of LRR1.
5624 Writes the current value of 64-bit Page Local Interrupt ID Register (LID).
5626 Writes the current value of LID. The 64-bit value written to the LID is returned.
5627 No parameter checking is performed on Value. All bits of Value corresponding to
5628 reserved fields of LID must be 0 or a Reserved Register/Field fault may occur.
5629 The caller must either guarantee that Value is valid, or the caller must set up
5630 fault handlers to catch the faults.
5631 This function is only available on Itanium processors.
5633 @param Value The 64-bit value to write to LID.
5635 @return The 64-bit value written to the LID.
5646 Writes the current value of 64-bit Task Priority Register (TPR).
5648 Writes the current value of TPR. The 64-bit value written to the TPR is returned.
5649 No parameter checking is performed on Value. All bits of Value corresponding to
5650 reserved fields of TPR must be 0 or a Reserved Register/Field fault may occur.
5651 The caller must either guarantee that Value is valid, or the caller must set up
5652 fault handlers to catch the faults.
5653 This function is only available on Itanium processors.
5655 @param Value The 64-bit value to write to TPR.
5657 @return The 64-bit value written to the TPR.
5668 Performs a write operation on End OF External Interrupt Register (EOI).
5670 Writes a value of 0 to the EOI Register. This function is only available on Itanium processors.
5681 Writes the current value of 64-bit Performance Monitor Vector Register (PMV).
5683 Writes the current value of PMV. The 64-bit value written to the PMV is returned.
5684 No parameter checking is performed on Value. All bits of Value corresponding
5685 to reserved fields of PMV must be 0 or a Reserved Register/Field fault may occur.
5686 The caller must either guarantee that Value is valid, or the caller must set up
5687 fault handlers to catch the faults.
5688 This function is only available on Itanium processors.
5690 @param Value The 64-bit value to write to PMV.
5692 @return The 64-bit value written to the PMV.
5703 Writes the current value of 64-bit Corrected Machine Check Vector Register (CMCV).
5705 Writes the current value of CMCV. The 64-bit value written to the CMCV is returned.
5706 No parameter checking is performed on Value. All bits of Value corresponding
5707 to reserved fields of CMCV must be 0 or a Reserved Register/Field fault may occur.
5708 The caller must either guarantee that Value is valid, or the caller must set up
5709 fault handlers to catch the faults.
5710 This function is only available on Itanium processors.
5712 @param Value The 64-bit value to write to CMCV.
5714 @return The 64-bit value written to the CMCV.
5725 Writes the current value of 64-bit Local Redirection Register #0 (LRR0).
5727 Writes the current value of LRR0. The 64-bit value written to the LRR0 is returned.
5728 No parameter checking is performed on Value. All bits of Value corresponding
5729 to reserved fields of LRR0 must be 0 or a Reserved Register/Field fault may occur.
5730 The caller must either guarantee that Value is valid, or the caller must set up
5731 fault handlers to catch the faults.
5732 This function is only available on Itanium processors.
5734 @param Value The 64-bit value to write to LRR0.
5736 @return The 64-bit value written to the LRR0.
5747 Writes the current value of 64-bit Local Redirection Register #1 (LRR1).
5749 Writes the current value of LRR1. The 64-bit value written to the LRR1 is returned.
5750 No parameter checking is performed on Value. All bits of Value corresponding
5751 to reserved fields of LRR1 must be 0 or a Reserved Register/Field fault may occur.
5752 The caller must either guarantee that Value is valid, or the caller must
5753 set up fault handlers to catch the faults.
5754 This function is only available on Itanium processors.
5756 @param Value The 64-bit value to write to LRR1.
5758 @return The 64-bit value written to the LRR1.
5769 Reads the current value of Instruction Breakpoint Register (IBR).
5771 The Instruction Breakpoint Registers are used in pairs. The even numbered
5772 registers contain breakpoint addresses, and the odd numbered registers contain
5773 breakpoint mask conditions. At least four instruction registers pairs are implemented
5774 on all processor models. Implemented registers are contiguous starting with
5775 register 0. No parameter checking is performed on Index, and if the Index value
5776 is beyond the implemented IBR register range, a Reserved Register/Field fault may
5777 occur. The caller must either guarantee that Index is valid, or the caller must
5778 set up fault handlers to catch the faults.
5779 This function is only available on Itanium processors.
5781 @param Index The 8-bit Instruction Breakpoint Register index to read.
5783 @return The current value of Instruction Breakpoint Register specified by Index.
5794 Reads the current value of Data Breakpoint Register (DBR).
5796 The Data Breakpoint Registers are used in pairs. The even numbered registers
5797 contain breakpoint addresses, and odd numbered registers contain breakpoint
5798 mask conditions. At least four data registers pairs are implemented on all processor
5799 models. Implemented registers are contiguous starting with register 0.
5800 No parameter checking is performed on Index. If the Index value is beyond
5801 the implemented DBR register range, a Reserved Register/Field fault may occur.
5802 The caller must either guarantee that Index is valid, or the caller must set up
5803 fault handlers to catch the faults.
5804 This function is only available on Itanium processors.
5806 @param Index The 8-bit Data Breakpoint Register index to read.
5808 @return The current value of Data Breakpoint Register specified by Index.
5819 Reads the current value of Performance Monitor Configuration Register (PMC).
5821 All processor implementations provide at least four performance counters
5822 (PMC/PMD [4]...PMC/PMD [7] pairs), and four performance monitor counter overflow
5823 status registers (PMC [0]... PMC [3]). Processor implementations may provide
5824 additional implementation-dependent PMC and PMD to increase the number of
5825 'generic' performance counters (PMC/PMD pairs). The remainder of PMC and PMD
5826 register set is implementation dependent. No parameter checking is performed
5827 on Index. If the Index value is beyond the implemented PMC register range,
5828 zero value will be returned.
5829 This function is only available on Itanium processors.
5831 @param Index The 8-bit Performance Monitor Configuration Register index to read.
5833 @return The current value of Performance Monitor Configuration Register
5845 Reads the current value of Performance Monitor Data Register (PMD).
5847 All processor implementations provide at least 4 performance counters
5848 (PMC/PMD [4]...PMC/PMD [7] pairs), and 4 performance monitor counter
5849 overflow status registers (PMC [0]... PMC [3]). Processor implementations may
5850 provide additional implementation-dependent PMC and PMD to increase the number
5851 of 'generic' performance counters (PMC/PMD pairs). The remainder of PMC and PMD
5852 register set is implementation dependent. No parameter checking is performed
5853 on Index. If the Index value is beyond the implemented PMD register range,
5854 zero value will be returned.
5855 This function is only available on Itanium processors.
5857 @param Index The 8-bit Performance Monitor Data Register index to read.
5859 @return The current value of Performance Monitor Data Register specified by Index.
5870 Writes the current value of 64-bit Instruction Breakpoint Register (IBR).
5872 Writes current value of Instruction Breakpoint Register specified by Index.
5873 The Instruction Breakpoint Registers are used in pairs. The even numbered
5874 registers contain breakpoint addresses, and odd numbered registers contain
5875 breakpoint mask conditions. At least four instruction registers pairs are implemented
5876 on all processor models. Implemented registers are contiguous starting with
5877 register 0. No parameter checking is performed on Index. If the Index value
5878 is beyond the implemented IBR register range, a Reserved Register/Field fault may
5879 occur. The caller must either guarantee that Index is valid, or the caller must
5880 set up fault handlers to catch the faults.
5881 This function is only available on Itanium processors.
5883 @param Index The 8-bit Instruction Breakpoint Register index to write.
5884 @param Value The 64-bit value to write to IBR.
5886 @return The 64-bit value written to the IBR.
5898 Writes the current value of 64-bit Data Breakpoint Register (DBR).
5900 Writes current value of Data Breakpoint Register specified by Index.
5901 The Data Breakpoint Registers are used in pairs. The even numbered registers
5902 contain breakpoint addresses, and odd numbered registers contain breakpoint
5903 mask conditions. At least four data registers pairs are implemented on all processor
5904 models. Implemented registers are contiguous starting with register 0. No parameter
5905 checking is performed on Index. If the Index value is beyond the implemented
5906 DBR register range, a Reserved Register/Field fault may occur. The caller must
5907 either guarantee that Index is valid, or the caller must set up fault handlers to
5909 This function is only available on Itanium processors.
5911 @param Index The 8-bit Data Breakpoint Register index to write.
5912 @param Value The 64-bit value to write to DBR.
5914 @return The 64-bit value written to the DBR.
5926 Writes the current value of 64-bit Performance Monitor Configuration Register (PMC).
5928 Writes current value of Performance Monitor Configuration Register specified by Index.
5929 All processor implementations provide at least four performance counters
5930 (PMC/PMD [4]...PMC/PMD [7] pairs), and four performance monitor counter overflow status
5931 registers (PMC [0]... PMC [3]). Processor implementations may provide additional
5932 implementation-dependent PMC and PMD to increase the number of 'generic' performance
5933 counters (PMC/PMD pairs). The remainder of PMC and PMD register set is implementation
5934 dependent. No parameter checking is performed on Index. If the Index value is
5935 beyond the implemented PMC register range, the write is ignored.
5936 This function is only available on Itanium processors.
5938 @param Index The 8-bit Performance Monitor Configuration Register index to write.
5939 @param Value The 64-bit value to write to PMC.
5941 @return The 64-bit value written to the PMC.
5953 Writes the current value of 64-bit Performance Monitor Data Register (PMD).
5955 Writes current value of Performance Monitor Data Register specified by Index.
5956 All processor implementations provide at least four performance counters
5957 (PMC/PMD [4]...PMC/PMD [7] pairs), and four performance monitor counter overflow
5958 status registers (PMC [0]... PMC [3]). Processor implementations may provide
5959 additional implementation-dependent PMC and PMD to increase the number of 'generic'
5960 performance counters (PMC/PMD pairs). The remainder of PMC and PMD register set
5961 is implementation dependent. No parameter checking is performed on Index. If the
5962 Index value is beyond the implemented PMD register range, the write is ignored.
5963 This function is only available on Itanium processors.
5965 @param Index The 8-bit Performance Monitor Data Register index to write.
5966 @param Value The 64-bit value to write to PMD.
5968 @return The 64-bit value written to the PMD.
5980 Reads the current value of 64-bit Global Pointer (GP).
5982 Reads and returns the current value of GP.
5983 This function is only available on Itanium processors.
5985 @return The current value of GP.
5996 Write the current value of 64-bit Global Pointer (GP).
5998 Writes the current value of GP. The 64-bit value written to the GP is returned.
5999 No parameter checking is performed on Value.
6000 This function is only available on Itanium processors.
6002 @param Value The 64-bit value to write to GP.
6004 @return The 64-bit value written to the GP.
6015 Reads the current value of 64-bit Stack Pointer (SP).
6017 Reads and returns the current value of SP.
6018 This function is only available on Itanium processors.
6020 @return The current value of SP.
6031 /// Valid Index value for AsmReadControlRegister().
6033 #define IPF_CONTROL_REGISTER_DCR 0
6034 #define IPF_CONTROL_REGISTER_ITM 1
6035 #define IPF_CONTROL_REGISTER_IVA 2
6036 #define IPF_CONTROL_REGISTER_PTA 8
6037 #define IPF_CONTROL_REGISTER_IPSR 16
6038 #define IPF_CONTROL_REGISTER_ISR 17
6039 #define IPF_CONTROL_REGISTER_IIP 19
6040 #define IPF_CONTROL_REGISTER_IFA 20
6041 #define IPF_CONTROL_REGISTER_ITIR 21
6042 #define IPF_CONTROL_REGISTER_IIPA 22
6043 #define IPF_CONTROL_REGISTER_IFS 23
6044 #define IPF_CONTROL_REGISTER_IIM 24
6045 #define IPF_CONTROL_REGISTER_IHA 25
6046 #define IPF_CONTROL_REGISTER_LID 64
6047 #define IPF_CONTROL_REGISTER_IVR 65
6048 #define IPF_CONTROL_REGISTER_TPR 66
6049 #define IPF_CONTROL_REGISTER_EOI 67
6050 #define IPF_CONTROL_REGISTER_IRR0 68
6051 #define IPF_CONTROL_REGISTER_IRR1 69
6052 #define IPF_CONTROL_REGISTER_IRR2 70
6053 #define IPF_CONTROL_REGISTER_IRR3 71
6054 #define IPF_CONTROL_REGISTER_ITV 72
6055 #define IPF_CONTROL_REGISTER_PMV 73
6056 #define IPF_CONTROL_REGISTER_CMCV 74
6057 #define IPF_CONTROL_REGISTER_LRR0 80
6058 #define IPF_CONTROL_REGISTER_LRR1 81
6061 Reads a 64-bit control register.
6063 Reads and returns the control register specified by Index. The valid Index valued
6064 are defined above in "Related Definitions".
6065 If Index is invalid then 0xFFFFFFFFFFFFFFFF is returned. This function is only
6066 available on Itanium processors.
6068 @param Index The index of the control register to read.
6070 @return The control register specified by Index.
6075 AsmReadControlRegister (
6081 /// Valid Index value for AsmReadApplicationRegister().
6083 #define IPF_APPLICATION_REGISTER_K0 0
6084 #define IPF_APPLICATION_REGISTER_K1 1
6085 #define IPF_APPLICATION_REGISTER_K2 2
6086 #define IPF_APPLICATION_REGISTER_K3 3
6087 #define IPF_APPLICATION_REGISTER_K4 4
6088 #define IPF_APPLICATION_REGISTER_K5 5
6089 #define IPF_APPLICATION_REGISTER_K6 6
6090 #define IPF_APPLICATION_REGISTER_K7 7
6091 #define IPF_APPLICATION_REGISTER_RSC 16
6092 #define IPF_APPLICATION_REGISTER_BSP 17
6093 #define IPF_APPLICATION_REGISTER_BSPSTORE 18
6094 #define IPF_APPLICATION_REGISTER_RNAT 19
6095 #define IPF_APPLICATION_REGISTER_FCR 21
6096 #define IPF_APPLICATION_REGISTER_EFLAG 24
6097 #define IPF_APPLICATION_REGISTER_CSD 25
6098 #define IPF_APPLICATION_REGISTER_SSD 26
6099 #define IPF_APPLICATION_REGISTER_CFLG 27
6100 #define IPF_APPLICATION_REGISTER_FSR 28
6101 #define IPF_APPLICATION_REGISTER_FIR 29
6102 #define IPF_APPLICATION_REGISTER_FDR 30
6103 #define IPF_APPLICATION_REGISTER_CCV 32
6104 #define IPF_APPLICATION_REGISTER_UNAT 36
6105 #define IPF_APPLICATION_REGISTER_FPSR 40
6106 #define IPF_APPLICATION_REGISTER_ITC 44
6107 #define IPF_APPLICATION_REGISTER_PFS 64
6108 #define IPF_APPLICATION_REGISTER_LC 65
6109 #define IPF_APPLICATION_REGISTER_EC 66
6112 Reads a 64-bit application register.
6114 Reads and returns the application register specified by Index. The valid Index
6115 valued are defined above in "Related Definitions".
6116 If Index is invalid then 0xFFFFFFFFFFFFFFFF is returned. This function is only
6117 available on Itanium processors.
6119 @param Index The index of the application register to read.
6121 @return The application register specified by Index.
6126 AsmReadApplicationRegister (
6132 Reads the current value of a Machine Specific Register (MSR).
6134 Reads and returns the current value of the Machine Specific Register specified by Index. No
6135 parameter checking is performed on Index, and if the Index value is beyond the implemented MSR
6136 register range, a Reserved Register/Field fault may occur. The caller must either guarantee that
6137 Index is valid, or the caller must set up fault handlers to catch the faults. This function is
6138 only available on Itanium processors.
6140 @param Index The 8-bit Machine Specific Register index to read.
6142 @return The current value of the Machine Specific Register specified by Index.
6153 Writes the current value of a Machine Specific Register (MSR).
6155 Writes Value to the Machine Specific Register specified by Index. Value is returned. No
6156 parameter checking is performed on Index, and if the Index value is beyond the implemented MSR
6157 register range, a Reserved Register/Field fault may occur. The caller must either guarantee that
6158 Index is valid, or the caller must set up fault handlers to catch the faults. This function is
6159 only available on Itanium processors.
6161 @param Index The 8-bit Machine Specific Register index to write.
6162 @param Value The 64-bit value to write to the Machine Specific Register.
6164 @return The 64-bit value to write to the Machine Specific Register.
6176 Determines if the CPU is currently executing in virtual, physical, or mixed mode.
6178 Determines the current execution mode of the CPU.
6179 If the CPU is in virtual mode(PSR.RT=1, PSR.DT=1, PSR.IT=1), then 1 is returned.
6180 If the CPU is in physical mode(PSR.RT=0, PSR.DT=0, PSR.IT=0), then 0 is returned.
6181 If the CPU is not in physical mode or virtual mode, then it is in mixed mode,
6183 This function is only available on Itanium processors.
6185 @retval 1 The CPU is in virtual mode.
6186 @retval 0 The CPU is in physical mode.
6187 @retval -1 The CPU is in mixed mode.
6198 Makes a PAL procedure call.
6200 This is a wrapper function to make a PAL procedure call. Based on the Index
6201 value this API will make static or stacked PAL call. The following table
6202 describes the usage of PAL Procedure Index Assignment. Architected procedures
6203 may be designated as required or optional. If a PAL procedure is specified
6204 as optional, a unique return code of 0xFFFFFFFFFFFFFFFF is returned in the
6205 Status field of the PAL_CALL_RETURN structure.
6206 This indicates that the procedure is not present in this PAL implementation.
6207 It is the caller's responsibility to check for this return code after calling
6208 any optional PAL procedure.
6209 No parameter checking is performed on the 5 input parameters, but there are
6210 some common rules that the caller should follow when making a PAL call. Any
6211 address passed to PAL as buffers for return parameters must be 8-byte aligned.
6212 Unaligned addresses may cause undefined results. For those parameters defined
6213 as reserved or some fields defined as reserved must be zero filled or the invalid
6214 argument return value may be returned or undefined result may occur during the
6215 execution of the procedure. If the PalEntryPoint does not point to a valid
6216 PAL entry point then the system behavior is undefined. This function is only
6217 available on Itanium processors.
6219 @param PalEntryPoint The PAL procedure calls entry point.
6220 @param Index The PAL procedure Index number.
6221 @param Arg2 The 2nd parameter for PAL procedure calls.
6222 @param Arg3 The 3rd parameter for PAL procedure calls.
6223 @param Arg4 The 4th parameter for PAL procedure calls.
6225 @return structure returned from the PAL Call procedure, including the status and return value.
6231 IN UINT64 PalEntryPoint
,
6239 #if defined (MDE_CPU_IA32) || defined (MDE_CPU_X64)
6241 /// IA32 and x64 Specific Functions.
6242 /// Byte packed structure for 16-bit Real Mode EFLAGS.
6246 UINT32 CF
:1; ///< Carry Flag.
6247 UINT32 Reserved_0
:1; ///< Reserved.
6248 UINT32 PF
:1; ///< Parity Flag.
6249 UINT32 Reserved_1
:1; ///< Reserved.
6250 UINT32 AF
:1; ///< Auxiliary Carry Flag.
6251 UINT32 Reserved_2
:1; ///< Reserved.
6252 UINT32 ZF
:1; ///< Zero Flag.
6253 UINT32 SF
:1; ///< Sign Flag.
6254 UINT32 TF
:1; ///< Trap Flag.
6255 UINT32 IF
:1; ///< Interrupt Enable Flag.
6256 UINT32 DF
:1; ///< Direction Flag.
6257 UINT32 OF
:1; ///< Overflow Flag.
6258 UINT32 IOPL
:2; ///< I/O Privilege Level.
6259 UINT32 NT
:1; ///< Nested Task.
6260 UINT32 Reserved_3
:1; ///< Reserved.
6266 /// Byte packed structure for EFLAGS/RFLAGS.
6267 /// 32-bits on IA-32.
6268 /// 64-bits on x64. The upper 32-bits on x64 are reserved.
6272 UINT32 CF
:1; ///< Carry Flag.
6273 UINT32 Reserved_0
:1; ///< Reserved.
6274 UINT32 PF
:1; ///< Parity Flag.
6275 UINT32 Reserved_1
:1; ///< Reserved.
6276 UINT32 AF
:1; ///< Auxiliary Carry Flag.
6277 UINT32 Reserved_2
:1; ///< Reserved.
6278 UINT32 ZF
:1; ///< Zero Flag.
6279 UINT32 SF
:1; ///< Sign Flag.
6280 UINT32 TF
:1; ///< Trap Flag.
6281 UINT32 IF
:1; ///< Interrupt Enable Flag.
6282 UINT32 DF
:1; ///< Direction Flag.
6283 UINT32 OF
:1; ///< Overflow Flag.
6284 UINT32 IOPL
:2; ///< I/O Privilege Level.
6285 UINT32 NT
:1; ///< Nested Task.
6286 UINT32 Reserved_3
:1; ///< Reserved.
6287 UINT32 RF
:1; ///< Resume Flag.
6288 UINT32 VM
:1; ///< Virtual 8086 Mode.
6289 UINT32 AC
:1; ///< Alignment Check.
6290 UINT32 VIF
:1; ///< Virtual Interrupt Flag.
6291 UINT32 VIP
:1; ///< Virtual Interrupt Pending.
6292 UINT32 ID
:1; ///< ID Flag.
6293 UINT32 Reserved_4
:10; ///< Reserved.
6299 /// Byte packed structure for Control Register 0 (CR0).
6300 /// 32-bits on IA-32.
6301 /// 64-bits on x64. The upper 32-bits on x64 are reserved.
6305 UINT32 PE
:1; ///< Protection Enable.
6306 UINT32 MP
:1; ///< Monitor Coprocessor.
6307 UINT32 EM
:1; ///< Emulation.
6308 UINT32 TS
:1; ///< Task Switched.
6309 UINT32 ET
:1; ///< Extension Type.
6310 UINT32 NE
:1; ///< Numeric Error.
6311 UINT32 Reserved_0
:10; ///< Reserved.
6312 UINT32 WP
:1; ///< Write Protect.
6313 UINT32 Reserved_1
:1; ///< Reserved.
6314 UINT32 AM
:1; ///< Alignment Mask.
6315 UINT32 Reserved_2
:10; ///< Reserved.
6316 UINT32 NW
:1; ///< Mot Write-through.
6317 UINT32 CD
:1; ///< Cache Disable.
6318 UINT32 PG
:1; ///< Paging.
6324 /// Byte packed structure for Control Register 4 (CR4).
6325 /// 32-bits on IA-32.
6326 /// 64-bits on x64. The upper 32-bits on x64 are reserved.
6330 UINT32 VME
:1; ///< Virtual-8086 Mode Extensions.
6331 UINT32 PVI
:1; ///< Protected-Mode Virtual Interrupts.
6332 UINT32 TSD
:1; ///< Time Stamp Disable.
6333 UINT32 DE
:1; ///< Debugging Extensions.
6334 UINT32 PSE
:1; ///< Page Size Extensions.
6335 UINT32 PAE
:1; ///< Physical Address Extension.
6336 UINT32 MCE
:1; ///< Machine Check Enable.
6337 UINT32 PGE
:1; ///< Page Global Enable.
6338 UINT32 PCE
:1; ///< Performance Monitoring Counter
6340 UINT32 OSFXSR
:1; ///< Operating System Support for
6341 ///< FXSAVE and FXRSTOR instructions
6342 UINT32 OSXMMEXCPT
:1; ///< Operating System Support for
6343 ///< Unmasked SIMD Floating Point
6345 UINT32 Reserved_0
:2; ///< Reserved.
6346 UINT32 VMXE
:1; ///< VMX Enable
6347 UINT32 Reserved_1
:18; ///< Reserved.
6353 /// Byte packed structure for a segment descriptor in a GDT/LDT.
6372 } IA32_SEGMENT_DESCRIPTOR
;
6375 /// Byte packed structure for an IDTR, GDTR, LDTR descriptor.
6384 #define IA32_IDT_GATE_TYPE_TASK 0x85
6385 #define IA32_IDT_GATE_TYPE_INTERRUPT_16 0x86
6386 #define IA32_IDT_GATE_TYPE_TRAP_16 0x87
6387 #define IA32_IDT_GATE_TYPE_INTERRUPT_32 0x8E
6388 #define IA32_IDT_GATE_TYPE_TRAP_32 0x8F
6391 #if defined (MDE_CPU_IA32)
6393 /// Byte packed structure for an IA-32 Interrupt Gate Descriptor.
6397 UINT32 OffsetLow
:16; ///< Offset bits 15..0.
6398 UINT32 Selector
:16; ///< Selector.
6399 UINT32 Reserved_0
:8; ///< Reserved.
6400 UINT32 GateType
:8; ///< Gate Type. See #defines above.
6401 UINT32 OffsetHigh
:16; ///< Offset bits 31..16.
6404 } IA32_IDT_GATE_DESCRIPTOR
;
6408 #if defined (MDE_CPU_X64)
6410 /// Byte packed structure for an x64 Interrupt Gate Descriptor.
6414 UINT32 OffsetLow
:16; ///< Offset bits 15..0.
6415 UINT32 Selector
:16; ///< Selector.
6416 UINT32 Reserved_0
:8; ///< Reserved.
6417 UINT32 GateType
:8; ///< Gate Type. See #defines above.
6418 UINT32 OffsetHigh
:16; ///< Offset bits 31..16.
6419 UINT32 OffsetUpper
:32; ///< Offset bits 63..32.
6420 UINT32 Reserved_1
:32; ///< Reserved.
6426 } IA32_IDT_GATE_DESCRIPTOR
;
6431 /// Byte packed structure for an FP/SSE/SSE2 context.
6438 /// Structures for the 16-bit real mode thunks.
6491 IA32_EFLAGS32 EFLAGS
;
6501 } IA32_REGISTER_SET
;
6504 /// Byte packed structure for an 16-bit real mode thunks.
6507 IA32_REGISTER_SET
*RealModeState
;
6508 VOID
*RealModeBuffer
;
6509 UINT32 RealModeBufferSize
;
6510 UINT32 ThunkAttributes
;
6513 #define THUNK_ATTRIBUTE_BIG_REAL_MODE 0x00000001
6514 #define THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 0x00000002
6515 #define THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL 0x00000004
6518 Retrieves CPUID information.
6520 Executes the CPUID instruction with EAX set to the value specified by Index.
6521 This function always returns Index.
6522 If Eax is not NULL, then the value of EAX after CPUID is returned in Eax.
6523 If Ebx is not NULL, then the value of EBX after CPUID is returned in Ebx.
6524 If Ecx is not NULL, then the value of ECX after CPUID is returned in Ecx.
6525 If Edx is not NULL, then the value of EDX after CPUID is returned in Edx.
6526 This function is only available on IA-32 and x64.
6528 @param Index The 32-bit value to load into EAX prior to invoking the CPUID
6530 @param Eax The pointer to the 32-bit EAX value returned by the CPUID
6531 instruction. This is an optional parameter that may be NULL.
6532 @param Ebx The pointer to the 32-bit EBX value returned by the CPUID
6533 instruction. This is an optional parameter that may be NULL.
6534 @param Ecx The pointer to the 32-bit ECX value returned by the CPUID
6535 instruction. This is an optional parameter that may be NULL.
6536 @param Edx The pointer to the 32-bit EDX value returned by the CPUID
6537 instruction. This is an optional parameter that may be NULL.
6546 OUT UINT32
*Eax
, OPTIONAL
6547 OUT UINT32
*Ebx
, OPTIONAL
6548 OUT UINT32
*Ecx
, OPTIONAL
6549 OUT UINT32
*Edx OPTIONAL
6554 Retrieves CPUID information using an extended leaf identifier.
6556 Executes the CPUID instruction with EAX set to the value specified by Index
6557 and ECX set to the value specified by SubIndex. This function always returns
6558 Index. This function is only available on IA-32 and x64.
6560 If Eax is not NULL, then the value of EAX after CPUID is returned in Eax.
6561 If Ebx is not NULL, then the value of EBX after CPUID is returned in Ebx.
6562 If Ecx is not NULL, then the value of ECX after CPUID is returned in Ecx.
6563 If Edx is not NULL, then the value of EDX after CPUID is returned in Edx.
6565 @param Index The 32-bit value to load into EAX prior to invoking the
6567 @param SubIndex The 32-bit value to load into ECX prior to invoking the
6569 @param Eax The pointer to the 32-bit EAX value returned by the CPUID
6570 instruction. This is an optional parameter that may be
6572 @param Ebx The pointer to the 32-bit EBX value returned by the CPUID
6573 instruction. This is an optional parameter that may be
6575 @param Ecx The pointer to the 32-bit ECX value returned by the CPUID
6576 instruction. This is an optional parameter that may be
6578 @param Edx The pointer to the 32-bit EDX value returned by the CPUID
6579 instruction. This is an optional parameter that may be
6590 OUT UINT32
*Eax
, OPTIONAL
6591 OUT UINT32
*Ebx
, OPTIONAL
6592 OUT UINT32
*Ecx
, OPTIONAL
6593 OUT UINT32
*Edx OPTIONAL
6598 Set CD bit and clear NW bit of CR0 followed by a WBINVD.
6600 Disables the caches by setting the CD bit of CR0 to 1, clearing the NW bit of CR0 to 0,
6601 and executing a WBINVD instruction. This function is only available on IA-32 and x64.
6612 Perform a WBINVD and clear both the CD and NW bits of CR0.
6614 Enables the caches by executing a WBINVD instruction and then clear both the CD and NW
6615 bits of CR0 to 0. This function is only available on IA-32 and x64.
6626 Returns the lower 32-bits of a Machine Specific Register(MSR).
6628 Reads and returns the lower 32-bits of the MSR specified by Index.
6629 No parameter checking is performed on Index, and some Index values may cause
6630 CPU exceptions. The caller must either guarantee that Index is valid, or the
6631 caller must set up exception handlers to catch the exceptions. This function
6632 is only available on IA-32 and x64.
6634 @param Index The 32-bit MSR index to read.
6636 @return The lower 32 bits of the MSR identified by Index.
6647 Writes a 32-bit value to a Machine Specific Register(MSR), and returns the value.
6648 The upper 32-bits of the MSR are set to zero.
6650 Writes the 32-bit value specified by Value to the MSR specified by Index. The
6651 upper 32-bits of the MSR write are set to zero. The 32-bit value written to
6652 the MSR is returned. No parameter checking is performed on Index or Value,
6653 and some of these may cause CPU exceptions. The caller must either guarantee
6654 that Index and Value are valid, or the caller must establish proper exception
6655 handlers. This function is only available on IA-32 and x64.
6657 @param Index The 32-bit MSR index to write.
6658 @param Value The 32-bit value to write to the MSR.
6672 Reads a 64-bit MSR, performs a bitwise OR on the lower 32-bits, and
6673 writes the result back to the 64-bit MSR.
6675 Reads the 64-bit MSR specified by Index, performs a bitwise OR
6676 between the lower 32-bits of the read result and the value specified by
6677 OrData, and writes the result to the 64-bit MSR specified by Index. The lower
6678 32-bits of the value written to the MSR is returned. No parameter checking is
6679 performed on Index or OrData, and some of these may cause CPU exceptions. The
6680 caller must either guarantee that Index and OrData are valid, or the caller
6681 must establish proper exception handlers. This function is only available on
6684 @param Index The 32-bit MSR index to write.
6685 @param OrData The value to OR with the read value from the MSR.
6687 @return The lower 32-bit value written to the MSR.
6699 Reads a 64-bit MSR, performs a bitwise AND on the lower 32-bits, and writes
6700 the result back to the 64-bit MSR.
6702 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
6703 lower 32-bits of the read result and the value specified by AndData, and
6704 writes the result to the 64-bit MSR specified by Index. The lower 32-bits of
6705 the value written to the MSR is returned. No parameter checking is performed
6706 on Index or AndData, and some of these may cause CPU exceptions. The caller
6707 must either guarantee that Index and AndData are valid, or the caller must
6708 establish proper exception handlers. This function is only available on IA-32
6711 @param Index The 32-bit MSR index to write.
6712 @param AndData The value to AND with the read value from the MSR.
6714 @return The lower 32-bit value written to the MSR.
6726 Reads a 64-bit MSR, performs a bitwise AND followed by a bitwise OR
6727 on the lower 32-bits, and writes the result back to the 64-bit MSR.
6729 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
6730 lower 32-bits of the read result and the value specified by AndData
6731 preserving the upper 32-bits, performs a bitwise OR between the
6732 result of the AND operation and the value specified by OrData, and writes the
6733 result to the 64-bit MSR specified by Address. The lower 32-bits of the value
6734 written to the MSR is returned. No parameter checking is performed on Index,
6735 AndData, or OrData, and some of these may cause CPU exceptions. The caller
6736 must either guarantee that Index, AndData, and OrData are valid, or the
6737 caller must establish proper exception handlers. This function is only
6738 available on IA-32 and x64.
6740 @param Index The 32-bit MSR index to write.
6741 @param AndData The value to AND with the read value from the MSR.
6742 @param OrData The value to OR with the result of the AND operation.
6744 @return The lower 32-bit value written to the MSR.
6757 Reads a bit field of an MSR.
6759 Reads the bit field in the lower 32-bits of a 64-bit MSR. The bit field is
6760 specified by the StartBit and the EndBit. The value of the bit field is
6761 returned. The caller must either guarantee that Index is valid, or the caller
6762 must set up exception handlers to catch the exceptions. This function is only
6763 available on IA-32 and x64.
6765 If StartBit is greater than 31, then ASSERT().
6766 If EndBit is greater than 31, then ASSERT().
6767 If EndBit is less than StartBit, then ASSERT().
6769 @param Index The 32-bit MSR index to read.
6770 @param StartBit The ordinal of the least significant bit in the bit field.
6772 @param EndBit The ordinal of the most significant bit in the bit field.
6775 @return The bit field read from the MSR.
6780 AsmMsrBitFieldRead32 (
6788 Writes a bit field to an MSR.
6790 Writes Value to a bit field in the lower 32-bits of a 64-bit MSR. The bit
6791 field is specified by the StartBit and the EndBit. All other bits in the
6792 destination MSR are preserved. The lower 32-bits of the MSR written is
6793 returned. The caller must either guarantee that Index and the data written
6794 is valid, or the caller must set up exception handlers to catch the exceptions.
6795 This function is only available on IA-32 and x64.
6797 If StartBit is greater than 31, then ASSERT().
6798 If EndBit is greater than 31, then ASSERT().
6799 If EndBit is less than StartBit, then ASSERT().
6800 If Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
6802 @param Index The 32-bit MSR index to write.
6803 @param StartBit The ordinal of the least significant bit in the bit field.
6805 @param EndBit The ordinal of the most significant bit in the bit field.
6807 @param Value New value of the bit field.
6809 @return The lower 32-bit of the value written to the MSR.
6814 AsmMsrBitFieldWrite32 (
6823 Reads a bit field in a 64-bit MSR, performs a bitwise OR, and writes the
6824 result back to the bit field in the 64-bit MSR.
6826 Reads the 64-bit MSR specified by Index, performs a bitwise OR
6827 between the read result and the value specified by OrData, and writes the
6828 result to the 64-bit MSR specified by Index. The lower 32-bits of the value
6829 written to the MSR are returned. Extra left bits in OrData are stripped. The
6830 caller must either guarantee that Index and the data written is valid, or
6831 the caller must set up exception handlers to catch the exceptions. This
6832 function is only available on IA-32 and x64.
6834 If StartBit is greater than 31, then ASSERT().
6835 If EndBit is greater than 31, then ASSERT().
6836 If EndBit is less than StartBit, then ASSERT().
6837 If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
6839 @param Index The 32-bit MSR index to write.
6840 @param StartBit The ordinal of the least significant bit in the bit field.
6842 @param EndBit The ordinal of the most significant bit in the bit field.
6844 @param OrData The value to OR with the read value from the MSR.
6846 @return The lower 32-bit of the value written to the MSR.
6851 AsmMsrBitFieldOr32 (
6860 Reads a bit field in a 64-bit MSR, performs a bitwise AND, and writes the
6861 result back to the bit field in the 64-bit MSR.
6863 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
6864 read result and the value specified by AndData, and writes the result to the
6865 64-bit MSR specified by Index. The lower 32-bits of the value written to the
6866 MSR are returned. Extra left bits in AndData are stripped. The caller must
6867 either guarantee that Index and the data written is valid, or the caller must
6868 set up exception handlers to catch the exceptions. This function is only
6869 available on IA-32 and x64.
6871 If StartBit is greater than 31, then ASSERT().
6872 If EndBit is greater than 31, then ASSERT().
6873 If EndBit is less than StartBit, then ASSERT().
6874 If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
6876 @param Index The 32-bit MSR index to write.
6877 @param StartBit The ordinal of the least significant bit in the bit field.
6879 @param EndBit The ordinal of the most significant bit in the bit field.
6881 @param AndData The value to AND with the read value from the MSR.
6883 @return The lower 32-bit of the value written to the MSR.
6888 AsmMsrBitFieldAnd32 (
6897 Reads a bit field in a 64-bit MSR, performs a bitwise AND followed by a
6898 bitwise OR, and writes the result back to the bit field in the
6901 Reads the 64-bit MSR specified by Index, performs a bitwise AND followed by a
6902 bitwise OR between the read result and the value specified by
6903 AndData, and writes the result to the 64-bit MSR specified by Index. The
6904 lower 32-bits of the value written to the MSR are returned. Extra left bits
6905 in both AndData and OrData are stripped. The caller must either guarantee
6906 that Index and the data written is valid, or the caller must set up exception
6907 handlers to catch the exceptions. This function is only available on IA-32
6910 If StartBit is greater than 31, then ASSERT().
6911 If EndBit is greater than 31, then ASSERT().
6912 If EndBit is less than StartBit, then ASSERT().
6913 If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
6914 If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
6916 @param Index The 32-bit MSR index to write.
6917 @param StartBit The ordinal of the least significant bit in the bit field.
6919 @param EndBit The ordinal of the most significant bit in the bit field.
6921 @param AndData The value to AND with the read value from the MSR.
6922 @param OrData The value to OR with the result of the AND operation.
6924 @return The lower 32-bit of the value written to the MSR.
6929 AsmMsrBitFieldAndThenOr32 (
6939 Returns a 64-bit Machine Specific Register(MSR).
6941 Reads and returns the 64-bit MSR specified by Index. No parameter checking is
6942 performed on Index, and some Index values may cause CPU exceptions. The
6943 caller must either guarantee that Index is valid, or the caller must set up
6944 exception handlers to catch the exceptions. This function is only available
6947 @param Index The 32-bit MSR index to read.
6949 @return The value of the MSR identified by Index.
6960 Writes a 64-bit value to a Machine Specific Register(MSR), and returns the
6963 Writes the 64-bit value specified by Value to the MSR specified by Index. The
6964 64-bit value written to the MSR is returned. No parameter checking is
6965 performed on Index or Value, and some of these may cause CPU exceptions. The
6966 caller must either guarantee that Index and Value are valid, or the caller
6967 must establish proper exception handlers. This function is only available on
6970 @param Index The 32-bit MSR index to write.
6971 @param Value The 64-bit value to write to the MSR.
6985 Reads a 64-bit MSR, performs a bitwise OR, and writes the result
6986 back to the 64-bit MSR.
6988 Reads the 64-bit MSR specified by Index, performs a bitwise OR
6989 between the read result and the value specified by OrData, and writes the
6990 result to the 64-bit MSR specified by Index. The value written to the MSR is
6991 returned. No parameter checking is performed on Index or OrData, and some of
6992 these may cause CPU exceptions. The caller must either guarantee that Index
6993 and OrData are valid, or the caller must establish proper exception handlers.
6994 This function is only available on IA-32 and x64.
6996 @param Index The 32-bit MSR index to write.
6997 @param OrData The value to OR with the read value from the MSR.
6999 @return The value written back to the MSR.
7011 Reads a 64-bit MSR, performs a bitwise AND, and writes the result back to the
7014 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
7015 read result and the value specified by OrData, and writes the result to the
7016 64-bit MSR specified by Index. The value written to the MSR is returned. No
7017 parameter checking is performed on Index or OrData, and some of these may
7018 cause CPU exceptions. The caller must either guarantee that Index and OrData
7019 are valid, or the caller must establish proper exception handlers. This
7020 function is only available on IA-32 and x64.
7022 @param Index The 32-bit MSR index to write.
7023 @param AndData The value to AND with the read value from the MSR.
7025 @return The value written back to the MSR.
7037 Reads a 64-bit MSR, performs a bitwise AND followed by a bitwise
7038 OR, and writes the result back to the 64-bit MSR.
7040 Reads the 64-bit MSR specified by Index, performs a bitwise AND between read
7041 result and the value specified by AndData, performs a bitwise OR
7042 between the result of the AND operation and the value specified by OrData,
7043 and writes the result to the 64-bit MSR specified by Index. The value written
7044 to the MSR is returned. No parameter checking is performed on Index, AndData,
7045 or OrData, and some of these may cause CPU exceptions. The caller must either
7046 guarantee that Index, AndData, and OrData are valid, or the caller must
7047 establish proper exception handlers. This function is only available on IA-32
7050 @param Index The 32-bit MSR index to write.
7051 @param AndData The value to AND with the read value from the MSR.
7052 @param OrData The value to OR with the result of the AND operation.
7054 @return The value written back to the MSR.
7067 Reads a bit field of an MSR.
7069 Reads the bit field in the 64-bit MSR. The bit field is specified by the
7070 StartBit and the EndBit. The value of the bit field is returned. The caller
7071 must either guarantee that Index is valid, or the caller must set up
7072 exception handlers to catch the exceptions. This function is only available
7075 If StartBit is greater than 63, then ASSERT().
7076 If EndBit is greater than 63, then ASSERT().
7077 If EndBit is less than StartBit, then ASSERT().
7079 @param Index The 32-bit MSR index to read.
7080 @param StartBit The ordinal of the least significant bit in the bit field.
7082 @param EndBit The ordinal of the most significant bit in the bit field.
7085 @return The value read from the MSR.
7090 AsmMsrBitFieldRead64 (
7098 Writes a bit field to an MSR.
7100 Writes Value to a bit field in a 64-bit MSR. The bit field is specified by
7101 the StartBit and the EndBit. All other bits in the destination MSR are
7102 preserved. The MSR written is returned. The caller must either guarantee
7103 that Index and the data written is valid, or the caller must set up exception
7104 handlers to catch the exceptions. This function is only available on IA-32 and x64.
7106 If StartBit is greater than 63, then ASSERT().
7107 If EndBit is greater than 63, then ASSERT().
7108 If EndBit is less than StartBit, then ASSERT().
7109 If Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
7111 @param Index The 32-bit MSR index to write.
7112 @param StartBit The ordinal of the least significant bit in the bit field.
7114 @param EndBit The ordinal of the most significant bit in the bit field.
7116 @param Value New value of the bit field.
7118 @return The value written back to the MSR.
7123 AsmMsrBitFieldWrite64 (
7132 Reads a bit field in a 64-bit MSR, performs a bitwise OR, and
7133 writes the result back to the bit field in the 64-bit MSR.
7135 Reads the 64-bit MSR specified by Index, performs a bitwise OR
7136 between the read result and the value specified by OrData, and writes the
7137 result to the 64-bit MSR specified by Index. The value written to the MSR is
7138 returned. Extra left bits in OrData are stripped. The caller must either
7139 guarantee that Index and the data written is valid, or the caller must set up
7140 exception handlers to catch the exceptions. This function is only available
7143 If StartBit is greater than 63, then ASSERT().
7144 If EndBit is greater than 63, then ASSERT().
7145 If EndBit is less than StartBit, then ASSERT().
7146 If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
7148 @param Index The 32-bit MSR index to write.
7149 @param StartBit The ordinal of the least significant bit in the bit field.
7151 @param EndBit The ordinal of the most significant bit in the bit field.
7153 @param OrData The value to OR with the read value from the bit field.
7155 @return The value written back to the MSR.
7160 AsmMsrBitFieldOr64 (
7169 Reads a bit field in a 64-bit MSR, performs a bitwise AND, and writes the
7170 result back to the bit field in the 64-bit MSR.
7172 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
7173 read result and the value specified by AndData, and writes the result to the
7174 64-bit MSR specified by Index. The value written to the MSR is returned.
7175 Extra left bits in AndData are stripped. The caller must either guarantee
7176 that Index and the data written is valid, or the caller must set up exception
7177 handlers to catch the exceptions. This function is only available on IA-32
7180 If StartBit is greater than 63, then ASSERT().
7181 If EndBit is greater than 63, then ASSERT().
7182 If EndBit is less than StartBit, then ASSERT().
7183 If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
7185 @param Index The 32-bit MSR index to write.
7186 @param StartBit The ordinal of the least significant bit in the bit field.
7188 @param EndBit The ordinal of the most significant bit in the bit field.
7190 @param AndData The value to AND with the read value from the bit field.
7192 @return The value written back to the MSR.
7197 AsmMsrBitFieldAnd64 (
7206 Reads a bit field in a 64-bit MSR, performs a bitwise AND followed by a
7207 bitwise OR, and writes the result back to the bit field in the
7210 Reads the 64-bit MSR specified by Index, performs a bitwise AND followed by
7211 a bitwise OR between the read result and the value specified by
7212 AndData, and writes the result to the 64-bit MSR specified by Index. The
7213 value written to the MSR is returned. Extra left bits in both AndData and
7214 OrData are stripped. The caller must either guarantee that Index and the data
7215 written is valid, or the caller must set up exception handlers to catch the
7216 exceptions. This function is only available on IA-32 and x64.
7218 If StartBit is greater than 63, then ASSERT().
7219 If EndBit is greater than 63, then ASSERT().
7220 If EndBit is less than StartBit, then ASSERT().
7221 If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
7222 If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
7224 @param Index The 32-bit MSR index to write.
7225 @param StartBit The ordinal of the least significant bit in the bit field.
7227 @param EndBit The ordinal of the most significant bit in the bit field.
7229 @param AndData The value to AND with the read value from the bit field.
7230 @param OrData The value to OR with the result of the AND operation.
7232 @return The value written back to the MSR.
7237 AsmMsrBitFieldAndThenOr64 (
7247 Reads the current value of the EFLAGS register.
7249 Reads and returns the current value of the EFLAGS register. This function is
7250 only available on IA-32 and x64. This returns a 32-bit value on IA-32 and a
7251 64-bit value on x64.
7253 @return EFLAGS on IA-32 or RFLAGS on x64.
7264 Reads the current value of the Control Register 0 (CR0).
7266 Reads and returns the current value of CR0. This function is only available
7267 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
7270 @return The value of the Control Register 0 (CR0).
7281 Reads the current value of the Control Register 2 (CR2).
7283 Reads and returns the current value of CR2. This function is only available
7284 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
7287 @return The value of the Control Register 2 (CR2).
7298 Reads the current value of the Control Register 3 (CR3).
7300 Reads and returns the current value of CR3. This function is only available
7301 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
7304 @return The value of the Control Register 3 (CR3).
7315 Reads the current value of the Control Register 4 (CR4).
7317 Reads and returns the current value of CR4. This function is only available
7318 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
7321 @return The value of the Control Register 4 (CR4).
7332 Writes a value to Control Register 0 (CR0).
7334 Writes and returns a new value to CR0. This function is only available on
7335 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
7337 @param Cr0 The value to write to CR0.
7339 @return The value written to CR0.
7350 Writes a value to Control Register 2 (CR2).
7352 Writes and returns a new value to CR2. This function is only available on
7353 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
7355 @param Cr2 The value to write to CR2.
7357 @return The value written to CR2.
7368 Writes a value to Control Register 3 (CR3).
7370 Writes and returns a new value to CR3. This function is only available on
7371 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
7373 @param Cr3 The value to write to CR3.
7375 @return The value written to CR3.
7386 Writes a value to Control Register 4 (CR4).
7388 Writes and returns a new value to CR4. This function is only available on
7389 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
7391 @param Cr4 The value to write to CR4.
7393 @return The value written to CR4.
7404 Reads the current value of Debug Register 0 (DR0).
7406 Reads and returns the current value of DR0. This function is only available
7407 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
7410 @return The value of Debug Register 0 (DR0).
7421 Reads the current value of Debug Register 1 (DR1).
7423 Reads and returns the current value of DR1. This function is only available
7424 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
7427 @return The value of Debug Register 1 (DR1).
7438 Reads the current value of Debug Register 2 (DR2).
7440 Reads and returns the current value of DR2. This function is only available
7441 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
7444 @return The value of Debug Register 2 (DR2).
7455 Reads the current value of Debug Register 3 (DR3).
7457 Reads and returns the current value of DR3. This function is only available
7458 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
7461 @return The value of Debug Register 3 (DR3).
7472 Reads the current value of Debug Register 4 (DR4).
7474 Reads and returns the current value of DR4. This function is only available
7475 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
7478 @return The value of Debug Register 4 (DR4).
7489 Reads the current value of Debug Register 5 (DR5).
7491 Reads and returns the current value of DR5. This function is only available
7492 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
7495 @return The value of Debug Register 5 (DR5).
7506 Reads the current value of Debug Register 6 (DR6).
7508 Reads and returns the current value of DR6. This function is only available
7509 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
7512 @return The value of Debug Register 6 (DR6).
7523 Reads the current value of Debug Register 7 (DR7).
7525 Reads and returns the current value of DR7. This function is only available
7526 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
7529 @return The value of Debug Register 7 (DR7).
7540 Writes a value to Debug Register 0 (DR0).
7542 Writes and returns a new value to DR0. This function is only available on
7543 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
7545 @param Dr0 The value to write to Dr0.
7547 @return The value written to Debug Register 0 (DR0).
7558 Writes a value to Debug Register 1 (DR1).
7560 Writes and returns a new value to DR1. This function is only available on
7561 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
7563 @param Dr1 The value to write to Dr1.
7565 @return The value written to Debug Register 1 (DR1).
7576 Writes a value to Debug Register 2 (DR2).
7578 Writes and returns a new value to DR2. This function is only available on
7579 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
7581 @param Dr2 The value to write to Dr2.
7583 @return The value written to Debug Register 2 (DR2).
7594 Writes a value to Debug Register 3 (DR3).
7596 Writes and returns a new value to DR3. This function is only available on
7597 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
7599 @param Dr3 The value to write to Dr3.
7601 @return The value written to Debug Register 3 (DR3).
7612 Writes a value to Debug Register 4 (DR4).
7614 Writes and returns a new value to DR4. This function is only available on
7615 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
7617 @param Dr4 The value to write to Dr4.
7619 @return The value written to Debug Register 4 (DR4).
7630 Writes a value to Debug Register 5 (DR5).
7632 Writes and returns a new value to DR5. This function is only available on
7633 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
7635 @param Dr5 The value to write to Dr5.
7637 @return The value written to Debug Register 5 (DR5).
7648 Writes a value to Debug Register 6 (DR6).
7650 Writes and returns a new value to DR6. This function is only available on
7651 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
7653 @param Dr6 The value to write to Dr6.
7655 @return The value written to Debug Register 6 (DR6).
7666 Writes a value to Debug Register 7 (DR7).
7668 Writes and returns a new value to DR7. This function is only available on
7669 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
7671 @param Dr7 The value to write to Dr7.
7673 @return The value written to Debug Register 7 (DR7).
7684 Reads the current value of Code Segment Register (CS).
7686 Reads and returns the current value of CS. This function is only available on
7689 @return The current value of CS.
7700 Reads the current value of Data Segment Register (DS).
7702 Reads and returns the current value of DS. This function is only available on
7705 @return The current value of DS.
7716 Reads the current value of Extra Segment Register (ES).
7718 Reads and returns the current value of ES. This function is only available on
7721 @return The current value of ES.
7732 Reads the current value of FS Data Segment Register (FS).
7734 Reads and returns the current value of FS. This function is only available on
7737 @return The current value of FS.
7748 Reads the current value of GS Data Segment Register (GS).
7750 Reads and returns the current value of GS. This function is only available on
7753 @return The current value of GS.
7764 Reads the current value of Stack Segment Register (SS).
7766 Reads and returns the current value of SS. This function is only available on
7769 @return The current value of SS.
7780 Reads the current value of Task Register (TR).
7782 Reads and returns the current value of TR. This function is only available on
7785 @return The current value of TR.
7796 Reads the current Global Descriptor Table Register(GDTR) descriptor.
7798 Reads and returns the current GDTR descriptor and returns it in Gdtr. This
7799 function is only available on IA-32 and x64.
7801 If Gdtr is NULL, then ASSERT().
7803 @param Gdtr The pointer to a GDTR descriptor.
7809 OUT IA32_DESCRIPTOR
*Gdtr
7814 Writes the current Global Descriptor Table Register (GDTR) descriptor.
7816 Writes and the current GDTR descriptor specified by Gdtr. This function is
7817 only available on IA-32 and x64.
7819 If Gdtr is NULL, then ASSERT().
7821 @param Gdtr The pointer to a GDTR descriptor.
7827 IN CONST IA32_DESCRIPTOR
*Gdtr
7832 Reads the current Interrupt Descriptor Table Register(IDTR) descriptor.
7834 Reads and returns the current IDTR descriptor and returns it in Idtr. This
7835 function is only available on IA-32 and x64.
7837 If Idtr is NULL, then ASSERT().
7839 @param Idtr The pointer to a IDTR descriptor.
7845 OUT IA32_DESCRIPTOR
*Idtr
7850 Writes the current Interrupt Descriptor Table Register(IDTR) descriptor.
7852 Writes the current IDTR descriptor and returns it in Idtr. This function is
7853 only available on IA-32 and x64.
7855 If Idtr is NULL, then ASSERT().
7857 @param Idtr The pointer to a IDTR descriptor.
7863 IN CONST IA32_DESCRIPTOR
*Idtr
7868 Reads the current Local Descriptor Table Register(LDTR) selector.
7870 Reads and returns the current 16-bit LDTR descriptor value. This function is
7871 only available on IA-32 and x64.
7873 @return The current selector of LDT.
7884 Writes the current Local Descriptor Table Register (LDTR) selector.
7886 Writes and the current LDTR descriptor specified by Ldtr. This function is
7887 only available on IA-32 and x64.
7889 @param Ldtr 16-bit LDTR selector value.
7900 Save the current floating point/SSE/SSE2 context to a buffer.
7902 Saves the current floating point/SSE/SSE2 state to the buffer specified by
7903 Buffer. Buffer must be aligned on a 16-byte boundary. This function is only
7904 available on IA-32 and x64.
7906 If Buffer is NULL, then ASSERT().
7907 If Buffer is not aligned on a 16-byte boundary, then ASSERT().
7909 @param Buffer The pointer to a buffer to save the floating point/SSE/SSE2 context.
7915 OUT IA32_FX_BUFFER
*Buffer
7920 Restores the current floating point/SSE/SSE2 context from a buffer.
7922 Restores the current floating point/SSE/SSE2 state from the buffer specified
7923 by Buffer. Buffer must be aligned on a 16-byte boundary. This function is
7924 only available on IA-32 and x64.
7926 If Buffer is NULL, then ASSERT().
7927 If Buffer is not aligned on a 16-byte boundary, then ASSERT().
7928 If Buffer was not saved with AsmFxSave(), then ASSERT().
7930 @param Buffer The pointer to a buffer to save the floating point/SSE/SSE2 context.
7936 IN CONST IA32_FX_BUFFER
*Buffer
7941 Reads the current value of 64-bit MMX Register #0 (MM0).
7943 Reads and returns the current value of MM0. This function is only available
7946 @return The current value of MM0.
7957 Reads the current value of 64-bit MMX Register #1 (MM1).
7959 Reads and returns the current value of MM1. This function is only available
7962 @return The current value of MM1.
7973 Reads the current value of 64-bit MMX Register #2 (MM2).
7975 Reads and returns the current value of MM2. This function is only available
7978 @return The current value of MM2.
7989 Reads the current value of 64-bit MMX Register #3 (MM3).
7991 Reads and returns the current value of MM3. This function is only available
7994 @return The current value of MM3.
8005 Reads the current value of 64-bit MMX Register #4 (MM4).
8007 Reads and returns the current value of MM4. This function is only available
8010 @return The current value of MM4.
8021 Reads the current value of 64-bit MMX Register #5 (MM5).
8023 Reads and returns the current value of MM5. This function is only available
8026 @return The current value of MM5.
8037 Reads the current value of 64-bit MMX Register #6 (MM6).
8039 Reads and returns the current value of MM6. This function is only available
8042 @return The current value of MM6.
8053 Reads the current value of 64-bit MMX Register #7 (MM7).
8055 Reads and returns the current value of MM7. This function is only available
8058 @return The current value of MM7.
8069 Writes the current value of 64-bit MMX Register #0 (MM0).
8071 Writes the current value of MM0. This function is only available on IA32 and
8074 @param Value The 64-bit value to write to MM0.
8085 Writes the current value of 64-bit MMX Register #1 (MM1).
8087 Writes the current value of MM1. This function is only available on IA32 and
8090 @param Value The 64-bit value to write to MM1.
8101 Writes the current value of 64-bit MMX Register #2 (MM2).
8103 Writes the current value of MM2. This function is only available on IA32 and
8106 @param Value The 64-bit value to write to MM2.
8117 Writes the current value of 64-bit MMX Register #3 (MM3).
8119 Writes the current value of MM3. This function is only available on IA32 and
8122 @param Value The 64-bit value to write to MM3.
8133 Writes the current value of 64-bit MMX Register #4 (MM4).
8135 Writes the current value of MM4. This function is only available on IA32 and
8138 @param Value The 64-bit value to write to MM4.
8149 Writes the current value of 64-bit MMX Register #5 (MM5).
8151 Writes the current value of MM5. This function is only available on IA32 and
8154 @param Value The 64-bit value to write to MM5.
8165 Writes the current value of 64-bit MMX Register #6 (MM6).
8167 Writes the current value of MM6. This function is only available on IA32 and
8170 @param Value The 64-bit value to write to MM6.
8181 Writes the current value of 64-bit MMX Register #7 (MM7).
8183 Writes the current value of MM7. This function is only available on IA32 and
8186 @param Value The 64-bit value to write to MM7.
8197 Reads the current value of Time Stamp Counter (TSC).
8199 Reads and returns the current value of TSC. This function is only available
8202 @return The current value of TSC
8213 Reads the current value of a Performance Counter (PMC).
8215 Reads and returns the current value of performance counter specified by
8216 Index. This function is only available on IA-32 and x64.
8218 @param Index The 32-bit Performance Counter index to read.
8220 @return The value of the PMC specified by Index.
8231 Sets up a monitor buffer that is used by AsmMwait().
8233 Executes a MONITOR instruction with the register state specified by Eax, Ecx
8234 and Edx. Returns Eax. This function is only available on IA-32 and x64.
8236 @param Eax The value to load into EAX or RAX before executing the MONITOR
8238 @param Ecx The value to load into ECX or RCX before executing the MONITOR
8240 @param Edx The value to load into EDX or RDX before executing the MONITOR
8256 Executes an MWAIT instruction.
8258 Executes an MWAIT instruction with the register state specified by Eax and
8259 Ecx. Returns Eax. This function is only available on IA-32 and x64.
8261 @param Eax The value to load into EAX or RAX before executing the MONITOR
8263 @param Ecx The value to load into ECX or RCX before executing the MONITOR
8278 Executes a WBINVD instruction.
8280 Executes a WBINVD instruction. This function is only available on IA-32 and
8292 Executes a INVD instruction.
8294 Executes a INVD instruction. This function is only available on IA-32 and
8306 Flushes a cache line from all the instruction and data caches within the
8307 coherency domain of the CPU.
8309 Flushed the cache line specified by LinearAddress, and returns LinearAddress.
8310 This function is only available on IA-32 and x64.
8312 @param LinearAddress The address of the cache line to flush. If the CPU is
8313 in a physical addressing mode, then LinearAddress is a
8314 physical address. If the CPU is in a virtual
8315 addressing mode, then LinearAddress is a virtual
8318 @return LinearAddress.
8323 IN VOID
*LinearAddress
8328 Enables the 32-bit paging mode on the CPU.
8330 Enables the 32-bit paging mode on the CPU. CR0, CR3, CR4, and the page tables
8331 must be properly initialized prior to calling this service. This function
8332 assumes the current execution mode is 32-bit protected mode. This function is
8333 only available on IA-32. After the 32-bit paging mode is enabled, control is
8334 transferred to the function specified by EntryPoint using the new stack
8335 specified by NewStack and passing in the parameters specified by Context1 and
8336 Context2. Context1 and Context2 are optional and may be NULL. The function
8337 EntryPoint must never return.
8339 If the current execution mode is not 32-bit protected mode, then ASSERT().
8340 If EntryPoint is NULL, then ASSERT().
8341 If NewStack is NULL, then ASSERT().
8343 There are a number of constraints that must be followed before calling this
8345 1) Interrupts must be disabled.
8346 2) The caller must be in 32-bit protected mode with flat descriptors. This
8347 means all descriptors must have a base of 0 and a limit of 4GB.
8348 3) CR0 and CR4 must be compatible with 32-bit protected mode with flat
8350 4) CR3 must point to valid page tables that will be used once the transition
8351 is complete, and those page tables must guarantee that the pages for this
8352 function and the stack are identity mapped.
8354 @param EntryPoint A pointer to function to call with the new stack after
8356 @param Context1 A pointer to the context to pass into the EntryPoint
8357 function as the first parameter after paging is enabled.
8358 @param Context2 A pointer to the context to pass into the EntryPoint
8359 function as the second parameter after paging is enabled.
8360 @param NewStack A pointer to the new stack to use for the EntryPoint
8361 function after paging is enabled.
8367 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
8368 IN VOID
*Context1
, OPTIONAL
8369 IN VOID
*Context2
, OPTIONAL
8375 Disables the 32-bit paging mode on the CPU.
8377 Disables the 32-bit paging mode on the CPU and returns to 32-bit protected
8378 mode. This function assumes the current execution mode is 32-paged protected
8379 mode. This function is only available on IA-32. After the 32-bit paging mode
8380 is disabled, control is transferred to the function specified by EntryPoint
8381 using the new stack specified by NewStack and passing in the parameters
8382 specified by Context1 and Context2. Context1 and Context2 are optional and
8383 may be NULL. The function EntryPoint must never return.
8385 If the current execution mode is not 32-bit paged mode, then ASSERT().
8386 If EntryPoint is NULL, then ASSERT().
8387 If NewStack is NULL, then ASSERT().
8389 There are a number of constraints that must be followed before calling this
8391 1) Interrupts must be disabled.
8392 2) The caller must be in 32-bit paged mode.
8393 3) CR0, CR3, and CR4 must be compatible with 32-bit paged mode.
8394 4) CR3 must point to valid page tables that guarantee that the pages for
8395 this function and the stack are identity mapped.
8397 @param EntryPoint A pointer to function to call with the new stack after
8399 @param Context1 A pointer to the context to pass into the EntryPoint
8400 function as the first parameter after paging is disabled.
8401 @param Context2 A pointer to the context to pass into the EntryPoint
8402 function as the second parameter after paging is
8404 @param NewStack A pointer to the new stack to use for the EntryPoint
8405 function after paging is disabled.
8410 AsmDisablePaging32 (
8411 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
8412 IN VOID
*Context1
, OPTIONAL
8413 IN VOID
*Context2
, OPTIONAL
8419 Enables the 64-bit paging mode on the CPU.
8421 Enables the 64-bit paging mode on the CPU. CR0, CR3, CR4, and the page tables
8422 must be properly initialized prior to calling this service. This function
8423 assumes the current execution mode is 32-bit protected mode with flat
8424 descriptors. This function is only available on IA-32. After the 64-bit
8425 paging mode is enabled, control is transferred to the function specified by
8426 EntryPoint using the new stack specified by NewStack and passing in the
8427 parameters specified by Context1 and Context2. Context1 and Context2 are
8428 optional and may be 0. The function EntryPoint must never return.
8430 If the current execution mode is not 32-bit protected mode with flat
8431 descriptors, then ASSERT().
8432 If EntryPoint is 0, then ASSERT().
8433 If NewStack is 0, then ASSERT().
8435 @param Cs The 16-bit selector to load in the CS before EntryPoint
8436 is called. The descriptor in the GDT that this selector
8437 references must be setup for long mode.
8438 @param EntryPoint The 64-bit virtual address of the function to call with
8439 the new stack after paging is enabled.
8440 @param Context1 The 64-bit virtual address of the context to pass into
8441 the EntryPoint function as the first parameter after
8443 @param Context2 The 64-bit virtual address of the context to pass into
8444 the EntryPoint function as the second parameter after
8446 @param NewStack The 64-bit virtual address of the new stack to use for
8447 the EntryPoint function after paging is enabled.
8454 IN UINT64 EntryPoint
,
8455 IN UINT64 Context1
, OPTIONAL
8456 IN UINT64 Context2
, OPTIONAL
8462 Disables the 64-bit paging mode on the CPU.
8464 Disables the 64-bit paging mode on the CPU and returns to 32-bit protected
8465 mode. This function assumes the current execution mode is 64-paging mode.
8466 This function is only available on x64. After the 64-bit paging mode is
8467 disabled, control is transferred to the function specified by EntryPoint
8468 using the new stack specified by NewStack and passing in the parameters
8469 specified by Context1 and Context2. Context1 and Context2 are optional and
8470 may be 0. The function EntryPoint must never return.
8472 If the current execution mode is not 64-bit paged mode, then ASSERT().
8473 If EntryPoint is 0, then ASSERT().
8474 If NewStack is 0, then ASSERT().
8476 @param Cs The 16-bit selector to load in the CS before EntryPoint
8477 is called. The descriptor in the GDT that this selector
8478 references must be setup for 32-bit protected mode.
8479 @param EntryPoint The 64-bit virtual address of the function to call with
8480 the new stack after paging is disabled.
8481 @param Context1 The 64-bit virtual address of the context to pass into
8482 the EntryPoint function as the first parameter after
8484 @param Context2 The 64-bit virtual address of the context to pass into
8485 the EntryPoint function as the second parameter after
8487 @param NewStack The 64-bit virtual address of the new stack to use for
8488 the EntryPoint function after paging is disabled.
8493 AsmDisablePaging64 (
8495 IN UINT32 EntryPoint
,
8496 IN UINT32 Context1
, OPTIONAL
8497 IN UINT32 Context2
, OPTIONAL
8503 // 16-bit thunking services
8507 Retrieves the properties for 16-bit thunk functions.
8509 Computes the size of the buffer and stack below 1MB required to use the
8510 AsmPrepareThunk16(), AsmThunk16() and AsmPrepareAndThunk16() functions. This
8511 buffer size is returned in RealModeBufferSize, and the stack size is returned
8512 in ExtraStackSize. If parameters are passed to the 16-bit real mode code,
8513 then the actual minimum stack size is ExtraStackSize plus the maximum number
8514 of bytes that need to be passed to the 16-bit real mode code.
8516 If RealModeBufferSize is NULL, then ASSERT().
8517 If ExtraStackSize is NULL, then ASSERT().
8519 @param RealModeBufferSize A pointer to the size of the buffer below 1MB
8520 required to use the 16-bit thunk functions.
8521 @param ExtraStackSize A pointer to the extra size of stack below 1MB
8522 that the 16-bit thunk functions require for
8523 temporary storage in the transition to and from
8529 AsmGetThunk16Properties (
8530 OUT UINT32
*RealModeBufferSize
,
8531 OUT UINT32
*ExtraStackSize
8536 Prepares all structures a code required to use AsmThunk16().
8538 Prepares all structures and code required to use AsmThunk16().
8540 This interface is limited to be used in either physical mode or virtual modes with paging enabled where the
8541 virtual to physical mappings for ThunkContext.RealModeBuffer is mapped 1:1.
8543 If ThunkContext is NULL, then ASSERT().
8545 @param ThunkContext A pointer to the context structure that describes the
8546 16-bit real mode code to call.
8552 IN OUT THUNK_CONTEXT
*ThunkContext
8557 Transfers control to a 16-bit real mode entry point and returns the results.
8559 Transfers control to a 16-bit real mode entry point and returns the results.
8560 AsmPrepareThunk16() must be called with ThunkContext before this function is used.
8561 This function must be called with interrupts disabled.
8563 The register state from the RealModeState field of ThunkContext is restored just prior
8564 to calling the 16-bit real mode entry point. This includes the EFLAGS field of RealModeState,
8565 which is used to set the interrupt state when a 16-bit real mode entry point is called.
8566 Control is transferred to the 16-bit real mode entry point specified by the CS and Eip fields of RealModeState.
8567 The stack is initialized to the SS and ESP fields of RealModeState. Any parameters passed to
8568 the 16-bit real mode code must be populated by the caller at SS:ESP prior to calling this function.
8569 The 16-bit real mode entry point is invoked with a 16-bit CALL FAR instruction,
8570 so when accessing stack contents, the 16-bit real mode code must account for the 16-bit segment
8571 and 16-bit offset of the return address that were pushed onto the stack. The 16-bit real mode entry
8572 point must exit with a RETF instruction. The register state is captured into RealModeState immediately
8573 after the RETF instruction is executed.
8575 If EFLAGS specifies interrupts enabled, or any of the 16-bit real mode code enables interrupts,
8576 or any of the 16-bit real mode code makes a SW interrupt, then the caller is responsible for making sure
8577 the IDT at address 0 is initialized to handle any HW or SW interrupts that may occur while in 16-bit real mode.
8579 If EFLAGS specifies interrupts enabled, or any of the 16-bit real mode code enables interrupts,
8580 then the caller is responsible for making sure the 8259 PIC is in a state compatible with 16-bit real mode.
8581 This includes the base vectors, the interrupt masks, and the edge/level trigger mode.
8583 If THUNK_ATTRIBUTE_BIG_REAL_MODE is set in the ThunkAttributes field of ThunkContext, then the user code
8584 is invoked in big real mode. Otherwise, the user code is invoked in 16-bit real mode with 64KB segment limits.
8586 If neither THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 nor THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL are set in
8587 ThunkAttributes, then it is assumed that the user code did not enable the A20 mask, and no attempt is made to
8588 disable the A20 mask.
8590 If THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 is set and THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL is clear in
8591 ThunkAttributes, then attempt to use the INT 15 service to disable the A20 mask. If this INT 15 call fails,
8592 then attempt to disable the A20 mask by directly accessing the 8042 keyboard controller I/O ports.
8594 If THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 is clear and THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL is set in
8595 ThunkAttributes, then attempt to disable the A20 mask by directly accessing the 8042 keyboard controller I/O ports.
8597 If ThunkContext is NULL, then ASSERT().
8598 If AsmPrepareThunk16() was not previously called with ThunkContext, then ASSERT().
8599 If both THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 and THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL are set in
8600 ThunkAttributes, then ASSERT().
8602 This interface is limited to be used in either physical mode or virtual modes with paging enabled where the
8603 virtual to physical mappings for ThunkContext.RealModeBuffer are mapped 1:1.
8605 @param ThunkContext A pointer to the context structure that describes the
8606 16-bit real mode code to call.
8612 IN OUT THUNK_CONTEXT
*ThunkContext
8617 Prepares all structures and code for a 16-bit real mode thunk, transfers
8618 control to a 16-bit real mode entry point, and returns the results.
8620 Prepares all structures and code for a 16-bit real mode thunk, transfers
8621 control to a 16-bit real mode entry point, and returns the results. If the
8622 caller only need to perform a single 16-bit real mode thunk, then this
8623 service should be used. If the caller intends to make more than one 16-bit
8624 real mode thunk, then it is more efficient if AsmPrepareThunk16() is called
8625 once and AsmThunk16() can be called for each 16-bit real mode thunk.
8627 This interface is limited to be used in either physical mode or virtual modes with paging enabled where the
8628 virtual to physical mappings for ThunkContext.RealModeBuffer is mapped 1:1.
8630 See AsmPrepareThunk16() and AsmThunk16() for the detailed description and ASSERT() conditions.
8632 @param ThunkContext A pointer to the context structure that describes the
8633 16-bit real mode code to call.
8638 AsmPrepareAndThunk16 (
8639 IN OUT THUNK_CONTEXT
*ThunkContext
8643 Generates a 16-bit random number through RDRAND instruction.
8645 if Rand is NULL, then ASSERT().
8647 @param[out] Rand Buffer pointer to store the random result.
8649 @retval TRUE RDRAND call was successful.
8650 @retval FALSE Failed attempts to call RDRAND.
8660 Generates a 32-bit random number through RDRAND instruction.
8662 if Rand is NULL, then ASSERT().
8664 @param[out] Rand Buffer pointer to store the random result.
8666 @retval TRUE RDRAND call was successful.
8667 @retval FALSE Failed attempts to call RDRAND.
8677 Generates a 64-bit random number through RDRAND instruction.
8679 if Rand is NULL, then ASSERT().
8681 @param[out] Rand Buffer pointer to store the random result.
8683 @retval TRUE RDRAND call was successful.
8684 @retval FALSE Failed attempts to call RDRAND.