MdePkg/Library/DxeIoLibEsal/IoLibMmioBuffer.c File Reference


Functions

UINT8 *EFIAPI MmioReadBuffer8 (IN UINTN StartAddress, IN UINTN Length, OUT UINT8 *Buffer)
UINT16 *EFIAPI MmioReadBuffer16 (IN UINTN StartAddress, IN UINTN Length, OUT UINT16 *Buffer)
UINT32 *EFIAPI MmioReadBuffer32 (IN UINTN StartAddress, IN UINTN Length, OUT UINT32 *Buffer)
UINT64 *EFIAPI MmioReadBuffer64 (IN UINTN StartAddress, IN UINTN Length, OUT UINT64 *Buffer)
UINT8 *EFIAPI MmioWriteBuffer8 (IN UINTN StartAddress, IN UINTN Length, IN CONST UINT8 *Buffer)
UINT16 *EFIAPI MmioWriteBuffer16 (IN UINTN StartAddress, IN UINTN Length, IN CONST UINT16 *Buffer)
UINT32 *EFIAPI MmioWriteBuffer32 (IN UINTN StartAddress, IN UINTN Length, IN CONST UINT32 *Buffer)
UINT64 *EFIAPI MmioWriteBuffer64 (IN UINTN StartAddress, IN UINTN Length, IN CONST UINT64 *Buffer)

Detailed Description

I/O Library MMIO Buffer Functions.

Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.
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.


Function Documentation

UINT16* EFIAPI MmioReadBuffer16 ( IN UINTN  StartAddress,
IN UINTN  Length,
OUT UINT16 Buffer 
)

Copy data from MMIO region to system memory by using 16-bit access.

Copy data from MMIO region specified by starting address StartAddress to system memory specified by Buffer by using 16-bit access. The total number of byte to be copied is specified by Length. Buffer is returned.

If StartAddress is not aligned on a 16-bit boundary, then ASSERT().

If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().

If Length is not aligned on a 16-bit boundary, then ASSERT(). If Buffer is not aligned on a 16-bit boundary, then ASSERT().

Parameters:
StartAddress Starting address for the MMIO region to be copied from.
Length Size in bytes of the copy.
Buffer Pointer to a system memory buffer receiving the data read.
Returns:
Buffer

References ASSERT, MAX_ADDRESS, and MmioRead16().

UINT32* EFIAPI MmioReadBuffer32 ( IN UINTN  StartAddress,
IN UINTN  Length,
OUT UINT32 Buffer 
)

Copy data from MMIO region to system memory by using 32-bit access.

Copy data from MMIO region specified by starting address StartAddress to system memory specified by Buffer by using 32-bit access. The total number of byte to be copied is specified by Length. Buffer is returned.

If StartAddress is not aligned on a 32-bit boundary, then ASSERT().

If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().

If Length is not aligned on a 32-bit boundary, then ASSERT(). If Buffer is not aligned on a 32-bit boundary, then ASSERT().

Parameters:
StartAddress Starting address for the MMIO region to be copied from.
Length Size in bytes of the copy.
Buffer Pointer to a system memory buffer receiving the data read.
Returns:
Buffer

References ASSERT, MAX_ADDRESS, and MmioRead32().

UINT64* EFIAPI MmioReadBuffer64 ( IN UINTN  StartAddress,
IN UINTN  Length,
OUT UINT64 Buffer 
)

Copy data from MMIO region to system memory by using 64-bit access.

Copy data from MMIO region specified by starting address StartAddress to system memory specified by Buffer by using 64-bit access. The total number of byte to be copied is specified by Length. Buffer is returned.

If StartAddress is not aligned on a 64-bit boundary, then ASSERT().

If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().

If Length is not aligned on a 64-bit boundary, then ASSERT(). If Buffer is not aligned on a 64-bit boundary, then ASSERT().

Parameters:
StartAddress Starting address for the MMIO region to be copied from.
Length Size in bytes of the copy.
Buffer Pointer to a system memory buffer receiving the data read.
Returns:
Buffer

References ASSERT, MAX_ADDRESS, and MmioRead64().

UINT8* EFIAPI MmioReadBuffer8 ( IN UINTN  StartAddress,
IN UINTN  Length,
OUT UINT8 Buffer 
)

Copy data from MMIO region to system memory by using 8-bit access.

Copy data from MMIO region specified by starting address StartAddress to system memory specified by Buffer by using 8-bit access. The total number of byte to be copied is specified by Length. Buffer is returned.

If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().

Parameters:
StartAddress Starting address for the MMIO region to be copied from.
Length Size in bytes of the copy.
Buffer Pointer to a system memory buffer receiving the data read.
Returns:
Buffer

References ASSERT, MAX_ADDRESS, and MmioRead8().

UINT16* EFIAPI MmioWriteBuffer16 ( IN UINTN  StartAddress,
IN UINTN  Length,
IN CONST UINT16 Buffer 
)

Copy data from system memory to MMIO region by using 16-bit access.

Copy data from system memory specified by Buffer to MMIO region specified by starting address StartAddress by using 16-bit access. The total number of byte to be copied is specified by Length. Buffer is returned.

If StartAddress is not aligned on a 16-bit boundary, then ASSERT().

If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS -Buffer + 1), then ASSERT().

If Length is not aligned on a 16-bit boundary, then ASSERT().

If Buffer is not aligned on a 16-bit boundary, then ASSERT().

Parameters:
StartAddress Starting address for the MMIO region to be copied to.
Length Size in bytes of the copy.
Buffer Pointer to a system memory buffer containing the data to write.
Returns:
Buffer

References ASSERT, MAX_ADDRESS, and MmioWrite16().

UINT32* EFIAPI MmioWriteBuffer32 ( IN UINTN  StartAddress,
IN UINTN  Length,
IN CONST UINT32 Buffer 
)

Copy data from system memory to MMIO region by using 32-bit access.

Copy data from system memory specified by Buffer to MMIO region specified by starting address StartAddress by using 32-bit access. The total number of byte to be copied is specified by Length. Buffer is returned.

If StartAddress is not aligned on a 32-bit boundary, then ASSERT().

If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS -Buffer + 1), then ASSERT().

If Length is not aligned on a 32-bit boundary, then ASSERT().

If Buffer is not aligned on a 32-bit boundary, then ASSERT().

Parameters:
StartAddress Starting address for the MMIO region to be copied to.
Length Size in bytes of the copy.
Buffer Pointer to a system memory buffer containing the data to write.
Returns:
Buffer

References ASSERT, MAX_ADDRESS, and MmioWrite32().

UINT64* EFIAPI MmioWriteBuffer64 ( IN UINTN  StartAddress,
IN UINTN  Length,
IN CONST UINT64 Buffer 
)

Copy data from system memory to MMIO region by using 64-bit access.

Copy data from system memory specified by Buffer to MMIO region specified by starting address StartAddress by using 64-bit access. The total number of byte to be copied is specified by Length. Buffer is returned.

If StartAddress is not aligned on a 64-bit boundary, then ASSERT().

If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS -Buffer + 1), then ASSERT().

If Length is not aligned on a 64-bit boundary, then ASSERT().

If Buffer is not aligned on a 64-bit boundary, then ASSERT().

Parameters:
StartAddress Starting address for the MMIO region to be copied to.
Length Size in bytes of the copy.
Buffer Pointer to a system memory buffer containing the data to write.
Returns:
Buffer

References ASSERT, MAX_ADDRESS, and MmioWrite64().

UINT8* EFIAPI MmioWriteBuffer8 ( IN UINTN  StartAddress,
IN UINTN  Length,
IN CONST UINT8 Buffer 
)

Copy data from system memory to MMIO region by using 8-bit access.

Copy data from system memory specified by Buffer to MMIO region specified by starting address StartAddress by using 8-bit access. The total number of byte to be copied is specified by Length. Buffer is returned.

If Length is greater than (MAX_ADDRESS - StartAddress + 1), then ASSERT(). If Length is greater than (MAX_ADDRESS -Buffer + 1), then ASSERT().

Parameters:
StartAddress Starting address for the MMIO region to be copied to.
Length Size in bytes of the copy.
Buffer Pointer to a system memory buffer containing the data to write.
Returns:
Buffer

References ASSERT, MAX_ADDRESS, MmioWrite8(), and VOID.


Generated on Thu Sep 24 23:14:22 2015 for MdePkg[ALL] by  doxygen 1.5.7.1