STM32L486xx HAL User Manual: __USART_HandleTypeDef Struct Reference

STM32L486xx HAL User Manual

USART handle Structure definition. More...

#include <stm32l4xx_hal_usart.h>

Data Fields
USART_TypeDef *	Instance
USART_InitTypeDef	Init
uint8_t *	pTxBuffPtr
uint16_t	TxXferSize
__IO uint16_t	TxXferCount
uint8_t *	pRxBuffPtr
uint16_t	RxXferSize
__IO uint16_t	RxXferCount
uint16_t	Mask
void(*	RxISR )(struct __USART_HandleTypeDef *husart)
void(*	TxISR )(struct __USART_HandleTypeDef *husart)
DMA_HandleTypeDef *	hdmatx
DMA_HandleTypeDef *	hdmarx
HAL_LockTypeDef	Lock
__IO HAL_USART_StateTypeDef	State
__IO uint32_t	ErrorCode
void(*	TxHalfCpltCallback )(struct __USART_HandleTypeDef *husart)
void(*	TxCpltCallback )(struct __USART_HandleTypeDef *husart)
void(*	RxHalfCpltCallback )(struct __USART_HandleTypeDef *husart)
void(*	RxCpltCallback )(struct __USART_HandleTypeDef *husart)
void(*	TxRxCpltCallback )(struct __USART_HandleTypeDef *husart)
void(*	ErrorCallback )(struct __USART_HandleTypeDef *husart)
void(*	AbortCpltCallback )(struct __USART_HandleTypeDef *husart)
void(*	MspInitCallback )(struct __USART_HandleTypeDef *husart)
void(*	MspDeInitCallback )(struct __USART_HandleTypeDef *husart)

Detailed Description

USART handle Structure definition.

Definition at line 137 of file stm32l4xx_hal_usart.h.

Field Documentation

void(* __USART_HandleTypeDef::AbortCpltCallback)(struct __USART_HandleTypeDef *husart)

USART Abort Complete Callback

Definition at line 194 of file stm32l4xx_hal_usart.h.

Referenced by HAL_USART_Abort_IT(), HAL_USART_RegisterCallback(), HAL_USART_UnRegisterCallback(), USART_DMARxAbortCallback(), USART_DMATxAbortCallback(), and USART_InitCallbacksToDefault().

void(* __USART_HandleTypeDef::ErrorCallback)(struct __USART_HandleTypeDef *husart)

USART Error Callback

Definition at line 193 of file stm32l4xx_hal_usart.h.

Referenced by HAL_USART_IRQHandler(), HAL_USART_RegisterCallback(), HAL_USART_UnRegisterCallback(), USART_DMAAbortOnError(), USART_DMAError(), and USART_InitCallbacksToDefault().

DMA_HandleTypeDef* __USART_HandleTypeDef::hdmarx

USART Rx DMA Handle parameters

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

DMA_HandleTypeDef* __USART_HandleTypeDef::hdmatx

USART Tx DMA Handle parameters

Definition at line 177 of file stm32l4xx_hal_usart.h.

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

USART_InitTypeDef __USART_HandleTypeDef::Init

USART communication parameters

Definition at line 141 of file stm32l4xx_hal_usart.h.

Referenced by HAL_USART_Receive(), HAL_USART_Receive_IT(), HAL_USART_Transmit(), HAL_USART_Transmit_IT(), HAL_USART_TransmitReceive(), HAL_USART_TransmitReceive_IT(), and USART_SetConfig().

HAL_LockTypeDef __USART_HandleTypeDef::Lock

Locking object

Definition at line 181 of file stm32l4xx_hal_usart.h.

Referenced by HAL_USART_Init().

uint16_t __USART_HandleTypeDef::Mask

USART Rx RDR register mask

Definition at line 155 of file stm32l4xx_hal_usart.h.

Referenced by HAL_USART_Receive(), HAL_USART_TransmitReceive(), USART_RxISR_16BIT(), and USART_RxISR_8BIT().

void(* __USART_HandleTypeDef::MspDeInitCallback)(struct __USART_HandleTypeDef *husart)

USART Msp DeInit callback

Definition at line 201 of file stm32l4xx_hal_usart.h.

Referenced by HAL_USART_DeInit(), HAL_USART_RegisterCallback(), and HAL_USART_UnRegisterCallback().

void(* __USART_HandleTypeDef::MspInitCallback)(struct __USART_HandleTypeDef *husart)

USART Msp Init callback

Definition at line 200 of file stm32l4xx_hal_usart.h.

Referenced by HAL_USART_Init(), HAL_USART_RegisterCallback(), and HAL_USART_UnRegisterCallback().

uint8_t* __USART_HandleTypeDef::pRxBuffPtr

Pointer to USART Rx transfer Buffer

Definition at line 149 of file stm32l4xx_hal_usart.h.

Referenced by HAL_USART_Receive_DMA(), HAL_USART_Receive_IT(), HAL_USART_TransmitReceive_DMA(), HAL_USART_TransmitReceive_IT(), USART_RxISR_16BIT(), and USART_RxISR_8BIT().

uint8_t* __USART_HandleTypeDef::pTxBuffPtr

Pointer to USART Tx transfer Buffer

Definition at line 143 of file stm32l4xx_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_TxISR_16BIT(), and USART_TxISR_8BIT().

void(* __USART_HandleTypeDef::RxCpltCallback)(struct __USART_HandleTypeDef *husart)

USART Rx Complete Callback

Definition at line 191 of file stm32l4xx_hal_usart.h.

Referenced by HAL_USART_RegisterCallback(), HAL_USART_UnRegisterCallback(), USART_DMAReceiveCplt(), USART_InitCallbacksToDefault(), USART_RxISR_16BIT(), and USART_RxISR_8BIT().

void(* __USART_HandleTypeDef::RxHalfCpltCallback)(struct __USART_HandleTypeDef *husart)

USART Rx Half Complete Callback

Definition at line 190 of file stm32l4xx_hal_usart.h.

Referenced by HAL_USART_RegisterCallback(), HAL_USART_UnRegisterCallback(), USART_DMARxHalfCplt(), and USART_InitCallbacksToDefault().

void(* __USART_HandleTypeDef::RxISR)(struct __USART_HandleTypeDef *husart)

Function pointer on Rx IRQ handler

Definition at line 173 of file stm32l4xx_hal_usart.h.

Referenced by HAL_USART_IRQHandler(), HAL_USART_Receive_IT(), HAL_USART_TransmitReceive_IT(), USART_RxISR_16BIT(), USART_RxISR_8BIT(), and USART_SetConfig().

__IO uint16_t __USART_HandleTypeDef::RxXferCount

USART Rx Transfer Counter

Definition at line 153 of file stm32l4xx_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_EndTransmit_IT(), USART_RxISR_16BIT(), and USART_RxISR_8BIT().

uint16_t __USART_HandleTypeDef::RxXferSize

USART Rx Transfer size

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

__IO HAL_USART_StateTypeDef __USART_HandleTypeDef::State

USART communication state

Definition at line 183 of file stm32l4xx_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_GetState(), HAL_USART_Init(), HAL_USART_IRQHandler(), HAL_USART_Receive(), HAL_USART_Receive_DMA(), HAL_USART_Receive_IT(), HAL_USART_RegisterCallback(), HAL_USART_Transmit(), HAL_USART_Transmit_DMA(), HAL_USART_Transmit_IT(), HAL_USART_TransmitReceive(), HAL_USART_TransmitReceive_DMA(), HAL_USART_TransmitReceive_IT(), HAL_USART_UnRegisterCallback(), USART_CheckIdleState(), USART_DMAError(), USART_DMAReceiveCplt(), USART_DMARxAbortCallback(), USART_DMATransmitCplt(), USART_DMATxAbortCallback(), USART_EndTransfer(), USART_EndTransmit_IT(), USART_RxISR_16BIT(), USART_RxISR_8BIT(), USART_TxISR_16BIT(), USART_TxISR_8BIT(), and USART_WaitOnFlagUntilTimeout().

void(* __USART_HandleTypeDef::TxCpltCallback)(struct __USART_HandleTypeDef *husart)

USART Tx Complete Callback

Definition at line 189 of file stm32l4xx_hal_usart.h.

Referenced by HAL_USART_RegisterCallback(), HAL_USART_UnRegisterCallback(), USART_DMATransmitCplt(), USART_EndTransmit_IT(), and USART_InitCallbacksToDefault().

void(* __USART_HandleTypeDef::TxHalfCpltCallback)(struct __USART_HandleTypeDef *husart)

USART Tx Half Complete Callback

Definition at line 188 of file stm32l4xx_hal_usart.h.

Referenced by HAL_USART_RegisterCallback(), HAL_USART_UnRegisterCallback(), USART_DMATxHalfCplt(), and USART_InitCallbacksToDefault().

void(* __USART_HandleTypeDef::TxISR)(struct __USART_HandleTypeDef *husart)

Function pointer on Tx IRQ handler

Definition at line 175 of file stm32l4xx_hal_usart.h.

Referenced by HAL_USART_IRQHandler(), HAL_USART_Transmit_IT(), HAL_USART_TransmitReceive_IT(), USART_EndTransmit_IT(), and USART_SetConfig().

void(* __USART_HandleTypeDef::TxRxCpltCallback)(struct __USART_HandleTypeDef *husart)

USART Tx Rx Complete Callback

Definition at line 192 of file stm32l4xx_hal_usart.h.

Referenced by HAL_USART_RegisterCallback(), HAL_USART_UnRegisterCallback(), USART_DMAReceiveCplt(), USART_EndTransmit_IT(), USART_InitCallbacksToDefault(), USART_RxISR_16BIT(), and USART_RxISR_8BIT().

__IO uint16_t __USART_HandleTypeDef::TxXferCount

USART Tx Transfer Counter

Definition at line 147 of file stm32l4xx_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_RxISR_16BIT(), USART_RxISR_8BIT(), USART_TxISR_16BIT(), and USART_TxISR_8BIT().

uint16_t __USART_HandleTypeDef::TxXferSize

USART Tx Transfer size

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

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

stm32l4xx_hal_usart.h