Arrow / Mbed OS DAPLink Reset
Embed: (wiki syntax)

« Back to documentation index

Peripheral State and Errors functions

Peripheral State and Errors functions
[USART Exported Functions]

USART State and Errors functions. More...

Functions

HAL_USART_StateTypeDef HAL_USART_GetState (USART_HandleTypeDef *husart)
 Returns the USART state.
uint32_t HAL_USART_GetError (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

uint32_t HAL_USART_GetError ( USART_HandleTypeDef *  husart )

Return the USART error code.

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

Definition at line 1364 of file stm32f1xx_hal_usart.c.

HAL_USART_StateTypeDef HAL_USART_GetState ( USART_HandleTypeDef *  husart )

Returns the USART state.

Parameters:
husart,:Pointer to a USART_HandleTypeDef structure that contains the configuration information for the specified USART module.
Return values:
HALstate

Definition at line 1353 of file stm32f1xx_hal_usart.c.