XCORE SDK
XCORE Software Development Kit
Functions
hil_i2s_slave

Functions

void i2s_slave (const i2s_callback_group_t *const i2s_cbg, port_t p_dout[], const size_t num_out, port_t p_din[], const size_t num_in, port_t p_bclk, port_t p_lrclk, xclock_t bclk)
 

Detailed Description

The public API for using the HIL I2S slave.

Function Documentation

◆ i2s_slave()

void i2s_slave ( const i2s_callback_group_t *const  i2s_cbg,
port_t  p_dout[],
const size_t  num_out,
port_t  p_din[],
const size_t  num_in,
port_t  p_bclk,
port_t  p_lrclk,
xclock_t  bclk 
)

I2S slave task

This task performs I2S on the provided pins. It will perform callbacks over the i2s_callback_group_t callback group to get/receive data from the application using this component.

The component performs I2S slave so will expect the word clock and bit clock to be driven externally.

Parameters
i2s_cbgThe I2S callback group pointing to the application's functions to use for initialization and getting and receiving frames. Also points to application specific data which will be shared between the callbacks.
p_doutAn array of data output ports
num_outThe number of output data ports
p_dinAn array of data input ports
num_inThe number of input data ports
p_bclkThe bit clock input port
p_lrclkThe word clock input port
bclkA clock that will get configured for use with the bit clock