STM32H735xx HAL User Manual: __UART_HandleTypeDef Struct Reference

STM32H735xx HAL User Manual

UART handle Structure definition. More...

#include <stm32h7xx_hal_uart.h>

Data Fields
USART_TypeDef *	Instance
UART_InitTypeDef	Init
UART_AdvFeatureInitTypeDef	AdvancedInit
const uint8_t *	pTxBuffPtr
uint16_t	TxXferSize
__IO uint16_t	TxXferCount
uint8_t *	pRxBuffPtr
uint16_t	RxXferSize
__IO uint16_t	RxXferCount
uint16_t	Mask
uint32_t	FifoMode
uint16_t	NbRxDataToProcess
uint16_t	NbTxDataToProcess
__IO HAL_UART_RxTypeTypeDef	ReceptionType
void(*	RxISR )(struct __UART_HandleTypeDef *huart)
void(*	TxISR )(struct __UART_HandleTypeDef *huart)
DMA_HandleTypeDef *	hdmatx
DMA_HandleTypeDef *	hdmarx
HAL_LockTypeDef	Lock
__IO HAL_UART_StateTypeDef	gState
__IO HAL_UART_StateTypeDef	RxState
__IO uint32_t	ErrorCode
void(*	TxHalfCpltCallback )(struct __UART_HandleTypeDef *huart)
void(*	TxCpltCallback )(struct __UART_HandleTypeDef *huart)
void(*	RxHalfCpltCallback )(struct __UART_HandleTypeDef *huart)
void(*	RxCpltCallback )(struct __UART_HandleTypeDef *huart)
void(*	ErrorCallback )(struct __UART_HandleTypeDef *huart)
void(*	AbortCpltCallback )(struct __UART_HandleTypeDef *huart)
void(*	AbortTransmitCpltCallback )(struct __UART_HandleTypeDef *huart)
void(*	AbortReceiveCpltCallback )(struct __UART_HandleTypeDef *huart)
void(*	WakeupCallback )(struct __UART_HandleTypeDef *huart)
void(*	RxFifoFullCallback )(struct __UART_HandleTypeDef *huart)
void(*	TxFifoEmptyCallback )(struct __UART_HandleTypeDef *huart)
void(*	RxEventCallback )(struct __UART_HandleTypeDef *huart, uint16_t Pos)
void(*	MspInitCallback )(struct __UART_HandleTypeDef *huart)
void(*	MspDeInitCallback )(struct __UART_HandleTypeDef *huart)

Detailed Description

UART handle Structure definition.

Definition at line 211 of file stm32h7xx_hal_uart.h.

Field Documentation

void(* __UART_HandleTypeDef::AbortCpltCallback)(struct __UART_HandleTypeDef *huart)

UART Abort Complete Callback

Definition at line 267 of file stm32h7xx_hal_uart.h.

Referenced by HAL_UART_Abort_IT(), HAL_UART_RegisterCallback(), HAL_UART_UnRegisterCallback(), UART_DMARxAbortCallback(), UART_DMATxAbortCallback(), and UART_InitCallbacksToDefault().

void(* __UART_HandleTypeDef::AbortReceiveCpltCallback)(struct __UART_HandleTypeDef *huart)

UART Abort Receive Complete Callback

Definition at line 269 of file stm32h7xx_hal_uart.h.

Referenced by HAL_UART_AbortReceive_IT(), HAL_UART_RegisterCallback(), HAL_UART_UnRegisterCallback(), UART_DMARxOnlyAbortCallback(), and UART_InitCallbacksToDefault().

void(* __UART_HandleTypeDef::AbortTransmitCpltCallback)(struct __UART_HandleTypeDef *huart)

UART Abort Transmit Complete Callback

Definition at line 268 of file stm32h7xx_hal_uart.h.

Referenced by HAL_UART_AbortTransmit_IT(), HAL_UART_RegisterCallback(), HAL_UART_UnRegisterCallback(), UART_DMATxOnlyAbortCallback(), and UART_InitCallbacksToDefault().

UART_AdvFeatureInitTypeDef __UART_HandleTypeDef::AdvancedInit

UART Advanced Features initialization parameters

Definition at line 217 of file stm32h7xx_hal_uart.h.

Referenced by HAL_HalfDuplex_Init(), HAL_LIN_Init(), HAL_MultiProcessor_Init(), HAL_RS485Ex_Init(), HAL_UART_Init(), and UART_AdvFeatureConfig().

void(* __UART_HandleTypeDef::ErrorCallback)(struct __UART_HandleTypeDef *huart)

UART Error Callback

Definition at line 266 of file stm32h7xx_hal_uart.h.

Referenced by HAL_UART_IRQHandler(), HAL_UART_RegisterCallback(), HAL_UART_UnRegisterCallback(), UART_DMAAbortOnError(), UART_DMAError(), UART_InitCallbacksToDefault(), UART_RxISR_16BIT_FIFOEN(), and UART_RxISR_8BIT_FIFOEN().

uint32_t __UART_HandleTypeDef::FifoMode

Specifies if the FIFO mode is being used. This parameter can be a value of UARTEx FIFO mode.

Definition at line 233 of file stm32h7xx_hal_uart.h.

Referenced by HAL_UART_Abort(), HAL_UART_Abort_IT(), HAL_UART_AbortTransmit(), HAL_UART_AbortTransmit_IT(), HAL_UART_Transmit_IT(), HAL_UARTEx_DisableFifoMode(), HAL_UARTEx_EnableFifoMode(), UART_DMATxAbortCallback(), UART_DMATxOnlyAbortCallback(), UART_Start_Receive_IT(), and UARTEx_SetNbDataToProcess().

__IO HAL_UART_StateTypeDef __UART_HandleTypeDef::gState

UART state information related to global Handle management and also related to Tx operations. This parameter can be a value of HAL_UART_StateTypeDef

Definition at line 252 of file stm32h7xx_hal_uart.h.

Referenced by HAL_HalfDuplex_EnableReceiver(), HAL_HalfDuplex_EnableTransmitter(), HAL_HalfDuplex_Init(), HAL_LIN_Init(), HAL_LIN_SendBreak(), HAL_MultiProcessor_DisableMuteMode(), HAL_MultiProcessor_EnableMuteMode(), HAL_MultiProcessor_Init(), HAL_MultiProcessorEx_AddressLength_Set(), HAL_RS485Ex_Init(), HAL_UART_Abort(), HAL_UART_Abort_IT(), HAL_UART_AbortTransmit(), HAL_UART_AbortTransmit_IT(), HAL_UART_DeInit(), HAL_UART_DisableReceiverTimeout(), HAL_UART_DMAPause(), HAL_UART_DMAResume(), HAL_UART_DMAStop(), HAL_UART_EnableReceiverTimeout(), HAL_UART_GetState(), HAL_UART_Init(), HAL_UART_RegisterCallback(), HAL_UART_RegisterRxEventCallback(), HAL_UART_Transmit(), HAL_UART_Transmit_DMA(), HAL_UART_Transmit_IT(), HAL_UART_UnRegisterCallback(), HAL_UART_UnRegisterRxEventCallback(), HAL_UARTEx_DisableFifoMode(), HAL_UARTEx_EnableFifoMode(), HAL_UARTEx_SetRxFifoThreshold(), HAL_UARTEx_SetTxFifoThreshold(), HAL_UARTEx_StopModeWakeUpSourceConfig(), UART_CheckIdleState(), UART_DMAError(), UART_DMARxAbortCallback(), UART_DMATxAbortCallback(), UART_DMATxOnlyAbortCallback(), UART_EndTransmit_IT(), UART_EndTxTransfer(), UART_TxISR_16BIT(), UART_TxISR_16BIT_FIFOEN(), UART_TxISR_8BIT(), UART_TxISR_8BIT_FIFOEN(), and UART_WaitOnFlagUntilTimeout().

DMA_HandleTypeDef* __UART_HandleTypeDef::hdmarx

UART Rx DMA Handle parameters

Definition at line 248 of file stm32h7xx_hal_uart.h.

Referenced by HAL_UART_Abort(), HAL_UART_Abort_IT(), HAL_UART_AbortReceive(), HAL_UART_AbortReceive_IT(), HAL_UART_DMAStop(), HAL_UART_IRQHandler(), UART_DMARxAbortCallback(), UART_DMATxAbortCallback(), and UART_Start_Receive_DMA().

DMA_HandleTypeDef* __UART_HandleTypeDef::hdmatx

UART Tx DMA Handle parameters

Definition at line 246 of file stm32h7xx_hal_uart.h.

Referenced by HAL_UART_Abort(), HAL_UART_Abort_IT(), HAL_UART_AbortTransmit(), HAL_UART_AbortTransmit_IT(), HAL_UART_DMAStop(), HAL_UART_Transmit_DMA(), UART_DMARxAbortCallback(), and UART_DMATxAbortCallback().

UART_InitTypeDef __UART_HandleTypeDef::Init

UART communication parameters

Definition at line 215 of file stm32h7xx_hal_uart.h.

Referenced by HAL_LIN_Init(), HAL_UART_DMAResume(), HAL_UART_Init(), HAL_UART_Receive(), HAL_UART_Transmit(), HAL_UART_Transmit_IT(), HAL_UARTEx_ReceiveToIdle(), UART_SetConfig(), UART_Start_Receive_DMA(), and UART_Start_Receive_IT().

USART_TypeDef* __UART_HandleTypeDef::Instance

UART registers base address

Definition at line 213 of file stm32h7xx_hal_uart.h.

Referenced by HAL_HalfDuplex_EnableReceiver(), HAL_HalfDuplex_EnableTransmitter(), HAL_HalfDuplex_Init(), HAL_LIN_Init(), HAL_LIN_SendBreak(), HAL_MultiProcessor_DisableMuteMode(), HAL_MultiProcessor_EnableMuteMode(), HAL_MultiProcessor_Init(), HAL_MultiProcessorEx_AddressLength_Set(), HAL_RS485Ex_Init(), HAL_UART_Abort(), HAL_UART_Abort_IT(), HAL_UART_AbortReceive(), HAL_UART_AbortReceive_IT(), HAL_UART_AbortTransmit(), HAL_UART_AbortTransmit_IT(), HAL_UART_DeInit(), HAL_UART_DisableReceiverTimeout(), HAL_UART_DMAPause(), HAL_UART_DMAResume(), HAL_UART_DMAStop(), HAL_UART_EnableReceiverTimeout(), HAL_UART_Init(), HAL_UART_IRQHandler(), HAL_UART_Receive(), HAL_UART_Receive_DMA(), HAL_UART_Receive_IT(), HAL_UART_ReceiverTimeout_Config(), HAL_UART_Transmit(), HAL_UART_Transmit_DMA(), HAL_UART_Transmit_IT(), HAL_UARTEx_DisableFifoMode(), HAL_UARTEx_DisableStopMode(), HAL_UARTEx_EnableFifoMode(), HAL_UARTEx_EnableStopMode(), HAL_UARTEx_ReceiveToIdle(), HAL_UARTEx_ReceiveToIdle_DMA(), HAL_UARTEx_ReceiveToIdle_IT(), HAL_UARTEx_SetRxFifoThreshold(), HAL_UARTEx_SetTxFifoThreshold(), HAL_UARTEx_StopModeWakeUpSourceConfig(), UART_AdvFeatureConfig(), UART_CheckIdleState(), UART_DMAError(), UART_DMAReceiveCplt(), UART_DMATransmitCplt(), UART_EndRxTransfer(), UART_EndTransmit_IT(), UART_EndTxTransfer(), UART_RxISR_16BIT(), UART_RxISR_16BIT_FIFOEN(), UART_RxISR_8BIT(), UART_RxISR_8BIT_FIFOEN(), UART_SetConfig(), UART_Start_Receive_DMA(), UART_Start_Receive_IT(), UART_TxISR_16BIT(), UART_TxISR_16BIT_FIFOEN(), UART_TxISR_8BIT(), UART_TxISR_8BIT_FIFOEN(), UART_WaitOnFlagUntilTimeout(), UARTEx_SetNbDataToProcess(), and UARTEx_Wakeup_AddressConfig().

HAL_LockTypeDef __UART_HandleTypeDef::Lock

Locking object

Definition at line 250 of file stm32h7xx_hal_uart.h.

Referenced by HAL_HalfDuplex_Init(), HAL_LIN_Init(), HAL_MultiProcessor_Init(), HAL_RS485Ex_Init(), and HAL_UART_Init().

uint16_t __UART_HandleTypeDef::Mask

UART Rx RDR register mask

Definition at line 231 of file stm32h7xx_hal_uart.h.

Referenced by HAL_UART_Receive(), HAL_UARTEx_ReceiveToIdle(), UART_RxISR_16BIT(), UART_RxISR_16BIT_FIFOEN(), UART_RxISR_8BIT(), and UART_RxISR_8BIT_FIFOEN().

void(* __UART_HandleTypeDef::MspDeInitCallback)(struct __UART_HandleTypeDef *huart)

UART Msp DeInit callback

Definition at line 276 of file stm32h7xx_hal_uart.h.

Referenced by HAL_UART_DeInit(), HAL_UART_RegisterCallback(), and HAL_UART_UnRegisterCallback().

void(* __UART_HandleTypeDef::MspInitCallback)(struct __UART_HandleTypeDef *huart)

UART Msp Init callback

Definition at line 275 of file stm32h7xx_hal_uart.h.

Referenced by HAL_HalfDuplex_Init(), HAL_LIN_Init(), HAL_MultiProcessor_Init(), HAL_RS485Ex_Init(), HAL_UART_Init(), HAL_UART_RegisterCallback(), and HAL_UART_UnRegisterCallback().

uint16_t __UART_HandleTypeDef::NbRxDataToProcess

Number of data to process during RX ISR execution

Definition at line 236 of file stm32h7xx_hal_uart.h.

Referenced by UART_RxISR_16BIT_FIFOEN(), UART_RxISR_8BIT_FIFOEN(), UART_SetConfig(), UART_Start_Receive_IT(), UARTEx_SetNbDataToProcess(), USART_RxISR_16BIT_FIFOEN(), and USART_RxISR_8BIT_FIFOEN().

uint16_t __UART_HandleTypeDef::NbTxDataToProcess

Number of data to process during TX ISR execution

Definition at line 238 of file stm32h7xx_hal_uart.h.

Referenced by UART_SetConfig(), UART_TxISR_16BIT_FIFOEN(), UART_TxISR_8BIT_FIFOEN(), and UARTEx_SetNbDataToProcess().

uint8_t* __UART_HandleTypeDef::pRxBuffPtr

Pointer to UART Rx transfer Buffer

Definition at line 225 of file stm32h7xx_hal_uart.h.

Referenced by HAL_UART_AbortReceive_IT(), UART_RxISR_16BIT(), UART_RxISR_16BIT_FIFOEN(), UART_RxISR_8BIT(), UART_RxISR_8BIT_FIFOEN(), UART_Start_Receive_DMA(), and UART_Start_Receive_IT().

const uint8_t* __UART_HandleTypeDef::pTxBuffPtr

Pointer to UART Tx transfer Buffer

Definition at line 219 of file stm32h7xx_hal_uart.h.

Referenced by HAL_UART_Transmit_DMA(), HAL_UART_Transmit_IT(), UART_TxISR_16BIT(), UART_TxISR_16BIT_FIFOEN(), UART_TxISR_8BIT(), and UART_TxISR_8BIT_FIFOEN().

void(* __UART_HandleTypeDef::RxCpltCallback)(struct __UART_HandleTypeDef *huart)

UART Rx Complete Callback

Definition at line 265 of file stm32h7xx_hal_uart.h.

Referenced by HAL_UART_RegisterCallback(), HAL_UART_UnRegisterCallback(), UART_DMAReceiveCplt(), UART_InitCallbacksToDefault(), UART_RxISR_16BIT(), UART_RxISR_16BIT_FIFOEN(), UART_RxISR_8BIT(), and UART_RxISR_8BIT_FIFOEN().

void(* __UART_HandleTypeDef::RxEventCallback)(struct __UART_HandleTypeDef *huart, uint16_t Pos)

UART Reception Event Callback

Definition at line 273 of file stm32h7xx_hal_uart.h.

Referenced by HAL_UART_IRQHandler(), HAL_UART_RegisterRxEventCallback(), HAL_UART_UnRegisterRxEventCallback(), UART_DMAReceiveCplt(), UART_DMARxHalfCplt(), UART_InitCallbacksToDefault(), UART_RxISR_16BIT(), UART_RxISR_16BIT_FIFOEN(), UART_RxISR_8BIT(), and UART_RxISR_8BIT_FIFOEN().

void(* __UART_HandleTypeDef::RxFifoFullCallback)(struct __UART_HandleTypeDef *huart)

UART Rx Fifo Full Callback

Definition at line 271 of file stm32h7xx_hal_uart.h.

Referenced by HAL_UART_IRQHandler(), HAL_UART_RegisterCallback(), HAL_UART_UnRegisterCallback(), and UART_InitCallbacksToDefault().

void(* __UART_HandleTypeDef::RxHalfCpltCallback)(struct __UART_HandleTypeDef *huart)

UART Rx Half Complete Callback

Definition at line 264 of file stm32h7xx_hal_uart.h.

Referenced by HAL_UART_RegisterCallback(), HAL_UART_UnRegisterCallback(), UART_DMARxHalfCplt(), and UART_InitCallbacksToDefault().

void(* __UART_HandleTypeDef::RxISR)(struct __UART_HandleTypeDef *huart)

Function pointer on Rx IRQ handler

Definition at line 242 of file stm32h7xx_hal_uart.h.

Referenced by HAL_UART_Abort_IT(), HAL_UART_IRQHandler(), UART_EndRxTransfer(), UART_RxISR_16BIT(), UART_RxISR_16BIT_FIFOEN(), UART_RxISR_8BIT(), UART_RxISR_8BIT_FIFOEN(), UART_SetConfig(), and UART_Start_Receive_IT().

__IO HAL_UART_StateTypeDef __UART_HandleTypeDef::RxState

UART state information related to Rx operations. This parameter can be a value of HAL_UART_StateTypeDef

Definition at line 256 of file stm32h7xx_hal_uart.h.

Referenced by HAL_UART_Abort(), HAL_UART_Abort_IT(), HAL_UART_AbortReceive(), HAL_UART_AbortReceive_IT(), HAL_UART_DeInit(), HAL_UART_DMAPause(), HAL_UART_DMAResume(), HAL_UART_DMAStop(), HAL_UART_GetState(), HAL_UART_IRQHandler(), HAL_UART_Receive(), HAL_UART_Receive_DMA(), HAL_UART_Receive_IT(), HAL_UARTEx_ReceiveToIdle(), HAL_UARTEx_ReceiveToIdle_DMA(), HAL_UARTEx_ReceiveToIdle_IT(), UART_CheckIdleState(), UART_DMAError(), UART_DMAReceiveCplt(), UART_DMARxAbortCallback(), UART_DMARxOnlyAbortCallback(), UART_DMATxAbortCallback(), UART_EndRxTransfer(), UART_RxISR_16BIT(), UART_RxISR_16BIT_FIFOEN(), UART_RxISR_8BIT(), UART_RxISR_8BIT_FIFOEN(), UART_Start_Receive_DMA(), UART_Start_Receive_IT(), and UART_WaitOnFlagUntilTimeout().

__IO uint16_t __UART_HandleTypeDef::RxXferCount

UART Rx Transfer Counter

Definition at line 229 of file stm32h7xx_hal_uart.h.

Referenced by HAL_UART_Abort(), HAL_UART_Abort_IT(), HAL_UART_AbortReceive(), HAL_UART_AbortReceive_IT(), HAL_UART_IRQHandler(), HAL_UART_Receive(), HAL_UARTEx_ReceiveToIdle(), UART_DMAAbortOnError(), UART_DMAError(), UART_DMAReceiveCplt(), UART_DMARxAbortCallback(), UART_DMARxOnlyAbortCallback(), UART_DMATxAbortCallback(), UART_RxISR_16BIT(), UART_RxISR_16BIT_FIFOEN(), UART_RxISR_8BIT(), UART_RxISR_8BIT_FIFOEN(), and UART_Start_Receive_IT().

uint16_t __UART_HandleTypeDef::RxXferSize

UART Rx Transfer size

Definition at line 227 of file stm32h7xx_hal_uart.h.

Referenced by HAL_UART_IRQHandler(), HAL_UART_Receive(), HAL_UARTEx_ReceiveToIdle(), UART_DMAReceiveCplt(), UART_DMARxHalfCplt(), UART_RxISR_16BIT(), UART_RxISR_16BIT_FIFOEN(), UART_RxISR_8BIT(), UART_RxISR_8BIT_FIFOEN(), UART_Start_Receive_DMA(), and UART_Start_Receive_IT().

void(* __UART_HandleTypeDef::TxCpltCallback)(struct __UART_HandleTypeDef *huart)

UART Tx Complete Callback

Definition at line 263 of file stm32h7xx_hal_uart.h.

Referenced by HAL_UART_RegisterCallback(), HAL_UART_UnRegisterCallback(), UART_DMATransmitCplt(), UART_EndTransmit_IT(), and UART_InitCallbacksToDefault().

void(* __UART_HandleTypeDef::TxFifoEmptyCallback)(struct __UART_HandleTypeDef *huart)

UART Tx Fifo Empty Callback

Definition at line 272 of file stm32h7xx_hal_uart.h.

Referenced by HAL_UART_IRQHandler(), HAL_UART_RegisterCallback(), HAL_UART_UnRegisterCallback(), and UART_InitCallbacksToDefault().

void(* __UART_HandleTypeDef::TxHalfCpltCallback)(struct __UART_HandleTypeDef *huart)

UART Tx Half Complete Callback

Definition at line 262 of file stm32h7xx_hal_uart.h.

Referenced by HAL_UART_RegisterCallback(), HAL_UART_UnRegisterCallback(), UART_DMATxHalfCplt(), and UART_InitCallbacksToDefault().

void(* __UART_HandleTypeDef::TxISR)(struct __UART_HandleTypeDef *huart)

Function pointer on Tx IRQ handler

Definition at line 244 of file stm32h7xx_hal_uart.h.

Referenced by HAL_UART_Abort_IT(), HAL_UART_AbortTransmit_IT(), HAL_UART_IRQHandler(), HAL_UART_Transmit_IT(), UART_EndTransmit_IT(), and UART_SetConfig().

__IO uint16_t __UART_HandleTypeDef::TxXferCount

UART Tx Transfer Counter

Definition at line 223 of file stm32h7xx_hal_uart.h.

Referenced by HAL_UART_Abort(), HAL_UART_Abort_IT(), HAL_UART_AbortTransmit(), HAL_UART_AbortTransmit_IT(), HAL_UART_Transmit(), HAL_UART_Transmit_DMA(), HAL_UART_Transmit_IT(), UART_DMAAbortOnError(), UART_DMAError(), UART_DMARxAbortCallback(), UART_DMATransmitCplt(), UART_DMATxAbortCallback(), UART_DMATxOnlyAbortCallback(), UART_TxISR_16BIT(), UART_TxISR_16BIT_FIFOEN(), UART_TxISR_8BIT(), and UART_TxISR_8BIT_FIFOEN().

uint16_t __UART_HandleTypeDef::TxXferSize

UART Tx Transfer size

Definition at line 221 of file stm32h7xx_hal_uart.h.

Referenced by HAL_UART_Transmit(), HAL_UART_Transmit_DMA(), and HAL_UART_Transmit_IT().

void(* __UART_HandleTypeDef::WakeupCallback)(struct __UART_HandleTypeDef *huart)

UART Wakeup Callback

Definition at line 270 of file stm32h7xx_hal_uart.h.

Referenced by HAL_UART_IRQHandler(), HAL_UART_RegisterCallback(), HAL_UART_UnRegisterCallback(), and UART_InitCallbacksToDefault().

The documentation for this struct was generated from the following file:

stm32h7xx_hal_uart.h