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_NUCLEO_F412ZG/TOOLCHAIN_IAR/stm32f4xx_hal_i2s_ex.h@171:3a7713b1edbc, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:45:42 2018 +0000
Revision:
171:3a7713b1edbc
Parent:
TARGET_MTB_MTS_DRAGONFLY/TARGET_STM/TARGET_STM32F4/device/stm32f4xx_hal_i2s_ex.h@163:e59c8e839560 
mbed library. Release version 164

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