You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 

778 lines
35 KiB

  1. /**
  2. ******************************************************************************
  3. * @file stm32f4xx_hal_can.h
  4. * @author MCD Application Team
  5. * @version V1.5.2
  6. * @date 22-September-2016
  7. * @brief Header file of CAN HAL module.
  8. ******************************************************************************
  9. * @attention
  10. *
  11. * <h2><center>&copy; COPYRIGHT(c) 2016 STMicroelectronics</center></h2>
  12. *
  13. * Redistribution and use in source and binary forms, with or without modification,
  14. * are permitted provided that the following conditions are met:
  15. * 1. Redistributions of source code must retain the above copyright notice,
  16. * this list of conditions and the following disclaimer.
  17. * 2. Redistributions in binary form must reproduce the above copyright notice,
  18. * this list of conditions and the following disclaimer in the documentation
  19. * and/or other materials provided with the distribution.
  20. * 3. Neither the name of STMicroelectronics nor the names of its contributors
  21. * may be used to endorse or promote products derived from this software
  22. * without specific prior written permission.
  23. *
  24. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  25. * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  27. * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  28. * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  30. * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  31. * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  32. * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  33. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34. *
  35. ******************************************************************************
  36. */
  37. /* Define to prevent recursive inclusion -------------------------------------*/
  38. #ifndef __STM32F4xx_HAL_CAN_H
  39. #define __STM32F4xx_HAL_CAN_H
  40. #ifdef __cplusplus
  41. extern "C" {
  42. #endif
  43. #if defined(STM32F405xx) || defined(STM32F415xx) || defined(STM32F407xx) || defined(STM32F417xx) ||\
  44. defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx) ||\
  45. defined(STM32F446xx) || defined(STM32F469xx) || defined(STM32F479xx) || defined(STM32F412Zx) ||\
  46. defined(STM32F412Vx) || defined(STM32F412Rx) || defined(STM32F412Cx)
  47. /* Includes ------------------------------------------------------------------*/
  48. #include "stm32f4xx_hal_def.h"
  49. /** @addtogroup STM32F4xx_HAL_Driver
  50. * @{
  51. */
  52. /** @addtogroup CAN
  53. * @{
  54. */
  55. /* Exported types ------------------------------------------------------------*/
  56. /** @defgroup CAN_Exported_Types CAN Exported Types
  57. * @{
  58. */
  59. /**
  60. * @brief HAL State structures definition
  61. */
  62. typedef enum
  63. {
  64. HAL_CAN_STATE_RESET = 0x00U, /*!< CAN not yet initialized or disabled */
  65. HAL_CAN_STATE_READY = 0x01U, /*!< CAN initialized and ready for use */
  66. HAL_CAN_STATE_BUSY = 0x02U, /*!< CAN process is ongoing */
  67. HAL_CAN_STATE_BUSY_TX = 0x12U, /*!< CAN process is ongoing */
  68. HAL_CAN_STATE_BUSY_RX = 0x22U, /*!< CAN process is ongoing */
  69. HAL_CAN_STATE_BUSY_TX_RX = 0x32U, /*!< CAN process is ongoing */
  70. HAL_CAN_STATE_TIMEOUT = 0x03U, /*!< Timeout state */
  71. HAL_CAN_STATE_ERROR = 0x04U /*!< CAN error state */
  72. }HAL_CAN_StateTypeDef;
  73. /**
  74. * @brief CAN init structure definition
  75. */
  76. typedef struct
  77. {
  78. uint32_t Prescaler; /*!< Specifies the length of a time quantum.
  79. This parameter must be a number between Min_Data = 1 and Max_Data = 1024 */
  80. uint32_t Mode; /*!< Specifies the CAN operating mode.
  81. This parameter can be a value of @ref CAN_operating_mode */
  82. uint32_t SJW; /*!< Specifies the maximum number of time quanta
  83. the CAN hardware is allowed to lengthen or
  84. shorten a bit to perform resynchronization.
  85. This parameter can be a value of @ref CAN_synchronisation_jump_width */
  86. uint32_t BS1; /*!< Specifies the number of time quanta in Bit Segment 1.
  87. This parameter can be a value of @ref CAN_time_quantum_in_bit_segment_1 */
  88. uint32_t BS2; /*!< Specifies the number of time quanta in Bit Segment 2.
  89. This parameter can be a value of @ref CAN_time_quantum_in_bit_segment_2 */
  90. uint32_t TTCM; /*!< Enable or disable the time triggered communication mode.
  91. This parameter can be set to ENABLE or DISABLE. */
  92. uint32_t ABOM; /*!< Enable or disable the automatic bus-off management.
  93. This parameter can be set to ENABLE or DISABLE */
  94. uint32_t AWUM; /*!< Enable or disable the automatic wake-up mode.
  95. This parameter can be set to ENABLE or DISABLE */
  96. uint32_t NART; /*!< Enable or disable the non-automatic retransmission mode.
  97. This parameter can be set to ENABLE or DISABLE */
  98. uint32_t RFLM; /*!< Enable or disable the receive FIFO Locked mode.
  99. This parameter can be set to ENABLE or DISABLE */
  100. uint32_t TXFP; /*!< Enable or disable the transmit FIFO priority.
  101. This parameter can be set to ENABLE or DISABLE */
  102. }CAN_InitTypeDef;
  103. /**
  104. * @brief CAN filter configuration structure definition
  105. */
  106. typedef struct
  107. {
  108. uint32_t FilterIdHigh; /*!< Specifies the filter identification number (MSBs for a 32-bit
  109. configuration, first one for a 16-bit configuration).
  110. This parameter must be a number between Min_Data = 0x0000U and Max_Data = 0xFFFFU */
  111. uint32_t FilterIdLow; /*!< Specifies the filter identification number (LSBs for a 32-bit
  112. configuration, second one for a 16-bit configuration).
  113. This parameter must be a number between Min_Data = 0x0000U and Max_Data = 0xFFFFU */
  114. uint32_t FilterMaskIdHigh; /*!< Specifies the filter mask number or identification number,
  115. according to the mode (MSBs for a 32-bit configuration,
  116. first one for a 16-bit configuration).
  117. This parameter must be a number between Min_Data = 0x0000U and Max_Data = 0xFFFFU */
  118. uint32_t FilterMaskIdLow; /*!< Specifies the filter mask number or identification number,
  119. according to the mode (LSBs for a 32-bit configuration,
  120. second one for a 16-bit configuration).
  121. This parameter must be a number between Min_Data = 0x0000U and Max_Data = 0xFFFFU */
  122. uint32_t FilterFIFOAssignment; /*!< Specifies the FIFO (0 or 1) which will be assigned to the filter.
  123. This parameter can be a value of @ref CAN_filter_FIFO */
  124. uint32_t FilterNumber; /*!< Specifies the filter which will be initialized.
  125. This parameter must be a number between Min_Data = 0 and Max_Data = 27 */
  126. uint32_t FilterMode; /*!< Specifies the filter mode to be initialized.
  127. This parameter can be a value of @ref CAN_filter_mode */
  128. uint32_t FilterScale; /*!< Specifies the filter scale.
  129. This parameter can be a value of @ref CAN_filter_scale */
  130. uint32_t FilterActivation; /*!< Enable or disable the filter.
  131. This parameter can be set to ENABLE or DISABLE. */
  132. uint32_t BankNumber; /*!< Select the start slave bank filter.
  133. This parameter must be a number between Min_Data = 0 and Max_Data = 28 */
  134. }CAN_FilterConfTypeDef;
  135. /**
  136. * @brief CAN Tx message structure definition
  137. */
  138. typedef struct
  139. {
  140. uint32_t StdId; /*!< Specifies the standard identifier.
  141. This parameter must be a number between Min_Data = 0 and Max_Data = 0x7FF */
  142. uint32_t ExtId; /*!< Specifies the extended identifier.
  143. This parameter must be a number between Min_Data = 0 and Max_Data = 0x1FFFFFFFU */
  144. uint32_t IDE; /*!< Specifies the type of identifier for the message that will be transmitted.
  145. This parameter can be a value of @ref CAN_Identifier_Type */
  146. uint32_t RTR; /*!< Specifies the type of frame for the message that will be transmitted.
  147. This parameter can be a value of @ref CAN_remote_transmission_request */
  148. uint32_t DLC; /*!< Specifies the length of the frame that will be transmitted.
  149. This parameter must be a number between Min_Data = 0 and Max_Data = 8 */
  150. uint8_t Data[8]; /*!< Contains the data to be transmitted.
  151. This parameter must be a number between Min_Data = 0 and Max_Data = 0xFF */
  152. }CanTxMsgTypeDef;
  153. /**
  154. * @brief CAN Rx message structure definition
  155. */
  156. typedef struct
  157. {
  158. uint32_t StdId; /*!< Specifies the standard identifier.
  159. This parameter must be a number between Min_Data = 0 and Max_Data = 0x7FF */
  160. uint32_t ExtId; /*!< Specifies the extended identifier.
  161. This parameter must be a number between Min_Data = 0 and Max_Data = 0x1FFFFFFFU */
  162. uint32_t IDE; /*!< Specifies the type of identifier for the message that will be received.
  163. This parameter can be a value of @ref CAN_Identifier_Type */
  164. uint32_t RTR; /*!< Specifies the type of frame for the received message.
  165. This parameter can be a value of @ref CAN_remote_transmission_request */
  166. uint32_t DLC; /*!< Specifies the length of the frame that will be received.
  167. This parameter must be a number between Min_Data = 0 and Max_Data = 8 */
  168. uint8_t Data[8]; /*!< Contains the data to be received.
  169. This parameter must be a number between Min_Data = 0 and Max_Data = 0xFF */
  170. uint32_t FMI; /*!< Specifies the index of the filter the message stored in the mailbox passes through.
  171. This parameter must be a number between Min_Data = 0 and Max_Data = 0xFF */
  172. uint32_t FIFONumber; /*!< Specifies the receive FIFO number.
  173. This parameter can be CAN_FIFO0 or CAN_FIFO1 */
  174. }CanRxMsgTypeDef;
  175. /**
  176. * @brief CAN handle Structure definition
  177. */
  178. typedef struct
  179. {
  180. CAN_TypeDef *Instance; /*!< Register base address */
  181. CAN_InitTypeDef Init; /*!< CAN required parameters */
  182. CanTxMsgTypeDef* pTxMsg; /*!< Pointer to transmit structure */
  183. CanRxMsgTypeDef* pRxMsg; /*!< Pointer to reception structure */
  184. __IO HAL_CAN_StateTypeDef State; /*!< CAN communication state */
  185. HAL_LockTypeDef Lock; /*!< CAN locking object */
  186. __IO uint32_t ErrorCode; /*!< CAN Error code */
  187. }CAN_HandleTypeDef;
  188. /**
  189. * @}
  190. */
  191. /* Exported constants --------------------------------------------------------*/
  192. /** @defgroup CAN_Exported_Constants CAN Exported Constants
  193. * @{
  194. */
  195. /** @defgroup CAN_Error_Code CAN Error Code
  196. * @{
  197. */
  198. #define HAL_CAN_ERROR_NONE 0x00U /*!< No error */
  199. #define HAL_CAN_ERROR_EWG 0x01U /*!< EWG error */
  200. #define HAL_CAN_ERROR_EPV 0x02U /*!< EPV error */
  201. #define HAL_CAN_ERROR_BOF 0x04U /*!< BOF error */
  202. #define HAL_CAN_ERROR_STF 0x08U /*!< Stuff error */
  203. #define HAL_CAN_ERROR_FOR 0x10U /*!< Form error */
  204. #define HAL_CAN_ERROR_ACK 0x20U /*!< Acknowledgment error */
  205. #define HAL_CAN_ERROR_BR 0x40U /*!< Bit recessive */
  206. #define HAL_CAN_ERROR_BD 0x80U /*!< LEC dominant */
  207. #define HAL_CAN_ERROR_CRC 0x100U /*!< LEC transfer error */
  208. /**
  209. * @}
  210. */
  211. /** @defgroup CAN_InitStatus CAN InitStatus
  212. * @{
  213. */
  214. #define CAN_INITSTATUS_FAILED ((uint8_t)0x00U) /*!< CAN initialization failed */
  215. #define CAN_INITSTATUS_SUCCESS ((uint8_t)0x01U) /*!< CAN initialization OK */
  216. /**
  217. * @}
  218. */
  219. /** @defgroup CAN_operating_mode CAN Operating Mode
  220. * @{
  221. */
  222. #define CAN_MODE_NORMAL ((uint32_t)0x00000000U) /*!< Normal mode */
  223. #define CAN_MODE_LOOPBACK ((uint32_t)CAN_BTR_LBKM) /*!< Loopback mode */
  224. #define CAN_MODE_SILENT ((uint32_t)CAN_BTR_SILM) /*!< Silent mode */
  225. #define CAN_MODE_SILENT_LOOPBACK ((uint32_t)(CAN_BTR_LBKM | CAN_BTR_SILM)) /*!< Loopback combined with silent mode */
  226. /**
  227. * @}
  228. */
  229. /** @defgroup CAN_synchronisation_jump_width CAN Synchronisation Jump Width
  230. * @{
  231. */
  232. #define CAN_SJW_1TQ ((uint32_t)0x00000000U) /*!< 1 time quantum */
  233. #define CAN_SJW_2TQ ((uint32_t)CAN_BTR_SJW_0) /*!< 2 time quantum */
  234. #define CAN_SJW_3TQ ((uint32_t)CAN_BTR_SJW_1) /*!< 3 time quantum */
  235. #define CAN_SJW_4TQ ((uint32_t)CAN_BTR_SJW) /*!< 4 time quantum */
  236. /**
  237. * @}
  238. */
  239. /** @defgroup CAN_time_quantum_in_bit_segment_1 CAN Time Quantum in bit segment 1
  240. * @{
  241. */
  242. #define CAN_BS1_1TQ ((uint32_t)0x00000000U) /*!< 1 time quantum */
  243. #define CAN_BS1_2TQ ((uint32_t)CAN_BTR_TS1_0) /*!< 2 time quantum */
  244. #define CAN_BS1_3TQ ((uint32_t)CAN_BTR_TS1_1) /*!< 3 time quantum */
  245. #define CAN_BS1_4TQ ((uint32_t)(CAN_BTR_TS1_1 | CAN_BTR_TS1_0)) /*!< 4 time quantum */
  246. #define CAN_BS1_5TQ ((uint32_t)CAN_BTR_TS1_2) /*!< 5 time quantum */
  247. #define CAN_BS1_6TQ ((uint32_t)(CAN_BTR_TS1_2 | CAN_BTR_TS1_0)) /*!< 6 time quantum */
  248. #define CAN_BS1_7TQ ((uint32_t)(CAN_BTR_TS1_2 | CAN_BTR_TS1_1)) /*!< 7 time quantum */
  249. #define CAN_BS1_8TQ ((uint32_t)(CAN_BTR_TS1_2 | CAN_BTR_TS1_1 | CAN_BTR_TS1_0)) /*!< 8 time quantum */
  250. #define CAN_BS1_9TQ ((uint32_t)CAN_BTR_TS1_3) /*!< 9 time quantum */
  251. #define CAN_BS1_10TQ ((uint32_t)(CAN_BTR_TS1_3 | CAN_BTR_TS1_0)) /*!< 10 time quantum */
  252. #define CAN_BS1_11TQ ((uint32_t)(CAN_BTR_TS1_3 | CAN_BTR_TS1_1)) /*!< 11 time quantum */
  253. #define CAN_BS1_12TQ ((uint32_t)(CAN_BTR_TS1_3 | CAN_BTR_TS1_1 | CAN_BTR_TS1_0)) /*!< 12 time quantum */
  254. #define CAN_BS1_13TQ ((uint32_t)(CAN_BTR_TS1_3 | CAN_BTR_TS1_2)) /*!< 13 time quantum */
  255. #define CAN_BS1_14TQ ((uint32_t)(CAN_BTR_TS1_3 | CAN_BTR_TS1_2 | CAN_BTR_TS1_0)) /*!< 14 time quantum */
  256. #define CAN_BS1_15TQ ((uint32_t)(CAN_BTR_TS1_3 | CAN_BTR_TS1_2 | CAN_BTR_TS1_1)) /*!< 15 time quantum */
  257. #define CAN_BS1_16TQ ((uint32_t)CAN_BTR_TS1) /*!< 16 time quantum */
  258. /**
  259. * @}
  260. */
  261. /** @defgroup CAN_time_quantum_in_bit_segment_2 CAN Time Quantum in bit segment 2
  262. * @{
  263. */
  264. #define CAN_BS2_1TQ ((uint32_t)0x00000000U) /*!< 1 time quantum */
  265. #define CAN_BS2_2TQ ((uint32_t)CAN_BTR_TS2_0) /*!< 2 time quantum */
  266. #define CAN_BS2_3TQ ((uint32_t)CAN_BTR_TS2_1) /*!< 3 time quantum */
  267. #define CAN_BS2_4TQ ((uint32_t)(CAN_BTR_TS2_1 | CAN_BTR_TS2_0)) /*!< 4 time quantum */
  268. #define CAN_BS2_5TQ ((uint32_t)CAN_BTR_TS2_2) /*!< 5 time quantum */
  269. #define CAN_BS2_6TQ ((uint32_t)(CAN_BTR_TS2_2 | CAN_BTR_TS2_0)) /*!< 6 time quantum */
  270. #define CAN_BS2_7TQ ((uint32_t)(CAN_BTR_TS2_2 | CAN_BTR_TS2_1)) /*!< 7 time quantum */
  271. #define CAN_BS2_8TQ ((uint32_t)CAN_BTR_TS2) /*!< 8 time quantum */
  272. /**
  273. * @}
  274. */
  275. /** @defgroup CAN_filter_mode CAN Filter Mode
  276. * @{
  277. */
  278. #define CAN_FILTERMODE_IDMASK ((uint8_t)0x00U) /*!< Identifier mask mode */
  279. #define CAN_FILTERMODE_IDLIST ((uint8_t)0x01U) /*!< Identifier list mode */
  280. /**
  281. * @}
  282. */
  283. /** @defgroup CAN_filter_scale CAN Filter Scale
  284. * @{
  285. */
  286. #define CAN_FILTERSCALE_16BIT ((uint8_t)0x00U) /*!< Two 16-bit filters */
  287. #define CAN_FILTERSCALE_32BIT ((uint8_t)0x01U) /*!< One 32-bit filter */
  288. /**
  289. * @}
  290. */
  291. /** @defgroup CAN_filter_FIFO CAN Filter FIFO
  292. * @{
  293. */
  294. #define CAN_FILTER_FIFO0 ((uint8_t)0x00U) /*!< Filter FIFO 0 assignment for filter x */
  295. #define CAN_FILTER_FIFO1 ((uint8_t)0x01U) /*!< Filter FIFO 1 assignment for filter x */
  296. /**
  297. * @}
  298. */
  299. /** @defgroup CAN_Identifier_Type CAN Identifier Type
  300. * @{
  301. */
  302. #define CAN_ID_STD ((uint32_t)0x00000000U) /*!< Standard Id */
  303. #define CAN_ID_EXT ((uint32_t)0x00000004U) /*!< Extended Id */
  304. /**
  305. * @}
  306. */
  307. /** @defgroup CAN_remote_transmission_request CAN Remote Transmission Request
  308. * @{
  309. */
  310. #define CAN_RTR_DATA ((uint32_t)0x00000000U) /*!< Data frame */
  311. #define CAN_RTR_REMOTE ((uint32_t)0x00000002U) /*!< Remote frame */
  312. /**
  313. * @}
  314. */
  315. /** @defgroup CAN_receive_FIFO_number_constants CAN Receive FIFO Number Constants
  316. * @{
  317. */
  318. #define CAN_FIFO0 ((uint8_t)0x00U) /*!< CAN FIFO 0 used to receive */
  319. #define CAN_FIFO1 ((uint8_t)0x01U) /*!< CAN FIFO 1 used to receive */
  320. /**
  321. * @}
  322. */
  323. /** @defgroup CAN_flags CAN Flags
  324. * @{
  325. */
  326. /* If the flag is 0x3XXXXXXX, it means that it can be used with CAN_GetFlagStatus()
  327. and CAN_ClearFlag() functions. */
  328. /* If the flag is 0x1XXXXXXX, it means that it can only be used with
  329. CAN_GetFlagStatus() function. */
  330. /* Transmit Flags */
  331. #define CAN_FLAG_RQCP0 ((uint32_t)0x00000500U) /*!< Request MailBox0 flag */
  332. #define CAN_FLAG_RQCP1 ((uint32_t)0x00000508U) /*!< Request MailBox1 flag */
  333. #define CAN_FLAG_RQCP2 ((uint32_t)0x00000510U) /*!< Request MailBox2 flag */
  334. #define CAN_FLAG_TXOK0 ((uint32_t)0x00000501U) /*!< Transmission OK MailBox0 flag */
  335. #define CAN_FLAG_TXOK1 ((uint32_t)0x00000509U) /*!< Transmission OK MailBox1 flag */
  336. #define CAN_FLAG_TXOK2 ((uint32_t)0x00000511U) /*!< Transmission OK MailBox2 flag */
  337. #define CAN_FLAG_TME0 ((uint32_t)0x0000051AU) /*!< Transmit mailbox 0 empty flag */
  338. #define CAN_FLAG_TME1 ((uint32_t)0x0000051BU) /*!< Transmit mailbox 0 empty flag */
  339. #define CAN_FLAG_TME2 ((uint32_t)0x0000051CU) /*!< Transmit mailbox 0 empty flag */
  340. /* Receive Flags */
  341. #define CAN_FLAG_FF0 ((uint32_t)0x00000203U) /*!< FIFO 0 Full flag */
  342. #define CAN_FLAG_FOV0 ((uint32_t)0x00000204U) /*!< FIFO 0 Overrun flag */
  343. #define CAN_FLAG_FF1 ((uint32_t)0x00000403U) /*!< FIFO 1 Full flag */
  344. #define CAN_FLAG_FOV1 ((uint32_t)0x00000404U) /*!< FIFO 1 Overrun flag */
  345. /* Operating Mode Flags */
  346. #define CAN_FLAG_INAK ((uint32_t)0x00000100U) /*!< Initialization acknowledge flag */
  347. #define CAN_FLAG_SLAK ((uint32_t)0x00000101U) /*!< Sleep acknowledge flag */
  348. #define CAN_FLAG_ERRI ((uint32_t)0x00000102U) /*!< Error flag */
  349. #define CAN_FLAG_WKU ((uint32_t)0x00000103U) /*!< Wake up flag */
  350. #define CAN_FLAG_SLAKI ((uint32_t)0x00000104U) /*!< Sleep acknowledge flag */
  351. /* @note When SLAK interrupt is disabled (SLKIE=0), no polling on SLAKI is possible.
  352. In this case the SLAK bit can be polled.*/
  353. /* Error Flags */
  354. #define CAN_FLAG_EWG ((uint32_t)0x00000300U) /*!< Error warning flag */
  355. #define CAN_FLAG_EPV ((uint32_t)0x00000301U) /*!< Error passive flag */
  356. #define CAN_FLAG_BOF ((uint32_t)0x00000302U) /*!< Bus-Off flag */
  357. /**
  358. * @}
  359. */
  360. /** @defgroup CAN_Interrupts CAN Interrupts
  361. * @{
  362. */
  363. #define CAN_IT_TME ((uint32_t)CAN_IER_TMEIE) /*!< Transmit mailbox empty interrupt */
  364. /* Receive Interrupts */
  365. #define CAN_IT_FMP0 ((uint32_t)CAN_IER_FMPIE0) /*!< FIFO 0 message pending interrupt */
  366. #define CAN_IT_FF0 ((uint32_t)CAN_IER_FFIE0) /*!< FIFO 0 full interrupt */
  367. #define CAN_IT_FOV0 ((uint32_t)CAN_IER_FOVIE0) /*!< FIFO 0 overrun interrupt */
  368. #define CAN_IT_FMP1 ((uint32_t)CAN_IER_FMPIE1) /*!< FIFO 1 message pending interrupt */
  369. #define CAN_IT_FF1 ((uint32_t)CAN_IER_FFIE1) /*!< FIFO 1 full interrupt */
  370. #define CAN_IT_FOV1 ((uint32_t)CAN_IER_FOVIE1) /*!< FIFO 1 overrun interrupt */
  371. /* Operating Mode Interrupts */
  372. #define CAN_IT_WKU ((uint32_t)CAN_IER_WKUIE) /*!< Wake-up interrupt */
  373. #define CAN_IT_SLK ((uint32_t)CAN_IER_SLKIE) /*!< Sleep acknowledge interrupt */
  374. /* Error Interrupts */
  375. #define CAN_IT_EWG ((uint32_t)CAN_IER_EWGIE) /*!< Error warning interrupt */
  376. #define CAN_IT_EPV ((uint32_t)CAN_IER_EPVIE) /*!< Error passive interrupt */
  377. #define CAN_IT_BOF ((uint32_t)CAN_IER_BOFIE) /*!< Bus-off interrupt */
  378. #define CAN_IT_LEC ((uint32_t)CAN_IER_LECIE) /*!< Last error code interrupt */
  379. #define CAN_IT_ERR ((uint32_t)CAN_IER_ERRIE) /*!< Error Interrupt */
  380. /**
  381. * @}
  382. */
  383. /** @defgroup CAN_Mailboxes_Definition CAN Mailboxes Definition
  384. * @{
  385. */
  386. #define CAN_TXMAILBOX_0 ((uint8_t)0x00U)
  387. #define CAN_TXMAILBOX_1 ((uint8_t)0x01U)
  388. #define CAN_TXMAILBOX_2 ((uint8_t)0x02U)
  389. /**
  390. * @}
  391. */
  392. /**
  393. * @}
  394. */
  395. /* Exported macro ------------------------------------------------------------*/
  396. /** @defgroup CAN_Exported_Macros CAN Exported Macros
  397. * @{
  398. */
  399. /** @brief Reset CAN handle state
  400. * @param __HANDLE__: specifies the CAN Handle.
  401. * @retval None
  402. */
  403. #define __HAL_CAN_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_CAN_STATE_RESET)
  404. /**
  405. * @brief Enable the specified CAN interrupts.
  406. * @param __HANDLE__: CAN handle
  407. * @param __INTERRUPT__: CAN Interrupt
  408. * @retval None
  409. */
  410. #define __HAL_CAN_ENABLE_IT(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->IER) |= (__INTERRUPT__))
  411. /**
  412. * @brief Disable the specified CAN interrupts.
  413. * @param __HANDLE__: CAN handle
  414. * @param __INTERRUPT__: CAN Interrupt
  415. * @retval None
  416. */
  417. #define __HAL_CAN_DISABLE_IT(__HANDLE__, __INTERRUPT__) (((__HANDLE__)->Instance->IER) &= ~(__INTERRUPT__))
  418. /**
  419. * @brief Return the number of pending received messages.
  420. * @param __HANDLE__: CAN handle
  421. * @param __FIFONUMBER__: Receive FIFO number, CAN_FIFO0 or CAN_FIFO1.
  422. * @retval The number of pending message.
  423. */
  424. #define __HAL_CAN_MSG_PENDING(__HANDLE__, __FIFONUMBER__) (((__FIFONUMBER__) == CAN_FIFO0)? \
  425. ((uint8_t)((__HANDLE__)->Instance->RF0R&(uint32_t)0x03U)) : ((uint8_t)((__HANDLE__)->Instance->RF1R & (uint32_t)0x03U)))
  426. /** @brief Check whether the specified CAN flag is set or not.
  427. * @param __HANDLE__: CAN Handle
  428. * @param __FLAG__: specifies the flag to check.
  429. * This parameter can be one of the following values:
  430. * @arg CAN_TSR_RQCP0: Request MailBox0 Flag
  431. * @arg CAN_TSR_RQCP1: Request MailBox1 Flag
  432. * @arg CAN_TSR_RQCP2: Request MailBox2 Flag
  433. * @arg CAN_FLAG_TXOK0: Transmission OK MailBox0 Flag
  434. * @arg CAN_FLAG_TXOK1: Transmission OK MailBox1 Flag
  435. * @arg CAN_FLAG_TXOK2: Transmission OK MailBox2 Flag
  436. * @arg CAN_FLAG_TME0: Transmit mailbox 0 empty Flag
  437. * @arg CAN_FLAG_TME1: Transmit mailbox 1 empty Flag
  438. * @arg CAN_FLAG_TME2: Transmit mailbox 2 empty Flag
  439. * @arg CAN_FLAG_FMP0: FIFO 0 Message Pending Flag
  440. * @arg CAN_FLAG_FF0: FIFO 0 Full Flag
  441. * @arg CAN_FLAG_FOV0: FIFO 0 Overrun Flag
  442. * @arg CAN_FLAG_FMP1: FIFO 1 Message Pending Flag
  443. * @arg CAN_FLAG_FF1: FIFO 1 Full Flag
  444. * @arg CAN_FLAG_FOV1: FIFO 1 Overrun Flag
  445. * @arg CAN_FLAG_WKU: Wake up Flag
  446. * @arg CAN_FLAG_SLAK: Sleep acknowledge Flag
  447. * @arg CAN_FLAG_SLAKI: Sleep acknowledge Flag
  448. * @arg CAN_FLAG_EWG: Error Warning Flag
  449. * @arg CAN_FLAG_EPV: Error Passive Flag
  450. * @arg CAN_FLAG_BOF: Bus-Off Flag
  451. * @retval The new state of __FLAG__ (TRUE or FALSE).
  452. */
  453. #define __HAL_CAN_GET_FLAG(__HANDLE__, __FLAG__) \
  454. ((((__FLAG__) >> 8U) == 5U)? ((((__HANDLE__)->Instance->TSR) & (1U << ((__FLAG__) & CAN_FLAG_MASK))) == (1U << ((__FLAG__) & CAN_FLAG_MASK))): \
  455. (((__FLAG__) >> 8U) == 2U)? ((((__HANDLE__)->Instance->RF0R) & (1U << ((__FLAG__) & CAN_FLAG_MASK))) == (1U << ((__FLAG__) & CAN_FLAG_MASK))): \
  456. (((__FLAG__) >> 8U) == 4U)? ((((__HANDLE__)->Instance->RF1R) & (1U << ((__FLAG__) & CAN_FLAG_MASK))) == (1U << ((__FLAG__) & CAN_FLAG_MASK))): \
  457. (((__FLAG__) >> 8U) == 1U)? ((((__HANDLE__)->Instance->MSR) & (1U << ((__FLAG__) & CAN_FLAG_MASK))) == (1U << ((__FLAG__) & CAN_FLAG_MASK))): \
  458. ((((__HANDLE__)->Instance->ESR) & (1U << ((__FLAG__) & CAN_FLAG_MASK))) == (1U << ((__FLAG__) & CAN_FLAG_MASK))))
  459. /** @brief Clear the specified CAN pending flag.
  460. * @param __HANDLE__: CAN Handle.
  461. * @param __FLAG__: specifies the flag to check.
  462. * This parameter can be one of the following values:
  463. * @arg CAN_TSR_RQCP0: Request MailBox0 Flag
  464. * @arg CAN_TSR_RQCP1: Request MailBox1 Flag
  465. * @arg CAN_TSR_RQCP2: Request MailBox2 Flag
  466. * @arg CAN_FLAG_TXOK0: Transmission OK MailBox0 Flag
  467. * @arg CAN_FLAG_TXOK1: Transmission OK MailBox1 Flag
  468. * @arg CAN_FLAG_TXOK2: Transmission OK MailBox2 Flag
  469. * @arg CAN_FLAG_TME0: Transmit mailbox 0 empty Flag
  470. * @arg CAN_FLAG_TME1: Transmit mailbox 1 empty Flag
  471. * @arg CAN_FLAG_TME2: Transmit mailbox 2 empty Flag
  472. * @arg CAN_FLAG_FMP0: FIFO 0 Message Pending Flag
  473. * @arg CAN_FLAG_FF0: FIFO 0 Full Flag
  474. * @arg CAN_FLAG_FOV0: FIFO 0 Overrun Flag
  475. * @arg CAN_FLAG_FMP1: FIFO 1 Message Pending Flag
  476. * @arg CAN_FLAG_FF1: FIFO 1 Full Flag
  477. * @arg CAN_FLAG_FOV1: FIFO 1 Overrun Flag
  478. * @arg CAN_FLAG_WKU: Wake up Flag
  479. * @arg CAN_FLAG_SLAK: Sleep acknowledge Flag
  480. * @arg CAN_FLAG_SLAKI: Sleep acknowledge Flag
  481. * @retval The new state of __FLAG__ (TRUE or FALSE).
  482. */
  483. #define __HAL_CAN_CLEAR_FLAG(__HANDLE__, __FLAG__) \
  484. ((((__FLAG__) >> 8U) == 5U)? (((__HANDLE__)->Instance->TSR) = ((uint32_t)1U << ((__FLAG__) & CAN_FLAG_MASK))): \
  485. (((__FLAG__) >> 8U) == 2U)? (((__HANDLE__)->Instance->RF0R) = ((uint32_t)1U << ((__FLAG__) & CAN_FLAG_MASK))): \
  486. (((__FLAG__) >> 8U) == 4U)? (((__HANDLE__)->Instance->RF1R) = ((uint32_t)1U << ((__FLAG__) & CAN_FLAG_MASK))): \
  487. (((__HANDLE__)->Instance->MSR) = ((uint32_t)1U << ((__FLAG__) & CAN_FLAG_MASK))))
  488. /** @brief Check if the specified CAN interrupt source is enabled or disabled.
  489. * @param __HANDLE__: CAN Handle
  490. * @param __INTERRUPT__: specifies the CAN interrupt source to check.
  491. * This parameter can be one of the following values:
  492. * @arg CAN_IT_TME: Transmit mailbox empty interrupt enable
  493. * @arg CAN_IT_FMP0: FIFO0 message pending interrupt enable
  494. * @arg CAN_IT_FMP1: FIFO1 message pending interrupt enable
  495. * @retval The new state of __IT__ (TRUE or FALSE).
  496. */
  497. #define __HAL_CAN_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->IER & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
  498. /**
  499. * @brief Check the transmission status of a CAN Frame.
  500. * @param __HANDLE__: CAN Handle
  501. * @param __TRANSMITMAILBOX__: the number of the mailbox that is used for transmission.
  502. * @retval The new status of transmission (TRUE or FALSE).
  503. */
  504. #define __HAL_CAN_TRANSMIT_STATUS(__HANDLE__, __TRANSMITMAILBOX__)\
  505. (((__TRANSMITMAILBOX__) == CAN_TXMAILBOX_0)? ((((__HANDLE__)->Instance->TSR) & (CAN_TSR_RQCP0 | CAN_TSR_TXOK0 | CAN_TSR_TME0)) == (CAN_TSR_RQCP0 | CAN_TSR_TXOK0 | CAN_TSR_TME0)) :\
  506. ((__TRANSMITMAILBOX__) == CAN_TXMAILBOX_1)? ((((__HANDLE__)->Instance->TSR) & (CAN_TSR_RQCP1 | CAN_TSR_TXOK1 | CAN_TSR_TME1)) == (CAN_TSR_RQCP1 | CAN_TSR_TXOK1 | CAN_TSR_TME1)) :\
  507. ((((__HANDLE__)->Instance->TSR) & (CAN_TSR_RQCP2 | CAN_TSR_TXOK2 | CAN_TSR_TME2)) == (CAN_TSR_RQCP2 | CAN_TSR_TXOK2 | CAN_TSR_TME2)))
  508. /**
  509. * @brief Release the specified receive FIFO.
  510. * @param __HANDLE__: CAN handle
  511. * @param __FIFONUMBER__: Receive FIFO number, CAN_FIFO0 or CAN_FIFO1.
  512. * @retval None
  513. */
  514. #define __HAL_CAN_FIFO_RELEASE(__HANDLE__, __FIFONUMBER__) (((__FIFONUMBER__) == CAN_FIFO0)? \
  515. ((__HANDLE__)->Instance->RF0R = CAN_RF0R_RFOM0) : ((__HANDLE__)->Instance->RF1R = CAN_RF1R_RFOM1))
  516. /**
  517. * @brief Cancel a transmit request.
  518. * @param __HANDLE__: CAN Handle
  519. * @param __TRANSMITMAILBOX__: the number of the mailbox that is used for transmission.
  520. * @retval None
  521. */
  522. #define __HAL_CAN_CANCEL_TRANSMIT(__HANDLE__, __TRANSMITMAILBOX__)\
  523. (((__TRANSMITMAILBOX__) == CAN_TXMAILBOX_0)? ((__HANDLE__)->Instance->TSR = CAN_TSR_ABRQ0) :\
  524. ((__TRANSMITMAILBOX__) == CAN_TXMAILBOX_1)? ((__HANDLE__)->Instance->TSR = CAN_TSR_ABRQ1) :\
  525. ((__HANDLE__)->Instance->TSR = CAN_TSR_ABRQ2))
  526. /**
  527. * @brief Enable or disable the DBG Freeze for CAN.
  528. * @param __HANDLE__: CAN Handle
  529. * @param __NEWSTATE__: new state of the CAN peripheral.
  530. * This parameter can be: ENABLE (CAN reception/transmission is frozen
  531. * during debug. Reception FIFOs can still be accessed/controlled normally)
  532. * or DISABLE (CAN is working during debug).
  533. * @retval None
  534. */
  535. #define __HAL_CAN_DBG_FREEZE(__HANDLE__, __NEWSTATE__) (((__NEWSTATE__) == ENABLE)? \
  536. ((__HANDLE__)->Instance->MCR |= CAN_MCR_DBF) : ((__HANDLE__)->Instance->MCR &= ~CAN_MCR_DBF))
  537. /**
  538. * @}
  539. */
  540. /* Exported functions --------------------------------------------------------*/
  541. /** @addtogroup CAN_Exported_Functions
  542. * @{
  543. */
  544. /** @addtogroup CAN_Exported_Functions_Group1
  545. * @{
  546. */
  547. /* Initialization/de-initialization functions ***********************************/
  548. HAL_StatusTypeDef HAL_CAN_Init(CAN_HandleTypeDef* hcan);
  549. HAL_StatusTypeDef HAL_CAN_ConfigFilter(CAN_HandleTypeDef* hcan, CAN_FilterConfTypeDef* sFilterConfig);
  550. HAL_StatusTypeDef HAL_CAN_DeInit(CAN_HandleTypeDef* hcan);
  551. void HAL_CAN_MspInit(CAN_HandleTypeDef* hcan);
  552. void HAL_CAN_MspDeInit(CAN_HandleTypeDef* hcan);
  553. /**
  554. * @}
  555. */
  556. /** @addtogroup CAN_Exported_Functions_Group2
  557. * @{
  558. */
  559. /* I/O operation functions ******************************************************/
  560. HAL_StatusTypeDef HAL_CAN_Transmit(CAN_HandleTypeDef *hcan, uint32_t Timeout);
  561. HAL_StatusTypeDef HAL_CAN_Transmit_IT(CAN_HandleTypeDef *hcan);
  562. HAL_StatusTypeDef HAL_CAN_Receive(CAN_HandleTypeDef *hcan, uint8_t FIFONumber, uint32_t Timeout);
  563. HAL_StatusTypeDef HAL_CAN_Receive_IT(CAN_HandleTypeDef *hcan, uint8_t FIFONumber);
  564. HAL_StatusTypeDef HAL_CAN_Sleep(CAN_HandleTypeDef *hcan);
  565. HAL_StatusTypeDef HAL_CAN_WakeUp(CAN_HandleTypeDef *hcan);
  566. void HAL_CAN_IRQHandler(CAN_HandleTypeDef* hcan);
  567. void HAL_CAN_TxCpltCallback(CAN_HandleTypeDef* hcan);
  568. void HAL_CAN_RxCpltCallback(CAN_HandleTypeDef* hcan);
  569. void HAL_CAN_ErrorCallback(CAN_HandleTypeDef *hcan);
  570. /**
  571. * @}
  572. */
  573. /** @addtogroup CAN_Exported_Functions_Group3
  574. * @{
  575. */
  576. /* Peripheral State functions ***************************************************/
  577. uint32_t HAL_CAN_GetError(CAN_HandleTypeDef *hcan);
  578. HAL_CAN_StateTypeDef HAL_CAN_GetState(CAN_HandleTypeDef* hcan);
  579. /**
  580. * @}
  581. */
  582. /**
  583. * @}
  584. */
  585. /* Private types -------------------------------------------------------------*/
  586. /** @defgroup CAN_Private_Types CAN Private Types
  587. * @{
  588. */
  589. /**
  590. * @}
  591. */
  592. /* Private variables ---------------------------------------------------------*/
  593. /** @defgroup CAN_Private_Variables CAN Private Variables
  594. * @{
  595. */
  596. /**
  597. * @}
  598. */
  599. /* Private constants ---------------------------------------------------------*/
  600. /** @defgroup CAN_Private_Constants CAN Private Constants
  601. * @{
  602. */
  603. #define CAN_TXSTATUS_NOMAILBOX ((uint8_t)0x04U) /*!< CAN cell did not provide CAN_TxStatus_NoMailBox */
  604. #define CAN_FLAG_MASK ((uint32_t)0x000000FFU)
  605. /**
  606. * @}
  607. */
  608. /* Private macros ------------------------------------------------------------*/
  609. /** @defgroup CAN_Private_Macros CAN Private Macros
  610. * @{
  611. */
  612. #define IS_CAN_MODE(MODE) (((MODE) == CAN_MODE_NORMAL) || \
  613. ((MODE) == CAN_MODE_LOOPBACK)|| \
  614. ((MODE) == CAN_MODE_SILENT) || \
  615. ((MODE) == CAN_MODE_SILENT_LOOPBACK))
  616. #define IS_CAN_SJW(SJW) (((SJW) == CAN_SJW_1TQ) || ((SJW) == CAN_SJW_2TQ)|| \
  617. ((SJW) == CAN_SJW_3TQ) || ((SJW) == CAN_SJW_4TQ))
  618. #define IS_CAN_BS1(BS1) ((BS1) <= CAN_BS1_16TQ)
  619. #define IS_CAN_BS2(BS2) ((BS2) <= CAN_BS2_8TQ)
  620. #define IS_CAN_PRESCALER(PRESCALER) (((PRESCALER) >= 1U) && ((PRESCALER) <= 1024U))
  621. #define IS_CAN_FILTER_NUMBER(NUMBER) ((NUMBER) <= 27U)
  622. #define IS_CAN_FILTER_MODE(MODE) (((MODE) == CAN_FILTERMODE_IDMASK) || \
  623. ((MODE) == CAN_FILTERMODE_IDLIST))
  624. #define IS_CAN_FILTER_SCALE(SCALE) (((SCALE) == CAN_FILTERSCALE_16BIT) || \
  625. ((SCALE) == CAN_FILTERSCALE_32BIT))
  626. #define IS_CAN_FILTER_FIFO(FIFO) (((FIFO) == CAN_FILTER_FIFO0) || \
  627. ((FIFO) == CAN_FILTER_FIFO1))
  628. #define IS_CAN_BANKNUMBER(BANKNUMBER) ((BANKNUMBER) <= 28U)
  629. #define IS_CAN_TRANSMITMAILBOX(TRANSMITMAILBOX) ((TRANSMITMAILBOX) <= ((uint8_t)0x02U))
  630. #define IS_CAN_STDID(STDID) ((STDID) <= ((uint32_t)0x7FFU))
  631. #define IS_CAN_EXTID(EXTID) ((EXTID) <= ((uint32_t)0x1FFFFFFFU))
  632. #define IS_CAN_DLC(DLC) ((DLC) <= ((uint8_t)0x08U))
  633. #define IS_CAN_IDTYPE(IDTYPE) (((IDTYPE) == CAN_ID_STD) || \
  634. ((IDTYPE) == CAN_ID_EXT))
  635. #define IS_CAN_RTR(RTR) (((RTR) == CAN_RTR_DATA) || ((RTR) == CAN_RTR_REMOTE))
  636. #define IS_CAN_FIFO(FIFO) (((FIFO) == CAN_FIFO0) || ((FIFO) == CAN_FIFO1))
  637. /**
  638. * @}
  639. */
  640. /* Private functions ---------------------------------------------------------*/
  641. /** @defgroup CAN_Private_Functions CAN Private Functions
  642. * @{
  643. */
  644. /**
  645. * @}
  646. */
  647. #endif /* STM32F405xx || STM32F415xx || STM32F407xx || STM32F417xx || STM32F427xx || STM32F437xx ||\
  648. STM32F429xx || STM32F439xx || STM32F446xx || STM32F469xx || STM32F479xx || STM32F412Zx ||\
  649. STM32F412Vx || STM32F412Rx || STM32F412Cx */
  650. /**
  651. * @}
  652. */
  653. /**
  654. * @}
  655. */
  656. #ifdef __cplusplus
  657. }
  658. #endif
  659. #endif /* __STM32F4xx_CAN_H */
  660. /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/