I2C Framework

RTOS-integrated I2C Framework Interface. More...

Data Structures
struct	sf_i2c_bus_t
struct	sf_i2c_cfg_t
struct	sf_i2c_api_t
struct	sf_i2c_instance_t

Macros
#define	SF_I2C_API_VERSION_MAJOR   (2U)

Typedefs
typedef void	sf_i2c_ctrl_t

Enumerations
enum	sf_i2c_dev_state_t { SF_I2C_DEV_STATE_CLOSED = 0, SF_I2C_DEV_STATE_OPENED }

Detailed Description

RTOS-integrated I2C Framework Interface.

Summary

This is a ThreadX-aware I2C interface. It can be implemented by several hardware peripherals at the HAL layer through the I2C interface I2C Interface.

The connection to the HAL layer is established by passing in a driver structure in SF_I2C_Open().

Related SSP architecture topics:

• SSP Interfaces
• SSP Predefined Layers
• Using SSP Modules

SPI Framework Interface description: I2C Framework

Macro Definition Documentation

SF_I2C_API_VERSION_MAJOR

#define SF_I2C_API_VERSION_MAJOR   (2U)

Includes driver interface.

Typedef Documentation

sf_i2c_ctrl_t

typedef void sf_i2c_ctrl_t

I2C framework control block. Allocate an instance specific control block to pass into the I2C framework API calls.

Implemented as

• sf_i2c_instance_ctrl_t

Enumeration Type Documentation

sf_i2c_dev_state_t

enum sf_i2c_dev_state_t

SF I2C device state

Enumerator
SF_I2C_DEV_STATE_CLOSED	I2C device is closed.
SF_I2C_DEV_STATE_OPENED	I2C device is opened.