I²C Library

A software defined I²C library that allows you to control an I²C bus via xcore ports. I²C is a two-wire hardware serial interface, first developed by Philips. The components in the library are controlled via C and can either act as I²C master or slave.

The library is compatible with multiple slave devices existing on the same bus. The I²C master component can be used by multiple tasks within the xcore device (each addressing the same or different slave devices).

The library can also be used to implement multiple I²C physical interfaces on a single xcore device simultaneously.

All signals are designed to comply with the timings in the I²C specification found here:

https://www.nxp.com/docs/en/user-guide/UM10204.pdf

Note that the following optional parts of the I²C specification are not supported:

• Multi-master arbitration

• 10-bit slave addressing

• General call addressing

• Software reset

• START byte

• Device ID

• Fast-mode Plus, High-speed mode, Ultra Fast-mode

I²C consists of two signals: a clock line (SCL) and a data line (SDA). Both these signals are open-drain and require external resistors to pull the line up if no device is driving the signal down. The correct value for the resistors can be found in the I²C specification.

All I²C functions can be accessed via the i2c.h header:

#include <i2c.h>

• I²C Master
  • I²C Master Usage
  • I²C Master API
• I²C Slave
  • I²C Slave Usage
  • I²C Slave API
• I²C Registers
  • I²C Register API