STM32F4xx_HAL_Driver  1.8.3
Peripheral State and Errors functions

UART State and Errors functions. More...

+ Collaboration diagram for Peripheral State and Errors functions:

Functions

HAL_UART_StateTypeDef HAL_UART_GetState (const UART_HandleTypeDef *huart)
 Returns the UART state. More...
 
uint32_t HAL_UART_GetError (const UART_HandleTypeDef *huart)
 Return the UART error code. More...
 

Detailed Description

UART State and Errors functions.

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

Function Documentation

◆ HAL_UART_GetError()

uint32_t HAL_UART_GetError ( const UART_HandleTypeDef huart)

Return the UART error code.

Parameters
huartPointer to a UART_HandleTypeDef structure that contains the configuration information for the specified UART.
Return values
UARTError Code

Definition at line 2943 of file stm32f4xx_hal_uart.c.

◆ HAL_UART_GetState()

HAL_UART_StateTypeDef HAL_UART_GetState ( const UART_HandleTypeDef huart)

Returns the UART state.

Parameters
huartPointer to a UART_HandleTypeDef structure that contains the configuration information for the specified UART module.
Return values
HALstate

Definition at line 2928 of file stm32f4xx_hal_uart.c.