S32 SDK
sai_user_config_t Struct Reference

User config structure. More...

#include <sai_driver.h>

Data Fields

sai_sync_mode_t SyncMode
 
sai_master_clk_source_t MasterClkSrc
 
bool BitClkNegPolar
 
bool BitClkInternal
 
uint16_t BitClkDiv
 
uint8_t ChannelEnable
 
uint8_t FrameSize
 
uint8_t SyncWidth
 
sai_mask_mode_t MaskMode
 
bool MsbFirst
 
bool SyncEarly
 
bool SyncNegPolar
 
bool SyncInternal
 
uint8_t Word0Width
 
uint8_t WordNWidth
 
uint8_t FirstBitIndex
 
uint32_t BitClkFreq
 
bool RunErrorReport
 
bool SyncErrorReport
 
bool FrameStartReport
 
sai_mux_mode_t MuxMode
 
sai_transfer_type_t TransferType
 
uint8_t DmaChannel [SAI_MAX_CHANNEL_COUNT]
 
uint8_t ElementSize
 
uint8_t ChannelCount
 
sai_transfer_callback_t callback
 

Detailed Description

User config structure.

Implements : sai_user_config_t_Class

Definition at line 144 of file sai_driver.h.

Field Documentation

uint16_t BitClkDiv

If bit clock is generated internally, it is divided from master clock by this. User need to init this if master clock is external.

Definition at line 150 of file sai_driver.h.

uint32_t BitClkFreq

Desired bit clock frequency in hertz, only for internally generated master clock and bit clock.

Definition at line 164 of file sai_driver.h.

bool BitClkInternal

True if bit clock is generated internally.

Definition at line 149 of file sai_driver.h.

bool BitClkNegPolar

True if bit clock is negative polar

Definition at line 148 of file sai_driver.h.

User callback function, called when transfer complete or selected events occured.

Definition at line 174 of file sai_driver.h.

uint8_t ChannelCount

Number of channels to enable, only used when line mux mode and interrupt mode is selected.

Definition at line 173 of file sai_driver.h.

uint8_t ChannelEnable

Turn on each bit to enable each channel. 4 bit for 4 channels.

Definition at line 152 of file sai_driver.h.

uint8_t DmaChannel[SAI_MAX_CHANNEL_COUNT]

DMA channels to be used.

Definition at line 171 of file sai_driver.h.

uint8_t ElementSize

Size in bytes of each element to transfer.

Definition at line 172 of file sai_driver.h.

uint8_t FirstBitIndex

Index from LSB of first bit to be transmitted/received, valid range from 0-31.

Definition at line 162 of file sai_driver.h.

uint8_t FrameSize

Frame size in number of words.

Definition at line 153 of file sai_driver.h.

bool FrameStartReport

Enable frame start report.

Definition at line 168 of file sai_driver.h.

sai_mask_mode_t MaskMode

Data line state for mask word or when data line is disabled (apply only for transmitter).

Definition at line 155 of file sai_driver.h.

Select master clock source.

Definition at line 147 of file sai_driver.h.

bool MsbFirst

True if data is MSB first, false if LSB first.

Definition at line 156 of file sai_driver.h.

sai_mux_mode_t MuxMode

Enable line mux, memory mux or mux is disabled.

Definition at line 169 of file sai_driver.h.

bool RunErrorReport

Underrun/overrun error report.

Definition at line 166 of file sai_driver.h.

bool SyncEarly

True if frame sync is one bit clock early.

Definition at line 157 of file sai_driver.h.

bool SyncErrorReport

Enable sync error report.

Definition at line 167 of file sai_driver.h.

bool SyncInternal

True if frame sync is generated internally

Definition at line 159 of file sai_driver.h.

sai_sync_mode_t SyncMode

Sync mode.

Definition at line 146 of file sai_driver.h.

bool SyncNegPolar

True if frame sync is negative polar.

Definition at line 158 of file sai_driver.h.

uint8_t SyncWidth

Sync width in number of bit clocks.

Definition at line 154 of file sai_driver.h.

sai_transfer_type_t TransferType

Transfer using dma or interrupt.

Definition at line 170 of file sai_driver.h.

uint8_t Word0Width

First word width in number of bit clocks.

Definition at line 160 of file sai_driver.h.

uint8_t WordNWidth

Other words width in number of bit clocks.

Definition at line 161 of file sai_driver.h.


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