STM32746G-Discovery board drivers V1.0.0

Dependents:   F746_SD_GraphicEqualizer_ren0620

Fork of BSP_DISCO_F746NG by ST

Embed: (wiki syntax)

« Back to documentation index

STM32746G_DISCOVERY_AUDIO Out Private Functions

STM32746G_DISCOVERY_AUDIO Out Private Functions
[STM32746G_DISCOVERY AUDIO]

Functions

uint8_t BSP_AUDIO_IN_Init (uint16_t InputDevice, uint8_t Volume, uint32_t AudioFreq)
 Initializes wave recording.
uint8_t BSP_AUDIO_IN_OUT_Init (uint16_t InputDevice, uint16_t OutputDevice, uint8_t Volume, uint32_t AudioFreq)
 Initializes wave recording and playback in parallel.
uint8_t BSP_AUDIO_IN_Record (uint16_t *pbuf, uint32_t size)
 Starts audio recording.
uint8_t BSP_AUDIO_IN_Stop (uint32_t Option)
 Stops audio recording.
uint8_t BSP_AUDIO_IN_Pause (void)
 Pauses the audio file stream.
uint8_t BSP_AUDIO_IN_Resume (void)
 Resumes the audio file stream.
uint8_t BSP_AUDIO_IN_SetVolume (uint8_t Volume)
 Controls the audio in volume level.
void BSP_AUDIO_IN_DeInit (void)
 Deinit the audio IN peripherals.
void HAL_SAI_RxCpltCallback (SAI_HandleTypeDef *hsai)
 Rx Transfer completed callbacks.
void HAL_SAI_RxHalfCpltCallback (SAI_HandleTypeDef *hsai)
 Rx Half Transfer completed callbacks.
__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 (SAI_HandleTypeDef *hsai, void *Params)
 Initializes BSP_AUDIO_IN MSP.
__weak void BSP_AUDIO_IN_MspDeInit (SAI_HandleTypeDef *hsai, void *Params)
 DeInitializes BSP_AUDIO_IN MSP.
static void SAIx_In_Init (uint32_t SaiOutMode, uint32_t SlotActive, uint32_t AudioFreq)
 Initializes the input Audio Codec audio interface (SAI).
static void SAIx_In_DeInit (void)
 Deinitializes the output Audio Codec audio interface (SAI).
static void AUDIO_IN_INT_IRQHandler (void)
 This function handles External line 15_10 interrupt request.
static void AUDIO_IN_SAIx_DMAx_IRQHandler (void)
 This function handles DMA2 Stream 7 interrupt request.
static void AUDIO_OUT_SAIx_DMAx_IRQHandler (void)
 This function handles DMA2 Stream 6 interrupt request.

Function Documentation

static void AUDIO_IN_INT_IRQHandler ( void   ) [static]

This function handles External line 15_10 interrupt request.

Parameters:
None
Return values:
None

Definition at line 1379 of file stm32746g_discovery_audio.c.

static void AUDIO_IN_SAIx_DMAx_IRQHandler ( void   ) [static]

This function handles DMA2 Stream 7 interrupt request.

Parameters:
None
Return values:
None

Definition at line 1393 of file stm32746g_discovery_audio.c.

static void AUDIO_OUT_SAIx_DMAx_IRQHandler ( void   ) [static]

This function handles DMA2 Stream 6 interrupt request.

Parameters:
None
Return values:
None

Definition at line 1403 of file stm32746g_discovery_audio.c.

void BSP_AUDIO_IN_DeInit ( void   )

Deinit the audio IN peripherals.

Return values:
None

Definition at line 1057 of file stm32746g_discovery_audio.c.

__weak void BSP_AUDIO_IN_Error_CallBack ( void   )

Audio IN Error callback function.

Return values:
None

Definition at line 1113 of file stm32746g_discovery_audio.c.

__weak void BSP_AUDIO_IN_HalfTransfer_CallBack ( void   )

Manages the DMA Half Transfer complete event.

Return values:
None

Definition at line 1102 of file stm32746g_discovery_audio.c.

uint8_t BSP_AUDIO_IN_Init ( uint16_t  InputDevice,
uint8_t  Volume,
uint32_t  AudioFreq 
)

Initializes wave recording.

Parameters:
InputDevice,:INPUT_DEVICE_DIGITAL_MICROPHONE_2 or INPUT_DEVICE_INPUT_LINE_1
Volume,:Initial volume level (in range 0(Mute)..80(+0dB)..100(+17.625dB))
AudioFreq,:Audio frequency to be configured for the SAI peripheral.
Return values:
AUDIO_OKif correct communication, else wrong communication

Definition at line 803 of file stm32746g_discovery_audio.c.

__weak void BSP_AUDIO_IN_MspDeInit ( SAI_HandleTypeDef *  hsai,
void *  Params 
)

DeInitializes BSP_AUDIO_IN MSP.

Parameters:
hsai,:SAI handle
Params
Return values:
None

Definition at line 1216 of file stm32746g_discovery_audio.c.

__weak void BSP_AUDIO_IN_MspInit ( SAI_HandleTypeDef *  hsai,
void *  Params 
)

Initializes BSP_AUDIO_IN MSP.

Parameters:
hsai,:SAI handle
Params
Return values:
None

Definition at line 1125 of file stm32746g_discovery_audio.c.

uint8_t BSP_AUDIO_IN_OUT_Init ( uint16_t  InputDevice,
uint16_t  OutputDevice,
uint8_t  Volume,
uint32_t  AudioFreq 
)

Initializes wave recording and playback in parallel.

Parameters:
InputDevice,:INPUT_DEVICE_DIGITAL_MICROPHONE_2
OutputDevice,:OUTPUT_DEVICE_SPEAKER, OUTPUT_DEVICE_HEADPHONE, or OUTPUT_DEVICE_BOTH.
Volume,:Initial volume level (in range 0(Mute)..80(+0dB)..100(+17.625dB))
AudioFreq,:Audio frequency to be configured for the SAI peripheral.
Return values:
AUDIO_OKif correct communication, else wrong communication

Definition at line 880 of file stm32746g_discovery_audio.c.

uint8_t BSP_AUDIO_IN_Pause ( void   )

Pauses the audio file stream.

Return values:
AUDIO_OKif correct communication, else wrong communication

Definition at line 1012 of file stm32746g_discovery_audio.c.

uint8_t BSP_AUDIO_IN_Record ( uint16_t *  pbuf,
uint32_t  size 
)

Starts audio recording.

Parameters:
pbuf,:Main buffer pointer for the recorded data storing
size,:size of the recorded buffer in number of elements (typically number of half-words) Be careful that it is not the same unit than BSP_AUDIO_OUT_Play function
Return values:
AUDIO_OKif correct communication, else wrong communication

Definition at line 964 of file stm32746g_discovery_audio.c.

uint8_t BSP_AUDIO_IN_Resume ( void   )

Resumes the audio file stream.

Return values:
AUDIO_OKif correct communication, else wrong communication

Definition at line 1024 of file stm32746g_discovery_audio.c.

uint8_t BSP_AUDIO_IN_SetVolume ( uint8_t  Volume )

Controls the audio in volume level.

Parameters:
Volume,:Volume level in range 0(Mute)..80(+0dB)..100(+17.625dB)
Return values:
AUDIO_OKif correct communication, else wrong communication

Definition at line 1037 of file stm32746g_discovery_audio.c.

uint8_t BSP_AUDIO_IN_Stop ( uint32_t  Option )

Stops audio recording.

Parameters:
Option,:could be one of the following parameters

  • CODEC_PDWN_SW: for software power off (by writing registers). Then no need to reconfigure the Codec after power on.
  • CODEC_PDWN_HW: completely shut down the codec (physically). Then need to reconfigure the Codec after power on.
Return values:
AUDIO_OKif correct communication, else wrong communication

Definition at line 986 of file stm32746g_discovery_audio.c.

__weak void BSP_AUDIO_IN_TransferComplete_CallBack ( void   )

User callback when record buffer is filled.

Return values:
None

Definition at line 1091 of file stm32746g_discovery_audio.c.

void HAL_SAI_RxCpltCallback ( SAI_HandleTypeDef *  hsai )

Rx Transfer completed callbacks.

Parameters:
hsai,:SAI handle
Return values:
None

Definition at line 1069 of file stm32746g_discovery_audio.c.

void HAL_SAI_RxHalfCpltCallback ( SAI_HandleTypeDef *  hsai )

Rx Half Transfer completed callbacks.

Parameters:
hsai,:SAI handle
Return values:
None

Definition at line 1080 of file stm32746g_discovery_audio.c.

static void SAIx_In_DeInit ( void   ) [static]

Deinitializes the output Audio Codec audio interface (SAI).

Return values:
None

Definition at line 1363 of file stm32746g_discovery_audio.c.

static void SAIx_In_Init ( uint32_t  SaiOutMode,
uint32_t  SlotActive,
uint32_t  AudioFreq 
) [static]

Initializes the input Audio Codec audio interface (SAI).

Parameters:
SaiOutMode,:SAI_MODEMASTER_TX (for record and playback in parallel) or SAI_MODEMASTER_RX (for record only).
SlotActive,:CODEC_AUDIOFRAME_SLOT_02 or CODEC_AUDIOFRAME_SLOT_13
AudioFreq,:Audio frequency to be configured for the SAI peripheral.
Return values:
None

Definition at line 1258 of file stm32746g_discovery_audio.c.