iPXE
Defines | Typedefs | Functions
BaseLib.h File Reference

Provides string functions, linked list functions, math functions, synchronization functions, file path functions, and CPU architecture-specific functions. More...

Go to the source code of this file.

Defines

#define GUID_STRING_LENGTH   36
#define INITIALIZE_LIST_HEAD_VARIABLE(ListHead)   {&(ListHead), &(ListHead)}
 Initializes the head node of a doubly linked list that is declared as a global variable in a module.

Typedefs

typedef VOID(EFIAPISWITCH_STACK_ENTRY_POINT )(IN VOID *Context1, OPTIONAL IN VOID *Context2 OPTIONAL)
 Function entry point used when a stack switch is requested with SwitchStack()

Functions

 FILE_LICENCE (BSD3)
UINTN EFIAPI StrnLenS (IN CONST CHAR16 *String, IN UINTN MaxSize)
 Returns the length of a Null-terminated Unicode string.
UINTN EFIAPI StrnSizeS (IN CONST CHAR16 *String, IN UINTN MaxSize)
 Returns the size of a Null-terminated Unicode string in bytes, including the Null terminator.
RETURN_STATUS EFIAPI StrCpyS (OUT CHAR16 *Destination, IN UINTN DestMax, IN CONST CHAR16 *Source)
 Copies the string pointed to by Source (including the terminating null char) to the array pointed to by Destination.
RETURN_STATUS EFIAPI StrnCpyS (OUT CHAR16 *Destination, IN UINTN DestMax, IN CONST CHAR16 *Source, IN UINTN Length)
 Copies not more than Length successive char from the string pointed to by Source to the array pointed to by Destination.
RETURN_STATUS EFIAPI StrCatS (IN OUT CHAR16 *Destination, IN UINTN DestMax, IN CONST CHAR16 *Source)
 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.
RETURN_STATUS EFIAPI StrnCatS (IN OUT CHAR16 *Destination, IN UINTN DestMax, IN CONST CHAR16 *Source, IN UINTN Length)
 Appends not more than Length successive char from the string pointed to by Source to the end of the string pointed to by Destination.
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 UINTN.
RETURN_STATUS EFIAPI StrDecimalToUint64S (IN CONST CHAR16 *String, OUT CHAR16 **EndPointer, OPTIONAL OUT UINT64 *Data)
 Convert a Null-terminated Unicode decimal string to a value of type UINT64.
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 UINTN.
RETURN_STATUS EFIAPI StrHexToUint64S (IN CONST CHAR16 *String, OUT CHAR16 **EndPointer, OPTIONAL OUT UINT64 *Data)
 Convert a Null-terminated Unicode hexadecimal string to a value of type UINT64.
UINTN EFIAPI AsciiStrnLenS (IN CONST CHAR8 *String, IN UINTN MaxSize)
 Returns the length of a Null-terminated Ascii string.
UINTN EFIAPI AsciiStrnSizeS (IN CONST CHAR8 *String, IN UINTN MaxSize)
 Returns the size of a Null-terminated Ascii string in bytes, including the Null terminator.
RETURN_STATUS EFIAPI AsciiStrCpyS (OUT CHAR8 *Destination, IN UINTN DestMax, IN CONST CHAR8 *Source)
 Copies the string pointed to by Source (including the terminating null char) to the array pointed to by Destination.
RETURN_STATUS EFIAPI AsciiStrnCpyS (OUT CHAR8 *Destination, IN UINTN DestMax, IN CONST CHAR8 *Source, IN UINTN Length)
 Copies not more than Length successive char from the string pointed to by Source to the array pointed to by Destination.
RETURN_STATUS EFIAPI AsciiStrCatS (IN OUT CHAR8 *Destination, IN UINTN DestMax, IN CONST CHAR8 *Source)
 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.
RETURN_STATUS EFIAPI AsciiStrnCatS (IN OUT CHAR8 *Destination, IN UINTN DestMax, IN CONST CHAR8 *Source, IN UINTN Length)
 Appends not more than Length successive char from the string pointed to by Source to the end of the string pointed to by Destination.
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 UINTN.
RETURN_STATUS EFIAPI AsciiStrDecimalToUint64S (IN CONST CHAR8 *String, OUT CHAR8 **EndPointer, OPTIONAL OUT UINT64 *Data)
 Convert a Null-terminated Ascii decimal string to a value of type UINT64.
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 UINTN.
RETURN_STATUS EFIAPI AsciiStrHexToUint64S (IN CONST CHAR8 *String, OUT CHAR8 **EndPointer, OPTIONAL OUT UINT64 *Data)
 Convert a Null-terminated Ascii hexadecimal string to a value of type UINT64.
CHAR16 *EFIAPI StrCpy (OUT CHAR16 *Destination, IN CONST CHAR16 *Source)
 [ATTENTION] This function is deprecated for security reason.
CHAR16 *EFIAPI StrnCpy (OUT CHAR16 *Destination, IN CONST CHAR16 *Source, IN UINTN Length)
 [ATTENTION] This function is deprecated for security reason.
UINTN EFIAPI StrLen (IN CONST CHAR16 *String)
 Returns the length of a Null-terminated Unicode string.
UINTN EFIAPI StrSize (IN CONST CHAR16 *String)
 Returns the size of a Null-terminated Unicode string in bytes, including the Null terminator.
INTN EFIAPI StrCmp (IN CONST CHAR16 *FirstString, IN CONST CHAR16 *SecondString)
 Compares two Null-terminated Unicode strings, and returns the difference between the first mismatched Unicode characters.
INTN EFIAPI StrnCmp (IN CONST CHAR16 *FirstString, IN CONST CHAR16 *SecondString, IN UINTN Length)
 Compares up to a specified length the contents of two Null-terminated Unicode strings, and returns the difference between the first mismatched Unicode characters.
CHAR16 *EFIAPI StrCat (IN OUT CHAR16 *Destination, IN CONST CHAR16 *Source)
 [ATTENTION] This function is deprecated for security reason.
CHAR16 *EFIAPI StrnCat (IN OUT CHAR16 *Destination, IN CONST CHAR16 *Source, IN UINTN Length)
 [ATTENTION] This function is deprecated for security reason.
CHAR16 *EFIAPI StrStr (IN CONST CHAR16 *String, IN CONST CHAR16 *SearchString)
 Returns the first occurrence of a Null-terminated Unicode sub-string in a Null-terminated Unicode string.
UINTN EFIAPI StrDecimalToUintn (IN CONST CHAR16 *String)
 Convert a Null-terminated Unicode decimal string to a value of type UINTN.
UINT64 EFIAPI StrDecimalToUint64 (IN CONST CHAR16 *String)
 Convert a Null-terminated Unicode decimal string to a value of type UINT64.
UINTN EFIAPI StrHexToUintn (IN CONST CHAR16 *String)
 Convert a Null-terminated Unicode hexadecimal string to a value of type UINTN.
UINT64 EFIAPI StrHexToUint64 (IN CONST CHAR16 *String)
 Convert a Null-terminated Unicode hexadecimal string to a value of type UINT64.
RETURN_STATUS EFIAPI StrToIpv6Address (IN CONST CHAR16 *String, OUT CHAR16 **EndPointer, OPTIONAL OUT IPv6_ADDRESS *Address, OUT UINT8 *PrefixLength OPTIONAL)
 Convert a Null-terminated Unicode string to IPv6 address and prefix length.
RETURN_STATUS EFIAPI StrToIpv4Address (IN CONST CHAR16 *String, OUT CHAR16 **EndPointer, OPTIONAL OUT IPv4_ADDRESS *Address, OUT UINT8 *PrefixLength OPTIONAL)
 Convert a Null-terminated Unicode string to IPv4 address and prefix length.
RETURN_STATUS EFIAPI StrToGuid (IN CONST CHAR16 *String, OUT GUID *Guid)
 Convert a Null-terminated Unicode GUID string to a value of type EFI_GUID.
RETURN_STATUS EFIAPI StrHexToBytes (IN CONST CHAR16 *String, IN UINTN Length, OUT UINT8 *Buffer, IN UINTN MaxBufferSize)
 Convert a Null-terminated Unicode hexadecimal string to a byte array.
CHAR8 *EFIAPI UnicodeStrToAsciiStr (IN CONST CHAR16 *Source, OUT CHAR8 *Destination)
 [ATTENTION] This function is deprecated for security reason.
RETURN_STATUS EFIAPI UnicodeStrToAsciiStrS (IN CONST CHAR16 *Source, OUT CHAR8 *Destination, IN UINTN DestMax)
 Convert a Null-terminated Unicode string to a Null-terminated ASCII string.
RETURN_STATUS EFIAPI UnicodeStrnToAsciiStrS (IN CONST CHAR16 *Source, IN UINTN Length, OUT CHAR8 *Destination, IN UINTN DestMax, OUT UINTN *DestinationLength)
 Convert not more than Length successive characters from a Null-terminated Unicode string to a Null-terminated Ascii string.
CHAR8 *EFIAPI AsciiStrCpy (OUT CHAR8 *Destination, IN CONST CHAR8 *Source)
 [ATTENTION] This function is deprecated for security reason.
CHAR8 *EFIAPI AsciiStrnCpy (OUT CHAR8 *Destination, IN CONST CHAR8 *Source, IN UINTN Length)
 [ATTENTION] This function is deprecated for security reason.
UINTN EFIAPI AsciiStrLen (IN CONST CHAR8 *String)
 Returns the length of a Null-terminated ASCII string.
UINTN EFIAPI AsciiStrSize (IN CONST CHAR8 *String)
 Returns the size of a Null-terminated ASCII string in bytes, including the Null terminator.
INTN EFIAPI AsciiStrCmp (IN CONST CHAR8 *FirstString, IN CONST CHAR8 *SecondString)
 Compares two Null-terminated ASCII strings, and returns the difference between the first mismatched ASCII characters.
INTN EFIAPI AsciiStriCmp (IN CONST CHAR8 *FirstString, IN CONST CHAR8 *SecondString)
 Performs a case insensitive comparison of two Null-terminated ASCII strings, and returns the difference between the first mismatched ASCII characters.
INTN EFIAPI AsciiStrnCmp (IN CONST CHAR8 *FirstString, IN CONST CHAR8 *SecondString, IN UINTN Length)
 Compares two Null-terminated ASCII strings with maximum lengths, and returns the difference between the first mismatched ASCII characters.
CHAR8 *EFIAPI AsciiStrCat (IN OUT CHAR8 *Destination, IN CONST CHAR8 *Source)
 [ATTENTION] This function is deprecated for security reason.
CHAR8 *EFIAPI AsciiStrnCat (IN OUT CHAR8 *Destination, IN CONST CHAR8 *Source, IN UINTN Length)
 [ATTENTION] This function is deprecated for security reason.
CHAR8 *EFIAPI AsciiStrStr (IN CONST CHAR8 *String, IN CONST CHAR8 *SearchString)
 Returns the first occurrence of a Null-terminated ASCII sub-string in a Null-terminated ASCII string.
UINTN EFIAPI AsciiStrDecimalToUintn (IN CONST CHAR8 *String)
 Convert a Null-terminated ASCII decimal string to a value of type UINTN.
UINT64 EFIAPI AsciiStrDecimalToUint64 (IN CONST CHAR8 *String)
 Convert a Null-terminated ASCII decimal string to a value of type UINT64.
UINTN EFIAPI AsciiStrHexToUintn (IN CONST CHAR8 *String)
 Convert a Null-terminated ASCII hexadecimal string to a value of type UINTN.
UINT64 EFIAPI AsciiStrHexToUint64 (IN CONST CHAR8 *String)
 Convert a Null-terminated ASCII hexadecimal string to a value of type UINT64.
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 IPv6 address and prefix length.
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 string to IPv4 address and prefix length.
RETURN_STATUS EFIAPI AsciiStrToGuid (IN CONST CHAR8 *String, OUT GUID *Guid)
 Convert a Null-terminated ASCII GUID string to a value of type EFI_GUID.
RETURN_STATUS EFIAPI AsciiStrHexToBytes (IN CONST CHAR8 *String, IN UINTN Length, OUT UINT8 *Buffer, IN UINTN MaxBufferSize)
 Convert a Null-terminated ASCII hexadecimal string to a byte array.
CHAR16 *EFIAPI AsciiStrToUnicodeStr (IN CONST CHAR8 *Source, OUT CHAR16 *Destination)
 [ATTENTION] This function is deprecated for security reason.
RETURN_STATUS EFIAPI AsciiStrToUnicodeStrS (IN CONST CHAR8 *Source, OUT CHAR16 *Destination, IN UINTN DestMax)
 Convert one Null-terminated ASCII string to a Null-terminated Unicode string.
RETURN_STATUS EFIAPI AsciiStrnToUnicodeStrS (IN CONST CHAR8 *Source, IN UINTN Length, OUT CHAR16 *Destination, IN UINTN DestMax, OUT UINTN *DestinationLength)
 Convert not more than Length successive characters from a Null-terminated Ascii string to a Null-terminated Unicode string.
UINT8 EFIAPI DecimalToBcd8 (IN UINT8 Value)
 Converts an 8-bit value to an 8-bit BCD value.
UINT8 EFIAPI BcdToDecimal8 (IN UINT8 Value)
 Converts an 8-bit BCD value to an 8-bit value.
BOOLEAN EFIAPI PathRemoveLastItem (IN OUT CHAR16 *Path)
 Removes the last directory or file entry in a path.
CHAR16 *EFIAPI PathCleanUpDirectories (IN CHAR16 *Path)
 Function to clean up paths.
LIST_ENTRY *EFIAPI InitializeListHead (IN OUT LIST_ENTRY *ListHead)
 Initializes the head node of a doubly linked list, and returns the pointer to the head node of the doubly linked list.
LIST_ENTRY *EFIAPI InsertHeadList (IN OUT LIST_ENTRY *ListHead, IN OUT LIST_ENTRY *Entry)
 Adds a node to the beginning of a doubly linked list, and returns the pointer to the head node of the doubly linked list.
LIST_ENTRY *EFIAPI InsertTailList (IN OUT LIST_ENTRY *ListHead, IN OUT LIST_ENTRY *Entry)
 Adds a node to the end of a doubly linked list, and returns the pointer to the head node of the doubly linked list.
LIST_ENTRY *EFIAPI GetFirstNode (IN CONST LIST_ENTRY *List)
 Retrieves the first node of a doubly linked list.
LIST_ENTRY *EFIAPI GetNextNode (IN CONST LIST_ENTRY *List, IN CONST LIST_ENTRY *Node)
 Retrieves the next node of a doubly linked list.
LIST_ENTRY *EFIAPI GetPreviousNode (IN CONST LIST_ENTRY *List, IN CONST LIST_ENTRY *Node)
 Retrieves the previous node of a doubly linked list.
BOOLEAN EFIAPI IsListEmpty (IN CONST LIST_ENTRY *ListHead)
 Checks to see if a doubly linked list is empty or not.
BOOLEAN EFIAPI IsNull (IN CONST LIST_ENTRY *List, IN CONST LIST_ENTRY *Node)
 Determines if a node in a doubly linked list is the head node of a the same doubly linked list.
BOOLEAN EFIAPI IsNodeAtEnd (IN CONST LIST_ENTRY *List, IN CONST LIST_ENTRY *Node)
 Determines if a node the last node in a doubly linked list.
LIST_ENTRY *EFIAPI SwapListEntries (IN OUT LIST_ENTRY *FirstEntry, IN OUT LIST_ENTRY *SecondEntry)
 Swaps the location of two nodes in a doubly linked list, and returns the first node after the swap.
LIST_ENTRY *EFIAPI RemoveEntryList (IN CONST LIST_ENTRY *Entry)
 Removes a node from a doubly linked list, and returns the node that follows the removed node.
UINT64 EFIAPI LShiftU64 (IN UINT64 Operand, IN UINTN Count)
 Shifts a 64-bit integer left between 0 and 63 bits.
UINT64 EFIAPI RShiftU64 (IN UINT64 Operand, IN UINTN Count)
 Shifts a 64-bit integer right between 0 and 63 bits.
UINT64 EFIAPI ARShiftU64 (IN UINT64 Operand, IN UINTN Count)
 Shifts a 64-bit integer right between 0 and 63 bits.
UINT32 EFIAPI LRotU32 (IN UINT32 Operand, IN UINTN Count)
 Rotates a 32-bit integer left between 0 and 31 bits, filling the low bits with the high bits that were rotated.
UINT32 EFIAPI RRotU32 (IN UINT32 Operand, IN UINTN Count)
 Rotates a 32-bit integer right between 0 and 31 bits, filling the high bits with the low bits that were rotated.
UINT64 EFIAPI LRotU64 (IN UINT64 Operand, IN UINTN Count)
 Rotates a 64-bit integer left between 0 and 63 bits, filling the low bits with the high bits that were rotated.
UINT64 EFIAPI RRotU64 (IN UINT64 Operand, IN UINTN Count)
 Rotates a 64-bit integer right between 0 and 63 bits, filling the high bits with the high low bits that were rotated.
INTN EFIAPI LowBitSet32 (IN UINT32 Operand)
 Returns the bit position of the lowest bit set in a 32-bit value.
INTN EFIAPI LowBitSet64 (IN UINT64 Operand)
 Returns the bit position of the lowest bit set in a 64-bit value.
INTN EFIAPI HighBitSet32 (IN UINT32 Operand)
 Returns the bit position of the highest bit set in a 32-bit value.
INTN EFIAPI HighBitSet64 (IN UINT64 Operand)
 Returns the bit position of the highest bit set in a 64-bit value.
UINT32 EFIAPI GetPowerOfTwo32 (IN UINT32 Operand)
 Returns the value of the highest bit set in a 32-bit value.
UINT64 EFIAPI GetPowerOfTwo64 (IN UINT64 Operand)
 Returns the value of the highest bit set in a 64-bit value.
UINT16 EFIAPI SwapBytes16 (IN UINT16 Value)
 Switches the endianness of a 16-bit integer.
UINT32 EFIAPI SwapBytes32 (IN UINT32 Value)
 Switches the endianness of a 32-bit integer.
UINT64 EFIAPI SwapBytes64 (IN UINT64 Value)
 Switches the endianness of a 64-bit integer.
UINT64 EFIAPI MultU64x32 (IN UINT64 Multiplicand, IN UINT32 Multiplier)
 Multiples a 64-bit unsigned integer by a 32-bit unsigned integer and generates a 64-bit unsigned result.
UINT64 EFIAPI MultU64x64 (IN UINT64 Multiplicand, IN UINT64 Multiplier)
 Multiples a 64-bit unsigned integer by a 64-bit unsigned integer and generates a 64-bit unsigned result.
INT64 EFIAPI MultS64x64 (IN INT64 Multiplicand, IN INT64 Multiplier)
 Multiples a 64-bit signed integer by a 64-bit signed integer and generates a 64-bit signed result.
UINT64 EFIAPI DivU64x32 (IN UINT64 Dividend, IN UINT32 Divisor)
 Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates a 64-bit unsigned result.
UINT32 EFIAPI ModU64x32 (IN UINT64 Dividend, IN UINT32 Divisor)
 Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates a 32-bit unsigned remainder.
UINT64 EFIAPI DivU64x32Remainder (IN UINT64 Dividend, IN UINT32 Divisor, OUT UINT32 *Remainder OPTIONAL)
 Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates a 64-bit unsigned result and an optional 32-bit unsigned remainder.
UINT64 EFIAPI DivU64x64Remainder (IN UINT64 Dividend, IN UINT64 Divisor, OUT UINT64 *Remainder OPTIONAL)
 Divides a 64-bit unsigned integer by a 64-bit unsigned integer and generates a 64-bit unsigned result and an optional 64-bit unsigned remainder.
INT64 EFIAPI DivS64x64Remainder (IN INT64 Dividend, IN INT64 Divisor, OUT INT64 *Remainder OPTIONAL)
 Divides a 64-bit signed integer by a 64-bit signed integer and generates a 64-bit signed result and a optional 64-bit signed remainder.
UINT16 EFIAPI ReadUnaligned16 (IN CONST UINT16 *Buffer)
 Reads a 16-bit value from memory that may be unaligned.
UINT16 EFIAPI WriteUnaligned16 (OUT UINT16 *Buffer, IN UINT16 Value)
 Writes a 16-bit value to memory that may be unaligned.
UINT32 EFIAPI ReadUnaligned24 (IN CONST UINT32 *Buffer)
 Reads a 24-bit value from memory that may be unaligned.
UINT32 EFIAPI WriteUnaligned24 (OUT UINT32 *Buffer, IN UINT32 Value)
 Writes a 24-bit value to memory that may be unaligned.
UINT32 EFIAPI ReadUnaligned32 (IN CONST UINT32 *Buffer)
 Reads a 32-bit value from memory that may be unaligned.
UINT32 EFIAPI WriteUnaligned32 (OUT UINT32 *Buffer, IN UINT32 Value)
 Writes a 32-bit value to memory that may be unaligned.
UINT64 EFIAPI ReadUnaligned64 (IN CONST UINT64 *Buffer)
 Reads a 64-bit value from memory that may be unaligned.
UINT64 EFIAPI WriteUnaligned64 (OUT UINT64 *Buffer, IN UINT64 Value)
 Writes a 64-bit value to memory that may be unaligned.
UINT8 EFIAPI BitFieldRead8 (IN UINT8 Operand, IN UINTN StartBit, IN UINTN EndBit)
 Returns a bit field from an 8-bit value.
UINT8 EFIAPI BitFieldWrite8 (IN UINT8 Operand, IN UINTN StartBit, IN UINTN EndBit, IN UINT8 Value)
 Writes a bit field to an 8-bit value, and returns the result.
UINT8 EFIAPI BitFieldOr8 (IN UINT8 Operand, IN UINTN StartBit, IN UINTN EndBit, IN UINT8 OrData)
 Reads a bit field from an 8-bit value, performs a bitwise OR, and returns the result.
UINT8 EFIAPI BitFieldAnd8 (IN UINT8 Operand, IN UINTN StartBit, IN UINTN EndBit, IN UINT8 AndData)
 Reads a bit field from an 8-bit value, performs a bitwise AND, and returns the result.
UINT8 EFIAPI BitFieldAndThenOr8 (IN UINT8 Operand, IN UINTN StartBit, IN UINTN EndBit, IN UINT8 AndData, IN UINT8 OrData)
 Reads a bit field from an 8-bit value, performs a bitwise AND followed by a bitwise OR, and returns the result.
UINT16 EFIAPI BitFieldRead16 (IN UINT16 Operand, IN UINTN StartBit, IN UINTN EndBit)
 Returns a bit field from a 16-bit value.
UINT16 EFIAPI BitFieldWrite16 (IN UINT16 Operand, IN UINTN StartBit, IN UINTN EndBit, IN UINT16 Value)
 Writes a bit field to a 16-bit value, and returns the result.
UINT16 EFIAPI BitFieldOr16 (IN UINT16 Operand, IN UINTN StartBit, IN UINTN EndBit, IN UINT16 OrData)
 Reads a bit field from a 16-bit value, performs a bitwise OR, and returns the result.
UINT16 EFIAPI BitFieldAnd16 (IN UINT16 Operand, IN UINTN StartBit, IN UINTN EndBit, IN UINT16 AndData)
 Reads a bit field from a 16-bit value, performs a bitwise AND, and returns the result.
UINT16 EFIAPI BitFieldAndThenOr16 (IN UINT16 Operand, IN UINTN StartBit, IN UINTN EndBit, IN UINT16 AndData, IN UINT16 OrData)
 Reads a bit field from a 16-bit value, performs a bitwise AND followed by a bitwise OR, and returns the result.
UINT32 EFIAPI BitFieldRead32 (IN UINT32 Operand, IN UINTN StartBit, IN UINTN EndBit)
 Returns a bit field from a 32-bit value.
UINT32 EFIAPI BitFieldWrite32 (IN UINT32 Operand, IN UINTN StartBit, IN UINTN EndBit, IN UINT32 Value)
 Writes a bit field to a 32-bit value, and returns the result.
UINT32 EFIAPI BitFieldOr32 (IN UINT32 Operand, IN UINTN StartBit, IN UINTN EndBit, IN UINT32 OrData)
 Reads a bit field from a 32-bit value, performs a bitwise OR, and returns the result.
UINT32 EFIAPI BitFieldAnd32 (IN UINT32 Operand, IN UINTN StartBit, IN UINTN EndBit, IN UINT32 AndData)
 Reads a bit field from a 32-bit value, performs a bitwise AND, and returns the result.
UINT32 EFIAPI BitFieldAndThenOr32 (IN UINT32 Operand, IN UINTN StartBit, IN UINTN EndBit, IN UINT32 AndData, IN UINT32 OrData)
 Reads a bit field from a 32-bit value, performs a bitwise AND followed by a bitwise OR, and returns the result.
UINT64 EFIAPI BitFieldRead64 (IN UINT64 Operand, IN UINTN StartBit, IN UINTN EndBit)
 Returns a bit field from a 64-bit value.
UINT64 EFIAPI BitFieldWrite64 (IN UINT64 Operand, IN UINTN StartBit, IN UINTN EndBit, IN UINT64 Value)
 Writes a bit field to a 64-bit value, and returns the result.
UINT64 EFIAPI BitFieldOr64 (IN UINT64 Operand, IN UINTN StartBit, IN UINTN EndBit, IN UINT64 OrData)
 Reads a bit field from a 64-bit value, performs a bitwise OR, and returns the result.
UINT64 EFIAPI BitFieldAnd64 (IN UINT64 Operand, IN UINTN StartBit, IN UINTN EndBit, IN UINT64 AndData)
 Reads a bit field from a 64-bit value, performs a bitwise AND, and returns the result.
UINT64 EFIAPI BitFieldAndThenOr64 (IN UINT64 Operand, IN UINTN StartBit, IN UINTN EndBit, IN UINT64 AndData, IN UINT64 OrData)
 Reads a bit field from a 64-bit value, performs a bitwise AND followed by a bitwise OR, and returns the result.
UINT8 EFIAPI CalculateSum8 (IN CONST UINT8 *Buffer, IN UINTN Length)
 Returns the sum of all elements in a buffer in unit of UINT8.
UINT8 EFIAPI CalculateCheckSum8 (IN CONST UINT8 *Buffer, IN UINTN Length)
 Returns the two's complement checksum of all elements in a buffer of 8-bit values.
UINT16 EFIAPI CalculateSum16 (IN CONST UINT16 *Buffer, IN UINTN Length)
 Returns the sum of all elements in a buffer of 16-bit values.
UINT16 EFIAPI CalculateCheckSum16 (IN CONST UINT16 *Buffer, IN UINTN Length)
 Returns the two's complement checksum of all elements in a buffer of 16-bit values.
UINT32 EFIAPI CalculateSum32 (IN CONST UINT32 *Buffer, IN UINTN Length)
 Returns the sum of all elements in a buffer of 32-bit values.
UINT32 EFIAPI CalculateCheckSum32 (IN CONST UINT32 *Buffer, IN UINTN Length)
 Returns the two's complement checksum of all elements in a buffer of 32-bit values.
UINT64 EFIAPI CalculateSum64 (IN CONST UINT64 *Buffer, IN UINTN Length)
 Returns the sum of all elements in a buffer of 64-bit values.
UINT64 EFIAPI CalculateCheckSum64 (IN CONST UINT64 *Buffer, IN UINTN Length)
 Returns the two's complement checksum of all elements in a buffer of 64-bit values.
VOID EFIAPI MemoryFence (VOID)
 Used to serialize load and store operations.
UINTN EFIAPI SetJump (OUT BASE_LIBRARY_JUMP_BUFFER *JumpBuffer)
 Saves the current CPU context that can be restored with a call to LongJump() and returns 0.
VOID EFIAPI LongJump (IN BASE_LIBRARY_JUMP_BUFFER *JumpBuffer, IN UINTN Value)
 Restores the CPU context that was saved with SetJump().
VOID EFIAPI EnableInterrupts (VOID)
 Enables CPU interrupts.
VOID EFIAPI DisableInterrupts (VOID)
 Disables CPU interrupts.
BOOLEAN EFIAPI SaveAndDisableInterrupts (VOID)
 Disables CPU interrupts and returns the interrupt state prior to the disable operation.
VOID EFIAPI EnableDisableInterrupts (VOID)
 Enables CPU interrupts for the smallest window required to capture any pending interrupts.
BOOLEAN EFIAPI GetInterruptState (VOID)
 Retrieves the current CPU interrupt state.
BOOLEAN EFIAPI SetInterruptState (IN BOOLEAN InterruptState)
 Set the current CPU interrupt state.
VOID EFIAPI CpuPause (VOID)
 Requests CPU to pause for a short period of time.
VOID EFIAPI SwitchStack (IN SWITCH_STACK_ENTRY_POINT EntryPoint, IN VOID *Context1, OPTIONAL IN VOID *Context2, OPTIONAL IN VOID *NewStack,...)
 Transfers control to a function starting with a new stack.
VOID EFIAPI CpuBreakpoint (VOID)
 Generates a breakpoint on the CPU.
VOID EFIAPI CpuDeadLoop (VOID)
 Executes an infinite loop.

Detailed Description

Provides string functions, linked list functions, math functions, synchronization functions, file path functions, and CPU architecture-specific functions.

Copyright (c) 2006 - 2017, 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.

Definition in file BaseLib.h.


Define Documentation

#define GUID_STRING_LENGTH   36

Definition at line 1666 of file BaseLib.h.

#define INITIALIZE_LIST_HEAD_VARIABLE (   ListHead)    {&(ListHead), &(ListHead)}

Initializes the head node of a doubly linked list that is declared as a global variable in a module.

Initializes the forward and backward links of a new linked list. After initializing a linked list with this macro, the other linked list functions may be used to add and remove nodes from the linked list. This macro results in smaller executables by initializing the linked list in the data section, instead if calling the InitializeListHead() function to perform the equivalent operation.

Parameters:
ListHeadThe head note of a list to initialize.

Definition at line 2870 of file BaseLib.h.


Typedef Documentation

typedef VOID(EFIAPI * SWITCH_STACK_ENTRY_POINT)(IN VOID *Context1, OPTIONAL IN VOID *Context2 OPTIONAL)

Function entry point used when a stack switch is requested with SwitchStack()

Parameters:
Context1Context1 parameter passed into SwitchStack().
Context2Context2 parameter passed into SwitchStack().

Definition at line 4821 of file BaseLib.h.


Function Documentation

FILE_LICENCE ( BSD3  )
UINTN EFIAPI StrnLenS ( IN CONST CHAR16 String,
IN UINTN  MaxSize 
)

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().

Parameters:
StringA pointer to a Null-terminated Unicode string.
MaxSizeThe maximum number of Destination Unicode char, including terminating null char.
Return values:
0If String is NULL.
MaxSizeIf there is no null character in the first MaxSize characters of String.
Returns:
The number of characters that percede the terminating null character.
UINTN EFIAPI StrnSizeS ( 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().

Parameters:
StringA pointer to a Null-terminated Unicode string.
MaxSizeThe maximum number of Destination Unicode char, including the Null terminator.
Return values:
0If String is NULL.
(sizeof(CHAR16) * (MaxSize + 1)) If there is no Null terminator in the first MaxSize characters of String.
Returns:
The size of the Null-terminated Unicode string in bytes, including the Null terminator.
RETURN_STATUS EFIAPI StrCpyS ( OUT CHAR16 Destination,
IN UINTN  DestMax,
IN CONST CHAR16 Source 
)

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.

Parameters:
DestinationA pointer to a Null-terminated Unicode string.
DestMaxThe maximum number of Destination Unicode char, including terminating null char.
SourceA pointer to a Null-terminated Unicode string.
Return values:
RETURN_SUCCESSString is copied.
RETURN_BUFFER_TOO_SMALLIf DestMax is NOT greater than StrLen(Source).
RETURN_INVALID_PARAMETERIf Destination is NULL. If Source is NULL. If PcdMaximumUnicodeStringLength is not zero, and DestMax is greater than PcdMaximumUnicodeStringLength. If DestMax is 0.
RETURN_ACCESS_DENIEDIf Source and Destination overlap.
RETURN_STATUS EFIAPI StrnCpyS ( OUT CHAR16 Destination,
IN UINTN  DestMax,
IN CONST CHAR16 Source,
IN UINTN  Length 
)

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.

Parameters:
DestinationA pointer to a Null-terminated Unicode string.
DestMaxThe maximum number of Destination Unicode char, including terminating null char.
SourceA pointer to a Null-terminated Unicode string.
LengthThe maximum number of Unicode characters to copy.
Return values:
RETURN_SUCCESSString is copied.
RETURN_BUFFER_TOO_SMALLIf DestMax is NOT greater than MIN(StrLen(Source), Length).
RETURN_INVALID_PARAMETERIf Destination is NULL. If Source is NULL. If PcdMaximumUnicodeStringLength is not zero, and DestMax is greater than PcdMaximumUnicodeStringLength. If DestMax is 0.
RETURN_ACCESS_DENIEDIf Source and Destination overlap.
RETURN_STATUS EFIAPI StrCatS ( IN OUT CHAR16 Destination,
IN UINTN  DestMax,
IN CONST CHAR16 Source 
)

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.

Parameters:
DestinationA pointer to a Null-terminated Unicode string.
DestMaxThe maximum number of Destination Unicode char, including terminating null char.
SourceA pointer to a Null-terminated Unicode string.
Return values:
RETURN_SUCCESSString is appended.
RETURN_BAD_BUFFER_SIZEIf DestMax is NOT greater than StrLen(Destination).
RETURN_BUFFER_TOO_SMALLIf (DestMax - StrLen(Destination)) is NOT greater than StrLen(Source).
RETURN_INVALID_PARAMETERIf Destination is NULL. If Source is NULL. If PcdMaximumUnicodeStringLength is not zero, and DestMax is greater than PcdMaximumUnicodeStringLength. If DestMax is 0.
RETURN_ACCESS_DENIEDIf Source and Destination overlap.
RETURN_STATUS EFIAPI StrnCatS ( IN OUT CHAR16 Destination,
IN UINTN  DestMax,
IN CONST CHAR16 Source,
IN UINTN  Length 
)

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.

Parameters:
DestinationA pointer to a Null-terminated Unicode string.
DestMaxThe maximum number of Destination Unicode char, including terminating null char.
SourceA pointer to a Null-terminated Unicode string.
LengthThe maximum number of Unicode characters to copy.
Return values:
RETURN_SUCCESSString is appended.
RETURN_BAD_BUFFER_SIZEIf DestMax is NOT greater than StrLen(Destination).
RETURN_BUFFER_TOO_SMALLIf (DestMax - StrLen(Destination)) is NOT greater than MIN(StrLen(Source), Length).
RETURN_INVALID_PARAMETERIf Destination is NULL. If Source is NULL. If PcdMaximumUnicodeStringLength is not zero, and DestMax is greater than PcdMaximumUnicodeStringLength. If DestMax is 0.
RETURN_ACCESS_DENIEDIf Source and Destination overlap.
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 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.

Parameters:
StringPointer to a Null-terminated Unicode string.
EndPointerPointer to character that stops scan.
DataPointer to the converted value.
Return values:
RETURN_SUCCESSValue is translated from String.
RETURN_INVALID_PARAMETERIf 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.
RETURN_UNSUPPORTEDIf the number represented by String exceeds the range defined by UINTN.
RETURN_STATUS EFIAPI StrDecimalToUint64S ( IN CONST CHAR16 String,
OUT CHAR16 **  EndPointer,
OPTIONAL OUT UINT64 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.

Parameters:
StringPointer to a Null-terminated Unicode string.
EndPointerPointer to character that stops scan.
DataPointer to the converted value.
Return values:
RETURN_SUCCESSValue is translated from String.
RETURN_INVALID_PARAMETERIf 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.
RETURN_UNSUPPORTEDIf the number represented by String exceeds the range defined by UINT64.
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 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.

Parameters:
StringPointer to a Null-terminated Unicode string.
EndPointerPointer to character that stops scan.
DataPointer to the converted value.
Return values:
RETURN_SUCCESSValue is translated from String.
RETURN_INVALID_PARAMETERIf 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.
RETURN_UNSUPPORTEDIf the number represented by String exceeds the range defined by UINTN.
RETURN_STATUS EFIAPI StrHexToUint64S ( IN CONST CHAR16 String,
OUT CHAR16 **  EndPointer,
OPTIONAL OUT UINT64 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.

Parameters:
StringPointer to a Null-terminated Unicode string.
EndPointerPointer to character that stops scan.
DataPointer to the converted value.
Return values:
RETURN_SUCCESSValue is translated from String.
RETURN_INVALID_PARAMETERIf 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.
RETURN_UNSUPPORTEDIf the number represented by String exceeds the range defined by UINT64.
UINTN EFIAPI AsciiStrnLenS ( IN CONST CHAR8 String,
IN UINTN  MaxSize 
)

Returns the length of a Null-terminated Ascii string.

This function is similar as strlen_s defined in C11.

Parameters:
StringA pointer to a Null-terminated Ascii string.
MaxSizeThe maximum number of Destination Ascii char, including terminating null char.
Return values:
0If String is NULL.
MaxSizeIf there is no null character in the first MaxSize characters of String.
Returns:
The number of characters that percede the terminating null character.
UINTN EFIAPI AsciiStrnSizeS ( 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.

Parameters:
StringA pointer to a Null-terminated Ascii string.
MaxSizeThe maximum number of Destination Ascii char, including the Null terminator.
Return values:
0If String is NULL.
(sizeof(CHAR8) * (MaxSize + 1)) If there is no Null terminator in the first MaxSize characters of String.
Returns:
The size of the Null-terminated Ascii string in bytes, including the Null terminator.
RETURN_STATUS EFIAPI AsciiStrCpyS ( OUT CHAR8 Destination,
IN UINTN  DestMax,
IN CONST CHAR8 Source 
)

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.

Parameters:
DestinationA pointer to a Null-terminated Ascii string.
DestMaxThe maximum number of Destination Ascii char, including terminating null char.
SourceA pointer to a Null-terminated Ascii string.
Return values:
RETURN_SUCCESSString is copied.
RETURN_BUFFER_TOO_SMALLIf DestMax is NOT greater than StrLen(Source).
RETURN_INVALID_PARAMETERIf Destination is NULL. If Source is NULL. If PcdMaximumAsciiStringLength is not zero, and DestMax is greater than PcdMaximumAsciiStringLength. If DestMax is 0.
RETURN_ACCESS_DENIEDIf Source and Destination overlap.
RETURN_STATUS EFIAPI AsciiStrnCpyS ( OUT CHAR8 Destination,
IN UINTN  DestMax,
IN CONST CHAR8 Source,
IN UINTN  Length 
)

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.

Parameters:
DestinationA pointer to a Null-terminated Ascii string.
DestMaxThe maximum number of Destination Ascii char, including terminating null char.
SourceA pointer to a Null-terminated Ascii string.
LengthThe maximum number of Ascii characters to copy.
Return values:
RETURN_SUCCESSString is copied.
RETURN_BUFFER_TOO_SMALLIf DestMax is NOT greater than MIN(StrLen(Source), Length).
RETURN_INVALID_PARAMETERIf Destination is NULL. If Source is NULL. If PcdMaximumAsciiStringLength is not zero, and DestMax is greater than PcdMaximumAsciiStringLength. If DestMax is 0.
RETURN_ACCESS_DENIEDIf Source and Destination overlap.
RETURN_STATUS EFIAPI AsciiStrCatS ( IN OUT CHAR8 Destination,
IN UINTN  DestMax,
IN CONST CHAR8 Source 
)

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.

Parameters:
DestinationA pointer to a Null-terminated Ascii string.
DestMaxThe maximum number of Destination Ascii char, including terminating null char.
SourceA pointer to a Null-terminated Ascii string.
Return values:
RETURN_SUCCESSString is appended.
RETURN_BAD_BUFFER_SIZEIf DestMax is NOT greater than StrLen(Destination).
RETURN_BUFFER_TOO_SMALLIf (DestMax - StrLen(Destination)) is NOT greater than StrLen(Source).
RETURN_INVALID_PARAMETERIf Destination is NULL. If Source is NULL. If PcdMaximumAsciiStringLength is not zero, and DestMax is greater than PcdMaximumAsciiStringLength. If DestMax is 0.
RETURN_ACCESS_DENIEDIf Source and Destination overlap.
RETURN_STATUS EFIAPI AsciiStrnCatS ( IN OUT CHAR8 Destination,
IN UINTN  DestMax,
IN CONST CHAR8 Source,
IN UINTN  Length 
)

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.

Parameters:
DestinationA pointer to a Null-terminated Ascii string.
DestMaxThe maximum number of Destination Ascii char, including terminating null char.
SourceA pointer to a Null-terminated Ascii string.
LengthThe maximum number of Ascii characters to copy.
Return values:
RETURN_SUCCESSString is appended.
RETURN_BAD_BUFFER_SIZEIf DestMax is NOT greater than StrLen(Destination).
RETURN_BUFFER_TOO_SMALLIf (DestMax - StrLen(Destination)) is NOT greater than MIN(StrLen(Source), Length).
RETURN_INVALID_PARAMETERIf Destination is NULL. If Source is NULL. If PcdMaximumAsciiStringLength is not zero, and DestMax is greater than PcdMaximumAsciiStringLength. If DestMax is 0.
RETURN_ACCESS_DENIEDIf Source and Destination overlap.
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 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.

Parameters:
StringPointer to a Null-terminated Ascii string.
EndPointerPointer to character that stops scan.
DataPointer to the converted value.
Return values:
RETURN_SUCCESSValue is translated from String.
RETURN_INVALID_PARAMETERIf 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.
RETURN_UNSUPPORTEDIf the number represented by String exceeds the range defined by UINTN.
RETURN_STATUS EFIAPI AsciiStrDecimalToUint64S ( IN CONST CHAR8 String,
OUT CHAR8 **  EndPointer,
OPTIONAL OUT UINT64 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.

Parameters:
StringPointer to a Null-terminated Ascii string.
EndPointerPointer to character that stops scan.
DataPointer to the converted value.
Return values:
RETURN_SUCCESSValue is translated from String.
RETURN_INVALID_PARAMETERIf 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.
RETURN_UNSUPPORTEDIf the number represented by String exceeds the range defined by UINT64.
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 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.

Parameters:
StringPointer to a Null-terminated Ascii string.
EndPointerPointer to character that stops scan.
DataPointer to the converted value.
Return values:
RETURN_SUCCESSValue is translated from String.
RETURN_INVALID_PARAMETERIf 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.
RETURN_UNSUPPORTEDIf the number represented by String exceeds the range defined by UINTN.
RETURN_STATUS EFIAPI AsciiStrHexToUint64S ( IN CONST CHAR8 String,
OUT CHAR8 **  EndPointer,
OPTIONAL OUT UINT64 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:

[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 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.

Parameters:
StringPointer to a Null-terminated Ascii string.
EndPointerPointer to character that stops scan.
DataPointer to the converted value.
Return values:
RETURN_SUCCESSValue is translated from String.
RETURN_INVALID_PARAMETERIf 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.
RETURN_UNSUPPORTEDIf the number represented by String exceeds the range defined by UINT64.
CHAR16* EFIAPI StrCpy ( OUT CHAR16 Destination,
IN CONST CHAR16 Source 
)

[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.

This function copies the contents of the Unicode string Source to the Unicode string Destination, and returns Destination. If Source and Destination overlap, then the results are undefined.

If Destination is NULL, 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 boundary, then ASSERT(). If Source and Destination overlap, then ASSERT(). If PcdMaximumUnicodeStringLength is not zero, and Source contains more than PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT().

Parameters:
DestinationThe pointer to a Null-terminated Unicode string.
SourceThe pointer to a Null-terminated Unicode string.
Returns:
Destination.
CHAR16* EFIAPI StrnCpy ( OUT CHAR16 Destination,
IN CONST CHAR16 Source,
IN UINTN  Length 
)

[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 characters are copied from Source to Destination. If Length is 0, then Destination is returned unmodified. If Length is greater that the number of Unicode characters in Source, then Destination is padded with Null Unicode characters. If Source and Destination overlap, then the results are undefined.

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 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().

Parameters:
DestinationThe pointer to a Null-terminated Unicode string.
SourceThe pointer to a Null-terminated Unicode string.
LengthThe maximum number of Unicode characters to copy.
Returns:
Destination.
UINTN EFIAPI StrLen ( IN CONST CHAR16 String)

Returns the length of a Null-terminated Unicode string.

This function returns the number of Unicode characters in 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(). If PcdMaximumUnicodeStringLength is not zero, and String contains more than PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT().

Parameters:
StringPointer to a Null-terminated Unicode string.
Returns:
The length of String.
UINTN EFIAPI StrSize ( IN CONST CHAR16 String)

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.

If String is NULL, then ASSERT(). If String is not aligned on 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().

Parameters:
StringThe pointer to a Null-terminated Unicode string.
Returns:
The size of String.
INTN EFIAPI StrCmp ( IN CONST CHAR16 FirstString,
IN CONST CHAR16 SecondString 
)

Compares 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. If FirstString is identical to SecondString, then 0 is returned. Otherwise, the value returned is the first mismatched Unicode character in SecondString subtracted from the first mismatched Unicode character in FirstString.

If FirstString is NULL, then ASSERT(). If FirstString is not aligned on a 16-bit boundary, then ASSERT(). If SecondString is NULL, then ASSERT(). If SecondString is not aligned on a 16-bit boundary, 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().

Parameters:
FirstStringThe pointer to a Null-terminated Unicode string.
SecondStringThe pointer to a Null-terminated Unicode string.
Return values:
0FirstString is identical to SecondString.
Returns:
others FirstString is not identical to SecondString.
INTN EFIAPI StrnCmp ( IN CONST CHAR16 FirstString,
IN CONST CHAR16 SecondString,
IN UINTN  Length 
)

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 characters will be compared. If Length is 0, then 0 is returned. If FirstString is identical to SecondString, then 0 is returned. Otherwise, the value returned is the first mismatched Unicode character in SecondString 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 boundary, then ASSERT(). If Length > 0 and SecondString is NULL, 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().

Parameters:
FirstStringThe pointer to a Null-terminated Unicode string.
SecondStringThe pointer to a Null-terminated Unicode string.
LengthThe maximum number of Unicode characters to compare.
Return values:
0FirstString is identical to SecondString.
Returns:
others FirstString is not identical to SecondString.
CHAR16* EFIAPI StrCat ( IN OUT CHAR16 Destination,
IN CONST CHAR16 Source 
)

[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.

This function concatenates two Null-terminated Unicode strings. The contents of Null-terminated Unicode string Source are concatenated to the end of Null-terminated Unicode string Destination. The Null-terminated concatenated Unicode String is returned. If Source and Destination overlap, then the results are undefined.

If Destination is NULL, 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 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 Null-terminator, then ASSERT(). If PcdMaximumUnicodeStringLength is not zero, and Source contains more than 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().

Parameters:
DestinationThe pointer to a Null-terminated Unicode string.
SourceThe pointer to a Null-terminated Unicode string.
Returns:
Destination.
CHAR16* EFIAPI StrnCat ( IN OUT CHAR16 Destination,
IN CONST CHAR16 Source,
IN UINTN  Length 
)

[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 of Null-terminated Unicode string Source are concatenated to the end of Null-terminated Unicode string Destination, and Destination is returned. At most, Length Unicode characters are concatenated from Source to the end of Destination, and Destination is always Null-terminated. If Length is 0, then Destination is returned unmodified. If Source and Destination overlap, then the results are undefined.

If 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 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 Null-terminator, then ASSERT(). If PcdMaximumUnicodeStringLength is not zero, and Source contains more than 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().

Parameters:
DestinationThe pointer to a Null-terminated Unicode string.
SourceThe pointer to a Null-terminated Unicode string.
LengthThe maximum number of Unicode characters to concatenate from Source.
Returns:
Destination.
CHAR16* EFIAPI StrStr ( IN CONST CHAR16 String,
IN CONST CHAR16 SearchString 
)

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.

If String is NULL, then ASSERT(). If String is not aligned on a 16-bit boundary, then ASSERT(). If SearchString is NULL, then ASSERT(). If SearchString is not aligned on a 16-bit boundary, then ASSERT().

If PcdMaximumUnicodeStringLength is not zero, and SearchString or String contains more than PcdMaximumUnicodeStringLength Unicode characters, not including the Null-terminator, then ASSERT().

Parameters:
StringThe pointer to a Null-terminated Unicode string.
SearchStringThe pointer to a Null-terminated Unicode string to search for.
Return values:
NULLIf the SearchString does not appear in String.
Returns:
others If there is a match.

Convert a Null-terminated Unicode decimal string to a value of type UINTN.

This function returns 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 String is not aligned in a 16-bit boundary, then ASSERT(). 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 MAX_UINTN is returned.

If PcdMaximumUnicodeStringLength is not zero, and String contains more than PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT().

Parameters:
StringThe pointer to a Null-terminated Unicode string.
Return values:
Valuetranslated from String.

Convert a Null-terminated Unicode decimal string to a value of type UINT64.

This function returns 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 String is not aligned in a 16-bit boundary, then ASSERT(). 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 MAX_UINT64 is returned.

If PcdMaximumUnicodeStringLength is not zero, and String contains more than PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT().

Parameters:
StringThe pointer to a Null-terminated Unicode string.
Return values:
Valuetranslated from String.

Convert a Null-terminated Unicode hexadecimal string to a value of type UINTN.

This function returns 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 String is not aligned in a 16-bit boundary, then ASSERT(). If String has only pad spaces, then zero is returned. 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 MAX_UINTN is returned.

If PcdMaximumUnicodeStringLength is not zero, and String contains more than PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT().

Parameters:
StringThe pointer to a Null-terminated Unicode string.
Return values:
Valuetranslated from String.

Convert a Null-terminated Unicode hexadecimal string to a value of type UINT64.

This function returns 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 String is not aligned in a 16-bit boundary, then ASSERT(). If String has only pad spaces, then zero is returned. 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 MAX_UINT64 is returned.

If PcdMaximumUnicodeStringLength is not zero, and String contains more than PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT().

Parameters:
StringThe pointer to a Null-terminated Unicode string.
Return values:
Valuetranslated from String.
RETURN_STATUS EFIAPI StrToIpv6Address ( IN CONST CHAR16 String,
OUT CHAR16 **  EndPointer,
OPTIONAL OUT IPv6_ADDRESS Address,
OUT UINT8 *PrefixLength  OPTIONAL 
)

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().

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.

Parameters:
StringPointer to a Null-terminated Unicode string.
EndPointerPointer to character that stops scan.
AddressPointer to the converted IPv6 address.
PrefixLengthPointer to the converted IPv6 address prefix length. MAX_UINT8 is returned when /P is not in the String.
Return values:
RETURN_SUCCESSAddress is translated from String.
RETURN_INVALID_PARAMETERIf String is NULL. If Data is NULL.
RETURN_UNSUPPORTEDIf 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 StrToIpv4Address ( IN CONST CHAR16 String,
OUT CHAR16 **  EndPointer,
OPTIONAL OUT IPv4_ADDRESS Address,
OUT UINT8 *PrefixLength  OPTIONAL 
)

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.

Parameters:
StringPointer to a Null-terminated Unicode string.
EndPointerPointer to character that stops scan.
AddressPointer to the converted IPv4 address.
PrefixLengthPointer to the converted IPv4 address prefix length. MAX_UINT8 is returned when /P is not in the String.
Return values:
RETURN_SUCCESSAddress is translated from String.
RETURN_INVALID_PARAMETERIf String is NULL. If Data is NULL.
RETURN_UNSUPPORTEDIf 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 StrToGuid ( IN CONST CHAR16 String,
OUT GUID Guid 
)

Convert a Null-terminated Unicode GUID string to a value of type EFI_GUID.

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:

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().

Parameters:
StringPointer to a Null-terminated Unicode string.
GuidPointer to the converted GUID.
Return values:
RETURN_SUCCESSGuid is translated from String.
RETURN_INVALID_PARAMETERIf String is NULL. If Data is NULL.
RETURN_UNSUPPORTEDIf String is not as the above format.
RETURN_STATUS EFIAPI StrHexToBytes ( IN CONST CHAR16 String,
IN UINTN  Length,
OUT UINT8 Buffer,
IN UINTN  MaxBufferSize 
)

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().

If Length is not multiple of 2, then ASSERT().

If PcdMaximumUnicodeStringLength is not zero and Length is greater than PcdMaximumUnicodeStringLength, then ASSERT().

If MaxBufferSize is less than (Length / 2), then ASSERT().

Parameters:
StringPointer to a Null-terminated Unicode string.
LengthThe number of Unicode characters to decode.
BufferPointer to the converted bytes array.
MaxBufferSizeThe maximum size of Buffer.
Return values:
RETURN_SUCCESSBuffer is translated from String.
RETURN_INVALID_PARAMETERIf 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.
RETURN_UNSUPPORTEDIf Length of characters from String contain a character that is not valid hexadecimal digit characters, or a Null-terminator.
RETURN_BUFFER_TOO_SMALLIf MaxBufferSize is less than (Length / 2).
CHAR8* EFIAPI UnicodeStrToAsciiStr ( IN CONST CHAR16 Source,
OUT CHAR8 Destination 
)

[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().

If Destination is NULL, then ASSERT(). If Source is NULL, 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 Source contains more than PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT().

If PcdMaximumAsciiStringLength is not zero, and Source contains more than PcdMaximumAsciiStringLength Unicode characters not including the Null-terminator, then ASSERT().

Parameters:
SourceThe pointer to a Null-terminated Unicode string.
DestinationThe pointer to a Null-terminated ASCII string.
Returns:
Destination.
RETURN_STATUS EFIAPI UnicodeStrToAsciiStrS ( IN CONST CHAR16 Source,
OUT CHAR8 Destination,
IN UINTN  DestMax 
)

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.

Parameters:
SourceThe pointer to a Null-terminated Unicode string.
DestinationThe pointer to a Null-terminated ASCII string.
DestMaxThe maximum number of Destination Ascii char, including terminating null char.
Return values:
RETURN_SUCCESSString is converted.
RETURN_BUFFER_TOO_SMALLIf DestMax is NOT greater than StrLen(Source).
RETURN_INVALID_PARAMETERIf 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.
RETURN_ACCESS_DENIEDIf Source and Destination overlap.
RETURN_STATUS EFIAPI UnicodeStrnToAsciiStrS ( IN CONST CHAR16 Source,
IN UINTN  Length,
OUT CHAR8 Destination,
IN UINTN  DestMax,
OUT UINTN DestinationLength 
)

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.

Parameters:
SourceThe pointer to a Null-terminated Unicode string.
LengthThe maximum number of Unicode characters to convert.
DestinationThe pointer to a Null-terminated Ascii string.
DestMaxThe maximum number of Destination Ascii char, including terminating null char.
DestinationLengthThe number of Unicode characters converted.
Return values:
RETURN_SUCCESSString is converted.
RETURN_INVALID_PARAMETERIf 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.
RETURN_BUFFER_TOO_SMALLIf DestMax is NOT greater than MIN(StrLen(Source), Length).
RETURN_ACCESS_DENIEDIf Source and Destination overlap.
CHAR8* EFIAPI AsciiStrCpy ( OUT CHAR8 Destination,
IN CONST CHAR8 Source 
)

[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.

This function copies the contents of the ASCII string Source to the ASCII string Destination, and returns Destination. If Source and Destination overlap, then the results are undefined.

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 Source contains more than PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then ASSERT().

Parameters:
DestinationThe pointer to a Null-terminated ASCII string.
SourceThe pointer to a Null-terminated ASCII string.
Returns:
Destination
CHAR8* EFIAPI AsciiStrnCpy ( OUT CHAR8 Destination,
IN CONST CHAR8 Source,
IN UINTN  Length 
)

[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 are copied from Source to Destination. If Length is 0, then Destination is returned unmodified. If Length is greater that the number of ASCII characters in Source, then Destination is padded with Null ASCII characters. If Source and Destination overlap, then the results are undefined.

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, then ASSERT().

Parameters:
DestinationThe pointer to a Null-terminated ASCII string.
SourceThe pointer to a Null-terminated ASCII string.
LengthThe maximum number of ASCII characters to copy.
Returns:
Destination

Returns the length of a Null-terminated ASCII string.

This function returns the number of ASCII characters in the Null-terminated ASCII string specified by String.

If Length > 0 and Destination is NULL, then ASSERT(). If Length > 0 and Source is NULL, then ASSERT(). If PcdMaximumAsciiStringLength is not zero and String contains more than PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then ASSERT().

Parameters:
StringThe pointer to a Null-terminated ASCII string.
Returns:
The length of String.

Returns the size of a Null-terminated ASCII string in bytes, including the Null terminator.

This function returns the size, in bytes, of the Null-terminated ASCII string specified by String.

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().

Parameters:
StringThe pointer to a Null-terminated ASCII string.
Returns:
The size of String.
INTN EFIAPI AsciiStrCmp ( IN CONST CHAR8 FirstString,
IN CONST CHAR8 SecondString 
)

Compares two Null-terminated ASCII strings, and returns the difference between the first mismatched ASCII characters.

This function compares the Null-terminated ASCII string FirstString to the Null-terminated ASCII string SecondString. If FirstString is identical to SecondString, then 0 is returned. Otherwise, the value returned is the first mismatched ASCII character in SecondString subtracted from the first mismatched ASCII character in FirstString.

If FirstString is NULL, then ASSERT(). If SecondString is NULL, 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, then ASSERT().

Parameters:
FirstStringThe pointer to a Null-terminated ASCII string.
SecondStringThe pointer to a Null-terminated ASCII string.
Return values:
==0FirstString is identical to SecondString.
!=0FirstString is not identical to SecondString.
INTN EFIAPI AsciiStriCmp ( IN CONST CHAR8 FirstString,
IN CONST CHAR8 SecondString 
)

Performs a case insensitive comparison of two Null-terminated ASCII strings, and returns the difference between the first mismatched ASCII characters.

This function performs a case insensitive comparison of the Null-terminated ASCII string FirstString to the Null-terminated ASCII string SecondString. If FirstString is identical to SecondString, then 0 is returned. Otherwise, the value returned is the first mismatched lower case ASCII character in SecondString subtracted from the first mismatched lower case ASCII character in FirstString.

If FirstString is NULL, then ASSERT(). If SecondString is NULL, 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, then ASSERT().

Parameters:
FirstStringThe pointer to a Null-terminated ASCII string.
SecondStringThe pointer to a Null-terminated ASCII string.
Return values:
==0FirstString is identical to SecondString using case insensitive comparisons.
!=0FirstString is not identical to SecondString using case insensitive comparisons.
INTN EFIAPI AsciiStrnCmp ( IN CONST CHAR8 FirstString,
IN CONST CHAR8 SecondString,
IN UINTN  Length 
)

Compares two Null-terminated ASCII strings with maximum lengths, and returns the difference between the first mismatched ASCII characters.

This function compares the Null-terminated ASCII string FirstString to the Null-terminated ASCII string SecondString. At most, Length ASCII characters will be compared. If Length is 0, then 0 is returned. If FirstString is identical to SecondString, then 0 is returned. Otherwise, the value returned is the first mismatched ASCII character in SecondString subtracted from the first mismatched ASCII character in FirstString.

If Length > 0 and FirstString is NULL, then ASSERT(). If Length > 0 and SecondString is NULL, then ASSERT(). 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, then ASSERT().

Parameters:
FirstStringThe pointer to a Null-terminated ASCII string.
SecondStringThe pointer to a Null-terminated ASCII string.
LengthThe maximum number of ASCII characters for compare.
Return values:
==0FirstString is identical to SecondString.
!=0FirstString is not identical to SecondString.
CHAR8* EFIAPI AsciiStrCat ( IN OUT CHAR8 Destination,
IN CONST CHAR8 Source 
)

[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.

This function concatenates two Null-terminated ASCII strings. The contents of Null-terminated ASCII string Source are concatenated to the end of Null- terminated ASCII string Destination. The Null-terminated concatenated ASCII String is returned.

If Destination is NULL, then ASSERT(). If Source is NULL, then ASSERT(). If PcdMaximumAsciiStringLength is not zero and Destination contains more than 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, then ASSERT(). If PcdMaximumAsciiStringLength is not zero and concatenating Destination and Source results in a ASCII string with more than PcdMaximumAsciiStringLength ASCII characters, then ASSERT().

Parameters:
DestinationThe pointer to a Null-terminated ASCII string.
SourceThe pointer to a Null-terminated ASCII string.
Returns:
Destination
CHAR8* EFIAPI AsciiStrnCat ( IN OUT CHAR8 Destination,
IN CONST CHAR8 Source,
IN UINTN  Length 
)

[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- terminated ASCII string Destination, and Destination is returned. At most, Length ASCII characters are concatenated from Source to the end of Destination, and Destination is always Null-terminated. If Length is 0, then Destination is returned unmodified. If Source and Destination overlap, then the results are undefined.

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, then ASSERT(). If PcdMaximumAsciiStringLength is not zero, and Source contains more than 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().

Parameters:
DestinationThe pointer to a Null-terminated ASCII string.
SourceThe pointer to a Null-terminated ASCII string.
LengthThe maximum number of ASCII characters to concatenate from Source.
Returns:
Destination
CHAR8* EFIAPI AsciiStrStr ( IN CONST CHAR8 String,
IN CONST CHAR8 SearchString 
)

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 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.

If String is NULL, then ASSERT(). If SearchString is NULL, then ASSERT().

If PcdMaximumAsciiStringLength is not zero, and SearchString or String contains more than PcdMaximumAsciiStringLength Unicode characters not including the Null-terminator, then ASSERT().

Parameters:
StringThe pointer to a Null-terminated ASCII string.
SearchStringThe pointer to a Null-terminated ASCII string to search for.
Return values:
NULLIf the SearchString does not appear in String.
othersIf there is a match return the first occurrence of SearchingString. If the length of SearchString is zero,return String.

Convert a Null-terminated ASCII decimal string to a value of type UINTN.

This function returns a value of type UINTN by interpreting the contents of the ASCII string 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 the 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 Null-terminator, whichever on comes first.

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 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().

Parameters:
StringThe pointer to a Null-terminated ASCII string.
Return values:
Thevalue translated from String.

Convert a Null-terminated ASCII decimal string to a value of type UINT64.

This function returns a value of type UINT64 by interpreting the contents of the ASCII string 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 the 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 Null-terminator, whichever on comes first.

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 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().

Parameters:
StringThe pointer to a Null-terminated ASCII string.
Return values:
Valuetranslated from String.

Convert a Null-terminated ASCII hexadecimal string to a value of type UINTN.

This function returns a value of type UINTN by interpreting the contents of the ASCII string 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 has only pad spaces, then 0 is returned. 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 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().

Parameters:
StringThe pointer to a Null-terminated ASCII string.
Return values:
Valuetranslated from String.

Convert a Null-terminated ASCII hexadecimal string to a value of type UINT64.

This function returns a value of type UINT64 by interpreting the contents of the ASCII string 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 has only pad spaces, then 0 is returned. 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 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().

Parameters:
StringThe pointer to a Null-terminated ASCII string.
Return values:
Valuetranslated from String.
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 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.

Parameters:
StringPointer to a Null-terminated ASCII string.
EndPointerPointer to character that stops scan.
AddressPointer to the converted IPv6 address.
PrefixLengthPointer to the converted IPv6 address prefix length. MAX_UINT8 is returned when /P is not in the String.
Return values:
RETURN_SUCCESSAddress is translated from String.
RETURN_INVALID_PARAMETERIf String is NULL. If Data is NULL.
RETURN_UNSUPPORTEDIf 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 AsciiStrToIpv4Address ( IN CONST CHAR8 String,
OUT CHAR8 **  EndPointer,
OPTIONAL OUT IPv4_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.

Parameters:
StringPointer to a Null-terminated ASCII string.
EndPointerPointer to character that stops scan.
AddressPointer to the converted IPv4 address.
PrefixLengthPointer to the converted IPv4 address prefix length. MAX_UINT8 is returned when /P is not in the String.
Return values:
RETURN_SUCCESSAddress is translated from String.
RETURN_INVALID_PARAMETERIf String is NULL. If Data is NULL.
RETURN_UNSUPPORTEDIf 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 AsciiStrToGuid ( IN CONST CHAR8 String,
OUT GUID Guid 
)

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().

Parameters:
StringPointer to a Null-terminated ASCII string.
GuidPointer to the converted GUID.
Return values:
RETURN_SUCCESSGuid is translated from String.
RETURN_INVALID_PARAMETERIf String is NULL. If Data is NULL.
RETURN_UNSUPPORTEDIf String is not as the above format.
RETURN_STATUS EFIAPI AsciiStrHexToBytes ( IN CONST CHAR8 String,
IN UINTN  Length,
OUT UINT8 Buffer,
IN UINTN  MaxBufferSize 
)

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 Buffer is NULL, then ASSERT().

If Length is not multiple of 2, then ASSERT().

If PcdMaximumAsciiStringLength is not zero and Length is greater than PcdMaximumAsciiStringLength, then ASSERT().

If MaxBufferSize is less than (Length / 2), then ASSERT().

Parameters:
StringPointer to a Null-terminated ASCII string.
LengthThe number of ASCII characters to decode.
BufferPointer to the converted bytes array.
MaxBufferSizeThe maximum size of Buffer.
Return values:
RETURN_SUCCESSBuffer is translated from String.
RETURN_INVALID_PARAMETERIf 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.
RETURN_UNSUPPORTEDIf Length of characters from String contain a character that is not valid hexadecimal digit characters, or a Null-terminator.
RETURN_BUFFER_TOO_SMALLIf MaxBufferSize is less than (Length / 2).
CHAR16* EFIAPI AsciiStrToUnicodeStr ( IN CONST CHAR8 Source,
OUT CHAR16 Destination 
)

[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.

This function converts the contents of the ASCII string Source to the Unicode string Destination, and returns 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 NULL, then ASSERT(). If Destination is not aligned on a 16-bit boundary, then ASSERT(). If Source is NULL, then ASSERT(). If Source and Destination overlap, then ASSERT(). If PcdMaximumAsciiStringLength is not zero, and Source contains more than PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then ASSERT(). If PcdMaximumUnicodeStringLength is not zero, and Source contains more than PcdMaximumUnicodeStringLength ASCII characters not including the Null-terminator, then ASSERT().

Parameters:
SourceThe pointer to a Null-terminated ASCII string.
DestinationThe pointer to a Null-terminated Unicode string.
Returns:
Destination.
RETURN_STATUS EFIAPI AsciiStrToUnicodeStrS ( IN CONST CHAR8 Source,
OUT CHAR16 Destination,
IN UINTN  DestMax 
)

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.

Parameters:
SourceThe pointer to a Null-terminated ASCII string.
DestinationThe pointer to a Null-terminated Unicode string.
DestMaxThe maximum number of Destination Unicode char, including terminating null char.
Return values:
RETURN_SUCCESSString is converted.
RETURN_BUFFER_TOO_SMALLIf DestMax is NOT greater than StrLen(Source).
RETURN_INVALID_PARAMETERIf 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.
RETURN_ACCESS_DENIEDIf Source and Destination overlap.
RETURN_STATUS EFIAPI AsciiStrnToUnicodeStrS ( IN CONST CHAR8 Source,
IN UINTN  Length,
OUT CHAR16 Destination,
IN UINTN  DestMax,
OUT UINTN DestinationLength 
)

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.

Parameters:
SourceThe pointer to a Null-terminated Ascii string.
LengthThe maximum number of Ascii characters to convert.
DestinationThe pointer to a Null-terminated Unicode string.
DestMaxThe maximum number of Destination Unicode char, including terminating null char.
DestinationLengthThe number of Ascii characters converted.
Return values:
RETURN_SUCCESSString is converted.
RETURN_INVALID_PARAMETERIf 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.
RETURN_BUFFER_TOO_SMALLIf DestMax is NOT greater than MIN(AsciiStrLen(Source), Length).
RETURN_ACCESS_DENIEDIf Source and Destination overlap.

Converts an 8-bit value to an 8-bit BCD value.

Converts the 8-bit value specified by Value to BCD. The BCD value is returned.

If Value >= 100, then ASSERT().

Parameters:
ValueThe 8-bit value to convert to BCD. Range 0..99.
Returns:
The BCD value.

Converts an 8-bit BCD value to an 8-bit value.

Converts the 8-bit BCD value specified by Value to an 8-bit value. The 8-bit value is returned.

If Value >= 0xA0, then ASSERT(). If (Value & 0x0F) >= 0x0A, then ASSERT().

Parameters:
ValueThe 8-bit BCD value to convert to an 8-bit value.
Returns:
The 8-bit value is returned.

Removes the last directory or file entry in a path.

Parameters:
[in,out]PathThe pointer to the path to modify.
Return values:
FALSENothing was found to remove.
TRUEA directory or file was removed.

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.

Parameters:
[in]PathThe pointer to the string containing the path.
Returns:
Returns Path, otherwise returns NULL to indicate that an error has occurred.

Initializes the head node of a doubly linked list, and returns the pointer to the head node of the doubly linked list.

Initializes the forward and backward links of a new linked list. After initializing a linked list with this function, the other linked list functions may be used to add and remove nodes from the linked list. It is up to the caller of this function to allocate the memory for ListHead.

If ListHead is NULL, then ASSERT().

Parameters:
ListHeadA pointer to the head node of a new doubly linked list.
Returns:
ListHead
LIST_ENTRY* EFIAPI InsertHeadList ( IN OUT LIST_ENTRY ListHead,
IN OUT LIST_ENTRY Entry 
)

Adds a node to the beginning of a doubly linked list, and returns the pointer to the head node of the doubly linked list.

Adds the node Entry at the beginning of the doubly linked list denoted by ListHead, and returns ListHead.

If ListHead is NULL, then ASSERT(). If Entry is NULL, then ASSERT(). 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().

Parameters:
ListHeadA pointer to the head node of a doubly linked list.
EntryA pointer to a node that is to be inserted at the beginning of a doubly linked list.
Returns:
ListHead
LIST_ENTRY* EFIAPI InsertTailList ( IN OUT LIST_ENTRY ListHead,
IN OUT LIST_ENTRY Entry 
)

Adds a node to the end of a doubly linked list, and returns the pointer to the head node of the doubly linked list.

Adds the node Entry to the end of the doubly linked list denoted by ListHead, and returns ListHead.

If ListHead is NULL, then ASSERT(). If Entry is NULL, then ASSERT(). 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().

Parameters:
ListHeadA pointer to the head node of a doubly linked list.
EntryA pointer to a node that is to be added at the end of the doubly linked list.
Returns:
ListHead

Retrieves the first node of a doubly linked list.

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 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().

Parameters:
ListA pointer to the head node of a doubly linked list.
Returns:
The first node of a doubly linked list.
Return values:
ListThe list is empty.

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 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().

Parameters:
ListA pointer to the head node of a doubly linked list.
NodeA pointer to a node in the doubly linked list.
Returns:
The pointer to the next node if one exists. Otherwise List is returned.

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().

Parameters:
ListA pointer to the head node of a doubly linked list.
NodeA pointer to a node in the doubly linked list.
Returns:
The pointer to the previous node if one exists. Otherwise List is returned.

Checks to see if a doubly linked list is empty or not.

Checks to see if the doubly linked list is empty. If the linked list contains zero nodes, this function returns TRUE. Otherwise, it returns FALSE.

If ListHead is NULL, then ASSERT(). 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().

Parameters:
ListHeadA pointer to the head node of a doubly linked list.
Return values:
TRUEThe linked list is empty.
FALSEThe linked list is not empty.

Determines if a node in a doubly linked list is the head node of a the same doubly linked list.

This function is typically used to terminate a loop that traverses all the nodes in a doubly linked list starting with the head node.

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 INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead().

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 the number of nodes in List, including the List node, is greater than or equal to PcdMaximumLinkedListLength, then ASSERT(). If PcdVerifyNodeInList is TRUE and Node is not a node in List the and Node is not equal to List, then ASSERT().

Parameters:
ListA pointer to the head node of a doubly linked list.
NodeA pointer to a node in the doubly linked list.
Return values:
TRUENode is the head of the doubly-linked list pointed by List.
FALSENode is not the head of the doubly-linked list pointed by List.

Determines if a node the last node in a doubly linked list.

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 INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead().

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 the number of nodes in List, including the List node, is greater than or equal to PcdMaximumLinkedListLength, then ASSERT(). If PcdVerifyNodeInList is TRUE and Node is not a node in List, then ASSERT().

Parameters:
ListA pointer to the head node of a doubly linked list.
NodeA pointer to a node in the doubly linked list.
Return values:
TRUENode is the last node in the linked list.
FALSENode is not the last node in the linked list.
LIST_ENTRY* EFIAPI SwapListEntries ( IN OUT LIST_ENTRY FirstEntry,
IN OUT LIST_ENTRY SecondEntry 
)

Swaps the location of two nodes in a doubly linked list, and returns the first node after the swap.

If FirstEntry is identical to SecondEntry, then SecondEntry is returned. 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 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 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 PcdMaximumLinkedListLength, then ASSERT().

Parameters:
FirstEntryA pointer to a node in a linked list.
SecondEntryA pointer to another node in the same linked list.
Returns:
SecondEntry.

Removes a node from a doubly linked list, and returns the node that follows the removed node.

Removes the node Entry from a doubly linked list. It is up to the caller of this function to release the memory used by this node if that is required. On exit, the node following Entry in the doubly linked list is returned. If Entry is the only node in the linked list, then the head node of the linked list is returned.

If Entry is NULL, then ASSERT(). If Entry is the head node of an empty list, then ASSERT(). If PcdMaximumLinkedListLength is not zero, and the number of nodes in the linked list containing Entry, including the Entry node, is greater than or equal to PcdMaximumLinkedListLength, then ASSERT().

Parameters:
EntryA pointer to a node in a linked list.
Returns:
Entry.
UINT64 EFIAPI LShiftU64 ( IN UINT64  Operand,
IN UINTN  Count 
)

Shifts a 64-bit integer left between 0 and 63 bits.

The low bits are filled with zeros. The shifted value is returned.

This function shifts the 64-bit value Operand to the left by Count bits. The low Count bits are set to zero. The shifted value is returned.

If Count is greater than 63, then ASSERT().

Parameters:
OperandThe 64-bit operand to shift left.
CountThe number of bits to shift left.
Returns:
Operand << Count.
UINT64 EFIAPI RShiftU64 ( IN UINT64  Operand,
IN UINTN  Count 
)

Shifts a 64-bit integer right between 0 and 63 bits.

This high bits are filled with zeros. The shifted value is returned.

This function shifts the 64-bit value Operand to the right by Count bits. The high Count bits are set to zero. The shifted value is returned.

If Count is greater than 63, then ASSERT().

Parameters:
OperandThe 64-bit operand to shift right.
CountThe number of bits to shift right.
Returns:
Operand >> Count
UINT64 EFIAPI ARShiftU64 ( IN UINT64  Operand,
IN UINTN  Count 
)

Shifts a 64-bit integer right between 0 and 63 bits.

The high bits are filled with original integer's bit 63. The shifted value is returned.

This function shifts the 64-bit value Operand to the right by Count bits. The high Count bits are set to bit 63 of Operand. The shifted value is returned.

If Count is greater than 63, then ASSERT().

Parameters:
OperandThe 64-bit operand to shift right.
CountThe number of bits to shift right.
Returns:
Operand >> Count
UINT32 EFIAPI LRotU32 ( IN UINT32  Operand,
IN UINTN  Count 
)

Rotates a 32-bit integer left between 0 and 31 bits, filling the low bits with the high bits that were rotated.

This function rotates the 32-bit value Operand to the left by Count bits. The low Count bits are fill with the high Count bits of Operand. The rotated value is returned.

If Count is greater than 31, then ASSERT().

Parameters:
OperandThe 32-bit operand to rotate left.
CountThe number of bits to rotate left.
Returns:
Operand << Count
UINT32 EFIAPI RRotU32 ( IN UINT32  Operand,
IN UINTN  Count 
)

Rotates a 32-bit integer right between 0 and 31 bits, filling the high bits with the low bits that were rotated.

This function rotates the 32-bit value Operand to the right by Count bits. The high Count bits are fill with the low Count bits of Operand. The rotated value is returned.

If Count is greater than 31, then ASSERT().

Parameters:
OperandThe 32-bit operand to rotate right.
CountThe number of bits to rotate right.
Returns:
Operand >> Count
UINT64 EFIAPI LRotU64 ( IN UINT64  Operand,
IN UINTN  Count 
)

Rotates a 64-bit integer left between 0 and 63 bits, filling the low bits with the high bits that were rotated.

This function rotates the 64-bit value Operand to the left by Count bits. The low Count bits are fill with the high Count bits of Operand. The rotated value is returned.

If Count is greater than 63, then ASSERT().

Parameters:
OperandThe 64-bit operand to rotate left.
CountThe number of bits to rotate left.
Returns:
Operand << Count
UINT64 EFIAPI RRotU64 ( IN UINT64  Operand,
IN UINTN  Count 
)

Rotates a 64-bit integer right between 0 and 63 bits, filling the high bits with the high low bits that were rotated.

This function rotates the 64-bit value Operand to the right by Count bits. The high Count bits are fill with the low Count bits of Operand. The rotated value is returned.

If Count is greater than 63, then ASSERT().

Parameters:
OperandThe 64-bit operand to rotate right.
CountThe number of bits to rotate right.
Returns:
Operand >> Count

Returns the bit position of the lowest bit set in a 32-bit value.

This function computes the bit position of the lowest bit set in the 32-bit value specified by Operand. If Operand is zero, then -1 is returned. Otherwise, a value between 0 and 31 is returned.

Parameters:
OperandThe 32-bit operand to evaluate.
Return values:
0..31The lowest bit set in Operand was found.
-1Operand is zero.

Returns the bit position of the lowest bit set in a 64-bit value.

This function computes the bit position of the lowest bit set in the 64-bit value specified by Operand. If Operand is zero, then -1 is returned. Otherwise, a value between 0 and 63 is returned.

Parameters:
OperandThe 64-bit operand to evaluate.
Return values:
0..63The lowest bit set in Operand was found.
-1Operand is zero.

Returns the bit position of the highest bit set in a 32-bit value.

Equivalent to log2(x).

This function computes the bit position of the highest bit set in the 32-bit value specified by Operand. If Operand is zero, then -1 is returned. Otherwise, a value between 0 and 31 is returned.

Parameters:
OperandThe 32-bit operand to evaluate.
Return values:
0..31Position of the highest bit set in Operand if found.
-1Operand is zero.

Returns the bit position of the highest bit set in a 64-bit value.

Equivalent to log2(x).

This function computes the bit position of the highest bit set in the 64-bit value specified by Operand. If Operand is zero, then -1 is returned. Otherwise, a value between 0 and 63 is returned.

Parameters:
OperandThe 64-bit operand to evaluate.
Return values:
0..63Position of the highest bit set in Operand if found.
-1Operand is zero.

Returns the value of the highest bit set in a 32-bit value.

Equivalent to 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.

Parameters:
OperandThe 32-bit operand to evaluate.
Returns:
1 << HighBitSet32(Operand)
Return values:
0Operand is zero.

Returns the value of the highest bit set in a 64-bit value.

Equivalent to 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.

Parameters:
OperandThe 64-bit operand to evaluate.
Returns:
1 << HighBitSet64(Operand)
Return values:
0Operand is zero.

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.

Parameters:
ValueA 16-bit unsigned value.
Returns:
The byte swapped Value.

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.

Parameters:
ValueA 32-bit unsigned value.
Returns:
The byte swapped Value.

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.

Parameters:
ValueA 64-bit unsigned value.
Returns:
The byte swapped Value.
UINT64 EFIAPI MultU64x32 ( IN UINT64  Multiplicand,
IN UINT32  Multiplier 
)

Multiples a 64-bit unsigned integer by a 32-bit unsigned integer and generates a 64-bit unsigned result.

This function multiples the 64-bit unsigned value Multiplicand by the 32-bit unsigned value Multiplier and generates a 64-bit unsigned result. This 64- bit unsigned result is returned.

Parameters:
MultiplicandA 64-bit unsigned value.
MultiplierA 32-bit unsigned value.
Returns:
Multiplicand * Multiplier
UINT64 EFIAPI MultU64x64 ( IN UINT64  Multiplicand,
IN UINT64  Multiplier 
)

Multiples a 64-bit unsigned integer by a 64-bit unsigned integer and generates a 64-bit unsigned result.

This function multiples the 64-bit unsigned value Multiplicand by the 64-bit unsigned value Multiplier and generates a 64-bit unsigned result. This 64- bit unsigned result is returned.

Parameters:
MultiplicandA 64-bit unsigned value.
MultiplierA 64-bit unsigned value.
Returns:
Multiplicand * Multiplier.
INT64 EFIAPI MultS64x64 ( IN INT64  Multiplicand,
IN INT64  Multiplier 
)

Multiples a 64-bit signed integer by a 64-bit signed integer and generates a 64-bit signed result.

This function multiples the 64-bit signed value Multiplicand by the 64-bit signed value Multiplier and generates a 64-bit signed result. This 64-bit signed result is returned.

Parameters:
MultiplicandA 64-bit signed value.
MultiplierA 64-bit signed value.
Returns:
Multiplicand * Multiplier
UINT64 EFIAPI DivU64x32 ( IN UINT64  Dividend,
IN UINT32  Divisor 
)

Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates a 64-bit unsigned result.

This function divides the 64-bit unsigned value Dividend by the 32-bit unsigned value Divisor and generates a 64-bit unsigned quotient. This function returns the 64-bit unsigned quotient.

If Divisor is 0, then ASSERT().

Parameters:
DividendA 64-bit unsigned value.
DivisorA 32-bit unsigned value.
Returns:
Dividend / Divisor.
UINT32 EFIAPI ModU64x32 ( IN UINT64  Dividend,
IN UINT32  Divisor 
)

Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates a 32-bit unsigned remainder.

This function divides the 64-bit unsigned value Dividend by the 32-bit unsigned value Divisor and generates a 32-bit remainder. This function returns the 32-bit unsigned remainder.

If Divisor is 0, then ASSERT().

Parameters:
DividendA 64-bit unsigned value.
DivisorA 32-bit unsigned value.
Returns:
Dividend % Divisor.
UINT64 EFIAPI DivU64x32Remainder ( IN UINT64  Dividend,
IN UINT32  Divisor,
OUT UINT32 *Remainder  OPTIONAL 
)

Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates a 64-bit unsigned result and an optional 32-bit unsigned remainder.

This function divides the 64-bit unsigned value Dividend by the 32-bit unsigned value Divisor and generates a 64-bit unsigned quotient. If Remainder is not NULL, then the 32-bit unsigned remainder is returned in Remainder. This function returns the 64-bit unsigned quotient.

If Divisor is 0, then ASSERT().

Parameters:
DividendA 64-bit unsigned value.
DivisorA 32-bit unsigned value.
RemainderA pointer to a 32-bit unsigned value. This parameter is optional and may be NULL.
Returns:
Dividend / Divisor.
UINT64 EFIAPI DivU64x64Remainder ( IN UINT64  Dividend,
IN UINT64  Divisor,
OUT UINT64 *Remainder  OPTIONAL 
)

Divides a 64-bit unsigned integer by a 64-bit unsigned integer and generates a 64-bit unsigned result and an optional 64-bit unsigned remainder.

This function divides the 64-bit unsigned value Dividend by the 64-bit unsigned value Divisor and generates a 64-bit unsigned quotient. If Remainder is not NULL, then the 64-bit unsigned remainder is returned in Remainder. This function returns the 64-bit unsigned quotient.

If Divisor is 0, then ASSERT().

Parameters:
DividendA 64-bit unsigned value.
DivisorA 64-bit unsigned value.
RemainderA pointer to a 64-bit unsigned value. This parameter is optional and may be NULL.
Returns:
Dividend / Divisor.
INT64 EFIAPI DivS64x64Remainder ( IN INT64  Dividend,
IN INT64  Divisor,
OUT INT64 *Remainder  OPTIONAL 
)

Divides a 64-bit signed integer by a 64-bit signed integer and generates a 64-bit signed result and a optional 64-bit signed remainder.

This function divides the 64-bit signed value Dividend by the 64-bit signed value Divisor and generates a 64-bit signed quotient. If Remainder is not 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().

Parameters:
DividendA 64-bit signed value.
DivisorA 64-bit signed value.
RemainderA pointer to a 64-bit signed value. This parameter is optional and may be NULL.
Returns:
Dividend / Divisor.

Reads a 16-bit value from memory that may be unaligned.

This function returns the 16-bit value pointed to by Buffer. The function guarantees that the read operation does not produce an alignment fault.

If the Buffer is NULL, then ASSERT().

Parameters:
BufferThe pointer to a 16-bit value that may be unaligned.
Returns:
The 16-bit value read from Buffer.
UINT16 EFIAPI WriteUnaligned16 ( OUT UINT16 Buffer,
IN UINT16  Value 
)

Writes a 16-bit value to memory that may be unaligned.

This function writes the 16-bit value specified by Value to Buffer. Value is returned. The function guarantees that the write operation does not produce an alignment fault.

If the Buffer is NULL, then ASSERT().

Parameters:
BufferThe pointer to a 16-bit value that may be unaligned.
Value16-bit value to write to Buffer.
Returns:
The 16-bit value to write to Buffer.

Reads a 24-bit value from memory that may be unaligned.

This function returns the 24-bit value pointed to by Buffer. The function guarantees that the read operation does not produce an alignment fault.

If the Buffer is NULL, then ASSERT().

Parameters:
BufferThe pointer to a 24-bit value that may be unaligned.
Returns:
The 24-bit value read from Buffer.
UINT32 EFIAPI WriteUnaligned24 ( OUT UINT32 Buffer,
IN UINT32  Value 
)

Writes a 24-bit value to memory that may be unaligned.

This function writes the 24-bit value specified by Value to Buffer. Value is returned. The function guarantees that the write operation does not produce an alignment fault.

If the Buffer is NULL, then ASSERT().

Parameters:
BufferThe pointer to a 24-bit value that may be unaligned.
Value24-bit value to write to Buffer.
Returns:
The 24-bit value to write to Buffer.

Reads a 32-bit value from memory that may be unaligned.

This function returns the 32-bit value pointed to by Buffer. The function guarantees that the read operation does not produce an alignment fault.

If the Buffer is NULL, then ASSERT().

Parameters:
BufferThe pointer to a 32-bit value that may be unaligned.
Returns:
The 32-bit value read from Buffer.
UINT32 EFIAPI WriteUnaligned32 ( OUT UINT32 Buffer,
IN UINT32  Value 
)

Writes a 32-bit value to memory that may be unaligned.

This function writes the 32-bit value specified by Value to Buffer. Value is returned. The function guarantees that the write operation does not produce an alignment fault.

If the Buffer is NULL, then ASSERT().

Parameters:
BufferThe pointer to a 32-bit value that may be unaligned.
Value32-bit value to write to Buffer.
Returns:
The 32-bit value to write to Buffer.

Reads a 64-bit value from memory that may be unaligned.

This function returns the 64-bit value pointed to by Buffer. The function guarantees that the read operation does not produce an alignment fault.

If the Buffer is NULL, then ASSERT().

Parameters:
BufferThe pointer to a 64-bit value that may be unaligned.
Returns:
The 64-bit value read from Buffer.
UINT64 EFIAPI WriteUnaligned64 ( OUT UINT64 Buffer,
IN UINT64  Value 
)

Writes a 64-bit value to memory that may be unaligned.

This function writes the 64-bit value specified by Value to Buffer. Value is returned. The function guarantees that the write operation does not produce an alignment fault.

If the Buffer is NULL, then ASSERT().

Parameters:
BufferThe pointer to a 64-bit value that may be unaligned.
Value64-bit value to write to Buffer.
Returns:
The 64-bit value to write to Buffer.
UINT8 EFIAPI BitFieldRead8 ( IN UINT8  Operand,
IN UINTN  StartBit,
IN UINTN  EndBit 
)

Returns a bit field from an 8-bit value.

Returns the bitfield specified by the StartBit and the EndBit from Operand.

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().

Parameters:
OperandOperand on which to perform the bitfield operation.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..7.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..7.
Returns:
The bit field read.
UINT8 EFIAPI BitFieldWrite8 ( IN UINT8  Operand,
IN UINTN  StartBit,
IN UINTN  EndBit,
IN UINT8  Value 
)

Writes a bit field to an 8-bit value, and returns the result.

Writes Value to the bit field specified by the StartBit and the EndBit in Operand. 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 Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters:
OperandOperand on which to perform the bitfield operation.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..7.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..7.
ValueNew value of the bit field.
Returns:
The new 8-bit value.
UINT8 EFIAPI BitFieldOr8 ( IN UINT8  Operand,
IN UINTN  StartBit,
IN UINTN  EndBit,
IN UINT8  OrData 
)

Reads a bit field from an 8-bit value, performs a bitwise OR, and returns the result.

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.

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 OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters:
OperandOperand on which to perform the bitfield operation.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..7.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..7.
OrDataThe value to OR with the read value from the value
Returns:
The new 8-bit value.
UINT8 EFIAPI BitFieldAnd8 ( IN UINT8  Operand,
IN UINTN  StartBit,
IN UINTN  EndBit,
IN UINT8  AndData 
)

Reads a bit field from an 8-bit value, performs a bitwise AND, and returns the result.

Performs a bitwise AND between the bit field specified by StartBit and EndBit in Operand and the value specified by AndData. 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().

Parameters:
OperandOperand on which to perform the bitfield operation.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..7.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..7.
AndDataThe value to AND with the read value from the value.
Returns:
The new 8-bit value.
UINT8 EFIAPI BitFieldAndThenOr8 ( IN UINT8  Operand,
IN UINTN  StartBit,
IN UINTN  EndBit,
IN UINT8  AndData,
IN UINT8  OrData 
)

Reads a bit field from an 8-bit value, performs a bitwise AND followed by a bitwise OR, and returns the result.

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 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().

Parameters:
OperandOperand on which to perform the bitfield operation.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..7.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..7.
AndDataThe value to AND with the read value from the value.
OrDataThe value to OR with the result of the AND operation.
Returns:
The new 8-bit value.
UINT16 EFIAPI BitFieldRead16 ( IN UINT16  Operand,
IN UINTN  StartBit,
IN UINTN  EndBit 
)

Returns a bit field from a 16-bit value.

Returns the bitfield specified by the StartBit and the EndBit from Operand.

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().

Parameters:
OperandOperand on which to perform the bitfield operation.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..15.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..15.
Returns:
The bit field read.
UINT16 EFIAPI BitFieldWrite16 ( IN UINT16  Operand,
IN UINTN  StartBit,
IN UINTN  EndBit,
IN UINT16  Value 
)

Writes a bit field to a 16-bit value, and returns the result.

Writes Value to the bit field specified by the StartBit and the EndBit in Operand. 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 Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters:
OperandOperand on which to perform the bitfield operation.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..15.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..15.
ValueNew value of the bit field.
Returns:
The new 16-bit value.
UINT16 EFIAPI BitFieldOr16 ( IN UINT16  Operand,
IN UINTN  StartBit,
IN UINTN  EndBit,
IN UINT16  OrData 
)

Reads a bit field from a 16-bit value, performs a bitwise OR, and returns the result.

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.

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 OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters:
OperandOperand on which to perform the bitfield operation.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..15.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..15.
OrDataThe value to OR with the read value from the value
Returns:
The new 16-bit value.
UINT16 EFIAPI BitFieldAnd16 ( IN UINT16  Operand,
IN UINTN  StartBit,
IN UINTN  EndBit,
IN UINT16  AndData 
)

Reads a bit field from a 16-bit value, performs a bitwise AND, and returns the result.

Performs a bitwise AND between the bit field specified by StartBit and EndBit in Operand and the value specified by AndData. 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().

Parameters:
OperandOperand on which to perform the bitfield operation.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..15.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..15.
AndDataThe value to AND with the read value from the value
Returns:
The new 16-bit value.
UINT16 EFIAPI BitFieldAndThenOr16 ( IN UINT16  Operand,
IN UINTN  StartBit,
IN UINTN  EndBit,
IN UINT16  AndData,
IN UINT16  OrData 
)

Reads a bit field from a 16-bit value, performs a bitwise AND followed by a bitwise OR, and returns the result.

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 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().

Parameters:
OperandOperand on which to perform the bitfield operation.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..15.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..15.
AndDataThe value to AND with the read value from the value.
OrDataThe value to OR with the result of the AND operation.
Returns:
The new 16-bit value.
UINT32 EFIAPI BitFieldRead32 ( IN UINT32  Operand,
IN UINTN  StartBit,
IN UINTN  EndBit 
)

Returns a bit field from a 32-bit value.

Returns the bitfield specified by the StartBit and the EndBit from Operand.

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().

Parameters:
OperandOperand on which to perform the bitfield operation.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..31.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..31.
Returns:
The bit field read.
UINT32 EFIAPI BitFieldWrite32 ( IN UINT32  Operand,
IN UINTN  StartBit,
IN UINTN  EndBit,
IN UINT32  Value 
)

Writes a bit field to a 32-bit value, and returns the result.

Writes Value to the bit field specified by the StartBit and the EndBit in Operand. 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 Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters:
OperandOperand on which to perform the bitfield operation.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..31.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..31.
ValueNew value of the bit field.
Returns:
The new 32-bit value.
UINT32 EFIAPI BitFieldOr32 ( IN UINT32  Operand,
IN UINTN  StartBit,
IN UINTN  EndBit,
IN UINT32  OrData 
)

Reads a bit field from a 32-bit value, performs a bitwise OR, and returns the result.

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.

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 OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters:
OperandOperand on which to perform the bitfield operation.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..31.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..31.
OrDataThe value to OR with the read value from the value.
Returns:
The new 32-bit value.
UINT32 EFIAPI BitFieldAnd32 ( IN UINT32  Operand,
IN UINTN  StartBit,
IN UINTN  EndBit,
IN UINT32  AndData 
)

Reads a bit field from a 32-bit value, performs a bitwise AND, and returns the result.

Performs a bitwise AND between the bit field specified by StartBit and EndBit in Operand and the value specified by AndData. 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().

Parameters:
OperandOperand on which to perform the bitfield operation.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..31.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..31.
AndDataThe value to AND with the read value from the value
Returns:
The new 32-bit value.
UINT32 EFIAPI BitFieldAndThenOr32 ( IN UINT32  Operand,
IN UINTN  StartBit,
IN UINTN  EndBit,
IN UINT32  AndData,
IN UINT32  OrData 
)

Reads a bit field from a 32-bit value, performs a bitwise AND followed by a bitwise OR, and returns the result.

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 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().

Parameters:
OperandOperand on which to perform the bitfield operation.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..31.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..31.
AndDataThe value to AND with the read value from the value.
OrDataThe value to OR with the result of the AND operation.
Returns:
The new 32-bit value.
UINT64 EFIAPI BitFieldRead64 ( IN UINT64  Operand,
IN UINTN  StartBit,
IN UINTN  EndBit 
)

Returns a bit field from a 64-bit value.

Returns the bitfield specified by the StartBit and the EndBit from Operand.

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().

Parameters:
OperandOperand on which to perform the bitfield operation.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..63.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..63.
Returns:
The bit field read.
UINT64 EFIAPI BitFieldWrite64 ( IN UINT64  Operand,
IN UINTN  StartBit,
IN UINTN  EndBit,
IN UINT64  Value 
)

Writes a bit field to a 64-bit value, and returns the result.

Writes Value to the bit field specified by the StartBit and the EndBit in Operand. 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 Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters:
OperandOperand on which to perform the bitfield operation.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..63.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..63.
ValueNew value of the bit field.
Returns:
The new 64-bit value.
UINT64 EFIAPI BitFieldOr64 ( IN UINT64  Operand,
IN UINTN  StartBit,
IN UINTN  EndBit,
IN UINT64  OrData 
)

Reads a bit field from a 64-bit value, performs a bitwise OR, and returns the result.

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.

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 OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().

Parameters:
OperandOperand on which to perform the bitfield operation.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..63.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..63.
OrDataThe value to OR with the read value from the value
Returns:
The new 64-bit value.
UINT64 EFIAPI BitFieldAnd64 ( IN UINT64  Operand,
IN UINTN  StartBit,
IN UINTN  EndBit,
IN UINT64  AndData 
)

Reads a bit field from a 64-bit value, performs a bitwise AND, and returns the result.

Performs a bitwise AND between the bit field specified by StartBit and EndBit in Operand and the value specified by AndData. 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().

Parameters:
OperandOperand on which to perform the bitfield operation.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..63.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..63.
AndDataThe value to AND with the read value from the value
Returns:
The new 64-bit value.
UINT64 EFIAPI BitFieldAndThenOr64 ( IN UINT64  Operand,
IN UINTN  StartBit,
IN UINTN  EndBit,
IN UINT64  AndData,
IN UINT64  OrData 
)

Reads a bit field from a 64-bit value, performs a bitwise AND followed by a bitwise OR, and returns the result.

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 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().

Parameters:
OperandOperand on which to perform the bitfield operation.
StartBitThe ordinal of the least significant bit in the bit field. Range 0..63.
EndBitThe ordinal of the most significant bit in the bit field. Range 0..63.
AndDataThe value to AND with the read value from the value.
OrDataThe value to OR with the result of the AND operation.
Returns:
The new 64-bit value.
UINT8 EFIAPI CalculateSum8 ( IN CONST UINT8 Buffer,
IN UINTN  Length 
)

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 in unit of UINT8. The carry bits in result of addition are dropped. The result is returned as UINT8. If Length is Zero, then Zero is returned.

If Buffer is NULL, then ASSERT(). If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().

Parameters:
BufferThe pointer to the buffer to carry out the sum operation.
LengthThe size, in bytes, of Buffer.
Returns:
Sum The sum of Buffer with carry bits dropped during additions.
UINT8 EFIAPI CalculateCheckSum8 ( IN CONST UINT8 Buffer,
IN UINTN  Length 
)

Returns the two's complement checksum of all elements in a buffer of 8-bit values.

This function first calculates the sum of the 8-bit values in the buffer specified by Buffer and Length. The carry bits in the result of addition are dropped. Then, the two's complement of the sum is returned. If Length is 0, then 0 is returned.

If Buffer is NULL, then ASSERT(). If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().

Parameters:
BufferThe pointer to the buffer to carry out the checksum operation.
LengthThe size, in bytes, of Buffer.
Returns:
Checksum The two's complement checksum of Buffer.
UINT16 EFIAPI CalculateSum16 ( IN CONST UINT16 Buffer,
IN UINTN  Length 
)

Returns the sum of all elements in a buffer of 16-bit values.

During calculation, the carry bits are dropped.

This function calculates the sum of the 16-bit values in the buffer specified by Buffer and Length. The carry bits in result of addition are dropped. The 16-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 16-bit boundary, then ASSERT(). If Length is not aligned on a 16-bit boundary, then ASSERT(). If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().

Parameters:
BufferThe pointer to the buffer to carry out the sum operation.
LengthThe size, in bytes, of Buffer.
Returns:
Sum The sum of Buffer with carry bits dropped during additions.
UINT16 EFIAPI CalculateCheckSum16 ( IN CONST UINT16 Buffer,
IN UINTN  Length 
)

Returns the two's complement checksum of all elements in a buffer of 16-bit values.

This function first calculates the sum of the 16-bit values in the buffer specified by Buffer and Length. The carry bits in the result of addition are dropped. Then, the two's complement of the sum is returned. If Length is 0, then 0 is returned.

If Buffer is NULL, then ASSERT(). If Buffer is not aligned on a 16-bit boundary, then ASSERT(). If Length is not aligned on a 16-bit boundary, then ASSERT(). If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().

Parameters:
BufferThe pointer to the buffer to carry out the checksum operation.
LengthThe size, in bytes, of Buffer.
Returns:
Checksum The two's complement checksum of Buffer.
UINT32 EFIAPI CalculateSum32 ( IN CONST UINT32 Buffer,
IN UINTN  Length 
)

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.

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().

Parameters:
BufferThe pointer to the buffer to carry out the sum operation.
LengthThe size, in bytes, of Buffer.
Returns:
Sum The sum of Buffer with carry bits dropped during additions.
UINT32 EFIAPI CalculateCheckSum32 ( IN CONST UINT32 Buffer,
IN UINTN  Length 
)

Returns the two's complement checksum of all elements in a buffer of 32-bit values.

This function first calculates the sum of the 32-bit values in the buffer specified by Buffer and Length. The carry bits in the result of addition are dropped. Then, the two's complement of the sum 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().

Parameters:
BufferThe pointer to the buffer to carry out the checksum operation.
LengthThe size, in bytes, of Buffer.
Returns:
Checksum The two's complement checksum of Buffer.
UINT64 EFIAPI CalculateSum64 ( IN CONST UINT64 Buffer,
IN UINTN  Length 
)

Returns the sum of all elements in a buffer of 64-bit values.

During calculation, the carry bits are dropped.

This function calculates the sum of the 64-bit values in the buffer specified by Buffer and Length. The carry bits in result of addition are dropped. The 64-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 64-bit boundary, then ASSERT(). If Length is not aligned on a 64-bit boundary, then ASSERT(). If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().

Parameters:
BufferThe pointer to the buffer to carry out the sum operation.
LengthThe size, in bytes, of Buffer.
Returns:
Sum The sum of Buffer with carry bits dropped during additions.
UINT64 EFIAPI CalculateCheckSum64 ( IN CONST UINT64 Buffer,
IN UINTN  Length 
)

Returns the two's complement checksum of all elements in a buffer of 64-bit values.

This function first calculates the sum of the 64-bit values in the buffer specified by Buffer and Length. The carry bits in the result of addition are dropped. Then, the two's complement of the sum is returned. If Length is 0, then 0 is returned.

If Buffer is NULL, then ASSERT(). If Buffer is not aligned on a 64-bit boundary, then ASSERT(). If Length is not aligned on a 64-bit boundary, then ASSERT(). If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().

Parameters:
BufferThe pointer to the buffer to carry out the checksum operation.
LengthThe size, in bytes, of Buffer.
Returns:
Checksum The two's complement checksum of Buffer.

Used to serialize load and store operations.

All loads and stores that proceed calls to this function are guaranteed to be globally visible when this function returns.

UINTN EFIAPI SetJump ( OUT BASE_LIBRARY_JUMP_BUFFER *  JumpBuffer)

Saves the current CPU context that can be restored with a call to LongJump() and returns 0.

Saves the current CPU context in the buffer specified by JumpBuffer and returns 0. The initial call to SetJump() must always return 0. Subsequent calls to LongJump() cause a non-zero value to be returned by SetJump().

If JumpBuffer is NULL, 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.

Parameters:
JumpBufferA pointer to CPU context buffer.
Return values:
0Indicates a return from SetJump().
VOID EFIAPI LongJump ( IN BASE_LIBRARY_JUMP_BUFFER *  JumpBuffer,
IN UINTN  Value 
)

Restores the CPU context that was saved with SetJump().

Restores the CPU context from the buffer specified by JumpBuffer. This function never returns to the caller. Instead is resumes execution based on the state of JumpBuffer.

If JumpBuffer is NULL, then ASSERT(). For Itanium processors, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT(). If Value is 0, then ASSERT().

Parameters:
JumpBufferA pointer to CPU context buffer.
ValueThe value to return when the SetJump() context is restored and must be non-zero.

Enables CPU interrupts.

Disables CPU interrupts.

Disables CPU interrupts and returns the interrupt state prior to the disable operation.

Return values:
TRUECPU interrupts were enabled on entry to this call.
FALSECPU interrupts were disabled on entry to this call.

Enables CPU interrupts for the smallest window required to capture any pending interrupts.

Retrieves the current CPU interrupt state.

Returns TRUE if interrupts are currently enabled. Otherwise returns FALSE.

Return values:
TRUECPU interrupts are enabled.
FALSECPU interrupts are disabled.
BOOLEAN EFIAPI SetInterruptState ( IN BOOLEAN  InterruptState)

Set the current CPU interrupt state.

Sets the current CPU interrupt state to the state specified by InterruptState. If InterruptState is TRUE, then interrupts are enabled. If InterruptState is FALSE, then interrupts are disabled. InterruptState is returned.

Parameters:
InterruptStateTRUE if interrupts should enabled. FALSE if interrupts should be disabled.
Returns:
InterruptState

Requests CPU to pause for a short period of time.

Requests CPU to pause for a short period of time. Typically used in MP systems to prevent memory starvation while waiting for a spin lock.

VOID EFIAPI SwitchStack ( IN SWITCH_STACK_ENTRY_POINT  EntryPoint,
IN VOID Context1,
OPTIONAL IN VOID Context2,
OPTIONAL IN VOID NewStack,
  ... 
)

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. This function supports a variable number of arguments following the NewStack parameter. 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(). If NewStack is NULL, then ASSERT().

Parameters:
EntryPointA pointer to function to call with the new stack.
Context1A pointer to the context to pass into the EntryPoint function.
Context2A pointer to the context to pass into the EntryPoint function.
NewStackA pointer to the new stack to use for the EntryPoint function.
...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.

Generates a breakpoint on the CPU.

Generates a breakpoint on the CPU. The breakpoint must be implemented such that code can resume normal execution after the breakpoint.

Executes an infinite loop.

Forces the CPU to execute an infinite loop. A debugger may be used to skip past the loop and the code that follows the loop must execute properly. This implies that the infinite loop must not cause the code that follow it to be optimized away.