?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Updated and Validated
[betaflight.git] / lib / main / STM32F7 / Drivers / STM32F7xx_HAL_Driver / Inc / stm32f7xx_hal_uart.h
blob689092d36c85aa633fa4fac02ab84694a3f6bf93
1 /**
2 ******************************************************************************
3 * @file stm32f7xx_hal_uart.h
4 * @author MCD Application Team
5 * @brief Header file of UART 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 STM32F7xx_HAL_UART_H
22 #define STM32F7xx_HAL_UART_H
23
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27
28 /* Includes ------------------------------------------------------------------*/
29 #include "stm32f7xx_hal_def.h"
30
31 /** @addtogroup STM32F7xx_HAL_Driver
32 * @{
33 */
34
35 /** @addtogroup UART
36 * @{
37 */
38
39 /* Exported types ------------------------------------------------------------*/
40 /** @defgroup UART_Exported_Types UART Exported Types
41 * @{
42 */
43
44 /**
45 * @brief UART Init Structure definition
46 */
47 typedef struct
48 {
49 uint32_t BaudRate; /*!< This member configures the UART communication baud rate.
50 The baud rate register is computed using the following formula:
51 - If oversampling is 16 or in LIN mode,
52 Baud Rate Register = ((uart_ker_ck) / ((huart->Init.BaudRate)))
53 - If oversampling is 8,
54 Baud Rate Register[15:4] = ((2 * uart_ker_ck) / ((huart->Init.BaudRate)))[15:4]
55 Baud Rate Register[3] = 0
56 Baud Rate Register[2:0] = (((2 * uart_ker_ck) / ((huart->Init.BaudRate)))[3:0]) >> 1
57 where uart_ker_ck is the UART input clock */
58
59 uint32_t WordLength; /*!< Specifies the number of data bits transmitted or received in a frame.
60 This parameter can be a value of @ref UARTEx_Word_Length. */
61
62 uint32_t StopBits; /*!< Specifies the number of stop bits transmitted.
63 This parameter can be a value of @ref UART_Stop_Bits. */
64
65 uint32_t Parity; /*!< Specifies the parity mode.
66 This parameter can be a value of @ref UART_Parity
67 @note When parity is enabled, the computed parity is inserted
68 at the MSB position of the transmitted data (9th bit when
69 the word length is set to 9 data bits; 8th bit when the
70 word length is set to 8 data bits). */
71
72 uint32_t Mode; /*!< Specifies whether the Receive or Transmit mode is enabled or disabled.
73 This parameter can be a value of @ref UART_Mode. */
74
75 uint32_t HwFlowCtl; /*!< Specifies whether the hardware flow control mode is enabled
76 or disabled.
77 This parameter can be a value of @ref UART_Hardware_Flow_Control. */
78
79 uint32_t OverSampling; /*!< Specifies whether the Over sampling 8 is enabled or disabled, to achieve higher speed (up to f_PCLK/8).
80 This parameter can be a value of @ref UART_Over_Sampling. */
81
82 uint32_t OneBitSampling; /*!< Specifies whether a single sample or three samples' majority vote is selected.
83 Selecting the single sample method increases the receiver tolerance to clock
84 deviations. This parameter can be a value of @ref UART_OneBit_Sampling. */
85
86
87 } UART_InitTypeDef;
88
89 /**
90 * @brief UART Advanced Features initialization structure definition
91 */
92 typedef struct
93 {
94 uint32_t AdvFeatureInit; /*!< Specifies which advanced UART features is initialized. Several
95 Advanced Features may be initialized at the same time .
96 This parameter can be a value of @ref UART_Advanced_Features_Initialization_Type. */
97
98 uint32_t TxPinLevelInvert; /*!< Specifies whether the TX pin active level is inverted.
99 This parameter can be a value of @ref UART_Tx_Inv. */
100
101 uint32_t RxPinLevelInvert; /*!< Specifies whether the RX pin active level is inverted.
102 This parameter can be a value of @ref UART_Rx_Inv. */
103
104 uint32_t DataInvert; /*!< Specifies whether data are inverted (positive/direct logic
105 vs negative/inverted logic).
106 This parameter can be a value of @ref UART_Data_Inv. */
107
108 uint32_t Swap; /*!< Specifies whether TX and RX pins are swapped.
109 This parameter can be a value of @ref UART_Rx_Tx_Swap. */
110
111 uint32_t OverrunDisable; /*!< Specifies whether the reception overrun detection is disabled.
112 This parameter can be a value of @ref UART_Overrun_Disable. */
113
114 uint32_t DMADisableonRxError; /*!< Specifies whether the DMA is disabled in case of reception error.
115 This parameter can be a value of @ref UART_DMA_Disable_on_Rx_Error. */
116
117 uint32_t AutoBaudRateEnable; /*!< Specifies whether auto Baud rate detection is enabled.
118 This parameter can be a value of @ref UART_AutoBaudRate_Enable. */
119
120 uint32_t AutoBaudRateMode; /*!< If auto Baud rate detection is enabled, specifies how the rate
121 detection is carried out.
122 This parameter can be a value of @ref UART_AutoBaud_Rate_Mode. */
123
124 uint32_t MSBFirst; /*!< Specifies whether MSB is sent first on UART line.
125 This parameter can be a value of @ref UART_MSB_First. */
126 } UART_AdvFeatureInitTypeDef;
127
128
129
130 /**
131 * @brief HAL UART State definition
132 * @note HAL UART State value is a combination of 2 different substates: gState and RxState (see @ref UART_State_Definition).
133 * - gState contains UART state information related to global Handle management
134 * and also information related to Tx operations.
135 * gState value coding follow below described bitmap :
136 * b7-b6 Error information
137 * 00 : No Error
138 * 01 : (Not Used)
139 * 10 : Timeout
140 * 11 : Error
141 * b5 Peripheral initialization status
142 * 0 : Reset (Peripheral not initialized)
143 * 1 : Init done (Peripheral not initialized. HAL UART Init function already called)
144 * b4-b3 (not used)
145 * xx : Should be set to 00
146 * b2 Intrinsic process state
147 * 0 : Ready
148 * 1 : Busy (Peripheral busy with some configuration or internal operations)
149 * b1 (not used)
150 * x : Should be set to 0
151 * b0 Tx state
152 * 0 : Ready (no Tx operation ongoing)
153 * 1 : Busy (Tx operation ongoing)
154 * - RxState contains information related to Rx operations.
155 * RxState value coding follow below described bitmap :
156 * b7-b6 (not used)
157 * xx : Should be set to 00
158 * b5 Peripheral initialization status
159 * 0 : Reset (Peripheral not initialized)
160 * 1 : Init done (Peripheral not initialized)
161 * b4-b2 (not used)
162 * xxx : Should be set to 000
163 * b1 Rx state
164 * 0 : Ready (no Rx operation ongoing)
165 * 1 : Busy (Rx operation ongoing)
166 * b0 (not used)
167 * x : Should be set to 0.
168 */
169 typedef uint32_t HAL_UART_StateTypeDef;
170
171 /**
172 * @brief UART clock sources definition
173 */
174 typedef enum
175 {
176 UART_CLOCKSOURCE_PCLK1 = 0x00U, /*!< PCLK1 clock source */
177 UART_CLOCKSOURCE_PCLK2 = 0x01U, /*!< PCLK2 clock source */
178 UART_CLOCKSOURCE_HSI = 0x02U, /*!< HSI clock source */
179 UART_CLOCKSOURCE_SYSCLK = 0x04U, /*!< SYSCLK clock source */
180 UART_CLOCKSOURCE_LSE = 0x08U, /*!< LSE clock source */
181 UART_CLOCKSOURCE_UNDEFINED = 0x10U /*!< Undefined clock source */
182 } UART_ClockSourceTypeDef;
183
184 /**
185 * @brief UART handle Structure definition
186 */
187 typedef struct __UART_HandleTypeDef
188 {
189 USART_TypeDef *Instance; /*!< UART registers base address */
190
191 UART_InitTypeDef Init; /*!< UART communication parameters */
192
193 UART_AdvFeatureInitTypeDef AdvancedInit; /*!< UART Advanced Features initialization parameters */
194
195 uint8_t *pTxBuffPtr; /*!< Pointer to UART Tx transfer Buffer */
196
197 uint16_t TxXferSize; /*!< UART Tx Transfer size */
198
199 __IO uint16_t TxXferCount; /*!< UART Tx Transfer Counter */
200
201 uint8_t *pRxBuffPtr; /*!< Pointer to UART Rx transfer Buffer */
202
203 uint16_t RxXferSize; /*!< UART Rx Transfer size */
204
205 __IO uint16_t RxXferCount; /*!< UART Rx Transfer Counter */
206
207 uint16_t Mask; /*!< UART Rx RDR register mask */
208
209
210 void (*RxISR)(struct __UART_HandleTypeDef *huart); /*!< Function pointer on Rx IRQ handler */
211
212 void (*TxISR)(struct __UART_HandleTypeDef *huart); /*!< Function pointer on Tx IRQ handler */
213
214 DMA_HandleTypeDef *hdmatx; /*!< UART Tx DMA Handle parameters */
215
216 DMA_HandleTypeDef *hdmarx; /*!< UART Rx DMA Handle parameters */
217
218 HAL_LockTypeDef Lock; /*!< Locking object */
219
220 __IO HAL_UART_StateTypeDef gState; /*!< UART state information related to global Handle management
221 and also related to Tx operations.
222 This parameter can be a value of @ref HAL_UART_StateTypeDef */
223
224 __IO HAL_UART_StateTypeDef RxState; /*!< UART state information related to Rx operations.
225 This parameter can be a value of @ref HAL_UART_StateTypeDef */
226
227 __IO uint32_t ErrorCode; /*!< UART Error code */
228
229 #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
230 void (* TxHalfCpltCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Tx Half Complete Callback */
231 void (* TxCpltCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Tx Complete Callback */
232 void (* RxHalfCpltCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Rx Half Complete Callback */
233 void (* RxCpltCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Rx Complete Callback */
234 void (* ErrorCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Error Callback */
235 void (* AbortCpltCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Abort Complete Callback */
236 void (* AbortTransmitCpltCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Abort Transmit Complete Callback */
237 void (* AbortReceiveCpltCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Abort Receive Complete Callback */
238 void (* WakeupCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Wakeup Callback */
239
240 void (* MspInitCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Msp Init callback */
241 void (* MspDeInitCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Msp DeInit callback */
242 #endif /* USE_HAL_UART_REGISTER_CALLBACKS */
243
244 } UART_HandleTypeDef;
245
246 #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
247 /**
248 * @brief HAL UART Callback ID enumeration definition
249 */
250 typedef enum
251 {
252 HAL_UART_TX_HALFCOMPLETE_CB_ID = 0x00U, /*!< UART Tx Half Complete Callback ID */
253 HAL_UART_TX_COMPLETE_CB_ID = 0x01U, /*!< UART Tx Complete Callback ID */
254 HAL_UART_RX_HALFCOMPLETE_CB_ID = 0x02U, /*!< UART Rx Half Complete Callback ID */
255 HAL_UART_RX_COMPLETE_CB_ID = 0x03U, /*!< UART Rx Complete Callback ID */
256 HAL_UART_ERROR_CB_ID = 0x04U, /*!< UART Error Callback ID */
257 HAL_UART_ABORT_COMPLETE_CB_ID = 0x05U, /*!< UART Abort Complete Callback ID */
258 HAL_UART_ABORT_TRANSMIT_COMPLETE_CB_ID = 0x06U, /*!< UART Abort Transmit Complete Callback ID */
259 HAL_UART_ABORT_RECEIVE_COMPLETE_CB_ID = 0x07U, /*!< UART Abort Receive Complete Callback ID */
260 HAL_UART_WAKEUP_CB_ID = 0x08U, /*!< UART Wakeup Callback ID */
261
262 HAL_UART_MSPINIT_CB_ID = 0x0BU, /*!< UART MspInit callback ID */
263 HAL_UART_MSPDEINIT_CB_ID = 0x0CU /*!< UART MspDeInit callback ID */
264
265 } HAL_UART_CallbackIDTypeDef;
266
267 /**
268 * @brief HAL UART Callback pointer definition
269 */
270 typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer to an UART callback function */
271
272 #endif /* USE_HAL_UART_REGISTER_CALLBACKS */
273
274 /**
275 * @}
276 */
277
278 /* Exported constants --------------------------------------------------------*/
279 /** @defgroup UART_Exported_Constants UART Exported Constants
280 * @{
281 */
282
283 /** @defgroup UART_State_Definition UART State Code Definition
284 * @{
285 */
286 #define HAL_UART_STATE_RESET 0x00000000U /*!< Peripheral is not initialized
287 Value is allowed for gState and RxState */
288 #define HAL_UART_STATE_READY 0x00000020U /*!< Peripheral Initialized and ready for use
289 Value is allowed for gState and RxState */
290 #define HAL_UART_STATE_BUSY 0x00000024U /*!< an internal process is ongoing
291 Value is allowed for gState only */
292 #define HAL_UART_STATE_BUSY_TX 0x00000021U /*!< Data Transmission process is ongoing
293 Value is allowed for gState only */
294 #define HAL_UART_STATE_BUSY_RX 0x00000022U /*!< Data Reception process is ongoing
295 Value is allowed for RxState only */
296 #define HAL_UART_STATE_BUSY_TX_RX 0x00000023U /*!< Data Transmission and Reception process is ongoing
297 Not to be used for neither gState nor RxState.
298 Value is result of combination (Or) between gState and RxState values */
299 #define HAL_UART_STATE_TIMEOUT 0x000000A0U /*!< Timeout state
300 Value is allowed for gState only */
301 #define HAL_UART_STATE_ERROR 0x000000E0U /*!< Error
302 Value is allowed for gState only */
303 /**
304 * @}
305 */
306
307 /** @defgroup UART_Error_Definition UART Error Definition
308 * @{
309 */
310 #define HAL_UART_ERROR_NONE ((uint32_t)0x00000000U) /*!< No error */
311 #define HAL_UART_ERROR_PE ((uint32_t)0x00000001U) /*!< Parity error */
312 #define HAL_UART_ERROR_NE ((uint32_t)0x00000002U) /*!< Noise error */
313 #define HAL_UART_ERROR_FE ((uint32_t)0x00000004U) /*!< Frame error */
314 #define HAL_UART_ERROR_ORE ((uint32_t)0x00000008U) /*!< Overrun error */
315 #define HAL_UART_ERROR_DMA ((uint32_t)0x00000010U) /*!< DMA transfer error */
316 #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
317 #define HAL_UART_ERROR_INVALID_CALLBACK ((uint32_t)0x00000020U) /*!< Invalid Callback error */
318 #endif /* USE_HAL_UART_REGISTER_CALLBACKS */
319 /**
320 * @}
321 */
322
323 /** @defgroup UART_Stop_Bits UART Number of Stop Bits
324 * @{
325 */
326 #define UART_STOPBITS_0_5 USART_CR2_STOP_0 /*!< UART frame with 0.5 stop bit */
327 #define UART_STOPBITS_1 0x00000000U /*!< UART frame with 1 stop bit */
328 #define UART_STOPBITS_1_5 (USART_CR2_STOP_0 | USART_CR2_STOP_1) /*!< UART frame with 1.5 stop bits */
329 #define UART_STOPBITS_2 USART_CR2_STOP_1 /*!< UART frame with 2 stop bits */
330 /**
331 * @}
332 */
333
334 /** @defgroup UART_Parity UART Parity
335 * @{
336 */
337 #define UART_PARITY_NONE 0x00000000U /*!< No parity */
338 #define UART_PARITY_EVEN USART_CR1_PCE /*!< Even parity */
339 #define UART_PARITY_ODD (USART_CR1_PCE | USART_CR1_PS) /*!< Odd parity */
340 /**
341 * @}
342 */
343
344 /** @defgroup UART_Hardware_Flow_Control UART Hardware Flow Control
345 * @{
346 */
347 #define UART_HWCONTROL_NONE 0x00000000U /*!< No hardware control */
348 #define UART_HWCONTROL_RTS USART_CR3_RTSE /*!< Request To Send */
349 #define UART_HWCONTROL_CTS USART_CR3_CTSE /*!< Clear To Send */
350 #define UART_HWCONTROL_RTS_CTS (USART_CR3_RTSE | USART_CR3_CTSE) /*!< Request and Clear To Send */
351 /**
352 * @}
353 */
354
355 /** @defgroup UART_Mode UART Transfer Mode
356 * @{
357 */
358 #define UART_MODE_RX USART_CR1_RE /*!< RX mode */
359 #define UART_MODE_TX USART_CR1_TE /*!< TX mode */
360 #define UART_MODE_TX_RX (USART_CR1_TE |USART_CR1_RE) /*!< RX and TX mode */
361 /**
362 * @}
363 */
364
365 /** @defgroup UART_State UART State
366 * @{
367 */
368 #define UART_STATE_DISABLE 0x00000000U /*!< UART disabled */
369 #define UART_STATE_ENABLE USART_CR1_UE /*!< UART enabled */
370 /**
371 * @}
372 */
373
374 /** @defgroup UART_Over_Sampling UART Over Sampling
375 * @{
376 */
377 #define UART_OVERSAMPLING_16 0x00000000U /*!< Oversampling by 16 */
378 #define UART_OVERSAMPLING_8 USART_CR1_OVER8 /*!< Oversampling by 8 */
379 /**
380 * @}
381 */
382
383 /** @defgroup UART_OneBit_Sampling UART One Bit Sampling Method
384 * @{
385 */
386 #define UART_ONE_BIT_SAMPLE_DISABLE 0x00000000U /*!< One-bit sampling disable */
387 #define UART_ONE_BIT_SAMPLE_ENABLE USART_CR3_ONEBIT /*!< One-bit sampling enable */
388 /**
389 * @}
390 */
391
392 /** @defgroup UART_AutoBaud_Rate_Mode UART Advanced Feature AutoBaud Rate Mode
393 * @{
394 */
395 #define UART_ADVFEATURE_AUTOBAUDRATE_ONSTARTBIT 0x00000000U /*!< Auto Baud rate detection on start bit */
396 #define UART_ADVFEATURE_AUTOBAUDRATE_ONFALLINGEDGE USART_CR2_ABRMODE_0 /*!< Auto Baud rate detection on falling edge */
397 #define UART_ADVFEATURE_AUTOBAUDRATE_ON0X7FFRAME USART_CR2_ABRMODE_1 /*!< Auto Baud rate detection on 0x7F frame detection */
398 #define UART_ADVFEATURE_AUTOBAUDRATE_ON0X55FRAME USART_CR2_ABRMODE /*!< Auto Baud rate detection on 0x55 frame detection */
399 /**
400 * @}
401 */
402
403 /** @defgroup UART_Receiver_TimeOut UART Receiver TimeOut
404 * @{
405 */
406 #define UART_RECEIVER_TIMEOUT_DISABLE 0x00000000U /*!< UART receiver timeout disable */
407 #define UART_RECEIVER_TIMEOUT_ENABLE USART_CR2_RTOEN /*!< UART receiver timeout enable */
408 /**
409 * @}
410 */
411
412 /** @defgroup UART_LIN UART Local Interconnection Network mode
413 * @{
414 */
415 #define UART_LIN_DISABLE 0x00000000U /*!< Local Interconnect Network disable */
416 #define UART_LIN_ENABLE USART_CR2_LINEN /*!< Local Interconnect Network enable */
417 /**
418 * @}
419 */
420
421 /** @defgroup UART_LIN_Break_Detection UART LIN Break Detection
422 * @{
423 */
424 #define UART_LINBREAKDETECTLENGTH_10B 0x00000000U /*!< LIN 10-bit break detection length */
425 #define UART_LINBREAKDETECTLENGTH_11B USART_CR2_LBDL /*!< LIN 11-bit break detection length */
426 /**
427 * @}
428 */
429
430 /** @defgroup UART_DMA_Tx UART DMA Tx
431 * @{
432 */
433 #define UART_DMA_TX_DISABLE 0x00000000U /*!< UART DMA TX disabled */
434 #define UART_DMA_TX_ENABLE USART_CR3_DMAT /*!< UART DMA TX enabled */
435 /**
436 * @}
437 */
438
439 /** @defgroup UART_DMA_Rx UART DMA Rx
440 * @{
441 */
442 #define UART_DMA_RX_DISABLE 0x00000000U /*!< UART DMA RX disabled */
443 #define UART_DMA_RX_ENABLE USART_CR3_DMAR /*!< UART DMA RX enabled */
444 /**
445 * @}
446 */
447
448 /** @defgroup UART_Half_Duplex_Selection UART Half Duplex Selection
449 * @{
450 */
451 #define UART_HALF_DUPLEX_DISABLE 0x00000000U /*!< UART half-duplex disabled */
452 #define UART_HALF_DUPLEX_ENABLE USART_CR3_HDSEL /*!< UART half-duplex enabled */
453 /**
454 * @}
455 */
456
457 /** @defgroup UART_WakeUp_Methods UART WakeUp Methods
458 * @{
459 */
460 #define UART_WAKEUPMETHOD_IDLELINE 0x00000000U /*!< UART wake-up on idle line */
461 #define UART_WAKEUPMETHOD_ADDRESSMARK USART_CR1_WAKE /*!< UART wake-up on address mark */
462 /**
463 * @}
464 */
465
466 /** @defgroup UART_Request_Parameters UART Request Parameters
467 * @{
468 */
469 #define UART_AUTOBAUD_REQUEST USART_RQR_ABRRQ /*!< Auto-Baud Rate Request */
470 #define UART_SENDBREAK_REQUEST USART_RQR_SBKRQ /*!< Send Break Request */
471 #define UART_MUTE_MODE_REQUEST USART_RQR_MMRQ /*!< Mute Mode Request */
472 #define UART_RXDATA_FLUSH_REQUEST USART_RQR_RXFRQ /*!< Receive Data flush Request */
473 #define UART_TXDATA_FLUSH_REQUEST USART_RQR_TXFRQ /*!< Transmit data flush Request */
474 /**
475 * @}
476 */
477
478 /** @defgroup UART_Advanced_Features_Initialization_Type UART Advanced Feature Initialization Type
479 * @{
480 */
481 #define UART_ADVFEATURE_NO_INIT 0x00000000U /*!< No advanced feature initialization */
482 #define UART_ADVFEATURE_TXINVERT_INIT 0x00000001U /*!< TX pin active level inversion */
483 #define UART_ADVFEATURE_RXINVERT_INIT 0x00000002U /*!< RX pin active level inversion */
484 #define UART_ADVFEATURE_DATAINVERT_INIT 0x00000004U /*!< Binary data inversion */
485 #define UART_ADVFEATURE_SWAP_INIT 0x00000008U /*!< TX/RX pins swap */
486 #define UART_ADVFEATURE_RXOVERRUNDISABLE_INIT 0x00000010U /*!< RX overrun disable */
487 #define UART_ADVFEATURE_DMADISABLEONERROR_INIT 0x00000020U /*!< DMA disable on Reception Error */
488 #define UART_ADVFEATURE_AUTOBAUDRATE_INIT 0x00000040U /*!< Auto Baud rate detection initialization */
489 #define UART_ADVFEATURE_MSBFIRST_INIT 0x00000080U /*!< Most significant bit sent/received first */
490 /**
491 * @}
492 */
493
494 /** @defgroup UART_Tx_Inv UART Advanced Feature TX Pin Active Level Inversion
495 * @{
496 */
497 #define UART_ADVFEATURE_TXINV_DISABLE 0x00000000U /*!< TX pin active level inversion disable */
498 #define UART_ADVFEATURE_TXINV_ENABLE USART_CR2_TXINV /*!< TX pin active level inversion enable */
499 /**
500 * @}
501 */
502
503 /** @defgroup UART_Rx_Inv UART Advanced Feature RX Pin Active Level Inversion
504 * @{
505 */
506 #define UART_ADVFEATURE_RXINV_DISABLE 0x00000000U /*!< RX pin active level inversion disable */
507 #define UART_ADVFEATURE_RXINV_ENABLE USART_CR2_RXINV /*!< RX pin active level inversion enable */
508 /**
509 * @}
510 */
511
512 /** @defgroup UART_Data_Inv UART Advanced Feature Binary Data Inversion
513 * @{
514 */
515 #define UART_ADVFEATURE_DATAINV_DISABLE 0x00000000U /*!< Binary data inversion disable */
516 #define UART_ADVFEATURE_DATAINV_ENABLE USART_CR2_DATAINV /*!< Binary data inversion enable */
517 /**
518 * @}
519 */
520
521 /** @defgroup UART_Rx_Tx_Swap UART Advanced Feature RX TX Pins Swap
522 * @{
523 */
524 #define UART_ADVFEATURE_SWAP_DISABLE 0x00000000U /*!< TX/RX pins swap disable */
525 #define UART_ADVFEATURE_SWAP_ENABLE USART_CR2_SWAP /*!< TX/RX pins swap enable */
526 /**
527 * @}
528 */
529
530 /** @defgroup UART_Overrun_Disable UART Advanced Feature Overrun Disable
531 * @{
532 */
533 #define UART_ADVFEATURE_OVERRUN_ENABLE 0x00000000U /*!< RX overrun enable */
534 #define UART_ADVFEATURE_OVERRUN_DISABLE USART_CR3_OVRDIS /*!< RX overrun disable */
535 /**
536 * @}
537 */
538
539 /** @defgroup UART_AutoBaudRate_Enable UART Advanced Feature Auto BaudRate Enable
540 * @{
541 */
542 #define UART_ADVFEATURE_AUTOBAUDRATE_DISABLE 0x00000000U /*!< RX Auto Baud rate detection enable */
543 #define UART_ADVFEATURE_AUTOBAUDRATE_ENABLE USART_CR2_ABREN /*!< RX Auto Baud rate detection disable */
544 /**
545 * @}
546 */
547
548 /** @defgroup UART_DMA_Disable_on_Rx_Error UART Advanced Feature DMA Disable On Rx Error
549 * @{
550 */
551 #define UART_ADVFEATURE_DMA_ENABLEONRXERROR 0x00000000U /*!< DMA enable on Reception Error */
552 #define UART_ADVFEATURE_DMA_DISABLEONRXERROR USART_CR3_DDRE /*!< DMA disable on Reception Error */
553 /**
554 * @}
555 */
556
557 /** @defgroup UART_MSB_First UART Advanced Feature MSB First
558 * @{
559 */
560 #define UART_ADVFEATURE_MSBFIRST_DISABLE 0x00000000U /*!< Most significant bit sent/received first disable */
561 #define UART_ADVFEATURE_MSBFIRST_ENABLE USART_CR2_MSBFIRST /*!< Most significant bit sent/received first enable */
562 /**
563 * @}
564 */
565
566 /** @defgroup UART_Mute_Mode UART Advanced Feature Mute Mode Enable
567 * @{
568 */
569 #define UART_ADVFEATURE_MUTEMODE_DISABLE 0x00000000U /*!< UART mute mode disable */
570 #define UART_ADVFEATURE_MUTEMODE_ENABLE USART_CR1_MME /*!< UART mute mode enable */
571 /**
572 * @}
573 */
574
575 /** @defgroup UART_CR2_ADDRESS_LSB_POS UART Address-matching LSB Position In CR2 Register
576 * @{
577 */
578 #define UART_CR2_ADDRESS_LSB_POS 24U /*!< UART address-matching LSB position in CR2 register */
579 /**
580 * @}
581 */
582
583 /** @defgroup UART_DriverEnable_Polarity UART DriverEnable Polarity
584 * @{
585 */
586 #define UART_DE_POLARITY_HIGH 0x00000000U /*!< Driver enable signal is active high */
587 #define UART_DE_POLARITY_LOW USART_CR3_DEP /*!< Driver enable signal is active low */
588 /**
589 * @}
590 */
591
592 /** @defgroup UART_CR1_DEAT_ADDRESS_LSB_POS UART Driver Enable Assertion Time LSB Position In CR1 Register
593 * @{
594 */
595 #define UART_CR1_DEAT_ADDRESS_LSB_POS 21U /*!< UART Driver Enable assertion time LSB position in CR1 register */
596 /**
597 * @}
598 */
599
600 /** @defgroup UART_CR1_DEDT_ADDRESS_LSB_POS UART Driver Enable DeAssertion Time LSB Position In CR1 Register
601 * @{
602 */
603 #define UART_CR1_DEDT_ADDRESS_LSB_POS 16U /*!< UART Driver Enable de-assertion time LSB position in CR1 register */
604 /**
605 * @}
606 */
607
608 /** @defgroup UART_Interruption_Mask UART Interruptions Flag Mask
609 * @{
610 */
611 #define UART_IT_MASK 0x001FU /*!< UART interruptions flags mask */
612 /**
613 * @}
614 */
615
616 /** @defgroup UART_TimeOut_Value UART polling-based communications time-out value
617 * @{
618 */
619 #define HAL_UART_TIMEOUT_VALUE 0x1FFFFFFU /*!< UART polling-based communications time-out value */
620 /**
621 * @}
622 */
623
624 /** @defgroup UART_Flags UART Status Flags
625 * Elements values convention: 0xXXXX
626 * - 0xXXXX : Flag mask in the ISR register
627 * @{
628 */
629 #define UART_FLAG_TEACK USART_ISR_TEACK /*!< UART transmit enable acknowledge flag */
630 #define UART_FLAG_RWU USART_ISR_RWU /*!< UART receiver wake-up from mute mode flag */
631 #define UART_FLAG_SBKF USART_ISR_SBKF /*!< UART send break flag */
632 #define UART_FLAG_CMF USART_ISR_CMF /*!< UART character match flag */
633 #define UART_FLAG_BUSY USART_ISR_BUSY /*!< UART busy flag */
634 #define UART_FLAG_ABRF USART_ISR_ABRF /*!< UART auto Baud rate flag */
635 #define UART_FLAG_ABRE USART_ISR_ABRE /*!< UART auto Baud rate error */
636 #define UART_FLAG_CTS USART_ISR_CTS /*!< UART clear to send flag */
637 #define UART_FLAG_CTSIF USART_ISR_CTSIF /*!< UART clear to send interrupt flag */
638 #define UART_FLAG_LBDF USART_ISR_LBDF /*!< UART LIN break detection flag */
639 #define UART_FLAG_TXE USART_ISR_TXE /*!< UART transmit data register empty */
640 #define UART_FLAG_TC USART_ISR_TC /*!< UART transmission complete */
641 #define UART_FLAG_RXNE USART_ISR_RXNE /*!< UART read data register not empty */
642 #define UART_FLAG_IDLE USART_ISR_IDLE /*!< UART idle flag */
643 #define UART_FLAG_ORE USART_ISR_ORE /*!< UART overrun error */
644 #define UART_FLAG_NE USART_ISR_NE /*!< UART noise error */
645 #define UART_FLAG_FE USART_ISR_FE /*!< UART frame error */
646 #define UART_FLAG_PE USART_ISR_PE /*!< UART parity error */
647 /**
648 * @}
649 */
650
651 /** @defgroup UART_Interrupt_definition UART Interrupts Definition
652 * Elements values convention: 000ZZZZZ0XXYYYYYb
653 * - YYYYY : Interrupt source position in the XX register (5bits)
654 * - XX : Interrupt source register (2bits)
655 * - 01: CR1 register
656 * - 10: CR2 register
657 * - 11: CR3 register
658 * - ZZZZZ : Flag position in the ISR register(5bits)
659 * Elements values convention: 000000000XXYYYYYb
660 * - YYYYY : Interrupt source position in the XX register (5bits)
661 * - XX : Interrupt source register (2bits)
662 * - 01: CR1 register
663 * - 10: CR2 register
664 * - 11: CR3 register
665 * Elements values convention: 0000ZZZZ00000000b
666 * - ZZZZ : Flag position in the ISR register(4bits)
667 * @{
668 */
669 #define UART_IT_PE 0x0028U /*!< UART parity error interruption */
670 #define UART_IT_TXE 0x0727U /*!< UART transmit data register empty interruption */
671 #define UART_IT_TC 0x0626U /*!< UART transmission complete interruption */
672 #define UART_IT_RXNE 0x0525U /*!< UART read data register not empty interruption */
673 #define UART_IT_IDLE 0x0424U /*!< UART idle interruption */
674 #define UART_IT_LBD 0x0846U /*!< UART LIN break detection interruption */
675 #define UART_IT_CTS 0x096AU /*!< UART CTS interruption */
676 #define UART_IT_CM 0x112EU /*!< UART character match interruption */
677
678 #define UART_IT_ERR 0x0060U /*!< UART error interruption */
679
680 #define UART_IT_ORE 0x0300U /*!< UART overrun error interruption */
681 #define UART_IT_NE 0x0200U /*!< UART noise error interruption */
682 #define UART_IT_FE 0x0100U /*!< UART frame error interruption */
683 /**
684 * @}
685 */
686
687 /** @defgroup UART_IT_CLEAR_Flags UART Interruption Clear Flags
688 * @{
689 */
690 #define UART_CLEAR_PEF USART_ICR_PECF /*!< Parity Error Clear Flag */
691 #define UART_CLEAR_FEF USART_ICR_FECF /*!< Framing Error Clear Flag */
692 #define UART_CLEAR_NEF USART_ICR_NCF /*!< Noise Error detected Clear Flag */
693 #define UART_CLEAR_OREF USART_ICR_ORECF /*!< Overrun Error Clear Flag */
694 #define UART_CLEAR_IDLEF USART_ICR_IDLECF /*!< IDLE line detected Clear Flag */
695 #define UART_CLEAR_TCF USART_ICR_TCCF /*!< Transmission Complete Clear Flag */
696 #define UART_CLEAR_LBDF USART_ICR_LBDCF /*!< LIN Break Detection Clear Flag */
697 #define UART_CLEAR_CTSF USART_ICR_CTSCF /*!< CTS Interrupt Clear Flag */
698 #define UART_CLEAR_CMF USART_ICR_CMCF /*!< Character Match Clear Flag */
699 /**
700 * @}
701 */
702
703
704 /**
705 * @}
706 */
707
708 /* Exported macros -----------------------------------------------------------*/
709 /** @defgroup UART_Exported_Macros UART Exported Macros
710 * @{
711 */
712
713 /** @brief Reset UART handle states.
714 * @param __HANDLE__ UART handle.
715 * @retval None
716 */
717 #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
718 #define __HAL_UART_RESET_HANDLE_STATE(__HANDLE__) do{ \
719 (__HANDLE__)->gState = HAL_UART_STATE_RESET; \
720 (__HANDLE__)->RxState = HAL_UART_STATE_RESET; \
721 (__HANDLE__)->MspInitCallback = NULL; \
722 (__HANDLE__)->MspDeInitCallback = NULL; \
723 } while(0U)
724 #else
725 #define __HAL_UART_RESET_HANDLE_STATE(__HANDLE__) do{ \
726 (__HANDLE__)->gState = HAL_UART_STATE_RESET; \
727 (__HANDLE__)->RxState = HAL_UART_STATE_RESET; \
728 } while(0U)
729 #endif /*USE_HAL_UART_REGISTER_CALLBACKS */
730
731 /** @brief Flush the UART Data registers.
732 * @param __HANDLE__ specifies the UART Handle.
733 * @retval None
734 */
735 #define __HAL_UART_FLUSH_DRREGISTER(__HANDLE__) \
736 do{ \
737 SET_BIT((__HANDLE__)->Instance->RQR, UART_RXDATA_FLUSH_REQUEST); \
738 SET_BIT((__HANDLE__)->Instance->RQR, UART_TXDATA_FLUSH_REQUEST); \
739 } while(0U)
740
741 /** @brief Clear the specified UART pending flag.
742 * @param __HANDLE__ specifies the UART Handle.
743 * @param __FLAG__ specifies the flag to check.
744 * This parameter can be any combination of the following values:
745 * @arg @ref UART_CLEAR_PEF Parity Error Clear Flag
746 * @arg @ref UART_CLEAR_FEF Framing Error Clear Flag
747 * @arg @ref UART_CLEAR_NEF Noise detected Clear Flag
748 * @arg @ref UART_CLEAR_OREF Overrun Error Clear Flag
749 * @arg @ref UART_CLEAR_IDLEF IDLE line detected Clear Flag
750 * @arg @ref UART_CLEAR_TCF Transmission Complete Clear Flag
751 * @arg @ref UART_CLEAR_LBDF LIN Break Detection Clear Flag
752 * @arg @ref UART_CLEAR_CTSF CTS Interrupt Clear Flag
753 * @arg @ref UART_CLEAR_CMF Character Match Clear Flag
754 * @retval None
755 */
756 #define __HAL_UART_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__))
757
758 /** @brief Clear the UART PE pending flag.
759 * @param __HANDLE__ specifies the UART Handle.
760 * @retval None
761 */
762 #define __HAL_UART_CLEAR_PEFLAG(__HANDLE__) __HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_PEF)
763
764 /** @brief Clear the UART FE pending flag.
765 * @param __HANDLE__ specifies the UART Handle.
766 * @retval None
767 */
768 #define __HAL_UART_CLEAR_FEFLAG(__HANDLE__) __HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_FEF)
769
770 /** @brief Clear the UART NE pending flag.
771 * @param __HANDLE__ specifies the UART Handle.
772 * @retval None
773 */
774 #define __HAL_UART_CLEAR_NEFLAG(__HANDLE__) __HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_NEF)
775
776 /** @brief Clear the UART ORE pending flag.
777 * @param __HANDLE__ specifies the UART Handle.
778 * @retval None
779 */
780 #define __HAL_UART_CLEAR_OREFLAG(__HANDLE__) __HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_OREF)
781
782 /** @brief Clear the UART IDLE pending flag.
783 * @param __HANDLE__ specifies the UART Handle.
784 * @retval None
785 */
786 #define __HAL_UART_CLEAR_IDLEFLAG(__HANDLE__) __HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_IDLEF)
787
788
789 /** @brief Check whether the specified UART flag is set or not.
790 * @param __HANDLE__ specifies the UART Handle.
791 * @param __FLAG__ specifies the flag to check.
792 * This parameter can be one of the following values:
793 * @arg @ref UART_FLAG_TEACK Transmit enable acknowledge flag
794 * @arg @ref UART_FLAG_RWU Receiver wake up flag (if the UART in mute mode)
795 * @arg @ref UART_FLAG_SBKF Send Break flag
796 * @arg @ref UART_FLAG_CMF Character match flag
797 * @arg @ref UART_FLAG_BUSY Busy flag
798 * @arg @ref UART_FLAG_ABRF Auto Baud rate detection flag
799 * @arg @ref UART_FLAG_ABRE Auto Baud rate detection error flag
800 * @arg @ref UART_FLAG_CTS CTS Change flag
801 * @arg @ref UART_FLAG_LBDF LIN Break detection flag
802 * @arg @ref UART_FLAG_TXE Transmit data register empty flag
803 * @arg @ref UART_FLAG_TC Transmission Complete flag
804 * @arg @ref UART_FLAG_RXNE Receive data register not empty flag
805 * @arg @ref UART_FLAG_IDLE Idle Line detection flag
806 * @arg @ref UART_FLAG_ORE Overrun Error flag
807 * @arg @ref UART_FLAG_NE Noise Error flag
808 * @arg @ref UART_FLAG_FE Framing Error flag
809 * @arg @ref UART_FLAG_PE Parity Error flag
810 * @retval The new state of __FLAG__ (TRUE or FALSE).
811 */
812 #define __HAL_UART_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->ISR & (__FLAG__)) == (__FLAG__))
813
814 /** @brief Enable the specified UART interrupt.
815 * @param __HANDLE__ specifies the UART Handle.
816 * @param __INTERRUPT__ specifies the UART interrupt source to enable.
817 * This parameter can be one of the following values:
818 * @arg @ref UART_IT_CM Character match interrupt
819 * @arg @ref UART_IT_CTS CTS change interrupt
820 * @arg @ref UART_IT_LBD LIN Break detection interrupt
821 * @arg @ref UART_IT_TXE Transmit Data Register empty interrupt
822 * @arg @ref UART_IT_TC Transmission complete interrupt
823 * @arg @ref UART_IT_RXNE Receive Data register not empty interrupt
824 * @arg @ref UART_IT_IDLE Idle line detection interrupt
825 * @arg @ref UART_IT_PE Parity Error interrupt
826 * @arg @ref UART_IT_ERR Error interrupt (frame error, noise error, overrun error)
827 * @retval None
828 */
829 #define __HAL_UART_ENABLE_IT(__HANDLE__, __INTERRUPT__) (((((uint8_t)(__INTERRUPT__)) >> 5U) == 1U)? ((__HANDLE__)->Instance->CR1 |= (1U << ((__INTERRUPT__) & UART_IT_MASK))): \
830 ((((uint8_t)(__INTERRUPT__)) >> 5U) == 2U)? ((__HANDLE__)->Instance->CR2 |= (1U << ((__INTERRUPT__) & UART_IT_MASK))): \
831 ((__HANDLE__)->Instance->CR3 |= (1U << ((__INTERRUPT__) & UART_IT_MASK))))
832
833
834 /** @brief Disable the specified UART interrupt.
835 * @param __HANDLE__ specifies the UART Handle.
836 * @param __INTERRUPT__ specifies the UART interrupt source to disable.
837 * This parameter can be one of the following values:
838 * @arg @ref UART_IT_CM Character match interrupt
839 * @arg @ref UART_IT_CTS CTS change interrupt
840 * @arg @ref UART_IT_LBD LIN Break detection interrupt
841 * @arg @ref UART_IT_TXE Transmit Data Register empty interrupt
842 * @arg @ref UART_IT_TC Transmission complete interrupt
843 * @arg @ref UART_IT_RXNE Receive Data register not empty interrupt
844 * @arg @ref UART_IT_IDLE Idle line detection interrupt
845 * @arg @ref UART_IT_PE Parity Error interrupt
846 * @arg @ref UART_IT_ERR Error interrupt (Frame error, noise error, overrun error)
847 * @retval None
848 */
849 #define __HAL_UART_DISABLE_IT(__HANDLE__, __INTERRUPT__) (((((uint8_t)(__INTERRUPT__)) >> 5U) == 1U)? ((__HANDLE__)->Instance->CR1 &= ~ (1U << ((__INTERRUPT__) & UART_IT_MASK))): \
850 ((((uint8_t)(__INTERRUPT__)) >> 5U) == 2U)? ((__HANDLE__)->Instance->CR2 &= ~ (1U << ((__INTERRUPT__) & UART_IT_MASK))): \
851 ((__HANDLE__)->Instance->CR3 &= ~ (1U << ((__INTERRUPT__) & UART_IT_MASK))))
852
853 /** @brief Check whether the specified UART interrupt has occurred or not.
854 * @param __HANDLE__ specifies the UART Handle.
855 * @param __INTERRUPT__ specifies the UART interrupt to check.
856 * This parameter can be one of the following values:
857 * @arg @ref UART_IT_CM Character match interrupt
858 * @arg @ref UART_IT_CTS CTS change interrupt
859 * @arg @ref UART_IT_LBD LIN Break detection interrupt
860 * @arg @ref UART_IT_TXE Transmit Data Register empty interrupt
861 * @arg @ref UART_IT_TC Transmission complete interrupt
862 * @arg @ref UART_IT_RXNE Receive Data register not empty interrupt
863 * @arg @ref UART_IT_IDLE Idle line detection interrupt
864 * @arg @ref UART_IT_PE Parity Error interrupt
865 * @arg @ref UART_IT_ERR Error interrupt (Frame error, noise error, overrun error)
866 * @retval The new state of __INTERRUPT__ (SET or RESET).
867 */
868 #define __HAL_UART_GET_IT(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->ISR & (1U << ((__INTERRUPT__)>> 8U))) != RESET) ? SET : RESET)
869
870 /** @brief Check whether the specified UART interrupt source is enabled or not.
871 * @param __HANDLE__ specifies the UART Handle.
872 * @param __INTERRUPT__ specifies the UART interrupt source to check.
873 * This parameter can be one of the following values:
874 * @arg @ref UART_IT_CM Character match interrupt
875 * @arg @ref UART_IT_CTS CTS change interrupt
876 * @arg @ref UART_IT_LBD LIN Break detection interrupt
877 * @arg @ref UART_IT_TXE Transmit Data Register empty interrupt
878 * @arg @ref UART_IT_TC Transmission complete interrupt
879 * @arg @ref UART_IT_RXNE Receive Data register not empty interrupt
880 * @arg @ref UART_IT_IDLE Idle line detection interrupt
881 * @arg @ref UART_IT_PE Parity Error interrupt
882 * @arg @ref UART_IT_ERR Error interrupt (Frame error, noise error, overrun error)
883 * @retval The new state of __INTERRUPT__ (SET or RESET).
884 */
885 #define __HAL_UART_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((((((uint8_t)(__INTERRUPT__)) >> 5U) == 1U) ? (__HANDLE__)->Instance->CR1 : \
886 (((((uint8_t)(__INTERRUPT__)) >> 5U) == 2U) ? (__HANDLE__)->Instance->CR2 : \
887 (__HANDLE__)->Instance->CR3)) & (1U << (((uint16_t)(__INTERRUPT__)) & UART_IT_MASK))) != RESET) ? SET : RESET)
888
889 /** @brief Clear the specified UART ISR flag, in setting the proper ICR register flag.
890 * @param __HANDLE__ specifies the UART Handle.
891 * @param __IT_CLEAR__ specifies the interrupt clear register flag that needs to be set
892 * to clear the corresponding interrupt
893 * This parameter can be one of the following values:
894 * @arg @ref UART_CLEAR_PEF Parity Error Clear Flag
895 * @arg @ref UART_CLEAR_FEF Framing Error Clear Flag
896 * @arg @ref UART_CLEAR_NEF Noise detected Clear Flag
897 * @arg @ref UART_CLEAR_OREF Overrun Error Clear Flag
898 * @arg @ref UART_CLEAR_IDLEF IDLE line detected Clear Flag
899 * @arg @ref UART_CLEAR_TCF Transmission Complete Clear Flag
900 * @arg @ref UART_CLEAR_LBDF LIN Break Detection Clear Flag
901 * @arg @ref UART_CLEAR_CTSF CTS Interrupt Clear Flag
902 * @arg @ref UART_CLEAR_CMF Character Match Clear Flag
903 * @retval None
904 */
905 #define __HAL_UART_CLEAR_IT(__HANDLE__, __IT_CLEAR__) ((__HANDLE__)->Instance->ICR = (uint32_t)(__IT_CLEAR__))
906
907 /** @brief Set a specific UART request flag.
908 * @param __HANDLE__ specifies the UART Handle.
909 * @param __REQ__ specifies the request flag to set
910 * This parameter can be one of the following values:
911 * @arg @ref UART_AUTOBAUD_REQUEST Auto-Baud Rate Request
912 * @arg @ref UART_SENDBREAK_REQUEST Send Break Request
913 * @arg @ref UART_MUTE_MODE_REQUEST Mute Mode Request
914 * @arg @ref UART_RXDATA_FLUSH_REQUEST Receive Data flush Request
915 * @arg @ref UART_TXDATA_FLUSH_REQUEST Transmit data flush Request
916 * @retval None
917 */
918 #define __HAL_UART_SEND_REQ(__HANDLE__, __REQ__) ((__HANDLE__)->Instance->RQR |= (uint16_t)(__REQ__))
919
920 /** @brief Enable the UART one bit sample method.
921 * @param __HANDLE__ specifies the UART Handle.
922 * @retval None
923 */
924 #define __HAL_UART_ONE_BIT_SAMPLE_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3|= USART_CR3_ONEBIT)
925
926 /** @brief Disable the UART one bit sample method.
927 * @param __HANDLE__ specifies the UART Handle.
928 * @retval None
929 */
930 #define __HAL_UART_ONE_BIT_SAMPLE_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3 &= ~USART_CR3_ONEBIT)
931
932 /** @brief Enable UART.
933 * @param __HANDLE__ specifies the UART Handle.
934 * @retval None
935 */
936 #define __HAL_UART_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 |= USART_CR1_UE)
937
938 /** @brief Disable UART.
939 * @param __HANDLE__ specifies the UART Handle.
940 * @retval None
941 */
942 #define __HAL_UART_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE)
943
944 /** @brief Enable CTS flow control.
945 * @note This macro allows to enable CTS hardware flow control for a given UART instance,
946 * without need to call HAL_UART_Init() function.
947 * As involving direct access to UART registers, usage of this macro should be fully endorsed by user.
948 * @note As macro is expected to be used for modifying CTS Hw flow control feature activation, without need
949 * for USART instance Deinit/Init, following conditions for macro call should be fulfilled :
950 * - UART instance should have already been initialised (through call of HAL_UART_Init() )
951 * - macro could only be called when corresponding UART instance is disabled (i.e. __HAL_UART_DISABLE(__HANDLE__))
952 * and should be followed by an Enable macro (i.e. __HAL_UART_ENABLE(__HANDLE__)).
953 * @param __HANDLE__ specifies the UART Handle.
954 * @retval None
955 */
956 #define __HAL_UART_HWCONTROL_CTS_ENABLE(__HANDLE__) \
957 do{ \
958 SET_BIT((__HANDLE__)->Instance->CR3, USART_CR3_CTSE); \
959 (__HANDLE__)->Init.HwFlowCtl |= USART_CR3_CTSE; \
960 } while(0U)
961
962 /** @brief Disable CTS flow control.
963 * @note This macro allows to disable CTS hardware flow control for a given UART instance,
964 * without need to call HAL_UART_Init() function.
965 * As involving direct access to UART registers, usage of this macro should be fully endorsed by user.
966 * @note As macro is expected to be used for modifying CTS Hw flow control feature activation, without need
967 * for USART instance Deinit/Init, following conditions for macro call should be fulfilled :
968 * - UART instance should have already been initialised (through call of HAL_UART_Init() )
969 * - macro could only be called when corresponding UART instance is disabled (i.e. __HAL_UART_DISABLE(__HANDLE__))
970 * and should be followed by an Enable macro (i.e. __HAL_UART_ENABLE(__HANDLE__)).
971 * @param __HANDLE__ specifies the UART Handle.
972 * @retval None
973 */
974 #define __HAL_UART_HWCONTROL_CTS_DISABLE(__HANDLE__) \
975 do{ \
976 CLEAR_BIT((__HANDLE__)->Instance->CR3, USART_CR3_CTSE); \
977 (__HANDLE__)->Init.HwFlowCtl &= ~(USART_CR3_CTSE); \
978 } while(0U)
979
980 /** @brief Enable RTS flow control.
981 * @note This macro allows to enable RTS hardware flow control for a given UART instance,
982 * without need to call HAL_UART_Init() function.
983 * As involving direct access to UART registers, usage of this macro should be fully endorsed by user.
984 * @note As macro is expected to be used for modifying RTS Hw flow control feature activation, without need
985 * for USART instance Deinit/Init, following conditions for macro call should be fulfilled :
986 * - UART instance should have already been initialised (through call of HAL_UART_Init() )
987 * - macro could only be called when corresponding UART instance is disabled (i.e. __HAL_UART_DISABLE(__HANDLE__))
988 * and should be followed by an Enable macro (i.e. __HAL_UART_ENABLE(__HANDLE__)).
989 * @param __HANDLE__ specifies the UART Handle.
990 * @retval None
991 */
992 #define __HAL_UART_HWCONTROL_RTS_ENABLE(__HANDLE__) \
993 do{ \
994 SET_BIT((__HANDLE__)->Instance->CR3, USART_CR3_RTSE); \
995 (__HANDLE__)->Init.HwFlowCtl |= USART_CR3_RTSE; \
996 } while(0U)
997
998 /** @brief Disable RTS flow control.
999 * @note This macro allows to disable RTS hardware flow control for a given UART instance,
1000 * without need to call HAL_UART_Init() function.
1001 * As involving direct access to UART registers, usage of this macro should be fully endorsed by user.
1002 * @note As macro is expected to be used for modifying RTS Hw flow control feature activation, without need
1003 * for USART instance Deinit/Init, following conditions for macro call should be fulfilled :
1004 * - UART instance should have already been initialised (through call of HAL_UART_Init() )
1005 * - macro could only be called when corresponding UART instance is disabled (i.e. __HAL_UART_DISABLE(__HANDLE__))
1006 * and should be followed by an Enable macro (i.e. __HAL_UART_ENABLE(__HANDLE__)).
1007 * @param __HANDLE__ specifies the UART Handle.
1008 * @retval None
1009 */
1010 #define __HAL_UART_HWCONTROL_RTS_DISABLE(__HANDLE__) \
1011 do{ \
1012 CLEAR_BIT((__HANDLE__)->Instance->CR3, USART_CR3_RTSE);\
1013 (__HANDLE__)->Init.HwFlowCtl &= ~(USART_CR3_RTSE); \
1014 } while(0U)
1015 /**
1016 * @}
1017 */
1018
1019 /* Private macros --------------------------------------------------------*/
1020 /** @defgroup UART_Private_Macros UART Private Macros
1021 * @{
1022 */
1023
1024
1025 /** @brief BRR division operation to set BRR register in 8-bit oversampling mode.
1026 * @param __PCLK__ UART clock.
1027 * @param __BAUD__ Baud rate set by the user.
1028 * @retval Division result
1029 */
1030 #define UART_DIV_SAMPLING8(__PCLK__, __BAUD__) ((((__PCLK__)*2U) + ((__BAUD__)/2U)) / (__BAUD__))
1031
1032 /** @brief BRR division operation to set BRR register in 16-bit oversampling mode.
1033 * @param __PCLK__ UART clock.
1034 * @param __BAUD__ Baud rate set by the user.
1035 * @retval Division result
1036 */
1037 #define UART_DIV_SAMPLING16(__PCLK__, __BAUD__) (((__PCLK__) + ((__BAUD__)/2U)) / (__BAUD__))
1038
1039
1040 /** @brief Check UART Baud rate.
1041 * @param __BAUDRATE__ Baudrate specified by the user.
1042 * The maximum Baud Rate is derived from the maximum clock on F7 (i.e. 216 MHz)
1043 * divided by the smallest oversampling used on the USART (i.e. 8)
1044 * @retval SET (__BAUDRATE__ is valid) or RESET (__BAUDRATE__ is invalid)
1045 */
1046 #define IS_UART_BAUDRATE(__BAUDRATE__) ((__BAUDRATE__) < 27000001U)
1047
1048 /** @brief Check UART assertion time.
1049 * @param __TIME__ 5-bit value assertion time.
1050 * @retval Test result (TRUE or FALSE).
1051 */
1052 #define IS_UART_ASSERTIONTIME(__TIME__) ((__TIME__) <= 0x1FU)
1053
1054 /** @brief Check UART deassertion time.
1055 * @param __TIME__ 5-bit value deassertion time.
1056 * @retval Test result (TRUE or FALSE).
1057 */
1058 #define IS_UART_DEASSERTIONTIME(__TIME__) ((__TIME__) <= 0x1FU)
1059
1060 /**
1061 * @brief Ensure that UART frame number of stop bits is valid.
1062 * @param __STOPBITS__ UART frame number of stop bits.
1063 * @retval SET (__STOPBITS__ is valid) or RESET (__STOPBITS__ is invalid)
1064 */
1065 #define IS_UART_STOPBITS(__STOPBITS__) (((__STOPBITS__) == UART_STOPBITS_0_5) || \
1066 ((__STOPBITS__) == UART_STOPBITS_1) || \
1067 ((__STOPBITS__) == UART_STOPBITS_1_5) || \
1068 ((__STOPBITS__) == UART_STOPBITS_2))
1069
1070
1071 /**
1072 * @brief Ensure that UART frame parity is valid.
1073 * @param __PARITY__ UART frame parity.
1074 * @retval SET (__PARITY__ is valid) or RESET (__PARITY__ is invalid)
1075 */
1076 #define IS_UART_PARITY(__PARITY__) (((__PARITY__) == UART_PARITY_NONE) || \
1077 ((__PARITY__) == UART_PARITY_EVEN) || \
1078 ((__PARITY__) == UART_PARITY_ODD))
1079
1080 /**
1081 * @brief Ensure that UART hardware flow control is valid.
1082 * @param __CONTROL__ UART hardware flow control.
1083 * @retval SET (__CONTROL__ is valid) or RESET (__CONTROL__ is invalid)
1084 */
1085 #define IS_UART_HARDWARE_FLOW_CONTROL(__CONTROL__)\
1086 (((__CONTROL__) == UART_HWCONTROL_NONE) || \
1087 ((__CONTROL__) == UART_HWCONTROL_RTS) || \
1088 ((__CONTROL__) == UART_HWCONTROL_CTS) || \
1089 ((__CONTROL__) == UART_HWCONTROL_RTS_CTS))
1090
1091 /**
1092 * @brief Ensure that UART communication mode is valid.
1093 * @param __MODE__ UART communication mode.
1094 * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid)
1095 */
1096 #define IS_UART_MODE(__MODE__) ((((__MODE__) & (~((uint32_t)(UART_MODE_TX_RX)))) == 0x00U) && ((__MODE__) != 0x00U))
1097
1098 /**
1099 * @brief Ensure that UART state is valid.
1100 * @param __STATE__ UART state.
1101 * @retval SET (__STATE__ is valid) or RESET (__STATE__ is invalid)
1102 */
1103 #define IS_UART_STATE(__STATE__) (((__STATE__) == UART_STATE_DISABLE) || \
1104 ((__STATE__) == UART_STATE_ENABLE))
1105
1106 /**
1107 * @brief Ensure that UART oversampling is valid.
1108 * @param __SAMPLING__ UART oversampling.
1109 * @retval SET (__SAMPLING__ is valid) or RESET (__SAMPLING__ is invalid)
1110 */
1111 #define IS_UART_OVERSAMPLING(__SAMPLING__) (((__SAMPLING__) == UART_OVERSAMPLING_16) || \
1112 ((__SAMPLING__) == UART_OVERSAMPLING_8))
1113
1114 /**
1115 * @brief Ensure that UART frame sampling is valid.
1116 * @param __ONEBIT__ UART frame sampling.
1117 * @retval SET (__ONEBIT__ is valid) or RESET (__ONEBIT__ is invalid)
1118 */
1119 #define IS_UART_ONE_BIT_SAMPLE(__ONEBIT__) (((__ONEBIT__) == UART_ONE_BIT_SAMPLE_DISABLE) || \
1120 ((__ONEBIT__) == UART_ONE_BIT_SAMPLE_ENABLE))
1121
1122 /**
1123 * @brief Ensure that UART auto Baud rate detection mode is valid.
1124 * @param __MODE__ UART auto Baud rate detection mode.
1125 * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid)
1126 */
1127 #define IS_UART_ADVFEATURE_AUTOBAUDRATEMODE(__MODE__) (((__MODE__) == UART_ADVFEATURE_AUTOBAUDRATE_ONSTARTBIT) || \
1128 ((__MODE__) == UART_ADVFEATURE_AUTOBAUDRATE_ONFALLINGEDGE) || \
1129 ((__MODE__) == UART_ADVFEATURE_AUTOBAUDRATE_ON0X7FFRAME) || \
1130 ((__MODE__) == UART_ADVFEATURE_AUTOBAUDRATE_ON0X55FRAME))
1131
1132 /**
1133 * @brief Ensure that UART receiver timeout setting is valid.
1134 * @param __TIMEOUT__ UART receiver timeout setting.
1135 * @retval SET (__TIMEOUT__ is valid) or RESET (__TIMEOUT__ is invalid)
1136 */
1137 #define IS_UART_RECEIVER_TIMEOUT(__TIMEOUT__) (((__TIMEOUT__) == UART_RECEIVER_TIMEOUT_DISABLE) || \
1138 ((__TIMEOUT__) == UART_RECEIVER_TIMEOUT_ENABLE))
1139
1140 /**
1141 * @brief Ensure that UART LIN state is valid.
1142 * @param __LIN__ UART LIN state.
1143 * @retval SET (__LIN__ is valid) or RESET (__LIN__ is invalid)
1144 */
1145 #define IS_UART_LIN(__LIN__) (((__LIN__) == UART_LIN_DISABLE) || \
1146 ((__LIN__) == UART_LIN_ENABLE))
1147
1148 /**
1149 * @brief Ensure that UART LIN break detection length is valid.
1150 * @param __LENGTH__ UART LIN break detection length.
1151 * @retval SET (__LENGTH__ is valid) or RESET (__LENGTH__ is invalid)
1152 */
1153 #define IS_UART_LIN_BREAK_DETECT_LENGTH(__LENGTH__) (((__LENGTH__) == UART_LINBREAKDETECTLENGTH_10B) || \
1154 ((__LENGTH__) == UART_LINBREAKDETECTLENGTH_11B))
1155
1156 /**
1157 * @brief Ensure that UART DMA TX state is valid.
1158 * @param __DMATX__ UART DMA TX state.
1159 * @retval SET (__DMATX__ is valid) or RESET (__DMATX__ is invalid)
1160 */
1161 #define IS_UART_DMA_TX(__DMATX__) (((__DMATX__) == UART_DMA_TX_DISABLE) || \
1162 ((__DMATX__) == UART_DMA_TX_ENABLE))
1163
1164 /**
1165 * @brief Ensure that UART DMA RX state is valid.
1166 * @param __DMARX__ UART DMA RX state.
1167 * @retval SET (__DMARX__ is valid) or RESET (__DMARX__ is invalid)
1168 */
1169 #define IS_UART_DMA_RX(__DMARX__) (((__DMARX__) == UART_DMA_RX_DISABLE) || \
1170 ((__DMARX__) == UART_DMA_RX_ENABLE))
1171
1172 /**
1173 * @brief Ensure that UART half-duplex state is valid.
1174 * @param __HDSEL__ UART half-duplex state.
1175 * @retval SET (__HDSEL__ is valid) or RESET (__HDSEL__ is invalid)
1176 */
1177 #define IS_UART_HALF_DUPLEX(__HDSEL__) (((__HDSEL__) == UART_HALF_DUPLEX_DISABLE) || \
1178 ((__HDSEL__) == UART_HALF_DUPLEX_ENABLE))
1179
1180 /**
1181 * @brief Ensure that UART wake-up method is valid.
1182 * @param __WAKEUP__ UART wake-up method .
1183 * @retval SET (__WAKEUP__ is valid) or RESET (__WAKEUP__ is invalid)
1184 */
1185 #define IS_UART_WAKEUPMETHOD(__WAKEUP__) (((__WAKEUP__) == UART_WAKEUPMETHOD_IDLELINE) || \
1186 ((__WAKEUP__) == UART_WAKEUPMETHOD_ADDRESSMARK))
1187
1188 /**
1189 * @brief Ensure that UART request parameter is valid.
1190 * @param __PARAM__ UART request parameter.
1191 * @retval SET (__PARAM__ is valid) or RESET (__PARAM__ is invalid)
1192 */
1193 #define IS_UART_REQUEST_PARAMETER(__PARAM__) (((__PARAM__) == UART_AUTOBAUD_REQUEST) || \
1194 ((__PARAM__) == UART_SENDBREAK_REQUEST) || \
1195 ((__PARAM__) == UART_MUTE_MODE_REQUEST) || \
1196 ((__PARAM__) == UART_RXDATA_FLUSH_REQUEST) || \
1197 ((__PARAM__) == UART_TXDATA_FLUSH_REQUEST))
1198
1199 /**
1200 * @brief Ensure that UART advanced features initialization is valid.
1201 * @param __INIT__ UART advanced features initialization.
1202 * @retval SET (__INIT__ is valid) or RESET (__INIT__ is invalid)
1203 */
1204 #define IS_UART_ADVFEATURE_INIT(__INIT__) ((__INIT__) <= (UART_ADVFEATURE_NO_INIT | \
1205 UART_ADVFEATURE_TXINVERT_INIT | \
1206 UART_ADVFEATURE_RXINVERT_INIT | \
1207 UART_ADVFEATURE_DATAINVERT_INIT | \
1208 UART_ADVFEATURE_SWAP_INIT | \
1209 UART_ADVFEATURE_RXOVERRUNDISABLE_INIT | \
1210 UART_ADVFEATURE_DMADISABLEONERROR_INIT | \
1211 UART_ADVFEATURE_AUTOBAUDRATE_INIT | \
1212 UART_ADVFEATURE_MSBFIRST_INIT))
1213
1214 /**
1215 * @brief Ensure that UART frame TX inversion setting is valid.
1216 * @param __TXINV__ UART frame TX inversion setting.
1217 * @retval SET (__TXINV__ is valid) or RESET (__TXINV__ is invalid)
1218 */
1219 #define IS_UART_ADVFEATURE_TXINV(__TXINV__) (((__TXINV__) == UART_ADVFEATURE_TXINV_DISABLE) || \
1220 ((__TXINV__) == UART_ADVFEATURE_TXINV_ENABLE))
1221
1222 /**
1223 * @brief Ensure that UART frame RX inversion setting is valid.
1224 * @param __RXINV__ UART frame RX inversion setting.
1225 * @retval SET (__RXINV__ is valid) or RESET (__RXINV__ is invalid)
1226 */
1227 #define IS_UART_ADVFEATURE_RXINV(__RXINV__) (((__RXINV__) == UART_ADVFEATURE_RXINV_DISABLE) || \
1228 ((__RXINV__) == UART_ADVFEATURE_RXINV_ENABLE))
1229
1230 /**
1231 * @brief Ensure that UART frame data inversion setting is valid.
1232 * @param __DATAINV__ UART frame data inversion setting.
1233 * @retval SET (__DATAINV__ is valid) or RESET (__DATAINV__ is invalid)
1234 */
1235 #define IS_UART_ADVFEATURE_DATAINV(__DATAINV__) (((__DATAINV__) == UART_ADVFEATURE_DATAINV_DISABLE) || \
1236 ((__DATAINV__) == UART_ADVFEATURE_DATAINV_ENABLE))
1237
1238 /**
1239 * @brief Ensure that UART frame RX/TX pins swap setting is valid.
1240 * @param __SWAP__ UART frame RX/TX pins swap setting.
1241 * @retval SET (__SWAP__ is valid) or RESET (__SWAP__ is invalid)
1242 */
1243 #define IS_UART_ADVFEATURE_SWAP(__SWAP__) (((__SWAP__) == UART_ADVFEATURE_SWAP_DISABLE) || \
1244 ((__SWAP__) == UART_ADVFEATURE_SWAP_ENABLE))
1245
1246 /**
1247 * @brief Ensure that UART frame overrun setting is valid.
1248 * @param __OVERRUN__ UART frame overrun setting.
1249 * @retval SET (__OVERRUN__ is valid) or RESET (__OVERRUN__ is invalid)
1250 */
1251 #define IS_UART_OVERRUN(__OVERRUN__) (((__OVERRUN__) == UART_ADVFEATURE_OVERRUN_ENABLE) || \
1252 ((__OVERRUN__) == UART_ADVFEATURE_OVERRUN_DISABLE))
1253
1254 /**
1255 * @brief Ensure that UART auto Baud rate state is valid.
1256 * @param __AUTOBAUDRATE__ UART auto Baud rate state.
1257 * @retval SET (__AUTOBAUDRATE__ is valid) or RESET (__AUTOBAUDRATE__ is invalid)
1258 */
1259 #define IS_UART_ADVFEATURE_AUTOBAUDRATE(__AUTOBAUDRATE__) (((__AUTOBAUDRATE__) == UART_ADVFEATURE_AUTOBAUDRATE_DISABLE) || \
1260 ((__AUTOBAUDRATE__) == UART_ADVFEATURE_AUTOBAUDRATE_ENABLE))
1261
1262 /**
1263 * @brief Ensure that UART DMA enabling or disabling on error setting is valid.
1264 * @param __DMA__ UART DMA enabling or disabling on error setting.
1265 * @retval SET (__DMA__ is valid) or RESET (__DMA__ is invalid)
1266 */
1267 #define IS_UART_ADVFEATURE_DMAONRXERROR(__DMA__) (((__DMA__) == UART_ADVFEATURE_DMA_ENABLEONRXERROR) || \
1268 ((__DMA__) == UART_ADVFEATURE_DMA_DISABLEONRXERROR))
1269
1270 /**
1271 * @brief Ensure that UART frame MSB first setting is valid.
1272 * @param __MSBFIRST__ UART frame MSB first setting.
1273 * @retval SET (__MSBFIRST__ is valid) or RESET (__MSBFIRST__ is invalid)
1274 */
1275 #define IS_UART_ADVFEATURE_MSBFIRST(__MSBFIRST__) (((__MSBFIRST__) == UART_ADVFEATURE_MSBFIRST_DISABLE) || \
1276 ((__MSBFIRST__) == UART_ADVFEATURE_MSBFIRST_ENABLE))
1277
1278 /**
1279 * @brief Ensure that UART mute mode state is valid.
1280 * @param __MUTE__ UART mute mode state.
1281 * @retval SET (__MUTE__ is valid) or RESET (__MUTE__ is invalid)
1282 */
1283 #define IS_UART_MUTE_MODE(__MUTE__) (((__MUTE__) == UART_ADVFEATURE_MUTEMODE_DISABLE) || \
1284 ((__MUTE__) == UART_ADVFEATURE_MUTEMODE_ENABLE))
1285
1286 /**
1287 * @brief Ensure that UART driver enable polarity is valid.
1288 * @param __POLARITY__ UART driver enable polarity.
1289 * @retval SET (__POLARITY__ is valid) or RESET (__POLARITY__ is invalid)
1290 */
1291 #define IS_UART_DE_POLARITY(__POLARITY__) (((__POLARITY__) == UART_DE_POLARITY_HIGH) || \
1292 ((__POLARITY__) == UART_DE_POLARITY_LOW))
1293
1294
1295 /**
1296 * @}
1297 */
1298
1299 /* Include UART HAL Extended module */
1300 #include "stm32f7xx_hal_uart_ex.h"
1301
1302
1303 /* Exported functions --------------------------------------------------------*/
1304 /** @addtogroup UART_Exported_Functions UART Exported Functions
1305 * @{
1306 */
1307
1308 /** @addtogroup UART_Exported_Functions_Group1 Initialization and de-initialization functions
1309 * @{
1310 */
1311
1312 /* Initialization and de-initialization functions ****************************/
1313 HAL_StatusTypeDef HAL_UART_Init(UART_HandleTypeDef *huart);
1314 HAL_StatusTypeDef HAL_HalfDuplex_Init(UART_HandleTypeDef *huart);
1315 HAL_StatusTypeDef HAL_LIN_Init(UART_HandleTypeDef *huart, uint32_t BreakDetectLength);
1316 HAL_StatusTypeDef HAL_MultiProcessor_Init(UART_HandleTypeDef *huart, uint8_t Address, uint32_t WakeUpMethod);
1317 HAL_StatusTypeDef HAL_UART_DeInit(UART_HandleTypeDef *huart);
1318 void HAL_UART_MspInit(UART_HandleTypeDef *huart);
1319 void HAL_UART_MspDeInit(UART_HandleTypeDef *huart);
1320
1321 /* Callbacks Register/UnRegister functions ***********************************/
1322 #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
1323 HAL_StatusTypeDef HAL_UART_RegisterCallback(UART_HandleTypeDef *huart, HAL_UART_CallbackIDTypeDef CallbackID, pUART_CallbackTypeDef pCallback);
1324 HAL_StatusTypeDef HAL_UART_UnRegisterCallback(UART_HandleTypeDef *huart, HAL_UART_CallbackIDTypeDef CallbackID);
1325 #endif /* USE_HAL_UART_REGISTER_CALLBACKS */
1326
1327 /**
1328 * @}
1329 */
1330
1331 /** @addtogroup UART_Exported_Functions_Group2 IO operation functions
1332 * @{
1333 */
1334
1335 /* IO operation functions *****************************************************/
1336 HAL_StatusTypeDef HAL_UART_Transmit(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size, uint32_t Timeout);
1337 HAL_StatusTypeDef HAL_UART_Receive(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size, uint32_t Timeout);
1338 HAL_StatusTypeDef HAL_UART_Transmit_IT(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
1339 HAL_StatusTypeDef HAL_UART_Receive_IT(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
1340 HAL_StatusTypeDef HAL_UART_Transmit_DMA(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
1341 HAL_StatusTypeDef HAL_UART_Receive_DMA(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
1342 HAL_StatusTypeDef HAL_UART_DMAPause(UART_HandleTypeDef *huart);
1343 HAL_StatusTypeDef HAL_UART_DMAResume(UART_HandleTypeDef *huart);
1344 HAL_StatusTypeDef HAL_UART_DMAStop(UART_HandleTypeDef *huart);
1345 /* Transfer Abort functions */
1346 HAL_StatusTypeDef HAL_UART_Abort(UART_HandleTypeDef *huart);
1347 HAL_StatusTypeDef HAL_UART_AbortTransmit(UART_HandleTypeDef *huart);
1348 HAL_StatusTypeDef HAL_UART_AbortReceive(UART_HandleTypeDef *huart);
1349 HAL_StatusTypeDef HAL_UART_Abort_IT(UART_HandleTypeDef *huart);
1350 HAL_StatusTypeDef HAL_UART_AbortTransmit_IT(UART_HandleTypeDef *huart);
1351 HAL_StatusTypeDef HAL_UART_AbortReceive_IT(UART_HandleTypeDef *huart);
1352
1353 void HAL_UART_IRQHandler(UART_HandleTypeDef *huart);
1354 void HAL_UART_TxHalfCpltCallback(UART_HandleTypeDef *huart);
1355 void HAL_UART_TxCpltCallback(UART_HandleTypeDef *huart);
1356 void HAL_UART_RxHalfCpltCallback(UART_HandleTypeDef *huart);
1357 void HAL_UART_RxCpltCallback(UART_HandleTypeDef *huart);
1358 void HAL_UART_ErrorCallback(UART_HandleTypeDef *huart);
1359 void HAL_UART_AbortCpltCallback(UART_HandleTypeDef *huart);
1360 void HAL_UART_AbortTransmitCpltCallback(UART_HandleTypeDef *huart);
1361 void HAL_UART_AbortReceiveCpltCallback(UART_HandleTypeDef *huart);
1362
1363 /**
1364 * @}
1365 */
1366
1367 /** @addtogroup UART_Exported_Functions_Group3 Peripheral Control functions
1368 * @{
1369 */
1370
1371 /* Peripheral Control functions ************************************************/
1372 HAL_StatusTypeDef HAL_LIN_SendBreak(UART_HandleTypeDef *huart);
1373 HAL_StatusTypeDef HAL_MultiProcessor_EnableMuteMode(UART_HandleTypeDef *huart);
1374 HAL_StatusTypeDef HAL_MultiProcessor_DisableMuteMode(UART_HandleTypeDef *huart);
1375 void HAL_MultiProcessor_EnterMuteMode(UART_HandleTypeDef *huart);
1376 HAL_StatusTypeDef HAL_HalfDuplex_EnableTransmitter(UART_HandleTypeDef *huart);
1377 HAL_StatusTypeDef HAL_HalfDuplex_EnableReceiver(UART_HandleTypeDef *huart);
1378
1379 /**
1380 * @}
1381 */
1382
1383 /** @addtogroup UART_Exported_Functions_Group4 Peripheral State and Error functions
1384 * @{
1385 */
1386
1387 /* Peripheral State and Errors functions **************************************************/
1388 HAL_UART_StateTypeDef HAL_UART_GetState(UART_HandleTypeDef *huart);
1389 uint32_t HAL_UART_GetError(UART_HandleTypeDef *huart);
1390
1391 /**
1392 * @}
1393 */
1394
1395 /**
1396 * @}
1397 */
1398
1399 /* Private functions -----------------------------------------------------------*/
1400 /** @addtogroup UART_Private_Functions UART Private Functions
1401 * @{
1402 */
1403 #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
1404 void UART_InitCallbacksToDefault(UART_HandleTypeDef *huart);
1405 #endif /* USE_HAL_UART_REGISTER_CALLBACKS */
1406 HAL_StatusTypeDef UART_SetConfig(UART_HandleTypeDef *huart);
1407 HAL_StatusTypeDef UART_CheckIdleState(UART_HandleTypeDef *huart);
1408 HAL_StatusTypeDef UART_WaitOnFlagUntilTimeout(UART_HandleTypeDef *huart, uint32_t Flag, FlagStatus Status, uint32_t Tickstart, uint32_t Timeout);
1409 void UART_AdvFeatureConfig(UART_HandleTypeDef *huart);
1410
1411 /**
1412 * @}
1413 */
1414
1415 /**
1416 * @}
1417 */
1418
1419 /**
1420 * @}
1421 */
1422
1423 #ifdef __cplusplus
1424 }
1425 #endif
1426
1427 #endif /* STM32F7xx_HAL_UART_H */
1428
1429 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/