2 ******************************************************************************
\r
3 * @file stm32h745i_discovery_audio.h
\r
4 * @author MCD Application Team
\r
5 * @brief This file contains the common defines and functions prototypes for
\r
6 * the stm32h745i_discovery_audio.c driver.
\r
7 ******************************************************************************
\r
10 * <h2><center>© Copyright (c) 2019 STMicroelectronics.
\r
11 * All rights reserved.</center></h2>
\r
13 * This software component is licensed by ST under BSD 3-Clause license,
\r
14 * the "License"; You may not use this file except in compliance with the
\r
15 * License. You may obtain a copy of the License at:
\r
16 * opensource.org/licenses/BSD-3-Clause
\r
18 ******************************************************************************
\r
21 /* Define to prevent recursive inclusion -------------------------------------*/
\r
22 #ifndef __STM32H745I_DISCOVERY_AUDIO_H
\r
23 #define __STM32H745I_DISCOVERY_AUDIO_H
\r
29 /* Includes ------------------------------------------------------------------*/
\r
30 /* Include audio component Driver */
\r
31 #include "../Components/wm8994/wm8994.h"
\r
32 #include "stm32h745i_discovery.h"
\r
34 /* Include PDM to PCM lib header file */
\r
35 #include "pdm2pcm_glo.h"
\r
41 /** @addtogroup STM32H745I_DISCOVERY
\r
45 /** @addtogroup STM32H745I_DISCOVERY_AUDIO
\r
49 /** @defgroup STM32H745I_DISCOVERY_AUDIO_Exported_Types Exported Types
\r
54 uint32_t Frequency; /* Record Frequency */
\r
55 uint32_t BitResolution; /* Record bit resolution */
\r
56 uint32_t ChannelNbr; /* Record Channel Number */
\r
57 uint16_t *pRecBuf; /* Pointer to record user buffer */
\r
58 uint32_t RecSize; /* Size to record in mono, double size to record in stereo */
\r
59 uint32_t InputDevice; /* Audio Input Device */
\r
60 uint32_t Interface; /* Audio Input Interface */
\r
61 uint32_t MultiBuffMode; /* Multi buffer mode selection */
\r
62 }AUDIOIN_ContextTypeDef;
\r
67 /** @defgroup STM32H745I_DISCOVERY_AUDIO_Exported_Constants Exported Constants
\r
70 #define BSP_AUDIO_FREQUENCY_96K SAI_AUDIO_FREQUENCY_96K
\r
71 #define BSP_AUDIO_FREQUENCY_48K SAI_AUDIO_FREQUENCY_48K
\r
72 #define BSP_AUDIO_FREQUENCY_44K SAI_AUDIO_FREQUENCY_44K
\r
73 #define BSP_AUDIO_FREQUENCY_32K SAI_AUDIO_FREQUENCY_32K
\r
74 #define BSP_AUDIO_FREQUENCY_22K SAI_AUDIO_FREQUENCY_22K
\r
75 #define BSP_AUDIO_FREQUENCY_16K SAI_AUDIO_FREQUENCY_16K
\r
76 #define BSP_AUDIO_FREQUENCY_11K SAI_AUDIO_FREQUENCY_11K
\r
77 #define BSP_AUDIO_FREQUENCY_8K SAI_AUDIO_FREQUENCY_8K
\r
79 /*------------------------------------------------------------------------------
\r
80 USER SAI defines parameters
\r
81 -----------------------------------------------------------------------------*/
\r
82 /** In W8994 codec the Audio frame contains 4 slots : TDM Mode
\r
84 * +------------------|------------------|--------------------|-------------------+
\r
85 * | CODEC_SLOT0 Left | CODEC_SLOT1 Left | CODEC_SLOT0 Right | CODEC_SLOT1 Right |
\r
86 * +------------------------------------------------------------------------------+
\r
88 /* To have 2 separate audio stream in Both headphone and speaker the 4 slot must be activated */
\r
89 #define CODEC_AUDIOFRAME_SLOT_0123 SAI_SLOTACTIVE_0 | SAI_SLOTACTIVE_1 | SAI_SLOTACTIVE_2 | SAI_SLOTACTIVE_3
\r
91 /* To have an audio stream in headphone only SAI Slot 0 and Slot 2 must be activated */
\r
92 #define CODEC_AUDIOFRAME_SLOT_02 SAI_SLOTACTIVE_0 | SAI_SLOTACTIVE_2
\r
93 /* To have an audio stream in speaker only SAI Slot 1 and Slot 3 must be activated */
\r
94 #define CODEC_AUDIOFRAME_SLOT_13 SAI_SLOTACTIVE_1 | SAI_SLOTACTIVE_3
\r
95 /* To have an audio stream in SAI PDM input Slot 0 must be activated */
\r
96 #define CODEC_AUDIOFRAME_SLOT_0 SAI_SLOTACTIVE_0
\r
97 /* To have an audio stream in SAI PDM input Slot 1 must be activated */
\r
98 #define CODEC_AUDIOFRAME_SLOT_1 SAI_SLOTACTIVE_1
\r
100 /*------------------------------------------------------------------------------
\r
101 AUDIO OUT CONFIGURATION
\r
102 ------------------------------------------------------------------------------*/
\r
103 /* SAI peripheral configuration defines */
\r
104 #define AUDIO_OUT_SAIx SAI2_Block_A
\r
105 #define AUDIO_OUT_SAIx_CLK_ENABLE() __HAL_RCC_SAI2_CLK_ENABLE()
\r
106 #define AUDIO_OUT_SAIx_CLK_DISABLE() __HAL_RCC_SAI2_CLK_DISABLE()
\r
107 #define AUDIO_OUT_SAIx_AF GPIO_AF10_SAI2
\r
109 #define AUDIO_OUT_SAIx_MCLK_ENABLE() __HAL_RCC_GPIOI_CLK_ENABLE()
\r
110 #define AUDIO_OUT_SAIx_MCLK_GPIO_PORT GPIOI
\r
111 #define AUDIO_OUT_SAIx_MCLK_PIN GPIO_PIN_4
\r
112 #define AUDIO_OUT_SAIx_SD_FS_CLK_ENABLE() __HAL_RCC_GPIOI_CLK_ENABLE()
\r
113 #define AUDIO_OUT_SAIx_SD_FS_SCK_GPIO_PORT GPIOI
\r
114 #define AUDIO_OUT_SAIx_FS_PIN GPIO_PIN_7
\r
115 #define AUDIO_OUT_SAIx_SCK_PIN GPIO_PIN_5
\r
116 #define AUDIO_OUT_SAIx_SD_PIN GPIO_PIN_6
\r
118 /* SAI DMA Stream definitions */
\r
119 #define AUDIO_OUT_SAIx_DMAx_CLK_ENABLE() __HAL_RCC_DMA2_CLK_ENABLE()
\r
120 #define AUDIO_OUT_SAIx_DMAx_STREAM DMA2_Stream1
\r
121 #define AUDIO_OUT_SAIx_DMAx_REQUEST DMA_REQUEST_SAI2_A
\r
122 #define AUDIO_OUT_SAIx_DMAx_IRQ DMA2_Stream1_IRQn
\r
123 #define AUDIO_OUT_SAIx_DMAx_PERIPH_DATA_SIZE DMA_PDATAALIGN_HALFWORD
\r
124 #define AUDIO_OUT_SAIx_DMAx_MEM_DATA_SIZE DMA_MDATAALIGN_HALFWORD
\r
125 #define AUDIO_OUT_SAIx_DMAx_IRQHandler DMA2_Stream1_IRQHandler
\r
127 /* Select the interrupt preemption priority and subpriority for the DMA interrupt */
\r
128 #define AUDIO_OUT_IRQ_PREPRIO ((uint32_t)0x0E)
\r
130 /*------------------------------------------------------------------------------
\r
131 AUDIO IN CONFIGURATION
\r
132 ------------------------------------------------------------------------------*/
\r
133 /* SAI peripheral configuration defines */
\r
134 #define AUDIO_IN_SAIx SAI2_Block_B
\r
135 #define AUDIO_IN_SAIx_CLK_ENABLE() __HAL_RCC_SAI2_CLK_ENABLE()
\r
136 #define AUDIO_IN_SAIx_CLK_DISABLE() __HAL_RCC_SAI2_CLK_DISABLE()
\r
137 #define AUDIO_IN_SAIx_AF GPIO_AF10_SAI2
\r
138 #define AUDIO_IN_SAIx_SD_ENABLE() __HAL_RCC_GPIOG_CLK_ENABLE()
\r
139 #define AUDIO_IN_SAIx_SD_GPIO_PORT GPIOG
\r
140 #define AUDIO_IN_SAIx_SD_PIN GPIO_PIN_10
\r
142 /* SAI DMA Stream definitions */
\r
143 #define AUDIO_IN_SAIx_DMAx_CLK_ENABLE() __HAL_RCC_DMA2_CLK_ENABLE()
\r
144 #define AUDIO_IN_SAIx_DMAx_STREAM DMA2_Stream4
\r
145 #define AUDIO_IN_SAIx_DMAx_REQUEST DMA_REQUEST_SAI2_B
\r
146 #define AUDIO_IN_SAIx_DMAx_IRQ DMA2_Stream4_IRQn
\r
147 #define AUDIO_IN_SAIx_DMAx_PERIPH_DATA_SIZE DMA_PDATAALIGN_HALFWORD
\r
148 #define AUDIO_IN_SAIx_DMAx_MEM_DATA_SIZE DMA_MDATAALIGN_HALFWORD
\r
150 #define AUDIO_IN_SAIx_DMAx_IRQHandler DMA2_Stream4_IRQHandler
\r
152 /* SAI PDM input definitions */
\r
153 #define AUDIO_IN_SAI_PDMx SAI4_Block_A
\r
154 #define AUDIO_IN_SAI_PDMx_CLK_ENABLE() __HAL_RCC_SAI4_CLK_ENABLE()
\r
155 #define AUDIO_IN_SAI_PDMx_CLK_DISABLE() __HAL_RCC_SAI4_CLK_DISABLE()
\r
156 #define AUDIO_IN_SAI_PDMx_CLK_IN_ENABLE() __HAL_RCC_GPIOE_CLK_ENABLE()
\r
157 #define AUDIO_IN_SAI_PDMx_CLK_IN_PIN GPIO_PIN_5
\r
158 #define AUDIO_IN_SAI_PDMx_CLK_IN_PORT GPIOE
\r
159 #define AUDIO_IN_SAI_PDMx_DATA_IN_ENABLE() __HAL_RCC_GPIOE_CLK_ENABLE()
\r
160 #define AUDIO_IN_SAI_PDMx_DATA_IN_PIN GPIO_PIN_4
\r
161 #define AUDIO_IN_SAI_PDMx_DATA_IN_PORT GPIOE
\r
162 #define AUDIO_IN_SAI_PDMx_DATA_CLK_AF GPIO_AF10_SAI4
\r
163 #define AUDIO_IN_SAI_PDMx_IRQHandler SAI4_IRQHandler
\r
164 #define AUDIO_IN_SAI_PDMx_IRQ SAI4_IRQn
\r
166 /* SAI PDM DMA Stream definitions */
\r
167 #define AUDIO_IN_SAI_PDMx_DMAx_CLK_ENABLE() __HAL_RCC_BDMA_CLK_ENABLE()
\r
168 #define AUDIO_IN_SAI_PDMx_DMAx_STREAM BDMA_Channel1
\r
169 #define AUDIO_IN_SAI_PDMx_DMAx_REQUEST BDMA_REQUEST_SAI4_A
\r
170 #define AUDIO_IN_SAI_PDMx_DMAx_IRQ BDMA_Channel1_IRQn
\r
171 #define AUDIO_IN_SAI_PDMx_DMAx_PERIPH_DATA_SIZE DMA_PDATAALIGN_HALFWORD
\r
172 #define AUDIO_IN_SAI_PDMx_DMAx_MEM_DATA_SIZE DMA_MDATAALIGN_HALFWORD
\r
173 #define AUDIO_IN_SAI_PDMx_DMAx_IRQHandler BDMA_Channel1_IRQHandler
\r
175 /* Select the interrupt preemption priority and subpriority for the DMA interrupt */
\r
176 #define AUDIO_IN_IRQ_PREPRIO ((uint32_t)0x0F)
\r
179 /*------------------------------------------------------------------------------
\r
180 CONFIGURATION: Audio Driver Configuration parameters
\r
181 ------------------------------------------------------------------------------*/
\r
183 #define AUDIODATA_SIZE ((uint32_t)2) /* 16-bits audio data size */
\r
185 /* Audio status definition */
\r
186 #define AUDIO_OK ((uint8_t)0)
\r
187 #define AUDIO_ERROR ((uint8_t)1)
\r
188 #define AUDIO_TIMEOUT ((uint8_t)2)
\r
190 /* Audio In default settings */
\r
191 #define DEFAULT_AUDIO_IN_FREQ BSP_AUDIO_FREQUENCY_16K
\r
192 #define DEFAULT_AUDIO_IN_BIT_RESOLUTION ((uint8_t)16)
\r
193 #define DEFAULT_AUDIO_IN_CHANNEL_NBR ((uint8_t)2)
\r
194 #define DEFAULT_AUDIO_IN_VOLUME ((uint16_t)64)
\r
196 /*------------------------------------------------------------------------------
\r
197 OUTPUT DEVICES definition
\r
198 ------------------------------------------------------------------------------*/
\r
199 /* Alias on existing output devices to adapt for 2 headphones output */
\r
200 #define OUTPUT_DEVICE_HEADPHONE1 OUTPUT_DEVICE_HEADPHONE
\r
201 #define OUTPUT_DEVICE_HEADPHONE2 OUTPUT_DEVICE_SPEAKER /* Headphone2 is connected to Speaker output of the wm8994 */
\r
203 /*------------------------------------------------------------------------------
\r
204 INPUT DEVICES definition
\r
205 ------------------------------------------------------------------------------*/
\r
206 /* Analog microphone input from 3.5 audio jack connector */
\r
207 #define INPUT_DEVICE_ANALOG_MIC ((uint32_t)0x00000001)
\r
208 /* MP34DT01TR digital microphone on PCB top side */
\r
209 #define INPUT_DEVICE_DIGITAL_MIC1 ((uint32_t)0x00000010)
\r
210 #define INPUT_DEVICE_DIGITAL_MIC2 ((uint32_t)0x00000020)
\r
211 #define INPUT_DEVICE_DIGITAL_MIC ((uint32_t)(INPUT_DEVICE_DIGITAL_MIC1 | INPUT_DEVICE_DIGITAL_MIC2))
\r
213 /* Audio In interface for Digital mic */
\r
214 #define AUDIO_IN_INTERFACE_SAI ((uint16_t)0)
\r
215 #define AUDIO_IN_INTERFACE_PDM ((uint16_t)1)
\r
221 /** @defgroup STM32H745I_DISCOVERY_AUDIO_Exported_Macros Exported Macros
\r
224 #define DMA_MAX_SIZE 0xFFFF
\r
225 #define DMA_MAX(x) (((x) <= DMA_MAX_SIZE)? (x):DMA_MAX_SIZE)
\r
226 #define POS_VAL(VAL) (POSITION_VAL(VAL) - 4)
\r
231 /** @addtogroup STM32H745I_DISCOVERY_AUDIO_OUT_Exported_Functions
\r
234 uint8_t BSP_AUDIO_OUT_Init(uint16_t OutputDevice, uint8_t Volume, uint32_t AudioFreq);
\r
235 void BSP_AUDIO_OUT_DeInit(void);
\r
236 uint8_t BSP_AUDIO_OUT_Play(uint16_t* pBuffer, uint32_t Size);
\r
237 void BSP_AUDIO_OUT_ChangeBuffer(uint16_t *pData, uint16_t Size);
\r
238 uint8_t BSP_AUDIO_OUT_Pause(void);
\r
239 uint8_t BSP_AUDIO_OUT_Resume(void);
\r
240 uint8_t BSP_AUDIO_OUT_Stop(uint32_t Option);
\r
241 uint8_t BSP_AUDIO_OUT_SetVolume(uint8_t Volume);
\r
242 void BSP_AUDIO_OUT_SetFrequency(uint32_t AudioFreq);
\r
243 void BSP_AUDIO_OUT_SetAudioFrameSlot(uint32_t AudioFrameSlot);
\r
244 uint8_t BSP_AUDIO_OUT_SetMute(uint32_t Cmd);
\r
245 uint8_t BSP_AUDIO_OUT_SetOutputMode(uint8_t Output);
\r
247 /* User Callbacks: user has to implement these functions in his code if they are needed. */
\r
248 /* This function is called when the requested data has been completely transferred.*/
\r
249 void BSP_AUDIO_OUT_TransferComplete_CallBack(void);
\r
251 /* This function is called when half of the requested buffer has been transferred. */
\r
252 void BSP_AUDIO_OUT_HalfTransfer_CallBack(void);
\r
254 /* This function is called when an Interrupt due to transfer error on or peripheral
\r
256 void BSP_AUDIO_OUT_Error_CallBack(void);
\r
258 /* These function can be modified in case the current settings (e.g. DMA stream)
\r
259 need to be changed for specific application needs */
\r
260 void BSP_AUDIO_OUT_ClockConfig(SAI_HandleTypeDef *hsai, uint32_t AudioFreq, void *Params);
\r
261 void BSP_AUDIO_OUT_MspInit(SAI_HandleTypeDef *hsai, void *Params);
\r
262 void BSP_AUDIO_OUT_MspDeInit(SAI_HandleTypeDef *hsai, void *Params);
\r
268 /** @addtogroup STM32H745I_DISCOVERY_AUDIO_IN_Exported_Functions
\r
271 uint8_t BSP_AUDIO_IN_Init(uint32_t AudioFreq, uint32_t BitRes, uint32_t ChnlNbr);
\r
272 uint8_t BSP_AUDIO_IN_InitEx(uint16_t InputDevice, uint32_t AudioFreq, uint32_t BitRes, uint32_t ChnlNbr);
\r
273 uint8_t BSP_AUDIO_IN_AllocScratch (int32_t *pScratch, uint32_t size);
\r
274 uint8_t BSP_AUDIO_IN_Record(uint16_t *pBuf, uint32_t Size);
\r
275 uint8_t BSP_AUDIO_IN_RecordEx(uint32_t *pBuf, uint32_t Size);
\r
276 uint8_t BSP_AUDIO_IN_SetFrequency(uint32_t AudioFreq);
\r
277 uint8_t BSP_AUDIO_IN_Stop(void);
\r
278 uint8_t BSP_AUDIO_IN_StopEx(uint32_t InputDevice);
\r
279 uint8_t BSP_AUDIO_IN_Pause(void);
\r
280 uint8_t BSP_AUDIO_IN_PauseEx(uint32_t InputDevice);
\r
281 uint8_t BSP_AUDIO_IN_Resume(void);
\r
282 uint8_t BSP_AUDIO_IN_ResumeEx(uint32_t *pBuf, uint32_t InputDevice);
\r
283 uint8_t BSP_AUDIO_IN_SetVolume(uint8_t Volume);
\r
284 void BSP_AUDIO_IN_DeInit(void);
\r
285 uint8_t BSP_AUDIO_IN_PDMToPCM(uint16_t *PDMBuf, uint16_t *PCMBuf);
\r
286 uint8_t BSP_AUDIO_IN_PDMToPCM_Init(uint32_t AudioFreq, uint32_t ChnlNbrIn, uint32_t ChnlNbrOut);
\r
287 void BSP_AUDIO_IN_SelectInterface(uint32_t Interface);
\r
288 uint32_t BSP_AUDIO_IN_GetInterface(void);
\r
289 uint8_t BSP_AUDIO_IN_GetChannelNumber(void);
\r
290 uint8_t BSP_AUDIO_IN_OUT_Init(uint32_t InputDevice, uint32_t OutputDevice, uint32_t AudioFreq, uint32_t BitRes, uint32_t ChnlNbr);
\r
292 /* User Callbacks: user has to implement these functions in his code if they are needed. */
\r
293 /* This function should be implemented by the user application.
\r
294 It is called into this driver when the current buffer is filled to prepare the next
\r
295 buffer pointer and its size. */
\r
296 void BSP_AUDIO_IN_TransferComplete_CallBack(void);
\r
297 void BSP_AUDIO_IN_HalfTransfer_CallBack(void);
\r
298 void BSP_AUDIO_IN_TransferComplete_CallBackEx(uint32_t InputDevice);
\r
299 void BSP_AUDIO_IN_HalfTransfer_CallBackEx(uint32_t InputDevice);
\r
301 /* This function is called when an Interrupt due to transfer error on or peripheral
\r
303 void BSP_AUDIO_IN_Error_CallBack(void);
\r
305 /* These function can be modified in case the current settings (e.g. DMA stream)
\r
306 need to be changed for specific application needs */
\r
307 void BSP_AUDIO_IN_ClockConfig(uint32_t AudioFreq, void *Params);
\r
308 void BSP_AUDIO_IN_MspInit(void);
\r
309 void BSP_AUDIO_IN_MspDeInit(void);
\r
330 #endif /* __STM32H745I_DISCOVERY_AUDIO_H */
\r
332 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
\r