diff options
| author | gikidy <gikidy@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-12-11 04:45:23 +0000 |
|---|---|---|
| committer | gikidy <gikidy@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-12-11 04:45:23 +0000 |
| commit | efb2311707ec50ff04ebaecbb151ce8d8f168ee4 (patch) | |
| tree | a323b199272ddb465745e6cb6f007358d84c5846 | |
| parent | 2fc60b703842994beb1d78f9221deca7d81d9159 (diff) | |
| download | edk2-platforms-efb2311707ec50ff04ebaecbb151ce8d8f168ee4.tar.xz | |
Synchronize MdePkg h files to Library/Base* c files.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6984 6f19259b-4bc3-4df7-8a09-765794883524
26 files changed, 278 insertions, 187 deletions
diff --git a/MdePkg/Include/Library/BaseLib.h b/MdePkg/Include/Library/BaseLib.h index d4db217f9d..cb31c94c09 100644 --- a/MdePkg/Include/Library/BaseLib.h +++ b/MdePkg/Include/Library/BaseLib.h @@ -1817,7 +1817,7 @@ GetPowerOfTwo64 ( @param Value A 16-bit unsigned value.
- @return The byte swapped value.
+ @return The byte swapped Value.
**/
UINT16
@@ -1836,7 +1836,7 @@ SwapBytes16 ( @param Value A 32-bit unsigned value.
- @return The byte swapped value.
+ @return The byte swapped Value.
**/
UINT32
@@ -1855,7 +1855,7 @@ SwapBytes32 ( @param Value A 64-bit unsigned value.
- @return The byte swapped value.
+ @return The byte swapped Value.
**/
UINT64
diff --git a/MdePkg/Library/BaseCacheMaintenanceLib/EbcCache.c b/MdePkg/Library/BaseCacheMaintenanceLib/EbcCache.c index e8267293f0..e4bd1e1163 100644 --- a/MdePkg/Library/BaseCacheMaintenanceLib/EbcCache.c +++ b/MdePkg/Library/BaseCacheMaintenanceLib/EbcCache.c @@ -19,9 +19,6 @@ Invalidates the entire instruction cache in cache coherency domain of the
calling CPU.
- Invalidates the entire instruction cache in cache coherency domain of the
- calling CPU.
-
**/
VOID
EFIAPI
diff --git a/MdePkg/Library/BaseCacheMaintenanceLib/IpfCache.c b/MdePkg/Library/BaseCacheMaintenanceLib/IpfCache.c index 9b940fc3f7..1e5241832f 100644 --- a/MdePkg/Library/BaseCacheMaintenanceLib/IpfCache.c +++ b/MdePkg/Library/BaseCacheMaintenanceLib/IpfCache.c @@ -22,9 +22,6 @@ Invalidates the entire instruction cache in cache coherency domain of the
calling CPU.
- Invalidates the entire instruction cache in cache coherency domain of the
- calling CPU.
-
**/
VOID
EFIAPI
diff --git a/MdePkg/Library/BaseCacheMaintenanceLib/X86Cache.c b/MdePkg/Library/BaseCacheMaintenanceLib/X86Cache.c index 24301e9292..c2f62855fd 100644 --- a/MdePkg/Library/BaseCacheMaintenanceLib/X86Cache.c +++ b/MdePkg/Library/BaseCacheMaintenanceLib/X86Cache.c @@ -27,9 +27,6 @@ Invalidates the entire instruction cache in cache coherency domain of the
calling CPU.
- Invalidates the entire instruction cache in cache coherency domain of the
- calling CPU.
-
**/
VOID
EFIAPI
diff --git a/MdePkg/Library/BaseDebugLibNull/DebugLib.c b/MdePkg/Library/BaseDebugLibNull/DebugLib.c index 7719346682..97f8ff061b 100644 --- a/MdePkg/Library/BaseDebugLibNull/DebugLib.c +++ b/MdePkg/Library/BaseDebugLibNull/DebugLib.c @@ -80,7 +80,7 @@ DebugAssert ( PcdDebugClearMemoryValue, and returns Buffer.
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 target buffer to be filled with PcdDebugClearMemoryValue.
@param Length Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.
diff --git a/MdePkg/Library/BaseDebugLibSerialPort/DebugLib.c b/MdePkg/Library/BaseDebugLibSerialPort/DebugLib.c index a086e6e992..4e603a7378 100644 --- a/MdePkg/Library/BaseDebugLibSerialPort/DebugLib.c +++ b/MdePkg/Library/BaseDebugLibSerialPort/DebugLib.c @@ -137,7 +137,7 @@ DebugAssert ( PcdDebugClearMemoryValue, and returns Buffer.
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 target buffer to be filled with PcdDebugClearMemoryValue.
@param Length Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.
diff --git a/MdePkg/Library/BaseLib/SwapBytes16.c b/MdePkg/Library/BaseLib/SwapBytes16.c index a656a8cea2..7c8badb725 100644 --- a/MdePkg/Library/BaseLib/SwapBytes16.c +++ b/MdePkg/Library/BaseLib/SwapBytes16.c @@ -26,7 +26,7 @@ @param Value A 16-bit unsigned value.
- @return The byte swapped value.
+ @return The byte swapped Value.
**/
UINT16
diff --git a/MdePkg/Library/BaseMemoryLib/CompareMemWrapper.c b/MdePkg/Library/BaseMemoryLib/CompareMemWrapper.c index 4d1c61891b..b94750a18d 100644 --- a/MdePkg/Library/BaseMemoryLib/CompareMemWrapper.c +++ b/MdePkg/Library/BaseMemoryLib/CompareMemWrapper.c @@ -31,7 +31,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. If all Length bytes of the two buffers are identical, then 0 is returned. Otherwise, the
value returned is the first mismatched byte in SourceBuffer subtracted from the first
mismatched byte in DestinationBuffer.
-
+
If Length > 0 and DestinationBuffer is NULL, then ASSERT().
If Length > 0 and SourceBuffer is NULL, then ASSERT().
If Length is greater than (MAX_ADDRESS - DestinationBuffer + 1), then ASSERT().
@@ -44,7 +44,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @return 0 All Length bytes of the two buffers are identical.
@retval Non-zero The first mismatched byte in SourceBuffer subtracted from the first
mismatched byte in DestinationBuffer.
-
+
**/
INTN
EFIAPI
diff --git a/MdePkg/Library/BaseMemoryLib/CopyMem.c b/MdePkg/Library/BaseMemoryLib/CopyMem.c index 079f7cf506..aa2ffea437 100644 --- a/MdePkg/Library/BaseMemoryLib/CopyMem.c +++ b/MdePkg/Library/BaseMemoryLib/CopyMem.c @@ -22,9 +22,9 @@ /**
Copy Length bytes from Source to Destination.
- @param Destination Target of copy
- @param Source Place to copy from
- @param Length Number of bytes to copy
+ @param DestinationBuffer Target of copy
+ @param SourceBuffer Place to copy from
+ @param Length Number of bytes to copy
@return Destination
@@ -32,8 +32,8 @@ VOID *
EFIAPI
InternalMemCopyMem (
- OUT VOID *Destination,
- IN CONST VOID *Source,
+ OUT VOID *DestinationBuffer,
+ IN CONST VOID *SourceBuffer,
IN UINTN Length
)
{
@@ -45,18 +45,18 @@ InternalMemCopyMem ( volatile UINT8 *Destination8;
CONST UINT8 *Source8;
- if (Source > Destination) {
- Destination8 = (UINT8*)Destination;
- Source8 = (CONST UINT8*)Source;
+ if (SourceBuffer > DestinationBuffer) {
+ Destination8 = (UINT8*)DestinationBuffer;
+ Source8 = (CONST UINT8*)SourceBuffer;
while (Length-- != 0) {
*(Destination8++) = *(Source8++);
}
- } else if (Source < Destination) {
- Destination8 = (UINT8*)Destination + Length;
- Source8 = (CONST UINT8*)Source + Length;
+ } else if (SourceBuffer < DestinationBuffer) {
+ Destination8 = (UINT8*)DestinationBuffer + Length;
+ Source8 = (CONST UINT8*)SourceBuffer + Length;
while (Length-- != 0) {
*(--Destination8) = *(--Source8);
}
}
- return Destination;
+ return DestinationBuffer;
}
diff --git a/MdePkg/Library/BaseMemoryLib/SetMem.c b/MdePkg/Library/BaseMemoryLib/SetMem.c index dee44f61ce..9d7b0ec55e 100644 --- a/MdePkg/Library/BaseMemoryLib/SetMem.c +++ b/MdePkg/Library/BaseMemoryLib/SetMem.c @@ -23,9 +23,9 @@ /**
Set Buffer to Value for Size bytes.
- @param Buffer Memory to set.
- @param Length Number of bytes to set
- @param Value Value of the set operation.
+ @param Buffer Memory to set.
+ @param Length Number of bytes to set
+ @param Value Value of the set operation.
@return Buffer
diff --git a/MdePkg/Library/BaseMemoryLibMmx/CompareMemWrapper.c b/MdePkg/Library/BaseMemoryLibMmx/CompareMemWrapper.c index 052851e7c0..27da96d56b 100644 --- a/MdePkg/Library/BaseMemoryLibMmx/CompareMemWrapper.c +++ b/MdePkg/Library/BaseMemoryLibMmx/CompareMemWrapper.c @@ -31,7 +31,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. If all Length bytes of the two buffers are identical, then 0 is returned. Otherwise, the
value returned is the first mismatched byte in SourceBuffer subtracted from the first
mismatched byte in DestinationBuffer.
-
+
If Length > 0 and DestinationBuffer is NULL, then ASSERT().
If Length > 0 and SourceBuffer is NULL, then ASSERT().
If Length is greater than (MAX_ADDRESS - DestinationBuffer + 1), then ASSERT().
@@ -44,7 +44,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @return 0 All Length bytes of the two buffers are identical.
@retval Non-zero The first mismatched byte in SourceBuffer subtracted from the first
mismatched byte in DestinationBuffer.
-
+
**/
INTN
EFIAPI
diff --git a/MdePkg/Library/BaseMemoryLibOptDxe/CompareMemWrapper.c b/MdePkg/Library/BaseMemoryLibOptDxe/CompareMemWrapper.c index 052851e7c0..27da96d56b 100644 --- a/MdePkg/Library/BaseMemoryLibOptDxe/CompareMemWrapper.c +++ b/MdePkg/Library/BaseMemoryLibOptDxe/CompareMemWrapper.c @@ -31,7 +31,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. If all Length bytes of the two buffers are identical, then 0 is returned. Otherwise, the
value returned is the first mismatched byte in SourceBuffer subtracted from the first
mismatched byte in DestinationBuffer.
-
+
If Length > 0 and DestinationBuffer is NULL, then ASSERT().
If Length > 0 and SourceBuffer is NULL, then ASSERT().
If Length is greater than (MAX_ADDRESS - DestinationBuffer + 1), then ASSERT().
@@ -44,7 +44,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @return 0 All Length bytes of the two buffers are identical.
@retval Non-zero The first mismatched byte in SourceBuffer subtracted from the first
mismatched byte in DestinationBuffer.
-
+
**/
INTN
EFIAPI
diff --git a/MdePkg/Library/BaseMemoryLibOptPei/CompareMemWrapper.c b/MdePkg/Library/BaseMemoryLibOptPei/CompareMemWrapper.c index 6ee6857857..3a537742ea 100644 --- a/MdePkg/Library/BaseMemoryLibOptPei/CompareMemWrapper.c +++ b/MdePkg/Library/BaseMemoryLibOptPei/CompareMemWrapper.c @@ -32,7 +32,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. If all Length bytes of the two buffers are identical, then 0 is returned. Otherwise, the
value returned is the first mismatched byte in SourceBuffer subtracted from the first
mismatched byte in DestinationBuffer.
-
+
If Length > 0 and DestinationBuffer is NULL, then ASSERT().
If Length > 0 and SourceBuffer is NULL, then ASSERT().
If Length is greater than (MAX_ADDRESS - DestinationBuffer + 1), then ASSERT().
@@ -45,7 +45,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @return 0 All Length bytes of the two buffers are identical.
@retval Non-zero The first mismatched byte in SourceBuffer subtracted from the first
mismatched byte in DestinationBuffer.
-
+
**/
INTN
EFIAPI
diff --git a/MdePkg/Library/BaseMemoryLibRepStr/CompareMemWrapper.c b/MdePkg/Library/BaseMemoryLibRepStr/CompareMemWrapper.c index 45fd3975f1..8f917aa56c 100644 --- a/MdePkg/Library/BaseMemoryLibRepStr/CompareMemWrapper.c +++ b/MdePkg/Library/BaseMemoryLibRepStr/CompareMemWrapper.c @@ -31,7 +31,7 @@ If all Length bytes of the two buffers are identical, then 0 is returned. Otherwise, the
value returned is the first mismatched byte in SourceBuffer subtracted from the first
mismatched byte in DestinationBuffer.
-
+
If Length > 0 and DestinationBuffer is NULL, then ASSERT().
If Length > 0 and SourceBuffer is NULL, then ASSERT().
If Length is greater than (MAX_ADDRESS - DestinationBuffer + 1), then ASSERT().
@@ -44,7 +44,7 @@ @return 0 All Length bytes of the two buffers are identical.
@retval Non-zero The first mismatched byte in SourceBuffer subtracted from the first
mismatched byte in DestinationBuffer.
-
+
**/
INTN
EFIAPI
diff --git a/MdePkg/Library/BaseMemoryLibSse2/CompareMemWrapper.c b/MdePkg/Library/BaseMemoryLibSse2/CompareMemWrapper.c index 052851e7c0..27da96d56b 100644 --- a/MdePkg/Library/BaseMemoryLibSse2/CompareMemWrapper.c +++ b/MdePkg/Library/BaseMemoryLibSse2/CompareMemWrapper.c @@ -31,7 +31,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. If all Length bytes of the two buffers are identical, then 0 is returned. Otherwise, the
value returned is the first mismatched byte in SourceBuffer subtracted from the first
mismatched byte in DestinationBuffer.
-
+
If Length > 0 and DestinationBuffer is NULL, then ASSERT().
If Length > 0 and SourceBuffer is NULL, then ASSERT().
If Length is greater than (MAX_ADDRESS - DestinationBuffer + 1), then ASSERT().
@@ -44,7 +44,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @return 0 All Length bytes of the two buffers are identical.
@retval Non-zero The first mismatched byte in SourceBuffer subtracted from the first
mismatched byte in DestinationBuffer.
-
+
**/
INTN
EFIAPI
diff --git a/MdePkg/Library/BasePalLibNull/PalCall.c b/MdePkg/Library/BasePalLibNull/PalCall.c index 82db43cf65..a124336b20 100644 --- a/MdePkg/Library/BasePalLibNull/PalCall.c +++ b/MdePkg/Library/BasePalLibNull/PalCall.c @@ -20,14 +20,24 @@ /**
Makes a PAL procedure call.
- This is a wrapper function to make a PAL procedure call.
- This is just a template as simple instance. It does not
- make real PAL call. It directly reports error if called.
-
- @param Index The PAL procedure Index number.
- @param Arg2 The 2nd parameter for PAL procedure calls.
- @param Arg3 The 3rd parameter for PAL procedure calls.
- @param Arg4 The 4th parameter for PAL procedure calls.
+ This is a wrapper function to make a PAL procedure call. Based on the Index value,
+ this API will make static or stacked PAL call. Architected procedures may be designated
+ as required or optional. If a PAL procedure is specified as optional, a unique return
+ code of 0xFFFFFFFFFFFFFFFF is returned in the Status field of the PAL_CALL_RETURN structure.
+ This indicates that the procedure is not present in this PAL implementation. It is the
+ caller's responsibility to check for this return code after calling any optional PAL
+ procedure. No parameter checking is performed on the 4 input parameters, but there are
+ some common rules that the caller should follow when making a PAL call. Any address
+ passed to PAL as buffers for return parameters must be 8-byte aligned. Unaligned addresses
+ may cause undefined results. For those parameters defined as reserved or some fields
+ defined as reserved must be zero filled or the invalid argument return value may be
+ returned or undefined result may occur during the execution of the procedure.
+ This function is only available on IPF.
+
+ @param Index The PAL procedure Index number.
+ @param Arg2 The 2nd parameter for PAL procedure calls.
+ @param Arg3 The 3rd parameter for PAL procedure calls.
+ @param Arg4 The 4th parameter for PAL procedure calls.
@return Structure returned from the PAL Call procedure, including the status and return value.
diff --git a/MdePkg/Library/BasePcdLibNull/PcdLib.c b/MdePkg/Library/BasePcdLibNull/PcdLib.c index 20031ee570..6ad91b8cdb 100644 --- a/MdePkg/Library/BasePcdLibNull/PcdLib.c +++ b/MdePkg/Library/BasePcdLibNull/PcdLib.c @@ -20,18 +20,22 @@ /**
+ This function provides a means by which SKU support can be established in the PCD infrastructure.
+
Sets the current SKU in the PCD database to the value specified by SkuId. SkuId is returned.
@param[in] SkuId The SKU value that will be used when the PCD service will retrieve and
- set values associated with a PCD token.
+ set values associated with a PCD token.
+
+ If SkuId >= 0x100, then ASSERT().
@return Return the SKU ID that just be set.
**/
-UINTN
+UINTN
EFIAPI
LibPcdSetSku (
- IN UINTN SkuId
+ IN UINTN SkuId
)
{
ASSERT (FALSE);
@@ -40,6 +44,8 @@ LibPcdSetSku ( }
/**
+ This function provides a means by which to retrieve a value for a given PCD token.
+
Returns the 8-bit value for the token specified by TokenNumber.
@param[in] TokenNumber The PCD token number to retrieve a current value for.
@@ -61,9 +67,11 @@ LibPcdGet8 ( /**
+ This function provides a means by which to retrieve a value for a given PCD token.
+
Returns the 16-bit value for the token specified by TokenNumber.
- @param[in] TokenNumber The PCD token number to retrieve a current value for.
+ @param[in] TokenNumber The PCD token number to retrieve a current value for.
@return Returns the 16-bit value for the token specified by TokenNumber.
@@ -82,6 +90,8 @@ LibPcdGet16 ( /**
+ This function provides a means by which to retrieve a value for a given PCD token.
+
Returns the 32-bit value for the token specified by TokenNumber.
@param[in] TokenNumber The PCD token number to retrieve a current value for.
@@ -103,6 +113,8 @@ LibPcdGet32 ( /**
+ This function provides a means by which to retrieve a value for a given PCD token.
+
Returns the 64-bit value for the token specified by TokenNumber.
@param[in] TokenNumber The PCD token number to retrieve a current value for.
@@ -124,6 +136,8 @@ LibPcdGet64 ( /**
+ This function provides a means by which to retrieve a value for a given PCD token.
+
Returns the pointer to the buffer of the token specified by TokenNumber.
@param[in] TokenNumber The PCD token number to retrieve a current value for.
@@ -145,6 +159,8 @@ LibPcdGetPtr ( /**
+ This function provides a means by which to retrieve a value for a given PCD token.
+
Returns the Boolean value of the token specified by TokenNumber.
@param[in] TokenNumber The PCD token number to retrieve a current value for.
@@ -166,7 +182,7 @@ LibPcdGetBool ( /**
- Returns the size of the token specified by TokenNumber.
+ This function provides a means by which to retrieve the size of a given PCD token.
@param[in] TokenNumber The PCD token number to retrieve a current value for.
@@ -187,7 +203,10 @@ LibPcdGetSize ( /**
+ This function provides a means by which to retrieve a value for a given PCD token.
+
Returns the 8-bit value for the token specified by TokenNumber and Guid.
+
If Guid is NULL, then ASSERT().
@param[in] Guid Pointer to a 128-bit unique value that designates
@@ -212,7 +231,10 @@ LibPcdGetEx8 ( /**
+ This function provides a means by which to retrieve a value for a given PCD token.
+
Returns the 16-bit value for the token specified by TokenNumber and Guid.
+
If Guid is NULL, then ASSERT().
@param[in] Guid Pointer to a 128-bit unique value that designates
@@ -262,12 +284,15 @@ LibPcdGetEx32 ( /**
+ This function provides a means by which to retrieve a value for a given PCD token.
+
Returns the 64-bit value for the token specified by TokenNumber and Guid.
+
If Guid is NULL, then ASSERT().
- @param[in] Guid Pointer to a 128-bit unique value that designates
- which namespace to retrieve a value from.
- @param[in] TokenNumber The PCD token number to retrieve a current value for.
+ @param[in] Guid Pointer to a 128-bit unique value that designates
+ which namespace to retrieve a value from.
+ @param[in] TokenNumber The PCD token number to retrieve a current value for.
@return Return the UINT64.
@@ -287,12 +312,15 @@ LibPcdGetEx64 ( /**
- Returns the pointer to the buffer of the token specified by TokenNumber and Guid.
+ This function provides a means by which to retrieve a value for a given PCD token.
+
+ Returns the pointer to the buffer of token specified by TokenNumber and Guid.
+
If Guid is NULL, then ASSERT().
- @param[in] Guid Pointer to a 128-bit unique value that designates
- which namespace to retrieve a value from.
- @param[in] TokenNumber The PCD token number to retrieve a current value for.
+ @param[in] Guid Pointer to a 128-bit unique value that designates
+ which namespace to retrieve a value from.
+ @param[in] TokenNumber The PCD token number to retrieve a current value for.
@return Return the VOID* pointer.
@@ -312,12 +340,15 @@ LibPcdGetExPtr ( /**
+ This function provides a means by which to retrieve a value for a given PCD token.
+
Returns the Boolean value of the token specified by TokenNumber and Guid.
+
If Guid is NULL, then ASSERT().
- @param[in] Guid Pointer to a 128-bit unique value that designates
- which namespace to retrieve a value from.
- @param[in] TokenNumber The PCD token number to retrieve a current value for.
+ @param[in] Guid Pointer to a 128-bit unique value that designates
+ which namespace to retrieve a value from.
+ @param[in] TokenNumber The PCD token number to retrieve a current value for.
@return Return the BOOLEAN.
@@ -337,12 +368,15 @@ LibPcdGetExBool ( /**
+ This function provides a means by which to retrieve the size of a given PCD token.
+
Returns the size of the token specified by TokenNumber and Guid.
+
If Guid is NULL, then ASSERT().
- @param[in] Guid Pointer to a 128-bit unique value that designates
- which namespace to retrieve a value from.
- @param[in] TokenNumber The PCD token number to retrieve a current value for.
+ @param[in] Guid Pointer to a 128-bit unique value that designates
+ which namespace to retrieve a value from.
+ @param[in] TokenNumber The PCD token number to retrieve a current value for.
@return Return the size.
@@ -362,11 +396,13 @@ LibPcdGetExSize ( /**
+ This function provides a means by which to set a value for a given PCD token.
+
Sets the 8-bit value for the token specified by TokenNumber
to the value specified by Value. Value is returned.
- @param[in] TokenNumber The PCD token number to set a current value for.
- @param[in] Value The 8-bit value to set.
+ @param[in] TokenNumber The PCD token number to set a current value for.
+ @param[in] Value The 8-bit value to set.
@return Return the value been set.
@@ -386,11 +422,13 @@ LibPcdSet8 ( /**
+ This function provides a means by which to set a value for a given PCD token.
+
Sets the 16-bit value for the token specified by TokenNumber
to the value specified by Value. Value is returned.
- @param[in] TokenNumber The PCD token number to set a current value for.
- @param[in] Value The 16-bit value to set.
+ @param[in] TokenNumber The PCD token number to set a current value for.
+ @param[in] Value The 16-bit value to set.
@return Return the value been set.
@@ -410,11 +448,13 @@ LibPcdSet16 ( /**
+ This function provides a means by which to set a value for a given PCD token.
+
Sets the 32-bit value for the token specified by TokenNumber
to the value specified by Value. Value is returned.
- @param[in] TokenNumber The PCD token number to set a current value for.
- @param[in] Value The 32-bit value to set.
+ @param[in] TokenNumber The PCD token number to set a current value for.
+ @param[in] Value The 32-bit value to set.
@return Return the value been set.
@@ -422,8 +462,8 @@ LibPcdSet16 ( UINT32
EFIAPI
LibPcdSet32 (
- IN UINTN TokenNumber,
- IN UINT32 Value
+ IN UINTN TokenNumber,
+ IN UINT32 Value
)
{
ASSERT (FALSE);
@@ -434,11 +474,13 @@ LibPcdSet32 ( /**
+ This function provides a means by which to set a value for a given PCD token.
+
Sets the 64-bit value for the token specified by TokenNumber
to the value specified by Value. Value is returned.
- @param[in] TokenNumber The PCD token number to set a current value for.
- @param[in] Value The 64-bit value to set.
+ @param[in] TokenNumber The PCD token number to set a current value for.
+ @param[in] Value The 64-bit value to set.
@return Return the value been set.
@@ -446,8 +488,8 @@ LibPcdSet32 ( UINT64
EFIAPI
LibPcdSet64 (
- IN UINTN TokenNumber,
- IN UINT64 Value
+ IN UINTN TokenNumber,
+ IN UINT64 Value
)
{
ASSERT (FALSE);
@@ -458,22 +500,23 @@ LibPcdSet64 ( /**
- Sets a buffer for the token specified by TokenNumber to
- the value specified by Buffer and SizeOfValue. Buffer to
- be set is returned. The content of the buffer could be
- overwritten if a Callback on SET is registered with this
- TokenNumber.
+ This function provides a means by which to set a value for a given PCD token.
- If SizeOfValue is greater than the maximum
- size support by TokenNumber, then set SizeOfValue to the
- maximum size supported by TokenNumber and return NULL to
- indicate that the set operation was not actually performed.
+ Sets a buffer for the token specified by TokenNumber to the value
+ specified by Buffer and SizeOfBuffer. Buffer is returned.
+ If SizeOfBuffer is greater than the maximum size support by TokenNumber,
+ then set SizeOfBuffer to the maximum size supported by TokenNumber and
+ return NULL to indicate that the set operation was not actually performed.
+
+ If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to the
+ maximum size supported by TokenName and NULL must be returned.
- If SizeOfValue > 0 and Buffer is NULL, then ASSERT().
+ If SizeOfBuffer is NULL, then ASSERT().
+ If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().
- @param[in] TokenNumber The PCD token number to set a current value for.
- @param[in, out] SizeOfBuffer The size, in bytes, of Buffer.
- @param[in] Buffer A pointer to the buffer to set.
+ @param[in] TokenNumber The PCD token number to set a current value for.
+ @param[in, out] SizeOfBuffer The size, in bytes, of Buffer.
+ @param[in] Buffer A pointer to the buffer to set.
@return Return the pointer for the buffer been set.
@@ -481,9 +524,9 @@ LibPcdSet64 ( VOID *
EFIAPI
LibPcdSetPtr (
- IN UINTN TokenNumber,
- IN OUT UINTN *SizeOfBuffer,
- IN CONST VOID *Buffer
+ IN UINTN TokenNumber,
+ IN OUT UINTN *SizeOfBuffer,
+ IN CONST VOID *Buffer
)
{
ASSERT (FALSE);
@@ -494,11 +537,13 @@ LibPcdSetPtr ( /**
+ This function provides a means by which to set a value for a given PCD token.
+
Sets the Boolean value for the token specified by TokenNumber
to the value specified by Value. Value is returned.
- @param[in] TokenNumber The PCD token number to set a current value for.
- @param[in] Value The boolean value to set.
+ @param[in] TokenNumber The PCD token number to set a current value for.
+ @param[in] Value The boolean value to set.
@return Return the value been set.
@@ -518,14 +563,17 @@ LibPcdSetBool ( /**
+ This function provides a means by which to set a value for a given PCD token.
+
Sets the 8-bit value for the token specified by TokenNumber and
Guid to the value specified by Value. Value is returned.
+
If Guid is NULL, then ASSERT().
- @param[in] Guid Pointer to a 128-bit unique value that
- designates which namespace to set a value from.
- @param[in] TokenNumber The PCD token number to set a current value for.
- @param[in] Value The 8-bit value to set.
+ @param[in] Guid Pointer to a 128-bit unique value that
+ designates which namespace to set a value from.
+ @param[in] TokenNumber The PCD token number to set a current value for.
+ @param[in] Value The 8-bit value to set.
@return Return the value been set.
@@ -546,14 +594,17 @@ LibPcdSetEx8 ( /**
+ This function provides a means by which to set a value for a given PCD token.
+
Sets the 16-bit value for the token specified by TokenNumber and
Guid to the value specified by Value. Value is returned.
+
If Guid is NULL, then ASSERT().
- @param[in] Guid Pointer to a 128-bit unique value that
- designates which namespace to set a value from.
- @param[in] TokenNumber The PCD token number to set a current value for.
- @param[in] Value The 16-bit value to set.
+ @param[in] Guid Pointer to a 128-bit unique value that
+ designates which namespace to set a value from.
+ @param[in] TokenNumber The PCD token number to set a current value for.
+ @param[in] Value The 16-bit value to set.
@return Return the value been set.
@@ -574,14 +625,17 @@ LibPcdSetEx16 ( /**
+ This function provides a means by which to set a value for a given PCD token.
+
Sets the 32-bit value for the token specified by TokenNumber and
Guid to the value specified by Value. Value is returned.
+
If Guid is NULL, then ASSERT().
- @param[in] Guid Pointer to a 128-bit unique value that
- designates which namespace to set a value from.
- @param[in] TokenNumber The PCD token number to set a current value for.
- @param[in] Value The 32-bit value to set.
+ @param[in] Guid Pointer to a 128-bit unique value that
+ designates which namespace to set a value from.
+ @param[in] TokenNumber The PCD token number to set a current value for.
+ @param[in] Value The 32-bit value to set.
@return Return the value been set.
@@ -602,14 +656,16 @@ LibPcdSetEx32 ( /**
+ This function provides a means by which to set a value for a given PCD token.
+
Sets the 64-bit value for the token specified by TokenNumber and
Guid to the value specified by Value. Value is returned.
If Guid is NULL, then ASSERT().
- @param[in] Guid Pointer to a 128-bit unique value that
- designates which namespace to set a value from.
- @param[in] TokenNumber The PCD token number to set a current value for.
- @param[in] Value The 64-bit value to set.
+ @param[in] Guid Pointer to a 128-bit unique value that
+ designates which namespace to set a value from.
+ @param[in] TokenNumber The PCD token number to set a current value for.
+ @param[in] Value The 64-bit value to set.
@return Return the value been set.
@@ -630,19 +686,23 @@ LibPcdSetEx64 ( /**
+ This function provides a means by which to set a value for a given PCD token.
+
Sets a buffer for the token specified by TokenNumber to the value specified by
- Buffer and SizeOfValue. Buffer is returned. If SizeOfValue is greater than
- the maximum size support by TokenNumber, then set SizeOfValue to the maximum size
+ Buffer and SizeOfBuffer. Buffer is returned. If SizeOfBuffer is greater than
+ the maximum size support by TokenNumber, then set SizeOfBuffer to the maximum size
supported by TokenNumber and return NULL to indicate that the set operation
was not actually performed.
- If SizeOfValue > 0 and Buffer is NULL, then ASSERT().
+ If Guid is NULL, then ASSERT().
+ If SizeOfBuffer is NULL, then ASSERT().
+ If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().
- @param[in] Guid Pointer to a 128-bit unique value that
- designates which namespace to set a value from.
- @param[in] TokenNumber The PCD token number to set a current value for.
- @param[in, out] SizeOfBuffer The size, in bytes, of Buffer.
- @param[in] Buffer A pointer to the buffer to set.
+ @param[in] Guid Pointer to a 128-bit unique value that
+ designates which namespace to set a value from.
+ @param[in] TokenNumber The PCD token number to set a current value for.
+ @param[in, out] SizeOfBuffer The size, in bytes, of Buffer.
+ @param[in] Buffer A pointer to the buffer to set.
@return Return the pinter to the buffer been set.
@@ -664,14 +724,17 @@ LibPcdSetExPtr ( /**
+ This function provides a means by which to set a value for a given PCD token.
+
Sets the Boolean value for the token specified by TokenNumber and
Guid to the value specified by Value. Value is returned.
+
If Guid is NULL, then ASSERT().
- @param[in] Guid Pointer to a 128-bit unique value that
- designates which namespace to set a value from.
- @param[in] TokenNumber The PCD token number to set a current value for.
- @param[in] Value The Boolean value to set.
+ @param[in] Guid Pointer to a 128-bit unique value that
+ designates which namespace to set a value from.
+ @param[in] TokenNumber The PCD token number to set a current value for.
+ @param[in] Value The Boolean value to set.
@return Return the value been set.
@@ -692,17 +755,20 @@ LibPcdSetExBool ( /**
+ Set up a notification function that is called when a specified token is set.
+
When the token specified by TokenNumber and Guid is set,
then notification function specified by NotificationFunction is called.
If Guid is NULL, then the default token space is used.
+
If NotificationFunction is NULL, then ASSERT().
- @param[in] Guid Pointer to a 128-bit unique value that designates which
- namespace to set a value from. If NULL, then the default
- token space is used.
- @param[in] TokenNumber The PCD token number to monitor.
- @param[in] NotificationFunction The function to call when the token
- specified by Guid and TokenNumber is set.
+ @param[in] Guid Pointer to a 128-bit unique value that designates which
+ namespace to set a value from. If NULL, then the default
+ token space is used.
+ @param[in] TokenNumber The PCD token number to monitor.
+ @param[in] NotificationFunction The function to call when the token
+ specified by Guid and TokenNumber is set.
**/
VOID
@@ -720,10 +786,15 @@ LibPcdCallbackOnSet ( /**
Disable a notification function that was established with LibPcdCallbackonSet().
+
+ Disable a notification function that was previously established with LibPcdCallbackOnSet().
+
If NotificationFunction is NULL, then ASSERT().
-
- @param[in] Guid Specify the GUID token space.
- @param[in] TokenNumber Specify the token number.
+ If LibPcdCallbackOnSet() was not previously called with Guid, TokenNumber,
+ and NotificationFunction, then ASSERT().
+
+ @param[in] Guid Specify the GUID token space.
+ @param[in] TokenNumber Specify the token number.
@param[in] NotificationFunction The callback function to be unregistered.
**/
@@ -741,17 +812,20 @@ LibPcdCancelCallback ( /**
+ Retrieves the next token in a token space.
+
Retrieves the next PCD token number from the token space specified by Guid.
If Guid is NULL, then the default token space is used. If TokenNumber is 0,
then the first token number is returned. Otherwise, the token number that
follows TokenNumber in the token space is returned. If TokenNumber is the last
- token number in the token space, then 0 is returned. If TokenNumber is not 0 and
- is not in the token space specified by Guid, then ASSERT().
+ token number in the token space, then 0 is returned.
+
+ If TokenNumber is not 0 and is not in the token space specified by Guid, then ASSERT().
- @param[in] Guid Pointer to a 128-bit unique value that designates which namespace
- to set a value from. If NULL, then the default token space is used.
- @param[in] TokenNumber The previous PCD token number. If 0, then retrieves the first PCD
- token number.
+ @param[in] Guid Pointer to a 128-bit unique value that designates which namespace
+ to set a value from. If NULL, then the default token space is used.
+ @param[in] TokenNumber The previous PCD token number. If 0, then retrieves the first PCD
+ token number.
@return The next valid token number.
@@ -759,8 +833,8 @@ LibPcdCancelCallback ( UINTN
EFIAPI
LibPcdGetNextToken (
- IN CONST GUID *Guid, OPTIONAL
- IN UINTN TokenNumber
+ IN CONST GUID *Guid, OPTIONAL
+ IN UINTN TokenNumber
)
{
ASSERT (FALSE);
@@ -771,6 +845,8 @@ LibPcdGetNextToken ( /**
+ Used to retrieve the list of available PCD token space GUIDs.
+
Retrieves the next PCD token space from a token space specified by Guid.
Guid of NULL is reserved to mark the default local token namespace on the current
platform. If Guid is NULL, then the GUID of the first non-local token space of the
@@ -778,6 +854,8 @@ LibPcdGetNextToken ( then NULL is returned.
If Guid is not NULL and is not a valid token space in the current platform, then ASSERT().
+
+
@param[in] Guid Pointer to a 128-bit unique value that designates from which namespace
to start the search.
@@ -788,7 +866,7 @@ LibPcdGetNextToken ( GUID *
EFIAPI
LibPcdGetNextTokenSpace (
- IN CONST GUID *Guid
+ IN CONST GUID *TokenSpaceGuid
)
{
ASSERT (FALSE);
diff --git a/MdePkg/Library/BasePciLibCf8/PciLib.c b/MdePkg/Library/BasePciLibCf8/PciLib.c index 0834dac5e7..337839e97b 100644 --- a/MdePkg/Library/BasePciLibCf8/PciLib.c +++ b/MdePkg/Library/BasePciLibCf8/PciLib.c @@ -1108,7 +1108,7 @@ PciReadBuffer ( @param Size Size in bytes of the transfer.
@param Buffer Pointer to a buffer containing the data to write.
- @return Size
+ @return Size written to StartAddress.
**/
UINTN
diff --git a/MdePkg/Library/BasePciLibPciExpress/PciLib.c b/MdePkg/Library/BasePciLibPciExpress/PciLib.c index 2566edff36..e1efe065b1 100644 --- a/MdePkg/Library/BasePciLibPciExpress/PciLib.c +++ b/MdePkg/Library/BasePciLibPciExpress/PciLib.c @@ -1108,7 +1108,7 @@ PciReadBuffer ( @param Size Size in bytes of the transfer.
@param Buffer Pointer to a buffer containing the data to write.
- @return Size
+ @return Size written to StartAddress.
**/
UINTN
diff --git a/MdePkg/Library/BasePeCoffLib/BasePeCoff.c b/MdePkg/Library/BasePeCoffLib/BasePeCoff.c index 181c87847a..60f0470319 100644 --- a/MdePkg/Library/BasePeCoffLib/BasePeCoff.c +++ b/MdePkg/Library/BasePeCoffLib/BasePeCoff.c @@ -195,7 +195,7 @@ PeCoffLoaderGetPeHeader ( RETURN_STATUS
EFIAPI
PeCoffLoaderGetImageInfo (
- IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext
+ IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext
)
{
RETURN_STATUS Status;
@@ -487,6 +487,12 @@ PeCoffLoaderImageAddress ( ImageContext as the relocation base address. Otherwise, use the DestinationAddress field
of ImageContext as the relocation base address. The caller must allocate the relocation
fixup log buffer and fill in the FixupData field of ImageContext prior to calling this function.
+
+ The ImageRead, Handle, PeCoffHeaderOffset, IsTeImage, Machine, ImageType, ImageAddress,
+ ImageSize, DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders,
+ DebugDirectoryEntryRva, EntryPoint, FixupDataSize, CodeView, PdbPointer, and FixupData of
+ the ImageContext structure must be valid prior to invoking this service.
+
If ImageContext is NULL, then ASSERT().
@param ImageContext Pointer to the image context structure that describes the PE/COFF
@@ -725,6 +731,10 @@ PeCoffLoaderRelocateImage ( specified by the ImageAddress and ImageSize fields of ImageContext. The caller must allocate
the load buffer and fill in the ImageAddress and ImageSize fields prior to calling this function.
The EntryPoint, FixupDataSize, CodeView, and PdbPointer fields of ImageContext are computed.
+ The ImageRead, Handle, PeCoffHeaderOffset, IsTeImage, Machine, ImageType, ImageAddress, ImageSize,
+ DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, and DebugDirectoryEntryRva
+ fields of the ImageContext structure must be valid prior to invoking this service.
+
If ImageContext is NULL, then ASSERT().
@param ImageContext Pointer to the image context structure that describes the PE/COFF
@@ -1117,17 +1127,20 @@ PeCoffLoaderLoadImage ( /**
Reapply fixups on a fixed up PE32/PE32+ image to allow virutal calling at EFI
- runtime.
-
+ runtime.
+
PE_COFF_LOADER_IMAGE_CONTEXT.FixupData stores information needed to reapply
the fixups with a virtual mapping.
- @param ImageBase Base address of relocated image
- @param VirtImageBase Virtual mapping for ImageBase
- @param ImageSize Size of the image to relocate
- @param RelocationData Location to place results of read
-
+ @param ImageBase Base address of a PE/COFF image that has been loaded
+ and relocated into system memory.
+ @param VirtImageBase The request virtual address that the PE/COFF image is to
+ be fixed up for.
+ @param ImageSize The size, in bytes, of the PE/COFF image.
+ @param RelocationData A pointer to the relocation data that was collected when the PE/COFF
+ image was relocated using PeCoffLoaderRelocateImage().
+
**/
VOID
EFIAPI
@@ -1360,11 +1373,15 @@ PeCoffLoaderImageReadFromMemory ( /**
Unloads a loaded PE/COFF image from memory and releases its taken resource.
-
+ Releases any environment specific resources that were allocated when the image
+ specified by ImageContext was loaded using PeCoffLoaderLoadImage().
+
For NT32 emulator, the PE/COFF image loaded by system needs to release.
For real platform, the PE/COFF image loaded by Core doesn't needs to be unloaded,
this function can simply return RETURN_SUCCESS.
-
+
+ If ImageContext is NULL, then ASSERT().
+
@param ImageContext Pointer to the image context structure that describes the PE/COFF
image to be unloaded.
diff --git a/MdePkg/Library/BasePeCoffLib/PeCoffLoaderEx.c b/MdePkg/Library/BasePeCoffLib/PeCoffLoaderEx.c index 4014c16bab..6913a87e81 100644 --- a/MdePkg/Library/BasePeCoffLib/PeCoffLoaderEx.c +++ b/MdePkg/Library/BasePeCoffLib/PeCoffLoaderEx.c @@ -16,14 +16,15 @@ /**
- Performs an IA-32 specific relocation fixup.
+ Performs an Itanium-based specific relocation fixup and is a no-op on other
+ instruction sets.
@param Reloc Pointer to the relocation record.
@param Fixup Pointer to the address to fix up.
@param FixupData Pointer to a buffer to log the fixups.
@param Adjust The offset to adjust the fixup.
- @retval EFI_UNSUPPORTED Unsupported now.
+ @return Status code.
**/
RETURN_STATUS
@@ -38,14 +39,10 @@ PeCoffLoaderRelocateImageEx ( }
/**
- Returns TRUE if the machine type of PE/COFF image is supported. Supported
+ Returns TRUE if the machine type of PE/COFF image is supported. Supported
does not mean the image can be executed it means the PE/COFF loader supports
loading and relocating of the image type. It's up to the caller to support
- the entry point.
-
- This function implies the basic PE/COFF loader/relocator supports IA32, EBC,
- & x64 images. Calling the entry point in a correct mannor is up to the
- consumer of this library.
+ the entry point.
@param Machine Machine type from the PE Header.
@@ -75,7 +72,7 @@ PeCoffLoaderImageFormatSupported ( @param FixupData Pointer to a buffer to log the fixups.
@param Adjust The offset to adjust the fixup.
- @return Always return UNSUPPORTED.
+ @return Status code.
**/
RETURN_STATUS
diff --git a/MdePkg/Library/BasePerformanceLibNull/PerformanceLib.c b/MdePkg/Library/BasePerformanceLibNull/PerformanceLib.c index c3dd2734d6..737734c9a9 100644 --- a/MdePkg/Library/BasePerformanceLibNull/PerformanceLib.c +++ b/MdePkg/Library/BasePerformanceLibNull/PerformanceLib.c @@ -44,9 +44,9 @@ RETURN_STATUS
EFIAPI
StartPerformanceMeasurement (
- IN CONST VOID *Handle, OPTIONAL
- IN CONST CHAR8 *Token, OPTIONAL
- IN CONST CHAR8 *Module, OPTIONAL
+ IN CONST VOID *Handle, OPTIONAL
+ IN CONST CHAR8 *Token, OPTIONAL
+ IN CONST CHAR8 *Module, OPTIONAL
IN UINT64 TimeStamp
)
{
diff --git a/MdePkg/Library/BasePostCodeLibPort80/PostCode.c b/MdePkg/Library/BasePostCodeLibPort80/PostCode.c index f47a8aba05..eed47616e5 100644 --- a/MdePkg/Library/BasePostCodeLibPort80/PostCode.c +++ b/MdePkg/Library/BasePostCodeLibPort80/PostCode.c @@ -66,7 +66,7 @@ PostCode ( @param Value The 32-bit value to write to the POST card.
@param Description Pointer to an ASCII string that is a description of the
POST code value. This is an optional parameter that may
- be NULL. Ihis parameter is ignored in this implementation.
+ be NULL.
@return The 32-bit value to write to the POST card.
diff --git a/MdePkg/Library/BasePrintLib/PrintLib.c b/MdePkg/Library/BasePrintLib/PrintLib.c index 308f6273bf..c50c4eae7d 100644 --- a/MdePkg/Library/BasePrintLib/PrintLib.c +++ b/MdePkg/Library/BasePrintLib/PrintLib.c @@ -334,7 +334,7 @@ AsciiVSPrint ( @param FormatString Null-terminated ASCII format string.
@param ... Variable argument list whose contents are accessed based on the
format string specified by FormatString.
-
+
@return The number of ASCII characters in the produced output buffer not including the
Null-terminator.
diff --git a/MdePkg/Library/BasePrintLib/PrintLibInternal.c b/MdePkg/Library/BasePrintLib/PrintLibInternal.c index 14cb154713..d87513042e 100644 --- a/MdePkg/Library/BasePrintLib/PrintLibInternal.c +++ b/MdePkg/Library/BasePrintLib/PrintLibInternal.c @@ -100,8 +100,8 @@ BasePrintLibFillBuffer ( **/
UINTN
BasePrintLibValueToString (
- IN OUT CHAR8 *Buffer,
- IN INT64 Value,
+ IN OUT CHAR8 *Buffer,
+ IN INT64 Value,
IN UINTN Radix
)
{
@@ -131,7 +131,7 @@ BasePrintLibValueToString ( Converts the decimal number specified by Value to a Null-terminated
string specified by Buffer containing at most Width characters.
If Width is 0 then a width of MAXIMUM_VALUE_CHARACTERS is assumed.
- The number of characters in Buffer is returned not including the Null-terminator.
+ The total number of characters placed in Buffer is returned.
If the conversion contains more than Width characters, then only the first
Width characters are returned, and the total number of characters
required to perform the conversion is returned.
@@ -141,13 +141,11 @@ BasePrintLibValueToString ( If Width is 0, PREFIX_ZERO is ignored in Flags.
If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and commas
are inserted every 3rd digit starting from the right.
- If HEX_RADIX is set in Flags, then the output buffer will be formatted in hexadecimal format.
- If Value is < 0 and HEX_RADIX is not set in Flags, then the fist character in Buffer is a '-'.
+ If Value is < 0, then the fist character in Buffer is a '-'.
If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored,
then Buffer is padded with '0' characters so the combination of the optional '-'
sign character, '0' characters, digit characters for Value, and the Null-terminator
add up to Width characters.
- If both COMMA_TYPE and HEX_RADIX are set in Flags, then ASSERT().
If Buffer is NULL, then ASSERT().
If unsupported bits are set in Flags, then ASSERT().
@@ -162,7 +160,7 @@ BasePrintLibValueToString ( the Null-terminator.
@param Increment Character increment in Buffer.
- @return The number of characters in Buffer not including the Null-terminator.
+ @return Total number of characters required to perform the conversion.
**/
UINTN
@@ -792,7 +790,7 @@ BasePrintLibVSPrint ( VSPrint function to process format and place the results in Buffer. Since a
VA_LIST is used this rountine allows the nesting of Vararg routines. Thus
- this is the main print working routine.
+ this is the main print working routine
@param StartOfBuffer Character buffer to print the results of the parsing
of Format into.
@@ -803,7 +801,7 @@ BasePrintLibVSPrint ( @param FormatString Null-terminated format string.
@param ... The variable argument list.
- @return Number of characters printed not including the Null-terminator.
+ @return Number of characters printed.
**/
UINTN
diff --git a/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLib.c b/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLib.c index 21d35e29da..f32eac49bf 100644 --- a/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLib.c +++ b/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLib.c @@ -81,8 +81,8 @@ FillBuf ( /**
Get NumOfBits of bits out from mBitBuf.
- Get NumOfBits of bits out from mBitBuf. Fill mBitBuf with subsequent
- NumOfBits of bits from source. Returns NumOfBits of bits that are
+ Get NumOfBits of bits out from mBitBuf. Fill mBitBuf with subsequent
+ NumOfBits of bits from source. Returns NumOfBits of bits that are
popped out.
@param Sd The global scratch data.
@@ -115,14 +115,14 @@ GetBits ( /**
Creates Huffman Code mapping table according to code length array.
- Creates Huffman Code mapping table for Extra Set, Char&Len Set
+ Creates Huffman Code mapping table for Extra Set, Char&Len Set
and Position Set according to code length array.
@param Sd The global scratch data
@param NumOfChar Number of symbols in the symbol set
@param BitLen Code length array
@param TableBits The width of the mapping table
- @param Table The table to be created
+ @param Table The table to be created.
@retval 0 OK.
@retval BAD_TABLE The table is corrupted.
@@ -251,7 +251,7 @@ MakeTable ( Decodes a position value.
Get a position value according to Position Huffman Table.
-
+
@param Sd the global scratch data
@return The position value decoded.
@@ -391,7 +391,7 @@ ReadPTLen ( /**
Reads code lengths for Char&Len Set.
-
+
Read in and decode the Char&Len Set Code Length Array, then
generate the Huffman Code mapping table for the Char&Len Set.
@@ -482,7 +482,7 @@ ReadCLen ( /**
Decode a character/length value.
-
+
Read one value from mBitBuf, Get one code from mBitBuf. If it is at block boundary, generates
Huffman code mapping table for Extra Set, Code&Len Set and
Position Set.
@@ -561,7 +561,7 @@ DecodeC ( /**
Decode the source data and put the resulting data into the destination buffer.
-
+
@param Sd The global scratch data
**/
|