\r
**/\r
\r
-#include <BaseLibInternals.h>\r
+#include "BaseLibInternals.h"\r
\r
/**\r
- Calculate the sum of all elements in a buffer in unit of UINT8. \r
+ Returns the sum of all elements in a buffer in unit of UINT8.\r
During calculation, the carry bits are dropped.\r
\r
- This function calculates the sum of all elements in a buffer \r
- in unit of UINT8. The carry bits in result of addition are dropped. \r
- The result is returned as UINT8. If Length is Zero, then Zero is \r
+ This function calculates the sum of all elements in a buffer\r
+ in unit of UINT8. The carry bits in result of addition are dropped.\r
+ The result is returned as UINT8. If Length is Zero, then Zero is\r
returned.\r
- \r
+\r
If Buffer is NULL, then ASSERT().\r
- If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
+ If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
\r
@param Buffer Pointer to the buffer to carry out the sum operation.\r
- @param Length The size, in bytes, of Buffer .\r
+ @param Length The size, in bytes, of Buffer.\r
\r
- @return The sum of Buffer with carry bits dropped during additions.\r
+ @return Sum The sum of Buffer with carry bits dropped during additions.\r
\r
**/\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
UINT8 Sum;\r
\r
\r
/**\r
- Returns the two's complement checksum of all elements in a buffer \r
+ Returns the two's complement checksum of all elements in a buffer\r
of 8-bit values.\r
\r
- This function first calculates the sum of the 8-bit values in the \r
- buffer specified by Buffer and Length. The carry bits in the result \r
- of addition are dropped. Then, the two's complement of the sum is \r
+ This function first calculates the sum of the 8-bit values in the\r
+ buffer specified by Buffer and Length. The carry bits in the result\r
+ of addition are dropped. Then, the two's complement of the sum is\r
returned. If Length is 0, then 0 is returned.\r
- \r
+\r
If Buffer is NULL, then ASSERT().\r
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\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 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
UINT8 CheckSum;\r
}\r
\r
/**\r
- Returns the sum of all elements in a buffer of 16-bit values. During \r
+ Returns the sum of all elements in a buffer of 16-bit values. During\r
calculation, the carry bits are dropped.\r
\r
- This function calculates the sum of the 16-bit values in the buffer \r
- specified by Buffer and Length. The carry bits in result of addition are dropped. \r
- The 16-bit result is returned. If Length is 0, then 0 is returned. \r
- \r
+ This function calculates the sum of the 16-bit values in the buffer\r
+ specified by Buffer and Length. The carry bits in result of addition are dropped.\r
+ The 16-bit result is returned. If Length is 0, then 0 is returned.\r
+\r
If Buffer is NULL, then ASSERT().\r
If Buffer is not aligned on a 16-bit boundary, then ASSERT().\r
If Length is not aligned on a 16-bit boundary, then ASSERT().\r
@param Buffer Pointer to the buffer to carry out the sum operation.\r
@param Length The size, in bytes, of Buffer.\r
\r
- @return The sum of Buffer with carry bits dropped during additions.\r
+ @return Sum The sum of Buffer with carry bits dropped during additions.\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
UINT16 Sum;\r
\r
\r
/**\r
- Returns the two's complement checksum of all elements in a buffer of \r
+ Returns the two's complement checksum of all elements in a buffer of\r
16-bit values.\r
\r
- This function first calculates the sum of the 16-bit values in the buffer \r
- specified by Buffer and Length. The carry bits in the result of addition \r
- are dropped. Then, the two's complement of the sum is returned. If Length \r
+ This function first calculates the sum of the 16-bit values in the buffer\r
+ specified by Buffer and Length. The carry bits in the result of addition\r
+ are dropped. Then, the two's complement of the sum is returned. If Length\r
is 0, then 0 is returned.\r
- \r
+\r
If Buffer is NULL, then ASSERT().\r
If Buffer is not aligned on a 16-bit boundary, then ASSERT().\r
If Length is not aligned on a 16-bit boundary, then ASSERT().\r
- If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
+ If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\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 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
UINT16 CheckSum;\r
\r
\r
/**\r
- Returns the sum of all elements in a buffer of 32-bit values. During \r
+ Returns the sum of all elements in a buffer of 32-bit values. During\r
calculation, the carry bits are dropped.\r
\r
- This function calculates the sum of the 32-bit values in the buffer \r
- specified by Buffer and Length. The carry bits in result of addition are dropped. \r
- The 32-bit result is returned. If Length is 0, then 0 is returned. \r
- \r
+ This function calculates the sum of the 32-bit values in the buffer\r
+ specified by Buffer and Length. The carry bits in result of addition are dropped.\r
+ The 32-bit result is returned. If Length is 0, then 0 is returned.\r
+\r
If Buffer is NULL, then ASSERT().\r
If Buffer is not aligned on a 32-bit boundary, then ASSERT().\r
If Length is not aligned on a 32-bit boundary, then ASSERT().\r
@param Buffer Pointer to the buffer to carry out the sum operation.\r
@param Length The size, in bytes, of Buffer.\r
\r
- @return The sum of Buffer with carry bits dropped during additions.\r
+ @return Sum The sum of Buffer with carry bits dropped during additions.\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
UINT32 Sum;\r
\r
\r
/**\r
- Returns the two's complement checksum of all elements in a buffer of \r
+ Returns the two's complement checksum of all elements in a buffer of\r
32-bit values.\r
\r
- This function first calculates the sum of the 32-bit values in the buffer \r
- specified by Buffer and Length. The carry bits in the result of addition \r
- are dropped. Then, the two's complement of the sum is returned. If Length \r
+ This function first calculates the sum of the 32-bit values in the buffer\r
+ specified by Buffer and Length. The carry bits in the result of addition\r
+ are dropped. Then, the two's complement of the sum is returned. If Length\r
is 0, then 0 is returned.\r
- \r
+\r
If Buffer is NULL, then ASSERT().\r
If Buffer is not aligned on a 32-bit boundary, then ASSERT().\r
If Length is not aligned on a 32-bit boundary, then ASSERT().\r
- If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
+ If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\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 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
UINT32 CheckSum;\r
\r
\r
/**\r
- Returns the sum of all elements in a buffer of 64-bit values. During \r
+ Returns the sum of all elements in a buffer of 64-bit values. During\r
calculation, the carry bits are dropped.\r
\r
- This function calculates the sum of the 64-bit values in the buffer \r
- specified by Buffer and Length. The carry bits in result of addition are dropped. \r
- The 64-bit result is returned. If Length is 0, then 0 is returned. \r
- \r
+ This function calculates the sum of the 64-bit values in the buffer\r
+ specified by Buffer and Length. The carry bits in result of addition are dropped.\r
+ The 64-bit result is returned. If Length is 0, then 0 is returned.\r
+\r
If Buffer is NULL, then ASSERT().\r
If Buffer is not aligned on a 64-bit boundary, then ASSERT().\r
If Length is not aligned on a 64-bit boundary, then ASSERT().\r
@param Buffer Pointer to the buffer to carry out the sum operation.\r
@param Length The size, in bytes, of Buffer.\r
\r
- @return The sum of Buffer with carry bits dropped during additions.\r
+ @return Sum The sum of Buffer with carry bits dropped during additions.\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
UINT64 Sum;\r
\r
\r
/**\r
- Returns the two's complement checksum of all elements in a buffer of \r
+ Returns the two's complement checksum of all elements in a buffer of\r
64-bit values.\r
\r
- This function first calculates the sum of the 64-bit values in the buffer \r
- specified by Buffer and Length. The carry bits in the result of addition \r
- are dropped. Then, the two's complement of the sum is returned. If Length \r
+ This function first calculates the sum of the 64-bit values in the buffer\r
+ specified by Buffer and Length. The carry bits in the result of addition\r
+ are dropped. Then, the two's complement of the sum is returned. If Length\r
is 0, then 0 is returned.\r
- \r
+\r
If Buffer is NULL, then ASSERT().\r
If Buffer is not aligned on a 64-bit boundary, then ASSERT().\r
If Length is not aligned on a 64-bit boundary, then ASSERT().\r
- If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
+ If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\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 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
UINT64 CheckSum;\r