STM32F439xx HAL User Manual
Modules | Functions
USART Exported Functions
USART

Modules

 USART Initialization and de-initialization functions
 

Initialization and Configuration functions.


 IO operation functions
 

USART Transmit and Receive functions.


 Peripheral State and Errors functions
 

USART State and Errors functions.


Functions

static void USART_DMATransmitCplt (DMA_HandleTypeDef *hdma)
 DMA USART transmit process complete callback.
static void USART_DMATxHalfCplt (DMA_HandleTypeDef *hdma)
 DMA USART transmit process half complete callback.
static void USART_DMAReceiveCplt (DMA_HandleTypeDef *hdma)
 DMA USART receive process complete callback.
static void USART_DMARxHalfCplt (DMA_HandleTypeDef *hdma)
 DMA USART receive process half complete callback.
static void USART_DMAError (DMA_HandleTypeDef *hdma)
 DMA USART communication error callback.
static HAL_StatusTypeDef USART_WaitOnFlagUntilTimeout (USART_HandleTypeDef *husart, uint32_t Flag, FlagStatus Status, uint32_t Tickstart, uint32_t Timeout)
 This function handles USART Communication Timeout.
static void USART_EndTxTransfer (USART_HandleTypeDef *husart)
 End ongoing Tx transfer on USART peripheral (following error detection or Transmit completion).
static void USART_EndRxTransfer (USART_HandleTypeDef *husart)
 End ongoing Rx transfer on USART peripheral (following error detection or Reception completion).
static void USART_DMAAbortOnError (DMA_HandleTypeDef *hdma)
 DMA USART communication abort callback, when initiated by HAL services on Error (To be called at end of DMA Abort procedure following error occurrence).
static void USART_DMATxAbortCallback (DMA_HandleTypeDef *hdma)
 DMA USART Tx communication abort callback, when initiated by user (To be called at end of DMA Tx Abort procedure following user abort request).
static void USART_DMARxAbortCallback (DMA_HandleTypeDef *hdma)
 DMA USART Rx communication abort callback, when initiated by user (To be called at end of DMA Rx Abort procedure following user abort request).
static HAL_StatusTypeDef USART_Transmit_IT (USART_HandleTypeDef *husart)
 Simplex Send an amount of data in non-blocking mode.
static HAL_StatusTypeDef USART_EndTransmit_IT (USART_HandleTypeDef *husart)
 Wraps up transmission in non blocking mode.
static HAL_StatusTypeDef USART_Receive_IT (USART_HandleTypeDef *husart)
 Simplex Receive an amount of data in non-blocking mode.
static HAL_StatusTypeDef USART_TransmitReceive_IT (USART_HandleTypeDef *husart)
 Full-Duplex Send receive an amount of data in full-duplex mode (non-blocking).
static void USART_SetConfig (USART_HandleTypeDef *husart)
 Configures the USART pferipheral.

Function Documentation

static void USART_DMAAbortOnError ( DMA_HandleTypeDef hdma) [static]

DMA USART communication abort callback, when initiated by HAL services on Error (To be called at end of DMA Abort procedure following error occurrence).

Parameters:
hdmaDMA handle.
Return values:
None

Definition at line 1883 of file stm32f4xx_hal_usart.c.

References HAL_USART_ErrorCallback(), USART_HandleTypeDef::RxXferCount, and USART_HandleTypeDef::TxXferCount.

Referenced by HAL_USART_IRQHandler().

static void USART_DMAError ( DMA_HandleTypeDef hdma) [static]
static void USART_DMAReceiveCplt ( DMA_HandleTypeDef hdma) [static]
static void USART_DMARxAbortCallback ( DMA_HandleTypeDef hdma) [static]

DMA USART Rx communication abort callback, when initiated by user (To be called at end of DMA Rx Abort procedure following user abort request).

Note:
When this callback is executed, User Abort complete call back is called only if no Abort still ongoing for Tx DMA Handle.
Parameters:
hdmaDMA handle.
Return values:
None

Definition at line 1937 of file stm32f4xx_hal_usart.c.

References USART_HandleTypeDef::ErrorCode, HAL_USART_AbortCpltCallback(), HAL_USART_ERROR_NONE, HAL_USART_STATE_READY, USART_HandleTypeDef::hdmarx, USART_HandleTypeDef::hdmatx, USART_HandleTypeDef::RxXferCount, USART_HandleTypeDef::State, USART_HandleTypeDef::TxXferCount, and __DMA_HandleTypeDef::XferAbortCallback.

Referenced by HAL_USART_Abort_IT().

static void USART_DMARxHalfCplt ( DMA_HandleTypeDef hdma) [static]

DMA USART receive process half complete callback.

Parameters:
hdmapointer to a DMA_HandleTypeDef structure that contains the configuration information for the specified DMA module.
Return values:
None

Definition at line 1765 of file stm32f4xx_hal_usart.c.

References HAL_USART_RxHalfCpltCallback().

Referenced by HAL_USART_Receive_DMA(), and HAL_USART_TransmitReceive_DMA().

static void USART_DMATransmitCplt ( DMA_HandleTypeDef hdma) [static]

DMA USART transmit process complete callback.

Parameters:
hdmaDMA handle
Return values:
None

Definition at line 1669 of file stm32f4xx_hal_usart.c.

References HAL_USART_STATE_BUSY_TX, HAL_USART_TxCpltCallback(), USART_HandleTypeDef::Instance, __DMA_HandleTypeDef::Instance, USART_HandleTypeDef::State, and USART_HandleTypeDef::TxXferCount.

Referenced by HAL_USART_Transmit_DMA(), and HAL_USART_TransmitReceive_DMA().

static void USART_DMATxAbortCallback ( DMA_HandleTypeDef hdma) [static]

DMA USART Tx communication abort callback, when initiated by user (To be called at end of DMA Tx Abort procedure following user abort request).

Note:
When this callback is executed, User Abort complete call back is called only if no Abort still ongoing for Rx DMA Handle.
Parameters:
hdmaDMA handle.
Return values:
None

Definition at line 1900 of file stm32f4xx_hal_usart.c.

References USART_HandleTypeDef::ErrorCode, HAL_USART_AbortCpltCallback(), HAL_USART_ERROR_NONE, HAL_USART_STATE_READY, USART_HandleTypeDef::hdmarx, USART_HandleTypeDef::hdmatx, USART_HandleTypeDef::RxXferCount, USART_HandleTypeDef::State, USART_HandleTypeDef::TxXferCount, and __DMA_HandleTypeDef::XferAbortCallback.

Referenced by HAL_USART_Abort_IT().

static void USART_DMATxHalfCplt ( DMA_HandleTypeDef hdma) [static]

DMA USART transmit process half complete callback.

Parameters:
hdmapointer to a DMA_HandleTypeDef structure that contains the configuration information for the specified DMA module.
Return values:
None

Definition at line 1702 of file stm32f4xx_hal_usart.c.

References HAL_USART_TxHalfCpltCallback().

Referenced by HAL_USART_Transmit_DMA(), and HAL_USART_TransmitReceive_DMA().

static void USART_EndRxTransfer ( USART_HandleTypeDef husart) [static]

End ongoing Rx transfer on USART peripheral (following error detection or Reception completion).

Parameters:
husartUSART handle.
Return values:
None

Definition at line 1867 of file stm32f4xx_hal_usart.c.

References HAL_USART_STATE_READY, USART_HandleTypeDef::Instance, and USART_HandleTypeDef::State.

Referenced by HAL_USART_DMAStop(), HAL_USART_IRQHandler(), and USART_DMAError().

static HAL_StatusTypeDef USART_EndTransmit_IT ( USART_HandleTypeDef husart) [static]

Wraps up transmission in non blocking mode.

Parameters:
husartpointer to a USART_HandleTypeDef structure that contains the configuration information for the specified USART module.
Return values:
HALstatus

Definition at line 2019 of file stm32f4xx_hal_usart.c.

References HAL_USART_STATE_READY, HAL_USART_TxCpltCallback(), USART_HandleTypeDef::Instance, and USART_HandleTypeDef::State.

Referenced by HAL_USART_IRQHandler().

static void USART_EndTxTransfer ( USART_HandleTypeDef husart) [static]

End ongoing Tx transfer on USART peripheral (following error detection or Transmit completion).

Parameters:
husartUSART handle.
Return values:
None

Definition at line 1853 of file stm32f4xx_hal_usart.c.

References HAL_USART_STATE_READY, USART_HandleTypeDef::Instance, and USART_HandleTypeDef::State.

Referenced by HAL_USART_DMAStop(), and USART_DMAError().

static HAL_StatusTypeDef USART_Receive_IT ( USART_HandleTypeDef husart) [static]

Simplex Receive an amount of data in non-blocking mode.

Parameters:
husartpointer to a USART_HandleTypeDef structure that contains the configuration information for the specified USART module.
Return values:
HALstatus

Definition at line 2040 of file stm32f4xx_hal_usart.c.

References DUMMY_DATA, HAL_USART_RxCpltCallback(), HAL_USART_STATE_BUSY_RX, HAL_USART_STATE_READY, USART_HandleTypeDef::Init, USART_HandleTypeDef::Instance, USART_InitTypeDef::Parity, USART_HandleTypeDef::pRxBuffPtr, USART_HandleTypeDef::RxXferCount, USART_HandleTypeDef::State, USART_PARITY_NONE, USART_WORDLENGTH_9B, and USART_InitTypeDef::WordLength.

Referenced by HAL_USART_IRQHandler().

static void USART_SetConfig ( USART_HandleTypeDef husart) [static]
static HAL_StatusTypeDef USART_Transmit_IT ( USART_HandleTypeDef husart) [static]

Simplex Send an amount of data in non-blocking mode.

Parameters:
husartpointer to a USART_HandleTypeDef structure that contains the configuration information for the specified USART module.
Return values:
HALstatus
Note:
The USART errors are not managed to avoid the overrun error.

Definition at line 1973 of file stm32f4xx_hal_usart.c.

References HAL_USART_STATE_BUSY_TX, USART_HandleTypeDef::Init, USART_HandleTypeDef::Instance, USART_InitTypeDef::Parity, USART_HandleTypeDef::pTxBuffPtr, USART_HandleTypeDef::State, USART_HandleTypeDef::TxXferCount, USART_PARITY_NONE, USART_WORDLENGTH_9B, and USART_InitTypeDef::WordLength.

Referenced by HAL_USART_IRQHandler().

static HAL_StatusTypeDef USART_TransmitReceive_IT ( USART_HandleTypeDef husart) [static]
static HAL_StatusTypeDef USART_WaitOnFlagUntilTimeout ( USART_HandleTypeDef husart,
uint32_t  Flag,
FlagStatus  Status,
uint32_t  Tickstart,
uint32_t  Timeout 
) [static]

This function handles USART Communication Timeout.

Parameters:
husartpointer to a USART_HandleTypeDef structure that contains the configuration information for the specified USART module.
Flagspecifies the USART flag to check.
StatusThe new Flag status (SET or RESET).
TickstartTick start value.
TimeoutTimeout duration.
Return values:
HALstatus

Definition at line 1814 of file stm32f4xx_hal_usart.c.

References __HAL_USART_GET_FLAG, HAL_GetTick(), HAL_USART_STATE_READY, USART_HandleTypeDef::Instance, and USART_HandleTypeDef::State.

Referenced by HAL_USART_Receive(), HAL_USART_Transmit(), and HAL_USART_TransmitReceive().