stm32l4r9i_eval_audio.h File Reference

This file contains the common defines and functions prototypes for the stm32l4r9i_eval_audio.c driver. More...

#include <stdlib.h> #include "../Components/wm8994/wm8994.h"
#include "stm32l4r9i_eval.h"

Go to the source code of this file.

Defines
#define	BSP_AUDIO_OUT_CIRCULARMODE   ((uint32_t)0x00000001) /* BUFFER CIRCULAR MODE */
#define	BSP_AUDIO_OUT_NORMALMODE   ((uint32_t)0x00000002) /* BUFFER NORMAL MODE */
#define	BSP_AUDIO_OUT_STEREOMODE   ((uint32_t)0x00000004) /* STEREO MODE */
#define	BSP_AUDIO_OUT_MONOMODE   ((uint32_t)0x00000008) /* MONO MODE */
#define	BSP_AUDIO_FREQUENCY_96K   SAI_AUDIO_FREQUENCY_96K
#define	BSP_AUDIO_FREQUENCY_48K   SAI_AUDIO_FREQUENCY_48K
#define	BSP_AUDIO_FREQUENCY_44K   SAI_AUDIO_FREQUENCY_44K
#define	BSP_AUDIO_FREQUENCY_32K   SAI_AUDIO_FREQUENCY_32K
#define	BSP_AUDIO_FREQUENCY_22K   SAI_AUDIO_FREQUENCY_22K
#define	BSP_AUDIO_FREQUENCY_16K   SAI_AUDIO_FREQUENCY_16K
#define	BSP_AUDIO_FREQUENCY_11K   SAI_AUDIO_FREQUENCY_11K
#define	BSP_AUDIO_FREQUENCY_8K   SAI_AUDIO_FREQUENCY_8K
#define	AUDIO_SAIx   SAI1_Block_A
#define	AUDIO_SAIx_CLK_ENABLE()   __HAL_RCC_SAI1_CLK_ENABLE()
#define	AUDIO_SAIx_CLK_DISABLE()   __HAL_RCC_SAI1_CLK_DISABLE()
#define	AUDIO_SAIx_MCK_SCK_SD_FS_AF   GPIO_AF13_SAI1
#define	AUDIO_SAIx_MCK_CLK_ENABLE()   __HAL_RCC_GPIOB_CLK_ENABLE()
#define	AUDIO_SAIx_MCK_CLK_DISABLE()   __HAL_RCC_GPIOB_CLK_DISABLE()
#define	AUDIO_SAIx_MCK_PIN   GPIO_PIN_8
#define	AUDIO_SAIx_MCK_GPIO_PORT   GPIOB
#define	AUDIO_SAIx_FS_CLK_ENABLE()   __HAL_RCC_GPIOB_CLK_ENABLE()
#define	AUDIO_SAIx_FS_CLK_DISABLE()   __HAL_RCC_GPIOB_CLK_DISABLE()
#define	AUDIO_SAIx_FS_PIN   GPIO_PIN_9
#define	AUDIO_SAIx_FS_GPIO_PORT   GPIOB
#define	AUDIO_SAIx_SCK_CLK_ENABLE()   __HAL_RCC_GPIOA_CLK_ENABLE()
#define	AUDIO_SAIx_SCK_CLK_DISABLE()   __HAL_RCC_GPIOA_CLK_DISABLE()
#define	AUDIO_SAIx_SCK_PIN   GPIO_PIN_8
#define	AUDIO_SAIx_SCK_GPIO_PORT   GPIOA
#define	AUDIO_SAIx_SD_CLK_ENABLE()   __HAL_RCC_GPIOC_CLK_ENABLE()
#define	AUDIO_SAIx_SD_CLK_DISABLE()   __HAL_RCC_GPIOC_CLK_DISABLE()
#define	AUDIO_SAIx_SD_PIN   GPIO_PIN_1
#define	AUDIO_SAIx_SD_GPIO_PORT   GPIOC
#define	AUDIO_SAIx_DMAx_CLK_ENABLE()   __HAL_RCC_DMA2_CLK_ENABLE()
#define	AUDIO_SAIx_DMAx_CLK_DISABLE()   __HAL_RCC_DMA2_CLK_DISABLE()
#define	AUDIO_SAIx_DMAx_REQUEST   DMA_REQUEST_SAI1_A
#define	AUDIO_SAIx_DMAx_CHANNEL   DMA2_Channel2
#define	AUDIO_SAIx_DMAx_IRQ   DMA2_Channel2_IRQn
#define	AUDIO_SAIx_DMAx_PERIPH_DATA_SIZE   DMA_PDATAALIGN_HALFWORD
#define	AUDIO_SAIx_DMAx_MEM_DATA_SIZE   DMA_MDATAALIGN_HALFWORD
#define	DMA_MAX_SZE   (uint32_t)0xFFFF
#define	AUDIO_SAIx_DMAx_IRQHandler   DMA2_Channel2_IRQHandler
#define	AUDIO_OUT_IRQ_PREPRIO   5 /* Select the preemption priority level(0 is the highest) */
#define	AUDIO_SAIx_PLL_DISABLE()   HAL_RCCEx_DisablePLLSAI1()
#define	AUDIO_DFSDMx_LEFT_CHANNEL   DFSDM1_Channel4
#define	AUDIO_DFSDMx_RIGHT_CHANNEL   DFSDM1_Channel3
#define	AUDIO_DFSDMx_LEFT_FILTER   DFSDM1_Filter0
#define	AUDIO_DFSDMx_RIGHT_FILTER   DFSDM1_Filter1
#define	AUDIO_DFSDMx_CLK_ENABLE()   __HAL_RCC_DFSDM1_CLK_ENABLE()
#define	AUDIO_DFSDMx_CLK_DISABLE()   __HAL_RCC_DFSDM1_CLK_DISABLE()
#define	AUDIO_DFSDMx_CKOUT_DATIN_AF   GPIO_AF6_DFSDM1
#define	AUDIO_DFSDMx_CKOUT_CLK_ENABLE()   __HAL_RCC_GPIOF_CLK_ENABLE()
#define	AUDIO_DFSDMx_CKOUT_CLK_DISABLE()   __HAL_RCC_GPIOF_CLK_DISABLE()
#define	AUDIO_DFSDMx_CKOUT_PIN   GPIO_PIN_10
#define	AUDIO_DFSDMx_CKOUT_GPIO_PORT   GPIOF
#define	AUDIO_DFSDMx_DATIN_CLK_ENABLE()   __HAL_RCC_GPIOC_CLK_ENABLE()
#define	AUDIO_DFSDMx_DATIN_CLK_DISABLE()   __HAL_RCC_GPIOC_CLK_DISABLE()
#define	AUDIO_DFSDMx_DATIN_PIN   GPIO_PIN_0
#define	AUDIO_DFSDMx_DATIN_GPIO_PORT   GPIOC
#define	AUDIO_DFSDMx_DMAx_CLK_ENABLE()   __HAL_RCC_DMA1_CLK_ENABLE()
#define	AUDIO_DFSDMx_DMAx_CLK_DISABLE()   __HAL_RCC_DMA1_CLK_DISABLE()
#define	AUDIO_DFSDMx_DMAx_LEFT_CHANNEL   DMA1_Channel4
#define	AUDIO_DFSDMx_DMAx_RIGHT_CHANNEL   DMA1_Channel5
#define	AUDIO_DFSDMx_DMAx_LEFT_IRQ   DMA1_Channel4_IRQn
#define	AUDIO_DFSDMx_DMAx_RIGHT_IRQ   DMA1_Channel5_IRQn
#define	AUDIO_DFSDMx_DMAx_LEFT_REQUEST   DMA_REQUEST_DFSDM1_FLT0
#define	AUDIO_DFSDMx_DMAx_RIGHT_REQUEST   DMA_REQUEST_DFSDM1_FLT1
#define	AUDIO_DFSDMx_DMAx_PERIPH_DATA_SIZE   DMA_PDATAALIGN_WORD
#define	AUDIO_DFSDMx_DMAx_MEM_DATA_SIZE   DMA_MDATAALIGN_WORD
#define	AUDIO_DFSDM_DMAx_LEFT_IRQHandler   DMA1_Channel4_IRQHandler
#define	AUDIO_DFSDM_DMAx_RIGHT_IRQHandler   DMA1_Channel5_IRQHandler
#define	AUDIO_IN_IRQ_PREPRIO   6 /* Select the preemption priority level(0 is the highest) */
#define	AUDIODATA_SIZE   2 /* 16-bits audio data size */
#define	AUDIO_OK   0
#define	AUDIO_ERROR   1
#define	AUDIO_TIMEOUT   2
#define	DEFAULT_AUDIO_IN_FREQ   BSP_AUDIO_FREQUENCY_16K
#define	DEFAULT_AUDIO_IN_BIT_RESOLUTION   16
#define	DEFAULT_AUDIO_IN_CHANNEL_NBR   2 /* Mono = 1, Stereo = 2 */
#define	DEFAULT_AUDIO_IN_VOLUME   64
#define	INTERNAL_BUFF_SIZE   256
#define	CODEC_RESET_DELAY   5
#define	DMA_MAX(_X_)   (((_X_) <= DMA_MAX_SZE)? (_X_):DMA_MAX_SZE)
Typedefs
typedef void(*	Audio_CallbackTypeDef )(void)
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_DeInit (void)
	De-Initializes audio codec related peripherals.
uint8_t	BSP_AUDIO_OUT_Play (uint16_t *pData, uint32_t Size)
	Starts playing audio stream from a data buffer for a determined size.
uint8_t	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_SetFrequency (uint32_t AudioFreq)
	Update the audio frequency.
void	BSP_AUDIO_OUT_ChangeAudioConfig (uint32_t AudioOutOption)
	Changes the Audio Out Configuration.
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 played) the output target (speaker or headphone).
void	BSP_AUDIO_OUT_RegisterCallbacks (Audio_CallbackTypeDef ErrorCallback, Audio_CallbackTypeDef HalfTransferCallback, Audio_CallbackTypeDef TransferCompleteCallback)
	register user callback functions
uint8_t	BSP_AUDIO_IN_Init (uint32_t AudioFreq, uint32_t BitRes, uint32_t ChnlNbr)
	Initializes wave recording.
uint8_t	BSP_AUDIO_IN_DeInit (void)
	De-Initializes microphone related peripherals.
uint8_t	BSP_AUDIO_IN_Record (uint16_t *pbuf, uint32_t size)
	Starts audio recording.
uint8_t	BSP_AUDIO_IN_SetFrequency (uint32_t AudioFreq)
	Updates the audio frequency.
uint8_t	BSP_AUDIO_IN_Stop (void)
	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.
void	BSP_AUDIO_IN_RegisterCallbacks (Audio_CallbackTypeDef ErrorCallback, Audio_CallbackTypeDef HalfTransferCallback, Audio_CallbackTypeDef TransferCompleteCallback)
	register user callback functions
Variables
SAI_HandleTypeDef	BSP_AUDIO_hSai
DFSDM_Filter_HandleTypeDef	BSP_AUDIO_hDfsdmLeftFilter
DFSDM_Filter_HandleTypeDef	BSP_AUDIO_hDfsdmRightFilter

---

Detailed Description

This file contains the common defines and functions prototypes for the stm32l4r9i_eval_audio.c driver.

Author:

MCD Application Team

Attention:

© COPYRIGHT(c) 2017 STMicroelectronics

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of STMicroelectronics nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file stm32l4r9i_eval_audio.h.