I2C_Params Struct Reference

Detailed Description

I2C Parameters.

I2C parameters are used to with the I2C_open() call. Default values for these parameters are set using I2C_Params_init().

If I2C_TransferMode is set to I2C_MODE_BLOCKING then I2C_transfer function calls will block thread execution until the transaction has completed.

If I2C_TransferMode is set to I2C_MODE_CALLBACK then I2C_transfer will not block thread execution and it will call the function specified by transferCallbackFxn. Sequential calls to I2C_transfer in I2C_MODE_CALLBACK mode will put the designated transaction onto an internal queue that automatically starts queued transactions after the previous transaction has completed. (regardless of error state).

I2cBitRates specifies the I2C bus rate used for I2C communications.

Data Fields
uint8_t	transferMode
void(*	transferCallbackFxn )(I2C_Handle i2cHnd, I2C_Transaction *msg, int32_t transferStatus)
uint8_t	bitRate

Field Documentation

transferMode

uint8_t I2C_Params::transferMode

Blocking or Callback mode

transferCallbackFxn

void(* I2C_Params::transferCallbackFxn) (I2C_Handle i2cHnd, I2C_Transaction *msg, int32_t transferStatus)

I2C_CallbackFxn transferCallbackFxn; Callback function pointer

bitRate

uint8_t I2C_Params::bitRate

I2C bus bit rate