STM32F4xx_HAL_Driver  1.8.3
Peripheral State and Errors functions

USART State and Errors functions. More...

+ Collaboration diagram for Peripheral State and Errors functions:

Functions

HAL_USART_StateTypeDef HAL_USART_GetState (const USART_HandleTypeDef *husart)
 Returns the USART state. More...
 
uint32_t HAL_USART_GetError (const USART_HandleTypeDef *husart)
 Return the USART error code. More...
 

Detailed Description

USART State and Errors functions.

  ==============================================================================
                  ##### Peripheral State and Errors functions #####
  ==============================================================================
  [..]
    This subsection provides a set of functions allowing to return the State of
    USART communication
    process, return Peripheral Errors occurred during communication process
     (+) HAL_USART_GetState() API can be helpful to check in run-time the state
         of the USART peripheral.
     (+) HAL_USART_GetError() check in run-time errors that could be occurred during
         communication.

Function Documentation

◆ HAL_USART_GetError()

uint32_t HAL_USART_GetError ( const USART_HandleTypeDef husart)

Return the USART error code.

Parameters
husartPointer to a USART_HandleTypeDef structure that contains the configuration information for the specified USART.
Return values
USARTError Code

Definition at line 2082 of file stm32f4xx_hal_usart.c.

◆ HAL_USART_GetState()

HAL_USART_StateTypeDef HAL_USART_GetState ( const USART_HandleTypeDef husart)

Returns the USART state.

Parameters
husartPointer to a USART_HandleTypeDef structure that contains the configuration information for the specified USART module.
Return values
HALstate

Definition at line 2071 of file stm32f4xx_hal_usart.c.