/** @file\r
- Provides copy memory, fill memory, zero memory, and GUID functions. \r
-\r
-Copyright (c) 2006 - 2008, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
-are licensed and made available under the terms and conditions of the BSD License\r
-which accompanies this distribution. The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php\r
+ Provides copy memory, fill memory, zero memory, and GUID functions.\r
+ \r
+ The Base Memory Library provides optimized implementations for common memory-based operations. \r
+ These functions should be used in place of coding your own loops to do equivalent common functions. \r
+ This allows optimized library implementations to help increase performance. \r
+\r
+Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php.\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
This function copies Length bytes from SourceBuffer to DestinationBuffer, and returns\r
DestinationBuffer. The implementation must be reentrant, and it must handle the case\r
where SourceBuffer overlaps DestinationBuffer.\r
+ \r
If Length is greater than (MAX_ADDRESS - DestinationBuffer + 1), then ASSERT().\r
If Length is greater than (MAX_ADDRESS - SourceBuffer + 1), then ASSERT().\r
\r
- @param DestinationBuffer Pointer to the destination buffer of the memory copy.\r
- @param SourceBuffer Pointer to the source buffer of the memory copy.\r
- @param Length Number of bytes to copy from SourceBuffer to DestinationBuffer.\r
+ @param DestinationBuffer The pointer to the destination buffer of the memory copy.\r
+ @param SourceBuffer The pointer to the source buffer of the memory copy.\r
+ @param Length The number of bytes to copy from SourceBuffer to DestinationBuffer.\r
\r
@return DestinationBuffer.\r
\r
Fills a target buffer with a byte value, and returns the target buffer.\r
\r
This function fills Length bytes of Buffer with Value, and returns Buffer.\r
+ \r
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
\r
- @param Buffer Memory to set.\r
- @param Length Number of bytes to set.\r
- @param Value Value of the set operation.\r
+ @param Buffer The memory to set.\r
+ @param Length The number of bytes to set.\r
+ @param Value The value with which to fill Length bytes of Buffer.\r
\r
@return Buffer.\r
\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
\r
- @param Buffer Pointer to the target buffer to fill.\r
- @param Length Number of bytes in Buffer to fill.\r
- @param Value Value with which to fill Length bytes of Buffer.\r
+ @param Buffer The pointer to the target buffer to fill.\r
+ @param Length The number of bytes in Buffer to fill.\r
+ @param Value The value with which to fill Length bytes of Buffer.\r
\r
@return Buffer.\r
\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
\r
- @param Buffer Pointer to the target buffer to fill.\r
- @param Length Number of bytes in Buffer to fill.\r
- @param Value Value with which to fill Length bytes of Buffer.\r
+ @param Buffer The pointer to the target buffer to fill.\r
+ @param Length The number of bytes in Buffer to fill.\r
+ @param Value The value with which to fill Length bytes of Buffer.\r
\r
@return Buffer.\r
\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
\r
- @param Buffer Pointer to the target buffer to fill.\r
- @param Length Number of bytes in Buffer to fill.\r
- @param Value Value with which to fill Length bytes of Buffer.\r
+ @param Buffer The pointer to the target buffer to fill.\r
+ @param Length The number of bytes in Buffer to fill.\r
+ @param Value The value with which to fill Length bytes of Buffer.\r
\r
@return Buffer.\r
\r
IN UINT64 Value\r
);\r
\r
+/**\r
+ Fills a target buffer with a value that is size UINTN, and returns the target buffer.\r
+\r
+ This function fills Length bytes of Buffer with the UINTN sized value specified by\r
+ Value, and returns Buffer. Value is repeated every sizeof(UINTN) bytes for Length\r
+ bytes of Buffer.\r
+\r
+ If Length > 0 and Buffer is NULL, then ASSERT().\r
+ If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
+ If Buffer is not aligned on a UINTN boundary, then ASSERT().\r
+ If Length is not aligned on a UINTN boundary, then ASSERT().\r
+\r
+ @param Buffer The pointer to the target buffer to fill.\r
+ @param Length The number of bytes in Buffer to fill.\r
+ @param Value The value with which to fill Length bytes of Buffer.\r
+\r
+ @return Buffer.\r
+\r
+**/\r
+VOID *\r
+EFIAPI\r
+SetMemN (\r
+ OUT VOID *Buffer,\r
+ IN UINTN Length,\r
+ IN UINTN Value\r
+ );\r
+\r
/**\r
Fills a target buffer with zeros, and returns the target buffer.\r
\r
This function fills Length bytes of Buffer with zeros, and returns Buffer.\r
+ \r
If Length > 0 and Buffer is NULL, then ASSERT().\r
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
\r
- @param Buffer Pointer to the target buffer to fill with zeros.\r
- @param Length Number of bytes in Buffer to fill with zeros.\r
+ @param Buffer The pointer to the target buffer to fill with zeros.\r
+ @param Length The number of bytes in Buffer to fill with zeros.\r
\r
@return Buffer.\r
\r
If all Length bytes of the two buffers are identical, then 0 is returned. Otherwise, the\r
value returned is the first mismatched byte in SourceBuffer subtracted from the first\r
mismatched byte in DestinationBuffer.\r
+ \r
If Length > 0 and DestinationBuffer is NULL, then ASSERT().\r
If Length > 0 and SourceBuffer is NULL, then ASSERT().\r
If Length is greater than (MAX_ADDRESS - DestinationBuffer + 1), then ASSERT().\r
If Length is greater than (MAX_ADDRESS - SourceBuffer + 1), then ASSERT().\r
\r
- @param DestinationBuffer Pointer to the destination buffer to compare.\r
- @param SourceBuffer Pointer to the source buffer to compare.\r
- @param Length Number of bytes to compare.\r
+ @param DestinationBuffer The pointer to the destination buffer to compare.\r
+ @param SourceBuffer The pointer to the source buffer to compare.\r
+ @param Length The number of bytes to compare.\r
\r
@return 0 All Length bytes of the two buffers are identical.\r
@retval Non-zero The first mismatched byte in SourceBuffer subtracted from the first\r
mismatched byte in DestinationBuffer.\r
-\r
+ \r
**/\r
INTN\r
EFIAPI\r
address to the highest address for an 8-bit value that matches Value. If a match is found,\r
then a pointer to the matching byte in the target buffer is returned. If no match is found,\r
then NULL is returned. If Length is 0, then NULL is returned.\r
+ \r
If Length > 0 and Buffer is NULL, then ASSERT().\r
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
\r
- @param Buffer Pointer to the target buffer to scan.\r
- @param Length Number of bytes in Buffer to scan.\r
- @param Value Value to search for in the target buffer.\r
+ @param Buffer The pointer to the target buffer to scan.\r
+ @param Length The number of bytes in Buffer to scan.\r
+ @param Value The value to search for in the target buffer.\r
\r
- @return A pointer to the matching byte in the target buffer or NULL otherwise.\r
+ @return A pointer to the matching byte in the target buffer, otherwise NULL.\r
\r
**/\r
VOID *\r
address to the highest address for a 16-bit value that matches Value. If a match is found,\r
then a pointer to the matching byte in the target buffer is returned. If no match is found,\r
then NULL is returned. If Length is 0, then NULL is returned.\r
+ \r
If Length > 0 and 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
\r
- @param Buffer Pointer to the target buffer to scan.\r
- @param Length Number of bytes in Buffer to scan.\r
- @param Value Value to search for in the target buffer.\r
+ @param Buffer The pointer to the target buffer to scan.\r
+ @param Length The number of bytes in Buffer to scan.\r
+ @param Value The value to search for in the target buffer.\r
\r
- @return A pointer to the matching byte in the target buffer or NULL otherwise.\r
+ @return A pointer to the matching byte in the target buffer, otherwise NULL.\r
\r
**/\r
VOID *\r
address to the highest address for a 32-bit value that matches Value. If a match is found,\r
then a pointer to the matching byte in the target buffer is returned. If no match is found,\r
then NULL is returned. If Length is 0, then NULL is returned.\r
+ \r
If Length > 0 and 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
\r
- @param Buffer Pointer to the target buffer to scan.\r
- @param Length Number of bytes in Buffer to scan.\r
- @param Value Value to search for in the target buffer.\r
+ @param Buffer The pointer to the target buffer to scan.\r
+ @param Length The number of bytes in Buffer to scan.\r
+ @param Value The value to search for in the target buffer.\r
\r
- @return A pointer to the matching byte in the target buffer or NULL otherwise.\r
+ @return A pointer to the matching byte in the target buffer, otherwise NULL.\r
\r
**/\r
VOID *\r
address to the highest address for a 64-bit value that matches Value. If a match is found,\r
then a pointer to the matching byte in the target buffer is returned. If no match is found,\r
then NULL is returned. If Length is 0, then NULL is returned.\r
+ \r
If Length > 0 and 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
\r
- @param Buffer Pointer to the target buffer to scan.\r
- @param Length Number of bytes in Buffer to scan.\r
- @param Value Value to search for in the target buffer.\r
+ @param Buffer The pointer to the target buffer to scan.\r
+ @param Length The number of bytes in Buffer to scan.\r
+ @param Value The value to search for in the target buffer.\r
\r
- @return A pointer to the matching byte in the target buffer or NULL otherwise.\r
+ @return A pointer to the matching byte in the target buffer, otherwise NULL.\r
\r
**/\r
VOID *\r
IN UINT64 Value\r
);\r
\r
+/**\r
+ Scans a target buffer for a UINTN sized value, and returns a pointer to the matching \r
+ UINTN sized value in the target buffer.\r
+\r
+ This function searches target the buffer specified by Buffer and Length from the lowest\r
+ address to the highest address for a UINTN sized value that matches Value. If a match is found,\r
+ then a pointer to the matching byte in the target buffer is returned. If no match is found,\r
+ then NULL is returned. If Length is 0, then NULL is returned.\r
+ \r
+ If Length > 0 and Buffer is NULL, then ASSERT().\r
+ If Buffer is not aligned on a UINTN boundary, then ASSERT().\r
+ If Length is not aligned on a UINTN boundary, then ASSERT().\r
+ If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
+\r
+ @param Buffer The pointer to the target buffer to scan.\r
+ @param Length The number of bytes in Buffer to scan.\r
+ @param Value The value to search for in the target buffer.\r
+\r
+ @return A pointer to the matching byte in the target buffer, otherwise NULL.\r
+\r
+**/\r
+VOID *\r
+EFIAPI\r
+ScanMemN (\r
+ IN CONST VOID *Buffer,\r
+ IN UINTN Length,\r
+ IN UINTN Value\r
+ );\r
+ \r
/**\r
Copies a source GUID to a destination GUID.\r
\r
This function copies the contents of the 128-bit GUID specified by SourceGuid to\r
DestinationGuid, and returns DestinationGuid.\r
+ \r
If DestinationGuid is NULL, then ASSERT().\r
If SourceGuid is NULL, then ASSERT().\r
\r
- @param DestinationGuid Pointer to the destination GUID.\r
- @param SourceGuid Pointer to the source GUID.\r
+ @param DestinationGuid The pointer to the destination GUID.\r
+ @param SourceGuid The pointer to the source GUID.\r
\r
@return DestinationGuid.\r
\r
\r
This function compares Guid1 to Guid2. If the GUIDs are identical then TRUE is returned.\r
If there are any bit differences in the two GUIDs, then FALSE is returned.\r
+ \r
If Guid1 is NULL, then ASSERT().\r
If Guid2 is NULL, then ASSERT().\r
\r
GUID value that matches Guid. If a match is found, then a pointer to the matching\r
GUID in the target buffer is returned. If no match is found, then NULL is returned.\r
If Length is 0, then NULL is returned.\r
+ \r
If Length > 0 and 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 128-bit boundary, then ASSERT().\r
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
\r
- @param Buffer Pointer to the target buffer to scan.\r
- @param Length Number of bytes in Buffer to scan.\r
- @param Guid Value to search for in the target buffer.\r
+ @param Buffer The pointer to the target buffer to scan.\r
+ @param Length The number of bytes in Buffer to scan.\r
+ @param Guid The value to search for in the target buffer.\r
\r
- @return A pointer to the matching Guid in the target buffer or NULL otherwise.\r
+ @return A pointer to the matching Guid in the target buffer, otherwise NULL.\r
\r
**/\r
VOID *\r
IN CONST GUID *Guid\r
);\r
\r
+/**\r
+ Checks if the given GUID is a zero GUID.\r
+\r
+ This function checks whether the given GUID is a zero GUID. If the GUID is\r
+ identical to a zero GUID then TRUE is returned. Otherwise, FALSE is returned.\r
+\r
+ If Guid is NULL, then ASSERT().\r
+\r
+ @param Guid The pointer to a 128 bit GUID.\r
+\r
+ @retval TRUE Guid is a zero GUID.\r
+ @retval FALSE Guid is not a zero GUID.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+IsZeroGuid (\r
+ IN CONST GUID *Guid\r
+ );\r
+\r
+/**\r
+ Checks if the contents of a buffer are all zeros.\r
+\r
+ This function checks whether the contents of a buffer are all zeros. If the\r
+ contents are all zeros, return TRUE. Otherwise, return FALSE.\r
+\r
+ If Length > 0 and Buffer is NULL, then ASSERT().\r
+ If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
+\r
+ @param Buffer The pointer to the buffer to be checked.\r
+ @param Length The size of the buffer (in bytes) to be checked.\r
+\r
+ @retval TRUE Contents of the buffer are all zeros.\r
+ @retval FALSE Contents of the buffer are not all zeros.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+IsZeroBuffer (\r
+ IN CONST VOID *Buffer,\r
+ IN UINTN Length\r
+ );\r
+\r
#endif\r
projects / mirror_edk2.git / blobdiff