]> git.donarmstrong.com Git - qmk_firmware.git/blob - tool/mbed/mbed-sdk/libraries/mbed/targets/cmsis/TARGET_STM/TARGET_STM32L0/stm32l0xx_hal_i2s.h
Squashed 'tmk_core/' changes from 7967731..b9e0ea0
[qmk_firmware.git] / tool / mbed / mbed-sdk / libraries / mbed / targets / cmsis / TARGET_STM / TARGET_STM32L0 / stm32l0xx_hal_i2s.h
1 /**
2   ******************************************************************************
3   * @file    stm32l0xx_hal_i2s.h
4   * @author  MCD Application Team
5   * @version V1.2.0
6   * @date    06-February-2015
7   * @brief   Header file of I2S HAL module.
8   ******************************************************************************
9   * @attention
10   *
11   * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
12   *
13   * Redistribution and use in source and binary forms, with or without modification,
14   * are permitted provided that the following conditions are met:
15   *   1. Redistributions of source code must retain the above copyright notice,
16   *      this list of conditions and the following disclaimer.
17   *   2. Redistributions in binary form must reproduce the above copyright notice,
18   *      this list of conditions and the following disclaimer in the documentation
19   *      and/or other materials provided with the distribution.
20   *   3. Neither the name of STMicroelectronics nor the names of its contributors
21   *      may be used to endorse or promote products derived from this software
22   *      without specific prior written permission.
23   *
24   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
27   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
28   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
30   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
31   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
32   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34   *
35   ******************************************************************************
36   */ 
37
38 /* Define to prevent recursive inclusion -------------------------------------*/
39 #ifndef __STM32L0xx_HAL_I2S_H
40 #define __STM32L0xx_HAL_I2S_H
41
42 #ifdef __cplusplus
43  extern "C" {
44 #endif
45
46 #if !defined (STM32L031xx) && !defined (STM32L041xx)
47 /* Includes ------------------------------------------------------------------*/
48 #include "stm32l0xx_hal_def.h"  
49
50 /** @addtogroup STM32L0xx_HAL_Driver
51   * @{
52   */
53
54 /** @addtogroup I2S
55   * @{
56   */ 
57
58 /* Exported types ------------------------------------------------------------*/
59 /** @defgroup I2S_Exported_Types I2S Exported Types
60   * @{
61   */
62
63 /** 
64   * @brief I2S Init structure definition  
65   */
66 typedef struct
67 {
68   uint32_t Mode;         /*!< Specifies the I2S operating mode.
69                               This parameter can be a value of @ref I2S_Mode */
70
71   uint32_t Standard;     /*!< Specifies the standard used for the I2S communication.
72                               This parameter can be a value of @ref I2S_Standard */
73
74   uint32_t DataFormat;   /*!< Specifies the data format for the I2S communication.
75                               This parameter can be a value of @ref I2S_Data_Format */
76
77   uint32_t MCLKOutput;   /*!< Specifies whether the I2S MCLK output is enabled or not.
78                               This parameter can be a value of @ref I2S_MCLK_Output */
79
80   uint32_t AudioFreq;    /*!< Specifies the frequency selected for the I2S communication.
81                               This parameter can be a value of @ref I2S_Audio_Frequency */
82
83   uint32_t CPOL;         /*!< Specifies the idle state of the I2S clock.
84                               This parameter can be a value of @ref I2S_Clock_Polarity */
85
86 }I2S_InitTypeDef;
87
88 /** 
89   * @brief  HAL State structures definition
90   */ 
91 typedef enum
92 {
93   HAL_I2S_STATE_RESET      = 0x00,  /*!< I2S not yet initialized or disabled                */
94   HAL_I2S_STATE_READY      = 0x01,  /*!< I2S initialized and ready for use                  */
95   HAL_I2S_STATE_BUSY       = 0x02,  /*!< I2S internal process is ongoing                    */   
96   HAL_I2S_STATE_BUSY_TX    = 0x12,  /*!< Data Transmission process is ongoing               */ 
97   HAL_I2S_STATE_BUSY_RX    = 0x22,  /*!< Data Reception process is ongoing                  */
98   HAL_I2S_STATE_TIMEOUT    = 0x03,  /*!< I2S timeout state                                  */ 
99   HAL_I2S_STATE_ERROR      = 0x04   /*!< I2S error state                                    */      
100 }HAL_I2S_StateTypeDef;
101
102 /** 
103   * @brief I2S handle Structure definition  
104   */
105 typedef struct
106 {
107   SPI_TypeDef                *Instance;    /* I2S registers base address        */
108
109   I2S_InitTypeDef            Init;         /* I2S communication parameters      */
110   
111   uint16_t                   *pTxBuffPtr;  /* Pointer to I2S Tx transfer buffer */
112   
113   __IO uint16_t              TxXferSize;   /* I2S Tx transfer size              */
114   
115   __IO uint16_t              TxXferCount;  /* I2S Tx transfer Counter           */
116   
117   uint16_t                   *pRxBuffPtr;  /* Pointer to I2S Rx transfer buffer */
118   
119   __IO uint16_t              RxXferSize;   /* I2S Rx transfer size              */
120   
121   __IO uint16_t              RxXferCount;  /* I2S Rx transfer counter 
122                                               (This field is initialized at the 
123                                                same value as transfer size at the 
124                                                beginning of the transfer and 
125                                                decremented when a sample is received. 
126                                                NbSamplesReceived = RxBufferSize-RxBufferCount) */
127
128   DMA_HandleTypeDef          *hdmatx;      /* I2S Tx DMA handle parameters      */
129
130   DMA_HandleTypeDef          *hdmarx;      /* I2S Rx DMA handle parameters      */
131   
132   __IO HAL_LockTypeDef       Lock;         /* I2S locking object                */
133   
134   __IO HAL_I2S_StateTypeDef  State;        /* I2S communication state           */
135
136   __IO  uint32_t             ErrorCode;    /* I2S Error code                    */
137
138 }I2S_HandleTypeDef;
139 /**
140   * @}
141   */
142
143 /* Exported constants --------------------------------------------------------*/
144 /** @defgroup I2S_Exported_Constants I2S Exported Constants
145   * @{
146   */
147
148 /**
149   * @defgroup  I2S_ErrorCode I2S Error Code
150   * @{
151   */
152 #define HAL_I2S_ERROR_NONE      ((uint32_t)0x00)    /*!< No error                    */
153 #define HAL_I2S_ERROR_UDR       ((uint32_t)0x01)    /*!< I2S Underrun error          */
154 #define HAL_I2S_ERROR_OVR       ((uint32_t)0x02)    /*!< I2S Overrun error           */
155 #define HAL_I2S_ERROR_FRE       ((uint32_t)0x04)    /*!< I2S Frame format error      */
156 #define HAL_I2S_ERROR_DMA       ((uint32_t)0x08)    /*!< DMA transfer error          */
157   /**
158     * @}
159     */
160
161 /** @defgroup I2S_Mode I2S Mode
162   * @{
163   */
164 #define I2S_MODE_SLAVE_TX                ((uint32_t) 0x00000000)
165 #define I2S_MODE_SLAVE_RX                ((uint32_t) SPI_I2SCFGR_I2SCFG_0)
166 #define I2S_MODE_MASTER_TX               ((uint32_t) SPI_I2SCFGR_I2SCFG_1)
167 #define I2S_MODE_MASTER_RX               ((uint32_t)(SPI_I2SCFGR_I2SCFG_0 |\
168                                                      SPI_I2SCFGR_I2SCFG_1))
169 /**
170   * @}
171   */
172   
173 /** @defgroup I2S_Standard I2S Standard
174   * @{
175   */
176 #define I2S_STANDARD_PHILIPS             ((uint32_t) 0x00000000)
177 #define I2S_STANDARD_MSB                 ((uint32_t) SPI_I2SCFGR_I2SSTD_0)
178 #define I2S_STANDARD_LSB                 ((uint32_t) SPI_I2SCFGR_I2SSTD_1)
179 #define I2S_STANDARD_PCM_SHORT           ((uint32_t)(SPI_I2SCFGR_I2SSTD_0 |\
180                                                      SPI_I2SCFGR_I2SSTD_1))
181 #define I2S_STANDARD_PCM_LONG            ((uint32_t)(SPI_I2SCFGR_I2SSTD_0 |\
182                                                      SPI_I2SCFGR_I2SSTD_1 |\
183                                                      SPI_I2SCFGR_PCMSYNC))
184 /** @defgroup I2S_Legacy I2S Legacy
185   * @{
186   */
187 #define I2S_STANDARD_PHILLIPS      I2S_STANDARD_PHILIPS
188 /**
189   * @}
190   */
191
192 /**
193   * @}
194   */
195   
196 /** @defgroup I2S_Data_Format I2S Data Format
197   * @{
198   */
199 #define I2S_DATAFORMAT_16B               ((uint32_t) 0x00000000)
200 #define I2S_DATAFORMAT_16B_EXTENDED      ((uint32_t) SPI_I2SCFGR_CHLEN)
201 #define I2S_DATAFORMAT_24B               ((uint32_t)(SPI_I2SCFGR_CHLEN | SPI_I2SCFGR_DATLEN_0))
202 #define I2S_DATAFORMAT_32B               ((uint32_t)(SPI_I2SCFGR_CHLEN | SPI_I2SCFGR_DATLEN_1))
203 /**
204   * @}
205   */
206
207 /** @defgroup I2S_MCLK_Output I2S MCLK Output
208   * @{
209   */
210 #define I2S_MCLKOUTPUT_ENABLE           ((uint32_t)SPI_I2SPR_MCKOE)
211 #define I2S_MCLKOUTPUT_DISABLE          ((uint32_t)0x00000000)
212 /**
213   * @}
214   */
215
216 /** @defgroup I2S_Audio_Frequency I2S Audio Frequency
217   * @{
218   */
219 #define I2S_AUDIOFREQ_192K               ((uint32_t)192000)
220 #define I2S_AUDIOFREQ_96K                ((uint32_t)96000)
221 #define I2S_AUDIOFREQ_48K                ((uint32_t)48000)
222 #define I2S_AUDIOFREQ_44K                ((uint32_t)44100)
223 #define I2S_AUDIOFREQ_32K                ((uint32_t)32000)
224 #define I2S_AUDIOFREQ_22K                ((uint32_t)22050)
225 #define I2S_AUDIOFREQ_16K                ((uint32_t)16000)
226 #define I2S_AUDIOFREQ_11K                ((uint32_t)11025)
227 #define I2S_AUDIOFREQ_8K                 ((uint32_t)8000)
228 #define I2S_AUDIOFREQ_DEFAULT            ((uint32_t)2)
229 /**
230   * @}
231   */
232
233 /** @defgroup I2S_Clock_Polarity I2S Clock Polarity
234   * @{
235   */
236 #define I2S_CPOL_LOW                    ((uint32_t)0x00000000)
237 #define I2S_CPOL_HIGH                   ((uint32_t)SPI_I2SCFGR_CKPOL)
238 /**
239   * @}
240   */
241
242 /** @defgroup I2S_Interrupt_configuration_definition I2S Interrupt configuration definition
243   * @{
244   */
245 #define I2S_IT_TXE                      SPI_CR2_TXEIE
246 #define I2S_IT_RXNE                     SPI_CR2_RXNEIE
247 #define I2S_IT_ERR                      SPI_CR2_ERRIE
248 /**
249   * @}
250   */
251
252 /** @defgroup I2S_Flag_definition I2S Flag definition
253   * @{
254   */
255 #define I2S_FLAG_TXE                    SPI_SR_TXE
256 #define I2S_FLAG_RXNE                   SPI_SR_RXNE
257
258 #define I2S_FLAG_UDR                    SPI_SR_UDR
259 #define I2S_FLAG_OVR                    SPI_SR_OVR
260 #define I2S_FLAG_FRE                    SPI_SR_FRE
261
262 #define I2S_FLAG_CHSIDE                 SPI_SR_CHSIDE
263 #define I2S_FLAG_BSY                    SPI_SR_BSY
264 /**
265   * @}
266   */
267
268 /**
269   * @}
270   */ 
271   
272 /* Exported macro ------------------------------------------------------------*/
273 /** @defgroup I2S_Exported_macros I2S Exported Macros
274   * @{
275   */
276
277 /** @brief  Reset I2S handle state
278   * @param  __HANDLE__: specifies the I2S Handle.
279   * @retval None
280   */
281 #define __HAL_I2S_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_I2S_STATE_RESET)
282
283 /** @brief  Enable the specified SPI peripheral (in I2S mode).
284   * @param  __HANDLE__: specifies the I2S Handle. 
285   * @retval None
286   */
287 #define __HAL_I2S_ENABLE(__HANDLE__)    (SET_BIT((__HANDLE__)->Instance->I2SCFGR, SPI_I2SCFGR_I2SE))
288
289 /** @brief  Disable the specified SPI peripheral (in I2S mode).
290   * @param  __HANDLE__: specifies the I2S Handle. 
291   * @retval None
292   */
293 #define __HAL_I2S_DISABLE(__HANDLE__) (CLEAR_BIT((__HANDLE__)->Instance->I2SCFGR, SPI_I2SCFGR_I2SE))
294
295 /** @brief  Enable the specified I2S interrupts.
296   * @param  __HANDLE__: specifies the I2S Handle.
297   * @param  __INTERRUPT__: specifies the interrupt source to enable or disable.
298   *         This parameter can be one of the following values:
299   *            @arg I2S_IT_TXE: Tx buffer empty interrupt enable
300   *            @arg I2S_IT_RXNE: RX buffer not empty interrupt enable
301   *            @arg I2S_IT_ERR: Error interrupt enable
302   * @retval None
303   */  
304 #define __HAL_I2S_ENABLE_IT(__HANDLE__, __INTERRUPT__)    (SET_BIT((__HANDLE__)->Instance->CR2,(__INTERRUPT__)))
305
306 /** @brief  Disable the specified I2S interrupts.
307   * @param  __HANDLE__: specifies the I2S Handle.
308   * @param  __INTERRUPT__: specifies the interrupt source to enable or disable.
309   *         This parameter can be one of the following values:
310   *            @arg I2S_IT_TXE: Tx buffer empty interrupt enable
311   *            @arg I2S_IT_RXNE: RX buffer not empty interrupt enable
312   *            @arg I2S_IT_ERR: Error interrupt enable
313   * @retval None
314   */ 
315 #define __HAL_I2S_DISABLE_IT(__HANDLE__, __INTERRUPT__) (CLEAR_BIT((__HANDLE__)->Instance->CR2,(__INTERRUPT__)))
316  
317 /** @brief  Checks if the specified I2S interrupt source is enabled or disabled.
318   * @param  __HANDLE__: specifies the I2S Handle.
319   *         This parameter can be I2S where x: 1, 2, or 3 to select the I2S peripheral.
320   * @param  __INTERRUPT__: specifies the I2S interrupt source to check.
321   *          This parameter can be one of the following values:
322   *            @arg I2S_IT_TXE: Tx buffer empty interrupt enable
323   *            @arg I2S_IT_RXNE: RX buffer not empty interrupt enable
324   *            @arg I2S_IT_ERR: Error interrupt enable
325   * @retval The new state of __IT__ (TRUE or FALSE).
326   */
327 #define __HAL_I2S_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->CR2 & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
328
329 /** @brief  Checks whether the specified I2S flag is set or not.
330   * @param  __HANDLE__: specifies the I2S Handle.
331   * @param  __FLAG__: specifies the flag to check.
332   *         This parameter can be one of the following values:
333   *            @arg I2S_FLAG_RXNE: Receive buffer not empty flag
334   *            @arg I2S_FLAG_TXE: Transmit buffer empty flag
335   *            @arg I2S_FLAG_UDR: Underrun flag
336   *            @arg I2S_FLAG_OVR: Overrun flag
337   *            @arg I2S_FLAG_CHSIDE: Channel Side flag
338   *            @arg I2S_FLAG_BSY: Busy flag
339   * @retval The new state of __FLAG__ (TRUE or FALSE).
340   */
341 #define __HAL_I2S_GET_FLAG(__HANDLE__, __FLAG__) ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))
342
343 /** @brief Clears the I2S OVR pending flag.
344   * @param  __HANDLE__: specifies the I2S Handle.
345   * @retval None
346   */                                                                                                   
347 #define __HAL_I2S_CLEAR_OVRFLAG(__HANDLE__) do{__IO uint32_t tmpreg = (__HANDLE__)->Instance->DR;\
348                                                              tmpreg = (__HANDLE__)->Instance->SR;\
349                                                              UNUSED(tmpreg);\
350                                               }while(0)
351 /** @brief Clears the I2S UDR pending flag.
352   * @param  __HANDLE__: specifies the I2S Handle.
353   * @retval None
354   */
355 #define __HAL_I2S_CLEAR_UDRFLAG(__HANDLE__)((__HANDLE__)->Instance->SR)
356 /**
357   * @}
358   */ 
359                                                 
360 /* Exported functions --------------------------------------------------------*/
361 /** @addtogroup I2S_Exported_Functions
362   * @{
363   */
364                                                 
365 /** @addtogroup I2S_Exported_Functions_Group1
366   * @{
367   */
368 /* Initialization/de-initialization functions  ********************************/
369 HAL_StatusTypeDef HAL_I2S_Init(I2S_HandleTypeDef *hi2s);
370 HAL_StatusTypeDef HAL_I2S_DeInit (I2S_HandleTypeDef *hi2s);
371 void HAL_I2S_MspInit(I2S_HandleTypeDef *hi2s);
372 void HAL_I2S_MspDeInit(I2S_HandleTypeDef *hi2s);
373 /**
374   * @}
375   */
376
377 /** @addtogroup I2S_Exported_Functions_Group2
378   * @{
379   */
380 /* I/O operation functions  ***************************************************/
381  /* Blocking mode: Polling */
382 HAL_StatusTypeDef HAL_I2S_Transmit(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size, uint32_t Timeout);
383 HAL_StatusTypeDef HAL_I2S_Receive(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size, uint32_t Timeout);
384
385  /* Non-Blocking mode: Interrupt */
386 HAL_StatusTypeDef HAL_I2S_Transmit_IT(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size);
387 HAL_StatusTypeDef HAL_I2S_Receive_IT(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size);
388 void HAL_I2S_IRQHandler(I2S_HandleTypeDef *hi2s);
389
390 /* Non-Blocking mode: DMA */
391 HAL_StatusTypeDef HAL_I2S_Transmit_DMA(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size);
392 HAL_StatusTypeDef HAL_I2S_Receive_DMA(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size);
393
394 HAL_StatusTypeDef HAL_I2S_DMAPause(I2S_HandleTypeDef *hi2s);
395 HAL_StatusTypeDef HAL_I2S_DMAResume(I2S_HandleTypeDef *hi2s);
396 HAL_StatusTypeDef HAL_I2S_DMAStop(I2S_HandleTypeDef *hi2s);
397
398 /* Callbacks used in non blocking modes (Interrupt and DMA) *******************/
399 void HAL_I2S_TxHalfCpltCallback(I2S_HandleTypeDef *hi2s);
400 void HAL_I2S_TxCpltCallback(I2S_HandleTypeDef *hi2s);
401 void HAL_I2S_RxHalfCpltCallback(I2S_HandleTypeDef *hi2s);
402 void HAL_I2S_RxCpltCallback(I2S_HandleTypeDef *hi2s);
403 void HAL_I2S_ErrorCallback(I2S_HandleTypeDef *hi2s);
404 /**
405   * @}
406   */
407
408 /** @addtogroup I2S_Exported_Functions_Group3
409   * @{
410   */
411 /* Peripheral Control and State functions  ************************************/
412 HAL_I2S_StateTypeDef HAL_I2S_GetState(I2S_HandleTypeDef *hi2s);
413 uint32_t HAL_I2S_GetError(I2S_HandleTypeDef *hi2s);
414 /**
415   * @}
416   */
417
418 /**
419   * @}
420   */
421
422 /* Private macros ------------------------------------------------------------*/
423 /** @defgroup I2S_Private_Macros I2S Private Macros
424   * @{
425   */
426 #define IS_I2S_MODE(MODE) (((MODE) == I2S_MODE_SLAVE_TX)  || \
427                            ((MODE) == I2S_MODE_SLAVE_RX)  || \
428                            ((MODE) == I2S_MODE_MASTER_TX) || \
429                            ((MODE) == I2S_MODE_MASTER_RX))
430
431 #define IS_I2S_STANDARD(STANDARD) (((STANDARD) == I2S_STANDARD_PHILIPS)   || \
432                                    ((STANDARD) == I2S_STANDARD_MSB)       || \
433                                    ((STANDARD) == I2S_STANDARD_LSB)       || \
434                                    ((STANDARD) == I2S_STANDARD_PCM_SHORT) || \
435                                    ((STANDARD) == I2S_STANDARD_PCM_LONG))
436
437 #define IS_I2S_DATA_FORMAT(FORMAT) (((FORMAT) == I2S_DATAFORMAT_16B)          || \
438                                     ((FORMAT) == I2S_DATAFORMAT_16B_EXTENDED) || \
439                                     ((FORMAT) == I2S_DATAFORMAT_24B)          || \
440                                     ((FORMAT) == I2S_DATAFORMAT_32B))
441
442 #define IS_I2S_MCLK_OUTPUT(OUTPUT) (((OUTPUT) == I2S_MCLKOUTPUT_ENABLE) || \
443                                     ((OUTPUT) == I2S_MCLKOUTPUT_DISABLE))
444
445 #define IS_I2S_AUDIO_FREQ(FREQ) ((((FREQ) >= I2S_AUDIOFREQ_8K)    && \
446                                   ((FREQ) <= I2S_AUDIOFREQ_192K)) || \
447                                   ((FREQ) == I2S_AUDIOFREQ_DEFAULT))
448
449 #define IS_I2S_CPOL(CPOL) (((CPOL) == I2S_CPOL_LOW) || \
450                            ((CPOL) == I2S_CPOL_HIGH))
451 /**
452   * @}
453   */
454
455 /* Private Fonctions ---------------------------------------------------------*/
456 /** @defgroup I2S_Private_Functions I2S Private Functions
457   * @{
458   */
459 /* Private functions are defined in stm32f1xx_hal_i2s.c file */
460 /**
461   * @}
462   */
463
464 /**
465   * @}
466   */
467
468 /**
469   * @}
470   */
471 #ifdef __cplusplus
472 }
473 #endif
474
475 #endif /* !STM32L031xx && !STM32L041xx */
476
477 #endif /* __STM32L0xx_HAL_I2S_H */
478
479 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/