Initialization and de-initialization functions

Initialization and Configuration functions. More...

Collaboration diagram for Initialization and de-initialization functions:

Functions
HAL_StatusTypeDef	HAL_CAN_Init (CAN_HandleTypeDef *hcan)
	Initializes the CAN peripheral according to the specified parameters in the CAN_InitStruct. More...
HAL_StatusTypeDef	HAL_CAN_DeInit (CAN_HandleTypeDef *hcan)
	Deinitializes the CAN peripheral registers to their default reset values. More...
void	HAL_CAN_MspInit (CAN_HandleTypeDef *hcan)
	Initializes the CAN MSP. More...
void	HAL_CAN_MspDeInit (CAN_HandleTypeDef *hcan)
	DeInitializes the CAN MSP. More...
HAL_StatusTypeDef	HAL_CAN_RegisterCallback (CAN_HandleTypeDef *hcan, HAL_CAN_CallbackIDTypeDef CallbackID, void(*pCallback)(CAN_HandleTypeDef *_hcan))
	Register a CAN CallBack. To be used instead of the weak predefined callback. More...
HAL_StatusTypeDef	HAL_CAN_UnRegisterCallback (CAN_HandleTypeDef *hcan, HAL_CAN_CallbackIDTypeDef CallbackID)
	Unregister a CAN CallBack. CAN callback is redirected to the weak predefined callback. More...

Detailed Description

Initialization and Configuration functions.

  ==============================================================================
              ##### Initialization and de-initialization functions #####
  ==============================================================================
    [..]  This section provides functions allowing to:
      (+) HAL_CAN_Init                       : Initialize and configure the CAN.
      (+) HAL_CAN_DeInit                     : De-initialize the CAN.
      (+) HAL_CAN_MspInit                    : Initialize the CAN MSP.
      (+) HAL_CAN_MspDeInit                  : DeInitialize the CAN MSP.

Function Documentation

HAL_CAN_DeInit()

HAL_StatusTypeDef HAL_CAN_DeInit

(

CAN_HandleTypeDef *

hcan

)

Deinitializes the CAN peripheral registers to their default reset values.

Parameters

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

Return values

HAL

status

Definition at line 460 of file stm32f4xx_hal_can.c.

HAL_CAN_Init()

HAL_StatusTypeDef HAL_CAN_Init

(

CAN_HandleTypeDef *

hcan

)

Initializes the CAN peripheral according to the specified parameters in the CAN_InitStruct.

Parameters

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

Return values

HAL

status

Definition at line 275 of file stm32f4xx_hal_can.c.

HAL_CAN_MspDeInit()

__weak void HAL_CAN_MspDeInit

(

CAN_HandleTypeDef *

hcan

)

DeInitializes the CAN MSP.

Parameters

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

Return values

None

Definition at line 523 of file stm32f4xx_hal_can.c.

HAL_CAN_MspInit()

__weak void HAL_CAN_MspInit

(

CAN_HandleTypeDef *

hcan

)

Initializes the CAN MSP.

Parameters

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

Return values

None

Definition at line 507 of file stm32f4xx_hal_can.c.

HAL_CAN_RegisterCallback()

HAL_StatusTypeDef HAL_CAN_RegisterCallback	(	CAN_HandleTypeDef *	hcan,
		HAL_CAN_CallbackIDTypeDef	CallbackID,
		void(*)(CAN_HandleTypeDef *_hcan)	pCallback
	)

Register a CAN CallBack. To be used instead of the weak predefined callback.

Parameters

hcan	pointer to a CAN_HandleTypeDef structure that contains the configuration information for CAN module
CallbackID	ID of the callback to be registered This parameter can be one of the following values: HAL_CAN_TX_MAILBOX0_COMPLETE_CB_ID Tx Mailbox 0 Complete callback ID HAL_CAN_TX_MAILBOX1_COMPLETE_CB_ID Tx Mailbox 1 Complete callback ID HAL_CAN_TX_MAILBOX2_COMPLETE_CB_ID Tx Mailbox 2 Complete callback ID HAL_CAN_TX_MAILBOX0_ABORT_CB_ID Tx Mailbox 0 Abort callback ID HAL_CAN_TX_MAILBOX1_ABORT_CB_ID Tx Mailbox 1 Abort callback ID HAL_CAN_TX_MAILBOX2_ABORT_CB_ID Tx Mailbox 2 Abort callback ID HAL_CAN_RX_FIFO0_MSG_PENDING_CB_ID Rx Fifo 0 message pending callback ID HAL_CAN_RX_FIFO0_FULL_CB_ID Rx Fifo 0 full callback ID HAL_CAN_RX_FIFO1_MSG_PENDING_CB_ID Rx Fifo 1 message pending callback ID HAL_CAN_RX_FIFO1_FULL_CB_ID Rx Fifo 1 full callback ID HAL_CAN_SLEEP_CB_ID Sleep callback ID HAL_CAN_WAKEUP_FROM_RX_MSG_CB_ID Wake Up from Rx message callback ID HAL_CAN_ERROR_CB_ID Error callback ID HAL_CAN_MSPINIT_CB_ID MspInit callback ID HAL_CAN_MSPDEINIT_CB_ID MspDeInit callback ID
pCallback	pointer to the Callback function

Return values

HAL

status

Definition at line 559 of file stm32f4xx_hal_can.c.

HAL_CAN_UnRegisterCallback()

HAL_StatusTypeDef HAL_CAN_UnRegisterCallback	(	CAN_HandleTypeDef *	hcan,
		HAL_CAN_CallbackIDTypeDef	CallbackID
	)

Unregister a CAN CallBack. CAN callback is redirected to the weak predefined callback.

Parameters

hcan

pointer to a CAN_HandleTypeDef structure that contains the configuration information for CAN module

CallbackID

ID of the callback to be unregistered This parameter can be one of the following values: HAL_CAN_TX_MAILBOX0_COMPLETE_CB_ID Tx Mailbox 0 Complete callback ID HAL_CAN_TX_MAILBOX1_COMPLETE_CB_ID Tx Mailbox 1 Complete callback ID HAL_CAN_TX_MAILBOX2_COMPLETE_CB_ID Tx Mailbox 2 Complete callback ID HAL_CAN_TX_MAILBOX0_ABORT_CB_ID Tx Mailbox 0 Abort callback ID HAL_CAN_TX_MAILBOX1_ABORT_CB_ID Tx Mailbox 1 Abort callback ID HAL_CAN_TX_MAILBOX2_ABORT_CB_ID Tx Mailbox 2 Abort callback ID HAL_CAN_RX_FIFO0_MSG_PENDING_CB_ID Rx Fifo 0 message pending callback ID HAL_CAN_RX_FIFO0_FULL_CB_ID Rx Fifo 0 full callback ID HAL_CAN_RX_FIFO1_MSG_PENDING_CB_ID Rx Fifo 1 message pending callback ID HAL_CAN_RX_FIFO1_FULL_CB_ID Rx Fifo 1 full callback ID HAL_CAN_SLEEP_CB_ID Sleep callback ID HAL_CAN_WAKEUP_FROM_RX_MSG_CB_ID Wake Up from Rx message callback ID HAL_CAN_ERROR_CB_ID Error callback ID HAL_CAN_MSPINIT_CB_ID MspInit callback ID HAL_CAN_MSPDEINIT_CB_ID MspDeInit callback ID

Return values

HAL

status

Definition at line 702 of file stm32f4xx_hal_can.c.