FpgaManager
Software API Documentation
|
Provides a MmAccess interface with an offset More...
Public Member Functions | |
RegisterBank (UInt32 registerOffset, IMmAccess mm) | |
Constructs a Register Bank More... | |
RegisterBank (UInt32 registerOffset, RegisterBank rb) | |
Constructs a cascaded Register Bank More... | |
void | ReadContiguous (uint startAddress, byte[] buffer, int offset, int length) |
Reads consecutive bytes from mapped memory/registers More... | |
void | ReadContiguous (uint startAddress, byte[] buffer) |
Reads consecutive bytes from mapped memory/registers More... | |
Task< AsyncMmTransferResult< byte > > | ReadContiguousAsync (uint startAddress, byte[] buffer, int offset, int length) |
Reads consecutive bytes from mapped memory/registers asynchronously (non-blocking) More... | |
void | ReadMailbox (uint address, byte[] buffer, int offset, int length) |
Reads multiple words from a single address location More... | |
void | ReadMailbox (uint address, uint[] buffer) |
Reads multiple words from a single address location More... | |
Task< AsyncMmTransferResult< byte > > | ReadMailboxAsync (uint address, byte[] buffer, int offset, int length) |
Reads multiple words from a single address location asynchronously (non-blocking) More... | |
Task< AsyncMmTransferResult< uint > > | ReadMailboxAsync (uint address, uint[] buffer) |
Reads multiple words from a single address location asynchronously (non-blocking) More... | |
uint | ReadRegister (uint address) |
Reads from a single register More... | |
Task< UInt32 > | ReadRegisterAsync (UInt32 address) |
Reads from a single register asynchronously (non-blocking) More... | |
void | WriteContiguous (uint startAddress, byte[] buffer, int offset, int length) |
Writes consecutive bytes to mapped memory/registers More... | |
void | WriteContiguous (uint startAddress, byte[] buffer) |
Writes consecutive bytes to mapped memory/registers More... | |
Task< AsyncMmTransferResult< byte > > | WriteContiguousAsync (uint startAddress, byte[] buffer, int offset, int length) |
Writes consecutive bytes to mapped memory/registers asynchronously (non-blocking) More... | |
void | WriteMailbox (uint address, byte[] buffer, int offset, int length) |
Writes multiple words to a single address location More... | |
void | WriteMailbox (uint address, uint[] buffer) |
Writes multiple words to a single address location More... | |
Task< AsyncMmTransferResult< byte > > | WriteMailboxAsync (uint address, byte[] buffer, int offset, int length) |
Writes multiple words to a single address location asynchronously (non-blocking) More... | |
Task< AsyncMmTransferResult< uint > > | WriteMailboxAsync (uint address, uint[] buffer) |
Writes multiple words to a single address location asynchronously (non-blocking) More... | |
void | WriteRegister (uint address, uint value) |
Writes to a single register More... | |
Task | WriteRegisterAsync (UInt32 address, UInt32 value) |
Writes to a single register asynchronously (non-blocking) More... | |
void | ReadContiguous (UInt32 startAddress, Span< byte > buffer) |
Reads consecutive bytes from mapped memory/registers More... | |
void | ReadContiguous (UInt32 startAddress, Memory< byte > buffer) |
Reads consecutive bytes from mapped memory/registers More... | |
Task< AsyncMmMemRdTransferResult< byte > > | ReadContiguousAsync (UInt32 startAddress, Memory< byte > buffer) |
Reads consecutive bytes from mapped memory/registers asynchronously (non-blocking) More... | |
void | ReadMailbox (UInt32 address, Span< UInt32 > buffer) |
Reads multiple words from a single address location More... | |
void | ReadMailbox (UInt32 address, Memory< UInt32 > buffer) |
Reads multiple words from a single address location More... | |
Task< AsyncMmMemRdTransferResult< UInt32 > > | ReadMailboxAsync (UInt32 address, Memory< UInt32 > buffer) |
Reads multiple words from a single address location asynchronously (non-blocking) More... | |
void | WriteContiguous (UInt32 startAddress, ReadOnlySpan< byte > buffer) |
Writes consecutive bytes to mapped memory/registers More... | |
void | WriteContiguous (UInt32 startAddress, ReadOnlyMemory< byte > buffer) |
Writes consecutive bytes to mapped memory/registers More... | |
Task< AsyncMmMemWrTransferResult< byte > > | WriteContiguousAsync (UInt32 startAddress, ReadOnlyMemory< byte > buffer) |
Writes consecutive bytes to mapped memory/registers asynchronously (non-blocking) More... | |
void | WriteMailbox (UInt32 address, ReadOnlySpan< UInt32 > buffer) |
Writes multiple words to a single address location More... | |
void | WriteMailbox (UInt32 address, ReadOnlyMemory< UInt32 > buffer) |
Writes multiple words to a single address location More... | |
Task< AsyncMmMemWrTransferResult< UInt32 > > | WriteMailboxAsync (UInt32 address, ReadOnlyMemory< UInt32 > buffer) |
Writes multiple words to a single address location asynchronously (non-blocking) More... | |
Public Member Functions inherited from IMmAccess | |
UInt32 | ReadRegister (UInt32 address) |
Reads from a single register More... | |
void | WriteRegister (UInt32 address, UInt32 value) |
Writes to a single register More... | |
void | ReadContiguous (UInt32 startAddress, byte[] buffer, int offset, int length) |
Reads consecutive bytes from mapped memory/registers More... | |
void | ReadContiguous (UInt32 startAddress, byte[] buffer) |
Reads consecutive bytes from mapped memory/registers More... | |
void | WriteContiguous (UInt32 startAddress, byte[] buffer, int offset, int length) |
Writes consecutive bytes to mapped memory/registers More... | |
void | WriteContiguous (UInt32 startAddress, byte[] buffer) |
Writes consecutive bytes to mapped memory/registers More... | |
Task< AsyncMmTransferResult< byte > > | ReadContiguousAsync (UInt32 startAddress, byte[] buffer, int offset, int length) |
Reads consecutive bytes from mapped memory/registers asynchronously (non-blocking) More... | |
Task< AsyncMmTransferResult< byte > > | WriteContiguousAsync (UInt32 startAddress, byte[] buffer, int offset, int length) |
Writes consecutive bytes to mapped memory/registers asynchronously (non-blocking) More... | |
void | ReadMailbox (UInt32 address, byte[] buffer, int offset, int length) |
Reads multiple words from a single address location More... | |
void | ReadMailbox (UInt32 address, UInt32[] buffer) |
Reads multiple words from a single address location More... | |
void | WriteMailbox (UInt32 address, byte[] buffer, int offset, int length) |
Writes multiple words to a single address location More... | |
void | WriteMailbox (UInt32 address, UInt32[] buffer) |
Writes multiple words to a single address location More... | |
Task< AsyncMmTransferResult< byte > > | ReadMailboxAsync (UInt32 address, byte[] buffer, int offset, int length) |
Reads multiple words from a single address location asynchronously (non-blocking) More... | |
Task< AsyncMmTransferResult< UInt32 > > | ReadMailboxAsync (UInt32 address, UInt32[] buffer) |
Reads multiple words from a single address location asynchronously (non-blocking) More... | |
Task< AsyncMmTransferResult< byte > > | WriteMailboxAsync (UInt32 address, byte[] buffer, int offset, int length) |
Writes multiple words to a single address location asynchronously (non-blocking) More... | |
Task< AsyncMmTransferResult< UInt32 > > | WriteMailboxAsync (UInt32 address, UInt32[] buffer) |
Writes multiple words to a single address location asynchronously (non-blocking) More... | |
Provides a MmAccess interface with an offset
See IMmAccess for interface details, and RegisterBank Example on how to use RegisterBank in a project.
|
inline |
Constructs a Register Bank
registerOffset | Offset of the register bank in memory space |
mm | memory mapped interface for register access |
|
inline |
Constructs a cascaded Register Bank
registerOffset | Offset of the register bank in parent register bank space |
rb | parent register bank |
void ReadContiguous | ( | uint | startAddress, |
byte [] | buffer, | ||
int | offset, | ||
int | length | ||
) |
Reads consecutive bytes from mapped memory/registers
startAddress | Start address of transfer |
buffer | Buffer where the data is copied to |
offset | Start offset within buffer |
length | Length of transfer in bytes |
void ReadContiguous | ( | uint | startAddress, |
byte [] | buffer | ||
) |
Reads consecutive bytes from mapped memory/registers
startAddress | Start address of transfer |
buffer | Buffer where the data is copied to |
void ReadContiguous | ( | UInt32 | startAddress, |
Span< byte > | buffer | ||
) |
Reads consecutive bytes from mapped memory/registers
requires .NET standard 2.1
startAddress | Start address of transfer |
buffer | Buffer where the data is copied to |
Implements IMmAccess.
void ReadContiguous | ( | UInt32 | startAddress, |
Memory< byte > | buffer | ||
) |
Reads consecutive bytes from mapped memory/registers
requires .NET standard 2.1
startAddress | Start address of transfer |
buffer | Buffer where the data is copied to |
Implements IMmAccess.
Task<AsyncMmTransferResult<byte> > ReadContiguousAsync | ( | uint | startAddress, |
byte [] | buffer, | ||
int | offset, | ||
int | length | ||
) |
Reads consecutive bytes from mapped memory/registers asynchronously (non-blocking)
startAddress | Start address of transfer |
buffer | Buffer where the data is copied to |
offset | Start offset within buffer |
length | Length of transfer in bytes |
Task<AsyncMmMemRdTransferResult<byte> > ReadContiguousAsync | ( | UInt32 | startAddress, |
Memory< byte > | buffer | ||
) |
Reads consecutive bytes from mapped memory/registers asynchronously (non-blocking)
requires .NET standard 2.1
startAddress | Start address of transfer |
buffer | Buffer where the data is copied to |
Implements IMmAccess.
void ReadMailbox | ( | uint | address, |
byte [] | buffer, | ||
int | offset, | ||
int | length | ||
) |
Reads multiple words from a single address location
address | Address of transfer |
buffer | Buffer where the data is copied to |
offset | Start offset within buffer |
length | Length of transfer in bytes |
void ReadMailbox | ( | uint | address, |
uint [] | buffer | ||
) |
Reads multiple words from a single address location
address | Address of transfer |
buffer | Buffer where the data is copied to |
void ReadMailbox | ( | UInt32 | address, |
Span< UInt32 > | buffer | ||
) |
Reads multiple words from a single address location
requires .NET standard 2.1
address | Address of transfer |
buffer | Buffer where the data is copied to |
Implements IMmAccess.
void ReadMailbox | ( | UInt32 | address, |
Memory< UInt32 > | buffer | ||
) |
Reads multiple words from a single address location
requires .NET standard 2.1
address | Address of transfer |
buffer | Buffer where the data is copied to |
Implements IMmAccess.
Task<AsyncMmTransferResult<byte> > ReadMailboxAsync | ( | uint | address, |
byte [] | buffer, | ||
int | offset, | ||
int | length | ||
) |
Reads multiple words from a single address location asynchronously (non-blocking)
address | Address of transfer |
buffer | Buffer where the data is copied to |
offset | Start offset within buffer |
length | Length of transfer in bytes |
Task<AsyncMmTransferResult<uint> > ReadMailboxAsync | ( | uint | address, |
uint [] | buffer | ||
) |
Reads multiple words from a single address location asynchronously (non-blocking)
address | Address of transfer |
buffer |
Task<AsyncMmMemRdTransferResult<UInt32> > ReadMailboxAsync | ( | UInt32 | address, |
Memory< UInt32 > | buffer | ||
) |
Reads multiple words from a single address location asynchronously (non-blocking)
requires .NET standard 2.1
address | Address of transfer |
buffer |
Implements IMmAccess.
uint ReadRegister | ( | uint | address | ) |
Reads from a single register
address | Register address |
Task<UInt32> ReadRegisterAsync | ( | UInt32 | address | ) |
Reads from a single register asynchronously (non-blocking)
address | Register address |
Implements IMmAccess.
void WriteContiguous | ( | uint | startAddress, |
byte [] | buffer, | ||
int | offset, | ||
int | length | ||
) |
Writes consecutive bytes to mapped memory/registers
startAddress | Start address of transfer |
buffer | Buffer where the data is copied from |
offset | Start offset within buffer |
length | Length of transfer in bytes |
void WriteContiguous | ( | uint | startAddress, |
byte [] | buffer | ||
) |
Writes consecutive bytes to mapped memory/registers
startAddress | Start address of transfer |
buffer | Buffer where the data is copied from |
void WriteContiguous | ( | UInt32 | startAddress, |
ReadOnlySpan< byte > | buffer | ||
) |
Writes consecutive bytes to mapped memory/registers
requires .NET standard 2.1
startAddress | Start address of transfer |
buffer | Buffer where the data is copied from |
Implements IMmAccess.
void WriteContiguous | ( | UInt32 | startAddress, |
ReadOnlyMemory< byte > | buffer | ||
) |
Writes consecutive bytes to mapped memory/registers
requires .NET standard 2.1
startAddress | Start address of transfer |
buffer | Buffer where the data is copied from |
Implements IMmAccess.
Task<AsyncMmTransferResult<byte> > WriteContiguousAsync | ( | uint | startAddress, |
byte [] | buffer, | ||
int | offset, | ||
int | length | ||
) |
Writes consecutive bytes to mapped memory/registers asynchronously (non-blocking)
startAddress | Start address of transfer |
buffer | Buffer where the data is copied from |
offset | Start offset within buffer |
length | Length of transfer in bytes |
Task<AsyncMmMemWrTransferResult<byte> > WriteContiguousAsync | ( | UInt32 | startAddress, |
ReadOnlyMemory< byte > | buffer | ||
) |
Writes consecutive bytes to mapped memory/registers asynchronously (non-blocking)
requires .NET standard 2.1
startAddress | Start address of transfer |
buffer | Buffer where the data is copied from |
Implements IMmAccess.
void WriteMailbox | ( | uint | address, |
byte [] | buffer, | ||
int | offset, | ||
int | length | ||
) |
Writes multiple words to a single address location
address | Address of transfer |
buffer | Buffer where the data is copied from |
offset | Start offset within buffer |
length | Length of transfer in bytes |
void WriteMailbox | ( | uint | address, |
uint [] | buffer | ||
) |
Writes multiple words to a single address location
address | Address of transfer |
buffer | Buffer where the data is copied from |
void WriteMailbox | ( | UInt32 | address, |
ReadOnlySpan< UInt32 > | buffer | ||
) |
Writes multiple words to a single address location
requires .NET standard 2.1
address | Address of transfer |
buffer | Buffer where the data is copied from |
Implements IMmAccess.
void WriteMailbox | ( | UInt32 | address, |
ReadOnlyMemory< UInt32 > | buffer | ||
) |
Writes multiple words to a single address location
requires .NET standard 2.1
address | Address of transfer |
buffer | Buffer where the data is copied from |
Implements IMmAccess.
Task<AsyncMmTransferResult<byte> > WriteMailboxAsync | ( | uint | address, |
byte [] | buffer, | ||
int | offset, | ||
int | length | ||
) |
Writes multiple words to a single address location asynchronously (non-blocking)
address | Address of transfer |
buffer | Buffer where the data is copied from |
offset | Start offset within buffer |
length | Length of transfer in bytes |
Task<AsyncMmTransferResult<uint> > WriteMailboxAsync | ( | uint | address, |
uint [] | buffer | ||
) |
Writes multiple words to a single address location asynchronously (non-blocking)
address | Address of transfer |
buffer | Buffer where the data is copied from |
Task<AsyncMmMemWrTransferResult<UInt32> > WriteMailboxAsync | ( | UInt32 | address, |
ReadOnlyMemory< UInt32 > | buffer | ||
) |
Writes multiple words to a single address location asynchronously (non-blocking)
requires .NET standard 2.1
address | Address of transfer |
buffer | Buffer where the data is copied from |
Implements IMmAccess.
void WriteRegister | ( | uint | address, |
uint | value | ||
) |
Writes to a single register
address | Register address |
value | Value to write |
Task WriteRegisterAsync | ( | UInt32 | address, |
UInt32 | value | ||
) |
Writes to a single register asynchronously (non-blocking)
address | Register address |
value | Value to write |
Implements IMmAccess.