#include <r_i2s_api.h>

Data Fields
uint8_t	channel

i2s_pcm_width_t	pcm_width
	Audio PCM data width.

i2s_word_length_t	word_length
	Audio word length, bits must be >= i2s_cfg_t::pcm_width bits.

i2s_ws_continue_t	ws_continue
	Whether to continue WS transmission during idle state.

uint32_t	sampling_freq_hz
	Sampling frequency in Hertz.

i2s_mode_t	operating_mode
	Operating mode selection (i.e., Master/Slave mode)

uint32_t	audio_clk_freq_hz

timer_instance_t const *	p_timer

transfer_instance_t const *	p_transfer_tx

transfer_instance_t const *	p_transfer_rx

void(*	p_callback )(i2s_callback_args_t *p_args)

void const *	p_context

void const *	p_extend
	Extension parameter for hardware specific settings.

uint8_t	rxi_ipl
	Receive interrupt priority.

uint8_t	txi_ipl
	Transmit interrupt priority.

uint8_t	idle_err_ipl
	Idle/Error interrupt priority.

Detailed Description

User configuration structure, used in open function

Field Documentation

uint32_t i2s_cfg_t::audio_clk_freq_hz

Audio clock frequency in Hertz. Must be a multiple between 1 and 128 of (16 * i2s_cfg_t::sampling_freq_hz * (i2s_cfg_t::word_length <enum_value> + 1)

uint8_t i2s_cfg_t::channel

Select a channel corresponding to the channel number of the hardware.

void(* i2s_cfg_t::p_callback) (i2s_callback_args_t *p_args)

Callback provided when an I2S ISR occurs. Set to NULL for no CPU interrupt.

void const* i2s_cfg_t::p_context

Placeholder for user data. Passed to the user callback in i2s_callback_args_t.

timer_instance_t const* i2s_cfg_t::p_timer

To generate audio clock with GPT, link a timer instance here. Set to NULL if unused.

transfer_instance_t const* i2s_cfg_t::p_transfer_rx

To use DTC during read, link a DTC instance here. Set to NULL if unused.

transfer_instance_t const* i2s_cfg_t::p_transfer_tx

To use DTC during write, link a DTC instance here. Set to NULL if unused.

The documentation for this struct was generated from the following file: