stm32h747i_discovery_audio.h

00001 /**
00002   ******************************************************************************
00003   * @file    stm32h747i_discovery_audio.h
00004   * @author  MCD Application Team
00005   * @brief   This file contains the common defines and functions prototypes for
00006   *          the stm32h747i_discovery_audio.c driver.
00007   ******************************************************************************
00008   * @attention
00009   *
00010   * <h2><center>&copy; Copyright (c) 2019 STMicroelectronics.
00011   * All rights reserved.</center></h2>
00012   *
00013   * This software component is licensed by ST under BSD 3-Clause license,
00014   * the "License"; You may not use this file except in compliance with the
00015   * License. You may obtain a copy of the License at:
00016   *                        opensource.org/licenses/BSD-3-Clause
00017   *
00018   ******************************************************************************
00019   */
00020 
00021 /* Define to prevent recursive inclusion -------------------------------------*/
00022 #ifndef __STM32H747I_DISCOVERY_AUDIO_H
00023 #define __STM32H747I_DISCOVERY_AUDIO_H
00024 
00025 #ifdef __cplusplus
00026  extern "C" {
00027 #endif 
00028 
00029 /* Includes ------------------------------------------------------------------*/
00030 /* Include audio component Driver */
00031 #include "../Components/wm8994/wm8994.h"
00032 #include "stm32h747i_discovery.h"
00033 #include <stdlib.h>
00034 /* Include PDM to PCM lib header file */
00035 #include "pdm2pcm_glo.h"
00036 
00037 /** @addtogroup BSP
00038   * @{
00039   */ 
00040 
00041 /** @addtogroup STM32H747I_DISCOVERY
00042   * @{
00043   */
00044     
00045 /** @addtogroup STM32H747I_DISCOVERY_AUDIO
00046   * @{
00047   */
00048 
00049 /** @defgroup STM32H747I_DISCOVERY_AUDIO_Exported_Types Exported Types
00050   * @{
00051   */
00052 typedef struct
00053 {
00054   uint32_t               Frequency;      /* Record Frequency */
00055   uint32_t               BitResolution;  /* Record bit resolution */
00056   uint32_t               ChannelNbr;     /* Record Channel Number */
00057   uint16_t               *pRecBuf;       /* Pointer to record user buffer */
00058   uint32_t               RecSize;        /* Size to record in mono, double size to record in stereo */
00059   uint32_t               InputDevice;    /* Audio Input Device */
00060   uint32_t               Interface;      /* Audio Input Interface */
00061   uint32_t               MultiBuffMode;  /* Multi buffer mode selection */
00062 }AUDIOIN_ContextTypeDef;
00063 /**
00064   * @}
00065   */
00066 
00067 /** @defgroup STM32H747I_DISCOVERY_AUDIO_Exported_Constants Exported Constants
00068   * @{
00069   */
00070 #define BSP_AUDIO_FREQUENCY_96K         SAI_AUDIO_FREQUENCY_96K
00071 #define BSP_AUDIO_FREQUENCY_48K         SAI_AUDIO_FREQUENCY_48K
00072 #define BSP_AUDIO_FREQUENCY_44K         SAI_AUDIO_FREQUENCY_44K
00073 #define BSP_AUDIO_FREQUENCY_32K         SAI_AUDIO_FREQUENCY_32K
00074 #define BSP_AUDIO_FREQUENCY_22K         SAI_AUDIO_FREQUENCY_22K
00075 #define BSP_AUDIO_FREQUENCY_16K         SAI_AUDIO_FREQUENCY_16K
00076 #define BSP_AUDIO_FREQUENCY_11K         SAI_AUDIO_FREQUENCY_11K
00077 #define BSP_AUDIO_FREQUENCY_8K          SAI_AUDIO_FREQUENCY_8K
00078 
00079 /*------------------------------------------------------------------------------
00080                           USER SAI defines parameters
00081  -----------------------------------------------------------------------------*/
00082 /** In W8994 codec the Audio frame contains 4 slots : TDM Mode
00083   * TDM format :
00084   * +------------------|------------------|--------------------|-------------------+
00085   * | CODEC_SLOT0 Left | CODEC_SLOT1 Left | CODEC_SLOT0 Right  | CODEC_SLOT1 Right |
00086   * +------------------------------------------------------------------------------+
00087   */
00088 /* To have 2 separate audio stream in Both headphone and speaker the 4 slot must be activated */
00089 #define CODEC_AUDIOFRAME_SLOT_0123                   SAI_SLOTACTIVE_0 | SAI_SLOTACTIVE_1 | SAI_SLOTACTIVE_2 | SAI_SLOTACTIVE_3
00090 
00091 /* To have an audio stream in headphone only SAI Slot 0 and Slot 2 must be activated */
00092 #define CODEC_AUDIOFRAME_SLOT_02                     SAI_SLOTACTIVE_0 | SAI_SLOTACTIVE_2
00093 /* To have an audio stream in speaker only SAI Slot 1 and Slot 3 must be activated */
00094 #define CODEC_AUDIOFRAME_SLOT_13                     SAI_SLOTACTIVE_1 | SAI_SLOTACTIVE_3
00095 /* To have an audio stream in SAI PDM input Slot 0 must be activated */
00096 #define CODEC_AUDIOFRAME_SLOT_0                      SAI_SLOTACTIVE_0
00097 
00098 /*------------------------------------------------------------------------------
00099                         AUDIO OUT CONFIGURATION
00100 ------------------------------------------------------------------------------*/
00101 /* SAI peripheral configuration defines */
00102 #define AUDIO_OUT_SAIx                           SAI1_Block_A
00103 #define AUDIO_OUT_SAIx_CLK_ENABLE()              __HAL_RCC_SAI1_CLK_ENABLE()
00104 #define AUDIO_OUT_SAIx_CLK_DISABLE()             __HAL_RCC_SAI1_CLK_DISABLE()
00105 #define AUDIO_OUT_SAIx_AF                        GPIO_AF6_SAI1
00106 
00107 #define AUDIO_OUT_SAIx_MCLK_ENABLE()             __HAL_RCC_GPIOG_CLK_ENABLE()
00108 #define AUDIO_OUT_SAIx_MCLK_GPIO_PORT            GPIOG
00109 #define AUDIO_OUT_SAIx_MCLK_PIN                  GPIO_PIN_7
00110 #define AUDIO_OUT_SAIx_SD_FS_CLK_ENABLE()        __HAL_RCC_GPIOE_CLK_ENABLE()
00111 #define AUDIO_OUT_SAIx_SD_FS_SCK_GPIO_PORT       GPIOE
00112 #define AUDIO_OUT_SAIx_FS_PIN                    GPIO_PIN_4   
00113 #define AUDIO_OUT_SAIx_SCK_PIN                   GPIO_PIN_5
00114 #define AUDIO_OUT_SAIx_SD_PIN                    GPIO_PIN_6
00115 
00116 /* SAI DMA Stream definitions */
00117 #define AUDIO_OUT_SAIx_DMAx_CLK_ENABLE()         __HAL_RCC_DMA2_CLK_ENABLE()
00118 #define AUDIO_OUT_SAIx_DMAx_STREAM               DMA2_Stream1
00119 #define AUDIO_OUT_SAIx_DMAx_REQUEST              DMA_REQUEST_SAI1_A
00120 #define AUDIO_OUT_SAIx_DMAx_IRQ                  DMA2_Stream1_IRQn
00121 #define AUDIO_OUT_SAIx_DMAx_PERIPH_DATA_SIZE     DMA_PDATAALIGN_HALFWORD
00122 #define AUDIO_OUT_SAIx_DMAx_MEM_DATA_SIZE        DMA_MDATAALIGN_HALFWORD
00123 #define AUDIO_OUT_SAIx_DMAx_IRQHandler           DMA2_Stream1_IRQHandler
00124 
00125 /* Select the interrupt preemption priority and subpriority for the DMA interrupt */
00126 #define AUDIO_OUT_IRQ_PREPRIO                    ((uint32_t)0x0E)
00127 
00128 /*------------------------------------------------------------------------------
00129                         AUDIO IN CONFIGURATION
00130 ------------------------------------------------------------------------------*/
00131 /* SAI peripheral configuration defines */
00132 #define AUDIO_IN_SAIx                           SAI1_Block_B
00133 #define AUDIO_IN_SAIx_CLK_ENABLE()              __HAL_RCC_SAI1_CLK_ENABLE()
00134 #define AUDIO_IN_SAIx_CLK_DISABLE()             __HAL_RCC_SAI1_CLK_DISABLE()
00135 #define AUDIO_IN_SAIx_AF                        GPIO_AF6_SAI1
00136 #define AUDIO_IN_SAIx_SD_ENABLE()               __HAL_RCC_GPIOE_CLK_ENABLE()
00137 #define AUDIO_IN_SAIx_SD_GPIO_PORT              GPIOE
00138 #define AUDIO_IN_SAIx_SD_PIN                    GPIO_PIN_3
00139 
00140 /* SAI DMA Stream definitions */
00141 #define AUDIO_IN_SAIx_DMAx_CLK_ENABLE()         __HAL_RCC_DMA2_CLK_ENABLE()
00142 #define AUDIO_IN_SAIx_DMAx_STREAM               DMA2_Stream4
00143 #define AUDIO_IN_SAIx_DMAx_REQUEST              DMA_REQUEST_SAI1_B
00144 #define AUDIO_IN_SAIx_DMAx_IRQ                  DMA2_Stream4_IRQn
00145 #define AUDIO_IN_SAIx_DMAx_PERIPH_DATA_SIZE     DMA_PDATAALIGN_HALFWORD
00146 #define AUDIO_IN_SAIx_DMAx_MEM_DATA_SIZE        DMA_MDATAALIGN_HALFWORD
00147 
00148 #define AUDIO_IN_SAIx_DMAx_IRQHandler           DMA2_Stream4_IRQHandler
00149 
00150 #define AUDIO_IN_INT_GPIO_ENABLE()               __HAL_RCC_GPIOJ_CLK_ENABLE()
00151 #define AUDIO_IN_INT_GPIO_PORT                   GPIOJ
00152 #define AUDIO_IN_INT_GPIO_PIN                    GPIO_PIN_15
00153 #define AUDIO_IN_INT_IRQ                         EXTI15_10_IRQn
00154 
00155 /* SAI PDM input definitions */
00156 #define AUDIO_IN_SAI_PDMx                       SAI4_Block_A
00157 #define AUDIO_IN_SAI_PDMx_CLK_ENABLE()          __HAL_RCC_SAI4_CLK_ENABLE()
00158 #define AUDIO_IN_SAI_PDMx_CLK_DISABLE()         __HAL_RCC_SAI4_CLK_DISABLE()
00159 #define AUDIO_IN_SAI_PDMx_FS_SCK_AF             GPIO_AF8_SAI4
00160 #define AUDIO_IN_SAI_PDMx_FS_SCK_ENABLE()       __HAL_RCC_GPIOE_CLK_ENABLE()
00161 #define AUDIO_IN_SAI_PDMx_FS_SCK_GPIO_PORT      GPIOE
00162 #define AUDIO_IN_SAI_PDMx_FS_PIN                GPIO_PIN_4
00163 #define AUDIO_IN_SAI_PDMx_SCK_PIN               GPIO_PIN_5
00164 
00165 #define AUDIO_IN_SAI_PDMx_CLK_IN_ENABLE()       __HAL_RCC_GPIOE_CLK_ENABLE()
00166 #define AUDIO_IN_SAI_PDMx_CLK_IN_PIN            GPIO_PIN_2
00167 #define AUDIO_IN_SAI_PDMx_CLK_IN_PORT           GPIOE
00168 #define AUDIO_IN_SAI_PDMx_DATA_IN_ENABLE()      __HAL_RCC_GPIOC_CLK_ENABLE()
00169 #define AUDIO_IN_SAI_PDMx_DATA_IN_PIN           GPIO_PIN_1
00170 #define AUDIO_IN_SAI_PDMx_DATA_IN_PORT          GPIOC
00171 #define AUDIO_IN_SAI_PDMx_DATA_CLK_AF           GPIO_AF10_SAI4
00172 #define AUDIO_IN_SAI_PDMx_IRQHandler            SAI4_IRQHandler
00173 #define AUDIO_IN_SAI_PDMx_IRQ                   SAI4_IRQn
00174 
00175 /* SAI PDM DMA Stream definitions */
00176 #define AUDIO_IN_SAI_PDMx_DMAx_CLK_ENABLE()         __HAL_RCC_BDMA_CLK_ENABLE()
00177 #define AUDIO_IN_SAI_PDMx_DMAx_STREAM               BDMA_Channel1
00178 #define AUDIO_IN_SAI_PDMx_DMAx_REQUEST              BDMA_REQUEST_SAI4_A
00179 #define AUDIO_IN_SAI_PDMx_DMAx_IRQ                  BDMA_Channel1_IRQn
00180 #define AUDIO_IN_SAI_PDMx_DMAx_PERIPH_DATA_SIZE     DMA_PDATAALIGN_HALFWORD
00181 #define AUDIO_IN_SAI_PDMx_DMAx_MEM_DATA_SIZE        DMA_MDATAALIGN_HALFWORD
00182 #define AUDIO_IN_SAI_PDMx_DMAx_IRQHandler           BDMA_Channel1_IRQHandler
00183 
00184 /* Select the interrupt preemption priority and subpriority for the DMA interrupt */
00185 #define AUDIO_IN_IRQ_PREPRIO                ((uint32_t)0x0F)
00186 
00187 
00188 /*------------------------------------------------------------------------------
00189              CONFIGURATION: Audio Driver Configuration parameters
00190 ------------------------------------------------------------------------------*/
00191 
00192 #define AUDIODATA_SIZE                      ((uint32_t)2)   /* 16-bits audio data size */
00193 
00194 /* Audio status definition */
00195 #define AUDIO_OK                            ((uint8_t)0)
00196 #define AUDIO_ERROR                         ((uint8_t)1)
00197 #define AUDIO_TIMEOUT                       ((uint8_t)2)
00198 
00199 /* Audio In default settings */
00200 #define DEFAULT_AUDIO_IN_FREQ               BSP_AUDIO_FREQUENCY_16K
00201 #define DEFAULT_AUDIO_IN_BIT_RESOLUTION     ((uint8_t)16)
00202 #define DEFAULT_AUDIO_IN_CHANNEL_NBR        ((uint8_t)2)
00203 #define DEFAULT_AUDIO_IN_VOLUME             ((uint16_t)64)
00204 
00205 /*------------------------------------------------------------------------------
00206                             OUTPUT DEVICES definition
00207 ------------------------------------------------------------------------------*/
00208 /* Alias on existing output devices to adapt for 2 headphones output */
00209 #define OUTPUT_DEVICE_HEADPHONE1 OUTPUT_DEVICE_HEADPHONE
00210 #define OUTPUT_DEVICE_HEADPHONE2 OUTPUT_DEVICE_SPEAKER /* Headphone2 is connected to Speaker output of the wm8994 */
00211 
00212 /*------------------------------------------------------------------------------
00213                            INPUT DEVICES definition
00214 ------------------------------------------------------------------------------*/
00215 /* Analog microphone input from 3.5 audio jack connector */
00216 #define INPUT_DEVICE_ANALOG_MIC        ((uint32_t)0x00000001)
00217 /* MP34DT01TR digital microphone on PCB top side */
00218 #define INPUT_DEVICE_DIGITAL_MIC1      ((uint32_t)0x00000010)
00219 #define INPUT_DEVICE_DIGITAL_MIC2      ((uint32_t)0x00000020)
00220 #define INPUT_DEVICE_DIGITAL_MIC       ((uint32_t)(INPUT_DEVICE_DIGITAL_MIC1 | INPUT_DEVICE_DIGITAL_MIC2))
00221 
00222 /* Audio In interface for Digital mic */
00223 #define AUDIO_IN_INTERFACE_SAI        ((uint16_t)0)
00224 #define AUDIO_IN_INTERFACE_PDM        ((uint16_t)1)
00225 
00226 /**
00227   * @}
00228   */
00229 
00230 /** @defgroup STM32H747I_DISCOVERY_AUDIO_Exported_Macros Exported Macros
00231   * @{
00232   */
00233 #define DMA_MAX_SIZE         0xFFFF
00234 #define DMA_MAX(x)           (((x) <= DMA_MAX_SIZE)? (x):DMA_MAX_SIZE)
00235 #define POS_VAL(VAL)         (POSITION_VAL(VAL) - 4)
00236 /**
00237   * @}
00238   */
00239 
00240 /** @addtogroup STM32H747I_DISCOVERY_AUDIO_OUT_Exported_Functions
00241   * @{
00242   */
00243 uint8_t BSP_AUDIO_OUT_Init(uint16_t OutputDevice, uint8_t Volume, uint32_t AudioFreq);
00244 void    BSP_AUDIO_OUT_DeInit(void);
00245 uint8_t BSP_AUDIO_OUT_Play(uint16_t* pBuffer, uint32_t Size);
00246 void    BSP_AUDIO_OUT_ChangeBuffer(uint16_t *pData, uint16_t Size);
00247 uint8_t BSP_AUDIO_OUT_Pause(void);
00248 uint8_t BSP_AUDIO_OUT_Resume(void);
00249 uint8_t BSP_AUDIO_OUT_Stop(uint32_t Option);
00250 uint8_t BSP_AUDIO_OUT_SetVolume(uint8_t Volume);
00251 void    BSP_AUDIO_OUT_SetFrequency(uint32_t AudioFreq);
00252 void    BSP_AUDIO_OUT_SetAudioFrameSlot(uint32_t AudioFrameSlot);
00253 uint8_t BSP_AUDIO_OUT_SetMute(uint32_t Cmd);
00254 uint8_t BSP_AUDIO_OUT_SetOutputMode(uint8_t Output);
00255 
00256 /* User Callbacks: user has to implement these functions in his code if they are needed. */
00257 /* This function is called when the requested data has been completely transferred.*/
00258 void    BSP_AUDIO_OUT_TransferComplete_CallBack(void);
00259 
00260 /* This function is called when half of the requested buffer has been transferred. */
00261 void    BSP_AUDIO_OUT_HalfTransfer_CallBack(void);
00262 
00263 /* This function is called when an Interrupt due to transfer error on or peripheral
00264    error occurs. */
00265 void    BSP_AUDIO_OUT_Error_CallBack(void);
00266 
00267 /* These function can be modified in case the current settings (e.g. DMA stream)
00268    need to be changed for specific application needs */
00269 void  BSP_AUDIO_OUT_ClockConfig(SAI_HandleTypeDef *hsai, uint32_t AudioFreq, void *Params);
00270 void  BSP_AUDIO_OUT_MspInit(SAI_HandleTypeDef *hsai, void *Params);
00271 void  BSP_AUDIO_OUT_MspDeInit(SAI_HandleTypeDef *hsai, void *Params);
00272 
00273 /**
00274   * @}
00275   */
00276 
00277 /** @addtogroup STM32H747I_DISCOVERY_AUDIO_IN_Exported_Functions
00278   * @{
00279   */
00280 uint8_t BSP_AUDIO_IN_Init(uint32_t AudioFreq, uint32_t BitRes, uint32_t ChnlNbr);
00281 uint8_t BSP_AUDIO_IN_InitEx(uint16_t InputDevice, uint32_t AudioFreq, uint32_t BitRes, uint32_t ChnlNbr);
00282 uint8_t BSP_AUDIO_IN_AllocScratch (int32_t *pScratch, uint32_t size);
00283 uint8_t BSP_AUDIO_IN_Record(uint16_t *pBuf, uint32_t Size);
00284 uint8_t BSP_AUDIO_IN_RecordEx(uint32_t *pBuf, uint32_t Size);
00285 uint8_t BSP_AUDIO_IN_SetFrequency(uint32_t AudioFreq);
00286 uint8_t BSP_AUDIO_IN_Stop(void);
00287 uint8_t BSP_AUDIO_IN_StopEx(uint32_t InputDevice);
00288 uint8_t BSP_AUDIO_IN_Pause(void);
00289 uint8_t BSP_AUDIO_IN_PauseEx(uint32_t InputDevice);
00290 uint8_t BSP_AUDIO_IN_Resume(void);
00291 uint8_t BSP_AUDIO_IN_ResumeEx(uint32_t *pBuf, uint32_t InputDevice);
00292 uint8_t BSP_AUDIO_IN_SetVolume(uint8_t Volume);
00293 void    BSP_AUDIO_IN_DeInit(void);
00294 uint8_t BSP_AUDIO_IN_PDMToPCM(uint16_t *PDMBuf, uint16_t *PCMBuf);
00295 uint8_t BSP_AUDIO_IN_PDMToPCM_Init(uint32_t AudioFreq, uint32_t ChnlNbrIn, uint32_t ChnlNbrOut);
00296 void    BSP_AUDIO_IN_SelectInterface(uint32_t Interface);
00297 uint32_t BSP_AUDIO_IN_GetInterface(void);
00298 uint8_t BSP_AUDIO_IN_OUT_Init(uint32_t InputDevice, uint32_t OutputDevice, uint32_t AudioFreq, uint32_t BitRes, uint32_t ChnlNbr);
00299 uint8_t BSP_AUDIO_IN_GetChannelNumber(void);
00300 void    BSP_AUDIO_IN_Error_Callback(void);
00301 
00302 /* User Callbacks: user has to implement these functions in his code if they are needed. */
00303 /* This function should be implemented by the user application.
00304    It is called into this driver when the current buffer is filled to prepare the next
00305    buffer pointer and its size. */
00306 void    BSP_AUDIO_IN_TransferComplete_CallBack(void);
00307 void    BSP_AUDIO_IN_HalfTransfer_CallBack(void);
00308 void    BSP_AUDIO_IN_TransferComplete_CallBackEx(uint32_t InputDevice);
00309 void    BSP_AUDIO_IN_HalfTransfer_CallBackEx(uint32_t InputDevice);
00310 
00311 /* This function is called when an Interrupt due to transfer error on or peripheral
00312    error occurs. */
00313 void    BSP_AUDIO_IN_Error_CallBack(void);
00314 
00315 /* These function can be modified in case the current settings (e.g. DMA stream)
00316    need to be changed for specific application needs */
00317 void BSP_AUDIO_IN_ClockConfig(uint32_t AudioFreq, void *Params);
00318 void BSP_AUDIO_IN_MspInit(void);
00319 void BSP_AUDIO_IN_MspDeInit(void);
00320 
00321 /**
00322   * @}
00323   */
00324 
00325 /**
00326   * @}
00327   */
00328 
00329 /**
00330   * @}
00331   */
00332 /**
00333   * @}
00334   */
00335 
00336 #ifdef __cplusplus
00337 }
00338 #endif
00339 
00340 #endif /* __STM32H747I_DISCOVERY_AUDIO_H */
00341 
00342 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/