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_L011K4/TARGET_STM/TARGET_STM32L0/device/stm32l0xx_hal_usart_ex.h@157:e7ca05fa8600, 2017-11-09 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 09 11:14:10 2017 +0000
Revision:
157:e7ca05fa8600
Child:
167:84c0a372a020
Release 155 of the mbed library.

Who changed what in which revision?

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