STM32F4xx_HAL_Driver  1.8.3
Peripheral State and Error functions

CAN Peripheral State functions. More...

+ Collaboration diagram for Peripheral State and Error functions:

Functions

HAL_CAN_StateTypeDef HAL_CAN_GetState (const CAN_HandleTypeDef *hcan)
 Return the CAN state. More...
 
uint32_t HAL_CAN_GetError (const 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 ( const CAN_HandleTypeDef hcan)

Return the CAN error code.

Parameters
hcanpointer to a CAN_HandleTypeDef structure that contains the configuration information for the specified CAN.
Return values
CANError Code

Definition at line 2411 of file stm32f4xx_hal_can.c.

◆ HAL_CAN_GetState()

HAL_CAN_StateTypeDef HAL_CAN_GetState ( const CAN_HandleTypeDef hcan)

Return the CAN state.

Parameters
hcanpointer to a CAN_HandleTypeDef structure that contains the configuration information for the specified CAN.
Return values
HALstate

Definition at line 2376 of file stm32f4xx_hal_can.c.

◆ HAL_CAN_ResetError()

HAL_StatusTypeDef HAL_CAN_ResetError ( CAN_HandleTypeDef hcan)

Reset the CAN error code.

Parameters
hcanpointer to a CAN_HandleTypeDef structure that contains the configuration information for the specified CAN.
Return values
HALstatus

Definition at line 2423 of file stm32f4xx_hal_can.c.