?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Set blackbox file handler to NULL after closing file
[inav.git] / lib / main / STM32H7 / Drivers / STM32H7xx_HAL_Driver / Inc / stm32h7xx_hal_usart.h
blobc794031a637a8d4ce77e6494b2703d9a6ea6ccee
1 /**
2 ******************************************************************************
3 * @file stm32h7xx_hal_usart.h
4 * @author MCD Application Team
5 * @brief Header file of USART HAL module.
6 ******************************************************************************
7 * @attention
8 *
9 * <h2><center>&copy; Copyright (c) 2017 STMicroelectronics.
10 * All rights reserved.</center></h2>
11 *
12 * This software component is licensed by ST under BSD 3-Clause license,
13 * the "License"; You may not use this file except in compliance with the
14 * License. You may obtain a copy of the License at:
15 * opensource.org/licenses/BSD-3-Clause
16 *
17 ******************************************************************************
18 */
19
20 /* Define to prevent recursive inclusion -------------------------------------*/
21 #ifndef STM32H7xx_HAL_USART_H
22 #define STM32H7xx_HAL_USART_H
23
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27
28 /* Includes ------------------------------------------------------------------*/
29 #include "stm32h7xx_hal_def.h"
30
31 /** @addtogroup STM32H7xx_HAL_Driver
32 * @{
33 */
34
35 /** @addtogroup USART
36 * @{
37 */
38
39 /* Exported types ------------------------------------------------------------*/
40 /** @defgroup USART_Exported_Types USART Exported Types
41 * @{
42 */
43
44 /**
45 * @brief USART Init Structure definition
46 */
47 typedef struct
48 {
49 uint32_t BaudRate; /*!< This member configures the Usart communication baud rate.
50 The baud rate is computed using the following formula:
51 Baud Rate Register[15:4] = ((2 * fclk_pres) / ((huart->Init.BaudRate)))[15:4]
52 Baud Rate Register[3] = 0
53 Baud Rate Register[2:0] = (((2 * fclk_pres) / ((huart->Init.BaudRate)))[3:0]) >> 1
54 where fclk_pres is the USART input clock frequency (fclk) divided by a prescaler.
55 @note Oversampling by 8 is systematically applied to achieve high baud rates. */
56
57 uint32_t WordLength; /*!< Specifies the number of data bits transmitted or received in a frame.
58 This parameter can be a value of @ref USARTEx_Word_Length. */
59
60 uint32_t StopBits; /*!< Specifies the number of stop bits transmitted.
61 This parameter can be a value of @ref USART_Stop_Bits. */
62
63 uint32_t Parity; /*!< Specifies the parity mode.
64 This parameter can be a value of @ref USART_Parity
65 @note When parity is enabled, the computed parity is inserted
66 at the MSB position of the transmitted data (9th bit when
67 the word length is set to 9 data bits; 8th bit when the
68 word length is set to 8 data bits). */
69
70 uint32_t Mode; /*!< Specifies whether the Receive or Transmit mode is enabled or disabled.
71 This parameter can be a value of @ref USART_Mode. */
72
73 uint32_t CLKPolarity; /*!< Specifies the steady state of the serial clock.
74 This parameter can be a value of @ref USART_Clock_Polarity. */
75
76 uint32_t CLKPhase; /*!< Specifies the clock transition on which the bit capture is made.
77 This parameter can be a value of @ref USART_Clock_Phase. */
78
79 uint32_t CLKLastBit; /*!< Specifies whether the clock pulse corresponding to the last transmitted
80 data bit (MSB) has to be output on the SCLK pin in synchronous mode.
81 This parameter can be a value of @ref USART_Last_Bit. */
82
83 uint32_t ClockPrescaler; /*!< Specifies the prescaler value used to divide the USART clock source.
84 This parameter can be a value of @ref USART_ClockPrescaler. */
85 } USART_InitTypeDef;
86
87 /**
88 * @brief HAL USART State structures definition
89 */
90 typedef enum
91 {
92 HAL_USART_STATE_RESET = 0x00U, /*!< Peripheral is not initialized */
93 HAL_USART_STATE_READY = 0x01U, /*!< Peripheral Initialized and ready for use */
94 HAL_USART_STATE_BUSY = 0x02U, /*!< an internal process is ongoing */
95 HAL_USART_STATE_BUSY_TX = 0x12U, /*!< Data Transmission process is ongoing */
96 HAL_USART_STATE_BUSY_RX = 0x22U, /*!< Data Reception process is ongoing */
97 HAL_USART_STATE_BUSY_TX_RX = 0x32U, /*!< Data Transmission Reception process is ongoing */
98 HAL_USART_STATE_TIMEOUT = 0x03U, /*!< Timeout state */
99 HAL_USART_STATE_ERROR = 0x04U /*!< Error */
100 } HAL_USART_StateTypeDef;
101
102 /**
103 * @brief USART clock sources definitions
104 */
105 typedef enum
106 {
107 USART_CLOCKSOURCE_D2PCLK1 = 0x00U, /*!< Domain2 PCLK1 clock source */
108 USART_CLOCKSOURCE_D2PCLK2 = 0x01U, /*!< Domain2 PCLK2 clock source */
109 USART_CLOCKSOURCE_PLL2 = 0x02U, /*!< PLL2Q clock source */
110 USART_CLOCKSOURCE_PLL3 = 0x04U, /*!< PLL3Q clock source */
111 USART_CLOCKSOURCE_HSI = 0x08U, /*!< HSI clock source */
112 USART_CLOCKSOURCE_CSI = 0x10U, /*!< CSI clock source */
113 USART_CLOCKSOURCE_LSE = 0x20U, /*!< LSE clock source */
114 USART_CLOCKSOURCE_UNDEFINED = 0x40U /*!< Undefined clock source */
115 } USART_ClockSourceTypeDef;
116
117 /**
118 * @brief USART handle Structure definition
119 */
120 typedef struct __USART_HandleTypeDef
121 {
122 USART_TypeDef *Instance; /*!< USART registers base address */
123
124 USART_InitTypeDef Init; /*!< USART communication parameters */
125
126 uint8_t *pTxBuffPtr; /*!< Pointer to USART Tx transfer Buffer */
127
128 uint16_t TxXferSize; /*!< USART Tx Transfer size */
129
130 __IO uint16_t TxXferCount; /*!< USART Tx Transfer Counter */
131
132 uint8_t *pRxBuffPtr; /*!< Pointer to USART Rx transfer Buffer */
133
134 uint16_t RxXferSize; /*!< USART Rx Transfer size */
135
136 __IO uint16_t RxXferCount; /*!< USART Rx Transfer Counter */
137
138 uint16_t Mask; /*!< USART Rx RDR register mask */
139
140 uint16_t NbRxDataToProcess; /*!< Number of data to process during RX ISR execution */
141
142 uint16_t NbTxDataToProcess; /*!< Number of data to process during TX ISR execution */
143
144 uint32_t SlaveMode; /*!< Enable/Disable UART SPI Slave Mode. This parameter can be a value
145 of @ref USARTEx_Slave_Mode */
146
147 uint32_t FifoMode; /*!< Specifies if the FIFO mode will be used. This parameter can be a value
148 of @ref USARTEx_FIFO_mode. */
149
150 void (*RxISR)(struct __USART_HandleTypeDef *husart); /*!< Function pointer on Rx IRQ handler */
151
152 void (*TxISR)(struct __USART_HandleTypeDef *husart); /*!< Function pointer on Tx IRQ handler */
153
154 DMA_HandleTypeDef *hdmatx; /*!< USART Tx DMA Handle parameters */
155
156 DMA_HandleTypeDef *hdmarx; /*!< USART Rx DMA Handle parameters */
157
158 HAL_LockTypeDef Lock; /*!< Locking object */
159
160 __IO HAL_USART_StateTypeDef State; /*!< USART communication state */
161
162 __IO uint32_t ErrorCode; /*!< USART Error code */
163
164 #if (USE_HAL_USART_REGISTER_CALLBACKS == 1)
165 void (* TxHalfCpltCallback)(struct __USART_HandleTypeDef *husart); /*!< USART Tx Half Complete Callback */
166 void (* TxCpltCallback)(struct __USART_HandleTypeDef *husart); /*!< USART Tx Complete Callback */
167 void (* RxHalfCpltCallback)(struct __USART_HandleTypeDef *husart); /*!< USART Rx Half Complete Callback */
168 void (* RxCpltCallback)(struct __USART_HandleTypeDef *husart); /*!< USART Rx Complete Callback */
169 void (* TxRxCpltCallback)(struct __USART_HandleTypeDef *husart); /*!< USART Tx Rx Complete Callback */
170 void (* ErrorCallback)(struct __USART_HandleTypeDef *husart); /*!< USART Error Callback */
171 void (* AbortCpltCallback)(struct __USART_HandleTypeDef *husart); /*!< USART Abort Complete Callback */
172 void (* RxFifoFullCallback)(struct __USART_HandleTypeDef *husart); /*!< USART Rx Fifo Full Callback */
173 void (* TxFifoEmptyCallback)(struct __USART_HandleTypeDef *husart); /*!< USART Tx Fifo Empty Callback */
174
175 void (* MspInitCallback)(struct __USART_HandleTypeDef *husart); /*!< USART Msp Init callback */
176 void (* MspDeInitCallback)(struct __USART_HandleTypeDef *husart); /*!< USART Msp DeInit callback */
177 #endif /* USE_HAL_USART_REGISTER_CALLBACKS */
178
179 } USART_HandleTypeDef;
180
181 #if (USE_HAL_USART_REGISTER_CALLBACKS == 1)
182 /**
183 * @brief HAL USART Callback ID enumeration definition
184 */
185 typedef enum
186 {
187 HAL_USART_TX_HALFCOMPLETE_CB_ID = 0x00U, /*!< USART Tx Half Complete Callback ID */
188 HAL_USART_TX_COMPLETE_CB_ID = 0x01U, /*!< USART Tx Complete Callback ID */
189 HAL_USART_RX_HALFCOMPLETE_CB_ID = 0x02U, /*!< USART Rx Half Complete Callback ID */
190 HAL_USART_RX_COMPLETE_CB_ID = 0x03U, /*!< USART Rx Complete Callback ID */
191 HAL_USART_TX_RX_COMPLETE_CB_ID = 0x04U, /*!< USART Tx Rx Complete Callback ID */
192 HAL_USART_ERROR_CB_ID = 0x05U, /*!< USART Error Callback ID */
193 HAL_USART_ABORT_COMPLETE_CB_ID = 0x06U, /*!< USART Abort Complete Callback ID */
194 HAL_USART_RX_FIFO_FULL_CB_ID = 0x07U, /*!< USART Rx Fifo Full Callback ID */
195 HAL_USART_TX_FIFO_EMPTY_CB_ID = 0x08U, /*!< USART Tx Fifo Empty Callback ID */
196
197 HAL_USART_MSPINIT_CB_ID = 0x09U, /*!< USART MspInit callback ID */
198 HAL_USART_MSPDEINIT_CB_ID = 0x0AU /*!< USART MspDeInit callback ID */
199
200 } HAL_USART_CallbackIDTypeDef;
201
202 /**
203 * @brief HAL USART Callback pointer definition
204 */
205 typedef void (*pUSART_CallbackTypeDef)(USART_HandleTypeDef *husart); /*!< pointer to an USART callback function */
206
207 #endif /* USE_HAL_USART_REGISTER_CALLBACKS */
208
209 /**
210 * @}
211 */
212
213 /* Exported constants --------------------------------------------------------*/
214 /** @defgroup USART_Exported_Constants USART Exported Constants
215 * @{
216 */
217
218 /** @defgroup USART_Error_Definition USART Error Definition
219 * @{
220 */
221 #define HAL_USART_ERROR_NONE ((uint32_t)0x00000000U) /*!< No error */
222 #define HAL_USART_ERROR_PE ((uint32_t)0x00000001U) /*!< Parity error */
223 #define HAL_USART_ERROR_NE ((uint32_t)0x00000002U) /*!< Noise error */
224 #define HAL_USART_ERROR_FE ((uint32_t)0x00000004U) /*!< Frame error */
225 #define HAL_USART_ERROR_ORE ((uint32_t)0x00000008U) /*!< Overrun error */
226 #define HAL_USART_ERROR_DMA ((uint32_t)0x00000010U) /*!< DMA transfer error */
227 #define HAL_USART_ERROR_UDR ((uint32_t)0x00000020U) /*!< SPI slave underrun error */
228 #if (USE_HAL_USART_REGISTER_CALLBACKS == 1)
229 #define HAL_USART_ERROR_INVALID_CALLBACK ((uint32_t)0x00000040U) /*!< Invalid Callback error */
230 #endif /* USE_HAL_USART_REGISTER_CALLBACKS */
231 /**
232 * @}
233 */
234
235 /** @defgroup USART_Stop_Bits USART Number of Stop Bits
236 * @{
237 */
238 #define USART_STOPBITS_0_5 USART_CR2_STOP_0 /*!< USART frame with 0.5 stop bit */
239 #define USART_STOPBITS_1 0x00000000U /*!< USART frame with 1 stop bit */
240 #define USART_STOPBITS_1_5 (USART_CR2_STOP_0 | USART_CR2_STOP_1) /*!< USART frame with 1.5 stop bits */
241 #define USART_STOPBITS_2 USART_CR2_STOP_1 /*!< USART frame with 2 stop bits */
242 /**
243 * @}
244 */
245
246 /** @defgroup USART_Parity USART Parity
247 * @{
248 */
249 #define USART_PARITY_NONE 0x00000000U /*!< No parity */
250 #define USART_PARITY_EVEN USART_CR1_PCE /*!< Even parity */
251 #define USART_PARITY_ODD (USART_CR1_PCE | USART_CR1_PS) /*!< Odd parity */
252 /**
253 * @}
254 */
255
256 /** @defgroup USART_Mode USART Mode
257 * @{
258 */
259 #define USART_MODE_RX USART_CR1_RE /*!< RX mode */
260 #define USART_MODE_TX USART_CR1_TE /*!< TX mode */
261 #define USART_MODE_TX_RX (USART_CR1_TE |USART_CR1_RE) /*!< RX and TX mode */
262 /**
263 * @}
264 */
265
266 /** @defgroup USART_Over_Sampling USART Over Sampling
267 * @{
268 */
269 #define USART_OVERSAMPLING_16 0x00000000U /*!< Oversampling by 16 */
270 #define USART_OVERSAMPLING_8 USART_CR1_OVER8 /*!< Oversampling by 8 */
271 /**
272 * @}
273 */
274
275 /** @defgroup USART_Clock USART Clock
276 * @{
277 */
278 #define USART_CLOCK_DISABLE 0x00000000U /*!< USART clock disable */
279 #define USART_CLOCK_ENABLE USART_CR2_CLKEN /*!< USART clock enable */
280 /**
281 * @}
282 */
283
284 /** @defgroup USART_Clock_Polarity USART Clock Polarity
285 * @{
286 */
287 #define USART_POLARITY_LOW 0x00000000U /*!< Driver enable signal is active high */
288 #define USART_POLARITY_HIGH USART_CR2_CPOL /*!< Driver enable signal is active low */
289 /**
290 * @}
291 */
292
293 /** @defgroup USART_Clock_Phase USART Clock Phase
294 * @{
295 */
296 #define USART_PHASE_1EDGE 0x00000000U /*!< USART frame phase on first clock transition */
297 #define USART_PHASE_2EDGE USART_CR2_CPHA /*!< USART frame phase on second clock transition */
298 /**
299 * @}
300 */
301
302 /** @defgroup USART_Last_Bit USART Last Bit
303 * @{
304 */
305 #define USART_LASTBIT_DISABLE 0x00000000U /*!< USART frame last data bit clock pulse not output to SCLK pin */
306 #define USART_LASTBIT_ENABLE USART_CR2_LBCL /*!< USART frame last data bit clock pulse output to SCLK pin */
307 /**
308 * @}
309 */
310
311 /** @defgroup USART_ClockPrescaler USART Clock Prescaler
312 * @{
313 */
314 #define USART_PRESCALER_DIV1 0x00000000U /*!< fclk_pres = fclk */
315 #define USART_PRESCALER_DIV2 0x00000001U /*!< fclk_pres = fclk/2 */
316 #define USART_PRESCALER_DIV4 0x00000002U /*!< fclk_pres = fclk/4 */
317 #define USART_PRESCALER_DIV6 0x00000003U /*!< fclk_pres = fclk/6 */
318 #define USART_PRESCALER_DIV8 0x00000004U /*!< fclk_pres = fclk/8 */
319 #define USART_PRESCALER_DIV10 0x00000005U /*!< fclk_pres = fclk/10 */
320 #define USART_PRESCALER_DIV12 0x00000006U /*!< fclk_pres = fclk/12 */
321 #define USART_PRESCALER_DIV16 0x00000007U /*!< fclk_pres = fclk/16 */
322 #define USART_PRESCALER_DIV32 0x00000008U /*!< fclk_pres = fclk/32 */
323 #define USART_PRESCALER_DIV64 0x00000009U /*!< fclk_pres = fclk/64 */
324 #define USART_PRESCALER_DIV128 0x0000000AU /*!< fclk_pres = fclk/128 */
325 #define USART_PRESCALER_DIV256 0x0000000BU /*!< fclk_pres = fclk/256 */
326
327 /**
328 * @}
329 */
330
331 /** @defgroup USART_Request_Parameters USART Request Parameters
332 * @{
333 */
334 #define USART_RXDATA_FLUSH_REQUEST USART_RQR_RXFRQ /*!< Receive Data flush Request */
335 #define USART_TXDATA_FLUSH_REQUEST USART_RQR_TXFRQ /*!< Transmit data flush Request */
336 /**
337 * @}
338 */
339
340 /** @defgroup USART_Flags USART Flags
341 * Elements values convention: 0xXXXX
342 * - 0xXXXX : Flag mask in the ISR register
343 * @{
344 */
345 #define USART_FLAG_TXFT USART_ISR_TXFT /*!< USART TXFIFO threshold flag */
346 #define USART_FLAG_RXFT USART_ISR_RXFT /*!< USART RXFIFO threshold flag */
347 #define USART_FLAG_RXFF USART_ISR_RXFF /*!< USART RXFIFO Full flag */
348 #define USART_FLAG_TXFE USART_ISR_TXFE /*!< USART TXFIFO Empty flag */
349 #define USART_FLAG_REACK USART_ISR_REACK /*!< USART receive enable acknowledge flag */
350 #define USART_FLAG_TEACK USART_ISR_TEACK /*!< USART transmit enable acknowledge flag */
351 #define USART_FLAG_BUSY USART_ISR_BUSY /*!< USART busy flag */
352 #define USART_FLAG_UDR USART_ISR_UDR /*!< SPI slave underrun error flag */
353 #define USART_FLAG_TXE USART_ISR_TXE_TXFNF /*!< USART transmit data register empty */
354 #define USART_FLAG_TXFNF USART_ISR_TXE_TXFNF /*!< USART TXFIFO not full */
355 #define USART_FLAG_TC USART_ISR_TC /*!< USART transmission complete */
356 #define USART_FLAG_RXNE USART_ISR_RXNE_RXFNE /*!< USART read data register not empty */
357 #define USART_FLAG_RXFNE USART_ISR_RXNE_RXFNE /*!< USART RXFIFO not empty */
358 #define USART_FLAG_IDLE USART_ISR_IDLE /*!< USART idle flag */
359 #define USART_FLAG_ORE USART_ISR_ORE /*!< USART overrun error */
360 #define USART_FLAG_NE USART_ISR_NE /*!< USART noise error */
361 #define USART_FLAG_FE USART_ISR_FE /*!< USART frame error */
362 #define USART_FLAG_PE USART_ISR_PE /*!< USART parity error */
363 /**
364 * @}
365 */
366
367 /** @defgroup USART_Interrupt_definition USART Interrupts Definition
368 * Elements values convention: 0000ZZZZ0XXYYYYYb
369 * - YYYYY : Interrupt source position in the XX register (5bits)
370 * - XX : Interrupt source register (2bits)
371 * - 01: CR1 register
372 * - 10: CR2 register
373 * - 11: CR3 register
374 * - ZZZZ : Flag position in the ISR register(4bits)
375 * @{
376 */
377
378 #define USART_IT_PE 0x0028U /*!< USART parity error interruption */
379 #define USART_IT_TXE 0x0727U /*!< USART transmit data register empty interruption */
380 #define USART_IT_TXFNF 0x0727U /*!< USART TX FIFO not full interruption */
381 #define USART_IT_TC 0x0626U /*!< USART transmission complete interruption */
382 #define USART_IT_RXNE 0x0525U /*!< USART read data register not empty interruption */
383 #define USART_IT_RXFNE 0x0525U /*!< USART RXFIFO not empty interruption */
384 #define USART_IT_IDLE 0x0424U /*!< USART idle interruption */
385 #define USART_IT_ERR 0x0060U /*!< USART error interruption */
386 #define USART_IT_ORE 0x0300U /*!< USART overrun error interruption */
387 #define USART_IT_NE 0x0200U /*!< USART noise error interruption */
388 #define USART_IT_FE 0x0100U /*!< USART frame error interruption */
389 #define USART_IT_RXFF 0x183FU /*!< USART RXFIFO full interruption */
390 #define USART_IT_TXFE 0x173EU /*!< USART TXFIFO empty interruption */
391 #define USART_IT_RXFT 0x1A7CU /*!< USART RXFIFO threshold reached interruption */
392 #define USART_IT_TXFT 0x1B77U /*!< USART TXFIFO threshold reached interruption */
393
394 /**
395 * @}
396 */
397
398 /** @defgroup USART_IT_CLEAR_Flags USART Interruption Clear Flags
399 * @{
400 */
401 #define USART_CLEAR_PEF USART_ICR_PECF /*!< Parity Error Clear Flag */
402 #define USART_CLEAR_FEF USART_ICR_FECF /*!< Framing Error Clear Flag */
403 #define USART_CLEAR_NEF USART_ICR_NECF /*!< Noise Error detected Clear Flag */
404 #define USART_CLEAR_OREF USART_ICR_ORECF /*!< OverRun Error Clear Flag */
405 #define USART_CLEAR_IDLEF USART_ICR_IDLECF /*!< IDLE line detected Clear Flag */
406 #define USART_CLEAR_TCF USART_ICR_TCCF /*!< Transmission Complete Clear Flag */
407 #define USART_CLEAR_UDRF USART_ICR_UDRCF /*!< SPI slave underrun error Clear Flag */
408 #define USART_CLEAR_TXFECF USART_ICR_TXFECF /*!< TXFIFO Empty Clear Flag */
409 /**
410 * @}
411 */
412
413 /** @defgroup USART_Interruption_Mask USART Interruption Flags Mask
414 * @{
415 */
416 #define USART_IT_MASK 0x001FU /*!< USART interruptions flags mask */
417 #define USART_CR_MASK 0x00E0U /*!< USART control register mask */
418 #define USART_CR_POS 5U /*!< USART control register position */
419 #define USART_ISR_MASK 0x1F00U /*!< USART ISR register mask */
420 #define USART_ISR_POS 8U /*!< USART ISR register position */
421 /**
422 * @}
423 */
424
425 /**
426 * @}
427 */
428
429 /* Exported macros -----------------------------------------------------------*/
430 /** @defgroup USART_Exported_Macros USART Exported Macros
431 * @{
432 */
433
434 /** @brief Reset USART handle state.
435 * @param __HANDLE__ USART handle.
436 * @retval None
437 */
438 #if (USE_HAL_USART_REGISTER_CALLBACKS == 1)
439 #define __HAL_USART_RESET_HANDLE_STATE(__HANDLE__) do{ \
440 (__HANDLE__)->State = HAL_USART_STATE_RESET; \
441 (__HANDLE__)->MspInitCallback = NULL; \
442 (__HANDLE__)->MspDeInitCallback = NULL; \
443 } while(0U)
444 #else
445 #define __HAL_USART_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_USART_STATE_RESET)
446 #endif /* USE_HAL_USART_REGISTER_CALLBACKS */
447
448 /** @brief Check whether the specified USART flag is set or not.
449 * @param __HANDLE__ specifies the USART Handle
450 * @param __FLAG__ specifies the flag to check.
451 * This parameter can be one of the following values:
452 * @arg @ref USART_FLAG_TXFT TXFIFO threshold flag
453 * @arg @ref USART_FLAG_RXFT RXFIFO threshold flag
454 * @arg @ref USART_FLAG_RXFF RXFIFO Full flag
455 * @arg @ref USART_FLAG_TXFE TXFIFO Empty flag
456 * @arg @ref USART_FLAG_REACK Receive enable acknowledge flag
457 * @arg @ref USART_FLAG_TEACK Transmit enable acknowledge flag
458 * @arg @ref USART_FLAG_BUSY Busy flag
459 * @arg @ref USART_FLAG_UDR SPI slave underrun error flag
460 * @arg @ref USART_FLAG_TXE Transmit data register empty flag
461 * @arg @ref USART_FLAG_TXFNF TXFIFO not full flag
462 * @arg @ref USART_FLAG_TC Transmission Complete flag
463 * @arg @ref USART_FLAG_RXNE Receive data register not empty flag
464 * @arg @ref USART_FLAG_RXFNE RXFIFO not empty flag
465 * @arg @ref USART_FLAG_IDLE Idle Line detection flag
466 * @arg @ref USART_FLAG_ORE OverRun Error flag
467 * @arg @ref USART_FLAG_NE Noise Error flag
468 * @arg @ref USART_FLAG_FE Framing Error flag
469 * @arg @ref USART_FLAG_PE Parity Error flag
470 * @retval The new state of __FLAG__ (TRUE or FALSE).
471 */
472 #define __HAL_USART_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->ISR & (__FLAG__)) == (__FLAG__))
473
474 /** @brief Clear the specified USART pending flag.
475 * @param __HANDLE__ specifies the USART Handle.
476 * @param __FLAG__ specifies the flag to check.
477 * This parameter can be any combination of the following values:
478 * @arg @ref USART_CLEAR_PEF Parity Error Clear Flag
479 * @arg @ref USART_CLEAR_FEF Framing Error Clear Flag
480 * @arg @ref USART_CLEAR_NEF Noise detected Clear Flag
481 * @arg @ref USART_CLEAR_OREF Overrun Error Clear Flag
482 * @arg @ref USART_CLEAR_IDLEF IDLE line detected Clear Flag
483 * @arg @ref USART_CLEAR_TXFECF TXFIFO empty clear Flag
484 * @arg @ref USART_CLEAR_TCF Transmission Complete Clear Flag
485 * @arg @ref USART_CLEAR_UDRF SPI slave underrun error Clear Flag
486 * @retval None
487 */
488 #define __HAL_USART_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__))
489
490 /** @brief Clear the USART PE pending flag.
491 * @param __HANDLE__ specifies the USART Handle.
492 * @retval None
493 */
494 #define __HAL_USART_CLEAR_PEFLAG(__HANDLE__) __HAL_USART_CLEAR_FLAG((__HANDLE__), USART_CLEAR_PEF)
495
496 /** @brief Clear the USART FE pending flag.
497 * @param __HANDLE__ specifies the USART Handle.
498 * @retval None
499 */
500 #define __HAL_USART_CLEAR_FEFLAG(__HANDLE__) __HAL_USART_CLEAR_FLAG((__HANDLE__), USART_CLEAR_FEF)
501
502 /** @brief Clear the USART NE pending flag.
503 * @param __HANDLE__ specifies the USART Handle.
504 * @retval None
505 */
506 #define __HAL_USART_CLEAR_NEFLAG(__HANDLE__) __HAL_USART_CLEAR_FLAG((__HANDLE__), USART_CLEAR_NEF)
507
508 /** @brief Clear the USART ORE pending flag.
509 * @param __HANDLE__ specifies the USART Handle.
510 * @retval None
511 */
512 #define __HAL_USART_CLEAR_OREFLAG(__HANDLE__) __HAL_USART_CLEAR_FLAG((__HANDLE__), USART_CLEAR_OREF)
513
514 /** @brief Clear the USART IDLE pending flag.
515 * @param __HANDLE__ specifies the USART Handle.
516 * @retval None
517 */
518 #define __HAL_USART_CLEAR_IDLEFLAG(__HANDLE__) __HAL_USART_CLEAR_FLAG((__HANDLE__), USART_CLEAR_IDLEF)
519
520 /** @brief Clear the USART TX FIFO empty clear flag.
521 * @param __HANDLE__ specifies the USART Handle.
522 * @retval None
523 */
524 #define __HAL_USART_CLEAR_TXFECF(__HANDLE__) __HAL_USART_CLEAR_FLAG((__HANDLE__), USART_CLEAR_TXFECF)
525
526 /** @brief Clear SPI slave underrun error flag.
527 * @param __HANDLE__ specifies the USART Handle.
528 * @retval None
529 */
530 #define __HAL_USART_CLEAR_UDRFLAG(__HANDLE__) __HAL_USART_CLEAR_FLAG((__HANDLE__), USART_CLEAR_UDRF)
531
532 /** @brief Enable the specified USART interrupt.
533 * @param __HANDLE__ specifies the USART Handle.
534 * @param __INTERRUPT__ specifies the USART interrupt source to enable.
535 * This parameter can be one of the following values:
536 * @arg @ref USART_IT_RXFF RXFIFO Full interrupt
537 * @arg @ref USART_IT_TXFE TXFIFO Empty interrupt
538 * @arg @ref USART_IT_RXFT RXFIFO threshold interrupt
539 * @arg @ref USART_IT_TXFT TXFIFO threshold interrupt
540 * @arg @ref USART_IT_TXE Transmit Data Register empty interrupt
541 * @arg @ref USART_IT_TXFNF TX FIFO not full interrupt
542 * @arg @ref USART_IT_TC Transmission complete interrupt
543 * @arg @ref USART_IT_RXNE Receive Data register not empty interrupt
544 * @arg @ref USART_IT_RXFNE RXFIFO not empty interrupt
545 * @arg @ref USART_IT_IDLE Idle line detection interrupt
546 * @arg @ref USART_IT_PE Parity Error interrupt
547 * @arg @ref USART_IT_ERR Error interrupt(Frame error, noise error, overrun error)
548 * @retval None
549 */
550 #define __HAL_USART_ENABLE_IT(__HANDLE__, __INTERRUPT__) (((((__INTERRUPT__) & USART_CR_MASK) >> USART_CR_POS) == 1U)? ((__HANDLE__)->Instance->CR1 |= ((uint32_t)1U << ((__INTERRUPT__) & USART_IT_MASK))): \
551 ((((__INTERRUPT__) & USART_CR_MASK) >> USART_CR_POS) == 2U)? ((__HANDLE__)->Instance->CR2 |= ((uint32_t)1U << ((__INTERRUPT__) & USART_IT_MASK))): \
552 ((__HANDLE__)->Instance->CR3 |= ((uint32_t)1U << ((__INTERRUPT__) & USART_IT_MASK))))
553
554 /** @brief Disable the specified USART interrupt.
555 * @param __HANDLE__ specifies the USART Handle.
556 * @param __INTERRUPT__ specifies the USART interrupt source to disable.
557 * This parameter can be one of the following values:
558 * @arg @ref USART_IT_RXFF RXFIFO Full interrupt
559 * @arg @ref USART_IT_TXFE TXFIFO Empty interrupt
560 * @arg @ref USART_IT_RXFT RXFIFO threshold interrupt
561 * @arg @ref USART_IT_TXFT TXFIFO threshold interrupt
562 * @arg @ref USART_IT_TXE Transmit Data Register empty interrupt
563 * @arg @ref USART_IT_TXFNF TX FIFO not full interrupt
564 * @arg @ref USART_IT_TC Transmission complete interrupt
565 * @arg @ref USART_IT_RXNE Receive Data register not empty interrupt
566 * @arg @ref USART_IT_RXFNE RXFIFO not empty interrupt
567 * @arg @ref USART_IT_IDLE Idle line detection interrupt
568 * @arg @ref USART_IT_PE Parity Error interrupt
569 * @arg @ref USART_IT_ERR Error interrupt(Frame error, noise error, overrun error)
570 * @retval None
571 */
572 #define __HAL_USART_DISABLE_IT(__HANDLE__, __INTERRUPT__) (((((__INTERRUPT__) & USART_CR_MASK) >> USART_CR_POS) == 1U)? ((__HANDLE__)->Instance->CR1 &= ~ ((uint32_t)1U << ((__INTERRUPT__) & USART_IT_MASK))): \
573 ((((__INTERRUPT__) & USART_CR_MASK) >> USART_CR_POS) == 2U)? ((__HANDLE__)->Instance->CR2 &= ~ ((uint32_t)1U << ((__INTERRUPT__) & USART_IT_MASK))): \
574 ((__HANDLE__)->Instance->CR3 &= ~ ((uint32_t)1U << ((__INTERRUPT__) & USART_IT_MASK))))
575
576
577 /** @brief Check whether the specified USART interrupt has occurred or not.
578 * @param __HANDLE__ specifies the USART Handle.
579 * @param __INTERRUPT__ specifies the USART interrupt source to check.
580 * This parameter can be one of the following values:
581 * @arg @ref USART_IT_RXFF RXFIFO Full interrupt
582 * @arg @ref USART_IT_TXFE TXFIFO Empty interrupt
583 * @arg @ref USART_IT_RXFT RXFIFO threshold interrupt
584 * @arg @ref USART_IT_TXFT TXFIFO threshold interrupt
585 * @arg @ref USART_IT_TXE Transmit Data Register empty interrupt
586 * @arg @ref USART_IT_TXFNF TX FIFO not full interrupt
587 * @arg @ref USART_IT_TC Transmission complete interrupt
588 * @arg @ref USART_IT_RXNE Receive Data register not empty interrupt
589 * @arg @ref USART_IT_RXFNE RXFIFO not empty interrupt
590 * @arg @ref USART_IT_IDLE Idle line detection interrupt
591 * @arg @ref USART_IT_ORE OverRun Error interrupt
592 * @arg @ref USART_IT_NE Noise Error interrupt
593 * @arg @ref USART_IT_FE Framing Error interrupt
594 * @arg @ref USART_IT_PE Parity Error interrupt
595 * @retval The new state of __INTERRUPT__ (SET or RESET).
596 */
597 #define __HAL_USART_GET_IT(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->ISR\
598 & ((uint32_t)0x01U << (((__INTERRUPT__) & USART_ISR_MASK)>> USART_ISR_POS))) != 0U) ? SET : RESET)
599
600 /** @brief Check whether the specified USART interrupt source is enabled or not.
601 * @param __HANDLE__ specifies the USART Handle.
602 * @param __INTERRUPT__ specifies the USART interrupt source to check.
603 * This parameter can be one of the following values:
604 * @arg @ref USART_IT_RXFF RXFIFO Full interrupt
605 * @arg @ref USART_IT_TXFE TXFIFO Empty interrupt
606 * @arg @ref USART_IT_RXFT RXFIFO threshold interrupt
607 * @arg @ref USART_IT_TXFT TXFIFO threshold interrupt
608 * @arg @ref USART_IT_TXE Transmit Data Register empty interrupt
609 * @arg @ref USART_IT_TXFNF TX FIFO not full interrupt
610 * @arg @ref USART_IT_TC Transmission complete interrupt
611 * @arg @ref USART_IT_RXNE Receive Data register not empty interrupt
612 * @arg @ref USART_IT_RXFNE RXFIFO not empty interrupt
613 * @arg @ref USART_IT_IDLE Idle line detection interrupt
614 * @arg @ref USART_IT_ORE OverRun Error interrupt
615 * @arg @ref USART_IT_NE Noise Error interrupt
616 * @arg @ref USART_IT_FE Framing Error interrupt
617 * @arg @ref USART_IT_PE Parity Error interrupt
618 * @retval The new state of __INTERRUPT__ (SET or RESET).
619 */
620 #define __HAL_USART_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((((((uint8_t)(__INTERRUPT__)) >> 0x05U) == 0x01U) ? (__HANDLE__)->Instance->CR1 : \
621 (((((uint8_t)(__INTERRUPT__)) >> 0x05U) == 0x02U) ? (__HANDLE__)->Instance->CR2 : \
622 (__HANDLE__)->Instance->CR3)) & (0x01U << (((uint16_t)(__INTERRUPT__)) & USART_IT_MASK))) != 0U) ? SET : RESET)
623
624
625 /** @brief Clear the specified USART ISR flag, in setting the proper ICR register flag.
626 * @param __HANDLE__ specifies the USART Handle.
627 * @param __IT_CLEAR__ specifies the interrupt clear register flag that needs to be set
628 * to clear the corresponding interrupt.
629 * This parameter can be one of the following values:
630 * @arg @ref USART_CLEAR_PEF Parity Error Clear Flag
631 * @arg @ref USART_CLEAR_FEF Framing Error Clear Flag
632 * @arg @ref USART_CLEAR_NEF Noise detected Clear Flag
633 * @arg @ref USART_CLEAR_OREF Overrun Error Clear Flag
634 * @arg @ref USART_CLEAR_IDLEF IDLE line detected Clear Flag
635 * @arg @ref USART_CLEAR_TXFECF TXFIFO empty clear Flag
636 * @arg @ref USART_CLEAR_TCF Transmission Complete Clear Flag
637 * @retval None
638 */
639 #define __HAL_USART_CLEAR_IT(__HANDLE__, __IT_CLEAR__) ((__HANDLE__)->Instance->ICR = (uint32_t)(__IT_CLEAR__))
640
641 /** @brief Set a specific USART request flag.
642 * @param __HANDLE__ specifies the USART Handle.
643 * @param __REQ__ specifies the request flag to set.
644 * This parameter can be one of the following values:
645 * @arg @ref USART_RXDATA_FLUSH_REQUEST Receive Data flush Request
646 * @arg @ref USART_TXDATA_FLUSH_REQUEST Transmit data flush Request
647 *
648 * @retval None
649 */
650 #define __HAL_USART_SEND_REQ(__HANDLE__, __REQ__) ((__HANDLE__)->Instance->RQR |= (uint16_t)(__REQ__))
651
652 /** @brief Enable the USART one bit sample method.
653 * @param __HANDLE__ specifies the USART Handle.
654 * @retval None
655 */
656 #define __HAL_USART_ONE_BIT_SAMPLE_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3|= USART_CR3_ONEBIT)
657
658 /** @brief Disable the USART one bit sample method.
659 * @param __HANDLE__ specifies the USART Handle.
660 * @retval None
661 */
662 #define __HAL_USART_ONE_BIT_SAMPLE_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3 &= ~USART_CR3_ONEBIT)
663
664 /** @brief Enable USART.
665 * @param __HANDLE__ specifies the USART Handle.
666 * @retval None
667 */
668 #define __HAL_USART_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 |= USART_CR1_UE)
669
670 /** @brief Disable USART.
671 * @param __HANDLE__ specifies the USART Handle.
672 * @retval None
673 */
674 #define __HAL_USART_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE)
675
676 /**
677 * @}
678 */
679
680 /* Private macros --------------------------------------------------------*/
681 /** @defgroup USART_Private_Macros USART Private Macros
682 * @{
683 */
684
685 /** @brief Get USART clock division factor from clock prescaler value.
686 * @param __CLOCKPRESCALER__ USART prescaler value.
687 * @retval USART clock division factor
688 */
689 #define USART_GET_DIV_FACTOR(__CLOCKPRESCALER__) \
690 (((__CLOCKPRESCALER__) == USART_PRESCALER_DIV1) ? 1U : \
691 ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV2) ? 2U : \
692 ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV4) ? 4U : \
693 ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV6) ? 6U : \
694 ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV8) ? 8U : \
695 ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV10) ? 10U : \
696 ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV12) ? 12U : \
697 ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV16) ? 16U : \
698 ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV32) ? 32U : \
699 ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV64) ? 64U : \
700 ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV128) ? 128U : \
701 ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV256) ? 256U : 1U)
702
703 /** @brief BRR division operation to set BRR register in 8-bit oversampling mode.
704 * @param __PCLK__ USART clock.
705 * @param __BAUD__ Baud rate set by the user.
706 * @param __CLOCKPRESCALER__ UART prescaler value.
707 * @retval Division result
708 */
709 #define USART_DIV_SAMPLING8(__PCLK__, __BAUD__, __CLOCKPRESCALER__) (((((__PCLK__)/USART_GET_DIV_FACTOR(__CLOCKPRESCALER__))*2U)\
710 + ((__BAUD__)/2U)) / (__BAUD__))
711
712 /** @brief Report the USART clock source.
713 * @param __HANDLE__ specifies the USART Handle.
714 * @param __CLOCKSOURCE__ output variable.
715 * @retval the USART clocking source, written in __CLOCKSOURCE__.
716 */
717 #if defined(UART9) && defined(USART10)
718 #define USART_GETCLOCKSOURCE(__HANDLE__,__CLOCKSOURCE__) \
719 do { \
720 if((__HANDLE__)->Instance == USART1) \
721 { \
722 switch(__HAL_RCC_GET_USART1_SOURCE()) \
723 { \
724 case RCC_USART1CLKSOURCE_D2PCLK2: \
725 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_D2PCLK2; \
726 break; \
727 case RCC_USART1CLKSOURCE_PLL2: \
728 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_PLL2; \
729 break; \
730 case RCC_USART1CLKSOURCE_PLL3: \
731 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_PLL3; \
732 break; \
733 case RCC_USART1CLKSOURCE_HSI: \
734 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_HSI; \
735 break; \
736 case RCC_USART1CLKSOURCE_CSI: \
737 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_CSI; \
738 break; \
739 case RCC_USART1CLKSOURCE_LSE: \
740 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_LSE; \
741 break; \
742 default: \
743 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_UNDEFINED; \
744 break; \
745 } \
746 } \
747 else if((__HANDLE__)->Instance == USART2) \
748 { \
749 switch(__HAL_RCC_GET_USART2_SOURCE()) \
750 { \
751 case RCC_USART2CLKSOURCE_D2PCLK1: \
752 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_D2PCLK1; \
753 break; \
754 case RCC_USART2CLKSOURCE_PLL2: \
755 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_PLL2; \
756 break; \
757 case RCC_USART2CLKSOURCE_PLL3: \
758 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_PLL3; \
759 break; \
760 case RCC_USART2CLKSOURCE_HSI: \
761 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_HSI; \
762 break; \
763 case RCC_USART2CLKSOURCE_CSI: \
764 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_CSI; \
765 break; \
766 case RCC_USART2CLKSOURCE_LSE: \
767 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_LSE; \
768 break; \
769 default: \
770 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_UNDEFINED; \
771 break; \
772 } \
773 } \
774 else if((__HANDLE__)->Instance == USART3) \
775 { \
776 switch(__HAL_RCC_GET_USART3_SOURCE()) \
777 { \
778 case RCC_USART3CLKSOURCE_D2PCLK1: \
779 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_D2PCLK1; \
780 break; \
781 case RCC_USART3CLKSOURCE_PLL2: \
782 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_PLL2; \
783 break; \
784 case RCC_USART3CLKSOURCE_PLL3: \
785 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_PLL3; \
786 break; \
787 case RCC_USART3CLKSOURCE_HSI: \
788 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_HSI; \
789 break; \
790 case RCC_USART3CLKSOURCE_CSI: \
791 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_CSI; \
792 break; \
793 case RCC_USART3CLKSOURCE_LSE: \
794 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_LSE; \
795 break; \
796 default: \
797 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_UNDEFINED; \
798 break; \
799 } \
800 } \
801 else if((__HANDLE__)->Instance == USART6) \
802 { \
803 switch(__HAL_RCC_GET_USART6_SOURCE()) \
804 { \
805 case RCC_USART6CLKSOURCE_D2PCLK2: \
806 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_D2PCLK2; \
807 break; \
808 case RCC_USART6CLKSOURCE_PLL2: \
809 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_PLL2; \
810 break; \
811 case RCC_USART6CLKSOURCE_PLL3: \
812 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_PLL3; \
813 break; \
814 case RCC_USART6CLKSOURCE_HSI: \
815 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_HSI; \
816 break; \
817 case RCC_USART6CLKSOURCE_CSI: \
818 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_CSI; \
819 break; \
820 case RCC_USART6CLKSOURCE_LSE: \
821 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_LSE; \
822 break; \
823 default: \
824 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_UNDEFINED; \
825 break; \
826 } \
827 } \
828 else if((__HANDLE__)->Instance == USART10) \
829 { \
830 switch(__HAL_RCC_GET_USART10_SOURCE()) \
831 { \
832 case RCC_USART10CLKSOURCE_D2PCLK2: \
833 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_D2PCLK2; \
834 break; \
835 case RCC_USART10CLKSOURCE_PLL2: \
836 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_PLL2; \
837 break; \
838 case RCC_USART10CLKSOURCE_PLL3: \
839 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_PLL3; \
840 break; \
841 case RCC_USART10CLKSOURCE_HSI: \
842 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_HSI; \
843 break; \
844 case RCC_USART10CLKSOURCE_CSI: \
845 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_CSI; \
846 break; \
847 case RCC_USART10CLKSOURCE_LSE: \
848 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_LSE; \
849 break; \
850 default: \
851 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_UNDEFINED; \
852 break; \
853 } \
854 } \
855 else \
856 { \
857 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_UNDEFINED; \
858 } \
859 } while(0U)
860 #else
861 #define USART_GETCLOCKSOURCE(__HANDLE__,__CLOCKSOURCE__) \
862 do { \
863 if((__HANDLE__)->Instance == USART1) \
864 { \
865 switch(__HAL_RCC_GET_USART1_SOURCE()) \
866 { \
867 case RCC_USART1CLKSOURCE_D2PCLK2: \
868 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_D2PCLK2; \
869 break; \
870 case RCC_USART1CLKSOURCE_PLL2: \
871 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_PLL2; \
872 break; \
873 case RCC_USART1CLKSOURCE_PLL3: \
874 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_PLL3; \
875 break; \
876 case RCC_USART1CLKSOURCE_HSI: \
877 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_HSI; \
878 break; \
879 case RCC_USART1CLKSOURCE_CSI: \
880 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_CSI; \
881 break; \
882 case RCC_USART1CLKSOURCE_LSE: \
883 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_LSE; \
884 break; \
885 default: \
886 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_UNDEFINED; \
887 break; \
888 } \
889 } \
890 else if((__HANDLE__)->Instance == USART2) \
891 { \
892 switch(__HAL_RCC_GET_USART2_SOURCE()) \
893 { \
894 case RCC_USART2CLKSOURCE_D2PCLK1: \
895 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_D2PCLK1; \
896 break; \
897 case RCC_USART2CLKSOURCE_PLL2: \
898 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_PLL2; \
899 break; \
900 case RCC_USART2CLKSOURCE_PLL3: \
901 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_PLL3; \
902 break; \
903 case RCC_USART2CLKSOURCE_HSI: \
904 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_HSI; \
905 break; \
906 case RCC_USART2CLKSOURCE_CSI: \
907 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_CSI; \
908 break; \
909 case RCC_USART2CLKSOURCE_LSE: \
910 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_LSE; \
911 break; \
912 default: \
913 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_UNDEFINED; \
914 break; \
915 } \
916 } \
917 else if((__HANDLE__)->Instance == USART3) \
918 { \
919 switch(__HAL_RCC_GET_USART3_SOURCE()) \
920 { \
921 case RCC_USART3CLKSOURCE_D2PCLK1: \
922 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_D2PCLK1; \
923 break; \
924 case RCC_USART3CLKSOURCE_PLL2: \
925 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_PLL2; \
926 break; \
927 case RCC_USART3CLKSOURCE_PLL3: \
928 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_PLL3; \
929 break; \
930 case RCC_USART3CLKSOURCE_HSI: \
931 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_HSI; \
932 break; \
933 case RCC_USART3CLKSOURCE_CSI: \
934 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_CSI; \
935 break; \
936 case RCC_USART3CLKSOURCE_LSE: \
937 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_LSE; \
938 break; \
939 default: \
940 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_UNDEFINED; \
941 break; \
942 } \
943 } \
944 else if((__HANDLE__)->Instance == USART6) \
945 { \
946 switch(__HAL_RCC_GET_USART6_SOURCE()) \
947 { \
948 case RCC_USART6CLKSOURCE_D2PCLK2: \
949 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_D2PCLK2; \
950 break; \
951 case RCC_USART6CLKSOURCE_PLL2: \
952 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_PLL2; \
953 break; \
954 case RCC_USART6CLKSOURCE_PLL3: \
955 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_PLL3; \
956 break; \
957 case RCC_USART6CLKSOURCE_HSI: \
958 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_HSI; \
959 break; \
960 case RCC_USART6CLKSOURCE_CSI: \
961 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_CSI; \
962 break; \
963 case RCC_USART6CLKSOURCE_LSE: \
964 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_LSE; \
965 break; \
966 default: \
967 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_UNDEFINED; \
968 break; \
969 } \
970 } \
971 else \
972 { \
973 (__CLOCKSOURCE__) = USART_CLOCKSOURCE_UNDEFINED; \
974 } \
975 } while(0U)
976 #endif /* UART9 && USART10 */
977
978 /** @brief Check USART Baud rate.
979 * @param __BAUDRATE__ Baudrate specified by the user.
980 * The maximum Baud Rate is derived from the maximum clock on H7 (i.e. 100 MHz)
981 * divided by the smallest oversampling used on the USART (i.e. 8)
982 * @retval SET (__BAUDRATE__ is valid) or RESET (__BAUDRATE__ is invalid) */
983 #define IS_USART_BAUDRATE(__BAUDRATE__) ((__BAUDRATE__) <= 12500000U)
984
985 /**
986 * @brief Ensure that USART frame number of stop bits is valid.
987 * @param __STOPBITS__ USART frame number of stop bits.
988 * @retval SET (__STOPBITS__ is valid) or RESET (__STOPBITS__ is invalid)
989 */
990 #define IS_USART_STOPBITS(__STOPBITS__) (((__STOPBITS__) == USART_STOPBITS_0_5) || \
991 ((__STOPBITS__) == USART_STOPBITS_1) || \
992 ((__STOPBITS__) == USART_STOPBITS_1_5) || \
993 ((__STOPBITS__) == USART_STOPBITS_2))
994
995 /**
996 * @brief Ensure that USART frame parity is valid.
997 * @param __PARITY__ USART frame parity.
998 * @retval SET (__PARITY__ is valid) or RESET (__PARITY__ is invalid)
999 */
1000 #define IS_USART_PARITY(__PARITY__) (((__PARITY__) == USART_PARITY_NONE) || \
1001 ((__PARITY__) == USART_PARITY_EVEN) || \
1002 ((__PARITY__) == USART_PARITY_ODD))
1003
1004 /**
1005 * @brief Ensure that USART communication mode is valid.
1006 * @param __MODE__ USART communication mode.
1007 * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid)
1008 */
1009 #define IS_USART_MODE(__MODE__) ((((__MODE__) & 0xFFFFFFF3U) == 0x00U) && ((__MODE__) != 0x00U))
1010
1011 /**
1012 * @brief Ensure that USART oversampling is valid.
1013 * @param __SAMPLING__ USART oversampling.
1014 * @retval SET (__SAMPLING__ is valid) or RESET (__SAMPLING__ is invalid)
1015 */
1016 #define IS_USART_OVERSAMPLING(__SAMPLING__) (((__SAMPLING__) == USART_OVERSAMPLING_16) || \
1017 ((__SAMPLING__) == USART_OVERSAMPLING_8))
1018
1019 /**
1020 * @brief Ensure that USART clock state is valid.
1021 * @param __CLOCK__ USART clock state.
1022 * @retval SET (__CLOCK__ is valid) or RESET (__CLOCK__ is invalid)
1023 */
1024 #define IS_USART_CLOCK(__CLOCK__) (((__CLOCK__) == USART_CLOCK_DISABLE) || \
1025 ((__CLOCK__) == USART_CLOCK_ENABLE))
1026
1027 /**
1028 * @brief Ensure that USART frame polarity is valid.
1029 * @param __CPOL__ USART frame polarity.
1030 * @retval SET (__CPOL__ is valid) or RESET (__CPOL__ is invalid)
1031 */
1032 #define IS_USART_POLARITY(__CPOL__) (((__CPOL__) == USART_POLARITY_LOW) || ((__CPOL__) == USART_POLARITY_HIGH))
1033
1034 /**
1035 * @brief Ensure that USART frame phase is valid.
1036 * @param __CPHA__ USART frame phase.
1037 * @retval SET (__CPHA__ is valid) or RESET (__CPHA__ is invalid)
1038 */
1039 #define IS_USART_PHASE(__CPHA__) (((__CPHA__) == USART_PHASE_1EDGE) || ((__CPHA__) == USART_PHASE_2EDGE))
1040
1041 /**
1042 * @brief Ensure that USART frame last bit clock pulse setting is valid.
1043 * @param __LASTBIT__ USART frame last bit clock pulse setting.
1044 * @retval SET (__LASTBIT__ is valid) or RESET (__LASTBIT__ is invalid)
1045 */
1046 #define IS_USART_LASTBIT(__LASTBIT__) (((__LASTBIT__) == USART_LASTBIT_DISABLE) || \
1047 ((__LASTBIT__) == USART_LASTBIT_ENABLE))
1048
1049 /**
1050 * @brief Ensure that USART request parameter is valid.
1051 * @param __PARAM__ USART request parameter.
1052 * @retval SET (__PARAM__ is valid) or RESET (__PARAM__ is invalid)
1053 */
1054 #define IS_USART_REQUEST_PARAMETER(__PARAM__) (((__PARAM__) == USART_RXDATA_FLUSH_REQUEST) || \
1055 ((__PARAM__) == USART_TXDATA_FLUSH_REQUEST))
1056
1057 /**
1058 * @brief Ensure that USART Prescaler is valid.
1059 * @param __CLOCKPRESCALER__ USART Prescaler value.
1060 * @retval SET (__CLOCKPRESCALER__ is valid) or RESET (__CLOCKPRESCALER__ is invalid)
1061 */
1062 #define IS_USART_PRESCALER(__CLOCKPRESCALER__) (((__CLOCKPRESCALER__) == USART_PRESCALER_DIV1) || \
1063 ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV2) || \
1064 ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV4) || \
1065 ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV6) || \
1066 ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV8) || \
1067 ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV10) || \
1068 ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV12) || \
1069 ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV16) || \
1070 ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV32) || \
1071 ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV64) || \
1072 ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV128) || \
1073 ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV256))
1074
1075 /**
1076 * @}
1077 */
1078
1079 /* Include USART HAL Extended module */
1080 #include "stm32h7xx_hal_usart_ex.h"
1081
1082 /* Exported functions --------------------------------------------------------*/
1083 /** @addtogroup USART_Exported_Functions USART Exported Functions
1084 * @{
1085 */
1086
1087 /** @addtogroup USART_Exported_Functions_Group1 Initialization and de-initialization functions
1088 * @{
1089 */
1090
1091 /* Initialization and de-initialization functions ****************************/
1092 HAL_StatusTypeDef HAL_USART_Init(USART_HandleTypeDef *husart);
1093 HAL_StatusTypeDef HAL_USART_DeInit(USART_HandleTypeDef *husart);
1094 void HAL_USART_MspInit(USART_HandleTypeDef *husart);
1095 void HAL_USART_MspDeInit(USART_HandleTypeDef *husart);
1096
1097 /* Callbacks Register/UnRegister functions ***********************************/
1098 #if (USE_HAL_USART_REGISTER_CALLBACKS == 1)
1099 HAL_StatusTypeDef HAL_USART_RegisterCallback(USART_HandleTypeDef *husart, HAL_USART_CallbackIDTypeDef CallbackID,
1100 pUSART_CallbackTypeDef pCallback);
1101 HAL_StatusTypeDef HAL_USART_UnRegisterCallback(USART_HandleTypeDef *husart, HAL_USART_CallbackIDTypeDef CallbackID);
1102 #endif /* USE_HAL_USART_REGISTER_CALLBACKS */
1103
1104 /**
1105 * @}
1106 */
1107
1108 /** @addtogroup USART_Exported_Functions_Group2 IO operation functions
1109 * @{
1110 */
1111
1112 /* IO operation functions *****************************************************/
1113 HAL_StatusTypeDef HAL_USART_Transmit(USART_HandleTypeDef *husart, uint8_t *pTxData, uint16_t Size, uint32_t Timeout);
1114 HAL_StatusTypeDef HAL_USART_Receive(USART_HandleTypeDef *husart, uint8_t *pRxData, uint16_t Size, uint32_t Timeout);
1115 HAL_StatusTypeDef HAL_USART_TransmitReceive(USART_HandleTypeDef *husart, uint8_t *pTxData, uint8_t *pRxData,
1116 uint16_t Size, uint32_t Timeout);
1117 HAL_StatusTypeDef HAL_USART_Transmit_IT(USART_HandleTypeDef *husart, uint8_t *pTxData, uint16_t Size);
1118 HAL_StatusTypeDef HAL_USART_Receive_IT(USART_HandleTypeDef *husart, uint8_t *pRxData, uint16_t Size);
1119 HAL_StatusTypeDef HAL_USART_TransmitReceive_IT(USART_HandleTypeDef *husart, uint8_t *pTxData, uint8_t *pRxData,
1120 uint16_t Size);
1121 HAL_StatusTypeDef HAL_USART_Transmit_DMA(USART_HandleTypeDef *husart, uint8_t *pTxData, uint16_t Size);
1122 HAL_StatusTypeDef HAL_USART_Receive_DMA(USART_HandleTypeDef *husart, uint8_t *pRxData, uint16_t Size);
1123 HAL_StatusTypeDef HAL_USART_TransmitReceive_DMA(USART_HandleTypeDef *husart, uint8_t *pTxData, uint8_t *pRxData,
1124 uint16_t Size);
1125 HAL_StatusTypeDef HAL_USART_DMAPause(USART_HandleTypeDef *husart);
1126 HAL_StatusTypeDef HAL_USART_DMAResume(USART_HandleTypeDef *husart);
1127 HAL_StatusTypeDef HAL_USART_DMAStop(USART_HandleTypeDef *husart);
1128 /* Transfer Abort functions */
1129 HAL_StatusTypeDef HAL_USART_Abort(USART_HandleTypeDef *husart);
1130 HAL_StatusTypeDef HAL_USART_Abort_IT(USART_HandleTypeDef *husart);
1131
1132 void HAL_USART_IRQHandler(USART_HandleTypeDef *husart);
1133 void HAL_USART_TxHalfCpltCallback(USART_HandleTypeDef *husart);
1134 void HAL_USART_TxCpltCallback(USART_HandleTypeDef *husart);
1135 void HAL_USART_RxCpltCallback(USART_HandleTypeDef *husart);
1136 void HAL_USART_RxHalfCpltCallback(USART_HandleTypeDef *husart);
1137 void HAL_USART_TxRxCpltCallback(USART_HandleTypeDef *husart);
1138 void HAL_USART_ErrorCallback(USART_HandleTypeDef *husart);
1139 void HAL_USART_AbortCpltCallback(USART_HandleTypeDef *husart);
1140
1141 /**
1142 * @}
1143 */
1144
1145 /** @addtogroup USART_Exported_Functions_Group4 Peripheral State and Error functions
1146 * @{
1147 */
1148
1149 /* Peripheral State and Error functions ***************************************/
1150 HAL_USART_StateTypeDef HAL_USART_GetState(USART_HandleTypeDef *husart);
1151 uint32_t HAL_USART_GetError(USART_HandleTypeDef *husart);
1152
1153 /**
1154 * @}
1155 */
1156
1157 /**
1158 * @}
1159 */
1160
1161 /**
1162 * @}
1163 */
1164
1165 /**
1166 * @}
1167 */
1168
1169 #ifdef __cplusplus
1170 }
1171 #endif
1172
1173 #endif /* STM32H7xx_HAL_USART_H */
1174
1175 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
INAV: Navigation-enabled flight control software