Jolyon Hill / mbed-dev

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.

Fork of mbed-dev by mbed official

targets/cmsis/TARGET_STM/TARGET_STM32L0/stm32l0xx_hal_usart_ex.h@149:6f3fb14e6942, 2016-10-10 (annotated)

Committer:
jolyon
Date:
Mon Oct 10 14:36:54 2016 +0000
Revision:
149:6f3fb14e6942
Parent:
144:ef7eb2e8f9f7 
Working with LPC1764 & inverted LEDS

Who changed what in which revision?

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