Detailed Description

Master mode transfer message structure used to define a complete I2C transfer sequence (from start to stop).

The structure allows for defining the following types of sequences, please refer to defines for sequence details.

I2C_FLAG_READ - data read into buf[0].data
I2C_FLAG_WRITE - data written from buf[0].data
I2C_FLAG_WRITE_READ - data written from buf[0].data and read into buf[1].data
I2C_FLAG_WRITE_WRITE - data written from buf[0].data and buf[1].data

Definition at line 252 of file em_i2c.h.

#include <em_i2c.h>

Data Fields
uint16_t	addr
	Address to use after (repeated) start. More...

struct {
uint8_t * data

uint16_t len

}	buf [2]

uint16_t	flags

Field Documentation

uint16_t I2C_TransferSeq_TypeDef::addr

Address to use after (repeated) start.

Layout details, A = address bit, X = don't care bit (set to 0):

7 bit address - use format AAAA AAAX.
10 bit address - use format XXXX XAAX AAAA AAAA

Definition at line 262 of file em_i2c.h.

Referenced by CCS811_getMeasurement(), CCS811_getRawData(), CCS811_readMailbox(), CCS811_setEnvData(), CCS811_setMeasureMode(), CCS811_softwareReset(), EEPROM_AckPoll(), EEPROM_Read(), EEPROM_Write(), I2C_Transfer(), performI2CTransfer(), SI1133_registerBlockRead(), SI1133_registerBlockWrite(), SI1133_registerRead(), SI1133_registerWrite(), Si1147_Read_Block_Register(), Si1147_Read_Register(), Si1147_Write_Block_Register(), Si1147_Write_Register(), Si7013_Detect(), Si7013_GetFirmwareRevision(), SI7021_cmdRead(), SI7021_cmdWrite(), SI7210_regRead(), SI7210_regWrite(), TEMPSENS_RegisterGet(), and TEMPSENS_RegisterSet().

struct { ... } I2C_TransferSeq_TypeDef::buf[2]

Buffers used to hold data to send from or receive into depending on sequence type.

Referenced by CCS811_getMeasurement(), CCS811_getRawData(), CCS811_readMailbox(), CCS811_setEnvData(), CCS811_setMeasureMode(), CCS811_softwareReset(), EEPROM_AckPoll(), EEPROM_Read(), EEPROM_Write(), I2C_Transfer(), I2C_TransferInit(), performI2CTransfer(), SI1133_registerBlockRead(), SI1133_registerBlockWrite(), SI1133_registerRead(), SI1133_registerWrite(), Si1147_Read_Block_Register(), Si1147_Read_Register(), Si1147_Write_Block_Register(), Si1147_Write_Register(), Si7013_Detect(), Si7013_GetFirmwareRevision(), SI7021_cmdRead(), SI7021_cmdWrite(), SI7210_regRead(), SI7210_regWrite(), TEMPSENS_RegisterGet(), and TEMPSENS_RegisterSet().

uint8_t* I2C_TransferSeq_TypeDef::data

Buffer used for data to transmit/receive, must be len long.

Definition at line 274 of file em_i2c.h.

Referenced by CCS811_getMeasurement(), CCS811_getRawData(), CCS811_readMailbox(), CCS811_setEnvData(), CCS811_setMeasureMode(), CCS811_softwareReset(), EEPROM_AckPoll(), EEPROM_Read(), EEPROM_Write(), I2C_Transfer(), performI2CTransfer(), SI1133_registerBlockRead(), SI1133_registerBlockWrite(), SI1133_registerRead(), SI1133_registerWrite(), Si1147_Read_Block_Register(), Si1147_Read_Register(), Si1147_Write_Block_Register(), Si1147_Write_Register(), Si7013_Detect(), Si7013_GetFirmwareRevision(), SI7021_cmdRead(), SI7021_cmdWrite(), SI7210_regRead(), SI7210_regWrite(), TEMPSENS_RegisterGet(), and TEMPSENS_RegisterSet().

uint16_t I2C_TransferSeq_TypeDef::flags

Flags defining sequence type and details, see I2C_FLAG_... defines.

Definition at line 265 of file em_i2c.h.

Referenced by CCS811_getMeasurement(), CCS811_getRawData(), CCS811_readMailbox(), CCS811_setEnvData(), CCS811_setMeasureMode(), CCS811_softwareReset(), EEPROM_AckPoll(), EEPROM_Read(), EEPROM_Write(), I2C_Transfer(), I2C_TransferInit(), performI2CTransfer(), SI1133_registerBlockRead(), SI1133_registerBlockWrite(), SI1133_registerRead(), SI1133_registerWrite(), Si1147_Read_Block_Register(), Si1147_Read_Register(), Si1147_Write_Block_Register(), Si1147_Write_Register(), Si7013_Detect(), Si7013_GetFirmwareRevision(), SI7021_cmdRead(), SI7021_cmdWrite(), SI7210_regRead(), SI7210_regWrite(), TEMPSENS_RegisterGet(), and TEMPSENS_RegisterSet().

uint16_t I2C_TransferSeq_TypeDef::len

Number of bytes in data to send or receive. Notice that when receiving data to this buffer, at least 1 byte must be received. Setting len to 0 in the receive case is considered a usage fault. Transmitting 0 bytes is legal, in which case only the address is transmitted after the start condition.

Definition at line 283 of file em_i2c.h.

Referenced by CCS811_getMeasurement(), CCS811_getRawData(), CCS811_readMailbox(), CCS811_setEnvData(), CCS811_setMeasureMode(), CCS811_softwareReset(), EEPROM_AckPoll(), EEPROM_Read(), EEPROM_Write(), I2C_Transfer(), I2C_TransferInit(), performI2CTransfer(), SI1133_registerBlockRead(), SI1133_registerBlockWrite(), SI1133_registerRead(), SI1133_registerWrite(), Si1147_Read_Block_Register(), Si1147_Read_Register(), Si1147_Write_Block_Register(), Si1147_Write_Register(), Si7013_Detect(), Si7013_GetFirmwareRevision(), SI7021_cmdRead(), SI7021_cmdWrite(), SI7210_regRead(), SI7210_regWrite(), TEMPSENS_RegisterGet(), and TEMPSENS_RegisterSet().

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

D:/jenkins-slave/workspaces/Executor-0/super/platform/emlib/inc/em_i2c.h

Detailed Description

Data Fields

Field Documentation