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.
uint32_t	HAL_UART_GetError (const UART_HandleTypeDef *huart)
	Return the UART error code.

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_GetState()

HAL_UART_StateTypeDef HAL_UART_GetState

(

const UART_HandleTypeDef *

huart

)

#include <stm32f4xx_hal_uart.h>

Returns the UART state.

Parameters

huart

Pointer to a UART_HandleTypeDef structure that contains the configuration information for the specified UART module.

Return values

HAL

state

Definition at line 2928 of file stm32f4xx_hal_uart.c.

References __UART_HandleTypeDef::gState, and __UART_HandleTypeDef::RxState.

HAL_UART_GetError()

uint32_t HAL_UART_GetError

(

const UART_HandleTypeDef *

huart

)

#include <stm32f4xx_hal_uart.h>

Return the UART error code.

Parameters

huart

Pointer to a UART_HandleTypeDef structure that contains the configuration information for the specified UART.

Return values

UART	Error Code

Definition at line 2943 of file stm32f4xx_hal_uart.c.

References __UART_HandleTypeDef::ErrorCode.