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 parmaters like bitrate, target addresses to probe.
I2C instances and pin configurations.
Interrupt mode enable option.If you disable it, configures to 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

Target mode is not supported in polling mode.

Usage Overview

API Sequence

Needs Work

Initializing the I2C HLD Driver

Needs Work

Important Usage Guidelines

NA

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