TianoCore EDK2 master

#include <Base.h>
#include <Library/BaseLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/DebugLib.h>
#include <Library/PcdLib.h>
Go to the source code of this file.
Declaration of internal functions in BaseLib.
Copyright (c) 2006  2019, Intel Corporation. All rights reserved.
SPDXLicenseIdentifier: BSD2ClausePatent
Definition in file BaseLibInternals.h.
UINTN EFIAPI BitFieldAndUint  (  IN UINTN  Operand, 
IN UINTN  StartBit,  
IN UINTN  EndBit,  
IN UINTN  AndData  
) 
Worker function that reads a bit field from Operand, 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 value is returned.
Operand  Operand on which to perform the bitfield operation. 
StartBit  The ordinal of the least significant bit in the bit field. 
EndBit  The ordinal of the most significant bit in the bit field. 
AndData  The value to And with the read value from the value 
UINTN EFIAPI BitFieldOrUint  (  IN UINTN  Operand, 
IN UINTN  StartBit,  
IN UINTN  EndBit,  
IN UINTN  OrData  
) 
Worker function that reads a bit field from Operand, 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 AndData. All other bits in Operand are preserved. The new value is returned.
Operand  Operand on which to perform the bitfield operation. 
StartBit  The ordinal of the least significant bit in the bit field. 
EndBit  The ordinal of the most significant bit in the bit field. 
OrData  The value to OR with the read value from the value 
Worker function that returns a bit field from Operand.
Returns the bitfield specified by the StartBit and the EndBit from Operand.
Operand  Operand on which to perform the bitfield operation. 
StartBit  The ordinal of the least significant bit in the bit field. 
EndBit  The ordinal of the most significant bit in the bit field. 
Convert a ASCII character to numerical value.
This internal function only deal with Unicode character which maps to a valid hexadecimal ASII character, i.e. '0' to '9', 'a' to 'f' or 'A' to 'F'. For other ASCII character, the value returned does not make sense.
Char  The character to convert. 
Check if a ASCII character is a decimal character.
This internal function checks if a Unicode character is a decimal character. The valid decimal character is from '0' to '9'.
Char  The character to check against. 
TRUE  If the Char is a decmial character. 
FALSE  If the Char is not a decmial character. 
Check if a ASCII character is a hexadecimal character.
This internal function checks if a ASCII character is a decimal character. The valid hexadecimal character is L'0' to L'9', L'a' to L'f', or L'A' to L'F'.
Char  The character to check against. 
TRUE  If the Char is a hexadecmial character. 
FALSE  If the Char is not a hexadecmial character. 
Convert a Unicode character to numerical value.
This internal function only deal with Unicode character which maps to a valid hexadecimal ASII character, i.e. L'0' to L'9', L'a' to L'f' or L'A' to L'F'. For other Unicode character, the value returned does not make sense.
Char  The character to convert. 
Check if a Unicode character is a decimal character.
This internal function checks if a Unicode character is a decimal character. The valid decimal character is from L'0' to L'9'.
Char  The character to check against. 
TRUE  If the Char is a decmial character. 
FALSE  If the Char is not a decmial character. 
Check if a Unicode character is a hexadecimal character.
This internal function checks if a Unicode character is a decimal character. The valid hexadecimal character is L'0' to L'9', L'a' to L'f', or L'A' to L'F'.
Char  The character to check against. 
TRUE  If the Char is a hexadecmial character. 
FALSE  If the Char is not a hexadecmial character. 
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.
JumpBuffer  A pointer to CPU context buffer. 
Value  The value to return when the SetJump() context is restored. 
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 it resumes execution based on the state of JumpBuffer.
JumpBuffer  A pointer to CPU context buffer. 
Value  The value to return when the SetJump() context is restored. 
Definition at line 53 of file SetJumpLongJump.c.
Shifts a 64bit 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 64bit value Operand to the right by Count bits. The high Count bits are set to bit 63 of Operand. The shifted value is returned.
Operand  The 64bit operand to shift right. 
Count  The number of bits to shift right. 
Shifts a 64bit 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 64bit value Operand to the right by Count bits. The high Count bits are set to bit 63 of Operand. The shifted value is returned.
Operand  The 64bit operand to shift right. 
Count  The number of bits to shift right. 
Definition at line 24 of file ARShiftU64.c.
INT64 EFIAPI InternalMathDivRemS64x64  (  IN INT64  Dividend, 
IN INT64  Divisor,  
OUT INT64 *Remainder  OPTIONAL  
) 
Divides a 64bit signed integer by a 64bit signed integer and generates a 64bit signed result and an optional 64bit signed remainder.
This function divides the 64bit signed value Dividend by the 64bit signed value Divisor and generates a 64bit signed quotient. If Remainder is not NULL, then the 64bit signed remainder is returned in Remainder. This function returns the 64bit signed quotient.
Dividend  A 64bit signed value. 
Divisor  A 64bit signed value. 
Remainder  A pointer to a 64bit signed value. This parameter is optional and may be NULL. 
Worker function that Divides a 64bit signed integer by a 64bit signed integer and generates a 64bit signed result and a optional 64bit signed remainder.
This function divides the 64bit signed value Dividend by the 64bit signed value Divisor and generates a 64bit signed quotient. If Remainder is not NULL, then the 64bit signed remainder is returned in Remainder. This function returns the 64bit signed quotient.
Dividend  A 64bit signed value. 
Divisor  A 64bit signed value. 
Remainder  A pointer to a 64bit signed value. This parameter is optional and may be NULL. 
Divides a 64bit signed integer by a 64bit signed integer and generates a 64bit signed result and an optional 64bit signed remainder.
This function divides the 64bit signed value Dividend by the 64bit signed value Divisor and generates a 64bit signed quotient. If Remainder is not NULL, then the 64bit signed remainder is returned in Remainder. This function returns the 64bit signed quotient.
Dividend  A 64bit signed value. 
Divisor  A 64bit signed value. 
Remainder  A pointer to a 64bit signed value. This parameter is optional and may be NULL. 
Definition at line 30 of file DivS64x64Remainder.c.
UINT64 EFIAPI InternalMathDivRemU64x32  (  IN UINT64  Dividend, 
IN UINT32  Divisor,  
OUT UINT32 *Remainder  OPTIONAL  
) 
Divides a 64bit unsigned integer by a 32bit unsigned integer and generates a 64bit unsigned result and an optional 32bit unsigned remainder.
This function divides the 64bit unsigned value Dividend by the 32bit unsigned value Divisor and generates a 64bit unsigned quotient. If Remainder is not NULL, then the 32bit unsigned remainder is returned in Remainder. This function returns the 64bit unsigned quotient.
Dividend  A 64bit unsigned value. 
Divisor  A 32bit unsigned value. 
Remainder  A pointer to a 32bit unsigned value. This parameter is optional and may be NULL. 
Divides a 64bit unsigned integer by a 32bit unsigned integer and generates a 64bit unsigned result and an optional 32bit unsigned remainder.
This function divides the 64bit unsigned value Dividend by the 32bit unsigned value Divisor and generates a 64bit unsigned quotient. If Remainder is not NULL, then the 32bit unsigned remainder is returned in Remainder. This function returns the 64bit unsigned quotient.
Dividend  A 64bit unsigned value. 
Divisor  A 32bit unsigned value. 
Remainder  A pointer to a 32bit unsigned value. This parameter is optional and may be NULL. 
UINT64 EFIAPI InternalMathDivRemU64x64  (  IN UINT64  Dividend, 
IN UINT64  Divisor,  
OUT UINT64 *Remainder  OPTIONAL  
) 
Divides a 64bit unsigned integer by a 64bit unsigned integer and generates a 64bit unsigned result and an optional 64bit unsigned remainder.
This function divides the 64bit unsigned value Dividend by the 64bit unsigned value Divisor and generates a 64bit unsigned quotient. If Remainder is not NULL, then the 64bit unsigned remainder is returned in Remainder. This function returns the 64bit unsigned quotient.
Dividend  A 64bit unsigned value. 
Divisor  A 64bit unsigned value. 
Remainder  A pointer to a 64bit unsigned value. This parameter is optional and may be NULL. 
Divides a 64bit unsigned integer by a 32bit unsigned integer and generates a 64bit unsigned result.
This function divides the 64bit unsigned value Dividend by the 32bit unsigned value Divisor and generates a 64bit unsigned quotient. This function returns the 64bit unsigned quotient.
Dividend  A 64bit unsigned value. 
Divisor  A 32bit unsigned value. 
Divides a 64bit unsigned integer by a 32bit unsigned integer and generates a 64bit unsigned result.
This function divides the 64bit unsigned value Dividend by the 32bit unsigned value Divisor and generates a 64bit unsigned quotient. This function returns the 64bit unsigned quotient.
Dividend  A 64bit unsigned value. 
Divisor  A 32bit unsigned value. 
Definition at line 25 of file DivU64x32.c.
Rotates a 64bit integer left between 0 and 63 bits, filling the low bits with the high bits that were rotated.
This function rotates the 64bit value Operand to the left by Count bits. The low Count bits are filled with the high Count bits of Operand. The rotated value is returned.
Operand  The 64bit operand to rotate left. 
Count  The number of bits to rotate left. 
Rotates a 64bit integer left between 0 and 63 bits, filling the low bits with the high bits that were rotated.
This function rotates the 64bit 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.
Operand  The 64bit operand to rotate left. 
Count  The number of bits to rotate left. 
Rotates a 64bit integer left between 0 and 63 bits, filling the low bits with the high bits that were rotated.
This function rotates the 64bit 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.
Operand  The 64bit operand to rotate left. 
Count  The number of bits to rotate left. 
Shifts a 64bit integer left between 0 and 63 bits. The low bits are filled with zeros. The shifted value is returned.
This function shifts the 64bit value Operand to the left by Count bits. The low Count bits are set to zero. The shifted value is returned.
Operand  The 64bit operand to shift left. 
Count  The number of bits to shift left. 
Shifts a 64bit integer left between 0 and 63 bits. The low bits are filled with zeros. The shifted value is returned.
This function shifts the 64bit value Operand to the left by Count bits. The low Count bits are set to zero. The shifted value is returned.
Operand  The 64bit operand to shift left. 
Count  The number of bits to shift left. 
Definition at line 24 of file LShiftU64.c.
Divides a 64bit unsigned integer by a 32bit unsigned integer and generates a 32bit unsigned remainder.
This function divides the 64bit unsigned value Dividend by the 32bit unsigned value Divisor and generates a 32bit remainder. This function returns the 32bit unsigned remainder.
Dividend  A 64bit unsigned value. 
Divisor  A 32bit unsigned value. 
Divides a 64bit unsigned integer by a 32bit unsigned integer and generates a 32bit unsigned remainder.
This function divides the 64bit unsigned value Dividend by the 32bit unsigned value Divisor and generates a 32bit remainder. This function returns the 32bit unsigned remainder.
Dividend  A 64bit unsigned value. 
Divisor  A 32bit unsigned value. 
Definition at line 25 of file ModU64x32.c.
Multiplies a 64bit unsigned integer by a 32bit unsigned integer and generates a 64bit unsigned result.
This function multiplies the 64bit unsigned value Multiplicand by the 32bit unsigned value Multiplier and generates a 64bit unsigned result. This 64 bit unsigned result is returned.
Multiplicand  A 64bit unsigned value. 
Multiplier  A 32bit unsigned value. 
Multiples a 64bit unsigned integer by a 32bit unsigned integer and generates a 64bit unsigned result.
This function multiples the 64bit unsigned value Multiplicand by the 32bit unsigned value Multiplier and generates a 64bit unsigned result. This 64 bit unsigned result is returned.
Multiplicand  A 64bit unsigned value. 
Multiplier  A 32bit unsigned value. 
Definition at line 25 of file MultU64x32.c.
Multiplies a 64bit unsigned integer by a 64bit unsigned integer and generates a 64bit unsigned result.
This function multiples the 64bit unsigned value Multiplicand by the 64bit unsigned value Multiplier and generates a 64bit unsigned result. This 64 bit unsigned result is returned.
Multiplicand  A 64bit unsigned value. 
Multiplier  A 64bit unsigned value. 
Multiplies a 64bit unsigned integer by a 64bit unsigned integer and generates a 64bit unsigned result.
This function multiplies the 64bit unsigned value Multiplicand by the 64bit unsigned value Multiplier and generates a 64bit unsigned result. This 64 bit unsigned result is returned.
Multiplicand  A 64bit unsigned value. 
Multiplier  A 64bit unsigned value. 
Multiplies a 64bit unsigned integer by a 64bit unsigned integer and generates a 64bit unsigned result.
This function multiplies the 64bit unsigned value Multiplicand by the 64bit unsigned value Multiplier and generates a 64bit unsigned result. This 64 bit unsigned result is returned.
Multiplicand  A 64bit unsigned value. 
Multiplier  A 64bit unsigned value. 
Definition at line 25 of file MultU64x64.c.
Rotates a 64bit integer right between 0 and 63 bits, filling the high bits with the high low bits that were rotated.
This function rotates the 64bit value Operand to the right by Count bits. The high Count bits are filled with the low Count bits of Operand. The rotated value is returned.
Operand  The 64bit operand to rotate right. 
Count  The number of bits to rotate right. 
Rotates a 64bit integer right between 0 and 63 bits, filling the high bits with the high low bits that were rotated.
This function rotates the 64bit 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.
Operand  The 64bit operand to rotate right. 
Count  The number of bits to rotate right. 
Rotates a 64bit integer right between 0 and 63 bits, filling the high bits with the high low bits that were rotated.
This function rotates the 64bit 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.
Operand  The 64bit operand to rotate right. 
Count  The number of bits to rotate right. 
Shifts a 64bit integer right between 0 and 63 bits. The high bits are filled with zeros. The shifted value is returned.
This function shifts the 64bit value Operand to the right by Count bits. The high Count bits are set to zero. The shifted value is returned.
Operand  The 64bit operand to shift right. 
Count  The number of bits to shift right. 
Shifts a 64bit integer right between 0 and 63 bits. This high bits are filled with zeros. The shifted value is returned.
This function shifts the 64bit value Operand to the right by Count bits. The high Count bits are set to zero. The shifted value is returned.
Operand  The 64bit operand to shift right. 
Count  The number of bits to shift right. 
Shifts a 64bit integer right between 0 and 63 bits. This high bits are filled with zeros. The shifted value is returned.
This function shifts the 64bit value Operand to the right by Count bits. The high Count bits are set to zero. The shifted value is returned.
Operand  The 64bit operand to shift right. 
Count  The number of bits to shift right. 
Definition at line 24 of file RShiftU64.c.
Switches the endianess of a 64bit integer.
This function swaps the bytes in a 64bit unsigned value to switch the value from little endian to big endian or vice versa. The byte swapped value is returned.
Operand  A 64bit unsigned value. 
Switches the endianess of a 64bit integer.
This function swaps the bytes in a 64bit unsigned value to switch the value from little endian to big endian or vice versa. The byte swapped value is returned.
Operand  A 64bit unsigned value. 
Definition at line 23 of file SwapBytes64.c.
VOID EFIAPI InternalSwitchStack  (  IN SWITCH_STACK_ENTRY_POINT  EntryPoint, 
IN VOID *Context1  OPTIONAL,  
IN VOID *Context2  OPTIONAL,  
IN VOID *  NewStack,  
IN VA_LIST  Marker  
) 
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. Marker will be ignored on IA32, 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().
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. 
Marker  VA_LIST marker for the variable argument list. 
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 passes in the parameters specified by Context1 and Context2. Context1 and Context2 are optional and may be NULL. The function EntryPoint must never return. Marker will be ignored on IA32, 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().
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. 
Marker  A VA_LIST marker for the variable argument list. 
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. Marker will be ignored on IA32, 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().
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. 
Marker  A VA_LIST marker for the variable argument list. 
Definition at line 62 of file InternalSwitchStack.c.