TianoCore EDK2 master

Go to the source code of this file.
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) 
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) 
Provides string functions, linked list functions, math functions, synchronization functions, file path functions, and CPU architecturespecific 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.
SPDXLicenseIdentifier: BSD2ClausePatent
Definition in file BaseLib.h.
#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  
) 
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.
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 
#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.
ListHead  The head note of a list to initialize. 
Prototype for comparison function for any two element types.
[in]  Buffer1  The pointer to first buffer. 
[in]  Buffer2  The pointer to second buffer. 
0  Buffer1 equal to Buffer2. 
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()
Context1  Context1 parameter passed into SwitchStack(). 
Context2  Context2 parameter passed into SwitchStack(). 
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.
If Count is greater than 63, then ASSERT().
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 the 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.
If Count is greater than 63, then ASSERT().
Operand  The 64bit operand to shift right. 
Count  The number of bits to shift right. 
Definition at line 28 of file ARShiftU64.c.
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.
Destination  A pointer to a Nullterminated Ascii string. 
DestMax  The maximum number of Destination Ascii char, including terminating null char. 
Source  A pointer to a Nullterminated Ascii string. 
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 1955 of file SafeString.c.
Compares two Nullterminated ASCII strings, and returns the difference between the first mismatched ASCII characters.
This function compares the Nullterminated ASCII string FirstString to the Nullterminated 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 Nullterminator, then ASSERT(). If PcdMaximumAsciiStringLength is not zero and SecondString contains more than PcdMaximumAsciiStringLength ASCII characters not including the Nullterminator, then ASSERT().
FirstString  The pointer to a Nullterminated ASCII string. 
SecondString  The pointer to a Nullterminated ASCII string. 
==0  FirstString is identical to SecondString. 
!=0  FirstString is not identical to SecondString. 
Compares two Nullterminated ASCII strings, and returns the difference between the first mismatched ASCII characters.
This function compares the Nullterminated ASCII string FirstString to the Nullterminated 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 Nullterminator, then ASSERT(). If PcdMaximumAsciiStringLength is not zero and SecondString contains more than PcdMaximumAsciiStringLength ASCII characters, not including the Nullterminator, then ASSERT().
FirstString  A pointer to a Nullterminated ASCII string. 
SecondString  A pointer to a Nullterminated ASCII string. 
==0  FirstString is identical to SecondString. 
!=0  FirstString is not identical to SecondString. 
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.
Destination  A pointer to a Nullterminated Ascii string. 
DestMax  The maximum number of Destination Ascii char, including terminating null char. 
Source  A pointer to a Nullterminated Ascii string. 
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 1788 of file SafeString.c.
Convert a Nullterminated 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 [09]. 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 Nullterminator, 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 Nullterminator, then ASSERT().
String  The pointer to a Nullterminated ASCII string. 
Value  translated from String. 
Convert a Nullterminated 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 [09]. 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 Nullterminator, 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 Nullterminator, then ASSERT().
String  A pointer to a Nullterminated ASCII string. 
Value  translated from String. 
RETURN_STATUS EFIAPI AsciiStrDecimalToUint64S  (  IN CONST CHAR8 *  String, 
OUT CHAR8 **EndPointer  OPTIONAL,  
OUT UINT64 *  Data  
) 
Convert a Nullterminated 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 [09]. 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 Nullterminator, 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.
String  Pointer to a Nullterminated Ascii string. 
EndPointer  Pointer to character that stops scan. 
Data  Pointer to the converted value. 
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 Nullterminator. 
RETURN_UNSUPPORTED  If the number represented by String exceeds the range defined by UINT64. 
Definition at line 2278 of file SafeString.c.
Convert a Nullterminated 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 [09]. 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 Nullterminator, 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 Nullterminator, then ASSERT().
String  The pointer to a Nullterminated ASCII string. 
The  value translated from String. 
Convert a Nullterminated 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 [09]. 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 Nullterminator, 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 Nullterminator, then ASSERT().
String  A pointer to a Nullterminated ASCII string. 
Value  translated from String. 
RETURN_STATUS EFIAPI AsciiStrDecimalToUintnS  (  IN CONST CHAR8 *  String, 
OUT CHAR8 **EndPointer  OPTIONAL,  
OUT UINTN *  Data  
) 
Convert a Nullterminated 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 [09]. 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 Nullterminator, 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.
String  Pointer to a Nullterminated Ascii string. 
EndPointer  Pointer to character that stops scan. 
Data  Pointer to the converted value. 
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 Nullterminator. 
RETURN_UNSUPPORTED  If the number represented by String exceeds the range defined by UINTN. 
Definition at line 2170 of file SafeString.c.
RETURN_STATUS EFIAPI AsciiStrHexToBytes  (  IN CONST CHAR8 *  String, 
IN UINTN  Length,  
OUT UINT8 *  Buffer,  
IN UINTN  MaxBufferSize  
) 
Convert a Nullterminated 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 [09], [af] and [AF]. 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.
String  Pointer to a Nullterminated ASCII string. 
Length  The number of ASCII characters to decode. 
Buffer  Pointer to the converted bytes array. 
MaxBufferSize  The maximum size of Buffer. 
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 Nullterminator. 
RETURN_BUFFER_TOO_SMALL  If MaxBufferSize is less than (Length / 2). 
Definition at line 3552 of file SafeString.c.
Convert a Nullterminated 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 [09], [af] and [AF]. 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 Nullterminator, 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 Nullterminator, then ASSERT().
String  The pointer to a Nullterminated ASCII string. 
Value  translated from String. 
Convert a Nullterminated 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 [09], [af] and [AF]. 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 Nullterminator, 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 Nullterminator, then ASSERT().
String  A pointer to a Nullterminated ASCII string. 
Value  translated from String. 
RETURN_STATUS EFIAPI AsciiStrHexToUint64S  (  IN CONST CHAR8 *  String, 
OUT CHAR8 **EndPointer  OPTIONAL,  
OUT UINT64 *  Data  
) 
Convert a Nullterminated 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 [09], [af] and [AF]. 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 Nullterminator, 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.
String  Pointer to a Nullterminated Ascii string. 
EndPointer  Pointer to character that stops scan. 
Data  Pointer to the converted value. 
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 Nullterminator. 
RETURN_UNSUPPORTED  If the number represented by String exceeds the range defined by UINT64. 
Definition at line 2514 of file SafeString.c.
Convert a Nullterminated 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 [09], [af] and [AF]. 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 Nullterminator, 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 Nullterminator, then ASSERT().
String  The pointer to a Nullterminated ASCII string. 
Value  translated from String. 
Convert a Nullterminated 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 [09], [af] and [AF]. 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 Nullterminator, 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 Nullterminator, then ASSERT().
String  A pointer to a Nullterminated ASCII string. 
Value  translated from String. 
RETURN_STATUS EFIAPI AsciiStrHexToUintnS  (  IN CONST CHAR8 *  String, 
OUT CHAR8 **EndPointer  OPTIONAL,  
OUT UINTN *  Data  
) 
Convert a Nullterminated 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 [09], [af] and [AF]. 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 Nullterminator, 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.
String  Pointer to a Nullterminated Ascii string. 
EndPointer  Pointer to character that stops scan. 
Data  Pointer to the converted value. 
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 Nullterminator. 
RETURN_UNSUPPORTED  If the number represented by String exceeds the range defined by UINTN. 
Definition at line 2390 of file SafeString.c.
Performs a case insensitive comparison of two Nullterminated ASCII strings, and returns the difference between the first mismatched ASCII characters.
This function performs a case insensitive comparison of the Nullterminated ASCII string FirstString to the Nullterminated 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 Nullterminator, then ASSERT(). If PcdMaximumAsciiStringLength is not zero and SecondString contains more than PcdMaximumAsciiStringLength ASCII characters not including the Nullterminator, then ASSERT().
FirstString  The pointer to a Nullterminated ASCII string. 
SecondString  The pointer to a Nullterminated ASCII string. 
==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 Nullterminated ASCII strings, and returns the difference between the first mismatched ASCII characters.
This function performs a case insensitive comparison of the Nullterminated ASCII string FirstString to the Nullterminated 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 Nullterminator, then ASSERT(). If PcdMaximumAsciiStringLength is not zero and SecondString contains more than PcdMaximumAsciiStringLength ASCII characters, not including the Nullterminator, then ASSERT().
FirstString  A pointer to a Nullterminated ASCII string. 
SecondString  A pointer to a Nullterminated ASCII string. 
==0  FirstString is identical to SecondString using case insensitive comparisons. 
!=0  FirstString is not identical to SecondString using case insensitive comparisons. 
Returns the length of a Nullterminated ASCII string.
This function returns the number of ASCII characters in the Nullterminated 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 Nullterminator, then ASSERT().
String  The pointer to a Nullterminated ASCII string. 
Returns the length of a Nullterminated ASCII string.
This function returns the number of ASCII characters in the Nullterminated 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 Nullterminator, then ASSERT().
String  A pointer to a Nullterminated ASCII string. 
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.
Destination  A pointer to a Nullterminated Ascii string. 
DestMax  The maximum number of Destination Ascii char, including terminating null char. 
Source  A pointer to a Nullterminated Ascii string. 
Length  The maximum number of Ascii characters to copy. 
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 2051 of file SafeString.c.
INTN EFIAPI AsciiStrnCmp  (  IN CONST CHAR8 *  FirstString, 
IN CONST CHAR8 *  SecondString,  
IN UINTN  Length  
) 
Compares two Nullterminated ASCII strings with maximum lengths, and returns the difference between the first mismatched ASCII characters.
This function compares the Nullterminated ASCII string FirstString to the Nullterminated 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 Nullterminator, then ASSERT(). If PcdMaximumAsciiStringLength is not zero, and SecondString contains more than PcdMaximumAsciiStringLength ASCII characters, not including the Nullterminator, then ASSERT().
FirstString  The pointer to a Nullterminated ASCII string. 
SecondString  The pointer to a Nullterminated ASCII string. 
Length  The maximum number of ASCII characters for compare. 
==0  FirstString is identical to SecondString. 
!=0  FirstString is not identical to SecondString. 
Compares two Nullterminated ASCII strings with maximum lengths, and returns the difference between the first mismatched ASCII characters.
This function compares the Nullterminated ASCII string FirstString to the Nullterminated 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 Nullterminator, then ASSERT(). If PcdMaximumAsciiStringLength is not zero, and SecondString contains more than PcdMaximumAsciiStringLength ASCII characters, not including the Nullterminator, then ASSERT().
FirstString  A pointer to a Nullterminated ASCII string. 
SecondString  A pointer to a Nullterminated ASCII string. 
Length  The maximum number of ASCII characters for compare. 
==0  FirstString is identical to SecondString. 
!=0  FirstString is not identical to SecondString. 
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.
Destination  A pointer to a Nullterminated Ascii string. 
DestMax  The maximum number of Destination Ascii char, including terminating null char. 
Source  A pointer to a Nullterminated Ascii string. 
Length  The maximum number of Ascii characters to copy. 
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 1866 of file SafeString.c.
Returns the length of a Nullterminated Ascii string.
This function is similar as strlen_s defined in C11.
String  A pointer to a Nullterminated Ascii string. 
MaxSize  The maximum number of Destination Ascii char, including terminating null char. 
0  If String is NULL. 
MaxSize  If there is no null character in the first MaxSize characters of String. 
Definition at line 1687 of file SafeString.c.
Returns the size of a Nullterminated Ascii string in bytes, including the Null terminator.
This function returns the size of the Nullterminated Ascii string specified by String in bytes, including the Null terminator.
String  A pointer to a Nullterminated Ascii string. 
MaxSize  The maximum number of Destination Ascii char, including the Null terminator. 
0  If String is NULL. 
(sizeof  (CHAR8) * (MaxSize + 1)) If there is no Null terminator in the first MaxSize characters of String. 
Definition at line 1740 of file SafeString.c.
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 Nullterminated Ascii string to a Nullterminated 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 Nullterminator 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 16bit boundary, then ASSERT().
If an error is returned, then Destination and DestinationLength are unmodified.
Source  The pointer to a Nullterminated Ascii string. 
Length  The maximum number of Ascii characters to convert. 
Destination  The pointer to a Nullterminated Unicode string. 
DestMax  The maximum number of Destination Unicode char, including terminating null char. 
DestinationLength  The number of Ascii characters converted. 
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 2955 of file SafeString.c.
Returns the size of a Nullterminated ASCII string in bytes, including the Null terminator.
This function returns the size, in bytes, of the Nullterminated 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 Nullterminator, then ASSERT().
String  The pointer to a Nullterminated ASCII string. 
Returns the size of a Nullterminated ASCII string in bytes, including the Null terminator.
This function returns the size, in bytes, of the Nullterminated 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 Nullterminator, then ASSERT().
String  A pointer to a Nullterminated ASCII string. 
Returns the first occurrence of a Nullterminated ASCII substring in a Nullterminated 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 Nullterminator, then ASSERT().
String  The pointer to a Nullterminated ASCII string. 
SearchString  The pointer to a Nullterminated ASCII string to search for. 
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 Nullterminated ASCII substring in a Nullterminated 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 Nullterminator, then ASSERT().
String  A pointer to a Nullterminated ASCII string. 
SearchString  A pointer to a Nullterminated ASCII string to search for. 
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. 
Convert a Nullterminated 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:
aabbccddeeffgghhiijjkkllmmnnoopp
The pairs aa  pp are two characters in the range [09], [af] and [AF], 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]
String  Pointer to a Nullterminated ASCII string. 
Guid  Pointer to the converted GUID. 
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 3441 of file SafeString.c.
RETURN_STATUS EFIAPI AsciiStrToIpv4Address  (  IN CONST CHAR8 *  String, 
OUT CHAR8 **EndPointer  OPTIONAL,  
OUT IPv4_ADDRESS *  Address,  
OUT UINT8 *PrefixLength  OPTIONAL  
) 
Convert a Nullterminated 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 [09]. 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.
String  Pointer to a Nullterminated 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_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 3296 of file SafeString.c.
RETURN_STATUS EFIAPI AsciiStrToIpv6Address  (  IN CONST CHAR8 *  String, 
OUT CHAR8 **EndPointer  OPTIONAL,  
OUT IPv6_ADDRESS *  Address,  
OUT UINT8 *PrefixLength  OPTIONAL  
) 
Convert a Nullterminated 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 [09], [af] and [AF]. 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 [09]. 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.
String  Pointer to a Nullterminated 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_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 3078 of file SafeString.c.
RETURN_STATUS EFIAPI AsciiStrToUnicodeStrS  (  IN CONST CHAR8 *  Source, 
OUT CHAR16 *  Destination,  
IN UINTN  DestMax  
) 
Convert one Nullterminated ASCII string to a Nullterminated 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 Nullterminator 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 16bit boundary, then ASSERT().
If an error is returned, then the Destination is unmodified.
Source  The pointer to a Nullterminated ASCII string. 
Destination  The pointer to a Nullterminated Unicode string. 
DestMax  The maximum number of Destination Unicode char, including terminating null char. 
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 2856 of file SafeString.c.
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 8bit binary representation, based on RFC4648.
Decoding occurs according to "Table 1: The Base 64 Alphabet" in RFC4648.
Whitespace is ignored at all positions:
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.
[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 8bit binary representation. Allocated by the caller. May be NULL if DestinationSize is zero on input. If NULL, decoding is performed, but the 8bit binary representation is not stored. If nonNULL 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_SUCCESS  SourceSize CHAR8 elements at Source have been decoded to onoutput 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 nonNULL, and (Source + SourceSize) would wrap around MAX_ADDRESS. 
RETURN_INVALID_PARAMETER  Destination is nonNULL, 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. 
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 Nullterminated 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.
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_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. 
Converts an 8bit BCD value to an 8bit value.
Converts the 8bit BCD value specified by Value to an 8bit value. The 8bit value is returned.
If Value >= 0xA0, then ASSERT(). If (Value & 0x0F) >= 0x0A, then ASSERT().
Value  The 8bit BCD value to convert to an 8bit value. 
UINT16 EFIAPI BitFieldAnd16  (  IN UINT16  Operand, 
IN UINTN  StartBit,  
IN UINTN  EndBit,  
IN UINT16  AndData  
) 
Reads a bit field from a 16bit 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 16bit value is returned.
If 16bit 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().
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 
Reads a bit field from a 16bit 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 16bit value is returned.
If 16bit 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().
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. 
Definition at line 447 of file BitField.c.
UINT32 EFIAPI BitFieldAnd32  (  IN UINT32  Operand, 
IN UINTN  StartBit,  
IN UINTN  EndBit,  
IN UINT32  AndData  
) 
Reads a bit field from a 32bit 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 32bit value is returned.
If 32bit 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().
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 
Reads a bit field from a 32bit 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 32bit value is returned.
If 32bit 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().
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. 
Definition at line 639 of file BitField.c.
UINT64 EFIAPI BitFieldAnd64  (  IN UINT64  Operand, 
IN UINTN  StartBit,  
IN UINTN  EndBit,  
IN UINT64  AndData  
) 
Reads a bit field from a 64bit 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 64bit value is returned.
If 64bit 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().
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 
Reads a bit field from a 64bit 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 64bit value is returned.
If 64bit 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().
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. 
Definition at line 845 of file BitField.c.
UINT8 EFIAPI BitFieldAnd8  (  IN UINT8  Operand, 
IN UINTN  StartBit,  
IN UINTN  EndBit,  
IN UINT8  AndData  
) 
Reads a bit field from an 8bit 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 8bit value is returned.
If 8bit 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().
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. 
Definition at line 255 of file BitField.c.
UINT16 EFIAPI BitFieldAndThenOr16  (  IN UINT16  Operand, 
IN UINTN  StartBit,  
IN UINTN  EndBit,  
IN UINT16  AndData,  
IN UINT16  OrData  
) 
Reads a bit field from a 16bit 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 16bit value is returned.
If 16bit 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().
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. 
Definition at line 488 of file BitField.c.
UINT32 EFIAPI BitFieldAndThenOr32  (  IN UINT32  Operand, 
IN UINTN  StartBit,  
IN UINTN  EndBit,  
IN UINT32  AndData,  
IN UINT32  OrData  
) 
Reads a bit field from a 32bit 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 32bit value is returned.
If 32bit 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().
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. 
Definition at line 680 of file BitField.c.
UINT64 EFIAPI BitFieldAndThenOr64  (  IN UINT64  Operand, 
IN UINTN  StartBit,  
IN UINTN  EndBit,  
IN UINT64  AndData,  
IN UINT64  OrData  
) 
Reads a bit field from a 64bit 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 64bit value is returned.
If 64bit 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().
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. 
Definition at line 900 of file BitField.c.
UINT8 EFIAPI BitFieldAndThenOr8  (  IN UINT8  Operand, 
IN UINTN  StartBit,  
IN UINTN  EndBit,  
IN UINT8  AndData,  
IN UINT8  OrData  
) 
Reads a bit field from an 8bit 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 8bit value is returned.
If 8bit 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().
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. 
Definition at line 296 of file BitField.c.
Reads a bit field from a 32bit 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().
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. 
Definition at line 940 of file BitField.c.
Reads a bit field from a 64bit 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().
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. 
Definition at line 984 of file BitField.c.
UINT16 EFIAPI BitFieldOr16  (  IN UINT16  Operand, 
IN UINTN  StartBit,  
IN UINTN  EndBit,  
IN UINT16  OrData  
) 
Reads a bit field from a 16bit 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 16bit value is returned.
If 16bit 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().
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 
Reads a bit field from a 16bit 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 16bit value is returned.
If 16bit 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().
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. 
Definition at line 409 of file BitField.c.
UINT32 EFIAPI BitFieldOr32  (  IN UINT32  Operand, 
IN UINTN  StartBit,  
IN UINTN  EndBit,  
IN UINT32  OrData  
) 
Reads a bit field from a 32bit 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 32bit value is returned.
If 32bit 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().
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. 
Definition at line 601 of file BitField.c.
UINT64 EFIAPI BitFieldOr64  (  IN UINT64  Operand, 
IN UINTN  StartBit,  
IN UINTN  EndBit,  
IN UINT64  OrData  
) 
Reads a bit field from a 64bit 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 64bit value is returned.
If 64bit 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().
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 
Definition at line 793 of file BitField.c.
Reads a bit field from an 8bit 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 8bit value is returned.
If 8bit 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().
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 
Reads a bit field from an 8bit 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 8bit value is returned.
If 8bit 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().
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. 
Definition at line 217 of file BitField.c.
Returns a bit field from a 16bit value.
Returns the bitfield specified by the StartBit and the EndBit from Operand.
If 16bit 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().
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. 
Definition at line 335 of file BitField.c.
Returns a bit field from a 32bit value.
Returns the bitfield specified by the StartBit and the EndBit from Operand.
If 32bit 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().
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. 
Definition at line 527 of file BitField.c.
Returns a bit field from a 64bit value.
Returns the bitfield specified by the StartBit and the EndBit from Operand.
If 64bit 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().
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. 
Definition at line 719 of file BitField.c.
Returns a bit field from an 8bit value.
Returns the bitfield specified by the StartBit and the EndBit from Operand.
If 8bit 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().
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. 
Definition at line 143 of file BitField.c.
UINT16 EFIAPI BitFieldWrite16  (  IN UINT16  Operand, 
IN UINTN  StartBit,  
IN UINTN  EndBit,  
IN UINT16  Value  
) 
Writes a bit field to a 16bit 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 16bit value is returned.
If 16bit 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().
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. 
Writes a bit field to a 16bit 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 16bit value is returned.
If 16bit 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().
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. 
Definition at line 371 of file BitField.c.
UINT32 EFIAPI BitFieldWrite32  (  IN UINT32  Operand, 
IN UINTN  StartBit,  
IN UINTN  EndBit,  
IN UINT32  Value  
) 
Writes a bit field to a 32bit 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 32bit value is returned.
If 32bit 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().
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. 
Writes a bit field to a 32bit 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 32bit value is returned.
If 32bit 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().
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. 
Definition at line 563 of file BitField.c.
UINT64 EFIAPI BitFieldWrite64  (  IN UINT64  Operand, 
IN UINTN  StartBit,  
IN UINTN  EndBit,  
IN UINT64  Value  
) 
Writes a bit field to a 64bit 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 64bit value is returned.
If 64bit 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().
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. 
Writes a bit field to a 64bit 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 64bit value is returned.
If 64bit 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().
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. 
Definition at line 755 of file BitField.c.
UINT8 EFIAPI BitFieldWrite8  (  IN UINT8  Operand, 
IN UINTN  StartBit,  
IN UINTN  EndBit,  
IN UINT8  Value  
) 
Writes a bit field to an 8bit 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 8bit value is returned.
If 8bit 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().
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. 
Writes a bit field to an 8bit 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 8bit value is returned.
If 8bit 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().
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. 
Definition at line 179 of file BitField.c.
Returns the two's complement checksum of all elements in a buffer of 16bit values.
This function first calculates the sum of the 16bit 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 16bit boundary, then ASSERT(). If Length is not aligned on a 16bit boundary, then ASSERT(). If Length is greater than (MAX_ADDRESS  Buffer + 1), then ASSERT().
Buffer  The pointer to the buffer to carry out the checksum operation. 
Length  The size, in bytes, of Buffer. 
Returns the two's complement checksum of all elements in a buffer of 16bit values.
This function first calculates the sum of the 16bit 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 16bit boundary, then ASSERT(). If Length is not aligned on a 16bit boundary, then ASSERT(). If Length is greater than (MAX_ADDRESS  Buffer + 1), then ASSERT().
Buffer  The pointer to the buffer to carry out the checksum operation. 
Length  The size, in bytes, of Buffer. 
Definition at line 150 of file CheckSum.c.
Returns the two's complement checksum of all elements in a buffer of 32bit values.
This function first calculates the sum of the 32bit 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 32bit boundary, then ASSERT(). If Length is not aligned on a 32bit boundary, then ASSERT(). If Length is greater than (MAX_ADDRESS  Buffer + 1), then ASSERT().
Buffer  The pointer to the buffer to carry out the checksum operation. 
Length  The size, in bytes, of Buffer. 
Returns the two's complement checksum of all elements in a buffer of 32bit values.
This function first calculates the sum of the 32bit 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 32bit boundary, then ASSERT(). If Length is not aligned on a 32bit boundary, then ASSERT(). If Length is greater than (MAX_ADDRESS  Buffer + 1), then ASSERT().
Buffer  The pointer to the buffer to carry out the checksum operation. 
Length  The size, in bytes, of Buffer. 
Definition at line 230 of file CheckSum.c.
Returns the two's complement checksum of all elements in a buffer of 64bit values.
This function first calculates the sum of the 64bit 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 64bit boundary, then ASSERT(). If Length is not aligned on a 64bit boundary, then ASSERT(). If Length is greater than (MAX_ADDRESS  Buffer + 1), then ASSERT().
Buffer  The pointer to the buffer to carry out the checksum operation. 
Length  The size, in bytes, of Buffer. 
Returns the two's complement checksum of all elements in a buffer of 64bit values.
This function first calculates the sum of the 64bit 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 64bit boundary, then ASSERT(). If Length is not aligned on a 64bit boundary, then ASSERT(). If Length is greater than (MAX_ADDRESS  Buffer + 1), then ASSERT().
Buffer  The pointer to the buffer to carry out the checksum operation. 
Length  The size, in bytes, of Buffer. 
Definition at line 310 of file CheckSum.c.
Returns the two's complement checksum of all elements in a buffer of 8bit values.
This function first calculates the sum of the 8bit 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().
Buffer  The pointer to the buffer to carry out the checksum operation. 
Length  The size, in bytes, of Buffer. 
Returns the two's complement checksum of all elements in a buffer of 8bit values.
This function first calculates the sum of the 8bit 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().
Buffer  The pointer to the buffer to carry out the checksum operation. 
Length  The size, in bytes, of Buffer. 
Definition at line 70 of file CheckSum.c.
Computes and returns a 32bit CRC for a data buffer. CRC32 value bases on ITUT V.42.
If Buffer is NULL, then ASSERT(). If Length is greater than (MAX_ADDRESS  Buffer + 1), then ASSERT().
[in]  Buffer  A pointer to the buffer on which the 32bit CRC is to be computed. 
[in]  Length  The number of bytes in the buffer Data. 
Crc32  The 32bit CRC was computed for the data buffer. 
Definition at line 599 of file CheckSum.c.
Returns the sum of all elements in a buffer of 16bit values. During calculation, the carry bits are dropped.
This function calculates the sum of the 16bit values in the buffer specified by Buffer and Length. The carry bits in result of addition are dropped. The 16bit result is returned. If Length is 0, then 0 is returned.
If Buffer is NULL, then ASSERT(). If Buffer is not aligned on a 16bit boundary, then ASSERT(). If Length is not aligned on a 16bit boundary, then ASSERT(). If Length is greater than (MAX_ADDRESS  Buffer + 1), then ASSERT().
Buffer  The pointer to the buffer to carry out the sum operation. 
Length  The size, in bytes, of Buffer. 
Definition at line 106 of file CheckSum.c.
Returns the sum of all elements in a buffer of 32bit values. During calculation, the carry bits are dropped.
This function calculates the sum of the 32bit values in the buffer specified by Buffer and Length. The carry bits in result of addition are dropped. The 32bit result is returned. If Length is 0, then 0 is returned.
If Buffer is NULL, then ASSERT(). If Buffer is not aligned on a 32bit boundary, then ASSERT(). If Length is not aligned on a 32bit boundary, then ASSERT(). If Length is greater than (MAX_ADDRESS  Buffer + 1), then ASSERT().
Buffer  The pointer to the buffer to carry out the sum operation. 
Length  The size, in bytes, of Buffer. 
Definition at line 186 of file CheckSum.c.
Returns the sum of all elements in a buffer of 64bit values. During calculation, the carry bits are dropped.
This function calculates the sum of the 64bit values in the buffer specified by Buffer and Length. The carry bits in result of addition are dropped. The 64bit result is returned. If Length is 0, then 0 is returned.
If Buffer is NULL, then ASSERT(). If Buffer is not aligned on a 64bit boundary, then ASSERT(). If Length is not aligned on a 64bit boundary, then ASSERT(). If Length is greater than (MAX_ADDRESS  Buffer + 1), then ASSERT().
Buffer  The pointer to the buffer to carry out the sum operation. 
Length  The size, in bytes, of Buffer. 
Definition at line 266 of file CheckSum.c.
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().
Buffer  The pointer to the buffer to carry out the sum operation. 
Length  The size, in bytes, of Buffer. 
Definition at line 32 of file CheckSum.c.
Convert a Unicode character to upper case only if it maps to a valid smallcase ASCII character.
This internal function only deal with Unicode character which maps to a valid smallcase ASCII character, i.e. L'a' to L'z'. For other Unicode character, the input character is returned directly.
Char  The character to convert. 
LowerCharacter  If the Char is with range L'a' to L'z'. 
Unchanged  Otherwise. 
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.
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 23 of file CpuDeadLoop.c.
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.
Disables CPU interrupts.
Disables CPU interrupts.
Disables CPU interrupts.
Definition at line 54 of file CpuBreakpoint.c.
INT64 EFIAPI DivS64x64Remainder  (  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 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.
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().
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 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.
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().
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 36 of file DivS64x64Remainder.c.
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.
If Divisor is 0, then ASSERT().
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.
If Divisor is 0, then ASSERT().
Dividend  A 64bit unsigned value. 
Divisor  A 32bit unsigned value. 
Definition at line 29 of file DivU64x32.c.
UINT64 EFIAPI DivU64x32Remainder  (  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.
If Divisor is 0, then ASSERT().
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.
If Divisor is 0, then ASSERT().
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. 
Definition at line 32 of file DivU64x32Remainder.c.
UINT64 EFIAPI DivU64x64Remainder  (  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.
If Divisor is 0, then ASSERT().
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 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.
If Divisor is 0, then ASSERT().
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. 
Definition at line 32 of file DivU64x64Remainder.c.
Enables CPU interrupts for the smallest window required to capture any pending interrupts.
Definition at line 101 of file CpuBreakpoint.c.
Enables CPU interrupts.
Enables CPU interrupts.
Enables CPU interrupts.
Definition at line 67 of file CpuBreakpoint.c.
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().
List  A pointer to the head node of a doubly linked list. 
List  The list is empty. 
Retrieves the first node of a doublylinked list.
Returns the first node of a doublylinked 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().
List  A pointer to the head node of a doublylinked list. 
List  The list is empty. 
Definition at line 298 of file LinkedList.c.
Retrieves the current CPU interrupt state.
Returns TRUE if interrupts are currently enabled. Otherwise returns FALSE.
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.
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.
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.
InterruptState  TRUE if interrupts should enabled. FALSE if interrupts should be disabled. 
Definition at line 86 of file CpuBreakpoint.c.
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().
List  A pointer to the head node of a doubly linked list. 
Node  A pointer to a node in the doubly linked list. 
Retrieves the next node of a doublylinked list.
Returns the node of a doublylinked 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().
List  A pointer to the head node of a doublylinked list. 
Node  A pointer to a node in the doublylinked list. 
Definition at line 333 of file LinkedList.c.
Returns the value of the highest bit set in a 32bit value. Equivalent to 1 << log2(x).
This function computes the value of the highest bit set in the 32bit value specified by Operand. If Operand is zero, then zero is returned.
Operand  The 32bit operand to evaluate. 
0  Operand is zero. 
Definition at line 26 of file GetPowerOfTwo32.c.
Returns the value of the highest bit set in a 64bit value. Equivalent to 1 << log2(x).
This function computes the value of the highest bit set in the 64bit value specified by Operand. If Operand is zero, then zero is returned.
Operand  The 64bit operand to evaluate. 
0  Operand is zero. 
Definition at line 26 of file GetPowerOfTwo64.c.
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().
List  A pointer to the head node of a doubly linked list. 
Node  A pointer to a node in the doubly linked list. 
Retrieves the previous node of a doublylinked list.
Returns the node of a doublylinked 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().
List  A pointer to the head node of a doublylinked list. 
Node  A pointer to a node in the doublylinked list. 
Definition at line 369 of file LinkedList.c.
Returns the bit position of the highest bit set in a 32bit value. Equivalent to log2(x).
This function computes the bit position of the highest bit set in the 32bit value specified by Operand. If Operand is zero, then 1 is returned. Otherwise, a value between 0 and 31 is returned.
Operand  The 32bit operand to evaluate. 
0..31  Position of the highest bit set in Operand if found. 
1  Operand is zero. 
Definition at line 27 of file HighBitSet32.c.
Returns the bit position of the highest bit set in a 64bit value. Equivalent to log2(x).
This function computes the bit position of the highest bit set in the 64bit value specified by Operand. If Operand is zero, then 1 is returned. Otherwise, a value between 0 and 63 is returned.
Operand  The 64bit operand to evaluate. 
0..63  Position of the highest bit set in Operand if found. 
1  Operand is zero. 
Definition at line 27 of file HighBitSet64.c.
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().
ListHead  A pointer to the head node of a new doubly linked list. 
Initializes the head node of a doublylinked list, and returns the pointer to the head node of the doublylinked 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().
ListHead  A pointer to the head node of a new doublylinked list. 
Definition at line 182 of file LinkedList.c.
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().
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. 
Adds a node to the beginning of a doublylinked list, and returns the pointer to the head node of the doublylinked list.
Adds the node Entry at the beginning of the doublylinked 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().
ListHead  A pointer to the head node of a doublylinked list. 
Entry  A pointer to a node that is to be inserted at the beginning of a doublylinked list. 
Definition at line 218 of file LinkedList.c.
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().
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. 
Adds a node to the end of a doublylinked list, and returns the pointer to the head node of the doublylinked list.
Adds the node Entry to the end of the doublylinked 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().
ListHead  A pointer to the head node of a doublylinked list. 
Entry  A pointer to a node that is to be added at the end of the doublylinked list. 
Definition at line 259 of file LinkedList.c.
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().
ListHead  A pointer to the head node of a doubly linked list. 
TRUE  The linked list is empty. 
FALSE  The linked list is not empty. 
Checks to see if a doublylinked list is empty or not.
Checks to see if the doublylinked 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().
ListHead  A pointer to the head node of a doublylinked list. 
TRUE  The linked list is empty. 
FALSE  The linked list is not empty. 
Definition at line 403 of file LinkedList.c.
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().
List  A pointer to the head node of a doubly linked list. 
Node  A pointer to a node in the doubly linked list. 
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 doublylinked list.
Returns TRUE if Node is the last node in the doublylinked 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().
List  A pointer to the head node of a doublylinked list. 
Node  A pointer to a node in the doublylinked list. 
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.
BOOLEAN EFIAPI IsNodeInList  (  IN CONST LIST_ENTRY *  FirstEntry, 
IN CONST LIST_ENTRY *  SecondEntry  
) 
Checks whether FirstEntry and SecondEntry are part of the same doublylinked 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().
FirstEntry  A pointer to a node in a linked list. 
SecondEntry  A pointer to the node to locate. 
TRUE  SecondEntry is in the same doublylinked list as FirstEntry. 
FALSE  SecondEntry isn't in the same doublylinked list as FirstEntry, or FirstEntry is invalid. 
Definition at line 121 of file LinkedList.c.
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().
List  A pointer to the head node of a doubly linked list. 
Node  A pointer to a node in the doubly linked list. 
TRUE  Node is the head of the doublylinked list pointed by List. 
FALSE  Node is not the head of the doublylinked list pointed by List. 
Determines if a node in a doublylinked list is the head node of a the same doublylinked list. This function is typically used to terminate a loop that traverses all the nodes in a doublylinked 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 doublylinked 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().
List  A pointer to the head node of a doublylinked list. 
Node  A pointer to a node in the doublylinked list. 
TRUE  Node is the head of the doublylinked list pointed by List. 
FALSE  Node is not the head of the doublylinked list pointed by List. 
Definition at line 443 of file LinkedList.c.
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 16byte boundary, then ASSERT(). If Value is 0, then ASSERT().
JumpBuffer  A pointer to CPU context buffer. 
Value  The value to return when the SetJump() context is restored and must be nonzero. 
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 16byte boundary, then ASSERT(). If Value is 0, then ASSERT().
JumpBuffer  A pointer to CPU context buffer. 
Value  The value to return when the SetJump() context is restored and must be nonzero. 
Definition at line 29 of file LongJump.c.
Returns the bit position of the lowest bit set in a 32bit value.
This function computes the bit position of the lowest bit set in the 32bit value specified by Operand. If Operand is zero, then 1 is returned. Otherwise, a value between 0 and 31 is returned.
Operand  The 32bit operand to evaluate. 
0..31  The lowest bit set in Operand was found. 
1  Operand is zero. 
Definition at line 26 of file LowBitSet32.c.
Returns the bit position of the lowest bit set in a 64bit value.
This function computes the bit position of the lowest bit set in the 64bit value specified by Operand. If Operand is zero, then 1 is returned. Otherwise, a value between 0 and 63 is returned.
Operand  The 64bit operand to evaluate. 
0..63  The lowest bit set in Operand was found. 
1  Operand is zero. 
Definition at line 27 of file LowBitSet64.c.
Rotates a 32bit integer left between 0 and 31 bits, filling the low bits with the high bits that were rotated.
This function rotates the 32bit 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().
Operand  The 32bit 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.
If Count is greater than 63, then ASSERT().
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.
If Count is greater than 63, then ASSERT().
Operand  The 64bit operand to shift left. 
Count  The number of bits to shift left. 
Definition at line 28 of file LShiftU64.c.
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.
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.
If Divisor is 0, then ASSERT().
Dividend  A 64bit unsigned value. 
Divisor  A 32bit unsigned value. 
Definition at line 29 of file ModU64x32.c.
Multiples a 64bit signed integer by a 64bit signed integer and generates a 64bit signed result.
This function multiples the 64bit signed value Multiplicand by the 64bit signed value Multiplier and generates a 64bit signed result. This 64bit signed result is returned.
Multiplicand  A 64bit signed value. 
Multiplier  A 64bit signed value. 
Multiplies a 64bit signed integer by a 64bit signed integer and generates a 64bit signed result.
This function multiplies the 64bit signed value Multiplicand by the 64bit signed value Multiplier and generates a 64bit signed result. This 64bit signed result is returned.
Multiplicand  A 64bit signed value. 
Multiplier  A 64bit signed value. 
Definition at line 27 of file MultS64x64.c.
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. 
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. 
Definition at line 27 of file MultU64x32.c.
Multiples 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. 
Definition at line 27 of file MultU64x64.c.
Function to clean up paths.
This will be done inline and the existing buffer may be larger than required upon completion.
[in]  Path  The pointer to the string containing the path. 
Definition at line 68 of file FilePaths.c.
Removes the last directory or file entry in a path.
[in,out]  Path  The pointer to the path to modify. 
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:".
[in,out]  Path  A pointer to the path to modify. 
FALSE  Nothing was found to remove. 
TRUE  A directory or file was removed. 
Definition at line 22 of file FilePaths.c.
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 preallocated 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.
[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.
Reads a 16bit value from memory that may be unaligned.
This function returns the 16bit 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().
Buffer  The pointer to a 16bit value that may be unaligned. 
Reads a 16bit value from memory that may be unaligned.
This function returns the 16bit 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().
Buffer  A pointer to a 16bit value that may be unaligned. 
Definition at line 29 of file Unaligned.c.
Reads a 24bit value from memory that may be unaligned.
This function returns the 24bit 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().
Buffer  The pointer to a 24bit value that may be unaligned. 
Reads a 24bit value from memory that may be unaligned.
This function returns the 24bit 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().
Buffer  A pointer to a 24bit value that may be unaligned. 
Definition at line 89 of file Unaligned.c.
Reads a 32bit value from memory that may be unaligned.
This function returns the 32bit 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().
Buffer  The pointer to a 32bit value that may be unaligned. 
Reads a 32bit value from memory that may be unaligned.
This function returns the 32bit 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().
Buffer  A pointer to a 32bit value that may be unaligned. 
Definition at line 145 of file Unaligned.c.
Reads a 64bit value from memory that may be unaligned.
This function returns the 64bit 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().
Buffer  The pointer to a 64bit value that may be unaligned. 
Reads a 64bit value from memory that may be unaligned.
This function returns the 64bit 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().
Buffer  A pointer to a 64bit value that may be unaligned. 
Definition at line 204 of file Unaligned.c.
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().
Entry  A pointer to a node in a linked list. 
Removes a node from a doublylinked list, and returns the node that follows the removed node.
Removes the node Entry from a doublylinked 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 doublylinked 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().
Entry  A pointer to a node in a linked list. 
Definition at line 590 of file LinkedList.c.
Rotates a 32bit integer right between 0 and 31 bits, filling the high bits with the low bits that were rotated.
This function rotates the 32bit 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().
Operand  The 32bit operand to rotate right. 
Count  The number of bits to rotate right. 
Rotates a 32bit integer right between 0 and 31 bits, filling the high bits with the low bits that were rotated.
This function rotates the 32bit 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().
Operand  The 32bit 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.
If Count is greater than 63, then ASSERT().
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.
If Count is greater than 63, then ASSERT().
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. 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.
If Count is greater than 63, then ASSERT().
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.
If Count is greater than 63, then ASSERT().
Operand  The 64bit operand to shift right. 
Count  The number of bits to shift right. 
Definition at line 28 of file RShiftU64.c.
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.
InterruptState  TRUE if interrupts should enabled. FALSE if interrupts should be 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.
InterruptState  TRUE if interrupts should be enabled. FALSE if interrupts should be disabled. 
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 nonzero value to be returned by SetJump().
If JumpBuffer is NULL, then ASSERT(). For Itanium processors, if JumpBuffer is not aligned on a 16byte 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 IA32 module must never be used from an x64 module. SetJump()/LongJump() is not currently supported for the EBC processor type.
JumpBuffer  A pointer to CPU context buffer. 
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 nonzero value to be returned by SetJump().
If JumpBuffer is NULL, then ASSERT(). For IPF CPUs, if JumpBuffer is not aligned on a 16byte boundary, then ASSERT().
JumpBuffer  A pointer to CPU context buffer. 
0  Indicates a return from SetJump(). 
Definition at line 32 of file SetJumpLongJump.c.
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.
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 16bit boundary, then ASSERT(). If Source is not aligned on a 16bit boundary, then ASSERT().
If an error is returned, then the Destination is unmodified.
Destination  A pointer to a Nullterminated Unicode string. 
DestMax  The maximum number of Destination Unicode char, including terminating null char. 
Source  A pointer to a Nullterminated Unicode string. 
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.
Compares two Nullterminated Unicode strings, and returns the difference between the first mismatched Unicode characters.
This function compares the Nullterminated Unicode string FirstString to the Nullterminated 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 16bit boundary, then ASSERT(). If SecondString is NULL, then ASSERT(). If SecondString is not aligned on a 16bit boundary, then ASSERT(). If PcdMaximumUnicodeStringLength is not zero, and FirstString contains more than PcdMaximumUnicodeStringLength Unicode characters not including the Nullterminator, then ASSERT(). If PcdMaximumUnicodeStringLength is not zero, and SecondString contains more than PcdMaximumUnicodeStringLength Unicode characters, not including the Nullterminator, then ASSERT().
FirstString  The pointer to a Nullterminated Unicode string. 
SecondString  The pointer to a Nullterminated Unicode string. 
0  FirstString is identical to SecondString. 
Compares two Nullterminated Unicode strings, and returns the difference between the first mismatched Unicode characters.
This function compares the Nullterminated Unicode string FirstString to the Nullterminated 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 16bit boundary, then ASSERT(). If SecondString is NULL, then ASSERT(). If SecondString is not aligned on a 16bit boundary, then ASSERT(). If PcdMaximumUnicodeStringLength is not zero, and FirstString contains more than PcdMaximumUnicodeStringLength Unicode characters, not including the Nullterminator, then ASSERT(). If PcdMaximumUnicodeStringLength is not zero, and SecondString contains more than PcdMaximumUnicodeStringLength Unicode characters, not including the Nullterminator, then ASSERT().
FirstString  A pointer to a Nullterminated Unicode string. 
SecondString  A pointer to a Nullterminated Unicode string. 
0  FirstString is identical to SecondString. 
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 16bit boundary, then ASSERT(). If Source is not aligned on a 16bit boundary, then ASSERT().
If an error is returned, then the Destination is unmodified.
Destination  A pointer to a Nullterminated Unicode string. 
DestMax  The maximum number of Destination Unicode char, including terminating null char. 
Source  A pointer to a Nullterminated Unicode string. 
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.
Convert a Nullterminated 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 [09]. 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 Nullterminator, whichever one comes first.
If String is NULL, then ASSERT(). If String is not aligned in a 16bit 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 Nullterminator, then ASSERT().
String  The pointer to a Nullterminated Unicode string. 
Value  translated from String. 
Convert a Nullterminated 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 [09]. 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 Nullterminator, whichever one comes first.
If String is NULL, then ASSERT(). If String is not aligned in a 16bit 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 Nullterminator, then ASSERT().
String  A pointer to a Nullterminated Unicode string. 
Value  translated from String. 
RETURN_STATUS EFIAPI StrDecimalToUint64S  (  IN CONST CHAR16 *  String, 
OUT CHAR16 **EndPointer  OPTIONAL,  
OUT UINT64 *  Data  
) 
Convert a Nullterminated 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 [09]. 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 Nullterminator, whichever one comes first.
If String is not aligned in a 16bit 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.
String  Pointer to a Nullterminated Unicode string. 
EndPointer  Pointer to character that stops scan. 
Data  Pointer to the converted value. 
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 Nullterminator. 
RETURN_UNSUPPORTED  If the number represented by String exceeds the range defined by UINT64. 
Definition at line 743 of file SafeString.c.
Convert a Nullterminated 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 [09]. 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 Nullterminator, whichever one comes first.
If String is NULL, then ASSERT(). If String is not aligned in a 16bit 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 Nullterminator, then ASSERT().
String  The pointer to a Nullterminated Unicode string. 
Value  translated from String. 
Convert a Nullterminated 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 [09]. 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 Nullterminator, whichever one comes first.
If String is NULL, then ASSERT(). If String is not aligned in a 16bit 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 Nullterminator, then ASSERT().
String  A pointer to a Nullterminated Unicode string. 
Value  translated from String. 
RETURN_STATUS EFIAPI StrDecimalToUintnS  (  IN CONST CHAR16 *  String, 
OUT CHAR16 **EndPointer  OPTIONAL,  
OUT UINTN *  Data  
) 
Convert a Nullterminated 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 [09]. 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 Nullterminator, whichever one comes first.
If String is not aligned in a 16bit 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.
String  Pointer to a Nullterminated Unicode string. 
EndPointer  Pointer to character that stops scan. 
Data  Pointer to the converted value. 
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 Nullterminator. 
RETURN_UNSUPPORTED  If the number represented by String exceeds the range defined by UINTN. 
Definition at line 631 of file SafeString.c.
RETURN_STATUS EFIAPI StrHexToBytes  (  IN CONST CHAR16 *  String, 
IN UINTN  Length,  
OUT UINT8 *  Buffer,  
IN UINTN  MaxBufferSize  
) 
Convert a Nullterminated 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 [09], [af] and [AF]. 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 16bit boundary, then ASSERT().
String  Pointer to a Nullterminated Unicode string. 
Length  The number of Unicode characters to decode. 
Buffer  Pointer to the converted bytes array. 
MaxBufferSize  The maximum size of Buffer. 
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 Nullterminator. 
RETURN_BUFFER_TOO_SMALL  If MaxBufferSize is less than (Length / 2). 
Definition at line 1606 of file SafeString.c.
Convert a Nullterminated 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 [09], [af] and [AF]. 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 16bit 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 Nullterminator, then ASSERT().
String  The pointer to a Nullterminated Unicode string. 
Value  translated from String. 
Convert a Nullterminated 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 [09], [af] and [AF]. 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 16bit 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 Nullterminator, then ASSERT().
String  A pointer to a Nullterminated Unicode string. 
Value  translated from String. 
RETURN_STATUS EFIAPI StrHexToUint64S  (  IN CONST CHAR16 *  String, 
OUT CHAR16 **EndPointer  OPTIONAL,  
OUT UINT64 *  Data  
) 
Convert a Nullterminated 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 [09], [af] and [AF]. 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 16bit 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.
String  Pointer to a Nullterminated Unicode string. 
EndPointer  Pointer to character that stops scan. 
Data  Pointer to the converted value. 
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 Nullterminator. 
RETURN_UNSUPPORTED  If the number represented by String exceeds the range defined by UINT64. 
Definition at line 989 of file SafeString.c.
Convert a Nullterminated 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 [09], [af] and [AF]. 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 16bit 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 Nullterminator, then ASSERT().
String  The pointer to a Nullterminated Unicode string. 
Value  translated from String. 
Convert a Nullterminated 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 [09], [af] and [AF]. 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 16bit 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 Nullterminator, then ASSERT().
String  A pointer to a Nullterminated Unicode string. 
Value  translated from String. 
RETURN_STATUS EFIAPI StrHexToUintnS  (  IN CONST CHAR16 *  String, 
OUT CHAR16 **EndPointer  OPTIONAL,  
OUT UINTN *  Data  
) 
Convert a Nullterminated 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 [09], [af] and [AF]. 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 16bit 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.
String  Pointer to a Nullterminated Unicode string. 
EndPointer  Pointer to character that stops scan. 
Data  Pointer to the converted value. 
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 Nullterminator. 
RETURN_UNSUPPORTED  If the number represented by String exceeds the range defined by UINTN. 
Definition at line 860 of file SafeString.c.
Returns the length of a Nullterminated Unicode string.
This function returns the number of Unicode characters in the Nullterminated Unicode string specified by String.
If String is NULL, then ASSERT(). If String is not aligned on a 16bit boundary, then ASSERT(). If PcdMaximumUnicodeStringLength is not zero, and String contains more than PcdMaximumUnicodeStringLength Unicode characters not including the Nullterminator, then ASSERT().
String  Pointer to a Nullterminated Unicode string. 
Returns the length of a Nullterminated Unicode string.
This function returns the number of Unicode characters in the Nullterminated Unicode string specified by String.
If String is NULL, then ASSERT(). If String is not aligned on a 16bit boundary, then ASSERT(). If PcdMaximumUnicodeStringLength is not zero, and String contains more than PcdMaximumUnicodeStringLength Unicode characters, not including the Nullterminator, then ASSERT().
String  A pointer to a Nullterminated Unicode string. 
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 16bit boundary, then ASSERT(). If Source is not aligned on a 16bit boundary, then ASSERT().
If an error is returned, then the Destination is unmodified.
Destination  A pointer to a Nullterminated Unicode string. 
DestMax  The maximum number of Destination Unicode char, including terminating null char. 
Source  A pointer to a Nullterminated Unicode string. 
Length  The maximum number of Unicode characters to copy. 
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.
INTN EFIAPI StrnCmp  (  IN CONST CHAR16 *  FirstString, 
IN CONST CHAR16 *  SecondString,  
IN UINTN  Length  
) 
Compares up to a specified length the contents of two Nullterminated Unicode strings, and returns the difference between the first mismatched Unicode characters.
This function compares the Nullterminated Unicode string FirstString to the Nullterminated 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 16bit boundary, then ASSERT(). If Length > 0 and SecondString is NULL, then ASSERT(). If Length > 0 and SecondString is not aligned on a 16bit 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 Nullterminator, then ASSERT(). If PcdMaximumUnicodeStringLength is not zero, and SecondString contains more than PcdMaximumUnicodeStringLength Unicode characters, not including the Nullterminator, then ASSERT().
FirstString  The pointer to a Nullterminated Unicode string. 
SecondString  The pointer to a Nullterminated Unicode string. 
Length  The maximum number of Unicode characters to compare. 
0  FirstString is identical to SecondString. 
Compares up to a specified length the contents of two Nullterminated Unicode strings, and returns the difference between the first mismatched Unicode characters.
This function compares the Nullterminated Unicode string FirstString to the Nullterminated 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 16bit boundary, then ASSERT(). If Length > 0 and SecondString is NULL, then ASSERT(). If Length > 0 and SecondString is not aligned on a 16bit 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 Nullterminator, then ASSERT(). If PcdMaximumUnicodeStringLength is not zero, and SecondString contains more than PcdMaximumUnicodeStringLength Unicode characters, not including the Nullterminator, then ASSERT().
FirstString  A pointer to a Nullterminated Unicode string. 
SecondString  A pointer to a Nullterminated Unicode string. 
Length  The maximum number of Unicode characters to compare. 
0  FirstString is identical to SecondString. 
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 16bit boundary, then ASSERT(). If Length > 0 and Source is not aligned on a 16bit boundary, then ASSERT().
If an error is returned, then the Destination is unmodified.
Destination  A pointer to a Nullterminated Unicode string. 
DestMax  The maximum number of Destination Unicode char, including terminating null char. 
Source  A pointer to a Nullterminated Unicode string. 
Length  The maximum number of Unicode characters to copy. 
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.
Returns the length of a Nullterminated Unicode string.
This function is similar as strlen_s defined in C11.
If String is not aligned on a 16bit boundary, then ASSERT().
String  A pointer to a Nullterminated Unicode string. 
MaxSize  The maximum number of Destination Unicode char, including terminating null char. 
0  If String is NULL. 
MaxSize  If there is no null character in the first MaxSize characters of String. 
Definition at line 119 of file SafeString.c.
Returns the size of a Nullterminated Unicode string in bytes, including the Null terminator.
This function returns the size of the Nullterminated Unicode string specified by String in bytes, including the Null terminator.
If String is not aligned on a 16bit boundary, then ASSERT().
String  A pointer to a Nullterminated Unicode string. 
MaxSize  The maximum number of Destination Unicode char, including the Null terminator. 
0  If String is NULL. 
(sizeof  (CHAR16) * (MaxSize + 1)) If there is no Null terminator in the first MaxSize characters of String. 
Definition at line 176 of file SafeString.c.
Returns the size of a Nullterminated Unicode string in bytes, including the Null terminator.
This function returns the size, in bytes, of the Nullterminated Unicode string specified by String.
If String is NULL, then ASSERT(). If String is not aligned on a 16bit boundary, then ASSERT(). If PcdMaximumUnicodeStringLength is not zero, and String contains more than PcdMaximumUnicodeStringLength Unicode characters not including the Nullterminator, then ASSERT().
String  The pointer to a Nullterminated Unicode string. 
Returns the size of a Nullterminated Unicode string in bytes, including the Null terminator.
This function returns the size, in bytes, of the Nullterminated Unicode string specified by String.
If String is NULL, then ASSERT(). If String is not aligned on a 16bit boundary, then ASSERT(). If PcdMaximumUnicodeStringLength is not zero, and String contains more than PcdMaximumUnicodeStringLength Unicode characters, not including the Nullterminator, then ASSERT().
String  A pointer to a Nullterminated Unicode string. 
Returns the first occurrence of a Nullterminated Unicode substring in a Nullterminated Unicode string.
This function scans the contents of the Nullterminated 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 16bit boundary, then ASSERT(). If SearchString is NULL, then ASSERT(). If SearchString is not aligned on a 16bit boundary, then ASSERT().
If PcdMaximumUnicodeStringLength is not zero, and SearchString or String contains more than PcdMaximumUnicodeStringLength Unicode characters, not including the Nullterminator, then ASSERT().
String  The pointer to a Nullterminated Unicode string. 
SearchString  The pointer to a Nullterminated Unicode string to search for. 
NULL  If the SearchString does not appear in String. 
Returns the first occurrence of a Nullterminated Unicode substring in a Nullterminated Unicode string.
This function scans the contents of the Nullterminated 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 16bit boundary, then ASSERT(). If SearchString is NULL, then ASSERT(). If SearchString is not aligned on a 16bit boundary, then ASSERT().
If PcdMaximumUnicodeStringLength is not zero, and SearchString or String contains more than PcdMaximumUnicodeStringLength Unicode characters, not including the Nullterminator, then ASSERT().
String  A pointer to a Nullterminated Unicode string. 
SearchString  A pointer to a Nullterminated Unicode string to search for. 
NULL  If the SearchString does not appear in String. 
Convert a Nullterminated 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:
aabbccddeeffgghhiijjkkllmmnnoopp
The pairs aa  pp are two characters in the range [09], [af] and [AF], 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 16bit boundary, then ASSERT().
String  Pointer to a Nullterminated Unicode string. 
Guid  Pointer to the converted GUID. 
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 1491 of file SafeString.c.
RETURN_STATUS EFIAPI StrToIpv4Address  (  IN CONST CHAR16 *  String, 
OUT CHAR16 **EndPointer  OPTIONAL,  
OUT IPv4_ADDRESS *  Address,  
OUT UINT8 *PrefixLength  OPTIONAL  
) 
Convert a Nullterminated 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 [09]. 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 16bit 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.
String  Pointer to a Nullterminated 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_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 1342 of file SafeString.c.
RETURN_STATUS EFIAPI StrToIpv6Address  (  IN CONST CHAR16 *  String, 
OUT CHAR16 **EndPointer  OPTIONAL,  
OUT IPv6_ADDRESS *  Address,  
OUT UINT8 *PrefixLength  OPTIONAL  
) 
Convert a Nullterminated 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 [09], [af] and [AF]. 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 [09]. 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 16bit 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.
String  Pointer to a Nullterminated 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_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 1120 of file SafeString.c.
Switches the endianness of a 16bit integer.
This function swaps the bytes in a 16bit unsigned value to switch the value from little endian to big endian or vice versa. The byte swapped value is returned.
Value  A 16bit unsigned value. 
Switches the endianess of a 16bit integer.
This function swaps the bytes in a 16bit unsigned value to switch the value from little endian to big endian or vice versa. The byte swapped value is returned.
Value  A 16bit unsigned value. 
Definition at line 25 of file SwapBytes16.c.
Switches the endianness of a 32bit integer.
This function swaps the bytes in a 32bit unsigned value to switch the value from little endian to big endian or vice versa. The byte swapped value is returned.
Value  A 32bit unsigned value. 
Switches the endianess of a 32bit integer.
This function swaps the bytes in a 32bit unsigned value to switch the value from little endian to big endian or vice versa. The byte swapped value is returned.
Value  A 32bit unsigned value. 
Definition at line 25 of file SwapBytes32.c.
Switches the endianness 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.
Value  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.
Value  A 64bit unsigned value. 
Definition at line 25 of file SwapBytes64.c.
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().
FirstEntry  A pointer to a node in a linked list. 
SecondEntry  A pointer to another node in the same linked list. 
Swaps the location of two nodes in a doublylinked 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 doublylinked 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().
FirstEntry  A pointer to a node in a linked list. 
SecondEntry  A pointer to another node in the same linked list. 
Definition at line 522 of file LinkedList.c.
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 IA32, 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().
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 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 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. 
...  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.
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 Nullterminated Unicode string to a Nullterminated 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 Nullterminator 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 nonzero value in the upper 8 bits, then ASSERT(). If Source is not aligned on a 16bit boundary, then ASSERT().
If an error is returned, then the Destination is unmodified.
Source  The pointer to a Nullterminated Unicode string. 
Length  The maximum number of Unicode characters to convert. 
Destination  The pointer to a Nullterminated Ascii string. 
DestMax  The maximum number of Destination Ascii char, including terminating null char. 
DestinationLength  The number of Unicode characters converted. 
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 Nullterminated Unicode string to a Nullterminated 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 Nullterminator 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 nonzero value in the upper 8 bits, then ASSERT(). If Source is not aligned on a 16bit boundary, then ASSERT().
If an error is returned, then Destination and DestinationLength are unmodified.
Source  The pointer to a Nullterminated Unicode string. 
Length  The maximum number of Unicode characters to convert. 
Destination  The pointer to a Nullterminated Ascii string. 
DestMax  The maximum number of Destination Ascii char, including terminating null char. 
DestinationLength  The number of Unicode characters converted. 
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 2740 of file SafeString.c.
RETURN_STATUS EFIAPI UnicodeStrToAsciiStrS  (  IN CONST CHAR16 *  Source, 
OUT CHAR8 *  Destination,  
IN UINTN  DestMax  
) 
Convert a Nullterminated Unicode string to a Nullterminated 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 Nullterminator 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 nonzero value in the upper 8 bits, then ASSERT().
If Source is not aligned on a 16bit boundary, then ASSERT().
If an error is returned, then the Destination is unmodified.
Source  The pointer to a Nullterminated Unicode string. 
Destination  The pointer to a Nullterminated ASCII string. 
DestMax  The maximum number of Destination Ascii char, including terminating null char. 
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 2633 of file SafeString.c.
Writes a 16bit value to memory that may be unaligned.
This function writes the 16bit 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().
Buffer  The pointer to a 16bit value that may be unaligned. 
Value  16bit value to write to Buffer. 
Writes a 16bit value to memory that may be unaligned.
This function writes the 16bit 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().
Buffer  A pointer to a 16bit value that may be unaligned. 
Value  16bit value to write to Buffer. 
Definition at line 61 of file Unaligned.c.
Writes a 24bit value to memory that may be unaligned.
This function writes the 24bit 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().
Buffer  The pointer to a 24bit value that may be unaligned. 
Value  24bit value to write to Buffer. 
Writes a 24bit value to memory that may be unaligned.
This function writes the 24bit 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().
Buffer  A pointer to a 24bit value that may be unaligned. 
Value  24bit value to write to Buffer. 
Definition at line 118 of file Unaligned.c.
Writes a 32bit value to memory that may be unaligned.
This function writes the 32bit 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().
Buffer  The pointer to a 32bit value that may be unaligned. 
Value  32bit value to write to Buffer. 
Writes a 32bit value to memory that may be unaligned.
This function writes the 32bit 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().
Buffer  A pointer to a 32bit value that may be unaligned. 
Value  The 32bit value to write to Buffer. 
Definition at line 177 of file Unaligned.c.
Writes a 64bit value to memory that may be unaligned.
This function writes the 64bit 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().
Buffer  The pointer to a 64bit value that may be unaligned. 
Value  64bit value to write to Buffer. 
Writes a 64bit value to memory that may be unaligned.
This function writes the 64bit 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().
Buffer  A pointer to a 64bit value that may be unaligned. 
Value  The 64bit value to write to Buffer. 
Definition at line 236 of file Unaligned.c.