STM32F4xx HAL Documentation
Hardware Abstraction Layer for STM32F4 familiy
•All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Data Fields
__UART_HandleTypeDef Struct Reference
STM32F4xx_HAL_Driver » UART » UART Exported Types

UART handle Structure definition. More...

#include <stm32f4xx_hal_uart.h>

Collaboration diagram for __UART_HandleTypeDef:

Data Fields

USART_TypeDef * Instance
 
UART_InitTypeDef Init
 
const uint8_t * pTxBuffPtr
 
uint16_t TxXferSize
 
__IO uint16_t TxXferCount
 
uint8_t * pRxBuffPtr
 
uint16_t RxXferSize
 
__IO uint16_t RxXferCount
 
__IO HAL_UART_RxTypeTypeDef ReceptionType
 
__IO HAL_UART_RxEventTypeTypeDef RxEventType
 
DMA_HandleTypeDef * hdmatx
 
DMA_HandleTypeDef * hdmarx
 
HAL_LockTypeDef Lock
 
__IO HAL_UART_StateTypeDef gState
 
__IO HAL_UART_StateTypeDef RxState
 
__IO uint32_t ErrorCode
 

Detailed Description

UART handle Structure definition.

Definition at line 160 of file stm32f4xx_hal_uart.h.

Field Documentation

◆ Instance

USART_TypeDef* __UART_HandleTypeDef::Instance

UART registers base address

Definition at line 162 of file stm32f4xx_hal_uart.h.

Referenced by HAL_HalfDuplex_EnableReceiver(), HAL_HalfDuplex_EnableTransmitter(), HAL_HalfDuplex_Init(), HAL_LIN_Init(), HAL_LIN_SendBreak(), HAL_MultiProcessor_EnterMuteMode(), HAL_MultiProcessor_ExitMuteMode(), HAL_MultiProcessor_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_DMAPause(), HAL_UART_DMAResume(), HAL_UART_DMAStop(), HAL_UART_Init(), HAL_UART_IRQHandler(), HAL_UART_Receive(), HAL_UART_Transmit(), HAL_UART_Transmit_DMA(), HAL_UARTEx_ReceiveToIdle(), HAL_UARTEx_ReceiveToIdle_DMA(), HAL_UARTEx_ReceiveToIdle_IT(), UART_DMAError(), UART_DMAReceiveCplt(), UART_DMATransmitCplt(), UART_EndRxTransfer(), UART_EndTxTransfer(), UART_Receive_IT(), UART_SetConfig(), UART_Start_Receive_DMA(), UART_Transmit_IT(), and UART_WaitOnFlagUntilTimeout().

◆ Init

UART_InitTypeDef __UART_HandleTypeDef::Init

UART communication parameters

Definition at line 164 of file stm32f4xx_hal_uart.h.

Referenced by HAL_HalfDuplex_Init(), HAL_LIN_Init(), HAL_MultiProcessor_Init(), HAL_UART_DMAResume(), HAL_UART_Init(), HAL_UART_Receive(), HAL_UART_Transmit(), HAL_UARTEx_ReceiveToIdle(), UART_Receive_IT(), UART_SetConfig(), UART_Start_Receive_DMA(), UART_Start_Receive_IT(), and UART_Transmit_IT().

◆ pTxBuffPtr

const uint8_t* __UART_HandleTypeDef::pTxBuffPtr

Pointer to UART Tx transfer Buffer

Definition at line 166 of file stm32f4xx_hal_uart.h.

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

◆ TxXferSize

uint16_t __UART_HandleTypeDef::TxXferSize

UART Tx Transfer size

Definition at line 168 of file stm32f4xx_hal_uart.h.

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

◆ TxXferCount

__IO uint16_t __UART_HandleTypeDef::TxXferCount

UART Tx Transfer Counter

Definition at line 170 of file stm32f4xx_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(), and UART_Transmit_IT().

◆ pRxBuffPtr

uint8_t* __UART_HandleTypeDef::pRxBuffPtr

Pointer to UART Rx transfer Buffer

Definition at line 172 of file stm32f4xx_hal_uart.h.

Referenced by UART_Receive_IT(), UART_Start_Receive_DMA(), and UART_Start_Receive_IT().

◆ RxXferSize

uint16_t __UART_HandleTypeDef::RxXferSize

UART Rx Transfer size

Definition at line 174 of file stm32f4xx_hal_uart.h.

Referenced by HAL_UART_IRQHandler(), HAL_UART_Receive(), HAL_UARTEx_ReceiveToIdle(), UART_DMAReceiveCplt(), UART_DMARxHalfCplt(), UART_Receive_IT(), UART_Start_Receive_DMA(), and UART_Start_Receive_IT().

◆ RxXferCount

__IO uint16_t __UART_HandleTypeDef::RxXferCount

UART Rx Transfer Counter

Definition at line 176 of file stm32f4xx_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_Receive_IT(), and UART_Start_Receive_IT().

◆ ReceptionType

__IO HAL_UART_RxTypeTypeDef __UART_HandleTypeDef::ReceptionType

Type of ongoing reception

Definition at line 178 of file stm32f4xx_hal_uart.h.

Referenced by HAL_UART_Abort(), HAL_UART_Abort_IT(), HAL_UART_AbortReceive(), HAL_UART_AbortReceive_IT(), HAL_UART_DeInit(), 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_DMAReceiveCplt(), UART_DMARxAbortCallback(), UART_DMARxHalfCplt(), UART_DMARxOnlyAbortCallback(), UART_DMATxAbortCallback(), UART_EndRxTransfer(), and UART_Receive_IT().

◆ RxEventType

__IO HAL_UART_RxEventTypeTypeDef __UART_HandleTypeDef::RxEventType

Type of Rx Event

Definition at line 180 of file stm32f4xx_hal_uart.h.

Referenced by HAL_HalfDuplex_Init(), HAL_LIN_Init(), HAL_MultiProcessor_EnterMuteMode(), HAL_MultiProcessor_ExitMuteMode(), HAL_MultiProcessor_Init(), HAL_UART_DeInit(), HAL_UART_Init(), HAL_UART_IRQHandler(), HAL_UARTEx_GetRxEventType(), HAL_UARTEx_ReceiveToIdle(), HAL_UARTEx_ReceiveToIdle_DMA(), HAL_UARTEx_ReceiveToIdle_IT(), UART_DMAReceiveCplt(), UART_DMARxHalfCplt(), and UART_Receive_IT().

◆ hdmatx

DMA_HandleTypeDef* __UART_HandleTypeDef::hdmatx

UART Tx DMA Handle parameters

Definition at line 182 of file stm32f4xx_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().

◆ hdmarx

DMA_HandleTypeDef* __UART_HandleTypeDef::hdmarx

UART Rx DMA Handle parameters

Definition at line 184 of file stm32f4xx_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().

◆ Lock

HAL_LockTypeDef __UART_HandleTypeDef::Lock

Locking object

Definition at line 186 of file stm32f4xx_hal_uart.h.

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

◆ gState

__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 188 of file stm32f4xx_hal_uart.h.

Referenced by HAL_HalfDuplex_EnableReceiver(), HAL_HalfDuplex_EnableTransmitter(), HAL_HalfDuplex_Init(), HAL_LIN_Init(), HAL_LIN_SendBreak(), HAL_MultiProcessor_EnterMuteMode(), HAL_MultiProcessor_ExitMuteMode(), HAL_MultiProcessor_Init(), HAL_UART_Abort(), HAL_UART_Abort_IT(), HAL_UART_AbortTransmit(), HAL_UART_AbortTransmit_IT(), HAL_UART_DeInit(), HAL_UART_DMAPause(), HAL_UART_DMAResume(), HAL_UART_DMAStop(), HAL_UART_GetState(), HAL_UART_Init(), HAL_UART_Transmit(), HAL_UART_Transmit_DMA(), HAL_UART_Transmit_IT(), UART_DMAError(), UART_DMARxAbortCallback(), UART_DMATxAbortCallback(), UART_DMATxOnlyAbortCallback(), UART_EndTransmit_IT(), UART_EndTxTransfer(), and UART_Transmit_IT().

◆ RxState

__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 192 of file stm32f4xx_hal_uart.h.

Referenced by HAL_HalfDuplex_Init(), HAL_LIN_Init(), HAL_MultiProcessor_Init(), 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_Init(), 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_DMAError(), UART_DMAReceiveCplt(), UART_DMARxAbortCallback(), UART_DMARxOnlyAbortCallback(), UART_DMATxAbortCallback(), UART_EndRxTransfer(), UART_Receive_IT(), UART_Start_Receive_DMA(), and UART_Start_Receive_IT().

◆ ErrorCode

__IO uint32_t __UART_HandleTypeDef::ErrorCode

UART Error code

Definition at line 195 of file stm32f4xx_hal_uart.h.

Referenced by HAL_HalfDuplex_Init(), HAL_LIN_Init(), HAL_MultiProcessor_Init(), HAL_UART_Abort(), HAL_UART_Abort_IT(), HAL_UART_AbortReceive(), HAL_UART_AbortTransmit(), HAL_UART_DeInit(), HAL_UART_GetError(), HAL_UART_Init(), HAL_UART_IRQHandler(), HAL_UART_Receive(), HAL_UART_Transmit(), HAL_UART_Transmit_DMA(), HAL_UART_Transmit_IT(), HAL_UARTEx_ReceiveToIdle(), UART_DMAError(), UART_DMARxAbortCallback(), UART_DMATxAbortCallback(), UART_Start_Receive_DMA(), UART_Start_Receive_IT(), and UART_WaitOnFlagUntilTimeout().

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