ADuCM302x Device Drivers API Reference Manual
Release 3.1.2.0
|
#include <adi_i2c.h>
Data Fields | |
uint8_t * | pPrologue |
uint16_t | nPrologueSize |
uint8_t * | pData |
uint16_t | nDataSize |
bool | bReadNotWrite |
bool | bRepeatStart |
I2C Device Command/Data Transaction Structure. This is the called-provided data structure used by the blocking adi_i2c_ReadWrite() and non-blocking adi_i2c_SubmitBuffer() calls to describe the caller's transaction parameters, consisting of prologue data and size (the addressing phase), transmit/receive data pointer and size (the data phase), and various transaction control parameters.
Each transaction may optionally be prefaced with a prologue block, which may describe a read/write memory/register address, a slave-specific command, or some other slave-specific protocol that may precede the actual read/write data. Set the prologue size to zero if no prologue is desired.
Each call to adi_i2c_ReadWrite or adi_i2c_SubmitBuffer() must populate the following fields of the ADI_I2C_TRANSACTION block:
uint8_t* pPrologue |
Prologue pointer.
Definition at line 200 of file adi_i2c.h.
Referenced by adi_i2c_IssueGeneralCall().
uint16_t nPrologueSize |
Prologue byte count.
Definition at line 201 of file adi_i2c.h.
Referenced by adi_i2c_IssueGeneralCall().
uint8_t* pData |
Data pointer.
Definition at line 202 of file adi_i2c.h.
Referenced by adi_i2c_IssueGeneralCall(), adi_i2c_ReadWrite(), and adi_i2c_SubmitBuffer().
uint16_t nDataSize |
Data byte count.
Definition at line 203 of file adi_i2c.h.
Referenced by adi_i2c_IssueGeneralCall(), adi_i2c_ReadWrite(), and adi_i2c_SubmitBuffer().
bool bReadNotWrite |
Read/write flag.
Definition at line 204 of file adi_i2c.h.
Referenced by adi_i2c_IssueGeneralCall().
bool bRepeatStart |
Repeat start flag.
Definition at line 205 of file adi_i2c.h.
Referenced by adi_i2c_IssueGeneralCall().