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_F334R8/stm32f3xx_hal_i2s_ex.h@89:552587b429a1, 2014-09-12 (annotated)

Committer:
bogdanm
Date:
Fri Sep 12 16:41:52 2014 +0100
Revision:
89:552587b429a1
Parent:
86:04dd9b1680ae
Child:
92:4fc01daae5a5
Release 89 of the mbed library



Main changes:



- low power optimizations for Nordic targets

- code structure changes for Freescale K64F targets

- bug fixes in various backends

Who changed what in which revision?

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