2 Memory-only library functions with no library constructor/destructor
4 Copyright (c) 2006 - 2007, Intel Corporation
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
19 // Definitions for architecture specific types
20 // These include SPIN_LOCK and BASE_LIBRARY_JUMP_BUFFER
26 typedef volatile UINTN SPIN_LOCK
;
28 #if defined (MDE_CPU_IA32)
30 // IA32 context buffer used by SetJump() and LongJump()
39 } BASE_LIBRARY_JUMP_BUFFER
;
41 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 4
43 #elif defined (MDE_CPU_IPF)
46 // IPF context buffer used by SetJump() and LongJump()
81 UINT64 AfterSpillUNAT
;
87 } BASE_LIBRARY_JUMP_BUFFER
;
89 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 0x10
91 #elif defined (MDE_CPU_X64)
93 // X64 context buffer used by SetJump() and LongJump()
106 } BASE_LIBRARY_JUMP_BUFFER
;
108 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 8
110 #elif defined (MDE_CPU_EBC)
112 // EBC context buffer used by SetJump() and LongJump()
120 } BASE_LIBRARY_JUMP_BUFFER
;
122 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 8
125 #error Unknown Processor Type
133 Copies one Null-terminated Unicode string to another Null-terminated Unicode
134 string and returns the new Unicode string.
136 This function copies the contents of the Unicode string Source to the Unicode
137 string Destination, and returns Destination. If Source and Destination
138 overlap, then the results are undefined.
140 If Destination is NULL, then ASSERT().
141 If Destination is not aligned on a 16-bit boundary, then ASSERT().
142 If Source is NULL, then ASSERT().
143 If Source is not aligned on a 16-bit boundary, then ASSERT().
144 If Source and Destination overlap, then ASSERT().
145 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
146 PcdMaximumUnicodeStringLength Unicode characters not including the
147 Null-terminator, then ASSERT().
149 @param Destination Pointer to a Null-terminated Unicode string.
150 @param Source Pointer to a Null-terminated Unicode string.
158 OUT CHAR16
*Destination
,
159 IN CONST CHAR16
*Source
164 Copies one Null-terminated Unicode string with a maximum length to another
165 Null-terminated Unicode string with a maximum length and returns the new
168 This function copies the contents of the Unicode string Source to the Unicode
169 string Destination, and returns Destination. At most, Length Unicode
170 characters are copied from Source to Destination. If Length is 0, then
171 Destination is returned unmodified. If Length is greater that the number of
172 Unicode characters in Source, then Destination is padded with Null Unicode
173 characters. If Source and Destination overlap, then the results are
176 If Length > 0 and Destination is NULL, then ASSERT().
177 If Length > 0 and Destination is not aligned on a 16-bit boundary, then ASSERT().
178 If Length > 0 and Source is NULL, then ASSERT().
179 If Length > 0 and Source is not aligned on a 16-bit bounadry, then ASSERT().
180 If Source and Destination overlap, then ASSERT().
181 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
182 PcdMaximumUnicodeStringLength Unicode characters not including the
183 Null-terminator, then ASSERT().
185 @param Destination Pointer to a Null-terminated Unicode string.
186 @param Source Pointer to a Null-terminated Unicode string.
187 @param Length Maximum number of Unicode characters to copy.
195 OUT CHAR16
*Destination
,
196 IN CONST CHAR16
*Source
,
202 Returns the length of a Null-terminated Unicode string.
204 This function returns the number of Unicode characters in the Null-terminated
205 Unicode string specified by String.
207 If String is NULL, then ASSERT().
208 If String is not aligned on a 16-bit boundary, then ASSERT().
209 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
210 PcdMaximumUnicodeStringLength Unicode characters not including the
211 Null-terminator, then ASSERT().
213 @param String Pointer to a Null-terminated Unicode string.
215 @return The length of String.
221 IN CONST CHAR16
*String
226 Returns the size of a Null-terminated Unicode string in bytes, including the
229 This function returns the size, in bytes, of the Null-terminated Unicode
230 string specified by String.
232 If String is NULL, then ASSERT().
233 If String is not aligned on a 16-bit boundary, then ASSERT().
234 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
235 PcdMaximumUnicodeStringLength Unicode characters not including the
236 Null-terminator, then ASSERT().
238 @param String Pointer to a Null-terminated Unicode string.
240 @return The size of String.
246 IN CONST CHAR16
*String
251 Compares two Null-terminated Unicode strings, and returns the difference
252 between the first mismatched Unicode characters.
254 This function compares the Null-terminated Unicode string FirstString to the
255 Null-terminated Unicode string SecondString. If FirstString is identical to
256 SecondString, then 0 is returned. Otherwise, the value returned is the first
257 mismatched Unicode character in SecondString subtracted from the first
258 mismatched Unicode character in FirstString.
260 If FirstString is NULL, then ASSERT().
261 If FirstString is not aligned on a 16-bit boundary, then ASSERT().
262 If SecondString is NULL, then ASSERT().
263 If SecondString is not aligned on a 16-bit boundary, then ASSERT().
264 If PcdMaximumUnicodeStringLength is not zero, and FirstString contains more
265 than PcdMaximumUnicodeStringLength Unicode characters not including the
266 Null-terminator, then ASSERT().
267 If PcdMaximumUnicodeStringLength is not zero, and SecondString contains more
268 than PcdMaximumUnicodeStringLength Unicode characters not including the
269 Null-terminator, then ASSERT().
271 @param FirstString Pointer to a Null-terminated Unicode string.
272 @param SecondString Pointer to a Null-terminated Unicode string.
274 @retval 0 FirstString is identical to SecondString.
275 @retval !=0 FirstString is not identical to SecondString.
281 IN CONST CHAR16
*FirstString
,
282 IN CONST CHAR16
*SecondString
287 Compares two Null-terminated Unicode strings with maximum lengths, and
288 returns the difference between the first mismatched Unicode characters.
290 This function compares the Null-terminated Unicode string FirstString to the
291 Null-terminated Unicode string SecondString. At most, Length Unicode
292 characters will be compared. If Length is 0, then 0 is returned. If
293 FirstString is identical to SecondString, then 0 is returned. Otherwise, the
294 value returned is the first mismatched Unicode character in SecondString
295 subtracted from the first mismatched Unicode character in FirstString.
297 If Length > 0 and FirstString is NULL, then ASSERT().
298 If Length > 0 and FirstString is not aligned on a 16-bit bounadary, then ASSERT().
299 If Length > 0 and SecondString is NULL, then ASSERT().
300 If Length > 0 and SecondString is not aligned on a 16-bit bounadary, then ASSERT().
301 If PcdMaximumUnicodeStringLength is not zero, and FirstString contains more
302 than PcdMaximumUnicodeStringLength Unicode characters not including the
303 Null-terminator, then ASSERT().
304 If PcdMaximumUnicodeStringLength is not zero, and SecondString contains more
305 than PcdMaximumUnicodeStringLength Unicode characters not including the
306 Null-terminator, then ASSERT().
308 @param FirstString Pointer to a Null-terminated Unicode string.
309 @param SecondString Pointer to a Null-terminated Unicode string.
310 @param Length Maximum number of Unicode characters to compare.
312 @retval 0 FirstString is identical to SecondString.
313 @retval !=0 FirstString is not identical to SecondString.
319 IN CONST CHAR16
*FirstString
,
320 IN CONST CHAR16
*SecondString
,
326 Concatenates one Null-terminated Unicode string to another Null-terminated
327 Unicode string, and returns the concatenated Unicode string.
329 This function concatenates two Null-terminated Unicode strings. The contents
330 of Null-terminated Unicode string Source are concatenated to the end of
331 Null-terminated Unicode string Destination. The Null-terminated concatenated
332 Unicode String is returned. If Source and Destination overlap, then the
333 results are undefined.
335 If Destination is NULL, then ASSERT().
336 If Destination is not aligned on a 16-bit bounadary, then ASSERT().
337 If Source is NULL, then ASSERT().
338 If Source is not aligned on a 16-bit bounadary, then ASSERT().
339 If Source and Destination overlap, then ASSERT().
340 If PcdMaximumUnicodeStringLength is not zero, and Destination contains more
341 than PcdMaximumUnicodeStringLength Unicode characters not including the
342 Null-terminator, then ASSERT().
343 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
344 PcdMaximumUnicodeStringLength Unicode characters not including the
345 Null-terminator, then ASSERT().
346 If PcdMaximumUnicodeStringLength is not zero, and concatenating Destination
347 and Source results in a Unicode string with more than
348 PcdMaximumUnicodeStringLength Unicode characters not including the
349 Null-terminator, then ASSERT().
351 @param Destination Pointer to a Null-terminated Unicode string.
352 @param Source Pointer to a Null-terminated Unicode string.
360 IN OUT CHAR16
*Destination
,
361 IN CONST CHAR16
*Source
366 Concatenates one Null-terminated Unicode string with a maximum length to the
367 end of another Null-terminated Unicode string, and returns the concatenated
370 This function concatenates two Null-terminated Unicode strings. The contents
371 of Null-terminated Unicode string Source are concatenated to the end of
372 Null-terminated Unicode string Destination, and Destination is returned. At
373 most, Length Unicode characters are concatenated from Source to the end of
374 Destination, and Destination is always Null-terminated. If Length is 0, then
375 Destination is returned unmodified. If Source and Destination overlap, then
376 the results are undefined.
378 If Destination is NULL, then ASSERT().
379 If Length > 0 and Destination is not aligned on a 16-bit boundary, then ASSERT().
380 If Length > 0 and Source is NULL, then ASSERT().
381 If Length > 0 and Source is not aligned on a 16-bit boundary, then ASSERT().
382 If Source and Destination overlap, then ASSERT().
383 If PcdMaximumUnicodeStringLength is not zero, and Destination contains more
384 than PcdMaximumUnicodeStringLength Unicode characters not including the
385 Null-terminator, then ASSERT().
386 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
387 PcdMaximumUnicodeStringLength Unicode characters not including the
388 Null-terminator, then ASSERT().
389 If PcdMaximumUnicodeStringLength is not zero, and concatenating Destination
390 and Source results in a Unicode string with more than
391 PcdMaximumUnicodeStringLength Unicode characters not including the
392 Null-terminator, then ASSERT().
394 @param Destination Pointer to a Null-terminated Unicode string.
395 @param Source Pointer to a Null-terminated Unicode string.
396 @param Length Maximum number of Unicode characters to concatenate from
405 IN OUT CHAR16
*Destination
,
406 IN CONST CHAR16
*Source
,
411 Returns the first occurance of a Null-terminated Unicode sub-string
412 in a Null-terminated Unicode string.
414 This function scans the contents of the Null-terminated Unicode string
415 specified by String and returns the first occurrence of SearchString.
416 If SearchString is not found in String, then NULL is returned. If
417 the length of SearchString is zero, then String is
420 If String is NULL, then ASSERT().
421 If String is not aligned on a 16-bit boundary, then ASSERT().
422 If SearchString is NULL, then ASSERT().
423 If SearchString is not aligned on a 16-bit boundary, then ASSERT().
425 If PcdMaximumUnicodeStringLength is not zero, and SearchString
426 or String contains more than PcdMaximumUnicodeStringLength Unicode
427 characters not including the Null-terminator, then ASSERT().
429 @param String Pointer to a Null-terminated Unicode string.
430 @param SearchString Pointer to a Null-terminated Unicode string to search for.
432 @retval NULL If the SearchString does not appear in String.
433 @retval !NULL If there is a match.
439 IN CONST CHAR16
*String
,
440 IN CONST CHAR16
*SearchString
444 Convert a Null-terminated Unicode decimal string to a value of
447 This function returns a value of type UINTN by interpreting the contents
448 of the Unicode string specified by String as a decimal number. The format
449 of the input Unicode string String is:
451 [spaces] [decimal digits].
453 The valid decimal digit character is in the range [0-9]. The
454 function will ignore the pad space, which includes spaces or
455 tab characters, before [decimal digits]. The running zero in the
456 beginning of [decimal digits] will be ignored. Then, the function
457 stops at the first character that is a not a valid decimal character
458 or a Null-terminator, whichever one comes first.
460 If String is NULL, then ASSERT().
461 If String is not aligned in a 16-bit boundary, then ASSERT().
462 If String has only pad spaces, then 0 is returned.
463 If String has no pad spaces or valid decimal digits,
465 If the number represented by String overflows according
466 to the range defined by UINTN, then ASSERT().
468 If PcdMaximumUnicodeStringLength is not zero, and String contains
469 more than PcdMaximumUnicodeStringLength Unicode characters not including
470 the Null-terminator, then ASSERT().
472 @param String Pointer to a Null-terminated Unicode string.
480 IN CONST CHAR16
*String
484 Convert a Null-terminated Unicode decimal string to a value of
487 This function returns a value of type UINT64 by interpreting the contents
488 of the Unicode string specified by String as a decimal number. The format
489 of the input Unicode string String is:
491 [spaces] [decimal digits].
493 The valid decimal digit character is in the range [0-9]. The
494 function will ignore the pad space, which includes spaces or
495 tab characters, before [decimal digits]. The running zero in the
496 beginning of [decimal digits] will be ignored. Then, the function
497 stops at the first character that is a not a valid decimal character
498 or a Null-terminator, whichever one comes first.
500 If String is NULL, then ASSERT().
501 If String is not aligned in a 16-bit boundary, then ASSERT().
502 If String has only pad spaces, then 0 is returned.
503 If String has no pad spaces or valid decimal digits,
505 If the number represented by String overflows according
506 to the range defined by UINT64, then ASSERT().
508 If PcdMaximumUnicodeStringLength is not zero, and String contains
509 more than PcdMaximumUnicodeStringLength Unicode characters not including
510 the Null-terminator, then ASSERT().
512 @param String Pointer to a Null-terminated Unicode string.
520 IN CONST CHAR16
*String
525 Convert a Null-terminated Unicode hexadecimal string to a value of type UINTN.
527 This function returns a value of type UINTN by interpreting the contents
528 of the Unicode string specified by String as a hexadecimal number.
529 The format of the input Unicode string String is:
531 [spaces][zeros][x][hexadecimal digits].
533 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
534 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix.
535 If "x" appears in the input string, it must be prefixed with at least one 0.
536 The function will ignore the pad space, which includes spaces or tab characters,
537 before [zeros], [x] or [hexadecimal digit]. The running zero before [x] or
538 [hexadecimal digit] will be ignored. Then, the decoding starts after [x] or the
539 first valid hexadecimal digit. Then, the function stops at the first character that is
540 a not a valid hexadecimal character or NULL, whichever one comes first.
542 If String is NULL, then ASSERT().
543 If String is not aligned in a 16-bit boundary, then ASSERT().
544 If String has only pad spaces, then zero is returned.
545 If String has no leading pad spaces, leading zeros or valid hexadecimal digits,
546 then zero is returned.
547 If the number represented by String overflows according to the range defined by
548 UINTN, then ASSERT().
550 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
551 PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator,
554 @param String Pointer to a Null-terminated Unicode string.
562 IN CONST CHAR16
*String
567 Convert a Null-terminated Unicode hexadecimal string to a value of type UINT64.
569 This function returns a value of type UINT64 by interpreting the contents
570 of the Unicode string specified by String as a hexadecimal number.
571 The format of the input Unicode string String is
573 [spaces][zeros][x][hexadecimal digits].
575 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
576 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix.
577 If "x" appears in the input string, it must be prefixed with at least one 0.
578 The function will ignore the pad space, which includes spaces or tab characters,
579 before [zeros], [x] or [hexadecimal digit]. The running zero before [x] or
580 [hexadecimal digit] will be ignored. Then, the decoding starts after [x] or the
581 first valid hexadecimal digit. Then, the function stops at the first character that is
582 a not a valid hexadecimal character or NULL, whichever one comes first.
584 If String is NULL, then ASSERT().
585 If String is not aligned in a 16-bit boundary, then ASSERT().
586 If String has only pad spaces, then zero is returned.
587 If String has no leading pad spaces, leading zeros or valid hexadecimal digits,
588 then zero is returned.
589 If the number represented by String overflows according to the range defined by
590 UINT64, then ASSERT().
592 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
593 PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator,
596 @param String Pointer to a Null-terminated Unicode string.
604 IN CONST CHAR16
*String
609 Convert one Null-terminated Unicode string to a Null-terminated
610 ASCII string and returns the ASCII string.
612 This function converts the content of the Unicode string Source
613 to the ASCII string Destination by copying the lower 8 bits of
614 each Unicode character. It returns Destination.
616 If any Unicode characters in Source contain non-zero value in
617 the upper 8 bits, then ASSERT().
619 If Destination is NULL, then ASSERT().
620 If Source is NULL, then ASSERT().
621 If Source is not aligned on a 16-bit boundary, then ASSERT().
622 If Source and Destination overlap, then ASSERT().
624 If PcdMaximumUnicodeStringLength is not zero, and Source contains
625 more than PcdMaximumUnicodeStringLength Unicode characters not including
626 the Null-terminator, then ASSERT().
628 If PcdMaximumAsciiStringLength is not zero, and Source contains more
629 than PcdMaximumAsciiStringLength Unicode characters not including the
630 Null-terminator, then ASSERT().
632 @param Source Pointer to a Null-terminated Unicode string.
633 @param Destination Pointer to a Null-terminated ASCII string.
640 UnicodeStrToAsciiStr (
641 IN CONST CHAR16
*Source
,
642 OUT CHAR8
*Destination
647 Copies one Null-terminated ASCII string to another Null-terminated ASCII
648 string and returns the new ASCII string.
650 This function copies the contents of the ASCII string Source to the ASCII
651 string Destination, and returns Destination. If Source and Destination
652 overlap, then the results are undefined.
654 If Destination is NULL, then ASSERT().
655 If Source is NULL, then ASSERT().
656 If Source and Destination overlap, then ASSERT().
657 If PcdMaximumAsciiStringLength is not zero and Source contains more than
658 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
661 @param Destination Pointer to a Null-terminated ASCII string.
662 @param Source Pointer to a Null-terminated ASCII string.
670 OUT CHAR8
*Destination
,
671 IN CONST CHAR8
*Source
676 Copies one Null-terminated ASCII string with a maximum length to another
677 Null-terminated ASCII string with a maximum length and returns the new ASCII
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 one Null-terminated ASCII string with a maximum length to the
903 end of another Null-terminated ASCII string, and returns the concatenated
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 occurance 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 !NULL If there is a match.
970 IN CONST CHAR8
*String
,
971 IN CONST CHAR8
*SearchString
976 Convert a Null-terminated ASCII decimal string to a value of type
979 This function returns a value of type UINTN by interpreting the contents
980 of the ASCII string String as a decimal number. The format of the input
981 ASCII string String is:
983 [spaces] [decimal digits].
985 The valid decimal digit character is in the range [0-9]. The function will
986 ignore the pad space, which includes spaces or tab characters, before the digits.
987 The running zero in the beginning of [decimal digits] will be ignored. Then, the
988 function stops at the first character that is a not a valid decimal character or
989 Null-terminator, whichever on comes first.
991 If String has only pad spaces, then 0 is returned.
992 If String has no pad spaces or valid decimal digits, then 0 is returned.
993 If the number represented by String overflows according to the range defined by
994 UINTN, then ASSERT().
995 If String is NULL, then ASSERT().
996 If PcdMaximumAsciiStringLength is not zero, and String contains more than
997 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
1000 @param String Pointer to a Null-terminated ASCII string.
1007 AsciiStrDecimalToUintn (
1008 IN CONST CHAR8
*String
1013 Convert a Null-terminated ASCII decimal string to a value of type
1016 This function returns a value of type UINT64 by interpreting the contents
1017 of the ASCII string String as a decimal number. The format of the input
1018 ASCII string String is:
1020 [spaces] [decimal digits].
1022 The valid decimal digit character is in the range [0-9]. The function will
1023 ignore the pad space, which includes spaces or tab characters, before the digits.
1024 The running zero in the beginning of [decimal digits] will be ignored. Then, the
1025 function stops at the first character that is a not a valid decimal character or
1026 Null-terminator, whichever on comes first.
1028 If String has only pad spaces, then 0 is returned.
1029 If String has no pad spaces or valid decimal digits, then 0 is returned.
1030 If the number represented by String overflows according to the range defined by
1031 UINT64, then ASSERT().
1032 If String is NULL, then ASSERT().
1033 If PcdMaximumAsciiStringLength is not zero, and String contains more than
1034 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
1037 @param String Pointer to a Null-terminated ASCII string.
1044 AsciiStrDecimalToUint64 (
1045 IN CONST CHAR8
*String
1050 Convert a Null-terminated ASCII hexadecimal string to a value of type UINTN.
1052 This function returns a value of type UINTN by interpreting the contents of
1053 the ASCII string String as a hexadecimal number. The format of the input ASCII
1056 [spaces][zeros][x][hexadecimal digits].
1058 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
1059 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix. If "x"
1060 appears in the input string, it must be prefixed with at least one 0. The function
1061 will ignore the pad space, which includes spaces or tab characters, before [zeros],
1062 [x] or [hexadecimal digits]. The running zero before [x] or [hexadecimal digits]
1063 will be ignored. Then, the decoding starts after [x] or the first valid hexadecimal
1064 digit. Then, the function stops at the first character that is a not a valid
1065 hexadecimal character or Null-terminator, whichever on comes first.
1067 If String has only pad spaces, then 0 is returned.
1068 If String has no leading pad spaces, leading zeros or valid hexadecimal digits, then
1071 If the number represented by String overflows according to the range defined by UINTN,
1073 If String is NULL, then ASSERT().
1074 If PcdMaximumAsciiStringLength is not zero,
1075 and String contains more than PcdMaximumAsciiStringLength ASCII characters not including
1076 the Null-terminator, then ASSERT().
1078 @param String Pointer to a Null-terminated ASCII string.
1085 AsciiStrHexToUintn (
1086 IN CONST CHAR8
*String
1091 Convert a Null-terminated ASCII hexadecimal string to a value of type UINT64.
1093 This function returns a value of type UINT64 by interpreting the contents of
1094 the ASCII string String as a hexadecimal number. The format of the input ASCII
1097 [spaces][zeros][x][hexadecimal digits].
1099 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
1100 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix. If "x"
1101 appears in the input string, it must be prefixed with at least one 0. The function
1102 will ignore the pad space, which includes spaces or tab characters, before [zeros],
1103 [x] or [hexadecimal digits]. The running zero before [x] or [hexadecimal digits]
1104 will be ignored. Then, the decoding starts after [x] or the first valid hexadecimal
1105 digit. Then, the function stops at the first character that is a not a valid
1106 hexadecimal character or Null-terminator, whichever on comes first.
1108 If String has only pad spaces, then 0 is returned.
1109 If String has no leading pad spaces, leading zeros or valid hexadecimal digits, then
1112 If the number represented by String overflows according to the range defined by UINT64,
1114 If String is NULL, then ASSERT().
1115 If PcdMaximumAsciiStringLength is not zero,
1116 and String contains more than PcdMaximumAsciiStringLength ASCII characters not including
1117 the Null-terminator, then ASSERT().
1119 @param String Pointer to a Null-terminated ASCII string.
1126 AsciiStrHexToUint64 (
1127 IN CONST CHAR8
*String
1132 Convert one Null-terminated ASCII string to a Null-terminated
1133 Unicode string and returns the Unicode string.
1135 This function converts the contents of the ASCII string Source to the Unicode
1136 string Destination, and returns Destination. The function terminates the
1137 Unicode string Destination by appending a Null-terminator character at the end.
1138 The caller is responsible to make sure Destination points to a buffer with size
1139 equal or greater than ((AsciiStrLen (Source) + 1) * sizeof (CHAR16)) in bytes.
1141 If Destination is NULL, then ASSERT().
1142 If Destination is not aligned on a 16-bit boundary, then ASSERT().
1143 If Source is NULL, then ASSERT().
1144 If Source and Destination overlap, then ASSERT().
1145 If PcdMaximumAsciiStringLength is not zero, and Source contains more than
1146 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
1148 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
1149 PcdMaximumUnicodeStringLength ASCII characters not including the
1150 Null-terminator, then ASSERT().
1152 @param Source Pointer to a Null-terminated ASCII string.
1153 @param Destination Pointer to a Null-terminated Unicode string.
1160 AsciiStrToUnicodeStr (
1161 IN CONST CHAR8
*Source
,
1162 OUT CHAR16
*Destination
1167 Converts an 8-bit value to an 8-bit BCD value.
1169 Converts the 8-bit value specified by Value to BCD. The BCD value is
1172 If Value >= 100, then ASSERT().
1174 @param Value The 8-bit value to convert to BCD. Range 0..99.
1176 @return The BCD value
1187 Converts an 8-bit BCD value to an 8-bit value.
1189 Converts the 8-bit BCD value specified by Value to an 8-bit value. The 8-bit
1192 If Value >= 0xA0, then ASSERT().
1193 If (Value & 0x0F) >= 0x0A, then ASSERT().
1195 @param Value The 8-bit BCD value to convert to an 8-bit value.
1197 @return The 8-bit value is returned.
1208 // Linked List Functions and Macros
1212 Initializes the head node of a doubly linked list that is declared as a
1213 global variable in a module.
1215 Initializes the forward and backward links of a new linked list. After
1216 initializing a linked list with this macro, the other linked list functions
1217 may be used to add and remove nodes from the linked list. This macro results
1218 in smaller executables by initializing the linked list in the data section,
1219 instead if calling the InitializeListHead() function to perform the
1220 equivalent operation.
1222 @param ListHead The head note of a list to initiailize.
1225 #define INITIALIZE_LIST_HEAD_VARIABLE(ListHead) {&ListHead, &ListHead}
1229 Initializes the head node of a doubly linked list, and returns the pointer to
1230 the head node of the doubly linked list.
1232 Initializes the forward and backward links of a new linked list. After
1233 initializing a linked list with this function, the other linked list
1234 functions may be used to add and remove nodes from the linked list. It is up
1235 to the caller of this function to allocate the memory for ListHead.
1237 If ListHead is NULL, then ASSERT().
1239 @param ListHead A pointer to the head node of a new doubly linked list.
1246 InitializeListHead (
1247 IN LIST_ENTRY
*ListHead
1252 Adds a node to the beginning of a doubly linked list, and returns the pointer
1253 to the head node of the doubly linked list.
1255 Adds the node Entry at the beginning of the doubly linked list denoted by
1256 ListHead, and returns ListHead.
1258 If ListHead is NULL, then ASSERT().
1259 If Entry is NULL, then ASSERT().
1260 If ListHead was not initialized with InitializeListHead(), then ASSERT().
1261 If PcdMaximumLinkedListLenth is not zero, and prior to insertion the number
1262 of nodes in ListHead, including the ListHead node, is greater than or
1263 equal to PcdMaximumLinkedListLength, then ASSERT().
1265 @param ListHead A pointer to the head node of a doubly linked list.
1266 @param Entry A pointer to a node that is to be inserted at the beginning
1267 of a doubly linked list.
1275 IN LIST_ENTRY
*ListHead
,
1276 IN LIST_ENTRY
*Entry
1281 Adds a node to the end of a doubly linked list, and returns the pointer to
1282 the head node of the doubly linked list.
1284 Adds the node Entry to the end of the doubly linked list denoted by ListHead,
1285 and returns ListHead.
1287 If ListHead is NULL, then ASSERT().
1288 If Entry is NULL, then ASSERT().
1289 If ListHead was not initialized with InitializeListHead(), then ASSERT().
1290 If PcdMaximumLinkedListLenth is not zero, and prior to insertion the number
1291 of nodes in ListHead, including the ListHead node, is greater than or
1292 equal to PcdMaximumLinkedListLength, then ASSERT().
1294 @param ListHead A pointer to the head node of a doubly linked list.
1295 @param Entry A pointer to a node that is to be added at the end of the
1304 IN LIST_ENTRY
*ListHead
,
1305 IN LIST_ENTRY
*Entry
1310 Retrieves the first node of a doubly linked list.
1312 Returns the first node of a doubly linked list. List must have been
1313 initialized with InitializeListHead(). If List is empty, then NULL is
1316 If List is NULL, then ASSERT().
1317 If List was not initialized with InitializeListHead(), then ASSERT().
1318 If PcdMaximumLinkedListLenth is not zero, and the number of nodes
1319 in List, including the List node, is greater than or equal to
1320 PcdMaximumLinkedListLength, then ASSERT().
1322 @param List A pointer to the head node of a doubly linked list.
1324 @return The first node of a doubly linked list.
1325 @retval NULL The list is empty.
1331 IN CONST LIST_ENTRY
*List
1336 Retrieves the next node of a doubly linked list.
1338 Returns the node of a doubly linked list that follows Node. List must have
1339 been initialized with InitializeListHead(). If List is empty, then List is
1342 If List is NULL, then ASSERT().
1343 If Node is NULL, then ASSERT().
1344 If List was not initialized with InitializeListHead(), then ASSERT().
1345 If PcdMaximumLinkedListLenth is not zero, and List contains more than
1346 PcdMaximumLinkedListLenth nodes, then ASSERT().
1347 If Node is not a node in List, then ASSERT().
1349 @param List A pointer to the head node of a doubly linked list.
1350 @param Node A pointer to a node in the doubly linked list.
1352 @return Pointer to the next node if one exists. Otherwise a null value which
1353 is actually List is returned.
1359 IN CONST LIST_ENTRY
*List
,
1360 IN CONST LIST_ENTRY
*Node
1365 Checks to see if a doubly linked list is empty or not.
1367 Checks to see if the doubly linked list is empty. If the linked list contains
1368 zero nodes, this function returns TRUE. Otherwise, it returns FALSE.
1370 If ListHead is NULL, then ASSERT().
1371 If ListHead was not initialized with InitializeListHead(), then ASSERT().
1372 If PcdMaximumLinkedListLenth is not zero, and the number of nodes
1373 in List, including the List node, is greater than or equal to
1374 PcdMaximumLinkedListLength, then ASSERT().
1376 @param ListHead A pointer to the head node of a doubly linked list.
1378 @retval TRUE The linked list is empty.
1379 @retval FALSE The linked list is not empty.
1385 IN CONST LIST_ENTRY
*ListHead
1390 Determines if a node in a doubly linked list is null.
1392 Returns FALSE if Node is one of the nodes in the doubly linked list specified
1393 by List. Otherwise, TRUE is returned. List must have been initialized with
1394 InitializeListHead().
1396 If List is NULL, then ASSERT().
1397 If Node is NULL, then ASSERT().
1398 If List was not initialized with InitializeListHead(), then ASSERT().
1399 If PcdMaximumLinkedListLenth is not zero, and the number of nodes
1400 in List, including the List node, is greater than or equal to
1401 PcdMaximumLinkedListLength, then ASSERT().
1402 If Node is not a node in List and Node is not equal to List, then ASSERT().
1404 @param List A pointer to the head node of a doubly linked list.
1405 @param Node A pointer to a node in the doubly linked list.
1407 @retval TRUE Node is one of the nodes in the doubly linked list.
1408 @retval FALSE Node is not one of the nodes in the doubly linked list.
1414 IN CONST LIST_ENTRY
*List
,
1415 IN CONST LIST_ENTRY
*Node
1420 Determines if a node the last node in a doubly linked list.
1422 Returns TRUE if Node is the last node in the doubly linked list specified by
1423 List. Otherwise, FALSE is returned. List must have been initialized with
1424 InitializeListHead().
1426 If List is NULL, then ASSERT().
1427 If Node is NULL, then ASSERT().
1428 If List was not initialized with InitializeListHead(), then ASSERT().
1429 If PcdMaximumLinkedListLenth is not zero, and the number of nodes
1430 in List, including the List node, is greater than or equal to
1431 PcdMaximumLinkedListLength, then ASSERT().
1432 If Node is not a node in List, then ASSERT().
1434 @param List A pointer to the head node of a doubly linked list.
1435 @param Node A pointer to a node in the doubly linked list.
1437 @retval TRUE Node is the last node in the linked list.
1438 @retval FALSE Node is not the last node in the linked list.
1444 IN CONST LIST_ENTRY
*List
,
1445 IN CONST LIST_ENTRY
*Node
1450 Swaps the location of two nodes in a doubly linked list, and returns the
1451 first node after the swap.
1453 If FirstEntry is identical to SecondEntry, then SecondEntry is returned.
1454 Otherwise, the location of the FirstEntry node is swapped with the location
1455 of the SecondEntry node in a doubly linked list. SecondEntry must be in the
1456 same double linked list as FirstEntry and that double linked list must have
1457 been initialized with InitializeListHead(). SecondEntry is returned after the
1460 If FirstEntry is NULL, then ASSERT().
1461 If SecondEntry is NULL, then ASSERT().
1462 If SecondEntry and FirstEntry are not in the same linked list, then ASSERT().
1463 If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
1464 linked list containing the FirstEntry and SecondEntry nodes, including
1465 the FirstEntry and SecondEntry nodes, is greater than or equal to
1466 PcdMaximumLinkedListLength, then ASSERT().
1468 @param FirstEntry A pointer to a node in a linked list.
1469 @param SecondEntry A pointer to another node in the same linked list.
1475 IN LIST_ENTRY
*FirstEntry
,
1476 IN LIST_ENTRY
*SecondEntry
1481 Removes a node from a doubly linked list, and returns the node that follows
1484 Removes the node Entry from a doubly linked list. It is up to the caller of
1485 this function to release the memory used by this node if that is required. On
1486 exit, the node following Entry in the doubly linked list is returned. If
1487 Entry is the only node in the linked list, then the head node of the linked
1490 If Entry is NULL, then ASSERT().
1491 If Entry is the head node of an empty list, then ASSERT().
1492 If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
1493 linked list containing Entry, including the Entry node, is greater than
1494 or equal to PcdMaximumLinkedListLength, then ASSERT().
1496 @param Entry A pointer to a node in a linked list
1504 IN CONST LIST_ENTRY
*Entry
1512 Shifts a 64-bit integer left between 0 and 63 bits. The low bits are filled
1513 with zeros. The shifted value is returned.
1515 This function shifts the 64-bit value Operand to the left by Count bits. The
1516 low Count bits are set to zero. The shifted value is returned.
1518 If Count is greater than 63, then ASSERT().
1520 @param Operand The 64-bit operand to shift left.
1521 @param Count The number of bits to shift left.
1523 @return Operand << Count
1535 Shifts a 64-bit integer right between 0 and 63 bits. This high bits are
1536 filled with zeros. The shifted value is returned.
1538 This function shifts the 64-bit value Operand to the right by Count bits. The
1539 high Count bits are set to zero. The shifted value is returned.
1541 If Count is greater than 63, then ASSERT().
1543 @param Operand The 64-bit operand to shift right.
1544 @param Count The number of bits to shift right.
1546 @return Operand >> Count
1558 Shifts a 64-bit integer right between 0 and 63 bits. The high bits are filled
1559 with original integer's bit 63. The shifted value is returned.
1561 This function shifts the 64-bit value Operand to the right by Count bits. The
1562 high Count bits are set to bit 63 of Operand. The shifted value is returned.
1564 If Count is greater than 63, then ASSERT().
1566 @param Operand The 64-bit operand to shift right.
1567 @param Count The number of bits to shift right.
1569 @return Operand >> Count
1581 Rotates a 32-bit integer left between 0 and 31 bits, filling the low bits
1582 with the high bits that were rotated.
1584 This function rotates the 32-bit value Operand to the left by Count bits. The
1585 low Count bits are fill with the high Count bits of Operand. The rotated
1588 If Count is greater than 31, then ASSERT().
1590 @param Operand The 32-bit operand to rotate left.
1591 @param Count The number of bits to rotate left.
1593 @return Operand <<< Count
1605 Rotates a 32-bit integer right between 0 and 31 bits, filling the high bits
1606 with the low bits that were rotated.
1608 This function rotates the 32-bit value Operand to the right by Count bits.
1609 The high Count bits are fill with the low Count bits of Operand. The rotated
1612 If Count is greater than 31, then ASSERT().
1614 @param Operand The 32-bit operand to rotate right.
1615 @param Count The number of bits to rotate right.
1617 @return Operand >>> Count
1629 Rotates a 64-bit integer left between 0 and 63 bits, filling the low bits
1630 with the high bits that were rotated.
1632 This function rotates the 64-bit value Operand to the left by Count bits. The
1633 low Count bits are fill with the high Count bits of Operand. The rotated
1636 If Count is greater than 63, then ASSERT().
1638 @param Operand The 64-bit operand to rotate left.
1639 @param Count The number of bits to rotate left.
1641 @return Operand <<< Count
1653 Rotates a 64-bit integer right between 0 and 63 bits, filling the high bits
1654 with the high low bits that were rotated.
1656 This function rotates the 64-bit value Operand to the right by Count bits.
1657 The high Count bits are fill with the low Count bits of Operand. The rotated
1660 If Count is greater than 63, then ASSERT().
1662 @param Operand The 64-bit operand to rotate right.
1663 @param Count The number of bits to rotate right.
1665 @return Operand >>> Count
1677 Returns the bit position of the lowest bit set in a 32-bit value.
1679 This function computes the bit position of the lowest bit set in the 32-bit
1680 value specified by Operand. If Operand is zero, then -1 is returned.
1681 Otherwise, a value between 0 and 31 is returned.
1683 @param Operand The 32-bit operand to evaluate.
1685 @return Position of the lowest bit set in Operand if found.
1686 @retval -1 Operand is zero.
1697 Returns the bit position of the lowest bit set in a 64-bit value.
1699 This function computes the bit position of the lowest bit set in the 64-bit
1700 value specified by Operand. If Operand is zero, then -1 is returned.
1701 Otherwise, a value between 0 and 63 is returned.
1703 @param Operand The 64-bit operand to evaluate.
1705 @return Position of the lowest bit set in Operand if found.
1706 @retval -1 Operand is zero.
1717 Returns the bit position of the highest bit set in a 32-bit value. Equivalent
1720 This function computes the bit position of the highest bit set in the 32-bit
1721 value specified by Operand. If Operand is zero, then -1 is returned.
1722 Otherwise, a value between 0 and 31 is returned.
1724 @param Operand The 32-bit operand to evaluate.
1726 @return Position of the highest bit set in Operand if found.
1727 @retval -1 Operand is zero.
1738 Returns the bit position of the highest bit set in a 64-bit value. Equivalent
1741 This function computes the bit position of the highest bit set in the 64-bit
1742 value specified by Operand. If Operand is zero, then -1 is returned.
1743 Otherwise, a value between 0 and 63 is returned.
1745 @param Operand The 64-bit operand to evaluate.
1747 @return Position of the highest bit set in Operand if found.
1748 @retval -1 Operand is zero.
1759 Returns the value of the highest bit set in a 32-bit value. Equivalent to
1760 1 << HighBitSet32(x).
1762 This function computes the value of the highest bit set in the 32-bit value
1763 specified by Operand. If Operand is zero, then zero is returned.
1765 @param Operand The 32-bit operand to evaluate.
1767 @return 1 << HighBitSet32(Operand)
1768 @retval 0 Operand is zero.
1779 Returns the value of the highest bit set in a 64-bit value. Equivalent to
1780 1 << HighBitSet64(x).
1782 This function computes the value of the highest bit set in the 64-bit value
1783 specified by Operand. If Operand is zero, then zero is returned.
1785 @param Operand The 64-bit operand to evaluate.
1787 @return 1 << HighBitSet64(Operand)
1788 @retval 0 Operand is zero.
1799 Switches the endianess of a 16-bit integer.
1801 This function swaps the bytes in a 16-bit unsigned value to switch the value
1802 from little endian to big endian or vice versa. The byte swapped value is
1805 @param Value Operand A 16-bit unsigned value.
1807 @return The byte swaped Operand.
1818 Switches the endianess of a 32-bit integer.
1820 This function swaps the bytes in a 32-bit unsigned value to switch the value
1821 from little endian to big endian or vice versa. The byte swapped value is
1824 @param Value Operand A 32-bit unsigned value.
1826 @return The byte swaped Operand.
1837 Switches the endianess of a 64-bit integer.
1839 This function swaps the bytes in a 64-bit unsigned value to switch the value
1840 from little endian to big endian or vice versa. The byte swapped value is
1843 @param Value Operand A 64-bit unsigned value.
1845 @return The byte swaped Operand.
1856 Multiples a 64-bit unsigned integer by a 32-bit unsigned integer and
1857 generates a 64-bit unsigned result.
1859 This function multiples the 64-bit unsigned value Multiplicand by the 32-bit
1860 unsigned value Multiplier and generates a 64-bit unsigned result. This 64-
1861 bit unsigned result is returned.
1863 If the result overflows, then ASSERT().
1865 @param Multiplicand A 64-bit unsigned value.
1866 @param Multiplier A 32-bit unsigned value.
1868 @return Multiplicand * Multiplier
1874 IN UINT64 Multiplicand
,
1875 IN UINT32 Multiplier
1880 Multiples a 64-bit unsigned integer by a 64-bit unsigned integer and
1881 generates a 64-bit unsigned result.
1883 This function multiples the 64-bit unsigned value Multiplicand by the 64-bit
1884 unsigned value Multiplier and generates a 64-bit unsigned result. This 64-
1885 bit unsigned result is returned.
1887 If the result overflows, then ASSERT().
1889 @param Multiplicand A 64-bit unsigned value.
1890 @param Multiplier A 64-bit unsigned value.
1892 @return Multiplicand * Multiplier
1898 IN UINT64 Multiplicand
,
1899 IN UINT64 Multiplier
1904 Multiples a 64-bit signed integer by a 64-bit signed integer and generates a
1905 64-bit signed result.
1907 This function multiples the 64-bit signed value Multiplicand by the 64-bit
1908 signed value Multiplier and generates a 64-bit signed result. This 64-bit
1909 signed result is returned.
1911 If the result overflows, then ASSERT().
1913 @param Multiplicand A 64-bit signed value.
1914 @param Multiplier A 64-bit signed value.
1916 @return Multiplicand * Multiplier
1922 IN INT64 Multiplicand
,
1928 Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates
1929 a 64-bit unsigned result.
1931 This function divides the 64-bit unsigned value Dividend by the 32-bit
1932 unsigned value Divisor and generates a 64-bit unsigned quotient. This
1933 function returns the 64-bit unsigned quotient.
1935 If Divisor is 0, then ASSERT().
1937 @param Dividend A 64-bit unsigned value.
1938 @param Divisor A 32-bit unsigned value.
1940 @return Dividend / Divisor
1952 Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates
1953 a 32-bit unsigned remainder.
1955 This function divides the 64-bit unsigned value Dividend by the 32-bit
1956 unsigned value Divisor and generates a 32-bit remainder. This function
1957 returns the 32-bit unsigned remainder.
1959 If Divisor is 0, then ASSERT().
1961 @param Dividend A 64-bit unsigned value.
1962 @param Divisor A 32-bit unsigned value.
1964 @return Dividend % Divisor
1976 Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates
1977 a 64-bit unsigned result and an optional 32-bit unsigned remainder.
1979 This function divides the 64-bit unsigned value Dividend by the 32-bit
1980 unsigned value Divisor and generates a 64-bit unsigned quotient. If Remainder
1981 is not NULL, then the 32-bit unsigned remainder is returned in Remainder.
1982 This function returns the 64-bit unsigned quotient.
1984 If Divisor is 0, then ASSERT().
1986 @param Dividend A 64-bit unsigned value.
1987 @param Divisor A 32-bit unsigned value.
1988 @param Remainder A pointer to a 32-bit unsigned value. This parameter is
1989 optional and may be NULL.
1991 @return Dividend / Divisor
1996 DivU64x32Remainder (
1999 OUT UINT32
*Remainder OPTIONAL
2004 Divides a 64-bit unsigned integer by a 64-bit unsigned integer and generates
2005 a 64-bit unsigned result and an optional 64-bit unsigned remainder.
2007 This function divides the 64-bit unsigned value Dividend by the 64-bit
2008 unsigned value Divisor and generates a 64-bit unsigned quotient. If Remainder
2009 is not NULL, then the 64-bit unsigned remainder is returned in Remainder.
2010 This function returns the 64-bit unsigned quotient.
2012 If Divisor is 0, then ASSERT().
2014 @param Dividend A 64-bit unsigned value.
2015 @param Divisor A 64-bit unsigned value.
2016 @param Remainder A pointer to a 64-bit unsigned value. This parameter is
2017 optional and may be NULL.
2019 @return Dividend / Divisor
2024 DivU64x64Remainder (
2027 OUT UINT64
*Remainder OPTIONAL
2032 Divides a 64-bit signed integer by a 64-bit signed integer and generates a
2033 64-bit signed result and a optional 64-bit signed remainder.
2035 This function divides the 64-bit signed value Dividend by the 64-bit signed
2036 value Divisor and generates a 64-bit signed quotient. If Remainder is not
2037 NULL, then the 64-bit signed remainder is returned in Remainder. This
2038 function returns the 64-bit signed quotient.
2040 If Divisor is 0, then ASSERT().
2042 @param Dividend A 64-bit signed value.
2043 @param Divisor A 64-bit signed value.
2044 @param Remainder A pointer to a 64-bit signed value. This parameter is
2045 optional and may be NULL.
2047 @return Dividend / Divisor
2052 DivS64x64Remainder (
2055 OUT INT64
*Remainder OPTIONAL
2060 Reads a 16-bit value from memory that may be unaligned.
2062 This function returns the 16-bit value pointed to by Buffer. The function
2063 guarantees that the read operation does not produce an alignment fault.
2065 If the Buffer is NULL, then ASSERT().
2067 @param Uint16 Pointer to a 16-bit value that may be unaligned.
2075 IN CONST UINT16
*Uint16
2080 Writes a 16-bit value to memory that may be unaligned.
2082 This function writes the 16-bit value specified by Value to Buffer. Value is
2083 returned. The function guarantees that the write operation does not produce
2086 If the Buffer is NULL, then ASSERT().
2088 @param Uint16 Pointer to a 16-bit value that may be unaligned.
2089 @param Value 16-bit value to write to Buffer.
2103 Reads a 24-bit value from memory that may be unaligned.
2105 This function returns the 24-bit value pointed to by Buffer. The function
2106 guarantees that the read operation does not produce an alignment fault.
2108 If the Buffer is NULL, then ASSERT().
2110 @param Buffer Pointer to a 24-bit value that may be unaligned.
2112 @return The value read.
2118 IN CONST UINT32
*Buffer
2123 Writes a 24-bit value to memory that may be unaligned.
2125 This function writes the 24-bit value specified by Value to Buffer. Value is
2126 returned. The function guarantees that the write operation does not produce
2129 If the Buffer is NULL, then ASSERT().
2131 @param Buffer Pointer to a 24-bit value that may be unaligned.
2132 @param Value 24-bit value to write to Buffer.
2134 @return The value written.
2146 Reads a 32-bit value from memory that may be unaligned.
2148 This function returns the 32-bit value pointed to by Buffer. The function
2149 guarantees that the read operation does not produce an alignment fault.
2151 If the Buffer is NULL, then ASSERT().
2153 @param Uint32 Pointer to a 32-bit value that may be unaligned.
2161 IN CONST UINT32
*Uint32
2166 Writes a 32-bit value to memory that may be unaligned.
2168 This function writes the 32-bit value specified by Value to Buffer. Value is
2169 returned. The function guarantees that the write operation does not produce
2172 If the Buffer is NULL, then ASSERT().
2174 @param Uint32 Pointer to a 32-bit value that may be unaligned.
2175 @param Value 32-bit value to write to Buffer.
2189 Reads a 64-bit value from memory that may be unaligned.
2191 This function returns the 64-bit value pointed to by Buffer. The function
2192 guarantees that the read operation does not produce an alignment fault.
2194 If the Buffer is NULL, then ASSERT().
2196 @param Uint64 Pointer to a 64-bit value that may be unaligned.
2204 IN CONST UINT64
*Uint64
2209 Writes a 64-bit value to memory that may be unaligned.
2211 This function writes the 64-bit value specified by Value to Buffer. Value is
2212 returned. The function guarantees that the write operation does not produce
2215 If the Buffer is NULL, then ASSERT().
2217 @param Uint64 Pointer to a 64-bit value that may be unaligned.
2218 @param Value 64-bit value to write to Buffer.
2232 // Bit Field Functions
2236 Returns a bit field from an 8-bit value.
2238 Returns the bitfield specified by the StartBit and the EndBit from Operand.
2240 If 8-bit operations are not supported, then ASSERT().
2241 If StartBit is greater than 7, then ASSERT().
2242 If EndBit is greater than 7, then ASSERT().
2243 If EndBit is less than StartBit, then ASSERT().
2245 @param Operand Operand on which to perform the bitfield operation.
2246 @param StartBit The ordinal of the least significant bit in the bit field.
2248 @param EndBit The ordinal of the most significant bit in the bit field.
2251 @return The bit field read.
2264 Writes a bit field to an 8-bit value, and returns the result.
2266 Writes Value to the bit field specified by the StartBit and the EndBit in
2267 Operand. All other bits in Operand are preserved. The new 8-bit value is
2270 If 8-bit operations are not supported, then ASSERT().
2271 If StartBit is greater than 7, then ASSERT().
2272 If EndBit is greater than 7, then ASSERT().
2273 If EndBit is less than StartBit, then ASSERT().
2275 @param Operand Operand on which to perform the bitfield operation.
2276 @param StartBit The ordinal of the least significant bit in the bit field.
2278 @param EndBit The ordinal of the most significant bit in the bit field.
2280 @param Value New value of the bit field.
2282 @return The new 8-bit value.
2296 Reads a bit field from an 8-bit value, performs a bitwise OR, and returns the
2299 Performs a bitwise inclusive OR between the bit field specified by StartBit
2300 and EndBit in Operand and the value specified by OrData. All other bits in
2301 Operand are preserved. The new 8-bit value is returned.
2303 If 8-bit operations are not supported, then ASSERT().
2304 If StartBit is greater than 7, then ASSERT().
2305 If EndBit is greater than 7, then ASSERT().
2306 If EndBit is less than StartBit, then ASSERT().
2308 @param Operand Operand on which to perform the bitfield operation.
2309 @param StartBit The ordinal of the least significant bit in the bit field.
2311 @param EndBit The ordinal of the most significant bit in the bit field.
2313 @param OrData The value to OR with the read value from the value
2315 @return The new 8-bit value.
2329 Reads a bit field from an 8-bit value, performs a bitwise AND, and returns
2332 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2333 in Operand and the value specified by AndData. All other bits in Operand are
2334 preserved. The new 8-bit value is returned.
2336 If 8-bit operations are not supported, then ASSERT().
2337 If StartBit is greater than 7, then ASSERT().
2338 If EndBit is greater than 7, then ASSERT().
2339 If EndBit is less than StartBit, then ASSERT().
2341 @param Operand Operand on which to perform the bitfield operation.
2342 @param StartBit The ordinal of the least significant bit in the bit field.
2344 @param EndBit The ordinal of the most significant bit in the bit field.
2346 @param AndData The value to AND with the read value from the value.
2348 @return The new 8-bit value.
2362 Reads a bit field from an 8-bit value, performs a bitwise AND followed by a
2363 bitwise OR, and returns the result.
2365 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2366 in Operand and the value specified by AndData, followed by a bitwise
2367 inclusive OR with value specified by OrData. All other bits in Operand are
2368 preserved. The new 8-bit value is returned.
2370 If 8-bit operations are not supported, then ASSERT().
2371 If StartBit is greater than 7, then ASSERT().
2372 If EndBit is greater than 7, then ASSERT().
2373 If EndBit is less than StartBit, then ASSERT().
2375 @param Operand Operand on which to perform the bitfield operation.
2376 @param StartBit The ordinal of the least significant bit in the bit field.
2378 @param EndBit The ordinal of the most significant bit in the bit field.
2380 @param AndData The value to AND with the read value from the value.
2381 @param OrData The value to OR with the result of the AND operation.
2383 @return The new 8-bit value.
2388 BitFieldAndThenOr8 (
2398 Returns a bit field from a 16-bit value.
2400 Returns the bitfield specified by the StartBit and the EndBit from Operand.
2402 If 16-bit operations are not supported, then ASSERT().
2403 If StartBit is greater than 15, then ASSERT().
2404 If EndBit is greater than 15, then ASSERT().
2405 If EndBit is less than StartBit, then ASSERT().
2407 @param Operand Operand on which to perform the bitfield operation.
2408 @param StartBit The ordinal of the least significant bit in the bit field.
2410 @param EndBit The ordinal of the most significant bit in the bit field.
2413 @return The bit field read.
2426 Writes a bit field to a 16-bit value, and returns the result.
2428 Writes Value to the bit field specified by the StartBit and the EndBit in
2429 Operand. All other bits in Operand are preserved. The new 16-bit value is
2432 If 16-bit operations are not supported, then ASSERT().
2433 If StartBit is greater than 15, then ASSERT().
2434 If EndBit is greater than 15, then ASSERT().
2435 If EndBit is less than StartBit, then ASSERT().
2437 @param Operand Operand on which to perform the bitfield operation.
2438 @param StartBit The ordinal of the least significant bit in the bit field.
2440 @param EndBit The ordinal of the most significant bit in the bit field.
2442 @param Value New value of the bit field.
2444 @return The new 16-bit value.
2458 Reads a bit field from a 16-bit value, performs a bitwise OR, and returns the
2461 Performs a bitwise inclusive OR between the bit field specified by StartBit
2462 and EndBit in Operand and the value specified by OrData. All other bits in
2463 Operand are preserved. The new 16-bit value is returned.
2465 If 16-bit operations are not supported, then ASSERT().
2466 If StartBit is greater than 15, then ASSERT().
2467 If EndBit is greater than 15, then ASSERT().
2468 If EndBit is less than StartBit, then ASSERT().
2470 @param Operand Operand on which to perform the bitfield operation.
2471 @param StartBit The ordinal of the least significant bit in the bit field.
2473 @param EndBit The ordinal of the most significant bit in the bit field.
2475 @param OrData The value to OR with the read value from the value
2477 @return The new 16-bit value.
2491 Reads a bit field from a 16-bit value, performs a bitwise AND, and returns
2494 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2495 in Operand and the value specified by AndData. All other bits in Operand are
2496 preserved. The new 16-bit value is returned.
2498 If 16-bit operations are not supported, then ASSERT().
2499 If StartBit is greater than 15, then ASSERT().
2500 If EndBit is greater than 15, then ASSERT().
2501 If EndBit is less than StartBit, then ASSERT().
2503 @param Operand Operand on which to perform the bitfield operation.
2504 @param StartBit The ordinal of the least significant bit in the bit field.
2506 @param EndBit The ordinal of the most significant bit in the bit field.
2508 @param AndData The value to AND with the read value from the value
2510 @return The new 16-bit value.
2524 Reads a bit field from a 16-bit value, performs a bitwise AND followed by a
2525 bitwise OR, and returns the result.
2527 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2528 in Operand and the value specified by AndData, followed by a bitwise
2529 inclusive OR with value specified by OrData. All other bits in Operand are
2530 preserved. The new 16-bit value is returned.
2532 If 16-bit operations are not supported, then ASSERT().
2533 If StartBit is greater than 15, then ASSERT().
2534 If EndBit is greater than 15, then ASSERT().
2535 If EndBit is less than StartBit, then ASSERT().
2537 @param Operand Operand on which to perform the bitfield operation.
2538 @param StartBit The ordinal of the least significant bit in the bit field.
2540 @param EndBit The ordinal of the most significant bit in the bit field.
2542 @param AndData The value to AND with the read value from the value.
2543 @param OrData The value to OR with the result of the AND operation.
2545 @return The new 16-bit value.
2550 BitFieldAndThenOr16 (
2560 Returns a bit field from a 32-bit value.
2562 Returns the bitfield specified by the StartBit and the EndBit from Operand.
2564 If 32-bit operations are not supported, then ASSERT().
2565 If StartBit is greater than 31, then ASSERT().
2566 If EndBit is greater than 31, then ASSERT().
2567 If EndBit is less than StartBit, then ASSERT().
2569 @param Operand Operand on which to perform the bitfield operation.
2570 @param StartBit The ordinal of the least significant bit in the bit field.
2572 @param EndBit The ordinal of the most significant bit in the bit field.
2575 @return The bit field read.
2588 Writes a bit field to a 32-bit value, and returns the result.
2590 Writes Value to the bit field specified by the StartBit and the EndBit in
2591 Operand. All other bits in Operand are preserved. The new 32-bit value is
2594 If 32-bit operations are not supported, then ASSERT().
2595 If StartBit is greater than 31, then ASSERT().
2596 If EndBit is greater than 31, then ASSERT().
2597 If EndBit is less than StartBit, then ASSERT().
2599 @param Operand Operand on which to perform the bitfield operation.
2600 @param StartBit The ordinal of the least significant bit in the bit field.
2602 @param EndBit The ordinal of the most significant bit in the bit field.
2604 @param Value New value of the bit field.
2606 @return The new 32-bit value.
2620 Reads a bit field from a 32-bit value, performs a bitwise OR, and returns the
2623 Performs a bitwise inclusive OR between the bit field specified by StartBit
2624 and EndBit in Operand and the value specified by OrData. All other bits in
2625 Operand are preserved. The new 32-bit value is returned.
2627 If 32-bit operations are not supported, then ASSERT().
2628 If StartBit is greater than 31, then ASSERT().
2629 If EndBit is greater than 31, then ASSERT().
2630 If EndBit is less than StartBit, then ASSERT().
2632 @param Operand Operand on which to perform the bitfield operation.
2633 @param StartBit The ordinal of the least significant bit in the bit field.
2635 @param EndBit The ordinal of the most significant bit in the bit field.
2637 @param OrData The value to OR with the read value from the value
2639 @return The new 32-bit value.
2653 Reads a bit field from a 32-bit value, performs a bitwise AND, and returns
2656 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2657 in Operand and the value specified by AndData. All other bits in Operand are
2658 preserved. The new 32-bit value is returned.
2660 If 32-bit operations are not supported, then ASSERT().
2661 If StartBit is greater than 31, then ASSERT().
2662 If EndBit is greater than 31, then ASSERT().
2663 If EndBit is less than StartBit, then ASSERT().
2665 @param Operand Operand on which to perform the bitfield operation.
2666 @param StartBit The ordinal of the least significant bit in the bit field.
2668 @param EndBit The ordinal of the most significant bit in the bit field.
2670 @param AndData The value to AND with the read value from the value
2672 @return The new 32-bit value.
2686 Reads a bit field from a 32-bit value, performs a bitwise AND followed by a
2687 bitwise OR, and returns the result.
2689 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2690 in Operand and the value specified by AndData, followed by a bitwise
2691 inclusive OR with value specified by OrData. All other bits in Operand are
2692 preserved. The new 32-bit value is returned.
2694 If 32-bit operations are not supported, then ASSERT().
2695 If StartBit is greater than 31, then ASSERT().
2696 If EndBit is greater than 31, then ASSERT().
2697 If EndBit is less than StartBit, then ASSERT().
2699 @param Operand Operand on which to perform the bitfield operation.
2700 @param StartBit The ordinal of the least significant bit in the bit field.
2702 @param EndBit The ordinal of the most significant bit in the bit field.
2704 @param AndData The value to AND with the read value from the value.
2705 @param OrData The value to OR with the result of the AND operation.
2707 @return The new 32-bit value.
2712 BitFieldAndThenOr32 (
2722 Returns a bit field from a 64-bit value.
2724 Returns the bitfield specified by the StartBit and the EndBit from Operand.
2726 If 64-bit operations are not supported, then ASSERT().
2727 If StartBit is greater than 63, then ASSERT().
2728 If EndBit is greater than 63, then ASSERT().
2729 If EndBit is less than StartBit, then ASSERT().
2731 @param Operand Operand on which to perform the bitfield operation.
2732 @param StartBit The ordinal of the least significant bit in the bit field.
2734 @param EndBit The ordinal of the most significant bit in the bit field.
2737 @return The bit field read.
2750 Writes a bit field to a 64-bit value, and returns the result.
2752 Writes Value to the bit field specified by the StartBit and the EndBit in
2753 Operand. All other bits in Operand are preserved. The new 64-bit value is
2756 If 64-bit operations are not supported, then ASSERT().
2757 If StartBit is greater than 63, then ASSERT().
2758 If EndBit is greater than 63, then ASSERT().
2759 If EndBit is less than StartBit, then ASSERT().
2761 @param Operand Operand on which to perform the bitfield operation.
2762 @param StartBit The ordinal of the least significant bit in the bit field.
2764 @param EndBit The ordinal of the most significant bit in the bit field.
2766 @param Value New value of the bit field.
2768 @return The new 64-bit value.
2782 Reads a bit field from a 64-bit value, performs a bitwise OR, and returns the
2785 Performs a bitwise inclusive OR between the bit field specified by StartBit
2786 and EndBit in Operand and the value specified by OrData. All other bits in
2787 Operand are preserved. The new 64-bit value is returned.
2789 If 64-bit operations are not supported, then ASSERT().
2790 If StartBit is greater than 63, then ASSERT().
2791 If EndBit is greater than 63, then ASSERT().
2792 If EndBit is less than StartBit, then ASSERT().
2794 @param Operand Operand on which to perform the bitfield operation.
2795 @param StartBit The ordinal of the least significant bit in the bit field.
2797 @param EndBit The ordinal of the most significant bit in the bit field.
2799 @param OrData The value to OR with the read value from the value
2801 @return The new 64-bit value.
2815 Reads a bit field from a 64-bit value, performs a bitwise AND, and returns
2818 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2819 in Operand and the value specified by AndData. All other bits in Operand are
2820 preserved. The new 64-bit value is returned.
2822 If 64-bit operations are not supported, then ASSERT().
2823 If StartBit is greater than 63, then ASSERT().
2824 If EndBit is greater than 63, then ASSERT().
2825 If EndBit is less than StartBit, then ASSERT().
2827 @param Operand Operand on which to perform the bitfield operation.
2828 @param StartBit The ordinal of the least significant bit in the bit field.
2830 @param EndBit The ordinal of the most significant bit in the bit field.
2832 @param AndData The value to AND with the read value from the value
2834 @return The new 64-bit value.
2848 Reads a bit field from a 64-bit value, performs a bitwise AND followed by a
2849 bitwise OR, and returns the result.
2851 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2852 in Operand and the value specified by AndData, followed by a bitwise
2853 inclusive OR with value specified by OrData. All other bits in Operand are
2854 preserved. The new 64-bit value is returned.
2856 If 64-bit operations are not supported, then ASSERT().
2857 If StartBit is greater than 63, then ASSERT().
2858 If EndBit is greater than 63, then ASSERT().
2859 If EndBit is less than StartBit, then ASSERT().
2861 @param Operand Operand on which to perform the bitfield operation.
2862 @param StartBit The ordinal of the least significant bit in the bit field.
2864 @param EndBit The ordinal of the most significant bit in the bit field.
2866 @param AndData The value to AND with the read value from the value.
2867 @param OrData The value to OR with the result of the AND operation.
2869 @return The new 64-bit value.
2874 BitFieldAndThenOr64 (
2884 // Base Library Synchronization Functions
2888 Retrieves the architecture specific spin lock alignment requirements for
2889 optimal spin lock performance.
2891 This function retrieves the spin lock alignment requirements for optimal
2892 performance on a given CPU architecture. The spin lock alignment must be a
2893 power of two and is returned by this function. If there are no alignment
2894 requirements, then 1 must be returned. The spin lock synchronization
2895 functions must function correctly if the spin lock size and alignment values
2896 returned by this function are not used at all. These values are hints to the
2897 consumers of the spin lock synchronization functions to obtain optimal spin
2900 @return The architecture specific spin lock alignment.
2905 GetSpinLockProperties (
2911 Initializes a spin lock to the released state and returns the spin lock.
2913 This function initializes the spin lock specified by SpinLock to the released
2914 state, and returns SpinLock. Optimal performance can be achieved by calling
2915 GetSpinLockProperties() to determine the size and alignment requirements for
2918 If SpinLock is NULL, then ASSERT().
2920 @param SpinLock A pointer to the spin lock to initialize to the released
2928 InitializeSpinLock (
2929 IN SPIN_LOCK
*SpinLock
2934 Waits until a spin lock can be placed in the acquired state.
2936 This function checks the state of the spin lock specified by SpinLock. If
2937 SpinLock is in the released state, then this function places SpinLock in the
2938 acquired state and returns SpinLock. Otherwise, this function waits
2939 indefinitely for the spin lock to be released, and then places it in the
2940 acquired state and returns SpinLock. All state transitions of SpinLock must
2941 be performed using MP safe mechanisms.
2943 If SpinLock is NULL, then ASSERT().
2944 If SpinLock was not initialized with InitializeSpinLock(), then ASSERT().
2945 If PcdSpinLockTimeout is not zero, and SpinLock is can not be acquired in
2946 PcdSpinLockTimeout microseconds, then ASSERT().
2948 @param SpinLock A pointer to the spin lock to place in the acquired state.
2956 IN SPIN_LOCK
*SpinLock
2961 Attempts to place a spin lock in the acquired state.
2963 This function checks the state of the spin lock specified by SpinLock. If
2964 SpinLock is in the released state, then this function places SpinLock in the
2965 acquired state and returns TRUE. Otherwise, FALSE is returned. All state
2966 transitions of SpinLock must be performed using MP safe mechanisms.
2968 If SpinLock is NULL, then ASSERT().
2969 If SpinLock was not initialized with InitializeSpinLock(), then ASSERT().
2971 @param SpinLock A pointer to the spin lock to place in the acquired state.
2973 @retval TRUE SpinLock was placed in the acquired state.
2974 @retval FALSE SpinLock could not be acquired.
2979 AcquireSpinLockOrFail (
2980 IN SPIN_LOCK
*SpinLock
2985 Releases a spin lock.
2987 This function places the spin lock specified by SpinLock in the release state
2988 and returns SpinLock.
2990 If SpinLock is NULL, then ASSERT().
2991 If SpinLock was not initialized with InitializeSpinLock(), then ASSERT().
2993 @param SpinLock A pointer to the spin lock to release.
3001 IN SPIN_LOCK
*SpinLock
3006 Performs an atomic increment of an 32-bit unsigned integer.
3008 Performs an atomic increment of the 32-bit unsigned integer specified by
3009 Value and returns the incremented value. The increment operation must be
3010 performed using MP safe mechanisms. The state of the return value is not
3011 guaranteed to be MP safe.
3013 If Value is NULL, then ASSERT().
3015 @param Value A pointer to the 32-bit value to increment.
3017 @return The incremented value.
3022 InterlockedIncrement (
3028 Performs an atomic decrement of an 32-bit unsigned integer.
3030 Performs an atomic decrement of the 32-bit unsigned integer specified by
3031 Value and returns the decremented value. The decrement operation must be
3032 performed using MP safe mechanisms. The state of the return value is not
3033 guaranteed to be MP safe.
3035 If Value is NULL, then ASSERT().
3037 @param Value A pointer to the 32-bit value to decrement.
3039 @return The decremented value.
3044 InterlockedDecrement (
3050 Performs an atomic compare exchange operation on a 32-bit unsigned integer.
3052 Performs an atomic compare exchange operation on the 32-bit unsigned integer
3053 specified by Value. If Value is equal to CompareValue, then Value is set to
3054 ExchangeValue and CompareValue is returned. If Value is not equal to CompareValue,
3055 then Value is returned. The compare exchange operation must be performed using
3058 If Value is NULL, then ASSERT().
3060 @param Value A pointer to the 32-bit value for the compare exchange
3062 @param CompareValue 32-bit value used in compare operation.
3063 @param ExchangeValue 32-bit value used in exchange operation.
3065 @return The original *Value before exchange.
3070 InterlockedCompareExchange32 (
3071 IN OUT UINT32
*Value
,
3072 IN UINT32 CompareValue
,
3073 IN UINT32 ExchangeValue
3078 Performs an atomic compare exchange operation on a 64-bit unsigned integer.
3080 Performs an atomic compare exchange operation on the 64-bit unsigned integer specified
3081 by Value. If Value is equal to CompareValue, then Value is set to ExchangeValue and
3082 CompareValue is returned. If Value is not equal to CompareValue, then Value is returned.
3083 The compare exchange operation must be performed using MP safe mechanisms.
3085 If Value is NULL, then ASSERT().
3087 @param Value A pointer to the 64-bit value for the compare exchange
3089 @param CompareValue 64-bit value used in compare operation.
3090 @param ExchangeValue 64-bit value used in exchange operation.
3092 @return The original *Value before exchange.
3097 InterlockedCompareExchange64 (
3098 IN OUT UINT64
*Value
,
3099 IN UINT64 CompareValue
,
3100 IN UINT64 ExchangeValue
3105 Performs an atomic compare exchange operation on a pointer value.
3107 Performs an atomic compare exchange operation on the pointer value specified
3108 by Value. If Value is equal to CompareValue, then Value is set to
3109 ExchangeValue and CompareValue is returned. If Value is not equal to
3110 CompareValue, then Value is returned. The compare exchange operation must be
3111 performed using MP safe mechanisms.
3113 If Value is NULL, then ASSERT().
3115 @param Value A pointer to the pointer value for the compare exchange
3117 @param CompareValue Pointer value used in compare operation.
3118 @param ExchangeValue Pointer value used in exchange operation.
3123 InterlockedCompareExchangePointer (
3124 IN OUT VOID
**Value
,
3125 IN VOID
*CompareValue
,
3126 IN VOID
*ExchangeValue
3131 // Base Library Checksum Functions
3135 Calculate the sum of all elements in a buffer in unit of UINT8.
3136 During calculation, the carry bits are dropped.
3138 This function calculates the sum of all elements in a buffer
3139 in unit of UINT8. The carry bits in result of addition are dropped.
3140 The result is returned as UINT8. If Length is Zero, then Zero is
3143 If Buffer is NULL, then ASSERT().
3144 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3146 @param Buffer Pointer to the buffer to carry out the sum operation.
3147 @param Length The size, in bytes, of Buffer .
3149 @return Sum The sum of Buffer with carry bits dropped during additions.
3155 IN CONST UINT8
*Buffer
,
3161 Returns the two's complement checksum of all elements in a buffer
3164 This function first calculates the sum of the 8-bit values in the
3165 buffer specified by Buffer and Length. The carry bits in the result
3166 of addition are dropped. Then, the two's complement of the sum is
3167 returned. If Length is 0, then 0 is returned.
3169 If Buffer is NULL, then ASSERT().
3170 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3173 @param Buffer Pointer to the buffer to carry out the checksum operation.
3174 @param Length The size, in bytes, of Buffer.
3176 @return Checksum The 2's complement checksum of Buffer.
3181 CalculateCheckSum8 (
3182 IN CONST UINT8
*Buffer
,
3188 Returns the sum of all elements in a buffer of 16-bit values. During
3189 calculation, the carry bits are dropped.
3191 This function calculates the sum of the 16-bit values in the buffer
3192 specified by Buffer and Length. The carry bits in result of addition are dropped.
3193 The 16-bit result is returned. If Length is 0, then 0 is returned.
3195 If Buffer is NULL, then ASSERT().
3196 If Buffer is not aligned on a 16-bit boundary, then ASSERT().
3197 If Length is not aligned on a 16-bit boundary, then ASSERT().
3198 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3200 @param Buffer Pointer to the buffer to carry out the sum operation.
3201 @param Length The size, in bytes, of Buffer.
3203 @return Sum The sum of Buffer with carry bits dropped during additions.
3209 IN CONST UINT16
*Buffer
,
3215 Returns the two's complement checksum of all elements in a buffer of
3218 This function first calculates the sum of the 16-bit values in the buffer
3219 specified by Buffer and Length. The carry bits in the result of addition
3220 are dropped. Then, the two's complement of the sum is returned. If Length
3221 is 0, then 0 is returned.
3223 If Buffer is NULL, then ASSERT().
3224 If Buffer is not aligned on a 16-bit boundary, then ASSERT().
3225 If Length is not aligned on a 16-bit boundary, then ASSERT().
3226 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3228 @param Buffer Pointer to the buffer to carry out the checksum operation.
3229 @param Length The size, in bytes, of Buffer.
3231 @return Checksum The 2's complement checksum of Buffer.
3236 CalculateCheckSum16 (
3237 IN CONST UINT16
*Buffer
,
3243 Returns the sum of all elements in a buffer of 32-bit values. During
3244 calculation, the carry bits are dropped.
3246 This function calculates the sum of the 32-bit values in the buffer
3247 specified by Buffer and Length. The carry bits in result of addition are dropped.
3248 The 32-bit result is returned. If Length is 0, then 0 is returned.
3250 If Buffer is NULL, then ASSERT().
3251 If Buffer is not aligned on a 32-bit boundary, then ASSERT().
3252 If Length is not aligned on a 32-bit boundary, then ASSERT().
3253 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3255 @param Buffer Pointer to the buffer to carry out the sum operation.
3256 @param Length The size, in bytes, of Buffer.
3258 @return Sum The sum of Buffer with carry bits dropped during additions.
3264 IN CONST UINT32
*Buffer
,
3270 Returns the two's complement checksum of all elements in a buffer of
3273 This function first calculates the sum of the 32-bit values in the buffer
3274 specified by Buffer and Length. The carry bits in the result of addition
3275 are dropped. Then, the two's complement of the sum is returned. If Length
3276 is 0, then 0 is returned.
3278 If Buffer is NULL, then ASSERT().
3279 If Buffer is not aligned on a 32-bit boundary, then ASSERT().
3280 If Length is not aligned on a 32-bit boundary, then ASSERT().
3281 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3283 @param Buffer Pointer to the buffer to carry out the checksum operation.
3284 @param Length The size, in bytes, of Buffer.
3286 @return Checksum The 2's complement checksum of Buffer.
3291 CalculateCheckSum32 (
3292 IN CONST UINT32
*Buffer
,
3298 Returns the sum of all elements in a buffer of 64-bit values. During
3299 calculation, the carry bits are dropped.
3301 This function calculates the sum of the 64-bit values in the buffer
3302 specified by Buffer and Length. The carry bits in result of addition are dropped.
3303 The 64-bit result is returned. If Length is 0, then 0 is returned.
3305 If Buffer is NULL, then ASSERT().
3306 If Buffer is not aligned on a 64-bit boundary, then ASSERT().
3307 If Length is not aligned on a 64-bit boundary, then ASSERT().
3308 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3310 @param Buffer Pointer to the buffer to carry out the sum operation.
3311 @param Length The size, in bytes, of Buffer.
3313 @return Sum The sum of Buffer with carry bits dropped during additions.
3319 IN CONST UINT64
*Buffer
,
3325 Returns the two's complement checksum of all elements in a buffer of
3328 This function first calculates the sum of the 64-bit values in the buffer
3329 specified by Buffer and Length. The carry bits in the result of addition
3330 are dropped. Then, the two's complement of the sum is returned. If Length
3331 is 0, then 0 is returned.
3333 If Buffer is NULL, then ASSERT().
3334 If Buffer is not aligned on a 64-bit boundary, then ASSERT().
3335 If Length is not aligned on a 64-bit boundary, then ASSERT().
3336 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3338 @param Buffer Pointer to the buffer to carry out the checksum operation.
3339 @param Length The size, in bytes, of Buffer.
3341 @return Checksum The 2's complement checksum of Buffer.
3346 CalculateCheckSum64 (
3347 IN CONST UINT64
*Buffer
,
3353 // Base Library CPU Functions
3357 (EFIAPI
*SWITCH_STACK_ENTRY_POINT
) (
3358 IN VOID
*Context1
, OPTIONAL
3359 IN VOID
*Context2 OPTIONAL
3364 Used to serialize load and store operations.
3366 All loads and stores that proceed calls to this function are guaranteed to be
3367 globally visible when this function returns.
3378 Saves the current CPU context that can be restored with a call to LongJump()
3381 Saves the current CPU context in the buffer specified by JumpBuffer and
3382 returns 0. The initial call to SetJump() must always return 0. Subsequent
3383 calls to LongJump() cause a non-zero value to be returned by SetJump().
3385 If JumpBuffer is NULL, then ASSERT().
3386 For IPF CPUs, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().
3388 @param JumpBuffer A pointer to CPU context buffer.
3390 @retval 0 Indicates a return from SetJump().
3396 OUT BASE_LIBRARY_JUMP_BUFFER
*JumpBuffer
3401 Restores the CPU context that was saved with SetJump().
3403 Restores the CPU context from the buffer specified by JumpBuffer. This
3404 function never returns to the caller. Instead is resumes execution based on
3405 the state of JumpBuffer.
3407 If JumpBuffer is NULL, then ASSERT().
3408 For IPF CPUs, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().
3409 If Value is 0, then ASSERT().
3411 @param JumpBuffer A pointer to CPU context buffer.
3412 @param Value The value to return when the SetJump() context is
3413 restored and must be non-zero.
3419 IN BASE_LIBRARY_JUMP_BUFFER
*JumpBuffer
,
3425 Enables CPU interrupts.
3427 Enables CPU interrupts.
3438 Disables CPU interrupts.
3440 Disables CPU interrupts.
3451 Disables CPU interrupts and returns the interrupt state prior to the disable
3454 Disables CPU interrupts and returns the interrupt state prior to the disable
3457 @retval TRUE CPU interrupts were enabled on entry to this call.
3458 @retval FALSE CPU interrupts were disabled on entry to this call.
3463 SaveAndDisableInterrupts (
3469 Enables CPU interrupts for the smallest window required to capture any
3472 Enables CPU interrupts for the smallest window required to capture any
3478 EnableDisableInterrupts (
3484 Retrieves the current CPU interrupt state.
3486 Retrieves the current CPU interrupt state. Returns TRUE is interrupts are
3487 currently enabled. Otherwise returns FALSE.
3489 @retval TRUE CPU interrupts are enabled.
3490 @retval FALSE CPU interrupts are disabled.
3501 Set the current CPU interrupt state.
3503 Sets the current CPU interrupt state to the state specified by
3504 InterruptState. If InterruptState is TRUE, then interrupts are enabled. If
3505 InterruptState is FALSE, then interrupts are disabled. InterruptState is
3508 @param InterruptState TRUE if interrupts should enabled. FALSE if
3509 interrupts should be disabled.
3511 @return InterruptState
3517 IN BOOLEAN InterruptState
3522 Requests CPU to pause for a short period of time.
3524 Requests CPU to pause for a short period of time. Typically used in MP
3525 systems to prevent memory starvation while waiting for a spin lock.
3536 Transfers control to a function starting with a new stack.
3538 Transfers control to the function specified by EntryPoint using the
3539 new stack specified by NewStack and passing in the parameters specified
3540 by Context1 and Context2. Context1 and Context2 are optional and may
3541 be NULL. The function EntryPoint must never return. This function
3542 supports a variable number of arguments following the NewStack parameter.
3543 These additional arguments are ignored on IA-32, x64, and EBC.
3544 IPF CPUs expect one additional parameter of type VOID * that specifies
3545 the new backing store pointer.
3547 If EntryPoint is NULL, then ASSERT().
3548 If NewStack is NULL, then ASSERT().
3550 @param EntryPoint A pointer to function to call with the new stack.
3551 @param Context1 A pointer to the context to pass into the EntryPoint
3553 @param Context2 A pointer to the context to pass into the EntryPoint
3555 @param NewStack A pointer to the new stack to use for the EntryPoint
3562 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
3563 IN VOID
*Context1
, OPTIONAL
3564 IN VOID
*Context2
, OPTIONAL
3571 Generates a breakpoint on the CPU.
3573 Generates a breakpoint on the CPU. The breakpoint must be implemented such
3574 that code can resume normal execution after the breakpoint.
3585 Executes an infinite loop.
3587 Forces the CPU to execute an infinite loop. A debugger may be used to skip
3588 past the loop and the code that follows the loop must execute properly. This
3589 implies that the infinite loop must not cause the code that follow it to be
3600 #if defined (MDE_CPU_IPF)
3603 Flush a range of cache lines in the cache coherency domain of the calling
3606 Invalidates the cache lines specified by Address and Length. If Address is
3607 not aligned on a cache line boundary, then entire cache line containing
3608 Address is invalidated. If Address + Length is not aligned on a cache line
3609 boundary, then the entire instruction cache line containing Address + Length
3610 -1 is invalidated. This function may choose to invalidate the entire
3611 instruction cache if that is more efficient than invalidating the specified
3612 range. If Length is 0, the no instruction cache lines are invalidated.
3613 Address is returned.
3615 If Length is greater than (MAX_ADDRESS - Address + 1), then ASSERT().
3617 @param Address The base address of the instruction lines to invalidate. If
3618 the CPU is in a physical addressing mode, then Address is a
3619 physical address. If the CPU is in a virtual addressing mode,
3620 then Address is a virtual address.
3622 @param Length The number of bytes to invalidate from the instruction cache.
3629 IpfFlushCacheRange (
3636 Executes a FC instruction
3637 Executes a FC instruction on the cache line specified by Address.
3638 The cache line size affected is at least 32-bytes (aligned on a 32-byte boundary).
3639 An implementation may flush a larger region. This function is only available on IPF.
3641 @param Address The Address of cache line to be flushed.
3643 @return The address of FC instruction executed.
3654 Executes a FC.I instruction.
3655 Executes a FC.I instruction on the cache line specified by Address.
3656 The cache line size affected is at least 32-bytes (aligned on a 32-byte boundary).
3657 An implementation may flush a larger region. This function is only available on IPF.
3659 @param Address The Address of cache line to be flushed.
3661 @return The address of FC.I instruction executed.
3672 Reads the current value of a Processor Identifier Register (CPUID).
3673 The Index of largest implemented CPUID (One less than the number of implemented CPUID
3674 registers) is determined by CPUID [3] bits {7:0}.
3675 No parameter checking is performed on Index. If the Index value is beyond the
3676 implemented CPUID register range, a Reserved Register/Field fault may occur. The caller
3677 must either guarantee that Index is valid, or the caller must set up fault handlers to
3678 catch the faults. This function is only available on IPF.
3680 @param Index The 8-bit Processor Identifier Register index to read.
3682 @return The current value of Processor Identifier Register specified by Index.
3693 Reads the current value of 64-bit Processor Status Register (PSR).
3694 This function is only available on IPF.
3696 @return The current value of PSR.
3707 Writes the current value of 64-bit Processor Status Register (PSR).
3708 No parameter checking is performed on Value. All bits of Value corresponding to
3709 reserved fields of PSR must be 0 or a Reserved Register/Field fault may occur. The caller must either guarantee that Value is valid, or the caller must set up fault handlers to catch the faults.
3710 This function is only available on IPF.
3712 @param Value The 64-bit value to write to PSR.
3714 @return The 64-bit value written to the PSR.
3725 Reads the current value of 64-bit Kernel Register #0 (KR0).
3726 This function is only available on IPF.
3728 @return The current value of KR0.
3739 Reads the current value of 64-bit Kernel Register #1 (KR1).
3740 This function is only available on IPF.
3742 @return The current value of KR1.
3753 Reads the current value of 64-bit Kernel Register #2 (KR2).
3754 This function is only available on IPF.
3756 @return The current value of KR2.
3767 Reads the current value of 64-bit Kernel Register #3 (KR3).
3768 This function is only available on IPF.
3770 @return The current value of KR3.
3781 Reads the current value of 64-bit Kernel Register #4 (KR4).
3782 This function is only available on IPF.
3784 @return The current value of KR4.
3795 Reads the current value of 64-bit Kernel Register #5 (KR5).
3796 This function is only available on IPF.
3798 @return The current value of KR5.
3809 Reads the current value of 64-bit Kernel Register #6 (KR6).
3810 This function is only available on IPF.
3812 @return The current value of KR6.
3823 Reads the current value of 64-bit Kernel Register #7 (KR7).
3824 This function is only available on IPF.
3826 @return The current value of KR7.
3837 Write the current value of 64-bit Kernel Register #0 (KR0).
3838 This function is only available on IPF.
3840 @param Value The 64-bit value to write to KR0.
3842 @return The 64-bit value written to the KR0.
3853 Write the current value of 64-bit Kernel Register #1 (KR1).
3854 This function is only available on IPF.
3856 @param Value The 64-bit value to write to KR1.
3858 @return The 64-bit value written to the KR1.
3869 Write the current value of 64-bit Kernel Register #2 (KR2).
3870 This function is only available on IPF.
3872 @param Value The 64-bit value to write to KR2.
3874 @return The 64-bit value written to the KR2.
3885 Write the current value of 64-bit Kernel Register #3 (KR3).
3886 This function is only available on IPF.
3888 @param Value The 64-bit value to write to KR3.
3890 @return The 64-bit value written to the KR3.
3901 Write the current value of 64-bit Kernel Register #4 (KR4).
3902 This function is only available on IPF.
3904 @param Value The 64-bit value to write to KR4.
3906 @return The 64-bit value written to the KR4.
3917 Write the current value of 64-bit Kernel Register #5 (KR5).
3918 This function is only available on IPF.
3920 @param Value The 64-bit value to write to KR5.
3922 @return The 64-bit value written to the KR5.
3933 Write the current value of 64-bit Kernel Register #6 (KR6).
3934 This function is only available on IPF.
3936 @param Value The 64-bit value to write to KR6.
3938 @return The 64-bit value written to the KR6.
3949 Write the current value of 64-bit Kernel Register #7 (KR7).
3950 This function is only available on IPF.
3952 @param Value The 64-bit value to write to KR7.
3954 @return The 64-bit value written to the KR7.
3965 Reads the current value of Interval Timer Counter Register (ITC).
3966 This function is only available on IPF.
3968 @return The current value of ITC.
3979 Reads the current value of Interval Timer Vector Register (ITV).
3980 This function is only available on IPF.
3982 @return The current value of ITV.
3993 Reads the current value of Interval Timer Match Register (ITM).
3994 This function is only available on IPF.
3996 @return The current value of ITM.
4006 Writes the current value of 64-bit Interval Timer Counter Register (ITC).
4007 This function is only available on IPF.
4009 @param Value The 64-bit value to write to ITC.
4011 @return The 64-bit value written to the ITC.
4022 Writes the current value of 64-bit Interval Timer Match Register (ITM).
4023 This function is only available on IPF.
4025 @param Value The 64-bit value to write to ITM.
4027 @return The 64-bit value written to the ITM.
4038 Writes the current value of 64-bit Interval Timer Vector Register (ITV).
4039 No parameter checking is performed on Value. All bits of Value corresponding to
4040 reserved fields of ITV must be 0 or a Reserved Register/Field fault may occur.
4041 The caller must either guarantee that Value is valid, or the caller must set up
4042 fault handlers to catch the faults.
4043 This function is only available on IPF.
4045 @param Value The 64-bit value to write to ITV.
4047 @return The 64-bit value written to the ITV.
4058 Reads the current value of Default Control Register (DCR).
4059 This function is only available on IPF.
4061 @return The current value of DCR.
4072 Reads the current value of Interruption Vector Address Register (IVA).
4073 This function is only available on IPF.
4075 @return The current value of IVA.
4085 Reads the current value of Page Table Address Register (PTA).
4086 This function is only available on IPF.
4088 @return The current value of PTA.
4099 Writes the current value of 64-bit Default Control Register (DCR).
4100 No parameter checking is performed on Value. All bits of Value corresponding to
4101 reserved fields of DCR must be 0 or a Reserved Register/Field fault may occur.
4102 The caller must either guarantee that Value is valid, or the caller must set up
4103 fault handlers to catch the faults.
4104 This function is only available on IPF.
4106 @param Value The 64-bit value to write to DCR.
4108 @return The 64-bit value written to the DCR.
4119 Writes the current value of 64-bit Interruption Vector Address Register (IVA).
4120 The size of vector table is 32 K bytes and is 32 K bytes aligned
4121 the low 15 bits of Value is ignored when written.
4122 This function is only available on IPF.
4124 @param Value The 64-bit value to write to IVA.
4126 @return The 64-bit value written to the IVA.
4137 Writes the current value of 64-bit Page Table Address Register (PTA).
4138 No parameter checking is performed on Value. All bits of Value corresponding to
4139 reserved fields of DCR must be 0 or a Reserved Register/Field fault may occur.
4140 The caller must either guarantee that Value is valid, or the caller must set up
4141 fault handlers to catch the faults.
4142 This function is only available on IPF.
4144 @param Value The 64-bit value to write to PTA.
4146 @return The 64-bit value written to the PTA.
4156 Reads the current value of Local Interrupt ID Register (LID).
4157 This function is only available on IPF.
4159 @return The current value of LID.
4170 Reads the current value of External Interrupt Vector Register (IVR).
4171 This function is only available on IPF.
4173 @return The current value of IVR.
4184 Reads the current value of Task Priority Register (TPR).
4185 This function is only available on IPF.
4187 @return The current value of TPR.
4198 Reads the current value of External Interrupt Request Register #0 (IRR0).
4199 This function is only available on IPF.
4201 @return The current value of IRR0.
4212 Reads the current value of External Interrupt Request Register #1 (IRR1).
4213 This function is only available on IPF.
4215 @return The current value of IRR1.
4226 Reads the current value of External Interrupt Request Register #2 (IRR2).
4227 This function is only available on IPF.
4229 @return The current value of IRR2.
4240 Reads the current value of External Interrupt Request Register #3 (IRR3).
4241 This function is only available on IPF.
4243 @return The current value of IRR3.
4254 Reads the current value of Performance Monitor Vector Register (PMV).
4255 This function is only available on IPF.
4257 @return The current value of PMV.
4268 Reads the current value of Corrected Machine Check Vector Register (CMCV).
4269 This function is only available on IPF.
4271 @return The current value of CMCV.
4282 Reads the current value of Local Redirection Register #0 (LRR0).
4283 This function is only available on IPF.
4285 @return The current value of LRR0.
4296 Reads the current value of Local Redirection Register #1 (LRR1).
4297 This function is only available on IPF.
4299 @return The current value of LRR1.
4310 Writes the current value of 64-bit Page Local Interrupt ID Register (LID).
4311 No parameter checking is performed on Value. All bits of Value corresponding to
4312 reserved fields of LID must be 0 or a Reserved Register/Field fault may occur.
4313 The caller must either guarantee that Value is valid, or the caller must set up
4314 fault handlers to catch the faults.
4315 This function is only available on IPF.
4317 @param Value The 64-bit value to write to LID.
4319 @return The 64-bit value written to the LID.
4330 Writes the current value of 64-bit Task Priority Register (TPR).
4331 No parameter checking is performed on Value. All bits of Value corresponding to
4332 reserved fields of TPR must be 0 or a Reserved Register/Field fault may occur.
4333 The caller must either guarantee that Value is valid, or the caller must set up
4334 fault handlers to catch the faults.
4335 This function is only available on IPF.
4337 @param Value The 64-bit value to write to TPR.
4339 @return The 64-bit value written to the TPR.
4350 Performs a write operation on End OF External Interrupt Register (EOI).
4351 Writes a value of 0 to the EOI Register. This function is only available on IPF.
4362 Writes the current value of 64-bit Performance Monitor Vector Register (PMV).
4363 No parameter checking is performed on Value. All bits of Value corresponding
4364 to reserved fields of PMV must be 0 or a Reserved Register/Field fault may occur.
4365 The caller must either guarantee that Value is valid, or the caller must set up
4366 fault handlers to catch the faults.
4367 This function is only available on IPF.
4369 @param Value The 64-bit value to write to PMV.
4371 @return The 64-bit value written to the PMV.
4382 Writes the current value of 64-bit Corrected Machine Check Vector Register (CMCV).
4383 No parameter checking is performed on Value. All bits of Value corresponding
4384 to reserved fields of CMCV must be 0 or a Reserved Register/Field fault may occur.
4385 The caller must either guarantee that Value is valid, or the caller must set up
4386 fault handlers to catch the faults.
4387 This function is only available on IPF.
4389 @param Value The 64-bit value to write to CMCV.
4391 @return The 64-bit value written to the CMCV.
4402 Writes the current value of 64-bit Local Redirection Register #0 (LRR0).
4403 No parameter checking is performed on Value. All bits of Value corresponding
4404 to reserved fields of LRR0 must be 0 or a Reserved Register/Field fault may occur.
4405 The caller must either guarantee that Value is valid, or the caller must set up
4406 fault handlers to catch the faults.
4407 This function is only available on IPF.
4409 @param Value The 64-bit value to write to LRR0.
4411 @return The 64-bit value written to the LRR0.
4422 Writes the current value of 64-bit Local Redirection Register #1 (LRR1).
4423 No parameter checking is performed on Value. All bits of Value corresponding
4424 to reserved fields of LRR1 must be 0 or a Reserved Register/Field fault may occur.
4425 The caller must either guarantee that Value is valid, or the caller must
4426 set up fault handlers to catch the faults.
4427 This function is only available on IPF.
4429 @param Value The 64-bit value to write to LRR1.
4431 @return The 64-bit value written to the LRR1.
4442 Reads the current value of Instruction Breakpoint Register (IBR).
4444 The Instruction Breakpoint Registers are used in pairs. The even numbered
4445 registers contain breakpoint addresses, and the odd numbered registers contain
4446 breakpoint mask conditions. At least 4 instruction registers pairs are implemented
4447 on all processor models. Implemented registers are contiguous starting with
4448 register 0. No parameter checking is performed on Index, and if the Index value
4449 is beyond the implemented IBR register range, a Reserved Register/Field fault may
4450 occur. The caller must either guarantee that Index is valid, or the caller must
4451 set up fault handlers to catch the faults.
4452 This function is only available on IPF.
4454 @param Index The 8-bit Instruction Breakpoint Register index to read.
4456 @return The current value of Instruction Breakpoint Register specified by Index.
4467 Reads the current value of Data Breakpoint Register (DBR).
4469 The Data Breakpoint Registers are used in pairs. The even numbered registers
4470 contain breakpoint addresses, and odd numbered registers contain breakpoint
4471 mask conditions. At least 4 data registers pairs are implemented on all processor
4472 models. Implemented registers are contiguous starting with register 0.
4473 No parameter checking is performed on Index. If the Index value is beyond
4474 the implemented DBR register range, a Reserved Register/Field fault may occur.
4475 The caller must either guarantee that Index is valid, or the caller must set up
4476 fault handlers to catch the faults.
4477 This function is only available on IPF.
4479 @param Index The 8-bit Data Breakpoint Register index to read.
4481 @return The current value of Data Breakpoint Register specified by Index.
4492 Reads the current value of Performance Monitor Configuration Register (PMC).
4494 All processor implementations provide at least 4 performance counters
4495 (PMC/PMD [4]...PMC/PMD [7] pairs), and 4 performance monitor counter overflow
4496 status registers (PMC [0]¡ PMC [3]). Processor implementations may provide
4497 additional implementation-dependent PMC and PMD to increase the number of
4498 ¡®generic¡¯ performance counters (PMC/PMD pairs). The remainder of PMC and PMD
4499 register set is implementation dependent. No parameter checking is performed
4500 on Index. If the Index value is beyond the implemented PMC register range,
4501 zero value will be returned.
4502 This function is only available on IPF.
4504 @param Index The 8-bit Performance Monitor Configuration Register index to read.
4506 @return The current value of Performance Monitor Configuration Register
4518 Reads the current value of Performance Monitor Data Register (PMD).
4520 All processor implementations provide at least 4 performance counters
4521 (PMC/PMD [4]...PMC/PMD [7] pairs), and 4 performance monitor counter
4522 overflow status registers (PMC [0]¡ PMC [3]). Processor implementations may
4523 provide additional implementation-dependent PMC and PMD to increase the number
4524 of ¡®generic¡¯ performance counters (PMC/PMD pairs). The remainder of PMC and PMD
4525 register set is implementation dependent. No parameter checking is performed
4526 on Index. If the Index value is beyond the implemented PMD register range,
4527 zero value will be returned.
4528 This function is only available on IPF.
4530 @param Index The 8-bit Performance Monitor Data Register index to read.
4532 @return The current value of Performance Monitor Data Register specified by Index.
4543 Writes the current value of 64-bit Instruction Breakpoint Register (IBR).
4545 Writes current value of Instruction Breakpoint Register specified by Index.
4546 The Instruction Breakpoint Registers are used in pairs. The even numbered
4547 registers contain breakpoint addresses, and odd numbered registers contain
4548 breakpoint mask conditions. At least 4 instruction registers pairs are implemented
4549 on all processor models. Implemented registers are contiguous starting with
4550 register 0. No parameter checking is performed on Index. If the Index value
4551 is beyond the implemented IBR register range, a Reserved Register/Field fault may
4552 occur. The caller must either guarantee that Index is valid, or the caller must
4553 set up fault handlers to catch the faults.
4554 This function is only available on IPF.
4556 @param Index The 8-bit Instruction Breakpoint Register index to write.
4557 @param Value The 64-bit value to write to IBR.
4559 @return The 64-bit value written to the IBR.
4571 Writes the current value of 64-bit Data Breakpoint Register (DBR).
4573 Writes current value of Data Breakpoint Register specified by Index.
4574 The Data Breakpoint Registers are used in pairs. The even numbered registers
4575 contain breakpoint addresses, and odd numbered registers contain breakpoint
4576 mask conditions. At least 4 data registers pairs are implemented on all processor
4577 models. Implemented registers are contiguous starting with register 0. No parameter
4578 checking is performed on Index. If the Index value is beyond the implemented
4579 DBR register range, a Reserved Register/Field fault may occur. The caller must
4580 either guarantee that Index is valid, or the caller must set up fault handlers to
4582 This function is only available on IPF.
4584 @param Index The 8-bit Data Breakpoint Register index to write.
4585 @param Value The 64-bit value to write to DBR.
4587 @return The 64-bit value written to the DBR.
4599 Writes the current value of 64-bit Performance Monitor Configuration Register (PMC).
4601 Writes current value of Performance Monitor Configuration Register specified by Index.
4602 All processor implementations provide at least 4 performance counters
4603 (PMC/PMD [4]...PMC/PMD [7] pairs), and 4 performance monitor counter overflow status
4604 registers (PMC [0]¡ PMC [3]). Processor implementations may provide additional
4605 implementation-dependent PMC and PMD to increase the number of ¡®generic¡¯ performance
4606 counters (PMC/PMD pairs). The remainder of PMC and PMD register set is implementation
4607 dependent. No parameter checking is performed on Index. If the Index value is
4608 beyond the implemented PMC register range, the write is ignored.
4609 This function is only available on IPF.
4611 @param Index The 8-bit Performance Monitor Configuration Register index to write.
4612 @param Value The 64-bit value to write to PMC.
4614 @return The 64-bit value written to the PMC.
4626 Writes the current value of 64-bit Performance Monitor Data Register (PMD).
4628 Writes current value of Performance Monitor Data Register specified by Index.
4629 All processor implementations provide at least 4 performance counters
4630 (PMC/PMD [4]...PMC/PMD [7] pairs), and 4 performance monitor counter overflow
4631 status registers (PMC [0]¡ PMC [3]). Processor implementations may provide
4632 additional implementation-dependent PMC and PMD to increase the number of ¡®generic¡¯
4633 performance counters (PMC/PMD pairs). The remainder of PMC and PMD register set
4634 is implementation dependent. No parameter checking is performed on Index. If the
4635 Index value is beyond the implemented PMD register range, the write is ignored.
4636 This function is only available on IPF.
4638 @param Index The 8-bit Performance Monitor Data Register index to write.
4639 @param Value The 64-bit value to write to PMD.
4641 @return The 64-bit value written to the PMD.
4653 Reads the current value of 64-bit Global Pointer (GP).
4655 Reads and returns the current value of GP.
4656 This function is only available on IPF.
4658 @return The current value of GP.
4669 Write the current value of 64-bit Global Pointer (GP).
4671 Writes the current value of GP. The 64-bit value written to the GP is returned.
4672 No parameter checking is performed on Value.
4673 This function is only available on IPF.
4675 @param Value The 64-bit value to write to GP.
4677 @return The 64-bit value written to the GP.
4688 Reads the current value of 64-bit Stack Pointer (SP).
4690 Reads and returns the current value of SP.
4691 This function is only available on IPF.
4693 @return The current value of SP.
4704 Determines if the CPU is currently executing in virtual, physical, or mixed mode.
4706 Determines the current execution mode of the CPU.
4707 If the CPU is in virtual mode(PSR.RT=1, PSR.DT=1, PSR.IT=1), then 1 is returned.
4708 If the CPU is in physical mode(PSR.RT=0, PSR.DT=0, PSR.IT=0), then 0 is returned.
4709 If the CPU is not in physical mode or virtual mode, then it is in mixed mode,
4711 This function is only available on IPF.
4713 @return 1 The CPU is in virtual mode.
4714 @return 0 The CPU is in physical mode.
4715 @return -1 The CPU is in mixed mode.
4726 Makes a PAL procedure call.
4728 This is a wrapper function to make a PAL procedure call. Based on the Index
4729 value this API will make static or stacked PAL call. The following table
4730 describes the usage of PAL Procedure Index Assignment. Architected procedures
4731 may be designated as required or optional. If a PAL procedure is specified
4732 as optional, a unique return code of 0xFFFFFFFFFFFFFFFF is returned in the
4733 Status field of the PAL_CALL_RETURN structure.
4734 This indicates that the procedure is not present in this PAL implementation.
4735 It is the caller¡¯s responsibility to check for this return code after calling
4736 any optional PAL procedure.
4737 No parameter checking is performed on the 5 input parameters, but there are
4738 some common rules that the caller should follow when making a PAL call. Any
4739 address passed to PAL as buffers for return parameters must be 8-byte aligned.
4740 Unaligned addresses may cause undefined results. For those parameters defined
4741 as reserved or some fields defined as reserved must be zero filled or the invalid
4742 argument return value may be returned or undefined result may occur during the
4743 execution of the procedure. If the PalEntryPoint does not point to a valid
4744 PAL entry point then the system behavior is undefined. This function is only
4747 @param PalEntryPoint The PAL procedure calls entry point.
4748 @param Index The PAL procedure Index number.
4749 @param Arg2 The 2nd parameter for PAL procedure calls.
4750 @param Arg3 The 3rd parameter for PAL procedure calls.
4751 @param Arg4 The 4th parameter for PAL procedure calls.
4753 @return structure returned from the PAL Call procedure, including the status and return value.
4759 IN UINT64 PalEntryPoint
,
4768 Transfers control to a function starting with a new stack.
4770 Transfers control to the function specified by EntryPoint using the new stack
4771 specified by NewStack and passing in the parameters specified by Context1 and
4772 Context2. Context1 and Context2 are optional and may be NULL. The function
4773 EntryPoint must never return.
4775 If EntryPoint is NULL, then ASSERT().
4776 If NewStack is NULL, then ASSERT().
4778 @param EntryPoint A pointer to function to call with the new stack.
4779 @param Context1 A pointer to the context to pass into the EntryPoint
4781 @param Context2 A pointer to the context to pass into the EntryPoint
4783 @param NewStack A pointer to the new stack to use for the EntryPoint
4785 @param NewBsp A pointer to the new memory location for RSE backing
4791 AsmSwitchStackAndBackingStore (
4792 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
4793 IN VOID
*Context1
, OPTIONAL
4794 IN VOID
*Context2
, OPTIONAL
4801 // Bugbug: This call should be removed after
4802 // the PalCall Instance issue has been fixed.
4805 Performs a PAL call using static calling convention.
4807 An internal function to perform a PAL call using static calling convention.
4809 @param PalEntryPoint The entry point address of PAL. The address in ar.kr5
4810 would be used if this parameter were NULL on input.
4811 @param Arg1 The first argument of a PAL call.
4812 @param Arg1 The second argument of a PAL call.
4813 @param Arg1 The third argument of a PAL call.
4814 @param Arg1 The fourth argument of a PAL call.
4816 @return The values returned in r8, r9, r10 and r11.
4821 IN CONST VOID
*PalEntryPoint
,
4829 #elif defined (MDE_CPU_IA32) || defined (MDE_CPU_X64)
4831 // IA32 and X64 Specific Functions
4834 // Byte packed structure for 16-bit Real Mode EFLAGS
4838 UINT32 CF
:1; // Carry Flag
4839 UINT32 Reserved_0
:1; // Reserved
4840 UINT32 PF
:1; // Parity Flag
4841 UINT32 Reserved_1
:1; // Reserved
4842 UINT32 AF
:1; // Auxiliary Carry Flag
4843 UINT32 Reserved_2
:1; // Reserved
4844 UINT32 ZF
:1; // Zero Flag
4845 UINT32 SF
:1; // Sign Flag
4846 UINT32 TF
:1; // Trap Flag
4847 UINT32 IF
:1; // Interrupt Enable Flag
4848 UINT32 DF
:1; // Direction Flag
4849 UINT32 OF
:1; // Overflow Flag
4850 UINT32 IOPL
:2; // I/O Privilege Level
4851 UINT32 NT
:1; // Nested Task
4852 UINT32 Reserved_3
:1; // Reserved
4858 // Byte packed structure for EFLAGS/RFLAGS
4860 // 64-bits on X64. The upper 32-bits on X64 are reserved
4864 UINT32 CF
:1; // Carry Flag
4865 UINT32 Reserved_0
:1; // Reserved
4866 UINT32 PF
:1; // Parity Flag
4867 UINT32 Reserved_1
:1; // Reserved
4868 UINT32 AF
:1; // Auxiliary Carry Flag
4869 UINT32 Reserved_2
:1; // Reserved
4870 UINT32 ZF
:1; // Zero Flag
4871 UINT32 SF
:1; // Sign Flag
4872 UINT32 TF
:1; // Trap Flag
4873 UINT32 IF
:1; // Interrupt Enable Flag
4874 UINT32 DF
:1; // Direction Flag
4875 UINT32 OF
:1; // Overflow Flag
4876 UINT32 IOPL
:2; // I/O Privilege Level
4877 UINT32 NT
:1; // Nested Task
4878 UINT32 Reserved_3
:1; // Reserved
4879 UINT32 RF
:1; // Resume Flag
4880 UINT32 VM
:1; // Virtual 8086 Mode
4881 UINT32 AC
:1; // Alignment Check
4882 UINT32 VIF
:1; // Virtual Interrupt Flag
4883 UINT32 VIP
:1; // Virtual Interrupt Pending
4884 UINT32 ID
:1; // ID Flag
4885 UINT32 Reserved_4
:10; // Reserved
4891 // Byte packed structure for Control Register 0 (CR0)
4893 // 64-bits on X64. The upper 32-bits on X64 are reserved
4897 UINT32 PE
:1; // Protection Enable
4898 UINT32 MP
:1; // Monitor Coprocessor
4899 UINT32 EM
:1; // Emulation
4900 UINT32 TS
:1; // Task Switched
4901 UINT32 ET
:1; // Extension Type
4902 UINT32 NE
:1; // Numeric Error
4903 UINT32 Reserved_0
:10; // Reserved
4904 UINT32 WP
:1; // Write Protect
4905 UINT32 Reserved_1
:1; // Reserved
4906 UINT32 AM
:1; // Alignment Mask
4907 UINT32 Reserved_2
:10; // Reserved
4908 UINT32 NW
:1; // Mot Write-through
4909 UINT32 CD
:1; // Cache Disable
4910 UINT32 PG
:1; // Paging
4916 // Byte packed structure for Control Register 4 (CR4)
4918 // 64-bits on X64. The upper 32-bits on X64 are reserved
4922 UINT32 VME
:1; // Virtual-8086 Mode Extensions
4923 UINT32 PVI
:1; // Protected-Mode Virtual Interrupts
4924 UINT32 TSD
:1; // Time Stamp Disable
4925 UINT32 DE
:1; // Debugging Extensions
4926 UINT32 PSE
:1; // Page Size Extensions
4927 UINT32 PAE
:1; // Physical Address Extension
4928 UINT32 MCE
:1; // Machine Check Enable
4929 UINT32 PGE
:1; // Page Global Enable
4930 UINT32 PCE
:1; // Performance Monitoring Counter
4932 UINT32 OSFXSR
:1; // Operating System Support for
4933 // FXSAVE and FXRSTOR instructions
4934 UINT32 OSXMMEXCPT
:1; // Operating System Support for
4935 // Unmasked SIMD Floating Point
4937 UINT32 Reserved_0
:2; // Reserved
4938 UINT32 VMXE
:1; // VMX Enable
4939 UINT32 Reserved_1
:18; // Reseved
4945 // Byte packed structure for an IDTR, GDTR, LDTR descriptor
4946 /// @bug How to make this structure byte-packed in a compiler independent way?
4955 #define IA32_IDT_GATE_TYPE_TASK 0x85
4956 #define IA32_IDT_GATE_TYPE_INTERRUPT_16 0x86
4957 #define IA32_IDT_GATE_TYPE_TRAP_16 0x87
4958 #define IA32_IDT_GATE_TYPE_INTERRUPT_32 0x8E
4959 #define IA32_IDT_GATE_TYPE_TRAP_32 0x8F
4962 // Byte packed structure for an Interrupt Gate Descriptor
4966 UINT32 OffsetLow
:16; // Offset bits 15..0
4967 UINT32 Selector
:16; // Selector
4968 UINT32 Reserved_0
:8; // Reserved
4969 UINT32 GateType
:8; // Gate Type. See #defines above
4970 UINT32 OffsetHigh
:16; // Offset bits 31..16
4973 } IA32_IDT_GATE_DESCRIPTOR
;
4976 // Byte packed structure for an FP/SSE/SSE2 context
4983 // Structures for the 16-bit real mode thunks
5036 IA32_EFLAGS32 EFLAGS
;
5046 } IA32_REGISTER_SET
;
5049 // Byte packed structure for an 16-bit real mode thunks
5052 IA32_REGISTER_SET
*RealModeState
;
5053 VOID
*RealModeBuffer
;
5054 UINT32 RealModeBufferSize
;
5055 UINT32 ThunkAttributes
;
5058 #define THUNK_ATTRIBUTE_BIG_REAL_MODE 0x00000001
5059 #define THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 0x00000002
5060 #define THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL 0x00000004
5063 Retrieves CPUID information.
5065 Executes the CPUID instruction with EAX set to the value specified by Index.
5066 This function always returns Index.
5067 If Eax is not NULL, then the value of EAX after CPUID is returned in Eax.
5068 If Ebx is not NULL, then the value of EBX after CPUID is returned in Ebx.
5069 If Ecx is not NULL, then the value of ECX after CPUID is returned in Ecx.
5070 If Edx is not NULL, then the value of EDX after CPUID is returned in Edx.
5071 This function is only available on IA-32 and X64.
5073 @param Index The 32-bit value to load into EAX prior to invoking the CPUID
5075 @param Eax Pointer to the 32-bit EAX value returned by the CPUID
5076 instruction. This is an optional parameter that may be NULL.
5077 @param Ebx Pointer to the 32-bit EBX value returned by the CPUID
5078 instruction. This is an optional parameter that may be NULL.
5079 @param Ecx Pointer to the 32-bit ECX value returned by the CPUID
5080 instruction. This is an optional parameter that may be NULL.
5081 @param Edx Pointer to the 32-bit EDX value returned by the CPUID
5082 instruction. This is an optional parameter that may be NULL.
5091 OUT UINT32
*Eax
, OPTIONAL
5092 OUT UINT32
*Ebx
, OPTIONAL
5093 OUT UINT32
*Ecx
, OPTIONAL
5094 OUT UINT32
*Edx OPTIONAL
5099 Retrieves CPUID information using an extended leaf identifier.
5101 Executes the CPUID instruction with EAX set to the value specified by Index
5102 and ECX set to the value specified by SubIndex. This function always returns
5103 Index. This function is only available on IA-32 and x64.
5105 If Eax is not NULL, then the value of EAX after CPUID is returned in Eax.
5106 If Ebx is not NULL, then the value of EBX after CPUID is returned in Ebx.
5107 If Ecx is not NULL, then the value of ECX after CPUID is returned in Ecx.
5108 If Edx is not NULL, then the value of EDX after CPUID is returned in Edx.
5110 @param Index The 32-bit value to load into EAX prior to invoking the
5112 @param SubIndex The 32-bit value to load into ECX prior to invoking the
5114 @param Eax Pointer to the 32-bit EAX value returned by the CPUID
5115 instruction. This is an optional parameter that may be
5117 @param Ebx Pointer to the 32-bit EBX value returned by the CPUID
5118 instruction. This is an optional parameter that may be
5120 @param Ecx Pointer to the 32-bit ECX value returned by the CPUID
5121 instruction. This is an optional parameter that may be
5123 @param Edx Pointer to the 32-bit EDX value returned by the CPUID
5124 instruction. This is an optional parameter that may be
5135 OUT UINT32
*Eax
, OPTIONAL
5136 OUT UINT32
*Ebx
, OPTIONAL
5137 OUT UINT32
*Ecx
, OPTIONAL
5138 OUT UINT32
*Edx OPTIONAL
5143 Returns the lower 32-bits of a Machine Specific Register(MSR).
5145 Reads and returns the lower 32-bits of the MSR specified by Index.
5146 No parameter checking is performed on Index, and some Index values may cause
5147 CPU exceptions. The caller must either guarantee that Index is valid, or the
5148 caller must set up exception handlers to catch the exceptions. This function
5149 is only available on IA-32 and X64.
5151 @param Index The 32-bit MSR index to read.
5153 @return The lower 32 bits of the MSR identified by Index.
5164 Zero-extend a 32-bit value and writes it to a Machine Specific Register(MSR).
5166 Writes the 32-bit value specified by Value to the MSR specified by Index. The
5167 upper 32-bits of the MSR write are set to zero. The 32-bit value written to
5168 the MSR is returned. No parameter checking is performed on Index or Value,
5169 and some of these may cause CPU exceptions. The caller must either guarantee
5170 that Index and Value are valid, or the caller must establish proper exception
5171 handlers. This function is only available on IA-32 and X64.
5173 @param Index The 32-bit MSR index to write.
5174 @param Value The 32-bit value to write to the MSR.
5188 Reads a 64-bit MSR, performs a bitwise inclusive OR on the lower 32-bits, and
5189 writes the result back to the 64-bit MSR.
5191 Reads the 64-bit MSR specified by Index, performs a bitwise inclusive OR
5192 between the lower 32-bits of the read result and the value specified by
5193 OrData, and writes the result to the 64-bit MSR specified by Index. The lower
5194 32-bits of the value written to the MSR is returned. No parameter checking is
5195 performed on Index or OrData, and some of these may cause CPU exceptions. The
5196 caller must either guarantee that Index and OrData are valid, or the caller
5197 must establish proper exception handlers. This function is only available on
5200 @param Index The 32-bit MSR index to write.
5201 @param OrData The value to OR with the read value from the MSR.
5203 @return The lower 32-bit value written to the MSR.
5215 Reads a 64-bit MSR, performs a bitwise AND on the lower 32-bits, and writes
5216 the result back to the 64-bit MSR.
5218 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
5219 lower 32-bits of the read result and the value specified by AndData, and
5220 writes the result to the 64-bit MSR specified by Index. The lower 32-bits of
5221 the value written to the MSR is returned. No parameter checking is performed
5222 on Index or AndData, and some of these may cause CPU exceptions. The caller
5223 must either guarantee that Index and AndData are valid, or the caller must
5224 establish proper exception handlers. This function is only available on IA-32
5227 @param Index The 32-bit MSR index to write.
5228 @param AndData The value to AND with the read value from the MSR.
5230 @return The lower 32-bit value written to the MSR.
5242 Reads a 64-bit MSR, performs a bitwise AND followed by a bitwise inclusive OR
5243 on the lower 32-bits, and writes the result back to the 64-bit MSR.
5245 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
5246 lower 32-bits of the read result and the value specified by AndData
5247 preserving the upper 32-bits, performs a bitwise inclusive OR between the
5248 result of the AND operation and the value specified by OrData, and writes the
5249 result to the 64-bit MSR specified by Address. The lower 32-bits of the value
5250 written to the MSR is returned. No parameter checking is performed on Index,
5251 AndData, or OrData, and some of these may cause CPU exceptions. The caller
5252 must either guarantee that Index, AndData, and OrData are valid, or the
5253 caller must establish proper exception handlers. This function is only
5254 available on IA-32 and X64.
5256 @param Index The 32-bit MSR index to write.
5257 @param AndData The value to AND with the read value from the MSR.
5258 @param OrData The value to OR with the result of the AND operation.
5260 @return The lower 32-bit value written to the MSR.
5273 Reads a bit field of an MSR.
5275 Reads the bit field in the lower 32-bits of a 64-bit MSR. The bit field is
5276 specified by the StartBit and the EndBit. The value of the bit field is
5277 returned. The caller must either guarantee that Index is valid, or the caller
5278 must set up exception handlers to catch the exceptions. This function is only
5279 available on IA-32 and X64.
5281 If StartBit is greater than 31, then ASSERT().
5282 If EndBit is greater than 31, then ASSERT().
5283 If EndBit is less than StartBit, then ASSERT().
5285 @param Index The 32-bit MSR index to read.
5286 @param StartBit The ordinal of the least significant bit in the bit field.
5288 @param EndBit The ordinal of the most significant bit in the bit field.
5291 @return The bit field read from the MSR.
5296 AsmMsrBitFieldRead32 (
5304 Writes a bit field to an MSR.
5306 Writes Value to a bit field in the lower 32-bits of a 64-bit MSR. The bit
5307 field is specified by the StartBit and the EndBit. All other bits in the
5308 destination MSR are preserved. The lower 32-bits of the MSR written is
5309 returned. Extra left bits in Value are stripped. The caller must either
5310 guarantee that Index and the data written is valid, or the caller must set up
5311 exception handlers to catch the exceptions. This function is only available
5314 If StartBit is greater than 31, then ASSERT().
5315 If EndBit is greater than 31, then ASSERT().
5316 If EndBit is less than StartBit, then ASSERT().
5318 @param Index The 32-bit MSR index to write.
5319 @param StartBit The ordinal of the least significant bit in the bit field.
5321 @param EndBit The ordinal of the most significant bit in the bit field.
5323 @param Value New value of the bit field.
5325 @return The lower 32-bit of the value written to the MSR.
5330 AsmMsrBitFieldWrite32 (
5339 Reads a bit field in a 64-bit MSR, performs a bitwise OR, and writes the
5340 result back to the bit field in the 64-bit MSR.
5342 Reads the 64-bit MSR specified by Index, performs a bitwise inclusive OR
5343 between the read result and the value specified by OrData, and writes the
5344 result to the 64-bit MSR specified by Index. The lower 32-bits of the value
5345 written to the MSR are returned. Extra left bits in OrData are stripped. The
5346 caller must either guarantee that Index and the data written is valid, or
5347 the caller must set up exception handlers to catch the exceptions. This
5348 function is only available on IA-32 and X64.
5350 If StartBit is greater than 31, then ASSERT().
5351 If EndBit is greater than 31, then ASSERT().
5352 If EndBit is less than StartBit, then ASSERT().
5354 @param Index The 32-bit MSR index to write.
5355 @param StartBit The ordinal of the least significant bit in the bit field.
5357 @param EndBit The ordinal of the most significant bit in the bit field.
5359 @param OrData The value to OR with the read value from the MSR.
5361 @return The lower 32-bit of the value written to the MSR.
5366 AsmMsrBitFieldOr32 (
5375 Reads a bit field in a 64-bit MSR, performs a bitwise AND, and writes the
5376 result back to the bit field in the 64-bit MSR.
5378 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
5379 read result and the value specified by AndData, and writes the result to the
5380 64-bit MSR specified by Index. The lower 32-bits of the value written to the
5381 MSR are returned. Extra left bits in AndData are stripped. The caller must
5382 either guarantee that Index and the data written is valid, or the caller must
5383 set up exception handlers to catch the exceptions. This function is only
5384 available on IA-32 and X64.
5386 If StartBit is greater than 31, then ASSERT().
5387 If EndBit is greater than 31, then ASSERT().
5388 If EndBit is less than StartBit, then ASSERT().
5390 @param Index The 32-bit MSR index to write.
5391 @param StartBit The ordinal of the least significant bit in the bit field.
5393 @param EndBit The ordinal of the most significant bit in the bit field.
5395 @param AndData The value to AND with the read value from the MSR.
5397 @return The lower 32-bit of the value written to the MSR.
5402 AsmMsrBitFieldAnd32 (
5411 Reads a bit field in a 64-bit MSR, performs a bitwise AND followed by a
5412 bitwise inclusive OR, and writes the result back to the bit field in the
5415 Reads the 64-bit MSR specified by Index, performs a bitwise AND followed by a
5416 bitwise inclusive OR between the read result and the value specified by
5417 AndData, and writes the result to the 64-bit MSR specified by Index. The
5418 lower 32-bits of the value written to the MSR are returned. Extra left bits
5419 in both AndData and OrData are stripped. The caller must either guarantee
5420 that Index and the data written is valid, or the caller must set up exception
5421 handlers to catch the exceptions. This function is only available on IA-32
5424 If StartBit is greater than 31, then ASSERT().
5425 If EndBit is greater than 31, then ASSERT().
5426 If EndBit is less than StartBit, then ASSERT().
5428 @param Index The 32-bit MSR index to write.
5429 @param StartBit The ordinal of the least significant bit in the bit field.
5431 @param EndBit The ordinal of the most significant bit in the bit field.
5433 @param AndData The value to AND with the read value from the MSR.
5434 @param OrData The value to OR with the result of the AND operation.
5436 @return The lower 32-bit of the value written to the MSR.
5441 AsmMsrBitFieldAndThenOr32 (
5451 Returns a 64-bit Machine Specific Register(MSR).
5453 Reads and returns the 64-bit MSR specified by Index. No parameter checking is
5454 performed on Index, and some Index values may cause CPU exceptions. The
5455 caller must either guarantee that Index is valid, or the caller must set up
5456 exception handlers to catch the exceptions. This function is only available
5459 @param Index The 32-bit MSR index to read.
5461 @return The value of the MSR identified by Index.
5472 Writes a 64-bit value to a Machine Specific Register(MSR), and returns the
5475 Writes the 64-bit value specified by Value to the MSR specified by Index. The
5476 64-bit value written to the MSR is returned. No parameter checking is
5477 performed on Index or Value, and some of these may cause CPU exceptions. The
5478 caller must either guarantee that Index and Value are valid, or the caller
5479 must establish proper exception handlers. This function is only available on
5482 @param Index The 32-bit MSR index to write.
5483 @param Value The 64-bit value to write to the MSR.
5497 Reads a 64-bit MSR, performs a bitwise inclusive OR, and writes the result
5498 back to the 64-bit MSR.
5500 Reads the 64-bit MSR specified by Index, performs a bitwise inclusive OR
5501 between the read result and the value specified by OrData, and writes the
5502 result to the 64-bit MSR specified by Index. The value written to the MSR is
5503 returned. No parameter checking is performed on Index or OrData, and some of
5504 these may cause CPU exceptions. The caller must either guarantee that Index
5505 and OrData are valid, or the caller must establish proper exception handlers.
5506 This function is only available on IA-32 and X64.
5508 @param Index The 32-bit MSR index to write.
5509 @param OrData The value to OR with the read value from the MSR.
5511 @return The value written back to the MSR.
5523 Reads a 64-bit MSR, performs a bitwise AND, and writes the result back to the
5526 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
5527 read result and the value specified by OrData, and writes the result to the
5528 64-bit MSR specified by Index. The value written to the MSR is returned. No
5529 parameter checking is performed on Index or OrData, and some of these may
5530 cause CPU exceptions. The caller must either guarantee that Index and OrData
5531 are valid, or the caller must establish proper exception handlers. This
5532 function is only available on IA-32 and X64.
5534 @param Index The 32-bit MSR index to write.
5535 @param AndData The value to AND with the read value from the MSR.
5537 @return The value written back to the MSR.
5549 Reads a 64-bit MSR, performs a bitwise AND followed by a bitwise inclusive
5550 OR, and writes the result back to the 64-bit MSR.
5552 Reads the 64-bit MSR specified by Index, performs a bitwise AND between read
5553 result and the value specified by AndData, performs a bitwise inclusive OR
5554 between the result of the AND operation and the value specified by OrData,
5555 and writes the result to the 64-bit MSR specified by Index. The value written
5556 to the MSR is returned. No parameter checking is performed on Index, AndData,
5557 or OrData, and some of these may cause CPU exceptions. The caller must either
5558 guarantee that Index, AndData, and OrData are valid, or the caller must
5559 establish proper exception handlers. This function is only available on IA-32
5562 @param Index The 32-bit MSR index to write.
5563 @param AndData The value to AND with the read value from the MSR.
5564 @param OrData The value to OR with the result of the AND operation.
5566 @return The value written back to the MSR.
5579 Reads a bit field of an MSR.
5581 Reads the bit field in the 64-bit MSR. The bit field is specified by the
5582 StartBit and the EndBit. The value of the bit field is returned. The caller
5583 must either guarantee that Index is valid, or the caller must set up
5584 exception handlers to catch the exceptions. This function is only available
5587 If StartBit is greater than 63, then ASSERT().
5588 If EndBit is greater than 63, then ASSERT().
5589 If EndBit is less than StartBit, then ASSERT().
5591 @param Index The 32-bit MSR index to read.
5592 @param StartBit The ordinal of the least significant bit in the bit field.
5594 @param EndBit The ordinal of the most significant bit in the bit field.
5597 @return The value read from the MSR.
5602 AsmMsrBitFieldRead64 (
5610 Writes a bit field to an MSR.
5612 Writes Value to a bit field in a 64-bit MSR. The bit field is specified by
5613 the StartBit and the EndBit. All other bits in the destination MSR are
5614 preserved. The MSR written is returned. Extra left bits in Value are
5615 stripped. The caller must either guarantee that Index and the data written is
5616 valid, or the caller must set up exception handlers to catch the exceptions.
5617 This function is only available on IA-32 and X64.
5619 If StartBit is greater than 63, then ASSERT().
5620 If EndBit is greater than 63, then ASSERT().
5621 If EndBit is less than StartBit, then ASSERT().
5623 @param Index The 32-bit MSR index to write.
5624 @param StartBit The ordinal of the least significant bit in the bit field.
5626 @param EndBit The ordinal of the most significant bit in the bit field.
5628 @param Value New value of the bit field.
5630 @return The value written back to the MSR.
5635 AsmMsrBitFieldWrite64 (
5644 Reads a bit field in a 64-bit MSR, performs a bitwise inclusive OR, and
5645 writes the result back to the bit field in the 64-bit MSR.
5647 Reads the 64-bit MSR specified by Index, performs a bitwise inclusive OR
5648 between the read result and the value specified by OrData, and writes the
5649 result to the 64-bit MSR specified by Index. The value written to the MSR is
5650 returned. Extra left bits in OrData are stripped. The caller must either
5651 guarantee that Index and the data written is valid, or the caller must set up
5652 exception handlers to catch the exceptions. This function is only available
5655 If StartBit is greater than 63, then ASSERT().
5656 If EndBit is greater than 63, then ASSERT().
5657 If EndBit is less than StartBit, then ASSERT().
5659 @param Index The 32-bit MSR index to write.
5660 @param StartBit The ordinal of the least significant bit in the bit field.
5662 @param EndBit The ordinal of the most significant bit in the bit field.
5664 @param OrData The value to OR with the read value from the bit field.
5666 @return The value written back to the MSR.
5671 AsmMsrBitFieldOr64 (
5680 Reads a bit field in a 64-bit MSR, performs a bitwise AND, and writes the
5681 result back to the bit field in the 64-bit MSR.
5683 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
5684 read result and the value specified by AndData, and writes the result to the
5685 64-bit MSR specified by Index. The value written to the MSR is returned.
5686 Extra left bits in AndData are stripped. The caller must either guarantee
5687 that Index and the data written is valid, or the caller must set up exception
5688 handlers to catch the exceptions. This function is only available on IA-32
5691 If StartBit is greater than 63, then ASSERT().
5692 If EndBit is greater than 63, then ASSERT().
5693 If EndBit is less than StartBit, then ASSERT().
5695 @param Index The 32-bit MSR index to write.
5696 @param StartBit The ordinal of the least significant bit in the bit field.
5698 @param EndBit The ordinal of the most significant bit in the bit field.
5700 @param AndData The value to AND with the read value from the bit field.
5702 @return The value written back to the MSR.
5707 AsmMsrBitFieldAnd64 (
5716 Reads a bit field in a 64-bit MSR, performs a bitwise AND followed by a
5717 bitwise inclusive OR, and writes the result back to the bit field in the
5720 Reads the 64-bit MSR specified by Index, performs a bitwise AND followed by
5721 a bitwise inclusive OR between the read result and the value specified by
5722 AndData, and writes the result to the 64-bit MSR specified by Index. The
5723 value written to the MSR is returned. Extra left bits in both AndData and
5724 OrData are stripped. The caller must either guarantee that Index and the data
5725 written is valid, or the caller must set up exception handlers to catch the
5726 exceptions. This function is only available on IA-32 and X64.
5728 If StartBit is greater than 63, then ASSERT().
5729 If EndBit is greater than 63, then ASSERT().
5730 If EndBit is less than StartBit, then ASSERT().
5732 @param Index The 32-bit MSR index to write.
5733 @param StartBit The ordinal of the least significant bit in the bit field.
5735 @param EndBit The ordinal of the most significant bit in the bit field.
5737 @param AndData The value to AND with the read value from the bit field.
5738 @param OrData The value to OR with the result of the AND operation.
5740 @return The value written back to the MSR.
5745 AsmMsrBitFieldAndThenOr64 (
5755 Reads the current value of the EFLAGS register.
5757 Reads and returns the current value of the EFLAGS register. This function is
5758 only available on IA-32 and X64. This returns a 32-bit value on IA-32 and a
5759 64-bit value on X64.
5761 @return EFLAGS on IA-32 or RFLAGS on X64.
5772 Reads the current value of the Control Register 0 (CR0).
5774 Reads and returns the current value of CR0. This function is only available
5775 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
5778 @return The value of the Control Register 0 (CR0).
5789 Reads the current value of the Control Register 2 (CR2).
5791 Reads and returns the current value of CR2. This function is only available
5792 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
5795 @return The value of the Control Register 2 (CR2).
5806 Reads the current value of the Control Register 3 (CR3).
5808 Reads and returns the current value of CR3. This function is only available
5809 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
5812 @return The value of the Control Register 3 (CR3).
5823 Reads the current value of the Control Register 4 (CR4).
5825 Reads and returns the current value of CR4. This function is only available
5826 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
5829 @return The value of the Control Register 4 (CR4).
5840 Writes a value to Control Register 0 (CR0).
5842 Writes and returns a new value to CR0. This function is only available on
5843 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
5845 @param Cr0 The value to write to CR0.
5847 @return The value written to CR0.
5858 Writes a value to Control Register 2 (CR2).
5860 Writes and returns a new value to CR2. This function is only available on
5861 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
5863 @param Cr2 The value to write to CR2.
5865 @return The value written to CR2.
5876 Writes a value to Control Register 3 (CR3).
5878 Writes and returns a new value to CR3. This function is only available on
5879 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
5881 @param Cr3 The value to write to CR3.
5883 @return The value written to CR3.
5894 Writes a value to Control Register 4 (CR4).
5896 Writes and returns a new value to CR4. This function is only available on
5897 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
5899 @param Cr4 The value to write to CR4.
5901 @return The value written to CR4.
5912 Reads the current value of Debug Register 0 (DR0).
5914 Reads and returns the current value of DR0. This function is only available
5915 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
5918 @return The value of Debug Register 0 (DR0).
5929 Reads the current value of Debug Register 1 (DR1).
5931 Reads and returns the current value of DR1. This function is only available
5932 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
5935 @return The value of Debug Register 1 (DR1).
5946 Reads the current value of Debug Register 2 (DR2).
5948 Reads and returns the current value of DR2. This function is only available
5949 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
5952 @return The value of Debug Register 2 (DR2).
5963 Reads the current value of Debug Register 3 (DR3).
5965 Reads and returns the current value of DR3. This function is only available
5966 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
5969 @return The value of Debug Register 3 (DR3).
5980 Reads the current value of Debug Register 4 (DR4).
5982 Reads and returns the current value of DR4. This function is only available
5983 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
5986 @return The value of Debug Register 4 (DR4).
5997 Reads the current value of Debug Register 5 (DR5).
5999 Reads and returns the current value of DR5. This function is only available
6000 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
6003 @return The value of Debug Register 5 (DR5).
6014 Reads the current value of Debug Register 6 (DR6).
6016 Reads and returns the current value of DR6. This function is only available
6017 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
6020 @return The value of Debug Register 6 (DR6).
6031 Reads the current value of Debug Register 7 (DR7).
6033 Reads and returns the current value of DR7. This function is only available
6034 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
6037 @return The value of Debug Register 7 (DR7).
6048 Writes a value to Debug Register 0 (DR0).
6050 Writes and returns a new value to DR0. This function is only available on
6051 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6053 @param Dr0 The value to write to Dr0.
6055 @return The value written to Debug Register 0 (DR0).
6066 Writes a value to Debug Register 1 (DR1).
6068 Writes and returns a new value to DR1. This function is only available on
6069 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6071 @param Dr1 The value to write to Dr1.
6073 @return The value written to Debug Register 1 (DR1).
6084 Writes a value to Debug Register 2 (DR2).
6086 Writes and returns a new value to DR2. This function is only available on
6087 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6089 @param Dr2 The value to write to Dr2.
6091 @return The value written to Debug Register 2 (DR2).
6102 Writes a value to Debug Register 3 (DR3).
6104 Writes and returns a new value to DR3. This function is only available on
6105 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6107 @param Dr3 The value to write to Dr3.
6109 @return The value written to Debug Register 3 (DR3).
6120 Writes a value to Debug Register 4 (DR4).
6122 Writes and returns a new value to DR4. This function is only available on
6123 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6125 @param Dr4 The value to write to Dr4.
6127 @return The value written to Debug Register 4 (DR4).
6138 Writes a value to Debug Register 5 (DR5).
6140 Writes and returns a new value to DR5. This function is only available on
6141 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6143 @param Dr5 The value to write to Dr5.
6145 @return The value written to Debug Register 5 (DR5).
6156 Writes a value to Debug Register 6 (DR6).
6158 Writes and returns a new value to DR6. This function is only available on
6159 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6161 @param Dr6 The value to write to Dr6.
6163 @return The value written to Debug Register 6 (DR6).
6174 Writes a value to Debug Register 7 (DR7).
6176 Writes and returns a new value to DR7. This function is only available on
6177 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6179 @param Dr7 The value to write to Dr7.
6181 @return The value written to Debug Register 7 (DR7).
6192 Reads the current value of Code Segment Register (CS).
6194 Reads and returns the current value of CS. This function is only available on
6197 @return The current value of CS.
6208 Reads the current value of Data Segment Register (DS).
6210 Reads and returns the current value of DS. This function is only available on
6213 @return The current value of DS.
6224 Reads the current value of Extra Segment Register (ES).
6226 Reads and returns the current value of ES. This function is only available on
6229 @return The current value of ES.
6240 Reads the current value of FS Data Segment Register (FS).
6242 Reads and returns the current value of FS. This function is only available on
6245 @return The current value of FS.
6256 Reads the current value of GS Data Segment Register (GS).
6258 Reads and returns the current value of GS. This function is only available on
6261 @return The current value of GS.
6272 Reads the current value of Stack Segment Register (SS).
6274 Reads and returns the current value of SS. This function is only available on
6277 @return The current value of SS.
6288 Reads the current value of Task Register (TR).
6290 Reads and returns the current value of TR. This function is only available on
6293 @return The current value of TR.
6304 Reads the current Global Descriptor Table Register(GDTR) descriptor.
6306 Reads and returns the current GDTR descriptor and returns it in Gdtr. This
6307 function is only available on IA-32 and X64.
6309 If Gdtr is NULL, then ASSERT().
6311 @param Gdtr Pointer to a GDTR descriptor.
6317 OUT IA32_DESCRIPTOR
*Gdtr
6322 Writes the current Global Descriptor Table Register (GDTR) descriptor.
6324 Writes and the current GDTR descriptor specified by Gdtr. This function is
6325 only available on IA-32 and X64.
6327 If Gdtr is NULL, then ASSERT().
6329 @param Gdtr Pointer to a GDTR descriptor.
6335 IN CONST IA32_DESCRIPTOR
*Gdtr
6340 Reads the current Interrupt Descriptor Table Register(GDTR) descriptor.
6342 Reads and returns the current IDTR descriptor and returns it in Idtr. This
6343 function is only available on IA-32 and X64.
6345 If Idtr is NULL, then ASSERT().
6347 @param Idtr Pointer to a IDTR descriptor.
6353 OUT IA32_DESCRIPTOR
*Idtr
6358 Writes the current Interrupt Descriptor Table Register(GDTR) descriptor.
6360 Writes the current IDTR descriptor and returns it in Idtr. This function is
6361 only available on IA-32 and X64.
6363 If Idtr is NULL, then ASSERT().
6365 @param Idtr Pointer to a IDTR descriptor.
6371 IN CONST IA32_DESCRIPTOR
*Idtr
6376 Reads the current Local Descriptor Table Register(LDTR) selector.
6378 Reads and returns the current 16-bit LDTR descriptor value. This function is
6379 only available on IA-32 and X64.
6381 @return The current selector of LDT.
6392 Writes the current Local Descriptor Table Register (GDTR) selector.
6394 Writes and the current LDTR descriptor specified by Ldtr. This function is
6395 only available on IA-32 and X64.
6397 @param Ldtr 16-bit LDTR selector value.
6408 Save the current floating point/SSE/SSE2 context to a buffer.
6410 Saves the current floating point/SSE/SSE2 state to the buffer specified by
6411 Buffer. Buffer must be aligned on a 16-byte boundary. This function is only
6412 available on IA-32 and X64.
6414 If Buffer is NULL, then ASSERT().
6415 If Buffer is not aligned on a 16-byte boundary, then ASSERT().
6417 @param Buffer Pointer to a buffer to save the floating point/SSE/SSE2 context.
6423 OUT IA32_FX_BUFFER
*Buffer
6428 Restores the current floating point/SSE/SSE2 context from a buffer.
6430 Restores the current floating point/SSE/SSE2 state from the buffer specified
6431 by Buffer. Buffer must be aligned on a 16-byte boundary. This function is
6432 only available on IA-32 and X64.
6434 If Buffer is NULL, then ASSERT().
6435 If Buffer is not aligned on a 16-byte boundary, then ASSERT().
6436 If Buffer was not saved with AsmFxSave(), then ASSERT().
6438 @param Buffer Pointer to a buffer to save the floating point/SSE/SSE2 context.
6444 IN CONST IA32_FX_BUFFER
*Buffer
6449 Reads the current value of 64-bit MMX Register #0 (MM0).
6451 Reads and returns the current value of MM0. This function is only available
6454 @return The current value of MM0.
6465 Reads the current value of 64-bit MMX Register #1 (MM1).
6467 Reads and returns the current value of MM1. This function is only available
6470 @return The current value of MM1.
6481 Reads the current value of 64-bit MMX Register #2 (MM2).
6483 Reads and returns the current value of MM2. This function is only available
6486 @return The current value of MM2.
6497 Reads the current value of 64-bit MMX Register #3 (MM3).
6499 Reads and returns the current value of MM3. This function is only available
6502 @return The current value of MM3.
6513 Reads the current value of 64-bit MMX Register #4 (MM4).
6515 Reads and returns the current value of MM4. This function is only available
6518 @return The current value of MM4.
6529 Reads the current value of 64-bit MMX Register #5 (MM5).
6531 Reads and returns the current value of MM5. This function is only available
6534 @return The current value of MM5.
6545 Reads the current value of 64-bit MMX Register #6 (MM6).
6547 Reads and returns the current value of MM6. This function is only available
6550 @return The current value of MM6.
6561 Reads the current value of 64-bit MMX Register #7 (MM7).
6563 Reads and returns the current value of MM7. This function is only available
6566 @return The current value of MM7.
6577 Writes the current value of 64-bit MMX Register #0 (MM0).
6579 Writes the current value of MM0. This function is only available on IA32 and
6582 @param Value The 64-bit value to write to MM0.
6593 Writes the current value of 64-bit MMX Register #1 (MM1).
6595 Writes the current value of MM1. This function is only available on IA32 and
6598 @param Value The 64-bit value to write to MM1.
6609 Writes the current value of 64-bit MMX Register #2 (MM2).
6611 Writes the current value of MM2. This function is only available on IA32 and
6614 @param Value The 64-bit value to write to MM2.
6625 Writes the current value of 64-bit MMX Register #3 (MM3).
6627 Writes the current value of MM3. This function is only available on IA32 and
6630 @param Value The 64-bit value to write to MM3.
6641 Writes the current value of 64-bit MMX Register #4 (MM4).
6643 Writes the current value of MM4. This function is only available on IA32 and
6646 @param Value The 64-bit value to write to MM4.
6657 Writes the current value of 64-bit MMX Register #5 (MM5).
6659 Writes the current value of MM5. This function is only available on IA32 and
6662 @param Value The 64-bit value to write to MM5.
6673 Writes the current value of 64-bit MMX Register #6 (MM6).
6675 Writes the current value of MM6. This function is only available on IA32 and
6678 @param Value The 64-bit value to write to MM6.
6689 Writes the current value of 64-bit MMX Register #7 (MM7).
6691 Writes the current value of MM7. This function is only available on IA32 and
6694 @param Value The 64-bit value to write to MM7.
6705 Reads the current value of Time Stamp Counter (TSC).
6707 Reads and returns the current value of TSC. This function is only available
6710 @return The current value of TSC
6721 Reads the current value of a Performance Counter (PMC).
6723 Reads and returns the current value of performance counter specified by
6724 Index. This function is only available on IA-32 and X64.
6726 @param Index The 32-bit Performance Counter index to read.
6728 @return The value of the PMC specified by Index.
6739 Sets up a monitor buffer that is used by AsmMwait().
6741 Executes a MONITOR instruction with the register state specified by Eax, Ecx
6742 and Edx. Returns Eax. This function is only available on IA-32 and X64.
6744 @param Eax The value to load into EAX or RAX before executing the MONITOR
6746 @param Ecx The value to load into ECX or RCX before executing the MONITOR
6748 @param Edx The value to load into EDX or RDX before executing the MONITOR
6764 Executes an MWAIT instruction.
6766 Executes an MWAIT instruction with the register state specified by Eax and
6767 Ecx. Returns Eax. This function is only available on IA-32 and X64.
6769 @param Eax The value to load into EAX or RAX before executing the MONITOR
6771 @param Ecx The value to load into ECX or RCX before executing the MONITOR
6786 Executes a WBINVD instruction.
6788 Executes a WBINVD instruction. This function is only available on IA-32 and
6800 Executes a INVD instruction.
6802 Executes a INVD instruction. This function is only available on IA-32 and
6814 Flushes a cache line from all the instruction and data caches within the
6815 coherency domain of the CPU.
6817 Flushed the cache line specified by LinearAddress, and returns LinearAddress.
6818 This function is only available on IA-32 and X64.
6820 @param LinearAddress The address of the cache line to flush. If the CPU is
6821 in a physical addressing mode, then LinearAddress is a
6822 physical address. If the CPU is in a virtual
6823 addressing mode, then LinearAddress is a virtual
6826 @return LinearAddress
6831 IN VOID
*LinearAddress
6836 Enables the 32-bit paging mode on the CPU.
6838 Enables the 32-bit paging mode on the CPU. CR0, CR3, CR4, and the page tables
6839 must be properly initialized prior to calling this service. This function
6840 assumes the current execution mode is 32-bit protected mode. This function is
6841 only available on IA-32. After the 32-bit paging mode is enabled, control is
6842 transferred to the function specified by EntryPoint using the new stack
6843 specified by NewStack and passing in the parameters specified by Context1 and
6844 Context2. Context1 and Context2 are optional and may be NULL. The function
6845 EntryPoint must never return.
6847 If the current execution mode is not 32-bit protected mode, then ASSERT().
6848 If EntryPoint is NULL, then ASSERT().
6849 If NewStack is NULL, then ASSERT().
6851 There are a number of constraints that must be followed before calling this
6853 1) Interrupts must be disabled.
6854 2) The caller must be in 32-bit protected mode with flat descriptors. This
6855 means all descriptors must have a base of 0 and a limit of 4GB.
6856 3) CR0 and CR4 must be compatible with 32-bit protected mode with flat
6858 4) CR3 must point to valid page tables that will be used once the transition
6859 is complete, and those page tables must guarantee that the pages for this
6860 function and the stack are identity mapped.
6862 @param EntryPoint A pointer to function to call with the new stack after
6864 @param Context1 A pointer to the context to pass into the EntryPoint
6865 function as the first parameter after paging is enabled.
6866 @param Context2 A pointer to the context to pass into the EntryPoint
6867 function as the second parameter after paging is enabled.
6868 @param NewStack A pointer to the new stack to use for the EntryPoint
6869 function after paging is enabled.
6875 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
6876 IN VOID
*Context1
, OPTIONAL
6877 IN VOID
*Context2
, OPTIONAL
6883 Disables the 32-bit paging mode on the CPU.
6885 Disables the 32-bit paging mode on the CPU and returns to 32-bit protected
6886 mode. This function assumes the current execution mode is 32-paged protected
6887 mode. This function is only available on IA-32. After the 32-bit paging mode
6888 is disabled, control is transferred to the function specified by EntryPoint
6889 using the new stack specified by NewStack and passing in the parameters
6890 specified by Context1 and Context2. Context1 and Context2 are optional and
6891 may be NULL. The function EntryPoint must never return.
6893 If the current execution mode is not 32-bit paged mode, then ASSERT().
6894 If EntryPoint is NULL, then ASSERT().
6895 If NewStack is NULL, then ASSERT().
6897 There are a number of constraints that must be followed before calling this
6899 1) Interrupts must be disabled.
6900 2) The caller must be in 32-bit paged mode.
6901 3) CR0, CR3, and CR4 must be compatible with 32-bit paged mode.
6902 4) CR3 must point to valid page tables that guarantee that the pages for
6903 this function and the stack are identity mapped.
6905 @param EntryPoint A pointer to function to call with the new stack after
6907 @param Context1 A pointer to the context to pass into the EntryPoint
6908 function as the first parameter after paging is disabled.
6909 @param Context2 A pointer to the context to pass into the EntryPoint
6910 function as the second parameter after paging is
6912 @param NewStack A pointer to the new stack to use for the EntryPoint
6913 function after paging is disabled.
6918 AsmDisablePaging32 (
6919 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
6920 IN VOID
*Context1
, OPTIONAL
6921 IN VOID
*Context2
, OPTIONAL
6927 Enables the 64-bit paging mode on the CPU.
6929 Enables the 64-bit paging mode on the CPU. CR0, CR3, CR4, and the page tables
6930 must be properly initialized prior to calling this service. This function
6931 assumes the current execution mode is 32-bit protected mode with flat
6932 descriptors. This function is only available on IA-32. After the 64-bit
6933 paging mode is enabled, control is transferred to the function specified by
6934 EntryPoint using the new stack specified by NewStack and passing in the
6935 parameters specified by Context1 and Context2. Context1 and Context2 are
6936 optional and may be 0. The function EntryPoint must never return.
6938 If the current execution mode is not 32-bit protected mode with flat
6939 descriptors, then ASSERT().
6940 If EntryPoint is 0, then ASSERT().
6941 If NewStack is 0, then ASSERT().
6943 @param Cs The 16-bit selector to load in the CS before EntryPoint
6944 is called. The descriptor in the GDT that this selector
6945 references must be setup for long mode.
6946 @param EntryPoint The 64-bit virtual address of the function to call with
6947 the new stack after paging is enabled.
6948 @param Context1 The 64-bit virtual address of the context to pass into
6949 the EntryPoint function as the first parameter after
6951 @param Context2 The 64-bit virtual address of the context to pass into
6952 the EntryPoint function as the second parameter after
6954 @param NewStack The 64-bit virtual address of the new stack to use for
6955 the EntryPoint function after paging is enabled.
6961 IN UINT16 CodeSelector
,
6962 IN UINT64 EntryPoint
,
6963 IN UINT64 Context1
, OPTIONAL
6964 IN UINT64 Context2
, OPTIONAL
6970 Disables the 64-bit paging mode on the CPU.
6972 Disables the 64-bit paging mode on the CPU and returns to 32-bit protected
6973 mode. This function assumes the current execution mode is 64-paging mode.
6974 This function is only available on X64. After the 64-bit paging mode is
6975 disabled, control is transferred to the function specified by EntryPoint
6976 using the new stack specified by NewStack and passing in the parameters
6977 specified by Context1 and Context2. Context1 and Context2 are optional and
6978 may be 0. The function EntryPoint must never return.
6980 If the current execution mode is not 64-bit paged mode, then ASSERT().
6981 If EntryPoint is 0, then ASSERT().
6982 If NewStack is 0, then ASSERT().
6984 @param Cs The 16-bit selector to load in the CS before EntryPoint
6985 is called. The descriptor in the GDT that this selector
6986 references must be setup for 32-bit protected mode.
6987 @param EntryPoint The 64-bit virtual address of the function to call with
6988 the new stack after paging is disabled.
6989 @param Context1 The 64-bit virtual address of the context to pass into
6990 the EntryPoint function as the first parameter after
6992 @param Context2 The 64-bit virtual address of the context to pass into
6993 the EntryPoint function as the second parameter after
6995 @param NewStack The 64-bit virtual address of the new stack to use for
6996 the EntryPoint function after paging is disabled.
7001 AsmDisablePaging64 (
7002 IN UINT16 CodeSelector
,
7003 IN UINT32 EntryPoint
,
7004 IN UINT32 Context1
, OPTIONAL
7005 IN UINT32 Context2
, OPTIONAL
7011 // 16-bit thunking services
7015 Retrieves the properties for 16-bit thunk functions.
7017 Computes the size of the buffer and stack below 1MB required to use the
7018 AsmPrepareThunk16(), AsmThunk16() and AsmPrepareAndThunk16() functions. This
7019 buffer size is returned in RealModeBufferSize, and the stack size is returned
7020 in ExtraStackSize. If parameters are passed to the 16-bit real mode code,
7021 then the actual minimum stack size is ExtraStackSize plus the maximum number
7022 of bytes that need to be passed to the 16-bit real mode code.
7024 If RealModeBufferSize is NULL, then ASSERT().
7025 If ExtraStackSize is NULL, then ASSERT().
7027 @param RealModeBufferSize A pointer to the size of the buffer below 1MB
7028 required to use the 16-bit thunk functions.
7029 @param ExtraStackSize A pointer to the extra size of stack below 1MB
7030 that the 16-bit thunk functions require for
7031 temporary storage in the transition to and from
7037 AsmGetThunk16Properties (
7038 OUT UINT32
*RealModeBufferSize
,
7039 OUT UINT32
*ExtraStackSize
7044 Prepares all structures a code required to use AsmThunk16().
7046 Prepares all structures and code required to use AsmThunk16().
7048 If ThunkContext is NULL, then ASSERT().
7050 @param ThunkContext A pointer to the context structure that describes the
7051 16-bit real mode code to call.
7057 OUT THUNK_CONTEXT
*ThunkContext
7062 Transfers control to a 16-bit real mode entry point and returns the results.
7064 Transfers control to a 16-bit real mode entry point and returns the results.
7065 AsmPrepareThunk16() must be called with ThunkContext before this function is
7068 If ThunkContext is NULL, then ASSERT().
7069 If AsmPrepareThunk16() was not previously called with ThunkContext, then ASSERT().
7071 @param ThunkContext A pointer to the context structure that describes the
7072 16-bit real mode code to call.
7078 IN OUT THUNK_CONTEXT
*ThunkContext
7083 Prepares all structures and code for a 16-bit real mode thunk, transfers
7084 control to a 16-bit real mode entry point, and returns the results.
7086 Prepares all structures and code for a 16-bit real mode thunk, transfers
7087 control to a 16-bit real mode entry point, and returns the results. If the
7088 caller only need to perform a single 16-bit real mode thunk, then this
7089 service should be used. If the caller intends to make more than one 16-bit
7090 real mode thunk, then it is more efficient if AsmPrepareThunk16() is called
7091 once and AsmThunk16() can be called for each 16-bit real mode thunk.
7093 If ThunkContext is NULL, then ASSERT().
7095 @param ThunkContext A pointer to the context structure that describes the
7096 16-bit real mode code to call.
7101 AsmPrepareAndThunk16 (
7102 IN OUT THUNK_CONTEXT
*ThunkContext