2 ******************************************************************************
3 * @file stm32l0xx_hal_usart_ex.h
4 * @author MCD Application Team
6 * @date 06-February-2015
7 * @brief Header file of USART HAL Extension module.
8 ******************************************************************************
11 * <h2><center>© COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
13 * Redistribution and use in source and binary forms, with or without modification,
14 * are permitted provided that the following conditions are met:
15 * 1. Redistributions of source code must retain the above copyright notice,
16 * this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright notice,
18 * this list of conditions and the following disclaimer in the documentation
19 * and/or other materials provided with the distribution.
20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
21 * may be used to endorse or promote products derived from this software
22 * without specific prior written permission.
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 ******************************************************************************
38 /* Define to prevent recursive inclusion -------------------------------------*/
39 #ifndef __STM32L0xx_HAL_USART_EX_H
40 #define __STM32L0xx_HAL_USART_EX_H
46 /* Includes ------------------------------------------------------------------*/
47 #include "stm32l0xx_hal_def.h"
49 /** @addtogroup STM32L0xx_HAL_Driver
52 /** @defgroup USARTEx USARTEx Extended USART
56 /* Exported types ------------------------------------------------------------*/
57 /* Exported constants --------------------------------------------------------*/
58 /** @defgroup USARTEx_Exported_Constants USARTEx Exported Constants
62 /** @defgroup USARTEx_Word_Length Word length definition
65 #define USART_WORDLENGTH_7B ((uint32_t)USART_CR1_M_1)
66 #define USART_WORDLENGTH_8B ((uint32_t)0x00000000)
67 #define USART_WORDLENGTH_9B ((uint32_t)USART_CR1_M_0)
68 #define IS_USART_WORD_LENGTH(LENGTH) (((LENGTH) == USART_WORDLENGTH_7B) || \
69 ((LENGTH) == USART_WORDLENGTH_8B) || \
70 ((LENGTH) == USART_WORDLENGTH_9B))
78 /* Exported macro ------------------------------------------------------------*/
80 /** @defgroup USARTEx_Extended_Exported_Macros USARTEx Exported Macros
84 /** @brief Reports the USART clock source.
85 * @param __HANDLE__: specifies the USART Handle
86 * @param __CLOCKSOURCE__ : output variable
87 * @retval the USART clocking source, written in __CLOCKSOURCE__.
89 #if defined (STM32L031xx) || defined (STM32L041xx)
90 #define USART_GETCLOCKSOURCE(__HANDLE__,__CLOCKSOURCE__) \
92 if((__HANDLE__)->Instance == USART2) \
94 switch(__HAL_RCC_GET_USART2_SOURCE()) \
96 case RCC_USART2CLKSOURCE_PCLK1: \
97 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_PCLK1; \
99 case RCC_USART2CLKSOURCE_HSI: \
100 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_HSI; \
102 case RCC_USART2CLKSOURCE_SYSCLK: \
103 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_SYSCLK; \
105 case RCC_USART2CLKSOURCE_LSE: \
106 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_LSE; \
114 #else /* (STM32L031xx) || defined (STM32L041xx) */
116 #define USART_GETCLOCKSOURCE(__HANDLE__,__CLOCKSOURCE__) \
118 if((__HANDLE__)->Instance == USART1) \
120 switch(__HAL_RCC_GET_USART1_SOURCE()) \
122 case RCC_USART1CLKSOURCE_PCLK2: \
123 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_PCLK2; \
125 case RCC_USART1CLKSOURCE_HSI: \
126 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_HSI; \
128 case RCC_USART1CLKSOURCE_SYSCLK: \
129 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_SYSCLK; \
131 case RCC_USART1CLKSOURCE_LSE: \
132 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_LSE; \
138 else if((__HANDLE__)->Instance == USART2) \
140 switch(__HAL_RCC_GET_USART2_SOURCE()) \
142 case RCC_USART2CLKSOURCE_PCLK1: \
143 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_PCLK1; \
145 case RCC_USART2CLKSOURCE_HSI: \
146 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_HSI; \
148 case RCC_USART2CLKSOURCE_SYSCLK: \
149 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_SYSCLK; \
151 case RCC_USART2CLKSOURCE_LSE: \
152 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_LSE; \
159 #endif /* (STM32L031xx) || (STM32L041xx) */
161 /** @brief Reports the USART mask to apply to retrieve the received data
162 * according to the word length and to the parity bits activation.
163 * If PCE = 1, the parity bit is not included in the data extracted
164 * by the reception API().
165 * This masking operation is not carried out in the case of
167 * @param __HANDLE__: specifies the USART Handle
168 * @retval mask to apply to USART RDR register value.
170 #define USART_MASK_COMPUTATION(__HANDLE__) \
172 if ((__HANDLE__)->Init.WordLength == USART_WORDLENGTH_9B) \
174 if ((__HANDLE__)->Init.Parity == USART_PARITY_NONE) \
176 (__HANDLE__)->Mask = 0x01FF ; \
180 (__HANDLE__)->Mask = 0x00FF ; \
183 else if ((__HANDLE__)->Init.WordLength == USART_WORDLENGTH_8B) \
185 if ((__HANDLE__)->Init.Parity == USART_PARITY_NONE) \
187 (__HANDLE__)->Mask = 0x00FF ; \
191 (__HANDLE__)->Mask = 0x007F ; \
194 else if ((__HANDLE__)->Init.WordLength == USART_WORDLENGTH_7B) \
196 if ((__HANDLE__)->Init.Parity == USART_PARITY_NONE) \
198 (__HANDLE__)->Mask = 0x007F ; \
202 (__HANDLE__)->Mask = 0x003F ; \
211 /* Exported functions --------------------------------------------------------*/
212 /* Initialization/de-initialization methods **********************************/
213 /* IO operation methods *******************************************************/
214 /* Peripheral Control methods ************************************************/
215 /* Peripheral State methods **************************************************/
230 #endif /* __STM32L0xx_HAL_USART_EX_H */
232 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/