mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_MTB_MTS_DRAGONFLY/TARGET_STM/TARGET_STM32F4/device/stm32f4xx_hal_i2s_ex.h@161:aa5281ff4a02, 2018-02-16 (annotated)

Committer:
AnnaBridge
Date:
Fri Feb 16 16:16:41 2018 +0000
Revision:
161:aa5281ff4a02
Child:
163:e59c8e839560
mbed library. Release version 159.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 161:aa5281ff4a02 1 /**
AnnaBridge 161:aa5281ff4a02 2 ******************************************************************************
AnnaBridge 161:aa5281ff4a02 3 * @file stm32f4xx_hal_i2s_ex.h
AnnaBridge 161:aa5281ff4a02 4 * @author MCD Application Team
AnnaBridge 161:aa5281ff4a02 5 * @version V1.7.1
AnnaBridge 161:aa5281ff4a02 6 * @date 14-April-2017
AnnaBridge 161:aa5281ff4a02 7 * @brief Header file of I2S HAL module.
AnnaBridge 161:aa5281ff4a02 8 ******************************************************************************
AnnaBridge 161:aa5281ff4a02 9 * @attention
AnnaBridge 161:aa5281ff4a02 10 *
AnnaBridge 161:aa5281ff4a02 11 * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
AnnaBridge 161:aa5281ff4a02 12 *
AnnaBridge 161:aa5281ff4a02 13 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 161:aa5281ff4a02 14 * are permitted provided that the following conditions are met:
AnnaBridge 161:aa5281ff4a02 15 * 1. Redistributions of source code must retain the above copyright notice,
AnnaBridge 161:aa5281ff4a02 16 * this list of conditions and the following disclaimer.
AnnaBridge 161:aa5281ff4a02 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
AnnaBridge 161:aa5281ff4a02 18 * this list of conditions and the following disclaimer in the documentation
AnnaBridge 161:aa5281ff4a02 19 * and/or other materials provided with the distribution.
AnnaBridge 161:aa5281ff4a02 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
AnnaBridge 161:aa5281ff4a02 21 * may be used to endorse or promote products derived from this software
AnnaBridge 161:aa5281ff4a02 22 * without specific prior written permission.
AnnaBridge 161:aa5281ff4a02 23 *
AnnaBridge 161:aa5281ff4a02 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AnnaBridge 161:aa5281ff4a02 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
AnnaBridge 161:aa5281ff4a02 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 161:aa5281ff4a02 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
AnnaBridge 161:aa5281ff4a02 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
AnnaBridge 161:aa5281ff4a02 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
AnnaBridge 161:aa5281ff4a02 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
AnnaBridge 161:aa5281ff4a02 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
AnnaBridge 161:aa5281ff4a02 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
AnnaBridge 161:aa5281ff4a02 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 161:aa5281ff4a02 34 *
AnnaBridge 161:aa5281ff4a02 35 ******************************************************************************
AnnaBridge 161:aa5281ff4a02 36 */
AnnaBridge 161:aa5281ff4a02 37
AnnaBridge 161:aa5281ff4a02 38 /* Define to prevent recursive inclusion -------------------------------------*/
AnnaBridge 161:aa5281ff4a02 39 #ifndef __STM32F4xx_HAL_I2S_EX_H
AnnaBridge 161:aa5281ff4a02 40 #define __STM32F4xx_HAL_I2S_EX_H
AnnaBridge 161:aa5281ff4a02 41
AnnaBridge 161:aa5281ff4a02 42 #ifdef __cplusplus
AnnaBridge 161:aa5281ff4a02 43 extern "C" {
AnnaBridge 161:aa5281ff4a02 44 #endif
AnnaBridge 161:aa5281ff4a02 45
AnnaBridge 161:aa5281ff4a02 46 /* Includes ------------------------------------------------------------------*/
AnnaBridge 161:aa5281ff4a02 47 #include "stm32f4xx_hal_def.h"
AnnaBridge 161:aa5281ff4a02 48
AnnaBridge 161:aa5281ff4a02 49 /** @addtogroup STM32F4xx_HAL_Driver
AnnaBridge 161:aa5281ff4a02 50 * @{
AnnaBridge 161:aa5281ff4a02 51 */
AnnaBridge 161:aa5281ff4a02 52 #if defined(SPI_I2S_FULLDUPLEX_SUPPORT)
AnnaBridge 161:aa5281ff4a02 53 /** @addtogroup I2SEx I2SEx
AnnaBridge 161:aa5281ff4a02 54 * @{
AnnaBridge 161:aa5281ff4a02 55 */
AnnaBridge 161:aa5281ff4a02 56
AnnaBridge 161:aa5281ff4a02 57 /* Exported types ------------------------------------------------------------*/
AnnaBridge 161:aa5281ff4a02 58 /* Exported constants --------------------------------------------------------*/
AnnaBridge 161:aa5281ff4a02 59 /* Exported macros -----------------------------------------------------------*/
AnnaBridge 161:aa5281ff4a02 60 /** @defgroup I2SEx_Exported_Macros I2S Extended Exported Macros
AnnaBridge 161:aa5281ff4a02 61 * @{
AnnaBridge 161:aa5281ff4a02 62 */
AnnaBridge 161:aa5281ff4a02 63
AnnaBridge 161:aa5281ff4a02 64 #define I2SxEXT(__INSTANCE__) ((__INSTANCE__) == (SPI2)? (SPI_TypeDef *)(I2S2ext_BASE): (SPI_TypeDef *)(I2S3ext_BASE))
AnnaBridge 161:aa5281ff4a02 65
AnnaBridge 161:aa5281ff4a02 66 /** @brief Enable or disable the specified I2SExt peripheral.
AnnaBridge 161:aa5281ff4a02 67 * @param __HANDLE__: specifies the I2S Handle.
AnnaBridge 161:aa5281ff4a02 68 * @retval None
AnnaBridge 161:aa5281ff4a02 69 */
AnnaBridge 161:aa5281ff4a02 70 #define __HAL_I2SEXT_ENABLE(__HANDLE__) (I2SxEXT((__HANDLE__)->Instance)->I2SCFGR |= SPI_I2SCFGR_I2SE)
AnnaBridge 161:aa5281ff4a02 71 #define __HAL_I2SEXT_DISABLE(__HANDLE__) (I2SxEXT((__HANDLE__)->Instance)->I2SCFGR &= ~SPI_I2SCFGR_I2SE)
AnnaBridge 161:aa5281ff4a02 72
AnnaBridge 161:aa5281ff4a02 73 /** @brief Enable or disable the specified I2SExt interrupts.
AnnaBridge 161:aa5281ff4a02 74 * @param __HANDLE__: specifies the I2S Handle.
AnnaBridge 161:aa5281ff4a02 75 * @param __INTERRUPT__: specifies the interrupt source to enable or disable.
AnnaBridge 161:aa5281ff4a02 76 * This parameter can be one of the following values:
AnnaBridge 161:aa5281ff4a02 77 * @arg I2S_IT_TXE: Tx buffer empty interrupt enable
AnnaBridge 161:aa5281ff4a02 78 * @arg I2S_IT_RXNE: RX buffer not empty interrupt enable
AnnaBridge 161:aa5281ff4a02 79 * @arg I2S_IT_ERR: Error interrupt enable
AnnaBridge 161:aa5281ff4a02 80 * @retval None
AnnaBridge 161:aa5281ff4a02 81 */
AnnaBridge 161:aa5281ff4a02 82 #define __HAL_I2SEXT_ENABLE_IT(__HANDLE__, __INTERRUPT__) (I2SxEXT((__HANDLE__)->Instance)->CR2 |= (__INTERRUPT__))
AnnaBridge 161:aa5281ff4a02 83 #define __HAL_I2SEXT_DISABLE_IT(__HANDLE__, __INTERRUPT__) (I2SxEXT((__HANDLE__)->Instance)->CR2 &= ~(__INTERRUPT__))
AnnaBridge 161:aa5281ff4a02 84
AnnaBridge 161:aa5281ff4a02 85 /** @brief Checks if the specified I2SExt interrupt source is enabled or disabled.
AnnaBridge 161:aa5281ff4a02 86 * @param __HANDLE__: specifies the I2S Handle.
AnnaBridge 161:aa5281ff4a02 87 * This parameter can be I2S where x: 1, 2, or 3 to select the I2S peripheral.
AnnaBridge 161:aa5281ff4a02 88 * @param __INTERRUPT__: specifies the I2S interrupt source to check.
AnnaBridge 161:aa5281ff4a02 89 * This parameter can be one of the following values:
AnnaBridge 161:aa5281ff4a02 90 * @arg I2S_IT_TXE: Tx buffer empty interrupt enable
AnnaBridge 161:aa5281ff4a02 91 * @arg I2S_IT_RXNE: RX buffer not empty interrupt enable
AnnaBridge 161:aa5281ff4a02 92 * @arg I2S_IT_ERR: Error interrupt enable
AnnaBridge 161:aa5281ff4a02 93 * @retval The new state of __IT__ (TRUE or FALSE).
AnnaBridge 161:aa5281ff4a02 94 */
AnnaBridge 161:aa5281ff4a02 95 #define __HAL_I2SEXT_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) (((I2SxEXT((__HANDLE__)->Instance)->CR2 & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
AnnaBridge 161:aa5281ff4a02 96
AnnaBridge 161:aa5281ff4a02 97 /** @brief Checks whether the specified I2SExt flag is set or not.
AnnaBridge 161:aa5281ff4a02 98 * @param __HANDLE__: specifies the I2S Handle.
AnnaBridge 161:aa5281ff4a02 99 * @param __FLAG__: specifies the flag to check.
AnnaBridge 161:aa5281ff4a02 100 * This parameter can be one of the following values:
AnnaBridge 161:aa5281ff4a02 101 * @arg I2S_FLAG_RXNE: Receive buffer not empty flag
AnnaBridge 161:aa5281ff4a02 102 * @arg I2S_FLAG_TXE: Transmit buffer empty flag
AnnaBridge 161:aa5281ff4a02 103 * @arg I2S_FLAG_UDR: Underrun flag
AnnaBridge 161:aa5281ff4a02 104 * @arg I2S_FLAG_OVR: Overrun flag
AnnaBridge 161:aa5281ff4a02 105 * @arg I2S_FLAG_FRE: Frame error flag
AnnaBridge 161:aa5281ff4a02 106 * @arg I2S_FLAG_CHSIDE: Channel Side flag
AnnaBridge 161:aa5281ff4a02 107 * @arg I2S_FLAG_BSY: Busy flag
AnnaBridge 161:aa5281ff4a02 108 * @retval The new state of __FLAG__ (TRUE or FALSE).
AnnaBridge 161:aa5281ff4a02 109 */
AnnaBridge 161:aa5281ff4a02 110 #define __HAL_I2SEXT_GET_FLAG(__HANDLE__, __FLAG__) (((I2SxEXT((__HANDLE__)->Instance)->SR) & (__FLAG__)) == (__FLAG__))
AnnaBridge 161:aa5281ff4a02 111
AnnaBridge 161:aa5281ff4a02 112 /** @brief Clears the I2SExt OVR pending flag.
AnnaBridge 161:aa5281ff4a02 113 * @param __HANDLE__: specifies the I2S Handle.
AnnaBridge 161:aa5281ff4a02 114 * @retval None
AnnaBridge 161:aa5281ff4a02 115 */
AnnaBridge 161:aa5281ff4a02 116 #define __HAL_I2SEXT_CLEAR_OVRFLAG(__HANDLE__) do{ \
AnnaBridge 161:aa5281ff4a02 117 __IO uint32_t tmpreg_ovr = 0x00U; \
AnnaBridge 161:aa5281ff4a02 118 tmpreg_ovr = I2SxEXT((__HANDLE__)->Instance)->DR;\
AnnaBridge 161:aa5281ff4a02 119 tmpreg_ovr = I2SxEXT((__HANDLE__)->Instance)->SR;\
AnnaBridge 161:aa5281ff4a02 120 UNUSED(tmpreg_ovr); \
AnnaBridge 161:aa5281ff4a02 121 }while(0U)
AnnaBridge 161:aa5281ff4a02 122 /** @brief Clears the I2SExt UDR pending flag.
AnnaBridge 161:aa5281ff4a02 123 * @param __HANDLE__: specifies the I2S Handle.
AnnaBridge 161:aa5281ff4a02 124 * @retval None
AnnaBridge 161:aa5281ff4a02 125 */
AnnaBridge 161:aa5281ff4a02 126 #define __HAL_I2SEXT_CLEAR_UDRFLAG(__HANDLE__) do{ \
AnnaBridge 161:aa5281ff4a02 127 __IO uint32_t tmpreg_udr = 0x00U; \
AnnaBridge 161:aa5281ff4a02 128 tmpreg_udr = I2SxEXT((__HANDLE__)->Instance)->SR;\
AnnaBridge 161:aa5281ff4a02 129 UNUSED(tmpreg_udr); \
AnnaBridge 161:aa5281ff4a02 130 }while(0U)
AnnaBridge 161:aa5281ff4a02 131 /**
AnnaBridge 161:aa5281ff4a02 132 * @}
AnnaBridge 161:aa5281ff4a02 133 */
AnnaBridge 161:aa5281ff4a02 134
AnnaBridge 161:aa5281ff4a02 135 /* Exported functions --------------------------------------------------------*/
AnnaBridge 161:aa5281ff4a02 136 /** @addtogroup I2SEx_Exported_Functions I2S Extended Exported Functions
AnnaBridge 161:aa5281ff4a02 137 * @{
AnnaBridge 161:aa5281ff4a02 138 */
AnnaBridge 161:aa5281ff4a02 139
AnnaBridge 161:aa5281ff4a02 140 /** @addtogroup I2SEx_Exported_Functions_Group1 I2S Extended IO operation functions
AnnaBridge 161:aa5281ff4a02 141 * @{
AnnaBridge 161:aa5281ff4a02 142 */
AnnaBridge 161:aa5281ff4a02 143
AnnaBridge 161:aa5281ff4a02 144 /* Extended features functions *************************************************/
AnnaBridge 161:aa5281ff4a02 145 /* Blocking mode: Polling */
AnnaBridge 161:aa5281ff4a02 146 HAL_StatusTypeDef HAL_I2SEx_TransmitReceive(I2S_HandleTypeDef *hi2s, uint16_t *pTxData, uint16_t *pRxData,
AnnaBridge 161:aa5281ff4a02 147 uint16_t Size, uint32_t Timeout);
AnnaBridge 161:aa5281ff4a02 148 /* Non-Blocking mode: Interrupt */
AnnaBridge 161:aa5281ff4a02 149 HAL_StatusTypeDef HAL_I2SEx_TransmitReceive_IT(I2S_HandleTypeDef *hi2s, uint16_t *pTxData, uint16_t *pRxData,
AnnaBridge 161:aa5281ff4a02 150 uint16_t Size);
AnnaBridge 161:aa5281ff4a02 151 /* Non-Blocking mode: DMA */
AnnaBridge 161:aa5281ff4a02 152 HAL_StatusTypeDef HAL_I2SEx_TransmitReceive_DMA(I2S_HandleTypeDef *hi2s, uint16_t *pTxData, uint16_t *pRxData,
AnnaBridge 161:aa5281ff4a02 153 uint16_t Size);
AnnaBridge 161:aa5281ff4a02 154 /* I2S IRQHandler and Callbacks used in non blocking modes (Interrupt and DMA) */
AnnaBridge 161:aa5281ff4a02 155 void HAL_I2SEx_FullDuplex_IRQHandler(I2S_HandleTypeDef *hi2s);
AnnaBridge 161:aa5281ff4a02 156 void HAL_I2SEx_TxRxCpltCallback(I2S_HandleTypeDef *hi2s);
AnnaBridge 161:aa5281ff4a02 157 /**
AnnaBridge 161:aa5281ff4a02 158 * @}
AnnaBridge 161:aa5281ff4a02 159 */
AnnaBridge 161:aa5281ff4a02 160
AnnaBridge 161:aa5281ff4a02 161 /**
AnnaBridge 161:aa5281ff4a02 162 * @}
AnnaBridge 161:aa5281ff4a02 163 */
AnnaBridge 161:aa5281ff4a02 164 /* Private types -------------------------------------------------------------*/
AnnaBridge 161:aa5281ff4a02 165 /* Private variables ---------------------------------------------------------*/
AnnaBridge 161:aa5281ff4a02 166 /* Private constants ---------------------------------------------------------*/
AnnaBridge 161:aa5281ff4a02 167 /* Private macros ------------------------------------------------------------*/
AnnaBridge 161:aa5281ff4a02 168
AnnaBridge 161:aa5281ff4a02 169 /**
AnnaBridge 161:aa5281ff4a02 170 * @}
AnnaBridge 161:aa5281ff4a02 171 */
AnnaBridge 161:aa5281ff4a02 172
AnnaBridge 161:aa5281ff4a02 173 /* Private functions ---------------------------------------------------------*/
AnnaBridge 161:aa5281ff4a02 174
AnnaBridge 161:aa5281ff4a02 175 /**
AnnaBridge 161:aa5281ff4a02 176 * @}
AnnaBridge 161:aa5281ff4a02 177 */
AnnaBridge 161:aa5281ff4a02 178
AnnaBridge 161:aa5281ff4a02 179 #endif /* SPI_I2S_FULLDUPLEX_SUPPORT */
AnnaBridge 161:aa5281ff4a02 180 /**
AnnaBridge 161:aa5281ff4a02 181 * @}
AnnaBridge 161:aa5281ff4a02 182 */
AnnaBridge 161:aa5281ff4a02 183
AnnaBridge 161:aa5281ff4a02 184 #ifdef __cplusplus
AnnaBridge 161:aa5281ff4a02 185 }
AnnaBridge 161:aa5281ff4a02 186 #endif
AnnaBridge 161:aa5281ff4a02 187
AnnaBridge 161:aa5281ff4a02 188
AnnaBridge 161:aa5281ff4a02 189 #endif /* __STM32F4xx_HAL_I2S_EX_H */
AnnaBridge 161:aa5281ff4a02 190
AnnaBridge 161:aa5281ff4a02 191 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/