text: /*++
  
  Copyright (c) 2004 - 2006, Intel Corporation. All rights reserved.<BR>
  This program and the accompanying materials                          
  are licensed and made available under the terms and conditions of the BSD License         
  which accompanies this distribution.  The full text of the license may be found at        
  http://opensource.org/licenses/bsd-license.php                                            
                                                                                            
  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:
  
    BaseMemoryLibInternals.h
    
  Abstract: 
  
    Header file for Base Memory Library.
    
  --*/
  
  #ifndef __BASEMEMORY_LIB_INTERNALS_H__
  #define __BASEMEMORY_LIB_INTERNALS_H__
  
  #include "EdkIIGlueBase.h"
  /**
    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
  
    @return Destination
  
  **/
  VOID *
  EFIAPI
  InternalMemCopyMem (
    OUT     VOID                      *DestinationBuffer,
    IN      CONST VOID                *SourceBuffer,
    IN      UINTN                     Length
    );
  
  /**
    Set Buffer to Value for Size bytes.
  
    @param  Buffer Memory to set.
    @param  Size Number of bytes to set
    @param  Value Value of the set operation.
  
    @return Buffer
  
  **/
  VOID *
  EFIAPI
  InternalMemSetMem (
    OUT     VOID                      *Buffer,
    IN      UINTN                     Length,
    IN      UINT8                     Value
    );
  
  /**
    Fills a target buffer with a 16-bit value, and returns the target buffer.
  
    @param  Buffer  Pointer to the target buffer to fill.
    @param  Length  Number of bytes in Buffer to fill.
    @param  Value   Value with which to fill Length bytes of Buffer.
  
    @return Buffer
  
  **/
  VOID *
  EFIAPI
  InternalMemSetMem16 (
    OUT     VOID                      *Buffer,
    IN      UINTN                     Length,
    IN      UINT16                    Value
    );
  
  /**
    Fills a target buffer with a 32-bit value, and returns the target buffer.
  
    @param  Buffer  Pointer to the target buffer to fill.
    @param  Length  Number of bytes in Buffer to fill.
    @param  Value   Value with which to fill Length bytes of Buffer.
  
    @return Buffer
  
  **/
  VOID *
  EFIAPI
  InternalMemSetMem32 (
    OUT     VOID                      *Buffer,
    IN      UINTN                     Length,
    IN      UINT32                    Value
    );
  
  /**
    Fills a target buffer with a 64-bit value, and returns the target buffer.
  
    @param  Buffer  Pointer to the target buffer to fill.
    @param  Length  Number of bytes in Buffer to fill.
    @param  Value   Value with which to fill Length bytes of Buffer.
  
    @return Buffer
  
  **/
  VOID *
  EFIAPI
  InternalMemSetMem64 (
    OUT     VOID                      *Buffer,
    IN      UINTN                     Length,
    IN      UINT64                    Value
    );
  
  /**
    Set Buffer to 0 for Size bytes.
  
    @param  Buffer Memory to set.
    @param  Size Number of bytes to set
  
    @return Buffer
  
  **/
  VOID *
  EFIAPI
  InternalMemZeroMem (
    OUT     VOID                      *Buffer,
    IN      UINTN                     Length
    );
  
  /**
    Compares two memory buffers of a given length.
  
    @param  DestinationBuffer First memory buffer
    @param  SourceBuffer      Second memory buffer
    @param  Length            Length of DestinationBuffer and SourceBuffer memory
                              regions to compare. Must be non-zero.
  
    @retval 0     if MemOne == MemTwo
  
  **/
  INTN
  EFIAPI
  InternalMemCompareMem (
    IN      CONST VOID                *DestinationBuffer,
    IN      CONST VOID                *SourceBuffer,
    IN      UINTN                     Length
    );
  
  /**
    Scans a target buffer for an 8-bit value, and returns a pointer to the
    matching 8-bit value in the target buffer.
  
    @param  Buffer  Pointer to the target buffer to scan.
    @param  Length  Number of bytes in Buffer to scan. Must be non-zero.
    @param  Value   Value to search for in the target buffer.
  
    @return Pointer to the first occurrence or NULL if not found.
  
  **/
  CONST VOID *
  EFIAPI
  InternalMemScanMem8 (
    IN      CONST VOID                *Buffer,
    IN      UINTN                     Length,
    IN      UINT8                     Value
    );
  
  /**
    Scans a target buffer for a 16-bit value, and returns a pointer to the
    matching 16-bit value in the target buffer.
  
    @param  Buffer  Pointer to the target buffer to scan.
    @param  Length  Number of bytes in Buffer to scan. Must be non-zero.
    @param  Value   Value to search for in the target buffer.
  
    @return Pointer to the first occurrence or NULL if not found.
  
  **/
  CONST VOID *
  EFIAPI
  InternalMemScanMem16 (
    IN      CONST VOID                *Buffer,
    IN      UINTN                     Length,
    IN      UINT16                    Value
    );
  
  /**
    Scans a target buffer for a 32-bit value, and returns a pointer to the
    matching 32-bit value in the target buffer.
  
    @param  Buffer  Pointer to the target buffer to scan.
    @param  Length  Number of bytes in Buffer to scan. Must be non-zero.
    @param  Value   Value to search for in the target buffer.
  
    @return Pointer to the first occurrence or NULL if not found.
  
  **/
  CONST VOID *
  EFIAPI
  InternalMemScanMem32 (
    IN      CONST VOID                *Buffer,
    IN      UINTN                     Length,
    IN      UINT32                    Value
    );
  
  /**
    Scans a target buffer for a 64-bit value, and returns a pointer to the
    matching 64-bit value in the target buffer.
  
    @param  Buffer  Pointer to the target buffer to scan.
    @param  Length  Number of bytes in Buffer to scan. Must be non-zero.
    @param  Value   Value to search for in the target buffer.
  
    @return Pointer to the first occurrence or NULL if not found.
  
  **/
  CONST VOID *
  EFIAPI
  InternalMemScanMem64 (
    IN      CONST VOID                *Buffer,
    IN      UINTN                     Length,
    IN      UINT64                    Value
    );
  
  #endif
  