STM32F4xx HAL Documentation
Hardware Abstraction Layer for STM32F4 familiy
Loading...
Searching...
No Matches
Data Fields
SAI_InitTypeDef Struct Reference
STM32F4xx_HAL_Driver » SAI » SAI Exported Types » SAI Init Structure definition

#include <stm32f4xx_hal_sai.h>

Collaboration diagram for SAI_InitTypeDef:

Data Fields

uint32_t AudioMode
 
uint32_t Synchro
 
uint32_t SynchroExt
 
uint32_t OutputDrive
 
uint32_t NoDivider
 
uint32_t FIFOThreshold
 
uint32_t ClockSource
 
uint32_t AudioFrequency
 
uint32_t Mckdiv
 
uint32_t MonoStereoMode
 
uint32_t CompandingMode
 
uint32_t TriState
 
uint32_t Protocol
 
uint32_t DataSize
 
uint32_t FirstBit
 
uint32_t ClockStrobing
 

Detailed Description

Definition at line 69 of file stm32f4xx_hal_sai.h.

Field Documentation

◆ AudioMode

uint32_t SAI_InitTypeDef::AudioMode

Specifies the SAI Block audio Mode. This parameter can be a value of SAI Block Mode

Definition at line 71 of file stm32f4xx_hal_sai.h.

Referenced by HAL_SAI_Init(), SAI_InitI2S(), SAI_InitPCM(), and SAI_InterruptFlag().

◆ Synchro

uint32_t SAI_InitTypeDef::Synchro

Specifies SAI Block synchronization This parameter can be a value of SAI Block Synchronization

Definition at line 74 of file stm32f4xx_hal_sai.h.

Referenced by HAL_SAI_Init(), and SAI_BlockSynchroConfig().

◆ SynchroExt

uint32_t SAI_InitTypeDef::SynchroExt

Specifies SAI external output synchronization, this setup is common for BlockA and BlockB This parameter can be a value of SAI External synchronisation

Note
: If both audio blocks of same SAI are used, this parameter has to be set to the same value for each audio block

Definition at line 77 of file stm32f4xx_hal_sai.h.

Referenced by HAL_SAI_Init(), and SAI_BlockSynchroConfig().

◆ OutputDrive

uint32_t SAI_InitTypeDef::OutputDrive

Specifies when SAI Block outputs are driven. This parameter can be a value of SAI Block Output Drive

Note
this value has to be set before enabling the audio block but after the audio block configuration.

Definition at line 83 of file stm32f4xx_hal_sai.h.

Referenced by HAL_SAI_Init().

◆ NoDivider

uint32_t SAI_InitTypeDef::NoDivider

Specifies whether master clock will be divided or not. This parameter can be a value of SAI Block NoDivider

Note
If bit NODIV in the SAI_xCR1 register is cleared, the frame length should be aligned to a number equal to a power of 2, from 8 to 256. If bit NODIV in the SAI_xCR1 register is set, the frame length can take any of the values without constraint since the input clock of the audio block should be equal to the bit clock. There is no MCLK_x clock which can be output.

Definition at line 88 of file stm32f4xx_hal_sai.h.

Referenced by HAL_SAI_Init().

◆ FIFOThreshold

uint32_t SAI_InitTypeDef::FIFOThreshold

Specifies SAI Block FIFO threshold. This parameter can be a value of SAI Block Fifo Threshold

Definition at line 97 of file stm32f4xx_hal_sai.h.

Referenced by HAL_SAI_Init().

◆ ClockSource

uint32_t SAI_InitTypeDef::ClockSource

Specifies the SAI Block x Clock source. This parameter is not used for STM32F446xx devices.

Definition at line 100 of file stm32f4xx_hal_sai.h.

Referenced by SAI_GetInputClock().

◆ AudioFrequency

uint32_t SAI_InitTypeDef::AudioFrequency

Specifies the audio frequency sampling. This parameter can be a value of SAI Audio Frequency

Definition at line 103 of file stm32f4xx_hal_sai.h.

Referenced by HAL_SAI_Init().

◆ Mckdiv

uint32_t SAI_InitTypeDef::Mckdiv

Specifies the master clock divider. This parameter must be a number between Min_Data = 0 and Max_Data = 15.

Note
This parameter is used only if AudioFrequency is set to SAI_AUDIO_FREQUENCY_MCKDIV otherwise it is internally computed.

Definition at line 106 of file stm32f4xx_hal_sai.h.

Referenced by HAL_SAI_Init().

◆ MonoStereoMode

uint32_t SAI_InitTypeDef::MonoStereoMode

Specifies if the mono or stereo mode is selected. This parameter can be a value of SAI Mono Stereo Mode

Definition at line 111 of file stm32f4xx_hal_sai.h.

Referenced by HAL_SAI_Init().

◆ CompandingMode

uint32_t SAI_InitTypeDef::CompandingMode

Specifies the companding mode type. This parameter can be a value of SAI Block Companding Mode

Definition at line 114 of file stm32f4xx_hal_sai.h.

Referenced by HAL_SAI_Init(), HAL_SAI_Receive(), HAL_SAI_Receive_IT(), HAL_SAI_Transmit(), HAL_SAI_Transmit_IT(), and SAI_FillFifo().

◆ TriState

uint32_t SAI_InitTypeDef::TriState

Specifies the companding mode type. This parameter can be a value of SAI TRIState Management

Definition at line 117 of file stm32f4xx_hal_sai.h.

Referenced by HAL_SAI_Init().

◆ Protocol

uint32_t SAI_InitTypeDef::Protocol

Specifies the SAI Block protocol. This parameter can be a value of SAI Block Protocol

Definition at line 123 of file stm32f4xx_hal_sai.h.

Referenced by HAL_SAI_Init(), SAI_InitI2S(), SAI_InitPCM(), and SAI_InterruptFlag().

◆ DataSize

uint32_t SAI_InitTypeDef::DataSize

Specifies the SAI Block data size. This parameter can be a value of SAI Block Data Size

Definition at line 126 of file stm32f4xx_hal_sai.h.

Referenced by HAL_SAI_Init(), HAL_SAI_Receive(), HAL_SAI_Receive_IT(), HAL_SAI_Transmit(), HAL_SAI_Transmit_IT(), SAI_FillFifo(), SAI_InitI2S(), and SAI_InitPCM().

◆ FirstBit

uint32_t SAI_InitTypeDef::FirstBit

Specifies whether data transfers start from MSB or LSB bit. This parameter can be a value of SAI Block MSB LSB transmission

Definition at line 129 of file stm32f4xx_hal_sai.h.

Referenced by HAL_SAI_Init(), SAI_InitI2S(), and SAI_InitPCM().

◆ ClockStrobing

uint32_t SAI_InitTypeDef::ClockStrobing

Specifies the SAI Block clock strobing edge sensitivity. This parameter can be a value of SAI Block Clock Strobing

Definition at line 132 of file stm32f4xx_hal_sai.h.

Referenced by HAL_SAI_Init(), SAI_InitI2S(), and SAI_InitPCM().

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