I2C_Params_ Struct Reference

I2C Parameters. More...

#include <I2C.h>

Collaboration diagram for I2C_Params_:

Data Fields
I2C_TransferMode	transferMode
I2C_CallbackFxn	transferCallbackFxn
I2C_BitRate	bitRate
void *	custom

Detailed Description

I2C Parameters.

I2C parameters are used 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, I2C_transfer() function calls will block thread execution until the transaction has completed. In this case, the transferCallbackFxn parameter will be ignored.

If I2C_TransferMode is set to I2C_MODE_CALLBACK, I2C_transfer() will not block thread execution, but it will call the function specified by transferCallbackFxn upon transfer completion. Sequential calls to I2C_transfer() in I2C_MODE_CALLBACK will put the I2C_Transaction structures onto an internal queue that automatically starts queued transactions after the previous transaction has completed. This queuing occurs regardless of any error state from previous transactions.

I2C_BitRate specifies the I2C bus rate used for I2C communications.

See also

I2C_Params_init()

Field Documentation

I2C_TransferMode I2C_Params_::transferMode

Blocking or Callback mode

I2C_CallbackFxn I2C_Params_::transferCallbackFxn

Callback function pointer

I2C_BitRate I2C_Params_::bitRate

I2C bus bit rate

void* I2C_Params_::custom

Custom argument used by driver implementation

---

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

• I2C.h