STM32F4xx HAL Documentation
Hardware Abstraction Layer for STM32F4 familiy
Loading...
Searching...
No Matches
USART Private Functions
Collaboration diagram for USART Private Functions:

Functions

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 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 peripheral.
 
static void USART_DMATransmitCplt (DMA_HandleTypeDef *hdma)
 Initialize the callbacks to their default values.
 
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 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_WaitOnFlagUntilTimeout (USART_HandleTypeDef *husart, uint32_t Flag, FlagStatus Status, uint32_t Tickstart, uint32_t Timeout)
 This function handles USART Communication Timeout. It waits until a flag is no longer in the specified status.
 

Detailed Description

Function Documentation

◆ USART_EndTxTransfer()

static void USART_EndTxTransfer ( USART_HandleTypeDef * husart)
static

#include <stm32f4xx_hal_usart.c>

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

Parameters
husartUSART handle.
Return values
None

Definition at line 2358 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().

◆ USART_EndRxTransfer()

static void USART_EndRxTransfer ( USART_HandleTypeDef * husart)
static

#include <stm32f4xx_hal_usart.c>

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

Parameters
husartUSART handle.
Return values
None

Definition at line 2372 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().

◆ USART_Transmit_IT()

static HAL_StatusTypeDef USART_Transmit_IT ( USART_HandleTypeDef * husart)
static

#include <stm32f4xx_hal_usart.c>

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 2496 of file stm32f4xx_hal_usart.c.

References HAL_BUSY, HAL_OK, 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().

◆ USART_EndTransmit_IT()

static HAL_StatusTypeDef USART_EndTransmit_IT ( USART_HandleTypeDef * husart)
static

#include <stm32f4xx_hal_usart.c>

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 2535 of file stm32f4xx_hal_usart.c.

References HAL_OK, HAL_USART_STATE_READY, HAL_USART_TxCpltCallback(), __USART_HandleTypeDef::Instance, and __USART_HandleTypeDef::State.

Referenced by HAL_USART_IRQHandler().

◆ USART_Receive_IT()

static HAL_StatusTypeDef USART_Receive_IT ( USART_HandleTypeDef * husart)
static

#include <stm32f4xx_hal_usart.c>

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 2562 of file stm32f4xx_hal_usart.c.

References DUMMY_DATA, HAL_BUSY, HAL_OK, 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_8B, USART_WORDLENGTH_9B, and USART_InitTypeDef::WordLength.

Referenced by HAL_USART_IRQHandler().

◆ USART_TransmitReceive_IT()

static HAL_StatusTypeDef USART_TransmitReceive_IT ( USART_HandleTypeDef * husart)
static

◆ USART_SetConfig()

◆ USART_DMATransmitCplt()

static void USART_DMATransmitCplt ( DMA_HandleTypeDef * hdma)
static

#include <stm32f4xx_hal_usart.c>

Initialize the callbacks to their default values.

Parameters
husartUSART handle.
Return values
none

DMA USART transmit process 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 2123 of file stm32f4xx_hal_usart.c.

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

Referenced by HAL_USART_Transmit_DMA(), and HAL_USART_TransmitReceive_DMA().

◆ USART_DMATxHalfCplt()

static void USART_DMATxHalfCplt ( DMA_HandleTypeDef * hdma)
static

#include <stm32f4xx_hal_usart.c>

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 2162 of file stm32f4xx_hal_usart.c.

References HAL_USART_TxHalfCpltCallback().

Referenced by HAL_USART_Transmit_DMA(), and HAL_USART_TransmitReceive_DMA().

◆ USART_DMAReceiveCplt()

static void USART_DMAReceiveCplt ( DMA_HandleTypeDef * hdma)
static

#include <stm32f4xx_hal_usart.c>

DMA USART receive process 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 2181 of file stm32f4xx_hal_usart.c.

References HAL_USART_RxCpltCallback(), HAL_USART_STATE_BUSY_RX, HAL_USART_STATE_READY, HAL_USART_TxRxCpltCallback(), __DMA_HandleTypeDef::Instance, __USART_HandleTypeDef::Instance, __USART_HandleTypeDef::RxXferCount, and __USART_HandleTypeDef::State.

Referenced by HAL_USART_Receive_DMA(), and HAL_USART_TransmitReceive_DMA().

◆ USART_DMARxHalfCplt()

static void USART_DMARxHalfCplt ( DMA_HandleTypeDef * hdma)
static

#include <stm32f4xx_hal_usart.c>

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 2255 of file stm32f4xx_hal_usart.c.

References HAL_USART_RxHalfCpltCallback().

Referenced by HAL_USART_Receive_DMA(), and HAL_USART_TransmitReceive_DMA().

◆ USART_DMAError()

static void USART_DMAError ( DMA_HandleTypeDef * hdma)
static

◆ USART_DMAAbortOnError()

static void USART_DMAAbortOnError ( DMA_HandleTypeDef * hdma)
static

#include <stm32f4xx_hal_usart.c>

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 2388 of file stm32f4xx_hal_usart.c.

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

Referenced by HAL_USART_IRQHandler().

◆ USART_DMATxAbortCallback()

static void USART_DMATxAbortCallback ( DMA_HandleTypeDef * hdma)
static

#include <stm32f4xx_hal_usart.c>

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 2411 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().

◆ USART_DMARxAbortCallback()

static void USART_DMARxAbortCallback ( DMA_HandleTypeDef * hdma)
static

#include <stm32f4xx_hal_usart.c>

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 2454 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().

◆ USART_WaitOnFlagUntilTimeout()

static HAL_StatusTypeDef USART_WaitOnFlagUntilTimeout ( USART_HandleTypeDef * husart,
uint32_t Flag,
FlagStatus Status,
uint32_t Tickstart,
uint32_t Timeout )
static

#include <stm32f4xx_hal_usart.c>

This function handles USART Communication Timeout. It waits until a flag is no longer in the specified status.

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

Definition at line 2318 of file stm32f4xx_hal_usart.c.

References __HAL_UNLOCK, __HAL_USART_GET_FLAG, HAL_GetTick(), HAL_MAX_DELAY, HAL_OK, HAL_TIMEOUT, HAL_USART_STATE_READY, __USART_HandleTypeDef::Instance, and __USART_HandleTypeDef::State.

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