stm32l4xx_hal_uart.h File Reference

Header file of UART HAL module. More...

Go to the source code of this file.

Data Structures
struct	UART_InitTypeDef
	UART Init Structure definition. More...
struct	UART_AdvFeatureInitTypeDef
	UART Advanced Features initialization structure definition. More...
struct	__UART_HandleTypeDef
	UART handle Structure definition. More...

Typedefs
typedef uint32_t	HAL_UART_StateTypeDef
	HAL UART State definition. More...
typedef struct __UART_HandleTypeDef	UART_HandleTypeDef
	UART handle Structure definition. More...
typedef void(*	pUART_CallbackTypeDef) (UART_HandleTypeDef *huart)
	HAL UART Callback pointer definition. More...

Enumerations
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_RX_FIFO_FULL_CB_ID = 0x09U, HAL_UART_TX_FIFO_EMPTY_CB_ID = 0x0AU, 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. 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_TxHalfCpltCallback (UART_HandleTypeDef *huart)
	Tx Half Transfer completed callback. More...
void	HAL_UART_TxCpltCallback (UART_HandleTypeDef *huart)
	Tx Transfer completed callback. More...
void	HAL_UART_RxHalfCpltCallback (UART_HandleTypeDef *huart)
	Rx Half Transfer completed callback. More...
void	HAL_UART_RxCpltCallback (UART_HandleTypeDef *huart)
	Rx 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_LIN_SendBreak (UART_HandleTypeDef *huart)
	Transmit break characters. 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_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...
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...
void	UART_AdvFeatureConfig (UART_HandleTypeDef *huart)
	Configure the UART peripheral advanced features. More...

Detailed Description

Header file of UART HAL module.

Author

MCD Application Team

Attention

© Copyright (c) 2017 STMicroelectronics. All rights reserved.

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.h.