stm32f4xx_hal_can.h File Reference

Header file of CAN HAL module. More...

Go to the source code of this file.

Data Structures
struct	CAN_InitTypeDef
	CAN init structure definition. More...
struct	CAN_FilterTypeDef
	CAN filter configuration structure definition. More...
struct	CAN_TxHeaderTypeDef
	CAN Tx message header structure definition. More...
struct	CAN_RxHeaderTypeDef
	CAN Rx message header structure definition. More...
struct	endif
	ADC handle Structure definition. More...

Typedefs
typedef struct __CAN_HandleTypeDef else typedef struct endif	CAN_HandleTypeDef
	CAN handle Structure definition.
typedef void(*	pCAN_CallbackTypeDef) (CAN_HandleTypeDef *hcan)
	HAL CAN Callback pointer definition. More...

Enumerations
enum	HAL_CAN_StateTypeDef {   HAL_CAN_STATE_RESET = 0x00U , HAL_CAN_STATE_READY = 0x01U , HAL_CAN_STATE_LISTENING = 0x02U , HAL_CAN_STATE_SLEEP_PENDING = 0x03U ,   HAL_CAN_STATE_SLEEP_ACTIVE = 0x04U , HAL_CAN_STATE_ERROR = 0x05U }
	HAL State structures definition. More...
enum	HAL_CAN_CallbackIDTypeDef {   HAL_CAN_TX_MAILBOX0_COMPLETE_CB_ID = 0x00U , HAL_CAN_TX_MAILBOX1_COMPLETE_CB_ID = 0x01U , HAL_CAN_TX_MAILBOX2_COMPLETE_CB_ID = 0x02U , HAL_CAN_TX_MAILBOX0_ABORT_CB_ID = 0x03U ,   HAL_CAN_TX_MAILBOX1_ABORT_CB_ID = 0x04U , HAL_CAN_TX_MAILBOX2_ABORT_CB_ID = 0x05U , HAL_CAN_RX_FIFO0_MSG_PENDING_CB_ID = 0x06U , HAL_CAN_RX_FIFO0_FULL_CB_ID = 0x07U ,   HAL_CAN_RX_FIFO1_MSG_PENDING_CB_ID = 0x08U , HAL_CAN_RX_FIFO1_FULL_CB_ID = 0x09U , HAL_CAN_SLEEP_CB_ID = 0x0AU , HAL_CAN_WAKEUP_FROM_RX_MSG_CB_ID = 0x0BU ,   HAL_CAN_ERROR_CB_ID = 0x0CU , HAL_CAN_MSPINIT_CB_ID = 0x0DU , HAL_CAN_MSPDEINIT_CB_ID = 0x0EU }
	HAL CAN common Callback ID enumeration definition. More...

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...
HAL_StatusTypeDef	HAL_CAN_ConfigFilter (CAN_HandleTypeDef *hcan, const CAN_FilterTypeDef *sFilterConfig)
	Configures the CAN reception filter according to the specified parameters in the CAN_FilterInitStruct. More...
HAL_StatusTypeDef	HAL_CAN_Start (CAN_HandleTypeDef *hcan)
	Start the CAN module. More...
HAL_StatusTypeDef	HAL_CAN_Stop (CAN_HandleTypeDef *hcan)
	Stop the CAN module and enable access to configuration registers. More...
HAL_StatusTypeDef	HAL_CAN_RequestSleep (CAN_HandleTypeDef *hcan)
	Request the sleep mode (low power) entry. When returning from this function, Sleep mode will be entered as soon as the current CAN activity (transmission or reception of a CAN frame) has been completed. More...
HAL_StatusTypeDef	HAL_CAN_WakeUp (CAN_HandleTypeDef *hcan)
	Wake up from sleep mode. When returning with HAL_OK status from this function, Sleep mode is exited. More...
uint32_t	HAL_CAN_IsSleepActive (const CAN_HandleTypeDef *hcan)
	Check is sleep mode is active. More...
HAL_StatusTypeDef	HAL_CAN_AddTxMessage (CAN_HandleTypeDef *hcan, const CAN_TxHeaderTypeDef *pHeader, const uint8_t aData[], uint32_t *pTxMailbox)
	Add a message to the first free Tx mailbox and activate the corresponding transmission request. More...
HAL_StatusTypeDef	HAL_CAN_AbortTxRequest (CAN_HandleTypeDef *hcan, uint32_t TxMailboxes)
	Abort transmission requests. More...
uint32_t	HAL_CAN_GetTxMailboxesFreeLevel (const CAN_HandleTypeDef *hcan)
	Return Tx Mailboxes free level: number of free Tx Mailboxes. More...
uint32_t	HAL_CAN_IsTxMessagePending (const CAN_HandleTypeDef *hcan, uint32_t TxMailboxes)
	Check if a transmission request is pending on the selected Tx Mailboxes. More...
uint32_t	HAL_CAN_GetTxTimestamp (const CAN_HandleTypeDef *hcan, uint32_t TxMailbox)
	Return timestamp of Tx message sent, if time triggered communication mode is enabled. More...
HAL_StatusTypeDef	HAL_CAN_GetRxMessage (CAN_HandleTypeDef *hcan, uint32_t RxFifo, CAN_RxHeaderTypeDef *pHeader, uint8_t aData[])
	Get an CAN frame from the Rx FIFO zone into the message RAM. More...
uint32_t	HAL_CAN_GetRxFifoFillLevel (const CAN_HandleTypeDef *hcan, uint32_t RxFifo)
	Return Rx FIFO fill level. More...
HAL_StatusTypeDef	HAL_CAN_ActivateNotification (CAN_HandleTypeDef *hcan, uint32_t ActiveITs)
	Enable interrupts. More...
HAL_StatusTypeDef	HAL_CAN_DeactivateNotification (CAN_HandleTypeDef *hcan, uint32_t InactiveITs)
	Disable interrupts. More...
void	HAL_CAN_IRQHandler (CAN_HandleTypeDef *hcan)
	Handles CAN interrupt request. More...
void	HAL_CAN_TxMailbox0CompleteCallback (CAN_HandleTypeDef *hcan)
	Transmission Mailbox 0 complete callback. More...
void	HAL_CAN_TxMailbox1CompleteCallback (CAN_HandleTypeDef *hcan)
	Transmission Mailbox 1 complete callback. More...
void	HAL_CAN_TxMailbox2CompleteCallback (CAN_HandleTypeDef *hcan)
	Transmission Mailbox 2 complete callback. More...
void	HAL_CAN_TxMailbox0AbortCallback (CAN_HandleTypeDef *hcan)
	Transmission Mailbox 0 Cancellation callback. More...
void	HAL_CAN_TxMailbox1AbortCallback (CAN_HandleTypeDef *hcan)
	Transmission Mailbox 1 Cancellation callback. More...
void	HAL_CAN_TxMailbox2AbortCallback (CAN_HandleTypeDef *hcan)
	Transmission Mailbox 2 Cancellation callback. More...
void	HAL_CAN_RxFifo0MsgPendingCallback (CAN_HandleTypeDef *hcan)
	Rx FIFO 0 message pending callback. More...
void	HAL_CAN_RxFifo0FullCallback (CAN_HandleTypeDef *hcan)
	Rx FIFO 0 full callback. More...
void	HAL_CAN_RxFifo1MsgPendingCallback (CAN_HandleTypeDef *hcan)
	Rx FIFO 1 message pending callback. More...
void	HAL_CAN_RxFifo1FullCallback (CAN_HandleTypeDef *hcan)
	Rx FIFO 1 full callback. More...
void	HAL_CAN_SleepCallback (CAN_HandleTypeDef *hcan)
	Sleep callback. More...
void	HAL_CAN_WakeUpFromRxMsgCallback (CAN_HandleTypeDef *hcan)
	WakeUp from Rx message callback. More...
void	HAL_CAN_ErrorCallback (CAN_HandleTypeDef *hcan)
	Error CAN callback. More...
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

Header file of CAN HAL module.

Author

MCD Application Team

Attention

Copyright (c) 2016 STMicroelectronics. All rights reserved.

This software is licensed under terms that can be found in the LICENSE file in the root directory of this software component. If no LICENSE file comes with this software, it is provided AS-IS.

Definition in file stm32f4xx_hal_can.h.