X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=MdePkg%2FLibrary%2FPeiMemoryLib%2FMemLibInternals.h;h=e216b9445b0099fc04075c2968b121e4f1c36b37;hb=0c3437e0437334687bf08557339072ec9d6977e3;hp=8646b24e7902fd205824a613d65b58ca7b998719;hpb=dd51a993419cb90cc954aa4d9ae53fb012991d21;p=mirror_edk2.git diff --git a/MdePkg/Library/PeiMemoryLib/MemLibInternals.h b/MdePkg/Library/PeiMemoryLib/MemLibInternals.h index 8646b24e79..e216b9445b 100644 --- a/MdePkg/Library/PeiMemoryLib/MemLibInternals.h +++ b/MdePkg/Library/PeiMemoryLib/MemLibInternals.h @@ -10,14 +10,14 @@ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. - Module Name: MemLibInternals.h - - The following BaseMemoryLib instances share the same version of this file: + The following BaseMemoryLib instances contain the same copy of this file: BaseMemoryLib BaseMemoryLibMmx BaseMemoryLibSse2 BaseMemoryLibRepStr + BaseMemoryLibOptDxe + BaseMemoryLibOptPei PeiMemoryLib DxeMemoryLib @@ -26,39 +26,51 @@ #ifndef __MEM_LIB_INTERNALS__ #define __MEM_LIB_INTERNALS__ + +#include + +#include +#include +#include +#include + /** - Copy Length bytes from Source to Destination. + Copies a source buffer to a destination buffer, and returns the destination buffer. - @param Destination Target of copy - @param Source Place to copy from - @param Length Number of bytes to copy + This function wraps the gPS->CopyMem (). + + @param DestinationBuffer Pointer to the destination buffer of the memory copy. + @param SourceBuffer Pointer to the source buffer of the memory copy. + @param Length Number of bytes to copy from SourceBuffer to DestinationBuffer. - @return Destination + @return DestinationBuffer. **/ VOID * EFIAPI InternalMemCopyMem ( - OUT VOID *DestinationBuffer, - IN CONST VOID *SourceBuffer, + OUT VOID *Destination, + IN CONST VOID *Source, IN UINTN Length ); /** - Set Buffer to Value for Size bytes. + Fills a target buffer with a byte value, and returns the target buffer. - @param Buffer Memory to set. - @param Size Number of bytes to set - @param Value Value of the set operation. + This function wraps the gPS->SetMem (). + + @param Buffer Memory to set. + @param Size Number of bytes to set. + @param Value Value of the set operation. - @return Buffer + @return Buffer. **/ VOID * EFIAPI InternalMemSetMem ( OUT VOID *Buffer, - IN UINTN Length, + IN UINTN Size, IN UINT8 Value ); @@ -120,7 +132,7 @@ InternalMemSetMem64 ( Set Buffer to 0 for Size bytes. @param Buffer Memory to set. - @param Size Number of bytes to set + @param Length Number of bytes to set @return Buffer @@ -140,7 +152,9 @@ InternalMemZeroMem ( @param Length Length of DestinationBuffer and SourceBuffer memory regions to compare. Must be non-zero. - @retval 0 if MemOne == MemTwo + @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