2 Memory-only library functions with no library constructor/destructor
4 Copyright (c) 2006 - 2007, Intel Corporation
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
19 /// Definitions for SPIN_LOCK
21 typedef volatile UINTN SPIN_LOCK
;
24 // Definitions for architecture specific types
26 #if defined (MDE_CPU_IA32)
28 /// IA32 context buffer used by SetJump() and LongJump()
37 } BASE_LIBRARY_JUMP_BUFFER
;
39 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 4
41 #elif defined (MDE_CPU_IPF)
44 /// IPF context buffer used by SetJump() and LongJump()
79 UINT64 AfterSpillUNAT
;
85 } BASE_LIBRARY_JUMP_BUFFER
;
87 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 0x10
89 #elif defined (MDE_CPU_X64)
91 /// X64 context buffer used by SetJump() and LongJump()
104 } BASE_LIBRARY_JUMP_BUFFER
;
106 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 8
108 #elif defined (MDE_CPU_EBC)
110 /// EBC context buffer used by SetJump() and LongJump()
118 } BASE_LIBRARY_JUMP_BUFFER
;
120 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 8
123 #error Unknown Processor Type
131 Copies one Null-terminated Unicode string to another Null-terminated Unicode
132 string and returns the new Unicode string.
134 This function copies the contents of the Unicode string Source to the Unicode
135 string Destination, and returns Destination. If Source and Destination
136 overlap, then the results are undefined.
138 If Destination is NULL, then ASSERT().
139 If Destination is not aligned on a 16-bit boundary, then ASSERT().
140 If Source is NULL, then ASSERT().
141 If Source is not aligned on a 16-bit boundary, then ASSERT().
142 If Source and Destination overlap, then ASSERT().
143 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
144 PcdMaximumUnicodeStringLength Unicode characters not including the
145 Null-terminator, then ASSERT().
147 @param Destination Pointer to a Null-terminated Unicode string.
148 @param Source Pointer to a Null-terminated Unicode string.
156 OUT CHAR16
*Destination
,
157 IN CONST CHAR16
*Source
162 Copies one Null-terminated Unicode string with a maximum length to another
163 Null-terminated Unicode string with a maximum length and returns the new
166 This function copies the contents of the Unicode string Source to the Unicode
167 string Destination, and returns Destination. At most, Length Unicode
168 characters are copied from Source to Destination. If Length is 0, then
169 Destination is returned unmodified. If Length is greater that the number of
170 Unicode characters in Source, then Destination is padded with Null Unicode
171 characters. If Source and Destination overlap, then the results are
174 If Length > 0 and Destination is NULL, then ASSERT().
175 If Length > 0 and Destination is not aligned on a 16-bit boundary, then ASSERT().
176 If Length > 0 and Source is NULL, then ASSERT().
177 If Length > 0 and Source is not aligned on a 16-bit bounadry, then ASSERT().
178 If Source and Destination overlap, then ASSERT().
179 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
180 PcdMaximumUnicodeStringLength Unicode characters not including the
181 Null-terminator, then ASSERT().
183 @param Destination Pointer to a Null-terminated Unicode string.
184 @param Source Pointer to a Null-terminated Unicode string.
185 @param Length Maximum number of Unicode characters to copy.
193 OUT CHAR16
*Destination
,
194 IN CONST CHAR16
*Source
,
200 Returns the length of a Null-terminated Unicode string.
202 This function returns the number of Unicode characters in the Null-terminated
203 Unicode string specified by String.
205 If String is NULL, then ASSERT().
206 If String is not aligned on a 16-bit boundary, then ASSERT().
207 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
208 PcdMaximumUnicodeStringLength Unicode characters not including the
209 Null-terminator, then ASSERT().
211 @param String Pointer to a Null-terminated Unicode string.
213 @return The length of String.
219 IN CONST CHAR16
*String
224 Returns the size of a Null-terminated Unicode string in bytes, including the
227 This function returns the size, in bytes, of the Null-terminated Unicode
228 string specified by String.
230 If String is NULL, then ASSERT().
231 If String is not aligned on a 16-bit boundary, then ASSERT().
232 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
233 PcdMaximumUnicodeStringLength Unicode characters not including the
234 Null-terminator, then ASSERT().
236 @param String Pointer to a Null-terminated Unicode string.
238 @return The size of String.
244 IN CONST CHAR16
*String
249 Compares two Null-terminated Unicode strings, and returns the difference
250 between the first mismatched Unicode characters.
252 This function compares the Null-terminated Unicode string FirstString to the
253 Null-terminated Unicode string SecondString. If FirstString is identical to
254 SecondString, then 0 is returned. Otherwise, the value returned is the first
255 mismatched Unicode character in SecondString subtracted from the first
256 mismatched Unicode character in FirstString.
258 If FirstString is NULL, then ASSERT().
259 If FirstString is not aligned on a 16-bit boundary, then ASSERT().
260 If SecondString is NULL, then ASSERT().
261 If SecondString is not aligned on a 16-bit boundary, then ASSERT().
262 If PcdMaximumUnicodeStringLength is not zero, and FirstString contains more
263 than PcdMaximumUnicodeStringLength Unicode characters not including the
264 Null-terminator, then ASSERT().
265 If PcdMaximumUnicodeStringLength is not zero, and SecondString contains more
266 than PcdMaximumUnicodeStringLength Unicode characters not including the
267 Null-terminator, then ASSERT().
269 @param FirstString Pointer to a Null-terminated Unicode string.
270 @param SecondString Pointer to a Null-terminated Unicode string.
272 @retval 0 FirstString is identical to SecondString.
273 @return others FirstString is not identical to SecondString.
279 IN CONST CHAR16
*FirstString
,
280 IN CONST CHAR16
*SecondString
285 Compares two Null-terminated Unicode strings with maximum lengths, and
286 returns the difference between the first mismatched Unicode characters.
288 This function compares the Null-terminated Unicode string FirstString to the
289 Null-terminated Unicode string SecondString. At most, Length Unicode
290 characters will be compared. If Length is 0, then 0 is returned. If
291 FirstString is identical to SecondString, then 0 is returned. Otherwise, the
292 value returned is the first mismatched Unicode character in SecondString
293 subtracted from the first mismatched Unicode character in FirstString.
295 If Length > 0 and FirstString is NULL, then ASSERT().
296 If Length > 0 and FirstString is not aligned on a 16-bit bounadary, then ASSERT().
297 If Length > 0 and SecondString is NULL, then ASSERT().
298 If Length > 0 and SecondString is not aligned on a 16-bit bounadary, then ASSERT().
299 If PcdMaximumUnicodeStringLength is not zero, and FirstString contains more
300 than PcdMaximumUnicodeStringLength Unicode characters not including the
301 Null-terminator, then ASSERT().
302 If PcdMaximumUnicodeStringLength is not zero, and SecondString contains more
303 than PcdMaximumUnicodeStringLength Unicode characters not including the
304 Null-terminator, then ASSERT().
306 @param FirstString Pointer to a Null-terminated Unicode string.
307 @param SecondString Pointer to a Null-terminated Unicode string.
308 @param Length Maximum number of Unicode characters to compare.
310 @retval 0 FirstString is identical to SecondString.
311 @return others FirstString is not identical to SecondString.
317 IN CONST CHAR16
*FirstString
,
318 IN CONST CHAR16
*SecondString
,
324 Concatenates one Null-terminated Unicode string to another Null-terminated
325 Unicode string, and returns the concatenated Unicode string.
327 This function concatenates two Null-terminated Unicode strings. The contents
328 of Null-terminated Unicode string Source are concatenated to the end of
329 Null-terminated Unicode string Destination. The Null-terminated concatenated
330 Unicode String is returned. If Source and Destination overlap, then the
331 results are undefined.
333 If Destination is NULL, then ASSERT().
334 If Destination is not aligned on a 16-bit bounadary, then ASSERT().
335 If Source is NULL, then ASSERT().
336 If Source is not aligned on a 16-bit bounadary, then ASSERT().
337 If Source and Destination overlap, then ASSERT().
338 If PcdMaximumUnicodeStringLength is not zero, and Destination contains more
339 than PcdMaximumUnicodeStringLength Unicode characters not including the
340 Null-terminator, then ASSERT().
341 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
342 PcdMaximumUnicodeStringLength Unicode characters not including the
343 Null-terminator, then ASSERT().
344 If PcdMaximumUnicodeStringLength is not zero, and concatenating Destination
345 and Source results in a Unicode string with more than
346 PcdMaximumUnicodeStringLength Unicode characters not including the
347 Null-terminator, then ASSERT().
349 @param Destination Pointer to a Null-terminated Unicode string.
350 @param Source Pointer to a Null-terminated Unicode string.
358 IN OUT CHAR16
*Destination
,
359 IN CONST CHAR16
*Source
364 Concatenates one Null-terminated Unicode string with a maximum length to the
365 end of another Null-terminated Unicode string, and returns the concatenated
368 This function concatenates two Null-terminated Unicode strings. The contents
369 of Null-terminated Unicode string Source are concatenated to the end of
370 Null-terminated Unicode string Destination, and Destination is returned. At
371 most, Length Unicode characters are concatenated from Source to the end of
372 Destination, and Destination is always Null-terminated. If Length is 0, then
373 Destination is returned unmodified. If Source and Destination overlap, then
374 the results are undefined.
376 If Destination is NULL, then ASSERT().
377 If Length > 0 and Destination is not aligned on a 16-bit boundary, then ASSERT().
378 If Length > 0 and Source is NULL, then ASSERT().
379 If Length > 0 and Source is not aligned on a 16-bit boundary, then ASSERT().
380 If Source and Destination overlap, then ASSERT().
381 If PcdMaximumUnicodeStringLength is not zero, and Destination contains more
382 than PcdMaximumUnicodeStringLength Unicode characters not including the
383 Null-terminator, then ASSERT().
384 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
385 PcdMaximumUnicodeStringLength Unicode characters not including the
386 Null-terminator, then ASSERT().
387 If PcdMaximumUnicodeStringLength is not zero, and concatenating Destination
388 and Source results in a Unicode string with more than
389 PcdMaximumUnicodeStringLength Unicode characters not including the
390 Null-terminator, then ASSERT().
392 @param Destination Pointer to a Null-terminated Unicode string.
393 @param Source Pointer to a Null-terminated Unicode string.
394 @param Length Maximum number of Unicode characters to concatenate from
403 IN OUT CHAR16
*Destination
,
404 IN CONST CHAR16
*Source
,
409 Returns the first occurance of a Null-terminated Unicode sub-string
410 in a Null-terminated Unicode string.
412 This function scans the contents of the Null-terminated Unicode string
413 specified by String and returns the first occurrence of SearchString.
414 If SearchString is not found in String, then NULL is returned. If
415 the length of SearchString is zero, then String is
418 If String is NULL, then ASSERT().
419 If String is not aligned on a 16-bit boundary, then ASSERT().
420 If SearchString is NULL, then ASSERT().
421 If SearchString is not aligned on a 16-bit boundary, then ASSERT().
423 If PcdMaximumUnicodeStringLength is not zero, and SearchString
424 or String contains more than PcdMaximumUnicodeStringLength Unicode
425 characters not including the Null-terminator, then ASSERT().
427 @param String Pointer to a Null-terminated Unicode string.
428 @param SearchString Pointer to a Null-terminated Unicode string to search for.
430 @retval NULL If the SearchString does not appear in String.
431 @return others If there is a match.
437 IN CONST CHAR16
*String
,
438 IN CONST CHAR16
*SearchString
442 Convert a Null-terminated Unicode decimal string to a value of
445 This function returns a value of type UINTN by interpreting the contents
446 of the Unicode string specified by String as a decimal number. The format
447 of the input Unicode string String is:
449 [spaces] [decimal digits].
451 The valid decimal digit character is in the range [0-9]. The
452 function will ignore the pad space, which includes spaces or
453 tab characters, before [decimal digits]. The running zero in the
454 beginning of [decimal digits] will be ignored. Then, the function
455 stops at the first character that is a not a valid decimal character
456 or a Null-terminator, whichever one comes first.
458 If String is NULL, then ASSERT().
459 If String is not aligned in a 16-bit boundary, then ASSERT().
460 If String has only pad spaces, then 0 is returned.
461 If String has no pad spaces or valid decimal digits,
463 If the number represented by String overflows according
464 to the range defined by UINTN, then ASSERT().
466 If PcdMaximumUnicodeStringLength is not zero, and String contains
467 more than PcdMaximumUnicodeStringLength Unicode characters not including
468 the Null-terminator, then ASSERT().
470 @param String Pointer to a Null-terminated Unicode string.
472 @retval Value translated from String.
478 IN CONST CHAR16
*String
482 Convert a Null-terminated Unicode decimal string to a value of
485 This function returns a value of type UINT64 by interpreting the contents
486 of the Unicode string specified by String as a decimal number. The format
487 of the input Unicode string String is:
489 [spaces] [decimal digits].
491 The valid decimal digit character is in the range [0-9]. The
492 function will ignore the pad space, which includes spaces or
493 tab characters, before [decimal digits]. The running zero in the
494 beginning of [decimal digits] will be ignored. Then, the function
495 stops at the first character that is a not a valid decimal character
496 or a Null-terminator, whichever one comes first.
498 If String is NULL, then ASSERT().
499 If String is not aligned in a 16-bit boundary, then ASSERT().
500 If String has only pad spaces, then 0 is returned.
501 If String has no pad spaces or valid decimal digits,
503 If the number represented by String overflows according
504 to the range defined by UINT64, then ASSERT().
506 If PcdMaximumUnicodeStringLength is not zero, and String contains
507 more than PcdMaximumUnicodeStringLength Unicode characters not including
508 the Null-terminator, then ASSERT().
510 @param String Pointer to a Null-terminated Unicode string.
512 @retval Value translated from String.
518 IN CONST CHAR16
*String
523 Convert a Null-terminated Unicode hexadecimal string to a value of type UINTN.
525 This function returns a value of type UINTN by interpreting the contents
526 of the Unicode string specified by String as a hexadecimal number.
527 The format of the input Unicode string String is:
529 [spaces][zeros][x][hexadecimal digits].
531 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
532 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix.
533 If "x" appears in the input string, it must be prefixed with at least one 0.
534 The function will ignore the pad space, which includes spaces or tab characters,
535 before [zeros], [x] or [hexadecimal digit]. The running zero before [x] or
536 [hexadecimal digit] will be ignored. Then, the decoding starts after [x] or the
537 first valid hexadecimal digit. Then, the function stops at the first character that is
538 a not a valid hexadecimal character or NULL, whichever one comes first.
540 If String is NULL, then ASSERT().
541 If String is not aligned in a 16-bit boundary, then ASSERT().
542 If String has only pad spaces, then zero is returned.
543 If String has no leading pad spaces, leading zeros or valid hexadecimal digits,
544 then zero is returned.
545 If the number represented by String overflows according to the range defined by
546 UINTN, then ASSERT().
548 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
549 PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator,
552 @param String Pointer to a Null-terminated Unicode string.
554 @retval Value translated from String.
560 IN CONST CHAR16
*String
565 Convert a Null-terminated Unicode hexadecimal string to a value of type UINT64.
567 This function returns a value of type UINT64 by interpreting the contents
568 of the Unicode string specified by String as a hexadecimal number.
569 The format of the input Unicode string String is
571 [spaces][zeros][x][hexadecimal digits].
573 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
574 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix.
575 If "x" appears in the input string, it must be prefixed with at least one 0.
576 The function will ignore the pad space, which includes spaces or tab characters,
577 before [zeros], [x] or [hexadecimal digit]. The running zero before [x] or
578 [hexadecimal digit] will be ignored. Then, the decoding starts after [x] or the
579 first valid hexadecimal digit. Then, the function stops at the first character that is
580 a not a valid hexadecimal character or NULL, whichever one comes first.
582 If String is NULL, then ASSERT().
583 If String is not aligned in a 16-bit boundary, then ASSERT().
584 If String has only pad spaces, then zero is returned.
585 If String has no leading pad spaces, leading zeros or valid hexadecimal digits,
586 then zero is returned.
587 If the number represented by String overflows according to the range defined by
588 UINT64, then ASSERT().
590 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
591 PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator,
594 @param String Pointer to a Null-terminated Unicode string.
596 @retval Value translated from String.
602 IN CONST CHAR16
*String
606 Convert a nibble in the low 4 bits of a byte to a Unicode hexadecimal character.
608 This function converts a nibble in the low 4 bits of a byte to a Unicode hexadecimal
609 character For example, the nibble 0x01 and 0x0A will converted to L'1' and L'A'
612 The upper nibble in the input byte will be masked off.
614 @param Nibble The nibble which is in the low 4 bits of the input byte.
616 @retval CHAR16 The Unicode hexadecimal character.
626 Convert binary buffer to a Unicode String in a specified sequence.
628 This function converts bytes in the memory block pointed by Buffer to a Unicode String Str.
629 Each byte will be represented by two Unicode characters. For example, byte 0xA1 will
630 be converted into two Unicode character L'A' and L'1'. In the output String, the Unicode Character
631 for the Most Significant Nibble will be put before the Unicode Character for the Least Significant
632 Nibble. The output string for the buffer containing a single byte 0xA1 will be L"A1".
633 For a buffer with multiple bytes, the Unicode character produced by the first byte will be put into the
634 the last character in the output string. The one next to first byte will be put into the
635 character before the last character. This rules applies to the rest of the bytes. The Unicode
636 character by the last byte will be put into the first character in the output string. For example,
637 the input buffer for a 64-bits unsigned integrer 0x12345678abcdef1234 will be converted to
638 a Unicode string equal to L"12345678abcdef1234".
640 @param String On input, String is pointed to the buffer allocated for the convertion.
641 @param StringLen The Length of String buffer to hold the output String. The length must include the tailing '\0' character.
642 The StringLen required to convert a N bytes Buffer will be a least equal to or greater
644 @param Buffer The pointer to a input buffer.
645 @param BufferSizeInBytes Lenth in bytes of the input buffer.
648 @retval EFI_SUCCESS The convertion is successfull. All bytes in Buffer has been convert to the corresponding
649 Unicode character and placed into the right place in String.
650 @retval EFI_BUFFER_TOO_SMALL StringSizeInBytes is smaller than 2 * N + 1the number of bytes required to
651 complete the convertion.
656 IN OUT CHAR16
*String
,
657 IN OUT UINTN
*StringLen
,
658 IN CONST UINT8
*Buffer
,
659 IN UINTN BufferSizeInBytes
664 Convert a Unicode string consisting of hexadecimal characters to a output byte buffer.
666 This function converts a Unicode string consisting of characters in the range of Hexadecimal
667 character (L'0' to L'9', L'A' to L'F' and L'a' to L'f') to a output byte buffer. The function will stop
668 at the first non-hexadecimal character or the NULL character. The convertion process can be
669 simply viewed as the reverse operations defined by BufToHexString. Two Unicode characters will be
670 converted into one byte. The first Unicode character represents the Most Significant Nibble and the
671 second Unicode character represents the Least Significant Nibble in the output byte.
672 The first pair of Unicode characters represents the last byte in the output buffer. The second pair of Unicode
673 characters represent the the byte preceding the last byte. This rule applies to the rest pairs of bytes.
674 The last pair represent the first byte in the output buffer.
676 For example, a Unciode String L"12345678" will be converted into a buffer wil the following bytes
677 (first byte is the byte in the lowest memory address): "0x78, 0x56, 0x34, 0x12".
679 If String has N valid hexadecimal characters for conversion, the caller must make sure Buffer is at least
680 N/2 (if N is even) or (N+1)/2 (if N if odd) bytes.
682 @param Buffer The output buffer allocated by the caller.
683 @param BufferSizeInBytes On input, the size in bytes of Buffer. On output, it is updated to
684 contain the size of the Buffer which is actually used for the converstion.
685 For Unicode string with 2*N hexadecimal characters (not including the
686 tailing NULL character), N bytes of Buffer will be used for the output.
687 @param String The input hexadecimal string.
688 @param ConvertedStrLen The number of hexadecimal characters used to produce content in output
691 @retval RETURN_BUFFER_TOO_SMALL The input BufferSizeInBytes is too small to hold the output. BufferSizeInBytes
692 will be updated to the size required for the converstion.
693 @retval RETURN_SUCCESS The convertion is successful or the first Unicode character from String
694 is hexadecimal. If ConvertedStrLen is not NULL, it is updated
695 to the number of hexadecimal character used for the converstion.
701 IN OUT UINTN
*BufferSizeInBytes
,
702 IN CONST CHAR16
*String
,
703 OUT UINTN
*ConvertedStrLen OPTIONAL
708 Test if a Unicode character is a hexadecimal digit. If true, the input
709 Unicode character is converted to a byte.
711 This function tests if a Unicode character is a hexadecimal digit. If true, the input
712 Unicode character is converted to a byte. For example, Unicode character
713 L'A' will be converted to 0x0A.
715 If Digit is NULL, then ASSERT.
717 @param Digit The output hexadecimal digit.
719 @param Char The input Unicode character.
721 @retval TRUE Char is in the range of Hexadecimal number. Digit is updated
722 to the byte value of the number.
723 @retval FALSE Char is not in the range of Hexadecimal number. Digit is keep
735 Convert one Null-terminated Unicode string to a Null-terminated
736 ASCII string and returns the ASCII string.
738 This function converts the content of the Unicode string Source
739 to the ASCII string Destination by copying the lower 8 bits of
740 each Unicode character. It returns Destination.
742 If any Unicode characters in Source contain non-zero value in
743 the upper 8 bits, then ASSERT().
745 If Destination is NULL, then ASSERT().
746 If Source is NULL, then ASSERT().
747 If Source is not aligned on a 16-bit boundary, then ASSERT().
748 If Source and Destination overlap, then ASSERT().
750 If PcdMaximumUnicodeStringLength is not zero, and Source contains
751 more than PcdMaximumUnicodeStringLength Unicode characters not including
752 the Null-terminator, then ASSERT().
754 If PcdMaximumAsciiStringLength is not zero, and Source contains more
755 than PcdMaximumAsciiStringLength Unicode characters not including the
756 Null-terminator, then ASSERT().
758 @param Source Pointer to a Null-terminated Unicode string.
759 @param Destination Pointer to a Null-terminated ASCII string.
766 UnicodeStrToAsciiStr (
767 IN CONST CHAR16
*Source
,
768 OUT CHAR8
*Destination
773 Copies one Null-terminated ASCII string to another Null-terminated ASCII
774 string and returns the new ASCII string.
776 This function copies the contents of the ASCII string Source to the ASCII
777 string Destination, and returns Destination. If Source and Destination
778 overlap, then the results are undefined.
780 If Destination is NULL, then ASSERT().
781 If Source is NULL, then ASSERT().
782 If Source and Destination overlap, then ASSERT().
783 If PcdMaximumAsciiStringLength is not zero and Source contains more than
784 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
787 @param Destination Pointer to a Null-terminated ASCII string.
788 @param Source Pointer to a Null-terminated ASCII string.
796 OUT CHAR8
*Destination
,
797 IN CONST CHAR8
*Source
802 Copies one Null-terminated ASCII string with a maximum length to another
803 Null-terminated ASCII string with a maximum length and returns the new ASCII
806 This function copies the contents of the ASCII string Source to the ASCII
807 string Destination, and returns Destination. At most, Length ASCII characters
808 are copied from Source to Destination. If Length is 0, then Destination is
809 returned unmodified. If Length is greater that the number of ASCII characters
810 in Source, then Destination is padded with Null ASCII characters. If Source
811 and Destination overlap, then the results are undefined.
813 If Destination is NULL, then ASSERT().
814 If Source is NULL, then ASSERT().
815 If Source and Destination overlap, then ASSERT().
816 If PcdMaximumAsciiStringLength is not zero, and Source contains more than
817 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
820 @param Destination Pointer to a Null-terminated ASCII string.
821 @param Source Pointer to a Null-terminated ASCII string.
822 @param Length Maximum number of ASCII characters to copy.
830 OUT CHAR8
*Destination
,
831 IN CONST CHAR8
*Source
,
837 Returns the length of a Null-terminated ASCII string.
839 This function returns the number of ASCII characters in the Null-terminated
840 ASCII string specified by String.
842 If Length > 0 and Destination is NULL, then ASSERT().
843 If Length > 0 and Source is NULL, then ASSERT().
844 If PcdMaximumAsciiStringLength is not zero and String contains more than
845 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
848 @param String Pointer to a Null-terminated ASCII string.
850 @return The length of String.
856 IN CONST CHAR8
*String
861 Returns the size of a Null-terminated ASCII string in bytes, including the
864 This function returns the size, in bytes, of the Null-terminated ASCII string
867 If String is NULL, then ASSERT().
868 If PcdMaximumAsciiStringLength is not zero and String contains more than
869 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
872 @param String Pointer to a Null-terminated ASCII string.
874 @return The size of String.
880 IN CONST CHAR8
*String
885 Compares two Null-terminated ASCII strings, and returns the difference
886 between the first mismatched ASCII characters.
888 This function compares the Null-terminated ASCII string FirstString to the
889 Null-terminated ASCII string SecondString. If FirstString is identical to
890 SecondString, then 0 is returned. Otherwise, the value returned is the first
891 mismatched ASCII character in SecondString subtracted from the first
892 mismatched ASCII character in FirstString.
894 If FirstString is NULL, then ASSERT().
895 If SecondString is NULL, then ASSERT().
896 If PcdMaximumAsciiStringLength is not zero and FirstString contains more than
897 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
899 If PcdMaximumAsciiStringLength is not zero and SecondString contains more
900 than PcdMaximumAsciiStringLength ASCII characters not including the
901 Null-terminator, then ASSERT().
903 @param FirstString Pointer to a Null-terminated ASCII string.
904 @param SecondString Pointer to a Null-terminated ASCII string.
906 @retval 0 FirstString is identical to SecondString.
907 @return others FirstString is not identical to SecondString.
913 IN CONST CHAR8
*FirstString
,
914 IN CONST CHAR8
*SecondString
919 Performs a case insensitive comparison of two Null-terminated ASCII strings,
920 and returns the difference between the first mismatched ASCII characters.
922 This function performs a case insensitive comparison of the Null-terminated
923 ASCII string FirstString to the Null-terminated ASCII string SecondString. If
924 FirstString is identical to SecondString, then 0 is returned. Otherwise, the
925 value returned is the first mismatched lower case ASCII character in
926 SecondString subtracted from the first mismatched lower case ASCII character
929 If FirstString is NULL, then ASSERT().
930 If SecondString is NULL, then ASSERT().
931 If PcdMaximumAsciiStringLength is not zero and FirstString contains more than
932 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
934 If PcdMaximumAsciiStringLength is not zero and SecondString contains more
935 than PcdMaximumAsciiStringLength ASCII characters not including the
936 Null-terminator, then ASSERT().
938 @param FirstString Pointer to a Null-terminated ASCII string.
939 @param SecondString Pointer to a Null-terminated ASCII string.
941 @retval 0 FirstString is identical to SecondString using case insensitive
943 @return others FirstString is not identical to SecondString using case
944 insensitive comparisons.
950 IN CONST CHAR8
*FirstString
,
951 IN CONST CHAR8
*SecondString
956 Compares two Null-terminated ASCII strings with maximum lengths, and returns
957 the difference between the first mismatched ASCII characters.
959 This function compares the Null-terminated ASCII string FirstString to the
960 Null-terminated ASCII string SecondString. At most, Length ASCII characters
961 will be compared. If Length is 0, then 0 is returned. If FirstString is
962 identical to SecondString, then 0 is returned. Otherwise, the value returned
963 is the first mismatched ASCII character in SecondString subtracted from the
964 first mismatched ASCII character in FirstString.
966 If Length > 0 and FirstString is NULL, then ASSERT().
967 If Length > 0 and SecondString is NULL, then ASSERT().
968 If PcdMaximumAsciiStringLength is not zero and FirstString contains more than
969 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
971 If PcdMaximumAsciiStringLength is not zero and SecondString contains more than
972 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
975 @param FirstString Pointer to a Null-terminated ASCII string.
976 @param SecondString Pointer to a Null-terminated ASCII string.
977 @param Length Maximum number of ASCII characters for compare.
979 @retval 0 FirstString is identical to SecondString.
980 @return others FirstString is not identical to SecondString.
986 IN CONST CHAR8
*FirstString
,
987 IN CONST CHAR8
*SecondString
,
993 Concatenates one Null-terminated ASCII string to another Null-terminated
994 ASCII string, and returns the concatenated ASCII string.
996 This function concatenates two Null-terminated ASCII strings. The contents of
997 Null-terminated ASCII string Source are concatenated to the end of Null-
998 terminated ASCII string Destination. The Null-terminated concatenated ASCII
1001 If Destination is NULL, then ASSERT().
1002 If Source is NULL, then ASSERT().
1003 If PcdMaximumAsciiStringLength is not zero and Destination contains more than
1004 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
1006 If PcdMaximumAsciiStringLength is not zero and Source contains more than
1007 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
1009 If PcdMaximumAsciiStringLength is not zero and concatenating Destination and
1010 Source results in a ASCII string with more than PcdMaximumAsciiStringLength
1011 ASCII characters, then ASSERT().
1013 @param Destination Pointer to a Null-terminated ASCII string.
1014 @param Source Pointer to a Null-terminated ASCII string.
1022 IN OUT CHAR8
*Destination
,
1023 IN CONST CHAR8
*Source
1028 Concatenates one Null-terminated ASCII string with a maximum length to the
1029 end of another Null-terminated ASCII string, and returns the concatenated
1032 This function concatenates two Null-terminated ASCII strings. The contents
1033 of Null-terminated ASCII string Source are concatenated to the end of Null-
1034 terminated ASCII string Destination, and Destination is returned. At most,
1035 Length ASCII characters are concatenated from Source to the end of
1036 Destination, and Destination is always Null-terminated. If Length is 0, then
1037 Destination is returned unmodified. If Source and Destination overlap, then
1038 the results are undefined.
1040 If Length > 0 and Destination is NULL, then ASSERT().
1041 If Length > 0 and Source is NULL, then ASSERT().
1042 If Source and Destination overlap, then ASSERT().
1043 If PcdMaximumAsciiStringLength is not zero, and Destination contains more than
1044 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
1046 If PcdMaximumAsciiStringLength is not zero, and Source contains more than
1047 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
1049 If PcdMaximumAsciiStringLength is not zero, and concatenating Destination and
1050 Source results in a ASCII string with more than PcdMaximumAsciiStringLength
1051 ASCII characters not including the Null-terminator, then ASSERT().
1053 @param Destination Pointer to a Null-terminated ASCII string.
1054 @param Source Pointer to a Null-terminated ASCII string.
1055 @param Length Maximum number of ASCII characters to concatenate from
1064 IN OUT CHAR8
*Destination
,
1065 IN CONST CHAR8
*Source
,
1071 Returns the first occurance of a Null-terminated ASCII sub-string
1072 in a Null-terminated ASCII string.
1074 This function scans the contents of the ASCII string specified by String
1075 and returns the first occurrence of SearchString. If SearchString is not
1076 found in String, then NULL is returned. If the length of SearchString is zero,
1077 then String is returned.
1079 If String is NULL, then ASSERT().
1080 If SearchString is NULL, then ASSERT().
1082 If PcdMaximumAsciiStringLength is not zero, and SearchString or
1083 String contains more than PcdMaximumAsciiStringLength Unicode characters
1084 not including the Null-terminator, then ASSERT().
1086 @param String Pointer to a Null-terminated ASCII string.
1087 @param SearchString Pointer to a Null-terminated ASCII string to search for.
1089 @retval NULL If the SearchString does not appear in String.
1090 @return others If there is a match.
1096 IN CONST CHAR8
*String
,
1097 IN CONST CHAR8
*SearchString
1102 Convert a Null-terminated ASCII decimal string to a value of type
1105 This function returns a value of type UINTN by interpreting the contents
1106 of the ASCII string String as a decimal number. The format of the input
1107 ASCII string String is:
1109 [spaces] [decimal digits].
1111 The valid decimal digit character is in the range [0-9]. The function will
1112 ignore the pad space, which includes spaces or tab characters, before the digits.
1113 The running zero in the beginning of [decimal digits] will be ignored. Then, the
1114 function stops at the first character that is a not a valid decimal character or
1115 Null-terminator, whichever on comes first.
1117 If String has only pad spaces, then 0 is returned.
1118 If String has no pad spaces or valid decimal digits, then 0 is returned.
1119 If the number represented by String overflows according to the range defined by
1120 UINTN, then ASSERT().
1121 If String is NULL, then ASSERT().
1122 If PcdMaximumAsciiStringLength is not zero, and String contains more than
1123 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
1126 @param String Pointer to a Null-terminated ASCII string.
1128 @retval Value translated from String.
1133 AsciiStrDecimalToUintn (
1134 IN CONST CHAR8
*String
1139 Convert a Null-terminated ASCII decimal string to a value of type
1142 This function returns a value of type UINT64 by interpreting the contents
1143 of the ASCII string String as a decimal number. The format of the input
1144 ASCII string String is:
1146 [spaces] [decimal digits].
1148 The valid decimal digit character is in the range [0-9]. The function will
1149 ignore the pad space, which includes spaces or tab characters, before the digits.
1150 The running zero in the beginning of [decimal digits] will be ignored. Then, the
1151 function stops at the first character that is a not a valid decimal character or
1152 Null-terminator, whichever on comes first.
1154 If String has only pad spaces, then 0 is returned.
1155 If String has no pad spaces or valid decimal digits, then 0 is returned.
1156 If the number represented by String overflows according to the range defined by
1157 UINT64, then ASSERT().
1158 If String is NULL, then ASSERT().
1159 If PcdMaximumAsciiStringLength is not zero, and String contains more than
1160 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
1163 @param String Pointer to a Null-terminated ASCII string.
1165 @retval Value translated from String.
1170 AsciiStrDecimalToUint64 (
1171 IN CONST CHAR8
*String
1176 Convert a Null-terminated ASCII hexadecimal string to a value of type UINTN.
1178 This function returns a value of type UINTN by interpreting the contents of
1179 the ASCII string String as a hexadecimal number. The format of the input ASCII
1182 [spaces][zeros][x][hexadecimal digits].
1184 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
1185 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix. If "x"
1186 appears in the input string, it must be prefixed with at least one 0. The function
1187 will ignore the pad space, which includes spaces or tab characters, before [zeros],
1188 [x] or [hexadecimal digits]. The running zero before [x] or [hexadecimal digits]
1189 will be ignored. Then, the decoding starts after [x] or the first valid hexadecimal
1190 digit. Then, the function stops at the first character that is a not a valid
1191 hexadecimal character or Null-terminator, whichever on comes first.
1193 If String has only pad spaces, then 0 is returned.
1194 If String has no leading pad spaces, leading zeros or valid hexadecimal digits, then
1197 If the number represented by String overflows according to the range defined by UINTN,
1199 If String is NULL, then ASSERT().
1200 If PcdMaximumAsciiStringLength is not zero,
1201 and String contains more than PcdMaximumAsciiStringLength ASCII characters not including
1202 the Null-terminator, then ASSERT().
1204 @param String Pointer to a Null-terminated ASCII string.
1206 @retval Value translated from String.
1211 AsciiStrHexToUintn (
1212 IN CONST CHAR8
*String
1217 Convert a Null-terminated ASCII hexadecimal string to a value of type UINT64.
1219 This function returns a value of type UINT64 by interpreting the contents of
1220 the ASCII string String as a hexadecimal number. The format of the input ASCII
1223 [spaces][zeros][x][hexadecimal digits].
1225 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
1226 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix. If "x"
1227 appears in the input string, it must be prefixed with at least one 0. The function
1228 will ignore the pad space, which includes spaces or tab characters, before [zeros],
1229 [x] or [hexadecimal digits]. The running zero before [x] or [hexadecimal digits]
1230 will be ignored. Then, the decoding starts after [x] or the first valid hexadecimal
1231 digit. Then, the function stops at the first character that is a not a valid
1232 hexadecimal character or Null-terminator, whichever on comes first.
1234 If String has only pad spaces, then 0 is returned.
1235 If String has no leading pad spaces, leading zeros or valid hexadecimal digits, then
1238 If the number represented by String overflows according to the range defined by UINT64,
1240 If String is NULL, then ASSERT().
1241 If PcdMaximumAsciiStringLength is not zero,
1242 and String contains more than PcdMaximumAsciiStringLength ASCII characters not including
1243 the Null-terminator, then ASSERT().
1245 @param String Pointer to a Null-terminated ASCII string.
1247 @retval Value translated from String.
1252 AsciiStrHexToUint64 (
1253 IN CONST CHAR8
*String
1258 Convert one Null-terminated ASCII string to a Null-terminated
1259 Unicode string and returns the Unicode string.
1261 This function converts the contents of the ASCII string Source to the Unicode
1262 string Destination, and returns Destination. The function terminates the
1263 Unicode string Destination by appending a Null-terminator character at the end.
1264 The caller is responsible to make sure Destination points to a buffer with size
1265 equal or greater than ((AsciiStrLen (Source) + 1) * sizeof (CHAR16)) in bytes.
1267 If Destination is NULL, then ASSERT().
1268 If Destination is not aligned on a 16-bit boundary, then ASSERT().
1269 If Source is NULL, then ASSERT().
1270 If Source and Destination overlap, then ASSERT().
1271 If PcdMaximumAsciiStringLength is not zero, and Source contains more than
1272 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
1274 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
1275 PcdMaximumUnicodeStringLength ASCII characters not including the
1276 Null-terminator, then ASSERT().
1278 @param Source Pointer to a Null-terminated ASCII string.
1279 @param Destination Pointer to a Null-terminated Unicode string.
1286 AsciiStrToUnicodeStr (
1287 IN CONST CHAR8
*Source
,
1288 OUT CHAR16
*Destination
1293 Converts an 8-bit value to an 8-bit BCD value.
1295 Converts the 8-bit value specified by Value to BCD. The BCD value is
1298 If Value >= 100, then ASSERT().
1300 @param Value The 8-bit value to convert to BCD. Range 0..99.
1302 @return The BCD value
1313 Converts an 8-bit BCD value to an 8-bit value.
1315 Converts the 8-bit BCD value specified by Value to an 8-bit value. The 8-bit
1318 If Value >= 0xA0, then ASSERT().
1319 If (Value & 0x0F) >= 0x0A, then ASSERT().
1321 @param Value The 8-bit BCD value to convert to an 8-bit value.
1323 @return The 8-bit value is returned.
1334 // Linked List Functions and Macros
1338 Initializes the head node of a doubly linked list that is declared as a
1339 global variable in a module.
1341 Initializes the forward and backward links of a new linked list. After
1342 initializing a linked list with this macro, the other linked list functions
1343 may be used to add and remove nodes from the linked list. This macro results
1344 in smaller executables by initializing the linked list in the data section,
1345 instead if calling the InitializeListHead() function to perform the
1346 equivalent operation.
1348 @param ListHead The head note of a list to initiailize.
1351 #define INITIALIZE_LIST_HEAD_VARIABLE(ListHead) {&ListHead, &ListHead}
1355 Initializes the head node of a doubly linked list, and returns the pointer to
1356 the head node of the doubly linked list.
1358 Initializes the forward and backward links of a new linked list. After
1359 initializing a linked list with this function, the other linked list
1360 functions may be used to add and remove nodes from the linked list. It is up
1361 to the caller of this function to allocate the memory for ListHead.
1363 If ListHead is NULL, then ASSERT().
1365 @param ListHead A pointer to the head node of a new doubly linked list.
1372 InitializeListHead (
1373 IN LIST_ENTRY
*ListHead
1378 Adds a node to the beginning of a doubly linked list, and returns the pointer
1379 to the head node of the doubly linked list.
1381 Adds the node Entry at the beginning of the doubly linked list denoted by
1382 ListHead, and returns ListHead.
1384 If ListHead is NULL, then ASSERT().
1385 If Entry is NULL, then ASSERT().
1386 If ListHead was not initialized with InitializeListHead(), then ASSERT().
1387 If PcdMaximumLinkedListLenth is not zero, and prior to insertion the number
1388 of nodes in ListHead, including the ListHead node, is greater than or
1389 equal to PcdMaximumLinkedListLength, then ASSERT().
1391 @param ListHead A pointer to the head node of a doubly linked list.
1392 @param Entry A pointer to a node that is to be inserted at the beginning
1393 of a doubly linked list.
1401 IN LIST_ENTRY
*ListHead
,
1402 IN LIST_ENTRY
*Entry
1407 Adds a node to the end of a doubly linked list, and returns the pointer to
1408 the head node of the doubly linked list.
1410 Adds the node Entry to the end of the doubly linked list denoted by ListHead,
1411 and returns ListHead.
1413 If ListHead is NULL, then ASSERT().
1414 If Entry is NULL, then ASSERT().
1415 If ListHead was not initialized with InitializeListHead(), then ASSERT().
1416 If PcdMaximumLinkedListLenth is not zero, and prior to insertion the number
1417 of nodes in ListHead, including the ListHead node, is greater than or
1418 equal to PcdMaximumLinkedListLength, then ASSERT().
1420 @param ListHead A pointer to the head node of a doubly linked list.
1421 @param Entry A pointer to a node that is to be added at the end of the
1430 IN LIST_ENTRY
*ListHead
,
1431 IN LIST_ENTRY
*Entry
1436 Retrieves the first node of a doubly linked list.
1438 Returns the first node of a doubly linked list. List must have been
1439 initialized with InitializeListHead(). If List is empty, then NULL is
1442 If List is NULL, then ASSERT().
1443 If List was not initialized with InitializeListHead(), then ASSERT().
1444 If PcdMaximumLinkedListLenth is not zero, and the number of nodes
1445 in List, including the List node, is greater than or equal to
1446 PcdMaximumLinkedListLength, then ASSERT().
1448 @param List A pointer to the head node of a doubly linked list.
1450 @return The first node of a doubly linked list.
1451 @retval NULL The list is empty.
1457 IN CONST LIST_ENTRY
*List
1462 Retrieves the next node of a doubly linked list.
1464 Returns the node of a doubly linked list that follows Node. List must have
1465 been initialized with InitializeListHead(). If List is empty, then List is
1468 If List is NULL, then ASSERT().
1469 If Node is NULL, then ASSERT().
1470 If List was not initialized with InitializeListHead(), then ASSERT().
1471 If PcdMaximumLinkedListLenth is not zero, and List contains more than
1472 PcdMaximumLinkedListLenth nodes, then ASSERT().
1473 If Node is not a node in List, then ASSERT().
1475 @param List A pointer to the head node of a doubly linked list.
1476 @param Node A pointer to a node in the doubly linked list.
1478 @return Pointer to the next node if one exists. Otherwise a null value which
1479 is actually List is returned.
1485 IN CONST LIST_ENTRY
*List
,
1486 IN CONST LIST_ENTRY
*Node
1491 Checks to see if a doubly linked list is empty or not.
1493 Checks to see if the doubly linked list is empty. If the linked list contains
1494 zero nodes, this function returns TRUE. Otherwise, it returns FALSE.
1496 If ListHead is NULL, then ASSERT().
1497 If ListHead was not initialized with InitializeListHead(), then ASSERT().
1498 If PcdMaximumLinkedListLenth is not zero, and the number of nodes
1499 in List, including the List node, is greater than or equal to
1500 PcdMaximumLinkedListLength, then ASSERT().
1502 @param ListHead A pointer to the head node of a doubly linked list.
1504 @retval TRUE The linked list is empty.
1505 @retval FALSE The linked list is not empty.
1511 IN CONST LIST_ENTRY
*ListHead
1516 Determines if a node in a doubly linked list is null.
1518 Returns FALSE if Node is one of the nodes in the doubly linked list specified
1519 by List. Otherwise, TRUE is returned. List must have been initialized with
1520 InitializeListHead().
1522 If List is NULL, then ASSERT().
1523 If Node is NULL, then ASSERT().
1524 If List was not initialized with InitializeListHead(), then ASSERT().
1525 If PcdMaximumLinkedListLenth is not zero, and the number of nodes
1526 in List, including the List node, is greater than or equal to
1527 PcdMaximumLinkedListLength, then ASSERT().
1528 If Node is not a node in List and Node is not equal to List, then ASSERT().
1530 @param List A pointer to the head node of a doubly linked list.
1531 @param Node A pointer to a node in the doubly linked list.
1533 @retval TRUE Node is one of the nodes in the doubly linked list.
1534 @retval FALSE Node is not one of the nodes in the doubly linked list.
1540 IN CONST LIST_ENTRY
*List
,
1541 IN CONST LIST_ENTRY
*Node
1546 Determines if a node the last node in a doubly linked list.
1548 Returns TRUE if Node is the last node in the doubly linked list specified by
1549 List. Otherwise, FALSE is returned. List must have been initialized with
1550 InitializeListHead().
1552 If List is NULL, then ASSERT().
1553 If Node is NULL, then ASSERT().
1554 If List was not initialized with InitializeListHead(), then ASSERT().
1555 If PcdMaximumLinkedListLenth is not zero, and the number of nodes
1556 in List, including the List node, is greater than or equal to
1557 PcdMaximumLinkedListLength, then ASSERT().
1558 If Node is not a node in List, then ASSERT().
1560 @param List A pointer to the head node of a doubly linked list.
1561 @param Node A pointer to a node in the doubly linked list.
1563 @retval TRUE Node is the last node in the linked list.
1564 @retval FALSE Node is not the last node in the linked list.
1570 IN CONST LIST_ENTRY
*List
,
1571 IN CONST LIST_ENTRY
*Node
1576 Swaps the location of two nodes in a doubly linked list, and returns the
1577 first node after the swap.
1579 If FirstEntry is identical to SecondEntry, then SecondEntry is returned.
1580 Otherwise, the location of the FirstEntry node is swapped with the location
1581 of the SecondEntry node in a doubly linked list. SecondEntry must be in the
1582 same double linked list as FirstEntry and that double linked list must have
1583 been initialized with InitializeListHead(). SecondEntry is returned after the
1586 If FirstEntry is NULL, then ASSERT().
1587 If SecondEntry is NULL, then ASSERT().
1588 If SecondEntry and FirstEntry are not in the same linked list, then ASSERT().
1589 If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
1590 linked list containing the FirstEntry and SecondEntry nodes, including
1591 the FirstEntry and SecondEntry nodes, is greater than or equal to
1592 PcdMaximumLinkedListLength, then ASSERT().
1594 @param FirstEntry A pointer to a node in a linked list.
1595 @param SecondEntry A pointer to another node in the same linked list.
1603 IN LIST_ENTRY
*FirstEntry
,
1604 IN LIST_ENTRY
*SecondEntry
1609 Removes a node from a doubly linked list, and returns the node that follows
1612 Removes the node Entry from a doubly linked list. It is up to the caller of
1613 this function to release the memory used by this node if that is required. On
1614 exit, the node following Entry in the doubly linked list is returned. If
1615 Entry is the only node in the linked list, then the head node of the linked
1618 If Entry is NULL, then ASSERT().
1619 If Entry is the head node of an empty list, then ASSERT().
1620 If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
1621 linked list containing Entry, including the Entry node, is greater than
1622 or equal to PcdMaximumLinkedListLength, then ASSERT().
1624 @param Entry A pointer to a node in a linked list
1632 IN CONST LIST_ENTRY
*Entry
1640 Shifts a 64-bit integer left between 0 and 63 bits. The low bits are filled
1641 with zeros. The shifted value is returned.
1643 This function shifts the 64-bit value Operand to the left by Count bits. The
1644 low Count bits are set to zero. The shifted value is returned.
1646 If Count is greater than 63, then ASSERT().
1648 @param Operand The 64-bit operand to shift left.
1649 @param Count The number of bits to shift left.
1651 @return Operand << Count
1663 Shifts a 64-bit integer right between 0 and 63 bits. This high bits are
1664 filled with zeros. The shifted value is returned.
1666 This function shifts the 64-bit value Operand to the right by Count bits. The
1667 high Count bits are set to zero. The shifted value is returned.
1669 If Count is greater than 63, then ASSERT().
1671 @param Operand The 64-bit operand to shift right.
1672 @param Count The number of bits to shift right.
1674 @return Operand >> Count
1686 Shifts a 64-bit integer right between 0 and 63 bits. The high bits are filled
1687 with original integer's bit 63. The shifted value is returned.
1689 This function shifts the 64-bit value Operand to the right by Count bits. The
1690 high Count bits are set to bit 63 of Operand. The shifted value is returned.
1692 If Count is greater than 63, then ASSERT().
1694 @param Operand The 64-bit operand to shift right.
1695 @param Count The number of bits to shift right.
1697 @return Operand >> Count
1709 Rotates a 32-bit integer left between 0 and 31 bits, filling the low bits
1710 with the high bits that were rotated.
1712 This function rotates the 32-bit value Operand to the left by Count bits. The
1713 low Count bits are fill with the high Count bits of Operand. The rotated
1716 If Count is greater than 31, then ASSERT().
1718 @param Operand The 32-bit operand to rotate left.
1719 @param Count The number of bits to rotate left.
1721 @return Operand <<< Count
1733 Rotates a 32-bit integer right between 0 and 31 bits, filling the high bits
1734 with the low bits that were rotated.
1736 This function rotates the 32-bit value Operand to the right by Count bits.
1737 The high Count bits are fill with the low Count bits of Operand. The rotated
1740 If Count is greater than 31, then ASSERT().
1742 @param Operand The 32-bit operand to rotate right.
1743 @param Count The number of bits to rotate right.
1745 @return Operand >>> Count
1757 Rotates a 64-bit integer left between 0 and 63 bits, filling the low bits
1758 with the high bits that were rotated.
1760 This function rotates the 64-bit value Operand to the left by Count bits. The
1761 low Count bits are fill with the high Count bits of Operand. The rotated
1764 If Count is greater than 63, then ASSERT().
1766 @param Operand The 64-bit operand to rotate left.
1767 @param Count The number of bits to rotate left.
1769 @return Operand <<< Count
1781 Rotates a 64-bit integer right between 0 and 63 bits, filling the high bits
1782 with the high low bits that were rotated.
1784 This function rotates the 64-bit value Operand to the right by Count bits.
1785 The high Count bits are fill with the low Count bits of Operand. The rotated
1788 If Count is greater than 63, then ASSERT().
1790 @param Operand The 64-bit operand to rotate right.
1791 @param Count The number of bits to rotate right.
1793 @return Operand >>> Count
1805 Returns the bit position of the lowest bit set in a 32-bit value.
1807 This function computes the bit position of the lowest bit set in the 32-bit
1808 value specified by Operand. If Operand is zero, then -1 is returned.
1809 Otherwise, a value between 0 and 31 is returned.
1811 @param Operand The 32-bit operand to evaluate.
1813 @return Position of the lowest bit set in Operand if found.
1814 @retval -1 Operand is zero.
1825 Returns the bit position of the lowest bit set in a 64-bit value.
1827 This function computes the bit position of the lowest bit set in the 64-bit
1828 value specified by Operand. If Operand is zero, then -1 is returned.
1829 Otherwise, a value between 0 and 63 is returned.
1831 @param Operand The 64-bit operand to evaluate.
1833 @return Position of the lowest bit set in Operand if found.
1834 @retval -1 Operand is zero.
1845 Returns the bit position of the highest bit set in a 32-bit value. Equivalent
1848 This function computes the bit position of the highest bit set in the 32-bit
1849 value specified by Operand. If Operand is zero, then -1 is returned.
1850 Otherwise, a value between 0 and 31 is returned.
1852 @param Operand The 32-bit operand to evaluate.
1854 @return Position of the highest bit set in Operand if found.
1855 @retval -1 Operand is zero.
1866 Returns the bit position of the highest bit set in a 64-bit value. Equivalent
1869 This function computes the bit position of the highest bit set in the 64-bit
1870 value specified by Operand. If Operand is zero, then -1 is returned.
1871 Otherwise, a value between 0 and 63 is returned.
1873 @param Operand The 64-bit operand to evaluate.
1875 @return Position of the highest bit set in Operand if found.
1876 @retval -1 Operand is zero.
1887 Returns the value of the highest bit set in a 32-bit value. Equivalent to
1888 1 << HighBitSet32(x).
1890 This function computes the value of the highest bit set in the 32-bit value
1891 specified by Operand. If Operand is zero, then zero is returned.
1893 @param Operand The 32-bit operand to evaluate.
1895 @return 1 << HighBitSet32(Operand)
1896 @retval 0 Operand is zero.
1907 Returns the value of the highest bit set in a 64-bit value. Equivalent to
1908 1 << HighBitSet64(x).
1910 This function computes the value of the highest bit set in the 64-bit value
1911 specified by Operand. If Operand is zero, then zero is returned.
1913 @param Operand The 64-bit operand to evaluate.
1915 @return 1 << HighBitSet64(Operand)
1916 @retval 0 Operand is zero.
1927 Switches the endianess of a 16-bit integer.
1929 This function swaps the bytes in a 16-bit unsigned value to switch the value
1930 from little endian to big endian or vice versa. The byte swapped value is
1933 @param Value Operand A 16-bit unsigned value.
1935 @return The byte swaped Operand.
1946 Switches the endianess of a 32-bit integer.
1948 This function swaps the bytes in a 32-bit unsigned value to switch the value
1949 from little endian to big endian or vice versa. The byte swapped value is
1952 @param Value Operand A 32-bit unsigned value.
1954 @return The byte swaped Operand.
1965 Switches the endianess of a 64-bit integer.
1967 This function swaps the bytes in a 64-bit unsigned value to switch the value
1968 from little endian to big endian or vice versa. The byte swapped value is
1971 @param Value Operand A 64-bit unsigned value.
1973 @return The byte swaped Operand.
1984 Multiples a 64-bit unsigned integer by a 32-bit unsigned integer and
1985 generates a 64-bit unsigned result.
1987 This function multiples the 64-bit unsigned value Multiplicand by the 32-bit
1988 unsigned value Multiplier and generates a 64-bit unsigned result. This 64-
1989 bit unsigned result is returned.
1991 If the result overflows, then ASSERT().
1993 @param Multiplicand A 64-bit unsigned value.
1994 @param Multiplier A 32-bit unsigned value.
1996 @return Multiplicand * Multiplier
2002 IN UINT64 Multiplicand
,
2003 IN UINT32 Multiplier
2008 Multiples a 64-bit unsigned integer by a 64-bit unsigned integer and
2009 generates a 64-bit unsigned result.
2011 This function multiples the 64-bit unsigned value Multiplicand by the 64-bit
2012 unsigned value Multiplier and generates a 64-bit unsigned result. This 64-
2013 bit unsigned result is returned.
2015 If the result overflows, then ASSERT().
2017 @param Multiplicand A 64-bit unsigned value.
2018 @param Multiplier A 64-bit unsigned value.
2020 @return Multiplicand * Multiplier
2026 IN UINT64 Multiplicand
,
2027 IN UINT64 Multiplier
2032 Multiples a 64-bit signed integer by a 64-bit signed integer and generates a
2033 64-bit signed result.
2035 This function multiples the 64-bit signed value Multiplicand by the 64-bit
2036 signed value Multiplier and generates a 64-bit signed result. This 64-bit
2037 signed result is returned.
2039 If the result overflows, then ASSERT().
2041 @param Multiplicand A 64-bit signed value.
2042 @param Multiplier A 64-bit signed value.
2044 @return Multiplicand * Multiplier
2050 IN INT64 Multiplicand
,
2056 Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates
2057 a 64-bit unsigned result.
2059 This function divides the 64-bit unsigned value Dividend by the 32-bit
2060 unsigned value Divisor and generates a 64-bit unsigned quotient. This
2061 function returns the 64-bit unsigned quotient.
2063 If Divisor is 0, then ASSERT().
2065 @param Dividend A 64-bit unsigned value.
2066 @param Divisor A 32-bit unsigned value.
2068 @return Dividend / Divisor
2080 Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates
2081 a 32-bit unsigned remainder.
2083 This function divides the 64-bit unsigned value Dividend by the 32-bit
2084 unsigned value Divisor and generates a 32-bit remainder. This function
2085 returns the 32-bit unsigned remainder.
2087 If Divisor is 0, then ASSERT().
2089 @param Dividend A 64-bit unsigned value.
2090 @param Divisor A 32-bit unsigned value.
2092 @return Dividend % Divisor
2104 Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates
2105 a 64-bit unsigned result and an optional 32-bit unsigned remainder.
2107 This function divides the 64-bit unsigned value Dividend by the 32-bit
2108 unsigned value Divisor and generates a 64-bit unsigned quotient. If Remainder
2109 is not NULL, then the 32-bit unsigned remainder is returned in Remainder.
2110 This function returns the 64-bit unsigned quotient.
2112 If Divisor is 0, then ASSERT().
2114 @param Dividend A 64-bit unsigned value.
2115 @param Divisor A 32-bit unsigned value.
2116 @param Remainder A pointer to a 32-bit unsigned value. This parameter is
2117 optional and may be NULL.
2119 @return Dividend / Divisor
2124 DivU64x32Remainder (
2127 OUT UINT32
*Remainder OPTIONAL
2132 Divides a 64-bit unsigned integer by a 64-bit unsigned integer and generates
2133 a 64-bit unsigned result and an optional 64-bit unsigned remainder.
2135 This function divides the 64-bit unsigned value Dividend by the 64-bit
2136 unsigned value Divisor and generates a 64-bit unsigned quotient. If Remainder
2137 is not NULL, then the 64-bit unsigned remainder is returned in Remainder.
2138 This function returns the 64-bit unsigned quotient.
2140 If Divisor is 0, then ASSERT().
2142 @param Dividend A 64-bit unsigned value.
2143 @param Divisor A 64-bit unsigned value.
2144 @param Remainder A pointer to a 64-bit unsigned value. This parameter is
2145 optional and may be NULL.
2147 @return Dividend / Divisor
2152 DivU64x64Remainder (
2155 OUT UINT64
*Remainder OPTIONAL
2160 Divides a 64-bit signed integer by a 64-bit signed integer and generates a
2161 64-bit signed result and a optional 64-bit signed remainder.
2163 This function divides the 64-bit signed value Dividend by the 64-bit signed
2164 value Divisor and generates a 64-bit signed quotient. If Remainder is not
2165 NULL, then the 64-bit signed remainder is returned in Remainder. This
2166 function returns the 64-bit signed quotient.
2168 If Divisor is 0, then ASSERT().
2170 @param Dividend A 64-bit signed value.
2171 @param Divisor A 64-bit signed value.
2172 @param Remainder A pointer to a 64-bit signed value. This parameter is
2173 optional and may be NULL.
2175 @return Dividend / Divisor
2180 DivS64x64Remainder (
2183 OUT INT64
*Remainder OPTIONAL
2188 Reads a 16-bit value from memory that may be unaligned.
2190 This function returns the 16-bit value pointed to by Buffer. The function
2191 guarantees that the read operation does not produce an alignment fault.
2193 If the Buffer is NULL, then ASSERT().
2195 @param Uint16 Pointer to a 16-bit value that may be unaligned.
2203 IN CONST UINT16
*Uint16
2208 Writes a 16-bit value to memory that may be unaligned.
2210 This function writes the 16-bit value specified by Value to Buffer. Value is
2211 returned. The function guarantees that the write operation does not produce
2214 If the Buffer is NULL, then ASSERT().
2216 @param Uint16 Pointer to a 16-bit value that may be unaligned.
2217 @param Value 16-bit value to write to Buffer.
2231 Reads a 24-bit value from memory that may be unaligned.
2233 This function returns the 24-bit value pointed to by Buffer. The function
2234 guarantees that the read operation does not produce an alignment fault.
2236 If the Buffer is NULL, then ASSERT().
2238 @param Buffer Pointer to a 24-bit value that may be unaligned.
2240 @return The value read from Buffer.
2246 IN CONST UINT32
*Buffer
2251 Writes a 24-bit value to memory that may be unaligned.
2253 This function writes the 24-bit value specified by Value to Buffer. Value is
2254 returned. The function guarantees that the write operation does not produce
2257 If the Buffer is NULL, then ASSERT().
2259 @param Buffer Pointer to a 24-bit value that may be unaligned.
2260 @param Value 24-bit value to write to Buffer.
2262 @return The value written to Buffer.
2274 Reads a 32-bit value from memory that may be unaligned.
2276 This function returns the 32-bit value pointed to by Buffer. The function
2277 guarantees that the read operation does not produce an alignment fault.
2279 If the Buffer is NULL, then ASSERT().
2281 @param Uint32 Pointer to a 32-bit value that may be unaligned.
2283 @return Value read from Uint32
2289 IN CONST UINT32
*Uint32
2294 Writes a 32-bit value to memory that may be unaligned.
2296 This function writes the 32-bit value specified by Value to Buffer. Value is
2297 returned. The function guarantees that the write operation does not produce
2300 If the Buffer is NULL, then ASSERT().
2302 @param Uint32 Pointer to a 32-bit value that may be unaligned.
2303 @param Value 32-bit value to write to Buffer.
2305 @return Value written to Uint32.
2317 Reads a 64-bit value from memory that may be unaligned.
2319 This function returns the 64-bit value pointed to by Buffer. The function
2320 guarantees that the read operation does not produce an alignment fault.
2322 If the Buffer is NULL, then ASSERT().
2324 @param Uint64 Pointer to a 64-bit value that may be unaligned.
2326 @return Value read from Uint64.
2332 IN CONST UINT64
*Uint64
2337 Writes a 64-bit value to memory that may be unaligned.
2339 This function writes the 64-bit value specified by Value to Buffer. Value is
2340 returned. The function guarantees that the write operation does not produce
2343 If the Buffer is NULL, then ASSERT().
2345 @param Uint64 Pointer to a 64-bit value that may be unaligned.
2346 @param Value 64-bit value to write to Buffer.
2348 @return Value written to Uint64.
2360 // Bit Field Functions
2364 Returns a bit field from an 8-bit value.
2366 Returns the bitfield specified by the StartBit and the EndBit from Operand.
2368 If 8-bit operations are not supported, then ASSERT().
2369 If StartBit is greater than 7, then ASSERT().
2370 If EndBit is greater than 7, then ASSERT().
2371 If EndBit is less than StartBit, then ASSERT().
2373 @param Operand Operand on which to perform the bitfield operation.
2374 @param StartBit The ordinal of the least significant bit in the bit field.
2376 @param EndBit The ordinal of the most significant bit in the bit field.
2379 @return The bit field read.
2392 Writes a bit field to an 8-bit value, and returns the result.
2394 Writes Value to the bit field specified by the StartBit and the EndBit in
2395 Operand. All other bits in Operand are preserved. The new 8-bit value is
2398 If 8-bit operations are not supported, then ASSERT().
2399 If StartBit is greater than 7, then ASSERT().
2400 If EndBit is greater than 7, then ASSERT().
2401 If EndBit is less than StartBit, then ASSERT().
2403 @param Operand Operand on which to perform the bitfield operation.
2404 @param StartBit The ordinal of the least significant bit in the bit field.
2406 @param EndBit The ordinal of the most significant bit in the bit field.
2408 @param Value New value of the bit field.
2410 @return The new 8-bit value.
2424 Reads a bit field from an 8-bit value, performs a bitwise OR, and returns the
2427 Performs a bitwise inclusive OR between the bit field specified by StartBit
2428 and EndBit in Operand and the value specified by OrData. All other bits in
2429 Operand are preserved. The new 8-bit value is returned.
2431 If 8-bit operations are not supported, then ASSERT().
2432 If StartBit is greater than 7, then ASSERT().
2433 If EndBit is greater than 7, then ASSERT().
2434 If EndBit is less than StartBit, then ASSERT().
2436 @param Operand Operand on which to perform the bitfield operation.
2437 @param StartBit The ordinal of the least significant bit in the bit field.
2439 @param EndBit The ordinal of the most significant bit in the bit field.
2441 @param OrData The value to OR with the read value from the value
2443 @return The new 8-bit value.
2457 Reads a bit field from an 8-bit value, performs a bitwise AND, and returns
2460 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2461 in Operand and the value specified by AndData. All other bits in Operand are
2462 preserved. The new 8-bit value is returned.
2464 If 8-bit operations are not supported, then ASSERT().
2465 If StartBit is greater than 7, then ASSERT().
2466 If EndBit is greater than 7, then ASSERT().
2467 If EndBit is less than StartBit, then ASSERT().
2469 @param Operand Operand on which to perform the bitfield operation.
2470 @param StartBit The ordinal of the least significant bit in the bit field.
2472 @param EndBit The ordinal of the most significant bit in the bit field.
2474 @param AndData The value to AND with the read value from the value.
2476 @return The new 8-bit value.
2490 Reads a bit field from an 8-bit value, performs a bitwise AND followed by a
2491 bitwise OR, and returns the result.
2493 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2494 in Operand and the value specified by AndData, followed by a bitwise
2495 inclusive OR with value specified by OrData. All other bits in Operand are
2496 preserved. The new 8-bit value is returned.
2498 If 8-bit operations are not supported, then ASSERT().
2499 If StartBit is greater than 7, then ASSERT().
2500 If EndBit is greater than 7, 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.
2509 @param OrData The value to OR with the result of the AND operation.
2511 @return The new 8-bit value.
2516 BitFieldAndThenOr8 (
2526 Returns a bit field from a 16-bit value.
2528 Returns the bitfield specified by the StartBit and the EndBit from Operand.
2530 If 16-bit operations are not supported, then ASSERT().
2531 If StartBit is greater than 15, then ASSERT().
2532 If EndBit is greater than 15, then ASSERT().
2533 If EndBit is less than StartBit, then ASSERT().
2535 @param Operand Operand on which to perform the bitfield operation.
2536 @param StartBit The ordinal of the least significant bit in the bit field.
2538 @param EndBit The ordinal of the most significant bit in the bit field.
2541 @return The bit field read.
2554 Writes a bit field to a 16-bit value, and returns the result.
2556 Writes Value to the bit field specified by the StartBit and the EndBit in
2557 Operand. All other bits in Operand are preserved. The new 16-bit value is
2560 If 16-bit operations are not supported, then ASSERT().
2561 If StartBit is greater than 15, then ASSERT().
2562 If EndBit is greater than 15, then ASSERT().
2563 If EndBit is less than StartBit, then ASSERT().
2565 @param Operand Operand on which to perform the bitfield operation.
2566 @param StartBit The ordinal of the least significant bit in the bit field.
2568 @param EndBit The ordinal of the most significant bit in the bit field.
2570 @param Value New value of the bit field.
2572 @return The new 16-bit value.
2586 Reads a bit field from a 16-bit value, performs a bitwise OR, and returns the
2589 Performs a bitwise inclusive OR between the bit field specified by StartBit
2590 and EndBit in Operand and the value specified by OrData. All other bits in
2591 Operand are preserved. The new 16-bit value is returned.
2593 If 16-bit operations are not supported, then ASSERT().
2594 If StartBit is greater than 15, then ASSERT().
2595 If EndBit is greater than 15, then ASSERT().
2596 If EndBit is less than StartBit, then ASSERT().
2598 @param Operand Operand on which to perform the bitfield operation.
2599 @param StartBit The ordinal of the least significant bit in the bit field.
2601 @param EndBit The ordinal of the most significant bit in the bit field.
2603 @param OrData The value to OR with the read value from the value
2605 @return The new 16-bit value.
2619 Reads a bit field from a 16-bit value, performs a bitwise AND, and returns
2622 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2623 in Operand and the value specified by AndData. All other bits in Operand are
2624 preserved. The new 16-bit value is returned.
2626 If 16-bit operations are not supported, then ASSERT().
2627 If StartBit is greater than 15, then ASSERT().
2628 If EndBit is greater than 15, then ASSERT().
2629 If EndBit is less than StartBit, then ASSERT().
2631 @param Operand Operand on which to perform the bitfield operation.
2632 @param StartBit The ordinal of the least significant bit in the bit field.
2634 @param EndBit The ordinal of the most significant bit in the bit field.
2636 @param AndData The value to AND with the read value from the value
2638 @return The new 16-bit value.
2652 Reads a bit field from a 16-bit value, performs a bitwise AND followed by a
2653 bitwise OR, and returns the result.
2655 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2656 in Operand and the value specified by AndData, followed by a bitwise
2657 inclusive OR with value specified by OrData. All other bits in Operand are
2658 preserved. The new 16-bit value is returned.
2660 If 16-bit operations are not supported, then ASSERT().
2661 If StartBit is greater than 15, then ASSERT().
2662 If EndBit is greater than 15, 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.
2671 @param OrData The value to OR with the result of the AND operation.
2673 @return The new 16-bit value.
2678 BitFieldAndThenOr16 (
2688 Returns a bit field from a 32-bit value.
2690 Returns the bitfield specified by the StartBit and the EndBit from Operand.
2692 If 32-bit operations are not supported, then ASSERT().
2693 If StartBit is greater than 31, then ASSERT().
2694 If EndBit is greater than 31, then ASSERT().
2695 If EndBit is less than StartBit, then ASSERT().
2697 @param Operand Operand on which to perform the bitfield operation.
2698 @param StartBit The ordinal of the least significant bit in the bit field.
2700 @param EndBit The ordinal of the most significant bit in the bit field.
2703 @return The bit field read.
2716 Writes a bit field to a 32-bit value, and returns the result.
2718 Writes Value to the bit field specified by the StartBit and the EndBit in
2719 Operand. All other bits in Operand are preserved. The new 32-bit value is
2722 If 32-bit operations are not supported, then ASSERT().
2723 If StartBit is greater than 31, then ASSERT().
2724 If EndBit is greater than 31, then ASSERT().
2725 If EndBit is less than StartBit, then ASSERT().
2727 @param Operand Operand on which to perform the bitfield operation.
2728 @param StartBit The ordinal of the least significant bit in the bit field.
2730 @param EndBit The ordinal of the most significant bit in the bit field.
2732 @param Value New value of the bit field.
2734 @return The new 32-bit value.
2748 Reads a bit field from a 32-bit value, performs a bitwise OR, and returns the
2751 Performs a bitwise inclusive OR between the bit field specified by StartBit
2752 and EndBit in Operand and the value specified by OrData. All other bits in
2753 Operand are preserved. The new 32-bit value is returned.
2755 If 32-bit operations are not supported, then ASSERT().
2756 If StartBit is greater than 31, then ASSERT().
2757 If EndBit is greater than 31, then ASSERT().
2758 If EndBit is less than StartBit, then ASSERT().
2760 @param Operand Operand on which to perform the bitfield operation.
2761 @param StartBit The ordinal of the least significant bit in the bit field.
2763 @param EndBit The ordinal of the most significant bit in the bit field.
2765 @param OrData The value to OR with the read value from the value
2767 @return The new 32-bit value.
2781 Reads a bit field from a 32-bit value, performs a bitwise AND, and returns
2784 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2785 in Operand and the value specified by AndData. All other bits in Operand are
2786 preserved. The new 32-bit value is returned.
2788 If 32-bit operations are not supported, then ASSERT().
2789 If StartBit is greater than 31, then ASSERT().
2790 If EndBit is greater than 31, then ASSERT().
2791 If EndBit is less than StartBit, then ASSERT().
2793 @param Operand Operand on which to perform the bitfield operation.
2794 @param StartBit The ordinal of the least significant bit in the bit field.
2796 @param EndBit The ordinal of the most significant bit in the bit field.
2798 @param AndData The value to AND with the read value from the value
2800 @return The new 32-bit value.
2814 Reads a bit field from a 32-bit value, performs a bitwise AND followed by a
2815 bitwise OR, and returns the result.
2817 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2818 in Operand and the value specified by AndData, followed by a bitwise
2819 inclusive OR with value specified by OrData. All other bits in Operand are
2820 preserved. The new 32-bit value is returned.
2822 If 32-bit operations are not supported, then ASSERT().
2823 If StartBit is greater than 31, then ASSERT().
2824 If EndBit is greater than 31, 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.
2833 @param OrData The value to OR with the result of the AND operation.
2835 @return The new 32-bit value.
2840 BitFieldAndThenOr32 (
2850 Returns a bit field from a 64-bit value.
2852 Returns the bitfield specified by the StartBit and the EndBit from Operand.
2854 If 64-bit operations are not supported, then ASSERT().
2855 If StartBit is greater than 63, then ASSERT().
2856 If EndBit is greater than 63, then ASSERT().
2857 If EndBit is less than StartBit, then ASSERT().
2859 @param Operand Operand on which to perform the bitfield operation.
2860 @param StartBit The ordinal of the least significant bit in the bit field.
2862 @param EndBit The ordinal of the most significant bit in the bit field.
2865 @return The bit field read.
2878 Writes a bit field to a 64-bit value, and returns the result.
2880 Writes Value to the bit field specified by the StartBit and the EndBit in
2881 Operand. All other bits in Operand are preserved. The new 64-bit value is
2884 If 64-bit operations are not supported, then ASSERT().
2885 If StartBit is greater than 63, then ASSERT().
2886 If EndBit is greater than 63, then ASSERT().
2887 If EndBit is less than StartBit, then ASSERT().
2889 @param Operand Operand on which to perform the bitfield operation.
2890 @param StartBit The ordinal of the least significant bit in the bit field.
2892 @param EndBit The ordinal of the most significant bit in the bit field.
2894 @param Value New value of the bit field.
2896 @return The new 64-bit value.
2910 Reads a bit field from a 64-bit value, performs a bitwise OR, and returns the
2913 Performs a bitwise inclusive OR between the bit field specified by StartBit
2914 and EndBit in Operand and the value specified by OrData. All other bits in
2915 Operand are preserved. The new 64-bit value is returned.
2917 If 64-bit operations are not supported, then ASSERT().
2918 If StartBit is greater than 63, then ASSERT().
2919 If EndBit is greater than 63, then ASSERT().
2920 If EndBit is less than StartBit, then ASSERT().
2922 @param Operand Operand on which to perform the bitfield operation.
2923 @param StartBit The ordinal of the least significant bit in the bit field.
2925 @param EndBit The ordinal of the most significant bit in the bit field.
2927 @param OrData The value to OR with the read value from the value
2929 @return The new 64-bit value.
2943 Reads a bit field from a 64-bit value, performs a bitwise AND, and returns
2946 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2947 in Operand and the value specified by AndData. All other bits in Operand are
2948 preserved. The new 64-bit value is returned.
2950 If 64-bit operations are not supported, then ASSERT().
2951 If StartBit is greater than 63, then ASSERT().
2952 If EndBit is greater than 63, then ASSERT().
2953 If EndBit is less than StartBit, then ASSERT().
2955 @param Operand Operand on which to perform the bitfield operation.
2956 @param StartBit The ordinal of the least significant bit in the bit field.
2958 @param EndBit The ordinal of the most significant bit in the bit field.
2960 @param AndData The value to AND with the read value from the value
2962 @return The new 64-bit value.
2976 Reads a bit field from a 64-bit value, performs a bitwise AND followed by a
2977 bitwise OR, and returns the result.
2979 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2980 in Operand and the value specified by AndData, followed by a bitwise
2981 inclusive OR with value specified by OrData. All other bits in Operand are
2982 preserved. The new 64-bit value is returned.
2984 If 64-bit operations are not supported, then ASSERT().
2985 If StartBit is greater than 63, then ASSERT().
2986 If EndBit is greater than 63, then ASSERT().
2987 If EndBit is less than StartBit, then ASSERT().
2989 @param Operand Operand on which to perform the bitfield operation.
2990 @param StartBit The ordinal of the least significant bit in the bit field.
2992 @param EndBit The ordinal of the most significant bit in the bit field.
2994 @param AndData The value to AND with the read value from the value.
2995 @param OrData The value to OR with the result of the AND operation.
2997 @return The new 64-bit value.
3002 BitFieldAndThenOr64 (
3012 // Base Library Synchronization Functions
3016 Retrieves the architecture specific spin lock alignment requirements for
3017 optimal spin lock performance.
3019 This function retrieves the spin lock alignment requirements for optimal
3020 performance on a given CPU architecture. The spin lock alignment must be a
3021 power of two and is returned by this function. If there are no alignment
3022 requirements, then 1 must be returned. The spin lock synchronization
3023 functions must function correctly if the spin lock size and alignment values
3024 returned by this function are not used at all. These values are hints to the
3025 consumers of the spin lock synchronization functions to obtain optimal spin
3028 @return The architecture specific spin lock alignment.
3033 GetSpinLockProperties (
3039 Initializes a spin lock to the released state and returns the spin lock.
3041 This function initializes the spin lock specified by SpinLock to the released
3042 state, and returns SpinLock. Optimal performance can be achieved by calling
3043 GetSpinLockProperties() to determine the size and alignment requirements for
3046 If SpinLock is NULL, then ASSERT().
3048 @param SpinLock A pointer to the spin lock to initialize to the released
3051 @return SpinLock in release state.
3056 InitializeSpinLock (
3057 IN SPIN_LOCK
*SpinLock
3062 Waits until a spin lock can be placed in the acquired state.
3064 This function checks the state of the spin lock specified by SpinLock. If
3065 SpinLock is in the released state, then this function places SpinLock in the
3066 acquired state and returns SpinLock. Otherwise, this function waits
3067 indefinitely for the spin lock to be released, and then places it in the
3068 acquired state and returns SpinLock. All state transitions of SpinLock must
3069 be performed using MP safe mechanisms.
3071 If SpinLock is NULL, then ASSERT().
3072 If SpinLock was not initialized with InitializeSpinLock(), then ASSERT().
3073 If PcdSpinLockTimeout is not zero, and SpinLock is can not be acquired in
3074 PcdSpinLockTimeout microseconds, then ASSERT().
3076 @param SpinLock A pointer to the spin lock to place in the acquired state.
3078 @return SpinLock accquired lock.
3084 IN SPIN_LOCK
*SpinLock
3089 Attempts to place a spin lock in the acquired state.
3091 This function checks the state of the spin lock specified by SpinLock. If
3092 SpinLock is in the released state, then this function places SpinLock in the
3093 acquired state and returns TRUE. Otherwise, FALSE is returned. All state
3094 transitions of SpinLock must be performed using MP safe mechanisms.
3096 If SpinLock is NULL, then ASSERT().
3097 If SpinLock was not initialized with InitializeSpinLock(), then ASSERT().
3099 @param SpinLock A pointer to the spin lock to place in the acquired state.
3101 @retval TRUE SpinLock was placed in the acquired state.
3102 @retval FALSE SpinLock could not be acquired.
3107 AcquireSpinLockOrFail (
3108 IN SPIN_LOCK
*SpinLock
3113 Releases a spin lock.
3115 This function places the spin lock specified by SpinLock in the release state
3116 and returns SpinLock.
3118 If SpinLock is NULL, then ASSERT().
3119 If SpinLock was not initialized with InitializeSpinLock(), then ASSERT().
3121 @param SpinLock A pointer to the spin lock to release.
3123 @return SpinLock released lock.
3129 IN SPIN_LOCK
*SpinLock
3134 Performs an atomic increment of an 32-bit unsigned integer.
3136 Performs an atomic increment of the 32-bit unsigned integer specified by
3137 Value and returns the incremented value. The increment operation must be
3138 performed using MP safe mechanisms. The state of the return value is not
3139 guaranteed to be MP safe.
3141 If Value is NULL, then ASSERT().
3143 @param Value A pointer to the 32-bit value to increment.
3145 @return The incremented value.
3150 InterlockedIncrement (
3156 Performs an atomic decrement of an 32-bit unsigned integer.
3158 Performs an atomic decrement of the 32-bit unsigned integer specified by
3159 Value and returns the decremented value. The decrement operation must be
3160 performed using MP safe mechanisms. The state of the return value is not
3161 guaranteed to be MP safe.
3163 If Value is NULL, then ASSERT().
3165 @param Value A pointer to the 32-bit value to decrement.
3167 @return The decremented value.
3172 InterlockedDecrement (
3178 Performs an atomic compare exchange operation on a 32-bit unsigned integer.
3180 Performs an atomic compare exchange operation on the 32-bit unsigned integer
3181 specified by Value. If Value is equal to CompareValue, then Value is set to
3182 ExchangeValue and CompareValue is returned. If Value is not equal to CompareValue,
3183 then Value is returned. The compare exchange operation must be performed using
3186 If Value is NULL, then ASSERT().
3188 @param Value A pointer to the 32-bit value for the compare exchange
3190 @param CompareValue 32-bit value used in compare operation.
3191 @param ExchangeValue 32-bit value used in exchange operation.
3193 @return The original *Value before exchange.
3198 InterlockedCompareExchange32 (
3199 IN OUT UINT32
*Value
,
3200 IN UINT32 CompareValue
,
3201 IN UINT32 ExchangeValue
3206 Performs an atomic compare exchange operation on a 64-bit unsigned integer.
3208 Performs an atomic compare exchange operation on the 64-bit unsigned integer specified
3209 by Value. If Value is equal to CompareValue, then Value is set to ExchangeValue and
3210 CompareValue is returned. If Value is not equal to CompareValue, then Value is returned.
3211 The compare exchange operation must be performed using MP safe mechanisms.
3213 If Value is NULL, then ASSERT().
3215 @param Value A pointer to the 64-bit value for the compare exchange
3217 @param CompareValue 64-bit value used in compare operation.
3218 @param ExchangeValue 64-bit value used in exchange operation.
3220 @return The original *Value before exchange.
3225 InterlockedCompareExchange64 (
3226 IN OUT UINT64
*Value
,
3227 IN UINT64 CompareValue
,
3228 IN UINT64 ExchangeValue
3233 Performs an atomic compare exchange operation on a pointer value.
3235 Performs an atomic compare exchange operation on the pointer value specified
3236 by Value. If Value is equal to CompareValue, then Value is set to
3237 ExchangeValue and CompareValue is returned. If Value is not equal to
3238 CompareValue, then Value is returned. The compare exchange operation must be
3239 performed using MP safe mechanisms.
3241 If Value is NULL, then ASSERT().
3243 @param Value A pointer to the pointer value for the compare exchange
3245 @param CompareValue Pointer value used in compare operation.
3246 @param ExchangeValue Pointer value used in exchange operation.
3248 @return The original *Value before exchange.
3252 InterlockedCompareExchangePointer (
3253 IN OUT VOID
**Value
,
3254 IN VOID
*CompareValue
,
3255 IN VOID
*ExchangeValue
3260 // Base Library Checksum Functions
3264 Calculate the sum of all elements in a buffer in unit of UINT8.
3265 During calculation, the carry bits are dropped.
3267 This function calculates the sum of all elements in a buffer
3268 in unit of UINT8. The carry bits in result of addition are dropped.
3269 The result is returned as UINT8. If Length is Zero, then Zero is
3272 If Buffer is NULL, then ASSERT().
3273 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3275 @param Buffer Pointer to the buffer to carry out the sum operation.
3276 @param Length The size, in bytes, of Buffer .
3278 @return Sum The sum of Buffer with carry bits dropped during additions.
3284 IN CONST UINT8
*Buffer
,
3290 Returns the two's complement checksum of all elements in a buffer
3293 This function first calculates the sum of the 8-bit values in the
3294 buffer specified by Buffer and Length. The carry bits in the result
3295 of addition are dropped. Then, the two's complement of the sum is
3296 returned. If Length is 0, then 0 is returned.
3298 If Buffer is NULL, then ASSERT().
3299 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3301 @param Buffer Pointer to the buffer to carry out the checksum operation.
3302 @param Length The size, in bytes, of Buffer.
3304 @return Checksum The 2's complement checksum of Buffer.
3309 CalculateCheckSum8 (
3310 IN CONST UINT8
*Buffer
,
3316 Returns the sum of all elements in a buffer of 16-bit values. During
3317 calculation, the carry bits are dropped.
3319 This function calculates the sum of the 16-bit values in the buffer
3320 specified by Buffer and Length. The carry bits in result of addition are dropped.
3321 The 16-bit result is returned. If Length is 0, then 0 is returned.
3323 If Buffer is NULL, then ASSERT().
3324 If Buffer is not aligned on a 16-bit boundary, then ASSERT().
3325 If Length is not aligned on a 16-bit boundary, then ASSERT().
3326 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3328 @param Buffer Pointer to the buffer to carry out the sum operation.
3329 @param Length The size, in bytes, of Buffer.
3331 @return Sum The sum of Buffer with carry bits dropped during additions.
3337 IN CONST UINT16
*Buffer
,
3343 Returns the two's complement checksum of all elements in a buffer of
3346 This function first calculates the sum of the 16-bit values in the buffer
3347 specified by Buffer and Length. The carry bits in the result of addition
3348 are dropped. Then, the two's complement of the sum is returned. If Length
3349 is 0, then 0 is returned.
3351 If Buffer is NULL, then ASSERT().
3352 If Buffer is not aligned on a 16-bit boundary, then ASSERT().
3353 If Length is not aligned on a 16-bit boundary, then ASSERT().
3354 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3356 @param Buffer Pointer to the buffer to carry out the checksum operation.
3357 @param Length The size, in bytes, of Buffer.
3359 @return Checksum The 2's complement checksum of Buffer.
3364 CalculateCheckSum16 (
3365 IN CONST UINT16
*Buffer
,
3371 Returns the sum of all elements in a buffer of 32-bit values. During
3372 calculation, the carry bits are dropped.
3374 This function calculates the sum of the 32-bit values in the buffer
3375 specified by Buffer and Length. The carry bits in result of addition are dropped.
3376 The 32-bit result is returned. If Length is 0, then 0 is returned.
3378 If Buffer is NULL, then ASSERT().
3379 If Buffer is not aligned on a 32-bit boundary, then ASSERT().
3380 If Length is not aligned on a 32-bit boundary, then ASSERT().
3381 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3383 @param Buffer Pointer to the buffer to carry out the sum operation.
3384 @param Length The size, in bytes, of Buffer.
3386 @return Sum The sum of Buffer with carry bits dropped during additions.
3392 IN CONST UINT32
*Buffer
,
3398 Returns the two's complement checksum of all elements in a buffer of
3401 This function first calculates the sum of the 32-bit values in the buffer
3402 specified by Buffer and Length. The carry bits in the result of addition
3403 are dropped. Then, the two's complement of the sum is returned. If Length
3404 is 0, then 0 is returned.
3406 If Buffer is NULL, then ASSERT().
3407 If Buffer is not aligned on a 32-bit boundary, then ASSERT().
3408 If Length is not aligned on a 32-bit boundary, then ASSERT().
3409 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3411 @param Buffer Pointer to the buffer to carry out the checksum operation.
3412 @param Length The size, in bytes, of Buffer.
3414 @return Checksum The 2's complement checksum of Buffer.
3419 CalculateCheckSum32 (
3420 IN CONST UINT32
*Buffer
,
3426 Returns the sum of all elements in a buffer of 64-bit values. During
3427 calculation, the carry bits are dropped.
3429 This function calculates the sum of the 64-bit values in the buffer
3430 specified by Buffer and Length. The carry bits in result of addition are dropped.
3431 The 64-bit result is returned. If Length is 0, then 0 is returned.
3433 If Buffer is NULL, then ASSERT().
3434 If Buffer is not aligned on a 64-bit boundary, then ASSERT().
3435 If Length is not aligned on a 64-bit boundary, then ASSERT().
3436 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3438 @param Buffer Pointer to the buffer to carry out the sum operation.
3439 @param Length The size, in bytes, of Buffer.
3441 @return Sum The sum of Buffer with carry bits dropped during additions.
3447 IN CONST UINT64
*Buffer
,
3453 Returns the two's complement checksum of all elements in a buffer of
3456 This function first calculates the sum of the 64-bit values in the buffer
3457 specified by Buffer and Length. The carry bits in the result of addition
3458 are dropped. Then, the two's complement of the sum is returned. If Length
3459 is 0, then 0 is returned.
3461 If Buffer is NULL, then ASSERT().
3462 If Buffer is not aligned on a 64-bit boundary, then ASSERT().
3463 If Length is not aligned on a 64-bit boundary, then ASSERT().
3464 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3466 @param Buffer Pointer to the buffer to carry out the checksum operation.
3467 @param Length The size, in bytes, of Buffer.
3469 @return Checksum The 2's complement checksum of Buffer.
3474 CalculateCheckSum64 (
3475 IN CONST UINT64
*Buffer
,
3481 /// Base Library CPU Functions
3485 (EFIAPI
*SWITCH_STACK_ENTRY_POINT
)(
3486 IN VOID
*Context1
, OPTIONAL
3487 IN VOID
*Context2 OPTIONAL
3492 Used to serialize load and store operations.
3494 All loads and stores that proceed calls to this function are guaranteed to be
3495 globally visible when this function returns.
3506 Saves the current CPU context that can be restored with a call to LongJump()
3509 Saves the current CPU context in the buffer specified by JumpBuffer and
3510 returns 0. The initial call to SetJump() must always return 0. Subsequent
3511 calls to LongJump() cause a non-zero value to be returned by SetJump().
3513 If JumpBuffer is NULL, then ASSERT().
3514 For IPF CPUs, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().
3516 @param JumpBuffer A pointer to CPU context buffer.
3518 @retval 0 Indicates a return from SetJump().
3524 OUT BASE_LIBRARY_JUMP_BUFFER
*JumpBuffer
3529 Restores the CPU context that was saved with SetJump().
3531 Restores the CPU context from the buffer specified by JumpBuffer. This
3532 function never returns to the caller. Instead is resumes execution based on
3533 the state of JumpBuffer.
3535 If JumpBuffer is NULL, then ASSERT().
3536 For IPF CPUs, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().
3537 If Value is 0, then ASSERT().
3539 @param JumpBuffer A pointer to CPU context buffer.
3540 @param Value The value to return when the SetJump() context is
3541 restored and must be non-zero.
3547 IN BASE_LIBRARY_JUMP_BUFFER
*JumpBuffer
,
3553 Enables CPU interrupts.
3564 Disables CPU interrupts.
3575 Disables CPU interrupts and returns the interrupt state prior to the disable
3578 @retval TRUE CPU interrupts were enabled on entry to this call.
3579 @retval FALSE CPU interrupts were disabled on entry to this call.
3584 SaveAndDisableInterrupts (
3590 Enables CPU interrupts for the smallest window required to capture any
3596 EnableDisableInterrupts (
3602 Retrieves the current CPU interrupt state.
3604 Returns TRUE is interrupts are currently enabled. Otherwise
3607 @retval TRUE CPU interrupts are enabled.
3608 @retval FALSE CPU interrupts are disabled.
3619 Set the current CPU interrupt state.
3621 Sets the current CPU interrupt state to the state specified by
3622 InterruptState. If InterruptState is TRUE, then interrupts are enabled. If
3623 InterruptState is FALSE, then interrupts are disabled. InterruptState is
3626 @param InterruptState TRUE if interrupts should enabled. FALSE if
3627 interrupts should be disabled.
3629 @return InterruptState
3635 IN BOOLEAN InterruptState
3640 Requests CPU to pause for a short period of time.
3642 Requests CPU to pause for a short period of time. Typically used in MP
3643 systems to prevent memory starvation while waiting for a spin lock.
3654 Transfers control to a function starting with a new stack.
3656 Transfers control to the function specified by EntryPoint using the
3657 new stack specified by NewStack and passing in the parameters specified
3658 by Context1 and Context2. Context1 and Context2 are optional and may
3659 be NULL. The function EntryPoint must never return. This function
3660 supports a variable number of arguments following the NewStack parameter.
3661 These additional arguments are ignored on IA-32, x64, and EBC.
3662 IPF CPUs expect one additional parameter of type VOID * that specifies
3663 the new backing store pointer.
3665 If EntryPoint is NULL, then ASSERT().
3666 If NewStack is NULL, then ASSERT().
3668 @param EntryPoint A pointer to function to call with the new stack.
3669 @param Context1 A pointer to the context to pass into the EntryPoint
3671 @param Context2 A pointer to the context to pass into the EntryPoint
3673 @param NewStack A pointer to the new stack to use for the EntryPoint
3675 @param ... Extended parameters.
3682 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
3683 IN VOID
*Context1
, OPTIONAL
3684 IN VOID
*Context2
, OPTIONAL
3691 Generates a breakpoint on the CPU.
3693 Generates a breakpoint on the CPU. The breakpoint must be implemented such
3694 that code can resume normal execution after the breakpoint.
3705 Executes an infinite loop.
3707 Forces the CPU to execute an infinite loop. A debugger may be used to skip
3708 past the loop and the code that follows the loop must execute properly. This
3709 implies that the infinite loop must not cause the code that follow it to be
3720 #if defined (MDE_CPU_IPF)
3723 Flush a range of cache lines in the cache coherency domain of the calling
3726 Invalidates the cache lines specified by Address and Length. If Address is
3727 not aligned on a cache line boundary, then entire cache line containing
3728 Address is invalidated. If Address + Length is not aligned on a cache line
3729 boundary, then the entire instruction cache line containing Address + Length
3730 -1 is invalidated. This function may choose to invalidate the entire
3731 instruction cache if that is more efficient than invalidating the specified
3732 range. If Length is 0, the no instruction cache lines are invalidated.
3733 Address is returned.
3735 If Length is greater than (MAX_ADDRESS - Address + 1), then ASSERT().
3737 @param Address The base address of the instruction lines to invalidate. If
3738 the CPU is in a physical addressing mode, then Address is a
3739 physical address. If the CPU is in a virtual addressing mode,
3740 then Address is a virtual address.
3742 @param Length The number of bytes to invalidate from the instruction cache.
3749 IpfFlushCacheRange (
3756 Executes a FC instruction
3757 Executes a FC instruction on the cache line specified by Address.
3758 The cache line size affected is at least 32-bytes (aligned on a 32-byte boundary).
3759 An implementation may flush a larger region. This function is only available on IPF.
3761 @param Address The Address of cache line to be flushed.
3763 @return The address of FC instruction executed.
3774 Executes a FC.I instruction.
3775 Executes a FC.I instruction on the cache line specified by Address.
3776 The cache line size affected is at least 32-bytes (aligned on a 32-byte boundary).
3777 An implementation may flush a larger region. This function is only available on IPF.
3779 @param Address The Address of cache line to be flushed.
3781 @return The address of FC.I instruction executed.
3792 Reads the current value of a Processor Identifier Register (CPUID).
3793 The Index of largest implemented CPUID (One less than the number of implemented CPUID
3794 registers) is determined by CPUID [3] bits {7:0}.
3795 No parameter checking is performed on Index. If the Index value is beyond the
3796 implemented CPUID register range, a Reserved Register/Field fault may occur. The caller
3797 must either guarantee that Index is valid, or the caller must set up fault handlers to
3798 catch the faults. This function is only available on IPF.
3800 @param Index The 8-bit Processor Identifier Register index to read.
3802 @return The current value of Processor Identifier Register specified by Index.
3813 Reads the current value of 64-bit Processor Status Register (PSR).
3814 This function is only available on IPF.
3816 @return The current value of PSR.
3827 Writes the current value of 64-bit Processor Status Register (PSR).
3828 No parameter checking is performed on Value. All bits of Value corresponding to
3829 reserved fields of PSR must be 0 or a Reserved Register/Field fault may occur. The caller must either guarantee that Value is valid, or the caller must set up fault handlers to catch the faults.
3830 This function is only available on IPF.
3832 @param Value The 64-bit value to write to PSR.
3834 @return The 64-bit value written to the PSR.
3845 Reads the current value of 64-bit Kernel Register #0 (KR0).
3846 This function is only available on IPF.
3848 @return The current value of KR0.
3859 Reads the current value of 64-bit Kernel Register #1 (KR1).
3860 This function is only available on IPF.
3862 @return The current value of KR1.
3873 Reads the current value of 64-bit Kernel Register #2 (KR2).
3874 This function is only available on IPF.
3876 @return The current value of KR2.
3887 Reads the current value of 64-bit Kernel Register #3 (KR3).
3888 This function is only available on IPF.
3890 @return The current value of KR3.
3901 Reads the current value of 64-bit Kernel Register #4 (KR4).
3902 This function is only available on IPF.
3904 @return The current value of KR4.
3915 Reads the current value of 64-bit Kernel Register #5 (KR5).
3916 This function is only available on IPF.
3918 @return The current value of KR5.
3929 Reads the current value of 64-bit Kernel Register #6 (KR6).
3930 This function is only available on IPF.
3932 @return The current value of KR6.
3943 Reads the current value of 64-bit Kernel Register #7 (KR7).
3944 This function is only available on IPF.
3946 @return The current value of KR7.
3957 Write the current value of 64-bit Kernel Register #0 (KR0).
3958 This function is only available on IPF.
3960 @param Value The 64-bit value to write to KR0.
3962 @return The 64-bit value written to the KR0.
3973 Write the current value of 64-bit Kernel Register #1 (KR1).
3974 This function is only available on IPF.
3976 @param Value The 64-bit value to write to KR1.
3978 @return The 64-bit value written to the KR1.
3989 Write the current value of 64-bit Kernel Register #2 (KR2).
3990 This function is only available on IPF.
3992 @param Value The 64-bit value to write to KR2.
3994 @return The 64-bit value written to the KR2.
4005 Write the current value of 64-bit Kernel Register #3 (KR3).
4006 This function is only available on IPF.
4008 @param Value The 64-bit value to write to KR3.
4010 @return The 64-bit value written to the KR3.
4021 Write the current value of 64-bit Kernel Register #4 (KR4).
4022 This function is only available on IPF.
4024 @param Value The 64-bit value to write to KR4.
4026 @return The 64-bit value written to the KR4.
4037 Write the current value of 64-bit Kernel Register #5 (KR5).
4038 This function is only available on IPF.
4040 @param Value The 64-bit value to write to KR5.
4042 @return The 64-bit value written to the KR5.
4053 Write the current value of 64-bit Kernel Register #6 (KR6).
4054 This function is only available on IPF.
4056 @param Value The 64-bit value to write to KR6.
4058 @return The 64-bit value written to the KR6.
4069 Write the current value of 64-bit Kernel Register #7 (KR7).
4070 This function is only available on IPF.
4072 @param Value The 64-bit value to write to KR7.
4074 @return The 64-bit value written to the KR7.
4085 Reads the current value of Interval Timer Counter Register (ITC).
4086 This function is only available on IPF.
4088 @return The current value of ITC.
4099 Reads the current value of Interval Timer Vector Register (ITV).
4100 This function is only available on IPF.
4102 @return The current value of ITV.
4113 Reads the current value of Interval Timer Match Register (ITM).
4114 This function is only available on IPF.
4116 @return The current value of ITM.
4126 Writes the current value of 64-bit Interval Timer Counter Register (ITC).
4127 This function is only available on IPF.
4129 @param Value The 64-bit value to write to ITC.
4131 @return The 64-bit value written to the ITC.
4142 Writes the current value of 64-bit Interval Timer Match Register (ITM).
4143 This function is only available on IPF.
4145 @param Value The 64-bit value to write to ITM.
4147 @return The 64-bit value written to the ITM.
4158 Writes the current value of 64-bit Interval Timer Vector Register (ITV).
4159 No parameter checking is performed on Value. All bits of Value corresponding to
4160 reserved fields of ITV must be 0 or a Reserved Register/Field fault may occur.
4161 The caller must either guarantee that Value is valid, or the caller must set up
4162 fault handlers to catch the faults.
4163 This function is only available on IPF.
4165 @param Value The 64-bit value to write to ITV.
4167 @return The 64-bit value written to the ITV.
4178 Reads the current value of Default Control Register (DCR).
4179 This function is only available on IPF.
4181 @return The current value of DCR.
4192 Reads the current value of Interruption Vector Address Register (IVA).
4193 This function is only available on IPF.
4195 @return The current value of IVA.
4205 Reads the current value of Page Table Address Register (PTA).
4206 This function is only available on IPF.
4208 @return The current value of PTA.
4219 Writes the current value of 64-bit Default Control Register (DCR).
4220 No parameter checking is performed on Value. All bits of Value corresponding to
4221 reserved fields of DCR must be 0 or a Reserved Register/Field fault may occur.
4222 The caller must either guarantee that Value is valid, or the caller must set up
4223 fault handlers to catch the faults.
4224 This function is only available on IPF.
4226 @param Value The 64-bit value to write to DCR.
4228 @return The 64-bit value written to the DCR.
4239 Writes the current value of 64-bit Interruption Vector Address Register (IVA).
4240 The size of vector table is 32 K bytes and is 32 K bytes aligned
4241 the low 15 bits of Value is ignored when written.
4242 This function is only available on IPF.
4244 @param Value The 64-bit value to write to IVA.
4246 @return The 64-bit value written to the IVA.
4257 Writes the current value of 64-bit Page Table Address Register (PTA).
4258 No parameter checking is performed on Value. All bits of Value corresponding to
4259 reserved fields of DCR must be 0 or a Reserved Register/Field fault may occur.
4260 The caller must either guarantee that Value is valid, or the caller must set up
4261 fault handlers to catch the faults.
4262 This function is only available on IPF.
4264 @param Value The 64-bit value to write to PTA.
4266 @return The 64-bit value written to the PTA.
4276 Reads the current value of Local Interrupt ID Register (LID).
4277 This function is only available on IPF.
4279 @return The current value of LID.
4290 Reads the current value of External Interrupt Vector Register (IVR).
4291 This function is only available on IPF.
4293 @return The current value of IVR.
4304 Reads the current value of Task Priority Register (TPR).
4305 This function is only available on IPF.
4307 @return The current value of TPR.
4318 Reads the current value of External Interrupt Request Register #0 (IRR0).
4319 This function is only available on IPF.
4321 @return The current value of IRR0.
4332 Reads the current value of External Interrupt Request Register #1 (IRR1).
4333 This function is only available on IPF.
4335 @return The current value of IRR1.
4346 Reads the current value of External Interrupt Request Register #2 (IRR2).
4347 This function is only available on IPF.
4349 @return The current value of IRR2.
4360 Reads the current value of External Interrupt Request Register #3 (IRR3).
4361 This function is only available on IPF.
4363 @return The current value of IRR3.
4374 Reads the current value of Performance Monitor Vector Register (PMV).
4375 This function is only available on IPF.
4377 @return The current value of PMV.
4388 Reads the current value of Corrected Machine Check Vector Register (CMCV).
4389 This function is only available on IPF.
4391 @return The current value of CMCV.
4402 Reads the current value of Local Redirection Register #0 (LRR0).
4403 This function is only available on IPF.
4405 @return The current value of LRR0.
4416 Reads the current value of Local Redirection Register #1 (LRR1).
4417 This function is only available on IPF.
4419 @return The current value of LRR1.
4430 Writes the current value of 64-bit Page Local Interrupt ID Register (LID).
4431 No parameter checking is performed on Value. All bits of Value corresponding to
4432 reserved fields of LID must be 0 or a Reserved Register/Field fault may occur.
4433 The caller must either guarantee that Value is valid, or the caller must set up
4434 fault handlers to catch the faults.
4435 This function is only available on IPF.
4437 @param Value The 64-bit value to write to LID.
4439 @return The 64-bit value written to the LID.
4450 Writes the current value of 64-bit Task Priority Register (TPR).
4451 No parameter checking is performed on Value. All bits of Value corresponding to
4452 reserved fields of TPR must be 0 or a Reserved Register/Field fault may occur.
4453 The caller must either guarantee that Value is valid, or the caller must set up
4454 fault handlers to catch the faults.
4455 This function is only available on IPF.
4457 @param Value The 64-bit value to write to TPR.
4459 @return The 64-bit value written to the TPR.
4470 Performs a write operation on End OF External Interrupt Register (EOI).
4471 Writes a value of 0 to the EOI Register. This function is only available on IPF.
4482 Writes the current value of 64-bit Performance Monitor Vector Register (PMV).
4483 No parameter checking is performed on Value. All bits of Value corresponding
4484 to reserved fields of PMV must be 0 or a Reserved Register/Field fault may occur.
4485 The caller must either guarantee that Value is valid, or the caller must set up
4486 fault handlers to catch the faults.
4487 This function is only available on IPF.
4489 @param Value The 64-bit value to write to PMV.
4491 @return The 64-bit value written to the PMV.
4502 Writes the current value of 64-bit Corrected Machine Check Vector Register (CMCV).
4503 No parameter checking is performed on Value. All bits of Value corresponding
4504 to reserved fields of CMCV must be 0 or a Reserved Register/Field fault may occur.
4505 The caller must either guarantee that Value is valid, or the caller must set up
4506 fault handlers to catch the faults.
4507 This function is only available on IPF.
4509 @param Value The 64-bit value to write to CMCV.
4511 @return The 64-bit value written to the CMCV.
4522 Writes the current value of 64-bit Local Redirection Register #0 (LRR0).
4523 No parameter checking is performed on Value. All bits of Value corresponding
4524 to reserved fields of LRR0 must be 0 or a Reserved Register/Field fault may occur.
4525 The caller must either guarantee that Value is valid, or the caller must set up
4526 fault handlers to catch the faults.
4527 This function is only available on IPF.
4529 @param Value The 64-bit value to write to LRR0.
4531 @return The 64-bit value written to the LRR0.
4542 Writes the current value of 64-bit Local Redirection Register #1 (LRR1).
4543 No parameter checking is performed on Value. All bits of Value corresponding
4544 to reserved fields of LRR1 must be 0 or a Reserved Register/Field fault may occur.
4545 The caller must either guarantee that Value is valid, or the caller must
4546 set up fault handlers to catch the faults.
4547 This function is only available on IPF.
4549 @param Value The 64-bit value to write to LRR1.
4551 @return The 64-bit value written to the LRR1.
4562 Reads the current value of Instruction Breakpoint Register (IBR).
4564 The Instruction Breakpoint Registers are used in pairs. The even numbered
4565 registers contain breakpoint addresses, and the odd numbered registers contain
4566 breakpoint mask conditions. At least 4 instruction registers pairs are implemented
4567 on all processor models. Implemented registers are contiguous starting with
4568 register 0. No parameter checking is performed on Index, and if the Index value
4569 is beyond the implemented IBR register range, a Reserved Register/Field fault may
4570 occur. The caller must either guarantee that Index is valid, or the caller must
4571 set up fault handlers to catch the faults.
4572 This function is only available on IPF.
4574 @param Index The 8-bit Instruction Breakpoint Register index to read.
4576 @return The current value of Instruction Breakpoint Register specified by Index.
4587 Reads the current value of Data Breakpoint Register (DBR).
4589 The Data Breakpoint Registers are used in pairs. The even numbered registers
4590 contain breakpoint addresses, and odd numbered registers contain breakpoint
4591 mask conditions. At least 4 data registers pairs are implemented on all processor
4592 models. Implemented registers are contiguous starting with register 0.
4593 No parameter checking is performed on Index. If the Index value is beyond
4594 the implemented DBR register range, a Reserved Register/Field fault may occur.
4595 The caller must either guarantee that Index is valid, or the caller must set up
4596 fault handlers to catch the faults.
4597 This function is only available on IPF.
4599 @param Index The 8-bit Data Breakpoint Register index to read.
4601 @return The current value of Data Breakpoint Register specified by Index.
4612 Reads the current value of Performance Monitor Configuration Register (PMC).
4614 All processor implementations provide at least 4 performance counters
4615 (PMC/PMD [4]...PMC/PMD [7] pairs), and 4 performance monitor counter overflow
4616 status registers (PMC [0]... PMC [3]). Processor implementations may provide
4617 additional implementation-dependent PMC and PMD to increase the number of
4618 'generic' performance counters (PMC/PMD pairs). The remainder of PMC and PMD
4619 register set is implementation dependent. No parameter checking is performed
4620 on Index. If the Index value is beyond the implemented PMC register range,
4621 zero value will be returned.
4622 This function is only available on IPF.
4624 @param Index The 8-bit Performance Monitor Configuration Register index to read.
4626 @return The current value of Performance Monitor Configuration Register
4638 Reads the current value of Performance Monitor Data Register (PMD).
4640 All processor implementations provide at least 4 performance counters
4641 (PMC/PMD [4]...PMC/PMD [7] pairs), and 4 performance monitor counter
4642 overflow status registers (PMC [0]... PMC [3]). Processor implementations may
4643 provide additional implementation-dependent PMC and PMD to increase the number
4644 of 'generic' performance counters (PMC/PMD pairs). The remainder of PMC and PMD
4645 register set is implementation dependent. No parameter checking is performed
4646 on Index. If the Index value is beyond the implemented PMD register range,
4647 zero value will be returned.
4648 This function is only available on IPF.
4650 @param Index The 8-bit Performance Monitor Data Register index to read.
4652 @return The current value of Performance Monitor Data Register specified by Index.
4663 Writes the current value of 64-bit Instruction Breakpoint Register (IBR).
4665 Writes current value of Instruction Breakpoint Register specified by Index.
4666 The Instruction Breakpoint Registers are used in pairs. The even numbered
4667 registers contain breakpoint addresses, and odd numbered registers contain
4668 breakpoint mask conditions. At least 4 instruction registers pairs are implemented
4669 on all processor models. Implemented registers are contiguous starting with
4670 register 0. No parameter checking is performed on Index. If the Index value
4671 is beyond the implemented IBR register range, a Reserved Register/Field fault may
4672 occur. The caller must either guarantee that Index is valid, or the caller must
4673 set up fault handlers to catch the faults.
4674 This function is only available on IPF.
4676 @param Index The 8-bit Instruction Breakpoint Register index to write.
4677 @param Value The 64-bit value to write to IBR.
4679 @return The 64-bit value written to the IBR.
4691 Writes the current value of 64-bit Data Breakpoint Register (DBR).
4693 Writes current value of Data Breakpoint Register specified by Index.
4694 The Data Breakpoint Registers are used in pairs. The even numbered registers
4695 contain breakpoint addresses, and odd numbered registers contain breakpoint
4696 mask conditions. At least 4 data registers pairs are implemented on all processor
4697 models. Implemented registers are contiguous starting with register 0. No parameter
4698 checking is performed on Index. If the Index value is beyond the implemented
4699 DBR register range, a Reserved Register/Field fault may occur. The caller must
4700 either guarantee that Index is valid, or the caller must set up fault handlers to
4702 This function is only available on IPF.
4704 @param Index The 8-bit Data Breakpoint Register index to write.
4705 @param Value The 64-bit value to write to DBR.
4707 @return The 64-bit value written to the DBR.
4719 Writes the current value of 64-bit Performance Monitor Configuration Register (PMC).
4721 Writes current value of Performance Monitor Configuration Register specified by Index.
4722 All processor implementations provide at least 4 performance counters
4723 (PMC/PMD [4]...PMC/PMD [7] pairs), and 4 performance monitor counter overflow status
4724 registers (PMC [0]... PMC [3]). Processor implementations may provide additional
4725 implementation-dependent PMC and PMD to increase the number of 'generic' performance
4726 counters (PMC/PMD pairs). The remainder of PMC and PMD register set is implementation
4727 dependent. No parameter checking is performed on Index. If the Index value is
4728 beyond the implemented PMC register range, the write is ignored.
4729 This function is only available on IPF.
4731 @param Index The 8-bit Performance Monitor Configuration Register index to write.
4732 @param Value The 64-bit value to write to PMC.
4734 @return The 64-bit value written to the PMC.
4746 Writes the current value of 64-bit Performance Monitor Data Register (PMD).
4748 Writes current value of Performance Monitor Data Register specified by Index.
4749 All processor implementations provide at least 4 performance counters
4750 (PMC/PMD [4]...PMC/PMD [7] pairs), and 4 performance monitor counter overflow
4751 status registers (PMC [0]... PMC [3]). Processor implementations may provide
4752 additional implementation-dependent PMC and PMD to increase the number of 'generic'
4753 performance counters (PMC/PMD pairs). The remainder of PMC and PMD register set
4754 is implementation dependent. No parameter checking is performed on Index. If the
4755 Index value is beyond the implemented PMD register range, the write is ignored.
4756 This function is only available on IPF.
4758 @param Index The 8-bit Performance Monitor Data Register index to write.
4759 @param Value The 64-bit value to write to PMD.
4761 @return The 64-bit value written to the PMD.
4773 Reads the current value of 64-bit Global Pointer (GP).
4775 Reads and returns the current value of GP.
4776 This function is only available on IPF.
4778 @return The current value of GP.
4789 Write the current value of 64-bit Global Pointer (GP).
4791 Writes the current value of GP. The 64-bit value written to the GP is returned.
4792 No parameter checking is performed on Value.
4793 This function is only available on IPF.
4795 @param Value The 64-bit value to write to GP.
4797 @return The 64-bit value written to the GP.
4808 Reads the current value of 64-bit Stack Pointer (SP).
4810 Reads and returns the current value of SP.
4811 This function is only available on IPF.
4813 @return The current value of SP.
4824 Determines if the CPU is currently executing in virtual, physical, or mixed mode.
4826 Determines the current execution mode of the CPU.
4827 If the CPU is in virtual mode(PSR.RT=1, PSR.DT=1, PSR.IT=1), then 1 is returned.
4828 If the CPU is in physical mode(PSR.RT=0, PSR.DT=0, PSR.IT=0), then 0 is returned.
4829 If the CPU is not in physical mode or virtual mode, then it is in mixed mode,
4831 This function is only available on IPF.
4833 @return 1 The CPU is in virtual mode.
4834 @return 0 The CPU is in physical mode.
4835 @return -1 The CPU is in mixed mode.
4846 Makes a PAL procedure call.
4848 This is a wrapper function to make a PAL procedure call. Based on the Index
4849 value this API will make static or stacked PAL call. The following table
4850 describes the usage of PAL Procedure Index Assignment. Architected procedures
4851 may be designated as required or optional. If a PAL procedure is specified
4852 as optional, a unique return code of 0xFFFFFFFFFFFFFFFF is returned in the
4853 Status field of the PAL_CALL_RETURN structure.
4854 This indicates that the procedure is not present in this PAL implementation.
4855 It is the caller's responsibility to check for this return code after calling
4856 any optional PAL procedure.
4857 No parameter checking is performed on the 5 input parameters, but there are
4858 some common rules that the caller should follow when making a PAL call. Any
4859 address passed to PAL as buffers for return parameters must be 8-byte aligned.
4860 Unaligned addresses may cause undefined results. For those parameters defined
4861 as reserved or some fields defined as reserved must be zero filled or the invalid
4862 argument return value may be returned or undefined result may occur during the
4863 execution of the procedure. If the PalEntryPoint does not point to a valid
4864 PAL entry point then the system behavior is undefined. This function is only
4867 @param PalEntryPoint The PAL procedure calls entry point.
4868 @param Index The PAL procedure Index number.
4869 @param Arg2 The 2nd parameter for PAL procedure calls.
4870 @param Arg3 The 3rd parameter for PAL procedure calls.
4871 @param Arg4 The 4th parameter for PAL procedure calls.
4873 @return structure returned from the PAL Call procedure, including the status and return value.
4879 IN UINT64 PalEntryPoint
,
4888 Transfers control to a function starting with a new stack.
4890 Transfers control to the function specified by EntryPoint using the new stack
4891 specified by NewStack and passing in the parameters specified by Context1 and
4892 Context2. Context1 and Context2 are optional and may be NULL. The function
4893 EntryPoint must never return.
4895 If EntryPoint is NULL, then ASSERT().
4896 If NewStack is NULL, then ASSERT().
4898 @param EntryPoint A pointer to function to call with the new stack.
4899 @param Context1 A pointer to the context to pass into the EntryPoint
4901 @param Context2 A pointer to the context to pass into the EntryPoint
4903 @param NewStack A pointer to the new stack to use for the EntryPoint
4905 @param NewBsp A pointer to the new memory location for RSE backing
4911 AsmSwitchStackAndBackingStore (
4912 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
4913 IN VOID
*Context1
, OPTIONAL
4914 IN VOID
*Context2
, OPTIONAL
4920 @todo This call should be removed after the PalCall
4921 Instance issue has been fixed.
4923 Performs a PAL call using static calling convention.
4925 An internal function to perform a PAL call using static calling convention.
4927 @param PalEntryPoint The entry point address of PAL. The address in ar.kr5
4928 would be used if this parameter were NULL on input.
4929 @param Arg1 The first argument of a PAL call.
4930 @param Arg2 The second argument of a PAL call.
4931 @param Arg3 The third argument of a PAL call.
4932 @param Arg4 The fourth argument of a PAL call.
4934 @return The values returned in r8, r9, r10 and r11.
4939 IN CONST VOID
*PalEntryPoint
,
4947 #elif defined (MDE_CPU_IA32) || defined (MDE_CPU_X64)
4949 /// IA32 and X64 Specific Functions
4950 /// Byte packed structure for 16-bit Real Mode EFLAGS
4954 UINT32 CF
:1; /// Carry Flag
4955 UINT32 Reserved_0
:1; /// Reserved
4956 UINT32 PF
:1; /// Parity Flag
4957 UINT32 Reserved_1
:1; /// Reserved
4958 UINT32 AF
:1; /// Auxiliary Carry Flag
4959 UINT32 Reserved_2
:1; /// Reserved
4960 UINT32 ZF
:1; /// Zero Flag
4961 UINT32 SF
:1; /// Sign Flag
4962 UINT32 TF
:1; /// Trap Flag
4963 UINT32 IF
:1; /// Interrupt Enable Flag
4964 UINT32 DF
:1; /// Direction Flag
4965 UINT32 OF
:1; /// Overflow Flag
4966 UINT32 IOPL
:2; /// I/O Privilege Level
4967 UINT32 NT
:1; /// Nested Task
4968 UINT32 Reserved_3
:1; /// Reserved
4974 /// Byte packed structure for EFLAGS/RFLAGS
4975 /// 32-bits on IA-32
4976 /// 64-bits on X64. The upper 32-bits on X64 are reserved
4980 UINT32 CF
:1; /// Carry Flag
4981 UINT32 Reserved_0
:1; /// Reserved
4982 UINT32 PF
:1; /// Parity Flag
4983 UINT32 Reserved_1
:1; /// Reserved
4984 UINT32 AF
:1; /// Auxiliary Carry Flag
4985 UINT32 Reserved_2
:1; /// Reserved
4986 UINT32 ZF
:1; /// Zero Flag
4987 UINT32 SF
:1; /// Sign Flag
4988 UINT32 TF
:1; /// Trap Flag
4989 UINT32 IF
:1; /// Interrupt Enable Flag
4990 UINT32 DF
:1; /// Direction Flag
4991 UINT32 OF
:1; /// Overflow Flag
4992 UINT32 IOPL
:2; /// I/O Privilege Level
4993 UINT32 NT
:1; /// Nested Task
4994 UINT32 Reserved_3
:1; /// Reserved
4995 UINT32 RF
:1; /// Resume Flag
4996 UINT32 VM
:1; /// Virtual 8086 Mode
4997 UINT32 AC
:1; /// Alignment Check
4998 UINT32 VIF
:1; /// Virtual Interrupt Flag
4999 UINT32 VIP
:1; /// Virtual Interrupt Pending
5000 UINT32 ID
:1; /// ID Flag
5001 UINT32 Reserved_4
:10; /// Reserved
5007 /// Byte packed structure for Control Register 0 (CR0)
5008 /// 32-bits on IA-32
5009 /// 64-bits on X64. The upper 32-bits on X64 are reserved
5013 UINT32 PE
:1; /// Protection Enable
5014 UINT32 MP
:1; /// Monitor Coprocessor
5015 UINT32 EM
:1; /// Emulation
5016 UINT32 TS
:1; /// Task Switched
5017 UINT32 ET
:1; /// Extension Type
5018 UINT32 NE
:1; /// Numeric Error
5019 UINT32 Reserved_0
:10; /// Reserved
5020 UINT32 WP
:1; /// Write Protect
5021 UINT32 Reserved_1
:1; /// Reserved
5022 UINT32 AM
:1; /// Alignment Mask
5023 UINT32 Reserved_2
:10; /// Reserved
5024 UINT32 NW
:1; /// Mot Write-through
5025 UINT32 CD
:1; /// Cache Disable
5026 UINT32 PG
:1; /// Paging
5032 /// Byte packed structure for Control Register 4 (CR4)
5033 /// 32-bits on IA-32
5034 /// 64-bits on X64. The upper 32-bits on X64 are reserved
5038 UINT32 VME
:1; /// Virtual-8086 Mode Extensions
5039 UINT32 PVI
:1; /// Protected-Mode Virtual Interrupts
5040 UINT32 TSD
:1; /// Time Stamp Disable
5041 UINT32 DE
:1; /// Debugging Extensions
5042 UINT32 PSE
:1; /// Page Size Extensions
5043 UINT32 PAE
:1; /// Physical Address Extension
5044 UINT32 MCE
:1; /// Machine Check Enable
5045 UINT32 PGE
:1; /// Page Global Enable
5046 UINT32 PCE
:1; /// Performance Monitoring Counter
5048 UINT32 OSFXSR
:1; /// Operating System Support for
5049 /// FXSAVE and FXRSTOR instructions
5050 UINT32 OSXMMEXCPT
:1; /// Operating System Support for
5051 /// Unmasked SIMD Floating Point
5053 UINT32 Reserved_0
:2; /// Reserved
5054 UINT32 VMXE
:1; /// VMX Enable
5055 UINT32 Reserved_1
:18; /// Reseved
5061 /// Byte packed structure for an IDTR, GDTR, LDTR descriptor
5062 /// @todo How to make this structure byte-packed in a compiler independent way?
5071 #define IA32_IDT_GATE_TYPE_TASK 0x85
5072 #define IA32_IDT_GATE_TYPE_INTERRUPT_16 0x86
5073 #define IA32_IDT_GATE_TYPE_TRAP_16 0x87
5074 #define IA32_IDT_GATE_TYPE_INTERRUPT_32 0x8E
5075 #define IA32_IDT_GATE_TYPE_TRAP_32 0x8F
5078 /// Byte packed structure for an Interrupt Gate Descriptor
5082 UINT32 OffsetLow
:16; /// Offset bits 15..0
5083 UINT32 Selector
:16; /// Selector
5084 UINT32 Reserved_0
:8; /// Reserved
5085 UINT32 GateType
:8; /// Gate Type. See #defines above
5086 UINT32 OffsetHigh
:16; /// Offset bits 31..16
5089 } IA32_IDT_GATE_DESCRIPTOR
;
5092 /// Byte packed structure for an FP/SSE/SSE2 context
5099 /// Structures for the 16-bit real mode thunks
5152 IA32_EFLAGS32 EFLAGS
;
5162 } IA32_REGISTER_SET
;
5165 /// Byte packed structure for an 16-bit real mode thunks
5168 IA32_REGISTER_SET
*RealModeState
;
5169 VOID
*RealModeBuffer
;
5170 UINT32 RealModeBufferSize
;
5171 UINT32 ThunkAttributes
;
5174 #define THUNK_ATTRIBUTE_BIG_REAL_MODE 0x00000001
5175 #define THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 0x00000002
5176 #define THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL 0x00000004
5179 Retrieves CPUID information.
5181 Executes the CPUID instruction with EAX set to the value specified by Index.
5182 This function always returns Index.
5183 If Eax is not NULL, then the value of EAX after CPUID is returned in Eax.
5184 If Ebx is not NULL, then the value of EBX after CPUID is returned in Ebx.
5185 If Ecx is not NULL, then the value of ECX after CPUID is returned in Ecx.
5186 If Edx is not NULL, then the value of EDX after CPUID is returned in Edx.
5187 This function is only available on IA-32 and X64.
5189 @param Index The 32-bit value to load into EAX prior to invoking the CPUID
5191 @param Eax Pointer to the 32-bit EAX value returned by the CPUID
5192 instruction. This is an optional parameter that may be NULL.
5193 @param Ebx Pointer to the 32-bit EBX value returned by the CPUID
5194 instruction. This is an optional parameter that may be NULL.
5195 @param Ecx Pointer to the 32-bit ECX value returned by the CPUID
5196 instruction. This is an optional parameter that may be NULL.
5197 @param Edx Pointer to the 32-bit EDX value returned by the CPUID
5198 instruction. This is an optional parameter that may be NULL.
5207 OUT UINT32
*Eax
, OPTIONAL
5208 OUT UINT32
*Ebx
, OPTIONAL
5209 OUT UINT32
*Ecx
, OPTIONAL
5210 OUT UINT32
*Edx OPTIONAL
5215 Retrieves CPUID information using an extended leaf identifier.
5217 Executes the CPUID instruction with EAX set to the value specified by Index
5218 and ECX set to the value specified by SubIndex. This function always returns
5219 Index. This function is only available on IA-32 and x64.
5221 If Eax is not NULL, then the value of EAX after CPUID is returned in Eax.
5222 If Ebx is not NULL, then the value of EBX after CPUID is returned in Ebx.
5223 If Ecx is not NULL, then the value of ECX after CPUID is returned in Ecx.
5224 If Edx is not NULL, then the value of EDX after CPUID is returned in Edx.
5226 @param Index The 32-bit value to load into EAX prior to invoking the
5228 @param SubIndex The 32-bit value to load into ECX prior to invoking the
5230 @param Eax Pointer to the 32-bit EAX value returned by the CPUID
5231 instruction. This is an optional parameter that may be
5233 @param Ebx Pointer to the 32-bit EBX value returned by the CPUID
5234 instruction. This is an optional parameter that may be
5236 @param Ecx Pointer to the 32-bit ECX value returned by the CPUID
5237 instruction. This is an optional parameter that may be
5239 @param Edx Pointer to the 32-bit EDX value returned by the CPUID
5240 instruction. This is an optional parameter that may be
5251 OUT UINT32
*Eax
, OPTIONAL
5252 OUT UINT32
*Ebx
, OPTIONAL
5253 OUT UINT32
*Ecx
, OPTIONAL
5254 OUT UINT32
*Edx OPTIONAL
5259 Returns the lower 32-bits of a Machine Specific Register(MSR).
5261 Reads and returns the lower 32-bits of the MSR specified by Index.
5262 No parameter checking is performed on Index, and some Index values may cause
5263 CPU exceptions. The caller must either guarantee that Index is valid, or the
5264 caller must set up exception handlers to catch the exceptions. This function
5265 is only available on IA-32 and X64.
5267 @param Index The 32-bit MSR index to read.
5269 @return The lower 32 bits of the MSR identified by Index.
5280 Zero-extend a 32-bit value and writes it to a Machine Specific Register(MSR).
5282 Writes the 32-bit value specified by Value to the MSR specified by Index. The
5283 upper 32-bits of the MSR write are set to zero. The 32-bit value written to
5284 the MSR is returned. No parameter checking is performed on Index or Value,
5285 and some of these may cause CPU exceptions. The caller must either guarantee
5286 that Index and Value are valid, or the caller must establish proper exception
5287 handlers. This function is only available on IA-32 and X64.
5289 @param Index The 32-bit MSR index to write.
5290 @param Value The 32-bit value to write to the MSR.
5304 Reads a 64-bit MSR, performs a bitwise inclusive OR on the lower 32-bits, and
5305 writes the result back to the 64-bit MSR.
5307 Reads the 64-bit MSR specified by Index, performs a bitwise inclusive OR
5308 between the lower 32-bits of the read result and the value specified by
5309 OrData, and writes the result to the 64-bit MSR specified by Index. The lower
5310 32-bits of the value written to the MSR is returned. No parameter checking is
5311 performed on Index or OrData, and some of these may cause CPU exceptions. The
5312 caller must either guarantee that Index and OrData are valid, or the caller
5313 must establish proper exception handlers. This function is only available on
5316 @param Index The 32-bit MSR index to write.
5317 @param OrData The value to OR with the read value from the MSR.
5319 @return The lower 32-bit value written to the MSR.
5331 Reads a 64-bit MSR, performs a bitwise AND on the lower 32-bits, and writes
5332 the result back to the 64-bit MSR.
5334 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
5335 lower 32-bits of the read result and the value specified by AndData, and
5336 writes the result to the 64-bit MSR specified by Index. The lower 32-bits of
5337 the value written to the MSR is returned. No parameter checking is performed
5338 on Index or AndData, and some of these may cause CPU exceptions. The caller
5339 must either guarantee that Index and AndData are valid, or the caller must
5340 establish proper exception handlers. This function is only available on IA-32
5343 @param Index The 32-bit MSR index to write.
5344 @param AndData The value to AND with the read value from the MSR.
5346 @return The lower 32-bit value written to the MSR.
5358 Reads a 64-bit MSR, performs a bitwise AND followed by a bitwise inclusive OR
5359 on the lower 32-bits, and writes the result back to the 64-bit MSR.
5361 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
5362 lower 32-bits of the read result and the value specified by AndData
5363 preserving the upper 32-bits, performs a bitwise inclusive OR between the
5364 result of the AND operation and the value specified by OrData, and writes the
5365 result to the 64-bit MSR specified by Address. The lower 32-bits of the value
5366 written to the MSR is returned. No parameter checking is performed on Index,
5367 AndData, or OrData, and some of these may cause CPU exceptions. The caller
5368 must either guarantee that Index, AndData, and OrData are valid, or the
5369 caller must establish proper exception handlers. This function is only
5370 available on IA-32 and X64.
5372 @param Index The 32-bit MSR index to write.
5373 @param AndData The value to AND with the read value from the MSR.
5374 @param OrData The value to OR with the result of the AND operation.
5376 @return The lower 32-bit value written to the MSR.
5389 Reads a bit field of an MSR.
5391 Reads the bit field in the lower 32-bits of a 64-bit MSR. The bit field is
5392 specified by the StartBit and the EndBit. The value of the bit field is
5393 returned. The caller must either guarantee that Index is valid, or the caller
5394 must set up exception handlers to catch the exceptions. This function is only
5395 available on IA-32 and X64.
5397 If StartBit is greater than 31, then ASSERT().
5398 If EndBit is greater than 31, then ASSERT().
5399 If EndBit is less than StartBit, then ASSERT().
5401 @param Index The 32-bit MSR index to read.
5402 @param StartBit The ordinal of the least significant bit in the bit field.
5404 @param EndBit The ordinal of the most significant bit in the bit field.
5407 @return The bit field read from the MSR.
5412 AsmMsrBitFieldRead32 (
5420 Writes a bit field to an MSR.
5422 Writes Value to a bit field in the lower 32-bits of a 64-bit MSR. The bit
5423 field is specified by the StartBit and the EndBit. All other bits in the
5424 destination MSR are preserved. The lower 32-bits of the MSR written is
5425 returned. Extra left bits in Value are stripped. The caller must either
5426 guarantee that Index and the data written is valid, or the caller must set up
5427 exception handlers to catch the exceptions. This function is only available
5430 If StartBit is greater than 31, then ASSERT().
5431 If EndBit is greater than 31, then ASSERT().
5432 If EndBit is less than StartBit, then ASSERT().
5434 @param Index The 32-bit MSR index to write.
5435 @param StartBit The ordinal of the least significant bit in the bit field.
5437 @param EndBit The ordinal of the most significant bit in the bit field.
5439 @param Value New value of the bit field.
5441 @return The lower 32-bit of the value written to the MSR.
5446 AsmMsrBitFieldWrite32 (
5455 Reads a bit field in a 64-bit MSR, performs a bitwise OR, and writes the
5456 result back to the bit field in the 64-bit MSR.
5458 Reads the 64-bit MSR specified by Index, performs a bitwise inclusive OR
5459 between the read result and the value specified by OrData, and writes the
5460 result to the 64-bit MSR specified by Index. The lower 32-bits of the value
5461 written to the MSR are returned. Extra left bits in OrData are stripped. The
5462 caller must either guarantee that Index and the data written is valid, or
5463 the caller must set up exception handlers to catch the exceptions. This
5464 function is only available on IA-32 and X64.
5466 If StartBit is greater than 31, then ASSERT().
5467 If EndBit is greater than 31, then ASSERT().
5468 If EndBit is less than StartBit, then ASSERT().
5470 @param Index The 32-bit MSR index to write.
5471 @param StartBit The ordinal of the least significant bit in the bit field.
5473 @param EndBit The ordinal of the most significant bit in the bit field.
5475 @param OrData The value to OR with the read value from the MSR.
5477 @return The lower 32-bit of the value written to the MSR.
5482 AsmMsrBitFieldOr32 (
5491 Reads a bit field in a 64-bit MSR, performs a bitwise AND, and writes the
5492 result back to the bit field in the 64-bit MSR.
5494 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
5495 read result and the value specified by AndData, and writes the result to the
5496 64-bit MSR specified by Index. The lower 32-bits of the value written to the
5497 MSR are returned. Extra left bits in AndData are stripped. The caller must
5498 either guarantee that Index and the data written is valid, or the caller must
5499 set up exception handlers to catch the exceptions. This function is only
5500 available on IA-32 and X64.
5502 If StartBit is greater than 31, then ASSERT().
5503 If EndBit is greater than 31, then ASSERT().
5504 If EndBit is less than StartBit, then ASSERT().
5506 @param Index The 32-bit MSR index to write.
5507 @param StartBit The ordinal of the least significant bit in the bit field.
5509 @param EndBit The ordinal of the most significant bit in the bit field.
5511 @param AndData The value to AND with the read value from the MSR.
5513 @return The lower 32-bit of the value written to the MSR.
5518 AsmMsrBitFieldAnd32 (
5527 Reads a bit field in a 64-bit MSR, performs a bitwise AND followed by a
5528 bitwise inclusive OR, and writes the result back to the bit field in the
5531 Reads the 64-bit MSR specified by Index, performs a bitwise AND followed by a
5532 bitwise inclusive OR between the read result and the value specified by
5533 AndData, and writes the result to the 64-bit MSR specified by Index. The
5534 lower 32-bits of the value written to the MSR are returned. Extra left bits
5535 in both AndData and OrData are stripped. The caller must either guarantee
5536 that Index and the data written is valid, or the caller must set up exception
5537 handlers to catch the exceptions. This function is only available on IA-32
5540 If StartBit is greater than 31, then ASSERT().
5541 If EndBit is greater than 31, then ASSERT().
5542 If EndBit is less than StartBit, then ASSERT().
5544 @param Index The 32-bit MSR index to write.
5545 @param StartBit The ordinal of the least significant bit in the bit field.
5547 @param EndBit The ordinal of the most significant bit in the bit field.
5549 @param AndData The value to AND with the read value from the MSR.
5550 @param OrData The value to OR with the result of the AND operation.
5552 @return The lower 32-bit of the value written to the MSR.
5557 AsmMsrBitFieldAndThenOr32 (
5567 Returns a 64-bit Machine Specific Register(MSR).
5569 Reads and returns the 64-bit MSR specified by Index. No parameter checking is
5570 performed on Index, and some Index values may cause CPU exceptions. The
5571 caller must either guarantee that Index is valid, or the caller must set up
5572 exception handlers to catch the exceptions. This function is only available
5575 @param Index The 32-bit MSR index to read.
5577 @return The value of the MSR identified by Index.
5588 Writes a 64-bit value to a Machine Specific Register(MSR), and returns the
5591 Writes the 64-bit value specified by Value to the MSR specified by Index. The
5592 64-bit value written to the MSR is returned. No parameter checking is
5593 performed on Index or Value, and some of these may cause CPU exceptions. The
5594 caller must either guarantee that Index and Value are valid, or the caller
5595 must establish proper exception handlers. This function is only available on
5598 @param Index The 32-bit MSR index to write.
5599 @param Value The 64-bit value to write to the MSR.
5613 Reads a 64-bit MSR, performs a bitwise inclusive OR, and writes the result
5614 back to the 64-bit MSR.
5616 Reads the 64-bit MSR specified by Index, performs a bitwise inclusive OR
5617 between the read result and the value specified by OrData, and writes the
5618 result to the 64-bit MSR specified by Index. The value written to the MSR is
5619 returned. No parameter checking is performed on Index or OrData, and some of
5620 these may cause CPU exceptions. The caller must either guarantee that Index
5621 and OrData are valid, or the caller must establish proper exception handlers.
5622 This function is only available on IA-32 and X64.
5624 @param Index The 32-bit MSR index to write.
5625 @param OrData The value to OR with the read value from the MSR.
5627 @return The value written back to the MSR.
5639 Reads a 64-bit MSR, performs a bitwise AND, and writes the result back to the
5642 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
5643 read result and the value specified by OrData, and writes the result to the
5644 64-bit MSR specified by Index. The value written to the MSR is returned. No
5645 parameter checking is performed on Index or OrData, and some of these may
5646 cause CPU exceptions. The caller must either guarantee that Index and OrData
5647 are valid, or the caller must establish proper exception handlers. This
5648 function is only available on IA-32 and X64.
5650 @param Index The 32-bit MSR index to write.
5651 @param AndData The value to AND with the read value from the MSR.
5653 @return The value written back to the MSR.
5665 Reads a 64-bit MSR, performs a bitwise AND followed by a bitwise inclusive
5666 OR, and writes the result back to the 64-bit MSR.
5668 Reads the 64-bit MSR specified by Index, performs a bitwise AND between read
5669 result and the value specified by AndData, performs a bitwise inclusive OR
5670 between the result of the AND operation and the value specified by OrData,
5671 and writes the result to the 64-bit MSR specified by Index. The value written
5672 to the MSR is returned. No parameter checking is performed on Index, AndData,
5673 or OrData, and some of these may cause CPU exceptions. The caller must either
5674 guarantee that Index, AndData, and OrData are valid, or the caller must
5675 establish proper exception handlers. This function is only available on IA-32
5678 @param Index The 32-bit MSR index to write.
5679 @param AndData The value to AND with the read value from the MSR.
5680 @param OrData The value to OR with the result of the AND operation.
5682 @return The value written back to the MSR.
5695 Reads a bit field of an MSR.
5697 Reads the bit field in the 64-bit MSR. The bit field is specified by the
5698 StartBit and the EndBit. The value of the bit field is returned. The caller
5699 must either guarantee that Index is valid, or the caller must set up
5700 exception handlers to catch the exceptions. This function is only available
5703 If StartBit is greater than 63, then ASSERT().
5704 If EndBit is greater than 63, then ASSERT().
5705 If EndBit is less than StartBit, then ASSERT().
5707 @param Index The 32-bit MSR index to read.
5708 @param StartBit The ordinal of the least significant bit in the bit field.
5710 @param EndBit The ordinal of the most significant bit in the bit field.
5713 @return The value read from the MSR.
5718 AsmMsrBitFieldRead64 (
5726 Writes a bit field to an MSR.
5728 Writes Value to a bit field in a 64-bit MSR. The bit field is specified by
5729 the StartBit and the EndBit. All other bits in the destination MSR are
5730 preserved. The MSR written is returned. Extra left bits in Value are
5731 stripped. The caller must either guarantee that Index and the data written is
5732 valid, or the caller must set up exception handlers to catch the exceptions.
5733 This function is only available on IA-32 and X64.
5735 If StartBit is greater than 63, then ASSERT().
5736 If EndBit is greater than 63, then ASSERT().
5737 If EndBit is less than StartBit, then ASSERT().
5739 @param Index The 32-bit MSR index to write.
5740 @param StartBit The ordinal of the least significant bit in the bit field.
5742 @param EndBit The ordinal of the most significant bit in the bit field.
5744 @param Value New value of the bit field.
5746 @return The value written back to the MSR.
5751 AsmMsrBitFieldWrite64 (
5760 Reads a bit field in a 64-bit MSR, performs a bitwise inclusive OR, and
5761 writes the result back to the bit field in the 64-bit MSR.
5763 Reads the 64-bit MSR specified by Index, performs a bitwise inclusive OR
5764 between the read result and the value specified by OrData, and writes the
5765 result to the 64-bit MSR specified by Index. The value written to the MSR is
5766 returned. Extra left bits in OrData are stripped. The caller must either
5767 guarantee that Index and the data written is valid, or the caller must set up
5768 exception handlers to catch the exceptions. This function is only available
5771 If StartBit is greater than 63, then ASSERT().
5772 If EndBit is greater than 63, then ASSERT().
5773 If EndBit is less than StartBit, then ASSERT().
5775 @param Index The 32-bit MSR index to write.
5776 @param StartBit The ordinal of the least significant bit in the bit field.
5778 @param EndBit The ordinal of the most significant bit in the bit field.
5780 @param OrData The value to OR with the read value from the bit field.
5782 @return The value written back to the MSR.
5787 AsmMsrBitFieldOr64 (
5796 Reads a bit field in a 64-bit MSR, performs a bitwise AND, and writes the
5797 result back to the bit field in the 64-bit MSR.
5799 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
5800 read result and the value specified by AndData, and writes the result to the
5801 64-bit MSR specified by Index. The value written to the MSR is returned.
5802 Extra left bits in AndData are stripped. The caller must either guarantee
5803 that Index and the data written is valid, or the caller must set up exception
5804 handlers to catch the exceptions. This function is only available on IA-32
5807 If StartBit is greater than 63, then ASSERT().
5808 If EndBit is greater than 63, then ASSERT().
5809 If EndBit is less than StartBit, then ASSERT().
5811 @param Index The 32-bit MSR index to write.
5812 @param StartBit The ordinal of the least significant bit in the bit field.
5814 @param EndBit The ordinal of the most significant bit in the bit field.
5816 @param AndData The value to AND with the read value from the bit field.
5818 @return The value written back to the MSR.
5823 AsmMsrBitFieldAnd64 (
5832 Reads a bit field in a 64-bit MSR, performs a bitwise AND followed by a
5833 bitwise inclusive OR, and writes the result back to the bit field in the
5836 Reads the 64-bit MSR specified by Index, performs a bitwise AND followed by
5837 a bitwise inclusive OR between the read result and the value specified by
5838 AndData, and writes the result to the 64-bit MSR specified by Index. The
5839 value written to the MSR is returned. Extra left bits in both AndData and
5840 OrData are stripped. The caller must either guarantee that Index and the data
5841 written is valid, or the caller must set up exception handlers to catch the
5842 exceptions. This function is only available on IA-32 and X64.
5844 If StartBit is greater than 63, then ASSERT().
5845 If EndBit is greater than 63, then ASSERT().
5846 If EndBit is less than StartBit, then ASSERT().
5848 @param Index The 32-bit MSR index to write.
5849 @param StartBit The ordinal of the least significant bit in the bit field.
5851 @param EndBit The ordinal of the most significant bit in the bit field.
5853 @param AndData The value to AND with the read value from the bit field.
5854 @param OrData The value to OR with the result of the AND operation.
5856 @return The value written back to the MSR.
5861 AsmMsrBitFieldAndThenOr64 (
5871 Reads the current value of the EFLAGS register.
5873 Reads and returns the current value of the EFLAGS register. This function is
5874 only available on IA-32 and X64. This returns a 32-bit value on IA-32 and a
5875 64-bit value on X64.
5877 @return EFLAGS on IA-32 or RFLAGS on X64.
5888 Reads the current value of the Control Register 0 (CR0).
5890 Reads and returns the current value of CR0. This function is only available
5891 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
5894 @return The value of the Control Register 0 (CR0).
5905 Reads the current value of the Control Register 2 (CR2).
5907 Reads and returns the current value of CR2. This function is only available
5908 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
5911 @return The value of the Control Register 2 (CR2).
5922 Reads the current value of the Control Register 3 (CR3).
5924 Reads and returns the current value of CR3. This function is only available
5925 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
5928 @return The value of the Control Register 3 (CR3).
5939 Reads the current value of the Control Register 4 (CR4).
5941 Reads and returns the current value of CR4. This function is only available
5942 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
5945 @return The value of the Control Register 4 (CR4).
5956 Writes a value to Control Register 0 (CR0).
5958 Writes and returns a new value to CR0. This function is only available on
5959 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
5961 @param Cr0 The value to write to CR0.
5963 @return The value written to CR0.
5974 Writes a value to Control Register 2 (CR2).
5976 Writes and returns a new value to CR2. This function is only available on
5977 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
5979 @param Cr2 The value to write to CR2.
5981 @return The value written to CR2.
5992 Writes a value to Control Register 3 (CR3).
5994 Writes and returns a new value to CR3. This function is only available on
5995 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
5997 @param Cr3 The value to write to CR3.
5999 @return The value written to CR3.
6010 Writes a value to Control Register 4 (CR4).
6012 Writes and returns a new value to CR4. This function is only available on
6013 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6015 @param Cr4 The value to write to CR4.
6017 @return The value written to CR4.
6028 Reads the current value of Debug Register 0 (DR0).
6030 Reads and returns the current value of DR0. This function is only available
6031 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
6034 @return The value of Debug Register 0 (DR0).
6045 Reads the current value of Debug Register 1 (DR1).
6047 Reads and returns the current value of DR1. This function is only available
6048 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
6051 @return The value of Debug Register 1 (DR1).
6062 Reads the current value of Debug Register 2 (DR2).
6064 Reads and returns the current value of DR2. This function is only available
6065 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
6068 @return The value of Debug Register 2 (DR2).
6079 Reads the current value of Debug Register 3 (DR3).
6081 Reads and returns the current value of DR3. This function is only available
6082 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
6085 @return The value of Debug Register 3 (DR3).
6096 Reads the current value of Debug Register 4 (DR4).
6098 Reads and returns the current value of DR4. This function is only available
6099 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
6102 @return The value of Debug Register 4 (DR4).
6113 Reads the current value of Debug Register 5 (DR5).
6115 Reads and returns the current value of DR5. This function is only available
6116 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
6119 @return The value of Debug Register 5 (DR5).
6130 Reads the current value of Debug Register 6 (DR6).
6132 Reads and returns the current value of DR6. This function is only available
6133 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
6136 @return The value of Debug Register 6 (DR6).
6147 Reads the current value of Debug Register 7 (DR7).
6149 Reads and returns the current value of DR7. This function is only available
6150 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
6153 @return The value of Debug Register 7 (DR7).
6164 Writes a value to Debug Register 0 (DR0).
6166 Writes and returns a new value to DR0. This function is only available on
6167 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6169 @param Dr0 The value to write to Dr0.
6171 @return The value written to Debug Register 0 (DR0).
6182 Writes a value to Debug Register 1 (DR1).
6184 Writes and returns a new value to DR1. This function is only available on
6185 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6187 @param Dr1 The value to write to Dr1.
6189 @return The value written to Debug Register 1 (DR1).
6200 Writes a value to Debug Register 2 (DR2).
6202 Writes and returns a new value to DR2. This function is only available on
6203 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6205 @param Dr2 The value to write to Dr2.
6207 @return The value written to Debug Register 2 (DR2).
6218 Writes a value to Debug Register 3 (DR3).
6220 Writes and returns a new value to DR3. This function is only available on
6221 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6223 @param Dr3 The value to write to Dr3.
6225 @return The value written to Debug Register 3 (DR3).
6236 Writes a value to Debug Register 4 (DR4).
6238 Writes and returns a new value to DR4. This function is only available on
6239 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6241 @param Dr4 The value to write to Dr4.
6243 @return The value written to Debug Register 4 (DR4).
6254 Writes a value to Debug Register 5 (DR5).
6256 Writes and returns a new value to DR5. This function is only available on
6257 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6259 @param Dr5 The value to write to Dr5.
6261 @return The value written to Debug Register 5 (DR5).
6272 Writes a value to Debug Register 6 (DR6).
6274 Writes and returns a new value to DR6. This function is only available on
6275 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6277 @param Dr6 The value to write to Dr6.
6279 @return The value written to Debug Register 6 (DR6).
6290 Writes a value to Debug Register 7 (DR7).
6292 Writes and returns a new value to DR7. This function is only available on
6293 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6295 @param Dr7 The value to write to Dr7.
6297 @return The value written to Debug Register 7 (DR7).
6308 Reads the current value of Code Segment Register (CS).
6310 Reads and returns the current value of CS. This function is only available on
6313 @return The current value of CS.
6324 Reads the current value of Data Segment Register (DS).
6326 Reads and returns the current value of DS. This function is only available on
6329 @return The current value of DS.
6340 Reads the current value of Extra Segment Register (ES).
6342 Reads and returns the current value of ES. This function is only available on
6345 @return The current value of ES.
6356 Reads the current value of FS Data Segment Register (FS).
6358 Reads and returns the current value of FS. This function is only available on
6361 @return The current value of FS.
6372 Reads the current value of GS Data Segment Register (GS).
6374 Reads and returns the current value of GS. This function is only available on
6377 @return The current value of GS.
6388 Reads the current value of Stack Segment Register (SS).
6390 Reads and returns the current value of SS. This function is only available on
6393 @return The current value of SS.
6404 Reads the current value of Task Register (TR).
6406 Reads and returns the current value of TR. This function is only available on
6409 @return The current value of TR.
6420 Reads the current Global Descriptor Table Register(GDTR) descriptor.
6422 Reads and returns the current GDTR descriptor and returns it in Gdtr. This
6423 function is only available on IA-32 and X64.
6425 If Gdtr is NULL, then ASSERT().
6427 @param Gdtr Pointer to a GDTR descriptor.
6433 OUT IA32_DESCRIPTOR
*Gdtr
6438 Writes the current Global Descriptor Table Register (GDTR) descriptor.
6440 Writes and the current GDTR descriptor specified by Gdtr. This function is
6441 only available on IA-32 and X64.
6443 If Gdtr is NULL, then ASSERT().
6445 @param Gdtr Pointer to a GDTR descriptor.
6451 IN CONST IA32_DESCRIPTOR
*Gdtr
6456 Reads the current Interrupt Descriptor Table Register(GDTR) descriptor.
6458 Reads and returns the current IDTR descriptor and returns it in Idtr. This
6459 function is only available on IA-32 and X64.
6461 If Idtr is NULL, then ASSERT().
6463 @param Idtr Pointer to a IDTR descriptor.
6469 OUT IA32_DESCRIPTOR
*Idtr
6474 Writes the current Interrupt Descriptor Table Register(GDTR) descriptor.
6476 Writes the current IDTR descriptor and returns it in Idtr. This function is
6477 only available on IA-32 and X64.
6479 If Idtr is NULL, then ASSERT().
6481 @param Idtr Pointer to a IDTR descriptor.
6487 IN CONST IA32_DESCRIPTOR
*Idtr
6492 Reads the current Local Descriptor Table Register(LDTR) selector.
6494 Reads and returns the current 16-bit LDTR descriptor value. This function is
6495 only available on IA-32 and X64.
6497 @return The current selector of LDT.
6508 Writes the current Local Descriptor Table Register (GDTR) selector.
6510 Writes and the current LDTR descriptor specified by Ldtr. This function is
6511 only available on IA-32 and X64.
6513 @param Ldtr 16-bit LDTR selector value.
6524 Save the current floating point/SSE/SSE2 context to a buffer.
6526 Saves the current floating point/SSE/SSE2 state to the buffer specified by
6527 Buffer. Buffer must be aligned on a 16-byte boundary. This function is only
6528 available on IA-32 and X64.
6530 If Buffer is NULL, then ASSERT().
6531 If Buffer is not aligned on a 16-byte boundary, then ASSERT().
6533 @param Buffer Pointer to a buffer to save the floating point/SSE/SSE2 context.
6539 OUT IA32_FX_BUFFER
*Buffer
6544 Restores the current floating point/SSE/SSE2 context from a buffer.
6546 Restores the current floating point/SSE/SSE2 state from the buffer specified
6547 by Buffer. Buffer must be aligned on a 16-byte boundary. This function is
6548 only available on IA-32 and X64.
6550 If Buffer is NULL, then ASSERT().
6551 If Buffer is not aligned on a 16-byte boundary, then ASSERT().
6552 If Buffer was not saved with AsmFxSave(), then ASSERT().
6554 @param Buffer Pointer to a buffer to save the floating point/SSE/SSE2 context.
6560 IN CONST IA32_FX_BUFFER
*Buffer
6565 Reads the current value of 64-bit MMX Register #0 (MM0).
6567 Reads and returns the current value of MM0. This function is only available
6570 @return The current value of MM0.
6581 Reads the current value of 64-bit MMX Register #1 (MM1).
6583 Reads and returns the current value of MM1. This function is only available
6586 @return The current value of MM1.
6597 Reads the current value of 64-bit MMX Register #2 (MM2).
6599 Reads and returns the current value of MM2. This function is only available
6602 @return The current value of MM2.
6613 Reads the current value of 64-bit MMX Register #3 (MM3).
6615 Reads and returns the current value of MM3. This function is only available
6618 @return The current value of MM3.
6629 Reads the current value of 64-bit MMX Register #4 (MM4).
6631 Reads and returns the current value of MM4. This function is only available
6634 @return The current value of MM4.
6645 Reads the current value of 64-bit MMX Register #5 (MM5).
6647 Reads and returns the current value of MM5. This function is only available
6650 @return The current value of MM5.
6661 Reads the current value of 64-bit MMX Register #6 (MM6).
6663 Reads and returns the current value of MM6. This function is only available
6666 @return The current value of MM6.
6677 Reads the current value of 64-bit MMX Register #7 (MM7).
6679 Reads and returns the current value of MM7. This function is only available
6682 @return The current value of MM7.
6693 Writes the current value of 64-bit MMX Register #0 (MM0).
6695 Writes the current value of MM0. This function is only available on IA32 and
6698 @param Value The 64-bit value to write to MM0.
6709 Writes the current value of 64-bit MMX Register #1 (MM1).
6711 Writes the current value of MM1. This function is only available on IA32 and
6714 @param Value The 64-bit value to write to MM1.
6725 Writes the current value of 64-bit MMX Register #2 (MM2).
6727 Writes the current value of MM2. This function is only available on IA32 and
6730 @param Value The 64-bit value to write to MM2.
6741 Writes the current value of 64-bit MMX Register #3 (MM3).
6743 Writes the current value of MM3. This function is only available on IA32 and
6746 @param Value The 64-bit value to write to MM3.
6757 Writes the current value of 64-bit MMX Register #4 (MM4).
6759 Writes the current value of MM4. This function is only available on IA32 and
6762 @param Value The 64-bit value to write to MM4.
6773 Writes the current value of 64-bit MMX Register #5 (MM5).
6775 Writes the current value of MM5. This function is only available on IA32 and
6778 @param Value The 64-bit value to write to MM5.
6789 Writes the current value of 64-bit MMX Register #6 (MM6).
6791 Writes the current value of MM6. This function is only available on IA32 and
6794 @param Value The 64-bit value to write to MM6.
6805 Writes the current value of 64-bit MMX Register #7 (MM7).
6807 Writes the current value of MM7. This function is only available on IA32 and
6810 @param Value The 64-bit value to write to MM7.
6821 Reads the current value of Time Stamp Counter (TSC).
6823 Reads and returns the current value of TSC. This function is only available
6826 @return The current value of TSC
6837 Reads the current value of a Performance Counter (PMC).
6839 Reads and returns the current value of performance counter specified by
6840 Index. This function is only available on IA-32 and X64.
6842 @param Index The 32-bit Performance Counter index to read.
6844 @return The value of the PMC specified by Index.
6855 Sets up a monitor buffer that is used by AsmMwait().
6857 Executes a MONITOR instruction with the register state specified by Eax, Ecx
6858 and Edx. Returns Eax. This function is only available on IA-32 and X64.
6860 @param Eax The value to load into EAX or RAX before executing the MONITOR
6862 @param Ecx The value to load into ECX or RCX before executing the MONITOR
6864 @param Edx The value to load into EDX or RDX before executing the MONITOR
6880 Executes an MWAIT instruction.
6882 Executes an MWAIT instruction with the register state specified by Eax and
6883 Ecx. Returns Eax. This function is only available on IA-32 and X64.
6885 @param Eax The value to load into EAX or RAX before executing the MONITOR
6887 @param Ecx The value to load into ECX or RCX before executing the MONITOR
6902 Executes a WBINVD instruction.
6904 Executes a WBINVD instruction. This function is only available on IA-32 and
6916 Executes a INVD instruction.
6918 Executes a INVD instruction. This function is only available on IA-32 and
6930 Flushes a cache line from all the instruction and data caches within the
6931 coherency domain of the CPU.
6933 Flushed the cache line specified by LinearAddress, and returns LinearAddress.
6934 This function is only available on IA-32 and X64.
6936 @param LinearAddress The address of the cache line to flush. If the CPU is
6937 in a physical addressing mode, then LinearAddress is a
6938 physical address. If the CPU is in a virtual
6939 addressing mode, then LinearAddress is a virtual
6942 @return LinearAddress
6947 IN VOID
*LinearAddress
6952 Enables the 32-bit paging mode on the CPU.
6954 Enables the 32-bit paging mode on the CPU. CR0, CR3, CR4, and the page tables
6955 must be properly initialized prior to calling this service. This function
6956 assumes the current execution mode is 32-bit protected mode. This function is
6957 only available on IA-32. After the 32-bit paging mode is enabled, control is
6958 transferred to the function specified by EntryPoint using the new stack
6959 specified by NewStack and passing in the parameters specified by Context1 and
6960 Context2. Context1 and Context2 are optional and may be NULL. The function
6961 EntryPoint must never return.
6963 If the current execution mode is not 32-bit protected mode, then ASSERT().
6964 If EntryPoint is NULL, then ASSERT().
6965 If NewStack is NULL, then ASSERT().
6967 There are a number of constraints that must be followed before calling this
6969 1) Interrupts must be disabled.
6970 2) The caller must be in 32-bit protected mode with flat descriptors. This
6971 means all descriptors must have a base of 0 and a limit of 4GB.
6972 3) CR0 and CR4 must be compatible with 32-bit protected mode with flat
6974 4) CR3 must point to valid page tables that will be used once the transition
6975 is complete, and those page tables must guarantee that the pages for this
6976 function and the stack are identity mapped.
6978 @param EntryPoint A pointer to function to call with the new stack after
6980 @param Context1 A pointer to the context to pass into the EntryPoint
6981 function as the first parameter after paging is enabled.
6982 @param Context2 A pointer to the context to pass into the EntryPoint
6983 function as the second parameter after paging is enabled.
6984 @param NewStack A pointer to the new stack to use for the EntryPoint
6985 function after paging is enabled.
6991 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
6992 IN VOID
*Context1
, OPTIONAL
6993 IN VOID
*Context2
, OPTIONAL
6999 Disables the 32-bit paging mode on the CPU.
7001 Disables the 32-bit paging mode on the CPU and returns to 32-bit protected
7002 mode. This function assumes the current execution mode is 32-paged protected
7003 mode. This function is only available on IA-32. After the 32-bit paging mode
7004 is disabled, control is transferred to the function specified by EntryPoint
7005 using the new stack specified by NewStack and passing in the parameters
7006 specified by Context1 and Context2. Context1 and Context2 are optional and
7007 may be NULL. The function EntryPoint must never return.
7009 If the current execution mode is not 32-bit paged mode, then ASSERT().
7010 If EntryPoint is NULL, then ASSERT().
7011 If NewStack is NULL, then ASSERT().
7013 There are a number of constraints that must be followed before calling this
7015 1) Interrupts must be disabled.
7016 2) The caller must be in 32-bit paged mode.
7017 3) CR0, CR3, and CR4 must be compatible with 32-bit paged mode.
7018 4) CR3 must point to valid page tables that guarantee that the pages for
7019 this function and the stack are identity mapped.
7021 @param EntryPoint A pointer to function to call with the new stack after
7023 @param Context1 A pointer to the context to pass into the EntryPoint
7024 function as the first parameter after paging is disabled.
7025 @param Context2 A pointer to the context to pass into the EntryPoint
7026 function as the second parameter after paging is
7028 @param NewStack A pointer to the new stack to use for the EntryPoint
7029 function after paging is disabled.
7034 AsmDisablePaging32 (
7035 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
7036 IN VOID
*Context1
, OPTIONAL
7037 IN VOID
*Context2
, OPTIONAL
7043 Enables the 64-bit paging mode on the CPU.
7045 Enables the 64-bit paging mode on the CPU. CR0, CR3, CR4, and the page tables
7046 must be properly initialized prior to calling this service. This function
7047 assumes the current execution mode is 32-bit protected mode with flat
7048 descriptors. This function is only available on IA-32. After the 64-bit
7049 paging mode is enabled, control is transferred to the function specified by
7050 EntryPoint using the new stack specified by NewStack and passing in the
7051 parameters specified by Context1 and Context2. Context1 and Context2 are
7052 optional and may be 0. The function EntryPoint must never return.
7054 If the current execution mode is not 32-bit protected mode with flat
7055 descriptors, then ASSERT().
7056 If EntryPoint is 0, then ASSERT().
7057 If NewStack is 0, then ASSERT().
7059 @param CodeSelector The 16-bit selector to load in the CS before EntryPoint
7060 is called. The descriptor in the GDT that this selector
7061 references must be setup for long mode.
7062 @param EntryPoint The 64-bit virtual address of the function to call with
7063 the new stack after paging is enabled.
7064 @param Context1 The 64-bit virtual address of the context to pass into
7065 the EntryPoint function as the first parameter after
7067 @param Context2 The 64-bit virtual address of the context to pass into
7068 the EntryPoint function as the second parameter after
7070 @param NewStack The 64-bit virtual address of the new stack to use for
7071 the EntryPoint function after paging is enabled.
7077 IN UINT16 CodeSelector
,
7078 IN UINT64 EntryPoint
,
7079 IN UINT64 Context1
, OPTIONAL
7080 IN UINT64 Context2
, OPTIONAL
7086 Disables the 64-bit paging mode on the CPU.
7088 Disables the 64-bit paging mode on the CPU and returns to 32-bit protected
7089 mode. This function assumes the current execution mode is 64-paging mode.
7090 This function is only available on X64. After the 64-bit paging mode is
7091 disabled, control is transferred to the function specified by EntryPoint
7092 using the new stack specified by NewStack and passing in the parameters
7093 specified by Context1 and Context2. Context1 and Context2 are optional and
7094 may be 0. The function EntryPoint must never return.
7096 If the current execution mode is not 64-bit paged mode, then ASSERT().
7097 If EntryPoint is 0, then ASSERT().
7098 If NewStack is 0, then ASSERT().
7100 @param CodeSelector The 16-bit selector to load in the CS before EntryPoint
7101 is called. The descriptor in the GDT that this selector
7102 references must be setup for 32-bit protected mode.
7103 @param EntryPoint The 64-bit virtual address of the function to call with
7104 the new stack after paging is disabled.
7105 @param Context1 The 64-bit virtual address of the context to pass into
7106 the EntryPoint function as the first parameter after
7108 @param Context2 The 64-bit virtual address of the context to pass into
7109 the EntryPoint function as the second parameter after
7111 @param NewStack The 64-bit virtual address of the new stack to use for
7112 the EntryPoint function after paging is disabled.
7117 AsmDisablePaging64 (
7118 IN UINT16 CodeSelector
,
7119 IN UINT32 EntryPoint
,
7120 IN UINT32 Context1
, OPTIONAL
7121 IN UINT32 Context2
, OPTIONAL
7127 // 16-bit thunking services
7131 Retrieves the properties for 16-bit thunk functions.
7133 Computes the size of the buffer and stack below 1MB required to use the
7134 AsmPrepareThunk16(), AsmThunk16() and AsmPrepareAndThunk16() functions. This
7135 buffer size is returned in RealModeBufferSize, and the stack size is returned
7136 in ExtraStackSize. If parameters are passed to the 16-bit real mode code,
7137 then the actual minimum stack size is ExtraStackSize plus the maximum number
7138 of bytes that need to be passed to the 16-bit real mode code.
7140 If RealModeBufferSize is NULL, then ASSERT().
7141 If ExtraStackSize is NULL, then ASSERT().
7143 @param RealModeBufferSize A pointer to the size of the buffer below 1MB
7144 required to use the 16-bit thunk functions.
7145 @param ExtraStackSize A pointer to the extra size of stack below 1MB
7146 that the 16-bit thunk functions require for
7147 temporary storage in the transition to and from
7153 AsmGetThunk16Properties (
7154 OUT UINT32
*RealModeBufferSize
,
7155 OUT UINT32
*ExtraStackSize
7160 Prepares all structures a code required to use AsmThunk16().
7162 Prepares all structures and code required to use AsmThunk16().
7164 If ThunkContext is NULL, then ASSERT().
7166 @param ThunkContext A pointer to the context structure that describes the
7167 16-bit real mode code to call.
7173 OUT THUNK_CONTEXT
*ThunkContext
7178 Transfers control to a 16-bit real mode entry point and returns the results.
7180 Transfers control to a 16-bit real mode entry point and returns the results.
7181 AsmPrepareThunk16() must be called with ThunkContext before this function is
7184 If ThunkContext is NULL, then ASSERT().
7185 If AsmPrepareThunk16() was not previously called with ThunkContext, then ASSERT().
7187 @param ThunkContext A pointer to the context structure that describes the
7188 16-bit real mode code to call.
7194 IN OUT THUNK_CONTEXT
*ThunkContext
7199 Prepares all structures and code for a 16-bit real mode thunk, transfers
7200 control to a 16-bit real mode entry point, and returns the results.
7202 Prepares all structures and code for a 16-bit real mode thunk, transfers
7203 control to a 16-bit real mode entry point, and returns the results. If the
7204 caller only need to perform a single 16-bit real mode thunk, then this
7205 service should be used. If the caller intends to make more than one 16-bit
7206 real mode thunk, then it is more efficient if AsmPrepareThunk16() is called
7207 once and AsmThunk16() can be called for each 16-bit real mode thunk.
7209 If ThunkContext is NULL, then ASSERT().
7211 @param ThunkContext A pointer to the context structure that describes the
7212 16-bit real mode code to call.
7217 AsmPrepareAndThunk16 (
7218 IN OUT THUNK_CONTEXT
*ThunkContext