mbed official / mbed

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

TARGET_DISCO_L475VG_IOT01A/TARGET_STM/TARGET_STM32L4/device/stm32l4xx_hal_usart_ex.h@145:64910690c574, 2017-06-21 (annotated)

Committer:
AnnaBridge
Date:
Wed Jun 21 17:31:38 2017 +0100
Revision:
145:64910690c574
Child:
161:aa5281ff4a02
Release 145 of the mbed library.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 145:64910690c574 1 /**
AnnaBridge 145:64910690c574 2 ******************************************************************************
AnnaBridge 145:64910690c574 3 * @file stm32l4xx_hal_usart_ex.h
AnnaBridge 145:64910690c574 4 * @author MCD Application Team
AnnaBridge 145:64910690c574 5 * @version V1.7.1
AnnaBridge 145:64910690c574 6 * @date 21-April-2017
AnnaBridge 145:64910690c574 7 * @brief Header file of USART HAL Extended module.
AnnaBridge 145:64910690c574 8 ******************************************************************************
AnnaBridge 145:64910690c574 9 * @attention
AnnaBridge 145:64910690c574 10 *
AnnaBridge 145:64910690c574 11 * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
AnnaBridge 145:64910690c574 12 *
AnnaBridge 145:64910690c574 13 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 145:64910690c574 14 * are permitted provided that the following conditions are met:
AnnaBridge 145:64910690c574 15 * 1. Redistributions of source code must retain the above copyright notice,
AnnaBridge 145:64910690c574 16 * this list of conditions and the following disclaimer.
AnnaBridge 145:64910690c574 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
AnnaBridge 145:64910690c574 18 * this list of conditions and the following disclaimer in the documentation
AnnaBridge 145:64910690c574 19 * and/or other materials provided with the distribution.
AnnaBridge 145:64910690c574 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
AnnaBridge 145:64910690c574 21 * may be used to endorse or promote products derived from this software
AnnaBridge 145:64910690c574 22 * without specific prior written permission.
AnnaBridge 145:64910690c574 23 *
AnnaBridge 145:64910690c574 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AnnaBridge 145:64910690c574 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
AnnaBridge 145:64910690c574 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 145:64910690c574 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
AnnaBridge 145:64910690c574 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
AnnaBridge 145:64910690c574 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
AnnaBridge 145:64910690c574 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
AnnaBridge 145:64910690c574 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
AnnaBridge 145:64910690c574 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
AnnaBridge 145:64910690c574 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 145:64910690c574 34 *
AnnaBridge 145:64910690c574 35 ******************************************************************************
AnnaBridge 145:64910690c574 36 */
AnnaBridge 145:64910690c574 37
AnnaBridge 145:64910690c574 38 /* Define to prevent recursive inclusion -------------------------------------*/
AnnaBridge 145:64910690c574 39 #ifndef __STM32L4xx_HAL_USART_EX_H
AnnaBridge 145:64910690c574 40 #define __STM32L4xx_HAL_USART_EX_H
AnnaBridge 145:64910690c574 41
AnnaBridge 145:64910690c574 42 #ifdef __cplusplus
AnnaBridge 145:64910690c574 43 extern "C" {
AnnaBridge 145:64910690c574 44 #endif
AnnaBridge 145:64910690c574 45
AnnaBridge 145:64910690c574 46 /* Includes ------------------------------------------------------------------*/
AnnaBridge 145:64910690c574 47 #include "stm32l4xx_hal_def.h"
AnnaBridge 145:64910690c574 48
AnnaBridge 145:64910690c574 49 /** @addtogroup STM32L4xx_HAL_Driver
AnnaBridge 145:64910690c574 50 * @{
AnnaBridge 145:64910690c574 51 */
AnnaBridge 145:64910690c574 52
AnnaBridge 145:64910690c574 53 /** @addtogroup USARTEx
AnnaBridge 145:64910690c574 54 * @{
AnnaBridge 145:64910690c574 55 */
AnnaBridge 145:64910690c574 56
AnnaBridge 145:64910690c574 57 /* Exported types ------------------------------------------------------------*/
AnnaBridge 145:64910690c574 58 /* Exported constants --------------------------------------------------------*/
AnnaBridge 145:64910690c574 59 /** @defgroup USARTEx_Exported_Constants USARTEx Exported Constants
AnnaBridge 145:64910690c574 60 * @{
AnnaBridge 145:64910690c574 61 */
AnnaBridge 145:64910690c574 62
AnnaBridge 145:64910690c574 63 /** @defgroup USARTEx_Word_Length USARTEx Word Length
AnnaBridge 145:64910690c574 64 * @{
AnnaBridge 145:64910690c574 65 */
AnnaBridge 145:64910690c574 66 #define USART_WORDLENGTH_7B ((uint32_t)USART_CR1_M1) /*!< 7-bit long USART frame */
AnnaBridge 145:64910690c574 67 #define USART_WORDLENGTH_8B ((uint32_t)0x00000000) /*!< 8-bit long USART frame */
AnnaBridge 145:64910690c574 68 #define USART_WORDLENGTH_9B ((uint32_t)USART_CR1_M0) /*!< 9-bit long USART frame */
AnnaBridge 145:64910690c574 69 /**
AnnaBridge 145:64910690c574 70 * @}
AnnaBridge 145:64910690c574 71 */
AnnaBridge 145:64910690c574 72
AnnaBridge 145:64910690c574 73 /**
AnnaBridge 145:64910690c574 74 * @}
AnnaBridge 145:64910690c574 75 */
AnnaBridge 145:64910690c574 76
AnnaBridge 145:64910690c574 77 /* Exported functions --------------------------------------------------------*/
AnnaBridge 145:64910690c574 78
AnnaBridge 145:64910690c574 79 /* Private macros ------------------------------------------------------------*/
AnnaBridge 145:64910690c574 80 /** @defgroup USARTEx_Private_Macros USARTEx Private Macros
AnnaBridge 145:64910690c574 81 * @{
AnnaBridge 145:64910690c574 82 */
AnnaBridge 145:64910690c574 83
AnnaBridge 145:64910690c574 84 /** @brief Report the USART clock source.
AnnaBridge 145:64910690c574 85 * @param __HANDLE__: specifies the USART Handle.
AnnaBridge 145:64910690c574 86 * @param __CLOCKSOURCE__: output variable.
AnnaBridge 145:64910690c574 87 * @retval the USART clocking source, written in __CLOCKSOURCE__.
AnnaBridge 145:64910690c574 88 */
AnnaBridge 145:64910690c574 89 #if defined (STM32L432xx) || defined (STM32L442xx)
AnnaBridge 145:64910690c574 90 #define USART_GETCLOCKSOURCE(__HANDLE__,__CLOCKSOURCE__) \
AnnaBridge 145:64910690c574 91 do { \
AnnaBridge 145:64910690c574 92 if((__HANDLE__)->Instance == USART1) \
AnnaBridge 145:64910690c574 93 { \
AnnaBridge 145:64910690c574 94 switch(__HAL_RCC_GET_USART1_SOURCE()) \
AnnaBridge 145:64910690c574 95 { \
AnnaBridge 145:64910690c574 96 case RCC_USART1CLKSOURCE_PCLK2: \
AnnaBridge 145:64910690c574 97 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_PCLK2; \
AnnaBridge 145:64910690c574 98 break; \
AnnaBridge 145:64910690c574 99 case RCC_USART1CLKSOURCE_HSI: \
AnnaBridge 145:64910690c574 100 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_HSI; \
AnnaBridge 145:64910690c574 101 break; \
AnnaBridge 145:64910690c574 102 case RCC_USART1CLKSOURCE_SYSCLK: \
AnnaBridge 145:64910690c574 103 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_SYSCLK; \
AnnaBridge 145:64910690c574 104 break; \
AnnaBridge 145:64910690c574 105 case RCC_USART1CLKSOURCE_LSE: \
AnnaBridge 145:64910690c574 106 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_LSE; \
AnnaBridge 145:64910690c574 107 break; \
AnnaBridge 145:64910690c574 108 default: \
AnnaBridge 145:64910690c574 109 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_UNDEFINED; \
AnnaBridge 145:64910690c574 110 break; \
AnnaBridge 145:64910690c574 111 } \
AnnaBridge 145:64910690c574 112 } \
AnnaBridge 145:64910690c574 113 else if((__HANDLE__)->Instance == USART2) \
AnnaBridge 145:64910690c574 114 { \
AnnaBridge 145:64910690c574 115 switch(__HAL_RCC_GET_USART2_SOURCE()) \
AnnaBridge 145:64910690c574 116 { \
AnnaBridge 145:64910690c574 117 case RCC_USART2CLKSOURCE_PCLK1: \
AnnaBridge 145:64910690c574 118 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_PCLK1; \
AnnaBridge 145:64910690c574 119 break; \
AnnaBridge 145:64910690c574 120 case RCC_USART2CLKSOURCE_HSI: \
AnnaBridge 145:64910690c574 121 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_HSI; \
AnnaBridge 145:64910690c574 122 break; \
AnnaBridge 145:64910690c574 123 case RCC_USART2CLKSOURCE_SYSCLK: \
AnnaBridge 145:64910690c574 124 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_SYSCLK; \
AnnaBridge 145:64910690c574 125 break; \
AnnaBridge 145:64910690c574 126 case RCC_USART2CLKSOURCE_LSE: \
AnnaBridge 145:64910690c574 127 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_LSE; \
AnnaBridge 145:64910690c574 128 break; \
AnnaBridge 145:64910690c574 129 default: \
AnnaBridge 145:64910690c574 130 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_UNDEFINED; \
AnnaBridge 145:64910690c574 131 break; \
AnnaBridge 145:64910690c574 132 } \
AnnaBridge 145:64910690c574 133 } \
AnnaBridge 145:64910690c574 134 } while(0)
AnnaBridge 145:64910690c574 135 #else
AnnaBridge 145:64910690c574 136 #define USART_GETCLOCKSOURCE(__HANDLE__,__CLOCKSOURCE__) \
AnnaBridge 145:64910690c574 137 do { \
AnnaBridge 145:64910690c574 138 if((__HANDLE__)->Instance == USART1) \
AnnaBridge 145:64910690c574 139 { \
AnnaBridge 145:64910690c574 140 switch(__HAL_RCC_GET_USART1_SOURCE()) \
AnnaBridge 145:64910690c574 141 { \
AnnaBridge 145:64910690c574 142 case RCC_USART1CLKSOURCE_PCLK2: \
AnnaBridge 145:64910690c574 143 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_PCLK2; \
AnnaBridge 145:64910690c574 144 break; \
AnnaBridge 145:64910690c574 145 case RCC_USART1CLKSOURCE_HSI: \
AnnaBridge 145:64910690c574 146 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_HSI; \
AnnaBridge 145:64910690c574 147 break; \
AnnaBridge 145:64910690c574 148 case RCC_USART1CLKSOURCE_SYSCLK: \
AnnaBridge 145:64910690c574 149 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_SYSCLK; \
AnnaBridge 145:64910690c574 150 break; \
AnnaBridge 145:64910690c574 151 case RCC_USART1CLKSOURCE_LSE: \
AnnaBridge 145:64910690c574 152 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_LSE; \
AnnaBridge 145:64910690c574 153 break; \
AnnaBridge 145:64910690c574 154 default: \
AnnaBridge 145:64910690c574 155 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_UNDEFINED; \
AnnaBridge 145:64910690c574 156 break; \
AnnaBridge 145:64910690c574 157 } \
AnnaBridge 145:64910690c574 158 } \
AnnaBridge 145:64910690c574 159 else if((__HANDLE__)->Instance == USART2) \
AnnaBridge 145:64910690c574 160 { \
AnnaBridge 145:64910690c574 161 switch(__HAL_RCC_GET_USART2_SOURCE()) \
AnnaBridge 145:64910690c574 162 { \
AnnaBridge 145:64910690c574 163 case RCC_USART2CLKSOURCE_PCLK1: \
AnnaBridge 145:64910690c574 164 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_PCLK1; \
AnnaBridge 145:64910690c574 165 break; \
AnnaBridge 145:64910690c574 166 case RCC_USART2CLKSOURCE_HSI: \
AnnaBridge 145:64910690c574 167 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_HSI; \
AnnaBridge 145:64910690c574 168 break; \
AnnaBridge 145:64910690c574 169 case RCC_USART2CLKSOURCE_SYSCLK: \
AnnaBridge 145:64910690c574 170 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_SYSCLK; \
AnnaBridge 145:64910690c574 171 break; \
AnnaBridge 145:64910690c574 172 case RCC_USART2CLKSOURCE_LSE: \
AnnaBridge 145:64910690c574 173 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_LSE; \
AnnaBridge 145:64910690c574 174 break; \
AnnaBridge 145:64910690c574 175 default: \
AnnaBridge 145:64910690c574 176 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_UNDEFINED; \
AnnaBridge 145:64910690c574 177 break; \
AnnaBridge 145:64910690c574 178 } \
AnnaBridge 145:64910690c574 179 } \
AnnaBridge 145:64910690c574 180 else if((__HANDLE__)->Instance == USART3) \
AnnaBridge 145:64910690c574 181 { \
AnnaBridge 145:64910690c574 182 switch(__HAL_RCC_GET_USART3_SOURCE()) \
AnnaBridge 145:64910690c574 183 { \
AnnaBridge 145:64910690c574 184 case RCC_USART3CLKSOURCE_PCLK1: \
AnnaBridge 145:64910690c574 185 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_PCLK1; \
AnnaBridge 145:64910690c574 186 break; \
AnnaBridge 145:64910690c574 187 case RCC_USART3CLKSOURCE_HSI: \
AnnaBridge 145:64910690c574 188 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_HSI; \
AnnaBridge 145:64910690c574 189 break; \
AnnaBridge 145:64910690c574 190 case RCC_USART3CLKSOURCE_SYSCLK: \
AnnaBridge 145:64910690c574 191 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_SYSCLK; \
AnnaBridge 145:64910690c574 192 break; \
AnnaBridge 145:64910690c574 193 case RCC_USART3CLKSOURCE_LSE: \
AnnaBridge 145:64910690c574 194 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_LSE; \
AnnaBridge 145:64910690c574 195 break; \
AnnaBridge 145:64910690c574 196 default: \
AnnaBridge 145:64910690c574 197 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_UNDEFINED; \
AnnaBridge 145:64910690c574 198 break; \
AnnaBridge 145:64910690c574 199 } \
AnnaBridge 145:64910690c574 200 } \
AnnaBridge 145:64910690c574 201 } while(0)
AnnaBridge 145:64910690c574 202 #endif /* STM32L432xx || STM32L442xx */
AnnaBridge 145:64910690c574 203
AnnaBridge 145:64910690c574 204 /** @brief Compute the USART mask to apply to retrieve the received data
AnnaBridge 145:64910690c574 205 * according to the word length and to the parity bits activation.
AnnaBridge 145:64910690c574 206 * @note If PCE = 1, the parity bit is not included in the data extracted
AnnaBridge 145:64910690c574 207 * by the reception API().
AnnaBridge 145:64910690c574 208 * This masking operation is not carried out in the case of
AnnaBridge 145:64910690c574 209 * DMA transfers.
AnnaBridge 145:64910690c574 210 * @param __HANDLE__: specifies the USART Handle.
AnnaBridge 145:64910690c574 211 * @retval None, the mask to apply to USART RDR register is stored in (__HANDLE__)->Mask field.
AnnaBridge 145:64910690c574 212 */
AnnaBridge 145:64910690c574 213 #define USART_MASK_COMPUTATION(__HANDLE__) \
AnnaBridge 145:64910690c574 214 do { \
AnnaBridge 145:64910690c574 215 if ((__HANDLE__)->Init.WordLength == USART_WORDLENGTH_9B) \
AnnaBridge 145:64910690c574 216 { \
AnnaBridge 145:64910690c574 217 if ((__HANDLE__)->Init.Parity == USART_PARITY_NONE) \
AnnaBridge 145:64910690c574 218 { \
AnnaBridge 145:64910690c574 219 (__HANDLE__)->Mask = 0x01FF ; \
AnnaBridge 145:64910690c574 220 } \
AnnaBridge 145:64910690c574 221 else \
AnnaBridge 145:64910690c574 222 { \
AnnaBridge 145:64910690c574 223 (__HANDLE__)->Mask = 0x00FF ; \
AnnaBridge 145:64910690c574 224 } \
AnnaBridge 145:64910690c574 225 } \
AnnaBridge 145:64910690c574 226 else if ((__HANDLE__)->Init.WordLength == USART_WORDLENGTH_8B) \
AnnaBridge 145:64910690c574 227 { \
AnnaBridge 145:64910690c574 228 if ((__HANDLE__)->Init.Parity == USART_PARITY_NONE) \
AnnaBridge 145:64910690c574 229 { \
AnnaBridge 145:64910690c574 230 (__HANDLE__)->Mask = 0x00FF ; \
AnnaBridge 145:64910690c574 231 } \
AnnaBridge 145:64910690c574 232 else \
AnnaBridge 145:64910690c574 233 { \
AnnaBridge 145:64910690c574 234 (__HANDLE__)->Mask = 0x007F ; \
AnnaBridge 145:64910690c574 235 } \
AnnaBridge 145:64910690c574 236 } \
AnnaBridge 145:64910690c574 237 else if ((__HANDLE__)->Init.WordLength == USART_WORDLENGTH_7B) \
AnnaBridge 145:64910690c574 238 { \
AnnaBridge 145:64910690c574 239 if ((__HANDLE__)->Init.Parity == USART_PARITY_NONE) \
AnnaBridge 145:64910690c574 240 { \
AnnaBridge 145:64910690c574 241 (__HANDLE__)->Mask = 0x007F ; \
AnnaBridge 145:64910690c574 242 } \
AnnaBridge 145:64910690c574 243 else \
AnnaBridge 145:64910690c574 244 { \
AnnaBridge 145:64910690c574 245 (__HANDLE__)->Mask = 0x003F ; \
AnnaBridge 145:64910690c574 246 } \
AnnaBridge 145:64910690c574 247 } \
AnnaBridge 145:64910690c574 248 } while(0)
AnnaBridge 145:64910690c574 249
AnnaBridge 145:64910690c574 250
AnnaBridge 145:64910690c574 251 /**
AnnaBridge 145:64910690c574 252 * @brief Ensure that USART frame length is valid.
AnnaBridge 145:64910690c574 253 * @param __LENGTH__: USART frame length.
AnnaBridge 145:64910690c574 254 * @retval SET (__LENGTH__ is valid) or RESET (__LENGTH__ is invalid)
AnnaBridge 145:64910690c574 255 */
AnnaBridge 145:64910690c574 256 #define IS_USART_WORD_LENGTH(__LENGTH__) (((__LENGTH__) == USART_WORDLENGTH_7B) || \
AnnaBridge 145:64910690c574 257 ((__LENGTH__) == USART_WORDLENGTH_8B) || \
AnnaBridge 145:64910690c574 258 ((__LENGTH__) == USART_WORDLENGTH_9B))
AnnaBridge 145:64910690c574 259
AnnaBridge 145:64910690c574 260 /**
AnnaBridge 145:64910690c574 261 * @}
AnnaBridge 145:64910690c574 262 */
AnnaBridge 145:64910690c574 263
AnnaBridge 145:64910690c574 264 /* Exported functions --------------------------------------------------------*/
AnnaBridge 145:64910690c574 265
AnnaBridge 145:64910690c574 266 /**
AnnaBridge 145:64910690c574 267 * @}
AnnaBridge 145:64910690c574 268 */
AnnaBridge 145:64910690c574 269
AnnaBridge 145:64910690c574 270 /**
AnnaBridge 145:64910690c574 271 * @}
AnnaBridge 145:64910690c574 272 */
AnnaBridge 145:64910690c574 273
AnnaBridge 145:64910690c574 274 #ifdef __cplusplus
AnnaBridge 145:64910690c574 275 }
AnnaBridge 145:64910690c574 276 #endif
AnnaBridge 145:64910690c574 277
AnnaBridge 145:64910690c574 278 #endif /* __STM32L4xx_HAL_USART_EX_H */
AnnaBridge 145:64910690c574 279
AnnaBridge 145:64910690c574 280 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/