stm32f4xx_can.h 27 KB

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