Subversion Repositories DashDisplay

Rev

Rev 56 | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed

  1. /**
  2.   ******************************************************************************
  3.   * @file    stm32l1xx_hal_i2s.h
  4.   * @author  MCD Application Team
  5.   * @brief   Header file of I2S HAL module.
  6.   ******************************************************************************
  7.   * @attention
  8.   *
  9.   * <h2><center>&copy; Copyright (c) 2016 STMicroelectronics.
  10.   * All rights reserved.</center></h2>
  11.   *
  12.   * This software component is licensed by ST under BSD 3-Clause license,
  13.   * the "License"; You may not use this file except in compliance with the
  14.   * License. You may obtain a copy of the License at:
  15.   *                        opensource.org/licenses/BSD-3-Clause
  16.   *
  17.   ******************************************************************************
  18.   */
  19.  
  20. /* Define to prevent recursive inclusion -------------------------------------*/
  21. #ifndef STM32L1xx_HAL_I2S_H
  22. #define STM32L1xx_HAL_I2S_H
  23.  
  24. #ifdef __cplusplus
  25. extern "C" {
  26. #endif
  27.  
  28. /* Includes ------------------------------------------------------------------*/
  29. #include "stm32l1xx_hal_def.h"
  30.  
  31. #if defined(SPI_I2S_SUPPORT)
  32. /** @addtogroup STM32L1xx_HAL_Driver
  33.   * @{
  34.   */
  35.  
  36. /** @addtogroup I2S
  37.   * @{
  38.   */
  39.  
  40. /* Exported types ------------------------------------------------------------*/
  41. /** @defgroup I2S_Exported_Types I2S Exported Types
  42.   * @{
  43.   */
  44.  
  45. /**
  46.   * @brief I2S Init structure definition
  47.   */
  48. typedef struct
  49. {
  50.   uint32_t Mode;                /*!< Specifies the I2S operating mode.
  51.                                      This parameter can be a value of @ref I2S_Mode */
  52.  
  53.   uint32_t Standard;            /*!< Specifies the standard used for the I2S communication.
  54.                                      This parameter can be a value of @ref I2S_Standard */
  55.  
  56.   uint32_t DataFormat;          /*!< Specifies the data format for the I2S communication.
  57.                                      This parameter can be a value of @ref I2S_Data_Format */
  58.  
  59.   uint32_t MCLKOutput;          /*!< Specifies whether the I2S MCLK output is enabled or not.
  60.                                      This parameter can be a value of @ref I2S_MCLK_Output */
  61.  
  62.   uint32_t AudioFreq;           /*!< Specifies the frequency selected for the I2S communication.
  63.                                      This parameter can be a value of @ref I2S_Audio_Frequency */
  64.  
  65.   uint32_t CPOL;                /*!< Specifies the idle state of the I2S clock.
  66.                                      This parameter can be a value of @ref I2S_Clock_Polarity */
  67. } I2S_InitTypeDef;
  68.  
  69. /**
  70.   * @brief  HAL State structures definition
  71.   */
  72. typedef enum
  73. {
  74.   HAL_I2S_STATE_RESET      = 0x00U,  /*!< I2S not yet initialized or disabled                */
  75.   HAL_I2S_STATE_READY      = 0x01U,  /*!< I2S initialized and ready for use                  */
  76.   HAL_I2S_STATE_BUSY       = 0x02U,  /*!< I2S internal process is ongoing                    */
  77.   HAL_I2S_STATE_BUSY_TX    = 0x03U,  /*!< Data Transmission process is ongoing               */
  78.   HAL_I2S_STATE_BUSY_RX    = 0x04U,  /*!< Data Reception process is ongoing                  */
  79.   HAL_I2S_STATE_TIMEOUT    = 0x06U,  /*!< I2S timeout state                                  */
  80.   HAL_I2S_STATE_ERROR      = 0x07U   /*!< I2S error state                                    */
  81. } HAL_I2S_StateTypeDef;
  82.  
  83. /**
  84.   * @brief I2S handle Structure definition
  85.   */
  86. #if (USE_HAL_I2S_REGISTER_CALLBACKS == 1)
  87. typedef struct __I2S_HandleTypeDef
  88. #else
  89. typedef struct
  90. #endif /* USE_HAL_I2S_REGISTER_CALLBACKS */
  91. {
  92.   SPI_TypeDef                *Instance;    /*!< I2S registers base address */
  93.  
  94.   I2S_InitTypeDef            Init;         /*!< I2S communication parameters */
  95.  
  96.   uint16_t                   *pTxBuffPtr;  /*!< Pointer to I2S Tx transfer buffer */
  97.  
  98.   __IO uint16_t              TxXferSize;   /*!< I2S Tx transfer size */
  99.  
  100.   __IO uint16_t              TxXferCount;  /*!< I2S Tx transfer Counter */
  101.  
  102.   uint16_t                   *pRxBuffPtr;  /*!< Pointer to I2S Rx transfer buffer */
  103.  
  104.   __IO uint16_t              RxXferSize;   /*!< I2S Rx transfer size */
  105.  
  106.   __IO uint16_t              RxXferCount;  /*!< I2S Rx transfer counter
  107.                                               (This field is initialized at the
  108.                                                same value as transfer size at the
  109.                                                beginning of the transfer and
  110.                                                decremented when a sample is received
  111.                                                NbSamplesReceived = RxBufferSize-RxBufferCount) */
  112.   DMA_HandleTypeDef          *hdmatx;      /*!< I2S Tx DMA handle parameters */
  113.  
  114.   DMA_HandleTypeDef          *hdmarx;      /*!< I2S Rx DMA handle parameters */
  115.  
  116.   __IO HAL_LockTypeDef       Lock;         /*!< I2S locking object */
  117.  
  118.   __IO HAL_I2S_StateTypeDef  State;        /*!< I2S communication state */
  119.  
  120.   __IO uint32_t              ErrorCode;    /*!< I2S Error code
  121.                                                 This parameter can be a value of @ref I2S_Error */
  122.  
  123. #if (USE_HAL_I2S_REGISTER_CALLBACKS == 1U)
  124.   void (* TxCpltCallback)(struct __I2S_HandleTypeDef *hi2s);             /*!< I2S Tx Completed callback          */
  125.   void (* RxCpltCallback)(struct __I2S_HandleTypeDef *hi2s);             /*!< I2S Rx Completed callback          */
  126.   void (* TxHalfCpltCallback)(struct __I2S_HandleTypeDef *hi2s);         /*!< I2S Tx Half Completed callback     */
  127.   void (* RxHalfCpltCallback)(struct __I2S_HandleTypeDef *hi2s);         /*!< I2S Rx Half Completed callback     */
  128.   void (* ErrorCallback)(struct __I2S_HandleTypeDef *hi2s);              /*!< I2S Error callback                 */
  129.   void (* MspInitCallback)(struct __I2S_HandleTypeDef *hi2s);            /*!< I2S Msp Init callback              */
  130.   void (* MspDeInitCallback)(struct __I2S_HandleTypeDef *hi2s);          /*!< I2S Msp DeInit callback            */
  131.  
  132. #endif  /* USE_HAL_I2S_REGISTER_CALLBACKS */
  133. } I2S_HandleTypeDef;
  134.  
  135. #if (USE_HAL_I2S_REGISTER_CALLBACKS == 1U)
  136. /**
  137.   * @brief  HAL I2S Callback ID enumeration definition
  138.   */
  139. typedef enum
  140. {
  141.   HAL_I2S_TX_COMPLETE_CB_ID             = 0x00U,    /*!< I2S Tx Completed callback ID         */
  142.   HAL_I2S_RX_COMPLETE_CB_ID             = 0x01U,    /*!< I2S Rx Completed callback ID         */
  143.   HAL_I2S_TX_HALF_COMPLETE_CB_ID        = 0x03U,    /*!< I2S Tx Half Completed callback ID    */
  144.   HAL_I2S_RX_HALF_COMPLETE_CB_ID        = 0x04U,    /*!< I2S Rx Half Completed callback ID    */
  145.   HAL_I2S_ERROR_CB_ID                   = 0x06U,    /*!< I2S Error callback ID                */
  146.   HAL_I2S_MSPINIT_CB_ID                 = 0x07U,    /*!< I2S Msp Init callback ID             */
  147.   HAL_I2S_MSPDEINIT_CB_ID               = 0x08U     /*!< I2S Msp DeInit callback ID           */
  148.  
  149. } HAL_I2S_CallbackIDTypeDef;
  150.  
  151. /**
  152.   * @brief  HAL I2S Callback pointer definition
  153.   */
  154. typedef  void (*pI2S_CallbackTypeDef)(I2S_HandleTypeDef *hi2s); /*!< pointer to an I2S callback function */
  155.  
  156. #endif /* USE_HAL_I2S_REGISTER_CALLBACKS */
  157. /**
  158.   * @}
  159.   */
  160.  
  161. /* Exported constants --------------------------------------------------------*/
  162. /** @defgroup I2S_Exported_Constants I2S Exported Constants
  163.   * @{
  164.   */
  165. /** @defgroup I2S_Error I2S Error
  166.   * @{
  167.   */
  168. #define HAL_I2S_ERROR_NONE               (0x00000000U)  /*!< No error                    */
  169. #define HAL_I2S_ERROR_TIMEOUT            (0x00000001U)  /*!< Timeout error               */
  170. #define HAL_I2S_ERROR_OVR                (0x00000002U)  /*!< OVR error                   */
  171. #define HAL_I2S_ERROR_UDR                (0x00000004U)  /*!< UDR error                   */
  172. #define HAL_I2S_ERROR_DMA                (0x00000008U)  /*!< DMA transfer error          */
  173. #define HAL_I2S_ERROR_PRESCALER          (0x00000010U)  /*!< Prescaler Calculation error */
  174. #if (USE_HAL_I2S_REGISTER_CALLBACKS == 1U)
  175. #define HAL_I2S_ERROR_INVALID_CALLBACK   (0x00000020U)  /*!< Invalid Callback error      */
  176. #endif /* USE_HAL_I2S_REGISTER_CALLBACKS */
  177. #define HAL_I2S_ERROR_BUSY_LINE_RX       (0x00000040U)  /*!< Busy Rx Line error          */
  178. /**
  179.   * @}
  180.   */
  181.  
  182. /** @defgroup I2S_Mode I2S Mode
  183.   * @{
  184.   */
  185. #define I2S_MODE_SLAVE_TX                (0x00000000U)
  186. #define I2S_MODE_SLAVE_RX                (SPI_I2SCFGR_I2SCFG_0)
  187. #define I2S_MODE_MASTER_TX               (SPI_I2SCFGR_I2SCFG_1)
  188. #define I2S_MODE_MASTER_RX               ((SPI_I2SCFGR_I2SCFG_0 | SPI_I2SCFGR_I2SCFG_1))
  189. /**
  190.   * @}
  191.   */
  192.  
  193. /** @defgroup I2S_Standard I2S Standard
  194.   * @{
  195.   */
  196. #define I2S_STANDARD_PHILIPS             (0x00000000U)
  197. #define I2S_STANDARD_MSB                 (SPI_I2SCFGR_I2SSTD_0)
  198. #define I2S_STANDARD_LSB                 (SPI_I2SCFGR_I2SSTD_1)
  199. #define I2S_STANDARD_PCM_SHORT           ((SPI_I2SCFGR_I2SSTD_0 | SPI_I2SCFGR_I2SSTD_1))
  200. #define I2S_STANDARD_PCM_LONG            ((SPI_I2SCFGR_I2SSTD_0 | SPI_I2SCFGR_I2SSTD_1 | SPI_I2SCFGR_PCMSYNC))
  201. /**
  202.   * @}
  203.   */
  204.  
  205. /** @defgroup I2S_Data_Format I2S Data Format
  206.   * @{
  207.   */
  208. #define I2S_DATAFORMAT_16B               (0x00000000U)
  209. #define I2S_DATAFORMAT_16B_EXTENDED      (SPI_I2SCFGR_CHLEN)
  210. #define I2S_DATAFORMAT_24B               ((SPI_I2SCFGR_CHLEN | SPI_I2SCFGR_DATLEN_0))
  211. #define I2S_DATAFORMAT_32B               ((SPI_I2SCFGR_CHLEN | SPI_I2SCFGR_DATLEN_1))
  212. /**
  213.   * @}
  214.   */
  215.  
  216. /** @defgroup I2S_MCLK_Output I2S MCLK Output
  217.   * @{
  218.   */
  219. #define I2S_MCLKOUTPUT_ENABLE            (SPI_I2SPR_MCKOE)
  220. #define I2S_MCLKOUTPUT_DISABLE           (0x00000000U)
  221. /**
  222.   * @}
  223.   */
  224.  
  225. /** @defgroup I2S_Audio_Frequency I2S Audio Frequency
  226.   * @{
  227.   */
  228. #define I2S_AUDIOFREQ_192K               (192000U)
  229. #define I2S_AUDIOFREQ_96K                (96000U)
  230. #define I2S_AUDIOFREQ_48K                (48000U)
  231. #define I2S_AUDIOFREQ_44K                (44100U)
  232. #define I2S_AUDIOFREQ_32K                (32000U)
  233. #define I2S_AUDIOFREQ_22K                (22050U)
  234. #define I2S_AUDIOFREQ_16K                (16000U)
  235. #define I2S_AUDIOFREQ_11K                (11025U)
  236. #define I2S_AUDIOFREQ_8K                 (8000U)
  237. #define I2S_AUDIOFREQ_DEFAULT            (2U)
  238. /**
  239.   * @}
  240.   */
  241.  
  242. /** @defgroup I2S_Clock_Polarity I2S Clock Polarity
  243.   * @{
  244.   */
  245. #define I2S_CPOL_LOW                     (0x00000000U)
  246. #define I2S_CPOL_HIGH                    (SPI_I2SCFGR_CKPOL)
  247. /**
  248.   * @}
  249.   */
  250.  
  251. /** @defgroup I2S_Interrupts_Definition I2S Interrupts Definition
  252.   * @{
  253.   */
  254. #define I2S_IT_TXE                       SPI_CR2_TXEIE
  255. #define I2S_IT_RXNE                      SPI_CR2_RXNEIE
  256. #define I2S_IT_ERR                       SPI_CR2_ERRIE
  257. /**
  258.   * @}
  259.   */
  260.  
  261. /** @defgroup I2S_Flags_Definition I2S Flags Definition
  262.   * @{
  263.   */
  264. #define I2S_FLAG_TXE                     SPI_SR_TXE
  265. #define I2S_FLAG_RXNE                    SPI_SR_RXNE
  266.  
  267. #define I2S_FLAG_UDR                     SPI_SR_UDR
  268. #define I2S_FLAG_OVR                     SPI_SR_OVR
  269. #define I2S_FLAG_FRE                     SPI_SR_FRE
  270.  
  271. #define I2S_FLAG_CHSIDE                  SPI_SR_CHSIDE
  272. #define I2S_FLAG_BSY                     SPI_SR_BSY
  273.  
  274. #if defined(SPI_CR2_FRF)
  275. #define I2S_FLAG_MASK                   (SPI_SR_RXNE\
  276.                                          | SPI_SR_TXE | SPI_SR_UDR | SPI_SR_OVR | SPI_SR_FRE | SPI_SR_CHSIDE | SPI_SR_BSY)
  277. #else
  278. #define I2S_FLAG_MASK                   (SPI_SR_RXNE\
  279.                                          | SPI_SR_TXE | SPI_SR_UDR | SPI_SR_OVR | SPI_SR_CHSIDE | SPI_SR_BSY)
  280. #endif
  281. /**
  282.   * @}
  283.   */
  284.  
  285. /**
  286.   * @}
  287.   */
  288.  
  289. /* Exported macros -----------------------------------------------------------*/
  290. /** @defgroup I2S_Exported_macros I2S Exported Macros
  291.   * @{
  292.   */
  293.  
  294. /** @brief  Reset I2S handle state
  295.   * @param  __HANDLE__ specifies the I2S Handle.
  296.   * @retval None
  297.   */
  298. #if (USE_HAL_I2S_REGISTER_CALLBACKS == 1U)
  299. #define __HAL_I2S_RESET_HANDLE_STATE(__HANDLE__)                do{                                                  \
  300.                                                                     (__HANDLE__)->State = HAL_I2S_STATE_RESET;       \
  301.                                                                     (__HANDLE__)->MspInitCallback = NULL;            \
  302.                                                                     (__HANDLE__)->MspDeInitCallback = NULL;          \
  303.                                                                   } while(0)
  304. #else
  305. #define __HAL_I2S_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_I2S_STATE_RESET)
  306. #endif /* USE_HAL_I2S_REGISTER_CALLBACKS */
  307.  
  308. /** @brief  Enable the specified SPI peripheral (in I2S mode).
  309.   * @param  __HANDLE__ specifies the I2S Handle.
  310.   * @retval None
  311.   */
  312. #define __HAL_I2S_ENABLE(__HANDLE__)    (SET_BIT((__HANDLE__)->Instance->I2SCFGR, SPI_I2SCFGR_I2SE))
  313.  
  314. /** @brief  Disable the specified SPI peripheral (in I2S mode).
  315.   * @param  __HANDLE__ specifies the I2S Handle.
  316.   * @retval None
  317.   */
  318. #define __HAL_I2S_DISABLE(__HANDLE__) (CLEAR_BIT((__HANDLE__)->Instance->I2SCFGR, SPI_I2SCFGR_I2SE))
  319.  
  320. /** @brief  Enable the specified I2S interrupts.
  321.   * @param  __HANDLE__ specifies the I2S Handle.
  322.   * @param  __INTERRUPT__ specifies the interrupt source to enable or disable.
  323.   *         This parameter can be one of the following values:
  324.   *            @arg I2S_IT_TXE: Tx buffer empty interrupt enable
  325.   *            @arg I2S_IT_RXNE: RX buffer not empty interrupt enable
  326.   *            @arg I2S_IT_ERR: Error interrupt enable
  327.   * @retval None
  328.   */
  329. #define __HAL_I2S_ENABLE_IT(__HANDLE__, __INTERRUPT__)    (SET_BIT((__HANDLE__)->Instance->CR2,(__INTERRUPT__)))
  330.  
  331. /** @brief  Disable the specified I2S interrupts.
  332.   * @param  __HANDLE__ specifies the I2S Handle.
  333.   * @param  __INTERRUPT__ specifies the interrupt source to enable or disable.
  334.   *         This parameter can be one of the following values:
  335.   *            @arg I2S_IT_TXE: Tx buffer empty interrupt enable
  336.   *            @arg I2S_IT_RXNE: RX buffer not empty interrupt enable
  337.   *            @arg I2S_IT_ERR: Error interrupt enable
  338.   * @retval None
  339.   */
  340. #define __HAL_I2S_DISABLE_IT(__HANDLE__, __INTERRUPT__) (CLEAR_BIT((__HANDLE__)->Instance->CR2,(__INTERRUPT__)))
  341.  
  342. /** @brief  Checks if the specified I2S interrupt source is enabled or disabled.
  343.   * @param  __HANDLE__ specifies the I2S Handle.
  344.   *         This parameter can be I2S where x: 1, 2, or 3 to select the I2S peripheral.
  345.   * @param  __INTERRUPT__ specifies the I2S interrupt source to check.
  346.   *          This parameter can be one of the following values:
  347.   *            @arg I2S_IT_TXE: Tx buffer empty interrupt enable
  348.   *            @arg I2S_IT_RXNE: RX buffer not empty interrupt enable
  349.   *            @arg I2S_IT_ERR: Error interrupt enable
  350.   * @retval The new state of __IT__ (TRUE or FALSE).
  351.   */
  352. #define __HAL_I2S_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->CR2\
  353.                                                               & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
  354.  
  355. /** @brief  Checks whether the specified I2S flag is set or not.
  356.   * @param  __HANDLE__ specifies the I2S Handle.
  357.   * @param  __FLAG__ specifies the flag to check.
  358.   *         This parameter can be one of the following values:
  359.   *            @arg I2S_FLAG_RXNE: Receive buffer not empty flag
  360.   *            @arg I2S_FLAG_TXE: Transmit buffer empty flag
  361.   *            @arg I2S_FLAG_UDR: Underrun flag
  362.   *            @arg I2S_FLAG_OVR: Overrun flag
  363.   *            @arg I2S_FLAG_FRE: Frame error flag
  364.   *            @arg I2S_FLAG_CHSIDE: Channel Side flag
  365.   *            @arg I2S_FLAG_BSY: Busy flag
  366.   * @retval The new state of __FLAG__ (TRUE or FALSE).
  367.   */
  368. #define __HAL_I2S_GET_FLAG(__HANDLE__, __FLAG__) ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))
  369.  
  370. /** @brief Clears the I2S OVR pending flag.
  371.   * @param  __HANDLE__ specifies the I2S Handle.
  372.   * @retval None
  373.   */
  374. #define __HAL_I2S_CLEAR_OVRFLAG(__HANDLE__) do{ \
  375.                                                 __IO uint32_t tmpreg_ovr = 0x00U; \
  376.                                                 tmpreg_ovr = (__HANDLE__)->Instance->DR; \
  377.                                                 tmpreg_ovr = (__HANDLE__)->Instance->SR; \
  378.                                                 UNUSED(tmpreg_ovr); \
  379.                                               }while(0U)
  380. /** @brief Clears the I2S UDR pending flag.
  381.   * @param  __HANDLE__ specifies the I2S Handle.
  382.   * @retval None
  383.   */
  384. #define __HAL_I2S_CLEAR_UDRFLAG(__HANDLE__) do{\
  385.                                                 __IO uint32_t tmpreg_udr = 0x00U;\
  386.                                                 tmpreg_udr = ((__HANDLE__)->Instance->SR);\
  387.                                                 UNUSED(tmpreg_udr); \
  388.                                               }while(0U)
  389. /** @brief Flush the I2S DR Register.
  390.   * @param  __HANDLE__ specifies the I2S Handle.
  391.   * @retval None
  392.   */
  393. #define __HAL_I2S_FLUSH_RX_DR(__HANDLE__)  do{\
  394.                                                 __IO uint32_t tmpreg_dr = 0x00U;\
  395.                                                 tmpreg_dr = ((__HANDLE__)->Instance->DR);\
  396.                                                 UNUSED(tmpreg_dr); \
  397.                                               }while(0U)
  398. /**
  399.   * @}
  400.   */
  401.  
  402. /* Exported functions --------------------------------------------------------*/
  403. /** @addtogroup I2S_Exported_Functions
  404.   * @{
  405.   */
  406.  
  407. /** @addtogroup I2S_Exported_Functions_Group1
  408.   * @{
  409.   */
  410. /* Initialization/de-initialization functions  ********************************/
  411. HAL_StatusTypeDef HAL_I2S_Init(I2S_HandleTypeDef *hi2s);
  412. HAL_StatusTypeDef HAL_I2S_DeInit(I2S_HandleTypeDef *hi2s);
  413. void HAL_I2S_MspInit(I2S_HandleTypeDef *hi2s);
  414. void HAL_I2S_MspDeInit(I2S_HandleTypeDef *hi2s);
  415.  
  416. /* Callbacks Register/UnRegister functions  ***********************************/
  417. #if (USE_HAL_I2S_REGISTER_CALLBACKS == 1U)
  418. HAL_StatusTypeDef HAL_I2S_RegisterCallback(I2S_HandleTypeDef *hi2s, HAL_I2S_CallbackIDTypeDef CallbackID,
  419.                                            pI2S_CallbackTypeDef pCallback);
  420. HAL_StatusTypeDef HAL_I2S_UnRegisterCallback(I2S_HandleTypeDef *hi2s, HAL_I2S_CallbackIDTypeDef CallbackID);
  421. #endif /* USE_HAL_I2S_REGISTER_CALLBACKS */
  422. /**
  423.   * @}
  424.   */
  425.  
  426. /** @addtogroup I2S_Exported_Functions_Group2
  427.   * @{
  428.   */
  429. /* I/O operation functions  ***************************************************/
  430. /* Blocking mode: Polling */
  431. HAL_StatusTypeDef HAL_I2S_Transmit(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size, uint32_t Timeout);
  432. HAL_StatusTypeDef HAL_I2S_Receive(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size, uint32_t Timeout);
  433.  
  434. /* Non-Blocking mode: Interrupt */
  435. HAL_StatusTypeDef HAL_I2S_Transmit_IT(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size);
  436. HAL_StatusTypeDef HAL_I2S_Receive_IT(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size);
  437. void HAL_I2S_IRQHandler(I2S_HandleTypeDef *hi2s);
  438.  
  439. /* Non-Blocking mode: DMA */
  440. HAL_StatusTypeDef HAL_I2S_Transmit_DMA(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size);
  441. HAL_StatusTypeDef HAL_I2S_Receive_DMA(I2S_HandleTypeDef *hi2s, uint16_t *pData, uint16_t Size);
  442.  
  443. HAL_StatusTypeDef HAL_I2S_DMAPause(I2S_HandleTypeDef *hi2s);
  444. HAL_StatusTypeDef HAL_I2S_DMAResume(I2S_HandleTypeDef *hi2s);
  445. HAL_StatusTypeDef HAL_I2S_DMAStop(I2S_HandleTypeDef *hi2s);
  446.  
  447. /* Callbacks used in non blocking modes (Interrupt and DMA) *******************/
  448. void HAL_I2S_TxHalfCpltCallback(I2S_HandleTypeDef *hi2s);
  449. void HAL_I2S_TxCpltCallback(I2S_HandleTypeDef *hi2s);
  450. void HAL_I2S_RxHalfCpltCallback(I2S_HandleTypeDef *hi2s);
  451. void HAL_I2S_RxCpltCallback(I2S_HandleTypeDef *hi2s);
  452. void HAL_I2S_ErrorCallback(I2S_HandleTypeDef *hi2s);
  453. /**
  454.   * @}
  455.   */
  456.  
  457. /** @addtogroup I2S_Exported_Functions_Group3
  458.   * @{
  459.   */
  460. /* Peripheral Control and State functions  ************************************/
  461. HAL_I2S_StateTypeDef HAL_I2S_GetState(I2S_HandleTypeDef *hi2s);
  462. uint32_t HAL_I2S_GetError(I2S_HandleTypeDef *hi2s);
  463. /**
  464.   * @}
  465.   */
  466.  
  467. /**
  468.   * @}
  469.   */
  470.  
  471. /* Private types -------------------------------------------------------------*/
  472. /* Private variables ---------------------------------------------------------*/
  473. /* Private constants ---------------------------------------------------------*/
  474. /* Private macros ------------------------------------------------------------*/
  475. /** @defgroup I2S_Private_Macros I2S Private Macros
  476.   * @{
  477.   */
  478.  
  479. /** @brief  Check whether the specified SPI flag is set or not.
  480.   * @param  __SR__  copy of I2S SR register.
  481.   * @param  __FLAG__ specifies the flag to check.
  482.   *         This parameter can be one of the following values:
  483.   *            @arg I2S_FLAG_RXNE: Receive buffer not empty flag
  484.   *            @arg I2S_FLAG_TXE: Transmit buffer empty flag
  485.   *            @arg I2S_FLAG_UDR: Underrun error flag
  486.   *            @arg I2S_FLAG_OVR: Overrun flag
  487.   *            @arg I2S_FLAG_CHSIDE: Channel side flag
  488.   *            @arg I2S_FLAG_BSY: Busy flag
  489.   * @retval SET or RESET.
  490.   */
  491. #define I2S_CHECK_FLAG(__SR__, __FLAG__)         ((((__SR__)\
  492.                                                     & ((__FLAG__) & I2S_FLAG_MASK)) == ((__FLAG__) & I2S_FLAG_MASK)) ? SET : RESET)
  493.  
  494. /** @brief  Check whether the specified SPI Interrupt is set or not.
  495.   * @param  __CR2__  copy of I2S CR2 register.
  496.   * @param  __INTERRUPT__ specifies the SPI interrupt source to check.
  497.   *         This parameter can be one of the following values:
  498.   *            @arg I2S_IT_TXE: Tx buffer empty interrupt enable
  499.   *            @arg I2S_IT_RXNE: RX buffer not empty interrupt enable
  500.   *            @arg I2S_IT_ERR: Error interrupt enable
  501.   * @retval SET or RESET.
  502.   */
  503. #define I2S_CHECK_IT_SOURCE(__CR2__, __INTERRUPT__)      ((((__CR2__)\
  504.                                                             & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
  505.  
  506. /** @brief  Checks if I2S Mode parameter is in allowed range.
  507.   * @param  __MODE__ specifies the I2S Mode.
  508.   *         This parameter can be a value of @ref I2S_Mode
  509.   * @retval None
  510.   */
  511. #define IS_I2S_MODE(__MODE__) (((__MODE__) == I2S_MODE_SLAVE_TX)  || \
  512.                                ((__MODE__) == I2S_MODE_SLAVE_RX)  || \
  513.                                ((__MODE__) == I2S_MODE_MASTER_TX) || \
  514.                                ((__MODE__) == I2S_MODE_MASTER_RX))
  515.  
  516. #define IS_I2S_STANDARD(__STANDARD__) (((__STANDARD__) == I2S_STANDARD_PHILIPS)   || \
  517.                                        ((__STANDARD__) == I2S_STANDARD_MSB)       || \
  518.                                        ((__STANDARD__) == I2S_STANDARD_LSB)       || \
  519.                                        ((__STANDARD__) == I2S_STANDARD_PCM_SHORT) || \
  520.                                        ((__STANDARD__) == I2S_STANDARD_PCM_LONG))
  521.  
  522. #define IS_I2S_DATA_FORMAT(__FORMAT__) (((__FORMAT__) == I2S_DATAFORMAT_16B)          || \
  523.                                         ((__FORMAT__) == I2S_DATAFORMAT_16B_EXTENDED) || \
  524.                                         ((__FORMAT__) == I2S_DATAFORMAT_24B)          || \
  525.                                         ((__FORMAT__) == I2S_DATAFORMAT_32B))
  526.  
  527. #define IS_I2S_MCLK_OUTPUT(__OUTPUT__) (((__OUTPUT__) == I2S_MCLKOUTPUT_ENABLE) || \
  528.                                         ((__OUTPUT__) == I2S_MCLKOUTPUT_DISABLE))
  529.  
  530. #define IS_I2S_AUDIO_FREQ(__FREQ__) ((((__FREQ__) >= I2S_AUDIOFREQ_8K)    && \
  531.                                       ((__FREQ__) <= I2S_AUDIOFREQ_192K)) || \
  532.                                      ((__FREQ__) == I2S_AUDIOFREQ_DEFAULT))
  533.  
  534. /** @brief  Checks if I2S Serial clock steady state parameter is in allowed range.
  535.   * @param  __CPOL__ specifies the I2S serial clock steady state.
  536.   *         This parameter can be a value of @ref I2S_Clock_Polarity
  537.   * @retval None
  538.   */
  539. #define IS_I2S_CPOL(__CPOL__) (((__CPOL__) == I2S_CPOL_LOW) || \
  540.                                ((__CPOL__) == I2S_CPOL_HIGH))
  541.  
  542. /**
  543.   * @}
  544.   */
  545.  
  546. /**
  547.   * @}
  548.   */
  549.  
  550. /**
  551.   * @}
  552.   */
  553. #endif /* SPI_I2S_SUPPORT */
  554.  
  555. #ifdef __cplusplus
  556. }
  557. #endif
  558.  
  559. #endif /* STM32L1xx_HAL_I2S_H */
  560.  
  561. /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
  562.