I2C

Overview

Provides standard Inter-Integrated Circuit (I2C) interfaces.

This module allows a driver to perform operations on an I2C controller for accessing devices on the I2C bus, including creating and destroying I2C controller handles as well as reading and writing data.

Since:

1.0

Summary

Files

Data Structures

Enumerations

Functions

Details

Enumeration Type Documentation

I2cFlag

enum [I2cFlag](I2C.md#ga32b58f021632085445d80c80e382a546)

Description:

Enumerates flags used for transferring I2C messages.

Multiple flags can be used to jointly control a single I2C message transfer. If a bit is set to 1, the corresponding feature is enabled. If a bit is set to 0, the corresponding feature is disabled.

Function Documentation

I2cClose()

void I2cClose (struct [DevHandle](DevHandle.md) * handle)

Description:

Releases the handle of an I2C controller.

If you no longer need to access the I2C controller, you should call this function to close its handle so as to release unused memory resources.

Parameters:

I2cOpen()

struct [DevHandle](DevHandle.md)* I2cOpen (int16_t number)

Description:

Obtains the handle of an I2C controller.

You must call this function before accessing the I2C bus.

Parameters:

Returns:

Returns the pointer to the DevHandle of the I2C controller if the operation is successful; returns NULL otherwise.

I2cTransfer()

int32_t I2cTransfer (struct [DevHandle](DevHandle.md) * handle, struct [I2cMsg](I2cMsg.md) * msgs, int16_t count )

Description:

Launches a custom transfer to an I2C device.

Parameters:

Returns:

Returns the number of transferred message structures if the operation is successful; returns a negative value otherwise.

See also:

I2cMsg

Attention:

This function does not limit the number of message structures specified by count or the data length of each message structure. The specific I2C controller determines the maximum number and data length allowed.