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

USART handle Structure definition. More...

#include <stm32f4xx_hal_usart.h>

Collaboration diagram for __USART_HandleTypeDef:

Data Fields

USART_TypeDef * Instance
 
USART_InitTypeDef Init
 
const uint8_t * pTxBuffPtr
 
uint16_t TxXferSize
 
__IO uint16_t TxXferCount
 
uint8_t * pRxBuffPtr
 
uint16_t RxXferSize
 
__IO uint16_t RxXferCount
 
DMA_HandleTypeDef * hdmatx
 
DMA_HandleTypeDef * hdmarx
 
HAL_LockTypeDef Lock
 
__IO HAL_USART_StateTypeDef State
 
__IO uint32_t ErrorCode
 

Detailed Description

USART handle Structure definition.

Definition at line 98 of file stm32f4xx_hal_usart.h.

Field Documentation

◆ Instance

USART_TypeDef* __USART_HandleTypeDef::Instance

USART registers base address

Definition at line 100 of file stm32f4xx_hal_usart.h.

Referenced by HAL_USART_Abort(), HAL_USART_Abort_IT(), HAL_USART_DeInit(), HAL_USART_DMAPause(), HAL_USART_DMAResume(), HAL_USART_DMAStop(), HAL_USART_Init(), HAL_USART_IRQHandler(), HAL_USART_Receive(), HAL_USART_Receive_DMA(), HAL_USART_Receive_IT(), HAL_USART_Transmit(), HAL_USART_Transmit_DMA(), HAL_USART_Transmit_IT(), HAL_USART_TransmitReceive(), HAL_USART_TransmitReceive_DMA(), HAL_USART_TransmitReceive_IT(), USART_DMAError(), USART_DMAReceiveCplt(), USART_DMATransmitCplt(), USART_EndRxTransfer(), USART_EndTransmit_IT(), USART_EndTxTransfer(), USART_Receive_IT(), USART_SetConfig(), USART_Transmit_IT(), USART_TransmitReceive_IT(), and USART_WaitOnFlagUntilTimeout().

◆ Init

USART_InitTypeDef __USART_HandleTypeDef::Init

Usart communication parameters

Definition at line 102 of file stm32f4xx_hal_usart.h.

Referenced by HAL_USART_Receive(), HAL_USART_Receive_DMA(), HAL_USART_Receive_IT(), HAL_USART_Transmit(), HAL_USART_TransmitReceive(), HAL_USART_TransmitReceive_DMA(), HAL_USART_TransmitReceive_IT(), USART_Receive_IT(), USART_SetConfig(), USART_Transmit_IT(), and USART_TransmitReceive_IT().

◆ pTxBuffPtr

const uint8_t* __USART_HandleTypeDef::pTxBuffPtr

Pointer to Usart Tx transfer Buffer

Definition at line 104 of file stm32f4xx_hal_usart.h.

Referenced by HAL_USART_Receive_DMA(), HAL_USART_Transmit_DMA(), HAL_USART_Transmit_IT(), HAL_USART_TransmitReceive_DMA(), HAL_USART_TransmitReceive_IT(), USART_Transmit_IT(), and USART_TransmitReceive_IT().

◆ TxXferSize

uint16_t __USART_HandleTypeDef::TxXferSize

Usart Tx Transfer size

Definition at line 106 of file stm32f4xx_hal_usart.h.

Referenced by HAL_USART_Receive_DMA(), HAL_USART_Transmit(), HAL_USART_Transmit_DMA(), HAL_USART_Transmit_IT(), HAL_USART_TransmitReceive(), HAL_USART_TransmitReceive_DMA(), and HAL_USART_TransmitReceive_IT().

◆ TxXferCount

__IO uint16_t __USART_HandleTypeDef::TxXferCount

Usart Tx Transfer Counter

Definition at line 108 of file stm32f4xx_hal_usart.h.

Referenced by HAL_USART_Abort(), HAL_USART_Abort_IT(), HAL_USART_Transmit(), HAL_USART_Transmit_DMA(), HAL_USART_Transmit_IT(), HAL_USART_TransmitReceive(), HAL_USART_TransmitReceive_IT(), USART_DMAAbortOnError(), USART_DMAError(), USART_DMARxAbortCallback(), USART_DMATransmitCplt(), USART_DMATxAbortCallback(), USART_Transmit_IT(), and USART_TransmitReceive_IT().

◆ pRxBuffPtr

uint8_t* __USART_HandleTypeDef::pRxBuffPtr

Pointer to Usart Rx transfer Buffer

Definition at line 110 of file stm32f4xx_hal_usart.h.

Referenced by HAL_USART_Receive_DMA(), HAL_USART_Receive_IT(), HAL_USART_TransmitReceive_DMA(), HAL_USART_TransmitReceive_IT(), USART_Receive_IT(), and USART_TransmitReceive_IT().

◆ RxXferSize

uint16_t __USART_HandleTypeDef::RxXferSize

Usart Rx Transfer size

Definition at line 112 of file stm32f4xx_hal_usart.h.

Referenced by HAL_USART_Receive(), HAL_USART_Receive_DMA(), HAL_USART_Receive_IT(), HAL_USART_TransmitReceive(), HAL_USART_TransmitReceive_DMA(), and HAL_USART_TransmitReceive_IT().

◆ RxXferCount

__IO uint16_t __USART_HandleTypeDef::RxXferCount

Usart Rx Transfer Counter

Definition at line 114 of file stm32f4xx_hal_usart.h.

Referenced by HAL_USART_Abort(), HAL_USART_Abort_IT(), HAL_USART_Receive(), HAL_USART_Receive_IT(), HAL_USART_TransmitReceive(), HAL_USART_TransmitReceive_IT(), USART_DMAAbortOnError(), USART_DMAError(), USART_DMAReceiveCplt(), USART_DMARxAbortCallback(), USART_DMATxAbortCallback(), USART_Receive_IT(), and USART_TransmitReceive_IT().

◆ hdmatx

DMA_HandleTypeDef* __USART_HandleTypeDef::hdmatx

Usart Tx DMA Handle parameters

Definition at line 116 of file stm32f4xx_hal_usart.h.

Referenced by HAL_USART_Abort(), HAL_USART_Abort_IT(), HAL_USART_DMAStop(), HAL_USART_Receive_DMA(), HAL_USART_Transmit_DMA(), HAL_USART_TransmitReceive_DMA(), USART_DMARxAbortCallback(), and USART_DMATxAbortCallback().

◆ hdmarx

DMA_HandleTypeDef* __USART_HandleTypeDef::hdmarx

Usart Rx DMA Handle parameters

Definition at line 118 of file stm32f4xx_hal_usart.h.

Referenced by HAL_USART_Abort(), HAL_USART_Abort_IT(), HAL_USART_DMAStop(), HAL_USART_IRQHandler(), HAL_USART_Receive_DMA(), HAL_USART_TransmitReceive_DMA(), USART_DMARxAbortCallback(), and USART_DMATxAbortCallback().

◆ Lock

HAL_LockTypeDef __USART_HandleTypeDef::Lock

Locking object

Definition at line 120 of file stm32f4xx_hal_usart.h.

Referenced by HAL_USART_Init().

◆ State

__IO HAL_USART_StateTypeDef __USART_HandleTypeDef::State

Usart communication state

Definition at line 122 of file stm32f4xx_hal_usart.h.

Referenced by HAL_USART_Abort(), HAL_USART_Abort_IT(), HAL_USART_DeInit(), HAL_USART_DMAStop(), HAL_USART_GetState(), HAL_USART_Init(), HAL_USART_IRQHandler(), HAL_USART_Receive(), HAL_USART_Receive_DMA(), HAL_USART_Receive_IT(), HAL_USART_Transmit(), HAL_USART_Transmit_DMA(), HAL_USART_Transmit_IT(), HAL_USART_TransmitReceive(), HAL_USART_TransmitReceive_DMA(), HAL_USART_TransmitReceive_IT(), USART_DMAError(), USART_DMAReceiveCplt(), USART_DMARxAbortCallback(), USART_DMATransmitCplt(), USART_DMATxAbortCallback(), USART_EndRxTransfer(), USART_EndTransmit_IT(), USART_EndTxTransfer(), USART_Receive_IT(), USART_Transmit_IT(), USART_TransmitReceive_IT(), and USART_WaitOnFlagUntilTimeout().

◆ ErrorCode

__IO uint32_t __USART_HandleTypeDef::ErrorCode

USART Error code

Definition at line 124 of file stm32f4xx_hal_usart.h.

Referenced by HAL_USART_Abort(), HAL_USART_Abort_IT(), HAL_USART_DeInit(), HAL_USART_GetError(), HAL_USART_Init(), HAL_USART_IRQHandler(), HAL_USART_Receive(), HAL_USART_Receive_DMA(), HAL_USART_Receive_IT(), HAL_USART_Transmit(), HAL_USART_Transmit_DMA(), HAL_USART_Transmit_IT(), HAL_USART_TransmitReceive(), HAL_USART_TransmitReceive_DMA(), HAL_USART_TransmitReceive_IT(), USART_DMAError(), USART_DMARxAbortCallback(), and USART_DMATxAbortCallback().

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