2 Provides string functions, linked list functions, math functions, synchronization
3 functions, and CPU architecture specific functions.
5 Copyright (c) 2006 - 2008, Intel Corporation
6 All rights reserved. This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
20 /// Definitions for SPIN_LOCK
22 typedef volatile UINTN SPIN_LOCK
;
25 // Definitions for architecture specific types
27 #if defined (MDE_CPU_IA32)
29 /// IA32 context buffer used by SetJump() and LongJump()
38 } BASE_LIBRARY_JUMP_BUFFER
;
40 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 4
42 #elif defined (MDE_CPU_IPF)
45 /// IPF context buffer used by SetJump() and LongJump()
80 UINT64 AfterSpillUNAT
;
86 } BASE_LIBRARY_JUMP_BUFFER
;
88 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 0x10
90 #elif defined (MDE_CPU_X64)
92 /// X64 context buffer used by SetJump() and LongJump()
105 } BASE_LIBRARY_JUMP_BUFFER
;
107 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 8
109 #elif defined (MDE_CPU_EBC)
111 /// EBC context buffer used by SetJump() and LongJump()
119 } BASE_LIBRARY_JUMP_BUFFER
;
121 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 8
124 #error Unknown Processor Type
132 Copies one Null-terminated Unicode string to another Null-terminated Unicode
133 string and returns the new Unicode string.
135 This function copies the contents of the Unicode string Source to the Unicode
136 string Destination, and returns Destination. If Source and Destination
137 overlap, then the results are undefined.
139 If Destination is NULL, then ASSERT().
140 If Destination is not aligned on a 16-bit boundary, then ASSERT().
141 If Source is NULL, then ASSERT().
142 If Source is not aligned on a 16-bit boundary, then ASSERT().
143 If Source and Destination overlap, then ASSERT().
144 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
145 PcdMaximumUnicodeStringLength Unicode characters not including the
146 Null-terminator, then ASSERT().
148 @param Destination Pointer to a Null-terminated Unicode string.
149 @param Source Pointer to a Null-terminated Unicode string.
157 OUT CHAR16
*Destination
,
158 IN CONST CHAR16
*Source
163 Copies one Null-terminated Unicode string with a maximum length to another
164 Null-terminated Unicode string with a maximum length and returns the new
167 This function copies the contents of the Unicode string Source to the Unicode
168 string Destination, and returns Destination. At most, Length Unicode
169 characters are copied from Source to Destination. If Length is 0, then
170 Destination is returned unmodified. If Length is greater that the number of
171 Unicode characters in Source, then Destination is padded with Null Unicode
172 characters. If Source and Destination overlap, then the results are
175 If Length > 0 and Destination is NULL, then ASSERT().
176 If Length > 0 and Destination is not aligned on a 16-bit boundary, then ASSERT().
177 If Length > 0 and Source is NULL, then ASSERT().
178 If Length > 0 and Source is not aligned on a 16-bit bounadry, then ASSERT().
179 If Source and Destination overlap, then ASSERT().
180 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
181 PcdMaximumUnicodeStringLength Unicode characters not including the
182 Null-terminator, then ASSERT().
184 @param Destination Pointer to a Null-terminated Unicode string.
185 @param Source Pointer to a Null-terminated Unicode string.
186 @param Length Maximum number of Unicode characters to copy.
194 OUT CHAR16
*Destination
,
195 IN CONST CHAR16
*Source
,
201 Returns the length of a Null-terminated Unicode string.
203 This function returns the number of Unicode characters in the Null-terminated
204 Unicode string specified by String.
206 If String is NULL, then ASSERT().
207 If String is not aligned on a 16-bit boundary, then ASSERT().
208 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
209 PcdMaximumUnicodeStringLength Unicode characters not including the
210 Null-terminator, then ASSERT().
212 @param String Pointer to a Null-terminated Unicode string.
214 @return The length of String.
220 IN CONST CHAR16
*String
225 Returns the size of a Null-terminated Unicode string in bytes, including the
228 This function returns the size, in bytes, of the Null-terminated Unicode
229 string specified by String.
231 If String is NULL, then ASSERT().
232 If String is not aligned on a 16-bit boundary, then ASSERT().
233 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
234 PcdMaximumUnicodeStringLength Unicode characters not including the
235 Null-terminator, then ASSERT().
237 @param String Pointer to a Null-terminated Unicode string.
239 @return The size of String.
245 IN CONST CHAR16
*String
250 Compares two Null-terminated Unicode strings, and returns the difference
251 between the first mismatched Unicode characters.
253 This function compares the Null-terminated Unicode string FirstString to the
254 Null-terminated Unicode string SecondString. If FirstString is identical to
255 SecondString, then 0 is returned. Otherwise, the value returned is the first
256 mismatched Unicode character in SecondString subtracted from the first
257 mismatched Unicode character in FirstString.
259 If FirstString is NULL, then ASSERT().
260 If FirstString is not aligned on a 16-bit boundary, then ASSERT().
261 If SecondString is NULL, then ASSERT().
262 If SecondString is not aligned on a 16-bit boundary, then ASSERT().
263 If PcdMaximumUnicodeStringLength is not zero, and FirstString contains more
264 than PcdMaximumUnicodeStringLength Unicode characters not including the
265 Null-terminator, then ASSERT().
266 If PcdMaximumUnicodeStringLength is not zero, and SecondString contains more
267 than PcdMaximumUnicodeStringLength Unicode characters not including the
268 Null-terminator, then ASSERT().
270 @param FirstString Pointer to a Null-terminated Unicode string.
271 @param SecondString Pointer to a Null-terminated Unicode string.
273 @retval 0 FirstString is identical to SecondString.
274 @return others FirstString is not identical to SecondString.
280 IN CONST CHAR16
*FirstString
,
281 IN CONST CHAR16
*SecondString
286 Compares two Null-terminated Unicode strings with maximum lengths, and
287 returns the difference between the first mismatched Unicode characters.
289 This function compares the Null-terminated Unicode string FirstString to the
290 Null-terminated Unicode string SecondString. At most, Length Unicode
291 characters will be compared. If Length is 0, then 0 is returned. If
292 FirstString is identical to SecondString, then 0 is returned. Otherwise, the
293 value returned is the first mismatched Unicode character in SecondString
294 subtracted from the first mismatched Unicode character in FirstString.
296 If Length > 0 and FirstString is NULL, then ASSERT().
297 If Length > 0 and FirstString is not aligned on a 16-bit bounadary, then ASSERT().
298 If Length > 0 and SecondString is NULL, then ASSERT().
299 If Length > 0 and SecondString is not aligned on a 16-bit bounadary, then ASSERT().
300 If PcdMaximumUnicodeStringLength is not zero, and FirstString contains more
301 than PcdMaximumUnicodeStringLength Unicode characters not including the
302 Null-terminator, then ASSERT().
303 If PcdMaximumUnicodeStringLength is not zero, and SecondString contains more
304 than PcdMaximumUnicodeStringLength Unicode characters not including the
305 Null-terminator, then ASSERT().
307 @param FirstString Pointer to a Null-terminated Unicode string.
308 @param SecondString Pointer to a Null-terminated Unicode string.
309 @param Length Maximum number of Unicode characters to compare.
311 @retval 0 FirstString is identical to SecondString.
312 @return others FirstString is not identical to SecondString.
318 IN CONST CHAR16
*FirstString
,
319 IN CONST CHAR16
*SecondString
,
325 Concatenates one Null-terminated Unicode string to another Null-terminated
326 Unicode string, and returns the concatenated Unicode string.
328 This function concatenates two Null-terminated Unicode strings. The contents
329 of Null-terminated Unicode string Source are concatenated to the end of
330 Null-terminated Unicode string Destination. The Null-terminated concatenated
331 Unicode String is returned. If Source and Destination overlap, then the
332 results are undefined.
334 If Destination is NULL, then ASSERT().
335 If Destination is not aligned on a 16-bit bounadary, then ASSERT().
336 If Source is NULL, then ASSERT().
337 If Source is not aligned on a 16-bit bounadary, then ASSERT().
338 If Source and Destination overlap, then ASSERT().
339 If PcdMaximumUnicodeStringLength is not zero, and Destination contains more
340 than PcdMaximumUnicodeStringLength Unicode characters not including the
341 Null-terminator, then ASSERT().
342 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
343 PcdMaximumUnicodeStringLength Unicode characters not including the
344 Null-terminator, then ASSERT().
345 If PcdMaximumUnicodeStringLength is not zero, and concatenating Destination
346 and Source results in a Unicode string with more than
347 PcdMaximumUnicodeStringLength Unicode characters not including the
348 Null-terminator, then ASSERT().
350 @param Destination Pointer to a Null-terminated Unicode string.
351 @param Source Pointer to a Null-terminated Unicode string.
359 IN OUT CHAR16
*Destination
,
360 IN CONST CHAR16
*Source
365 Concatenates one Null-terminated Unicode string with a maximum length to the
366 end of another Null-terminated Unicode string, and returns the concatenated
369 This function concatenates two Null-terminated Unicode strings. The contents
370 of Null-terminated Unicode string Source are concatenated to the end of
371 Null-terminated Unicode string Destination, and Destination is returned. At
372 most, Length Unicode characters are concatenated from Source to the end of
373 Destination, and Destination is always Null-terminated. If Length is 0, then
374 Destination is returned unmodified. If Source and Destination overlap, then
375 the results are undefined.
377 If Destination is NULL, then ASSERT().
378 If Length > 0 and Destination is not aligned on a 16-bit boundary, then ASSERT().
379 If Length > 0 and Source is NULL, then ASSERT().
380 If Length > 0 and Source is not aligned on a 16-bit boundary, then ASSERT().
381 If Source and Destination overlap, then ASSERT().
382 If PcdMaximumUnicodeStringLength is not zero, and Destination contains more
383 than PcdMaximumUnicodeStringLength Unicode characters not including the
384 Null-terminator, then ASSERT().
385 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
386 PcdMaximumUnicodeStringLength Unicode characters not including the
387 Null-terminator, then ASSERT().
388 If PcdMaximumUnicodeStringLength is not zero, and concatenating Destination
389 and Source results in a Unicode string with more than
390 PcdMaximumUnicodeStringLength Unicode characters not including the
391 Null-terminator, then ASSERT().
393 @param Destination Pointer to a Null-terminated Unicode string.
394 @param Source Pointer to a Null-terminated Unicode string.
395 @param Length Maximum number of Unicode characters to concatenate from
404 IN OUT CHAR16
*Destination
,
405 IN CONST CHAR16
*Source
,
410 Returns the first occurance of a Null-terminated Unicode sub-string
411 in a Null-terminated Unicode string.
413 This function scans the contents of the Null-terminated Unicode string
414 specified by String and returns the first occurrence of SearchString.
415 If SearchString is not found in String, then NULL is returned. If
416 the length of SearchString is zero, then String is
419 If String is NULL, then ASSERT().
420 If String is not aligned on a 16-bit boundary, then ASSERT().
421 If SearchString is NULL, then ASSERT().
422 If SearchString is not aligned on a 16-bit boundary, then ASSERT().
424 If PcdMaximumUnicodeStringLength is not zero, and SearchString
425 or String contains more than PcdMaximumUnicodeStringLength Unicode
426 characters not including the Null-terminator, then ASSERT().
428 @param String Pointer to a Null-terminated Unicode string.
429 @param SearchString Pointer to a Null-terminated Unicode string to search for.
431 @retval NULL If the SearchString does not appear in String.
432 @return others If there is a match.
438 IN CONST CHAR16
*String
,
439 IN CONST CHAR16
*SearchString
443 Convert a Null-terminated Unicode decimal string to a value of
446 This function returns a value of type UINTN by interpreting the contents
447 of the Unicode string specified by String as a decimal number. The format
448 of the input Unicode string String is:
450 [spaces] [decimal digits].
452 The valid decimal digit character is in the range [0-9]. The
453 function will ignore the pad space, which includes spaces or
454 tab characters, before [decimal digits]. The running zero in the
455 beginning of [decimal digits] will be ignored. Then, the function
456 stops at the first character that is a not a valid decimal character
457 or a Null-terminator, whichever one comes first.
459 If String is NULL, then ASSERT().
460 If String is not aligned in a 16-bit boundary, then ASSERT().
461 If String has only pad spaces, then 0 is returned.
462 If String has no pad spaces or valid decimal digits,
464 If the number represented by String overflows according
465 to the range defined by UINTN, then ASSERT().
467 If PcdMaximumUnicodeStringLength is not zero, and String contains
468 more than PcdMaximumUnicodeStringLength Unicode characters not including
469 the Null-terminator, then ASSERT().
471 @param String Pointer to a Null-terminated Unicode string.
473 @retval Value translated from String.
479 IN CONST CHAR16
*String
483 Convert a Null-terminated Unicode decimal string to a value of
486 This function returns a value of type UINT64 by interpreting the contents
487 of the Unicode string specified by String as a decimal number. The format
488 of the input Unicode string String is:
490 [spaces] [decimal digits].
492 The valid decimal digit character is in the range [0-9]. The
493 function will ignore the pad space, which includes spaces or
494 tab characters, before [decimal digits]. The running zero in the
495 beginning of [decimal digits] will be ignored. Then, the function
496 stops at the first character that is a not a valid decimal character
497 or a Null-terminator, whichever one comes first.
499 If String is NULL, then ASSERT().
500 If String is not aligned in a 16-bit boundary, then ASSERT().
501 If String has only pad spaces, then 0 is returned.
502 If String has no pad spaces or valid decimal digits,
504 If the number represented by String overflows according
505 to the range defined by UINT64, then ASSERT().
507 If PcdMaximumUnicodeStringLength is not zero, and String contains
508 more than PcdMaximumUnicodeStringLength Unicode characters not including
509 the Null-terminator, then ASSERT().
511 @param String Pointer to a Null-terminated Unicode string.
513 @retval Value translated from String.
519 IN CONST CHAR16
*String
524 Convert a Null-terminated Unicode hexadecimal string to a value of type UINTN.
526 This function returns a value of type UINTN by interpreting the contents
527 of the Unicode string specified by String as a hexadecimal number.
528 The format of the input Unicode string String is:
530 [spaces][zeros][x][hexadecimal digits].
532 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
533 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix.
534 If "x" appears in the input string, it must be prefixed with at least one 0.
535 The function will ignore the pad space, which includes spaces or tab characters,
536 before [zeros], [x] or [hexadecimal digit]. The running zero before [x] or
537 [hexadecimal digit] will be ignored. Then, the decoding starts after [x] or the
538 first valid hexadecimal digit. Then, the function stops at the first character that is
539 a not a valid hexadecimal character or NULL, whichever one comes first.
541 If String is NULL, then ASSERT().
542 If String is not aligned in a 16-bit boundary, then ASSERT().
543 If String has only pad spaces, then zero is returned.
544 If String has no leading pad spaces, leading zeros or valid hexadecimal digits,
545 then zero is returned.
546 If the number represented by String overflows according to the range defined by
547 UINTN, then ASSERT().
549 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
550 PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator,
553 @param String Pointer to a Null-terminated Unicode string.
555 @retval Value translated from String.
561 IN CONST CHAR16
*String
566 Convert a Null-terminated Unicode hexadecimal string to a value of type UINT64.
568 This function returns a value of type UINT64 by interpreting the contents
569 of the Unicode string specified by String as a hexadecimal number.
570 The format of the input Unicode string String is
572 [spaces][zeros][x][hexadecimal digits].
574 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
575 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix.
576 If "x" appears in the input string, it must be prefixed with at least one 0.
577 The function will ignore the pad space, which includes spaces or tab characters,
578 before [zeros], [x] or [hexadecimal digit]. The running zero before [x] or
579 [hexadecimal digit] will be ignored. Then, the decoding starts after [x] or the
580 first valid hexadecimal digit. Then, the function stops at the first character that is
581 a not a valid hexadecimal character or NULL, whichever one comes first.
583 If String is NULL, then ASSERT().
584 If String is not aligned in a 16-bit boundary, then ASSERT().
585 If String has only pad spaces, then zero is returned.
586 If String has no leading pad spaces, leading zeros or valid hexadecimal digits,
587 then zero is returned.
588 If the number represented by String overflows according to the range defined by
589 UINT64, then ASSERT().
591 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
592 PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator,
595 @param String Pointer to a Null-terminated Unicode string.
597 @retval Value translated from String.
603 IN CONST CHAR16
*String
607 Convert a nibble in the low 4 bits of a byte to a Unicode hexadecimal character.
609 This function converts a nibble in the low 4 bits of a byte to a Unicode hexadecimal
610 character For example, the nibble 0x01 and 0x0A will converted to L'1' and L'A'
613 The upper nibble in the input byte will be masked off.
615 @param Nibble The nibble which is in the low 4 bits of the input byte.
617 @retval CHAR16 The Unicode hexadecimal character.
627 Convert binary buffer to a Unicode String in a specified sequence.
629 This function converts bytes in the memory block pointed by Buffer to a Unicode String Str.
630 Each byte will be represented by two Unicode characters. For example, byte 0xA1 will
631 be converted into two Unicode character L'A' and L'1'. In the output String, the Unicode Character
632 for the Most Significant Nibble will be put before the Unicode Character for the Least Significant
633 Nibble. The output string for the buffer containing a single byte 0xA1 will be L"A1".
634 For a buffer with multiple bytes, the Unicode character produced by the first byte will be put into the
635 the last character in the output string. The one next to first byte will be put into the
636 character before the last character. This rules applies to the rest of the bytes. The Unicode
637 character by the last byte will be put into the first character in the output string. For example,
638 the input buffer for a 64-bits unsigned integrer 0x12345678abcdef1234 will be converted to
639 a Unicode string equal to L"12345678abcdef1234".
641 @param String On input, String is pointed to the buffer allocated for the convertion.
642 @param StringLen The Length of String buffer to hold the output String. The length must include the tailing '\0' character.
643 The StringLen required to convert a N bytes Buffer will be a least equal to or greater
645 @param Buffer The pointer to a input buffer.
646 @param BufferSizeInBytes Lenth in bytes of the input buffer.
649 @retval EFI_SUCCESS The convertion is successfull. All bytes in Buffer has been convert to the corresponding
650 Unicode character and placed into the right place in String.
651 @retval EFI_BUFFER_TOO_SMALL StringSizeInBytes is smaller than 2 * N + 1the number of bytes required to
652 complete the convertion.
657 IN OUT CHAR16
*String
,
658 IN OUT UINTN
*StringLen
,
659 IN CONST UINT8
*Buffer
,
660 IN UINTN BufferSizeInBytes
665 Convert a Unicode string consisting of hexadecimal characters to a output byte buffer.
667 This function converts a Unicode string consisting of characters in the range of Hexadecimal
668 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
669 at the first non-hexadecimal character or the NULL character. The convertion process can be
670 simply viewed as the reverse operations defined by BufToHexString. Two Unicode characters will be
671 converted into one byte. The first Unicode character represents the Most Significant Nibble and the
672 second Unicode character represents the Least Significant Nibble in the output byte.
673 The first pair of Unicode characters represents the last byte in the output buffer. The second pair of Unicode
674 characters represent the the byte preceding the last byte. This rule applies to the rest pairs of bytes.
675 The last pair represent the first byte in the output buffer.
677 For example, a Unciode String L"12345678" will be converted into a buffer wil the following bytes
678 (first byte is the byte in the lowest memory address): "0x78, 0x56, 0x34, 0x12".
680 If String has N valid hexadecimal characters for conversion, the caller must make sure Buffer is at least
681 N/2 (if N is even) or (N+1)/2 (if N if odd) bytes.
683 @param Buffer The output buffer allocated by the caller.
684 @param BufferSizeInBytes On input, the size in bytes of Buffer. On output, it is updated to
685 contain the size of the Buffer which is actually used for the converstion.
686 For Unicode string with 2*N hexadecimal characters (not including the
687 tailing NULL character), N bytes of Buffer will be used for the output.
688 @param String The input hexadecimal string.
689 @param ConvertedStrLen The number of hexadecimal characters used to produce content in output
692 @retval RETURN_BUFFER_TOO_SMALL The input BufferSizeInBytes is too small to hold the output. BufferSizeInBytes
693 will be updated to the size required for the converstion.
694 @retval RETURN_SUCCESS The convertion is successful or the first Unicode character from String
695 is hexadecimal. If ConvertedStrLen is not NULL, it is updated
696 to the number of hexadecimal character used for the converstion.
702 IN OUT UINTN
*BufferSizeInBytes
,
703 IN CONST CHAR16
*String
,
704 OUT UINTN
*ConvertedStrLen OPTIONAL
709 Test if a Unicode character is a hexadecimal digit. If true, the input
710 Unicode character is converted to a byte.
712 This function tests if a Unicode character is a hexadecimal digit. If true, the input
713 Unicode character is converted to a byte. For example, Unicode character
714 L'A' will be converted to 0x0A.
716 If Digit is NULL, then ASSERT.
718 @param Digit The output hexadecimal digit.
720 @param Char The input Unicode character.
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
736 Convert one Null-terminated Unicode string to a Null-terminated
737 ASCII string and returns the ASCII string.
739 This function converts the content of the Unicode string Source
740 to the ASCII string Destination by copying the lower 8 bits of
741 each Unicode character. It returns Destination.
743 If any Unicode characters in Source contain non-zero value in
744 the upper 8 bits, then ASSERT().
746 If Destination is NULL, then ASSERT().
747 If Source is NULL, then ASSERT().
748 If Source is not aligned on a 16-bit boundary, then ASSERT().
749 If Source and Destination overlap, then ASSERT().
751 If PcdMaximumUnicodeStringLength is not zero, and Source contains
752 more than PcdMaximumUnicodeStringLength Unicode characters not including
753 the Null-terminator, then ASSERT().
755 If PcdMaximumAsciiStringLength is not zero, and Source contains more
756 than PcdMaximumAsciiStringLength Unicode characters not including the
757 Null-terminator, then ASSERT().
759 @param Source Pointer to a Null-terminated Unicode string.
760 @param Destination Pointer to a Null-terminated ASCII string.
767 UnicodeStrToAsciiStr (
768 IN CONST CHAR16
*Source
,
769 OUT CHAR8
*Destination
774 Copies one Null-terminated ASCII string to another Null-terminated ASCII
775 string and returns the new ASCII string.
777 This function copies the contents of the ASCII string Source to the ASCII
778 string Destination, and returns Destination. If Source and Destination
779 overlap, then the results are undefined.
781 If Destination is NULL, then ASSERT().
782 If Source is NULL, then ASSERT().
783 If Source and Destination overlap, then ASSERT().
784 If PcdMaximumAsciiStringLength is not zero and Source contains more than
785 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
788 @param Destination Pointer to a Null-terminated ASCII string.
789 @param Source Pointer to a Null-terminated ASCII string.
797 OUT CHAR8
*Destination
,
798 IN CONST CHAR8
*Source
803 Copies one Null-terminated ASCII string with a maximum length to another
804 Null-terminated ASCII string with a maximum length and returns the new ASCII
807 This function copies the contents of the ASCII string Source to the ASCII
808 string Destination, and returns Destination. At most, Length ASCII characters
809 are copied from Source to Destination. If Length is 0, then Destination is
810 returned unmodified. If Length is greater that the number of ASCII characters
811 in Source, then Destination is padded with Null ASCII characters. If Source
812 and Destination overlap, then the results are undefined.
814 If Destination is NULL, then ASSERT().
815 If Source is NULL, then ASSERT().
816 If Source and Destination overlap, then ASSERT().
817 If PcdMaximumAsciiStringLength is not zero, and Source contains more than
818 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
821 @param Destination Pointer to a Null-terminated ASCII string.
822 @param Source Pointer to a Null-terminated ASCII string.
823 @param Length Maximum number of ASCII characters to copy.
831 OUT CHAR8
*Destination
,
832 IN CONST CHAR8
*Source
,
838 Returns the length of a Null-terminated ASCII string.
840 This function returns the number of ASCII characters in the Null-terminated
841 ASCII string specified by String.
843 If Length > 0 and Destination is NULL, then ASSERT().
844 If Length > 0 and Source is NULL, then ASSERT().
845 If PcdMaximumAsciiStringLength is not zero and String contains more than
846 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
849 @param String Pointer to a Null-terminated ASCII string.
851 @return The length of String.
857 IN CONST CHAR8
*String
862 Returns the size of a Null-terminated ASCII string in bytes, including the
865 This function returns the size, in bytes, of the Null-terminated ASCII string
868 If String is NULL, then ASSERT().
869 If PcdMaximumAsciiStringLength is not zero and String contains more than
870 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
873 @param String Pointer to a Null-terminated ASCII string.
875 @return The size of String.
881 IN CONST CHAR8
*String
886 Compares two Null-terminated ASCII strings, and returns the difference
887 between the first mismatched ASCII characters.
889 This function compares the Null-terminated ASCII string FirstString to the
890 Null-terminated ASCII string SecondString. If FirstString is identical to
891 SecondString, then 0 is returned. Otherwise, the value returned is the first
892 mismatched ASCII character in SecondString subtracted from the first
893 mismatched ASCII character in FirstString.
895 If FirstString is NULL, then ASSERT().
896 If SecondString is NULL, then ASSERT().
897 If PcdMaximumAsciiStringLength is not zero and FirstString contains more than
898 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
900 If PcdMaximumAsciiStringLength is not zero and SecondString contains more
901 than PcdMaximumAsciiStringLength ASCII characters not including the
902 Null-terminator, then ASSERT().
904 @param FirstString Pointer to a Null-terminated ASCII string.
905 @param SecondString Pointer to a Null-terminated ASCII string.
907 @retval 0 FirstString is identical to SecondString.
908 @return others FirstString is not identical to SecondString.
914 IN CONST CHAR8
*FirstString
,
915 IN CONST CHAR8
*SecondString
920 Performs a case insensitive comparison of two Null-terminated ASCII strings,
921 and returns the difference between the first mismatched ASCII characters.
923 This function performs a case insensitive comparison of the Null-terminated
924 ASCII string FirstString to the Null-terminated ASCII string SecondString. If
925 FirstString is identical to SecondString, then 0 is returned. Otherwise, the
926 value returned is the first mismatched lower case ASCII character in
927 SecondString subtracted from the first mismatched lower case ASCII character
930 If FirstString is NULL, then ASSERT().
931 If SecondString is NULL, then ASSERT().
932 If PcdMaximumAsciiStringLength is not zero and FirstString contains more than
933 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
935 If PcdMaximumAsciiStringLength is not zero and SecondString contains more
936 than PcdMaximumAsciiStringLength ASCII characters not including the
937 Null-terminator, then ASSERT().
939 @param FirstString Pointer to a Null-terminated ASCII string.
940 @param SecondString Pointer to a Null-terminated ASCII string.
942 @retval 0 FirstString is identical to SecondString using case insensitive
944 @return others FirstString is not identical to SecondString using case
945 insensitive comparisons.
951 IN CONST CHAR8
*FirstString
,
952 IN CONST CHAR8
*SecondString
957 Compares two Null-terminated ASCII strings with maximum lengths, and returns
958 the difference between the first mismatched ASCII characters.
960 This function compares the Null-terminated ASCII string FirstString to the
961 Null-terminated ASCII string SecondString. At most, Length ASCII characters
962 will be compared. If Length is 0, then 0 is returned. If FirstString is
963 identical to SecondString, then 0 is returned. Otherwise, the value returned
964 is the first mismatched ASCII character in SecondString subtracted from the
965 first mismatched ASCII character in FirstString.
967 If Length > 0 and FirstString is NULL, then ASSERT().
968 If Length > 0 and SecondString is NULL, then ASSERT().
969 If PcdMaximumAsciiStringLength is not zero and FirstString contains more than
970 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
972 If PcdMaximumAsciiStringLength is not zero and SecondString contains more than
973 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
976 @param FirstString Pointer to a Null-terminated ASCII string.
977 @param SecondString Pointer to a Null-terminated ASCII string.
978 @param Length Maximum number of ASCII characters for compare.
980 @retval 0 FirstString is identical to SecondString.
981 @return others FirstString is not identical to SecondString.
987 IN CONST CHAR8
*FirstString
,
988 IN CONST CHAR8
*SecondString
,
994 Concatenates one Null-terminated ASCII string to another Null-terminated
995 ASCII string, and returns the concatenated ASCII string.
997 This function concatenates two Null-terminated ASCII strings. The contents of
998 Null-terminated ASCII string Source are concatenated to the end of Null-
999 terminated ASCII string Destination. The Null-terminated concatenated ASCII
1002 If Destination is NULL, then ASSERT().
1003 If Source is NULL, then ASSERT().
1004 If PcdMaximumAsciiStringLength is not zero and Destination contains more than
1005 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
1007 If PcdMaximumAsciiStringLength is not zero and Source contains more than
1008 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
1010 If PcdMaximumAsciiStringLength is not zero and concatenating Destination and
1011 Source results in a ASCII string with more than PcdMaximumAsciiStringLength
1012 ASCII characters, then ASSERT().
1014 @param Destination Pointer to a Null-terminated ASCII string.
1015 @param Source Pointer to a Null-terminated ASCII string.
1023 IN OUT CHAR8
*Destination
,
1024 IN CONST CHAR8
*Source
1029 Concatenates one Null-terminated ASCII string with a maximum length to the
1030 end of another Null-terminated ASCII string, and returns the concatenated
1033 This function concatenates two Null-terminated ASCII strings. The contents
1034 of Null-terminated ASCII string Source are concatenated to the end of Null-
1035 terminated ASCII string Destination, and Destination is returned. At most,
1036 Length ASCII characters are concatenated from Source to the end of
1037 Destination, and Destination is always Null-terminated. If Length is 0, then
1038 Destination is returned unmodified. If Source and Destination overlap, then
1039 the results are undefined.
1041 If Length > 0 and Destination is NULL, then ASSERT().
1042 If Length > 0 and Source is NULL, then ASSERT().
1043 If Source and Destination overlap, then ASSERT().
1044 If PcdMaximumAsciiStringLength is not zero, and Destination contains more than
1045 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
1047 If PcdMaximumAsciiStringLength is not zero, and Source contains more than
1048 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
1050 If PcdMaximumAsciiStringLength is not zero, and concatenating Destination and
1051 Source results in a ASCII string with more than PcdMaximumAsciiStringLength
1052 ASCII characters not including the Null-terminator, then ASSERT().
1054 @param Destination Pointer to a Null-terminated ASCII string.
1055 @param Source Pointer to a Null-terminated ASCII string.
1056 @param Length Maximum number of ASCII characters to concatenate from
1065 IN OUT CHAR8
*Destination
,
1066 IN CONST CHAR8
*Source
,
1072 Returns the first occurance of a Null-terminated ASCII sub-string
1073 in a Null-terminated ASCII string.
1075 This function scans the contents of the ASCII string specified by String
1076 and returns the first occurrence of SearchString. If SearchString is not
1077 found in String, then NULL is returned. If the length of SearchString is zero,
1078 then String is returned.
1080 If String is NULL, then ASSERT().
1081 If SearchString is NULL, then ASSERT().
1083 If PcdMaximumAsciiStringLength is not zero, and SearchString or
1084 String contains more than PcdMaximumAsciiStringLength Unicode characters
1085 not including the Null-terminator, then ASSERT().
1087 @param String Pointer to a Null-terminated ASCII string.
1088 @param SearchString Pointer to a Null-terminated ASCII string to search for.
1090 @retval NULL If the SearchString does not appear in String.
1091 @return others If there is a match.
1097 IN CONST CHAR8
*String
,
1098 IN CONST CHAR8
*SearchString
1103 Convert a Null-terminated ASCII decimal string to a value of type
1106 This function returns a value of type UINTN by interpreting the contents
1107 of the ASCII string String as a decimal number. The format of the input
1108 ASCII string String is:
1110 [spaces] [decimal digits].
1112 The valid decimal digit character is in the range [0-9]. The function will
1113 ignore the pad space, which includes spaces or tab characters, before the digits.
1114 The running zero in the beginning of [decimal digits] will be ignored. Then, the
1115 function stops at the first character that is a not a valid decimal character or
1116 Null-terminator, whichever on comes first.
1118 If String has only pad spaces, then 0 is returned.
1119 If String has no pad spaces or valid decimal digits, then 0 is returned.
1120 If the number represented by String overflows according to the range defined by
1121 UINTN, then ASSERT().
1122 If String is NULL, then ASSERT().
1123 If PcdMaximumAsciiStringLength is not zero, and String contains more than
1124 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
1127 @param String Pointer to a Null-terminated ASCII string.
1129 @retval Value translated from String.
1134 AsciiStrDecimalToUintn (
1135 IN CONST CHAR8
*String
1140 Convert a Null-terminated ASCII decimal string to a value of type
1143 This function returns a value of type UINT64 by interpreting the contents
1144 of the ASCII string String as a decimal number. The format of the input
1145 ASCII string String is:
1147 [spaces] [decimal digits].
1149 The valid decimal digit character is in the range [0-9]. The function will
1150 ignore the pad space, which includes spaces or tab characters, before the digits.
1151 The running zero in the beginning of [decimal digits] will be ignored. Then, the
1152 function stops at the first character that is a not a valid decimal character or
1153 Null-terminator, whichever on comes first.
1155 If String has only pad spaces, then 0 is returned.
1156 If String has no pad spaces or valid decimal digits, then 0 is returned.
1157 If the number represented by String overflows according to the range defined by
1158 UINT64, then ASSERT().
1159 If String is NULL, then ASSERT().
1160 If PcdMaximumAsciiStringLength is not zero, and String contains more than
1161 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
1164 @param String Pointer to a Null-terminated ASCII string.
1166 @retval Value translated from String.
1171 AsciiStrDecimalToUint64 (
1172 IN CONST CHAR8
*String
1177 Convert a Null-terminated ASCII hexadecimal string to a value of type UINTN.
1179 This function returns a value of type UINTN by interpreting the contents of
1180 the ASCII string String as a hexadecimal number. The format of the input ASCII
1183 [spaces][zeros][x][hexadecimal digits].
1185 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
1186 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix. If "x"
1187 appears in the input string, it must be prefixed with at least one 0. The function
1188 will ignore the pad space, which includes spaces or tab characters, before [zeros],
1189 [x] or [hexadecimal digits]. The running zero before [x] or [hexadecimal digits]
1190 will be ignored. Then, the decoding starts after [x] or the first valid hexadecimal
1191 digit. Then, the function stops at the first character that is a not a valid
1192 hexadecimal character or Null-terminator, whichever on comes first.
1194 If String has only pad spaces, then 0 is returned.
1195 If String has no leading pad spaces, leading zeros or valid hexadecimal digits, then
1198 If the number represented by String overflows according to the range defined by UINTN,
1200 If String is NULL, then ASSERT().
1201 If PcdMaximumAsciiStringLength is not zero,
1202 and String contains more than PcdMaximumAsciiStringLength ASCII characters not including
1203 the Null-terminator, then ASSERT().
1205 @param String Pointer to a Null-terminated ASCII string.
1207 @retval Value translated from String.
1212 AsciiStrHexToUintn (
1213 IN CONST CHAR8
*String
1218 Convert a Null-terminated ASCII hexadecimal string to a value of type UINT64.
1220 This function returns a value of type UINT64 by interpreting the contents of
1221 the ASCII string String as a hexadecimal number. The format of the input ASCII
1224 [spaces][zeros][x][hexadecimal digits].
1226 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
1227 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix. If "x"
1228 appears in the input string, it must be prefixed with at least one 0. The function
1229 will ignore the pad space, which includes spaces or tab characters, before [zeros],
1230 [x] or [hexadecimal digits]. The running zero before [x] or [hexadecimal digits]
1231 will be ignored. Then, the decoding starts after [x] or the first valid hexadecimal
1232 digit. Then, the function stops at the first character that is a not a valid
1233 hexadecimal character or Null-terminator, whichever on comes first.
1235 If String has only pad spaces, then 0 is returned.
1236 If String has no leading pad spaces, leading zeros or valid hexadecimal digits, then
1239 If the number represented by String overflows according to the range defined by UINT64,
1241 If String is NULL, then ASSERT().
1242 If PcdMaximumAsciiStringLength is not zero,
1243 and String contains more than PcdMaximumAsciiStringLength ASCII characters not including
1244 the Null-terminator, then ASSERT().
1246 @param String Pointer to a Null-terminated ASCII string.
1248 @retval Value translated from String.
1253 AsciiStrHexToUint64 (
1254 IN CONST CHAR8
*String
1259 Convert one Null-terminated ASCII string to a Null-terminated
1260 Unicode string and returns the Unicode string.
1262 This function converts the contents of the ASCII string Source to the Unicode
1263 string Destination, and returns Destination. The function terminates the
1264 Unicode string Destination by appending a Null-terminator character at the end.
1265 The caller is responsible to make sure Destination points to a buffer with size
1266 equal or greater than ((AsciiStrLen (Source) + 1) * sizeof (CHAR16)) in bytes.
1268 If Destination is NULL, then ASSERT().
1269 If Destination is not aligned on a 16-bit boundary, then ASSERT().
1270 If Source is NULL, then ASSERT().
1271 If Source and Destination overlap, then ASSERT().
1272 If PcdMaximumAsciiStringLength is not zero, and Source contains more than
1273 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
1275 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
1276 PcdMaximumUnicodeStringLength ASCII characters not including the
1277 Null-terminator, then ASSERT().
1279 @param Source Pointer to a Null-terminated ASCII string.
1280 @param Destination Pointer to a Null-terminated Unicode string.
1287 AsciiStrToUnicodeStr (
1288 IN CONST CHAR8
*Source
,
1289 OUT CHAR16
*Destination
1294 Converts an 8-bit value to an 8-bit BCD value.
1296 Converts the 8-bit value specified by Value to BCD. The BCD value is
1299 If Value >= 100, then ASSERT().
1301 @param Value The 8-bit value to convert to BCD. Range 0..99.
1303 @return The BCD value
1314 Converts an 8-bit BCD value to an 8-bit value.
1316 Converts the 8-bit BCD value specified by Value to an 8-bit value. The 8-bit
1319 If Value >= 0xA0, then ASSERT().
1320 If (Value & 0x0F) >= 0x0A, then ASSERT().
1322 @param Value The 8-bit BCD value to convert to an 8-bit value.
1324 @return The 8-bit value is returned.
1335 // Linked List Functions and Macros
1339 Initializes the head node of a doubly linked list that is declared as a
1340 global variable in a module.
1342 Initializes the forward and backward links of a new linked list. After
1343 initializing a linked list with this macro, the other linked list functions
1344 may be used to add and remove nodes from the linked list. This macro results
1345 in smaller executables by initializing the linked list in the data section,
1346 instead if calling the InitializeListHead() function to perform the
1347 equivalent operation.
1349 @param ListHead The head note of a list to initiailize.
1352 #define INITIALIZE_LIST_HEAD_VARIABLE(ListHead) {&ListHead, &ListHead}
1356 Initializes the head node of a doubly linked list, and returns the pointer to
1357 the head node of the doubly linked list.
1359 Initializes the forward and backward links of a new linked list. After
1360 initializing a linked list with this function, the other linked list
1361 functions may be used to add and remove nodes from the linked list. It is up
1362 to the caller of this function to allocate the memory for ListHead.
1364 If ListHead is NULL, then ASSERT().
1366 @param ListHead A pointer to the head node of a new doubly linked list.
1373 InitializeListHead (
1374 IN OUT LIST_ENTRY
*ListHead
1379 Adds a node to the beginning of a doubly linked list, and returns the pointer
1380 to the head node of the doubly linked list.
1382 Adds the node Entry at the beginning of the doubly linked list denoted by
1383 ListHead, and returns ListHead.
1385 If ListHead is NULL, then ASSERT().
1386 If Entry is NULL, then ASSERT().
1387 If ListHead was not initialized with InitializeListHead(), then ASSERT().
1388 If PcdMaximumLinkedListLenth is not zero, and prior to insertion the number
1389 of nodes in ListHead, including the ListHead node, is greater than or
1390 equal to PcdMaximumLinkedListLength, then ASSERT().
1392 @param ListHead A pointer to the head node of a doubly linked list.
1393 @param Entry A pointer to a node that is to be inserted at the beginning
1394 of a doubly linked list.
1402 IN OUT LIST_ENTRY
*ListHead
,
1403 IN OUT LIST_ENTRY
*Entry
1408 Adds a node to the end of a doubly linked list, and returns the pointer to
1409 the head node of the doubly linked list.
1411 Adds the node Entry to the end of the doubly linked list denoted by ListHead,
1412 and returns ListHead.
1414 If ListHead is NULL, then ASSERT().
1415 If Entry is NULL, then ASSERT().
1416 If ListHead was not initialized with InitializeListHead(), then ASSERT().
1417 If PcdMaximumLinkedListLenth is not zero, and prior to insertion the number
1418 of nodes in ListHead, including the ListHead node, is greater than or
1419 equal to PcdMaximumLinkedListLength, then ASSERT().
1421 @param ListHead A pointer to the head node of a doubly linked list.
1422 @param Entry A pointer to a node that is to be added at the end of the
1431 IN OUT LIST_ENTRY
*ListHead
,
1432 IN OUT LIST_ENTRY
*Entry
1437 Retrieves the first node of a doubly linked list.
1439 Returns the first node of a doubly linked list. List must have been
1440 initialized with InitializeListHead(). If List is empty, then NULL is
1443 If List is NULL, then ASSERT().
1444 If List was not initialized with InitializeListHead(), then ASSERT().
1445 If PcdMaximumLinkedListLenth is not zero, and the number of nodes
1446 in List, including the List node, is greater than or equal to
1447 PcdMaximumLinkedListLength, then ASSERT().
1449 @param List A pointer to the head node of a doubly linked list.
1451 @return The first node of a doubly linked list.
1452 @retval NULL The list is empty.
1458 IN CONST LIST_ENTRY
*List
1463 Retrieves the next node of a doubly linked list.
1465 Returns the node of a doubly linked list that follows Node. List must have
1466 been initialized with InitializeListHead(). If List is empty, then List is
1469 If List is NULL, then ASSERT().
1470 If Node is NULL, then ASSERT().
1471 If List was not initialized with InitializeListHead(), then ASSERT().
1472 If PcdMaximumLinkedListLenth is not zero, and List contains more than
1473 PcdMaximumLinkedListLenth nodes, then ASSERT().
1474 If Node is not a node in List, then ASSERT().
1476 @param List A pointer to the head node of a doubly linked list.
1477 @param Node A pointer to a node in the doubly linked list.
1479 @return Pointer to the next node if one exists. Otherwise a null value which
1480 is actually List is returned.
1486 IN CONST LIST_ENTRY
*List
,
1487 IN CONST LIST_ENTRY
*Node
1492 Checks to see if a doubly linked list is empty or not.
1494 Checks to see if the doubly linked list is empty. If the linked list contains
1495 zero nodes, this function returns TRUE. Otherwise, it returns FALSE.
1497 If ListHead is NULL, then ASSERT().
1498 If ListHead was not initialized with InitializeListHead(), then ASSERT().
1499 If PcdMaximumLinkedListLenth is not zero, and the number of nodes
1500 in List, including the List node, is greater than or equal to
1501 PcdMaximumLinkedListLength, then ASSERT().
1503 @param ListHead A pointer to the head node of a doubly linked list.
1505 @retval TRUE The linked list is empty.
1506 @retval FALSE The linked list is not empty.
1512 IN CONST LIST_ENTRY
*ListHead
1517 Determines if a node in a doubly linked list is the head node of a the same
1518 doubly linked list. This function is typically used to terminate a loop that
1519 traverses all the nodes in a doubly linked list starting with the head node.
1521 Returns TRUE if Node is equal to List. Returns FALSE if Node is one of the
1522 nodes in the doubly linked list specified by List. List must have been
1523 initialized with InitializeListHead().
1525 If List is NULL, then ASSERT().
1526 If Node is NULL, then ASSERT().
1527 If List was not initialized with InitializeListHead(), then ASSERT().
1528 If PcdMaximumLinkedListLenth is not zero, and the number of nodes
1529 in List, including the List node, is greater than or equal to
1530 PcdMaximumLinkedListLength, then ASSERT().
1531 If Node is not a node in List and Node is not equal to List, then ASSERT().
1533 @param List A pointer to the head node of a doubly linked list.
1534 @param Node A pointer to a node in the doubly linked list.
1536 @retval TRUE Node is one of the nodes in the doubly linked list.
1537 @retval FALSE Node is not one of the nodes in the doubly linked list.
1543 IN CONST LIST_ENTRY
*List
,
1544 IN CONST LIST_ENTRY
*Node
1549 Determines if a node the last node in a doubly linked list.
1551 Returns TRUE if Node is the last node in the doubly linked list specified by
1552 List. Otherwise, FALSE is returned. List must have been initialized with
1553 InitializeListHead().
1555 If List is NULL, then ASSERT().
1556 If Node is NULL, then ASSERT().
1557 If List was not initialized with InitializeListHead(), then ASSERT().
1558 If PcdMaximumLinkedListLenth is not zero, and the number of nodes
1559 in List, including the List node, is greater than or equal to
1560 PcdMaximumLinkedListLength, then ASSERT().
1561 If Node is not a node in List, then ASSERT().
1563 @param List A pointer to the head node of a doubly linked list.
1564 @param Node A pointer to a node in the doubly linked list.
1566 @retval TRUE Node is the last node in the linked list.
1567 @retval FALSE Node is not the last node in the linked list.
1573 IN CONST LIST_ENTRY
*List
,
1574 IN CONST LIST_ENTRY
*Node
1579 Swaps the location of two nodes in a doubly linked list, and returns the
1580 first node after the swap.
1582 If FirstEntry is identical to SecondEntry, then SecondEntry is returned.
1583 Otherwise, the location of the FirstEntry node is swapped with the location
1584 of the SecondEntry node in a doubly linked list. SecondEntry must be in the
1585 same double linked list as FirstEntry and that double linked list must have
1586 been initialized with InitializeListHead(). SecondEntry is returned after the
1589 If FirstEntry is NULL, then ASSERT().
1590 If SecondEntry is NULL, then ASSERT().
1591 If SecondEntry and FirstEntry are not in the same linked list, then ASSERT().
1592 If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
1593 linked list containing the FirstEntry and SecondEntry nodes, including
1594 the FirstEntry and SecondEntry nodes, is greater than or equal to
1595 PcdMaximumLinkedListLength, then ASSERT().
1597 @param FirstEntry A pointer to a node in a linked list.
1598 @param SecondEntry A pointer to another node in the same linked list.
1606 IN OUT LIST_ENTRY
*FirstEntry
,
1607 IN OUT LIST_ENTRY
*SecondEntry
1612 Removes a node from a doubly linked list, and returns the node that follows
1615 Removes the node Entry from a doubly linked list. It is up to the caller of
1616 this function to release the memory used by this node if that is required. On
1617 exit, the node following Entry in the doubly linked list is returned. If
1618 Entry is the only node in the linked list, then the head node of the linked
1621 If Entry is NULL, then ASSERT().
1622 If Entry is the head node of an empty list, then ASSERT().
1623 If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
1624 linked list containing Entry, including the Entry node, is greater than
1625 or equal to PcdMaximumLinkedListLength, then ASSERT().
1627 @param Entry A pointer to a node in a linked list
1635 IN CONST LIST_ENTRY
*Entry
1643 Shifts a 64-bit integer left between 0 and 63 bits. The low bits are filled
1644 with zeros. The shifted value is returned.
1646 This function shifts the 64-bit value Operand to the left by Count bits. The
1647 low Count bits are set to zero. The shifted value is returned.
1649 If Count is greater than 63, then ASSERT().
1651 @param Operand The 64-bit operand to shift left.
1652 @param Count The number of bits to shift left.
1654 @return Operand << Count
1666 Shifts a 64-bit integer right between 0 and 63 bits. This high bits are
1667 filled with zeros. The shifted value is returned.
1669 This function shifts the 64-bit value Operand to the right by Count bits. The
1670 high Count bits are set to zero. The shifted value is returned.
1672 If Count is greater than 63, then ASSERT().
1674 @param Operand The 64-bit operand to shift right.
1675 @param Count The number of bits to shift right.
1677 @return Operand >> Count
1689 Shifts a 64-bit integer right between 0 and 63 bits. The high bits are filled
1690 with original integer's bit 63. The shifted value is returned.
1692 This function shifts the 64-bit value Operand to the right by Count bits. The
1693 high Count bits are set to bit 63 of Operand. The shifted value is returned.
1695 If Count is greater than 63, then ASSERT().
1697 @param Operand The 64-bit operand to shift right.
1698 @param Count The number of bits to shift right.
1700 @return Operand >> Count
1712 Rotates a 32-bit integer left between 0 and 31 bits, filling the low bits
1713 with the high bits that were rotated.
1715 This function rotates the 32-bit value Operand to the left by Count bits. The
1716 low Count bits are fill with the high Count bits of Operand. The rotated
1719 If Count is greater than 31, then ASSERT().
1721 @param Operand The 32-bit operand to rotate left.
1722 @param Count The number of bits to rotate left.
1724 @return Operand <<< Count
1736 Rotates a 32-bit integer right between 0 and 31 bits, filling the high bits
1737 with the low bits that were rotated.
1739 This function rotates the 32-bit value Operand to the right by Count bits.
1740 The high Count bits are fill with the low Count bits of Operand. The rotated
1743 If Count is greater than 31, then ASSERT().
1745 @param Operand The 32-bit operand to rotate right.
1746 @param Count The number of bits to rotate right.
1748 @return Operand >>> Count
1760 Rotates a 64-bit integer left between 0 and 63 bits, filling the low bits
1761 with the high bits that were rotated.
1763 This function rotates the 64-bit value Operand to the left by Count bits. The
1764 low Count bits are fill with the high Count bits of Operand. The rotated
1767 If Count is greater than 63, then ASSERT().
1769 @param Operand The 64-bit operand to rotate left.
1770 @param Count The number of bits to rotate left.
1772 @return Operand <<< Count
1784 Rotates a 64-bit integer right between 0 and 63 bits, filling the high bits
1785 with the high low bits that were rotated.
1787 This function rotates the 64-bit value Operand to the right by Count bits.
1788 The high Count bits are fill with the low Count bits of Operand. The rotated
1791 If Count is greater than 63, then ASSERT().
1793 @param Operand The 64-bit operand to rotate right.
1794 @param Count The number of bits to rotate right.
1796 @return Operand >>> Count
1808 Returns the bit position of the lowest bit set in a 32-bit value.
1810 This function computes the bit position of the lowest bit set in the 32-bit
1811 value specified by Operand. If Operand is zero, then -1 is returned.
1812 Otherwise, a value between 0 and 31 is returned.
1814 @param Operand The 32-bit operand to evaluate.
1816 @return Position of the lowest bit set in Operand if found.
1817 @retval -1 Operand is zero.
1828 Returns the bit position of the lowest bit set in a 64-bit value.
1830 This function computes the bit position of the lowest bit set in the 64-bit
1831 value specified by Operand. If Operand is zero, then -1 is returned.
1832 Otherwise, a value between 0 and 63 is returned.
1834 @param Operand The 64-bit operand to evaluate.
1836 @return Position of the lowest bit set in Operand if found.
1837 @retval -1 Operand is zero.
1848 Returns the bit position of the highest bit set in a 32-bit value. Equivalent
1851 This function computes the bit position of the highest bit set in the 32-bit
1852 value specified by Operand. If Operand is zero, then -1 is returned.
1853 Otherwise, a value between 0 and 31 is returned.
1855 @param Operand The 32-bit operand to evaluate.
1857 @return Position of the highest bit set in Operand if found.
1858 @retval -1 Operand is zero.
1869 Returns the bit position of the highest bit set in a 64-bit value. Equivalent
1872 This function computes the bit position of the highest bit set in the 64-bit
1873 value specified by Operand. If Operand is zero, then -1 is returned.
1874 Otherwise, a value between 0 and 63 is returned.
1876 @param Operand The 64-bit operand to evaluate.
1878 @return Position of the highest bit set in Operand if found.
1879 @retval -1 Operand is zero.
1890 Returns the value of the highest bit set in a 32-bit value. Equivalent to
1891 1 << HighBitSet32(x).
1893 This function computes the value of the highest bit set in the 32-bit value
1894 specified by Operand. If Operand is zero, then zero is returned.
1896 @param Operand The 32-bit operand to evaluate.
1898 @return 1 << HighBitSet32(Operand)
1899 @retval 0 Operand is zero.
1910 Returns the value of the highest bit set in a 64-bit value. Equivalent to
1911 1 << HighBitSet64(x).
1913 This function computes the value of the highest bit set in the 64-bit value
1914 specified by Operand. If Operand is zero, then zero is returned.
1916 @param Operand The 64-bit operand to evaluate.
1918 @return 1 << HighBitSet64(Operand)
1919 @retval 0 Operand is zero.
1930 Switches the endianess of a 16-bit integer.
1932 This function swaps the bytes in a 16-bit unsigned value to switch the value
1933 from little endian to big endian or vice versa. The byte swapped value is
1936 @param Value Operand A 16-bit unsigned value.
1938 @return The byte swaped Operand.
1949 Switches the endianess of a 32-bit integer.
1951 This function swaps the bytes in a 32-bit unsigned value to switch the value
1952 from little endian to big endian or vice versa. The byte swapped value is
1955 @param Value Operand A 32-bit unsigned value.
1957 @return The byte swaped Operand.
1968 Switches the endianess of a 64-bit integer.
1970 This function swaps the bytes in a 64-bit unsigned value to switch the value
1971 from little endian to big endian or vice versa. The byte swapped value is
1974 @param Value Operand A 64-bit unsigned value.
1976 @return The byte swaped Operand.
1987 Multiples a 64-bit unsigned integer by a 32-bit unsigned integer and
1988 generates a 64-bit unsigned result.
1990 This function multiples the 64-bit unsigned value Multiplicand by the 32-bit
1991 unsigned value Multiplier and generates a 64-bit unsigned result. This 64-
1992 bit unsigned result is returned.
1994 If the result overflows, then ASSERT().
1996 @param Multiplicand A 64-bit unsigned value.
1997 @param Multiplier A 32-bit unsigned value.
1999 @return Multiplicand * Multiplier
2005 IN UINT64 Multiplicand
,
2006 IN UINT32 Multiplier
2011 Multiples a 64-bit unsigned integer by a 64-bit unsigned integer and
2012 generates a 64-bit unsigned result.
2014 This function multiples the 64-bit unsigned value Multiplicand by the 64-bit
2015 unsigned value Multiplier and generates a 64-bit unsigned result. This 64-
2016 bit unsigned result is returned.
2018 If the result overflows, then ASSERT().
2020 @param Multiplicand A 64-bit unsigned value.
2021 @param Multiplier A 64-bit unsigned value.
2023 @return Multiplicand * Multiplier
2029 IN UINT64 Multiplicand
,
2030 IN UINT64 Multiplier
2035 Multiples a 64-bit signed integer by a 64-bit signed integer and generates a
2036 64-bit signed result.
2038 This function multiples the 64-bit signed value Multiplicand by the 64-bit
2039 signed value Multiplier and generates a 64-bit signed result. This 64-bit
2040 signed result is returned.
2042 If the result overflows, then ASSERT().
2044 @param Multiplicand A 64-bit signed value.
2045 @param Multiplier A 64-bit signed value.
2047 @return Multiplicand * Multiplier
2053 IN INT64 Multiplicand
,
2059 Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates
2060 a 64-bit unsigned result.
2062 This function divides the 64-bit unsigned value Dividend by the 32-bit
2063 unsigned value Divisor and generates a 64-bit unsigned quotient. This
2064 function returns the 64-bit unsigned quotient.
2066 If Divisor is 0, then ASSERT().
2068 @param Dividend A 64-bit unsigned value.
2069 @param Divisor A 32-bit unsigned value.
2071 @return Dividend / Divisor
2083 Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates
2084 a 32-bit unsigned remainder.
2086 This function divides the 64-bit unsigned value Dividend by the 32-bit
2087 unsigned value Divisor and generates a 32-bit remainder. This function
2088 returns the 32-bit unsigned remainder.
2090 If Divisor is 0, then ASSERT().
2092 @param Dividend A 64-bit unsigned value.
2093 @param Divisor A 32-bit unsigned value.
2095 @return Dividend % Divisor
2107 Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates
2108 a 64-bit unsigned result and an optional 32-bit unsigned remainder.
2110 This function divides the 64-bit unsigned value Dividend by the 32-bit
2111 unsigned value Divisor and generates a 64-bit unsigned quotient. If Remainder
2112 is not NULL, then the 32-bit unsigned remainder is returned in Remainder.
2113 This function returns the 64-bit unsigned quotient.
2115 If Divisor is 0, then ASSERT().
2117 @param Dividend A 64-bit unsigned value.
2118 @param Divisor A 32-bit unsigned value.
2119 @param Remainder A pointer to a 32-bit unsigned value. This parameter is
2120 optional and may be NULL.
2122 @return Dividend / Divisor
2127 DivU64x32Remainder (
2130 OUT UINT32
*Remainder OPTIONAL
2135 Divides a 64-bit unsigned integer by a 64-bit unsigned integer and generates
2136 a 64-bit unsigned result and an optional 64-bit unsigned remainder.
2138 This function divides the 64-bit unsigned value Dividend by the 64-bit
2139 unsigned value Divisor and generates a 64-bit unsigned quotient. If Remainder
2140 is not NULL, then the 64-bit unsigned remainder is returned in Remainder.
2141 This function returns the 64-bit unsigned quotient.
2143 If Divisor is 0, then ASSERT().
2145 @param Dividend A 64-bit unsigned value.
2146 @param Divisor A 64-bit unsigned value.
2147 @param Remainder A pointer to a 64-bit unsigned value. This parameter is
2148 optional and may be NULL.
2150 @return Dividend / Divisor
2155 DivU64x64Remainder (
2158 OUT UINT64
*Remainder OPTIONAL
2163 Divides a 64-bit signed integer by a 64-bit signed integer and generates a
2164 64-bit signed result and a optional 64-bit signed remainder.
2166 This function divides the 64-bit signed value Dividend by the 64-bit signed
2167 value Divisor and generates a 64-bit signed quotient. If Remainder is not
2168 NULL, then the 64-bit signed remainder is returned in Remainder. This
2169 function returns the 64-bit signed quotient.
2171 If Divisor is 0, then ASSERT().
2173 @param Dividend A 64-bit signed value.
2174 @param Divisor A 64-bit signed value.
2175 @param Remainder A pointer to a 64-bit signed value. This parameter is
2176 optional and may be NULL.
2178 @return Dividend / Divisor
2183 DivS64x64Remainder (
2186 OUT INT64
*Remainder OPTIONAL
2191 Reads a 16-bit value from memory that may be unaligned.
2193 This function returns the 16-bit value pointed to by Buffer. The function
2194 guarantees that the read operation does not produce an alignment fault.
2196 If the Buffer is NULL, then ASSERT().
2198 @param Buffer Pointer to a 16-bit value that may be unaligned.
2200 @return The 16-bit value read from Buffer.
2206 IN CONST UINT16
*Buffer
2211 Writes a 16-bit value to memory that may be unaligned.
2213 This function writes the 16-bit value specified by Value to Buffer. Value is
2214 returned. The function guarantees that the write operation does not produce
2217 If the Buffer is NULL, then ASSERT().
2219 @param Buffer Pointer to a 16-bit value that may be unaligned.
2220 @param Value 16-bit value to write to Buffer.
2222 @return The 16-bit value to write to Buffer.
2234 Reads a 24-bit value from memory that may be unaligned.
2236 This function returns the 24-bit value pointed to by Buffer. The function
2237 guarantees that the read operation does not produce an alignment fault.
2239 If the Buffer is NULL, then ASSERT().
2241 @param Buffer Pointer to a 24-bit value that may be unaligned.
2243 @return The 24-bit value read from Buffer.
2249 IN CONST UINT32
*Buffer
2254 Writes a 24-bit value to memory that may be unaligned.
2256 This function writes the 24-bit value specified by Value to Buffer. Value is
2257 returned. The function guarantees that the write operation does not produce
2260 If the Buffer is NULL, then ASSERT().
2262 @param Buffer Pointer to a 24-bit value that may be unaligned.
2263 @param Value 24-bit value to write to Buffer.
2265 @return The 24-bit value to write to Buffer.
2277 Reads a 32-bit value from memory that may be unaligned.
2279 This function returns the 32-bit value pointed to by Buffer. The function
2280 guarantees that the read operation does not produce an alignment fault.
2282 If the Buffer is NULL, then ASSERT().
2284 @param Buffer Pointer to a 32-bit value that may be unaligned.
2286 @return The 32-bit value read from Buffer.
2292 IN CONST UINT32
*Buffer
2297 Writes a 32-bit value to memory that may be unaligned.
2299 This function writes the 32-bit value specified by Value to Buffer. Value is
2300 returned. The function guarantees that the write operation does not produce
2303 If the Buffer is NULL, then ASSERT().
2305 @param Buffer Pointer to a 32-bit value that may be unaligned.
2306 @param Value 32-bit value to write to Buffer.
2308 @return The 32-bit value to write to Buffer.
2320 Reads a 64-bit value from memory that may be unaligned.
2322 This function returns the 64-bit value pointed to by Buffer. The function
2323 guarantees that the read operation does not produce an alignment fault.
2325 If the Buffer is NULL, then ASSERT().
2327 @param Buffer Pointer to a 64-bit value that may be unaligned.
2329 @return The 64-bit value read from Buffer.
2335 IN CONST UINT64
*Buffer
2340 Writes a 64-bit value to memory that may be unaligned.
2342 This function writes the 64-bit value specified by Value to Buffer. Value is
2343 returned. The function guarantees that the write operation does not produce
2346 If the Buffer is NULL, then ASSERT().
2348 @param Buffer Pointer to a 64-bit value that may be unaligned.
2349 @param Value 64-bit value to write to Buffer.
2351 @return The 64-bit value to write to Buffer.
2363 // Bit Field Functions
2367 Returns a bit field from an 8-bit value.
2369 Returns the bitfield specified by the StartBit and the EndBit from Operand.
2371 If 8-bit operations are not supported, then ASSERT().
2372 If StartBit is greater than 7, then ASSERT().
2373 If EndBit is greater than 7, then ASSERT().
2374 If EndBit is less than StartBit, then ASSERT().
2376 @param Operand Operand on which to perform the bitfield operation.
2377 @param StartBit The ordinal of the least significant bit in the bit field.
2379 @param EndBit The ordinal of the most significant bit in the bit field.
2382 @return The bit field read.
2395 Writes a bit field to an 8-bit value, and returns the result.
2397 Writes Value to the bit field specified by the StartBit and the EndBit in
2398 Operand. All other bits in Operand are preserved. The new 8-bit value is
2401 If 8-bit operations are not supported, then ASSERT().
2402 If StartBit is greater than 7, then ASSERT().
2403 If EndBit is greater than 7, then ASSERT().
2404 If EndBit is less than StartBit, then ASSERT().
2406 @param Operand Operand on which to perform the bitfield operation.
2407 @param StartBit The ordinal of the least significant bit in the bit field.
2409 @param EndBit The ordinal of the most significant bit in the bit field.
2411 @param Value New value of the bit field.
2413 @return The new 8-bit value.
2427 Reads a bit field from an 8-bit value, performs a bitwise OR, and returns the
2430 Performs a bitwise inclusive OR between the bit field specified by StartBit
2431 and EndBit in Operand and the value specified by OrData. All other bits in
2432 Operand are preserved. The new 8-bit value is returned.
2434 If 8-bit operations are not supported, then ASSERT().
2435 If StartBit is greater than 7, then ASSERT().
2436 If EndBit is greater than 7, then ASSERT().
2437 If EndBit is less than StartBit, then ASSERT().
2439 @param Operand Operand on which to perform the bitfield operation.
2440 @param StartBit The ordinal of the least significant bit in the bit field.
2442 @param EndBit The ordinal of the most significant bit in the bit field.
2444 @param OrData The value to OR with the read value from the value
2446 @return The new 8-bit value.
2460 Reads a bit field from an 8-bit value, performs a bitwise AND, and returns
2463 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2464 in Operand and the value specified by AndData. All other bits in Operand are
2465 preserved. The new 8-bit value is returned.
2467 If 8-bit operations are not supported, then ASSERT().
2468 If StartBit is greater than 7, then ASSERT().
2469 If EndBit is greater than 7, then ASSERT().
2470 If EndBit is less than StartBit, then ASSERT().
2472 @param Operand Operand on which to perform the bitfield operation.
2473 @param StartBit The ordinal of the least significant bit in the bit field.
2475 @param EndBit The ordinal of the most significant bit in the bit field.
2477 @param AndData The value to AND with the read value from the value.
2479 @return The new 8-bit value.
2493 Reads a bit field from an 8-bit value, performs a bitwise AND followed by a
2494 bitwise OR, and returns the result.
2496 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2497 in Operand and the value specified by AndData, followed by a bitwise
2498 inclusive OR with value specified by OrData. All other bits in Operand are
2499 preserved. The new 8-bit value is returned.
2501 If 8-bit operations are not supported, then ASSERT().
2502 If StartBit is greater than 7, then ASSERT().
2503 If EndBit is greater than 7, then ASSERT().
2504 If EndBit is less than StartBit, then ASSERT().
2506 @param Operand Operand on which to perform the bitfield operation.
2507 @param StartBit The ordinal of the least significant bit in the bit field.
2509 @param EndBit The ordinal of the most significant bit in the bit field.
2511 @param AndData The value to AND with the read value from the value.
2512 @param OrData The value to OR with the result of the AND operation.
2514 @return The new 8-bit value.
2519 BitFieldAndThenOr8 (
2529 Returns a bit field from a 16-bit value.
2531 Returns the bitfield specified by the StartBit and the EndBit from Operand.
2533 If 16-bit operations are not supported, then ASSERT().
2534 If StartBit is greater than 15, then ASSERT().
2535 If EndBit is greater than 15, then ASSERT().
2536 If EndBit is less than StartBit, then ASSERT().
2538 @param Operand Operand on which to perform the bitfield operation.
2539 @param StartBit The ordinal of the least significant bit in the bit field.
2541 @param EndBit The ordinal of the most significant bit in the bit field.
2544 @return The bit field read.
2557 Writes a bit field to a 16-bit value, and returns the result.
2559 Writes Value to the bit field specified by the StartBit and the EndBit in
2560 Operand. All other bits in Operand are preserved. The new 16-bit value is
2563 If 16-bit operations are not supported, then ASSERT().
2564 If StartBit is greater than 15, then ASSERT().
2565 If EndBit is greater than 15, then ASSERT().
2566 If EndBit is less than StartBit, then ASSERT().
2568 @param Operand Operand on which to perform the bitfield operation.
2569 @param StartBit The ordinal of the least significant bit in the bit field.
2571 @param EndBit The ordinal of the most significant bit in the bit field.
2573 @param Value New value of the bit field.
2575 @return The new 16-bit value.
2589 Reads a bit field from a 16-bit value, performs a bitwise OR, and returns the
2592 Performs a bitwise inclusive OR between the bit field specified by StartBit
2593 and EndBit in Operand and the value specified by OrData. All other bits in
2594 Operand are preserved. The new 16-bit value is returned.
2596 If 16-bit operations are not supported, then ASSERT().
2597 If StartBit is greater than 15, then ASSERT().
2598 If EndBit is greater than 15, then ASSERT().
2599 If EndBit is less than StartBit, then ASSERT().
2601 @param Operand Operand on which to perform the bitfield operation.
2602 @param StartBit The ordinal of the least significant bit in the bit field.
2604 @param EndBit The ordinal of the most significant bit in the bit field.
2606 @param OrData The value to OR with the read value from the value
2608 @return The new 16-bit value.
2622 Reads a bit field from a 16-bit value, performs a bitwise AND, and returns
2625 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2626 in Operand and the value specified by AndData. All other bits in Operand are
2627 preserved. The new 16-bit value is returned.
2629 If 16-bit operations are not supported, then ASSERT().
2630 If StartBit is greater than 15, then ASSERT().
2631 If EndBit is greater than 15, then ASSERT().
2632 If EndBit is less than StartBit, then ASSERT().
2634 @param Operand Operand on which to perform the bitfield operation.
2635 @param StartBit The ordinal of the least significant bit in the bit field.
2637 @param EndBit The ordinal of the most significant bit in the bit field.
2639 @param AndData The value to AND with the read value from the value
2641 @return The new 16-bit value.
2655 Reads a bit field from a 16-bit value, performs a bitwise AND followed by a
2656 bitwise OR, and returns the result.
2658 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2659 in Operand and the value specified by AndData, followed by a bitwise
2660 inclusive OR with value specified by OrData. All other bits in Operand are
2661 preserved. The new 16-bit value is returned.
2663 If 16-bit operations are not supported, then ASSERT().
2664 If StartBit is greater than 15, then ASSERT().
2665 If EndBit is greater than 15, then ASSERT().
2666 If EndBit is less than StartBit, then ASSERT().
2668 @param Operand Operand on which to perform the bitfield operation.
2669 @param StartBit The ordinal of the least significant bit in the bit field.
2671 @param EndBit The ordinal of the most significant bit in the bit field.
2673 @param AndData The value to AND with the read value from the value.
2674 @param OrData The value to OR with the result of the AND operation.
2676 @return The new 16-bit value.
2681 BitFieldAndThenOr16 (
2691 Returns a bit field from a 32-bit value.
2693 Returns the bitfield specified by the StartBit and the EndBit from Operand.
2695 If 32-bit operations are not supported, then ASSERT().
2696 If StartBit is greater than 31, then ASSERT().
2697 If EndBit is greater than 31, then ASSERT().
2698 If EndBit is less than StartBit, then ASSERT().
2700 @param Operand Operand on which to perform the bitfield operation.
2701 @param StartBit The ordinal of the least significant bit in the bit field.
2703 @param EndBit The ordinal of the most significant bit in the bit field.
2706 @return The bit field read.
2719 Writes a bit field to a 32-bit value, and returns the result.
2721 Writes Value to the bit field specified by the StartBit and the EndBit in
2722 Operand. All other bits in Operand are preserved. The new 32-bit value is
2725 If 32-bit operations are not supported, then ASSERT().
2726 If StartBit is greater than 31, then ASSERT().
2727 If EndBit is greater than 31, then ASSERT().
2728 If EndBit is less than StartBit, then ASSERT().
2730 @param Operand Operand on which to perform the bitfield operation.
2731 @param StartBit The ordinal of the least significant bit in the bit field.
2733 @param EndBit The ordinal of the most significant bit in the bit field.
2735 @param Value New value of the bit field.
2737 @return The new 32-bit value.
2751 Reads a bit field from a 32-bit value, performs a bitwise OR, and returns the
2754 Performs a bitwise inclusive OR between the bit field specified by StartBit
2755 and EndBit in Operand and the value specified by OrData. All other bits in
2756 Operand are preserved. The new 32-bit value is returned.
2758 If 32-bit operations are not supported, then ASSERT().
2759 If StartBit is greater than 31, then ASSERT().
2760 If EndBit is greater than 31, then ASSERT().
2761 If EndBit is less than StartBit, then ASSERT().
2763 @param Operand Operand on which to perform the bitfield operation.
2764 @param StartBit The ordinal of the least significant bit in the bit field.
2766 @param EndBit The ordinal of the most significant bit in the bit field.
2768 @param OrData The value to OR with the read value from the value
2770 @return The new 32-bit value.
2784 Reads a bit field from a 32-bit value, performs a bitwise AND, and returns
2787 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2788 in Operand and the value specified by AndData. All other bits in Operand are
2789 preserved. The new 32-bit value is returned.
2791 If 32-bit operations are not supported, then ASSERT().
2792 If StartBit is greater than 31, then ASSERT().
2793 If EndBit is greater than 31, then ASSERT().
2794 If EndBit is less than StartBit, then ASSERT().
2796 @param Operand Operand on which to perform the bitfield operation.
2797 @param StartBit The ordinal of the least significant bit in the bit field.
2799 @param EndBit The ordinal of the most significant bit in the bit field.
2801 @param AndData The value to AND with the read value from the value
2803 @return The new 32-bit value.
2817 Reads a bit field from a 32-bit value, performs a bitwise AND followed by a
2818 bitwise OR, and returns the result.
2820 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2821 in Operand and the value specified by AndData, followed by a bitwise
2822 inclusive OR with value specified by OrData. All other bits in Operand are
2823 preserved. The new 32-bit value is returned.
2825 If 32-bit operations are not supported, then ASSERT().
2826 If StartBit is greater than 31, then ASSERT().
2827 If EndBit is greater than 31, then ASSERT().
2828 If EndBit is less than StartBit, then ASSERT().
2830 @param Operand Operand on which to perform the bitfield operation.
2831 @param StartBit The ordinal of the least significant bit in the bit field.
2833 @param EndBit The ordinal of the most significant bit in the bit field.
2835 @param AndData The value to AND with the read value from the value.
2836 @param OrData The value to OR with the result of the AND operation.
2838 @return The new 32-bit value.
2843 BitFieldAndThenOr32 (
2853 Returns a bit field from a 64-bit value.
2855 Returns the bitfield specified by the StartBit and the EndBit from Operand.
2857 If 64-bit operations are not supported, then ASSERT().
2858 If StartBit is greater than 63, then ASSERT().
2859 If EndBit is greater than 63, then ASSERT().
2860 If EndBit is less than StartBit, then ASSERT().
2862 @param Operand Operand on which to perform the bitfield operation.
2863 @param StartBit The ordinal of the least significant bit in the bit field.
2865 @param EndBit The ordinal of the most significant bit in the bit field.
2868 @return The bit field read.
2881 Writes a bit field to a 64-bit value, and returns the result.
2883 Writes Value to the bit field specified by the StartBit and the EndBit in
2884 Operand. All other bits in Operand are preserved. The new 64-bit value is
2887 If 64-bit operations are not supported, then ASSERT().
2888 If StartBit is greater than 63, then ASSERT().
2889 If EndBit is greater than 63, then ASSERT().
2890 If EndBit is less than StartBit, then ASSERT().
2892 @param Operand Operand on which to perform the bitfield operation.
2893 @param StartBit The ordinal of the least significant bit in the bit field.
2895 @param EndBit The ordinal of the most significant bit in the bit field.
2897 @param Value New value of the bit field.
2899 @return The new 64-bit value.
2913 Reads a bit field from a 64-bit value, performs a bitwise OR, and returns the
2916 Performs a bitwise inclusive OR between the bit field specified by StartBit
2917 and EndBit in Operand and the value specified by OrData. All other bits in
2918 Operand are preserved. The new 64-bit value is returned.
2920 If 64-bit operations are not supported, then ASSERT().
2921 If StartBit is greater than 63, then ASSERT().
2922 If EndBit is greater than 63, then ASSERT().
2923 If EndBit is less than StartBit, then ASSERT().
2925 @param Operand Operand on which to perform the bitfield operation.
2926 @param StartBit The ordinal of the least significant bit in the bit field.
2928 @param EndBit The ordinal of the most significant bit in the bit field.
2930 @param OrData The value to OR with the read value from the value
2932 @return The new 64-bit value.
2946 Reads a bit field from a 64-bit value, performs a bitwise AND, and returns
2949 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2950 in Operand and the value specified by AndData. All other bits in Operand are
2951 preserved. The new 64-bit value is returned.
2953 If 64-bit operations are not supported, then ASSERT().
2954 If StartBit is greater than 63, then ASSERT().
2955 If EndBit is greater than 63, then ASSERT().
2956 If EndBit is less than StartBit, then ASSERT().
2958 @param Operand Operand on which to perform the bitfield operation.
2959 @param StartBit The ordinal of the least significant bit in the bit field.
2961 @param EndBit The ordinal of the most significant bit in the bit field.
2963 @param AndData The value to AND with the read value from the value
2965 @return The new 64-bit value.
2979 Reads a bit field from a 64-bit value, performs a bitwise AND followed by a
2980 bitwise OR, and returns the result.
2982 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2983 in Operand and the value specified by AndData, followed by a bitwise
2984 inclusive OR with value specified by OrData. All other bits in Operand are
2985 preserved. The new 64-bit value is returned.
2987 If 64-bit operations are not supported, then ASSERT().
2988 If StartBit is greater than 63, then ASSERT().
2989 If EndBit is greater than 63, then ASSERT().
2990 If EndBit is less than StartBit, then ASSERT().
2992 @param Operand Operand on which to perform the bitfield operation.
2993 @param StartBit The ordinal of the least significant bit in the bit field.
2995 @param EndBit The ordinal of the most significant bit in the bit field.
2997 @param AndData The value to AND with the read value from the value.
2998 @param OrData The value to OR with the result of the AND operation.
3000 @return The new 64-bit value.
3005 BitFieldAndThenOr64 (
3015 // Base Library Synchronization Functions
3019 Retrieves the architecture specific spin lock alignment requirements for
3020 optimal spin lock performance.
3022 This function retrieves the spin lock alignment requirements for optimal
3023 performance on a given CPU architecture. The spin lock alignment must be a
3024 power of two and is returned by this function. If there are no alignment
3025 requirements, then 1 must be returned. The spin lock synchronization
3026 functions must function correctly if the spin lock size and alignment values
3027 returned by this function are not used at all. These values are hints to the
3028 consumers of the spin lock synchronization functions to obtain optimal spin
3031 @return The architecture specific spin lock alignment.
3036 GetSpinLockProperties (
3042 Initializes a spin lock to the released state and returns the spin lock.
3044 This function initializes the spin lock specified by SpinLock to the released
3045 state, and returns SpinLock. Optimal performance can be achieved by calling
3046 GetSpinLockProperties() to determine the size and alignment requirements for
3049 If SpinLock is NULL, then ASSERT().
3051 @param SpinLock A pointer to the spin lock to initialize to the released
3054 @return SpinLock in release state.
3059 InitializeSpinLock (
3060 OUT SPIN_LOCK
*SpinLock
3065 Waits until a spin lock can be placed in the acquired state.
3067 This function checks the state of the spin lock specified by SpinLock. If
3068 SpinLock is in the released state, then this function places SpinLock in the
3069 acquired state and returns SpinLock. Otherwise, this function waits
3070 indefinitely for the spin lock to be released, and then places it in the
3071 acquired state and returns SpinLock. All state transitions of SpinLock must
3072 be performed using MP safe mechanisms.
3074 If SpinLock is NULL, then ASSERT().
3075 If SpinLock was not initialized with InitializeSpinLock(), then ASSERT().
3076 If PcdSpinLockTimeout is not zero, and SpinLock is can not be acquired in
3077 PcdSpinLockTimeout microseconds, then ASSERT().
3079 @param SpinLock A pointer to the spin lock to place in the acquired state.
3081 @return SpinLock accquired lock.
3087 IN OUT SPIN_LOCK
*SpinLock
3092 Attempts to place a spin lock in the acquired state.
3094 This function checks the state of the spin lock specified by SpinLock. If
3095 SpinLock is in the released state, then this function places SpinLock in the
3096 acquired state and returns TRUE. Otherwise, FALSE is returned. All state
3097 transitions of SpinLock must be performed using MP safe mechanisms.
3099 If SpinLock is NULL, then ASSERT().
3100 If SpinLock was not initialized with InitializeSpinLock(), then ASSERT().
3102 @param SpinLock A pointer to the spin lock to place in the acquired state.
3104 @retval TRUE SpinLock was placed in the acquired state.
3105 @retval FALSE SpinLock could not be acquired.
3110 AcquireSpinLockOrFail (
3111 IN OUT SPIN_LOCK
*SpinLock
3116 Releases a spin lock.
3118 This function places the spin lock specified by SpinLock in the release state
3119 and returns SpinLock.
3121 If SpinLock is NULL, then ASSERT().
3122 If SpinLock was not initialized with InitializeSpinLock(), then ASSERT().
3124 @param SpinLock A pointer to the spin lock to release.
3126 @return SpinLock released lock.
3132 IN OUT SPIN_LOCK
*SpinLock
3137 Performs an atomic increment of an 32-bit unsigned integer.
3139 Performs an atomic increment of the 32-bit unsigned integer specified by
3140 Value and returns the incremented value. The increment operation must be
3141 performed using MP safe mechanisms. The state of the return value is not
3142 guaranteed to be MP safe.
3144 If Value is NULL, then ASSERT().
3146 @param Value A pointer to the 32-bit value to increment.
3148 @return The incremented value.
3153 InterlockedIncrement (
3159 Performs an atomic decrement of an 32-bit unsigned integer.
3161 Performs an atomic decrement of the 32-bit unsigned integer specified by
3162 Value and returns the decremented value. The decrement operation must be
3163 performed using MP safe mechanisms. The state of the return value is not
3164 guaranteed to be MP safe.
3166 If Value is NULL, then ASSERT().
3168 @param Value A pointer to the 32-bit value to decrement.
3170 @return The decremented value.
3175 InterlockedDecrement (
3181 Performs an atomic compare exchange operation on a 32-bit unsigned integer.
3183 Performs an atomic compare exchange operation on the 32-bit unsigned integer
3184 specified by Value. If Value is equal to CompareValue, then Value is set to
3185 ExchangeValue and CompareValue is returned. If Value is not equal to CompareValue,
3186 then Value is returned. The compare exchange operation must be performed using
3189 If Value is NULL, then ASSERT().
3191 @param Value A pointer to the 32-bit value for the compare exchange
3193 @param CompareValue 32-bit value used in compare operation.
3194 @param ExchangeValue 32-bit value used in exchange operation.
3196 @return The original *Value before exchange.
3201 InterlockedCompareExchange32 (
3202 IN OUT UINT32
*Value
,
3203 IN UINT32 CompareValue
,
3204 IN UINT32 ExchangeValue
3209 Performs an atomic compare exchange operation on a 64-bit unsigned integer.
3211 Performs an atomic compare exchange operation on the 64-bit unsigned integer specified
3212 by Value. If Value is equal to CompareValue, then Value is set to ExchangeValue and
3213 CompareValue is returned. If Value is not equal to CompareValue, then Value is returned.
3214 The compare exchange operation must be performed using MP safe mechanisms.
3216 If Value is NULL, then ASSERT().
3218 @param Value A pointer to the 64-bit value for the compare exchange
3220 @param CompareValue 64-bit value used in compare operation.
3221 @param ExchangeValue 64-bit value used in exchange operation.
3223 @return The original *Value before exchange.
3228 InterlockedCompareExchange64 (
3229 IN OUT UINT64
*Value
,
3230 IN UINT64 CompareValue
,
3231 IN UINT64 ExchangeValue
3236 Performs an atomic compare exchange operation on a pointer value.
3238 Performs an atomic compare exchange operation on the pointer value specified
3239 by Value. If Value is equal to CompareValue, then Value is set to
3240 ExchangeValue and CompareValue is returned. If Value is not equal to
3241 CompareValue, then Value is returned. The compare exchange operation must be
3242 performed using MP safe mechanisms.
3244 If Value is NULL, then ASSERT().
3246 @param Value A pointer to the pointer value for the compare exchange
3248 @param CompareValue Pointer value used in compare operation.
3249 @param ExchangeValue Pointer value used in exchange operation.
3251 @return The original *Value before exchange.
3255 InterlockedCompareExchangePointer (
3256 IN OUT VOID
**Value
,
3257 IN VOID
*CompareValue
,
3258 IN VOID
*ExchangeValue
3263 // Base Library Checksum Functions
3267 Calculate the sum of all elements in a buffer in unit of UINT8.
3268 During calculation, the carry bits are dropped.
3270 This function calculates the sum of all elements in a buffer
3271 in unit of UINT8. The carry bits in result of addition are dropped.
3272 The result is returned as UINT8. If Length is Zero, then Zero is
3275 If Buffer is NULL, then ASSERT().
3276 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3278 @param Buffer Pointer to the buffer to carry out the sum operation.
3279 @param Length The size, in bytes, of Buffer .
3281 @return Sum The sum of Buffer with carry bits dropped during additions.
3287 IN CONST UINT8
*Buffer
,
3293 Returns the two's complement checksum of all elements in a buffer
3296 This function first calculates the sum of the 8-bit values in the
3297 buffer specified by Buffer and Length. The carry bits in the result
3298 of addition are dropped. Then, the two's complement of the sum is
3299 returned. If Length is 0, then 0 is returned.
3301 If Buffer is NULL, then ASSERT().
3302 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
4923 @todo This call should be removed after the PalCall
4924 Instance issue has been fixed.
4926 Performs a PAL call using static calling convention.
4928 An internal function to perform a PAL call using static calling convention.
4930 @param PalEntryPoint The entry point address of PAL. The address in ar.kr5
4931 would be used if this parameter were NULL on input.
4932 @param Arg1 The first argument of a PAL call.
4933 @param Arg2 The second argument of a PAL call.
4934 @param Arg3 The third argument of a PAL call.
4935 @param Arg4 The fourth argument of a PAL call.
4937 @return The values returned in r8, r9, r10 and r11.
4942 IN CONST VOID
*PalEntryPoint
,
4950 #elif defined (MDE_CPU_IA32) || defined (MDE_CPU_X64)
4952 /// IA32 and X64 Specific Functions
4953 /// Byte packed structure for 16-bit Real Mode EFLAGS
4957 UINT32 CF
:1; /// Carry Flag
4958 UINT32 Reserved_0
:1; /// Reserved
4959 UINT32 PF
:1; /// Parity Flag
4960 UINT32 Reserved_1
:1; /// Reserved
4961 UINT32 AF
:1; /// Auxiliary Carry Flag
4962 UINT32 Reserved_2
:1; /// Reserved
4963 UINT32 ZF
:1; /// Zero Flag
4964 UINT32 SF
:1; /// Sign Flag
4965 UINT32 TF
:1; /// Trap Flag
4966 UINT32 IF
:1; /// Interrupt Enable Flag
4967 UINT32 DF
:1; /// Direction Flag
4968 UINT32 OF
:1; /// Overflow Flag
4969 UINT32 IOPL
:2; /// I/O Privilege Level
4970 UINT32 NT
:1; /// Nested Task
4971 UINT32 Reserved_3
:1; /// Reserved
4977 /// Byte packed structure for EFLAGS/RFLAGS
4978 /// 32-bits on IA-32
4979 /// 64-bits on X64. The upper 32-bits on X64 are reserved
4983 UINT32 CF
:1; /// Carry Flag
4984 UINT32 Reserved_0
:1; /// Reserved
4985 UINT32 PF
:1; /// Parity Flag
4986 UINT32 Reserved_1
:1; /// Reserved
4987 UINT32 AF
:1; /// Auxiliary Carry Flag
4988 UINT32 Reserved_2
:1; /// Reserved
4989 UINT32 ZF
:1; /// Zero Flag
4990 UINT32 SF
:1; /// Sign Flag
4991 UINT32 TF
:1; /// Trap Flag
4992 UINT32 IF
:1; /// Interrupt Enable Flag
4993 UINT32 DF
:1; /// Direction Flag
4994 UINT32 OF
:1; /// Overflow Flag
4995 UINT32 IOPL
:2; /// I/O Privilege Level
4996 UINT32 NT
:1; /// Nested Task
4997 UINT32 Reserved_3
:1; /// Reserved
4998 UINT32 RF
:1; /// Resume Flag
4999 UINT32 VM
:1; /// Virtual 8086 Mode
5000 UINT32 AC
:1; /// Alignment Check
5001 UINT32 VIF
:1; /// Virtual Interrupt Flag
5002 UINT32 VIP
:1; /// Virtual Interrupt Pending
5003 UINT32 ID
:1; /// ID Flag
5004 UINT32 Reserved_4
:10; /// Reserved
5010 /// Byte packed structure for Control Register 0 (CR0)
5011 /// 32-bits on IA-32
5012 /// 64-bits on X64. The upper 32-bits on X64 are reserved
5016 UINT32 PE
:1; /// Protection Enable
5017 UINT32 MP
:1; /// Monitor Coprocessor
5018 UINT32 EM
:1; /// Emulation
5019 UINT32 TS
:1; /// Task Switched
5020 UINT32 ET
:1; /// Extension Type
5021 UINT32 NE
:1; /// Numeric Error
5022 UINT32 Reserved_0
:10; /// Reserved
5023 UINT32 WP
:1; /// Write Protect
5024 UINT32 Reserved_1
:1; /// Reserved
5025 UINT32 AM
:1; /// Alignment Mask
5026 UINT32 Reserved_2
:10; /// Reserved
5027 UINT32 NW
:1; /// Mot Write-through
5028 UINT32 CD
:1; /// Cache Disable
5029 UINT32 PG
:1; /// Paging
5035 /// Byte packed structure for Control Register 4 (CR4)
5036 /// 32-bits on IA-32
5037 /// 64-bits on X64. The upper 32-bits on X64 are reserved
5041 UINT32 VME
:1; /// Virtual-8086 Mode Extensions
5042 UINT32 PVI
:1; /// Protected-Mode Virtual Interrupts
5043 UINT32 TSD
:1; /// Time Stamp Disable
5044 UINT32 DE
:1; /// Debugging Extensions
5045 UINT32 PSE
:1; /// Page Size Extensions
5046 UINT32 PAE
:1; /// Physical Address Extension
5047 UINT32 MCE
:1; /// Machine Check Enable
5048 UINT32 PGE
:1; /// Page Global Enable
5049 UINT32 PCE
:1; /// Performance Monitoring Counter
5051 UINT32 OSFXSR
:1; /// Operating System Support for
5052 /// FXSAVE and FXRSTOR instructions
5053 UINT32 OSXMMEXCPT
:1; /// Operating System Support for
5054 /// Unmasked SIMD Floating Point
5056 UINT32 Reserved_0
:2; /// Reserved
5057 UINT32 VMXE
:1; /// VMX Enable
5058 UINT32 Reserved_1
:18; /// Reseved
5064 /// Byte packed structure for an IDTR, GDTR, LDTR descriptor
5065 /// @todo How to make this structure byte-packed in a compiler independent way?
5074 #define IA32_IDT_GATE_TYPE_TASK 0x85
5075 #define IA32_IDT_GATE_TYPE_INTERRUPT_16 0x86
5076 #define IA32_IDT_GATE_TYPE_TRAP_16 0x87
5077 #define IA32_IDT_GATE_TYPE_INTERRUPT_32 0x8E
5078 #define IA32_IDT_GATE_TYPE_TRAP_32 0x8F
5081 /// Byte packed structure for an Interrupt Gate Descriptor
5083 #if defined (MDE_CPU_IA32)
5087 UINT32 OffsetLow
:16; // Offset bits 15..0
5088 UINT32 Selector
:16; // Selector
5089 UINT32 Reserved_0
:8; // Reserved
5090 UINT32 GateType
:8; // Gate Type. See #defines above
5091 UINT32 OffsetHigh
:16; // Offset bits 31..16
5094 } IA32_IDT_GATE_DESCRIPTOR
;
5098 #if defined (MDE_CPU_X64)
5102 UINT32 OffsetLow
:16; // Offset bits 15..0
5103 UINT32 Selector
:16; // Selector
5104 UINT32 Reserved_0
:8; // Reserved
5105 UINT32 GateType
:8; // Gate Type. See #defines above
5106 UINT32 OffsetHigh
:16; // Offset bits 31..16
5107 UINT32 OffsetUpper
:32; // Offset bits 63..32
5108 UINT32 Reserved_1
:32; // Reserved
5112 } IA32_IDT_GATE_DESCRIPTOR
;
5117 /// Byte packed structure for an FP/SSE/SSE2 context
5124 /// Structures for the 16-bit real mode thunks
5177 IA32_EFLAGS32 EFLAGS
;
5187 } IA32_REGISTER_SET
;
5190 /// Byte packed structure for an 16-bit real mode thunks
5193 IA32_REGISTER_SET
*RealModeState
;
5194 VOID
*RealModeBuffer
;
5195 UINT32 RealModeBufferSize
;
5196 UINT32 ThunkAttributes
;
5199 #define THUNK_ATTRIBUTE_BIG_REAL_MODE 0x00000001
5200 #define THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 0x00000002
5201 #define THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL 0x00000004
5204 Retrieves CPUID information.
5206 Executes the CPUID instruction with EAX set to the value specified by Index.
5207 This function always returns Index.
5208 If Eax is not NULL, then the value of EAX after CPUID is returned in Eax.
5209 If Ebx is not NULL, then the value of EBX after CPUID is returned in Ebx.
5210 If Ecx is not NULL, then the value of ECX after CPUID is returned in Ecx.
5211 If Edx is not NULL, then the value of EDX after CPUID is returned in Edx.
5212 This function is only available on IA-32 and X64.
5214 @param Index The 32-bit value to load into EAX prior to invoking the CPUID
5216 @param Eax Pointer to the 32-bit EAX value returned by the CPUID
5217 instruction. This is an optional parameter that may be NULL.
5218 @param Ebx Pointer to the 32-bit EBX value returned by the CPUID
5219 instruction. This is an optional parameter that may be NULL.
5220 @param Ecx Pointer to the 32-bit ECX value returned by the CPUID
5221 instruction. This is an optional parameter that may be NULL.
5222 @param Edx Pointer to the 32-bit EDX value returned by the CPUID
5223 instruction. This is an optional parameter that may be NULL.
5232 OUT UINT32
*Eax
, OPTIONAL
5233 OUT UINT32
*Ebx
, OPTIONAL
5234 OUT UINT32
*Ecx
, OPTIONAL
5235 OUT UINT32
*Edx OPTIONAL
5240 Retrieves CPUID information using an extended leaf identifier.
5242 Executes the CPUID instruction with EAX set to the value specified by Index
5243 and ECX set to the value specified by SubIndex. This function always returns
5244 Index. This function is only available on IA-32 and x64.
5246 If Eax is not NULL, then the value of EAX after CPUID is returned in Eax.
5247 If Ebx is not NULL, then the value of EBX after CPUID is returned in Ebx.
5248 If Ecx is not NULL, then the value of ECX after CPUID is returned in Ecx.
5249 If Edx is not NULL, then the value of EDX after CPUID is returned in Edx.
5251 @param Index The 32-bit value to load into EAX prior to invoking the
5253 @param SubIndex The 32-bit value to load into ECX prior to invoking the
5255 @param Eax Pointer to the 32-bit EAX value returned by the CPUID
5256 instruction. This is an optional parameter that may be
5258 @param Ebx Pointer to the 32-bit EBX value returned by the CPUID
5259 instruction. This is an optional parameter that may be
5261 @param Ecx Pointer to the 32-bit ECX value returned by the CPUID
5262 instruction. This is an optional parameter that may be
5264 @param Edx Pointer to the 32-bit EDX value returned by the CPUID
5265 instruction. This is an optional parameter that may be
5276 OUT UINT32
*Eax
, OPTIONAL
5277 OUT UINT32
*Ebx
, OPTIONAL
5278 OUT UINT32
*Ecx
, OPTIONAL
5279 OUT UINT32
*Edx OPTIONAL
5284 Returns the lower 32-bits of a Machine Specific Register(MSR).
5286 Reads and returns the lower 32-bits of the MSR specified by Index.
5287 No parameter checking is performed on Index, and some Index values may cause
5288 CPU exceptions. The caller must either guarantee that Index is valid, or the
5289 caller must set up exception handlers to catch the exceptions. This function
5290 is only available on IA-32 and X64.
5292 @param Index The 32-bit MSR index to read.
5294 @return The lower 32 bits of the MSR identified by Index.
5305 Zero-extend a 32-bit value and writes it to a Machine Specific Register(MSR).
5307 Writes the 32-bit value specified by Value to the MSR specified by Index. The
5308 upper 32-bits of the MSR write are set to zero. The 32-bit value written to
5309 the MSR is returned. No parameter checking is performed on Index or Value,
5310 and some of these may cause CPU exceptions. The caller must either guarantee
5311 that Index and Value are valid, or the caller must establish proper exception
5312 handlers. This function is only available on IA-32 and X64.
5314 @param Index The 32-bit MSR index to write.
5315 @param Value The 32-bit value to write to the MSR.
5329 Reads a 64-bit MSR, performs a bitwise inclusive OR on the lower 32-bits, and
5330 writes the result back to the 64-bit MSR.
5332 Reads the 64-bit MSR specified by Index, performs a bitwise inclusive OR
5333 between the lower 32-bits of the read result and the value specified by
5334 OrData, and writes the result to the 64-bit MSR specified by Index. The lower
5335 32-bits of the value written to the MSR is returned. No parameter checking is
5336 performed on Index or OrData, and some of these may cause CPU exceptions. The
5337 caller must either guarantee that Index and OrData are valid, or the caller
5338 must establish proper exception handlers. This function is only available on
5341 @param Index The 32-bit MSR index to write.
5342 @param OrData The value to OR with the read value from the MSR.
5344 @return The lower 32-bit value written to the MSR.
5356 Reads a 64-bit MSR, performs a bitwise AND on the lower 32-bits, and writes
5357 the result back to the 64-bit MSR.
5359 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
5360 lower 32-bits of the read result and the value specified by AndData, and
5361 writes the result to the 64-bit MSR specified by Index. The lower 32-bits of
5362 the value written to the MSR is returned. No parameter checking is performed
5363 on Index or AndData, and some of these may cause CPU exceptions. The caller
5364 must either guarantee that Index and AndData are valid, or the caller must
5365 establish proper exception handlers. This function is only available on IA-32
5368 @param Index The 32-bit MSR index to write.
5369 @param AndData The value to AND with the read value from the MSR.
5371 @return The lower 32-bit value written to the MSR.
5383 Reads a 64-bit MSR, performs a bitwise AND followed by a bitwise inclusive OR
5384 on the lower 32-bits, and writes the result back to the 64-bit MSR.
5386 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
5387 lower 32-bits of the read result and the value specified by AndData
5388 preserving the upper 32-bits, performs a bitwise inclusive OR between the
5389 result of the AND operation and the value specified by OrData, and writes the
5390 result to the 64-bit MSR specified by Address. The lower 32-bits of the value
5391 written to the MSR is returned. No parameter checking is performed on Index,
5392 AndData, or OrData, and some of these may cause CPU exceptions. The caller
5393 must either guarantee that Index, AndData, and OrData are valid, or the
5394 caller must establish proper exception handlers. This function is only
5395 available on IA-32 and X64.
5397 @param Index The 32-bit MSR index to write.
5398 @param AndData The value to AND with the read value from the MSR.
5399 @param OrData The value to OR with the result of the AND operation.
5401 @return The lower 32-bit value written to the MSR.
5414 Reads a bit field of an MSR.
5416 Reads the bit field in the lower 32-bits of a 64-bit MSR. The bit field is
5417 specified by the StartBit and the EndBit. The value of the bit field is
5418 returned. The caller must either guarantee that Index is valid, or the caller
5419 must set up exception handlers to catch the exceptions. This function is only
5420 available on IA-32 and X64.
5422 If StartBit is greater than 31, then ASSERT().
5423 If EndBit is greater than 31, then ASSERT().
5424 If EndBit is less than StartBit, then ASSERT().
5426 @param Index The 32-bit MSR index to read.
5427 @param StartBit The ordinal of the least significant bit in the bit field.
5429 @param EndBit The ordinal of the most significant bit in the bit field.
5432 @return The bit field read from the MSR.
5437 AsmMsrBitFieldRead32 (
5445 Writes a bit field to an MSR.
5447 Writes Value to a bit field in the lower 32-bits of a 64-bit MSR. The bit
5448 field is specified by the StartBit and the EndBit. All other bits in the
5449 destination MSR are preserved. The lower 32-bits of the MSR written is
5450 returned. Extra left bits in Value are stripped. The caller must either
5451 guarantee that Index and the data written is valid, or the caller must set up
5452 exception handlers to catch the exceptions. This function is only available
5455 If StartBit is greater than 31, then ASSERT().
5456 If EndBit is greater than 31, then ASSERT().
5457 If EndBit is less than StartBit, then ASSERT().
5459 @param Index The 32-bit MSR index to write.
5460 @param StartBit The ordinal of the least significant bit in the bit field.
5462 @param EndBit The ordinal of the most significant bit in the bit field.
5464 @param Value New value of the bit field.
5466 @return The lower 32-bit of the value written to the MSR.
5471 AsmMsrBitFieldWrite32 (
5480 Reads a bit field in a 64-bit MSR, performs a bitwise OR, and writes the
5481 result back to the bit field in the 64-bit MSR.
5483 Reads the 64-bit MSR specified by Index, performs a bitwise inclusive OR
5484 between the read result and the value specified by OrData, and writes the
5485 result to the 64-bit MSR specified by Index. The lower 32-bits of the value
5486 written to the MSR are returned. Extra left bits in OrData are stripped. The
5487 caller must either guarantee that Index and the data written is valid, or
5488 the caller must set up exception handlers to catch the exceptions. This
5489 function is only available on IA-32 and X64.
5491 If StartBit is greater than 31, then ASSERT().
5492 If EndBit is greater than 31, then ASSERT().
5493 If EndBit is less than StartBit, then ASSERT().
5495 @param Index The 32-bit MSR index to write.
5496 @param StartBit The ordinal of the least significant bit in the bit field.
5498 @param EndBit The ordinal of the most significant bit in the bit field.
5500 @param OrData The value to OR with the read value from the MSR.
5502 @return The lower 32-bit of the value written to the MSR.
5507 AsmMsrBitFieldOr32 (
5516 Reads a bit field in a 64-bit MSR, performs a bitwise AND, and writes the
5517 result back to the bit field in the 64-bit MSR.
5519 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
5520 read result and the value specified by AndData, and writes the result to the
5521 64-bit MSR specified by Index. The lower 32-bits of the value written to the
5522 MSR are returned. Extra left bits in AndData are stripped. The caller must
5523 either guarantee that Index and the data written is valid, or the caller must
5524 set up exception handlers to catch the exceptions. This function is only
5525 available on IA-32 and X64.
5527 If StartBit is greater than 31, then ASSERT().
5528 If EndBit is greater than 31, then ASSERT().
5529 If EndBit is less than StartBit, then ASSERT().
5531 @param Index The 32-bit MSR index to write.
5532 @param StartBit The ordinal of the least significant bit in the bit field.
5534 @param EndBit The ordinal of the most significant bit in the bit field.
5536 @param AndData The value to AND with the read value from the MSR.
5538 @return The lower 32-bit of the value written to the MSR.
5543 AsmMsrBitFieldAnd32 (
5552 Reads a bit field in a 64-bit MSR, performs a bitwise AND followed by a
5553 bitwise inclusive OR, and writes the result back to the bit field in the
5556 Reads the 64-bit MSR specified by Index, performs a bitwise AND followed by a
5557 bitwise inclusive OR between the read result and the value specified by
5558 AndData, and writes the result to the 64-bit MSR specified by Index. The
5559 lower 32-bits of the value written to the MSR are returned. Extra left bits
5560 in both AndData and OrData are stripped. The caller must either guarantee
5561 that Index and the data written is valid, or the caller must set up exception
5562 handlers to catch the exceptions. This function is only available on IA-32
5565 If StartBit is greater than 31, then ASSERT().
5566 If EndBit is greater than 31, then ASSERT().
5567 If EndBit is less than StartBit, then ASSERT().
5569 @param Index The 32-bit MSR index to write.
5570 @param StartBit The ordinal of the least significant bit in the bit field.
5572 @param EndBit The ordinal of the most significant bit in the bit field.
5574 @param AndData The value to AND with the read value from the MSR.
5575 @param OrData The value to OR with the result of the AND operation.
5577 @return The lower 32-bit of the value written to the MSR.
5582 AsmMsrBitFieldAndThenOr32 (
5592 Returns a 64-bit Machine Specific Register(MSR).
5594 Reads and returns the 64-bit MSR specified by Index. No parameter checking is
5595 performed on Index, and some Index values may cause CPU exceptions. The
5596 caller must either guarantee that Index is valid, or the caller must set up
5597 exception handlers to catch the exceptions. This function is only available
5600 @param Index The 32-bit MSR index to read.
5602 @return The value of the MSR identified by Index.
5613 Writes a 64-bit value to a Machine Specific Register(MSR), and returns the
5616 Writes the 64-bit value specified by Value to the MSR specified by Index. The
5617 64-bit value written to the MSR is returned. No parameter checking is
5618 performed on Index or Value, and some of these may cause CPU exceptions. The
5619 caller must either guarantee that Index and Value are valid, or the caller
5620 must establish proper exception handlers. This function is only available on
5623 @param Index The 32-bit MSR index to write.
5624 @param Value The 64-bit value to write to the MSR.
5638 Reads a 64-bit MSR, performs a bitwise inclusive OR, and writes the result
5639 back to the 64-bit MSR.
5641 Reads the 64-bit MSR specified by Index, performs a bitwise inclusive OR
5642 between the read result and the value specified by OrData, and writes the
5643 result to the 64-bit MSR specified by Index. The value written to the MSR is
5644 returned. No parameter checking is performed on Index or OrData, and some of
5645 these may cause CPU exceptions. The caller must either guarantee that Index
5646 and OrData are valid, or the caller must establish proper exception handlers.
5647 This function is only available on IA-32 and X64.
5649 @param Index The 32-bit MSR index to write.
5650 @param OrData The value to OR with the read value from the MSR.
5652 @return The value written back to the MSR.
5664 Reads a 64-bit MSR, performs a bitwise AND, and writes the result back to the
5667 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
5668 read result and the value specified by OrData, and writes the result to the
5669 64-bit MSR specified by Index. The value written to the MSR is returned. No
5670 parameter checking is performed on Index or OrData, and some of these may
5671 cause CPU exceptions. The caller must either guarantee that Index and OrData
5672 are valid, or the caller must establish proper exception handlers. This
5673 function is only available on IA-32 and X64.
5675 @param Index The 32-bit MSR index to write.
5676 @param AndData The value to AND with the read value from the MSR.
5678 @return The value written back to the MSR.
5690 Reads a 64-bit MSR, performs a bitwise AND followed by a bitwise inclusive
5691 OR, and writes the result back to the 64-bit MSR.
5693 Reads the 64-bit MSR specified by Index, performs a bitwise AND between read
5694 result and the value specified by AndData, performs a bitwise inclusive OR
5695 between the result of the AND operation and the value specified by OrData,
5696 and writes the result to the 64-bit MSR specified by Index. The value written
5697 to the MSR is returned. No parameter checking is performed on Index, AndData,
5698 or OrData, and some of these may cause CPU exceptions. The caller must either
5699 guarantee that Index, AndData, and OrData are valid, or the caller must
5700 establish proper exception handlers. This function is only available on IA-32
5703 @param Index The 32-bit MSR index to write.
5704 @param AndData The value to AND with the read value from the MSR.
5705 @param OrData The value to OR with the result of the AND operation.
5707 @return The value written back to the MSR.
5720 Reads a bit field of an MSR.
5722 Reads the bit field in the 64-bit MSR. The bit field is specified by the
5723 StartBit and the EndBit. The value of the bit field is returned. The caller
5724 must either guarantee that Index is valid, or the caller must set up
5725 exception handlers to catch the exceptions. This function is only available
5728 If StartBit is greater than 63, then ASSERT().
5729 If EndBit is greater than 63, then ASSERT().
5730 If EndBit is less than StartBit, then ASSERT().
5732 @param Index The 32-bit MSR index to read.
5733 @param StartBit The ordinal of the least significant bit in the bit field.
5735 @param EndBit The ordinal of the most significant bit in the bit field.
5738 @return The value read from the MSR.
5743 AsmMsrBitFieldRead64 (
5751 Writes a bit field to an MSR.
5753 Writes Value to a bit field in a 64-bit MSR. The bit field is specified by
5754 the StartBit and the EndBit. All other bits in the destination MSR are
5755 preserved. The MSR written is returned. Extra left bits in Value are
5756 stripped. The caller must either guarantee that Index and the data written is
5757 valid, or the caller must set up exception handlers to catch the exceptions.
5758 This function is only available on IA-32 and X64.
5760 If StartBit is greater than 63, then ASSERT().
5761 If EndBit is greater than 63, then ASSERT().
5762 If EndBit is less than StartBit, then ASSERT().
5764 @param Index The 32-bit MSR index to write.
5765 @param StartBit The ordinal of the least significant bit in the bit field.
5767 @param EndBit The ordinal of the most significant bit in the bit field.
5769 @param Value New value of the bit field.
5771 @return The value written back to the MSR.
5776 AsmMsrBitFieldWrite64 (
5785 Reads a bit field in a 64-bit MSR, performs a bitwise inclusive OR, and
5786 writes the result back to the bit field in the 64-bit MSR.
5788 Reads the 64-bit MSR specified by Index, performs a bitwise inclusive OR
5789 between the read result and the value specified by OrData, and writes the
5790 result to the 64-bit MSR specified by Index. The value written to the MSR is
5791 returned. Extra left bits in OrData are stripped. The caller must either
5792 guarantee that Index and the data written is valid, or the caller must set up
5793 exception handlers to catch the exceptions. This function is only available
5796 If StartBit is greater than 63, then ASSERT().
5797 If EndBit is greater than 63, then ASSERT().
5798 If EndBit is less than StartBit, then ASSERT().
5800 @param Index The 32-bit MSR index to write.
5801 @param StartBit The ordinal of the least significant bit in the bit field.
5803 @param EndBit The ordinal of the most significant bit in the bit field.
5805 @param OrData The value to OR with the read value from the bit field.
5807 @return The value written back to the MSR.
5812 AsmMsrBitFieldOr64 (
5821 Reads a bit field in a 64-bit MSR, performs a bitwise AND, and writes the
5822 result back to the bit field in the 64-bit MSR.
5824 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
5825 read result and the value specified by AndData, and writes the result to the
5826 64-bit MSR specified by Index. The value written to the MSR is returned.
5827 Extra left bits in AndData are stripped. The caller must either guarantee
5828 that Index and the data written is valid, or the caller must set up exception
5829 handlers to catch the exceptions. This function is only available on IA-32
5832 If StartBit is greater than 63, then ASSERT().
5833 If EndBit is greater than 63, then ASSERT().
5834 If EndBit is less than StartBit, then ASSERT().
5836 @param Index The 32-bit MSR index to write.
5837 @param StartBit The ordinal of the least significant bit in the bit field.
5839 @param EndBit The ordinal of the most significant bit in the bit field.
5841 @param AndData The value to AND with the read value from the bit field.
5843 @return The value written back to the MSR.
5848 AsmMsrBitFieldAnd64 (
5857 Reads a bit field in a 64-bit MSR, performs a bitwise AND followed by a
5858 bitwise inclusive OR, and writes the result back to the bit field in the
5861 Reads the 64-bit MSR specified by Index, performs a bitwise AND followed by
5862 a bitwise inclusive OR between the read result and the value specified by
5863 AndData, and writes the result to the 64-bit MSR specified by Index. The
5864 value written to the MSR is returned. Extra left bits in both AndData and
5865 OrData are stripped. The caller must either guarantee that Index and the data
5866 written is valid, or the caller must set up exception handlers to catch the
5867 exceptions. This function is only available on IA-32 and X64.
5869 If StartBit is greater than 63, then ASSERT().
5870 If EndBit is greater than 63, then ASSERT().
5871 If EndBit is less than StartBit, then ASSERT().
5873 @param Index The 32-bit MSR index to write.
5874 @param StartBit The ordinal of the least significant bit in the bit field.
5876 @param EndBit The ordinal of the most significant bit in the bit field.
5878 @param AndData The value to AND with the read value from the bit field.
5879 @param OrData The value to OR with the result of the AND operation.
5881 @return The value written back to the MSR.
5886 AsmMsrBitFieldAndThenOr64 (
5896 Reads the current value of the EFLAGS register.
5898 Reads and returns the current value of the EFLAGS register. This function is
5899 only available on IA-32 and X64. This returns a 32-bit value on IA-32 and a
5900 64-bit value on X64.
5902 @return EFLAGS on IA-32 or RFLAGS on X64.
5913 Reads the current value of the Control Register 0 (CR0).
5915 Reads and returns the current value of CR0. This function is only available
5916 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
5919 @return The value of the Control Register 0 (CR0).
5930 Reads the current value of the Control Register 2 (CR2).
5932 Reads and returns the current value of CR2. This function is only available
5933 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
5936 @return The value of the Control Register 2 (CR2).
5947 Reads the current value of the Control Register 3 (CR3).
5949 Reads and returns the current value of CR3. This function is only available
5950 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
5953 @return The value of the Control Register 3 (CR3).
5964 Reads the current value of the Control Register 4 (CR4).
5966 Reads and returns the current value of CR4. This function is only available
5967 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
5970 @return The value of the Control Register 4 (CR4).
5981 Writes a value to Control Register 0 (CR0).
5983 Writes and returns a new value to CR0. 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 Cr0 The value to write to CR0.
5988 @return The value written to CR0.
5999 Writes a value to Control Register 2 (CR2).
6001 Writes and returns a new value to CR2. 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 Cr2 The value to write to CR2.
6006 @return The value written to CR2.
6017 Writes a value to Control Register 3 (CR3).
6019 Writes and returns a new value to CR3. 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 Cr3 The value to write to CR3.
6024 @return The value written to CR3.
6035 Writes a value to Control Register 4 (CR4).
6037 Writes and returns a new value to CR4. This function is only available on
6038 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6040 @param Cr4 The value to write to CR4.
6042 @return The value written to CR4.
6053 Reads the current value of Debug Register 0 (DR0).
6055 Reads and returns the current value of DR0. This function is only available
6056 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
6059 @return The value of Debug Register 0 (DR0).
6070 Reads the current value of Debug Register 1 (DR1).
6072 Reads and returns the current value of DR1. This function is only available
6073 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
6076 @return The value of Debug Register 1 (DR1).
6087 Reads the current value of Debug Register 2 (DR2).
6089 Reads and returns the current value of DR2. This function is only available
6090 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
6093 @return The value of Debug Register 2 (DR2).
6104 Reads the current value of Debug Register 3 (DR3).
6106 Reads and returns the current value of DR3. This function is only available
6107 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
6110 @return The value of Debug Register 3 (DR3).
6121 Reads the current value of Debug Register 4 (DR4).
6123 Reads and returns the current value of DR4. This function is only available
6124 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
6127 @return The value of Debug Register 4 (DR4).
6138 Reads the current value of Debug Register 5 (DR5).
6140 Reads and returns the current value of DR5. This function is only available
6141 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
6144 @return The value of Debug Register 5 (DR5).
6155 Reads the current value of Debug Register 6 (DR6).
6157 Reads and returns the current value of DR6. This function is only available
6158 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
6161 @return The value of Debug Register 6 (DR6).
6172 Reads the current value of Debug Register 7 (DR7).
6174 Reads and returns the current value of DR7. This function is only available
6175 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
6178 @return The value of Debug Register 7 (DR7).
6189 Writes a value to Debug Register 0 (DR0).
6191 Writes and returns a new value to DR0. 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 Dr0 The value to write to Dr0.
6196 @return The value written to Debug Register 0 (DR0).
6207 Writes a value to Debug Register 1 (DR1).
6209 Writes and returns a new value to DR1. 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 Dr1 The value to write to Dr1.
6214 @return The value written to Debug Register 1 (DR1).
6225 Writes a value to Debug Register 2 (DR2).
6227 Writes and returns a new value to DR2. 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 Dr2 The value to write to Dr2.
6232 @return The value written to Debug Register 2 (DR2).
6243 Writes a value to Debug Register 3 (DR3).
6245 Writes and returns a new value to DR3. 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 Dr3 The value to write to Dr3.
6250 @return The value written to Debug Register 3 (DR3).
6261 Writes a value to Debug Register 4 (DR4).
6263 Writes and returns a new value to DR4. 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 Dr4 The value to write to Dr4.
6268 @return The value written to Debug Register 4 (DR4).
6279 Writes a value to Debug Register 5 (DR5).
6281 Writes and returns a new value to DR5. 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 Dr5 The value to write to Dr5.
6286 @return The value written to Debug Register 5 (DR5).
6297 Writes a value to Debug Register 6 (DR6).
6299 Writes and returns a new value to DR6. 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 Dr6 The value to write to Dr6.
6304 @return The value written to Debug Register 6 (DR6).
6315 Writes a value to Debug Register 7 (DR7).
6317 Writes and returns a new value to DR7. This function is only available on
6318 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6320 @param Dr7 The value to write to Dr7.
6322 @return The value written to Debug Register 7 (DR7).
6333 Reads the current value of Code Segment Register (CS).
6335 Reads and returns the current value of CS. This function is only available on
6338 @return The current value of CS.
6349 Reads the current value of Data Segment Register (DS).
6351 Reads and returns the current value of DS. This function is only available on
6354 @return The current value of DS.
6365 Reads the current value of Extra Segment Register (ES).
6367 Reads and returns the current value of ES. This function is only available on
6370 @return The current value of ES.
6381 Reads the current value of FS Data Segment Register (FS).
6383 Reads and returns the current value of FS. This function is only available on
6386 @return The current value of FS.
6397 Reads the current value of GS Data Segment Register (GS).
6399 Reads and returns the current value of GS. This function is only available on
6402 @return The current value of GS.
6413 Reads the current value of Stack Segment Register (SS).
6415 Reads and returns the current value of SS. This function is only available on
6418 @return The current value of SS.
6429 Reads the current value of Task Register (TR).
6431 Reads and returns the current value of TR. This function is only available on
6434 @return The current value of TR.
6445 Reads the current Global Descriptor Table Register(GDTR) descriptor.
6447 Reads and returns the current GDTR descriptor and returns it in Gdtr. This
6448 function is only available on IA-32 and X64.
6450 If Gdtr is NULL, then ASSERT().
6452 @param Gdtr Pointer to a GDTR descriptor.
6458 OUT IA32_DESCRIPTOR
*Gdtr
6463 Writes the current Global Descriptor Table Register (GDTR) descriptor.
6465 Writes and the current GDTR descriptor specified by Gdtr. This function is
6466 only available on IA-32 and X64.
6468 If Gdtr is NULL, then ASSERT().
6470 @param Gdtr Pointer to a GDTR descriptor.
6476 IN CONST IA32_DESCRIPTOR
*Gdtr
6481 Reads the current Interrupt Descriptor Table Register(GDTR) descriptor.
6483 Reads and returns the current IDTR descriptor and returns it in Idtr. This
6484 function is only available on IA-32 and X64.
6486 If Idtr is NULL, then ASSERT().
6488 @param Idtr Pointer to a IDTR descriptor.
6494 OUT IA32_DESCRIPTOR
*Idtr
6499 Writes the current Interrupt Descriptor Table Register(GDTR) descriptor.
6501 Writes the current IDTR descriptor and returns it in Idtr. This function is
6502 only available on IA-32 and X64.
6504 If Idtr is NULL, then ASSERT().
6506 @param Idtr Pointer to a IDTR descriptor.
6512 IN CONST IA32_DESCRIPTOR
*Idtr
6517 Reads the current Local Descriptor Table Register(LDTR) selector.
6519 Reads and returns the current 16-bit LDTR descriptor value. This function is
6520 only available on IA-32 and X64.
6522 @return The current selector of LDT.
6533 Writes the current Local Descriptor Table Register (GDTR) selector.
6535 Writes and the current LDTR descriptor specified by Ldtr. This function is
6536 only available on IA-32 and X64.
6538 @param Ldtr 16-bit LDTR selector value.
6549 Save the current floating point/SSE/SSE2 context to a buffer.
6551 Saves the current floating point/SSE/SSE2 state to the buffer specified by
6552 Buffer. Buffer must be aligned on a 16-byte boundary. This function is only
6553 available on IA-32 and X64.
6555 If Buffer is NULL, then ASSERT().
6556 If Buffer is not aligned on a 16-byte boundary, then ASSERT().
6558 @param Buffer Pointer to a buffer to save the floating point/SSE/SSE2 context.
6564 OUT IA32_FX_BUFFER
*Buffer
6569 Restores the current floating point/SSE/SSE2 context from a buffer.
6571 Restores the current floating point/SSE/SSE2 state from the buffer specified
6572 by Buffer. Buffer must be aligned on a 16-byte boundary. This function is
6573 only available on IA-32 and X64.
6575 If Buffer is NULL, then ASSERT().
6576 If Buffer is not aligned on a 16-byte boundary, then ASSERT().
6577 If Buffer was not saved with AsmFxSave(), then ASSERT().
6579 @param Buffer Pointer to a buffer to save the floating point/SSE/SSE2 context.
6585 IN CONST IA32_FX_BUFFER
*Buffer
6590 Reads the current value of 64-bit MMX Register #0 (MM0).
6592 Reads and returns the current value of MM0. This function is only available
6595 @return The current value of MM0.
6606 Reads the current value of 64-bit MMX Register #1 (MM1).
6608 Reads and returns the current value of MM1. This function is only available
6611 @return The current value of MM1.
6622 Reads the current value of 64-bit MMX Register #2 (MM2).
6624 Reads and returns the current value of MM2. This function is only available
6627 @return The current value of MM2.
6638 Reads the current value of 64-bit MMX Register #3 (MM3).
6640 Reads and returns the current value of MM3. This function is only available
6643 @return The current value of MM3.
6654 Reads the current value of 64-bit MMX Register #4 (MM4).
6656 Reads and returns the current value of MM4. This function is only available
6659 @return The current value of MM4.
6670 Reads the current value of 64-bit MMX Register #5 (MM5).
6672 Reads and returns the current value of MM5. This function is only available
6675 @return The current value of MM5.
6686 Reads the current value of 64-bit MMX Register #6 (MM6).
6688 Reads and returns the current value of MM6. This function is only available
6691 @return The current value of MM6.
6702 Reads the current value of 64-bit MMX Register #7 (MM7).
6704 Reads and returns the current value of MM7. This function is only available
6707 @return The current value of MM7.
6718 Writes the current value of 64-bit MMX Register #0 (MM0).
6720 Writes the current value of MM0. This function is only available on IA32 and
6723 @param Value The 64-bit value to write to MM0.
6734 Writes the current value of 64-bit MMX Register #1 (MM1).
6736 Writes the current value of MM1. This function is only available on IA32 and
6739 @param Value The 64-bit value to write to MM1.
6750 Writes the current value of 64-bit MMX Register #2 (MM2).
6752 Writes the current value of MM2. This function is only available on IA32 and
6755 @param Value The 64-bit value to write to MM2.
6766 Writes the current value of 64-bit MMX Register #3 (MM3).
6768 Writes the current value of MM3. This function is only available on IA32 and
6771 @param Value The 64-bit value to write to MM3.
6782 Writes the current value of 64-bit MMX Register #4 (MM4).
6784 Writes the current value of MM4. This function is only available on IA32 and
6787 @param Value The 64-bit value to write to MM4.
6798 Writes the current value of 64-bit MMX Register #5 (MM5).
6800 Writes the current value of MM5. This function is only available on IA32 and
6803 @param Value The 64-bit value to write to MM5.
6814 Writes the current value of 64-bit MMX Register #6 (MM6).
6816 Writes the current value of MM6. This function is only available on IA32 and
6819 @param Value The 64-bit value to write to MM6.
6830 Writes the current value of 64-bit MMX Register #7 (MM7).
6832 Writes the current value of MM7. This function is only available on IA32 and
6835 @param Value The 64-bit value to write to MM7.
6846 Reads the current value of Time Stamp Counter (TSC).
6848 Reads and returns the current value of TSC. This function is only available
6851 @return The current value of TSC
6862 Reads the current value of a Performance Counter (PMC).
6864 Reads and returns the current value of performance counter specified by
6865 Index. This function is only available on IA-32 and X64.
6867 @param Index The 32-bit Performance Counter index to read.
6869 @return The value of the PMC specified by Index.
6880 Sets up a monitor buffer that is used by AsmMwait().
6882 Executes a MONITOR instruction with the register state specified by Eax, Ecx
6883 and Edx. Returns Eax. This function is only available on IA-32 and X64.
6885 @param Eax The value to load into EAX or RAX before executing the MONITOR
6887 @param Ecx The value to load into ECX or RCX before executing the MONITOR
6889 @param Edx The value to load into EDX or RDX before executing the MONITOR
6905 Executes an MWAIT instruction.
6907 Executes an MWAIT instruction with the register state specified by Eax and
6908 Ecx. Returns Eax. This function is only available on IA-32 and X64.
6910 @param Eax The value to load into EAX or RAX before executing the MONITOR
6912 @param Ecx The value to load into ECX or RCX before executing the MONITOR
6927 Executes a WBINVD instruction.
6929 Executes a WBINVD instruction. This function is only available on IA-32 and
6941 Executes a INVD instruction.
6943 Executes a INVD instruction. This function is only available on IA-32 and
6955 Flushes a cache line from all the instruction and data caches within the
6956 coherency domain of the CPU.
6958 Flushed the cache line specified by LinearAddress, and returns LinearAddress.
6959 This function is only available on IA-32 and X64.
6961 @param LinearAddress The address of the cache line to flush. If the CPU is
6962 in a physical addressing mode, then LinearAddress is a
6963 physical address. If the CPU is in a virtual
6964 addressing mode, then LinearAddress is a virtual
6967 @return LinearAddress
6972 IN VOID
*LinearAddress
6977 Enables the 32-bit paging mode on the CPU.
6979 Enables the 32-bit paging mode on the CPU. CR0, CR3, CR4, and the page tables
6980 must be properly initialized prior to calling this service. This function
6981 assumes the current execution mode is 32-bit protected mode. This function is
6982 only available on IA-32. After the 32-bit paging mode is enabled, control is
6983 transferred to the function specified by EntryPoint using the new stack
6984 specified by NewStack and passing in the parameters specified by Context1 and
6985 Context2. Context1 and Context2 are optional and may be NULL. The function
6986 EntryPoint must never return.
6988 If the current execution mode is not 32-bit protected mode, then ASSERT().
6989 If EntryPoint is NULL, then ASSERT().
6990 If NewStack is NULL, then ASSERT().
6992 There are a number of constraints that must be followed before calling this
6994 1) Interrupts must be disabled.
6995 2) The caller must be in 32-bit protected mode with flat descriptors. This
6996 means all descriptors must have a base of 0 and a limit of 4GB.
6997 3) CR0 and CR4 must be compatible with 32-bit protected mode with flat
6999 4) CR3 must point to valid page tables that will be used once the transition
7000 is complete, and those page tables must guarantee that the pages for this
7001 function and the stack are identity mapped.
7003 @param EntryPoint A pointer to function to call with the new stack after
7005 @param Context1 A pointer to the context to pass into the EntryPoint
7006 function as the first parameter after paging is enabled.
7007 @param Context2 A pointer to the context to pass into the EntryPoint
7008 function as the second parameter after paging is enabled.
7009 @param NewStack A pointer to the new stack to use for the EntryPoint
7010 function after paging is enabled.
7016 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
7017 IN VOID
*Context1
, OPTIONAL
7018 IN VOID
*Context2
, OPTIONAL
7024 Disables the 32-bit paging mode on the CPU.
7026 Disables the 32-bit paging mode on the CPU and returns to 32-bit protected
7027 mode. This function assumes the current execution mode is 32-paged protected
7028 mode. This function is only available on IA-32. After the 32-bit paging mode
7029 is disabled, control is transferred to the function specified by EntryPoint
7030 using the new stack specified by NewStack and passing in the parameters
7031 specified by Context1 and Context2. Context1 and Context2 are optional and
7032 may be NULL. The function EntryPoint must never return.
7034 If the current execution mode is not 32-bit paged mode, then ASSERT().
7035 If EntryPoint is NULL, then ASSERT().
7036 If NewStack is NULL, then ASSERT().
7038 There are a number of constraints that must be followed before calling this
7040 1) Interrupts must be disabled.
7041 2) The caller must be in 32-bit paged mode.
7042 3) CR0, CR3, and CR4 must be compatible with 32-bit paged mode.
7043 4) CR3 must point to valid page tables that guarantee that the pages for
7044 this function and the stack are identity mapped.
7046 @param EntryPoint A pointer to function to call with the new stack after
7048 @param Context1 A pointer to the context to pass into the EntryPoint
7049 function as the first parameter after paging is disabled.
7050 @param Context2 A pointer to the context to pass into the EntryPoint
7051 function as the second parameter after paging is
7053 @param NewStack A pointer to the new stack to use for the EntryPoint
7054 function after paging is disabled.
7059 AsmDisablePaging32 (
7060 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
7061 IN VOID
*Context1
, OPTIONAL
7062 IN VOID
*Context2
, OPTIONAL
7068 Enables the 64-bit paging mode on the CPU.
7070 Enables the 64-bit paging mode on the CPU. CR0, CR3, CR4, and the page tables
7071 must be properly initialized prior to calling this service. This function
7072 assumes the current execution mode is 32-bit protected mode with flat
7073 descriptors. This function is only available on IA-32. After the 64-bit
7074 paging mode is enabled, control is transferred to the function specified by
7075 EntryPoint using the new stack specified by NewStack and passing in the
7076 parameters specified by Context1 and Context2. Context1 and Context2 are
7077 optional and may be 0. The function EntryPoint must never return.
7079 If the current execution mode is not 32-bit protected mode with flat
7080 descriptors, then ASSERT().
7081 If EntryPoint is 0, then ASSERT().
7082 If NewStack is 0, then ASSERT().
7084 @param CodeSelector The 16-bit selector to load in the CS before EntryPoint
7085 is called. The descriptor in the GDT that this selector
7086 references must be setup for long mode.
7087 @param EntryPoint The 64-bit virtual address of the function to call with
7088 the new stack after paging is enabled.
7089 @param Context1 The 64-bit virtual address of the context to pass into
7090 the EntryPoint function as the first parameter after
7092 @param Context2 The 64-bit virtual address of the context to pass into
7093 the EntryPoint function as the second parameter after
7095 @param NewStack The 64-bit virtual address of the new stack to use for
7096 the EntryPoint function after paging is enabled.
7102 IN UINT16 CodeSelector
,
7103 IN UINT64 EntryPoint
,
7104 IN UINT64 Context1
, OPTIONAL
7105 IN UINT64 Context2
, OPTIONAL
7111 Disables the 64-bit paging mode on the CPU.
7113 Disables the 64-bit paging mode on the CPU and returns to 32-bit protected
7114 mode. This function assumes the current execution mode is 64-paging mode.
7115 This function is only available on X64. After the 64-bit paging mode is
7116 disabled, control is transferred to the function specified by EntryPoint
7117 using the new stack specified by NewStack and passing in the parameters
7118 specified by Context1 and Context2. Context1 and Context2 are optional and
7119 may be 0. The function EntryPoint must never return.
7121 If the current execution mode is not 64-bit paged mode, then ASSERT().
7122 If EntryPoint is 0, then ASSERT().
7123 If NewStack is 0, then ASSERT().
7125 @param CodeSelector The 16-bit selector to load in the CS before EntryPoint
7126 is called. The descriptor in the GDT that this selector
7127 references must be setup for 32-bit protected mode.
7128 @param EntryPoint The 64-bit virtual address of the function to call with
7129 the new stack after paging is disabled.
7130 @param Context1 The 64-bit virtual address of the context to pass into
7131 the EntryPoint function as the first parameter after
7133 @param Context2 The 64-bit virtual address of the context to pass into
7134 the EntryPoint function as the second parameter after
7136 @param NewStack The 64-bit virtual address of the new stack to use for
7137 the EntryPoint function after paging is disabled.
7142 AsmDisablePaging64 (
7143 IN UINT16 CodeSelector
,
7144 IN UINT32 EntryPoint
,
7145 IN UINT32 Context1
, OPTIONAL
7146 IN UINT32 Context2
, OPTIONAL
7152 // 16-bit thunking services
7156 Retrieves the properties for 16-bit thunk functions.
7158 Computes the size of the buffer and stack below 1MB required to use the
7159 AsmPrepareThunk16(), AsmThunk16() and AsmPrepareAndThunk16() functions. This
7160 buffer size is returned in RealModeBufferSize, and the stack size is returned
7161 in ExtraStackSize. If parameters are passed to the 16-bit real mode code,
7162 then the actual minimum stack size is ExtraStackSize plus the maximum number
7163 of bytes that need to be passed to the 16-bit real mode code.
7165 If RealModeBufferSize is NULL, then ASSERT().
7166 If ExtraStackSize is NULL, then ASSERT().
7168 @param RealModeBufferSize A pointer to the size of the buffer below 1MB
7169 required to use the 16-bit thunk functions.
7170 @param ExtraStackSize A pointer to the extra size of stack below 1MB
7171 that the 16-bit thunk functions require for
7172 temporary storage in the transition to and from
7178 AsmGetThunk16Properties (
7179 OUT UINT32
*RealModeBufferSize
,
7180 OUT UINT32
*ExtraStackSize
7185 Prepares all structures a code required to use AsmThunk16().
7187 Prepares all structures and code required to use AsmThunk16().
7189 If ThunkContext is NULL, then ASSERT().
7191 @param ThunkContext A pointer to the context structure that describes the
7192 16-bit real mode code to call.
7198 OUT THUNK_CONTEXT
*ThunkContext
7203 Transfers control to a 16-bit real mode entry point and returns the results.
7205 Transfers control to a 16-bit real mode entry point and returns the results.
7206 AsmPrepareThunk16() must be called with ThunkContext before this function is
7209 If ThunkContext is NULL, then ASSERT().
7210 If AsmPrepareThunk16() was not previously called with ThunkContext, then ASSERT().
7212 @param ThunkContext A pointer to the context structure that describes the
7213 16-bit real mode code to call.
7219 IN OUT THUNK_CONTEXT
*ThunkContext
7224 Prepares all structures and code for a 16-bit real mode thunk, transfers
7225 control to a 16-bit real mode entry point, and returns the results.
7227 Prepares all structures and code for a 16-bit real mode thunk, transfers
7228 control to a 16-bit real mode entry point, and returns the results. If the
7229 caller only need to perform a single 16-bit real mode thunk, then this
7230 service should be used. If the caller intends to make more than one 16-bit
7231 real mode thunk, then it is more efficient if AsmPrepareThunk16() is called
7232 once and AsmThunk16() can be called for each 16-bit real mode thunk.
7234 If ThunkContext is NULL, then ASSERT().
7236 @param ThunkContext A pointer to the context structure that describes the
7237 16-bit real mode code to call.
7242 AsmPrepareAndThunk16 (
7243 IN OUT THUNK_CONTEXT
*ThunkContext