Macros
#define	GUID_STRING_LENGTH 36

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

#define	BASE_LIST_FOR_EACH(Entry, ListHead) for(Entry = (ListHead)->ForwardLink; Entry != (ListHead); Entry = Entry->ForwardLink)

#define	BASE_LIST_FOR_EACH_SAFE(Entry, NextEntry, ListHead)

#define	CRC16ANSI_INIT 0xffff

Typedefs
typedef INTN(EFIAPI *	BASE_SORT_COMPARE) (IN CONST VOID Buffer1, IN CONST VOID Buffer2)

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

Functions
UINTN EFIAPI	StrnLenS (IN CONST CHAR16 *String, IN UINTN MaxSize)

UINTN EFIAPI	StrnSizeS (IN CONST CHAR16 *String, IN UINTN MaxSize)

RETURN_STATUS EFIAPI	StrCpyS (OUT CHAR16 Destination, IN UINTN DestMax, IN CONST CHAR16 Source)

RETURN_STATUS EFIAPI	StrnCpyS (OUT CHAR16 Destination, IN UINTN DestMax, IN CONST CHAR16 Source, IN UINTN Length)

RETURN_STATUS EFIAPI	StrCatS (IN OUT CHAR16 Destination, IN UINTN DestMax, IN CONST CHAR16 Source)

RETURN_STATUS EFIAPI	StrnCatS (IN OUT CHAR16 Destination, IN UINTN DestMax, IN CONST CHAR16 Source, IN UINTN Length)

RETURN_STATUS EFIAPI	StrDecimalToUintnS (IN CONST CHAR16 String, OUT CHAR16 EndPointer OPTIONAL, OUT UINTN Data)

RETURN_STATUS EFIAPI	StrDecimalToUint64S (IN CONST CHAR16 String, OUT CHAR16 EndPointer OPTIONAL, OUT UINT64 Data)

RETURN_STATUS EFIAPI	StrHexToUintnS (IN CONST CHAR16 String, OUT CHAR16 EndPointer OPTIONAL, OUT UINTN Data)

RETURN_STATUS EFIAPI	StrHexToUint64S (IN CONST CHAR16 String, OUT CHAR16 EndPointer OPTIONAL, OUT UINT64 Data)

UINTN EFIAPI	AsciiStrnLenS (IN CONST CHAR8 *String, IN UINTN MaxSize)

UINTN EFIAPI	AsciiStrnSizeS (IN CONST CHAR8 *String, IN UINTN MaxSize)

RETURN_STATUS EFIAPI	AsciiStrCpyS (OUT CHAR8 Destination, IN UINTN DestMax, IN CONST CHAR8 Source)

RETURN_STATUS EFIAPI	AsciiStrnCpyS (OUT CHAR8 Destination, IN UINTN DestMax, IN CONST CHAR8 Source, IN UINTN Length)

RETURN_STATUS EFIAPI	AsciiStrCatS (IN OUT CHAR8 Destination, IN UINTN DestMax, IN CONST CHAR8 Source)

RETURN_STATUS EFIAPI	AsciiStrnCatS (IN OUT CHAR8 Destination, IN UINTN DestMax, IN CONST CHAR8 Source, IN UINTN Length)

RETURN_STATUS EFIAPI	AsciiStrDecimalToUintnS (IN CONST CHAR8 String, OUT CHAR8 EndPointer OPTIONAL, OUT UINTN Data)

RETURN_STATUS EFIAPI	AsciiStrDecimalToUint64S (IN CONST CHAR8 String, OUT CHAR8 EndPointer OPTIONAL, OUT UINT64 Data)

RETURN_STATUS EFIAPI	AsciiStrHexToUintnS (IN CONST CHAR8 String, OUT CHAR8 EndPointer OPTIONAL, OUT UINTN Data)

RETURN_STATUS EFIAPI	AsciiStrHexToUint64S (IN CONST CHAR8 String, OUT CHAR8 EndPointer OPTIONAL, OUT UINT64 Data)

UINTN EFIAPI	StrLen (IN CONST CHAR16 *String)

UINTN EFIAPI	StrSize (IN CONST CHAR16 *String)

INTN EFIAPI	StrCmp (IN CONST CHAR16 FirstString, IN CONST CHAR16 SecondString)

INTN EFIAPI	StrnCmp (IN CONST CHAR16 FirstString, IN CONST CHAR16 SecondString, IN UINTN Length)

CHAR16 *EFIAPI	StrStr (IN CONST CHAR16 String, IN CONST CHAR16 SearchString)

UINTN EFIAPI	StrDecimalToUintn (IN CONST CHAR16 *String)

UINT64 EFIAPI	StrDecimalToUint64 (IN CONST CHAR16 *String)

UINTN EFIAPI	StrHexToUintn (IN CONST CHAR16 *String)

UINT64 EFIAPI	StrHexToUint64 (IN CONST CHAR16 *String)

RETURN_STATUS EFIAPI	StrToIpv6Address (IN CONST CHAR16 String, OUT CHAR16 EndPointer OPTIONAL, OUT IPv6_ADDRESS Address, OUT UINT8 *PrefixLength OPTIONAL)

RETURN_STATUS EFIAPI	StrToIpv4Address (IN CONST CHAR16 String, OUT CHAR16 EndPointer OPTIONAL, OUT IPv4_ADDRESS Address, OUT UINT8 *PrefixLength OPTIONAL)

RETURN_STATUS EFIAPI	StrToGuid (IN CONST CHAR16 String, OUT GUID Guid)

RETURN_STATUS EFIAPI	StrHexToBytes (IN CONST CHAR16 String, IN UINTN Length, OUT UINT8 Buffer, IN UINTN MaxBufferSize)

RETURN_STATUS EFIAPI	UnicodeStrToAsciiStrS (IN CONST CHAR16 Source, OUT CHAR8 Destination, IN UINTN DestMax)

RETURN_STATUS EFIAPI	UnicodeStrnToAsciiStrS (IN CONST CHAR16 Source, IN UINTN Length, OUT CHAR8 Destination, IN UINTN DestMax, OUT UINTN *DestinationLength)

UINTN EFIAPI	AsciiStrLen (IN CONST CHAR8 *String)

UINTN EFIAPI	AsciiStrSize (IN CONST CHAR8 *String)

INTN EFIAPI	AsciiStrCmp (IN CONST CHAR8 FirstString, IN CONST CHAR8 SecondString)

INTN EFIAPI	AsciiStriCmp (IN CONST CHAR8 FirstString, IN CONST CHAR8 SecondString)

INTN EFIAPI	AsciiStrnCmp (IN CONST CHAR8 FirstString, IN CONST CHAR8 SecondString, IN UINTN Length)

CHAR8 *EFIAPI	AsciiStrStr (IN CONST CHAR8 String, IN CONST CHAR8 SearchString)

UINTN EFIAPI	AsciiStrDecimalToUintn (IN CONST CHAR8 *String)

UINT64 EFIAPI	AsciiStrDecimalToUint64 (IN CONST CHAR8 *String)

UINTN EFIAPI	AsciiStrHexToUintn (IN CONST CHAR8 *String)

UINT64 EFIAPI	AsciiStrHexToUint64 (IN CONST CHAR8 *String)

RETURN_STATUS EFIAPI	AsciiStrToIpv6Address (IN CONST CHAR8 String, OUT CHAR8 EndPointer OPTIONAL, OUT IPv6_ADDRESS Address, OUT UINT8 *PrefixLength OPTIONAL)

RETURN_STATUS EFIAPI	AsciiStrToIpv4Address (IN CONST CHAR8 String, OUT CHAR8 EndPointer OPTIONAL, OUT IPv4_ADDRESS Address, OUT UINT8 *PrefixLength OPTIONAL)

RETURN_STATUS EFIAPI	AsciiStrToGuid (IN CONST CHAR8 String, OUT GUID Guid)

RETURN_STATUS EFIAPI	AsciiStrHexToBytes (IN CONST CHAR8 String, IN UINTN Length, OUT UINT8 Buffer, IN UINTN MaxBufferSize)

RETURN_STATUS EFIAPI	AsciiStrToUnicodeStrS (IN CONST CHAR8 Source, OUT CHAR16 Destination, IN UINTN DestMax)

RETURN_STATUS EFIAPI	AsciiStrnToUnicodeStrS (IN CONST CHAR8 Source, IN UINTN Length, OUT CHAR16 Destination, IN UINTN DestMax, OUT UINTN *DestinationLength)

CHAR16 EFIAPI	CharToUpper (IN CHAR16 Char)

CHAR8 EFIAPI	AsciiCharToUpper (IN CHAR8 Chr)

RETURN_STATUS EFIAPI	Base64Encode (IN CONST UINT8 Source, IN UINTN SourceLength, OUT CHAR8 Destination OPTIONAL, IN OUT UINTN *DestinationSize)

RETURN_STATUS EFIAPI	Base64Decode (IN CONST CHAR8 Source OPTIONAL, IN UINTN SourceSize, OUT UINT8 Destination OPTIONAL, IN OUT UINTN *DestinationSize)

UINT8 EFIAPI	DecimalToBcd8 (IN UINT8 Value)

UINT8 EFIAPI	BcdToDecimal8 (IN UINT8 Value)

BOOLEAN EFIAPI	PathRemoveLastItem (IN OUT CHAR16 *Path)

CHAR16 *EFIAPI	PathCleanUpDirectories (IN CHAR16 *Path)

BOOLEAN EFIAPI	IsNodeInList (IN CONST LIST_ENTRY FirstEntry, IN CONST LIST_ENTRY SecondEntry)

LIST_ENTRY *EFIAPI	InitializeListHead (IN OUT LIST_ENTRY *ListHead)

LIST_ENTRY *EFIAPI	InsertHeadList (IN OUT LIST_ENTRY ListHead, IN OUT LIST_ENTRY Entry)

LIST_ENTRY *EFIAPI	InsertTailList (IN OUT LIST_ENTRY ListHead, IN OUT LIST_ENTRY Entry)

LIST_ENTRY *EFIAPI	GetFirstNode (IN CONST LIST_ENTRY *List)

LIST_ENTRY *EFIAPI	GetNextNode (IN CONST LIST_ENTRY List, IN CONST LIST_ENTRY Node)

LIST_ENTRY *EFIAPI	GetPreviousNode (IN CONST LIST_ENTRY List, IN CONST LIST_ENTRY Node)

BOOLEAN EFIAPI	IsListEmpty (IN CONST LIST_ENTRY *ListHead)

BOOLEAN EFIAPI	IsNull (IN CONST LIST_ENTRY List, IN CONST LIST_ENTRY Node)

BOOLEAN EFIAPI	IsNodeAtEnd (IN CONST LIST_ENTRY List, IN CONST LIST_ENTRY Node)

LIST_ENTRY *EFIAPI	SwapListEntries (IN OUT LIST_ENTRY FirstEntry, IN OUT LIST_ENTRY SecondEntry)

LIST_ENTRY *EFIAPI	RemoveEntryList (IN CONST LIST_ENTRY *Entry)

VOID EFIAPI	QuickSort (IN OUT VOID BufferToSort, IN CONST UINTN Count, IN CONST UINTN ElementSize, IN BASE_SORT_COMPARE CompareFunction, OUT VOID BufferOneElement)

UINT64 EFIAPI	LShiftU64 (IN UINT64 Operand, IN UINTN Count)

UINT64 EFIAPI	RShiftU64 (IN UINT64 Operand, IN UINTN Count)

UINT64 EFIAPI	ARShiftU64 (IN UINT64 Operand, IN UINTN Count)

UINT32 EFIAPI	LRotU32 (IN UINT32 Operand, IN UINTN Count)

UINT32 EFIAPI	RRotU32 (IN UINT32 Operand, IN UINTN Count)

UINT64 EFIAPI	LRotU64 (IN UINT64 Operand, IN UINTN Count)

UINT64 EFIAPI	RRotU64 (IN UINT64 Operand, IN UINTN Count)

INTN EFIAPI	LowBitSet32 (IN UINT32 Operand)

INTN EFIAPI	LowBitSet64 (IN UINT64 Operand)

INTN EFIAPI	HighBitSet32 (IN UINT32 Operand)

INTN EFIAPI	HighBitSet64 (IN UINT64 Operand)

UINT32 EFIAPI	GetPowerOfTwo32 (IN UINT32 Operand)

UINT64 EFIAPI	GetPowerOfTwo64 (IN UINT64 Operand)

UINT16 EFIAPI	SwapBytes16 (IN UINT16 Value)

UINT32 EFIAPI	SwapBytes32 (IN UINT32 Value)

UINT64 EFIAPI	SwapBytes64 (IN UINT64 Value)

UINT64 EFIAPI	MultU64x32 (IN UINT64 Multiplicand, IN UINT32 Multiplier)

UINT64 EFIAPI	MultU64x64 (IN UINT64 Multiplicand, IN UINT64 Multiplier)

INT64 EFIAPI	MultS64x64 (IN INT64 Multiplicand, IN INT64 Multiplier)

UINT64 EFIAPI	DivU64x32 (IN UINT64 Dividend, IN UINT32 Divisor)

UINT32 EFIAPI	ModU64x32 (IN UINT64 Dividend, IN UINT32 Divisor)

UINT64 EFIAPI	DivU64x32Remainder (IN UINT64 Dividend, IN UINT32 Divisor, OUT UINT32 *Remainder OPTIONAL)

UINT64 EFIAPI	DivU64x64Remainder (IN UINT64 Dividend, IN UINT64 Divisor, OUT UINT64 *Remainder OPTIONAL)

INT64 EFIAPI	DivS64x64Remainder (IN INT64 Dividend, IN INT64 Divisor, OUT INT64 *Remainder OPTIONAL)

UINT16 EFIAPI	ReadUnaligned16 (IN CONST UINT16 *Buffer)

UINT16 EFIAPI	WriteUnaligned16 (OUT UINT16 *Buffer, IN UINT16 Value)

UINT32 EFIAPI	ReadUnaligned24 (IN CONST UINT32 *Buffer)

UINT32 EFIAPI	WriteUnaligned24 (OUT UINT32 *Buffer, IN UINT32 Value)

UINT32 EFIAPI	ReadUnaligned32 (IN CONST UINT32 *Buffer)

UINT32 EFIAPI	WriteUnaligned32 (OUT UINT32 *Buffer, IN UINT32 Value)

UINT64 EFIAPI	ReadUnaligned64 (IN CONST UINT64 *Buffer)

UINT64 EFIAPI	WriteUnaligned64 (OUT UINT64 *Buffer, IN UINT64 Value)

UINT8 EFIAPI	BitFieldRead8 (IN UINT8 Operand, IN UINTN StartBit, IN UINTN EndBit)

UINT8 EFIAPI	BitFieldWrite8 (IN UINT8 Operand, IN UINTN StartBit, IN UINTN EndBit, IN UINT8 Value)

UINT8 EFIAPI	BitFieldOr8 (IN UINT8 Operand, IN UINTN StartBit, IN UINTN EndBit, IN UINT8 OrData)

UINT8 EFIAPI	BitFieldAnd8 (IN UINT8 Operand, IN UINTN StartBit, IN UINTN EndBit, IN UINT8 AndData)

UINT8 EFIAPI	BitFieldAndThenOr8 (IN UINT8 Operand, IN UINTN StartBit, IN UINTN EndBit, IN UINT8 AndData, IN UINT8 OrData)

UINT16 EFIAPI	BitFieldRead16 (IN UINT16 Operand, IN UINTN StartBit, IN UINTN EndBit)

UINT16 EFIAPI	BitFieldWrite16 (IN UINT16 Operand, IN UINTN StartBit, IN UINTN EndBit, IN UINT16 Value)

UINT16 EFIAPI	BitFieldOr16 (IN UINT16 Operand, IN UINTN StartBit, IN UINTN EndBit, IN UINT16 OrData)

UINT16 EFIAPI	BitFieldAnd16 (IN UINT16 Operand, IN UINTN StartBit, IN UINTN EndBit, IN UINT16 AndData)

UINT16 EFIAPI	BitFieldAndThenOr16 (IN UINT16 Operand, IN UINTN StartBit, IN UINTN EndBit, IN UINT16 AndData, IN UINT16 OrData)

UINT32 EFIAPI	BitFieldRead32 (IN UINT32 Operand, IN UINTN StartBit, IN UINTN EndBit)

UINT32 EFIAPI	BitFieldWrite32 (IN UINT32 Operand, IN UINTN StartBit, IN UINTN EndBit, IN UINT32 Value)

UINT32 EFIAPI	BitFieldOr32 (IN UINT32 Operand, IN UINTN StartBit, IN UINTN EndBit, IN UINT32 OrData)

UINT32 EFIAPI	BitFieldAnd32 (IN UINT32 Operand, IN UINTN StartBit, IN UINTN EndBit, IN UINT32 AndData)

UINT32 EFIAPI	BitFieldAndThenOr32 (IN UINT32 Operand, IN UINTN StartBit, IN UINTN EndBit, IN UINT32 AndData, IN UINT32 OrData)

UINT64 EFIAPI	BitFieldRead64 (IN UINT64 Operand, IN UINTN StartBit, IN UINTN EndBit)

UINT64 EFIAPI	BitFieldWrite64 (IN UINT64 Operand, IN UINTN StartBit, IN UINTN EndBit, IN UINT64 Value)

UINT64 EFIAPI	BitFieldOr64 (IN UINT64 Operand, IN UINTN StartBit, IN UINTN EndBit, IN UINT64 OrData)

UINT64 EFIAPI	BitFieldAnd64 (IN UINT64 Operand, IN UINTN StartBit, IN UINTN EndBit, IN UINT64 AndData)

UINT64 EFIAPI	BitFieldAndThenOr64 (IN UINT64 Operand, IN UINTN StartBit, IN UINTN EndBit, IN UINT64 AndData, IN UINT64 OrData)

UINT8 EFIAPI	BitFieldCountOnes32 (IN UINT32 Operand, IN UINTN StartBit, IN UINTN EndBit)

UINT8 EFIAPI	BitFieldCountOnes64 (IN UINT64 Operand, IN UINTN StartBit, IN UINTN EndBit)

UINT8 EFIAPI	CalculateSum8 (IN CONST UINT8 *Buffer, IN UINTN Length)

UINT8 EFIAPI	CalculateCheckSum8 (IN CONST UINT8 *Buffer, IN UINTN Length)

UINT16 EFIAPI	CalculateSum16 (IN CONST UINT16 *Buffer, IN UINTN Length)

UINT16 EFIAPI	CalculateCheckSum16 (IN CONST UINT16 *Buffer, IN UINTN Length)

UINT32 EFIAPI	CalculateSum32 (IN CONST UINT32 *Buffer, IN UINTN Length)

UINT32 EFIAPI	CalculateCheckSum32 (IN CONST UINT32 *Buffer, IN UINTN Length)

UINT64 EFIAPI	CalculateSum64 (IN CONST UINT64 *Buffer, IN UINTN Length)

UINT64 EFIAPI	CalculateCheckSum64 (IN CONST UINT64 *Buffer, IN UINTN Length)

UINT32 EFIAPI	CalculateCrc32 (IN VOID *Buffer, IN UINTN Length)

UINT16 EFIAPI	CalculateCrc16Ansi (IN CONST VOID *Buffer, IN UINTN Length, IN UINT16 InitialValue)

UINT32 EFIAPI	CalculateCrc32c (IN CONST VOID *Buffer, IN UINTN Length, IN UINT32 InitialValue)

UINT16 EFIAPI	CalculateCrc16CcittF (IN CONST VOID *Buffer, IN UINTN Length, IN UINT16 InitialValue)

VOID EFIAPI	MemoryFence (VOID)

RETURNS_TWICE UINTN EFIAPI	SetJump (OUT BASE_LIBRARY_JUMP_BUFFER *JumpBuffer)

VOID EFIAPI	LongJump (IN BASE_LIBRARY_JUMP_BUFFER *JumpBuffer, IN UINTN Value)

VOID EFIAPI	EnableInterrupts (VOID)

VOID EFIAPI	DisableInterrupts (VOID)

BOOLEAN EFIAPI	SaveAndDisableInterrupts (VOID)

VOID EFIAPI	EnableDisableInterrupts (VOID)

BOOLEAN EFIAPI	GetInterruptState (VOID)

BOOLEAN EFIAPI	SetInterruptState (IN BOOLEAN InterruptState)

VOID EFIAPI	CpuPause (VOID)

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

VOID EFIAPI	CpuBreakpoint (VOID)

VOID EFIAPI	CpuDeadLoop (VOID)

VOID EFIAPI	SpeculationBarrier (VOID)

UINTN EFIAPI	TdCall (IN UINT64 Leaf, IN UINT64 Arg1, IN UINT64 Arg2, IN UINT64 Arg3, IN OUT VOID *Results)

UINTN EFIAPI	TdVmCall (IN UINT64 Leaf, IN UINT64 Arg1, IN UINT64 Arg2, IN UINT64 Arg3, IN UINT64 Arg4, IN OUT VOID *Results)

BOOLEAN EFIAPI	TdIsEnabled (VOID)

Detailed Description

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

Copyright (c) 2006 - 2021, Intel Corporation. All rights reserved.
Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.
Copyright (c) Microsoft Corporation.
Portions Copyright (c) 2020, Hewlett Packard Enterprise Development LP. All rights reserved.
Portions Copyright (c) 2022, Loongson Technology Corporation Limited. All rights reserved.
Copyright (c) 2023 - 2024, Arm Limited. All rights reserved.

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file BaseLib.h.

Macro Definition Documentation

◆ BASE_LIST_FOR_EACH

#define BASE_LIST_FOR_EACH	(	Entry,
		ListHead
	)	for(Entry = (ListHead)->ForwardLink; Entry != (ListHead); Entry = Entry->ForwardLink)

Iterates over each node in a doubly linked list using each node's forward link.

Parameters

Entry	A pointer to a list node used as a loop cursor during iteration
ListHead	The head node of the doubly linked list

Definition at line 2913 of file BaseLib.h.

◆ BASE_LIST_FOR_EACH_SAFE

#define BASE_LIST_FOR_EACH_SAFE	(	Entry,
		NextEntry,
		ListHead
	)

Value:

for(Entry = (ListHead)->ForwardLink, NextEntry = Entry->ForwardLink;\

Entry != (ListHead); Entry = NextEntry, NextEntry = Entry->ForwardLink)

Iterates over each node in a doubly linked list using each node's forward link with safety against node removal.

This macro uses NextEntry to temporarily store the next list node so the node pointed to by Entry may be deleted in the current loop iteration step and iteration can continue from the node pointed to by NextEntry.

Parameters

Entry	A pointer to a list node used as a loop cursor during iteration
NextEntry	A pointer to a list node used to temporarily store the next node
ListHead	The head node of the doubly linked list

Definition at line 2929 of file BaseLib.h.

◆ CRC16ANSI_INIT

#define CRC16ANSI_INIT 0xffff

Definition at line 4971 of file BaseLib.h.

◆ GUID_STRING_LENGTH

#define GUID_STRING_LENGTH 36

Definition at line 1833 of file BaseLib.h.

◆ INITIALIZE_LIST_HEAD_VARIABLE

#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

ListHead The head note of a list to initialize.

Definition at line 2904 of file BaseLib.h.

Typedef Documentation

◆ BASE_SORT_COMPARE

typedef INTN(EFIAPI * BASE_SORT_COMPARE) (IN CONST VOID *Buffer1, IN CONST VOID *Buffer2)

Prototype for comparison function for any two element types.

Parameters

[in]	Buffer1	The pointer to first buffer.
[in]	Buffer2	The pointer to second buffer.

Return values

0	Buffer1 equal to Buffer2.

Returns: <0 Buffer1 is less than Buffer2.; >0 Buffer1 is greater than Buffer2.

Definition at line 3284 of file BaseLib.h.

◆ SWITCH_STACK_ENTRY_POINT

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

Context1	Context1 parameter passed into SwitchStack().
Context2	Context2 parameter passed into SwitchStack().

Definition at line 5018 of file BaseLib.h.

Function Documentation

◆ ARShiftU64()

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

Operand	The 64-bit operand to shift right.
Count	The number of bits to shift right.

Returns: Operand >> Count

Shifts a 64-bit integer right between 0 and 63 bits. The high bits are filled with the 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

Operand	The 64-bit operand to shift right.
Count	The number of bits to shift right.

Returns: Operand >> Count

Definition at line 28 of file ARShiftU64.c.

◆ AsciiCharToUpper()

CHAR8 EFIAPI AsciiCharToUpper ( IN CHAR8 Chr )

Converts a lowercase Ascii character to upper one.

If Chr is lowercase Ascii character, then converts it to upper one.

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

Parameters

Chr	one Ascii character

Returns: The uppercase value of Ascii character

Definition at line 750 of file String.c.

◆ AsciiStrCatS()

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 is returned, then the Destination is unmodified.

Parameters

Destination	A pointer to a Null-terminated Ascii string.
DestMax	The maximum number of Destination Ascii char, including terminating null char.
Source	A pointer to a Null-terminated Ascii string.

Return values

RETURN_SUCCESS	String is appended.
RETURN_BAD_BUFFER_SIZE	If DestMax is NOT greater than StrLen(Destination).
RETURN_BUFFER_TOO_SMALL	If (DestMax - StrLen(Destination)) is NOT greater than StrLen(Source).
RETURN_INVALID_PARAMETER	If Destination is NULL. If Source is NULL. If PcdMaximumAsciiStringLength is not zero, and DestMax is greater than PcdMaximumAsciiStringLength. If DestMax is 0.
RETURN_ACCESS_DENIED	If Source and Destination overlap.

Definition at line 1964 of file SafeString.c.

◆ AsciiStrCmp()

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

FirstString	The pointer to a Null-terminated ASCII string.
SecondString	The pointer to a Null-terminated ASCII string.

Return values

==0	FirstString is identical to SecondString.
!=0	FirstString is not identical to 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

FirstString	A pointer to a Null-terminated ASCII string.
SecondString	A pointer to a Null-terminated ASCII string.

Return values

==0	FirstString is identical to SecondString.
!=0	FirstString is not identical to SecondString.

Definition at line 716 of file String.c.

◆ AsciiStrCpyS()

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 is returned, then the Destination is unmodified.

Parameters

Destination	A pointer to a Null-terminated Ascii string.
DestMax	The maximum number of Destination Ascii char, including terminating null char.
Source	A pointer to a Null-terminated Ascii string.

Return values

RETURN_SUCCESS	String is copied.
RETURN_BUFFER_TOO_SMALL	If DestMax is NOT greater than StrLen(Source).
RETURN_INVALID_PARAMETER	If Destination is NULL. If Source is NULL. If PcdMaximumAsciiStringLength is not zero, and DestMax is greater than PcdMaximumAsciiStringLength. If DestMax is 0.
RETURN_ACCESS_DENIED	If Source and Destination overlap.

Definition at line 1797 of file SafeString.c.

◆ AsciiStrDecimalToUint64()

UINT64 EFIAPI AsciiStrDecimalToUint64 ( IN CONST CHAR8 * 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

String The pointer to a Null-terminated ASCII string.

Return values

Value 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

String A pointer to a Null-terminated ASCII string.

Return values

Value translated from String.

Definition at line 1053 of file String.c.

◆ AsciiStrDecimalToUint64S()

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

String	Pointer to a Null-terminated Ascii string.
EndPointer	Pointer to character that stops scan.
Data	Pointer to the converted value.

Return values

RETURN_SUCCESS	Value is translated from String.
RETURN_INVALID_PARAMETER	If String is NULL. If Data is NULL. If PcdMaximumAsciiStringLength is not zero, and String contains more than PcdMaximumAsciiStringLength Ascii characters, not including the Null-terminator.
RETURN_UNSUPPORTED	If the number represented by String exceeds the range defined by UINT64.

Definition at line 2287 of file SafeString.c.

◆ AsciiStrDecimalToUintn()

UINTN EFIAPI AsciiStrDecimalToUintn ( IN CONST CHAR8 * 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

String The pointer to a Null-terminated ASCII string.

Return values

The	value translated from 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

String A pointer to a Null-terminated ASCII string.

Return values

Value translated from String.

Definition at line 1006 of file String.c.

◆ AsciiStrDecimalToUintnS()

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

String	Pointer to a Null-terminated Ascii string.
EndPointer	Pointer to character that stops scan.
Data	Pointer to the converted value.

Return values

RETURN_SUCCESS	Value is translated from String.
RETURN_INVALID_PARAMETER	If String is NULL. If Data is NULL. If PcdMaximumAsciiStringLength is not zero, and String contains more than PcdMaximumAsciiStringLength Ascii characters, not including the Null-terminator.
RETURN_UNSUPPORTED	If the number represented by String exceeds the range defined by UINTN.

Definition at line 2179 of file SafeString.c.

◆ AsciiStrHexToBytes()

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.

Parameters

String	Pointer to a Null-terminated ASCII string.
Length	The number of ASCII characters to decode.
Buffer	Pointer to the converted bytes array.
MaxBufferSize	The maximum size of Buffer.

Return values

RETURN_SUCCESS	Buffer is translated from String.
RETURN_INVALID_PARAMETER	If String is NULL. If Data is NULL. If Length is not multiple of 2. If PcdMaximumAsciiStringLength is not zero, and Length is greater than PcdMaximumAsciiStringLength.
RETURN_UNSUPPORTED	If Length of characters from String contain a character that is not valid hexadecimal digit characters, or a Null-terminator.
RETURN_BUFFER_TOO_SMALL	If MaxBufferSize is less than (Length / 2).

Definition at line 3569 of file SafeString.c.

◆ AsciiStrHexToUint64()

UINT64 EFIAPI AsciiStrHexToUint64 ( IN CONST CHAR8 * 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

String The pointer to a Null-terminated ASCII string.

Return values

Value translated 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

String A pointer to a Null-terminated ASCII string.

Return values

Value translated from String.

Definition at line 1155 of file String.c.

◆ AsciiStrHexToUint64S()

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

String	Pointer to a Null-terminated Ascii string.
EndPointer	Pointer to character that stops scan.
Data	Pointer to the converted value.

Return values

RETURN_SUCCESS	Value is translated from String.
RETURN_INVALID_PARAMETER	If String is NULL. If Data is NULL. If PcdMaximumAsciiStringLength is not zero, and String contains more than PcdMaximumAsciiStringLength Ascii characters, not including the Null-terminator.
RETURN_UNSUPPORTED	If the number represented by String exceeds the range defined by UINT64.

Definition at line 2527 of file SafeString.c.

◆ AsciiStrHexToUintn()

UINTN EFIAPI AsciiStrHexToUintn ( IN CONST CHAR8 * 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

String The pointer to a Null-terminated ASCII string.

Return values

Value translated 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

String A pointer to a Null-terminated ASCII string.

Return values

Value translated from String.

Definition at line 1104 of file String.c.

◆ AsciiStrHexToUintnS()

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

String	Pointer to a Null-terminated Ascii string.
EndPointer	Pointer to character that stops scan.
Data	Pointer to the converted value.

Return values

RETURN_SUCCESS	Value is translated from String.
RETURN_INVALID_PARAMETER	If String is NULL. If Data is NULL. If PcdMaximumAsciiStringLength is not zero, and String contains more than PcdMaximumAsciiStringLength Ascii characters, not including the Null-terminator.
RETURN_UNSUPPORTED	If the number represented by String exceeds the range defined by UINTN.

Definition at line 2399 of file SafeString.c.

◆ AsciiStriCmp()

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

FirstString	The pointer to a Null-terminated ASCII string.
SecondString	The pointer to a Null-terminated ASCII string.

Return values

==0	FirstString is identical to SecondString using case insensitive comparisons.
!=0	FirstString is not identical to SecondString using case insensitive comparisons.

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

FirstString	A pointer to a Null-terminated ASCII string.
SecondString	A pointer to a Null-terminated ASCII string.

Return values

==0	FirstString is identical to SecondString using case insensitive comparisons.
!=0	FirstString is not identical to SecondString using case insensitive comparisons.

Definition at line 814 of file String.c.

◆ AsciiStrLen()

UINTN EFIAPI AsciiStrLen ( IN CONST CHAR8 * String )

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

String The pointer to a Null-terminated ASCII string.

Returns: The length of String.

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

String A pointer to a Null-terminated ASCII string.

Returns: The length of String.

Definition at line 641 of file String.c.

◆ AsciiStrnCatS()

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 is returned, then the Destination is unmodified.

Parameters

Destination	A pointer to a Null-terminated Ascii string.
DestMax	The maximum number of Destination Ascii char, including terminating null char.
Source	A pointer to a Null-terminated Ascii string.
Length	The maximum number of Ascii characters to copy.

Return values

RETURN_SUCCESS	String is appended.
RETURN_BAD_BUFFER_SIZE	If DestMax is NOT greater than StrLen(Destination).
RETURN_BUFFER_TOO_SMALL	If (DestMax - StrLen(Destination)) is NOT greater than MIN(StrLen(Source), Length).
RETURN_INVALID_PARAMETER	If Destination is NULL. If Source is NULL. If PcdMaximumAsciiStringLength is not zero, and DestMax is greater than PcdMaximumAsciiStringLength. If DestMax is 0.
RETURN_ACCESS_DENIED	If Source and Destination overlap.

Definition at line 2060 of file SafeString.c.

◆ AsciiStrnCmp()

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

FirstString	The pointer to a Null-terminated ASCII string.
SecondString	The pointer to a Null-terminated ASCII string.
Length	The maximum number of ASCII characters for compare.

Return values

==0	FirstString is identical to SecondString.
!=0	FirstString is not identical to SecondString.

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

FirstString	A pointer to a Null-terminated ASCII string.
SecondString	A pointer to a Null-terminated ASCII string.
Length	The maximum number of ASCII characters for compare.

Return values

==0	FirstString is identical to SecondString.
!=0	FirstString is not identical to SecondString.

Definition at line 872 of file String.c.

◆ AsciiStrnCpyS()

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 is returned, then the Destination is unmodified.

Parameters

Destination	A pointer to a Null-terminated Ascii string.
DestMax	The maximum number of Destination Ascii char, including terminating null char.
Source	A pointer to a Null-terminated Ascii string.
Length	The maximum number of Ascii characters to copy.

Return values

RETURN_SUCCESS	String is copied.
RETURN_BUFFER_TOO_SMALL	If DestMax is NOT greater than MIN(StrLen(Source), Length).
RETURN_INVALID_PARAMETER	If Destination is NULL. If Source is NULL. If PcdMaximumAsciiStringLength is not zero, and DestMax is greater than PcdMaximumAsciiStringLength. If DestMax is 0.
RETURN_ACCESS_DENIED	If Source and Destination overlap.

Definition at line 1875 of file SafeString.c.

◆ AsciiStrnLenS()

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

String	A pointer to a Null-terminated Ascii string.
MaxSize	The maximum number of Destination Ascii char, including terminating null char.

Return values

0	If String is NULL.
MaxSize	If there is no null character in the first MaxSize characters of String.

Returns: The number of characters that percede the terminating null character.

Definition at line 1696 of file SafeString.c.

◆ AsciiStrnSizeS()

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

String	A pointer to a Null-terminated Ascii string.
MaxSize	The maximum number of Destination Ascii char, including the Null terminator.

Return values

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

Definition at line 1749 of file SafeString.c.

◆ AsciiStrnToUnicodeStrS()

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 is returned, then Destination and DestinationLength are unmodified.

Parameters

Source	The pointer to a Null-terminated Ascii string.
Length	The maximum number of Ascii characters to convert.
Destination	The pointer to a Null-terminated Unicode string.
DestMax	The maximum number of Destination Unicode char, including terminating null char.
DestinationLength	The number of Ascii characters converted.

Return values

RETURN_SUCCESS	String is converted.
RETURN_INVALID_PARAMETER	If Destination is NULL. If Source is NULL. If DestinationLength is NULL. If PcdMaximumUnicodeStringLength is not zero, and Length or DestMax is greater than PcdMaximumUnicodeStringLength. If PcdMaximumAsciiStringLength is not zero, and Length or DestMax is greater than PcdMaximumAsciiStringLength. If DestMax is 0.
RETURN_BUFFER_TOO_SMALL	If DestMax is NOT greater than MIN(AsciiStrLen(Source), Length).
RETURN_ACCESS_DENIED	If Source and Destination overlap.

Definition at line 2972 of file SafeString.c.

◆ AsciiStrSize()

UINTN EFIAPI AsciiStrSize ( IN CONST CHAR8 * 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

String The pointer to a Null-terminated ASCII string.

Returns: The size 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

String A pointer to a Null-terminated ASCII string.

Returns: The size of String.

Definition at line 681 of file String.c.

◆ AsciiStrStr()

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

String	The pointer to a Null-terminated ASCII string.
SearchString	The pointer to a Null-terminated ASCII string to search for.

Return values

NULL	If the SearchString does not appear in String.
others	If there is a match return the first occurrence of SearchingString. If the length of SearchString is zero,return String.

Returns the first occurrence of a Null-terminated ASCII sub-string in a Null-terminated ASCII string.

This function scans the contents of the ASCII string specified by String 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

String	A pointer to a Null-terminated ASCII string.
SearchString	A pointer to a Null-terminated ASCII string to search for.

Return values

NULL	If the SearchString does not appear in String.
others	If there is a match return the first occurrence of SearchingString. If the length of SearchString is zero,return String.

Definition at line 931 of file String.c.

◆ AsciiStrToGuid()

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]

Parameters

String	Pointer to a Null-terminated ASCII string.
Guid	Pointer to the converted GUID.

Return values

RETURN_SUCCESS	Guid is translated from String.
RETURN_INVALID_PARAMETER	If String is NULL. If Data is NULL.
RETURN_UNSUPPORTED	If String is not as the above format.

Definition at line 3458 of file SafeString.c.

◆ AsciiStrToIpv4Address()

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

String	Pointer to a Null-terminated ASCII string.
EndPointer	Pointer to character that stops scan.
Address	Pointer to the converted IPv4 address.
PrefixLength	Pointer to the converted IPv4 address prefix length. MAX_UINT8 is returned when /P is not in the String.

Return values

RETURN_SUCCESS	Address is translated from String.
RETURN_INVALID_PARAMETER	If String is NULL. If Data is NULL.
RETURN_UNSUPPORTED	If String is not in the correct format. If any decimal number converted from D exceeds 255. If the decimal number converted from P exceeds 32.

Definition at line 3313 of file SafeString.c.

◆ AsciiStrToIpv6Address()

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

String	Pointer to a Null-terminated ASCII string.
EndPointer	Pointer to character that stops scan.
Address	Pointer to the converted IPv6 address.
PrefixLength	Pointer to the converted IPv6 address prefix length. MAX_UINT8 is returned when /P is not in the String.

Return values

RETURN_SUCCESS	Address is translated from String.
RETURN_INVALID_PARAMETER	If String is NULL. If Data is NULL.
RETURN_UNSUPPORTED	If X contains more than four hexadecimal digit characters. If String contains "::" and number of X is not less than 8. If P starts with character that is not a valid decimal digit character. If the decimal number converted from P exceeds 128.

Definition at line 3095 of file SafeString.c.

◆ AsciiStrToUnicodeStrS()

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 is returned, then the Destination is unmodified.

Parameters

Source	The pointer to a Null-terminated ASCII string.
Destination	The pointer to a Null-terminated Unicode string.
DestMax	The maximum number of Destination Unicode char, including terminating null char.

Return values

RETURN_SUCCESS	String is converted.
RETURN_BUFFER_TOO_SMALL	If DestMax is NOT greater than StrLen(Source).
RETURN_INVALID_PARAMETER	If Destination is NULL. If Source is NULL. If PcdMaximumUnicodeStringLength is not zero, and DestMax is greater than PcdMaximumUnicodeStringLength. If PcdMaximumAsciiStringLength is not zero, and DestMax is greater than PcdMaximumAsciiStringLength. If DestMax is 0.
RETURN_ACCESS_DENIED	If Source and Destination overlap.

Definition at line 2873 of file SafeString.c.

◆ Base64Decode()

RETURN_STATUS EFIAPI Base64Decode	(	IN CONST CHAR8 *Source	OPTIONAL,
		IN UINTN	SourceSize,
		OUT UINT8 *Destination	OPTIONAL,
		IN OUT UINTN *	DestinationSize
	)

Decode Base64 ASCII encoded data to 8-bit binary representation, based on RFC4648.

Decoding occurs according to "Table 1: The Base 64 Alphabet" in RFC4648.

Whitespace is ignored at all positions:

0x09 ('\t') horizontal tab
0x0A ('
') new line
0x0B ('\v') vertical tab
0x0C ('\f') form feed
0x0D ('\r') carriage return
0x20 (' ') space

The minimum amount of required padding (with ASCII 0x3D, '=') is tolerated and enforced at the end of the Base64 ASCII encoded data, and only there.

Other characters outside of the encoding alphabet cause the function to reject the Base64 ASCII encoded data.

Parameters

[in]	Source	Array of CHAR8 elements containing the Base64 ASCII encoding. May be NULL if SourceSize is zero.
[in]	SourceSize	Number of CHAR8 elements in Source.
[out]	Destination	Array of UINT8 elements receiving the decoded 8-bit binary representation. Allocated by the caller. May be NULL if DestinationSize is zero on input. If NULL, decoding is performed, but the 8-bit binary representation is not stored. If non-NULL and the function returns an error, the contents of Destination are indeterminate.
[in,out]	DestinationSize	On input, the number of UINT8 elements that the caller allocated for Destination. On output, if the function returns RETURN_SUCCESS or RETURN_BUFFER_TOO_SMALL, the number of UINT8 elements that are required for decoding the Base64 ASCII representation. If the function returns a value different from both RETURN_SUCCESS and RETURN_BUFFER_TOO_SMALL, then DestinationSize is indeterminate on output.

Return values

RETURN_SUCCESS	SourceSize CHAR8 elements at Source have been decoded to on-output DestinationSize UINT8 elements at Destination. Note that RETURN_SUCCESS covers the case when DestinationSize is zero on input, and Source decodes to zero bytes (due to containing at most ignored whitespace).
RETURN_BUFFER_TOO_SMALL	The input value of DestinationSize is not large enough for decoding SourceSize CHAR8 elements at Source. The required number of UINT8 elements has been stored to DestinationSize.
RETURN_INVALID_PARAMETER	DestinationSize is NULL.
RETURN_INVALID_PARAMETER	Source is NULL, but SourceSize is not zero.
RETURN_INVALID_PARAMETER	Destination is NULL, but DestinationSize is not zero on input.
RETURN_INVALID_PARAMETER	Source is non-NULL, and (Source + SourceSize) would wrap around MAX_ADDRESS.
RETURN_INVALID_PARAMETER	Destination is non-NULL, and (Destination + DestinationSize) would wrap around MAX_ADDRESS, as specified on input.
RETURN_INVALID_PARAMETER	None of Source and Destination are NULL, and CHAR8[SourceSize] at Source overlaps UINT8[DestinationSize] at Destination, as specified on input.
RETURN_INVALID_PARAMETER	Invalid CHAR8 element encountered in Source.

Definition at line 1379 of file String.c.

◆ Base64Encode()

RETURN_STATUS EFIAPI Base64Encode	(	IN CONST UINT8 *	Source,
		IN UINTN	SourceLength,
		OUT CHAR8 *Destination	OPTIONAL,
		IN OUT UINTN *	DestinationSize
	)

Convert binary data to a Base64 encoded ascii string based on RFC4648.

Produce a Null-terminated Ascii string in the output buffer specified by Destination and DestinationSize. The Ascii string is produced by converting the data string specified by Source and SourceLength.

Parameters

Source	Input UINT8 data
SourceLength	Number of UINT8 bytes of data
Destination	Pointer to output string buffer
DestinationSize	Size of ascii buffer. Set to 0 to get the size needed. Caller is responsible for passing in buffer of DestinationSize

Return values

RETURN_SUCCESS	When ascii buffer is filled in.
RETURN_INVALID_PARAMETER	If Source is NULL or DestinationSize is NULL.
RETURN_INVALID_PARAMETER	If SourceLength or DestinationSize is bigger than (MAX_ADDRESS - (UINTN)Destination).
RETURN_BUFFER_TOO_SMALL	If SourceLength is 0 and DestinationSize is <1.
RETURN_BUFFER_TOO_SMALL	If Destination is NULL or DestinationSize is smaller than required buffersize.

Definition at line 1195 of file String.c.

◆ BcdToDecimal8()

UINT8 EFIAPI BcdToDecimal8 ( IN UINT8 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

Value The 8-bit BCD value to convert to an 8-bit value.

Returns: The 8-bit value is returned.

Definition at line 1677 of file String.c.

◆ BitFieldAnd16()

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

Operand	Operand on which to perform the bitfield operation.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..15.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..15.
AndData	The value to AND with the read value from the value

Returns: The new 16-bit value.

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

Operand	Operand on which to perform the bitfield operation.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..15.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..15.
AndData	The value to AND with the read value from the value.

Returns: The new 16-bit value.

Definition at line 447 of file BitField.c.

◆ BitFieldAnd32()

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

Operand	Operand on which to perform the bitfield operation.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..31.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..31.
AndData	The value to AND with the read value from the value

Returns: The new 32-bit value.

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

Operand	Operand on which to perform the bitfield operation.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..31.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..31.
AndData	The value to AND with the read value from the value.

Returns: The new 32-bit value.

Definition at line 639 of file BitField.c.

◆ BitFieldAnd64()

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

Operand	Operand on which to perform the bitfield operation.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..63.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..63.
AndData	The value to AND with the read value from the value

Returns: The new 64-bit value.

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

Operand	Operand on which to perform the bitfield operation.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..63.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..63.
AndData	The value to AND with the read value from the value.

Returns: The new 64-bit value.

Definition at line 845 of file BitField.c.

◆ BitFieldAnd8()

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

Operand	Operand on which to perform the bitfield operation.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..7.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..7.
AndData	The value to AND with the read value from the value.

Returns: The new 8-bit value.

Definition at line 255 of file BitField.c.

◆ BitFieldAndThenOr16()

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

Operand	Operand on which to perform the bitfield operation.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..15.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..15.
AndData	The value to AND with the read value from the value.
OrData	The value to OR with the result of the AND operation.

Returns: The new 16-bit value.

Definition at line 488 of file BitField.c.

◆ BitFieldAndThenOr32()

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

Operand	Operand on which to perform the bitfield operation.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..31.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..31.
AndData	The value to AND with the read value from the value.
OrData	The value to OR with the result of the AND operation.

Returns: The new 32-bit value.

Definition at line 680 of file BitField.c.

◆ BitFieldAndThenOr64()

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

Operand	Operand on which to perform the bitfield operation.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..63.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..63.
AndData	The value to AND with the read value from the value.
OrData	The value to OR with the result of the AND operation.

Returns: The new 64-bit value.

Definition at line 900 of file BitField.c.

◆ BitFieldAndThenOr8()

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

Operand	Operand on which to perform the bitfield operation.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..7.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..7.
AndData	The value to AND with the read value from the value.
OrData	The value to OR with the result of the AND operation.

Returns: The new 8-bit value.

Definition at line 296 of file BitField.c.

◆ BitFieldCountOnes32()

UINT8 EFIAPI BitFieldCountOnes32	(	IN UINT32	Operand,
		IN UINTN	StartBit,
		IN UINTN	EndBit
	)

Reads a bit field from a 32-bit value, counts and returns the number of set bits.

Counts the number of set bits in the bit field specified by StartBit and EndBit in Operand. The count is returned.

If StartBit is greater than 31, then ASSERT(). If EndBit is greater than 31, then ASSERT(). If EndBit is less than StartBit, then ASSERT().

Parameters

Operand	Operand on which to perform the bitfield operation.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..31.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..31.

Returns: The number of bits set between StartBit and EndBit.

Definition at line 940 of file BitField.c.

◆ BitFieldCountOnes64()

UINT8 EFIAPI BitFieldCountOnes64	(	IN UINT64	Operand,
		IN UINTN	StartBit,
		IN UINTN	EndBit
	)

Reads a bit field from a 64-bit value, counts and returns the number of set bits.

Counts the number of set bits in the bit field specified by StartBit and EndBit in Operand. The count is returned.

If StartBit is greater than 63, then ASSERT(). If EndBit is greater than 63, then ASSERT(). If EndBit is less than StartBit, then ASSERT().

Parameters

Operand	Operand on which to perform the bitfield operation.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..63.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..63.

Returns: The number of bits set between StartBit and EndBit.

Definition at line 984 of file BitField.c.

◆ BitFieldOr16()

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

Operand	Operand on which to perform the bitfield operation.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..15.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..15.
OrData	The value to OR with the read value from the value

Returns: The new 16-bit value.

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

Operand	Operand on which to perform the bitfield operation.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..15.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..15.
OrData	The value to OR with the read value from the value.

Returns: The new 16-bit value.

Definition at line 409 of file BitField.c.

◆ BitFieldOr32()

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

Operand	Operand on which to perform the bitfield operation.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..31.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..31.
OrData	The value to OR with the read value from the value.

Returns: The new 32-bit value.

Definition at line 601 of file BitField.c.

◆ BitFieldOr64()

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

Operand	Operand on which to perform the bitfield operation.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..63.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..63.
OrData	The value to OR with the read value from the value

Returns: The new 64-bit value.

Definition at line 793 of file BitField.c.

◆ BitFieldOr8()

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

Operand	Operand on which to perform the bitfield operation.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..7.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..7.
OrData	The value to OR with the read value from the value

Returns: The new 8-bit value.

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

Operand	Operand on which to perform the bitfield operation.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..7.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..7.
OrData	The value to OR with the read value from the value.

Returns: The new 8-bit value.

Definition at line 217 of file BitField.c.

◆ BitFieldRead16()

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

Operand	Operand on which to perform the bitfield operation.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..15.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..15.

Returns: The bit field read.

Definition at line 335 of file BitField.c.

◆ BitFieldRead32()

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

Operand	Operand on which to perform the bitfield operation.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..31.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..31.

Returns: The bit field read.

Definition at line 527 of file BitField.c.

◆ BitFieldRead64()

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

Operand	Operand on which to perform the bitfield operation.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..63.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..63.

Returns: The bit field read.

Definition at line 719 of file BitField.c.

◆ BitFieldRead8()

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

Operand	Operand on which to perform the bitfield operation.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..7.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..7.

Returns: The bit field read.

Definition at line 143 of file BitField.c.

◆ BitFieldWrite16()

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

Operand	Operand on which to perform the bitfield operation.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..15.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..15.
Value	New value of the bit field.

Returns: The new 16-bit 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

Operand	Operand on which to perform the bitfield operation.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..15.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..15.
Value	The new value of the bit field.

Returns: The new 16-bit value.

Definition at line 371 of file BitField.c.

◆ BitFieldWrite32()

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

Operand	Operand on which to perform the bitfield operation.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..31.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..31.
Value	New value of the bit field.

Returns: The new 32-bit 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

Operand	Operand on which to perform the bitfield operation.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..31.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..31.
Value	The new value of the bit field.

Returns: The new 32-bit value.

Definition at line 563 of file BitField.c.

◆ BitFieldWrite64()

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

Operand	Operand on which to perform the bitfield operation.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..63.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..63.
Value	New value of the bit field.

Returns: The new 64-bit 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

Operand	Operand on which to perform the bitfield operation.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..63.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..63.
Value	The new value of the bit field.

Returns: The new 64-bit value.

Definition at line 755 of file BitField.c.

◆ BitFieldWrite8()

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

Operand	Operand on which to perform the bitfield operation.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..7.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..7.
Value	New value of the bit field.

Returns: The new 8-bit 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

Operand	Operand on which to perform the bitfield operation.
StartBit	The ordinal of the least significant bit in the bit field. Range 0..7.
EndBit	The ordinal of the most significant bit in the bit field. Range 0..7.
Value	The new value of the bit field.

Returns: The new 8-bit value.

Definition at line 179 of file BitField.c.

◆ CalculateCheckSum16()

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

Buffer	The pointer to the buffer to carry out the checksum operation.
Length	The size, in bytes, of Buffer.

Returns: Checksum The two's complement checksum of Buffer.

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

Buffer	The pointer to the buffer to carry out the checksum operation.
Length	The size, in bytes, of Buffer.

Returns: Checksum The 2's complement checksum of Buffer.

Definition at line 151 of file CheckSum.c.

◆ CalculateCheckSum32()

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

Buffer	The pointer to the buffer to carry out the checksum operation.
Length	The size, in bytes, of Buffer.

Returns: Checksum The two's complement checksum of Buffer.

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

Buffer	The pointer to the buffer to carry out the checksum operation.
Length	The size, in bytes, of Buffer.

Returns: Checksum The 2's complement checksum of Buffer.

Definition at line 231 of file CheckSum.c.

◆ CalculateCheckSum64()

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

Buffer	The pointer to the buffer to carry out the checksum operation.
Length	The size, in bytes, of Buffer.

Returns: Checksum The two's complement checksum of Buffer.

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

Buffer	The pointer to the buffer to carry out the checksum operation.
Length	The size, in bytes, of Buffer.

Returns: Checksum The 2's complement checksum of Buffer.

Definition at line 311 of file CheckSum.c.

◆ CalculateCheckSum8()

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

Buffer	The pointer to the buffer to carry out the checksum operation.
Length	The size, in bytes, of Buffer.

Returns: Checksum The two's complement checksum of Buffer.

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

Buffer	The pointer to the buffer to carry out the checksum operation.
Length	The size, in bytes, of Buffer.

Returns: Checksum The 2's complement checksum of Buffer.

Definition at line 71 of file CheckSum.c.

◆ CalculateCrc16Ansi()

UINT16 EFIAPI CalculateCrc16Ansi	(	IN CONST VOID *	Buffer,
		IN UINTN	Length,
		IN UINT16	InitialValue
	)

Calculates the CRC16-ANSI checksum of the given buffer.

Parameters

[in]	Buffer	Pointer to the buffer.
[in]	Length	Length of the buffer, in bytes.
[in]	InitialValue	Initial value of the CRC.

Returns: The CRC16-ANSI checksum.

Definition at line 670 of file CheckSum.c.

◆ CalculateCrc16CcittF()

UINT16 EFIAPI CalculateCrc16CcittF	(	IN CONST VOID *	Buffer,
		IN UINTN	Length,
		IN UINT16	InitialValue
	)

Calculates the CRC16-CCITT-FALSE checksum of the given buffer.

Parameters

[in]	Buffer	Pointer to the buffer.
[in]	Length	Length of the buffer, in bytes.
[in]	InitialValue	Initial value of the CRC.

Returns: The CRC16-CCITT-FALSE checksum.

Definition at line 813 of file CheckSum.c.

◆ CalculateCrc32()

UINT32 EFIAPI CalculateCrc32	(	IN VOID *	Buffer,
		IN UINTN	Length
	)

Computes and returns a 32-bit CRC for a data buffer. CRC32 value bases on ITU-T V.42.

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

Parameters

[in]	Buffer	A pointer to the buffer on which the 32-bit CRC is to be computed.
[in]	Length	The number of bytes in the buffer Data.

Return values

Crc32 The 32-bit CRC was computed for the data buffer.

Definition at line 600 of file CheckSum.c.

◆ CalculateCrc32c()

UINT32 EFIAPI CalculateCrc32c	(	IN CONST VOID *	Buffer,
		IN UINTN	Length,
		IN UINT32	InitialValue
	)

Calculates the CRC32c checksum of the given buffer.

Parameters

[in]	Buffer	Pointer to the buffer.
[in]	Length	Length of the buffer, in bytes.
[in]	InitialValue	Initial value of the CRC.

Returns: The CRC32c checksum.

Definition at line 747 of file CheckSum.c.

◆ CalculateSum16()

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

Buffer	The pointer to the buffer to carry out the sum operation.
Length	The size, in bytes, of Buffer.

Returns: Sum The sum of Buffer with carry bits dropped during additions.

Definition at line 107 of file CheckSum.c.

◆ CalculateSum32()

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

Buffer	The pointer to the buffer to carry out the sum operation.
Length	The size, in bytes, of Buffer.

Returns: Sum The sum of Buffer with carry bits dropped during additions.

Definition at line 187 of file CheckSum.c.

◆ CalculateSum64()

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

Buffer	The pointer to the buffer to carry out the sum operation.
Length	The size, in bytes, of Buffer.

Returns: Sum The sum of Buffer with carry bits dropped during additions.

Definition at line 267 of file CheckSum.c.

◆ CalculateSum8()

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

Buffer	The pointer to the buffer to carry out the sum operation.
Length	The size, in bytes, of Buffer.

Returns: Sum The sum of Buffer with carry bits dropped during additions.

Definition at line 33 of file CheckSum.c.

◆ CharToUpper()

CHAR16 EFIAPI CharToUpper ( IN CHAR16 Char )

Convert a Unicode character to upper case only if it maps to a valid small-case ASCII character.

This internal function only deal with Unicode character which maps to a valid small-case ASCII character, i.e. L'a' to L'z'. For other Unicode character, the input character is returned directly.

Parameters

Char	The character to convert.

Return values

LowerCharacter	If the Char is with range L'a' to L'z'.
Unchanged	Otherwise.

Definition at line 307 of file String.c.

◆ CpuBreakpoint()

VOID EFIAPI CpuBreakpoint ( VOID )

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.

Definition at line 26 of file CpuBreakpoint.c.

◆ CpuDeadLoop()

VOID EFIAPI CpuDeadLoop ( VOID )

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.

Definition at line 25 of file CpuDeadLoop.c.

◆ CpuPause()

VOID EFIAPI CpuPause ( VOID )

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.

Definition at line 118 of file CpuBreakpoint.c.

◆ DecimalToBcd8()

UINT8 EFIAPI DecimalToBcd8 ( IN UINT8 Value )

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

Value The 8-bit value to convert to BCD. Range 0..99.

Returns: The BCD value.

Definition at line 1653 of file String.c.

◆ DisableInterrupts()

VOID EFIAPI DisableInterrupts ( VOID )

Disables CPU interrupts.

Definition at line 54 of file CpuBreakpoint.c.

◆ DivS64x64Remainder()

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

Dividend	A 64-bit signed value.
Divisor	A 64-bit signed value.
Remainder	A pointer to a 64-bit signed value. This parameter is optional and may be NULL.

Returns: Dividend / Divisor.

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

Dividend	A 64-bit signed value.
Divisor	A 64-bit signed value.
Remainder	A pointer to a 64-bit signed value. This parameter is optional and may be NULL.

Returns: Dividend / Divisor

Definition at line 36 of file DivS64x64Remainder.c.

◆ DivU64x32()

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

Dividend	A 64-bit unsigned value.
Divisor	A 32-bit unsigned value.

Returns: Dividend / 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

Dividend	A 64-bit unsigned value.
Divisor	A 32-bit unsigned value.

Returns: Dividend / Divisor

Definition at line 29 of file DivU64x32.c.

◆ DivU64x32Remainder()

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

Dividend	A 64-bit unsigned value.
Divisor	A 32-bit unsigned value.
Remainder	A pointer to a 32-bit unsigned value. This parameter is optional and may be NULL.

Returns: Dividend / Divisor.

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

Dividend	A 64-bit unsigned value.
Divisor	A 32-bit unsigned value.
Remainder	A pointer to a 32-bit unsigned value. This parameter is optional and may be NULL.

Returns: Dividend / Divisor

Definition at line 32 of file DivU64x32Remainder.c.

◆ DivU64x64Remainder()

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

Dividend	A 64-bit unsigned value.
Divisor	A 64-bit unsigned value.
Remainder	A pointer to a 64-bit unsigned value. This parameter is optional and may be NULL.

Returns: Dividend / Divisor.

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

Dividend	A 64-bit unsigned value.
Divisor	A 64-bit unsigned value.
Remainder	A pointer to a 64-bit unsigned value. This parameter is optional and may be NULL.

Returns: Dividend / Divisor

Definition at line 32 of file DivU64x64Remainder.c.

◆ EnableDisableInterrupts()

VOID EFIAPI EnableDisableInterrupts ( VOID )

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

Definition at line 101 of file CpuBreakpoint.c.

◆ EnableInterrupts()

VOID EFIAPI EnableInterrupts ( VOID )

Enables CPU interrupts.

Definition at line 67 of file CpuBreakpoint.c.

◆ GetFirstNode()

LIST_ENTRY *EFIAPI GetFirstNode ( IN CONST LIST_ENTRY * List )

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

List	A pointer to the head node of a doubly linked list.

Returns: The first node of a doubly linked list.

Return values

List	The list is empty.

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

List	A pointer to the head node of a doubly-linked list.

Returns: The first node of a doubly-linked list.

Return values

List	The list is empty.

Definition at line 298 of file LinkedList.c.

◆ GetInterruptState()

BOOLEAN EFIAPI GetInterruptState ( VOID )

Retrieves the current CPU interrupt state.

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

Return values

TRUE	CPU interrupts are enabled.
FALSE	CPU interrupts are disabled.

Retrieves the current CPU interrupt state.

Returns TRUE means interrupts are currently enabled. Otherwise, returns FALSE.

Return values

TRUE	CPU interrupts are enabled.
FALSE	CPU interrupts are disabled.

Retrieves the current CPU interrupt state.

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

Return values

TRUE	CPU interrupts are enabled.
FALSE	CPU interrupts are disabled.

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

InterruptState TRUE if interrupts should enabled. FALSE if interrupts should be disabled.

Returns: InterruptState

Definition at line 86 of file CpuBreakpoint.c.

◆ GetNextNode()

LIST_ENTRY *EFIAPI GetNextNode	(	IN CONST LIST_ENTRY *	List,
		IN CONST LIST_ENTRY *	Node
	)

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

List	A pointer to the head node of a doubly linked list.
Node	A 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 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

List	A pointer to the head node of a doubly-linked list.
Node	A pointer to a node in the doubly-linked list.

Returns: A pointer to the next node if one exists. Otherwise List is returned.

Definition at line 333 of file LinkedList.c.

◆ GetPowerOfTwo32()

UINT32 EFIAPI GetPowerOfTwo32 ( IN UINT32 Operand )

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

Operand The 32-bit operand to evaluate.

Returns: 1 << HighBitSet32(Operand)

Return values

0	Operand is zero.

Definition at line 26 of file GetPowerOfTwo32.c.

◆ GetPowerOfTwo64()

UINT64 EFIAPI GetPowerOfTwo64 ( IN UINT64 Operand )

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

Operand The 64-bit operand to evaluate.

Returns: 1 << HighBitSet64(Operand)

Return values

0	Operand is zero.

Definition at line 26 of file GetPowerOfTwo64.c.

◆ GetPreviousNode()

LIST_ENTRY *EFIAPI GetPreviousNode	(	IN CONST LIST_ENTRY *	List,
		IN CONST LIST_ENTRY *	Node
	)

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

List	A pointer to the head node of a doubly linked list.
Node	A pointer to a node in the doubly linked list.

Returns: The pointer to the previous 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

List	A pointer to the head node of a doubly-linked list.
Node	A pointer to a node in the doubly-linked list.

Returns: A pointer to the previous node if one exists. Otherwise List is returned.

Definition at line 369 of file LinkedList.c.

◆ HighBitSet32()

INTN EFIAPI HighBitSet32 ( IN UINT32 Operand )

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

Operand The 32-bit operand to evaluate.

Return values

0..31	Position of the highest bit set in Operand if found.
-1	Operand is zero.

Definition at line 27 of file HighBitSet32.c.

◆ HighBitSet64()

INTN EFIAPI HighBitSet64 ( IN UINT64 Operand )

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

Operand The 64-bit operand to evaluate.

Return values

0..63	Position of the highest bit set in Operand if found.
-1	Operand is zero.

Definition at line 27 of file HighBitSet64.c.

◆ InitializeListHead()

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.

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

ListHead A pointer to the head node of a new doubly linked list.

Returns: ListHead

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

ListHead A pointer to the head node of a new doubly-linked list.

Returns: ListHead

Definition at line 182 of file LinkedList.c.

◆ InsertHeadList()

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

ListHead	A pointer to the head node of a doubly linked list.
Entry	A pointer to a node that is to be inserted at the beginning of a doubly linked list.

Returns: ListHead

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

ListHead	A pointer to the head node of a doubly-linked list.
Entry	A pointer to a node that is to be inserted at the beginning of a doubly-linked list.

Returns: ListHead

Definition at line 218 of file LinkedList.c.

◆ InsertTailList()

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

ListHead	A pointer to the head node of a doubly linked list.
Entry	A pointer to a node that is to be added at the end of the doubly linked list.

Returns: ListHead

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

ListHead	A pointer to the head node of a doubly-linked list.
Entry	A pointer to a node that is to be added at the end of the doubly-linked list.

Returns: ListHead

Definition at line 259 of file LinkedList.c.

◆ IsListEmpty()

BOOLEAN EFIAPI IsListEmpty ( IN CONST LIST_ENTRY * ListHead )

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

ListHead A pointer to the head node of a doubly linked list.

Return values

TRUE	The linked list is empty.
FALSE	The linked list is not empty.

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

ListHead A pointer to the head node of a doubly-linked list.

Return values

TRUE	The linked list is empty.
FALSE	The linked list is not empty.

Definition at line 403 of file LinkedList.c.

◆ IsNodeAtEnd()

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.

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

List	A pointer to the head node of a doubly linked list.
Node	A pointer to a node in the doubly linked list.

Return values

TRUE	Node is the last node in the linked list.
FALSE	Node is not the last node in the linked 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

List	A pointer to the head node of a doubly-linked list.
Node	A pointer to a node in the doubly-linked list.

Return values

TRUE	Node is the last node in the linked list.
FALSE	Node is not the last node in the linked list.

Definition at line 481 of file LinkedList.c.

◆ IsNodeInList()

BOOLEAN EFIAPI IsNodeInList	(	IN CONST LIST_ENTRY *	FirstEntry,
		IN CONST LIST_ENTRY *	SecondEntry
	)

Checks whether FirstEntry and SecondEntry are part of the same doubly-linked list.

If FirstEntry is NULL, then ASSERT(). If FirstEntry->ForwardLink is NULL, then ASSERT(). If FirstEntry->BackLink is NULL, then ASSERT(). If SecondEntry is NULL, then ASSERT(); If PcdMaximumLinkedListLength is not zero, and List contains more than PcdMaximumLinkedListLength nodes, then ASSERT().

Parameters

FirstEntry	A pointer to a node in a linked list.
SecondEntry	A pointer to the node to locate.

Return values

TRUE	SecondEntry is in the same doubly-linked list as FirstEntry.
FALSE	SecondEntry isn't in the same doubly-linked list as FirstEntry, or FirstEntry is invalid.

Definition at line 121 of file LinkedList.c.

◆ IsNull()

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

List	A pointer to the head node of a doubly linked list.
Node	A pointer to a node in the doubly linked list.

Return values

TRUE	Node is the head of the doubly-linked list pointed by List.
FALSE	Node is not the head of the doubly-linked list pointed by List.

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 and Node is not equal to List, then ASSERT().

Parameters

List	A pointer to the head node of a doubly-linked list.
Node	A pointer to a node in the doubly-linked list.

Return values

TRUE	Node is the head of the doubly-linked list pointed by List.
FALSE	Node is not the head of the doubly-linked list pointed by List.

Definition at line 443 of file LinkedList.c.

◆ LongJump()

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

JumpBuffer	A pointer to CPU context buffer.
Value	The value to return when the SetJump() context is restored and must be non-zero.

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 IPF CPUs, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT(). If Value is 0, then ASSERT().

Parameters

JumpBuffer	A pointer to CPU context buffer.
Value	The value to return when the SetJump() context is restored and must be non-zero.

Definition at line 29 of file LongJump.c.

◆ LowBitSet32()

INTN EFIAPI LowBitSet32 ( IN UINT32 Operand )

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

Operand The 32-bit operand to evaluate.

Return values

0..31	The lowest bit set in Operand was found.
-1	Operand is zero.

Definition at line 26 of file LowBitSet32.c.

◆ LowBitSet64()

INTN EFIAPI LowBitSet64 ( IN UINT64 Operand )

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

Operand The 64-bit operand to evaluate.

Return values

0..63	The lowest bit set in Operand was found.
-1	Operand is zero.

Definition at line 27 of file LowBitSet64.c.

◆ LRotU32()

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

Operand	The 32-bit operand to rotate left.
Count	The number of bits to rotate left.

Returns: Operand << Count

Definition at line 29 of file LRotU32.c.

◆ LRotU64()

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

Operand	The 64-bit operand to rotate left.
Count	The number of bits to rotate left.

Returns: Operand << Count

Definition at line 29 of file LRotU64.c.

◆ LShiftU64()

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

Operand	The 64-bit operand to shift left.
Count	The number of bits to shift left.

Returns: Operand << Count.

Definition at line 28 of file LShiftU64.c.

◆ MemoryFence()

VOID EFIAPI MemoryFence ( VOID )

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.

Definition at line 42 of file CpuBreakpoint.c.

◆ ModU64x32()

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

Dividend	A 64-bit unsigned value.
Divisor	A 32-bit unsigned value.

Returns: Dividend % Divisor.

Definition at line 29 of file ModU64x32.c.

◆ MultS64x64()

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

Multiplicand	A 64-bit signed value.
Multiplier	A 64-bit signed value.

Returns: Multiplicand * Multiplier

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

This function multiplies 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

Multiplicand	A 64-bit signed value.
Multiplier	A 64-bit signed value.

Returns: Multiplicand * Multiplier.

Definition at line 27 of file MultS64x64.c.

◆ MultU64x32()

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

Multiplicand	A 64-bit unsigned value.
Multiplier	A 32-bit unsigned value.

Returns: Multiplicand * Multiplier

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

This function multiplies 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

Multiplicand	A 64-bit unsigned value.
Multiplier	A 32-bit unsigned value.

Returns: Multiplicand * Multiplier.

Definition at line 27 of file MultU64x32.c.

◆ MultU64x64()

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

Multiplicand	A 64-bit unsigned value.
Multiplier	A 64-bit unsigned value.

Returns: Multiplicand * Multiplier.

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

This function multiplies 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

Multiplicand	A 64-bit unsigned value.
Multiplier	A 64-bit unsigned value.

Returns: Multiplicand * Multiplier.

Definition at line 27 of file MultU64x64.c.

◆ PathCleanUpDirectories()

CHAR16 *EFIAPI PathCleanUpDirectories ( IN CHAR16 * Path )

Function to clean up paths.

Single periods in the path are removed.
Double periods in the path are removed along with a single parent directory.
Forward slashes L'/' are converted to backward slashes L'\'.

This will be done inline and the existing buffer may be larger than required upon completion.

Parameters

[in] Path The pointer to the string containing the path.

Returns: Returns Path, otherwise returns NULL to indicate that an error has occurred.

Definition at line 68 of file FilePaths.c.

◆ PathRemoveLastItem()

BOOLEAN EFIAPI PathRemoveLastItem ( IN OUT CHAR16 * Path )

Removes the last directory or file entry in a path.

Parameters

[in,out] Path The pointer to the path to modify.

Return values

FALSE	Nothing was found to remove.
TRUE	A directory or file was removed.

Removes the last directory or file entry in a path. For a path which is like L"fs0:startup.nsh", it's converted to L"fs0:".

Parameters

[in,out] Path A pointer to the path to modify.

Return values

FALSE	Nothing was found to remove.
TRUE	A directory or file was removed.

Definition at line 22 of file FilePaths.c.

◆ QuickSort()

VOID EFIAPI QuickSort	(	IN OUT VOID *	BufferToSort,
		IN CONST UINTN	Count,
		IN CONST UINTN	ElementSize,
		IN BASE_SORT_COMPARE	CompareFunction,
		OUT VOID *	BufferOneElement
	)

This function is identical to perform QuickSort, except that is uses the pre-allocated buffer so the in place sorting does not need to allocate and free buffers constantly.

Each element must be equal sized.

if BufferToSort is NULL, then ASSERT. if CompareFunction is NULL, then ASSERT. if BufferOneElement is NULL, then ASSERT. if ElementSize is < 1, then ASSERT.

if Count is < 2 then perform no action.

Parameters

[in,out]	BufferToSort	on call a Buffer of (possibly sorted) elements on return a buffer of sorted elements
[in]	Count	the number of elements in the buffer to sort
[in]	ElementSize	Size of an element in bytes
[in]	CompareFunction	The function to call to perform the comparison of any 2 elements
[out]	BufferOneElement	Caller provided buffer whose size equals to ElementSize. It's used by QuickSort() for swapping in sorting.

Definition at line 36 of file QuickSort.c.

◆ ReadUnaligned16()

UINT16 EFIAPI ReadUnaligned16 ( IN CONST UINT16 * Buffer )

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

Buffer The pointer to a 16-bit value that may be unaligned.

Returns: The 16-bit value read from Buffer.

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

Buffer A pointer to a 16-bit value that may be unaligned.

Returns: The 16-bit value read from Buffer.

Definition at line 29 of file Unaligned.c.

◆ ReadUnaligned24()

UINT32 EFIAPI ReadUnaligned24 ( IN CONST UINT32 * 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

Buffer The pointer to a 24-bit value that may be unaligned.

Returns: The 24-bit value read from 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

Buffer A pointer to a 24-bit value that may be unaligned.

Returns: The 24-bit value read from Buffer.

Definition at line 89 of file Unaligned.c.

◆ ReadUnaligned32()

UINT32 EFIAPI ReadUnaligned32 ( IN CONST UINT32 * 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

Buffer The pointer to a 32-bit value that may be unaligned.

Returns: The 32-bit value read from 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

Buffer A pointer to a 32-bit value that may be unaligned.

Returns: The 32-bit value read from Buffer.

Definition at line 145 of file Unaligned.c.

◆ ReadUnaligned64()

UINT64 EFIAPI ReadUnaligned64 ( IN CONST UINT64 * 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

Buffer The pointer to a 64-bit value that may be unaligned.

Returns: The 64-bit value read from 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

Buffer A pointer to a 64-bit value that may be unaligned.

Returns: The 64-bit value read from Buffer.

Definition at line 204 of file Unaligned.c.

◆ RemoveEntryList()

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.

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

Entry A pointer to a node in a linked list.

Returns: Entry.

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

Entry A pointer to a node in a linked list.

Returns: Entry.

Definition at line 590 of file LinkedList.c.

◆ RRotU32()

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

Operand	The 32-bit operand to rotate right.
Count	The number of bits to rotate right.

Returns: Operand >> 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

Operand	The 32-bit operand to rotate right.
Count	The number of bits to rotate right.

Returns: Operand >> Count.

Definition at line 29 of file RRotU32.c.

◆ RRotU64()

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

Operand	The 64-bit operand to rotate right.
Count	The number of bits to rotate right.

Returns: Operand >> 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

Operand	The 64-bit operand to rotate right.
Count	The number of bits to rotate right.

Returns: Operand >> Count.

Definition at line 29 of file RRotU64.c.

◆ RShiftU64()

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

Operand	The 64-bit operand to shift right.
Count	The number of bits to shift right.

Returns: Operand >> 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

Operand	The 64-bit operand to shift right.
Count	The number of bits to shift right.

Returns: Operand >> Count.

Definition at line 28 of file RShiftU64.c.

◆ SaveAndDisableInterrupts()

BOOLEAN EFIAPI SaveAndDisableInterrupts ( VOID )

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

Return values

TRUE	CPU interrupts were enabled on entry to this call.
FALSE	CPU interrupts were disabled on entry to this call.

Definition at line 21 of file Cpu.c.

◆ SetInterruptState()

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

InterruptState TRUE if interrupts should enabled. FALSE if interrupts should be disabled.

Returns: 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

InterruptState TRUE if interrupts should be enabled. FALSE if interrupts should be disabled.

Returns: InterruptState

Definition at line 48 of file Cpu.c.

◆ SetJump()

RETURNS_TWICE 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

JumpBuffer A pointer to CPU context buffer.

Return values

0	Indicates a return from SetJump().

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 IPF CPUs, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().

Parameters

JumpBuffer A pointer to CPU context buffer.

Return values

0	Indicates a return from SetJump().

Definition at line 32 of file SetJumpLongJump.c.

◆ SpeculationBarrier()

VOID EFIAPI SpeculationBarrier ( VOID )

Uses as a barrier to stop speculative execution.

Ensures that no later instruction will execute speculatively, until all prior instructions have completed.

Definition at line 19 of file SpeculationBarrier.c.

◆ StrCatS()

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 is returned, then the Destination is unmodified.

Parameters

Destination	A pointer to a Null-terminated Unicode string.
DestMax	The maximum number of Destination Unicode char, including terminating null char.
Source	A pointer to a Null-terminated Unicode string.

Return values

RETURN_SUCCESS	String is appended.
RETURN_BAD_BUFFER_SIZE	If DestMax is NOT greater than StrLen(Destination).
RETURN_BUFFER_TOO_SMALL	If (DestMax - StrLen(Destination)) is NOT greater than StrLen(Source).
RETURN_INVALID_PARAMETER	If Destination is NULL. If Source is NULL. If PcdMaximumUnicodeStringLength is not zero, and DestMax is greater than PcdMaximumUnicodeStringLength. If DestMax is 0.
RETURN_ACCESS_DENIED	If Source and Destination overlap.

Definition at line 405 of file SafeString.c.

◆ StrCmp()

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

FirstString	The pointer to a Null-terminated Unicode string.
SecondString	The pointer to a Null-terminated Unicode string.

Return values

0	FirstString is identical to SecondString.

Returns: others FirstString is not identical to 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

FirstString	A pointer to a Null-terminated Unicode string.
SecondString	A pointer to a Null-terminated Unicode string.

Return values

0	FirstString is identical to SecondString.

Returns: others FirstString is not identical to SecondString.

Definition at line 109 of file String.c.

◆ StrCpyS()

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 is returned, then the Destination is unmodified.

Parameters

Destination	A pointer to a Null-terminated Unicode string.
DestMax	The maximum number of Destination Unicode char, including terminating null char.
Source	A pointer to a Null-terminated Unicode string.

Return values

RETURN_SUCCESS	String is copied.
RETURN_BUFFER_TOO_SMALL	If DestMax is NOT greater than StrLen(Source).
RETURN_INVALID_PARAMETER	If Destination is NULL. If Source is NULL. If PcdMaximumUnicodeStringLength is not zero, and DestMax is greater than PcdMaximumUnicodeStringLength. If DestMax is 0.
RETURN_ACCESS_DENIED	If Source and Destination overlap.

Definition at line 226 of file SafeString.c.

◆ StrDecimalToUint64()

UINT64 EFIAPI StrDecimalToUint64 ( IN CONST CHAR16 * 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

String The pointer to a Null-terminated Unicode string.

Return values

Value translated 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

String A pointer to a Null-terminated Unicode string.

Return values

Value translated from String.

Definition at line 456 of file String.c.

◆ StrDecimalToUint64S()

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 not aligned in a 16-bit boundary, 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

String	Pointer to a Null-terminated Unicode string.
EndPointer	Pointer to character that stops scan.
Data	Pointer to the converted value.

Return values

RETURN_SUCCESS	Value is translated from String.
RETURN_INVALID_PARAMETER	If String is NULL. If Data is NULL. If PcdMaximumUnicodeStringLength is not zero, and String contains more than PcdMaximumUnicodeStringLength Unicode characters, not including the Null-terminator.
RETURN_UNSUPPORTED	If the number represented by String exceeds the range defined by UINT64.

Definition at line 743 of file SafeString.c.

◆ StrDecimalToUintn()

UINTN EFIAPI StrDecimalToUintn ( IN CONST CHAR16 * String )

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

String The pointer to a Null-terminated Unicode string.

Return values

Value translated from String.

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

String A pointer to a Null-terminated Unicode string.

Return values

Value translated from String.

Definition at line 405 of file String.c.

◆ StrDecimalToUintnS()

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 not aligned in a 16-bit boundary, 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

String	Pointer to a Null-terminated Unicode string.
EndPointer	Pointer to character that stops scan.
Data	Pointer to the converted value.

Return values

RETURN_SUCCESS	Value is translated from String.
RETURN_INVALID_PARAMETER	If String is NULL. If Data is NULL. If PcdMaximumUnicodeStringLength is not zero, and String contains more than PcdMaximumUnicodeStringLength Unicode characters, not including the Null-terminator.
RETURN_UNSUPPORTED	If the number represented by String exceeds the range defined by UINTN.

Definition at line 631 of file SafeString.c.

◆ StrHexToBytes()

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

Parameters

String	Pointer to a Null-terminated Unicode string.
Length	The number of Unicode characters to decode.
Buffer	Pointer to the converted bytes array.
MaxBufferSize	The maximum size of Buffer.

Return values

RETURN_SUCCESS	Buffer is translated from String.
RETURN_INVALID_PARAMETER	If String is NULL. If Data is NULL. If Length is not multiple of 2. If PcdMaximumUnicodeStringLength is not zero, and Length is greater than PcdMaximumUnicodeStringLength.
RETURN_UNSUPPORTED	If Length of characters from String contain a character that is not valid hexadecimal digit characters, or a Null-terminator.
RETURN_BUFFER_TOO_SMALL	If MaxBufferSize is less than (Length / 2).

Definition at line 1615 of file SafeString.c.

◆ StrHexToUint64()

UINT64 EFIAPI StrHexToUint64 ( IN CONST CHAR16 * 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

String The pointer to a Null-terminated Unicode string.

Return values

Value translated 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

String A pointer to a Null-terminated Unicode string.

Return values

Value translated from String.

Definition at line 560 of file String.c.

◆ StrHexToUint64S()

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 not aligned in a 16-bit boundary, 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

String	Pointer to a Null-terminated Unicode string.
EndPointer	Pointer to character that stops scan.
Data	Pointer to the converted value.

Return values

RETURN_SUCCESS	Value is translated from String.
RETURN_INVALID_PARAMETER	If String is NULL. If Data is NULL. If PcdMaximumUnicodeStringLength is not zero, and String contains more than PcdMaximumUnicodeStringLength Unicode characters, not including the Null-terminator.
RETURN_UNSUPPORTED	If the number represented by String exceeds the range defined by UINT64.

Definition at line 994 of file SafeString.c.

◆ StrHexToUintn()

UINTN EFIAPI StrHexToUintn ( IN CONST CHAR16 * 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

String The pointer to a Null-terminated Unicode string.

Return values

Value translated 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

String A pointer to a Null-terminated Unicode string.

Return values

Value translated from String.

Definition at line 508 of file String.c.

◆ StrHexToUintnS()

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 not aligned in a 16-bit boundary, 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

String	Pointer to a Null-terminated Unicode string.
EndPointer	Pointer to character that stops scan.
Data	Pointer to the converted value.

Return values

RETURN_SUCCESS	Value is translated from String.
RETURN_INVALID_PARAMETER	If String is NULL. If Data is NULL. If PcdMaximumUnicodeStringLength is not zero, and String contains more than PcdMaximumUnicodeStringLength Unicode characters, not including the Null-terminator.
RETURN_UNSUPPORTED	If the number represented by String exceeds the range defined by UINTN.

Definition at line 860 of file SafeString.c.

◆ StrLen()

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

String Pointer to a Null-terminated Unicode string.

Returns: The length of 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

String A pointer to a Null-terminated Unicode string.

Returns: The length of String.

Definition at line 30 of file String.c.

◆ StrnCatS()

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 is returned, then the Destination is unmodified.

Parameters

Destination	A pointer to a Null-terminated Unicode string.
DestMax	The maximum number of Destination Unicode char, including terminating null char.
Source	A pointer to a Null-terminated Unicode string.
Length	The maximum number of Unicode characters to copy.

Return values

RETURN_SUCCESS	String is appended.
RETURN_BAD_BUFFER_SIZE	If DestMax is NOT greater than StrLen(Destination).
RETURN_BUFFER_TOO_SMALL	If (DestMax - StrLen(Destination)) is NOT greater than MIN(StrLen(Source), Length).
RETURN_INVALID_PARAMETER	If Destination is NULL. If Source is NULL. If PcdMaximumUnicodeStringLength is not zero, and DestMax is greater than PcdMaximumUnicodeStringLength. If DestMax is 0.
RETURN_ACCESS_DENIED	If Source and Destination overlap.

Definition at line 507 of file SafeString.c.

◆ StrnCmp()

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

FirstString	The pointer to a Null-terminated Unicode string.
SecondString	The pointer to a Null-terminated Unicode string.
Length	The maximum number of Unicode characters to compare.

Return values

0	FirstString is identical to SecondString.

Returns: others FirstString is not identical to SecondString.

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

FirstString	A pointer to a Null-terminated Unicode string.
SecondString	A pointer to a Null-terminated Unicode string.
Length	The maximum number of Unicode characters to compare.

Return values

0	FirstString is identical to SecondString.

Returns: others FirstString is not identical to SecondString.

Definition at line 162 of file String.c.

◆ StrnCpyS()

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 is returned, then the Destination is unmodified.

Parameters

Destination	A pointer to a Null-terminated Unicode string.
DestMax	The maximum number of Destination Unicode char, including terminating null char.
Source	A pointer to a Null-terminated Unicode string.
Length	The maximum number of Unicode characters to copy.

Return values

RETURN_SUCCESS	String is copied.
RETURN_BUFFER_TOO_SMALL	If DestMax is NOT greater than MIN(StrLen(Source), Length).
RETURN_INVALID_PARAMETER	If Destination is NULL. If Source is NULL. If PcdMaximumUnicodeStringLength is not zero, and DestMax is greater than PcdMaximumUnicodeStringLength. If DestMax is 0.
RETURN_ACCESS_DENIED	If Source and Destination overlap.

Definition at line 310 of file SafeString.c.

◆ StrnLenS()

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

String	A pointer to a Null-terminated Unicode string.
MaxSize	The maximum number of Destination Unicode char, including terminating null char.

Return values

0	If String is NULL.
MaxSize	If there is no null character in the first MaxSize characters of String.

Returns: The number of characters that percede the terminating null character.

Definition at line 119 of file SafeString.c.

◆ StrnSizeS()

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

String	A pointer to a Null-terminated Unicode string.
MaxSize	The maximum number of Destination Unicode char, including the Null terminator.

Return values

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

Definition at line 176 of file SafeString.c.

◆ StrSize()

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

String The pointer to a Null-terminated Unicode string.

Returns: The size of 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

String A pointer to a Null-terminated Unicode string.

Returns: The size of String.

Definition at line 72 of file String.c.

◆ StrStr()

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

String	The pointer to a Null-terminated Unicode string.
SearchString	The pointer to a Null-terminated Unicode string to search for.

Return values

NULL	If the SearchString does not appear in String.

Returns: others If there is a match.

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

String	A pointer to a Null-terminated Unicode string.
SearchString	A pointer to a Null-terminated Unicode string to search for.

Return values

NULL	If the SearchString does not appear in String.

Returns: others If there is a match.

Definition at line 224 of file String.c.

◆ StrToGuid()

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 not aligned in a 16-bit boundary, then ASSERT().

Parameters

String	Pointer to a Null-terminated Unicode string.
Guid	Pointer to the converted GUID.

Return values

RETURN_SUCCESS	Guid is translated from String.
RETURN_INVALID_PARAMETER	If String is NULL. If Data is NULL.
RETURN_UNSUPPORTED	If String is not as the above format.

Definition at line 1500 of file SafeString.c.

◆ StrToIpv4Address()

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 not aligned in a 16-bit boundary, 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

String	Pointer to a Null-terminated Unicode string.
EndPointer	Pointer to character that stops scan.
Address	Pointer to the converted IPv4 address.
PrefixLength	Pointer to the converted IPv4 address prefix length. MAX_UINT8 is returned when /P is not in the String.

Return values

RETURN_SUCCESS	Address is translated from String.
RETURN_INVALID_PARAMETER	If String is NULL. If Data is NULL.
RETURN_UNSUPPORTED	If String is not in the correct format. If any decimal number converted from D exceeds 255. If the decimal number converted from P exceeds 32.

Definition at line 1351 of file SafeString.c.

◆ StrToIpv6Address()

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 not aligned in a 16-bit boundary, 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

String	Pointer to a Null-terminated Unicode string.
EndPointer	Pointer to character that stops scan.
Address	Pointer to the converted IPv6 address.
PrefixLength	Pointer to the converted IPv6 address prefix length. MAX_UINT8 is returned when /P is not in the String.

Return values

RETURN_SUCCESS	Address is translated from String.
RETURN_INVALID_PARAMETER	If String is NULL. If Data is NULL.
RETURN_UNSUPPORTED	If X contains more than four hexadecimal digit characters. If String contains "::" and number of X is not less than 8. If P starts with character that is not a valid decimal digit character. If the decimal number converted from P exceeds 128.

Definition at line 1129 of file SafeString.c.

◆ SwapBytes16()

UINT16 EFIAPI SwapBytes16 ( IN UINT16 Value )

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

Value A 16-bit unsigned value.

Returns: The byte swapped Value.

Switches the endianess 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

Value A 16-bit unsigned value.

Returns: The byte swapped Value.

Definition at line 25 of file SwapBytes16.c.

◆ SwapBytes32()

UINT32 EFIAPI SwapBytes32 ( IN UINT32 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

Value A 32-bit unsigned value.

Returns: The byte swapped Value.

Switches the endianess 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

Value A 32-bit unsigned value.

Returns: The byte swapped Value.

Definition at line 25 of file SwapBytes32.c.

◆ SwapBytes64()

UINT64 EFIAPI SwapBytes64 ( IN UINT64 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

Value A 64-bit unsigned value.

Returns: The byte swapped Value.

Switches the endianess 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

Value A 64-bit unsigned value.

Returns: The byte swapped Value.

Definition at line 25 of file SwapBytes64.c.

◆ SwapListEntries()

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

FirstEntry	A pointer to a node in a linked list.
SecondEntry	A pointer to another node in the same linked list.

Returns: 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

FirstEntry	A pointer to a node in a linked list.
SecondEntry	A pointer to another node in the same linked list.

Returns: SecondEntry.

Definition at line 522 of file LinkedList.c.

◆ SwitchStack()

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

EntryPoint	A pointer to function to call with the new stack.
Context1	A pointer to the context to pass into the EntryPoint function.
Context2	A pointer to the context to pass into the EntryPoint function.
NewStack	A 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.

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

EntryPoint	A pointer to function to call with the new stack.
Context1	A pointer to the context to pass into the EntryPoint function.
Context2	A pointer to the context to pass into the EntryPoint function.
NewStack	A pointer to the new stack to use for the EntryPoint function.
...	This variable argument list is ignored for IA32, x64, and EBC. For IPF, this variable argument list is expected to contain a single parameter of type VOID * that specifies the new backing store pointer.

Definition at line 42 of file SwitchStack.c.

◆ TdCall()

UINTN EFIAPI TdCall	(	IN UINT64	Leaf,
		IN UINT64	Arg1,
		IN UINT64	Arg2,
		IN UINT64	Arg3,
		IN OUT VOID *	Results
	)

The TDCALL instruction causes a VM exit to the Intel TDX module. It is used to call guest-side Intel TDX functions, either local or a TD exit to the host VMM, as selected by Leaf.

Parameters

[in]	Leaf	Leaf number of TDCALL instruction
[in]	Arg1	Arg1
[in]	Arg2	Arg2
[in]	Arg3	Arg3
[in,out]	Results	Returned result of the Leaf function

Returns: 0 A successful call; Other See individual leaf functions

The TDCALL instruction causes a VM exit to the Intel TDX module. It is used to call guest-side Intel TDX functions, either local or a TD exit to the host VMM, as selected by Leaf. Leaf functions are described at <https://software.intel.com/content/ www/us/en/develop/articles/intel-trust-domain-extensions.html>

Parameters

[in]	Leaf	Leaf number of TDCALL instruction
[in]	Arg1	Arg1
[in]	Arg2	Arg2
[in]	Arg3	Arg3
[in,out]	Results	Returned result of the Leaf function

Returns: EFI_SUCCESS; Other See individual leaf functions

Definition at line 31 of file IntelTdxNull.c.

◆ TdIsEnabled()

BOOLEAN EFIAPI TdIsEnabled ( VOID )

Probe if TD is enabled.

Returns: TRUE TD is enabled.; FALSE TD is not enabled.

◆ TdVmCall()

UINTN EFIAPI TdVmCall	(	IN UINT64	Leaf,
		IN UINT64	Arg1,
		IN UINT64	Arg2,
		IN UINT64	Arg3,
		IN UINT64	Arg4,
		IN OUT VOID *	Results
	)

TDVMALL is a leaf function 0 for TDCALL. It helps invoke services from the host VMM to pass/receive information.

Parameters

[in]	Leaf	Number of sub-functions
[in]	Arg1	Arg1
[in]	Arg2	Arg2
[in]	Arg3	Arg3
[in]	Arg4	Arg4
[in,out]	Results	Returned result of the sub-function

Returns: 0 A successful call; Other See individual sub-functions

TDVMALL is a leaf function 0 for TDCALL. It helps invoke services from the host VMM to pass/receive information.

Parameters

[in]	Leaf	Number of sub-functions
[in]	Arg1	Arg1
[in]	Arg2	Arg2
[in]	Arg3	Arg3
[in]	Arg4	Arg4
[in,out]	Results	Returned result of the sub-function

Returns: EFI_SUCCESS; Other See individual sub-functions

Definition at line 59 of file IntelTdxNull.c.

◆ UnicodeStrnToAsciiStrS()

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 is returned, then the Destination is unmodified.

Parameters

Source	The pointer to a Null-terminated Unicode string.
Length	The maximum number of Unicode characters to convert.
Destination	The pointer to a Null-terminated Ascii string.
DestMax	The maximum number of Destination Ascii char, including terminating null char.
DestinationLength	The number of Unicode characters converted.

Return values

RETURN_SUCCESS	String is converted.
RETURN_INVALID_PARAMETER	If Destination is NULL. If Source is NULL. If DestinationLength is NULL. If PcdMaximumAsciiStringLength is not zero, and Length or DestMax is greater than PcdMaximumAsciiStringLength. If PcdMaximumUnicodeStringLength is not zero, and Length or DestMax is greater than PcdMaximumUnicodeStringLength. If DestMax is 0.
RETURN_BUFFER_TOO_SMALL	If DestMax is NOT greater than MIN(StrLen(Source), Length).
RETURN_ACCESS_DENIED	If Source and Destination overlap.

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 not smaller than ((MIN(StrLen(Source), Length) + 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 is returned, then Destination and DestinationLength are unmodified.

Parameters

Source	The pointer to a Null-terminated Unicode string.
Length	The maximum number of Unicode characters to convert.
Destination	The pointer to a Null-terminated Ascii string.
DestMax	The maximum number of Destination Ascii char, including terminating null char.
DestinationLength	The number of Unicode characters converted.

Return values

RETURN_SUCCESS	String is converted.
RETURN_INVALID_PARAMETER	If Destination is NULL. If Source is NULL. If DestinationLength is NULL. If PcdMaximumAsciiStringLength is not zero, and Length or DestMax is greater than PcdMaximumAsciiStringLength. If PcdMaximumUnicodeStringLength is not zero, and Length or DestMax is greater than PcdMaximumUnicodeStringLength. If DestMax is 0.
RETURN_BUFFER_TOO_SMALL	If DestMax is NOT greater than MIN(StrLen(Source), Length).
RETURN_ACCESS_DENIED	If Source and Destination overlap.

Definition at line 2757 of file SafeString.c.

◆ UnicodeStrToAsciiStrS()

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 is returned, then the Destination is unmodified.

Parameters

Source	The pointer to a Null-terminated Unicode string.
Destination	The pointer to a Null-terminated ASCII string.
DestMax	The maximum number of Destination Ascii char, including terminating null char.

Return values

RETURN_SUCCESS	String is converted.
RETURN_BUFFER_TOO_SMALL	If DestMax is NOT greater than StrLen(Source).
RETURN_INVALID_PARAMETER	If Destination is NULL. If Source is NULL. If PcdMaximumAsciiStringLength is not zero, and DestMax is greater than PcdMaximumAsciiStringLength. If PcdMaximumUnicodeStringLength is not zero, and DestMax is greater than PcdMaximumUnicodeStringLength. If DestMax is 0.
RETURN_ACCESS_DENIED	If Source and Destination overlap.

Definition at line 2650 of file SafeString.c.

◆ WriteUnaligned16()

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

Buffer	The pointer to a 16-bit value that may be unaligned.
Value	16-bit value to write to Buffer.

Returns: The 16-bit value to write to Buffer.

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

Buffer	A pointer to a 16-bit value that may be unaligned.
Value	16-bit value to write to Buffer.

Returns: The 16-bit value to write to Buffer.

Definition at line 61 of file Unaligned.c.

◆ WriteUnaligned24()

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

Buffer	The pointer to a 24-bit value that may be unaligned.
Value	24-bit value to write to Buffer.

Returns: The 24-bit value to write to Buffer.

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

Buffer	A pointer to a 24-bit value that may be unaligned.
Value	24-bit value to write to Buffer.

Returns: The 24-bit value to write to Buffer.

Definition at line 118 of file Unaligned.c.

◆ WriteUnaligned32()

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

Buffer	The pointer to a 32-bit value that may be unaligned.
Value	32-bit value to write to Buffer.

Returns: The 32-bit value to write to Buffer.

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

Buffer	A pointer to a 32-bit value that may be unaligned.
Value	The 32-bit value to write to Buffer.

Returns: The 32-bit value to write to Buffer.

Definition at line 177 of file Unaligned.c.

◆ WriteUnaligned64()

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

Buffer	The pointer to a 64-bit value that may be unaligned.
Value	64-bit value to write to Buffer.

Returns: The 64-bit value to write to Buffer.

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

Buffer	A pointer to a 64-bit value that may be unaligned.
Value	The 64-bit value to write to Buffer.

Returns: The 64-bit value to write to Buffer.

Definition at line 236 of file Unaligned.c.

Macros

Typedefs

Functions

Detailed Description

Macro Definition Documentation

◆ BASE_LIST_FOR_EACH

◆ BASE_LIST_FOR_EACH_SAFE

◆ CRC16ANSI_INIT

◆ GUID_STRING_LENGTH

◆ INITIALIZE_LIST_HEAD_VARIABLE

Typedef Documentation

◆ BASE_SORT_COMPARE

◆ SWITCH_STACK_ENTRY_POINT

Function Documentation

◆ ARShiftU64()

◆ AsciiCharToUpper()

◆ AsciiStrCatS()

◆ AsciiStrCmp()

◆ AsciiStrCpyS()

◆ AsciiStrDecimalToUint64()

◆ AsciiStrDecimalToUint64S()

◆ AsciiStrDecimalToUintn()

◆ AsciiStrDecimalToUintnS()

◆ AsciiStrHexToBytes()

◆ AsciiStrHexToUint64()

◆ AsciiStrHexToUint64S()

◆ AsciiStrHexToUintn()

◆ AsciiStrHexToUintnS()

◆ AsciiStriCmp()

◆ AsciiStrLen()

◆ AsciiStrnCatS()

◆ AsciiStrnCmp()

◆ AsciiStrnCpyS()

◆ AsciiStrnLenS()

◆ AsciiStrnSizeS()

◆ AsciiStrnToUnicodeStrS()

◆ AsciiStrSize()

◆ AsciiStrStr()

◆ AsciiStrToGuid()

◆ AsciiStrToIpv4Address()

◆ AsciiStrToIpv6Address()

◆ AsciiStrToUnicodeStrS()

◆ Base64Decode()

◆ Base64Encode()

◆ BcdToDecimal8()

◆ BitFieldAnd16()

◆ BitFieldAnd32()

◆ BitFieldAnd64()

◆ BitFieldAnd8()

◆ BitFieldAndThenOr16()

◆ BitFieldAndThenOr32()

◆ BitFieldAndThenOr64()

◆ BitFieldAndThenOr8()

◆ BitFieldCountOnes32()

◆ BitFieldCountOnes64()

◆ BitFieldOr16()

◆ BitFieldOr32()

◆ BitFieldOr64()

◆ BitFieldOr8()

◆ BitFieldRead16()

◆ BitFieldRead32()

◆ BitFieldRead64()

◆ BitFieldRead8()

◆ BitFieldWrite16()

◆ BitFieldWrite32()

◆ BitFieldWrite64()

◆ BitFieldWrite8()

◆ CalculateCheckSum16()

◆ CalculateCheckSum32()

◆ CalculateCheckSum64()

◆ CalculateCheckSum8()

◆ CalculateCrc16Ansi()

◆ CalculateCrc16CcittF()

◆ CalculateCrc32()

◆ CalculateCrc32c()

◆ CalculateSum16()

◆ CalculateSum32()

◆ CalculateSum64()

◆ CalculateSum8()

◆ CharToUpper()