2 Provides string functions, linked list functions, math functions, synchronization
3 functions, and CPU architecture specific functions.
5 Copyright (c) 2006 - 2008, Intel Corporation<BR>
6 All rights reserved. This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
20 /// Definitions for SPIN_LOCK
22 typedef volatile UINTN SPIN_LOCK
;
25 // Definitions for architecture specific types
27 #if defined (MDE_CPU_IA32)
29 /// IA32 context buffer used by SetJump() and LongJump()
38 } BASE_LIBRARY_JUMP_BUFFER
;
40 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 4
42 #endif // defined (MDE_CPU_IA32)
44 #if defined (MDE_CPU_IPF)
47 /// IPF context buffer used by SetJump() and LongJump()
82 UINT64 AfterSpillUNAT
;
88 } BASE_LIBRARY_JUMP_BUFFER
;
90 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 0x10
92 #endif // defined (MDE_CPU_IPF)
94 #if defined (MDE_CPU_X64)
96 /// x64 context buffer used by SetJump() and LongJump()
109 } BASE_LIBRARY_JUMP_BUFFER
;
111 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 8
113 #endif // defined (MDE_CPU_X64)
115 #if defined (MDE_CPU_EBC)
117 /// EBC context buffer used by SetJump() and LongJump()
125 } BASE_LIBRARY_JUMP_BUFFER
;
127 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 8
129 #endif // defined (MDE_CPU_EBC)
136 Copies one Null-terminated Unicode string to another Null-terminated Unicode
137 string and returns the new Unicode string.
139 This function copies the contents of the Unicode string Source to the Unicode
140 string Destination, and returns Destination. If Source and Destination
141 overlap, then the results are undefined.
143 If Destination is NULL, then ASSERT().
144 If Destination is not aligned on a 16-bit boundary, then ASSERT().
145 If Source is NULL, then ASSERT().
146 If Source is not aligned on a 16-bit boundary, then ASSERT().
147 If Source and Destination overlap, then ASSERT().
148 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
149 PcdMaximumUnicodeStringLength Unicode characters not including the
150 Null-terminator, then ASSERT().
152 @param Destination Pointer to a Null-terminated Unicode string.
153 @param Source Pointer to a Null-terminated Unicode string.
161 OUT CHAR16
*Destination
,
162 IN CONST CHAR16
*Source
167 Copies up to a specified length from one Null-terminated Unicode string to
168 another Null-terminated Unicode string and returns the new Unicode string.
170 This function copies the contents of the Unicode string Source to the Unicode
171 string Destination, and returns Destination. At most, Length Unicode
172 characters are copied from Source to Destination. If Length is 0, then
173 Destination is returned unmodified. If Length is greater that the number of
174 Unicode characters in Source, then Destination is padded with Null Unicode
175 characters. If Source and Destination overlap, then the results are
178 If Length > 0 and Destination is NULL, then ASSERT().
179 If Length > 0 and Destination is not aligned on a 16-bit boundary, then ASSERT().
180 If Length > 0 and Source is NULL, then ASSERT().
181 If Length > 0 and Source is not aligned on a 16-bit bounadry, then ASSERT().
182 If Source and Destination overlap, then ASSERT().
183 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
184 PcdMaximumUnicodeStringLength Unicode characters not including the
185 Null-terminator, then ASSERT().
187 @param Destination Pointer to a Null-terminated Unicode string.
188 @param Source Pointer to a Null-terminated Unicode string.
189 @param Length Maximum number of Unicode characters to copy.
197 OUT CHAR16
*Destination
,
198 IN CONST CHAR16
*Source
,
204 Returns the length of a Null-terminated Unicode string.
206 This function returns the number of Unicode characters in the Null-terminated
207 Unicode string specified by String.
209 If String is NULL, then ASSERT().
210 If String is not aligned on a 16-bit boundary, then ASSERT().
211 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
212 PcdMaximumUnicodeStringLength Unicode characters not including the
213 Null-terminator, then ASSERT().
215 @param String Pointer to a Null-terminated Unicode string.
217 @return The length of String.
223 IN CONST CHAR16
*String
228 Returns the size of a Null-terminated Unicode string in bytes, including the
231 This function returns the size, in bytes, of the Null-terminated Unicode string
234 If String is NULL, then ASSERT().
235 If String is not aligned on a 16-bit boundary, then ASSERT().
236 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
237 PcdMaximumUnicodeStringLength Unicode characters not including the
238 Null-terminator, then ASSERT().
240 @param String Pointer to a Null-terminated Unicode string.
242 @return The size of String.
248 IN CONST CHAR16
*String
253 Compares two Null-terminated Unicode strings, and returns the difference
254 between the first mismatched Unicode characters.
256 This function compares the Null-terminated Unicode string FirstString to the
257 Null-terminated Unicode string SecondString. If FirstString is identical to
258 SecondString, then 0 is returned. Otherwise, the value returned is the first
259 mismatched Unicode character in SecondString subtracted from the first
260 mismatched Unicode character in FirstString.
262 If FirstString is NULL, then ASSERT().
263 If FirstString is not aligned on a 16-bit boundary, then ASSERT().
264 If SecondString is NULL, then ASSERT().
265 If SecondString is not aligned on a 16-bit boundary, then ASSERT().
266 If PcdMaximumUnicodeStringLength is not zero, and FirstString contains more
267 than PcdMaximumUnicodeStringLength Unicode characters not including the
268 Null-terminator, then ASSERT().
269 If PcdMaximumUnicodeStringLength is not zero, and SecondString contains more
270 than PcdMaximumUnicodeStringLength Unicode characters not including the
271 Null-terminator, then ASSERT().
273 @param FirstString Pointer to a Null-terminated Unicode string.
274 @param SecondString Pointer to a Null-terminated Unicode string.
276 @retval 0 FirstString is identical to SecondString.
277 @return others FirstString is not identical to SecondString.
283 IN CONST CHAR16
*FirstString
,
284 IN CONST CHAR16
*SecondString
289 Compares up to a specified length the contents of two Null-terminated Unicode strings,
290 and returns the difference between the first mismatched Unicode characters.
292 This function compares the Null-terminated Unicode string FirstString to the
293 Null-terminated Unicode string SecondString. At most, Length Unicode
294 characters will be compared. If Length is 0, then 0 is returned. If
295 FirstString is identical to SecondString, then 0 is returned. Otherwise, the
296 value returned is the first mismatched Unicode character in SecondString
297 subtracted from the first mismatched Unicode character in FirstString.
299 If Length > 0 and FirstString is NULL, then ASSERT().
300 If Length > 0 and FirstString is not aligned on a 16-bit bounadary, then ASSERT().
301 If Length > 0 and SecondString is NULL, then ASSERT().
302 If Length > 0 and SecondString is not aligned on a 16-bit bounadary, then ASSERT().
303 If PcdMaximumUnicodeStringLength is not zero, and FirstString contains more
304 than PcdMaximumUnicodeStringLength Unicode characters not including the
305 Null-terminator, then ASSERT().
306 If PcdMaximumUnicodeStringLength is not zero, and SecondString contains more
307 than PcdMaximumUnicodeStringLength Unicode characters not including the
308 Null-terminator, then ASSERT().
310 @param FirstString Pointer to a Null-terminated Unicode string.
311 @param SecondString Pointer to a Null-terminated Unicode string.
312 @param Length Maximum number of Unicode characters to compare.
314 @retval 0 FirstString is identical to SecondString.
315 @return others FirstString is not identical to SecondString.
321 IN CONST CHAR16
*FirstString
,
322 IN CONST CHAR16
*SecondString
,
328 Concatenates one Null-terminated Unicode string to another Null-terminated
329 Unicode string, and returns the concatenated Unicode string.
331 This function concatenates two Null-terminated Unicode strings. The contents
332 of Null-terminated Unicode string Source are concatenated to the end of
333 Null-terminated Unicode string Destination. The Null-terminated concatenated
334 Unicode String is returned. If Source and Destination overlap, then the
335 results are undefined.
337 If Destination is NULL, then ASSERT().
338 If Destination is not aligned on a 16-bit bounadary, then ASSERT().
339 If Source is NULL, then ASSERT().
340 If Source is not aligned on a 16-bit bounadary, then ASSERT().
341 If Source and Destination overlap, then ASSERT().
342 If PcdMaximumUnicodeStringLength is not zero, and Destination contains more
343 than PcdMaximumUnicodeStringLength Unicode characters not including the
344 Null-terminator, then ASSERT().
345 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
346 PcdMaximumUnicodeStringLength Unicode characters not including the
347 Null-terminator, then ASSERT().
348 If PcdMaximumUnicodeStringLength is not zero, and concatenating Destination
349 and Source results in a Unicode string with more than
350 PcdMaximumUnicodeStringLength Unicode characters not including the
351 Null-terminator, then ASSERT().
353 @param Destination Pointer to a Null-terminated Unicode string.
354 @param Source Pointer to a Null-terminated Unicode string.
362 IN OUT CHAR16
*Destination
,
363 IN CONST CHAR16
*Source
368 Concatenates up to a specified length one Null-terminated Unicode to the end
369 of another Null-terminated Unicode string, and returns the concatenated
372 This function concatenates two Null-terminated Unicode strings. The contents
373 of Null-terminated Unicode string Source are concatenated to the end of
374 Null-terminated Unicode string Destination, and Destination is returned. At
375 most, Length Unicode characters are concatenated from Source to the end of
376 Destination, and Destination is always Null-terminated. If Length is 0, then
377 Destination is returned unmodified. If Source and Destination overlap, then
378 the results are undefined.
380 If Destination is NULL, then ASSERT().
381 If Length > 0 and Destination is not aligned on a 16-bit boundary, then ASSERT().
382 If Length > 0 and Source is NULL, then ASSERT().
383 If Length > 0 and Source is not aligned on a 16-bit boundary, then ASSERT().
384 If Source and Destination overlap, then ASSERT().
385 If PcdMaximumUnicodeStringLength is not zero, and Destination contains more
386 than PcdMaximumUnicodeStringLength Unicode characters not including the
387 Null-terminator, then ASSERT().
388 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
389 PcdMaximumUnicodeStringLength Unicode characters not including the
390 Null-terminator, then ASSERT().
391 If PcdMaximumUnicodeStringLength is not zero, and concatenating Destination
392 and Source results in a Unicode string with more than
393 PcdMaximumUnicodeStringLength Unicode characters not including the
394 Null-terminator, then ASSERT().
396 @param Destination Pointer to a Null-terminated Unicode string.
397 @param Source Pointer to a Null-terminated Unicode string.
398 @param Length Maximum number of Unicode characters to concatenate from
407 IN OUT CHAR16
*Destination
,
408 IN CONST CHAR16
*Source
,
413 Returns the first occurrence of a Null-terminated Unicode sub-string
414 in a Null-terminated Unicode string.
416 This function scans the contents of the Null-terminated Unicode string
417 specified by String and returns the first occurrence of SearchString.
418 If SearchString is not found in String, then NULL is returned. If
419 the length of SearchString is zero, then String is
422 If String is NULL, then ASSERT().
423 If String is not aligned on a 16-bit boundary, then ASSERT().
424 If SearchString is NULL, then ASSERT().
425 If SearchString is not aligned on a 16-bit boundary, then ASSERT().
427 If PcdMaximumUnicodeStringLength is not zero, and SearchString
428 or String contains more than PcdMaximumUnicodeStringLength Unicode
429 characters not including the Null-terminator, then ASSERT().
431 @param String Pointer to a Null-terminated Unicode string.
432 @param SearchString Pointer to a Null-terminated Unicode string to search for.
434 @retval NULL If the SearchString does not appear in String.
435 @return others If there is a match.
441 IN CONST CHAR16
*String
,
442 IN CONST CHAR16
*SearchString
446 Convert a Null-terminated Unicode decimal string to a value of
449 This function returns a value of type UINTN by interpreting the contents
450 of the Unicode string specified by String as a decimal number. The format
451 of the input Unicode string String is:
453 [spaces] [decimal digits].
455 The valid decimal digit character is in the range [0-9]. The
456 function will ignore the pad space, which includes spaces or
457 tab characters, before [decimal digits]. The running zero in the
458 beginning of [decimal digits] will be ignored. Then, the function
459 stops at the first character that is a not a valid decimal character
460 or a Null-terminator, whichever one comes first.
462 If String is NULL, then ASSERT().
463 If String is not aligned in a 16-bit boundary, then ASSERT().
464 If String has only pad spaces, then 0 is returned.
465 If String has no pad spaces or valid decimal digits,
467 If the number represented by String overflows according
468 to the range defined by UINTN, then ASSERT().
470 If PcdMaximumUnicodeStringLength is not zero, and String contains
471 more than PcdMaximumUnicodeStringLength Unicode characters not including
472 the Null-terminator, then ASSERT().
474 @param String Pointer to a Null-terminated Unicode string.
476 @retval Value translated from String.
482 IN CONST CHAR16
*String
486 Convert a Null-terminated Unicode decimal string to a value of
489 This function returns a value of type UINT64 by interpreting the contents
490 of the Unicode string specified by String as a decimal number. The format
491 of the input Unicode string String is:
493 [spaces] [decimal digits].
495 The valid decimal digit character is in the range [0-9]. The
496 function will ignore the pad space, which includes spaces or
497 tab characters, before [decimal digits]. The running zero in the
498 beginning of [decimal digits] will be ignored. Then, the function
499 stops at the first character that is a not a valid decimal character
500 or a Null-terminator, whichever one comes first.
502 If String is NULL, then ASSERT().
503 If String is not aligned in a 16-bit boundary, then ASSERT().
504 If String has only pad spaces, then 0 is returned.
505 If String has no pad spaces or valid decimal digits,
507 If the number represented by String overflows according
508 to the range defined by UINT64, then ASSERT().
510 If PcdMaximumUnicodeStringLength is not zero, and String contains
511 more than PcdMaximumUnicodeStringLength Unicode characters not including
512 the Null-terminator, then ASSERT().
514 @param String Pointer to a Null-terminated Unicode string.
516 @retval Value translated from String.
522 IN CONST CHAR16
*String
527 Convert a Null-terminated Unicode hexadecimal string to a value of type UINTN.
529 This function returns a value of type UINTN by interpreting the contents
530 of the Unicode string specified by String as a hexadecimal number.
531 The format of the input Unicode string String is:
533 [spaces][zeros][x][hexadecimal digits].
535 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
536 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix.
537 If "x" appears in the input string, it must be prefixed with at least one 0.
538 The function will ignore the pad space, which includes spaces or tab characters,
539 before [zeros], [x] or [hexadecimal digit]. The running zero before [x] or
540 [hexadecimal digit] will be ignored. Then, the decoding starts after [x] or the
541 first valid hexadecimal digit. Then, the function stops at the first character that is
542 a not a valid hexadecimal character or NULL, whichever one comes first.
544 If String is NULL, then ASSERT().
545 If String is not aligned in a 16-bit boundary, then ASSERT().
546 If String has only pad spaces, then zero is returned.
547 If String has no leading pad spaces, leading zeros or valid hexadecimal digits,
548 then zero is returned.
549 If the number represented by String overflows according to the range defined by
550 UINTN, then ASSERT().
552 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
553 PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator,
556 @param String Pointer to a Null-terminated Unicode string.
558 @retval Value translated from String.
564 IN CONST CHAR16
*String
569 Convert a Null-terminated Unicode hexadecimal string to a value of type UINT64.
571 This function returns a value of type UINT64 by interpreting the contents
572 of the Unicode string specified by String as a hexadecimal number.
573 The format of the input Unicode string String is
575 [spaces][zeros][x][hexadecimal digits].
577 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
578 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix.
579 If "x" appears in the input string, it must be prefixed with at least one 0.
580 The function will ignore the pad space, which includes spaces or tab characters,
581 before [zeros], [x] or [hexadecimal digit]. The running zero before [x] or
582 [hexadecimal digit] will be ignored. Then, the decoding starts after [x] or the
583 first valid hexadecimal digit. Then, the function stops at the first character that is
584 a not a valid hexadecimal character or NULL, whichever one comes first.
586 If String is NULL, then ASSERT().
587 If String is not aligned in a 16-bit boundary, then ASSERT().
588 If String has only pad spaces, then zero is returned.
589 If String has no leading pad spaces, leading zeros or valid hexadecimal digits,
590 then zero is returned.
591 If the number represented by String overflows according to the range defined by
592 UINT64, then ASSERT().
594 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
595 PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator,
598 @param String Pointer to a Null-terminated Unicode string.
600 @retval Value translated from String.
606 IN CONST CHAR16
*String
610 Convert a Null-terminated Unicode string to a Null-terminated
611 ASCII string and returns the ASCII string.
613 This function converts the content of the Unicode string Source
614 to the ASCII string Destination by copying the lower 8 bits of
615 each Unicode character. It returns Destination.
617 If any Unicode characters in Source contain non-zero value in
618 the upper 8 bits, then ASSERT().
620 If Destination is NULL, then ASSERT().
621 If Source is NULL, then ASSERT().
622 If Source is not aligned on a 16-bit boundary, then ASSERT().
623 If Source and Destination overlap, then ASSERT().
625 If PcdMaximumUnicodeStringLength is not zero, and Source contains
626 more than PcdMaximumUnicodeStringLength Unicode characters not including
627 the Null-terminator, then ASSERT().
629 If PcdMaximumAsciiStringLength is not zero, and Source contains more
630 than PcdMaximumAsciiStringLength Unicode characters not including the
631 Null-terminator, then ASSERT().
633 @param Source Pointer to a Null-terminated Unicode string.
634 @param Destination Pointer to a Null-terminated ASCII string.
641 UnicodeStrToAsciiStr (
642 IN CONST CHAR16
*Source
,
643 OUT CHAR8
*Destination
648 Copies one Null-terminated ASCII string to another Null-terminated ASCII
649 string and returns the new ASCII string.
651 This function copies the contents of the ASCII string Source to the ASCII
652 string Destination, and returns Destination. If Source and Destination
653 overlap, then the results are undefined.
655 If Destination is NULL, then ASSERT().
656 If Source is NULL, then ASSERT().
657 If Source and Destination overlap, then ASSERT().
658 If PcdMaximumAsciiStringLength is not zero and Source contains more than
659 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
662 @param Destination Pointer to a Null-terminated ASCII string.
663 @param Source Pointer to a Null-terminated ASCII string.
671 OUT CHAR8
*Destination
,
672 IN CONST CHAR8
*Source
677 Copies up to a specified length one Null-terminated ASCII string to another
678 Null-terminated ASCII string and returns the new ASCII string.
680 This function copies the contents of the ASCII string Source to the ASCII
681 string Destination, and returns Destination. At most, Length ASCII characters
682 are copied from Source to Destination. If Length is 0, then Destination is
683 returned unmodified. If Length is greater that the number of ASCII characters
684 in Source, then Destination is padded with Null ASCII characters. If Source
685 and Destination overlap, then the results are undefined.
687 If Destination is NULL, then ASSERT().
688 If Source is NULL, then ASSERT().
689 If Source and Destination overlap, then ASSERT().
690 If PcdMaximumAsciiStringLength is not zero, and Source contains more than
691 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
694 @param Destination Pointer to a Null-terminated ASCII string.
695 @param Source Pointer to a Null-terminated ASCII string.
696 @param Length Maximum number of ASCII characters to copy.
704 OUT CHAR8
*Destination
,
705 IN CONST CHAR8
*Source
,
711 Returns the length of a Null-terminated ASCII string.
713 This function returns the number of ASCII characters in the Null-terminated
714 ASCII string specified by String.
716 If Length > 0 and Destination is NULL, then ASSERT().
717 If Length > 0 and Source is NULL, then ASSERT().
718 If PcdMaximumAsciiStringLength is not zero and String contains more than
719 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
722 @param String Pointer to a Null-terminated ASCII string.
724 @return The length of String.
730 IN CONST CHAR8
*String
735 Returns the size of a Null-terminated ASCII string in bytes, including the
738 This function returns the size, in bytes, of the Null-terminated ASCII string
741 If String is NULL, then ASSERT().
742 If PcdMaximumAsciiStringLength is not zero and String contains more than
743 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
746 @param String Pointer to a Null-terminated ASCII string.
748 @return The size of String.
754 IN CONST CHAR8
*String
759 Compares two Null-terminated ASCII strings, and returns the difference
760 between the first mismatched ASCII characters.
762 This function compares the Null-terminated ASCII string FirstString to the
763 Null-terminated ASCII string SecondString. If FirstString is identical to
764 SecondString, then 0 is returned. Otherwise, the value returned is the first
765 mismatched ASCII character in SecondString subtracted from the first
766 mismatched ASCII character in FirstString.
768 If FirstString is NULL, then ASSERT().
769 If SecondString is NULL, then ASSERT().
770 If PcdMaximumAsciiStringLength is not zero and FirstString contains more than
771 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
773 If PcdMaximumAsciiStringLength is not zero and SecondString contains more
774 than PcdMaximumAsciiStringLength ASCII characters not including the
775 Null-terminator, then ASSERT().
777 @param FirstString Pointer to a Null-terminated ASCII string.
778 @param SecondString Pointer to a Null-terminated ASCII string.
780 @retval ==0 FirstString is identical to SecondString.
781 @retval !=0 FirstString is not identical to SecondString.
787 IN CONST CHAR8
*FirstString
,
788 IN CONST CHAR8
*SecondString
793 Performs a case insensitive comparison of two Null-terminated ASCII strings,
794 and returns the difference between the first mismatched ASCII characters.
796 This function performs a case insensitive comparison of the Null-terminated
797 ASCII string FirstString to the Null-terminated ASCII string SecondString. If
798 FirstString is identical to SecondString, then 0 is returned. Otherwise, the
799 value returned is the first mismatched lower case ASCII character in
800 SecondString subtracted from the first mismatched lower case ASCII character
803 If FirstString is NULL, then ASSERT().
804 If SecondString is NULL, then ASSERT().
805 If PcdMaximumAsciiStringLength is not zero and FirstString contains more than
806 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
808 If PcdMaximumAsciiStringLength is not zero and SecondString contains more
809 than PcdMaximumAsciiStringLength ASCII characters not including the
810 Null-terminator, then ASSERT().
812 @param FirstString Pointer to a Null-terminated ASCII string.
813 @param SecondString Pointer to a Null-terminated ASCII string.
815 @retval ==0 FirstString is identical to SecondString using case insensitive
817 @retval !=0 FirstString is not identical to SecondString using case
818 insensitive comparisons.
824 IN CONST CHAR8
*FirstString
,
825 IN CONST CHAR8
*SecondString
830 Compares two Null-terminated ASCII strings with maximum lengths, and returns
831 the difference between the first mismatched ASCII characters.
833 This function compares the Null-terminated ASCII string FirstString to the
834 Null-terminated ASCII string SecondString. At most, Length ASCII characters
835 will be compared. If Length is 0, then 0 is returned. If FirstString is
836 identical to SecondString, then 0 is returned. Otherwise, the value returned
837 is the first mismatched ASCII character in SecondString subtracted from the
838 first mismatched ASCII character in FirstString.
840 If Length > 0 and FirstString is NULL, then ASSERT().
841 If Length > 0 and SecondString is NULL, then ASSERT().
842 If PcdMaximumAsciiStringLength is not zero and FirstString contains more than
843 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
845 If PcdMaximumAsciiStringLength is not zero and SecondString contains more than
846 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
849 @param FirstString Pointer to a Null-terminated ASCII string.
850 @param SecondString Pointer to a Null-terminated ASCII string.
851 @param Length Maximum number of ASCII characters for compare.
853 @retval ==0 FirstString is identical to SecondString.
854 @retval !=0 FirstString is not identical to SecondString.
860 IN CONST CHAR8
*FirstString
,
861 IN CONST CHAR8
*SecondString
,
867 Concatenates one Null-terminated ASCII string to another Null-terminated
868 ASCII string, and returns the concatenated ASCII string.
870 This function concatenates two Null-terminated ASCII strings. The contents of
871 Null-terminated ASCII string Source are concatenated to the end of Null-
872 terminated ASCII string Destination. The Null-terminated concatenated ASCII
875 If Destination is NULL, then ASSERT().
876 If Source is NULL, then ASSERT().
877 If PcdMaximumAsciiStringLength is not zero and Destination contains more than
878 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
880 If PcdMaximumAsciiStringLength is not zero and Source contains more than
881 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
883 If PcdMaximumAsciiStringLength is not zero and concatenating Destination and
884 Source results in a ASCII string with more than PcdMaximumAsciiStringLength
885 ASCII characters, then ASSERT().
887 @param Destination Pointer to a Null-terminated ASCII string.
888 @param Source Pointer to a Null-terminated ASCII string.
896 IN OUT CHAR8
*Destination
,
897 IN CONST CHAR8
*Source
902 Concatenates up to a specified length one Null-terminated ASCII string to
903 the end of another Null-terminated ASCII string, and returns the
904 concatenated ASCII string.
906 This function concatenates two Null-terminated ASCII strings. The contents
907 of Null-terminated ASCII string Source are concatenated to the end of Null-
908 terminated ASCII string Destination, and Destination is returned. At most,
909 Length ASCII characters are concatenated from Source to the end of
910 Destination, and Destination is always Null-terminated. If Length is 0, then
911 Destination is returned unmodified. If Source and Destination overlap, then
912 the results are undefined.
914 If Length > 0 and Destination is NULL, then ASSERT().
915 If Length > 0 and Source is NULL, then ASSERT().
916 If Source and Destination overlap, then ASSERT().
917 If PcdMaximumAsciiStringLength is not zero, and Destination contains more than
918 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
920 If PcdMaximumAsciiStringLength is not zero, and Source contains more than
921 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
923 If PcdMaximumAsciiStringLength is not zero, and concatenating Destination and
924 Source results in a ASCII string with more than PcdMaximumAsciiStringLength
925 ASCII characters not including the Null-terminator, then ASSERT().
927 @param Destination Pointer to a Null-terminated ASCII string.
928 @param Source Pointer to a Null-terminated ASCII string.
929 @param Length Maximum number of ASCII characters to concatenate from
938 IN OUT CHAR8
*Destination
,
939 IN CONST CHAR8
*Source
,
945 Returns the first occurrence of a Null-terminated ASCII sub-string
946 in a Null-terminated ASCII string.
948 This function scans the contents of the ASCII string specified by String
949 and returns the first occurrence of SearchString. If SearchString is not
950 found in String, then NULL is returned. If the length of SearchString is zero,
951 then String is returned.
953 If String is NULL, then ASSERT().
954 If SearchString is NULL, then ASSERT().
956 If PcdMaximumAsciiStringLength is not zero, and SearchString or
957 String contains more than PcdMaximumAsciiStringLength Unicode characters
958 not including the Null-terminator, then ASSERT().
960 @param String Pointer to a Null-terminated ASCII string.
961 @param SearchString Pointer to a Null-terminated ASCII string to search for.
963 @retval NULL If the SearchString does not appear in String.
964 @retval others If there is a match return the first occurrence of SearchingString.
965 If the length of SearchString is zero,return String.
971 IN CONST CHAR8
*String
,
972 IN CONST CHAR8
*SearchString
977 Convert a Null-terminated ASCII decimal string to a value of type
980 This function returns a value of type UINTN by interpreting the contents
981 of the ASCII string String as a decimal number. The format of the input
982 ASCII string String is:
984 [spaces] [decimal digits].
986 The valid decimal digit character is in the range [0-9]. The function will
987 ignore the pad space, which includes spaces or tab characters, before the digits.
988 The running zero in the beginning of [decimal digits] will be ignored. Then, the
989 function stops at the first character that is a not a valid decimal character or
990 Null-terminator, whichever on comes first.
992 If String has only pad spaces, then 0 is returned.
993 If String has no pad spaces or valid decimal digits, then 0 is returned.
994 If the number represented by String overflows according to the range defined by
995 UINTN, then ASSERT().
996 If String is NULL, then ASSERT().
997 If PcdMaximumAsciiStringLength is not zero, and String contains more than
998 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
1001 @param String Pointer to a Null-terminated ASCII string.
1003 @retval Value translated from String.
1008 AsciiStrDecimalToUintn (
1009 IN CONST CHAR8
*String
1014 Convert a Null-terminated ASCII decimal string to a value of type
1017 This function returns a value of type UINT64 by interpreting the contents
1018 of the ASCII string String as a decimal number. The format of the input
1019 ASCII string String is:
1021 [spaces] [decimal digits].
1023 The valid decimal digit character is in the range [0-9]. The function will
1024 ignore the pad space, which includes spaces or tab characters, before the digits.
1025 The running zero in the beginning of [decimal digits] will be ignored. Then, the
1026 function stops at the first character that is a not a valid decimal character or
1027 Null-terminator, whichever on comes first.
1029 If String has only pad spaces, then 0 is returned.
1030 If String has no pad spaces or valid decimal digits, then 0 is returned.
1031 If the number represented by String overflows according to the range defined by
1032 UINT64, then ASSERT().
1033 If String is NULL, then ASSERT().
1034 If PcdMaximumAsciiStringLength is not zero, and String contains more than
1035 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
1038 @param String Pointer to a Null-terminated ASCII string.
1040 @retval Value translated from String.
1045 AsciiStrDecimalToUint64 (
1046 IN CONST CHAR8
*String
1051 Convert a Null-terminated ASCII hexadecimal string to a value of type UINTN.
1053 This function returns a value of type UINTN by interpreting the contents of
1054 the ASCII string String as a hexadecimal number. The format of the input ASCII
1057 [spaces][zeros][x][hexadecimal digits].
1059 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
1060 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix. If "x"
1061 appears in the input string, it must be prefixed with at least one 0. The function
1062 will ignore the pad space, which includes spaces or tab characters, before [zeros],
1063 [x] or [hexadecimal digits]. The running zero before [x] or [hexadecimal digits]
1064 will be ignored. Then, the decoding starts after [x] or the first valid hexadecimal
1065 digit. Then, the function stops at the first character that is a not a valid
1066 hexadecimal character or Null-terminator, whichever on comes first.
1068 If String has only pad spaces, then 0 is returned.
1069 If String has no leading pad spaces, leading zeros or valid hexadecimal digits, then
1072 If the number represented by String overflows according to the range defined by UINTN,
1074 If String is NULL, then ASSERT().
1075 If PcdMaximumAsciiStringLength is not zero,
1076 and String contains more than PcdMaximumAsciiStringLength ASCII characters not including
1077 the Null-terminator, then ASSERT().
1079 @param String Pointer to a Null-terminated ASCII string.
1081 @retval Value translated from String.
1086 AsciiStrHexToUintn (
1087 IN CONST CHAR8
*String
1092 Convert a Null-terminated ASCII hexadecimal string to a value of type UINT64.
1094 This function returns a value of type UINT64 by interpreting the contents of
1095 the ASCII string String as a hexadecimal number. The format of the input ASCII
1098 [spaces][zeros][x][hexadecimal digits].
1100 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
1101 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix. If "x"
1102 appears in the input string, it must be prefixed with at least one 0. The function
1103 will ignore the pad space, which includes spaces or tab characters, before [zeros],
1104 [x] or [hexadecimal digits]. The running zero before [x] or [hexadecimal digits]
1105 will be ignored. Then, the decoding starts after [x] or the first valid hexadecimal
1106 digit. Then, the function stops at the first character that is a not a valid
1107 hexadecimal character or Null-terminator, whichever on comes first.
1109 If String has only pad spaces, then 0 is returned.
1110 If String has no leading pad spaces, leading zeros or valid hexadecimal digits, then
1113 If the number represented by String overflows according to the range defined by UINT64,
1115 If String is NULL, then ASSERT().
1116 If PcdMaximumAsciiStringLength is not zero,
1117 and String contains more than PcdMaximumAsciiStringLength ASCII characters not including
1118 the Null-terminator, then ASSERT().
1120 @param String Pointer to a Null-terminated ASCII string.
1122 @retval Value translated from String.
1127 AsciiStrHexToUint64 (
1128 IN CONST CHAR8
*String
1133 Convert one Null-terminated ASCII string to a Null-terminated
1134 Unicode string and returns the Unicode string.
1136 This function converts the contents of the ASCII string Source to the Unicode
1137 string Destination, and returns Destination. The function terminates the
1138 Unicode string Destination by appending a Null-terminator character at the end.
1139 The caller is responsible to make sure Destination points to a buffer with size
1140 equal or greater than ((AsciiStrLen (Source) + 1) * sizeof (CHAR16)) in bytes.
1142 If Destination is NULL, then ASSERT().
1143 If Destination is not aligned on a 16-bit boundary, then ASSERT().
1144 If Source is NULL, then ASSERT().
1145 If Source and Destination overlap, then ASSERT().
1146 If PcdMaximumAsciiStringLength is not zero, and Source contains more than
1147 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
1149 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
1150 PcdMaximumUnicodeStringLength ASCII characters not including the
1151 Null-terminator, then ASSERT().
1153 @param Source Pointer to a Null-terminated ASCII string.
1154 @param Destination Pointer to a Null-terminated Unicode string.
1156 @return Destination.
1161 AsciiStrToUnicodeStr (
1162 IN CONST CHAR8
*Source
,
1163 OUT CHAR16
*Destination
1168 Converts an 8-bit value to an 8-bit BCD value.
1170 Converts the 8-bit value specified by Value to BCD. The BCD value is
1173 If Value >= 100, then ASSERT().
1175 @param Value The 8-bit value to convert to BCD. Range 0..99.
1177 @return The BCD value.
1188 Converts an 8-bit BCD value to an 8-bit value.
1190 Converts the 8-bit BCD value specified by Value to an 8-bit value. The 8-bit
1193 If Value >= 0xA0, then ASSERT().
1194 If (Value & 0x0F) >= 0x0A, then ASSERT().
1196 @param Value The 8-bit BCD value to convert to an 8-bit value.
1198 @return The 8-bit value is returned.
1209 // Linked List Functions and Macros
1213 Initializes the head node of a doubly linked list that is declared as a
1214 global variable in a module.
1216 Initializes the forward and backward links of a new linked list. After
1217 initializing a linked list with this macro, the other linked list functions
1218 may be used to add and remove nodes from the linked list. This macro results
1219 in smaller executables by initializing the linked list in the data section,
1220 instead if calling the InitializeListHead() function to perform the
1221 equivalent operation.
1223 @param ListHead The head note of a list to initiailize.
1226 #define INITIALIZE_LIST_HEAD_VARIABLE(ListHead) {&(ListHead), &(ListHead)}
1230 Initializes the head node of a doubly linked list, and returns the pointer to
1231 the head node of the doubly linked list.
1233 Initializes the forward and backward links of a new linked list. After
1234 initializing a linked list with this function, the other linked list
1235 functions may be used to add and remove nodes from the linked list. It is up
1236 to the caller of this function to allocate the memory for ListHead.
1238 If ListHead is NULL, then ASSERT().
1240 @param ListHead A pointer to the head node of a new doubly linked list.
1247 InitializeListHead (
1248 IN OUT LIST_ENTRY
*ListHead
1253 Adds a node to the beginning of a doubly linked list, and returns the pointer
1254 to the head node of the doubly linked list.
1256 Adds the node Entry at the beginning of the doubly linked list denoted by
1257 ListHead, and returns ListHead.
1259 If ListHead is NULL, then ASSERT().
1260 If Entry is NULL, then ASSERT().
1261 If ListHead was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or
1262 InitializeListHead(), then ASSERT().
1263 If PcdMaximumLinkedListLenth is not zero, and prior to insertion the number
1264 of nodes in ListHead, including the ListHead node, is greater than or
1265 equal to PcdMaximumLinkedListLength, then ASSERT().
1267 @param ListHead A pointer to the head node of a doubly linked list.
1268 @param Entry A pointer to a node that is to be inserted at the beginning
1269 of a doubly linked list.
1277 IN OUT LIST_ENTRY
*ListHead
,
1278 IN OUT LIST_ENTRY
*Entry
1283 Adds a node to the end of a doubly linked list, and returns the pointer to
1284 the head node of the doubly linked list.
1286 Adds the node Entry to the end of the doubly linked list denoted by ListHead,
1287 and returns ListHead.
1289 If ListHead is NULL, then ASSERT().
1290 If Entry is NULL, then ASSERT().
1291 If ListHead was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or
1292 InitializeListHead(), then ASSERT().
1293 If PcdMaximumLinkedListLenth is not zero, and prior to insertion the number
1294 of nodes in ListHead, including the ListHead node, is greater than or
1295 equal to PcdMaximumLinkedListLength, then ASSERT().
1297 @param ListHead A pointer to the head node of a doubly linked list.
1298 @param Entry A pointer to a node that is to be added at the end of the
1307 IN OUT LIST_ENTRY
*ListHead
,
1308 IN OUT LIST_ENTRY
*Entry
1313 Retrieves the first node of a doubly linked list.
1315 Returns the first node of a doubly linked list. List must have been
1316 initialized with INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead().
1317 If List is empty, then List is returned.
1319 If List is NULL, then ASSERT().
1320 If List was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or
1321 InitializeListHead(), then ASSERT().
1322 If PcdMaximumLinkedListLenth is not zero, and the number of nodes
1323 in List, including the List node, is greater than or equal to
1324 PcdMaximumLinkedListLength, then ASSERT().
1326 @param List A pointer to the head node of a doubly linked list.
1328 @return The first node of a doubly linked list.
1329 @retval NULL The list is empty.
1335 IN CONST LIST_ENTRY
*List
1340 Retrieves the next node of a doubly linked list.
1342 Returns the node of a doubly linked list that follows Node.
1343 List must have been initialized with INTIALIZE_LIST_HEAD_VARIABLE()
1344 or InitializeListHead(). If List is empty, then List is returned.
1346 If List is NULL, then ASSERT().
1347 If Node is NULL, then ASSERT().
1348 If List was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or
1349 InitializeListHead(), then ASSERT().
1350 If PcdMaximumLinkedListLenth is not zero, and List contains more than
1351 PcdMaximumLinkedListLenth nodes, then ASSERT().
1352 If Node is not a node in List, then ASSERT().
1354 @param List A pointer to the head node of a doubly linked list.
1355 @param Node A pointer to a node in the doubly linked list.
1357 @return Pointer to the next node if one exists. Otherwise a null value which
1358 is actually List is returned.
1364 IN CONST LIST_ENTRY
*List
,
1365 IN CONST LIST_ENTRY
*Node
1370 Checks to see if a doubly linked list is empty or not.
1372 Checks to see if the doubly linked list is empty. If the linked list contains
1373 zero nodes, this function returns TRUE. Otherwise, it returns FALSE.
1375 If ListHead is NULL, then ASSERT().
1376 If ListHead was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or
1377 InitializeListHead(), then ASSERT().
1378 If PcdMaximumLinkedListLenth is not zero, and the number of nodes
1379 in List, including the List node, is greater than or equal to
1380 PcdMaximumLinkedListLength, then ASSERT().
1382 @param ListHead A pointer to the head node of a doubly linked list.
1384 @retval TRUE The linked list is empty.
1385 @retval FALSE The linked list is not empty.
1391 IN CONST LIST_ENTRY
*ListHead
1396 Determines if a node in a doubly linked list is the head node of a the same
1397 doubly linked list. This function is typically used to terminate a loop that
1398 traverses all the nodes in a doubly linked list starting with the head node.
1400 Returns TRUE if Node is equal to List. Returns FALSE if Node is one of the
1401 nodes in the doubly linked list specified by List. List must have been
1402 initialized with INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead().
1404 If List is NULL, then ASSERT().
1405 If Node is NULL, then ASSERT().
1406 If List was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead(),
1408 If PcdMaximumLinkedListLenth is not zero, and the number of nodes
1409 in List, including the List node, is greater than or equal to
1410 PcdMaximumLinkedListLength, then ASSERT().
1411 If Node is not a node in List and Node is not equal to List, then ASSERT().
1413 @param List A pointer to the head node of a doubly linked list.
1414 @param Node A pointer to a node in the doubly linked list.
1416 @retval TRUE Node is one of the nodes in the doubly linked list.
1417 @retval FALSE Node is not one of the nodes in the doubly linked list.
1423 IN CONST LIST_ENTRY
*List
,
1424 IN CONST LIST_ENTRY
*Node
1429 Determines if a node the last node in a doubly linked list.
1431 Returns TRUE if Node is the last node in the doubly linked list specified by
1432 List. Otherwise, FALSE is returned. List must have been initialized with
1433 INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead().
1435 If List is NULL, then ASSERT().
1436 If Node is NULL, then ASSERT().
1437 If List was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or
1438 InitializeListHead(), then ASSERT().
1439 If PcdMaximumLinkedListLenth is not zero, and the number of nodes
1440 in List, including the List node, is greater than or equal to
1441 PcdMaximumLinkedListLength, then ASSERT().
1442 If Node is not a node in List, then ASSERT().
1444 @param List A pointer to the head node of a doubly linked list.
1445 @param Node A pointer to a node in the doubly linked list.
1447 @retval TRUE Node is the last node in the linked list.
1448 @retval FALSE Node is not the last node in the linked list.
1454 IN CONST LIST_ENTRY
*List
,
1455 IN CONST LIST_ENTRY
*Node
1460 Swaps the location of two nodes in a doubly linked list, and returns the
1461 first node after the swap.
1463 If FirstEntry is identical to SecondEntry, then SecondEntry is returned.
1464 Otherwise, the location of the FirstEntry node is swapped with the location
1465 of the SecondEntry node in a doubly linked list. SecondEntry must be in the
1466 same double linked list as FirstEntry and that double linked list must have
1467 been initialized with INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead().
1468 SecondEntry is returned after the nodes are swapped.
1470 If FirstEntry is NULL, then ASSERT().
1471 If SecondEntry is NULL, then ASSERT().
1472 If SecondEntry and FirstEntry are not in the same linked list, then ASSERT().
1473 If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
1474 linked list containing the FirstEntry and SecondEntry nodes, including
1475 the FirstEntry and SecondEntry nodes, is greater than or equal to
1476 PcdMaximumLinkedListLength, then ASSERT().
1478 @param FirstEntry A pointer to a node in a linked list.
1479 @param SecondEntry A pointer to another node in the same linked list.
1481 @return SecondEntry.
1487 IN OUT LIST_ENTRY
*FirstEntry
,
1488 IN OUT LIST_ENTRY
*SecondEntry
1493 Removes a node from a doubly linked list, and returns the node that follows
1496 Removes the node Entry from a doubly linked list. It is up to the caller of
1497 this function to release the memory used by this node if that is required. On
1498 exit, the node following Entry in the doubly linked list is returned. If
1499 Entry is the only node in the linked list, then the head node of the linked
1502 If Entry is NULL, then ASSERT().
1503 If Entry is the head node of an empty list, then ASSERT().
1504 If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
1505 linked list containing Entry, including the Entry node, is greater than
1506 or equal to PcdMaximumLinkedListLength, then ASSERT().
1508 @param Entry A pointer to a node in a linked list.
1516 IN CONST LIST_ENTRY
*Entry
1524 Shifts a 64-bit integer left between 0 and 63 bits. The low bits are filled
1525 with zeros. The shifted value is returned.
1527 This function shifts the 64-bit value Operand to the left by Count bits. The
1528 low Count bits are set to zero. The shifted value is returned.
1530 If Count is greater than 63, then ASSERT().
1532 @param Operand The 64-bit operand to shift left.
1533 @param Count The number of bits to shift left.
1535 @return Operand << Count.
1547 Shifts a 64-bit integer right between 0 and 63 bits. This high bits are
1548 filled with zeros. The shifted value is returned.
1550 This function shifts the 64-bit value Operand to the right by Count bits. The
1551 high Count bits are set to zero. The shifted value is returned.
1553 If Count is greater than 63, then ASSERT().
1555 @param Operand The 64-bit operand to shift right.
1556 @param Count The number of bits to shift right.
1558 @return Operand >> Count
1570 Shifts a 64-bit integer right between 0 and 63 bits. The high bits are filled
1571 with original integer's bit 63. The shifted value is returned.
1573 This function shifts the 64-bit value Operand to the right by Count bits. The
1574 high Count bits are set to bit 63 of Operand. The shifted value is returned.
1576 If Count is greater than 63, then ASSERT().
1578 @param Operand The 64-bit operand to shift right.
1579 @param Count The number of bits to shift right.
1581 @return Operand >> Count
1593 Rotates a 32-bit integer left between 0 and 31 bits, filling the low bits
1594 with the high bits that were rotated.
1596 This function rotates the 32-bit value Operand to the left by Count bits. The
1597 low Count bits are fill with the high Count bits of Operand. The rotated
1600 If Count is greater than 31, then ASSERT().
1602 @param Operand The 32-bit operand to rotate left.
1603 @param Count The number of bits to rotate left.
1605 @return Operand << Count
1617 Rotates a 32-bit integer right between 0 and 31 bits, filling the high bits
1618 with the low bits that were rotated.
1620 This function rotates the 32-bit value Operand to the right by Count bits.
1621 The high Count bits are fill with the low Count bits of Operand. The rotated
1624 If Count is greater than 31, then ASSERT().
1626 @param Operand The 32-bit operand to rotate right.
1627 @param Count The number of bits to rotate right.
1629 @return Operand >> Count
1641 Rotates a 64-bit integer left between 0 and 63 bits, filling the low bits
1642 with the high bits that were rotated.
1644 This function rotates the 64-bit value Operand to the left by Count bits. The
1645 low Count bits are fill with the high Count bits of Operand. The rotated
1648 If Count is greater than 63, then ASSERT().
1650 @param Operand The 64-bit operand to rotate left.
1651 @param Count The number of bits to rotate left.
1653 @return Operand << Count
1665 Rotates a 64-bit integer right between 0 and 63 bits, filling the high bits
1666 with the high low bits that were rotated.
1668 This function rotates the 64-bit value Operand to the right by Count bits.
1669 The high Count bits are fill with the low Count bits of Operand. The rotated
1672 If Count is greater than 63, then ASSERT().
1674 @param Operand The 64-bit operand to rotate right.
1675 @param Count The number of bits to rotate right.
1677 @return Operand >> Count
1689 Returns the bit position of the lowest bit set in a 32-bit value.
1691 This function computes the bit position of the lowest bit set in the 32-bit
1692 value specified by Operand. If Operand is zero, then -1 is returned.
1693 Otherwise, a value between 0 and 31 is returned.
1695 @param Operand The 32-bit operand to evaluate.
1697 @retval 0..31 The lowest bit set in Operand was found.
1698 @retval -1 Operand is zero.
1709 Returns the bit position of the lowest bit set in a 64-bit value.
1711 This function computes the bit position of the lowest bit set in the 64-bit
1712 value specified by Operand. If Operand is zero, then -1 is returned.
1713 Otherwise, a value between 0 and 63 is returned.
1715 @param Operand The 64-bit operand to evaluate.
1717 @retval 0..63 The lowest bit set in Operand was found.
1718 @retval -1 Operand is zero.
1730 Returns the bit position of the highest bit set in a 32-bit value. Equivalent
1733 This function computes the bit position of the highest bit set in the 32-bit
1734 value specified by Operand. If Operand is zero, then -1 is returned.
1735 Otherwise, a value between 0 and 31 is returned.
1737 @param Operand The 32-bit operand to evaluate.
1739 @retval 0..31 Position of the highest bit set in Operand if found.
1740 @retval -1 Operand is zero.
1751 Returns the bit position of the highest bit set in a 64-bit value. Equivalent
1754 This function computes the bit position of the highest bit set in the 64-bit
1755 value specified by Operand. If Operand is zero, then -1 is returned.
1756 Otherwise, a value between 0 and 63 is returned.
1758 @param Operand The 64-bit operand to evaluate.
1760 @retval 0..63 Position of the highest bit set in Operand if found.
1761 @retval -1 Operand is zero.
1772 Returns the value of the highest bit set in a 32-bit value. Equivalent to
1775 This function computes the value of the highest bit set in the 32-bit value
1776 specified by Operand. If Operand is zero, then zero is returned.
1778 @param Operand The 32-bit operand to evaluate.
1780 @return 1 << HighBitSet32(Operand)
1781 @retval 0 Operand is zero.
1792 Returns the value of the highest bit set in a 64-bit value. Equivalent to
1795 This function computes the value of the highest bit set in the 64-bit value
1796 specified by Operand. If Operand is zero, then zero is returned.
1798 @param Operand The 64-bit operand to evaluate.
1800 @return 1 << HighBitSet64(Operand)
1801 @retval 0 Operand is zero.
1812 Switches the endianess of a 16-bit integer.
1814 This function swaps the bytes in a 16-bit unsigned value to switch the value
1815 from little endian to big endian or vice versa. The byte swapped value is
1818 @param Value A 16-bit unsigned value.
1820 @return The byte swapped Value.
1831 Switches the endianess of a 32-bit integer.
1833 This function swaps the bytes in a 32-bit unsigned value to switch the value
1834 from little endian to big endian or vice versa. The byte swapped value is
1837 @param Value A 32-bit unsigned value.
1839 @return The byte swapped Value.
1850 Switches the endianess of a 64-bit integer.
1852 This function swaps the bytes in a 64-bit unsigned value to switch the value
1853 from little endian to big endian or vice versa. The byte swapped value is
1856 @param Value A 64-bit unsigned value.
1858 @return The byte swapped Value.
1869 Multiples a 64-bit unsigned integer by a 32-bit unsigned integer and
1870 generates a 64-bit unsigned result.
1872 This function multiples the 64-bit unsigned value Multiplicand by the 32-bit
1873 unsigned value Multiplier and generates a 64-bit unsigned result. This 64-
1874 bit unsigned result is returned.
1876 @param Multiplicand A 64-bit unsigned value.
1877 @param Multiplier A 32-bit unsigned value.
1879 @return Multiplicand * Multiplier
1885 IN UINT64 Multiplicand
,
1886 IN UINT32 Multiplier
1891 Multiples a 64-bit unsigned integer by a 64-bit unsigned integer and
1892 generates a 64-bit unsigned result.
1894 This function multiples the 64-bit unsigned value Multiplicand by the 64-bit
1895 unsigned value Multiplier and generates a 64-bit unsigned result. This 64-
1896 bit unsigned result is returned.
1898 @param Multiplicand A 64-bit unsigned value.
1899 @param Multiplier A 64-bit unsigned value.
1901 @return Multiplicand * Multiplier
1907 IN UINT64 Multiplicand
,
1908 IN UINT64 Multiplier
1913 Multiples a 64-bit signed integer by a 64-bit signed integer and generates a
1914 64-bit signed result.
1916 This function multiples the 64-bit signed value Multiplicand by the 64-bit
1917 signed value Multiplier and generates a 64-bit signed result. This 64-bit
1918 signed result is returned.
1920 @param Multiplicand A 64-bit signed value.
1921 @param Multiplier A 64-bit signed value.
1923 @return Multiplicand * Multiplier
1929 IN INT64 Multiplicand
,
1935 Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates
1936 a 64-bit unsigned result.
1938 This function divides the 64-bit unsigned value Dividend by the 32-bit
1939 unsigned value Divisor and generates a 64-bit unsigned quotient. This
1940 function returns the 64-bit unsigned quotient.
1942 If Divisor is 0, then ASSERT().
1944 @param Dividend A 64-bit unsigned value.
1945 @param Divisor A 32-bit unsigned value.
1947 @return Dividend / Divisor
1959 Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates
1960 a 32-bit unsigned remainder.
1962 This function divides the 64-bit unsigned value Dividend by the 32-bit
1963 unsigned value Divisor and generates a 32-bit remainder. This function
1964 returns the 32-bit unsigned remainder.
1966 If Divisor is 0, then ASSERT().
1968 @param Dividend A 64-bit unsigned value.
1969 @param Divisor A 32-bit unsigned value.
1971 @return Dividend % Divisor
1983 Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates
1984 a 64-bit unsigned result and an optional 32-bit unsigned remainder.
1986 This function divides the 64-bit unsigned value Dividend by the 32-bit
1987 unsigned value Divisor and generates a 64-bit unsigned quotient. If Remainder
1988 is not NULL, then the 32-bit unsigned remainder is returned in Remainder.
1989 This function returns the 64-bit unsigned quotient.
1991 If Divisor is 0, then ASSERT().
1993 @param Dividend A 64-bit unsigned value.
1994 @param Divisor A 32-bit unsigned value.
1995 @param Remainder A pointer to a 32-bit unsigned value. This parameter is
1996 optional and may be NULL.
1998 @return Dividend / Divisor
2003 DivU64x32Remainder (
2006 OUT UINT32
*Remainder OPTIONAL
2011 Divides a 64-bit unsigned integer by a 64-bit unsigned integer and generates
2012 a 64-bit unsigned result and an optional 64-bit unsigned remainder.
2014 This function divides the 64-bit unsigned value Dividend by the 64-bit
2015 unsigned value Divisor and generates a 64-bit unsigned quotient. If Remainder
2016 is not NULL, then the 64-bit unsigned remainder is returned in Remainder.
2017 This function returns the 64-bit unsigned quotient.
2019 If Divisor is 0, then ASSERT().
2021 @param Dividend A 64-bit unsigned value.
2022 @param Divisor A 64-bit unsigned value.
2023 @param Remainder A pointer to a 64-bit unsigned value. This parameter is
2024 optional and may be NULL.
2026 @return Dividend / Divisor
2031 DivU64x64Remainder (
2034 OUT UINT64
*Remainder OPTIONAL
2039 Divides a 64-bit signed integer by a 64-bit signed integer and generates a
2040 64-bit signed result and a optional 64-bit signed remainder.
2042 This function divides the 64-bit signed value Dividend by the 64-bit signed
2043 value Divisor and generates a 64-bit signed quotient. If Remainder is not
2044 NULL, then the 64-bit signed remainder is returned in Remainder. This
2045 function returns the 64-bit signed quotient.
2047 It is the caller's responsibility to not call this function with a Divisor of 0.
2048 If Divisor is 0, then the quotient and remainder should be assumed to be
2049 the largest negative integer.
2051 If Divisor is 0, then ASSERT().
2053 @param Dividend A 64-bit signed value.
2054 @param Divisor A 64-bit signed value.
2055 @param Remainder A pointer to a 64-bit signed value. This parameter is
2056 optional and may be NULL.
2058 @return Dividend / Divisor
2063 DivS64x64Remainder (
2066 OUT INT64
*Remainder OPTIONAL
2071 Reads a 16-bit value from memory that may be unaligned.
2073 This function returns the 16-bit value pointed to by Buffer. The function
2074 guarantees that the read operation does not produce an alignment fault.
2076 If the Buffer is NULL, then ASSERT().
2078 @param Buffer Pointer to a 16-bit value that may be unaligned.
2080 @return The 16-bit value read from Buffer.
2086 IN CONST UINT16
*Buffer
2091 Writes a 16-bit value to memory that may be unaligned.
2093 This function writes the 16-bit value specified by Value to Buffer. Value is
2094 returned. The function guarantees that the write operation does not produce
2097 If the Buffer is NULL, then ASSERT().
2099 @param Buffer Pointer to a 16-bit value that may be unaligned.
2100 @param Value 16-bit value to write to Buffer.
2102 @return The 16-bit value to write to Buffer.
2114 Reads a 24-bit value from memory that may be unaligned.
2116 This function returns the 24-bit value pointed to by Buffer. The function
2117 guarantees that the read operation does not produce an alignment fault.
2119 If the Buffer is NULL, then ASSERT().
2121 @param Buffer Pointer to a 24-bit value that may be unaligned.
2123 @return The 24-bit value read from Buffer.
2129 IN CONST UINT32
*Buffer
2134 Writes a 24-bit value to memory that may be unaligned.
2136 This function writes the 24-bit value specified by Value to Buffer. Value is
2137 returned. The function guarantees that the write operation does not produce
2140 If the Buffer is NULL, then ASSERT().
2142 @param Buffer Pointer to a 24-bit value that may be unaligned.
2143 @param Value 24-bit value to write to Buffer.
2145 @return The 24-bit value to write to Buffer.
2157 Reads a 32-bit value from memory that may be unaligned.
2159 This function returns the 32-bit value pointed to by Buffer. The function
2160 guarantees that the read operation does not produce an alignment fault.
2162 If the Buffer is NULL, then ASSERT().
2164 @param Buffer Pointer to a 32-bit value that may be unaligned.
2166 @return The 32-bit value read from Buffer.
2172 IN CONST UINT32
*Buffer
2177 Writes a 32-bit value to memory that may be unaligned.
2179 This function writes the 32-bit value specified by Value to Buffer. Value is
2180 returned. The function guarantees that the write operation does not produce
2183 If the Buffer is NULL, then ASSERT().
2185 @param Buffer Pointer to a 32-bit value that may be unaligned.
2186 @param Value 32-bit value to write to Buffer.
2188 @return The 32-bit value to write to Buffer.
2200 Reads a 64-bit value from memory that may be unaligned.
2202 This function returns the 64-bit value pointed to by Buffer. The function
2203 guarantees that the read operation does not produce an alignment fault.
2205 If the Buffer is NULL, then ASSERT().
2207 @param Buffer Pointer to a 64-bit value that may be unaligned.
2209 @return The 64-bit value read from Buffer.
2215 IN CONST UINT64
*Buffer
2220 Writes a 64-bit value to memory that may be unaligned.
2222 This function writes the 64-bit value specified by Value to Buffer. Value is
2223 returned. The function guarantees that the write operation does not produce
2226 If the Buffer is NULL, then ASSERT().
2228 @param Buffer Pointer to a 64-bit value that may be unaligned.
2229 @param Value 64-bit value to write to Buffer.
2231 @return The 64-bit value to write to Buffer.
2243 // Bit Field Functions
2247 Returns a bit field from an 8-bit value.
2249 Returns the bitfield specified by the StartBit and the EndBit from Operand.
2251 If 8-bit operations are not supported, then ASSERT().
2252 If StartBit is greater than 7, then ASSERT().
2253 If EndBit is greater than 7, then ASSERT().
2254 If EndBit is less than StartBit, then ASSERT().
2256 @param Operand Operand on which to perform the bitfield operation.
2257 @param StartBit The ordinal of the least significant bit in the bit field.
2259 @param EndBit The ordinal of the most significant bit in the bit field.
2262 @return The bit field read.
2275 Writes a bit field to an 8-bit value, and returns the result.
2277 Writes Value to the bit field specified by the StartBit and the EndBit in
2278 Operand. All other bits in Operand are preserved. The new 8-bit value is
2281 If 8-bit operations are not supported, then ASSERT().
2282 If StartBit is greater than 7, then ASSERT().
2283 If EndBit is greater than 7, then ASSERT().
2284 If EndBit is less than StartBit, then ASSERT().
2286 @param Operand Operand on which to perform the bitfield operation.
2287 @param StartBit The ordinal of the least significant bit in the bit field.
2289 @param EndBit The ordinal of the most significant bit in the bit field.
2291 @param Value New value of the bit field.
2293 @return The new 8-bit value.
2307 Reads a bit field from an 8-bit value, performs a bitwise OR, and returns the
2310 Performs a bitwise OR between the bit field specified by StartBit
2311 and EndBit in Operand and the value specified by OrData. All other bits in
2312 Operand are preserved. The new 8-bit value is returned.
2314 If 8-bit operations are not supported, then ASSERT().
2315 If StartBit is greater than 7, then ASSERT().
2316 If EndBit is greater than 7, then ASSERT().
2317 If EndBit is less than StartBit, then ASSERT().
2319 @param Operand Operand on which to perform the bitfield operation.
2320 @param StartBit The ordinal of the least significant bit in the bit field.
2322 @param EndBit The ordinal of the most significant bit in the bit field.
2324 @param OrData The value to OR with the read value from the value
2326 @return The new 8-bit value.
2340 Reads a bit field from an 8-bit value, performs a bitwise AND, and returns
2343 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2344 in Operand and the value specified by AndData. All other bits in Operand are
2345 preserved. The new 8-bit value is returned.
2347 If 8-bit operations are not supported, then ASSERT().
2348 If StartBit is greater than 7, then ASSERT().
2349 If EndBit is greater than 7, then ASSERT().
2350 If EndBit is less than StartBit, then ASSERT().
2352 @param Operand Operand on which to perform the bitfield operation.
2353 @param StartBit The ordinal of the least significant bit in the bit field.
2355 @param EndBit The ordinal of the most significant bit in the bit field.
2357 @param AndData The value to AND with the read value from the value.
2359 @return The new 8-bit value.
2373 Reads a bit field from an 8-bit value, performs a bitwise AND followed by a
2374 bitwise OR, and returns the result.
2376 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2377 in Operand and the value specified by AndData, followed by a bitwise
2378 OR with value specified by OrData. All other bits in Operand are
2379 preserved. The new 8-bit value is returned.
2381 If 8-bit operations are not supported, then ASSERT().
2382 If StartBit is greater than 7, then ASSERT().
2383 If EndBit is greater than 7, then ASSERT().
2384 If EndBit is less than StartBit, then ASSERT().
2386 @param Operand Operand on which to perform the bitfield operation.
2387 @param StartBit The ordinal of the least significant bit in the bit field.
2389 @param EndBit The ordinal of the most significant bit in the bit field.
2391 @param AndData The value to AND with the read value from the value.
2392 @param OrData The value to OR with the result of the AND operation.
2394 @return The new 8-bit value.
2399 BitFieldAndThenOr8 (
2409 Returns a bit field from a 16-bit value.
2411 Returns the bitfield specified by the StartBit and the EndBit from Operand.
2413 If 16-bit operations are not supported, then ASSERT().
2414 If StartBit is greater than 15, then ASSERT().
2415 If EndBit is greater than 15, then ASSERT().
2416 If EndBit is less than StartBit, then ASSERT().
2418 @param Operand Operand on which to perform the bitfield operation.
2419 @param StartBit The ordinal of the least significant bit in the bit field.
2421 @param EndBit The ordinal of the most significant bit in the bit field.
2424 @return The bit field read.
2437 Writes a bit field to a 16-bit value, and returns the result.
2439 Writes Value to the bit field specified by the StartBit and the EndBit in
2440 Operand. All other bits in Operand are preserved. The new 16-bit value is
2443 If 16-bit operations are not supported, then ASSERT().
2444 If StartBit is greater than 15, then ASSERT().
2445 If EndBit is greater than 15, then ASSERT().
2446 If EndBit is less than StartBit, then ASSERT().
2448 @param Operand Operand on which to perform the bitfield operation.
2449 @param StartBit The ordinal of the least significant bit in the bit field.
2451 @param EndBit The ordinal of the most significant bit in the bit field.
2453 @param Value New value of the bit field.
2455 @return The new 16-bit value.
2469 Reads a bit field from a 16-bit value, performs a bitwise OR, and returns the
2472 Performs a bitwise OR between the bit field specified by StartBit
2473 and EndBit in Operand and the value specified by OrData. All other bits in
2474 Operand are preserved. The new 16-bit value is returned.
2476 If 16-bit operations are not supported, then ASSERT().
2477 If StartBit is greater than 15, then ASSERT().
2478 If EndBit is greater than 15, then ASSERT().
2479 If EndBit is less than StartBit, then ASSERT().
2481 @param Operand Operand on which to perform the bitfield operation.
2482 @param StartBit The ordinal of the least significant bit in the bit field.
2484 @param EndBit The ordinal of the most significant bit in the bit field.
2486 @param OrData The value to OR with the read value from the value
2488 @return The new 16-bit value.
2502 Reads a bit field from a 16-bit value, performs a bitwise AND, and returns
2505 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2506 in Operand and the value specified by AndData. All other bits in Operand are
2507 preserved. The new 16-bit value is returned.
2509 If 16-bit operations are not supported, then ASSERT().
2510 If StartBit is greater than 15, then ASSERT().
2511 If EndBit is greater than 15, then ASSERT().
2512 If EndBit is less than StartBit, then ASSERT().
2514 @param Operand Operand on which to perform the bitfield operation.
2515 @param StartBit The ordinal of the least significant bit in the bit field.
2517 @param EndBit The ordinal of the most significant bit in the bit field.
2519 @param AndData The value to AND with the read value from the value
2521 @return The new 16-bit value.
2535 Reads a bit field from a 16-bit value, performs a bitwise AND followed by a
2536 bitwise OR, and returns the result.
2538 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2539 in Operand and the value specified by AndData, followed by a bitwise
2540 OR with value specified by OrData. All other bits in Operand are
2541 preserved. The new 16-bit value is returned.
2543 If 16-bit operations are not supported, then ASSERT().
2544 If StartBit is greater than 15, then ASSERT().
2545 If EndBit is greater than 15, then ASSERT().
2546 If EndBit is less than StartBit, then ASSERT().
2548 @param Operand Operand on which to perform the bitfield operation.
2549 @param StartBit The ordinal of the least significant bit in the bit field.
2551 @param EndBit The ordinal of the most significant bit in the bit field.
2553 @param AndData The value to AND with the read value from the value.
2554 @param OrData The value to OR with the result of the AND operation.
2556 @return The new 16-bit value.
2561 BitFieldAndThenOr16 (
2571 Returns a bit field from a 32-bit value.
2573 Returns the bitfield specified by the StartBit and the EndBit from Operand.
2575 If 32-bit operations are not supported, then ASSERT().
2576 If StartBit is greater than 31, then ASSERT().
2577 If EndBit is greater than 31, then ASSERT().
2578 If EndBit is less than StartBit, then ASSERT().
2580 @param Operand Operand on which to perform the bitfield operation.
2581 @param StartBit The ordinal of the least significant bit in the bit field.
2583 @param EndBit The ordinal of the most significant bit in the bit field.
2586 @return The bit field read.
2599 Writes a bit field to a 32-bit value, and returns the result.
2601 Writes Value to the bit field specified by the StartBit and the EndBit in
2602 Operand. All other bits in Operand are preserved. The new 32-bit value is
2605 If 32-bit operations are not supported, then ASSERT().
2606 If StartBit is greater than 31, then ASSERT().
2607 If EndBit is greater than 31, then ASSERT().
2608 If EndBit is less than StartBit, then ASSERT().
2610 @param Operand Operand on which to perform the bitfield operation.
2611 @param StartBit The ordinal of the least significant bit in the bit field.
2613 @param EndBit The ordinal of the most significant bit in the bit field.
2615 @param Value New value of the bit field.
2617 @return The new 32-bit value.
2631 Reads a bit field from a 32-bit value, performs a bitwise OR, and returns the
2634 Performs a bitwise OR between the bit field specified by StartBit
2635 and EndBit in Operand and the value specified by OrData. All other bits in
2636 Operand are preserved. The new 32-bit value is returned.
2638 If 32-bit operations are not supported, then ASSERT().
2639 If StartBit is greater than 31, then ASSERT().
2640 If EndBit is greater than 31, then ASSERT().
2641 If EndBit is less than StartBit, then ASSERT().
2643 @param Operand Operand on which to perform the bitfield operation.
2644 @param StartBit The ordinal of the least significant bit in the bit field.
2646 @param EndBit The ordinal of the most significant bit in the bit field.
2648 @param OrData The value to OR with the read value from the value
2650 @return The new 32-bit value.
2664 Reads a bit field from a 32-bit value, performs a bitwise AND, and returns
2667 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2668 in Operand and the value specified by AndData. All other bits in Operand are
2669 preserved. The new 32-bit value is returned.
2671 If 32-bit operations are not supported, then ASSERT().
2672 If StartBit is greater than 31, then ASSERT().
2673 If EndBit is greater than 31, then ASSERT().
2674 If EndBit is less than StartBit, then ASSERT().
2676 @param Operand Operand on which to perform the bitfield operation.
2677 @param StartBit The ordinal of the least significant bit in the bit field.
2679 @param EndBit The ordinal of the most significant bit in the bit field.
2681 @param AndData The value to AND with the read value from the value
2683 @return The new 32-bit value.
2697 Reads a bit field from a 32-bit value, performs a bitwise AND followed by a
2698 bitwise OR, and returns the result.
2700 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2701 in Operand and the value specified by AndData, followed by a bitwise
2702 OR with value specified by OrData. All other bits in Operand are
2703 preserved. The new 32-bit value is returned.
2705 If 32-bit operations are not supported, then ASSERT().
2706 If StartBit is greater than 31, then ASSERT().
2707 If EndBit is greater than 31, then ASSERT().
2708 If EndBit is less than StartBit, then ASSERT().
2710 @param Operand Operand on which to perform the bitfield operation.
2711 @param StartBit The ordinal of the least significant bit in the bit field.
2713 @param EndBit The ordinal of the most significant bit in the bit field.
2715 @param AndData The value to AND with the read value from the value.
2716 @param OrData The value to OR with the result of the AND operation.
2718 @return The new 32-bit value.
2723 BitFieldAndThenOr32 (
2733 Returns a bit field from a 64-bit value.
2735 Returns the bitfield specified by the StartBit and the EndBit from Operand.
2737 If 64-bit operations are not supported, then ASSERT().
2738 If StartBit is greater than 63, then ASSERT().
2739 If EndBit is greater than 63, then ASSERT().
2740 If EndBit is less than StartBit, then ASSERT().
2742 @param Operand Operand on which to perform the bitfield operation.
2743 @param StartBit The ordinal of the least significant bit in the bit field.
2745 @param EndBit The ordinal of the most significant bit in the bit field.
2748 @return The bit field read.
2761 Writes a bit field to a 64-bit value, and returns the result.
2763 Writes Value to the bit field specified by the StartBit and the EndBit in
2764 Operand. All other bits in Operand are preserved. The new 64-bit value is
2767 If 64-bit operations are not supported, then ASSERT().
2768 If StartBit is greater than 63, then ASSERT().
2769 If EndBit is greater than 63, then ASSERT().
2770 If EndBit is less than StartBit, then ASSERT().
2772 @param Operand Operand on which to perform the bitfield operation.
2773 @param StartBit The ordinal of the least significant bit in the bit field.
2775 @param EndBit The ordinal of the most significant bit in the bit field.
2777 @param Value New value of the bit field.
2779 @return The new 64-bit value.
2793 Reads a bit field from a 64-bit value, performs a bitwise OR, and returns the
2796 Performs a bitwise OR between the bit field specified by StartBit
2797 and EndBit in Operand and the value specified by OrData. All other bits in
2798 Operand are preserved. The new 64-bit value is returned.
2800 If 64-bit operations are not supported, then ASSERT().
2801 If StartBit is greater than 63, then ASSERT().
2802 If EndBit is greater than 63, then ASSERT().
2803 If EndBit is less than StartBit, then ASSERT().
2805 @param Operand Operand on which to perform the bitfield operation.
2806 @param StartBit The ordinal of the least significant bit in the bit field.
2808 @param EndBit The ordinal of the most significant bit in the bit field.
2810 @param OrData The value to OR with the read value from the value
2812 @return The new 64-bit value.
2826 Reads a bit field from a 64-bit value, performs a bitwise AND, and returns
2829 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2830 in Operand and the value specified by AndData. All other bits in Operand are
2831 preserved. The new 64-bit value is returned.
2833 If 64-bit operations are not supported, then ASSERT().
2834 If StartBit is greater than 63, then ASSERT().
2835 If EndBit is greater than 63, then ASSERT().
2836 If EndBit is less than StartBit, then ASSERT().
2838 @param Operand Operand on which to perform the bitfield operation.
2839 @param StartBit The ordinal of the least significant bit in the bit field.
2841 @param EndBit The ordinal of the most significant bit in the bit field.
2843 @param AndData The value to AND with the read value from the value
2845 @return The new 64-bit value.
2859 Reads a bit field from a 64-bit value, performs a bitwise AND followed by a
2860 bitwise OR, and returns the result.
2862 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2863 in Operand and the value specified by AndData, followed by a bitwise
2864 OR with value specified by OrData. All other bits in Operand are
2865 preserved. The new 64-bit value is returned.
2867 If 64-bit operations are not supported, then ASSERT().
2868 If StartBit is greater than 63, then ASSERT().
2869 If EndBit is greater than 63, then ASSERT().
2870 If EndBit is less than StartBit, then ASSERT().
2872 @param Operand Operand on which to perform the bitfield operation.
2873 @param StartBit The ordinal of the least significant bit in the bit field.
2875 @param EndBit The ordinal of the most significant bit in the bit field.
2877 @param AndData The value to AND with the read value from the value.
2878 @param OrData The value to OR with the result of the AND operation.
2880 @return The new 64-bit value.
2885 BitFieldAndThenOr64 (
2895 // Base Library Synchronization Functions
2899 Retrieves the architecture specific spin lock alignment requirements for
2900 optimal spin lock performance.
2902 This function retrieves the spin lock alignment requirements for optimal
2903 performance on a given CPU architecture. The spin lock alignment must be a
2904 power of two and is returned by this function. If there are no alignment
2905 requirements, then 1 must be returned. The spin lock synchronization
2906 functions must function correctly if the spin lock size and alignment values
2907 returned by this function are not used at all. These values are hints to the
2908 consumers of the spin lock synchronization functions to obtain optimal spin
2911 @return The architecture specific spin lock alignment.
2916 GetSpinLockProperties (
2922 Initializes a spin lock to the released state and returns the spin lock.
2924 This function initializes the spin lock specified by SpinLock to the released
2925 state, and returns SpinLock. Optimal performance can be achieved by calling
2926 GetSpinLockProperties() to determine the size and alignment requirements for
2929 If SpinLock is NULL, then ASSERT().
2931 @param SpinLock A pointer to the spin lock to initialize to the released
2934 @return SpinLock in release state.
2939 InitializeSpinLock (
2940 OUT SPIN_LOCK
*SpinLock
2945 Waits until a spin lock can be placed in the acquired state.
2947 This function checks the state of the spin lock specified by SpinLock. If
2948 SpinLock is in the released state, then this function places SpinLock in the
2949 acquired state and returns SpinLock. Otherwise, this function waits
2950 indefinitely for the spin lock to be released, and then places it in the
2951 acquired state and returns SpinLock. All state transitions of SpinLock must
2952 be performed using MP safe mechanisms.
2954 If SpinLock is NULL, then ASSERT().
2955 If SpinLock was not initialized with InitializeSpinLock(), then ASSERT().
2956 If PcdSpinLockTimeout is not zero, and SpinLock is can not be acquired in
2957 PcdSpinLockTimeout microseconds, then ASSERT().
2959 @param SpinLock A pointer to the spin lock to place in the acquired state.
2961 @return SpinLock acquired lock.
2967 IN OUT SPIN_LOCK
*SpinLock
2972 Attempts to place a spin lock in the acquired state.
2974 This function checks the state of the spin lock specified by SpinLock. If
2975 SpinLock is in the released state, then this function places SpinLock in the
2976 acquired state and returns TRUE. Otherwise, FALSE is returned. All state
2977 transitions of SpinLock must be performed using MP safe mechanisms.
2979 If SpinLock is NULL, then ASSERT().
2980 If SpinLock was not initialized with InitializeSpinLock(), then ASSERT().
2982 @param SpinLock A pointer to the spin lock to place in the acquired state.
2984 @retval TRUE SpinLock was placed in the acquired state.
2985 @retval FALSE SpinLock could not be acquired.
2990 AcquireSpinLockOrFail (
2991 IN OUT SPIN_LOCK
*SpinLock
2996 Releases a spin lock.
2998 This function places the spin lock specified by SpinLock in the release state
2999 and returns SpinLock.
3001 If SpinLock is NULL, then ASSERT().
3002 If SpinLock was not initialized with InitializeSpinLock(), then ASSERT().
3004 @param SpinLock A pointer to the spin lock to release.
3006 @return SpinLock released lock.
3012 IN OUT SPIN_LOCK
*SpinLock
3017 Performs an atomic increment of an 32-bit unsigned integer.
3019 Performs an atomic increment of the 32-bit unsigned integer specified by
3020 Value and returns the incremented value. The increment operation must be
3021 performed using MP safe mechanisms. The state of the return value is not
3022 guaranteed to be MP safe.
3024 If Value is NULL, then ASSERT().
3026 @param Value A pointer to the 32-bit value to increment.
3028 @return The incremented value.
3033 InterlockedIncrement (
3039 Performs an atomic decrement of an 32-bit unsigned integer.
3041 Performs an atomic decrement of the 32-bit unsigned integer specified by
3042 Value and returns the decremented value. The decrement operation must be
3043 performed using MP safe mechanisms. The state of the return value is not
3044 guaranteed to be MP safe.
3046 If Value is NULL, then ASSERT().
3048 @param Value A pointer to the 32-bit value to decrement.
3050 @return The decremented value.
3055 InterlockedDecrement (
3061 Performs an atomic compare exchange operation on a 32-bit unsigned integer.
3063 Performs an atomic compare exchange operation on the 32-bit unsigned integer
3064 specified by Value. If Value is equal to CompareValue, then Value is set to
3065 ExchangeValue and CompareValue is returned. If Value is not equal to CompareValue,
3066 then Value is returned. The compare exchange operation must be performed using
3069 If Value is NULL, then ASSERT().
3071 @param Value A pointer to the 32-bit value for the compare exchange
3073 @param CompareValue 32-bit value used in compare operation.
3074 @param ExchangeValue 32-bit value used in exchange operation.
3076 @return The original *Value before exchange.
3081 InterlockedCompareExchange32 (
3082 IN OUT UINT32
*Value
,
3083 IN UINT32 CompareValue
,
3084 IN UINT32 ExchangeValue
3089 Performs an atomic compare exchange operation on a 64-bit unsigned integer.
3091 Performs an atomic compare exchange operation on the 64-bit unsigned integer specified
3092 by Value. If Value is equal to CompareValue, then Value is set to ExchangeValue and
3093 CompareValue is returned. If Value is not equal to CompareValue, then Value is returned.
3094 The compare exchange operation must be performed using MP safe mechanisms.
3096 If Value is NULL, then ASSERT().
3098 @param Value A pointer to the 64-bit value for the compare exchange
3100 @param CompareValue 64-bit value used in compare operation.
3101 @param ExchangeValue 64-bit value used in exchange operation.
3103 @return The original *Value before exchange.
3108 InterlockedCompareExchange64 (
3109 IN OUT UINT64
*Value
,
3110 IN UINT64 CompareValue
,
3111 IN UINT64 ExchangeValue
3116 Performs an atomic compare exchange operation on a pointer value.
3118 Performs an atomic compare exchange operation on the pointer value specified
3119 by Value. If Value is equal to CompareValue, then Value is set to
3120 ExchangeValue and CompareValue is returned. If Value is not equal to
3121 CompareValue, then Value is returned. The compare exchange operation must be
3122 performed using MP safe mechanisms.
3124 If Value is NULL, then ASSERT().
3126 @param Value A pointer to the pointer value for the compare exchange
3128 @param CompareValue Pointer value used in compare operation.
3129 @param ExchangeValue Pointer value used in exchange operation.
3131 @return The original *Value before exchange.
3135 InterlockedCompareExchangePointer (
3136 IN OUT VOID
**Value
,
3137 IN VOID
*CompareValue
,
3138 IN VOID
*ExchangeValue
3143 // Base Library Checksum Functions
3147 Returns the sum of all elements in a buffer in unit of UINT8.
3148 During calculation, the carry bits are dropped.
3150 This function calculates the sum of all elements in a buffer
3151 in unit of UINT8. The carry bits in result of addition are dropped.
3152 The result is returned as UINT8. If Length is Zero, then Zero is
3155 If Buffer is NULL, then ASSERT().
3156 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3158 @param Buffer Pointer to the buffer to carry out the sum operation.
3159 @param Length The size, in bytes, of Buffer.
3161 @return Sum The sum of Buffer with carry bits dropped during additions.
3167 IN CONST UINT8
*Buffer
,
3173 Returns the two's complement checksum of all elements in a buffer
3176 This function first calculates the sum of the 8-bit values in the
3177 buffer specified by Buffer and Length. The carry bits in the result
3178 of addition are dropped. Then, the two's complement of the sum is
3179 returned. If Length is 0, then 0 is returned.
3181 If Buffer is NULL, then ASSERT().
3182 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3184 @param Buffer Pointer to the buffer to carry out the checksum operation.
3185 @param Length The size, in bytes, of Buffer.
3187 @return Checksum The 2's complement checksum of Buffer.
3192 CalculateCheckSum8 (
3193 IN CONST UINT8
*Buffer
,
3199 Returns the sum of all elements in a buffer of 16-bit values. During
3200 calculation, the carry bits are dropped.
3202 This function calculates the sum of the 16-bit values in the buffer
3203 specified by Buffer and Length. The carry bits in result of addition are dropped.
3204 The 16-bit result is returned. If Length is 0, then 0 is returned.
3206 If Buffer is NULL, then ASSERT().
3207 If Buffer is not aligned on a 16-bit boundary, then ASSERT().
3208 If Length is not aligned on a 16-bit boundary, then ASSERT().
3209 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3211 @param Buffer Pointer to the buffer to carry out the sum operation.
3212 @param Length The size, in bytes, of Buffer.
3214 @return Sum The sum of Buffer with carry bits dropped during additions.
3220 IN CONST UINT16
*Buffer
,
3226 Returns the two's complement checksum of all elements in a buffer of
3229 This function first calculates the sum of the 16-bit values in the buffer
3230 specified by Buffer and Length. The carry bits in the result of addition
3231 are dropped. Then, the two's complement of the sum is returned. If Length
3232 is 0, then 0 is returned.
3234 If Buffer is NULL, then ASSERT().
3235 If Buffer is not aligned on a 16-bit boundary, then ASSERT().
3236 If Length is not aligned on a 16-bit boundary, then ASSERT().
3237 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3239 @param Buffer Pointer to the buffer to carry out the checksum operation.
3240 @param Length The size, in bytes, of Buffer.
3242 @return Checksum The 2's complement checksum of Buffer.
3247 CalculateCheckSum16 (
3248 IN CONST UINT16
*Buffer
,
3254 Returns the sum of all elements in a buffer of 32-bit values. During
3255 calculation, the carry bits are dropped.
3257 This function calculates the sum of the 32-bit values in the buffer
3258 specified by Buffer and Length. The carry bits in result of addition are dropped.
3259 The 32-bit result is returned. If Length is 0, then 0 is returned.
3261 If Buffer is NULL, then ASSERT().
3262 If Buffer is not aligned on a 32-bit boundary, then ASSERT().
3263 If Length is not aligned on a 32-bit boundary, then ASSERT().
3264 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3266 @param Buffer Pointer to the buffer to carry out the sum operation.
3267 @param Length The size, in bytes, of Buffer.
3269 @return Sum The sum of Buffer with carry bits dropped during additions.
3275 IN CONST UINT32
*Buffer
,
3281 Returns the two's complement checksum of all elements in a buffer of
3284 This function first calculates the sum of the 32-bit values in the buffer
3285 specified by Buffer and Length. The carry bits in the result of addition
3286 are dropped. Then, the two's complement of the sum is returned. If Length
3287 is 0, then 0 is returned.
3289 If Buffer is NULL, then ASSERT().
3290 If Buffer is not aligned on a 32-bit boundary, then ASSERT().
3291 If Length is not aligned on a 32-bit boundary, then ASSERT().
3292 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3294 @param Buffer Pointer to the buffer to carry out the checksum operation.
3295 @param Length The size, in bytes, of Buffer.
3297 @return Checksum The 2's complement checksum of Buffer.
3302 CalculateCheckSum32 (
3303 IN CONST UINT32
*Buffer
,
3309 Returns the sum of all elements in a buffer of 64-bit values. During
3310 calculation, the carry bits are dropped.
3312 This function calculates the sum of the 64-bit values in the buffer
3313 specified by Buffer and Length. The carry bits in result of addition are dropped.
3314 The 64-bit result is returned. If Length is 0, then 0 is returned.
3316 If Buffer is NULL, then ASSERT().
3317 If Buffer is not aligned on a 64-bit boundary, then ASSERT().
3318 If Length is not aligned on a 64-bit boundary, then ASSERT().
3319 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3321 @param Buffer Pointer to the buffer to carry out the sum operation.
3322 @param Length The size, in bytes, of Buffer.
3324 @return Sum The sum of Buffer with carry bits dropped during additions.
3330 IN CONST UINT64
*Buffer
,
3336 Returns the two's complement checksum of all elements in a buffer of
3339 This function first calculates the sum of the 64-bit values in the buffer
3340 specified by Buffer and Length. The carry bits in the result of addition
3341 are dropped. Then, the two's complement of the sum is returned. If Length
3342 is 0, then 0 is returned.
3344 If Buffer is NULL, then ASSERT().
3345 If Buffer is not aligned on a 64-bit boundary, then ASSERT().
3346 If Length is not aligned on a 64-bit boundary, then ASSERT().
3347 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3349 @param Buffer Pointer to the buffer to carry out the checksum operation.
3350 @param Length The size, in bytes, of Buffer.
3352 @return Checksum The 2's complement checksum of Buffer.
3357 CalculateCheckSum64 (
3358 IN CONST UINT64
*Buffer
,
3364 // Base Library CPU Functions
3368 Function entry point used when a stack switch is requested with SwitchStack()
3370 @param Context1 Context1 parameter passed into SwitchStack().
3371 @param Context2 Context2 parameter passed into SwitchStack().
3376 (EFIAPI
*SWITCH_STACK_ENTRY_POINT
)(
3377 IN VOID
*Context1
, OPTIONAL
3378 IN VOID
*Context2 OPTIONAL
3383 Used to serialize load and store operations.
3385 All loads and stores that proceed calls to this function are guaranteed to be
3386 globally visible when this function returns.
3397 Saves the current CPU context that can be restored with a call to LongJump()
3400 Saves the current CPU context in the buffer specified by JumpBuffer and
3401 returns 0. The initial call to SetJump() must always return 0. Subsequent
3402 calls to LongJump() cause a non-zero value to be returned by SetJump().
3404 If JumpBuffer is NULL, then ASSERT().
3405 For IPF CPUs, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().
3407 NOTE: The structure BASE_LIBRARY_JUMP_BUFFER is CPU architecture specific.
3408 The same structure must never be used for more than one CPU architecture context.
3409 For example, a BASE_LIBRARY_JUMP_BUFFER allocated by an IA-32 module must never be used from an x64 module.
3410 SetJump()/LongJump() is not currently supported for the EBC processor type.
3412 @param JumpBuffer A pointer to CPU context buffer.
3414 @retval 0 Indicates a return from SetJump().
3420 OUT BASE_LIBRARY_JUMP_BUFFER
*JumpBuffer
3425 Restores the CPU context that was saved with SetJump().
3427 Restores the CPU context from the buffer specified by JumpBuffer. This
3428 function never returns to the caller. Instead is resumes execution based on
3429 the state of JumpBuffer.
3431 If JumpBuffer is NULL, then ASSERT().
3432 For IPF CPUs, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().
3433 If Value is 0, then ASSERT().
3435 @param JumpBuffer A pointer to CPU context buffer.
3436 @param Value The value to return when the SetJump() context is
3437 restored and must be non-zero.
3443 IN BASE_LIBRARY_JUMP_BUFFER
*JumpBuffer
,
3449 Enables CPU interrupts.
3460 Disables CPU interrupts.
3471 Disables CPU interrupts and returns the interrupt state prior to the disable
3474 @retval TRUE CPU interrupts were enabled on entry to this call.
3475 @retval FALSE CPU interrupts were disabled on entry to this call.
3480 SaveAndDisableInterrupts (
3486 Enables CPU interrupts for the smallest window required to capture any
3492 EnableDisableInterrupts (
3498 Retrieves the current CPU interrupt state.
3500 Returns TRUE is interrupts are currently enabled. Otherwise
3503 @retval TRUE CPU interrupts are enabled.
3504 @retval FALSE CPU interrupts are disabled.
3515 Set the current CPU interrupt state.
3517 Sets the current CPU interrupt state to the state specified by
3518 InterruptState. If InterruptState is TRUE, then interrupts are enabled. If
3519 InterruptState is FALSE, then interrupts are disabled. InterruptState is
3522 @param InterruptState TRUE if interrupts should enabled. FALSE if
3523 interrupts should be disabled.
3525 @return InterruptState
3531 IN BOOLEAN InterruptState
3536 Requests CPU to pause for a short period of time.
3538 Requests CPU to pause for a short period of time. Typically used in MP
3539 systems to prevent memory starvation while waiting for a spin lock.
3550 Transfers control to a function starting with a new stack.
3552 Transfers control to the function specified by EntryPoint using the
3553 new stack specified by NewStack and passing in the parameters specified
3554 by Context1 and Context2. Context1 and Context2 are optional and may
3555 be NULL. The function EntryPoint must never return. This function
3556 supports a variable number of arguments following the NewStack parameter.
3557 These additional arguments are ignored on IA-32, x64, and EBC.
3558 IPF CPUs expect one additional parameter of type VOID * that specifies
3559 the new backing store pointer.
3561 If EntryPoint is NULL, then ASSERT().
3562 If NewStack is NULL, then ASSERT().
3564 @param EntryPoint A pointer to function to call with the new stack.
3565 @param Context1 A pointer to the context to pass into the EntryPoint
3567 @param Context2 A pointer to the context to pass into the EntryPoint
3569 @param NewStack A pointer to the new stack to use for the EntryPoint
3571 @param ... This variable argument list is ignored for IA32, x64, and EBC.
3572 For IPF, this variable argument list is expected to contain
3573 a single parameter of type VOID * that specifies the new backing
3581 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
3582 IN VOID
*Context1
, OPTIONAL
3583 IN VOID
*Context2
, OPTIONAL
3590 Generates a breakpoint on the CPU.
3592 Generates a breakpoint on the CPU. The breakpoint must be implemented such
3593 that code can resume normal execution after the breakpoint.
3604 Executes an infinite loop.
3606 Forces the CPU to execute an infinite loop. A debugger may be used to skip
3607 past the loop and the code that follows the loop must execute properly. This
3608 implies that the infinite loop must not cause the code that follow it to be
3618 #if defined (MDE_CPU_IPF)
3621 Flush a range of cache lines in the cache coherency domain of the calling
3624 Flushes the cache lines specified by Address and Length. If Address is not aligned
3625 on a cache line boundary, then entire cache line containing Address is flushed.
3626 If Address + Length is not aligned on a cache line boundary, then the entire cache
3627 line containing Address + Length - 1 is flushed. This function may choose to flush
3628 the entire cache if that is more efficient than flushing the specified range. If
3629 Length is 0, the no cache lines are flushed. Address is returned.
3630 This function is only available on IPF.
3632 If Length is greater than (MAX_ADDRESS - Address + 1), then ASSERT().
3634 @param Address The base address of the instruction lines to invalidate. If
3635 the CPU is in a physical addressing mode, then Address is a
3636 physical address. If the CPU is in a virtual addressing mode,
3637 then Address is a virtual address.
3639 @param Length The number of bytes to invalidate from the instruction cache.
3646 AsmFlushCacheRange (
3653 Executes a FC instruction
3654 Executes a FC instruction on the cache line specified by Address.
3655 The cache line size affected is at least 32-bytes (aligned on a 32-byte boundary).
3656 An implementation may flush a larger region. This function is only available on IPF.
3658 @param Address The Address of cache line to be flushed.
3660 @return The address of FC instruction executed.
3671 Executes a FC.I instruction.
3672 Executes a FC.I instruction on the cache line specified by Address.
3673 The cache line size affected is at least 32-bytes (aligned on a 32-byte boundary).
3674 An implementation may flush a larger region. This function is only available on IPF.
3676 @param Address The Address of cache line to be flushed.
3678 @return The address of FC.I instruction executed.
3689 Reads the current value of a Processor Identifier Register (CPUID).
3691 Reads and returns the current value of Processor Identifier Register specified by Index.
3692 The Index of largest implemented CPUID (One less than the number of implemented CPUID
3693 registers) is determined by CPUID [3] bits {7:0}.
3694 No parameter checking is performed on Index. If the Index value is beyond the
3695 implemented CPUID register range, a Reserved Register/Field fault may occur. The caller
3696 must either guarantee that Index is valid, or the caller must set up fault handlers to
3697 catch the faults. This function is only available on IPF.
3699 @param Index The 8-bit Processor Identifier Register index to read.
3701 @return The current value of Processor Identifier Register specified by Index.
3712 Reads the current value of 64-bit Processor Status Register (PSR).
3713 This function is only available on IPF.
3715 @return The current value of PSR.
3726 Writes the current value of 64-bit Processor Status Register (PSR).
3728 No parameter checking is performed on Value. All bits of Value corresponding to
3729 reserved fields of PSR must be 0 or a Reserved Register/Field fault may occur.
3730 The caller must either guarantee that Value is valid, or the caller must set up
3731 fault handlers to catch the faults. This function is only available on IPF.
3733 @param Value The 64-bit value to write to PSR.
3735 @return The 64-bit value written to the PSR.
3746 Reads the current value of 64-bit Kernel Register #0 (KR0).
3748 Reads and returns the current value of KR0.
3749 This function is only available on IPF.
3751 @return The current value of KR0.
3762 Reads the current value of 64-bit Kernel Register #1 (KR1).
3764 Reads and returns the current value of KR1.
3765 This function is only available on IPF.
3767 @return The current value of KR1.
3778 Reads the current value of 64-bit Kernel Register #2 (KR2).
3780 Reads and returns the current value of KR2.
3781 This function is only available on IPF.
3783 @return The current value of KR2.
3794 Reads the current value of 64-bit Kernel Register #3 (KR3).
3796 Reads and returns the current value of KR3.
3797 This function is only available on IPF.
3799 @return The current value of KR3.
3810 Reads the current value of 64-bit Kernel Register #4 (KR4).
3812 Reads and returns the current value of KR4.
3813 This function is only available on IPF.
3815 @return The current value of KR4.
3826 Reads the current value of 64-bit Kernel Register #5 (KR5).
3828 Reads and returns the current value of KR5.
3829 This function is only available on IPF.
3831 @return The current value of KR5.
3842 Reads the current value of 64-bit Kernel Register #6 (KR6).
3844 Reads and returns the current value of KR6.
3845 This function is only available on IPF.
3847 @return The current value of KR6.
3858 Reads the current value of 64-bit Kernel Register #7 (KR7).
3860 Reads and returns the current value of KR7.
3861 This function is only available on IPF.
3863 @return The current value of KR7.
3874 Write the current value of 64-bit Kernel Register #0 (KR0).
3876 Writes the current value of KR0. The 64-bit value written to
3877 the KR0 is returned. This function is only available on IPF.
3879 @param Value The 64-bit value to write to KR0.
3881 @return The 64-bit value written to the KR0.
3892 Write the current value of 64-bit Kernel Register #1 (KR1).
3894 Writes the current value of KR1. The 64-bit value written to
3895 the KR1 is returned. This function is only available on IPF.
3897 @param Value The 64-bit value to write to KR1.
3899 @return The 64-bit value written to the KR1.
3910 Write the current value of 64-bit Kernel Register #2 (KR2).
3912 Writes the current value of KR2. The 64-bit value written to
3913 the KR2 is returned. This function is only available on IPF.
3915 @param Value The 64-bit value to write to KR2.
3917 @return The 64-bit value written to the KR2.
3928 Write the current value of 64-bit Kernel Register #3 (KR3).
3930 Writes the current value of KR3. The 64-bit value written to
3931 the KR3 is returned. This function is only available on IPF.
3933 @param Value The 64-bit value to write to KR3.
3935 @return The 64-bit value written to the KR3.
3946 Write the current value of 64-bit Kernel Register #4 (KR4).
3948 Writes the current value of KR4. The 64-bit value written to
3949 the KR4 is returned. This function is only available on IPF.
3951 @param Value The 64-bit value to write to KR4.
3953 @return The 64-bit value written to the KR4.
3964 Write the current value of 64-bit Kernel Register #5 (KR5).
3966 Writes the current value of KR5. The 64-bit value written to
3967 the KR5 is returned. This function is only available on IPF.
3969 @param Value The 64-bit value to write to KR5.
3971 @return The 64-bit value written to the KR5.
3982 Write the current value of 64-bit Kernel Register #6 (KR6).
3984 Writes the current value of KR6. The 64-bit value written to
3985 the KR6 is returned. This function is only available on IPF.
3987 @param Value The 64-bit value to write to KR6.
3989 @return The 64-bit value written to the KR6.
4000 Write the current value of 64-bit Kernel Register #7 (KR7).
4002 Writes the current value of KR7. The 64-bit value written to
4003 the KR7 is returned. This function is only available on IPF.
4005 @param Value The 64-bit value to write to KR7.
4007 @return The 64-bit value written to the KR7.
4018 Reads the current value of Interval Timer Counter Register (ITC).
4020 Reads and returns the current value of ITC.
4021 This function is only available on IPF.
4023 @return The current value of ITC.
4034 Reads the current value of Interval Timer Vector Register (ITV).
4036 Reads and returns the current value of ITV.
4037 This function is only available on IPF.
4039 @return The current value of ITV.
4050 Reads the current value of Interval Timer Match Register (ITM).
4052 Reads and returns the current value of ITM.
4053 This function is only available on IPF.
4055 @return The current value of ITM.
4065 Writes the current value of 64-bit Interval Timer Counter Register (ITC).
4067 Writes the current value of ITC. The 64-bit value written to the ITC is returned.
4068 This function is only available on IPF.
4070 @param Value The 64-bit value to write to ITC.
4072 @return The 64-bit value written to the ITC.
4083 Writes the current value of 64-bit Interval Timer Match Register (ITM).
4085 Writes the current value of ITM. The 64-bit value written to the ITM is returned.
4086 This function is only available on IPF.
4088 @param Value The 64-bit value to write to ITM.
4090 @return The 64-bit value written to the ITM.
4101 Writes the current value of 64-bit Interval Timer Vector Register (ITV).
4103 Writes the current value of ITV. The 64-bit value written to the ITV is returned.
4104 No parameter checking is performed on Value. All bits of Value corresponding to
4105 reserved fields of ITV must be 0 or a Reserved Register/Field fault may occur.
4106 The caller must either guarantee that Value is valid, or the caller must set up
4107 fault handlers to catch the faults.
4108 This function is only available on IPF.
4110 @param Value The 64-bit value to write to ITV.
4112 @return The 64-bit value written to the ITV.
4123 Reads the current value of Default Control Register (DCR).
4125 Reads and returns the current value of DCR. This function is only available on IPF.
4127 @return The current value of DCR.
4138 Reads the current value of Interruption Vector Address Register (IVA).
4140 Reads and returns the current value of IVA. This function is only available on IPF.
4142 @return The current value of IVA.
4152 Reads the current value of Page Table Address Register (PTA).
4154 Reads and returns the current value of PTA. This function is only available on IPF.
4156 @return The current value of PTA.
4167 Writes the current value of 64-bit Default Control Register (DCR).
4169 Writes the current value of DCR. The 64-bit value written to the DCR is returned.
4170 No parameter checking is performed on Value. All bits of Value corresponding to
4171 reserved fields of DCR must be 0 or a Reserved Register/Field fault may occur.
4172 The caller must either guarantee that Value is valid, or the caller must set up
4173 fault handlers to catch the faults.
4174 This function is only available on IPF.
4176 @param Value The 64-bit value to write to DCR.
4178 @return The 64-bit value written to the DCR.
4189 Writes the current value of 64-bit Interruption Vector Address Register (IVA).
4191 Writes the current value of IVA. The 64-bit value written to the IVA is returned.
4192 The size of vector table is 32 K bytes and is 32 K bytes aligned
4193 the low 15 bits of Value is ignored when written.
4194 This function is only available on IPF.
4196 @param Value The 64-bit value to write to IVA.
4198 @return The 64-bit value written to the IVA.
4209 Writes the current value of 64-bit Page Table Address Register (PTA).
4211 Writes the current value of PTA. The 64-bit value written to the PTA is returned.
4212 No parameter checking is performed on Value. All bits of Value corresponding to
4213 reserved fields of DCR must be 0 or a Reserved Register/Field fault may occur.
4214 The caller must either guarantee that Value is valid, or the caller must set up
4215 fault handlers to catch the faults.
4216 This function is only available on IPF.
4218 @param Value The 64-bit value to write to PTA.
4220 @return The 64-bit value written to the PTA.
4230 Reads the current value of Local Interrupt ID Register (LID).
4232 Reads and returns the current value of LID. This function is only available on IPF.
4234 @return The current value of LID.
4245 Reads the current value of External Interrupt Vector Register (IVR).
4247 Reads and returns the current value of IVR. This function is only available on IPF.
4249 @return The current value of IVR.
4260 Reads the current value of Task Priority Register (TPR).
4262 Reads and returns the current value of TPR. This function is only available on IPF.
4264 @return The current value of TPR.
4275 Reads the current value of External Interrupt Request Register #0 (IRR0).
4277 Reads and returns the current value of IRR0. This function is only available on IPF.
4279 @return The current value of IRR0.
4290 Reads the current value of External Interrupt Request Register #1 (IRR1).
4292 Reads and returns the current value of IRR1. This function is only available on IPF.
4294 @return The current value of IRR1.
4305 Reads the current value of External Interrupt Request Register #2 (IRR2).
4307 Reads and returns the current value of IRR2. This function is only available on IPF.
4309 @return The current value of IRR2.
4320 Reads the current value of External Interrupt Request Register #3 (IRR3).
4322 Reads and returns the current value of IRR3. This function is only available on IPF.
4324 @return The current value of IRR3.
4335 Reads the current value of Performance Monitor Vector Register (PMV).
4337 Reads and returns the current value of PMV. This function is only available on IPF.
4339 @return The current value of PMV.
4350 Reads the current value of Corrected Machine Check Vector Register (CMCV).
4352 Reads and returns the current value of CMCV. This function is only available on IPF.
4354 @return The current value of CMCV.
4365 Reads the current value of Local Redirection Register #0 (LRR0).
4367 Reads and returns the current value of LRR0. This function is only available on IPF.
4369 @return The current value of LRR0.
4380 Reads the current value of Local Redirection Register #1 (LRR1).
4382 Reads and returns the current value of LRR1. This function is only available on IPF.
4384 @return The current value of LRR1.
4395 Writes the current value of 64-bit Page Local Interrupt ID Register (LID).
4397 Writes the current value of LID. The 64-bit value written to the LID is returned.
4398 No parameter checking is performed on Value. All bits of Value corresponding to
4399 reserved fields of LID must be 0 or a Reserved Register/Field fault may occur.
4400 The caller must either guarantee that Value is valid, or the caller must set up
4401 fault handlers to catch the faults.
4402 This function is only available on IPF.
4404 @param Value The 64-bit value to write to LID.
4406 @return The 64-bit value written to the LID.
4417 Writes the current value of 64-bit Task Priority Register (TPR).
4419 Writes the current value of TPR. The 64-bit value written to the TPR is returned.
4420 No parameter checking is performed on Value. All bits of Value corresponding to
4421 reserved fields of TPR must be 0 or a Reserved Register/Field fault may occur.
4422 The caller must either guarantee that Value is valid, or the caller must set up
4423 fault handlers to catch the faults.
4424 This function is only available on IPF.
4426 @param Value The 64-bit value to write to TPR.
4428 @return The 64-bit value written to the TPR.
4439 Performs a write operation on End OF External Interrupt Register (EOI).
4441 Writes a value of 0 to the EOI Register. This function is only available on IPF.
4452 Writes the current value of 64-bit Performance Monitor Vector Register (PMV).
4454 Writes the current value of PMV. The 64-bit value written to the PMV is returned.
4455 No parameter checking is performed on Value. All bits of Value corresponding
4456 to reserved fields of PMV must be 0 or a Reserved Register/Field fault may occur.
4457 The caller must either guarantee that Value is valid, or the caller must set up
4458 fault handlers to catch the faults.
4459 This function is only available on IPF.
4461 @param Value The 64-bit value to write to PMV.
4463 @return The 64-bit value written to the PMV.
4474 Writes the current value of 64-bit Corrected Machine Check Vector Register (CMCV).
4476 Writes the current value of CMCV. The 64-bit value written to the CMCV is returned.
4477 No parameter checking is performed on Value. All bits of Value corresponding
4478 to reserved fields of CMCV must be 0 or a Reserved Register/Field fault may occur.
4479 The caller must either guarantee that Value is valid, or the caller must set up
4480 fault handlers to catch the faults.
4481 This function is only available on IPF.
4483 @param Value The 64-bit value to write to CMCV.
4485 @return The 64-bit value written to the CMCV.
4496 Writes the current value of 64-bit Local Redirection Register #0 (LRR0).
4498 Writes the current value of LRR0. The 64-bit value written to the LRR0 is returned.
4499 No parameter checking is performed on Value. All bits of Value corresponding
4500 to reserved fields of LRR0 must be 0 or a Reserved Register/Field fault may occur.
4501 The caller must either guarantee that Value is valid, or the caller must set up
4502 fault handlers to catch the faults.
4503 This function is only available on IPF.
4505 @param Value The 64-bit value to write to LRR0.
4507 @return The 64-bit value written to the LRR0.
4518 Writes the current value of 64-bit Local Redirection Register #1 (LRR1).
4520 Writes the current value of LRR1. The 64-bit value written to the LRR1 is returned.
4521 No parameter checking is performed on Value. All bits of Value corresponding
4522 to reserved fields of LRR1 must be 0 or a Reserved Register/Field fault may occur.
4523 The caller must either guarantee that Value is valid, or the caller must
4524 set up fault handlers to catch the faults.
4525 This function is only available on IPF.
4527 @param Value The 64-bit value to write to LRR1.
4529 @return The 64-bit value written to the LRR1.
4540 Reads the current value of Instruction Breakpoint Register (IBR).
4542 The Instruction Breakpoint Registers are used in pairs. The even numbered
4543 registers contain breakpoint addresses, and the odd numbered registers contain
4544 breakpoint mask conditions. At least 4 instruction registers pairs are implemented
4545 on all processor models. Implemented registers are contiguous starting with
4546 register 0. No parameter checking is performed on Index, and if the Index value
4547 is beyond the implemented IBR register range, a Reserved Register/Field fault may
4548 occur. The caller must either guarantee that Index is valid, or the caller must
4549 set up fault handlers to catch the faults.
4550 This function is only available on IPF.
4552 @param Index The 8-bit Instruction Breakpoint Register index to read.
4554 @return The current value of Instruction Breakpoint Register specified by Index.
4565 Reads the current value of Data Breakpoint Register (DBR).
4567 The Data Breakpoint Registers are used in pairs. The even numbered registers
4568 contain breakpoint addresses, and odd numbered registers contain breakpoint
4569 mask conditions. At least 4 data registers pairs are implemented on all processor
4570 models. Implemented registers are contiguous starting with register 0.
4571 No parameter checking is performed on Index. If the Index value is beyond
4572 the implemented DBR register range, a Reserved Register/Field fault may occur.
4573 The caller must either guarantee that Index is valid, or the caller must set up
4574 fault handlers to catch the faults.
4575 This function is only available on IPF.
4577 @param Index The 8-bit Data Breakpoint Register index to read.
4579 @return The current value of Data Breakpoint Register specified by Index.
4590 Reads the current value of Performance Monitor Configuration Register (PMC).
4592 All processor implementations provide at least 4 performance counters
4593 (PMC/PMD [4]...PMC/PMD [7] pairs), and 4 performance monitor counter overflow
4594 status registers (PMC [0]... PMC [3]). Processor implementations may provide
4595 additional implementation-dependent PMC and PMD to increase the number of
4596 'generic' performance counters (PMC/PMD pairs). The remainder of PMC and PMD
4597 register set is implementation dependent. No parameter checking is performed
4598 on Index. If the Index value is beyond the implemented PMC register range,
4599 zero value will be returned.
4600 This function is only available on IPF.
4602 @param Index The 8-bit Performance Monitor Configuration Register index to read.
4604 @return The current value of Performance Monitor Configuration Register
4616 Reads the current value of Performance Monitor Data Register (PMD).
4618 All processor implementations provide at least 4 performance counters
4619 (PMC/PMD [4]...PMC/PMD [7] pairs), and 4 performance monitor counter
4620 overflow status registers (PMC [0]... PMC [3]). Processor implementations may
4621 provide additional implementation-dependent PMC and PMD to increase the number
4622 of 'generic' performance counters (PMC/PMD pairs). The remainder of PMC and PMD
4623 register set is implementation dependent. No parameter checking is performed
4624 on Index. If the Index value is beyond the implemented PMD register range,
4625 zero value will be returned.
4626 This function is only available on IPF.
4628 @param Index The 8-bit Performance Monitor Data Register index to read.
4630 @return The current value of Performance Monitor Data Register specified by Index.
4641 Writes the current value of 64-bit Instruction Breakpoint Register (IBR).
4643 Writes current value of Instruction Breakpoint Register specified by Index.
4644 The Instruction Breakpoint Registers are used in pairs. The even numbered
4645 registers contain breakpoint addresses, and odd numbered registers contain
4646 breakpoint mask conditions. At least 4 instruction registers pairs are implemented
4647 on all processor models. Implemented registers are contiguous starting with
4648 register 0. No parameter checking is performed on Index. If the Index value
4649 is beyond the implemented IBR register range, a Reserved Register/Field fault may
4650 occur. The caller must either guarantee that Index is valid, or the caller must
4651 set up fault handlers to catch the faults.
4652 This function is only available on IPF.
4654 @param Index The 8-bit Instruction Breakpoint Register index to write.
4655 @param Value The 64-bit value to write to IBR.
4657 @return The 64-bit value written to the IBR.
4669 Writes the current value of 64-bit Data Breakpoint Register (DBR).
4671 Writes current value of Data Breakpoint Register specified by Index.
4672 The Data Breakpoint Registers are used in pairs. The even numbered registers
4673 contain breakpoint addresses, and odd numbered registers contain breakpoint
4674 mask conditions. At least 4 data registers pairs are implemented on all processor
4675 models. Implemented registers are contiguous starting with register 0. No parameter
4676 checking is performed on Index. If the Index value is beyond the implemented
4677 DBR register range, a Reserved Register/Field fault may occur. The caller must
4678 either guarantee that Index is valid, or the caller must set up fault handlers to
4680 This function is only available on IPF.
4682 @param Index The 8-bit Data Breakpoint Register index to write.
4683 @param Value The 64-bit value to write to DBR.
4685 @return The 64-bit value written to the DBR.
4697 Writes the current value of 64-bit Performance Monitor Configuration Register (PMC).
4699 Writes current value of Performance Monitor Configuration Register specified by Index.
4700 All processor implementations provide at least 4 performance counters
4701 (PMC/PMD [4]...PMC/PMD [7] pairs), and 4 performance monitor counter overflow status
4702 registers (PMC [0]... PMC [3]). Processor implementations may provide additional
4703 implementation-dependent PMC and PMD to increase the number of 'generic' performance
4704 counters (PMC/PMD pairs). The remainder of PMC and PMD register set is implementation
4705 dependent. No parameter checking is performed on Index. If the Index value is
4706 beyond the implemented PMC register range, the write is ignored.
4707 This function is only available on IPF.
4709 @param Index The 8-bit Performance Monitor Configuration Register index to write.
4710 @param Value The 64-bit value to write to PMC.
4712 @return The 64-bit value written to the PMC.
4724 Writes the current value of 64-bit Performance Monitor Data Register (PMD).
4726 Writes current value of Performance Monitor Data Register specified by Index.
4727 All processor implementations provide at least 4 performance counters
4728 (PMC/PMD [4]...PMC/PMD [7] pairs), and 4 performance monitor counter overflow
4729 status registers (PMC [0]... PMC [3]). Processor implementations may provide
4730 additional implementation-dependent PMC and PMD to increase the number of 'generic'
4731 performance counters (PMC/PMD pairs). The remainder of PMC and PMD register set
4732 is implementation dependent. No parameter checking is performed on Index. If the
4733 Index value is beyond the implemented PMD register range, the write is ignored.
4734 This function is only available on IPF.
4736 @param Index The 8-bit Performance Monitor Data Register index to write.
4737 @param Value The 64-bit value to write to PMD.
4739 @return The 64-bit value written to the PMD.
4751 Reads the current value of 64-bit Global Pointer (GP).
4753 Reads and returns the current value of GP.
4754 This function is only available on IPF.
4756 @return The current value of GP.
4767 Write the current value of 64-bit Global Pointer (GP).
4769 Writes the current value of GP. The 64-bit value written to the GP is returned.
4770 No parameter checking is performed on Value.
4771 This function is only available on IPF.
4773 @param Value The 64-bit value to write to GP.
4775 @return The 64-bit value written to the GP.
4786 Reads the current value of 64-bit Stack Pointer (SP).
4788 Reads and returns the current value of SP.
4789 This function is only available on IPF.
4791 @return The current value of SP.
4802 /// Valid Index value for AsmReadControlRegister()
4804 #define IPF_CONTROL_REGISTER_DCR 0
4805 #define IPF_CONTROL_REGISTER_ITM 1
4806 #define IPF_CONTROL_REGISTER_IVA 2
4807 #define IPF_CONTROL_REGISTER_PTA 8
4808 #define IPF_CONTROL_REGISTER_IPSR 16
4809 #define IPF_CONTROL_REGISTER_ISR 17
4810 #define IPF_CONTROL_REGISTER_IIP 19
4811 #define IPF_CONTROL_REGISTER_IFA 20
4812 #define IPF_CONTROL_REGISTER_ITIR 21
4813 #define IPF_CONTROL_REGISTER_IIPA 22
4814 #define IPF_CONTROL_REGISTER_IFS 23
4815 #define IPF_CONTROL_REGISTER_IIM 24
4816 #define IPF_CONTROL_REGISTER_IHA 25
4817 #define IPF_CONTROL_REGISTER_LID 64
4818 #define IPF_CONTROL_REGISTER_IVR 65
4819 #define IPF_CONTROL_REGISTER_TPR 66
4820 #define IPF_CONTROL_REGISTER_EOI 67
4821 #define IPF_CONTROL_REGISTER_IRR0 68
4822 #define IPF_CONTROL_REGISTER_IRR1 69
4823 #define IPF_CONTROL_REGISTER_IRR2 70
4824 #define IPF_CONTROL_REGISTER_IRR3 71
4825 #define IPF_CONTROL_REGISTER_ITV 72
4826 #define IPF_CONTROL_REGISTER_PMV 73
4827 #define IPF_CONTROL_REGISTER_CMCV 74
4828 #define IPF_CONTROL_REGISTER_LRR0 80
4829 #define IPF_CONTROL_REGISTER_LRR1 81
4832 Reads a 64-bit control register.
4834 Reads and returns the control register specified by Index. The valid Index valued are defined
4835 above in "Related Definitions".
4836 If Index is invalid then 0xFFFFFFFFFFFFFFFF is returned. This function is only available on IPF.
4838 @param Index The index of the control register to read.
4840 @return The control register specified by Index.
4845 AsmReadControlRegister (
4851 /// Valid Index value for AsmReadApplicationRegister()
4853 #define IPF_APPLICATION_REGISTER_K0 0
4854 #define IPF_APPLICATION_REGISTER_K1 1
4855 #define IPF_APPLICATION_REGISTER_K2 2
4856 #define IPF_APPLICATION_REGISTER_K3 3
4857 #define IPF_APPLICATION_REGISTER_K4 4
4858 #define IPF_APPLICATION_REGISTER_K5 5
4859 #define IPF_APPLICATION_REGISTER_K6 6
4860 #define IPF_APPLICATION_REGISTER_K7 7
4861 #define IPF_APPLICATION_REGISTER_RSC 16
4862 #define IPF_APPLICATION_REGISTER_BSP 17
4863 #define IPF_APPLICATION_REGISTER_BSPSTORE 18
4864 #define IPF_APPLICATION_REGISTER_RNAT 19
4865 #define IPF_APPLICATION_REGISTER_FCR 21
4866 #define IPF_APPLICATION_REGISTER_EFLAG 24
4867 #define IPF_APPLICATION_REGISTER_CSD 25
4868 #define IPF_APPLICATION_REGISTER_SSD 26
4869 #define IPF_APPLICATION_REGISTER_CFLG 27
4870 #define IPF_APPLICATION_REGISTER_FSR 28
4871 #define IPF_APPLICATION_REGISTER_FIR 29
4872 #define IPF_APPLICATION_REGISTER_FDR 30
4873 #define IPF_APPLICATION_REGISTER_CCV 32
4874 #define IPF_APPLICATION_REGISTER_UNAT 36
4875 #define IPF_APPLICATION_REGISTER_FPSR 40
4876 #define IPF_APPLICATION_REGISTER_ITC 44
4877 #define IPF_APPLICATION_REGISTER_PFS 64
4878 #define IPF_APPLICATION_REGISTER_LC 65
4879 #define IPF_APPLICATION_REGISTER_EC 66
4882 Reads a 64-bit application register.
4884 Reads and returns the application register specified by Index. The valid Index valued are defined
4885 above in "Related Definitions".
4886 If Index is invalid then 0xFFFFFFFFFFFFFFFF is returned. This function is only available on IPF.
4888 @param Index The index of the application register to read.
4890 @return The application register specified by Index.
4895 AsmReadApplicationRegister (
4901 Determines if the CPU is currently executing in virtual, physical, or mixed mode.
4903 Determines the current execution mode of the CPU.
4904 If the CPU is in virtual mode(PSR.RT=1, PSR.DT=1, PSR.IT=1), then 1 is returned.
4905 If the CPU is in physical mode(PSR.RT=0, PSR.DT=0, PSR.IT=0), then 0 is returned.
4906 If the CPU is not in physical mode or virtual mode, then it is in mixed mode,
4908 This function is only available on IPF.
4910 @retval 1 The CPU is in virtual mode.
4911 @retval 0 The CPU is in physical mode.
4912 @retval -1 The CPU is in mixed mode.
4923 Makes a PAL procedure call.
4925 This is a wrapper function to make a PAL procedure call. Based on the Index
4926 value this API will make static or stacked PAL call. The following table
4927 describes the usage of PAL Procedure Index Assignment. Architected procedures
4928 may be designated as required or optional. If a PAL procedure is specified
4929 as optional, a unique return code of 0xFFFFFFFFFFFFFFFF is returned in the
4930 Status field of the PAL_CALL_RETURN structure.
4931 This indicates that the procedure is not present in this PAL implementation.
4932 It is the caller's responsibility to check for this return code after calling
4933 any optional PAL procedure.
4934 No parameter checking is performed on the 5 input parameters, but there are
4935 some common rules that the caller should follow when making a PAL call. Any
4936 address passed to PAL as buffers for return parameters must be 8-byte aligned.
4937 Unaligned addresses may cause undefined results. For those parameters defined
4938 as reserved or some fields defined as reserved must be zero filled or the invalid
4939 argument return value may be returned or undefined result may occur during the
4940 execution of the procedure. If the PalEntryPoint does not point to a valid
4941 PAL entry point then the system behavior is undefined. This function is only
4944 @param PalEntryPoint The PAL procedure calls entry point.
4945 @param Index The PAL procedure Index number.
4946 @param Arg2 The 2nd parameter for PAL procedure calls.
4947 @param Arg3 The 3rd parameter for PAL procedure calls.
4948 @param Arg4 The 4th parameter for PAL procedure calls.
4950 @return structure returned from the PAL Call procedure, including the status and return value.
4956 IN UINT64 PalEntryPoint
,
4964 #elif defined (MDE_CPU_IA32) || defined (MDE_CPU_X64)
4966 /// IA32 and x64 Specific Functions
4967 /// Byte packed structure for 16-bit Real Mode EFLAGS
4971 UINT32 CF
:1; ///< Carry Flag
4972 UINT32 Reserved_0
:1; ///< Reserved
4973 UINT32 PF
:1; ///< Parity Flag
4974 UINT32 Reserved_1
:1; ///< Reserved
4975 UINT32 AF
:1; ///< Auxiliary Carry Flag
4976 UINT32 Reserved_2
:1; ///< Reserved
4977 UINT32 ZF
:1; ///< Zero Flag
4978 UINT32 SF
:1; ///< Sign Flag
4979 UINT32 TF
:1; ///< Trap Flag
4980 UINT32 IF
:1; ///< Interrupt Enable Flag
4981 UINT32 DF
:1; ///< Direction Flag
4982 UINT32 OF
:1; ///< Overflow Flag
4983 UINT32 IOPL
:2; ///< I/O Privilege Level
4984 UINT32 NT
:1; ///< Nested Task
4985 UINT32 Reserved_3
:1; ///< Reserved
4991 /// Byte packed structure for EFLAGS/RFLAGS
4992 /// 32-bits on IA-32
4993 /// 64-bits on x64. The upper 32-bits on x64 are reserved
4997 UINT32 CF
:1; ///< Carry Flag
4998 UINT32 Reserved_0
:1; ///< Reserved
4999 UINT32 PF
:1; ///< Parity Flag
5000 UINT32 Reserved_1
:1; ///< Reserved
5001 UINT32 AF
:1; ///< Auxiliary Carry Flag
5002 UINT32 Reserved_2
:1; ///< Reserved
5003 UINT32 ZF
:1; ///< Zero Flag
5004 UINT32 SF
:1; ///< Sign Flag
5005 UINT32 TF
:1; ///< Trap Flag
5006 UINT32 IF
:1; ///< Interrupt Enable Flag
5007 UINT32 DF
:1; ///< Direction Flag
5008 UINT32 OF
:1; ///< Overflow Flag
5009 UINT32 IOPL
:2; ///< I/O Privilege Level
5010 UINT32 NT
:1; ///< Nested Task
5011 UINT32 Reserved_3
:1; ///< Reserved
5012 UINT32 RF
:1; ///< Resume Flag
5013 UINT32 VM
:1; ///< Virtual 8086 Mode
5014 UINT32 AC
:1; ///< Alignment Check
5015 UINT32 VIF
:1; ///< Virtual Interrupt Flag
5016 UINT32 VIP
:1; ///< Virtual Interrupt Pending
5017 UINT32 ID
:1; ///< ID Flag
5018 UINT32 Reserved_4
:10; ///< Reserved
5024 /// Byte packed structure for Control Register 0 (CR0)
5025 /// 32-bits on IA-32
5026 /// 64-bits on x64. The upper 32-bits on x64 are reserved
5030 UINT32 PE
:1; ///< Protection Enable
5031 UINT32 MP
:1; ///< Monitor Coprocessor
5032 UINT32 EM
:1; ///< Emulation
5033 UINT32 TS
:1; ///< Task Switched
5034 UINT32 ET
:1; ///< Extension Type
5035 UINT32 NE
:1; ///< Numeric Error
5036 UINT32 Reserved_0
:10; ///< Reserved
5037 UINT32 WP
:1; ///< Write Protect
5038 UINT32 Reserved_1
:1; ///< Reserved
5039 UINT32 AM
:1; ///< Alignment Mask
5040 UINT32 Reserved_2
:10; ///< Reserved
5041 UINT32 NW
:1; ///< Mot Write-through
5042 UINT32 CD
:1; ///< Cache Disable
5043 UINT32 PG
:1; ///< Paging
5049 /// Byte packed structure for Control Register 4 (CR4)
5050 /// 32-bits on IA-32
5051 /// 64-bits on x64. The upper 32-bits on x64 are reserved
5055 UINT32 VME
:1; ///< Virtual-8086 Mode Extensions
5056 UINT32 PVI
:1; ///< Protected-Mode Virtual Interrupts
5057 UINT32 TSD
:1; ///< Time Stamp Disable
5058 UINT32 DE
:1; ///< Debugging Extensions
5059 UINT32 PSE
:1; ///< Page Size Extensions
5060 UINT32 PAE
:1; ///< Physical Address Extension
5061 UINT32 MCE
:1; ///< Machine Check Enable
5062 UINT32 PGE
:1; ///< Page Global Enable
5063 UINT32 PCE
:1; ///< Performance Monitoring Counter
5065 UINT32 OSFXSR
:1; ///< Operating System Support for
5066 ///< FXSAVE and FXRSTOR instructions
5067 UINT32 OSXMMEXCPT
:1; ///< Operating System Support for
5068 ///< Unmasked SIMD Floating Point
5070 UINT32 Reserved_0
:2; ///< Reserved
5071 UINT32 VMXE
:1; ///< VMX Enable
5072 UINT32 Reserved_1
:18; ///< Reseved
5078 /// Byte packed structure for an IDTR, GDTR, LDTR descriptor
5087 #define IA32_IDT_GATE_TYPE_TASK 0x85
5088 #define IA32_IDT_GATE_TYPE_INTERRUPT_16 0x86
5089 #define IA32_IDT_GATE_TYPE_TRAP_16 0x87
5090 #define IA32_IDT_GATE_TYPE_INTERRUPT_32 0x8E
5091 #define IA32_IDT_GATE_TYPE_TRAP_32 0x8F
5094 #if defined (MDE_CPU_IA32)
5096 /// Byte packed structure for an IA32 Interrupt Gate Descriptor
5100 UINT32 OffsetLow
:16; ///< Offset bits 15..0
5101 UINT32 Selector
:16; ///< Selector
5102 UINT32 Reserved_0
:8; ///< Reserved
5103 UINT32 GateType
:8; ///< Gate Type. See #defines above
5104 UINT32 OffsetHigh
:16; ///< Offset bits 31..16
5107 } IA32_IDT_GATE_DESCRIPTOR
;
5111 #if defined (MDE_CPU_X64)
5113 /// Byte packed structure for an x64 Interrupt Gate Descriptor
5117 UINT32 OffsetLow
:16; ///< Offset bits 15..0
5118 UINT32 Selector
:16; ///< Selector
5119 UINT32 Reserved_0
:8; ///< Reserved
5120 UINT32 GateType
:8; ///< Gate Type. See #defines above
5121 UINT32 OffsetHigh
:16; ///< Offset bits 31..16
5122 UINT32 OffsetUpper
:32; ///< Offset bits 63..32
5123 UINT32 Reserved_1
:32; ///< Reserved
5129 } IA32_IDT_GATE_DESCRIPTOR
;
5134 /// Byte packed structure for an FP/SSE/SSE2 context
5141 /// Structures for the 16-bit real mode thunks
5194 IA32_EFLAGS32 EFLAGS
;
5204 } IA32_REGISTER_SET
;
5207 /// Byte packed structure for an 16-bit real mode thunks
5210 IA32_REGISTER_SET
*RealModeState
;
5211 VOID
*RealModeBuffer
;
5212 UINT32 RealModeBufferSize
;
5213 UINT32 ThunkAttributes
;
5216 #define THUNK_ATTRIBUTE_BIG_REAL_MODE 0x00000001
5217 #define THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 0x00000002
5218 #define THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL 0x00000004
5221 Retrieves CPUID information.
5223 Executes the CPUID instruction with EAX set to the value specified by Index.
5224 This function always returns Index.
5225 If Eax is not NULL, then the value of EAX after CPUID is returned in Eax.
5226 If Ebx is not NULL, then the value of EBX after CPUID is returned in Ebx.
5227 If Ecx is not NULL, then the value of ECX after CPUID is returned in Ecx.
5228 If Edx is not NULL, then the value of EDX after CPUID is returned in Edx.
5229 This function is only available on IA-32 and x64.
5231 @param Index The 32-bit value to load into EAX prior to invoking the CPUID
5233 @param Eax Pointer to the 32-bit EAX value returned by the CPUID
5234 instruction. This is an optional parameter that may be NULL.
5235 @param Ebx Pointer to the 32-bit EBX value returned by the CPUID
5236 instruction. This is an optional parameter that may be NULL.
5237 @param Ecx Pointer to the 32-bit ECX value returned by the CPUID
5238 instruction. This is an optional parameter that may be NULL.
5239 @param Edx Pointer to the 32-bit EDX value returned by the CPUID
5240 instruction. This is an optional parameter that may be NULL.
5249 OUT UINT32
*Eax
, OPTIONAL
5250 OUT UINT32
*Ebx
, OPTIONAL
5251 OUT UINT32
*Ecx
, OPTIONAL
5252 OUT UINT32
*Edx OPTIONAL
5257 Retrieves CPUID information using an extended leaf identifier.
5259 Executes the CPUID instruction with EAX set to the value specified by Index
5260 and ECX set to the value specified by SubIndex. This function always returns
5261 Index. This function is only available on IA-32 and x64.
5263 If Eax is not NULL, then the value of EAX after CPUID is returned in Eax.
5264 If Ebx is not NULL, then the value of EBX after CPUID is returned in Ebx.
5265 If Ecx is not NULL, then the value of ECX after CPUID is returned in Ecx.
5266 If Edx is not NULL, then the value of EDX after CPUID is returned in Edx.
5268 @param Index The 32-bit value to load into EAX prior to invoking the
5270 @param SubIndex The 32-bit value to load into ECX prior to invoking the
5272 @param Eax Pointer to the 32-bit EAX value returned by the CPUID
5273 instruction. This is an optional parameter that may be
5275 @param Ebx Pointer to the 32-bit EBX value returned by the CPUID
5276 instruction. This is an optional parameter that may be
5278 @param Ecx Pointer to the 32-bit ECX value returned by the CPUID
5279 instruction. This is an optional parameter that may be
5281 @param Edx Pointer to the 32-bit EDX value returned by the CPUID
5282 instruction. This is an optional parameter that may be
5293 OUT UINT32
*Eax
, OPTIONAL
5294 OUT UINT32
*Ebx
, OPTIONAL
5295 OUT UINT32
*Ecx
, OPTIONAL
5296 OUT UINT32
*Edx OPTIONAL
5301 Set CD bit and clear NW bit of CR0 followed by a WBINVD.
5303 Disables the caches by setting the CD bit of CR0 to 1, clearing the NW bit of CR0 to 0,
5304 and executing a WBINVD instruction. This function is only available on IA-32 and x64.
5315 Perform a WBINVD and clear both the CD and NW bits of CR0.
5317 Enables the caches by executing a WBINVD instruction and then clear both the CD and NW
5318 bits of CR0 to 0. This function is only available on IA-32 and x64.
5329 Returns the lower 32-bits of a Machine Specific Register(MSR).
5331 Reads and returns the lower 32-bits of the MSR specified by Index.
5332 No parameter checking is performed on Index, and some Index values may cause
5333 CPU exceptions. The caller must either guarantee that Index is valid, or the
5334 caller must set up exception handlers to catch the exceptions. This function
5335 is only available on IA-32 and x64.
5337 @param Index The 32-bit MSR index to read.
5339 @return The lower 32 bits of the MSR identified by Index.
5350 Writes a 32-bit value to a Machine Specific Register(MSR), and returns the value.
5351 The upper 32-bits of the MSR are set to zero.
5353 Writes the 32-bit value specified by Value to the MSR specified by Index. The
5354 upper 32-bits of the MSR write are set to zero. The 32-bit value written to
5355 the MSR is returned. No parameter checking is performed on Index or Value,
5356 and some of these may cause CPU exceptions. The caller must either guarantee
5357 that Index and Value are valid, or the caller must establish proper exception
5358 handlers. This function is only available on IA-32 and x64.
5360 @param Index The 32-bit MSR index to write.
5361 @param Value The 32-bit value to write to the MSR.
5375 Reads a 64-bit MSR, performs a bitwise OR on the lower 32-bits, and
5376 writes the result back to the 64-bit MSR.
5378 Reads the 64-bit MSR specified by Index, performs a bitwise OR
5379 between the lower 32-bits of the read result and the value specified by
5380 OrData, and writes the result to the 64-bit MSR specified by Index. The lower
5381 32-bits of the value written to the MSR is returned. No parameter checking is
5382 performed on Index or OrData, and some of these may cause CPU exceptions. The
5383 caller must either guarantee that Index and OrData are valid, or the caller
5384 must establish proper exception handlers. This function is only available on
5387 @param Index The 32-bit MSR index to write.
5388 @param OrData The value to OR with the read value from the MSR.
5390 @return The lower 32-bit value written to the MSR.
5402 Reads a 64-bit MSR, performs a bitwise AND on the lower 32-bits, and writes
5403 the result back to the 64-bit MSR.
5405 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
5406 lower 32-bits of the read result and the value specified by AndData, and
5407 writes the result to the 64-bit MSR specified by Index. The lower 32-bits of
5408 the value written to the MSR is returned. No parameter checking is performed
5409 on Index or AndData, and some of these may cause CPU exceptions. The caller
5410 must either guarantee that Index and AndData are valid, or the caller must
5411 establish proper exception handlers. This function is only available on IA-32
5414 @param Index The 32-bit MSR index to write.
5415 @param AndData The value to AND with the read value from the MSR.
5417 @return The lower 32-bit value written to the MSR.
5429 Reads a 64-bit MSR, performs a bitwise AND followed by a bitwise OR
5430 on the lower 32-bits, and writes the result back to the 64-bit MSR.
5432 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
5433 lower 32-bits of the read result and the value specified by AndData
5434 preserving the upper 32-bits, performs a bitwise OR between the
5435 result of the AND operation and the value specified by OrData, and writes the
5436 result to the 64-bit MSR specified by Address. The lower 32-bits of the value
5437 written to the MSR is returned. No parameter checking is performed on Index,
5438 AndData, or OrData, and some of these may cause CPU exceptions. The caller
5439 must either guarantee that Index, AndData, and OrData are valid, or the
5440 caller must establish proper exception handlers. This function is only
5441 available on IA-32 and x64.
5443 @param Index The 32-bit MSR index to write.
5444 @param AndData The value to AND with the read value from the MSR.
5445 @param OrData The value to OR with the result of the AND operation.
5447 @return The lower 32-bit value written to the MSR.
5460 Reads a bit field of an MSR.
5462 Reads the bit field in the lower 32-bits of a 64-bit MSR. The bit field is
5463 specified by the StartBit and the EndBit. The value of the bit field is
5464 returned. The caller must either guarantee that Index is valid, or the caller
5465 must set up exception handlers to catch the exceptions. This function is only
5466 available on IA-32 and x64.
5468 If StartBit is greater than 31, then ASSERT().
5469 If EndBit is greater than 31, then ASSERT().
5470 If EndBit is less than StartBit, then ASSERT().
5472 @param Index The 32-bit MSR index to read.
5473 @param StartBit The ordinal of the least significant bit in the bit field.
5475 @param EndBit The ordinal of the most significant bit in the bit field.
5478 @return The bit field read from the MSR.
5483 AsmMsrBitFieldRead32 (
5491 Writes a bit field to an MSR.
5493 Writes Value to a bit field in the lower 32-bits of a 64-bit MSR. The bit
5494 field is specified by the StartBit and the EndBit. All other bits in the
5495 destination MSR are preserved. The lower 32-bits of the MSR written is
5496 returned. The caller must either guarantee that Index and the data written
5497 is valid, or the caller must set up exception handlers to catch the exceptions.
5498 This function is only available on IA-32 and x64.
5500 If StartBit is greater than 31, then ASSERT().
5501 If EndBit is greater than 31, then ASSERT().
5502 If EndBit is less than StartBit, then ASSERT().
5504 @param Index The 32-bit MSR index to write.
5505 @param StartBit The ordinal of the least significant bit in the bit field.
5507 @param EndBit The ordinal of the most significant bit in the bit field.
5509 @param Value New value of the bit field.
5511 @return The lower 32-bit of the value written to the MSR.
5516 AsmMsrBitFieldWrite32 (
5525 Reads a bit field in a 64-bit MSR, performs a bitwise OR, and writes the
5526 result back to the bit field in the 64-bit MSR.
5528 Reads the 64-bit MSR specified by Index, performs a bitwise OR
5529 between the read result and the value specified by OrData, and writes the
5530 result to the 64-bit MSR specified by Index. The lower 32-bits of the value
5531 written to the MSR are returned. Extra left bits in OrData are stripped. The
5532 caller must either guarantee that Index and the data written is valid, or
5533 the caller must set up exception handlers to catch the exceptions. This
5534 function is only available on IA-32 and x64.
5536 If StartBit is greater than 31, then ASSERT().
5537 If EndBit is greater than 31, then ASSERT().
5538 If EndBit is less than StartBit, then ASSERT().
5540 @param Index The 32-bit MSR index to write.
5541 @param StartBit The ordinal of the least significant bit in the bit field.
5543 @param EndBit The ordinal of the most significant bit in the bit field.
5545 @param OrData The value to OR with the read value from the MSR.
5547 @return The lower 32-bit of the value written to the MSR.
5552 AsmMsrBitFieldOr32 (
5561 Reads a bit field in a 64-bit MSR, performs a bitwise AND, and writes the
5562 result back to the bit field in the 64-bit MSR.
5564 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
5565 read result and the value specified by AndData, and writes the result to the
5566 64-bit MSR specified by Index. The lower 32-bits of the value written to the
5567 MSR are returned. Extra left bits in AndData are stripped. The caller must
5568 either guarantee that Index and the data written is valid, or the caller must
5569 set up exception handlers to catch the exceptions. This function is only
5570 available on IA-32 and x64.
5572 If StartBit is greater than 31, then ASSERT().
5573 If EndBit is greater than 31, then ASSERT().
5574 If EndBit is less than StartBit, then ASSERT().
5576 @param Index The 32-bit MSR index to write.
5577 @param StartBit The ordinal of the least significant bit in the bit field.
5579 @param EndBit The ordinal of the most significant bit in the bit field.
5581 @param AndData The value to AND with the read value from the MSR.
5583 @return The lower 32-bit of the value written to the MSR.
5588 AsmMsrBitFieldAnd32 (
5597 Reads a bit field in a 64-bit MSR, performs a bitwise AND followed by a
5598 bitwise OR, and writes the result back to the bit field in the
5601 Reads the 64-bit MSR specified by Index, performs a bitwise AND followed by a
5602 bitwise OR between the read result and the value specified by
5603 AndData, and writes the result to the 64-bit MSR specified by Index. The
5604 lower 32-bits of the value written to the MSR are returned. Extra left bits
5605 in both AndData and OrData are stripped. The caller must either guarantee
5606 that Index and the data written is valid, or the caller must set up exception
5607 handlers to catch the exceptions. This function is only available on IA-32
5610 If StartBit is greater than 31, then ASSERT().
5611 If EndBit is greater than 31, then ASSERT().
5612 If EndBit is less than StartBit, then ASSERT().
5614 @param Index The 32-bit MSR index to write.
5615 @param StartBit The ordinal of the least significant bit in the bit field.
5617 @param EndBit The ordinal of the most significant bit in the bit field.
5619 @param AndData The value to AND with the read value from the MSR.
5620 @param OrData The value to OR with the result of the AND operation.
5622 @return The lower 32-bit of the value written to the MSR.
5627 AsmMsrBitFieldAndThenOr32 (
5637 Returns a 64-bit Machine Specific Register(MSR).
5639 Reads and returns the 64-bit MSR specified by Index. No parameter checking is
5640 performed on Index, and some Index values may cause CPU exceptions. The
5641 caller must either guarantee that Index is valid, or the caller must set up
5642 exception handlers to catch the exceptions. This function is only available
5645 @param Index The 32-bit MSR index to read.
5647 @return The value of the MSR identified by Index.
5658 Writes a 64-bit value to a Machine Specific Register(MSR), and returns the
5661 Writes the 64-bit value specified by Value to the MSR specified by Index. The
5662 64-bit value written to the MSR is returned. No parameter checking is
5663 performed on Index or Value, and some of these may cause CPU exceptions. The
5664 caller must either guarantee that Index and Value are valid, or the caller
5665 must establish proper exception handlers. This function is only available on
5668 @param Index The 32-bit MSR index to write.
5669 @param Value The 64-bit value to write to the MSR.
5683 Reads a 64-bit MSR, performs a bitwise OR, and writes the result
5684 back to the 64-bit MSR.
5686 Reads the 64-bit MSR specified by Index, performs a bitwise OR
5687 between the read result and the value specified by OrData, and writes the
5688 result to the 64-bit MSR specified by Index. The value written to the MSR is
5689 returned. No parameter checking is performed on Index or OrData, and some of
5690 these may cause CPU exceptions. The caller must either guarantee that Index
5691 and OrData are valid, or the caller must establish proper exception handlers.
5692 This function is only available on IA-32 and x64.
5694 @param Index The 32-bit MSR index to write.
5695 @param OrData The value to OR with the read value from the MSR.
5697 @return The value written back to the MSR.
5709 Reads a 64-bit MSR, performs a bitwise AND, and writes the result back to the
5712 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
5713 read result and the value specified by OrData, and writes the result to the
5714 64-bit MSR specified by Index. The value written to the MSR is returned. No
5715 parameter checking is performed on Index or OrData, and some of these may
5716 cause CPU exceptions. The caller must either guarantee that Index and OrData
5717 are valid, or the caller must establish proper exception handlers. This
5718 function is only available on IA-32 and x64.
5720 @param Index The 32-bit MSR index to write.
5721 @param AndData The value to AND with the read value from the MSR.
5723 @return The value written back to the MSR.
5735 Reads a 64-bit MSR, performs a bitwise AND followed by a bitwise
5736 OR, and writes the result back to the 64-bit MSR.
5738 Reads the 64-bit MSR specified by Index, performs a bitwise AND between read
5739 result and the value specified by AndData, performs a bitwise OR
5740 between the result of the AND operation and the value specified by OrData,
5741 and writes the result to the 64-bit MSR specified by Index. The value written
5742 to the MSR is returned. No parameter checking is performed on Index, AndData,
5743 or OrData, and some of these may cause CPU exceptions. The caller must either
5744 guarantee that Index, AndData, and OrData are valid, or the caller must
5745 establish proper exception handlers. This function is only available on IA-32
5748 @param Index The 32-bit MSR index to write.
5749 @param AndData The value to AND with the read value from the MSR.
5750 @param OrData The value to OR with the result of the AND operation.
5752 @return The value written back to the MSR.
5765 Reads a bit field of an MSR.
5767 Reads the bit field in the 64-bit MSR. The bit field is specified by the
5768 StartBit and the EndBit. The value of the bit field is returned. The caller
5769 must either guarantee that Index is valid, or the caller must set up
5770 exception handlers to catch the exceptions. This function is only available
5773 If StartBit is greater than 63, then ASSERT().
5774 If EndBit is greater than 63, then ASSERT().
5775 If EndBit is less than StartBit, then ASSERT().
5777 @param Index The 32-bit MSR index to read.
5778 @param StartBit The ordinal of the least significant bit in the bit field.
5780 @param EndBit The ordinal of the most significant bit in the bit field.
5783 @return The value read from the MSR.
5788 AsmMsrBitFieldRead64 (
5796 Writes a bit field to an MSR.
5798 Writes Value to a bit field in a 64-bit MSR. The bit field is specified by
5799 the StartBit and the EndBit. All other bits in the destination MSR are
5800 preserved. The MSR written is returned. The caller must either guarantee
5801 that Index and the data written is valid, or the caller must set up exception
5802 handlers to catch the exceptions. This function is only available on IA-32 and x64.
5804 If StartBit is greater than 63, then ASSERT().
5805 If EndBit is greater than 63, then ASSERT().
5806 If EndBit is less than StartBit, then ASSERT().
5808 @param Index The 32-bit MSR index to write.
5809 @param StartBit The ordinal of the least significant bit in the bit field.
5811 @param EndBit The ordinal of the most significant bit in the bit field.
5813 @param Value New value of the bit field.
5815 @return The value written back to the MSR.
5820 AsmMsrBitFieldWrite64 (
5829 Reads a bit field in a 64-bit MSR, performs a bitwise OR, and
5830 writes the result back to the bit field in the 64-bit MSR.
5832 Reads the 64-bit MSR specified by Index, performs a bitwise OR
5833 between the read result and the value specified by OrData, and writes the
5834 result to the 64-bit MSR specified by Index. The value written to the MSR is
5835 returned. Extra left bits in OrData are stripped. The caller must either
5836 guarantee that Index and the data written is valid, or the caller must set up
5837 exception handlers to catch the exceptions. This function is only available
5840 If StartBit is greater than 63, then ASSERT().
5841 If EndBit is greater than 63, then ASSERT().
5842 If EndBit is less than StartBit, then ASSERT().
5844 @param Index The 32-bit MSR index to write.
5845 @param StartBit The ordinal of the least significant bit in the bit field.
5847 @param EndBit The ordinal of the most significant bit in the bit field.
5849 @param OrData The value to OR with the read value from the bit field.
5851 @return The value written back to the MSR.
5856 AsmMsrBitFieldOr64 (
5865 Reads a bit field in a 64-bit MSR, performs a bitwise AND, and writes the
5866 result back to the bit field in the 64-bit MSR.
5868 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
5869 read result and the value specified by AndData, and writes the result to the
5870 64-bit MSR specified by Index. The value written to the MSR is returned.
5871 Extra left bits in AndData are stripped. The caller must either guarantee
5872 that Index and the data written is valid, or the caller must set up exception
5873 handlers to catch the exceptions. This function is only available on IA-32
5876 If StartBit is greater than 63, then ASSERT().
5877 If EndBit is greater than 63, then ASSERT().
5878 If EndBit is less than StartBit, then ASSERT().
5880 @param Index The 32-bit MSR index to write.
5881 @param StartBit The ordinal of the least significant bit in the bit field.
5883 @param EndBit The ordinal of the most significant bit in the bit field.
5885 @param AndData The value to AND with the read value from the bit field.
5887 @return The value written back to the MSR.
5892 AsmMsrBitFieldAnd64 (
5901 Reads a bit field in a 64-bit MSR, performs a bitwise AND followed by a
5902 bitwise OR, and writes the result back to the bit field in the
5905 Reads the 64-bit MSR specified by Index, performs a bitwise AND followed by
5906 a bitwise OR between the read result and the value specified by
5907 AndData, and writes the result to the 64-bit MSR specified by Index. The
5908 value written to the MSR is returned. Extra left bits in both AndData and
5909 OrData are stripped. The caller must either guarantee that Index and the data
5910 written is valid, or the caller must set up exception handlers to catch the
5911 exceptions. This function is only available on IA-32 and x64.
5913 If StartBit is greater than 63, then ASSERT().
5914 If EndBit is greater than 63, then ASSERT().
5915 If EndBit is less than StartBit, then ASSERT().
5917 @param Index The 32-bit MSR index to write.
5918 @param StartBit The ordinal of the least significant bit in the bit field.
5920 @param EndBit The ordinal of the most significant bit in the bit field.
5922 @param AndData The value to AND with the read value from the bit field.
5923 @param OrData The value to OR with the result of the AND operation.
5925 @return The value written back to the MSR.
5930 AsmMsrBitFieldAndThenOr64 (
5940 Reads the current value of the EFLAGS register.
5942 Reads and returns the current value of the EFLAGS register. This function is
5943 only available on IA-32 and x64. This returns a 32-bit value on IA-32 and a
5944 64-bit value on x64.
5946 @return EFLAGS on IA-32 or RFLAGS on x64.
5957 Reads the current value of the Control Register 0 (CR0).
5959 Reads and returns the current value of CR0. This function is only available
5960 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
5963 @return The value of the Control Register 0 (CR0).
5974 Reads the current value of the Control Register 2 (CR2).
5976 Reads and returns the current value of CR2. This function is only available
5977 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
5980 @return The value of the Control Register 2 (CR2).
5991 Reads the current value of the Control Register 3 (CR3).
5993 Reads and returns the current value of CR3. This function is only available
5994 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
5997 @return The value of the Control Register 3 (CR3).
6008 Reads the current value of the Control Register 4 (CR4).
6010 Reads and returns the current value of CR4. This function is only available
6011 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
6014 @return The value of the Control Register 4 (CR4).
6025 Writes a value to Control Register 0 (CR0).
6027 Writes and returns a new value to CR0. This function is only available on
6028 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
6030 @param Cr0 The value to write to CR0.
6032 @return The value written to CR0.
6043 Writes a value to Control Register 2 (CR2).
6045 Writes and returns a new value to CR2. This function is only available on
6046 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
6048 @param Cr2 The value to write to CR2.
6050 @return The value written to CR2.
6061 Writes a value to Control Register 3 (CR3).
6063 Writes and returns a new value to CR3. This function is only available on
6064 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
6066 @param Cr3 The value to write to CR3.
6068 @return The value written to CR3.
6079 Writes a value to Control Register 4 (CR4).
6081 Writes and returns a new value to CR4. This function is only available on
6082 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
6084 @param Cr4 The value to write to CR4.
6086 @return The value written to CR4.
6097 Reads the current value of Debug Register 0 (DR0).
6099 Reads and returns the current value of DR0. This function is only available
6100 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
6103 @return The value of Debug Register 0 (DR0).
6114 Reads the current value of Debug Register 1 (DR1).
6116 Reads and returns the current value of DR1. This function is only available
6117 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
6120 @return The value of Debug Register 1 (DR1).
6131 Reads the current value of Debug Register 2 (DR2).
6133 Reads and returns the current value of DR2. This function is only available
6134 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
6137 @return The value of Debug Register 2 (DR2).
6148 Reads the current value of Debug Register 3 (DR3).
6150 Reads and returns the current value of DR3. This function is only available
6151 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
6154 @return The value of Debug Register 3 (DR3).
6165 Reads the current value of Debug Register 4 (DR4).
6167 Reads and returns the current value of DR4. This function is only available
6168 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
6171 @return The value of Debug Register 4 (DR4).
6182 Reads the current value of Debug Register 5 (DR5).
6184 Reads and returns the current value of DR5. This function is only available
6185 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
6188 @return The value of Debug Register 5 (DR5).
6199 Reads the current value of Debug Register 6 (DR6).
6201 Reads and returns the current value of DR6. This function is only available
6202 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
6205 @return The value of Debug Register 6 (DR6).
6216 Reads the current value of Debug Register 7 (DR7).
6218 Reads and returns the current value of DR7. This function is only available
6219 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
6222 @return The value of Debug Register 7 (DR7).
6233 Writes a value to Debug Register 0 (DR0).
6235 Writes and returns a new value to DR0. This function is only available on
6236 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
6238 @param Dr0 The value to write to Dr0.
6240 @return The value written to Debug Register 0 (DR0).
6251 Writes a value to Debug Register 1 (DR1).
6253 Writes and returns a new value to DR1. This function is only available on
6254 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
6256 @param Dr1 The value to write to Dr1.
6258 @return The value written to Debug Register 1 (DR1).
6269 Writes a value to Debug Register 2 (DR2).
6271 Writes and returns a new value to DR2. This function is only available on
6272 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
6274 @param Dr2 The value to write to Dr2.
6276 @return The value written to Debug Register 2 (DR2).
6287 Writes a value to Debug Register 3 (DR3).
6289 Writes and returns a new value to DR3. This function is only available on
6290 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
6292 @param Dr3 The value to write to Dr3.
6294 @return The value written to Debug Register 3 (DR3).
6305 Writes a value to Debug Register 4 (DR4).
6307 Writes and returns a new value to DR4. This function is only available on
6308 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
6310 @param Dr4 The value to write to Dr4.
6312 @return The value written to Debug Register 4 (DR4).
6323 Writes a value to Debug Register 5 (DR5).
6325 Writes and returns a new value to DR5. This function is only available on
6326 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
6328 @param Dr5 The value to write to Dr5.
6330 @return The value written to Debug Register 5 (DR5).
6341 Writes a value to Debug Register 6 (DR6).
6343 Writes and returns a new value to DR6. This function is only available on
6344 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
6346 @param Dr6 The value to write to Dr6.
6348 @return The value written to Debug Register 6 (DR6).
6359 Writes a value to Debug Register 7 (DR7).
6361 Writes and returns a new value to DR7. This function is only available on
6362 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
6364 @param Dr7 The value to write to Dr7.
6366 @return The value written to Debug Register 7 (DR7).
6377 Reads the current value of Code Segment Register (CS).
6379 Reads and returns the current value of CS. This function is only available on
6382 @return The current value of CS.
6393 Reads the current value of Data Segment Register (DS).
6395 Reads and returns the current value of DS. This function is only available on
6398 @return The current value of DS.
6409 Reads the current value of Extra Segment Register (ES).
6411 Reads and returns the current value of ES. This function is only available on
6414 @return The current value of ES.
6425 Reads the current value of FS Data Segment Register (FS).
6427 Reads and returns the current value of FS. This function is only available on
6430 @return The current value of FS.
6441 Reads the current value of GS Data Segment Register (GS).
6443 Reads and returns the current value of GS. This function is only available on
6446 @return The current value of GS.
6457 Reads the current value of Stack Segment Register (SS).
6459 Reads and returns the current value of SS. This function is only available on
6462 @return The current value of SS.
6473 Reads the current value of Task Register (TR).
6475 Reads and returns the current value of TR. This function is only available on
6478 @return The current value of TR.
6489 Reads the current Global Descriptor Table Register(GDTR) descriptor.
6491 Reads and returns the current GDTR descriptor and returns it in Gdtr. This
6492 function is only available on IA-32 and x64.
6494 If Gdtr is NULL, then ASSERT().
6496 @param Gdtr Pointer to a GDTR descriptor.
6502 OUT IA32_DESCRIPTOR
*Gdtr
6507 Writes the current Global Descriptor Table Register (GDTR) descriptor.
6509 Writes and the current GDTR descriptor specified by Gdtr. This function is
6510 only available on IA-32 and x64.
6512 If Gdtr is NULL, then ASSERT().
6514 @param Gdtr Pointer to a GDTR descriptor.
6520 IN CONST IA32_DESCRIPTOR
*Gdtr
6525 Reads the current Interrupt Descriptor Table Register(IDTR) descriptor.
6527 Reads and returns the current IDTR descriptor and returns it in Idtr. This
6528 function is only available on IA-32 and x64.
6530 If Idtr is NULL, then ASSERT().
6532 @param Idtr Pointer to a IDTR descriptor.
6538 OUT IA32_DESCRIPTOR
*Idtr
6543 Writes the current Interrupt Descriptor Table Register(IDTR) descriptor.
6545 Writes the current IDTR descriptor and returns it in Idtr. This function is
6546 only available on IA-32 and x64.
6548 If Idtr is NULL, then ASSERT().
6550 @param Idtr Pointer to a IDTR descriptor.
6556 IN CONST IA32_DESCRIPTOR
*Idtr
6561 Reads the current Local Descriptor Table Register(LDTR) selector.
6563 Reads and returns the current 16-bit LDTR descriptor value. This function is
6564 only available on IA-32 and x64.
6566 @return The current selector of LDT.
6577 Writes the current Local Descriptor Table Register (LDTR) selector.
6579 Writes and the current LDTR descriptor specified by Ldtr. This function is
6580 only available on IA-32 and x64.
6582 @param Ldtr 16-bit LDTR selector value.
6593 Save the current floating point/SSE/SSE2 context to a buffer.
6595 Saves the current floating point/SSE/SSE2 state to the buffer specified by
6596 Buffer. Buffer must be aligned on a 16-byte boundary. This function is only
6597 available on IA-32 and x64.
6599 If Buffer is NULL, then ASSERT().
6600 If Buffer is not aligned on a 16-byte boundary, then ASSERT().
6602 @param Buffer Pointer to a buffer to save the floating point/SSE/SSE2 context.
6608 OUT IA32_FX_BUFFER
*Buffer
6613 Restores the current floating point/SSE/SSE2 context from a buffer.
6615 Restores the current floating point/SSE/SSE2 state from the buffer specified
6616 by Buffer. Buffer must be aligned on a 16-byte boundary. This function is
6617 only available on IA-32 and x64.
6619 If Buffer is NULL, then ASSERT().
6620 If Buffer is not aligned on a 16-byte boundary, then ASSERT().
6621 If Buffer was not saved with AsmFxSave(), then ASSERT().
6623 @param Buffer Pointer to a buffer to save the floating point/SSE/SSE2 context.
6629 IN CONST IA32_FX_BUFFER
*Buffer
6634 Reads the current value of 64-bit MMX Register #0 (MM0).
6636 Reads and returns the current value of MM0. This function is only available
6639 @return The current value of MM0.
6650 Reads the current value of 64-bit MMX Register #1 (MM1).
6652 Reads and returns the current value of MM1. This function is only available
6655 @return The current value of MM1.
6666 Reads the current value of 64-bit MMX Register #2 (MM2).
6668 Reads and returns the current value of MM2. This function is only available
6671 @return The current value of MM2.
6682 Reads the current value of 64-bit MMX Register #3 (MM3).
6684 Reads and returns the current value of MM3. This function is only available
6687 @return The current value of MM3.
6698 Reads the current value of 64-bit MMX Register #4 (MM4).
6700 Reads and returns the current value of MM4. This function is only available
6703 @return The current value of MM4.
6714 Reads the current value of 64-bit MMX Register #5 (MM5).
6716 Reads and returns the current value of MM5. This function is only available
6719 @return The current value of MM5.
6730 Reads the current value of 64-bit MMX Register #6 (MM6).
6732 Reads and returns the current value of MM6. This function is only available
6735 @return The current value of MM6.
6746 Reads the current value of 64-bit MMX Register #7 (MM7).
6748 Reads and returns the current value of MM7. This function is only available
6751 @return The current value of MM7.
6762 Writes the current value of 64-bit MMX Register #0 (MM0).
6764 Writes the current value of MM0. This function is only available on IA32 and
6767 @param Value The 64-bit value to write to MM0.
6778 Writes the current value of 64-bit MMX Register #1 (MM1).
6780 Writes the current value of MM1. This function is only available on IA32 and
6783 @param Value The 64-bit value to write to MM1.
6794 Writes the current value of 64-bit MMX Register #2 (MM2).
6796 Writes the current value of MM2. This function is only available on IA32 and
6799 @param Value The 64-bit value to write to MM2.
6810 Writes the current value of 64-bit MMX Register #3 (MM3).
6812 Writes the current value of MM3. This function is only available on IA32 and
6815 @param Value The 64-bit value to write to MM3.
6826 Writes the current value of 64-bit MMX Register #4 (MM4).
6828 Writes the current value of MM4. This function is only available on IA32 and
6831 @param Value The 64-bit value to write to MM4.
6842 Writes the current value of 64-bit MMX Register #5 (MM5).
6844 Writes the current value of MM5. This function is only available on IA32 and
6847 @param Value The 64-bit value to write to MM5.
6858 Writes the current value of 64-bit MMX Register #6 (MM6).
6860 Writes the current value of MM6. This function is only available on IA32 and
6863 @param Value The 64-bit value to write to MM6.
6874 Writes the current value of 64-bit MMX Register #7 (MM7).
6876 Writes the current value of MM7. This function is only available on IA32 and
6879 @param Value The 64-bit value to write to MM7.
6890 Reads the current value of Time Stamp Counter (TSC).
6892 Reads and returns the current value of TSC. This function is only available
6895 @return The current value of TSC
6906 Reads the current value of a Performance Counter (PMC).
6908 Reads and returns the current value of performance counter specified by
6909 Index. This function is only available on IA-32 and x64.
6911 @param Index The 32-bit Performance Counter index to read.
6913 @return The value of the PMC specified by Index.
6924 Sets up a monitor buffer that is used by AsmMwait().
6926 Executes a MONITOR instruction with the register state specified by Eax, Ecx
6927 and Edx. Returns Eax. This function is only available on IA-32 and x64.
6929 @param Eax The value to load into EAX or RAX before executing the MONITOR
6931 @param Ecx The value to load into ECX or RCX before executing the MONITOR
6933 @param Edx The value to load into EDX or RDX before executing the MONITOR
6949 Executes an MWAIT instruction.
6951 Executes an MWAIT instruction with the register state specified by Eax and
6952 Ecx. Returns Eax. This function is only available on IA-32 and x64.
6954 @param Eax The value to load into EAX or RAX before executing the MONITOR
6956 @param Ecx The value to load into ECX or RCX before executing the MONITOR
6971 Executes a WBINVD instruction.
6973 Executes a WBINVD instruction. This function is only available on IA-32 and
6985 Executes a INVD instruction.
6987 Executes a INVD instruction. This function is only available on IA-32 and
6999 Flushes a cache line from all the instruction and data caches within the
7000 coherency domain of the CPU.
7002 Flushed the cache line specified by LinearAddress, and returns LinearAddress.
7003 This function is only available on IA-32 and x64.
7005 @param LinearAddress The address of the cache line to flush. If the CPU is
7006 in a physical addressing mode, then LinearAddress is a
7007 physical address. If the CPU is in a virtual
7008 addressing mode, then LinearAddress is a virtual
7011 @return LinearAddress
7016 IN VOID
*LinearAddress
7021 Enables the 32-bit paging mode on the CPU.
7023 Enables the 32-bit paging mode on the CPU. CR0, CR3, CR4, and the page tables
7024 must be properly initialized prior to calling this service. This function
7025 assumes the current execution mode is 32-bit protected mode. This function is
7026 only available on IA-32. After the 32-bit paging mode is enabled, control is
7027 transferred to the function specified by EntryPoint using the new stack
7028 specified by NewStack and passing in the parameters specified by Context1 and
7029 Context2. Context1 and Context2 are optional and may be NULL. The function
7030 EntryPoint must never return.
7032 If the current execution mode is not 32-bit protected mode, then ASSERT().
7033 If EntryPoint is NULL, then ASSERT().
7034 If NewStack is NULL, then ASSERT().
7036 There are a number of constraints that must be followed before calling this
7038 1) Interrupts must be disabled.
7039 2) The caller must be in 32-bit protected mode with flat descriptors. This
7040 means all descriptors must have a base of 0 and a limit of 4GB.
7041 3) CR0 and CR4 must be compatible with 32-bit protected mode with flat
7043 4) CR3 must point to valid page tables that will be used once the transition
7044 is complete, and those page tables must guarantee that the pages for this
7045 function and the stack are identity mapped.
7047 @param EntryPoint A pointer to function to call with the new stack after
7049 @param Context1 A pointer to the context to pass into the EntryPoint
7050 function as the first parameter after paging is enabled.
7051 @param Context2 A pointer to the context to pass into the EntryPoint
7052 function as the second parameter after paging is enabled.
7053 @param NewStack A pointer to the new stack to use for the EntryPoint
7054 function after paging is enabled.
7060 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
7061 IN VOID
*Context1
, OPTIONAL
7062 IN VOID
*Context2
, OPTIONAL
7068 Disables the 32-bit paging mode on the CPU.
7070 Disables the 32-bit paging mode on the CPU and returns to 32-bit protected
7071 mode. This function assumes the current execution mode is 32-paged protected
7072 mode. This function is only available on IA-32. After the 32-bit paging mode
7073 is disabled, control is transferred to the function specified by EntryPoint
7074 using the new stack specified by NewStack and passing in the parameters
7075 specified by Context1 and Context2. Context1 and Context2 are optional and
7076 may be NULL. The function EntryPoint must never return.
7078 If the current execution mode is not 32-bit paged mode, then ASSERT().
7079 If EntryPoint is NULL, then ASSERT().
7080 If NewStack is NULL, then ASSERT().
7082 There are a number of constraints that must be followed before calling this
7084 1) Interrupts must be disabled.
7085 2) The caller must be in 32-bit paged mode.
7086 3) CR0, CR3, and CR4 must be compatible with 32-bit paged mode.
7087 4) CR3 must point to valid page tables that guarantee that the pages for
7088 this function and the stack are identity mapped.
7090 @param EntryPoint A pointer to function to call with the new stack after
7092 @param Context1 A pointer to the context to pass into the EntryPoint
7093 function as the first parameter after paging is disabled.
7094 @param Context2 A pointer to the context to pass into the EntryPoint
7095 function as the second parameter after paging is
7097 @param NewStack A pointer to the new stack to use for the EntryPoint
7098 function after paging is disabled.
7103 AsmDisablePaging32 (
7104 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
7105 IN VOID
*Context1
, OPTIONAL
7106 IN VOID
*Context2
, OPTIONAL
7112 Enables the 64-bit paging mode on the CPU.
7114 Enables the 64-bit paging mode on the CPU. CR0, CR3, CR4, and the page tables
7115 must be properly initialized prior to calling this service. This function
7116 assumes the current execution mode is 32-bit protected mode with flat
7117 descriptors. This function is only available on IA-32. After the 64-bit
7118 paging mode is enabled, control is transferred to the function specified by
7119 EntryPoint using the new stack specified by NewStack and passing in the
7120 parameters specified by Context1 and Context2. Context1 and Context2 are
7121 optional and may be 0. The function EntryPoint must never return.
7123 If the current execution mode is not 32-bit protected mode with flat
7124 descriptors, then ASSERT().
7125 If EntryPoint is 0, then ASSERT().
7126 If NewStack is 0, then ASSERT().
7128 @param Cs The 16-bit selector to load in the CS before EntryPoint
7129 is called. The descriptor in the GDT that this selector
7130 references must be setup for long mode.
7131 @param EntryPoint The 64-bit virtual address of the function to call with
7132 the new stack after paging is enabled.
7133 @param Context1 The 64-bit virtual address of the context to pass into
7134 the EntryPoint function as the first parameter after
7136 @param Context2 The 64-bit virtual address of the context to pass into
7137 the EntryPoint function as the second parameter after
7139 @param NewStack The 64-bit virtual address of the new stack to use for
7140 the EntryPoint function after paging is enabled.
7147 IN UINT64 EntryPoint
,
7148 IN UINT64 Context1
, OPTIONAL
7149 IN UINT64 Context2
, OPTIONAL
7155 Disables the 64-bit paging mode on the CPU.
7157 Disables the 64-bit paging mode on the CPU and returns to 32-bit protected
7158 mode. This function assumes the current execution mode is 64-paging mode.
7159 This function is only available on x64. After the 64-bit paging mode is
7160 disabled, control is transferred to the function specified by EntryPoint
7161 using the new stack specified by NewStack and passing in the parameters
7162 specified by Context1 and Context2. Context1 and Context2 are optional and
7163 may be 0. The function EntryPoint must never return.
7165 If the current execution mode is not 64-bit paged mode, then ASSERT().
7166 If EntryPoint is 0, then ASSERT().
7167 If NewStack is 0, then ASSERT().
7169 @param Cs The 16-bit selector to load in the CS before EntryPoint
7170 is called. The descriptor in the GDT that this selector
7171 references must be setup for 32-bit protected mode.
7172 @param EntryPoint The 64-bit virtual address of the function to call with
7173 the new stack after paging is disabled.
7174 @param Context1 The 64-bit virtual address of the context to pass into
7175 the EntryPoint function as the first parameter after
7177 @param Context2 The 64-bit virtual address of the context to pass into
7178 the EntryPoint function as the second parameter after
7180 @param NewStack The 64-bit virtual address of the new stack to use for
7181 the EntryPoint function after paging is disabled.
7186 AsmDisablePaging64 (
7188 IN UINT32 EntryPoint
,
7189 IN UINT32 Context1
, OPTIONAL
7190 IN UINT32 Context2
, OPTIONAL
7196 // 16-bit thunking services
7200 Retrieves the properties for 16-bit thunk functions.
7202 Computes the size of the buffer and stack below 1MB required to use the
7203 AsmPrepareThunk16(), AsmThunk16() and AsmPrepareAndThunk16() functions. This
7204 buffer size is returned in RealModeBufferSize, and the stack size is returned
7205 in ExtraStackSize. If parameters are passed to the 16-bit real mode code,
7206 then the actual minimum stack size is ExtraStackSize plus the maximum number
7207 of bytes that need to be passed to the 16-bit real mode code.
7209 If RealModeBufferSize is NULL, then ASSERT().
7210 If ExtraStackSize is NULL, then ASSERT().
7212 @param RealModeBufferSize A pointer to the size of the buffer below 1MB
7213 required to use the 16-bit thunk functions.
7214 @param ExtraStackSize A pointer to the extra size of stack below 1MB
7215 that the 16-bit thunk functions require for
7216 temporary storage in the transition to and from
7222 AsmGetThunk16Properties (
7223 OUT UINT32
*RealModeBufferSize
,
7224 OUT UINT32
*ExtraStackSize
7229 Prepares all structures a code required to use AsmThunk16().
7231 Prepares all structures and code required to use AsmThunk16().
7233 If ThunkContext is NULL, then ASSERT().
7235 @param ThunkContext A pointer to the context structure that describes the
7236 16-bit real mode code to call.
7242 OUT THUNK_CONTEXT
*ThunkContext
7247 Transfers control to a 16-bit real mode entry point and returns the results.
7249 Transfers control to a 16-bit real mode entry point and returns the results.
7250 AsmPrepareThunk16() must be called with ThunkContext before this function is used.
7251 This function must be called with interrupts disabled.
7253 The register state from the RealModeState field of ThunkContext is restored just prior
7254 to calling the 16-bit real mode entry point. This includes the EFLAGS field of RealModeState,
7255 which is used to set the interrupt state when a 16-bit real mode entry point is called.
7256 Control is transferred to the 16-bit real mode entry point specified by the CS and Eip fields of RealModeState.
7257 The stack is initialized to the SS and ESP fields of RealModeState. Any parameters passed to
7258 the 16-bit real mode code must be populated by the caller at SS:ESP prior to calling this function.
7259 The 16-bit real mode entry point is invoked with a 16-bit CALL FAR instruction,
7260 so when accessing stack contents, the 16-bit real mode code must account for the 16-bit segment
7261 and 16-bit offset of the return address that were pushed onto the stack. The 16-bit real mode entry
7262 point must exit with a RETF instruction. The register state is captured into RealModeState immediately
7263 after the RETF instruction is executed.
7265 If EFLAGS specifies interrupts enabled, or any of the 16-bit real mode code enables interrupts,
7266 or any of the 16-bit real mode code makes a SW interrupt, then the caller is responsible for making sure
7267 the IDT at address 0 is initialized to handle any HW or SW interrupts that may occur while in 16-bit real mode.
7269 If EFLAGS specifies interrupts enabled, or any of the 16-bit real mode code enables interrupts,
7270 then the caller is responsible for making sure the 8259 PIC is in a state compatible with 16-bit real mode.
7271 This includes the base vectors, the interrupt masks, and the edge/level trigger mode.
7273 If THUNK_ATTRIBUTE_BIG_REAL_MODE is set in the ThunkAttributes field of ThunkContext, then the user code
7274 is invoked in big real mode. Otherwise, the user code is invoked in 16-bit real mode with 64KB segment limits.
7276 If neither THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 nor THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL are set in
7277 ThunkAttributes, then it is assumed that the user code did not enable the A20 mask, and no attempt is made to
7278 disable the A20 mask.
7280 If THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 is set and THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL is clear in
7281 ThunkAttributes, then attempt to use the INT 15 service to disable the A20 mask. If this INT 15 call fails,
7282 then attempt to disable the A20 mask by directly accessing the 8042 keyboard controller I/O ports.
7284 If THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 is clear and THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL is set in
7285 ThunkAttributes, then attempt to disable the A20 mask by directly accessing the 8042 keyboard controller I/O ports.
7287 If ThunkContext is NULL, then ASSERT().
7288 If AsmPrepareThunk16() was not previously called with ThunkContext, then ASSERT().
7289 If both THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 and THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL are set in
7290 ThunkAttributes, then ASSERT().
7292 @param ThunkContext A pointer to the context structure that describes the
7293 16-bit real mode code to call.
7299 IN OUT THUNK_CONTEXT
*ThunkContext
7304 Prepares all structures and code for a 16-bit real mode thunk, transfers
7305 control to a 16-bit real mode entry point, and returns the results.
7307 Prepares all structures and code for a 16-bit real mode thunk, transfers
7308 control to a 16-bit real mode entry point, and returns the results. If the
7309 caller only need to perform a single 16-bit real mode thunk, then this
7310 service should be used. If the caller intends to make more than one 16-bit
7311 real mode thunk, then it is more efficient if AsmPrepareThunk16() is called
7312 once and AsmThunk16() can be called for each 16-bit real mode thunk.
7314 See AsmPrepareThunk16() and AsmThunk16() for the detailed description and ASSERT() conditions.
7316 @param ThunkContext A pointer to the context structure that describes the
7317 16-bit real mode code to call.
7322 AsmPrepareAndThunk16 (
7323 IN OUT THUNK_CONTEXT
*ThunkContext