sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Function description in baselib.h is not clear. change it to comply with Doxgen format.

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5862 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
eric_tian
2008-09-09 06:22:30 +00:00
parent c0a23f8c37
commit 1106ffe1c0
3 changed files with 191 additions and 195 deletions
Download Patch File Download Diff File Expand all files Collapse all files

319
MdePkg/Include/Library/BaseLib.h
View File

@@ -15,16 +15,14 @@
#ifndef __BASE_LIB__ #ifndef __BASE_LIB__
#define __BASE_LIB__ #define __BASE_LIB__
//
// Definitions for architecture specific types
// These include SPIN_LOCK and BASE_LIBRARY_JUMP_BUFFER
//
/// ///
/// SPIN_LOCK /// Definitions for SPIN_LOCK
/// ///
typedef volatile UINTN SPIN_LOCK; typedef volatile UINTN SPIN_LOCK;
//
// Definitions for architecture specific types
//
#if defined (MDE_CPU_IA32) #if defined (MDE_CPU_IA32)
/// ///
/// IA32 context buffer used by SetJump() and LongJump() /// IA32 context buffer used by SetJump() and LongJump()
@@ -271,8 +269,8 @@ StrSize (
@param FirstString Pointer to a Null-terminated Unicode string. @param FirstString Pointer to a Null-terminated Unicode string.
@param SecondString Pointer to a Null-terminated Unicode string. @param SecondString Pointer to a Null-terminated Unicode string.
@retval 0 FirstString is identical to SecondString. @retval 0 FirstString is identical to SecondString.
@retval !=0 FirstString is not identical to SecondString. @return others FirstString is not identical to SecondString.
**/ **/
INTN INTN
@@ -309,8 +307,8 @@ StrCmp (
@param SecondString Pointer to a Null-terminated Unicode string. @param SecondString Pointer to a Null-terminated Unicode string.
@param Length Maximum number of Unicode characters to compare. @param Length Maximum number of Unicode characters to compare.
@retval 0 FirstString is identical to SecondString. @retval 0 FirstString is identical to SecondString.
@retval !=0 FirstString is not identical to SecondString. @return others FirstString is not identical to SecondString.
**/ **/
INTN INTN
@@ -430,7 +428,7 @@ StrnCat (
@param SearchString Pointer to a Null-terminated Unicode string to search for. @param SearchString Pointer to a Null-terminated Unicode string to search for.
@retval NULL If the SearchString does not appear in String. @retval NULL If the SearchString does not appear in String.
@retval !NULL If there is a match. @return others If there is a match.
**/ **/
CHAR16 * CHAR16 *
@@ -627,7 +625,7 @@ NibbleToHexChar (
/** /**
Convert binary buffer to a Unicode String in a specified sequence. Convert binary buffer to a Unicode String in a specified sequence.
This function converts bytes in the binary Buffer Buf to a Unicode String Str. This function converts bytes in the memory block pointed by Buffer to a Unicode String Str.
Each byte will be represented by two Unicode characters. For example, byte 0xA1 will Each byte will be represented by two Unicode characters. For example, byte 0xA1 will
be converted into two Unicode character L'A' and L'1'. In the output String, the Unicode Character be converted into two Unicode character L'A' and L'1'. In the output String, the Unicode Character
for the Most Significant Nibble will be put before the Unicode Character for the Least Significant for the Most Significant Nibble will be put before the Unicode Character for the Least Significant
@@ -716,6 +714,10 @@ HexStringToBuf (
If Digit is NULL, then ASSERT. If Digit is NULL, then ASSERT.
@param Digit The output hexadecimal digit.
@param Char The input Unicode character.
@retval TRUE Char is in the range of Hexadecimal number. Digit is updated @retval TRUE Char is in the range of Hexadecimal number. Digit is updated
to the byte value of the number. to the byte value of the number.
@retval FALSE Char is not in the range of Hexadecimal number. Digit is keep @retval FALSE Char is not in the range of Hexadecimal number. Digit is keep
@@ -901,8 +903,8 @@ AsciiStrSize (
@param FirstString Pointer to a Null-terminated ASCII string. @param FirstString Pointer to a Null-terminated ASCII string.
@param SecondString Pointer to a Null-terminated ASCII string. @param SecondString Pointer to a Null-terminated ASCII string.
@retval 0 FirstString is identical to SecondString. @retval 0 FirstString is identical to SecondString.
@retval !=0 FirstString is not identical to SecondString. @return others FirstString is not identical to SecondString.
**/ **/
INTN INTN
@@ -936,10 +938,10 @@ AsciiStrCmp (
@param FirstString Pointer to a Null-terminated ASCII string. @param FirstString Pointer to a Null-terminated ASCII string.
@param SecondString Pointer to a Null-terminated ASCII string. @param SecondString Pointer to a Null-terminated ASCII string.
@retval 0 FirstString is identical to SecondString using case insensitive @retval 0 FirstString is identical to SecondString using case insensitive
comparisons. comparisons.
@retval !=0 FirstString is not identical to SecondString using case @return others FirstString is not identical to SecondString using case
insensitive comparisons. insensitive comparisons.
**/ **/
INTN INTN
@@ -974,8 +976,8 @@ AsciiStriCmp (
@param SecondString Pointer to a Null-terminated ASCII string. @param SecondString Pointer to a Null-terminated ASCII string.
@param Length Maximum number of ASCII characters for compare. @param Length Maximum number of ASCII characters for compare.
@retval 0 FirstString is identical to SecondString. @retval 0 FirstString is identical to SecondString.
@retval !=0 FirstString is not identical to SecondString. @return others FirstString is not identical to SecondString.
**/ **/
INTN INTN
@@ -1081,11 +1083,11 @@ AsciiStrnCat (
String contains more than PcdMaximumAsciiStringLength Unicode characters String contains more than PcdMaximumAsciiStringLength Unicode characters
not including the Null-terminator, then ASSERT(). not including the Null-terminator, then ASSERT().
@param String Pointer to a Null-terminated ASCII string. @param String Pointer to a Null-terminated ASCII string.
@param SearchString Pointer to a Null-terminated ASCII string to search for. @param SearchString Pointer to a Null-terminated ASCII string to search for.
@retval NULL If the SearchString does not appear in String. @retval NULL If the SearchString does not appear in String.
@retval !NULL If there is a match. @return others If there is a match.
**/ **/
CHAR8 * CHAR8 *
@@ -3270,8 +3272,8 @@ InterlockedCompareExchangePointer (
If Buffer is NULL, then ASSERT(). If Buffer is NULL, then ASSERT().
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
@param Buffer Pointer to the buffer to carry out the sum operation. @param Buffer Pointer to the buffer to carry out the sum operation.
@param Length The size, in bytes, of Buffer . @param Length The size, in bytes, of Buffer .
@return Sum The sum of Buffer with carry bits dropped during additions. @return Sum The sum of Buffer with carry bits dropped during additions.
@@ -3296,9 +3298,8 @@ CalculateSum8 (
If Buffer is NULL, then ASSERT(). If Buffer is NULL, then ASSERT().
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
@param Buffer Pointer to the buffer to carry out the checksum operation.
@param Buffer Pointer to the buffer to carry out the checksum operation. @param Length The size, in bytes, of Buffer.
@param Length The size, in bytes, of Buffer.
@return Checksum The 2's complement checksum of Buffer. @return Checksum The 2's complement checksum of Buffer.
@@ -3324,8 +3325,8 @@ CalculateCheckSum8 (
If Length is not aligned on a 16-bit boundary, then ASSERT(). If Length is not aligned on a 16-bit boundary, then ASSERT().
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
@param Buffer Pointer to the buffer to carry out the sum operation. @param Buffer Pointer to the buffer to carry out the sum operation.
@param Length The size, in bytes, of Buffer. @param Length The size, in bytes, of Buffer.
@return Sum The sum of Buffer with carry bits dropped during additions. @return Sum The sum of Buffer with carry bits dropped during additions.
@@ -3352,8 +3353,8 @@ CalculateSum16 (
If Length is not aligned on a 16-bit boundary, then ASSERT(). If Length is not aligned on a 16-bit boundary, then ASSERT().
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
@param Buffer Pointer to the buffer to carry out the checksum operation. @param Buffer Pointer to the buffer to carry out the checksum operation.
@param Length The size, in bytes, of Buffer. @param Length The size, in bytes, of Buffer.
@return Checksum The 2's complement checksum of Buffer. @return Checksum The 2's complement checksum of Buffer.
@@ -3379,8 +3380,8 @@ CalculateCheckSum16 (
If Length is not aligned on a 32-bit boundary, then ASSERT(). If Length is not aligned on a 32-bit boundary, then ASSERT().
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
@param Buffer Pointer to the buffer to carry out the sum operation. @param Buffer Pointer to the buffer to carry out the sum operation.
@param Length The size, in bytes, of Buffer. @param Length The size, in bytes, of Buffer.
@return Sum The sum of Buffer with carry bits dropped during additions. @return Sum The sum of Buffer with carry bits dropped during additions.
@@ -3407,8 +3408,8 @@ CalculateSum32 (
If Length is not aligned on a 32-bit boundary, then ASSERT(). If Length is not aligned on a 32-bit boundary, then ASSERT().
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
@param Buffer Pointer to the buffer to carry out the checksum operation. @param Buffer Pointer to the buffer to carry out the checksum operation.
@param Length The size, in bytes, of Buffer. @param Length The size, in bytes, of Buffer.
@return Checksum The 2's complement checksum of Buffer. @return Checksum The 2's complement checksum of Buffer.
@@ -3434,8 +3435,8 @@ CalculateCheckSum32 (
If Length is not aligned on a 64-bit boundary, then ASSERT(). If Length is not aligned on a 64-bit boundary, then ASSERT().
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
@param Buffer Pointer to the buffer to carry out the sum operation. @param Buffer Pointer to the buffer to carry out the sum operation.
@param Length The size, in bytes, of Buffer. @param Length The size, in bytes, of Buffer.
@return Sum The sum of Buffer with carry bits dropped during additions. @return Sum The sum of Buffer with carry bits dropped during additions.
@@ -3462,8 +3463,8 @@ CalculateSum64 (
If Length is not aligned on a 64-bit boundary, then ASSERT(). If Length is not aligned on a 64-bit boundary, then ASSERT().
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
@param Buffer Pointer to the buffer to carry out the checksum operation. @param Buffer Pointer to the buffer to carry out the checksum operation.
@param Length The size, in bytes, of Buffer. @param Length The size, in bytes, of Buffer.
@return Checksum The 2's complement checksum of Buffer. @return Checksum The 2's complement checksum of Buffer.
@@ -3476,9 +3477,9 @@ CalculateCheckSum64 (
); );
// ///
// Base Library CPU Functions /// Base Library CPU Functions
// ///
typedef typedef
VOID VOID
(EFIAPI *SWITCH_STACK_ENTRY_POINT)( (EFIAPI *SWITCH_STACK_ENTRY_POINT)(
@@ -4915,12 +4916,10 @@ AsmSwitchStackAndBackingStore (
IN VOID *NewBsp IN VOID *NewBsp
); );
//
// Bugbug: This call should be removed after
// the PalCall Instance issue has been fixed.
//
/** /**
@todo This call should be removed after the PalCall
Instance issue has been fixed.
Performs a PAL call using static calling convention. Performs a PAL call using static calling convention.
An internal function to perform a PAL call using static calling convention. An internal function to perform a PAL call using static calling convention.
@@ -4946,124 +4945,122 @@ PalCallStatic (
#elif defined (MDE_CPU_IA32) || defined (MDE_CPU_X64) #elif defined (MDE_CPU_IA32) || defined (MDE_CPU_X64)
// ///
// IA32 and X64 Specific Functions /// IA32 and X64 Specific Functions
// /// Byte packed structure for 16-bit Real Mode EFLAGS
// ///
// Byte packed structure for 16-bit Real Mode EFLAGS
//
typedef union { typedef union {
struct { struct {
UINT32 CF:1; // Carry Flag UINT32 CF:1; /// Carry Flag
UINT32 Reserved_0:1; // Reserved UINT32 Reserved_0:1; /// Reserved
UINT32 PF:1; // Parity Flag UINT32 PF:1; /// Parity Flag
UINT32 Reserved_1:1; // Reserved UINT32 Reserved_1:1; /// Reserved
UINT32 AF:1; // Auxiliary Carry Flag UINT32 AF:1; /// Auxiliary Carry Flag
UINT32 Reserved_2:1; // Reserved UINT32 Reserved_2:1; /// Reserved
UINT32 ZF:1; // Zero Flag UINT32 ZF:1; /// Zero Flag
UINT32 SF:1; // Sign Flag UINT32 SF:1; /// Sign Flag
UINT32 TF:1; // Trap Flag UINT32 TF:1; /// Trap Flag
UINT32 IF:1; // Interrupt Enable Flag UINT32 IF:1; /// Interrupt Enable Flag
UINT32 DF:1; // Direction Flag UINT32 DF:1; /// Direction Flag
UINT32 OF:1; // Overflow Flag UINT32 OF:1; /// Overflow Flag
UINT32 IOPL:2; // I/O Privilege Level UINT32 IOPL:2; /// I/O Privilege Level
UINT32 NT:1; // Nested Task UINT32 NT:1; /// Nested Task
UINT32 Reserved_3:1; // Reserved UINT32 Reserved_3:1; /// Reserved
} Bits; } Bits;
UINT16 Uint16; UINT16 Uint16;
} IA32_FLAGS16; } IA32_FLAGS16;
// ///
// Byte packed structure for EFLAGS/RFLAGS /// Byte packed structure for EFLAGS/RFLAGS
// 32-bits on IA-32 /// 32-bits on IA-32
// 64-bits on X64. The upper 32-bits on X64 are reserved /// 64-bits on X64. The upper 32-bits on X64 are reserved
// ///
typedef union { typedef union {
struct { struct {
UINT32 CF:1; // Carry Flag UINT32 CF:1; /// Carry Flag
UINT32 Reserved_0:1; // Reserved UINT32 Reserved_0:1; /// Reserved
UINT32 PF:1; // Parity Flag UINT32 PF:1; /// Parity Flag
UINT32 Reserved_1:1; // Reserved UINT32 Reserved_1:1; /// Reserved
UINT32 AF:1; // Auxiliary Carry Flag UINT32 AF:1; /// Auxiliary Carry Flag
UINT32 Reserved_2:1; // Reserved UINT32 Reserved_2:1; /// Reserved
UINT32 ZF:1; // Zero Flag UINT32 ZF:1; /// Zero Flag
UINT32 SF:1; // Sign Flag UINT32 SF:1; /// Sign Flag
UINT32 TF:1; // Trap Flag UINT32 TF:1; /// Trap Flag
UINT32 IF:1; // Interrupt Enable Flag UINT32 IF:1; /// Interrupt Enable Flag
UINT32 DF:1; // Direction Flag UINT32 DF:1; /// Direction Flag
UINT32 OF:1; // Overflow Flag UINT32 OF:1; /// Overflow Flag
UINT32 IOPL:2; // I/O Privilege Level UINT32 IOPL:2; /// I/O Privilege Level
UINT32 NT:1; // Nested Task UINT32 NT:1; /// Nested Task
UINT32 Reserved_3:1; // Reserved UINT32 Reserved_3:1; /// Reserved
UINT32 RF:1; // Resume Flag UINT32 RF:1; /// Resume Flag
UINT32 VM:1; // Virtual 8086 Mode UINT32 VM:1; /// Virtual 8086 Mode
UINT32 AC:1; // Alignment Check UINT32 AC:1; /// Alignment Check
UINT32 VIF:1; // Virtual Interrupt Flag UINT32 VIF:1; /// Virtual Interrupt Flag
UINT32 VIP:1; // Virtual Interrupt Pending UINT32 VIP:1; /// Virtual Interrupt Pending
UINT32 ID:1; // ID Flag UINT32 ID:1; /// ID Flag
UINT32 Reserved_4:10; // Reserved UINT32 Reserved_4:10; /// Reserved
} Bits; } Bits;
UINTN UintN; UINTN UintN;
} IA32_EFLAGS32; } IA32_EFLAGS32;
// ///
// Byte packed structure for Control Register 0 (CR0) /// Byte packed structure for Control Register 0 (CR0)
// 32-bits on IA-32 /// 32-bits on IA-32
// 64-bits on X64. The upper 32-bits on X64 are reserved /// 64-bits on X64. The upper 32-bits on X64 are reserved
// ///
typedef union { typedef union {
struct { struct {
UINT32 PE:1; // Protection Enable UINT32 PE:1; /// Protection Enable
UINT32 MP:1; // Monitor Coprocessor UINT32 MP:1; /// Monitor Coprocessor
UINT32 EM:1; // Emulation UINT32 EM:1; /// Emulation
UINT32 TS:1; // Task Switched UINT32 TS:1; /// Task Switched
UINT32 ET:1; // Extension Type UINT32 ET:1; /// Extension Type
UINT32 NE:1; // Numeric Error UINT32 NE:1; /// Numeric Error
UINT32 Reserved_0:10; // Reserved UINT32 Reserved_0:10; /// Reserved
UINT32 WP:1; // Write Protect UINT32 WP:1; /// Write Protect
UINT32 Reserved_1:1; // Reserved UINT32 Reserved_1:1; /// Reserved
UINT32 AM:1; // Alignment Mask UINT32 AM:1; /// Alignment Mask
UINT32 Reserved_2:10; // Reserved UINT32 Reserved_2:10; /// Reserved
UINT32 NW:1; // Mot Write-through UINT32 NW:1; /// Mot Write-through
UINT32 CD:1; // Cache Disable UINT32 CD:1; /// Cache Disable
UINT32 PG:1; // Paging UINT32 PG:1; /// Paging
} Bits; } Bits;
UINTN UintN; UINTN UintN;
} IA32_CR0; } IA32_CR0;
// ///
// Byte packed structure for Control Register 4 (CR4) /// Byte packed structure for Control Register 4 (CR4)
// 32-bits on IA-32 /// 32-bits on IA-32
// 64-bits on X64. The upper 32-bits on X64 are reserved /// 64-bits on X64. The upper 32-bits on X64 are reserved
// ///
typedef union { typedef union {
struct { struct {
UINT32 VME:1; // Virtual-8086 Mode Extensions UINT32 VME:1; /// Virtual-8086 Mode Extensions
UINT32 PVI:1; // Protected-Mode Virtual Interrupts UINT32 PVI:1; /// Protected-Mode Virtual Interrupts
UINT32 TSD:1; // Time Stamp Disable UINT32 TSD:1; /// Time Stamp Disable
UINT32 DE:1; // Debugging Extensions UINT32 DE:1; /// Debugging Extensions
UINT32 PSE:1; // Page Size Extensions UINT32 PSE:1; /// Page Size Extensions
UINT32 PAE:1; // Physical Address Extension UINT32 PAE:1; /// Physical Address Extension
UINT32 MCE:1; // Machine Check Enable UINT32 MCE:1; /// Machine Check Enable
UINT32 PGE:1; // Page Global Enable UINT32 PGE:1; /// Page Global Enable
UINT32 PCE:1; // Performance Monitoring Counter UINT32 PCE:1; /// Performance Monitoring Counter
// Enable /// Enable
UINT32 OSFXSR:1; // Operating System Support for UINT32 OSFXSR:1; /// Operating System Support for
// FXSAVE and FXRSTOR instructions /// FXSAVE and FXRSTOR instructions
UINT32 OSXMMEXCPT:1; // Operating System Support for UINT32 OSXMMEXCPT:1; /// Operating System Support for
// Unmasked SIMD Floating Point /// Unmasked SIMD Floating Point
// Exceptions /// Exceptions
UINT32 Reserved_0:2; // Reserved UINT32 Reserved_0:2; /// Reserved
UINT32 VMXE:1; // VMX Enable UINT32 VMXE:1; /// VMX Enable
UINT32 Reserved_1:18; // Reseved UINT32 Reserved_1:18; /// Reseved
} Bits; } Bits;
UINTN UintN; UINTN UintN;
} IA32_CR4; } IA32_CR4;
// ///
// Byte packed structure for an IDTR, GDTR, LDTR descriptor /// Byte packed structure for an IDTR, GDTR, LDTR descriptor
/// @bug How to make this structure byte-packed in a compiler independent way? /// @todo How to make this structure byte-packed in a compiler independent way?
// ///
#pragma pack (1) #pragma pack (1)
typedef struct { typedef struct {
UINT16 Limit; UINT16 Limit;
@@ -5077,30 +5074,30 @@ typedef struct {
#define IA32_IDT_GATE_TYPE_INTERRUPT_32 0x8E #define IA32_IDT_GATE_TYPE_INTERRUPT_32 0x8E
#define IA32_IDT_GATE_TYPE_TRAP_32 0x8F #define IA32_IDT_GATE_TYPE_TRAP_32 0x8F
// ///
// Byte packed structure for an Interrupt Gate Descriptor /// Byte packed structure for an Interrupt Gate Descriptor
// ///
typedef union { typedef union {
struct { struct {
UINT32 OffsetLow:16; // Offset bits 15..0 UINT32 OffsetLow:16; /// Offset bits 15..0
UINT32 Selector:16; // Selector UINT32 Selector:16; /// Selector
UINT32 Reserved_0:8; // Reserved UINT32 Reserved_0:8; /// Reserved
UINT32 GateType:8; // Gate Type. See #defines above UINT32 GateType:8; /// Gate Type. See #defines above
UINT32 OffsetHigh:16; // Offset bits 31..16 UINT32 OffsetHigh:16; /// Offset bits 31..16
} Bits; } Bits;
UINT64 Uint64; UINT64 Uint64;
} IA32_IDT_GATE_DESCRIPTOR; } IA32_IDT_GATE_DESCRIPTOR;
// ///
// Byte packed structure for an FP/SSE/SSE2 context /// Byte packed structure for an FP/SSE/SSE2 context
// ///
typedef struct { typedef struct {
UINT8 Buffer[512]; UINT8 Buffer[512];
} IA32_FX_BUFFER; } IA32_FX_BUFFER;
// ///
// Structures for the 16-bit real mode thunks /// Structures for the 16-bit real mode thunks
// ///
typedef struct { typedef struct {
UINT32 Reserved1; UINT32 Reserved1;
UINT32 Reserved2; UINT32 Reserved2;
@@ -5164,9 +5161,9 @@ typedef union {
IA32_BYTE_REGS H; IA32_BYTE_REGS H;
} IA32_REGISTER_SET; } IA32_REGISTER_SET;
// ///
// Byte packed structure for an 16-bit real mode thunks /// Byte packed structure for an 16-bit real mode thunks
// ///
typedef struct { typedef struct {
IA32_REGISTER_SET *RealModeState; IA32_REGISTER_SET *RealModeState;
VOID *RealModeBuffer; VOID *RealModeBuffer;
@@ -7221,10 +7218,6 @@ AsmPrepareAndThunk16 (
IN OUT THUNK_CONTEXT *ThunkContext IN OUT THUNK_CONTEXT *ThunkContext
); );
#else
#endif
#endif #endif

33
MdePkg/Library/BaseLib/CheckSum.c
View File

@@ -31,8 +31,8 @@
If Buffer is NULL, then ASSERT(). If Buffer is NULL, then ASSERT().
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
@param Buffer Pointer to the buffer to carry out the sum operation. @param Buffer Pointer to the buffer to carry out the sum operation.
@param Length The size, in bytes, of Buffer . @param Length The size, in bytes, of Buffer .
@return Sum The sum of Buffer with carry bits dropped during additions. @return Sum The sum of Buffer with carry bits dropped during additions.
@@ -70,9 +70,8 @@ CalculateSum8 (
If Buffer is NULL, then ASSERT(). If Buffer is NULL, then ASSERT().
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
@param Buffer Pointer to the buffer to carry out the checksum operation.
@param Buffer Pointer to the buffer to carry out the checksum operation. @param Length The size, in bytes, of Buffer.
@param Length The size, in bytes, of Buffer.
@return Checksum The 2's complement checksum of Buffer. @return Checksum The 2's complement checksum of Buffer.
@@ -107,8 +106,8 @@ CalculateCheckSum8 (
If Length is not aligned on a 16-bit boundary, then ASSERT(). If Length is not aligned on a 16-bit boundary, then ASSERT().
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
@param Buffer Pointer to the buffer to carry out the sum operation. @param Buffer Pointer to the buffer to carry out the sum operation.
@param Length The size, in bytes, of Buffer. @param Length The size, in bytes, of Buffer.
@return Sum The sum of Buffer with carry bits dropped during additions. @return Sum The sum of Buffer with carry bits dropped during additions.
@@ -152,8 +151,8 @@ CalculateSum16 (
If Length is not aligned on a 16-bit boundary, then ASSERT(). If Length is not aligned on a 16-bit boundary, then ASSERT().
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
@param Buffer Pointer to the buffer to carry out the checksum operation. @param Buffer Pointer to the buffer to carry out the checksum operation.
@param Length The size, in bytes, of Buffer. @param Length The size, in bytes, of Buffer.
@return Checksum The 2's complement checksum of Buffer. @return Checksum The 2's complement checksum of Buffer.
@@ -189,8 +188,8 @@ CalculateCheckSum16 (
If Length is not aligned on a 32-bit boundary, then ASSERT(). If Length is not aligned on a 32-bit boundary, then ASSERT().
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
@param Buffer Pointer to the buffer to carry out the sum operation. @param Buffer Pointer to the buffer to carry out the sum operation.
@param Length The size, in bytes, of Buffer. @param Length The size, in bytes, of Buffer.
@return Sum The sum of Buffer with carry bits dropped during additions. @return Sum The sum of Buffer with carry bits dropped during additions.
@@ -234,8 +233,8 @@ CalculateSum32 (
If Length is not aligned on a 32-bit boundary, then ASSERT(). If Length is not aligned on a 32-bit boundary, then ASSERT().
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
@param Buffer Pointer to the buffer to carry out the checksum operation. @param Buffer Pointer to the buffer to carry out the checksum operation.
@param Length The size, in bytes, of Buffer. @param Length The size, in bytes, of Buffer.
@return Checksum The 2's complement checksum of Buffer. @return Checksum The 2's complement checksum of Buffer.
@@ -271,8 +270,8 @@ CalculateCheckSum32 (
If Length is not aligned on a 64-bit boundary, then ASSERT(). If Length is not aligned on a 64-bit boundary, then ASSERT().
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
@param Buffer Pointer to the buffer to carry out the sum operation. @param Buffer Pointer to the buffer to carry out the sum operation.
@param Length The size, in bytes, of Buffer. @param Length The size, in bytes, of Buffer.
@return Sum The sum of Buffer with carry bits dropped during additions. @return Sum The sum of Buffer with carry bits dropped during additions.
@@ -316,8 +315,8 @@ CalculateSum64 (
If Length is not aligned on a 64-bit boundary, then ASSERT(). If Length is not aligned on a 64-bit boundary, then ASSERT().
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
@param Buffer Pointer to the buffer to carry out the checksum operation. @param Buffer Pointer to the buffer to carry out the checksum operation.
@param Length The size, in bytes, of Buffer. @param Length The size, in bytes, of Buffer.
@return Checksum The 2's complement checksum of Buffer. @return Checksum The 2's complement checksum of Buffer.

34
MdePkg/Library/BaseLib/String.c
View File

@@ -229,8 +229,8 @@ StrSize (
@param FirstString Pointer to a Null-terminated Unicode string. @param FirstString Pointer to a Null-terminated Unicode string.
@param SecondString Pointer to a Null-terminated Unicode string. @param SecondString Pointer to a Null-terminated Unicode string.
@retval 0 FirstString is identical to SecondString. @retval 0 FirstString is identical to SecondString.
@retval !=0 FirstString is not identical to SecondString. @return others FirstString is not identical to SecondString.
**/ **/
INTN INTN
@@ -279,8 +279,8 @@ StrCmp (
@param SecondString Pointer to a Null-terminated Unicode string. @param SecondString Pointer to a Null-terminated Unicode string.
@param Length Maximum number of Unicode characters to compare. @param Length Maximum number of Unicode characters to compare.
@retval 0 FirstString is identical to SecondString. @retval 0 FirstString is identical to SecondString.
@retval !=0 FirstString is not identical to SecondString. @return others FirstString is not identical to SecondString.
**/ **/
INTN INTN
@@ -438,7 +438,7 @@ StrnCat (
@param SearchString Pointer to a Null-terminated Unicode string to search for. @param SearchString Pointer to a Null-terminated Unicode string to search for.
@retval NULL If the SearchString does not appear in String. @retval NULL If the SearchString does not appear in String.
@retval !NULL If there is a match. @return others If there is a match.
**/ **/
CHAR16 * CHAR16 *
@@ -1265,8 +1265,8 @@ AsciiStrSize (
@param FirstString Pointer to a Null-terminated ASCII string. @param FirstString Pointer to a Null-terminated ASCII string.
@param SecondString Pointer to a Null-terminated ASCII string. @param SecondString Pointer to a Null-terminated ASCII string.
@retval 0 FirstString is identical to SecondString. @retval 0 FirstString is identical to SecondString.
@retval !=0 FirstString is not identical to SecondString. @return others FirstString is not identical to SecondString.
**/ **/
INTN INTN
@@ -1362,10 +1362,10 @@ InternalAsciiHexCharToUintn (
@param FirstString Pointer to a Null-terminated ASCII string. @param FirstString Pointer to a Null-terminated ASCII string.
@param SecondString Pointer to a Null-terminated ASCII string. @param SecondString Pointer to a Null-terminated ASCII string.
@retval 0 FirstString is identical to SecondString using case insensitive @retval 0 FirstString is identical to SecondString using case insensitive
comparisons. comparisons.
@retval !=0 FirstString is not identical to SecondString using case @return others FirstString is not identical to SecondString using case
insensitive comparisons. insensitive comparisons.
**/ **/
INTN INTN
@@ -1420,8 +1420,8 @@ AsciiStriCmp (
@param SecondString Pointer to a Null-terminated ASCII string. @param SecondString Pointer to a Null-terminated ASCII string.
@param Length Maximum number of ASCII characters to compare. @param Length Maximum number of ASCII characters to compare.
@retval 0 FirstString is identical to SecondString. @retval 0 FirstString is identical to SecondString.
@retval !=0 FirstString is not identical to SecondString. @return others FirstString is not identical to SecondString.
**/ **/
INTN INTN
@@ -1568,7 +1568,7 @@ AsciiStrnCat (
@param SearchString Pointer to a Null-terminated ASCII string to search for. @param SearchString Pointer to a Null-terminated ASCII string to search for.
@retval NULL If the SearchString does not appear in String. @retval NULL If the SearchString does not appear in String.
@retval !NULL If there is a match. @return others If there is a match.
**/ **/
CHAR8 * CHAR8 *
@@ -2103,7 +2103,7 @@ NibbleToHexChar (
/** /**
Convert binary buffer to a Unicode String in a specified sequence. Convert binary buffer to a Unicode String in a specified sequence.
This function converts bytes in the binary Buffer Buf to a Unicode String Str. This function converts bytes in the memory block pointed by Buffer to a Unicode String Str.
Each byte will be represented by two Unicode characters. For example, byte 0xA1 will Each byte will be represented by two Unicode characters. For example, byte 0xA1 will
be converted into two Unicode character L'A' and L'1'. In the output String, the Unicode Character be converted into two Unicode character L'A' and L'1'. In the output String, the Unicode Character
for the Most Significant Nibble will be put before the Unicode Character for the Least Significant for the Most Significant Nibble will be put before the Unicode Character for the Least Significant
@@ -2278,6 +2278,10 @@ HexStringToBuf (
L'A' will be converted to 0x0A. L'A' will be converted to 0x0A.
If Digit is NULL, then ASSERT. If Digit is NULL, then ASSERT.
@param Digit The output hexadecimal digit.
@param Char The input Unicode character.
@retval TRUE Char is in the range of Hexadecimal number. Digit is updated @retval TRUE Char is in the range of Hexadecimal number. Digit is updated
to the byte value of the number. to the byte value of the number.