2 Memory-only library functions with no library constructor/destructor
4 Copyright (c) 2006 - 2008, Intel Corporation
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
19 /// Definitions for SPIN_LOCK
21 typedef volatile UINTN SPIN_LOCK
;
24 // Definitions for architecture specific types
26 #if defined (MDE_CPU_IA32)
28 /// IA32 context buffer used by SetJump() and LongJump()
37 } BASE_LIBRARY_JUMP_BUFFER
;
39 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 4
41 #elif defined (MDE_CPU_IPF)
44 /// IPF context buffer used by SetJump() and LongJump()
79 UINT64 AfterSpillUNAT
;
85 } BASE_LIBRARY_JUMP_BUFFER
;
87 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 0x10
89 #elif defined (MDE_CPU_X64)
91 /// X64 context buffer used by SetJump() and LongJump()
104 } BASE_LIBRARY_JUMP_BUFFER
;
106 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 8
108 #elif defined (MDE_CPU_EBC)
110 /// EBC context buffer used by SetJump() and LongJump()
118 } BASE_LIBRARY_JUMP_BUFFER
;
120 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 8
123 #error Unknown Processor Type
131 Copies one Null-terminated Unicode string to another Null-terminated Unicode
132 string and returns the new Unicode string.
134 This function copies the contents of the Unicode string Source to the Unicode
135 string Destination, and returns Destination. If Source and Destination
136 overlap, then the results are undefined.
138 If Destination is NULL, then ASSERT().
139 If Destination is not aligned on a 16-bit boundary, then ASSERT().
140 If Source is NULL, then ASSERT().
141 If Source is not aligned on a 16-bit boundary, then ASSERT().
142 If Source and Destination overlap, then ASSERT().
143 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
144 PcdMaximumUnicodeStringLength Unicode characters not including the
145 Null-terminator, then ASSERT().
147 @param Destination Pointer to a Null-terminated Unicode string.
148 @param Source Pointer to a Null-terminated Unicode string.
156 OUT CHAR16
*Destination
,
157 IN CONST CHAR16
*Source
162 Copies one Null-terminated Unicode string with a maximum length to another
163 Null-terminated Unicode string with a maximum length and returns the new
166 This function copies the contents of the Unicode string Source to the Unicode
167 string Destination, and returns Destination. At most, Length Unicode
168 characters are copied from Source to Destination. If Length is 0, then
169 Destination is returned unmodified. If Length is greater that the number of
170 Unicode characters in Source, then Destination is padded with Null Unicode
171 characters. If Source and Destination overlap, then the results are
174 If Length > 0 and Destination is NULL, then ASSERT().
175 If Length > 0 and Destination is not aligned on a 16-bit boundary, then ASSERT().
176 If Length > 0 and Source is NULL, then ASSERT().
177 If Length > 0 and Source is not aligned on a 16-bit bounadry, then ASSERT().
178 If Source and Destination overlap, then ASSERT().
179 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
180 PcdMaximumUnicodeStringLength Unicode characters not including the
181 Null-terminator, then ASSERT().
183 @param Destination Pointer to a Null-terminated Unicode string.
184 @param Source Pointer to a Null-terminated Unicode string.
185 @param Length Maximum number of Unicode characters to copy.
193 OUT CHAR16
*Destination
,
194 IN CONST CHAR16
*Source
,
200 Returns the length of a Null-terminated Unicode string.
202 This function returns the number of Unicode characters in the Null-terminated
203 Unicode string specified by String.
205 If String is NULL, then ASSERT().
206 If String is not aligned on a 16-bit boundary, then ASSERT().
207 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
208 PcdMaximumUnicodeStringLength Unicode characters not including the
209 Null-terminator, then ASSERT().
211 @param String Pointer to a Null-terminated Unicode string.
213 @return The length of String.
219 IN CONST CHAR16
*String
224 Returns the size of a Null-terminated Unicode string in bytes, including the
227 This function returns the size, in bytes, of the Null-terminated Unicode
228 string specified by String.
230 If String is NULL, then ASSERT().
231 If String is not aligned on a 16-bit boundary, then ASSERT().
232 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
233 PcdMaximumUnicodeStringLength Unicode characters not including the
234 Null-terminator, then ASSERT().
236 @param String Pointer to a Null-terminated Unicode string.
238 @return The size of String.
244 IN CONST CHAR16
*String
249 Compares two Null-terminated Unicode strings, and returns the difference
250 between the first mismatched Unicode characters.
252 This function compares the Null-terminated Unicode string FirstString to the
253 Null-terminated Unicode string SecondString. If FirstString is identical to
254 SecondString, then 0 is returned. Otherwise, the value returned is the first
255 mismatched Unicode character in SecondString subtracted from the first
256 mismatched Unicode character in FirstString.
258 If FirstString is NULL, then ASSERT().
259 If FirstString is not aligned on a 16-bit boundary, then ASSERT().
260 If SecondString is NULL, then ASSERT().
261 If SecondString is not aligned on a 16-bit boundary, then ASSERT().
262 If PcdMaximumUnicodeStringLength is not zero, and FirstString contains more
263 than PcdMaximumUnicodeStringLength Unicode characters not including the
264 Null-terminator, then ASSERT().
265 If PcdMaximumUnicodeStringLength is not zero, and SecondString contains more
266 than PcdMaximumUnicodeStringLength Unicode characters not including the
267 Null-terminator, then ASSERT().
269 @param FirstString Pointer to a Null-terminated Unicode string.
270 @param SecondString Pointer to a Null-terminated Unicode string.
272 @retval 0 FirstString is identical to SecondString.
273 @return others FirstString is not identical to SecondString.
279 IN CONST CHAR16
*FirstString
,
280 IN CONST CHAR16
*SecondString
285 Compares two Null-terminated Unicode strings with maximum lengths, and
286 returns the difference between the first mismatched Unicode characters.
288 This function compares the Null-terminated Unicode string FirstString to the
289 Null-terminated Unicode string SecondString. At most, Length Unicode
290 characters will be compared. If Length is 0, then 0 is returned. If
291 FirstString is identical to SecondString, then 0 is returned. Otherwise, the
292 value returned is the first mismatched Unicode character in SecondString
293 subtracted from the first mismatched Unicode character in FirstString.
295 If Length > 0 and FirstString is NULL, then ASSERT().
296 If Length > 0 and FirstString is not aligned on a 16-bit bounadary, then ASSERT().
297 If Length > 0 and SecondString is NULL, then ASSERT().
298 If Length > 0 and SecondString is not aligned on a 16-bit bounadary, then ASSERT().
299 If PcdMaximumUnicodeStringLength is not zero, and FirstString contains more
300 than PcdMaximumUnicodeStringLength Unicode characters not including the
301 Null-terminator, then ASSERT().
302 If PcdMaximumUnicodeStringLength is not zero, and SecondString contains more
303 than PcdMaximumUnicodeStringLength Unicode characters not including the
304 Null-terminator, then ASSERT().
306 @param FirstString Pointer to a Null-terminated Unicode string.
307 @param SecondString Pointer to a Null-terminated Unicode string.
308 @param Length Maximum number of Unicode characters to compare.
310 @retval 0 FirstString is identical to SecondString.
311 @return others FirstString is not identical to SecondString.
317 IN CONST CHAR16
*FirstString
,
318 IN CONST CHAR16
*SecondString
,
324 Concatenates one Null-terminated Unicode string to another Null-terminated
325 Unicode string, and returns the concatenated Unicode string.
327 This function concatenates two Null-terminated Unicode strings. The contents
328 of Null-terminated Unicode string Source are concatenated to the end of
329 Null-terminated Unicode string Destination. The Null-terminated concatenated
330 Unicode String is returned. If Source and Destination overlap, then the
331 results are undefined.
333 If Destination is NULL, then ASSERT().
334 If Destination is not aligned on a 16-bit bounadary, then ASSERT().
335 If Source is NULL, then ASSERT().
336 If Source is not aligned on a 16-bit bounadary, then ASSERT().
337 If Source and Destination overlap, then ASSERT().
338 If PcdMaximumUnicodeStringLength is not zero, and Destination contains more
339 than PcdMaximumUnicodeStringLength Unicode characters not including the
340 Null-terminator, then ASSERT().
341 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
342 PcdMaximumUnicodeStringLength Unicode characters not including the
343 Null-terminator, then ASSERT().
344 If PcdMaximumUnicodeStringLength is not zero, and concatenating Destination
345 and Source results in a Unicode string with more than
346 PcdMaximumUnicodeStringLength Unicode characters not including the
347 Null-terminator, then ASSERT().
349 @param Destination Pointer to a Null-terminated Unicode string.
350 @param Source Pointer to a Null-terminated Unicode string.
358 IN OUT CHAR16
*Destination
,
359 IN CONST CHAR16
*Source
364 Concatenates one Null-terminated Unicode string with a maximum length to the
365 end of another Null-terminated Unicode string, and returns the concatenated
368 This function concatenates two Null-terminated Unicode strings. The contents
369 of Null-terminated Unicode string Source are concatenated to the end of
370 Null-terminated Unicode string Destination, and Destination is returned. At
371 most, Length Unicode characters are concatenated from Source to the end of
372 Destination, and Destination is always Null-terminated. If Length is 0, then
373 Destination is returned unmodified. If Source and Destination overlap, then
374 the results are undefined.
376 If Destination is NULL, then ASSERT().
377 If Length > 0 and Destination is not aligned on a 16-bit boundary, then ASSERT().
378 If Length > 0 and Source is NULL, then ASSERT().
379 If Length > 0 and Source is not aligned on a 16-bit boundary, then ASSERT().
380 If Source and Destination overlap, then ASSERT().
381 If PcdMaximumUnicodeStringLength is not zero, and Destination contains more
382 than PcdMaximumUnicodeStringLength Unicode characters not including the
383 Null-terminator, then ASSERT().
384 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
385 PcdMaximumUnicodeStringLength Unicode characters not including the
386 Null-terminator, then ASSERT().
387 If PcdMaximumUnicodeStringLength is not zero, and concatenating Destination
388 and Source results in a Unicode string with more than
389 PcdMaximumUnicodeStringLength Unicode characters not including the
390 Null-terminator, then ASSERT().
392 @param Destination Pointer to a Null-terminated Unicode string.
393 @param Source Pointer to a Null-terminated Unicode string.
394 @param Length Maximum number of Unicode characters to concatenate from
403 IN OUT CHAR16
*Destination
,
404 IN CONST CHAR16
*Source
,
409 Returns the first occurance of a Null-terminated Unicode sub-string
410 in a Null-terminated Unicode string.
412 This function scans the contents of the Null-terminated Unicode string
413 specified by String and returns the first occurrence of SearchString.
414 If SearchString is not found in String, then NULL is returned. If
415 the length of SearchString is zero, then String is
418 If String is NULL, then ASSERT().
419 If String is not aligned on a 16-bit boundary, then ASSERT().
420 If SearchString is NULL, then ASSERT().
421 If SearchString is not aligned on a 16-bit boundary, then ASSERT().
423 If PcdMaximumUnicodeStringLength is not zero, and SearchString
424 or String contains more than PcdMaximumUnicodeStringLength Unicode
425 characters not including the Null-terminator, then ASSERT().
427 @param String Pointer to a Null-terminated Unicode string.
428 @param SearchString Pointer to a Null-terminated Unicode string to search for.
430 @retval NULL If the SearchString does not appear in String.
431 @return others If there is a match.
437 IN CONST CHAR16
*String
,
438 IN CONST CHAR16
*SearchString
442 Convert a Null-terminated Unicode decimal string to a value of
445 This function returns a value of type UINTN by interpreting the contents
446 of the Unicode string specified by String as a decimal number. The format
447 of the input Unicode string String is:
449 [spaces] [decimal digits].
451 The valid decimal digit character is in the range [0-9]. The
452 function will ignore the pad space, which includes spaces or
453 tab characters, before [decimal digits]. The running zero in the
454 beginning of [decimal digits] will be ignored. Then, the function
455 stops at the first character that is a not a valid decimal character
456 or a Null-terminator, whichever one comes first.
458 If String is NULL, then ASSERT().
459 If String is not aligned in a 16-bit boundary, then ASSERT().
460 If String has only pad spaces, then 0 is returned.
461 If String has no pad spaces or valid decimal digits,
463 If the number represented by String overflows according
464 to the range defined by UINTN, then ASSERT().
466 If PcdMaximumUnicodeStringLength is not zero, and String contains
467 more than PcdMaximumUnicodeStringLength Unicode characters not including
468 the Null-terminator, then ASSERT().
470 @param String Pointer to a Null-terminated Unicode string.
472 @retval Value translated from String.
478 IN CONST CHAR16
*String
482 Convert a Null-terminated Unicode decimal string to a value of
485 This function returns a value of type UINT64 by interpreting the contents
486 of the Unicode string specified by String as a decimal number. The format
487 of the input Unicode string String is:
489 [spaces] [decimal digits].
491 The valid decimal digit character is in the range [0-9]. The
492 function will ignore the pad space, which includes spaces or
493 tab characters, before [decimal digits]. The running zero in the
494 beginning of [decimal digits] will be ignored. Then, the function
495 stops at the first character that is a not a valid decimal character
496 or a Null-terminator, whichever one comes first.
498 If String is NULL, then ASSERT().
499 If String is not aligned in a 16-bit boundary, then ASSERT().
500 If String has only pad spaces, then 0 is returned.
501 If String has no pad spaces or valid decimal digits,
503 If the number represented by String overflows according
504 to the range defined by UINT64, then ASSERT().
506 If PcdMaximumUnicodeStringLength is not zero, and String contains
507 more than PcdMaximumUnicodeStringLength Unicode characters not including
508 the Null-terminator, then ASSERT().
510 @param String Pointer to a Null-terminated Unicode string.
512 @retval Value translated from String.
518 IN CONST CHAR16
*String
523 Convert a Null-terminated Unicode hexadecimal string to a value of type UINTN.
525 This function returns a value of type UINTN by interpreting the contents
526 of the Unicode string specified by String as a hexadecimal number.
527 The format of the input Unicode string String is:
529 [spaces][zeros][x][hexadecimal digits].
531 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
532 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix.
533 If "x" appears in the input string, it must be prefixed with at least one 0.
534 The function will ignore the pad space, which includes spaces or tab characters,
535 before [zeros], [x] or [hexadecimal digit]. The running zero before [x] or
536 [hexadecimal digit] will be ignored. Then, the decoding starts after [x] or the
537 first valid hexadecimal digit. Then, the function stops at the first character that is
538 a not a valid hexadecimal character or NULL, whichever one comes first.
540 If String is NULL, then ASSERT().
541 If String is not aligned in a 16-bit boundary, then ASSERT().
542 If String has only pad spaces, then zero is returned.
543 If String has no leading pad spaces, leading zeros or valid hexadecimal digits,
544 then zero is returned.
545 If the number represented by String overflows according to the range defined by
546 UINTN, then ASSERT().
548 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
549 PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator,
552 @param String Pointer to a Null-terminated Unicode string.
554 @retval Value translated from String.
560 IN CONST CHAR16
*String
565 Convert a Null-terminated Unicode hexadecimal string to a value of type UINT64.
567 This function returns a value of type UINT64 by interpreting the contents
568 of the Unicode string specified by String as a hexadecimal number.
569 The format of the input Unicode string String is
571 [spaces][zeros][x][hexadecimal digits].
573 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
574 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix.
575 If "x" appears in the input string, it must be prefixed with at least one 0.
576 The function will ignore the pad space, which includes spaces or tab characters,
577 before [zeros], [x] or [hexadecimal digit]. The running zero before [x] or
578 [hexadecimal digit] will be ignored. Then, the decoding starts after [x] or the
579 first valid hexadecimal digit. Then, the function stops at the first character that is
580 a not a valid hexadecimal character or NULL, whichever one comes first.
582 If String is NULL, then ASSERT().
583 If String is not aligned in a 16-bit boundary, then ASSERT().
584 If String has only pad spaces, then zero is returned.
585 If String has no leading pad spaces, leading zeros or valid hexadecimal digits,
586 then zero is returned.
587 If the number represented by String overflows according to the range defined by
588 UINT64, then ASSERT().
590 If PcdMaximumUnicodeStringLength is not zero, and String contains more than
591 PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator,
594 @param String Pointer to a Null-terminated Unicode string.
596 @retval Value translated from String.
602 IN CONST CHAR16
*String
606 Convert a nibble in the low 4 bits of a byte to a Unicode hexadecimal character.
608 This function converts a nibble in the low 4 bits of a byte to a Unicode hexadecimal
609 character For example, the nibble 0x01 and 0x0A will converted to L'1' and L'A'
612 The upper nibble in the input byte will be masked off.
614 @param Nibble The nibble which is in the low 4 bits of the input byte.
616 @retval CHAR16 The Unicode hexadecimal character.
626 Convert binary buffer to a Unicode String in a specified sequence.
628 This function converts bytes in the memory block pointed by Buffer to a Unicode String Str.
629 Each byte will be represented by two Unicode characters. For example, byte 0xA1 will
630 be converted into two Unicode character L'A' and L'1'. In the output String, the Unicode Character
631 for the Most Significant Nibble will be put before the Unicode Character for the Least Significant
632 Nibble. The output string for the buffer containing a single byte 0xA1 will be L"A1".
633 For a buffer with multiple bytes, the Unicode character produced by the first byte will be put into the
634 the last character in the output string. The one next to first byte will be put into the
635 character before the last character. This rules applies to the rest of the bytes. The Unicode
636 character by the last byte will be put into the first character in the output string. For example,
637 the input buffer for a 64-bits unsigned integrer 0x12345678abcdef1234 will be converted to
638 a Unicode string equal to L"12345678abcdef1234".
640 @param String On input, String is pointed to the buffer allocated for the convertion.
641 @param StringLen The Length of String buffer to hold the output String. The length must include the tailing '\0' character.
642 The StringLen required to convert a N bytes Buffer will be a least equal to or greater
644 @param Buffer The pointer to a input buffer.
645 @param BufferSizeInBytes Lenth in bytes of the input buffer.
648 @retval EFI_SUCCESS The convertion is successfull. All bytes in Buffer has been convert to the corresponding
649 Unicode character and placed into the right place in String.
650 @retval EFI_BUFFER_TOO_SMALL StringSizeInBytes is smaller than 2 * N + 1the number of bytes required to
651 complete the convertion.
656 IN OUT CHAR16
*String
,
657 IN OUT UINTN
*StringLen
,
658 IN CONST UINT8
*Buffer
,
659 IN UINTN BufferSizeInBytes
664 Convert a Unicode string consisting of hexadecimal characters to a output byte buffer.
666 This function converts a Unicode string consisting of characters in the range of Hexadecimal
667 character (L'0' to L'9', L'A' to L'F' and L'a' to L'f') to a output byte buffer. The function will stop
668 at the first non-hexadecimal character or the NULL character. The convertion process can be
669 simply viewed as the reverse operations defined by BufToHexString. Two Unicode characters will be
670 converted into one byte. The first Unicode character represents the Most Significant Nibble and the
671 second Unicode character represents the Least Significant Nibble in the output byte.
672 The first pair of Unicode characters represents the last byte in the output buffer. The second pair of Unicode
673 characters represent the the byte preceding the last byte. This rule applies to the rest pairs of bytes.
674 The last pair represent the first byte in the output buffer.
676 For example, a Unciode String L"12345678" will be converted into a buffer wil the following bytes
677 (first byte is the byte in the lowest memory address): "0x78, 0x56, 0x34, 0x12".
679 If String has N valid hexadecimal characters for conversion, the caller must make sure Buffer is at least
680 N/2 (if N is even) or (N+1)/2 (if N if odd) bytes.
682 @param Buffer The output buffer allocated by the caller.
683 @param BufferSizeInBytes On input, the size in bytes of Buffer. On output, it is updated to
684 contain the size of the Buffer which is actually used for the converstion.
685 For Unicode string with 2*N hexadecimal characters (not including the
686 tailing NULL character), N bytes of Buffer will be used for the output.
687 @param String The input hexadecimal string.
688 @param ConvertedStrLen The number of hexadecimal characters used to produce content in output
691 @retval RETURN_BUFFER_TOO_SMALL The input BufferSizeInBytes is too small to hold the output. BufferSizeInBytes
692 will be updated to the size required for the converstion.
693 @retval RETURN_SUCCESS The convertion is successful or the first Unicode character from String
694 is hexadecimal. If ConvertedStrLen is not NULL, it is updated
695 to the number of hexadecimal character used for the converstion.
701 IN OUT UINTN
*BufferSizeInBytes
,
702 IN CONST CHAR16
*String
,
703 OUT UINTN
*ConvertedStrLen OPTIONAL
708 Test if a Unicode character is a hexadecimal digit. If true, the input
709 Unicode character is converted to a byte.
711 This function tests if a Unicode character is a hexadecimal digit. If true, the input
712 Unicode character is converted to a byte. For example, Unicode character
713 L'A' will be converted to 0x0A.
715 If Digit is NULL, then ASSERT.
717 @param Digit The output hexadecimal digit.
719 @param Char The input Unicode character.
721 @retval TRUE Char is in the range of Hexadecimal number. Digit is updated
722 to the byte value of the number.
723 @retval FALSE Char is not in the range of Hexadecimal number. Digit is keep
735 Convert one Null-terminated Unicode string to a Null-terminated
736 ASCII string and returns the ASCII string.
738 This function converts the content of the Unicode string Source
739 to the ASCII string Destination by copying the lower 8 bits of
740 each Unicode character. It returns Destination.
742 If any Unicode characters in Source contain non-zero value in
743 the upper 8 bits, then ASSERT().
745 If Destination is NULL, then ASSERT().
746 If Source is NULL, then ASSERT().
747 If Source is not aligned on a 16-bit boundary, then ASSERT().
748 If Source and Destination overlap, then ASSERT().
750 If PcdMaximumUnicodeStringLength is not zero, and Source contains
751 more than PcdMaximumUnicodeStringLength Unicode characters not including
752 the Null-terminator, then ASSERT().
754 If PcdMaximumAsciiStringLength is not zero, and Source contains more
755 than PcdMaximumAsciiStringLength Unicode characters not including the
756 Null-terminator, then ASSERT().
758 @param Source Pointer to a Null-terminated Unicode string.
759 @param Destination Pointer to a Null-terminated ASCII string.
766 UnicodeStrToAsciiStr (
767 IN CONST CHAR16
*Source
,
768 OUT CHAR8
*Destination
773 Copies one Null-terminated ASCII string to another Null-terminated ASCII
774 string and returns the new ASCII string.
776 This function copies the contents of the ASCII string Source to the ASCII
777 string Destination, and returns Destination. If Source and Destination
778 overlap, then the results are undefined.
780 If Destination is NULL, then ASSERT().
781 If Source is NULL, then ASSERT().
782 If Source and Destination overlap, then ASSERT().
783 If PcdMaximumAsciiStringLength is not zero and Source contains more than
784 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
787 @param Destination Pointer to a Null-terminated ASCII string.
788 @param Source Pointer to a Null-terminated ASCII string.
796 OUT CHAR8
*Destination
,
797 IN CONST CHAR8
*Source
802 Copies one Null-terminated ASCII string with a maximum length to another
803 Null-terminated ASCII string with a maximum length and returns the new ASCII
806 This function copies the contents of the ASCII string Source to the ASCII
807 string Destination, and returns Destination. At most, Length ASCII characters
808 are copied from Source to Destination. If Length is 0, then Destination is
809 returned unmodified. If Length is greater that the number of ASCII characters
810 in Source, then Destination is padded with Null ASCII characters. If Source
811 and Destination overlap, then the results are undefined.
813 If Destination is NULL, then ASSERT().
814 If Source is NULL, then ASSERT().
815 If Source and Destination overlap, then ASSERT().
816 If PcdMaximumAsciiStringLength is not zero, and Source contains more than
817 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
820 @param Destination Pointer to a Null-terminated ASCII string.
821 @param Source Pointer to a Null-terminated ASCII string.
822 @param Length Maximum number of ASCII characters to copy.
830 OUT CHAR8
*Destination
,
831 IN CONST CHAR8
*Source
,
837 Returns the length of a Null-terminated ASCII string.
839 This function returns the number of ASCII characters in the Null-terminated
840 ASCII string specified by String.
842 If Length > 0 and Destination is NULL, then ASSERT().
843 If Length > 0 and Source is NULL, then ASSERT().
844 If PcdMaximumAsciiStringLength is not zero and String contains more than
845 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
848 @param String Pointer to a Null-terminated ASCII string.
850 @return The length of String.
856 IN CONST CHAR8
*String
861 Returns the size of a Null-terminated ASCII string in bytes, including the
864 This function returns the size, in bytes, of the Null-terminated ASCII string
867 If String is NULL, then ASSERT().
868 If PcdMaximumAsciiStringLength is not zero and String contains more than
869 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
872 @param String Pointer to a Null-terminated ASCII string.
874 @return The size of String.
880 IN CONST CHAR8
*String
885 Compares two Null-terminated ASCII strings, and returns the difference
886 between the first mismatched ASCII characters.
888 This function compares the Null-terminated ASCII string FirstString to the
889 Null-terminated ASCII string SecondString. If FirstString is identical to
890 SecondString, then 0 is returned. Otherwise, the value returned is the first
891 mismatched ASCII character in SecondString subtracted from the first
892 mismatched ASCII character in FirstString.
894 If FirstString is NULL, then ASSERT().
895 If SecondString is NULL, then ASSERT().
896 If PcdMaximumAsciiStringLength is not zero and FirstString contains more than
897 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
899 If PcdMaximumAsciiStringLength is not zero and SecondString contains more
900 than PcdMaximumAsciiStringLength ASCII characters not including the
901 Null-terminator, then ASSERT().
903 @param FirstString Pointer to a Null-terminated ASCII string.
904 @param SecondString Pointer to a Null-terminated ASCII string.
906 @retval 0 FirstString is identical to SecondString.
907 @return others FirstString is not identical to SecondString.
913 IN CONST CHAR8
*FirstString
,
914 IN CONST CHAR8
*SecondString
919 Performs a case insensitive comparison of two Null-terminated ASCII strings,
920 and returns the difference between the first mismatched ASCII characters.
922 This function performs a case insensitive comparison of the Null-terminated
923 ASCII string FirstString to the Null-terminated ASCII string SecondString. If
924 FirstString is identical to SecondString, then 0 is returned. Otherwise, the
925 value returned is the first mismatched lower case ASCII character in
926 SecondString subtracted from the first mismatched lower case ASCII character
929 If FirstString is NULL, then ASSERT().
930 If SecondString is NULL, then ASSERT().
931 If PcdMaximumAsciiStringLength is not zero and FirstString contains more than
932 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
934 If PcdMaximumAsciiStringLength is not zero and SecondString contains more
935 than PcdMaximumAsciiStringLength ASCII characters not including the
936 Null-terminator, then ASSERT().
938 @param FirstString Pointer to a Null-terminated ASCII string.
939 @param SecondString Pointer to a Null-terminated ASCII string.
941 @retval 0 FirstString is identical to SecondString using case insensitive
943 @return others FirstString is not identical to SecondString using case
944 insensitive comparisons.
950 IN CONST CHAR8
*FirstString
,
951 IN CONST CHAR8
*SecondString
956 Compares two Null-terminated ASCII strings with maximum lengths, and returns
957 the difference between the first mismatched ASCII characters.
959 This function compares the Null-terminated ASCII string FirstString to the
960 Null-terminated ASCII string SecondString. At most, Length ASCII characters
961 will be compared. If Length is 0, then 0 is returned. If FirstString is
962 identical to SecondString, then 0 is returned. Otherwise, the value returned
963 is the first mismatched ASCII character in SecondString subtracted from the
964 first mismatched ASCII character in FirstString.
966 If Length > 0 and FirstString is NULL, then ASSERT().
967 If Length > 0 and SecondString is NULL, then ASSERT().
968 If PcdMaximumAsciiStringLength is not zero and FirstString contains more than
969 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
971 If PcdMaximumAsciiStringLength is not zero and SecondString contains more than
972 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
975 @param FirstString Pointer to a Null-terminated ASCII string.
976 @param SecondString Pointer to a Null-terminated ASCII string.
977 @param Length Maximum number of ASCII characters for compare.
979 @retval 0 FirstString is identical to SecondString.
980 @return others FirstString is not identical to SecondString.
986 IN CONST CHAR8
*FirstString
,
987 IN CONST CHAR8
*SecondString
,
993 Concatenates one Null-terminated ASCII string to another Null-terminated
994 ASCII string, and returns the concatenated ASCII string.
996 This function concatenates two Null-terminated ASCII strings. The contents of
997 Null-terminated ASCII string Source are concatenated to the end of Null-
998 terminated ASCII string Destination. The Null-terminated concatenated ASCII
1001 If Destination is NULL, then ASSERT().
1002 If Source is NULL, then ASSERT().
1003 If PcdMaximumAsciiStringLength is not zero and Destination contains more than
1004 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
1006 If PcdMaximumAsciiStringLength is not zero and Source contains more than
1007 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
1009 If PcdMaximumAsciiStringLength is not zero and concatenating Destination and
1010 Source results in a ASCII string with more than PcdMaximumAsciiStringLength
1011 ASCII characters, then ASSERT().
1013 @param Destination Pointer to a Null-terminated ASCII string.
1014 @param Source Pointer to a Null-terminated ASCII string.
1022 IN OUT CHAR8
*Destination
,
1023 IN CONST CHAR8
*Source
1028 Concatenates one Null-terminated ASCII string with a maximum length to the
1029 end of another Null-terminated ASCII string, and returns the concatenated
1032 This function concatenates two Null-terminated ASCII strings. The contents
1033 of Null-terminated ASCII string Source are concatenated to the end of Null-
1034 terminated ASCII string Destination, and Destination is returned. At most,
1035 Length ASCII characters are concatenated from Source to the end of
1036 Destination, and Destination is always Null-terminated. If Length is 0, then
1037 Destination is returned unmodified. If Source and Destination overlap, then
1038 the results are undefined.
1040 If Length > 0 and Destination is NULL, then ASSERT().
1041 If Length > 0 and Source is NULL, then ASSERT().
1042 If Source and Destination overlap, then ASSERT().
1043 If PcdMaximumAsciiStringLength is not zero, and Destination contains more than
1044 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
1046 If PcdMaximumAsciiStringLength is not zero, and Source contains more than
1047 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
1049 If PcdMaximumAsciiStringLength is not zero, and concatenating Destination and
1050 Source results in a ASCII string with more than PcdMaximumAsciiStringLength
1051 ASCII characters not including the Null-terminator, then ASSERT().
1053 @param Destination Pointer to a Null-terminated ASCII string.
1054 @param Source Pointer to a Null-terminated ASCII string.
1055 @param Length Maximum number of ASCII characters to concatenate from
1064 IN OUT CHAR8
*Destination
,
1065 IN CONST CHAR8
*Source
,
1071 Returns the first occurance of a Null-terminated ASCII sub-string
1072 in a Null-terminated ASCII string.
1074 This function scans the contents of the ASCII string specified by String
1075 and returns the first occurrence of SearchString. If SearchString is not
1076 found in String, then NULL is returned. If the length of SearchString is zero,
1077 then String is returned.
1079 If String is NULL, then ASSERT().
1080 If SearchString is NULL, then ASSERT().
1082 If PcdMaximumAsciiStringLength is not zero, and SearchString or
1083 String contains more than PcdMaximumAsciiStringLength Unicode characters
1084 not including the Null-terminator, then ASSERT().
1086 @param String Pointer to a Null-terminated ASCII string.
1087 @param SearchString Pointer to a Null-terminated ASCII string to search for.
1089 @retval NULL If the SearchString does not appear in String.
1090 @return others If there is a match.
1096 IN CONST CHAR8
*String
,
1097 IN CONST CHAR8
*SearchString
1102 Convert a Null-terminated ASCII decimal string to a value of type
1105 This function returns a value of type UINTN by interpreting the contents
1106 of the ASCII string String as a decimal number. The format of the input
1107 ASCII string String is:
1109 [spaces] [decimal digits].
1111 The valid decimal digit character is in the range [0-9]. The function will
1112 ignore the pad space, which includes spaces or tab characters, before the digits.
1113 The running zero in the beginning of [decimal digits] will be ignored. Then, the
1114 function stops at the first character that is a not a valid decimal character or
1115 Null-terminator, whichever on comes first.
1117 If String has only pad spaces, then 0 is returned.
1118 If String has no pad spaces or valid decimal digits, then 0 is returned.
1119 If the number represented by String overflows according to the range defined by
1120 UINTN, then ASSERT().
1121 If String is NULL, then ASSERT().
1122 If PcdMaximumAsciiStringLength is not zero, and String contains more than
1123 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
1126 @param String Pointer to a Null-terminated ASCII string.
1128 @retval Value translated from String.
1133 AsciiStrDecimalToUintn (
1134 IN CONST CHAR8
*String
1139 Convert a Null-terminated ASCII decimal string to a value of type
1142 This function returns a value of type UINT64 by interpreting the contents
1143 of the ASCII string String as a decimal number. The format of the input
1144 ASCII string String is:
1146 [spaces] [decimal digits].
1148 The valid decimal digit character is in the range [0-9]. The function will
1149 ignore the pad space, which includes spaces or tab characters, before the digits.
1150 The running zero in the beginning of [decimal digits] will be ignored. Then, the
1151 function stops at the first character that is a not a valid decimal character or
1152 Null-terminator, whichever on comes first.
1154 If String has only pad spaces, then 0 is returned.
1155 If String has no pad spaces or valid decimal digits, then 0 is returned.
1156 If the number represented by String overflows according to the range defined by
1157 UINT64, then ASSERT().
1158 If String is NULL, then ASSERT().
1159 If PcdMaximumAsciiStringLength is not zero, and String contains more than
1160 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
1163 @param String Pointer to a Null-terminated ASCII string.
1165 @retval Value translated from String.
1170 AsciiStrDecimalToUint64 (
1171 IN CONST CHAR8
*String
1176 Convert a Null-terminated ASCII hexadecimal string to a value of type UINTN.
1178 This function returns a value of type UINTN by interpreting the contents of
1179 the ASCII string String as a hexadecimal number. The format of the input ASCII
1182 [spaces][zeros][x][hexadecimal digits].
1184 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
1185 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix. If "x"
1186 appears in the input string, it must be prefixed with at least one 0. The function
1187 will ignore the pad space, which includes spaces or tab characters, before [zeros],
1188 [x] or [hexadecimal digits]. The running zero before [x] or [hexadecimal digits]
1189 will be ignored. Then, the decoding starts after [x] or the first valid hexadecimal
1190 digit. Then, the function stops at the first character that is a not a valid
1191 hexadecimal character or Null-terminator, whichever on comes first.
1193 If String has only pad spaces, then 0 is returned.
1194 If String has no leading pad spaces, leading zeros or valid hexadecimal digits, then
1197 If the number represented by String overflows according to the range defined by UINTN,
1199 If String is NULL, then ASSERT().
1200 If PcdMaximumAsciiStringLength is not zero,
1201 and String contains more than PcdMaximumAsciiStringLength ASCII characters not including
1202 the Null-terminator, then ASSERT().
1204 @param String Pointer to a Null-terminated ASCII string.
1206 @retval Value translated from String.
1211 AsciiStrHexToUintn (
1212 IN CONST CHAR8
*String
1217 Convert a Null-terminated ASCII hexadecimal string to a value of type UINT64.
1219 This function returns a value of type UINT64 by interpreting the contents of
1220 the ASCII string String as a hexadecimal number. The format of the input ASCII
1223 [spaces][zeros][x][hexadecimal digits].
1225 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
1226 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix. If "x"
1227 appears in the input string, it must be prefixed with at least one 0. The function
1228 will ignore the pad space, which includes spaces or tab characters, before [zeros],
1229 [x] or [hexadecimal digits]. The running zero before [x] or [hexadecimal digits]
1230 will be ignored. Then, the decoding starts after [x] or the first valid hexadecimal
1231 digit. Then, the function stops at the first character that is a not a valid
1232 hexadecimal character or Null-terminator, whichever on comes first.
1234 If String has only pad spaces, then 0 is returned.
1235 If String has no leading pad spaces, leading zeros or valid hexadecimal digits, then
1238 If the number represented by String overflows according to the range defined by UINT64,
1240 If String is NULL, then ASSERT().
1241 If PcdMaximumAsciiStringLength is not zero,
1242 and String contains more than PcdMaximumAsciiStringLength ASCII characters not including
1243 the Null-terminator, then ASSERT().
1245 @param String Pointer to a Null-terminated ASCII string.
1247 @retval Value translated from String.
1252 AsciiStrHexToUint64 (
1253 IN CONST CHAR8
*String
1258 Convert one Null-terminated ASCII string to a Null-terminated
1259 Unicode string and returns the Unicode string.
1261 This function converts the contents of the ASCII string Source to the Unicode
1262 string Destination, and returns Destination. The function terminates the
1263 Unicode string Destination by appending a Null-terminator character at the end.
1264 The caller is responsible to make sure Destination points to a buffer with size
1265 equal or greater than ((AsciiStrLen (Source) + 1) * sizeof (CHAR16)) in bytes.
1267 If Destination is NULL, then ASSERT().
1268 If Destination is not aligned on a 16-bit boundary, then ASSERT().
1269 If Source is NULL, then ASSERT().
1270 If Source and Destination overlap, then ASSERT().
1271 If PcdMaximumAsciiStringLength is not zero, and Source contains more than
1272 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
1274 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
1275 PcdMaximumUnicodeStringLength ASCII characters not including the
1276 Null-terminator, then ASSERT().
1278 @param Source Pointer to a Null-terminated ASCII string.
1279 @param Destination Pointer to a Null-terminated Unicode string.
1286 AsciiStrToUnicodeStr (
1287 IN CONST CHAR8
*Source
,
1288 OUT CHAR16
*Destination
1293 Converts an 8-bit value to an 8-bit BCD value.
1295 Converts the 8-bit value specified by Value to BCD. The BCD value is
1298 If Value >= 100, then ASSERT().
1300 @param Value The 8-bit value to convert to BCD. Range 0..99.
1302 @return The BCD value
1313 Converts an 8-bit BCD value to an 8-bit value.
1315 Converts the 8-bit BCD value specified by Value to an 8-bit value. The 8-bit
1318 If Value >= 0xA0, then ASSERT().
1319 If (Value & 0x0F) >= 0x0A, then ASSERT().
1321 @param Value The 8-bit BCD value to convert to an 8-bit value.
1323 @return The 8-bit value is returned.
1334 // Linked List Functions and Macros
1338 Initializes the head node of a doubly linked list that is declared as a
1339 global variable in a module.
1341 Initializes the forward and backward links of a new linked list. After
1342 initializing a linked list with this macro, the other linked list functions
1343 may be used to add and remove nodes from the linked list. This macro results
1344 in smaller executables by initializing the linked list in the data section,
1345 instead if calling the InitializeListHead() function to perform the
1346 equivalent operation.
1348 @param ListHead The head note of a list to initiailize.
1351 #define INITIALIZE_LIST_HEAD_VARIABLE(ListHead) {&ListHead, &ListHead}
1355 Initializes the head node of a doubly linked list, and returns the pointer to
1356 the head node of the doubly linked list.
1358 Initializes the forward and backward links of a new linked list. After
1359 initializing a linked list with this function, the other linked list
1360 functions may be used to add and remove nodes from the linked list. It is up
1361 to the caller of this function to allocate the memory for ListHead.
1363 If ListHead is NULL, then ASSERT().
1365 @param ListHead A pointer to the head node of a new doubly linked list.
1372 InitializeListHead (
1373 IN OUT LIST_ENTRY
*ListHead
1378 Adds a node to the beginning of a doubly linked list, and returns the pointer
1379 to the head node of the doubly linked list.
1381 Adds the node Entry at the beginning of the doubly linked list denoted by
1382 ListHead, and returns ListHead.
1384 If ListHead is NULL, then ASSERT().
1385 If Entry is NULL, then ASSERT().
1386 If ListHead was not initialized with InitializeListHead(), then ASSERT().
1387 If PcdMaximumLinkedListLenth is not zero, and prior to insertion the number
1388 of nodes in ListHead, including the ListHead node, is greater than or
1389 equal to PcdMaximumLinkedListLength, then ASSERT().
1391 @param ListHead A pointer to the head node of a doubly linked list.
1392 @param Entry A pointer to a node that is to be inserted at the beginning
1393 of a doubly linked list.
1401 IN OUT LIST_ENTRY
*ListHead
,
1402 IN OUT LIST_ENTRY
*Entry
1407 Adds a node to the end of a doubly linked list, and returns the pointer to
1408 the head node of the doubly linked list.
1410 Adds the node Entry to the end of the doubly linked list denoted by ListHead,
1411 and returns ListHead.
1413 If ListHead is NULL, then ASSERT().
1414 If Entry is NULL, then ASSERT().
1415 If ListHead was not initialized with InitializeListHead(), then ASSERT().
1416 If PcdMaximumLinkedListLenth is not zero, and prior to insertion the number
1417 of nodes in ListHead, including the ListHead node, is greater than or
1418 equal to PcdMaximumLinkedListLength, then ASSERT().
1420 @param ListHead A pointer to the head node of a doubly linked list.
1421 @param Entry A pointer to a node that is to be added at the end of the
1430 IN OUT LIST_ENTRY
*ListHead
,
1431 IN OUT LIST_ENTRY
*Entry
1436 Retrieves the first node of a doubly linked list.
1438 Returns the first node of a doubly linked list. List must have been
1439 initialized with InitializeListHead(). If List is empty, then NULL is
1442 If List is NULL, then ASSERT().
1443 If List was not initialized with InitializeListHead(), then ASSERT().
1444 If PcdMaximumLinkedListLenth is not zero, and the number of nodes
1445 in List, including the List node, is greater than or equal to
1446 PcdMaximumLinkedListLength, then ASSERT().
1448 @param List A pointer to the head node of a doubly linked list.
1450 @return The first node of a doubly linked list.
1451 @retval NULL The list is empty.
1457 IN CONST LIST_ENTRY
*List
1462 Retrieves the next node of a doubly linked list.
1464 Returns the node of a doubly linked list that follows Node. List must have
1465 been initialized with InitializeListHead(). If List is empty, then List is
1468 If List is NULL, then ASSERT().
1469 If Node is NULL, then ASSERT().
1470 If List was not initialized with InitializeListHead(), then ASSERT().
1471 If PcdMaximumLinkedListLenth is not zero, and List contains more than
1472 PcdMaximumLinkedListLenth nodes, then ASSERT().
1473 If Node is not a node in List, then ASSERT().
1475 @param List A pointer to the head node of a doubly linked list.
1476 @param Node A pointer to a node in the doubly linked list.
1478 @return Pointer to the next node if one exists. Otherwise a null value which
1479 is actually List is returned.
1485 IN CONST LIST_ENTRY
*List
,
1486 IN CONST LIST_ENTRY
*Node
1491 Checks to see if a doubly linked list is empty or not.
1493 Checks to see if the doubly linked list is empty. If the linked list contains
1494 zero nodes, this function returns TRUE. Otherwise, it returns FALSE.
1496 If ListHead is NULL, then ASSERT().
1497 If ListHead was not initialized with InitializeListHead(), then ASSERT().
1498 If PcdMaximumLinkedListLenth is not zero, and the number of nodes
1499 in List, including the List node, is greater than or equal to
1500 PcdMaximumLinkedListLength, then ASSERT().
1502 @param ListHead A pointer to the head node of a doubly linked list.
1504 @retval TRUE The linked list is empty.
1505 @retval FALSE The linked list is not empty.
1511 IN CONST LIST_ENTRY
*ListHead
1516 Determines if a node in a doubly linked list is the head node of a the same
1517 doubly linked list. This function is typically used to terminate a loop that
1518 traverses all the nodes in a doubly linked list starting with the head node.
1520 Returns TRUE if Node is equal to List. Returns FALSE if Node is one of the
1521 nodes in the doubly linked list specified by List. List must have been
1522 initialized with InitializeListHead().
1524 If List is NULL, then ASSERT().
1525 If Node is NULL, then ASSERT().
1526 If List was not initialized with InitializeListHead(), then ASSERT().
1527 If PcdMaximumLinkedListLenth is not zero, and the number of nodes
1528 in List, including the List node, is greater than or equal to
1529 PcdMaximumLinkedListLength, then ASSERT().
1530 If Node is not a node in List and Node is not equal to List, then ASSERT().
1532 @param List A pointer to the head node of a doubly linked list.
1533 @param Node A pointer to a node in the doubly linked list.
1535 @retval TRUE Node is one of the nodes in the doubly linked list.
1536 @retval FALSE Node is not one of the nodes in the doubly linked list.
1542 IN CONST LIST_ENTRY
*List
,
1543 IN CONST LIST_ENTRY
*Node
1548 Determines if a node the last node in a doubly linked list.
1550 Returns TRUE if Node is the last node in the doubly linked list specified by
1551 List. Otherwise, FALSE is returned. List must have been initialized with
1552 InitializeListHead().
1554 If List is NULL, then ASSERT().
1555 If Node is NULL, then ASSERT().
1556 If List was not initialized with InitializeListHead(), then ASSERT().
1557 If PcdMaximumLinkedListLenth is not zero, and the number of nodes
1558 in List, including the List node, is greater than or equal to
1559 PcdMaximumLinkedListLength, then ASSERT().
1560 If Node is not a node in List, then ASSERT().
1562 @param List A pointer to the head node of a doubly linked list.
1563 @param Node A pointer to a node in the doubly linked list.
1565 @retval TRUE Node is the last node in the linked list.
1566 @retval FALSE Node is not the last node in the linked list.
1572 IN CONST LIST_ENTRY
*List
,
1573 IN CONST LIST_ENTRY
*Node
1578 Swaps the location of two nodes in a doubly linked list, and returns the
1579 first node after the swap.
1581 If FirstEntry is identical to SecondEntry, then SecondEntry is returned.
1582 Otherwise, the location of the FirstEntry node is swapped with the location
1583 of the SecondEntry node in a doubly linked list. SecondEntry must be in the
1584 same double linked list as FirstEntry and that double linked list must have
1585 been initialized with InitializeListHead(). SecondEntry is returned after the
1588 If FirstEntry is NULL, then ASSERT().
1589 If SecondEntry is NULL, then ASSERT().
1590 If SecondEntry and FirstEntry are not in the same linked list, then ASSERT().
1591 If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
1592 linked list containing the FirstEntry and SecondEntry nodes, including
1593 the FirstEntry and SecondEntry nodes, is greater than or equal to
1594 PcdMaximumLinkedListLength, then ASSERT().
1596 @param FirstEntry A pointer to a node in a linked list.
1597 @param SecondEntry A pointer to another node in the same linked list.
1605 IN OUT LIST_ENTRY
*FirstEntry
,
1606 IN OUT LIST_ENTRY
*SecondEntry
1611 Removes a node from a doubly linked list, and returns the node that follows
1614 Removes the node Entry from a doubly linked list. It is up to the caller of
1615 this function to release the memory used by this node if that is required. On
1616 exit, the node following Entry in the doubly linked list is returned. If
1617 Entry is the only node in the linked list, then the head node of the linked
1620 If Entry is NULL, then ASSERT().
1621 If Entry is the head node of an empty list, then ASSERT().
1622 If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
1623 linked list containing Entry, including the Entry node, is greater than
1624 or equal to PcdMaximumLinkedListLength, then ASSERT().
1626 @param Entry A pointer to a node in a linked list
1634 IN CONST LIST_ENTRY
*Entry
1642 Shifts a 64-bit integer left between 0 and 63 bits. The low bits are filled
1643 with zeros. The shifted value is returned.
1645 This function shifts the 64-bit value Operand to the left by Count bits. The
1646 low Count bits are set to zero. The shifted value is returned.
1648 If Count is greater than 63, then ASSERT().
1650 @param Operand The 64-bit operand to shift left.
1651 @param Count The number of bits to shift left.
1653 @return Operand << Count
1665 Shifts a 64-bit integer right between 0 and 63 bits. This high bits are
1666 filled with zeros. The shifted value is returned.
1668 This function shifts the 64-bit value Operand to the right by Count bits. The
1669 high Count bits are set to zero. The shifted value is returned.
1671 If Count is greater than 63, then ASSERT().
1673 @param Operand The 64-bit operand to shift right.
1674 @param Count The number of bits to shift right.
1676 @return Operand >> Count
1688 Shifts a 64-bit integer right between 0 and 63 bits. The high bits are filled
1689 with original integer's bit 63. The shifted value is returned.
1691 This function shifts the 64-bit value Operand to the right by Count bits. The
1692 high Count bits are set to bit 63 of Operand. The shifted value is returned.
1694 If Count is greater than 63, then ASSERT().
1696 @param Operand The 64-bit operand to shift right.
1697 @param Count The number of bits to shift right.
1699 @return Operand >> Count
1711 Rotates a 32-bit integer left between 0 and 31 bits, filling the low bits
1712 with the high bits that were rotated.
1714 This function rotates the 32-bit value Operand to the left by Count bits. The
1715 low Count bits are fill with the high Count bits of Operand. The rotated
1718 If Count is greater than 31, then ASSERT().
1720 @param Operand The 32-bit operand to rotate left.
1721 @param Count The number of bits to rotate left.
1723 @return Operand <<< Count
1735 Rotates a 32-bit integer right between 0 and 31 bits, filling the high bits
1736 with the low bits that were rotated.
1738 This function rotates the 32-bit value Operand to the right by Count bits.
1739 The high Count bits are fill with the low Count bits of Operand. The rotated
1742 If Count is greater than 31, then ASSERT().
1744 @param Operand The 32-bit operand to rotate right.
1745 @param Count The number of bits to rotate right.
1747 @return Operand >>> Count
1759 Rotates a 64-bit integer left between 0 and 63 bits, filling the low bits
1760 with the high bits that were rotated.
1762 This function rotates the 64-bit value Operand to the left by Count bits. The
1763 low Count bits are fill with the high Count bits of Operand. The rotated
1766 If Count is greater than 63, then ASSERT().
1768 @param Operand The 64-bit operand to rotate left.
1769 @param Count The number of bits to rotate left.
1771 @return Operand <<< Count
1783 Rotates a 64-bit integer right between 0 and 63 bits, filling the high bits
1784 with the high low bits that were rotated.
1786 This function rotates the 64-bit value Operand to the right by Count bits.
1787 The high Count bits are fill with the low Count bits of Operand. The rotated
1790 If Count is greater than 63, then ASSERT().
1792 @param Operand The 64-bit operand to rotate right.
1793 @param Count The number of bits to rotate right.
1795 @return Operand >>> Count
1807 Returns the bit position of the lowest bit set in a 32-bit value.
1809 This function computes the bit position of the lowest bit set in the 32-bit
1810 value specified by Operand. If Operand is zero, then -1 is returned.
1811 Otherwise, a value between 0 and 31 is returned.
1813 @param Operand The 32-bit operand to evaluate.
1815 @return Position of the lowest bit set in Operand if found.
1816 @retval -1 Operand is zero.
1827 Returns the bit position of the lowest bit set in a 64-bit value.
1829 This function computes the bit position of the lowest bit set in the 64-bit
1830 value specified by Operand. If Operand is zero, then -1 is returned.
1831 Otherwise, a value between 0 and 63 is returned.
1833 @param Operand The 64-bit operand to evaluate.
1835 @return Position of the lowest bit set in Operand if found.
1836 @retval -1 Operand is zero.
1847 Returns the bit position of the highest bit set in a 32-bit value. Equivalent
1850 This function computes the bit position of the highest bit set in the 32-bit
1851 value specified by Operand. If Operand is zero, then -1 is returned.
1852 Otherwise, a value between 0 and 31 is returned.
1854 @param Operand The 32-bit operand to evaluate.
1856 @return Position of the highest bit set in Operand if found.
1857 @retval -1 Operand is zero.
1868 Returns the bit position of the highest bit set in a 64-bit value. Equivalent
1871 This function computes the bit position of the highest bit set in the 64-bit
1872 value specified by Operand. If Operand is zero, then -1 is returned.
1873 Otherwise, a value between 0 and 63 is returned.
1875 @param Operand The 64-bit operand to evaluate.
1877 @return Position of the highest bit set in Operand if found.
1878 @retval -1 Operand is zero.
1889 Returns the value of the highest bit set in a 32-bit value. Equivalent to
1890 1 << HighBitSet32(x).
1892 This function computes the value of the highest bit set in the 32-bit value
1893 specified by Operand. If Operand is zero, then zero is returned.
1895 @param Operand The 32-bit operand to evaluate.
1897 @return 1 << HighBitSet32(Operand)
1898 @retval 0 Operand is zero.
1909 Returns the value of the highest bit set in a 64-bit value. Equivalent to
1910 1 << HighBitSet64(x).
1912 This function computes the value of the highest bit set in the 64-bit value
1913 specified by Operand. If Operand is zero, then zero is returned.
1915 @param Operand The 64-bit operand to evaluate.
1917 @return 1 << HighBitSet64(Operand)
1918 @retval 0 Operand is zero.
1929 Switches the endianess of a 16-bit integer.
1931 This function swaps the bytes in a 16-bit unsigned value to switch the value
1932 from little endian to big endian or vice versa. The byte swapped value is
1935 @param Value Operand A 16-bit unsigned value.
1937 @return The byte swaped Operand.
1948 Switches the endianess of a 32-bit integer.
1950 This function swaps the bytes in a 32-bit unsigned value to switch the value
1951 from little endian to big endian or vice versa. The byte swapped value is
1954 @param Value Operand A 32-bit unsigned value.
1956 @return The byte swaped Operand.
1967 Switches the endianess of a 64-bit integer.
1969 This function swaps the bytes in a 64-bit unsigned value to switch the value
1970 from little endian to big endian or vice versa. The byte swapped value is
1973 @param Value Operand A 64-bit unsigned value.
1975 @return The byte swaped Operand.
1986 Multiples a 64-bit unsigned integer by a 32-bit unsigned integer and
1987 generates a 64-bit unsigned result.
1989 This function multiples the 64-bit unsigned value Multiplicand by the 32-bit
1990 unsigned value Multiplier and generates a 64-bit unsigned result. This 64-
1991 bit unsigned result is returned.
1993 If the result overflows, then ASSERT().
1995 @param Multiplicand A 64-bit unsigned value.
1996 @param Multiplier A 32-bit unsigned value.
1998 @return Multiplicand * Multiplier
2004 IN UINT64 Multiplicand
,
2005 IN UINT32 Multiplier
2010 Multiples a 64-bit unsigned integer by a 64-bit unsigned integer and
2011 generates a 64-bit unsigned result.
2013 This function multiples the 64-bit unsigned value Multiplicand by the 64-bit
2014 unsigned value Multiplier and generates a 64-bit unsigned result. This 64-
2015 bit unsigned result is returned.
2017 If the result overflows, then ASSERT().
2019 @param Multiplicand A 64-bit unsigned value.
2020 @param Multiplier A 64-bit unsigned value.
2022 @return Multiplicand * Multiplier
2028 IN UINT64 Multiplicand
,
2029 IN UINT64 Multiplier
2034 Multiples a 64-bit signed integer by a 64-bit signed integer and generates a
2035 64-bit signed result.
2037 This function multiples the 64-bit signed value Multiplicand by the 64-bit
2038 signed value Multiplier and generates a 64-bit signed result. This 64-bit
2039 signed result is returned.
2041 If the result overflows, then ASSERT().
2043 @param Multiplicand A 64-bit signed value.
2044 @param Multiplier A 64-bit signed value.
2046 @return Multiplicand * Multiplier
2052 IN INT64 Multiplicand
,
2058 Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates
2059 a 64-bit unsigned result.
2061 This function divides the 64-bit unsigned value Dividend by the 32-bit
2062 unsigned value Divisor and generates a 64-bit unsigned quotient. This
2063 function returns the 64-bit unsigned quotient.
2065 If Divisor is 0, then ASSERT().
2067 @param Dividend A 64-bit unsigned value.
2068 @param Divisor A 32-bit unsigned value.
2070 @return Dividend / Divisor
2082 Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates
2083 a 32-bit unsigned remainder.
2085 This function divides the 64-bit unsigned value Dividend by the 32-bit
2086 unsigned value Divisor and generates a 32-bit remainder. This function
2087 returns the 32-bit unsigned remainder.
2089 If Divisor is 0, then ASSERT().
2091 @param Dividend A 64-bit unsigned value.
2092 @param Divisor A 32-bit unsigned value.
2094 @return Dividend % Divisor
2106 Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates
2107 a 64-bit unsigned result and an optional 32-bit unsigned remainder.
2109 This function divides the 64-bit unsigned value Dividend by the 32-bit
2110 unsigned value Divisor and generates a 64-bit unsigned quotient. If Remainder
2111 is not NULL, then the 32-bit unsigned remainder is returned in Remainder.
2112 This function returns the 64-bit unsigned quotient.
2114 If Divisor is 0, then ASSERT().
2116 @param Dividend A 64-bit unsigned value.
2117 @param Divisor A 32-bit unsigned value.
2118 @param Remainder A pointer to a 32-bit unsigned value. This parameter is
2119 optional and may be NULL.
2121 @return Dividend / Divisor
2126 DivU64x32Remainder (
2129 OUT UINT32
*Remainder OPTIONAL
2134 Divides a 64-bit unsigned integer by a 64-bit unsigned integer and generates
2135 a 64-bit unsigned result and an optional 64-bit unsigned remainder.
2137 This function divides the 64-bit unsigned value Dividend by the 64-bit
2138 unsigned value Divisor and generates a 64-bit unsigned quotient. If Remainder
2139 is not NULL, then the 64-bit unsigned remainder is returned in Remainder.
2140 This function returns the 64-bit unsigned quotient.
2142 If Divisor is 0, then ASSERT().
2144 @param Dividend A 64-bit unsigned value.
2145 @param Divisor A 64-bit unsigned value.
2146 @param Remainder A pointer to a 64-bit unsigned value. This parameter is
2147 optional and may be NULL.
2149 @return Dividend / Divisor
2154 DivU64x64Remainder (
2157 OUT UINT64
*Remainder OPTIONAL
2162 Divides a 64-bit signed integer by a 64-bit signed integer and generates a
2163 64-bit signed result and a optional 64-bit signed remainder.
2165 This function divides the 64-bit signed value Dividend by the 64-bit signed
2166 value Divisor and generates a 64-bit signed quotient. If Remainder is not
2167 NULL, then the 64-bit signed remainder is returned in Remainder. This
2168 function returns the 64-bit signed quotient.
2170 If Divisor is 0, then ASSERT().
2172 @param Dividend A 64-bit signed value.
2173 @param Divisor A 64-bit signed value.
2174 @param Remainder A pointer to a 64-bit signed value. This parameter is
2175 optional and may be NULL.
2177 @return Dividend / Divisor
2182 DivS64x64Remainder (
2185 OUT INT64
*Remainder OPTIONAL
2190 Reads a 16-bit value from memory that may be unaligned.
2192 This function returns the 16-bit value pointed to by Buffer. The function
2193 guarantees that the read operation does not produce an alignment fault.
2195 If the Buffer is NULL, then ASSERT().
2197 @param Buffer Pointer to a 16-bit value that may be unaligned.
2199 @return The 16-bit value read from Buffer.
2205 IN CONST UINT16
*Buffer
2210 Writes a 16-bit value to memory that may be unaligned.
2212 This function writes the 16-bit value specified by Value to Buffer. Value is
2213 returned. The function guarantees that the write operation does not produce
2216 If the Buffer is NULL, then ASSERT().
2218 @param Buffer Pointer to a 16-bit value that may be unaligned.
2219 @param Value 16-bit value to write to Buffer.
2221 @return The 16-bit value to write to Buffer.
2233 Reads a 24-bit value from memory that may be unaligned.
2235 This function returns the 24-bit value pointed to by Buffer. The function
2236 guarantees that the read operation does not produce an alignment fault.
2238 If the Buffer is NULL, then ASSERT().
2240 @param Buffer Pointer to a 24-bit value that may be unaligned.
2242 @return The 24-bit value read from Buffer.
2248 IN CONST UINT32
*Buffer
2253 Writes a 24-bit value to memory that may be unaligned.
2255 This function writes the 24-bit value specified by Value to Buffer. Value is
2256 returned. The function guarantees that the write operation does not produce
2259 If the Buffer is NULL, then ASSERT().
2261 @param Buffer Pointer to a 24-bit value that may be unaligned.
2262 @param Value 24-bit value to write to Buffer.
2264 @return The 24-bit value to write to Buffer.
2276 Reads a 32-bit value from memory that may be unaligned.
2278 This function returns the 32-bit value pointed to by Buffer. The function
2279 guarantees that the read operation does not produce an alignment fault.
2281 If the Buffer is NULL, then ASSERT().
2283 @param Buffer Pointer to a 32-bit value that may be unaligned.
2285 @return The 32-bit value read from Buffer.
2291 IN CONST UINT32
*Buffer
2296 Writes a 32-bit value to memory that may be unaligned.
2298 This function writes the 32-bit value specified by Value to Buffer. Value is
2299 returned. The function guarantees that the write operation does not produce
2302 If the Buffer is NULL, then ASSERT().
2304 @param Buffer Pointer to a 32-bit value that may be unaligned.
2305 @param Value 32-bit value to write to Buffer.
2307 @return The 32-bit value to write to Buffer.
2319 Reads a 64-bit value from memory that may be unaligned.
2321 This function returns the 64-bit value pointed to by Buffer. The function
2322 guarantees that the read operation does not produce an alignment fault.
2324 If the Buffer is NULL, then ASSERT().
2326 @param Buffer Pointer to a 64-bit value that may be unaligned.
2328 @return The 64-bit value read from Buffer.
2334 IN CONST UINT64
*Buffer
2339 Writes a 64-bit value to memory that may be unaligned.
2341 This function writes the 64-bit value specified by Value to Buffer. Value is
2342 returned. The function guarantees that the write operation does not produce
2345 If the Buffer is NULL, then ASSERT().
2347 @param Buffer Pointer to a 64-bit value that may be unaligned.
2348 @param Value 64-bit value to write to Buffer.
2350 @return The 64-bit value to write to Buffer.
2362 // Bit Field Functions
2366 Returns a bit field from an 8-bit value.
2368 Returns the bitfield specified by the StartBit and the EndBit from Operand.
2370 If 8-bit operations are not supported, then ASSERT().
2371 If StartBit is greater than 7, then ASSERT().
2372 If EndBit is greater than 7, then ASSERT().
2373 If EndBit is less than StartBit, then ASSERT().
2375 @param Operand Operand on which to perform the bitfield operation.
2376 @param StartBit The ordinal of the least significant bit in the bit field.
2378 @param EndBit The ordinal of the most significant bit in the bit field.
2381 @return The bit field read.
2394 Writes a bit field to an 8-bit value, and returns the result.
2396 Writes Value to the bit field specified by the StartBit and the EndBit in
2397 Operand. All other bits in Operand are preserved. The new 8-bit value is
2400 If 8-bit operations are not supported, then ASSERT().
2401 If StartBit is greater than 7, then ASSERT().
2402 If EndBit is greater than 7, then ASSERT().
2403 If EndBit is less than StartBit, then ASSERT().
2405 @param Operand Operand on which to perform the bitfield operation.
2406 @param StartBit The ordinal of the least significant bit in the bit field.
2408 @param EndBit The ordinal of the most significant bit in the bit field.
2410 @param Value New value of the bit field.
2412 @return The new 8-bit value.
2426 Reads a bit field from an 8-bit value, performs a bitwise OR, and returns the
2429 Performs a bitwise inclusive OR between the bit field specified by StartBit
2430 and EndBit in Operand and the value specified by OrData. All other bits in
2431 Operand are preserved. The new 8-bit value is returned.
2433 If 8-bit operations are not supported, then ASSERT().
2434 If StartBit is greater than 7, then ASSERT().
2435 If EndBit is greater than 7, then ASSERT().
2436 If EndBit is less than StartBit, then ASSERT().
2438 @param Operand Operand on which to perform the bitfield operation.
2439 @param StartBit The ordinal of the least significant bit in the bit field.
2441 @param EndBit The ordinal of the most significant bit in the bit field.
2443 @param OrData The value to OR with the read value from the value
2445 @return The new 8-bit value.
2459 Reads a bit field from an 8-bit value, performs a bitwise AND, and returns
2462 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2463 in Operand and the value specified by AndData. All other bits in Operand are
2464 preserved. The new 8-bit value is returned.
2466 If 8-bit operations are not supported, then ASSERT().
2467 If StartBit is greater than 7, then ASSERT().
2468 If EndBit is greater than 7, then ASSERT().
2469 If EndBit is less than StartBit, then ASSERT().
2471 @param Operand Operand on which to perform the bitfield operation.
2472 @param StartBit The ordinal of the least significant bit in the bit field.
2474 @param EndBit The ordinal of the most significant bit in the bit field.
2476 @param AndData The value to AND with the read value from the value.
2478 @return The new 8-bit value.
2492 Reads a bit field from an 8-bit value, performs a bitwise AND followed by a
2493 bitwise OR, and returns the result.
2495 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2496 in Operand and the value specified by AndData, followed by a bitwise
2497 inclusive OR with value specified by OrData. All other bits in Operand are
2498 preserved. The new 8-bit value is returned.
2500 If 8-bit operations are not supported, then ASSERT().
2501 If StartBit is greater than 7, then ASSERT().
2502 If EndBit is greater than 7, then ASSERT().
2503 If EndBit is less than StartBit, then ASSERT().
2505 @param Operand Operand on which to perform the bitfield operation.
2506 @param StartBit The ordinal of the least significant bit in the bit field.
2508 @param EndBit The ordinal of the most significant bit in the bit field.
2510 @param AndData The value to AND with the read value from the value.
2511 @param OrData The value to OR with the result of the AND operation.
2513 @return The new 8-bit value.
2518 BitFieldAndThenOr8 (
2528 Returns a bit field from a 16-bit value.
2530 Returns the bitfield specified by the StartBit and the EndBit from Operand.
2532 If 16-bit operations are not supported, then ASSERT().
2533 If StartBit is greater than 15, then ASSERT().
2534 If EndBit is greater than 15, then ASSERT().
2535 If EndBit is less than StartBit, then ASSERT().
2537 @param Operand Operand on which to perform the bitfield operation.
2538 @param StartBit The ordinal of the least significant bit in the bit field.
2540 @param EndBit The ordinal of the most significant bit in the bit field.
2543 @return The bit field read.
2556 Writes a bit field to a 16-bit value, and returns the result.
2558 Writes Value to the bit field specified by the StartBit and the EndBit in
2559 Operand. All other bits in Operand are preserved. The new 16-bit value is
2562 If 16-bit operations are not supported, then ASSERT().
2563 If StartBit is greater than 15, then ASSERT().
2564 If EndBit is greater than 15, then ASSERT().
2565 If EndBit is less than StartBit, then ASSERT().
2567 @param Operand Operand on which to perform the bitfield operation.
2568 @param StartBit The ordinal of the least significant bit in the bit field.
2570 @param EndBit The ordinal of the most significant bit in the bit field.
2572 @param Value New value of the bit field.
2574 @return The new 16-bit value.
2588 Reads a bit field from a 16-bit value, performs a bitwise OR, and returns the
2591 Performs a bitwise inclusive OR between the bit field specified by StartBit
2592 and EndBit in Operand and the value specified by OrData. All other bits in
2593 Operand are preserved. The new 16-bit value is returned.
2595 If 16-bit operations are not supported, then ASSERT().
2596 If StartBit is greater than 15, then ASSERT().
2597 If EndBit is greater than 15, then ASSERT().
2598 If EndBit is less than StartBit, then ASSERT().
2600 @param Operand Operand on which to perform the bitfield operation.
2601 @param StartBit The ordinal of the least significant bit in the bit field.
2603 @param EndBit The ordinal of the most significant bit in the bit field.
2605 @param OrData The value to OR with the read value from the value
2607 @return The new 16-bit value.
2621 Reads a bit field from a 16-bit value, performs a bitwise AND, and returns
2624 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2625 in Operand and the value specified by AndData. All other bits in Operand are
2626 preserved. The new 16-bit value is returned.
2628 If 16-bit operations are not supported, then ASSERT().
2629 If StartBit is greater than 15, then ASSERT().
2630 If EndBit is greater than 15, then ASSERT().
2631 If EndBit is less than StartBit, then ASSERT().
2633 @param Operand Operand on which to perform the bitfield operation.
2634 @param StartBit The ordinal of the least significant bit in the bit field.
2636 @param EndBit The ordinal of the most significant bit in the bit field.
2638 @param AndData The value to AND with the read value from the value
2640 @return The new 16-bit value.
2654 Reads a bit field from a 16-bit value, performs a bitwise AND followed by a
2655 bitwise OR, and returns the result.
2657 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2658 in Operand and the value specified by AndData, followed by a bitwise
2659 inclusive OR with value specified by OrData. All other bits in Operand are
2660 preserved. The new 16-bit value is returned.
2662 If 16-bit operations are not supported, then ASSERT().
2663 If StartBit is greater than 15, then ASSERT().
2664 If EndBit is greater than 15, then ASSERT().
2665 If EndBit is less than StartBit, then ASSERT().
2667 @param Operand Operand on which to perform the bitfield operation.
2668 @param StartBit The ordinal of the least significant bit in the bit field.
2670 @param EndBit The ordinal of the most significant bit in the bit field.
2672 @param AndData The value to AND with the read value from the value.
2673 @param OrData The value to OR with the result of the AND operation.
2675 @return The new 16-bit value.
2680 BitFieldAndThenOr16 (
2690 Returns a bit field from a 32-bit value.
2692 Returns the bitfield specified by the StartBit and the EndBit from Operand.
2694 If 32-bit operations are not supported, then ASSERT().
2695 If StartBit is greater than 31, then ASSERT().
2696 If EndBit is greater than 31, then ASSERT().
2697 If EndBit is less than StartBit, then ASSERT().
2699 @param Operand Operand on which to perform the bitfield operation.
2700 @param StartBit The ordinal of the least significant bit in the bit field.
2702 @param EndBit The ordinal of the most significant bit in the bit field.
2705 @return The bit field read.
2718 Writes a bit field to a 32-bit value, and returns the result.
2720 Writes Value to the bit field specified by the StartBit and the EndBit in
2721 Operand. All other bits in Operand are preserved. The new 32-bit value is
2724 If 32-bit operations are not supported, then ASSERT().
2725 If StartBit is greater than 31, then ASSERT().
2726 If EndBit is greater than 31, then ASSERT().
2727 If EndBit is less than StartBit, then ASSERT().
2729 @param Operand Operand on which to perform the bitfield operation.
2730 @param StartBit The ordinal of the least significant bit in the bit field.
2732 @param EndBit The ordinal of the most significant bit in the bit field.
2734 @param Value New value of the bit field.
2736 @return The new 32-bit value.
2750 Reads a bit field from a 32-bit value, performs a bitwise OR, and returns the
2753 Performs a bitwise inclusive OR between the bit field specified by StartBit
2754 and EndBit in Operand and the value specified by OrData. All other bits in
2755 Operand are preserved. The new 32-bit value is returned.
2757 If 32-bit operations are not supported, then ASSERT().
2758 If StartBit is greater than 31, then ASSERT().
2759 If EndBit is greater than 31, then ASSERT().
2760 If EndBit is less than StartBit, then ASSERT().
2762 @param Operand Operand on which to perform the bitfield operation.
2763 @param StartBit The ordinal of the least significant bit in the bit field.
2765 @param EndBit The ordinal of the most significant bit in the bit field.
2767 @param OrData The value to OR with the read value from the value
2769 @return The new 32-bit value.
2783 Reads a bit field from a 32-bit value, performs a bitwise AND, and returns
2786 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2787 in Operand and the value specified by AndData. All other bits in Operand are
2788 preserved. The new 32-bit value is returned.
2790 If 32-bit operations are not supported, then ASSERT().
2791 If StartBit is greater than 31, then ASSERT().
2792 If EndBit is greater than 31, then ASSERT().
2793 If EndBit is less than StartBit, then ASSERT().
2795 @param Operand Operand on which to perform the bitfield operation.
2796 @param StartBit The ordinal of the least significant bit in the bit field.
2798 @param EndBit The ordinal of the most significant bit in the bit field.
2800 @param AndData The value to AND with the read value from the value
2802 @return The new 32-bit value.
2816 Reads a bit field from a 32-bit value, performs a bitwise AND followed by a
2817 bitwise OR, and returns the result.
2819 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2820 in Operand and the value specified by AndData, followed by a bitwise
2821 inclusive OR with value specified by OrData. All other bits in Operand are
2822 preserved. The new 32-bit value is returned.
2824 If 32-bit operations are not supported, then ASSERT().
2825 If StartBit is greater than 31, then ASSERT().
2826 If EndBit is greater than 31, then ASSERT().
2827 If EndBit is less than StartBit, then ASSERT().
2829 @param Operand Operand on which to perform the bitfield operation.
2830 @param StartBit The ordinal of the least significant bit in the bit field.
2832 @param EndBit The ordinal of the most significant bit in the bit field.
2834 @param AndData The value to AND with the read value from the value.
2835 @param OrData The value to OR with the result of the AND operation.
2837 @return The new 32-bit value.
2842 BitFieldAndThenOr32 (
2852 Returns a bit field from a 64-bit value.
2854 Returns the bitfield specified by the StartBit and the EndBit from Operand.
2856 If 64-bit operations are not supported, then ASSERT().
2857 If StartBit is greater than 63, then ASSERT().
2858 If EndBit is greater than 63, then ASSERT().
2859 If EndBit is less than StartBit, then ASSERT().
2861 @param Operand Operand on which to perform the bitfield operation.
2862 @param StartBit The ordinal of the least significant bit in the bit field.
2864 @param EndBit The ordinal of the most significant bit in the bit field.
2867 @return The bit field read.
2880 Writes a bit field to a 64-bit value, and returns the result.
2882 Writes Value to the bit field specified by the StartBit and the EndBit in
2883 Operand. All other bits in Operand are preserved. The new 64-bit value is
2886 If 64-bit operations are not supported, then ASSERT().
2887 If StartBit is greater than 63, then ASSERT().
2888 If EndBit is greater than 63, then ASSERT().
2889 If EndBit is less than StartBit, then ASSERT().
2891 @param Operand Operand on which to perform the bitfield operation.
2892 @param StartBit The ordinal of the least significant bit in the bit field.
2894 @param EndBit The ordinal of the most significant bit in the bit field.
2896 @param Value New value of the bit field.
2898 @return The new 64-bit value.
2912 Reads a bit field from a 64-bit value, performs a bitwise OR, and returns the
2915 Performs a bitwise inclusive OR between the bit field specified by StartBit
2916 and EndBit in Operand and the value specified by OrData. All other bits in
2917 Operand are preserved. The new 64-bit value is returned.
2919 If 64-bit operations are not supported, then ASSERT().
2920 If StartBit is greater than 63, then ASSERT().
2921 If EndBit is greater than 63, then ASSERT().
2922 If EndBit is less than StartBit, then ASSERT().
2924 @param Operand Operand on which to perform the bitfield operation.
2925 @param StartBit The ordinal of the least significant bit in the bit field.
2927 @param EndBit The ordinal of the most significant bit in the bit field.
2929 @param OrData The value to OR with the read value from the value
2931 @return The new 64-bit value.
2945 Reads a bit field from a 64-bit value, performs a bitwise AND, and returns
2948 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2949 in Operand and the value specified by AndData. All other bits in Operand are
2950 preserved. The new 64-bit value is returned.
2952 If 64-bit operations are not supported, then ASSERT().
2953 If StartBit is greater than 63, then ASSERT().
2954 If EndBit is greater than 63, then ASSERT().
2955 If EndBit is less than StartBit, then ASSERT().
2957 @param Operand Operand on which to perform the bitfield operation.
2958 @param StartBit The ordinal of the least significant bit in the bit field.
2960 @param EndBit The ordinal of the most significant bit in the bit field.
2962 @param AndData The value to AND with the read value from the value
2964 @return The new 64-bit value.
2978 Reads a bit field from a 64-bit value, performs a bitwise AND followed by a
2979 bitwise OR, and returns the result.
2981 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2982 in Operand and the value specified by AndData, followed by a bitwise
2983 inclusive OR with value specified by OrData. All other bits in Operand are
2984 preserved. The new 64-bit value is returned.
2986 If 64-bit operations are not supported, then ASSERT().
2987 If StartBit is greater than 63, then ASSERT().
2988 If EndBit is greater than 63, then ASSERT().
2989 If EndBit is less than StartBit, then ASSERT().
2991 @param Operand Operand on which to perform the bitfield operation.
2992 @param StartBit The ordinal of the least significant bit in the bit field.
2994 @param EndBit The ordinal of the most significant bit in the bit field.
2996 @param AndData The value to AND with the read value from the value.
2997 @param OrData The value to OR with the result of the AND operation.
2999 @return The new 64-bit value.
3004 BitFieldAndThenOr64 (
3014 // Base Library Synchronization Functions
3018 Retrieves the architecture specific spin lock alignment requirements for
3019 optimal spin lock performance.
3021 This function retrieves the spin lock alignment requirements for optimal
3022 performance on a given CPU architecture. The spin lock alignment must be a
3023 power of two and is returned by this function. If there are no alignment
3024 requirements, then 1 must be returned. The spin lock synchronization
3025 functions must function correctly if the spin lock size and alignment values
3026 returned by this function are not used at all. These values are hints to the
3027 consumers of the spin lock synchronization functions to obtain optimal spin
3030 @return The architecture specific spin lock alignment.
3035 GetSpinLockProperties (
3041 Initializes a spin lock to the released state and returns the spin lock.
3043 This function initializes the spin lock specified by SpinLock to the released
3044 state, and returns SpinLock. Optimal performance can be achieved by calling
3045 GetSpinLockProperties() to determine the size and alignment requirements for
3048 If SpinLock is NULL, then ASSERT().
3050 @param SpinLock A pointer to the spin lock to initialize to the released
3053 @return SpinLock in release state.
3058 InitializeSpinLock (
3059 IN SPIN_LOCK
*SpinLock
3064 Waits until a spin lock can be placed in the acquired state.
3066 This function checks the state of the spin lock specified by SpinLock. If
3067 SpinLock is in the released state, then this function places SpinLock in the
3068 acquired state and returns SpinLock. Otherwise, this function waits
3069 indefinitely for the spin lock to be released, and then places it in the
3070 acquired state and returns SpinLock. All state transitions of SpinLock must
3071 be performed using MP safe mechanisms.
3073 If SpinLock is NULL, then ASSERT().
3074 If SpinLock was not initialized with InitializeSpinLock(), then ASSERT().
3075 If PcdSpinLockTimeout is not zero, and SpinLock is can not be acquired in
3076 PcdSpinLockTimeout microseconds, then ASSERT().
3078 @param SpinLock A pointer to the spin lock to place in the acquired state.
3080 @return SpinLock accquired lock.
3086 IN OUT SPIN_LOCK
*SpinLock
3091 Attempts to place a spin lock in the acquired state.
3093 This function checks the state of the spin lock specified by SpinLock. If
3094 SpinLock is in the released state, then this function places SpinLock in the
3095 acquired state and returns TRUE. Otherwise, FALSE is returned. All state
3096 transitions of SpinLock must be performed using MP safe mechanisms.
3098 If SpinLock is NULL, then ASSERT().
3099 If SpinLock was not initialized with InitializeSpinLock(), then ASSERT().
3101 @param SpinLock A pointer to the spin lock to place in the acquired state.
3103 @retval TRUE SpinLock was placed in the acquired state.
3104 @retval FALSE SpinLock could not be acquired.
3109 AcquireSpinLockOrFail (
3110 IN OUT SPIN_LOCK
*SpinLock
3115 Releases a spin lock.
3117 This function places the spin lock specified by SpinLock in the release state
3118 and returns SpinLock.
3120 If SpinLock is NULL, then ASSERT().
3121 If SpinLock was not initialized with InitializeSpinLock(), then ASSERT().
3123 @param SpinLock A pointer to the spin lock to release.
3125 @return SpinLock released lock.
3131 IN OUT SPIN_LOCK
*SpinLock
3136 Performs an atomic increment of an 32-bit unsigned integer.
3138 Performs an atomic increment of the 32-bit unsigned integer specified by
3139 Value and returns the incremented value. The increment operation must be
3140 performed using MP safe mechanisms. The state of the return value is not
3141 guaranteed to be MP safe.
3143 If Value is NULL, then ASSERT().
3145 @param Value A pointer to the 32-bit value to increment.
3147 @return The incremented value.
3152 InterlockedIncrement (
3158 Performs an atomic decrement of an 32-bit unsigned integer.
3160 Performs an atomic decrement of the 32-bit unsigned integer specified by
3161 Value and returns the decremented value. The decrement operation must be
3162 performed using MP safe mechanisms. The state of the return value is not
3163 guaranteed to be MP safe.
3165 If Value is NULL, then ASSERT().
3167 @param Value A pointer to the 32-bit value to decrement.
3169 @return The decremented value.
3174 InterlockedDecrement (
3180 Performs an atomic compare exchange operation on a 32-bit unsigned integer.
3182 Performs an atomic compare exchange operation on the 32-bit unsigned integer
3183 specified by Value. If Value is equal to CompareValue, then Value is set to
3184 ExchangeValue and CompareValue is returned. If Value is not equal to CompareValue,
3185 then Value is returned. The compare exchange operation must be performed using
3188 If Value is NULL, then ASSERT().
3190 @param Value A pointer to the 32-bit value for the compare exchange
3192 @param CompareValue 32-bit value used in compare operation.
3193 @param ExchangeValue 32-bit value used in exchange operation.
3195 @return The original *Value before exchange.
3200 InterlockedCompareExchange32 (
3201 IN OUT UINT32
*Value
,
3202 IN UINT32 CompareValue
,
3203 IN UINT32 ExchangeValue
3208 Performs an atomic compare exchange operation on a 64-bit unsigned integer.
3210 Performs an atomic compare exchange operation on the 64-bit unsigned integer specified
3211 by Value. If Value is equal to CompareValue, then Value is set to ExchangeValue and
3212 CompareValue is returned. If Value is not equal to CompareValue, then Value is returned.
3213 The compare exchange operation must be performed using MP safe mechanisms.
3215 If Value is NULL, then ASSERT().
3217 @param Value A pointer to the 64-bit value for the compare exchange
3219 @param CompareValue 64-bit value used in compare operation.
3220 @param ExchangeValue 64-bit value used in exchange operation.
3222 @return The original *Value before exchange.
3227 InterlockedCompareExchange64 (
3228 IN OUT UINT64
*Value
,
3229 IN UINT64 CompareValue
,
3230 IN UINT64 ExchangeValue
3235 Performs an atomic compare exchange operation on a pointer value.
3237 Performs an atomic compare exchange operation on the pointer value specified
3238 by Value. If Value is equal to CompareValue, then Value is set to
3239 ExchangeValue and CompareValue is returned. If Value is not equal to
3240 CompareValue, then Value is returned. The compare exchange operation must be
3241 performed using MP safe mechanisms.
3243 If Value is NULL, then ASSERT().
3245 @param Value A pointer to the pointer value for the compare exchange
3247 @param CompareValue Pointer value used in compare operation.
3248 @param ExchangeValue Pointer value used in exchange operation.
3250 @return The original *Value before exchange.
3254 InterlockedCompareExchangePointer (
3255 IN OUT VOID
**Value
,
3256 IN VOID
*CompareValue
,
3257 IN VOID
*ExchangeValue
3262 // Base Library Checksum Functions
3266 Calculate the sum of all elements in a buffer in unit of UINT8.
3267 During calculation, the carry bits are dropped.
3269 This function calculates the sum of all elements in a buffer
3270 in unit of UINT8. The carry bits in result of addition are dropped.
3271 The result is returned as UINT8. If Length is Zero, then Zero is
3274 If Buffer is NULL, then ASSERT().
3275 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3277 @param Buffer Pointer to the buffer to carry out the sum operation.
3278 @param Length The size, in bytes, of Buffer .
3280 @return Sum The sum of Buffer with carry bits dropped during additions.
3286 IN CONST UINT8
*Buffer
,
3292 Returns the two's complement checksum of all elements in a buffer
3295 This function first calculates the sum of the 8-bit values in the
3296 buffer specified by Buffer and Length. The carry bits in the result
3297 of addition are dropped. Then, the two's complement of the sum is
3298 returned. If Length is 0, then 0 is returned.
3300 If Buffer is NULL, then ASSERT().
3301 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3303 @param Buffer Pointer to the buffer to carry out the checksum operation.
3304 @param Length The size, in bytes, of Buffer.
3306 @return Checksum The 2's complement checksum of Buffer.
3311 CalculateCheckSum8 (
3312 IN CONST UINT8
*Buffer
,
3318 Returns the sum of all elements in a buffer of 16-bit values. During
3319 calculation, the carry bits are dropped.
3321 This function calculates the sum of the 16-bit values in the buffer
3322 specified by Buffer and Length. The carry bits in result of addition are dropped.
3323 The 16-bit result is returned. If Length is 0, then 0 is returned.
3325 If Buffer is NULL, then ASSERT().
3326 If Buffer is not aligned on a 16-bit boundary, then ASSERT().
3327 If Length is not aligned on a 16-bit boundary, then ASSERT().
3328 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3330 @param Buffer Pointer to the buffer to carry out the sum operation.
3331 @param Length The size, in bytes, of Buffer.
3333 @return Sum The sum of Buffer with carry bits dropped during additions.
3339 IN CONST UINT16
*Buffer
,
3345 Returns the two's complement checksum of all elements in a buffer of
3348 This function first calculates the sum of the 16-bit values in the buffer
3349 specified by Buffer and Length. The carry bits in the result of addition
3350 are dropped. Then, the two's complement of the sum is returned. If Length
3351 is 0, then 0 is returned.
3353 If Buffer is NULL, then ASSERT().
3354 If Buffer is not aligned on a 16-bit boundary, then ASSERT().
3355 If Length is not aligned on a 16-bit boundary, then ASSERT().
3356 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3358 @param Buffer Pointer to the buffer to carry out the checksum operation.
3359 @param Length The size, in bytes, of Buffer.
3361 @return Checksum The 2's complement checksum of Buffer.
3366 CalculateCheckSum16 (
3367 IN CONST UINT16
*Buffer
,
3373 Returns the sum of all elements in a buffer of 32-bit values. During
3374 calculation, the carry bits are dropped.
3376 This function calculates the sum of the 32-bit values in the buffer
3377 specified by Buffer and Length. The carry bits in result of addition are dropped.
3378 The 32-bit result is returned. If Length is 0, then 0 is returned.
3380 If Buffer is NULL, then ASSERT().
3381 If Buffer is not aligned on a 32-bit boundary, then ASSERT().
3382 If Length is not aligned on a 32-bit boundary, then ASSERT().
3383 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3385 @param Buffer Pointer to the buffer to carry out the sum operation.
3386 @param Length The size, in bytes, of Buffer.
3388 @return Sum The sum of Buffer with carry bits dropped during additions.
3394 IN CONST UINT32
*Buffer
,
3400 Returns the two's complement checksum of all elements in a buffer of
3403 This function first calculates the sum of the 32-bit values in the buffer
3404 specified by Buffer and Length. The carry bits in the result of addition
3405 are dropped. Then, the two's complement of the sum is returned. If Length
3406 is 0, then 0 is returned.
3408 If Buffer is NULL, then ASSERT().
3409 If Buffer is not aligned on a 32-bit boundary, then ASSERT().
3410 If Length is not aligned on a 32-bit boundary, then ASSERT().
3411 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3413 @param Buffer Pointer to the buffer to carry out the checksum operation.
3414 @param Length The size, in bytes, of Buffer.
3416 @return Checksum The 2's complement checksum of Buffer.
3421 CalculateCheckSum32 (
3422 IN CONST UINT32
*Buffer
,
3428 Returns the sum of all elements in a buffer of 64-bit values. During
3429 calculation, the carry bits are dropped.
3431 This function calculates the sum of the 64-bit values in the buffer
3432 specified by Buffer and Length. The carry bits in result of addition are dropped.
3433 The 64-bit result is returned. If Length is 0, then 0 is returned.
3435 If Buffer is NULL, then ASSERT().
3436 If Buffer is not aligned on a 64-bit boundary, then ASSERT().
3437 If Length is not aligned on a 64-bit boundary, then ASSERT().
3438 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3440 @param Buffer Pointer to the buffer to carry out the sum operation.
3441 @param Length The size, in bytes, of Buffer.
3443 @return Sum The sum of Buffer with carry bits dropped during additions.
3449 IN CONST UINT64
*Buffer
,
3455 Returns the two's complement checksum of all elements in a buffer of
3458 This function first calculates the sum of the 64-bit values in the buffer
3459 specified by Buffer and Length. The carry bits in the result of addition
3460 are dropped. Then, the two's complement of the sum is returned. If Length
3461 is 0, then 0 is returned.
3463 If Buffer is NULL, then ASSERT().
3464 If Buffer is not aligned on a 64-bit boundary, then ASSERT().
3465 If Length is not aligned on a 64-bit boundary, then ASSERT().
3466 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3468 @param Buffer Pointer to the buffer to carry out the checksum operation.
3469 @param Length The size, in bytes, of Buffer.
3471 @return Checksum The 2's complement checksum of Buffer.
3476 CalculateCheckSum64 (
3477 IN CONST UINT64
*Buffer
,
3483 /// Base Library CPU Functions
3487 (EFIAPI
*SWITCH_STACK_ENTRY_POINT
)(
3488 IN VOID
*Context1
, OPTIONAL
3489 IN VOID
*Context2 OPTIONAL
3494 Used to serialize load and store operations.
3496 All loads and stores that proceed calls to this function are guaranteed to be
3497 globally visible when this function returns.
3508 Saves the current CPU context that can be restored with a call to LongJump()
3511 Saves the current CPU context in the buffer specified by JumpBuffer and
3512 returns 0. The initial call to SetJump() must always return 0. Subsequent
3513 calls to LongJump() cause a non-zero value to be returned by SetJump().
3515 If JumpBuffer is NULL, then ASSERT().
3516 For IPF CPUs, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().
3518 @param JumpBuffer A pointer to CPU context buffer.
3520 @retval 0 Indicates a return from SetJump().
3526 OUT BASE_LIBRARY_JUMP_BUFFER
*JumpBuffer
3531 Restores the CPU context that was saved with SetJump().
3533 Restores the CPU context from the buffer specified by JumpBuffer. This
3534 function never returns to the caller. Instead is resumes execution based on
3535 the state of JumpBuffer.
3537 If JumpBuffer is NULL, then ASSERT().
3538 For IPF CPUs, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().
3539 If Value is 0, then ASSERT().
3541 @param JumpBuffer A pointer to CPU context buffer.
3542 @param Value The value to return when the SetJump() context is
3543 restored and must be non-zero.
3549 IN BASE_LIBRARY_JUMP_BUFFER
*JumpBuffer
,
3555 Enables CPU interrupts.
3566 Disables CPU interrupts.
3577 Disables CPU interrupts and returns the interrupt state prior to the disable
3580 @retval TRUE CPU interrupts were enabled on entry to this call.
3581 @retval FALSE CPU interrupts were disabled on entry to this call.
3586 SaveAndDisableInterrupts (
3592 Enables CPU interrupts for the smallest window required to capture any
3598 EnableDisableInterrupts (
3604 Retrieves the current CPU interrupt state.
3606 Returns TRUE is interrupts are currently enabled. Otherwise
3609 @retval TRUE CPU interrupts are enabled.
3610 @retval FALSE CPU interrupts are disabled.
3621 Set the current CPU interrupt state.
3623 Sets the current CPU interrupt state to the state specified by
3624 InterruptState. If InterruptState is TRUE, then interrupts are enabled. If
3625 InterruptState is FALSE, then interrupts are disabled. InterruptState is
3628 @param InterruptState TRUE if interrupts should enabled. FALSE if
3629 interrupts should be disabled.
3631 @return InterruptState
3637 IN BOOLEAN InterruptState
3642 Requests CPU to pause for a short period of time.
3644 Requests CPU to pause for a short period of time. Typically used in MP
3645 systems to prevent memory starvation while waiting for a spin lock.
3656 Transfers control to a function starting with a new stack.
3658 Transfers control to the function specified by EntryPoint using the
3659 new stack specified by NewStack and passing in the parameters specified
3660 by Context1 and Context2. Context1 and Context2 are optional and may
3661 be NULL. The function EntryPoint must never return. This function
3662 supports a variable number of arguments following the NewStack parameter.
3663 These additional arguments are ignored on IA-32, x64, and EBC.
3664 IPF CPUs expect one additional parameter of type VOID * that specifies
3665 the new backing store pointer.
3667 If EntryPoint is NULL, then ASSERT().
3668 If NewStack is NULL, then ASSERT().
3670 @param EntryPoint A pointer to function to call with the new stack.
3671 @param Context1 A pointer to the context to pass into the EntryPoint
3673 @param Context2 A pointer to the context to pass into the EntryPoint
3675 @param NewStack A pointer to the new stack to use for the EntryPoint
3677 @param ... Extended parameters.
3684 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
3685 IN VOID
*Context1
, OPTIONAL
3686 IN VOID
*Context2
, OPTIONAL
3693 Generates a breakpoint on the CPU.
3695 Generates a breakpoint on the CPU. The breakpoint must be implemented such
3696 that code can resume normal execution after the breakpoint.
3707 Executes an infinite loop.
3709 Forces the CPU to execute an infinite loop. A debugger may be used to skip
3710 past the loop and the code that follows the loop must execute properly. This
3711 implies that the infinite loop must not cause the code that follow it to be
3722 #if defined (MDE_CPU_IPF)
3725 Flush a range of cache lines in the cache coherency domain of the calling
3728 Invalidates the cache lines specified by Address and Length. If Address is
3729 not aligned on a cache line boundary, then entire cache line containing
3730 Address is invalidated. If Address + Length is not aligned on a cache line
3731 boundary, then the entire instruction cache line containing Address + Length
3732 -1 is invalidated. This function may choose to invalidate the entire
3733 instruction cache if that is more efficient than invalidating the specified
3734 range. If Length is 0, the no instruction cache lines are invalidated.
3735 Address is returned.
3737 If Length is greater than (MAX_ADDRESS - Address + 1), then ASSERT().
3739 @param Address The base address of the instruction lines to invalidate. If
3740 the CPU is in a physical addressing mode, then Address is a
3741 physical address. If the CPU is in a virtual addressing mode,
3742 then Address is a virtual address.
3744 @param Length The number of bytes to invalidate from the instruction cache.
3751 IpfFlushCacheRange (
3758 Executes a FC instruction
3759 Executes a FC instruction on the cache line specified by Address.
3760 The cache line size affected is at least 32-bytes (aligned on a 32-byte boundary).
3761 An implementation may flush a larger region. This function is only available on IPF.
3763 @param Address The Address of cache line to be flushed.
3765 @return The address of FC instruction executed.
3776 Executes a FC.I instruction.
3777 Executes a FC.I instruction on the cache line specified by Address.
3778 The cache line size affected is at least 32-bytes (aligned on a 32-byte boundary).
3779 An implementation may flush a larger region. This function is only available on IPF.
3781 @param Address The Address of cache line to be flushed.
3783 @return The address of FC.I instruction executed.
3794 Reads the current value of a Processor Identifier Register (CPUID).
3795 The Index of largest implemented CPUID (One less than the number of implemented CPUID
3796 registers) is determined by CPUID [3] bits {7:0}.
3797 No parameter checking is performed on Index. If the Index value is beyond the
3798 implemented CPUID register range, a Reserved Register/Field fault may occur. The caller
3799 must either guarantee that Index is valid, or the caller must set up fault handlers to
3800 catch the faults. This function is only available on IPF.
3802 @param Index The 8-bit Processor Identifier Register index to read.
3804 @return The current value of Processor Identifier Register specified by Index.
3815 Reads the current value of 64-bit Processor Status Register (PSR).
3816 This function is only available on IPF.
3818 @return The current value of PSR.
3829 Writes the current value of 64-bit Processor Status Register (PSR).
3830 No parameter checking is performed on Value. All bits of Value corresponding to
3831 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.
3832 This function is only available on IPF.
3834 @param Value The 64-bit value to write to PSR.
3836 @return The 64-bit value written to the PSR.
3847 Reads the current value of 64-bit Kernel Register #0 (KR0).
3848 This function is only available on IPF.
3850 @return The current value of KR0.
3861 Reads the current value of 64-bit Kernel Register #1 (KR1).
3862 This function is only available on IPF.
3864 @return The current value of KR1.
3875 Reads the current value of 64-bit Kernel Register #2 (KR2).
3876 This function is only available on IPF.
3878 @return The current value of KR2.
3889 Reads the current value of 64-bit Kernel Register #3 (KR3).
3890 This function is only available on IPF.
3892 @return The current value of KR3.
3903 Reads the current value of 64-bit Kernel Register #4 (KR4).
3904 This function is only available on IPF.
3906 @return The current value of KR4.
3917 Reads the current value of 64-bit Kernel Register #5 (KR5).
3918 This function is only available on IPF.
3920 @return The current value of KR5.
3931 Reads the current value of 64-bit Kernel Register #6 (KR6).
3932 This function is only available on IPF.
3934 @return The current value of KR6.
3945 Reads the current value of 64-bit Kernel Register #7 (KR7).
3946 This function is only available on IPF.
3948 @return The current value of KR7.
3959 Write the current value of 64-bit Kernel Register #0 (KR0).
3960 This function is only available on IPF.
3962 @param Value The 64-bit value to write to KR0.
3964 @return The 64-bit value written to the KR0.
3975 Write the current value of 64-bit Kernel Register #1 (KR1).
3976 This function is only available on IPF.
3978 @param Value The 64-bit value to write to KR1.
3980 @return The 64-bit value written to the KR1.
3991 Write the current value of 64-bit Kernel Register #2 (KR2).
3992 This function is only available on IPF.
3994 @param Value The 64-bit value to write to KR2.
3996 @return The 64-bit value written to the KR2.
4007 Write the current value of 64-bit Kernel Register #3 (KR3).
4008 This function is only available on IPF.
4010 @param Value The 64-bit value to write to KR3.
4012 @return The 64-bit value written to the KR3.
4023 Write the current value of 64-bit Kernel Register #4 (KR4).
4024 This function is only available on IPF.
4026 @param Value The 64-bit value to write to KR4.
4028 @return The 64-bit value written to the KR4.
4039 Write the current value of 64-bit Kernel Register #5 (KR5).
4040 This function is only available on IPF.
4042 @param Value The 64-bit value to write to KR5.
4044 @return The 64-bit value written to the KR5.
4055 Write the current value of 64-bit Kernel Register #6 (KR6).
4056 This function is only available on IPF.
4058 @param Value The 64-bit value to write to KR6.
4060 @return The 64-bit value written to the KR6.
4071 Write the current value of 64-bit Kernel Register #7 (KR7).
4072 This function is only available on IPF.
4074 @param Value The 64-bit value to write to KR7.
4076 @return The 64-bit value written to the KR7.
4087 Reads the current value of Interval Timer Counter Register (ITC).
4088 This function is only available on IPF.
4090 @return The current value of ITC.
4101 Reads the current value of Interval Timer Vector Register (ITV).
4102 This function is only available on IPF.
4104 @return The current value of ITV.
4115 Reads the current value of Interval Timer Match Register (ITM).
4116 This function is only available on IPF.
4118 @return The current value of ITM.
4128 Writes the current value of 64-bit Interval Timer Counter Register (ITC).
4129 This function is only available on IPF.
4131 @param Value The 64-bit value to write to ITC.
4133 @return The 64-bit value written to the ITC.
4144 Writes the current value of 64-bit Interval Timer Match Register (ITM).
4145 This function is only available on IPF.
4147 @param Value The 64-bit value to write to ITM.
4149 @return The 64-bit value written to the ITM.
4160 Writes the current value of 64-bit Interval Timer Vector Register (ITV).
4161 No parameter checking is performed on Value. All bits of Value corresponding to
4162 reserved fields of ITV must be 0 or a Reserved Register/Field fault may occur.
4163 The caller must either guarantee that Value is valid, or the caller must set up
4164 fault handlers to catch the faults.
4165 This function is only available on IPF.
4167 @param Value The 64-bit value to write to ITV.
4169 @return The 64-bit value written to the ITV.
4180 Reads the current value of Default Control Register (DCR).
4181 This function is only available on IPF.
4183 @return The current value of DCR.
4194 Reads the current value of Interruption Vector Address Register (IVA).
4195 This function is only available on IPF.
4197 @return The current value of IVA.
4207 Reads the current value of Page Table Address Register (PTA).
4208 This function is only available on IPF.
4210 @return The current value of PTA.
4221 Writes the current value of 64-bit Default Control Register (DCR).
4222 No parameter checking is performed on Value. All bits of Value corresponding to
4223 reserved fields of DCR must be 0 or a Reserved Register/Field fault may occur.
4224 The caller must either guarantee that Value is valid, or the caller must set up
4225 fault handlers to catch the faults.
4226 This function is only available on IPF.
4228 @param Value The 64-bit value to write to DCR.
4230 @return The 64-bit value written to the DCR.
4241 Writes the current value of 64-bit Interruption Vector Address Register (IVA).
4242 The size of vector table is 32 K bytes and is 32 K bytes aligned
4243 the low 15 bits of Value is ignored when written.
4244 This function is only available on IPF.
4246 @param Value The 64-bit value to write to IVA.
4248 @return The 64-bit value written to the IVA.
4259 Writes the current value of 64-bit Page Table Address Register (PTA).
4260 No parameter checking is performed on Value. All bits of Value corresponding to
4261 reserved fields of DCR must be 0 or a Reserved Register/Field fault may occur.
4262 The caller must either guarantee that Value is valid, or the caller must set up
4263 fault handlers to catch the faults.
4264 This function is only available on IPF.
4266 @param Value The 64-bit value to write to PTA.
4268 @return The 64-bit value written to the PTA.
4278 Reads the current value of Local Interrupt ID Register (LID).
4279 This function is only available on IPF.
4281 @return The current value of LID.
4292 Reads the current value of External Interrupt Vector Register (IVR).
4293 This function is only available on IPF.
4295 @return The current value of IVR.
4306 Reads the current value of Task Priority Register (TPR).
4307 This function is only available on IPF.
4309 @return The current value of TPR.
4320 Reads the current value of External Interrupt Request Register #0 (IRR0).
4321 This function is only available on IPF.
4323 @return The current value of IRR0.
4334 Reads the current value of External Interrupt Request Register #1 (IRR1).
4335 This function is only available on IPF.
4337 @return The current value of IRR1.
4348 Reads the current value of External Interrupt Request Register #2 (IRR2).
4349 This function is only available on IPF.
4351 @return The current value of IRR2.
4362 Reads the current value of External Interrupt Request Register #3 (IRR3).
4363 This function is only available on IPF.
4365 @return The current value of IRR3.
4376 Reads the current value of Performance Monitor Vector Register (PMV).
4377 This function is only available on IPF.
4379 @return The current value of PMV.
4390 Reads the current value of Corrected Machine Check Vector Register (CMCV).
4391 This function is only available on IPF.
4393 @return The current value of CMCV.
4404 Reads the current value of Local Redirection Register #0 (LRR0).
4405 This function is only available on IPF.
4407 @return The current value of LRR0.
4418 Reads the current value of Local Redirection Register #1 (LRR1).
4419 This function is only available on IPF.
4421 @return The current value of LRR1.
4432 Writes the current value of 64-bit Page Local Interrupt ID Register (LID).
4433 No parameter checking is performed on Value. All bits of Value corresponding to
4434 reserved fields of LID must be 0 or a Reserved Register/Field fault may occur.
4435 The caller must either guarantee that Value is valid, or the caller must set up
4436 fault handlers to catch the faults.
4437 This function is only available on IPF.
4439 @param Value The 64-bit value to write to LID.
4441 @return The 64-bit value written to the LID.
4452 Writes the current value of 64-bit Task Priority Register (TPR).
4453 No parameter checking is performed on Value. All bits of Value corresponding to
4454 reserved fields of TPR must be 0 or a Reserved Register/Field fault may occur.
4455 The caller must either guarantee that Value is valid, or the caller must set up
4456 fault handlers to catch the faults.
4457 This function is only available on IPF.
4459 @param Value The 64-bit value to write to TPR.
4461 @return The 64-bit value written to the TPR.
4472 Performs a write operation on End OF External Interrupt Register (EOI).
4473 Writes a value of 0 to the EOI Register. This function is only available on IPF.
4484 Writes the current value of 64-bit Performance Monitor Vector Register (PMV).
4485 No parameter checking is performed on Value. All bits of Value corresponding
4486 to reserved fields of PMV must be 0 or a Reserved Register/Field fault may occur.
4487 The caller must either guarantee that Value is valid, or the caller must set up
4488 fault handlers to catch the faults.
4489 This function is only available on IPF.
4491 @param Value The 64-bit value to write to PMV.
4493 @return The 64-bit value written to the PMV.
4504 Writes the current value of 64-bit Corrected Machine Check Vector Register (CMCV).
4505 No parameter checking is performed on Value. All bits of Value corresponding
4506 to reserved fields of CMCV must be 0 or a Reserved Register/Field fault may occur.
4507 The caller must either guarantee that Value is valid, or the caller must set up
4508 fault handlers to catch the faults.
4509 This function is only available on IPF.
4511 @param Value The 64-bit value to write to CMCV.
4513 @return The 64-bit value written to the CMCV.
4524 Writes the current value of 64-bit Local Redirection Register #0 (LRR0).
4525 No parameter checking is performed on Value. All bits of Value corresponding
4526 to reserved fields of LRR0 must be 0 or a Reserved Register/Field fault may occur.
4527 The caller must either guarantee that Value is valid, or the caller must set up
4528 fault handlers to catch the faults.
4529 This function is only available on IPF.
4531 @param Value The 64-bit value to write to LRR0.
4533 @return The 64-bit value written to the LRR0.
4544 Writes the current value of 64-bit Local Redirection Register #1 (LRR1).
4545 No parameter checking is performed on Value. All bits of Value corresponding
4546 to reserved fields of LRR1 must be 0 or a Reserved Register/Field fault may occur.
4547 The caller must either guarantee that Value is valid, or the caller must
4548 set up fault handlers to catch the faults.
4549 This function is only available on IPF.
4551 @param Value The 64-bit value to write to LRR1.
4553 @return The 64-bit value written to the LRR1.
4564 Reads the current value of Instruction Breakpoint Register (IBR).
4566 The Instruction Breakpoint Registers are used in pairs. The even numbered
4567 registers contain breakpoint addresses, and the odd numbered registers contain
4568 breakpoint mask conditions. At least 4 instruction registers pairs are implemented
4569 on all processor models. Implemented registers are contiguous starting with
4570 register 0. No parameter checking is performed on Index, and if the Index value
4571 is beyond the implemented IBR register range, a Reserved Register/Field fault may
4572 occur. The caller must either guarantee that Index is valid, or the caller must
4573 set up fault handlers to catch the faults.
4574 This function is only available on IPF.
4576 @param Index The 8-bit Instruction Breakpoint Register index to read.
4578 @return The current value of Instruction Breakpoint Register specified by Index.
4589 Reads the current value of Data Breakpoint Register (DBR).
4591 The Data Breakpoint Registers are used in pairs. The even numbered registers
4592 contain breakpoint addresses, and odd numbered registers contain breakpoint
4593 mask conditions. At least 4 data registers pairs are implemented on all processor
4594 models. Implemented registers are contiguous starting with register 0.
4595 No parameter checking is performed on Index. If the Index value is beyond
4596 the implemented DBR register range, a Reserved Register/Field fault may occur.
4597 The caller must either guarantee that Index is valid, or the caller must set up
4598 fault handlers to catch the faults.
4599 This function is only available on IPF.
4601 @param Index The 8-bit Data Breakpoint Register index to read.
4603 @return The current value of Data Breakpoint Register specified by Index.
4614 Reads the current value of Performance Monitor Configuration Register (PMC).
4616 All processor implementations provide at least 4 performance counters
4617 (PMC/PMD [4]...PMC/PMD [7] pairs), and 4 performance monitor counter overflow
4618 status registers (PMC [0]... PMC [3]). Processor implementations may provide
4619 additional implementation-dependent PMC and PMD to increase the number of
4620 'generic' performance counters (PMC/PMD pairs). The remainder of PMC and PMD
4621 register set is implementation dependent. No parameter checking is performed
4622 on Index. If the Index value is beyond the implemented PMC register range,
4623 zero value will be returned.
4624 This function is only available on IPF.
4626 @param Index The 8-bit Performance Monitor Configuration Register index to read.
4628 @return The current value of Performance Monitor Configuration Register
4640 Reads the current value of Performance Monitor Data Register (PMD).
4642 All processor implementations provide at least 4 performance counters
4643 (PMC/PMD [4]...PMC/PMD [7] pairs), and 4 performance monitor counter
4644 overflow status registers (PMC [0]... PMC [3]). Processor implementations may
4645 provide additional implementation-dependent PMC and PMD to increase the number
4646 of 'generic' performance counters (PMC/PMD pairs). The remainder of PMC and PMD
4647 register set is implementation dependent. No parameter checking is performed
4648 on Index. If the Index value is beyond the implemented PMD register range,
4649 zero value will be returned.
4650 This function is only available on IPF.
4652 @param Index The 8-bit Performance Monitor Data Register index to read.
4654 @return The current value of Performance Monitor Data Register specified by Index.
4665 Writes the current value of 64-bit Instruction Breakpoint Register (IBR).
4667 Writes current value of Instruction Breakpoint Register specified by Index.
4668 The Instruction Breakpoint Registers are used in pairs. The even numbered
4669 registers contain breakpoint addresses, and odd numbered registers contain
4670 breakpoint mask conditions. At least 4 instruction registers pairs are implemented
4671 on all processor models. Implemented registers are contiguous starting with
4672 register 0. No parameter checking is performed on Index. If the Index value
4673 is beyond the implemented IBR register range, a Reserved Register/Field fault may
4674 occur. The caller must either guarantee that Index is valid, or the caller must
4675 set up fault handlers to catch the faults.
4676 This function is only available on IPF.
4678 @param Index The 8-bit Instruction Breakpoint Register index to write.
4679 @param Value The 64-bit value to write to IBR.
4681 @return The 64-bit value written to the IBR.
4693 Writes the current value of 64-bit Data Breakpoint Register (DBR).
4695 Writes current value of Data Breakpoint Register specified by Index.
4696 The Data Breakpoint Registers are used in pairs. The even numbered registers
4697 contain breakpoint addresses, and odd numbered registers contain breakpoint
4698 mask conditions. At least 4 data registers pairs are implemented on all processor
4699 models. Implemented registers are contiguous starting with register 0. No parameter
4700 checking is performed on Index. If the Index value is beyond the implemented
4701 DBR register range, a Reserved Register/Field fault may occur. The caller must
4702 either guarantee that Index is valid, or the caller must set up fault handlers to
4704 This function is only available on IPF.
4706 @param Index The 8-bit Data Breakpoint Register index to write.
4707 @param Value The 64-bit value to write to DBR.
4709 @return The 64-bit value written to the DBR.
4721 Writes the current value of 64-bit Performance Monitor Configuration Register (PMC).
4723 Writes current value of Performance Monitor Configuration Register specified by Index.
4724 All processor implementations provide at least 4 performance counters
4725 (PMC/PMD [4]...PMC/PMD [7] pairs), and 4 performance monitor counter overflow status
4726 registers (PMC [0]... PMC [3]). Processor implementations may provide additional
4727 implementation-dependent PMC and PMD to increase the number of 'generic' performance
4728 counters (PMC/PMD pairs). The remainder of PMC and PMD register set is implementation
4729 dependent. No parameter checking is performed on Index. If the Index value is
4730 beyond the implemented PMC register range, the write is ignored.
4731 This function is only available on IPF.
4733 @param Index The 8-bit Performance Monitor Configuration Register index to write.
4734 @param Value The 64-bit value to write to PMC.
4736 @return The 64-bit value written to the PMC.
4748 Writes the current value of 64-bit Performance Monitor Data Register (PMD).
4750 Writes current value of Performance Monitor Data Register specified by Index.
4751 All processor implementations provide at least 4 performance counters
4752 (PMC/PMD [4]...PMC/PMD [7] pairs), and 4 performance monitor counter overflow
4753 status registers (PMC [0]... PMC [3]). Processor implementations may provide
4754 additional implementation-dependent PMC and PMD to increase the number of 'generic'
4755 performance counters (PMC/PMD pairs). The remainder of PMC and PMD register set
4756 is implementation dependent. No parameter checking is performed on Index. If the
4757 Index value is beyond the implemented PMD register range, the write is ignored.
4758 This function is only available on IPF.
4760 @param Index The 8-bit Performance Monitor Data Register index to write.
4761 @param Value The 64-bit value to write to PMD.
4763 @return The 64-bit value written to the PMD.
4775 Reads the current value of 64-bit Global Pointer (GP).
4777 Reads and returns the current value of GP.
4778 This function is only available on IPF.
4780 @return The current value of GP.
4791 Write the current value of 64-bit Global Pointer (GP).
4793 Writes the current value of GP. The 64-bit value written to the GP is returned.
4794 No parameter checking is performed on Value.
4795 This function is only available on IPF.
4797 @param Value The 64-bit value to write to GP.
4799 @return The 64-bit value written to the GP.
4810 Reads the current value of 64-bit Stack Pointer (SP).
4812 Reads and returns the current value of SP.
4813 This function is only available on IPF.
4815 @return The current value of SP.
4826 Determines if the CPU is currently executing in virtual, physical, or mixed mode.
4828 Determines the current execution mode of the CPU.
4829 If the CPU is in virtual mode(PSR.RT=1, PSR.DT=1, PSR.IT=1), then 1 is returned.
4830 If the CPU is in physical mode(PSR.RT=0, PSR.DT=0, PSR.IT=0), then 0 is returned.
4831 If the CPU is not in physical mode or virtual mode, then it is in mixed mode,
4833 This function is only available on IPF.
4835 @return 1 The CPU is in virtual mode.
4836 @return 0 The CPU is in physical mode.
4837 @return -1 The CPU is in mixed mode.
4848 Makes a PAL procedure call.
4850 This is a wrapper function to make a PAL procedure call. Based on the Index
4851 value this API will make static or stacked PAL call. The following table
4852 describes the usage of PAL Procedure Index Assignment. Architected procedures
4853 may be designated as required or optional. If a PAL procedure is specified
4854 as optional, a unique return code of 0xFFFFFFFFFFFFFFFF is returned in the
4855 Status field of the PAL_CALL_RETURN structure.
4856 This indicates that the procedure is not present in this PAL implementation.
4857 It is the caller's responsibility to check for this return code after calling
4858 any optional PAL procedure.
4859 No parameter checking is performed on the 5 input parameters, but there are
4860 some common rules that the caller should follow when making a PAL call. Any
4861 address passed to PAL as buffers for return parameters must be 8-byte aligned.
4862 Unaligned addresses may cause undefined results. For those parameters defined
4863 as reserved or some fields defined as reserved must be zero filled or the invalid
4864 argument return value may be returned or undefined result may occur during the
4865 execution of the procedure. If the PalEntryPoint does not point to a valid
4866 PAL entry point then the system behavior is undefined. This function is only
4869 @param PalEntryPoint The PAL procedure calls entry point.
4870 @param Index The PAL procedure Index number.
4871 @param Arg2 The 2nd parameter for PAL procedure calls.
4872 @param Arg3 The 3rd parameter for PAL procedure calls.
4873 @param Arg4 The 4th parameter for PAL procedure calls.
4875 @return structure returned from the PAL Call procedure, including the status and return value.
4881 IN UINT64 PalEntryPoint
,
4890 Transfers control to a function starting with a new stack.
4892 Transfers control to the function specified by EntryPoint using the new stack
4893 specified by NewStack and passing in the parameters specified by Context1 and
4894 Context2. Context1 and Context2 are optional and may be NULL. The function
4895 EntryPoint must never return.
4897 If EntryPoint is NULL, then ASSERT().
4898 If NewStack is NULL, then ASSERT().
4900 @param EntryPoint A pointer to function to call with the new stack.
4901 @param Context1 A pointer to the context to pass into the EntryPoint
4903 @param Context2 A pointer to the context to pass into the EntryPoint
4905 @param NewStack A pointer to the new stack to use for the EntryPoint
4907 @param NewBsp A pointer to the new memory location for RSE backing
4913 AsmSwitchStackAndBackingStore (
4914 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
4915 IN VOID
*Context1
, OPTIONAL
4916 IN VOID
*Context2
, OPTIONAL
4922 @todo This call should be removed after the PalCall
4923 Instance issue has been fixed.
4925 Performs a PAL call using static calling convention.
4927 An internal function to perform a PAL call using static calling convention.
4929 @param PalEntryPoint The entry point address of PAL. The address in ar.kr5
4930 would be used if this parameter were NULL on input.
4931 @param Arg1 The first argument of a PAL call.
4932 @param Arg2 The second argument of a PAL call.
4933 @param Arg3 The third argument of a PAL call.
4934 @param Arg4 The fourth argument of a PAL call.
4936 @return The values returned in r8, r9, r10 and r11.
4941 IN CONST VOID
*PalEntryPoint
,
4949 #elif defined (MDE_CPU_IA32) || defined (MDE_CPU_X64)
4951 /// IA32 and X64 Specific Functions
4952 /// Byte packed structure for 16-bit Real Mode EFLAGS
4956 UINT32 CF
:1; /// Carry Flag
4957 UINT32 Reserved_0
:1; /// Reserved
4958 UINT32 PF
:1; /// Parity Flag
4959 UINT32 Reserved_1
:1; /// Reserved
4960 UINT32 AF
:1; /// Auxiliary Carry Flag
4961 UINT32 Reserved_2
:1; /// Reserved
4962 UINT32 ZF
:1; /// Zero Flag
4963 UINT32 SF
:1; /// Sign Flag
4964 UINT32 TF
:1; /// Trap Flag
4965 UINT32 IF
:1; /// Interrupt Enable Flag
4966 UINT32 DF
:1; /// Direction Flag
4967 UINT32 OF
:1; /// Overflow Flag
4968 UINT32 IOPL
:2; /// I/O Privilege Level
4969 UINT32 NT
:1; /// Nested Task
4970 UINT32 Reserved_3
:1; /// Reserved
4976 /// Byte packed structure for EFLAGS/RFLAGS
4977 /// 32-bits on IA-32
4978 /// 64-bits on X64. The upper 32-bits on X64 are reserved
4982 UINT32 CF
:1; /// Carry Flag
4983 UINT32 Reserved_0
:1; /// Reserved
4984 UINT32 PF
:1; /// Parity Flag
4985 UINT32 Reserved_1
:1; /// Reserved
4986 UINT32 AF
:1; /// Auxiliary Carry Flag
4987 UINT32 Reserved_2
:1; /// Reserved
4988 UINT32 ZF
:1; /// Zero Flag
4989 UINT32 SF
:1; /// Sign Flag
4990 UINT32 TF
:1; /// Trap Flag
4991 UINT32 IF
:1; /// Interrupt Enable Flag
4992 UINT32 DF
:1; /// Direction Flag
4993 UINT32 OF
:1; /// Overflow Flag
4994 UINT32 IOPL
:2; /// I/O Privilege Level
4995 UINT32 NT
:1; /// Nested Task
4996 UINT32 Reserved_3
:1; /// Reserved
4997 UINT32 RF
:1; /// Resume Flag
4998 UINT32 VM
:1; /// Virtual 8086 Mode
4999 UINT32 AC
:1; /// Alignment Check
5000 UINT32 VIF
:1; /// Virtual Interrupt Flag
5001 UINT32 VIP
:1; /// Virtual Interrupt Pending
5002 UINT32 ID
:1; /// ID Flag
5003 UINT32 Reserved_4
:10; /// Reserved
5009 /// Byte packed structure for Control Register 0 (CR0)
5010 /// 32-bits on IA-32
5011 /// 64-bits on X64. The upper 32-bits on X64 are reserved
5015 UINT32 PE
:1; /// Protection Enable
5016 UINT32 MP
:1; /// Monitor Coprocessor
5017 UINT32 EM
:1; /// Emulation
5018 UINT32 TS
:1; /// Task Switched
5019 UINT32 ET
:1; /// Extension Type
5020 UINT32 NE
:1; /// Numeric Error
5021 UINT32 Reserved_0
:10; /// Reserved
5022 UINT32 WP
:1; /// Write Protect
5023 UINT32 Reserved_1
:1; /// Reserved
5024 UINT32 AM
:1; /// Alignment Mask
5025 UINT32 Reserved_2
:10; /// Reserved
5026 UINT32 NW
:1; /// Mot Write-through
5027 UINT32 CD
:1; /// Cache Disable
5028 UINT32 PG
:1; /// Paging
5034 /// Byte packed structure for Control Register 4 (CR4)
5035 /// 32-bits on IA-32
5036 /// 64-bits on X64. The upper 32-bits on X64 are reserved
5040 UINT32 VME
:1; /// Virtual-8086 Mode Extensions
5041 UINT32 PVI
:1; /// Protected-Mode Virtual Interrupts
5042 UINT32 TSD
:1; /// Time Stamp Disable
5043 UINT32 DE
:1; /// Debugging Extensions
5044 UINT32 PSE
:1; /// Page Size Extensions
5045 UINT32 PAE
:1; /// Physical Address Extension
5046 UINT32 MCE
:1; /// Machine Check Enable
5047 UINT32 PGE
:1; /// Page Global Enable
5048 UINT32 PCE
:1; /// Performance Monitoring Counter
5050 UINT32 OSFXSR
:1; /// Operating System Support for
5051 /// FXSAVE and FXRSTOR instructions
5052 UINT32 OSXMMEXCPT
:1; /// Operating System Support for
5053 /// Unmasked SIMD Floating Point
5055 UINT32 Reserved_0
:2; /// Reserved
5056 UINT32 VMXE
:1; /// VMX Enable
5057 UINT32 Reserved_1
:18; /// Reseved
5063 /// Byte packed structure for an IDTR, GDTR, LDTR descriptor
5064 /// @todo How to make this structure byte-packed in a compiler independent way?
5073 #define IA32_IDT_GATE_TYPE_TASK 0x85
5074 #define IA32_IDT_GATE_TYPE_INTERRUPT_16 0x86
5075 #define IA32_IDT_GATE_TYPE_TRAP_16 0x87
5076 #define IA32_IDT_GATE_TYPE_INTERRUPT_32 0x8E
5077 #define IA32_IDT_GATE_TYPE_TRAP_32 0x8F
5080 /// Byte packed structure for an Interrupt Gate Descriptor
5082 #if defined (MDE_CPU_IA32)
5086 UINT32 OffsetLow
:16; // Offset bits 15..0
5087 UINT32 Selector
:16; // Selector
5088 UINT32 Reserved_0
:8; // Reserved
5089 UINT32 GateType
:8; // Gate Type. See #defines above
5090 UINT32 OffsetHigh
:16; // Offset bits 31..16
5093 } IA32_IDT_GATE_DESCRIPTOR
;
5097 #if defined (MDE_CPU_X64)
5101 UINT32 OffsetLow
:16; // Offset bits 15..0
5102 UINT32 Selector
:16; // Selector
5103 UINT32 Reserved_0
:8; // Reserved
5104 UINT32 GateType
:8; // Gate Type. See #defines above
5105 UINT32 OffsetHigh
:16; // Offset bits 31..16
5106 UINT32 OffsetUpper
:32; // Offset bits 63..32
5107 UINT32 Reserved_1
:32; // Reserved
5111 } IA32_IDT_GATE_DESCRIPTOR
;
5116 /// Byte packed structure for an FP/SSE/SSE2 context
5123 /// Structures for the 16-bit real mode thunks
5176 IA32_EFLAGS32 EFLAGS
;
5186 } IA32_REGISTER_SET
;
5189 /// Byte packed structure for an 16-bit real mode thunks
5192 IA32_REGISTER_SET
*RealModeState
;
5193 VOID
*RealModeBuffer
;
5194 UINT32 RealModeBufferSize
;
5195 UINT32 ThunkAttributes
;
5198 #define THUNK_ATTRIBUTE_BIG_REAL_MODE 0x00000001
5199 #define THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 0x00000002
5200 #define THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL 0x00000004
5203 Retrieves CPUID information.
5205 Executes the CPUID instruction with EAX set to the value specified by Index.
5206 This function always returns Index.
5207 If Eax is not NULL, then the value of EAX after CPUID is returned in Eax.
5208 If Ebx is not NULL, then the value of EBX after CPUID is returned in Ebx.
5209 If Ecx is not NULL, then the value of ECX after CPUID is returned in Ecx.
5210 If Edx is not NULL, then the value of EDX after CPUID is returned in Edx.
5211 This function is only available on IA-32 and X64.
5213 @param Index The 32-bit value to load into EAX prior to invoking the CPUID
5215 @param Eax Pointer to the 32-bit EAX value returned by the CPUID
5216 instruction. This is an optional parameter that may be NULL.
5217 @param Ebx Pointer to the 32-bit EBX value returned by the CPUID
5218 instruction. This is an optional parameter that may be NULL.
5219 @param Ecx Pointer to the 32-bit ECX value returned by the CPUID
5220 instruction. This is an optional parameter that may be NULL.
5221 @param Edx Pointer to the 32-bit EDX value returned by the CPUID
5222 instruction. This is an optional parameter that may be NULL.
5231 OUT UINT32
*Eax
, OPTIONAL
5232 OUT UINT32
*Ebx
, OPTIONAL
5233 OUT UINT32
*Ecx
, OPTIONAL
5234 OUT UINT32
*Edx OPTIONAL
5239 Retrieves CPUID information using an extended leaf identifier.
5241 Executes the CPUID instruction with EAX set to the value specified by Index
5242 and ECX set to the value specified by SubIndex. This function always returns
5243 Index. This function is only available on IA-32 and x64.
5245 If Eax is not NULL, then the value of EAX after CPUID is returned in Eax.
5246 If Ebx is not NULL, then the value of EBX after CPUID is returned in Ebx.
5247 If Ecx is not NULL, then the value of ECX after CPUID is returned in Ecx.
5248 If Edx is not NULL, then the value of EDX after CPUID is returned in Edx.
5250 @param Index The 32-bit value to load into EAX prior to invoking the
5252 @param SubIndex The 32-bit value to load into ECX prior to invoking the
5254 @param Eax Pointer to the 32-bit EAX value returned by the CPUID
5255 instruction. This is an optional parameter that may be
5257 @param Ebx Pointer to the 32-bit EBX value returned by the CPUID
5258 instruction. This is an optional parameter that may be
5260 @param Ecx Pointer to the 32-bit ECX value returned by the CPUID
5261 instruction. This is an optional parameter that may be
5263 @param Edx Pointer to the 32-bit EDX value returned by the CPUID
5264 instruction. This is an optional parameter that may be
5275 OUT UINT32
*Eax
, OPTIONAL
5276 OUT UINT32
*Ebx
, OPTIONAL
5277 OUT UINT32
*Ecx
, OPTIONAL
5278 OUT UINT32
*Edx OPTIONAL
5283 Returns the lower 32-bits of a Machine Specific Register(MSR).
5285 Reads and returns the lower 32-bits of the MSR specified by Index.
5286 No parameter checking is performed on Index, and some Index values may cause
5287 CPU exceptions. The caller must either guarantee that Index is valid, or the
5288 caller must set up exception handlers to catch the exceptions. This function
5289 is only available on IA-32 and X64.
5291 @param Index The 32-bit MSR index to read.
5293 @return The lower 32 bits of the MSR identified by Index.
5304 Zero-extend a 32-bit value and writes it to a Machine Specific Register(MSR).
5306 Writes the 32-bit value specified by Value to the MSR specified by Index. The
5307 upper 32-bits of the MSR write are set to zero. The 32-bit value written to
5308 the MSR is returned. No parameter checking is performed on Index or Value,
5309 and some of these may cause CPU exceptions. The caller must either guarantee
5310 that Index and Value are valid, or the caller must establish proper exception
5311 handlers. This function is only available on IA-32 and X64.
5313 @param Index The 32-bit MSR index to write.
5314 @param Value The 32-bit value to write to the MSR.
5328 Reads a 64-bit MSR, performs a bitwise inclusive OR on the lower 32-bits, and
5329 writes the result back to the 64-bit MSR.
5331 Reads the 64-bit MSR specified by Index, performs a bitwise inclusive OR
5332 between the lower 32-bits of the read result and the value specified by
5333 OrData, and writes the result to the 64-bit MSR specified by Index. The lower
5334 32-bits of the value written to the MSR is returned. No parameter checking is
5335 performed on Index or OrData, and some of these may cause CPU exceptions. The
5336 caller must either guarantee that Index and OrData are valid, or the caller
5337 must establish proper exception handlers. This function is only available on
5340 @param Index The 32-bit MSR index to write.
5341 @param OrData The value to OR with the read value from the MSR.
5343 @return The lower 32-bit value written to the MSR.
5355 Reads a 64-bit MSR, performs a bitwise AND on the lower 32-bits, and writes
5356 the result back to the 64-bit MSR.
5358 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
5359 lower 32-bits of the read result and the value specified by AndData, and
5360 writes the result to the 64-bit MSR specified by Index. The lower 32-bits of
5361 the value written to the MSR is returned. No parameter checking is performed
5362 on Index or AndData, and some of these may cause CPU exceptions. The caller
5363 must either guarantee that Index and AndData are valid, or the caller must
5364 establish proper exception handlers. This function is only available on IA-32
5367 @param Index The 32-bit MSR index to write.
5368 @param AndData The value to AND with the read value from the MSR.
5370 @return The lower 32-bit value written to the MSR.
5382 Reads a 64-bit MSR, performs a bitwise AND followed by a bitwise inclusive OR
5383 on the lower 32-bits, and writes the result back to the 64-bit MSR.
5385 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
5386 lower 32-bits of the read result and the value specified by AndData
5387 preserving the upper 32-bits, performs a bitwise inclusive OR between the
5388 result of the AND operation and the value specified by OrData, and writes the
5389 result to the 64-bit MSR specified by Address. The lower 32-bits of the value
5390 written to the MSR is returned. No parameter checking is performed on Index,
5391 AndData, or OrData, and some of these may cause CPU exceptions. The caller
5392 must either guarantee that Index, AndData, and OrData are valid, or the
5393 caller must establish proper exception handlers. This function is only
5394 available on IA-32 and X64.
5396 @param Index The 32-bit MSR index to write.
5397 @param AndData The value to AND with the read value from the MSR.
5398 @param OrData The value to OR with the result of the AND operation.
5400 @return The lower 32-bit value written to the MSR.
5413 Reads a bit field of an MSR.
5415 Reads the bit field in the lower 32-bits of a 64-bit MSR. The bit field is
5416 specified by the StartBit and the EndBit. The value of the bit field is
5417 returned. The caller must either guarantee that Index is valid, or the caller
5418 must set up exception handlers to catch the exceptions. This function is only
5419 available on IA-32 and X64.
5421 If StartBit is greater than 31, then ASSERT().
5422 If EndBit is greater than 31, then ASSERT().
5423 If EndBit is less than StartBit, then ASSERT().
5425 @param Index The 32-bit MSR index to read.
5426 @param StartBit The ordinal of the least significant bit in the bit field.
5428 @param EndBit The ordinal of the most significant bit in the bit field.
5431 @return The bit field read from the MSR.
5436 AsmMsrBitFieldRead32 (
5444 Writes a bit field to an MSR.
5446 Writes Value to a bit field in the lower 32-bits of a 64-bit MSR. The bit
5447 field is specified by the StartBit and the EndBit. All other bits in the
5448 destination MSR are preserved. The lower 32-bits of the MSR written is
5449 returned. Extra left bits in Value are stripped. The caller must either
5450 guarantee that Index and the data written is valid, or the caller must set up
5451 exception handlers to catch the exceptions. This function is only available
5454 If StartBit is greater than 31, then ASSERT().
5455 If EndBit is greater than 31, then ASSERT().
5456 If EndBit is less than StartBit, then ASSERT().
5458 @param Index The 32-bit MSR index to write.
5459 @param StartBit The ordinal of the least significant bit in the bit field.
5461 @param EndBit The ordinal of the most significant bit in the bit field.
5463 @param Value New value of the bit field.
5465 @return The lower 32-bit of the value written to the MSR.
5470 AsmMsrBitFieldWrite32 (
5479 Reads a bit field in a 64-bit MSR, performs a bitwise OR, and writes the
5480 result back to the bit field in the 64-bit MSR.
5482 Reads the 64-bit MSR specified by Index, performs a bitwise inclusive OR
5483 between the read result and the value specified by OrData, and writes the
5484 result to the 64-bit MSR specified by Index. The lower 32-bits of the value
5485 written to the MSR are returned. Extra left bits in OrData are stripped. The
5486 caller must either guarantee that Index and the data written is valid, or
5487 the caller must set up exception handlers to catch the exceptions. This
5488 function is only available on IA-32 and X64.
5490 If StartBit is greater than 31, then ASSERT().
5491 If EndBit is greater than 31, then ASSERT().
5492 If EndBit is less than StartBit, then ASSERT().
5494 @param Index The 32-bit MSR index to write.
5495 @param StartBit The ordinal of the least significant bit in the bit field.
5497 @param EndBit The ordinal of the most significant bit in the bit field.
5499 @param OrData The value to OR with the read value from the MSR.
5501 @return The lower 32-bit of the value written to the MSR.
5506 AsmMsrBitFieldOr32 (
5515 Reads a bit field in a 64-bit MSR, performs a bitwise AND, and writes the
5516 result back to the bit field in the 64-bit MSR.
5518 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
5519 read result and the value specified by AndData, and writes the result to the
5520 64-bit MSR specified by Index. The lower 32-bits of the value written to the
5521 MSR are returned. Extra left bits in AndData are stripped. The caller must
5522 either guarantee that Index and the data written is valid, or the caller must
5523 set up exception handlers to catch the exceptions. This function is only
5524 available on IA-32 and X64.
5526 If StartBit is greater than 31, then ASSERT().
5527 If EndBit is greater than 31, then ASSERT().
5528 If EndBit is less than StartBit, then ASSERT().
5530 @param Index The 32-bit MSR index to write.
5531 @param StartBit The ordinal of the least significant bit in the bit field.
5533 @param EndBit The ordinal of the most significant bit in the bit field.
5535 @param AndData The value to AND with the read value from the MSR.
5537 @return The lower 32-bit of the value written to the MSR.
5542 AsmMsrBitFieldAnd32 (
5551 Reads a bit field in a 64-bit MSR, performs a bitwise AND followed by a
5552 bitwise inclusive OR, and writes the result back to the bit field in the
5555 Reads the 64-bit MSR specified by Index, performs a bitwise AND followed by a
5556 bitwise inclusive OR between the read result and the value specified by
5557 AndData, and writes the result to the 64-bit MSR specified by Index. The
5558 lower 32-bits of the value written to the MSR are returned. Extra left bits
5559 in both AndData and OrData are stripped. The caller must either guarantee
5560 that Index and the data written is valid, or the caller must set up exception
5561 handlers to catch the exceptions. This function is only available on IA-32
5564 If StartBit is greater than 31, then ASSERT().
5565 If EndBit is greater than 31, then ASSERT().
5566 If EndBit is less than StartBit, then ASSERT().
5568 @param Index The 32-bit MSR index to write.
5569 @param StartBit The ordinal of the least significant bit in the bit field.
5571 @param EndBit The ordinal of the most significant bit in the bit field.
5573 @param AndData The value to AND with the read value from the MSR.
5574 @param OrData The value to OR with the result of the AND operation.
5576 @return The lower 32-bit of the value written to the MSR.
5581 AsmMsrBitFieldAndThenOr32 (
5591 Returns a 64-bit Machine Specific Register(MSR).
5593 Reads and returns the 64-bit MSR specified by Index. No parameter checking is
5594 performed on Index, and some Index values may cause CPU exceptions. The
5595 caller must either guarantee that Index is valid, or the caller must set up
5596 exception handlers to catch the exceptions. This function is only available
5599 @param Index The 32-bit MSR index to read.
5601 @return The value of the MSR identified by Index.
5612 Writes a 64-bit value to a Machine Specific Register(MSR), and returns the
5615 Writes the 64-bit value specified by Value to the MSR specified by Index. The
5616 64-bit value written to the MSR is returned. No parameter checking is
5617 performed on Index or Value, and some of these may cause CPU exceptions. The
5618 caller must either guarantee that Index and Value are valid, or the caller
5619 must establish proper exception handlers. This function is only available on
5622 @param Index The 32-bit MSR index to write.
5623 @param Value The 64-bit value to write to the MSR.
5637 Reads a 64-bit MSR, performs a bitwise inclusive OR, and writes the result
5638 back to the 64-bit MSR.
5640 Reads the 64-bit MSR specified by Index, performs a bitwise inclusive OR
5641 between the read result and the value specified by OrData, and writes the
5642 result to the 64-bit MSR specified by Index. The value written to the MSR is
5643 returned. No parameter checking is performed on Index or OrData, and some of
5644 these may cause CPU exceptions. The caller must either guarantee that Index
5645 and OrData are valid, or the caller must establish proper exception handlers.
5646 This function is only available on IA-32 and X64.
5648 @param Index The 32-bit MSR index to write.
5649 @param OrData The value to OR with the read value from the MSR.
5651 @return The value written back to the MSR.
5663 Reads a 64-bit MSR, performs a bitwise AND, and writes the result back to the
5666 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
5667 read result and the value specified by OrData, and writes the result to the
5668 64-bit MSR specified by Index. The value written to the MSR is returned. No
5669 parameter checking is performed on Index or OrData, and some of these may
5670 cause CPU exceptions. The caller must either guarantee that Index and OrData
5671 are valid, or the caller must establish proper exception handlers. This
5672 function is only available on IA-32 and X64.
5674 @param Index The 32-bit MSR index to write.
5675 @param AndData The value to AND with the read value from the MSR.
5677 @return The value written back to the MSR.
5689 Reads a 64-bit MSR, performs a bitwise AND followed by a bitwise inclusive
5690 OR, and writes the result back to the 64-bit MSR.
5692 Reads the 64-bit MSR specified by Index, performs a bitwise AND between read
5693 result and the value specified by AndData, performs a bitwise inclusive OR
5694 between the result of the AND operation and the value specified by OrData,
5695 and writes the result to the 64-bit MSR specified by Index. The value written
5696 to the MSR is returned. No parameter checking is performed on Index, AndData,
5697 or OrData, and some of these may cause CPU exceptions. The caller must either
5698 guarantee that Index, AndData, and OrData are valid, or the caller must
5699 establish proper exception handlers. This function is only available on IA-32
5702 @param Index The 32-bit MSR index to write.
5703 @param AndData The value to AND with the read value from the MSR.
5704 @param OrData The value to OR with the result of the AND operation.
5706 @return The value written back to the MSR.
5719 Reads a bit field of an MSR.
5721 Reads the bit field in the 64-bit MSR. The bit field is specified by the
5722 StartBit and the EndBit. The value of the bit field is returned. The caller
5723 must either guarantee that Index is valid, or the caller must set up
5724 exception handlers to catch the exceptions. This function is only available
5727 If StartBit is greater than 63, then ASSERT().
5728 If EndBit is greater than 63, then ASSERT().
5729 If EndBit is less than StartBit, then ASSERT().
5731 @param Index The 32-bit MSR index to read.
5732 @param StartBit The ordinal of the least significant bit in the bit field.
5734 @param EndBit The ordinal of the most significant bit in the bit field.
5737 @return The value read from the MSR.
5742 AsmMsrBitFieldRead64 (
5750 Writes a bit field to an MSR.
5752 Writes Value to a bit field in a 64-bit MSR. The bit field is specified by
5753 the StartBit and the EndBit. All other bits in the destination MSR are
5754 preserved. The MSR written is returned. Extra left bits in Value are
5755 stripped. The caller must either guarantee that Index and the data written is
5756 valid, or the caller must set up exception handlers to catch the exceptions.
5757 This function is only available on IA-32 and X64.
5759 If StartBit is greater than 63, then ASSERT().
5760 If EndBit is greater than 63, then ASSERT().
5761 If EndBit is less than StartBit, then ASSERT().
5763 @param Index The 32-bit MSR index to write.
5764 @param StartBit The ordinal of the least significant bit in the bit field.
5766 @param EndBit The ordinal of the most significant bit in the bit field.
5768 @param Value New value of the bit field.
5770 @return The value written back to the MSR.
5775 AsmMsrBitFieldWrite64 (
5784 Reads a bit field in a 64-bit MSR, performs a bitwise inclusive OR, and
5785 writes the result back to the bit field in the 64-bit MSR.
5787 Reads the 64-bit MSR specified by Index, performs a bitwise inclusive OR
5788 between the read result and the value specified by OrData, and writes the
5789 result to the 64-bit MSR specified by Index. The value written to the MSR is
5790 returned. Extra left bits in OrData are stripped. The caller must either
5791 guarantee that Index and the data written is valid, or the caller must set up
5792 exception handlers to catch the exceptions. This function is only available
5795 If StartBit is greater than 63, then ASSERT().
5796 If EndBit is greater than 63, then ASSERT().
5797 If EndBit is less than StartBit, then ASSERT().
5799 @param Index The 32-bit MSR index to write.
5800 @param StartBit The ordinal of the least significant bit in the bit field.
5802 @param EndBit The ordinal of the most significant bit in the bit field.
5804 @param OrData The value to OR with the read value from the bit field.
5806 @return The value written back to the MSR.
5811 AsmMsrBitFieldOr64 (
5820 Reads a bit field in a 64-bit MSR, performs a bitwise AND, and writes the
5821 result back to the bit field in the 64-bit MSR.
5823 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
5824 read result and the value specified by AndData, and writes the result to the
5825 64-bit MSR specified by Index. The value written to the MSR is returned.
5826 Extra left bits in AndData are stripped. The caller must either guarantee
5827 that Index and the data written is valid, or the caller must set up exception
5828 handlers to catch the exceptions. This function is only available on IA-32
5831 If StartBit is greater than 63, then ASSERT().
5832 If EndBit is greater than 63, then ASSERT().
5833 If EndBit is less than StartBit, then ASSERT().
5835 @param Index The 32-bit MSR index to write.
5836 @param StartBit The ordinal of the least significant bit in the bit field.
5838 @param EndBit The ordinal of the most significant bit in the bit field.
5840 @param AndData The value to AND with the read value from the bit field.
5842 @return The value written back to the MSR.
5847 AsmMsrBitFieldAnd64 (
5856 Reads a bit field in a 64-bit MSR, performs a bitwise AND followed by a
5857 bitwise inclusive OR, and writes the result back to the bit field in the
5860 Reads the 64-bit MSR specified by Index, performs a bitwise AND followed by
5861 a bitwise inclusive OR between the read result and the value specified by
5862 AndData, and writes the result to the 64-bit MSR specified by Index. The
5863 value written to the MSR is returned. Extra left bits in both AndData and
5864 OrData are stripped. The caller must either guarantee that Index and the data
5865 written is valid, or the caller must set up exception handlers to catch the
5866 exceptions. This function is only available on IA-32 and X64.
5868 If StartBit is greater than 63, then ASSERT().
5869 If EndBit is greater than 63, then ASSERT().
5870 If EndBit is less than StartBit, then ASSERT().
5872 @param Index The 32-bit MSR index to write.
5873 @param StartBit The ordinal of the least significant bit in the bit field.
5875 @param EndBit The ordinal of the most significant bit in the bit field.
5877 @param AndData The value to AND with the read value from the bit field.
5878 @param OrData The value to OR with the result of the AND operation.
5880 @return The value written back to the MSR.
5885 AsmMsrBitFieldAndThenOr64 (
5895 Reads the current value of the EFLAGS register.
5897 Reads and returns the current value of the EFLAGS register. This function is
5898 only available on IA-32 and X64. This returns a 32-bit value on IA-32 and a
5899 64-bit value on X64.
5901 @return EFLAGS on IA-32 or RFLAGS on X64.
5912 Reads the current value of the Control Register 0 (CR0).
5914 Reads and returns the current value of CR0. This function is only available
5915 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
5918 @return The value of the Control Register 0 (CR0).
5929 Reads the current value of the Control Register 2 (CR2).
5931 Reads and returns the current value of CR2. This function is only available
5932 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
5935 @return The value of the Control Register 2 (CR2).
5946 Reads the current value of the Control Register 3 (CR3).
5948 Reads and returns the current value of CR3. This function is only available
5949 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
5952 @return The value of the Control Register 3 (CR3).
5963 Reads the current value of the Control Register 4 (CR4).
5965 Reads and returns the current value of CR4. This function is only available
5966 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
5969 @return The value of the Control Register 4 (CR4).
5980 Writes a value to Control Register 0 (CR0).
5982 Writes and returns a new value to CR0. This function is only available on
5983 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
5985 @param Cr0 The value to write to CR0.
5987 @return The value written to CR0.
5998 Writes a value to Control Register 2 (CR2).
6000 Writes and returns a new value to CR2. This function is only available on
6001 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6003 @param Cr2 The value to write to CR2.
6005 @return The value written to CR2.
6016 Writes a value to Control Register 3 (CR3).
6018 Writes and returns a new value to CR3. This function is only available on
6019 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6021 @param Cr3 The value to write to CR3.
6023 @return The value written to CR3.
6034 Writes a value to Control Register 4 (CR4).
6036 Writes and returns a new value to CR4. This function is only available on
6037 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6039 @param Cr4 The value to write to CR4.
6041 @return The value written to CR4.
6052 Reads the current value of Debug Register 0 (DR0).
6054 Reads and returns the current value of DR0. This function is only available
6055 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
6058 @return The value of Debug Register 0 (DR0).
6069 Reads the current value of Debug Register 1 (DR1).
6071 Reads and returns the current value of DR1. This function is only available
6072 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
6075 @return The value of Debug Register 1 (DR1).
6086 Reads the current value of Debug Register 2 (DR2).
6088 Reads and returns the current value of DR2. This function is only available
6089 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
6092 @return The value of Debug Register 2 (DR2).
6103 Reads the current value of Debug Register 3 (DR3).
6105 Reads and returns the current value of DR3. This function is only available
6106 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
6109 @return The value of Debug Register 3 (DR3).
6120 Reads the current value of Debug Register 4 (DR4).
6122 Reads and returns the current value of DR4. This function is only available
6123 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
6126 @return The value of Debug Register 4 (DR4).
6137 Reads the current value of Debug Register 5 (DR5).
6139 Reads and returns the current value of DR5. This function is only available
6140 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
6143 @return The value of Debug Register 5 (DR5).
6154 Reads the current value of Debug Register 6 (DR6).
6156 Reads and returns the current value of DR6. This function is only available
6157 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
6160 @return The value of Debug Register 6 (DR6).
6171 Reads the current value of Debug Register 7 (DR7).
6173 Reads and returns the current value of DR7. This function is only available
6174 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
6177 @return The value of Debug Register 7 (DR7).
6188 Writes a value to Debug Register 0 (DR0).
6190 Writes and returns a new value to DR0. This function is only available on
6191 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6193 @param Dr0 The value to write to Dr0.
6195 @return The value written to Debug Register 0 (DR0).
6206 Writes a value to Debug Register 1 (DR1).
6208 Writes and returns a new value to DR1. This function is only available on
6209 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6211 @param Dr1 The value to write to Dr1.
6213 @return The value written to Debug Register 1 (DR1).
6224 Writes a value to Debug Register 2 (DR2).
6226 Writes and returns a new value to DR2. This function is only available on
6227 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6229 @param Dr2 The value to write to Dr2.
6231 @return The value written to Debug Register 2 (DR2).
6242 Writes a value to Debug Register 3 (DR3).
6244 Writes and returns a new value to DR3. This function is only available on
6245 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6247 @param Dr3 The value to write to Dr3.
6249 @return The value written to Debug Register 3 (DR3).
6260 Writes a value to Debug Register 4 (DR4).
6262 Writes and returns a new value to DR4. This function is only available on
6263 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6265 @param Dr4 The value to write to Dr4.
6267 @return The value written to Debug Register 4 (DR4).
6278 Writes a value to Debug Register 5 (DR5).
6280 Writes and returns a new value to DR5. This function is only available on
6281 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6283 @param Dr5 The value to write to Dr5.
6285 @return The value written to Debug Register 5 (DR5).
6296 Writes a value to Debug Register 6 (DR6).
6298 Writes and returns a new value to DR6. This function is only available on
6299 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6301 @param Dr6 The value to write to Dr6.
6303 @return The value written to Debug Register 6 (DR6).
6314 Writes a value to Debug Register 7 (DR7).
6316 Writes and returns a new value to DR7. This function is only available on
6317 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6319 @param Dr7 The value to write to Dr7.
6321 @return The value written to Debug Register 7 (DR7).
6332 Reads the current value of Code Segment Register (CS).
6334 Reads and returns the current value of CS. This function is only available on
6337 @return The current value of CS.
6348 Reads the current value of Data Segment Register (DS).
6350 Reads and returns the current value of DS. This function is only available on
6353 @return The current value of DS.
6364 Reads the current value of Extra Segment Register (ES).
6366 Reads and returns the current value of ES. This function is only available on
6369 @return The current value of ES.
6380 Reads the current value of FS Data Segment Register (FS).
6382 Reads and returns the current value of FS. This function is only available on
6385 @return The current value of FS.
6396 Reads the current value of GS Data Segment Register (GS).
6398 Reads and returns the current value of GS. This function is only available on
6401 @return The current value of GS.
6412 Reads the current value of Stack Segment Register (SS).
6414 Reads and returns the current value of SS. This function is only available on
6417 @return The current value of SS.
6428 Reads the current value of Task Register (TR).
6430 Reads and returns the current value of TR. This function is only available on
6433 @return The current value of TR.
6444 Reads the current Global Descriptor Table Register(GDTR) descriptor.
6446 Reads and returns the current GDTR descriptor and returns it in Gdtr. This
6447 function is only available on IA-32 and X64.
6449 If Gdtr is NULL, then ASSERT().
6451 @param Gdtr Pointer to a GDTR descriptor.
6457 OUT IA32_DESCRIPTOR
*Gdtr
6462 Writes the current Global Descriptor Table Register (GDTR) descriptor.
6464 Writes and the current GDTR descriptor specified by Gdtr. This function is
6465 only available on IA-32 and X64.
6467 If Gdtr is NULL, then ASSERT().
6469 @param Gdtr Pointer to a GDTR descriptor.
6475 IN CONST IA32_DESCRIPTOR
*Gdtr
6480 Reads the current Interrupt Descriptor Table Register(GDTR) descriptor.
6482 Reads and returns the current IDTR descriptor and returns it in Idtr. This
6483 function is only available on IA-32 and X64.
6485 If Idtr is NULL, then ASSERT().
6487 @param Idtr Pointer to a IDTR descriptor.
6493 OUT IA32_DESCRIPTOR
*Idtr
6498 Writes the current Interrupt Descriptor Table Register(GDTR) descriptor.
6500 Writes the current IDTR descriptor and returns it in Idtr. This function is
6501 only available on IA-32 and X64.
6503 If Idtr is NULL, then ASSERT().
6505 @param Idtr Pointer to a IDTR descriptor.
6511 IN CONST IA32_DESCRIPTOR
*Idtr
6516 Reads the current Local Descriptor Table Register(LDTR) selector.
6518 Reads and returns the current 16-bit LDTR descriptor value. This function is
6519 only available on IA-32 and X64.
6521 @return The current selector of LDT.
6532 Writes the current Local Descriptor Table Register (GDTR) selector.
6534 Writes and the current LDTR descriptor specified by Ldtr. This function is
6535 only available on IA-32 and X64.
6537 @param Ldtr 16-bit LDTR selector value.
6548 Save the current floating point/SSE/SSE2 context to a buffer.
6550 Saves the current floating point/SSE/SSE2 state to the buffer specified by
6551 Buffer. Buffer must be aligned on a 16-byte boundary. This function is only
6552 available on IA-32 and X64.
6554 If Buffer is NULL, then ASSERT().
6555 If Buffer is not aligned on a 16-byte boundary, then ASSERT().
6557 @param Buffer Pointer to a buffer to save the floating point/SSE/SSE2 context.
6563 OUT IA32_FX_BUFFER
*Buffer
6568 Restores the current floating point/SSE/SSE2 context from a buffer.
6570 Restores the current floating point/SSE/SSE2 state from the buffer specified
6571 by Buffer. Buffer must be aligned on a 16-byte boundary. This function is
6572 only available on IA-32 and X64.
6574 If Buffer is NULL, then ASSERT().
6575 If Buffer is not aligned on a 16-byte boundary, then ASSERT().
6576 If Buffer was not saved with AsmFxSave(), then ASSERT().
6578 @param Buffer Pointer to a buffer to save the floating point/SSE/SSE2 context.
6584 IN CONST IA32_FX_BUFFER
*Buffer
6589 Reads the current value of 64-bit MMX Register #0 (MM0).
6591 Reads and returns the current value of MM0. This function is only available
6594 @return The current value of MM0.
6605 Reads the current value of 64-bit MMX Register #1 (MM1).
6607 Reads and returns the current value of MM1. This function is only available
6610 @return The current value of MM1.
6621 Reads the current value of 64-bit MMX Register #2 (MM2).
6623 Reads and returns the current value of MM2. This function is only available
6626 @return The current value of MM2.
6637 Reads the current value of 64-bit MMX Register #3 (MM3).
6639 Reads and returns the current value of MM3. This function is only available
6642 @return The current value of MM3.
6653 Reads the current value of 64-bit MMX Register #4 (MM4).
6655 Reads and returns the current value of MM4. This function is only available
6658 @return The current value of MM4.
6669 Reads the current value of 64-bit MMX Register #5 (MM5).
6671 Reads and returns the current value of MM5. This function is only available
6674 @return The current value of MM5.
6685 Reads the current value of 64-bit MMX Register #6 (MM6).
6687 Reads and returns the current value of MM6. This function is only available
6690 @return The current value of MM6.
6701 Reads the current value of 64-bit MMX Register #7 (MM7).
6703 Reads and returns the current value of MM7. This function is only available
6706 @return The current value of MM7.
6717 Writes the current value of 64-bit MMX Register #0 (MM0).
6719 Writes the current value of MM0. This function is only available on IA32 and
6722 @param Value The 64-bit value to write to MM0.
6733 Writes the current value of 64-bit MMX Register #1 (MM1).
6735 Writes the current value of MM1. This function is only available on IA32 and
6738 @param Value The 64-bit value to write to MM1.
6749 Writes the current value of 64-bit MMX Register #2 (MM2).
6751 Writes the current value of MM2. This function is only available on IA32 and
6754 @param Value The 64-bit value to write to MM2.
6765 Writes the current value of 64-bit MMX Register #3 (MM3).
6767 Writes the current value of MM3. This function is only available on IA32 and
6770 @param Value The 64-bit value to write to MM3.
6781 Writes the current value of 64-bit MMX Register #4 (MM4).
6783 Writes the current value of MM4. This function is only available on IA32 and
6786 @param Value The 64-bit value to write to MM4.
6797 Writes the current value of 64-bit MMX Register #5 (MM5).
6799 Writes the current value of MM5. This function is only available on IA32 and
6802 @param Value The 64-bit value to write to MM5.
6813 Writes the current value of 64-bit MMX Register #6 (MM6).
6815 Writes the current value of MM6. This function is only available on IA32 and
6818 @param Value The 64-bit value to write to MM6.
6829 Writes the current value of 64-bit MMX Register #7 (MM7).
6831 Writes the current value of MM7. This function is only available on IA32 and
6834 @param Value The 64-bit value to write to MM7.
6845 Reads the current value of Time Stamp Counter (TSC).
6847 Reads and returns the current value of TSC. This function is only available
6850 @return The current value of TSC
6861 Reads the current value of a Performance Counter (PMC).
6863 Reads and returns the current value of performance counter specified by
6864 Index. This function is only available on IA-32 and X64.
6866 @param Index The 32-bit Performance Counter index to read.
6868 @return The value of the PMC specified by Index.
6879 Sets up a monitor buffer that is used by AsmMwait().
6881 Executes a MONITOR instruction with the register state specified by Eax, Ecx
6882 and Edx. Returns Eax. This function is only available on IA-32 and X64.
6884 @param Eax The value to load into EAX or RAX before executing the MONITOR
6886 @param Ecx The value to load into ECX or RCX before executing the MONITOR
6888 @param Edx The value to load into EDX or RDX before executing the MONITOR
6904 Executes an MWAIT instruction.
6906 Executes an MWAIT instruction with the register state specified by Eax and
6907 Ecx. Returns Eax. This function is only available on IA-32 and X64.
6909 @param Eax The value to load into EAX or RAX before executing the MONITOR
6911 @param Ecx The value to load into ECX or RCX before executing the MONITOR
6926 Executes a WBINVD instruction.
6928 Executes a WBINVD instruction. This function is only available on IA-32 and
6940 Executes a INVD instruction.
6942 Executes a INVD instruction. This function is only available on IA-32 and
6954 Flushes a cache line from all the instruction and data caches within the
6955 coherency domain of the CPU.
6957 Flushed the cache line specified by LinearAddress, and returns LinearAddress.
6958 This function is only available on IA-32 and X64.
6960 @param LinearAddress The address of the cache line to flush. If the CPU is
6961 in a physical addressing mode, then LinearAddress is a
6962 physical address. If the CPU is in a virtual
6963 addressing mode, then LinearAddress is a virtual
6966 @return LinearAddress
6971 IN VOID
*LinearAddress
6976 Enables the 32-bit paging mode on the CPU.
6978 Enables the 32-bit paging mode on the CPU. CR0, CR3, CR4, and the page tables
6979 must be properly initialized prior to calling this service. This function
6980 assumes the current execution mode is 32-bit protected mode. This function is
6981 only available on IA-32. After the 32-bit paging mode is enabled, control is
6982 transferred to the function specified by EntryPoint using the new stack
6983 specified by NewStack and passing in the parameters specified by Context1 and
6984 Context2. Context1 and Context2 are optional and may be NULL. The function
6985 EntryPoint must never return.
6987 If the current execution mode is not 32-bit protected mode, then ASSERT().
6988 If EntryPoint is NULL, then ASSERT().
6989 If NewStack is NULL, then ASSERT().
6991 There are a number of constraints that must be followed before calling this
6993 1) Interrupts must be disabled.
6994 2) The caller must be in 32-bit protected mode with flat descriptors. This
6995 means all descriptors must have a base of 0 and a limit of 4GB.
6996 3) CR0 and CR4 must be compatible with 32-bit protected mode with flat
6998 4) CR3 must point to valid page tables that will be used once the transition
6999 is complete, and those page tables must guarantee that the pages for this
7000 function and the stack are identity mapped.
7002 @param EntryPoint A pointer to function to call with the new stack after
7004 @param Context1 A pointer to the context to pass into the EntryPoint
7005 function as the first parameter after paging is enabled.
7006 @param Context2 A pointer to the context to pass into the EntryPoint
7007 function as the second parameter after paging is enabled.
7008 @param NewStack A pointer to the new stack to use for the EntryPoint
7009 function after paging is enabled.
7015 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
7016 IN VOID
*Context1
, OPTIONAL
7017 IN VOID
*Context2
, OPTIONAL
7023 Disables the 32-bit paging mode on the CPU.
7025 Disables the 32-bit paging mode on the CPU and returns to 32-bit protected
7026 mode. This function assumes the current execution mode is 32-paged protected
7027 mode. This function is only available on IA-32. After the 32-bit paging mode
7028 is disabled, control is transferred to the function specified by EntryPoint
7029 using the new stack specified by NewStack and passing in the parameters
7030 specified by Context1 and Context2. Context1 and Context2 are optional and
7031 may be NULL. The function EntryPoint must never return.
7033 If the current execution mode is not 32-bit paged mode, then ASSERT().
7034 If EntryPoint is NULL, then ASSERT().
7035 If NewStack is NULL, then ASSERT().
7037 There are a number of constraints that must be followed before calling this
7039 1) Interrupts must be disabled.
7040 2) The caller must be in 32-bit paged mode.
7041 3) CR0, CR3, and CR4 must be compatible with 32-bit paged mode.
7042 4) CR3 must point to valid page tables that guarantee that the pages for
7043 this function and the stack are identity mapped.
7045 @param EntryPoint A pointer to function to call with the new stack after
7047 @param Context1 A pointer to the context to pass into the EntryPoint
7048 function as the first parameter after paging is disabled.
7049 @param Context2 A pointer to the context to pass into the EntryPoint
7050 function as the second parameter after paging is
7052 @param NewStack A pointer to the new stack to use for the EntryPoint
7053 function after paging is disabled.
7058 AsmDisablePaging32 (
7059 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
7060 IN VOID
*Context1
, OPTIONAL
7061 IN VOID
*Context2
, OPTIONAL
7067 Enables the 64-bit paging mode on the CPU.
7069 Enables the 64-bit paging mode on the CPU. CR0, CR3, CR4, and the page tables
7070 must be properly initialized prior to calling this service. This function
7071 assumes the current execution mode is 32-bit protected mode with flat
7072 descriptors. This function is only available on IA-32. After the 64-bit
7073 paging mode is enabled, control is transferred to the function specified by
7074 EntryPoint using the new stack specified by NewStack and passing in the
7075 parameters specified by Context1 and Context2. Context1 and Context2 are
7076 optional and may be 0. The function EntryPoint must never return.
7078 If the current execution mode is not 32-bit protected mode with flat
7079 descriptors, then ASSERT().
7080 If EntryPoint is 0, then ASSERT().
7081 If NewStack is 0, then ASSERT().
7083 @param CodeSelector The 16-bit selector to load in the CS before EntryPoint
7084 is called. The descriptor in the GDT that this selector
7085 references must be setup for long mode.
7086 @param EntryPoint The 64-bit virtual address of the function to call with
7087 the new stack after paging is enabled.
7088 @param Context1 The 64-bit virtual address of the context to pass into
7089 the EntryPoint function as the first parameter after
7091 @param Context2 The 64-bit virtual address of the context to pass into
7092 the EntryPoint function as the second parameter after
7094 @param NewStack The 64-bit virtual address of the new stack to use for
7095 the EntryPoint function after paging is enabled.
7101 IN UINT16 CodeSelector
,
7102 IN UINT64 EntryPoint
,
7103 IN UINT64 Context1
, OPTIONAL
7104 IN UINT64 Context2
, OPTIONAL
7110 Disables the 64-bit paging mode on the CPU.
7112 Disables the 64-bit paging mode on the CPU and returns to 32-bit protected
7113 mode. This function assumes the current execution mode is 64-paging mode.
7114 This function is only available on X64. After the 64-bit paging mode is
7115 disabled, control is transferred to the function specified by EntryPoint
7116 using the new stack specified by NewStack and passing in the parameters
7117 specified by Context1 and Context2. Context1 and Context2 are optional and
7118 may be 0. The function EntryPoint must never return.
7120 If the current execution mode is not 64-bit paged mode, then ASSERT().
7121 If EntryPoint is 0, then ASSERT().
7122 If NewStack is 0, then ASSERT().
7124 @param CodeSelector The 16-bit selector to load in the CS before EntryPoint
7125 is called. The descriptor in the GDT that this selector
7126 references must be setup for 32-bit protected mode.
7127 @param EntryPoint The 64-bit virtual address of the function to call with
7128 the new stack after paging is disabled.
7129 @param Context1 The 64-bit virtual address of the context to pass into
7130 the EntryPoint function as the first parameter after
7132 @param Context2 The 64-bit virtual address of the context to pass into
7133 the EntryPoint function as the second parameter after
7135 @param NewStack The 64-bit virtual address of the new stack to use for
7136 the EntryPoint function after paging is disabled.
7141 AsmDisablePaging64 (
7142 IN UINT16 CodeSelector
,
7143 IN UINT32 EntryPoint
,
7144 IN UINT32 Context1
, OPTIONAL
7145 IN UINT32 Context2
, OPTIONAL
7151 // 16-bit thunking services
7155 Retrieves the properties for 16-bit thunk functions.
7157 Computes the size of the buffer and stack below 1MB required to use the
7158 AsmPrepareThunk16(), AsmThunk16() and AsmPrepareAndThunk16() functions. This
7159 buffer size is returned in RealModeBufferSize, and the stack size is returned
7160 in ExtraStackSize. If parameters are passed to the 16-bit real mode code,
7161 then the actual minimum stack size is ExtraStackSize plus the maximum number
7162 of bytes that need to be passed to the 16-bit real mode code.
7164 If RealModeBufferSize is NULL, then ASSERT().
7165 If ExtraStackSize is NULL, then ASSERT().
7167 @param RealModeBufferSize A pointer to the size of the buffer below 1MB
7168 required to use the 16-bit thunk functions.
7169 @param ExtraStackSize A pointer to the extra size of stack below 1MB
7170 that the 16-bit thunk functions require for
7171 temporary storage in the transition to and from
7177 AsmGetThunk16Properties (
7178 OUT UINT32
*RealModeBufferSize
,
7179 OUT UINT32
*ExtraStackSize
7184 Prepares all structures a code required to use AsmThunk16().
7186 Prepares all structures and code required to use AsmThunk16().
7188 If ThunkContext is NULL, then ASSERT().
7190 @param ThunkContext A pointer to the context structure that describes the
7191 16-bit real mode code to call.
7197 OUT THUNK_CONTEXT
*ThunkContext
7202 Transfers control to a 16-bit real mode entry point and returns the results.
7204 Transfers control to a 16-bit real mode entry point and returns the results.
7205 AsmPrepareThunk16() must be called with ThunkContext before this function is
7208 If ThunkContext is NULL, then ASSERT().
7209 If AsmPrepareThunk16() was not previously called with ThunkContext, then ASSERT().
7211 @param ThunkContext A pointer to the context structure that describes the
7212 16-bit real mode code to call.
7218 IN OUT THUNK_CONTEXT
*ThunkContext
7223 Prepares all structures and code for a 16-bit real mode thunk, transfers
7224 control to a 16-bit real mode entry point, and returns the results.
7226 Prepares all structures and code for a 16-bit real mode thunk, transfers
7227 control to a 16-bit real mode entry point, and returns the results. If the
7228 caller only need to perform a single 16-bit real mode thunk, then this
7229 service should be used. If the caller intends to make more than one 16-bit
7230 real mode thunk, then it is more efficient if AsmPrepareThunk16() is called
7231 once and AsmThunk16() can be called for each 16-bit real mode thunk.
7233 If ThunkContext is NULL, then ASSERT().
7235 @param ThunkContext A pointer to the context structure that describes the
7236 16-bit real mode code to call.
7241 AsmPrepareAndThunk16 (
7242 IN OUT THUNK_CONTEXT
*ThunkContext