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

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

Detailed Description

The public API for using the HIL I2S master.

Function Documentation

◆ i2s_master()

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

I2S master task

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

The task performs I2S master so will drive the word clock and bit clock lines.

Parameters

i2s_cbg	The 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_dout	An array of data output ports
num_out	The number of output data ports
p_din	An array of data input ports
num_in	The number of input data ports
p_bclk	The bit clock output port
p_lrclk	The word clock output port
p_mclk	Input port which supplies the master clock
bclk	A clock that will get configured for use with the bit clock

◆ i2s_master_external_clock()

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