Peripheral State and Error functions

CAN Peripheral State functions. More...

Functions
HAL_CAN_StateTypeDef	HAL_CAN_GetState (CAN_HandleTypeDef *hcan)
	Return the CAN state. More...
uint32_t	HAL_CAN_GetError (CAN_HandleTypeDef *hcan)
	Return the CAN error code. More...
HAL_StatusTypeDef	HAL_CAN_ResetError (CAN_HandleTypeDef *hcan)
	Reset the CAN error code. More...

Detailed Description

CAN Peripheral State functions.

  ==============================================================================
            ##### Peripheral State and Error functions #####
  ==============================================================================
    [..]
    This subsection provides functions allowing to :
      (+) HAL_CAN_GetState()  : Return the CAN state.
      (+) HAL_CAN_GetError()  : Return the CAN error codes if any.
      (+) HAL_CAN_ResetError(): Reset the CAN error codes if any.

Function Documentation

HAL_CAN_GetError()

uint32_t HAL_CAN_GetError

(

CAN_HandleTypeDef *

hcan

)

Return the CAN error code.

Parameters

hcan	pointer to a CAN_HandleTypeDef structure that contains the configuration information for the specified CAN.

Return values

CAN	Error Code

Definition at line 2381 of file stm32l4xx_hal_can.c.

{
  /* Return CAN error code */
  return hcan->ErrorCode;
}

HAL_CAN_GetState()

HAL_CAN_StateTypeDef HAL_CAN_GetState

(

CAN_HandleTypeDef *

hcan

)

Return the CAN state.

Parameters

hcan	pointer to a CAN_HandleTypeDef structure that contains the configuration information for the specified CAN.

Return values

HAL

state

Definition at line 2346 of file stm32l4xx_hal_can.c.

{
  HAL_CAN_StateTypeDef state = hcan->State;

  if ((state == HAL_CAN_STATE_READY) ||
      (state == HAL_CAN_STATE_LISTENING))
  {
    /* Check sleep mode acknowledge flag */
    if ((hcan->Instance->MSR & CAN_MSR_SLAK) != 0U)
    {
      /* Sleep mode is active */
      state = HAL_CAN_STATE_SLEEP_ACTIVE;
    }
    /* Check sleep mode request flag */
    else if ((hcan->Instance->MCR & CAN_MCR_SLEEP) != 0U)
    {
      /* Sleep mode request is pending */
      state = HAL_CAN_STATE_SLEEP_PENDING;
    }
    else
    {
      /* Neither sleep mode request nor sleep mode acknowledge */
    }
  }

  /* Return CAN state */
  return state;
}

HAL_CAN_ResetError()

HAL_StatusTypeDef HAL_CAN_ResetError

(

CAN_HandleTypeDef *

hcan

)

Reset the CAN error code.

Parameters

hcan	pointer to a CAN_HandleTypeDef structure that contains the configuration information for the specified CAN.

Return values

HAL

status

Definition at line 2393 of file stm32l4xx_hal_can.c.

{
  HAL_StatusTypeDef status = HAL_OK;
  HAL_CAN_StateTypeDef state = hcan->State;

  if ((state == HAL_CAN_STATE_READY) ||
      (state == HAL_CAN_STATE_LISTENING))
  {
    /* Reset CAN error code */
    hcan->ErrorCode = 0U;
  }
  else
  {
    /* Update error code */
    hcan->ErrorCode |= HAL_CAN_ERROR_NOT_INITIALIZED;

    status = HAL_ERROR;
  }

  /* Return the status */
  return status;
}