STM32F103xB HAL User Manual
Functions
USART Private Functions
USART Exported Functions | USART

Functions

void USART_InitCallbacksToDefault (USART_HandleTypeDef *husart)
 Initialize the callbacks to their default values.
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)
 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 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.

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 2364 of file stm32f1xx_hal_usart.c.

References __USART_HandleTypeDef::ErrorCallback, 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]

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 2159 of file stm32f1xx_hal_usart.c.

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

Referenced by HAL_USART_Receive_DMA(), and HAL_USART_TransmitReceive_DMA().

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 2430 of file stm32f1xx_hal_usart.c.

References __USART_HandleTypeDef::AbortCpltCallback, __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 2233 of file stm32f1xx_hal_usart.c.

References HAL_USART_RxHalfCpltCallback(), and __USART_HandleTypeDef::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:
hdmaPointer to a DMA_HandleTypeDef structure that contains the configuration information for the specified DMA module.
Return values:
None

Definition at line 2101 of file stm32f1xx_hal_usart.c.

References HAL_USART_STATE_BUSY_TX, HAL_USART_TxCpltCallback(), __USART_HandleTypeDef::Instance, __DMA_HandleTypeDef::Instance, __USART_HandleTypeDef::State, __USART_HandleTypeDef::TxCpltCallback, 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 2387 of file stm32f1xx_hal_usart.c.

References __USART_HandleTypeDef::AbortCpltCallback, __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 2140 of file stm32f1xx_hal_usart.c.

References HAL_USART_TxHalfCpltCallback(), and __USART_HandleTypeDef::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 2348 of file stm32f1xx_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 2511 of file stm32f1xx_hal_usart.c.

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

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 2334 of file stm32f1xx_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 2538 of file stm32f1xx_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::RxCpltCallback, __USART_HandleTypeDef::RxXferCount, __USART_HandleTypeDef::State, USART_PARITY_NONE, USART_WORDLENGTH_8B, 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 2472 of file stm32f1xx_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 2295 of file stm32f1xx_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().