Peripheral State and Errors functions

UART State and Errors functions. More...

Functions
HAL_UART_StateTypeDef	HAL_UART_GetState (UART_HandleTypeDef *huart)
	Returns the UART state.
uint32_t	HAL_UART_GetError (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

uint32_t HAL_UART_GetError

(

UART_HandleTypeDef *

huart

)

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 1978 of file stm32f4xx_hal_uart.c.

References UART_HandleTypeDef::ErrorCode.

HAL_UART_StateTypeDef HAL_UART_GetState

(

UART_HandleTypeDef *

huart

)

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 1963 of file stm32f4xx_hal_uart.c.

References UART_HandleTypeDef::gState, and UART_HandleTypeDef::RxState.