FpgaManager
Software API Documentation
Enclustra.FPGAManager Namespace Reference

Namespaces

Classes

class  ApiDetails
 Details of the current API More...
 
struct  ApiUrl
 FPGA Manager device URL More...
 
struct  AsyncMmMemRdTransferResult
 Result of an asynchronous memory mapped transaction More...
 
struct  AsyncMmMemWrTransferResult
 Result of an asynchronous memory mapped transaction More...
 
struct  AsyncMmTransferResult
 Result of an asynchronous memory mapped transaction More...
 
struct  AsyncStreamMemRdTransferResult
 Result of an asynchronous stream transaction More...
 
struct  AsyncStreamMemWrTransferResult
 Result of an asynchronous stream transaction More...
 
struct  AsyncStreamPtrTransferResult
 Result of an asynchronous stream transaction More...
 
struct  AsyncStreamTransferResult
 Result of an asynchronous stream transaction More...
 
class  FpgaManagerApi
 FPGA Manager API More...
 
interface  IFpgaManager
 Provides access to the FPGA Manager API More...
 
interface  IMmAccess
 Provides access to a FPGA Manager MmAccess API Block More...
 
interface  IStream
 Provides access to the FPGA Manager Streaming API More...
 
class  RegisterBank
 Provides a MmAccess interface with an offset More...
 

Enumerations

enum  Profile { Unspecified, MaximumPerformance, MinimumResources }
 Configuration profile More...
 
enum  StreamType { ByteStream, FrameBased }
 Defines the type of a stream More...
 
enum  StreamDirection { Bidirectional, Downstream, Upstream }
 Defines the direction of a stream More...
 
enum  TransferStatus { Completed, Pending, InProgress, Error }
 Transfer status of the asynchronous transaction More...
 

Enumeration Type Documentation

◆ Profile

enum Profile
strong

Configuration profile

Enumerator
Unspecified 

None, use internal default values

MaximumPerformance 

Enclustra predefined Maximum performance

MinimumResources 

Enclustra predefined Minimum Resources

◆ StreamDirection

enum StreamDirection
strong

Defines the direction of a stream

Enumerator
Bidirectional 

FPGA <-> PC

Downstream 

PC -> FPGA

Upstream 

FPGA -> PC

◆ StreamType

enum StreamType
strong

Defines the type of a stream

Enumerator
ByteStream 

Stream without framing (i.e. transferring a given number of bytes)

FrameBased 

Stream with framing (i.e. transfer one frame independently of its size)

◆ TransferStatus

enum TransferStatus
strong

Transfer status of the asynchronous transaction

Enumerator
Completed 

Transfer has been completed sucessfully

Pending 

Transfer is pending (this should occur)

InProgress 

Transfer is in progress (this should occur)

Error 

Transfer has failed