Peripheral State and Error functions

IRDA State and Errors functions. More...

Functions
HAL_IRDA_StateTypeDef	HAL_IRDA_GetState (IRDA_HandleTypeDef *hirda)
	Return the IRDA handle state. More...
uint32_t	HAL_IRDA_GetError (IRDA_HandleTypeDef *hirda)
	Return the IRDA handle error code. More...

Detailed Description

IRDA State and Errors functions.

  ==============================================================================
            ##### Peripheral State and Error functions #####
  ==============================================================================
  [..]
    This subsection provides a set of functions allowing to return the State of IrDA
    communication process and also return Peripheral Errors occurred during communication process
     (+) HAL_IRDA_GetState() API can be helpful to check in run-time the state
         of the IRDA peripheral handle.
     (+) HAL_IRDA_GetError() checks in run-time errors that could occur during
         communication.

Function Documentation

HAL_IRDA_GetError()

uint32_t HAL_IRDA_GetError

(

IRDA_HandleTypeDef *

hirda

)

Return the IRDA handle error code.

Parameters

hirda

Pointer to a IRDA_HandleTypeDef structure that contains the configuration information for the specified IRDA module.

Return values

IRDA	Error Code

Definition at line 2232 of file stm32l4xx_hal_irda.c.

{
  return hirda->ErrorCode;
}

HAL_IRDA_GetState()

HAL_IRDA_StateTypeDef HAL_IRDA_GetState

(

IRDA_HandleTypeDef *

hirda

)

Return the IRDA handle state.

Parameters

hirda

Pointer to a IRDA_HandleTypeDef structure that contains the configuration information for the specified IRDA module.

Return values

HAL

state

Definition at line 2215 of file stm32l4xx_hal_irda.c.

{
  /* Return IRDA handle state */
  uint32_t temp1;
  uint32_t temp2;
  temp1 = (uint32_t)hirda->gState;
  temp2 = (uint32_t)hirda->RxState;

  return (HAL_IRDA_StateTypeDef)(temp1 | temp2);
}