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_B96B_F446VE/TARGET_STM/TARGET_STM32F4/device/stm32f4xx_hal_i2s_ex.h@169:a7c7b631e539, 2018-06-22 (annotated)

Committer:
Anna Bridge
Date:
Fri Jun 22 15:38:59 2018 +0100
Revision:
169:a7c7b631e539
Parent:
163:e59c8e839560 
mbed library. Release version 162

Who changed what in which revision?

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