I2C_Params Struct Reference

I2C parameters used with I2C_open(). More...

#include <I2C.h>

Collaboration diagram for I2C_Params:

Data Fields
I2C_TransferMode	transferMode
I2C_CallbackFxn	transferCallbackFxn
I2C_BitRate	bitRate
I2C_AddressMode	addressMode
void *	custom

Detailed Description

I2C parameters used with I2C_open().

I2C_Params_init() must be called prior to setting fields in this structure.

See also

I2C_Params_init()

Field Documentation

transferMode

I2C_TransferMode I2C_Params::transferMode

I2C_TransferMode for all I2C transfers.

transferCallbackFxn

I2C_CallbackFxn I2C_Params::transferCallbackFxn

Pointer to a I2C_CallbackFxn to be invoked after a I2C_transfer() completes when operating in I2C_MODE_CALLBACK.

bitRate

I2C_BitRate I2C_Params::bitRate

A I2C_BitRate specifying the frequency at which the I2C peripheral will transmit data during a I2C_transfer().

addressMode

I2C_AddressMode I2C_Params::addressMode

A I2C_AddressMode specifying the address mode to configure the I2C peripheral to use. This will be the address mode used after calling I2C_open(). The address mode can later be changed using I2C_setAddressMode().

Note

Not all address modes are supported for by devices. Please refer to the device-specific documentation for a list of supported address modes.

custom

void* I2C_Params::custom

Pointer to a device specific extension of the I2C_Params

---

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

• I2C.h