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.
13 Module Name: BaseLib.h
21 // Definitions for architecture specific types
22 // These include SPIN_LOCK and BASE_LIBRARY_JUMP_BUFFER
28 typedef volatile UINTN SPIN_LOCK
;
30 #if defined (MDE_CPU_IA32)
32 // IA32 context buffer used by SetJump() and LongJump()
41 } BASE_LIBRARY_JUMP_BUFFER
;
43 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 8
45 #elif defined (MDE_CPU_IPF)
47 // IPF context buffer used by SetJump() and LongJump()
82 UINT64 AfterSpillUNAT
;
88 } BASE_LIBRARY_JUMP_BUFFER
;
90 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 0x10
92 #elif defined (MDE_CPU_X64)
94 // X64 context buffer used by SetJump() and LongJump()
107 } BASE_LIBRARY_JUMP_BUFFER
;
109 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 8
111 #elif defined (MDE_CPU_EBC)
113 // EBC context buffer used by SetJump() and LongJump()
121 } BASE_LIBRARY_JUMP_BUFFER
;
123 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 8
126 #error Unknown Processor Type
134 Copies one Null-terminated Unicode string to another Null-terminated Unicode
135 string and returns the new Unicode string.
137 This function copies the contents of the Unicode string Source to the Unicode
138 string Destination, and returns Destination. If Source and Destination
139 overlap, then the results are undefined.
141 If Destination is NULL, then ASSERT().
142 If Destination is not aligned on a 16-bit boundary, then ASSERT().
143 If Source is NULL, then ASSERT().
144 If Source is not aligned on a 16-bit boundary, then ASSERT().
145 If Source and Destination overlap, then ASSERT().
146 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
147 PcdMaximumUnicodeStringLength Unicode characters not including the
148 Null-terminator, then ASSERT().
150 @param Destination Pointer to a Null-terminated Unicode string.
151 @param Source Pointer to a Null-terminated Unicode string.
159 OUT CHAR16
*Destination
,
160 IN CONST CHAR16
*Source
165 Copies one Null-terminated Unicode string with a maximum length to another
166 Null-terminated Unicode string with a maximum length and returns the new
169 This function copies the contents of the Unicode string Source to the Unicode
170 string Destination, and returns Destination. At most, Length Unicode
171 characters are copied from Source to Destination. If Length is 0, then
172 Destination is returned unmodified. If Length is greater that the number of
173 Unicode characters in Source, then Destination is padded with Null Unicode
174 characters. If Source and Destination overlap, then the results are
177 If Length > 0 and Destination is NULL, then ASSERT().
178 If Length > 0 and Destination is not aligned on a 16-bit boundary, then ASSERT().
179 If Length > 0 and Source is NULL, then ASSERT().
180 If Length > 0 and Source is not aligned on a 16-bit bounadry, then ASSERT().
181 If Source and Destination overlap, then ASSERT().
182 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
183 PcdMaximumUnicodeStringLength Unicode characters not including the
184 Null-terminator, then ASSERT().
186 @param Destination Pointer to a Null-terminated Unicode string.
187 @param Source Pointer to a Null-terminated Unicode string.
188 @param Length Maximum number of Unicode characters to copy.
196 OUT CHAR16
*Destination
,
197 IN CONST CHAR16
*Source
,
203 Returns the length of a Null-terminated Unicode string.
205 This function returns the number of Unicode characters in the Null-terminated
206 Unicode string specified by String.
208 If String is NULL, then ASSERT().
209 If String is not aligned on a 16-bit boundary, then ASSERT().
210 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
211 PcdMaximumUnicodeStringLength Unicode characters not including the
212 Null-terminator, then ASSERT().
214 @param String Pointer to a Null-terminated Unicode string.
216 @return The length of String.
222 IN CONST CHAR16
*String
227 Returns the size of a Null-terminated Unicode string in bytes, including the
230 This function returns the size, in bytes, of the Null-terminated Unicode
231 string specified by String.
233 If String is NULL, then ASSERT().
234 If String is not aligned on a 16-bit boundary, then ASSERT().
235 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
236 PcdMaximumUnicodeStringLength Unicode characters not including the
237 Null-terminator, then ASSERT().
239 @param String Pointer to a Null-terminated Unicode string.
241 @return The size of String.
247 IN CONST CHAR16
*String
252 Compares two Null-terminated Unicode strings, and returns the difference
253 between the first mismatched Unicode characters.
255 This function compares the Null-terminated Unicode string FirstString to the
256 Null-terminated Unicode string SecondString. If FirstString is identical to
257 SecondString, then 0 is returned. Otherwise, the value returned is the first
258 mismatched Unicode character in SecondString subtracted from the first
259 mismatched Unicode character in FirstString.
261 If FirstString is NULL, then ASSERT().
262 If FirstString is not aligned on a 16-bit boundary, then ASSERT().
263 If SecondString is NULL, then ASSERT().
264 If SecondString is not aligned on a 16-bit boundary, then ASSERT().
265 If PcdMaximumUnicodeStringLength is not zero, and FirstString contains more
266 than PcdMaximumUnicodeStringLength Unicode characters not including the
267 Null-terminator, then ASSERT().
268 If PcdMaximumUnicodeStringLength is not zero, and SecondString contains more
269 than PcdMaximumUnicodeStringLength Unicode characters not including the
270 Null-terminator, then ASSERT().
272 @param FirstString Pointer to a Null-terminated Unicode string.
273 @param SecondString Pointer to a Null-terminated Unicode string.
275 @retval 0 FirstString is identical to SecondString.
276 @retval !=0 FirstString is not identical to SecondString.
282 IN CONST CHAR16
*FirstString
,
283 IN CONST CHAR16
*SecondString
288 Compares two Null-terminated Unicode strings with maximum lengths, and
289 returns the difference between the first mismatched Unicode characters.
291 This function compares the Null-terminated Unicode string FirstString to the
292 Null-terminated Unicode string SecondString. At most, Length Unicode
293 characters will be compared. If Length is 0, then 0 is returned. If
294 FirstString is identical to SecondString, then 0 is returned. Otherwise, the
295 value returned is the first mismatched Unicode character in SecondString
296 subtracted from the first mismatched Unicode character in FirstString.
298 If Length > 0 and FirstString is NULL, then ASSERT().
299 If Length > 0 and FirstString is not aligned on a 16-bit bounadary, then ASSERT().
300 If Length > 0 and SecondString is NULL, then ASSERT().
301 If Length > 0 and SecondString is not aligned on a 16-bit bounadary, then ASSERT().
302 If PcdMaximumUnicodeStringLength is not zero, and FirstString contains more
303 than PcdMaximumUnicodeStringLength Unicode characters not including the
304 Null-terminator, then ASSERT().
305 If PcdMaximumUnicodeStringLength is not zero, and SecondString contains more
306 than PcdMaximumUnicodeStringLength Unicode characters not including the
307 Null-terminator, then ASSERT().
309 @param FirstString Pointer to a Null-terminated Unicode string.
310 @param SecondString Pointer to a Null-terminated Unicode string.
311 @param Length Maximum number of Unicode characters to compare.
313 @retval 0 FirstString is identical to SecondString.
314 @retval !=0 FirstString is not identical to SecondString.
320 IN CONST CHAR16
*FirstString
,
321 IN CONST CHAR16
*SecondString
,
327 Concatenates one Null-terminated Unicode string to another Null-terminated
328 Unicode string, and returns the concatenated Unicode string.
330 This function concatenates two Null-terminated Unicode strings. The contents
331 of Null-terminated Unicode string Source are concatenated to the end of
332 Null-terminated Unicode string Destination. The Null-terminated concatenated
333 Unicode String is returned. If Source and Destination overlap, then the
334 results are undefined.
336 If Destination is NULL, then ASSERT().
337 If Destination is not aligned on a 16-bit bounadary, then ASSERT().
338 If Source is NULL, then ASSERT().
339 If Source is not aligned on a 16-bit bounadary, then ASSERT().
340 If Source and Destination overlap, then ASSERT().
341 If PcdMaximumUnicodeStringLength is not zero, and Destination contains more
342 than PcdMaximumUnicodeStringLength Unicode characters not including the
343 Null-terminator, then ASSERT().
344 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
345 PcdMaximumUnicodeStringLength Unicode characters not including the
346 Null-terminator, then ASSERT().
347 If PcdMaximumUnicodeStringLength is not zero, and concatenating Destination
348 and Source results in a Unicode string with more than
349 PcdMaximumUnicodeStringLength Unicode characters not including the
350 Null-terminator, then ASSERT().
352 @param Destination Pointer to a Null-terminated Unicode string.
353 @param Source Pointer to a Null-terminated Unicode string.
361 IN OUT CHAR16
*Destination
,
362 IN CONST CHAR16
*Source
367 Concatenates one Null-terminated Unicode string with a maximum length to the
368 end of another Null-terminated Unicode string, and returns the concatenated
371 This function concatenates two Null-terminated Unicode strings. The contents
372 of Null-terminated Unicode string Source are concatenated to the end of
373 Null-terminated Unicode string Destination, and Destination is returned. At
374 most, Length Unicode characters are concatenated from Source to the end of
375 Destination, and Destination is always Null-terminated. If Length is 0, then
376 Destination is returned unmodified. If Source and Destination overlap, then
377 the results are undefined.
379 If Destination is NULL, then ASSERT().
380 If Length > 0 and Destination is not aligned on a 16-bit boundary, then ASSERT().
381 If Length > 0 and Source is NULL, then ASSERT().
382 If Length > 0 and Source is not aligned on a 16-bit boundary, then ASSERT().
383 If Source and Destination overlap, then ASSERT().
384 If PcdMaximumUnicodeStringLength is not zero, and Destination contains more
385 than PcdMaximumUnicodeStringLength Unicode characters not including the
386 Null-terminator, then ASSERT().
387 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
388 PcdMaximumUnicodeStringLength Unicode characters not including the
389 Null-terminator, then ASSERT().
390 If PcdMaximumUnicodeStringLength is not zero, and concatenating Destination
391 and Source results in a Unicode string with more than
392 PcdMaximumUnicodeStringLength Unicode characters not including the
393 Null-terminator, then ASSERT().
395 @param Destination Pointer to a Null-terminated Unicode string.
396 @param Source Pointer to a Null-terminated Unicode string.
397 @param Length Maximum number of Unicode characters to concatenate from
406 IN OUT CHAR16
*Destination
,
407 IN CONST CHAR16
*Source
,
412 Returns the first occurance of a Null-terminated Unicode sub-string
413 in a Null-terminated Unicode string.
415 This function scans the contents of the Null-terminated Unicode string
416 specified by String and returns the first occurrence of SearchString.
417 If SearchString is not found in String, then NULL is returned. If
418 the length of SearchString is zero, then String is
421 If String is NULL, then ASSERT().
422 If String is not aligned on a 16-bit boundary, then ASSERT().
423 If SearchString is NULL, then ASSERT().
424 If SearchString is not aligned on a 16-bit boundary, then ASSERT().
426 If PcdMaximumUnicodeStringLength is not zero, and SearchString
427 or String contains more than PcdMaximumUnicodeStringLength Unicode
428 characters not including the Null-terminator, then ASSERT().
430 @param String Pointer to a Null-terminated Unicode string.
431 @param SearchString Pointer to a Null-terminated Unicode string to search for.
433 @retval NULL If the SearchString does not appear in String.
434 @retval !NULL If there is a match.
440 IN CONST CHAR16
*String
,
441 IN CONST CHAR16
*SearchString
445 Convert a Null-terminated Unicode decimal string to a value of
448 This function returns a value of type UINTN by interpreting the contents
449 of the Unicode string specified by String as a decimal number. The format
450 of the input Unicode string String is:
452 [spaces] [decimal digits].
454 The valid decimal digit character is in the range [0-9]. The
455 function will ignore the pad space, which includes spaces or
456 tab characters, before [decimal digits]. The running zero in the
457 beginning of [decimal digits] will be ignored. Then, the function
458 stops at the first character that is a not a valid decimal character
459 or a Null-terminator, whichever one comes first.
461 If String is NULL, then ASSERT().
462 If String is not aligned in a 16-bit boundary, then ASSERT().
463 If String has only pad spaces, then 0 is returned.
464 If String has no pad spaces or valid decimal digits,
466 If the number represented by String overflows according
467 to the range defined by UINTN, then ASSERT().
469 If PcdMaximumUnicodeStringLength is not zero, and String contains
470 more than PcdMaximumUnicodeStringLength Unicode characters not including
471 the Null-terminator, then ASSERT().
473 @param String Pointer to a Null-terminated Unicode string.
481 IN CONST CHAR16
*String
485 Convert a Null-terminated Unicode decimal string to a value of
488 This function returns a value of type UINT64 by interpreting the contents
489 of the Unicode string specified by String as a decimal number. The format
490 of the input Unicode string String is:
492 [spaces] [decimal digits].
494 The valid decimal digit character is in the range [0-9]. The
495 function will ignore the pad space, which includes spaces or
496 tab characters, before [decimal digits]. The running zero in the
497 beginning of [decimal digits] will be ignored. Then, the function
498 stops at the first character that is a not a valid decimal character
499 or a Null-terminator, whichever one comes first.
501 If String is NULL, then ASSERT().
502 If String is not aligned in a 16-bit boundary, then ASSERT().
503 If String has only pad spaces, then 0 is returned.
504 If String has no pad spaces or valid decimal digits,
506 If the number represented by String overflows according
507 to the range defined by UINT64, then ASSERT().
509 If PcdMaximumUnicodeStringLength is not zero, and String contains
510 more than PcdMaximumUnicodeStringLength Unicode characters not including
511 the Null-terminator, then ASSERT().
513 @param String Pointer to a Null-terminated Unicode string.
521 IN CONST CHAR16
*String
526 Convert a Null-terminated Unicode hexadecimal string to a value of type UINTN.
528 This function returns a value of type UINTN by interpreting the contents
529 of the Unicode string specified by String as a hexadecimal number.
530 The format of the input Unicode string String is:
532 [spaces][zeros][x][hexadecimal digits].
534 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
535 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix.
536 If "x" appears in the input string, it must be prefixed with at least one 0.
537 The function will ignore the pad space, which includes spaces or tab characters,
538 before [zeros], [x] or [hexadecimal digit]. The running zero before [x] or
539 [hexadecimal digit] will be ignored. Then, the decoding starts after [x] or the
540 first valid hexadecimal digit. Then, the function stops at the first character that is
541 a not a valid hexadecimal character or NULL, whichever one comes first.
543 If String is NULL, then ASSERT().
544 If String is not aligned in a 16-bit boundary, then ASSERT().
545 If String has only pad spaces, then zero is returned.
546 If String has no leading pad spaces, leading zeros or valid hexadecimal digits,
547 then zero is returned.
548 If the number represented by String overflows according to the range defined by
549 UINTN, then ASSERT().
551 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
552 PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator,
555 @param String Pointer to a Null-terminated Unicode string.
563 IN CONST CHAR16
*String
568 Convert a Null-terminated Unicode hexadecimal string to a value of type UINT64.
570 This function returns a value of type UINT64 by interpreting the contents
571 of the Unicode string specified by String as a hexadecimal number.
572 The format of the input Unicode string String is
574 [spaces][zeros][x][hexadecimal digits].
576 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
577 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix.
578 If "x" appears in the input string, it must be prefixed with at least one 0.
579 The function will ignore the pad space, which includes spaces or tab characters,
580 before [zeros], [x] or [hexadecimal digit]. The running zero before [x] or
581 [hexadecimal digit] will be ignored. Then, the decoding starts after [x] or the
582 first valid hexadecimal digit. Then, the function stops at the first character that is
583 a not a valid hexadecimal character or NULL, whichever one comes first.
585 If String is NULL, then ASSERT().
586 If String is not aligned in a 16-bit boundary, then ASSERT().
587 If String has only pad spaces, then zero is returned.
588 If String has no leading pad spaces, leading zeros or valid hexadecimal digits,
589 then zero is returned.
590 If the number represented by String overflows according to the range defined by
591 UINT64, then ASSERT().
593 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
594 PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator,
597 @param String Pointer to a Null-terminated Unicode string.
605 IN CONST CHAR16
*String
610 Convert one Null-terminated Unicode string to a Null-terminated
611 ASCII string and returns the ASCII string.
613 This function converts the content of the Unicode string Source
614 to the ASCII string Destination by copying the lower 8 bits of
615 each Unicode character. It returns Destination.
617 If any Unicode characters in Source contain non-zero value in
618 the upper 8 bits, then ASSERT().
620 If Destination is NULL, then ASSERT().
621 If Source is NULL, then ASSERT().
622 If Source is not aligned on a 16-bit boundary, then ASSERT().
623 If Source and Destination overlap, then ASSERT().
625 If PcdMaximumUnicodeStringLength is not zero, and Source contains
626 more than PcdMaximumUnicodeStringLength Unicode characters not including
627 the Null-terminator, then ASSERT().
629 If PcdMaximumAsciiStringLength is not zero, and Source contains more
630 than PcdMaximumAsciiStringLength Unicode characters not including the
631 Null-terminator, then ASSERT().
633 @param Source Pointer to a Null-terminated Unicode string.
634 @param Destination Pointer to a Null-terminated ASCII string.
641 UnicodeStrToAsciiStr (
642 IN CONST CHAR16
*Source
,
643 OUT CHAR8
*Destination
648 Copies one Null-terminated ASCII string to another Null-terminated ASCII
649 string and returns the new ASCII string.
651 This function copies the contents of the ASCII string Source to the ASCII
652 string Destination, and returns Destination. If Source and Destination
653 overlap, then the results are undefined.
655 If Destination is NULL, then ASSERT().
656 If Source is NULL, then ASSERT().
657 If Source and Destination overlap, then ASSERT().
658 If PcdMaximumAsciiStringLength is not zero and Source contains more than
659 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
662 @param Destination Pointer to a Null-terminated ASCII string.
663 @param Source Pointer to a Null-terminated ASCII string.
671 OUT CHAR8
*Destination
,
672 IN CONST CHAR8
*Source
677 Copies one Null-terminated ASCII string with a maximum length to another
678 Null-terminated ASCII string with a maximum length and returns the new ASCII
681 This function copies the contents of the ASCII string Source to the ASCII
682 string Destination, and returns Destination. At most, Length ASCII characters
683 are copied from Source to Destination. If Length is 0, then Destination is
684 returned unmodified. If Length is greater that the number of ASCII characters
685 in Source, then Destination is padded with Null ASCII characters. If Source
686 and Destination overlap, then the results are undefined.
688 If Destination is NULL, then ASSERT().
689 If Source is NULL, then ASSERT().
690 If Source and Destination overlap, then ASSERT().
691 If PcdMaximumAsciiStringLength is not zero, and Source contains more than
692 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
695 @param Destination Pointer to a Null-terminated ASCII string.
696 @param Source Pointer to a Null-terminated ASCII string.
697 @param Length Maximum number of ASCII characters to copy.
705 OUT CHAR8
*Destination
,
706 IN CONST CHAR8
*Source
,
712 Returns the length of a Null-terminated ASCII string.
714 This function returns the number of ASCII characters in the Null-terminated
715 ASCII string specified by String.
717 If Length > 0 and Destination is NULL, then ASSERT().
718 If Length > 0 and Source is NULL, then ASSERT().
719 If PcdMaximumAsciiStringLength is not zero and String contains more than
720 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
723 @param String Pointer to a Null-terminated ASCII string.
725 @return The length of String.
731 IN CONST CHAR8
*String
736 Returns the size of a Null-terminated ASCII string in bytes, including the
739 This function returns the size, in bytes, of the Null-terminated ASCII string
742 If String is NULL, then ASSERT().
743 If PcdMaximumAsciiStringLength is not zero and String contains more than
744 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
747 @param String Pointer to a Null-terminated ASCII string.
749 @return The size of String.
755 IN CONST CHAR8
*String
760 Compares two Null-terminated ASCII strings, and returns the difference
761 between the first mismatched ASCII characters.
763 This function compares the Null-terminated ASCII string FirstString to the
764 Null-terminated ASCII string SecondString. If FirstString is identical to
765 SecondString, then 0 is returned. Otherwise, the value returned is the first
766 mismatched ASCII character in SecondString subtracted from the first
767 mismatched ASCII character in FirstString.
769 If FirstString is NULL, then ASSERT().
770 If SecondString is NULL, then ASSERT().
771 If PcdMaximumAsciiStringLength is not zero and FirstString contains more than
772 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
774 If PcdMaximumAsciiStringLength is not zero and SecondString contains more
775 than PcdMaximumAsciiStringLength ASCII characters not including the
776 Null-terminator, then ASSERT().
778 @param FirstString Pointer to a Null-terminated ASCII string.
779 @param SecondString Pointer to a Null-terminated ASCII string.
781 @retval 0 FirstString is identical to SecondString.
782 @retval !=0 FirstString is not identical to SecondString.
788 IN CONST CHAR8
*FirstString
,
789 IN CONST CHAR8
*SecondString
794 Performs a case insensitive comparison of two Null-terminated ASCII strings,
795 and returns the difference between the first mismatched ASCII characters.
797 This function performs a case insensitive comparison of the Null-terminated
798 ASCII string FirstString to the Null-terminated ASCII string SecondString. If
799 FirstString is identical to SecondString, then 0 is returned. Otherwise, the
800 value returned is the first mismatched lower case ASCII character in
801 SecondString subtracted from the first mismatched lower case ASCII character
804 If FirstString is NULL, then ASSERT().
805 If SecondString is NULL, then ASSERT().
806 If PcdMaximumAsciiStringLength is not zero and FirstString contains more than
807 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
809 If PcdMaximumAsciiStringLength is not zero and SecondString contains more
810 than PcdMaximumAsciiStringLength ASCII characters not including the
811 Null-terminator, then ASSERT().
813 @param FirstString Pointer to a Null-terminated ASCII string.
814 @param SecondString Pointer to a Null-terminated ASCII string.
816 @retval 0 FirstString is identical to SecondString using case insensitive
818 @retval !=0 FirstString is not identical to SecondString using case
819 insensitive comparisons.
825 IN CONST CHAR8
*FirstString
,
826 IN CONST CHAR8
*SecondString
831 Compares two Null-terminated ASCII strings with maximum lengths, and returns
832 the difference between the first mismatched ASCII characters.
834 This function compares the Null-terminated ASCII string FirstString to the
835 Null-terminated ASCII string SecondString. At most, Length ASCII characters
836 will be compared. If Length is 0, then 0 is returned. If FirstString is
837 identical to SecondString, then 0 is returned. Otherwise, the value returned
838 is the first mismatched ASCII character in SecondString subtracted from the
839 first mismatched ASCII character in FirstString.
841 If Length > 0 and FirstString is NULL, then ASSERT().
842 If Length > 0 and SecondString is NULL, then ASSERT().
843 If PcdMaximumAsciiStringLength is not zero and FirstString contains more than
844 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
846 If PcdMaximumAsciiStringLength is not zero and SecondString contains more than
847 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
850 @param FirstString Pointer to a Null-terminated ASCII string.
851 @param SecondString Pointer to a Null-terminated ASCII string.
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 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 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 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 Buffer 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 Buffer 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 Buffer 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 Buffer 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 Buffer 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 Buffer 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 Places the CPU in a sleep state until an interrupt is received.
3524 Places the CPU in a sleep state until an interrupt is received. If interrupts
3525 are disabled prior to calling this function, then the CPU will be placed in a
3526 sleep state indefinitely.
3537 Requests CPU to pause for a short period of time.
3539 Requests CPU to pause for a short period of time. Typically used in MP
3540 systems to prevent memory starvation while waiting for a spin lock.
3551 Flushes all the Translation Lookaside Buffers(TLB) entries in a CPU.
3553 Flushes all the Translation Lookaside Buffers(TLB) entries in a CPU.
3564 Transfers control to a function starting with a new stack.
3566 Transfers control to the function specified by EntryPoint using the
3567 new stack specified by NewStack and passing in the parameters specified
3568 by Context1 and Context2. Context1 and Context2 are optional and may
3569 be NULL. The function EntryPoint must never return. This function
3570 supports a variable number of arguments following the NewStack parameter.
3571 These additional arguments are ignored on IA-32, x64, and EBC.
3572 IPF CPUs expect one additional parameter of type VOID * that specifies
3573 the new backing store pointer.
3575 If EntryPoint is NULL, then ASSERT().
3576 If NewStack is NULL, then ASSERT().
3578 @param EntryPoint A pointer to function to call with the new stack.
3579 @param Context1 A pointer to the context to pass into the EntryPoint
3581 @param Context2 A pointer to the context to pass into the EntryPoint
3583 @param NewStack A pointer to the new stack to use for the EntryPoint
3590 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
3591 IN VOID
*Context1
, OPTIONAL
3592 IN VOID
*Context2
, OPTIONAL
3599 Generates a breakpoint on the CPU.
3601 Generates a breakpoint on the CPU. The breakpoint must be implemented such
3602 that code can resume normal execution after the breakpoint.
3613 Executes an infinite loop.
3615 Forces the CPU to execute an infinite loop. A debugger may be used to skip
3616 past the loop and the code that follows the loop must execute properly. This
3617 implies that the infinite loop must not cause the code that follow it to be
3629 // IA32 and X64 Specific Functions
3632 // Byte packed structure for 16-bit Real Mode EFLAGS
3636 UINT32 CF
:1; // Carry Flag
3637 UINT32 Reserved_0
:1; // Reserved
3638 UINT32 PF
:1; // Parity Flag
3639 UINT32 Reserved_1
:1; // Reserved
3640 UINT32 AF
:1; // Auxiliary Carry Flag
3641 UINT32 Reserved_2
:1; // Reserved
3642 UINT32 ZF
:1; // Zero Flag
3643 UINT32 SF
:1; // Sign Flag
3644 UINT32 TF
:1; // Trap Flag
3645 UINT32 IF
:1; // Interrupt Enable Flag
3646 UINT32 DF
:1; // Direction Flag
3647 UINT32 OF
:1; // Overflow Flag
3648 UINT32 IOPL
:2; // I/O Privilege Level
3649 UINT32 NT
:1; // Nested Task
3650 UINT32 Reserved_3
:1; // Reserved
3656 // Byte packed structure for EFLAGS/RFLAGS
3658 // 64-bits on X64. The upper 32-bits on X64 are reserved
3662 UINT32 CF
:1; // Carry Flag
3663 UINT32 Reserved_0
:1; // Reserved
3664 UINT32 PF
:1; // Parity Flag
3665 UINT32 Reserved_1
:1; // Reserved
3666 UINT32 AF
:1; // Auxiliary Carry Flag
3667 UINT32 Reserved_2
:1; // Reserved
3668 UINT32 ZF
:1; // Zero Flag
3669 UINT32 SF
:1; // Sign Flag
3670 UINT32 TF
:1; // Trap Flag
3671 UINT32 IF
:1; // Interrupt Enable Flag
3672 UINT32 DF
:1; // Direction Flag
3673 UINT32 OF
:1; // Overflow Flag
3674 UINT32 IOPL
:2; // I/O Privilege Level
3675 UINT32 NT
:1; // Nested Task
3676 UINT32 Reserved_3
:1; // Reserved
3677 UINT32 RF
:1; // Resume Flag
3678 UINT32 VM
:1; // Virtual 8086 Mode
3679 UINT32 AC
:1; // Alignment Check
3680 UINT32 VIF
:1; // Virtual Interrupt Flag
3681 UINT32 VIP
:1; // Virtual Interrupt Pending
3682 UINT32 ID
:1; // ID Flag
3683 UINT32 Reserved_4
:10; // Reserved
3689 // Byte packed structure for Control Register 0 (CR0)
3691 // 64-bits on X64. The upper 32-bits on X64 are reserved
3695 UINT32 PE
:1; // Protection Enable
3696 UINT32 MP
:1; // Monitor Coprocessor
3697 UINT32 EM
:1; // Emulation
3698 UINT32 TS
:1; // Task Switched
3699 UINT32 ET
:1; // Extension Type
3700 UINT32 NE
:1; // Numeric Error
3701 UINT32 Reserved_0
:10; // Reserved
3702 UINT32 WP
:1; // Write Protect
3703 UINT32 Reserved_1
:1; // Reserved
3704 UINT32 AM
:1; // Alignment Mask
3705 UINT32 Reserved_2
:10; // Reserved
3706 UINT32 NW
:1; // Mot Write-through
3707 UINT32 CD
:1; // Cache Disable
3708 UINT32 PG
:1; // Paging
3714 // Byte packed structure for Control Register 4 (CR4)
3716 // 64-bits on X64. The upper 32-bits on X64 are reserved
3720 UINT32 VME
:1; // Virtual-8086 Mode Extensions
3721 UINT32 PVI
:1; // Protected-Mode Virtual Interrupts
3722 UINT32 TSD
:1; // Time Stamp Disable
3723 UINT32 DE
:1; // Debugging Extensions
3724 UINT32 PSE
:1; // Page Size Extensions
3725 UINT32 PAE
:1; // Physical Address Extension
3726 UINT32 MCE
:1; // Machine Check Enable
3727 UINT32 PGE
:1; // Page Global Enable
3728 UINT32 PCE
:1; // Performance Monitoring Counter
3730 UINT32 OSFXSR
:1; // Operating System Support for
3731 // FXSAVE and FXRSTOR instructions
3732 UINT32 OSXMMEXCPT
:1; // Operating System Support for
3733 // Unmasked SIMD Floating Point
3735 UINT32 Reserved_0
:2; // Reserved
3736 UINT32 VMXE
:1; // VMX Enable
3737 UINT32 Reserved_1
:18; // Reseved
3743 // Byte packed structure for an IDTR, GDTR, LDTR descriptor
3744 /// @bug How to make this structure byte-packed in a compiler independent way?
3753 #define IA32_IDT_GATE_TYPE_TASK 0x85
3754 #define IA32_IDT_GATE_TYPE_INTERRUPT_16 0x86
3755 #define IA32_IDT_GATE_TYPE_TRAP_16 0x87
3756 #define IA32_IDT_GATE_TYPE_INTERRUPT_32 0x8E
3757 #define IA32_IDT_GATE_TYPE_TRAP_32 0x8F
3760 // Byte packed structure for an Interrupt Gate Descriptor
3764 UINT32 OffsetLow
:16; // Offset bits 15..0
3765 UINT32 Selector
:16; // Selector
3766 UINT32 Reserved_0
:8; // Reserved
3767 UINT32 GateType
:8; // Gate Type. See #defines above
3768 UINT32 OffsetHigh
:16; // Offset bits 31..16
3771 } IA32_IDT_GATE_DESCRIPTOR
;
3774 // Byte packed structure for an FP/SSE/SSE2 context
3781 // Structures for the 16-bit real mode thunks
3834 IA32_EFLAGS32 EFLAGS
;
3844 } IA32_REGISTER_SET
;
3847 // Byte packed structure for an 16-bit real mode thunks
3850 IA32_REGISTER_SET
*RealModeState
;
3851 VOID
*RealModeBuffer
;
3852 UINT32 RealModeBufferSize
;
3853 UINT32 ThunkAttributes
;
3856 #define THUNK_ATTRIBUTE_BIG_REAL_MODE 0x00000001
3857 #define THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 0x00000002
3858 #define THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL 0x00000004
3861 Retrieves CPUID information.
3863 Executes the CPUID instruction with EAX set to the value specified by Index.
3864 This function always returns Index.
3865 If Eax is not NULL, then the value of EAX after CPUID is returned in Eax.
3866 If Ebx is not NULL, then the value of EBX after CPUID is returned in Ebx.
3867 If Ecx is not NULL, then the value of ECX after CPUID is returned in Ecx.
3868 If Edx is not NULL, then the value of EDX after CPUID is returned in Edx.
3869 This function is only available on IA-32 and X64.
3871 @param Index The 32-bit value to load into EAX prior to invoking the CPUID
3873 @param Eax Pointer to the 32-bit EAX value returned by the CPUID
3874 instruction. This is an optional parameter that may be NULL.
3875 @param Ebx Pointer to the 32-bit EBX value returned by the CPUID
3876 instruction. This is an optional parameter that may be NULL.
3877 @param Ecx Pointer to the 32-bit ECX value returned by the CPUID
3878 instruction. This is an optional parameter that may be NULL.
3879 @param Edx Pointer to the 32-bit EDX value returned by the CPUID
3880 instruction. This is an optional parameter that may be NULL.
3889 OUT UINT32
*Eax
, OPTIONAL
3890 OUT UINT32
*Ebx
, OPTIONAL
3891 OUT UINT32
*Ecx
, OPTIONAL
3892 OUT UINT32
*Edx OPTIONAL
3897 Retrieves CPUID information using an extended leaf identifier.
3899 Executes the CPUID instruction with EAX set to the value specified by Index
3900 and ECX set to the value specified by SubIndex. This function always returns
3901 Index. This function is only available on IA-32 and x64.
3903 If Eax is not NULL, then the value of EAX after CPUID is returned in Eax.
3904 If Ebx is not NULL, then the value of EBX after CPUID is returned in Ebx.
3905 If Ecx is not NULL, then the value of ECX after CPUID is returned in Ecx.
3906 If Edx is not NULL, then the value of EDX after CPUID is returned in Edx.
3908 @param Index The 32-bit value to load into EAX prior to invoking the
3910 @param SubIndex The 32-bit value to load into ECX prior to invoking the
3912 @param Eax Pointer to the 32-bit EAX value returned by the CPUID
3913 instruction. This is an optional parameter that may be
3915 @param Ebx Pointer to the 32-bit EBX value returned by the CPUID
3916 instruction. This is an optional parameter that may be
3918 @param Ecx Pointer to the 32-bit ECX value returned by the CPUID
3919 instruction. This is an optional parameter that may be
3921 @param Edx Pointer to the 32-bit EDX value returned by the CPUID
3922 instruction. This is an optional parameter that may be
3933 OUT UINT32
*Eax
, OPTIONAL
3934 OUT UINT32
*Ebx
, OPTIONAL
3935 OUT UINT32
*Ecx
, OPTIONAL
3936 OUT UINT32
*Edx OPTIONAL
3941 Returns the lower 32-bits of a Machine Specific Register(MSR).
3943 Reads and returns the lower 32-bits of the MSR specified by Index.
3944 No parameter checking is performed on Index, and some Index values may cause
3945 CPU exceptions. The caller must either guarantee that Index is valid, or the
3946 caller must set up exception handlers to catch the exceptions. This function
3947 is only available on IA-32 and X64.
3949 @param Index The 32-bit MSR index to read.
3951 @return The lower 32 bits of the MSR identified by Index.
3962 Zero-extend a 32-bit value and writes it to a Machine Specific Register(MSR).
3964 Writes the 32-bit value specified by Value to the MSR specified by Index. The
3965 upper 32-bits of the MSR write are set to zero. The 32-bit value written to
3966 the MSR is returned. No parameter checking is performed on Index or Value,
3967 and some of these may cause CPU exceptions. The caller must either guarantee
3968 that Index and Value are valid, or the caller must establish proper exception
3969 handlers. This function is only available on IA-32 and X64.
3971 @param Index The 32-bit MSR index to write.
3972 @param Value The 32-bit value to write to the MSR.
3986 Reads a 64-bit MSR, performs a bitwise inclusive OR on the lower 32-bits, and
3987 writes the result back to the 64-bit MSR.
3989 Reads the 64-bit MSR specified by Index, performs a bitwise inclusive OR
3990 between the lower 32-bits of the read result and the value specified by
3991 OrData, and writes the result to the 64-bit MSR specified by Index. The lower
3992 32-bits of the value written to the MSR is returned. No parameter checking is
3993 performed on Index or OrData, and some of these may cause CPU exceptions. The
3994 caller must either guarantee that Index and OrData are valid, or the caller
3995 must establish proper exception handlers. This function is only available on
3998 @param Index The 32-bit MSR index to write.
3999 @param OrData The value to OR with the read value from the MSR.
4001 @return The lower 32-bit value written to the MSR.
4013 Reads a 64-bit MSR, performs a bitwise AND on the lower 32-bits, and writes
4014 the result back to the 64-bit MSR.
4016 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
4017 lower 32-bits of the read result and the value specified by AndData, and
4018 writes the result to the 64-bit MSR specified by Index. The lower 32-bits of
4019 the value written to the MSR is returned. No parameter checking is performed
4020 on Index or AndData, and some of these may cause CPU exceptions. The caller
4021 must either guarantee that Index and AndData are valid, or the caller must
4022 establish proper exception handlers. This function is only available on IA-32
4025 @param Index The 32-bit MSR index to write.
4026 @param AndData The value to AND with the read value from the MSR.
4028 @return The lower 32-bit value written to the MSR.
4040 Reads a 64-bit MSR, performs a bitwise AND followed by a bitwise inclusive OR
4041 on the lower 32-bits, and writes the result back to the 64-bit MSR.
4043 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
4044 lower 32-bits of the read result and the value specified by AndData
4045 preserving the upper 32-bits, performs a bitwise inclusive OR between the
4046 result of the AND operation and the value specified by OrData, and writes the
4047 result to the 64-bit MSR specified by Address. The lower 32-bits of the value
4048 written to the MSR is returned. No parameter checking is performed on Index,
4049 AndData, or OrData, and some of these may cause CPU exceptions. The caller
4050 must either guarantee that Index, AndData, and OrData are valid, or the
4051 caller must establish proper exception handlers. This function is only
4052 available on IA-32 and X64.
4054 @param Index The 32-bit MSR index to write.
4055 @param AndData The value to AND with the read value from the MSR.
4056 @param OrData The value to OR with the result of the AND operation.
4058 @return The lower 32-bit value written to the MSR.
4071 Reads a bit field of an MSR.
4073 Reads the bit field in the lower 32-bits of a 64-bit MSR. The bit field is
4074 specified by the StartBit and the EndBit. The value of the bit field is
4075 returned. The caller must either guarantee that Index is valid, or the caller
4076 must set up exception handlers to catch the exceptions. This function is only
4077 available on IA-32 and X64.
4079 If StartBit is greater than 31, then ASSERT().
4080 If EndBit is greater than 31, then ASSERT().
4081 If EndBit is less than StartBit, then ASSERT().
4083 @param Index The 32-bit MSR index to read.
4084 @param StartBit The ordinal of the least significant bit in the bit field.
4086 @param EndBit The ordinal of the most significant bit in the bit field.
4089 @return The bit field read from the MSR.
4094 AsmMsrBitFieldRead32 (
4102 Writes a bit field to an MSR.
4104 Writes Value to a bit field in the lower 32-bits of a 64-bit MSR. The bit
4105 field is specified by the StartBit and the EndBit. All other bits in the
4106 destination MSR are preserved. The lower 32-bits of the MSR written is
4107 returned. Extra left bits in Value are stripped. The caller must either
4108 guarantee that Index and the data written is valid, or the caller must set up
4109 exception handlers to catch the exceptions. This function is only available
4112 If StartBit is greater than 31, then ASSERT().
4113 If EndBit is greater than 31, then ASSERT().
4114 If EndBit is less than StartBit, then ASSERT().
4116 @param Index The 32-bit MSR index to write.
4117 @param StartBit The ordinal of the least significant bit in the bit field.
4119 @param EndBit The ordinal of the most significant bit in the bit field.
4121 @param Value New value of the bit field.
4123 @return The lower 32-bit of the value written to the MSR.
4128 AsmMsrBitFieldWrite32 (
4137 Reads a bit field in a 64-bit MSR, performs a bitwise OR, and writes the
4138 result back to the bit field in the 64-bit MSR.
4140 Reads the 64-bit MSR specified by Index, performs a bitwise inclusive OR
4141 between the read result and the value specified by OrData, and writes the
4142 result to the 64-bit MSR specified by Index. The lower 32-bits of the value
4143 written to the MSR are returned. Extra left bits in OrData are stripped. The
4144 caller must either guarantee that Index and the data written is valid, or
4145 the caller must set up exception handlers to catch the exceptions. This
4146 function is only available on IA-32 and X64.
4148 If StartBit is greater than 31, then ASSERT().
4149 If EndBit is greater than 31, then ASSERT().
4150 If EndBit is less than StartBit, then ASSERT().
4152 @param Index The 32-bit MSR index to write.
4153 @param StartBit The ordinal of the least significant bit in the bit field.
4155 @param EndBit The ordinal of the most significant bit in the bit field.
4157 @param OrData The value to OR with the read value from the MSR.
4159 @return The lower 32-bit of the value written to the MSR.
4164 AsmMsrBitFieldOr32 (
4173 Reads a bit field in a 64-bit MSR, performs a bitwise AND, and writes the
4174 result back to the bit field in the 64-bit MSR.
4176 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
4177 read result and the value specified by AndData, and writes the result to the
4178 64-bit MSR specified by Index. The lower 32-bits of the value written to the
4179 MSR are returned. Extra left bits in AndData are stripped. The caller must
4180 either guarantee that Index and the data written is valid, or the caller must
4181 set up exception handlers to catch the exceptions. This function is only
4182 available on IA-32 and X64.
4184 If StartBit is greater than 31, then ASSERT().
4185 If EndBit is greater than 31, then ASSERT().
4186 If EndBit is less than StartBit, then ASSERT().
4188 @param Index The 32-bit MSR index to write.
4189 @param StartBit The ordinal of the least significant bit in the bit field.
4191 @param EndBit The ordinal of the most significant bit in the bit field.
4193 @param AndData The value to AND with the read value from the MSR.
4195 @return The lower 32-bit of the value written to the MSR.
4200 AsmMsrBitFieldAnd32 (
4209 Reads a bit field in a 64-bit MSR, performs a bitwise AND followed by a
4210 bitwise inclusive OR, and writes the result back to the bit field in the
4213 Reads the 64-bit MSR specified by Index, performs a bitwise AND followed by a
4214 bitwise inclusive OR between the read result and the value specified by
4215 AndData, and writes the result to the 64-bit MSR specified by Index. The
4216 lower 32-bits of the value written to the MSR are returned. Extra left bits
4217 in both AndData and OrData are stripped. The caller must either guarantee
4218 that Index and the data written is valid, or the caller must set up exception
4219 handlers to catch the exceptions. This function is only available on IA-32
4222 If StartBit is greater than 31, then ASSERT().
4223 If EndBit is greater than 31, then ASSERT().
4224 If EndBit is less than StartBit, then ASSERT().
4226 @param Index The 32-bit MSR index to write.
4227 @param StartBit The ordinal of the least significant bit in the bit field.
4229 @param EndBit The ordinal of the most significant bit in the bit field.
4231 @param AndData The value to AND with the read value from the MSR.
4232 @param OrData The value to OR with the result of the AND operation.
4234 @return The lower 32-bit of the value written to the MSR.
4239 AsmMsrBitFieldAndThenOr32 (
4249 Returns a 64-bit Machine Specific Register(MSR).
4251 Reads and returns the 64-bit MSR specified by Index. No parameter checking is
4252 performed on Index, and some Index values may cause CPU exceptions. The
4253 caller must either guarantee that Index is valid, or the caller must set up
4254 exception handlers to catch the exceptions. This function is only available
4257 @param Index The 32-bit MSR index to read.
4259 @return The value of the MSR identified by Index.
4270 Writes a 64-bit value to a Machine Specific Register(MSR), and returns the
4273 Writes the 64-bit value specified by Value to the MSR specified by Index. The
4274 64-bit value written to the MSR is returned. No parameter checking is
4275 performed on Index or Value, and some of these may cause CPU exceptions. The
4276 caller must either guarantee that Index and Value are valid, or the caller
4277 must establish proper exception handlers. This function is only available on
4280 @param Index The 32-bit MSR index to write.
4281 @param Value The 64-bit value to write to the MSR.
4295 Reads a 64-bit MSR, performs a bitwise inclusive OR, and writes the result
4296 back to the 64-bit MSR.
4298 Reads the 64-bit MSR specified by Index, performs a bitwise inclusive OR
4299 between the read result and the value specified by OrData, and writes the
4300 result to the 64-bit MSR specified by Index. The value written to the MSR is
4301 returned. No parameter checking is performed on Index or OrData, and some of
4302 these may cause CPU exceptions. The caller must either guarantee that Index
4303 and OrData are valid, or the caller must establish proper exception handlers.
4304 This function is only available on IA-32 and X64.
4306 @param Index The 32-bit MSR index to write.
4307 @param OrData The value to OR with the read value from the MSR.
4309 @return The value written back to the MSR.
4321 Reads a 64-bit MSR, performs a bitwise AND, and writes the result back to the
4324 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
4325 read result and the value specified by OrData, and writes the result to the
4326 64-bit MSR specified by Index. The value written to the MSR is returned. No
4327 parameter checking is performed on Index or OrData, and some of these may
4328 cause CPU exceptions. The caller must either guarantee that Index and OrData
4329 are valid, or the caller must establish proper exception handlers. This
4330 function is only available on IA-32 and X64.
4332 @param Index The 32-bit MSR index to write.
4333 @param AndData The value to AND with the read value from the MSR.
4335 @return The value written back to the MSR.
4347 Reads a 64-bit MSR, performs a bitwise AND followed by a bitwise inclusive
4348 OR, and writes the result back to the 64-bit MSR.
4350 Reads the 64-bit MSR specified by Index, performs a bitwise AND between read
4351 result and the value specified by AndData, performs a bitwise inclusive OR
4352 between the result of the AND operation and the value specified by OrData,
4353 and writes the result to the 64-bit MSR specified by Index. The value written
4354 to the MSR is returned. No parameter checking is performed on Index, AndData,
4355 or OrData, and some of these may cause CPU exceptions. The caller must either
4356 guarantee that Index, AndData, and OrData are valid, or the caller must
4357 establish proper exception handlers. This function is only available on IA-32
4360 @param Index The 32-bit MSR index to write.
4361 @param AndData The value to AND with the read value from the MSR.
4362 @param OrData The value to OR with the result of the AND operation.
4364 @return The value written back to the MSR.
4377 Reads a bit field of an MSR.
4379 Reads the bit field in the 64-bit MSR. The bit field is specified by the
4380 StartBit and the EndBit. The value of the bit field is returned. The caller
4381 must either guarantee that Index is valid, or the caller must set up
4382 exception handlers to catch the exceptions. This function is only available
4385 If StartBit is greater than 63, then ASSERT().
4386 If EndBit is greater than 63, then ASSERT().
4387 If EndBit is less than StartBit, then ASSERT().
4389 @param Index The 32-bit MSR index to read.
4390 @param StartBit The ordinal of the least significant bit in the bit field.
4392 @param EndBit The ordinal of the most significant bit in the bit field.
4395 @return The value read from the MSR.
4400 AsmMsrBitFieldRead64 (
4408 Writes a bit field to an MSR.
4410 Writes Value to a bit field in a 64-bit MSR. The bit field is specified by
4411 the StartBit and the EndBit. All other bits in the destination MSR are
4412 preserved. The MSR written is returned. Extra left bits in Value are
4413 stripped. The caller must either guarantee that Index and the data written is
4414 valid, or the caller must set up exception handlers to catch the exceptions.
4415 This function is only available on IA-32 and X64.
4417 If StartBit is greater than 63, then ASSERT().
4418 If EndBit is greater than 63, then ASSERT().
4419 If EndBit is less than StartBit, then ASSERT().
4421 @param Index The 32-bit MSR index to write.
4422 @param StartBit The ordinal of the least significant bit in the bit field.
4424 @param EndBit The ordinal of the most significant bit in the bit field.
4426 @param Value New value of the bit field.
4428 @return The value written back to the MSR.
4433 AsmMsrBitFieldWrite64 (
4442 Reads a bit field in a 64-bit MSR, performs a bitwise inclusive OR, and
4443 writes the result back to the bit field in the 64-bit MSR.
4445 Reads the 64-bit MSR specified by Index, performs a bitwise inclusive OR
4446 between the read result and the value specified by OrData, and writes the
4447 result to the 64-bit MSR specified by Index. The value written to the MSR is
4448 returned. Extra left bits in OrData are stripped. The caller must either
4449 guarantee that Index and the data written is valid, or the caller must set up
4450 exception handlers to catch the exceptions. This function is only available
4453 If StartBit is greater than 63, then ASSERT().
4454 If EndBit is greater than 63, then ASSERT().
4455 If EndBit is less than StartBit, then ASSERT().
4457 @param Index The 32-bit MSR index to write.
4458 @param StartBit The ordinal of the least significant bit in the bit field.
4460 @param EndBit The ordinal of the most significant bit in the bit field.
4462 @param OrData The value to OR with the read value from the bit field.
4464 @return The value written back to the MSR.
4469 AsmMsrBitFieldOr64 (
4478 Reads a bit field in a 64-bit MSR, performs a bitwise AND, and writes the
4479 result back to the bit field in the 64-bit MSR.
4481 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
4482 read result and the value specified by AndData, and writes the result to the
4483 64-bit MSR specified by Index. The value written to the MSR is returned.
4484 Extra left bits in AndData are stripped. The caller must either guarantee
4485 that Index and the data written is valid, or the caller must set up exception
4486 handlers to catch the exceptions. This function is only available on IA-32
4489 If StartBit is greater than 63, then ASSERT().
4490 If EndBit is greater than 63, then ASSERT().
4491 If EndBit is less than StartBit, then ASSERT().
4493 @param Index The 32-bit MSR index to write.
4494 @param StartBit The ordinal of the least significant bit in the bit field.
4496 @param EndBit The ordinal of the most significant bit in the bit field.
4498 @param AndData The value to AND with the read value from the bit field.
4500 @return The value written back to the MSR.
4505 AsmMsrBitFieldAnd64 (
4514 Reads a bit field in a 64-bit MSR, performs a bitwise AND followed by a
4515 bitwise inclusive OR, and writes the result back to the bit field in the
4518 Reads the 64-bit MSR specified by Index, performs a bitwise AND followed by
4519 a bitwise inclusive OR between the read result and the value specified by
4520 AndData, and writes the result to the 64-bit MSR specified by Index. The
4521 value written to the MSR is returned. Extra left bits in both AndData and
4522 OrData are stripped. The caller must either guarantee that Index and the data
4523 written is valid, or the caller must set up exception handlers to catch the
4524 exceptions. This function is only available on IA-32 and X64.
4526 If StartBit is greater than 63, then ASSERT().
4527 If EndBit is greater than 63, then ASSERT().
4528 If EndBit is less than StartBit, then ASSERT().
4530 @param Index The 32-bit MSR index to write.
4531 @param StartBit The ordinal of the least significant bit in the bit field.
4533 @param EndBit The ordinal of the most significant bit in the bit field.
4535 @param AndData The value to AND with the read value from the bit field.
4536 @param OrData The value to OR with the result of the AND operation.
4538 @return The value written back to the MSR.
4543 AsmMsrBitFieldAndThenOr64 (
4553 Reads the current value of the EFLAGS register.
4555 Reads and returns the current value of the EFLAGS register. This function is
4556 only available on IA-32 and X64. This returns a 32-bit value on IA-32 and a
4557 64-bit value on X64.
4559 @return EFLAGS on IA-32 or RFLAGS on X64.
4570 Reads the current value of the Control Register 0 (CR0).
4572 Reads and returns the current value of CR0. This function is only available
4573 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
4576 @return The value of the Control Register 0 (CR0).
4587 Reads the current value of the Control Register 2 (CR2).
4589 Reads and returns the current value of CR2. This function is only available
4590 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
4593 @return The value of the Control Register 2 (CR2).
4604 Reads the current value of the Control Register 3 (CR3).
4606 Reads and returns the current value of CR3. This function is only available
4607 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
4610 @return The value of the Control Register 3 (CR3).
4621 Reads the current value of the Control Register 4 (CR4).
4623 Reads and returns the current value of CR4. This function is only available
4624 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
4627 @return The value of the Control Register 4 (CR4).
4638 Writes a value to Control Register 0 (CR0).
4640 Writes and returns a new value to CR0. This function is only available on
4641 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
4643 @param Cr0 The value to write to CR0.
4645 @return The value written to CR0.
4656 Writes a value to Control Register 2 (CR2).
4658 Writes and returns a new value to CR2. This function is only available on
4659 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
4661 @param Cr2 The value to write to CR2.
4663 @return The value written to CR2.
4674 Writes a value to Control Register 3 (CR3).
4676 Writes and returns a new value to CR3. This function is only available on
4677 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
4679 @param Cr3 The value to write to CR3.
4681 @return The value written to CR3.
4692 Writes a value to Control Register 4 (CR4).
4694 Writes and returns a new value to CR4. This function is only available on
4695 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
4697 @param Cr4 The value to write to CR4.
4699 @return The value written to CR4.
4710 Reads the current value of Debug Register 0 (DR0).
4712 Reads and returns the current value of DR0. This function is only available
4713 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
4716 @return The value of Debug Register 0 (DR0).
4727 Reads the current value of Debug Register 1 (DR1).
4729 Reads and returns the current value of DR1. This function is only available
4730 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
4733 @return The value of Debug Register 1 (DR1).
4744 Reads the current value of Debug Register 2 (DR2).
4746 Reads and returns the current value of DR2. This function is only available
4747 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
4750 @return The value of Debug Register 2 (DR2).
4761 Reads the current value of Debug Register 3 (DR3).
4763 Reads and returns the current value of DR3. This function is only available
4764 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
4767 @return The value of Debug Register 3 (DR3).
4778 Reads the current value of Debug Register 4 (DR4).
4780 Reads and returns the current value of DR4. This function is only available
4781 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
4784 @return The value of Debug Register 4 (DR4).
4795 Reads the current value of Debug Register 5 (DR5).
4797 Reads and returns the current value of DR5. This function is only available
4798 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
4801 @return The value of Debug Register 5 (DR5).
4812 Reads the current value of Debug Register 6 (DR6).
4814 Reads and returns the current value of DR6. This function is only available
4815 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
4818 @return The value of Debug Register 6 (DR6).
4829 Reads the current value of Debug Register 7 (DR7).
4831 Reads and returns the current value of DR7. This function is only available
4832 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
4835 @return The value of Debug Register 7 (DR7).
4846 Writes a value to Debug Register 0 (DR0).
4848 Writes and returns a new value to DR0. This function is only available on
4849 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
4851 @param Dr0 The value to write to Dr0.
4853 @return The value written to Debug Register 0 (DR0).
4864 Writes a value to Debug Register 1 (DR1).
4866 Writes and returns a new value to DR1. This function is only available on
4867 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
4869 @param Dr1 The value to write to Dr1.
4871 @return The value written to Debug Register 1 (DR1).
4882 Writes a value to Debug Register 2 (DR2).
4884 Writes and returns a new value to DR2. This function is only available on
4885 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
4887 @param Dr2 The value to write to Dr2.
4889 @return The value written to Debug Register 2 (DR2).
4900 Writes a value to Debug Register 3 (DR3).
4902 Writes and returns a new value to DR3. This function is only available on
4903 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
4905 @param Dr3 The value to write to Dr3.
4907 @return The value written to Debug Register 3 (DR3).
4918 Writes a value to Debug Register 4 (DR4).
4920 Writes and returns a new value to DR4. This function is only available on
4921 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
4923 @param Dr4 The value to write to Dr4.
4925 @return The value written to Debug Register 4 (DR4).
4936 Writes a value to Debug Register 5 (DR5).
4938 Writes and returns a new value to DR5. This function is only available on
4939 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
4941 @param Dr5 The value to write to Dr5.
4943 @return The value written to Debug Register 5 (DR5).
4954 Writes a value to Debug Register 6 (DR6).
4956 Writes and returns a new value to DR6. This function is only available on
4957 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
4959 @param Dr6 The value to write to Dr6.
4961 @return The value written to Debug Register 6 (DR6).
4972 Writes a value to Debug Register 7 (DR7).
4974 Writes and returns a new value to DR7. This function is only available on
4975 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
4977 @param Dr7 The value to write to Dr7.
4979 @return The value written to Debug Register 7 (DR7).
4990 Reads the current value of Code Segment Register (CS).
4992 Reads and returns the current value of CS. This function is only available on
4995 @return The current value of CS.
5006 Reads the current value of Data Segment Register (DS).
5008 Reads and returns the current value of DS. This function is only available on
5011 @return The current value of DS.
5022 Reads the current value of Extra Segment Register (ES).
5024 Reads and returns the current value of ES. This function is only available on
5027 @return The current value of ES.
5038 Reads the current value of FS Data Segment Register (FS).
5040 Reads and returns the current value of FS. This function is only available on
5043 @return The current value of FS.
5054 Reads the current value of GS Data Segment Register (GS).
5056 Reads and returns the current value of GS. This function is only available on
5059 @return The current value of GS.
5070 Reads the current value of Stack Segment Register (SS).
5072 Reads and returns the current value of SS. This function is only available on
5075 @return The current value of SS.
5086 Reads the current value of Task Register (TR).
5088 Reads and returns the current value of TR. This function is only available on
5091 @return The current value of TR.
5102 Reads the current Global Descriptor Table Register(GDTR) descriptor.
5104 Reads and returns the current GDTR descriptor and returns it in Gdtr. This
5105 function is only available on IA-32 and X64.
5107 If Gdtr is NULL, then ASSERT().
5109 @param Gdtr Pointer to a GDTR descriptor.
5115 OUT IA32_DESCRIPTOR
*Gdtr
5120 Writes the current Global Descriptor Table Register (GDTR) descriptor.
5122 Writes and the current GDTR descriptor specified by Gdtr. This function is
5123 only available on IA-32 and X64.
5125 If Gdtr is NULL, then ASSERT().
5127 @param Gdtr Pointer to a GDTR descriptor.
5133 IN CONST IA32_DESCRIPTOR
*Gdtr
5138 Reads the current Interrupt Descriptor Table Register(GDTR) descriptor.
5140 Reads and returns the current IDTR descriptor and returns it in Idtr. This
5141 function is only available on IA-32 and X64.
5143 If Idtr is NULL, then ASSERT().
5145 @param Idtr Pointer to a IDTR descriptor.
5151 OUT IA32_DESCRIPTOR
*Idtr
5156 Writes the current Interrupt Descriptor Table Register(GDTR) descriptor.
5158 Writes the current IDTR descriptor and returns it in Idtr. This function is
5159 only available on IA-32 and X64.
5161 If Idtr is NULL, then ASSERT().
5163 @param Idtr Pointer to a IDTR descriptor.
5169 IN CONST IA32_DESCRIPTOR
*Idtr
5174 Reads the current Local Descriptor Table Register(LDTR) selector.
5176 Reads and returns the current 16-bit LDTR descriptor value. This function is
5177 only available on IA-32 and X64.
5179 @return The current selector of LDT.
5190 Writes the current Local Descriptor Table Register (GDTR) selector.
5192 Writes and the current LDTR descriptor specified by Ldtr. This function is
5193 only available on IA-32 and X64.
5195 @param Ldtr 16-bit LDTR selector value.
5206 Save the current floating point/SSE/SSE2 context to a buffer.
5208 Saves the current floating point/SSE/SSE2 state to the buffer specified by
5209 Buffer. Buffer must be aligned on a 16-byte boundary. This function is only
5210 available on IA-32 and X64.
5212 If Buffer is NULL, then ASSERT().
5213 If Buffer is not aligned on a 16-byte boundary, then ASSERT().
5215 @param Buffer Pointer to a buffer to save the floating point/SSE/SSE2 context.
5221 OUT IA32_FX_BUFFER
*Buffer
5226 Restores the current floating point/SSE/SSE2 context from a buffer.
5228 Restores the current floating point/SSE/SSE2 state from the buffer specified
5229 by Buffer. Buffer must be aligned on a 16-byte boundary. This function is
5230 only available on IA-32 and X64.
5232 If Buffer is NULL, then ASSERT().
5233 If Buffer is not aligned on a 16-byte boundary, then ASSERT().
5234 If Buffer was not saved with AsmFxSave(), then ASSERT().
5236 @param Buffer Pointer to a buffer to save the floating point/SSE/SSE2 context.
5242 IN CONST IA32_FX_BUFFER
*Buffer
5247 Reads the current value of 64-bit MMX Register #0 (MM0).
5249 Reads and returns the current value of MM0. This function is only available
5252 @return The current value of MM0.
5263 Reads the current value of 64-bit MMX Register #1 (MM1).
5265 Reads and returns the current value of MM1. This function is only available
5268 @return The current value of MM1.
5279 Reads the current value of 64-bit MMX Register #2 (MM2).
5281 Reads and returns the current value of MM2. This function is only available
5284 @return The current value of MM2.
5295 Reads the current value of 64-bit MMX Register #3 (MM3).
5297 Reads and returns the current value of MM3. This function is only available
5300 @return The current value of MM3.
5311 Reads the current value of 64-bit MMX Register #4 (MM4).
5313 Reads and returns the current value of MM4. This function is only available
5316 @return The current value of MM4.
5327 Reads the current value of 64-bit MMX Register #5 (MM5).
5329 Reads and returns the current value of MM5. This function is only available
5332 @return The current value of MM5.
5343 Reads the current value of 64-bit MMX Register #6 (MM6).
5345 Reads and returns the current value of MM6. This function is only available
5348 @return The current value of MM6.
5359 Reads the current value of 64-bit MMX Register #7 (MM7).
5361 Reads and returns the current value of MM7. This function is only available
5364 @return The current value of MM7.
5375 Writes the current value of 64-bit MMX Register #0 (MM0).
5377 Writes the current value of MM0. This function is only available on IA32 and
5380 @param Value The 64-bit value to write to MM0.
5391 Writes the current value of 64-bit MMX Register #1 (MM1).
5393 Writes the current value of MM1. This function is only available on IA32 and
5396 @param Value The 64-bit value to write to MM1.
5407 Writes the current value of 64-bit MMX Register #2 (MM2).
5409 Writes the current value of MM2. This function is only available on IA32 and
5412 @param Value The 64-bit value to write to MM2.
5423 Writes the current value of 64-bit MMX Register #3 (MM3).
5425 Writes the current value of MM3. This function is only available on IA32 and
5428 @param Value The 64-bit value to write to MM3.
5439 Writes the current value of 64-bit MMX Register #4 (MM4).
5441 Writes the current value of MM4. This function is only available on IA32 and
5444 @param Value The 64-bit value to write to MM4.
5455 Writes the current value of 64-bit MMX Register #5 (MM5).
5457 Writes the current value of MM5. This function is only available on IA32 and
5460 @param Value The 64-bit value to write to MM5.
5471 Writes the current value of 64-bit MMX Register #6 (MM6).
5473 Writes the current value of MM6. This function is only available on IA32 and
5476 @param Value The 64-bit value to write to MM6.
5487 Writes the current value of 64-bit MMX Register #7 (MM7).
5489 Writes the current value of MM7. This function is only available on IA32 and
5492 @param Value The 64-bit value to write to MM7.
5503 Reads the current value of Time Stamp Counter (TSC).
5505 Reads and returns the current value of TSC. This function is only available
5508 @return The current value of TSC
5519 Reads the current value of a Performance Counter (PMC).
5521 Reads and returns the current value of performance counter specified by
5522 Index. This function is only available on IA-32 and X64.
5524 @param Index The 32-bit Performance Counter index to read.
5526 @return The value of the PMC specified by Index.
5537 Sets up a monitor buffer that is used by AsmMwait().
5539 Executes a MONITOR instruction with the register state specified by Eax, Ecx
5540 and Edx. Returns Eax. This function is only available on IA-32 and X64.
5542 @param Eax The value to load into EAX or RAX before executing the MONITOR
5544 @param Ecx The value to load into ECX or RCX before executing the MONITOR
5546 @param Edx The value to load into EDX or RDX before executing the MONITOR
5562 Executes an MWAIT instruction.
5564 Executes an MWAIT instruction with the register state specified by Eax and
5565 Ecx. Returns Eax. This function is only available on IA-32 and X64.
5567 @param Eax The value to load into EAX or RAX before executing the MONITOR
5569 @param Ecx The value to load into ECX or RCX before executing the MONITOR
5584 Executes a WBINVD instruction.
5586 Executes a WBINVD instruction. This function is only available on IA-32 and
5598 Executes a INVD instruction.
5600 Executes a INVD instruction. This function is only available on IA-32 and
5612 Flushes a cache line from all the instruction and data caches within the
5613 coherency domain of the CPU.
5615 Flushed the cache line specified by LinearAddress, and returns LinearAddress.
5616 This function is only available on IA-32 and X64.
5618 @param LinearAddress The address of the cache line to flush. If the CPU is
5619 in a physical addressing mode, then LinearAddress is a
5620 physical address. If the CPU is in a virtual
5621 addressing mode, then LinearAddress is a virtual
5624 @return LinearAddress
5629 IN VOID
*LinearAddress
5634 Enables the 32-bit paging mode on the CPU.
5636 Enables the 32-bit paging mode on the CPU. CR0, CR3, CR4, and the page tables
5637 must be properly initialized prior to calling this service. This function
5638 assumes the current execution mode is 32-bit protected mode. This function is
5639 only available on IA-32. After the 32-bit paging mode is enabled, control is
5640 transferred to the function specified by EntryPoint using the new stack
5641 specified by NewStack and passing in the parameters specified by Context1 and
5642 Context2. Context1 and Context2 are optional and may be NULL. The function
5643 EntryPoint must never return.
5645 If the current execution mode is not 32-bit protected mode, then ASSERT().
5646 If EntryPoint is NULL, then ASSERT().
5647 If NewStack is NULL, then ASSERT().
5649 There are a number of constraints that must be followed before calling this
5651 1) Interrupts must be disabled.
5652 2) The caller must be in 32-bit protected mode with flat descriptors. This
5653 means all descriptors must have a base of 0 and a limit of 4GB.
5654 3) CR0 and CR4 must be compatible with 32-bit protected mode with flat
5656 4) CR3 must point to valid page tables that will be used once the transition
5657 is complete, and those page tables must guarantee that the pages for this
5658 function and the stack are identity mapped.
5660 @param EntryPoint A pointer to function to call with the new stack after
5662 @param Context1 A pointer to the context to pass into the EntryPoint
5663 function as the first parameter after paging is enabled.
5664 @param Context2 A pointer to the context to pass into the EntryPoint
5665 function as the second parameter after paging is enabled.
5666 @param NewStack A pointer to the new stack to use for the EntryPoint
5667 function after paging is enabled.
5673 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
5674 IN VOID
*Context1
, OPTIONAL
5675 IN VOID
*Context2
, OPTIONAL
5681 Disables the 32-bit paging mode on the CPU.
5683 Disables the 32-bit paging mode on the CPU and returns to 32-bit protected
5684 mode. This function assumes the current execution mode is 32-paged protected
5685 mode. This function is only available on IA-32. After the 32-bit paging mode
5686 is disabled, control is transferred to the function specified by EntryPoint
5687 using the new stack specified by NewStack and passing in the parameters
5688 specified by Context1 and Context2. Context1 and Context2 are optional and
5689 may be NULL. The function EntryPoint must never return.
5691 If the current execution mode is not 32-bit paged mode, then ASSERT().
5692 If EntryPoint is NULL, then ASSERT().
5693 If NewStack is NULL, then ASSERT().
5695 There are a number of constraints that must be followed before calling this
5697 1) Interrupts must be disabled.
5698 2) The caller must be in 32-bit paged mode.
5699 3) CR0, CR3, and CR4 must be compatible with 32-bit paged mode.
5700 4) CR3 must point to valid page tables that guarantee that the pages for
5701 this function and the stack are identity mapped.
5703 @param EntryPoint A pointer to function to call with the new stack after
5705 @param Context1 A pointer to the context to pass into the EntryPoint
5706 function as the first parameter after paging is disabled.
5707 @param Context2 A pointer to the context to pass into the EntryPoint
5708 function as the second parameter after paging is
5710 @param NewStack A pointer to the new stack to use for the EntryPoint
5711 function after paging is disabled.
5716 AsmDisablePaging32 (
5717 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
5718 IN VOID
*Context1
, OPTIONAL
5719 IN VOID
*Context2
, OPTIONAL
5725 Enables the 64-bit paging mode on the CPU.
5727 Enables the 64-bit paging mode on the CPU. CR0, CR3, CR4, and the page tables
5728 must be properly initialized prior to calling this service. This function
5729 assumes the current execution mode is 32-bit protected mode with flat
5730 descriptors. This function is only available on IA-32. After the 64-bit
5731 paging mode is enabled, control is transferred to the function specified by
5732 EntryPoint using the new stack specified by NewStack and passing in the
5733 parameters specified by Context1 and Context2. Context1 and Context2 are
5734 optional and may be 0. The function EntryPoint must never return.
5736 If the current execution mode is not 32-bit protected mode with flat
5737 descriptors, then ASSERT().
5738 If EntryPoint is 0, then ASSERT().
5739 If NewStack is 0, then ASSERT().
5741 @param Cs The 16-bit selector to load in the CS before EntryPoint
5742 is called. The descriptor in the GDT that this selector
5743 references must be setup for long mode.
5744 @param EntryPoint The 64-bit virtual address of the function to call with
5745 the new stack after paging is enabled.
5746 @param Context1 The 64-bit virtual address of the context to pass into
5747 the EntryPoint function as the first parameter after
5749 @param Context2 The 64-bit virtual address of the context to pass into
5750 the EntryPoint function as the second parameter after
5752 @param NewStack The 64-bit virtual address of the new stack to use for
5753 the EntryPoint function after paging is enabled.
5759 IN UINT16 CodeSelector
,
5760 IN UINT64 EntryPoint
,
5761 IN UINT64 Context1
, OPTIONAL
5762 IN UINT64 Context2
, OPTIONAL
5768 Disables the 64-bit paging mode on the CPU.
5770 Disables the 64-bit paging mode on the CPU and returns to 32-bit protected
5771 mode. This function assumes the current execution mode is 64-paging mode.
5772 This function is only available on X64. After the 64-bit paging mode is
5773 disabled, control is transferred to the function specified by EntryPoint
5774 using the new stack specified by NewStack and passing in the parameters
5775 specified by Context1 and Context2. Context1 and Context2 are optional and
5776 may be 0. The function EntryPoint must never return.
5778 If the current execution mode is not 64-bit paged mode, then ASSERT().
5779 If EntryPoint is 0, then ASSERT().
5780 If NewStack is 0, then ASSERT().
5782 @param Cs The 16-bit selector to load in the CS before EntryPoint
5783 is called. The descriptor in the GDT that this selector
5784 references must be setup for 32-bit protected mode.
5785 @param EntryPoint The 64-bit virtual address of the function to call with
5786 the new stack after paging is disabled.
5787 @param Context1 The 64-bit virtual address of the context to pass into
5788 the EntryPoint function as the first parameter after
5790 @param Context2 The 64-bit virtual address of the context to pass into
5791 the EntryPoint function as the second parameter after
5793 @param NewStack The 64-bit virtual address of the new stack to use for
5794 the EntryPoint function after paging is disabled.
5799 AsmDisablePaging64 (
5800 IN UINT16 CodeSelector
,
5801 IN UINT32 EntryPoint
,
5802 IN UINT32 Context1
, OPTIONAL
5803 IN UINT32 Context2
, OPTIONAL
5809 // 16-bit thunking services
5813 Retrieves the properties for 16-bit thunk functions.
5815 Computes the size of the buffer and stack below 1MB required to use the
5816 AsmPrepareThunk16(), AsmThunk16() and AsmPrepareAndThunk16() functions. This
5817 buffer size is returned in RealModeBufferSize, and the stack size is returned
5818 in ExtraStackSize. If parameters are passed to the 16-bit real mode code,
5819 then the actual minimum stack size is ExtraStackSize plus the maximum number
5820 of bytes that need to be passed to the 16-bit real mode code.
5822 If RealModeBufferSize is NULL, then ASSERT().
5823 If ExtraStackSize is NULL, then ASSERT().
5825 @param RealModeBufferSize A pointer to the size of the buffer below 1MB
5826 required to use the 16-bit thunk functions.
5827 @param ExtraStackSize A pointer to the extra size of stack below 1MB
5828 that the 16-bit thunk functions require for
5829 temporary storage in the transition to and from
5835 AsmGetThunk16Properties (
5836 OUT UINT32
*RealModeBufferSize
,
5837 OUT UINT32
*ExtraStackSize
5842 Prepares all structures a code required to use AsmThunk16().
5844 Prepares all structures and code required to use AsmThunk16().
5846 If ThunkContext is NULL, then ASSERT().
5848 @param ThunkContext A pointer to the context structure that describes the
5849 16-bit real mode code to call.
5855 OUT THUNK_CONTEXT
*ThunkContext
5860 Transfers control to a 16-bit real mode entry point and returns the results.
5862 Transfers control to a 16-bit real mode entry point and returns the results.
5863 AsmPrepareThunk16() must be called with ThunkContext before this function is
5866 If ThunkContext is NULL, then ASSERT().
5867 If AsmPrepareThunk16() was not previously called with ThunkContext, then ASSERT().
5869 @param ThunkContext A pointer to the context structure that describes the
5870 16-bit real mode code to call.
5876 IN OUT THUNK_CONTEXT
*ThunkContext
5881 Prepares all structures and code for a 16-bit real mode thunk, transfers
5882 control to a 16-bit real mode entry point, and returns the results.
5884 Prepares all structures and code for a 16-bit real mode thunk, transfers
5885 control to a 16-bit real mode entry point, and returns the results. If the
5886 caller only need to perform a single 16-bit real mode thunk, then this
5887 service should be used. If the caller intends to make more than one 16-bit
5888 real mode thunk, then it is more efficient if AsmPrepareThunk16() is called
5889 once and AsmThunk16() can be called for each 16-bit real mode thunk.
5891 If ThunkContext is NULL, then ASSERT().
5893 @param ThunkContext A pointer to the context structure that describes the
5894 16-bit real mode code to call.
5899 AsmPrepareAndThunk16 (
5900 IN OUT THUNK_CONTEXT
*ThunkContext
5912 // IPF Specific functions
5917 Performs a PAL call using static calling convention.
5919 An internal function to perform a PAL call using static calling convention.
5921 @param PalEntryPoint The entry point address of PAL. The address in ar.kr5
5922 would be used if this parameter were NULL on input.
5923 @param Arg1 The first argument of a PAL call.
5924 @param Arg1 The second argument of a PAL call.
5925 @param Arg1 The third argument of a PAL call.
5926 @param Arg1 The fourth argument of a PAL call.
5928 @return The values returned in r8, r9, r10 and r11.
5933 IN CONST VOID
*PalEntryPoint
,
5942 Returns the current value of ar.itc.
5944 An internal function to return the current value of ar.itc, which is the
5947 @return The currect value of ar.itc
5957 Flush a range of cache lines in the cache coherency domain of the calling
5960 Invalidates the cache lines specified by Address and Length. If Address is
5961 not aligned on a cache line boundary, then entire cache line containing
5962 Address is invalidated. If Address + Length is not aligned on a cache line
5963 boundary, then the entire instruction cache line containing Address + Length
5964 -1 is invalidated. This function may choose to invalidate the entire
5965 instruction cache if that is more efficient than invalidating the specified
5966 range. If Length is 0, the no instruction cache lines are invalidated.
5967 Address is returned.
5969 If Length is greater than (MAX_ADDRESS - Address + 1), then ASSERT().
5971 @param Address The base address of the instruction lines to invalidate. If
5972 the CPU is in a physical addressing mode, then Address is a
5973 physical address. If the CPU is in a virtual addressing mode,
5974 then Address is a virtual address.
5976 @param Length The number of bytes to invalidate from the instruction cache.
5983 IpfFlushCacheRange (