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
2422 Convert a Null-terminated ASCII string to IPv6 address and prefix length.
2424 This function outputs a value of type IPv6_ADDRESS and may output a value
2425 of type UINT8 by interpreting the contents of the ASCII string specified
2426 by String. The format of the input ASCII string String is as follows:
2430 X contains one to four hexadecimal digit characters in the range [0-9], [a-f] and
2431 [A-F]. X is converted to a value of type UINT16, whose low byte is stored in low
2432 memory address and high byte is stored in high memory address. P contains decimal
2433 digit characters in the range [0-9]. The running zero in the beginning of P will
2434 be ignored. /P is optional.
2436 When /P is not in the String, the function stops at the first character that is
2437 not a valid hexadecimal digit character after eight X's are converted.
2439 When /P is in the String, the function stops at the first character that is not
2440 a valid decimal digit character after P is converted.
2442 "::" can be used to compress one or more groups of X when X contains only 0.
2443 The "::" can only appear once in the String.
2445 If String is NULL, then ASSERT().
2447 If Address is NULL, then ASSERT().
2449 If EndPointer is not NULL and Address is translated from String, a pointer
2450 to the character that stopped the scan is stored at the location pointed to
2453 @param String Pointer to a Null-terminated ASCII string.
2454 @param EndPointer Pointer to character that stops scan.
2455 @param Address Pointer to the converted IPv6 address.
2456 @param PrefixLength Pointer to the converted IPv6 address prefix
2457 length. MAX_UINT8 is returned when /P is
2460 @retval RETURN_SUCCESS Address is translated from String.
2461 @retval RETURN_INVALID_PARAMETER If String is NULL.
2463 @retval RETURN_UNSUPPORTED If X contains more than four hexadecimal
2465 If String contains "::" and number of X
2467 If P starts with character that is not a
2468 valid decimal digit character.
2469 If the decimal number converted from P
2475 AsciiStrToIpv6Address (
2476 IN CONST CHAR8
*String
,
2477 OUT CHAR8
**EndPointer
, OPTIONAL
2478 OUT IPv6_ADDRESS
*Address
,
2479 OUT UINT8
*PrefixLength OPTIONAL
2483 Convert a Null-terminated ASCII string to IPv4 address and prefix length.
2485 This function outputs a value of type IPv4_ADDRESS and may output a value
2486 of type UINT8 by interpreting the contents of the ASCII string specified
2487 by String. The format of the input ASCII string String is as follows:
2491 D and P are decimal digit characters in the range [0-9]. The running zero in
2492 the beginning of D and P will be ignored. /P is optional.
2494 When /P is not in the String, the function stops at the first character that is
2495 not a valid decimal digit character after four D's are converted.
2497 When /P is in the String, the function stops at the first character that is not
2498 a valid decimal digit character after P is converted.
2500 If String is NULL, then ASSERT().
2502 If Address is NULL, then ASSERT().
2504 If EndPointer is not NULL and Address is translated from String, a pointer
2505 to the character that stopped the scan is stored at the location pointed to
2508 @param String Pointer to a Null-terminated ASCII string.
2509 @param EndPointer Pointer to character that stops scan.
2510 @param Address Pointer to the converted IPv4 address.
2511 @param PrefixLength Pointer to the converted IPv4 address prefix
2512 length. MAX_UINT8 is returned when /P is
2515 @retval RETURN_SUCCESS Address is translated from String.
2516 @retval RETURN_INVALID_PARAMETER If String is NULL.
2518 @retval RETURN_UNSUPPORTED If String is not in the correct format.
2519 If any decimal number converted from D
2521 If the decimal number converted from P
2527 AsciiStrToIpv4Address (
2528 IN CONST CHAR8
*String
,
2529 OUT CHAR8
**EndPointer
, OPTIONAL
2530 OUT IPv4_ADDRESS
*Address
,
2531 OUT UINT8
*PrefixLength OPTIONAL
2535 Convert a Null-terminated ASCII GUID string to a value of type
2538 This function outputs a GUID value by interpreting the contents of
2539 the ASCII string specified by String. The format of the input
2540 ASCII string String consists of 36 characters, as follows:
2542 aabbccdd-eeff-gghh-iijj-kkllmmnnoopp
2544 The pairs aa - pp are two characters in the range [0-9], [a-f] and
2545 [A-F], with each pair representing a single byte hexadecimal value.
2547 The mapping between String and the EFI_GUID structure is as follows:
2565 If String is NULL, then ASSERT().
2566 If Guid is NULL, then ASSERT().
2568 @param String Pointer to a Null-terminated ASCII string.
2569 @param Guid Pointer to the converted GUID.
2571 @retval RETURN_SUCCESS Guid is translated from String.
2572 @retval RETURN_INVALID_PARAMETER If String is NULL.
2574 @retval RETURN_UNSUPPORTED If String is not as the above format.
2580 IN CONST CHAR8
*String
,
2585 Convert a Null-terminated ASCII hexadecimal string to a byte array.
2587 This function outputs a byte array by interpreting the contents of
2588 the ASCII string specified by String in hexadecimal format. The format of
2589 the input ASCII string String is:
2593 X is a hexadecimal digit character in the range [0-9], [a-f] and [A-F].
2594 The function decodes every two hexadecimal digit characters as one byte. The
2595 decoding stops after Length of characters and outputs Buffer containing
2598 If String is NULL, then ASSERT().
2600 If Buffer is NULL, then ASSERT().
2602 If Length is not multiple of 2, then ASSERT().
2604 If PcdMaximumAsciiStringLength is not zero and Length is greater than
2605 PcdMaximumAsciiStringLength, then ASSERT().
2607 If MaxBufferSize is less than (Length / 2), then ASSERT().
2609 @param String Pointer to a Null-terminated ASCII string.
2610 @param Length The number of ASCII characters to decode.
2611 @param Buffer Pointer to the converted bytes array.
2612 @param MaxBufferSize The maximum size of Buffer.
2614 @retval RETURN_SUCCESS Buffer is translated from String.
2615 @retval RETURN_INVALID_PARAMETER If String is NULL.
2617 If Length is not multiple of 2.
2618 If PcdMaximumAsciiStringLength is not zero,
2619 and Length is greater than
2620 PcdMaximumAsciiStringLength.
2621 @retval RETURN_UNSUPPORTED If Length of characters from String contain
2622 a character that is not valid hexadecimal
2623 digit characters, or a Null-terminator.
2624 @retval RETURN_BUFFER_TOO_SMALL If MaxBufferSize is less than (Length / 2).
2628 AsciiStrHexToBytes (
2629 IN CONST CHAR8
*String
,
2632 IN UINTN MaxBufferSize
2635 #ifndef DISABLE_NEW_DEPRECATED_INTERFACES
2638 [ATTENTION] This function is deprecated for security reason.
2640 Convert one Null-terminated ASCII string to a Null-terminated
2641 Unicode string and returns the Unicode string.
2643 This function converts the contents of the ASCII string Source to the Unicode
2644 string Destination, and returns Destination. The function terminates the
2645 Unicode string Destination by appending a Null-terminator character at the end.
2646 The caller is responsible to make sure Destination points to a buffer with size
2647 equal or greater than ((AsciiStrLen (Source) + 1) * sizeof (CHAR16)) in bytes.
2649 If Destination is NULL, then ASSERT().
2650 If Destination is not aligned on a 16-bit boundary, then ASSERT().
2651 If Source is NULL, then ASSERT().
2652 If Source and Destination overlap, then ASSERT().
2653 If PcdMaximumAsciiStringLength is not zero, and Source contains more than
2654 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
2656 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
2657 PcdMaximumUnicodeStringLength ASCII characters not including the
2658 Null-terminator, then ASSERT().
2660 @param Source The pointer to a Null-terminated ASCII string.
2661 @param Destination The pointer to a Null-terminated Unicode string.
2663 @return Destination.
2668 AsciiStrToUnicodeStr (
2669 IN CONST CHAR8
*Source
,
2670 OUT CHAR16
*Destination
2676 Convert one Null-terminated ASCII string to a Null-terminated
2679 This function is similar to StrCpyS.
2681 This function converts the contents of the ASCII string Source to the Unicode
2682 string Destination. The function terminates the Unicode string Destination by
2683 appending a Null-terminator character at the end.
2685 The caller is responsible to make sure Destination points to a buffer with size
2686 equal or greater than ((AsciiStrLen (Source) + 1) * sizeof (CHAR16)) in bytes.
2688 If Destination is not aligned on a 16-bit boundary, then ASSERT().
2689 If an error would be returned, then the function will also ASSERT().
2691 If an error is returned, then the Destination is unmodified.
2693 @param Source The pointer to a Null-terminated ASCII string.
2694 @param Destination The pointer to a Null-terminated Unicode string.
2695 @param DestMax The maximum number of Destination Unicode
2696 char, including terminating null char.
2698 @retval RETURN_SUCCESS String is converted.
2699 @retval RETURN_BUFFER_TOO_SMALL If DestMax is NOT greater than StrLen(Source).
2700 @retval RETURN_INVALID_PARAMETER If Destination is NULL.
2702 If PcdMaximumUnicodeStringLength is not zero,
2703 and DestMax is greater than
2704 PcdMaximumUnicodeStringLength.
2705 If PcdMaximumAsciiStringLength is not zero,
2706 and DestMax is greater than
2707 PcdMaximumAsciiStringLength.
2709 @retval RETURN_ACCESS_DENIED If Source and Destination overlap.
2714 AsciiStrToUnicodeStrS (
2715 IN CONST CHAR8
*Source
,
2716 OUT CHAR16
*Destination
,
2721 Convert not more than Length successive characters from a Null-terminated
2722 Ascii string to a Null-terminated Unicode string. If no null char is copied
2723 from Source, then Destination[Length] is always set to null.
2725 This function converts not more than Length successive characters from the
2726 Ascii string Source to the Unicode string Destination. The function
2727 terminates the Unicode string Destination by appending a Null-terminator
2728 character at the end.
2730 The caller is responsible to make sure Destination points to a buffer with
2731 size not smaller than
2732 ((MIN(AsciiStrLen(Source), Length) + 1) * sizeof (CHAR8)) in bytes.
2734 If Destination is not aligned on a 16-bit boundary, then ASSERT().
2735 If an error would be returned, then the function will also ASSERT().
2737 If an error is returned, then Destination and DestinationLength are
2740 @param Source The pointer to a Null-terminated Ascii string.
2741 @param Length The maximum number of Ascii characters to convert.
2742 @param Destination The pointer to a Null-terminated Unicode string.
2743 @param DestMax The maximum number of Destination Unicode char,
2744 including terminating null char.
2745 @param DestinationLength The number of Ascii characters converted.
2747 @retval RETURN_SUCCESS String is converted.
2748 @retval RETURN_INVALID_PARAMETER If Destination is NULL.
2750 If DestinationLength is NULL.
2751 If PcdMaximumUnicodeStringLength is not
2752 zero, and Length or DestMax is greater than
2753 PcdMaximumUnicodeStringLength.
2754 If PcdMaximumAsciiStringLength is not zero,
2755 and Length or DestMax is greater than
2756 PcdMaximumAsciiStringLength.
2758 @retval RETURN_BUFFER_TOO_SMALL If DestMax is NOT greater than
2759 MIN(AsciiStrLen(Source), Length).
2760 @retval RETURN_ACCESS_DENIED If Source and Destination overlap.
2765 AsciiStrnToUnicodeStrS (
2766 IN CONST CHAR8
*Source
,
2768 OUT CHAR16
*Destination
,
2770 OUT UINTN
*DestinationLength
2774 Converts an 8-bit value to an 8-bit BCD value.
2776 Converts the 8-bit value specified by Value to BCD. The BCD value is
2779 If Value >= 100, then ASSERT().
2781 @param Value The 8-bit value to convert to BCD. Range 0..99.
2783 @return The BCD value.
2794 Converts an 8-bit BCD value to an 8-bit value.
2796 Converts the 8-bit BCD value specified by Value to an 8-bit value. The 8-bit
2799 If Value >= 0xA0, then ASSERT().
2800 If (Value & 0x0F) >= 0x0A, then ASSERT().
2802 @param Value The 8-bit BCD value to convert to an 8-bit value.
2804 @return The 8-bit value is returned.
2814 // File Path Manipulation Functions
2818 Removes the last directory or file entry in a path.
2820 @param[in, out] Path The pointer to the path to modify.
2822 @retval FALSE Nothing was found to remove.
2823 @retval TRUE A directory or file was removed.
2832 Function to clean up paths.
2833 - Single periods in the path are removed.
2834 - Double periods in the path are removed along with a single parent directory.
2835 - Forward slashes L'/' are converted to backward slashes L'\'.
2837 This will be done inline and the existing buffer may be larger than required
2840 @param[in] Path The pointer to the string containing the path.
2842 @return Returns Path, otherwise returns NULL to indicate that an error has occurred.
2846 PathCleanUpDirectories(
2851 // Linked List Functions and Macros
2855 Initializes the head node of a doubly linked list that is declared as a
2856 global variable in a module.
2858 Initializes the forward and backward links of a new linked list. After
2859 initializing a linked list with this macro, the other linked list functions
2860 may be used to add and remove nodes from the linked list. This macro results
2861 in smaller executables by initializing the linked list in the data section,
2862 instead if calling the InitializeListHead() function to perform the
2863 equivalent operation.
2865 @param ListHead The head note of a list to initialize.
2868 #define INITIALIZE_LIST_HEAD_VARIABLE(ListHead) {&(ListHead), &(ListHead)}
2872 Initializes the head node of a doubly linked list, and returns the pointer to
2873 the head node of the doubly linked list.
2875 Initializes the forward and backward links of a new linked list. After
2876 initializing a linked list with this function, the other linked list
2877 functions may be used to add and remove nodes from the linked list. It is up
2878 to the caller of this function to allocate the memory for ListHead.
2880 If ListHead is NULL, then ASSERT().
2882 @param ListHead A pointer to the head node of a new doubly linked list.
2889 InitializeListHead (
2890 IN OUT LIST_ENTRY
*ListHead
2895 Adds a node to the beginning of a doubly linked list, and returns the pointer
2896 to the head node of the doubly linked list.
2898 Adds the node Entry at the beginning of the doubly linked list denoted by
2899 ListHead, and returns ListHead.
2901 If ListHead is NULL, then ASSERT().
2902 If Entry is NULL, then ASSERT().
2903 If ListHead was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or
2904 InitializeListHead(), then ASSERT().
2905 If PcdMaximumLinkedListLength is not zero, and prior to insertion the number
2906 of nodes in ListHead, including the ListHead node, is greater than or
2907 equal to PcdMaximumLinkedListLength, then ASSERT().
2909 @param ListHead A pointer to the head node of a doubly linked list.
2910 @param Entry A pointer to a node that is to be inserted at the beginning
2911 of a doubly linked list.
2919 IN OUT LIST_ENTRY
*ListHead
,
2920 IN OUT LIST_ENTRY
*Entry
2925 Adds a node to the end of a doubly linked list, and returns the pointer to
2926 the head node of the doubly linked list.
2928 Adds the node Entry to the end of the doubly linked list denoted by ListHead,
2929 and returns ListHead.
2931 If ListHead is NULL, then ASSERT().
2932 If Entry is NULL, then ASSERT().
2933 If ListHead was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or
2934 InitializeListHead(), then ASSERT().
2935 If PcdMaximumLinkedListLength is not zero, and prior to insertion the number
2936 of nodes in ListHead, including the ListHead node, is greater than or
2937 equal to PcdMaximumLinkedListLength, then ASSERT().
2939 @param ListHead A pointer to the head node of a doubly linked list.
2940 @param Entry A pointer to a node that is to be added at the end of the
2949 IN OUT LIST_ENTRY
*ListHead
,
2950 IN OUT LIST_ENTRY
*Entry
2955 Retrieves the first node of a doubly linked list.
2957 Returns the first node of a doubly linked list. List must have been
2958 initialized with INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead().
2959 If List is empty, then List is returned.
2961 If List is NULL, then ASSERT().
2962 If List was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or
2963 InitializeListHead(), then ASSERT().
2964 If PcdMaximumLinkedListLength is not zero, and the number of nodes
2965 in List, including the List node, is greater than or equal to
2966 PcdMaximumLinkedListLength, then ASSERT().
2968 @param List A pointer to the head node of a doubly linked list.
2970 @return The first node of a doubly linked list.
2971 @retval List The list is empty.
2977 IN CONST LIST_ENTRY
*List
2982 Retrieves the next node of a doubly linked list.
2984 Returns the node of a doubly linked list that follows Node.
2985 List must have been initialized with INTIALIZE_LIST_HEAD_VARIABLE()
2986 or InitializeListHead(). If List is empty, then List is returned.
2988 If List is NULL, then ASSERT().
2989 If Node is NULL, then ASSERT().
2990 If List was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or
2991 InitializeListHead(), then ASSERT().
2992 If PcdMaximumLinkedListLength is not zero, and List contains more than
2993 PcdMaximumLinkedListLength nodes, then ASSERT().
2994 If PcdVerifyNodeInList is TRUE and Node is not a node in List, then ASSERT().
2996 @param List A pointer to the head node of a doubly linked list.
2997 @param Node A pointer to a node in the doubly linked list.
2999 @return The pointer to the next node if one exists. Otherwise List is returned.
3005 IN CONST LIST_ENTRY
*List
,
3006 IN CONST LIST_ENTRY
*Node
3011 Retrieves the previous node of a doubly linked list.
3013 Returns the node of a doubly linked list that precedes Node.
3014 List must have been initialized with INTIALIZE_LIST_HEAD_VARIABLE()
3015 or InitializeListHead(). If List is empty, then List is returned.
3017 If List is NULL, then ASSERT().
3018 If Node is NULL, then ASSERT().
3019 If List was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or
3020 InitializeListHead(), then ASSERT().
3021 If PcdMaximumLinkedListLength is not zero, and List contains more than
3022 PcdMaximumLinkedListLength nodes, then ASSERT().
3023 If PcdVerifyNodeInList is TRUE and Node is not a node in List, then ASSERT().
3025 @param List A pointer to the head node of a doubly linked list.
3026 @param Node A pointer to a node in the doubly linked list.
3028 @return The pointer to the previous node if one exists. Otherwise List is returned.
3034 IN CONST LIST_ENTRY
*List
,
3035 IN CONST LIST_ENTRY
*Node
3040 Checks to see if a doubly linked list is empty or not.
3042 Checks to see if the doubly linked list is empty. If the linked list contains
3043 zero nodes, this function returns TRUE. Otherwise, it returns FALSE.
3045 If ListHead is NULL, then ASSERT().
3046 If ListHead was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or
3047 InitializeListHead(), then ASSERT().
3048 If PcdMaximumLinkedListLength is not zero, and the number of nodes
3049 in List, including the List node, is greater than or equal to
3050 PcdMaximumLinkedListLength, then ASSERT().
3052 @param ListHead A pointer to the head node of a doubly linked list.
3054 @retval TRUE The linked list is empty.
3055 @retval FALSE The linked list is not empty.
3061 IN CONST LIST_ENTRY
*ListHead
3066 Determines if a node in a doubly linked list is the head node of a the same
3067 doubly linked list. This function is typically used to terminate a loop that
3068 traverses all the nodes in a doubly linked list starting with the head node.
3070 Returns TRUE if Node is equal to List. Returns FALSE if Node is one of the
3071 nodes in the doubly linked list specified by List. List must have been
3072 initialized with INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead().
3074 If List is NULL, then ASSERT().
3075 If Node is NULL, then ASSERT().
3076 If List was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead(),
3078 If PcdMaximumLinkedListLength is not zero, and the number of nodes
3079 in List, including the List node, is greater than or equal to
3080 PcdMaximumLinkedListLength, then ASSERT().
3081 If PcdVerifyNodeInList is TRUE and Node is not a node in List the and Node is not equal
3082 to List, then ASSERT().
3084 @param List A pointer to the head node of a doubly linked list.
3085 @param Node A pointer to a node in the doubly linked list.
3087 @retval TRUE Node is the head of the doubly-linked list pointed by List.
3088 @retval FALSE Node is not the head of the doubly-linked list pointed by List.
3094 IN CONST LIST_ENTRY
*List
,
3095 IN CONST LIST_ENTRY
*Node
3100 Determines if a node the last node in a doubly linked list.
3102 Returns TRUE if Node is the last node in the doubly linked list specified by
3103 List. Otherwise, FALSE is returned. List must have been initialized with
3104 INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead().
3106 If List is NULL, then ASSERT().
3107 If Node is NULL, then ASSERT().
3108 If List was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or
3109 InitializeListHead(), then ASSERT().
3110 If PcdMaximumLinkedListLength is not zero, and the number of nodes
3111 in List, including the List node, is greater than or equal to
3112 PcdMaximumLinkedListLength, then ASSERT().
3113 If PcdVerifyNodeInList is TRUE and Node is not a node in List, then ASSERT().
3115 @param List A pointer to the head node of a doubly linked list.
3116 @param Node A pointer to a node in the doubly linked list.
3118 @retval TRUE Node is the last node in the linked list.
3119 @retval FALSE Node is not the last node in the linked list.
3125 IN CONST LIST_ENTRY
*List
,
3126 IN CONST LIST_ENTRY
*Node
3131 Swaps the location of two nodes in a doubly linked list, and returns the
3132 first node after the swap.
3134 If FirstEntry is identical to SecondEntry, then SecondEntry is returned.
3135 Otherwise, the location of the FirstEntry node is swapped with the location
3136 of the SecondEntry node in a doubly linked list. SecondEntry must be in the
3137 same double linked list as FirstEntry and that double linked list must have
3138 been initialized with INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead().
3139 SecondEntry is returned after the nodes are swapped.
3141 If FirstEntry is NULL, then ASSERT().
3142 If SecondEntry is NULL, then ASSERT().
3143 If PcdVerifyNodeInList is TRUE and SecondEntry and FirstEntry are not in the
3144 same linked list, then ASSERT().
3145 If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
3146 linked list containing the FirstEntry and SecondEntry nodes, including
3147 the FirstEntry and SecondEntry nodes, is greater than or equal to
3148 PcdMaximumLinkedListLength, then ASSERT().
3150 @param FirstEntry A pointer to a node in a linked list.
3151 @param SecondEntry A pointer to another node in the same linked list.
3153 @return SecondEntry.
3159 IN OUT LIST_ENTRY
*FirstEntry
,
3160 IN OUT LIST_ENTRY
*SecondEntry
3165 Removes a node from a doubly linked list, and returns the node that follows
3168 Removes the node Entry from a doubly linked list. It is up to the caller of
3169 this function to release the memory used by this node if that is required. On
3170 exit, the node following Entry in the doubly linked list is returned. If
3171 Entry is the only node in the linked list, then the head node of the linked
3174 If Entry is NULL, then ASSERT().
3175 If Entry is the head node of an empty list, then ASSERT().
3176 If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
3177 linked list containing Entry, including the Entry node, is greater than
3178 or equal to PcdMaximumLinkedListLength, then ASSERT().
3180 @param Entry A pointer to a node in a linked list.
3188 IN CONST LIST_ENTRY
*Entry
3196 Shifts a 64-bit integer left between 0 and 63 bits. The low bits are filled
3197 with zeros. The shifted value is returned.
3199 This function shifts the 64-bit value Operand to the left by Count bits. The
3200 low Count bits are set to zero. The shifted value is returned.
3202 If Count is greater than 63, then ASSERT().
3204 @param Operand The 64-bit operand to shift left.
3205 @param Count The number of bits to shift left.
3207 @return Operand << Count.
3219 Shifts a 64-bit integer right between 0 and 63 bits. This high bits are
3220 filled with zeros. The shifted value is returned.
3222 This function shifts the 64-bit value Operand to the right by Count bits. The
3223 high Count bits are set to zero. The shifted value is returned.
3225 If Count is greater than 63, then ASSERT().
3227 @param Operand The 64-bit operand to shift right.
3228 @param Count The number of bits to shift right.
3230 @return Operand >> Count
3242 Shifts a 64-bit integer right between 0 and 63 bits. The high bits are filled
3243 with original integer's bit 63. The shifted value is returned.
3245 This function shifts the 64-bit value Operand to the right by Count bits. The
3246 high Count bits are set to bit 63 of Operand. The shifted value is returned.
3248 If Count is greater than 63, then ASSERT().
3250 @param Operand The 64-bit operand to shift right.
3251 @param Count The number of bits to shift right.
3253 @return Operand >> Count
3265 Rotates a 32-bit integer left between 0 and 31 bits, filling the low bits
3266 with the high bits that were rotated.
3268 This function rotates the 32-bit value Operand to the left by Count bits. The
3269 low Count bits are fill with the high Count bits of Operand. The rotated
3272 If Count is greater than 31, then ASSERT().
3274 @param Operand The 32-bit operand to rotate left.
3275 @param Count The number of bits to rotate left.
3277 @return Operand << Count
3289 Rotates a 32-bit integer right between 0 and 31 bits, filling the high bits
3290 with the low bits that were rotated.
3292 This function rotates the 32-bit value Operand to the right by Count bits.
3293 The high Count bits are fill with the low Count bits of Operand. The rotated
3296 If Count is greater than 31, then ASSERT().
3298 @param Operand The 32-bit operand to rotate right.
3299 @param Count The number of bits to rotate right.
3301 @return Operand >> Count
3313 Rotates a 64-bit integer left between 0 and 63 bits, filling the low bits
3314 with the high bits that were rotated.
3316 This function rotates the 64-bit value Operand to the left by Count bits. The
3317 low Count bits are fill with the high Count bits of Operand. The rotated
3320 If Count is greater than 63, then ASSERT().
3322 @param Operand The 64-bit operand to rotate left.
3323 @param Count The number of bits to rotate left.
3325 @return Operand << Count
3337 Rotates a 64-bit integer right between 0 and 63 bits, filling the high bits
3338 with the high low bits that were rotated.
3340 This function rotates the 64-bit value Operand to the right by Count bits.
3341 The high Count bits are fill with the low Count bits of Operand. The rotated
3344 If Count is greater than 63, then ASSERT().
3346 @param Operand The 64-bit operand to rotate right.
3347 @param Count The number of bits to rotate right.
3349 @return Operand >> Count
3361 Returns the bit position of the lowest bit set in a 32-bit value.
3363 This function computes the bit position of the lowest bit set in the 32-bit
3364 value specified by Operand. If Operand is zero, then -1 is returned.
3365 Otherwise, a value between 0 and 31 is returned.
3367 @param Operand The 32-bit operand to evaluate.
3369 @retval 0..31 The lowest bit set in Operand was found.
3370 @retval -1 Operand is zero.
3381 Returns the bit position of the lowest bit set in a 64-bit value.
3383 This function computes the bit position of the lowest bit set in the 64-bit
3384 value specified by Operand. If Operand is zero, then -1 is returned.
3385 Otherwise, a value between 0 and 63 is returned.
3387 @param Operand The 64-bit operand to evaluate.
3389 @retval 0..63 The lowest bit set in Operand was found.
3390 @retval -1 Operand is zero.
3402 Returns the bit position of the highest bit set in a 32-bit value. Equivalent
3405 This function computes the bit position of the highest bit set in the 32-bit
3406 value specified by Operand. If Operand is zero, then -1 is returned.
3407 Otherwise, a value between 0 and 31 is returned.
3409 @param Operand The 32-bit operand to evaluate.
3411 @retval 0..31 Position of the highest bit set in Operand if found.
3412 @retval -1 Operand is zero.
3423 Returns the bit position of the highest bit set in a 64-bit value. Equivalent
3426 This function computes the bit position of the highest bit set in the 64-bit
3427 value specified by Operand. If Operand is zero, then -1 is returned.
3428 Otherwise, a value between 0 and 63 is returned.
3430 @param Operand The 64-bit operand to evaluate.
3432 @retval 0..63 Position of the highest bit set in Operand if found.
3433 @retval -1 Operand is zero.
3444 Returns the value of the highest bit set in a 32-bit value. Equivalent to
3447 This function computes the value of the highest bit set in the 32-bit value
3448 specified by Operand. If Operand is zero, then zero is returned.
3450 @param Operand The 32-bit operand to evaluate.
3452 @return 1 << HighBitSet32(Operand)
3453 @retval 0 Operand is zero.
3464 Returns the value of the highest bit set in a 64-bit value. Equivalent to
3467 This function computes the value of the highest bit set in the 64-bit value
3468 specified by Operand. If Operand is zero, then zero is returned.
3470 @param Operand The 64-bit operand to evaluate.
3472 @return 1 << HighBitSet64(Operand)
3473 @retval 0 Operand is zero.
3484 Switches the endianness of a 16-bit integer.
3486 This function swaps the bytes in a 16-bit unsigned value to switch the value
3487 from little endian to big endian or vice versa. The byte swapped value is
3490 @param Value A 16-bit unsigned value.
3492 @return The byte swapped Value.
3503 Switches the endianness of a 32-bit integer.
3505 This function swaps the bytes in a 32-bit unsigned value to switch the value
3506 from little endian to big endian or vice versa. The byte swapped value is
3509 @param Value A 32-bit unsigned value.
3511 @return The byte swapped Value.
3522 Switches the endianness of a 64-bit integer.
3524 This function swaps the bytes in a 64-bit unsigned value to switch the value
3525 from little endian to big endian or vice versa. The byte swapped value is
3528 @param Value A 64-bit unsigned value.
3530 @return The byte swapped Value.
3541 Multiples a 64-bit unsigned integer by a 32-bit unsigned integer and
3542 generates a 64-bit unsigned result.
3544 This function multiples the 64-bit unsigned value Multiplicand by the 32-bit
3545 unsigned value Multiplier and generates a 64-bit unsigned result. This 64-
3546 bit unsigned result is returned.
3548 @param Multiplicand A 64-bit unsigned value.
3549 @param Multiplier A 32-bit unsigned value.
3551 @return Multiplicand * Multiplier
3557 IN UINT64 Multiplicand
,
3558 IN UINT32 Multiplier
3563 Multiples a 64-bit unsigned integer by a 64-bit unsigned integer and
3564 generates a 64-bit unsigned result.
3566 This function multiples the 64-bit unsigned value Multiplicand by the 64-bit
3567 unsigned value Multiplier and generates a 64-bit unsigned result. This 64-
3568 bit unsigned result is returned.
3570 @param Multiplicand A 64-bit unsigned value.
3571 @param Multiplier A 64-bit unsigned value.
3573 @return Multiplicand * Multiplier.
3579 IN UINT64 Multiplicand
,
3580 IN UINT64 Multiplier
3585 Multiples a 64-bit signed integer by a 64-bit signed integer and generates a
3586 64-bit signed result.
3588 This function multiples the 64-bit signed value Multiplicand by the 64-bit
3589 signed value Multiplier and generates a 64-bit signed result. This 64-bit
3590 signed result is returned.
3592 @param Multiplicand A 64-bit signed value.
3593 @param Multiplier A 64-bit signed value.
3595 @return Multiplicand * Multiplier
3601 IN INT64 Multiplicand
,
3607 Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates
3608 a 64-bit unsigned result.
3610 This function divides the 64-bit unsigned value Dividend by the 32-bit
3611 unsigned value Divisor and generates a 64-bit unsigned quotient. This
3612 function returns the 64-bit unsigned quotient.
3614 If Divisor is 0, then ASSERT().
3616 @param Dividend A 64-bit unsigned value.
3617 @param Divisor A 32-bit unsigned value.
3619 @return Dividend / Divisor.
3631 Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates
3632 a 32-bit unsigned remainder.
3634 This function divides the 64-bit unsigned value Dividend by the 32-bit
3635 unsigned value Divisor and generates a 32-bit remainder. This function
3636 returns the 32-bit unsigned remainder.
3638 If Divisor is 0, then ASSERT().
3640 @param Dividend A 64-bit unsigned value.
3641 @param Divisor A 32-bit unsigned value.
3643 @return Dividend % Divisor.
3655 Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates
3656 a 64-bit unsigned result and an optional 32-bit unsigned remainder.
3658 This function divides the 64-bit unsigned value Dividend by the 32-bit
3659 unsigned value Divisor and generates a 64-bit unsigned quotient. If Remainder
3660 is not NULL, then the 32-bit unsigned remainder is returned in Remainder.
3661 This function returns the 64-bit unsigned quotient.
3663 If Divisor is 0, then ASSERT().
3665 @param Dividend A 64-bit unsigned value.
3666 @param Divisor A 32-bit unsigned value.
3667 @param Remainder A pointer to a 32-bit unsigned value. This parameter is
3668 optional and may be NULL.
3670 @return Dividend / Divisor.
3675 DivU64x32Remainder (
3678 OUT UINT32
*Remainder OPTIONAL
3683 Divides a 64-bit unsigned integer by a 64-bit unsigned integer and generates
3684 a 64-bit unsigned result and an optional 64-bit unsigned remainder.
3686 This function divides the 64-bit unsigned value Dividend by the 64-bit
3687 unsigned value Divisor and generates a 64-bit unsigned quotient. If Remainder
3688 is not NULL, then the 64-bit unsigned remainder is returned in Remainder.
3689 This function returns the 64-bit unsigned quotient.
3691 If Divisor is 0, then ASSERT().
3693 @param Dividend A 64-bit unsigned value.
3694 @param Divisor A 64-bit unsigned value.
3695 @param Remainder A pointer to a 64-bit unsigned value. This parameter is
3696 optional and may be NULL.
3698 @return Dividend / Divisor.
3703 DivU64x64Remainder (
3706 OUT UINT64
*Remainder OPTIONAL
3711 Divides a 64-bit signed integer by a 64-bit signed integer and generates a
3712 64-bit signed result and a optional 64-bit signed remainder.
3714 This function divides the 64-bit signed value Dividend by the 64-bit signed
3715 value Divisor and generates a 64-bit signed quotient. If Remainder is not
3716 NULL, then the 64-bit signed remainder is returned in Remainder. This
3717 function returns the 64-bit signed quotient.
3719 It is the caller's responsibility to not call this function with a Divisor of 0.
3720 If Divisor is 0, then the quotient and remainder should be assumed to be
3721 the largest negative integer.
3723 If Divisor is 0, then ASSERT().
3725 @param Dividend A 64-bit signed value.
3726 @param Divisor A 64-bit signed value.
3727 @param Remainder A pointer to a 64-bit signed value. This parameter is
3728 optional and may be NULL.
3730 @return Dividend / Divisor.
3735 DivS64x64Remainder (
3738 OUT INT64
*Remainder OPTIONAL
3743 Reads a 16-bit value from memory that may be unaligned.
3745 This function returns the 16-bit value pointed to by Buffer. The function
3746 guarantees that the read operation does not produce an alignment fault.
3748 If the Buffer is NULL, then ASSERT().
3750 @param Buffer The pointer to a 16-bit value that may be unaligned.
3752 @return The 16-bit value read from Buffer.
3758 IN CONST UINT16
*Buffer
3763 Writes a 16-bit value to memory that may be unaligned.
3765 This function writes the 16-bit value specified by Value to Buffer. Value is
3766 returned. The function guarantees that the write operation does not produce
3769 If the Buffer is NULL, then ASSERT().
3771 @param Buffer The pointer to a 16-bit value that may be unaligned.
3772 @param Value 16-bit value to write to Buffer.
3774 @return The 16-bit value to write to Buffer.
3786 Reads a 24-bit value from memory that may be unaligned.
3788 This function returns the 24-bit value pointed to by Buffer. The function
3789 guarantees that the read operation does not produce an alignment fault.
3791 If the Buffer is NULL, then ASSERT().
3793 @param Buffer The pointer to a 24-bit value that may be unaligned.
3795 @return The 24-bit value read from Buffer.
3801 IN CONST UINT32
*Buffer
3806 Writes a 24-bit value to memory that may be unaligned.
3808 This function writes the 24-bit value specified by Value to Buffer. Value is
3809 returned. The function guarantees that the write operation does not produce
3812 If the Buffer is NULL, then ASSERT().
3814 @param Buffer The pointer to a 24-bit value that may be unaligned.
3815 @param Value 24-bit value to write to Buffer.
3817 @return The 24-bit value to write to Buffer.
3829 Reads a 32-bit value from memory that may be unaligned.
3831 This function returns the 32-bit value pointed to by Buffer. The function
3832 guarantees that the read operation does not produce an alignment fault.
3834 If the Buffer is NULL, then ASSERT().
3836 @param Buffer The pointer to a 32-bit value that may be unaligned.
3838 @return The 32-bit value read from Buffer.
3844 IN CONST UINT32
*Buffer
3849 Writes a 32-bit value to memory that may be unaligned.
3851 This function writes the 32-bit value specified by Value to Buffer. Value is
3852 returned. The function guarantees that the write operation does not produce
3855 If the Buffer is NULL, then ASSERT().
3857 @param Buffer The pointer to a 32-bit value that may be unaligned.
3858 @param Value 32-bit value to write to Buffer.
3860 @return The 32-bit value to write to Buffer.
3872 Reads a 64-bit value from memory that may be unaligned.
3874 This function returns the 64-bit value pointed to by Buffer. The function
3875 guarantees that the read operation does not produce an alignment fault.
3877 If the Buffer is NULL, then ASSERT().
3879 @param Buffer The pointer to a 64-bit value that may be unaligned.
3881 @return The 64-bit value read from Buffer.
3887 IN CONST UINT64
*Buffer
3892 Writes a 64-bit value to memory that may be unaligned.
3894 This function writes the 64-bit value specified by Value to Buffer. Value is
3895 returned. The function guarantees that the write operation does not produce
3898 If the Buffer is NULL, then ASSERT().
3900 @param Buffer The pointer to a 64-bit value that may be unaligned.
3901 @param Value 64-bit value to write to Buffer.
3903 @return The 64-bit value to write to Buffer.
3915 // Bit Field Functions
3919 Returns a bit field from an 8-bit value.
3921 Returns the bitfield specified by the StartBit and the EndBit from Operand.
3923 If 8-bit operations are not supported, then ASSERT().
3924 If StartBit is greater than 7, then ASSERT().
3925 If EndBit is greater than 7, then ASSERT().
3926 If EndBit is less than StartBit, then ASSERT().
3928 @param Operand Operand on which to perform the bitfield operation.
3929 @param StartBit The ordinal of the least significant bit in the bit field.
3931 @param EndBit The ordinal of the most significant bit in the bit field.
3934 @return The bit field read.
3947 Writes a bit field to an 8-bit value, and returns the result.
3949 Writes Value to the bit field specified by the StartBit and the EndBit in
3950 Operand. All other bits in Operand are preserved. The new 8-bit value is
3953 If 8-bit operations are not supported, then ASSERT().
3954 If StartBit is greater than 7, then ASSERT().
3955 If EndBit is greater than 7, then ASSERT().
3956 If EndBit is less than StartBit, then ASSERT().
3957 If Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
3959 @param Operand Operand on which to perform the bitfield operation.
3960 @param StartBit The ordinal of the least significant bit in the bit field.
3962 @param EndBit The ordinal of the most significant bit in the bit field.
3964 @param Value New value of the bit field.
3966 @return The new 8-bit value.
3980 Reads a bit field from an 8-bit value, performs a bitwise OR, and returns the
3983 Performs a bitwise OR between the bit field specified by StartBit
3984 and EndBit in Operand and the value specified by OrData. All other bits in
3985 Operand are preserved. The new 8-bit value is returned.
3987 If 8-bit operations are not supported, then ASSERT().
3988 If StartBit is greater than 7, then ASSERT().
3989 If EndBit is greater than 7, then ASSERT().
3990 If EndBit is less than StartBit, then ASSERT().
3991 If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
3993 @param Operand Operand on which to perform the bitfield operation.
3994 @param StartBit The ordinal of the least significant bit in the bit field.
3996 @param EndBit The ordinal of the most significant bit in the bit field.
3998 @param OrData The value to OR with the read value from the value
4000 @return The new 8-bit value.
4014 Reads a bit field from an 8-bit value, performs a bitwise AND, and returns
4017 Performs a bitwise AND between the bit field specified by StartBit and EndBit
4018 in Operand and the value specified by AndData. All other bits in Operand are
4019 preserved. The new 8-bit value is returned.
4021 If 8-bit operations are not supported, then ASSERT().
4022 If StartBit is greater than 7, then ASSERT().
4023 If EndBit is greater than 7, then ASSERT().
4024 If EndBit is less than StartBit, then ASSERT().
4025 If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4027 @param Operand Operand on which to perform the bitfield operation.
4028 @param StartBit The ordinal of the least significant bit in the bit field.
4030 @param EndBit The ordinal of the most significant bit in the bit field.
4032 @param AndData The value to AND with the read value from the value.
4034 @return The new 8-bit value.
4048 Reads a bit field from an 8-bit value, performs a bitwise AND followed by a
4049 bitwise OR, and returns the result.
4051 Performs a bitwise AND between the bit field specified by StartBit and EndBit
4052 in Operand and the value specified by AndData, followed by a bitwise
4053 OR with value specified by OrData. All other bits in Operand are
4054 preserved. The new 8-bit value is returned.
4056 If 8-bit operations are not supported, then ASSERT().
4057 If StartBit is greater than 7, then ASSERT().
4058 If EndBit is greater than 7, then ASSERT().
4059 If EndBit is less than StartBit, then ASSERT().
4060 If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4061 If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4063 @param Operand Operand on which to perform the bitfield operation.
4064 @param StartBit The ordinal of the least significant bit in the bit field.
4066 @param EndBit The ordinal of the most significant bit in the bit field.
4068 @param AndData The value to AND with the read value from the value.
4069 @param OrData The value to OR with the result of the AND operation.
4071 @return The new 8-bit value.
4076 BitFieldAndThenOr8 (
4086 Returns a bit field from a 16-bit value.
4088 Returns the bitfield specified by the StartBit and the EndBit from Operand.
4090 If 16-bit operations are not supported, then ASSERT().
4091 If StartBit is greater than 15, then ASSERT().
4092 If EndBit is greater than 15, then ASSERT().
4093 If EndBit is less than StartBit, then ASSERT().
4095 @param Operand Operand on which to perform the bitfield operation.
4096 @param StartBit The ordinal of the least significant bit in the bit field.
4098 @param EndBit The ordinal of the most significant bit in the bit field.
4101 @return The bit field read.
4114 Writes a bit field to a 16-bit value, and returns the result.
4116 Writes Value to the bit field specified by the StartBit and the EndBit in
4117 Operand. All other bits in Operand are preserved. The new 16-bit value is
4120 If 16-bit operations are not supported, then ASSERT().
4121 If StartBit is greater than 15, then ASSERT().
4122 If EndBit is greater than 15, then ASSERT().
4123 If EndBit is less than StartBit, then ASSERT().
4124 If Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4126 @param Operand Operand on which to perform the bitfield operation.
4127 @param StartBit The ordinal of the least significant bit in the bit field.
4129 @param EndBit The ordinal of the most significant bit in the bit field.
4131 @param Value New value of the bit field.
4133 @return The new 16-bit value.
4147 Reads a bit field from a 16-bit value, performs a bitwise OR, and returns the
4150 Performs a bitwise OR between the bit field specified by StartBit
4151 and EndBit in Operand and the value specified by OrData. All other bits in
4152 Operand are preserved. The new 16-bit value is returned.
4154 If 16-bit operations are not supported, then ASSERT().
4155 If StartBit is greater than 15, then ASSERT().
4156 If EndBit is greater than 15, then ASSERT().
4157 If EndBit is less than StartBit, then ASSERT().
4158 If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4160 @param Operand Operand on which to perform the bitfield operation.
4161 @param StartBit The ordinal of the least significant bit in the bit field.
4163 @param EndBit The ordinal of the most significant bit in the bit field.
4165 @param OrData The value to OR with the read value from the value
4167 @return The new 16-bit value.
4181 Reads a bit field from a 16-bit value, performs a bitwise AND, and returns
4184 Performs a bitwise AND between the bit field specified by StartBit and EndBit
4185 in Operand and the value specified by AndData. All other bits in Operand are
4186 preserved. The new 16-bit value is returned.
4188 If 16-bit operations are not supported, then ASSERT().
4189 If StartBit is greater than 15, then ASSERT().
4190 If EndBit is greater than 15, then ASSERT().
4191 If EndBit is less than StartBit, then ASSERT().
4192 If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4194 @param Operand Operand on which to perform the bitfield operation.
4195 @param StartBit The ordinal of the least significant bit in the bit field.
4197 @param EndBit The ordinal of the most significant bit in the bit field.
4199 @param AndData The value to AND with the read value from the value
4201 @return The new 16-bit value.
4215 Reads a bit field from a 16-bit value, performs a bitwise AND followed by a
4216 bitwise OR, and returns the result.
4218 Performs a bitwise AND between the bit field specified by StartBit and EndBit
4219 in Operand and the value specified by AndData, followed by a bitwise
4220 OR with value specified by OrData. All other bits in Operand are
4221 preserved. The new 16-bit value is returned.
4223 If 16-bit operations are not supported, then ASSERT().
4224 If StartBit is greater than 15, then ASSERT().
4225 If EndBit is greater than 15, then ASSERT().
4226 If EndBit is less than StartBit, then ASSERT().
4227 If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4228 If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4230 @param Operand Operand on which to perform the bitfield operation.
4231 @param StartBit The ordinal of the least significant bit in the bit field.
4233 @param EndBit The ordinal of the most significant bit in the bit field.
4235 @param AndData The value to AND with the read value from the value.
4236 @param OrData The value to OR with the result of the AND operation.
4238 @return The new 16-bit value.
4243 BitFieldAndThenOr16 (
4253 Returns a bit field from a 32-bit value.
4255 Returns the bitfield specified by the StartBit and the EndBit from Operand.
4257 If 32-bit operations are not supported, then ASSERT().
4258 If StartBit is greater than 31, then ASSERT().
4259 If EndBit is greater than 31, then ASSERT().
4260 If EndBit is less than StartBit, then ASSERT().
4262 @param Operand Operand on which to perform the bitfield operation.
4263 @param StartBit The ordinal of the least significant bit in the bit field.
4265 @param EndBit The ordinal of the most significant bit in the bit field.
4268 @return The bit field read.
4281 Writes a bit field to a 32-bit value, and returns the result.
4283 Writes Value to the bit field specified by the StartBit and the EndBit in
4284 Operand. All other bits in Operand are preserved. The new 32-bit value is
4287 If 32-bit operations are not supported, then ASSERT().
4288 If StartBit is greater than 31, then ASSERT().
4289 If EndBit is greater than 31, then ASSERT().
4290 If EndBit is less than StartBit, then ASSERT().
4291 If Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4293 @param Operand Operand on which to perform the bitfield operation.
4294 @param StartBit The ordinal of the least significant bit in the bit field.
4296 @param EndBit The ordinal of the most significant bit in the bit field.
4298 @param Value New value of the bit field.
4300 @return The new 32-bit value.
4314 Reads a bit field from a 32-bit value, performs a bitwise OR, and returns the
4317 Performs a bitwise OR between the bit field specified by StartBit
4318 and EndBit in Operand and the value specified by OrData. All other bits in
4319 Operand are preserved. The new 32-bit value is returned.
4321 If 32-bit operations are not supported, then ASSERT().
4322 If StartBit is greater than 31, then ASSERT().
4323 If EndBit is greater than 31, then ASSERT().
4324 If EndBit is less than StartBit, then ASSERT().
4325 If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4327 @param Operand Operand on which to perform the bitfield operation.
4328 @param StartBit The ordinal of the least significant bit in the bit field.
4330 @param EndBit The ordinal of the most significant bit in the bit field.
4332 @param OrData The value to OR with the read value from the value.
4334 @return The new 32-bit value.
4348 Reads a bit field from a 32-bit value, performs a bitwise AND, and returns
4351 Performs a bitwise AND between the bit field specified by StartBit and EndBit
4352 in Operand and the value specified by AndData. All other bits in Operand are
4353 preserved. The new 32-bit value is returned.
4355 If 32-bit operations are not supported, then ASSERT().
4356 If StartBit is greater than 31, then ASSERT().
4357 If EndBit is greater than 31, then ASSERT().
4358 If EndBit is less than StartBit, then ASSERT().
4359 If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4361 @param Operand Operand on which to perform the bitfield operation.
4362 @param StartBit The ordinal of the least significant bit in the bit field.
4364 @param EndBit The ordinal of the most significant bit in the bit field.
4366 @param AndData The value to AND with the read value from the value
4368 @return The new 32-bit value.
4382 Reads a bit field from a 32-bit value, performs a bitwise AND followed by a
4383 bitwise OR, and returns the result.
4385 Performs a bitwise AND between the bit field specified by StartBit and EndBit
4386 in Operand and the value specified by AndData, followed by a bitwise
4387 OR with value specified by OrData. All other bits in Operand are
4388 preserved. The new 32-bit value is returned.
4390 If 32-bit operations are not supported, then ASSERT().
4391 If StartBit is greater than 31, then ASSERT().
4392 If EndBit is greater than 31, then ASSERT().
4393 If EndBit is less than StartBit, then ASSERT().
4394 If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4395 If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4397 @param Operand Operand on which to perform the bitfield operation.
4398 @param StartBit The ordinal of the least significant bit in the bit field.
4400 @param EndBit The ordinal of the most significant bit in the bit field.
4402 @param AndData The value to AND with the read value from the value.
4403 @param OrData The value to OR with the result of the AND operation.
4405 @return The new 32-bit value.
4410 BitFieldAndThenOr32 (
4420 Returns a bit field from a 64-bit value.
4422 Returns the bitfield specified by the StartBit and the EndBit from Operand.
4424 If 64-bit operations are not supported, then ASSERT().
4425 If StartBit is greater than 63, then ASSERT().
4426 If EndBit is greater than 63, then ASSERT().
4427 If EndBit is less than StartBit, then ASSERT().
4429 @param Operand Operand on which to perform the bitfield operation.
4430 @param StartBit The ordinal of the least significant bit in the bit field.
4432 @param EndBit The ordinal of the most significant bit in the bit field.
4435 @return The bit field read.
4448 Writes a bit field to a 64-bit value, and returns the result.
4450 Writes Value to the bit field specified by the StartBit and the EndBit in
4451 Operand. All other bits in Operand are preserved. The new 64-bit value is
4454 If 64-bit operations are not supported, then ASSERT().
4455 If StartBit is greater than 63, then ASSERT().
4456 If EndBit is greater than 63, then ASSERT().
4457 If EndBit is less than StartBit, then ASSERT().
4458 If Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4460 @param Operand Operand on which to perform the bitfield operation.
4461 @param StartBit The ordinal of the least significant bit in the bit field.
4463 @param EndBit The ordinal of the most significant bit in the bit field.
4465 @param Value New value of the bit field.
4467 @return The new 64-bit value.
4481 Reads a bit field from a 64-bit value, performs a bitwise OR, and returns the
4484 Performs a bitwise OR between the bit field specified by StartBit
4485 and EndBit in Operand and the value specified by OrData. All other bits in
4486 Operand are preserved. The new 64-bit value is returned.
4488 If 64-bit operations are not supported, then ASSERT().
4489 If StartBit is greater than 63, then ASSERT().
4490 If EndBit is greater than 63, then ASSERT().
4491 If EndBit is less than StartBit, then ASSERT().
4492 If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4494 @param Operand Operand on which to perform the bitfield operation.
4495 @param StartBit The ordinal of the least significant bit in the bit field.
4497 @param EndBit The ordinal of the most significant bit in the bit field.
4499 @param OrData The value to OR with the read value from the value
4501 @return The new 64-bit value.
4515 Reads a bit field from a 64-bit value, performs a bitwise AND, and returns
4518 Performs a bitwise AND between the bit field specified by StartBit and EndBit
4519 in Operand and the value specified by AndData. All other bits in Operand are
4520 preserved. The new 64-bit value is returned.
4522 If 64-bit operations are not supported, then ASSERT().
4523 If StartBit is greater than 63, then ASSERT().
4524 If EndBit is greater than 63, then ASSERT().
4525 If EndBit is less than StartBit, then ASSERT().
4526 If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4528 @param Operand Operand on which to perform the bitfield operation.
4529 @param StartBit The ordinal of the least significant bit in the bit field.
4531 @param EndBit The ordinal of the most significant bit in the bit field.
4533 @param AndData The value to AND with the read value from the value
4535 @return The new 64-bit value.
4549 Reads a bit field from a 64-bit value, performs a bitwise AND followed by a
4550 bitwise OR, and returns the result.
4552 Performs a bitwise AND between the bit field specified by StartBit and EndBit
4553 in Operand and the value specified by AndData, followed by a bitwise
4554 OR with value specified by OrData. All other bits in Operand are
4555 preserved. The new 64-bit value is returned.
4557 If 64-bit operations are not supported, then ASSERT().
4558 If StartBit is greater than 63, then ASSERT().
4559 If EndBit is greater than 63, then ASSERT().
4560 If EndBit is less than StartBit, then ASSERT().
4561 If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4562 If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
4564 @param Operand Operand on which to perform the bitfield operation.
4565 @param StartBit The ordinal of the least significant bit in the bit field.
4567 @param EndBit The ordinal of the most significant bit in the bit field.
4569 @param AndData The value to AND with the read value from the value.
4570 @param OrData The value to OR with the result of the AND operation.
4572 @return The new 64-bit value.
4577 BitFieldAndThenOr64 (
4586 // Base Library Checksum Functions
4590 Returns the sum of all elements in a buffer in unit of UINT8.
4591 During calculation, the carry bits are dropped.
4593 This function calculates the sum of all elements in a buffer
4594 in unit of UINT8. The carry bits in result of addition are dropped.
4595 The result is returned as UINT8. If Length is Zero, then Zero is
4598 If Buffer is NULL, then ASSERT().
4599 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
4601 @param Buffer The pointer to the buffer to carry out the sum operation.
4602 @param Length The size, in bytes, of Buffer.
4604 @return Sum The sum of Buffer with carry bits dropped during additions.
4610 IN CONST UINT8
*Buffer
,
4616 Returns the two's complement checksum of all elements in a buffer
4619 This function first calculates the sum of the 8-bit values in the
4620 buffer specified by Buffer and Length. The carry bits in the result
4621 of addition are dropped. Then, the two's complement of the sum is
4622 returned. If Length is 0, then 0 is returned.
4624 If Buffer is NULL, then ASSERT().
4625 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
4627 @param Buffer The pointer to the buffer to carry out the checksum operation.
4628 @param Length The size, in bytes, of Buffer.
4630 @return Checksum The two's complement checksum of Buffer.
4635 CalculateCheckSum8 (
4636 IN CONST UINT8
*Buffer
,
4642 Returns the sum of all elements in a buffer of 16-bit values. During
4643 calculation, the carry bits are dropped.
4645 This function calculates the sum of the 16-bit values in the buffer
4646 specified by Buffer and Length. The carry bits in result of addition are dropped.
4647 The 16-bit result is returned. If Length is 0, then 0 is returned.
4649 If Buffer is NULL, then ASSERT().
4650 If Buffer is not aligned on a 16-bit boundary, then ASSERT().
4651 If Length is not aligned on a 16-bit boundary, then ASSERT().
4652 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
4654 @param Buffer The pointer to the buffer to carry out the sum operation.
4655 @param Length The size, in bytes, of Buffer.
4657 @return Sum The sum of Buffer with carry bits dropped during additions.
4663 IN CONST UINT16
*Buffer
,
4669 Returns the two's complement checksum of all elements in a buffer of
4672 This function first calculates the sum of the 16-bit values in the buffer
4673 specified by Buffer and Length. The carry bits in the result of addition
4674 are dropped. Then, the two's complement of the sum is returned. If Length
4675 is 0, then 0 is returned.
4677 If Buffer is NULL, then ASSERT().
4678 If Buffer is not aligned on a 16-bit boundary, then ASSERT().
4679 If Length is not aligned on a 16-bit boundary, then ASSERT().
4680 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
4682 @param Buffer The pointer to the buffer to carry out the checksum operation.
4683 @param Length The size, in bytes, of Buffer.
4685 @return Checksum The two's complement checksum of Buffer.
4690 CalculateCheckSum16 (
4691 IN CONST UINT16
*Buffer
,
4697 Returns the sum of all elements in a buffer of 32-bit values. During
4698 calculation, the carry bits are dropped.
4700 This function calculates the sum of the 32-bit values in the buffer
4701 specified by Buffer and Length. The carry bits in result of addition are dropped.
4702 The 32-bit result is returned. If Length is 0, then 0 is returned.
4704 If Buffer is NULL, then ASSERT().
4705 If Buffer is not aligned on a 32-bit boundary, then ASSERT().
4706 If Length is not aligned on a 32-bit boundary, then ASSERT().
4707 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
4709 @param Buffer The pointer to the buffer to carry out the sum operation.
4710 @param Length The size, in bytes, of Buffer.
4712 @return Sum The sum of Buffer with carry bits dropped during additions.
4718 IN CONST UINT32
*Buffer
,
4724 Returns the two's complement checksum of all elements in a buffer of
4727 This function first calculates the sum of the 32-bit values in the buffer
4728 specified by Buffer and Length. The carry bits in the result of addition
4729 are dropped. Then, the two's complement of the sum is returned. If Length
4730 is 0, then 0 is returned.
4732 If Buffer is NULL, then ASSERT().
4733 If Buffer is not aligned on a 32-bit boundary, then ASSERT().
4734 If Length is not aligned on a 32-bit boundary, then ASSERT().
4735 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
4737 @param Buffer The pointer to the buffer to carry out the checksum operation.
4738 @param Length The size, in bytes, of Buffer.
4740 @return Checksum The two's complement checksum of Buffer.
4745 CalculateCheckSum32 (
4746 IN CONST UINT32
*Buffer
,
4752 Returns the sum of all elements in a buffer of 64-bit values. During
4753 calculation, the carry bits are dropped.
4755 This function calculates the sum of the 64-bit values in the buffer
4756 specified by Buffer and Length. The carry bits in result of addition are dropped.
4757 The 64-bit result is returned. If Length is 0, then 0 is returned.
4759 If Buffer is NULL, then ASSERT().
4760 If Buffer is not aligned on a 64-bit boundary, then ASSERT().
4761 If Length is not aligned on a 64-bit boundary, then ASSERT().
4762 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
4764 @param Buffer The pointer to the buffer to carry out the sum operation.
4765 @param Length The size, in bytes, of Buffer.
4767 @return Sum The sum of Buffer with carry bits dropped during additions.
4773 IN CONST UINT64
*Buffer
,
4779 Returns the two's complement checksum of all elements in a buffer of
4782 This function first calculates the sum of the 64-bit values in the buffer
4783 specified by Buffer and Length. The carry bits in the result of addition
4784 are dropped. Then, the two's complement of the sum is returned. If Length
4785 is 0, then 0 is returned.
4787 If Buffer is NULL, then ASSERT().
4788 If Buffer is not aligned on a 64-bit boundary, then ASSERT().
4789 If Length is not aligned on a 64-bit boundary, then ASSERT().
4790 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
4792 @param Buffer The pointer to the buffer to carry out the checksum operation.
4793 @param Length The size, in bytes, of Buffer.
4795 @return Checksum The two's complement checksum of Buffer.
4800 CalculateCheckSum64 (
4801 IN CONST UINT64
*Buffer
,
4807 // Base Library CPU Functions
4811 Function entry point used when a stack switch is requested with SwitchStack()
4813 @param Context1 Context1 parameter passed into SwitchStack().
4814 @param Context2 Context2 parameter passed into SwitchStack().
4819 (EFIAPI
*SWITCH_STACK_ENTRY_POINT
)(
4820 IN VOID
*Context1
, OPTIONAL
4821 IN VOID
*Context2 OPTIONAL
4826 Used to serialize load and store operations.
4828 All loads and stores that proceed calls to this function are guaranteed to be
4829 globally visible when this function returns.
4840 Saves the current CPU context that can be restored with a call to LongJump()
4843 Saves the current CPU context in the buffer specified by JumpBuffer and
4844 returns 0. The initial call to SetJump() must always return 0. Subsequent
4845 calls to LongJump() cause a non-zero value to be returned by SetJump().
4847 If JumpBuffer is NULL, then ASSERT().
4848 For Itanium processors, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().
4850 NOTE: The structure BASE_LIBRARY_JUMP_BUFFER is CPU architecture specific.
4851 The same structure must never be used for more than one CPU architecture context.
4852 For example, a BASE_LIBRARY_JUMP_BUFFER allocated by an IA-32 module must never be used from an x64 module.
4853 SetJump()/LongJump() is not currently supported for the EBC processor type.
4855 @param JumpBuffer A pointer to CPU context buffer.
4857 @retval 0 Indicates a return from SetJump().
4863 OUT BASE_LIBRARY_JUMP_BUFFER
*JumpBuffer
4868 Restores the CPU context that was saved with SetJump().
4870 Restores the CPU context from the buffer specified by JumpBuffer. This
4871 function never returns to the caller. Instead is resumes execution based on
4872 the state of JumpBuffer.
4874 If JumpBuffer is NULL, then ASSERT().
4875 For Itanium processors, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().
4876 If Value is 0, then ASSERT().
4878 @param JumpBuffer A pointer to CPU context buffer.
4879 @param Value The value to return when the SetJump() context is
4880 restored and must be non-zero.
4886 IN BASE_LIBRARY_JUMP_BUFFER
*JumpBuffer
,
4892 Enables CPU interrupts.
4903 Disables CPU interrupts.
4914 Disables CPU interrupts and returns the interrupt state prior to the disable
4917 @retval TRUE CPU interrupts were enabled on entry to this call.
4918 @retval FALSE CPU interrupts were disabled on entry to this call.
4923 SaveAndDisableInterrupts (
4929 Enables CPU interrupts for the smallest window required to capture any
4935 EnableDisableInterrupts (
4941 Retrieves the current CPU interrupt state.
4943 Returns TRUE if interrupts are currently enabled. Otherwise
4946 @retval TRUE CPU interrupts are enabled.
4947 @retval FALSE CPU interrupts are disabled.
4958 Set the current CPU interrupt state.
4960 Sets the current CPU interrupt state to the state specified by
4961 InterruptState. If InterruptState is TRUE, then interrupts are enabled. If
4962 InterruptState is FALSE, then interrupts are disabled. InterruptState is
4965 @param InterruptState TRUE if interrupts should enabled. FALSE if
4966 interrupts should be disabled.
4968 @return InterruptState
4974 IN BOOLEAN InterruptState
4979 Requests CPU to pause for a short period of time.
4981 Requests CPU to pause for a short period of time. Typically used in MP
4982 systems to prevent memory starvation while waiting for a spin lock.
4993 Transfers control to a function starting with a new stack.
4995 Transfers control to the function specified by EntryPoint using the
4996 new stack specified by NewStack and passing in the parameters specified
4997 by Context1 and Context2. Context1 and Context2 are optional and may
4998 be NULL. The function EntryPoint must never return. This function
4999 supports a variable number of arguments following the NewStack parameter.
5000 These additional arguments are ignored on IA-32, x64, and EBC architectures.
5001 Itanium processors expect one additional parameter of type VOID * that specifies
5002 the new backing store pointer.
5004 If EntryPoint is NULL, then ASSERT().
5005 If NewStack is NULL, then ASSERT().
5007 @param EntryPoint A pointer to function to call with the new stack.
5008 @param Context1 A pointer to the context to pass into the EntryPoint
5010 @param Context2 A pointer to the context to pass into the EntryPoint
5012 @param NewStack A pointer to the new stack to use for the EntryPoint
5014 @param ... This variable argument list is ignored for IA-32, x64, and
5015 EBC architectures. For Itanium processors, this variable
5016 argument list is expected to contain a single parameter of
5017 type VOID * that specifies the new backing store pointer.
5024 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
5025 IN VOID
*Context1
, OPTIONAL
5026 IN VOID
*Context2
, OPTIONAL
5033 Generates a breakpoint on the CPU.
5035 Generates a breakpoint on the CPU. The breakpoint must be implemented such
5036 that code can resume normal execution after the breakpoint.
5047 Executes an infinite loop.
5049 Forces the CPU to execute an infinite loop. A debugger may be used to skip
5050 past the loop and the code that follows the loop must execute properly. This
5051 implies that the infinite loop must not cause the code that follow it to be
5061 #if defined (MDE_CPU_IPF)
5064 Flush a range of cache lines in the cache coherency domain of the calling
5067 Flushes the cache lines specified by Address and Length. If Address is not aligned
5068 on a cache line boundary, then entire cache line containing Address is flushed.
5069 If Address + Length is not aligned on a cache line boundary, then the entire cache
5070 line containing Address + Length - 1 is flushed. This function may choose to flush
5071 the entire cache if that is more efficient than flushing the specified range. If
5072 Length is 0, the no cache lines are flushed. Address is returned.
5073 This function is only available on Itanium processors.
5075 If Length is greater than (MAX_ADDRESS - Address + 1), then ASSERT().
5077 @param Address The base address of the instruction lines to invalidate. If
5078 the CPU is in a physical addressing mode, then Address is a
5079 physical address. If the CPU is in a virtual addressing mode,
5080 then Address is a virtual address.
5082 @param Length The number of bytes to invalidate from the instruction cache.
5089 AsmFlushCacheRange (
5096 Executes an FC instruction.
5097 Executes an FC instruction on the cache line specified by Address.
5098 The cache line size affected is at least 32-bytes (aligned on a 32-byte boundary).
5099 An implementation may flush a larger region. This function is only available on Itanium processors.
5101 @param Address The Address of cache line to be flushed.
5103 @return The address of FC instruction executed.
5114 Executes an FC.I instruction.
5115 Executes an FC.I instruction on the cache line specified by Address.
5116 The cache line size affected is at least 32-bytes (aligned on a 32-byte boundary).
5117 An implementation may flush a larger region. This function is only available on Itanium processors.
5119 @param Address The Address of cache line to be flushed.
5121 @return The address of the FC.I instruction executed.
5132 Reads the current value of a Processor Identifier Register (CPUID).
5134 Reads and returns the current value of Processor Identifier Register specified by Index.
5135 The Index of largest implemented CPUID (One less than the number of implemented CPUID
5136 registers) is determined by CPUID [3] bits {7:0}.
5137 No parameter checking is performed on Index. If the Index value is beyond the
5138 implemented CPUID register range, a Reserved Register/Field fault may occur. The caller
5139 must either guarantee that Index is valid, or the caller must set up fault handlers to
5140 catch the faults. This function is only available on Itanium processors.
5142 @param Index The 8-bit Processor Identifier Register index to read.
5144 @return The current value of Processor Identifier Register specified by Index.
5155 Reads the current value of 64-bit Processor Status Register (PSR).
5156 This function is only available on Itanium processors.
5158 @return The current value of PSR.
5169 Writes the current value of 64-bit Processor Status Register (PSR).
5171 No parameter checking is performed on Value. All bits of Value corresponding to
5172 reserved fields of PSR must be 0 or a Reserved Register/Field fault may occur.
5173 The caller must either guarantee that Value is valid, or the caller must set up
5174 fault handlers to catch the faults. This function is only available on Itanium processors.
5176 @param Value The 64-bit value to write to PSR.
5178 @return The 64-bit value written to the PSR.
5189 Reads the current value of 64-bit Kernel Register #0 (KR0).
5191 Reads and returns the current value of KR0.
5192 This function is only available on Itanium processors.
5194 @return The current value of KR0.
5205 Reads the current value of 64-bit Kernel Register #1 (KR1).
5207 Reads and returns the current value of KR1.
5208 This function is only available on Itanium processors.
5210 @return The current value of KR1.
5221 Reads the current value of 64-bit Kernel Register #2 (KR2).
5223 Reads and returns the current value of KR2.
5224 This function is only available on Itanium processors.
5226 @return The current value of KR2.
5237 Reads the current value of 64-bit Kernel Register #3 (KR3).
5239 Reads and returns the current value of KR3.
5240 This function is only available on Itanium processors.
5242 @return The current value of KR3.
5253 Reads the current value of 64-bit Kernel Register #4 (KR4).
5255 Reads and returns the current value of KR4.
5256 This function is only available on Itanium processors.
5258 @return The current value of KR4.
5269 Reads the current value of 64-bit Kernel Register #5 (KR5).
5271 Reads and returns the current value of KR5.
5272 This function is only available on Itanium processors.
5274 @return The current value of KR5.
5285 Reads the current value of 64-bit Kernel Register #6 (KR6).
5287 Reads and returns the current value of KR6.
5288 This function is only available on Itanium processors.
5290 @return The current value of KR6.
5301 Reads the current value of 64-bit Kernel Register #7 (KR7).
5303 Reads and returns the current value of KR7.
5304 This function is only available on Itanium processors.
5306 @return The current value of KR7.
5317 Write the current value of 64-bit Kernel Register #0 (KR0).
5319 Writes the current value of KR0. The 64-bit value written to
5320 the KR0 is returned. This function is only available on Itanium processors.
5322 @param Value The 64-bit value to write to KR0.
5324 @return The 64-bit value written to the KR0.
5335 Write the current value of 64-bit Kernel Register #1 (KR1).
5337 Writes the current value of KR1. The 64-bit value written to
5338 the KR1 is returned. This function is only available on Itanium processors.
5340 @param Value The 64-bit value to write to KR1.
5342 @return The 64-bit value written to the KR1.
5353 Write the current value of 64-bit Kernel Register #2 (KR2).
5355 Writes the current value of KR2. The 64-bit value written to
5356 the KR2 is returned. This function is only available on Itanium processors.
5358 @param Value The 64-bit value to write to KR2.
5360 @return The 64-bit value written to the KR2.
5371 Write the current value of 64-bit Kernel Register #3 (KR3).
5373 Writes the current value of KR3. The 64-bit value written to
5374 the KR3 is returned. This function is only available on Itanium processors.
5376 @param Value The 64-bit value to write to KR3.
5378 @return The 64-bit value written to the KR3.
5389 Write the current value of 64-bit Kernel Register #4 (KR4).
5391 Writes the current value of KR4. The 64-bit value written to
5392 the KR4 is returned. This function is only available on Itanium processors.
5394 @param Value The 64-bit value to write to KR4.
5396 @return The 64-bit value written to the KR4.
5407 Write the current value of 64-bit Kernel Register #5 (KR5).
5409 Writes the current value of KR5. The 64-bit value written to
5410 the KR5 is returned. This function is only available on Itanium processors.
5412 @param Value The 64-bit value to write to KR5.
5414 @return The 64-bit value written to the KR5.
5425 Write the current value of 64-bit Kernel Register #6 (KR6).
5427 Writes the current value of KR6. The 64-bit value written to
5428 the KR6 is returned. This function is only available on Itanium processors.
5430 @param Value The 64-bit value to write to KR6.
5432 @return The 64-bit value written to the KR6.
5443 Write the current value of 64-bit Kernel Register #7 (KR7).
5445 Writes the current value of KR7. The 64-bit value written to
5446 the KR7 is returned. This function is only available on Itanium processors.
5448 @param Value The 64-bit value to write to KR7.
5450 @return The 64-bit value written to the KR7.
5461 Reads the current value of Interval Timer Counter Register (ITC).
5463 Reads and returns the current value of ITC.
5464 This function is only available on Itanium processors.
5466 @return The current value of ITC.
5477 Reads the current value of Interval Timer Vector Register (ITV).
5479 Reads and returns the current value of ITV.
5480 This function is only available on Itanium processors.
5482 @return The current value of ITV.
5493 Reads the current value of Interval Timer Match Register (ITM).
5495 Reads and returns the current value of ITM.
5496 This function is only available on Itanium processors.
5498 @return The current value of ITM.
5508 Writes the current value of 64-bit Interval Timer Counter Register (ITC).
5510 Writes the current value of ITC. The 64-bit value written to the ITC is returned.
5511 This function is only available on Itanium processors.
5513 @param Value The 64-bit value to write to ITC.
5515 @return The 64-bit value written to the ITC.
5526 Writes the current value of 64-bit Interval Timer Match Register (ITM).
5528 Writes the current value of ITM. The 64-bit value written to the ITM is returned.
5529 This function is only available on Itanium processors.
5531 @param Value The 64-bit value to write to ITM.
5533 @return The 64-bit value written to the ITM.
5544 Writes the current value of 64-bit Interval Timer Vector Register (ITV).
5546 Writes the current value of ITV. The 64-bit value written to the ITV is returned.
5547 No parameter checking is performed on Value. All bits of Value corresponding to
5548 reserved fields of ITV must be 0 or a Reserved Register/Field fault may occur.
5549 The caller must either guarantee that Value is valid, or the caller must set up
5550 fault handlers to catch the faults.
5551 This function is only available on Itanium processors.
5553 @param Value The 64-bit value to write to ITV.
5555 @return The 64-bit value written to the ITV.
5566 Reads the current value of Default Control Register (DCR).
5568 Reads and returns the current value of DCR. This function is only available on Itanium processors.
5570 @return The current value of DCR.
5581 Reads the current value of Interruption Vector Address Register (IVA).
5583 Reads and returns the current value of IVA. This function is only available on Itanium processors.
5585 @return The current value of IVA.
5595 Reads the current value of Page Table Address Register (PTA).
5597 Reads and returns the current value of PTA. This function is only available on Itanium processors.
5599 @return The current value of PTA.
5610 Writes the current value of 64-bit Default Control Register (DCR).
5612 Writes the current value of DCR. The 64-bit value written to the DCR is returned.
5613 No parameter checking is performed on Value. All bits of Value corresponding to
5614 reserved fields of DCR must be 0 or a Reserved Register/Field fault may occur.
5615 The caller must either guarantee that Value is valid, or the caller must set up
5616 fault handlers to catch the faults.
5617 This function is only available on Itanium processors.
5619 @param Value The 64-bit value to write to DCR.
5621 @return The 64-bit value written to the DCR.
5632 Writes the current value of 64-bit Interruption Vector Address Register (IVA).
5634 Writes the current value of IVA. The 64-bit value written to the IVA is returned.
5635 The size of vector table is 32 K bytes and is 32 K bytes aligned
5636 the low 15 bits of Value is ignored when written.
5637 This function is only available on Itanium processors.
5639 @param Value The 64-bit value to write to IVA.
5641 @return The 64-bit value written to the IVA.
5652 Writes the current value of 64-bit Page Table Address Register (PTA).
5654 Writes the current value of PTA. The 64-bit value written to the PTA is returned.
5655 No parameter checking is performed on Value. All bits of Value corresponding to
5656 reserved fields of DCR must be 0 or a Reserved Register/Field fault may occur.
5657 The caller must either guarantee that Value is valid, or the caller must set up
5658 fault handlers to catch the faults.
5659 This function is only available on Itanium processors.
5661 @param Value The 64-bit value to write to PTA.
5663 @return The 64-bit value written to the PTA.
5673 Reads the current value of Local Interrupt ID Register (LID).
5675 Reads and returns the current value of LID. This function is only available on Itanium processors.
5677 @return The current value of LID.
5688 Reads the current value of External Interrupt Vector Register (IVR).
5690 Reads and returns the current value of IVR. This function is only available on Itanium processors.
5692 @return The current value of IVR.
5703 Reads the current value of Task Priority Register (TPR).
5705 Reads and returns the current value of TPR. This function is only available on Itanium processors.
5707 @return The current value of TPR.
5718 Reads the current value of External Interrupt Request Register #0 (IRR0).
5720 Reads and returns the current value of IRR0. This function is only available on Itanium processors.
5722 @return The current value of IRR0.
5733 Reads the current value of External Interrupt Request Register #1 (IRR1).
5735 Reads and returns the current value of IRR1. This function is only available on Itanium processors.
5737 @return The current value of IRR1.
5748 Reads the current value of External Interrupt Request Register #2 (IRR2).
5750 Reads and returns the current value of IRR2. This function is only available on Itanium processors.
5752 @return The current value of IRR2.
5763 Reads the current value of External Interrupt Request Register #3 (IRR3).
5765 Reads and returns the current value of IRR3. This function is only available on Itanium processors.
5767 @return The current value of IRR3.
5778 Reads the current value of Performance Monitor Vector Register (PMV).
5780 Reads and returns the current value of PMV. This function is only available on Itanium processors.
5782 @return The current value of PMV.
5793 Reads the current value of Corrected Machine Check Vector Register (CMCV).
5795 Reads and returns the current value of CMCV. This function is only available on Itanium processors.
5797 @return The current value of CMCV.
5808 Reads the current value of Local Redirection Register #0 (LRR0).
5810 Reads and returns the current value of LRR0. This function is only available on Itanium processors.
5812 @return The current value of LRR0.
5823 Reads the current value of Local Redirection Register #1 (LRR1).
5825 Reads and returns the current value of LRR1. This function is only available on Itanium processors.
5827 @return The current value of LRR1.
5838 Writes the current value of 64-bit Page Local Interrupt ID Register (LID).
5840 Writes the current value of LID. The 64-bit value written to the LID is returned.
5841 No parameter checking is performed on Value. All bits of Value corresponding to
5842 reserved fields of LID must be 0 or a Reserved Register/Field fault may occur.
5843 The caller must either guarantee that Value is valid, or the caller must set up
5844 fault handlers to catch the faults.
5845 This function is only available on Itanium processors.
5847 @param Value The 64-bit value to write to LID.
5849 @return The 64-bit value written to the LID.
5860 Writes the current value of 64-bit Task Priority Register (TPR).
5862 Writes the current value of TPR. The 64-bit value written to the TPR is returned.
5863 No parameter checking is performed on Value. All bits of Value corresponding to
5864 reserved fields of TPR must be 0 or a Reserved Register/Field fault may occur.
5865 The caller must either guarantee that Value is valid, or the caller must set up
5866 fault handlers to catch the faults.
5867 This function is only available on Itanium processors.
5869 @param Value The 64-bit value to write to TPR.
5871 @return The 64-bit value written to the TPR.
5882 Performs a write operation on End OF External Interrupt Register (EOI).
5884 Writes a value of 0 to the EOI Register. This function is only available on Itanium processors.
5895 Writes the current value of 64-bit Performance Monitor Vector Register (PMV).
5897 Writes the current value of PMV. The 64-bit value written to the PMV is returned.
5898 No parameter checking is performed on Value. All bits of Value corresponding
5899 to reserved fields of PMV must be 0 or a Reserved Register/Field fault may occur.
5900 The caller must either guarantee that Value is valid, or the caller must set up
5901 fault handlers to catch the faults.
5902 This function is only available on Itanium processors.
5904 @param Value The 64-bit value to write to PMV.
5906 @return The 64-bit value written to the PMV.
5917 Writes the current value of 64-bit Corrected Machine Check Vector Register (CMCV).
5919 Writes the current value of CMCV. The 64-bit value written to the CMCV is returned.
5920 No parameter checking is performed on Value. All bits of Value corresponding
5921 to reserved fields of CMCV must be 0 or a Reserved Register/Field fault may occur.
5922 The caller must either guarantee that Value is valid, or the caller must set up
5923 fault handlers to catch the faults.
5924 This function is only available on Itanium processors.
5926 @param Value The 64-bit value to write to CMCV.
5928 @return The 64-bit value written to the CMCV.
5939 Writes the current value of 64-bit Local Redirection Register #0 (LRR0).
5941 Writes the current value of LRR0. The 64-bit value written to the LRR0 is returned.
5942 No parameter checking is performed on Value. All bits of Value corresponding
5943 to reserved fields of LRR0 must be 0 or a Reserved Register/Field fault may occur.
5944 The caller must either guarantee that Value is valid, or the caller must set up
5945 fault handlers to catch the faults.
5946 This function is only available on Itanium processors.
5948 @param Value The 64-bit value to write to LRR0.
5950 @return The 64-bit value written to the LRR0.
5961 Writes the current value of 64-bit Local Redirection Register #1 (LRR1).
5963 Writes the current value of LRR1. The 64-bit value written to the LRR1 is returned.
5964 No parameter checking is performed on Value. All bits of Value corresponding
5965 to reserved fields of LRR1 must be 0 or a Reserved Register/Field fault may occur.
5966 The caller must either guarantee that Value is valid, or the caller must
5967 set up fault handlers to catch the faults.
5968 This function is only available on Itanium processors.
5970 @param Value The 64-bit value to write to LRR1.
5972 @return The 64-bit value written to the LRR1.
5983 Reads the current value of Instruction Breakpoint Register (IBR).
5985 The Instruction Breakpoint Registers are used in pairs. The even numbered
5986 registers contain breakpoint addresses, and the odd numbered registers contain
5987 breakpoint mask conditions. At least four instruction registers pairs are implemented
5988 on all processor models. Implemented registers are contiguous starting with
5989 register 0. No parameter checking is performed on Index, and if the Index value
5990 is beyond the implemented IBR register range, a Reserved Register/Field fault may
5991 occur. The caller must either guarantee that Index is valid, or the caller must
5992 set up fault handlers to catch the faults.
5993 This function is only available on Itanium processors.
5995 @param Index The 8-bit Instruction Breakpoint Register index to read.
5997 @return The current value of Instruction Breakpoint Register specified by Index.
6008 Reads the current value of Data Breakpoint Register (DBR).
6010 The Data Breakpoint Registers are used in pairs. The even numbered registers
6011 contain breakpoint addresses, and odd numbered registers contain breakpoint
6012 mask conditions. At least four data registers pairs are implemented on all processor
6013 models. Implemented registers are contiguous starting with register 0.
6014 No parameter checking is performed on Index. If the Index value is beyond
6015 the implemented DBR register range, a Reserved Register/Field fault may occur.
6016 The caller must either guarantee that Index is valid, or the caller must set up
6017 fault handlers to catch the faults.
6018 This function is only available on Itanium processors.
6020 @param Index The 8-bit Data Breakpoint Register index to read.
6022 @return The current value of Data Breakpoint Register specified by Index.
6033 Reads the current value of Performance Monitor Configuration Register (PMC).
6035 All processor implementations provide at least four performance counters
6036 (PMC/PMD [4]...PMC/PMD [7] pairs), and four performance monitor counter overflow
6037 status registers (PMC [0]... PMC [3]). Processor implementations may provide
6038 additional implementation-dependent PMC and PMD to increase the number of
6039 'generic' performance counters (PMC/PMD pairs). The remainder of PMC and PMD
6040 register set is implementation dependent. No parameter checking is performed
6041 on Index. If the Index value is beyond the implemented PMC register range,
6042 zero value will be returned.
6043 This function is only available on Itanium processors.
6045 @param Index The 8-bit Performance Monitor Configuration Register index to read.
6047 @return The current value of Performance Monitor Configuration Register
6059 Reads the current value of Performance Monitor Data Register (PMD).
6061 All processor implementations provide at least 4 performance counters
6062 (PMC/PMD [4]...PMC/PMD [7] pairs), and 4 performance monitor counter
6063 overflow status registers (PMC [0]... PMC [3]). Processor implementations may
6064 provide additional implementation-dependent PMC and PMD to increase the number
6065 of 'generic' performance counters (PMC/PMD pairs). The remainder of PMC and PMD
6066 register set is implementation dependent. No parameter checking is performed
6067 on Index. If the Index value is beyond the implemented PMD register range,
6068 zero value will be returned.
6069 This function is only available on Itanium processors.
6071 @param Index The 8-bit Performance Monitor Data Register index to read.
6073 @return The current value of Performance Monitor Data Register specified by Index.
6084 Writes the current value of 64-bit Instruction Breakpoint Register (IBR).
6086 Writes current value of Instruction Breakpoint Register specified by Index.
6087 The Instruction Breakpoint Registers are used in pairs. The even numbered
6088 registers contain breakpoint addresses, and odd numbered registers contain
6089 breakpoint mask conditions. At least four instruction registers pairs are implemented
6090 on all processor models. Implemented registers are contiguous starting with
6091 register 0. No parameter checking is performed on Index. If the Index value
6092 is beyond the implemented IBR register range, a Reserved Register/Field fault may
6093 occur. The caller must either guarantee that Index is valid, or the caller must
6094 set up fault handlers to catch the faults.
6095 This function is only available on Itanium processors.
6097 @param Index The 8-bit Instruction Breakpoint Register index to write.
6098 @param Value The 64-bit value to write to IBR.
6100 @return The 64-bit value written to the IBR.
6112 Writes the current value of 64-bit Data Breakpoint Register (DBR).
6114 Writes current value of Data Breakpoint Register specified by Index.
6115 The Data Breakpoint Registers are used in pairs. The even numbered registers
6116 contain breakpoint addresses, and odd numbered registers contain breakpoint
6117 mask conditions. At least four data registers pairs are implemented on all processor
6118 models. Implemented registers are contiguous starting with register 0. No parameter
6119 checking is performed on Index. If the Index value is beyond the implemented
6120 DBR register range, a Reserved Register/Field fault may occur. The caller must
6121 either guarantee that Index is valid, or the caller must set up fault handlers to
6123 This function is only available on Itanium processors.
6125 @param Index The 8-bit Data Breakpoint Register index to write.
6126 @param Value The 64-bit value to write to DBR.
6128 @return The 64-bit value written to the DBR.
6140 Writes the current value of 64-bit Performance Monitor Configuration Register (PMC).
6142 Writes current value of Performance Monitor Configuration Register specified by Index.
6143 All processor implementations provide at least four performance counters
6144 (PMC/PMD [4]...PMC/PMD [7] pairs), and four performance monitor counter overflow status
6145 registers (PMC [0]... PMC [3]). Processor implementations may provide additional
6146 implementation-dependent PMC and PMD to increase the number of 'generic' performance
6147 counters (PMC/PMD pairs). The remainder of PMC and PMD register set is implementation
6148 dependent. No parameter checking is performed on Index. If the Index value is
6149 beyond the implemented PMC register range, the write is ignored.
6150 This function is only available on Itanium processors.
6152 @param Index The 8-bit Performance Monitor Configuration Register index to write.
6153 @param Value The 64-bit value to write to PMC.
6155 @return The 64-bit value written to the PMC.
6167 Writes the current value of 64-bit Performance Monitor Data Register (PMD).
6169 Writes current value of Performance Monitor Data Register specified by Index.
6170 All processor implementations provide at least four performance counters
6171 (PMC/PMD [4]...PMC/PMD [7] pairs), and four performance monitor counter overflow
6172 status registers (PMC [0]... PMC [3]). Processor implementations may provide
6173 additional implementation-dependent PMC and PMD to increase the number of 'generic'
6174 performance counters (PMC/PMD pairs). The remainder of PMC and PMD register set
6175 is implementation dependent. No parameter checking is performed on Index. If the
6176 Index value is beyond the implemented PMD register range, the write is ignored.
6177 This function is only available on Itanium processors.
6179 @param Index The 8-bit Performance Monitor Data Register index to write.
6180 @param Value The 64-bit value to write to PMD.
6182 @return The 64-bit value written to the PMD.
6194 Reads the current value of 64-bit Global Pointer (GP).
6196 Reads and returns the current value of GP.
6197 This function is only available on Itanium processors.
6199 @return The current value of GP.
6210 Write the current value of 64-bit Global Pointer (GP).
6212 Writes the current value of GP. The 64-bit value written to the GP is returned.
6213 No parameter checking is performed on Value.
6214 This function is only available on Itanium processors.
6216 @param Value The 64-bit value to write to GP.
6218 @return The 64-bit value written to the GP.
6229 Reads the current value of 64-bit Stack Pointer (SP).
6231 Reads and returns the current value of SP.
6232 This function is only available on Itanium processors.
6234 @return The current value of SP.
6245 /// Valid Index value for AsmReadControlRegister().
6247 #define IPF_CONTROL_REGISTER_DCR 0
6248 #define IPF_CONTROL_REGISTER_ITM 1
6249 #define IPF_CONTROL_REGISTER_IVA 2
6250 #define IPF_CONTROL_REGISTER_PTA 8
6251 #define IPF_CONTROL_REGISTER_IPSR 16
6252 #define IPF_CONTROL_REGISTER_ISR 17
6253 #define IPF_CONTROL_REGISTER_IIP 19
6254 #define IPF_CONTROL_REGISTER_IFA 20
6255 #define IPF_CONTROL_REGISTER_ITIR 21
6256 #define IPF_CONTROL_REGISTER_IIPA 22
6257 #define IPF_CONTROL_REGISTER_IFS 23
6258 #define IPF_CONTROL_REGISTER_IIM 24
6259 #define IPF_CONTROL_REGISTER_IHA 25
6260 #define IPF_CONTROL_REGISTER_LID 64
6261 #define IPF_CONTROL_REGISTER_IVR 65
6262 #define IPF_CONTROL_REGISTER_TPR 66
6263 #define IPF_CONTROL_REGISTER_EOI 67
6264 #define IPF_CONTROL_REGISTER_IRR0 68
6265 #define IPF_CONTROL_REGISTER_IRR1 69
6266 #define IPF_CONTROL_REGISTER_IRR2 70
6267 #define IPF_CONTROL_REGISTER_IRR3 71
6268 #define IPF_CONTROL_REGISTER_ITV 72
6269 #define IPF_CONTROL_REGISTER_PMV 73
6270 #define IPF_CONTROL_REGISTER_CMCV 74
6271 #define IPF_CONTROL_REGISTER_LRR0 80
6272 #define IPF_CONTROL_REGISTER_LRR1 81
6275 Reads a 64-bit control register.
6277 Reads and returns the control register specified by Index. The valid Index valued
6278 are defined above in "Related Definitions".
6279 If Index is invalid then 0xFFFFFFFFFFFFFFFF is returned. This function is only
6280 available on Itanium processors.
6282 @param Index The index of the control register to read.
6284 @return The control register specified by Index.
6289 AsmReadControlRegister (
6295 /// Valid Index value for AsmReadApplicationRegister().
6297 #define IPF_APPLICATION_REGISTER_K0 0
6298 #define IPF_APPLICATION_REGISTER_K1 1
6299 #define IPF_APPLICATION_REGISTER_K2 2
6300 #define IPF_APPLICATION_REGISTER_K3 3
6301 #define IPF_APPLICATION_REGISTER_K4 4
6302 #define IPF_APPLICATION_REGISTER_K5 5
6303 #define IPF_APPLICATION_REGISTER_K6 6
6304 #define IPF_APPLICATION_REGISTER_K7 7
6305 #define IPF_APPLICATION_REGISTER_RSC 16
6306 #define IPF_APPLICATION_REGISTER_BSP 17
6307 #define IPF_APPLICATION_REGISTER_BSPSTORE 18
6308 #define IPF_APPLICATION_REGISTER_RNAT 19
6309 #define IPF_APPLICATION_REGISTER_FCR 21
6310 #define IPF_APPLICATION_REGISTER_EFLAG 24
6311 #define IPF_APPLICATION_REGISTER_CSD 25
6312 #define IPF_APPLICATION_REGISTER_SSD 26
6313 #define IPF_APPLICATION_REGISTER_CFLG 27
6314 #define IPF_APPLICATION_REGISTER_FSR 28
6315 #define IPF_APPLICATION_REGISTER_FIR 29
6316 #define IPF_APPLICATION_REGISTER_FDR 30
6317 #define IPF_APPLICATION_REGISTER_CCV 32
6318 #define IPF_APPLICATION_REGISTER_UNAT 36
6319 #define IPF_APPLICATION_REGISTER_FPSR 40
6320 #define IPF_APPLICATION_REGISTER_ITC 44
6321 #define IPF_APPLICATION_REGISTER_PFS 64
6322 #define IPF_APPLICATION_REGISTER_LC 65
6323 #define IPF_APPLICATION_REGISTER_EC 66
6326 Reads a 64-bit application register.
6328 Reads and returns the application register specified by Index. The valid Index
6329 valued are defined above in "Related Definitions".
6330 If Index is invalid then 0xFFFFFFFFFFFFFFFF is returned. This function is only
6331 available on Itanium processors.
6333 @param Index The index of the application register to read.
6335 @return The application register specified by Index.
6340 AsmReadApplicationRegister (
6346 Reads the current value of a Machine Specific Register (MSR).
6348 Reads and returns the current value of the Machine Specific Register specified by Index. No
6349 parameter checking is performed on Index, and if the Index value is beyond the implemented MSR
6350 register range, a Reserved Register/Field fault may occur. The caller must either guarantee that
6351 Index is valid, or the caller must set up fault handlers to catch the faults. This function is
6352 only available on Itanium processors.
6354 @param Index The 8-bit Machine Specific Register index to read.
6356 @return The current value of the Machine Specific Register specified by Index.
6367 Writes the current value of a Machine Specific Register (MSR).
6369 Writes Value to the Machine Specific Register specified by Index. Value is returned. No
6370 parameter checking is performed on Index, and if the Index value is beyond the implemented MSR
6371 register range, a Reserved Register/Field fault may occur. The caller must either guarantee that
6372 Index is valid, or the caller must set up fault handlers to catch the faults. This function is
6373 only available on Itanium processors.
6375 @param Index The 8-bit Machine Specific Register index to write.
6376 @param Value The 64-bit value to write to the Machine Specific Register.
6378 @return The 64-bit value to write to the Machine Specific Register.
6390 Determines if the CPU is currently executing in virtual, physical, or mixed mode.
6392 Determines the current execution mode of the CPU.
6393 If the CPU is in virtual mode(PSR.RT=1, PSR.DT=1, PSR.IT=1), then 1 is returned.
6394 If the CPU is in physical mode(PSR.RT=0, PSR.DT=0, PSR.IT=0), then 0 is returned.
6395 If the CPU is not in physical mode or virtual mode, then it is in mixed mode,
6397 This function is only available on Itanium processors.
6399 @retval 1 The CPU is in virtual mode.
6400 @retval 0 The CPU is in physical mode.
6401 @retval -1 The CPU is in mixed mode.
6412 Makes a PAL procedure call.
6414 This is a wrapper function to make a PAL procedure call. Based on the Index
6415 value this API will make static or stacked PAL call. The following table
6416 describes the usage of PAL Procedure Index Assignment. Architected procedures
6417 may be designated as required or optional. If a PAL procedure is specified
6418 as optional, a unique return code of 0xFFFFFFFFFFFFFFFF is returned in the
6419 Status field of the PAL_CALL_RETURN structure.
6420 This indicates that the procedure is not present in this PAL implementation.
6421 It is the caller's responsibility to check for this return code after calling
6422 any optional PAL procedure.
6423 No parameter checking is performed on the 5 input parameters, but there are
6424 some common rules that the caller should follow when making a PAL call. Any
6425 address passed to PAL as buffers for return parameters must be 8-byte aligned.
6426 Unaligned addresses may cause undefined results. For those parameters defined
6427 as reserved or some fields defined as reserved must be zero filled or the invalid
6428 argument return value may be returned or undefined result may occur during the
6429 execution of the procedure. If the PalEntryPoint does not point to a valid
6430 PAL entry point then the system behavior is undefined. This function is only
6431 available on Itanium processors.
6433 @param PalEntryPoint The PAL procedure calls entry point.
6434 @param Index The PAL procedure Index number.
6435 @param Arg2 The 2nd parameter for PAL procedure calls.
6436 @param Arg3 The 3rd parameter for PAL procedure calls.
6437 @param Arg4 The 4th parameter for PAL procedure calls.
6439 @return structure returned from the PAL Call procedure, including the status and return value.
6445 IN UINT64 PalEntryPoint
,
6453 #if defined (MDE_CPU_IA32) || defined (MDE_CPU_X64)
6455 /// IA32 and x64 Specific Functions.
6456 /// Byte packed structure for 16-bit Real Mode EFLAGS.
6460 UINT32 CF
:1; ///< Carry Flag.
6461 UINT32 Reserved_0
:1; ///< Reserved.
6462 UINT32 PF
:1; ///< Parity Flag.
6463 UINT32 Reserved_1
:1; ///< Reserved.
6464 UINT32 AF
:1; ///< Auxiliary Carry Flag.
6465 UINT32 Reserved_2
:1; ///< Reserved.
6466 UINT32 ZF
:1; ///< Zero Flag.
6467 UINT32 SF
:1; ///< Sign Flag.
6468 UINT32 TF
:1; ///< Trap Flag.
6469 UINT32 IF
:1; ///< Interrupt Enable Flag.
6470 UINT32 DF
:1; ///< Direction Flag.
6471 UINT32 OF
:1; ///< Overflow Flag.
6472 UINT32 IOPL
:2; ///< I/O Privilege Level.
6473 UINT32 NT
:1; ///< Nested Task.
6474 UINT32 Reserved_3
:1; ///< Reserved.
6480 /// Byte packed structure for EFLAGS/RFLAGS.
6481 /// 32-bits on IA-32.
6482 /// 64-bits on x64. The upper 32-bits on x64 are reserved.
6486 UINT32 CF
:1; ///< Carry Flag.
6487 UINT32 Reserved_0
:1; ///< Reserved.
6488 UINT32 PF
:1; ///< Parity Flag.
6489 UINT32 Reserved_1
:1; ///< Reserved.
6490 UINT32 AF
:1; ///< Auxiliary Carry Flag.
6491 UINT32 Reserved_2
:1; ///< Reserved.
6492 UINT32 ZF
:1; ///< Zero Flag.
6493 UINT32 SF
:1; ///< Sign Flag.
6494 UINT32 TF
:1; ///< Trap Flag.
6495 UINT32 IF
:1; ///< Interrupt Enable Flag.
6496 UINT32 DF
:1; ///< Direction Flag.
6497 UINT32 OF
:1; ///< Overflow Flag.
6498 UINT32 IOPL
:2; ///< I/O Privilege Level.
6499 UINT32 NT
:1; ///< Nested Task.
6500 UINT32 Reserved_3
:1; ///< Reserved.
6501 UINT32 RF
:1; ///< Resume Flag.
6502 UINT32 VM
:1; ///< Virtual 8086 Mode.
6503 UINT32 AC
:1; ///< Alignment Check.
6504 UINT32 VIF
:1; ///< Virtual Interrupt Flag.
6505 UINT32 VIP
:1; ///< Virtual Interrupt Pending.
6506 UINT32 ID
:1; ///< ID Flag.
6507 UINT32 Reserved_4
:10; ///< Reserved.
6513 /// Byte packed structure for Control Register 0 (CR0).
6514 /// 32-bits on IA-32.
6515 /// 64-bits on x64. The upper 32-bits on x64 are reserved.
6519 UINT32 PE
:1; ///< Protection Enable.
6520 UINT32 MP
:1; ///< Monitor Coprocessor.
6521 UINT32 EM
:1; ///< Emulation.
6522 UINT32 TS
:1; ///< Task Switched.
6523 UINT32 ET
:1; ///< Extension Type.
6524 UINT32 NE
:1; ///< Numeric Error.
6525 UINT32 Reserved_0
:10; ///< Reserved.
6526 UINT32 WP
:1; ///< Write Protect.
6527 UINT32 Reserved_1
:1; ///< Reserved.
6528 UINT32 AM
:1; ///< Alignment Mask.
6529 UINT32 Reserved_2
:10; ///< Reserved.
6530 UINT32 NW
:1; ///< Mot Write-through.
6531 UINT32 CD
:1; ///< Cache Disable.
6532 UINT32 PG
:1; ///< Paging.
6538 /// Byte packed structure for Control Register 4 (CR4).
6539 /// 32-bits on IA-32.
6540 /// 64-bits on x64. The upper 32-bits on x64 are reserved.
6544 UINT32 VME
:1; ///< Virtual-8086 Mode Extensions.
6545 UINT32 PVI
:1; ///< Protected-Mode Virtual Interrupts.
6546 UINT32 TSD
:1; ///< Time Stamp Disable.
6547 UINT32 DE
:1; ///< Debugging Extensions.
6548 UINT32 PSE
:1; ///< Page Size Extensions.
6549 UINT32 PAE
:1; ///< Physical Address Extension.
6550 UINT32 MCE
:1; ///< Machine Check Enable.
6551 UINT32 PGE
:1; ///< Page Global Enable.
6552 UINT32 PCE
:1; ///< Performance Monitoring Counter
6554 UINT32 OSFXSR
:1; ///< Operating System Support for
6555 ///< FXSAVE and FXRSTOR instructions
6556 UINT32 OSXMMEXCPT
:1; ///< Operating System Support for
6557 ///< Unmasked SIMD Floating Point
6559 UINT32 Reserved_0
:2; ///< Reserved.
6560 UINT32 VMXE
:1; ///< VMX Enable
6561 UINT32 Reserved_1
:18; ///< Reserved.
6567 /// Byte packed structure for a segment descriptor in a GDT/LDT.
6586 } IA32_SEGMENT_DESCRIPTOR
;
6589 /// Byte packed structure for an IDTR, GDTR, LDTR descriptor.
6598 #define IA32_IDT_GATE_TYPE_TASK 0x85
6599 #define IA32_IDT_GATE_TYPE_INTERRUPT_16 0x86
6600 #define IA32_IDT_GATE_TYPE_TRAP_16 0x87
6601 #define IA32_IDT_GATE_TYPE_INTERRUPT_32 0x8E
6602 #define IA32_IDT_GATE_TYPE_TRAP_32 0x8F
6605 #if defined (MDE_CPU_IA32)
6607 /// Byte packed structure for an IA-32 Interrupt Gate Descriptor.
6611 UINT32 OffsetLow
:16; ///< Offset bits 15..0.
6612 UINT32 Selector
:16; ///< Selector.
6613 UINT32 Reserved_0
:8; ///< Reserved.
6614 UINT32 GateType
:8; ///< Gate Type. See #defines above.
6615 UINT32 OffsetHigh
:16; ///< Offset bits 31..16.
6618 } IA32_IDT_GATE_DESCRIPTOR
;
6622 #if defined (MDE_CPU_X64)
6624 /// Byte packed structure for an x64 Interrupt Gate Descriptor.
6628 UINT32 OffsetLow
:16; ///< Offset bits 15..0.
6629 UINT32 Selector
:16; ///< Selector.
6630 UINT32 Reserved_0
:8; ///< Reserved.
6631 UINT32 GateType
:8; ///< Gate Type. See #defines above.
6632 UINT32 OffsetHigh
:16; ///< Offset bits 31..16.
6633 UINT32 OffsetUpper
:32; ///< Offset bits 63..32.
6634 UINT32 Reserved_1
:32; ///< Reserved.
6640 } IA32_IDT_GATE_DESCRIPTOR
;
6645 /// Byte packed structure for an FP/SSE/SSE2 context.
6652 /// Structures for the 16-bit real mode thunks.
6705 IA32_EFLAGS32 EFLAGS
;
6715 } IA32_REGISTER_SET
;
6718 /// Byte packed structure for an 16-bit real mode thunks.
6721 IA32_REGISTER_SET
*RealModeState
;
6722 VOID
*RealModeBuffer
;
6723 UINT32 RealModeBufferSize
;
6724 UINT32 ThunkAttributes
;
6727 #define THUNK_ATTRIBUTE_BIG_REAL_MODE 0x00000001
6728 #define THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 0x00000002
6729 #define THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL 0x00000004
6732 Retrieves CPUID information.
6734 Executes the CPUID instruction with EAX set to the value specified by Index.
6735 This function always returns Index.
6736 If Eax is not NULL, then the value of EAX after CPUID is returned in Eax.
6737 If Ebx is not NULL, then the value of EBX after CPUID is returned in Ebx.
6738 If Ecx is not NULL, then the value of ECX after CPUID is returned in Ecx.
6739 If Edx is not NULL, then the value of EDX after CPUID is returned in Edx.
6740 This function is only available on IA-32 and x64.
6742 @param Index The 32-bit value to load into EAX prior to invoking the CPUID
6744 @param Eax The pointer to the 32-bit EAX value returned by the CPUID
6745 instruction. This is an optional parameter that may be NULL.
6746 @param Ebx The pointer to the 32-bit EBX value returned by the CPUID
6747 instruction. This is an optional parameter that may be NULL.
6748 @param Ecx The pointer to the 32-bit ECX value returned by the CPUID
6749 instruction. This is an optional parameter that may be NULL.
6750 @param Edx The pointer to the 32-bit EDX value returned by the CPUID
6751 instruction. This is an optional parameter that may be NULL.
6760 OUT UINT32
*Eax
, OPTIONAL
6761 OUT UINT32
*Ebx
, OPTIONAL
6762 OUT UINT32
*Ecx
, OPTIONAL
6763 OUT UINT32
*Edx OPTIONAL
6768 Retrieves CPUID information using an extended leaf identifier.
6770 Executes the CPUID instruction with EAX set to the value specified by Index
6771 and ECX set to the value specified by SubIndex. This function always returns
6772 Index. This function is only available on IA-32 and x64.
6774 If Eax is not NULL, then the value of EAX after CPUID is returned in Eax.
6775 If Ebx is not NULL, then the value of EBX after CPUID is returned in Ebx.
6776 If Ecx is not NULL, then the value of ECX after CPUID is returned in Ecx.
6777 If Edx is not NULL, then the value of EDX after CPUID is returned in Edx.
6779 @param Index The 32-bit value to load into EAX prior to invoking the
6781 @param SubIndex The 32-bit value to load into ECX prior to invoking the
6783 @param Eax The pointer to the 32-bit EAX value returned by the CPUID
6784 instruction. This is an optional parameter that may be
6786 @param Ebx The pointer to the 32-bit EBX value returned by the CPUID
6787 instruction. This is an optional parameter that may be
6789 @param Ecx The pointer to the 32-bit ECX value returned by the CPUID
6790 instruction. This is an optional parameter that may be
6792 @param Edx The pointer to the 32-bit EDX value returned by the CPUID
6793 instruction. This is an optional parameter that may be
6804 OUT UINT32
*Eax
, OPTIONAL
6805 OUT UINT32
*Ebx
, OPTIONAL
6806 OUT UINT32
*Ecx
, OPTIONAL
6807 OUT UINT32
*Edx OPTIONAL
6812 Set CD bit and clear NW bit of CR0 followed by a WBINVD.
6814 Disables the caches by setting the CD bit of CR0 to 1, clearing the NW bit of CR0 to 0,
6815 and executing a WBINVD instruction. This function is only available on IA-32 and x64.
6826 Perform a WBINVD and clear both the CD and NW bits of CR0.
6828 Enables the caches by executing a WBINVD instruction and then clear both the CD and NW
6829 bits of CR0 to 0. This function is only available on IA-32 and x64.
6840 Returns the lower 32-bits of a Machine Specific Register(MSR).
6842 Reads and returns the lower 32-bits of the MSR specified by Index.
6843 No parameter checking is performed on Index, and some Index values may cause
6844 CPU exceptions. The caller must either guarantee that Index is valid, or the
6845 caller must set up exception handlers to catch the exceptions. This function
6846 is only available on IA-32 and x64.
6848 @param Index The 32-bit MSR index to read.
6850 @return The lower 32 bits of the MSR identified by Index.
6861 Writes a 32-bit value to a Machine Specific Register(MSR), and returns the value.
6862 The upper 32-bits of the MSR are set to zero.
6864 Writes the 32-bit value specified by Value to the MSR specified by Index. The
6865 upper 32-bits of the MSR write are set to zero. The 32-bit value written to
6866 the MSR is returned. No parameter checking is performed on Index or Value,
6867 and some of these may cause CPU exceptions. The caller must either guarantee
6868 that Index and Value are valid, or the caller must establish proper exception
6869 handlers. This function is only available on IA-32 and x64.
6871 @param Index The 32-bit MSR index to write.
6872 @param Value The 32-bit value to write to the MSR.
6886 Reads a 64-bit MSR, performs a bitwise OR on the lower 32-bits, and
6887 writes the result back to the 64-bit MSR.
6889 Reads the 64-bit MSR specified by Index, performs a bitwise OR
6890 between the lower 32-bits of the read result and the value specified by
6891 OrData, and writes the result to the 64-bit MSR specified by Index. The lower
6892 32-bits of the value written to the MSR is returned. No parameter checking is
6893 performed on Index or OrData, and some of these may cause CPU exceptions. The
6894 caller must either guarantee that Index and OrData are valid, or the caller
6895 must establish proper exception handlers. This function is only available on
6898 @param Index The 32-bit MSR index to write.
6899 @param OrData The value to OR with the read value from the MSR.
6901 @return The lower 32-bit value written to the MSR.
6913 Reads a 64-bit MSR, performs a bitwise AND on the lower 32-bits, and writes
6914 the result back to the 64-bit MSR.
6916 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
6917 lower 32-bits of the read result and the value specified by AndData, and
6918 writes the result to the 64-bit MSR specified by Index. The lower 32-bits of
6919 the value written to the MSR is returned. No parameter checking is performed
6920 on Index or AndData, and some of these may cause CPU exceptions. The caller
6921 must either guarantee that Index and AndData are valid, or the caller must
6922 establish proper exception handlers. This function is only available on IA-32
6925 @param Index The 32-bit MSR index to write.
6926 @param AndData The value to AND with the read value from the MSR.
6928 @return The lower 32-bit value written to the MSR.
6940 Reads a 64-bit MSR, performs a bitwise AND followed by a bitwise OR
6941 on the lower 32-bits, and writes the result back to the 64-bit MSR.
6943 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
6944 lower 32-bits of the read result and the value specified by AndData
6945 preserving the upper 32-bits, performs a bitwise OR between the
6946 result of the AND operation and the value specified by OrData, and writes the
6947 result to the 64-bit MSR specified by Address. The lower 32-bits of the value
6948 written to the MSR is returned. No parameter checking is performed on Index,
6949 AndData, or OrData, and some of these may cause CPU exceptions. The caller
6950 must either guarantee that Index, AndData, and OrData are valid, or the
6951 caller must establish proper exception handlers. This function is only
6952 available on IA-32 and x64.
6954 @param Index The 32-bit MSR index to write.
6955 @param AndData The value to AND with the read value from the MSR.
6956 @param OrData The value to OR with the result of the AND operation.
6958 @return The lower 32-bit value written to the MSR.
6971 Reads a bit field of an MSR.
6973 Reads the bit field in the lower 32-bits of a 64-bit MSR. The bit field is
6974 specified by the StartBit and the EndBit. The value of the bit field is
6975 returned. The caller must either guarantee that Index is valid, or the caller
6976 must set up exception handlers to catch the exceptions. This function is only
6977 available on IA-32 and x64.
6979 If StartBit is greater than 31, then ASSERT().
6980 If EndBit is greater than 31, then ASSERT().
6981 If EndBit is less than StartBit, then ASSERT().
6983 @param Index The 32-bit MSR index to read.
6984 @param StartBit The ordinal of the least significant bit in the bit field.
6986 @param EndBit The ordinal of the most significant bit in the bit field.
6989 @return The bit field read from the MSR.
6994 AsmMsrBitFieldRead32 (
7002 Writes a bit field to an MSR.
7004 Writes Value to a bit field in the lower 32-bits of a 64-bit MSR. The bit
7005 field is specified by the StartBit and the EndBit. All other bits in the
7006 destination MSR are preserved. The lower 32-bits of the MSR written is
7007 returned. The caller must either guarantee that Index and the data written
7008 is valid, or the caller must set up exception handlers to catch the exceptions.
7009 This function is only available on IA-32 and x64.
7011 If StartBit is greater than 31, then ASSERT().
7012 If EndBit is greater than 31, then ASSERT().
7013 If EndBit is less than StartBit, then ASSERT().
7014 If Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
7016 @param Index The 32-bit MSR index to write.
7017 @param StartBit The ordinal of the least significant bit in the bit field.
7019 @param EndBit The ordinal of the most significant bit in the bit field.
7021 @param Value New value of the bit field.
7023 @return The lower 32-bit of the value written to the MSR.
7028 AsmMsrBitFieldWrite32 (
7037 Reads a bit field in a 64-bit MSR, performs a bitwise OR, and writes the
7038 result back to the bit field in the 64-bit MSR.
7040 Reads the 64-bit MSR specified by Index, performs a bitwise OR
7041 between the read result and the value specified by OrData, and writes the
7042 result to the 64-bit MSR specified by Index. The lower 32-bits of the value
7043 written to the MSR are returned. Extra left bits in OrData are stripped. The
7044 caller must either guarantee that Index and the data written is valid, or
7045 the caller must set up exception handlers to catch the exceptions. This
7046 function is only available on IA-32 and x64.
7048 If StartBit is greater than 31, then ASSERT().
7049 If EndBit is greater than 31, then ASSERT().
7050 If EndBit is less than StartBit, then ASSERT().
7051 If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
7053 @param Index The 32-bit MSR index to write.
7054 @param StartBit The ordinal of the least significant bit in the bit field.
7056 @param EndBit The ordinal of the most significant bit in the bit field.
7058 @param OrData The value to OR with the read value from the MSR.
7060 @return The lower 32-bit of the value written to the MSR.
7065 AsmMsrBitFieldOr32 (
7074 Reads a bit field in a 64-bit MSR, performs a bitwise AND, and writes the
7075 result back to the bit field in the 64-bit MSR.
7077 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
7078 read result and the value specified by AndData, and writes the result to the
7079 64-bit MSR specified by Index. The lower 32-bits of the value written to the
7080 MSR are returned. Extra left bits in AndData are stripped. The caller must
7081 either guarantee that Index and the data written is valid, or the caller must
7082 set up exception handlers to catch the exceptions. This function is only
7083 available on IA-32 and x64.
7085 If StartBit is greater than 31, then ASSERT().
7086 If EndBit is greater than 31, then ASSERT().
7087 If EndBit is less than StartBit, then ASSERT().
7088 If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
7090 @param Index The 32-bit MSR index to write.
7091 @param StartBit The ordinal of the least significant bit in the bit field.
7093 @param EndBit The ordinal of the most significant bit in the bit field.
7095 @param AndData The value to AND with the read value from the MSR.
7097 @return The lower 32-bit of the value written to the MSR.
7102 AsmMsrBitFieldAnd32 (
7111 Reads a bit field in a 64-bit MSR, performs a bitwise AND followed by a
7112 bitwise OR, and writes the result back to the bit field in the
7115 Reads the 64-bit MSR specified by Index, performs a bitwise AND followed by a
7116 bitwise OR between the read result and the value specified by
7117 AndData, and writes the result to the 64-bit MSR specified by Index. The
7118 lower 32-bits of the value written to the MSR are returned. Extra left bits
7119 in both AndData and OrData are stripped. The caller must either guarantee
7120 that Index and the data written is valid, or the caller must set up exception
7121 handlers to catch the exceptions. This function is only available on IA-32
7124 If StartBit is greater than 31, then ASSERT().
7125 If EndBit is greater than 31, then ASSERT().
7126 If EndBit is less than StartBit, then ASSERT().
7127 If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
7128 If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
7130 @param Index The 32-bit MSR index to write.
7131 @param StartBit The ordinal of the least significant bit in the bit field.
7133 @param EndBit The ordinal of the most significant bit in the bit field.
7135 @param AndData The value to AND with the read value from the MSR.
7136 @param OrData The value to OR with the result of the AND operation.
7138 @return The lower 32-bit of the value written to the MSR.
7143 AsmMsrBitFieldAndThenOr32 (
7153 Returns a 64-bit Machine Specific Register(MSR).
7155 Reads and returns the 64-bit MSR specified by Index. No parameter checking is
7156 performed on Index, and some Index values may cause CPU exceptions. The
7157 caller must either guarantee that Index is valid, or the caller must set up
7158 exception handlers to catch the exceptions. This function is only available
7161 @param Index The 32-bit MSR index to read.
7163 @return The value of the MSR identified by Index.
7174 Writes a 64-bit value to a Machine Specific Register(MSR), and returns the
7177 Writes the 64-bit value specified by Value to the MSR specified by Index. The
7178 64-bit value written to the MSR is returned. No parameter checking is
7179 performed on Index or Value, and some of these may cause CPU exceptions. The
7180 caller must either guarantee that Index and Value are valid, or the caller
7181 must establish proper exception handlers. This function is only available on
7184 @param Index The 32-bit MSR index to write.
7185 @param Value The 64-bit value to write to the MSR.
7199 Reads a 64-bit MSR, performs a bitwise OR, and writes the result
7200 back to the 64-bit MSR.
7202 Reads the 64-bit MSR specified by Index, performs a bitwise OR
7203 between the read result and the value specified by OrData, and writes the
7204 result to the 64-bit MSR specified by Index. The value written to the MSR is
7205 returned. No parameter checking is performed on Index or OrData, and some of
7206 these may cause CPU exceptions. The caller must either guarantee that Index
7207 and OrData are valid, or the caller must establish proper exception handlers.
7208 This function is only available on IA-32 and x64.
7210 @param Index The 32-bit MSR index to write.
7211 @param OrData The value to OR with the read value from the MSR.
7213 @return The value written back to the MSR.
7225 Reads a 64-bit MSR, performs a bitwise AND, and writes the result back to the
7228 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
7229 read result and the value specified by OrData, and writes the result to the
7230 64-bit MSR specified by Index. The value written to the MSR is returned. No
7231 parameter checking is performed on Index or OrData, and some of these may
7232 cause CPU exceptions. The caller must either guarantee that Index and OrData
7233 are valid, or the caller must establish proper exception handlers. This
7234 function is only available on IA-32 and x64.
7236 @param Index The 32-bit MSR index to write.
7237 @param AndData The value to AND with the read value from the MSR.
7239 @return The value written back to the MSR.
7251 Reads a 64-bit MSR, performs a bitwise AND followed by a bitwise
7252 OR, and writes the result back to the 64-bit MSR.
7254 Reads the 64-bit MSR specified by Index, performs a bitwise AND between read
7255 result and the value specified by AndData, performs a bitwise OR
7256 between the result of the AND operation and the value specified by OrData,
7257 and writes the result to the 64-bit MSR specified by Index. The value written
7258 to the MSR is returned. No parameter checking is performed on Index, AndData,
7259 or OrData, and some of these may cause CPU exceptions. The caller must either
7260 guarantee that Index, AndData, and OrData are valid, or the caller must
7261 establish proper exception handlers. This function is only available on IA-32
7264 @param Index The 32-bit MSR index to write.
7265 @param AndData The value to AND with the read value from the MSR.
7266 @param OrData The value to OR with the result of the AND operation.
7268 @return The value written back to the MSR.
7281 Reads a bit field of an MSR.
7283 Reads the bit field in the 64-bit MSR. The bit field is specified by the
7284 StartBit and the EndBit. The value of the bit field is returned. The caller
7285 must either guarantee that Index is valid, or the caller must set up
7286 exception handlers to catch the exceptions. This function is only available
7289 If StartBit is greater than 63, then ASSERT().
7290 If EndBit is greater than 63, then ASSERT().
7291 If EndBit is less than StartBit, then ASSERT().
7293 @param Index The 32-bit MSR index to read.
7294 @param StartBit The ordinal of the least significant bit in the bit field.
7296 @param EndBit The ordinal of the most significant bit in the bit field.
7299 @return The value read from the MSR.
7304 AsmMsrBitFieldRead64 (
7312 Writes a bit field to an MSR.
7314 Writes Value to a bit field in a 64-bit MSR. The bit field is specified by
7315 the StartBit and the EndBit. All other bits in the destination MSR are
7316 preserved. The MSR written is returned. The caller must either guarantee
7317 that Index and the data written is valid, or the caller must set up exception
7318 handlers to catch the exceptions. This function is only available on IA-32 and x64.
7320 If StartBit is greater than 63, then ASSERT().
7321 If EndBit is greater than 63, then ASSERT().
7322 If EndBit is less than StartBit, then ASSERT().
7323 If Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
7325 @param Index The 32-bit MSR index to write.
7326 @param StartBit The ordinal of the least significant bit in the bit field.
7328 @param EndBit The ordinal of the most significant bit in the bit field.
7330 @param Value New value of the bit field.
7332 @return The value written back to the MSR.
7337 AsmMsrBitFieldWrite64 (
7346 Reads a bit field in a 64-bit MSR, performs a bitwise OR, and
7347 writes the result back to the bit field in the 64-bit MSR.
7349 Reads the 64-bit MSR specified by Index, performs a bitwise OR
7350 between the read result and the value specified by OrData, and writes the
7351 result to the 64-bit MSR specified by Index. The value written to the MSR is
7352 returned. Extra left bits in OrData are stripped. The caller must either
7353 guarantee that Index and the data written is valid, or the caller must set up
7354 exception handlers to catch the exceptions. This function is only available
7357 If StartBit is greater than 63, then ASSERT().
7358 If EndBit is greater than 63, then ASSERT().
7359 If EndBit is less than StartBit, then ASSERT().
7360 If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
7362 @param Index The 32-bit MSR index to write.
7363 @param StartBit The ordinal of the least significant bit in the bit field.
7365 @param EndBit The ordinal of the most significant bit in the bit field.
7367 @param OrData The value to OR with the read value from the bit field.
7369 @return The value written back to the MSR.
7374 AsmMsrBitFieldOr64 (
7383 Reads a bit field in a 64-bit MSR, performs a bitwise AND, and writes the
7384 result back to the bit field in the 64-bit MSR.
7386 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
7387 read result and the value specified by AndData, and writes the result to the
7388 64-bit MSR specified by Index. The value written to the MSR is returned.
7389 Extra left bits in AndData are stripped. The caller must either guarantee
7390 that Index and the data written is valid, or the caller must set up exception
7391 handlers to catch the exceptions. This function is only available on IA-32
7394 If StartBit is greater than 63, then ASSERT().
7395 If EndBit is greater than 63, then ASSERT().
7396 If EndBit is less than StartBit, then ASSERT().
7397 If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
7399 @param Index The 32-bit MSR index to write.
7400 @param StartBit The ordinal of the least significant bit in the bit field.
7402 @param EndBit The ordinal of the most significant bit in the bit field.
7404 @param AndData The value to AND with the read value from the bit field.
7406 @return The value written back to the MSR.
7411 AsmMsrBitFieldAnd64 (
7420 Reads a bit field in a 64-bit MSR, performs a bitwise AND followed by a
7421 bitwise OR, and writes the result back to the bit field in the
7424 Reads the 64-bit MSR specified by Index, performs a bitwise AND followed by
7425 a bitwise OR between the read result and the value specified by
7426 AndData, and writes the result to the 64-bit MSR specified by Index. The
7427 value written to the MSR is returned. Extra left bits in both AndData and
7428 OrData are stripped. The caller must either guarantee that Index and the data
7429 written is valid, or the caller must set up exception handlers to catch the
7430 exceptions. This function is only available on IA-32 and x64.
7432 If StartBit is greater than 63, then ASSERT().
7433 If EndBit is greater than 63, then ASSERT().
7434 If EndBit is less than StartBit, then ASSERT().
7435 If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
7436 If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
7438 @param Index The 32-bit MSR index to write.
7439 @param StartBit The ordinal of the least significant bit in the bit field.
7441 @param EndBit The ordinal of the most significant bit in the bit field.
7443 @param AndData The value to AND with the read value from the bit field.
7444 @param OrData The value to OR with the result of the AND operation.
7446 @return The value written back to the MSR.
7451 AsmMsrBitFieldAndThenOr64 (
7461 Reads the current value of the EFLAGS register.
7463 Reads and returns the current value of the EFLAGS register. This function is
7464 only available on IA-32 and x64. This returns a 32-bit value on IA-32 and a
7465 64-bit value on x64.
7467 @return EFLAGS on IA-32 or RFLAGS on x64.
7478 Reads the current value of the Control Register 0 (CR0).
7480 Reads and returns the current value of CR0. This function is only available
7481 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
7484 @return The value of the Control Register 0 (CR0).
7495 Reads the current value of the Control Register 2 (CR2).
7497 Reads and returns the current value of CR2. This function is only available
7498 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
7501 @return The value of the Control Register 2 (CR2).
7512 Reads the current value of the Control Register 3 (CR3).
7514 Reads and returns the current value of CR3. This function is only available
7515 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
7518 @return The value of the Control Register 3 (CR3).
7529 Reads the current value of the Control Register 4 (CR4).
7531 Reads and returns the current value of CR4. This function is only available
7532 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
7535 @return The value of the Control Register 4 (CR4).
7546 Writes a value to Control Register 0 (CR0).
7548 Writes and returns a new value to CR0. This function is only available on
7549 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
7551 @param Cr0 The value to write to CR0.
7553 @return The value written to CR0.
7564 Writes a value to Control Register 2 (CR2).
7566 Writes and returns a new value to CR2. This function is only available on
7567 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
7569 @param Cr2 The value to write to CR2.
7571 @return The value written to CR2.
7582 Writes a value to Control Register 3 (CR3).
7584 Writes and returns a new value to CR3. This function is only available on
7585 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
7587 @param Cr3 The value to write to CR3.
7589 @return The value written to CR3.
7600 Writes a value to Control Register 4 (CR4).
7602 Writes and returns a new value to CR4. This function is only available on
7603 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
7605 @param Cr4 The value to write to CR4.
7607 @return The value written to CR4.
7618 Reads the current value of Debug Register 0 (DR0).
7620 Reads and returns the current value of DR0. This function is only available
7621 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
7624 @return The value of Debug Register 0 (DR0).
7635 Reads the current value of Debug Register 1 (DR1).
7637 Reads and returns the current value of DR1. This function is only available
7638 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
7641 @return The value of Debug Register 1 (DR1).
7652 Reads the current value of Debug Register 2 (DR2).
7654 Reads and returns the current value of DR2. This function is only available
7655 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
7658 @return The value of Debug Register 2 (DR2).
7669 Reads the current value of Debug Register 3 (DR3).
7671 Reads and returns the current value of DR3. This function is only available
7672 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
7675 @return The value of Debug Register 3 (DR3).
7686 Reads the current value of Debug Register 4 (DR4).
7688 Reads and returns the current value of DR4. This function is only available
7689 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
7692 @return The value of Debug Register 4 (DR4).
7703 Reads the current value of Debug Register 5 (DR5).
7705 Reads and returns the current value of DR5. This function is only available
7706 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
7709 @return The value of Debug Register 5 (DR5).
7720 Reads the current value of Debug Register 6 (DR6).
7722 Reads and returns the current value of DR6. This function is only available
7723 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
7726 @return The value of Debug Register 6 (DR6).
7737 Reads the current value of Debug Register 7 (DR7).
7739 Reads and returns the current value of DR7. This function is only available
7740 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
7743 @return The value of Debug Register 7 (DR7).
7754 Writes a value to Debug Register 0 (DR0).
7756 Writes and returns a new value to DR0. This function is only available on
7757 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
7759 @param Dr0 The value to write to Dr0.
7761 @return The value written to Debug Register 0 (DR0).
7772 Writes a value to Debug Register 1 (DR1).
7774 Writes and returns a new value to DR1. This function is only available on
7775 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
7777 @param Dr1 The value to write to Dr1.
7779 @return The value written to Debug Register 1 (DR1).
7790 Writes a value to Debug Register 2 (DR2).
7792 Writes and returns a new value to DR2. This function is only available on
7793 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
7795 @param Dr2 The value to write to Dr2.
7797 @return The value written to Debug Register 2 (DR2).
7808 Writes a value to Debug Register 3 (DR3).
7810 Writes and returns a new value to DR3. This function is only available on
7811 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
7813 @param Dr3 The value to write to Dr3.
7815 @return The value written to Debug Register 3 (DR3).
7826 Writes a value to Debug Register 4 (DR4).
7828 Writes and returns a new value to DR4. This function is only available on
7829 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
7831 @param Dr4 The value to write to Dr4.
7833 @return The value written to Debug Register 4 (DR4).
7844 Writes a value to Debug Register 5 (DR5).
7846 Writes and returns a new value to DR5. This function is only available on
7847 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
7849 @param Dr5 The value to write to Dr5.
7851 @return The value written to Debug Register 5 (DR5).
7862 Writes a value to Debug Register 6 (DR6).
7864 Writes and returns a new value to DR6. This function is only available on
7865 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
7867 @param Dr6 The value to write to Dr6.
7869 @return The value written to Debug Register 6 (DR6).
7880 Writes a value to Debug Register 7 (DR7).
7882 Writes and returns a new value to DR7. This function is only available on
7883 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
7885 @param Dr7 The value to write to Dr7.
7887 @return The value written to Debug Register 7 (DR7).
7898 Reads the current value of Code Segment Register (CS).
7900 Reads and returns the current value of CS. This function is only available on
7903 @return The current value of CS.
7914 Reads the current value of Data Segment Register (DS).
7916 Reads and returns the current value of DS. This function is only available on
7919 @return The current value of DS.
7930 Reads the current value of Extra Segment Register (ES).
7932 Reads and returns the current value of ES. This function is only available on
7935 @return The current value of ES.
7946 Reads the current value of FS Data Segment Register (FS).
7948 Reads and returns the current value of FS. This function is only available on
7951 @return The current value of FS.
7962 Reads the current value of GS Data Segment Register (GS).
7964 Reads and returns the current value of GS. This function is only available on
7967 @return The current value of GS.
7978 Reads the current value of Stack Segment Register (SS).
7980 Reads and returns the current value of SS. This function is only available on
7983 @return The current value of SS.
7994 Reads the current value of Task Register (TR).
7996 Reads and returns the current value of TR. This function is only available on
7999 @return The current value of TR.
8010 Reads the current Global Descriptor Table Register(GDTR) descriptor.
8012 Reads and returns the current GDTR descriptor and returns it in Gdtr. This
8013 function is only available on IA-32 and x64.
8015 If Gdtr is NULL, then ASSERT().
8017 @param Gdtr The pointer to a GDTR descriptor.
8023 OUT IA32_DESCRIPTOR
*Gdtr
8028 Writes the current Global Descriptor Table Register (GDTR) descriptor.
8030 Writes and the current GDTR descriptor specified by Gdtr. This function is
8031 only available on IA-32 and x64.
8033 If Gdtr is NULL, then ASSERT().
8035 @param Gdtr The pointer to a GDTR descriptor.
8041 IN CONST IA32_DESCRIPTOR
*Gdtr
8046 Reads the current Interrupt Descriptor Table Register(IDTR) descriptor.
8048 Reads and returns the current IDTR descriptor and returns it in Idtr. This
8049 function is only available on IA-32 and x64.
8051 If Idtr is NULL, then ASSERT().
8053 @param Idtr The pointer to a IDTR descriptor.
8059 OUT IA32_DESCRIPTOR
*Idtr
8064 Writes the current Interrupt Descriptor Table Register(IDTR) descriptor.
8066 Writes the current IDTR descriptor and returns it in Idtr. This function is
8067 only available on IA-32 and x64.
8069 If Idtr is NULL, then ASSERT().
8071 @param Idtr The pointer to a IDTR descriptor.
8077 IN CONST IA32_DESCRIPTOR
*Idtr
8082 Reads the current Local Descriptor Table Register(LDTR) selector.
8084 Reads and returns the current 16-bit LDTR descriptor value. This function is
8085 only available on IA-32 and x64.
8087 @return The current selector of LDT.
8098 Writes the current Local Descriptor Table Register (LDTR) selector.
8100 Writes and the current LDTR descriptor specified by Ldtr. This function is
8101 only available on IA-32 and x64.
8103 @param Ldtr 16-bit LDTR selector value.
8114 Save the current floating point/SSE/SSE2 context to a buffer.
8116 Saves the current floating point/SSE/SSE2 state to the buffer specified by
8117 Buffer. Buffer must be aligned on a 16-byte boundary. This function is only
8118 available on IA-32 and x64.
8120 If Buffer is NULL, then ASSERT().
8121 If Buffer is not aligned on a 16-byte boundary, then ASSERT().
8123 @param Buffer The pointer to a buffer to save the floating point/SSE/SSE2 context.
8129 OUT IA32_FX_BUFFER
*Buffer
8134 Restores the current floating point/SSE/SSE2 context from a buffer.
8136 Restores the current floating point/SSE/SSE2 state from the buffer specified
8137 by Buffer. Buffer must be aligned on a 16-byte boundary. This function is
8138 only available on IA-32 and x64.
8140 If Buffer is NULL, then ASSERT().
8141 If Buffer is not aligned on a 16-byte boundary, then ASSERT().
8142 If Buffer was not saved with AsmFxSave(), then ASSERT().
8144 @param Buffer The pointer to a buffer to save the floating point/SSE/SSE2 context.
8150 IN CONST IA32_FX_BUFFER
*Buffer
8155 Reads the current value of 64-bit MMX Register #0 (MM0).
8157 Reads and returns the current value of MM0. This function is only available
8160 @return The current value of MM0.
8171 Reads the current value of 64-bit MMX Register #1 (MM1).
8173 Reads and returns the current value of MM1. This function is only available
8176 @return The current value of MM1.
8187 Reads the current value of 64-bit MMX Register #2 (MM2).
8189 Reads and returns the current value of MM2. This function is only available
8192 @return The current value of MM2.
8203 Reads the current value of 64-bit MMX Register #3 (MM3).
8205 Reads and returns the current value of MM3. This function is only available
8208 @return The current value of MM3.
8219 Reads the current value of 64-bit MMX Register #4 (MM4).
8221 Reads and returns the current value of MM4. This function is only available
8224 @return The current value of MM4.
8235 Reads the current value of 64-bit MMX Register #5 (MM5).
8237 Reads and returns the current value of MM5. This function is only available
8240 @return The current value of MM5.
8251 Reads the current value of 64-bit MMX Register #6 (MM6).
8253 Reads and returns the current value of MM6. This function is only available
8256 @return The current value of MM6.
8267 Reads the current value of 64-bit MMX Register #7 (MM7).
8269 Reads and returns the current value of MM7. This function is only available
8272 @return The current value of MM7.
8283 Writes the current value of 64-bit MMX Register #0 (MM0).
8285 Writes the current value of MM0. This function is only available on IA32 and
8288 @param Value The 64-bit value to write to MM0.
8299 Writes the current value of 64-bit MMX Register #1 (MM1).
8301 Writes the current value of MM1. This function is only available on IA32 and
8304 @param Value The 64-bit value to write to MM1.
8315 Writes the current value of 64-bit MMX Register #2 (MM2).
8317 Writes the current value of MM2. This function is only available on IA32 and
8320 @param Value The 64-bit value to write to MM2.
8331 Writes the current value of 64-bit MMX Register #3 (MM3).
8333 Writes the current value of MM3. This function is only available on IA32 and
8336 @param Value The 64-bit value to write to MM3.
8347 Writes the current value of 64-bit MMX Register #4 (MM4).
8349 Writes the current value of MM4. This function is only available on IA32 and
8352 @param Value The 64-bit value to write to MM4.
8363 Writes the current value of 64-bit MMX Register #5 (MM5).
8365 Writes the current value of MM5. This function is only available on IA32 and
8368 @param Value The 64-bit value to write to MM5.
8379 Writes the current value of 64-bit MMX Register #6 (MM6).
8381 Writes the current value of MM6. This function is only available on IA32 and
8384 @param Value The 64-bit value to write to MM6.
8395 Writes the current value of 64-bit MMX Register #7 (MM7).
8397 Writes the current value of MM7. This function is only available on IA32 and
8400 @param Value The 64-bit value to write to MM7.
8411 Reads the current value of Time Stamp Counter (TSC).
8413 Reads and returns the current value of TSC. This function is only available
8416 @return The current value of TSC
8427 Reads the current value of a Performance Counter (PMC).
8429 Reads and returns the current value of performance counter specified by
8430 Index. This function is only available on IA-32 and x64.
8432 @param Index The 32-bit Performance Counter index to read.
8434 @return The value of the PMC specified by Index.
8445 Sets up a monitor buffer that is used by AsmMwait().
8447 Executes a MONITOR instruction with the register state specified by Eax, Ecx
8448 and Edx. Returns Eax. This function is only available on IA-32 and x64.
8450 @param Eax The value to load into EAX or RAX before executing the MONITOR
8452 @param Ecx The value to load into ECX or RCX before executing the MONITOR
8454 @param Edx The value to load into EDX or RDX before executing the MONITOR
8470 Executes an MWAIT instruction.
8472 Executes an MWAIT instruction with the register state specified by Eax and
8473 Ecx. Returns Eax. This function is only available on IA-32 and x64.
8475 @param Eax The value to load into EAX or RAX before executing the MONITOR
8477 @param Ecx The value to load into ECX or RCX before executing the MONITOR
8492 Executes a WBINVD instruction.
8494 Executes a WBINVD instruction. This function is only available on IA-32 and
8506 Executes a INVD instruction.
8508 Executes a INVD instruction. This function is only available on IA-32 and
8520 Flushes a cache line from all the instruction and data caches within the
8521 coherency domain of the CPU.
8523 Flushed the cache line specified by LinearAddress, and returns LinearAddress.
8524 This function is only available on IA-32 and x64.
8526 @param LinearAddress The address of the cache line to flush. If the CPU is
8527 in a physical addressing mode, then LinearAddress is a
8528 physical address. If the CPU is in a virtual
8529 addressing mode, then LinearAddress is a virtual
8532 @return LinearAddress.
8537 IN VOID
*LinearAddress
8542 Enables the 32-bit paging mode on the CPU.
8544 Enables the 32-bit paging mode on the CPU. CR0, CR3, CR4, and the page tables
8545 must be properly initialized prior to calling this service. This function
8546 assumes the current execution mode is 32-bit protected mode. This function is
8547 only available on IA-32. After the 32-bit paging mode is enabled, control is
8548 transferred to the function specified by EntryPoint using the new stack
8549 specified by NewStack and passing in the parameters specified by Context1 and
8550 Context2. Context1 and Context2 are optional and may be NULL. The function
8551 EntryPoint must never return.
8553 If the current execution mode is not 32-bit protected mode, then ASSERT().
8554 If EntryPoint is NULL, then ASSERT().
8555 If NewStack is NULL, then ASSERT().
8557 There are a number of constraints that must be followed before calling this
8559 1) Interrupts must be disabled.
8560 2) The caller must be in 32-bit protected mode with flat descriptors. This
8561 means all descriptors must have a base of 0 and a limit of 4GB.
8562 3) CR0 and CR4 must be compatible with 32-bit protected mode with flat
8564 4) CR3 must point to valid page tables that will be used once the transition
8565 is complete, and those page tables must guarantee that the pages for this
8566 function and the stack are identity mapped.
8568 @param EntryPoint A pointer to function to call with the new stack after
8570 @param Context1 A pointer to the context to pass into the EntryPoint
8571 function as the first parameter after paging is enabled.
8572 @param Context2 A pointer to the context to pass into the EntryPoint
8573 function as the second parameter after paging is enabled.
8574 @param NewStack A pointer to the new stack to use for the EntryPoint
8575 function after paging is enabled.
8581 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
8582 IN VOID
*Context1
, OPTIONAL
8583 IN VOID
*Context2
, OPTIONAL
8589 Disables the 32-bit paging mode on the CPU.
8591 Disables the 32-bit paging mode on the CPU and returns to 32-bit protected
8592 mode. This function assumes the current execution mode is 32-paged protected
8593 mode. This function is only available on IA-32. After the 32-bit paging mode
8594 is disabled, control is transferred to the function specified by EntryPoint
8595 using the new stack specified by NewStack and passing in the parameters
8596 specified by Context1 and Context2. Context1 and Context2 are optional and
8597 may be NULL. The function EntryPoint must never return.
8599 If the current execution mode is not 32-bit paged mode, then ASSERT().
8600 If EntryPoint is NULL, then ASSERT().
8601 If NewStack is NULL, then ASSERT().
8603 There are a number of constraints that must be followed before calling this
8605 1) Interrupts must be disabled.
8606 2) The caller must be in 32-bit paged mode.
8607 3) CR0, CR3, and CR4 must be compatible with 32-bit paged mode.
8608 4) CR3 must point to valid page tables that guarantee that the pages for
8609 this function and the stack are identity mapped.
8611 @param EntryPoint A pointer to function to call with the new stack after
8613 @param Context1 A pointer to the context to pass into the EntryPoint
8614 function as the first parameter after paging is disabled.
8615 @param Context2 A pointer to the context to pass into the EntryPoint
8616 function as the second parameter after paging is
8618 @param NewStack A pointer to the new stack to use for the EntryPoint
8619 function after paging is disabled.
8624 AsmDisablePaging32 (
8625 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
8626 IN VOID
*Context1
, OPTIONAL
8627 IN VOID
*Context2
, OPTIONAL
8633 Enables the 64-bit paging mode on the CPU.
8635 Enables the 64-bit paging mode on the CPU. CR0, CR3, CR4, and the page tables
8636 must be properly initialized prior to calling this service. This function
8637 assumes the current execution mode is 32-bit protected mode with flat
8638 descriptors. This function is only available on IA-32. After the 64-bit
8639 paging mode is enabled, control is transferred to the function specified by
8640 EntryPoint using the new stack specified by NewStack and passing in the
8641 parameters specified by Context1 and Context2. Context1 and Context2 are
8642 optional and may be 0. The function EntryPoint must never return.
8644 If the current execution mode is not 32-bit protected mode with flat
8645 descriptors, then ASSERT().
8646 If EntryPoint is 0, then ASSERT().
8647 If NewStack is 0, then ASSERT().
8649 @param Cs The 16-bit selector to load in the CS before EntryPoint
8650 is called. The descriptor in the GDT that this selector
8651 references must be setup for long mode.
8652 @param EntryPoint The 64-bit virtual address of the function to call with
8653 the new stack after paging is enabled.
8654 @param Context1 The 64-bit virtual address of the context to pass into
8655 the EntryPoint function as the first parameter after
8657 @param Context2 The 64-bit virtual address of the context to pass into
8658 the EntryPoint function as the second parameter after
8660 @param NewStack The 64-bit virtual address of the new stack to use for
8661 the EntryPoint function after paging is enabled.
8668 IN UINT64 EntryPoint
,
8669 IN UINT64 Context1
, OPTIONAL
8670 IN UINT64 Context2
, OPTIONAL
8676 Disables the 64-bit paging mode on the CPU.
8678 Disables the 64-bit paging mode on the CPU and returns to 32-bit protected
8679 mode. This function assumes the current execution mode is 64-paging mode.
8680 This function is only available on x64. After the 64-bit paging mode is
8681 disabled, control is transferred to the function specified by EntryPoint
8682 using the new stack specified by NewStack and passing in the parameters
8683 specified by Context1 and Context2. Context1 and Context2 are optional and
8684 may be 0. The function EntryPoint must never return.
8686 If the current execution mode is not 64-bit paged mode, then ASSERT().
8687 If EntryPoint is 0, then ASSERT().
8688 If NewStack is 0, then ASSERT().
8690 @param Cs The 16-bit selector to load in the CS before EntryPoint
8691 is called. The descriptor in the GDT that this selector
8692 references must be setup for 32-bit protected mode.
8693 @param EntryPoint The 64-bit virtual address of the function to call with
8694 the new stack after paging is disabled.
8695 @param Context1 The 64-bit virtual address of the context to pass into
8696 the EntryPoint function as the first parameter after
8698 @param Context2 The 64-bit virtual address of the context to pass into
8699 the EntryPoint function as the second parameter after
8701 @param NewStack The 64-bit virtual address of the new stack to use for
8702 the EntryPoint function after paging is disabled.
8707 AsmDisablePaging64 (
8709 IN UINT32 EntryPoint
,
8710 IN UINT32 Context1
, OPTIONAL
8711 IN UINT32 Context2
, OPTIONAL
8717 // 16-bit thunking services
8721 Retrieves the properties for 16-bit thunk functions.
8723 Computes the size of the buffer and stack below 1MB required to use the
8724 AsmPrepareThunk16(), AsmThunk16() and AsmPrepareAndThunk16() functions. This
8725 buffer size is returned in RealModeBufferSize, and the stack size is returned
8726 in ExtraStackSize. If parameters are passed to the 16-bit real mode code,
8727 then the actual minimum stack size is ExtraStackSize plus the maximum number
8728 of bytes that need to be passed to the 16-bit real mode code.
8730 If RealModeBufferSize is NULL, then ASSERT().
8731 If ExtraStackSize is NULL, then ASSERT().
8733 @param RealModeBufferSize A pointer to the size of the buffer below 1MB
8734 required to use the 16-bit thunk functions.
8735 @param ExtraStackSize A pointer to the extra size of stack below 1MB
8736 that the 16-bit thunk functions require for
8737 temporary storage in the transition to and from
8743 AsmGetThunk16Properties (
8744 OUT UINT32
*RealModeBufferSize
,
8745 OUT UINT32
*ExtraStackSize
8750 Prepares all structures a code required to use AsmThunk16().
8752 Prepares all structures and code required to use AsmThunk16().
8754 This interface is limited to be used in either physical mode or virtual modes with paging enabled where the
8755 virtual to physical mappings for ThunkContext.RealModeBuffer is mapped 1:1.
8757 If ThunkContext is NULL, then ASSERT().
8759 @param ThunkContext A pointer to the context structure that describes the
8760 16-bit real mode code to call.
8766 IN OUT THUNK_CONTEXT
*ThunkContext
8771 Transfers control to a 16-bit real mode entry point and returns the results.
8773 Transfers control to a 16-bit real mode entry point and returns the results.
8774 AsmPrepareThunk16() must be called with ThunkContext before this function is used.
8775 This function must be called with interrupts disabled.
8777 The register state from the RealModeState field of ThunkContext is restored just prior
8778 to calling the 16-bit real mode entry point. This includes the EFLAGS field of RealModeState,
8779 which is used to set the interrupt state when a 16-bit real mode entry point is called.
8780 Control is transferred to the 16-bit real mode entry point specified by the CS and Eip fields of RealModeState.
8781 The stack is initialized to the SS and ESP fields of RealModeState. Any parameters passed to
8782 the 16-bit real mode code must be populated by the caller at SS:ESP prior to calling this function.
8783 The 16-bit real mode entry point is invoked with a 16-bit CALL FAR instruction,
8784 so when accessing stack contents, the 16-bit real mode code must account for the 16-bit segment
8785 and 16-bit offset of the return address that were pushed onto the stack. The 16-bit real mode entry
8786 point must exit with a RETF instruction. The register state is captured into RealModeState immediately
8787 after the RETF instruction is executed.
8789 If EFLAGS specifies interrupts enabled, or any of the 16-bit real mode code enables interrupts,
8790 or any of the 16-bit real mode code makes a SW interrupt, then the caller is responsible for making sure
8791 the IDT at address 0 is initialized to handle any HW or SW interrupts that may occur while in 16-bit real mode.
8793 If EFLAGS specifies interrupts enabled, or any of the 16-bit real mode code enables interrupts,
8794 then the caller is responsible for making sure the 8259 PIC is in a state compatible with 16-bit real mode.
8795 This includes the base vectors, the interrupt masks, and the edge/level trigger mode.
8797 If THUNK_ATTRIBUTE_BIG_REAL_MODE is set in the ThunkAttributes field of ThunkContext, then the user code
8798 is invoked in big real mode. Otherwise, the user code is invoked in 16-bit real mode with 64KB segment limits.
8800 If neither THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 nor THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL are set in
8801 ThunkAttributes, then it is assumed that the user code did not enable the A20 mask, and no attempt is made to
8802 disable the A20 mask.
8804 If THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 is set and THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL is clear in
8805 ThunkAttributes, then attempt to use the INT 15 service to disable the A20 mask. If this INT 15 call fails,
8806 then attempt to disable the A20 mask by directly accessing the 8042 keyboard controller I/O ports.
8808 If THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 is clear and THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL is set in
8809 ThunkAttributes, then attempt to disable the A20 mask by directly accessing the 8042 keyboard controller I/O ports.
8811 If ThunkContext is NULL, then ASSERT().
8812 If AsmPrepareThunk16() was not previously called with ThunkContext, then ASSERT().
8813 If both THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 and THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL are set in
8814 ThunkAttributes, then ASSERT().
8816 This interface is limited to be used in either physical mode or virtual modes with paging enabled where the
8817 virtual to physical mappings for ThunkContext.RealModeBuffer are mapped 1:1.
8819 @param ThunkContext A pointer to the context structure that describes the
8820 16-bit real mode code to call.
8826 IN OUT THUNK_CONTEXT
*ThunkContext
8831 Prepares all structures and code for a 16-bit real mode thunk, transfers
8832 control to a 16-bit real mode entry point, and returns the results.
8834 Prepares all structures and code for a 16-bit real mode thunk, transfers
8835 control to a 16-bit real mode entry point, and returns the results. If the
8836 caller only need to perform a single 16-bit real mode thunk, then this
8837 service should be used. If the caller intends to make more than one 16-bit
8838 real mode thunk, then it is more efficient if AsmPrepareThunk16() is called
8839 once and AsmThunk16() can be called for each 16-bit real mode thunk.
8841 This interface is limited to be used in either physical mode or virtual modes with paging enabled where the
8842 virtual to physical mappings for ThunkContext.RealModeBuffer is mapped 1:1.
8844 See AsmPrepareThunk16() and AsmThunk16() for the detailed description and ASSERT() conditions.
8846 @param ThunkContext A pointer to the context structure that describes the
8847 16-bit real mode code to call.
8852 AsmPrepareAndThunk16 (
8853 IN OUT THUNK_CONTEXT
*ThunkContext
8857 Generates a 16-bit random number through RDRAND instruction.
8859 if Rand is NULL, then ASSERT().
8861 @param[out] Rand Buffer pointer to store the random result.
8863 @retval TRUE RDRAND call was successful.
8864 @retval FALSE Failed attempts to call RDRAND.
8874 Generates a 32-bit random number through RDRAND instruction.
8876 if Rand is NULL, then ASSERT().
8878 @param[out] Rand Buffer pointer to store the random result.
8880 @retval TRUE RDRAND call was successful.
8881 @retval FALSE Failed attempts to call RDRAND.
8891 Generates a 64-bit random number through RDRAND instruction.
8893 if Rand is NULL, then ASSERT().
8895 @param[out] Rand Buffer pointer to store the random result.
8897 @retval TRUE RDRAND call was successful.
8898 @retval FALSE Failed attempts to call RDRAND.