Features Supported

Controller and Target mode of Operation
Interrupt, Polled Mode
Blocking and Non-blocking (Callback) Transfers
Queueing of I2C transactions
I2C Bus Recovery

SysConfig Features

Note: It is strongly recommend to use SysConfig where it is available instead of using direct SW API calls. This will help simplify the SW application and also catch common mistakes early in the development cycle.

SysConfig can be used to configure below parameters apart from common configuration like Clock,MPU,RAT and others.

I2C module configuration parameters like bitrate, Own target address, Clock Source.
I2C instances and pin Configurations.
Interrupt Mode enable option. If disabled, gets configured to carry out transactions in Polling mode.
Based on above parameters, the SysConfig generated code does below as part of Drivers_open and Drivers_close functions.
- Set I2C instance parameter configuration.
- Driver ISR registration if Interrupt Mode is enabled.

Features NOT Supported

DMA Mode Operation.

Usage Overview

API Sequence

To use the I2C HLD driver to transmit/receive data over the I2C bus, probe target and set bus frequency the application may call the following APIs:

I2C_open(): Open an I2C HLD Instance.
I2C_close(): Close an I2C HLD Instance.
I2C_Memory_Transaction_init(): Fill Default Value in Memory Transaction object.
I2C_Transaction_init(): Fill Default Value in Transaction object.
I2C_transfer(): Initiate an I2C Transaction.
I2C_memory_transfer(): Initiate an I2C Memory Transaction.
I2C_probe(): Probe I2C Target.
I2C_setBusFrequency(): Set Bus frequency.
I2C_getHandle(): Get I2C Handle from index.

Initializing the I2C HLD Driver

I2C_init() must be called before any other I2C Open is called.

I2C_open() must be called before calling any I2C APIs. This function takes index and params to initialize an instance and returns the handle to the I2C instance.

Calling I2C_close() closes the instance passed.

Please note that the initialization of I2C HLD instances is taken care by the SysConfig generated code.

Example Usage

Include the below file to access the APIs

#include <drivers/i2c.h>

Instance Open Example

    I2C_Params      params;
  
    I2C_Params_init(&params);
    params.transferMode  = I2C_MODE_BLOCKING;
    I2C_init();
    gI2cHandle = I2C_open(CONFIG_I2C0, &params);
    if (!gI2cHandle) {
        DebugP_assert(FALSE);
    }

Instance Close Example

I2C_close(gI2cHandle);

I2c Transfer Example

    int32_t status;
 
    I2C_Transaction i2cTransaction;
    I2C_Transaction_init(&i2cTransaction);
  
    i2cTransaction.writeBuf = txBuffer;
    i2cTransaction.writeCount = 1U;
  
    i2cTransaction.readBuf = rxBuffer;
    i2cTransaction.readCount = 2U;
  
    status = I2C_transfer(gI2cHandle, &i2cTransaction);
    if (SystemP_SUCCESS != status) {
        DebugP_assert(FALSE);
    }

API

APIs for I2C HLD