stm32f401_discovery_audio.h File Reference

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

#include "../Components/cs43l22/cs43l22.h" #include "stm32f401_discovery.h"
#include "../../../Middlewares/ST/STM32_Audio/Addons/PDM/pdm_filter.h"

Go to the source code of this file.

Defines
#define	I2S3   SPI3
#define	I2S3_CLK_ENABLE()   __HAL_RCC_SPI3_CLK_ENABLE()
#define	I2S3_CLK_DISABLE()   __HAL_RCC_SPI3_CLK_DISABLE()
#define	I2S3_SCK_SD_WS_AF   GPIO_AF6_SPI3
#define	I2S3_SCK_SD_CLK_ENABLE()   __HAL_RCC_GPIOC_CLK_ENABLE()
#define	I2S3_MCK_CLK_ENABLE()   __HAL_RCC_GPIOC_CLK_ENABLE()
#define	I2S3_WS_CLK_ENABLE()   __HAL_RCC_GPIOA_CLK_ENABLE()
#define	I2S3_WS_PIN   GPIO_PIN_4
#define	I2S3_SCK_PIN   GPIO_PIN_10
#define	I2S3_SD_PIN   GPIO_PIN_12
#define	I2S3_MCK_PIN   GPIO_PIN_7
#define	I2S3_SCK_SD_GPIO_PORT   GPIOC
#define	I2S3_WS_GPIO_PORT   GPIOA
#define	I2S3_MCK_GPIO_PORT   GPIOC
#define	I2S3_DMAx_CLK_ENABLE()   __HAL_RCC_DMA1_CLK_ENABLE()
#define	I2S3_DMAx_CLK_DISABLE()   __HAL_RCC_DMA1_CLK_DISABLE()
#define	I2S3_DMAx_STREAM   DMA1_Stream7
#define	I2S3_DMAx_CHANNEL   DMA_CHANNEL_0
#define	I2S3_DMAx_IRQ   DMA1_Stream7_IRQn
#define	I2S3_DMAx_PERIPH_DATA_SIZE   DMA_PDATAALIGN_HALFWORD
#define	I2S3_DMAx_MEM_DATA_SIZE   DMA_MDATAALIGN_HALFWORD
#define	DMA_MAX_SZE   0xFFFF
#define	I2S3_IRQHandler   DMA1_Stream7_IRQHandler
#define	AUDIO_OUT_IRQ_PREPRIO   0x0E /* Select the preemption priority level(0 is the highest) */
#define	I2S2   SPI2
#define	I2S2_CLK_ENABLE()   __HAL_RCC_SPI2_CLK_ENABLE()
#define	I2S2_CLK_DISABLE()   __HAL_RCC_SPI2_CLK_DISABLE()
#define	I2S2_SCK_PIN   GPIO_PIN_10
#define	I2S2_SCK_GPIO_PORT   GPIOB
#define	I2S2_SCK_GPIO_CLK_ENABLE()   __HAL_RCC_GPIOB_CLK_ENABLE()
#define	I2S2_SCK_AF   GPIO_AF5_SPI2
#define	I2S2_MOSI_PIN   GPIO_PIN_3
#define	I2S2_MOSI_GPIO_PORT   GPIOC
#define	I2S2_MOSI_GPIO_CLK_ENABLE()   __HAL_RCC_GPIOC_CLK_ENABLE()
#define	I2S2_MOSI_AF   GPIO_AF5_SPI2
#define	I2S2_DMAx_CLK_ENABLE()   __HAL_RCC_DMA1_CLK_ENABLE()
#define	I2S2_DMAx_CLK_DISABLE()   __HAL_RCC_DMA1_CLK_DISABLE()
#define	I2S2_DMAx_STREAM   DMA1_Stream3
#define	I2S2_DMAx_CHANNEL   DMA_CHANNEL_0
#define	I2S2_DMAx_IRQ   DMA1_Stream3_IRQn
#define	I2S2_DMAx_PERIPH_DATA_SIZE   DMA_PDATAALIGN_HALFWORD
#define	I2S2_DMAx_MEM_DATA_SIZE   DMA_MDATAALIGN_HALFWORD
#define	I2S2_IRQHandler   DMA1_Stream3_IRQHandler
#define	AUDIO_IN_IRQ_PREPRIO   0x0F /* 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   I2S_AUDIOFREQ_16K
#define	DEFAULT_AUDIO_IN_BIT_RESOLUTION   16
#define	DEFAULT_AUDIO_IN_CHANNEL_NBR   1 /* Mono = 1, Stereo = 2 */
#define	DEFAULT_AUDIO_IN_VOLUME   64
#define	INTERNAL_BUFF_SIZE   128*DEFAULT_AUDIO_IN_FREQ/16000*DEFAULT_AUDIO_IN_CHANNEL_NBR
#define	PCM_OUT_SIZE   DEFAULT_AUDIO_IN_FREQ/1000
#define	CHANNEL_DEMUX_MASK   0x55
#define	DMA_MAX(_X_)   (((_X_) <= DMA_MAX_SZE)? (_X_):DMA_MAX_SZE)
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 I2S interface.
uint8_t	BSP_AUDIO_OUT_Pause (void)
	Pauses the audio file stream.
uint8_t	BSP_AUDIO_OUT_Resume (void)
	Resumes the audio file streaming.
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.
void	BSP_AUDIO_OUT_SetFrequency (uint32_t AudioFreq)
	Update the audio frequency.
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_TransferComplete_CallBack (void)
	Manages the DMA full Transfer complete event.
void	BSP_AUDIO_OUT_HalfTransfer_CallBack (void)
	Manages the DMA Half Transfer complete event.
void	BSP_AUDIO_OUT_Error_CallBack (void)
	Manages the DMA FIFO error event.
void	BSP_AUDIO_OUT_ClockConfig (I2S_HandleTypeDef *hi2s, uint32_t AudioFreq, void *Params)
	Clock Config.
void	BSP_AUDIO_OUT_MspInit (I2S_HandleTypeDef *hi2s, void *Params)
	AUDIO OUT I2S MSP Init.
void	BSP_AUDIO_OUT_MspDeInit (I2S_HandleTypeDef *hi2s, void *Params)
	De-Initializes BSP_AUDIO_OUT MSP.
uint8_t	BSP_AUDIO_IN_Init (uint32_t AudioFreq, uint32_t BitRes, uint32_t ChnlNbr)
	Initializes wave recording.
uint8_t	BSP_AUDIO_IN_Record (uint16_t *pData, uint32_t Size)
	Starts audio recording.
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.
uint8_t	BSP_AUDIO_IN_SetVolume (uint8_t Volume)
	Controls the audio in volume level.
uint8_t	BSP_AUDIO_IN_PDMToPCM (uint16_t *PDMBuf, uint16_t *PCMBuf)
	Converts audio format from PDM to PCM.
void	BSP_AUDIO_IN_TransferComplete_CallBack (void)
	User callback when record buffer is filled.
void	BSP_AUDIO_IN_HalfTransfer_CallBack (void)
	Manages the DMA Half Transfer complete event.
void	BSP_AUDIO_IN_Error_Callback (void)
	Audio IN Error callback function.
void	BSP_AUDIO_IN_ClockConfig (I2S_HandleTypeDef *hi2s, uint32_t AudioFreq, void *Params)
	Audio In Clock Config.
void	BSP_AUDIO_IN_MspInit (I2S_HandleTypeDef *hi2s, void *Params)
	BSP AUDIO IN MSP Init.
void	BSP_AUDIO_IN_MspDeInit (I2S_HandleTypeDef *hi2s, void *Params)
	DeInitializes BSP_AUDIO_IN MSP.
Variables
__IO uint16_t	AudioInVolume

---

Detailed Description

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

Author:

MCD Application Team

Version:

V2.2.2

Date:

31-January-2017

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 stm32f401_discovery_audio.h.