orphan:

lib_i2c: XMOS I²C Library

vendor:	XMOS
version:	6.3.0
scope:	General Use
description:	XMOS I2C library
category:	General Purpose
keywords:	IO, I2C
devices:	xcore.ai, xcore-200

Overview

A software defined, industry-standard, 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 libary are controlled via C using the XMOS multicore extensions (xC) and can either act as I²C master or slave.

The libary 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.

Features

Key features of the various components in this repository are as follows

• I²C master and I²C slave modes
• Supports speed up to 400 Kb/s (I²C Fast-mode)
• Clock stretching support
• Synchronous and asynchronous APIs for efficient usage of processing cores

Related Application Notes

The following application notes use this library:

• AN00156: How to use the I²C master library
• AN00157: How to use the I²C slave library
• AN00181: xCORE-200 explorer accelerometer demo

Known Issues

• The library has functions that wait on SCL high, through either an event or a polling loop. If these are called on a system where the pull up isn't present then the application can hang forever.

Required Tools

• XMOS XTC Tools: 15.3.0

Required Libraries (dependencies)

• lib_xassert (www.github.com/xmos/lib_xassert)

Support

This package is supported by XMOS Ltd. Issues can be raised against the software at www.xmos.com/support