stm32f2xx_can.h 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636
  1. /**
  2. ******************************************************************************
  3. * @file stm32f2xx_can.h
  4. * @author MCD Application Team
  5. * @version V1.1.3
  6. * @date 31-December-2021
  7. * @brief This file contains all the functions prototypes for the CAN firmware
  8. * library.
  9. ******************************************************************************
  10. * @attention
  11. *
  12. * Copyright (c) 2012 STMicroelectronics.
  13. * All rights reserved.
  14. *
  15. * This software is licensed under terms that can be found in the LICENSE file
  16. * in the root directory of this software component.
  17. * If no LICENSE file comes with this software, it is provided AS-IS.
  18. *
  19. ******************************************************************************
  20. */
  21. /* Define to prevent recursive inclusion -------------------------------------*/
  22. #ifndef __STM32F2xx_CAN_H
  23. #define __STM32F2xx_CAN_H
  24. #ifdef __cplusplus
  25. extern "C" {
  26. #endif
  27. /* Includes ------------------------------------------------------------------*/
  28. #include "stm32f2xx.h"
  29. /** @addtogroup STM32F2xx_StdPeriph_Driver
  30. * @{
  31. */
  32. /** @addtogroup CAN
  33. * @{
  34. */
  35. /* Exported types ------------------------------------------------------------*/
  36. #define IS_CAN_ALL_PERIPH(PERIPH) (((PERIPH) == CAN1) || \
  37. ((PERIPH) == CAN2))
  38. /**
  39. * @brief CAN init structure definition
  40. */
  41. typedef struct
  42. {
  43. uint16_t CAN_Prescaler; /*!< Specifies the length of a time quantum.
  44. It ranges from 1 to 1024. */
  45. uint8_t CAN_Mode; /*!< Specifies the CAN operating mode.
  46. This parameter can be a value of @ref CAN_operating_mode */
  47. uint8_t CAN_SJW; /*!< Specifies the maximum number of time quanta
  48. the CAN hardware is allowed to lengthen or
  49. shorten a bit to perform resynchronization.
  50. This parameter can be a value of @ref CAN_synchronisation_jump_width */
  51. uint8_t CAN_BS1; /*!< Specifies the number of time quanta in Bit
  52. Segment 1. This parameter can be a value of
  53. @ref CAN_time_quantum_in_bit_segment_1 */
  54. uint8_t CAN_BS2; /*!< Specifies the number of time quanta in Bit Segment 2.
  55. This parameter can be a value of @ref CAN_time_quantum_in_bit_segment_2 */
  56. FunctionalState CAN_TTCM; /*!< Enable or disable the time triggered communication mode.
  57. This parameter can be set either to ENABLE or DISABLE. */
  58. FunctionalState CAN_ABOM; /*!< Enable or disable the automatic bus-off management.
  59. This parameter can be set either to ENABLE or DISABLE. */
  60. FunctionalState CAN_AWUM; /*!< Enable or disable the automatic wake-up mode.
  61. This parameter can be set either to ENABLE or DISABLE. */
  62. FunctionalState CAN_NART; /*!< Enable or disable the non-automatic retransmission mode.
  63. This parameter can be set either to ENABLE or DISABLE. */
  64. FunctionalState CAN_RFLM; /*!< Enable or disable the Receive FIFO Locked mode.
  65. This parameter can be set either to ENABLE or DISABLE. */
  66. FunctionalState CAN_TXFP; /*!< Enable or disable the transmit FIFO priority.
  67. This parameter can be set either to ENABLE or DISABLE. */
  68. } CAN_InitTypeDef;
  69. /**
  70. * @brief CAN filter init structure definition
  71. */
  72. typedef struct
  73. {
  74. uint16_t CAN_FilterIdHigh; /*!< Specifies the filter identification number (MSBs for a 32-bit
  75. configuration, first one for a 16-bit configuration).
  76. This parameter can be a value between 0x0000 and 0xFFFF */
  77. uint16_t CAN_FilterIdLow; /*!< Specifies the filter identification number (LSBs for a 32-bit
  78. configuration, second one for a 16-bit configuration).
  79. This parameter can be a value between 0x0000 and 0xFFFF */
  80. uint16_t CAN_FilterMaskIdHigh; /*!< Specifies the filter mask number or identification number,
  81. according to the mode (MSBs for a 32-bit configuration,
  82. first one for a 16-bit configuration).
  83. This parameter can be a value between 0x0000 and 0xFFFF */
  84. uint16_t CAN_FilterMaskIdLow; /*!< Specifies the filter mask number or identification number,
  85. according to the mode (LSBs for a 32-bit configuration,
  86. second one for a 16-bit configuration).
  87. This parameter can be a value between 0x0000 and 0xFFFF */
  88. uint16_t CAN_FilterFIFOAssignment; /*!< Specifies the FIFO (0 or 1) which will be assigned to the filter.
  89. This parameter can be a value of @ref CAN_filter_FIFO */
  90. uint8_t CAN_FilterNumber; /*!< Specifies the filter which will be initialized. It ranges from 0 to 13. */
  91. uint8_t CAN_FilterMode; /*!< Specifies the filter mode to be initialized.
  92. This parameter can be a value of @ref CAN_filter_mode */
  93. uint8_t CAN_FilterScale; /*!< Specifies the filter scale.
  94. This parameter can be a value of @ref CAN_filter_scale */
  95. FunctionalState CAN_FilterActivation; /*!< Enable or disable the filter.
  96. This parameter can be set either to ENABLE or DISABLE. */
  97. } CAN_FilterInitTypeDef;
  98. /**
  99. * @brief CAN Tx message structure definition
  100. */
  101. typedef struct
  102. {
  103. uint32_t StdId; /*!< Specifies the standard identifier.
  104. This parameter can be a value between 0 to 0x7FF. */
  105. uint32_t ExtId; /*!< Specifies the extended identifier.
  106. This parameter can be a value between 0 to 0x1FFFFFFF. */
  107. uint8_t IDE; /*!< Specifies the type of identifier for the message that
  108. will be transmitted. This parameter can be a value
  109. of @ref CAN_identifier_type */
  110. uint8_t RTR; /*!< Specifies the type of frame for the message that will
  111. be transmitted. This parameter can be a value of
  112. @ref CAN_remote_transmission_request */
  113. uint8_t DLC; /*!< Specifies the length of the frame that will be
  114. transmitted. This parameter can be a value between
  115. 0 to 8 */
  116. uint8_t Data[8]; /*!< Contains the data to be transmitted. It ranges from 0
  117. to 0xFF. */
  118. } CanTxMsg;
  119. /**
  120. * @brief CAN Rx message structure definition
  121. */
  122. typedef struct
  123. {
  124. uint32_t StdId; /*!< Specifies the standard identifier.
  125. This parameter can be a value between 0 to 0x7FF. */
  126. uint32_t ExtId; /*!< Specifies the extended identifier.
  127. This parameter can be a value between 0 to 0x1FFFFFFF. */
  128. uint8_t IDE; /*!< Specifies the type of identifier for the message that
  129. will be received. This parameter can be a value of
  130. @ref CAN_identifier_type */
  131. uint8_t RTR; /*!< Specifies the type of frame for the received message.
  132. This parameter can be a value of
  133. @ref CAN_remote_transmission_request */
  134. uint8_t DLC; /*!< Specifies the length of the frame that will be received.
  135. This parameter can be a value between 0 to 8 */
  136. uint8_t Data[8]; /*!< Contains the data to be received. It ranges from 0 to
  137. 0xFF. */
  138. uint8_t FMI; /*!< Specifies the index of the filter the message stored in
  139. the mailbox passes through. This parameter can be a
  140. value between 0 to 0xFF */
  141. } CanRxMsg;
  142. /* Exported constants --------------------------------------------------------*/
  143. /** @defgroup CAN_Exported_Constants
  144. * @{
  145. */
  146. /** @defgroup CAN_InitStatus
  147. * @{
  148. */
  149. #define CAN_InitStatus_Failed ((uint8_t)0x00) /*!< CAN initialization failed */
  150. #define CAN_InitStatus_Success ((uint8_t)0x01) /*!< CAN initialization OK */
  151. /* Legacy defines */
  152. #define CANINITFAILED CAN_InitStatus_Failed
  153. #define CANINITOK CAN_InitStatus_Success
  154. /**
  155. * @}
  156. */
  157. /** @defgroup CAN_operating_mode
  158. * @{
  159. */
  160. #define CAN_Mode_Normal ((uint8_t)0x00) /*!< normal mode */
  161. #define CAN_Mode_LoopBack ((uint8_t)0x01) /*!< loopback mode */
  162. #define CAN_Mode_Silent ((uint8_t)0x02) /*!< silent mode */
  163. #define CAN_Mode_Silent_LoopBack ((uint8_t)0x03) /*!< loopback combined with silent mode */
  164. #define IS_CAN_MODE(MODE) (((MODE) == CAN_Mode_Normal) || \
  165. ((MODE) == CAN_Mode_LoopBack)|| \
  166. ((MODE) == CAN_Mode_Silent) || \
  167. ((MODE) == CAN_Mode_Silent_LoopBack))
  168. /**
  169. * @}
  170. */
  171. /**
  172. * @defgroup CAN_operating_mode
  173. * @{
  174. */
  175. #define CAN_OperatingMode_Initialization ((uint8_t)0x00) /*!< Initialization mode */
  176. #define CAN_OperatingMode_Normal ((uint8_t)0x01) /*!< Normal mode */
  177. #define CAN_OperatingMode_Sleep ((uint8_t)0x02) /*!< sleep mode */
  178. #define IS_CAN_OPERATING_MODE(MODE) (((MODE) == CAN_OperatingMode_Initialization) ||\
  179. ((MODE) == CAN_OperatingMode_Normal)|| \
  180. ((MODE) == CAN_OperatingMode_Sleep))
  181. /**
  182. * @}
  183. */
  184. /**
  185. * @defgroup CAN_operating_mode_status
  186. * @{
  187. */
  188. #define CAN_ModeStatus_Failed ((uint8_t)0x00) /*!< CAN entering the specific mode failed */
  189. #define CAN_ModeStatus_Success ((uint8_t)!CAN_ModeStatus_Failed) /*!< CAN entering the specific mode Succeed */
  190. /**
  191. * @}
  192. */
  193. /** @defgroup CAN_synchronisation_jump_width
  194. * @{
  195. */
  196. #define CAN_SJW_1tq ((uint8_t)0x00) /*!< 1 time quantum */
  197. #define CAN_SJW_2tq ((uint8_t)0x01) /*!< 2 time quantum */
  198. #define CAN_SJW_3tq ((uint8_t)0x02) /*!< 3 time quantum */
  199. #define CAN_SJW_4tq ((uint8_t)0x03) /*!< 4 time quantum */
  200. #define IS_CAN_SJW(SJW) (((SJW) == CAN_SJW_1tq) || ((SJW) == CAN_SJW_2tq)|| \
  201. ((SJW) == CAN_SJW_3tq) || ((SJW) == CAN_SJW_4tq))
  202. /**
  203. * @}
  204. */
  205. /** @defgroup CAN_time_quantum_in_bit_segment_1
  206. * @{
  207. */
  208. #define CAN_BS1_1tq ((uint8_t)0x00) /*!< 1 time quantum */
  209. #define CAN_BS1_2tq ((uint8_t)0x01) /*!< 2 time quantum */
  210. #define CAN_BS1_3tq ((uint8_t)0x02) /*!< 3 time quantum */
  211. #define CAN_BS1_4tq ((uint8_t)0x03) /*!< 4 time quantum */
  212. #define CAN_BS1_5tq ((uint8_t)0x04) /*!< 5 time quantum */
  213. #define CAN_BS1_6tq ((uint8_t)0x05) /*!< 6 time quantum */
  214. #define CAN_BS1_7tq ((uint8_t)0x06) /*!< 7 time quantum */
  215. #define CAN_BS1_8tq ((uint8_t)0x07) /*!< 8 time quantum */
  216. #define CAN_BS1_9tq ((uint8_t)0x08) /*!< 9 time quantum */
  217. #define CAN_BS1_10tq ((uint8_t)0x09) /*!< 10 time quantum */
  218. #define CAN_BS1_11tq ((uint8_t)0x0A) /*!< 11 time quantum */
  219. #define CAN_BS1_12tq ((uint8_t)0x0B) /*!< 12 time quantum */
  220. #define CAN_BS1_13tq ((uint8_t)0x0C) /*!< 13 time quantum */
  221. #define CAN_BS1_14tq ((uint8_t)0x0D) /*!< 14 time quantum */
  222. #define CAN_BS1_15tq ((uint8_t)0x0E) /*!< 15 time quantum */
  223. #define CAN_BS1_16tq ((uint8_t)0x0F) /*!< 16 time quantum */
  224. #define IS_CAN_BS1(BS1) ((BS1) <= CAN_BS1_16tq)
  225. /**
  226. * @}
  227. */
  228. /** @defgroup CAN_time_quantum_in_bit_segment_2
  229. * @{
  230. */
  231. #define CAN_BS2_1tq ((uint8_t)0x00) /*!< 1 time quantum */
  232. #define CAN_BS2_2tq ((uint8_t)0x01) /*!< 2 time quantum */
  233. #define CAN_BS2_3tq ((uint8_t)0x02) /*!< 3 time quantum */
  234. #define CAN_BS2_4tq ((uint8_t)0x03) /*!< 4 time quantum */
  235. #define CAN_BS2_5tq ((uint8_t)0x04) /*!< 5 time quantum */
  236. #define CAN_BS2_6tq ((uint8_t)0x05) /*!< 6 time quantum */
  237. #define CAN_BS2_7tq ((uint8_t)0x06) /*!< 7 time quantum */
  238. #define CAN_BS2_8tq ((uint8_t)0x07) /*!< 8 time quantum */
  239. #define IS_CAN_BS2(BS2) ((BS2) <= CAN_BS2_8tq)
  240. /**
  241. * @}
  242. */
  243. /** @defgroup CAN_clock_prescaler
  244. * @{
  245. */
  246. #define IS_CAN_PRESCALER(PRESCALER) (((PRESCALER) >= 1) && ((PRESCALER) <= 1024))
  247. /**
  248. * @}
  249. */
  250. /** @defgroup CAN_filter_number
  251. * @{
  252. */
  253. #define IS_CAN_FILTER_NUMBER(NUMBER) ((NUMBER) <= 27)
  254. /**
  255. * @}
  256. */
  257. /** @defgroup CAN_filter_mode
  258. * @{
  259. */
  260. #define CAN_FilterMode_IdMask ((uint8_t)0x00) /*!< identifier/mask mode */
  261. #define CAN_FilterMode_IdList ((uint8_t)0x01) /*!< identifier list mode */
  262. #define IS_CAN_FILTER_MODE(MODE) (((MODE) == CAN_FilterMode_IdMask) || \
  263. ((MODE) == CAN_FilterMode_IdList))
  264. /**
  265. * @}
  266. */
  267. /** @defgroup CAN_filter_scale
  268. * @{
  269. */
  270. #define CAN_FilterScale_16bit ((uint8_t)0x00) /*!< Two 16-bit filters */
  271. #define CAN_FilterScale_32bit ((uint8_t)0x01) /*!< One 32-bit filter */
  272. #define IS_CAN_FILTER_SCALE(SCALE) (((SCALE) == CAN_FilterScale_16bit) || \
  273. ((SCALE) == CAN_FilterScale_32bit))
  274. /**
  275. * @}
  276. */
  277. /** @defgroup CAN_filter_FIFO
  278. * @{
  279. */
  280. #define CAN_Filter_FIFO0 ((uint8_t)0x00) /*!< Filter FIFO 0 assignment for filter x */
  281. #define CAN_Filter_FIFO1 ((uint8_t)0x01) /*!< Filter FIFO 1 assignment for filter x */
  282. #define IS_CAN_FILTER_FIFO(FIFO) (((FIFO) == CAN_FilterFIFO0) || \
  283. ((FIFO) == CAN_FilterFIFO1))
  284. /* Legacy defines */
  285. #define CAN_FilterFIFO0 CAN_Filter_FIFO0
  286. #define CAN_FilterFIFO1 CAN_Filter_FIFO1
  287. /**
  288. * @}
  289. */
  290. /** @defgroup CAN_Start_bank_filter_for_slave_CAN
  291. * @{
  292. */
  293. #define IS_CAN_BANKNUMBER(BANKNUMBER) (((BANKNUMBER) >= 1) && ((BANKNUMBER) <= 27))
  294. /**
  295. * @}
  296. */
  297. /** @defgroup CAN_Tx
  298. * @{
  299. */
  300. #define IS_CAN_TRANSMITMAILBOX(TRANSMITMAILBOX) ((TRANSMITMAILBOX) <= ((uint8_t)0x02))
  301. #define IS_CAN_STDID(STDID) ((STDID) <= ((uint32_t)0x7FF))
  302. #define IS_CAN_EXTID(EXTID) ((EXTID) <= ((uint32_t)0x1FFFFFFF))
  303. #define IS_CAN_DLC(DLC) ((DLC) <= ((uint8_t)0x08))
  304. /**
  305. * @}
  306. */
  307. /** @defgroup CAN_identifier_type
  308. * @{
  309. */
  310. #define CAN_Id_Standard ((uint32_t)0x00000000) /*!< Standard Id */
  311. #define CAN_Id_Extended ((uint32_t)0x00000004) /*!< Extended Id */
  312. #define IS_CAN_IDTYPE(IDTYPE) (((IDTYPE) == CAN_Id_Standard) || \
  313. ((IDTYPE) == CAN_Id_Extended))
  314. /* Legacy defines */
  315. #define CAN_ID_STD CAN_Id_Standard
  316. #define CAN_ID_EXT CAN_Id_Extended
  317. /**
  318. * @}
  319. */
  320. /** @defgroup CAN_remote_transmission_request
  321. * @{
  322. */
  323. #define CAN_RTR_Data ((uint32_t)0x00000000) /*!< Data frame */
  324. #define CAN_RTR_Remote ((uint32_t)0x00000002) /*!< Remote frame */
  325. #define IS_CAN_RTR(RTR) (((RTR) == CAN_RTR_Data) || ((RTR) == CAN_RTR_Remote))
  326. /* Legacy defines */
  327. #define CAN_RTR_DATA CAN_RTR_Data
  328. #define CAN_RTR_REMOTE CAN_RTR_Remote
  329. /**
  330. * @}
  331. */
  332. /** @defgroup CAN_transmit_constants
  333. * @{
  334. */
  335. #define CAN_TxStatus_Failed ((uint8_t)0x00)/*!< CAN transmission failed */
  336. #define CAN_TxStatus_Ok ((uint8_t)0x01) /*!< CAN transmission succeeded */
  337. #define CAN_TxStatus_Pending ((uint8_t)0x02) /*!< CAN transmission pending */
  338. #define CAN_TxStatus_NoMailBox ((uint8_t)0x04) /*!< CAN cell did not provide
  339. an empty mailbox */
  340. /* Legacy defines */
  341. #define CANTXFAILED CAN_TxStatus_Failed
  342. #define CANTXOK CAN_TxStatus_Ok
  343. #define CANTXPENDING CAN_TxStatus_Pending
  344. #define CAN_NO_MB CAN_TxStatus_NoMailBox
  345. /**
  346. * @}
  347. */
  348. /** @defgroup CAN_receive_FIFO_number_constants
  349. * @{
  350. */
  351. #define CAN_FIFO0 ((uint8_t)0x00) /*!< CAN FIFO 0 used to receive */
  352. #define CAN_FIFO1 ((uint8_t)0x01) /*!< CAN FIFO 1 used to receive */
  353. #define IS_CAN_FIFO(FIFO) (((FIFO) == CAN_FIFO0) || ((FIFO) == CAN_FIFO1))
  354. /**
  355. * @}
  356. */
  357. /** @defgroup CAN_sleep_constants
  358. * @{
  359. */
  360. #define CAN_Sleep_Failed ((uint8_t)0x00) /*!< CAN did not enter the sleep mode */
  361. #define CAN_Sleep_Ok ((uint8_t)0x01) /*!< CAN entered the sleep mode */
  362. /* Legacy defines */
  363. #define CANSLEEPFAILED CAN_Sleep_Failed
  364. #define CANSLEEPOK CAN_Sleep_Ok
  365. /**
  366. * @}
  367. */
  368. /** @defgroup CAN_wake_up_constants
  369. * @{
  370. */
  371. #define CAN_WakeUp_Failed ((uint8_t)0x00) /*!< CAN did not leave the sleep mode */
  372. #define CAN_WakeUp_Ok ((uint8_t)0x01) /*!< CAN leaved the sleep mode */
  373. /* Legacy defines */
  374. #define CANWAKEUPFAILED CAN_WakeUp_Failed
  375. #define CANWAKEUPOK CAN_WakeUp_Ok
  376. /**
  377. * @}
  378. */
  379. /**
  380. * @defgroup CAN_Error_Code_constants
  381. * @{
  382. */
  383. #define CAN_ErrorCode_NoErr ((uint8_t)0x00) /*!< No Error */
  384. #define CAN_ErrorCode_StuffErr ((uint8_t)0x10) /*!< Stuff Error */
  385. #define CAN_ErrorCode_FormErr ((uint8_t)0x20) /*!< Form Error */
  386. #define CAN_ErrorCode_ACKErr ((uint8_t)0x30) /*!< Acknowledgment Error */
  387. #define CAN_ErrorCode_BitRecessiveErr ((uint8_t)0x40) /*!< Bit Recessive Error */
  388. #define CAN_ErrorCode_BitDominantErr ((uint8_t)0x50) /*!< Bit Dominant Error */
  389. #define CAN_ErrorCode_CRCErr ((uint8_t)0x60) /*!< CRC Error */
  390. #define CAN_ErrorCode_SoftwareSetErr ((uint8_t)0x70) /*!< Software Set Error */
  391. /**
  392. * @}
  393. */
  394. /** @defgroup CAN_flags
  395. * @{
  396. */
  397. /* If the flag is 0x3XXXXXXX, it means that it can be used with CAN_GetFlagStatus()
  398. and CAN_ClearFlag() functions. */
  399. /* If the flag is 0x1XXXXXXX, it means that it can only be used with
  400. CAN_GetFlagStatus() function. */
  401. /* Transmit Flags */
  402. #define CAN_FLAG_RQCP0 ((uint32_t)0x38000001) /*!< Request MailBox0 Flag */
  403. #define CAN_FLAG_RQCP1 ((uint32_t)0x38000100) /*!< Request MailBox1 Flag */
  404. #define CAN_FLAG_RQCP2 ((uint32_t)0x38010000) /*!< Request MailBox2 Flag */
  405. /* Receive Flags */
  406. #define CAN_FLAG_FMP0 ((uint32_t)0x12000003) /*!< FIFO 0 Message Pending Flag */
  407. #define CAN_FLAG_FF0 ((uint32_t)0x32000008) /*!< FIFO 0 Full Flag */
  408. #define CAN_FLAG_FOV0 ((uint32_t)0x32000010) /*!< FIFO 0 Overrun Flag */
  409. #define CAN_FLAG_FMP1 ((uint32_t)0x14000003) /*!< FIFO 1 Message Pending Flag */
  410. #define CAN_FLAG_FF1 ((uint32_t)0x34000008) /*!< FIFO 1 Full Flag */
  411. #define CAN_FLAG_FOV1 ((uint32_t)0x34000010) /*!< FIFO 1 Overrun Flag */
  412. /* Operating Mode Flags */
  413. #define CAN_FLAG_WKU ((uint32_t)0x31000008) /*!< Wake up Flag */
  414. #define CAN_FLAG_SLAK ((uint32_t)0x31000012) /*!< Sleep acknowledge Flag */
  415. /* @note When SLAK interrupt is disabled (SLKIE=0), no polling on SLAKI is possible.
  416. In this case the SLAK bit can be polled.*/
  417. /* Error Flags */
  418. #define CAN_FLAG_EWG ((uint32_t)0x10F00001) /*!< Error Warning Flag */
  419. #define CAN_FLAG_EPV ((uint32_t)0x10F00002) /*!< Error Passive Flag */
  420. #define CAN_FLAG_BOF ((uint32_t)0x10F00004) /*!< Bus-Off Flag */
  421. #define CAN_FLAG_LEC ((uint32_t)0x30F00070) /*!< Last error code Flag */
  422. #define IS_CAN_GET_FLAG(FLAG) (((FLAG) == CAN_FLAG_LEC) || ((FLAG) == CAN_FLAG_BOF) || \
  423. ((FLAG) == CAN_FLAG_EPV) || ((FLAG) == CAN_FLAG_EWG) || \
  424. ((FLAG) == CAN_FLAG_WKU) || ((FLAG) == CAN_FLAG_FOV0) || \
  425. ((FLAG) == CAN_FLAG_FF0) || ((FLAG) == CAN_FLAG_FMP0) || \
  426. ((FLAG) == CAN_FLAG_FOV1) || ((FLAG) == CAN_FLAG_FF1) || \
  427. ((FLAG) == CAN_FLAG_FMP1) || ((FLAG) == CAN_FLAG_RQCP2) || \
  428. ((FLAG) == CAN_FLAG_RQCP1)|| ((FLAG) == CAN_FLAG_RQCP0) || \
  429. ((FLAG) == CAN_FLAG_SLAK ))
  430. #define IS_CAN_CLEAR_FLAG(FLAG)(((FLAG) == CAN_FLAG_LEC) || ((FLAG) == CAN_FLAG_RQCP2) || \
  431. ((FLAG) == CAN_FLAG_RQCP1) || ((FLAG) == CAN_FLAG_RQCP0) || \
  432. ((FLAG) == CAN_FLAG_FF0) || ((FLAG) == CAN_FLAG_FOV0) ||\
  433. ((FLAG) == CAN_FLAG_FF1) || ((FLAG) == CAN_FLAG_FOV1) || \
  434. ((FLAG) == CAN_FLAG_WKU) || ((FLAG) == CAN_FLAG_SLAK))
  435. /**
  436. * @}
  437. */
  438. /** @defgroup CAN_interrupts
  439. * @{
  440. */
  441. #define CAN_IT_TME ((uint32_t)0x00000001) /*!< Transmit mailbox empty Interrupt*/
  442. /* Receive Interrupts */
  443. #define CAN_IT_FMP0 ((uint32_t)0x00000002) /*!< FIFO 0 message pending Interrupt*/
  444. #define CAN_IT_FF0 ((uint32_t)0x00000004) /*!< FIFO 0 full Interrupt*/
  445. #define CAN_IT_FOV0 ((uint32_t)0x00000008) /*!< FIFO 0 overrun Interrupt*/
  446. #define CAN_IT_FMP1 ((uint32_t)0x00000010) /*!< FIFO 1 message pending Interrupt*/
  447. #define CAN_IT_FF1 ((uint32_t)0x00000020) /*!< FIFO 1 full Interrupt*/
  448. #define CAN_IT_FOV1 ((uint32_t)0x00000040) /*!< FIFO 1 overrun Interrupt*/
  449. /* Operating Mode Interrupts */
  450. #define CAN_IT_WKU ((uint32_t)0x00010000) /*!< Wake-up Interrupt*/
  451. #define CAN_IT_SLK ((uint32_t)0x00020000) /*!< Sleep acknowledge Interrupt*/
  452. /* Error Interrupts */
  453. #define CAN_IT_EWG ((uint32_t)0x00000100) /*!< Error warning Interrupt*/
  454. #define CAN_IT_EPV ((uint32_t)0x00000200) /*!< Error passive Interrupt*/
  455. #define CAN_IT_BOF ((uint32_t)0x00000400) /*!< Bus-off Interrupt*/
  456. #define CAN_IT_LEC ((uint32_t)0x00000800) /*!< Last error code Interrupt*/
  457. #define CAN_IT_ERR ((uint32_t)0x00008000) /*!< Error Interrupt*/
  458. /* Flags named as Interrupts : kept only for FW compatibility */
  459. #define CAN_IT_RQCP0 CAN_IT_TME
  460. #define CAN_IT_RQCP1 CAN_IT_TME
  461. #define CAN_IT_RQCP2 CAN_IT_TME
  462. #define IS_CAN_IT(IT) (((IT) == CAN_IT_TME) || ((IT) == CAN_IT_FMP0) ||\
  463. ((IT) == CAN_IT_FF0) || ((IT) == CAN_IT_FOV0) ||\
  464. ((IT) == CAN_IT_FMP1) || ((IT) == CAN_IT_FF1) ||\
  465. ((IT) == CAN_IT_FOV1) || ((IT) == CAN_IT_EWG) ||\
  466. ((IT) == CAN_IT_EPV) || ((IT) == CAN_IT_BOF) ||\
  467. ((IT) == CAN_IT_LEC) || ((IT) == CAN_IT_ERR) ||\
  468. ((IT) == CAN_IT_WKU) || ((IT) == CAN_IT_SLK))
  469. #define IS_CAN_CLEAR_IT(IT) (((IT) == CAN_IT_TME) || ((IT) == CAN_IT_FF0) ||\
  470. ((IT) == CAN_IT_FOV0)|| ((IT) == CAN_IT_FF1) ||\
  471. ((IT) == CAN_IT_FOV1)|| ((IT) == CAN_IT_EWG) ||\
  472. ((IT) == CAN_IT_EPV) || ((IT) == CAN_IT_BOF) ||\
  473. ((IT) == CAN_IT_LEC) || ((IT) == CAN_IT_ERR) ||\
  474. ((IT) == CAN_IT_WKU) || ((IT) == CAN_IT_SLK))
  475. /**
  476. * @}
  477. */
  478. /**
  479. * @}
  480. */
  481. /* Exported macro ------------------------------------------------------------*/
  482. /* Exported functions --------------------------------------------------------*/
  483. /* Function used to set the CAN configuration to the default reset state *****/
  484. void CAN_DeInit(CAN_TypeDef* CANx);
  485. /* Initialization and Configuration functions *********************************/
  486. uint8_t CAN_Init(CAN_TypeDef* CANx, CAN_InitTypeDef* CAN_InitStruct);
  487. void CAN_FilterInit(CAN_FilterInitTypeDef* CAN_FilterInitStruct);
  488. void CAN_StructInit(CAN_InitTypeDef* CAN_InitStruct);
  489. void CAN_SlaveStartBank(uint8_t CAN_BankNumber);
  490. void CAN_DBGFreeze(CAN_TypeDef* CANx, FunctionalState NewState);
  491. void CAN_TTComModeCmd(CAN_TypeDef* CANx, FunctionalState NewState);
  492. /* CAN Frames Transmission functions ******************************************/
  493. uint8_t CAN_Transmit(CAN_TypeDef* CANx, CanTxMsg* TxMessage);
  494. uint8_t CAN_TransmitStatus(CAN_TypeDef* CANx, uint8_t TransmitMailbox);
  495. void CAN_CancelTransmit(CAN_TypeDef* CANx, uint8_t Mailbox);
  496. /* CAN Frames Reception functions *********************************************/
  497. void CAN_Receive(CAN_TypeDef* CANx, uint8_t FIFONumber, CanRxMsg* RxMessage);
  498. void CAN_FIFORelease(CAN_TypeDef* CANx, uint8_t FIFONumber);
  499. uint8_t CAN_MessagePending(CAN_TypeDef* CANx, uint8_t FIFONumber);
  500. /* Operation modes functions **************************************************/
  501. uint8_t CAN_OperatingModeRequest(CAN_TypeDef* CANx, uint8_t CAN_OperatingMode);
  502. uint8_t CAN_Sleep(CAN_TypeDef* CANx);
  503. uint8_t CAN_WakeUp(CAN_TypeDef* CANx);
  504. /* CAN Bus Error management functions *****************************************/
  505. uint8_t CAN_GetLastErrorCode(CAN_TypeDef* CANx);
  506. uint8_t CAN_GetReceiveErrorCounter(CAN_TypeDef* CANx);
  507. uint8_t CAN_GetLSBTransmitErrorCounter(CAN_TypeDef* CANx);
  508. /* Interrupts and flags management functions **********************************/
  509. void CAN_ITConfig(CAN_TypeDef* CANx, uint32_t CAN_IT, FunctionalState NewState);
  510. FlagStatus CAN_GetFlagStatus(CAN_TypeDef* CANx, uint32_t CAN_FLAG);
  511. void CAN_ClearFlag(CAN_TypeDef* CANx, uint32_t CAN_FLAG);
  512. ITStatus CAN_GetITStatus(CAN_TypeDef* CANx, uint32_t CAN_IT);
  513. void CAN_ClearITPendingBit(CAN_TypeDef* CANx, uint32_t CAN_IT);
  514. #ifdef __cplusplus
  515. }
  516. #endif
  517. #endif /* __STM32F2xx_CAN_H */
  518. /**
  519. * @}
  520. */
  521. /**
  522. * @}
  523. */