Initialization and de-initialization functions

Initialization and Configuration functions. More...

Functions
HAL_StatusTypeDef	HAL_CAN_Init (CAN_HandleTypeDef *hcan)
	Initializes the CAN peripheral according to the specified parameters in the CAN_InitStruct.
HAL_StatusTypeDef	HAL_CAN_DeInit (CAN_HandleTypeDef *hcan)
	Deinitializes the CAN peripheral registers to their default reset values.
__weak void	HAL_CAN_MspInit (CAN_HandleTypeDef *hcan)
	Initializes the CAN MSP.
__weak void	HAL_CAN_MspDeInit (CAN_HandleTypeDef *hcan)
	DeInitializes the CAN MSP.
HAL_StatusTypeDef	HAL_CAN_RegisterCallback (CAN_HandleTypeDef *hcan, HAL_CAN_CallbackIDTypeDef CallbackID, void(*pCallback)(CAN_HandleTypeDef *_hcan))
	Register a CAN CallBack.
HAL_StatusTypeDef	HAL_CAN_UnRegisterCallback (CAN_HandleTypeDef *hcan, HAL_CAN_CallbackIDTypeDef CallbackID)
	Unregister a CAN CallBack.

---

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_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 459 of file stm32f4xx_hal_can.c.

References assert_param, __CAN_HandleTypeDef::ErrorCode, HAL_CAN_ERROR_NONE, HAL_CAN_MspDeInit(), HAL_CAN_STATE_RESET, HAL_CAN_Stop(), __CAN_HandleTypeDef::Instance, __CAN_HandleTypeDef::MspDeInitCallback, and __CAN_HandleTypeDef::State.

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 274 of file stm32f4xx_hal_can.c.

References assert_param, CAN_InitTypeDef::AutoBusOff, CAN_InitTypeDef::AutoRetransmission, CAN_InitTypeDef::AutoWakeUp, CAN_TIMEOUT_VALUE, __CAN_HandleTypeDef::ErrorCallback, __CAN_HandleTypeDef::ErrorCode, HAL_CAN_ERROR_NONE, HAL_CAN_ERROR_TIMEOUT, HAL_CAN_ErrorCallback(), HAL_CAN_MspInit(), HAL_CAN_RxFifo0FullCallback(), HAL_CAN_RxFifo0MsgPendingCallback(), HAL_CAN_RxFifo1FullCallback(), HAL_CAN_RxFifo1MsgPendingCallback(), HAL_CAN_SleepCallback(), HAL_CAN_STATE_ERROR, HAL_CAN_STATE_READY, HAL_CAN_STATE_RESET, HAL_CAN_TxMailbox0AbortCallback(), HAL_CAN_TxMailbox0CompleteCallback(), HAL_CAN_TxMailbox1AbortCallback(), HAL_CAN_TxMailbox1CompleteCallback(), HAL_CAN_TxMailbox2AbortCallback(), HAL_CAN_TxMailbox2CompleteCallback(), HAL_CAN_WakeUpFromRxMsgCallback(), HAL_GetTick(), __CAN_HandleTypeDef::Init, __CAN_HandleTypeDef::Instance, IS_CAN_BS1, IS_CAN_BS2, IS_CAN_MODE, IS_CAN_PRESCALER, IS_CAN_SJW, CAN_InitTypeDef::Mode, __CAN_HandleTypeDef::MspInitCallback, CAN_InitTypeDef::Prescaler, CAN_InitTypeDef::ReceiveFifoLocked, __CAN_HandleTypeDef::RxFifo0FullCallback, __CAN_HandleTypeDef::RxFifo0MsgPendingCallback, __CAN_HandleTypeDef::RxFifo1FullCallback, __CAN_HandleTypeDef::RxFifo1MsgPendingCallback, __CAN_HandleTypeDef::SleepCallback, __CAN_HandleTypeDef::State, CAN_InitTypeDef::SyncJumpWidth, CAN_InitTypeDef::TimeSeg1, CAN_InitTypeDef::TimeSeg2, CAN_InitTypeDef::TimeTriggeredMode, CAN_InitTypeDef::TransmitFifoPriority, __CAN_HandleTypeDef::TxMailbox0AbortCallback, __CAN_HandleTypeDef::TxMailbox0CompleteCallback, __CAN_HandleTypeDef::TxMailbox1AbortCallback, __CAN_HandleTypeDef::TxMailbox1CompleteCallback, __CAN_HandleTypeDef::TxMailbox2AbortCallback, __CAN_HandleTypeDef::TxMailbox2CompleteCallback, and __CAN_HandleTypeDef::WakeUpFromRxMsgCallback.

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 522 of file stm32f4xx_hal_can.c.

Referenced by HAL_CAN_DeInit(), and HAL_CAN_UnRegisterCallback().

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 506 of file stm32f4xx_hal_can.c.

Referenced by HAL_CAN_Init(), and HAL_CAN_UnRegisterCallback().

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 558 of file stm32f4xx_hal_can.c.

References __CAN_HandleTypeDef::ErrorCallback, __CAN_HandleTypeDef::ErrorCode, HAL_CAN_ERROR_CB_ID, HAL_CAN_ERROR_INVALID_CALLBACK, HAL_CAN_MSPDEINIT_CB_ID, HAL_CAN_MSPINIT_CB_ID, HAL_CAN_RX_FIFO0_FULL_CB_ID, HAL_CAN_RX_FIFO0_MSG_PENDING_CB_ID, HAL_CAN_RX_FIFO1_FULL_CB_ID, HAL_CAN_RX_FIFO1_MSG_PENDING_CB_ID, HAL_CAN_SLEEP_CB_ID, HAL_CAN_STATE_READY, HAL_CAN_STATE_RESET, HAL_CAN_TX_MAILBOX0_ABORT_CB_ID, HAL_CAN_TX_MAILBOX0_COMPLETE_CB_ID, HAL_CAN_TX_MAILBOX1_ABORT_CB_ID, HAL_CAN_TX_MAILBOX1_COMPLETE_CB_ID, HAL_CAN_TX_MAILBOX2_ABORT_CB_ID, HAL_CAN_TX_MAILBOX2_COMPLETE_CB_ID, HAL_CAN_WAKEUP_FROM_RX_MSG_CB_ID, __CAN_HandleTypeDef::MspDeInitCallback, __CAN_HandleTypeDef::MspInitCallback, __CAN_HandleTypeDef::RxFifo0FullCallback, __CAN_HandleTypeDef::RxFifo0MsgPendingCallback, __CAN_HandleTypeDef::RxFifo1FullCallback, __CAN_HandleTypeDef::RxFifo1MsgPendingCallback, __CAN_HandleTypeDef::SleepCallback, __CAN_HandleTypeDef::State, __CAN_HandleTypeDef::TxMailbox0AbortCallback, __CAN_HandleTypeDef::TxMailbox0CompleteCallback, __CAN_HandleTypeDef::TxMailbox1AbortCallback, __CAN_HandleTypeDef::TxMailbox1CompleteCallback, __CAN_HandleTypeDef::TxMailbox2AbortCallback, __CAN_HandleTypeDef::TxMailbox2CompleteCallback, and __CAN_HandleTypeDef::WakeUpFromRxMsgCallback.

HAL_StatusTypeDef HAL_CAN_UnRegisterCallback	(	CAN_HandleTypeDef *	hcan,
		HAL_CAN_CallbackIDTypeDef	CallbackID
	)

Unregister a CAN CallBack.

CAN callabck 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 700 of file stm32f4xx_hal_can.c.

References __CAN_HandleTypeDef::ErrorCallback, __CAN_HandleTypeDef::ErrorCode, HAL_CAN_ERROR_CB_ID, HAL_CAN_ERROR_INVALID_CALLBACK, HAL_CAN_ErrorCallback(), HAL_CAN_MspDeInit(), HAL_CAN_MSPDEINIT_CB_ID, HAL_CAN_MspInit(), HAL_CAN_MSPINIT_CB_ID, HAL_CAN_RX_FIFO0_FULL_CB_ID, HAL_CAN_RX_FIFO0_MSG_PENDING_CB_ID, HAL_CAN_RX_FIFO1_FULL_CB_ID, HAL_CAN_RX_FIFO1_MSG_PENDING_CB_ID, HAL_CAN_RxFifo0FullCallback(), HAL_CAN_RxFifo0MsgPendingCallback(), HAL_CAN_RxFifo1FullCallback(), HAL_CAN_RxFifo1MsgPendingCallback(), HAL_CAN_SLEEP_CB_ID, HAL_CAN_SleepCallback(), HAL_CAN_STATE_READY, HAL_CAN_STATE_RESET, HAL_CAN_TX_MAILBOX0_ABORT_CB_ID, HAL_CAN_TX_MAILBOX0_COMPLETE_CB_ID, HAL_CAN_TX_MAILBOX1_ABORT_CB_ID, HAL_CAN_TX_MAILBOX1_COMPLETE_CB_ID, HAL_CAN_TX_MAILBOX2_ABORT_CB_ID, HAL_CAN_TX_MAILBOX2_COMPLETE_CB_ID, HAL_CAN_TxMailbox0AbortCallback(), HAL_CAN_TxMailbox0CompleteCallback(), HAL_CAN_TxMailbox1AbortCallback(), HAL_CAN_TxMailbox1CompleteCallback(), HAL_CAN_TxMailbox2AbortCallback(), HAL_CAN_TxMailbox2CompleteCallback(), HAL_CAN_WAKEUP_FROM_RX_MSG_CB_ID, HAL_CAN_WakeUpFromRxMsgCallback(), __CAN_HandleTypeDef::MspDeInitCallback, __CAN_HandleTypeDef::MspInitCallback, __CAN_HandleTypeDef::RxFifo0FullCallback, __CAN_HandleTypeDef::RxFifo0MsgPendingCallback, __CAN_HandleTypeDef::RxFifo1FullCallback, __CAN_HandleTypeDef::RxFifo1MsgPendingCallback, __CAN_HandleTypeDef::SleepCallback, __CAN_HandleTypeDef::State, __CAN_HandleTypeDef::TxMailbox0AbortCallback, __CAN_HandleTypeDef::TxMailbox0CompleteCallback, __CAN_HandleTypeDef::TxMailbox1AbortCallback, __CAN_HandleTypeDef::TxMailbox1CompleteCallback, __CAN_HandleTypeDef::TxMailbox2AbortCallback, __CAN_HandleTypeDef::TxMailbox2CompleteCallback, and __CAN_HandleTypeDef::WakeUpFromRxMsgCallback.