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.
uint32_t	HAL_USART_GetError (const USART_HandleTypeDef *husart)
	Return the USART error code.

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

HAL_USART_StateTypeDef HAL_USART_GetState

(

const USART_HandleTypeDef *

husart

)

#include <stm32f4xx_hal_usart.h>

Returns the USART state.

Parameters

husart

Pointer to a USART_HandleTypeDef structure that contains the configuration information for the specified USART module.

Return values

HAL

state

Definition at line 2071 of file stm32f4xx_hal_usart.c.

References __USART_HandleTypeDef::State.

HAL_USART_GetError()

uint32_t HAL_USART_GetError

(

const USART_HandleTypeDef *

husart

)

#include <stm32f4xx_hal_usart.h>

Return the USART error code.

Parameters

husart

Pointer to a USART_HandleTypeDef structure that contains the configuration information for the specified USART.

Return values

USART

Error Code

Definition at line 2082 of file stm32f4xx_hal_usart.c.

References __USART_HandleTypeDef::ErrorCode.