STM32Cube BSP FW for STM32F769I-Discovery

Dependents:   mbed-os-example-blinky-5 DISCO-F769NI_TOUCHSCREEN_demo_custom_1 Datarecorder2 DISCO-F769NI_TOUCHSCREEN_demo ... more

Embed: (wiki syntax)

« Back to documentation index

STM32F769I_DISCOVERY_AUDIO_In Private Functions

STM32F769I_DISCOVERY_AUDIO_In Private Functions
[STM32F769I_DISCOVERY AUDIO]

Functions

uint8_t BSP_AUDIO_IN_Init (uint32_t AudioFreq, uint32_t BitRes, uint32_t ChnlNbr)
 Initialize wave recording.
uint8_t BSP_AUDIO_IN_InitEx (uint16_t InputDevice, uint32_t AudioFreq, uint32_t BitRes, uint32_t ChnlNbr)
 Initialize wave recording.
uint8_t BSP_AUDIO_IN_AllocScratch (int32_t *pScratch, uint32_t size)
 Allocate channel buffer scratch.
uint8_t BSP_AUDIO_IN_GetChannelNumber (void)
 Return audio in channel number.
uint8_t BSP_AUDIO_IN_Record (uint16_t *pbuf, uint32_t size)
 Start audio recording.
uint8_t BSP_AUDIO_IN_Stop (void)
 Stop audio recording.
uint8_t BSP_AUDIO_IN_Pause (void)
 Pause the audio file stream.
uint8_t BSP_AUDIO_IN_Resume (void)
 Resume the audio file stream.
void BSP_AUDIO_IN_DeInit (void)
 Deinit the audio IN peripherals.
void HAL_DFSDM_FilterRegConvCpltCallback (DFSDM_Filter_HandleTypeDef *hdfsdm_filter)
 Regular conversion complete callback.
void HAL_DFSDM_FilterRegConvHalfCpltCallback (DFSDM_Filter_HandleTypeDef *hdfsdm_filter)
 Half regular conversion complete callback.
void HAL_SAI_RxHalfCpltCallback (SAI_HandleTypeDef *hsai)
 Half reception complete callback.
void HAL_SAI_RxCpltCallback (SAI_HandleTypeDef *hsai)
 Reception complete callback.
__weak void BSP_AUDIO_IN_TransferComplete_CallBack (void)
 User callback when record buffer is filled.
__weak void BSP_AUDIO_IN_HalfTransfer_CallBack (void)
 Manages the DMA Half Transfer complete event.
__weak void BSP_AUDIO_IN_Error_CallBack (void)
 Audio IN Error callback function.
__weak void BSP_AUDIO_IN_MspInit (void)
 Initialize BSP_AUDIO_IN MSP.
__weak void BSP_AUDIO_IN_MspDeInit (void)
 DeInitialize BSP_AUDIO_IN MSP.
__weak void BSP_AUDIO_IN_ClockConfig (DFSDM_Filter_HandleTypeDef *hdfsdm_filter, uint32_t AudioFreq, void *Params)
 Clock Config.
void AUDIO_DFSDMx_DMAx_TOP_LEFT_IRQHandler (void)
 This function handles DMA2 Stream 0 interrupt request.
void AUDIO_DFSDMx_DMAx_TOP_RIGHT_IRQHandler (void)
 This function handles DMA2 Stream 5 interrupt request.
void AUDIO_OUT_SAIx_DMAx_IRQHandler (void)
 This function handles DMA2 Stream 1 interrupt request.
void AUDIO_DFSDMx_DMAx_BUTTOM_LEFT_IRQHandler (void)
 This function handles DMA2 Stream 6 interrupt request.
void AUDIO_DFSDMx_DMAx_BUTTOM_RIGHT_IRQHandler (void)
 This function handles DMA2 Stream 7 interrupt request.
static uint8_t DFSDMx_Init (uint32_t AudioFreq)
 Initialize the Digital Filter for Sigma-Delta Modulators interface (DFSDM).
static uint8_t DFSDMx_DeInit (void)
 De-initialize the Digital Filter for Sigma-Delta Modulators interface (DFSDM).
static void DFSDMx_ChannelMspInit (void)
 Initialize the DFSDM channel MSP.
static void DFSDMx_ChannelMspDeInit (void)
 DeInitialize the DFSDM channel MSP.
static void DFSDMx_FilterMspInit (void)
 Initialize the DFSDM filter MSP.
static void DFSDMx_FilterMspDeInit (void)
 DeInitialize the DFSDM filter MSP.

Function Documentation

void AUDIO_DFSDMx_DMAx_BUTTOM_LEFT_IRQHandler ( void   )

This function handles DMA2 Stream 6 interrupt request.

Parameters:
None
Return values:
None

Definition at line 2231 of file stm32f769i_discovery_audio.c.

void AUDIO_DFSDMx_DMAx_BUTTOM_RIGHT_IRQHandler ( void   )

This function handles DMA2 Stream 7 interrupt request.

Parameters:
None
Return values:
None

Definition at line 2241 of file stm32f769i_discovery_audio.c.

void AUDIO_DFSDMx_DMAx_TOP_LEFT_IRQHandler ( void   )

This function handles DMA2 Stream 0 interrupt request.

Parameters:
None
Return values:
None

Definition at line 2201 of file stm32f769i_discovery_audio.c.

void AUDIO_DFSDMx_DMAx_TOP_RIGHT_IRQHandler ( void   )

This function handles DMA2 Stream 5 interrupt request.

Parameters:
None
Return values:
None

Definition at line 2211 of file stm32f769i_discovery_audio.c.

void AUDIO_OUT_SAIx_DMAx_IRQHandler ( void   )

This function handles DMA2 Stream 1 interrupt request.

Parameters:
None
Return values:
None

Definition at line 2221 of file stm32f769i_discovery_audio.c.

uint8_t BSP_AUDIO_IN_AllocScratch ( int32_t *  pScratch,
uint32_t  size 
)

Allocate channel buffer scratch.

Parameters:
pScratch: pointer to scratch tables.
sizeof scratch buffer

Definition at line 1204 of file stm32f769i_discovery_audio.c.

__weak void BSP_AUDIO_IN_ClockConfig ( DFSDM_Filter_HandleTypeDef *  hdfsdm_filter,
uint32_t  AudioFreq,
void *  Params 
)

Clock Config.

Parameters:
hdfsdm_filter,:might be required to set audio peripheral predivider if any.
AudioFreq,:Audio frequency used to play the audio stream.
Params
Note:
This API is called by BSP_AUDIO_IN_Init() Being __weak it can be overwritten by the application
Return values:
None

Definition at line 1690 of file stm32f769i_discovery_audio.c.

void BSP_AUDIO_IN_DeInit ( void   )

Deinit the audio IN peripherals.

Return values:
None

Definition at line 1420 of file stm32f769i_discovery_audio.c.

__weak void BSP_AUDIO_IN_Error_CallBack ( void   )

Audio IN Error callback function.

Return values:
None

Definition at line 1637 of file stm32f769i_discovery_audio.c.

uint8_t BSP_AUDIO_IN_GetChannelNumber ( void   )

Return audio in channel number.

Return values:
Numberof channel

Definition at line 1223 of file stm32f769i_discovery_audio.c.

__weak void BSP_AUDIO_IN_HalfTransfer_CallBack ( void   )

Manages the DMA Half Transfer complete event.

Return values:
None

Definition at line 1626 of file stm32f769i_discovery_audio.c.

uint8_t BSP_AUDIO_IN_Init ( uint32_t  AudioFreq,
uint32_t  BitRes,
uint32_t  ChnlNbr 
)

Initialize wave recording.

Parameters:
AudioFreq,:Audio frequency to be configured for the DFSDM peripheral.
BitRes,:Audio frequency to be configured for the DFSDM peripheral.
ChnlNbr,:Audio frequency to be configured for the DFSDM peripheral.
Return values:
AUDIO_OKif correct communication, else wrong communication

Definition at line 1127 of file stm32f769i_discovery_audio.c.

uint8_t BSP_AUDIO_IN_InitEx ( uint16_t  InputDevice,
uint32_t  AudioFreq,
uint32_t  BitRes,
uint32_t  ChnlNbr 
)

Initialize wave recording.

Parameters:
InputDevice,:INPUT_DEVICE_DIGITAL_MIC or INPUT_DEVICE_ANALOG_MIC.
AudioFreq,:Audio frequency to be configured.
BitRes,:Audio bit resolution to be configured..
ChnlNbr,:Number of channel to be configured.
Return values:
AUDIO_OKif correct communication, else wrong communication

Definition at line 1140 of file stm32f769i_discovery_audio.c.

__weak void BSP_AUDIO_IN_MspDeInit ( void   )

DeInitialize BSP_AUDIO_IN MSP.

Return values:
None

Definition at line 1666 of file stm32f769i_discovery_audio.c.

__weak void BSP_AUDIO_IN_MspInit ( void   )

Initialize BSP_AUDIO_IN MSP.

Return values:
None

Definition at line 1647 of file stm32f769i_discovery_audio.c.

uint8_t BSP_AUDIO_IN_Pause ( void   )

Pause the audio file stream.

Return values:
AUDIO_OKif correct communication, else wrong communication

Definition at line 1348 of file stm32f769i_discovery_audio.c.

uint8_t BSP_AUDIO_IN_Record ( uint16_t *  pbuf,
uint32_t  size 
)

Start audio recording.

Parameters:
pbuf,:Main buffer pointer for the recorded data storing
size,:Current size of the recorded buffer
Return values:
AUDIO_OKif correct communication, else wrong communication

Definition at line 1234 of file stm32f769i_discovery_audio.c.

uint8_t BSP_AUDIO_IN_Resume ( void   )

Resume the audio file stream.

Return values:
AUDIO_OKif correct communication, else wrong communication

Definition at line 1384 of file stm32f769i_discovery_audio.c.

uint8_t BSP_AUDIO_IN_Stop ( void   )

Stop audio recording.

Return values:
AUDIO_OKif correct communication, else wrong communication

Definition at line 1287 of file stm32f769i_discovery_audio.c.

__weak void BSP_AUDIO_IN_TransferComplete_CallBack ( void   )

User callback when record buffer is filled.

Return values:
None

Definition at line 1615 of file stm32f769i_discovery_audio.c.

static void DFSDMx_ChannelMspDeInit ( void   ) [static]

DeInitialize the DFSDM channel MSP.

Return values:
None

Definition at line 2046 of file stm32f769i_discovery_audio.c.

static void DFSDMx_ChannelMspInit ( void   ) [static]

Initialize the DFSDM channel MSP.

Return values:
None

Definition at line 2009 of file stm32f769i_discovery_audio.c.

static uint8_t DFSDMx_DeInit ( void   ) [static]

De-initialize the Digital Filter for Sigma-Delta Modulators interface (DFSDM).

Return values:
AUDIO_OKif correct communication, else wrong communication

Definition at line 1953 of file stm32f769i_discovery_audio.c.

static void DFSDMx_FilterMspDeInit ( void   ) [static]

DeInitialize the DFSDM filter MSP.

Return values:
None

Definition at line 2184 of file stm32f769i_discovery_audio.c.

static void DFSDMx_FilterMspInit ( void   ) [static]

Initialize the DFSDM filter MSP.

Return values:
None

Definition at line 2070 of file stm32f769i_discovery_audio.c.

static uint8_t DFSDMx_Init ( uint32_t  AudioFreq ) [static]

Initialize the Digital Filter for Sigma-Delta Modulators interface (DFSDM).

Parameters:
AudioFreq,:Audio frequency to be used to set correctly the DFSDM peripheral.
Note:
Channel output Clock Divider and Filter Oversampling are calculated as follow:
  • Clock_Divider = CLK(input DFSDM)/CLK(micro) with 1MHZ < CLK(micro) < 3.2MHZ (TYP 2.4MHZ for MP34DT01TR)
  • Oversampling = CLK(input DFSDM)/(Clock_Divider * AudioFreq)
Return values:
AUDIO_OKif correct communication, else wrong communication

Definition at line 1743 of file stm32f769i_discovery_audio.c.

void HAL_DFSDM_FilterRegConvCpltCallback ( DFSDM_Filter_HandleTypeDef *  hdfsdm_filter )

Regular conversion complete callback.

Note:
In interrupt mode, user has to read conversion value in this function using HAL_DFSDM_FilterGetRegularValue.
Parameters:
hdfsdm_filter: DFSDM filter handle.
Return values:
None

Definition at line 1441 of file stm32f769i_discovery_audio.c.

void HAL_DFSDM_FilterRegConvHalfCpltCallback ( DFSDM_Filter_HandleTypeDef *  hdfsdm_filter )

Half regular conversion complete callback.

Parameters:
hdfsdm_filter: DFSDM filter handle.
Return values:
None

Definition at line 1517 of file stm32f769i_discovery_audio.c.

void HAL_SAI_RxCpltCallback ( SAI_HandleTypeDef *  hsai )

Reception complete callback.

Parameters:
hsai: SAI handle.
Return values:
None

Definition at line 1605 of file stm32f769i_discovery_audio.c.

void HAL_SAI_RxHalfCpltCallback ( SAI_HandleTypeDef *  hsai )

Half reception complete callback.

Parameters:
hsai: SAI handle.
Return values:
None

Definition at line 1593 of file stm32f769i_discovery_audio.c.