UART Exported Types

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

---

Typedef Documentation

typedef void(* pUART_CallbackTypeDef)(UART_HandleTypeDef *huart)

HAL UART Callback pointer definition.

pointer to an UART callback function

Definition at line 331 of file stm32l4xx_hal_uart.h.

typedef struct __UART_HandleTypeDef UART_HandleTypeDef

UART handle Structure definition.

---

Enumeration Type Documentation

enum HAL_UART_CallbackIDTypeDef

HAL UART Callback ID enumeration definition.

Enumerator:

HAL_UART_TX_HALFCOMPLETE_CB_ID	UART Tx Half Complete Callback ID
HAL_UART_TX_COMPLETE_CB_ID	UART Tx Complete Callback ID
HAL_UART_RX_HALFCOMPLETE_CB_ID	UART Rx Half Complete Callback ID
HAL_UART_RX_COMPLETE_CB_ID	UART Rx Complete Callback ID
HAL_UART_ERROR_CB_ID	UART Error Callback ID
HAL_UART_ABORT_COMPLETE_CB_ID	UART Abort Complete Callback ID
HAL_UART_ABORT_TRANSMIT_COMPLETE_CB_ID	UART Abort Transmit Complete Callback ID
HAL_UART_ABORT_RECEIVE_COMPLETE_CB_ID	UART Abort Receive Complete Callback ID
HAL_UART_WAKEUP_CB_ID	UART Wakeup Callback ID
HAL_UART_MSPINIT_CB_ID	UART MspInit callback ID
HAL_UART_MSPDEINIT_CB_ID	UART MspDeInit callback ID

Definition at line 307 of file stm32l4xx_hal_uart.h.

enum HAL_UART_StateTypeDef

HAL UART State structures definition.

Note:

HAL UART State value is a combination of 2 different substates: gState and RxState.

• gState contains UART state information related to global Handle management and also information related to Tx operations. gState value coding follow below described bitmap : b7-b6 Error information 00 : No Error 01 : (Not Used) 10 : Timeout 11 : Error b5 IP initilisation status 0 : Reset (IP not initialized) 1 : Init done (IP not initialized. HAL UART Init function already called) b4-b3 (not used) xx : Should be set to 00 b2 Intrinsic process state 0 : Ready 1 : Busy (IP busy with some configuration or internal operations) b1 (not used) x : Should be set to 0 b0 Tx state 0 : Ready (no Tx operation ongoing) 1 : Busy (Tx operation ongoing)
• RxState contains information related to Rx operations. RxState value coding follow below described bitmap : b7-b6 (not used) xx : Should be set to 00 b5 IP initilisation status 0 : Reset (IP not initialized) 1 : Init done (IP not initialized) b4-b2 (not used) xxx : Should be set to 000 b1 Rx state 0 : Ready (no Rx operation ongoing) 1 : Busy (Rx operation ongoing) b0 (not used) x : Should be set to 0.

Enumerator:

HAL_UART_STATE_RESET	Peripheral is not initialized Value is allowed for gState and RxState
HAL_UART_STATE_READY	Peripheral Initialized and ready for use Value is allowed for gState and RxState
HAL_UART_STATE_BUSY	an internal process is ongoing Value is allowed for gState only
HAL_UART_STATE_BUSY_TX	Data Transmission process is ongoing Value is allowed for gState only
HAL_UART_STATE_BUSY_RX	Data Reception process is ongoing Value is allowed for RxState only
HAL_UART_STATE_BUSY_TX_RX	Data Transmission and Reception process is ongoing Not to be used for neither gState nor RxState. Value is result of combination (Or) between gState and RxState values
HAL_UART_STATE_TIMEOUT	Timeout state Value is allowed for gState only
HAL_UART_STATE_ERROR	Error Value is allowed for gState only

Definition at line 195 of file stm32l4xx_hal_uart.h.

enum UART_ClockSourceTypeDef

UART clock sources definition.

Enumerator:

UART_CLOCKSOURCE_PCLK1	PCLK1 clock source
UART_CLOCKSOURCE_PCLK2	PCLK2 clock source
UART_CLOCKSOURCE_HSI	HSI clock source
UART_CLOCKSOURCE_SYSCLK	SYSCLK clock source
UART_CLOCKSOURCE_LSE	LSE clock source
UART_CLOCKSOURCE_UNDEFINED	Undefined clock source

Definition at line 219 of file stm32l4xx_hal_uart.h.