STM32F4xx HAL Driver master
STM32CubeF4 HAL / LL Drivers API Reference
Loading...
Searching...
No Matches
stm32f4xx_hal_can.h
Go to the documentation of this file.
1
18
19/* Define to prevent recursive inclusion -------------------------------------*/
20#ifndef STM32F4xx_HAL_CAN_H
21#define STM32F4xx_HAL_CAN_H
22
23#ifdef __cplusplus
24extern "C" {
25#endif
26
27/* Includes ------------------------------------------------------------------*/
28#include "stm32f4xx_hal_def.h"
29
33
34#if defined (CAN1)
38
39/* Exported types ------------------------------------------------------------*/
46typedef enum
47{
48 HAL_CAN_STATE_RESET = 0x00U,
49 HAL_CAN_STATE_READY = 0x01U,
50 HAL_CAN_STATE_LISTENING = 0x02U,
51 HAL_CAN_STATE_SLEEP_PENDING = 0x03U,
52 HAL_CAN_STATE_SLEEP_ACTIVE = 0x04U,
53 HAL_CAN_STATE_ERROR = 0x05U
54
55} HAL_CAN_StateTypeDef;
56
60typedef struct
61{
62 uint32_t Prescaler;
64
65 uint32_t Mode;
67
68 uint32_t SyncJumpWidth;
71
72 uint32_t TimeSeg1;
74
75 uint32_t TimeSeg2;
77
78 FunctionalState TimeTriggeredMode;
80
81 FunctionalState AutoBusOff;
83
84 FunctionalState AutoWakeUp;
86
87 FunctionalState AutoRetransmission;
89
90 FunctionalState ReceiveFifoLocked;
92
93 FunctionalState TransmitFifoPriority;
95
96} CAN_InitTypeDef;
97
101typedef struct
102{
103 uint32_t FilterIdHigh;
107
108 uint32_t FilterIdLow;
112
113 uint32_t FilterMaskIdHigh;
118
119 uint32_t FilterMaskIdLow;
124
125 uint32_t FilterFIFOAssignment;
127
128 uint32_t FilterBank;
133
134 uint32_t FilterMode;
136
137 uint32_t FilterScale;
139
140 uint32_t FilterActivation;
142
143 uint32_t SlaveStartFilterBank;
149
150} CAN_FilterTypeDef;
151
155typedef struct
156{
157 uint32_t StdId;
159
160 uint32_t ExtId;
162
163 uint32_t IDE;
165
166 uint32_t RTR;
168
169 uint32_t DLC;
171
172 FunctionalState TransmitGlobalTime;
177
178} CAN_TxHeaderTypeDef;
179
183typedef struct
184{
185 uint32_t StdId;
187
188 uint32_t ExtId;
190
191 uint32_t IDE;
193
194 uint32_t RTR;
196
197 uint32_t DLC;
199
200 uint32_t Timestamp;
203
204 uint32_t FilterMatchIndex;
206
207} CAN_RxHeaderTypeDef;
208
212#if USE_HAL_CAN_REGISTER_CALLBACKS == 1
213typedef struct __CAN_HandleTypeDef
214#else
215typedef struct
216#endif /* USE_HAL_CAN_REGISTER_CALLBACKS */
217{
218 CAN_TypeDef *Instance;
219
220 CAN_InitTypeDef Init;
221
222 __IO HAL_CAN_StateTypeDef State;
223
224 __IO uint32_t ErrorCode;
226
227#if USE_HAL_CAN_REGISTER_CALLBACKS == 1
228 void (* TxMailbox0CompleteCallback)(struct __CAN_HandleTypeDef *hcan);
229 void (* TxMailbox1CompleteCallback)(struct __CAN_HandleTypeDef *hcan);
230 void (* TxMailbox2CompleteCallback)(struct __CAN_HandleTypeDef *hcan);
231 void (* TxMailbox0AbortCallback)(struct __CAN_HandleTypeDef *hcan);
232 void (* TxMailbox1AbortCallback)(struct __CAN_HandleTypeDef *hcan);
233 void (* TxMailbox2AbortCallback)(struct __CAN_HandleTypeDef *hcan);
234 void (* RxFifo0MsgPendingCallback)(struct __CAN_HandleTypeDef *hcan);
235 void (* RxFifo0FullCallback)(struct __CAN_HandleTypeDef *hcan);
236 void (* RxFifo1MsgPendingCallback)(struct __CAN_HandleTypeDef *hcan);
237 void (* RxFifo1FullCallback)(struct __CAN_HandleTypeDef *hcan);
238 void (* SleepCallback)(struct __CAN_HandleTypeDef *hcan);
239 void (* WakeUpFromRxMsgCallback)(struct __CAN_HandleTypeDef *hcan);
240 void (* ErrorCallback)(struct __CAN_HandleTypeDef *hcan);
241
242 void (* MspInitCallback)(struct __CAN_HandleTypeDef *hcan);
243 void (* MspDeInitCallback)(struct __CAN_HandleTypeDef *hcan);
244
245#endif /* (USE_HAL_CAN_REGISTER_CALLBACKS) */
246} CAN_HandleTypeDef;
247
248#if USE_HAL_CAN_REGISTER_CALLBACKS == 1
252typedef enum
253{
254 HAL_CAN_TX_MAILBOX0_COMPLETE_CB_ID = 0x00U,
255 HAL_CAN_TX_MAILBOX1_COMPLETE_CB_ID = 0x01U,
256 HAL_CAN_TX_MAILBOX2_COMPLETE_CB_ID = 0x02U,
257 HAL_CAN_TX_MAILBOX0_ABORT_CB_ID = 0x03U,
258 HAL_CAN_TX_MAILBOX1_ABORT_CB_ID = 0x04U,
259 HAL_CAN_TX_MAILBOX2_ABORT_CB_ID = 0x05U,
260 HAL_CAN_RX_FIFO0_MSG_PENDING_CB_ID = 0x06U,
261 HAL_CAN_RX_FIFO0_FULL_CB_ID = 0x07U,
262 HAL_CAN_RX_FIFO1_MSG_PENDING_CB_ID = 0x08U,
263 HAL_CAN_RX_FIFO1_FULL_CB_ID = 0x09U,
264 HAL_CAN_SLEEP_CB_ID = 0x0AU,
265 HAL_CAN_WAKEUP_FROM_RX_MSG_CB_ID = 0x0BU,
266 HAL_CAN_ERROR_CB_ID = 0x0CU,
267
268 HAL_CAN_MSPINIT_CB_ID = 0x0DU,
269 HAL_CAN_MSPDEINIT_CB_ID = 0x0EU,
270
271} HAL_CAN_CallbackIDTypeDef;
272
276typedef void (*pCAN_CallbackTypeDef)(CAN_HandleTypeDef *hcan);
277
278#endif /* USE_HAL_CAN_REGISTER_CALLBACKS */
282
283/* Exported constants --------------------------------------------------------*/
284
288
292#define HAL_CAN_ERROR_NONE (0x00000000U)
293#define HAL_CAN_ERROR_EWG (0x00000001U)
294#define HAL_CAN_ERROR_EPV (0x00000002U)
295#define HAL_CAN_ERROR_BOF (0x00000004U)
296#define HAL_CAN_ERROR_STF (0x00000008U)
297#define HAL_CAN_ERROR_FOR (0x00000010U)
298#define HAL_CAN_ERROR_ACK (0x00000020U)
299#define HAL_CAN_ERROR_BR (0x00000040U)
300#define HAL_CAN_ERROR_BD (0x00000080U)
301#define HAL_CAN_ERROR_CRC (0x00000100U)
302#define HAL_CAN_ERROR_RX_FOV0 (0x00000200U)
303#define HAL_CAN_ERROR_RX_FOV1 (0x00000400U)
304#define HAL_CAN_ERROR_TX_ALST0 (0x00000800U)
305#define HAL_CAN_ERROR_TX_TERR0 (0x00001000U)
306#define HAL_CAN_ERROR_TX_ALST1 (0x00002000U)
307#define HAL_CAN_ERROR_TX_TERR1 (0x00004000U)
308#define HAL_CAN_ERROR_TX_ALST2 (0x00008000U)
309#define HAL_CAN_ERROR_TX_TERR2 (0x00010000U)
310#define HAL_CAN_ERROR_TIMEOUT (0x00020000U)
311#define HAL_CAN_ERROR_NOT_INITIALIZED (0x00040000U)
312#define HAL_CAN_ERROR_NOT_READY (0x00080000U)
313#define HAL_CAN_ERROR_NOT_STARTED (0x00100000U)
314#define HAL_CAN_ERROR_PARAM (0x00200000U)
315
316#if USE_HAL_CAN_REGISTER_CALLBACKS == 1
317#define HAL_CAN_ERROR_INVALID_CALLBACK (0x00400000U)
318#endif /* USE_HAL_CAN_REGISTER_CALLBACKS */
319#define HAL_CAN_ERROR_INTERNAL (0x00800000U)
320
324
328#define CAN_INITSTATUS_FAILED (0x00000000U)
329#define CAN_INITSTATUS_SUCCESS (0x00000001U)
333
337#define CAN_MODE_NORMAL (0x00000000U)
338#define CAN_MODE_LOOPBACK ((uint32_t)CAN_BTR_LBKM)
339#define CAN_MODE_SILENT ((uint32_t)CAN_BTR_SILM)
340#define CAN_MODE_SILENT_LOOPBACK ((uint32_t)(CAN_BTR_LBKM | CAN_BTR_SILM))
345
346
350#define CAN_SJW_1TQ (0x00000000U)
351#define CAN_SJW_2TQ ((uint32_t)CAN_BTR_SJW_0)
352#define CAN_SJW_3TQ ((uint32_t)CAN_BTR_SJW_1)
353#define CAN_SJW_4TQ ((uint32_t)CAN_BTR_SJW)
357
361#define CAN_BS1_1TQ (0x00000000U)
362#define CAN_BS1_2TQ ((uint32_t)CAN_BTR_TS1_0)
363#define CAN_BS1_3TQ ((uint32_t)CAN_BTR_TS1_1)
364#define CAN_BS1_4TQ ((uint32_t)(CAN_BTR_TS1_1 | CAN_BTR_TS1_0))
365#define CAN_BS1_5TQ ((uint32_t)CAN_BTR_TS1_2)
366#define CAN_BS1_6TQ ((uint32_t)(CAN_BTR_TS1_2 | CAN_BTR_TS1_0))
367#define CAN_BS1_7TQ ((uint32_t)(CAN_BTR_TS1_2 | CAN_BTR_TS1_1))
368#define CAN_BS1_8TQ ((uint32_t)(CAN_BTR_TS1_2 | CAN_BTR_TS1_1 | CAN_BTR_TS1_0))
369#define CAN_BS1_9TQ ((uint32_t)CAN_BTR_TS1_3)
370#define CAN_BS1_10TQ ((uint32_t)(CAN_BTR_TS1_3 | CAN_BTR_TS1_0))
371#define CAN_BS1_11TQ ((uint32_t)(CAN_BTR_TS1_3 | CAN_BTR_TS1_1))
372#define CAN_BS1_12TQ ((uint32_t)(CAN_BTR_TS1_3 | CAN_BTR_TS1_1 | CAN_BTR_TS1_0))
373#define CAN_BS1_13TQ ((uint32_t)(CAN_BTR_TS1_3 | CAN_BTR_TS1_2))
374#define CAN_BS1_14TQ ((uint32_t)(CAN_BTR_TS1_3 | CAN_BTR_TS1_2 | CAN_BTR_TS1_0))
375#define CAN_BS1_15TQ ((uint32_t)(CAN_BTR_TS1_3 | CAN_BTR_TS1_2 | CAN_BTR_TS1_1))
376#define CAN_BS1_16TQ ((uint32_t)CAN_BTR_TS1)
380
384#define CAN_BS2_1TQ (0x00000000U)
385#define CAN_BS2_2TQ ((uint32_t)CAN_BTR_TS2_0)
386#define CAN_BS2_3TQ ((uint32_t)CAN_BTR_TS2_1)
387#define CAN_BS2_4TQ ((uint32_t)(CAN_BTR_TS2_1 | CAN_BTR_TS2_0))
388#define CAN_BS2_5TQ ((uint32_t)CAN_BTR_TS2_2)
389#define CAN_BS2_6TQ ((uint32_t)(CAN_BTR_TS2_2 | CAN_BTR_TS2_0))
390#define CAN_BS2_7TQ ((uint32_t)(CAN_BTR_TS2_2 | CAN_BTR_TS2_1))
391#define CAN_BS2_8TQ ((uint32_t)CAN_BTR_TS2)
395
399#define CAN_FILTERMODE_IDMASK (0x00000000U)
400#define CAN_FILTERMODE_IDLIST (0x00000001U)
404
408#define CAN_FILTERSCALE_16BIT (0x00000000U)
409#define CAN_FILTERSCALE_32BIT (0x00000001U)
413
417#define CAN_FILTER_DISABLE (0x00000000U)
418#define CAN_FILTER_ENABLE (0x00000001U)
422
426#define CAN_FILTER_FIFO0 (0x00000000U)
427#define CAN_FILTER_FIFO1 (0x00000001U)
431
435#define CAN_ID_STD (0x00000000U)
436#define CAN_ID_EXT (0x00000004U)
440
444#define CAN_RTR_DATA (0x00000000U)
445#define CAN_RTR_REMOTE (0x00000002U)
449
453#define CAN_RX_FIFO0 (0x00000000U)
454#define CAN_RX_FIFO1 (0x00000001U)
458
462#define CAN_TX_MAILBOX0 (0x00000001U)
463#define CAN_TX_MAILBOX1 (0x00000002U)
464#define CAN_TX_MAILBOX2 (0x00000004U)
468
472/* Transmit Flags */
473#define CAN_FLAG_RQCP0 (0x00000500U)
474#define CAN_FLAG_TXOK0 (0x00000501U)
475#define CAN_FLAG_ALST0 (0x00000502U)
476#define CAN_FLAG_TERR0 (0x00000503U)
477#define CAN_FLAG_RQCP1 (0x00000508U)
478#define CAN_FLAG_TXOK1 (0x00000509U)
479#define CAN_FLAG_ALST1 (0x0000050AU)
480#define CAN_FLAG_TERR1 (0x0000050BU)
481#define CAN_FLAG_RQCP2 (0x00000510U)
482#define CAN_FLAG_TXOK2 (0x00000511U)
483#define CAN_FLAG_ALST2 (0x00000512U)
484#define CAN_FLAG_TERR2 (0x00000513U)
485#define CAN_FLAG_TME0 (0x0000051AU)
486#define CAN_FLAG_TME1 (0x0000051BU)
487#define CAN_FLAG_TME2 (0x0000051CU)
488#define CAN_FLAG_LOW0 (0x0000051DU)
489#define CAN_FLAG_LOW1 (0x0000051EU)
490#define CAN_FLAG_LOW2 (0x0000051FU)
491
492/* Receive Flags */
493#define CAN_FLAG_FF0 (0x00000203U)
494#define CAN_FLAG_FOV0 (0x00000204U)
495#define CAN_FLAG_FF1 (0x00000403U)
496#define CAN_FLAG_FOV1 (0x00000404U)
497
498/* Operating Mode Flags */
499#define CAN_FLAG_INAK (0x00000100U)
500#define CAN_FLAG_SLAK (0x00000101U)
501#define CAN_FLAG_ERRI (0x00000102U)
502#define CAN_FLAG_WKU (0x00000103U)
503#define CAN_FLAG_SLAKI (0x00000104U)
504
505/* Error Flags */
506#define CAN_FLAG_EWG (0x00000300U)
507#define CAN_FLAG_EPV (0x00000301U)
508#define CAN_FLAG_BOF (0x00000302U)
512
513
517/* Transmit Interrupt */
518#define CAN_IT_TX_MAILBOX_EMPTY ((uint32_t)CAN_IER_TMEIE)
519
520/* Receive Interrupts */
521#define CAN_IT_RX_FIFO0_MSG_PENDING ((uint32_t)CAN_IER_FMPIE0)
522#define CAN_IT_RX_FIFO0_FULL ((uint32_t)CAN_IER_FFIE0)
523#define CAN_IT_RX_FIFO0_OVERRUN ((uint32_t)CAN_IER_FOVIE0)
524#define CAN_IT_RX_FIFO1_MSG_PENDING ((uint32_t)CAN_IER_FMPIE1)
525#define CAN_IT_RX_FIFO1_FULL ((uint32_t)CAN_IER_FFIE1)
526#define CAN_IT_RX_FIFO1_OVERRUN ((uint32_t)CAN_IER_FOVIE1)
527
528/* Operating Mode Interrupts */
529#define CAN_IT_WAKEUP ((uint32_t)CAN_IER_WKUIE)
530#define CAN_IT_SLEEP_ACK ((uint32_t)CAN_IER_SLKIE)
531
532/* Error Interrupts */
533#define CAN_IT_ERROR_WARNING ((uint32_t)CAN_IER_EWGIE)
534#define CAN_IT_ERROR_PASSIVE ((uint32_t)CAN_IER_EPVIE)
535#define CAN_IT_BUSOFF ((uint32_t)CAN_IER_BOFIE)
536#define CAN_IT_LAST_ERROR_CODE ((uint32_t)CAN_IER_LECIE)
537#define CAN_IT_ERROR ((uint32_t)CAN_IER_ERRIE)
541
545
546/* Exported macros -----------------------------------------------------------*/
550
555#if USE_HAL_CAN_REGISTER_CALLBACKS == 1
556#define __HAL_CAN_RESET_HANDLE_STATE(__HANDLE__) do{ \
557 (__HANDLE__)->State = HAL_CAN_STATE_RESET; \
558 (__HANDLE__)->MspInitCallback = NULL; \
559 (__HANDLE__)->MspDeInitCallback = NULL; \
560 } while(0)
561#else
562#define __HAL_CAN_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_CAN_STATE_RESET)
563#endif /*USE_HAL_CAN_REGISTER_CALLBACKS */
564
572#define __HAL_CAN_ENABLE_IT(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->IER) |= (__INTERRUPT__))
573
581#define __HAL_CAN_DISABLE_IT(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->IER) &= ~(__INTERRUPT__))
582
589#define __HAL_CAN_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->IER) & (__INTERRUPT__))
590
597#define __HAL_CAN_GET_FLAG(__HANDLE__, __FLAG__) \
598 ((((__FLAG__) >> 8U) == 5U)? ((((__HANDLE__)->Instance->TSR) & (1U << ((__FLAG__) & CAN_FLAG_MASK))) == (1U << ((__FLAG__) & CAN_FLAG_MASK))): \
599 (((__FLAG__) >> 8U) == 2U)? ((((__HANDLE__)->Instance->RF0R) & (1U << ((__FLAG__) & CAN_FLAG_MASK))) == (1U << ((__FLAG__) & CAN_FLAG_MASK))): \
600 (((__FLAG__) >> 8U) == 4U)? ((((__HANDLE__)->Instance->RF1R) & (1U << ((__FLAG__) & CAN_FLAG_MASK))) == (1U << ((__FLAG__) & CAN_FLAG_MASK))): \
601 (((__FLAG__) >> 8U) == 1U)? ((((__HANDLE__)->Instance->MSR) & (1U << ((__FLAG__) & CAN_FLAG_MASK))) == (1U << ((__FLAG__) & CAN_FLAG_MASK))): \
602 (((__FLAG__) >> 8U) == 3U)? ((((__HANDLE__)->Instance->ESR) & (1U << ((__FLAG__) & CAN_FLAG_MASK))) == (1U << ((__FLAG__) & CAN_FLAG_MASK))): 0U)
603
628#define __HAL_CAN_CLEAR_FLAG(__HANDLE__, __FLAG__) \
629 ((((__FLAG__) >> 8U) == 5U)? (((__HANDLE__)->Instance->TSR) = (1U << ((__FLAG__) & CAN_FLAG_MASK))): \
630 (((__FLAG__) >> 8U) == 2U)? (((__HANDLE__)->Instance->RF0R) = (1U << ((__FLAG__) & CAN_FLAG_MASK))): \
631 (((__FLAG__) >> 8U) == 4U)? (((__HANDLE__)->Instance->RF1R) = (1U << ((__FLAG__) & CAN_FLAG_MASK))): \
632 (((__FLAG__) >> 8U) == 1U)? (((__HANDLE__)->Instance->MSR) = (1U << ((__FLAG__) & CAN_FLAG_MASK))): 0U)
633
637
638/* Exported functions --------------------------------------------------------*/
642
647
648/* Initialization and de-initialization functions *****************************/
649HAL_StatusTypeDef HAL_CAN_Init(CAN_HandleTypeDef *hcan);
650HAL_StatusTypeDef HAL_CAN_DeInit(CAN_HandleTypeDef *hcan);
651void HAL_CAN_MspInit(CAN_HandleTypeDef *hcan);
652void HAL_CAN_MspDeInit(CAN_HandleTypeDef *hcan);
653
654#if USE_HAL_CAN_REGISTER_CALLBACKS == 1
655/* Callbacks Register/UnRegister functions ***********************************/
656HAL_StatusTypeDef HAL_CAN_RegisterCallback(CAN_HandleTypeDef *hcan, HAL_CAN_CallbackIDTypeDef CallbackID,
657 void (* pCallback)(CAN_HandleTypeDef *_hcan));
658HAL_StatusTypeDef HAL_CAN_UnRegisterCallback(CAN_HandleTypeDef *hcan, HAL_CAN_CallbackIDTypeDef CallbackID);
659
660#endif /* (USE_HAL_CAN_REGISTER_CALLBACKS) */
664
669
670/* Configuration functions ****************************************************/
671HAL_StatusTypeDef HAL_CAN_ConfigFilter(CAN_HandleTypeDef *hcan, const CAN_FilterTypeDef *sFilterConfig);
672
676
681
682/* Control functions **********************************************************/
683HAL_StatusTypeDef HAL_CAN_Start(CAN_HandleTypeDef *hcan);
684HAL_StatusTypeDef HAL_CAN_Stop(CAN_HandleTypeDef *hcan);
685HAL_StatusTypeDef HAL_CAN_RequestSleep(CAN_HandleTypeDef *hcan);
686HAL_StatusTypeDef HAL_CAN_WakeUp(CAN_HandleTypeDef *hcan);
687uint32_t HAL_CAN_IsSleepActive(const CAN_HandleTypeDef *hcan);
688HAL_StatusTypeDef HAL_CAN_AddTxMessage(CAN_HandleTypeDef *hcan, const CAN_TxHeaderTypeDef *pHeader,
689 const uint8_t aData[], uint32_t *pTxMailbox);
690HAL_StatusTypeDef HAL_CAN_AbortTxRequest(CAN_HandleTypeDef *hcan, uint32_t TxMailboxes);
691uint32_t HAL_CAN_GetTxMailboxesFreeLevel(const CAN_HandleTypeDef *hcan);
692uint32_t HAL_CAN_IsTxMessagePending(const CAN_HandleTypeDef *hcan, uint32_t TxMailboxes);
693uint32_t HAL_CAN_GetTxTimestamp(const CAN_HandleTypeDef *hcan, uint32_t TxMailbox);
694HAL_StatusTypeDef HAL_CAN_GetRxMessage(CAN_HandleTypeDef *hcan, uint32_t RxFifo,
695 CAN_RxHeaderTypeDef *pHeader, uint8_t aData[]);
696uint32_t HAL_CAN_GetRxFifoFillLevel(const CAN_HandleTypeDef *hcan, uint32_t RxFifo);
697
701
706/* Interrupts management ******************************************************/
707HAL_StatusTypeDef HAL_CAN_ActivateNotification(CAN_HandleTypeDef *hcan, uint32_t ActiveITs);
708HAL_StatusTypeDef HAL_CAN_DeactivateNotification(CAN_HandleTypeDef *hcan, uint32_t InactiveITs);
709void HAL_CAN_IRQHandler(CAN_HandleTypeDef *hcan);
710
714
719/* Callbacks functions ********************************************************/
720
721void HAL_CAN_TxMailbox0CompleteCallback(CAN_HandleTypeDef *hcan);
722void HAL_CAN_TxMailbox1CompleteCallback(CAN_HandleTypeDef *hcan);
723void HAL_CAN_TxMailbox2CompleteCallback(CAN_HandleTypeDef *hcan);
724void HAL_CAN_TxMailbox0AbortCallback(CAN_HandleTypeDef *hcan);
725void HAL_CAN_TxMailbox1AbortCallback(CAN_HandleTypeDef *hcan);
726void HAL_CAN_TxMailbox2AbortCallback(CAN_HandleTypeDef *hcan);
727void HAL_CAN_RxFifo0MsgPendingCallback(CAN_HandleTypeDef *hcan);
728void HAL_CAN_RxFifo0FullCallback(CAN_HandleTypeDef *hcan);
729void HAL_CAN_RxFifo1MsgPendingCallback(CAN_HandleTypeDef *hcan);
730void HAL_CAN_RxFifo1FullCallback(CAN_HandleTypeDef *hcan);
731void HAL_CAN_SleepCallback(CAN_HandleTypeDef *hcan);
732void HAL_CAN_WakeUpFromRxMsgCallback(CAN_HandleTypeDef *hcan);
733void HAL_CAN_ErrorCallback(CAN_HandleTypeDef *hcan);
734
738
743/* Peripheral State and Error functions ***************************************/
744HAL_CAN_StateTypeDef HAL_CAN_GetState(const CAN_HandleTypeDef *hcan);
745uint32_t HAL_CAN_GetError(const CAN_HandleTypeDef *hcan);
746HAL_StatusTypeDef HAL_CAN_ResetError(CAN_HandleTypeDef *hcan);
747
751
755
756/* Private types -------------------------------------------------------------*/
760
764
765/* Private variables ---------------------------------------------------------*/
769
773
774/* Private constants ---------------------------------------------------------*/
778#define CAN_FLAG_MASK (0x000000FFU)
782
783/* Private Macros -----------------------------------------------------------*/
787
788#define IS_CAN_MODE(MODE) (((MODE) == CAN_MODE_NORMAL) || \
789 ((MODE) == CAN_MODE_LOOPBACK)|| \
790 ((MODE) == CAN_MODE_SILENT) || \
791 ((MODE) == CAN_MODE_SILENT_LOOPBACK))
792#define IS_CAN_SJW(SJW) (((SJW) == CAN_SJW_1TQ) || ((SJW) == CAN_SJW_2TQ) || \
793 ((SJW) == CAN_SJW_3TQ) || ((SJW) == CAN_SJW_4TQ))
794#define IS_CAN_BS1(BS1) (((BS1) == CAN_BS1_1TQ) || ((BS1) == CAN_BS1_2TQ) || \
795 ((BS1) == CAN_BS1_3TQ) || ((BS1) == CAN_BS1_4TQ) || \
796 ((BS1) == CAN_BS1_5TQ) || ((BS1) == CAN_BS1_6TQ) || \
797 ((BS1) == CAN_BS1_7TQ) || ((BS1) == CAN_BS1_8TQ) || \
798 ((BS1) == CAN_BS1_9TQ) || ((BS1) == CAN_BS1_10TQ)|| \
799 ((BS1) == CAN_BS1_11TQ)|| ((BS1) == CAN_BS1_12TQ)|| \
800 ((BS1) == CAN_BS1_13TQ)|| ((BS1) == CAN_BS1_14TQ)|| \
801 ((BS1) == CAN_BS1_15TQ)|| ((BS1) == CAN_BS1_16TQ))
802#define IS_CAN_BS2(BS2) (((BS2) == CAN_BS2_1TQ) || ((BS2) == CAN_BS2_2TQ) || \
803 ((BS2) == CAN_BS2_3TQ) || ((BS2) == CAN_BS2_4TQ) || \
804 ((BS2) == CAN_BS2_5TQ) || ((BS2) == CAN_BS2_6TQ) || \
805 ((BS2) == CAN_BS2_7TQ) || ((BS2) == CAN_BS2_8TQ))
806#define IS_CAN_PRESCALER(PRESCALER) (((PRESCALER) >= 1U) && ((PRESCALER) <= 1024U))
807#define IS_CAN_FILTER_ID_HALFWORD(HALFWORD) ((HALFWORD) <= 0xFFFFU)
808#define IS_CAN_FILTER_BANK_DUAL(BANK) ((BANK) <= 27U)
809#define IS_CAN_FILTER_BANK_SINGLE(BANK) ((BANK) <= 13U)
810#define IS_CAN_FILTER_MODE(MODE) (((MODE) == CAN_FILTERMODE_IDMASK) || \
811 ((MODE) == CAN_FILTERMODE_IDLIST))
812#define IS_CAN_FILTER_SCALE(SCALE) (((SCALE) == CAN_FILTERSCALE_16BIT) || \
813 ((SCALE) == CAN_FILTERSCALE_32BIT))
814#define IS_CAN_FILTER_ACTIVATION(ACTIVATION) (((ACTIVATION) == CAN_FILTER_DISABLE) || \
815 ((ACTIVATION) == CAN_FILTER_ENABLE))
816#define IS_CAN_FILTER_FIFO(FIFO) (((FIFO) == CAN_FILTER_FIFO0) || \
817 ((FIFO) == CAN_FILTER_FIFO1))
818#define IS_CAN_TX_MAILBOX(TRANSMITMAILBOX) (((TRANSMITMAILBOX) == CAN_TX_MAILBOX0 ) || \
819 ((TRANSMITMAILBOX) == CAN_TX_MAILBOX1 ) || \
820 ((TRANSMITMAILBOX) == CAN_TX_MAILBOX2 ))
821#define IS_CAN_TX_MAILBOX_LIST(TRANSMITMAILBOX) ((TRANSMITMAILBOX) <= (CAN_TX_MAILBOX0 | CAN_TX_MAILBOX1 | \
822 CAN_TX_MAILBOX2))
823#define IS_CAN_STDID(STDID) ((STDID) <= 0x7FFU)
824#define IS_CAN_EXTID(EXTID) ((EXTID) <= 0x1FFFFFFFU)
825#define IS_CAN_DLC(DLC) ((DLC) <= 8U)
826#define IS_CAN_IDTYPE(IDTYPE) (((IDTYPE) == CAN_ID_STD) || \
827 ((IDTYPE) == CAN_ID_EXT))
828#define IS_CAN_RTR(RTR) (((RTR) == CAN_RTR_DATA) || ((RTR) == CAN_RTR_REMOTE))
829#define IS_CAN_RX_FIFO(FIFO) (((FIFO) == CAN_RX_FIFO0) || ((FIFO) == CAN_RX_FIFO1))
830#define IS_CAN_IT(IT) ((IT) <= (CAN_IT_TX_MAILBOX_EMPTY | CAN_IT_RX_FIFO0_MSG_PENDING | \
831 CAN_IT_RX_FIFO0_FULL | CAN_IT_RX_FIFO0_OVERRUN | \
832 CAN_IT_RX_FIFO1_MSG_PENDING | CAN_IT_RX_FIFO1_FULL | \
833 CAN_IT_RX_FIFO1_OVERRUN | CAN_IT_WAKEUP | \
834 CAN_IT_SLEEP_ACK | CAN_IT_ERROR_WARNING | \
835 CAN_IT_ERROR_PASSIVE | CAN_IT_BUSOFF | \
836 CAN_IT_LAST_ERROR_CODE | CAN_IT_ERROR))
837
841/* End of private macros -----------------------------------------------------*/
842
846
847
848#endif /* CAN1 */
852
853#ifdef __cplusplus
854}
855#endif
856
857#endif /* STM32F4xx_HAL_CAN_H */
This file contains HAL common defines, enumeration, macros and structures definitions.
HAL_StatusTypeDef
HAL Status structures definition.