- Generated by
1.8.13
|
STM32L4xx_HAL_Driver
1.14.0
|
UART HAL module driver. This file provides firmware functions to manage the following functionalities of the Universal Asynchronous Receiver Transmitter Peripheral (UART). More...
Go to the source code of this file.
Functions | |
| static void | UART_EndTxTransfer (UART_HandleTypeDef *huart) |
| End ongoing Tx transfer on UART peripheral (following error detection or Transmit completion). More... | |
| static void | UART_EndRxTransfer (UART_HandleTypeDef *huart) |
| End ongoing Rx transfer on UART peripheral (following error detection or Reception completion). More... | |
| static void | UART_DMATransmitCplt (DMA_HandleTypeDef *hdma) |
| DMA UART transmit process complete callback. More... | |
| static void | UART_DMAReceiveCplt (DMA_HandleTypeDef *hdma) |
| DMA UART receive process complete callback. More... | |
| static void | UART_DMARxHalfCplt (DMA_HandleTypeDef *hdma) |
| DMA UART receive process half complete callback. More... | |
| static void | UART_DMATxHalfCplt (DMA_HandleTypeDef *hdma) |
| DMA UART transmit process half complete callback. More... | |
| static void | UART_DMAError (DMA_HandleTypeDef *hdma) |
| DMA UART communication error callback. More... | |
| static void | UART_DMAAbortOnError (DMA_HandleTypeDef *hdma) |
| DMA UART communication abort callback, when initiated by HAL services on Error (To be called at end of DMA Abort procedure following error occurrence). More... | |
| static void | UART_DMATxAbortCallback (DMA_HandleTypeDef *hdma) |
| DMA UART Tx communication abort callback, when initiated by user (To be called at end of DMA Tx Abort procedure following user abort request). More... | |
| static void | UART_DMARxAbortCallback (DMA_HandleTypeDef *hdma) |
| DMA UART Rx communication abort callback, when initiated by user (To be called at end of DMA Rx Abort procedure following user abort request). More... | |
| static void | UART_DMATxOnlyAbortCallback (DMA_HandleTypeDef *hdma) |
| DMA UART Tx communication abort callback, when initiated by user by a call to HAL_UART_AbortTransmit_IT API (Abort only Tx transfer) (This callback is executed at end of DMA Tx Abort procedure following user abort request, and leads to user Tx Abort Complete callback execution). More... | |
| static void | UART_DMARxOnlyAbortCallback (DMA_HandleTypeDef *hdma) |
| DMA UART Rx communication abort callback, when initiated by user by a call to HAL_UART_AbortReceive_IT API (Abort only Rx transfer) (This callback is executed at end of DMA Rx Abort procedure following user abort request, and leads to user Rx Abort Complete callback execution). More... | |
| static void | UART_TxISR_8BIT (UART_HandleTypeDef *huart) |
| TX interrrupt handler for 7 or 8 bits data word length . More... | |
| static void | UART_TxISR_16BIT (UART_HandleTypeDef *huart) |
| TX interrrupt handler for 9 bits data word length. More... | |
| static void | UART_TxISR_8BIT_FIFOEN (UART_HandleTypeDef *huart) |
| TX interrrupt handler for 7 or 8 bits data word length and FIFO mode is enabled. More... | |
| static void | UART_TxISR_16BIT_FIFOEN (UART_HandleTypeDef *huart) |
| TX interrrupt handler for 9 bits data word length and FIFO mode is enabled. More... | |
| static void | UART_EndTransmit_IT (UART_HandleTypeDef *huart) |
| Wrap up transmission in non-blocking mode. More... | |
| static void | UART_RxISR_8BIT (UART_HandleTypeDef *huart) |
| RX interrrupt handler for 7 or 8 bits data word length . More... | |
| static void | UART_RxISR_16BIT (UART_HandleTypeDef *huart) |
| RX interrrupt handler for 9 bits data word length . More... | |
| static void | UART_RxISR_8BIT_FIFOEN (UART_HandleTypeDef *huart) |
| RX interrrupt handler for 7 or 8 bits data word length and FIFO mode is enabled. More... | |
| static void | UART_RxISR_16BIT_FIFOEN (UART_HandleTypeDef *huart) |
| RX interrrupt handler for 9 bits data word length and FIFO mode is enabled. More... | |
| HAL_StatusTypeDef | HAL_UART_Init (UART_HandleTypeDef *huart) |
| Initialize the UART mode according to the specified parameters in the UART_InitTypeDef and initialize the associated handle. More... | |
| HAL_StatusTypeDef | HAL_HalfDuplex_Init (UART_HandleTypeDef *huart) |
| Initialize the half-duplex mode according to the specified parameters in the UART_InitTypeDef and creates the associated handle. More... | |
| HAL_StatusTypeDef | HAL_LIN_Init (UART_HandleTypeDef *huart, uint32_t BreakDetectLength) |
| Initialize the LIN mode according to the specified parameters in the UART_InitTypeDef and creates the associated handle. More... | |
| HAL_StatusTypeDef | HAL_MultiProcessor_Init (UART_HandleTypeDef *huart, uint8_t Address, uint32_t WakeUpMethod) |
| Initialize the multiprocessor mode according to the specified parameters in the UART_InitTypeDef and initialize the associated handle. More... | |
| HAL_StatusTypeDef | HAL_UART_DeInit (UART_HandleTypeDef *huart) |
| DeInitialize the UART peripheral. More... | |
| void | HAL_UART_MspInit (UART_HandleTypeDef *huart) |
| Initialize the UART MSP. More... | |
| void | HAL_UART_MspDeInit (UART_HandleTypeDef *huart) |
| DeInitialize the UART MSP. More... | |
| HAL_StatusTypeDef | HAL_UART_RegisterCallback (UART_HandleTypeDef *huart, HAL_UART_CallbackIDTypeDef CallbackID, pUART_CallbackTypeDef pCallback) |
| Register a User UART Callback To be used instead of the weak predefined callback. More... | |
| HAL_StatusTypeDef | HAL_UART_UnRegisterCallback (UART_HandleTypeDef *huart, HAL_UART_CallbackIDTypeDef CallbackID) |
| Unregister an UART Callback UART callaback is redirected to the weak predefined callback. More... | |
| HAL_StatusTypeDef | HAL_UART_Transmit (UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size, uint32_t Timeout) |
| Send an amount of data in blocking mode. More... | |
| HAL_StatusTypeDef | HAL_UART_Receive (UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size, uint32_t Timeout) |
| Receive an amount of data in blocking mode. More... | |
| HAL_StatusTypeDef | HAL_UART_Transmit_IT (UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size) |
| Send an amount of data in interrupt mode. More... | |
| HAL_StatusTypeDef | HAL_UART_Receive_IT (UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size) |
| Receive an amount of data in interrupt mode. More... | |
| HAL_StatusTypeDef | HAL_UART_Transmit_DMA (UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size) |
| Send an amount of data in DMA mode. More... | |
| HAL_StatusTypeDef | HAL_UART_Receive_DMA (UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size) |
| Receive an amount of data in DMA mode. More... | |
| HAL_StatusTypeDef | HAL_UART_DMAPause (UART_HandleTypeDef *huart) |
| Pause the DMA Transfer. More... | |
| HAL_StatusTypeDef | HAL_UART_DMAResume (UART_HandleTypeDef *huart) |
| Resume the DMA Transfer. More... | |
| HAL_StatusTypeDef | HAL_UART_DMAStop (UART_HandleTypeDef *huart) |
| Stop the DMA Transfer. More... | |
| HAL_StatusTypeDef | HAL_UART_Abort (UART_HandleTypeDef *huart) |
| Abort ongoing transfers (blocking mode). More... | |
| HAL_StatusTypeDef | HAL_UART_AbortTransmit (UART_HandleTypeDef *huart) |
| Abort ongoing Transmit transfer (blocking mode). More... | |
| HAL_StatusTypeDef | HAL_UART_AbortReceive (UART_HandleTypeDef *huart) |
| Abort ongoing Receive transfer (blocking mode). More... | |
| HAL_StatusTypeDef | HAL_UART_Abort_IT (UART_HandleTypeDef *huart) |
| Abort ongoing transfers (Interrupt mode). More... | |
| HAL_StatusTypeDef | HAL_UART_AbortTransmit_IT (UART_HandleTypeDef *huart) |
| Abort ongoing Transmit transfer (Interrupt mode). More... | |
| HAL_StatusTypeDef | HAL_UART_AbortReceive_IT (UART_HandleTypeDef *huart) |
| Abort ongoing Receive transfer (Interrupt mode). More... | |
| void | HAL_UART_IRQHandler (UART_HandleTypeDef *huart) |
| Handle UART interrupt request. More... | |
| void | HAL_UART_TxCpltCallback (UART_HandleTypeDef *huart) |
| Tx Transfer completed callback. More... | |
| void | HAL_UART_TxHalfCpltCallback (UART_HandleTypeDef *huart) |
| Tx Half Transfer completed callback. More... | |
| void | HAL_UART_RxCpltCallback (UART_HandleTypeDef *huart) |
| Rx Transfer completed callback. More... | |
| void | HAL_UART_RxHalfCpltCallback (UART_HandleTypeDef *huart) |
| Rx Half Transfer completed callback. More... | |
| void | HAL_UART_ErrorCallback (UART_HandleTypeDef *huart) |
| UART error callback. More... | |
| void | HAL_UART_AbortCpltCallback (UART_HandleTypeDef *huart) |
| UART Abort Complete callback. More... | |
| void | HAL_UART_AbortTransmitCpltCallback (UART_HandleTypeDef *huart) |
| UART Abort Complete callback. More... | |
| void | HAL_UART_AbortReceiveCpltCallback (UART_HandleTypeDef *huart) |
| UART Abort Receive Complete callback. More... | |
| HAL_StatusTypeDef | HAL_MultiProcessor_EnableMuteMode (UART_HandleTypeDef *huart) |
| Enable UART in mute mode (does not mean UART enters mute mode; to enter mute mode, HAL_MultiProcessor_EnterMuteMode() API must be called). More... | |
| HAL_StatusTypeDef | HAL_MultiProcessor_DisableMuteMode (UART_HandleTypeDef *huart) |
| Disable UART mute mode (does not mean the UART actually exits mute mode as it may not have been in mute mode at this very moment). More... | |
| void | HAL_MultiProcessor_EnterMuteMode (UART_HandleTypeDef *huart) |
| Enter UART mute mode (means UART actually enters mute mode). More... | |
| HAL_StatusTypeDef | HAL_HalfDuplex_EnableTransmitter (UART_HandleTypeDef *huart) |
| Enable the UART transmitter and disable the UART receiver. More... | |
| HAL_StatusTypeDef | HAL_HalfDuplex_EnableReceiver (UART_HandleTypeDef *huart) |
| Enable the UART receiver and disable the UART transmitter. More... | |
| HAL_StatusTypeDef | HAL_LIN_SendBreak (UART_HandleTypeDef *huart) |
| Transmit break characters. More... | |
| HAL_UART_StateTypeDef | HAL_UART_GetState (UART_HandleTypeDef *huart) |
| Return the UART handle state. More... | |
| uint32_t | HAL_UART_GetError (UART_HandleTypeDef *huart) |
| Return the UART handle error code. More... | |
| void | UART_InitCallbacksToDefault (UART_HandleTypeDef *huart) |
| Initialize the callbacks to their default values. More... | |
| HAL_StatusTypeDef | UART_SetConfig (UART_HandleTypeDef *huart) |
| Configure the UART peripheral. More... | |
| void | UART_AdvFeatureConfig (UART_HandleTypeDef *huart) |
| Configure the UART peripheral advanced features. More... | |
| HAL_StatusTypeDef | UART_CheckIdleState (UART_HandleTypeDef *huart) |
| Check the UART Idle State. More... | |
| HAL_StatusTypeDef | UART_WaitOnFlagUntilTimeout (UART_HandleTypeDef *huart, uint32_t Flag, FlagStatus Status, uint32_t Tickstart, uint32_t Timeout) |
| Handle UART Communication Timeout. More... | |
UART HAL module driver. This file provides firmware functions to manage the following functionalities of the Universal Asynchronous Receiver Transmitter Peripheral (UART).
===============================================================================
##### How to use this driver #####
===============================================================================
[..]
The UART HAL driver can be used as follows:
(#) Declare a UART_HandleTypeDef handle structure (eg. UART_HandleTypeDef huart).
(#) Initialize the UART low level resources by implementing the HAL_UART_MspInit() API:
(++) Enable the USARTx interface clock.
(++) UART pins configuration:
(+++) Enable the clock for the UART GPIOs.
(+++) Configure these UART pins as alternate function pull-up.
(++) NVIC configuration if you need to use interrupt process (HAL_UART_Transmit_IT()
and HAL_UART_Receive_IT() APIs):
(+++) Configure the USARTx interrupt priority.
(+++) Enable the NVIC USART IRQ handle.
(++) UART interrupts handling:
-@@- The specific UART interrupts (Transmission complete interrupt,
RXNE interrupt, RX/TX FIFOs related interrupts and Error Interrupts)
are managed using the macros __HAL_UART_ENABLE_IT() and __HAL_UART_DISABLE_IT()
inside the transmit and receive processes.
(++) DMA Configuration if you need to use DMA process (HAL_UART_Transmit_DMA()
and HAL_UART_Receive_DMA() APIs):
(+++) Declare a DMA handle structure for the Tx/Rx channel.
(+++) Enable the DMAx interface clock.
(+++) Configure the declared DMA handle structure with the required Tx/Rx parameters.
(+++) Configure the DMA Tx/Rx channel.
(+++) Associate the initialized DMA handle to the UART DMA Tx/Rx handle.
(+++) Configure the priority and enable the NVIC for the transfer complete interrupt on the DMA Tx/Rx channel.
(#) Program the Baud Rate, Word Length, Stop Bit, Parity, Prescaler value , Hardware
flow control and Mode (Receiver/Transmitter) in the huart handle Init structure.
(#) If required, program UART advanced features (TX/RX pins swap, auto Baud rate detection,...)
in the huart handle AdvancedInit structure.
(#) For the UART asynchronous mode, initialize the UART registers by calling
the HAL_UART_Init() API.
(#) For the UART Half duplex mode, initialize the UART registers by calling
the HAL_HalfDuplex_Init() API.
(#) For the UART LIN (Local Interconnection Network) mode, initialize the UART registers
by calling the HAL_LIN_Init() API.
(#) For the UART Multiprocessor mode, initialize the UART registers
by calling the HAL_MultiProcessor_Init() API.
(#) For the UART RS485 Driver Enabled mode, initialize the UART registers
by calling the HAL_RS485Ex_Init() API.
[..]
(@) These API's (HAL_UART_Init(), HAL_HalfDuplex_Init(), HAL_LIN_Init(), HAL_MultiProcessor_Init(),
also configure the low level Hardware GPIO, CLOCK, CORTEX...etc) by
calling the customized HAL_UART_MspInit() API.
##### Callback registration #####
==================================
[..]
The compilation define USE_HAL_UART_REGISTER_CALLBACKS when set to 1
allows the user to configure dynamically the driver callbacks.
[..]
Use Function @ref HAL_UART_RegisterCallback() to register a user callback.
Function @ref HAL_UART_RegisterCallback() allows to register following callbacks:
(+) TxHalfCpltCallback : Tx Half Complete Callback.
(+) TxCpltCallback : Tx Complete Callback.
(+) RxHalfCpltCallback : Rx Half Complete Callback.
(+) RxCpltCallback : Rx Complete Callback.
(+) ErrorCallback : Error Callback.
(+) AbortCpltCallback : Abort Complete Callback.
(+) AbortTransmitCpltCallback : Abort Transmit Complete Callback.
(+) AbortReceiveCpltCallback : Abort Receive Complete Callback.
(+) WakeupCallback : Wakeup Callback.
(+) RxFifoFullCallback : Rx Fifo Full Callback.
(+) TxFifoEmptyCallback : Tx Fifo Empty Callback.
(+) MspInitCallback : UART MspInit.
(+) MspDeInitCallback : UART MspDeInit.
This function takes as parameters the HAL peripheral handle, the Callback ID
and a pointer to the user callback function.
[..]
Use function @ref HAL_UART_UnRegisterCallback() to reset a callback to the default
weak (surcharged) function.
@ref HAL_UART_UnRegisterCallback() takes as parameters the HAL peripheral handle,
and the Callback ID.
This function allows to reset following callbacks:
(+) TxHalfCpltCallback : Tx Half Complete Callback.
(+) TxCpltCallback : Tx Complete Callback.
(+) RxHalfCpltCallback : Rx Half Complete Callback.
(+) RxCpltCallback : Rx Complete Callback.
(+) ErrorCallback : Error Callback.
(+) AbortCpltCallback : Abort Complete Callback.
(+) AbortTransmitCpltCallback : Abort Transmit Complete Callback.
(+) AbortReceiveCpltCallback : Abort Receive Complete Callback.
(+) WakeupCallback : Wakeup Callback.
(+) RxFifoFullCallback : Rx Fifo Full Callback.
(+) TxFifoEmptyCallback : Tx Fifo Empty Callback.
(+) MspInitCallback : UART MspInit.
(+) MspDeInitCallback : UART MspDeInit.
[..]
By default, after the @ref HAL_UART_Init() and when the state is HAL_UART_STATE_RESET
all callbacks are set to the corresponding weak (surcharged) functions:
examples @ref HAL_UART_TxCpltCallback(), @ref HAL_UART_RxHalfCpltCallback().
Exception done for MspInit and MspDeInit functions that are respectively
reset to the legacy weak (surcharged) functions in the @ref HAL_UART_Init()
and @ref HAL_UART_DeInit() only when these callbacks are null (not registered beforehand).
If not, MspInit or MspDeInit are not null, the @ref HAL_UART_Init() and @ref HAL_UART_DeInit()
keep and use the user MspInit/MspDeInit callbacks (registered beforehand).
[..]
Callbacks can be registered/unregistered in HAL_UART_STATE_READY state only.
Exception done MspInit/MspDeInit that can be registered/unregistered
in HAL_UART_STATE_READY or HAL_UART_STATE_RESET state, thus registered (user)
MspInit/DeInit callbacks can be used during the Init/DeInit.
In that case first register the MspInit/MspDeInit user callbacks
using @ref HAL_UART_RegisterCallback() before calling @ref HAL_UART_DeInit()
or @ref HAL_UART_Init() function.
[..]
When The compilation define USE_HAL_UART_REGISTER_CALLBACKS is set to 0 or
not defined, the callback registration feature is not available
and weak (surcharged) callbacks are used.This software component is licensed by ST under BSD 3-Clause license, the "License"; You may not use this file except in compliance with the License. You may obtain a copy of the License at: opensource.org/licenses/BSD-3-Clause
Definition in file stm32l4xx_hal_uart.c.
1.8.13