Synergy Software Package User's Manual
ssi_instance_ctrl_t Struct Reference

#include <r_ssi.h>

Data Fields

void(* p_callback )(i2s_callback_args_t *p_args)
 
void const * p_context
 
R_SSI0_Type * p_reg
 Pointer to SSI register base address.
 
timer_instance_t const * p_timer
 Timer used to generate audio clock.
 
transfer_instance_t const * p_transfer_tx
 Transfer used for hardware acceleration during write.
 
transfer_instance_t const * p_transfer_rx
 Transfer used for hardware acceleration during read.
 
uint32_t const * p_tx_src
 
uint32_t tx_src_bytes
 
uint32_t * p_rx_dest
 
uint32_t rx_dest_bytes
 
uint32_t sampling_freq_hz
 Sampling frequency in Hertz.
 
uint8_t channel
 Channel number.
 
uint8_t fifo_access_bytes
 Byte access to FIFO.
 
bool tx_in_use
 True if a transmission is in progress.
 
bool rx_in_use
 True if a reception is in progress.
 
bool zeros_written
 True if zeros have been transmitted.
 
IRQn_Type txi_irq
 Transmit IRQ number.
 
IRQn_Type rxi_irq
 Receive IRQ number.
 
IRQn_Type int_irq
 Idle/Error IRQ number.
 
uint32_t open
 Whether or not this control block is initialized.
 

Detailed Description

Channel instance control block. DO NOT INITIALIZE. Initialization occurs when i2s_api_t::open is called.

Field Documentation

◆ p_callback

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

Callback provided when an I2S ISR occurs. NULL indicates no CPU interrupt.

◆ p_context

void const* ssi_instance_ctrl_t::p_context

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

◆ p_rx_dest

uint32_t* ssi_instance_ctrl_t::p_rx_dest

Destination buffer pointer used to fill from hardware FIFO in receive ISR.

◆ p_tx_src

uint32_t const* ssi_instance_ctrl_t::p_tx_src

Source buffer pointer used to fill hardware FIFO from transmit ISR.

◆ rx_dest_bytes

uint32_t ssi_instance_ctrl_t::rx_dest_bytes

Size of destination buffer used to fill from hardware FIFO in receive ISR.

◆ tx_src_bytes

uint32_t ssi_instance_ctrl_t::tx_src_bytes

Size of source buffer used to fill hardware FIFO from transmit ISR.


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