stm32f7xx_hal_can_legacy.h 35 KB

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