FrontPanel API 6.1.0
Loading...
Searching...
No Matches
OpalKelly::FrontPanelAXIFull Class Referenceabstract

Provides AXI-Full memory-mapped read/write access to the FPGA. More...

Public Member Functions

virtual UINT8 GetDatapathWidthByteCount (void) const =0
 Returns the datapath width in bytes.
 
virtual ErrorCode Read (UINT64 address, unsigned char *pBuffer, std::size_t bufferSize, UINT32 burst, UINT32 timeoutMilliseconds, UINT64 &transferByteCount)=0
 Read data from the given address.
 
virtual ErrorCode Write (UINT64 address, const unsigned char *pData, std::size_t dataSize, UINT32 burst, UINT32 timeoutMilliseconds, okTOperationStatistics &operationStats)=0
 Write data to the given address.
 
virtual ErrorCode Reset (void)=0
 Reset the AXI-Full interface.
 
ErrorCode Read (UINT64 address, unsigned char *pBuffer, std::size_t bufferSize, UINT64 &transferByteCount)
 Read data using the default burst length and timeout.
 
ErrorCode Write (UINT64 address, const unsigned char *pData, std::size_t dataSize, okTOperationStatistics &operationStats)
 Write data using the default burst length and timeout.
 

Detailed Description

This interface provides byte-level, burst-capable access to the FPGA over the AXI-Full protocol. It supports configurable burst lengths and variable datapath widths.

An instance of this class is obtained via OpalKelly::FPGADataPortAXI::GetAXIFull().

Note
The AXI data port is available on FP-Gen3-USB devices. Such devices report okDATAPORT_AXI in okTDeviceInfo::dataport. OpalKelly::FrontPanel::GetFPGADataPortAXI() returns UnsupportedFeature on all other devices.

Copyright (c) 2005-2026 Opal Kelly Incorporated