STM32469I-Discovery BSP User Manual
|
Functions | |
uint8_t | BSP_AUDIO_OUT_Init (uint16_t OutputDevice, uint8_t Volume, uint32_t AudioFreq) |
Configures the audio peripherals. | |
uint8_t | BSP_AUDIO_OUT_Play (uint16_t *pBuffer, uint32_t Size) |
Starts playing audio stream from a data buffer for a determined size. | |
void | BSP_AUDIO_OUT_ChangeBuffer (uint16_t *pData, uint16_t Size) |
Sends n-Bytes on the SAI interface. | |
uint8_t | BSP_AUDIO_OUT_Pause (void) |
This function Pauses the audio file stream. | |
uint8_t | BSP_AUDIO_OUT_Resume (void) |
This function Resumes the audio file stream. | |
uint8_t | BSP_AUDIO_OUT_Stop (uint32_t Option) |
Stops audio playing and Power down the Audio Codec. | |
uint8_t | BSP_AUDIO_OUT_SetVolume (uint8_t Volume) |
Controls the current audio volume level. | |
uint8_t | BSP_AUDIO_OUT_SetMute (uint32_t Cmd) |
Enables or disables the MUTE mode by software. | |
uint8_t | BSP_AUDIO_OUT_SetOutputMode (uint8_t Output) |
Switch dynamically (while audio file is being played) the output target (speaker or headphone). | |
void | BSP_AUDIO_OUT_SetFrequency (uint32_t AudioFreq) |
Updates the audio frequency. | |
void | BSP_AUDIO_OUT_SetAudioFrameSlot (uint32_t AudioFrameSlot) |
Updates the Audio frame slot configuration. | |
void | BSP_AUDIO_OUT_DeInit (void) |
Deinit the audio peripherals. | |
void | HAL_SAI_TxCpltCallback (SAI_HandleTypeDef *hsai) |
Tx Transfer completed callbacks. | |
void | HAL_SAI_TxHalfCpltCallback (SAI_HandleTypeDef *hsai) |
Tx Half Transfer completed callbacks. | |
void | HAL_SAI_ErrorCallback (SAI_HandleTypeDef *hsai) |
SAI error callbacks. | |
__weak void | BSP_AUDIO_OUT_TransferComplete_CallBack (void) |
Manages the DMA full Transfer complete event. | |
__weak void | BSP_AUDIO_OUT_HalfTransfer_CallBack (void) |
Manages the DMA Half Transfer complete event. | |
__weak void | BSP_AUDIO_OUT_Error_CallBack (void) |
Manages the DMA FIFO error event. | |
__weak void | BSP_AUDIO_OUT_MspInit (SAI_HandleTypeDef *hsai, void *Params) |
Initializes BSP_AUDIO_OUT MSP. | |
__weak void | BSP_AUDIO_OUT_MspDeInit (SAI_HandleTypeDef *hsai, void *Params) |
Deinitializes BSP_AUDIO_OUT MSP. | |
__weak void | BSP_AUDIO_OUT_ClockConfig (SAI_HandleTypeDef *hsai, uint32_t AudioFreq, void *Params) |
Clock Config. | |
void | BSP_AUDIO_OUT_ChangeAudioConfig (uint32_t AudioOutOption) |
Changes the Audio Out Configuration. | |
static uint8_t | SAIx_Init (uint32_t AudioFreq) |
Initializes the Audio Codec audio interface (SAI). |
Function Documentation
void BSP_AUDIO_OUT_ChangeAudioConfig | ( | uint32_t | AudioOutOption | ) |
Changes the Audio Out Configuration.
- Parameters:
-
AudioOutOption,: specifies the audio out new configuration This parameter can be any value of BSP AUDIO OUT Option
- Note:
- This API should be called after the BSP_AUDIO_OUT_Init() to adjust the audio out configuration.
Definition at line 513 of file stm32469i_discovery_audio.c.
References BSP_AUDIO_OUT_CIRCULARMODE, BSP_AUDIO_OUT_STEREOMODE, and haudio_out_sai.
void BSP_AUDIO_OUT_ChangeBuffer | ( | uint16_t * | pData, |
uint16_t | Size | ||
) |
Sends n-Bytes on the SAI interface.
- Parameters:
-
pData,: pointer on PCM samples buffer Size,: number of data to be written
Definition at line 319 of file stm32469i_discovery_audio.c.
References haudio_out_sai.
__weak void BSP_AUDIO_OUT_ClockConfig | ( | SAI_HandleTypeDef * | hsai, |
uint32_t | AudioFreq, | ||
void * | Params | ||
) |
Clock Config.
- Parameters:
-
hsai,: might be required to set audio peripheral predivider if any. AudioFreq,: Audio frequency used to play the audio stream.
- Note:
- This API is called by BSP_AUDIO_OUT_Init() and BSP_AUDIO_OUT_SetFrequency() Being __weak it can be overwritten by the application
- Parameters:
-
Params : pointer on additional configuration parameters, can be NULL.
Definition at line 780 of file stm32469i_discovery_audio.c.
Referenced by BSP_AUDIO_OUT_Init(), and BSP_AUDIO_OUT_SetFrequency().
void BSP_AUDIO_OUT_DeInit | ( | void | ) |
Deinit the audio peripherals.
Definition at line 589 of file stm32469i_discovery_audio.c.
References audio_drv, BSP_AUDIO_OUT_MspDeInit(), haudio_out_sai, and SAIx_DeInit().
__weak void BSP_AUDIO_OUT_Error_CallBack | ( | void | ) |
Manages the DMA FIFO error event.
Definition at line 647 of file stm32469i_discovery_audio.c.
Referenced by HAL_SAI_ErrorCallback().
__weak void BSP_AUDIO_OUT_HalfTransfer_CallBack | ( | void | ) |
Manages the DMA Half Transfer complete event.
Definition at line 640 of file stm32469i_discovery_audio.c.
Referenced by HAL_SAI_TxHalfCpltCallback().
uint8_t BSP_AUDIO_OUT_Init | ( | uint16_t | OutputDevice, |
uint8_t | Volume, | ||
uint32_t | AudioFreq | ||
) |
Configures the audio peripherals.
- Parameters:
-
OutputDevice,: OUTPUT_DEVICE_SPEAKER, OUTPUT_DEVICE_HEADPHONE, or OUTPUT_DEVICE_BOTH. Volume,: Initial volume level (from 0 (Mute) to 100 (Max)) AudioFreq,: Audio frequency used to play the audio stream.
- Note:
- The SAI PLL input clock must be done in the user application.
- Return values:
-
AUDIO_OK if correct communication, else wrong communication
Definition at line 232 of file stm32469i_discovery_audio.c.
References audio_drv, AUDIO_ERROR, AUDIO_I2C_ADDRESS, AUDIO_OK, AUDIO_SAIx, BSP_AUDIO_OUT_ClockConfig(), BSP_AUDIO_OUT_MspInit(), haudio_out_sai, SAIx_DeInit(), and SAIx_Init().
__weak void BSP_AUDIO_OUT_MspDeInit | ( | SAI_HandleTypeDef * | hsai, |
void * | Params | ||
) |
Deinitializes BSP_AUDIO_OUT MSP.
- Parameters:
-
hsai,: SAI handle Params : pointer on additional configuration parameters, can be NULL.
Definition at line 734 of file stm32469i_discovery_audio.c.
References AUDIO_RESET_GPIO_PORT, AUDIO_RESET_PIN, AUDIO_SAIx, AUDIO_SAIx_CLK_DISABLE, AUDIO_SAIx_DMAx_IRQ, AUDIO_SAIx_FS_PIN, AUDIO_SAIx_MCK_PIN, AUDIO_SAIx_MCLK_GPIO_PORT, AUDIO_SAIx_SCK_PIN, AUDIO_SAIx_SCK_SD_FS_GPIO_PORT, and AUDIO_SAIx_SD_PIN.
Referenced by BSP_AUDIO_OUT_DeInit().
__weak void BSP_AUDIO_OUT_MspInit | ( | SAI_HandleTypeDef * | hsai, |
void * | Params | ||
) |
Initializes BSP_AUDIO_OUT MSP.
- Parameters:
-
hsai,: SAI handle Params : pointer on additional configuration parameters, can be NULL.
Definition at line 656 of file stm32469i_discovery_audio.c.
References AUDIO_OUT_IRQ_PREPRIO, AUDIO_RESET_ENABLE, AUDIO_RESET_GPIO_PORT, AUDIO_RESET_PIN, AUDIO_SAIx, AUDIO_SAIx_CLK_ENABLE, AUDIO_SAIx_DMAx_CHANNEL, AUDIO_SAIx_DMAx_CLK_ENABLE, AUDIO_SAIx_DMAx_IRQ, AUDIO_SAIx_DMAx_MEM_DATA_SIZE, AUDIO_SAIx_DMAx_PERIPH_DATA_SIZE, AUDIO_SAIx_DMAx_STREAM, AUDIO_SAIx_FS_PIN, AUDIO_SAIx_MCK_PIN, AUDIO_SAIx_MCLK_ENABLE, AUDIO_SAIx_MCLK_GPIO_PORT, AUDIO_SAIx_MCLK_SCK_SD_FS_AF, AUDIO_SAIx_SCK_PIN, AUDIO_SAIx_SCK_SD_FS_ENABLE, AUDIO_SAIx_SCK_SD_FS_GPIO_PORT, and AUDIO_SAIx_SD_PIN.
Referenced by BSP_AUDIO_OUT_Init().
uint8_t BSP_AUDIO_OUT_Pause | ( | void | ) |
This function Pauses the audio file stream.
In case of using DMA, the DMA Pause feature is used.
- Warning:
- When calling BSP_AUDIO_OUT_Pause() function for pause, only BSP_AUDIO_OUT_Resume() function should be called for resume (use of BSP_AUDIO_OUT_Play() function for resume could lead to unexpected behavior).
- Return values:
-
AUDIO_OK if correct communication, else wrong communication
Definition at line 332 of file stm32469i_discovery_audio.c.
References audio_drv, AUDIO_ERROR, AUDIO_I2C_ADDRESS, AUDIO_OK, and haudio_out_sai.
uint8_t BSP_AUDIO_OUT_Play | ( | uint16_t * | pBuffer, |
uint32_t | Size | ||
) |
Starts playing audio stream from a data buffer for a determined size.
- Parameters:
-
pBuffer,: Pointer to the buffer Size,: Number of audio data BYTES.
- Return values:
-
AUDIO_OK if correct communication, else wrong communication
Definition at line 292 of file stm32469i_discovery_audio.c.
References audio_drv, AUDIO_ERROR, AUDIO_I2C_ADDRESS, AUDIO_OK, AUDIODATA_SIZE, DMA_MAX, and haudio_out_sai.
uint8_t BSP_AUDIO_OUT_Resume | ( | void | ) |
This function Resumes the audio file stream.
WARNING: When calling BSP_AUDIO_OUT_Pause() function for pause, only BSP_AUDIO_OUT_Resume() function should be called for resume (use of BSP_AUDIO_OUT_Play() function for resume could lead to unexpected behavior).
- Return values:
-
AUDIO_OK if correct communication, else wrong communication
Definition at line 363 of file stm32469i_discovery_audio.c.
References audio_drv, AUDIO_ERROR, AUDIO_I2C_ADDRESS, AUDIO_OK, and haudio_out_sai.
void BSP_AUDIO_OUT_SetAudioFrameSlot | ( | uint32_t | AudioFrameSlot | ) |
Updates the Audio frame slot configuration.
- Parameters:
-
AudioFrameSlot,: specifies the audio Frame slot This parameter can be any value of STM32469I Discovery Audio Slot TDM mode
- Note:
- This API should be called after the BSP_AUDIO_OUT_Init() to adjust the audio frame slot.
Definition at line 573 of file stm32469i_discovery_audio.c.
References haudio_out_sai.
void BSP_AUDIO_OUT_SetFrequency | ( | uint32_t | AudioFreq | ) |
Updates the audio frequency.
- Parameters:
-
AudioFreq,: Audio frequency used to play the audio stream.
- Note:
- This API should be called after the BSP_AUDIO_OUT_Init() to adjust the audio frequency.
Definition at line 490 of file stm32469i_discovery_audio.c.
References BSP_AUDIO_OUT_ClockConfig(), and haudio_out_sai.
uint8_t BSP_AUDIO_OUT_SetMute | ( | uint32_t | Cmd | ) |
Enables or disables the MUTE mode by software.
- Parameters:
-
Cmd,: Could be AUDIO_MUTE_ON to mute sound or AUDIO_MUTE_OFF to unmute the codec and restore previous volume level.
- Return values:
-
AUDIO_OK if correct communication, else wrong communication
Definition at line 449 of file stm32469i_discovery_audio.c.
References audio_drv, AUDIO_ERROR, AUDIO_I2C_ADDRESS, and AUDIO_OK.
uint8_t BSP_AUDIO_OUT_SetOutputMode | ( | uint8_t | Output | ) |
Switch dynamically (while audio file is being played) the output target (speaker or headphone).
- Parameters:
-
Output,: The audio output target: OUTPUT_DEVICE_SPEAKER, OUTPUT_DEVICE_HEADPHONE or OUTPUT_DEVICE_BOTH
- Return values:
-
AUDIO_OK if correct communication, else wrong communication
Definition at line 470 of file stm32469i_discovery_audio.c.
References audio_drv, AUDIO_ERROR, AUDIO_I2C_ADDRESS, and AUDIO_OK.
uint8_t BSP_AUDIO_OUT_SetVolume | ( | uint8_t | Volume | ) |
Controls the current audio volume level.
- Parameters:
-
Volume,: Volume level to be set in percentage from 0% to 100% (0 for Mute and 100 for Max volume level).
- Return values:
-
AUDIO_OK if correct communication, else wrong communication
Definition at line 429 of file stm32469i_discovery_audio.c.
References audio_drv, AUDIO_ERROR, AUDIO_I2C_ADDRESS, and AUDIO_OK.
uint8_t BSP_AUDIO_OUT_Stop | ( | uint32_t | Option | ) |
Stops audio playing and Power down the Audio Codec.
- 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_OK if correct communication, else wrong communication
Definition at line 395 of file stm32469i_discovery_audio.c.
References audio_drv, AUDIO_ERROR, AUDIO_I2C_ADDRESS, AUDIO_OK, and haudio_out_sai.
__weak void BSP_AUDIO_OUT_TransferComplete_CallBack | ( | void | ) |
Manages the DMA full Transfer complete event.
Definition at line 633 of file stm32469i_discovery_audio.c.
Referenced by HAL_SAI_TxCpltCallback().
void HAL_SAI_ErrorCallback | ( | SAI_HandleTypeDef * | hsai | ) |
SAI error callbacks.
- Parameters:
-
hsai,: SAI handle
Definition at line 625 of file stm32469i_discovery_audio.c.
References BSP_AUDIO_OUT_Error_CallBack().
void HAL_SAI_TxCpltCallback | ( | SAI_HandleTypeDef * | hsai | ) |
Tx Transfer completed callbacks.
- Parameters:
-
hsai,: SAI handle
Definition at line 603 of file stm32469i_discovery_audio.c.
References BSP_AUDIO_OUT_TransferComplete_CallBack().
void HAL_SAI_TxHalfCpltCallback | ( | SAI_HandleTypeDef * | hsai | ) |
Tx Half Transfer completed callbacks.
- Parameters:
-
hsai,: SAI handle
Definition at line 614 of file stm32469i_discovery_audio.c.
References BSP_AUDIO_OUT_HalfTransfer_CallBack().
static uint8_t SAIx_Init | ( | uint32_t | AudioFreq | ) | [static] |
Initializes the Audio Codec audio interface (SAI).
- Parameters:
-
AudioFreq,: Audio frequency to be configured for the SAI peripheral.
- Note:
- The default SlotActive configuration is set to CODEC_AUDIOFRAME_SLOT_0123 and user can update this configuration using
Definition at line 825 of file stm32469i_discovery_audio.c.
References AUDIO_ERROR, AUDIO_OK, AUDIO_SAIx, CODEC_AUDIOFRAME_SLOT_0123, and haudio_out_sai.
Referenced by BSP_AUDIO_OUT_Init().
Generated on Fri Jan 13 2017 11:00:15 for STM32469I-Discovery BSP User Manual by 1.7.6.1