mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

targets/TARGET_STM/TARGET_STM32F4/device/stm32f4xx_hal_i2s_ex.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
Parent:
182:a56a73fd2a6f 
mbed library release version 165

Who changed what in which revision?

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