2 Memory-only library functions with no library constructor/destructor
4 Copyright (c) 2006 - 2007, Intel Corporation
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
19 // Definitions for architecture specific types
20 // These include SPIN_LOCK and BASE_LIBRARY_JUMP_BUFFER
26 typedef volatile UINTN SPIN_LOCK
;
28 #if defined (MDE_CPU_IA32)
30 // IA32 context buffer used by SetJump() and LongJump()
39 } BASE_LIBRARY_JUMP_BUFFER
;
41 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 4
43 #elif defined (MDE_CPU_IPF)
46 // IPF context buffer used by SetJump() and LongJump()
81 UINT64 AfterSpillUNAT
;
87 } BASE_LIBRARY_JUMP_BUFFER
;
89 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 0x10
91 #elif defined (MDE_CPU_X64)
93 // X64 context buffer used by SetJump() and LongJump()
106 } BASE_LIBRARY_JUMP_BUFFER
;
108 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 8
110 #elif defined (MDE_CPU_EBC)
112 // EBC context buffer used by SetJump() and LongJump()
120 } BASE_LIBRARY_JUMP_BUFFER
;
122 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 8
125 #error Unknown Processor Type
133 Copies one Null-terminated Unicode string to another Null-terminated Unicode
134 string and returns the new Unicode string.
136 This function copies the contents of the Unicode string Source to the Unicode
137 string Destination, and returns Destination. If Source and Destination
138 overlap, then the results are undefined.
140 If Destination is NULL, then ASSERT().
141 If Destination is not aligned on a 16-bit boundary, then ASSERT().
142 If Source is NULL, then ASSERT().
143 If Source is not aligned on a 16-bit boundary, then ASSERT().
144 If Source and Destination overlap, then ASSERT().
145 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
146 PcdMaximumUnicodeStringLength Unicode characters not including the
147 Null-terminator, then ASSERT().
149 @param Destination Pointer to a Null-terminated Unicode string.
150 @param Source Pointer to a Null-terminated Unicode string.
158 OUT CHAR16
*Destination
,
159 IN CONST CHAR16
*Source
164 Copies one Null-terminated Unicode string with a maximum length to another
165 Null-terminated Unicode string with a maximum length and returns the new
168 This function copies the contents of the Unicode string Source to the Unicode
169 string Destination, and returns Destination. At most, Length Unicode
170 characters are copied from Source to Destination. If Length is 0, then
171 Destination is returned unmodified. If Length is greater that the number of
172 Unicode characters in Source, then Destination is padded with Null Unicode
173 characters. If Source and Destination overlap, then the results are
176 If Length > 0 and Destination is NULL, then ASSERT().
177 If Length > 0 and Destination is not aligned on a 16-bit boundary, then ASSERT().
178 If Length > 0 and Source is NULL, then ASSERT().
179 If Length > 0 and Source is not aligned on a 16-bit bounadry, then ASSERT().
180 If Source and Destination overlap, then ASSERT().
181 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
182 PcdMaximumUnicodeStringLength Unicode characters not including the
183 Null-terminator, then ASSERT().
185 @param Destination Pointer to a Null-terminated Unicode string.
186 @param Source Pointer to a Null-terminated Unicode string.
187 @param Length Maximum number of Unicode characters to copy.
195 OUT CHAR16
*Destination
,
196 IN CONST CHAR16
*Source
,
202 Returns the length of a Null-terminated Unicode string.
204 This function returns the number of Unicode characters in the Null-terminated
205 Unicode string specified by String.
207 If String is NULL, then ASSERT().
208 If String is not aligned on a 16-bit boundary, then ASSERT().
209 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
210 PcdMaximumUnicodeStringLength Unicode characters not including the
211 Null-terminator, then ASSERT().
213 @param String Pointer to a Null-terminated Unicode string.
215 @return The length of String.
221 IN CONST CHAR16
*String
226 Returns the size of a Null-terminated Unicode string in bytes, including the
229 This function returns the size, in bytes, of the Null-terminated Unicode
230 string specified by String.
232 If String is NULL, then ASSERT().
233 If String is not aligned on a 16-bit boundary, then ASSERT().
234 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
235 PcdMaximumUnicodeStringLength Unicode characters not including the
236 Null-terminator, then ASSERT().
238 @param String Pointer to a Null-terminated Unicode string.
240 @return The size of String.
246 IN CONST CHAR16
*String
251 Compares two Null-terminated Unicode strings, and returns the difference
252 between the first mismatched Unicode characters.
254 This function compares the Null-terminated Unicode string FirstString to the
255 Null-terminated Unicode string SecondString. If FirstString is identical to
256 SecondString, then 0 is returned. Otherwise, the value returned is the first
257 mismatched Unicode character in SecondString subtracted from the first
258 mismatched Unicode character in FirstString.
260 If FirstString is NULL, then ASSERT().
261 If FirstString is not aligned on a 16-bit boundary, then ASSERT().
262 If SecondString is NULL, then ASSERT().
263 If SecondString is not aligned on a 16-bit boundary, then ASSERT().
264 If PcdMaximumUnicodeStringLength is not zero, and FirstString contains more
265 than PcdMaximumUnicodeStringLength Unicode characters not including the
266 Null-terminator, then ASSERT().
267 If PcdMaximumUnicodeStringLength is not zero, and SecondString contains more
268 than PcdMaximumUnicodeStringLength Unicode characters not including the
269 Null-terminator, then ASSERT().
271 @param FirstString Pointer to a Null-terminated Unicode string.
272 @param SecondString Pointer to a Null-terminated Unicode string.
274 @retval 0 FirstString is identical to SecondString.
275 @retval !=0 FirstString is not identical to SecondString.
281 IN CONST CHAR16
*FirstString
,
282 IN CONST CHAR16
*SecondString
287 Compares two Null-terminated Unicode strings with maximum lengths, and
288 returns the difference between the first mismatched Unicode characters.
290 This function compares the Null-terminated Unicode string FirstString to the
291 Null-terminated Unicode string SecondString. At most, Length Unicode
292 characters will be compared. If Length is 0, then 0 is returned. If
293 FirstString is identical to SecondString, then 0 is returned. Otherwise, the
294 value returned is the first mismatched Unicode character in SecondString
295 subtracted from the first mismatched Unicode character in FirstString.
297 If Length > 0 and FirstString is NULL, then ASSERT().
298 If Length > 0 and FirstString is not aligned on a 16-bit bounadary, then ASSERT().
299 If Length > 0 and SecondString is NULL, then ASSERT().
300 If Length > 0 and SecondString is not aligned on a 16-bit bounadary, then ASSERT().
301 If PcdMaximumUnicodeStringLength is not zero, and FirstString contains more
302 than PcdMaximumUnicodeStringLength Unicode characters not including the
303 Null-terminator, then ASSERT().
304 If PcdMaximumUnicodeStringLength is not zero, and SecondString contains more
305 than PcdMaximumUnicodeStringLength Unicode characters not including the
306 Null-terminator, then ASSERT().
308 @param FirstString Pointer to a Null-terminated Unicode string.
309 @param SecondString Pointer to a Null-terminated Unicode string.
310 @param Length Maximum number of Unicode characters to compare.
312 @retval 0 FirstString is identical to SecondString.
313 @retval !=0 FirstString is not identical to SecondString.
319 IN CONST CHAR16
*FirstString
,
320 IN CONST CHAR16
*SecondString
,
326 Concatenates one Null-terminated Unicode string to another Null-terminated
327 Unicode string, and returns the concatenated Unicode string.
329 This function concatenates two Null-terminated Unicode strings. The contents
330 of Null-terminated Unicode string Source are concatenated to the end of
331 Null-terminated Unicode string Destination. The Null-terminated concatenated
332 Unicode String is returned. If Source and Destination overlap, then the
333 results are undefined.
335 If Destination is NULL, then ASSERT().
336 If Destination is not aligned on a 16-bit bounadary, then ASSERT().
337 If Source is NULL, then ASSERT().
338 If Source is not aligned on a 16-bit bounadary, then ASSERT().
339 If Source and Destination overlap, then ASSERT().
340 If PcdMaximumUnicodeStringLength is not zero, and Destination contains more
341 than PcdMaximumUnicodeStringLength Unicode characters not including the
342 Null-terminator, then ASSERT().
343 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
344 PcdMaximumUnicodeStringLength Unicode characters not including the
345 Null-terminator, then ASSERT().
346 If PcdMaximumUnicodeStringLength is not zero, and concatenating Destination
347 and Source results in a Unicode string with more than
348 PcdMaximumUnicodeStringLength Unicode characters not including the
349 Null-terminator, then ASSERT().
351 @param Destination Pointer to a Null-terminated Unicode string.
352 @param Source Pointer to a Null-terminated Unicode string.
360 IN OUT CHAR16
*Destination
,
361 IN CONST CHAR16
*Source
366 Concatenates one Null-terminated Unicode string with a maximum length to the
367 end of another Null-terminated Unicode string, and returns the concatenated
370 This function concatenates two Null-terminated Unicode strings. The contents
371 of Null-terminated Unicode string Source are concatenated to the end of
372 Null-terminated Unicode string Destination, and Destination is returned. At
373 most, Length Unicode characters are concatenated from Source to the end of
374 Destination, and Destination is always Null-terminated. If Length is 0, then
375 Destination is returned unmodified. If Source and Destination overlap, then
376 the results are undefined.
378 If Destination is NULL, then ASSERT().
379 If Length > 0 and Destination is not aligned on a 16-bit boundary, then ASSERT().
380 If Length > 0 and Source is NULL, then ASSERT().
381 If Length > 0 and Source is not aligned on a 16-bit boundary, then ASSERT().
382 If Source and Destination overlap, then ASSERT().
383 If PcdMaximumUnicodeStringLength is not zero, and Destination contains more
384 than PcdMaximumUnicodeStringLength Unicode characters not including the
385 Null-terminator, then ASSERT().
386 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
387 PcdMaximumUnicodeStringLength Unicode characters not including the
388 Null-terminator, then ASSERT().
389 If PcdMaximumUnicodeStringLength is not zero, and concatenating Destination
390 and Source results in a Unicode string with more than
391 PcdMaximumUnicodeStringLength Unicode characters not including the
392 Null-terminator, then ASSERT().
394 @param Destination Pointer to a Null-terminated Unicode string.
395 @param Source Pointer to a Null-terminated Unicode string.
396 @param Length Maximum number of Unicode characters to concatenate from
405 IN OUT CHAR16
*Destination
,
406 IN CONST CHAR16
*Source
,
411 Returns the first occurance of a Null-terminated Unicode sub-string
412 in a Null-terminated Unicode string.
414 This function scans the contents of the Null-terminated Unicode string
415 specified by String and returns the first occurrence of SearchString.
416 If SearchString is not found in String, then NULL is returned. If
417 the length of SearchString is zero, then String is
420 If String is NULL, then ASSERT().
421 If String is not aligned on a 16-bit boundary, then ASSERT().
422 If SearchString is NULL, then ASSERT().
423 If SearchString is not aligned on a 16-bit boundary, then ASSERT().
425 If PcdMaximumUnicodeStringLength is not zero, and SearchString
426 or String contains more than PcdMaximumUnicodeStringLength Unicode
427 characters not including the Null-terminator, then ASSERT().
429 @param String Pointer to a Null-terminated Unicode string.
430 @param SearchString Pointer to a Null-terminated Unicode string to search for.
432 @retval NULL If the SearchString does not appear in String.
433 @retval !NULL If there is a match.
439 IN CONST CHAR16
*String
,
440 IN CONST CHAR16
*SearchString
444 Convert a Null-terminated Unicode decimal string to a value of
447 This function returns a value of type UINTN by interpreting the contents
448 of the Unicode string specified by String as a decimal number. The format
449 of the input Unicode string String is:
451 [spaces] [decimal digits].
453 The valid decimal digit character is in the range [0-9]. The
454 function will ignore the pad space, which includes spaces or
455 tab characters, before [decimal digits]. The running zero in the
456 beginning of [decimal digits] will be ignored. Then, the function
457 stops at the first character that is a not a valid decimal character
458 or a Null-terminator, whichever one comes first.
460 If String is NULL, then ASSERT().
461 If String is not aligned in a 16-bit boundary, then ASSERT().
462 If String has only pad spaces, then 0 is returned.
463 If String has no pad spaces or valid decimal digits,
465 If the number represented by String overflows according
466 to the range defined by UINTN, then ASSERT().
468 If PcdMaximumUnicodeStringLength is not zero, and String contains
469 more than PcdMaximumUnicodeStringLength Unicode characters not including
470 the Null-terminator, then ASSERT().
472 @param String Pointer to a Null-terminated Unicode string.
474 @retval Value translated from String.
480 IN CONST CHAR16
*String
484 Convert a Null-terminated Unicode decimal string to a value of
487 This function returns a value of type UINT64 by interpreting the contents
488 of the Unicode string specified by String as a decimal number. The format
489 of the input Unicode string String is:
491 [spaces] [decimal digits].
493 The valid decimal digit character is in the range [0-9]. The
494 function will ignore the pad space, which includes spaces or
495 tab characters, before [decimal digits]. The running zero in the
496 beginning of [decimal digits] will be ignored. Then, the function
497 stops at the first character that is a not a valid decimal character
498 or a Null-terminator, whichever one comes first.
500 If String is NULL, then ASSERT().
501 If String is not aligned in a 16-bit boundary, then ASSERT().
502 If String has only pad spaces, then 0 is returned.
503 If String has no pad spaces or valid decimal digits,
505 If the number represented by String overflows according
506 to the range defined by UINT64, then ASSERT().
508 If PcdMaximumUnicodeStringLength is not zero, and String contains
509 more than PcdMaximumUnicodeStringLength Unicode characters not including
510 the Null-terminator, then ASSERT().
512 @param String Pointer to a Null-terminated Unicode string.
514 @retval Value translated from String.
520 IN CONST CHAR16
*String
525 Convert a Null-terminated Unicode hexadecimal string to a value of type UINTN.
527 This function returns a value of type UINTN by interpreting the contents
528 of the Unicode string specified by String as a hexadecimal number.
529 The format of the input Unicode string String is:
531 [spaces][zeros][x][hexadecimal digits].
533 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
534 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix.
535 If "x" appears in the input string, it must be prefixed with at least one 0.
536 The function will ignore the pad space, which includes spaces or tab characters,
537 before [zeros], [x] or [hexadecimal digit]. The running zero before [x] or
538 [hexadecimal digit] will be ignored. Then, the decoding starts after [x] or the
539 first valid hexadecimal digit. Then, the function stops at the first character that is
540 a not a valid hexadecimal character or NULL, whichever one comes first.
542 If String is NULL, then ASSERT().
543 If String is not aligned in a 16-bit boundary, then ASSERT().
544 If String has only pad spaces, then zero is returned.
545 If String has no leading pad spaces, leading zeros or valid hexadecimal digits,
546 then zero is returned.
547 If the number represented by String overflows according to the range defined by
548 UINTN, then ASSERT().
550 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
551 PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator,
554 @param String Pointer to a Null-terminated Unicode string.
556 @retval Value translated from String.
562 IN CONST CHAR16
*String
567 Convert a Null-terminated Unicode hexadecimal string to a value of type UINT64.
569 This function returns a value of type UINT64 by interpreting the contents
570 of the Unicode string specified by String as a hexadecimal number.
571 The format of the input Unicode string String is
573 [spaces][zeros][x][hexadecimal digits].
575 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
576 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix.
577 If "x" appears in the input string, it must be prefixed with at least one 0.
578 The function will ignore the pad space, which includes spaces or tab characters,
579 before [zeros], [x] or [hexadecimal digit]. The running zero before [x] or
580 [hexadecimal digit] will be ignored. Then, the decoding starts after [x] or the
581 first valid hexadecimal digit. Then, the function stops at the first character that is
582 a not a valid hexadecimal character or NULL, whichever one comes first.
584 If String is NULL, then ASSERT().
585 If String is not aligned in a 16-bit boundary, then ASSERT().
586 If String has only pad spaces, then zero is returned.
587 If String has no leading pad spaces, leading zeros or valid hexadecimal digits,
588 then zero is returned.
589 If the number represented by String overflows according to the range defined by
590 UINT64, then ASSERT().
592 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
593 PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator,
596 @param String Pointer to a Null-terminated Unicode string.
598 @retval Value translated from String.
604 IN CONST CHAR16
*String
608 Convert a nibble in the low 4 bits of a byte to a Unicode hexadecimal character.
610 This function converts a nibble in the low 4 bits of a byte to a Unicode hexadecimal
611 character For example, the nibble 0x01 and 0x0A will converted to L'1' and L'A'
614 The upper nibble in the input byte will be masked off.
616 @param Nibble The nibble which is in the low 4 bits of the input byte.
618 @retval CHAR16 The Unicode hexadecimal character.
629 Convert binary buffer to a Unicode String in a specified sequence.
631 This function converts bytes in the binary Buffer Buf to a Unicode String Str.
632 Each byte will be represented by two Unicode characters. For example, byte 0xA1 will
633 be converted into two Unicode character L'A' and L'1'. In the output String, the Unicode Character
634 for the Most Significant Nibble will be put before the Unicode Character for the Least Significant
635 Nibble. The output string for the buffer containing a single byte 0xA1 will be L"A1".
636 For a buffer with multiple bytes, the Unicode character produced by the first byte will be put into the
637 the last character in the output string. The one next to first byte will be put into the
638 character before the last character. This rules applies to the rest of the bytes. The Unicode
639 character by the last byte will be put into the first character in the output string. For example,
640 the input buffer for a 64-bits unsigned integrer 0x12345678abcdef1234 will be converted to
641 a Unicode string equal to L"12345678abcdef1234".
643 @param String On input, String is pointed to the buffer allocated for the convertion.
644 @param StringLen The Length of String buffer to hold the output String. The length must include the tailing '\0' character.
645 The StringLen required to convert a N bytes Buffer will be a least equal to or greater
647 @param Buffer The pointer to a input buffer.
648 @param BufferSizeInBytes Lenth in bytes of the input buffer.
651 @retval EFI_SUCCESS The convertion is successfull. All bytes in Buffer has been convert to the corresponding
652 Unicode character and placed into the right place in String.
653 @retval EFI_BUFFER_TOO_SMALL StringSizeInBytes is smaller than 2 * N + 1the number of bytes required to
654 complete the convertion.
659 IN OUT CHAR16
*String
,
660 IN OUT UINTN
*StringLen
,
661 IN CONST UINT8
*Buffer
,
662 IN UINTN BufferSizeInBytes
668 Convert a Unicode string consisting of hexadecimal characters to a output byte buffer.
670 This function converts a Unicode string consisting of characters in the range of Hexadecimal
671 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
672 at the first non-hexadecimal character or the NULL character. The convertion process can be
673 simply viewed as the reverse operations defined by BufToHexString. Two Unicode characters will be
674 converted into one byte. The first Unicode character represents the Most Significant Nibble and the
675 second Unicode character represents the Least Significant Nibble in the output byte.
676 The first pair of Unicode characters represents the last byte in the output buffer. The second pair of Unicode
677 characters represent the the byte preceding the last byte. This rule applies to the rest pairs of bytes.
678 The last pair represent the first byte in the output buffer.
680 For example, a Unciode String L"12345678" will be converted into a buffer wil the following bytes
681 (first byte is the byte in the lowest memory address): "0x78, 0x56, 0x34, 0x12".
683 If String has N valid hexadecimal characters for conversion, the caller must make sure Buffer is at least
684 N/2 (if N is even) or (N+1)/2 (if N if odd) bytes.
686 @param Buffer The output buffer allocated by the caller.
687 @param BufferSizeInBytes On input, the size in bytes of Buffer. On output, it is updated to
688 contain the size of the Buffer which is actually used for the converstion.
689 For Unicode string with 2*N hexadecimal characters (not including the
690 tailing NULL character), N bytes of Buffer will be used for the output.
691 @param String The input hexadecimal string.
692 @param ConvertedStrLen The number of hexadecimal characters used to produce content in output
695 @retval RETURN_BUFFER_TOO_SMALL The input BufferSizeInBytes is too small to hold the output. BufferSizeInBytes
696 will be updated to the size required for the converstion.
697 @retval RETURN_SUCCESS The convertion is successful or the first Unicode character from String
698 is hexadecimal. If ConvertedStrLen is not NULL, it is updated
699 to the number of hexadecimal character used for the converstion.
705 IN OUT UINTN
*BufferSizeInBytes
,
706 IN CONST CHAR16
*String
,
707 OUT UINTN
*ConvertedStrLen OPTIONAL
713 Test if a Unicode character is a hexadecimal digit. If true, the input
714 Unicode character is converted to a byte.
716 This function tests if a Unicode character is a hexadecimal digit. If true, the input
717 Unicode character is converted to a byte. For example, Unicode character
718 L'A' will be converted to 0x0A.
720 If Digit is NULL, then ASSERT.
722 @retval TRUE Char is in the range of Hexadecimal number. Digit is updated
723 to the byte value of the number.
724 @retval FALSE Char is not in the range of Hexadecimal number. Digit is keep
737 Convert one Null-terminated Unicode string to a Null-terminated
738 ASCII string and returns the ASCII string.
740 This function converts the content of the Unicode string Source
741 to the ASCII string Destination by copying the lower 8 bits of
742 each Unicode character. It returns Destination.
744 If any Unicode characters in Source contain non-zero value in
745 the upper 8 bits, then ASSERT().
747 If Destination is NULL, then ASSERT().
748 If Source is NULL, then ASSERT().
749 If Source is not aligned on a 16-bit boundary, then ASSERT().
750 If Source and Destination overlap, then ASSERT().
752 If PcdMaximumUnicodeStringLength is not zero, and Source contains
753 more than PcdMaximumUnicodeStringLength Unicode characters not including
754 the Null-terminator, then ASSERT().
756 If PcdMaximumAsciiStringLength is not zero, and Source contains more
757 than PcdMaximumAsciiStringLength Unicode characters not including the
758 Null-terminator, then ASSERT().
760 @param Source Pointer to a Null-terminated Unicode string.
761 @param Destination Pointer to a Null-terminated ASCII string.
768 UnicodeStrToAsciiStr (
769 IN CONST CHAR16
*Source
,
770 OUT CHAR8
*Destination
775 Copies one Null-terminated ASCII string to another Null-terminated ASCII
776 string and returns the new ASCII string.
778 This function copies the contents of the ASCII string Source to the ASCII
779 string Destination, and returns Destination. If Source and Destination
780 overlap, then the results are undefined.
782 If Destination is NULL, then ASSERT().
783 If Source is NULL, then ASSERT().
784 If Source and Destination overlap, then ASSERT().
785 If PcdMaximumAsciiStringLength is not zero and Source contains more than
786 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
789 @param Destination Pointer to a Null-terminated ASCII string.
790 @param Source Pointer to a Null-terminated ASCII string.
798 OUT CHAR8
*Destination
,
799 IN CONST CHAR8
*Source
804 Copies one Null-terminated ASCII string with a maximum length to another
805 Null-terminated ASCII string with a maximum length and returns the new ASCII
808 This function copies the contents of the ASCII string Source to the ASCII
809 string Destination, and returns Destination. At most, Length ASCII characters
810 are copied from Source to Destination. If Length is 0, then Destination is
811 returned unmodified. If Length is greater that the number of ASCII characters
812 in Source, then Destination is padded with Null ASCII characters. If Source
813 and Destination overlap, then the results are undefined.
815 If Destination is NULL, then ASSERT().
816 If Source is NULL, then ASSERT().
817 If Source and Destination overlap, then ASSERT().
818 If PcdMaximumAsciiStringLength is not zero, and Source contains more than
819 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
822 @param Destination Pointer to a Null-terminated ASCII string.
823 @param Source Pointer to a Null-terminated ASCII string.
824 @param Length Maximum number of ASCII characters to copy.
832 OUT CHAR8
*Destination
,
833 IN CONST CHAR8
*Source
,
839 Returns the length of a Null-terminated ASCII string.
841 This function returns the number of ASCII characters in the Null-terminated
842 ASCII string specified by String.
844 If Length > 0 and Destination is NULL, then ASSERT().
845 If Length > 0 and Source is NULL, then ASSERT().
846 If PcdMaximumAsciiStringLength is not zero and String contains more than
847 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
850 @param String Pointer to a Null-terminated ASCII string.
852 @return The length of String.
858 IN CONST CHAR8
*String
863 Returns the size of a Null-terminated ASCII string in bytes, including the
866 This function returns the size, in bytes, of the Null-terminated ASCII string
869 If String is NULL, then ASSERT().
870 If PcdMaximumAsciiStringLength is not zero and String contains more than
871 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
874 @param String Pointer to a Null-terminated ASCII string.
876 @return The size of String.
882 IN CONST CHAR8
*String
887 Compares two Null-terminated ASCII strings, and returns the difference
888 between the first mismatched ASCII characters.
890 This function compares the Null-terminated ASCII string FirstString to the
891 Null-terminated ASCII string SecondString. If FirstString is identical to
892 SecondString, then 0 is returned. Otherwise, the value returned is the first
893 mismatched ASCII character in SecondString subtracted from the first
894 mismatched ASCII character in FirstString.
896 If FirstString is NULL, then ASSERT().
897 If SecondString is NULL, then ASSERT().
898 If PcdMaximumAsciiStringLength is not zero and FirstString contains more than
899 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
901 If PcdMaximumAsciiStringLength is not zero and SecondString contains more
902 than PcdMaximumAsciiStringLength ASCII characters not including the
903 Null-terminator, then ASSERT().
905 @param FirstString Pointer to a Null-terminated ASCII string.
906 @param SecondString Pointer to a Null-terminated ASCII string.
908 @retval 0 FirstString is identical to SecondString.
909 @retval !=0 FirstString is not identical to SecondString.
915 IN CONST CHAR8
*FirstString
,
916 IN CONST CHAR8
*SecondString
921 Performs a case insensitive comparison of two Null-terminated ASCII strings,
922 and returns the difference between the first mismatched ASCII characters.
924 This function performs a case insensitive comparison of the Null-terminated
925 ASCII string FirstString to the Null-terminated ASCII string SecondString. If
926 FirstString is identical to SecondString, then 0 is returned. Otherwise, the
927 value returned is the first mismatched lower case ASCII character in
928 SecondString subtracted from the first mismatched lower case ASCII character
931 If FirstString is NULL, then ASSERT().
932 If SecondString is NULL, then ASSERT().
933 If PcdMaximumAsciiStringLength is not zero and FirstString contains more than
934 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
936 If PcdMaximumAsciiStringLength is not zero and SecondString contains more
937 than PcdMaximumAsciiStringLength ASCII characters not including the
938 Null-terminator, then ASSERT().
940 @param FirstString Pointer to a Null-terminated ASCII string.
941 @param SecondString Pointer to a Null-terminated ASCII string.
943 @retval 0 FirstString is identical to SecondString using case insensitive
945 @retval !=0 FirstString is not identical to SecondString using case
946 insensitive comparisons.
952 IN CONST CHAR8
*FirstString
,
953 IN CONST CHAR8
*SecondString
958 Compares two Null-terminated ASCII strings with maximum lengths, and returns
959 the difference between the first mismatched ASCII characters.
961 This function compares the Null-terminated ASCII string FirstString to the
962 Null-terminated ASCII string SecondString. At most, Length ASCII characters
963 will be compared. If Length is 0, then 0 is returned. If FirstString is
964 identical to SecondString, then 0 is returned. Otherwise, the value returned
965 is the first mismatched ASCII character in SecondString subtracted from the
966 first mismatched ASCII character in FirstString.
968 If Length > 0 and FirstString is NULL, then ASSERT().
969 If Length > 0 and SecondString is NULL, then ASSERT().
970 If PcdMaximumAsciiStringLength is not zero and FirstString contains more than
971 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
973 If PcdMaximumAsciiStringLength is not zero and SecondString contains more than
974 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
977 @param FirstString Pointer to a Null-terminated ASCII string.
978 @param SecondString Pointer to a Null-terminated ASCII string.
979 @param Length Maximum number of ASCII characters for compare.
981 @retval 0 FirstString is identical to SecondString.
982 @retval !=0 FirstString is not identical to SecondString.
988 IN CONST CHAR8
*FirstString
,
989 IN CONST CHAR8
*SecondString
,
995 Concatenates one Null-terminated ASCII string to another Null-terminated
996 ASCII string, and returns the concatenated ASCII string.
998 This function concatenates two Null-terminated ASCII strings. The contents of
999 Null-terminated ASCII string Source are concatenated to the end of Null-
1000 terminated ASCII string Destination. The Null-terminated concatenated ASCII
1003 If Destination is NULL, then ASSERT().
1004 If Source is NULL, then ASSERT().
1005 If PcdMaximumAsciiStringLength is not zero and Destination contains more than
1006 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
1008 If PcdMaximumAsciiStringLength is not zero and Source contains more than
1009 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
1011 If PcdMaximumAsciiStringLength is not zero and concatenating Destination and
1012 Source results in a ASCII string with more than PcdMaximumAsciiStringLength
1013 ASCII characters, then ASSERT().
1015 @param Destination Pointer to a Null-terminated ASCII string.
1016 @param Source Pointer to a Null-terminated ASCII string.
1024 IN OUT CHAR8
*Destination
,
1025 IN CONST CHAR8
*Source
1030 Concatenates one Null-terminated ASCII string with a maximum length to the
1031 end of another Null-terminated ASCII string, and returns the concatenated
1034 This function concatenates two Null-terminated ASCII strings. The contents
1035 of Null-terminated ASCII string Source are concatenated to the end of Null-
1036 terminated ASCII string Destination, and Destination is returned. At most,
1037 Length ASCII characters are concatenated from Source to the end of
1038 Destination, and Destination is always Null-terminated. If Length is 0, then
1039 Destination is returned unmodified. If Source and Destination overlap, then
1040 the results are undefined.
1042 If Length > 0 and Destination is NULL, then ASSERT().
1043 If Length > 0 and Source is NULL, then ASSERT().
1044 If Source and Destination overlap, then ASSERT().
1045 If PcdMaximumAsciiStringLength is not zero, and Destination contains more than
1046 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
1048 If PcdMaximumAsciiStringLength is not zero, and Source contains more than
1049 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
1051 If PcdMaximumAsciiStringLength is not zero, and concatenating Destination and
1052 Source results in a ASCII string with more than PcdMaximumAsciiStringLength
1053 ASCII characters not including the Null-terminator, then ASSERT().
1055 @param Destination Pointer to a Null-terminated ASCII string.
1056 @param Source Pointer to a Null-terminated ASCII string.
1057 @param Length Maximum number of ASCII characters to concatenate from
1066 IN OUT CHAR8
*Destination
,
1067 IN CONST CHAR8
*Source
,
1073 Returns the first occurance of a Null-terminated ASCII sub-string
1074 in a Null-terminated ASCII string.
1076 This function scans the contents of the ASCII string specified by String
1077 and returns the first occurrence of SearchString. If SearchString is not
1078 found in String, then NULL is returned. If the length of SearchString is zero,
1079 then String is returned.
1081 If String is NULL, then ASSERT().
1082 If SearchString is NULL, then ASSERT().
1084 If PcdMaximumAsciiStringLength is not zero, and SearchString or
1085 String contains more than PcdMaximumAsciiStringLength Unicode characters
1086 not including the Null-terminator, then ASSERT().
1088 @param String Pointer to a Null-terminated ASCII string.
1089 @param SearchString Pointer to a Null-terminated ASCII string to search for.
1091 @retval NULL If the SearchString does not appear in String.
1092 @retval !NULL If there is a match.
1098 IN CONST CHAR8
*String
,
1099 IN CONST CHAR8
*SearchString
1104 Convert a Null-terminated ASCII decimal string to a value of type
1107 This function returns a value of type UINTN by interpreting the contents
1108 of the ASCII string String as a decimal number. The format of the input
1109 ASCII string String is:
1111 [spaces] [decimal digits].
1113 The valid decimal digit character is in the range [0-9]. The function will
1114 ignore the pad space, which includes spaces or tab characters, before the digits.
1115 The running zero in the beginning of [decimal digits] will be ignored. Then, the
1116 function stops at the first character that is a not a valid decimal character or
1117 Null-terminator, whichever on comes first.
1119 If String has only pad spaces, then 0 is returned.
1120 If String has no pad spaces or valid decimal digits, then 0 is returned.
1121 If the number represented by String overflows according to the range defined by
1122 UINTN, then ASSERT().
1123 If String is NULL, then ASSERT().
1124 If PcdMaximumAsciiStringLength is not zero, and String contains more than
1125 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
1128 @param String Pointer to a Null-terminated ASCII string.
1130 @retval Value translated from String.
1135 AsciiStrDecimalToUintn (
1136 IN CONST CHAR8
*String
1141 Convert a Null-terminated ASCII decimal string to a value of type
1144 This function returns a value of type UINT64 by interpreting the contents
1145 of the ASCII string String as a decimal number. The format of the input
1146 ASCII string String is:
1148 [spaces] [decimal digits].
1150 The valid decimal digit character is in the range [0-9]. The function will
1151 ignore the pad space, which includes spaces or tab characters, before the digits.
1152 The running zero in the beginning of [decimal digits] will be ignored. Then, the
1153 function stops at the first character that is a not a valid decimal character or
1154 Null-terminator, whichever on comes first.
1156 If String has only pad spaces, then 0 is returned.
1157 If String has no pad spaces or valid decimal digits, then 0 is returned.
1158 If the number represented by String overflows according to the range defined by
1159 UINT64, then ASSERT().
1160 If String is NULL, then ASSERT().
1161 If PcdMaximumAsciiStringLength is not zero, and String contains more than
1162 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
1165 @param String Pointer to a Null-terminated ASCII string.
1167 @retval Value translated from String.
1172 AsciiStrDecimalToUint64 (
1173 IN CONST CHAR8
*String
1178 Convert a Null-terminated ASCII hexadecimal string to a value of type UINTN.
1180 This function returns a value of type UINTN by interpreting the contents of
1181 the ASCII string String as a hexadecimal number. The format of the input ASCII
1184 [spaces][zeros][x][hexadecimal digits].
1186 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
1187 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix. If "x"
1188 appears in the input string, it must be prefixed with at least one 0. The function
1189 will ignore the pad space, which includes spaces or tab characters, before [zeros],
1190 [x] or [hexadecimal digits]. The running zero before [x] or [hexadecimal digits]
1191 will be ignored. Then, the decoding starts after [x] or the first valid hexadecimal
1192 digit. Then, the function stops at the first character that is a not a valid
1193 hexadecimal character or Null-terminator, whichever on comes first.
1195 If String has only pad spaces, then 0 is returned.
1196 If String has no leading pad spaces, leading zeros or valid hexadecimal digits, then
1199 If the number represented by String overflows according to the range defined by UINTN,
1201 If String is NULL, then ASSERT().
1202 If PcdMaximumAsciiStringLength is not zero,
1203 and String contains more than PcdMaximumAsciiStringLength ASCII characters not including
1204 the Null-terminator, then ASSERT().
1206 @param String Pointer to a Null-terminated ASCII string.
1208 @retval Value translated from String.
1213 AsciiStrHexToUintn (
1214 IN CONST CHAR8
*String
1219 Convert a Null-terminated ASCII hexadecimal string to a value of type UINT64.
1221 This function returns a value of type UINT64 by interpreting the contents of
1222 the ASCII string String as a hexadecimal number. The format of the input ASCII
1225 [spaces][zeros][x][hexadecimal digits].
1227 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
1228 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix. If "x"
1229 appears in the input string, it must be prefixed with at least one 0. The function
1230 will ignore the pad space, which includes spaces or tab characters, before [zeros],
1231 [x] or [hexadecimal digits]. The running zero before [x] or [hexadecimal digits]
1232 will be ignored. Then, the decoding starts after [x] or the first valid hexadecimal
1233 digit. Then, the function stops at the first character that is a not a valid
1234 hexadecimal character or Null-terminator, whichever on comes first.
1236 If String has only pad spaces, then 0 is returned.
1237 If String has no leading pad spaces, leading zeros or valid hexadecimal digits, then
1240 If the number represented by String overflows according to the range defined by UINT64,
1242 If String is NULL, then ASSERT().
1243 If PcdMaximumAsciiStringLength is not zero,
1244 and String contains more than PcdMaximumAsciiStringLength ASCII characters not including
1245 the Null-terminator, then ASSERT().
1247 @param String Pointer to a Null-terminated ASCII string.
1249 @retval Value translated from String.
1254 AsciiStrHexToUint64 (
1255 IN CONST CHAR8
*String
1260 Convert one Null-terminated ASCII string to a Null-terminated
1261 Unicode string and returns the Unicode string.
1263 This function converts the contents of the ASCII string Source to the Unicode
1264 string Destination, and returns Destination. The function terminates the
1265 Unicode string Destination by appending a Null-terminator character at the end.
1266 The caller is responsible to make sure Destination points to a buffer with size
1267 equal or greater than ((AsciiStrLen (Source) + 1) * sizeof (CHAR16)) in bytes.
1269 If Destination is NULL, then ASSERT().
1270 If Destination is not aligned on a 16-bit boundary, then ASSERT().
1271 If Source is NULL, then ASSERT().
1272 If Source and Destination overlap, then ASSERT().
1273 If PcdMaximumAsciiStringLength is not zero, and Source contains more than
1274 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
1276 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
1277 PcdMaximumUnicodeStringLength ASCII characters not including the
1278 Null-terminator, then ASSERT().
1280 @param Source Pointer to a Null-terminated ASCII string.
1281 @param Destination Pointer to a Null-terminated Unicode string.
1288 AsciiStrToUnicodeStr (
1289 IN CONST CHAR8
*Source
,
1290 OUT CHAR16
*Destination
1295 Converts an 8-bit value to an 8-bit BCD value.
1297 Converts the 8-bit value specified by Value to BCD. The BCD value is
1300 If Value >= 100, then ASSERT().
1302 @param Value The 8-bit value to convert to BCD. Range 0..99.
1304 @return The BCD value
1315 Converts an 8-bit BCD value to an 8-bit value.
1317 Converts the 8-bit BCD value specified by Value to an 8-bit value. The 8-bit
1320 If Value >= 0xA0, then ASSERT().
1321 If (Value & 0x0F) >= 0x0A, then ASSERT().
1323 @param Value The 8-bit BCD value to convert to an 8-bit value.
1325 @return The 8-bit value is returned.
1336 // Linked List Functions and Macros
1340 Initializes the head node of a doubly linked list that is declared as a
1341 global variable in a module.
1343 Initializes the forward and backward links of a new linked list. After
1344 initializing a linked list with this macro, the other linked list functions
1345 may be used to add and remove nodes from the linked list. This macro results
1346 in smaller executables by initializing the linked list in the data section,
1347 instead if calling the InitializeListHead() function to perform the
1348 equivalent operation.
1350 @param ListHead The head note of a list to initiailize.
1353 #define INITIALIZE_LIST_HEAD_VARIABLE(ListHead) {&ListHead, &ListHead}
1357 Initializes the head node of a doubly linked list, and returns the pointer to
1358 the head node of the doubly linked list.
1360 Initializes the forward and backward links of a new linked list. After
1361 initializing a linked list with this function, the other linked list
1362 functions may be used to add and remove nodes from the linked list. It is up
1363 to the caller of this function to allocate the memory for ListHead.
1365 If ListHead is NULL, then ASSERT().
1367 @param ListHead A pointer to the head node of a new doubly linked list.
1374 InitializeListHead (
1375 IN LIST_ENTRY
*ListHead
1380 Adds a node to the beginning of a doubly linked list, and returns the pointer
1381 to the head node of the doubly linked list.
1383 Adds the node Entry at the beginning of the doubly linked list denoted by
1384 ListHead, and returns ListHead.
1386 If ListHead is NULL, then ASSERT().
1387 If Entry is NULL, then ASSERT().
1388 If ListHead was not initialized with InitializeListHead(), then ASSERT().
1389 If PcdMaximumLinkedListLenth is not zero, and prior to insertion the number
1390 of nodes in ListHead, including the ListHead node, is greater than or
1391 equal to PcdMaximumLinkedListLength, then ASSERT().
1393 @param ListHead A pointer to the head node of a doubly linked list.
1394 @param Entry A pointer to a node that is to be inserted at the beginning
1395 of a doubly linked list.
1403 IN LIST_ENTRY
*ListHead
,
1404 IN LIST_ENTRY
*Entry
1409 Adds a node to the end of a doubly linked list, and returns the pointer to
1410 the head node of the doubly linked list.
1412 Adds the node Entry to the end of the doubly linked list denoted by ListHead,
1413 and returns ListHead.
1415 If ListHead is NULL, then ASSERT().
1416 If Entry is NULL, then ASSERT().
1417 If ListHead was not initialized with InitializeListHead(), then ASSERT().
1418 If PcdMaximumLinkedListLenth is not zero, and prior to insertion the number
1419 of nodes in ListHead, including the ListHead node, is greater than or
1420 equal to PcdMaximumLinkedListLength, then ASSERT().
1422 @param ListHead A pointer to the head node of a doubly linked list.
1423 @param Entry A pointer to a node that is to be added at the end of the
1432 IN LIST_ENTRY
*ListHead
,
1433 IN LIST_ENTRY
*Entry
1438 Retrieves the first node of a doubly linked list.
1440 Returns the first node of a doubly linked list. List must have been
1441 initialized with InitializeListHead(). If List is empty, then NULL is
1444 If List is NULL, then ASSERT().
1445 If List was not initialized with InitializeListHead(), then ASSERT().
1446 If PcdMaximumLinkedListLenth is not zero, and the number of nodes
1447 in List, including the List node, is greater than or equal to
1448 PcdMaximumLinkedListLength, then ASSERT().
1450 @param List A pointer to the head node of a doubly linked list.
1452 @return The first node of a doubly linked list.
1453 @retval NULL The list is empty.
1459 IN CONST LIST_ENTRY
*List
1464 Retrieves the next node of a doubly linked list.
1466 Returns the node of a doubly linked list that follows Node. List must have
1467 been initialized with InitializeListHead(). If List is empty, then List is
1470 If List is NULL, then ASSERT().
1471 If Node is NULL, then ASSERT().
1472 If List was not initialized with InitializeListHead(), then ASSERT().
1473 If PcdMaximumLinkedListLenth is not zero, and List contains more than
1474 PcdMaximumLinkedListLenth nodes, then ASSERT().
1475 If Node is not a node in List, then ASSERT().
1477 @param List A pointer to the head node of a doubly linked list.
1478 @param Node A pointer to a node in the doubly linked list.
1480 @return Pointer to the next node if one exists. Otherwise a null value which
1481 is actually List is returned.
1487 IN CONST LIST_ENTRY
*List
,
1488 IN CONST LIST_ENTRY
*Node
1493 Checks to see if a doubly linked list is empty or not.
1495 Checks to see if the doubly linked list is empty. If the linked list contains
1496 zero nodes, this function returns TRUE. Otherwise, it returns FALSE.
1498 If ListHead is NULL, then ASSERT().
1499 If ListHead was not initialized with InitializeListHead(), then ASSERT().
1500 If PcdMaximumLinkedListLenth is not zero, and the number of nodes
1501 in List, including the List node, is greater than or equal to
1502 PcdMaximumLinkedListLength, then ASSERT().
1504 @param ListHead A pointer to the head node of a doubly linked list.
1506 @retval TRUE The linked list is empty.
1507 @retval FALSE The linked list is not empty.
1513 IN CONST LIST_ENTRY
*ListHead
1518 Determines if a node in a doubly linked list is null.
1520 Returns FALSE if Node is one of the nodes in the doubly linked list specified
1521 by List. Otherwise, TRUE is returned. List must have been initialized with
1522 InitializeListHead().
1524 If List is NULL, then ASSERT().
1525 If Node is NULL, then ASSERT().
1526 If List was not initialized with InitializeListHead(), then ASSERT().
1527 If PcdMaximumLinkedListLenth is not zero, and the number of nodes
1528 in List, including the List node, is greater than or equal to
1529 PcdMaximumLinkedListLength, then ASSERT().
1530 If Node is not a node in List and Node is not equal to List, then ASSERT().
1532 @param List A pointer to the head node of a doubly linked list.
1533 @param Node A pointer to a node in the doubly linked list.
1535 @retval TRUE Node is one of the nodes in the doubly linked list.
1536 @retval FALSE Node is not one of the nodes in the doubly linked list.
1542 IN CONST LIST_ENTRY
*List
,
1543 IN CONST LIST_ENTRY
*Node
1548 Determines if a node the last node in a doubly linked list.
1550 Returns TRUE if Node is the last node in the doubly linked list specified by
1551 List. Otherwise, FALSE is returned. List must have been initialized with
1552 InitializeListHead().
1554 If List is NULL, then ASSERT().
1555 If Node is NULL, then ASSERT().
1556 If List was not initialized with InitializeListHead(), then ASSERT().
1557 If PcdMaximumLinkedListLenth is not zero, and the number of nodes
1558 in List, including the List node, is greater than or equal to
1559 PcdMaximumLinkedListLength, then ASSERT().
1560 If Node is not a node in List, then ASSERT().
1562 @param List A pointer to the head node of a doubly linked list.
1563 @param Node A pointer to a node in the doubly linked list.
1565 @retval TRUE Node is the last node in the linked list.
1566 @retval FALSE Node is not the last node in the linked list.
1572 IN CONST LIST_ENTRY
*List
,
1573 IN CONST LIST_ENTRY
*Node
1578 Swaps the location of two nodes in a doubly linked list, and returns the
1579 first node after the swap.
1581 If FirstEntry is identical to SecondEntry, then SecondEntry is returned.
1582 Otherwise, the location of the FirstEntry node is swapped with the location
1583 of the SecondEntry node in a doubly linked list. SecondEntry must be in the
1584 same double linked list as FirstEntry and that double linked list must have
1585 been initialized with InitializeListHead(). SecondEntry is returned after the
1588 If FirstEntry is NULL, then ASSERT().
1589 If SecondEntry is NULL, then ASSERT().
1590 If SecondEntry and FirstEntry are not in the same linked list, then ASSERT().
1591 If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
1592 linked list containing the FirstEntry and SecondEntry nodes, including
1593 the FirstEntry and SecondEntry nodes, is greater than or equal to
1594 PcdMaximumLinkedListLength, then ASSERT().
1596 @param FirstEntry A pointer to a node in a linked list.
1597 @param SecondEntry A pointer to another node in the same linked list.
1605 IN LIST_ENTRY
*FirstEntry
,
1606 IN LIST_ENTRY
*SecondEntry
1611 Removes a node from a doubly linked list, and returns the node that follows
1614 Removes the node Entry from a doubly linked list. It is up to the caller of
1615 this function to release the memory used by this node if that is required. On
1616 exit, the node following Entry in the doubly linked list is returned. If
1617 Entry is the only node in the linked list, then the head node of the linked
1620 If Entry is NULL, then ASSERT().
1621 If Entry is the head node of an empty list, then ASSERT().
1622 If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
1623 linked list containing Entry, including the Entry node, is greater than
1624 or equal to PcdMaximumLinkedListLength, then ASSERT().
1626 @param Entry A pointer to a node in a linked list
1634 IN CONST LIST_ENTRY
*Entry
1642 Shifts a 64-bit integer left between 0 and 63 bits. The low bits are filled
1643 with zeros. The shifted value is returned.
1645 This function shifts the 64-bit value Operand to the left by Count bits. The
1646 low Count bits are set to zero. The shifted value is returned.
1648 If Count is greater than 63, then ASSERT().
1650 @param Operand The 64-bit operand to shift left.
1651 @param Count The number of bits to shift left.
1653 @return Operand << Count
1665 Shifts a 64-bit integer right between 0 and 63 bits. This high bits are
1666 filled with zeros. The shifted value is returned.
1668 This function shifts the 64-bit value Operand to the right by Count bits. The
1669 high Count bits are set to zero. The shifted value is returned.
1671 If Count is greater than 63, then ASSERT().
1673 @param Operand The 64-bit operand to shift right.
1674 @param Count The number of bits to shift right.
1676 @return Operand >> Count
1688 Shifts a 64-bit integer right between 0 and 63 bits. The high bits are filled
1689 with original integer's bit 63. The shifted value is returned.
1691 This function shifts the 64-bit value Operand to the right by Count bits. The
1692 high Count bits are set to bit 63 of Operand. The shifted value is returned.
1694 If Count is greater than 63, then ASSERT().
1696 @param Operand The 64-bit operand to shift right.
1697 @param Count The number of bits to shift right.
1699 @return Operand >> Count
1711 Rotates a 32-bit integer left between 0 and 31 bits, filling the low bits
1712 with the high bits that were rotated.
1714 This function rotates the 32-bit value Operand to the left by Count bits. The
1715 low Count bits are fill with the high Count bits of Operand. The rotated
1718 If Count is greater than 31, then ASSERT().
1720 @param Operand The 32-bit operand to rotate left.
1721 @param Count The number of bits to rotate left.
1723 @return Operand <<< Count
1735 Rotates a 32-bit integer right between 0 and 31 bits, filling the high bits
1736 with the low bits that were rotated.
1738 This function rotates the 32-bit value Operand to the right by Count bits.
1739 The high Count bits are fill with the low Count bits of Operand. The rotated
1742 If Count is greater than 31, then ASSERT().
1744 @param Operand The 32-bit operand to rotate right.
1745 @param Count The number of bits to rotate right.
1747 @return Operand >>> Count
1759 Rotates a 64-bit integer left between 0 and 63 bits, filling the low bits
1760 with the high bits that were rotated.
1762 This function rotates the 64-bit value Operand to the left by Count bits. The
1763 low Count bits are fill with the high Count bits of Operand. The rotated
1766 If Count is greater than 63, then ASSERT().
1768 @param Operand The 64-bit operand to rotate left.
1769 @param Count The number of bits to rotate left.
1771 @return Operand <<< Count
1783 Rotates a 64-bit integer right between 0 and 63 bits, filling the high bits
1784 with the high low bits that were rotated.
1786 This function rotates the 64-bit value Operand to the right by Count bits.
1787 The high Count bits are fill with the low Count bits of Operand. The rotated
1790 If Count is greater than 63, then ASSERT().
1792 @param Operand The 64-bit operand to rotate right.
1793 @param Count The number of bits to rotate right.
1795 @return Operand >>> Count
1807 Returns the bit position of the lowest bit set in a 32-bit value.
1809 This function computes the bit position of the lowest bit set in the 32-bit
1810 value specified by Operand. If Operand is zero, then -1 is returned.
1811 Otherwise, a value between 0 and 31 is returned.
1813 @param Operand The 32-bit operand to evaluate.
1815 @return Position of the lowest bit set in Operand if found.
1816 @retval -1 Operand is zero.
1827 Returns the bit position of the lowest bit set in a 64-bit value.
1829 This function computes the bit position of the lowest bit set in the 64-bit
1830 value specified by Operand. If Operand is zero, then -1 is returned.
1831 Otherwise, a value between 0 and 63 is returned.
1833 @param Operand The 64-bit operand to evaluate.
1835 @return Position of the lowest bit set in Operand if found.
1836 @retval -1 Operand is zero.
1847 Returns the bit position of the highest bit set in a 32-bit value. Equivalent
1850 This function computes the bit position of the highest bit set in the 32-bit
1851 value specified by Operand. If Operand is zero, then -1 is returned.
1852 Otherwise, a value between 0 and 31 is returned.
1854 @param Operand The 32-bit operand to evaluate.
1856 @return Position of the highest bit set in Operand if found.
1857 @retval -1 Operand is zero.
1868 Returns the bit position of the highest bit set in a 64-bit value. Equivalent
1871 This function computes the bit position of the highest bit set in the 64-bit
1872 value specified by Operand. If Operand is zero, then -1 is returned.
1873 Otherwise, a value between 0 and 63 is returned.
1875 @param Operand The 64-bit operand to evaluate.
1877 @return Position of the highest bit set in Operand if found.
1878 @retval -1 Operand is zero.
1889 Returns the value of the highest bit set in a 32-bit value. Equivalent to
1890 1 << HighBitSet32(x).
1892 This function computes the value of the highest bit set in the 32-bit value
1893 specified by Operand. If Operand is zero, then zero is returned.
1895 @param Operand The 32-bit operand to evaluate.
1897 @return 1 << HighBitSet32(Operand)
1898 @retval 0 Operand is zero.
1909 Returns the value of the highest bit set in a 64-bit value. Equivalent to
1910 1 << HighBitSet64(x).
1912 This function computes the value of the highest bit set in the 64-bit value
1913 specified by Operand. If Operand is zero, then zero is returned.
1915 @param Operand The 64-bit operand to evaluate.
1917 @return 1 << HighBitSet64(Operand)
1918 @retval 0 Operand is zero.
1929 Switches the endianess of a 16-bit integer.
1931 This function swaps the bytes in a 16-bit unsigned value to switch the value
1932 from little endian to big endian or vice versa. The byte swapped value is
1935 @param Value Operand A 16-bit unsigned value.
1937 @return The byte swaped Operand.
1948 Switches the endianess of a 32-bit integer.
1950 This function swaps the bytes in a 32-bit unsigned value to switch the value
1951 from little endian to big endian or vice versa. The byte swapped value is
1954 @param Value Operand A 32-bit unsigned value.
1956 @return The byte swaped Operand.
1967 Switches the endianess of a 64-bit integer.
1969 This function swaps the bytes in a 64-bit unsigned value to switch the value
1970 from little endian to big endian or vice versa. The byte swapped value is
1973 @param Value Operand A 64-bit unsigned value.
1975 @return The byte swaped Operand.
1986 Multiples a 64-bit unsigned integer by a 32-bit unsigned integer and
1987 generates a 64-bit unsigned result.
1989 This function multiples the 64-bit unsigned value Multiplicand by the 32-bit
1990 unsigned value Multiplier and generates a 64-bit unsigned result. This 64-
1991 bit unsigned result is returned.
1993 If the result overflows, then ASSERT().
1995 @param Multiplicand A 64-bit unsigned value.
1996 @param Multiplier A 32-bit unsigned value.
1998 @return Multiplicand * Multiplier
2004 IN UINT64 Multiplicand
,
2005 IN UINT32 Multiplier
2010 Multiples a 64-bit unsigned integer by a 64-bit unsigned integer and
2011 generates a 64-bit unsigned result.
2013 This function multiples the 64-bit unsigned value Multiplicand by the 64-bit
2014 unsigned value Multiplier and generates a 64-bit unsigned result. This 64-
2015 bit unsigned result is returned.
2017 If the result overflows, then ASSERT().
2019 @param Multiplicand A 64-bit unsigned value.
2020 @param Multiplier A 64-bit unsigned value.
2022 @return Multiplicand * Multiplier
2028 IN UINT64 Multiplicand
,
2029 IN UINT64 Multiplier
2034 Multiples a 64-bit signed integer by a 64-bit signed integer and generates a
2035 64-bit signed result.
2037 This function multiples the 64-bit signed value Multiplicand by the 64-bit
2038 signed value Multiplier and generates a 64-bit signed result. This 64-bit
2039 signed result is returned.
2041 If the result overflows, then ASSERT().
2043 @param Multiplicand A 64-bit signed value.
2044 @param Multiplier A 64-bit signed value.
2046 @return Multiplicand * Multiplier
2052 IN INT64 Multiplicand
,
2058 Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates
2059 a 64-bit unsigned result.
2061 This function divides the 64-bit unsigned value Dividend by the 32-bit
2062 unsigned value Divisor and generates a 64-bit unsigned quotient. This
2063 function returns the 64-bit unsigned quotient.
2065 If Divisor is 0, then ASSERT().
2067 @param Dividend A 64-bit unsigned value.
2068 @param Divisor A 32-bit unsigned value.
2070 @return Dividend / Divisor
2082 Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates
2083 a 32-bit unsigned remainder.
2085 This function divides the 64-bit unsigned value Dividend by the 32-bit
2086 unsigned value Divisor and generates a 32-bit remainder. This function
2087 returns the 32-bit unsigned remainder.
2089 If Divisor is 0, then ASSERT().
2091 @param Dividend A 64-bit unsigned value.
2092 @param Divisor A 32-bit unsigned value.
2094 @return Dividend % Divisor
2106 Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates
2107 a 64-bit unsigned result and an optional 32-bit unsigned remainder.
2109 This function divides the 64-bit unsigned value Dividend by the 32-bit
2110 unsigned value Divisor and generates a 64-bit unsigned quotient. If Remainder
2111 is not NULL, then the 32-bit unsigned remainder is returned in Remainder.
2112 This function returns the 64-bit unsigned quotient.
2114 If Divisor is 0, then ASSERT().
2116 @param Dividend A 64-bit unsigned value.
2117 @param Divisor A 32-bit unsigned value.
2118 @param Remainder A pointer to a 32-bit unsigned value. This parameter is
2119 optional and may be NULL.
2121 @return Dividend / Divisor
2126 DivU64x32Remainder (
2129 OUT UINT32
*Remainder OPTIONAL
2134 Divides a 64-bit unsigned integer by a 64-bit unsigned integer and generates
2135 a 64-bit unsigned result and an optional 64-bit unsigned remainder.
2137 This function divides the 64-bit unsigned value Dividend by the 64-bit
2138 unsigned value Divisor and generates a 64-bit unsigned quotient. If Remainder
2139 is not NULL, then the 64-bit unsigned remainder is returned in Remainder.
2140 This function returns the 64-bit unsigned quotient.
2142 If Divisor is 0, then ASSERT().
2144 @param Dividend A 64-bit unsigned value.
2145 @param Divisor A 64-bit unsigned value.
2146 @param Remainder A pointer to a 64-bit unsigned value. This parameter is
2147 optional and may be NULL.
2149 @return Dividend / Divisor
2154 DivU64x64Remainder (
2157 OUT UINT64
*Remainder OPTIONAL
2162 Divides a 64-bit signed integer by a 64-bit signed integer and generates a
2163 64-bit signed result and a optional 64-bit signed remainder.
2165 This function divides the 64-bit signed value Dividend by the 64-bit signed
2166 value Divisor and generates a 64-bit signed quotient. If Remainder is not
2167 NULL, then the 64-bit signed remainder is returned in Remainder. This
2168 function returns the 64-bit signed quotient.
2170 If Divisor is 0, then ASSERT().
2172 @param Dividend A 64-bit signed value.
2173 @param Divisor A 64-bit signed value.
2174 @param Remainder A pointer to a 64-bit signed value. This parameter is
2175 optional and may be NULL.
2177 @return Dividend / Divisor
2182 DivS64x64Remainder (
2185 OUT INT64
*Remainder OPTIONAL
2190 Reads a 16-bit value from memory that may be unaligned.
2192 This function returns the 16-bit value pointed to by Buffer. The function
2193 guarantees that the read operation does not produce an alignment fault.
2195 If the Buffer is NULL, then ASSERT().
2197 @param Uint16 Pointer to a 16-bit value that may be unaligned.
2205 IN CONST UINT16
*Uint16
2210 Writes a 16-bit value to memory that may be unaligned.
2212 This function writes the 16-bit value specified by Value to Buffer. Value is
2213 returned. The function guarantees that the write operation does not produce
2216 If the Buffer is NULL, then ASSERT().
2218 @param Uint16 Pointer to a 16-bit value that may be unaligned.
2219 @param Value 16-bit value to write to Buffer.
2233 Reads a 24-bit value from memory that may be unaligned.
2235 This function returns the 24-bit value pointed to by Buffer. The function
2236 guarantees that the read operation does not produce an alignment fault.
2238 If the Buffer is NULL, then ASSERT().
2240 @param Buffer Pointer to a 24-bit value that may be unaligned.
2242 @return The value read from Buffer.
2248 IN CONST UINT32
*Buffer
2253 Writes a 24-bit value to memory that may be unaligned.
2255 This function writes the 24-bit value specified by Value to Buffer. Value is
2256 returned. The function guarantees that the write operation does not produce
2259 If the Buffer is NULL, then ASSERT().
2261 @param Buffer Pointer to a 24-bit value that may be unaligned.
2262 @param Value 24-bit value to write to Buffer.
2264 @return The value written to Buffer.
2276 Reads a 32-bit value from memory that may be unaligned.
2278 This function returns the 32-bit value pointed to by Buffer. The function
2279 guarantees that the read operation does not produce an alignment fault.
2281 If the Buffer is NULL, then ASSERT().
2283 @param Uint32 Pointer to a 32-bit value that may be unaligned.
2285 @return Value read from Uint32
2291 IN CONST UINT32
*Uint32
2296 Writes a 32-bit value to memory that may be unaligned.
2298 This function writes the 32-bit value specified by Value to Buffer. Value is
2299 returned. The function guarantees that the write operation does not produce
2302 If the Buffer is NULL, then ASSERT().
2304 @param Uint32 Pointer to a 32-bit value that may be unaligned.
2305 @param Value 32-bit value to write to Buffer.
2307 @return Value written to Uint32.
2319 Reads a 64-bit value from memory that may be unaligned.
2321 This function returns the 64-bit value pointed to by Buffer. The function
2322 guarantees that the read operation does not produce an alignment fault.
2324 If the Buffer is NULL, then ASSERT().
2326 @param Uint64 Pointer to a 64-bit value that may be unaligned.
2328 @return Value read from Uint64.
2334 IN CONST UINT64
*Uint64
2339 Writes a 64-bit value to memory that may be unaligned.
2341 This function writes the 64-bit value specified by Value to Buffer. Value is
2342 returned. The function guarantees that the write operation does not produce
2345 If the Buffer is NULL, then ASSERT().
2347 @param Uint64 Pointer to a 64-bit value that may be unaligned.
2348 @param Value 64-bit value to write to Buffer.
2350 @return Value written to Uint64.
2362 // Bit Field Functions
2366 Returns a bit field from an 8-bit value.
2368 Returns the bitfield specified by the StartBit and the EndBit from Operand.
2370 If 8-bit operations are not supported, then ASSERT().
2371 If StartBit is greater than 7, then ASSERT().
2372 If EndBit is greater than 7, then ASSERT().
2373 If EndBit is less than StartBit, then ASSERT().
2375 @param Operand Operand on which to perform the bitfield operation.
2376 @param StartBit The ordinal of the least significant bit in the bit field.
2378 @param EndBit The ordinal of the most significant bit in the bit field.
2381 @return The bit field read.
2394 Writes a bit field to an 8-bit value, and returns the result.
2396 Writes Value to the bit field specified by the StartBit and the EndBit in
2397 Operand. All other bits in Operand are preserved. The new 8-bit value is
2400 If 8-bit operations are not supported, then ASSERT().
2401 If StartBit is greater than 7, then ASSERT().
2402 If EndBit is greater than 7, then ASSERT().
2403 If EndBit is less than StartBit, then ASSERT().
2405 @param Operand Operand on which to perform the bitfield operation.
2406 @param StartBit The ordinal of the least significant bit in the bit field.
2408 @param EndBit The ordinal of the most significant bit in the bit field.
2410 @param Value New value of the bit field.
2412 @return The new 8-bit value.
2426 Reads a bit field from an 8-bit value, performs a bitwise OR, and returns the
2429 Performs a bitwise inclusive OR between the bit field specified by StartBit
2430 and EndBit in Operand and the value specified by OrData. All other bits in
2431 Operand are preserved. The new 8-bit value is returned.
2433 If 8-bit operations are not supported, then ASSERT().
2434 If StartBit is greater than 7, then ASSERT().
2435 If EndBit is greater than 7, then ASSERT().
2436 If EndBit is less than StartBit, then ASSERT().
2438 @param Operand Operand on which to perform the bitfield operation.
2439 @param StartBit The ordinal of the least significant bit in the bit field.
2441 @param EndBit The ordinal of the most significant bit in the bit field.
2443 @param OrData The value to OR with the read value from the value
2445 @return The new 8-bit value.
2459 Reads a bit field from an 8-bit value, performs a bitwise AND, and returns
2462 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2463 in Operand and the value specified by AndData. All other bits in Operand are
2464 preserved. The new 8-bit value is returned.
2466 If 8-bit operations are not supported, then ASSERT().
2467 If StartBit is greater than 7, then ASSERT().
2468 If EndBit is greater than 7, then ASSERT().
2469 If EndBit is less than StartBit, then ASSERT().
2471 @param Operand Operand on which to perform the bitfield operation.
2472 @param StartBit The ordinal of the least significant bit in the bit field.
2474 @param EndBit The ordinal of the most significant bit in the bit field.
2476 @param AndData The value to AND with the read value from the value.
2478 @return The new 8-bit value.
2492 Reads a bit field from an 8-bit value, performs a bitwise AND followed by a
2493 bitwise OR, and returns the result.
2495 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2496 in Operand and the value specified by AndData, followed by a bitwise
2497 inclusive OR with value specified by OrData. All other bits in Operand are
2498 preserved. The new 8-bit value is returned.
2500 If 8-bit operations are not supported, then ASSERT().
2501 If StartBit is greater than 7, then ASSERT().
2502 If EndBit is greater than 7, then ASSERT().
2503 If EndBit is less than StartBit, then ASSERT().
2505 @param Operand Operand on which to perform the bitfield operation.
2506 @param StartBit The ordinal of the least significant bit in the bit field.
2508 @param EndBit The ordinal of the most significant bit in the bit field.
2510 @param AndData The value to AND with the read value from the value.
2511 @param OrData The value to OR with the result of the AND operation.
2513 @return The new 8-bit value.
2518 BitFieldAndThenOr8 (
2528 Returns a bit field from a 16-bit value.
2530 Returns the bitfield specified by the StartBit and the EndBit from Operand.
2532 If 16-bit operations are not supported, then ASSERT().
2533 If StartBit is greater than 15, then ASSERT().
2534 If EndBit is greater than 15, then ASSERT().
2535 If EndBit is less than StartBit, then ASSERT().
2537 @param Operand Operand on which to perform the bitfield operation.
2538 @param StartBit The ordinal of the least significant bit in the bit field.
2540 @param EndBit The ordinal of the most significant bit in the bit field.
2543 @return The bit field read.
2556 Writes a bit field to a 16-bit value, and returns the result.
2558 Writes Value to the bit field specified by the StartBit and the EndBit in
2559 Operand. All other bits in Operand are preserved. The new 16-bit value is
2562 If 16-bit operations are not supported, then ASSERT().
2563 If StartBit is greater than 15, then ASSERT().
2564 If EndBit is greater than 15, then ASSERT().
2565 If EndBit is less than StartBit, then ASSERT().
2567 @param Operand Operand on which to perform the bitfield operation.
2568 @param StartBit The ordinal of the least significant bit in the bit field.
2570 @param EndBit The ordinal of the most significant bit in the bit field.
2572 @param Value New value of the bit field.
2574 @return The new 16-bit value.
2588 Reads a bit field from a 16-bit value, performs a bitwise OR, and returns the
2591 Performs a bitwise inclusive OR between the bit field specified by StartBit
2592 and EndBit in Operand and the value specified by OrData. All other bits in
2593 Operand are preserved. The new 16-bit value is returned.
2595 If 16-bit operations are not supported, then ASSERT().
2596 If StartBit is greater than 15, then ASSERT().
2597 If EndBit is greater than 15, then ASSERT().
2598 If EndBit is less than StartBit, then ASSERT().
2600 @param Operand Operand on which to perform the bitfield operation.
2601 @param StartBit The ordinal of the least significant bit in the bit field.
2603 @param EndBit The ordinal of the most significant bit in the bit field.
2605 @param OrData The value to OR with the read value from the value
2607 @return The new 16-bit value.
2621 Reads a bit field from a 16-bit value, performs a bitwise AND, and returns
2624 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2625 in Operand and the value specified by AndData. All other bits in Operand are
2626 preserved. The new 16-bit value is returned.
2628 If 16-bit operations are not supported, then ASSERT().
2629 If StartBit is greater than 15, then ASSERT().
2630 If EndBit is greater than 15, then ASSERT().
2631 If EndBit is less than StartBit, then ASSERT().
2633 @param Operand Operand on which to perform the bitfield operation.
2634 @param StartBit The ordinal of the least significant bit in the bit field.
2636 @param EndBit The ordinal of the most significant bit in the bit field.
2638 @param AndData The value to AND with the read value from the value
2640 @return The new 16-bit value.
2654 Reads a bit field from a 16-bit value, performs a bitwise AND followed by a
2655 bitwise OR, and returns the result.
2657 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2658 in Operand and the value specified by AndData, followed by a bitwise
2659 inclusive OR with value specified by OrData. All other bits in Operand are
2660 preserved. The new 16-bit value is returned.
2662 If 16-bit operations are not supported, then ASSERT().
2663 If StartBit is greater than 15, then ASSERT().
2664 If EndBit is greater than 15, then ASSERT().
2665 If EndBit is less than StartBit, then ASSERT().
2667 @param Operand Operand on which to perform the bitfield operation.
2668 @param StartBit The ordinal of the least significant bit in the bit field.
2670 @param EndBit The ordinal of the most significant bit in the bit field.
2672 @param AndData The value to AND with the read value from the value.
2673 @param OrData The value to OR with the result of the AND operation.
2675 @return The new 16-bit value.
2680 BitFieldAndThenOr16 (
2690 Returns a bit field from a 32-bit value.
2692 Returns the bitfield specified by the StartBit and the EndBit from Operand.
2694 If 32-bit operations are not supported, then ASSERT().
2695 If StartBit is greater than 31, then ASSERT().
2696 If EndBit is greater than 31, then ASSERT().
2697 If EndBit is less than StartBit, then ASSERT().
2699 @param Operand Operand on which to perform the bitfield operation.
2700 @param StartBit The ordinal of the least significant bit in the bit field.
2702 @param EndBit The ordinal of the most significant bit in the bit field.
2705 @return The bit field read.
2718 Writes a bit field to a 32-bit value, and returns the result.
2720 Writes Value to the bit field specified by the StartBit and the EndBit in
2721 Operand. All other bits in Operand are preserved. The new 32-bit value is
2724 If 32-bit operations are not supported, then ASSERT().
2725 If StartBit is greater than 31, then ASSERT().
2726 If EndBit is greater than 31, then ASSERT().
2727 If EndBit is less than StartBit, then ASSERT().
2729 @param Operand Operand on which to perform the bitfield operation.
2730 @param StartBit The ordinal of the least significant bit in the bit field.
2732 @param EndBit The ordinal of the most significant bit in the bit field.
2734 @param Value New value of the bit field.
2736 @return The new 32-bit value.
2750 Reads a bit field from a 32-bit value, performs a bitwise OR, and returns the
2753 Performs a bitwise inclusive OR between the bit field specified by StartBit
2754 and EndBit in Operand and the value specified by OrData. All other bits in
2755 Operand are preserved. The new 32-bit value is returned.
2757 If 32-bit operations are not supported, then ASSERT().
2758 If StartBit is greater than 31, then ASSERT().
2759 If EndBit is greater than 31, then ASSERT().
2760 If EndBit is less than StartBit, then ASSERT().
2762 @param Operand Operand on which to perform the bitfield operation.
2763 @param StartBit The ordinal of the least significant bit in the bit field.
2765 @param EndBit The ordinal of the most significant bit in the bit field.
2767 @param OrData The value to OR with the read value from the value
2769 @return The new 32-bit value.
2783 Reads a bit field from a 32-bit value, performs a bitwise AND, and returns
2786 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2787 in Operand and the value specified by AndData. All other bits in Operand are
2788 preserved. The new 32-bit value is returned.
2790 If 32-bit operations are not supported, then ASSERT().
2791 If StartBit is greater than 31, then ASSERT().
2792 If EndBit is greater than 31, then ASSERT().
2793 If EndBit is less than StartBit, then ASSERT().
2795 @param Operand Operand on which to perform the bitfield operation.
2796 @param StartBit The ordinal of the least significant bit in the bit field.
2798 @param EndBit The ordinal of the most significant bit in the bit field.
2800 @param AndData The value to AND with the read value from the value
2802 @return The new 32-bit value.
2816 Reads a bit field from a 32-bit value, performs a bitwise AND followed by a
2817 bitwise OR, and returns the result.
2819 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2820 in Operand and the value specified by AndData, followed by a bitwise
2821 inclusive OR with value specified by OrData. All other bits in Operand are
2822 preserved. The new 32-bit value is returned.
2824 If 32-bit operations are not supported, then ASSERT().
2825 If StartBit is greater than 31, then ASSERT().
2826 If EndBit is greater than 31, then ASSERT().
2827 If EndBit is less than StartBit, then ASSERT().
2829 @param Operand Operand on which to perform the bitfield operation.
2830 @param StartBit The ordinal of the least significant bit in the bit field.
2832 @param EndBit The ordinal of the most significant bit in the bit field.
2834 @param AndData The value to AND with the read value from the value.
2835 @param OrData The value to OR with the result of the AND operation.
2837 @return The new 32-bit value.
2842 BitFieldAndThenOr32 (
2852 Returns a bit field from a 64-bit value.
2854 Returns the bitfield specified by the StartBit and the EndBit from Operand.
2856 If 64-bit operations are not supported, then ASSERT().
2857 If StartBit is greater than 63, then ASSERT().
2858 If EndBit is greater than 63, then ASSERT().
2859 If EndBit is less than StartBit, then ASSERT().
2861 @param Operand Operand on which to perform the bitfield operation.
2862 @param StartBit The ordinal of the least significant bit in the bit field.
2864 @param EndBit The ordinal of the most significant bit in the bit field.
2867 @return The bit field read.
2880 Writes a bit field to a 64-bit value, and returns the result.
2882 Writes Value to the bit field specified by the StartBit and the EndBit in
2883 Operand. All other bits in Operand are preserved. The new 64-bit value is
2886 If 64-bit operations are not supported, then ASSERT().
2887 If StartBit is greater than 63, then ASSERT().
2888 If EndBit is greater than 63, then ASSERT().
2889 If EndBit is less than StartBit, then ASSERT().
2891 @param Operand Operand on which to perform the bitfield operation.
2892 @param StartBit The ordinal of the least significant bit in the bit field.
2894 @param EndBit The ordinal of the most significant bit in the bit field.
2896 @param Value New value of the bit field.
2898 @return The new 64-bit value.
2912 Reads a bit field from a 64-bit value, performs a bitwise OR, and returns the
2915 Performs a bitwise inclusive OR between the bit field specified by StartBit
2916 and EndBit in Operand and the value specified by OrData. All other bits in
2917 Operand are preserved. The new 64-bit value is returned.
2919 If 64-bit operations are not supported, then ASSERT().
2920 If StartBit is greater than 63, then ASSERT().
2921 If EndBit is greater than 63, then ASSERT().
2922 If EndBit is less than StartBit, then ASSERT().
2924 @param Operand Operand on which to perform the bitfield operation.
2925 @param StartBit The ordinal of the least significant bit in the bit field.
2927 @param EndBit The ordinal of the most significant bit in the bit field.
2929 @param OrData The value to OR with the read value from the value
2931 @return The new 64-bit value.
2945 Reads a bit field from a 64-bit value, performs a bitwise AND, and returns
2948 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2949 in Operand and the value specified by AndData. All other bits in Operand are
2950 preserved. The new 64-bit value is returned.
2952 If 64-bit operations are not supported, then ASSERT().
2953 If StartBit is greater than 63, then ASSERT().
2954 If EndBit is greater than 63, then ASSERT().
2955 If EndBit is less than StartBit, then ASSERT().
2957 @param Operand Operand on which to perform the bitfield operation.
2958 @param StartBit The ordinal of the least significant bit in the bit field.
2960 @param EndBit The ordinal of the most significant bit in the bit field.
2962 @param AndData The value to AND with the read value from the value
2964 @return The new 64-bit value.
2978 Reads a bit field from a 64-bit value, performs a bitwise AND followed by a
2979 bitwise OR, and returns the result.
2981 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2982 in Operand and the value specified by AndData, followed by a bitwise
2983 inclusive OR with value specified by OrData. All other bits in Operand are
2984 preserved. The new 64-bit value is returned.
2986 If 64-bit operations are not supported, then ASSERT().
2987 If StartBit is greater than 63, then ASSERT().
2988 If EndBit is greater than 63, then ASSERT().
2989 If EndBit is less than StartBit, then ASSERT().
2991 @param Operand Operand on which to perform the bitfield operation.
2992 @param StartBit The ordinal of the least significant bit in the bit field.
2994 @param EndBit The ordinal of the most significant bit in the bit field.
2996 @param AndData The value to AND with the read value from the value.
2997 @param OrData The value to OR with the result of the AND operation.
2999 @return The new 64-bit value.
3004 BitFieldAndThenOr64 (
3014 // Base Library Synchronization Functions
3018 Retrieves the architecture specific spin lock alignment requirements for
3019 optimal spin lock performance.
3021 This function retrieves the spin lock alignment requirements for optimal
3022 performance on a given CPU architecture. The spin lock alignment must be a
3023 power of two and is returned by this function. If there are no alignment
3024 requirements, then 1 must be returned. The spin lock synchronization
3025 functions must function correctly if the spin lock size and alignment values
3026 returned by this function are not used at all. These values are hints to the
3027 consumers of the spin lock synchronization functions to obtain optimal spin
3030 @return The architecture specific spin lock alignment.
3035 GetSpinLockProperties (
3041 Initializes a spin lock to the released state and returns the spin lock.
3043 This function initializes the spin lock specified by SpinLock to the released
3044 state, and returns SpinLock. Optimal performance can be achieved by calling
3045 GetSpinLockProperties() to determine the size and alignment requirements for
3048 If SpinLock is NULL, then ASSERT().
3050 @param SpinLock A pointer to the spin lock to initialize to the released
3053 @return SpinLock in release state.
3058 InitializeSpinLock (
3059 IN SPIN_LOCK
*SpinLock
3064 Waits until a spin lock can be placed in the acquired state.
3066 This function checks the state of the spin lock specified by SpinLock. If
3067 SpinLock is in the released state, then this function places SpinLock in the
3068 acquired state and returns SpinLock. Otherwise, this function waits
3069 indefinitely for the spin lock to be released, and then places it in the
3070 acquired state and returns SpinLock. All state transitions of SpinLock must
3071 be performed using MP safe mechanisms.
3073 If SpinLock is NULL, then ASSERT().
3074 If SpinLock was not initialized with InitializeSpinLock(), then ASSERT().
3075 If PcdSpinLockTimeout is not zero, and SpinLock is can not be acquired in
3076 PcdSpinLockTimeout microseconds, then ASSERT().
3078 @param SpinLock A pointer to the spin lock to place in the acquired state.
3080 @return SpinLock accquired lock.
3086 IN SPIN_LOCK
*SpinLock
3091 Attempts to place a spin lock in the acquired state.
3093 This function checks the state of the spin lock specified by SpinLock. If
3094 SpinLock is in the released state, then this function places SpinLock in the
3095 acquired state and returns TRUE. Otherwise, FALSE is returned. All state
3096 transitions of SpinLock must be performed using MP safe mechanisms.
3098 If SpinLock is NULL, then ASSERT().
3099 If SpinLock was not initialized with InitializeSpinLock(), then ASSERT().
3101 @param SpinLock A pointer to the spin lock to place in the acquired state.
3103 @retval TRUE SpinLock was placed in the acquired state.
3104 @retval FALSE SpinLock could not be acquired.
3109 AcquireSpinLockOrFail (
3110 IN SPIN_LOCK
*SpinLock
3115 Releases a spin lock.
3117 This function places the spin lock specified by SpinLock in the release state
3118 and returns SpinLock.
3120 If SpinLock is NULL, then ASSERT().
3121 If SpinLock was not initialized with InitializeSpinLock(), then ASSERT().
3123 @param SpinLock A pointer to the spin lock to release.
3125 @return SpinLock released lock.
3131 IN SPIN_LOCK
*SpinLock
3136 Performs an atomic increment of an 32-bit unsigned integer.
3138 Performs an atomic increment of the 32-bit unsigned integer specified by
3139 Value and returns the incremented value. The increment operation must be
3140 performed using MP safe mechanisms. The state of the return value is not
3141 guaranteed to be MP safe.
3143 If Value is NULL, then ASSERT().
3145 @param Value A pointer to the 32-bit value to increment.
3147 @return The incremented value.
3152 InterlockedIncrement (
3158 Performs an atomic decrement of an 32-bit unsigned integer.
3160 Performs an atomic decrement of the 32-bit unsigned integer specified by
3161 Value and returns the decremented value. The decrement operation must be
3162 performed using MP safe mechanisms. The state of the return value is not
3163 guaranteed to be MP safe.
3165 If Value is NULL, then ASSERT().
3167 @param Value A pointer to the 32-bit value to decrement.
3169 @return The decremented value.
3174 InterlockedDecrement (
3180 Performs an atomic compare exchange operation on a 32-bit unsigned integer.
3182 Performs an atomic compare exchange operation on the 32-bit unsigned integer
3183 specified by Value. If Value is equal to CompareValue, then Value is set to
3184 ExchangeValue and CompareValue is returned. If Value is not equal to CompareValue,
3185 then Value is returned. The compare exchange operation must be performed using
3188 If Value is NULL, then ASSERT().
3190 @param Value A pointer to the 32-bit value for the compare exchange
3192 @param CompareValue 32-bit value used in compare operation.
3193 @param ExchangeValue 32-bit value used in exchange operation.
3195 @return The original *Value before exchange.
3200 InterlockedCompareExchange32 (
3201 IN OUT UINT32
*Value
,
3202 IN UINT32 CompareValue
,
3203 IN UINT32 ExchangeValue
3208 Performs an atomic compare exchange operation on a 64-bit unsigned integer.
3210 Performs an atomic compare exchange operation on the 64-bit unsigned integer specified
3211 by Value. If Value is equal to CompareValue, then Value is set to ExchangeValue and
3212 CompareValue is returned. If Value is not equal to CompareValue, then Value is returned.
3213 The compare exchange operation must be performed using MP safe mechanisms.
3215 If Value is NULL, then ASSERT().
3217 @param Value A pointer to the 64-bit value for the compare exchange
3219 @param CompareValue 64-bit value used in compare operation.
3220 @param ExchangeValue 64-bit value used in exchange operation.
3222 @return The original *Value before exchange.
3227 InterlockedCompareExchange64 (
3228 IN OUT UINT64
*Value
,
3229 IN UINT64 CompareValue
,
3230 IN UINT64 ExchangeValue
3235 Performs an atomic compare exchange operation on a pointer value.
3237 Performs an atomic compare exchange operation on the pointer value specified
3238 by Value. If Value is equal to CompareValue, then Value is set to
3239 ExchangeValue and CompareValue is returned. If Value is not equal to
3240 CompareValue, then Value is returned. The compare exchange operation must be
3241 performed using MP safe mechanisms.
3243 If Value is NULL, then ASSERT().
3245 @param Value A pointer to the pointer value for the compare exchange
3247 @param CompareValue Pointer value used in compare operation.
3248 @param ExchangeValue Pointer value used in exchange operation.
3250 @return The original *Value before exchange.
3254 InterlockedCompareExchangePointer (
3255 IN OUT VOID
**Value
,
3256 IN VOID
*CompareValue
,
3257 IN VOID
*ExchangeValue
3262 // Base Library Checksum Functions
3266 Calculate the sum of all elements in a buffer in unit of UINT8.
3267 During calculation, the carry bits are dropped.
3269 This function calculates the sum of all elements in a buffer
3270 in unit of UINT8. The carry bits in result of addition are dropped.
3271 The result is returned as UINT8. If Length is Zero, then Zero is
3274 If Buffer is NULL, then ASSERT().
3275 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3277 @param Buffer Pointer to the buffer to carry out the sum operation.
3278 @param Length The size, in bytes, of Buffer .
3280 @return Sum The sum of Buffer with carry bits dropped during additions.
3286 IN CONST UINT8
*Buffer
,
3292 Returns the two's complement checksum of all elements in a buffer
3295 This function first calculates the sum of the 8-bit values in the
3296 buffer specified by Buffer and Length. The carry bits in the result
3297 of addition are dropped. Then, the two's complement of the sum is
3298 returned. If Length is 0, then 0 is returned.
3300 If Buffer is NULL, then ASSERT().
3301 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3304 @param Buffer Pointer to the buffer to carry out the checksum operation.
3305 @param Length The size, in bytes, of Buffer.
3307 @return Checksum The 2's complement checksum of Buffer.
3312 CalculateCheckSum8 (
3313 IN CONST UINT8
*Buffer
,
3319 Returns the sum of all elements in a buffer of 16-bit values. During
3320 calculation, the carry bits are dropped.
3322 This function calculates the sum of the 16-bit values in the buffer
3323 specified by Buffer and Length. The carry bits in result of addition are dropped.
3324 The 16-bit result is returned. If Length is 0, then 0 is returned.
3326 If Buffer is NULL, then ASSERT().
3327 If Buffer is not aligned on a 16-bit boundary, then ASSERT().
3328 If Length is not aligned on a 16-bit boundary, then ASSERT().
3329 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3331 @param Buffer Pointer to the buffer to carry out the sum operation.
3332 @param Length The size, in bytes, of Buffer.
3334 @return Sum The sum of Buffer with carry bits dropped during additions.
3340 IN CONST UINT16
*Buffer
,
3346 Returns the two's complement checksum of all elements in a buffer of
3349 This function first calculates the sum of the 16-bit values in the buffer
3350 specified by Buffer and Length. The carry bits in the result of addition
3351 are dropped. Then, the two's complement of the sum is returned. If Length
3352 is 0, then 0 is returned.
3354 If Buffer is NULL, then ASSERT().
3355 If Buffer is not aligned on a 16-bit boundary, then ASSERT().
3356 If Length is not aligned on a 16-bit boundary, then ASSERT().
3357 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3359 @param Buffer Pointer to the buffer to carry out the checksum operation.
3360 @param Length The size, in bytes, of Buffer.
3362 @return Checksum The 2's complement checksum of Buffer.
3367 CalculateCheckSum16 (
3368 IN CONST UINT16
*Buffer
,
3374 Returns the sum of all elements in a buffer of 32-bit values. During
3375 calculation, the carry bits are dropped.
3377 This function calculates the sum of the 32-bit values in the buffer
3378 specified by Buffer and Length. The carry bits in result of addition are dropped.
3379 The 32-bit result is returned. If Length is 0, then 0 is returned.
3381 If Buffer is NULL, then ASSERT().
3382 If Buffer is not aligned on a 32-bit boundary, then ASSERT().
3383 If Length is not aligned on a 32-bit boundary, then ASSERT().
3384 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3386 @param Buffer Pointer to the buffer to carry out the sum operation.
3387 @param Length The size, in bytes, of Buffer.
3389 @return Sum The sum of Buffer with carry bits dropped during additions.
3395 IN CONST UINT32
*Buffer
,
3401 Returns the two's complement checksum of all elements in a buffer of
3404 This function first calculates the sum of the 32-bit values in the buffer
3405 specified by Buffer and Length. The carry bits in the result of addition
3406 are dropped. Then, the two's complement of the sum is returned. If Length
3407 is 0, then 0 is returned.
3409 If Buffer is NULL, then ASSERT().
3410 If Buffer is not aligned on a 32-bit boundary, then ASSERT().
3411 If Length is not aligned on a 32-bit boundary, then ASSERT().
3412 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3414 @param Buffer Pointer to the buffer to carry out the checksum operation.
3415 @param Length The size, in bytes, of Buffer.
3417 @return Checksum The 2's complement checksum of Buffer.
3422 CalculateCheckSum32 (
3423 IN CONST UINT32
*Buffer
,
3429 Returns the sum of all elements in a buffer of 64-bit values. During
3430 calculation, the carry bits are dropped.
3432 This function calculates the sum of the 64-bit values in the buffer
3433 specified by Buffer and Length. The carry bits in result of addition are dropped.
3434 The 64-bit result is returned. If Length is 0, then 0 is returned.
3436 If Buffer is NULL, then ASSERT().
3437 If Buffer is not aligned on a 64-bit boundary, then ASSERT().
3438 If Length is not aligned on a 64-bit boundary, then ASSERT().
3439 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3441 @param Buffer Pointer to the buffer to carry out the sum operation.
3442 @param Length The size, in bytes, of Buffer.
3444 @return Sum The sum of Buffer with carry bits dropped during additions.
3450 IN CONST UINT64
*Buffer
,
3456 Returns the two's complement checksum of all elements in a buffer of
3459 This function first calculates the sum of the 64-bit values in the buffer
3460 specified by Buffer and Length. The carry bits in the result of addition
3461 are dropped. Then, the two's complement of the sum is returned. If Length
3462 is 0, then 0 is returned.
3464 If Buffer is NULL, then ASSERT().
3465 If Buffer is not aligned on a 64-bit boundary, then ASSERT().
3466 If Length is not aligned on a 64-bit boundary, then ASSERT().
3467 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3469 @param Buffer Pointer to the buffer to carry out the checksum operation.
3470 @param Length The size, in bytes, of Buffer.
3472 @return Checksum The 2's complement checksum of Buffer.
3477 CalculateCheckSum64 (
3478 IN CONST UINT64
*Buffer
,
3484 // Base Library CPU Functions
3488 (EFIAPI
*SWITCH_STACK_ENTRY_POINT
)(
3489 IN VOID
*Context1
, OPTIONAL
3490 IN VOID
*Context2 OPTIONAL
3495 Used to serialize load and store operations.
3497 All loads and stores that proceed calls to this function are guaranteed to be
3498 globally visible when this function returns.
3509 Saves the current CPU context that can be restored with a call to LongJump()
3512 Saves the current CPU context in the buffer specified by JumpBuffer and
3513 returns 0. The initial call to SetJump() must always return 0. Subsequent
3514 calls to LongJump() cause a non-zero value to be returned by SetJump().
3516 If JumpBuffer is NULL, then ASSERT().
3517 For IPF CPUs, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().
3519 @param JumpBuffer A pointer to CPU context buffer.
3521 @retval 0 Indicates a return from SetJump().
3527 OUT BASE_LIBRARY_JUMP_BUFFER
*JumpBuffer
3532 Restores the CPU context that was saved with SetJump().
3534 Restores the CPU context from the buffer specified by JumpBuffer. This
3535 function never returns to the caller. Instead is resumes execution based on
3536 the state of JumpBuffer.
3538 If JumpBuffer is NULL, then ASSERT().
3539 For IPF CPUs, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().
3540 If Value is 0, then ASSERT().
3542 @param JumpBuffer A pointer to CPU context buffer.
3543 @param Value The value to return when the SetJump() context is
3544 restored and must be non-zero.
3550 IN BASE_LIBRARY_JUMP_BUFFER
*JumpBuffer
,
3556 Enables CPU interrupts.
3567 Disables CPU interrupts.
3578 Disables CPU interrupts and returns the interrupt state prior to the disable
3581 @retval TRUE CPU interrupts were enabled on entry to this call.
3582 @retval FALSE CPU interrupts were disabled on entry to this call.
3587 SaveAndDisableInterrupts (
3593 Enables CPU interrupts for the smallest window required to capture any
3599 EnableDisableInterrupts (
3605 Retrieves the current CPU interrupt state.
3607 Returns TRUE is interrupts are currently enabled. Otherwise
3610 @retval TRUE CPU interrupts are enabled.
3611 @retval FALSE CPU interrupts are disabled.
3622 Set the current CPU interrupt state.
3624 Sets the current CPU interrupt state to the state specified by
3625 InterruptState. If InterruptState is TRUE, then interrupts are enabled. If
3626 InterruptState is FALSE, then interrupts are disabled. InterruptState is
3629 @param InterruptState TRUE if interrupts should enabled. FALSE if
3630 interrupts should be disabled.
3632 @return InterruptState
3638 IN BOOLEAN InterruptState
3643 Requests CPU to pause for a short period of time.
3645 Requests CPU to pause for a short period of time. Typically used in MP
3646 systems to prevent memory starvation while waiting for a spin lock.
3657 Transfers control to a function starting with a new stack.
3659 Transfers control to the function specified by EntryPoint using the
3660 new stack specified by NewStack and passing in the parameters specified
3661 by Context1 and Context2. Context1 and Context2 are optional and may
3662 be NULL. The function EntryPoint must never return. This function
3663 supports a variable number of arguments following the NewStack parameter.
3664 These additional arguments are ignored on IA-32, x64, and EBC.
3665 IPF CPUs expect one additional parameter of type VOID * that specifies
3666 the new backing store pointer.
3668 If EntryPoint is NULL, then ASSERT().
3669 If NewStack is NULL, then ASSERT().
3671 @param EntryPoint A pointer to function to call with the new stack.
3672 @param Context1 A pointer to the context to pass into the EntryPoint
3674 @param Context2 A pointer to the context to pass into the EntryPoint
3676 @param NewStack A pointer to the new stack to use for the EntryPoint
3678 @param ... Extended parameters.
3685 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
3686 IN VOID
*Context1
, OPTIONAL
3687 IN VOID
*Context2
, OPTIONAL
3694 Generates a breakpoint on the CPU.
3696 Generates a breakpoint on the CPU. The breakpoint must be implemented such
3697 that code can resume normal execution after the breakpoint.
3708 Executes an infinite loop.
3710 Forces the CPU to execute an infinite loop. A debugger may be used to skip
3711 past the loop and the code that follows the loop must execute properly. This
3712 implies that the infinite loop must not cause the code that follow it to be
3723 #if defined (MDE_CPU_IPF)
3726 Flush a range of cache lines in the cache coherency domain of the calling
3729 Invalidates the cache lines specified by Address and Length. If Address is
3730 not aligned on a cache line boundary, then entire cache line containing
3731 Address is invalidated. If Address + Length is not aligned on a cache line
3732 boundary, then the entire instruction cache line containing Address + Length
3733 -1 is invalidated. This function may choose to invalidate the entire
3734 instruction cache if that is more efficient than invalidating the specified
3735 range. If Length is 0, the no instruction cache lines are invalidated.
3736 Address is returned.
3738 If Length is greater than (MAX_ADDRESS - Address + 1), then ASSERT().
3740 @param Address The base address of the instruction lines to invalidate. If
3741 the CPU is in a physical addressing mode, then Address is a
3742 physical address. If the CPU is in a virtual addressing mode,
3743 then Address is a virtual address.
3745 @param Length The number of bytes to invalidate from the instruction cache.
3752 IpfFlushCacheRange (
3759 Executes a FC instruction
3760 Executes a FC instruction on the cache line specified by Address.
3761 The cache line size affected is at least 32-bytes (aligned on a 32-byte boundary).
3762 An implementation may flush a larger region. This function is only available on IPF.
3764 @param Address The Address of cache line to be flushed.
3766 @return The address of FC instruction executed.
3777 Executes a FC.I instruction.
3778 Executes a FC.I instruction on the cache line specified by Address.
3779 The cache line size affected is at least 32-bytes (aligned on a 32-byte boundary).
3780 An implementation may flush a larger region. This function is only available on IPF.
3782 @param Address The Address of cache line to be flushed.
3784 @return The address of FC.I instruction executed.
3795 Reads the current value of a Processor Identifier Register (CPUID).
3796 The Index of largest implemented CPUID (One less than the number of implemented CPUID
3797 registers) is determined by CPUID [3] bits {7:0}.
3798 No parameter checking is performed on Index. If the Index value is beyond the
3799 implemented CPUID register range, a Reserved Register/Field fault may occur. The caller
3800 must either guarantee that Index is valid, or the caller must set up fault handlers to
3801 catch the faults. This function is only available on IPF.
3803 @param Index The 8-bit Processor Identifier Register index to read.
3805 @return The current value of Processor Identifier Register specified by Index.
3816 Reads the current value of 64-bit Processor Status Register (PSR).
3817 This function is only available on IPF.
3819 @return The current value of PSR.
3830 Writes the current value of 64-bit Processor Status Register (PSR).
3831 No parameter checking is performed on Value. All bits of Value corresponding to
3832 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.
3833 This function is only available on IPF.
3835 @param Value The 64-bit value to write to PSR.
3837 @return The 64-bit value written to the PSR.
3848 Reads the current value of 64-bit Kernel Register #0 (KR0).
3849 This function is only available on IPF.
3851 @return The current value of KR0.
3862 Reads the current value of 64-bit Kernel Register #1 (KR1).
3863 This function is only available on IPF.
3865 @return The current value of KR1.
3876 Reads the current value of 64-bit Kernel Register #2 (KR2).
3877 This function is only available on IPF.
3879 @return The current value of KR2.
3890 Reads the current value of 64-bit Kernel Register #3 (KR3).
3891 This function is only available on IPF.
3893 @return The current value of KR3.
3904 Reads the current value of 64-bit Kernel Register #4 (KR4).
3905 This function is only available on IPF.
3907 @return The current value of KR4.
3918 Reads the current value of 64-bit Kernel Register #5 (KR5).
3919 This function is only available on IPF.
3921 @return The current value of KR5.
3932 Reads the current value of 64-bit Kernel Register #6 (KR6).
3933 This function is only available on IPF.
3935 @return The current value of KR6.
3946 Reads the current value of 64-bit Kernel Register #7 (KR7).
3947 This function is only available on IPF.
3949 @return The current value of KR7.
3960 Write the current value of 64-bit Kernel Register #0 (KR0).
3961 This function is only available on IPF.
3963 @param Value The 64-bit value to write to KR0.
3965 @return The 64-bit value written to the KR0.
3976 Write the current value of 64-bit Kernel Register #1 (KR1).
3977 This function is only available on IPF.
3979 @param Value The 64-bit value to write to KR1.
3981 @return The 64-bit value written to the KR1.
3992 Write the current value of 64-bit Kernel Register #2 (KR2).
3993 This function is only available on IPF.
3995 @param Value The 64-bit value to write to KR2.
3997 @return The 64-bit value written to the KR2.
4008 Write the current value of 64-bit Kernel Register #3 (KR3).
4009 This function is only available on IPF.
4011 @param Value The 64-bit value to write to KR3.
4013 @return The 64-bit value written to the KR3.
4024 Write the current value of 64-bit Kernel Register #4 (KR4).
4025 This function is only available on IPF.
4027 @param Value The 64-bit value to write to KR4.
4029 @return The 64-bit value written to the KR4.
4040 Write the current value of 64-bit Kernel Register #5 (KR5).
4041 This function is only available on IPF.
4043 @param Value The 64-bit value to write to KR5.
4045 @return The 64-bit value written to the KR5.
4056 Write the current value of 64-bit Kernel Register #6 (KR6).
4057 This function is only available on IPF.
4059 @param Value The 64-bit value to write to KR6.
4061 @return The 64-bit value written to the KR6.
4072 Write the current value of 64-bit Kernel Register #7 (KR7).
4073 This function is only available on IPF.
4075 @param Value The 64-bit value to write to KR7.
4077 @return The 64-bit value written to the KR7.
4088 Reads the current value of Interval Timer Counter Register (ITC).
4089 This function is only available on IPF.
4091 @return The current value of ITC.
4102 Reads the current value of Interval Timer Vector Register (ITV).
4103 This function is only available on IPF.
4105 @return The current value of ITV.
4116 Reads the current value of Interval Timer Match Register (ITM).
4117 This function is only available on IPF.
4119 @return The current value of ITM.
4129 Writes the current value of 64-bit Interval Timer Counter Register (ITC).
4130 This function is only available on IPF.
4132 @param Value The 64-bit value to write to ITC.
4134 @return The 64-bit value written to the ITC.
4145 Writes the current value of 64-bit Interval Timer Match Register (ITM).
4146 This function is only available on IPF.
4148 @param Value The 64-bit value to write to ITM.
4150 @return The 64-bit value written to the ITM.
4161 Writes the current value of 64-bit Interval Timer Vector Register (ITV).
4162 No parameter checking is performed on Value. All bits of Value corresponding to
4163 reserved fields of ITV must be 0 or a Reserved Register/Field fault may occur.
4164 The caller must either guarantee that Value is valid, or the caller must set up
4165 fault handlers to catch the faults.
4166 This function is only available on IPF.
4168 @param Value The 64-bit value to write to ITV.
4170 @return The 64-bit value written to the ITV.
4181 Reads the current value of Default Control Register (DCR).
4182 This function is only available on IPF.
4184 @return The current value of DCR.
4195 Reads the current value of Interruption Vector Address Register (IVA).
4196 This function is only available on IPF.
4198 @return The current value of IVA.
4208 Reads the current value of Page Table Address Register (PTA).
4209 This function is only available on IPF.
4211 @return The current value of PTA.
4222 Writes the current value of 64-bit Default Control Register (DCR).
4223 No parameter checking is performed on Value. All bits of Value corresponding to
4224 reserved fields of DCR must be 0 or a Reserved Register/Field fault may occur.
4225 The caller must either guarantee that Value is valid, or the caller must set up
4226 fault handlers to catch the faults.
4227 This function is only available on IPF.
4229 @param Value The 64-bit value to write to DCR.
4231 @return The 64-bit value written to the DCR.
4242 Writes the current value of 64-bit Interruption Vector Address Register (IVA).
4243 The size of vector table is 32 K bytes and is 32 K bytes aligned
4244 the low 15 bits of Value is ignored when written.
4245 This function is only available on IPF.
4247 @param Value The 64-bit value to write to IVA.
4249 @return The 64-bit value written to the IVA.
4260 Writes the current value of 64-bit Page Table Address Register (PTA).
4261 No parameter checking is performed on Value. All bits of Value corresponding to
4262 reserved fields of DCR must be 0 or a Reserved Register/Field fault may occur.
4263 The caller must either guarantee that Value is valid, or the caller must set up
4264 fault handlers to catch the faults.
4265 This function is only available on IPF.
4267 @param Value The 64-bit value to write to PTA.
4269 @return The 64-bit value written to the PTA.
4279 Reads the current value of Local Interrupt ID Register (LID).
4280 This function is only available on IPF.
4282 @return The current value of LID.
4293 Reads the current value of External Interrupt Vector Register (IVR).
4294 This function is only available on IPF.
4296 @return The current value of IVR.
4307 Reads the current value of Task Priority Register (TPR).
4308 This function is only available on IPF.
4310 @return The current value of TPR.
4321 Reads the current value of External Interrupt Request Register #0 (IRR0).
4322 This function is only available on IPF.
4324 @return The current value of IRR0.
4335 Reads the current value of External Interrupt Request Register #1 (IRR1).
4336 This function is only available on IPF.
4338 @return The current value of IRR1.
4349 Reads the current value of External Interrupt Request Register #2 (IRR2).
4350 This function is only available on IPF.
4352 @return The current value of IRR2.
4363 Reads the current value of External Interrupt Request Register #3 (IRR3).
4364 This function is only available on IPF.
4366 @return The current value of IRR3.
4377 Reads the current value of Performance Monitor Vector Register (PMV).
4378 This function is only available on IPF.
4380 @return The current value of PMV.
4391 Reads the current value of Corrected Machine Check Vector Register (CMCV).
4392 This function is only available on IPF.
4394 @return The current value of CMCV.
4405 Reads the current value of Local Redirection Register #0 (LRR0).
4406 This function is only available on IPF.
4408 @return The current value of LRR0.
4419 Reads the current value of Local Redirection Register #1 (LRR1).
4420 This function is only available on IPF.
4422 @return The current value of LRR1.
4433 Writes the current value of 64-bit Page Local Interrupt ID Register (LID).
4434 No parameter checking is performed on Value. All bits of Value corresponding to
4435 reserved fields of LID must be 0 or a Reserved Register/Field fault may occur.
4436 The caller must either guarantee that Value is valid, or the caller must set up
4437 fault handlers to catch the faults.
4438 This function is only available on IPF.
4440 @param Value The 64-bit value to write to LID.
4442 @return The 64-bit value written to the LID.
4453 Writes the current value of 64-bit Task Priority Register (TPR).
4454 No parameter checking is performed on Value. All bits of Value corresponding to
4455 reserved fields of TPR must be 0 or a Reserved Register/Field fault may occur.
4456 The caller must either guarantee that Value is valid, or the caller must set up
4457 fault handlers to catch the faults.
4458 This function is only available on IPF.
4460 @param Value The 64-bit value to write to TPR.
4462 @return The 64-bit value written to the TPR.
4473 Performs a write operation on End OF External Interrupt Register (EOI).
4474 Writes a value of 0 to the EOI Register. This function is only available on IPF.
4485 Writes the current value of 64-bit Performance Monitor Vector Register (PMV).
4486 No parameter checking is performed on Value. All bits of Value corresponding
4487 to reserved fields of PMV must be 0 or a Reserved Register/Field fault may occur.
4488 The caller must either guarantee that Value is valid, or the caller must set up
4489 fault handlers to catch the faults.
4490 This function is only available on IPF.
4492 @param Value The 64-bit value to write to PMV.
4494 @return The 64-bit value written to the PMV.
4505 Writes the current value of 64-bit Corrected Machine Check Vector Register (CMCV).
4506 No parameter checking is performed on Value. All bits of Value corresponding
4507 to reserved fields of CMCV must be 0 or a Reserved Register/Field fault may occur.
4508 The caller must either guarantee that Value is valid, or the caller must set up
4509 fault handlers to catch the faults.
4510 This function is only available on IPF.
4512 @param Value The 64-bit value to write to CMCV.
4514 @return The 64-bit value written to the CMCV.
4525 Writes the current value of 64-bit Local Redirection Register #0 (LRR0).
4526 No parameter checking is performed on Value. All bits of Value corresponding
4527 to reserved fields of LRR0 must be 0 or a Reserved Register/Field fault may occur.
4528 The caller must either guarantee that Value is valid, or the caller must set up
4529 fault handlers to catch the faults.
4530 This function is only available on IPF.
4532 @param Value The 64-bit value to write to LRR0.
4534 @return The 64-bit value written to the LRR0.
4545 Writes the current value of 64-bit Local Redirection Register #1 (LRR1).
4546 No parameter checking is performed on Value. All bits of Value corresponding
4547 to reserved fields of LRR1 must be 0 or a Reserved Register/Field fault may occur.
4548 The caller must either guarantee that Value is valid, or the caller must
4549 set up fault handlers to catch the faults.
4550 This function is only available on IPF.
4552 @param Value The 64-bit value to write to LRR1.
4554 @return The 64-bit value written to the LRR1.
4565 Reads the current value of Instruction Breakpoint Register (IBR).
4567 The Instruction Breakpoint Registers are used in pairs. The even numbered
4568 registers contain breakpoint addresses, and the odd numbered registers contain
4569 breakpoint mask conditions. At least 4 instruction registers pairs are implemented
4570 on all processor models. Implemented registers are contiguous starting with
4571 register 0. No parameter checking is performed on Index, and if the Index value
4572 is beyond the implemented IBR register range, a Reserved Register/Field fault may
4573 occur. The caller must either guarantee that Index is valid, or the caller must
4574 set up fault handlers to catch the faults.
4575 This function is only available on IPF.
4577 @param Index The 8-bit Instruction Breakpoint Register index to read.
4579 @return The current value of Instruction Breakpoint Register specified by Index.
4590 Reads the current value of Data Breakpoint Register (DBR).
4592 The Data Breakpoint Registers are used in pairs. The even numbered registers
4593 contain breakpoint addresses, and odd numbered registers contain breakpoint
4594 mask conditions. At least 4 data registers pairs are implemented on all processor
4595 models. Implemented registers are contiguous starting with register 0.
4596 No parameter checking is performed on Index. If the Index value is beyond
4597 the implemented DBR register range, a Reserved Register/Field fault may occur.
4598 The caller must either guarantee that Index is valid, or the caller must set up
4599 fault handlers to catch the faults.
4600 This function is only available on IPF.
4602 @param Index The 8-bit Data Breakpoint Register index to read.
4604 @return The current value of Data Breakpoint Register specified by Index.
4615 Reads the current value of Performance Monitor Configuration Register (PMC).
4617 All processor implementations provide at least 4 performance counters
4618 (PMC/PMD [4]...PMC/PMD [7] pairs), and 4 performance monitor counter overflow
4619 status registers (PMC [0]... PMC [3]). Processor implementations may provide
4620 additional implementation-dependent PMC and PMD to increase the number of
4621 'generic' performance counters (PMC/PMD pairs). The remainder of PMC and PMD
4622 register set is implementation dependent. No parameter checking is performed
4623 on Index. If the Index value is beyond the implemented PMC register range,
4624 zero value will be returned.
4625 This function is only available on IPF.
4627 @param Index The 8-bit Performance Monitor Configuration Register index to read.
4629 @return The current value of Performance Monitor Configuration Register
4641 Reads the current value of Performance Monitor Data Register (PMD).
4643 All processor implementations provide at least 4 performance counters
4644 (PMC/PMD [4]...PMC/PMD [7] pairs), and 4 performance monitor counter
4645 overflow status registers (PMC [0]... PMC [3]). Processor implementations may
4646 provide additional implementation-dependent PMC and PMD to increase the number
4647 of 'generic' performance counters (PMC/PMD pairs). The remainder of PMC and PMD
4648 register set is implementation dependent. No parameter checking is performed
4649 on Index. If the Index value is beyond the implemented PMD register range,
4650 zero value will be returned.
4651 This function is only available on IPF.
4653 @param Index The 8-bit Performance Monitor Data Register index to read.
4655 @return The current value of Performance Monitor Data Register specified by Index.
4666 Writes the current value of 64-bit Instruction Breakpoint Register (IBR).
4668 Writes current value of Instruction Breakpoint Register specified by Index.
4669 The Instruction Breakpoint Registers are used in pairs. The even numbered
4670 registers contain breakpoint addresses, and odd numbered registers contain
4671 breakpoint mask conditions. At least 4 instruction registers pairs are implemented
4672 on all processor models. Implemented registers are contiguous starting with
4673 register 0. No parameter checking is performed on Index. If the Index value
4674 is beyond the implemented IBR register range, a Reserved Register/Field fault may
4675 occur. The caller must either guarantee that Index is valid, or the caller must
4676 set up fault handlers to catch the faults.
4677 This function is only available on IPF.
4679 @param Index The 8-bit Instruction Breakpoint Register index to write.
4680 @param Value The 64-bit value to write to IBR.
4682 @return The 64-bit value written to the IBR.
4694 Writes the current value of 64-bit Data Breakpoint Register (DBR).
4696 Writes current value of Data Breakpoint Register specified by Index.
4697 The Data Breakpoint Registers are used in pairs. The even numbered registers
4698 contain breakpoint addresses, and odd numbered registers contain breakpoint
4699 mask conditions. At least 4 data registers pairs are implemented on all processor
4700 models. Implemented registers are contiguous starting with register 0. No parameter
4701 checking is performed on Index. If the Index value is beyond the implemented
4702 DBR register range, a Reserved Register/Field fault may occur. The caller must
4703 either guarantee that Index is valid, or the caller must set up fault handlers to
4705 This function is only available on IPF.
4707 @param Index The 8-bit Data Breakpoint Register index to write.
4708 @param Value The 64-bit value to write to DBR.
4710 @return The 64-bit value written to the DBR.
4722 Writes the current value of 64-bit Performance Monitor Configuration Register (PMC).
4724 Writes current value of Performance Monitor Configuration Register specified by Index.
4725 All processor implementations provide at least 4 performance counters
4726 (PMC/PMD [4]...PMC/PMD [7] pairs), and 4 performance monitor counter overflow status
4727 registers (PMC [0]... PMC [3]). Processor implementations may provide additional
4728 implementation-dependent PMC and PMD to increase the number of 'generic' performance
4729 counters (PMC/PMD pairs). The remainder of PMC and PMD register set is implementation
4730 dependent. No parameter checking is performed on Index. If the Index value is
4731 beyond the implemented PMC register range, the write is ignored.
4732 This function is only available on IPF.
4734 @param Index The 8-bit Performance Monitor Configuration Register index to write.
4735 @param Value The 64-bit value to write to PMC.
4737 @return The 64-bit value written to the PMC.
4749 Writes the current value of 64-bit Performance Monitor Data Register (PMD).
4751 Writes current value of Performance Monitor Data Register specified by Index.
4752 All processor implementations provide at least 4 performance counters
4753 (PMC/PMD [4]...PMC/PMD [7] pairs), and 4 performance monitor counter overflow
4754 status registers (PMC [0]... PMC [3]). Processor implementations may provide
4755 additional implementation-dependent PMC and PMD to increase the number of 'generic'
4756 performance counters (PMC/PMD pairs). The remainder of PMC and PMD register set
4757 is implementation dependent. No parameter checking is performed on Index. If the
4758 Index value is beyond the implemented PMD register range, the write is ignored.
4759 This function is only available on IPF.
4761 @param Index The 8-bit Performance Monitor Data Register index to write.
4762 @param Value The 64-bit value to write to PMD.
4764 @return The 64-bit value written to the PMD.
4776 Reads the current value of 64-bit Global Pointer (GP).
4778 Reads and returns the current value of GP.
4779 This function is only available on IPF.
4781 @return The current value of GP.
4792 Write the current value of 64-bit Global Pointer (GP).
4794 Writes the current value of GP. The 64-bit value written to the GP is returned.
4795 No parameter checking is performed on Value.
4796 This function is only available on IPF.
4798 @param Value The 64-bit value to write to GP.
4800 @return The 64-bit value written to the GP.
4811 Reads the current value of 64-bit Stack Pointer (SP).
4813 Reads and returns the current value of SP.
4814 This function is only available on IPF.
4816 @return The current value of SP.
4827 Determines if the CPU is currently executing in virtual, physical, or mixed mode.
4829 Determines the current execution mode of the CPU.
4830 If the CPU is in virtual mode(PSR.RT=1, PSR.DT=1, PSR.IT=1), then 1 is returned.
4831 If the CPU is in physical mode(PSR.RT=0, PSR.DT=0, PSR.IT=0), then 0 is returned.
4832 If the CPU is not in physical mode or virtual mode, then it is in mixed mode,
4834 This function is only available on IPF.
4836 @return 1 The CPU is in virtual mode.
4837 @return 0 The CPU is in physical mode.
4838 @return -1 The CPU is in mixed mode.
4849 Makes a PAL procedure call.
4851 This is a wrapper function to make a PAL procedure call. Based on the Index
4852 value this API will make static or stacked PAL call. The following table
4853 describes the usage of PAL Procedure Index Assignment. Architected procedures
4854 may be designated as required or optional. If a PAL procedure is specified
4855 as optional, a unique return code of 0xFFFFFFFFFFFFFFFF is returned in the
4856 Status field of the PAL_CALL_RETURN structure.
4857 This indicates that the procedure is not present in this PAL implementation.
4858 It is the caller's responsibility to check for this return code after calling
4859 any optional PAL procedure.
4860 No parameter checking is performed on the 5 input parameters, but there are
4861 some common rules that the caller should follow when making a PAL call. Any
4862 address passed to PAL as buffers for return parameters must be 8-byte aligned.
4863 Unaligned addresses may cause undefined results. For those parameters defined
4864 as reserved or some fields defined as reserved must be zero filled or the invalid
4865 argument return value may be returned or undefined result may occur during the
4866 execution of the procedure. If the PalEntryPoint does not point to a valid
4867 PAL entry point then the system behavior is undefined. This function is only
4870 @param PalEntryPoint The PAL procedure calls entry point.
4871 @param Index The PAL procedure Index number.
4872 @param Arg2 The 2nd parameter for PAL procedure calls.
4873 @param Arg3 The 3rd parameter for PAL procedure calls.
4874 @param Arg4 The 4th parameter for PAL procedure calls.
4876 @return structure returned from the PAL Call procedure, including the status and return value.
4882 IN UINT64 PalEntryPoint
,
4891 Transfers control to a function starting with a new stack.
4893 Transfers control to the function specified by EntryPoint using the new stack
4894 specified by NewStack and passing in the parameters specified by Context1 and
4895 Context2. Context1 and Context2 are optional and may be NULL. The function
4896 EntryPoint must never return.
4898 If EntryPoint is NULL, then ASSERT().
4899 If NewStack is NULL, then ASSERT().
4901 @param EntryPoint A pointer to function to call with the new stack.
4902 @param Context1 A pointer to the context to pass into the EntryPoint
4904 @param Context2 A pointer to the context to pass into the EntryPoint
4906 @param NewStack A pointer to the new stack to use for the EntryPoint
4908 @param NewBsp A pointer to the new memory location for RSE backing
4914 AsmSwitchStackAndBackingStore (
4915 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
4916 IN VOID
*Context1
, OPTIONAL
4917 IN VOID
*Context2
, OPTIONAL
4924 // Bugbug: This call should be removed after
4925 // the PalCall Instance issue has been fixed.
4928 Performs a PAL call using static calling convention.
4930 An internal function to perform a PAL call using static calling convention.
4932 @param PalEntryPoint The entry point address of PAL. The address in ar.kr5
4933 would be used if this parameter were NULL on input.
4934 @param Arg1 The first argument of a PAL call.
4935 @param Arg2 The second argument of a PAL call.
4936 @param Arg3 The third argument of a PAL call.
4937 @param Arg4 The fourth argument of a PAL call.
4939 @return The values returned in r8, r9, r10 and r11.
4944 IN CONST VOID
*PalEntryPoint
,
4952 #elif defined (MDE_CPU_IA32) || defined (MDE_CPU_X64)
4954 // IA32 and X64 Specific Functions
4957 // Byte packed structure for 16-bit Real Mode EFLAGS
4961 UINT32 CF
:1; // Carry Flag
4962 UINT32 Reserved_0
:1; // Reserved
4963 UINT32 PF
:1; // Parity Flag
4964 UINT32 Reserved_1
:1; // Reserved
4965 UINT32 AF
:1; // Auxiliary Carry Flag
4966 UINT32 Reserved_2
:1; // Reserved
4967 UINT32 ZF
:1; // Zero Flag
4968 UINT32 SF
:1; // Sign Flag
4969 UINT32 TF
:1; // Trap Flag
4970 UINT32 IF
:1; // Interrupt Enable Flag
4971 UINT32 DF
:1; // Direction Flag
4972 UINT32 OF
:1; // Overflow Flag
4973 UINT32 IOPL
:2; // I/O Privilege Level
4974 UINT32 NT
:1; // Nested Task
4975 UINT32 Reserved_3
:1; // Reserved
4981 // Byte packed structure for EFLAGS/RFLAGS
4983 // 64-bits on X64. The upper 32-bits on X64 are reserved
4987 UINT32 CF
:1; // Carry Flag
4988 UINT32 Reserved_0
:1; // Reserved
4989 UINT32 PF
:1; // Parity Flag
4990 UINT32 Reserved_1
:1; // Reserved
4991 UINT32 AF
:1; // Auxiliary Carry Flag
4992 UINT32 Reserved_2
:1; // Reserved
4993 UINT32 ZF
:1; // Zero Flag
4994 UINT32 SF
:1; // Sign Flag
4995 UINT32 TF
:1; // Trap Flag
4996 UINT32 IF
:1; // Interrupt Enable Flag
4997 UINT32 DF
:1; // Direction Flag
4998 UINT32 OF
:1; // Overflow Flag
4999 UINT32 IOPL
:2; // I/O Privilege Level
5000 UINT32 NT
:1; // Nested Task
5001 UINT32 Reserved_3
:1; // Reserved
5002 UINT32 RF
:1; // Resume Flag
5003 UINT32 VM
:1; // Virtual 8086 Mode
5004 UINT32 AC
:1; // Alignment Check
5005 UINT32 VIF
:1; // Virtual Interrupt Flag
5006 UINT32 VIP
:1; // Virtual Interrupt Pending
5007 UINT32 ID
:1; // ID Flag
5008 UINT32 Reserved_4
:10; // Reserved
5014 // Byte packed structure for Control Register 0 (CR0)
5016 // 64-bits on X64. The upper 32-bits on X64 are reserved
5020 UINT32 PE
:1; // Protection Enable
5021 UINT32 MP
:1; // Monitor Coprocessor
5022 UINT32 EM
:1; // Emulation
5023 UINT32 TS
:1; // Task Switched
5024 UINT32 ET
:1; // Extension Type
5025 UINT32 NE
:1; // Numeric Error
5026 UINT32 Reserved_0
:10; // Reserved
5027 UINT32 WP
:1; // Write Protect
5028 UINT32 Reserved_1
:1; // Reserved
5029 UINT32 AM
:1; // Alignment Mask
5030 UINT32 Reserved_2
:10; // Reserved
5031 UINT32 NW
:1; // Mot Write-through
5032 UINT32 CD
:1; // Cache Disable
5033 UINT32 PG
:1; // Paging
5039 // Byte packed structure for Control Register 4 (CR4)
5041 // 64-bits on X64. The upper 32-bits on X64 are reserved
5045 UINT32 VME
:1; // Virtual-8086 Mode Extensions
5046 UINT32 PVI
:1; // Protected-Mode Virtual Interrupts
5047 UINT32 TSD
:1; // Time Stamp Disable
5048 UINT32 DE
:1; // Debugging Extensions
5049 UINT32 PSE
:1; // Page Size Extensions
5050 UINT32 PAE
:1; // Physical Address Extension
5051 UINT32 MCE
:1; // Machine Check Enable
5052 UINT32 PGE
:1; // Page Global Enable
5053 UINT32 PCE
:1; // Performance Monitoring Counter
5055 UINT32 OSFXSR
:1; // Operating System Support for
5056 // FXSAVE and FXRSTOR instructions
5057 UINT32 OSXMMEXCPT
:1; // Operating System Support for
5058 // Unmasked SIMD Floating Point
5060 UINT32 Reserved_0
:2; // Reserved
5061 UINT32 VMXE
:1; // VMX Enable
5062 UINT32 Reserved_1
:18; // Reseved
5068 // Byte packed structure for an IDTR, GDTR, LDTR descriptor
5069 /// @bug How to make this structure byte-packed in a compiler independent way?
5078 #define IA32_IDT_GATE_TYPE_TASK 0x85
5079 #define IA32_IDT_GATE_TYPE_INTERRUPT_16 0x86
5080 #define IA32_IDT_GATE_TYPE_TRAP_16 0x87
5081 #define IA32_IDT_GATE_TYPE_INTERRUPT_32 0x8E
5082 #define IA32_IDT_GATE_TYPE_TRAP_32 0x8F
5085 // Byte packed structure for an Interrupt Gate Descriptor
5089 UINT32 OffsetLow
:16; // Offset bits 15..0
5090 UINT32 Selector
:16; // Selector
5091 UINT32 Reserved_0
:8; // Reserved
5092 UINT32 GateType
:8; // Gate Type. See #defines above
5093 UINT32 OffsetHigh
:16; // Offset bits 31..16
5096 } IA32_IDT_GATE_DESCRIPTOR
;
5099 // Byte packed structure for an FP/SSE/SSE2 context
5106 // Structures for the 16-bit real mode thunks
5159 IA32_EFLAGS32 EFLAGS
;
5169 } IA32_REGISTER_SET
;
5172 // Byte packed structure for an 16-bit real mode thunks
5175 IA32_REGISTER_SET
*RealModeState
;
5176 VOID
*RealModeBuffer
;
5177 UINT32 RealModeBufferSize
;
5178 UINT32 ThunkAttributes
;
5181 #define THUNK_ATTRIBUTE_BIG_REAL_MODE 0x00000001
5182 #define THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 0x00000002
5183 #define THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL 0x00000004
5186 Retrieves CPUID information.
5188 Executes the CPUID instruction with EAX set to the value specified by Index.
5189 This function always returns Index.
5190 If Eax is not NULL, then the value of EAX after CPUID is returned in Eax.
5191 If Ebx is not NULL, then the value of EBX after CPUID is returned in Ebx.
5192 If Ecx is not NULL, then the value of ECX after CPUID is returned in Ecx.
5193 If Edx is not NULL, then the value of EDX after CPUID is returned in Edx.
5194 This function is only available on IA-32 and X64.
5196 @param Index The 32-bit value to load into EAX prior to invoking the CPUID
5198 @param Eax Pointer to the 32-bit EAX value returned by the CPUID
5199 instruction. This is an optional parameter that may be NULL.
5200 @param Ebx Pointer to the 32-bit EBX value returned by the CPUID
5201 instruction. This is an optional parameter that may be NULL.
5202 @param Ecx Pointer to the 32-bit ECX value returned by the CPUID
5203 instruction. This is an optional parameter that may be NULL.
5204 @param Edx Pointer to the 32-bit EDX value returned by the CPUID
5205 instruction. This is an optional parameter that may be NULL.
5214 OUT UINT32
*Eax
, OPTIONAL
5215 OUT UINT32
*Ebx
, OPTIONAL
5216 OUT UINT32
*Ecx
, OPTIONAL
5217 OUT UINT32
*Edx OPTIONAL
5222 Retrieves CPUID information using an extended leaf identifier.
5224 Executes the CPUID instruction with EAX set to the value specified by Index
5225 and ECX set to the value specified by SubIndex. This function always returns
5226 Index. This function is only available on IA-32 and x64.
5228 If Eax is not NULL, then the value of EAX after CPUID is returned in Eax.
5229 If Ebx is not NULL, then the value of EBX after CPUID is returned in Ebx.
5230 If Ecx is not NULL, then the value of ECX after CPUID is returned in Ecx.
5231 If Edx is not NULL, then the value of EDX after CPUID is returned in Edx.
5233 @param Index The 32-bit value to load into EAX prior to invoking the
5235 @param SubIndex The 32-bit value to load into ECX prior to invoking the
5237 @param Eax Pointer to the 32-bit EAX value returned by the CPUID
5238 instruction. This is an optional parameter that may be
5240 @param Ebx Pointer to the 32-bit EBX value returned by the CPUID
5241 instruction. This is an optional parameter that may be
5243 @param Ecx Pointer to the 32-bit ECX value returned by the CPUID
5244 instruction. This is an optional parameter that may be
5246 @param Edx Pointer to the 32-bit EDX value returned by the CPUID
5247 instruction. This is an optional parameter that may be
5258 OUT UINT32
*Eax
, OPTIONAL
5259 OUT UINT32
*Ebx
, OPTIONAL
5260 OUT UINT32
*Ecx
, OPTIONAL
5261 OUT UINT32
*Edx OPTIONAL
5266 Returns the lower 32-bits of a Machine Specific Register(MSR).
5268 Reads and returns the lower 32-bits of the MSR specified by Index.
5269 No parameter checking is performed on Index, and some Index values may cause
5270 CPU exceptions. The caller must either guarantee that Index is valid, or the
5271 caller must set up exception handlers to catch the exceptions. This function
5272 is only available on IA-32 and X64.
5274 @param Index The 32-bit MSR index to read.
5276 @return The lower 32 bits of the MSR identified by Index.
5287 Zero-extend a 32-bit value and writes it to a Machine Specific Register(MSR).
5289 Writes the 32-bit value specified by Value to the MSR specified by Index. The
5290 upper 32-bits of the MSR write are set to zero. The 32-bit value written to
5291 the MSR is returned. No parameter checking is performed on Index or Value,
5292 and some of these may cause CPU exceptions. The caller must either guarantee
5293 that Index and Value are valid, or the caller must establish proper exception
5294 handlers. This function is only available on IA-32 and X64.
5296 @param Index The 32-bit MSR index to write.
5297 @param Value The 32-bit value to write to the MSR.
5311 Reads a 64-bit MSR, performs a bitwise inclusive OR on the lower 32-bits, and
5312 writes the result back to the 64-bit MSR.
5314 Reads the 64-bit MSR specified by Index, performs a bitwise inclusive OR
5315 between the lower 32-bits of the read result and the value specified by
5316 OrData, and writes the result to the 64-bit MSR specified by Index. The lower
5317 32-bits of the value written to the MSR is returned. No parameter checking is
5318 performed on Index or OrData, and some of these may cause CPU exceptions. The
5319 caller must either guarantee that Index and OrData are valid, or the caller
5320 must establish proper exception handlers. This function is only available on
5323 @param Index The 32-bit MSR index to write.
5324 @param OrData The value to OR with the read value from the MSR.
5326 @return The lower 32-bit value written to the MSR.
5338 Reads a 64-bit MSR, performs a bitwise AND on the lower 32-bits, and writes
5339 the result back to the 64-bit MSR.
5341 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
5342 lower 32-bits of the read result and the value specified by AndData, and
5343 writes the result to the 64-bit MSR specified by Index. The lower 32-bits of
5344 the value written to the MSR is returned. No parameter checking is performed
5345 on Index or AndData, and some of these may cause CPU exceptions. The caller
5346 must either guarantee that Index and AndData are valid, or the caller must
5347 establish proper exception handlers. This function is only available on IA-32
5350 @param Index The 32-bit MSR index to write.
5351 @param AndData The value to AND with the read value from the MSR.
5353 @return The lower 32-bit value written to the MSR.
5365 Reads a 64-bit MSR, performs a bitwise AND followed by a bitwise inclusive OR
5366 on the lower 32-bits, and writes the result back to the 64-bit MSR.
5368 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
5369 lower 32-bits of the read result and the value specified by AndData
5370 preserving the upper 32-bits, performs a bitwise inclusive OR between the
5371 result of the AND operation and the value specified by OrData, and writes the
5372 result to the 64-bit MSR specified by Address. The lower 32-bits of the value
5373 written to the MSR is returned. No parameter checking is performed on Index,
5374 AndData, or OrData, and some of these may cause CPU exceptions. The caller
5375 must either guarantee that Index, AndData, and OrData are valid, or the
5376 caller must establish proper exception handlers. This function is only
5377 available on IA-32 and X64.
5379 @param Index The 32-bit MSR index to write.
5380 @param AndData The value to AND with the read value from the MSR.
5381 @param OrData The value to OR with the result of the AND operation.
5383 @return The lower 32-bit value written to the MSR.
5396 Reads a bit field of an MSR.
5398 Reads the bit field in the lower 32-bits of a 64-bit MSR. The bit field is
5399 specified by the StartBit and the EndBit. The value of the bit field is
5400 returned. The caller must either guarantee that Index is valid, or the caller
5401 must set up exception handlers to catch the exceptions. This function is only
5402 available on IA-32 and X64.
5404 If StartBit is greater than 31, then ASSERT().
5405 If EndBit is greater than 31, then ASSERT().
5406 If EndBit is less than StartBit, then ASSERT().
5408 @param Index The 32-bit MSR index to read.
5409 @param StartBit The ordinal of the least significant bit in the bit field.
5411 @param EndBit The ordinal of the most significant bit in the bit field.
5414 @return The bit field read from the MSR.
5419 AsmMsrBitFieldRead32 (
5427 Writes a bit field to an MSR.
5429 Writes Value to a bit field in the lower 32-bits of a 64-bit MSR. The bit
5430 field is specified by the StartBit and the EndBit. All other bits in the
5431 destination MSR are preserved. The lower 32-bits of the MSR written is
5432 returned. Extra left bits in Value are stripped. The caller must either
5433 guarantee that Index and the data written is valid, or the caller must set up
5434 exception handlers to catch the exceptions. This function is only available
5437 If StartBit is greater than 31, then ASSERT().
5438 If EndBit is greater than 31, then ASSERT().
5439 If EndBit is less than StartBit, then ASSERT().
5441 @param Index The 32-bit MSR index to write.
5442 @param StartBit The ordinal of the least significant bit in the bit field.
5444 @param EndBit The ordinal of the most significant bit in the bit field.
5446 @param Value New value of the bit field.
5448 @return The lower 32-bit of the value written to the MSR.
5453 AsmMsrBitFieldWrite32 (
5462 Reads a bit field in a 64-bit MSR, performs a bitwise OR, and writes the
5463 result back to the bit field in the 64-bit MSR.
5465 Reads the 64-bit MSR specified by Index, performs a bitwise inclusive OR
5466 between the read result and the value specified by OrData, and writes the
5467 result to the 64-bit MSR specified by Index. The lower 32-bits of the value
5468 written to the MSR are returned. Extra left bits in OrData are stripped. The
5469 caller must either guarantee that Index and the data written is valid, or
5470 the caller must set up exception handlers to catch the exceptions. This
5471 function is only available on IA-32 and X64.
5473 If StartBit is greater than 31, then ASSERT().
5474 If EndBit is greater than 31, then ASSERT().
5475 If EndBit is less than StartBit, then ASSERT().
5477 @param Index The 32-bit MSR index to write.
5478 @param StartBit The ordinal of the least significant bit in the bit field.
5480 @param EndBit The ordinal of the most significant bit in the bit field.
5482 @param OrData The value to OR with the read value from the MSR.
5484 @return The lower 32-bit of the value written to the MSR.
5489 AsmMsrBitFieldOr32 (
5498 Reads a bit field in a 64-bit MSR, performs a bitwise AND, and writes the
5499 result back to the bit field in the 64-bit MSR.
5501 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
5502 read result and the value specified by AndData, and writes the result to the
5503 64-bit MSR specified by Index. The lower 32-bits of the value written to the
5504 MSR are returned. Extra left bits in AndData are stripped. The caller must
5505 either guarantee that Index and the data written is valid, or the caller must
5506 set up exception handlers to catch the exceptions. This function is only
5507 available on IA-32 and X64.
5509 If StartBit is greater than 31, then ASSERT().
5510 If EndBit is greater than 31, then ASSERT().
5511 If EndBit is less than StartBit, then ASSERT().
5513 @param Index The 32-bit MSR index to write.
5514 @param StartBit The ordinal of the least significant bit in the bit field.
5516 @param EndBit The ordinal of the most significant bit in the bit field.
5518 @param AndData The value to AND with the read value from the MSR.
5520 @return The lower 32-bit of the value written to the MSR.
5525 AsmMsrBitFieldAnd32 (
5534 Reads a bit field in a 64-bit MSR, performs a bitwise AND followed by a
5535 bitwise inclusive OR, and writes the result back to the bit field in the
5538 Reads the 64-bit MSR specified by Index, performs a bitwise AND followed by a
5539 bitwise inclusive OR between the read result and the value specified by
5540 AndData, and writes the result to the 64-bit MSR specified by Index. The
5541 lower 32-bits of the value written to the MSR are returned. Extra left bits
5542 in both AndData and OrData are stripped. The caller must either guarantee
5543 that Index and the data written is valid, or the caller must set up exception
5544 handlers to catch the exceptions. This function is only available on IA-32
5547 If StartBit is greater than 31, then ASSERT().
5548 If EndBit is greater than 31, then ASSERT().
5549 If EndBit is less than StartBit, then ASSERT().
5551 @param Index The 32-bit MSR index to write.
5552 @param StartBit The ordinal of the least significant bit in the bit field.
5554 @param EndBit The ordinal of the most significant bit in the bit field.
5556 @param AndData The value to AND with the read value from the MSR.
5557 @param OrData The value to OR with the result of the AND operation.
5559 @return The lower 32-bit of the value written to the MSR.
5564 AsmMsrBitFieldAndThenOr32 (
5574 Returns a 64-bit Machine Specific Register(MSR).
5576 Reads and returns the 64-bit MSR specified by Index. No parameter checking is
5577 performed on Index, and some Index values may cause CPU exceptions. The
5578 caller must either guarantee that Index is valid, or the caller must set up
5579 exception handlers to catch the exceptions. This function is only available
5582 @param Index The 32-bit MSR index to read.
5584 @return The value of the MSR identified by Index.
5595 Writes a 64-bit value to a Machine Specific Register(MSR), and returns the
5598 Writes the 64-bit value specified by Value to the MSR specified by Index. The
5599 64-bit value written to the MSR is returned. No parameter checking is
5600 performed on Index or Value, and some of these may cause CPU exceptions. The
5601 caller must either guarantee that Index and Value are valid, or the caller
5602 must establish proper exception handlers. This function is only available on
5605 @param Index The 32-bit MSR index to write.
5606 @param Value The 64-bit value to write to the MSR.
5620 Reads a 64-bit MSR, performs a bitwise inclusive OR, and writes the result
5621 back to the 64-bit MSR.
5623 Reads the 64-bit MSR specified by Index, performs a bitwise inclusive OR
5624 between the read result and the value specified by OrData, and writes the
5625 result to the 64-bit MSR specified by Index. The value written to the MSR is
5626 returned. No parameter checking is performed on Index or OrData, and some of
5627 these may cause CPU exceptions. The caller must either guarantee that Index
5628 and OrData are valid, or the caller must establish proper exception handlers.
5629 This function is only available on IA-32 and X64.
5631 @param Index The 32-bit MSR index to write.
5632 @param OrData The value to OR with the read value from the MSR.
5634 @return The value written back to the MSR.
5646 Reads a 64-bit MSR, performs a bitwise AND, and writes the result back to the
5649 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
5650 read result and the value specified by OrData, and writes the result to the
5651 64-bit MSR specified by Index. The value written to the MSR is returned. No
5652 parameter checking is performed on Index or OrData, and some of these may
5653 cause CPU exceptions. The caller must either guarantee that Index and OrData
5654 are valid, or the caller must establish proper exception handlers. This
5655 function is only available on IA-32 and X64.
5657 @param Index The 32-bit MSR index to write.
5658 @param AndData The value to AND with the read value from the MSR.
5660 @return The value written back to the MSR.
5672 Reads a 64-bit MSR, performs a bitwise AND followed by a bitwise inclusive
5673 OR, and writes the result back to the 64-bit MSR.
5675 Reads the 64-bit MSR specified by Index, performs a bitwise AND between read
5676 result and the value specified by AndData, performs a bitwise inclusive OR
5677 between the result of the AND operation and the value specified by OrData,
5678 and writes the result to the 64-bit MSR specified by Index. The value written
5679 to the MSR is returned. No parameter checking is performed on Index, AndData,
5680 or OrData, and some of these may cause CPU exceptions. The caller must either
5681 guarantee that Index, AndData, and OrData are valid, or the caller must
5682 establish proper exception handlers. This function is only available on IA-32
5685 @param Index The 32-bit MSR index to write.
5686 @param AndData The value to AND with the read value from the MSR.
5687 @param OrData The value to OR with the result of the AND operation.
5689 @return The value written back to the MSR.
5702 Reads a bit field of an MSR.
5704 Reads the bit field in the 64-bit MSR. The bit field is specified by the
5705 StartBit and the EndBit. The value of the bit field is returned. The caller
5706 must either guarantee that Index is valid, or the caller must set up
5707 exception handlers to catch the exceptions. This function is only available
5710 If StartBit is greater than 63, then ASSERT().
5711 If EndBit is greater than 63, then ASSERT().
5712 If EndBit is less than StartBit, then ASSERT().
5714 @param Index The 32-bit MSR index to read.
5715 @param StartBit The ordinal of the least significant bit in the bit field.
5717 @param EndBit The ordinal of the most significant bit in the bit field.
5720 @return The value read from the MSR.
5725 AsmMsrBitFieldRead64 (
5733 Writes a bit field to an MSR.
5735 Writes Value to a bit field in a 64-bit MSR. The bit field is specified by
5736 the StartBit and the EndBit. All other bits in the destination MSR are
5737 preserved. The MSR written is returned. Extra left bits in Value are
5738 stripped. The caller must either guarantee that Index and the data written is
5739 valid, or the caller must set up exception handlers to catch the exceptions.
5740 This function is only available on IA-32 and X64.
5742 If StartBit is greater than 63, then ASSERT().
5743 If EndBit is greater than 63, then ASSERT().
5744 If EndBit is less than StartBit, then ASSERT().
5746 @param Index The 32-bit MSR index to write.
5747 @param StartBit The ordinal of the least significant bit in the bit field.
5749 @param EndBit The ordinal of the most significant bit in the bit field.
5751 @param Value New value of the bit field.
5753 @return The value written back to the MSR.
5758 AsmMsrBitFieldWrite64 (
5767 Reads a bit field in a 64-bit MSR, performs a bitwise inclusive OR, and
5768 writes the result back to the bit field in the 64-bit MSR.
5770 Reads the 64-bit MSR specified by Index, performs a bitwise inclusive OR
5771 between the read result and the value specified by OrData, and writes the
5772 result to the 64-bit MSR specified by Index. The value written to the MSR is
5773 returned. Extra left bits in OrData are stripped. The caller must either
5774 guarantee that Index and the data written is valid, or the caller must set up
5775 exception handlers to catch the exceptions. This function is only available
5778 If StartBit is greater than 63, then ASSERT().
5779 If EndBit is greater than 63, then ASSERT().
5780 If EndBit is less than StartBit, then ASSERT().
5782 @param Index The 32-bit MSR index to write.
5783 @param StartBit The ordinal of the least significant bit in the bit field.
5785 @param EndBit The ordinal of the most significant bit in the bit field.
5787 @param OrData The value to OR with the read value from the bit field.
5789 @return The value written back to the MSR.
5794 AsmMsrBitFieldOr64 (
5803 Reads a bit field in a 64-bit MSR, performs a bitwise AND, and writes the
5804 result back to the bit field in the 64-bit MSR.
5806 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
5807 read result and the value specified by AndData, and writes the result to the
5808 64-bit MSR specified by Index. The value written to the MSR is returned.
5809 Extra left bits in AndData are stripped. The caller must either guarantee
5810 that Index and the data written is valid, or the caller must set up exception
5811 handlers to catch the exceptions. This function is only available on IA-32
5814 If StartBit is greater than 63, then ASSERT().
5815 If EndBit is greater than 63, then ASSERT().
5816 If EndBit is less than StartBit, then ASSERT().
5818 @param Index The 32-bit MSR index to write.
5819 @param StartBit The ordinal of the least significant bit in the bit field.
5821 @param EndBit The ordinal of the most significant bit in the bit field.
5823 @param AndData The value to AND with the read value from the bit field.
5825 @return The value written back to the MSR.
5830 AsmMsrBitFieldAnd64 (
5839 Reads a bit field in a 64-bit MSR, performs a bitwise AND followed by a
5840 bitwise inclusive OR, and writes the result back to the bit field in the
5843 Reads the 64-bit MSR specified by Index, performs a bitwise AND followed by
5844 a bitwise inclusive OR between the read result and the value specified by
5845 AndData, and writes the result to the 64-bit MSR specified by Index. The
5846 value written to the MSR is returned. Extra left bits in both AndData and
5847 OrData are stripped. The caller must either guarantee that Index and the data
5848 written is valid, or the caller must set up exception handlers to catch the
5849 exceptions. This function is only available on IA-32 and X64.
5851 If StartBit is greater than 63, then ASSERT().
5852 If EndBit is greater than 63, then ASSERT().
5853 If EndBit is less than StartBit, then ASSERT().
5855 @param Index The 32-bit MSR index to write.
5856 @param StartBit The ordinal of the least significant bit in the bit field.
5858 @param EndBit The ordinal of the most significant bit in the bit field.
5860 @param AndData The value to AND with the read value from the bit field.
5861 @param OrData The value to OR with the result of the AND operation.
5863 @return The value written back to the MSR.
5868 AsmMsrBitFieldAndThenOr64 (
5878 Reads the current value of the EFLAGS register.
5880 Reads and returns the current value of the EFLAGS register. This function is
5881 only available on IA-32 and X64. This returns a 32-bit value on IA-32 and a
5882 64-bit value on X64.
5884 @return EFLAGS on IA-32 or RFLAGS on X64.
5895 Reads the current value of the Control Register 0 (CR0).
5897 Reads and returns the current value of CR0. This function is only available
5898 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
5901 @return The value of the Control Register 0 (CR0).
5912 Reads the current value of the Control Register 2 (CR2).
5914 Reads and returns the current value of CR2. This function is only available
5915 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
5918 @return The value of the Control Register 2 (CR2).
5929 Reads the current value of the Control Register 3 (CR3).
5931 Reads and returns the current value of CR3. This function is only available
5932 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
5935 @return The value of the Control Register 3 (CR3).
5946 Reads the current value of the Control Register 4 (CR4).
5948 Reads and returns the current value of CR4. This function is only available
5949 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
5952 @return The value of the Control Register 4 (CR4).
5963 Writes a value to Control Register 0 (CR0).
5965 Writes and returns a new value to CR0. This function is only available on
5966 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
5968 @param Cr0 The value to write to CR0.
5970 @return The value written to CR0.
5981 Writes a value to Control Register 2 (CR2).
5983 Writes and returns a new value to CR2. This function is only available on
5984 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
5986 @param Cr2 The value to write to CR2.
5988 @return The value written to CR2.
5999 Writes a value to Control Register 3 (CR3).
6001 Writes and returns a new value to CR3. This function is only available on
6002 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6004 @param Cr3 The value to write to CR3.
6006 @return The value written to CR3.
6017 Writes a value to Control Register 4 (CR4).
6019 Writes and returns a new value to CR4. This function is only available on
6020 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6022 @param Cr4 The value to write to CR4.
6024 @return The value written to CR4.
6035 Reads the current value of Debug Register 0 (DR0).
6037 Reads and returns the current value of DR0. This function is only available
6038 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
6041 @return The value of Debug Register 0 (DR0).
6052 Reads the current value of Debug Register 1 (DR1).
6054 Reads and returns the current value of DR1. This function is only available
6055 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
6058 @return The value of Debug Register 1 (DR1).
6069 Reads the current value of Debug Register 2 (DR2).
6071 Reads and returns the current value of DR2. This function is only available
6072 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
6075 @return The value of Debug Register 2 (DR2).
6086 Reads the current value of Debug Register 3 (DR3).
6088 Reads and returns the current value of DR3. This function is only available
6089 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
6092 @return The value of Debug Register 3 (DR3).
6103 Reads the current value of Debug Register 4 (DR4).
6105 Reads and returns the current value of DR4. This function is only available
6106 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
6109 @return The value of Debug Register 4 (DR4).
6120 Reads the current value of Debug Register 5 (DR5).
6122 Reads and returns the current value of DR5. This function is only available
6123 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
6126 @return The value of Debug Register 5 (DR5).
6137 Reads the current value of Debug Register 6 (DR6).
6139 Reads and returns the current value of DR6. This function is only available
6140 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
6143 @return The value of Debug Register 6 (DR6).
6154 Reads the current value of Debug Register 7 (DR7).
6156 Reads and returns the current value of DR7. This function is only available
6157 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
6160 @return The value of Debug Register 7 (DR7).
6171 Writes a value to Debug Register 0 (DR0).
6173 Writes and returns a new value to DR0. This function is only available on
6174 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6176 @param Dr0 The value to write to Dr0.
6178 @return The value written to Debug Register 0 (DR0).
6189 Writes a value to Debug Register 1 (DR1).
6191 Writes and returns a new value to DR1. This function is only available on
6192 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6194 @param Dr1 The value to write to Dr1.
6196 @return The value written to Debug Register 1 (DR1).
6207 Writes a value to Debug Register 2 (DR2).
6209 Writes and returns a new value to DR2. This function is only available on
6210 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6212 @param Dr2 The value to write to Dr2.
6214 @return The value written to Debug Register 2 (DR2).
6225 Writes a value to Debug Register 3 (DR3).
6227 Writes and returns a new value to DR3. This function is only available on
6228 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6230 @param Dr3 The value to write to Dr3.
6232 @return The value written to Debug Register 3 (DR3).
6243 Writes a value to Debug Register 4 (DR4).
6245 Writes and returns a new value to DR4. This function is only available on
6246 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6248 @param Dr4 The value to write to Dr4.
6250 @return The value written to Debug Register 4 (DR4).
6261 Writes a value to Debug Register 5 (DR5).
6263 Writes and returns a new value to DR5. This function is only available on
6264 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6266 @param Dr5 The value to write to Dr5.
6268 @return The value written to Debug Register 5 (DR5).
6279 Writes a value to Debug Register 6 (DR6).
6281 Writes and returns a new value to DR6. This function is only available on
6282 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6284 @param Dr6 The value to write to Dr6.
6286 @return The value written to Debug Register 6 (DR6).
6297 Writes a value to Debug Register 7 (DR7).
6299 Writes and returns a new value to DR7. This function is only available on
6300 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6302 @param Dr7 The value to write to Dr7.
6304 @return The value written to Debug Register 7 (DR7).
6315 Reads the current value of Code Segment Register (CS).
6317 Reads and returns the current value of CS. This function is only available on
6320 @return The current value of CS.
6331 Reads the current value of Data Segment Register (DS).
6333 Reads and returns the current value of DS. This function is only available on
6336 @return The current value of DS.
6347 Reads the current value of Extra Segment Register (ES).
6349 Reads and returns the current value of ES. This function is only available on
6352 @return The current value of ES.
6363 Reads the current value of FS Data Segment Register (FS).
6365 Reads and returns the current value of FS. This function is only available on
6368 @return The current value of FS.
6379 Reads the current value of GS Data Segment Register (GS).
6381 Reads and returns the current value of GS. This function is only available on
6384 @return The current value of GS.
6395 Reads the current value of Stack Segment Register (SS).
6397 Reads and returns the current value of SS. This function is only available on
6400 @return The current value of SS.
6411 Reads the current value of Task Register (TR).
6413 Reads and returns the current value of TR. This function is only available on
6416 @return The current value of TR.
6427 Reads the current Global Descriptor Table Register(GDTR) descriptor.
6429 Reads and returns the current GDTR descriptor and returns it in Gdtr. This
6430 function is only available on IA-32 and X64.
6432 If Gdtr is NULL, then ASSERT().
6434 @param Gdtr Pointer to a GDTR descriptor.
6440 OUT IA32_DESCRIPTOR
*Gdtr
6445 Writes the current Global Descriptor Table Register (GDTR) descriptor.
6447 Writes and the current GDTR descriptor specified by Gdtr. This function is
6448 only available on IA-32 and X64.
6450 If Gdtr is NULL, then ASSERT().
6452 @param Gdtr Pointer to a GDTR descriptor.
6458 IN CONST IA32_DESCRIPTOR
*Gdtr
6463 Reads the current Interrupt Descriptor Table Register(GDTR) descriptor.
6465 Reads and returns the current IDTR descriptor and returns it in Idtr. This
6466 function is only available on IA-32 and X64.
6468 If Idtr is NULL, then ASSERT().
6470 @param Idtr Pointer to a IDTR descriptor.
6476 OUT IA32_DESCRIPTOR
*Idtr
6481 Writes the current Interrupt Descriptor Table Register(GDTR) descriptor.
6483 Writes the current IDTR descriptor and returns it in Idtr. This function is
6484 only available on IA-32 and X64.
6486 If Idtr is NULL, then ASSERT().
6488 @param Idtr Pointer to a IDTR descriptor.
6494 IN CONST IA32_DESCRIPTOR
*Idtr
6499 Reads the current Local Descriptor Table Register(LDTR) selector.
6501 Reads and returns the current 16-bit LDTR descriptor value. This function is
6502 only available on IA-32 and X64.
6504 @return The current selector of LDT.
6515 Writes the current Local Descriptor Table Register (GDTR) selector.
6517 Writes and the current LDTR descriptor specified by Ldtr. This function is
6518 only available on IA-32 and X64.
6520 @param Ldtr 16-bit LDTR selector value.
6531 Save the current floating point/SSE/SSE2 context to a buffer.
6533 Saves the current floating point/SSE/SSE2 state to the buffer specified by
6534 Buffer. Buffer must be aligned on a 16-byte boundary. This function is only
6535 available on IA-32 and X64.
6537 If Buffer is NULL, then ASSERT().
6538 If Buffer is not aligned on a 16-byte boundary, then ASSERT().
6540 @param Buffer Pointer to a buffer to save the floating point/SSE/SSE2 context.
6546 OUT IA32_FX_BUFFER
*Buffer
6551 Restores the current floating point/SSE/SSE2 context from a buffer.
6553 Restores the current floating point/SSE/SSE2 state from the buffer specified
6554 by Buffer. Buffer must be aligned on a 16-byte boundary. This function is
6555 only available on IA-32 and X64.
6557 If Buffer is NULL, then ASSERT().
6558 If Buffer is not aligned on a 16-byte boundary, then ASSERT().
6559 If Buffer was not saved with AsmFxSave(), then ASSERT().
6561 @param Buffer Pointer to a buffer to save the floating point/SSE/SSE2 context.
6567 IN CONST IA32_FX_BUFFER
*Buffer
6572 Reads the current value of 64-bit MMX Register #0 (MM0).
6574 Reads and returns the current value of MM0. This function is only available
6577 @return The current value of MM0.
6588 Reads the current value of 64-bit MMX Register #1 (MM1).
6590 Reads and returns the current value of MM1. This function is only available
6593 @return The current value of MM1.
6604 Reads the current value of 64-bit MMX Register #2 (MM2).
6606 Reads and returns the current value of MM2. This function is only available
6609 @return The current value of MM2.
6620 Reads the current value of 64-bit MMX Register #3 (MM3).
6622 Reads and returns the current value of MM3. This function is only available
6625 @return The current value of MM3.
6636 Reads the current value of 64-bit MMX Register #4 (MM4).
6638 Reads and returns the current value of MM4. This function is only available
6641 @return The current value of MM4.
6652 Reads the current value of 64-bit MMX Register #5 (MM5).
6654 Reads and returns the current value of MM5. This function is only available
6657 @return The current value of MM5.
6668 Reads the current value of 64-bit MMX Register #6 (MM6).
6670 Reads and returns the current value of MM6. This function is only available
6673 @return The current value of MM6.
6684 Reads the current value of 64-bit MMX Register #7 (MM7).
6686 Reads and returns the current value of MM7. This function is only available
6689 @return The current value of MM7.
6700 Writes the current value of 64-bit MMX Register #0 (MM0).
6702 Writes the current value of MM0. This function is only available on IA32 and
6705 @param Value The 64-bit value to write to MM0.
6716 Writes the current value of 64-bit MMX Register #1 (MM1).
6718 Writes the current value of MM1. This function is only available on IA32 and
6721 @param Value The 64-bit value to write to MM1.
6732 Writes the current value of 64-bit MMX Register #2 (MM2).
6734 Writes the current value of MM2. This function is only available on IA32 and
6737 @param Value The 64-bit value to write to MM2.
6748 Writes the current value of 64-bit MMX Register #3 (MM3).
6750 Writes the current value of MM3. This function is only available on IA32 and
6753 @param Value The 64-bit value to write to MM3.
6764 Writes the current value of 64-bit MMX Register #4 (MM4).
6766 Writes the current value of MM4. This function is only available on IA32 and
6769 @param Value The 64-bit value to write to MM4.
6780 Writes the current value of 64-bit MMX Register #5 (MM5).
6782 Writes the current value of MM5. This function is only available on IA32 and
6785 @param Value The 64-bit value to write to MM5.
6796 Writes the current value of 64-bit MMX Register #6 (MM6).
6798 Writes the current value of MM6. This function is only available on IA32 and
6801 @param Value The 64-bit value to write to MM6.
6812 Writes the current value of 64-bit MMX Register #7 (MM7).
6814 Writes the current value of MM7. This function is only available on IA32 and
6817 @param Value The 64-bit value to write to MM7.
6828 Reads the current value of Time Stamp Counter (TSC).
6830 Reads and returns the current value of TSC. This function is only available
6833 @return The current value of TSC
6844 Reads the current value of a Performance Counter (PMC).
6846 Reads and returns the current value of performance counter specified by
6847 Index. This function is only available on IA-32 and X64.
6849 @param Index The 32-bit Performance Counter index to read.
6851 @return The value of the PMC specified by Index.
6862 Sets up a monitor buffer that is used by AsmMwait().
6864 Executes a MONITOR instruction with the register state specified by Eax, Ecx
6865 and Edx. Returns Eax. This function is only available on IA-32 and X64.
6867 @param Eax The value to load into EAX or RAX before executing the MONITOR
6869 @param Ecx The value to load into ECX or RCX before executing the MONITOR
6871 @param Edx The value to load into EDX or RDX before executing the MONITOR
6887 Executes an MWAIT instruction.
6889 Executes an MWAIT instruction with the register state specified by Eax and
6890 Ecx. Returns Eax. This function is only available on IA-32 and X64.
6892 @param Eax The value to load into EAX or RAX before executing the MONITOR
6894 @param Ecx The value to load into ECX or RCX before executing the MONITOR
6909 Executes a WBINVD instruction.
6911 Executes a WBINVD instruction. This function is only available on IA-32 and
6923 Executes a INVD instruction.
6925 Executes a INVD instruction. This function is only available on IA-32 and
6937 Flushes a cache line from all the instruction and data caches within the
6938 coherency domain of the CPU.
6940 Flushed the cache line specified by LinearAddress, and returns LinearAddress.
6941 This function is only available on IA-32 and X64.
6943 @param LinearAddress The address of the cache line to flush. If the CPU is
6944 in a physical addressing mode, then LinearAddress is a
6945 physical address. If the CPU is in a virtual
6946 addressing mode, then LinearAddress is a virtual
6949 @return LinearAddress
6954 IN VOID
*LinearAddress
6959 Enables the 32-bit paging mode on the CPU.
6961 Enables the 32-bit paging mode on the CPU. CR0, CR3, CR4, and the page tables
6962 must be properly initialized prior to calling this service. This function
6963 assumes the current execution mode is 32-bit protected mode. This function is
6964 only available on IA-32. After the 32-bit paging mode is enabled, control is
6965 transferred to the function specified by EntryPoint using the new stack
6966 specified by NewStack and passing in the parameters specified by Context1 and
6967 Context2. Context1 and Context2 are optional and may be NULL. The function
6968 EntryPoint must never return.
6970 If the current execution mode is not 32-bit protected mode, then ASSERT().
6971 If EntryPoint is NULL, then ASSERT().
6972 If NewStack is NULL, then ASSERT().
6974 There are a number of constraints that must be followed before calling this
6976 1) Interrupts must be disabled.
6977 2) The caller must be in 32-bit protected mode with flat descriptors. This
6978 means all descriptors must have a base of 0 and a limit of 4GB.
6979 3) CR0 and CR4 must be compatible with 32-bit protected mode with flat
6981 4) CR3 must point to valid page tables that will be used once the transition
6982 is complete, and those page tables must guarantee that the pages for this
6983 function and the stack are identity mapped.
6985 @param EntryPoint A pointer to function to call with the new stack after
6987 @param Context1 A pointer to the context to pass into the EntryPoint
6988 function as the first parameter after paging is enabled.
6989 @param Context2 A pointer to the context to pass into the EntryPoint
6990 function as the second parameter after paging is enabled.
6991 @param NewStack A pointer to the new stack to use for the EntryPoint
6992 function after paging is enabled.
6998 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
6999 IN VOID
*Context1
, OPTIONAL
7000 IN VOID
*Context2
, OPTIONAL
7006 Disables the 32-bit paging mode on the CPU.
7008 Disables the 32-bit paging mode on the CPU and returns to 32-bit protected
7009 mode. This function assumes the current execution mode is 32-paged protected
7010 mode. This function is only available on IA-32. After the 32-bit paging mode
7011 is disabled, control is transferred to the function specified by EntryPoint
7012 using the new stack specified by NewStack and passing in the parameters
7013 specified by Context1 and Context2. Context1 and Context2 are optional and
7014 may be NULL. The function EntryPoint must never return.
7016 If the current execution mode is not 32-bit paged mode, then ASSERT().
7017 If EntryPoint is NULL, then ASSERT().
7018 If NewStack is NULL, then ASSERT().
7020 There are a number of constraints that must be followed before calling this
7022 1) Interrupts must be disabled.
7023 2) The caller must be in 32-bit paged mode.
7024 3) CR0, CR3, and CR4 must be compatible with 32-bit paged mode.
7025 4) CR3 must point to valid page tables that guarantee that the pages for
7026 this function and the stack are identity mapped.
7028 @param EntryPoint A pointer to function to call with the new stack after
7030 @param Context1 A pointer to the context to pass into the EntryPoint
7031 function as the first parameter after paging is disabled.
7032 @param Context2 A pointer to the context to pass into the EntryPoint
7033 function as the second parameter after paging is
7035 @param NewStack A pointer to the new stack to use for the EntryPoint
7036 function after paging is disabled.
7041 AsmDisablePaging32 (
7042 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
7043 IN VOID
*Context1
, OPTIONAL
7044 IN VOID
*Context2
, OPTIONAL
7050 Enables the 64-bit paging mode on the CPU.
7052 Enables the 64-bit paging mode on the CPU. CR0, CR3, CR4, and the page tables
7053 must be properly initialized prior to calling this service. This function
7054 assumes the current execution mode is 32-bit protected mode with flat
7055 descriptors. This function is only available on IA-32. After the 64-bit
7056 paging mode is enabled, control is transferred to the function specified by
7057 EntryPoint using the new stack specified by NewStack and passing in the
7058 parameters specified by Context1 and Context2. Context1 and Context2 are
7059 optional and may be 0. The function EntryPoint must never return.
7061 If the current execution mode is not 32-bit protected mode with flat
7062 descriptors, then ASSERT().
7063 If EntryPoint is 0, then ASSERT().
7064 If NewStack is 0, then ASSERT().
7066 @param CodeSelector The 16-bit selector to load in the CS before EntryPoint
7067 is called. The descriptor in the GDT that this selector
7068 references must be setup for long mode.
7069 @param EntryPoint The 64-bit virtual address of the function to call with
7070 the new stack after paging is enabled.
7071 @param Context1 The 64-bit virtual address of the context to pass into
7072 the EntryPoint function as the first parameter after
7074 @param Context2 The 64-bit virtual address of the context to pass into
7075 the EntryPoint function as the second parameter after
7077 @param NewStack The 64-bit virtual address of the new stack to use for
7078 the EntryPoint function after paging is enabled.
7084 IN UINT16 CodeSelector
,
7085 IN UINT64 EntryPoint
,
7086 IN UINT64 Context1
, OPTIONAL
7087 IN UINT64 Context2
, OPTIONAL
7093 Disables the 64-bit paging mode on the CPU.
7095 Disables the 64-bit paging mode on the CPU and returns to 32-bit protected
7096 mode. This function assumes the current execution mode is 64-paging mode.
7097 This function is only available on X64. After the 64-bit paging mode is
7098 disabled, control is transferred to the function specified by EntryPoint
7099 using the new stack specified by NewStack and passing in the parameters
7100 specified by Context1 and Context2. Context1 and Context2 are optional and
7101 may be 0. The function EntryPoint must never return.
7103 If the current execution mode is not 64-bit paged mode, then ASSERT().
7104 If EntryPoint is 0, then ASSERT().
7105 If NewStack is 0, then ASSERT().
7107 @param CodeSelector The 16-bit selector to load in the CS before EntryPoint
7108 is called. The descriptor in the GDT that this selector
7109 references must be setup for 32-bit protected mode.
7110 @param EntryPoint The 64-bit virtual address of the function to call with
7111 the new stack after paging is disabled.
7112 @param Context1 The 64-bit virtual address of the context to pass into
7113 the EntryPoint function as the first parameter after
7115 @param Context2 The 64-bit virtual address of the context to pass into
7116 the EntryPoint function as the second parameter after
7118 @param NewStack The 64-bit virtual address of the new stack to use for
7119 the EntryPoint function after paging is disabled.
7124 AsmDisablePaging64 (
7125 IN UINT16 CodeSelector
,
7126 IN UINT32 EntryPoint
,
7127 IN UINT32 Context1
, OPTIONAL
7128 IN UINT32 Context2
, OPTIONAL
7134 // 16-bit thunking services
7138 Retrieves the properties for 16-bit thunk functions.
7140 Computes the size of the buffer and stack below 1MB required to use the
7141 AsmPrepareThunk16(), AsmThunk16() and AsmPrepareAndThunk16() functions. This
7142 buffer size is returned in RealModeBufferSize, and the stack size is returned
7143 in ExtraStackSize. If parameters are passed to the 16-bit real mode code,
7144 then the actual minimum stack size is ExtraStackSize plus the maximum number
7145 of bytes that need to be passed to the 16-bit real mode code.
7147 If RealModeBufferSize is NULL, then ASSERT().
7148 If ExtraStackSize is NULL, then ASSERT().
7150 @param RealModeBufferSize A pointer to the size of the buffer below 1MB
7151 required to use the 16-bit thunk functions.
7152 @param ExtraStackSize A pointer to the extra size of stack below 1MB
7153 that the 16-bit thunk functions require for
7154 temporary storage in the transition to and from
7160 AsmGetThunk16Properties (
7161 OUT UINT32
*RealModeBufferSize
,
7162 OUT UINT32
*ExtraStackSize
7167 Prepares all structures a code required to use AsmThunk16().
7169 Prepares all structures and code required to use AsmThunk16().
7171 If ThunkContext is NULL, then ASSERT().
7173 @param ThunkContext A pointer to the context structure that describes the
7174 16-bit real mode code to call.
7180 OUT THUNK_CONTEXT
*ThunkContext
7185 Transfers control to a 16-bit real mode entry point and returns the results.
7187 Transfers control to a 16-bit real mode entry point and returns the results.
7188 AsmPrepareThunk16() must be called with ThunkContext before this function is
7191 If ThunkContext is NULL, then ASSERT().
7192 If AsmPrepareThunk16() was not previously called with ThunkContext, then ASSERT().
7194 @param ThunkContext A pointer to the context structure that describes the
7195 16-bit real mode code to call.
7201 IN OUT THUNK_CONTEXT
*ThunkContext
7206 Prepares all structures and code for a 16-bit real mode thunk, transfers
7207 control to a 16-bit real mode entry point, and returns the results.
7209 Prepares all structures and code for a 16-bit real mode thunk, transfers
7210 control to a 16-bit real mode entry point, and returns the results. If the
7211 caller only need to perform a single 16-bit real mode thunk, then this
7212 service should be used. If the caller intends to make more than one 16-bit
7213 real mode thunk, then it is more efficient if AsmPrepareThunk16() is called
7214 once and AsmThunk16() can be called for each 16-bit real mode thunk.
7216 If ThunkContext is NULL, then ASSERT().
7218 @param ThunkContext A pointer to the context structure that describes the
7219 16-bit real mode code to call.
7224 AsmPrepareAndThunk16 (
7225 IN OUT THUNK_CONTEXT
*ThunkContext