I²S Library

A software defined library that allows you to control an I²S (Inter-IC Sound) bus via xcore ports. I²S is a digital data streaming interfaces particularly appropriate for transmission of audio data. The components in the library are controlled via C and can either act as I²S master or I²S slave.

Note

The TDM protocol is not yet supported by this library.

I²S is a protocol between two devices where one is the master and one is the slave . The protocol is made up of four signals shown in I2S data wires.

Table 17 I²S data wires

MCLK	Clock line, driven by external oscillator
BCLK	Bit clock. This is a fixed divide of the MCLK and is driven by the master.
LRCLK (or WCLK)	Word clock (or word select). This is driven by the master.
DATA	Data line, driven by one of the slave or master depending on the data direction. There may be several data lines in differing directions.

All I²S functions can be accessed via the i2s.h header:

#include <i2s.h>

• I²S Common API
• I²S Master
  • I²S Master Usage
  • I²S Master API
• I²S Slave
  • I²S Slave Usage
  • I²S Slave API