TianoCore EDK2 master
Loading...
Searching...
No Matches
MemLibInternals.h File Reference

Go to the source code of this file.

Functions

VOID *EFIAPI InternalMemCopyMem (OUT VOID *Destination, IN CONST VOID *Source, IN UINTN Length)
 
VOID *EFIAPI InternalMemSetMem (OUT VOID *Buffer, IN UINTN Size, IN UINT8 Value)
 
VOID *EFIAPI InternalMemSetMem16 (OUT VOID *Buffer, IN UINTN Length, IN UINT16 Value)
 
VOID *EFIAPI InternalMemSetMem32 (OUT VOID *Buffer, IN UINTN Length, IN UINT32 Value)
 
VOID *EFIAPI InternalMemSetMem64 (OUT VOID *Buffer, IN UINTN Length, IN UINT64 Value)
 
VOID *EFIAPI InternalMemZeroMem (OUT VOID *Buffer, IN UINTN Length)
 
INTN EFIAPI InternalMemCompareMem (IN CONST VOID *DestinationBuffer, IN CONST VOID *SourceBuffer, IN UINTN Length)
 
CONST VOID *EFIAPI InternalMemScanMem8 (IN CONST VOID *Buffer, IN UINTN Length, IN UINT8 Value)
 
CONST VOID *EFIAPI InternalMemScanMem16 (IN CONST VOID *Buffer, IN UINTN Length, IN UINT16 Value)
 
CONST VOID *EFIAPI InternalMemScanMem32 (IN CONST VOID *Buffer, IN UINTN Length, IN UINT32 Value)
 
CONST VOID *EFIAPI InternalMemScanMem64 (IN CONST VOID *Buffer, IN UINTN Length, IN UINT64 Value)
 
BOOLEAN EFIAPI InternalMemIsZeroBuffer (IN CONST VOID *Buffer, IN UINTN Length)
 

Detailed Description

Declaration of internal functions for Base Memory Library.

Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file MemLibInternals.h.

Function Documentation

◆ InternalMemCompareMem()

INTN EFIAPI InternalMemCompareMem ( IN CONST VOID *  DestinationBuffer,
IN CONST VOID *  SourceBuffer,
IN UINTN  Length 
)

Compares two memory buffers of a given length.

Parameters
DestinationBufferThe first memory buffer
SourceBufferThe second memory buffer
LengthThe length of DestinationBuffer and SourceBuffer memory regions to compare. Must be non-zero.
Returns
0 All Length bytes of the two buffers are identical.
Return values
Non-zeroThe first mismatched byte in SourceBuffer subtracted from the first mismatched byte in DestinationBuffer.

Compares two memory buffers of a given length.

Parameters
DestinationBufferThe first memory buffer.
SourceBufferThe second memory buffer.
LengthLength of DestinationBuffer and SourceBuffer memory regions to compare. Must be non-zero.
Returns
0 All Length bytes of the two buffers are identical.
Return values
Non-zeroThe first mismatched byte in SourceBuffer subtracted from the first mismatched byte in DestinationBuffer.

Definition at line 125 of file MemLibGeneric.c.

◆ InternalMemCopyMem()

VOID *EFIAPI InternalMemCopyMem ( OUT VOID *  Destination,
IN CONST VOID *  Source,
IN UINTN  Length 
)

Copies a source buffer to a destination buffer, and returns the destination buffer.

This function wraps the (*PeiServices)->CopyMem ().

Parameters
DestinationBufferThe pointer to the destination buffer of the memory copy.
SourceBufferThe pointer to the source buffer of the memory copy.
LengthThe number of bytes to copy from SourceBuffer to DestinationBuffer.
Returns
DestinationBuffer.

Copy Length bytes from Source to Destination.

Parameters
DestinationBufferThe target of the copy request.
SourceBufferThe place to copy from.
LengthThe number of bytes to copy.
Returns
Destination

Copies a source buffer to a destination buffer, and returns the destination buffer.

This function wraps the gPS->CopyMem ().

Parameters
DestinationBufferThe pointer to the destination buffer of the memory copy.
SourceBufferThe pointer to the source buffer of the memory copy.
LengthThe number of bytes to copy from SourceBuffer to DestinationBuffer.
Returns
DestinationBuffer.

Copies a source buffer to a destination buffer, and returns the destination buffer.

This function wraps the gBS->CopyMem().

Parameters
DestinationBufferThe pointer to the destination buffer of the memory copy.
SourceBufferThe pointer to the source buffer of the memory copy.
LengthThe number of bytes to copy from SourceBuffer to DestinationBuffer.
Returns
DestinationBuffer.

Definition at line 28 of file CopyMem.c.

◆ InternalMemIsZeroBuffer()

BOOLEAN EFIAPI InternalMemIsZeroBuffer ( IN CONST VOID *  Buffer,
IN UINTN  Length 
)

Checks whether the contents of a buffer are all zeros.

Parameters
BufferThe pointer to the buffer to be checked.
LengthThe size of the buffer (in bytes) to be checked.
Return values
TRUEContents of the buffer are all zeros.
FALSEContents of the buffer are not all zeros.

Definition at line 285 of file MemLibGeneric.c.

◆ InternalMemScanMem16()

CONST VOID *EFIAPI InternalMemScanMem16 ( IN CONST VOID *  Buffer,
IN UINTN  Length,
IN UINT16  Value 
)

Scans a target buffer for a 16-bit value, and returns a pointer to the matching 16-bit value in the target buffer.

Parameters
BufferThe pointer to the target buffer to scan.
LengthThe count of 16-bit value to scan. Must be non-zero.
ValueThe value to search for in the target buffer.
Returns
The pointer to the first occurrence, or NULL if not found.

Scans a target buffer for a 16-bit value, and returns a pointer to the matching 16-bit value in the target buffer.

Parameters
BufferThe pointer to the target buffer to scan.
LengthThe count of 16-bit value to scan. Must be non-zero.
ValueThe value to search for in the target buffer.
Returns
The pointer to the first occurrence or NULL if not found.

Definition at line 187 of file MemLibGeneric.c.

◆ InternalMemScanMem32()

CONST VOID *EFIAPI InternalMemScanMem32 ( IN CONST VOID *  Buffer,
IN UINTN  Length,
IN UINT32  Value 
)

Scans a target buffer for a 32-bit value, and returns a pointer to the matching 32-bit value in the target buffer.

Parameters
BufferThe pointer to the target buffer to scan.
LengthThe count of 32-bit value to scan. Must be non-zero.
ValueThe value to search for in the target buffer.
Returns
The pointer to the first occurrence, or NULL if not found.

Scans a target buffer for a 32-bit value, and returns a pointer to the matching 32-bit value in the target buffer.

Parameters
BufferThe pointer to the target buffer to scan.
LengthThe count of 32-bit value to scan. Must be non-zero.
ValueThe value to search for in the target buffer.
Returns
The pointer to the first occurrence or NULL if not found.

Definition at line 220 of file MemLibGeneric.c.

◆ InternalMemScanMem64()

CONST VOID *EFIAPI InternalMemScanMem64 ( IN CONST VOID *  Buffer,
IN UINTN  Length,
IN UINT64  Value 
)

Scans a target buffer for a 64-bit value, and returns a pointer to the matching 64-bit value in the target buffer.

Parameters
BufferThe pointer to the target buffer to scan.
LengthThe count of 64-bit value to scan. Must be non-zero.
ValueThe value to search for in the target buffer.
Returns
The pointer to the first occurrence, or NULL if not found.

Scans a target buffer for a 64-bit value, and returns a pointer to the matching 64-bit value in the target buffer.

Parameters
BufferThe pointer to the target buffer to scan.
LengthThe count of 64-bit value to scan. Must be non-zero.
ValueThe value to search for in the target buffer.
Returns
The pointer to the first occurrence or NULL if not found.

Definition at line 253 of file MemLibGeneric.c.

◆ InternalMemScanMem8()

CONST VOID *EFIAPI InternalMemScanMem8 ( IN CONST VOID *  Buffer,
IN UINTN  Length,
IN UINT8  Value 
)

Scans a target buffer for an 8-bit value, and returns a pointer to the matching 8-bit value in the target buffer.

Parameters
BufferThe pointer to the target buffer to scan.
LengthThe count of 8-bit value to scan. Must be non-zero.
ValueThe value to search for in the target buffer.
Returns
The pointer to the first occurrence, or NULL if not found.

Scans a target buffer for an 8-bit value, and returns a pointer to the matching 8-bit value in the target buffer.

Parameters
BufferThe pointer to the target buffer to scan.
LengthThe count of 8-bit value to scan. Must be non-zero.
ValueThe value to search for in the target buffer.
Returns
The pointer to the first occurrence or NULL if not found.

Definition at line 154 of file MemLibGeneric.c.

◆ InternalMemSetMem()

VOID *EFIAPI InternalMemSetMem ( OUT VOID *  Buffer,
IN UINTN  Size,
IN UINT8  Value 
)

Fills a target buffer with a byte value, and returns the target buffer.

This function wraps the (*PeiServices)->SetMem ().

Parameters
BufferThe memory to set.
SizeThe number of bytes to set.
ValueValue of the set operation.
Returns
Buffer.

Set Buffer to Value for Size bytes.

Parameters
BufferThe memory to set.
LengthThe number of bytes to set.
ValueThe value of the set operation.
Returns
Buffer

Fills a target buffer with a byte value, and returns the target buffer.

This function wraps the gPS->SetMem ().

Parameters
BufferMemory to set.
SizeThe number of bytes to set.
ValueValue of the set operation.
Returns
Buffer.

Fills a target buffer with a byte value, and returns the target buffer.

This function wraps the gBS->SetMem().

Parameters
BufferMemory to set.
SizeThe number of bytes to set.
ValueValue of the set operation.
Returns
Buffer.

Definition at line 29 of file SetMem.c.

◆ InternalMemSetMem16()

VOID *EFIAPI InternalMemSetMem16 ( OUT VOID *  Buffer,
IN UINTN  Length,
IN UINT16  Value 
)

Fills a target buffer with a 16-bit value, and returns the target buffer.

Parameters
BufferThe pointer to the target buffer to fill.
LengthThe count of 16-bit value to fill.
ValueThe value with which to fill Length bytes of Buffer.
Returns
Buffer

Fills a target buffer with a 16-bit value, and returns the target buffer.

Parameters
BufferThe pointer to the target buffer to fill.
LengthThe count of 16-bit value to fill.
ValueThe value with which to fill Length bytes of Buffer.
Returns
Buffer.

Definition at line 28 of file MemLibGeneric.c.

◆ InternalMemSetMem32()

VOID *EFIAPI InternalMemSetMem32 ( OUT VOID *  Buffer,
IN UINTN  Length,
IN UINT32  Value 
)

Fills a target buffer with a 32-bit value, and returns the target buffer.

Parameters
BufferThe pointer to the target buffer to fill.
LengthThe count of 32-bit value to fill.
ValueThe value with which to fill Length bytes of Buffer.
Returns
Buffer

Fills a target buffer with a 32-bit value, and returns the target buffer.

Parameters
BufferThe pointer to the target buffer to fill.
LengthThe count of 32-bit value to fill.
ValueThe value with which to fill Length bytes of Buffer.
Returns
Buffer.

Definition at line 53 of file MemLibGeneric.c.

◆ InternalMemSetMem64()

VOID *EFIAPI InternalMemSetMem64 ( OUT VOID *  Buffer,
IN UINTN  Length,
IN UINT64  Value 
)

Fills a target buffer with a 64-bit value, and returns the target buffer.

Parameters
BufferThe pointer to the target buffer to fill.
LengthThe count of 64-bit value to fill.
ValueThe value with which to fill Length bytes of Buffer.
Returns
Buffer

Fills a target buffer with a 64-bit value, and returns the target buffer.

Parameters
BufferThe pointer to the target buffer to fill.
LengthThe count of 64-bit value to fill.
ValueThe value with which to fill Length bytes of Buffer.
Returns
Buffer.

Definition at line 78 of file MemLibGeneric.c.

◆ InternalMemZeroMem()

VOID *EFIAPI InternalMemZeroMem ( OUT VOID *  Buffer,
IN UINTN  Length 
)

Set Buffer to 0 for Size bytes.

Parameters
BufferThe memory to set.
LengthThe number of bytes to set
Returns
Buffer

Set Buffer to 0 for Size bytes.

Parameters
BufferMemory to set.
LengthThe number of bytes to set.
Returns
Buffer

Set Buffer to 0 for Size bytes.

Parameters
BufferThe memory to set.
LengthThe number of bytes to set
Returns
Buffer.

Set Buffer to 0 for Size bytes.

Parameters
BufferMemory to set.
LengthThe number of bytes to set
Returns
Buffer

Definition at line 102 of file MemLibGeneric.c.