mbed official / mbed

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

Committer:
Kojto
Date:
Thu Jul 07 14:34:11 2016 +0100
Revision:
122:f9eeca106725
Parent:
107:4f6c30876dfa
Release 122 of the mbed library

Changes:
- new targets - Nucleo L432KC, Beetle, Nucleo F446ZE, Nucleo L011K4
- Thread safety addition - mbed API should contain a statement about thread safety
- critical section API addition
- CAS API (core_util_atomic_incr/decr)
- DEVICE_ are generated from targets.json file, device.h deprecated
- Callback replaces FunctionPointer to provide std like interface
- mbed HAL API docs improvements
- toolchain - prexif attributes with MBED_
- add new attributes - packed, weak, forcedinline, align
- target.json - contains targets definitions
- ST - L1XX - Cube update to 1.5
- SPI clock selection fix (clock from APB domain)
- F7 - Cube update v1.4.0
- L0 - baudrate init fix
- L1 - Cube update v1.5
- F3 - baudrate init fix, 3 targets CAN support
- F4 - Cube update v1.12.0, 3 targets CAN support
- L4XX - Cube update v1.5.1
- F0 - update Cube to v1.5.0
- L4 - 2 targets (L476RG/VG) CAN support
- NXP - pwm clock fix for KSDK2 MCU
- LPC2368 - remove ARM toolchain support - due to regression
- KSDK2 - fix SPI , I2C address and repeat start
- Silabs - some fixes backported from mbed 3
- Renesas - RZ_A1H - SystemCoreClockUpdate addition

Who changed what in which revision?

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