2 Provides string functions, linked list functions, math functions, synchronization
3 functions, and CPU architecture specific functions.
5 Copyright (c) 2006 - 2008, Intel Corporation
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 Operand A 16-bit unsigned value.
1820 @return The byte swapped Operand.
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 Operand A 32-bit unsigned value.
1839 @return The byte swapped Operand.
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 Operand A 64-bit unsigned value.
1858 @return The byte swapped Operand.
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 If the result overflows, then ASSERT().
1900 @param Multiplicand A 64-bit unsigned value.
1901 @param Multiplier A 64-bit unsigned value.
1903 @return Multiplicand * Multiplier
1909 IN UINT64 Multiplicand
,
1910 IN UINT64 Multiplier
1915 Multiples a 64-bit signed integer by a 64-bit signed integer and generates a
1916 64-bit signed result.
1918 This function multiples the 64-bit signed value Multiplicand by the 64-bit
1919 signed value Multiplier and generates a 64-bit signed result. This 64-bit
1920 signed result is returned.
1922 @param Multiplicand A 64-bit signed value.
1923 @param Multiplier A 64-bit signed value.
1925 @return Multiplicand * Multiplier
1931 IN INT64 Multiplicand
,
1937 Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates
1938 a 64-bit unsigned result.
1940 This function divides the 64-bit unsigned value Dividend by the 32-bit
1941 unsigned value Divisor and generates a 64-bit unsigned quotient. This
1942 function returns the 64-bit unsigned quotient.
1944 If Divisor is 0, then ASSERT().
1946 @param Dividend A 64-bit unsigned value.
1947 @param Divisor A 32-bit unsigned value.
1949 @return Dividend / Divisor
1961 Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates
1962 a 32-bit unsigned remainder.
1964 This function divides the 64-bit unsigned value Dividend by the 32-bit
1965 unsigned value Divisor and generates a 32-bit remainder. This function
1966 returns the 32-bit unsigned remainder.
1968 If Divisor is 0, then ASSERT().
1970 @param Dividend A 64-bit unsigned value.
1971 @param Divisor A 32-bit unsigned value.
1973 @return Dividend % Divisor
1985 Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates
1986 a 64-bit unsigned result and an optional 32-bit unsigned remainder.
1988 This function divides the 64-bit unsigned value Dividend by the 32-bit
1989 unsigned value Divisor and generates a 64-bit unsigned quotient. If Remainder
1990 is not NULL, then the 32-bit unsigned remainder is returned in Remainder.
1991 This function returns the 64-bit unsigned quotient.
1993 If Divisor is 0, then ASSERT().
1995 @param Dividend A 64-bit unsigned value.
1996 @param Divisor A 32-bit unsigned value.
1997 @param Remainder A pointer to a 32-bit unsigned value. This parameter is
1998 optional and may be NULL.
2000 @return Dividend / Divisor
2005 DivU64x32Remainder (
2008 OUT UINT32
*Remainder OPTIONAL
2013 Divides a 64-bit unsigned integer by a 64-bit unsigned integer and generates
2014 a 64-bit unsigned result and an optional 64-bit unsigned remainder.
2016 This function divides the 64-bit unsigned value Dividend by the 64-bit
2017 unsigned value Divisor and generates a 64-bit unsigned quotient. If Remainder
2018 is not NULL, then the 64-bit unsigned remainder is returned in Remainder.
2019 This function returns the 64-bit unsigned quotient.
2021 If Divisor is 0, then ASSERT().
2023 @param Dividend A 64-bit unsigned value.
2024 @param Divisor A 64-bit unsigned value.
2025 @param Remainder A pointer to a 64-bit unsigned value. This parameter is
2026 optional and may be NULL.
2028 @return Dividend / Divisor
2033 DivU64x64Remainder (
2036 OUT UINT64
*Remainder OPTIONAL
2041 Divides a 64-bit signed integer by a 64-bit signed integer and generates a
2042 64-bit signed result and a optional 64-bit signed remainder.
2044 This function divides the 64-bit signed value Dividend by the 64-bit signed
2045 value Divisor and generates a 64-bit signed quotient. If Remainder is not
2046 NULL, then the 64-bit signed remainder is returned in Remainder. This
2047 function returns the 64-bit signed quotient.
2049 It is the caller's responsibility to not call this function with a Divisor of 0.
2050 If Divisor is 0, then the quotient and remainder should be assumed to be
2051 the largest negative integer.
2053 If Divisor is 0, then ASSERT().
2055 @param Dividend A 64-bit signed value.
2056 @param Divisor A 64-bit signed value.
2057 @param Remainder A pointer to a 64-bit signed value. This parameter is
2058 optional and may be NULL.
2060 @return Dividend / Divisor
2065 DivS64x64Remainder (
2068 OUT INT64
*Remainder OPTIONAL
2073 Reads a 16-bit value from memory that may be unaligned.
2075 This function returns the 16-bit value pointed to by Buffer. The function
2076 guarantees that the read operation does not produce an alignment fault.
2078 If the Buffer is NULL, then ASSERT().
2080 @param Buffer Pointer to a 16-bit value that may be unaligned.
2082 @return The 16-bit value read from Buffer.
2088 IN CONST UINT16
*Buffer
2093 Writes a 16-bit value to memory that may be unaligned.
2095 This function writes the 16-bit value specified by Value to Buffer. Value is
2096 returned. The function guarantees that the write operation does not produce
2099 If the Buffer is NULL, then ASSERT().
2101 @param Buffer Pointer to a 16-bit value that may be unaligned.
2102 @param Value 16-bit value to write to Buffer.
2104 @return The 16-bit value to write to Buffer.
2116 Reads a 24-bit value from memory that may be unaligned.
2118 This function returns the 24-bit value pointed to by Buffer. The function
2119 guarantees that the read operation does not produce an alignment fault.
2121 If the Buffer is NULL, then ASSERT().
2123 @param Buffer Pointer to a 24-bit value that may be unaligned.
2125 @return The 24-bit value read from Buffer.
2131 IN CONST UINT32
*Buffer
2136 Writes a 24-bit value to memory that may be unaligned.
2138 This function writes the 24-bit value specified by Value to Buffer. Value is
2139 returned. The function guarantees that the write operation does not produce
2142 If the Buffer is NULL, then ASSERT().
2144 @param Buffer Pointer to a 24-bit value that may be unaligned.
2145 @param Value 24-bit value to write to Buffer.
2147 @return The 24-bit value to write to Buffer.
2159 Reads a 32-bit value from memory that may be unaligned.
2161 This function returns the 32-bit value pointed to by Buffer. The function
2162 guarantees that the read operation does not produce an alignment fault.
2164 If the Buffer is NULL, then ASSERT().
2166 @param Buffer Pointer to a 32-bit value that may be unaligned.
2168 @return The 32-bit value read from Buffer.
2174 IN CONST UINT32
*Buffer
2179 Writes a 32-bit value to memory that may be unaligned.
2181 This function writes the 32-bit value specified by Value to Buffer. Value is
2182 returned. The function guarantees that the write operation does not produce
2185 If the Buffer is NULL, then ASSERT().
2187 @param Buffer Pointer to a 32-bit value that may be unaligned.
2188 @param Value 32-bit value to write to Buffer.
2190 @return The 32-bit value to write to Buffer.
2202 Reads a 64-bit value from memory that may be unaligned.
2204 This function returns the 64-bit value pointed to by Buffer. The function
2205 guarantees that the read operation does not produce an alignment fault.
2207 If the Buffer is NULL, then ASSERT().
2209 @param Buffer Pointer to a 64-bit value that may be unaligned.
2211 @return The 64-bit value read from Buffer.
2217 IN CONST UINT64
*Buffer
2222 Writes a 64-bit value to memory that may be unaligned.
2224 This function writes the 64-bit value specified by Value to Buffer. Value is
2225 returned. The function guarantees that the write operation does not produce
2228 If the Buffer is NULL, then ASSERT().
2230 @param Buffer Pointer to a 64-bit value that may be unaligned.
2231 @param Value 64-bit value to write to Buffer.
2233 @return The 64-bit value to write to Buffer.
2245 // Bit Field Functions
2249 Returns a bit field from an 8-bit value.
2251 Returns the bitfield specified by the StartBit and the EndBit from Operand.
2253 If 8-bit operations are not supported, then ASSERT().
2254 If StartBit is greater than 7, then ASSERT().
2255 If EndBit is greater than 7, then ASSERT().
2256 If EndBit is less than StartBit, then ASSERT().
2258 @param Operand Operand on which to perform the bitfield operation.
2259 @param StartBit The ordinal of the least significant bit in the bit field.
2261 @param EndBit The ordinal of the most significant bit in the bit field.
2264 @return The bit field read.
2277 Writes a bit field to an 8-bit value, and returns the result.
2279 Writes Value to the bit field specified by the StartBit and the EndBit in
2280 Operand. All other bits in Operand are preserved. The new 8-bit value is
2283 If 8-bit operations are not supported, then ASSERT().
2284 If StartBit is greater than 7, then ASSERT().
2285 If EndBit is greater than 7, then ASSERT().
2286 If EndBit is less than StartBit, then ASSERT().
2288 @param Operand Operand on which to perform the bitfield operation.
2289 @param StartBit The ordinal of the least significant bit in the bit field.
2291 @param EndBit The ordinal of the most significant bit in the bit field.
2293 @param Value New value of the bit field.
2295 @return The new 8-bit value.
2309 Reads a bit field from an 8-bit value, performs a bitwise OR, and returns the
2312 Performs a bitwise OR between the bit field specified by StartBit
2313 and EndBit in Operand and the value specified by OrData. All other bits in
2314 Operand are preserved. The new 8-bit value is returned.
2316 If 8-bit operations are not supported, then ASSERT().
2317 If StartBit is greater than 7, then ASSERT().
2318 If EndBit is greater than 7, then ASSERT().
2319 If EndBit is less than StartBit, then ASSERT().
2321 @param Operand Operand on which to perform the bitfield operation.
2322 @param StartBit The ordinal of the least significant bit in the bit field.
2324 @param EndBit The ordinal of the most significant bit in the bit field.
2326 @param OrData The value to OR with the read value from the value
2328 @return The new 8-bit value.
2342 Reads a bit field from an 8-bit value, performs a bitwise AND, and returns
2345 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2346 in Operand and the value specified by AndData. All other bits in Operand are
2347 preserved. The new 8-bit value is returned.
2349 If 8-bit operations are not supported, then ASSERT().
2350 If StartBit is greater than 7, then ASSERT().
2351 If EndBit is greater than 7, then ASSERT().
2352 If EndBit is less than StartBit, then ASSERT().
2354 @param Operand Operand on which to perform the bitfield operation.
2355 @param StartBit The ordinal of the least significant bit in the bit field.
2357 @param EndBit The ordinal of the most significant bit in the bit field.
2359 @param AndData The value to AND with the read value from the value.
2361 @return The new 8-bit value.
2375 Reads a bit field from an 8-bit value, performs a bitwise AND followed by a
2376 bitwise OR, and returns the result.
2378 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2379 in Operand and the value specified by AndData, followed by a bitwise
2380 OR with value specified by OrData. All other bits in Operand are
2381 preserved. The new 8-bit value is returned.
2383 If 8-bit operations are not supported, then ASSERT().
2384 If StartBit is greater than 7, then ASSERT().
2385 If EndBit is greater than 7, then ASSERT().
2386 If EndBit is less than StartBit, then ASSERT().
2388 @param Operand Operand on which to perform the bitfield operation.
2389 @param StartBit The ordinal of the least significant bit in the bit field.
2391 @param EndBit The ordinal of the most significant bit in the bit field.
2393 @param AndData The value to AND with the read value from the value.
2394 @param OrData The value to OR with the result of the AND operation.
2396 @return The new 8-bit value.
2401 BitFieldAndThenOr8 (
2411 Returns a bit field from a 16-bit value.
2413 Returns the bitfield specified by the StartBit and the EndBit from Operand.
2415 If 16-bit operations are not supported, then ASSERT().
2416 If StartBit is greater than 15, then ASSERT().
2417 If EndBit is greater than 15, then ASSERT().
2418 If EndBit is less than StartBit, then ASSERT().
2420 @param Operand Operand on which to perform the bitfield operation.
2421 @param StartBit The ordinal of the least significant bit in the bit field.
2423 @param EndBit The ordinal of the most significant bit in the bit field.
2426 @return The bit field read.
2439 Writes a bit field to a 16-bit value, and returns the result.
2441 Writes Value to the bit field specified by the StartBit and the EndBit in
2442 Operand. All other bits in Operand are preserved. The new 16-bit value is
2445 If 16-bit operations are not supported, then ASSERT().
2446 If StartBit is greater than 15, then ASSERT().
2447 If EndBit is greater than 15, then ASSERT().
2448 If EndBit is less than StartBit, then ASSERT().
2450 @param Operand Operand on which to perform the bitfield operation.
2451 @param StartBit The ordinal of the least significant bit in the bit field.
2453 @param EndBit The ordinal of the most significant bit in the bit field.
2455 @param Value New value of the bit field.
2457 @return The new 16-bit value.
2471 Reads a bit field from a 16-bit value, performs a bitwise OR, and returns the
2474 Performs a bitwise OR between the bit field specified by StartBit
2475 and EndBit in Operand and the value specified by OrData. All other bits in
2476 Operand are preserved. The new 16-bit value is returned.
2478 If 16-bit operations are not supported, then ASSERT().
2479 If StartBit is greater than 15, then ASSERT().
2480 If EndBit is greater than 15, then ASSERT().
2481 If EndBit is less than StartBit, then ASSERT().
2483 @param Operand Operand on which to perform the bitfield operation.
2484 @param StartBit The ordinal of the least significant bit in the bit field.
2486 @param EndBit The ordinal of the most significant bit in the bit field.
2488 @param OrData The value to OR with the read value from the value
2490 @return The new 16-bit value.
2504 Reads a bit field from a 16-bit value, performs a bitwise AND, and returns
2507 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2508 in Operand and the value specified by AndData. All other bits in Operand are
2509 preserved. The new 16-bit value is returned.
2511 If 16-bit operations are not supported, then ASSERT().
2512 If StartBit is greater than 15, then ASSERT().
2513 If EndBit is greater than 15, then ASSERT().
2514 If EndBit is less than StartBit, then ASSERT().
2516 @param Operand Operand on which to perform the bitfield operation.
2517 @param StartBit The ordinal of the least significant bit in the bit field.
2519 @param EndBit The ordinal of the most significant bit in the bit field.
2521 @param AndData The value to AND with the read value from the value
2523 @return The new 16-bit value.
2537 Reads a bit field from a 16-bit value, performs a bitwise AND followed by a
2538 bitwise OR, and returns the result.
2540 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2541 in Operand and the value specified by AndData, followed by a bitwise
2542 OR with value specified by OrData. All other bits in Operand are
2543 preserved. The new 16-bit value is returned.
2545 If 16-bit operations are not supported, then ASSERT().
2546 If StartBit is greater than 15, then ASSERT().
2547 If EndBit is greater than 15, then ASSERT().
2548 If EndBit is less than StartBit, then ASSERT().
2550 @param Operand Operand on which to perform the bitfield operation.
2551 @param StartBit The ordinal of the least significant bit in the bit field.
2553 @param EndBit The ordinal of the most significant bit in the bit field.
2555 @param AndData The value to AND with the read value from the value.
2556 @param OrData The value to OR with the result of the AND operation.
2558 @return The new 16-bit value.
2563 BitFieldAndThenOr16 (
2573 Returns a bit field from a 32-bit value.
2575 Returns the bitfield specified by the StartBit and the EndBit from Operand.
2577 If 32-bit operations are not supported, then ASSERT().
2578 If StartBit is greater than 31, then ASSERT().
2579 If EndBit is greater than 31, then ASSERT().
2580 If EndBit is less than StartBit, then ASSERT().
2582 @param Operand Operand on which to perform the bitfield operation.
2583 @param StartBit The ordinal of the least significant bit in the bit field.
2585 @param EndBit The ordinal of the most significant bit in the bit field.
2588 @return The bit field read.
2601 Writes a bit field to a 32-bit value, and returns the result.
2603 Writes Value to the bit field specified by the StartBit and the EndBit in
2604 Operand. All other bits in Operand are preserved. The new 32-bit value is
2607 If 32-bit operations are not supported, then ASSERT().
2608 If StartBit is greater than 31, then ASSERT().
2609 If EndBit is greater than 31, then ASSERT().
2610 If EndBit is less than StartBit, then ASSERT().
2612 @param Operand Operand on which to perform the bitfield operation.
2613 @param StartBit The ordinal of the least significant bit in the bit field.
2615 @param EndBit The ordinal of the most significant bit in the bit field.
2617 @param Value New value of the bit field.
2619 @return The new 32-bit value.
2633 Reads a bit field from a 32-bit value, performs a bitwise OR, and returns the
2636 Performs a bitwise OR between the bit field specified by StartBit
2637 and EndBit in Operand and the value specified by OrData. All other bits in
2638 Operand are preserved. The new 32-bit value is returned.
2640 If 32-bit operations are not supported, then ASSERT().
2641 If StartBit is greater than 31, then ASSERT().
2642 If EndBit is greater than 31, then ASSERT().
2643 If EndBit is less than StartBit, then ASSERT().
2645 @param Operand Operand on which to perform the bitfield operation.
2646 @param StartBit The ordinal of the least significant bit in the bit field.
2648 @param EndBit The ordinal of the most significant bit in the bit field.
2650 @param OrData The value to OR with the read value from the value
2652 @return The new 32-bit value.
2666 Reads a bit field from a 32-bit value, performs a bitwise AND, and returns
2669 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2670 in Operand and the value specified by AndData. All other bits in Operand are
2671 preserved. The new 32-bit value is returned.
2673 If 32-bit operations are not supported, then ASSERT().
2674 If StartBit is greater than 31, then ASSERT().
2675 If EndBit is greater than 31, then ASSERT().
2676 If EndBit is less than StartBit, then ASSERT().
2678 @param Operand Operand on which to perform the bitfield operation.
2679 @param StartBit The ordinal of the least significant bit in the bit field.
2681 @param EndBit The ordinal of the most significant bit in the bit field.
2683 @param AndData The value to AND with the read value from the value
2685 @return The new 32-bit value.
2699 Reads a bit field from a 32-bit value, performs a bitwise AND followed by a
2700 bitwise OR, and returns the result.
2702 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2703 in Operand and the value specified by AndData, followed by a bitwise
2704 OR with value specified by OrData. All other bits in Operand are
2705 preserved. The new 32-bit value is returned.
2707 If 32-bit operations are not supported, then ASSERT().
2708 If StartBit is greater than 31, then ASSERT().
2709 If EndBit is greater than 31, then ASSERT().
2710 If EndBit is less than StartBit, then ASSERT().
2712 @param Operand Operand on which to perform the bitfield operation.
2713 @param StartBit The ordinal of the least significant bit in the bit field.
2715 @param EndBit The ordinal of the most significant bit in the bit field.
2717 @param AndData The value to AND with the read value from the value.
2718 @param OrData The value to OR with the result of the AND operation.
2720 @return The new 32-bit value.
2725 BitFieldAndThenOr32 (
2735 Returns a bit field from a 64-bit value.
2737 Returns the bitfield specified by the StartBit and the EndBit from Operand.
2739 If 64-bit operations are not supported, then ASSERT().
2740 If StartBit is greater than 63, then ASSERT().
2741 If EndBit is greater than 63, then ASSERT().
2742 If EndBit is less than StartBit, then ASSERT().
2744 @param Operand Operand on which to perform the bitfield operation.
2745 @param StartBit The ordinal of the least significant bit in the bit field.
2747 @param EndBit The ordinal of the most significant bit in the bit field.
2750 @return The bit field read.
2763 Writes a bit field to a 64-bit value, and returns the result.
2765 Writes Value to the bit field specified by the StartBit and the EndBit in
2766 Operand. All other bits in Operand are preserved. The new 64-bit value is
2769 If 64-bit operations are not supported, then ASSERT().
2770 If StartBit is greater than 63, then ASSERT().
2771 If EndBit is greater than 63, then ASSERT().
2772 If EndBit is less than StartBit, then ASSERT().
2774 @param Operand Operand on which to perform the bitfield operation.
2775 @param StartBit The ordinal of the least significant bit in the bit field.
2777 @param EndBit The ordinal of the most significant bit in the bit field.
2779 @param Value New value of the bit field.
2781 @return The new 64-bit value.
2795 Reads a bit field from a 64-bit value, performs a bitwise OR, and returns the
2798 Performs a bitwise OR between the bit field specified by StartBit
2799 and EndBit in Operand and the value specified by OrData. All other bits in
2800 Operand are preserved. The new 64-bit value is returned.
2802 If 64-bit operations are not supported, then ASSERT().
2803 If StartBit is greater than 63, then ASSERT().
2804 If EndBit is greater than 63, then ASSERT().
2805 If EndBit is less than StartBit, then ASSERT().
2807 @param Operand Operand on which to perform the bitfield operation.
2808 @param StartBit The ordinal of the least significant bit in the bit field.
2810 @param EndBit The ordinal of the most significant bit in the bit field.
2812 @param OrData The value to OR with the read value from the value
2814 @return The new 64-bit value.
2828 Reads a bit field from a 64-bit value, performs a bitwise AND, and returns
2831 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2832 in Operand and the value specified by AndData. All other bits in Operand are
2833 preserved. The new 64-bit value is returned.
2835 If 64-bit operations are not supported, then ASSERT().
2836 If StartBit is greater than 63, then ASSERT().
2837 If EndBit is greater than 63, then ASSERT().
2838 If EndBit is less than StartBit, then ASSERT().
2840 @param Operand Operand on which to perform the bitfield operation.
2841 @param StartBit The ordinal of the least significant bit in the bit field.
2843 @param EndBit The ordinal of the most significant bit in the bit field.
2845 @param AndData The value to AND with the read value from the value
2847 @return The new 64-bit value.
2861 Reads a bit field from a 64-bit value, performs a bitwise AND followed by a
2862 bitwise OR, and returns the result.
2864 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2865 in Operand and the value specified by AndData, followed by a bitwise
2866 OR with value specified by OrData. All other bits in Operand are
2867 preserved. The new 64-bit value is returned.
2869 If 64-bit operations are not supported, then ASSERT().
2870 If StartBit is greater than 63, then ASSERT().
2871 If EndBit is greater than 63, then ASSERT().
2872 If EndBit is less than StartBit, then ASSERT().
2874 @param Operand Operand on which to perform the bitfield operation.
2875 @param StartBit The ordinal of the least significant bit in the bit field.
2877 @param EndBit The ordinal of the most significant bit in the bit field.
2879 @param AndData The value to AND with the read value from the value.
2880 @param OrData The value to OR with the result of the AND operation.
2882 @return The new 64-bit value.
2887 BitFieldAndThenOr64 (
2897 // Base Library Synchronization Functions
2901 Retrieves the architecture specific spin lock alignment requirements for
2902 optimal spin lock performance.
2904 This function retrieves the spin lock alignment requirements for optimal
2905 performance on a given CPU architecture. The spin lock alignment must be a
2906 power of two and is returned by this function. If there are no alignment
2907 requirements, then 1 must be returned. The spin lock synchronization
2908 functions must function correctly if the spin lock size and alignment values
2909 returned by this function are not used at all. These values are hints to the
2910 consumers of the spin lock synchronization functions to obtain optimal spin
2913 @return The architecture specific spin lock alignment.
2918 GetSpinLockProperties (
2924 Initializes a spin lock to the released state and returns the spin lock.
2926 This function initializes the spin lock specified by SpinLock to the released
2927 state, and returns SpinLock. Optimal performance can be achieved by calling
2928 GetSpinLockProperties() to determine the size and alignment requirements for
2931 If SpinLock is NULL, then ASSERT().
2933 @param SpinLock A pointer to the spin lock to initialize to the released
2936 @return SpinLock in release state.
2941 InitializeSpinLock (
2942 OUT SPIN_LOCK
*SpinLock
2947 Waits until a spin lock can be placed in the acquired state.
2949 This function checks the state of the spin lock specified by SpinLock. If
2950 SpinLock is in the released state, then this function places SpinLock in the
2951 acquired state and returns SpinLock. Otherwise, this function waits
2952 indefinitely for the spin lock to be released, and then places it in the
2953 acquired state and returns SpinLock. All state transitions of SpinLock must
2954 be performed using MP safe mechanisms.
2956 If SpinLock is NULL, then ASSERT().
2957 If SpinLock was not initialized with InitializeSpinLock(), then ASSERT().
2958 If PcdSpinLockTimeout is not zero, and SpinLock is can not be acquired in
2959 PcdSpinLockTimeout microseconds, then ASSERT().
2961 @param SpinLock A pointer to the spin lock to place in the acquired state.
2963 @return SpinLock acquired lock.
2969 IN OUT SPIN_LOCK
*SpinLock
2974 Attempts to place a spin lock in the acquired state.
2976 This function checks the state of the spin lock specified by SpinLock. If
2977 SpinLock is in the released state, then this function places SpinLock in the
2978 acquired state and returns TRUE. Otherwise, FALSE is returned. All state
2979 transitions of SpinLock must be performed using MP safe mechanisms.
2981 If SpinLock is NULL, then ASSERT().
2982 If SpinLock was not initialized with InitializeSpinLock(), then ASSERT().
2984 @param SpinLock A pointer to the spin lock to place in the acquired state.
2986 @retval TRUE SpinLock was placed in the acquired state.
2987 @retval FALSE SpinLock could not be acquired.
2992 AcquireSpinLockOrFail (
2993 IN OUT SPIN_LOCK
*SpinLock
2998 Releases a spin lock.
3000 This function places the spin lock specified by SpinLock in the release state
3001 and returns SpinLock.
3003 If SpinLock is NULL, then ASSERT().
3004 If SpinLock was not initialized with InitializeSpinLock(), then ASSERT().
3006 @param SpinLock A pointer to the spin lock to release.
3008 @return SpinLock released lock.
3014 IN OUT SPIN_LOCK
*SpinLock
3019 Performs an atomic increment of an 32-bit unsigned integer.
3021 Performs an atomic increment of the 32-bit unsigned integer specified by
3022 Value and returns the incremented value. The increment operation must be
3023 performed using MP safe mechanisms. The state of the return value is not
3024 guaranteed to be MP safe.
3026 If Value is NULL, then ASSERT().
3028 @param Value A pointer to the 32-bit value to increment.
3030 @return The incremented value.
3035 InterlockedIncrement (
3041 Performs an atomic decrement of an 32-bit unsigned integer.
3043 Performs an atomic decrement of the 32-bit unsigned integer specified by
3044 Value and returns the decremented value. The decrement operation must be
3045 performed using MP safe mechanisms. The state of the return value is not
3046 guaranteed to be MP safe.
3048 If Value is NULL, then ASSERT().
3050 @param Value A pointer to the 32-bit value to decrement.
3052 @return The decremented value.
3057 InterlockedDecrement (
3063 Performs an atomic compare exchange operation on a 32-bit unsigned integer.
3065 Performs an atomic compare exchange operation on the 32-bit unsigned integer
3066 specified by Value. If Value is equal to CompareValue, then Value is set to
3067 ExchangeValue and CompareValue is returned. If Value is not equal to CompareValue,
3068 then Value is returned. The compare exchange operation must be performed using
3071 If Value is NULL, then ASSERT().
3073 @param Value A pointer to the 32-bit value for the compare exchange
3075 @param CompareValue 32-bit value used in compare operation.
3076 @param ExchangeValue 32-bit value used in exchange operation.
3078 @return The original *Value before exchange.
3083 InterlockedCompareExchange32 (
3084 IN OUT UINT32
*Value
,
3085 IN UINT32 CompareValue
,
3086 IN UINT32 ExchangeValue
3091 Performs an atomic compare exchange operation on a 64-bit unsigned integer.
3093 Performs an atomic compare exchange operation on the 64-bit unsigned integer specified
3094 by Value. If Value is equal to CompareValue, then Value is set to ExchangeValue and
3095 CompareValue is returned. If Value is not equal to CompareValue, then Value is returned.
3096 The compare exchange operation must be performed using MP safe mechanisms.
3098 If Value is NULL, then ASSERT().
3100 @param Value A pointer to the 64-bit value for the compare exchange
3102 @param CompareValue 64-bit value used in compare operation.
3103 @param ExchangeValue 64-bit value used in exchange operation.
3105 @return The original *Value before exchange.
3110 InterlockedCompareExchange64 (
3111 IN OUT UINT64
*Value
,
3112 IN UINT64 CompareValue
,
3113 IN UINT64 ExchangeValue
3118 Performs an atomic compare exchange operation on a pointer value.
3120 Performs an atomic compare exchange operation on the pointer value specified
3121 by Value. If Value is equal to CompareValue, then Value is set to
3122 ExchangeValue and CompareValue is returned. If Value is not equal to
3123 CompareValue, then Value is returned. The compare exchange operation must be
3124 performed using MP safe mechanisms.
3126 If Value is NULL, then ASSERT().
3128 @param Value A pointer to the pointer value for the compare exchange
3130 @param CompareValue Pointer value used in compare operation.
3131 @param ExchangeValue Pointer value used in exchange operation.
3133 @return The original *Value before exchange.
3137 InterlockedCompareExchangePointer (
3138 IN OUT VOID
**Value
,
3139 IN VOID
*CompareValue
,
3140 IN VOID
*ExchangeValue
3145 // Base Library Checksum Functions
3149 Returns the sum of all elements in a buffer in unit of UINT8.
3150 During calculation, the carry bits are dropped.
3152 This function calculates the sum of all elements in a buffer
3153 in unit of UINT8. The carry bits in result of addition are dropped.
3154 The result is returned as UINT8. If Length is Zero, then Zero is
3157 If Buffer is NULL, then ASSERT().
3158 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3160 @param Buffer Pointer to the buffer to carry out the sum operation.
3161 @param Length The size, in bytes, of Buffer.
3163 @return Sum The sum of Buffer with carry bits dropped during additions.
3169 IN CONST UINT8
*Buffer
,
3175 Returns the two's complement checksum of all elements in a buffer
3178 This function first calculates the sum of the 8-bit values in the
3179 buffer specified by Buffer and Length. The carry bits in the result
3180 of addition are dropped. Then, the two's complement of the sum is
3181 returned. If Length is 0, then 0 is returned.
3183 If Buffer is NULL, then ASSERT().
3184 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3186 @param Buffer Pointer to the buffer to carry out the checksum operation.
3187 @param Length The size, in bytes, of Buffer.
3189 @return Checksum The 2's complement checksum of Buffer.
3194 CalculateCheckSum8 (
3195 IN CONST UINT8
*Buffer
,
3201 Returns the sum of all elements in a buffer of 16-bit values. During
3202 calculation, the carry bits are dropped.
3204 This function calculates the sum of the 16-bit values in the buffer
3205 specified by Buffer and Length. The carry bits in result of addition are dropped.
3206 The 16-bit result is returned. If Length is 0, then 0 is returned.
3208 If Buffer is NULL, then ASSERT().
3209 If Buffer is not aligned on a 16-bit boundary, then ASSERT().
3210 If Length is not aligned on a 16-bit boundary, then ASSERT().
3211 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3213 @param Buffer Pointer to the buffer to carry out the sum operation.
3214 @param Length The size, in bytes, of Buffer.
3216 @return Sum The sum of Buffer with carry bits dropped during additions.
3222 IN CONST UINT16
*Buffer
,
3228 Returns the two's complement checksum of all elements in a buffer of
3231 This function first calculates the sum of the 16-bit values in the buffer
3232 specified by Buffer and Length. The carry bits in the result of addition
3233 are dropped. Then, the two's complement of the sum is returned. If Length
3234 is 0, then 0 is returned.
3236 If Buffer is NULL, then ASSERT().
3237 If Buffer is not aligned on a 16-bit boundary, then ASSERT().
3238 If Length is not aligned on a 16-bit boundary, then ASSERT().
3239 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3241 @param Buffer Pointer to the buffer to carry out the checksum operation.
3242 @param Length The size, in bytes, of Buffer.
3244 @return Checksum The 2's complement checksum of Buffer.
3249 CalculateCheckSum16 (
3250 IN CONST UINT16
*Buffer
,
3256 Returns the sum of all elements in a buffer of 32-bit values. During
3257 calculation, the carry bits are dropped.
3259 This function calculates the sum of the 32-bit values in the buffer
3260 specified by Buffer and Length. The carry bits in result of addition are dropped.
3261 The 32-bit result is returned. If Length is 0, then 0 is returned.
3263 If Buffer is NULL, then ASSERT().
3264 If Buffer is not aligned on a 32-bit boundary, then ASSERT().
3265 If Length is not aligned on a 32-bit boundary, then ASSERT().
3266 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3268 @param Buffer Pointer to the buffer to carry out the sum operation.
3269 @param Length The size, in bytes, of Buffer.
3271 @return Sum The sum of Buffer with carry bits dropped during additions.
3277 IN CONST UINT32
*Buffer
,
3283 Returns the two's complement checksum of all elements in a buffer of
3286 This function first calculates the sum of the 32-bit values in the buffer
3287 specified by Buffer and Length. The carry bits in the result of addition
3288 are dropped. Then, the two's complement of the sum is returned. If Length
3289 is 0, then 0 is returned.
3291 If Buffer is NULL, then ASSERT().
3292 If Buffer is not aligned on a 32-bit boundary, then ASSERT().
3293 If Length is not aligned on a 32-bit boundary, then ASSERT().
3294 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3296 @param Buffer Pointer to the buffer to carry out the checksum operation.
3297 @param Length The size, in bytes, of Buffer.
3299 @return Checksum The 2's complement checksum of Buffer.
3304 CalculateCheckSum32 (
3305 IN CONST UINT32
*Buffer
,
3311 Returns the sum of all elements in a buffer of 64-bit values. During
3312 calculation, the carry bits are dropped.
3314 This function calculates the sum of the 64-bit values in the buffer
3315 specified by Buffer and Length. The carry bits in result of addition are dropped.
3316 The 64-bit result is returned. If Length is 0, then 0 is returned.
3318 If Buffer is NULL, then ASSERT().
3319 If Buffer is not aligned on a 64-bit boundary, then ASSERT().
3320 If Length is not aligned on a 64-bit boundary, then ASSERT().
3321 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3323 @param Buffer Pointer to the buffer to carry out the sum operation.
3324 @param Length The size, in bytes, of Buffer.
3326 @return Sum The sum of Buffer with carry bits dropped during additions.
3332 IN CONST UINT64
*Buffer
,
3338 Returns the two's complement checksum of all elements in a buffer of
3341 This function first calculates the sum of the 64-bit values in the buffer
3342 specified by Buffer and Length. The carry bits in the result of addition
3343 are dropped. Then, the two's complement of the sum is returned. If Length
3344 is 0, then 0 is returned.
3346 If Buffer is NULL, then ASSERT().
3347 If Buffer is not aligned on a 64-bit boundary, then ASSERT().
3348 If Length is not aligned on a 64-bit boundary, then ASSERT().
3349 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3351 @param Buffer Pointer to the buffer to carry out the checksum operation.
3352 @param Length The size, in bytes, of Buffer.
3354 @return Checksum The 2's complement checksum of Buffer.
3359 CalculateCheckSum64 (
3360 IN CONST UINT64
*Buffer
,
3366 /// Base Library CPU Functions
3370 (EFIAPI
*SWITCH_STACK_ENTRY_POINT
)(
3371 IN VOID
*Context1
, OPTIONAL
3372 IN VOID
*Context2 OPTIONAL
3377 Used to serialize load and store operations.
3379 All loads and stores that proceed calls to this function are guaranteed to be
3380 globally visible when this function returns.
3391 Saves the current CPU context that can be restored with a call to LongJump()
3394 Saves the current CPU context in the buffer specified by JumpBuffer and
3395 returns 0. The initial call to SetJump() must always return 0. Subsequent
3396 calls to LongJump() cause a non-zero value to be returned by SetJump().
3398 If JumpBuffer is NULL, then ASSERT().
3399 For IPF CPUs, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().
3401 NOTE: The structure BASE_LIBRARY_JUMP_BUFFER is CPU architecture specific.
3402 The same structure must never be used for more than one CPU architecture context.
3403 For example, a BASE_LIBRARY_JUMP_BUFFER allocated by an IA-32 module must never be used from an x64 module.
3404 SetJump()/LongJump() is not currently supported for the EBC processor type.
3406 @param JumpBuffer A pointer to CPU context buffer.
3408 @retval 0 Indicates a return from SetJump().
3414 OUT BASE_LIBRARY_JUMP_BUFFER
*JumpBuffer
3419 Restores the CPU context that was saved with SetJump().
3421 Restores the CPU context from the buffer specified by JumpBuffer. This
3422 function never returns to the caller. Instead is resumes execution based on
3423 the state of JumpBuffer.
3425 If JumpBuffer is NULL, then ASSERT().
3426 For IPF CPUs, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().
3427 If Value is 0, then ASSERT().
3429 @param JumpBuffer A pointer to CPU context buffer.
3430 @param Value The value to return when the SetJump() context is
3431 restored and must be non-zero.
3437 IN BASE_LIBRARY_JUMP_BUFFER
*JumpBuffer
,
3443 Enables CPU interrupts.
3454 Disables CPU interrupts.
3465 Disables CPU interrupts and returns the interrupt state prior to the disable
3468 @retval TRUE CPU interrupts were enabled on entry to this call.
3469 @retval FALSE CPU interrupts were disabled on entry to this call.
3474 SaveAndDisableInterrupts (
3480 Enables CPU interrupts for the smallest window required to capture any
3486 EnableDisableInterrupts (
3492 Retrieves the current CPU interrupt state.
3494 Returns TRUE is interrupts are currently enabled. Otherwise
3497 @retval TRUE CPU interrupts are enabled.
3498 @retval FALSE CPU interrupts are disabled.
3509 Set the current CPU interrupt state.
3511 Sets the current CPU interrupt state to the state specified by
3512 InterruptState. If InterruptState is TRUE, then interrupts are enabled. If
3513 InterruptState is FALSE, then interrupts are disabled. InterruptState is
3516 @param InterruptState TRUE if interrupts should enabled. FALSE if
3517 interrupts should be disabled.
3519 @return InterruptState
3525 IN BOOLEAN InterruptState
3530 Requests CPU to pause for a short period of time.
3532 Requests CPU to pause for a short period of time. Typically used in MP
3533 systems to prevent memory starvation while waiting for a spin lock.
3544 Transfers control to a function starting with a new stack.
3546 Transfers control to the function specified by EntryPoint using the
3547 new stack specified by NewStack and passing in the parameters specified
3548 by Context1 and Context2. Context1 and Context2 are optional and may
3549 be NULL. The function EntryPoint must never return. This function
3550 supports a variable number of arguments following the NewStack parameter.
3551 These additional arguments are ignored on IA-32, x64, and EBC.
3552 IPF CPUs expect one additional parameter of type VOID * that specifies
3553 the new backing store pointer.
3555 If EntryPoint is NULL, then ASSERT().
3556 If NewStack is NULL, then ASSERT().
3558 @param EntryPoint A pointer to function to call with the new stack.
3559 @param Context1 A pointer to the context to pass into the EntryPoint
3561 @param Context2 A pointer to the context to pass into the EntryPoint
3563 @param NewStack A pointer to the new stack to use for the EntryPoint
3565 @param ... This variable argument list is ignored for IA32, x64, and EBC.
3566 For IPF, this variable argument list is expected to contain
3567 a single parameter of type VOID * that specifies the new backing
3575 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
3576 IN VOID
*Context1
, OPTIONAL
3577 IN VOID
*Context2
, OPTIONAL
3584 Generates a breakpoint on the CPU.
3586 Generates a breakpoint on the CPU. The breakpoint must be implemented such
3587 that code can resume normal execution after the breakpoint.
3598 Executes an infinite loop.
3600 Forces the CPU to execute an infinite loop. A debugger may be used to skip
3601 past the loop and the code that follows the loop must execute properly. This
3602 implies that the infinite loop must not cause the code that follow it to be
3611 #if defined (MDE_CPU_IPF)
3614 Flush a range of cache lines in the cache coherency domain of the calling
3617 Flushes the cache lines specified by Address and Length. If Address is not aligned
3618 on a cache line boundary, then entire cache line containing Address is flushed.
3619 If Address + Length is not aligned on a cache line boundary, then the entire cache
3620 line containing Address + Length - 1 is flushed. This function may choose to flush
3621 the entire cache if that is more efficient than flushing the specified range. If
3622 Length is 0, the no cache lines are flushed. Address is returned.
3623 This function is only available on IPF.
3625 If Length is greater than (MAX_ADDRESS - Address + 1), then ASSERT().
3627 @param Address The base address of the instruction lines to invalidate. If
3628 the CPU is in a physical addressing mode, then Address is a
3629 physical address. If the CPU is in a virtual addressing mode,
3630 then Address is a virtual address.
3632 @param Length The number of bytes to invalidate from the instruction cache.
3639 AsmFlushCacheRange (
3646 Executes a FC instruction
3647 Executes a FC instruction on the cache line specified by Address.
3648 The cache line size affected is at least 32-bytes (aligned on a 32-byte boundary).
3649 An implementation may flush a larger region. This function is only available on IPF.
3651 @param Address The Address of cache line to be flushed.
3653 @return The address of FC instruction executed.
3664 Executes a FC.I instruction.
3665 Executes a FC.I instruction on the cache line specified by Address.
3666 The cache line size affected is at least 32-bytes (aligned on a 32-byte boundary).
3667 An implementation may flush a larger region. This function is only available on IPF.
3669 @param Address The Address of cache line to be flushed.
3671 @return The address of FC.I instruction executed.
3682 Reads the current value of a Processor Identifier Register (CPUID).
3684 Reads and returns the current value of Processor Identifier Register specified by Index.
3685 The Index of largest implemented CPUID (One less than the number of implemented CPUID
3686 registers) is determined by CPUID [3] bits {7:0}.
3687 No parameter checking is performed on Index. If the Index value is beyond the
3688 implemented CPUID register range, a Reserved Register/Field fault may occur. The caller
3689 must either guarantee that Index is valid, or the caller must set up fault handlers to
3690 catch the faults. This function is only available on IPF.
3692 @param Index The 8-bit Processor Identifier Register index to read.
3694 @return The current value of Processor Identifier Register specified by Index.
3705 Reads the current value of 64-bit Processor Status Register (PSR).
3706 This function is only available on IPF.
3708 @return The current value of PSR.
3719 Writes the current value of 64-bit Processor Status Register (PSR).
3721 No parameter checking is performed on Value. All bits of Value corresponding to
3722 reserved fields of PSR must be 0 or a Reserved Register/Field fault may occur.
3723 The caller must either guarantee that Value is valid, or the caller must set up
3724 fault handlers to catch the faults. This function is only available on IPF.
3726 @param Value The 64-bit value to write to PSR.
3728 @return The 64-bit value written to the PSR.
3739 Reads the current value of 64-bit Kernel Register #0 (KR0).
3740 This function is only available on IPF.
3742 @return The current value of KR0.
3753 Reads the current value of 64-bit Kernel Register #1 (KR1).
3754 This function is only available on IPF.
3756 @return The current value of KR1.
3767 Reads the current value of 64-bit Kernel Register #2 (KR2).
3768 This function is only available on IPF.
3770 @return The current value of KR2.
3781 Reads the current value of 64-bit Kernel Register #3 (KR3).
3782 This function is only available on IPF.
3784 @return The current value of KR3.
3795 Reads the current value of 64-bit Kernel Register #4 (KR4).
3796 This function is only available on IPF.
3798 @return The current value of KR4.
3809 Reads the current value of 64-bit Kernel Register #5 (KR5).
3810 This function is only available on IPF.
3812 @return The current value of KR5.
3823 Reads the current value of 64-bit Kernel Register #6 (KR6).
3824 This function is only available on IPF.
3826 @return The current value of KR6.
3837 Reads the current value of 64-bit Kernel Register #7 (KR7).
3838 This function is only available on IPF.
3840 @return The current value of KR7.
3851 Write the current value of 64-bit Kernel Register #0 (KR0).
3852 This function is only available on IPF.
3854 @param Value The 64-bit value to write to KR0.
3856 @return The 64-bit value written to the KR0.
3867 Write the current value of 64-bit Kernel Register #1 (KR1).
3868 This function is only available on IPF.
3870 @param Value The 64-bit value to write to KR1.
3872 @return The 64-bit value written to the KR1.
3883 Write the current value of 64-bit Kernel Register #2 (KR2).
3884 This function is only available on IPF.
3886 @param Value The 64-bit value to write to KR2.
3888 @return The 64-bit value written to the KR2.
3899 Write the current value of 64-bit Kernel Register #3 (KR3).
3900 This function is only available on IPF.
3902 @param Value The 64-bit value to write to KR3.
3904 @return The 64-bit value written to the KR3.
3915 Write the current value of 64-bit Kernel Register #4 (KR4).
3916 This function is only available on IPF.
3918 @param Value The 64-bit value to write to KR4.
3920 @return The 64-bit value written to the KR4.
3931 Write the current value of 64-bit Kernel Register #5 (KR5).
3932 This function is only available on IPF.
3934 @param Value The 64-bit value to write to KR5.
3936 @return The 64-bit value written to the KR5.
3947 Write the current value of 64-bit Kernel Register #6 (KR6).
3948 This function is only available on IPF.
3950 @param Value The 64-bit value to write to KR6.
3952 @return The 64-bit value written to the KR6.
3963 Write the current value of 64-bit Kernel Register #7 (KR7).
3964 This function is only available on IPF.
3966 @param Value The 64-bit value to write to KR7.
3968 @return The 64-bit value written to the KR7.
3979 Reads the current value of Interval Timer Counter Register (ITC).
3980 This function is only available on IPF.
3982 @return The current value of ITC.
3993 Reads the current value of Interval Timer Vector Register (ITV).
3994 This function is only available on IPF.
3996 @return The current value of ITV.
4007 Reads the current value of Interval Timer Match Register (ITM).
4008 This function is only available on IPF.
4010 @return The current value of ITM.
4020 Writes the current value of 64-bit Interval Timer Counter Register (ITC).
4021 This function is only available on IPF.
4023 @param Value The 64-bit value to write to ITC.
4025 @return The 64-bit value written to the ITC.
4036 Writes the current value of 64-bit Interval Timer Match Register (ITM).
4037 This function is only available on IPF.
4039 @param Value The 64-bit value to write to ITM.
4041 @return The 64-bit value written to the ITM.
4052 Writes the current value of 64-bit Interval Timer Vector Register (ITV).
4053 No parameter checking is performed on Value. All bits of Value corresponding to
4054 reserved fields of ITV must be 0 or a Reserved Register/Field fault may occur.
4055 The caller must either guarantee that Value is valid, or the caller must set up
4056 fault handlers to catch the faults.
4057 This function is only available on IPF.
4059 @param Value The 64-bit value to write to ITV.
4061 @return The 64-bit value written to the ITV.
4072 Reads the current value of Default Control Register (DCR).
4073 This function is only available on IPF.
4075 @return The current value of DCR.
4086 Reads the current value of Interruption Vector Address Register (IVA).
4087 This function is only available on IPF.
4089 @return The current value of IVA.
4099 Reads the current value of Page Table Address Register (PTA).
4100 This function is only available on IPF.
4102 @return The current value of PTA.
4113 Writes the current value of 64-bit Default Control Register (DCR).
4114 No parameter checking is performed on Value. All bits of Value corresponding to
4115 reserved fields of DCR must be 0 or a Reserved Register/Field fault may occur.
4116 The caller must either guarantee that Value is valid, or the caller must set up
4117 fault handlers to catch the faults.
4118 This function is only available on IPF.
4120 @param Value The 64-bit value to write to DCR.
4122 @return The 64-bit value written to the DCR.
4133 Writes the current value of 64-bit Interruption Vector Address Register (IVA).
4134 The size of vector table is 32 K bytes and is 32 K bytes aligned
4135 the low 15 bits of Value is ignored when written.
4136 This function is only available on IPF.
4138 @param Value The 64-bit value to write to IVA.
4140 @return The 64-bit value written to the IVA.
4151 Writes the current value of 64-bit Page Table Address Register (PTA).
4152 No parameter checking is performed on Value. All bits of Value corresponding to
4153 reserved fields of DCR must be 0 or a Reserved Register/Field fault may occur.
4154 The caller must either guarantee that Value is valid, or the caller must set up
4155 fault handlers to catch the faults.
4156 This function is only available on IPF.
4158 @param Value The 64-bit value to write to PTA.
4160 @return The 64-bit value written to the PTA.
4170 Reads the current value of Local Interrupt ID Register (LID).
4171 This function is only available on IPF.
4173 @return The current value of LID.
4184 Reads the current value of External Interrupt Vector Register (IVR).
4185 This function is only available on IPF.
4187 @return The current value of IVR.
4198 Reads the current value of Task Priority Register (TPR).
4199 This function is only available on IPF.
4201 @return The current value of TPR.
4212 Reads the current value of External Interrupt Request Register #0 (IRR0).
4213 This function is only available on IPF.
4215 @return The current value of IRR0.
4226 Reads the current value of External Interrupt Request Register #1 (IRR1).
4227 This function is only available on IPF.
4229 @return The current value of IRR1.
4240 Reads the current value of External Interrupt Request Register #2 (IRR2).
4241 This function is only available on IPF.
4243 @return The current value of IRR2.
4254 Reads the current value of External Interrupt Request Register #3 (IRR3).
4255 This function is only available on IPF.
4257 @return The current value of IRR3.
4268 Reads the current value of Performance Monitor Vector Register (PMV).
4269 This function is only available on IPF.
4271 @return The current value of PMV.
4282 Reads the current value of Corrected Machine Check Vector Register (CMCV).
4283 This function is only available on IPF.
4285 @return The current value of CMCV.
4296 Reads the current value of Local Redirection Register #0 (LRR0).
4297 This function is only available on IPF.
4299 @return The current value of LRR0.
4310 Reads the current value of Local Redirection Register #1 (LRR1).
4311 This function is only available on IPF.
4313 @return The current value of LRR1.
4324 Writes the current value of 64-bit Page Local Interrupt ID Register (LID).
4325 No parameter checking is performed on Value. All bits of Value corresponding to
4326 reserved fields of LID must be 0 or a Reserved Register/Field fault may occur.
4327 The caller must either guarantee that Value is valid, or the caller must set up
4328 fault handlers to catch the faults.
4329 This function is only available on IPF.
4331 @param Value The 64-bit value to write to LID.
4333 @return The 64-bit value written to the LID.
4344 Writes the current value of 64-bit Task Priority Register (TPR).
4345 No parameter checking is performed on Value. All bits of Value corresponding to
4346 reserved fields of TPR must be 0 or a Reserved Register/Field fault may occur.
4347 The caller must either guarantee that Value is valid, or the caller must set up
4348 fault handlers to catch the faults.
4349 This function is only available on IPF.
4351 @param Value The 64-bit value to write to TPR.
4353 @return The 64-bit value written to the TPR.
4364 Performs a write operation on End OF External Interrupt Register (EOI).
4365 Writes a value of 0 to the EOI Register. This function is only available on IPF.
4376 Writes the current value of 64-bit Performance Monitor Vector Register (PMV).
4377 No parameter checking is performed on Value. All bits of Value corresponding
4378 to reserved fields of PMV must be 0 or a Reserved Register/Field fault may occur.
4379 The caller must either guarantee that Value is valid, or the caller must set up
4380 fault handlers to catch the faults.
4381 This function is only available on IPF.
4383 @param Value The 64-bit value to write to PMV.
4385 @return The 64-bit value written to the PMV.
4396 Writes the current value of 64-bit Corrected Machine Check Vector Register (CMCV).
4397 No parameter checking is performed on Value. All bits of Value corresponding
4398 to reserved fields of CMCV must be 0 or a Reserved Register/Field fault may occur.
4399 The caller must either guarantee that Value is valid, or the caller must set up
4400 fault handlers to catch the faults.
4401 This function is only available on IPF.
4403 @param Value The 64-bit value to write to CMCV.
4405 @return The 64-bit value written to the CMCV.
4416 Writes the current value of 64-bit Local Redirection Register #0 (LRR0).
4417 No parameter checking is performed on Value. All bits of Value corresponding
4418 to reserved fields of LRR0 must be 0 or a Reserved Register/Field fault may occur.
4419 The caller must either guarantee that Value is valid, or the caller must set up
4420 fault handlers to catch the faults.
4421 This function is only available on IPF.
4423 @param Value The 64-bit value to write to LRR0.
4425 @return The 64-bit value written to the LRR0.
4436 Writes the current value of 64-bit Local Redirection Register #1 (LRR1).
4437 No parameter checking is performed on Value. All bits of Value corresponding
4438 to reserved fields of LRR1 must be 0 or a Reserved Register/Field fault may occur.
4439 The caller must either guarantee that Value is valid, or the caller must
4440 set up fault handlers to catch the faults.
4441 This function is only available on IPF.
4443 @param Value The 64-bit value to write to LRR1.
4445 @return The 64-bit value written to the LRR1.
4456 Reads the current value of Instruction Breakpoint Register (IBR).
4458 The Instruction Breakpoint Registers are used in pairs. The even numbered
4459 registers contain breakpoint addresses, and the odd numbered registers contain
4460 breakpoint mask conditions. At least 4 instruction registers pairs are implemented
4461 on all processor models. Implemented registers are contiguous starting with
4462 register 0. No parameter checking is performed on Index, and if the Index value
4463 is beyond the implemented IBR register range, a Reserved Register/Field fault may
4464 occur. The caller must either guarantee that Index is valid, or the caller must
4465 set up fault handlers to catch the faults.
4466 This function is only available on IPF.
4468 @param Index The 8-bit Instruction Breakpoint Register index to read.
4470 @return The current value of Instruction Breakpoint Register specified by Index.
4481 Reads the current value of Data Breakpoint Register (DBR).
4483 The Data Breakpoint Registers are used in pairs. The even numbered registers
4484 contain breakpoint addresses, and odd numbered registers contain breakpoint
4485 mask conditions. At least 4 data registers pairs are implemented on all processor
4486 models. Implemented registers are contiguous starting with register 0.
4487 No parameter checking is performed on Index. If the Index value is beyond
4488 the implemented DBR register range, a Reserved Register/Field fault may occur.
4489 The caller must either guarantee that Index is valid, or the caller must set up
4490 fault handlers to catch the faults.
4491 This function is only available on IPF.
4493 @param Index The 8-bit Data Breakpoint Register index to read.
4495 @return The current value of Data Breakpoint Register specified by Index.
4506 Reads the current value of Performance Monitor Configuration Register (PMC).
4508 All processor implementations provide at least 4 performance counters
4509 (PMC/PMD [4]...PMC/PMD [7] pairs), and 4 performance monitor counter overflow
4510 status registers (PMC [0]... PMC [3]). Processor implementations may provide
4511 additional implementation-dependent PMC and PMD to increase the number of
4512 'generic' performance counters (PMC/PMD pairs). The remainder of PMC and PMD
4513 register set is implementation dependent. No parameter checking is performed
4514 on Index. If the Index value is beyond the implemented PMC register range,
4515 zero value will be returned.
4516 This function is only available on IPF.
4518 @param Index The 8-bit Performance Monitor Configuration Register index to read.
4520 @return The current value of Performance Monitor Configuration Register
4532 Reads the current value of Performance Monitor Data Register (PMD).
4534 All processor implementations provide at least 4 performance counters
4535 (PMC/PMD [4]...PMC/PMD [7] pairs), and 4 performance monitor counter
4536 overflow status registers (PMC [0]... PMC [3]). Processor implementations may
4537 provide additional implementation-dependent PMC and PMD to increase the number
4538 of 'generic' performance counters (PMC/PMD pairs). The remainder of PMC and PMD
4539 register set is implementation dependent. No parameter checking is performed
4540 on Index. If the Index value is beyond the implemented PMD register range,
4541 zero value will be returned.
4542 This function is only available on IPF.
4544 @param Index The 8-bit Performance Monitor Data Register index to read.
4546 @return The current value of Performance Monitor Data Register specified by Index.
4557 Writes the current value of 64-bit Instruction Breakpoint Register (IBR).
4559 Writes current value of Instruction Breakpoint Register specified by Index.
4560 The Instruction Breakpoint Registers are used in pairs. The even numbered
4561 registers contain breakpoint addresses, and odd numbered registers contain
4562 breakpoint mask conditions. At least 4 instruction registers pairs are implemented
4563 on all processor models. Implemented registers are contiguous starting with
4564 register 0. No parameter checking is performed on Index. If the Index value
4565 is beyond the implemented IBR register range, a Reserved Register/Field fault may
4566 occur. The caller must either guarantee that Index is valid, or the caller must
4567 set up fault handlers to catch the faults.
4568 This function is only available on IPF.
4570 @param Index The 8-bit Instruction Breakpoint Register index to write.
4571 @param Value The 64-bit value to write to IBR.
4573 @return The 64-bit value written to the IBR.
4585 Writes the current value of 64-bit Data Breakpoint Register (DBR).
4587 Writes current value of Data Breakpoint Register specified by Index.
4588 The Data Breakpoint Registers are used in pairs. The even numbered registers
4589 contain breakpoint addresses, and odd numbered registers contain breakpoint
4590 mask conditions. At least 4 data registers pairs are implemented on all processor
4591 models. Implemented registers are contiguous starting with register 0. No parameter
4592 checking is performed on Index. If the Index value is beyond the implemented
4593 DBR register range, a Reserved Register/Field fault may occur. The caller must
4594 either guarantee that Index is valid, or the caller must set up fault handlers to
4596 This function is only available on IPF.
4598 @param Index The 8-bit Data Breakpoint Register index to write.
4599 @param Value The 64-bit value to write to DBR.
4601 @return The 64-bit value written to the DBR.
4613 Writes the current value of 64-bit Performance Monitor Configuration Register (PMC).
4615 Writes current value of Performance Monitor Configuration Register specified by Index.
4616 All processor implementations provide at least 4 performance counters
4617 (PMC/PMD [4]...PMC/PMD [7] pairs), and 4 performance monitor counter overflow status
4618 registers (PMC [0]... PMC [3]). Processor implementations may provide additional
4619 implementation-dependent PMC and PMD to increase the number of 'generic' performance
4620 counters (PMC/PMD pairs). The remainder of PMC and PMD register set is implementation
4621 dependent. No parameter checking is performed on Index. If the Index value is
4622 beyond the implemented PMC register range, the write is ignored.
4623 This function is only available on IPF.
4625 @param Index The 8-bit Performance Monitor Configuration Register index to write.
4626 @param Value The 64-bit value to write to PMC.
4628 @return The 64-bit value written to the PMC.
4640 Writes the current value of 64-bit Performance Monitor Data Register (PMD).
4642 Writes current value of Performance Monitor Data Register specified by Index.
4643 All processor implementations provide at least 4 performance counters
4644 (PMC/PMD [4]...PMC/PMD [7] pairs), and 4 performance monitor counter overflow
4645 status registers (PMC [0]... PMC [3]). Processor implementations may provide
4646 additional implementation-dependent PMC and PMD to increase the number of 'generic'
4647 performance counters (PMC/PMD pairs). The remainder of PMC and PMD register set
4648 is implementation dependent. No parameter checking is performed on Index. If the
4649 Index value is beyond the implemented PMD register range, the write is ignored.
4650 This function is only available on IPF.
4652 @param Index The 8-bit Performance Monitor Data Register index to write.
4653 @param Value The 64-bit value to write to PMD.
4655 @return The 64-bit value written to the PMD.
4667 Reads the current value of 64-bit Global Pointer (GP).
4669 Reads and returns the current value of GP.
4670 This function is only available on IPF.
4672 @return The current value of GP.
4683 Write the current value of 64-bit Global Pointer (GP).
4685 Writes the current value of GP. The 64-bit value written to the GP is returned.
4686 No parameter checking is performed on Value.
4687 This function is only available on IPF.
4689 @param Value The 64-bit value to write to GP.
4691 @return The 64-bit value written to the GP.
4702 Reads the current value of 64-bit Stack Pointer (SP).
4704 Reads and returns the current value of SP.
4705 This function is only available on IPF.
4707 @return The current value of SP.
4718 /// Valid Index value for AsmReadControlRegister()
4720 #define IPF_CONTROL_REGISTER_DCR 0
4721 #define IPF_CONTROL_REGISTER_ITM 1
4722 #define IPF_CONTROL_REGISTER_IVA 2
4723 #define IPF_CONTROL_REGISTER_PTA 8
4724 #define IPF_CONTROL_REGISTER_IPSR 16
4725 #define IPF_CONTROL_REGISTER_ISR 17
4726 #define IPF_CONTROL_REGISTER_IIP 19
4727 #define IPF_CONTROL_REGISTER_IFA 20
4728 #define IPF_CONTROL_REGISTER_ITIR 21
4729 #define IPF_CONTROL_REGISTER_IIPA 22
4730 #define IPF_CONTROL_REGISTER_IFS 23
4731 #define IPF_CONTROL_REGISTER_IIM 24
4732 #define IPF_CONTROL_REGISTER_IHA 25
4733 #define IPF_CONTROL_REGISTER_LID 64
4734 #define IPF_CONTROL_REGISTER_IVR 65
4735 #define IPF_CONTROL_REGISTER_TPR 66
4736 #define IPF_CONTROL_REGISTER_EOI 67
4737 #define IPF_CONTROL_REGISTER_IRR0 68
4738 #define IPF_CONTROL_REGISTER_IRR1 69
4739 #define IPF_CONTROL_REGISTER_IRR2 70
4740 #define IPF_CONTROL_REGISTER_IRR3 71
4741 #define IPF_CONTROL_REGISTER_ITV 72
4742 #define IPF_CONTROL_REGISTER_PMV 73
4743 #define IPF_CONTROL_REGISTER_CMCV 74
4744 #define IPF_CONTROL_REGISTER_LRR0 80
4745 #define IPF_CONTROL_REGISTER_LRR1 81
4748 Reads a 64-bit control register.
4750 Reads and returns the control register specified by Index. The valid Index valued are defined
4751 above in "Related Definitions".
4752 If Index is invalid then 0xFFFFFFFFFFFFFFFF is returned. This function is only available on IPF.
4754 @param Index The index of the control register to read.
4756 @return The control register specified by Index.
4761 AsmReadControlRegister (
4767 /// Valid Index value for AsmReadApplicationRegister()
4769 #define IPF_APPLICATION_REGISTER_K0 0
4770 #define IPF_APPLICATION_REGISTER_K1 1
4771 #define IPF_APPLICATION_REGISTER_K2 2
4772 #define IPF_APPLICATION_REGISTER_K3 3
4773 #define IPF_APPLICATION_REGISTER_K4 4
4774 #define IPF_APPLICATION_REGISTER_K5 5
4775 #define IPF_APPLICATION_REGISTER_K6 6
4776 #define IPF_APPLICATION_REGISTER_K7 7
4777 #define IPF_APPLICATION_REGISTER_RSC 16
4778 #define IPF_APPLICATION_REGISTER_BSP 17
4779 #define IPF_APPLICATION_REGISTER_BSPSTORE 18
4780 #define IPF_APPLICATION_REGISTER_RNAT 19
4781 #define IPF_APPLICATION_REGISTER_FCR 21
4782 #define IPF_APPLICATION_REGISTER_EFLAG 24
4783 #define IPF_APPLICATION_REGISTER_CSD 25
4784 #define IPF_APPLICATION_REGISTER_SSD 26
4785 #define IPF_APPLICATION_REGISTER_CFLG 27
4786 #define IPF_APPLICATION_REGISTER_FSR 28
4787 #define IPF_APPLICATION_REGISTER_FIR 29
4788 #define IPF_APPLICATION_REGISTER_FDR 30
4789 #define IPF_APPLICATION_REGISTER_CCV 32
4790 #define IPF_APPLICATION_REGISTER_UNAT 36
4791 #define IPF_APPLICATION_REGISTER_FPSR 40
4792 #define IPF_APPLICATION_REGISTER_ITC 44
4793 #define IPF_APPLICATION_REGISTER_PFS 64
4794 #define IPF_APPLICATION_REGISTER_LC 65
4795 #define IPF_APPLICATION_REGISTER_EC 66
4798 Reads a 64-bit application register.
4800 Reads and returns the application register specified by Index. The valid Index valued are defined
4801 above in "Related Definitions".
4802 If Index is invalid then 0xFFFFFFFFFFFFFFFF is returned. This function is only available on IPF.
4804 @param Index The index of the application register to read.
4806 @return The application register specified by Index.
4811 AsmReadApplicationRegister (
4817 Determines if the CPU is currently executing in virtual, physical, or mixed mode.
4819 Determines the current execution mode of the CPU.
4820 If the CPU is in virtual mode(PSR.RT=1, PSR.DT=1, PSR.IT=1), then 1 is returned.
4821 If the CPU is in physical mode(PSR.RT=0, PSR.DT=0, PSR.IT=0), then 0 is returned.
4822 If the CPU is not in physical mode or virtual mode, then it is in mixed mode,
4824 This function is only available on IPF.
4826 @retval 1 The CPU is in virtual mode.
4827 @retval 0 The CPU is in physical mode.
4828 @retval -1 The CPU is in mixed mode.
4839 Makes a PAL procedure call.
4841 This is a wrapper function to make a PAL procedure call. Based on the Index
4842 value this API will make static or stacked PAL call. The following table
4843 describes the usage of PAL Procedure Index Assignment. Architected procedures
4844 may be designated as required or optional. If a PAL procedure is specified
4845 as optional, a unique return code of 0xFFFFFFFFFFFFFFFF is returned in the
4846 Status field of the PAL_CALL_RETURN structure.
4847 This indicates that the procedure is not present in this PAL implementation.
4848 It is the caller's responsibility to check for this return code after calling
4849 any optional PAL procedure.
4850 No parameter checking is performed on the 5 input parameters, but there are
4851 some common rules that the caller should follow when making a PAL call. Any
4852 address passed to PAL as buffers for return parameters must be 8-byte aligned.
4853 Unaligned addresses may cause undefined results. For those parameters defined
4854 as reserved or some fields defined as reserved must be zero filled or the invalid
4855 argument return value may be returned or undefined result may occur during the
4856 execution of the procedure. If the PalEntryPoint does not point to a valid
4857 PAL entry point then the system behavior is undefined. This function is only
4860 @param PalEntryPoint The PAL procedure calls entry point.
4861 @param Index The PAL procedure Index number.
4862 @param Arg2 The 2nd parameter for PAL procedure calls.
4863 @param Arg3 The 3rd parameter for PAL procedure calls.
4864 @param Arg4 The 4th parameter for PAL procedure calls.
4866 @return structure returned from the PAL Call procedure, including the status and return value.
4872 IN UINT64 PalEntryPoint
,
4880 #elif defined (MDE_CPU_IA32) || defined (MDE_CPU_X64)
4882 /// IA32 and x64 Specific Functions
4883 /// Byte packed structure for 16-bit Real Mode EFLAGS
4887 UINT32 CF
:1; /// Carry Flag
4888 UINT32 Reserved_0
:1; /// Reserved
4889 UINT32 PF
:1; /// Parity Flag
4890 UINT32 Reserved_1
:1; /// Reserved
4891 UINT32 AF
:1; /// Auxiliary Carry Flag
4892 UINT32 Reserved_2
:1; /// Reserved
4893 UINT32 ZF
:1; /// Zero Flag
4894 UINT32 SF
:1; /// Sign Flag
4895 UINT32 TF
:1; /// Trap Flag
4896 UINT32 IF
:1; /// Interrupt Enable Flag
4897 UINT32 DF
:1; /// Direction Flag
4898 UINT32 OF
:1; /// Overflow Flag
4899 UINT32 IOPL
:2; /// I/O Privilege Level
4900 UINT32 NT
:1; /// Nested Task
4901 UINT32 Reserved_3
:1; /// Reserved
4907 /// Byte packed structure for EFLAGS/RFLAGS
4908 /// 32-bits on IA-32
4909 /// 64-bits on x64. The upper 32-bits on x64 are reserved
4913 UINT32 CF
:1; /// Carry Flag
4914 UINT32 Reserved_0
:1; /// Reserved
4915 UINT32 PF
:1; /// Parity Flag
4916 UINT32 Reserved_1
:1; /// Reserved
4917 UINT32 AF
:1; /// Auxiliary Carry Flag
4918 UINT32 Reserved_2
:1; /// Reserved
4919 UINT32 ZF
:1; /// Zero Flag
4920 UINT32 SF
:1; /// Sign Flag
4921 UINT32 TF
:1; /// Trap Flag
4922 UINT32 IF
:1; /// Interrupt Enable Flag
4923 UINT32 DF
:1; /// Direction Flag
4924 UINT32 OF
:1; /// Overflow Flag
4925 UINT32 IOPL
:2; /// I/O Privilege Level
4926 UINT32 NT
:1; /// Nested Task
4927 UINT32 Reserved_3
:1; /// Reserved
4928 UINT32 RF
:1; /// Resume Flag
4929 UINT32 VM
:1; /// Virtual 8086 Mode
4930 UINT32 AC
:1; /// Alignment Check
4931 UINT32 VIF
:1; /// Virtual Interrupt Flag
4932 UINT32 VIP
:1; /// Virtual Interrupt Pending
4933 UINT32 ID
:1; /// ID Flag
4934 UINT32 Reserved_4
:10; /// Reserved
4940 /// Byte packed structure for Control Register 0 (CR0)
4941 /// 32-bits on IA-32
4942 /// 64-bits on x64. The upper 32-bits on x64 are reserved
4946 UINT32 PE
:1; /// Protection Enable
4947 UINT32 MP
:1; /// Monitor Coprocessor
4948 UINT32 EM
:1; /// Emulation
4949 UINT32 TS
:1; /// Task Switched
4950 UINT32 ET
:1; /// Extension Type
4951 UINT32 NE
:1; /// Numeric Error
4952 UINT32 Reserved_0
:10; /// Reserved
4953 UINT32 WP
:1; /// Write Protect
4954 UINT32 Reserved_1
:1; /// Reserved
4955 UINT32 AM
:1; /// Alignment Mask
4956 UINT32 Reserved_2
:10; /// Reserved
4957 UINT32 NW
:1; /// Mot Write-through
4958 UINT32 CD
:1; /// Cache Disable
4959 UINT32 PG
:1; /// Paging
4965 /// Byte packed structure for Control Register 4 (CR4)
4966 /// 32-bits on IA-32
4967 /// 64-bits on x64. The upper 32-bits on x64 are reserved
4971 UINT32 VME
:1; /// Virtual-8086 Mode Extensions
4972 UINT32 PVI
:1; /// Protected-Mode Virtual Interrupts
4973 UINT32 TSD
:1; /// Time Stamp Disable
4974 UINT32 DE
:1; /// Debugging Extensions
4975 UINT32 PSE
:1; /// Page Size Extensions
4976 UINT32 PAE
:1; /// Physical Address Extension
4977 UINT32 MCE
:1; /// Machine Check Enable
4978 UINT32 PGE
:1; /// Page Global Enable
4979 UINT32 PCE
:1; /// Performance Monitoring Counter
4981 UINT32 OSFXSR
:1; /// Operating System Support for
4982 /// FXSAVE and FXRSTOR instructions
4983 UINT32 OSXMMEXCPT
:1; /// Operating System Support for
4984 /// Unmasked SIMD Floating Point
4986 UINT32 Reserved_0
:2; /// Reserved
4987 UINT32 VMXE
:1; /// VMX Enable
4988 UINT32 Reserved_1
:18; /// Reseved
4994 /// Byte packed structure for an IDTR, GDTR, LDTR descriptor
5003 #define IA32_IDT_GATE_TYPE_TASK 0x85
5004 #define IA32_IDT_GATE_TYPE_INTERRUPT_16 0x86
5005 #define IA32_IDT_GATE_TYPE_TRAP_16 0x87
5006 #define IA32_IDT_GATE_TYPE_INTERRUPT_32 0x8E
5007 #define IA32_IDT_GATE_TYPE_TRAP_32 0x8F
5010 /// Byte packed structure for an Interrupt Gate Descriptor
5012 #if defined (MDE_CPU_IA32)
5016 UINT32 OffsetLow
:16; // Offset bits 15..0
5017 UINT32 Selector
:16; // Selector
5018 UINT32 Reserved_0
:8; // Reserved
5019 UINT32 GateType
:8; // Gate Type. See #defines above
5020 UINT32 OffsetHigh
:16; // Offset bits 31..16
5023 } IA32_IDT_GATE_DESCRIPTOR
;
5027 #if defined (MDE_CPU_X64)
5031 UINT32 OffsetLow
:16; // Offset bits 15..0
5032 UINT32 Selector
:16; // Selector
5033 UINT32 Reserved_0
:8; // Reserved
5034 UINT32 GateType
:8; // Gate Type. See #defines above
5035 UINT32 OffsetHigh
:16; // Offset bits 31..16
5036 UINT32 OffsetUpper
:32; // Offset bits 63..32
5037 UINT32 Reserved_1
:32; // Reserved
5041 } IA32_IDT_GATE_DESCRIPTOR
;
5046 /// Byte packed structure for an FP/SSE/SSE2 context
5053 /// Structures for the 16-bit real mode thunks
5106 IA32_EFLAGS32 EFLAGS
;
5116 } IA32_REGISTER_SET
;
5119 /// Byte packed structure for an 16-bit real mode thunks
5122 IA32_REGISTER_SET
*RealModeState
;
5123 VOID
*RealModeBuffer
;
5124 UINT32 RealModeBufferSize
;
5125 UINT32 ThunkAttributes
;
5128 #define THUNK_ATTRIBUTE_BIG_REAL_MODE 0x00000001
5129 #define THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 0x00000002
5130 #define THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL 0x00000004
5133 Retrieves CPUID information.
5135 Executes the CPUID instruction with EAX set to the value specified by Index.
5136 This function always returns Index.
5137 If Eax is not NULL, then the value of EAX after CPUID is returned in Eax.
5138 If Ebx is not NULL, then the value of EBX after CPUID is returned in Ebx.
5139 If Ecx is not NULL, then the value of ECX after CPUID is returned in Ecx.
5140 If Edx is not NULL, then the value of EDX after CPUID is returned in Edx.
5141 This function is only available on IA-32 and x64.
5143 @param Index The 32-bit value to load into EAX prior to invoking the CPUID
5145 @param Eax Pointer to the 32-bit EAX value returned by the CPUID
5146 instruction. This is an optional parameter that may be NULL.
5147 @param Ebx Pointer to the 32-bit EBX value returned by the CPUID
5148 instruction. This is an optional parameter that may be NULL.
5149 @param Ecx Pointer to the 32-bit ECX value returned by the CPUID
5150 instruction. This is an optional parameter that may be NULL.
5151 @param Edx Pointer to the 32-bit EDX value returned by the CPUID
5152 instruction. This is an optional parameter that may be NULL.
5161 OUT UINT32
*Eax
, OPTIONAL
5162 OUT UINT32
*Ebx
, OPTIONAL
5163 OUT UINT32
*Ecx
, OPTIONAL
5164 OUT UINT32
*Edx OPTIONAL
5169 Retrieves CPUID information using an extended leaf identifier.
5171 Executes the CPUID instruction with EAX set to the value specified by Index
5172 and ECX set to the value specified by SubIndex. This function always returns
5173 Index. This function is only available on IA-32 and x64.
5175 If Eax is not NULL, then the value of EAX after CPUID is returned in Eax.
5176 If Ebx is not NULL, then the value of EBX after CPUID is returned in Ebx.
5177 If Ecx is not NULL, then the value of ECX after CPUID is returned in Ecx.
5178 If Edx is not NULL, then the value of EDX after CPUID is returned in Edx.
5180 @param Index The 32-bit value to load into EAX prior to invoking the
5182 @param SubIndex The 32-bit value to load into ECX prior to invoking the
5184 @param Eax Pointer to the 32-bit EAX value returned by the CPUID
5185 instruction. This is an optional parameter that may be
5187 @param Ebx Pointer to the 32-bit EBX value returned by the CPUID
5188 instruction. This is an optional parameter that may be
5190 @param Ecx Pointer to the 32-bit ECX value returned by the CPUID
5191 instruction. This is an optional parameter that may be
5193 @param Edx Pointer to the 32-bit EDX value returned by the CPUID
5194 instruction. This is an optional parameter that may be
5205 OUT UINT32
*Eax
, OPTIONAL
5206 OUT UINT32
*Ebx
, OPTIONAL
5207 OUT UINT32
*Ecx
, OPTIONAL
5208 OUT UINT32
*Edx OPTIONAL
5213 Set CD bit and clear NW bit of CR0 followed by a WBINVD.
5215 Disables the caches by setting the CD bit of CR0 to 1, clearing the NW bit of CR0 to 0,
5216 and executing a WBINVD instruction. This function is only available on IA-32 and x64.
5227 Perform a WBINVD and clear both the CD and NW bits of CR0.
5229 Enables the caches by executing a WBINVD instruction and then clear both the CD and NW
5230 bits of CR0 to 0. This function is only available on IA-32 and x64.
5241 Returns the lower 32-bits of a Machine Specific Register(MSR).
5243 Reads and returns the lower 32-bits of the MSR specified by Index.
5244 No parameter checking is performed on Index, and some Index values may cause
5245 CPU exceptions. The caller must either guarantee that Index is valid, or the
5246 caller must set up exception handlers to catch the exceptions. This function
5247 is only available on IA-32 and x64.
5249 @param Index The 32-bit MSR index to read.
5251 @return The lower 32 bits of the MSR identified by Index.
5262 Writes a 32-bit value to a Machine Specific Register(MSR), and returns the value.
5263 The upper 32-bits of the MSR are set to zero.
5265 Writes the 32-bit value specified by Value to the MSR specified by Index. The
5266 upper 32-bits of the MSR write are set to zero. The 32-bit value written to
5267 the MSR is returned. No parameter checking is performed on Index or Value,
5268 and some of these may cause CPU exceptions. The caller must either guarantee
5269 that Index and Value are valid, or the caller must establish proper exception
5270 handlers. This function is only available on IA-32 and x64.
5272 @param Index The 32-bit MSR index to write.
5273 @param Value The 32-bit value to write to the MSR.
5287 Reads a 64-bit MSR, performs a bitwise OR on the lower 32-bits, and
5288 writes the result back to the 64-bit MSR.
5290 Reads the 64-bit MSR specified by Index, performs a bitwise OR
5291 between the lower 32-bits of the read result and the value specified by
5292 OrData, and writes the result to the 64-bit MSR specified by Index. The lower
5293 32-bits of the value written to the MSR is returned. No parameter checking is
5294 performed on Index or OrData, and some of these may cause CPU exceptions. The
5295 caller must either guarantee that Index and OrData are valid, or the caller
5296 must establish proper exception handlers. This function is only available on
5299 @param Index The 32-bit MSR index to write.
5300 @param OrData The value to OR with the read value from the MSR.
5302 @return The lower 32-bit value written to the MSR.
5314 Reads a 64-bit MSR, performs a bitwise AND on the lower 32-bits, and writes
5315 the result back to the 64-bit MSR.
5317 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
5318 lower 32-bits of the read result and the value specified by AndData, and
5319 writes the result to the 64-bit MSR specified by Index. The lower 32-bits of
5320 the value written to the MSR is returned. No parameter checking is performed
5321 on Index or AndData, and some of these may cause CPU exceptions. The caller
5322 must either guarantee that Index and AndData are valid, or the caller must
5323 establish proper exception handlers. This function is only available on IA-32
5326 @param Index The 32-bit MSR index to write.
5327 @param AndData The value to AND with the read value from the MSR.
5329 @return The lower 32-bit value written to the MSR.
5341 Reads a 64-bit MSR, performs a bitwise AND followed by a bitwise OR
5342 on the lower 32-bits, and writes the result back to the 64-bit MSR.
5344 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
5345 lower 32-bits of the read result and the value specified by AndData
5346 preserving the upper 32-bits, performs a bitwise OR between the
5347 result of the AND operation and the value specified by OrData, and writes the
5348 result to the 64-bit MSR specified by Address. The lower 32-bits of the value
5349 written to the MSR is returned. No parameter checking is performed on Index,
5350 AndData, or OrData, and some of these may cause CPU exceptions. The caller
5351 must either guarantee that Index, AndData, and OrData are valid, or the
5352 caller must establish proper exception handlers. This function is only
5353 available on IA-32 and x64.
5355 @param Index The 32-bit MSR index to write.
5356 @param AndData The value to AND with the read value from the MSR.
5357 @param OrData The value to OR with the result of the AND operation.
5359 @return The lower 32-bit value written to the MSR.
5372 Reads a bit field of an MSR.
5374 Reads the bit field in the lower 32-bits of a 64-bit MSR. The bit field is
5375 specified by the StartBit and the EndBit. The value of the bit field is
5376 returned. The caller must either guarantee that Index is valid, or the caller
5377 must set up exception handlers to catch the exceptions. This function is only
5378 available on IA-32 and x64.
5380 If StartBit is greater than 31, then ASSERT().
5381 If EndBit is greater than 31, then ASSERT().
5382 If EndBit is less than StartBit, then ASSERT().
5384 @param Index The 32-bit MSR index to read.
5385 @param StartBit The ordinal of the least significant bit in the bit field.
5387 @param EndBit The ordinal of the most significant bit in the bit field.
5390 @return The bit field read from the MSR.
5395 AsmMsrBitFieldRead32 (
5403 Writes a bit field to an MSR.
5405 Writes Value to a bit field in the lower 32-bits of a 64-bit MSR. The bit
5406 field is specified by the StartBit and the EndBit. All other bits in the
5407 destination MSR are preserved. The lower 32-bits of the MSR written is
5408 returned. The caller must either guarantee that Index and the data written
5409 is valid, or the caller must set up exception handlers to catch the exceptions.
5410 This function is only available on IA-32 and x64.
5412 If StartBit is greater than 31, then ASSERT().
5413 If EndBit is greater than 31, then ASSERT().
5414 If EndBit is less than StartBit, then ASSERT().
5416 @param Index The 32-bit MSR index to write.
5417 @param StartBit The ordinal of the least significant bit in the bit field.
5419 @param EndBit The ordinal of the most significant bit in the bit field.
5421 @param Value New value of the bit field.
5423 @return The lower 32-bit of the value written to the MSR.
5428 AsmMsrBitFieldWrite32 (
5437 Reads a bit field in a 64-bit MSR, performs a bitwise OR, and writes the
5438 result back to the bit field in the 64-bit MSR.
5440 Reads the 64-bit MSR specified by Index, performs a bitwise OR
5441 between the read result and the value specified by OrData, and writes the
5442 result to the 64-bit MSR specified by Index. The lower 32-bits of the value
5443 written to the MSR are returned. Extra left bits in OrData are stripped. The
5444 caller must either guarantee that Index and the data written is valid, or
5445 the caller must set up exception handlers to catch the exceptions. This
5446 function is only available on IA-32 and x64.
5448 If StartBit is greater than 31, then ASSERT().
5449 If EndBit is greater than 31, then ASSERT().
5450 If EndBit is less than StartBit, then ASSERT().
5452 @param Index The 32-bit MSR index to write.
5453 @param StartBit The ordinal of the least significant bit in the bit field.
5455 @param EndBit The ordinal of the most significant bit in the bit field.
5457 @param OrData The value to OR with the read value from the MSR.
5459 @return The lower 32-bit of the value written to the MSR.
5464 AsmMsrBitFieldOr32 (
5473 Reads a bit field in a 64-bit MSR, performs a bitwise AND, and writes the
5474 result back to the bit field in the 64-bit MSR.
5476 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
5477 read result and the value specified by AndData, and writes the result to the
5478 64-bit MSR specified by Index. The lower 32-bits of the value written to the
5479 MSR are returned. Extra left bits in AndData are stripped. The caller must
5480 either guarantee that Index and the data written is valid, or the caller must
5481 set up exception handlers to catch the exceptions. This function is only
5482 available on IA-32 and x64.
5484 If StartBit is greater than 31, then ASSERT().
5485 If EndBit is greater than 31, then ASSERT().
5486 If EndBit is less than StartBit, then ASSERT().
5488 @param Index The 32-bit MSR index to write.
5489 @param StartBit The ordinal of the least significant bit in the bit field.
5491 @param EndBit The ordinal of the most significant bit in the bit field.
5493 @param AndData The value to AND with the read value from the MSR.
5495 @return The lower 32-bit of the value written to the MSR.
5500 AsmMsrBitFieldAnd32 (
5509 Reads a bit field in a 64-bit MSR, performs a bitwise AND followed by a
5510 bitwise OR, and writes the result back to the bit field in the
5513 Reads the 64-bit MSR specified by Index, performs a bitwise AND followed by a
5514 bitwise OR between the read result and the value specified by
5515 AndData, and writes the result to the 64-bit MSR specified by Index. The
5516 lower 32-bits of the value written to the MSR are returned. Extra left bits
5517 in both AndData and OrData are stripped. The caller must either guarantee
5518 that Index and the data written is valid, or the caller must set up exception
5519 handlers to catch the exceptions. This function is only available on IA-32
5522 If StartBit is greater than 31, then ASSERT().
5523 If EndBit is greater than 31, then ASSERT().
5524 If EndBit is less than StartBit, then ASSERT().
5526 @param Index The 32-bit MSR index to write.
5527 @param StartBit The ordinal of the least significant bit in the bit field.
5529 @param EndBit The ordinal of the most significant bit in the bit field.
5531 @param AndData The value to AND with the read value from the MSR.
5532 @param OrData The value to OR with the result of the AND operation.
5534 @return The lower 32-bit of the value written to the MSR.
5539 AsmMsrBitFieldAndThenOr32 (
5549 Returns a 64-bit Machine Specific Register(MSR).
5551 Reads and returns the 64-bit MSR specified by Index. No parameter checking is
5552 performed on Index, and some Index values may cause CPU exceptions. The
5553 caller must either guarantee that Index is valid, or the caller must set up
5554 exception handlers to catch the exceptions. This function is only available
5557 @param Index The 32-bit MSR index to read.
5559 @return The value of the MSR identified by Index.
5570 Writes a 64-bit value to a Machine Specific Register(MSR), and returns the
5573 Writes the 64-bit value specified by Value to the MSR specified by Index. The
5574 64-bit value written to the MSR is returned. No parameter checking is
5575 performed on Index or Value, and some of these may cause CPU exceptions. The
5576 caller must either guarantee that Index and Value are valid, or the caller
5577 must establish proper exception handlers. This function is only available on
5580 @param Index The 32-bit MSR index to write.
5581 @param Value The 64-bit value to write to the MSR.
5595 Reads a 64-bit MSR, performs a bitwise OR, and writes the result
5596 back to the 64-bit MSR.
5598 Reads the 64-bit MSR specified by Index, performs a bitwise OR
5599 between the read result and the value specified by OrData, and writes the
5600 result to the 64-bit MSR specified by Index. The value written to the MSR is
5601 returned. No parameter checking is performed on Index or OrData, and some of
5602 these may cause CPU exceptions. The caller must either guarantee that Index
5603 and OrData are valid, or the caller must establish proper exception handlers.
5604 This function is only available on IA-32 and x64.
5606 @param Index The 32-bit MSR index to write.
5607 @param OrData The value to OR with the read value from the MSR.
5609 @return The value written back to the MSR.
5621 Reads a 64-bit MSR, performs a bitwise AND, and writes the result back to the
5624 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
5625 read result and the value specified by OrData, and writes the result to the
5626 64-bit MSR specified by Index. The value written to the MSR is returned. No
5627 parameter checking is performed on Index or OrData, and some of these may
5628 cause CPU exceptions. The caller must either guarantee that Index and OrData
5629 are valid, or the caller must establish proper exception handlers. This
5630 function is only available on IA-32 and x64.
5632 @param Index The 32-bit MSR index to write.
5633 @param AndData The value to AND with the read value from the MSR.
5635 @return The value written back to the MSR.
5647 Reads a 64-bit MSR, performs a bitwise AND followed by a bitwise
5648 OR, and writes the result back to the 64-bit MSR.
5650 Reads the 64-bit MSR specified by Index, performs a bitwise AND between read
5651 result and the value specified by AndData, performs a bitwise OR
5652 between the result of the AND operation and the value specified by OrData,
5653 and writes the result to the 64-bit MSR specified by Index. The value written
5654 to the MSR is returned. No parameter checking is performed on Index, AndData,
5655 or OrData, and some of these may cause CPU exceptions. The caller must either
5656 guarantee that Index, AndData, and OrData are valid, or the caller must
5657 establish proper exception handlers. This function is only available on IA-32
5660 @param Index The 32-bit MSR index to write.
5661 @param AndData The value to AND with the read value from the MSR.
5662 @param OrData The value to OR with the result of the AND operation.
5664 @return The value written back to the MSR.
5677 Reads a bit field of an MSR.
5679 Reads the bit field in the 64-bit MSR. The bit field is specified by the
5680 StartBit and the EndBit. The value of the bit field is returned. The caller
5681 must either guarantee that Index is valid, or the caller must set up
5682 exception handlers to catch the exceptions. This function is only available
5685 If StartBit is greater than 63, then ASSERT().
5686 If EndBit is greater than 63, then ASSERT().
5687 If EndBit is less than StartBit, then ASSERT().
5689 @param Index The 32-bit MSR index to read.
5690 @param StartBit The ordinal of the least significant bit in the bit field.
5692 @param EndBit The ordinal of the most significant bit in the bit field.
5695 @return The value read from the MSR.
5700 AsmMsrBitFieldRead64 (
5708 Writes a bit field to an MSR.
5710 Writes Value to a bit field in a 64-bit MSR. The bit field is specified by
5711 the StartBit and the EndBit. All other bits in the destination MSR are
5712 preserved. The MSR written is returned. The caller must either guarantee
5713 that Index and the data written is valid, or the caller must set up exception
5714 handlers to catch the exceptions. This function is only available on IA-32 and x64.
5716 If StartBit is greater than 63, then ASSERT().
5717 If EndBit is greater than 63, then ASSERT().
5718 If EndBit is less than StartBit, then ASSERT().
5720 @param Index The 32-bit MSR index to write.
5721 @param StartBit The ordinal of the least significant bit in the bit field.
5723 @param EndBit The ordinal of the most significant bit in the bit field.
5725 @param Value New value of the bit field.
5727 @return The value written back to the MSR.
5732 AsmMsrBitFieldWrite64 (
5741 Reads a bit field in a 64-bit MSR, performs a bitwise OR, and
5742 writes the result back to the bit field in the 64-bit MSR.
5744 Reads the 64-bit MSR specified by Index, performs a bitwise OR
5745 between the read result and the value specified by OrData, and writes the
5746 result to the 64-bit MSR specified by Index. The value written to the MSR is
5747 returned. Extra left bits in OrData are stripped. The caller must either
5748 guarantee that Index and the data written is valid, or the caller must set up
5749 exception handlers to catch the exceptions. This function is only available
5752 If StartBit is greater than 63, then ASSERT().
5753 If EndBit is greater than 63, then ASSERT().
5754 If EndBit is less than StartBit, then ASSERT().
5756 @param Index The 32-bit MSR index to write.
5757 @param StartBit The ordinal of the least significant bit in the bit field.
5759 @param EndBit The ordinal of the most significant bit in the bit field.
5761 @param OrData The value to OR with the read value from the bit field.
5763 @return The value written back to the MSR.
5768 AsmMsrBitFieldOr64 (
5777 Reads a bit field in a 64-bit MSR, performs a bitwise AND, and writes the
5778 result back to the bit field in the 64-bit MSR.
5780 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
5781 read result and the value specified by AndData, and writes the result to the
5782 64-bit MSR specified by Index. The value written to the MSR is returned.
5783 Extra left bits in AndData are stripped. The caller must either guarantee
5784 that Index and the data written is valid, or the caller must set up exception
5785 handlers to catch the exceptions. This function is only available on IA-32
5788 If StartBit is greater than 63, then ASSERT().
5789 If EndBit is greater than 63, then ASSERT().
5790 If EndBit is less than StartBit, then ASSERT().
5792 @param Index The 32-bit MSR index to write.
5793 @param StartBit The ordinal of the least significant bit in the bit field.
5795 @param EndBit The ordinal of the most significant bit in the bit field.
5797 @param AndData The value to AND with the read value from the bit field.
5799 @return The value written back to the MSR.
5804 AsmMsrBitFieldAnd64 (
5813 Reads a bit field in a 64-bit MSR, performs a bitwise AND followed by a
5814 bitwise OR, and writes the result back to the bit field in the
5817 Reads the 64-bit MSR specified by Index, performs a bitwise AND followed by
5818 a bitwise OR between the read result and the value specified by
5819 AndData, and writes the result to the 64-bit MSR specified by Index. The
5820 value written to the MSR is returned. Extra left bits in both AndData and
5821 OrData are stripped. The caller must either guarantee that Index and the data
5822 written is valid, or the caller must set up exception handlers to catch the
5823 exceptions. This function is only available on IA-32 and x64.
5825 If StartBit is greater than 63, then ASSERT().
5826 If EndBit is greater than 63, then ASSERT().
5827 If EndBit is less than StartBit, then ASSERT().
5829 @param Index The 32-bit MSR index to write.
5830 @param StartBit The ordinal of the least significant bit in the bit field.
5832 @param EndBit The ordinal of the most significant bit in the bit field.
5834 @param AndData The value to AND with the read value from the bit field.
5835 @param OrData The value to OR with the result of the AND operation.
5837 @return The value written back to the MSR.
5842 AsmMsrBitFieldAndThenOr64 (
5852 Reads the current value of the EFLAGS register.
5854 Reads and returns the current value of the EFLAGS register. This function is
5855 only available on IA-32 and x64. This returns a 32-bit value on IA-32 and a
5856 64-bit value on x64.
5858 @return EFLAGS on IA-32 or RFLAGS on x64.
5869 Reads the current value of the Control Register 0 (CR0).
5871 Reads and returns the current value of CR0. This function is only available
5872 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
5875 @return The value of the Control Register 0 (CR0).
5886 Reads the current value of the Control Register 2 (CR2).
5888 Reads and returns the current value of CR2. This function is only available
5889 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
5892 @return The value of the Control Register 2 (CR2).
5903 Reads the current value of the Control Register 3 (CR3).
5905 Reads and returns the current value of CR3. This function is only available
5906 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
5909 @return The value of the Control Register 3 (CR3).
5920 Reads the current value of the Control Register 4 (CR4).
5922 Reads and returns the current value of CR4. This function is only available
5923 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
5926 @return The value of the Control Register 4 (CR4).
5937 Writes a value to Control Register 0 (CR0).
5939 Writes and returns a new value to CR0. This function is only available on
5940 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
5942 @param Cr0 The value to write to CR0.
5944 @return The value written to CR0.
5955 Writes a value to Control Register 2 (CR2).
5957 Writes and returns a new value to CR2. This function is only available on
5958 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
5960 @param Cr2 The value to write to CR2.
5962 @return The value written to CR2.
5973 Writes a value to Control Register 3 (CR3).
5975 Writes and returns a new value to CR3. This function is only available on
5976 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
5978 @param Cr3 The value to write to CR3.
5980 @return The value written to CR3.
5991 Writes a value to Control Register 4 (CR4).
5993 Writes and returns a new value to CR4. This function is only available on
5994 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
5996 @param Cr4 The value to write to CR4.
5998 @return The value written to CR4.
6009 Reads the current value of Debug Register 0 (DR0).
6011 Reads and returns the current value of DR0. This function is only available
6012 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
6015 @return The value of Debug Register 0 (DR0).
6026 Reads the current value of Debug Register 1 (DR1).
6028 Reads and returns the current value of DR1. This function is only available
6029 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
6032 @return The value of Debug Register 1 (DR1).
6043 Reads the current value of Debug Register 2 (DR2).
6045 Reads and returns the current value of DR2. This function is only available
6046 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
6049 @return The value of Debug Register 2 (DR2).
6060 Reads the current value of Debug Register 3 (DR3).
6062 Reads and returns the current value of DR3. This function is only available
6063 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
6066 @return The value of Debug Register 3 (DR3).
6077 Reads the current value of Debug Register 4 (DR4).
6079 Reads and returns the current value of DR4. This function is only available
6080 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
6083 @return The value of Debug Register 4 (DR4).
6094 Reads the current value of Debug Register 5 (DR5).
6096 Reads and returns the current value of DR5. This function is only available
6097 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
6100 @return The value of Debug Register 5 (DR5).
6111 Reads the current value of Debug Register 6 (DR6).
6113 Reads and returns the current value of DR6. This function is only available
6114 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
6117 @return The value of Debug Register 6 (DR6).
6128 Reads the current value of Debug Register 7 (DR7).
6130 Reads and returns the current value of DR7. This function is only available
6131 on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
6134 @return The value of Debug Register 7 (DR7).
6145 Writes a value to Debug Register 0 (DR0).
6147 Writes and returns a new value to DR0. This function is only available on
6148 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
6150 @param Dr0 The value to write to Dr0.
6152 @return The value written to Debug Register 0 (DR0).
6163 Writes a value to Debug Register 1 (DR1).
6165 Writes and returns a new value to DR1. This function is only available on
6166 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
6168 @param Dr1 The value to write to Dr1.
6170 @return The value written to Debug Register 1 (DR1).
6181 Writes a value to Debug Register 2 (DR2).
6183 Writes and returns a new value to DR2. This function is only available on
6184 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
6186 @param Dr2 The value to write to Dr2.
6188 @return The value written to Debug Register 2 (DR2).
6199 Writes a value to Debug Register 3 (DR3).
6201 Writes and returns a new value to DR3. This function is only available on
6202 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
6204 @param Dr3 The value to write to Dr3.
6206 @return The value written to Debug Register 3 (DR3).
6217 Writes a value to Debug Register 4 (DR4).
6219 Writes and returns a new value to DR4. This function is only available on
6220 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
6222 @param Dr4 The value to write to Dr4.
6224 @return The value written to Debug Register 4 (DR4).
6235 Writes a value to Debug Register 5 (DR5).
6237 Writes and returns a new value to DR5. This function is only available on
6238 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
6240 @param Dr5 The value to write to Dr5.
6242 @return The value written to Debug Register 5 (DR5).
6253 Writes a value to Debug Register 6 (DR6).
6255 Writes and returns a new value to DR6. This function is only available on
6256 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
6258 @param Dr6 The value to write to Dr6.
6260 @return The value written to Debug Register 6 (DR6).
6271 Writes a value to Debug Register 7 (DR7).
6273 Writes and returns a new value to DR7. This function is only available on
6274 IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
6276 @param Dr7 The value to write to Dr7.
6278 @return The value written to Debug Register 7 (DR7).
6289 Reads the current value of Code Segment Register (CS).
6291 Reads and returns the current value of CS. This function is only available on
6294 @return The current value of CS.
6305 Reads the current value of Data Segment Register (DS).
6307 Reads and returns the current value of DS. This function is only available on
6310 @return The current value of DS.
6321 Reads the current value of Extra Segment Register (ES).
6323 Reads and returns the current value of ES. This function is only available on
6326 @return The current value of ES.
6337 Reads the current value of FS Data Segment Register (FS).
6339 Reads and returns the current value of FS. This function is only available on
6342 @return The current value of FS.
6353 Reads the current value of GS Data Segment Register (GS).
6355 Reads and returns the current value of GS. This function is only available on
6358 @return The current value of GS.
6369 Reads the current value of Stack Segment Register (SS).
6371 Reads and returns the current value of SS. This function is only available on
6374 @return The current value of SS.
6385 Reads the current value of Task Register (TR).
6387 Reads and returns the current value of TR. This function is only available on
6390 @return The current value of TR.
6401 Reads the current Global Descriptor Table Register(GDTR) descriptor.
6403 Reads and returns the current GDTR descriptor and returns it in Gdtr. This
6404 function is only available on IA-32 and x64.
6406 If Gdtr is NULL, then ASSERT().
6408 @param Gdtr Pointer to a GDTR descriptor.
6414 OUT IA32_DESCRIPTOR
*Gdtr
6419 Writes the current Global Descriptor Table Register (GDTR) descriptor.
6421 Writes and the current GDTR descriptor specified by Gdtr. This function is
6422 only available on IA-32 and x64.
6424 If Gdtr is NULL, then ASSERT().
6426 @param Gdtr Pointer to a GDTR descriptor.
6432 IN CONST IA32_DESCRIPTOR
*Gdtr
6437 Reads the current Interrupt Descriptor Table Register(IDTR) descriptor.
6439 Reads and returns the current IDTR descriptor and returns it in Idtr. This
6440 function is only available on IA-32 and x64.
6442 If Idtr is NULL, then ASSERT().
6444 @param Idtr Pointer to a IDTR descriptor.
6450 OUT IA32_DESCRIPTOR
*Idtr
6455 Writes the current Interrupt Descriptor Table Register(IDTR) descriptor.
6457 Writes the current IDTR descriptor and returns it in Idtr. This function is
6458 only available on IA-32 and x64.
6460 If Idtr is NULL, then ASSERT().
6462 @param Idtr Pointer to a IDTR descriptor.
6468 IN CONST IA32_DESCRIPTOR
*Idtr
6473 Reads the current Local Descriptor Table Register(LDTR) selector.
6475 Reads and returns the current 16-bit LDTR descriptor value. This function is
6476 only available on IA-32 and x64.
6478 @return The current selector of LDT.
6489 Writes the current Local Descriptor Table Register (LDTR) selector.
6491 Writes and the current LDTR descriptor specified by Ldtr. This function is
6492 only available on IA-32 and x64.
6494 @param Ldtr 16-bit LDTR selector value.
6505 Save the current floating point/SSE/SSE2 context to a buffer.
6507 Saves the current floating point/SSE/SSE2 state to the buffer specified by
6508 Buffer. Buffer must be aligned on a 16-byte boundary. This function is only
6509 available on IA-32 and x64.
6511 If Buffer is NULL, then ASSERT().
6512 If Buffer is not aligned on a 16-byte boundary, then ASSERT().
6514 @param Buffer Pointer to a buffer to save the floating point/SSE/SSE2 context.
6520 OUT IA32_FX_BUFFER
*Buffer
6525 Restores the current floating point/SSE/SSE2 context from a buffer.
6527 Restores the current floating point/SSE/SSE2 state from the buffer specified
6528 by Buffer. Buffer must be aligned on a 16-byte boundary. This function is
6529 only available on IA-32 and x64.
6531 If Buffer is NULL, then ASSERT().
6532 If Buffer is not aligned on a 16-byte boundary, then ASSERT().
6533 If Buffer was not saved with AsmFxSave(), then ASSERT().
6535 @param Buffer Pointer to a buffer to save the floating point/SSE/SSE2 context.
6541 IN CONST IA32_FX_BUFFER
*Buffer
6546 Reads the current value of 64-bit MMX Register #0 (MM0).
6548 Reads and returns the current value of MM0. This function is only available
6551 @return The current value of MM0.
6562 Reads the current value of 64-bit MMX Register #1 (MM1).
6564 Reads and returns the current value of MM1. This function is only available
6567 @return The current value of MM1.
6578 Reads the current value of 64-bit MMX Register #2 (MM2).
6580 Reads and returns the current value of MM2. This function is only available
6583 @return The current value of MM2.
6594 Reads the current value of 64-bit MMX Register #3 (MM3).
6596 Reads and returns the current value of MM3. This function is only available
6599 @return The current value of MM3.
6610 Reads the current value of 64-bit MMX Register #4 (MM4).
6612 Reads and returns the current value of MM4. This function is only available
6615 @return The current value of MM4.
6626 Reads the current value of 64-bit MMX Register #5 (MM5).
6628 Reads and returns the current value of MM5. This function is only available
6631 @return The current value of MM5.
6642 Reads the current value of 64-bit MMX Register #6 (MM6).
6644 Reads and returns the current value of MM6. This function is only available
6647 @return The current value of MM6.
6658 Reads the current value of 64-bit MMX Register #7 (MM7).
6660 Reads and returns the current value of MM7. This function is only available
6663 @return The current value of MM7.
6674 Writes the current value of 64-bit MMX Register #0 (MM0).
6676 Writes the current value of MM0. This function is only available on IA32 and
6679 @param Value The 64-bit value to write to MM0.
6690 Writes the current value of 64-bit MMX Register #1 (MM1).
6692 Writes the current value of MM1. This function is only available on IA32 and
6695 @param Value The 64-bit value to write to MM1.
6706 Writes the current value of 64-bit MMX Register #2 (MM2).
6708 Writes the current value of MM2. This function is only available on IA32 and
6711 @param Value The 64-bit value to write to MM2.
6722 Writes the current value of 64-bit MMX Register #3 (MM3).
6724 Writes the current value of MM3. This function is only available on IA32 and
6727 @param Value The 64-bit value to write to MM3.
6738 Writes the current value of 64-bit MMX Register #4 (MM4).
6740 Writes the current value of MM4. This function is only available on IA32 and
6743 @param Value The 64-bit value to write to MM4.
6754 Writes the current value of 64-bit MMX Register #5 (MM5).
6756 Writes the current value of MM5. This function is only available on IA32 and
6759 @param Value The 64-bit value to write to MM5.
6770 Writes the current value of 64-bit MMX Register #6 (MM6).
6772 Writes the current value of MM6. This function is only available on IA32 and
6775 @param Value The 64-bit value to write to MM6.
6786 Writes the current value of 64-bit MMX Register #7 (MM7).
6788 Writes the current value of MM7. This function is only available on IA32 and
6791 @param Value The 64-bit value to write to MM7.
6802 Reads the current value of Time Stamp Counter (TSC).
6804 Reads and returns the current value of TSC. This function is only available
6807 @return The current value of TSC
6818 Reads the current value of a Performance Counter (PMC).
6820 Reads and returns the current value of performance counter specified by
6821 Index. This function is only available on IA-32 and x64.
6823 @param Index The 32-bit Performance Counter index to read.
6825 @return The value of the PMC specified by Index.
6836 Sets up a monitor buffer that is used by AsmMwait().
6838 Executes a MONITOR instruction with the register state specified by Eax, Ecx
6839 and Edx. Returns Eax. This function is only available on IA-32 and x64.
6841 @param Eax The value to load into EAX or RAX before executing the MONITOR
6843 @param Ecx The value to load into ECX or RCX before executing the MONITOR
6845 @param Edx The value to load into EDX or RDX before executing the MONITOR
6861 Executes an MWAIT instruction.
6863 Executes an MWAIT instruction with the register state specified by Eax and
6864 Ecx. Returns Eax. This function is only available on IA-32 and x64.
6866 @param Eax The value to load into EAX or RAX before executing the MONITOR
6868 @param Ecx The value to load into ECX or RCX before executing the MONITOR
6883 Executes a WBINVD instruction.
6885 Executes a WBINVD instruction. This function is only available on IA-32 and
6897 Executes a INVD instruction.
6899 Executes a INVD instruction. This function is only available on IA-32 and
6911 Flushes a cache line from all the instruction and data caches within the
6912 coherency domain of the CPU.
6914 Flushed the cache line specified by LinearAddress, and returns LinearAddress.
6915 This function is only available on IA-32 and x64.
6917 @param LinearAddress The address of the cache line to flush. If the CPU is
6918 in a physical addressing mode, then LinearAddress is a
6919 physical address. If the CPU is in a virtual
6920 addressing mode, then LinearAddress is a virtual
6923 @return LinearAddress
6928 IN VOID
*LinearAddress
6933 Enables the 32-bit paging mode on the CPU.
6935 Enables the 32-bit paging mode on the CPU. CR0, CR3, CR4, and the page tables
6936 must be properly initialized prior to calling this service. This function
6937 assumes the current execution mode is 32-bit protected mode. This function is
6938 only available on IA-32. After the 32-bit paging mode is enabled, control is
6939 transferred to the function specified by EntryPoint using the new stack
6940 specified by NewStack and passing in the parameters specified by Context1 and
6941 Context2. Context1 and Context2 are optional and may be NULL. The function
6942 EntryPoint must never return.
6944 If the current execution mode is not 32-bit protected mode, then ASSERT().
6945 If EntryPoint is NULL, then ASSERT().
6946 If NewStack is NULL, then ASSERT().
6948 There are a number of constraints that must be followed before calling this
6950 1) Interrupts must be disabled.
6951 2) The caller must be in 32-bit protected mode with flat descriptors. This
6952 means all descriptors must have a base of 0 and a limit of 4GB.
6953 3) CR0 and CR4 must be compatible with 32-bit protected mode with flat
6955 4) CR3 must point to valid page tables that will be used once the transition
6956 is complete, and those page tables must guarantee that the pages for this
6957 function and the stack are identity mapped.
6959 @param EntryPoint A pointer to function to call with the new stack after
6961 @param Context1 A pointer to the context to pass into the EntryPoint
6962 function as the first parameter after paging is enabled.
6963 @param Context2 A pointer to the context to pass into the EntryPoint
6964 function as the second parameter after paging is enabled.
6965 @param NewStack A pointer to the new stack to use for the EntryPoint
6966 function after paging is enabled.
6972 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
6973 IN VOID
*Context1
, OPTIONAL
6974 IN VOID
*Context2
, OPTIONAL
6980 Disables the 32-bit paging mode on the CPU.
6982 Disables the 32-bit paging mode on the CPU and returns to 32-bit protected
6983 mode. This function assumes the current execution mode is 32-paged protected
6984 mode. This function is only available on IA-32. After the 32-bit paging mode
6985 is disabled, control is transferred to the function specified by EntryPoint
6986 using the new stack specified by NewStack and passing in the parameters
6987 specified by Context1 and Context2. Context1 and Context2 are optional and
6988 may be NULL. The function EntryPoint must never return.
6990 If the current execution mode is not 32-bit paged mode, then ASSERT().
6991 If EntryPoint is NULL, then ASSERT().
6992 If NewStack is NULL, then ASSERT().
6994 There are a number of constraints that must be followed before calling this
6996 1) Interrupts must be disabled.
6997 2) The caller must be in 32-bit paged mode.
6998 3) CR0, CR3, and CR4 must be compatible with 32-bit paged mode.
6999 4) CR3 must point to valid page tables that guarantee that the pages for
7000 this function and the stack are identity mapped.
7002 @param EntryPoint A pointer to function to call with the new stack after
7004 @param Context1 A pointer to the context to pass into the EntryPoint
7005 function as the first parameter after paging is disabled.
7006 @param Context2 A pointer to the context to pass into the EntryPoint
7007 function as the second parameter after paging is
7009 @param NewStack A pointer to the new stack to use for the EntryPoint
7010 function after paging is disabled.
7015 AsmDisablePaging32 (
7016 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
7017 IN VOID
*Context1
, OPTIONAL
7018 IN VOID
*Context2
, OPTIONAL
7024 Enables the 64-bit paging mode on the CPU.
7026 Enables the 64-bit paging mode on the CPU. CR0, CR3, CR4, and the page tables
7027 must be properly initialized prior to calling this service. This function
7028 assumes the current execution mode is 32-bit protected mode with flat
7029 descriptors. This function is only available on IA-32. After the 64-bit
7030 paging mode is enabled, control is transferred to the function specified by
7031 EntryPoint using the new stack specified by NewStack and passing in the
7032 parameters specified by Context1 and Context2. Context1 and Context2 are
7033 optional and may be 0. The function EntryPoint must never return.
7035 If the current execution mode is not 32-bit protected mode with flat
7036 descriptors, then ASSERT().
7037 If EntryPoint is 0, then ASSERT().
7038 If NewStack is 0, then ASSERT().
7040 @param Cs The 16-bit selector to load in the CS before EntryPoint
7041 is called. The descriptor in the GDT that this selector
7042 references must be setup for long mode.
7043 @param EntryPoint The 64-bit virtual address of the function to call with
7044 the new stack after paging is enabled.
7045 @param Context1 The 64-bit virtual address of the context to pass into
7046 the EntryPoint function as the first parameter after
7048 @param Context2 The 64-bit virtual address of the context to pass into
7049 the EntryPoint function as the second parameter after
7051 @param NewStack The 64-bit virtual address of the new stack to use for
7052 the EntryPoint function after paging is enabled.
7059 IN UINT64 EntryPoint
,
7060 IN UINT64 Context1
, OPTIONAL
7061 IN UINT64 Context2
, OPTIONAL
7067 Disables the 64-bit paging mode on the CPU.
7069 Disables the 64-bit paging mode on the CPU and returns to 32-bit protected
7070 mode. This function assumes the current execution mode is 64-paging mode.
7071 This function is only available on x64. After the 64-bit paging mode is
7072 disabled, control is transferred to the function specified by EntryPoint
7073 using the new stack specified by NewStack and passing in the parameters
7074 specified by Context1 and Context2. Context1 and Context2 are optional and
7075 may be 0. The function EntryPoint must never return.
7077 If the current execution mode is not 64-bit paged mode, then ASSERT().
7078 If EntryPoint is 0, then ASSERT().
7079 If NewStack is 0, then ASSERT().
7081 @param Cs The 16-bit selector to load in the CS before EntryPoint
7082 is called. The descriptor in the GDT that this selector
7083 references must be setup for 32-bit protected mode.
7084 @param EntryPoint The 64-bit virtual address of the function to call with
7085 the new stack after paging is disabled.
7086 @param Context1 The 64-bit virtual address of the context to pass into
7087 the EntryPoint function as the first parameter after
7089 @param Context2 The 64-bit virtual address of the context to pass into
7090 the EntryPoint function as the second parameter after
7092 @param NewStack The 64-bit virtual address of the new stack to use for
7093 the EntryPoint function after paging is disabled.
7098 AsmDisablePaging64 (
7100 IN UINT32 EntryPoint
,
7101 IN UINT32 Context1
, OPTIONAL
7102 IN UINT32 Context2
, OPTIONAL
7108 // 16-bit thunking services
7112 Retrieves the properties for 16-bit thunk functions.
7114 Computes the size of the buffer and stack below 1MB required to use the
7115 AsmPrepareThunk16(), AsmThunk16() and AsmPrepareAndThunk16() functions. This
7116 buffer size is returned in RealModeBufferSize, and the stack size is returned
7117 in ExtraStackSize. If parameters are passed to the 16-bit real mode code,
7118 then the actual minimum stack size is ExtraStackSize plus the maximum number
7119 of bytes that need to be passed to the 16-bit real mode code.
7121 If RealModeBufferSize is NULL, then ASSERT().
7122 If ExtraStackSize is NULL, then ASSERT().
7124 @param RealModeBufferSize A pointer to the size of the buffer below 1MB
7125 required to use the 16-bit thunk functions.
7126 @param ExtraStackSize A pointer to the extra size of stack below 1MB
7127 that the 16-bit thunk functions require for
7128 temporary storage in the transition to and from
7134 AsmGetThunk16Properties (
7135 OUT UINT32
*RealModeBufferSize
,
7136 OUT UINT32
*ExtraStackSize
7141 Prepares all structures a code required to use AsmThunk16().
7143 Prepares all structures and code required to use AsmThunk16().
7145 If ThunkContext is NULL, then ASSERT().
7147 @param ThunkContext A pointer to the context structure that describes the
7148 16-bit real mode code to call.
7154 OUT THUNK_CONTEXT
*ThunkContext
7159 Transfers control to a 16-bit real mode entry point and returns the results.
7161 Transfers control to a 16-bit real mode entry point and returns the results.
7162 AsmPrepareThunk16() must be called with ThunkContext before this function is used.
7163 This function must be called with interrupts disabled.
7165 The register state from the RealModeState field of ThunkContext is restored just prior
7166 to calling the 16-bit real mode entry point. This includes the EFLAGS field of RealModeState,
7167 which is used to set the interrupt state when a 16-bit real mode entry point is called.
7168 Control is transferred to the 16-bit real mode entry point specified by the CS and Eip fields of RealModeState.
7169 The stack is initialized to the SS and ESP fields of RealModeState. Any parameters passed to
7170 the 16-bit real mode code must be populated by the caller at SS:ESP prior to calling this function.
7171 The 16-bit real mode entry point is invoked with a 16-bit CALL FAR instruction,
7172 so when accessing stack contents, the 16-bit real mode code must account for the 16-bit segment
7173 and 16-bit offset of the return address that were pushed onto the stack. The 16-bit real mode entry
7174 point must exit with a RETF instruction. The register state is captured into RealModeState immediately
7175 after the RETF instruction is executed.
7177 If EFLAGS specifies interrupts enabled, or any of the 16-bit real mode code enables interrupts,
7178 or any of the 16-bit real mode code makes a SW interrupt, then the caller is responsible for making sure
7179 the IDT at address 0 is initialized to handle any HW or SW interrupts that may occur while in 16-bit real mode.
7181 If EFLAGS specifies interrupts enabled, or any of the 16-bit real mode code enables interrupts,
7182 then the caller is responsible for making sure the 8259 PIC is in a state compatible with 16-bit real mode.
7183 This includes the base vectors, the interrupt masks, and the edge/level trigger mode.
7185 If THUNK_ATTRIBUTE_BIG_REAL_MODE is set in the ThunkAttributes field of ThunkContext, then the user code
7186 is invoked in big real mode. Otherwise, the user code is invoked in 16-bit real mode with 64KB segment limits.
7188 If neither THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 nor THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL are set in
7189 ThunkAttributes, then it is assumed that the user code did not enable the A20 mask, and no attempt is made to
7190 disable the A20 mask.
7192 If THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 is set and THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL is clear in
7193 ThunkAttributes, then attempt to use the INT 15 service to disable the A20 mask. If this INT 15 call fails,
7194 then attempt to disable the A20 mask by directly accessing the 8042 keyboard controller I/O ports.
7196 If THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 is clear and THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL is set in
7197 ThunkAttributes, then attempt to disable the A20 mask by directly accessing the 8042 keyboard controller I/O ports.
7199 If ThunkContext is NULL, then ASSERT().
7200 If AsmPrepareThunk16() was not previously called with ThunkContext, then ASSERT().
7201 If both THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 and THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL are set in
7202 ThunkAttributes, then ASSERT().
7204 @param ThunkContext A pointer to the context structure that describes the
7205 16-bit real mode code to call.
7211 IN OUT THUNK_CONTEXT
*ThunkContext
7216 Prepares all structures and code for a 16-bit real mode thunk, transfers
7217 control to a 16-bit real mode entry point, and returns the results.
7219 Prepares all structures and code for a 16-bit real mode thunk, transfers
7220 control to a 16-bit real mode entry point, and returns the results. If the
7221 caller only need to perform a single 16-bit real mode thunk, then this
7222 service should be used. If the caller intends to make more than one 16-bit
7223 real mode thunk, then it is more efficient if AsmPrepareThunk16() is called
7224 once and AsmThunk16() can be called for each 16-bit real mode thunk.
7226 See AsmPrepareThunk16() and AsmThunk16() for the detailed description and ASSERT() conditions.
7228 @param ThunkContext A pointer to the context structure that describes the
7229 16-bit real mode code to call.
7234 AsmPrepareAndThunk16 (
7235 IN OUT THUNK_CONTEXT
*ThunkContext