STM32L486xx HAL User Manual
Data Structures | Defines | Typedefs | Enumerations | Functions
stm32l4xx_hal_uart.h File Reference

Header file of UART HAL module. More...

#include "stm32l4xx_hal_def.h"
#include "stm32l4xx_hal_uart_ex.h"

Go to the source code of this file.

Data Structures

struct  UART_InitTypeDef
 UART Init Structure definition. More...
struct  UART_AdvFeatureInitTypeDef
 UART Advanced Features initalization structure definition. More...
struct  __UART_HandleTypeDef
 UART handle Structure definition. More...

Defines

#define HAL_UART_ERROR_NONE   ((uint32_t)0x00000000U)
#define HAL_UART_ERROR_PE   ((uint32_t)0x00000001U)
#define HAL_UART_ERROR_NE   ((uint32_t)0x00000002U)
#define HAL_UART_ERROR_FE   ((uint32_t)0x00000004U)
#define HAL_UART_ERROR_ORE   ((uint32_t)0x00000008U)
#define HAL_UART_ERROR_DMA   ((uint32_t)0x00000010U)
#define HAL_UART_ERROR_INVALID_CALLBACK   ((uint32_t)0x00000020U)
#define UART_STOPBITS_0_5   USART_CR2_STOP_0
#define UART_STOPBITS_1   0x00000000U
#define UART_STOPBITS_1_5   (USART_CR2_STOP_0 | USART_CR2_STOP_1)
#define UART_STOPBITS_2   USART_CR2_STOP_1
#define UART_PARITY_NONE   0x00000000U
#define UART_PARITY_EVEN   USART_CR1_PCE
#define UART_PARITY_ODD   (USART_CR1_PCE | USART_CR1_PS)
#define UART_HWCONTROL_NONE   0x00000000U
#define UART_HWCONTROL_RTS   USART_CR3_RTSE
#define UART_HWCONTROL_CTS   USART_CR3_CTSE
#define UART_HWCONTROL_RTS_CTS   (USART_CR3_RTSE | USART_CR3_CTSE)
#define UART_MODE_RX   USART_CR1_RE
#define UART_MODE_TX   USART_CR1_TE
#define UART_MODE_TX_RX   (USART_CR1_TE |USART_CR1_RE)
#define UART_STATE_DISABLE   0x00000000U
#define UART_STATE_ENABLE   USART_CR1_UE
#define UART_OVERSAMPLING_16   0x00000000U
#define UART_OVERSAMPLING_8   USART_CR1_OVER8
#define UART_ONE_BIT_SAMPLE_DISABLE   0x00000000U
#define UART_ONE_BIT_SAMPLE_ENABLE   USART_CR3_ONEBIT
#define UART_ADVFEATURE_AUTOBAUDRATE_ONSTARTBIT   0x00000000U
#define UART_ADVFEATURE_AUTOBAUDRATE_ONFALLINGEDGE   USART_CR2_ABRMODE_0
#define UART_ADVFEATURE_AUTOBAUDRATE_ON0X7FFRAME   USART_CR2_ABRMODE_1
#define UART_ADVFEATURE_AUTOBAUDRATE_ON0X55FRAME   USART_CR2_ABRMODE
#define UART_RECEIVER_TIMEOUT_DISABLE   0x00000000U
#define UART_RECEIVER_TIMEOUT_ENABLE   USART_CR2_RTOEN
#define UART_LIN_DISABLE   0x00000000U
#define UART_LIN_ENABLE   USART_CR2_LINEN
#define UART_LINBREAKDETECTLENGTH_10B   0x00000000U
#define UART_LINBREAKDETECTLENGTH_11B   USART_CR2_LBDL
#define UART_DMA_TX_DISABLE   0x00000000U
#define UART_DMA_TX_ENABLE   USART_CR3_DMAT
#define UART_DMA_RX_DISABLE   0x00000000U
#define UART_DMA_RX_ENABLE   USART_CR3_DMAR
#define UART_HALF_DUPLEX_DISABLE   0x00000000U
#define UART_HALF_DUPLEX_ENABLE   USART_CR3_HDSEL
#define UART_WAKEUPMETHOD_IDLELINE   0x00000000U
#define UART_WAKEUPMETHOD_ADDRESSMARK   USART_CR1_WAKE
#define UART_AUTOBAUD_REQUEST   USART_RQR_ABRRQ
#define UART_SENDBREAK_REQUEST   USART_RQR_SBKRQ
#define UART_MUTE_MODE_REQUEST   USART_RQR_MMRQ
#define UART_RXDATA_FLUSH_REQUEST   USART_RQR_RXFRQ
#define UART_TXDATA_FLUSH_REQUEST   USART_RQR_TXFRQ
#define UART_ADVFEATURE_NO_INIT   0x00000000U
#define UART_ADVFEATURE_TXINVERT_INIT   0x00000001U
#define UART_ADVFEATURE_RXINVERT_INIT   0x00000002U
#define UART_ADVFEATURE_DATAINVERT_INIT   0x00000004U
#define UART_ADVFEATURE_SWAP_INIT   0x00000008U
#define UART_ADVFEATURE_RXOVERRUNDISABLE_INIT   0x00000010U
#define UART_ADVFEATURE_DMADISABLEONERROR_INIT   0x00000020U
#define UART_ADVFEATURE_AUTOBAUDRATE_INIT   0x00000040U
#define UART_ADVFEATURE_MSBFIRST_INIT   0x00000080U
#define UART_ADVFEATURE_TXINV_DISABLE   0x00000000U
#define UART_ADVFEATURE_TXINV_ENABLE   USART_CR2_TXINV
#define UART_ADVFEATURE_RXINV_DISABLE   0x00000000U
#define UART_ADVFEATURE_RXINV_ENABLE   USART_CR2_RXINV
#define UART_ADVFEATURE_DATAINV_DISABLE   0x00000000U
#define UART_ADVFEATURE_DATAINV_ENABLE   USART_CR2_DATAINV
#define UART_ADVFEATURE_SWAP_DISABLE   0x00000000U
#define UART_ADVFEATURE_SWAP_ENABLE   USART_CR2_SWAP
#define UART_ADVFEATURE_OVERRUN_ENABLE   0x00000000U
#define UART_ADVFEATURE_OVERRUN_DISABLE   USART_CR3_OVRDIS
#define UART_ADVFEATURE_AUTOBAUDRATE_DISABLE   0x00000000U
#define UART_ADVFEATURE_AUTOBAUDRATE_ENABLE   USART_CR2_ABREN
#define UART_ADVFEATURE_DMA_ENABLEONRXERROR   0x00000000U
#define UART_ADVFEATURE_DMA_DISABLEONRXERROR   USART_CR3_DDRE
#define UART_ADVFEATURE_MSBFIRST_DISABLE   0x00000000U
#define UART_ADVFEATURE_MSBFIRST_ENABLE   USART_CR2_MSBFIRST
#define UART_ADVFEATURE_STOPMODE_DISABLE   0x00000000U
#define UART_ADVFEATURE_STOPMODE_ENABLE   USART_CR1_UESM
#define UART_ADVFEATURE_MUTEMODE_DISABLE   0x00000000U
#define UART_ADVFEATURE_MUTEMODE_ENABLE   USART_CR1_MME
#define UART_CR2_ADDRESS_LSB_POS   24U
#define UART_WAKEUP_ON_ADDRESS   0x00000000U
#define UART_WAKEUP_ON_STARTBIT   USART_CR3_WUS_1
#define UART_WAKEUP_ON_READDATA_NONEMPTY   USART_CR3_WUS
#define UART_DE_POLARITY_HIGH   0x00000000U
#define UART_DE_POLARITY_LOW   USART_CR3_DEP
#define UART_CR1_DEAT_ADDRESS_LSB_POS   21U
#define UART_CR1_DEDT_ADDRESS_LSB_POS   16U
#define UART_IT_MASK   0x001FU
#define HAL_UART_TIMEOUT_VALUE   0x1FFFFFFU
#define UART_FLAG_TXFT   USART_ISR_TXFT
#define UART_FLAG_RXFT   USART_ISR_RXFT
#define UART_FLAG_RXFF   USART_ISR_RXFF
#define UART_FLAG_TXFE   USART_ISR_TXFE
#define UART_FLAG_REACK   USART_ISR_REACK
#define UART_FLAG_TEACK   USART_ISR_TEACK
#define UART_FLAG_WUF   USART_ISR_WUF
#define UART_FLAG_RWU   USART_ISR_RWU
#define UART_FLAG_SBKF   USART_ISR_SBKF
#define UART_FLAG_CMF   USART_ISR_CMF
#define UART_FLAG_BUSY   USART_ISR_BUSY
#define UART_FLAG_ABRF   USART_ISR_ABRF
#define UART_FLAG_ABRE   USART_ISR_ABRE
#define UART_FLAG_CTS   USART_ISR_CTS
#define UART_FLAG_CTSIF   USART_ISR_CTSIF
#define UART_FLAG_LBDF   USART_ISR_LBDF
#define UART_FLAG_TXE   USART_ISR_TXE
#define UART_FLAG_TC   USART_ISR_TC
#define UART_FLAG_RXNE   USART_ISR_RXNE
#define UART_FLAG_IDLE   USART_ISR_IDLE
#define UART_FLAG_ORE   USART_ISR_ORE
#define UART_FLAG_NE   USART_ISR_NE
#define UART_FLAG_FE   USART_ISR_FE
#define UART_FLAG_PE   USART_ISR_PE
#define UART_IT_PE   0x0028U
#define UART_IT_TXE   0x0727U
#define UART_IT_TC   0x0626U
#define UART_IT_RXNE   0x0525U
#define UART_IT_IDLE   0x0424U
#define UART_IT_LBD   0x0846U
#define UART_IT_CTS   0x096AU
#define UART_IT_CM   0x112EU
#define UART_IT_WUF   0x1476U
#define UART_IT_ERR   0x0060U
#define UART_IT_ORE   0x0300U
#define UART_IT_NE   0x0200U
#define UART_IT_FE   0x0100U
#define UART_CLEAR_PEF   USART_ICR_PECF
#define UART_CLEAR_FEF   USART_ICR_FECF
#define UART_CLEAR_NEF   USART_ICR_NECF
#define UART_CLEAR_OREF   USART_ICR_ORECF
#define UART_CLEAR_IDLEF   USART_ICR_IDLECF
#define UART_CLEAR_TCF   USART_ICR_TCCF
#define UART_CLEAR_LBDF   USART_ICR_LBDCF
#define UART_CLEAR_CTSF   USART_ICR_CTSCF
#define UART_CLEAR_CMF   USART_ICR_CMCF
#define UART_CLEAR_WUF   USART_ICR_WUCF
#define __HAL_UART_RESET_HANDLE_STATE(__HANDLE__)
 Reset UART handle states.
#define __HAL_UART_FLUSH_DRREGISTER(__HANDLE__)
 Flush the UART Data registers.
#define __HAL_UART_CLEAR_FLAG(__HANDLE__, __FLAG__)   ((__HANDLE__)->Instance->ICR = (__FLAG__))
 Clear the specified UART pending flag.
#define __HAL_UART_CLEAR_PEFLAG(__HANDLE__)   __HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_PEF)
 Clear the UART PE pending flag.
#define __HAL_UART_CLEAR_FEFLAG(__HANDLE__)   __HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_FEF)
 Clear the UART FE pending flag.
#define __HAL_UART_CLEAR_NEFLAG(__HANDLE__)   __HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_NEF)
 Clear the UART NE pending flag.
#define __HAL_UART_CLEAR_OREFLAG(__HANDLE__)   __HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_OREF)
 Clear the UART ORE pending flag.
#define __HAL_UART_CLEAR_IDLEFLAG(__HANDLE__)   __HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_IDLEF)
 Clear the UART IDLE pending flag.
#define __HAL_UART_GET_FLAG(__HANDLE__, __FLAG__)   (((__HANDLE__)->Instance->ISR & (__FLAG__)) == (__FLAG__))
 Check whether the specified UART flag is set or not.
#define __HAL_UART_ENABLE_IT(__HANDLE__, __INTERRUPT__)
 Enable the specified UART interrupt.
#define __HAL_UART_DISABLE_IT(__HANDLE__, __INTERRUPT__)
 Disable the specified UART interrupt.
#define __HAL_UART_GET_IT(__HANDLE__, __INTERRUPT__)   ((((__HANDLE__)->Instance->ISR & (1U << ((__INTERRUPT__)>> 8U))) != RESET) ? SET : RESET)
 Check whether the specified UART interrupt has occurred or not.
#define __HAL_UART_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)
 Check whether the specified UART interrupt source is enabled or not.
#define __HAL_UART_CLEAR_IT(__HANDLE__, __IT_CLEAR__)   ((__HANDLE__)->Instance->ICR = (uint32_t)(__IT_CLEAR__))
 Clear the specified UART ISR flag, in setting the proper ICR register flag.
#define __HAL_UART_SEND_REQ(__HANDLE__, __REQ__)   ((__HANDLE__)->Instance->RQR |= (__REQ__))
 Set a specific UART request flag.
#define __HAL_UART_ONE_BIT_SAMPLE_ENABLE(__HANDLE__)   ((__HANDLE__)->Instance->CR3|= USART_CR3_ONEBIT)
 Enable the UART one bit sample method.
#define __HAL_UART_ONE_BIT_SAMPLE_DISABLE(__HANDLE__)   ((__HANDLE__)->Instance->CR3 &= ~USART_CR3_ONEBIT)
 Disable the UART one bit sample method.
#define __HAL_UART_ENABLE(__HANDLE__)   ((__HANDLE__)->Instance->CR1 |= USART_CR1_UE)
 Enable UART.
#define __HAL_UART_DISABLE(__HANDLE__)   ((__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE)
 Disable UART.
#define __HAL_UART_HWCONTROL_CTS_ENABLE(__HANDLE__)
 Enable CTS flow control.
#define __HAL_UART_HWCONTROL_CTS_DISABLE(__HANDLE__)
 Disable CTS flow control.
#define __HAL_UART_HWCONTROL_RTS_ENABLE(__HANDLE__)
 Enable RTS flow control.
#define __HAL_UART_HWCONTROL_RTS_DISABLE(__HANDLE__)
 Disable RTS flow control.
#define UART_DIV_LPUART(__PCLK__, __BAUD__)   (((((uint64_t)(__PCLK__)*256U)) + ((__BAUD__)/2U)) / (__BAUD__))
 BRR division operation to set BRR register with LPUART.
#define UART_DIV_SAMPLING8(__PCLK__, __BAUD__)   ((((__PCLK__)*2U) + ((__BAUD__)/2U)) / (__BAUD__))
 BRR division operation to set BRR register in 8-bit oversampling mode.
#define UART_DIV_SAMPLING16(__PCLK__, __BAUD__)   (((__PCLK__) + ((__BAUD__)/2U)) / (__BAUD__))
 BRR division operation to set BRR register in 16-bit oversampling mode.
#define UART_INSTANCE_LOWPOWER(__HANDLE__)   (IS_LPUART_INSTANCE((__HANDLE__)->Instance))
 Check whether or not UART instance is Low Power UART.
#define IS_UART_BAUDRATE(__BAUDRATE__)   ((__BAUDRATE__) < 10000001U)
 Check UART Baud rate.
#define IS_UART_ASSERTIONTIME(__TIME__)   ((__TIME__) <= 0x1FU)
 Check UART assertion time.
#define IS_UART_DEASSERTIONTIME(__TIME__)   ((__TIME__) <= 0x1FU)
 Check UART deassertion time.
#define IS_UART_STOPBITS(__STOPBITS__)
 Ensure that UART frame number of stop bits is valid.
#define IS_LPUART_STOPBITS(__STOPBITS__)
 Ensure that LPUART frame number of stop bits is valid.
#define IS_UART_PARITY(__PARITY__)
 Ensure that UART frame parity is valid.
#define IS_UART_HARDWARE_FLOW_CONTROL(__CONTROL__)
 Ensure that UART hardware flow control is valid.
#define IS_UART_MODE(__MODE__)   ((((__MODE__) & (~((uint32_t)(UART_MODE_TX_RX)))) == 0x00U) && ((__MODE__) != 0x00U))
 Ensure that UART communication mode is valid.
#define IS_UART_STATE(__STATE__)
 Ensure that UART state is valid.
#define IS_UART_OVERSAMPLING(__SAMPLING__)
 Ensure that UART oversampling is valid.
#define IS_UART_ONE_BIT_SAMPLE(__ONEBIT__)
 Ensure that UART frame sampling is valid.
#define IS_UART_ADVFEATURE_AUTOBAUDRATEMODE(__MODE__)
 Ensure that UART auto Baud rate detection mode is valid.
#define IS_UART_RECEIVER_TIMEOUT(__TIMEOUT__)
 Ensure that UART receiver timeout setting is valid.
#define IS_UART_LIN(__LIN__)
 Ensure that UART LIN state is valid.
#define IS_UART_LIN_BREAK_DETECT_LENGTH(__LENGTH__)
 Ensure that UART LIN break detection length is valid.
#define IS_UART_DMA_TX(__DMATX__)
 Ensure that UART DMA TX state is valid.
#define IS_UART_DMA_RX(__DMARX__)
 Ensure that UART DMA RX state is valid.
#define IS_UART_HALF_DUPLEX(__HDSEL__)
 Ensure that UART half-duplex state is valid.
#define IS_UART_WAKEUPMETHOD(__WAKEUP__)
 Ensure that UART wake-up method is valid.
#define IS_UART_REQUEST_PARAMETER(__PARAM__)
 Ensure that UART request parameter is valid.
#define IS_UART_ADVFEATURE_INIT(__INIT__)
 Ensure that UART advanced features initialization is valid.
#define IS_UART_ADVFEATURE_TXINV(__TXINV__)
 Ensure that UART frame TX inversion setting is valid.
#define IS_UART_ADVFEATURE_RXINV(__RXINV__)
 Ensure that UART frame RX inversion setting is valid.
#define IS_UART_ADVFEATURE_DATAINV(__DATAINV__)
 Ensure that UART frame data inversion setting is valid.
#define IS_UART_ADVFEATURE_SWAP(__SWAP__)
 Ensure that UART frame RX/TX pins swap setting is valid.
#define IS_UART_OVERRUN(__OVERRUN__)
 Ensure that UART frame overrun setting is valid.
#define IS_UART_ADVFEATURE_AUTOBAUDRATE(__AUTOBAUDRATE__)
 Ensure that UART auto Baud rate state is valid.
#define IS_UART_ADVFEATURE_DMAONRXERROR(__DMA__)
 Ensure that UART DMA enabling or disabling on error setting is valid.
#define IS_UART_ADVFEATURE_MSBFIRST(__MSBFIRST__)
 Ensure that UART frame MSB first setting is valid.
#define IS_UART_ADVFEATURE_STOPMODE(__STOPMODE__)
 Ensure that UART stop mode state is valid.
#define IS_UART_MUTE_MODE(__MUTE__)
 Ensure that UART mute mode state is valid.
#define IS_UART_WAKEUP_SELECTION(__WAKE__)
 Ensure that UART wake-up selection is valid.
#define IS_UART_DE_POLARITY(__POLARITY__)
 Ensure that UART driver enable polarity is valid.

Typedefs

typedef struct __UART_HandleTypeDef UART_HandleTypeDef
 UART handle Structure definition.
typedef void(* pUART_CallbackTypeDef )(UART_HandleTypeDef *huart)
 HAL UART Callback pointer definition.

Enumerations

enum  HAL_UART_StateTypeDef {
  HAL_UART_STATE_RESET = 0x00U, HAL_UART_STATE_READY = 0x20U, HAL_UART_STATE_BUSY = 0x24U, HAL_UART_STATE_BUSY_TX = 0x21U,
  HAL_UART_STATE_BUSY_RX = 0x22U, HAL_UART_STATE_BUSY_TX_RX = 0x23U, HAL_UART_STATE_TIMEOUT = 0xA0U, HAL_UART_STATE_ERROR = 0xE0U
}
 HAL UART State structures definition. More...
enum  UART_ClockSourceTypeDef {
  UART_CLOCKSOURCE_PCLK1 = 0x00U, UART_CLOCKSOURCE_PCLK2 = 0x01U, UART_CLOCKSOURCE_HSI = 0x02U, UART_CLOCKSOURCE_SYSCLK = 0x04U,
  UART_CLOCKSOURCE_LSE = 0x08U, UART_CLOCKSOURCE_UNDEFINED = 0x10U
}
 UART clock sources definition. More...
enum  HAL_UART_CallbackIDTypeDef {
  HAL_UART_TX_HALFCOMPLETE_CB_ID = 0x00U, HAL_UART_TX_COMPLETE_CB_ID = 0x01U, HAL_UART_RX_HALFCOMPLETE_CB_ID = 0x02U, HAL_UART_RX_COMPLETE_CB_ID = 0x03U,
  HAL_UART_ERROR_CB_ID = 0x04U, HAL_UART_ABORT_COMPLETE_CB_ID = 0x05U, HAL_UART_ABORT_TRANSMIT_COMPLETE_CB_ID = 0x06U, HAL_UART_ABORT_RECEIVE_COMPLETE_CB_ID = 0x07U,
  HAL_UART_WAKEUP_CB_ID = 0x08U, HAL_UART_MSPINIT_CB_ID = 0x0BU, HAL_UART_MSPDEINIT_CB_ID = 0x0CU
}
 HAL UART Callback ID enumeration definition. More...

Functions

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.
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.
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 .
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.
HAL_StatusTypeDef HAL_UART_DeInit (UART_HandleTypeDef *huart)
 DeInitialize the UART peripheral.
__weak void HAL_UART_MspInit (UART_HandleTypeDef *huart)
 Initialize the UART MSP.
__weak void HAL_UART_MspDeInit (UART_HandleTypeDef *huart)
 DeInitialize the UART MSP.
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.
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.
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.
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.
HAL_StatusTypeDef HAL_UART_Transmit_IT (UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size)
 Send an amount of data in interrupt mode.
HAL_StatusTypeDef HAL_UART_Receive_IT (UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size)
 Receive an amount of data in interrupt mode.
HAL_StatusTypeDef HAL_UART_Transmit_DMA (UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size)
 Send an amount of data in DMA mode.
HAL_StatusTypeDef HAL_UART_Receive_DMA (UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size)
 Receive an amount of data in DMA mode.
HAL_StatusTypeDef HAL_UART_DMAPause (UART_HandleTypeDef *huart)
 Pause the DMA Transfer.
HAL_StatusTypeDef HAL_UART_DMAResume (UART_HandleTypeDef *huart)
 Resume the DMA Transfer.
HAL_StatusTypeDef HAL_UART_DMAStop (UART_HandleTypeDef *huart)
 Stop the DMA Transfer.
HAL_StatusTypeDef HAL_UART_Abort (UART_HandleTypeDef *huart)
 Abort ongoing transfers (blocking mode).
HAL_StatusTypeDef HAL_UART_AbortTransmit (UART_HandleTypeDef *huart)
 Abort ongoing Transmit transfer (blocking mode).
HAL_StatusTypeDef HAL_UART_AbortReceive (UART_HandleTypeDef *huart)
 Abort ongoing Receive transfer (blocking mode).
HAL_StatusTypeDef HAL_UART_Abort_IT (UART_HandleTypeDef *huart)
 Abort ongoing transfers (Interrupt mode).
HAL_StatusTypeDef HAL_UART_AbortTransmit_IT (UART_HandleTypeDef *huart)
 Abort ongoing Transmit transfer (Interrupt mode).
HAL_StatusTypeDef HAL_UART_AbortReceive_IT (UART_HandleTypeDef *huart)
 Abort ongoing Receive transfer (Interrupt mode).
void HAL_UART_IRQHandler (UART_HandleTypeDef *huart)
 Handle UART interrupt request.
__weak void HAL_UART_TxHalfCpltCallback (UART_HandleTypeDef *huart)
 Tx Half Transfer completed callback.
__weak void HAL_UART_TxCpltCallback (UART_HandleTypeDef *huart)
 Tx Transfer completed callback.
__weak void HAL_UART_RxHalfCpltCallback (UART_HandleTypeDef *huart)
 Rx Half Transfer completed callback.
__weak void HAL_UART_RxCpltCallback (UART_HandleTypeDef *huart)
 Rx Transfer completed callback.
__weak void HAL_UART_ErrorCallback (UART_HandleTypeDef *huart)
 UART error callback.
__weak void HAL_UART_AbortCpltCallback (UART_HandleTypeDef *huart)
 UART Abort Complete callback.
__weak void HAL_UART_AbortTransmitCpltCallback (UART_HandleTypeDef *huart)
 UART Abort Complete callback.
__weak void HAL_UART_AbortReceiveCpltCallback (UART_HandleTypeDef *huart)
 UART Abort Receive Complete callback.
HAL_StatusTypeDef HAL_LIN_SendBreak (UART_HandleTypeDef *huart)
 Transmit break characters.
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).
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).
void HAL_MultiProcessor_EnterMuteMode (UART_HandleTypeDef *huart)
 Enter UART mute mode (means UART actually enters mute mode).
HAL_StatusTypeDef HAL_HalfDuplex_EnableTransmitter (UART_HandleTypeDef *huart)
 Enable the UART transmitter and disable the UART receiver.
HAL_StatusTypeDef HAL_HalfDuplex_EnableReceiver (UART_HandleTypeDef *huart)
 Enable the UART receiver and disable the UART transmitter.
HAL_UART_StateTypeDef HAL_UART_GetState (UART_HandleTypeDef *huart)
 Return the UART handle state.
uint32_t HAL_UART_GetError (UART_HandleTypeDef *huart)
 Return the UART handle error code.
HAL_StatusTypeDef UART_SetConfig (UART_HandleTypeDef *huart)
 Configure the UART peripheral.
HAL_StatusTypeDef UART_CheckIdleState (UART_HandleTypeDef *huart)
 Check the UART Idle State.
HAL_StatusTypeDef UART_WaitOnFlagUntilTimeout (UART_HandleTypeDef *huart, uint32_t Flag, FlagStatus Status, uint32_t Tickstart, uint32_t Timeout)
 Handle UART Communication Timeout.
void UART_AdvFeatureConfig (UART_HandleTypeDef *huart)
 Configure the UART peripheral advanced features.

Detailed Description

Header file of UART HAL module.

Author:
MCD Application Team
Attention:

© COPYRIGHT(c) 2017 STMicroelectronics

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of STMicroelectronics nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file stm32l4xx_hal_uart.h.