FpgaManager
Software API Documentation
I2CMasterEnclustra Class Reference

Driver for Enclustra I2C Master Controller More...

Inheritance diagram for I2CMasterEnclustra:
II2CBus

Public Member Functions

 I2CMasterEnclustra (IMmAccess registerBank, UInt32 registerBankOffset)
 Constructs the I2C Master Controller More...
 
IEnumerable< uint > Detect (CancellationToken ct)
 Enumerate all I2C device on a bus More...
 
II2CDevice Connect (uint deviceAddress)
 Provides interface for a specific I2C device on a bus More...
 
async IAsyncEnumerable< uint > DetectAsync ([EnumeratorCancellation] CancellationToken ct)
 Enumerate all I2C device on a bus asynchronously (non-blocking) More...
 

Properties

DateTime Version [get]
 Returns the version of the IP core More...
 

Detailed Description

Driver for Enclustra I2C Master Controller

Constructor & Destructor Documentation

◆ I2CMasterEnclustra()

I2CMasterEnclustra ( IMmAccess  registerBank,
UInt32  registerBankOffset 
)
inline

Constructs the I2C Master Controller

Parameters
registerBankMmAccess interface
registerBankOffsetBase address of IP block

Member Function Documentation

◆ Connect()

II2CDevice Connect ( uint  deviceAddress)

Provides interface for a specific I2C device on a bus

Parameters
deviceAddressI2C address of the device in 7-bit notation
Returns
TAP Task

Implements II2CBus.

◆ Detect()

IEnumerable<uint> Detect ( CancellationToken  ct)
inline

Enumerate all I2C device on a bus

Returns
Sequence of detected I2C device addresses

Implements II2CBus.

◆ DetectAsync()

async IAsyncEnumerable<uint> DetectAsync ( [EnumeratorCancellation] CancellationToken  ct)
inline

Enumerate all I2C device on a bus asynchronously (non-blocking)

Parameters
ctCancellation Token
Returns
Sequence of detected I2C device addresses

Implements II2CBus.

Property Documentation

◆ Version

DateTime Version
get

Returns the version of the IP core

Returns
IP core version

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