stm32l476g_discovery_audio.h

00001 /**
00002   ******************************************************************************
00003   * @file    stm32l476g_discovery_audio.h
00004   * @author  MCD Application Team
00005   * @version V1.0.1
00006   * @date    16-September-2015
00007   * @brief   This file contains the common defines and functions prototypes for
00008   *          the stm32l476g_discovery_audio.c driver.
00009   ******************************************************************************
00010   * @attention
00011   *
00012   * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
00013   *
00014   * Redistribution and use in source and binary forms, with or without modification,
00015   * are permitted provided that the following conditions are met:
00016   *   1. Redistributions of source code must retain the above copyright notice,
00017   *      this list of conditions and the following disclaimer.
00018   *   2. Redistributions in binary form must reproduce the above copyright notice,
00019   *      this list of conditions and the following disclaimer in the documentation
00020   *      and/or other materials provided with the distribution.
00021   *   3. Neither the name of STMicroelectronics nor the names of its contributors
00022   *      may be used to endorse or promote products derived from this software
00023   *      without specific prior written permission.
00024   *
00025   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00026   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00028   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
00029   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00030   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00031   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00032   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00033   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00034   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00035   *
00036   ******************************************************************************
00037   */
00038 
00039 /* Define to prevent recursive inclusion -------------------------------------*/
00040 #ifndef __STM32L476G_DISCOVERY_AUDIO_H
00041 #define __STM32L476G_DISCOVERY_AUDIO_H
00042 
00043 
00044 /* Includes ------------------------------------------------------------------*/
00045 
00046 #include <string.h>
00047 #include <stdlib.h>
00048 #include "mbed.h"
00049 #include "main.h"
00050 /* Include audio component Driver */
00051 
00052 //#include "stm32l476g_discovery.h"
00053 
00054 /** @addtogroup BSP
00055   * @{
00056   */ 
00057 
00058 /** @addtogroup STM32L476G_DISCOVERY
00059   * @{
00060   */
00061 
00062 /** @addtogroup STM32L476G_DISCOVERY_AUDIO
00063   * @{
00064   */
00065 
00066 /** @defgroup STM32L476G_DISCOVERY_AUDIO_Exported_Types Exported Types
00067   * @{
00068   */
00069 typedef void (*Audio_CallbackTypeDef)(void);
00070 
00071 /**
00072   * @}
00073   */
00074 
00075 /** @defgroup STM32L476G_DISCOVERY_AUDIO_Exported_Constants Exported Constants
00076   * @{
00077   */
00078 /** @defgroup BSP_Audio_Out_Option BSP Audio Out Option
00079   * @{
00080   */
00081 #define BSP_AUDIO_OUT_CIRCULARMODE      ((uint32_t)0x00000001) /* BUFFER CIRCULAR MODE */
00082 #define BSP_AUDIO_OUT_NORMALMODE        ((uint32_t)0x00000002) /* BUFFER NORMAL MODE   */
00083 #define BSP_AUDIO_OUT_STEREOMODE        ((uint32_t)0x00000004) /* STEREO MODE          */
00084 #define BSP_AUDIO_OUT_MONOMODE          ((uint32_t)0x00000008) /* MONO MODE            */
00085 /**
00086   * @}
00087   */
00088  
00089 /** @defgroup BSP_Audio_Sample_Rate BSP Audio Sample Rate
00090   * @{
00091   */
00092 #define BSP_AUDIO_FREQUENCY_96K         SAI_AUDIO_FREQUENCY_96K
00093 #define BSP_AUDIO_FREQUENCY_48K         SAI_AUDIO_FREQUENCY_48K
00094 #define BSP_AUDIO_FREQUENCY_44K         SAI_AUDIO_FREQUENCY_44K
00095 #define BSP_AUDIO_FREQUENCY_32K         SAI_AUDIO_FREQUENCY_32K
00096 #define BSP_AUDIO_FREQUENCY_22K         SAI_AUDIO_FREQUENCY_22K
00097 #define BSP_AUDIO_FREQUENCY_16K         SAI_AUDIO_FREQUENCY_16K
00098 #define BSP_AUDIO_FREQUENCY_11K         SAI_AUDIO_FREQUENCY_11K
00099 #define BSP_AUDIO_FREQUENCY_8K          SAI_AUDIO_FREQUENCY_8K
00100 /**
00101   * @}
00102   */
00103   
00104 /* AUDIO FREQUENCY */
00105 #define AUDIO_FREQUENCY_192K          ((uint32_t)192000)
00106 #define AUDIO_FREQUENCY_96K           ((uint32_t)96000)
00107 #define AUDIO_FREQUENCY_48K           ((uint32_t)48000)
00108 #define AUDIO_FREQUENCY_44K           ((uint32_t)44100)
00109 #define AUDIO_FREQUENCY_32K           ((uint32_t)32000)
00110 #define AUDIO_FREQUENCY_22K           ((uint32_t)22050)
00111 #define AUDIO_FREQUENCY_16K           ((uint32_t)16000)
00112 #define AUDIO_FREQUENCY_11K           ((uint32_t)11025)
00113 #define AUDIO_FREQUENCY_8K            ((uint32_t)8000)  
00114   
00115 /*------------------------------------------------------------------------------
00116                           USER SAI defines parameters
00117  -----------------------------------------------------------------------------*/
00118 /* SAI peripheral configuration defines */
00119 #define AUDIO_SAIx                             SAI1_Block_A
00120 #define AUDIO_SAIx_CLK_ENABLE()                __HAL_RCC_SAI1_CLK_ENABLE()
00121 #define AUDIO_SAIx_CLK_DISABLE()               __HAL_RCC_SAI1_CLK_DISABLE()
00122 #define AUDIO_SAIx_MCK_SCK_SD_FS_AF            GPIO_AF13_SAI1
00123 
00124 #define AUDIO_SAIx_MCK_SCK_SD_FS_ENABLE()      __HAL_RCC_GPIOE_CLK_ENABLE()
00125 #define AUDIO_SAIx_MCK_SCK_SD_FS_DISABLE()     __HAL_RCC_GPIOE_CLK_DISABLE()
00126 #define AUDIO_SAIx_FS_PIN                      GPIO_PIN_4
00127 #define AUDIO_SAIx_SCK_PIN                     GPIO_PIN_5
00128 #define AUDIO_SAIx_SD_PIN                      GPIO_PIN_6
00129 #define AUDIO_SAIx_MCK_PIN                     GPIO_PIN_2
00130 #define AUDIO_SAIx_MCK_SCK_SD_FS_GPIO_PORT     GPIOE
00131 
00132 /* SAI DMA Channel definitions */
00133 #define AUDIO_SAIx_DMAx_CLK_ENABLE()         __HAL_RCC_DMA2_CLK_ENABLE()
00134 #define AUDIO_SAIx_DMAx_CLK_DISABLE()        __HAL_RCC_DMA2_CLK_DISABLE()
00135 #define AUDIO_SAIx_DMAx_CHANNEL              DMA2_Channel1
00136 #define AUDIO_SAIx_DMAx_IRQ                  DMA2_Channel1_IRQn
00137 #define AUDIO_SAIx_DMAx_PERIPH_DATA_SIZE     DMA_PDATAALIGN_HALFWORD
00138 #define AUDIO_SAIx_DMAx_MEM_DATA_SIZE        DMA_MDATAALIGN_HALFWORD
00139 #define DMA_MAX_SZE                          (uint32_t)0xFFFF
00140    
00141 #define AUDIO_SAIx_DMAx_IRQHandler           DMA2_Channel1_IRQHandler
00142 
00143 /* Select the interrupt preemption priority for the DMA interrupt */
00144 #define AUDIO_OUT_IRQ_PREPRIO           5   /* Select the preemption priority level(0 is the highest) */   
00145 
00146 /* Disable SAIx PLL */
00147 #define AUDIO_SAIx_PLL_DISABLE()             HAL_RCCEx_DisablePLLSAI1()
00148 
00149 /*------------------------------------------------------------------------------
00150                         AUDIO IN CONFIGURATION
00151 ------------------------------------------------------------------------------*/
00152 /* DFSDM Configuration defines */
00153 #define AUDIO_DFSDMx_LEFT_CHANNEL                       DFSDM_Channel2
00154 #define AUDIO_DFSDMx_LEFT_FILTER                        DFSDM_Filter0
00155 #define AUDIO_DFSDMx_CLK_ENABLE()                       __HAL_RCC_DFSDM_CLK_ENABLE()
00156 #define AUDIO_DFSDMx_CLK_DISABLE()                       __HAL_RCC_DFSDM_CLK_DISABLE()
00157 #define AUDIO_DFSDMx_CKOUT_PIN                          GPIO_PIN_9
00158 #define AUDIO_DFSDMx_DMIC_DATIN_PIN                     GPIO_PIN_7
00159 #define AUDIO_DFSDMx_CKOUT_DMIC_DATIN_GPIO_PORT         GPIOE
00160 #define AUDIO_DFSDMx_CKOUT_DMIC_DATIN_GPIO_CLK_ENABLE() __HAL_RCC_GPIOE_CLK_ENABLE()
00161 #define AUDIO_DFSDMx_CKOUT_DMIC_DATIN_GPIO_CLK_DISABLE() __HAL_RCC_GPIOE_CLK_DISABLE()
00162 #define AUDIO_DFSDMx_CKOUT_DMIC_DATIN_AF                GPIO_AF6_DFSDM
00163 
00164 /* DFSDM DMA Right and Left channels definitions */
00165 #define AUDIO_DFSDMx_DMAx_CLK_ENABLE()                  __HAL_RCC_DMA1_CLK_ENABLE()
00166 #define AUDIO_DFSDMx_DMAx_CLK_DISABLE()                 __HAL_RCC_DMA1_CLK_DISABLE()
00167 #define AUDIO_DFSDMx_DMAx_LEFT_CHANNEL                  DMA1_Channel4
00168 #define AUDIO_DFSDMx_DMAx_LEFT_IRQ                      DMA1_Channel4_IRQn
00169 #define AUDIO_DFSDMx_DMAx_PERIPH_DATA_SIZE              DMA_PDATAALIGN_WORD
00170 #define AUDIO_DFSDMx_DMAx_MEM_DATA_SIZE                 DMA_MDATAALIGN_WORD
00171    
00172 #define AUDIO_DFSDM_DMAx_LEFT_IRQHandler                DMA1_Channel4_IRQHandler
00173   
00174 /* Select the interrupt preemption priority and subpriority for the IT/DMA interrupt */
00175 #define AUDIO_IN_IRQ_PREPRIO                6   /* Select the preemption priority level(0 is the highest) */
00176 
00177 /*------------------------------------------------------------------------------
00178              CONFIGURATION: Audio Driver Configuration parameters
00179 ------------------------------------------------------------------------------*/
00180 
00181 #define AUDIODATA_SIZE                      2   /* 16-bits audio data size */
00182 
00183 /* Audio status definition */     
00184 #define AUDIO_OK                            0
00185 #define AUDIO_ERROR                         1
00186 #define AUDIO_TIMEOUT                       2
00187 
00188 /* AudioFreq * DataSize (2 bytes) * NumChannels (Stereo: 2) */
00189 #define DEFAULT_AUDIO_IN_FREQ               BSP_AUDIO_FREQUENCY_16K
00190 #define DEFAULT_AUDIO_IN_BIT_RESOLUTION     16
00191 #define DEFAULT_AUDIO_IN_CHANNEL_NBR        1 /* Mono = 1, Stereo = 2 */
00192 #define DEFAULT_AUDIO_IN_VOLUME             64
00193 
00194 /*------------------------------------------------------------------------------
00195                     OPTIONAL Configuration defines parameters
00196 ------------------------------------------------------------------------------*/
00197 
00198 /* Delay for the Codec to be correctly reset */
00199 #define CODEC_RESET_DELAY           5
00200 
00201 typedef enum
00202 {
00203   BUFFER_OFFSET_NONE = 0,
00204   BUFFER_OFFSET_HALF,
00205   BUFFER_OFFSET_FULL,
00206  } RecordBufferOffset_Typedef;
00207 
00208 
00209 /**
00210   * @}
00211   */
00212  
00213 /** @defgroup STM32L476G_DISCOVERY_AUDIO_Exported_Variables Exported Variables
00214   * @{
00215   */
00216 extern SAI_HandleTypeDef          BSP_AUDIO_hSai;
00217 extern DFSDM_Filter_HandleTypeDef BSP_AUDIO_hDfsdmLeftFilter;
00218 
00219 
00220 extern RecordBufferOffset_Typedef  RecordBufferOffset;
00221 
00222  /**
00223   * @}
00224   */
00225    
00226 /** @defgroup STM32L476G_DISCOVERY_AUDIO_Exported_Macros Exported Macros
00227   * @{
00228   */
00229 #define DMA_MAX(_X_)                (((_X_) <= DMA_MAX_SZE)? (_X_):DMA_MAX_SZE)
00230 
00231 /**
00232   * @}
00233   */
00234 
00235 /* Exported functions --------------------------------------------------------*/
00236 /** @defgroup STM32L476G_DISCOVERY_AUDIO_Exported_Functions Exported Functions
00237   * @{
00238   */
00239 uint8_t BSP_AUDIO_OUT_Init(uint16_t OutputDevice, uint8_t Volume, uint32_t AudioFreq);
00240 uint8_t BSP_AUDIO_OUT_DeInit(void);
00241 uint8_t BSP_AUDIO_OUT_Play(uint16_t* pData, uint32_t Size);
00242 uint8_t BSP_AUDIO_OUT_ChangeBuffer(uint16_t *pData, uint16_t Size);
00243 uint8_t BSP_AUDIO_OUT_Pause(void);
00244 uint8_t BSP_AUDIO_OUT_Resume(void);
00245 uint8_t BSP_AUDIO_OUT_Stop(uint32_t Option);
00246 uint8_t BSP_AUDIO_OUT_SetVolume(uint8_t Volume);
00247 uint8_t BSP_AUDIO_OUT_SetFrequency(uint32_t AudioFreq);
00248 void    BSP_AUDIO_OUT_ChangeAudioConfig(uint32_t AudioOutOption);
00249 uint8_t BSP_AUDIO_OUT_SetMute(uint32_t Cmd);
00250 uint8_t BSP_AUDIO_OUT_SetOutputMode(uint8_t Output);
00251 void    BSP_AUDIO_OUT_RegisterCallbacks(Audio_CallbackTypeDef ErrorCallback, 
00252                                         Audio_CallbackTypeDef HalfTransferCallback, 
00253                                         Audio_CallbackTypeDef TransferCompleteCallback);
00254 
00255 uint8_t BSP_AUDIO_IN_Init(uint32_t AudioFreq, uint32_t BitRes, uint32_t ChnlNbr);
00256 uint8_t BSP_AUDIO_IN_DeInit(void);
00257 uint8_t BSP_AUDIO_IN_Record(uint16_t *pData, uint32_t Size);
00258 uint8_t BSP_AUDIO_IN_SetFrequency(uint32_t AudioFreq);
00259 uint8_t BSP_AUDIO_IN_Stop(void);
00260 uint8_t BSP_AUDIO_IN_Pause(void);
00261 uint8_t BSP_AUDIO_IN_Resume(void);
00262 void    BSP_AUDIO_IN_RegisterCallbacks(Audio_CallbackTypeDef ErrorCallback, 
00263                                        Audio_CallbackTypeDef HalfTransferCallback, 
00264                                        Audio_CallbackTypeDef TransferCompleteCallback);
00265                                        
00266                                        
00267 /* Audio recorder callback functions */
00268 static void AudioRecord_TransferComplete_CallBack(void);
00269 static void AudioRecord_HalfTransfer_CallBack(void);
00270 static void AudioRecord_Error_CallBack(void);
00271 
00272 //  uint16_t getDMAState(void);
00273 //  uint16_t getSPIState(void);
00274 //  bool getSPIFlagStatus(uint16_t flag);
00275                                        
00276 /**
00277   * @}
00278   */
00279 
00280 /**
00281   * @}
00282   */
00283 
00284 /**
00285   * @}
00286   */
00287 
00288 /**
00289   * @}
00290   */
00291 
00292 
00293 #endif /* __STM32L476G_DISCOVERY_AUDIO_H */
00294 
00295 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
00296 
00297