X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=MdePkg%2FInclude%2FLibrary%2FBaseLib.h;h=123ae19dc263dc98e73174e877b37473b7d28a2a;hp=24f93c9bb140226cd449a520bc53ccfeb13c6796;hb=d7634dc0c5a83360b3b6c155df29c078ad9c77ce;hpb=aa0583c78369a5a85d7bf26c76240ae4e3086c42
diff --git a/MdePkg/Include/Library/BaseLib.h b/MdePkg/Include/Library/BaseLib.h
index 24f93c9bb1..123ae19dc2 100644
--- a/MdePkg/Include/Library/BaseLib.h
+++ b/MdePkg/Include/Library/BaseLib.h
@@ -1,31 +1,28 @@
/** @file
- Memory-only library functions with no library constructor/destructor
+ Provides string functions, linked list functions, math functions, synchronization
+ functions, file path functions, and CPU architecture-specific functions.
- Copyright (c) 2006 - 2008, Intel Corporation
- All rights reserved. This program and the accompanying materials
- are licensed and made available under the terms and conditions of the BSD License
- which accompanies this distribution. The full text of the license may be found at
- http://opensource.org/licenses/bsd-license.php
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.
+This program and the accompanying materials
+are licensed and made available under the terms and conditions of the BSD License
+which accompanies this distribution. The full text of the license may be found at
+http://opensource.org/licenses/bsd-license.php.
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#ifndef __BASE_LIB__
#define __BASE_LIB__
-///
-/// Definitions for SPIN_LOCK
-///
-typedef volatile UINTN SPIN_LOCK;
-
//
-// Definitions for architecture specific types
+// Definitions for architecture-specific types
//
#if defined (MDE_CPU_IA32)
///
-/// IA32 context buffer used by SetJump() and LongJump()
+/// The IA-32 architecture context buffer used by SetJump() and LongJump().
///
typedef struct {
UINT32 Ebx;
@@ -38,10 +35,12 @@ typedef struct {
#define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 4
-#elif defined (MDE_CPU_IPF)
+#endif // defined (MDE_CPU_IA32)
+
+#if defined (MDE_CPU_IPF)
///
-/// IPF context buffer used by SetJump() and LongJump()
+/// The Itanium architecture context buffer used by SetJump() and LongJump().
///
typedef struct {
UINT64 F2[2];
@@ -86,9 +85,11 @@ typedef struct {
#define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 0x10
-#elif defined (MDE_CPU_X64)
+#endif // defined (MDE_CPU_IPF)
+
+#if defined (MDE_CPU_X64)
///
-/// X64 context buffer used by SetJump() and LongJump()
+/// The x64 architecture context buffer used by SetJump() and LongJump().
///
typedef struct {
UINT64 Rbx;
@@ -101,33 +102,954 @@ typedef struct {
UINT64 R14;
UINT64 R15;
UINT64 Rip;
+ UINT64 MxCsr;
+ UINT8 XmmBuffer[160]; ///< XMM6-XMM15.
} BASE_LIBRARY_JUMP_BUFFER;
-#define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 8
+#define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 8
+
+#endif // defined (MDE_CPU_X64)
+
+#if defined (MDE_CPU_EBC)
+///
+/// The EBC context buffer used by SetJump() and LongJump().
+///
+typedef struct {
+ UINT64 R0;
+ UINT64 R1;
+ UINT64 R2;
+ UINT64 R3;
+ UINT64 IP;
+} BASE_LIBRARY_JUMP_BUFFER;
+
+#define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 8
+
+#endif // defined (MDE_CPU_EBC)
+
+#if defined (MDE_CPU_ARM)
+
+typedef struct {
+ UINT32 R3; ///< A copy of R13.
+ UINT32 R4;
+ UINT32 R5;
+ UINT32 R6;
+ UINT32 R7;
+ UINT32 R8;
+ UINT32 R9;
+ UINT32 R10;
+ UINT32 R11;
+ UINT32 R12;
+ UINT32 R14;
+} BASE_LIBRARY_JUMP_BUFFER;
+
+#define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 4
+
+#endif // defined (MDE_CPU_ARM)
+
+#if defined (MDE_CPU_AARCH64)
+typedef struct {
+ // GP regs
+ UINT64 X19;
+ UINT64 X20;
+ UINT64 X21;
+ UINT64 X22;
+ UINT64 X23;
+ UINT64 X24;
+ UINT64 X25;
+ UINT64 X26;
+ UINT64 X27;
+ UINT64 X28;
+ UINT64 FP;
+ UINT64 LR;
+ UINT64 IP0;
+
+ // FP regs
+ UINT64 D8;
+ UINT64 D9;
+ UINT64 D10;
+ UINT64 D11;
+ UINT64 D12;
+ UINT64 D13;
+ UINT64 D14;
+ UINT64 D15;
+} BASE_LIBRARY_JUMP_BUFFER;
+
+#define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 8
+
+#endif // defined (MDE_CPU_AARCH64)
+
+
+//
+// String Services
+//
+
+
+/**
+ Returns the length of a Null-terminated Unicode string.
+
+ This function is similar as strlen_s defined in C11.
+
+ If String is not aligned on a 16-bit boundary, then ASSERT().
+
+ @param String A pointer to a Null-terminated Unicode string.
+ @param MaxSize The maximum number of Destination Unicode
+ char, including terminating null char.
+
+ @retval 0 If String is NULL.
+ @retval MaxSize If there is no null character in the first MaxSize characters of String.
+ @return The number of characters that percede the terminating null character.
+
+**/
+UINTN
+EFIAPI
+StrnLenS (
+ IN CONST CHAR16 *String,
+ IN UINTN MaxSize
+ );
+
+/**
+ Returns the size of a Null-terminated Unicode string in bytes, including the
+ Null terminator.
+
+ This function returns the size of the Null-terminated Unicode string
+ specified by String in bytes, including the Null terminator.
+
+ If String is not aligned on a 16-bit boundary, then ASSERT().
+
+ @param String A pointer to a Null-terminated Unicode string.
+ @param MaxSize The maximum number of Destination Unicode
+ char, including the Null terminator.
+
+ @retval 0 If String is NULL.
+ @retval (sizeof (CHAR16) * (MaxSize + 1))
+ If there is no Null terminator in the first MaxSize characters of
+ String.
+ @return The size of the Null-terminated Unicode string in bytes, including
+ the Null terminator.
+
+**/
+UINTN
+EFIAPI
+StrnSizeS (
+ IN CONST CHAR16 *String,
+ IN UINTN MaxSize
+ );
+
+/**
+ Copies the string pointed to by Source (including the terminating null char)
+ to the array pointed to by Destination.
+
+ This function is similar as strcpy_s defined in C11.
+
+ If Destination is not aligned on a 16-bit boundary, then ASSERT().
+ If Source is not aligned on a 16-bit boundary, then ASSERT().
+ If an error would be returned, then the function will also ASSERT().
+
+ If an error is returned, then the Destination is unmodified.
+
+ @param Destination A pointer to a Null-terminated Unicode string.
+ @param DestMax The maximum number of Destination Unicode
+ char, including terminating null char.
+ @param Source A pointer to a Null-terminated Unicode string.
+
+ @retval RETURN_SUCCESS String is copied.
+ @retval RETURN_BUFFER_TOO_SMALL If DestMax is NOT greater than StrLen(Source).
+ @retval RETURN_INVALID_PARAMETER If Destination is NULL.
+ If Source is NULL.
+ If PcdMaximumUnicodeStringLength is not zero,
+ and DestMax is greater than
+ PcdMaximumUnicodeStringLength.
+ If DestMax is 0.
+ @retval RETURN_ACCESS_DENIED If Source and Destination overlap.
+**/
+RETURN_STATUS
+EFIAPI
+StrCpyS (
+ OUT CHAR16 *Destination,
+ IN UINTN DestMax,
+ IN CONST CHAR16 *Source
+ );
+
+/**
+ Copies not more than Length successive char from the string pointed to by
+ Source to the array pointed to by Destination. If no null char is copied from
+ Source, then Destination[Length] is always set to null.
+
+ This function is similar as strncpy_s defined in C11.
+
+ If Length > 0 and Destination is not aligned on a 16-bit boundary, then ASSERT().
+ If Length > 0 and Source is not aligned on a 16-bit boundary, then ASSERT().
+ If an error would be returned, then the function will also ASSERT().
+
+ If an error is returned, then the Destination is unmodified.
+
+ @param Destination A pointer to a Null-terminated Unicode string.
+ @param DestMax The maximum number of Destination Unicode
+ char, including terminating null char.
+ @param Source A pointer to a Null-terminated Unicode string.
+ @param Length The maximum number of Unicode characters to copy.
+
+ @retval RETURN_SUCCESS String is copied.
+ @retval RETURN_BUFFER_TOO_SMALL If DestMax is NOT greater than
+ MIN(StrLen(Source), Length).
+ @retval RETURN_INVALID_PARAMETER If Destination is NULL.
+ If Source is NULL.
+ If PcdMaximumUnicodeStringLength is not zero,
+ and DestMax is greater than
+ PcdMaximumUnicodeStringLength.
+ If DestMax is 0.
+ @retval RETURN_ACCESS_DENIED If Source and Destination overlap.
+**/
+RETURN_STATUS
+EFIAPI
+StrnCpyS (
+ OUT CHAR16 *Destination,
+ IN UINTN DestMax,
+ IN CONST CHAR16 *Source,
+ IN UINTN Length
+ );
+
+/**
+ Appends a copy of the string pointed to by Source (including the terminating
+ null char) to the end of the string pointed to by Destination.
+
+ This function is similar as strcat_s defined in C11.
+
+ If Destination is not aligned on a 16-bit boundary, then ASSERT().
+ If Source is not aligned on a 16-bit boundary, then ASSERT().
+ If an error would be returned, then the function will also ASSERT().
+
+ If an error is returned, then the Destination is unmodified.
+
+ @param Destination A pointer to a Null-terminated Unicode string.
+ @param DestMax The maximum number of Destination Unicode
+ char, including terminating null char.
+ @param Source A pointer to a Null-terminated Unicode string.
+
+ @retval RETURN_SUCCESS String is appended.
+ @retval RETURN_BAD_BUFFER_SIZE If DestMax is NOT greater than
+ StrLen(Destination).
+ @retval RETURN_BUFFER_TOO_SMALL If (DestMax - StrLen(Destination)) is NOT
+ greater than StrLen(Source).
+ @retval RETURN_INVALID_PARAMETER If Destination is NULL.
+ If Source is NULL.
+ If PcdMaximumUnicodeStringLength is not zero,
+ and DestMax is greater than
+ PcdMaximumUnicodeStringLength.
+ If DestMax is 0.
+ @retval RETURN_ACCESS_DENIED If Source and Destination overlap.
+**/
+RETURN_STATUS
+EFIAPI
+StrCatS (
+ IN OUT CHAR16 *Destination,
+ IN UINTN DestMax,
+ IN CONST CHAR16 *Source
+ );
+
+/**
+ Appends not more than Length successive char from the string pointed to by
+ Source to the end of the string pointed to by Destination. If no null char is
+ copied from Source, then Destination[StrLen(Destination) + Length] is always
+ set to null.
+
+ This function is similar as strncat_s defined in C11.
+
+ If Destination is not aligned on a 16-bit boundary, then ASSERT().
+ If Source is not aligned on a 16-bit boundary, then ASSERT().
+ If an error would be returned, then the function will also ASSERT().
+
+ If an error is returned, then the Destination is unmodified.
+
+ @param Destination A pointer to a Null-terminated Unicode string.
+ @param DestMax The maximum number of Destination Unicode
+ char, including terminating null char.
+ @param Source A pointer to a Null-terminated Unicode string.
+ @param Length The maximum number of Unicode characters to copy.
+
+ @retval RETURN_SUCCESS String is appended.
+ @retval RETURN_BAD_BUFFER_SIZE If DestMax is NOT greater than
+ StrLen(Destination).
+ @retval RETURN_BUFFER_TOO_SMALL If (DestMax - StrLen(Destination)) is NOT
+ greater than MIN(StrLen(Source), Length).
+ @retval RETURN_INVALID_PARAMETER If Destination is NULL.
+ If Source is NULL.
+ If PcdMaximumUnicodeStringLength is not zero,
+ and DestMax is greater than
+ PcdMaximumUnicodeStringLength.
+ If DestMax is 0.
+ @retval RETURN_ACCESS_DENIED If Source and Destination overlap.
+**/
+RETURN_STATUS
+EFIAPI
+StrnCatS (
+ IN OUT CHAR16 *Destination,
+ IN UINTN DestMax,
+ IN CONST CHAR16 *Source,
+ IN UINTN Length
+ );
+
+/**
+ Convert a Null-terminated Unicode decimal string to a value of type UINTN.
+
+ This function outputs a value of type UINTN by interpreting the contents of
+ the Unicode string specified by String as a decimal number. The format of the
+ input Unicode string String is:
+
+ [spaces] [decimal digits].
+
+ The valid decimal digit character is in the range [0-9]. The function will
+ ignore the pad space, which includes spaces or tab characters, before
+ [decimal digits]. The running zero in the beginning of [decimal digits] will
+ be ignored. Then, the function stops at the first character that is a not a
+ valid decimal character or a Null-terminator, whichever one comes first.
+
+ If String is NULL, then ASSERT().
+ If Data is NULL, then ASSERT().
+ If String is not aligned in a 16-bit boundary, then ASSERT().
+ If PcdMaximumUnicodeStringLength is not zero, and String contains more than
+ PcdMaximumUnicodeStringLength Unicode characters, not including the
+ Null-terminator, then ASSERT().
+
+ If String has no valid decimal digits in the above format, then 0 is stored
+ at the location pointed to by Data.
+ If the number represented by String exceeds the range defined by UINTN, then
+ MAX_UINTN is stored at the location pointed to by Data.
+
+ If EndPointer is not NULL, a pointer to the character that stopped the scan
+ is stored at the location pointed to by EndPointer. If String has no valid
+ decimal digits right after the optional pad spaces, the value of String is
+ stored at the location pointed to by EndPointer.
+
+ @param String Pointer to a Null-terminated Unicode string.
+ @param EndPointer Pointer to character that stops scan.
+ @param Data Pointer to the converted value.
+
+ @retval RETURN_SUCCESS Value is translated from String.
+ @retval RETURN_INVALID_PARAMETER If String is NULL.
+ If Data is NULL.
+ If PcdMaximumUnicodeStringLength is not
+ zero, and String contains more than
+ PcdMaximumUnicodeStringLength Unicode
+ characters, not including the
+ Null-terminator.
+ @retval RETURN_UNSUPPORTED If the number represented by String exceeds
+ the range defined by UINTN.
+
+**/
+RETURN_STATUS
+EFIAPI
+StrDecimalToUintnS (
+ IN CONST CHAR16 *String,
+ OUT CHAR16 **EndPointer, OPTIONAL
+ OUT UINTN *Data
+ );
+
+/**
+ Convert a Null-terminated Unicode decimal string to a value of type UINT64.
+
+ This function outputs a value of type UINT64 by interpreting the contents of
+ the Unicode string specified by String as a decimal number. The format of the
+ input Unicode string String is:
+
+ [spaces] [decimal digits].
+
+ The valid decimal digit character is in the range [0-9]. The function will
+ ignore the pad space, which includes spaces or tab characters, before
+ [decimal digits]. The running zero in the beginning of [decimal digits] will
+ be ignored. Then, the function stops at the first character that is a not a
+ valid decimal character or a Null-terminator, whichever one comes first.
+
+ If String is NULL, then ASSERT().
+ If Data is NULL, then ASSERT().
+ If String is not aligned in a 16-bit boundary, then ASSERT().
+ If PcdMaximumUnicodeStringLength is not zero, and String contains more than
+ PcdMaximumUnicodeStringLength Unicode characters, not including the
+ Null-terminator, then ASSERT().
+
+ If String has no valid decimal digits in the above format, then 0 is stored
+ at the location pointed to by Data.
+ If the number represented by String exceeds the range defined by UINT64, then
+ MAX_UINT64 is stored at the location pointed to by Data.
+
+ If EndPointer is not NULL, a pointer to the character that stopped the scan
+ is stored at the location pointed to by EndPointer. If String has no valid
+ decimal digits right after the optional pad spaces, the value of String is
+ stored at the location pointed to by EndPointer.
+
+ @param String Pointer to a Null-terminated Unicode string.
+ @param EndPointer Pointer to character that stops scan.
+ @param Data Pointer to the converted value.
+
+ @retval RETURN_SUCCESS Value is translated from String.
+ @retval RETURN_INVALID_PARAMETER If String is NULL.
+ If Data is NULL.
+ If PcdMaximumUnicodeStringLength is not
+ zero, and String contains more than
+ PcdMaximumUnicodeStringLength Unicode
+ characters, not including the
+ Null-terminator.
+ @retval RETURN_UNSUPPORTED If the number represented by String exceeds
+ the range defined by UINT64.
+
+**/
+RETURN_STATUS
+EFIAPI
+StrDecimalToUint64S (
+ IN CONST CHAR16 *String,
+ OUT CHAR16 **EndPointer, OPTIONAL
+ OUT UINT64 *Data
+ );
+
+/**
+ Convert a Null-terminated Unicode hexadecimal string to a value of type
+ UINTN.
+
+ This function outputs a value of type UINTN by interpreting the contents of
+ the Unicode string specified by String as a hexadecimal number. The format of
+ the input Unicode string String is:
+
+ [spaces][zeros][x][hexadecimal digits].
+
+ The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
+ The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix.
+ If "x" appears in the input string, it must be prefixed with at least one 0.
+ The function will ignore the pad space, which includes spaces or tab
+ characters, before [zeros], [x] or [hexadecimal digit]. The running zero
+ before [x] or [hexadecimal digit] will be ignored. Then, the decoding starts
+ after [x] or the first valid hexadecimal digit. Then, the function stops at
+ the first character that is a not a valid hexadecimal character or NULL,
+ whichever one comes first.
+
+ If String is NULL, then ASSERT().
+ If Data is NULL, then ASSERT().
+ If String is not aligned in a 16-bit boundary, then ASSERT().
+ If PcdMaximumUnicodeStringLength is not zero, and String contains more than
+ PcdMaximumUnicodeStringLength Unicode characters, not including the
+ Null-terminator, then ASSERT().
+
+ If String has no valid hexadecimal digits in the above format, then 0 is
+ stored at the location pointed to by Data.
+ If the number represented by String exceeds the range defined by UINTN, then
+ MAX_UINTN is stored at the location pointed to by Data.
+
+ If EndPointer is not NULL, a pointer to the character that stopped the scan
+ is stored at the location pointed to by EndPointer. If String has no valid
+ hexadecimal digits right after the optional pad spaces, the value of String
+ is stored at the location pointed to by EndPointer.
+
+ @param String Pointer to a Null-terminated Unicode string.
+ @param EndPointer Pointer to character that stops scan.
+ @param Data Pointer to the converted value.
+
+ @retval RETURN_SUCCESS Value is translated from String.
+ @retval RETURN_INVALID_PARAMETER If String is NULL.
+ If Data is NULL.
+ If PcdMaximumUnicodeStringLength is not
+ zero, and String contains more than
+ PcdMaximumUnicodeStringLength Unicode
+ characters, not including the
+ Null-terminator.
+ @retval RETURN_UNSUPPORTED If the number represented by String exceeds
+ the range defined by UINTN.
+
+**/
+RETURN_STATUS
+EFIAPI
+StrHexToUintnS (
+ IN CONST CHAR16 *String,
+ OUT CHAR16 **EndPointer, OPTIONAL
+ OUT UINTN *Data
+ );
+
+/**
+ Convert a Null-terminated Unicode hexadecimal string to a value of type
+ UINT64.
+
+ This function outputs a value of type UINT64 by interpreting the contents of
+ the Unicode string specified by String as a hexadecimal number. The format of
+ the input Unicode string String is:
+
+ [spaces][zeros][x][hexadecimal digits].
+
+ The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
+ The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix.
+ If "x" appears in the input string, it must be prefixed with at least one 0.
+ The function will ignore the pad space, which includes spaces or tab
+ characters, before [zeros], [x] or [hexadecimal digit]. The running zero
+ before [x] or [hexadecimal digit] will be ignored. Then, the decoding starts
+ after [x] or the first valid hexadecimal digit. Then, the function stops at
+ the first character that is a not a valid hexadecimal character or NULL,
+ whichever one comes first.
+
+ If String is NULL, then ASSERT().
+ If Data is NULL, then ASSERT().
+ If String is not aligned in a 16-bit boundary, then ASSERT().
+ If PcdMaximumUnicodeStringLength is not zero, and String contains more than
+ PcdMaximumUnicodeStringLength Unicode characters, not including the
+ Null-terminator, then ASSERT().
+
+ If String has no valid hexadecimal digits in the above format, then 0 is
+ stored at the location pointed to by Data.
+ If the number represented by String exceeds the range defined by UINT64, then
+ MAX_UINT64 is stored at the location pointed to by Data.
+
+ If EndPointer is not NULL, a pointer to the character that stopped the scan
+ is stored at the location pointed to by EndPointer. If String has no valid
+ hexadecimal digits right after the optional pad spaces, the value of String
+ is stored at the location pointed to by EndPointer.
+
+ @param String Pointer to a Null-terminated Unicode string.
+ @param EndPointer Pointer to character that stops scan.
+ @param Data Pointer to the converted value.
+
+ @retval RETURN_SUCCESS Value is translated from String.
+ @retval RETURN_INVALID_PARAMETER If String is NULL.
+ If Data is NULL.
+ If PcdMaximumUnicodeStringLength is not
+ zero, and String contains more than
+ PcdMaximumUnicodeStringLength Unicode
+ characters, not including the
+ Null-terminator.
+ @retval RETURN_UNSUPPORTED If the number represented by String exceeds
+ the range defined by UINT64.
+
+**/
+RETURN_STATUS
+EFIAPI
+StrHexToUint64S (
+ IN CONST CHAR16 *String,
+ OUT CHAR16 **EndPointer, OPTIONAL
+ OUT UINT64 *Data
+ );
+
+/**
+ Returns the length of a Null-terminated Ascii string.
+
+ This function is similar as strlen_s defined in C11.
+
+ @param String A pointer to a Null-terminated Ascii string.
+ @param MaxSize The maximum number of Destination Ascii
+ char, including terminating null char.
+
+ @retval 0 If String is NULL.
+ @retval MaxSize If there is no null character in the first MaxSize characters of String.
+ @return The number of characters that percede the terminating null character.
+
+**/
+UINTN
+EFIAPI
+AsciiStrnLenS (
+ IN CONST CHAR8 *String,
+ IN UINTN MaxSize
+ );
+
+/**
+ Returns the size of a Null-terminated Ascii string in bytes, including the
+ Null terminator.
+
+ This function returns the size of the Null-terminated Ascii string specified
+ by String in bytes, including the Null terminator.
+
+ @param String A pointer to a Null-terminated Ascii string.
+ @param MaxSize The maximum number of Destination Ascii
+ char, including the Null terminator.
+
+ @retval 0 If String is NULL.
+ @retval (sizeof (CHAR8) * (MaxSize + 1))
+ If there is no Null terminator in the first MaxSize characters of
+ String.
+ @return The size of the Null-terminated Ascii string in bytes, including the
+ Null terminator.
+
+**/
+UINTN
+EFIAPI
+AsciiStrnSizeS (
+ IN CONST CHAR8 *String,
+ IN UINTN MaxSize
+ );
+
+/**
+ Copies the string pointed to by Source (including the terminating null char)
+ to the array pointed to by Destination.
+
+ This function is similar as strcpy_s defined in C11.
+
+ If an error would be returned, then the function will also ASSERT().
+
+ If an error is returned, then the Destination is unmodified.
+
+ @param Destination A pointer to a Null-terminated Ascii string.
+ @param DestMax The maximum number of Destination Ascii
+ char, including terminating null char.
+ @param Source A pointer to a Null-terminated Ascii string.
+
+ @retval RETURN_SUCCESS String is copied.
+ @retval RETURN_BUFFER_TOO_SMALL If DestMax is NOT greater than StrLen(Source).
+ @retval RETURN_INVALID_PARAMETER If Destination is NULL.
+ If Source is NULL.
+ If PcdMaximumAsciiStringLength is not zero,
+ and DestMax is greater than
+ PcdMaximumAsciiStringLength.
+ If DestMax is 0.
+ @retval RETURN_ACCESS_DENIED If Source and Destination overlap.
+**/
+RETURN_STATUS
+EFIAPI
+AsciiStrCpyS (
+ OUT CHAR8 *Destination,
+ IN UINTN DestMax,
+ IN CONST CHAR8 *Source
+ );
+
+/**
+ Copies not more than Length successive char from the string pointed to by
+ Source to the array pointed to by Destination. If no null char is copied from
+ Source, then Destination[Length] is always set to null.
+
+ This function is similar as strncpy_s defined in C11.
+
+ If an error would be returned, then the function will also ASSERT().
+
+ If an error is returned, then the Destination is unmodified.
+
+ @param Destination A pointer to a Null-terminated Ascii string.
+ @param DestMax The maximum number of Destination Ascii
+ char, including terminating null char.
+ @param Source A pointer to a Null-terminated Ascii string.
+ @param Length The maximum number of Ascii characters to copy.
+
+ @retval RETURN_SUCCESS String is copied.
+ @retval RETURN_BUFFER_TOO_SMALL If DestMax is NOT greater than
+ MIN(StrLen(Source), Length).
+ @retval RETURN_INVALID_PARAMETER If Destination is NULL.
+ If Source is NULL.
+ If PcdMaximumAsciiStringLength is not zero,
+ and DestMax is greater than
+ PcdMaximumAsciiStringLength.
+ If DestMax is 0.
+ @retval RETURN_ACCESS_DENIED If Source and Destination overlap.
+**/
+RETURN_STATUS
+EFIAPI
+AsciiStrnCpyS (
+ OUT CHAR8 *Destination,
+ IN UINTN DestMax,
+ IN CONST CHAR8 *Source,
+ IN UINTN Length
+ );
+
+/**
+ Appends a copy of the string pointed to by Source (including the terminating
+ null char) to the end of the string pointed to by Destination.
+
+ This function is similar as strcat_s defined in C11.
+
+ If an error would be returned, then the function will also ASSERT().
+
+ If an error is returned, then the Destination is unmodified.
+
+ @param Destination A pointer to a Null-terminated Ascii string.
+ @param DestMax The maximum number of Destination Ascii
+ char, including terminating null char.
+ @param Source A pointer to a Null-terminated Ascii string.
+
+ @retval RETURN_SUCCESS String is appended.
+ @retval RETURN_BAD_BUFFER_SIZE If DestMax is NOT greater than
+ StrLen(Destination).
+ @retval RETURN_BUFFER_TOO_SMALL If (DestMax - StrLen(Destination)) is NOT
+ greater than StrLen(Source).
+ @retval RETURN_INVALID_PARAMETER If Destination is NULL.
+ If Source is NULL.
+ If PcdMaximumAsciiStringLength is not zero,
+ and DestMax is greater than
+ PcdMaximumAsciiStringLength.
+ If DestMax is 0.
+ @retval RETURN_ACCESS_DENIED If Source and Destination overlap.
+**/
+RETURN_STATUS
+EFIAPI
+AsciiStrCatS (
+ IN OUT CHAR8 *Destination,
+ IN UINTN DestMax,
+ IN CONST CHAR8 *Source
+ );
+
+/**
+ Appends not more than Length successive char from the string pointed to by
+ Source to the end of the string pointed to by Destination. If no null char is
+ copied from Source, then Destination[StrLen(Destination) + Length] is always
+ set to null.
+
+ This function is similar as strncat_s defined in C11.
+
+ If an error would be returned, then the function will also ASSERT().
+
+ If an error is returned, then the Destination is unmodified.
+
+ @param Destination A pointer to a Null-terminated Ascii string.
+ @param DestMax The maximum number of Destination Ascii
+ char, including terminating null char.
+ @param Source A pointer to a Null-terminated Ascii string.
+ @param Length The maximum number of Ascii characters to copy.
+
+ @retval RETURN_SUCCESS String is appended.
+ @retval RETURN_BAD_BUFFER_SIZE If DestMax is NOT greater than
+ StrLen(Destination).
+ @retval RETURN_BUFFER_TOO_SMALL If (DestMax - StrLen(Destination)) is NOT
+ greater than MIN(StrLen(Source), Length).
+ @retval RETURN_INVALID_PARAMETER If Destination is NULL.
+ If Source is NULL.
+ If PcdMaximumAsciiStringLength is not zero,
+ and DestMax is greater than
+ PcdMaximumAsciiStringLength.
+ If DestMax is 0.
+ @retval RETURN_ACCESS_DENIED If Source and Destination overlap.
+**/
+RETURN_STATUS
+EFIAPI
+AsciiStrnCatS (
+ IN OUT CHAR8 *Destination,
+ IN UINTN DestMax,
+ IN CONST CHAR8 *Source,
+ IN UINTN Length
+ );
+
+/**
+ Convert a Null-terminated Ascii decimal string to a value of type UINTN.
+
+ This function outputs a value of type UINTN by interpreting the contents of
+ the Ascii string specified by String as a decimal number. The format of the
+ input Ascii string String is:
+
+ [spaces] [decimal digits].
+
+ The valid decimal digit character is in the range [0-9]. The function will
+ ignore the pad space, which includes spaces or tab characters, before
+ [decimal digits]. The running zero in the beginning of [decimal digits] will
+ be ignored. Then, the function stops at the first character that is a not a
+ valid decimal character or a Null-terminator, whichever one comes first.
+
+ If String is NULL, then ASSERT().
+ If Data is NULL, then ASSERT().
+ If PcdMaximumAsciiStringLength is not zero, and String contains more than
+ PcdMaximumAsciiStringLength Ascii characters, not including the
+ Null-terminator, then ASSERT().
+
+ If String has no valid decimal digits in the above format, then 0 is stored
+ at the location pointed to by Data.
+ If the number represented by String exceeds the range defined by UINTN, then
+ MAX_UINTN is stored at the location pointed to by Data.
+
+ If EndPointer is not NULL, a pointer to the character that stopped the scan
+ is stored at the location pointed to by EndPointer. If String has no valid
+ decimal digits right after the optional pad spaces, the value of String is
+ stored at the location pointed to by EndPointer.
+
+ @param String Pointer to a Null-terminated Ascii string.
+ @param EndPointer Pointer to character that stops scan.
+ @param Data Pointer to the converted value.
+
+ @retval RETURN_SUCCESS Value is translated from String.
+ @retval RETURN_INVALID_PARAMETER If String is NULL.
+ If Data is NULL.
+ If PcdMaximumAsciiStringLength is not zero,
+ and String contains more than
+ PcdMaximumAsciiStringLength Ascii
+ characters, not including the
+ Null-terminator.
+ @retval RETURN_UNSUPPORTED If the number represented by String exceeds
+ the range defined by UINTN.
+
+**/
+RETURN_STATUS
+EFIAPI
+AsciiStrDecimalToUintnS (
+ IN CONST CHAR8 *String,
+ OUT CHAR8 **EndPointer, OPTIONAL
+ OUT UINTN *Data
+ );
+
+/**
+ Convert a Null-terminated Ascii decimal string to a value of type UINT64.
+
+ This function outputs a value of type UINT64 by interpreting the contents of
+ the Ascii string specified by String as a decimal number. The format of the
+ input Ascii string String is:
+
+ [spaces] [decimal digits].
+
+ The valid decimal digit character is in the range [0-9]. The function will
+ ignore the pad space, which includes spaces or tab characters, before
+ [decimal digits]. The running zero in the beginning of [decimal digits] will
+ be ignored. Then, the function stops at the first character that is a not a
+ valid decimal character or a Null-terminator, whichever one comes first.
+
+ If String is NULL, then ASSERT().
+ If Data is NULL, then ASSERT().
+ If PcdMaximumAsciiStringLength is not zero, and String contains more than
+ PcdMaximumAsciiStringLength Ascii characters, not including the
+ Null-terminator, then ASSERT().
+
+ If String has no valid decimal digits in the above format, then 0 is stored
+ at the location pointed to by Data.
+ If the number represented by String exceeds the range defined by UINT64, then
+ MAX_UINT64 is stored at the location pointed to by Data.
+
+ If EndPointer is not NULL, a pointer to the character that stopped the scan
+ is stored at the location pointed to by EndPointer. If String has no valid
+ decimal digits right after the optional pad spaces, the value of String is
+ stored at the location pointed to by EndPointer.
+
+ @param String Pointer to a Null-terminated Ascii string.
+ @param EndPointer Pointer to character that stops scan.
+ @param Data Pointer to the converted value.
+
+ @retval RETURN_SUCCESS Value is translated from String.
+ @retval RETURN_INVALID_PARAMETER If String is NULL.
+ If Data is NULL.
+ If PcdMaximumAsciiStringLength is not zero,
+ and String contains more than
+ PcdMaximumAsciiStringLength Ascii
+ characters, not including the
+ Null-terminator.
+ @retval RETURN_UNSUPPORTED If the number represented by String exceeds
+ the range defined by UINT64.
+
+**/
+RETURN_STATUS
+EFIAPI
+AsciiStrDecimalToUint64S (
+ IN CONST CHAR8 *String,
+ OUT CHAR8 **EndPointer, OPTIONAL
+ OUT UINT64 *Data
+ );
+
+/**
+ Convert a Null-terminated Ascii hexadecimal string to a value of type UINTN.
+
+ This function outputs a value of type UINTN by interpreting the contents of
+ the Ascii string specified by String as a hexadecimal number. The format of
+ the input Ascii string String is:
+
+ [spaces][zeros][x][hexadecimal digits].
+
+ The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
+ The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix. If
+ "x" appears in the input string, it must be prefixed with at least one 0. The
+ function will ignore the pad space, which includes spaces or tab characters,
+ before [zeros], [x] or [hexadecimal digits]. The running zero before [x] or
+ [hexadecimal digits] will be ignored. Then, the decoding starts after [x] or
+ the first valid hexadecimal digit. Then, the function stops at the first
+ character that is a not a valid hexadecimal character or Null-terminator,
+ whichever on comes first.
+
+ If String is NULL, then ASSERT().
+ If Data is NULL, then ASSERT().
+ If PcdMaximumAsciiStringLength is not zero, and String contains more than
+ PcdMaximumAsciiStringLength Ascii characters, not including the
+ Null-terminator, then ASSERT().
+
+ If String has no valid hexadecimal digits in the above format, then 0 is
+ stored at the location pointed to by Data.
+ If the number represented by String exceeds the range defined by UINTN, then
+ MAX_UINTN is stored at the location pointed to by Data.
+
+ If EndPointer is not NULL, a pointer to the character that stopped the scan
+ is stored at the location pointed to by EndPointer. If String has no valid
+ hexadecimal digits right after the optional pad spaces, the value of String
+ is stored at the location pointed to by EndPointer.
+
+ @param String Pointer to a Null-terminated Ascii string.
+ @param EndPointer Pointer to character that stops scan.
+ @param Data Pointer to the converted value.
+
+ @retval RETURN_SUCCESS Value is translated from String.
+ @retval RETURN_INVALID_PARAMETER If String is NULL.
+ If Data is NULL.
+ If PcdMaximumAsciiStringLength is not zero,
+ and String contains more than
+ PcdMaximumAsciiStringLength Ascii
+ characters, not including the
+ Null-terminator.
+ @retval RETURN_UNSUPPORTED If the number represented by String exceeds
+ the range defined by UINTN.
+
+**/
+RETURN_STATUS
+EFIAPI
+AsciiStrHexToUintnS (
+ IN CONST CHAR8 *String,
+ OUT CHAR8 **EndPointer, OPTIONAL
+ OUT UINTN *Data
+ );
+
+/**
+ Convert a Null-terminated Ascii hexadecimal string to a value of type UINT64.
+
+ This function outputs a value of type UINT64 by interpreting the contents of
+ the Ascii string specified by String as a hexadecimal number. The format of
+ the input Ascii string String is:
-#elif defined (MDE_CPU_EBC)
-///
-/// EBC context buffer used by SetJump() and LongJump()
-///
-typedef struct {
- UINT64 R0;
- UINT64 R1;
- UINT64 R2;
- UINT64 R3;
- UINT64 IP;
-} BASE_LIBRARY_JUMP_BUFFER;
+ [spaces][zeros][x][hexadecimal digits].
-#define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 8
+ The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
+ The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix. If
+ "x" appears in the input string, it must be prefixed with at least one 0. The
+ function will ignore the pad space, which includes spaces or tab characters,
+ before [zeros], [x] or [hexadecimal digits]. The running zero before [x] or
+ [hexadecimal digits] will be ignored. Then, the decoding starts after [x] or
+ the first valid hexadecimal digit. Then, the function stops at the first
+ character that is a not a valid hexadecimal character or Null-terminator,
+ whichever on comes first.
+
+ If String is NULL, then ASSERT().
+ If Data is NULL, then ASSERT().
+ If PcdMaximumAsciiStringLength is not zero, and String contains more than
+ PcdMaximumAsciiStringLength Ascii characters, not including the
+ Null-terminator, then ASSERT().
-#else
-#error Unknown Processor Type
-#endif
+ If String has no valid hexadecimal digits in the above format, then 0 is
+ stored at the location pointed to by Data.
+ If the number represented by String exceeds the range defined by UINT64, then
+ MAX_UINT64 is stored at the location pointed to by Data.
-//
-// String Services
-//
+ If EndPointer is not NULL, a pointer to the character that stopped the scan
+ is stored at the location pointed to by EndPointer. If String has no valid
+ hexadecimal digits right after the optional pad spaces, the value of String
+ is stored at the location pointed to by EndPointer.
+
+ @param String Pointer to a Null-terminated Ascii string.
+ @param EndPointer Pointer to character that stops scan.
+ @param Data Pointer to the converted value.
+
+ @retval RETURN_SUCCESS Value is translated from String.
+ @retval RETURN_INVALID_PARAMETER If String is NULL.
+ If Data is NULL.
+ If PcdMaximumAsciiStringLength is not zero,
+ and String contains more than
+ PcdMaximumAsciiStringLength Ascii
+ characters, not including the
+ Null-terminator.
+ @retval RETURN_UNSUPPORTED If the number represented by String exceeds
+ the range defined by UINT64.
+
+**/
+RETURN_STATUS
+EFIAPI
+AsciiStrHexToUint64S (
+ IN CONST CHAR8 *String,
+ OUT CHAR8 **EndPointer, OPTIONAL
+ OUT UINT64 *Data
+ );
+
+
+#ifndef DISABLE_NEW_DEPRECATED_INTERFACES
/**
+ [ATTENTION] This function is deprecated for security reason.
+
Copies one Null-terminated Unicode string to another Null-terminated Unicode
string and returns the new Unicode string.
@@ -144,10 +1066,10 @@ typedef struct {
PcdMaximumUnicodeStringLength Unicode characters not including the
Null-terminator, then ASSERT().
- @param Destination Pointer to a Null-terminated Unicode string.
- @param Source Pointer to a Null-terminated Unicode string.
+ @param Destination The pointer to a Null-terminated Unicode string.
+ @param Source The pointer to a Null-terminated Unicode string.
- @return Destiantion
+ @return Destination.
**/
CHAR16 *
@@ -159,9 +1081,10 @@ StrCpy (
/**
- Copies one Null-terminated Unicode string with a maximum length to another
- Null-terminated Unicode string with a maximum length and returns the new
- Unicode string.
+ [ATTENTION] This function is deprecated for security reason.
+
+ Copies up to a specified length from one Null-terminated Unicode string to
+ another Null-terminated Unicode string and returns the new Unicode string.
This function copies the contents of the Unicode string Source to the Unicode
string Destination, and returns Destination. At most, Length Unicode
@@ -174,17 +1097,19 @@ StrCpy (
If Length > 0 and Destination is NULL, then ASSERT().
If Length > 0 and Destination is not aligned on a 16-bit boundary, then ASSERT().
If Length > 0 and Source is NULL, then ASSERT().
- If Length > 0 and Source is not aligned on a 16-bit bounadry, then ASSERT().
+ If Length > 0 and Source is not aligned on a 16-bit boundary, then ASSERT().
If Source and Destination overlap, then ASSERT().
+ If PcdMaximumUnicodeStringLength is not zero, and Length is greater than
+ PcdMaximumUnicodeStringLength, then ASSERT().
If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
- PcdMaximumUnicodeStringLength Unicode characters not including the
- Null-terminator, then ASSERT().
+ PcdMaximumUnicodeStringLength Unicode characters, not including the Null-terminator,
+ then ASSERT().
- @param Destination Pointer to a Null-terminated Unicode string.
- @param Source Pointer to a Null-terminated Unicode string.
- @param Length Maximum number of Unicode characters to copy.
+ @param Destination The pointer to a Null-terminated Unicode string.
+ @param Source The pointer to a Null-terminated Unicode string.
+ @param Length The maximum number of Unicode characters to copy.
- @return Destination
+ @return Destination.
**/
CHAR16 *
@@ -194,7 +1119,7 @@ StrnCpy (
IN CONST CHAR16 *Source,
IN UINTN Length
);
-
+#endif // !defined (DISABLE_NEW_DEPRECATED_INTERFACES)
/**
Returns the length of a Null-terminated Unicode string.
@@ -224,8 +1149,8 @@ StrLen (
Returns the size of a Null-terminated Unicode string in bytes, including the
Null terminator.
- This function returns the size, in bytes, of the Null-terminated Unicode
- string specified by String.
+ This function returns the size, in bytes, of the Null-terminated Unicode string
+ specified by String.
If String is NULL, then ASSERT().
If String is not aligned on a 16-bit boundary, then ASSERT().
@@ -233,7 +1158,7 @@ StrLen (
PcdMaximumUnicodeStringLength Unicode characters not including the
Null-terminator, then ASSERT().
- @param String Pointer to a Null-terminated Unicode string.
+ @param String The pointer to a Null-terminated Unicode string.
@return The size of String.
@@ -263,11 +1188,11 @@ StrSize (
than PcdMaximumUnicodeStringLength Unicode characters not including the
Null-terminator, then ASSERT().
If PcdMaximumUnicodeStringLength is not zero, and SecondString contains more
- than PcdMaximumUnicodeStringLength Unicode characters not including the
+ than PcdMaximumUnicodeStringLength Unicode characters, not including the
Null-terminator, then ASSERT().
- @param FirstString Pointer to a Null-terminated Unicode string.
- @param SecondString Pointer to a Null-terminated Unicode string.
+ @param FirstString The pointer to a Null-terminated Unicode string.
+ @param SecondString The pointer to a Null-terminated Unicode string.
@retval 0 FirstString is identical to SecondString.
@return others FirstString is not identical to SecondString.
@@ -282,8 +1207,8 @@ StrCmp (
/**
- Compares two Null-terminated Unicode strings with maximum lengths, and
- returns the difference between the first mismatched Unicode characters.
+ Compares up to a specified length the contents of two Null-terminated Unicode strings,
+ and returns the difference between the first mismatched Unicode characters.
This function compares the Null-terminated Unicode string FirstString to the
Null-terminated Unicode string SecondString. At most, Length Unicode
@@ -293,19 +1218,21 @@ StrCmp (
subtracted from the first mismatched Unicode character in FirstString.
If Length > 0 and FirstString is NULL, then ASSERT().
- If Length > 0 and FirstString is not aligned on a 16-bit bounadary, then ASSERT().
+ If Length > 0 and FirstString is not aligned on a 16-bit boundary, then ASSERT().
If Length > 0 and SecondString is NULL, then ASSERT().
- If Length > 0 and SecondString is not aligned on a 16-bit bounadary, then ASSERT().
- If PcdMaximumUnicodeStringLength is not zero, and FirstString contains more
- than PcdMaximumUnicodeStringLength Unicode characters not including the
- Null-terminator, then ASSERT().
- If PcdMaximumUnicodeStringLength is not zero, and SecondString contains more
- than PcdMaximumUnicodeStringLength Unicode characters not including the
- Null-terminator, then ASSERT().
+ If Length > 0 and SecondString is not aligned on a 16-bit boundary, then ASSERT().
+ If PcdMaximumUnicodeStringLength is not zero, and Length is greater than
+ PcdMaximumUnicodeStringLength, then ASSERT().
+ If PcdMaximumUnicodeStringLength is not zero, and FirstString contains more than
+ PcdMaximumUnicodeStringLength Unicode characters, not including the Null-terminator,
+ then ASSERT().
+ If PcdMaximumUnicodeStringLength is not zero, and SecondString contains more than
+ PcdMaximumUnicodeStringLength Unicode characters, not including the Null-terminator,
+ then ASSERT().
- @param FirstString Pointer to a Null-terminated Unicode string.
- @param SecondString Pointer to a Null-terminated Unicode string.
- @param Length Maximum number of Unicode characters to compare.
+ @param FirstString The pointer to a Null-terminated Unicode string.
+ @param SecondString The pointer to a Null-terminated Unicode string.
+ @param Length The maximum number of Unicode characters to compare.
@retval 0 FirstString is identical to SecondString.
@return others FirstString is not identical to SecondString.
@@ -320,7 +1247,11 @@ StrnCmp (
);
+#ifndef DISABLE_NEW_DEPRECATED_INTERFACES
+
/**
+ [ATTENTION] This function is deprecated for security reason.
+
Concatenates one Null-terminated Unicode string to another Null-terminated
Unicode string, and returns the concatenated Unicode string.
@@ -331,25 +1262,25 @@ StrnCmp (
results are undefined.
If Destination is NULL, then ASSERT().
- If Destination is not aligned on a 16-bit bounadary, then ASSERT().
+ If Destination is not aligned on a 16-bit boundary, then ASSERT().
If Source is NULL, then ASSERT().
- If Source is not aligned on a 16-bit bounadary, then ASSERT().
+ If Source is not aligned on a 16-bit boundary, then ASSERT().
If Source and Destination overlap, then ASSERT().
If PcdMaximumUnicodeStringLength is not zero, and Destination contains more
- than PcdMaximumUnicodeStringLength Unicode characters not including the
+ than PcdMaximumUnicodeStringLength Unicode characters, not including the
Null-terminator, then ASSERT().
If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
- PcdMaximumUnicodeStringLength Unicode characters not including the
+ PcdMaximumUnicodeStringLength Unicode characters, not including the
Null-terminator, then ASSERT().
If PcdMaximumUnicodeStringLength is not zero, and concatenating Destination
and Source results in a Unicode string with more than
- PcdMaximumUnicodeStringLength Unicode characters not including the
+ PcdMaximumUnicodeStringLength Unicode characters, not including the
Null-terminator, then ASSERT().
- @param Destination Pointer to a Null-terminated Unicode string.
- @param Source Pointer to a Null-terminated Unicode string.
+ @param Destination The pointer to a Null-terminated Unicode string.
+ @param Source The pointer to a Null-terminated Unicode string.
- @return Destination
+ @return Destination.
**/
CHAR16 *
@@ -361,8 +1292,10 @@ StrCat (
/**
- Concatenates one Null-terminated Unicode string with a maximum length to the
- end of another Null-terminated Unicode string, and returns the concatenated
+ [ATTENTION] This function is deprecated for security reason.
+
+ Concatenates up to a specified length one Null-terminated Unicode to the end
+ of another Null-terminated Unicode string, and returns the concatenated
Unicode string.
This function concatenates two Null-terminated Unicode strings. The contents
@@ -378,23 +1311,24 @@ StrCat (
If Length > 0 and Source is NULL, then ASSERT().
If Length > 0 and Source is not aligned on a 16-bit boundary, then ASSERT().
If Source and Destination overlap, then ASSERT().
+ If PcdMaximumUnicodeStringLength is not zero, and Length is greater than
+ PcdMaximumUnicodeStringLength, then ASSERT().
If PcdMaximumUnicodeStringLength is not zero, and Destination contains more
- than PcdMaximumUnicodeStringLength Unicode characters not including the
+ than PcdMaximumUnicodeStringLength Unicode characters, not including the
Null-terminator, then ASSERT().
If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
- PcdMaximumUnicodeStringLength Unicode characters not including the
+ PcdMaximumUnicodeStringLength Unicode characters, not including the
Null-terminator, then ASSERT().
If PcdMaximumUnicodeStringLength is not zero, and concatenating Destination
- and Source results in a Unicode string with more than
- PcdMaximumUnicodeStringLength Unicode characters not including the
- Null-terminator, then ASSERT().
+ and Source results in a Unicode string with more than PcdMaximumUnicodeStringLength
+ Unicode characters, not including the Null-terminator, then ASSERT().
- @param Destination Pointer to a Null-terminated Unicode string.
- @param Source Pointer to a Null-terminated Unicode string.
- @param Length Maximum number of Unicode characters to concatenate from
+ @param Destination The pointer to a Null-terminated Unicode string.
+ @param Source The pointer to a Null-terminated Unicode string.
+ @param Length The maximum number of Unicode characters to concatenate from
Source.
- @return Destination
+ @return Destination.
**/
CHAR16 *
@@ -404,16 +1338,16 @@ StrnCat (
IN CONST CHAR16 *Source,
IN UINTN Length
);
+#endif // !defined (DISABLE_NEW_DEPRECATED_INTERFACES)
/**
- Returns the first occurance of a Null-terminated Unicode sub-string
+ Returns the first occurrence of a Null-terminated Unicode sub-string
in a Null-terminated Unicode string.
This function scans the contents of the Null-terminated Unicode string
specified by String and returns the first occurrence of SearchString.
If SearchString is not found in String, then NULL is returned. If
- the length of SearchString is zero, then String is
- returned.
+ the length of SearchString is zero, then String is returned.
If String is NULL, then ASSERT().
If String is not aligned on a 16-bit boundary, then ASSERT().
@@ -422,10 +1356,10 @@ StrnCat (
If PcdMaximumUnicodeStringLength is not zero, and SearchString
or String contains more than PcdMaximumUnicodeStringLength Unicode
- characters not including the Null-terminator, then ASSERT().
+ characters, not including the Null-terminator, then ASSERT().
- @param String Pointer to a Null-terminated Unicode string.
- @param SearchString Pointer to a Null-terminated Unicode string to search for.
+ @param String The pointer to a Null-terminated Unicode string.
+ @param SearchString The pointer to a Null-terminated Unicode string to search for.
@retval NULL If the SearchString does not appear in String.
@return others If there is a match.
@@ -434,8 +1368,8 @@ StrnCat (
CHAR16 *
EFIAPI
StrStr (
- IN CONST CHAR16 *String,
- IN CONST CHAR16 *SearchString
+ IN CONST CHAR16 *String,
+ IN CONST CHAR16 *SearchString
);
/**
@@ -461,13 +1395,13 @@ StrStr (
If String has no pad spaces or valid decimal digits,
then 0 is returned.
If the number represented by String overflows according
- to the range defined by UINTN, then ASSERT().
+ to the range defined by UINTN, then MAX_UINTN is returned.
If PcdMaximumUnicodeStringLength is not zero, and String contains
more than PcdMaximumUnicodeStringLength Unicode characters not including
the Null-terminator, then ASSERT().
- @param String Pointer to a Null-terminated Unicode string.
+ @param String The pointer to a Null-terminated Unicode string.
@retval Value translated from String.
@@ -475,7 +1409,7 @@ StrStr (
UINTN
EFIAPI
StrDecimalToUintn (
- IN CONST CHAR16 *String
+ IN CONST CHAR16 *String
);
/**
@@ -501,13 +1435,13 @@ StrDecimalToUintn (
If String has no pad spaces or valid decimal digits,
then 0 is returned.
If the number represented by String overflows according
- to the range defined by UINT64, then ASSERT().
+ to the range defined by UINT64, then MAX_UINT64 is returned.
If PcdMaximumUnicodeStringLength is not zero, and String contains
more than PcdMaximumUnicodeStringLength Unicode characters not including
the Null-terminator, then ASSERT().
- @param String Pointer to a Null-terminated Unicode string.
+ @param String The pointer to a Null-terminated Unicode string.
@retval Value translated from String.
@@ -515,9 +1449,9 @@ StrDecimalToUintn (
UINT64
EFIAPI
StrDecimalToUint64 (
- IN CONST CHAR16 *String
+ IN CONST CHAR16 *String
);
-
+
/**
Convert a Null-terminated Unicode hexadecimal string to a value of type UINTN.
@@ -534,8 +1468,8 @@ StrDecimalToUint64 (
The function will ignore the pad space, which includes spaces or tab characters,
before [zeros], [x] or [hexadecimal digit]. The running zero before [x] or
[hexadecimal digit] will be ignored. Then, the decoding starts after [x] or the
- first valid hexadecimal digit. Then, the function stops at the first character that is
- a not a valid hexadecimal character or NULL, whichever one comes first.
+ first valid hexadecimal digit. Then, the function stops at the first character
+ that is a not a valid hexadecimal character or NULL, whichever one comes first.
If String is NULL, then ASSERT().
If String is not aligned in a 16-bit boundary, then ASSERT().
@@ -543,13 +1477,13 @@ StrDecimalToUint64 (
If String has no leading pad spaces, leading zeros or valid hexadecimal digits,
then zero is returned.
If the number represented by String overflows according to the range defined by
- UINTN, then ASSERT().
+ UINTN, then MAX_UINTN is returned.
If PcdMaximumUnicodeStringLength is not zero, and String contains more than
PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator,
then ASSERT().
- @param String Pointer to a Null-terminated Unicode string.
+ @param String The pointer to a Null-terminated Unicode string.
@retval Value translated from String.
@@ -557,7 +1491,7 @@ StrDecimalToUint64 (
UINTN
EFIAPI
StrHexToUintn (
- IN CONST CHAR16 *String
+ IN CONST CHAR16 *String
);
@@ -585,13 +1519,13 @@ StrHexToUintn (
If String has no leading pad spaces, leading zeros or valid hexadecimal digits,
then zero is returned.
If the number represented by String overflows according to the range defined by
- UINT64, then ASSERT().
+ UINT64, then MAX_UINT64 is returned.
If PcdMaximumUnicodeStringLength is not zero, and String contains more than
PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator,
then ASSERT().
- @param String Pointer to a Null-terminated Unicode string.
+ @param String The pointer to a Null-terminated Unicode string.
@retval Value translated from String.
@@ -599,146 +1533,255 @@ StrHexToUintn (
UINT64
EFIAPI
StrHexToUint64 (
- IN CONST CHAR16 *String
+ IN CONST CHAR16 *String
);
/**
- Convert a nibble in the low 4 bits of a byte to a Unicode hexadecimal character.
+ Convert a Null-terminated Unicode string to IPv6 address and prefix length.
+
+ This function outputs a value of type IPv6_ADDRESS and may output a value
+ of type UINT8 by interpreting the contents of the Unicode string specified
+ by String. The format of the input Unicode string String is as follows:
+
+ X:X:X:X:X:X:X:X[/P]
+
+ X contains one to four hexadecimal digit characters in the range [0-9], [a-f] and
+ [A-F]. X is converted to a value of type UINT16, whose low byte is stored in low
+ memory address and high byte is stored in high memory address. P contains decimal
+ digit characters in the range [0-9]. The running zero in the beginning of P will
+ be ignored. /P is optional.
+
+ When /P is not in the String, the function stops at the first character that is
+ not a valid hexadecimal digit character after eight X's are converted.
+
+ When /P is in the String, the function stops at the first character that is not
+ a valid decimal digit character after P is converted.
+
+ "::" can be used to compress one or more groups of X when X contains only 0.
+ The "::" can only appear once in the String.
+
+ If String is NULL, then ASSERT().
- This function converts a nibble in the low 4 bits of a byte to a Unicode hexadecimal
- character For example, the nibble 0x01 and 0x0A will converted to L'1' and L'A'
- respectively.
+ If Address is NULL, then ASSERT().
- The upper nibble in the input byte will be masked off.
+ If String is not aligned in a 16-bit boundary, then ASSERT().
+
+ If PcdMaximumUnicodeStringLength is not zero, and String contains more than
+ PcdMaximumUnicodeStringLength Unicode characters, not including the
+ Null-terminator, then ASSERT().
- @param Nibble The nibble which is in the low 4 bits of the input byte.
+ If EndPointer is not NULL and Address is translated from String, a pointer
+ to the character that stopped the scan is stored at the location pointed to
+ by EndPointer.
+
+ @param String Pointer to a Null-terminated Unicode string.
+ @param EndPointer Pointer to character that stops scan.
+ @param Address Pointer to the converted IPv6 address.
+ @param PrefixLength Pointer to the converted IPv6 address prefix
+ length. MAX_UINT8 is returned when /P is
+ not in the String.
+
+ @retval RETURN_SUCCESS Address is translated from String.
+ @retval RETURN_INVALID_PARAMETER If String is NULL.
+ If Data is NULL.
+ @retval RETURN_UNSUPPORTED If X contains more than four hexadecimal
+ digit characters.
+ If String contains "::" and number of X
+ is not less than 8.
+ If P starts with character that is not a
+ valid decimal digit character.
+ If the decimal number converted from P
+ exceeds 128.
- @retval CHAR16 The Unicode hexadecimal character.
-
**/
-CHAR16
+RETURN_STATUS
EFIAPI
-NibbleToHexChar (
- IN UINT8 Nibble
+StrToIpv6Address (
+ IN CONST CHAR16 *String,
+ OUT CHAR16 **EndPointer, OPTIONAL
+ OUT IPv6_ADDRESS *Address,
+ OUT UINT8 *PrefixLength OPTIONAL
);
-/**
- Convert binary buffer to a Unicode String in a specified sequence.
+/**
+ Convert a Null-terminated Unicode string to IPv4 address and prefix length.
+
+ This function outputs a value of type IPv4_ADDRESS and may output a value
+ of type UINT8 by interpreting the contents of the Unicode string specified
+ by String. The format of the input Unicode string String is as follows:
+
+ D.D.D.D[/P]
+
+ D and P are decimal digit characters in the range [0-9]. The running zero in
+ the beginning of D and P will be ignored. /P is optional.
+
+ When /P is not in the String, the function stops at the first character that is
+ not a valid decimal digit character after four D's are converted.
+
+ When /P is in the String, the function stops at the first character that is not
+ a valid decimal digit character after P is converted.
+
+ If String is NULL, then ASSERT().
+
+ If Address is NULL, then ASSERT().
+
+ If String is not aligned in a 16-bit boundary, then ASSERT().
+
+ If PcdMaximumUnicodeStringLength is not zero, and String contains more than
+ PcdMaximumUnicodeStringLength Unicode characters, not including the
+ Null-terminator, then ASSERT().
+
+ If EndPointer is not NULL and Address is translated from String, a pointer
+ to the character that stopped the scan is stored at the location pointed to
+ by EndPointer.
- This function converts bytes in the memory block pointed by Buffer to a Unicode String Str.
- Each byte will be represented by two Unicode characters. For example, byte 0xA1 will
- be converted into two Unicode character L'A' and L'1'. In the output String, the Unicode Character
- for the Most Significant Nibble will be put before the Unicode Character for the Least Significant
- Nibble. The output string for the buffer containing a single byte 0xA1 will be L"A1".
- For a buffer with multiple bytes, the Unicode character produced by the first byte will be put into the
- the last character in the output string. The one next to first byte will be put into the
- character before the last character. This rules applies to the rest of the bytes. The Unicode
- character by the last byte will be put into the first character in the output string. For example,
- the input buffer for a 64-bits unsigned integrer 0x12345678abcdef1234 will be converted to
- a Unicode string equal to L"12345678abcdef1234".
+ @param String Pointer to a Null-terminated Unicode string.
+ @param EndPointer Pointer to character that stops scan.
+ @param Address Pointer to the converted IPv4 address.
+ @param PrefixLength Pointer to the converted IPv4 address prefix
+ length. MAX_UINT8 is returned when /P is
+ not in the String.
- @param String On input, String is pointed to the buffer allocated for the convertion.
- @param StringLen The Length of String buffer to hold the output String. The length must include the tailing '\0' character.
- The StringLen required to convert a N bytes Buffer will be a least equal to or greater
- than 2*N + 1.
- @param Buffer The pointer to a input buffer.
- @param BufferSizeInBytes Lenth in bytes of the input buffer.
-
+ @retval RETURN_SUCCESS Address is translated from String.
+ @retval RETURN_INVALID_PARAMETER If String is NULL.
+ If Data is NULL.
+ @retval RETURN_UNSUPPORTED If String is not in the correct format.
+ If any decimal number converted from D
+ exceeds 255.
+ If the decimal number converted from P
+ exceeds 32.
- @retval EFI_SUCCESS The convertion is successfull. All bytes in Buffer has been convert to the corresponding
- Unicode character and placed into the right place in String.
- @retval EFI_BUFFER_TOO_SMALL StringSizeInBytes is smaller than 2 * N + 1the number of bytes required to
- complete the convertion.
**/
RETURN_STATUS
EFIAPI
-BufToHexString (
- IN OUT CHAR16 *String,
- IN OUT UINTN *StringLen,
- IN CONST UINT8 *Buffer,
- IN UINTN BufferSizeInBytes
+StrToIpv4Address (
+ IN CONST CHAR16 *String,
+ OUT CHAR16 **EndPointer, OPTIONAL
+ OUT IPv4_ADDRESS *Address,
+ OUT UINT8 *PrefixLength OPTIONAL
);
+#define GUID_STRING_LENGTH 36
/**
- Convert a Unicode string consisting of hexadecimal characters to a output byte buffer.
+ Convert a Null-terminated Unicode GUID string to a value of type
+ EFI_GUID.
- This function converts a Unicode string consisting of characters in the range of Hexadecimal
- 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
- at the first non-hexadecimal character or the NULL character. The convertion process can be
- simply viewed as the reverse operations defined by BufToHexString. Two Unicode characters will be
- converted into one byte. The first Unicode character represents the Most Significant Nibble and the
- second Unicode character represents the Least Significant Nibble in the output byte.
- The first pair of Unicode characters represents the last byte in the output buffer. The second pair of Unicode
- characters represent the the byte preceding the last byte. This rule applies to the rest pairs of bytes.
- The last pair represent the first byte in the output buffer.
+ This function outputs a GUID value by interpreting the contents of
+ the Unicode string specified by String. The format of the input
+ Unicode string String consists of 36 characters, as follows:
- For example, a Unciode String L"12345678" will be converted into a buffer wil the following bytes
- (first byte is the byte in the lowest memory address): "0x78, 0x56, 0x34, 0x12".
+ aabbccdd-eeff-gghh-iijj-kkllmmnnoopp
+
+ The pairs aa - pp are two characters in the range [0-9], [a-f] and
+ [A-F], with each pair representing a single byte hexadecimal value.
+
+ The mapping between String and the EFI_GUID structure is as follows:
+ aa Data1[24:31]
+ bb Data1[16:23]
+ cc Data1[8:15]
+ dd Data1[0:7]
+ ee Data2[8:15]
+ ff Data2[0:7]
+ gg Data3[8:15]
+ hh Data3[0:7]
+ ii Data4[0:7]
+ jj Data4[8:15]
+ kk Data4[16:23]
+ ll Data4[24:31]
+ mm Data4[32:39]
+ nn Data4[40:47]
+ oo Data4[48:55]
+ pp Data4[56:63]
+
+ If String is NULL, then ASSERT().
+ If Guid is NULL, then ASSERT().
+ If String is not aligned in a 16-bit boundary, then ASSERT().
- If String has N valid hexadecimal characters for conversion, the caller must make sure Buffer is at least
- N/2 (if N is even) or (N+1)/2 (if N if odd) bytes.
+ @param String Pointer to a Null-terminated Unicode string.
+ @param Guid Pointer to the converted GUID.
- @param Buffer The output buffer allocated by the caller.
- @param BufferSizeInBytes On input, the size in bytes of Buffer. On output, it is updated to
- contain the size of the Buffer which is actually used for the converstion.
- For Unicode string with 2*N hexadecimal characters (not including the
- tailing NULL character), N bytes of Buffer will be used for the output.
- @param String The input hexadecimal string.
- @param ConvertedStrLen The number of hexadecimal characters used to produce content in output
- buffer Buffer.
+ @retval RETURN_SUCCESS Guid is translated from String.
+ @retval RETURN_INVALID_PARAMETER If String is NULL.
+ If Data is NULL.
+ @retval RETURN_UNSUPPORTED If String is not as the above format.
- @retval RETURN_BUFFER_TOO_SMALL The input BufferSizeInBytes is too small to hold the output. BufferSizeInBytes
- will be updated to the size required for the converstion.
- @retval RETURN_SUCCESS The convertion is successful or the first Unicode character from String
- is hexadecimal. If ConvertedStrLen is not NULL, it is updated
- to the number of hexadecimal character used for the converstion.
**/
RETURN_STATUS
EFIAPI
-HexStringToBuf (
- OUT UINT8 *Buffer,
- IN OUT UINTN *BufferSizeInBytes,
- IN CONST CHAR16 *String,
- OUT UINTN *ConvertedStrLen OPTIONAL
+StrToGuid (
+ IN CONST CHAR16 *String,
+ OUT GUID *Guid
);
-
/**
- Test if a Unicode character is a hexadecimal digit. If true, the input
- Unicode character is converted to a byte.
+ Convert a Null-terminated Unicode hexadecimal string to a byte array.
+
+ This function outputs a byte array by interpreting the contents of
+ the Unicode string specified by String in hexadecimal format. The format of
+ the input Unicode string String is:
+
+ [XX]*
+
+ X is a hexadecimal digit character in the range [0-9], [a-f] and [A-F].
+ The function decodes every two hexadecimal digit characters as one byte. The
+ decoding stops after Length of characters and outputs Buffer containing
+ (Length / 2) bytes.
+
+ If String is not aligned in a 16-bit boundary, then ASSERT().
+
+ If String is NULL, then ASSERT().
+
+ If Buffer is NULL, then ASSERT().
- This function tests if a Unicode character is a hexadecimal digit. If true, the input
- Unicode character is converted to a byte. For example, Unicode character
- L'A' will be converted to 0x0A.
+ If Length is not multiple of 2, then ASSERT().
- If Digit is NULL, then ASSERT.
+ If PcdMaximumUnicodeStringLength is not zero and Length is greater than
+ PcdMaximumUnicodeStringLength, then ASSERT().
- @param Digit The output hexadecimal digit.
+ If MaxBufferSize is less than (Length / 2), then ASSERT().
- @param Char The input Unicode character.
+ @param String Pointer to a Null-terminated Unicode string.
+ @param Length The number of Unicode characters to decode.
+ @param Buffer Pointer to the converted bytes array.
+ @param MaxBufferSize The maximum size of Buffer.
- @retval TRUE Char is in the range of Hexadecimal number. Digit is updated
- to the byte value of the number.
- @retval FALSE Char is not in the range of Hexadecimal number. Digit is keep
- intact.
-
+ @retval RETURN_SUCCESS Buffer is translated from String.
+ @retval RETURN_INVALID_PARAMETER If String is NULL.
+ If Data is NULL.
+ If Length is not multiple of 2.
+ If PcdMaximumUnicodeStringLength is not zero,
+ and Length is greater than
+ PcdMaximumUnicodeStringLength.
+ @retval RETURN_UNSUPPORTED If Length of characters from String contain
+ a character that is not valid hexadecimal
+ digit characters, or a Null-terminator.
+ @retval RETURN_BUFFER_TOO_SMALL If MaxBufferSize is less than (Length / 2).
**/
-BOOLEAN
+RETURN_STATUS
EFIAPI
-IsHexDigit (
- OUT UINT8 *Digit,
- IN CHAR16 Char
+StrHexToBytes (
+ IN CONST CHAR16 *String,
+ IN UINTN Length,
+ OUT UINT8 *Buffer,
+ IN UINTN MaxBufferSize
);
+#ifndef DISABLE_NEW_DEPRECATED_INTERFACES
+
/**
- Convert one Null-terminated Unicode string to a Null-terminated
+ [ATTENTION] This function is deprecated for security reason.
+
+ Convert a Null-terminated Unicode string to a Null-terminated
ASCII string and returns the ASCII string.
This function converts the content of the Unicode string Source
to the ASCII string Destination by copying the lower 8 bits of
each Unicode character. It returns Destination.
+ The caller is responsible to make sure Destination points to a buffer with size
+ equal or greater than ((StrLen (Source) + 1) * sizeof (CHAR8)) in bytes.
+
If any Unicode characters in Source contain non-zero value in
the upper 8 bits, then ASSERT().
@@ -755,21 +1798,129 @@ IsHexDigit (
than PcdMaximumAsciiStringLength Unicode characters not including the
Null-terminator, then ASSERT().
- @param Source Pointer to a Null-terminated Unicode string.
- @param Destination Pointer to a Null-terminated ASCII string.
+ @param Source The pointer to a Null-terminated Unicode string.
+ @param Destination The pointer to a Null-terminated ASCII string.
- @return Destination
+ @return Destination.
**/
CHAR8 *
EFIAPI
UnicodeStrToAsciiStr (
- IN CONST CHAR16 *Source,
- OUT CHAR8 *Destination
+ IN CONST CHAR16 *Source,
+ OUT CHAR8 *Destination
+ );
+
+#endif // !defined (DISABLE_NEW_DEPRECATED_INTERFACES)
+
+/**
+ Convert a Null-terminated Unicode string to a Null-terminated
+ ASCII string.
+
+ This function is similar to AsciiStrCpyS.
+
+ This function converts the content of the Unicode string Source
+ to the ASCII string Destination by copying the lower 8 bits of
+ each Unicode character. The function terminates the ASCII string
+ Destination by appending a Null-terminator character at the end.
+
+ The caller is responsible to make sure Destination points to a buffer with size
+ equal or greater than ((StrLen (Source) + 1) * sizeof (CHAR8)) in bytes.
+
+ If any Unicode characters in Source contain non-zero value in
+ the upper 8 bits, then ASSERT().
+
+ If Source is not aligned on a 16-bit boundary, then ASSERT().
+ If an error would be returned, then the function will also ASSERT().
+
+ If an error is returned, then the Destination is unmodified.
+
+ @param Source The pointer to a Null-terminated Unicode string.
+ @param Destination The pointer to a Null-terminated ASCII string.
+ @param DestMax The maximum number of Destination Ascii
+ char, including terminating null char.
+
+ @retval RETURN_SUCCESS String is converted.
+ @retval RETURN_BUFFER_TOO_SMALL If DestMax is NOT greater than StrLen(Source).
+ @retval RETURN_INVALID_PARAMETER If Destination is NULL.
+ If Source is NULL.
+ If PcdMaximumAsciiStringLength is not zero,
+ and DestMax is greater than
+ PcdMaximumAsciiStringLength.
+ If PcdMaximumUnicodeStringLength is not zero,
+ and DestMax is greater than
+ PcdMaximumUnicodeStringLength.
+ If DestMax is 0.
+ @retval RETURN_ACCESS_DENIED If Source and Destination overlap.
+
+**/
+RETURN_STATUS
+EFIAPI
+UnicodeStrToAsciiStrS (
+ IN CONST CHAR16 *Source,
+ OUT CHAR8 *Destination,
+ IN UINTN DestMax
+ );
+
+/**
+ Convert not more than Length successive characters from a Null-terminated
+ Unicode string to a Null-terminated Ascii string. If no null char is copied
+ from Source, then Destination[Length] is always set to null.
+
+ This function converts not more than Length successive characters from the
+ Unicode string Source to the Ascii string Destination by copying the lower 8
+ bits of each Unicode character. The function terminates the Ascii string
+ Destination by appending a Null-terminator character at the end.
+
+ The caller is responsible to make sure Destination points to a buffer with size
+ equal or greater than ((StrLen (Source) + 1) * sizeof (CHAR8)) in bytes.
+
+ If any Unicode characters in Source contain non-zero value in the upper 8
+ bits, then ASSERT().
+ If Source is not aligned on a 16-bit boundary, then ASSERT().
+ If an error would be returned, then the function will also ASSERT().
+
+ If an error is returned, then the Destination is unmodified.
+
+ @param Source The pointer to a Null-terminated Unicode string.
+ @param Length The maximum number of Unicode characters to
+ convert.
+ @param Destination The pointer to a Null-terminated Ascii string.
+ @param DestMax The maximum number of Destination Ascii
+ char, including terminating null char.
+ @param DestinationLength The number of Unicode characters converted.
+
+ @retval RETURN_SUCCESS String is converted.
+ @retval RETURN_INVALID_PARAMETER If Destination is NULL.
+ If Source is NULL.
+ If DestinationLength is NULL.
+ If PcdMaximumAsciiStringLength is not zero,
+ and Length or DestMax is greater than
+ PcdMaximumAsciiStringLength.
+ If PcdMaximumUnicodeStringLength is not
+ zero, and Length or DestMax is greater than
+ PcdMaximumUnicodeStringLength.
+ If DestMax is 0.
+ @retval RETURN_BUFFER_TOO_SMALL If DestMax is NOT greater than
+ MIN(StrLen(Source), Length).
+ @retval RETURN_ACCESS_DENIED If Source and Destination overlap.
+
+**/
+RETURN_STATUS
+EFIAPI
+UnicodeStrnToAsciiStrS (
+ IN CONST CHAR16 *Source,
+ IN UINTN Length,
+ OUT CHAR8 *Destination,
+ IN UINTN DestMax,
+ OUT UINTN *DestinationLength
);
+#ifndef DISABLE_NEW_DEPRECATED_INTERFACES
/**
+ [ATTENTION] This function is deprecated for security reason.
+
Copies one Null-terminated ASCII string to another Null-terminated ASCII
string and returns the new ASCII string.
@@ -784,8 +1935,8 @@ UnicodeStrToAsciiStr (
PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
then ASSERT().
- @param Destination Pointer to a Null-terminated ASCII string.
- @param Source Pointer to a Null-terminated ASCII string.
+ @param Destination The pointer to a Null-terminated ASCII string.
+ @param Source The pointer to a Null-terminated ASCII string.
@return Destination
@@ -799,9 +1950,10 @@ AsciiStrCpy (
/**
- Copies one Null-terminated ASCII string with a maximum length to another
- Null-terminated ASCII string with a maximum length and returns the new ASCII
- string.
+ [ATTENTION] This function is deprecated for security reason.
+
+ Copies up to a specified length one Null-terminated ASCII string to another
+ Null-terminated ASCII string and returns the new ASCII string.
This function copies the contents of the ASCII string Source to the ASCII
string Destination, and returns Destination. At most, Length ASCII characters
@@ -813,13 +1965,15 @@ AsciiStrCpy (
If Destination is NULL, then ASSERT().
If Source is NULL, then ASSERT().
If Source and Destination overlap, then ASSERT().
+ If PcdMaximumAsciiStringLength is not zero, and Length is greater than
+ PcdMaximumAsciiStringLength, then ASSERT().
If PcdMaximumAsciiStringLength is not zero, and Source contains more than
- PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
+ PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator,
then ASSERT().
- @param Destination Pointer to a Null-terminated ASCII string.
- @param Source Pointer to a Null-terminated ASCII string.
- @param Length Maximum number of ASCII characters to copy.
+ @param Destination The pointer to a Null-terminated ASCII string.
+ @param Source The pointer to a Null-terminated ASCII string.
+ @param Length The maximum number of ASCII characters to copy.
@return Destination
@@ -831,7 +1985,7 @@ AsciiStrnCpy (
IN CONST CHAR8 *Source,
IN UINTN Length
);
-
+#endif // !defined (DISABLE_NEW_DEPRECATED_INTERFACES)
/**
Returns the length of a Null-terminated ASCII string.
@@ -845,7 +1999,7 @@ AsciiStrnCpy (
PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
then ASSERT().
- @param String Pointer to a Null-terminated ASCII string.
+ @param String The pointer to a Null-terminated ASCII string.
@return The length of String.
@@ -869,7 +2023,7 @@ AsciiStrLen (
PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
then ASSERT().
- @param String Pointer to a Null-terminated ASCII string.
+ @param String The pointer to a Null-terminated ASCII string.
@return The size of String.
@@ -900,11 +2054,11 @@ AsciiStrSize (
than PcdMaximumAsciiStringLength ASCII characters not including the
Null-terminator, then ASSERT().
- @param FirstString Pointer to a Null-terminated ASCII string.
- @param SecondString Pointer to a Null-terminated ASCII string.
+ @param FirstString The pointer to a Null-terminated ASCII string.
+ @param SecondString The pointer to a Null-terminated ASCII string.
- @retval 0 FirstString is identical to SecondString.
- @return others FirstString is not identical to SecondString.
+ @retval ==0 FirstString is identical to SecondString.
+ @retval !=0 FirstString is not identical to SecondString.
**/
INTN
@@ -935,12 +2089,12 @@ AsciiStrCmp (
than PcdMaximumAsciiStringLength ASCII characters not including the
Null-terminator, then ASSERT().
- @param FirstString Pointer to a Null-terminated ASCII string.
- @param SecondString Pointer to a Null-terminated ASCII string.
+ @param FirstString The pointer to a Null-terminated ASCII string.
+ @param SecondString The pointer to a Null-terminated ASCII string.
- @retval 0 FirstString is identical to SecondString using case insensitive
+ @retval ==0 FirstString is identical to SecondString using case insensitive
comparisons.
- @return others FirstString is not identical to SecondString using case
+ @retval !=0 FirstString is not identical to SecondString using case
insensitive comparisons.
**/
@@ -965,19 +2119,21 @@ AsciiStriCmp (
If Length > 0 and FirstString is NULL, then ASSERT().
If Length > 0 and SecondString is NULL, then ASSERT().
- If PcdMaximumAsciiStringLength is not zero and FirstString contains more than
- PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
+ If PcdMaximumAsciiStringLength is not zero, and Length is greater than
+ PcdMaximumAsciiStringLength, then ASSERT().
+ If PcdMaximumAsciiStringLength is not zero, and FirstString contains more than
+ PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator,
then ASSERT().
- If PcdMaximumAsciiStringLength is not zero and SecondString contains more than
- PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
+ If PcdMaximumAsciiStringLength is not zero, and SecondString contains more than
+ PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator,
then ASSERT().
- @param FirstString Pointer to a Null-terminated ASCII string.
- @param SecondString Pointer to a Null-terminated ASCII string.
- @param Length Maximum number of ASCII characters for compare.
-
- @retval 0 FirstString is identical to SecondString.
- @return others FirstString is not identical to SecondString.
+ @param FirstString The pointer to a Null-terminated ASCII string.
+ @param SecondString The pointer to a Null-terminated ASCII string.
+ @param Length The maximum number of ASCII characters for compare.
+
+ @retval ==0 FirstString is identical to SecondString.
+ @retval !=0 FirstString is not identical to SecondString.
**/
INTN
@@ -989,7 +2145,11 @@ AsciiStrnCmp (
);
+#ifndef DISABLE_NEW_DEPRECATED_INTERFACES
+
/**
+ [ATTENTION] This function is deprecated for security reason.
+
Concatenates one Null-terminated ASCII string to another Null-terminated
ASCII string, and returns the concatenated ASCII string.
@@ -1010,8 +2170,8 @@ AsciiStrnCmp (
Source results in a ASCII string with more than PcdMaximumAsciiStringLength
ASCII characters, then ASSERT().
- @param Destination Pointer to a Null-terminated ASCII string.
- @param Source Pointer to a Null-terminated ASCII string.
+ @param Destination The pointer to a Null-terminated ASCII string.
+ @param Source The pointer to a Null-terminated ASCII string.
@return Destination
@@ -1025,9 +2185,11 @@ AsciiStrCat (
/**
- Concatenates one Null-terminated ASCII string with a maximum length to the
- end of another Null-terminated ASCII string, and returns the concatenated
- ASCII string.
+ [ATTENTION] This function is deprecated for security reason.
+
+ Concatenates up to a specified length one Null-terminated ASCII string to
+ the end of another Null-terminated ASCII string, and returns the
+ concatenated ASCII string.
This function concatenates two Null-terminated ASCII strings. The contents
of Null-terminated ASCII string Source are concatenated to the end of Null-
@@ -1040,19 +2202,21 @@ AsciiStrCat (
If Length > 0 and Destination is NULL, then ASSERT().
If Length > 0 and Source is NULL, then ASSERT().
If Source and Destination overlap, then ASSERT().
+ If PcdMaximumAsciiStringLength is not zero, and Length is greater than
+ PcdMaximumAsciiStringLength, then ASSERT().
If PcdMaximumAsciiStringLength is not zero, and Destination contains more than
- PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
+ PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator,
then ASSERT().
If PcdMaximumAsciiStringLength is not zero, and Source contains more than
- PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
+ PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator,
then ASSERT().
If PcdMaximumAsciiStringLength is not zero, and concatenating Destination and
Source results in a ASCII string with more than PcdMaximumAsciiStringLength
- ASCII characters not including the Null-terminator, then ASSERT().
+ ASCII characters, not including the Null-terminator, then ASSERT().
- @param Destination Pointer to a Null-terminated ASCII string.
- @param Source Pointer to a Null-terminated ASCII string.
- @param Length Maximum number of ASCII characters to concatenate from
+ @param Destination The pointer to a Null-terminated ASCII string.
+ @param Source The pointer to a Null-terminated ASCII string.
+ @param Length The maximum number of ASCII characters to concatenate from
Source.
@return Destination
@@ -1065,10 +2229,10 @@ AsciiStrnCat (
IN CONST CHAR8 *Source,
IN UINTN Length
);
-
+#endif // !defined (DISABLE_NEW_DEPRECATED_INTERFACES)
/**
- Returns the first occurance of a Null-terminated ASCII sub-string
+ Returns the first occurrence of a Null-terminated ASCII sub-string
in a Null-terminated ASCII string.
This function scans the contents of the ASCII string specified by String
@@ -1083,18 +2247,19 @@ AsciiStrnCat (
String contains more than PcdMaximumAsciiStringLength Unicode characters
not including the Null-terminator, then ASSERT().
- @param String Pointer to a Null-terminated ASCII string.
- @param SearchString Pointer to a Null-terminated ASCII string to search for.
+ @param String The pointer to a Null-terminated ASCII string.
+ @param SearchString The pointer to a Null-terminated ASCII string to search for.
@retval NULL If the SearchString does not appear in String.
- @return others If there is a match.
+ @retval others If there is a match return the first occurrence of SearchingString.
+ If the length of SearchString is zero,return String.
**/
CHAR8 *
EFIAPI
AsciiStrStr (
- IN CONST CHAR8 *String,
- IN CONST CHAR8 *SearchString
+ IN CONST CHAR8 *String,
+ IN CONST CHAR8 *SearchString
);
@@ -1117,15 +2282,15 @@ AsciiStrStr (
If String has only pad spaces, then 0 is returned.
If String has no pad spaces or valid decimal digits, then 0 is returned.
If the number represented by String overflows according to the range defined by
- UINTN, then ASSERT().
+ UINTN, then MAX_UINTN is returned.
If String is NULL, then ASSERT().
If PcdMaximumAsciiStringLength is not zero, and String contains more than
PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
then ASSERT().
- @param String Pointer to a Null-terminated ASCII string.
+ @param String The pointer to a Null-terminated ASCII string.
- @retval Value translated from String.
+ @retval The value translated from String.
**/
UINTN
@@ -1154,13 +2319,13 @@ AsciiStrDecimalToUintn (
If String has only pad spaces, then 0 is returned.
If String has no pad spaces or valid decimal digits, then 0 is returned.
If the number represented by String overflows according to the range defined by
- UINT64, then ASSERT().
+ UINT64, then MAX_UINT64 is returned.
If String is NULL, then ASSERT().
If PcdMaximumAsciiStringLength is not zero, and String contains more than
PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
then ASSERT().
- @param String Pointer to a Null-terminated ASCII string.
+ @param String The pointer to a Null-terminated ASCII string.
@retval Value translated from String.
@@ -1168,7 +2333,7 @@ AsciiStrDecimalToUintn (
UINT64
EFIAPI
AsciiStrDecimalToUint64 (
- IN CONST CHAR8 *String
+ IN CONST CHAR8 *String
);
@@ -1195,13 +2360,13 @@ AsciiStrDecimalToUint64 (
0 is returned.
If the number represented by String overflows according to the range defined by UINTN,
- then ASSERT().
+ then MAX_UINTN is returned.
If String is NULL, then ASSERT().
If PcdMaximumAsciiStringLength is not zero,
and String contains more than PcdMaximumAsciiStringLength ASCII characters not including
the Null-terminator, then ASSERT().
- @param String Pointer to a Null-terminated ASCII string.
+ @param String The pointer to a Null-terminated ASCII string.
@retval Value translated from String.
@@ -1209,7 +2374,7 @@ AsciiStrDecimalToUint64 (
UINTN
EFIAPI
AsciiStrHexToUintn (
- IN CONST CHAR8 *String
+ IN CONST CHAR8 *String
);
@@ -1235,26 +2400,243 @@ AsciiStrHexToUintn (
If String has no leading pad spaces, leading zeros or valid hexadecimal digits, then
0 is returned.
- If the number represented by String overflows according to the range defined by UINT64,
- then ASSERT().
+ If the number represented by String overflows according to the range defined by UINT64,
+ then MAX_UINT64 is returned.
+ If String is NULL, then ASSERT().
+ If PcdMaximumAsciiStringLength is not zero,
+ and String contains more than PcdMaximumAsciiStringLength ASCII characters not including
+ the Null-terminator, then ASSERT().
+
+ @param String The pointer to a Null-terminated ASCII string.
+
+ @retval Value translated from String.
+
+**/
+UINT64
+EFIAPI
+AsciiStrHexToUint64 (
+ IN CONST CHAR8 *String
+ );
+
+/**
+ Convert a Null-terminated ASCII string to IPv6 address and prefix length.
+
+ This function outputs a value of type IPv6_ADDRESS and may output a value
+ of type UINT8 by interpreting the contents of the ASCII string specified
+ by String. The format of the input ASCII string String is as follows:
+
+ X:X:X:X:X:X:X:X[/P]
+
+ X contains one to four hexadecimal digit characters in the range [0-9], [a-f] and
+ [A-F]. X is converted to a value of type UINT16, whose low byte is stored in low
+ memory address and high byte is stored in high memory address. P contains decimal
+ digit characters in the range [0-9]. The running zero in the beginning of P will
+ be ignored. /P is optional.
+
+ When /P is not in the String, the function stops at the first character that is
+ not a valid hexadecimal digit character after eight X's are converted.
+
+ When /P is in the String, the function stops at the first character that is not
+ a valid decimal digit character after P is converted.
+
+ "::" can be used to compress one or more groups of X when X contains only 0.
+ The "::" can only appear once in the String.
+
+ If String is NULL, then ASSERT().
+
+ If Address is NULL, then ASSERT().
+
+ If EndPointer is not NULL and Address is translated from String, a pointer
+ to the character that stopped the scan is stored at the location pointed to
+ by EndPointer.
+
+ @param String Pointer to a Null-terminated ASCII string.
+ @param EndPointer Pointer to character that stops scan.
+ @param Address Pointer to the converted IPv6 address.
+ @param PrefixLength Pointer to the converted IPv6 address prefix
+ length. MAX_UINT8 is returned when /P is
+ not in the String.
+
+ @retval RETURN_SUCCESS Address is translated from String.
+ @retval RETURN_INVALID_PARAMETER If String is NULL.
+ If Data is NULL.
+ @retval RETURN_UNSUPPORTED If X contains more than four hexadecimal
+ digit characters.
+ If String contains "::" and number of X
+ is not less than 8.
+ If P starts with character that is not a
+ valid decimal digit character.
+ If the decimal number converted from P
+ exceeds 128.
+
+**/
+RETURN_STATUS
+EFIAPI
+AsciiStrToIpv6Address (
+ IN CONST CHAR8 *String,
+ OUT CHAR8 **EndPointer, OPTIONAL
+ OUT IPv6_ADDRESS *Address,
+ OUT UINT8 *PrefixLength OPTIONAL
+ );
+
+/**
+ Convert a Null-terminated ASCII string to IPv4 address and prefix length.
+
+ This function outputs a value of type IPv4_ADDRESS and may output a value
+ of type UINT8 by interpreting the contents of the ASCII string specified
+ by String. The format of the input ASCII string String is as follows:
+
+ D.D.D.D[/P]
+
+ D and P are decimal digit characters in the range [0-9]. The running zero in
+ the beginning of D and P will be ignored. /P is optional.
+
+ When /P is not in the String, the function stops at the first character that is
+ not a valid decimal digit character after four D's are converted.
+
+ When /P is in the String, the function stops at the first character that is not
+ a valid decimal digit character after P is converted.
+
+ If String is NULL, then ASSERT().
+
+ If Address is NULL, then ASSERT().
+
+ If EndPointer is not NULL and Address is translated from String, a pointer
+ to the character that stopped the scan is stored at the location pointed to
+ by EndPointer.
+
+ @param String Pointer to a Null-terminated ASCII string.
+ @param EndPointer Pointer to character that stops scan.
+ @param Address Pointer to the converted IPv4 address.
+ @param PrefixLength Pointer to the converted IPv4 address prefix
+ length. MAX_UINT8 is returned when /P is
+ not in the String.
+
+ @retval RETURN_SUCCESS Address is translated from String.
+ @retval RETURN_INVALID_PARAMETER If String is NULL.
+ If Data is NULL.
+ @retval RETURN_UNSUPPORTED If String is not in the correct format.
+ If any decimal number converted from D
+ exceeds 255.
+ If the decimal number converted from P
+ exceeds 32.
+
+**/
+RETURN_STATUS
+EFIAPI
+AsciiStrToIpv4Address (
+ IN CONST CHAR8 *String,
+ OUT CHAR8 **EndPointer, OPTIONAL
+ OUT IPv4_ADDRESS *Address,
+ OUT UINT8 *PrefixLength OPTIONAL
+ );
+
+/**
+ Convert a Null-terminated ASCII GUID string to a value of type
+ EFI_GUID.
+
+ This function outputs a GUID value by interpreting the contents of
+ the ASCII string specified by String. The format of the input
+ ASCII string String consists of 36 characters, as follows:
+
+ aabbccdd-eeff-gghh-iijj-kkllmmnnoopp
+
+ The pairs aa - pp are two characters in the range [0-9], [a-f] and
+ [A-F], with each pair representing a single byte hexadecimal value.
+
+ The mapping between String and the EFI_GUID structure is as follows:
+ aa Data1[24:31]
+ bb Data1[16:23]
+ cc Data1[8:15]
+ dd Data1[0:7]
+ ee Data2[8:15]
+ ff Data2[0:7]
+ gg Data3[8:15]
+ hh Data3[0:7]
+ ii Data4[0:7]
+ jj Data4[8:15]
+ kk Data4[16:23]
+ ll Data4[24:31]
+ mm Data4[32:39]
+ nn Data4[40:47]
+ oo Data4[48:55]
+ pp Data4[56:63]
+
+ If String is NULL, then ASSERT().
+ If Guid is NULL, then ASSERT().
+
+ @param String Pointer to a Null-terminated ASCII string.
+ @param Guid Pointer to the converted GUID.
+
+ @retval RETURN_SUCCESS Guid is translated from String.
+ @retval RETURN_INVALID_PARAMETER If String is NULL.
+ If Data is NULL.
+ @retval RETURN_UNSUPPORTED If String is not as the above format.
+
+**/
+RETURN_STATUS
+EFIAPI
+AsciiStrToGuid (
+ IN CONST CHAR8 *String,
+ OUT GUID *Guid
+ );
+
+/**
+ Convert a Null-terminated ASCII hexadecimal string to a byte array.
+
+ This function outputs a byte array by interpreting the contents of
+ the ASCII string specified by String in hexadecimal format. The format of
+ the input ASCII string String is:
+
+ [XX]*
+
+ X is a hexadecimal digit character in the range [0-9], [a-f] and [A-F].
+ The function decodes every two hexadecimal digit characters as one byte. The
+ decoding stops after Length of characters and outputs Buffer containing
+ (Length / 2) bytes.
+
If String is NULL, then ASSERT().
- If PcdMaximumAsciiStringLength is not zero,
- and String contains more than PcdMaximumAsciiStringLength ASCII characters not including
- the Null-terminator, then ASSERT().
- @param String Pointer to a Null-terminated ASCII string.
+ If Buffer is NULL, then ASSERT().
+
+ If Length is not multiple of 2, then ASSERT().
- @retval Value translated from String.
+ If PcdMaximumAsciiStringLength is not zero and Length is greater than
+ PcdMaximumAsciiStringLength, then ASSERT().
+
+ If MaxBufferSize is less than (Length / 2), then ASSERT().
+
+ @param String Pointer to a Null-terminated ASCII string.
+ @param Length The number of ASCII characters to decode.
+ @param Buffer Pointer to the converted bytes array.
+ @param MaxBufferSize The maximum size of Buffer.
+ @retval RETURN_SUCCESS Buffer is translated from String.
+ @retval RETURN_INVALID_PARAMETER If String is NULL.
+ If Data is NULL.
+ If Length is not multiple of 2.
+ If PcdMaximumAsciiStringLength is not zero,
+ and Length is greater than
+ PcdMaximumAsciiStringLength.
+ @retval RETURN_UNSUPPORTED If Length of characters from String contain
+ a character that is not valid hexadecimal
+ digit characters, or a Null-terminator.
+ @retval RETURN_BUFFER_TOO_SMALL If MaxBufferSize is less than (Length / 2).
**/
-UINT64
+RETURN_STATUS
EFIAPI
-AsciiStrHexToUint64 (
- IN CONST CHAR8 *String
+AsciiStrHexToBytes (
+ IN CONST CHAR8 *String,
+ IN UINTN Length,
+ OUT UINT8 *Buffer,
+ IN UINTN MaxBufferSize
);
+#ifndef DISABLE_NEW_DEPRECATED_INTERFACES
/**
+ [ATTENTION] This function is deprecated for security reason.
+
Convert one Null-terminated ASCII string to a Null-terminated
Unicode string and returns the Unicode string.
@@ -1275,19 +2657,118 @@ AsciiStrHexToUint64 (
PcdMaximumUnicodeStringLength ASCII characters not including the
Null-terminator, then ASSERT().
- @param Source Pointer to a Null-terminated ASCII string.
- @param Destination Pointer to a Null-terminated Unicode string.
+ @param Source The pointer to a Null-terminated ASCII string.
+ @param Destination The pointer to a Null-terminated Unicode string.
- @return Destination
+ @return Destination.
**/
CHAR16 *
EFIAPI
AsciiStrToUnicodeStr (
- IN CONST CHAR8 *Source,
- OUT CHAR16 *Destination
+ IN CONST CHAR8 *Source,
+ OUT CHAR16 *Destination
+ );
+
+#endif // !defined (DISABLE_NEW_DEPRECATED_INTERFACES)
+
+/**
+ Convert one Null-terminated ASCII string to a Null-terminated
+ Unicode string.
+
+ This function is similar to StrCpyS.
+
+ This function converts the contents of the ASCII string Source to the Unicode
+ string Destination. The function terminates the Unicode string Destination by
+ appending a Null-terminator character at the end.
+
+ The caller is responsible to make sure Destination points to a buffer with size
+ equal or greater than ((AsciiStrLen (Source) + 1) * sizeof (CHAR16)) in bytes.
+
+ If Destination is not aligned on a 16-bit boundary, then ASSERT().
+ If an error would be returned, then the function will also ASSERT().
+
+ If an error is returned, then the Destination is unmodified.
+
+ @param Source The pointer to a Null-terminated ASCII string.
+ @param Destination The pointer to a Null-terminated Unicode string.
+ @param DestMax The maximum number of Destination Unicode
+ char, including terminating null char.
+
+ @retval RETURN_SUCCESS String is converted.
+ @retval RETURN_BUFFER_TOO_SMALL If DestMax is NOT greater than StrLen(Source).
+ @retval RETURN_INVALID_PARAMETER If Destination is NULL.
+ If Source is NULL.
+ If PcdMaximumUnicodeStringLength is not zero,
+ and DestMax is greater than
+ PcdMaximumUnicodeStringLength.
+ If PcdMaximumAsciiStringLength is not zero,
+ and DestMax is greater than
+ PcdMaximumAsciiStringLength.
+ If DestMax is 0.
+ @retval RETURN_ACCESS_DENIED If Source and Destination overlap.
+
+**/
+RETURN_STATUS
+EFIAPI
+AsciiStrToUnicodeStrS (
+ IN CONST CHAR8 *Source,
+ OUT CHAR16 *Destination,
+ IN UINTN DestMax
);
+/**
+ Convert not more than Length successive characters from a Null-terminated
+ Ascii string to a Null-terminated Unicode string. If no null char is copied
+ from Source, then Destination[Length] is always set to null.
+
+ This function converts not more than Length successive characters from the
+ Ascii string Source to the Unicode string Destination. The function
+ terminates the Unicode string Destination by appending a Null-terminator
+ character at the end.
+
+ The caller is responsible to make sure Destination points to a buffer with
+ size not smaller than
+ ((MIN(AsciiStrLen(Source), Length) + 1) * sizeof (CHAR8)) in bytes.
+
+ If Destination is not aligned on a 16-bit boundary, then ASSERT().
+ If an error would be returned, then the function will also ASSERT().
+
+ If an error is returned, then Destination and DestinationLength are
+ unmodified.
+
+ @param Source The pointer to a Null-terminated Ascii string.
+ @param Length The maximum number of Ascii characters to convert.
+ @param Destination The pointer to a Null-terminated Unicode string.
+ @param DestMax The maximum number of Destination Unicode char,
+ including terminating null char.
+ @param DestinationLength The number of Ascii characters converted.
+
+ @retval RETURN_SUCCESS String is converted.
+ @retval RETURN_INVALID_PARAMETER If Destination is NULL.
+ If Source is NULL.
+ If DestinationLength is NULL.
+ If PcdMaximumUnicodeStringLength is not
+ zero, and Length or DestMax is greater than
+ PcdMaximumUnicodeStringLength.
+ If PcdMaximumAsciiStringLength is not zero,
+ and Length or DestMax is greater than
+ PcdMaximumAsciiStringLength.
+ If DestMax is 0.
+ @retval RETURN_BUFFER_TOO_SMALL If DestMax is NOT greater than
+ MIN(AsciiStrLen(Source), Length).
+ @retval RETURN_ACCESS_DENIED If Source and Destination overlap.
+
+**/
+RETURN_STATUS
+EFIAPI
+AsciiStrnToUnicodeStrS (
+ IN CONST CHAR8 *Source,
+ IN UINTN Length,
+ OUT CHAR16 *Destination,
+ IN UINTN DestMax,
+ OUT UINTN *DestinationLength
+ );
/**
Converts an 8-bit value to an 8-bit BCD value.
@@ -1299,7 +2780,7 @@ AsciiStrToUnicodeStr (
@param Value The 8-bit value to convert to BCD. Range 0..99.
- @return The BCD value
+ @return The BCD value.
**/
UINT8
@@ -1329,6 +2810,42 @@ BcdToDecimal8 (
IN UINT8 Value
);
+//
+// File Path Manipulation Functions
+//
+
+/**
+ Removes the last directory or file entry in a path.
+
+ @param[in, out] Path The pointer to the path to modify.
+
+ @retval FALSE Nothing was found to remove.
+ @retval TRUE A directory or file was removed.
+**/
+BOOLEAN
+EFIAPI
+PathRemoveLastItem(
+ IN OUT CHAR16 *Path
+ );
+
+/**
+ Function to clean up paths.
+ - Single periods in the path are removed.
+ - Double periods in the path are removed along with a single parent directory.
+ - Forward slashes L'/' are converted to backward slashes L'\'.
+
+ This will be done inline and the existing buffer may be larger than required
+ upon completion.
+
+ @param[in] Path The pointer to the string containing the path.
+
+ @return Returns Path, otherwise returns NULL to indicate that an error has occurred.
+**/
+CHAR16*
+EFIAPI
+PathCleanUpDirectories(
+ IN CHAR16 *Path
+ );
//
// Linked List Functions and Macros
@@ -1345,10 +2862,37 @@ BcdToDecimal8 (
instead if calling the InitializeListHead() function to perform the
equivalent operation.
- @param ListHead The head note of a list to initiailize.
+ @param ListHead The head note of a list to initialize.
+
+**/
+#define INITIALIZE_LIST_HEAD_VARIABLE(ListHead) {&(ListHead), &(ListHead)}
+
+
+/**
+ Checks whether FirstEntry and SecondEntry are part of the same doubly-linked
+ list.
+
+ If FirstEntry is NULL, then ASSERT().
+ If FirstEntry->ForwardLink is NULL, then ASSERT().
+ If FirstEntry->BackLink is NULL, then ASSERT().
+ If SecondEntry is NULL, then ASSERT();
+ If PcdMaximumLinkedListLength is not zero, and List contains more than
+ PcdMaximumLinkedListLength nodes, then ASSERT().
+
+ @param FirstEntry A pointer to a node in a linked list.
+ @param SecondEntry A pointer to the node to locate.
+
+ @retval TRUE SecondEntry is in the same doubly-linked list as FirstEntry.
+ @retval FALSE SecondEntry isn't in the same doubly-linked list as FirstEntry,
+ or FirstEntry is invalid.
**/
-#define INITIALIZE_LIST_HEAD_VARIABLE(ListHead) {&ListHead, &ListHead}
+BOOLEAN
+EFIAPI
+IsNodeInList (
+ IN CONST LIST_ENTRY *FirstEntry,
+ IN CONST LIST_ENTRY *SecondEntry
+ );
/**
@@ -1383,8 +2927,9 @@ InitializeListHead (
If ListHead is NULL, then ASSERT().
If Entry is NULL, then ASSERT().
- If ListHead was not initialized with InitializeListHead(), then ASSERT().
- If PcdMaximumLinkedListLenth is not zero, and prior to insertion the number
+ If ListHead was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or
+ InitializeListHead(), then ASSERT().
+ If PcdMaximumLinkedListLength is not zero, and prior to insertion the number
of nodes in ListHead, including the ListHead node, is greater than or
equal to PcdMaximumLinkedListLength, then ASSERT().
@@ -1412,8 +2957,9 @@ InsertHeadList (
If ListHead is NULL, then ASSERT().
If Entry is NULL, then ASSERT().
- If ListHead was not initialized with InitializeListHead(), then ASSERT().
- If PcdMaximumLinkedListLenth is not zero, and prior to insertion the number
+ If ListHead was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or
+ InitializeListHead(), then ASSERT().
+ If PcdMaximumLinkedListLength is not zero, and prior to insertion the number
of nodes in ListHead, including the ListHead node, is greater than or
equal to PcdMaximumLinkedListLength, then ASSERT().
@@ -1435,20 +2981,21 @@ InsertTailList (
/**
Retrieves the first node of a doubly linked list.
- Returns the first node of a doubly linked list. List must have been
- initialized with InitializeListHead(). If List is empty, then NULL is
- returned.
+ Returns the first node of a doubly linked list. List must have been
+ initialized with INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead().
+ If List is empty, then List is returned.
If List is NULL, then ASSERT().
- If List was not initialized with InitializeListHead(), then ASSERT().
- If PcdMaximumLinkedListLenth is not zero, and the number of nodes
+ If List was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or
+ InitializeListHead(), then ASSERT().
+ If PcdMaximumLinkedListLength is not zero, and the number of nodes
in List, including the List node, is greater than or equal to
PcdMaximumLinkedListLength, then ASSERT().
@param List A pointer to the head node of a doubly linked list.
@return The first node of a doubly linked list.
- @retval NULL The list is empty.
+ @retval List The list is empty.
**/
LIST_ENTRY *
@@ -1461,22 +3008,22 @@ GetFirstNode (
/**
Retrieves the next node of a doubly linked list.
- Returns the node of a doubly linked list that follows Node. List must have
- been initialized with InitializeListHead(). If List is empty, then List is
- returned.
+ Returns the node of a doubly linked list that follows Node.
+ List must have been initialized with INTIALIZE_LIST_HEAD_VARIABLE()
+ or InitializeListHead(). If List is empty, then List is returned.
If List is NULL, then ASSERT().
If Node is NULL, then ASSERT().
- If List was not initialized with InitializeListHead(), then ASSERT().
- If PcdMaximumLinkedListLenth is not zero, and List contains more than
- PcdMaximumLinkedListLenth nodes, then ASSERT().
- If Node is not a node in List, then ASSERT().
+ If List was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or
+ InitializeListHead(), then ASSERT().
+ If PcdMaximumLinkedListLength is not zero, and List contains more than
+ PcdMaximumLinkedListLength nodes, then ASSERT().
+ If PcdVerifyNodeInList is TRUE and Node is not a node in List, then ASSERT().
@param List A pointer to the head node of a doubly linked list.
@param Node A pointer to a node in the doubly linked list.
- @return Pointer to the next node if one exists. Otherwise a null value which
- is actually List is returned.
+ @return The pointer to the next node if one exists. Otherwise List is returned.
**/
LIST_ENTRY *
@@ -1487,6 +3034,35 @@ GetNextNode (
);
+/**
+ Retrieves the previous node of a doubly linked list.
+
+ Returns the node of a doubly linked list that precedes Node.
+ List must have been initialized with INTIALIZE_LIST_HEAD_VARIABLE()
+ or InitializeListHead(). If List is empty, then List is returned.
+
+ If List is NULL, then ASSERT().
+ If Node is NULL, then ASSERT().
+ If List was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or
+ InitializeListHead(), then ASSERT().
+ If PcdMaximumLinkedListLength is not zero, and List contains more than
+ PcdMaximumLinkedListLength nodes, then ASSERT().
+ If PcdVerifyNodeInList is TRUE and Node is not a node in List, then ASSERT().
+
+ @param List A pointer to the head node of a doubly linked list.
+ @param Node A pointer to a node in the doubly linked list.
+
+ @return The pointer to the previous node if one exists. Otherwise List is returned.
+
+**/
+LIST_ENTRY *
+EFIAPI
+GetPreviousNode (
+ IN CONST LIST_ENTRY *List,
+ IN CONST LIST_ENTRY *Node
+ );
+
+
/**
Checks to see if a doubly linked list is empty or not.
@@ -1494,8 +3070,9 @@ GetNextNode (
zero nodes, this function returns TRUE. Otherwise, it returns FALSE.
If ListHead is NULL, then ASSERT().
- If ListHead was not initialized with InitializeListHead(), then ASSERT().
- If PcdMaximumLinkedListLenth is not zero, and the number of nodes
+ If ListHead was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or
+ InitializeListHead(), then ASSERT().
+ If PcdMaximumLinkedListLength is not zero, and the number of nodes
in List, including the List node, is greater than or equal to
PcdMaximumLinkedListLength, then ASSERT().
@@ -1519,21 +3096,23 @@ IsListEmpty (
Returns TRUE if Node is equal to List. Returns FALSE if Node is one of the
nodes in the doubly linked list specified by List. List must have been
- initialized with InitializeListHead().
+ initialized with INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead().
If List is NULL, then ASSERT().
If Node is NULL, then ASSERT().
- If List was not initialized with InitializeListHead(), then ASSERT().
- If PcdMaximumLinkedListLenth is not zero, and the number of nodes
+ If List was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead(),
+ then ASSERT().
+ If PcdMaximumLinkedListLength is not zero, and the number of nodes
in List, including the List node, is greater than or equal to
PcdMaximumLinkedListLength, then ASSERT().
- If Node is not a node in List and Node is not equal to List, then ASSERT().
+ If PcdVerifyNodeInList is TRUE and Node is not a node in List the and Node is not equal
+ to List, then ASSERT().
@param List A pointer to the head node of a doubly linked list.
@param Node A pointer to a node in the doubly linked list.
- @retval TRUE Node is one of the nodes in the doubly linked list.
- @retval FALSE Node is not one of the nodes in the doubly linked list.
+ @retval TRUE Node is the head of the doubly-linked list pointed by List.
+ @retval FALSE Node is not the head of the doubly-linked list pointed by List.
**/
BOOLEAN
@@ -1549,15 +3128,16 @@ IsNull (
Returns TRUE if Node is the last node in the doubly linked list specified by
List. Otherwise, FALSE is returned. List must have been initialized with
- InitializeListHead().
+ INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead().
If List is NULL, then ASSERT().
If Node is NULL, then ASSERT().
- If List was not initialized with InitializeListHead(), then ASSERT().
- If PcdMaximumLinkedListLenth is not zero, and the number of nodes
+ If List was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or
+ InitializeListHead(), then ASSERT().
+ If PcdMaximumLinkedListLength is not zero, and the number of nodes
in List, including the List node, is greater than or equal to
PcdMaximumLinkedListLength, then ASSERT().
- If Node is not a node in List, then ASSERT().
+ If PcdVerifyNodeInList is TRUE and Node is not a node in List, then ASSERT().
@param List A pointer to the head node of a doubly linked list.
@param Node A pointer to a node in the doubly linked list.
@@ -1582,12 +3162,13 @@ IsNodeAtEnd (
Otherwise, the location of the FirstEntry node is swapped with the location
of the SecondEntry node in a doubly linked list. SecondEntry must be in the
same double linked list as FirstEntry and that double linked list must have
- been initialized with InitializeListHead(). SecondEntry is returned after the
- nodes are swapped.
+ been initialized with INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead().
+ SecondEntry is returned after the nodes are swapped.
If FirstEntry is NULL, then ASSERT().
If SecondEntry is NULL, then ASSERT().
- If SecondEntry and FirstEntry are not in the same linked list, then ASSERT().
+ If PcdVerifyNodeInList is TRUE and SecondEntry and FirstEntry are not in the
+ same linked list, then ASSERT().
If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
linked list containing the FirstEntry and SecondEntry nodes, including
the FirstEntry and SecondEntry nodes, is greater than or equal to
@@ -1595,8 +3176,8 @@ IsNodeAtEnd (
@param FirstEntry A pointer to a node in a linked list.
@param SecondEntry A pointer to another node in the same linked list.
-
- @return SecondEntry
+
+ @return SecondEntry.
**/
LIST_ENTRY *
@@ -1623,9 +3204,9 @@ SwapListEntries (
linked list containing Entry, including the Entry node, is greater than
or equal to PcdMaximumLinkedListLength, then ASSERT().
- @param Entry A pointer to a node in a linked list
+ @param Entry A pointer to a node in a linked list.
- @return Entry
+ @return Entry.
**/
LIST_ENTRY *
@@ -1650,7 +3231,7 @@ RemoveEntryList (
@param Operand The 64-bit operand to shift left.
@param Count The number of bits to shift left.
- @return Operand << Count
+ @return Operand << Count.
**/
UINT64
@@ -1720,7 +3301,7 @@ ARShiftU64 (
@param Operand The 32-bit operand to rotate left.
@param Count The number of bits to rotate left.
- @return Operand <<< Count
+ @return Operand << Count
**/
UINT32
@@ -1744,7 +3325,7 @@ LRotU32 (
@param Operand The 32-bit operand to rotate right.
@param Count The number of bits to rotate right.
- @return Operand >>> Count
+ @return Operand >> Count
**/
UINT32
@@ -1768,7 +3349,7 @@ RRotU32 (
@param Operand The 64-bit operand to rotate left.
@param Count The number of bits to rotate left.
- @return Operand <<< Count
+ @return Operand << Count
**/
UINT64
@@ -1792,7 +3373,7 @@ LRotU64 (
@param Operand The 64-bit operand to rotate right.
@param Count The number of bits to rotate right.
- @return Operand >>> Count
+ @return Operand >> Count
**/
UINT64
@@ -1812,8 +3393,8 @@ RRotU64 (
@param Operand The 32-bit operand to evaluate.
- @return Position of the lowest bit set in Operand if found.
- @retval -1 Operand is zero.
+ @retval 0..31 The lowest bit set in Operand was found.
+ @retval -1 Operand is zero.
**/
INTN
@@ -1832,8 +3413,9 @@ LowBitSet32 (
@param Operand The 64-bit operand to evaluate.
- @return Position of the lowest bit set in Operand if found.
- @retval -1 Operand is zero.
+ @retval 0..63 The lowest bit set in Operand was found.
+ @retval -1 Operand is zero.
+
**/
INTN
@@ -1853,8 +3435,8 @@ LowBitSet64 (
@param Operand The 32-bit operand to evaluate.
- @return Position of the highest bit set in Operand if found.
- @retval -1 Operand is zero.
+ @retval 0..31 Position of the highest bit set in Operand if found.
+ @retval -1 Operand is zero.
**/
INTN
@@ -1874,8 +3456,8 @@ HighBitSet32 (
@param Operand The 64-bit operand to evaluate.
- @return Position of the highest bit set in Operand if found.
- @retval -1 Operand is zero.
+ @retval 0..63 Position of the highest bit set in Operand if found.
+ @retval -1 Operand is zero.
**/
INTN
@@ -1887,7 +3469,7 @@ HighBitSet64 (
/**
Returns the value of the highest bit set in a 32-bit value. Equivalent to
- 1 << HighBitSet32(x).
+ 1 << log2(x).
This function computes the value of the highest bit set in the 32-bit value
specified by Operand. If Operand is zero, then zero is returned.
@@ -1907,7 +3489,7 @@ GetPowerOfTwo32 (
/**
Returns the value of the highest bit set in a 64-bit value. Equivalent to
- 1 << HighBitSet64(x).
+ 1 << log2(x).
This function computes the value of the highest bit set in the 64-bit value
specified by Operand. If Operand is zero, then zero is returned.
@@ -1926,15 +3508,15 @@ GetPowerOfTwo64 (
/**
- Switches the endianess of a 16-bit integer.
+ Switches the endianness of a 16-bit integer.
This function swaps the bytes in a 16-bit unsigned value to switch the value
from little endian to big endian or vice versa. The byte swapped value is
returned.
- @param Value Operand A 16-bit unsigned value.
+ @param Value A 16-bit unsigned value.
- @return The byte swaped Operand.
+ @return The byte swapped Value.
**/
UINT16
@@ -1945,15 +3527,15 @@ SwapBytes16 (
/**
- Switches the endianess of a 32-bit integer.
+ Switches the endianness of a 32-bit integer.
This function swaps the bytes in a 32-bit unsigned value to switch the value
from little endian to big endian or vice versa. The byte swapped value is
returned.
- @param Value Operand A 32-bit unsigned value.
+ @param Value A 32-bit unsigned value.
- @return The byte swaped Operand.
+ @return The byte swapped Value.
**/
UINT32
@@ -1964,15 +3546,15 @@ SwapBytes32 (
/**
- Switches the endianess of a 64-bit integer.
+ Switches the endianness of a 64-bit integer.
This function swaps the bytes in a 64-bit unsigned value to switch the value
from little endian to big endian or vice versa. The byte swapped value is
returned.
- @param Value Operand A 64-bit unsigned value.
+ @param Value A 64-bit unsigned value.
- @return The byte swaped Operand.
+ @return The byte swapped Value.
**/
UINT64
@@ -1990,8 +3572,6 @@ SwapBytes64 (
unsigned value Multiplier and generates a 64-bit unsigned result. This 64-
bit unsigned result is returned.
- If the result overflows, then ASSERT().
-
@param Multiplicand A 64-bit unsigned value.
@param Multiplier A 32-bit unsigned value.
@@ -2014,12 +3594,10 @@ MultU64x32 (
unsigned value Multiplier and generates a 64-bit unsigned result. This 64-
bit unsigned result is returned.
- If the result overflows, then ASSERT().
-
@param Multiplicand A 64-bit unsigned value.
@param Multiplier A 64-bit unsigned value.
- @return Multiplicand * Multiplier
+ @return Multiplicand * Multiplier.
**/
UINT64
@@ -2038,8 +3616,6 @@ MultU64x64 (
signed value Multiplier and generates a 64-bit signed result. This 64-bit
signed result is returned.
- If the result overflows, then ASSERT().
-
@param Multiplicand A 64-bit signed value.
@param Multiplier A 64-bit signed value.
@@ -2067,7 +3643,7 @@ MultS64x64 (
@param Dividend A 64-bit unsigned value.
@param Divisor A 32-bit unsigned value.
- @return Dividend / Divisor
+ @return Dividend / Divisor.
**/
UINT64
@@ -2091,7 +3667,7 @@ DivU64x32 (
@param Dividend A 64-bit unsigned value.
@param Divisor A 32-bit unsigned value.
- @return Dividend % Divisor
+ @return Dividend % Divisor.
**/
UINT32
@@ -2118,7 +3694,7 @@ ModU64x32 (
@param Remainder A pointer to a 32-bit unsigned value. This parameter is
optional and may be NULL.
- @return Dividend / Divisor
+ @return Dividend / Divisor.
**/
UINT64
@@ -2146,7 +3722,7 @@ DivU64x32Remainder (
@param Remainder A pointer to a 64-bit unsigned value. This parameter is
optional and may be NULL.
- @return Dividend / Divisor
+ @return Dividend / Divisor.
**/
UINT64
@@ -2167,6 +3743,10 @@ DivU64x64Remainder (
NULL, then the 64-bit signed remainder is returned in Remainder. This
function returns the 64-bit signed quotient.
+ It is the caller's responsibility to not call this function with a Divisor of 0.
+ If Divisor is 0, then the quotient and remainder should be assumed to be
+ the largest negative integer.
+
If Divisor is 0, then ASSERT().
@param Dividend A 64-bit signed value.
@@ -2174,7 +3754,7 @@ DivU64x64Remainder (
@param Remainder A pointer to a 64-bit signed value. This parameter is
optional and may be NULL.
- @return Dividend / Divisor
+ @return Dividend / Divisor.
**/
INT64
@@ -2194,7 +3774,7 @@ DivS64x64Remainder (
If the Buffer is NULL, then ASSERT().
- @param Buffer Pointer to a 16-bit value that may be unaligned.
+ @param Buffer The pointer to a 16-bit value that may be unaligned.
@return The 16-bit value read from Buffer.
@@ -2215,7 +3795,7 @@ ReadUnaligned16 (
If the Buffer is NULL, then ASSERT().
- @param Buffer Pointer to a 16-bit value that may be unaligned.
+ @param Buffer The pointer to a 16-bit value that may be unaligned.
@param Value 16-bit value to write to Buffer.
@return The 16-bit value to write to Buffer.
@@ -2237,7 +3817,7 @@ WriteUnaligned16 (
If the Buffer is NULL, then ASSERT().
- @param Buffer Pointer to a 24-bit value that may be unaligned.
+ @param Buffer The pointer to a 24-bit value that may be unaligned.
@return The 24-bit value read from Buffer.
@@ -2258,7 +3838,7 @@ ReadUnaligned24 (
If the Buffer is NULL, then ASSERT().
- @param Buffer Pointer to a 24-bit value that may be unaligned.
+ @param Buffer The pointer to a 24-bit value that may be unaligned.
@param Value 24-bit value to write to Buffer.
@return The 24-bit value to write to Buffer.
@@ -2280,7 +3860,7 @@ WriteUnaligned24 (
If the Buffer is NULL, then ASSERT().
- @param Buffer Pointer to a 32-bit value that may be unaligned.
+ @param Buffer The pointer to a 32-bit value that may be unaligned.
@return The 32-bit value read from Buffer.
@@ -2301,7 +3881,7 @@ ReadUnaligned32 (
If the Buffer is NULL, then ASSERT().
- @param Buffer Pointer to a 32-bit value that may be unaligned.
+ @param Buffer The pointer to a 32-bit value that may be unaligned.
@param Value 32-bit value to write to Buffer.
@return The 32-bit value to write to Buffer.
@@ -2323,7 +3903,7 @@ WriteUnaligned32 (
If the Buffer is NULL, then ASSERT().
- @param Buffer Pointer to a 64-bit value that may be unaligned.
+ @param Buffer The pointer to a 64-bit value that may be unaligned.
@return The 64-bit value read from Buffer.
@@ -2344,7 +3924,7 @@ ReadUnaligned64 (
If the Buffer is NULL, then ASSERT().
- @param Buffer Pointer to a 64-bit value that may be unaligned.
+ @param Buffer The pointer to a 64-bit value that may be unaligned.
@param Value 64-bit value to write to Buffer.
@return The 64-bit value to write to Buffer.
@@ -2401,6 +3981,7 @@ BitFieldRead8 (
If StartBit is greater than 7, then ASSERT().
If EndBit is greater than 7, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
+ If Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
@param Operand Operand on which to perform the bitfield operation.
@param StartBit The ordinal of the least significant bit in the bit field.
@@ -2426,7 +4007,7 @@ BitFieldWrite8 (
Reads a bit field from an 8-bit value, performs a bitwise OR, and returns the
result.
- Performs a bitwise inclusive OR between the bit field specified by StartBit
+ Performs a bitwise OR between the bit field specified by StartBit
and EndBit in Operand and the value specified by OrData. All other bits in
Operand are preserved. The new 8-bit value is returned.
@@ -2434,6 +4015,7 @@ BitFieldWrite8 (
If StartBit is greater than 7, then ASSERT().
If EndBit is greater than 7, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
+ If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
@param Operand Operand on which to perform the bitfield operation.
@param StartBit The ordinal of the least significant bit in the bit field.
@@ -2467,6 +4049,7 @@ BitFieldOr8 (
If StartBit is greater than 7, then ASSERT().
If EndBit is greater than 7, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
+ If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
@param Operand Operand on which to perform the bitfield operation.
@param StartBit The ordinal of the least significant bit in the bit field.
@@ -2494,13 +4077,15 @@ BitFieldAnd8 (
Performs a bitwise AND between the bit field specified by StartBit and EndBit
in Operand and the value specified by AndData, followed by a bitwise
- inclusive OR with value specified by OrData. All other bits in Operand are
+ OR with value specified by OrData. All other bits in Operand are
preserved. The new 8-bit value is returned.
If 8-bit operations are not supported, then ASSERT().
If StartBit is greater than 7, then ASSERT().
If EndBit is greater than 7, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
+ If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
+ If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
@param Operand Operand on which to perform the bitfield operation.
@param StartBit The ordinal of the least significant bit in the bit field.
@@ -2563,6 +4148,7 @@ BitFieldRead16 (
If StartBit is greater than 15, then ASSERT().
If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
+ If Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
@param Operand Operand on which to perform the bitfield operation.
@param StartBit The ordinal of the least significant bit in the bit field.
@@ -2588,7 +4174,7 @@ BitFieldWrite16 (
Reads a bit field from a 16-bit value, performs a bitwise OR, and returns the
result.
- Performs a bitwise inclusive OR between the bit field specified by StartBit
+ Performs a bitwise OR between the bit field specified by StartBit
and EndBit in Operand and the value specified by OrData. All other bits in
Operand are preserved. The new 16-bit value is returned.
@@ -2596,6 +4182,7 @@ BitFieldWrite16 (
If StartBit is greater than 15, then ASSERT().
If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
+ If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
@param Operand Operand on which to perform the bitfield operation.
@param StartBit The ordinal of the least significant bit in the bit field.
@@ -2629,6 +4216,7 @@ BitFieldOr16 (
If StartBit is greater than 15, then ASSERT().
If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
+ If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
@param Operand Operand on which to perform the bitfield operation.
@param StartBit The ordinal of the least significant bit in the bit field.
@@ -2656,13 +4244,15 @@ BitFieldAnd16 (
Performs a bitwise AND between the bit field specified by StartBit and EndBit
in Operand and the value specified by AndData, followed by a bitwise
- inclusive OR with value specified by OrData. All other bits in Operand are
+ OR with value specified by OrData. All other bits in Operand are
preserved. The new 16-bit value is returned.
If 16-bit operations are not supported, then ASSERT().
If StartBit is greater than 15, then ASSERT().
If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
+ If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
+ If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
@param Operand Operand on which to perform the bitfield operation.
@param StartBit The ordinal of the least significant bit in the bit field.
@@ -2725,6 +4315,7 @@ BitFieldRead32 (
If StartBit is greater than 31, then ASSERT().
If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
+ If Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
@param Operand Operand on which to perform the bitfield operation.
@param StartBit The ordinal of the least significant bit in the bit field.
@@ -2750,7 +4341,7 @@ BitFieldWrite32 (
Reads a bit field from a 32-bit value, performs a bitwise OR, and returns the
result.
- Performs a bitwise inclusive OR between the bit field specified by StartBit
+ Performs a bitwise OR between the bit field specified by StartBit
and EndBit in Operand and the value specified by OrData. All other bits in
Operand are preserved. The new 32-bit value is returned.
@@ -2758,13 +4349,14 @@ BitFieldWrite32 (
If StartBit is greater than 31, then ASSERT().
If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
+ If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
@param Operand Operand on which to perform the bitfield operation.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..31.
@param EndBit The ordinal of the most significant bit in the bit field.
Range 0..31.
- @param OrData The value to OR with the read value from the value
+ @param OrData The value to OR with the read value from the value.
@return The new 32-bit value.
@@ -2791,6 +4383,7 @@ BitFieldOr32 (
If StartBit is greater than 31, then ASSERT().
If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
+ If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
@param Operand Operand on which to perform the bitfield operation.
@param StartBit The ordinal of the least significant bit in the bit field.
@@ -2818,13 +4411,15 @@ BitFieldAnd32 (
Performs a bitwise AND between the bit field specified by StartBit and EndBit
in Operand and the value specified by AndData, followed by a bitwise
- inclusive OR with value specified by OrData. All other bits in Operand are
+ OR with value specified by OrData. All other bits in Operand are
preserved. The new 32-bit value is returned.
If 32-bit operations are not supported, then ASSERT().
If StartBit is greater than 31, then ASSERT().
If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
+ If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
+ If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
@param Operand Operand on which to perform the bitfield operation.
@param StartBit The ordinal of the least significant bit in the bit field.
@@ -2887,6 +4482,7 @@ BitFieldRead64 (
If StartBit is greater than 63, then ASSERT().
If EndBit is greater than 63, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
+ If Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
@param Operand Operand on which to perform the bitfield operation.
@param StartBit The ordinal of the least significant bit in the bit field.
@@ -2912,7 +4508,7 @@ BitFieldWrite64 (
Reads a bit field from a 64-bit value, performs a bitwise OR, and returns the
result.
- Performs a bitwise inclusive OR between the bit field specified by StartBit
+ Performs a bitwise OR between the bit field specified by StartBit
and EndBit in Operand and the value specified by OrData. All other bits in
Operand are preserved. The new 64-bit value is returned.
@@ -2920,6 +4516,7 @@ BitFieldWrite64 (
If StartBit is greater than 63, then ASSERT().
If EndBit is greater than 63, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
+ If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
@param Operand Operand on which to perform the bitfield operation.
@param StartBit The ordinal of the least significant bit in the bit field.
@@ -2953,6 +4550,7 @@ BitFieldOr64 (
If StartBit is greater than 63, then ASSERT().
If EndBit is greater than 63, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
+ If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
@param Operand Operand on which to perform the bitfield operation.
@param StartBit The ordinal of the least significant bit in the bit field.
@@ -2980,13 +4578,15 @@ BitFieldAnd64 (
Performs a bitwise AND between the bit field specified by StartBit and EndBit
in Operand and the value specified by AndData, followed by a bitwise
- inclusive OR with value specified by OrData. All other bits in Operand are
+ OR with value specified by OrData. All other bits in Operand are
preserved. The new 64-bit value is returned.
If 64-bit operations are not supported, then ASSERT().
If StartBit is greater than 63, then ASSERT().
If EndBit is greater than 63, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
+ If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
+ If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
@param Operand Operand on which to perform the bitfield operation.
@param StartBit The ordinal of the least significant bit in the bit field.
@@ -3009,261 +4609,68 @@ BitFieldAndThenOr64 (
IN UINT64 OrData
);
-
-//
-// Base Library Synchronization Functions
-//
-
-/**
- Retrieves the architecture specific spin lock alignment requirements for
- optimal spin lock performance.
-
- This function retrieves the spin lock alignment requirements for optimal
- performance on a given CPU architecture. The spin lock alignment must be a
- power of two and is returned by this function. If there are no alignment
- requirements, then 1 must be returned. The spin lock synchronization
- functions must function correctly if the spin lock size and alignment values
- returned by this function are not used at all. These values are hints to the
- consumers of the spin lock synchronization functions to obtain optimal spin
- lock performance.
-
- @return The architecture specific spin lock alignment.
-
-**/
-UINTN
-EFIAPI
-GetSpinLockProperties (
- VOID
- );
-
-
-/**
- Initializes a spin lock to the released state and returns the spin lock.
-
- This function initializes the spin lock specified by SpinLock to the released
- state, and returns SpinLock. Optimal performance can be achieved by calling
- GetSpinLockProperties() to determine the size and alignment requirements for
- SpinLock.
-
- If SpinLock is NULL, then ASSERT().
-
- @param SpinLock A pointer to the spin lock to initialize to the released
- state.
-
- @return SpinLock in release state.
-
-**/
-SPIN_LOCK *
-EFIAPI
-InitializeSpinLock (
- IN SPIN_LOCK *SpinLock
- );
-
-
-/**
- Waits until a spin lock can be placed in the acquired state.
-
- This function checks the state of the spin lock specified by SpinLock. If
- SpinLock is in the released state, then this function places SpinLock in the
- acquired state and returns SpinLock. Otherwise, this function waits
- indefinitely for the spin lock to be released, and then places it in the
- acquired state and returns SpinLock. All state transitions of SpinLock must
- be performed using MP safe mechanisms.
-
- If SpinLock is NULL, then ASSERT().
- If SpinLock was not initialized with InitializeSpinLock(), then ASSERT().
- If PcdSpinLockTimeout is not zero, and SpinLock is can not be acquired in
- PcdSpinLockTimeout microseconds, then ASSERT().
-
- @param SpinLock A pointer to the spin lock to place in the acquired state.
-
- @return SpinLock accquired lock.
-
-**/
-SPIN_LOCK *
-EFIAPI
-AcquireSpinLock (
- IN OUT SPIN_LOCK *SpinLock
- );
-
-
-/**
- Attempts to place a spin lock in the acquired state.
-
- This function checks the state of the spin lock specified by SpinLock. If
- SpinLock is in the released state, then this function places SpinLock in the
- acquired state and returns TRUE. Otherwise, FALSE is returned. All state
- transitions of SpinLock must be performed using MP safe mechanisms.
-
- If SpinLock is NULL, then ASSERT().
- If SpinLock was not initialized with InitializeSpinLock(), then ASSERT().
-
- @param SpinLock A pointer to the spin lock to place in the acquired state.
-
- @retval TRUE SpinLock was placed in the acquired state.
- @retval FALSE SpinLock could not be acquired.
-
-**/
-BOOLEAN
-EFIAPI
-AcquireSpinLockOrFail (
- IN OUT SPIN_LOCK *SpinLock
- );
-
-
-/**
- Releases a spin lock.
-
- This function places the spin lock specified by SpinLock in the release state
- and returns SpinLock.
-
- If SpinLock is NULL, then ASSERT().
- If SpinLock was not initialized with InitializeSpinLock(), then ASSERT().
-
- @param SpinLock A pointer to the spin lock to release.
-
- @return SpinLock released lock.
-
-**/
-SPIN_LOCK *
-EFIAPI
-ReleaseSpinLock (
- IN OUT SPIN_LOCK *SpinLock
- );
-
-
-/**
- Performs an atomic increment of an 32-bit unsigned integer.
-
- Performs an atomic increment of the 32-bit unsigned integer specified by
- Value and returns the incremented value. The increment operation must be
- performed using MP safe mechanisms. The state of the return value is not
- guaranteed to be MP safe.
-
- If Value is NULL, then ASSERT().
-
- @param Value A pointer to the 32-bit value to increment.
-
- @return The incremented value.
-
-**/
-UINT32
-EFIAPI
-InterlockedIncrement (
- IN UINT32 *Value
- );
-
-
-/**
- Performs an atomic decrement of an 32-bit unsigned integer.
-
- Performs an atomic decrement of the 32-bit unsigned integer specified by
- Value and returns the decremented value. The decrement operation must be
- performed using MP safe mechanisms. The state of the return value is not
- guaranteed to be MP safe.
-
- If Value is NULL, then ASSERT().
-
- @param Value A pointer to the 32-bit value to decrement.
-
- @return The decremented value.
-
-**/
-UINT32
-EFIAPI
-InterlockedDecrement (
- IN UINT32 *Value
- );
-
-
/**
- Performs an atomic compare exchange operation on a 32-bit unsigned integer.
+ Reads a bit field from a 32-bit value, counts and returns
+ the number of set bits.
- Performs an atomic compare exchange operation on the 32-bit unsigned integer
- specified by Value. If Value is equal to CompareValue, then Value is set to
- ExchangeValue and CompareValue is returned. If Value is not equal to CompareValue,
- then Value is returned. The compare exchange operation must be performed using
- MP safe mechanisms.
+ Counts the number of set bits in the bit field specified by
+ StartBit and EndBit in Operand. The count is returned.
- If Value is NULL, then ASSERT().
+ If StartBit is greater than 31, then ASSERT().
+ If EndBit is greater than 31, then ASSERT().
+ If EndBit is less than StartBit, then ASSERT().
- @param Value A pointer to the 32-bit value for the compare exchange
- operation.
- @param CompareValue 32-bit value used in compare operation.
- @param ExchangeValue 32-bit value used in exchange operation.
+ @param Operand Operand on which to perform the bitfield operation.
+ @param StartBit The ordinal of the least significant bit in the bit field.
+ Range 0..31.
+ @param EndBit The ordinal of the most significant bit in the bit field.
+ Range 0..31.
- @return The original *Value before exchange.
+ @return The number of bits set between StartBit and EndBit.
**/
-UINT32
+UINT8
EFIAPI
-InterlockedCompareExchange32 (
- IN OUT UINT32 *Value,
- IN UINT32 CompareValue,
- IN UINT32 ExchangeValue
+BitFieldCountOnes32 (
+ IN UINT32 Operand,
+ IN UINTN StartBit,
+ IN UINTN EndBit
);
-
/**
- Performs an atomic compare exchange operation on a 64-bit unsigned integer.
-
- Performs an atomic compare exchange operation on the 64-bit unsigned integer specified
- by Value. If Value is equal to CompareValue, then Value is set to ExchangeValue and
- CompareValue is returned. If Value is not equal to CompareValue, then Value is returned.
- The compare exchange operation must be performed using MP safe mechanisms.
-
- If Value is NULL, then ASSERT().
-
- @param Value A pointer to the 64-bit value for the compare exchange
- operation.
- @param CompareValue 64-bit value used in compare operation.
- @param ExchangeValue 64-bit value used in exchange operation.
-
- @return The original *Value before exchange.
+ Reads a bit field from a 64-bit value, counts and returns
+ the number of set bits.
-**/
-UINT64
-EFIAPI
-InterlockedCompareExchange64 (
- IN OUT UINT64 *Value,
- IN UINT64 CompareValue,
- IN UINT64 ExchangeValue
- );
+ Counts the number of set bits in the bit field specified by
+ StartBit and EndBit in Operand. The count is returned.
+ If StartBit is greater than 63, then ASSERT().
+ If EndBit is greater than 63, then ASSERT().
+ If EndBit is less than StartBit, then ASSERT().
-/**
- Performs an atomic compare exchange operation on a pointer value.
-
- Performs an atomic compare exchange operation on the pointer value specified
- by Value. If Value is equal to CompareValue, then Value is set to
- ExchangeValue and CompareValue is returned. If Value is not equal to
- CompareValue, then Value is returned. The compare exchange operation must be
- performed using MP safe mechanisms.
+ @param Operand Operand on which to perform the bitfield operation.
+ @param StartBit The ordinal of the least significant bit in the bit field.
+ Range 0..63.
+ @param EndBit The ordinal of the most significant bit in the bit field.
+ Range 0..63.
- If Value is NULL, then ASSERT().
+ @return The number of bits set between StartBit and EndBit.
- @param Value A pointer to the pointer value for the compare exchange
- operation.
- @param CompareValue Pointer value used in compare operation.
- @param ExchangeValue Pointer value used in exchange operation.
-
- @return The original *Value before exchange.
**/
-VOID *
+UINT8
EFIAPI
-InterlockedCompareExchangePointer (
- IN OUT VOID **Value,
- IN VOID *CompareValue,
- IN VOID *ExchangeValue
+BitFieldCountOnes64 (
+ IN UINT64 Operand,
+ IN UINTN StartBit,
+ IN UINTN EndBit
);
-
//
// Base Library Checksum Functions
//
/**
- Calculate the sum of all elements in a buffer in unit of UINT8.
+ Returns the sum of all elements in a buffer in unit of UINT8.
During calculation, the carry bits are dropped.
This function calculates the sum of all elements in a buffer
@@ -3274,8 +4681,8 @@ InterlockedCompareExchangePointer (
If Buffer is NULL, then ASSERT().
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
- @param Buffer Pointer to the buffer to carry out the sum operation.
- @param Length The size, in bytes, of Buffer .
+ @param Buffer The pointer to the buffer to carry out the sum operation.
+ @param Length The size, in bytes, of Buffer.
@return Sum The sum of Buffer with carry bits dropped during additions.
@@ -3283,8 +4690,8 @@ InterlockedCompareExchangePointer (
UINT8
EFIAPI
CalculateSum8 (
- IN CONST UINT8 *Buffer,
- IN UINTN Length
+ IN CONST UINT8 *Buffer,
+ IN UINTN Length
);
@@ -3300,17 +4707,17 @@ CalculateSum8 (
If Buffer is NULL, then ASSERT().
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
- @param Buffer Pointer to the buffer to carry out the checksum operation.
+ @param Buffer The pointer to the buffer to carry out the checksum operation.
@param Length The size, in bytes, of Buffer.
- @return Checksum The 2's complement checksum of Buffer.
+ @return Checksum The two's complement checksum of Buffer.
**/
UINT8
EFIAPI
CalculateCheckSum8 (
- IN CONST UINT8 *Buffer,
- IN UINTN Length
+ IN CONST UINT8 *Buffer,
+ IN UINTN Length
);
@@ -3327,7 +4734,7 @@ CalculateCheckSum8 (
If Length is not aligned on a 16-bit boundary, then ASSERT().
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
- @param Buffer Pointer to the buffer to carry out the sum operation.
+ @param Buffer The pointer to the buffer to carry out the sum operation.
@param Length The size, in bytes, of Buffer.
@return Sum The sum of Buffer with carry bits dropped during additions.
@@ -3336,8 +4743,8 @@ CalculateCheckSum8 (
UINT16
EFIAPI
CalculateSum16 (
- IN CONST UINT16 *Buffer,
- IN UINTN Length
+ IN CONST UINT16 *Buffer,
+ IN UINTN Length
);
@@ -3355,34 +4762,34 @@ CalculateSum16 (
If Length is not aligned on a 16-bit boundary, then ASSERT().
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
- @param Buffer Pointer to the buffer to carry out the checksum operation.
+ @param Buffer The pointer to the buffer to carry out the checksum operation.
@param Length The size, in bytes, of Buffer.
- @return Checksum The 2's complement checksum of Buffer.
+ @return Checksum The two's complement checksum of Buffer.
**/
UINT16
EFIAPI
CalculateCheckSum16 (
- IN CONST UINT16 *Buffer,
- IN UINTN Length
+ IN CONST UINT16 *Buffer,
+ IN UINTN Length
);
/**
- Returns the sum of all elements in a buffer of 32-bit values. During
+ Returns the sum of all elements in a buffer of 32-bit values. During
calculation, the carry bits are dropped.
This function calculates the sum of the 32-bit values in the buffer
specified by Buffer and Length. The carry bits in result of addition are dropped.
- The 32-bit result is returned. If Length is 0, then 0 is returned.
+ The 32-bit result is returned. If Length is 0, then 0 is returned.
If Buffer is NULL, then ASSERT().
If Buffer is not aligned on a 32-bit boundary, then ASSERT().
If Length is not aligned on a 32-bit boundary, then ASSERT().
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
- @param Buffer Pointer to the buffer to carry out the sum operation.
+ @param Buffer The pointer to the buffer to carry out the sum operation.
@param Length The size, in bytes, of Buffer.
@return Sum The sum of Buffer with carry bits dropped during additions.
@@ -3391,8 +4798,8 @@ CalculateCheckSum16 (
UINT32
EFIAPI
CalculateSum32 (
- IN CONST UINT32 *Buffer,
- IN UINTN Length
+ IN CONST UINT32 *Buffer,
+ IN UINTN Length
);
@@ -3410,17 +4817,17 @@ CalculateSum32 (
If Length is not aligned on a 32-bit boundary, then ASSERT().
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
- @param Buffer Pointer to the buffer to carry out the checksum operation.
+ @param Buffer The pointer to the buffer to carry out the checksum operation.
@param Length The size, in bytes, of Buffer.
- @return Checksum The 2's complement checksum of Buffer.
+ @return Checksum The two's complement checksum of Buffer.
**/
UINT32
EFIAPI
CalculateCheckSum32 (
- IN CONST UINT32 *Buffer,
- IN UINTN Length
+ IN CONST UINT32 *Buffer,
+ IN UINTN Length
);
@@ -3437,7 +4844,7 @@ CalculateCheckSum32 (
If Length is not aligned on a 64-bit boundary, then ASSERT().
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
- @param Buffer Pointer to the buffer to carry out the sum operation.
+ @param Buffer The pointer to the buffer to carry out the sum operation.
@param Length The size, in bytes, of Buffer.
@return Sum The sum of Buffer with carry bits dropped during additions.
@@ -3446,8 +4853,8 @@ CalculateCheckSum32 (
UINT64
EFIAPI
CalculateSum64 (
- IN CONST UINT64 *Buffer,
- IN UINTN Length
+ IN CONST UINT64 *Buffer,
+ IN UINTN Length
);
@@ -3465,23 +4872,50 @@ CalculateSum64 (
If Length is not aligned on a 64-bit boundary, then ASSERT().
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
- @param Buffer Pointer to the buffer to carry out the checksum operation.
+ @param Buffer The pointer to the buffer to carry out the checksum operation.
@param Length The size, in bytes, of Buffer.
- @return Checksum The 2's complement checksum of Buffer.
+ @return Checksum The two's complement checksum of Buffer.
**/
UINT64
EFIAPI
CalculateCheckSum64 (
- IN CONST UINT64 *Buffer,
- IN UINTN Length
+ IN CONST UINT64 *Buffer,
+ IN UINTN Length
);
+/**
+ Computes and returns a 32-bit CRC for a data buffer.
+ CRC32 value bases on ITU-T V.42.
-///
-/// Base Library CPU Functions
-///
+ If Buffer is NULL, then ASSERT().
+ If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
+
+ @param[in] Buffer A pointer to the buffer on which the 32-bit CRC is to be computed.
+ @param[in] Length The number of bytes in the buffer Data.
+
+ @retval Crc32 The 32-bit CRC was computed for the data buffer.
+
+**/
+UINT32
+EFIAPI
+CalculateCrc32(
+ IN VOID *Buffer,
+ IN UINTN Length
+ );
+
+//
+// Base Library CPU Functions
+//
+
+/**
+ Function entry point used when a stack switch is requested with SwitchStack()
+
+ @param Context1 Context1 parameter passed into SwitchStack().
+ @param Context2 Context2 parameter passed into SwitchStack().
+
+**/
typedef
VOID
(EFIAPI *SWITCH_STACK_ENTRY_POINT)(
@@ -3513,13 +4947,19 @@ MemoryFence (
calls to LongJump() cause a non-zero value to be returned by SetJump().
If JumpBuffer is NULL, then ASSERT().
- For IPF CPUs, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().
+ For Itanium processors, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().
+
+ NOTE: The structure BASE_LIBRARY_JUMP_BUFFER is CPU architecture specific.
+ The same structure must never be used for more than one CPU architecture context.
+ For example, a BASE_LIBRARY_JUMP_BUFFER allocated by an IA-32 module must never be used from an x64 module.
+ SetJump()/LongJump() is not currently supported for the EBC processor type.
@param JumpBuffer A pointer to CPU context buffer.
@retval 0 Indicates a return from SetJump().
**/
+RETURNS_TWICE
UINTN
EFIAPI
SetJump (
@@ -3535,7 +4975,7 @@ SetJump (
the state of JumpBuffer.
If JumpBuffer is NULL, then ASSERT().
- For IPF CPUs, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().
+ For Itanium processors, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().
If Value is 0, then ASSERT().
@param JumpBuffer A pointer to CPU context buffer.
@@ -3603,7 +5043,7 @@ EnableDisableInterrupts (
/**
Retrieves the current CPU interrupt state.
- Returns TRUE is interrupts are currently enabled. Otherwise
+ Returns TRUE if interrupts are currently enabled. Otherwise
returns FALSE.
@retval TRUE CPU interrupts are enabled.
@@ -3660,8 +5100,8 @@ CpuPause (
by Context1 and Context2. Context1 and Context2 are optional and may
be NULL. The function EntryPoint must never return. This function
supports a variable number of arguments following the NewStack parameter.
- These additional arguments are ignored on IA-32, x64, and EBC.
- IPF CPUs expect one additional parameter of type VOID * that specifies
+ These additional arguments are ignored on IA-32, x64, and EBC architectures.
+ Itanium processors expect one additional parameter of type VOID * that specifies
the new backing store pointer.
If EntryPoint is NULL, then ASSERT().
@@ -3674,7 +5114,10 @@ CpuPause (
function.
@param NewStack A pointer to the new stack to use for the EntryPoint
function.
- @param ... Extended parameters.
+ @param ... This variable argument list is ignored for IA-32, x64, and
+ EBC architectures. For Itanium processors, this variable
+ argument list is expected to contain a single parameter of
+ type VOID * that specifies the new backing store pointer.
**/
@@ -3718,21 +5161,19 @@ CpuDeadLoop (
VOID
);
-
#if defined (MDE_CPU_IPF)
/**
Flush a range of cache lines in the cache coherency domain of the calling
CPU.
- Invalidates the cache lines specified by Address and Length. If Address is
- not aligned on a cache line boundary, then entire cache line containing
- Address is invalidated. If Address + Length is not aligned on a cache line
- boundary, then the entire instruction cache line containing Address + Length
- -1 is invalidated. This function may choose to invalidate the entire
- instruction cache if that is more efficient than invalidating the specified
- range. If Length is 0, the no instruction cache lines are invalidated.
- Address is returned.
+ Flushes the cache lines specified by Address and Length. If Address is not aligned
+ on a cache line boundary, then entire cache line containing Address is flushed.
+ If Address + Length is not aligned on a cache line boundary, then the entire cache
+ line containing Address + Length - 1 is flushed. This function may choose to flush
+ the entire cache if that is more efficient than flushing the specified range. If
+ Length is 0, the no cache lines are flushed. Address is returned.
+ This function is only available on Itanium processors.
If Length is greater than (MAX_ADDRESS - Address + 1), then ASSERT().
@@ -3743,24 +5184,24 @@ CpuDeadLoop (
@param Length The number of bytes to invalidate from the instruction cache.
- @return Address
+ @return Address.
**/
VOID *
EFIAPI
-IpfFlushCacheRange (
+AsmFlushCacheRange (
IN VOID *Address,
IN UINTN Length
);
/**
- Executes a FC instruction
- Executes a FC instruction on the cache line specified by Address.
+ Executes an FC instruction.
+ Executes an FC instruction on the cache line specified by Address.
The cache line size affected is at least 32-bytes (aligned on a 32-byte boundary).
- An implementation may flush a larger region. This function is only available on IPF.
+ An implementation may flush a larger region. This function is only available on Itanium processors.
- @param Address The Address of cache line to be flushed.
+ @param Address The Address of cache line to be flushed.
@return The address of FC instruction executed.
@@ -3773,14 +5214,14 @@ AsmFc (
/**
- Executes a FC.I instruction.
- Executes a FC.I instruction on the cache line specified by Address.
+ Executes an FC.I instruction.
+ Executes an FC.I instruction on the cache line specified by Address.
The cache line size affected is at least 32-bytes (aligned on a 32-byte boundary).
- An implementation may flush a larger region. This function is only available on IPF.
+ An implementation may flush a larger region. This function is only available on Itanium processors.
- @param Address The Address of cache line to be flushed.
+ @param Address The Address of cache line to be flushed.
- @return The address of FC.I instruction executed.
+ @return The address of the FC.I instruction executed.
**/
UINT64
@@ -3792,14 +5233,16 @@ AsmFci (
/**
Reads the current value of a Processor Identifier Register (CPUID).
+
+ Reads and returns the current value of Processor Identifier Register specified by Index.
The Index of largest implemented CPUID (One less than the number of implemented CPUID
registers) is determined by CPUID [3] bits {7:0}.
No parameter checking is performed on Index. If the Index value is beyond the
implemented CPUID register range, a Reserved Register/Field fault may occur. The caller
must either guarantee that Index is valid, or the caller must set up fault handlers to
- catch the faults. This function is only available on IPF.
+ catch the faults. This function is only available on Itanium processors.
- @param Index The 8-bit Processor Identifier Register index to read.
+ @param Index The 8-bit Processor Identifier Register index to read.
@return The current value of Processor Identifier Register specified by Index.
@@ -3813,7 +5256,7 @@ AsmReadCpuid (
/**
Reads the current value of 64-bit Processor Status Register (PSR).
- This function is only available on IPF.
+ This function is only available on Itanium processors.
@return The current value of PSR.
@@ -3827,11 +5270,13 @@ AsmReadPsr (
/**
Writes the current value of 64-bit Processor Status Register (PSR).
+
No parameter checking is performed on Value. All bits of Value corresponding to
- reserved fields of PSR must be 0 or a Reserved Register/Field fault may occur. The caller must either guarantee that Value is valid, or the caller must set up fault handlers to catch the faults.
- This function is only available on IPF.
+ reserved fields of PSR must be 0 or a Reserved Register/Field fault may occur.
+ The caller must either guarantee that Value is valid, or the caller must set up
+ fault handlers to catch the faults. This function is only available on Itanium processors.
- @param Value The 64-bit value to write to PSR.
+ @param Value The 64-bit value to write to PSR.
@return The 64-bit value written to the PSR.
@@ -3845,7 +5290,9 @@ AsmWritePsr (
/**
Reads the current value of 64-bit Kernel Register #0 (KR0).
- This function is only available on IPF.
+
+ Reads and returns the current value of KR0.
+ This function is only available on Itanium processors.
@return The current value of KR0.
@@ -3859,7 +5306,9 @@ AsmReadKr0 (
/**
Reads the current value of 64-bit Kernel Register #1 (KR1).
- This function is only available on IPF.
+
+ Reads and returns the current value of KR1.
+ This function is only available on Itanium processors.
@return The current value of KR1.
@@ -3873,7 +5322,9 @@ AsmReadKr1 (
/**
Reads the current value of 64-bit Kernel Register #2 (KR2).
- This function is only available on IPF.
+
+ Reads and returns the current value of KR2.
+ This function is only available on Itanium processors.
@return The current value of KR2.
@@ -3887,7 +5338,9 @@ AsmReadKr2 (
/**
Reads the current value of 64-bit Kernel Register #3 (KR3).
- This function is only available on IPF.
+
+ Reads and returns the current value of KR3.
+ This function is only available on Itanium processors.
@return The current value of KR3.
@@ -3901,7 +5354,9 @@ AsmReadKr3 (
/**
Reads the current value of 64-bit Kernel Register #4 (KR4).
- This function is only available on IPF.
+
+ Reads and returns the current value of KR4.
+ This function is only available on Itanium processors.
@return The current value of KR4.
@@ -3915,7 +5370,9 @@ AsmReadKr4 (
/**
Reads the current value of 64-bit Kernel Register #5 (KR5).
- This function is only available on IPF.
+
+ Reads and returns the current value of KR5.
+ This function is only available on Itanium processors.
@return The current value of KR5.
@@ -3929,7 +5386,9 @@ AsmReadKr5 (
/**
Reads the current value of 64-bit Kernel Register #6 (KR6).
- This function is only available on IPF.
+
+ Reads and returns the current value of KR6.
+ This function is only available on Itanium processors.
@return The current value of KR6.
@@ -3943,7 +5402,9 @@ AsmReadKr6 (
/**
Reads the current value of 64-bit Kernel Register #7 (KR7).
- This function is only available on IPF.
+
+ Reads and returns the current value of KR7.
+ This function is only available on Itanium processors.
@return The current value of KR7.
@@ -3957,9 +5418,11 @@ AsmReadKr7 (
/**
Write the current value of 64-bit Kernel Register #0 (KR0).
- This function is only available on IPF.
- @param Value The 64-bit value to write to KR0.
+ Writes the current value of KR0. The 64-bit value written to
+ the KR0 is returned. This function is only available on Itanium processors.
+
+ @param Value The 64-bit value to write to KR0.
@return The 64-bit value written to the KR0.
@@ -3973,9 +5436,11 @@ AsmWriteKr0 (
/**
Write the current value of 64-bit Kernel Register #1 (KR1).
- This function is only available on IPF.
- @param Value The 64-bit value to write to KR1.
+ Writes the current value of KR1. The 64-bit value written to
+ the KR1 is returned. This function is only available on Itanium processors.
+
+ @param Value The 64-bit value to write to KR1.
@return The 64-bit value written to the KR1.
@@ -3989,9 +5454,11 @@ AsmWriteKr1 (
/**
Write the current value of 64-bit Kernel Register #2 (KR2).
- This function is only available on IPF.
- @param Value The 64-bit value to write to KR2.
+ Writes the current value of KR2. The 64-bit value written to
+ the KR2 is returned. This function is only available on Itanium processors.
+
+ @param Value The 64-bit value to write to KR2.
@return The 64-bit value written to the KR2.
@@ -4005,9 +5472,11 @@ AsmWriteKr2 (
/**
Write the current value of 64-bit Kernel Register #3 (KR3).
- This function is only available on IPF.
- @param Value The 64-bit value to write to KR3.
+ Writes the current value of KR3. The 64-bit value written to
+ the KR3 is returned. This function is only available on Itanium processors.
+
+ @param Value The 64-bit value to write to KR3.
@return The 64-bit value written to the KR3.
@@ -4021,9 +5490,11 @@ AsmWriteKr3 (
/**
Write the current value of 64-bit Kernel Register #4 (KR4).
- This function is only available on IPF.
- @param Value The 64-bit value to write to KR4.
+ Writes the current value of KR4. The 64-bit value written to
+ the KR4 is returned. This function is only available on Itanium processors.
+
+ @param Value The 64-bit value to write to KR4.
@return The 64-bit value written to the KR4.
@@ -4037,9 +5508,11 @@ AsmWriteKr4 (
/**
Write the current value of 64-bit Kernel Register #5 (KR5).
- This function is only available on IPF.
- @param Value The 64-bit value to write to KR5.
+ Writes the current value of KR5. The 64-bit value written to
+ the KR5 is returned. This function is only available on Itanium processors.
+
+ @param Value The 64-bit value to write to KR5.
@return The 64-bit value written to the KR5.
@@ -4053,9 +5526,11 @@ AsmWriteKr5 (
/**
Write the current value of 64-bit Kernel Register #6 (KR6).
- This function is only available on IPF.
- @param Value The 64-bit value to write to KR6.
+ Writes the current value of KR6. The 64-bit value written to
+ the KR6 is returned. This function is only available on Itanium processors.
+
+ @param Value The 64-bit value to write to KR6.
@return The 64-bit value written to the KR6.
@@ -4069,9 +5544,11 @@ AsmWriteKr6 (
/**
Write the current value of 64-bit Kernel Register #7 (KR7).
- This function is only available on IPF.
- @param Value The 64-bit value to write to KR7.
+ Writes the current value of KR7. The 64-bit value written to
+ the KR7 is returned. This function is only available on Itanium processors.
+
+ @param Value The 64-bit value to write to KR7.
@return The 64-bit value written to the KR7.
@@ -4085,7 +5562,9 @@ AsmWriteKr7 (
/**
Reads the current value of Interval Timer Counter Register (ITC).
- This function is only available on IPF.
+
+ Reads and returns the current value of ITC.
+ This function is only available on Itanium processors.
@return The current value of ITC.
@@ -4099,7 +5578,9 @@ AsmReadItc (
/**
Reads the current value of Interval Timer Vector Register (ITV).
- This function is only available on IPF.
+
+ Reads and returns the current value of ITV.
+ This function is only available on Itanium processors.
@return The current value of ITV.
@@ -4113,7 +5594,9 @@ AsmReadItv (
/**
Reads the current value of Interval Timer Match Register (ITM).
- This function is only available on IPF.
+
+ Reads and returns the current value of ITM.
+ This function is only available on Itanium processors.
@return The current value of ITM.
**/
@@ -4126,9 +5609,11 @@ AsmReadItm (
/**
Writes the current value of 64-bit Interval Timer Counter Register (ITC).
- This function is only available on IPF.
- @param Value The 64-bit value to write to ITC.
+ Writes the current value of ITC. The 64-bit value written to the ITC is returned.
+ This function is only available on Itanium processors.
+
+ @param Value The 64-bit value to write to ITC.
@return The 64-bit value written to the ITC.
@@ -4142,9 +5627,11 @@ AsmWriteItc (
/**
Writes the current value of 64-bit Interval Timer Match Register (ITM).
- This function is only available on IPF.
- @param Value The 64-bit value to write to ITM.
+ Writes the current value of ITM. The 64-bit value written to the ITM is returned.
+ This function is only available on Itanium processors.
+
+ @param Value The 64-bit value to write to ITM.
@return The 64-bit value written to the ITM.
@@ -4158,13 +5645,15 @@ AsmWriteItm (
/**
Writes the current value of 64-bit Interval Timer Vector Register (ITV).
+
+ Writes the current value of ITV. The 64-bit value written to the ITV is returned.
No parameter checking is performed on Value. All bits of Value corresponding to
reserved fields of ITV must be 0 or a Reserved Register/Field fault may occur.
The caller must either guarantee that Value is valid, or the caller must set up
fault handlers to catch the faults.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
- @param Value The 64-bit value to write to ITV.
+ @param Value The 64-bit value to write to ITV.
@return The 64-bit value written to the ITV.
@@ -4178,7 +5667,8 @@ AsmWriteItv (
/**
Reads the current value of Default Control Register (DCR).
- This function is only available on IPF.
+
+ Reads and returns the current value of DCR. This function is only available on Itanium processors.
@return The current value of DCR.
@@ -4192,7 +5682,8 @@ AsmReadDcr (
/**
Reads the current value of Interruption Vector Address Register (IVA).
- This function is only available on IPF.
+
+ Reads and returns the current value of IVA. This function is only available on Itanium processors.
@return The current value of IVA.
**/
@@ -4205,7 +5696,8 @@ AsmReadIva (
/**
Reads the current value of Page Table Address Register (PTA).
- This function is only available on IPF.
+
+ Reads and returns the current value of PTA. This function is only available on Itanium processors.
@return The current value of PTA.
@@ -4219,13 +5711,15 @@ AsmReadPta (
/**
Writes the current value of 64-bit Default Control Register (DCR).
+
+ Writes the current value of DCR. The 64-bit value written to the DCR is returned.
No parameter checking is performed on Value. All bits of Value corresponding to
reserved fields of DCR must be 0 or a Reserved Register/Field fault may occur.
The caller must either guarantee that Value is valid, or the caller must set up
fault handlers to catch the faults.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
- @param Value The 64-bit value to write to DCR.
+ @param Value The 64-bit value to write to DCR.
@return The 64-bit value written to the DCR.
@@ -4239,11 +5733,13 @@ AsmWriteDcr (
/**
Writes the current value of 64-bit Interruption Vector Address Register (IVA).
+
+ Writes the current value of IVA. The 64-bit value written to the IVA is returned.
The size of vector table is 32 K bytes and is 32 K bytes aligned
the low 15 bits of Value is ignored when written.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
- @param Value The 64-bit value to write to IVA.
+ @param Value The 64-bit value to write to IVA.
@return The 64-bit value written to the IVA.
@@ -4257,13 +5753,15 @@ AsmWriteIva (
/**
Writes the current value of 64-bit Page Table Address Register (PTA).
+
+ Writes the current value of PTA. The 64-bit value written to the PTA is returned.
No parameter checking is performed on Value. All bits of Value corresponding to
reserved fields of DCR must be 0 or a Reserved Register/Field fault may occur.
The caller must either guarantee that Value is valid, or the caller must set up
fault handlers to catch the faults.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
- @param Value The 64-bit value to write to PTA.
+ @param Value The 64-bit value to write to PTA.
@return The 64-bit value written to the PTA.
**/
@@ -4276,7 +5774,8 @@ AsmWritePta (
/**
Reads the current value of Local Interrupt ID Register (LID).
- This function is only available on IPF.
+
+ Reads and returns the current value of LID. This function is only available on Itanium processors.
@return The current value of LID.
@@ -4290,7 +5789,8 @@ AsmReadLid (
/**
Reads the current value of External Interrupt Vector Register (IVR).
- This function is only available on IPF.
+
+ Reads and returns the current value of IVR. This function is only available on Itanium processors.
@return The current value of IVR.
@@ -4304,7 +5804,8 @@ AsmReadIvr (
/**
Reads the current value of Task Priority Register (TPR).
- This function is only available on IPF.
+
+ Reads and returns the current value of TPR. This function is only available on Itanium processors.
@return The current value of TPR.
@@ -4318,7 +5819,8 @@ AsmReadTpr (
/**
Reads the current value of External Interrupt Request Register #0 (IRR0).
- This function is only available on IPF.
+
+ Reads and returns the current value of IRR0. This function is only available on Itanium processors.
@return The current value of IRR0.
@@ -4332,7 +5834,8 @@ AsmReadIrr0 (
/**
Reads the current value of External Interrupt Request Register #1 (IRR1).
- This function is only available on IPF.
+
+ Reads and returns the current value of IRR1. This function is only available on Itanium processors.
@return The current value of IRR1.
@@ -4346,7 +5849,8 @@ AsmReadIrr1 (
/**
Reads the current value of External Interrupt Request Register #2 (IRR2).
- This function is only available on IPF.
+
+ Reads and returns the current value of IRR2. This function is only available on Itanium processors.
@return The current value of IRR2.
@@ -4360,7 +5864,8 @@ AsmReadIrr2 (
/**
Reads the current value of External Interrupt Request Register #3 (IRR3).
- This function is only available on IPF.
+
+ Reads and returns the current value of IRR3. This function is only available on Itanium processors.
@return The current value of IRR3.
@@ -4374,7 +5879,8 @@ AsmReadIrr3 (
/**
Reads the current value of Performance Monitor Vector Register (PMV).
- This function is only available on IPF.
+
+ Reads and returns the current value of PMV. This function is only available on Itanium processors.
@return The current value of PMV.
@@ -4388,7 +5894,8 @@ AsmReadPmv (
/**
Reads the current value of Corrected Machine Check Vector Register (CMCV).
- This function is only available on IPF.
+
+ Reads and returns the current value of CMCV. This function is only available on Itanium processors.
@return The current value of CMCV.
@@ -4402,7 +5909,8 @@ AsmReadCmcv (
/**
Reads the current value of Local Redirection Register #0 (LRR0).
- This function is only available on IPF.
+
+ Reads and returns the current value of LRR0. This function is only available on Itanium processors.
@return The current value of LRR0.
@@ -4416,7 +5924,8 @@ AsmReadLrr0 (
/**
Reads the current value of Local Redirection Register #1 (LRR1).
- This function is only available on IPF.
+
+ Reads and returns the current value of LRR1. This function is only available on Itanium processors.
@return The current value of LRR1.
@@ -4430,13 +5939,15 @@ AsmReadLrr1 (
/**
Writes the current value of 64-bit Page Local Interrupt ID Register (LID).
+
+ Writes the current value of LID. The 64-bit value written to the LID is returned.
No parameter checking is performed on Value. All bits of Value corresponding to
reserved fields of LID must be 0 or a Reserved Register/Field fault may occur.
The caller must either guarantee that Value is valid, or the caller must set up
fault handlers to catch the faults.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
- @param Value The 64-bit value to write to LID.
+ @param Value The 64-bit value to write to LID.
@return The 64-bit value written to the LID.
@@ -4450,13 +5961,15 @@ AsmWriteLid (
/**
Writes the current value of 64-bit Task Priority Register (TPR).
+
+ Writes the current value of TPR. The 64-bit value written to the TPR is returned.
No parameter checking is performed on Value. All bits of Value corresponding to
reserved fields of TPR must be 0 or a Reserved Register/Field fault may occur.
The caller must either guarantee that Value is valid, or the caller must set up
fault handlers to catch the faults.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
- @param Value The 64-bit value to write to TPR.
+ @param Value The 64-bit value to write to TPR.
@return The 64-bit value written to the TPR.
@@ -4470,7 +5983,8 @@ AsmWriteTpr (
/**
Performs a write operation on End OF External Interrupt Register (EOI).
- Writes a value of 0 to the EOI Register. This function is only available on IPF.
+
+ Writes a value of 0 to the EOI Register. This function is only available on Itanium processors.
**/
VOID
@@ -4482,13 +5996,15 @@ AsmWriteEoi (
/**
Writes the current value of 64-bit Performance Monitor Vector Register (PMV).
+
+ Writes the current value of PMV. The 64-bit value written to the PMV is returned.
No parameter checking is performed on Value. All bits of Value corresponding
to reserved fields of PMV must be 0 or a Reserved Register/Field fault may occur.
The caller must either guarantee that Value is valid, or the caller must set up
fault handlers to catch the faults.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
- @param Value The 64-bit value to write to PMV.
+ @param Value The 64-bit value to write to PMV.
@return The 64-bit value written to the PMV.
@@ -4502,13 +6018,15 @@ AsmWritePmv (
/**
Writes the current value of 64-bit Corrected Machine Check Vector Register (CMCV).
+
+ Writes the current value of CMCV. The 64-bit value written to the CMCV is returned.
No parameter checking is performed on Value. All bits of Value corresponding
to reserved fields of CMCV must be 0 or a Reserved Register/Field fault may occur.
The caller must either guarantee that Value is valid, or the caller must set up
fault handlers to catch the faults.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
- @param Value The 64-bit value to write to CMCV.
+ @param Value The 64-bit value to write to CMCV.
@return The 64-bit value written to the CMCV.
@@ -4522,13 +6040,15 @@ AsmWriteCmcv (
/**
Writes the current value of 64-bit Local Redirection Register #0 (LRR0).
+
+ Writes the current value of LRR0. The 64-bit value written to the LRR0 is returned.
No parameter checking is performed on Value. All bits of Value corresponding
to reserved fields of LRR0 must be 0 or a Reserved Register/Field fault may occur.
The caller must either guarantee that Value is valid, or the caller must set up
fault handlers to catch the faults.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
- @param Value The 64-bit value to write to LRR0.
+ @param Value The 64-bit value to write to LRR0.
@return The 64-bit value written to the LRR0.
@@ -4542,13 +6062,15 @@ AsmWriteLrr0 (
/**
Writes the current value of 64-bit Local Redirection Register #1 (LRR1).
+
+ Writes the current value of LRR1. The 64-bit value written to the LRR1 is returned.
No parameter checking is performed on Value. All bits of Value corresponding
to reserved fields of LRR1 must be 0 or a Reserved Register/Field fault may occur.
The caller must either guarantee that Value is valid, or the caller must
set up fault handlers to catch the faults.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
- @param Value The 64-bit value to write to LRR1.
+ @param Value The 64-bit value to write to LRR1.
@return The 64-bit value written to the LRR1.
@@ -4562,18 +6084,18 @@ AsmWriteLrr1 (
/**
Reads the current value of Instruction Breakpoint Register (IBR).
-
+
The Instruction Breakpoint Registers are used in pairs. The even numbered
registers contain breakpoint addresses, and the odd numbered registers contain
- breakpoint mask conditions. At least 4 instruction registers pairs are implemented
+ breakpoint mask conditions. At least four instruction registers pairs are implemented
on all processor models. Implemented registers are contiguous starting with
register 0. No parameter checking is performed on Index, and if the Index value
is beyond the implemented IBR register range, a Reserved Register/Field fault may
occur. The caller must either guarantee that Index is valid, or the caller must
set up fault handlers to catch the faults.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
- @param Index The 8-bit Instruction Breakpoint Register index to read.
+ @param Index The 8-bit Instruction Breakpoint Register index to read.
@return The current value of Instruction Breakpoint Register specified by Index.
@@ -4590,15 +6112,15 @@ AsmReadIbr (
The Data Breakpoint Registers are used in pairs. The even numbered registers
contain breakpoint addresses, and odd numbered registers contain breakpoint
- mask conditions. At least 4 data registers pairs are implemented on all processor
+ mask conditions. At least four data registers pairs are implemented on all processor
models. Implemented registers are contiguous starting with register 0.
No parameter checking is performed on Index. If the Index value is beyond
the implemented DBR register range, a Reserved Register/Field fault may occur.
The caller must either guarantee that Index is valid, or the caller must set up
fault handlers to catch the faults.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
- @param Index The 8-bit Data Breakpoint Register index to read.
+ @param Index The 8-bit Data Breakpoint Register index to read.
@return The current value of Data Breakpoint Register specified by Index.
@@ -4613,20 +6135,20 @@ AsmReadDbr (
/**
Reads the current value of Performance Monitor Configuration Register (PMC).
- All processor implementations provide at least 4 performance counters
- (PMC/PMD [4]...PMC/PMD [7] pairs), and 4 performance monitor counter overflow
+ All processor implementations provide at least four performance counters
+ (PMC/PMD [4]...PMC/PMD [7] pairs), and four performance monitor counter overflow
status registers (PMC [0]... PMC [3]). Processor implementations may provide
additional implementation-dependent PMC and PMD to increase the number of
'generic' performance counters (PMC/PMD pairs). The remainder of PMC and PMD
register set is implementation dependent. No parameter checking is performed
on Index. If the Index value is beyond the implemented PMC register range,
zero value will be returned.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
- @param Index The 8-bit Performance Monitor Configuration Register index to read.
+ @param Index The 8-bit Performance Monitor Configuration Register index to read.
- @return The current value of Performance Monitor Configuration Register
- specified by Index.
+ @return The current value of Performance Monitor Configuration Register
+ specified by Index.
**/
UINT64
@@ -4647,9 +6169,9 @@ AsmReadPmc (
register set is implementation dependent. No parameter checking is performed
on Index. If the Index value is beyond the implemented PMD register range,
zero value will be returned.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
- @param Index The 8-bit Performance Monitor Data Register index to read.
+ @param Index The 8-bit Performance Monitor Data Register index to read.
@return The current value of Performance Monitor Data Register specified by Index.
@@ -4667,16 +6189,16 @@ AsmReadPmd (
Writes current value of Instruction Breakpoint Register specified by Index.
The Instruction Breakpoint Registers are used in pairs. The even numbered
registers contain breakpoint addresses, and odd numbered registers contain
- breakpoint mask conditions. At least 4 instruction registers pairs are implemented
+ breakpoint mask conditions. At least four instruction registers pairs are implemented
on all processor models. Implemented registers are contiguous starting with
register 0. No parameter checking is performed on Index. If the Index value
is beyond the implemented IBR register range, a Reserved Register/Field fault may
occur. The caller must either guarantee that Index is valid, or the caller must
set up fault handlers to catch the faults.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
- @param Index The 8-bit Instruction Breakpoint Register index to write.
- @param Value The 64-bit value to write to IBR.
+ @param Index The 8-bit Instruction Breakpoint Register index to write.
+ @param Value The 64-bit value to write to IBR.
@return The 64-bit value written to the IBR.
@@ -4695,16 +6217,16 @@ AsmWriteIbr (
Writes current value of Data Breakpoint Register specified by Index.
The Data Breakpoint Registers are used in pairs. The even numbered registers
contain breakpoint addresses, and odd numbered registers contain breakpoint
- mask conditions. At least 4 data registers pairs are implemented on all processor
+ mask conditions. At least four data registers pairs are implemented on all processor
models. Implemented registers are contiguous starting with register 0. No parameter
checking is performed on Index. If the Index value is beyond the implemented
DBR register range, a Reserved Register/Field fault may occur. The caller must
either guarantee that Index is valid, or the caller must set up fault handlers to
catch the faults.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
- @param Index The 8-bit Data Breakpoint Register index to write.
- @param Value The 64-bit value to write to DBR.
+ @param Index The 8-bit Data Breakpoint Register index to write.
+ @param Value The 64-bit value to write to DBR.
@return The 64-bit value written to the DBR.
@@ -4721,17 +6243,17 @@ AsmWriteDbr (
Writes the current value of 64-bit Performance Monitor Configuration Register (PMC).
Writes current value of Performance Monitor Configuration Register specified by Index.
- All processor implementations provide at least 4 performance counters
- (PMC/PMD [4]...PMC/PMD [7] pairs), and 4 performance monitor counter overflow status
+ All processor implementations provide at least four performance counters
+ (PMC/PMD [4]...PMC/PMD [7] pairs), and four performance monitor counter overflow status
registers (PMC [0]... PMC [3]). Processor implementations may provide additional
implementation-dependent PMC and PMD to increase the number of 'generic' performance
counters (PMC/PMD pairs). The remainder of PMC and PMD register set is implementation
dependent. No parameter checking is performed on Index. If the Index value is
beyond the implemented PMC register range, the write is ignored.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
- @param Index The 8-bit Performance Monitor Configuration Register index to write.
- @param Value The 64-bit value to write to PMC.
+ @param Index The 8-bit Performance Monitor Configuration Register index to write.
+ @param Value The 64-bit value to write to PMC.
@return The 64-bit value written to the PMC.
@@ -4748,17 +6270,17 @@ AsmWritePmc (
Writes the current value of 64-bit Performance Monitor Data Register (PMD).
Writes current value of Performance Monitor Data Register specified by Index.
- All processor implementations provide at least 4 performance counters
- (PMC/PMD [4]...PMC/PMD [7] pairs), and 4 performance monitor counter overflow
+ All processor implementations provide at least four performance counters
+ (PMC/PMD [4]...PMC/PMD [7] pairs), and four performance monitor counter overflow
status registers (PMC [0]... PMC [3]). Processor implementations may provide
additional implementation-dependent PMC and PMD to increase the number of 'generic'
performance counters (PMC/PMD pairs). The remainder of PMC and PMD register set
is implementation dependent. No parameter checking is performed on Index. If the
Index value is beyond the implemented PMD register range, the write is ignored.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
- @param Index The 8-bit Performance Monitor Data Register index to write.
- @param Value The 64-bit value to write to PMD.
+ @param Index The 8-bit Performance Monitor Data Register index to write.
+ @param Value The 64-bit value to write to PMD.
@return The 64-bit value written to the PMD.
@@ -4775,7 +6297,7 @@ AsmWritePmd (
Reads the current value of 64-bit Global Pointer (GP).
Reads and returns the current value of GP.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
@return The current value of GP.
@@ -4792,7 +6314,7 @@ AsmReadGp (
Writes the current value of GP. The 64-bit value written to the GP is returned.
No parameter checking is performed on Value.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
@param Value The 64-bit value to write to GP.
@@ -4810,7 +6332,7 @@ AsmWriteGp (
Reads the current value of 64-bit Stack Pointer (SP).
Reads and returns the current value of SP.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
@return The current value of SP.
@@ -4822,6 +6344,151 @@ AsmReadSp (
);
+///
+/// Valid Index value for AsmReadControlRegister().
+///
+#define IPF_CONTROL_REGISTER_DCR 0
+#define IPF_CONTROL_REGISTER_ITM 1
+#define IPF_CONTROL_REGISTER_IVA 2
+#define IPF_CONTROL_REGISTER_PTA 8
+#define IPF_CONTROL_REGISTER_IPSR 16
+#define IPF_CONTROL_REGISTER_ISR 17
+#define IPF_CONTROL_REGISTER_IIP 19
+#define IPF_CONTROL_REGISTER_IFA 20
+#define IPF_CONTROL_REGISTER_ITIR 21
+#define IPF_CONTROL_REGISTER_IIPA 22
+#define IPF_CONTROL_REGISTER_IFS 23
+#define IPF_CONTROL_REGISTER_IIM 24
+#define IPF_CONTROL_REGISTER_IHA 25
+#define IPF_CONTROL_REGISTER_LID 64
+#define IPF_CONTROL_REGISTER_IVR 65
+#define IPF_CONTROL_REGISTER_TPR 66
+#define IPF_CONTROL_REGISTER_EOI 67
+#define IPF_CONTROL_REGISTER_IRR0 68
+#define IPF_CONTROL_REGISTER_IRR1 69
+#define IPF_CONTROL_REGISTER_IRR2 70
+#define IPF_CONTROL_REGISTER_IRR3 71
+#define IPF_CONTROL_REGISTER_ITV 72
+#define IPF_CONTROL_REGISTER_PMV 73
+#define IPF_CONTROL_REGISTER_CMCV 74
+#define IPF_CONTROL_REGISTER_LRR0 80
+#define IPF_CONTROL_REGISTER_LRR1 81
+
+/**
+ Reads a 64-bit control register.
+
+ Reads and returns the control register specified by Index. The valid Index valued
+ are defined above in "Related Definitions".
+ If Index is invalid then 0xFFFFFFFFFFFFFFFF is returned. This function is only
+ available on Itanium processors.
+
+ @param Index The index of the control register to read.
+
+ @return The control register specified by Index.
+
+**/
+UINT64
+EFIAPI
+AsmReadControlRegister (
+ IN UINT64 Index
+ );
+
+
+///
+/// Valid Index value for AsmReadApplicationRegister().
+///
+#define IPF_APPLICATION_REGISTER_K0 0
+#define IPF_APPLICATION_REGISTER_K1 1
+#define IPF_APPLICATION_REGISTER_K2 2
+#define IPF_APPLICATION_REGISTER_K3 3
+#define IPF_APPLICATION_REGISTER_K4 4
+#define IPF_APPLICATION_REGISTER_K5 5
+#define IPF_APPLICATION_REGISTER_K6 6
+#define IPF_APPLICATION_REGISTER_K7 7
+#define IPF_APPLICATION_REGISTER_RSC 16
+#define IPF_APPLICATION_REGISTER_BSP 17
+#define IPF_APPLICATION_REGISTER_BSPSTORE 18
+#define IPF_APPLICATION_REGISTER_RNAT 19
+#define IPF_APPLICATION_REGISTER_FCR 21
+#define IPF_APPLICATION_REGISTER_EFLAG 24
+#define IPF_APPLICATION_REGISTER_CSD 25
+#define IPF_APPLICATION_REGISTER_SSD 26
+#define IPF_APPLICATION_REGISTER_CFLG 27
+#define IPF_APPLICATION_REGISTER_FSR 28
+#define IPF_APPLICATION_REGISTER_FIR 29
+#define IPF_APPLICATION_REGISTER_FDR 30
+#define IPF_APPLICATION_REGISTER_CCV 32
+#define IPF_APPLICATION_REGISTER_UNAT 36
+#define IPF_APPLICATION_REGISTER_FPSR 40
+#define IPF_APPLICATION_REGISTER_ITC 44
+#define IPF_APPLICATION_REGISTER_PFS 64
+#define IPF_APPLICATION_REGISTER_LC 65
+#define IPF_APPLICATION_REGISTER_EC 66
+
+/**
+ Reads a 64-bit application register.
+
+ Reads and returns the application register specified by Index. The valid Index
+ valued are defined above in "Related Definitions".
+ If Index is invalid then 0xFFFFFFFFFFFFFFFF is returned. This function is only
+ available on Itanium processors.
+
+ @param Index The index of the application register to read.
+
+ @return The application register specified by Index.
+
+**/
+UINT64
+EFIAPI
+AsmReadApplicationRegister (
+ IN UINT64 Index
+ );
+
+
+/**
+ Reads the current value of a Machine Specific Register (MSR).
+
+ Reads and returns the current value of the Machine Specific Register specified by Index. No
+ parameter checking is performed on Index, and if the Index value is beyond the implemented MSR
+ register range, a Reserved Register/Field fault may occur. The caller must either guarantee that
+ Index is valid, or the caller must set up fault handlers to catch the faults. This function is
+ only available on Itanium processors.
+
+ @param Index The 8-bit Machine Specific Register index to read.
+
+ @return The current value of the Machine Specific Register specified by Index.
+
+**/
+UINT64
+EFIAPI
+AsmReadMsr (
+ IN UINT8 Index
+ );
+
+
+/**
+ Writes the current value of a Machine Specific Register (MSR).
+
+ Writes Value to the Machine Specific Register specified by Index. Value is returned. No
+ parameter checking is performed on Index, and if the Index value is beyond the implemented MSR
+ register range, a Reserved Register/Field fault may occur. The caller must either guarantee that
+ Index is valid, or the caller must set up fault handlers to catch the faults. This function is
+ only available on Itanium processors.
+
+ @param Index The 8-bit Machine Specific Register index to write.
+ @param Value The 64-bit value to write to the Machine Specific Register.
+
+ @return The 64-bit value to write to the Machine Specific Register.
+
+**/
+UINT64
+EFIAPI
+AsmWriteMsr (
+ IN UINT8 Index,
+ IN UINT64 Value
+ );
+
+
/**
Determines if the CPU is currently executing in virtual, physical, or mixed mode.
@@ -4830,11 +6497,11 @@ AsmReadSp (
If the CPU is in physical mode(PSR.RT=0, PSR.DT=0, PSR.IT=0), then 0 is returned.
If the CPU is not in physical mode or virtual mode, then it is in mixed mode,
and -1 is returned.
- This function is only available on IPF.
+ This function is only available on Itanium processors.
- @return 1 The CPU is in virtual mode.
- @return 0 The CPU is in physical mode.
- @return -1 The CPU is in mixed mode.
+ @retval 1 The CPU is in virtual mode.
+ @retval 0 The CPU is in physical mode.
+ @retval -1 The CPU is in mixed mode.
**/
INT64
@@ -4864,13 +6531,13 @@ AsmCpuVirtual (
argument return value may be returned or undefined result may occur during the
execution of the procedure. If the PalEntryPoint does not point to a valid
PAL entry point then the system behavior is undefined. This function is only
- available on IPF.
+ available on Itanium processors.
- @param PalEntryPoint The PAL procedure calls entry point.
- @param Index The PAL procedure Index number.
- @param Arg2 The 2nd parameter for PAL procedure calls.
- @param Arg3 The 3rd parameter for PAL procedure calls.
- @param Arg4 The 4th parameter for PAL procedure calls.
+ @param PalEntryPoint The PAL procedure calls entry point.
+ @param Index The PAL procedure Index number.
+ @param Arg2 The 2nd parameter for PAL procedure calls.
+ @param Arg3 The 3rd parameter for PAL procedure calls.
+ @param Arg4 The 4th parameter for PAL procedure calls.
@return structure returned from the PAL Call procedure, including the status and return value.
@@ -4884,184 +6551,145 @@ AsmPalCall (
IN UINT64 Arg3,
IN UINT64 Arg4
);
+#endif // defined (MDE_CPU_IPF)
-
-/**
- Transfers control to a function starting with a new stack.
-
- Transfers control to the function specified by EntryPoint using the new stack
- specified by NewStack and passing in the parameters specified by Context1 and
- Context2. Context1 and Context2 are optional and may be NULL. The function
- EntryPoint must never return.
-
- If EntryPoint is NULL, then ASSERT().
- If NewStack is NULL, then ASSERT().
-
- @param EntryPoint A pointer to function to call with the new stack.
- @param Context1 A pointer to the context to pass into the EntryPoint
- function.
- @param Context2 A pointer to the context to pass into the EntryPoint
- function.
- @param NewStack A pointer to the new stack to use for the EntryPoint
- function.
- @param NewBsp A pointer to the new memory location for RSE backing
- store.
-
-**/
-VOID
-EFIAPI
-AsmSwitchStackAndBackingStore (
- IN SWITCH_STACK_ENTRY_POINT EntryPoint,
- IN VOID *Context1, OPTIONAL
- IN VOID *Context2, OPTIONAL
- IN VOID *NewStack,
- IN VOID *NewBsp
- );
-
-/**
- @todo This call should be removed after the PalCall
- Instance issue has been fixed.
-
- Performs a PAL call using static calling convention.
-
- An internal function to perform a PAL call using static calling convention.
-
- @param PalEntryPoint The entry point address of PAL. The address in ar.kr5
- would be used if this parameter were NULL on input.
- @param Arg1 The first argument of a PAL call.
- @param Arg2 The second argument of a PAL call.
- @param Arg3 The third argument of a PAL call.
- @param Arg4 The fourth argument of a PAL call.
-
- @return The values returned in r8, r9, r10 and r11.
-
-**/
-PAL_CALL_RETURN
-PalCallStatic (
- IN CONST VOID *PalEntryPoint,
- IN UINT64 Arg1,
- IN UINT64 Arg2,
- IN UINT64 Arg3,
- IN UINT64 Arg4
- );
-
-
-#elif defined (MDE_CPU_IA32) || defined (MDE_CPU_X64)
+#if defined (MDE_CPU_IA32) || defined (MDE_CPU_X64)
///
-/// IA32 and X64 Specific Functions
-/// Byte packed structure for 16-bit Real Mode EFLAGS
+/// IA32 and x64 Specific Functions.
+/// Byte packed structure for 16-bit Real Mode EFLAGS.
///
typedef union {
struct {
- UINT32 CF:1; /// Carry Flag
- UINT32 Reserved_0:1; /// Reserved
- UINT32 PF:1; /// Parity Flag
- UINT32 Reserved_1:1; /// Reserved
- UINT32 AF:1; /// Auxiliary Carry Flag
- UINT32 Reserved_2:1; /// Reserved
- UINT32 ZF:1; /// Zero Flag
- UINT32 SF:1; /// Sign Flag
- UINT32 TF:1; /// Trap Flag
- UINT32 IF:1; /// Interrupt Enable Flag
- UINT32 DF:1; /// Direction Flag
- UINT32 OF:1; /// Overflow Flag
- UINT32 IOPL:2; /// I/O Privilege Level
- UINT32 NT:1; /// Nested Task
- UINT32 Reserved_3:1; /// Reserved
+ UINT32 CF:1; ///< Carry Flag.
+ UINT32 Reserved_0:1; ///< Reserved.
+ UINT32 PF:1; ///< Parity Flag.
+ UINT32 Reserved_1:1; ///< Reserved.
+ UINT32 AF:1; ///< Auxiliary Carry Flag.
+ UINT32 Reserved_2:1; ///< Reserved.
+ UINT32 ZF:1; ///< Zero Flag.
+ UINT32 SF:1; ///< Sign Flag.
+ UINT32 TF:1; ///< Trap Flag.
+ UINT32 IF:1; ///< Interrupt Enable Flag.
+ UINT32 DF:1; ///< Direction Flag.
+ UINT32 OF:1; ///< Overflow Flag.
+ UINT32 IOPL:2; ///< I/O Privilege Level.
+ UINT32 NT:1; ///< Nested Task.
+ UINT32 Reserved_3:1; ///< Reserved.
} Bits;
UINT16 Uint16;
} IA32_FLAGS16;
///
-/// Byte packed structure for EFLAGS/RFLAGS
-/// 32-bits on IA-32
-/// 64-bits on X64. The upper 32-bits on X64 are reserved
+/// Byte packed structure for EFLAGS/RFLAGS.
+/// 32-bits on IA-32.
+/// 64-bits on x64. The upper 32-bits on x64 are reserved.
///
typedef union {
struct {
- UINT32 CF:1; /// Carry Flag
- UINT32 Reserved_0:1; /// Reserved
- UINT32 PF:1; /// Parity Flag
- UINT32 Reserved_1:1; /// Reserved
- UINT32 AF:1; /// Auxiliary Carry Flag
- UINT32 Reserved_2:1; /// Reserved
- UINT32 ZF:1; /// Zero Flag
- UINT32 SF:1; /// Sign Flag
- UINT32 TF:1; /// Trap Flag
- UINT32 IF:1; /// Interrupt Enable Flag
- UINT32 DF:1; /// Direction Flag
- UINT32 OF:1; /// Overflow Flag
- UINT32 IOPL:2; /// I/O Privilege Level
- UINT32 NT:1; /// Nested Task
- UINT32 Reserved_3:1; /// Reserved
- UINT32 RF:1; /// Resume Flag
- UINT32 VM:1; /// Virtual 8086 Mode
- UINT32 AC:1; /// Alignment Check
- UINT32 VIF:1; /// Virtual Interrupt Flag
- UINT32 VIP:1; /// Virtual Interrupt Pending
- UINT32 ID:1; /// ID Flag
- UINT32 Reserved_4:10; /// Reserved
+ UINT32 CF:1; ///< Carry Flag.
+ UINT32 Reserved_0:1; ///< Reserved.
+ UINT32 PF:1; ///< Parity Flag.
+ UINT32 Reserved_1:1; ///< Reserved.
+ UINT32 AF:1; ///< Auxiliary Carry Flag.
+ UINT32 Reserved_2:1; ///< Reserved.
+ UINT32 ZF:1; ///< Zero Flag.
+ UINT32 SF:1; ///< Sign Flag.
+ UINT32 TF:1; ///< Trap Flag.
+ UINT32 IF:1; ///< Interrupt Enable Flag.
+ UINT32 DF:1; ///< Direction Flag.
+ UINT32 OF:1; ///< Overflow Flag.
+ UINT32 IOPL:2; ///< I/O Privilege Level.
+ UINT32 NT:1; ///< Nested Task.
+ UINT32 Reserved_3:1; ///< Reserved.
+ UINT32 RF:1; ///< Resume Flag.
+ UINT32 VM:1; ///< Virtual 8086 Mode.
+ UINT32 AC:1; ///< Alignment Check.
+ UINT32 VIF:1; ///< Virtual Interrupt Flag.
+ UINT32 VIP:1; ///< Virtual Interrupt Pending.
+ UINT32 ID:1; ///< ID Flag.
+ UINT32 Reserved_4:10; ///< Reserved.
} Bits;
UINTN UintN;
} IA32_EFLAGS32;
///
-/// Byte packed structure for Control Register 0 (CR0)
-/// 32-bits on IA-32
-/// 64-bits on X64. The upper 32-bits on X64 are reserved
+/// Byte packed structure for Control Register 0 (CR0).
+/// 32-bits on IA-32.
+/// 64-bits on x64. The upper 32-bits on x64 are reserved.
///
typedef union {
struct {
- UINT32 PE:1; /// Protection Enable
- UINT32 MP:1; /// Monitor Coprocessor
- UINT32 EM:1; /// Emulation
- UINT32 TS:1; /// Task Switched
- UINT32 ET:1; /// Extension Type
- UINT32 NE:1; /// Numeric Error
- UINT32 Reserved_0:10; /// Reserved
- UINT32 WP:1; /// Write Protect
- UINT32 Reserved_1:1; /// Reserved
- UINT32 AM:1; /// Alignment Mask
- UINT32 Reserved_2:10; /// Reserved
- UINT32 NW:1; /// Mot Write-through
- UINT32 CD:1; /// Cache Disable
- UINT32 PG:1; /// Paging
+ UINT32 PE:1; ///< Protection Enable.
+ UINT32 MP:1; ///< Monitor Coprocessor.
+ UINT32 EM:1; ///< Emulation.
+ UINT32 TS:1; ///< Task Switched.
+ UINT32 ET:1; ///< Extension Type.
+ UINT32 NE:1; ///< Numeric Error.
+ UINT32 Reserved_0:10; ///< Reserved.
+ UINT32 WP:1; ///< Write Protect.
+ UINT32 Reserved_1:1; ///< Reserved.
+ UINT32 AM:1; ///< Alignment Mask.
+ UINT32 Reserved_2:10; ///< Reserved.
+ UINT32 NW:1; ///< Mot Write-through.
+ UINT32 CD:1; ///< Cache Disable.
+ UINT32 PG:1; ///< Paging.
} Bits;
UINTN UintN;
} IA32_CR0;
///
-/// Byte packed structure for Control Register 4 (CR4)
-/// 32-bits on IA-32
-/// 64-bits on X64. The upper 32-bits on X64 are reserved
+/// Byte packed structure for Control Register 4 (CR4).
+/// 32-bits on IA-32.
+/// 64-bits on x64. The upper 32-bits on x64 are reserved.
///
typedef union {
struct {
- UINT32 VME:1; /// Virtual-8086 Mode Extensions
- UINT32 PVI:1; /// Protected-Mode Virtual Interrupts
- UINT32 TSD:1; /// Time Stamp Disable
- UINT32 DE:1; /// Debugging Extensions
- UINT32 PSE:1; /// Page Size Extensions
- UINT32 PAE:1; /// Physical Address Extension
- UINT32 MCE:1; /// Machine Check Enable
- UINT32 PGE:1; /// Page Global Enable
- UINT32 PCE:1; /// Performance Monitoring Counter
- /// Enable
- UINT32 OSFXSR:1; /// Operating System Support for
- /// FXSAVE and FXRSTOR instructions
- UINT32 OSXMMEXCPT:1; /// Operating System Support for
- /// Unmasked SIMD Floating Point
- /// Exceptions
- UINT32 Reserved_0:2; /// Reserved
- UINT32 VMXE:1; /// VMX Enable
- UINT32 Reserved_1:18; /// Reseved
+ UINT32 VME:1; ///< Virtual-8086 Mode Extensions.
+ UINT32 PVI:1; ///< Protected-Mode Virtual Interrupts.
+ UINT32 TSD:1; ///< Time Stamp Disable.
+ UINT32 DE:1; ///< Debugging Extensions.
+ UINT32 PSE:1; ///< Page Size Extensions.
+ UINT32 PAE:1; ///< Physical Address Extension.
+ UINT32 MCE:1; ///< Machine Check Enable.
+ UINT32 PGE:1; ///< Page Global Enable.
+ UINT32 PCE:1; ///< Performance Monitoring Counter
+ ///< Enable.
+ UINT32 OSFXSR:1; ///< Operating System Support for
+ ///< FXSAVE and FXRSTOR instructions
+ UINT32 OSXMMEXCPT:1; ///< Operating System Support for
+ ///< Unmasked SIMD Floating Point
+ ///< Exceptions.
+ UINT32 Reserved_0:2; ///< Reserved.
+ UINT32 VMXE:1; ///< VMX Enable
+ UINT32 Reserved_1:18; ///< Reserved.
} Bits;
UINTN UintN;
} IA32_CR4;
///
-/// Byte packed structure for an IDTR, GDTR, LDTR descriptor
-/// @todo How to make this structure byte-packed in a compiler independent way?
+/// Byte packed structure for a segment descriptor in a GDT/LDT.
+///
+typedef union {
+ struct {
+ UINT32 LimitLow:16;
+ UINT32 BaseLow:16;
+ UINT32 BaseMid:8;
+ UINT32 Type:4;
+ UINT32 S:1;
+ UINT32 DPL:2;
+ UINT32 P:1;
+ UINT32 LimitHigh:4;
+ UINT32 AVL:1;
+ UINT32 L:1;
+ UINT32 DB:1;
+ UINT32 G:1;
+ UINT32 BaseHigh:8;
+ } Bits;
+ UINT64 Uint64;
+} IA32_SEGMENT_DESCRIPTOR;
+
+///
+/// Byte packed structure for an IDTR, GDTR, LDTR descriptor.
///
#pragma pack (1)
typedef struct {
@@ -5076,29 +6704,161 @@ typedef struct {
#define IA32_IDT_GATE_TYPE_INTERRUPT_32 0x8E
#define IA32_IDT_GATE_TYPE_TRAP_32 0x8F
+#define IA32_GDT_TYPE_TSS 0x9
+#define IA32_GDT_ALIGNMENT 8
+
+#if defined (MDE_CPU_IA32)
///
-/// Byte packed structure for an Interrupt Gate Descriptor
+/// Byte packed structure for an IA-32 Interrupt Gate Descriptor.
///
typedef union {
struct {
- UINT32 OffsetLow:16; /// Offset bits 15..0
- UINT32 Selector:16; /// Selector
- UINT32 Reserved_0:8; /// Reserved
- UINT32 GateType:8; /// Gate Type. See #defines above
- UINT32 OffsetHigh:16; /// Offset bits 31..16
+ UINT32 OffsetLow:16; ///< Offset bits 15..0.
+ UINT32 Selector:16; ///< Selector.
+ UINT32 Reserved_0:8; ///< Reserved.
+ UINT32 GateType:8; ///< Gate Type. See #defines above.
+ UINT32 OffsetHigh:16; ///< Offset bits 31..16.
+ } Bits;
+ UINT64 Uint64;
+} IA32_IDT_GATE_DESCRIPTOR;
+
+#pragma pack (1)
+//
+// IA32 Task-State Segment Definition
+//
+typedef struct {
+ UINT16 PreviousTaskLink;
+ UINT16 Reserved_2;
+ UINT32 ESP0;
+ UINT16 SS0;
+ UINT16 Reserved_10;
+ UINT32 ESP1;
+ UINT16 SS1;
+ UINT16 Reserved_18;
+ UINT32 ESP2;
+ UINT16 SS2;
+ UINT16 Reserved_26;
+ UINT32 CR3;
+ UINT32 EIP;
+ UINT32 EFLAGS;
+ UINT32 EAX;
+ UINT32 ECX;
+ UINT32 EDX;
+ UINT32 EBX;
+ UINT32 ESP;
+ UINT32 EBP;
+ UINT32 ESI;
+ UINT32 EDI;
+ UINT16 ES;
+ UINT16 Reserved_74;
+ UINT16 CS;
+ UINT16 Reserved_78;
+ UINT16 SS;
+ UINT16 Reserved_82;
+ UINT16 DS;
+ UINT16 Reserved_86;
+ UINT16 FS;
+ UINT16 Reserved_90;
+ UINT16 GS;
+ UINT16 Reserved_94;
+ UINT16 LDTSegmentSelector;
+ UINT16 Reserved_98;
+ UINT16 T;
+ UINT16 IOMapBaseAddress;
+} IA32_TASK_STATE_SEGMENT;
+
+typedef union {
+ struct {
+ UINT32 LimitLow:16; ///< Segment Limit 15..00
+ UINT32 BaseLow:16; ///< Base Address 15..00
+ UINT32 BaseMid:8; ///< Base Address 23..16
+ UINT32 Type:4; ///< Type (1 0 B 1)
+ UINT32 Reserved_43:1; ///< 0
+ UINT32 DPL:2; ///< Descriptor Privilege Level
+ UINT32 P:1; ///< Segment Present
+ UINT32 LimitHigh:4; ///< Segment Limit 19..16
+ UINT32 AVL:1; ///< Available for use by system software
+ UINT32 Reserved_52:2; ///< 0 0
+ UINT32 G:1; ///< Granularity
+ UINT32 BaseHigh:8; ///< Base Address 31..24
} Bits;
UINT64 Uint64;
+} IA32_TSS_DESCRIPTOR;
+#pragma pack ()
+
+#endif // defined (MDE_CPU_IA32)
+
+#if defined (MDE_CPU_X64)
+///
+/// Byte packed structure for an x64 Interrupt Gate Descriptor.
+///
+typedef union {
+ struct {
+ UINT32 OffsetLow:16; ///< Offset bits 15..0.
+ UINT32 Selector:16; ///< Selector.
+ UINT32 Reserved_0:8; ///< Reserved.
+ UINT32 GateType:8; ///< Gate Type. See #defines above.
+ UINT32 OffsetHigh:16; ///< Offset bits 31..16.
+ UINT32 OffsetUpper:32; ///< Offset bits 63..32.
+ UINT32 Reserved_1:32; ///< Reserved.
+ } Bits;
+ struct {
+ UINT64 Uint64;
+ UINT64 Uint64_1;
+ } Uint128;
} IA32_IDT_GATE_DESCRIPTOR;
+#pragma pack (1)
+//
+// IA32 Task-State Segment Definition
+//
+typedef struct {
+ UINT32 Reserved_0;
+ UINT64 RSP0;
+ UINT64 RSP1;
+ UINT64 RSP2;
+ UINT64 Reserved_28;
+ UINT64 IST[7];
+ UINT64 Reserved_92;
+ UINT16 Reserved_100;
+ UINT16 IOMapBaseAddress;
+} IA32_TASK_STATE_SEGMENT;
+
+typedef union {
+ struct {
+ UINT32 LimitLow:16; ///< Segment Limit 15..00
+ UINT32 BaseLow:16; ///< Base Address 15..00
+ UINT32 BaseMidl:8; ///< Base Address 23..16
+ UINT32 Type:4; ///< Type (1 0 B 1)
+ UINT32 Reserved_43:1; ///< 0
+ UINT32 DPL:2; ///< Descriptor Privilege Level
+ UINT32 P:1; ///< Segment Present
+ UINT32 LimitHigh:4; ///< Segment Limit 19..16
+ UINT32 AVL:1; ///< Available for use by system software
+ UINT32 Reserved_52:2; ///< 0 0
+ UINT32 G:1; ///< Granularity
+ UINT32 BaseMidh:8; ///< Base Address 31..24
+ UINT32 BaseHigh:32; ///< Base Address 63..32
+ UINT32 Reserved_96:32; ///< Reserved
+ } Bits;
+ struct {
+ UINT64 Uint64;
+ UINT64 Uint64_1;
+ } Uint128;
+} IA32_TSS_DESCRIPTOR;
+#pragma pack ()
+
+#endif // defined (MDE_CPU_X64)
+
///
-/// Byte packed structure for an FP/SSE/SSE2 context
+/// Byte packed structure for an FP/SSE/SSE2 context.
///
typedef struct {
UINT8 Buffer[512];
} IA32_FX_BUFFER;
///
-/// Structures for the 16-bit real mode thunks
+/// Structures for the 16-bit real mode thunks.
///
typedef struct {
UINT32 Reserved1;
@@ -5164,7 +6924,7 @@ typedef union {
} IA32_REGISTER_SET;
///
-/// Byte packed structure for an 16-bit real mode thunks
+/// Byte packed structure for an 16-bit real mode thunks.
///
typedef struct {
IA32_REGISTER_SET *RealModeState;
@@ -5177,6 +6937,20 @@ typedef struct {
#define THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 0x00000002
#define THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL 0x00000004
+///
+/// Type definition for representing labels in NASM source code that allow for
+/// the patching of immediate operands of IA32 and X64 instructions.
+///
+/// While the type is technically defined as a function type (note: not a
+/// pointer-to-function type), such labels in NASM source code never stand for
+/// actual functions, and identifiers declared with this function type should
+/// never be called. This is also why the EFIAPI calling convention specifier
+/// is missing from the typedef, and why the typedef does not follow the usual
+/// edk2 coding style for function (or pointer-to-function) typedefs. The VOID
+/// return type and the VOID argument list are merely artifacts.
+///
+typedef VOID (X86_ASSEMBLY_PATCH_LABEL) (VOID);
+
/**
Retrieves CPUID information.
@@ -5186,20 +6960,20 @@ typedef struct {
If Ebx is not NULL, then the value of EBX after CPUID is returned in Ebx.
If Ecx is not NULL, then the value of ECX after CPUID is returned in Ecx.
If Edx is not NULL, then the value of EDX after CPUID is returned in Edx.
- This function is only available on IA-32 and X64.
+ This function is only available on IA-32 and x64.
@param Index The 32-bit value to load into EAX prior to invoking the CPUID
instruction.
- @param Eax Pointer to the 32-bit EAX value returned by the CPUID
+ @param Eax The pointer to the 32-bit EAX value returned by the CPUID
instruction. This is an optional parameter that may be NULL.
- @param Ebx Pointer to the 32-bit EBX value returned by the CPUID
+ @param Ebx The pointer to the 32-bit EBX value returned by the CPUID
instruction. This is an optional parameter that may be NULL.
- @param Ecx Pointer to the 32-bit ECX value returned by the CPUID
+ @param Ecx The pointer to the 32-bit ECX value returned by the CPUID
instruction. This is an optional parameter that may be NULL.
- @param Edx Pointer to the 32-bit EDX value returned by the CPUID
+ @param Edx The pointer to the 32-bit EDX value returned by the CPUID
instruction. This is an optional parameter that may be NULL.
- @return Index
+ @return Index.
**/
UINT32
@@ -5229,20 +7003,20 @@ AsmCpuid (
CPUID instruction.
@param SubIndex The 32-bit value to load into ECX prior to invoking the
CPUID instruction.
- @param Eax Pointer to the 32-bit EAX value returned by the CPUID
+ @param Eax The pointer to the 32-bit EAX value returned by the CPUID
instruction. This is an optional parameter that may be
NULL.
- @param Ebx Pointer to the 32-bit EBX value returned by the CPUID
+ @param Ebx The pointer to the 32-bit EBX value returned by the CPUID
instruction. This is an optional parameter that may be
NULL.
- @param Ecx Pointer to the 32-bit ECX value returned by the CPUID
+ @param Ecx The pointer to the 32-bit ECX value returned by the CPUID
instruction. This is an optional parameter that may be
NULL.
- @param Edx Pointer to the 32-bit EDX value returned by the CPUID
+ @param Edx The pointer to the 32-bit EDX value returned by the CPUID
instruction. This is an optional parameter that may be
NULL.
- @return Index
+ @return Index.
**/
UINT32
@@ -5257,6 +7031,34 @@ AsmCpuidEx (
);
+/**
+ Set CD bit and clear NW bit of CR0 followed by a WBINVD.
+
+ Disables the caches by setting the CD bit of CR0 to 1, clearing the NW bit of CR0 to 0,
+ and executing a WBINVD instruction. This function is only available on IA-32 and x64.
+
+**/
+VOID
+EFIAPI
+AsmDisableCache (
+ VOID
+ );
+
+
+/**
+ Perform a WBINVD and clear both the CD and NW bits of CR0.
+
+ Enables the caches by executing a WBINVD instruction and then clear both the CD and NW
+ bits of CR0 to 0. This function is only available on IA-32 and x64.
+
+**/
+VOID
+EFIAPI
+AsmEnableCache (
+ VOID
+ );
+
+
/**
Returns the lower 32-bits of a Machine Specific Register(MSR).
@@ -5264,7 +7066,7 @@ AsmCpuidEx (
No parameter checking is performed on Index, and some Index values may cause
CPU exceptions. The caller must either guarantee that Index is valid, or the
caller must set up exception handlers to catch the exceptions. This function
- is only available on IA-32 and X64.
+ is only available on IA-32 and x64.
@param Index The 32-bit MSR index to read.
@@ -5279,14 +7081,15 @@ AsmReadMsr32 (
/**
- Zero-extend a 32-bit value and writes it to a Machine Specific Register(MSR).
+ Writes a 32-bit value to a Machine Specific Register(MSR), and returns the value.
+ The upper 32-bits of the MSR are set to zero.
Writes the 32-bit value specified by Value to the MSR specified by Index. The
upper 32-bits of the MSR write are set to zero. The 32-bit value written to
the MSR is returned. No parameter checking is performed on Index or Value,
and some of these may cause CPU exceptions. The caller must either guarantee
that Index and Value are valid, or the caller must establish proper exception
- handlers. This function is only available on IA-32 and X64.
+ handlers. This function is only available on IA-32 and x64.
@param Index The 32-bit MSR index to write.
@param Value The 32-bit value to write to the MSR.
@@ -5303,17 +7106,17 @@ AsmWriteMsr32 (
/**
- Reads a 64-bit MSR, performs a bitwise inclusive OR on the lower 32-bits, and
+ Reads a 64-bit MSR, performs a bitwise OR on the lower 32-bits, and
writes the result back to the 64-bit MSR.
- Reads the 64-bit MSR specified by Index, performs a bitwise inclusive OR
+ Reads the 64-bit MSR specified by Index, performs a bitwise OR
between the lower 32-bits of the read result and the value specified by
OrData, and writes the result to the 64-bit MSR specified by Index. The lower
32-bits of the value written to the MSR is returned. No parameter checking is
performed on Index or OrData, and some of these may cause CPU exceptions. The
caller must either guarantee that Index and OrData are valid, or the caller
must establish proper exception handlers. This function is only available on
- IA-32 and X64.
+ IA-32 and x64.
@param Index The 32-bit MSR index to write.
@param OrData The value to OR with the read value from the MSR.
@@ -5340,7 +7143,7 @@ AsmMsrOr32 (
on Index or AndData, and some of these may cause CPU exceptions. The caller
must either guarantee that Index and AndData are valid, or the caller must
establish proper exception handlers. This function is only available on IA-32
- and X64.
+ and x64.
@param Index The 32-bit MSR index to write.
@param AndData The value to AND with the read value from the MSR.
@@ -5357,19 +7160,19 @@ AsmMsrAnd32 (
/**
- Reads a 64-bit MSR, performs a bitwise AND followed by a bitwise inclusive OR
+ Reads a 64-bit MSR, performs a bitwise AND followed by a bitwise OR
on the lower 32-bits, and writes the result back to the 64-bit MSR.
Reads the 64-bit MSR specified by Index, performs a bitwise AND between the
lower 32-bits of the read result and the value specified by AndData
- preserving the upper 32-bits, performs a bitwise inclusive OR between the
+ preserving the upper 32-bits, performs a bitwise OR between the
result of the AND operation and the value specified by OrData, and writes the
result to the 64-bit MSR specified by Address. The lower 32-bits of the value
written to the MSR is returned. No parameter checking is performed on Index,
AndData, or OrData, and some of these may cause CPU exceptions. The caller
must either guarantee that Index, AndData, and OrData are valid, or the
caller must establish proper exception handlers. This function is only
- available on IA-32 and X64.
+ available on IA-32 and x64.
@param Index The 32-bit MSR index to write.
@param AndData The value to AND with the read value from the MSR.
@@ -5394,7 +7197,7 @@ AsmMsrAndThenOr32 (
specified by the StartBit and the EndBit. The value of the bit field is
returned. The caller must either guarantee that Index is valid, or the caller
must set up exception handlers to catch the exceptions. This function is only
- available on IA-32 and X64.
+ available on IA-32 and x64.
If StartBit is greater than 31, then ASSERT().
If EndBit is greater than 31, then ASSERT().
@@ -5421,17 +7224,17 @@ AsmMsrBitFieldRead32 (
/**
Writes a bit field to an MSR.
- Writes Value to a bit field in the lower 32-bits of a 64-bit MSR. The bit
+ Writes Value to a bit field in the lower 32-bits of a 64-bit MSR. The bit
field is specified by the StartBit and the EndBit. All other bits in the
destination MSR are preserved. The lower 32-bits of the MSR written is
- returned. Extra left bits in Value are stripped. The caller must either
- guarantee that Index and the data written is valid, or the caller must set up
- exception handlers to catch the exceptions. This function is only available
- on IA-32 and X64.
+ returned. The caller must either guarantee that Index and the data written
+ is valid, or the caller must set up exception handlers to catch the exceptions.
+ This function is only available on IA-32 and x64.
If StartBit is greater than 31, then ASSERT().
If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
+ If Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
@param Index The 32-bit MSR index to write.
@param StartBit The ordinal of the least significant bit in the bit field.
@@ -5457,17 +7260,18 @@ AsmMsrBitFieldWrite32 (
Reads a bit field in a 64-bit MSR, performs a bitwise OR, and writes the
result back to the bit field in the 64-bit MSR.
- Reads the 64-bit MSR specified by Index, performs a bitwise inclusive OR
+ Reads the 64-bit MSR specified by Index, performs a bitwise OR
between the read result and the value specified by OrData, and writes the
result to the 64-bit MSR specified by Index. The lower 32-bits of the value
written to the MSR are returned. Extra left bits in OrData are stripped. The
caller must either guarantee that Index and the data written is valid, or
the caller must set up exception handlers to catch the exceptions. This
- function is only available on IA-32 and X64.
+ function is only available on IA-32 and x64.
If StartBit is greater than 31, then ASSERT().
If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
+ If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
@param Index The 32-bit MSR index to write.
@param StartBit The ordinal of the least significant bit in the bit field.
@@ -5499,11 +7303,12 @@ AsmMsrBitFieldOr32 (
MSR are returned. Extra left bits in AndData are stripped. The caller must
either guarantee that Index and the data written is valid, or the caller must
set up exception handlers to catch the exceptions. This function is only
- available on IA-32 and X64.
+ available on IA-32 and x64.
If StartBit is greater than 31, then ASSERT().
If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
+ If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
@param Index The 32-bit MSR index to write.
@param StartBit The ordinal of the least significant bit in the bit field.
@@ -5527,21 +7332,23 @@ AsmMsrBitFieldAnd32 (
/**
Reads a bit field in a 64-bit MSR, performs a bitwise AND followed by a
- bitwise inclusive OR, and writes the result back to the bit field in the
+ bitwise OR, and writes the result back to the bit field in the
64-bit MSR.
Reads the 64-bit MSR specified by Index, performs a bitwise AND followed by a
- bitwise inclusive OR between the read result and the value specified by
+ bitwise OR between the read result and the value specified by
AndData, and writes the result to the 64-bit MSR specified by Index. The
lower 32-bits of the value written to the MSR are returned. Extra left bits
in both AndData and OrData are stripped. The caller must either guarantee
that Index and the data written is valid, or the caller must set up exception
handlers to catch the exceptions. This function is only available on IA-32
- and X64.
+ and x64.
If StartBit is greater than 31, then ASSERT().
If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
+ If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
+ If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
@param Index The 32-bit MSR index to write.
@param StartBit The ordinal of the least significant bit in the bit field.
@@ -5572,7 +7379,7 @@ AsmMsrBitFieldAndThenOr32 (
performed on Index, and some Index values may cause CPU exceptions. The
caller must either guarantee that Index is valid, or the caller must set up
exception handlers to catch the exceptions. This function is only available
- on IA-32 and X64.
+ on IA-32 and x64.
@param Index The 32-bit MSR index to read.
@@ -5595,7 +7402,7 @@ AsmReadMsr64 (
performed on Index or Value, and some of these may cause CPU exceptions. The
caller must either guarantee that Index and Value are valid, or the caller
must establish proper exception handlers. This function is only available on
- IA-32 and X64.
+ IA-32 and x64.
@param Index The 32-bit MSR index to write.
@param Value The 64-bit value to write to the MSR.
@@ -5612,16 +7419,16 @@ AsmWriteMsr64 (
/**
- Reads a 64-bit MSR, performs a bitwise inclusive OR, and writes the result
+ Reads a 64-bit MSR, performs a bitwise OR, and writes the result
back to the 64-bit MSR.
- Reads the 64-bit MSR specified by Index, performs a bitwise inclusive OR
+ Reads the 64-bit MSR specified by Index, performs a bitwise OR
between the read result and the value specified by OrData, and writes the
result to the 64-bit MSR specified by Index. The value written to the MSR is
returned. No parameter checking is performed on Index or OrData, and some of
these may cause CPU exceptions. The caller must either guarantee that Index
and OrData are valid, or the caller must establish proper exception handlers.
- This function is only available on IA-32 and X64.
+ This function is only available on IA-32 and x64.
@param Index The 32-bit MSR index to write.
@param OrData The value to OR with the read value from the MSR.
@@ -5647,7 +7454,7 @@ AsmMsrOr64 (
parameter checking is performed on Index or OrData, and some of these may
cause CPU exceptions. The caller must either guarantee that Index and OrData
are valid, or the caller must establish proper exception handlers. This
- function is only available on IA-32 and X64.
+ function is only available on IA-32 and x64.
@param Index The 32-bit MSR index to write.
@param AndData The value to AND with the read value from the MSR.
@@ -5664,18 +7471,18 @@ AsmMsrAnd64 (
/**
- Reads a 64-bit MSR, performs a bitwise AND followed by a bitwise inclusive
+ Reads a 64-bit MSR, performs a bitwise AND followed by a bitwise
OR, and writes the result back to the 64-bit MSR.
Reads the 64-bit MSR specified by Index, performs a bitwise AND between read
- result and the value specified by AndData, performs a bitwise inclusive OR
+ result and the value specified by AndData, performs a bitwise OR
between the result of the AND operation and the value specified by OrData,
and writes the result to the 64-bit MSR specified by Index. The value written
to the MSR is returned. No parameter checking is performed on Index, AndData,
or OrData, and some of these may cause CPU exceptions. The caller must either
guarantee that Index, AndData, and OrData are valid, or the caller must
establish proper exception handlers. This function is only available on IA-32
- and X64.
+ and x64.
@param Index The 32-bit MSR index to write.
@param AndData The value to AND with the read value from the MSR.
@@ -5700,7 +7507,7 @@ AsmMsrAndThenOr64 (
StartBit and the EndBit. The value of the bit field is returned. The caller
must either guarantee that Index is valid, or the caller must set up
exception handlers to catch the exceptions. This function is only available
- on IA-32 and X64.
+ on IA-32 and x64.
If StartBit is greater than 63, then ASSERT().
If EndBit is greater than 63, then ASSERT().
@@ -5729,14 +7536,14 @@ AsmMsrBitFieldRead64 (
Writes Value to a bit field in a 64-bit MSR. The bit field is specified by
the StartBit and the EndBit. All other bits in the destination MSR are
- preserved. The MSR written is returned. Extra left bits in Value are
- stripped. The caller must either guarantee that Index and the data written is
- valid, or the caller must set up exception handlers to catch the exceptions.
- This function is only available on IA-32 and X64.
+ preserved. The MSR written is returned. The caller must either guarantee
+ that Index and the data written is valid, or the caller must set up exception
+ handlers to catch the exceptions. This function is only available on IA-32 and x64.
If StartBit is greater than 63, then ASSERT().
If EndBit is greater than 63, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
+ If Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
@param Index The 32-bit MSR index to write.
@param StartBit The ordinal of the least significant bit in the bit field.
@@ -5759,20 +7566,21 @@ AsmMsrBitFieldWrite64 (
/**
- Reads a bit field in a 64-bit MSR, performs a bitwise inclusive OR, and
+ Reads a bit field in a 64-bit MSR, performs a bitwise OR, and
writes the result back to the bit field in the 64-bit MSR.
- Reads the 64-bit MSR specified by Index, performs a bitwise inclusive OR
+ Reads the 64-bit MSR specified by Index, performs a bitwise OR
between the read result and the value specified by OrData, and writes the
result to the 64-bit MSR specified by Index. The value written to the MSR is
returned. Extra left bits in OrData are stripped. The caller must either
guarantee that Index and the data written is valid, or the caller must set up
exception handlers to catch the exceptions. This function is only available
- on IA-32 and X64.
+ on IA-32 and x64.
If StartBit is greater than 63, then ASSERT().
If EndBit is greater than 63, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
+ If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
@param Index The 32-bit MSR index to write.
@param StartBit The ordinal of the least significant bit in the bit field.
@@ -5804,11 +7612,12 @@ AsmMsrBitFieldOr64 (
Extra left bits in AndData are stripped. The caller must either guarantee
that Index and the data written is valid, or the caller must set up exception
handlers to catch the exceptions. This function is only available on IA-32
- and X64.
+ and x64.
If StartBit is greater than 63, then ASSERT().
If EndBit is greater than 63, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
+ If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
@param Index The 32-bit MSR index to write.
@param StartBit The ordinal of the least significant bit in the bit field.
@@ -5832,20 +7641,22 @@ AsmMsrBitFieldAnd64 (
/**
Reads a bit field in a 64-bit MSR, performs a bitwise AND followed by a
- bitwise inclusive OR, and writes the result back to the bit field in the
+ bitwise OR, and writes the result back to the bit field in the
64-bit MSR.
Reads the 64-bit MSR specified by Index, performs a bitwise AND followed by
- a bitwise inclusive OR between the read result and the value specified by
+ a bitwise OR between the read result and the value specified by
AndData, and writes the result to the 64-bit MSR specified by Index. The
value written to the MSR is returned. Extra left bits in both AndData and
OrData are stripped. The caller must either guarantee that Index and the data
written is valid, or the caller must set up exception handlers to catch the
- exceptions. This function is only available on IA-32 and X64.
+ exceptions. This function is only available on IA-32 and x64.
If StartBit is greater than 63, then ASSERT().
If EndBit is greater than 63, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
+ If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
+ If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().
@param Index The 32-bit MSR index to write.
@param StartBit The ordinal of the least significant bit in the bit field.
@@ -5873,10 +7684,10 @@ AsmMsrBitFieldAndThenOr64 (
Reads the current value of the EFLAGS register.
Reads and returns the current value of the EFLAGS register. This function is
- only available on IA-32 and X64. This returns a 32-bit value on IA-32 and a
- 64-bit value on X64.
+ only available on IA-32 and x64. This returns a 32-bit value on IA-32 and a
+ 64-bit value on x64.
- @return EFLAGS on IA-32 or RFLAGS on X64.
+ @return EFLAGS on IA-32 or RFLAGS on x64.
**/
UINTN
@@ -5890,8 +7701,8 @@ AsmReadEflags (
Reads the current value of the Control Register 0 (CR0).
Reads and returns the current value of CR0. This function is only available
- on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
- X64.
+ on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
+ x64.
@return The value of the Control Register 0 (CR0).
@@ -5907,8 +7718,8 @@ AsmReadCr0 (
Reads the current value of the Control Register 2 (CR2).
Reads and returns the current value of CR2. This function is only available
- on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
- X64.
+ on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
+ x64.
@return The value of the Control Register 2 (CR2).
@@ -5924,8 +7735,8 @@ AsmReadCr2 (
Reads the current value of the Control Register 3 (CR3).
Reads and returns the current value of CR3. This function is only available
- on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
- X64.
+ on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
+ x64.
@return The value of the Control Register 3 (CR3).
@@ -5941,8 +7752,8 @@ AsmReadCr3 (
Reads the current value of the Control Register 4 (CR4).
Reads and returns the current value of CR4. This function is only available
- on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
- X64.
+ on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
+ x64.
@return The value of the Control Register 4 (CR4).
@@ -5958,7 +7769,7 @@ AsmReadCr4 (
Writes a value to Control Register 0 (CR0).
Writes and returns a new value to CR0. This function is only available on
- IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
+ IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
@param Cr0 The value to write to CR0.
@@ -5976,7 +7787,7 @@ AsmWriteCr0 (
Writes a value to Control Register 2 (CR2).
Writes and returns a new value to CR2. This function is only available on
- IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
+ IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
@param Cr2 The value to write to CR2.
@@ -5994,7 +7805,7 @@ AsmWriteCr2 (
Writes a value to Control Register 3 (CR3).
Writes and returns a new value to CR3. This function is only available on
- IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
+ IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
@param Cr3 The value to write to CR3.
@@ -6012,7 +7823,7 @@ AsmWriteCr3 (
Writes a value to Control Register 4 (CR4).
Writes and returns a new value to CR4. This function is only available on
- IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
+ IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
@param Cr4 The value to write to CR4.
@@ -6030,8 +7841,8 @@ AsmWriteCr4 (
Reads the current value of Debug Register 0 (DR0).
Reads and returns the current value of DR0. This function is only available
- on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
- X64.
+ on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
+ x64.
@return The value of Debug Register 0 (DR0).
@@ -6047,8 +7858,8 @@ AsmReadDr0 (
Reads the current value of Debug Register 1 (DR1).
Reads and returns the current value of DR1. This function is only available
- on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
- X64.
+ on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
+ x64.
@return The value of Debug Register 1 (DR1).
@@ -6064,8 +7875,8 @@ AsmReadDr1 (
Reads the current value of Debug Register 2 (DR2).
Reads and returns the current value of DR2. This function is only available
- on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
- X64.
+ on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
+ x64.
@return The value of Debug Register 2 (DR2).
@@ -6081,8 +7892,8 @@ AsmReadDr2 (
Reads the current value of Debug Register 3 (DR3).
Reads and returns the current value of DR3. This function is only available
- on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
- X64.
+ on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
+ x64.
@return The value of Debug Register 3 (DR3).
@@ -6098,8 +7909,8 @@ AsmReadDr3 (
Reads the current value of Debug Register 4 (DR4).
Reads and returns the current value of DR4. This function is only available
- on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
- X64.
+ on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
+ x64.
@return The value of Debug Register 4 (DR4).
@@ -6115,8 +7926,8 @@ AsmReadDr4 (
Reads the current value of Debug Register 5 (DR5).
Reads and returns the current value of DR5. This function is only available
- on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
- X64.
+ on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
+ x64.
@return The value of Debug Register 5 (DR5).
@@ -6132,8 +7943,8 @@ AsmReadDr5 (
Reads the current value of Debug Register 6 (DR6).
Reads and returns the current value of DR6. This function is only available
- on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
- X64.
+ on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
+ x64.
@return The value of Debug Register 6 (DR6).
@@ -6149,8 +7960,8 @@ AsmReadDr6 (
Reads the current value of Debug Register 7 (DR7).
Reads and returns the current value of DR7. This function is only available
- on IA-32 and X64. This returns a 32-bit value on IA-32 and a 64-bit value on
- X64.
+ on IA-32 and x64. This returns a 32-bit value on IA-32 and a 64-bit value on
+ x64.
@return The value of Debug Register 7 (DR7).
@@ -6166,7 +7977,7 @@ AsmReadDr7 (
Writes a value to Debug Register 0 (DR0).
Writes and returns a new value to DR0. This function is only available on
- IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
+ IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
@param Dr0 The value to write to Dr0.
@@ -6184,7 +7995,7 @@ AsmWriteDr0 (
Writes a value to Debug Register 1 (DR1).
Writes and returns a new value to DR1. This function is only available on
- IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
+ IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
@param Dr1 The value to write to Dr1.
@@ -6202,7 +8013,7 @@ AsmWriteDr1 (
Writes a value to Debug Register 2 (DR2).
Writes and returns a new value to DR2. This function is only available on
- IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
+ IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
@param Dr2 The value to write to Dr2.
@@ -6220,7 +8031,7 @@ AsmWriteDr2 (
Writes a value to Debug Register 3 (DR3).
Writes and returns a new value to DR3. This function is only available on
- IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
+ IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
@param Dr3 The value to write to Dr3.
@@ -6238,7 +8049,7 @@ AsmWriteDr3 (
Writes a value to Debug Register 4 (DR4).
Writes and returns a new value to DR4. This function is only available on
- IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
+ IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
@param Dr4 The value to write to Dr4.
@@ -6256,7 +8067,7 @@ AsmWriteDr4 (
Writes a value to Debug Register 5 (DR5).
Writes and returns a new value to DR5. This function is only available on
- IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
+ IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
@param Dr5 The value to write to Dr5.
@@ -6274,7 +8085,7 @@ AsmWriteDr5 (
Writes a value to Debug Register 6 (DR6).
Writes and returns a new value to DR6. This function is only available on
- IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
+ IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
@param Dr6 The value to write to Dr6.
@@ -6292,7 +8103,7 @@ AsmWriteDr6 (
Writes a value to Debug Register 7 (DR7).
Writes and returns a new value to DR7. This function is only available on
- IA-32 and X64. This writes a 32-bit value on IA-32 and a 64-bit value on X64.
+ IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.
@param Dr7 The value to write to Dr7.
@@ -6310,7 +8121,7 @@ AsmWriteDr7 (
Reads the current value of Code Segment Register (CS).
Reads and returns the current value of CS. This function is only available on
- IA-32 and X64.
+ IA-32 and x64.
@return The current value of CS.
@@ -6326,7 +8137,7 @@ AsmReadCs (
Reads the current value of Data Segment Register (DS).
Reads and returns the current value of DS. This function is only available on
- IA-32 and X64.
+ IA-32 and x64.
@return The current value of DS.
@@ -6342,7 +8153,7 @@ AsmReadDs (
Reads the current value of Extra Segment Register (ES).
Reads and returns the current value of ES. This function is only available on
- IA-32 and X64.
+ IA-32 and x64.
@return The current value of ES.
@@ -6358,7 +8169,7 @@ AsmReadEs (
Reads the current value of FS Data Segment Register (FS).
Reads and returns the current value of FS. This function is only available on
- IA-32 and X64.
+ IA-32 and x64.
@return The current value of FS.
@@ -6374,7 +8185,7 @@ AsmReadFs (
Reads the current value of GS Data Segment Register (GS).
Reads and returns the current value of GS. This function is only available on
- IA-32 and X64.
+ IA-32 and x64.
@return The current value of GS.
@@ -6390,7 +8201,7 @@ AsmReadGs (
Reads the current value of Stack Segment Register (SS).
Reads and returns the current value of SS. This function is only available on
- IA-32 and X64.
+ IA-32 and x64.
@return The current value of SS.
@@ -6406,7 +8217,7 @@ AsmReadSs (
Reads the current value of Task Register (TR).
Reads and returns the current value of TR. This function is only available on
- IA-32 and X64.
+ IA-32 and x64.
@return The current value of TR.
@@ -6422,11 +8233,11 @@ AsmReadTr (
Reads the current Global Descriptor Table Register(GDTR) descriptor.
Reads and returns the current GDTR descriptor and returns it in Gdtr. This
- function is only available on IA-32 and X64.
+ function is only available on IA-32 and x64.
If Gdtr is NULL, then ASSERT().
- @param Gdtr Pointer to a GDTR descriptor.
+ @param Gdtr The pointer to a GDTR descriptor.
**/
VOID
@@ -6440,11 +8251,11 @@ AsmReadGdtr (
Writes the current Global Descriptor Table Register (GDTR) descriptor.
Writes and the current GDTR descriptor specified by Gdtr. This function is
- only available on IA-32 and X64.
+ only available on IA-32 and x64.
If Gdtr is NULL, then ASSERT().
- @param Gdtr Pointer to a GDTR descriptor.
+ @param Gdtr The pointer to a GDTR descriptor.
**/
VOID
@@ -6455,14 +8266,14 @@ AsmWriteGdtr (
/**
- Reads the current Interrupt Descriptor Table Register(GDTR) descriptor.
+ Reads the current Interrupt Descriptor Table Register(IDTR) descriptor.
Reads and returns the current IDTR descriptor and returns it in Idtr. This
- function is only available on IA-32 and X64.
+ function is only available on IA-32 and x64.
If Idtr is NULL, then ASSERT().
- @param Idtr Pointer to a IDTR descriptor.
+ @param Idtr The pointer to a IDTR descriptor.
**/
VOID
@@ -6473,14 +8284,14 @@ AsmReadIdtr (
/**
- Writes the current Interrupt Descriptor Table Register(GDTR) descriptor.
+ Writes the current Interrupt Descriptor Table Register(IDTR) descriptor.
Writes the current IDTR descriptor and returns it in Idtr. This function is
- only available on IA-32 and X64.
+ only available on IA-32 and x64.
If Idtr is NULL, then ASSERT().
- @param Idtr Pointer to a IDTR descriptor.
+ @param Idtr The pointer to a IDTR descriptor.
**/
VOID
@@ -6494,7 +8305,7 @@ AsmWriteIdtr (
Reads the current Local Descriptor Table Register(LDTR) selector.
Reads and returns the current 16-bit LDTR descriptor value. This function is
- only available on IA-32 and X64.
+ only available on IA-32 and x64.
@return The current selector of LDT.
@@ -6507,10 +8318,10 @@ AsmReadLdtr (
/**
- Writes the current Local Descriptor Table Register (GDTR) selector.
+ Writes the current Local Descriptor Table Register (LDTR) selector.
Writes and the current LDTR descriptor specified by Ldtr. This function is
- only available on IA-32 and X64.
+ only available on IA-32 and x64.
@param Ldtr 16-bit LDTR selector value.
@@ -6527,12 +8338,12 @@ AsmWriteLdtr (
Saves the current floating point/SSE/SSE2 state to the buffer specified by
Buffer. Buffer must be aligned on a 16-byte boundary. This function is only
- available on IA-32 and X64.
+ available on IA-32 and x64.
If Buffer is NULL, then ASSERT().
If Buffer is not aligned on a 16-byte boundary, then ASSERT().
- @param Buffer Pointer to a buffer to save the floating point/SSE/SSE2 context.
+ @param Buffer The pointer to a buffer to save the floating point/SSE/SSE2 context.
**/
VOID
@@ -6547,13 +8358,13 @@ AsmFxSave (
Restores the current floating point/SSE/SSE2 state from the buffer specified
by Buffer. Buffer must be aligned on a 16-byte boundary. This function is
- only available on IA-32 and X64.
+ only available on IA-32 and x64.
If Buffer is NULL, then ASSERT().
If Buffer is not aligned on a 16-byte boundary, then ASSERT().
If Buffer was not saved with AsmFxSave(), then ASSERT().
- @param Buffer Pointer to a buffer to save the floating point/SSE/SSE2 context.
+ @param Buffer The pointer to a buffer to save the floating point/SSE/SSE2 context.
**/
VOID
@@ -6567,7 +8378,7 @@ AsmFxRestore (
Reads the current value of 64-bit MMX Register #0 (MM0).
Reads and returns the current value of MM0. This function is only available
- on IA-32 and X64.
+ on IA-32 and x64.
@return The current value of MM0.
@@ -6583,7 +8394,7 @@ AsmReadMm0 (
Reads the current value of 64-bit MMX Register #1 (MM1).
Reads and returns the current value of MM1. This function is only available
- on IA-32 and X64.
+ on IA-32 and x64.
@return The current value of MM1.
@@ -6599,7 +8410,7 @@ AsmReadMm1 (
Reads the current value of 64-bit MMX Register #2 (MM2).
Reads and returns the current value of MM2. This function is only available
- on IA-32 and X64.
+ on IA-32 and x64.
@return The current value of MM2.
@@ -6615,7 +8426,7 @@ AsmReadMm2 (
Reads the current value of 64-bit MMX Register #3 (MM3).
Reads and returns the current value of MM3. This function is only available
- on IA-32 and X64.
+ on IA-32 and x64.
@return The current value of MM3.
@@ -6631,7 +8442,7 @@ AsmReadMm3 (
Reads the current value of 64-bit MMX Register #4 (MM4).
Reads and returns the current value of MM4. This function is only available
- on IA-32 and X64.
+ on IA-32 and x64.
@return The current value of MM4.
@@ -6647,7 +8458,7 @@ AsmReadMm4 (
Reads the current value of 64-bit MMX Register #5 (MM5).
Reads and returns the current value of MM5. This function is only available
- on IA-32 and X64.
+ on IA-32 and x64.
@return The current value of MM5.
@@ -6663,7 +8474,7 @@ AsmReadMm5 (
Reads the current value of 64-bit MMX Register #6 (MM6).
Reads and returns the current value of MM6. This function is only available
- on IA-32 and X64.
+ on IA-32 and x64.
@return The current value of MM6.
@@ -6679,7 +8490,7 @@ AsmReadMm6 (
Reads the current value of 64-bit MMX Register #7 (MM7).
Reads and returns the current value of MM7. This function is only available
- on IA-32 and X64.
+ on IA-32 and x64.
@return The current value of MM7.
@@ -6695,7 +8506,7 @@ AsmReadMm7 (
Writes the current value of 64-bit MMX Register #0 (MM0).
Writes the current value of MM0. This function is only available on IA32 and
- X64.
+ x64.
@param Value The 64-bit value to write to MM0.
@@ -6711,7 +8522,7 @@ AsmWriteMm0 (
Writes the current value of 64-bit MMX Register #1 (MM1).
Writes the current value of MM1. This function is only available on IA32 and
- X64.
+ x64.
@param Value The 64-bit value to write to MM1.
@@ -6727,7 +8538,7 @@ AsmWriteMm1 (
Writes the current value of 64-bit MMX Register #2 (MM2).
Writes the current value of MM2. This function is only available on IA32 and
- X64.
+ x64.
@param Value The 64-bit value to write to MM2.
@@ -6743,7 +8554,7 @@ AsmWriteMm2 (
Writes the current value of 64-bit MMX Register #3 (MM3).
Writes the current value of MM3. This function is only available on IA32 and
- X64.
+ x64.
@param Value The 64-bit value to write to MM3.
@@ -6759,7 +8570,7 @@ AsmWriteMm3 (
Writes the current value of 64-bit MMX Register #4 (MM4).
Writes the current value of MM4. This function is only available on IA32 and
- X64.
+ x64.
@param Value The 64-bit value to write to MM4.
@@ -6775,7 +8586,7 @@ AsmWriteMm4 (
Writes the current value of 64-bit MMX Register #5 (MM5).
Writes the current value of MM5. This function is only available on IA32 and
- X64.
+ x64.
@param Value The 64-bit value to write to MM5.
@@ -6791,7 +8602,7 @@ AsmWriteMm5 (
Writes the current value of 64-bit MMX Register #6 (MM6).
Writes the current value of MM6. This function is only available on IA32 and
- X64.
+ x64.
@param Value The 64-bit value to write to MM6.
@@ -6807,7 +8618,7 @@ AsmWriteMm6 (
Writes the current value of 64-bit MMX Register #7 (MM7).
Writes the current value of MM7. This function is only available on IA32 and
- X64.
+ x64.
@param Value The 64-bit value to write to MM7.
@@ -6823,7 +8634,7 @@ AsmWriteMm7 (
Reads the current value of Time Stamp Counter (TSC).
Reads and returns the current value of TSC. This function is only available
- on IA-32 and X64.
+ on IA-32 and x64.
@return The current value of TSC
@@ -6839,7 +8650,7 @@ AsmReadTsc (
Reads the current value of a Performance Counter (PMC).
Reads and returns the current value of performance counter specified by
- Index. This function is only available on IA-32 and X64.
+ Index. This function is only available on IA-32 and x64.
@param Index The 32-bit Performance Counter index to read.
@@ -6857,7 +8668,7 @@ AsmReadPmc (
Sets up a monitor buffer that is used by AsmMwait().
Executes a MONITOR instruction with the register state specified by Eax, Ecx
- and Edx. Returns Eax. This function is only available on IA-32 and X64.
+ and Edx. Returns Eax. This function is only available on IA-32 and x64.
@param Eax The value to load into EAX or RAX before executing the MONITOR
instruction.
@@ -6882,7 +8693,7 @@ AsmMonitor (
Executes an MWAIT instruction.
Executes an MWAIT instruction with the register state specified by Eax and
- Ecx. Returns Eax. This function is only available on IA-32 and X64.
+ Ecx. Returns Eax. This function is only available on IA-32 and x64.
@param Eax The value to load into EAX or RAX before executing the MONITOR
instruction.
@@ -6904,7 +8715,7 @@ AsmMwait (
Executes a WBINVD instruction.
Executes a WBINVD instruction. This function is only available on IA-32 and
- X64.
+ x64.
**/
VOID
@@ -6918,7 +8729,7 @@ AsmWbinvd (
Executes a INVD instruction.
Executes a INVD instruction. This function is only available on IA-32 and
- X64.
+ x64.
**/
VOID
@@ -6933,7 +8744,7 @@ AsmInvd (
coherency domain of the CPU.
Flushed the cache line specified by LinearAddress, and returns LinearAddress.
- This function is only available on IA-32 and X64.
+ This function is only available on IA-32 and x64.
@param LinearAddress The address of the cache line to flush. If the CPU is
in a physical addressing mode, then LinearAddress is a
@@ -6941,7 +8752,7 @@ AsmInvd (
addressing mode, then LinearAddress is a virtual
address.
- @return LinearAddress
+ @return LinearAddress.
**/
VOID *
EFIAPI
@@ -7058,7 +8869,7 @@ AsmDisablePaging32 (
If EntryPoint is 0, then ASSERT().
If NewStack is 0, then ASSERT().
- @param CodeSelector The 16-bit selector to load in the CS before EntryPoint
+ @param Cs The 16-bit selector to load in the CS before EntryPoint
is called. The descriptor in the GDT that this selector
references must be setup for long mode.
@param EntryPoint The 64-bit virtual address of the function to call with
@@ -7076,7 +8887,7 @@ AsmDisablePaging32 (
VOID
EFIAPI
AsmEnablePaging64 (
- IN UINT16 CodeSelector,
+ IN UINT16 Cs,
IN UINT64 EntryPoint,
IN UINT64 Context1, OPTIONAL
IN UINT64 Context2, OPTIONAL
@@ -7089,7 +8900,7 @@ AsmEnablePaging64 (
Disables the 64-bit paging mode on the CPU and returns to 32-bit protected
mode. This function assumes the current execution mode is 64-paging mode.
- This function is only available on X64. After the 64-bit paging mode is
+ This function is only available on x64. After the 64-bit paging mode is
disabled, control is transferred to the function specified by EntryPoint
using the new stack specified by NewStack and passing in the parameters
specified by Context1 and Context2. Context1 and Context2 are optional and
@@ -7099,7 +8910,7 @@ AsmEnablePaging64 (
If EntryPoint is 0, then ASSERT().
If NewStack is 0, then ASSERT().
- @param CodeSelector The 16-bit selector to load in the CS before EntryPoint
+ @param Cs The 16-bit selector to load in the CS before EntryPoint
is called. The descriptor in the GDT that this selector
references must be setup for 32-bit protected mode.
@param EntryPoint The 64-bit virtual address of the function to call with
@@ -7117,7 +8928,7 @@ AsmEnablePaging64 (
VOID
EFIAPI
AsmDisablePaging64 (
- IN UINT16 CodeSelector,
+ IN UINT16 Cs,
IN UINT32 EntryPoint,
IN UINT32 Context1, OPTIONAL
IN UINT32 Context2, OPTIONAL
@@ -7163,6 +8974,9 @@ AsmGetThunk16Properties (
Prepares all structures and code required to use AsmThunk16().
+ This interface is limited to be used in either physical mode or virtual modes with paging enabled where the
+ virtual to physical mappings for ThunkContext.RealModeBuffer is mapped 1:1.
+
If ThunkContext is NULL, then ASSERT().
@param ThunkContext A pointer to the context structure that describes the
@@ -7172,7 +8986,7 @@ AsmGetThunk16Properties (
VOID
EFIAPI
AsmPrepareThunk16 (
- OUT THUNK_CONTEXT *ThunkContext
+ IN OUT THUNK_CONTEXT *ThunkContext
);
@@ -7180,11 +8994,50 @@ AsmPrepareThunk16 (
Transfers control to a 16-bit real mode entry point and returns the results.
Transfers control to a 16-bit real mode entry point and returns the results.
- AsmPrepareThunk16() must be called with ThunkContext before this function is
- used.
+ AsmPrepareThunk16() must be called with ThunkContext before this function is used.
+ This function must be called with interrupts disabled.
+
+ The register state from the RealModeState field of ThunkContext is restored just prior
+ to calling the 16-bit real mode entry point. This includes the EFLAGS field of RealModeState,
+ which is used to set the interrupt state when a 16-bit real mode entry point is called.
+ Control is transferred to the 16-bit real mode entry point specified by the CS and Eip fields of RealModeState.
+ The stack is initialized to the SS and ESP fields of RealModeState. Any parameters passed to
+ the 16-bit real mode code must be populated by the caller at SS:ESP prior to calling this function.
+ The 16-bit real mode entry point is invoked with a 16-bit CALL FAR instruction,
+ so when accessing stack contents, the 16-bit real mode code must account for the 16-bit segment
+ and 16-bit offset of the return address that were pushed onto the stack. The 16-bit real mode entry
+ point must exit with a RETF instruction. The register state is captured into RealModeState immediately
+ after the RETF instruction is executed.
+
+ If EFLAGS specifies interrupts enabled, or any of the 16-bit real mode code enables interrupts,
+ or any of the 16-bit real mode code makes a SW interrupt, then the caller is responsible for making sure
+ the IDT at address 0 is initialized to handle any HW or SW interrupts that may occur while in 16-bit real mode.
+
+ If EFLAGS specifies interrupts enabled, or any of the 16-bit real mode code enables interrupts,
+ then the caller is responsible for making sure the 8259 PIC is in a state compatible with 16-bit real mode.
+ This includes the base vectors, the interrupt masks, and the edge/level trigger mode.
+
+ If THUNK_ATTRIBUTE_BIG_REAL_MODE is set in the ThunkAttributes field of ThunkContext, then the user code
+ is invoked in big real mode. Otherwise, the user code is invoked in 16-bit real mode with 64KB segment limits.
+
+ If neither THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 nor THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL are set in
+ ThunkAttributes, then it is assumed that the user code did not enable the A20 mask, and no attempt is made to
+ disable the A20 mask.
+
+ If THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 is set and THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL is clear in
+ ThunkAttributes, then attempt to use the INT 15 service to disable the A20 mask. If this INT 15 call fails,
+ then attempt to disable the A20 mask by directly accessing the 8042 keyboard controller I/O ports.
+
+ If THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 is clear and THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL is set in
+ ThunkAttributes, then attempt to disable the A20 mask by directly accessing the 8042 keyboard controller I/O ports.
If ThunkContext is NULL, then ASSERT().
If AsmPrepareThunk16() was not previously called with ThunkContext, then ASSERT().
+ If both THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15 and THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL are set in
+ ThunkAttributes, then ASSERT().
+
+ This interface is limited to be used in either physical mode or virtual modes with paging enabled where the
+ virtual to physical mappings for ThunkContext.RealModeBuffer are mapped 1:1.
@param ThunkContext A pointer to the context structure that describes the
16-bit real mode code to call.
@@ -7208,7 +9061,10 @@ AsmThunk16 (
real mode thunk, then it is more efficient if AsmPrepareThunk16() is called
once and AsmThunk16() can be called for each 16-bit real mode thunk.
- If ThunkContext is NULL, then ASSERT().
+ This interface is limited to be used in either physical mode or virtual modes with paging enabled where the
+ virtual to physical mappings for ThunkContext.RealModeBuffer is mapped 1:1.
+
+ See AsmPrepareThunk16() and AsmThunk16() for the detailed description and ASSERT() conditions.
@param ThunkContext A pointer to the context structure that describes the
16-bit real mode code to call.
@@ -7220,7 +9076,109 @@ AsmPrepareAndThunk16 (
IN OUT THUNK_CONTEXT *ThunkContext
);
-#endif
-#endif
+/**
+ Generates a 16-bit random number through RDRAND instruction.
+
+ if Rand is NULL, then ASSERT().
+
+ @param[out] Rand Buffer pointer to store the random result.
+
+ @retval TRUE RDRAND call was successful.
+ @retval FALSE Failed attempts to call RDRAND.
+
+ **/
+BOOLEAN
+EFIAPI
+AsmRdRand16 (
+ OUT UINT16 *Rand
+ );
+
+/**
+ Generates a 32-bit random number through RDRAND instruction.
+
+ if Rand is NULL, then ASSERT().
+
+ @param[out] Rand Buffer pointer to store the random result.
+
+ @retval TRUE RDRAND call was successful.
+ @retval FALSE Failed attempts to call RDRAND.
+
+**/
+BOOLEAN
+EFIAPI
+AsmRdRand32 (
+ OUT UINT32 *Rand
+ );
+
+/**
+ Generates a 64-bit random number through RDRAND instruction.
+
+ if Rand is NULL, then ASSERT().
+
+ @param[out] Rand Buffer pointer to store the random result.
+
+ @retval TRUE RDRAND call was successful.
+ @retval FALSE Failed attempts to call RDRAND.
+
+**/
+BOOLEAN
+EFIAPI
+AsmRdRand64 (
+ OUT UINT64 *Rand
+ );
+
+/**
+ Load given selector into TR register.
+
+ @param[in] Selector Task segment selector
+**/
+VOID
+EFIAPI
+AsmWriteTr (
+ IN UINT16 Selector
+ );
+
+/**
+ Patch the immediate operand of an IA32 or X64 instruction such that the byte,
+ word, dword or qword operand is encoded at the end of the instruction's
+ binary representation.
+
+ This function should be used to update object code that was compiled with
+ NASM from assembly source code. Example:
+
+ NASM source code:
+
+ mov eax, strict dword 0 ; the imm32 zero operand will be patched
+ ASM_PFX(gPatchCr3):
+ mov cr3, eax
+ C source code:
+
+ X86_ASSEMBLY_PATCH_LABEL gPatchCr3;
+ PatchInstructionX86 (gPatchCr3, AsmReadCr3 (), 4);
+
+ @param[out] InstructionEnd Pointer right past the instruction to patch. The
+ immediate operand to patch is expected to
+ comprise the trailing bytes of the instruction.
+ If InstructionEnd is closer to address 0 than
+ ValueSize permits, then ASSERT().
+
+ @param[in] PatchValue The constant to write to the immediate operand.
+ The caller is responsible for ensuring that
+ PatchValue can be represented in the byte, word,
+ dword or qword operand (as indicated through
+ ValueSize); otherwise ASSERT().
+
+ @param[in] ValueSize The size of the operand in bytes; must be 1, 2,
+ 4, or 8. ASSERT() otherwise.
+**/
+VOID
+EFIAPI
+PatchInstructionX86 (
+ OUT X86_ASSEMBLY_PATCH_LABEL *InstructionEnd,
+ IN UINT64 PatchValue,
+ IN UINTN ValueSize
+ );
+#endif // defined (MDE_CPU_IA32) || defined (MDE_CPU_X64)
+#endif // !defined (__BASE_LIB__)