2 Provides string functions, linked list functions, math functions, synchronization
3 functions, and CPU architecture specific functions.
5 Copyright (c) 2006 - 2008, Intel Corporation
6 All rights reserved. This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
20 /// Definitions for SPIN_LOCK
22 typedef volatile UINTN SPIN_LOCK
;
25 // Definitions for architecture specific types
27 #if defined (MDE_CPU_IA32)
29 /// IA32 context buffer used by SetJump() and LongJump()
38 } BASE_LIBRARY_JUMP_BUFFER
;
40 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 4
42 #elif defined (MDE_CPU_IPF)
45 /// IPF context buffer used by SetJump() and LongJump()
80 UINT64 AfterSpillUNAT
;
86 } BASE_LIBRARY_JUMP_BUFFER
;
88 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 0x10
90 #elif defined (MDE_CPU_X64)
92 /// X64 context buffer used by SetJump() and LongJump()
105 } BASE_LIBRARY_JUMP_BUFFER
;
107 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 8
109 #elif defined (MDE_CPU_EBC)
111 /// EBC context buffer used by SetJump() and LongJump()
119 } BASE_LIBRARY_JUMP_BUFFER
;
121 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 8
124 #error Unknown Processor Type
132 Copies one Null-terminated Unicode string to another Null-terminated Unicode
133 string and returns the new Unicode string.
135 This function copies the contents of the Unicode string Source to the Unicode
136 string Destination, and returns Destination. If Source and Destination
137 overlap, then the results are undefined.
139 If Destination is NULL, then ASSERT().
140 If Destination is not aligned on a 16-bit boundary, then ASSERT().
141 If Source is NULL, then ASSERT().
142 If Source is not aligned on a 16-bit boundary, then ASSERT().
143 If Source and Destination overlap, then ASSERT().
144 If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
145 PcdMaximumUnicodeStringLength Unicode characters not including the
146 Null-terminator, then ASSERT().
148 @param Destination Pointer to a Null-terminated Unicode string.
149 @param Source Pointer to a Null-terminated Unicode string.
157 OUT CHAR16
*Destination
,
158 IN CONST CHAR16
*Source
163 Copies up to a specified length from one Null-terminated Unicode string to
164 another Null-terminated Unicode string and returns the new Unicode string.
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 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 up to a specified length the contents of two Null-terminated Unicode strings,
286 and 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 up to a specified length one Null-terminated Unicode to the end
365 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 a 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 up to a specified length one Null-terminated ASCII string to another
803 Null-terminated ASCII string and returns the new ASCII string.
805 This function copies the contents of the ASCII string Source to the ASCII
806 string Destination, and returns Destination. At most, Length ASCII characters
807 are copied from Source to Destination. If Length is 0, then Destination is
808 returned unmodified. If Length is greater that the number of ASCII characters
809 in Source, then Destination is padded with Null ASCII characters. If Source
810 and Destination overlap, then the results are undefined.
812 If Destination is NULL, then ASSERT().
813 If Source is NULL, then ASSERT().
814 If Source and Destination overlap, then ASSERT().
815 If PcdMaximumAsciiStringLength is not zero, and Source contains more than
816 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
819 @param Destination Pointer to a Null-terminated ASCII string.
820 @param Source Pointer to a Null-terminated ASCII string.
821 @param Length Maximum number of ASCII characters to copy.
829 OUT CHAR8
*Destination
,
830 IN CONST CHAR8
*Source
,
836 Returns the length of a Null-terminated ASCII string.
838 This function returns the number of ASCII characters in the Null-terminated
839 ASCII string specified by String.
841 If Length > 0 and Destination is NULL, then ASSERT().
842 If Length > 0 and Source is NULL, then ASSERT().
843 If PcdMaximumAsciiStringLength is not zero and String contains more than
844 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
847 @param String Pointer to a Null-terminated ASCII string.
849 @return The length of String.
855 IN CONST CHAR8
*String
860 Returns the size of a Null-terminated ASCII string in bytes, including the
863 This function returns the size, in bytes, of the Null-terminated ASCII string
866 If String is NULL, then ASSERT().
867 If PcdMaximumAsciiStringLength is not zero and String contains more than
868 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
871 @param String Pointer to a Null-terminated ASCII string.
873 @return The size of String.
879 IN CONST CHAR8
*String
884 Compares two Null-terminated ASCII strings, and returns the difference
885 between the first mismatched ASCII characters.
887 This function compares the Null-terminated ASCII string FirstString to the
888 Null-terminated ASCII string SecondString. If FirstString is identical to
889 SecondString, then 0 is returned. Otherwise, the value returned is the first
890 mismatched ASCII character in SecondString subtracted from the first
891 mismatched ASCII character in FirstString.
893 If FirstString is NULL, then ASSERT().
894 If SecondString is NULL, then ASSERT().
895 If PcdMaximumAsciiStringLength is not zero and FirstString contains more than
896 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
898 If PcdMaximumAsciiStringLength is not zero and SecondString contains more
899 than PcdMaximumAsciiStringLength ASCII characters not including the
900 Null-terminator, then ASSERT().
902 @param FirstString Pointer to a Null-terminated ASCII string.
903 @param SecondString Pointer to a Null-terminated ASCII string.
905 @retval ==0 FirstString is identical to SecondString.
906 @retval !=0 FirstString is not identical to SecondString.
912 IN CONST CHAR8
*FirstString
,
913 IN CONST CHAR8
*SecondString
918 Performs a case insensitive comparison of two Null-terminated ASCII strings,
919 and returns the difference between the first mismatched ASCII characters.
921 This function performs a case insensitive comparison of the Null-terminated
922 ASCII string FirstString to the Null-terminated ASCII string SecondString. If
923 FirstString is identical to SecondString, then 0 is returned. Otherwise, the
924 value returned is the first mismatched lower case ASCII character in
925 SecondString subtracted from the first mismatched lower case ASCII character
928 If FirstString is NULL, then ASSERT().
929 If SecondString is NULL, then ASSERT().
930 If PcdMaximumAsciiStringLength is not zero and FirstString contains more than
931 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
933 If PcdMaximumAsciiStringLength is not zero and SecondString contains more
934 than PcdMaximumAsciiStringLength ASCII characters not including the
935 Null-terminator, then ASSERT().
937 @param FirstString Pointer to a Null-terminated ASCII string.
938 @param SecondString Pointer to a Null-terminated ASCII string.
940 @retval ==0 FirstString is identical to SecondString using case insensitive
942 @retval !=0 FirstString is not identical to SecondString using case
943 insensitive comparisons.
949 IN CONST CHAR8
*FirstString
,
950 IN CONST CHAR8
*SecondString
955 Compares two Null-terminated ASCII strings with maximum lengths, and returns
956 the difference between the first mismatched ASCII characters.
958 This function compares the Null-terminated ASCII string FirstString to the
959 Null-terminated ASCII string SecondString. At most, Length ASCII characters
960 will be compared. If Length is 0, then 0 is returned. If FirstString is
961 identical to SecondString, then 0 is returned. Otherwise, the value returned
962 is the first mismatched ASCII character in SecondString subtracted from the
963 first mismatched ASCII character in FirstString.
965 If Length > 0 and FirstString is NULL, then ASSERT().
966 If Length > 0 and SecondString is NULL, then ASSERT().
967 If PcdMaximumAsciiStringLength is not zero and FirstString contains more than
968 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
970 If PcdMaximumAsciiStringLength is not zero and SecondString contains more than
971 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
974 @param FirstString Pointer to a Null-terminated ASCII string.
975 @param SecondString Pointer to a Null-terminated ASCII string.
976 @param Length Maximum number of ASCII characters for compare.
978 @retval ==0 FirstString is identical to SecondString.
979 @retval !=0 FirstString is not identical to SecondString.
985 IN CONST CHAR8
*FirstString
,
986 IN CONST CHAR8
*SecondString
,
992 Concatenates one Null-terminated ASCII string to another Null-terminated
993 ASCII string, and returns the concatenated ASCII string.
995 This function concatenates two Null-terminated ASCII strings. The contents of
996 Null-terminated ASCII string Source are concatenated to the end of Null-
997 terminated ASCII string Destination. The Null-terminated concatenated ASCII
1000 If Destination is NULL, then ASSERT().
1001 If Source is NULL, then ASSERT().
1002 If PcdMaximumAsciiStringLength is not zero and Destination contains more than
1003 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
1005 If PcdMaximumAsciiStringLength is not zero and Source contains more than
1006 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
1008 If PcdMaximumAsciiStringLength is not zero and concatenating Destination and
1009 Source results in a ASCII string with more than PcdMaximumAsciiStringLength
1010 ASCII characters, then ASSERT().
1012 @param Destination Pointer to a Null-terminated ASCII string.
1013 @param Source Pointer to a Null-terminated ASCII string.
1021 IN OUT CHAR8
*Destination
,
1022 IN CONST CHAR8
*Source
1027 Concatenates up to a specified length one Null-terminated ASCII string to
1028 the end of another Null-terminated ASCII string, and returns the
1029 concatenated ASCII string.
1031 This function concatenates two Null-terminated ASCII strings. The contents
1032 of Null-terminated ASCII string Source are concatenated to the end of Null-
1033 terminated ASCII string Destination, and Destination is returned. At most,
1034 Length ASCII characters are concatenated from Source to the end of
1035 Destination, and Destination is always Null-terminated. If Length is 0, then
1036 Destination is returned unmodified. If Source and Destination overlap, then
1037 the results are undefined.
1039 If Length > 0 and Destination is NULL, then ASSERT().
1040 If Length > 0 and Source is NULL, then ASSERT().
1041 If Source and Destination overlap, then ASSERT().
1042 If PcdMaximumAsciiStringLength is not zero, and Destination contains more than
1043 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
1045 If PcdMaximumAsciiStringLength is not zero, and Source contains more than
1046 PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
1048 If PcdMaximumAsciiStringLength is not zero, and concatenating Destination and
1049 Source results in a ASCII string with more than PcdMaximumAsciiStringLength
1050 ASCII characters not including the Null-terminator, then ASSERT().
1052 @param Destination Pointer to a Null-terminated ASCII string.
1053 @param Source Pointer to a Null-terminated ASCII string.
1054 @param Length Maximum number of ASCII characters to concatenate from
1063 IN OUT CHAR8
*Destination
,
1064 IN CONST CHAR8
*Source
,
1070 Returns the first occurance of a Null-terminated ASCII sub-string
1071 in a Null-terminated ASCII string.
1073 This function scans the contents of the ASCII string specified by String
1074 and returns the first occurrence of SearchString. If SearchString is not
1075 found in String, then NULL is returned. If the length of SearchString is zero,
1076 then String is returned.
1078 If String is NULL, then ASSERT().
1079 If SearchString is NULL, then ASSERT().
1081 If PcdMaximumAsciiStringLength is not zero, and SearchString or
1082 String contains more than PcdMaximumAsciiStringLength Unicode characters
1083 not including the Null-terminator, then ASSERT().
1085 @param String Pointer to a Null-terminated ASCII string.
1086 @param SearchString Pointer to a Null-terminated ASCII string to search for.
1088 @retval NULL If the SearchString does not appear in String.
1089 @retval others If there is a match return the first occurrence of SearchingString.
1090 If the lenth of SearchString is zero,return String.
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 INTIALIZE_LIST_HEAD_VARIABLE() or
1387 InitializeListHead(), then ASSERT().
1388 If PcdMaximumLinkedListLenth is not zero, and prior to insertion the number
1389 of nodes in ListHead, including the ListHead node, is greater than or
1390 equal to PcdMaximumLinkedListLength, then ASSERT().
1392 @param ListHead A pointer to the head node of a doubly linked list.
1393 @param Entry A pointer to a node that is to be inserted at the beginning
1394 of a doubly linked list.
1402 IN OUT LIST_ENTRY
*ListHead
,
1403 IN OUT LIST_ENTRY
*Entry
1408 Adds a node to the end of a doubly linked list, and returns the pointer to
1409 the head node of the doubly linked list.
1411 Adds the node Entry to the end of the doubly linked list denoted by ListHead,
1412 and returns ListHead.
1414 If ListHead is NULL, then ASSERT().
1415 If Entry is NULL, then ASSERT().
1416 If ListHead was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or
1417 InitializeListHead(), then ASSERT().
1418 If PcdMaximumLinkedListLenth is not zero, and prior to insertion the number
1419 of nodes in ListHead, including the ListHead node, is greater than or
1420 equal to PcdMaximumLinkedListLength, then ASSERT().
1422 @param ListHead A pointer to the head node of a doubly linked list.
1423 @param Entry A pointer to a node that is to be added at the end of the
1432 IN OUT LIST_ENTRY
*ListHead
,
1433 IN OUT LIST_ENTRY
*Entry
1438 Retrieves the first node of a doubly linked list.
1440 Returns the first node of a doubly linked list. List must have been
1441 initialized with INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead().
1442 If List is empty, then List is returned.
1444 If List is NULL, then ASSERT().
1445 If List was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or
1446 InitializeListHead(), then ASSERT().
1447 If PcdMaximumLinkedListLenth is not zero, and the number of nodes
1448 in List, including the List node, is greater than or equal to
1449 PcdMaximumLinkedListLength, then ASSERT().
1451 @param List A pointer to the head node of a doubly linked list.
1453 @return The first node of a doubly linked list.
1454 @retval NULL The list is empty.
1460 IN CONST LIST_ENTRY
*List
1465 Retrieves the next node of a doubly linked list.
1467 Returns the node of a doubly linked list that follows Node.
1468 List must have been initialized with INTIALIZE_LIST_HEAD_VARIABLE()
1469 or InitializeListHead(). If List is empty, then List is returned.
1471 If List is NULL, then ASSERT().
1472 If Node is NULL, then ASSERT().
1473 If List was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or
1474 InitializeListHead(), then ASSERT().
1475 If PcdMaximumLinkedListLenth is not zero, and List contains more than
1476 PcdMaximumLinkedListLenth nodes, then ASSERT().
1477 If Node is not a node in List, then ASSERT().
1479 @param List A pointer to the head node of a doubly linked list.
1480 @param Node A pointer to a node in the doubly linked list.
1482 @return Pointer to the next node if one exists. Otherwise a null value which
1483 is actually List is returned.
1489 IN CONST LIST_ENTRY
*List
,
1490 IN CONST LIST_ENTRY
*Node
1495 Checks to see if a doubly linked list is empty or not.
1497 Checks to see if the doubly linked list is empty. If the linked list contains
1498 zero nodes, this function returns TRUE. Otherwise, it returns FALSE.
1500 If ListHead is NULL, then ASSERT().
1501 If ListHead was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or
1502 InitializeListHead(), then ASSERT().
1503 If PcdMaximumLinkedListLenth is not zero, and the number of nodes
1504 in List, including the List node, is greater than or equal to
1505 PcdMaximumLinkedListLength, then ASSERT().
1507 @param ListHead A pointer to the head node of a doubly linked list.
1509 @retval TRUE The linked list is empty.
1510 @retval FALSE The linked list is not empty.
1516 IN CONST LIST_ENTRY
*ListHead
1521 Determines if a node in a doubly linked list is the head node of a the same
1522 doubly linked list. This function is typically used to terminate a loop that
1523 traverses all the nodes in a doubly linked list starting with the head node.
1525 Returns TRUE if Node is equal to List. Returns FALSE if Node is one of the
1526 nodes in the doubly linked list specified by List. List must have been
1527 initialized with INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead().
1529 If List is NULL, then ASSERT().
1530 If Node is NULL, then ASSERT().
1531 If List was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead(),
1533 If PcdMaximumLinkedListLenth is not zero, and the number of nodes
1534 in List, including the List node, is greater than or equal to
1535 PcdMaximumLinkedListLength, then ASSERT().
1536 If Node is not a node in List and Node is not equal to List, then ASSERT().
1538 @param List A pointer to the head node of a doubly linked list.
1539 @param Node A pointer to a node in the doubly linked list.
1541 @retval TRUE Node is one of the nodes in the doubly linked list.
1542 @retval FALSE Node is not one of the nodes in the doubly linked list.
1548 IN CONST LIST_ENTRY
*List
,
1549 IN CONST LIST_ENTRY
*Node
1554 Determines if a node the last node in a doubly linked list.
1556 Returns TRUE if Node is the last node in the doubly linked list specified by
1557 List. Otherwise, FALSE is returned. List must have been initialized with
1558 INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead().
1560 If List is NULL, then ASSERT().
1561 If Node is NULL, then ASSERT().
1562 If List was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or
1563 InitializeListHead(), then ASSERT().
1564 If PcdMaximumLinkedListLenth is not zero, and the number of nodes
1565 in List, including the List node, is greater than or equal to
1566 PcdMaximumLinkedListLength, then ASSERT().
1567 If Node is not a node in List, then ASSERT().
1569 @param List A pointer to the head node of a doubly linked list.
1570 @param Node A pointer to a node in the doubly linked list.
1572 @retval TRUE Node is the last node in the linked list.
1573 @retval FALSE Node is not the last node in the linked list.
1579 IN CONST LIST_ENTRY
*List
,
1580 IN CONST LIST_ENTRY
*Node
1585 Swaps the location of two nodes in a doubly linked list, and returns the
1586 first node after the swap.
1588 If FirstEntry is identical to SecondEntry, then SecondEntry is returned.
1589 Otherwise, the location of the FirstEntry node is swapped with the location
1590 of the SecondEntry node in a doubly linked list. SecondEntry must be in the
1591 same double linked list as FirstEntry and that double linked list must have
1592 been initialized with INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead().
1593 SecondEntry is returned after the nodes are swapped.
1595 If FirstEntry is NULL, then ASSERT().
1596 If SecondEntry is NULL, then ASSERT().
1597 If SecondEntry and FirstEntry are not in the same linked list, then ASSERT().
1598 If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
1599 linked list containing the FirstEntry and SecondEntry nodes, including
1600 the FirstEntry and SecondEntry nodes, is greater than or equal to
1601 PcdMaximumLinkedListLength, then ASSERT().
1603 @param FirstEntry A pointer to a node in a linked list.
1604 @param SecondEntry A pointer to another node in the same linked list.
1612 IN OUT LIST_ENTRY
*FirstEntry
,
1613 IN OUT LIST_ENTRY
*SecondEntry
1618 Removes a node from a doubly linked list, and returns the node that follows
1621 Removes the node Entry from a doubly linked list. It is up to the caller of
1622 this function to release the memory used by this node if that is required. On
1623 exit, the node following Entry in the doubly linked list is returned. If
1624 Entry is the only node in the linked list, then the head node of the linked
1627 If Entry is NULL, then ASSERT().
1628 If Entry is the head node of an empty list, then ASSERT().
1629 If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
1630 linked list containing Entry, including the Entry node, is greater than
1631 or equal to PcdMaximumLinkedListLength, then ASSERT().
1633 @param Entry A pointer to a node in a linked list
1641 IN CONST LIST_ENTRY
*Entry
1649 Shifts a 64-bit integer left between 0 and 63 bits. The low bits are filled
1650 with zeros. The shifted value is returned.
1652 This function shifts the 64-bit value Operand to the left by Count bits. The
1653 low Count bits are set to zero. The shifted value is returned.
1655 If Count is greater than 63, then ASSERT().
1657 @param Operand The 64-bit operand to shift left.
1658 @param Count The number of bits to shift left.
1660 @return Operand << Count
1672 Shifts a 64-bit integer right between 0 and 63 bits. This high bits are
1673 filled with zeros. The shifted value is returned.
1675 This function shifts the 64-bit value Operand to the right by Count bits. The
1676 high Count bits are set to zero. The shifted value is returned.
1678 If Count is greater than 63, then ASSERT().
1680 @param Operand The 64-bit operand to shift right.
1681 @param Count The number of bits to shift right.
1683 @return Operand >> Count
1695 Shifts a 64-bit integer right between 0 and 63 bits. The high bits are filled
1696 with original integer's bit 63. The shifted value is returned.
1698 This function shifts the 64-bit value Operand to the right by Count bits. The
1699 high Count bits are set to bit 63 of Operand. The shifted value is returned.
1701 If Count is greater than 63, then ASSERT().
1703 @param Operand The 64-bit operand to shift right.
1704 @param Count The number of bits to shift right.
1706 @return Operand >> Count
1718 Rotates a 32-bit integer left between 0 and 31 bits, filling the low bits
1719 with the high bits that were rotated.
1721 This function rotates the 32-bit value Operand to the left by Count bits. The
1722 low Count bits are fill with the high Count bits of Operand. The rotated
1725 If Count is greater than 31, then ASSERT().
1727 @param Operand The 32-bit operand to rotate left.
1728 @param Count The number of bits to rotate left.
1730 @return Operand << Count
1742 Rotates a 32-bit integer right between 0 and 31 bits, filling the high bits
1743 with the low bits that were rotated.
1745 This function rotates the 32-bit value Operand to the right by Count bits.
1746 The high Count bits are fill with the low Count bits of Operand. The rotated
1749 If Count is greater than 31, then ASSERT().
1751 @param Operand The 32-bit operand to rotate right.
1752 @param Count The number of bits to rotate right.
1754 @return Operand >>> Count
1766 Rotates a 64-bit integer left between 0 and 63 bits, filling the low bits
1767 with the high bits that were rotated.
1769 This function rotates the 64-bit value Operand to the left by Count bits. The
1770 low Count bits are fill with the high Count bits of Operand. The rotated
1773 If Count is greater than 63, then ASSERT().
1775 @param Operand The 64-bit operand to rotate left.
1776 @param Count The number of bits to rotate left.
1778 @return Operand << Count
1790 Rotates a 64-bit integer right between 0 and 63 bits, filling the high bits
1791 with the high low bits that were rotated.
1793 This function rotates the 64-bit value Operand to the right by Count bits.
1794 The high Count bits are fill with the low Count bits of Operand. The rotated
1797 If Count is greater than 63, then ASSERT().
1799 @param Operand The 64-bit operand to rotate right.
1800 @param Count The number of bits to rotate right.
1802 @return Operand >> Count
1814 Returns the bit position of the lowest bit set in a 32-bit value.
1816 This function computes the bit position of the lowest bit set in the 32-bit
1817 value specified by Operand. If Operand is zero, then -1 is returned.
1818 Otherwise, a value between 0 and 31 is returned.
1820 @param Operand The 32-bit operand to evaluate.
1822 @retval 0-31 The lowest bit set in Operand was found.
1823 @retval -1 Operand is zero.
1834 Returns the bit position of the lowest bit set in a 64-bit value.
1836 This function computes the bit position of the lowest bit set in the 64-bit
1837 value specified by Operand. If Operand is zero, then -1 is returned.
1838 Otherwise, a value between 0 and 63 is returned.
1840 @param Operand The 64-bit operand to evaluate.
1842 @retval 0-63 The lowest bit set in Operand was found.
1843 @retval -1 Operand is zero.
1855 Returns the bit position of the highest bit set in a 32-bit value. Equivalent
1858 This function computes the bit position of the highest bit set in the 32-bit
1859 value specified by Operand. If Operand is zero, then -1 is returned.
1860 Otherwise, a value between 0 and 31 is returned.
1862 @param Operand The 32-bit operand to evaluate.
1864 @retval 0-31 Position of the highest bit set in Operand if found.
1865 @retval -1 Operand is zero.
1876 Returns the bit position of the highest bit set in a 64-bit value. Equivalent
1879 This function computes the bit position of the highest bit set in the 64-bit
1880 value specified by Operand. If Operand is zero, then -1 is returned.
1881 Otherwise, a value between 0 and 63 is returned.
1883 @param Operand The 64-bit operand to evaluate.
1885 @retval 0-63 Position of the highest bit set in Operand if found.
1886 @retval -1 Operand is zero.
1897 Returns the value of the highest bit set in a 32-bit value. Equivalent to
1900 This function computes the value of the highest bit set in the 32-bit value
1901 specified by Operand. If Operand is zero, then zero is returned.
1903 @param Operand The 32-bit operand to evaluate.
1905 @return 1 << HighBitSet32(Operand)
1906 @retval 0 Operand is zero.
1917 Returns the value of the highest bit set in a 64-bit value. Equivalent to
1920 This function computes the value of the highest bit set in the 64-bit value
1921 specified by Operand. If Operand is zero, then zero is returned.
1923 @param Operand The 64-bit operand to evaluate.
1925 @return 1 << HighBitSet64(Operand)
1926 @retval 0 Operand is zero.
1937 Switches the endianess of a 16-bit integer.
1939 This function swaps the bytes in a 16-bit unsigned value to switch the value
1940 from little endian to big endian or vice versa. The byte swapped value is
1943 @param Value Operand A 16-bit unsigned value.
1945 @return The byte swapped Operand.
1956 Switches the endianess of a 32-bit integer.
1958 This function swaps the bytes in a 32-bit unsigned value to switch the value
1959 from little endian to big endian or vice versa. The byte swapped value is
1962 @param Value Operand A 32-bit unsigned value.
1964 @return The byte swapped Operand.
1975 Switches the endianess of a 64-bit integer.
1977 This function swaps the bytes in a 64-bit unsigned value to switch the value
1978 from little endian to big endian or vice versa. The byte swapped value is
1981 @param Value Operand A 64-bit unsigned value.
1983 @return The byte swapped Operand.
1994 Multiples a 64-bit unsigned integer by a 32-bit unsigned integer and
1995 generates a 64-bit unsigned result.
1997 This function multiples the 64-bit unsigned value Multiplicand by the 32-bit
1998 unsigned value Multiplier and generates a 64-bit unsigned result. This 64-
1999 bit unsigned result is returned.
2001 If the result overflows, then ASSERT().
2003 @param Multiplicand A 64-bit unsigned value.
2004 @param Multiplier A 32-bit unsigned value.
2006 @return Multiplicand * Multiplier
2012 IN UINT64 Multiplicand
,
2013 IN UINT32 Multiplier
2018 Multiples a 64-bit unsigned integer by a 64-bit unsigned integer and
2019 generates a 64-bit unsigned result.
2021 This function multiples the 64-bit unsigned value Multiplicand by the 64-bit
2022 unsigned value Multiplier and generates a 64-bit unsigned result. This 64-
2023 bit unsigned result is returned.
2025 If the result overflows, then ASSERT().
2027 @param Multiplicand A 64-bit unsigned value.
2028 @param Multiplier A 64-bit unsigned value.
2030 @return Multiplicand * Multiplier
2036 IN UINT64 Multiplicand
,
2037 IN UINT64 Multiplier
2042 Multiples a 64-bit signed integer by a 64-bit signed integer and generates a
2043 64-bit signed result.
2045 This function multiples the 64-bit signed value Multiplicand by the 64-bit
2046 signed value Multiplier and generates a 64-bit signed result. This 64-bit
2047 signed result is returned.
2049 If the result overflows, then ASSERT().
2051 @param Multiplicand A 64-bit signed value.
2052 @param Multiplier A 64-bit signed value.
2054 @return Multiplicand * Multiplier
2060 IN INT64 Multiplicand
,
2066 Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates
2067 a 64-bit unsigned result.
2069 This function divides the 64-bit unsigned value Dividend by the 32-bit
2070 unsigned value Divisor and generates a 64-bit unsigned quotient. This
2071 function returns the 64-bit unsigned quotient.
2073 If Divisor is 0, then ASSERT().
2075 @param Dividend A 64-bit unsigned value.
2076 @param Divisor A 32-bit unsigned value.
2078 @return Dividend / Divisor
2090 Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates
2091 a 32-bit unsigned remainder.
2093 This function divides the 64-bit unsigned value Dividend by the 32-bit
2094 unsigned value Divisor and generates a 32-bit remainder. This function
2095 returns the 32-bit unsigned remainder.
2097 If Divisor is 0, then ASSERT().
2099 @param Dividend A 64-bit unsigned value.
2100 @param Divisor A 32-bit unsigned value.
2102 @return Dividend % Divisor
2114 Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates
2115 a 64-bit unsigned result and an optional 32-bit unsigned remainder.
2117 This function divides the 64-bit unsigned value Dividend by the 32-bit
2118 unsigned value Divisor and generates a 64-bit unsigned quotient. If Remainder
2119 is not NULL, then the 32-bit unsigned remainder is returned in Remainder.
2120 This function returns the 64-bit unsigned quotient.
2122 If Divisor is 0, then ASSERT().
2124 @param Dividend A 64-bit unsigned value.
2125 @param Divisor A 32-bit unsigned value.
2126 @param Remainder A pointer to a 32-bit unsigned value. This parameter is
2127 optional and may be NULL.
2129 @return Dividend / Divisor
2134 DivU64x32Remainder (
2137 OUT UINT32
*Remainder OPTIONAL
2142 Divides a 64-bit unsigned integer by a 64-bit unsigned integer and generates
2143 a 64-bit unsigned result and an optional 64-bit unsigned remainder.
2145 This function divides the 64-bit unsigned value Dividend by the 64-bit
2146 unsigned value Divisor and generates a 64-bit unsigned quotient. If Remainder
2147 is not NULL, then the 64-bit unsigned remainder is returned in Remainder.
2148 This function returns the 64-bit unsigned quotient.
2150 If Divisor is 0, then ASSERT().
2152 @param Dividend A 64-bit unsigned value.
2153 @param Divisor A 64-bit unsigned value.
2154 @param Remainder A pointer to a 64-bit unsigned value. This parameter is
2155 optional and may be NULL.
2157 @return Dividend / Divisor
2162 DivU64x64Remainder (
2165 OUT UINT64
*Remainder OPTIONAL
2170 Divides a 64-bit signed integer by a 64-bit signed integer and generates a
2171 64-bit signed result and a optional 64-bit signed remainder.
2173 This function divides the 64-bit signed value Dividend by the 64-bit signed
2174 value Divisor and generates a 64-bit signed quotient. If Remainder is not
2175 NULL, then the 64-bit signed remainder is returned in Remainder. This
2176 function returns the 64-bit signed quotient.
2178 It is the caller¡¯s responsibility to not call this function with a Divisor of 0.
2179 If Divisor is 0, then the quotient and remainder should be assumed to be
2180 the largest negative integer.
2182 If Divisor is 0, then ASSERT().
2184 @param Dividend A 64-bit signed value.
2185 @param Divisor A 64-bit signed value.
2186 @param Remainder A pointer to a 64-bit signed value. This parameter is
2187 optional and may be NULL.
2189 @return Dividend / Divisor
2194 DivS64x64Remainder (
2197 OUT INT64
*Remainder OPTIONAL
2202 Reads a 16-bit value from memory that may be unaligned.
2204 This function returns the 16-bit value pointed to by Buffer. The function
2205 guarantees that the read operation does not produce an alignment fault.
2207 If the Buffer is NULL, then ASSERT().
2209 @param Buffer Pointer to a 16-bit value that may be unaligned.
2211 @return The 16-bit value read from Buffer.
2217 IN CONST UINT16
*Buffer
2222 Writes a 16-bit value to memory that may be unaligned.
2224 This function writes the 16-bit value specified by Value to Buffer. Value is
2225 returned. The function guarantees that the write operation does not produce
2228 If the Buffer is NULL, then ASSERT().
2230 @param Buffer Pointer to a 16-bit value that may be unaligned.
2231 @param Value 16-bit value to write to Buffer.
2233 @return The 16-bit value to write to Buffer.
2245 Reads a 24-bit value from memory that may be unaligned.
2247 This function returns the 24-bit value pointed to by Buffer. The function
2248 guarantees that the read operation does not produce an alignment fault.
2250 If the Buffer is NULL, then ASSERT().
2252 @param Buffer Pointer to a 24-bit value that may be unaligned.
2254 @return The 24-bit value read from Buffer.
2260 IN CONST UINT32
*Buffer
2265 Writes a 24-bit value to memory that may be unaligned.
2267 This function writes the 24-bit value specified by Value to Buffer. Value is
2268 returned. The function guarantees that the write operation does not produce
2271 If the Buffer is NULL, then ASSERT().
2273 @param Buffer Pointer to a 24-bit value that may be unaligned.
2274 @param Value 24-bit value to write to Buffer.
2276 @return The 24-bit value to write to Buffer.
2288 Reads a 32-bit value from memory that may be unaligned.
2290 This function returns the 32-bit value pointed to by Buffer. The function
2291 guarantees that the read operation does not produce an alignment fault.
2293 If the Buffer is NULL, then ASSERT().
2295 @param Buffer Pointer to a 32-bit value that may be unaligned.
2297 @return The 32-bit value read from Buffer.
2303 IN CONST UINT32
*Buffer
2308 Writes a 32-bit value to memory that may be unaligned.
2310 This function writes the 32-bit value specified by Value to Buffer. Value is
2311 returned. The function guarantees that the write operation does not produce
2314 If the Buffer is NULL, then ASSERT().
2316 @param Buffer Pointer to a 32-bit value that may be unaligned.
2317 @param Value 32-bit value to write to Buffer.
2319 @return The 32-bit value to write to Buffer.
2331 Reads a 64-bit value from memory that may be unaligned.
2333 This function returns the 64-bit value pointed to by Buffer. The function
2334 guarantees that the read operation does not produce an alignment fault.
2336 If the Buffer is NULL, then ASSERT().
2338 @param Buffer Pointer to a 64-bit value that may be unaligned.
2340 @return The 64-bit value read from Buffer.
2346 IN CONST UINT64
*Buffer
2351 Writes a 64-bit value to memory that may be unaligned.
2353 This function writes the 64-bit value specified by Value to Buffer. Value is
2354 returned. The function guarantees that the write operation does not produce
2357 If the Buffer is NULL, then ASSERT().
2359 @param Buffer Pointer to a 64-bit value that may be unaligned.
2360 @param Value 64-bit value to write to Buffer.
2362 @return The 64-bit value to write to Buffer.
2374 // Bit Field Functions
2378 Returns a bit field from an 8-bit value.
2380 Returns the bitfield specified by the StartBit and the EndBit from Operand.
2382 If 8-bit operations are not supported, then ASSERT().
2383 If StartBit is greater than 7, then ASSERT().
2384 If EndBit is greater than 7, then ASSERT().
2385 If EndBit is less than StartBit, then ASSERT().
2387 @param Operand Operand on which to perform the bitfield operation.
2388 @param StartBit The ordinal of the least significant bit in the bit field.
2390 @param EndBit The ordinal of the most significant bit in the bit field.
2393 @return The bit field read.
2406 Writes a bit field to an 8-bit value, and returns the result.
2408 Writes Value to the bit field specified by the StartBit and the EndBit in
2409 Operand. All other bits in Operand are preserved. The new 8-bit value is
2412 If 8-bit operations are not supported, then ASSERT().
2413 If StartBit is greater than 7, then ASSERT().
2414 If EndBit is greater than 7, then ASSERT().
2415 If EndBit is less than StartBit, then ASSERT().
2417 @param Operand Operand on which to perform the bitfield operation.
2418 @param StartBit The ordinal of the least significant bit in the bit field.
2420 @param EndBit The ordinal of the most significant bit in the bit field.
2422 @param Value New value of the bit field.
2424 @return The new 8-bit value.
2438 Reads a bit field from an 8-bit value, performs a bitwise OR, and returns the
2441 Performs a bitwise inclusive OR between the bit field specified by StartBit
2442 and EndBit in Operand and the value specified by OrData. All other bits in
2443 Operand are preserved. The new 8-bit value is returned.
2445 If 8-bit operations are not supported, then ASSERT().
2446 If StartBit is greater than 7, then ASSERT().
2447 If EndBit is greater than 7, then ASSERT().
2448 If EndBit is less than StartBit, then ASSERT().
2450 @param Operand Operand on which to perform the bitfield operation.
2451 @param StartBit The ordinal of the least significant bit in the bit field.
2453 @param EndBit The ordinal of the most significant bit in the bit field.
2455 @param OrData The value to OR with the read value from the value
2457 @return The new 8-bit value.
2471 Reads a bit field from an 8-bit value, performs a bitwise AND, and returns
2474 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2475 in Operand and the value specified by AndData. All other bits in Operand are
2476 preserved. The new 8-bit value is returned.
2478 If 8-bit operations are not supported, then ASSERT().
2479 If StartBit is greater than 7, then ASSERT().
2480 If EndBit is greater than 7, then ASSERT().
2481 If EndBit is less than StartBit, then ASSERT().
2483 @param Operand Operand on which to perform the bitfield operation.
2484 @param StartBit The ordinal of the least significant bit in the bit field.
2486 @param EndBit The ordinal of the most significant bit in the bit field.
2488 @param AndData The value to AND with the read value from the value.
2490 @return The new 8-bit value.
2504 Reads a bit field from an 8-bit value, performs a bitwise AND followed by a
2505 bitwise OR, and returns the result.
2507 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2508 in Operand and the value specified by AndData, followed by a bitwise
2509 inclusive OR with value specified by OrData. All other bits in Operand are
2510 preserved. The new 8-bit value is returned.
2512 If 8-bit operations are not supported, then ASSERT().
2513 If StartBit is greater than 7, then ASSERT().
2514 If EndBit is greater than 7, then ASSERT().
2515 If EndBit is less than StartBit, then ASSERT().
2517 @param Operand Operand on which to perform the bitfield operation.
2518 @param StartBit The ordinal of the least significant bit in the bit field.
2520 @param EndBit The ordinal of the most significant bit in the bit field.
2522 @param AndData The value to AND with the read value from the value.
2523 @param OrData The value to OR with the result of the AND operation.
2525 @return The new 8-bit value.
2530 BitFieldAndThenOr8 (
2540 Returns a bit field from a 16-bit value.
2542 Returns the bitfield specified by the StartBit and the EndBit from Operand.
2544 If 16-bit operations are not supported, then ASSERT().
2545 If StartBit is greater than 15, then ASSERT().
2546 If EndBit is greater than 15, then ASSERT().
2547 If EndBit is less than StartBit, then ASSERT().
2549 @param Operand Operand on which to perform the bitfield operation.
2550 @param StartBit The ordinal of the least significant bit in the bit field.
2552 @param EndBit The ordinal of the most significant bit in the bit field.
2555 @return The bit field read.
2568 Writes a bit field to a 16-bit value, and returns the result.
2570 Writes Value to the bit field specified by the StartBit and the EndBit in
2571 Operand. All other bits in Operand are preserved. The new 16-bit value is
2574 If 16-bit operations are not supported, then ASSERT().
2575 If StartBit is greater than 15, then ASSERT().
2576 If EndBit is greater than 15, then ASSERT().
2577 If EndBit is less than StartBit, then ASSERT().
2579 @param Operand Operand on which to perform the bitfield operation.
2580 @param StartBit The ordinal of the least significant bit in the bit field.
2582 @param EndBit The ordinal of the most significant bit in the bit field.
2584 @param Value New value of the bit field.
2586 @return The new 16-bit value.
2600 Reads a bit field from a 16-bit value, performs a bitwise OR, and returns the
2603 Performs a bitwise inclusive OR between the bit field specified by StartBit
2604 and EndBit in Operand and the value specified by OrData. All other bits in
2605 Operand are preserved. The new 16-bit value is returned.
2607 If 16-bit operations are not supported, then ASSERT().
2608 If StartBit is greater than 15, then ASSERT().
2609 If EndBit is greater than 15, then ASSERT().
2610 If EndBit is less than StartBit, then ASSERT().
2612 @param Operand Operand on which to perform the bitfield operation.
2613 @param StartBit The ordinal of the least significant bit in the bit field.
2615 @param EndBit The ordinal of the most significant bit in the bit field.
2617 @param OrData The value to OR with the read value from the value
2619 @return The new 16-bit value.
2633 Reads a bit field from a 16-bit value, performs a bitwise AND, and returns
2636 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2637 in Operand and the value specified by AndData. All other bits in Operand are
2638 preserved. The new 16-bit value is returned.
2640 If 16-bit operations are not supported, then ASSERT().
2641 If StartBit is greater than 15, then ASSERT().
2642 If EndBit is greater than 15, then ASSERT().
2643 If EndBit is less than StartBit, then ASSERT().
2645 @param Operand Operand on which to perform the bitfield operation.
2646 @param StartBit The ordinal of the least significant bit in the bit field.
2648 @param EndBit The ordinal of the most significant bit in the bit field.
2650 @param AndData The value to AND with the read value from the value
2652 @return The new 16-bit value.
2666 Reads a bit field from a 16-bit value, performs a bitwise AND followed by a
2667 bitwise OR, and returns the result.
2669 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2670 in Operand and the value specified by AndData, followed by a bitwise
2671 inclusive OR with value specified by OrData. All other bits in Operand are
2672 preserved. The new 16-bit value is returned.
2674 If 16-bit operations are not supported, then ASSERT().
2675 If StartBit is greater than 15, then ASSERT().
2676 If EndBit is greater than 15, then ASSERT().
2677 If EndBit is less than StartBit, then ASSERT().
2679 @param Operand Operand on which to perform the bitfield operation.
2680 @param StartBit The ordinal of the least significant bit in the bit field.
2682 @param EndBit The ordinal of the most significant bit in the bit field.
2684 @param AndData The value to AND with the read value from the value.
2685 @param OrData The value to OR with the result of the AND operation.
2687 @return The new 16-bit value.
2692 BitFieldAndThenOr16 (
2702 Returns a bit field from a 32-bit value.
2704 Returns the bitfield specified by the StartBit and the EndBit from Operand.
2706 If 32-bit operations are not supported, then ASSERT().
2707 If StartBit is greater than 31, then ASSERT().
2708 If EndBit is greater than 31, then ASSERT().
2709 If EndBit is less than StartBit, then ASSERT().
2711 @param Operand Operand on which to perform the bitfield operation.
2712 @param StartBit The ordinal of the least significant bit in the bit field.
2714 @param EndBit The ordinal of the most significant bit in the bit field.
2717 @return The bit field read.
2730 Writes a bit field to a 32-bit value, and returns the result.
2732 Writes Value to the bit field specified by the StartBit and the EndBit in
2733 Operand. All other bits in Operand are preserved. The new 32-bit value is
2736 If 32-bit operations are not supported, then ASSERT().
2737 If StartBit is greater than 31, then ASSERT().
2738 If EndBit is greater than 31, then ASSERT().
2739 If EndBit is less than StartBit, then ASSERT().
2741 @param Operand Operand on which to perform the bitfield operation.
2742 @param StartBit The ordinal of the least significant bit in the bit field.
2744 @param EndBit The ordinal of the most significant bit in the bit field.
2746 @param Value New value of the bit field.
2748 @return The new 32-bit value.
2762 Reads a bit field from a 32-bit value, performs a bitwise OR, and returns the
2765 Performs a bitwise inclusive OR between the bit field specified by StartBit
2766 and EndBit in Operand and the value specified by OrData. All other bits in
2767 Operand are preserved. The new 32-bit value is returned.
2769 If 32-bit operations are not supported, then ASSERT().
2770 If StartBit is greater than 31, then ASSERT().
2771 If EndBit is greater than 31, then ASSERT().
2772 If EndBit is less than StartBit, then ASSERT().
2774 @param Operand Operand on which to perform the bitfield operation.
2775 @param StartBit The ordinal of the least significant bit in the bit field.
2777 @param EndBit The ordinal of the most significant bit in the bit field.
2779 @param OrData The value to OR with the read value from the value
2781 @return The new 32-bit value.
2795 Reads a bit field from a 32-bit value, performs a bitwise AND, and returns
2798 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2799 in Operand and the value specified by AndData. All other bits in Operand are
2800 preserved. The new 32-bit value is returned.
2802 If 32-bit operations are not supported, then ASSERT().
2803 If StartBit is greater than 31, then ASSERT().
2804 If EndBit is greater than 31, then ASSERT().
2805 If EndBit is less than StartBit, then ASSERT().
2807 @param Operand Operand on which to perform the bitfield operation.
2808 @param StartBit The ordinal of the least significant bit in the bit field.
2810 @param EndBit The ordinal of the most significant bit in the bit field.
2812 @param AndData The value to AND with the read value from the value
2814 @return The new 32-bit value.
2828 Reads a bit field from a 32-bit value, performs a bitwise AND followed by a
2829 bitwise OR, and returns the result.
2831 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2832 in Operand and the value specified by AndData, followed by a bitwise
2833 inclusive OR with value specified by OrData. All other bits in Operand are
2834 preserved. The new 32-bit value is returned.
2836 If 32-bit operations are not supported, then ASSERT().
2837 If StartBit is greater than 31, then ASSERT().
2838 If EndBit is greater than 31, then ASSERT().
2839 If EndBit is less than StartBit, then ASSERT().
2841 @param Operand Operand on which to perform the bitfield operation.
2842 @param StartBit The ordinal of the least significant bit in the bit field.
2844 @param EndBit The ordinal of the most significant bit in the bit field.
2846 @param AndData The value to AND with the read value from the value.
2847 @param OrData The value to OR with the result of the AND operation.
2849 @return The new 32-bit value.
2854 BitFieldAndThenOr32 (
2864 Returns a bit field from a 64-bit value.
2866 Returns the bitfield specified by the StartBit and the EndBit from Operand.
2868 If 64-bit operations are not supported, then ASSERT().
2869 If StartBit is greater than 63, then ASSERT().
2870 If EndBit is greater than 63, then ASSERT().
2871 If EndBit is less than StartBit, then ASSERT().
2873 @param Operand Operand on which to perform the bitfield operation.
2874 @param StartBit The ordinal of the least significant bit in the bit field.
2876 @param EndBit The ordinal of the most significant bit in the bit field.
2879 @return The bit field read.
2892 Writes a bit field to a 64-bit value, and returns the result.
2894 Writes Value to the bit field specified by the StartBit and the EndBit in
2895 Operand. All other bits in Operand are preserved. The new 64-bit value is
2898 If 64-bit operations are not supported, then ASSERT().
2899 If StartBit is greater than 63, then ASSERT().
2900 If EndBit is greater than 63, then ASSERT().
2901 If EndBit is less than StartBit, then ASSERT().
2903 @param Operand Operand on which to perform the bitfield operation.
2904 @param StartBit The ordinal of the least significant bit in the bit field.
2906 @param EndBit The ordinal of the most significant bit in the bit field.
2908 @param Value New value of the bit field.
2910 @return The new 64-bit value.
2924 Reads a bit field from a 64-bit value, performs a bitwise OR, and returns the
2927 Performs a bitwise inclusive OR between the bit field specified by StartBit
2928 and EndBit in Operand and the value specified by OrData. All other bits in
2929 Operand are preserved. The new 64-bit value is returned.
2931 If 64-bit operations are not supported, then ASSERT().
2932 If StartBit is greater than 63, then ASSERT().
2933 If EndBit is greater than 63, then ASSERT().
2934 If EndBit is less than StartBit, then ASSERT().
2936 @param Operand Operand on which to perform the bitfield operation.
2937 @param StartBit The ordinal of the least significant bit in the bit field.
2939 @param EndBit The ordinal of the most significant bit in the bit field.
2941 @param OrData The value to OR with the read value from the value
2943 @return The new 64-bit value.
2957 Reads a bit field from a 64-bit value, performs a bitwise AND, and returns
2960 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2961 in Operand and the value specified by AndData. All other bits in Operand are
2962 preserved. The new 64-bit value is returned.
2964 If 64-bit operations are not supported, then ASSERT().
2965 If StartBit is greater than 63, then ASSERT().
2966 If EndBit is greater than 63, then ASSERT().
2967 If EndBit is less than StartBit, then ASSERT().
2969 @param Operand Operand on which to perform the bitfield operation.
2970 @param StartBit The ordinal of the least significant bit in the bit field.
2972 @param EndBit The ordinal of the most significant bit in the bit field.
2974 @param AndData The value to AND with the read value from the value
2976 @return The new 64-bit value.
2990 Reads a bit field from a 64-bit value, performs a bitwise AND followed by a
2991 bitwise OR, and returns the result.
2993 Performs a bitwise AND between the bit field specified by StartBit and EndBit
2994 in Operand and the value specified by AndData, followed by a bitwise
2995 inclusive OR with value specified by OrData. All other bits in Operand are
2996 preserved. The new 64-bit value is returned.
2998 If 64-bit operations are not supported, then ASSERT().
2999 If StartBit is greater than 63, then ASSERT().
3000 If EndBit is greater than 63, then ASSERT().
3001 If EndBit is less than StartBit, then ASSERT().
3003 @param Operand Operand on which to perform the bitfield operation.
3004 @param StartBit The ordinal of the least significant bit in the bit field.
3006 @param EndBit The ordinal of the most significant bit in the bit field.
3008 @param AndData The value to AND with the read value from the value.
3009 @param OrData The value to OR with the result of the AND operation.
3011 @return The new 64-bit value.
3016 BitFieldAndThenOr64 (
3026 // Base Library Synchronization Functions
3030 Retrieves the architecture specific spin lock alignment requirements for
3031 optimal spin lock performance.
3033 This function retrieves the spin lock alignment requirements for optimal
3034 performance on a given CPU architecture. The spin lock alignment must be a
3035 power of two and is returned by this function. If there are no alignment
3036 requirements, then 1 must be returned. The spin lock synchronization
3037 functions must function correctly if the spin lock size and alignment values
3038 returned by this function are not used at all. These values are hints to the
3039 consumers of the spin lock synchronization functions to obtain optimal spin
3042 @return The architecture specific spin lock alignment.
3047 GetSpinLockProperties (
3053 Initializes a spin lock to the released state and returns the spin lock.
3055 This function initializes the spin lock specified by SpinLock to the released
3056 state, and returns SpinLock. Optimal performance can be achieved by calling
3057 GetSpinLockProperties() to determine the size and alignment requirements for
3060 If SpinLock is NULL, then ASSERT().
3062 @param SpinLock A pointer to the spin lock to initialize to the released
3065 @return SpinLock in release state.
3070 InitializeSpinLock (
3071 OUT SPIN_LOCK
*SpinLock
3076 Waits until a spin lock can be placed in the acquired state.
3078 This function checks the state of the spin lock specified by SpinLock. If
3079 SpinLock is in the released state, then this function places SpinLock in the
3080 acquired state and returns SpinLock. Otherwise, this function waits
3081 indefinitely for the spin lock to be released, and then places it in the
3082 acquired state and returns SpinLock. All state transitions of SpinLock must
3083 be performed using MP safe mechanisms.
3085 If SpinLock is NULL, then ASSERT().
3086 If SpinLock was not initialized with InitializeSpinLock(), then ASSERT().
3087 If PcdSpinLockTimeout is not zero, and SpinLock is can not be acquired in
3088 PcdSpinLockTimeout microseconds, then ASSERT().
3090 @param SpinLock A pointer to the spin lock to place in the acquired state.
3092 @return SpinLock accquired lock.
3098 IN OUT SPIN_LOCK
*SpinLock
3103 Attempts to place a spin lock in the acquired state.
3105 This function checks the state of the spin lock specified by SpinLock. If
3106 SpinLock is in the released state, then this function places SpinLock in the
3107 acquired state and returns TRUE. Otherwise, FALSE is returned. All state
3108 transitions of SpinLock must be performed using MP safe mechanisms.
3110 If SpinLock is NULL, then ASSERT().
3111 If SpinLock was not initialized with InitializeSpinLock(), then ASSERT().
3113 @param SpinLock A pointer to the spin lock to place in the acquired state.
3115 @retval TRUE SpinLock was placed in the acquired state.
3116 @retval FALSE SpinLock could not be acquired.
3121 AcquireSpinLockOrFail (
3122 IN OUT SPIN_LOCK
*SpinLock
3127 Releases a spin lock.
3129 This function places the spin lock specified by SpinLock in the release state
3130 and returns SpinLock.
3132 If SpinLock is NULL, then ASSERT().
3133 If SpinLock was not initialized with InitializeSpinLock(), then ASSERT().
3135 @param SpinLock A pointer to the spin lock to release.
3137 @return SpinLock released lock.
3143 IN OUT SPIN_LOCK
*SpinLock
3148 Performs an atomic increment of an 32-bit unsigned integer.
3150 Performs an atomic increment of the 32-bit unsigned integer specified by
3151 Value and returns the incremented value. The increment operation must be
3152 performed using MP safe mechanisms. The state of the return value is not
3153 guaranteed to be MP safe.
3155 If Value is NULL, then ASSERT().
3157 @param Value A pointer to the 32-bit value to increment.
3159 @return The incremented value.
3164 InterlockedIncrement (
3170 Performs an atomic decrement of an 32-bit unsigned integer.
3172 Performs an atomic decrement of the 32-bit unsigned integer specified by
3173 Value and returns the decremented value. The decrement operation must be
3174 performed using MP safe mechanisms. The state of the return value is not
3175 guaranteed to be MP safe.
3177 If Value is NULL, then ASSERT().
3179 @param Value A pointer to the 32-bit value to decrement.
3181 @return The decremented value.
3186 InterlockedDecrement (
3192 Performs an atomic compare exchange operation on a 32-bit unsigned integer.
3194 Performs an atomic compare exchange operation on the 32-bit unsigned integer
3195 specified by Value. If Value is equal to CompareValue, then Value is set to
3196 ExchangeValue and CompareValue is returned. If Value is not equal to CompareValue,
3197 then Value is returned. The compare exchange operation must be performed using
3200 If Value is NULL, then ASSERT().
3202 @param Value A pointer to the 32-bit value for the compare exchange
3204 @param CompareValue 32-bit value used in compare operation.
3205 @param ExchangeValue 32-bit value used in exchange operation.
3207 @return The original *Value before exchange.
3212 InterlockedCompareExchange32 (
3213 IN OUT UINT32
*Value
,
3214 IN UINT32 CompareValue
,
3215 IN UINT32 ExchangeValue
3220 Performs an atomic compare exchange operation on a 64-bit unsigned integer.
3222 Performs an atomic compare exchange operation on the 64-bit unsigned integer specified
3223 by Value. If Value is equal to CompareValue, then Value is set to ExchangeValue and
3224 CompareValue is returned. If Value is not equal to CompareValue, then Value is returned.
3225 The compare exchange operation must be performed using MP safe mechanisms.
3227 If Value is NULL, then ASSERT().
3229 @param Value A pointer to the 64-bit value for the compare exchange
3231 @param CompareValue 64-bit value used in compare operation.
3232 @param ExchangeValue 64-bit value used in exchange operation.
3234 @return The original *Value before exchange.
3239 InterlockedCompareExchange64 (
3240 IN OUT UINT64
*Value
,
3241 IN UINT64 CompareValue
,
3242 IN UINT64 ExchangeValue
3247 Performs an atomic compare exchange operation on a pointer value.
3249 Performs an atomic compare exchange operation on the pointer value specified
3250 by Value. If Value is equal to CompareValue, then Value is set to
3251 ExchangeValue and CompareValue is returned. If Value is not equal to
3252 CompareValue, then Value is returned. The compare exchange operation must be
3253 performed using MP safe mechanisms.
3255 If Value is NULL, then ASSERT().
3257 @param Value A pointer to the pointer value for the compare exchange
3259 @param CompareValue Pointer value used in compare operation.
3260 @param ExchangeValue Pointer value used in exchange operation.
3262 @return The original *Value before exchange.
3266 InterlockedCompareExchangePointer (
3267 IN OUT VOID
**Value
,
3268 IN VOID
*CompareValue
,
3269 IN VOID
*ExchangeValue
3274 // Base Library Checksum Functions
3278 Returns the sum of all elements in a buffer in unit of UINT8.
3279 During calculation, the carry bits are dropped.
3281 This function calculates the sum of all elements in a buffer
3282 in unit of UINT8. The carry bits in result of addition are dropped.
3283 The result is returned as UINT8. If Length is Zero, then Zero is
3286 If Buffer is NULL, then ASSERT().
3287 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3289 @param Buffer Pointer to the buffer to carry out the sum operation.
3290 @param Length The size, in bytes, of Buffer.
3292 @return Sum The sum of Buffer with carry bits dropped during additions.
3298 IN CONST UINT8
*Buffer
,
3304 Returns the two's complement checksum of all elements in a buffer
3307 This function first calculates the sum of the 8-bit values in the
3308 buffer specified by Buffer and Length. The carry bits in the result
3309 of addition are dropped. Then, the two's complement of the sum is
3310 returned. If Length is 0, then 0 is returned.
3312 If Buffer is NULL, then ASSERT().
3313 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3315 @param Buffer Pointer to the buffer to carry out the checksum operation.
3316 @param Length The size, in bytes, of Buffer.
3318 @return Checksum The 2's complement checksum of Buffer.
3323 CalculateCheckSum8 (
3324 IN CONST UINT8
*Buffer
,
3330 Returns the sum of all elements in a buffer of 16-bit values. During
3331 calculation, the carry bits are dropped.
3333 This function calculates the sum of the 16-bit values in the buffer
3334 specified by Buffer and Length. The carry bits in result of addition are dropped.
3335 The 16-bit result is returned. If Length is 0, then 0 is returned.
3337 If Buffer is NULL, then ASSERT().
3338 If Buffer is not aligned on a 16-bit boundary, then ASSERT().
3339 If Length is not aligned on a 16-bit boundary, then ASSERT().
3340 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3342 @param Buffer Pointer to the buffer to carry out the sum operation.
3343 @param Length The size, in bytes, of Buffer.
3345 @return Sum The sum of Buffer with carry bits dropped during additions.
3351 IN CONST UINT16
*Buffer
,
3357 Returns the two's complement checksum of all elements in a buffer of
3360 This function first calculates the sum of the 16-bit values in the buffer
3361 specified by Buffer and Length. The carry bits in the result of addition
3362 are dropped. Then, the two's complement of the sum is returned. If Length
3363 is 0, then 0 is returned.
3365 If Buffer is NULL, then ASSERT().
3366 If Buffer is not aligned on a 16-bit boundary, then ASSERT().
3367 If Length is not aligned on a 16-bit boundary, then ASSERT().
3368 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3370 @param Buffer Pointer to the buffer to carry out the checksum operation.
3371 @param Length The size, in bytes, of Buffer.
3373 @return Checksum The 2's complement checksum of Buffer.
3378 CalculateCheckSum16 (
3379 IN CONST UINT16
*Buffer
,
3385 Returns the sum of all elements in a buffer of 32-bit values. During
3386 calculation, the carry bits are dropped.
3388 This function calculates the sum of the 32-bit values in the buffer
3389 specified by Buffer and Length. The carry bits in result of addition are dropped.
3390 The 32-bit result is returned. If Length is 0, then 0 is returned.
3392 If Buffer is NULL, then ASSERT().
3393 If Buffer is not aligned on a 32-bit boundary, then ASSERT().
3394 If Length is not aligned on a 32-bit boundary, then ASSERT().
3395 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3397 @param Buffer Pointer to the buffer to carry out the sum operation.
3398 @param Length The size, in bytes, of Buffer.
3400 @return Sum The sum of Buffer with carry bits dropped during additions.
3406 IN CONST UINT32
*Buffer
,
3412 Returns the two's complement checksum of all elements in a buffer of
3415 This function first calculates the sum of the 32-bit values in the buffer
3416 specified by Buffer and Length. The carry bits in the result of addition
3417 are dropped. Then, the two's complement of the sum is returned. If Length
3418 is 0, then 0 is returned.
3420 If Buffer is NULL, then ASSERT().
3421 If Buffer is not aligned on a 32-bit boundary, then ASSERT().
3422 If Length is not aligned on a 32-bit boundary, then ASSERT().
3423 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3425 @param Buffer Pointer to the buffer to carry out the checksum operation.
3426 @param Length The size, in bytes, of Buffer.
3428 @return Checksum The 2's complement checksum of Buffer.
3433 CalculateCheckSum32 (
3434 IN CONST UINT32
*Buffer
,
3440 Returns the sum of all elements in a buffer of 64-bit values. During
3441 calculation, the carry bits are dropped.
3443 This function calculates the sum of the 64-bit values in the buffer
3444 specified by Buffer and Length. The carry bits in result of addition are dropped.
3445 The 64-bit result is returned. If Length is 0, then 0 is returned.
3447 If Buffer is NULL, then ASSERT().
3448 If Buffer is not aligned on a 64-bit boundary, then ASSERT().
3449 If Length is not aligned on a 64-bit boundary, then ASSERT().
3450 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3452 @param Buffer Pointer to the buffer to carry out the sum operation.
3453 @param Length The size, in bytes, of Buffer.
3455 @return Sum The sum of Buffer with carry bits dropped during additions.
3461 IN CONST UINT64
*Buffer
,
3467 Returns the two's complement checksum of all elements in a buffer of
3470 This function first calculates the sum of the 64-bit values in the buffer
3471 specified by Buffer and Length. The carry bits in the result of addition
3472 are dropped. Then, the two's complement of the sum is returned. If Length
3473 is 0, then 0 is returned.
3475 If Buffer is NULL, then ASSERT().
3476 If Buffer is not aligned on a 64-bit boundary, then ASSERT().
3477 If Length is not aligned on a 64-bit boundary, then ASSERT().
3478 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
3480 @param Buffer Pointer to the buffer to carry out the checksum operation.
3481 @param Length The size, in bytes, of Buffer.
3483 @return Checksum The 2's complement checksum of Buffer.
3488 CalculateCheckSum64 (
3489 IN CONST UINT64
*Buffer
,
3495 /// Base Library CPU Functions
3499 (EFIAPI
*SWITCH_STACK_ENTRY_POINT
)(
3500 IN VOID
*Context1
, OPTIONAL
3501 IN VOID
*Context2 OPTIONAL
3506 Used to serialize load and store operations.
3508 All loads and stores that proceed calls to this function are guaranteed to be
3509 globally visible when this function returns.
3520 Saves the current CPU context that can be restored with a call to LongJump()
3523 Saves the current CPU context in the buffer specified by JumpBuffer and
3524 returns 0. The initial call to SetJump() must always return 0. Subsequent
3525 calls to LongJump() cause a non-zero value to be returned by SetJump().
3527 If JumpBuffer is NULL, then ASSERT().
3528 For IPF CPUs, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().
3530 NOTE: The structure BASE_LIBRARY_JUMP_BUFFER is CPU architecture specific.
3531 The same structure must never be used for more than one CPU architecture context.
3532 For example, a BASE_LIBRARY_JUMP_BUFFER allocated by an IA-32 module must never be used from an x64 module.
3533 SetJump()/LongJump() is not currently supported for the EBC processor type.
3535 @param JumpBuffer A pointer to CPU context buffer.
3537 @retval 0 Indicates a return from SetJump().
3543 OUT BASE_LIBRARY_JUMP_BUFFER
*JumpBuffer
3548 Restores the CPU context that was saved with SetJump().
3550 Restores the CPU context from the buffer specified by JumpBuffer. This
3551 function never returns to the caller. Instead is resumes execution based on
3552 the state of JumpBuffer.
3554 If JumpBuffer is NULL, then ASSERT().
3555 For IPF CPUs, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().
3556 If Value is 0, then ASSERT().
3558 @param JumpBuffer A pointer to CPU context buffer.
3559 @param Value The value to return when the SetJump() context is
3560 restored and must be non-zero.
3566 IN BASE_LIBRARY_JUMP_BUFFER
*JumpBuffer
,
3572 Enables CPU interrupts.
3583 Disables CPU interrupts.
3594 Disables CPU interrupts and returns the interrupt state prior to the disable
3597 @retval TRUE CPU interrupts were enabled on entry to this call.
3598 @retval FALSE CPU interrupts were disabled on entry to this call.
3603 SaveAndDisableInterrupts (
3609 Enables CPU interrupts for the smallest window required to capture any
3615 EnableDisableInterrupts (
3621 Retrieves the current CPU interrupt state.
3623 Returns TRUE is interrupts are currently enabled. Otherwise
3626 @retval TRUE CPU interrupts are enabled.
3627 @retval FALSE CPU interrupts are disabled.
3638 Set the current CPU interrupt state.
3640 Sets the current CPU interrupt state to the state specified by
3641 InterruptState. If InterruptState is TRUE, then interrupts are enabled. If
3642 InterruptState is FALSE, then interrupts are disabled. InterruptState is
3645 @param InterruptState TRUE if interrupts should enabled. FALSE if
3646 interrupts should be disabled.
3648 @return InterruptState
3654 IN BOOLEAN InterruptState
3659 Requests CPU to pause for a short period of time.
3661 Requests CPU to pause for a short period of time. Typically used in MP
3662 systems to prevent memory starvation while waiting for a spin lock.
3673 Transfers control to a function starting with a new stack.
3675 Transfers control to the function specified by EntryPoint using the
3676 new stack specified by NewStack and passing in the parameters specified
3677 by Context1 and Context2. Context1 and Context2 are optional and may
3678 be NULL. The function EntryPoint must never return. This function
3679 supports a variable number of arguments following the NewStack parameter.
3680 These additional arguments are ignored on IA-32, x64, and EBC.
3681 IPF CPUs expect one additional parameter of type VOID * that specifies
3682 the new backing store pointer.
3684 If EntryPoint is NULL, then ASSERT().
3685 If NewStack is NULL, then ASSERT().
3687 @param EntryPoint A pointer to function to call with the new stack.
3688 @param Context1 A pointer to the context to pass into the EntryPoint
3690 @param Context2 A pointer to the context to pass into the EntryPoint
3692 @param NewStack A pointer to the new stack to use for the EntryPoint
3694 @param ... This variable argument list is ignored for IA32, x64, and EBC.
3695 For IPF, this variable argument list is expected to contain
3696 a single parameter of type VOID * that specifies the new backing
3704 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
3705 IN VOID
*Context1
, OPTIONAL
3706 IN VOID
*Context2
, OPTIONAL
3713 Generates a breakpoint on the CPU.
3715 Generates a breakpoint on the CPU. The breakpoint must be implemented such
3716 that code can resume normal execution after the breakpoint.
3727 Executes an infinite loop.
3729 Forces the CPU to execute an infinite loop. A debugger may be used to skip
3730 past the loop and the code that follows the loop must execute properly. This
3731 implies that the infinite loop must not cause the code that follow it to be
3741 #if defined (MDE_CPU_IPF)
3744 Flush a range of cache lines in the cache coherency domain of the calling
3747 Invalidates the cache lines specified by Address and Length. If Address is
3748 not aligned on a cache line boundary, then entire cache line containing
3749 Address is invalidated. If Address + Length is not aligned on a cache line
3750 boundary, then the entire instruction cache line containing Address + Length
3751 -1 is invalidated. This function may choose to invalidate the entire
3752 instruction cache if that is more efficient than invalidating the specified
3753 range. If Length is 0, the no instruction cache lines are invalidated.
3754 Address is returned.
3756 If Length is greater than (MAX_ADDRESS - Address + 1), then ASSERT().
3758 @param Address The base address of the instruction lines to invalidate. If
3759 the CPU is in a physical addressing mode, then Address is a
3760 physical address. If the CPU is in a virtual addressing mode,
3761 then Address is a virtual address.
3763 @param Length The number of bytes to invalidate from the instruction cache.
3770 IpfFlushCacheRange (
3777 Executes a FC instruction
3778 Executes a FC instruction on the cache line specified by Address.
3779 The cache line size affected is at least 32-bytes (aligned on a 32-byte boundary).
3780 An implementation may flush a larger region. This function is only available on IPF.
3782 @param Address The Address of cache line to be flushed.
3784 @return The address of FC instruction executed.
3795 Executes a FC.I instruction.
3796 Executes a FC.I instruction on the cache line specified by Address.
3797 The cache line size affected is at least 32-bytes (aligned on a 32-byte boundary).
3798 An implementation may flush a larger region. This function is only available on IPF.
3800 @param Address The Address of cache line to be flushed.
3802 @return The address of FC.I instruction executed.
3813 Reads the current value of a Processor Identifier Register (CPUID).
3815 Reads and returns the current value of Processor Identifier Register specified by Index.
3816 The Index of largest implemented CPUID (One less than the number of implemented CPUID
3817 registers) is determined by CPUID [3] bits {7:0}.
3818 No parameter checking is performed on Index. If the Index value is beyond the
3819 implemented CPUID register range, a Reserved Register/Field fault may occur. The caller
3820 must either guarantee that Index is valid, or the caller must set up fault handlers to
3821 catch the faults. This function is only available on IPF.
3823 @param Index The 8-bit Processor Identifier Register index to read.
3825 @return The current value of Processor Identifier Register specified by Index.
3836 Reads the current value of 64-bit Processor Status Register (PSR).
3837 This function is only available on IPF.
3839 @return The current value of PSR.
3850 Writes the current value of 64-bit Processor Status Register (PSR).
3852 No parameter checking is performed on Value. All bits of Value corresponding to
3853 reserved fields of PSR must be 0 or a Reserved Register/Field fault may occur.
3854 The caller must either guarantee that Value is valid, or the caller must set up
3855 fault handlers to catch the faults. This function is only available on IPF.
3857 @param Value The 64-bit value to write to PSR.
3859 @return The 64-bit value written to the PSR.
3870 Reads the current value of 64-bit Kernel Register #0 (KR0).
3871 This function is only available on IPF.
3873 @return The current value of KR0.
3884 Reads the current value of 64-bit Kernel Register #1 (KR1).
3885 This function is only available on IPF.
3887 @return The current value of KR1.
3898 Reads the current value of 64-bit Kernel Register #2 (KR2).
3899 This function is only available on IPF.
3901 @return The current value of KR2.
3912 Reads the current value of 64-bit Kernel Register #3 (KR3).
3913 This function is only available on IPF.
3915 @return The current value of KR3.
3926 Reads the current value of 64-bit Kernel Register #4 (KR4).
3927 This function is only available on IPF.
3929 @return The current value of KR4.
3940 Reads the current value of 64-bit Kernel Register #5 (KR5).
3941 This function is only available on IPF.
3943 @return The current value of KR5.
3954 Reads the current value of 64-bit Kernel Register #6 (KR6).
3955 This function is only available on IPF.
3957 @return The current value of KR6.
3968 Reads the current value of 64-bit Kernel Register #7 (KR7).
3969 This function is only available on IPF.
3971 @return The current value of KR7.
3982 Write the current value of 64-bit Kernel Register #0 (KR0).
3983 This function is only available on IPF.
3985 @param Value The 64-bit value to write to KR0.
3987 @return The 64-bit value written to the KR0.
3998 Write the current value of 64-bit Kernel Register #1 (KR1).
3999 This function is only available on IPF.
4001 @param Value The 64-bit value to write to KR1.
4003 @return The 64-bit value written to the KR1.
4014 Write the current value of 64-bit Kernel Register #2 (KR2).
4015 This function is only available on IPF.
4017 @param Value The 64-bit value to write to KR2.
4019 @return The 64-bit value written to the KR2.
4030 Write the current value of 64-bit Kernel Register #3 (KR3).
4031 This function is only available on IPF.
4033 @param Value The 64-bit value to write to KR3.
4035 @return The 64-bit value written to the KR3.
4046 Write the current value of 64-bit Kernel Register #4 (KR4).
4047 This function is only available on IPF.
4049 @param Value The 64-bit value to write to KR4.
4051 @return The 64-bit value written to the KR4.
4062 Write the current value of 64-bit Kernel Register #5 (KR5).
4063 This function is only available on IPF.
4065 @param Value The 64-bit value to write to KR5.
4067 @return The 64-bit value written to the KR5.
4078 Write the current value of 64-bit Kernel Register #6 (KR6).
4079 This function is only available on IPF.
4081 @param Value The 64-bit value to write to KR6.
4083 @return The 64-bit value written to the KR6.
4094 Write the current value of 64-bit Kernel Register #7 (KR7).
4095 This function is only available on IPF.
4097 @param Value The 64-bit value to write to KR7.
4099 @return The 64-bit value written to the KR7.
4110 Reads the current value of Interval Timer Counter Register (ITC).
4111 This function is only available on IPF.
4113 @return The current value of ITC.
4124 Reads the current value of Interval Timer Vector Register (ITV).
4125 This function is only available on IPF.
4127 @return The current value of ITV.
4138 Reads the current value of Interval Timer Match Register (ITM).
4139 This function is only available on IPF.
4141 @return The current value of ITM.
4151 Writes the current value of 64-bit Interval Timer Counter Register (ITC).
4152 This function is only available on IPF.
4154 @param Value The 64-bit value to write to ITC.
4156 @return The 64-bit value written to the ITC.
4167 Writes the current value of 64-bit Interval Timer Match Register (ITM).
4168 This function is only available on IPF.
4170 @param Value The 64-bit value to write to ITM.
4172 @return The 64-bit value written to the ITM.
4183 Writes the current value of 64-bit Interval Timer Vector Register (ITV).
4184 No parameter checking is performed on Value. All bits of Value corresponding to
4185 reserved fields of ITV must be 0 or a Reserved Register/Field fault may occur.
4186 The caller must either guarantee that Value is valid, or the caller must set up
4187 fault handlers to catch the faults.
4188 This function is only available on IPF.
4190 @param Value The 64-bit value to write to ITV.
4192 @return The 64-bit value written to the ITV.
4203 Reads the current value of Default Control Register (DCR).
4204 This function is only available on IPF.
4206 @return The current value of DCR.
4217 Reads the current value of Interruption Vector Address Register (IVA).
4218 This function is only available on IPF.
4220 @return The current value of IVA.
4230 Reads the current value of Page Table Address Register (PTA).
4231 This function is only available on IPF.
4233 @return The current value of PTA.
4244 Writes the current value of 64-bit Default Control Register (DCR).
4245 No parameter checking is performed on Value. All bits of Value corresponding to
4246 reserved fields of DCR must be 0 or a Reserved Register/Field fault may occur.
4247 The caller must either guarantee that Value is valid, or the caller must set up
4248 fault handlers to catch the faults.
4249 This function is only available on IPF.
4251 @param Value The 64-bit value to write to DCR.
4253 @return The 64-bit value written to the DCR.
4264 Writes the current value of 64-bit Interruption Vector Address Register (IVA).
4265 The size of vector table is 32 K bytes and is 32 K bytes aligned
4266 the low 15 bits of Value is ignored when written.
4267 This function is only available on IPF.
4269 @param Value The 64-bit value to write to IVA.
4271 @return The 64-bit value written to the IVA.
4282 Writes the current value of 64-bit Page Table Address Register (PTA).
4283 No parameter checking is performed on Value. All bits of Value corresponding to
4284 reserved fields of DCR must be 0 or a Reserved Register/Field fault may occur.
4285 The caller must either guarantee that Value is valid, or the caller must set up
4286 fault handlers to catch the faults.
4287 This function is only available on IPF.
4289 @param Value The 64-bit value to write to PTA.
4291 @return The 64-bit value written to the PTA.
4301 Reads the current value of Local Interrupt ID Register (LID).
4302 This function is only available on IPF.
4304 @return The current value of LID.
4315 Reads the current value of External Interrupt Vector Register (IVR).
4316 This function is only available on IPF.
4318 @return The current value of IVR.
4329 Reads the current value of Task Priority Register (TPR).
4330 This function is only available on IPF.
4332 @return The current value of TPR.
4343 Reads the current value of External Interrupt Request Register #0 (IRR0).
4344 This function is only available on IPF.
4346 @return The current value of IRR0.
4357 Reads the current value of External Interrupt Request Register #1 (IRR1).
4358 This function is only available on IPF.
4360 @return The current value of IRR1.
4371 Reads the current value of External Interrupt Request Register #2 (IRR2).
4372 This function is only available on IPF.
4374 @return The current value of IRR2.
4385 Reads the current value of External Interrupt Request Register #3 (IRR3).
4386 This function is only available on IPF.
4388 @return The current value of IRR3.
4399 Reads the current value of Performance Monitor Vector Register (PMV).
4400 This function is only available on IPF.
4402 @return The current value of PMV.
4413 Reads the current value of Corrected Machine Check Vector Register (CMCV).
4414 This function is only available on IPF.
4416 @return The current value of CMCV.
4427 Reads the current value of Local Redirection Register #0 (LRR0).
4428 This function is only available on IPF.
4430 @return The current value of LRR0.
4441 Reads the current value of Local Redirection Register #1 (LRR1).
4442 This function is only available on IPF.
4444 @return The current value of LRR1.
4455 Writes the current value of 64-bit Page Local Interrupt ID Register (LID).
4456 No parameter checking is performed on Value. All bits of Value corresponding to
4457 reserved fields of LID must be 0 or a Reserved Register/Field fault may occur.
4458 The caller must either guarantee that Value is valid, or the caller must set up
4459 fault handlers to catch the faults.
4460 This function is only available on IPF.
4462 @param Value The 64-bit value to write to LID.
4464 @return The 64-bit value written to the LID.
4475 Writes the current value of 64-bit Task Priority Register (TPR).
4476 No parameter checking is performed on Value. All bits of Value corresponding to
4477 reserved fields of TPR must be 0 or a Reserved Register/Field fault may occur.
4478 The caller must either guarantee that Value is valid, or the caller must set up
4479 fault handlers to catch the faults.
4480 This function is only available on IPF.
4482 @param Value The 64-bit value to write to TPR.
4484 @return The 64-bit value written to the TPR.
4495 Performs a write operation on End OF External Interrupt Register (EOI).
4496 Writes a value of 0 to the EOI Register. This function is only available on IPF.
4507 Writes the current value of 64-bit Performance Monitor Vector Register (PMV).
4508 No parameter checking is performed on Value. All bits of Value corresponding
4509 to reserved fields of PMV must be 0 or a Reserved Register/Field fault may occur.
4510 The caller must either guarantee that Value is valid, or the caller must set up
4511 fault handlers to catch the faults.
4512 This function is only available on IPF.
4514 @param Value The 64-bit value to write to PMV.
4516 @return The 64-bit value written to the PMV.
4527 Writes the current value of 64-bit Corrected Machine Check Vector Register (CMCV).
4528 No parameter checking is performed on Value. All bits of Value corresponding
4529 to reserved fields of CMCV must be 0 or a Reserved Register/Field fault may occur.
4530 The caller must either guarantee that Value is valid, or the caller must set up
4531 fault handlers to catch the faults.
4532 This function is only available on IPF.
4534 @param Value The 64-bit value to write to CMCV.
4536 @return The 64-bit value written to the CMCV.
4547 Writes the current value of 64-bit Local Redirection Register #0 (LRR0).
4548 No parameter checking is performed on Value. All bits of Value corresponding
4549 to reserved fields of LRR0 must be 0 or a Reserved Register/Field fault may occur.
4550 The caller must either guarantee that Value is valid, or the caller must set up
4551 fault handlers to catch the faults.
4552 This function is only available on IPF.
4554 @param Value The 64-bit value to write to LRR0.
4556 @return The 64-bit value written to the LRR0.
4567 Writes the current value of 64-bit Local Redirection Register #1 (LRR1).
4568 No parameter checking is performed on Value. All bits of Value corresponding
4569 to reserved fields of LRR1 must be 0 or a Reserved Register/Field fault may occur.
4570 The caller must either guarantee that Value is valid, or the caller must
4571 set up fault handlers to catch the faults.
4572 This function is only available on IPF.
4574 @param Value The 64-bit value to write to LRR1.
4576 @return The 64-bit value written to the LRR1.
4587 Reads the current value of Instruction Breakpoint Register (IBR).
4589 The Instruction Breakpoint Registers are used in pairs. The even numbered
4590 registers contain breakpoint addresses, and the odd numbered registers contain
4591 breakpoint mask conditions. At least 4 instruction registers pairs are implemented
4592 on all processor models. Implemented registers are contiguous starting with
4593 register 0. No parameter checking is performed on Index, and if the Index value
4594 is beyond the implemented IBR register range, a Reserved Register/Field fault may
4595 occur. The caller must either guarantee that Index is valid, or the caller must
4596 set up fault handlers to catch the faults.
4597 This function is only available on IPF.
4599 @param Index The 8-bit Instruction Breakpoint Register index to read.
4601 @return The current value of Instruction Breakpoint Register specified by Index.
4612 Reads the current value of Data Breakpoint Register (DBR).
4614 The Data Breakpoint Registers are used in pairs. The even numbered registers
4615 contain breakpoint addresses, and odd numbered registers contain breakpoint
4616 mask conditions. At least 4 data registers pairs are implemented on all processor
4617 models. Implemented registers are contiguous starting with register 0.
4618 No parameter checking is performed on Index. If the Index value is beyond
4619 the implemented DBR register range, a Reserved Register/Field fault may occur.
4620 The caller must either guarantee that Index is valid, or the caller must set up
4621 fault handlers to catch the faults.
4622 This function is only available on IPF.
4624 @param Index The 8-bit Data Breakpoint Register index to read.
4626 @return The current value of Data Breakpoint Register specified by Index.
4637 Reads the current value of Performance Monitor Configuration Register (PMC).
4639 All processor implementations provide at least 4 performance counters
4640 (PMC/PMD [4]...PMC/PMD [7] pairs), and 4 performance monitor counter overflow
4641 status registers (PMC [0]... PMC [3]). Processor implementations may provide
4642 additional implementation-dependent PMC and PMD to increase the number of
4643 'generic' performance counters (PMC/PMD pairs). The remainder of PMC and PMD
4644 register set is implementation dependent. No parameter checking is performed
4645 on Index. If the Index value is beyond the implemented PMC register range,
4646 zero value will be returned.
4647 This function is only available on IPF.
4649 @param Index The 8-bit Performance Monitor Configuration Register index to read.
4651 @return The current value of Performance Monitor Configuration Register
4663 Reads the current value of Performance Monitor Data Register (PMD).
4665 All processor implementations provide at least 4 performance counters
4666 (PMC/PMD [4]...PMC/PMD [7] pairs), and 4 performance monitor counter
4667 overflow status registers (PMC [0]... PMC [3]). Processor implementations may
4668 provide additional implementation-dependent PMC and PMD to increase the number
4669 of 'generic' performance counters (PMC/PMD pairs). The remainder of PMC and PMD
4670 register set is implementation dependent. No parameter checking is performed
4671 on Index. If the Index value is beyond the implemented PMD register range,
4672 zero value will be returned.
4673 This function is only available on IPF.
4675 @param Index The 8-bit Performance Monitor Data Register index to read.
4677 @return The current value of Performance Monitor Data Register specified by Index.
4688 Writes the current value of 64-bit Instruction Breakpoint Register (IBR).
4690 Writes current value of Instruction Breakpoint Register specified by Index.
4691 The Instruction Breakpoint Registers are used in pairs. The even numbered
4692 registers contain breakpoint addresses, and odd numbered registers contain
4693 breakpoint mask conditions. At least 4 instruction registers pairs are implemented
4694 on all processor models. Implemented registers are contiguous starting with
4695 register 0. No parameter checking is performed on Index. If the Index value
4696 is beyond the implemented IBR register range, a Reserved Register/Field fault may
4697 occur. The caller must either guarantee that Index is valid, or the caller must
4698 set up fault handlers to catch the faults.
4699 This function is only available on IPF.
4701 @param Index The 8-bit Instruction Breakpoint Register index to write.
4702 @param Value The 64-bit value to write to IBR.
4704 @return The 64-bit value written to the IBR.
4716 Writes the current value of 64-bit Data Breakpoint Register (DBR).
4718 Writes current value of Data Breakpoint Register specified by Index.
4719 The Data Breakpoint Registers are used in pairs. The even numbered registers
4720 contain breakpoint addresses, and odd numbered registers contain breakpoint
4721 mask conditions. At least 4 data registers pairs are implemented on all processor
4722 models. Implemented registers are contiguous starting with register 0. No parameter
4723 checking is performed on Index. If the Index value is beyond the implemented
4724 DBR register range, a Reserved Register/Field fault may occur. The caller must
4725 either guarantee that Index is valid, or the caller must set up fault handlers to
4727 This function is only available on IPF.
4729 @param Index The 8-bit Data Breakpoint Register index to write.
4730 @param Value The 64-bit value to write to DBR.
4732 @return The 64-bit value written to the DBR.
4744 Writes the current value of 64-bit Performance Monitor Configuration Register (PMC).
4746 Writes current value of Performance Monitor Configuration Register specified by Index.
4747 All processor implementations provide at least 4 performance counters
4748 (PMC/PMD [4]...PMC/PMD [7] pairs), and 4 performance monitor counter overflow status
4749 registers (PMC [0]... PMC [3]). Processor implementations may provide additional
4750 implementation-dependent PMC and PMD to increase the number of 'generic' performance
4751 counters (PMC/PMD pairs). The remainder of PMC and PMD register set is implementation
4752 dependent. No parameter checking is performed on Index. If the Index value is
4753 beyond the implemented PMC register range, the write is ignored.
4754 This function is only available on IPF.
4756 @param Index The 8-bit Performance Monitor Configuration Register index to write.
4757 @param Value The 64-bit value to write to PMC.
4759 @return The 64-bit value written to the PMC.
4771 Writes the current value of 64-bit Performance Monitor Data Register (PMD).
4773 Writes current value of Performance Monitor Data Register specified by Index.
4774 All processor implementations provide at least 4 performance counters
4775 (PMC/PMD [4]...PMC/PMD [7] pairs), and 4 performance monitor counter overflow
4776 status registers (PMC [0]... PMC [3]). Processor implementations may provide
4777 additional implementation-dependent PMC and PMD to increase the number of 'generic'
4778 performance counters (PMC/PMD pairs). The remainder of PMC and PMD register set
4779 is implementation dependent. No parameter checking is performed on Index. If the
4780 Index value is beyond the implemented PMD register range, the write is ignored.
4781 This function is only available on IPF.
4783 @param Index The 8-bit Performance Monitor Data Register index to write.
4784 @param Value The 64-bit value to write to PMD.
4786 @return The 64-bit value written to the PMD.
4798 Reads the current value of 64-bit Global Pointer (GP).
4800 Reads and returns the current value of GP.
4801 This function is only available on IPF.
4803 @return The current value of GP.
4814 Write the current value of 64-bit Global Pointer (GP).
4816 Writes the current value of GP. The 64-bit value written to the GP is returned.
4817 No parameter checking is performed on Value.
4818 This function is only available on IPF.
4820 @param Value The 64-bit value to write to GP.
4822 @return The 64-bit value written to the GP.
4833 Reads the current value of 64-bit Stack Pointer (SP).
4835 Reads and returns the current value of SP.
4836 This function is only available on IPF.
4838 @return The current value of SP.
4849 Determines if the CPU is currently executing in virtual, physical, or mixed mode.
4851 Determines the current execution mode of the CPU.
4852 If the CPU is in virtual mode(PSR.RT=1, PSR.DT=1, PSR.IT=1), then 1 is returned.
4853 If the CPU is in physical mode(PSR.RT=0, PSR.DT=0, PSR.IT=0), then 0 is returned.
4854 If the CPU is not in physical mode or virtual mode, then it is in mixed mode,
4856 This function is only available on IPF.
4858 @retval 1 The CPU is in virtual mode.
4859 @retval 0 The CPU is in physical mode.
4860 @retval -1 The CPU is in mixed mode.
4871 Makes a PAL procedure call.
4873 This is a wrapper function to make a PAL procedure call. Based on the Index
4874 value this API will make static or stacked PAL call. The following table
4875 describes the usage of PAL Procedure Index Assignment. Architected procedures
4876 may be designated as required or optional. If a PAL procedure is specified
4877 as optional, a unique return code of 0xFFFFFFFFFFFFFFFF is returned in the
4878 Status field of the PAL_CALL_RETURN structure.
4879 This indicates that the procedure is not present in this PAL implementation.
4880 It is the caller's responsibility to check for this return code after calling
4881 any optional PAL procedure.
4882 No parameter checking is performed on the 5 input parameters, but there are
4883 some common rules that the caller should follow when making a PAL call. Any
4884 address passed to PAL as buffers for return parameters must be 8-byte aligned.
4885 Unaligned addresses may cause undefined results. For those parameters defined
4886 as reserved or some fields defined as reserved must be zero filled or the invalid
4887 argument return value may be returned or undefined result may occur during the
4888 execution of the procedure. If the PalEntryPoint does not point to a valid
4889 PAL entry point then the system behavior is undefined. This function is only
4892 @param PalEntryPoint The PAL procedure calls entry point.
4893 @param Index The PAL procedure Index number.
4894 @param Arg2 The 2nd parameter for PAL procedure calls.
4895 @param Arg3 The 3rd parameter for PAL procedure calls.
4896 @param Arg4 The 4th parameter for PAL procedure calls.
4898 @return structure returned from the PAL Call procedure, including the status and return value.
4904 IN UINT64 PalEntryPoint
,
4913 Transfers control to a function starting with a new stack.
4915 Transfers control to the function specified by EntryPoint using the new stack
4916 specified by NewStack and passing in the parameters specified by Context1 and
4917 Context2. Context1 and Context2 are optional and may be NULL. The function
4918 EntryPoint must never return.
4920 If EntryPoint is NULL, then ASSERT().
4921 If NewStack is NULL, then ASSERT().
4923 @param EntryPoint A pointer to function to call with the new stack.
4924 @param Context1 A pointer to the context to pass into the EntryPoint
4926 @param Context2 A pointer to the context to pass into the EntryPoint
4928 @param NewStack A pointer to the new stack to use for the EntryPoint
4930 @param NewBsp A pointer to the new memory location for RSE backing
4936 AsmSwitchStackAndBackingStore (
4937 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
4938 IN VOID
*Context1
, OPTIONAL
4939 IN VOID
*Context2
, OPTIONAL
4945 @todo This call should be removed after the PalCall
4946 Instance issue has been fixed.
4948 Performs a PAL call using static calling convention.
4950 An internal function to perform a PAL call using static calling convention.
4952 @param PalEntryPoint The entry point address of PAL. The address in ar.kr5
4953 would be used if this parameter were NULL on input.
4954 @param Arg1 The first argument of a PAL call.
4955 @param Arg2 The second argument of a PAL call.
4956 @param Arg3 The third argument of a PAL call.
4957 @param Arg4 The fourth argument of a PAL call.
4959 @return The values returned in r8, r9, r10 and r11.
4964 IN CONST VOID
*PalEntryPoint
,
4973 #elif defined (MDE_CPU_IA32) || defined (MDE_CPU_X64)
4975 /// IA32 and X64 Specific Functions
4976 /// Byte packed structure for 16-bit Real Mode EFLAGS
4980 UINT32 CF
:1; /// Carry Flag
4981 UINT32 Reserved_0
:1; /// Reserved
4982 UINT32 PF
:1; /// Parity Flag
4983 UINT32 Reserved_1
:1; /// Reserved
4984 UINT32 AF
:1; /// Auxiliary Carry Flag
4985 UINT32 Reserved_2
:1; /// Reserved
4986 UINT32 ZF
:1; /// Zero Flag
4987 UINT32 SF
:1; /// Sign Flag
4988 UINT32 TF
:1; /// Trap Flag
4989 UINT32 IF
:1; /// Interrupt Enable Flag
4990 UINT32 DF
:1; /// Direction Flag
4991 UINT32 OF
:1; /// Overflow Flag
4992 UINT32 IOPL
:2; /// I/O Privilege Level
4993 UINT32 NT
:1; /// Nested Task
4994 UINT32 Reserved_3
:1; /// Reserved
5000 /// Byte packed structure for EFLAGS/RFLAGS
5001 /// 32-bits on IA-32
5002 /// 64-bits on X64. The upper 32-bits on X64 are reserved
5006 UINT32 CF
:1; /// Carry Flag
5007 UINT32 Reserved_0
:1; /// Reserved
5008 UINT32 PF
:1; /// Parity Flag
5009 UINT32 Reserved_1
:1; /// Reserved
5010 UINT32 AF
:1; /// Auxiliary Carry Flag
5011 UINT32 Reserved_2
:1; /// Reserved
5012 UINT32 ZF
:1; /// Zero Flag
5013 UINT32 SF
:1; /// Sign Flag
5014 UINT32 TF
:1; /// Trap Flag
5015 UINT32 IF
:1; /// Interrupt Enable Flag
5016 UINT32 DF
:1; /// Direction Flag
5017 UINT32 OF
:1; /// Overflow Flag
5018 UINT32 IOPL
:2; /// I/O Privilege Level
5019 UINT32 NT
:1; /// Nested Task
5020 UINT32 Reserved_3
:1; /// Reserved
5021 UINT32 RF
:1; /// Resume Flag
5022 UINT32 VM
:1; /// Virtual 8086 Mode
5023 UINT32 AC
:1; /// Alignment Check
5024 UINT32 VIF
:1; /// Virtual Interrupt Flag
5025 UINT32 VIP
:1; /// Virtual Interrupt Pending
5026 UINT32 ID
:1; /// ID Flag
5027 UINT32 Reserved_4
:10; /// Reserved
5033 /// Byte packed structure for Control Register 0 (CR0)
5034 /// 32-bits on IA-32
5035 /// 64-bits on X64. The upper 32-bits on X64 are reserved
5039 UINT32 PE
:1; /// Protection Enable
5040 UINT32 MP
:1; /// Monitor Coprocessor
5041 UINT32 EM
:1; /// Emulation
5042 UINT32 TS
:1; /// Task Switched
5043 UINT32 ET
:1; /// Extension Type
5044 UINT32 NE
:1; /// Numeric Error
5045 UINT32 Reserved_0
:10; /// Reserved
5046 UINT32 WP
:1; /// Write Protect
5047 UINT32 Reserved_1
:1; /// Reserved
5048 UINT32 AM
:1; /// Alignment Mask
5049 UINT32 Reserved_2
:10; /// Reserved
5050 UINT32 NW
:1; /// Mot Write-through
5051 UINT32 CD
:1; /// Cache Disable
5052 UINT32 PG
:1; /// Paging
5058 /// Byte packed structure for Control Register 4 (CR4)
5059 /// 32-bits on IA-32
5060 /// 64-bits on X64. The upper 32-bits on X64 are reserved
5064 UINT32 VME
:1; /// Virtual-8086 Mode Extensions
5065 UINT32 PVI
:1; /// Protected-Mode Virtual Interrupts
5066 UINT32 TSD
:1; /// Time Stamp Disable
5067 UINT32 DE
:1; /// Debugging Extensions
5068 UINT32 PSE
:1; /// Page Size Extensions
5069 UINT32 PAE
:1; /// Physical Address Extension
5070 UINT32 MCE
:1; /// Machine Check Enable
5071 UINT32 PGE
:1; /// Page Global Enable
5072 UINT32 PCE
:1; /// Performance Monitoring Counter
5074 UINT32 OSFXSR
:1; /// Operating System Support for
5075 /// FXSAVE and FXRSTOR instructions
5076 UINT32 OSXMMEXCPT
:1; /// Operating System Support for
5077 /// Unmasked SIMD Floating Point
5079 UINT32 Reserved_0
:2; /// Reserved
5080 UINT32 VMXE
:1; /// VMX Enable
5081 UINT32 Reserved_1
:18; /// Reseved
5087 /// Byte packed structure for an IDTR, GDTR, LDTR descriptor
5088 /// @todo How to make this structure byte-packed in a compiler independent way?
5097 #define IA32_IDT_GATE_TYPE_TASK 0x85
5098 #define IA32_IDT_GATE_TYPE_INTERRUPT_16 0x86
5099 #define IA32_IDT_GATE_TYPE_TRAP_16 0x87
5100 #define IA32_IDT_GATE_TYPE_INTERRUPT_32 0x8E
5101 #define IA32_IDT_GATE_TYPE_TRAP_32 0x8F
5104 /// Byte packed structure for an Interrupt Gate Descriptor
5106 #if defined (MDE_CPU_IA32)
5110 UINT32 OffsetLow
:16; // Offset bits 15..0
5111 UINT32 Selector
:16; // Selector
5112 UINT32 Reserved_0
:8; // Reserved
5113 UINT32 GateType
:8; // Gate Type. See #defines above
5114 UINT32 OffsetHigh
:16; // Offset bits 31..16
5117 } IA32_IDT_GATE_DESCRIPTOR
;
5121 #if defined (MDE_CPU_X64)
5125 UINT32 OffsetLow
:16; // Offset bits 15..0
5126 UINT32 Selector
:16; // Selector
5127 UINT32 Reserved_0
:8; // Reserved
5128 UINT32 GateType
:8; // Gate Type. See #defines above
5129 UINT32 OffsetHigh
:16; // Offset bits 31..16
5130 UINT32 OffsetUpper
:32; // Offset bits 63..32
5131 UINT32 Reserved_1
:32; // Reserved
5135 } IA32_IDT_GATE_DESCRIPTOR
;
5140 /// Byte packed structure for an FP/SSE/SSE2 context
5147 /// Structures for the 16-bit real mode thunks
5200 IA32_EFLAGS32 EFLAGS
;
5210 } IA32_REGISTER_SET
;
5213 /// Byte packed structure for an 16-bit real mode thunks
5216 IA32_REGISTER_SET
*RealModeState
;
5217 VOID
*RealModeBuffer
;
5218 UINT32 RealModeBufferSize
;
5219 UINT32 ThunkAttributes
;
5222 #define THUNK_ATTRIBUTE_BIG_REAL_MODE 0x00000001
5223 #define THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 0x00000002
5224 #define THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL 0x00000004
5227 Retrieves CPUID information.
5229 Executes the CPUID instruction with EAX set to the value specified by Index.
5230 This function always returns Index.
5231 If Eax is not NULL, then the value of EAX after CPUID is returned in Eax.
5232 If Ebx is not NULL, then the value of EBX after CPUID is returned in Ebx.
5233 If Ecx is not NULL, then the value of ECX after CPUID is returned in Ecx.
5234 If Edx is not NULL, then the value of EDX after CPUID is returned in Edx.
5235 This function is only available on IA-32 and X64.
5237 @param Index The 32-bit value to load into EAX prior to invoking the CPUID
5239 @param Eax Pointer to the 32-bit EAX value returned by the CPUID
5240 instruction. This is an optional parameter that may be NULL.
5241 @param Ebx Pointer to the 32-bit EBX value returned by the CPUID
5242 instruction. This is an optional parameter that may be NULL.
5243 @param Ecx Pointer to the 32-bit ECX value returned by the CPUID
5244 instruction. This is an optional parameter that may be NULL.
5245 @param Edx Pointer to the 32-bit EDX value returned by the CPUID
5246 instruction. This is an optional parameter that may be NULL.
5255 OUT UINT32
*Eax
, OPTIONAL
5256 OUT UINT32
*Ebx
, OPTIONAL
5257 OUT UINT32
*Ecx
, OPTIONAL
5258 OUT UINT32
*Edx OPTIONAL
5263 Retrieves CPUID information using an extended leaf identifier.
5265 Executes the CPUID instruction with EAX set to the value specified by Index
5266 and ECX set to the value specified by SubIndex. This function always returns
5267 Index. This function is only available on IA-32 and x64.
5269 If Eax is not NULL, then the value of EAX after CPUID is returned in Eax.
5270 If Ebx is not NULL, then the value of EBX after CPUID is returned in Ebx.
5271 If Ecx is not NULL, then the value of ECX after CPUID is returned in Ecx.
5272 If Edx is not NULL, then the value of EDX after CPUID is returned in Edx.
5274 @param Index The 32-bit value to load into EAX prior to invoking the
5276 @param SubIndex The 32-bit value to load into ECX prior to invoking the
5278 @param Eax Pointer to the 32-bit EAX value returned by the CPUID
5279 instruction. This is an optional parameter that may be
5281 @param Ebx Pointer to the 32-bit EBX value returned by the CPUID
5282 instruction. This is an optional parameter that may be
5284 @param Ecx Pointer to the 32-bit ECX value returned by the CPUID
5285 instruction. This is an optional parameter that may be
5287 @param Edx Pointer to the 32-bit EDX value returned by the CPUID
5288 instruction. This is an optional parameter that may be
5299 OUT UINT32
*Eax
, OPTIONAL
5300 OUT UINT32
*Ebx
, OPTIONAL
5301 OUT UINT32
*Ecx
, OPTIONAL
5302 OUT UINT32
*Edx OPTIONAL
5307 Returns the lower 32-bits of a Machine Specific Register(MSR).
5309 Reads and returns the lower 32-bits of the MSR specified by Index.
5310 No parameter checking is performed on Index, and some Index values may cause
5311 CPU exceptions. The caller must either guarantee that Index is valid, or the
5312 caller must set up exception handlers to catch the exceptions. This function
5313 is only available on IA-32 and X64.
5315 @param Index The 32-bit MSR index to read.
5317 @return The lower 32 bits of the MSR identified by Index.
5328 Writes a 32-bit value to a Machine Specific Register(MSR), and returns the value.
5329 The upper 32-bits of the MSR are set to zero.
5331 Writes the 32-bit value specified by Value to the MSR specified by Index. The
5332 upper 32-bits of the MSR write are set to zero. The 32-bit value written to
5333 the MSR is returned. No parameter checking is performed on Index or Value,
5334 and some of these may cause CPU exceptions. The caller must either guarantee
5335 that Index and Value are valid, or the caller must establish proper exception
5336 handlers. This function is only available on IA-32 and X64.
5338 @param Index The 32-bit MSR index to write.
5339 @param Value The 32-bit value to write to the MSR.
5353 Reads a 64-bit MSR, performs a bitwise inclusive OR on the lower 32-bits, and
5354 writes the result back to the 64-bit MSR.
5356 Reads the 64-bit MSR specified by Index, performs a bitwise inclusive OR
5357 between the lower 32-bits of the read result and the value specified by
5358 OrData, and writes the result to the 64-bit MSR specified by Index. The lower
5359 32-bits of the value written to the MSR is returned. No parameter checking is
5360 performed on Index or OrData, and some of these may cause CPU exceptions. The
5361 caller must either guarantee that Index and OrData are valid, or the caller
5362 must establish proper exception handlers. This function is only available on
5365 @param Index The 32-bit MSR index to write.
5366 @param OrData The value to OR with the read value from the MSR.
5368 @return The lower 32-bit value written to the MSR.
5380 Reads a 64-bit MSR, performs a bitwise AND on the lower 32-bits, and writes
5381 the result back to the 64-bit MSR.
5383 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
5384 lower 32-bits of the read result and the value specified by AndData, and
5385 writes the result to the 64-bit MSR specified by Index. The lower 32-bits of
5386 the value written to the MSR is returned. No parameter checking is performed
5387 on Index or AndData, and some of these may cause CPU exceptions. The caller
5388 must either guarantee that Index and AndData are valid, or the caller must
5389 establish proper exception handlers. This function is only available on IA-32
5392 @param Index The 32-bit MSR index to write.
5393 @param AndData The value to AND with the read value from the MSR.
5395 @return The lower 32-bit value written to the MSR.
5407 Reads a 64-bit MSR, performs a bitwise AND followed by a bitwise inclusive OR
5408 on the lower 32-bits, and writes the result back to the 64-bit MSR.
5410 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
5411 lower 32-bits of the read result and the value specified by AndData
5412 preserving the upper 32-bits, performs a bitwise inclusive OR between the
5413 result of the AND operation and the value specified by OrData, and writes the
5414 result to the 64-bit MSR specified by Address. The lower 32-bits of the value
5415 written to the MSR is returned. No parameter checking is performed on Index,
5416 AndData, or OrData, and some of these may cause CPU exceptions. The caller
5417 must either guarantee that Index, AndData, and OrData are valid, or the
5418 caller must establish proper exception handlers. This function is only
5419 available on IA-32 and X64.
5421 @param Index The 32-bit MSR index to write.
5422 @param AndData The value to AND with the read value from the MSR.
5423 @param OrData The value to OR with the result of the AND operation.
5425 @return The lower 32-bit value written to the MSR.
5438 Reads a bit field of an MSR.
5440 Reads the bit field in the lower 32-bits of a 64-bit MSR. The bit field is
5441 specified by the StartBit and the EndBit. The value of the bit field is
5442 returned. The caller must either guarantee that Index is valid, or the caller
5443 must set up exception handlers to catch the exceptions. This function is only
5444 available on IA-32 and X64.
5446 If StartBit is greater than 31, then ASSERT().
5447 If EndBit is greater than 31, then ASSERT().
5448 If EndBit is less than StartBit, then ASSERT().
5450 @param Index The 32-bit MSR index to read.
5451 @param StartBit The ordinal of the least significant bit in the bit field.
5453 @param EndBit The ordinal of the most significant bit in the bit field.
5456 @return The bit field read from the MSR.
5461 AsmMsrBitFieldRead32 (
5469 Writes a bit field to an MSR.
5471 Writes Value to a bit field in the lower 32-bits of a 64-bit MSR. The bit
5472 field is specified by the StartBit and the EndBit. All other bits in the
5473 destination MSR are preserved. The lower 32-bits of the MSR written is
5474 returned. Extra left bits in Value are stripped. The caller must either
5475 guarantee that Index and the data written is valid, or the caller must set up
5476 exception handlers to catch the exceptions. This function is only available
5479 If StartBit is greater than 31, then ASSERT().
5480 If EndBit is greater than 31, then ASSERT().
5481 If EndBit is less than StartBit, then ASSERT().
5483 @param Index The 32-bit MSR index to write.
5484 @param StartBit The ordinal of the least significant bit in the bit field.
5486 @param EndBit The ordinal of the most significant bit in the bit field.
5488 @param Value New value of the bit field.
5490 @return The lower 32-bit of the value written to the MSR.
5495 AsmMsrBitFieldWrite32 (
5504 Reads a bit field in a 64-bit MSR, performs a bitwise OR, and writes the
5505 result back to the bit field in the 64-bit MSR.
5507 Reads the 64-bit MSR specified by Index, performs a bitwise inclusive OR
5508 between the read result and the value specified by OrData, and writes the
5509 result to the 64-bit MSR specified by Index. The lower 32-bits of the value
5510 written to the MSR are returned. Extra left bits in OrData are stripped. The
5511 caller must either guarantee that Index and the data written is valid, or
5512 the caller must set up exception handlers to catch the exceptions. This
5513 function is only available on IA-32 and X64.
5515 If StartBit is greater than 31, then ASSERT().
5516 If EndBit is greater than 31, then ASSERT().
5517 If EndBit is less than StartBit, then ASSERT().
5519 @param Index The 32-bit MSR index to write.
5520 @param StartBit The ordinal of the least significant bit in the bit field.
5522 @param EndBit The ordinal of the most significant bit in the bit field.
5524 @param OrData The value to OR with the read value from the MSR.
5526 @return The lower 32-bit of the value written to the MSR.
5531 AsmMsrBitFieldOr32 (
5540 Reads a bit field in a 64-bit MSR, performs a bitwise AND, and writes the
5541 result back to the bit field in the 64-bit MSR.
5543 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
5544 read result and the value specified by AndData, and writes the result to the
5545 64-bit MSR specified by Index. The lower 32-bits of the value written to the
5546 MSR are returned. Extra left bits in AndData are stripped. The caller must
5547 either guarantee that Index and the data written is valid, or the caller must
5548 set up exception handlers to catch the exceptions. This function is only
5549 available on IA-32 and X64.
5551 If StartBit is greater than 31, then ASSERT().
5552 If EndBit is greater than 31, then ASSERT().
5553 If EndBit is less than StartBit, then ASSERT().
5555 @param Index The 32-bit MSR index to write.
5556 @param StartBit The ordinal of the least significant bit in the bit field.
5558 @param EndBit The ordinal of the most significant bit in the bit field.
5560 @param AndData The value to AND with the read value from the MSR.
5562 @return The lower 32-bit of the value written to the MSR.
5567 AsmMsrBitFieldAnd32 (
5576 Reads a bit field in a 64-bit MSR, performs a bitwise AND followed by a
5577 bitwise inclusive OR, and writes the result back to the bit field in the
5580 Reads the 64-bit MSR specified by Index, performs a bitwise AND followed by a
5581 bitwise inclusive OR between the read result and the value specified by
5582 AndData, and writes the result to the 64-bit MSR specified by Index. The
5583 lower 32-bits of the value written to the MSR are returned. Extra left bits
5584 in both AndData and OrData are stripped. The caller must either guarantee
5585 that Index and the data written is valid, or the caller must set up exception
5586 handlers to catch the exceptions. This function is only available on IA-32
5589 If StartBit is greater than 31, then ASSERT().
5590 If EndBit is greater than 31, then ASSERT().
5591 If EndBit is less than StartBit, then ASSERT().
5593 @param Index The 32-bit MSR index to write.
5594 @param StartBit The ordinal of the least significant bit in the bit field.
5596 @param EndBit The ordinal of the most significant bit in the bit field.
5598 @param AndData The value to AND with the read value from the MSR.
5599 @param OrData The value to OR with the result of the AND operation.
5601 @return The lower 32-bit of the value written to the MSR.
5606 AsmMsrBitFieldAndThenOr32 (
5616 Returns a 64-bit Machine Specific Register(MSR).
5618 Reads and returns the 64-bit MSR specified by Index. No parameter checking is
5619 performed on Index, and some Index values may cause CPU exceptions. The
5620 caller must either guarantee that Index is valid, or the caller must set up
5621 exception handlers to catch the exceptions. This function is only available
5624 @param Index The 32-bit MSR index to read.
5626 @return The value of the MSR identified by Index.
5637 Writes a 64-bit value to a Machine Specific Register(MSR), and returns the
5640 Writes the 64-bit value specified by Value to the MSR specified by Index. The
5641 64-bit value written to the MSR is returned. No parameter checking is
5642 performed on Index or Value, and some of these may cause CPU exceptions. The
5643 caller must either guarantee that Index and Value are valid, or the caller
5644 must establish proper exception handlers. This function is only available on
5647 @param Index The 32-bit MSR index to write.
5648 @param Value The 64-bit value to write to the MSR.
5662 Reads a 64-bit MSR, performs a bitwise inclusive OR, and writes the result
5663 back to the 64-bit MSR.
5665 Reads the 64-bit MSR specified by Index, performs a bitwise inclusive OR
5666 between the read result and the value specified by OrData, and writes the
5667 result to the 64-bit MSR specified by Index. The value written to the MSR is
5668 returned. No parameter checking is performed on Index or OrData, and some of
5669 these may cause CPU exceptions. The caller must either guarantee that Index
5670 and OrData are valid, or the caller must establish proper exception handlers.
5671 This function is only available on IA-32 and X64.
5673 @param Index The 32-bit MSR index to write.
5674 @param OrData The value to OR with the read value from the MSR.
5676 @return The value written back to the MSR.
5688 Reads a 64-bit MSR, performs a bitwise AND, and writes the result back to the
5691 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
5692 read result and the value specified by OrData, and writes the result to the
5693 64-bit MSR specified by Index. The value written to the MSR is returned. No
5694 parameter checking is performed on Index or OrData, and some of these may
5695 cause CPU exceptions. The caller must either guarantee that Index and OrData
5696 are valid, or the caller must establish proper exception handlers. This
5697 function is only available on IA-32 and X64.
5699 @param Index The 32-bit MSR index to write.
5700 @param AndData The value to AND with the read value from the MSR.
5702 @return The value written back to the MSR.
5714 Reads a 64-bit MSR, performs a bitwise AND followed by a bitwise inclusive
5715 OR, and writes the result back to the 64-bit MSR.
5717 Reads the 64-bit MSR specified by Index, performs a bitwise AND between read
5718 result and the value specified by AndData, performs a bitwise inclusive OR
5719 between the result of the AND operation and the value specified by OrData,
5720 and writes the result to the 64-bit MSR specified by Index. The value written
5721 to the MSR is returned. No parameter checking is performed on Index, AndData,
5722 or OrData, and some of these may cause CPU exceptions. The caller must either
5723 guarantee that Index, AndData, and OrData are valid, or the caller must
5724 establish proper exception handlers. This function is only available on IA-32
5727 @param Index The 32-bit MSR index to write.
5728 @param AndData The value to AND with the read value from the MSR.
5729 @param OrData The value to OR with the result of the AND operation.
5731 @return The value written back to the MSR.
5744 Reads a bit field of an MSR.
5746 Reads the bit field in the 64-bit MSR. The bit field is specified by the
5747 StartBit and the EndBit. The value of the bit field is returned. The caller
5748 must either guarantee that Index is valid, or the caller must set up
5749 exception handlers to catch the exceptions. This function is only available
5752 If StartBit is greater than 63, then ASSERT().
5753 If EndBit is greater than 63, then ASSERT().
5754 If EndBit is less than StartBit, then ASSERT().
5756 @param Index The 32-bit MSR index to read.
5757 @param StartBit The ordinal of the least significant bit in the bit field.
5759 @param EndBit The ordinal of the most significant bit in the bit field.
5762 @return The value read from the MSR.
5767 AsmMsrBitFieldRead64 (
5775 Writes a bit field to an MSR.
5777 Writes Value to a bit field in a 64-bit MSR. The bit field is specified by
5778 the StartBit and the EndBit. All other bits in the destination MSR are
5779 preserved. The MSR written is returned. Extra left bits in Value are
5780 stripped. The caller must either guarantee that Index and the data written is
5781 valid, or the caller must set up exception handlers to catch the exceptions.
5782 This function is only available on IA-32 and X64.
5784 If StartBit is greater than 63, then ASSERT().
5785 If EndBit is greater than 63, then ASSERT().
5786 If EndBit is less than StartBit, then ASSERT().
5788 @param Index The 32-bit MSR index to write.
5789 @param StartBit The ordinal of the least significant bit in the bit field.
5791 @param EndBit The ordinal of the most significant bit in the bit field.
5793 @param Value New value of the bit field.
5795 @return The value written back to the MSR.
5800 AsmMsrBitFieldWrite64 (
5809 Reads a bit field in a 64-bit MSR, performs a bitwise inclusive OR, and
5810 writes the result back to the bit field in the 64-bit MSR.
5812 Reads the 64-bit MSR specified by Index, performs a bitwise inclusive OR
5813 between the read result and the value specified by OrData, and writes the
5814 result to the 64-bit MSR specified by Index. The value written to the MSR is
5815 returned. Extra left bits in OrData are stripped. The caller must either
5816 guarantee that Index and the data written is valid, or the caller must set up
5817 exception handlers to catch the exceptions. This function is only available
5820 If StartBit is greater than 63, then ASSERT().
5821 If EndBit is greater than 63, then ASSERT().
5822 If EndBit is less than StartBit, then ASSERT().
5824 @param Index The 32-bit MSR index to write.
5825 @param StartBit The ordinal of the least significant bit in the bit field.
5827 @param EndBit The ordinal of the most significant bit in the bit field.
5829 @param OrData The value to OR with the read value from the bit field.
5831 @return The value written back to the MSR.
5836 AsmMsrBitFieldOr64 (
5845 Reads a bit field in a 64-bit MSR, performs a bitwise AND, and writes the
5846 result back to the bit field in the 64-bit MSR.
5848 Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
5849 read result and the value specified by AndData, and writes the result to the
5850 64-bit MSR specified by Index. The value written to the MSR is returned.
5851 Extra left bits in AndData are stripped. The caller must either guarantee
5852 that Index and the data written is valid, or the caller must set up exception
5853 handlers to catch the exceptions. This function is only available on IA-32
5856 If StartBit is greater than 63, then ASSERT().
5857 If EndBit is greater than 63, then ASSERT().
5858 If EndBit is less than StartBit, then ASSERT().
5860 @param Index The 32-bit MSR index to write.
5861 @param StartBit The ordinal of the least significant bit in the bit field.
5863 @param EndBit The ordinal of the most significant bit in the bit field.
5865 @param AndData The value to AND with the read value from the bit field.
5867 @return The value written back to the MSR.
5872 AsmMsrBitFieldAnd64 (
5881 Reads a bit field in a 64-bit MSR, performs a bitwise AND followed by a
5882 bitwise inclusive OR, and writes the result back to the bit field in the
5885 Reads the 64-bit MSR specified by Index, performs a bitwise AND followed by
5886 a bitwise inclusive OR between the read result and the value specified by
5887 AndData, and writes the result to the 64-bit MSR specified by Index. The
5888 value written to the MSR is returned. Extra left bits in both AndData and
5889 OrData are stripped. The caller must either guarantee that Index and the data
5890 written is valid, or the caller must set up exception handlers to catch the
5891 exceptions. This function is only available on IA-32 and X64.
5893 If StartBit is greater than 63, then ASSERT().
5894 If EndBit is greater than 63, then ASSERT().
5895 If EndBit is less than StartBit, then ASSERT().
5897 @param Index The 32-bit MSR index to write.
5898 @param StartBit The ordinal of the least significant bit in the bit field.
5900 @param EndBit The ordinal of the most significant bit in the bit field.
5902 @param AndData The value to AND with the read value from the bit field.
5903 @param OrData The value to OR with the result of the AND operation.
5905 @return The value written back to the MSR.
5910 AsmMsrBitFieldAndThenOr64 (
5920 Reads the current value of the EFLAGS register.
5922 Reads and returns the current value of the EFLAGS register. This function is
5923 only available on IA-32 and X64. This returns a 32-bit value on IA-32 and a
5924 64-bit value on X64.
5926 @return EFLAGS on IA-32 or RFLAGS on X64.
5937 Reads the current value of the Control Register 0 (CR0).
5939 Reads and returns the current value of CR0. This function is only available
5940 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
5943 @return The value of the Control Register 0 (CR0).
5954 Reads the current value of the Control Register 2 (CR2).
5956 Reads and returns the current value of CR2. This function is only available
5957 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
5960 @return The value of the Control Register 2 (CR2).
5971 Reads the current value of the Control Register 3 (CR3).
5973 Reads and returns the current value of CR3. This function is only available
5974 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
5977 @return The value of the Control Register 3 (CR3).
5988 Reads the current value of the Control Register 4 (CR4).
5990 Reads and returns the current value of CR4. This function is only available
5991 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
5994 @return The value of the Control Register 4 (CR4).
6005 Writes a value to Control Register 0 (CR0).
6007 Writes and returns a new value to CR0. This function is only available on
6008 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6010 @param Cr0 The value to write to CR0.
6012 @return The value written to CR0.
6023 Writes a value to Control Register 2 (CR2).
6025 Writes and returns a new value to CR2. This function is only available on
6026 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6028 @param Cr2 The value to write to CR2.
6030 @return The value written to CR2.
6041 Writes a value to Control Register 3 (CR3).
6043 Writes and returns a new value to CR3. This function is only available on
6044 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6046 @param Cr3 The value to write to CR3.
6048 @return The value written to CR3.
6059 Writes a value to Control Register 4 (CR4).
6061 Writes and returns a new value to CR4. This function is only available on
6062 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6064 @param Cr4 The value to write to CR4.
6066 @return The value written to CR4.
6077 Reads the current value of Debug Register 0 (DR0).
6079 Reads and returns the current value of DR0. This function is only available
6080 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
6083 @return The value of Debug Register 0 (DR0).
6094 Reads the current value of Debug Register 1 (DR1).
6096 Reads and returns the current value of DR1. This function is only available
6097 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
6100 @return The value of Debug Register 1 (DR1).
6111 Reads the current value of Debug Register 2 (DR2).
6113 Reads and returns the current value of DR2. This function is only available
6114 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
6117 @return The value of Debug Register 2 (DR2).
6128 Reads the current value of Debug Register 3 (DR3).
6130 Reads and returns the current value of DR3. This function is only available
6131 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
6134 @return The value of Debug Register 3 (DR3).
6145 Reads the current value of Debug Register 4 (DR4).
6147 Reads and returns the current value of DR4. This function is only available
6148 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
6151 @return The value of Debug Register 4 (DR4).
6162 Reads the current value of Debug Register 5 (DR5).
6164 Reads and returns the current value of DR5. This function is only available
6165 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
6168 @return The value of Debug Register 5 (DR5).
6179 Reads the current value of Debug Register 6 (DR6).
6181 Reads and returns the current value of DR6. This function is only available
6182 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
6185 @return The value of Debug Register 6 (DR6).
6196 Reads the current value of Debug Register 7 (DR7).
6198 Reads and returns the current value of DR7. This function is only available
6199 on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
6202 @return The value of Debug Register 7 (DR7).
6213 Writes a value to Debug Register 0 (DR0).
6215 Writes and returns a new value to DR0. This function is only available on
6216 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6218 @param Dr0 The value to write to Dr0.
6220 @return The value written to Debug Register 0 (DR0).
6231 Writes a value to Debug Register 1 (DR1).
6233 Writes and returns a new value to DR1. This function is only available on
6234 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6236 @param Dr1 The value to write to Dr1.
6238 @return The value written to Debug Register 1 (DR1).
6249 Writes a value to Debug Register 2 (DR2).
6251 Writes and returns a new value to DR2. This function is only available on
6252 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6254 @param Dr2 The value to write to Dr2.
6256 @return The value written to Debug Register 2 (DR2).
6267 Writes a value to Debug Register 3 (DR3).
6269 Writes and returns a new value to DR3. This function is only available on
6270 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6272 @param Dr3 The value to write to Dr3.
6274 @return The value written to Debug Register 3 (DR3).
6285 Writes a value to Debug Register 4 (DR4).
6287 Writes and returns a new value to DR4. This function is only available on
6288 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6290 @param Dr4 The value to write to Dr4.
6292 @return The value written to Debug Register 4 (DR4).
6303 Writes a value to Debug Register 5 (DR5).
6305 Writes and returns a new value to DR5. This function is only available on
6306 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6308 @param Dr5 The value to write to Dr5.
6310 @return The value written to Debug Register 5 (DR5).
6321 Writes a value to Debug Register 6 (DR6).
6323 Writes and returns a new value to DR6. This function is only available on
6324 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6326 @param Dr6 The value to write to Dr6.
6328 @return The value written to Debug Register 6 (DR6).
6339 Writes a value to Debug Register 7 (DR7).
6341 Writes and returns a new value to DR7. This function is only available on
6342 IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
6344 @param Dr7 The value to write to Dr7.
6346 @return The value written to Debug Register 7 (DR7).
6357 Reads the current value of Code Segment Register (CS).
6359 Reads and returns the current value of CS. This function is only available on
6362 @return The current value of CS.
6373 Reads the current value of Data Segment Register (DS).
6375 Reads and returns the current value of DS. This function is only available on
6378 @return The current value of DS.
6389 Reads the current value of Extra Segment Register (ES).
6391 Reads and returns the current value of ES. This function is only available on
6394 @return The current value of ES.
6405 Reads the current value of FS Data Segment Register (FS).
6407 Reads and returns the current value of FS. This function is only available on
6410 @return The current value of FS.
6421 Reads the current value of GS Data Segment Register (GS).
6423 Reads and returns the current value of GS. This function is only available on
6426 @return The current value of GS.
6437 Reads the current value of Stack Segment Register (SS).
6439 Reads and returns the current value of SS. This function is only available on
6442 @return The current value of SS.
6453 Reads the current value of Task Register (TR).
6455 Reads and returns the current value of TR. This function is only available on
6458 @return The current value of TR.
6469 Reads the current Global Descriptor Table Register(GDTR) descriptor.
6471 Reads and returns the current GDTR descriptor and returns it in Gdtr. This
6472 function is only available on IA-32 and X64.
6474 If Gdtr is NULL, then ASSERT().
6476 @param Gdtr Pointer to a GDTR descriptor.
6482 OUT IA32_DESCRIPTOR
*Gdtr
6487 Writes the current Global Descriptor Table Register (GDTR) descriptor.
6489 Writes and the current GDTR descriptor specified by Gdtr. This function is
6490 only available on IA-32 and X64.
6492 If Gdtr is NULL, then ASSERT().
6494 @param Gdtr Pointer to a GDTR descriptor.
6500 IN CONST IA32_DESCRIPTOR
*Gdtr
6505 Reads the current Interrupt Descriptor Table Register(IDTR) descriptor.
6507 Reads and returns the current IDTR descriptor and returns it in Idtr. This
6508 function is only available on IA-32 and X64.
6510 If Idtr is NULL, then ASSERT().
6512 @param Idtr Pointer to a IDTR descriptor.
6518 OUT IA32_DESCRIPTOR
*Idtr
6523 Writes the current Interrupt Descriptor Table Register(IDTR) descriptor.
6525 Writes the current IDTR descriptor and returns it in Idtr. This function is
6526 only available on IA-32 and X64.
6528 If Idtr is NULL, then ASSERT().
6530 @param Idtr Pointer to a IDTR descriptor.
6536 IN CONST IA32_DESCRIPTOR
*Idtr
6541 Reads the current Local Descriptor Table Register(LDTR) selector.
6543 Reads and returns the current 16-bit LDTR descriptor value. This function is
6544 only available on IA-32 and X64.
6546 @return The current selector of LDT.
6557 Writes the current Local Descriptor Table Register (LDTR) selector.
6559 Writes and the current LDTR descriptor specified by Ldtr. This function is
6560 only available on IA-32 and X64.
6562 @param Ldtr 16-bit LDTR selector value.
6573 Save the current floating point/SSE/SSE2 context to a buffer.
6575 Saves the current floating point/SSE/SSE2 state to the buffer specified by
6576 Buffer. Buffer must be aligned on a 16-byte boundary. This function is only
6577 available on IA-32 and X64.
6579 If Buffer is NULL, then ASSERT().
6580 If Buffer is not aligned on a 16-byte boundary, then ASSERT().
6582 @param Buffer Pointer to a buffer to save the floating point/SSE/SSE2 context.
6588 OUT IA32_FX_BUFFER
*Buffer
6593 Restores the current floating point/SSE/SSE2 context from a buffer.
6595 Restores the current floating point/SSE/SSE2 state from the buffer specified
6596 by Buffer. Buffer must be aligned on a 16-byte boundary. This function is
6597 only available on IA-32 and X64.
6599 If Buffer is NULL, then ASSERT().
6600 If Buffer is not aligned on a 16-byte boundary, then ASSERT().
6601 If Buffer was not saved with AsmFxSave(), then ASSERT().
6603 @param Buffer Pointer to a buffer to save the floating point/SSE/SSE2 context.
6609 IN CONST IA32_FX_BUFFER
*Buffer
6614 Reads the current value of 64-bit MMX Register #0 (MM0).
6616 Reads and returns the current value of MM0. This function is only available
6619 @return The current value of MM0.
6630 Reads the current value of 64-bit MMX Register #1 (MM1).
6632 Reads and returns the current value of MM1. This function is only available
6635 @return The current value of MM1.
6646 Reads the current value of 64-bit MMX Register #2 (MM2).
6648 Reads and returns the current value of MM2. This function is only available
6651 @return The current value of MM2.
6662 Reads the current value of 64-bit MMX Register #3 (MM3).
6664 Reads and returns the current value of MM3. This function is only available
6667 @return The current value of MM3.
6678 Reads the current value of 64-bit MMX Register #4 (MM4).
6680 Reads and returns the current value of MM4. This function is only available
6683 @return The current value of MM4.
6694 Reads the current value of 64-bit MMX Register #5 (MM5).
6696 Reads and returns the current value of MM5. This function is only available
6699 @return The current value of MM5.
6710 Reads the current value of 64-bit MMX Register #6 (MM6).
6712 Reads and returns the current value of MM6. This function is only available
6715 @return The current value of MM6.
6726 Reads the current value of 64-bit MMX Register #7 (MM7).
6728 Reads and returns the current value of MM7. This function is only available
6731 @return The current value of MM7.
6742 Writes the current value of 64-bit MMX Register #0 (MM0).
6744 Writes the current value of MM0. This function is only available on IA32 and
6747 @param Value The 64-bit value to write to MM0.
6758 Writes the current value of 64-bit MMX Register #1 (MM1).
6760 Writes the current value of MM1. This function is only available on IA32 and
6763 @param Value The 64-bit value to write to MM1.
6774 Writes the current value of 64-bit MMX Register #2 (MM2).
6776 Writes the current value of MM2. This function is only available on IA32 and
6779 @param Value The 64-bit value to write to MM2.
6790 Writes the current value of 64-bit MMX Register #3 (MM3).
6792 Writes the current value of MM3. This function is only available on IA32 and
6795 @param Value The 64-bit value to write to MM3.
6806 Writes the current value of 64-bit MMX Register #4 (MM4).
6808 Writes the current value of MM4. This function is only available on IA32 and
6811 @param Value The 64-bit value to write to MM4.
6822 Writes the current value of 64-bit MMX Register #5 (MM5).
6824 Writes the current value of MM5. This function is only available on IA32 and
6827 @param Value The 64-bit value to write to MM5.
6838 Writes the current value of 64-bit MMX Register #6 (MM6).
6840 Writes the current value of MM6. This function is only available on IA32 and
6843 @param Value The 64-bit value to write to MM6.
6854 Writes the current value of 64-bit MMX Register #7 (MM7).
6856 Writes the current value of MM7. This function is only available on IA32 and
6859 @param Value The 64-bit value to write to MM7.
6870 Reads the current value of Time Stamp Counter (TSC).
6872 Reads and returns the current value of TSC. This function is only available
6875 @return The current value of TSC
6886 Reads the current value of a Performance Counter (PMC).
6888 Reads and returns the current value of performance counter specified by
6889 Index. This function is only available on IA-32 and X64.
6891 @param Index The 32-bit Performance Counter index to read.
6893 @return The value of the PMC specified by Index.
6904 Sets up a monitor buffer that is used by AsmMwait().
6906 Executes a MONITOR instruction with the register state specified by Eax, Ecx
6907 and Edx. 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
6913 @param Edx The value to load into EDX or RDX before executing the MONITOR
6929 Executes an MWAIT instruction.
6931 Executes an MWAIT instruction with the register state specified by Eax and
6932 Ecx. Returns Eax. This function is only available on IA-32 and X64.
6934 @param Eax The value to load into EAX or RAX before executing the MONITOR
6936 @param Ecx The value to load into ECX or RCX before executing the MONITOR
6951 Executes a WBINVD instruction.
6953 Executes a WBINVD instruction. This function is only available on IA-32 and
6965 Executes a INVD instruction.
6967 Executes a INVD instruction. This function is only available on IA-32 and
6979 Flushes a cache line from all the instruction and data caches within the
6980 coherency domain of the CPU.
6982 Flushed the cache line specified by LinearAddress, and returns LinearAddress.
6983 This function is only available on IA-32 and X64.
6985 @param LinearAddress The address of the cache line to flush. If the CPU is
6986 in a physical addressing mode, then LinearAddress is a
6987 physical address. If the CPU is in a virtual
6988 addressing mode, then LinearAddress is a virtual
6991 @return LinearAddress
6996 IN VOID
*LinearAddress
7001 Enables the 32-bit paging mode on the CPU.
7003 Enables the 32-bit paging mode on the CPU. CR0, CR3, CR4, and the page tables
7004 must be properly initialized prior to calling this service. This function
7005 assumes the current execution mode is 32-bit protected mode. This function is
7006 only available on IA-32. After the 32-bit paging mode is enabled, control is
7007 transferred to the function specified by EntryPoint using the new stack
7008 specified by NewStack and passing in the parameters specified by Context1 and
7009 Context2. Context1 and Context2 are optional and may be NULL. The function
7010 EntryPoint must never return.
7012 If the current execution mode is not 32-bit protected mode, then ASSERT().
7013 If EntryPoint is NULL, then ASSERT().
7014 If NewStack is NULL, then ASSERT().
7016 There are a number of constraints that must be followed before calling this
7018 1) Interrupts must be disabled.
7019 2) The caller must be in 32-bit protected mode with flat descriptors. This
7020 means all descriptors must have a base of 0 and a limit of 4GB.
7021 3) CR0 and CR4 must be compatible with 32-bit protected mode with flat
7023 4) CR3 must point to valid page tables that will be used once the transition
7024 is complete, and those page tables must guarantee that the pages for this
7025 function and the stack are identity mapped.
7027 @param EntryPoint A pointer to function to call with the new stack after
7029 @param Context1 A pointer to the context to pass into the EntryPoint
7030 function as the first parameter after paging is enabled.
7031 @param Context2 A pointer to the context to pass into the EntryPoint
7032 function as the second parameter after paging is enabled.
7033 @param NewStack A pointer to the new stack to use for the EntryPoint
7034 function after paging is enabled.
7040 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
7041 IN VOID
*Context1
, OPTIONAL
7042 IN VOID
*Context2
, OPTIONAL
7048 Disables the 32-bit paging mode on the CPU.
7050 Disables the 32-bit paging mode on the CPU and returns to 32-bit protected
7051 mode. This function assumes the current execution mode is 32-paged protected
7052 mode. This function is only available on IA-32. After the 32-bit paging mode
7053 is disabled, control is transferred to the function specified by EntryPoint
7054 using the new stack specified by NewStack and passing in the parameters
7055 specified by Context1 and Context2. Context1 and Context2 are optional and
7056 may be NULL. The function EntryPoint must never return.
7058 If the current execution mode is not 32-bit paged mode, then ASSERT().
7059 If EntryPoint is NULL, then ASSERT().
7060 If NewStack is NULL, then ASSERT().
7062 There are a number of constraints that must be followed before calling this
7064 1) Interrupts must be disabled.
7065 2) The caller must be in 32-bit paged mode.
7066 3) CR0, CR3, and CR4 must be compatible with 32-bit paged mode.
7067 4) CR3 must point to valid page tables that guarantee that the pages for
7068 this function and the stack are identity mapped.
7070 @param EntryPoint A pointer to function to call with the new stack after
7072 @param Context1 A pointer to the context to pass into the EntryPoint
7073 function as the first parameter after paging is disabled.
7074 @param Context2 A pointer to the context to pass into the EntryPoint
7075 function as the second parameter after paging is
7077 @param NewStack A pointer to the new stack to use for the EntryPoint
7078 function after paging is disabled.
7083 AsmDisablePaging32 (
7084 IN SWITCH_STACK_ENTRY_POINT EntryPoint
,
7085 IN VOID
*Context1
, OPTIONAL
7086 IN VOID
*Context2
, OPTIONAL
7092 Enables the 64-bit paging mode on the CPU.
7094 Enables the 64-bit paging mode on the CPU. CR0, CR3, CR4, and the page tables
7095 must be properly initialized prior to calling this service. This function
7096 assumes the current execution mode is 32-bit protected mode with flat
7097 descriptors. This function is only available on IA-32. After the 64-bit
7098 paging mode is enabled, control is transferred to the function specified by
7099 EntryPoint using the new stack specified by NewStack and passing in the
7100 parameters specified by Context1 and Context2. Context1 and Context2 are
7101 optional and may be 0. The function EntryPoint must never return.
7103 If the current execution mode is not 32-bit protected mode with flat
7104 descriptors, then ASSERT().
7105 If EntryPoint is 0, then ASSERT().
7106 If NewStack is 0, then ASSERT().
7108 @param Cs The 16-bit selector to load in the CS before EntryPoint
7109 is called. The descriptor in the GDT that this selector
7110 references must be setup for long mode.
7111 @param EntryPoint The 64-bit virtual address of the function to call with
7112 the new stack after paging is enabled.
7113 @param Context1 The 64-bit virtual address of the context to pass into
7114 the EntryPoint function as the first parameter after
7116 @param Context2 The 64-bit virtual address of the context to pass into
7117 the EntryPoint function as the second parameter after
7119 @param NewStack The 64-bit virtual address of the new stack to use for
7120 the EntryPoint function after paging is enabled.
7127 IN UINT64 EntryPoint
,
7128 IN UINT64 Context1
, OPTIONAL
7129 IN UINT64 Context2
, OPTIONAL
7135 Disables the 64-bit paging mode on the CPU.
7137 Disables the 64-bit paging mode on the CPU and returns to 32-bit protected
7138 mode. This function assumes the current execution mode is 64-paging mode.
7139 This function is only available on X64. After the 64-bit paging mode is
7140 disabled, control is transferred to the function specified by EntryPoint
7141 using the new stack specified by NewStack and passing in the parameters
7142 specified by Context1 and Context2. Context1 and Context2 are optional and
7143 may be 0. The function EntryPoint must never return.
7145 If the current execution mode is not 64-bit paged mode, then ASSERT().
7146 If EntryPoint is 0, then ASSERT().
7147 If NewStack is 0, then ASSERT().
7149 @param Cs The 16-bit selector to load in the CS before EntryPoint
7150 is called. The descriptor in the GDT that this selector
7151 references must be setup for 32-bit protected mode.
7152 @param EntryPoint The 64-bit virtual address of the function to call with
7153 the new stack after paging is disabled.
7154 @param Context1 The 64-bit virtual address of the context to pass into
7155 the EntryPoint function as the first parameter after
7157 @param Context2 The 64-bit virtual address of the context to pass into
7158 the EntryPoint function as the second parameter after
7160 @param NewStack The 64-bit virtual address of the new stack to use for
7161 the EntryPoint function after paging is disabled.
7166 AsmDisablePaging64 (
7168 IN UINT32 EntryPoint
,
7169 IN UINT32 Context1
, OPTIONAL
7170 IN UINT32 Context2
, OPTIONAL
7176 // 16-bit thunking services
7180 Retrieves the properties for 16-bit thunk functions.
7182 Computes the size of the buffer and stack below 1MB required to use the
7183 AsmPrepareThunk16(), AsmThunk16() and AsmPrepareAndThunk16() functions. This
7184 buffer size is returned in RealModeBufferSize, and the stack size is returned
7185 in ExtraStackSize. If parameters are passed to the 16-bit real mode code,
7186 then the actual minimum stack size is ExtraStackSize plus the maximum number
7187 of bytes that need to be passed to the 16-bit real mode code.
7189 If RealModeBufferSize is NULL, then ASSERT().
7190 If ExtraStackSize is NULL, then ASSERT().
7192 @param RealModeBufferSize A pointer to the size of the buffer below 1MB
7193 required to use the 16-bit thunk functions.
7194 @param ExtraStackSize A pointer to the extra size of stack below 1MB
7195 that the 16-bit thunk functions require for
7196 temporary storage in the transition to and from
7202 AsmGetThunk16Properties (
7203 OUT UINT32
*RealModeBufferSize
,
7204 OUT UINT32
*ExtraStackSize
7209 Prepares all structures a code required to use AsmThunk16().
7211 Prepares all structures and code required to use AsmThunk16().
7213 If ThunkContext is NULL, then ASSERT().
7215 @param ThunkContext A pointer to the context structure that describes the
7216 16-bit real mode code to call.
7222 OUT THUNK_CONTEXT
*ThunkContext
7227 Transfers control to a 16-bit real mode entry point and returns the results.
7229 Transfers control to a 16-bit real mode entry point and returns the results.
7230 AsmPrepareThunk16() must be called with ThunkContext before this function is used.
7231 This function must be called with interrupts disabled.
7233 The register state from the RealModeState field of ThunkContext is restored just prior
7234 to calling the 16-bit real mode entry point. This includes the EFLAGS field of RealModeState,
7235 which is used to set the interrupt state when a 16-bit real mode entry point is called.
7236 Control is transferred to the 16-bit real mode entry point specified by the CS and Eip fields of RealModeState.
7237 The stack is initialized to the SS and ESP fields of RealModeState. Any parameters passed to
7238 the 16-bit real mode code must be populated by the caller at SS:ESP prior to calling this function.
7239 The 16-bit real mode entry point is invoked with a 16-bit CALL FAR instruction,
7240 so when accessing stack contents, the 16-bit real mode code must account for the 16-bit segment
7241 and 16-bit offset of the return address that were pushed onto the stack. The 16-bit real mode entry
7242 point must exit with a RETF instruction. The register state is captured into RealModeState immediately
7243 after the RETF instruction is executed.
7245 If EFLAGS specifies interrupts enabled, or any of the 16-bit real mode code enables interrupts,
7246 or any of the 16-bit real mode code makes a SW interrupt, then the caller is responsible for making sure
7247 the IDT at address 0 is initialized to handle any HW or SW interrupts that may occur while in 16-bit real mode.
7249 If EFLAGS specifies interrupts enabled, or any of the 16-bit real mode code enables interrupts,
7250 then the caller is responsible for making sure the 8259 PIC is in a state compatible with 16-bit real mode.
7251 This includes the base vectors, the interrupt masks, and the edge/level trigger mode.
7253 If THUNK_ATTRIBUTE_BIG_REAL_MODE is set in the ThunkAttributes field of ThunkContext, then the user code
7254 is invoked in big real mode. Otherwise, the user code is invoked in 16-bit real mode with 64KB segment limits.
7256 If neither THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 nor THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL are set in
7257 ThunkAttributes, then it is assumed that the user code did not enable the A20 mask, and no attempt is made to
7258 disable the A20 mask.
7260 If THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 is set and THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL is clear in
7261 ThunkAttributes, then attempt to use the INT 15 service to disable the A20 mask. If this INT 15 call fails,
7262 then attempt to disable the A20 mask by directly accessing the 8042 keyboard controller I/O ports.
7264 If THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 is clear and THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL is set in
7265 ThunkAttributes, then attempt to disable the A20 mask by directly accessing the 8042 keyboard controller I/O ports.
7267 If ThunkContext is NULL, then ASSERT().
7268 If AsmPrepareThunk16() was not previously called with ThunkContext, then ASSERT().
7269 If both THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 and THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL are set in
7270 ThunkAttributes, then ASSERT().
7272 @param ThunkContext A pointer to the context structure that describes the
7273 16-bit real mode code to call.
7279 IN OUT THUNK_CONTEXT
*ThunkContext
7284 Prepares all structures and code for a 16-bit real mode thunk, transfers
7285 control to a 16-bit real mode entry point, and returns the results.
7287 Prepares all structures and code for a 16-bit real mode thunk, transfers
7288 control to a 16-bit real mode entry point, and returns the results. If the
7289 caller only need to perform a single 16-bit real mode thunk, then this
7290 service should be used. If the caller intends to make more than one 16-bit
7291 real mode thunk, then it is more efficient if AsmPrepareThunk16() is called
7292 once and AsmThunk16() can be called for each 16-bit real mode thunk.
7294 See AsmPrepareThunk16() and AsmThunk16() for the detailed description and ASSERT() conditions.
7296 @param ThunkContext A pointer to the context structure that describes the
7297 16-bit real mode code to call.
7302 AsmPrepareAndThunk16 (
7303 IN OUT THUNK_CONTEXT
*ThunkContext