2 ******************************************************************************
\r
3 * @file stm32f7xx_hal_uart.c
\r
4 * @author MCD Application Team
\r
5 * @brief UART HAL module driver.
\r
6 * This file provides firmware functions to manage the following
\r
7 * functionalities of the Universal Asynchronous Receiver Transmitter Peripheral (UART).
\r
8 * + Initialization and de-initialization functions
\r
9 * + IO operation functions
\r
10 * + Peripheral Control functions
\r
14 ===============================================================================
\r
15 ##### How to use this driver #####
\r
16 ===============================================================================
\r
18 The UART HAL driver can be used as follows:
\r
20 (#) Declare a UART_HandleTypeDef handle structure (eg. UART_HandleTypeDef huart).
\r
21 (#) Initialize the UART low level resources by implementing the HAL_UART_MspInit() API:
\r
22 (++) Enable the USARTx interface clock.
\r
23 (++) UART pins configuration:
\r
24 (+++) Enable the clock for the UART GPIOs.
\r
25 (+++) Configure these UART pins as alternate function pull-up.
\r
26 (++) NVIC configuration if you need to use interrupt process (HAL_UART_Transmit_IT()
\r
27 and HAL_UART_Receive_IT() APIs):
\r
28 (+++) Configure the USARTx interrupt priority.
\r
29 (+++) Enable the NVIC USART IRQ handle.
\r
30 (++) UART interrupts handling:
\r
31 -@@- The specific UART interrupts (Transmission complete interrupt,
\r
32 RXNE interrupt, RX/TX FIFOs related interrupts and Error Interrupts)
\r
33 are managed using the macros __HAL_UART_ENABLE_IT() and __HAL_UART_DISABLE_IT()
\r
34 inside the transmit and receive processes.
\r
35 (++) DMA Configuration if you need to use DMA process (HAL_UART_Transmit_DMA()
\r
36 and HAL_UART_Receive_DMA() APIs):
\r
37 (+++) Declare a DMA handle structure for the Tx/Rx channel.
\r
38 (+++) Enable the DMAx interface clock.
\r
39 (+++) Configure the declared DMA handle structure with the required Tx/Rx parameters.
\r
40 (+++) Configure the DMA Tx/Rx channel.
\r
41 (+++) Associate the initialized DMA handle to the UART DMA Tx/Rx handle.
\r
42 (+++) Configure the priority and enable the NVIC for the transfer complete interrupt on the DMA Tx/Rx channel.
\r
44 (#) Program the Baud Rate, Word Length, Stop Bit, Parity, Hardware
\r
45 flow control and Mode (Receiver/Transmitter) in the huart handle Init structure.
\r
47 (#) If required, program UART advanced features (TX/RX pins swap, auto Baud rate detection,...)
\r
48 in the huart handle AdvancedInit structure.
\r
50 (#) For the UART asynchronous mode, initialize the UART registers by calling
\r
51 the HAL_UART_Init() API.
\r
53 (#) For the UART Half duplex mode, initialize the UART registers by calling
\r
54 the HAL_HalfDuplex_Init() API.
\r
56 (#) For the UART LIN (Local Interconnection Network) mode, initialize the UART registers
\r
57 by calling the HAL_LIN_Init() API.
\r
59 (#) For the UART Multiprocessor mode, initialize the UART registers
\r
60 by calling the HAL_MultiProcessor_Init() API.
\r
62 (#) For the UART RS485 Driver Enabled mode, initialize the UART registers
\r
63 by calling the HAL_RS485Ex_Init() API.
\r
66 (@) These API's (HAL_UART_Init(), HAL_HalfDuplex_Init(), HAL_LIN_Init(), HAL_MultiProcessor_Init(),
\r
67 also configure the low level Hardware GPIO, CLOCK, CORTEX...etc) by
\r
68 calling the customized HAL_UART_MspInit() API.
\r
70 ##### Callback registration #####
\r
71 ==================================
\r
74 The compilation define USE_HAL_UART_REGISTER_CALLBACKS when set to 1
\r
75 allows the user to configure dynamically the driver callbacks.
\r
78 Use Function @ref HAL_UART_RegisterCallback() to register a user callback.
\r
79 Function @ref HAL_UART_RegisterCallback() allows to register following callbacks:
\r
80 (+) TxHalfCpltCallback : Tx Half Complete Callback.
\r
81 (+) TxCpltCallback : Tx Complete Callback.
\r
82 (+) RxHalfCpltCallback : Rx Half Complete Callback.
\r
83 (+) RxCpltCallback : Rx Complete Callback.
\r
84 (+) ErrorCallback : Error Callback.
\r
85 (+) AbortCpltCallback : Abort Complete Callback.
\r
86 (+) AbortTransmitCpltCallback : Abort Transmit Complete Callback.
\r
87 (+) AbortReceiveCpltCallback : Abort Receive Complete Callback.
\r
88 (+) WakeupCallback : Wakeup Callback.
\r
89 (+) RxFifoFullCallback : Rx Fifo Full Callback.
\r
90 (+) TxFifoEmptyCallback : Tx Fifo Empty Callback.
\r
91 (+) MspInitCallback : UART MspInit.
\r
92 (+) MspDeInitCallback : UART MspDeInit.
\r
93 This function takes as parameters the HAL peripheral handle, the Callback ID
\r
94 and a pointer to the user callback function.
\r
97 Use function @ref HAL_UART_UnRegisterCallback() to reset a callback to the default
\r
98 weak (surcharged) function.
\r
99 @ref HAL_UART_UnRegisterCallback() takes as parameters the HAL peripheral handle,
\r
100 and the Callback ID.
\r
101 This function allows to reset following callbacks:
\r
102 (+) TxHalfCpltCallback : Tx Half Complete Callback.
\r
103 (+) TxCpltCallback : Tx Complete Callback.
\r
104 (+) RxHalfCpltCallback : Rx Half Complete Callback.
\r
105 (+) RxCpltCallback : Rx Complete Callback.
\r
106 (+) ErrorCallback : Error Callback.
\r
107 (+) AbortCpltCallback : Abort Complete Callback.
\r
108 (+) AbortTransmitCpltCallback : Abort Transmit Complete Callback.
\r
109 (+) AbortReceiveCpltCallback : Abort Receive Complete Callback.
\r
110 (+) WakeupCallback : Wakeup Callback.
\r
111 (+) RxFifoFullCallback : Rx Fifo Full Callback.
\r
112 (+) TxFifoEmptyCallback : Tx Fifo Empty Callback.
\r
113 (+) MspInitCallback : UART MspInit.
\r
114 (+) MspDeInitCallback : UART MspDeInit.
\r
117 By default, after the @ref HAL_UART_Init() and when the state is HAL_UART_STATE_RESET
\r
118 all callbacks are set to the corresponding weak (surcharged) functions:
\r
119 examples @ref HAL_UART_TxCpltCallback(), @ref HAL_UART_RxHalfCpltCallback().
\r
120 Exception done for MspInit and MspDeInit functions that are respectively
\r
121 reset to the legacy weak (surcharged) functions in the @ref HAL_UART_Init()
\r
122 and @ref HAL_UART_DeInit() only when these callbacks are null (not registered beforehand).
\r
123 If not, MspInit or MspDeInit are not null, the @ref HAL_UART_Init() and @ref HAL_UART_DeInit()
\r
124 keep and use the user MspInit/MspDeInit callbacks (registered beforehand).
\r
127 Callbacks can be registered/unregistered in HAL_UART_STATE_READY state only.
\r
128 Exception done MspInit/MspDeInit that can be registered/unregistered
\r
129 in HAL_UART_STATE_READY or HAL_UART_STATE_RESET state, thus registered (user)
\r
130 MspInit/DeInit callbacks can be used during the Init/DeInit.
\r
131 In that case first register the MspInit/MspDeInit user callbacks
\r
132 using @ref HAL_UART_RegisterCallback() before calling @ref HAL_UART_DeInit()
\r
133 or @ref HAL_UART_Init() function.
\r
136 When The compilation define USE_HAL_UART_REGISTER_CALLBACKS is set to 0 or
\r
137 not defined, the callback registration feature is not available
\r
138 and weak (surcharged) callbacks are used.
\r
142 ******************************************************************************
\r
145 * <h2><center>© Copyright (c) 2017 STMicroelectronics.
\r
146 * All rights reserved.</center></h2>
\r
148 * This software component is licensed by ST under BSD 3-Clause license,
\r
149 * the "License"; You may not use this file except in compliance with the
\r
150 * License. You may obtain a copy of the License at:
\r
151 * opensource.org/licenses/BSD-3-Clause
\r
153 ******************************************************************************
\r
156 /* Includes ------------------------------------------------------------------*/
\r
157 #include "stm32f7xx_hal.h"
\r
159 /** @addtogroup STM32F7xx_HAL_Driver
\r
163 /** @defgroup UART UART
\r
164 * @brief HAL UART module driver
\r
168 #ifdef HAL_UART_MODULE_ENABLED
\r
170 /* Private typedef -----------------------------------------------------------*/
\r
171 /* Private define ------------------------------------------------------------*/
\r
172 /** @defgroup UART_Private_Constants UART Private Constants
\r
175 #define USART_CR1_FIELDS ((uint32_t)(USART_CR1_M | USART_CR1_PCE | USART_CR1_PS | \
\r
176 USART_CR1_TE | USART_CR1_RE | USART_CR1_OVER8 )) /*!< UART or USART CR1 fields of parameters set by UART_SetConfig API */
\r
178 #define USART_CR3_FIELDS ((uint32_t)(USART_CR3_RTSE | USART_CR3_CTSE | USART_CR3_ONEBIT)) /*!< UART or USART CR3 fields of parameters set by UART_SetConfig API */
\r
181 #define UART_BRR_MIN 0x10U /* UART BRR minimum authorized value */
\r
182 #define UART_BRR_MAX 0x0000FFFFU /* UART BRR maximum authorized value */
\r
188 /* Private macros ------------------------------------------------------------*/
\r
189 /* Private variables ---------------------------------------------------------*/
\r
190 /* Private function prototypes -----------------------------------------------*/
\r
191 /** @addtogroup UART_Private_Functions
\r
194 static void UART_EndTxTransfer(UART_HandleTypeDef *huart);
\r
195 static void UART_EndRxTransfer(UART_HandleTypeDef *huart);
\r
196 static void UART_DMATransmitCplt(DMA_HandleTypeDef *hdma);
\r
197 static void UART_DMAReceiveCplt(DMA_HandleTypeDef *hdma);
\r
198 static void UART_DMARxHalfCplt(DMA_HandleTypeDef *hdma);
\r
199 static void UART_DMATxHalfCplt(DMA_HandleTypeDef *hdma);
\r
200 static void UART_DMAError(DMA_HandleTypeDef *hdma);
\r
201 static void UART_DMAAbortOnError(DMA_HandleTypeDef *hdma);
\r
202 static void UART_DMATxAbortCallback(DMA_HandleTypeDef *hdma);
\r
203 static void UART_DMARxAbortCallback(DMA_HandleTypeDef *hdma);
\r
204 static void UART_DMATxOnlyAbortCallback(DMA_HandleTypeDef *hdma);
\r
205 static void UART_DMARxOnlyAbortCallback(DMA_HandleTypeDef *hdma);
\r
206 static void UART_TxISR_8BIT(UART_HandleTypeDef *huart);
\r
207 static void UART_TxISR_16BIT(UART_HandleTypeDef *huart);
\r
208 static void UART_EndTransmit_IT(UART_HandleTypeDef *huart);
\r
209 static void UART_RxISR_8BIT(UART_HandleTypeDef *huart);
\r
210 static void UART_RxISR_16BIT(UART_HandleTypeDef *huart);
\r
215 /* Exported functions --------------------------------------------------------*/
\r
217 /** @defgroup UART_Exported_Functions UART Exported Functions
\r
221 /** @defgroup UART_Exported_Functions_Group1 Initialization and de-initialization functions
\r
222 * @brief Initialization and Configuration functions
\r
225 ===============================================================================
\r
226 ##### Initialization and Configuration functions #####
\r
227 ===============================================================================
\r
229 This subsection provides a set of functions allowing to initialize the USARTx or the UARTy
\r
230 in asynchronous mode.
\r
231 (+) For the asynchronous mode the parameters below can be configured:
\r
235 (++) Parity: If the parity is enabled, then the MSB bit of the data written
\r
236 in the data register is transmitted but is changed by the parity bit.
\r
237 (++) Hardware flow control
\r
238 (++) Receiver/transmitter modes
\r
239 (++) Over Sampling Method
\r
240 (++) One-Bit Sampling Method
\r
241 (+) For the asynchronous mode, the following advanced features can be configured as well:
\r
242 (++) TX and/or RX pin level inversion
\r
243 (++) data logical level inversion
\r
244 (++) RX and TX pins swap
\r
245 (++) RX overrun detection disabling
\r
246 (++) DMA disabling on RX error
\r
247 (++) MSB first on communication line
\r
248 (++) auto Baud rate detection
\r
250 The HAL_UART_Init(), HAL_HalfDuplex_Init(), HAL_LIN_Init()and HAL_MultiProcessor_Init()API
\r
251 follow respectively the UART asynchronous, UART Half duplex, UART LIN mode
\r
252 and UART multiprocessor mode configuration procedures (details for the procedures
\r
253 are available in reference manual).
\r
257 Depending on the frame length defined by the M1 and M0 bits (7-bit,
\r
258 8-bit or 9-bit), the possible UART formats are listed in the
\r
261 Table 1. UART frame format.
\r
262 +-----------------------------------------------------------------------+
\r
263 | M1 bit | M0 bit | PCE bit | UART frame |
\r
264 |---------|---------|-----------|---------------------------------------|
\r
265 | 0 | 0 | 0 | | SB | 8 bit data | STB | |
\r
266 |---------|---------|-----------|---------------------------------------|
\r
267 | 0 | 0 | 1 | | SB | 7 bit data | PB | STB | |
\r
268 |---------|---------|-----------|---------------------------------------|
\r
269 | 0 | 1 | 0 | | SB | 9 bit data | STB | |
\r
270 |---------|---------|-----------|---------------------------------------|
\r
271 | 0 | 1 | 1 | | SB | 8 bit data | PB | STB | |
\r
272 |---------|---------|-----------|---------------------------------------|
\r
273 | 1 | 0 | 0 | | SB | 7 bit data | STB | |
\r
274 |---------|---------|-----------|---------------------------------------|
\r
275 | 1 | 0 | 1 | | SB | 6 bit data | PB | STB | |
\r
276 +-----------------------------------------------------------------------+
\r
282 * @brief Initialize the UART mode according to the specified
\r
283 * parameters in the UART_InitTypeDef and initialize the associated handle.
\r
284 * @param huart UART handle.
\r
285 * @retval HAL status
\r
287 HAL_StatusTypeDef HAL_UART_Init(UART_HandleTypeDef *huart)
\r
289 /* Check the UART handle allocation */
\r
295 if (huart->Init.HwFlowCtl != UART_HWCONTROL_NONE)
\r
297 /* Check the parameters */
\r
298 assert_param(IS_UART_HWFLOW_INSTANCE(huart->Instance));
\r
302 /* Check the parameters */
\r
303 assert_param(IS_UART_INSTANCE(huart->Instance));
\r
306 if (huart->gState == HAL_UART_STATE_RESET)
\r
308 /* Allocate lock resource and initialize it */
\r
309 huart->Lock = HAL_UNLOCKED;
\r
311 #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
\r
312 UART_InitCallbacksToDefault(huart);
\r
314 if (huart->MspInitCallback == NULL)
\r
316 huart->MspInitCallback = HAL_UART_MspInit;
\r
319 /* Init the low level hardware */
\r
320 huart->MspInitCallback(huart);
\r
322 /* Init the low level hardware : GPIO, CLOCK */
\r
323 HAL_UART_MspInit(huart);
\r
324 #endif /* (USE_HAL_UART_REGISTER_CALLBACKS) */
\r
327 huart->gState = HAL_UART_STATE_BUSY;
\r
329 /* Disable the Peripheral */
\r
330 __HAL_UART_DISABLE(huart);
\r
332 /* Set the UART Communication parameters */
\r
333 if (UART_SetConfig(huart) == HAL_ERROR)
\r
338 if (huart->AdvancedInit.AdvFeatureInit != UART_ADVFEATURE_NO_INIT)
\r
340 UART_AdvFeatureConfig(huart);
\r
343 /* In asynchronous mode, the following bits must be kept cleared:
\r
344 - LINEN and CLKEN bits in the USART_CR2 register,
\r
345 - SCEN, HDSEL and IREN bits in the USART_CR3 register.*/
\r
346 CLEAR_BIT(huart->Instance->CR2, (USART_CR2_LINEN | USART_CR2_CLKEN));
\r
347 CLEAR_BIT(huart->Instance->CR3, (USART_CR3_SCEN | USART_CR3_HDSEL | USART_CR3_IREN));
\r
349 /* Enable the Peripheral */
\r
350 __HAL_UART_ENABLE(huart);
\r
352 /* TEACK and/or REACK to check before moving huart->gState and huart->RxState to Ready */
\r
353 return (UART_CheckIdleState(huart));
\r
357 * @brief Initialize the half-duplex mode according to the specified
\r
358 * parameters in the UART_InitTypeDef and creates the associated handle.
\r
359 * @param huart UART handle.
\r
360 * @retval HAL status
\r
362 HAL_StatusTypeDef HAL_HalfDuplex_Init(UART_HandleTypeDef *huart)
\r
364 /* Check the UART handle allocation */
\r
370 /* Check UART instance */
\r
371 assert_param(IS_UART_HALFDUPLEX_INSTANCE(huart->Instance));
\r
373 if (huart->gState == HAL_UART_STATE_RESET)
\r
375 /* Allocate lock resource and initialize it */
\r
376 huart->Lock = HAL_UNLOCKED;
\r
378 #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
\r
379 UART_InitCallbacksToDefault(huart);
\r
381 if (huart->MspInitCallback == NULL)
\r
383 huart->MspInitCallback = HAL_UART_MspInit;
\r
386 /* Init the low level hardware */
\r
387 huart->MspInitCallback(huart);
\r
389 /* Init the low level hardware : GPIO, CLOCK */
\r
390 HAL_UART_MspInit(huart);
\r
391 #endif /* (USE_HAL_UART_REGISTER_CALLBACKS) */
\r
394 huart->gState = HAL_UART_STATE_BUSY;
\r
396 /* Disable the Peripheral */
\r
397 __HAL_UART_DISABLE(huart);
\r
399 /* Set the UART Communication parameters */
\r
400 if (UART_SetConfig(huart) == HAL_ERROR)
\r
405 if (huart->AdvancedInit.AdvFeatureInit != UART_ADVFEATURE_NO_INIT)
\r
407 UART_AdvFeatureConfig(huart);
\r
410 /* In half-duplex mode, the following bits must be kept cleared:
\r
411 - LINEN and CLKEN bits in the USART_CR2 register,
\r
412 - SCEN and IREN bits in the USART_CR3 register.*/
\r
413 CLEAR_BIT(huart->Instance->CR2, (USART_CR2_LINEN | USART_CR2_CLKEN));
\r
414 CLEAR_BIT(huart->Instance->CR3, (USART_CR3_IREN | USART_CR3_SCEN));
\r
416 /* Enable the Half-Duplex mode by setting the HDSEL bit in the CR3 register */
\r
417 SET_BIT(huart->Instance->CR3, USART_CR3_HDSEL);
\r
419 /* Enable the Peripheral */
\r
420 __HAL_UART_ENABLE(huart);
\r
422 /* TEACK and/or REACK to check before moving huart->gState and huart->RxState to Ready */
\r
423 return (UART_CheckIdleState(huart));
\r
428 * @brief Initialize the LIN mode according to the specified
\r
429 * parameters in the UART_InitTypeDef and creates the associated handle.
\r
430 * @param huart UART handle.
\r
431 * @param BreakDetectLength Specifies the LIN break detection length.
\r
432 * This parameter can be one of the following values:
\r
433 * @arg @ref UART_LINBREAKDETECTLENGTH_10B 10-bit break detection
\r
434 * @arg @ref UART_LINBREAKDETECTLENGTH_11B 11-bit break detection
\r
435 * @retval HAL status
\r
437 HAL_StatusTypeDef HAL_LIN_Init(UART_HandleTypeDef *huart, uint32_t BreakDetectLength)
\r
439 /* Check the UART handle allocation */
\r
445 /* Check the LIN UART instance */
\r
446 assert_param(IS_UART_LIN_INSTANCE(huart->Instance));
\r
447 /* Check the Break detection length parameter */
\r
448 assert_param(IS_UART_LIN_BREAK_DETECT_LENGTH(BreakDetectLength));
\r
450 /* LIN mode limited to 16-bit oversampling only */
\r
451 if (huart->Init.OverSampling == UART_OVERSAMPLING_8)
\r
455 /* LIN mode limited to 8-bit data length */
\r
456 if (huart->Init.WordLength != UART_WORDLENGTH_8B)
\r
461 if (huart->gState == HAL_UART_STATE_RESET)
\r
463 /* Allocate lock resource and initialize it */
\r
464 huart->Lock = HAL_UNLOCKED;
\r
466 #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
\r
467 UART_InitCallbacksToDefault(huart);
\r
469 if (huart->MspInitCallback == NULL)
\r
471 huart->MspInitCallback = HAL_UART_MspInit;
\r
474 /* Init the low level hardware */
\r
475 huart->MspInitCallback(huart);
\r
477 /* Init the low level hardware : GPIO, CLOCK */
\r
478 HAL_UART_MspInit(huart);
\r
479 #endif /* (USE_HAL_UART_REGISTER_CALLBACKS) */
\r
482 huart->gState = HAL_UART_STATE_BUSY;
\r
484 /* Disable the Peripheral */
\r
485 __HAL_UART_DISABLE(huart);
\r
487 /* Set the UART Communication parameters */
\r
488 if (UART_SetConfig(huart) == HAL_ERROR)
\r
493 if (huart->AdvancedInit.AdvFeatureInit != UART_ADVFEATURE_NO_INIT)
\r
495 UART_AdvFeatureConfig(huart);
\r
498 /* In LIN mode, the following bits must be kept cleared:
\r
499 - LINEN and CLKEN bits in the USART_CR2 register,
\r
500 - SCEN and IREN bits in the USART_CR3 register.*/
\r
501 CLEAR_BIT(huart->Instance->CR2, USART_CR2_CLKEN);
\r
502 CLEAR_BIT(huart->Instance->CR3, (USART_CR3_HDSEL | USART_CR3_IREN | USART_CR3_SCEN));
\r
504 /* Enable the LIN mode by setting the LINEN bit in the CR2 register */
\r
505 SET_BIT(huart->Instance->CR2, USART_CR2_LINEN);
\r
507 /* Set the USART LIN Break detection length. */
\r
508 MODIFY_REG(huart->Instance->CR2, USART_CR2_LBDL, BreakDetectLength);
\r
510 /* Enable the Peripheral */
\r
511 __HAL_UART_ENABLE(huart);
\r
513 /* TEACK and/or REACK to check before moving huart->gState and huart->RxState to Ready */
\r
514 return (UART_CheckIdleState(huart));
\r
519 * @brief Initialize the multiprocessor mode according to the specified
\r
520 * parameters in the UART_InitTypeDef and initialize the associated handle.
\r
521 * @param huart UART handle.
\r
522 * @param Address UART node address (4-, 6-, 7- or 8-bit long).
\r
523 * @param WakeUpMethod Specifies the UART wakeup method.
\r
524 * This parameter can be one of the following values:
\r
525 * @arg @ref UART_WAKEUPMETHOD_IDLELINE WakeUp by an idle line detection
\r
526 * @arg @ref UART_WAKEUPMETHOD_ADDRESSMARK WakeUp by an address mark
\r
527 * @note If the user resorts to idle line detection wake up, the Address parameter
\r
528 * is useless and ignored by the initialization function.
\r
529 * @note If the user resorts to address mark wake up, the address length detection
\r
530 * is configured by default to 4 bits only. For the UART to be able to
\r
531 * manage 6-, 7- or 8-bit long addresses detection, the API
\r
532 * HAL_MultiProcessorEx_AddressLength_Set() must be called after
\r
533 * HAL_MultiProcessor_Init().
\r
534 * @retval HAL status
\r
536 HAL_StatusTypeDef HAL_MultiProcessor_Init(UART_HandleTypeDef *huart, uint8_t Address, uint32_t WakeUpMethod)
\r
538 /* Check the UART handle allocation */
\r
544 /* Check the wake up method parameter */
\r
545 assert_param(IS_UART_WAKEUPMETHOD(WakeUpMethod));
\r
547 if (huart->gState == HAL_UART_STATE_RESET)
\r
549 /* Allocate lock resource and initialize it */
\r
550 huart->Lock = HAL_UNLOCKED;
\r
552 #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
\r
553 UART_InitCallbacksToDefault(huart);
\r
555 if (huart->MspInitCallback == NULL)
\r
557 huart->MspInitCallback = HAL_UART_MspInit;
\r
560 /* Init the low level hardware */
\r
561 huart->MspInitCallback(huart);
\r
563 /* Init the low level hardware : GPIO, CLOCK */
\r
564 HAL_UART_MspInit(huart);
\r
565 #endif /* (USE_HAL_UART_REGISTER_CALLBACKS) */
\r
568 huart->gState = HAL_UART_STATE_BUSY;
\r
570 /* Disable the Peripheral */
\r
571 __HAL_UART_DISABLE(huart);
\r
573 /* Set the UART Communication parameters */
\r
574 if (UART_SetConfig(huart) == HAL_ERROR)
\r
579 if (huart->AdvancedInit.AdvFeatureInit != UART_ADVFEATURE_NO_INIT)
\r
581 UART_AdvFeatureConfig(huart);
\r
584 /* In multiprocessor mode, the following bits must be kept cleared:
\r
585 - LINEN and CLKEN bits in the USART_CR2 register,
\r
586 - SCEN, HDSEL and IREN bits in the USART_CR3 register. */
\r
587 CLEAR_BIT(huart->Instance->CR2, (USART_CR2_LINEN | USART_CR2_CLKEN));
\r
588 CLEAR_BIT(huart->Instance->CR3, (USART_CR3_SCEN | USART_CR3_HDSEL | USART_CR3_IREN));
\r
590 if (WakeUpMethod == UART_WAKEUPMETHOD_ADDRESSMARK)
\r
592 /* If address mark wake up method is chosen, set the USART address node */
\r
593 MODIFY_REG(huart->Instance->CR2, USART_CR2_ADD, ((uint32_t)Address << UART_CR2_ADDRESS_LSB_POS));
\r
596 /* Set the wake up method by setting the WAKE bit in the CR1 register */
\r
597 MODIFY_REG(huart->Instance->CR1, USART_CR1_WAKE, WakeUpMethod);
\r
599 /* Enable the Peripheral */
\r
600 __HAL_UART_ENABLE(huart);
\r
602 /* TEACK and/or REACK to check before moving huart->gState and huart->RxState to Ready */
\r
603 return (UART_CheckIdleState(huart));
\r
608 * @brief DeInitialize the UART peripheral.
\r
609 * @param huart UART handle.
\r
610 * @retval HAL status
\r
612 HAL_StatusTypeDef HAL_UART_DeInit(UART_HandleTypeDef *huart)
\r
614 /* Check the UART handle allocation */
\r
620 /* Check the parameters */
\r
621 assert_param(IS_UART_INSTANCE(huart->Instance));
\r
623 huart->gState = HAL_UART_STATE_BUSY;
\r
625 /* Disable the Peripheral */
\r
626 __HAL_UART_DISABLE(huart);
\r
628 huart->Instance->CR1 = 0x0U;
\r
629 huart->Instance->CR2 = 0x0U;
\r
630 huart->Instance->CR3 = 0x0U;
\r
632 #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
\r
633 if (huart->MspDeInitCallback == NULL)
\r
635 huart->MspDeInitCallback = HAL_UART_MspDeInit;
\r
637 /* DeInit the low level hardware */
\r
638 huart->MspDeInitCallback(huart);
\r
640 /* DeInit the low level hardware */
\r
641 HAL_UART_MspDeInit(huart);
\r
642 #endif /* (USE_HAL_UART_REGISTER_CALLBACKS) */
\r
644 huart->ErrorCode = HAL_UART_ERROR_NONE;
\r
645 huart->gState = HAL_UART_STATE_RESET;
\r
646 huart->RxState = HAL_UART_STATE_RESET;
\r
648 /* Process Unlock */
\r
649 __HAL_UNLOCK(huart);
\r
655 * @brief Initialize the UART MSP.
\r
656 * @param huart UART handle.
\r
659 __weak void HAL_UART_MspInit(UART_HandleTypeDef *huart)
\r
661 /* Prevent unused argument(s) compilation warning */
\r
664 /* NOTE : This function should not be modified, when the callback is needed,
\r
665 the HAL_UART_MspInit can be implemented in the user file
\r
670 * @brief DeInitialize the UART MSP.
\r
671 * @param huart UART handle.
\r
674 __weak void HAL_UART_MspDeInit(UART_HandleTypeDef *huart)
\r
676 /* Prevent unused argument(s) compilation warning */
\r
679 /* NOTE : This function should not be modified, when the callback is needed,
\r
680 the HAL_UART_MspDeInit can be implemented in the user file
\r
684 #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
\r
686 * @brief Register a User UART Callback
\r
687 * To be used instead of the weak predefined callback
\r
688 * @param huart uart handle
\r
689 * @param CallbackID ID of the callback to be registered
\r
690 * This parameter can be one of the following values:
\r
691 * @arg @ref HAL_UART_TX_HALFCOMPLETE_CB_ID Tx Half Complete Callback ID
\r
692 * @arg @ref HAL_UART_TX_COMPLETE_CB_ID Tx Complete Callback ID
\r
693 * @arg @ref HAL_UART_RX_HALFCOMPLETE_CB_ID Rx Half Complete Callback ID
\r
694 * @arg @ref HAL_UART_RX_COMPLETE_CB_ID Rx Complete Callback ID
\r
695 * @arg @ref HAL_UART_ERROR_CB_ID Error Callback ID
\r
696 * @arg @ref HAL_UART_ABORT_COMPLETE_CB_ID Abort Complete Callback ID
\r
697 * @arg @ref HAL_UART_ABORT_TRANSMIT_COMPLETE_CB_ID Abort Transmit Complete Callback ID
\r
698 * @arg @ref HAL_UART_ABORT_RECEIVE_COMPLETE_CB_ID Abort Receive Complete Callback ID
\r
699 * @arg @ref HAL_UART_WAKEUP_CB_ID Wakeup Callback ID
\r
700 * @arg @ref HAL_UART_RX_FIFO_FULL_CB_ID Rx Fifo Full Callback ID
\r
701 * @arg @ref HAL_UART_TX_FIFO_EMPTY_CB_ID Tx Fifo Empty Callback ID
\r
702 * @arg @ref HAL_UART_MSPINIT_CB_ID MspInit Callback ID
\r
703 * @arg @ref HAL_UART_MSPDEINIT_CB_ID MspDeInit Callback ID
\r
704 * @param pCallback pointer to the Callback function
\r
705 * @retval HAL status
\r
707 HAL_StatusTypeDef HAL_UART_RegisterCallback(UART_HandleTypeDef *huart, HAL_UART_CallbackIDTypeDef CallbackID, pUART_CallbackTypeDef pCallback)
\r
709 HAL_StatusTypeDef status = HAL_OK;
\r
711 if (pCallback == NULL)
\r
713 /* Update the error code */
\r
714 huart->ErrorCode |= HAL_UART_ERROR_INVALID_CALLBACK;
\r
718 /* Process locked */
\r
721 if (huart->gState == HAL_UART_STATE_READY)
\r
723 switch (CallbackID)
\r
725 case HAL_UART_TX_HALFCOMPLETE_CB_ID :
\r
726 huart->TxHalfCpltCallback = pCallback;
\r
729 case HAL_UART_TX_COMPLETE_CB_ID :
\r
730 huart->TxCpltCallback = pCallback;
\r
733 case HAL_UART_RX_HALFCOMPLETE_CB_ID :
\r
734 huart->RxHalfCpltCallback = pCallback;
\r
737 case HAL_UART_RX_COMPLETE_CB_ID :
\r
738 huart->RxCpltCallback = pCallback;
\r
741 case HAL_UART_ERROR_CB_ID :
\r
742 huart->ErrorCallback = pCallback;
\r
745 case HAL_UART_ABORT_COMPLETE_CB_ID :
\r
746 huart->AbortCpltCallback = pCallback;
\r
749 case HAL_UART_ABORT_TRANSMIT_COMPLETE_CB_ID :
\r
750 huart->AbortTransmitCpltCallback = pCallback;
\r
753 case HAL_UART_ABORT_RECEIVE_COMPLETE_CB_ID :
\r
754 huart->AbortReceiveCpltCallback = pCallback;
\r
757 case HAL_UART_WAKEUP_CB_ID :
\r
758 huart->WakeupCallback = pCallback;
\r
762 case HAL_UART_MSPINIT_CB_ID :
\r
763 huart->MspInitCallback = pCallback;
\r
766 case HAL_UART_MSPDEINIT_CB_ID :
\r
767 huart->MspDeInitCallback = pCallback;
\r
771 /* Update the error code */
\r
772 huart->ErrorCode |= HAL_UART_ERROR_INVALID_CALLBACK;
\r
774 /* Return error status */
\r
775 status = HAL_ERROR;
\r
779 else if (huart->gState == HAL_UART_STATE_RESET)
\r
781 switch (CallbackID)
\r
783 case HAL_UART_MSPINIT_CB_ID :
\r
784 huart->MspInitCallback = pCallback;
\r
787 case HAL_UART_MSPDEINIT_CB_ID :
\r
788 huart->MspDeInitCallback = pCallback;
\r
792 /* Update the error code */
\r
793 huart->ErrorCode |= HAL_UART_ERROR_INVALID_CALLBACK;
\r
795 /* Return error status */
\r
796 status = HAL_ERROR;
\r
802 /* Update the error code */
\r
803 huart->ErrorCode |= HAL_UART_ERROR_INVALID_CALLBACK;
\r
805 /* Return error status */
\r
806 status = HAL_ERROR;
\r
810 __HAL_UNLOCK(huart);
\r
816 * @brief Unregister an UART Callback
\r
817 * UART callaback is redirected to the weak predefined callback
\r
818 * @param huart uart handle
\r
819 * @param CallbackID ID of the callback to be unregistered
\r
820 * This parameter can be one of the following values:
\r
821 * @arg @ref HAL_UART_TX_HALFCOMPLETE_CB_ID Tx Half Complete Callback ID
\r
822 * @arg @ref HAL_UART_TX_COMPLETE_CB_ID Tx Complete Callback ID
\r
823 * @arg @ref HAL_UART_RX_HALFCOMPLETE_CB_ID Rx Half Complete Callback ID
\r
824 * @arg @ref HAL_UART_RX_COMPLETE_CB_ID Rx Complete Callback ID
\r
825 * @arg @ref HAL_UART_ERROR_CB_ID Error Callback ID
\r
826 * @arg @ref HAL_UART_ABORT_COMPLETE_CB_ID Abort Complete Callback ID
\r
827 * @arg @ref HAL_UART_ABORT_TRANSMIT_COMPLETE_CB_ID Abort Transmit Complete Callback ID
\r
828 * @arg @ref HAL_UART_ABORT_RECEIVE_COMPLETE_CB_ID Abort Receive Complete Callback ID
\r
829 * @arg @ref HAL_UART_WAKEUP_CB_ID Wakeup Callback ID
\r
830 * @arg @ref HAL_UART_RX_FIFO_FULL_CB_ID Rx Fifo Full Callback ID
\r
831 * @arg @ref HAL_UART_TX_FIFO_EMPTY_CB_ID Tx Fifo Empty Callback ID
\r
832 * @arg @ref HAL_UART_MSPINIT_CB_ID MspInit Callback ID
\r
833 * @arg @ref HAL_UART_MSPDEINIT_CB_ID MspDeInit Callback ID
\r
834 * @retval HAL status
\r
836 HAL_StatusTypeDef HAL_UART_UnRegisterCallback(UART_HandleTypeDef *huart, HAL_UART_CallbackIDTypeDef CallbackID)
\r
838 HAL_StatusTypeDef status = HAL_OK;
\r
840 /* Process locked */
\r
843 if (HAL_UART_STATE_READY == huart->gState)
\r
845 switch (CallbackID)
\r
847 case HAL_UART_TX_HALFCOMPLETE_CB_ID :
\r
848 huart->TxHalfCpltCallback = HAL_UART_TxHalfCpltCallback; /* Legacy weak TxHalfCpltCallback */
\r
851 case HAL_UART_TX_COMPLETE_CB_ID :
\r
852 huart->TxCpltCallback = HAL_UART_TxCpltCallback; /* Legacy weak TxCpltCallback */
\r
855 case HAL_UART_RX_HALFCOMPLETE_CB_ID :
\r
856 huart->RxHalfCpltCallback = HAL_UART_RxHalfCpltCallback; /* Legacy weak RxHalfCpltCallback */
\r
859 case HAL_UART_RX_COMPLETE_CB_ID :
\r
860 huart->RxCpltCallback = HAL_UART_RxCpltCallback; /* Legacy weak RxCpltCallback */
\r
863 case HAL_UART_ERROR_CB_ID :
\r
864 huart->ErrorCallback = HAL_UART_ErrorCallback; /* Legacy weak ErrorCallback */
\r
867 case HAL_UART_ABORT_COMPLETE_CB_ID :
\r
868 huart->AbortCpltCallback = HAL_UART_AbortCpltCallback; /* Legacy weak AbortCpltCallback */
\r
871 case HAL_UART_ABORT_TRANSMIT_COMPLETE_CB_ID :
\r
872 huart->AbortTransmitCpltCallback = HAL_UART_AbortTransmitCpltCallback; /* Legacy weak AbortTransmitCpltCallback */
\r
875 case HAL_UART_ABORT_RECEIVE_COMPLETE_CB_ID :
\r
876 huart->AbortReceiveCpltCallback = HAL_UART_AbortReceiveCpltCallback; /* Legacy weak AbortReceiveCpltCallback */
\r
879 case HAL_UART_MSPINIT_CB_ID :
\r
880 huart->MspInitCallback = HAL_UART_MspInit; /* Legacy weak MspInitCallback */
\r
883 case HAL_UART_MSPDEINIT_CB_ID :
\r
884 huart->MspDeInitCallback = HAL_UART_MspDeInit; /* Legacy weak MspDeInitCallback */
\r
888 /* Update the error code */
\r
889 huart->ErrorCode |= HAL_UART_ERROR_INVALID_CALLBACK;
\r
891 /* Return error status */
\r
892 status = HAL_ERROR;
\r
896 else if (HAL_UART_STATE_RESET == huart->gState)
\r
898 switch (CallbackID)
\r
900 case HAL_UART_MSPINIT_CB_ID :
\r
901 huart->MspInitCallback = HAL_UART_MspInit;
\r
904 case HAL_UART_MSPDEINIT_CB_ID :
\r
905 huart->MspDeInitCallback = HAL_UART_MspDeInit;
\r
909 /* Update the error code */
\r
910 huart->ErrorCode |= HAL_UART_ERROR_INVALID_CALLBACK;
\r
912 /* Return error status */
\r
913 status = HAL_ERROR;
\r
919 /* Update the error code */
\r
920 huart->ErrorCode |= HAL_UART_ERROR_INVALID_CALLBACK;
\r
922 /* Return error status */
\r
923 status = HAL_ERROR;
\r
927 __HAL_UNLOCK(huart);
\r
931 #endif /* USE_HAL_UART_REGISTER_CALLBACKS */
\r
937 /** @defgroup UART_Exported_Functions_Group2 IO operation functions
\r
938 * @brief UART Transmit/Receive functions
\r
941 ===============================================================================
\r
942 ##### IO operation functions #####
\r
943 ===============================================================================
\r
944 This subsection provides a set of functions allowing to manage the UART asynchronous
\r
945 and Half duplex data transfers.
\r
947 (#) There are two mode of transfer:
\r
948 (+) Blocking mode: The communication is performed in polling mode.
\r
949 The HAL status of all data processing is returned by the same function
\r
950 after finishing transfer.
\r
951 (+) Non-Blocking mode: The communication is performed using Interrupts
\r
952 or DMA, These API's return the HAL status.
\r
953 The end of the data processing will be indicated through the
\r
954 dedicated UART IRQ when using Interrupt mode or the DMA IRQ when
\r
956 The HAL_UART_TxCpltCallback(), HAL_UART_RxCpltCallback() user callbacks
\r
957 will be executed respectively at the end of the transmit or Receive process
\r
958 The HAL_UART_ErrorCallback()user callback will be executed when a communication error is detected
\r
960 (#) Blocking mode API's are :
\r
961 (+) HAL_UART_Transmit()
\r
962 (+) HAL_UART_Receive()
\r
964 (#) Non-Blocking mode API's with Interrupt are :
\r
965 (+) HAL_UART_Transmit_IT()
\r
966 (+) HAL_UART_Receive_IT()
\r
967 (+) HAL_UART_IRQHandler()
\r
969 (#) Non-Blocking mode API's with DMA are :
\r
970 (+) HAL_UART_Transmit_DMA()
\r
971 (+) HAL_UART_Receive_DMA()
\r
972 (+) HAL_UART_DMAPause()
\r
973 (+) HAL_UART_DMAResume()
\r
974 (+) HAL_UART_DMAStop()
\r
976 (#) A set of Transfer Complete Callbacks are provided in Non_Blocking mode:
\r
977 (+) HAL_UART_TxHalfCpltCallback()
\r
978 (+) HAL_UART_TxCpltCallback()
\r
979 (+) HAL_UART_RxHalfCpltCallback()
\r
980 (+) HAL_UART_RxCpltCallback()
\r
981 (+) HAL_UART_ErrorCallback()
\r
983 (#) Non-Blocking mode transfers could be aborted using Abort API's :
\r
984 (+) HAL_UART_Abort()
\r
985 (+) HAL_UART_AbortTransmit()
\r
986 (+) HAL_UART_AbortReceive()
\r
987 (+) HAL_UART_Abort_IT()
\r
988 (+) HAL_UART_AbortTransmit_IT()
\r
989 (+) HAL_UART_AbortReceive_IT()
\r
991 (#) For Abort services based on interrupts (HAL_UART_Abortxxx_IT), a set of Abort Complete Callbacks are provided:
\r
992 (+) HAL_UART_AbortCpltCallback()
\r
993 (+) HAL_UART_AbortTransmitCpltCallback()
\r
994 (+) HAL_UART_AbortReceiveCpltCallback()
\r
996 (#) In Non-Blocking mode transfers, possible errors are split into 2 categories.
\r
997 Errors are handled as follows :
\r
998 (+) Error is considered as Recoverable and non blocking : Transfer could go till end, but error severity is
\r
999 to be evaluated by user : this concerns Frame Error, Parity Error or Noise Error in Interrupt mode reception .
\r
1000 Received character is then retrieved and stored in Rx buffer, Error code is set to allow user to identify error type,
\r
1001 and HAL_UART_ErrorCallback() user callback is executed. Transfer is kept ongoing on UART side.
\r
1002 If user wants to abort it, Abort services should be called by user.
\r
1003 (+) Error is considered as Blocking : Transfer could not be completed properly and is aborted.
\r
1004 This concerns Overrun Error In Interrupt mode reception and all errors in DMA mode.
\r
1005 Error code is set to allow user to identify error type, and HAL_UART_ErrorCallback() user callback is executed.
\r
1007 -@- In the Half duplex communication, it is forbidden to run the transmit
\r
1008 and receive process in parallel, the UART state HAL_UART_STATE_BUSY_TX_RX can't be useful.
\r
1015 * @brief Send an amount of data in blocking mode.
\r
1016 * @param huart UART handle.
\r
1017 * @param pData Pointer to data buffer.
\r
1018 * @param Size Amount of data to be sent.
\r
1019 * @param Timeout Timeout duration.
\r
1020 * @retval HAL status
\r
1022 HAL_StatusTypeDef HAL_UART_Transmit(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size, uint32_t Timeout)
\r
1024 uint8_t *pdata8bits;
\r
1025 uint16_t *pdata16bits;
\r
1026 uint32_t tickstart;
\r
1028 /* Check that a Tx process is not already ongoing */
\r
1029 if (huart->gState == HAL_UART_STATE_READY)
\r
1031 if ((pData == NULL) || (Size == 0U))
\r
1036 /* Process Locked */
\r
1037 __HAL_LOCK(huart);
\r
1039 huart->ErrorCode = HAL_UART_ERROR_NONE;
\r
1040 huart->gState = HAL_UART_STATE_BUSY_TX;
\r
1042 /* Init tickstart for timeout managment*/
\r
1043 tickstart = HAL_GetTick();
\r
1045 huart->TxXferSize = Size;
\r
1046 huart->TxXferCount = Size;
\r
1048 /* In case of 9bits/No Parity transfer, pData needs to be handled as a uint16_t pointer */
\r
1049 if ((huart->Init.WordLength == UART_WORDLENGTH_9B) && (huart->Init.Parity == UART_PARITY_NONE))
\r
1051 pdata8bits = NULL;
\r
1052 pdata16bits = (uint16_t *) pData;
\r
1056 pdata8bits = pData;
\r
1057 pdata16bits = NULL;
\r
1060 while (huart->TxXferCount > 0U)
\r
1062 if (UART_WaitOnFlagUntilTimeout(huart, UART_FLAG_TXE, RESET, tickstart, Timeout) != HAL_OK)
\r
1064 return HAL_TIMEOUT;
\r
1066 if (pdata8bits == NULL)
\r
1068 huart->Instance->TDR = (uint16_t)(*pdata16bits & 0x01FFU);
\r
1073 huart->Instance->TDR = (uint8_t)(*pdata8bits & 0xFFU);
\r
1076 huart->TxXferCount--;
\r
1079 if (UART_WaitOnFlagUntilTimeout(huart, UART_FLAG_TC, RESET, tickstart, Timeout) != HAL_OK)
\r
1081 return HAL_TIMEOUT;
\r
1084 /* At end of Tx process, restore huart->gState to Ready */
\r
1085 huart->gState = HAL_UART_STATE_READY;
\r
1087 /* Process Unlocked */
\r
1088 __HAL_UNLOCK(huart);
\r
1099 * @brief Receive an amount of data in blocking mode.
\r
1100 * @param huart UART handle.
\r
1101 * @param pData Pointer to data buffer.
\r
1102 * @param Size Amount of data to be received.
\r
1103 * @param Timeout Timeout duration.
\r
1104 * @retval HAL status
\r
1106 HAL_StatusTypeDef HAL_UART_Receive(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size, uint32_t Timeout)
\r
1108 uint8_t *pdata8bits;
\r
1109 uint16_t *pdata16bits;
\r
1111 uint32_t tickstart;
\r
1113 /* Check that a Rx process is not already ongoing */
\r
1114 if (huart->RxState == HAL_UART_STATE_READY)
\r
1116 if ((pData == NULL) || (Size == 0U))
\r
1121 /* Process Locked */
\r
1122 __HAL_LOCK(huart);
\r
1124 huart->ErrorCode = HAL_UART_ERROR_NONE;
\r
1125 huart->RxState = HAL_UART_STATE_BUSY_RX;
\r
1127 /* Init tickstart for timeout managment*/
\r
1128 tickstart = HAL_GetTick();
\r
1130 huart->RxXferSize = Size;
\r
1131 huart->RxXferCount = Size;
\r
1133 /* Computation of UART mask to apply to RDR register */
\r
1134 UART_MASK_COMPUTATION(huart);
\r
1135 uhMask = huart->Mask;
\r
1137 /* In case of 9bits/No Parity transfer, pRxData needs to be handled as a uint16_t pointer */
\r
1138 if ((huart->Init.WordLength == UART_WORDLENGTH_9B) && (huart->Init.Parity == UART_PARITY_NONE))
\r
1140 pdata8bits = NULL;
\r
1141 pdata16bits = (uint16_t *) pData;
\r
1145 pdata8bits = pData;
\r
1146 pdata16bits = NULL;
\r
1149 /* as long as data have to be received */
\r
1150 while (huart->RxXferCount > 0U)
\r
1152 if (UART_WaitOnFlagUntilTimeout(huart, UART_FLAG_RXNE, RESET, tickstart, Timeout) != HAL_OK)
\r
1154 return HAL_TIMEOUT;
\r
1156 if (pdata8bits == NULL)
\r
1158 *pdata16bits = (uint16_t)(huart->Instance->RDR & uhMask);
\r
1163 *pdata8bits = (uint8_t)(huart->Instance->RDR & (uint8_t)uhMask);
\r
1166 huart->RxXferCount--;
\r
1169 /* At end of Rx process, restore huart->RxState to Ready */
\r
1170 huart->RxState = HAL_UART_STATE_READY;
\r
1172 /* Process Unlocked */
\r
1173 __HAL_UNLOCK(huart);
\r
1184 * @brief Send an amount of data in interrupt mode.
\r
1185 * @param huart UART handle.
\r
1186 * @param pData Pointer to data buffer.
\r
1187 * @param Size Amount of data to be sent.
\r
1188 * @retval HAL status
\r
1190 HAL_StatusTypeDef HAL_UART_Transmit_IT(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size)
\r
1192 /* Check that a Tx process is not already ongoing */
\r
1193 if (huart->gState == HAL_UART_STATE_READY)
\r
1195 if ((pData == NULL) || (Size == 0U))
\r
1200 /* Process Locked */
\r
1201 __HAL_LOCK(huart);
\r
1203 huart->pTxBuffPtr = pData;
\r
1204 huart->TxXferSize = Size;
\r
1205 huart->TxXferCount = Size;
\r
1206 huart->TxISR = NULL;
\r
1208 huart->ErrorCode = HAL_UART_ERROR_NONE;
\r
1209 huart->gState = HAL_UART_STATE_BUSY_TX;
\r
1211 /* Set the Tx ISR function pointer according to the data word length */
\r
1212 if ((huart->Init.WordLength == UART_WORDLENGTH_9B) && (huart->Init.Parity == UART_PARITY_NONE))
\r
1214 huart->TxISR = UART_TxISR_16BIT;
\r
1218 huart->TxISR = UART_TxISR_8BIT;
\r
1221 /* Process Unlocked */
\r
1222 __HAL_UNLOCK(huart);
\r
1224 /* Enable the Transmit Data Register Empty interrupt */
\r
1225 SET_BIT(huart->Instance->CR1, USART_CR1_TXEIE);
\r
1236 * @brief Receive an amount of data in interrupt mode.
\r
1237 * @param huart UART handle.
\r
1238 * @param pData Pointer to data buffer.
\r
1239 * @param Size Amount of data to be received.
\r
1240 * @retval HAL status
\r
1242 HAL_StatusTypeDef HAL_UART_Receive_IT(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size)
\r
1244 /* Check that a Rx process is not already ongoing */
\r
1245 if (huart->RxState == HAL_UART_STATE_READY)
\r
1247 if ((pData == NULL) || (Size == 0U))
\r
1252 /* Process Locked */
\r
1253 __HAL_LOCK(huart);
\r
1255 huart->pRxBuffPtr = pData;
\r
1256 huart->RxXferSize = Size;
\r
1257 huart->RxXferCount = Size;
\r
1258 huart->RxISR = NULL;
\r
1260 /* Computation of UART mask to apply to RDR register */
\r
1261 UART_MASK_COMPUTATION(huart);
\r
1263 huart->ErrorCode = HAL_UART_ERROR_NONE;
\r
1264 huart->RxState = HAL_UART_STATE_BUSY_RX;
\r
1266 /* Enable the UART Error Interrupt: (Frame error, noise error, overrun error) */
\r
1267 SET_BIT(huart->Instance->CR3, USART_CR3_EIE);
\r
1269 /* Set the Rx ISR function pointer according to the data word length */
\r
1270 if ((huart->Init.WordLength == UART_WORDLENGTH_9B) && (huart->Init.Parity == UART_PARITY_NONE))
\r
1272 huart->RxISR = UART_RxISR_16BIT;
\r
1276 huart->RxISR = UART_RxISR_8BIT;
\r
1279 /* Process Unlocked */
\r
1280 __HAL_UNLOCK(huart);
\r
1282 /* Enable the UART Parity Error interrupt and Data Register Not Empty interrupt */
\r
1283 SET_BIT(huart->Instance->CR1, USART_CR1_PEIE | USART_CR1_RXNEIE);
\r
1294 * @brief Send an amount of data in DMA mode.
\r
1295 * @param huart UART handle.
\r
1296 * @param pData Pointer to data buffer.
\r
1297 * @param Size Amount of data to be sent.
\r
1298 * @retval HAL status
\r
1300 HAL_StatusTypeDef HAL_UART_Transmit_DMA(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size)
\r
1302 /* Check that a Tx process is not already ongoing */
\r
1303 if (huart->gState == HAL_UART_STATE_READY)
\r
1305 if ((pData == NULL) || (Size == 0U))
\r
1310 /* Process Locked */
\r
1311 __HAL_LOCK(huart);
\r
1313 huart->pTxBuffPtr = pData;
\r
1314 huart->TxXferSize = Size;
\r
1315 huart->TxXferCount = Size;
\r
1317 huart->ErrorCode = HAL_UART_ERROR_NONE;
\r
1318 huart->gState = HAL_UART_STATE_BUSY_TX;
\r
1320 if (huart->hdmatx != NULL)
\r
1322 /* Set the UART DMA transfer complete callback */
\r
1323 huart->hdmatx->XferCpltCallback = UART_DMATransmitCplt;
\r
1325 /* Set the UART DMA Half transfer complete callback */
\r
1326 huart->hdmatx->XferHalfCpltCallback = UART_DMATxHalfCplt;
\r
1328 /* Set the DMA error callback */
\r
1329 huart->hdmatx->XferErrorCallback = UART_DMAError;
\r
1331 /* Set the DMA abort callback */
\r
1332 huart->hdmatx->XferAbortCallback = NULL;
\r
1334 /* Enable the UART transmit DMA channel */
\r
1335 if (HAL_DMA_Start_IT(huart->hdmatx, (uint32_t)huart->pTxBuffPtr, (uint32_t)&huart->Instance->TDR, Size) != HAL_OK)
\r
1337 /* Set error code to DMA */
\r
1338 huart->ErrorCode = HAL_UART_ERROR_DMA;
\r
1340 /* Process Unlocked */
\r
1341 __HAL_UNLOCK(huart);
\r
1343 /* Restore huart->gState to ready */
\r
1344 huart->gState = HAL_UART_STATE_READY;
\r
1349 /* Clear the TC flag in the ICR register */
\r
1350 __HAL_UART_CLEAR_FLAG(huart, UART_CLEAR_TCF);
\r
1352 /* Process Unlocked */
\r
1353 __HAL_UNLOCK(huart);
\r
1355 /* Enable the DMA transfer for transmit request by setting the DMAT bit
\r
1356 in the UART CR3 register */
\r
1357 SET_BIT(huart->Instance->CR3, USART_CR3_DMAT);
\r
1368 * @brief Receive an amount of data in DMA mode.
\r
1369 * @note When the UART parity is enabled (PCE = 1), the received data contain
\r
1370 * the parity bit (MSB position).
\r
1371 * @param huart UART handle.
\r
1372 * @param pData Pointer to data buffer.
\r
1373 * @param Size Amount of data to be received.
\r
1374 * @retval HAL status
\r
1376 HAL_StatusTypeDef HAL_UART_Receive_DMA(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size)
\r
1378 /* Check that a Rx process is not already ongoing */
\r
1379 if (huart->RxState == HAL_UART_STATE_READY)
\r
1381 if ((pData == NULL) || (Size == 0U))
\r
1386 /* Process Locked */
\r
1387 __HAL_LOCK(huart);
\r
1389 huart->pRxBuffPtr = pData;
\r
1390 huart->RxXferSize = Size;
\r
1392 huart->ErrorCode = HAL_UART_ERROR_NONE;
\r
1393 huart->RxState = HAL_UART_STATE_BUSY_RX;
\r
1395 if (huart->hdmarx != NULL)
\r
1397 /* Set the UART DMA transfer complete callback */
\r
1398 huart->hdmarx->XferCpltCallback = UART_DMAReceiveCplt;
\r
1400 /* Set the UART DMA Half transfer complete callback */
\r
1401 huart->hdmarx->XferHalfCpltCallback = UART_DMARxHalfCplt;
\r
1403 /* Set the DMA error callback */
\r
1404 huart->hdmarx->XferErrorCallback = UART_DMAError;
\r
1406 /* Set the DMA abort callback */
\r
1407 huart->hdmarx->XferAbortCallback = NULL;
\r
1409 /* Enable the DMA channel */
\r
1410 if (HAL_DMA_Start_IT(huart->hdmarx, (uint32_t)&huart->Instance->RDR, (uint32_t)huart->pRxBuffPtr, Size) != HAL_OK)
\r
1412 /* Set error code to DMA */
\r
1413 huart->ErrorCode = HAL_UART_ERROR_DMA;
\r
1415 /* Process Unlocked */
\r
1416 __HAL_UNLOCK(huart);
\r
1418 /* Restore huart->gState to ready */
\r
1419 huart->gState = HAL_UART_STATE_READY;
\r
1424 /* Process Unlocked */
\r
1425 __HAL_UNLOCK(huart);
\r
1427 /* Enable the UART Parity Error Interrupt */
\r
1428 SET_BIT(huart->Instance->CR1, USART_CR1_PEIE);
\r
1430 /* Enable the UART Error Interrupt: (Frame error, noise error, overrun error) */
\r
1431 SET_BIT(huart->Instance->CR3, USART_CR3_EIE);
\r
1433 /* Enable the DMA transfer for the receiver request by setting the DMAR bit
\r
1434 in the UART CR3 register */
\r
1435 SET_BIT(huart->Instance->CR3, USART_CR3_DMAR);
\r
1446 * @brief Pause the DMA Transfer.
\r
1447 * @param huart UART handle.
\r
1448 * @retval HAL status
\r
1450 HAL_StatusTypeDef HAL_UART_DMAPause(UART_HandleTypeDef *huart)
\r
1452 const HAL_UART_StateTypeDef gstate = huart->gState;
\r
1453 const HAL_UART_StateTypeDef rxstate = huart->RxState;
\r
1455 /* Process Locked */
\r
1456 __HAL_LOCK(huart);
\r
1458 if ((HAL_IS_BIT_SET(huart->Instance->CR3, USART_CR3_DMAT)) &&
\r
1459 (gstate == HAL_UART_STATE_BUSY_TX))
\r
1461 /* Disable the UART DMA Tx request */
\r
1462 CLEAR_BIT(huart->Instance->CR3, USART_CR3_DMAT);
\r
1464 if ((HAL_IS_BIT_SET(huart->Instance->CR3, USART_CR3_DMAR)) &&
\r
1465 (rxstate == HAL_UART_STATE_BUSY_RX))
\r
1467 /* Disable PE and ERR (Frame error, noise error, overrun error) interrupts */
\r
1468 CLEAR_BIT(huart->Instance->CR1, USART_CR1_PEIE);
\r
1469 CLEAR_BIT(huart->Instance->CR3, USART_CR3_EIE);
\r
1471 /* Disable the UART DMA Rx request */
\r
1472 CLEAR_BIT(huart->Instance->CR3, USART_CR3_DMAR);
\r
1475 /* Process Unlocked */
\r
1476 __HAL_UNLOCK(huart);
\r
1482 * @brief Resume the DMA Transfer.
\r
1483 * @param huart UART handle.
\r
1484 * @retval HAL status
\r
1486 HAL_StatusTypeDef HAL_UART_DMAResume(UART_HandleTypeDef *huart)
\r
1488 /* Process Locked */
\r
1489 __HAL_LOCK(huart);
\r
1491 if (huart->gState == HAL_UART_STATE_BUSY_TX)
\r
1493 /* Enable the UART DMA Tx request */
\r
1494 SET_BIT(huart->Instance->CR3, USART_CR3_DMAT);
\r
1496 if (huart->RxState == HAL_UART_STATE_BUSY_RX)
\r
1498 /* Clear the Overrun flag before resuming the Rx transfer */
\r
1499 __HAL_UART_CLEAR_FLAG(huart, UART_CLEAR_OREF);
\r
1501 /* Reenable PE and ERR (Frame error, noise error, overrun error) interrupts */
\r
1502 SET_BIT(huart->Instance->CR1, USART_CR1_PEIE);
\r
1503 SET_BIT(huart->Instance->CR3, USART_CR3_EIE);
\r
1505 /* Enable the UART DMA Rx request */
\r
1506 SET_BIT(huart->Instance->CR3, USART_CR3_DMAR);
\r
1509 /* Process Unlocked */
\r
1510 __HAL_UNLOCK(huart);
\r
1516 * @brief Stop the DMA Transfer.
\r
1517 * @param huart UART handle.
\r
1518 * @retval HAL status
\r
1520 HAL_StatusTypeDef HAL_UART_DMAStop(UART_HandleTypeDef *huart)
\r
1522 /* The Lock is not implemented on this API to allow the user application
\r
1523 to call the HAL UART API under callbacks HAL_UART_TxCpltCallback() / HAL_UART_RxCpltCallback() /
\r
1524 HAL_UART_TxHalfCpltCallback / HAL_UART_RxHalfCpltCallback:
\r
1525 indeed, when HAL_DMA_Abort() API is called, the DMA TX/RX Transfer or Half Transfer complete
\r
1526 interrupt is generated if the DMA transfer interruption occurs at the middle or at the end of
\r
1527 the stream and the corresponding call back is executed. */
\r
1529 const HAL_UART_StateTypeDef gstate = huart->gState;
\r
1530 const HAL_UART_StateTypeDef rxstate = huart->RxState;
\r
1532 /* Stop UART DMA Tx request if ongoing */
\r
1533 if ((HAL_IS_BIT_SET(huart->Instance->CR3, USART_CR3_DMAT)) &&
\r
1534 (gstate == HAL_UART_STATE_BUSY_TX))
\r
1536 CLEAR_BIT(huart->Instance->CR3, USART_CR3_DMAT);
\r
1538 /* Abort the UART DMA Tx channel */
\r
1539 if (huart->hdmatx != NULL)
\r
1541 if (HAL_DMA_Abort(huart->hdmatx) != HAL_OK)
\r
1543 if (HAL_DMA_GetError(huart->hdmatx) == HAL_DMA_ERROR_TIMEOUT)
\r
1545 /* Set error code to DMA */
\r
1546 huart->ErrorCode = HAL_UART_ERROR_DMA;
\r
1548 return HAL_TIMEOUT;
\r
1553 UART_EndTxTransfer(huart);
\r
1556 /* Stop UART DMA Rx request if ongoing */
\r
1557 if ((HAL_IS_BIT_SET(huart->Instance->CR3, USART_CR3_DMAR)) &&
\r
1558 (rxstate == HAL_UART_STATE_BUSY_RX))
\r
1560 CLEAR_BIT(huart->Instance->CR3, USART_CR3_DMAR);
\r
1562 /* Abort the UART DMA Rx channel */
\r
1563 if (huart->hdmarx != NULL)
\r
1565 if (HAL_DMA_Abort(huart->hdmarx) != HAL_OK)
\r
1567 if (HAL_DMA_GetError(huart->hdmarx) == HAL_DMA_ERROR_TIMEOUT)
\r
1569 /* Set error code to DMA */
\r
1570 huart->ErrorCode = HAL_UART_ERROR_DMA;
\r
1572 return HAL_TIMEOUT;
\r
1577 UART_EndRxTransfer(huart);
\r
1584 * @brief Abort ongoing transfers (blocking mode).
\r
1585 * @param huart UART handle.
\r
1586 * @note This procedure could be used for aborting any ongoing transfer started in Interrupt or DMA mode.
\r
1587 * This procedure performs following operations :
\r
1588 * - Disable UART Interrupts (Tx and Rx)
\r
1589 * - Disable the DMA transfer in the peripheral register (if enabled)
\r
1590 * - Abort DMA transfer by calling HAL_DMA_Abort (in case of transfer in DMA mode)
\r
1591 * - Set handle State to READY
\r
1592 * @note This procedure is executed in blocking mode : when exiting function, Abort is considered as completed.
\r
1593 * @retval HAL status
\r
1595 HAL_StatusTypeDef HAL_UART_Abort(UART_HandleTypeDef *huart)
\r
1597 /* Disable TXEIE, TCIE, RXNE, PE and ERR (Frame error, noise error, overrun error) interrupts */
\r
1598 CLEAR_BIT(huart->Instance->CR1, (USART_CR1_RXNEIE | USART_CR1_PEIE | USART_CR1_TXEIE | USART_CR1_TCIE));
\r
1599 CLEAR_BIT(huart->Instance->CR3, USART_CR3_EIE);
\r
1601 /* Disable the UART DMA Tx request if enabled */
\r
1602 if (HAL_IS_BIT_SET(huart->Instance->CR3, USART_CR3_DMAT))
\r
1604 CLEAR_BIT(huart->Instance->CR3, USART_CR3_DMAT);
\r
1606 /* Abort the UART DMA Tx channel : use blocking DMA Abort API (no callback) */
\r
1607 if (huart->hdmatx != NULL)
\r
1609 /* Set the UART DMA Abort callback to Null.
\r
1610 No call back execution at end of DMA abort procedure */
\r
1611 huart->hdmatx->XferAbortCallback = NULL;
\r
1613 if (HAL_DMA_Abort(huart->hdmatx) != HAL_OK)
\r
1615 if (HAL_DMA_GetError(huart->hdmatx) == HAL_DMA_ERROR_TIMEOUT)
\r
1617 /* Set error code to DMA */
\r
1618 huart->ErrorCode = HAL_UART_ERROR_DMA;
\r
1620 return HAL_TIMEOUT;
\r
1626 /* Disable the UART DMA Rx request if enabled */
\r
1627 if (HAL_IS_BIT_SET(huart->Instance->CR3, USART_CR3_DMAR))
\r
1629 CLEAR_BIT(huart->Instance->CR3, USART_CR3_DMAR);
\r
1631 /* Abort the UART DMA Rx channel : use blocking DMA Abort API (no callback) */
\r
1632 if (huart->hdmarx != NULL)
\r
1634 /* Set the UART DMA Abort callback to Null.
\r
1635 No call back execution at end of DMA abort procedure */
\r
1636 huart->hdmarx->XferAbortCallback = NULL;
\r
1638 if (HAL_DMA_Abort(huart->hdmarx) != HAL_OK)
\r
1640 if (HAL_DMA_GetError(huart->hdmarx) == HAL_DMA_ERROR_TIMEOUT)
\r
1642 /* Set error code to DMA */
\r
1643 huart->ErrorCode = HAL_UART_ERROR_DMA;
\r
1645 return HAL_TIMEOUT;
\r
1651 /* Reset Tx and Rx transfer counters */
\r
1652 huart->TxXferCount = 0U;
\r
1653 huart->RxXferCount = 0U;
\r
1655 /* Clear the Error flags in the ICR register */
\r
1656 __HAL_UART_CLEAR_FLAG(huart, UART_CLEAR_OREF | UART_CLEAR_NEF | UART_CLEAR_PEF | UART_CLEAR_FEF);
\r
1659 /* Discard the received data */
\r
1660 __HAL_UART_SEND_REQ(huart, UART_RXDATA_FLUSH_REQUEST);
\r
1662 /* Restore huart->gState and huart->RxState to Ready */
\r
1663 huart->gState = HAL_UART_STATE_READY;
\r
1664 huart->RxState = HAL_UART_STATE_READY;
\r
1666 /* Reset Handle ErrorCode to No Error */
\r
1667 huart->ErrorCode = HAL_UART_ERROR_NONE;
\r
1673 * @brief Abort ongoing Transmit transfer (blocking mode).
\r
1674 * @param huart UART handle.
\r
1675 * @note This procedure could be used for aborting any ongoing Tx transfer started in Interrupt or DMA mode.
\r
1676 * This procedure performs following operations :
\r
1677 * - Disable UART Interrupts (Tx)
\r
1678 * - Disable the DMA transfer in the peripheral register (if enabled)
\r
1679 * - Abort DMA transfer by calling HAL_DMA_Abort (in case of transfer in DMA mode)
\r
1680 * - Set handle State to READY
\r
1681 * @note This procedure is executed in blocking mode : when exiting function, Abort is considered as completed.
\r
1682 * @retval HAL status
\r
1684 HAL_StatusTypeDef HAL_UART_AbortTransmit(UART_HandleTypeDef *huart)
\r
1686 /* Disable TXEIE and TCIE interrupts */
\r
1687 CLEAR_BIT(huart->Instance->CR1, (USART_CR1_TXEIE | USART_CR1_TCIE));
\r
1689 /* Disable the UART DMA Tx request if enabled */
\r
1690 if (HAL_IS_BIT_SET(huart->Instance->CR3, USART_CR3_DMAT))
\r
1692 CLEAR_BIT(huart->Instance->CR3, USART_CR3_DMAT);
\r
1694 /* Abort the UART DMA Tx channel : use blocking DMA Abort API (no callback) */
\r
1695 if (huart->hdmatx != NULL)
\r
1697 /* Set the UART DMA Abort callback to Null.
\r
1698 No call back execution at end of DMA abort procedure */
\r
1699 huart->hdmatx->XferAbortCallback = NULL;
\r
1701 if (HAL_DMA_Abort(huart->hdmatx) != HAL_OK)
\r
1703 if (HAL_DMA_GetError(huart->hdmatx) == HAL_DMA_ERROR_TIMEOUT)
\r
1705 /* Set error code to DMA */
\r
1706 huart->ErrorCode = HAL_UART_ERROR_DMA;
\r
1708 return HAL_TIMEOUT;
\r
1714 /* Reset Tx transfer counter */
\r
1715 huart->TxXferCount = 0U;
\r
1718 /* Restore huart->gState to Ready */
\r
1719 huart->gState = HAL_UART_STATE_READY;
\r
1725 * @brief Abort ongoing Receive transfer (blocking mode).
\r
1726 * @param huart UART handle.
\r
1727 * @note This procedure could be used for aborting any ongoing Rx transfer started in Interrupt or DMA mode.
\r
1728 * This procedure performs following operations :
\r
1729 * - Disable UART Interrupts (Rx)
\r
1730 * - Disable the DMA transfer in the peripheral register (if enabled)
\r
1731 * - Abort DMA transfer by calling HAL_DMA_Abort (in case of transfer in DMA mode)
\r
1732 * - Set handle State to READY
\r
1733 * @note This procedure is executed in blocking mode : when exiting function, Abort is considered as completed.
\r
1734 * @retval HAL status
\r
1736 HAL_StatusTypeDef HAL_UART_AbortReceive(UART_HandleTypeDef *huart)
\r
1738 /* Disable RXNE, PE and ERR (Frame error, noise error, overrun error) interrupts */
\r
1739 CLEAR_BIT(huart->Instance->CR1, (USART_CR1_RXNEIE | USART_CR1_PEIE));
\r
1740 CLEAR_BIT(huart->Instance->CR3, USART_CR3_EIE);
\r
1742 /* Disable the UART DMA Rx request if enabled */
\r
1743 if (HAL_IS_BIT_SET(huart->Instance->CR3, USART_CR3_DMAR))
\r
1745 CLEAR_BIT(huart->Instance->CR3, USART_CR3_DMAR);
\r
1747 /* Abort the UART DMA Rx channel : use blocking DMA Abort API (no callback) */
\r
1748 if (huart->hdmarx != NULL)
\r
1750 /* Set the UART DMA Abort callback to Null.
\r
1751 No call back execution at end of DMA abort procedure */
\r
1752 huart->hdmarx->XferAbortCallback = NULL;
\r
1754 if (HAL_DMA_Abort(huart->hdmarx) != HAL_OK)
\r
1756 if (HAL_DMA_GetError(huart->hdmarx) == HAL_DMA_ERROR_TIMEOUT)
\r
1758 /* Set error code to DMA */
\r
1759 huart->ErrorCode = HAL_UART_ERROR_DMA;
\r
1761 return HAL_TIMEOUT;
\r
1767 /* Reset Rx transfer counter */
\r
1768 huart->RxXferCount = 0U;
\r
1770 /* Clear the Error flags in the ICR register */
\r
1771 __HAL_UART_CLEAR_FLAG(huart, UART_CLEAR_OREF | UART_CLEAR_NEF | UART_CLEAR_PEF | UART_CLEAR_FEF);
\r
1773 /* Discard the received data */
\r
1774 __HAL_UART_SEND_REQ(huart, UART_RXDATA_FLUSH_REQUEST);
\r
1776 /* Restore huart->RxState to Ready */
\r
1777 huart->RxState = HAL_UART_STATE_READY;
\r
1783 * @brief Abort ongoing transfers (Interrupt mode).
\r
1784 * @param huart UART handle.
\r
1785 * @note This procedure could be used for aborting any ongoing transfer started in Interrupt or DMA mode.
\r
1786 * This procedure performs following operations :
\r
1787 * - Disable UART Interrupts (Tx and Rx)
\r
1788 * - Disable the DMA transfer in the peripheral register (if enabled)
\r
1789 * - Abort DMA transfer by calling HAL_DMA_Abort_IT (in case of transfer in DMA mode)
\r
1790 * - Set handle State to READY
\r
1791 * - At abort completion, call user abort complete callback
\r
1792 * @note This procedure is executed in Interrupt mode, meaning that abort procedure could be
\r
1793 * considered as completed only when user abort complete callback is executed (not when exiting function).
\r
1794 * @retval HAL status
\r
1796 HAL_StatusTypeDef HAL_UART_Abort_IT(UART_HandleTypeDef *huart)
\r
1798 uint32_t abortcplt = 1U;
\r
1800 /* Disable interrupts */
\r
1801 CLEAR_BIT(huart->Instance->CR1, (USART_CR1_RXNEIE | USART_CR1_PEIE | USART_CR1_TXEIE | USART_CR1_TCIE));
\r
1802 CLEAR_BIT(huart->Instance->CR3, USART_CR3_EIE);
\r
1804 /* If DMA Tx and/or DMA Rx Handles are associated to UART Handle, DMA Abort complete callbacks should be initialised
\r
1805 before any call to DMA Abort functions */
\r
1806 /* DMA Tx Handle is valid */
\r
1807 if (huart->hdmatx != NULL)
\r
1809 /* Set DMA Abort Complete callback if UART DMA Tx request if enabled.
\r
1810 Otherwise, set it to NULL */
\r
1811 if (HAL_IS_BIT_SET(huart->Instance->CR3, USART_CR3_DMAT))
\r
1813 huart->hdmatx->XferAbortCallback = UART_DMATxAbortCallback;
\r
1817 huart->hdmatx->XferAbortCallback = NULL;
\r
1820 /* DMA Rx Handle is valid */
\r
1821 if (huart->hdmarx != NULL)
\r
1823 /* Set DMA Abort Complete callback if UART DMA Rx request if enabled.
\r
1824 Otherwise, set it to NULL */
\r
1825 if (HAL_IS_BIT_SET(huart->Instance->CR3, USART_CR3_DMAR))
\r
1827 huart->hdmarx->XferAbortCallback = UART_DMARxAbortCallback;
\r
1831 huart->hdmarx->XferAbortCallback = NULL;
\r
1835 /* Disable the UART DMA Tx request if enabled */
\r
1836 if (HAL_IS_BIT_SET(huart->Instance->CR3, USART_CR3_DMAT))
\r
1838 /* Disable DMA Tx at UART level */
\r
1839 CLEAR_BIT(huart->Instance->CR3, USART_CR3_DMAT);
\r
1841 /* Abort the UART DMA Tx channel : use non blocking DMA Abort API (callback) */
\r
1842 if (huart->hdmatx != NULL)
\r
1844 /* UART Tx DMA Abort callback has already been initialised :
\r
1845 will lead to call HAL_UART_AbortCpltCallback() at end of DMA abort procedure */
\r
1847 /* Abort DMA TX */
\r
1848 if (HAL_DMA_Abort_IT(huart->hdmatx) != HAL_OK)
\r
1850 huart->hdmatx->XferAbortCallback = NULL;
\r
1859 /* Disable the UART DMA Rx request if enabled */
\r
1860 if (HAL_IS_BIT_SET(huart->Instance->CR3, USART_CR3_DMAR))
\r
1862 CLEAR_BIT(huart->Instance->CR3, USART_CR3_DMAR);
\r
1864 /* Abort the UART DMA Rx channel : use non blocking DMA Abort API (callback) */
\r
1865 if (huart->hdmarx != NULL)
\r
1867 /* UART Rx DMA Abort callback has already been initialised :
\r
1868 will lead to call HAL_UART_AbortCpltCallback() at end of DMA abort procedure */
\r
1870 /* Abort DMA RX */
\r
1871 if (HAL_DMA_Abort_IT(huart->hdmarx) != HAL_OK)
\r
1873 huart->hdmarx->XferAbortCallback = NULL;
\r
1883 /* if no DMA abort complete callback execution is required => call user Abort Complete callback */
\r
1884 if (abortcplt == 1U)
\r
1886 /* Reset Tx and Rx transfer counters */
\r
1887 huart->TxXferCount = 0U;
\r
1888 huart->RxXferCount = 0U;
\r
1890 /* Clear ISR function pointers */
\r
1891 huart->RxISR = NULL;
\r
1892 huart->TxISR = NULL;
\r
1894 /* Reset errorCode */
\r
1895 huart->ErrorCode = HAL_UART_ERROR_NONE;
\r
1897 /* Clear the Error flags in the ICR register */
\r
1898 __HAL_UART_CLEAR_FLAG(huart, UART_CLEAR_OREF | UART_CLEAR_NEF | UART_CLEAR_PEF | UART_CLEAR_FEF);
\r
1901 /* Discard the received data */
\r
1902 __HAL_UART_SEND_REQ(huart, UART_RXDATA_FLUSH_REQUEST);
\r
1904 /* Restore huart->gState and huart->RxState to Ready */
\r
1905 huart->gState = HAL_UART_STATE_READY;
\r
1906 huart->RxState = HAL_UART_STATE_READY;
\r
1908 /* As no DMA to be aborted, call directly user Abort complete callback */
\r
1909 #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
\r
1910 /* Call registered Abort complete callback */
\r
1911 huart->AbortCpltCallback(huart);
\r
1913 /* Call legacy weak Abort complete callback */
\r
1914 HAL_UART_AbortCpltCallback(huart);
\r
1915 #endif /* USE_HAL_UART_REGISTER_CALLBACKS */
\r
1922 * @brief Abort ongoing Transmit transfer (Interrupt mode).
\r
1923 * @param huart UART handle.
\r
1924 * @note This procedure could be used for aborting any ongoing Tx transfer started in Interrupt or DMA mode.
\r
1925 * This procedure performs following operations :
\r
1926 * - Disable UART Interrupts (Tx)
\r
1927 * - Disable the DMA transfer in the peripheral register (if enabled)
\r
1928 * - Abort DMA transfer by calling HAL_DMA_Abort_IT (in case of transfer in DMA mode)
\r
1929 * - Set handle State to READY
\r
1930 * - At abort completion, call user abort complete callback
\r
1931 * @note This procedure is executed in Interrupt mode, meaning that abort procedure could be
\r
1932 * considered as completed only when user abort complete callback is executed (not when exiting function).
\r
1933 * @retval HAL status
\r
1935 HAL_StatusTypeDef HAL_UART_AbortTransmit_IT(UART_HandleTypeDef *huart)
\r
1937 /* Disable interrupts */
\r
1938 CLEAR_BIT(huart->Instance->CR1, (USART_CR1_TXEIE | USART_CR1_TCIE));
\r
1940 /* Disable the UART DMA Tx request if enabled */
\r
1941 if (HAL_IS_BIT_SET(huart->Instance->CR3, USART_CR3_DMAT))
\r
1943 CLEAR_BIT(huart->Instance->CR3, USART_CR3_DMAT);
\r
1945 /* Abort the UART DMA Tx channel : use non blocking DMA Abort API (callback) */
\r
1946 if (huart->hdmatx != NULL)
\r
1948 /* Set the UART DMA Abort callback :
\r
1949 will lead to call HAL_UART_AbortCpltCallback() at end of DMA abort procedure */
\r
1950 huart->hdmatx->XferAbortCallback = UART_DMATxOnlyAbortCallback;
\r
1952 /* Abort DMA TX */
\r
1953 if (HAL_DMA_Abort_IT(huart->hdmatx) != HAL_OK)
\r
1955 /* Call Directly huart->hdmatx->XferAbortCallback function in case of error */
\r
1956 huart->hdmatx->XferAbortCallback(huart->hdmatx);
\r
1961 /* Reset Tx transfer counter */
\r
1962 huart->TxXferCount = 0U;
\r
1964 /* Clear TxISR function pointers */
\r
1965 huart->TxISR = NULL;
\r
1967 /* Restore huart->gState to Ready */
\r
1968 huart->gState = HAL_UART_STATE_READY;
\r
1970 /* As no DMA to be aborted, call directly user Abort complete callback */
\r
1971 #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
\r
1972 /* Call registered Abort Transmit Complete Callback */
\r
1973 huart->AbortTransmitCpltCallback(huart);
\r
1975 /* Call legacy weak Abort Transmit Complete Callback */
\r
1976 HAL_UART_AbortTransmitCpltCallback(huart);
\r
1977 #endif /* USE_HAL_UART_REGISTER_CALLBACKS */
\r
1982 /* Reset Tx transfer counter */
\r
1983 huart->TxXferCount = 0U;
\r
1985 /* Clear TxISR function pointers */
\r
1986 huart->TxISR = NULL;
\r
1989 /* Restore huart->gState to Ready */
\r
1990 huart->gState = HAL_UART_STATE_READY;
\r
1992 /* As no DMA to be aborted, call directly user Abort complete callback */
\r
1993 #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
\r
1994 /* Call registered Abort Transmit Complete Callback */
\r
1995 huart->AbortTransmitCpltCallback(huart);
\r
1997 /* Call legacy weak Abort Transmit Complete Callback */
\r
1998 HAL_UART_AbortTransmitCpltCallback(huart);
\r
1999 #endif /* USE_HAL_UART_REGISTER_CALLBACKS */
\r
2006 * @brief Abort ongoing Receive transfer (Interrupt mode).
\r
2007 * @param huart UART handle.
\r
2008 * @note This procedure could be used for aborting any ongoing Rx transfer started in Interrupt or DMA mode.
\r
2009 * This procedure performs following operations :
\r
2010 * - Disable UART Interrupts (Rx)
\r
2011 * - Disable the DMA transfer in the peripheral register (if enabled)
\r
2012 * - Abort DMA transfer by calling HAL_DMA_Abort_IT (in case of transfer in DMA mode)
\r
2013 * - Set handle State to READY
\r
2014 * - At abort completion, call user abort complete callback
\r
2015 * @note This procedure is executed in Interrupt mode, meaning that abort procedure could be
\r
2016 * considered as completed only when user abort complete callback is executed (not when exiting function).
\r
2017 * @retval HAL status
\r
2019 HAL_StatusTypeDef HAL_UART_AbortReceive_IT(UART_HandleTypeDef *huart)
\r
2021 /* Disable RXNE, PE and ERR (Frame error, noise error, overrun error) interrupts */
\r
2022 CLEAR_BIT(huart->Instance->CR1, (USART_CR1_RXNEIE | USART_CR1_PEIE));
\r
2023 CLEAR_BIT(huart->Instance->CR3, USART_CR3_EIE);
\r
2025 /* Disable the UART DMA Rx request if enabled */
\r
2026 if (HAL_IS_BIT_SET(huart->Instance->CR3, USART_CR3_DMAR))
\r
2028 CLEAR_BIT(huart->Instance->CR3, USART_CR3_DMAR);
\r
2030 /* Abort the UART DMA Rx channel : use non blocking DMA Abort API (callback) */
\r
2031 if (huart->hdmarx != NULL)
\r
2033 /* Set the UART DMA Abort callback :
\r
2034 will lead to call HAL_UART_AbortCpltCallback() at end of DMA abort procedure */
\r
2035 huart->hdmarx->XferAbortCallback = UART_DMARxOnlyAbortCallback;
\r
2037 /* Abort DMA RX */
\r
2038 if (HAL_DMA_Abort_IT(huart->hdmarx) != HAL_OK)
\r
2040 /* Call Directly huart->hdmarx->XferAbortCallback function in case of error */
\r
2041 huart->hdmarx->XferAbortCallback(huart->hdmarx);
\r
2046 /* Reset Rx transfer counter */
\r
2047 huart->RxXferCount = 0U;
\r
2049 /* Clear RxISR function pointer */
\r
2050 huart->pRxBuffPtr = NULL;
\r
2052 /* Clear the Error flags in the ICR register */
\r
2053 __HAL_UART_CLEAR_FLAG(huart, UART_CLEAR_OREF | UART_CLEAR_NEF | UART_CLEAR_PEF | UART_CLEAR_FEF);
\r
2055 /* Discard the received data */
\r
2056 __HAL_UART_SEND_REQ(huart, UART_RXDATA_FLUSH_REQUEST);
\r
2058 /* Restore huart->RxState to Ready */
\r
2059 huart->RxState = HAL_UART_STATE_READY;
\r
2061 /* As no DMA to be aborted, call directly user Abort complete callback */
\r
2062 #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
\r
2063 /* Call registered Abort Receive Complete Callback */
\r
2064 huart->AbortReceiveCpltCallback(huart);
\r
2066 /* Call legacy weak Abort Receive Complete Callback */
\r
2067 HAL_UART_AbortReceiveCpltCallback(huart);
\r
2068 #endif /* USE_HAL_UART_REGISTER_CALLBACKS */
\r
2073 /* Reset Rx transfer counter */
\r
2074 huart->RxXferCount = 0U;
\r
2076 /* Clear RxISR function pointer */
\r
2077 huart->pRxBuffPtr = NULL;
\r
2079 /* Clear the Error flags in the ICR register */
\r
2080 __HAL_UART_CLEAR_FLAG(huart, UART_CLEAR_OREF | UART_CLEAR_NEF | UART_CLEAR_PEF | UART_CLEAR_FEF);
\r
2082 /* Restore huart->RxState to Ready */
\r
2083 huart->RxState = HAL_UART_STATE_READY;
\r
2085 /* As no DMA to be aborted, call directly user Abort complete callback */
\r
2086 #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
\r
2087 /* Call registered Abort Receive Complete Callback */
\r
2088 huart->AbortReceiveCpltCallback(huart);
\r
2090 /* Call legacy weak Abort Receive Complete Callback */
\r
2091 HAL_UART_AbortReceiveCpltCallback(huart);
\r
2092 #endif /* USE_HAL_UART_REGISTER_CALLBACKS */
\r
2099 * @brief Handle UART interrupt request.
\r
2100 * @param huart UART handle.
\r
2103 void HAL_UART_IRQHandler(UART_HandleTypeDef *huart)
\r
2105 uint32_t isrflags = READ_REG(huart->Instance->ISR);
\r
2106 uint32_t cr1its = READ_REG(huart->Instance->CR1);
\r
2107 uint32_t cr3its = READ_REG(huart->Instance->CR3);
\r
2109 uint32_t errorflags;
\r
2110 uint32_t errorcode;
\r
2112 /* If no error occurs */
\r
2113 errorflags = (isrflags & (uint32_t)(USART_ISR_PE | USART_ISR_FE | USART_ISR_ORE | USART_ISR_NE));
\r
2114 if (errorflags == 0U)
\r
2116 /* UART in mode Receiver ---------------------------------------------------*/
\r
2117 if (((isrflags & USART_ISR_RXNE) != 0U)
\r
2118 && ((cr1its & USART_CR1_RXNEIE) != 0U))
\r
2120 if (huart->RxISR != NULL)
\r
2122 huart->RxISR(huart);
\r
2128 /* If some errors occur */
\r
2129 if ((errorflags != 0U)
\r
2130 && (((cr3its & USART_CR3_EIE) != 0U)
\r
2131 || ((cr1its & (USART_CR1_RXNEIE | USART_CR1_PEIE)) != 0U)))
\r
2133 /* UART parity error interrupt occurred -------------------------------------*/
\r
2134 if (((isrflags & USART_ISR_PE) != 0U) && ((cr1its & USART_CR1_PEIE) != 0U))
\r
2136 __HAL_UART_CLEAR_FLAG(huart, UART_CLEAR_PEF);
\r
2138 huart->ErrorCode |= HAL_UART_ERROR_PE;
\r
2141 /* UART frame error interrupt occurred --------------------------------------*/
\r
2142 if (((isrflags & USART_ISR_FE) != 0U) && ((cr3its & USART_CR3_EIE) != 0U))
\r
2144 __HAL_UART_CLEAR_FLAG(huart, UART_CLEAR_FEF);
\r
2146 huart->ErrorCode |= HAL_UART_ERROR_FE;
\r
2149 /* UART noise error interrupt occurred --------------------------------------*/
\r
2150 if (((isrflags & USART_ISR_NE) != 0U) && ((cr3its & USART_CR3_EIE) != 0U))
\r
2152 __HAL_UART_CLEAR_FLAG(huart, UART_CLEAR_NEF);
\r
2154 huart->ErrorCode |= HAL_UART_ERROR_NE;
\r
2157 /* UART Over-Run interrupt occurred -----------------------------------------*/
\r
2158 if (((isrflags & USART_ISR_ORE) != 0U)
\r
2159 && (((cr1its & USART_CR1_RXNEIE) != 0U) ||
\r
2160 ((cr3its & USART_CR3_EIE) != 0U)))
\r
2162 __HAL_UART_CLEAR_FLAG(huart, UART_CLEAR_OREF);
\r
2164 huart->ErrorCode |= HAL_UART_ERROR_ORE;
\r
2167 /* Call UART Error Call back function if need be --------------------------*/
\r
2168 if (huart->ErrorCode != HAL_UART_ERROR_NONE)
\r
2170 /* UART in mode Receiver ---------------------------------------------------*/
\r
2171 if (((isrflags & USART_ISR_RXNE) != 0U)
\r
2172 && ((cr1its & USART_CR1_RXNEIE) != 0U))
\r
2174 if (huart->RxISR != NULL)
\r
2176 huart->RxISR(huart);
\r
2180 /* If Overrun error occurs, or if any error occurs in DMA mode reception,
\r
2181 consider error as blocking */
\r
2182 errorcode = huart->ErrorCode;
\r
2183 if ((HAL_IS_BIT_SET(huart->Instance->CR3, USART_CR3_DMAR)) ||
\r
2184 ((errorcode & HAL_UART_ERROR_ORE) != 0U))
\r
2186 /* Blocking error : transfer is aborted
\r
2187 Set the UART state ready to be able to start again the process,
\r
2188 Disable Rx Interrupts, and disable Rx DMA request, if ongoing */
\r
2189 UART_EndRxTransfer(huart);
\r
2191 /* Disable the UART DMA Rx request if enabled */
\r
2192 if (HAL_IS_BIT_SET(huart->Instance->CR3, USART_CR3_DMAR))
\r
2194 CLEAR_BIT(huart->Instance->CR3, USART_CR3_DMAR);
\r
2196 /* Abort the UART DMA Rx channel */
\r
2197 if (huart->hdmarx != NULL)
\r
2199 /* Set the UART DMA Abort callback :
\r
2200 will lead to call HAL_UART_ErrorCallback() at end of DMA abort procedure */
\r
2201 huart->hdmarx->XferAbortCallback = UART_DMAAbortOnError;
\r
2203 /* Abort DMA RX */
\r
2204 if (HAL_DMA_Abort_IT(huart->hdmarx) != HAL_OK)
\r
2206 /* Call Directly huart->hdmarx->XferAbortCallback function in case of error */
\r
2207 huart->hdmarx->XferAbortCallback(huart->hdmarx);
\r
2212 /* Call user error callback */
\r
2213 #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
\r
2214 /*Call registered error callback*/
\r
2215 huart->ErrorCallback(huart);
\r
2217 /*Call legacy weak error callback*/
\r
2218 HAL_UART_ErrorCallback(huart);
\r
2219 #endif /* USE_HAL_UART_REGISTER_CALLBACKS */
\r
2225 /* Call user error callback */
\r
2226 #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
\r
2227 /*Call registered error callback*/
\r
2228 huart->ErrorCallback(huart);
\r
2230 /*Call legacy weak error callback*/
\r
2231 HAL_UART_ErrorCallback(huart);
\r
2232 #endif /* USE_HAL_UART_REGISTER_CALLBACKS */
\r
2237 /* Non Blocking error : transfer could go on.
\r
2238 Error is notified to user through user error callback */
\r
2239 #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
\r
2240 /*Call registered error callback*/
\r
2241 huart->ErrorCallback(huart);
\r
2243 /*Call legacy weak error callback*/
\r
2244 HAL_UART_ErrorCallback(huart);
\r
2245 #endif /* USE_HAL_UART_REGISTER_CALLBACKS */
\r
2246 huart->ErrorCode = HAL_UART_ERROR_NONE;
\r
2251 } /* End if some error occurs */
\r
2253 /* UART in mode Transmitter ------------------------------------------------*/
\r
2254 if (((isrflags & USART_ISR_TXE) != 0U)
\r
2255 && ((cr1its & USART_CR1_TXEIE) != 0U))
\r
2257 if (huart->TxISR != NULL)
\r
2259 huart->TxISR(huart);
\r
2264 /* UART in mode Transmitter (transmission end) -----------------------------*/
\r
2265 if (((isrflags & USART_ISR_TC) != 0U) && ((cr1its & USART_CR1_TCIE) != 0U))
\r
2267 UART_EndTransmit_IT(huart);
\r
2274 * @brief Tx Transfer completed callback.
\r
2275 * @param huart UART handle.
\r
2278 __weak void HAL_UART_TxCpltCallback(UART_HandleTypeDef *huart)
\r
2280 /* Prevent unused argument(s) compilation warning */
\r
2283 /* NOTE : This function should not be modified, when the callback is needed,
\r
2284 the HAL_UART_TxCpltCallback can be implemented in the user file.
\r
2289 * @brief Tx Half Transfer completed callback.
\r
2290 * @param huart UART handle.
\r
2293 __weak void HAL_UART_TxHalfCpltCallback(UART_HandleTypeDef *huart)
\r
2295 /* Prevent unused argument(s) compilation warning */
\r
2298 /* NOTE: This function should not be modified, when the callback is needed,
\r
2299 the HAL_UART_TxHalfCpltCallback can be implemented in the user file.
\r
2304 * @brief Rx Transfer completed callback.
\r
2305 * @param huart UART handle.
\r
2308 __weak void HAL_UART_RxCpltCallback(UART_HandleTypeDef *huart)
\r
2310 /* Prevent unused argument(s) compilation warning */
\r
2313 /* NOTE : This function should not be modified, when the callback is needed,
\r
2314 the HAL_UART_RxCpltCallback can be implemented in the user file.
\r
2319 * @brief Rx Half Transfer completed callback.
\r
2320 * @param huart UART handle.
\r
2323 __weak void HAL_UART_RxHalfCpltCallback(UART_HandleTypeDef *huart)
\r
2325 /* Prevent unused argument(s) compilation warning */
\r
2328 /* NOTE: This function should not be modified, when the callback is needed,
\r
2329 the HAL_UART_RxHalfCpltCallback can be implemented in the user file.
\r
2334 * @brief UART error callback.
\r
2335 * @param huart UART handle.
\r
2338 __weak void HAL_UART_ErrorCallback(UART_HandleTypeDef *huart)
\r
2340 /* Prevent unused argument(s) compilation warning */
\r
2343 /* NOTE : This function should not be modified, when the callback is needed,
\r
2344 the HAL_UART_ErrorCallback can be implemented in the user file.
\r
2349 * @brief UART Abort Complete callback.
\r
2350 * @param huart UART handle.
\r
2353 __weak void HAL_UART_AbortCpltCallback(UART_HandleTypeDef *huart)
\r
2355 /* Prevent unused argument(s) compilation warning */
\r
2358 /* NOTE : This function should not be modified, when the callback is needed,
\r
2359 the HAL_UART_AbortCpltCallback can be implemented in the user file.
\r
2364 * @brief UART Abort Complete callback.
\r
2365 * @param huart UART handle.
\r
2368 __weak void HAL_UART_AbortTransmitCpltCallback(UART_HandleTypeDef *huart)
\r
2370 /* Prevent unused argument(s) compilation warning */
\r
2373 /* NOTE : This function should not be modified, when the callback is needed,
\r
2374 the HAL_UART_AbortTransmitCpltCallback can be implemented in the user file.
\r
2379 * @brief UART Abort Receive Complete callback.
\r
2380 * @param huart UART handle.
\r
2383 __weak void HAL_UART_AbortReceiveCpltCallback(UART_HandleTypeDef *huart)
\r
2385 /* Prevent unused argument(s) compilation warning */
\r
2388 /* NOTE : This function should not be modified, when the callback is needed,
\r
2389 the HAL_UART_AbortReceiveCpltCallback can be implemented in the user file.
\r
2397 /** @defgroup UART_Exported_Functions_Group3 Peripheral Control functions
\r
2398 * @brief UART control functions
\r
2401 ===============================================================================
\r
2402 ##### Peripheral Control functions #####
\r
2403 ===============================================================================
\r
2405 This subsection provides a set of functions allowing to control the UART.
\r
2406 (+) HAL_MultiProcessor_EnableMuteMode() API enables mute mode
\r
2407 (+) HAL_MultiProcessor_DisableMuteMode() API disables mute mode
\r
2408 (+) HAL_MultiProcessor_EnterMuteMode() API enters mute mode
\r
2409 (+) UART_SetConfig() API configures the UART peripheral
\r
2410 (+) UART_AdvFeatureConfig() API optionally configures the UART advanced features
\r
2411 (+) UART_CheckIdleState() API ensures that TEACK and/or REACK are set after initialization
\r
2412 (+) HAL_HalfDuplex_EnableTransmitter() API disables receiver and enables transmitter
\r
2413 (+) HAL_HalfDuplex_EnableReceiver() API disables transmitter and enables receiver
\r
2414 (+) HAL_LIN_SendBreak() API transmits the break characters
\r
2420 * @brief Enable UART in mute mode (does not mean UART enters mute mode;
\r
2421 * to enter mute mode, HAL_MultiProcessor_EnterMuteMode() API must be called).
\r
2422 * @param huart UART handle.
\r
2423 * @retval HAL status
\r
2425 HAL_StatusTypeDef HAL_MultiProcessor_EnableMuteMode(UART_HandleTypeDef *huart)
\r
2427 /* Process Locked */
\r
2428 __HAL_LOCK(huart);
\r
2430 huart->gState = HAL_UART_STATE_BUSY;
\r
2432 /* Enable USART mute mode by setting the MME bit in the CR1 register */
\r
2433 SET_BIT(huart->Instance->CR1, USART_CR1_MME);
\r
2435 huart->gState = HAL_UART_STATE_READY;
\r
2437 return (UART_CheckIdleState(huart));
\r
2441 * @brief Disable UART mute mode (does not mean the UART actually exits mute mode
\r
2442 * as it may not have been in mute mode at this very moment).
\r
2443 * @param huart UART handle.
\r
2444 * @retval HAL status
\r
2446 HAL_StatusTypeDef HAL_MultiProcessor_DisableMuteMode(UART_HandleTypeDef *huart)
\r
2448 /* Process Locked */
\r
2449 __HAL_LOCK(huart);
\r
2451 huart->gState = HAL_UART_STATE_BUSY;
\r
2453 /* Disable USART mute mode by clearing the MME bit in the CR1 register */
\r
2454 CLEAR_BIT(huart->Instance->CR1, USART_CR1_MME);
\r
2456 huart->gState = HAL_UART_STATE_READY;
\r
2458 return (UART_CheckIdleState(huart));
\r
2462 * @brief Enter UART mute mode (means UART actually enters mute mode).
\r
2463 * @note To exit from mute mode, HAL_MultiProcessor_DisableMuteMode() API must be called.
\r
2464 * @param huart UART handle.
\r
2467 void HAL_MultiProcessor_EnterMuteMode(UART_HandleTypeDef *huart)
\r
2469 __HAL_UART_SEND_REQ(huart, UART_MUTE_MODE_REQUEST);
\r
2473 * @brief Enable the UART transmitter and disable the UART receiver.
\r
2474 * @param huart UART handle.
\r
2475 * @retval HAL status
\r
2477 HAL_StatusTypeDef HAL_HalfDuplex_EnableTransmitter(UART_HandleTypeDef *huart)
\r
2479 /* Process Locked */
\r
2480 __HAL_LOCK(huart);
\r
2481 huart->gState = HAL_UART_STATE_BUSY;
\r
2483 /* Clear TE and RE bits */
\r
2484 CLEAR_BIT(huart->Instance->CR1, (USART_CR1_TE | USART_CR1_RE));
\r
2486 /* Enable the USART's transmit interface by setting the TE bit in the USART CR1 register */
\r
2487 SET_BIT(huart->Instance->CR1, USART_CR1_TE);
\r
2489 huart->gState = HAL_UART_STATE_READY;
\r
2491 /* Process Unlocked */
\r
2492 __HAL_UNLOCK(huart);
\r
2498 * @brief Enable the UART receiver and disable the UART transmitter.
\r
2499 * @param huart UART handle.
\r
2500 * @retval HAL status.
\r
2502 HAL_StatusTypeDef HAL_HalfDuplex_EnableReceiver(UART_HandleTypeDef *huart)
\r
2504 /* Process Locked */
\r
2505 __HAL_LOCK(huart);
\r
2506 huart->gState = HAL_UART_STATE_BUSY;
\r
2508 /* Clear TE and RE bits */
\r
2509 CLEAR_BIT(huart->Instance->CR1, (USART_CR1_TE | USART_CR1_RE));
\r
2511 /* Enable the USART's receive interface by setting the RE bit in the USART CR1 register */
\r
2512 SET_BIT(huart->Instance->CR1, USART_CR1_RE);
\r
2514 huart->gState = HAL_UART_STATE_READY;
\r
2516 /* Process Unlocked */
\r
2517 __HAL_UNLOCK(huart);
\r
2524 * @brief Transmit break characters.
\r
2525 * @param huart UART handle.
\r
2526 * @retval HAL status
\r
2528 HAL_StatusTypeDef HAL_LIN_SendBreak(UART_HandleTypeDef *huart)
\r
2530 /* Check the parameters */
\r
2531 assert_param(IS_UART_LIN_INSTANCE(huart->Instance));
\r
2533 /* Process Locked */
\r
2534 __HAL_LOCK(huart);
\r
2536 huart->gState = HAL_UART_STATE_BUSY;
\r
2538 /* Send break characters */
\r
2539 __HAL_UART_SEND_REQ(huart, UART_SENDBREAK_REQUEST);
\r
2541 huart->gState = HAL_UART_STATE_READY;
\r
2543 /* Process Unlocked */
\r
2544 __HAL_UNLOCK(huart);
\r
2553 /** @defgroup UART_Exported_Functions_Group4 Peripheral State and Error functions
\r
2554 * @brief UART Peripheral State functions
\r
2557 ==============================================================================
\r
2558 ##### Peripheral State and Error functions #####
\r
2559 ==============================================================================
\r
2561 This subsection provides functions allowing to :
\r
2562 (+) Return the UART handle state.
\r
2563 (+) Return the UART handle error code
\r
2570 * @brief Return the UART handle state.
\r
2571 * @param huart Pointer to a UART_HandleTypeDef structure that contains
\r
2572 * the configuration information for the specified UART.
\r
2573 * @retval HAL state
\r
2575 HAL_UART_StateTypeDef HAL_UART_GetState(UART_HandleTypeDef *huart)
\r
2577 uint32_t temp1, temp2;
\r
2578 temp1 = huart->gState;
\r
2579 temp2 = huart->RxState;
\r
2581 return (HAL_UART_StateTypeDef)(temp1 | temp2);
\r
2585 * @brief Return the UART handle error code.
\r
2586 * @param huart Pointer to a UART_HandleTypeDef structure that contains
\r
2587 * the configuration information for the specified UART.
\r
2588 * @retval UART Error Code
\r
2590 uint32_t HAL_UART_GetError(UART_HandleTypeDef *huart)
\r
2592 return huart->ErrorCode;
\r
2602 /** @defgroup UART_Private_Functions UART Private Functions
\r
2607 * @brief Initialize the callbacks to their default values.
\r
2608 * @param huart UART handle.
\r
2611 #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
\r
2612 void UART_InitCallbacksToDefault(UART_HandleTypeDef *huart)
\r
2614 /* Init the UART Callback settings */
\r
2615 huart->TxHalfCpltCallback = HAL_UART_TxHalfCpltCallback; /* Legacy weak TxHalfCpltCallback */
\r
2616 huart->TxCpltCallback = HAL_UART_TxCpltCallback; /* Legacy weak TxCpltCallback */
\r
2617 huart->RxHalfCpltCallback = HAL_UART_RxHalfCpltCallback; /* Legacy weak RxHalfCpltCallback */
\r
2618 huart->RxCpltCallback = HAL_UART_RxCpltCallback; /* Legacy weak RxCpltCallback */
\r
2619 huart->ErrorCallback = HAL_UART_ErrorCallback; /* Legacy weak ErrorCallback */
\r
2620 huart->AbortCpltCallback = HAL_UART_AbortCpltCallback; /* Legacy weak AbortCpltCallback */
\r
2621 huart->AbortTransmitCpltCallback = HAL_UART_AbortTransmitCpltCallback; /* Legacy weak AbortTransmitCpltCallback */
\r
2622 huart->AbortReceiveCpltCallback = HAL_UART_AbortReceiveCpltCallback; /* Legacy weak AbortReceiveCpltCallback */
\r
2625 #endif /* USE_HAL_UART_REGISTER_CALLBACKS */
\r
2628 * @brief Configure the UART peripheral.
\r
2629 * @param huart UART handle.
\r
2630 * @retval HAL status
\r
2632 HAL_StatusTypeDef UART_SetConfig(UART_HandleTypeDef *huart)
\r
2636 UART_ClockSourceTypeDef clocksource;
\r
2637 uint32_t usartdiv = 0x00000000U;
\r
2638 HAL_StatusTypeDef ret = HAL_OK;
\r
2640 /* Check the parameters */
\r
2641 assert_param(IS_UART_BAUDRATE(huart->Init.BaudRate));
\r
2642 assert_param(IS_UART_WORD_LENGTH(huart->Init.WordLength));
\r
2643 assert_param(IS_UART_STOPBITS(huart->Init.StopBits));
\r
2644 assert_param(IS_UART_ONE_BIT_SAMPLE(huart->Init.OneBitSampling));
\r
2646 assert_param(IS_UART_PARITY(huart->Init.Parity));
\r
2647 assert_param(IS_UART_MODE(huart->Init.Mode));
\r
2648 assert_param(IS_UART_HARDWARE_FLOW_CONTROL(huart->Init.HwFlowCtl));
\r
2649 assert_param(IS_UART_OVERSAMPLING(huart->Init.OverSampling));
\r
2651 /*-------------------------- USART CR1 Configuration -----------------------*/
\r
2652 /* Clear M, PCE, PS, TE, RE and OVER8 bits and configure
\r
2653 * the UART Word Length, Parity, Mode and oversampling:
\r
2654 * set the M bits according to huart->Init.WordLength value
\r
2655 * set PCE and PS bits according to huart->Init.Parity value
\r
2656 * set TE and RE bits according to huart->Init.Mode value
\r
2657 * set OVER8 bit according to huart->Init.OverSampling value */
\r
2658 tmpreg = (uint32_t)huart->Init.WordLength | huart->Init.Parity | huart->Init.Mode | huart->Init.OverSampling ;
\r
2659 MODIFY_REG(huart->Instance->CR1, USART_CR1_FIELDS, tmpreg);
\r
2661 /*-------------------------- USART CR2 Configuration -----------------------*/
\r
2662 /* Configure the UART Stop Bits: Set STOP[13:12] bits according
\r
2663 * to huart->Init.StopBits value */
\r
2664 MODIFY_REG(huart->Instance->CR2, USART_CR2_STOP, huart->Init.StopBits);
\r
2666 /*-------------------------- USART CR3 Configuration -----------------------*/
\r
2668 * - UART HardWare Flow Control: set CTSE and RTSE bits according
\r
2669 * to huart->Init.HwFlowCtl value
\r
2670 * - one-bit sampling method versus three samples' majority rule according
\r
2671 * to huart->Init.OneBitSampling (not applicable to LPUART) */
\r
2672 tmpreg = (uint32_t)huart->Init.HwFlowCtl;
\r
2674 tmpreg |= huart->Init.OneBitSampling;
\r
2675 MODIFY_REG(huart->Instance->CR3, USART_CR3_FIELDS, tmpreg);
\r
2678 /*-------------------------- USART BRR Configuration -----------------------*/
\r
2679 UART_GETCLOCKSOURCE(huart, clocksource);
\r
2681 if (huart->Init.OverSampling == UART_OVERSAMPLING_8)
\r
2683 switch (clocksource)
\r
2685 case UART_CLOCKSOURCE_PCLK1:
\r
2686 usartdiv = (uint16_t)(UART_DIV_SAMPLING8(HAL_RCC_GetPCLK1Freq(), huart->Init.BaudRate));
\r
2688 case UART_CLOCKSOURCE_PCLK2:
\r
2689 usartdiv = (uint16_t)(UART_DIV_SAMPLING8(HAL_RCC_GetPCLK2Freq(), huart->Init.BaudRate));
\r
2691 case UART_CLOCKSOURCE_HSI:
\r
2692 usartdiv = (uint16_t)(UART_DIV_SAMPLING8(HSI_VALUE, huart->Init.BaudRate));
\r
2694 case UART_CLOCKSOURCE_SYSCLK:
\r
2695 usartdiv = (uint16_t)(UART_DIV_SAMPLING8(HAL_RCC_GetSysClockFreq(), huart->Init.BaudRate));
\r
2697 case UART_CLOCKSOURCE_LSE:
\r
2698 usartdiv = (uint16_t)(UART_DIV_SAMPLING8(LSE_VALUE, huart->Init.BaudRate));
\r
2700 case UART_CLOCKSOURCE_UNDEFINED:
\r
2706 /* USARTDIV must be greater than or equal to 0d16 */
\r
2707 if ((usartdiv >= UART_BRR_MIN) && (usartdiv <= UART_BRR_MAX))
\r
2709 brrtemp = (uint16_t)(usartdiv & 0xFFF0U);
\r
2710 brrtemp |= (uint16_t)((usartdiv & (uint16_t)0x000FU) >> 1U);
\r
2711 huart->Instance->BRR = brrtemp;
\r
2720 switch (clocksource)
\r
2722 case UART_CLOCKSOURCE_PCLK1:
\r
2723 usartdiv = (uint16_t)(UART_DIV_SAMPLING16(HAL_RCC_GetPCLK1Freq(), huart->Init.BaudRate));
\r
2725 case UART_CLOCKSOURCE_PCLK2:
\r
2726 usartdiv = (uint16_t)(UART_DIV_SAMPLING16(HAL_RCC_GetPCLK2Freq(), huart->Init.BaudRate));
\r
2728 case UART_CLOCKSOURCE_HSI:
\r
2729 usartdiv = (uint16_t)(UART_DIV_SAMPLING16(HSI_VALUE, huart->Init.BaudRate));
\r
2731 case UART_CLOCKSOURCE_SYSCLK:
\r
2732 usartdiv = (uint16_t)(UART_DIV_SAMPLING16(HAL_RCC_GetSysClockFreq(), huart->Init.BaudRate));
\r
2734 case UART_CLOCKSOURCE_LSE:
\r
2735 usartdiv = (uint16_t)(UART_DIV_SAMPLING16(LSE_VALUE, huart->Init.BaudRate));
\r
2737 case UART_CLOCKSOURCE_UNDEFINED:
\r
2743 /* USARTDIV must be greater than or equal to 0d16 */
\r
2744 if ((usartdiv >= UART_BRR_MIN) && (usartdiv <= UART_BRR_MAX))
\r
2746 huart->Instance->BRR = usartdiv;
\r
2755 /* Clear ISR function pointers */
\r
2756 huart->RxISR = NULL;
\r
2757 huart->TxISR = NULL;
\r
2763 * @brief Configure the UART peripheral advanced features.
\r
2764 * @param huart UART handle.
\r
2767 void UART_AdvFeatureConfig(UART_HandleTypeDef *huart)
\r
2769 /* Check whether the set of advanced features to configure is properly set */
\r
2770 assert_param(IS_UART_ADVFEATURE_INIT(huart->AdvancedInit.AdvFeatureInit));
\r
2772 /* if required, configure TX pin active level inversion */
\r
2773 if (HAL_IS_BIT_SET(huart->AdvancedInit.AdvFeatureInit, UART_ADVFEATURE_TXINVERT_INIT))
\r
2775 assert_param(IS_UART_ADVFEATURE_TXINV(huart->AdvancedInit.TxPinLevelInvert));
\r
2776 MODIFY_REG(huart->Instance->CR2, USART_CR2_TXINV, huart->AdvancedInit.TxPinLevelInvert);
\r
2779 /* if required, configure RX pin active level inversion */
\r
2780 if (HAL_IS_BIT_SET(huart->AdvancedInit.AdvFeatureInit, UART_ADVFEATURE_RXINVERT_INIT))
\r
2782 assert_param(IS_UART_ADVFEATURE_RXINV(huart->AdvancedInit.RxPinLevelInvert));
\r
2783 MODIFY_REG(huart->Instance->CR2, USART_CR2_RXINV, huart->AdvancedInit.RxPinLevelInvert);
\r
2786 /* if required, configure data inversion */
\r
2787 if (HAL_IS_BIT_SET(huart->AdvancedInit.AdvFeatureInit, UART_ADVFEATURE_DATAINVERT_INIT))
\r
2789 assert_param(IS_UART_ADVFEATURE_DATAINV(huart->AdvancedInit.DataInvert));
\r
2790 MODIFY_REG(huart->Instance->CR2, USART_CR2_DATAINV, huart->AdvancedInit.DataInvert);
\r
2793 /* if required, configure RX/TX pins swap */
\r
2794 if (HAL_IS_BIT_SET(huart->AdvancedInit.AdvFeatureInit, UART_ADVFEATURE_SWAP_INIT))
\r
2796 assert_param(IS_UART_ADVFEATURE_SWAP(huart->AdvancedInit.Swap));
\r
2797 MODIFY_REG(huart->Instance->CR2, USART_CR2_SWAP, huart->AdvancedInit.Swap);
\r
2800 /* if required, configure RX overrun detection disabling */
\r
2801 if (HAL_IS_BIT_SET(huart->AdvancedInit.AdvFeatureInit, UART_ADVFEATURE_RXOVERRUNDISABLE_INIT))
\r
2803 assert_param(IS_UART_OVERRUN(huart->AdvancedInit.OverrunDisable));
\r
2804 MODIFY_REG(huart->Instance->CR3, USART_CR3_OVRDIS, huart->AdvancedInit.OverrunDisable);
\r
2807 /* if required, configure DMA disabling on reception error */
\r
2808 if (HAL_IS_BIT_SET(huart->AdvancedInit.AdvFeatureInit, UART_ADVFEATURE_DMADISABLEONERROR_INIT))
\r
2810 assert_param(IS_UART_ADVFEATURE_DMAONRXERROR(huart->AdvancedInit.DMADisableonRxError));
\r
2811 MODIFY_REG(huart->Instance->CR3, USART_CR3_DDRE, huart->AdvancedInit.DMADisableonRxError);
\r
2814 /* if required, configure auto Baud rate detection scheme */
\r
2815 if (HAL_IS_BIT_SET(huart->AdvancedInit.AdvFeatureInit, UART_ADVFEATURE_AUTOBAUDRATE_INIT))
\r
2817 assert_param(IS_USART_AUTOBAUDRATE_DETECTION_INSTANCE(huart->Instance));
\r
2818 assert_param(IS_UART_ADVFEATURE_AUTOBAUDRATE(huart->AdvancedInit.AutoBaudRateEnable));
\r
2819 MODIFY_REG(huart->Instance->CR2, USART_CR2_ABREN, huart->AdvancedInit.AutoBaudRateEnable);
\r
2820 /* set auto Baudrate detection parameters if detection is enabled */
\r
2821 if (huart->AdvancedInit.AutoBaudRateEnable == UART_ADVFEATURE_AUTOBAUDRATE_ENABLE)
\r
2823 assert_param(IS_UART_ADVFEATURE_AUTOBAUDRATEMODE(huart->AdvancedInit.AutoBaudRateMode));
\r
2824 MODIFY_REG(huart->Instance->CR2, USART_CR2_ABRMODE, huart->AdvancedInit.AutoBaudRateMode);
\r
2828 /* if required, configure MSB first on communication line */
\r
2829 if (HAL_IS_BIT_SET(huart->AdvancedInit.AdvFeatureInit, UART_ADVFEATURE_MSBFIRST_INIT))
\r
2831 assert_param(IS_UART_ADVFEATURE_MSBFIRST(huart->AdvancedInit.MSBFirst));
\r
2832 MODIFY_REG(huart->Instance->CR2, USART_CR2_MSBFIRST, huart->AdvancedInit.MSBFirst);
\r
2837 * @brief Check the UART Idle State.
\r
2838 * @param huart UART handle.
\r
2839 * @retval HAL status
\r
2841 HAL_StatusTypeDef UART_CheckIdleState(UART_HandleTypeDef *huart)
\r
2843 uint32_t tickstart;
\r
2845 /* Initialize the UART ErrorCode */
\r
2846 huart->ErrorCode = HAL_UART_ERROR_NONE;
\r
2848 /* Init tickstart for timeout managment*/
\r
2849 tickstart = HAL_GetTick();
\r
2851 /* Check if the Transmitter is enabled */
\r
2852 if ((huart->Instance->CR1 & USART_CR1_TE) == USART_CR1_TE)
\r
2854 /* Wait until TEACK flag is set */
\r
2855 if (UART_WaitOnFlagUntilTimeout(huart, USART_ISR_TEACK, RESET, tickstart, HAL_UART_TIMEOUT_VALUE) != HAL_OK)
\r
2857 /* Timeout occurred */
\r
2858 return HAL_TIMEOUT;
\r
2862 /* Initialize the UART State */
\r
2863 huart->gState = HAL_UART_STATE_READY;
\r
2864 huart->RxState = HAL_UART_STATE_READY;
\r
2866 /* Process Unlocked */
\r
2867 __HAL_UNLOCK(huart);
\r
2873 * @brief Handle UART Communication Timeout.
\r
2874 * @param huart UART handle.
\r
2875 * @param Flag Specifies the UART flag to check
\r
2876 * @param Status Flag status (SET or RESET)
\r
2877 * @param Tickstart Tick start value
\r
2878 * @param Timeout Timeout duration
\r
2879 * @retval HAL status
\r
2881 HAL_StatusTypeDef UART_WaitOnFlagUntilTimeout(UART_HandleTypeDef *huart, uint32_t Flag, FlagStatus Status, uint32_t Tickstart, uint32_t Timeout)
\r
2883 /* Wait until flag is set */
\r
2884 while ((__HAL_UART_GET_FLAG(huart, Flag) ? SET : RESET) == Status)
\r
2886 /* Check for the Timeout */
\r
2887 if (Timeout != HAL_MAX_DELAY)
\r
2889 if (((HAL_GetTick() - Tickstart) > Timeout) || (Timeout == 0U))
\r
2891 /* Disable TXE, RXNE, PE and ERR (Frame error, noise error, overrun error) interrupts for the interrupt process */
\r
2892 CLEAR_BIT(huart->Instance->CR1, (USART_CR1_RXNEIE | USART_CR1_PEIE | USART_CR1_TXEIE));
\r
2893 CLEAR_BIT(huart->Instance->CR3, USART_CR3_EIE);
\r
2895 huart->gState = HAL_UART_STATE_READY;
\r
2896 huart->RxState = HAL_UART_STATE_READY;
\r
2898 /* Process Unlocked */
\r
2899 __HAL_UNLOCK(huart);
\r
2901 return HAL_TIMEOUT;
\r
2910 * @brief End ongoing Tx transfer on UART peripheral (following error detection or Transmit completion).
\r
2911 * @param huart UART handle.
\r
2914 static void UART_EndTxTransfer(UART_HandleTypeDef *huart)
\r
2916 /* Disable TXEIE and TCIE interrupts */
\r
2917 CLEAR_BIT(huart->Instance->CR1, (USART_CR1_TXEIE | USART_CR1_TCIE));
\r
2919 /* At end of Tx process, restore huart->gState to Ready */
\r
2920 huart->gState = HAL_UART_STATE_READY;
\r
2925 * @brief End ongoing Rx transfer on UART peripheral (following error detection or Reception completion).
\r
2926 * @param huart UART handle.
\r
2929 static void UART_EndRxTransfer(UART_HandleTypeDef *huart)
\r
2931 /* Disable RXNE, PE and ERR (Frame error, noise error, overrun error) interrupts */
\r
2932 CLEAR_BIT(huart->Instance->CR1, (USART_CR1_RXNEIE | USART_CR1_PEIE));
\r
2933 CLEAR_BIT(huart->Instance->CR3, USART_CR3_EIE);
\r
2935 /* At end of Rx process, restore huart->RxState to Ready */
\r
2936 huart->RxState = HAL_UART_STATE_READY;
\r
2938 /* Reset RxIsr function pointer */
\r
2939 huart->RxISR = NULL;
\r
2944 * @brief DMA UART transmit process complete callback.
\r
2945 * @param hdma DMA handle.
\r
2948 static void UART_DMATransmitCplt(DMA_HandleTypeDef *hdma)
\r
2950 UART_HandleTypeDef *huart = (UART_HandleTypeDef *)(hdma->Parent);
\r
2952 /* DMA Normal mode */
\r
2953 if (hdma->Init.Mode != DMA_CIRCULAR)
\r
2955 huart->TxXferCount = 0U;
\r
2957 /* Disable the DMA transfer for transmit request by resetting the DMAT bit
\r
2958 in the UART CR3 register */
\r
2959 CLEAR_BIT(huart->Instance->CR3, USART_CR3_DMAT);
\r
2961 /* Enable the UART Transmit Complete Interrupt */
\r
2962 SET_BIT(huart->Instance->CR1, USART_CR1_TCIE);
\r
2964 /* DMA Circular mode */
\r
2967 #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
\r
2968 /*Call registered Tx complete callback*/
\r
2969 huart->TxCpltCallback(huart);
\r
2971 /*Call legacy weak Tx complete callback*/
\r
2972 HAL_UART_TxCpltCallback(huart);
\r
2973 #endif /* USE_HAL_UART_REGISTER_CALLBACKS */
\r
2978 * @brief DMA UART transmit process half complete callback.
\r
2979 * @param hdma DMA handle.
\r
2982 static void UART_DMATxHalfCplt(DMA_HandleTypeDef *hdma)
\r
2984 UART_HandleTypeDef *huart = (UART_HandleTypeDef *)(hdma->Parent);
\r
2986 #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
\r
2987 /*Call registered Tx Half complete callback*/
\r
2988 huart->TxHalfCpltCallback(huart);
\r
2990 /*Call legacy weak Tx Half complete callback*/
\r
2991 HAL_UART_TxHalfCpltCallback(huart);
\r
2992 #endif /* USE_HAL_UART_REGISTER_CALLBACKS */
\r
2996 * @brief DMA UART receive process complete callback.
\r
2997 * @param hdma DMA handle.
\r
3000 static void UART_DMAReceiveCplt(DMA_HandleTypeDef *hdma)
\r
3002 UART_HandleTypeDef *huart = (UART_HandleTypeDef *)(hdma->Parent);
\r
3004 /* DMA Normal mode */
\r
3005 if (hdma->Init.Mode != DMA_CIRCULAR)
\r
3007 huart->RxXferCount = 0U;
\r
3009 /* Disable PE and ERR (Frame error, noise error, overrun error) interrupts */
\r
3010 CLEAR_BIT(huart->Instance->CR1, USART_CR1_PEIE);
\r
3011 CLEAR_BIT(huart->Instance->CR3, USART_CR3_EIE);
\r
3013 /* Disable the DMA transfer for the receiver request by resetting the DMAR bit
\r
3014 in the UART CR3 register */
\r
3015 CLEAR_BIT(huart->Instance->CR3, USART_CR3_DMAR);
\r
3017 /* At end of Rx process, restore huart->RxState to Ready */
\r
3018 huart->RxState = HAL_UART_STATE_READY;
\r
3021 #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
\r
3022 /*Call registered Rx complete callback*/
\r
3023 huart->RxCpltCallback(huart);
\r
3025 /*Call legacy weak Rx complete callback*/
\r
3026 HAL_UART_RxCpltCallback(huart);
\r
3027 #endif /* USE_HAL_UART_REGISTER_CALLBACKS */
\r
3031 * @brief DMA UART receive process half complete callback.
\r
3032 * @param hdma DMA handle.
\r
3035 static void UART_DMARxHalfCplt(DMA_HandleTypeDef *hdma)
\r
3037 UART_HandleTypeDef *huart = (UART_HandleTypeDef *)(hdma->Parent);
\r
3039 #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
\r
3040 /*Call registered Rx Half complete callback*/
\r
3041 huart->RxHalfCpltCallback(huart);
\r
3043 /*Call legacy weak Rx Half complete callback*/
\r
3044 HAL_UART_RxHalfCpltCallback(huart);
\r
3045 #endif /* USE_HAL_UART_REGISTER_CALLBACKS */
\r
3049 * @brief DMA UART communication error callback.
\r
3050 * @param hdma DMA handle.
\r
3053 static void UART_DMAError(DMA_HandleTypeDef *hdma)
\r
3055 UART_HandleTypeDef *huart = (UART_HandleTypeDef *)(hdma->Parent);
\r
3057 const HAL_UART_StateTypeDef gstate = huart->gState;
\r
3058 const HAL_UART_StateTypeDef rxstate = huart->RxState;
\r
3060 /* Stop UART DMA Tx request if ongoing */
\r
3061 if ((HAL_IS_BIT_SET(huart->Instance->CR3, USART_CR3_DMAT)) &&
\r
3062 (gstate == HAL_UART_STATE_BUSY_TX))
\r
3064 huart->TxXferCount = 0U;
\r
3065 UART_EndTxTransfer(huart);
\r
3068 /* Stop UART DMA Rx request if ongoing */
\r
3069 if ((HAL_IS_BIT_SET(huart->Instance->CR3, USART_CR3_DMAR)) &&
\r
3070 (rxstate == HAL_UART_STATE_BUSY_RX))
\r
3072 huart->RxXferCount = 0U;
\r
3073 UART_EndRxTransfer(huart);
\r
3076 huart->ErrorCode |= HAL_UART_ERROR_DMA;
\r
3078 #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
\r
3079 /*Call registered error callback*/
\r
3080 huart->ErrorCallback(huart);
\r
3082 /*Call legacy weak error callback*/
\r
3083 HAL_UART_ErrorCallback(huart);
\r
3084 #endif /* USE_HAL_UART_REGISTER_CALLBACKS */
\r
3088 * @brief DMA UART communication abort callback, when initiated by HAL services on Error
\r
3089 * (To be called at end of DMA Abort procedure following error occurrence).
\r
3090 * @param hdma DMA handle.
\r
3093 static void UART_DMAAbortOnError(DMA_HandleTypeDef *hdma)
\r
3095 UART_HandleTypeDef *huart = (UART_HandleTypeDef *)(hdma->Parent);
\r
3096 huart->RxXferCount = 0U;
\r
3097 huart->TxXferCount = 0U;
\r
3099 #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
\r
3100 /*Call registered error callback*/
\r
3101 huart->ErrorCallback(huart);
\r
3103 /*Call legacy weak error callback*/
\r
3104 HAL_UART_ErrorCallback(huart);
\r
3105 #endif /* USE_HAL_UART_REGISTER_CALLBACKS */
\r
3109 * @brief DMA UART Tx communication abort callback, when initiated by user
\r
3110 * (To be called at end of DMA Tx Abort procedure following user abort request).
\r
3111 * @note When this callback is executed, User Abort complete call back is called only if no
\r
3112 * Abort still ongoing for Rx DMA Handle.
\r
3113 * @param hdma DMA handle.
\r
3116 static void UART_DMATxAbortCallback(DMA_HandleTypeDef *hdma)
\r
3118 UART_HandleTypeDef *huart = (UART_HandleTypeDef *)(hdma->Parent);
\r
3120 huart->hdmatx->XferAbortCallback = NULL;
\r
3122 /* Check if an Abort process is still ongoing */
\r
3123 if (huart->hdmarx != NULL)
\r
3125 if (huart->hdmarx->XferAbortCallback != NULL)
\r
3131 /* No Abort process still ongoing : All DMA channels are aborted, call user Abort Complete callback */
\r
3132 huart->TxXferCount = 0U;
\r
3133 huart->RxXferCount = 0U;
\r
3135 /* Reset errorCode */
\r
3136 huart->ErrorCode = HAL_UART_ERROR_NONE;
\r
3138 /* Clear the Error flags in the ICR register */
\r
3139 __HAL_UART_CLEAR_FLAG(huart, UART_CLEAR_OREF | UART_CLEAR_NEF | UART_CLEAR_PEF | UART_CLEAR_FEF);
\r
3142 /* Restore huart->gState and huart->RxState to Ready */
\r
3143 huart->gState = HAL_UART_STATE_READY;
\r
3144 huart->RxState = HAL_UART_STATE_READY;
\r
3146 /* Call user Abort complete callback */
\r
3147 #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
\r
3148 /* Call registered Abort complete callback */
\r
3149 huart->AbortCpltCallback(huart);
\r
3151 /* Call legacy weak Abort complete callback */
\r
3152 HAL_UART_AbortCpltCallback(huart);
\r
3153 #endif /* USE_HAL_UART_REGISTER_CALLBACKS */
\r
3158 * @brief DMA UART Rx communication abort callback, when initiated by user
\r
3159 * (To be called at end of DMA Rx Abort procedure following user abort request).
\r
3160 * @note When this callback is executed, User Abort complete call back is called only if no
\r
3161 * Abort still ongoing for Tx DMA Handle.
\r
3162 * @param hdma DMA handle.
\r
3165 static void UART_DMARxAbortCallback(DMA_HandleTypeDef *hdma)
\r
3167 UART_HandleTypeDef *huart = (UART_HandleTypeDef *)(hdma->Parent);
\r
3169 huart->hdmarx->XferAbortCallback = NULL;
\r
3171 /* Check if an Abort process is still ongoing */
\r
3172 if (huart->hdmatx != NULL)
\r
3174 if (huart->hdmatx->XferAbortCallback != NULL)
\r
3180 /* No Abort process still ongoing : All DMA channels are aborted, call user Abort Complete callback */
\r
3181 huart->TxXferCount = 0U;
\r
3182 huart->RxXferCount = 0U;
\r
3184 /* Reset errorCode */
\r
3185 huart->ErrorCode = HAL_UART_ERROR_NONE;
\r
3187 /* Clear the Error flags in the ICR register */
\r
3188 __HAL_UART_CLEAR_FLAG(huart, UART_CLEAR_OREF | UART_CLEAR_NEF | UART_CLEAR_PEF | UART_CLEAR_FEF);
\r
3190 /* Discard the received data */
\r
3191 __HAL_UART_SEND_REQ(huart, UART_RXDATA_FLUSH_REQUEST);
\r
3193 /* Restore huart->gState and huart->RxState to Ready */
\r
3194 huart->gState = HAL_UART_STATE_READY;
\r
3195 huart->RxState = HAL_UART_STATE_READY;
\r
3197 /* Call user Abort complete callback */
\r
3198 #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
\r
3199 /* Call registered Abort complete callback */
\r
3200 huart->AbortCpltCallback(huart);
\r
3202 /* Call legacy weak Abort complete callback */
\r
3203 HAL_UART_AbortCpltCallback(huart);
\r
3204 #endif /* USE_HAL_UART_REGISTER_CALLBACKS */
\r
3209 * @brief DMA UART Tx communication abort callback, when initiated by user by a call to
\r
3210 * HAL_UART_AbortTransmit_IT API (Abort only Tx transfer)
\r
3211 * (This callback is executed at end of DMA Tx Abort procedure following user abort request,
\r
3212 * and leads to user Tx Abort Complete callback execution).
\r
3213 * @param hdma DMA handle.
\r
3216 static void UART_DMATxOnlyAbortCallback(DMA_HandleTypeDef *hdma)
\r
3218 UART_HandleTypeDef *huart = (UART_HandleTypeDef *)(hdma->Parent);
\r
3220 huart->TxXferCount = 0U;
\r
3223 /* Restore huart->gState to Ready */
\r
3224 huart->gState = HAL_UART_STATE_READY;
\r
3226 /* Call user Abort complete callback */
\r
3227 #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
\r
3228 /* Call registered Abort Transmit Complete Callback */
\r
3229 huart->AbortTransmitCpltCallback(huart);
\r
3231 /* Call legacy weak Abort Transmit Complete Callback */
\r
3232 HAL_UART_AbortTransmitCpltCallback(huart);
\r
3233 #endif /* USE_HAL_UART_REGISTER_CALLBACKS */
\r
3237 * @brief DMA UART Rx communication abort callback, when initiated by user by a call to
\r
3238 * HAL_UART_AbortReceive_IT API (Abort only Rx transfer)
\r
3239 * (This callback is executed at end of DMA Rx Abort procedure following user abort request,
\r
3240 * and leads to user Rx Abort Complete callback execution).
\r
3241 * @param hdma DMA handle.
\r
3244 static void UART_DMARxOnlyAbortCallback(DMA_HandleTypeDef *hdma)
\r
3246 UART_HandleTypeDef *huart = (UART_HandleTypeDef *)((DMA_HandleTypeDef *)hdma)->Parent;
\r
3248 huart->RxXferCount = 0U;
\r
3250 /* Clear the Error flags in the ICR register */
\r
3251 __HAL_UART_CLEAR_FLAG(huart, UART_CLEAR_OREF | UART_CLEAR_NEF | UART_CLEAR_PEF | UART_CLEAR_FEF);
\r
3253 /* Discard the received data */
\r
3254 __HAL_UART_SEND_REQ(huart, UART_RXDATA_FLUSH_REQUEST);
\r
3256 /* Restore huart->RxState to Ready */
\r
3257 huart->RxState = HAL_UART_STATE_READY;
\r
3259 /* Call user Abort complete callback */
\r
3260 #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
\r
3261 /* Call registered Abort Receive Complete Callback */
\r
3262 huart->AbortReceiveCpltCallback(huart);
\r
3264 /* Call legacy weak Abort Receive Complete Callback */
\r
3265 HAL_UART_AbortReceiveCpltCallback(huart);
\r
3266 #endif /* USE_HAL_UART_REGISTER_CALLBACKS */
\r
3270 * @brief TX interrrupt handler for 7 or 8 bits data word length .
\r
3271 * @note Function is called under interruption only, once
\r
3272 * interruptions have been enabled by HAL_UART_Transmit_IT().
\r
3273 * @param huart UART handle.
\r
3276 static void UART_TxISR_8BIT(UART_HandleTypeDef *huart)
\r
3278 /* Check that a Tx process is ongoing */
\r
3279 if (huart->gState == HAL_UART_STATE_BUSY_TX)
\r
3281 if (huart->TxXferCount == 0U)
\r
3283 /* Disable the UART Transmit Data Register Empty Interrupt */
\r
3284 CLEAR_BIT(huart->Instance->CR1, USART_CR1_TXEIE);
\r
3286 /* Enable the UART Transmit Complete Interrupt */
\r
3287 SET_BIT(huart->Instance->CR1, USART_CR1_TCIE);
\r
3291 huart->Instance->TDR = (uint8_t)(*huart->pTxBuffPtr & (uint8_t)0xFF);
\r
3292 huart->pTxBuffPtr++;
\r
3293 huart->TxXferCount--;
\r
3299 * @brief TX interrrupt handler for 9 bits data word length.
\r
3300 * @note Function is called under interruption only, once
\r
3301 * interruptions have been enabled by HAL_UART_Transmit_IT().
\r
3302 * @param huart UART handle.
\r
3305 static void UART_TxISR_16BIT(UART_HandleTypeDef *huart)
\r
3309 /* Check that a Tx process is ongoing */
\r
3310 if (huart->gState == HAL_UART_STATE_BUSY_TX)
\r
3312 if (huart->TxXferCount == 0U)
\r
3314 /* Disable the UART Transmit Data Register Empty Interrupt */
\r
3315 CLEAR_BIT(huart->Instance->CR1, USART_CR1_TXEIE);
\r
3317 /* Enable the UART Transmit Complete Interrupt */
\r
3318 SET_BIT(huart->Instance->CR1, USART_CR1_TCIE);
\r
3322 tmp = (uint16_t *) huart->pTxBuffPtr;
\r
3323 huart->Instance->TDR = (((uint32_t)(*tmp)) & 0x01FFUL);
\r
3324 huart->pTxBuffPtr += 2U;
\r
3325 huart->TxXferCount--;
\r
3332 * @brief Wrap up transmission in non-blocking mode.
\r
3333 * @param huart pointer to a UART_HandleTypeDef structure that contains
\r
3334 * the configuration information for the specified UART module.
\r
3337 static void UART_EndTransmit_IT(UART_HandleTypeDef *huart)
\r
3339 /* Disable the UART Transmit Complete Interrupt */
\r
3340 CLEAR_BIT(huart->Instance->CR1, USART_CR1_TCIE);
\r
3342 /* Tx process is ended, restore huart->gState to Ready */
\r
3343 huart->gState = HAL_UART_STATE_READY;
\r
3345 /* Cleat TxISR function pointer */
\r
3346 huart->TxISR = NULL;
\r
3348 #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
\r
3349 /*Call registered Tx complete callback*/
\r
3350 huart->TxCpltCallback(huart);
\r
3352 /*Call legacy weak Tx complete callback*/
\r
3353 HAL_UART_TxCpltCallback(huart);
\r
3354 #endif /* USE_HAL_UART_REGISTER_CALLBACKS */
\r
3358 * @brief RX interrrupt handler for 7 or 8 bits data word length .
\r
3359 * @param huart UART handle.
\r
3362 static void UART_RxISR_8BIT(UART_HandleTypeDef *huart)
\r
3364 uint16_t uhMask = huart->Mask;
\r
3367 /* Check that a Rx process is ongoing */
\r
3368 if (huart->RxState == HAL_UART_STATE_BUSY_RX)
\r
3370 uhdata = (uint16_t) READ_REG(huart->Instance->RDR);
\r
3371 *huart->pRxBuffPtr = (uint8_t)(uhdata & (uint8_t)uhMask);
\r
3372 huart->pRxBuffPtr++;
\r
3373 huart->RxXferCount--;
\r
3375 if (huart->RxXferCount == 0U)
\r
3377 /* Disable the UART Parity Error Interrupt and RXNE interrupts */
\r
3378 CLEAR_BIT(huart->Instance->CR1, (USART_CR1_RXNEIE | USART_CR1_PEIE));
\r
3380 /* Disable the UART Error Interrupt: (Frame error, noise error, overrun error) */
\r
3381 CLEAR_BIT(huart->Instance->CR3, USART_CR3_EIE);
\r
3383 /* Rx process is completed, restore huart->RxState to Ready */
\r
3384 huart->RxState = HAL_UART_STATE_READY;
\r
3386 /* Clear RxISR function pointer */
\r
3387 huart->RxISR = NULL;
\r
3389 #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
\r
3390 /*Call registered Rx complete callback*/
\r
3391 huart->RxCpltCallback(huart);
\r
3393 /*Call legacy weak Rx complete callback*/
\r
3394 HAL_UART_RxCpltCallback(huart);
\r
3395 #endif /* USE_HAL_UART_REGISTER_CALLBACKS */
\r
3400 /* Clear RXNE interrupt flag */
\r
3401 __HAL_UART_SEND_REQ(huart, UART_RXDATA_FLUSH_REQUEST);
\r
3406 * @brief RX interrrupt handler for 9 bits data word length .
\r
3407 * @note Function is called under interruption only, once
\r
3408 * interruptions have been enabled by HAL_UART_Receive_IT()
\r
3409 * @param huart UART handle.
\r
3412 static void UART_RxISR_16BIT(UART_HandleTypeDef *huart)
\r
3415 uint16_t uhMask = huart->Mask;
\r
3418 /* Check that a Rx process is ongoing */
\r
3419 if (huart->RxState == HAL_UART_STATE_BUSY_RX)
\r
3421 uhdata = (uint16_t) READ_REG(huart->Instance->RDR);
\r
3422 tmp = (uint16_t *) huart->pRxBuffPtr ;
\r
3423 *tmp = (uint16_t)(uhdata & uhMask);
\r
3424 huart->pRxBuffPtr += 2U;
\r
3425 huart->RxXferCount--;
\r
3427 if (huart->RxXferCount == 0U)
\r
3429 /* Disable the UART Parity Error Interrupt and RXNE interrupt*/
\r
3430 CLEAR_BIT(huart->Instance->CR1, (USART_CR1_RXNEIE | USART_CR1_PEIE));
\r
3432 /* Disable the UART Error Interrupt: (Frame error, noise error, overrun error) */
\r
3433 CLEAR_BIT(huart->Instance->CR3, USART_CR3_EIE);
\r
3435 /* Rx process is completed, restore huart->RxState to Ready */
\r
3436 huart->RxState = HAL_UART_STATE_READY;
\r
3438 /* Clear RxISR function pointer */
\r
3439 huart->RxISR = NULL;
\r
3441 #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
\r
3442 /*Call registered Rx complete callback*/
\r
3443 huart->RxCpltCallback(huart);
\r
3445 /*Call legacy weak Rx complete callback*/
\r
3446 HAL_UART_RxCpltCallback(huart);
\r
3447 #endif /* USE_HAL_UART_REGISTER_CALLBACKS */
\r
3452 /* Clear RXNE interrupt flag */
\r
3453 __HAL_UART_SEND_REQ(huart, UART_RXDATA_FLUSH_REQUEST);
\r
3462 #endif /* HAL_UART_MODULE_ENABLED */
\r
3471 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
\r