IMmAccess Interface Reference

Provides access to a FPGA Manager MmAccess API Block More...

Inheritance diagram for IMmAccess:

Public Member Functions
UInt32	ReadRegister (UInt32 address)
	Reads from a single register More...
Task< UInt32 >	ReadRegisterAsync (UInt32 address)
	Reads from a single register asynchronously (non-blocking) More...
void	WriteRegister (UInt32 address, UInt32 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, 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...
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...

Detailed Description

Provides access to a FPGA Manager MmAccess API Block

Member Function Documentation

ReadContiguous() [1/4]

void ReadContiguous	(	UInt32	startAddress,
		byte []	buffer,
		int	offset,
		int	length
	)

Reads consecutive bytes from mapped memory/registers

Parameters

startAddress	Start address of transfer
buffer	Buffer where the data is copied to
offset	Start offset within buffer
length	Length of transfer in bytes

ReadContiguous() [2/4]

void ReadContiguous	(	UInt32	startAddress,
		byte []	buffer
	)

Reads consecutive bytes from mapped memory/registers

Parameters

startAddress	Start address of transfer
buffer	Buffer where the data is copied to

ReadContiguous() [3/4]

void ReadContiguous	(	UInt32	startAddress,
		Span< byte >	buffer
	)

Reads consecutive bytes from mapped memory/registers

requires .NET standard 2.1

Parameters

startAddress	Start address of transfer
buffer	Buffer where the data is copied to

Implemented in RegisterBank.

ReadContiguous() [4/4]

void ReadContiguous	(	UInt32	startAddress,
		Memory< byte >	buffer
	)

Reads consecutive bytes from mapped memory/registers

requires .NET standard 2.1

Parameters

startAddress	Start address of transfer
buffer	Buffer where the data is copied to

Implemented in RegisterBank.

ReadContiguousAsync() [1/2]

Task<AsyncMmTransferResult<byte> > ReadContiguousAsync	(	UInt32	startAddress,
		byte []	buffer,
		int	offset,
		int	length
	)

Reads consecutive bytes from mapped memory/registers asynchronously (non-blocking)

Parameters

startAddress	Start address of transfer
buffer	Buffer where the data is copied to
offset	Start offset within buffer
length	Length of transfer in bytes

Returns

TAP Task

ReadContiguousAsync() [2/2]

Task<AsyncMmMemRdTransferResult<byte> > ReadContiguousAsync	(	UInt32	startAddress,
		Memory< byte >	buffer
	)

Reads consecutive bytes from mapped memory/registers asynchronously (non-blocking)

requires .NET standard 2.1

Parameters

startAddress	Start address of transfer
buffer	Buffer where the data is copied to

Returns

TAP Task

Implemented in RegisterBank.

ReadMailbox() [1/4]

void ReadMailbox	(	UInt32	address,
		byte []	buffer,
		int	offset,
		int	length
	)

Reads multiple words from a single address location

Parameters

address	Address of transfer
buffer	Buffer where the data is copied to
offset	Start offset within buffer
length	Length of transfer in bytes

ReadMailbox() [2/4]

void ReadMailbox	(	UInt32	address,
		UInt32 []	buffer
	)

Reads multiple words from a single address location

Parameters

address	Address of transfer
buffer	Buffer where the data is copied to

ReadMailbox() [3/4]

void ReadMailbox	(	UInt32	address,
		Span< UInt32 >	buffer
	)

Reads multiple words from a single address location

requires .NET standard 2.1

Parameters

address	Address of transfer
buffer	Buffer where the data is copied to

Implemented in RegisterBank.

ReadMailbox() [4/4]

void ReadMailbox	(	UInt32	address,
		Memory< UInt32 >	buffer
	)

Reads multiple words from a single address location

requires .NET standard 2.1

Parameters

address	Address of transfer
buffer	Buffer where the data is copied to

Implemented in RegisterBank.

ReadMailboxAsync() [1/3]

Task<AsyncMmTransferResult<byte> > ReadMailboxAsync	(	UInt32	address,
		byte []	buffer,
		int	offset,
		int	length
	)

Reads multiple words from a single address location asynchronously (non-blocking)

Parameters

address	Address of transfer
buffer	Buffer where the data is copied to
offset	Start offset within buffer
length	Length of transfer in bytes

Returns

TAP Task

ReadMailboxAsync() [2/3]

Task<AsyncMmTransferResult<UInt32> > ReadMailboxAsync	(	UInt32	address,
		UInt32 []	buffer
	)

Reads multiple words from a single address location asynchronously (non-blocking)

Parameters

address	Address of transfer
buffer

Returns

TAP Task

ReadMailboxAsync() [3/3]

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

Parameters

address	Address of transfer
buffer

Returns

TAP Task

Implemented in RegisterBank.

ReadRegister()

UInt32 ReadRegister

(

UInt32

address

)

Reads from a single register

Parameters

address

Register address

Returns

Read value of the addressed register

ReadRegisterAsync()

Task<UInt32> ReadRegisterAsync

(

UInt32

address

)

Reads from a single register asynchronously (non-blocking)

Parameters

address

Register address

Returns

TAP Task

Implemented in RegisterBank.

WriteContiguous() [1/4]

void WriteContiguous	(	UInt32	startAddress,
		byte []	buffer,
		int	offset,
		int	length
	)

Writes consecutive bytes to mapped memory/registers

Parameters

startAddress	Start address of transfer
buffer	Buffer where the data is copied from
offset	Start offset within buffer
length	Length of transfer in bytes

WriteContiguous() [2/4]

void WriteContiguous	(	UInt32	startAddress,
		byte []	buffer
	)

Writes consecutive bytes to mapped memory/registers

Parameters

startAddress	Start address of transfer
buffer	Buffer where the data is copied from

WriteContiguous() [3/4]

void WriteContiguous	(	UInt32	startAddress,
		ReadOnlySpan< byte >	buffer
	)

Writes consecutive bytes to mapped memory/registers

requires .NET standard 2.1

Parameters

startAddress	Start address of transfer
buffer	Buffer where the data is copied from

Implemented in RegisterBank.

WriteContiguous() [4/4]

void WriteContiguous	(	UInt32	startAddress,
		ReadOnlyMemory< byte >	buffer
	)

Writes consecutive bytes to mapped memory/registers

requires .NET standard 2.1

Parameters

startAddress	Start address of transfer
buffer	Buffer where the data is copied from

Implemented in RegisterBank.

WriteContiguousAsync() [1/2]

Task<AsyncMmTransferResult<byte> > WriteContiguousAsync	(	UInt32	startAddress,
		byte []	buffer,
		int	offset,
		int	length
	)

Writes consecutive bytes to mapped memory/registers asynchronously (non-blocking)

Parameters

startAddress	Start address of transfer
buffer	Buffer where the data is copied from
offset	Start offset within buffer
length	Length of transfer in bytes

Returns

TAP Task

WriteContiguousAsync() [2/2]

Task<AsyncMmMemWrTransferResult<byte> > WriteContiguousAsync	(	UInt32	startAddress,
		ReadOnlyMemory< byte >	buffer
	)

Writes consecutive bytes to mapped memory/registers asynchronously (non-blocking)

requires .NET standard 2.1

Parameters

startAddress	Start address of transfer
buffer	Buffer where the data is copied from

Returns

TAP Task

Implemented in RegisterBank.

WriteMailbox() [1/4]

void WriteMailbox	(	UInt32	address,
		byte []	buffer,
		int	offset,
		int	length
	)

Writes multiple words to a single address location

Parameters

address	Address of transfer
buffer	Buffer where the data is copied from
offset	Start offset within buffer
length	Length of transfer in bytes

WriteMailbox() [2/4]

void WriteMailbox	(	UInt32	address,
		UInt32 []	buffer
	)

Writes multiple words to a single address location

Parameters

address	Address of transfer
buffer	Buffer where the data is copied from

WriteMailbox() [3/4]

void WriteMailbox	(	UInt32	address,
		ReadOnlySpan< UInt32 >	buffer
	)

Writes multiple words to a single address location

requires .NET standard 2.1

Parameters

address	Address of transfer
buffer	Buffer where the data is copied from

Implemented in RegisterBank.

WriteMailbox() [4/4]

void WriteMailbox	(	UInt32	address,
		ReadOnlyMemory< UInt32 >	buffer
	)

Writes multiple words to a single address location

requires .NET standard 2.1

Parameters

address	Address of transfer
buffer	Buffer where the data is copied from

Implemented in RegisterBank.

WriteMailboxAsync() [1/3]

Task<AsyncMmTransferResult<byte> > WriteMailboxAsync	(	UInt32	address,
		byte []	buffer,
		int	offset,
		int	length
	)

Writes multiple words to a single address location asynchronously (non-blocking)

Parameters

address	Address of transfer
buffer	Buffer where the data is copied from
offset	Start offset within buffer
length	Length of transfer in bytes

Returns

TAP Task

WriteMailboxAsync() [2/3]

Task<AsyncMmTransferResult<UInt32> > WriteMailboxAsync	(	UInt32	address,
		UInt32 []	buffer
	)

Writes multiple words to a single address location asynchronously (non-blocking)

Parameters

address	Address of transfer
buffer	Buffer where the data is copied from

Returns

TAP Task

WriteMailboxAsync() [3/3]

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

Parameters

address	Address of transfer
buffer	Buffer where the data is copied from

Returns

TAP Task

Implemented in RegisterBank.

WriteRegister()

void WriteRegister	(	UInt32	address,
		UInt32	value
	)

Writes to a single register

Parameters

address	Register address
value	Value to write

WriteRegisterAsync()

Task WriteRegisterAsync	(	UInt32	address,
		UInt32	value
	)

Writes to a single register asynchronously (non-blocking)

Parameters

address	Register address
value	Value to write

Returns

TAP Task

Implemented in RegisterBank.

---

The documentation for this interface was generated from the following file:

• C:/Git/Ip/en_mgr_sw/Projects/Win7/CsApi/IMmAccess.cs