@param Destination Pointer to a Null-terminated Unicode string.\r
@param Source Pointer to a Null-terminated Unicode string.\r
\r
- @return Destiantion\r
+ @return Destination.\r
\r
**/\r
CHAR16 *\r
@param Source Pointer to a Null-terminated Unicode string.\r
@param Length Maximum number of Unicode characters to copy.\r
\r
- @return Destination\r
+ @return Destination.\r
\r
**/\r
CHAR16 *\r
@param Destination Pointer to a Null-terminated Unicode string.\r
@param Source Pointer to a Null-terminated Unicode string.\r
\r
- @return Destination\r
+ @return Destination.\r
\r
**/\r
CHAR16 *\r
@param Length Maximum number of Unicode characters to concatenate from\r
Source.\r
\r
- @return Destination\r
+ @return Destination.\r
\r
**/\r
CHAR16 *\r
);\r
\r
/**\r
- Returns the first occurance of a Null-terminated Unicode sub-string\r
+ Returns the first occurrence of a Null-terminated Unicode sub-string\r
in a Null-terminated Unicode string.\r
\r
This function scans the contents of the Null-terminated Unicode string\r
the last character in the output string. The one next to first byte will be put into the\r
character before the last character. This rules applies to the rest of the bytes. The Unicode\r
character by the last byte will be put into the first character in the output string. For example,\r
- the input buffer for a 64-bits unsigned integrer 0x12345678abcdef1234 will be converted to\r
+ the input buffer for a 64-bits unsigned integer 0x12345678abcdef1234 will be converted to\r
a Unicode string equal to L"12345678abcdef1234".\r
\r
@param String On input, String is pointed to the buffer allocated for the convertion.\r
The StringLen required to convert a N bytes Buffer will be a least equal to or greater \r
than 2*N + 1.\r
@param Buffer The pointer to a input buffer.\r
- @param BufferSizeInBytes Lenth in bytes of the input buffer.\r
+ @param BufferSizeInBytes Length in bytes of the input buffer.\r
\r
\r
- @retval EFI_SUCCESS The convertion is successfull. All bytes in Buffer has been convert to the corresponding\r
+ @retval EFI_SUCCESS The convertion is successful. All bytes in Buffer has been convert to the corresponding\r
Unicode character and placed into the right place in String.\r
@retval EFI_BUFFER_TOO_SMALL StringSizeInBytes is smaller than 2 * N + 1the number of bytes required to\r
complete the convertion. \r
@param Source Pointer to a Null-terminated Unicode string.\r
@param Destination Pointer to a Null-terminated ASCII string.\r
\r
- @return Destination\r
+ @return Destination.\r
\r
**/\r
CHAR8 *\r
\r
\r
/**\r
- Returns the first occurance of a Null-terminated ASCII sub-string\r
+ Returns the first occurrence of a Null-terminated ASCII sub-string\r
in a Null-terminated ASCII string.\r
\r
This function scans the contents of the ASCII string specified by String\r
\r
@retval NULL If the SearchString does not appear in String.\r
@retval others If there is a match return the first occurrence of SearchingString.\r
- If the lenth of SearchString is zero,return String.\r
+ If the length of SearchString is zero,return String.\r
\r
**/\r
CHAR8 *\r
@param Source Pointer to a Null-terminated ASCII string.\r
@param Destination Pointer to a Null-terminated Unicode string.\r
\r
- @return Destination\r
+ @return Destination.\r
\r
**/\r
CHAR16 *\r
\r
@param Value The 8-bit value to convert to BCD. Range 0..99.\r
\r
- @return The BCD value\r
+ @return The BCD value.\r
\r
**/\r
UINT8\r
@param FirstEntry A pointer to a node in a linked list.\r
@param SecondEntry A pointer to another node in the same linked list.\r
\r
- @return SecondEntry\r
+ @return SecondEntry.\r
\r
**/\r
LIST_ENTRY *\r
linked list containing Entry, including the Entry node, is greater than\r
or equal to PcdMaximumLinkedListLength, then ASSERT().\r
\r
- @param Entry A pointer to a node in a linked list\r
+ @param Entry A pointer to a node in a linked list.\r
\r
- @return Entry\r
+ @return Entry.\r
\r
**/\r
LIST_ENTRY *\r
@param Operand The 64-bit operand to shift left.\r
@param Count The number of bits to shift left.\r
\r
- @return Operand << Count\r
+ @return Operand << Count.\r
\r
**/\r
UINT64\r
\r
@param Operand The 32-bit operand to evaluate.\r
\r
- @retval 0-31 The lowest bit set in Operand was found.\r
+ @retval 0..31 The lowest bit set in Operand was found.\r
@retval -1 Operand is zero.\r
\r
**/\r
\r
@param Operand The 64-bit operand to evaluate.\r
\r
- @retval 0-63 The lowest bit set in Operand was found.\r
+ @retval 0..63 The lowest bit set in Operand was found.\r
@retval -1 Operand is zero.\r
\r
\r
\r
@param Operand The 32-bit operand to evaluate.\r
\r
- @retval 0-31 Position of the highest bit set in Operand if found.\r
+ @retval 0..31 Position of the highest bit set in Operand if found.\r
@retval -1 Operand is zero.\r
\r
**/\r
\r
@param Operand The 64-bit operand to evaluate.\r
\r
- @retval 0-63 Position of the highest bit set in Operand if found.\r
+ @retval 0..63 Position of the highest bit set in Operand if found.\r
@retval -1 Operand is zero.\r
\r
**/\r
unsigned value Multiplier and generates a 64-bit unsigned result. This 64-\r
bit unsigned result is returned.\r
\r
- If the result overflows, then ASSERT().\r
-\r
@param Multiplicand A 64-bit unsigned value.\r
@param Multiplier A 32-bit unsigned value.\r
\r
signed value Multiplier and generates a 64-bit signed result. This 64-bit\r
signed result is returned.\r
\r
- If the result overflows, then ASSERT().\r
-\r
@param Multiplicand A 64-bit signed value.\r
@param Multiplier A 64-bit signed value.\r
\r
NULL, then the 64-bit signed remainder is returned in Remainder. This\r
function returns the 64-bit signed quotient.\r
\r
- It is the caller¡¯s responsibility to not call this function with a Divisor of 0.\r
+ It is the caller's responsibility to not call this function with a Divisor of 0.\r
If Divisor is 0, then the quotient and remainder should be assumed to be \r
the largest negative integer.\r
\r
\r
@param SpinLock A pointer to the spin lock to place in the acquired state.\r
\r
- @return SpinLock accquired lock.\r
+ @return SpinLock acquired lock.\r
\r
**/\r
SPIN_LOCK *\r
UINT8\r
EFIAPI\r
CalculateSum8 (\r
- IN CONST UINT8 *Buffer,\r
- IN UINTN Length\r
+ IN CONST UINT8 *Buffer,\r
+ IN UINTN Length\r
);\r
\r
\r
@param Buffer Pointer to the buffer to carry out the checksum operation.\r
@param Length The size, in bytes, of Buffer.\r
\r
- @return Checksum The 2's complement checksum of Buffer.\r
+ @return Checksum The 2's complement checksum of Buffer.\r
\r
**/\r
UINT8\r
EFIAPI\r
CalculateCheckSum8 (\r
- IN CONST UINT8 *Buffer,\r
- IN UINTN Length\r
+ IN CONST UINT8 *Buffer,\r
+ IN UINTN Length\r
);\r
\r
\r
UINT16\r
EFIAPI\r
CalculateSum16 (\r
- IN CONST UINT16 *Buffer,\r
- IN UINTN Length\r
+ IN CONST UINT16 *Buffer,\r
+ IN UINTN Length\r
);\r
\r
\r
@param Buffer Pointer to the buffer to carry out the checksum operation.\r
@param Length The size, in bytes, of Buffer.\r
\r
- @return Checksum The 2's complement checksum of Buffer.\r
+ @return Checksum The 2's complement checksum of Buffer.\r
\r
**/\r
UINT16\r
EFIAPI\r
CalculateCheckSum16 (\r
- IN CONST UINT16 *Buffer,\r
- IN UINTN Length\r
+ IN CONST UINT16 *Buffer,\r
+ IN UINTN Length\r
);\r
\r
\r
UINT32\r
EFIAPI\r
CalculateSum32 (\r
- IN CONST UINT32 *Buffer,\r
- IN UINTN Length\r
+ IN CONST UINT32 *Buffer,\r
+ IN UINTN Length\r
);\r
\r
\r
@param Buffer Pointer to the buffer to carry out the checksum operation.\r
@param Length The size, in bytes, of Buffer.\r
\r
- @return Checksum The 2's complement checksum of Buffer.\r
+ @return Checksum The 2's complement checksum of Buffer.\r
\r
**/\r
UINT32\r
EFIAPI\r
CalculateCheckSum32 (\r
- IN CONST UINT32 *Buffer,\r
- IN UINTN Length\r
+ IN CONST UINT32 *Buffer,\r
+ IN UINTN Length\r
);\r
\r
\r
UINT64\r
EFIAPI\r
CalculateSum64 (\r
- IN CONST UINT64 *Buffer,\r
- IN UINTN Length\r
+ IN CONST UINT64 *Buffer,\r
+ IN UINTN Length\r
);\r
\r
\r
@param Buffer Pointer to the buffer to carry out the checksum operation.\r
@param Length The size, in bytes, of Buffer.\r
\r
- @return Checksum The 2's complement checksum of Buffer.\r
+ @return Checksum The 2's complement checksum of Buffer.\r
\r
**/\r
UINT64\r
EFIAPI\r
CalculateCheckSum64 (\r
- IN CONST UINT64 *Buffer,\r
- IN UINTN Length\r
+ IN CONST UINT64 *Buffer,\r
+ IN UINTN Length\r
);\r
\r
\r
function.\r
@param NewStack A pointer to the new stack to use for the EntryPoint\r
function.\r
- @param ... Extended parameters.\r
+ @param ... This variable argument list is ignored for IA32, x64, and EBC. \r
+ For IPF, this variable argument list is expected to contain \r
+ a single parameter of type VOID * that specifies the new backing \r
+ store pointer.\r
\r
\r
**/\r
The cache line size affected is at least 32-bytes (aligned on a 32-byte boundary).\r
An implementation may flush a larger region. This function is only available on IPF.\r
\r
- @param Address The Address of cache line to be flushed.\r
+ @param Address The Address of cache line to be flushed.\r
\r
@return The address of FC instruction executed.\r
\r
The cache line size affected is at least 32-bytes (aligned on a 32-byte boundary).\r
An implementation may flush a larger region. This function is only available on IPF.\r
\r
- @param Address The Address of cache line to be flushed.\r
+ @param Address The Address of cache line to be flushed.\r
\r
@return The address of FC.I instruction executed.\r
\r
must either guarantee that Index is valid, or the caller must set up fault handlers to\r
catch the faults. This function is only available on IPF.\r
\r
- @param Index The 8-bit Processor Identifier Register index to read.\r
+ @param Index The 8-bit Processor Identifier Register index to read.\r
\r
@return The current value of Processor Identifier Register specified by Index.\r
\r
\r
/**\r
Writes the current value of 64-bit Processor Status Register (PSR).\r
+\r
No parameter checking is performed on Value. All bits of Value corresponding to\r
- reserved fields of PSR must be 0 or a Reserved Register/Field fault may occur. The caller must either guarantee that Value is valid, or the caller must set up fault handlers to catch the faults.\r
- This function is only available on IPF.\r
+ reserved fields of PSR must be 0 or a Reserved Register/Field fault may occur.\r
+ The caller must either guarantee that Value is valid, or the caller must set up\r
+ fault handlers to catch the faults. This function is only available on IPF.\r
\r
- @param Value The 64-bit value to write to PSR.\r
+ @param Value The 64-bit value to write to PSR.\r
\r
@return The 64-bit value written to the PSR.\r
\r
Write the current value of 64-bit Kernel Register #0 (KR0).\r
This function is only available on IPF.\r
\r
- @param Value The 64-bit value to write to KR0.\r
+ @param Value The 64-bit value to write to KR0.\r
\r
@return The 64-bit value written to the KR0.\r
\r
Write the current value of 64-bit Kernel Register #1 (KR1).\r
This function is only available on IPF.\r
\r
- @param Value The 64-bit value to write to KR1.\r
+ @param Value The 64-bit value to write to KR1.\r
\r
@return The 64-bit value written to the KR1.\r
\r
Write the current value of 64-bit Kernel Register #2 (KR2).\r
This function is only available on IPF.\r
\r
- @param Value The 64-bit value to write to KR2.\r
+ @param Value The 64-bit value to write to KR2.\r
\r
@return The 64-bit value written to the KR2.\r
\r
Write the current value of 64-bit Kernel Register #3 (KR3).\r
This function is only available on IPF.\r
\r
- @param Value The 64-bit value to write to KR3.\r
+ @param Value The 64-bit value to write to KR3.\r
\r
@return The 64-bit value written to the KR3.\r
\r
Write the current value of 64-bit Kernel Register #4 (KR4).\r
This function is only available on IPF.\r
\r
- @param Value The 64-bit value to write to KR4.\r
+ @param Value The 64-bit value to write to KR4.\r
\r
@return The 64-bit value written to the KR4.\r
\r
Write the current value of 64-bit Kernel Register #5 (KR5).\r
This function is only available on IPF.\r
\r
- @param Value The 64-bit value to write to KR5.\r
+ @param Value The 64-bit value to write to KR5.\r
\r
@return The 64-bit value written to the KR5.\r
\r
Write the current value of 64-bit Kernel Register #6 (KR6).\r
This function is only available on IPF.\r
\r
- @param Value The 64-bit value to write to KR6.\r
+ @param Value The 64-bit value to write to KR6.\r
\r
@return The 64-bit value written to the KR6.\r
\r
Write the current value of 64-bit Kernel Register #7 (KR7).\r
This function is only available on IPF.\r
\r
- @param Value The 64-bit value to write to KR7.\r
+ @param Value The 64-bit value to write to KR7.\r
\r
@return The 64-bit value written to the KR7.\r
\r
Writes the current value of 64-bit Interval Timer Counter Register (ITC).\r
This function is only available on IPF.\r
\r
- @param Value The 64-bit value to write to ITC.\r
+ @param Value The 64-bit value to write to ITC.\r
\r
@return The 64-bit value written to the ITC.\r
\r
Writes the current value of 64-bit Interval Timer Match Register (ITM).\r
This function is only available on IPF.\r
\r
- @param Value The 64-bit value to write to ITM.\r
+ @param Value The 64-bit value to write to ITM.\r
\r
@return The 64-bit value written to the ITM.\r
\r
fault handlers to catch the faults.\r
This function is only available on IPF.\r
\r
- @param Value The 64-bit value to write to ITV.\r
+ @param Value The 64-bit value to write to ITV.\r
\r
@return The 64-bit value written to the ITV.\r
\r
fault handlers to catch the faults.\r
This function is only available on IPF.\r
\r
- @param Value The 64-bit value to write to DCR.\r
+ @param Value The 64-bit value to write to DCR.\r
\r
@return The 64-bit value written to the DCR.\r
\r
the low 15 bits of Value is ignored when written.\r
This function is only available on IPF.\r
\r
- @param Value The 64-bit value to write to IVA.\r
+ @param Value The 64-bit value to write to IVA.\r
\r
@return The 64-bit value written to the IVA.\r
\r
fault handlers to catch the faults.\r
This function is only available on IPF.\r
\r
- @param Value The 64-bit value to write to PTA.\r
+ @param Value The 64-bit value to write to PTA.\r
\r
@return The 64-bit value written to the PTA.\r
**/\r
fault handlers to catch the faults.\r
This function is only available on IPF.\r
\r
- @param Value The 64-bit value to write to LID.\r
+ @param Value The 64-bit value to write to LID.\r
\r
@return The 64-bit value written to the LID.\r
\r
fault handlers to catch the faults.\r
This function is only available on IPF.\r
\r
- @param Value The 64-bit value to write to TPR.\r
+ @param Value The 64-bit value to write to TPR.\r
\r
@return The 64-bit value written to the TPR.\r
\r
fault handlers to catch the faults.\r
This function is only available on IPF.\r
\r
- @param Value The 64-bit value to write to PMV.\r
+ @param Value The 64-bit value to write to PMV.\r
\r
@return The 64-bit value written to the PMV.\r
\r
fault handlers to catch the faults.\r
This function is only available on IPF.\r
\r
- @param Value The 64-bit value to write to CMCV.\r
+ @param Value The 64-bit value to write to CMCV.\r
\r
@return The 64-bit value written to the CMCV.\r
\r
fault handlers to catch the faults.\r
This function is only available on IPF.\r
\r
- @param Value The 64-bit value to write to LRR0.\r
+ @param Value The 64-bit value to write to LRR0.\r
\r
@return The 64-bit value written to the LRR0.\r
\r
set up fault handlers to catch the faults.\r
This function is only available on IPF.\r
\r
- @param Value The 64-bit value to write to LRR1.\r
+ @param Value The 64-bit value to write to LRR1.\r
\r
@return The 64-bit value written to the LRR1.\r
\r
set up fault handlers to catch the faults.\r
This function is only available on IPF.\r
\r
- @param Index The 8-bit Instruction Breakpoint Register index to read.\r
+ @param Index The 8-bit Instruction Breakpoint Register index to read.\r
\r
@return The current value of Instruction Breakpoint Register specified by Index.\r
\r
fault handlers to catch the faults.\r
This function is only available on IPF.\r
\r
- @param Index The 8-bit Data Breakpoint Register index to read.\r
+ @param Index The 8-bit Data Breakpoint Register index to read.\r
\r
@return The current value of Data Breakpoint Register specified by Index.\r
\r
zero value will be returned.\r
This function is only available on IPF.\r
\r
- @param Index The 8-bit Performance Monitor Configuration Register index to read.\r
+ @param Index The 8-bit Performance Monitor Configuration Register index to read.\r
\r
@return The current value of Performance Monitor Configuration Register\r
specified by Index.\r
zero value will be returned.\r
This function is only available on IPF.\r
\r
- @param Index The 8-bit Performance Monitor Data Register index to read.\r
+ @param Index The 8-bit Performance Monitor Data Register index to read.\r
\r
@return The current value of Performance Monitor Data Register specified by Index.\r
\r
set up fault handlers to catch the faults.\r
This function is only available on IPF.\r
\r
- @param Index The 8-bit Instruction Breakpoint Register index to write.\r
- @param Value The 64-bit value to write to IBR.\r
+ @param Index The 8-bit Instruction Breakpoint Register index to write.\r
+ @param Value The 64-bit value to write to IBR.\r
\r
@return The 64-bit value written to the IBR.\r
\r
catch the faults.\r
This function is only available on IPF.\r
\r
- @param Index The 8-bit Data Breakpoint Register index to write.\r
- @param Value The 64-bit value to write to DBR.\r
+ @param Index The 8-bit Data Breakpoint Register index to write.\r
+ @param Value The 64-bit value to write to DBR.\r
\r
@return The 64-bit value written to the DBR.\r
\r
beyond the implemented PMC register range, the write is ignored.\r
This function is only available on IPF.\r
\r
- @param Index The 8-bit Performance Monitor Configuration Register index to write.\r
- @param Value The 64-bit value to write to PMC.\r
+ @param Index The 8-bit Performance Monitor Configuration Register index to write.\r
+ @param Value The 64-bit value to write to PMC.\r
\r
@return The 64-bit value written to the PMC.\r
\r
Index value is beyond the implemented PMD register range, the write is ignored.\r
This function is only available on IPF.\r
\r
- @param Index The 8-bit Performance Monitor Data Register index to write.\r
- @param Value The 64-bit value to write to PMD.\r
+ @param Index The 8-bit Performance Monitor Data Register index to write.\r
+ @param Value The 64-bit value to write to PMD.\r
\r
@return The 64-bit value written to the PMD.\r
\r
PAL entry point then the system behavior is undefined. This function is only\r
available on IPF.\r
\r
- @param PalEntryPoint The PAL procedure calls entry point.\r
- @param Index The PAL procedure Index number.\r
- @param Arg2 The 2nd parameter for PAL procedure calls.\r
- @param Arg3 The 3rd parameter for PAL procedure calls.\r
- @param Arg4 The 4th parameter for PAL procedure calls.\r
+ @param PalEntryPoint The PAL procedure calls entry point.\r
+ @param Index The PAL procedure Index number.\r
+ @param Arg2 The 2nd parameter for PAL procedure calls.\r
+ @param Arg3 The 3rd parameter for PAL procedure calls.\r
+ @param Arg4 The 4th parameter for PAL procedure calls.\r
\r
@return structure returned from the PAL Call procedure, including the status and return value.\r
\r
projects / mirror_edk2.git / blobdiff