MdeModulePkg/EbcDxe: Add comments for functions

Cc: Jiewen Yao <jiewen.yao@intel.com>
Cc: Pete Batard <pete@akeo.ie>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Dandan Bi <dandan.bi@intel.com>
Reviewed-by: Jiewen.yao@intel.com
This commit is contained in:
Dandan Bi
2016-12-05 11:33:52 +08:00
committed by Star Zeng
parent 532daaed0d
commit d138a2e987
9 changed files with 1157 additions and 15 deletions

View File

@@ -25,36 +25,83 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#define EFI_DEBUG_MAX_PRINT_BUFFER (80 * 4)
/**
Convert hex string to uint.
@param Str - The string
**/
UINTN
EFIAPI
Xtoi (
CHAR16 *Str
);
/**
Convert hex string to uint.
@param Str - The string
**/
UINT64
EFIAPI
LXtoi (
CHAR16 *Str
);
/**
Convert hex string to uint.
@param Str - The string
**/
UINTN
EFIAPI
Atoi (
CHAR16 *Str
);
/**
Convert hex string to uint.
@param Str - The string
**/
UINTN
EFIAPI
AsciiXtoi (
CHAR8 *Str
);
/**
Convert hex string to uint.
@param Str - The string
**/
UINTN
EFIAPI
AsciiAtoi (
CHAR8 *Str
);
/**
Compare the Unicode and Ascii string pointed by String to the string pointed by String2.
@param String - Unicode String to process
@param String2 - Ascii string to process
@return Return a positive integer if String is lexicall greater than String2; Zero if
the two strings are identical; and a negative interger if String is lexically
less than String2.
**/
INTN
EFIAPI
StrCmpUnicodeAndAscii (
@@ -62,6 +109,18 @@ StrCmpUnicodeAndAscii (
IN CHAR8 *String2
);
/**
Compare the Unicode string pointed by String to the string pointed by String2.
@param String - Unicode String to process
@param String2 - Unicode string to process
@return Return a positive integer if String is lexically greater than String2; Zero if
the two strings are identical; and a negative integer if String is lexically
less than String2.
**/
INTN
EFIAPI
StriCmp (
@@ -69,6 +128,18 @@ StriCmp (
IN CHAR16 *String2
);
/**
Compare the Unicode and Ascii string pointed by String to the string pointed by String2.
@param String - Unicode String to process
@param String2 - Ascii string to process
@return Return a positive integer if String is lexically greater than String2; Zero if
the two strings are identical; and a negative integer if String is lexically
less than String2.
**/
INTN
EFIAPI
StriCmpUnicodeAndAscii (
@@ -76,6 +147,14 @@ StriCmpUnicodeAndAscii (
IN CHAR8 *String2
);
/**
Verify if the string is end with the sub string.
@param Str - The string where to search the sub string
@param SubStr - The substring.
**/
BOOLEAN
EFIAPI
StrEndWith (
@@ -83,12 +162,26 @@ StrEndWith (
IN CHAR16 *SubStr
);
/**
Duplicate a string.
@param Src The string to be duplicated.
**/
CHAR16 *
EFIAPI
StrDuplicate (
IN CHAR16 *Src
);
/**
Find the next token after one or more specified characters.
@param String Point to the string where to find the substring.
@param CharSet Point to the string to be found.
**/
CHAR16 *
EFIAPI
StrGetNewTokenLine (
@@ -96,12 +189,27 @@ StrGetNewTokenLine (
IN CHAR16 *CharSet
);
/**
Find the next token after one or more specified characters.
@param CharSet Point to the string to be found.
**/
CHAR16 *
EFIAPI
StrGetNextTokenLine (
IN CHAR16 *CharSet
);
/**
Find the next token after one specificed characters.
@param String Point to the string where to find the substring.
@param CharSet Point to the string to be found.
**/
CHAR16 *
EFIAPI
StrGetNewTokenField (
@@ -109,12 +217,27 @@ StrGetNewTokenField (
IN CHAR16 *CharSet
);
/**
Find the next token after one specificed characters.
@param CharSet Point to the string to be found.
**/
CHAR16 *
EFIAPI
StrGetNextTokenField (
IN CHAR16 *CharSet
);
/**
Patch a character to the end of a string.
@param Buffer The string to be patched.
@param Patch The patch character.
**/
VOID
EFIAPI
PatchForStrTokenAfter (
@@ -122,6 +245,13 @@ PatchForStrTokenAfter (
IN CHAR16 Patch
);
/**
Patch a character at the beginning of a string.
@param Buffer The string to be patched.
@param Patch The patch character.
**/
VOID
EFIAPI
PatchForStrTokenBefore (
@@ -129,6 +259,14 @@ PatchForStrTokenBefore (
IN CHAR16 Patch
);
/**
Find the next token after one or more specified characters.
@param String Point to the string where to find the substring.
@param CharSet Point to the string to be found.
**/
CHAR8 *
EFIAPI
AsciiStrGetNewTokenLine (
@@ -136,12 +274,27 @@ AsciiStrGetNewTokenLine (
IN CHAR8 *CharSet
);
/**
Find the next token after one or more specified characters.
@param CharSet Point to the string to be found.
**/
CHAR8 *
EFIAPI
AsciiStrGetNextTokenLine (
IN CHAR8 *CharSet
);
/**
Find the next token after one specificed characters.
@param String Point to the string where to find the substring.
@param CharSet Point to the string to be found.
**/
CHAR8 *
EFIAPI
AsciiStrGetNewTokenField (
@@ -149,12 +302,27 @@ AsciiStrGetNewTokenField (
IN CHAR8 *CharSet
);
/**
Find the next token after one specificed characters.
@param CharSet Point to the string to be found.
**/
CHAR8 *
EFIAPI
AsciiStrGetNextTokenField (
IN CHAR8 *CharSet
);
/**
Patch a character to the end of a string.
@param Buffer The string to be patched.
@param Patch The patch character.
**/
VOID
EFIAPI
PatchForAsciiStrTokenAfter (
@@ -162,6 +330,13 @@ PatchForAsciiStrTokenAfter (
IN CHAR8 Patch
);
/**
Patch a character at the beginning of a string.
@param Buffer The string to be patched.
@param Patch The patch character.
**/
VOID
EFIAPI
PatchForAsciiStrTokenBefore (
@@ -170,7 +345,14 @@ PatchForAsciiStrTokenBefore (
);
/**
Shell Library.
Shell Library.
Get user input.
@param Prompt The prompt string.
@param InStr Point to the input string.
@param StrLen The max length of string user can input.
**/
VOID
EFIAPI
@@ -180,12 +362,25 @@ Input (
IN UINTN StrLen
);
/**
SetPageBreak.
**/
BOOLEAN
EFIAPI
SetPageBreak (
VOID
);
/**
Print a Unicode string to the output device.
@param Format A Null-terminated Unicode format string.
@param ... The variable argument list that contains pointers to Null-
terminated Unicode strings to be printed
**/
UINTN
EFIAPI
EDBPrint (
@@ -193,6 +388,17 @@ EDBPrint (
...
);
/**
Print a Unicode string to the output buffer.
@param Buffer A pointer to the output buffer for the produced Null-terminated
Unicode string.
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
@param Format A Null-terminated Unicode format string.
@param ... The variable argument list that contains pointers to Null-
terminated Unicode strings to be printed
**/
UINTN
EFIAPI
EDBSPrint (
@@ -202,6 +408,18 @@ EDBSPrint (
...
);
/**
Print a Unicode string to the output buffer with specified offset..
@param Buffer A pointer to the output buffer for the produced Null-terminated
Unicode string.
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
@param Offset The offset of the buffer.
@param Format A Null-terminated Unicode format string.
@param ... The variable argument list that contains pointers to Null-
terminated Unicode strings to be printed
**/
UINTN
EFIAPI
EDBSPrintWithOffset (
@@ -212,6 +430,25 @@ EDBSPrintWithOffset (
...
);
/**
Read a file.
If ScanFs is FLASE, it will use DebuggerPrivate->Vol as default Fs.
If ScanFs is TRUE, it will scan all FS and check the file.
If there is only one file match the name, it will be read.
If there is more than one file match the name, it will return Error.
@param DebuggerPrivate - EBC Debugger private data structure
@param FileName - The file to be read.
@param BufferSize - The file buffer size
@param Buffer - The file buffer
@param ScanFs - Need Scan all FS
@retval EFI_SUCCESS - read file successfully
@retval EFI_NOT_FOUND - file not found
@retval EFI_NO_MAPPING - there is duplicated files found
**/
EFI_STATUS
EFIAPI
ReadFileToBuffer (
@@ -222,6 +459,18 @@ ReadFileToBuffer (
IN BOOLEAN ScanFs
);
/**
Get file name under this dir with index
@param DebuggerPrivate - EBC Debugger private data structure
@param DirName - The dir to be read.
@param FileName - The file name pattern under this dir
@param Index - The file index under this dir
@return File Name which match the pattern and index.
**/
CHAR16 *
EFIAPI
GetFileNameUnderDir (