UART Exported Types

Collaboration diagram for UART Exported Types:

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

Typedefs
typedef uint32_t	HAL_UART_RxTypeTypeDef
	HAL UART Reception type definition. More...
typedef uint32_t	HAL_UART_StateTypeDef
	HAL UART State definition. More...
typedef uint32_t	HAL_UART_StateTypeDef
	HAL UART State definition. More...
typedef uint32_t	HAL_UART_StateTypeDef
	HAL UART State definition. More...
typedef struct __UART_HandleTypeDef	UART_HandleTypeDef
	UART handle Structure definition. More...
typedef struct __UART_HandleTypeDef	UART_HandleTypeDef
	UART handle Structure definition. More...
typedef struct __UART_HandleTypeDef	UART_HandleTypeDef
	UART handle Structure definition. More...
typedef struct __UART_HandleTypeDef	UART_HandleTypeDef
	UART handle Structure definition. More...

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_CLOCKSOURCE_D2PCLK1 = 0x00U, UART_CLOCKSOURCE_D2PCLK2 = 0x01U,   UART_CLOCKSOURCE_D3PCLK1 = 0x02U, UART_CLOCKSOURCE_PLL2 = 0x04U, UART_CLOCKSOURCE_PLL3 = 0x08U, UART_CLOCKSOURCE_HSI = 0x10U,   UART_CLOCKSOURCE_CSI = 0x20U, UART_CLOCKSOURCE_LSE = 0x40U, UART_CLOCKSOURCE_UNDEFINED = 0x80U, UART_CLOCKSOURCE_D2PCLK1 = 0x00U,   UART_CLOCKSOURCE_D2PCLK2 = 0x01U, UART_CLOCKSOURCE_D3PCLK1 = 0x02U, UART_CLOCKSOURCE_PLL2 = 0x04U, UART_CLOCKSOURCE_PLL3 = 0x08U,   UART_CLOCKSOURCE_HSI = 0x10U, UART_CLOCKSOURCE_CSI = 0x20U, UART_CLOCKSOURCE_LSE = 0x40U, UART_CLOCKSOURCE_UNDEFINED = 0x80U }
	UART clock sources 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_CLOCKSOURCE_D2PCLK1 = 0x00U, UART_CLOCKSOURCE_D2PCLK2 = 0x01U,   UART_CLOCKSOURCE_D3PCLK1 = 0x02U, UART_CLOCKSOURCE_PLL2 = 0x04U, UART_CLOCKSOURCE_PLL3 = 0x08U, UART_CLOCKSOURCE_HSI = 0x10U,   UART_CLOCKSOURCE_CSI = 0x20U, UART_CLOCKSOURCE_LSE = 0x40U, UART_CLOCKSOURCE_UNDEFINED = 0x80U, UART_CLOCKSOURCE_D2PCLK1 = 0x00U,   UART_CLOCKSOURCE_D2PCLK2 = 0x01U, UART_CLOCKSOURCE_D3PCLK1 = 0x02U, UART_CLOCKSOURCE_PLL2 = 0x04U, UART_CLOCKSOURCE_PLL3 = 0x08U,   UART_CLOCKSOURCE_HSI = 0x10U, UART_CLOCKSOURCE_CSI = 0x20U, UART_CLOCKSOURCE_LSE = 0x40U, UART_CLOCKSOURCE_UNDEFINED = 0x80U }
	UART clock sources 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_CLOCKSOURCE_D2PCLK1 = 0x00U, UART_CLOCKSOURCE_D2PCLK2 = 0x01U,   UART_CLOCKSOURCE_D3PCLK1 = 0x02U, UART_CLOCKSOURCE_PLL2 = 0x04U, UART_CLOCKSOURCE_PLL3 = 0x08U, UART_CLOCKSOURCE_HSI = 0x10U,   UART_CLOCKSOURCE_CSI = 0x20U, UART_CLOCKSOURCE_LSE = 0x40U, UART_CLOCKSOURCE_UNDEFINED = 0x80U, UART_CLOCKSOURCE_D2PCLK1 = 0x00U,   UART_CLOCKSOURCE_D2PCLK2 = 0x01U, UART_CLOCKSOURCE_D3PCLK1 = 0x02U, UART_CLOCKSOURCE_PLL2 = 0x04U, UART_CLOCKSOURCE_PLL3 = 0x08U,   UART_CLOCKSOURCE_HSI = 0x10U, UART_CLOCKSOURCE_CSI = 0x20U, UART_CLOCKSOURCE_LSE = 0x40U, UART_CLOCKSOURCE_UNDEFINED = 0x80U }
	UART clock sources definition. More...

Detailed Description

Typedef Documentation

HAL_UART_RxTypeTypeDef

typedef uint32_t HAL_UART_RxTypeTypeDef

HAL UART Reception type definition.

Note

HAL UART Reception type value aims to identify which type of Reception is ongoing. It is expected to admit following values : HAL_UART_RECEPTION_STANDARD = 0x00U, HAL_UART_RECEPTION_TOIDLE = 0x01U, HAL_UART_RECEPTION_TORTO = 0x02U, HAL_UART_RECEPTION_TOCHARMATCH = 0x03U,

Definition at line 207 of file stm32h735/stm32h735g-dk/Drivers/STM32H7xx_HAL_Driver/Inc/stm32h7xx_hal_uart.h.

HAL_UART_StateTypeDef [1/3]

typedef uint32_t HAL_UART_StateTypeDef

HAL UART State definition.

Note

HAL UART State value is a combination of 2 different substates: gState and RxState (see UART State Code Definition).

• 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 Peripheral initialization status 0 : Reset (Peripheral not initialized) 1 : Init done (Peripheral 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 (Peripheral 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 Peripheral initialization status 0 : Reset (Peripheral not initialized) 1 : Init done (Peripheral 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.

Definition at line 167 of file stm32f7xx_hal_uart.h.

HAL_UART_StateTypeDef [2/3]

typedef uint32_t HAL_UART_StateTypeDef

HAL UART State definition.

Note

HAL UART State value is a combination of 2 different substates: gState and RxState (see UART State Code Definition).

• 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 Peripheral initialization status 0 : Reset (Peripheral not initialized) 1 : Init done (Peripheral 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 (Peripheral 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 Peripheral initialization status 0 : Reset (Peripheral not initialized) 1 : Init done (Peripheral 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.

Definition at line 175 of file stm32h747/stm32h747i-disco/CM7/Drivers/STM32H7xx_HAL_Driver/Inc/stm32h7xx_hal_uart.h.

HAL_UART_StateTypeDef [3/3]

typedef uint32_t HAL_UART_StateTypeDef

HAL UART State definition.

Note

HAL UART State value is a combination of 2 different substates: gState and RxState (see UART State Code Definition).

• 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 Peripheral initialization status 0 : Reset (Peripheral not initialized) 1 : Init done (Peripheral 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 (Peripheral 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 Peripheral initialization status 0 : Reset (Peripheral not initialized) 1 : Init done (Peripheral 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.

Definition at line 180 of file stm32h735/stm32h735g-dk/Drivers/STM32H7xx_HAL_Driver/Inc/stm32h7xx_hal_uart.h.

UART_HandleTypeDef [1/4]

typedef struct __UART_HandleTypeDef UART_HandleTypeDef

UART handle Structure definition.

UART_HandleTypeDef [2/4]

typedef struct __UART_HandleTypeDef UART_HandleTypeDef

UART handle Structure definition.

UART_HandleTypeDef [3/4]

typedef struct __UART_HandleTypeDef UART_HandleTypeDef

UART handle Structure definition.

UART_HandleTypeDef [4/4]

typedef struct __UART_HandleTypeDef UART_HandleTypeDef

UART handle Structure definition.

Enumeration Type Documentation

HAL_UART_StateTypeDef

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 Peripheral initialization status 0 : Reset (Peripheral not initialized) 1 : Init done (Peripheral 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 (Peripheral 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 Peripheral initialization status 0 : Reset (Peripheral not initialized) 1 : Init done (Peripheral 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 yet 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 117 of file stm32f4xx_hal_uart.h.

UART_ClockSourceTypeDef [1/3]

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
UART_CLOCKSOURCE_D2PCLK1	Domain2 PCLK1 clock source
UART_CLOCKSOURCE_D2PCLK2	Domain2 PCLK2 clock source
UART_CLOCKSOURCE_D3PCLK1	Domain3 PCLK1 clock source
UART_CLOCKSOURCE_PLL2	PLL2Q clock source
UART_CLOCKSOURCE_PLL3	PLL3Q clock source
UART_CLOCKSOURCE_HSI	HSI clock source
UART_CLOCKSOURCE_CSI	CSI clock source
UART_CLOCKSOURCE_LSE	LSE clock source
UART_CLOCKSOURCE_UNDEFINED	Undefined clock source
UART_CLOCKSOURCE_D2PCLK1	Domain2 PCLK1 clock source
UART_CLOCKSOURCE_D2PCLK2	Domain2 PCLK2 clock source
UART_CLOCKSOURCE_D3PCLK1	Domain3 PCLK1 clock source
UART_CLOCKSOURCE_PLL2	PLL2Q clock source
UART_CLOCKSOURCE_PLL3	PLL3Q clock source
UART_CLOCKSOURCE_HSI	HSI clock source
UART_CLOCKSOURCE_CSI	CSI clock source
UART_CLOCKSOURCE_LSE	LSE clock source
UART_CLOCKSOURCE_UNDEFINED	Undefined clock source

Definition at line 172 of file stm32f7xx_hal_uart.h.

UART_ClockSourceTypeDef [2/3]

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
UART_CLOCKSOURCE_D2PCLK1	Domain2 PCLK1 clock source
UART_CLOCKSOURCE_D2PCLK2	Domain2 PCLK2 clock source
UART_CLOCKSOURCE_D3PCLK1	Domain3 PCLK1 clock source
UART_CLOCKSOURCE_PLL2	PLL2Q clock source
UART_CLOCKSOURCE_PLL3	PLL3Q clock source
UART_CLOCKSOURCE_HSI	HSI clock source
UART_CLOCKSOURCE_CSI	CSI clock source
UART_CLOCKSOURCE_LSE	LSE clock source
UART_CLOCKSOURCE_UNDEFINED	Undefined clock source
UART_CLOCKSOURCE_D2PCLK1	Domain2 PCLK1 clock source
UART_CLOCKSOURCE_D2PCLK2	Domain2 PCLK2 clock source
UART_CLOCKSOURCE_D3PCLK1	Domain3 PCLK1 clock source
UART_CLOCKSOURCE_PLL2	PLL2Q clock source
UART_CLOCKSOURCE_PLL3	PLL3Q clock source
UART_CLOCKSOURCE_HSI	HSI clock source
UART_CLOCKSOURCE_CSI	CSI clock source
UART_CLOCKSOURCE_LSE	LSE clock source
UART_CLOCKSOURCE_UNDEFINED	Undefined clock source

Definition at line 180 of file stm32h747/stm32h747i-disco/CM7/Drivers/STM32H7xx_HAL_Driver/Inc/stm32h7xx_hal_uart.h.

UART_ClockSourceTypeDef [3/3]

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
UART_CLOCKSOURCE_D2PCLK1	Domain2 PCLK1 clock source
UART_CLOCKSOURCE_D2PCLK2	Domain2 PCLK2 clock source
UART_CLOCKSOURCE_D3PCLK1	Domain3 PCLK1 clock source
UART_CLOCKSOURCE_PLL2	PLL2Q clock source
UART_CLOCKSOURCE_PLL3	PLL3Q clock source
UART_CLOCKSOURCE_HSI	HSI clock source
UART_CLOCKSOURCE_CSI	CSI clock source
UART_CLOCKSOURCE_LSE	LSE clock source
UART_CLOCKSOURCE_UNDEFINED	Undefined clock source
UART_CLOCKSOURCE_D2PCLK1	Domain2 PCLK1 clock source
UART_CLOCKSOURCE_D2PCLK2	Domain2 PCLK2 clock source
UART_CLOCKSOURCE_D3PCLK1	Domain3 PCLK1 clock source
UART_CLOCKSOURCE_PLL2	PLL2Q clock source
UART_CLOCKSOURCE_PLL3	PLL3Q clock source
UART_CLOCKSOURCE_HSI	HSI clock source
UART_CLOCKSOURCE_CSI	CSI clock source
UART_CLOCKSOURCE_LSE	LSE clock source
UART_CLOCKSOURCE_UNDEFINED	Undefined clock source

Definition at line 185 of file stm32h735/stm32h735g-dk/Drivers/STM32H7xx_HAL_Driver/Inc/stm32h7xx_hal_uart.h.