stm3210e_eval_audio.h File Reference

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

#include "../Components/ak4343/ak4343.h" #include "stm3210e_eval.h"

Go to the source code of this file.

Defines
#define	I2SOUT   SPI2
#define	I2SOUT_CLK_ENABLE()   __HAL_RCC_SPI2_CLK_ENABLE()
#define	I2SOUT_CLK_DISABLE()   __HAL_RCC_SPI2_CLK_DISABLE()
#define	I2SOUT_SCK_SD_CLK_ENABLE()   __HAL_RCC_GPIOB_CLK_ENABLE()
#define	I2SOUT_MCK_CLK_ENABLE()   __HAL_RCC_GPIOC_CLK_ENABLE()
#define	I2SOUT_WS_CLK_ENABLE()   __HAL_RCC_GPIOB_CLK_ENABLE()
#define	I2SOUT_WS_PIN   GPIO_PIN_12 /* PB.12*/
#define	I2SOUT_SCK_PIN   GPIO_PIN_13 /* PB.13*/
#define	I2SOUT_SD_PIN   GPIO_PIN_15 /* PB.15*/
#define	I2SOUT_MCK_PIN   GPIO_PIN_6 /* PC.06*/
#define	I2SOUT_SCK_SD_GPIO_PORT   GPIOB
#define	I2SOUT_WS_GPIO_PORT   GPIOB
#define	I2SOUT_MCK_GPIO_PORT   GPIOC
#define	I2SOUT_DMAx_CLK_ENABLE()   __HAL_RCC_DMA1_CLK_ENABLE()
#define	I2SOUT_DMAx_CHANNEL   DMA1_Channel5
#define	I2SOUT_DMAx_IRQ   DMA1_Channel5_IRQn
#define	I2SOUT_DMAx_PERIPH_DATA_SIZE   DMA_PDATAALIGN_HALFWORD
#define	I2SOUT_DMAx_MEM_DATA_SIZE   DMA_MDATAALIGN_HALFWORD
#define	DMA_MAX_SZE   0xFFFF
#define	I2SOUT_IRQHandler   DMA1_Channel5_IRQHandler
#define	AUDIO_OUT_IRQ_PREPRIO   0xE /* Select the preemption priority level(0 is the highest) */
#define	AUDIO_OK   0
#define	AUDIO_ERROR   1
#define	AUDIO_TIMEOUT   2
#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)
	Configure the audio peripherals.
void	BSP_AUDIO_OUT_DeInit (void)
	De-initialize 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)
	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.
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).
__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 (I2S_HandleTypeDef *hi2s, void *Params)
	Initializes BSP_AUDIO_OUT MSP.
__weak void	BSP_AUDIO_OUT_MspDeInit (I2S_HandleTypeDef *hi2s, void *Params)
	De-Initializes BSP_AUDIO_OUT MSP.

---

Detailed Description

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

Author:

MCD Application Team

Version:

V6.0.2

Date:

29-April-2016

Attention:

© COPYRIGHT(c) 2016 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 stm3210e_eval_audio.h.