2 ******************************************************************************
\r
3 * @file stm32f7xx_hal_uart_ex.h
\r
4 * @author MCD Application Team
\r
6 * @date 24-March-2015
\r
7 * @brief Header file of UART HAL Extension module.
\r
8 ******************************************************************************
\r
11 * <h2><center>© COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
\r
13 * Redistribution and use in source and binary forms, with or without modification,
\r
14 * are permitted provided that the following conditions are met:
\r
15 * 1. Redistributions of source code must retain the above copyright notice,
\r
16 * this list of conditions and the following disclaimer.
\r
17 * 2. Redistributions in binary form must reproduce the above copyright notice,
\r
18 * this list of conditions and the following disclaimer in the documentation
\r
19 * and/or other materials provided with the distribution.
\r
20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
\r
21 * may be used to endorse or promote products derived from this software
\r
22 * without specific prior written permission.
\r
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
\r
25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
\r
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
\r
27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
\r
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
\r
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
\r
30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
\r
31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
\r
32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
\r
33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
\r
35 ******************************************************************************
\r
38 /* Define to prevent recursive inclusion -------------------------------------*/
\r
39 #ifndef __STM32F7xx_HAL_UART_EX_H
\r
40 #define __STM32F7xx_HAL_UART_EX_H
\r
46 /* Includes ------------------------------------------------------------------*/
\r
47 #include "stm32f7xx_hal_def.h"
\r
49 /** @addtogroup STM32F7xx_HAL_Driver
\r
53 /** @addtogroup UARTEx
\r
57 /* Exported types ------------------------------------------------------------*/
\r
58 /* Exported constants --------------------------------------------------------*/
\r
59 /** @defgroup UARTEx_Exported_Constants UARTEx Exported Constants
\r
63 /** @defgroup UARTEx_Word_Length UARTEx Word Length
\r
66 #define UART_WORDLENGTH_7B ((uint32_t)USART_CR1_M_1)
\r
67 #define UART_WORDLENGTH_8B ((uint32_t)0x0000)
\r
68 #define UART_WORDLENGTH_9B ((uint32_t)USART_CR1_M_0)
\r
69 #define IS_UART_WORD_LENGTH(__LENGTH__) (((__LENGTH__) == UART_WORDLENGTH_7B) || \
\r
70 ((__LENGTH__) == UART_WORDLENGTH_8B) || \
\r
71 ((__LENGTH__) == UART_WORDLENGTH_9B))
\r
72 #define IS_LIN_WORD_LENGTH(LENGTH) (((LENGTH) == UART_WORDLENGTH_8B))
\r
78 /** @defgroup UARTEx_WakeUp_Address_Length UARTEx WakeUp Address Length
\r
81 #define UART_ADDRESS_DETECT_4B ((uint32_t)0x00000000)
\r
82 #define UART_ADDRESS_DETECT_7B ((uint32_t)USART_CR2_ADDM7)
\r
83 #define IS_UART_ADDRESSLENGTH_DETECT(__ADDRESS__) (((__ADDRESS__) == UART_ADDRESS_DETECT_4B) || \
\r
84 ((__ADDRESS__) == UART_ADDRESS_DETECT_7B))
\r
94 /* Exported macro ------------------------------------------------------------*/
\r
96 /** @defgroup UARTEx_Exported_Macros UARTEx Exported Macros
\r
100 /** @brief Reports the UART clock source.
\r
101 * @param __HANDLE__: specifies the UART Handle
\r
102 * @param __CLOCKSOURCE__ : output variable
\r
103 * @retval UART clocking source, written in __CLOCKSOURCE__.
\r
105 #define UART_GETCLOCKSOURCE(__HANDLE__,__CLOCKSOURCE__) \
\r
107 if((__HANDLE__)->Instance == USART1) \
\r
109 switch(__HAL_RCC_GET_USART1_SOURCE()) \
\r
111 case RCC_USART1CLKSOURCE_PCLK2: \
\r
112 (__CLOCKSOURCE__) = UART_CLOCKSOURCE_PCLK2; \
\r
114 case RCC_USART1CLKSOURCE_HSI: \
\r
115 (__CLOCKSOURCE__) = UART_CLOCKSOURCE_HSI; \
\r
117 case RCC_USART1CLKSOURCE_SYSCLK: \
\r
118 (__CLOCKSOURCE__) = UART_CLOCKSOURCE_SYSCLK; \
\r
120 case RCC_USART1CLKSOURCE_LSE: \
\r
121 (__CLOCKSOURCE__) = UART_CLOCKSOURCE_LSE; \
\r
127 else if((__HANDLE__)->Instance == USART2) \
\r
129 switch(__HAL_RCC_GET_USART2_SOURCE()) \
\r
131 case RCC_USART2CLKSOURCE_PCLK1: \
\r
132 (__CLOCKSOURCE__) = UART_CLOCKSOURCE_PCLK1; \
\r
134 case RCC_USART2CLKSOURCE_HSI: \
\r
135 (__CLOCKSOURCE__) = UART_CLOCKSOURCE_HSI; \
\r
137 case RCC_USART2CLKSOURCE_SYSCLK: \
\r
138 (__CLOCKSOURCE__) = UART_CLOCKSOURCE_SYSCLK; \
\r
140 case RCC_USART2CLKSOURCE_LSE: \
\r
141 (__CLOCKSOURCE__) = UART_CLOCKSOURCE_LSE; \
\r
147 else if((__HANDLE__)->Instance == USART3) \
\r
149 switch(__HAL_RCC_GET_USART3_SOURCE()) \
\r
151 case RCC_USART3CLKSOURCE_PCLK1: \
\r
152 (__CLOCKSOURCE__) = UART_CLOCKSOURCE_PCLK1; \
\r
154 case RCC_USART3CLKSOURCE_HSI: \
\r
155 (__CLOCKSOURCE__) = UART_CLOCKSOURCE_HSI; \
\r
157 case RCC_USART3CLKSOURCE_SYSCLK: \
\r
158 (__CLOCKSOURCE__) = UART_CLOCKSOURCE_SYSCLK; \
\r
160 case RCC_USART3CLKSOURCE_LSE: \
\r
161 (__CLOCKSOURCE__) = UART_CLOCKSOURCE_LSE; \
\r
167 else if((__HANDLE__)->Instance == UART4) \
\r
169 switch(__HAL_RCC_GET_UART4_SOURCE()) \
\r
171 case RCC_UART4CLKSOURCE_PCLK1: \
\r
172 (__CLOCKSOURCE__) = UART_CLOCKSOURCE_PCLK1; \
\r
174 case RCC_UART4CLKSOURCE_HSI: \
\r
175 (__CLOCKSOURCE__) = UART_CLOCKSOURCE_HSI; \
\r
177 case RCC_UART4CLKSOURCE_SYSCLK: \
\r
178 (__CLOCKSOURCE__) = UART_CLOCKSOURCE_SYSCLK; \
\r
180 case RCC_UART4CLKSOURCE_LSE: \
\r
181 (__CLOCKSOURCE__) = UART_CLOCKSOURCE_LSE; \
\r
187 else if ((__HANDLE__)->Instance == UART5) \
\r
189 switch(__HAL_RCC_GET_UART5_SOURCE()) \
\r
191 case RCC_UART5CLKSOURCE_PCLK1: \
\r
192 (__CLOCKSOURCE__) = UART_CLOCKSOURCE_PCLK1; \
\r
194 case RCC_UART5CLKSOURCE_HSI: \
\r
195 (__CLOCKSOURCE__) = UART_CLOCKSOURCE_HSI; \
\r
197 case RCC_UART5CLKSOURCE_SYSCLK: \
\r
198 (__CLOCKSOURCE__) = UART_CLOCKSOURCE_SYSCLK; \
\r
200 case RCC_UART5CLKSOURCE_LSE: \
\r
201 (__CLOCKSOURCE__) = UART_CLOCKSOURCE_LSE; \
\r
207 else if((__HANDLE__)->Instance == USART6) \
\r
209 switch(__HAL_RCC_GET_USART6_SOURCE()) \
\r
211 case RCC_USART6CLKSOURCE_PCLK2: \
\r
212 (__CLOCKSOURCE__) = UART_CLOCKSOURCE_PCLK2; \
\r
214 case RCC_USART6CLKSOURCE_HSI: \
\r
215 (__CLOCKSOURCE__) = UART_CLOCKSOURCE_HSI; \
\r
217 case RCC_USART6CLKSOURCE_SYSCLK: \
\r
218 (__CLOCKSOURCE__) = UART_CLOCKSOURCE_SYSCLK; \
\r
220 case RCC_USART6CLKSOURCE_LSE: \
\r
221 (__CLOCKSOURCE__) = UART_CLOCKSOURCE_LSE; \
\r
227 else if ((__HANDLE__)->Instance == UART7) \
\r
229 switch(__HAL_RCC_GET_UART7_SOURCE()) \
\r
231 case RCC_UART7CLKSOURCE_PCLK1: \
\r
232 (__CLOCKSOURCE__) = UART_CLOCKSOURCE_PCLK1; \
\r
234 case RCC_UART7CLKSOURCE_HSI: \
\r
235 (__CLOCKSOURCE__) = UART_CLOCKSOURCE_HSI; \
\r
237 case RCC_UART7CLKSOURCE_SYSCLK: \
\r
238 (__CLOCKSOURCE__) = UART_CLOCKSOURCE_SYSCLK; \
\r
240 case RCC_UART7CLKSOURCE_LSE: \
\r
241 (__CLOCKSOURCE__) = UART_CLOCKSOURCE_LSE; \
\r
247 else if ((__HANDLE__)->Instance == UART8) \
\r
249 switch(__HAL_RCC_GET_UART8_SOURCE()) \
\r
251 case RCC_UART8CLKSOURCE_PCLK1: \
\r
252 (__CLOCKSOURCE__) = UART_CLOCKSOURCE_PCLK1; \
\r
254 case RCC_UART8CLKSOURCE_HSI: \
\r
255 (__CLOCKSOURCE__) = UART_CLOCKSOURCE_HSI; \
\r
257 case RCC_UART8CLKSOURCE_SYSCLK: \
\r
258 (__CLOCKSOURCE__) = UART_CLOCKSOURCE_SYSCLK; \
\r
260 case RCC_UART8CLKSOURCE_LSE: \
\r
261 (__CLOCKSOURCE__) = UART_CLOCKSOURCE_LSE; \
\r
269 /** @brief Reports the UART mask to apply to retrieve the received data
\r
270 * according to the word length and to the parity bits activation.
\r
271 * If PCE = 1, the parity bit is not included in the data extracted
\r
272 * by the reception API().
\r
273 * This masking operation is not carried out in the case of
\r
275 * @param __HANDLE__: specifies the UART Handle
\r
276 * @retval mask to apply to UART RDR register value.
\r
278 #define UART_MASK_COMPUTATION(__HANDLE__) \
\r
280 if ((__HANDLE__)->Init.WordLength == UART_WORDLENGTH_9B) \
\r
282 if ((__HANDLE__)->Init.Parity == UART_PARITY_NONE) \
\r
284 (__HANDLE__)->Mask = 0x01FF ; \
\r
288 (__HANDLE__)->Mask = 0x00FF ; \
\r
291 else if ((__HANDLE__)->Init.WordLength == UART_WORDLENGTH_8B) \
\r
293 if ((__HANDLE__)->Init.Parity == UART_PARITY_NONE) \
\r
295 (__HANDLE__)->Mask = 0x00FF ; \
\r
299 (__HANDLE__)->Mask = 0x007F ; \
\r
302 else if ((__HANDLE__)->Init.WordLength == UART_WORDLENGTH_7B) \
\r
304 if ((__HANDLE__)->Init.Parity == UART_PARITY_NONE) \
\r
306 (__HANDLE__)->Mask = 0x007F ; \
\r
310 (__HANDLE__)->Mask = 0x003F ; \
\r
319 /* Exported functions --------------------------------------------------------*/
\r
333 #endif /* __STM32F7xx_HAL_UART_EX_H */
\r
335 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
\r