STM32F37 Standard Peripheral bibliotheek  1.0
ST Microelectronics bibliotheek documentatie voor de STM32F37 Standard Peripheral Library
 All Data Structures Files Functions Variables Enumerations Enumerator Groups
stm32f37x_can.h
Go to the documentation of this file.
1 
29 /* Define to prevent recursive inclusion -------------------------------------*/
30 #ifndef __STM32F37X_CAN_H
31 #define __STM32F37X_CAN_H
32 
33 #ifdef __cplusplus
34  extern "C" {
35 #endif
36 
37 /* Includes ------------------------------------------------------------------*/
38 #include "stm32f37x.h"
39 
48 /* Exported types ------------------------------------------------------------*/
49 
50 #define IS_CAN_ALL_PERIPH(PERIPH) ((PERIPH) == CAN1)
51 
55 typedef struct
56 {
57  uint16_t CAN_Prescaler;
60  uint8_t CAN_Mode;
63  uint8_t CAN_SJW;
68  uint8_t CAN_BS1;
72  uint8_t CAN_BS2;
75  FunctionalState CAN_TTCM;
78  FunctionalState CAN_ABOM;
81  FunctionalState CAN_AWUM;
84  FunctionalState CAN_NART;
87  FunctionalState CAN_RFLM;
90  FunctionalState CAN_TXFP;
92 } CAN_InitTypeDef;
93 
97 typedef struct
98 {
99  uint16_t CAN_FilterIdHigh;
103  uint16_t CAN_FilterIdLow;
107  uint16_t CAN_FilterMaskIdHigh;
112  uint16_t CAN_FilterMaskIdLow;
117  uint16_t CAN_FilterFIFOAssignment;
120  uint8_t CAN_FilterNumber;
122  uint8_t CAN_FilterMode;
125  uint8_t CAN_FilterScale;
128  FunctionalState CAN_FilterActivation;
130 } CAN_FilterInitTypeDef;
131 
135 typedef struct
136 {
137  uint32_t StdId;
140  uint32_t ExtId;
143  uint8_t IDE;
147  uint8_t RTR;
151  uint8_t DLC;
155  uint8_t Data[8];
157 } CanTxMsg;
158 
162 typedef struct
163 {
164  uint32_t StdId;
167  uint32_t ExtId;
170  uint8_t IDE;
174  uint8_t RTR;
177  uint8_t DLC;
180  uint8_t Data[8];
183  uint8_t FMI;
186 } CanRxMsg;
187 
188 /* Exported constants --------------------------------------------------------*/
189 
198 #define CAN_InitStatus_Failed ((uint8_t)0x00)
199 #define CAN_InitStatus_Success ((uint8_t)0x01)
202 /* Legacy defines */
203 #define CANINITFAILED CAN_InitStatus_Failed
204 #define CANINITOK CAN_InitStatus_Success
205 
213 #define CAN_Mode_Normal ((uint8_t)0x00)
214 #define CAN_Mode_LoopBack ((uint8_t)0x01)
215 #define CAN_Mode_Silent ((uint8_t)0x02)
216 #define CAN_Mode_Silent_LoopBack ((uint8_t)0x03)
218 #define IS_CAN_MODE(MODE) (((MODE) == CAN_Mode_Normal) || \
219  ((MODE) == CAN_Mode_LoopBack)|| \
220  ((MODE) == CAN_Mode_Silent) || \
221  ((MODE) == CAN_Mode_Silent_LoopBack))
222 
231 #define CAN_OperatingMode_Initialization ((uint8_t)0x00)
232 #define CAN_OperatingMode_Normal ((uint8_t)0x01)
233 #define CAN_OperatingMode_Sleep ((uint8_t)0x02)
236 #define IS_CAN_OPERATING_MODE(MODE) (((MODE) == CAN_OperatingMode_Initialization) ||\
237  ((MODE) == CAN_OperatingMode_Normal)|| \
238  ((MODE) == CAN_OperatingMode_Sleep))
239 
248 #define CAN_ModeStatus_Failed ((uint8_t)0x00)
249 #define CAN_ModeStatus_Success ((uint8_t)!CAN_ModeStatus_Failed)
257 #define CAN_SJW_1tq ((uint8_t)0x00)
258 #define CAN_SJW_2tq ((uint8_t)0x01)
259 #define CAN_SJW_3tq ((uint8_t)0x02)
260 #define CAN_SJW_4tq ((uint8_t)0x03)
262 #define IS_CAN_SJW(SJW) (((SJW) == CAN_SJW_1tq) || ((SJW) == CAN_SJW_2tq)|| \
263  ((SJW) == CAN_SJW_3tq) || ((SJW) == CAN_SJW_4tq))
264 
271 #define CAN_BS1_1tq ((uint8_t)0x00)
272 #define CAN_BS1_2tq ((uint8_t)0x01)
273 #define CAN_BS1_3tq ((uint8_t)0x02)
274 #define CAN_BS1_4tq ((uint8_t)0x03)
275 #define CAN_BS1_5tq ((uint8_t)0x04)
276 #define CAN_BS1_6tq ((uint8_t)0x05)
277 #define CAN_BS1_7tq ((uint8_t)0x06)
278 #define CAN_BS1_8tq ((uint8_t)0x07)
279 #define CAN_BS1_9tq ((uint8_t)0x08)
280 #define CAN_BS1_10tq ((uint8_t)0x09)
281 #define CAN_BS1_11tq ((uint8_t)0x0A)
282 #define CAN_BS1_12tq ((uint8_t)0x0B)
283 #define CAN_BS1_13tq ((uint8_t)0x0C)
284 #define CAN_BS1_14tq ((uint8_t)0x0D)
285 #define CAN_BS1_15tq ((uint8_t)0x0E)
286 #define CAN_BS1_16tq ((uint8_t)0x0F)
288 #define IS_CAN_BS1(BS1) ((BS1) <= CAN_BS1_16tq)
289 
296 #define CAN_BS2_1tq ((uint8_t)0x00)
297 #define CAN_BS2_2tq ((uint8_t)0x01)
298 #define CAN_BS2_3tq ((uint8_t)0x02)
299 #define CAN_BS2_4tq ((uint8_t)0x03)
300 #define CAN_BS2_5tq ((uint8_t)0x04)
301 #define CAN_BS2_6tq ((uint8_t)0x05)
302 #define CAN_BS2_7tq ((uint8_t)0x06)
303 #define CAN_BS2_8tq ((uint8_t)0x07)
305 #define IS_CAN_BS2(BS2) ((BS2) <= CAN_BS2_8tq)
306 
313 #define IS_CAN_PRESCALER(PRESCALER) (((PRESCALER) >= 1) && ((PRESCALER) <= 1024))
314 
321 #define IS_CAN_FILTER_NUMBER(NUMBER) ((NUMBER) <= 27)
322 
329 #define CAN_FilterMode_IdMask ((uint8_t)0x00)
330 #define CAN_FilterMode_IdList ((uint8_t)0x01)
332 #define IS_CAN_FILTER_MODE(MODE) (((MODE) == CAN_FilterMode_IdMask) || \
333  ((MODE) == CAN_FilterMode_IdList))
334 
341 #define CAN_FilterScale_16bit ((uint8_t)0x00)
342 #define CAN_FilterScale_32bit ((uint8_t)0x01)
344 #define IS_CAN_FILTER_SCALE(SCALE) (((SCALE) == CAN_FilterScale_16bit) || \
345  ((SCALE) == CAN_FilterScale_32bit))
346 
353 #define CAN_Filter_FIFO0 ((uint8_t)0x00)
354 #define CAN_Filter_FIFO1 ((uint8_t)0x01)
355 #define IS_CAN_FILTER_FIFO(FIFO) (((FIFO) == CAN_FilterFIFO0) || \
356  ((FIFO) == CAN_FilterFIFO1))
357 
358 /* Legacy defines */
359 #define CAN_FilterFIFO0 CAN_Filter_FIFO0
360 #define CAN_FilterFIFO1 CAN_Filter_FIFO1
361 
368 #define IS_CAN_BANKNUMBER(BANKNUMBER) (((BANKNUMBER) >= 1) && ((BANKNUMBER) <= 27))
369 
376 #define IS_CAN_TRANSMITMAILBOX(TRANSMITMAILBOX) ((TRANSMITMAILBOX) <= ((uint8_t)0x02))
377 #define IS_CAN_STDID(STDID) ((STDID) <= ((uint32_t)0x7FF))
378 #define IS_CAN_EXTID(EXTID) ((EXTID) <= ((uint32_t)0x1FFFFFFF))
379 #define IS_CAN_DLC(DLC) ((DLC) <= ((uint8_t)0x08))
380 
387 #define CAN_Id_Standard ((uint32_t)0x00000000)
388 #define CAN_Id_Extended ((uint32_t)0x00000004)
389 #define IS_CAN_IDTYPE(IDTYPE) (((IDTYPE) == CAN_Id_Standard) || \
390  ((IDTYPE) == CAN_Id_Extended))
391 /* Legacy defines */
392 #define CAN_ID_STD CAN_Id_Standard
393 #define CAN_ID_EXT CAN_Id_Extended
394 
401 #define CAN_RTR_Data ((uint32_t)0x00000000)
402 #define CAN_RTR_Remote ((uint32_t)0x00000002)
403 #define IS_CAN_RTR(RTR) (((RTR) == CAN_RTR_Data) || ((RTR) == CAN_RTR_Remote))
404 /* Legacy defines */
405 #define CAN_RTR_DATA CAN_RTR_Data
406 #define CAN_RTR_REMOTE CAN_RTR_Remote
407 
414 #define CAN_TxStatus_Failed ((uint8_t)0x00)
415 #define CAN_TxStatus_Ok ((uint8_t)0x01)
416 #define CAN_TxStatus_Pending ((uint8_t)0x02)
417 #define CAN_TxStatus_NoMailBox ((uint8_t)0x04)
419 /* Legacy defines */
420 #define CANTXFAILED CAN_TxStatus_Failed
421 #define CANTXOK CAN_TxStatus_Ok
422 #define CANTXPENDING CAN_TxStatus_Pending
423 #define CAN_NO_MB CAN_TxStatus_NoMailBox
424 
431 #define CAN_FIFO0 ((uint8_t)0x00)
432 #define CAN_FIFO1 ((uint8_t)0x01)
434 #define IS_CAN_FIFO(FIFO) (((FIFO) == CAN_FIFO0) || ((FIFO) == CAN_FIFO1))
435 
442 #define CAN_Sleep_Failed ((uint8_t)0x00)
443 #define CAN_Sleep_Ok ((uint8_t)0x01)
445 /* Legacy defines */
446 #define CANSLEEPFAILED CAN_Sleep_Failed
447 #define CANSLEEPOK CAN_Sleep_Ok
448 
455 #define CAN_WakeUp_Failed ((uint8_t)0x00)
456 #define CAN_WakeUp_Ok ((uint8_t)0x01)
458 /* Legacy defines */
459 #define CANWAKEUPFAILED CAN_WakeUp_Failed
460 #define CANWAKEUPOK CAN_WakeUp_Ok
461 
469 #define CAN_ErrorCode_NoErr ((uint8_t)0x00)
470 #define CAN_ErrorCode_StuffErr ((uint8_t)0x10)
471 #define CAN_ErrorCode_FormErr ((uint8_t)0x20)
472 #define CAN_ErrorCode_ACKErr ((uint8_t)0x30)
473 #define CAN_ErrorCode_BitRecessiveErr ((uint8_t)0x40)
474 #define CAN_ErrorCode_BitDominantErr ((uint8_t)0x50)
475 #define CAN_ErrorCode_CRCErr ((uint8_t)0x60)
476 #define CAN_ErrorCode_SoftwareSetErr ((uint8_t)0x70)
484 /* If the flag is 0x3XXXXXXX, it means that it can be used with CAN_GetFlagStatus()
485  and CAN_ClearFlag() functions. */
486 /* If the flag is 0x1XXXXXXX, it means that it can only be used with
487  CAN_GetFlagStatus() function. */
488 
489 /* Transmit Flags */
490 #define CAN_FLAG_RQCP0 ((uint32_t)0x38000001)
491 #define CAN_FLAG_RQCP1 ((uint32_t)0x38000100)
492 #define CAN_FLAG_RQCP2 ((uint32_t)0x38010000)
494 /* Receive Flags */
495 #define CAN_FLAG_FMP0 ((uint32_t)0x12000003)
496 #define CAN_FLAG_FF0 ((uint32_t)0x32000008)
497 #define CAN_FLAG_FOV0 ((uint32_t)0x32000010)
498 #define CAN_FLAG_FMP1 ((uint32_t)0x14000003)
499 #define CAN_FLAG_FF1 ((uint32_t)0x34000008)
500 #define CAN_FLAG_FOV1 ((uint32_t)0x34000010)
502 /* Operating Mode Flags */
503 #define CAN_FLAG_WKU ((uint32_t)0x31000008)
504 #define CAN_FLAG_SLAK ((uint32_t)0x31000012)
505 /* @note When SLAK interrupt is disabled (SLKIE=0), no polling on SLAKI is possible.
506  In this case the SLAK bit can be polled.*/
507 
508 /* Error Flags */
509 #define CAN_FLAG_EWG ((uint32_t)0x10F00001)
510 #define CAN_FLAG_EPV ((uint32_t)0x10F00002)
511 #define CAN_FLAG_BOF ((uint32_t)0x10F00004)
512 #define CAN_FLAG_LEC ((uint32_t)0x30F00070)
514 #define IS_CAN_GET_FLAG(FLAG) (((FLAG) == CAN_FLAG_LEC) || ((FLAG) == CAN_FLAG_BOF) || \
515  ((FLAG) == CAN_FLAG_EPV) || ((FLAG) == CAN_FLAG_EWG) || \
516  ((FLAG) == CAN_FLAG_WKU) || ((FLAG) == CAN_FLAG_FOV0) || \
517  ((FLAG) == CAN_FLAG_FF0) || ((FLAG) == CAN_FLAG_FMP0) || \
518  ((FLAG) == CAN_FLAG_FOV1) || ((FLAG) == CAN_FLAG_FF1) || \
519  ((FLAG) == CAN_FLAG_FMP1) || ((FLAG) == CAN_FLAG_RQCP2) || \
520  ((FLAG) == CAN_FLAG_RQCP1)|| ((FLAG) == CAN_FLAG_RQCP0) || \
521  ((FLAG) == CAN_FLAG_SLAK ))
522 
523 #define IS_CAN_CLEAR_FLAG(FLAG)(((FLAG) == CAN_FLAG_LEC) || ((FLAG) == CAN_FLAG_RQCP2) || \
524  ((FLAG) == CAN_FLAG_RQCP1) || ((FLAG) == CAN_FLAG_RQCP0) || \
525  ((FLAG) == CAN_FLAG_FF0) || ((FLAG) == CAN_FLAG_FOV0) ||\
526  ((FLAG) == CAN_FLAG_FF1) || ((FLAG) == CAN_FLAG_FOV1) || \
527  ((FLAG) == CAN_FLAG_WKU) || ((FLAG) == CAN_FLAG_SLAK))
528 
536 #define CAN_IT_TME ((uint32_t)0x00000001)
538 /* Receive Interrupts */
539 #define CAN_IT_FMP0 ((uint32_t)0x00000002)
540 #define CAN_IT_FF0 ((uint32_t)0x00000004)
541 #define CAN_IT_FOV0 ((uint32_t)0x00000008)
542 #define CAN_IT_FMP1 ((uint32_t)0x00000010)
543 #define CAN_IT_FF1 ((uint32_t)0x00000020)
544 #define CAN_IT_FOV1 ((uint32_t)0x00000040)
546 /* Operating Mode Interrupts */
547 #define CAN_IT_WKU ((uint32_t)0x00010000)
548 #define CAN_IT_SLK ((uint32_t)0x00020000)
550 /* Error Interrupts */
551 #define CAN_IT_EWG ((uint32_t)0x00000100)
552 #define CAN_IT_EPV ((uint32_t)0x00000200)
553 #define CAN_IT_BOF ((uint32_t)0x00000400)
554 #define CAN_IT_LEC ((uint32_t)0x00000800)
555 #define CAN_IT_ERR ((uint32_t)0x00008000)
557 /* Flags named as Interrupts : kept only for FW compatibility */
558 #define CAN_IT_RQCP0 CAN_IT_TME
559 #define CAN_IT_RQCP1 CAN_IT_TME
560 #define CAN_IT_RQCP2 CAN_IT_TME
561 
562 
563 #define IS_CAN_IT(IT) (((IT) == CAN_IT_TME) || ((IT) == CAN_IT_FMP0) ||\
564  ((IT) == CAN_IT_FF0) || ((IT) == CAN_IT_FOV0) ||\
565  ((IT) == CAN_IT_FMP1) || ((IT) == CAN_IT_FF1) ||\
566  ((IT) == CAN_IT_FOV1) || ((IT) == CAN_IT_EWG) ||\
567  ((IT) == CAN_IT_EPV) || ((IT) == CAN_IT_BOF) ||\
568  ((IT) == CAN_IT_LEC) || ((IT) == CAN_IT_ERR) ||\
569  ((IT) == CAN_IT_WKU) || ((IT) == CAN_IT_SLK))
570 
571 #define IS_CAN_CLEAR_IT(IT) (((IT) == CAN_IT_TME) || ((IT) == CAN_IT_FF0) ||\
572  ((IT) == CAN_IT_FOV0)|| ((IT) == CAN_IT_FF1) ||\
573  ((IT) == CAN_IT_FOV1)|| ((IT) == CAN_IT_EWG) ||\
574  ((IT) == CAN_IT_EPV) || ((IT) == CAN_IT_BOF) ||\
575  ((IT) == CAN_IT_LEC) || ((IT) == CAN_IT_ERR) ||\
576  ((IT) == CAN_IT_WKU) || ((IT) == CAN_IT_SLK))
577 
585 /* Exported macro ------------------------------------------------------------*/
586 /* Exported functions --------------------------------------------------------*/
587 
588 /* Function used to set the CAN configuration to the default reset state *****/
589 void CAN_DeInit(CAN_TypeDef* CANx);
590 
591 /* Initialization and Configuration functions *********************************/
592 uint8_t CAN_Init(CAN_TypeDef* CANx, CAN_InitTypeDef* CAN_InitStruct);
593 void CAN_FilterInit(CAN_FilterInitTypeDef* CAN_FilterInitStruct);
594 void CAN_StructInit(CAN_InitTypeDef* CAN_InitStruct);
595 void CAN_SlaveStartBank(uint8_t CAN_BankNumber);
596 void CAN_DBGFreeze(CAN_TypeDef* CANx, FunctionalState NewState);
597 void CAN_TTComModeCmd(CAN_TypeDef* CANx, FunctionalState NewState);
598 
599 /* CAN Frames Transmission functions ******************************************/
600 uint8_t CAN_Transmit(CAN_TypeDef* CANx, CanTxMsg* TxMessage);
601 uint8_t CAN_TransmitStatus(CAN_TypeDef* CANx, uint8_t TransmitMailbox);
602 void CAN_CancelTransmit(CAN_TypeDef* CANx, uint8_t Mailbox);
603 
604 /* CAN Frames Reception functions *********************************************/
605 void CAN_Receive(CAN_TypeDef* CANx, uint8_t FIFONumber, CanRxMsg* RxMessage);
606 void CAN_FIFORelease(CAN_TypeDef* CANx, uint8_t FIFONumber);
607 uint8_t CAN_MessagePending(CAN_TypeDef* CANx, uint8_t FIFONumber);
608 
609 /* Operation modes functions **************************************************/
610 uint8_t CAN_OperatingModeRequest(CAN_TypeDef* CANx, uint8_t CAN_OperatingMode);
611 uint8_t CAN_Sleep(CAN_TypeDef* CANx);
612 uint8_t CAN_WakeUp(CAN_TypeDef* CANx);
613 
614 /* CAN Bus Error management functions *****************************************/
615 uint8_t CAN_GetLastErrorCode(CAN_TypeDef* CANx);
616 uint8_t CAN_GetReceiveErrorCounter(CAN_TypeDef* CANx);
617 uint8_t CAN_GetLSBTransmitErrorCounter(CAN_TypeDef* CANx);
618 
619 /* Interrupts and flags management functions **********************************/
620 void CAN_ITConfig(CAN_TypeDef* CANx, uint32_t CAN_IT, FunctionalState NewState);
621 FlagStatus CAN_GetFlagStatus(CAN_TypeDef* CANx, uint32_t CAN_FLAG);
622 void CAN_ClearFlag(CAN_TypeDef* CANx, uint32_t CAN_FLAG);
623 ITStatus CAN_GetITStatus(CAN_TypeDef* CANx, uint32_t CAN_IT);
624 void CAN_ClearITPendingBit(CAN_TypeDef* CANx, uint32_t CAN_IT);
625 
626 #ifdef __cplusplus
627 }
628 #endif
629 
630 #endif /* __STM32F37X_CAN_H */
631 
640 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/