Driver_CAN.h 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377
  1. /*
  2. * Copyright (c) 2015-2017 ARM Limited. All rights reserved.
  3. *
  4. * SPDX-License-Identifier: Apache-2.0
  5. *
  6. * Licensed under the Apache License, Version 2.0 (the License); you may
  7. * not use this file except in compliance with the License.
  8. * You may obtain a copy of the License at
  9. *
  10. * www.apache.org/licenses/LICENSE-2.0
  11. *
  12. * Unless required by applicable law or agreed to in writing, software
  13. * distributed under the License is distributed on an AS IS BASIS, WITHOUT
  14. * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15. * See the License for the specific language governing permissions and
  16. * limitations under the License.
  17. *
  18. * $Date: 2. Feb 2017
  19. * $Revision: V1.1
  20. *
  21. * Project: CAN (Controller Area Network) Driver definitions
  22. */
  23. /* History:
  24. * Version 1.1
  25. * ARM_CAN_STATUS made volatile
  26. * Version 1.0
  27. * Initial release
  28. */
  29. #ifndef DRIVER_CAN_H_
  30. #define DRIVER_CAN_H_
  31. #ifdef __cplusplus
  32. extern "C"
  33. {
  34. #endif
  35. #include "Driver_Common.h"
  36. #define ARM_CAN_API_VERSION ARM_DRIVER_VERSION_MAJOR_MINOR(1,1) /* API version */
  37. /****** CAN Bitrate selection codes *****/
  38. typedef enum _ARM_CAN_BITRATE_SELECT {
  39. ARM_CAN_BITRATE_NOMINAL, ///< Select nominal (flexible data-rate arbitration) bitrate
  40. ARM_CAN_BITRATE_FD_DATA ///< Select flexible data-rate data bitrate
  41. } ARM_CAN_BITRATE_SELECT;
  42. /****** CAN Bit Propagation Segment codes (PROP_SEG) *****/
  43. #define ARM_CAN_BIT_PROP_SEG_Pos 0UL ///< bits 7..0
  44. #define ARM_CAN_BIT_PROP_SEG_Msk (0xFFUL << ARM_CAN_BIT_PROP_SEG_Pos)
  45. #define ARM_CAN_BIT_PROP_SEG(x) (((x) << ARM_CAN_BIT_PROP_SEG_Pos) & ARM_CAN_BIT_PROP_SEG_Msk)
  46. /****** CAN Bit Phase Buffer Segment 1 (PHASE_SEG1) codes *****/
  47. #define ARM_CAN_BIT_PHASE_SEG1_Pos 8UL ///< bits 15..8
  48. #define ARM_CAN_BIT_PHASE_SEG1_Msk (0xFFUL << ARM_CAN_BIT_PHASE_SEG1_Pos)
  49. #define ARM_CAN_BIT_PHASE_SEG1(x) (((x) << ARM_CAN_BIT_PHASE_SEG1_Pos) & ARM_CAN_BIT_PHASE_SEG1_Msk)
  50. /****** CAN Bit Phase Buffer Segment 2 (PHASE_SEG2) codes *****/
  51. #define ARM_CAN_BIT_PHASE_SEG2_Pos 16UL ///< bits 23..16
  52. #define ARM_CAN_BIT_PHASE_SEG2_Msk (0xFFUL << ARM_CAN_BIT_PHASE_SEG2_Pos)
  53. #define ARM_CAN_BIT_PHASE_SEG2(x) (((x) << ARM_CAN_BIT_PHASE_SEG2_Pos) & ARM_CAN_BIT_PHASE_SEG2_Msk)
  54. /****** CAN Bit (Re)Synchronization Jump Width Segment (SJW) *****/
  55. #define ARM_CAN_BIT_SJW_Pos 24UL ///< bits 28..24
  56. #define ARM_CAN_BIT_SJW_Msk (0x1FUL << ARM_CAN_BIT_SJW_Pos)
  57. #define ARM_CAN_BIT_SJW(x) (((x) << ARM_CAN_BIT_SJW_Pos) & ARM_CAN_BIT_SJW_Msk)
  58. /****** CAN Mode codes *****/
  59. typedef enum _ARM_CAN_MODE {
  60. ARM_CAN_MODE_INITIALIZATION, ///< Initialization mode
  61. ARM_CAN_MODE_NORMAL, ///< Normal operation mode
  62. ARM_CAN_MODE_RESTRICTED, ///< Restricted operation mode
  63. ARM_CAN_MODE_MONITOR, ///< Bus monitoring mode
  64. ARM_CAN_MODE_LOOPBACK_INTERNAL, ///< Loopback internal mode
  65. ARM_CAN_MODE_LOOPBACK_EXTERNAL ///< Loopback external mode
  66. } ARM_CAN_MODE;
  67. /****** CAN Filter Operation codes *****/
  68. typedef enum _ARM_CAN_FILTER_OPERATION {
  69. ARM_CAN_FILTER_ID_EXACT_ADD, ///< Add exact id filter
  70. ARM_CAN_FILTER_ID_EXACT_REMOVE, ///< Remove exact id filter
  71. ARM_CAN_FILTER_ID_RANGE_ADD, ///< Add range id filter
  72. ARM_CAN_FILTER_ID_RANGE_REMOVE, ///< Remove range id filter
  73. ARM_CAN_FILTER_ID_MASKABLE_ADD, ///< Add maskable id filter
  74. ARM_CAN_FILTER_ID_MASKABLE_REMOVE ///< Remove maskable id filter
  75. } ARM_CAN_FILTER_OPERATION;
  76. /****** CAN Object Configuration codes *****/
  77. typedef enum _ARM_CAN_OBJ_CONFIG {
  78. ARM_CAN_OBJ_INACTIVE, ///< CAN object inactive
  79. ARM_CAN_OBJ_TX, ///< CAN transmit object
  80. ARM_CAN_OBJ_RX, ///< CAN receive object
  81. ARM_CAN_OBJ_RX_RTR_TX_DATA, ///< CAN object that on RTR reception automatically transmits Data Frame
  82. ARM_CAN_OBJ_TX_RTR_RX_DATA ///< CAN object that transmits RTR and automatically receives Data Frame
  83. } ARM_CAN_OBJ_CONFIG;
  84. /**
  85. \brief CAN Object Capabilities
  86. */
  87. typedef struct _ARM_CAN_OBJ_CAPABILITIES {
  88. uint32_t tx : 1; ///< Object supports transmission
  89. uint32_t rx : 1; ///< Object supports reception
  90. uint32_t rx_rtr_tx_data : 1; ///< Object supports RTR reception and automatic Data Frame transmission
  91. uint32_t tx_rtr_rx_data : 1; ///< Object supports RTR transmission and automatic Data Frame reception
  92. uint32_t multiple_filters : 1; ///< Object allows assignment of multiple filters to it
  93. uint32_t exact_filtering : 1; ///< Object supports exact identifier filtering
  94. uint32_t range_filtering : 1; ///< Object supports range identifier filtering
  95. uint32_t mask_filtering : 1; ///< Object supports mask identifier filtering
  96. uint32_t message_depth : 8; ///< Number of messages buffers (FIFO) for that object
  97. uint32_t reserved : 16; ///< Reserved (must be zero)
  98. } ARM_CAN_OBJ_CAPABILITIES;
  99. /****** CAN Control Function Operation codes *****/
  100. #define ARM_CAN_CONTROL_Pos 0UL
  101. #define ARM_CAN_CONTROL_Msk (0xFFUL << ARM_CAN_CONTROL_Pos)
  102. #define ARM_CAN_SET_FD_MODE (1UL << ARM_CAN_CONTROL_Pos) ///< Set FD operation mode; arg: 0 = disable, 1 = enable
  103. #define ARM_CAN_ABORT_MESSAGE_SEND (2UL << ARM_CAN_CONTROL_Pos) ///< Abort sending of CAN message; arg = object
  104. #define ARM_CAN_CONTROL_RETRANSMISSION (3UL << ARM_CAN_CONTROL_Pos) ///< Enable/disable automatic retransmission; arg: 0 = disable, 1 = enable (default state)
  105. #define ARM_CAN_SET_TRANSCEIVER_DELAY (4UL << ARM_CAN_CONTROL_Pos) ///< Set transceiver delay; arg = delay in time quanta
  106. /****** CAN ID Frame Format codes *****/
  107. #define ARM_CAN_ID_IDE_Pos 31UL
  108. #define ARM_CAN_ID_IDE_Msk (1UL << ARM_CAN_ID_IDE_Pos)
  109. /****** CAN Identifier encoding *****/
  110. #define ARM_CAN_STANDARD_ID(id) (id & 0x000007FFUL) ///< CAN identifier in standard format (11-bits)
  111. #define ARM_CAN_EXTENDED_ID(id) ((id & 0x1FFFFFFFUL) | ARM_CAN_ID_IDE_Msk)///< CAN identifier in extended format (29-bits)
  112. /**
  113. \brief CAN Message Information
  114. */
  115. typedef struct _ARM_CAN_MSG_INFO {
  116. uint32_t id; ///< CAN identifier with frame format specifier (bit 31)
  117. uint32_t rtr : 1; ///< Remote transmission request frame
  118. uint32_t edl : 1; ///< Flexible data-rate format extended data length
  119. uint32_t brs : 1; ///< Flexible data-rate format with bitrate switch
  120. uint32_t esi : 1; ///< Flexible data-rate format error state indicator
  121. uint32_t dlc : 4; ///< Data length code
  122. uint32_t reserved : 24;
  123. } ARM_CAN_MSG_INFO;
  124. /****** CAN specific error code *****/
  125. #define ARM_CAN_INVALID_BITRATE_SELECT (ARM_DRIVER_ERROR_SPECIFIC - 1) ///< Bitrate selection not supported
  126. #define ARM_CAN_INVALID_BITRATE (ARM_DRIVER_ERROR_SPECIFIC - 2) ///< Requested bitrate not supported
  127. #define ARM_CAN_INVALID_BIT_PROP_SEG (ARM_DRIVER_ERROR_SPECIFIC - 3) ///< Propagation segment value not supported
  128. #define ARM_CAN_INVALID_BIT_PHASE_SEG1 (ARM_DRIVER_ERROR_SPECIFIC - 4) ///< Phase segment 1 value not supported
  129. #define ARM_CAN_INVALID_BIT_PHASE_SEG2 (ARM_DRIVER_ERROR_SPECIFIC - 5) ///< Phase segment 2 value not supported
  130. #define ARM_CAN_INVALID_BIT_SJW (ARM_DRIVER_ERROR_SPECIFIC - 6) ///< SJW value not supported
  131. #define ARM_CAN_NO_MESSAGE_AVAILABLE (ARM_DRIVER_ERROR_SPECIFIC - 7) ///< Message is not available
  132. /****** CAN Status codes *****/
  133. #define ARM_CAN_UNIT_STATE_INACTIVE (0U) ///< Unit state: Not active on bus (initialize or error bus off)
  134. #define ARM_CAN_UNIT_STATE_ACTIVE (1U) ///< Unit state: Active on bus (can generate active error frame)
  135. #define ARM_CAN_UNIT_STATE_PASSIVE (2U) ///< Unit state: Error passive (can not generate active error frame)
  136. #define ARM_CAN_LEC_NO_ERROR (0U) ///< Last error code: No error
  137. #define ARM_CAN_LEC_BIT_ERROR (1U) ///< Last error code: Bit error
  138. #define ARM_CAN_LEC_STUFF_ERROR (2U) ///< Last error code: Bit stuffing error
  139. #define ARM_CAN_LEC_CRC_ERROR (3U) ///< Last error code: CRC error
  140. #define ARM_CAN_LEC_FORM_ERROR (4U) ///< Last error code: Illegal fixed-form bit
  141. #define ARM_CAN_LEC_ACK_ERROR (5U) ///< Last error code: Acknowledgment error
  142. /**
  143. \brief CAN Status
  144. */
  145. typedef volatile struct _ARM_CAN_STATUS {
  146. uint32_t unit_state : 4; ///< Unit bus state
  147. uint32_t last_error_code : 4; ///< Last error code
  148. uint32_t tx_error_count : 8; ///< Transmitter error count
  149. uint32_t rx_error_count : 8; ///< Receiver error count
  150. uint32_t reserved : 8;
  151. } ARM_CAN_STATUS;
  152. /****** CAN Unit Event *****/
  153. #define ARM_CAN_EVENT_UNIT_ACTIVE (1U) ///< Unit entered Error Active state
  154. #define ARM_CAN_EVENT_UNIT_WARNING (2U) ///< Unit entered Error Warning state (one or both error counters >= 96)
  155. #define ARM_CAN_EVENT_UNIT_PASSIVE (3U) ///< Unit entered Error Passive state
  156. #define ARM_CAN_EVENT_UNIT_BUS_OFF (4U) ///< Unit entered bus off state
  157. /****** CAN Send/Receive Event *****/
  158. #define ARM_CAN_EVENT_SEND_COMPLETE (1UL << 0) ///< Send complete
  159. #define ARM_CAN_EVENT_RECEIVE (1UL << 1) ///< Message received
  160. #define ARM_CAN_EVENT_RECEIVE_OVERRUN (1UL << 2) ///< Received message overrun
  161. // Function documentation
  162. /**
  163. \fn ARM_DRIVER_VERSION ARM_CAN_GetVersion (void)
  164. \brief Get driver version.
  165. \return \ref ARM_DRIVER_VERSION
  166. \fn ARM_CAN_CAPABILITIES ARM_CAN_GetCapabilities (void)
  167. \brief Get driver capabilities.
  168. \return \ref ARM_CAN_CAPABILITIES
  169. \fn int32_t ARM_CAN_Initialize (ARM_CAN_SignalUnitEvent_t cb_unit_event,
  170. ARM_CAN_SignalObjectEvent_t cb_object_event)
  171. \brief Initialize CAN interface and register signal (callback) functions.
  172. \param[in] cb_unit_event Pointer to \ref ARM_CAN_SignalUnitEvent callback function
  173. \param[in] cb_object_event Pointer to \ref ARM_CAN_SignalObjectEvent callback function
  174. \return \ref execution_status
  175. \fn int32_t ARM_CAN_Uninitialize (void)
  176. \brief De-initialize CAN interface.
  177. \return \ref execution_status
  178. \fn int32_t ARM_CAN_PowerControl (ARM_POWER_STATE state)
  179. \brief Control CAN interface power.
  180. \param[in] state Power state
  181. - \ref ARM_POWER_OFF : power off: no operation possible
  182. - \ref ARM_POWER_LOW : low power mode: retain state, detect and signal wake-up events
  183. - \ref ARM_POWER_FULL : power on: full operation at maximum performance
  184. \return \ref execution_status
  185. \fn uint32_t ARM_CAN_GetClock (void)
  186. \brief Retrieve CAN base clock frequency.
  187. \return base clock frequency
  188. \fn int32_t ARM_CAN_SetBitrate (ARM_CAN_BITRATE_SELECT select, uint32_t bitrate, uint32_t bit_segments)
  189. \brief Set bitrate for CAN interface.
  190. \param[in] select Bitrate selection
  191. - \ref ARM_CAN_BITRATE_NOMINAL : nominal (flexible data-rate arbitration) bitrate
  192. - \ref ARM_CAN_BITRATE_FD_DATA : flexible data-rate data bitrate
  193. \param[in] bitrate Bitrate
  194. \param[in] bit_segments Bit segments settings
  195. - \ref ARM_CAN_BIT_PROP_SEG(x) : number of time quanta for propagation time segment
  196. - \ref ARM_CAN_BIT_PHASE_SEG1(x) : number of time quanta for phase buffer segment 1
  197. - \ref ARM_CAN_BIT_PHASE_SEG2(x) : number of time quanta for phase buffer Segment 2
  198. - \ref ARM_CAN_BIT_SJW(x) : number of time quanta for (re-)synchronization jump width
  199. \return \ref execution_status
  200. \fn int32_t ARM_CAN_SetMode (ARM_CAN_MODE mode)
  201. \brief Set operating mode for CAN interface.
  202. \param[in] mode Operating mode
  203. - \ref ARM_CAN_MODE_INITIALIZATION : initialization mode
  204. - \ref ARM_CAN_MODE_NORMAL : normal operation mode
  205. - \ref ARM_CAN_MODE_RESTRICTED : restricted operation mode
  206. - \ref ARM_CAN_MODE_MONITOR : bus monitoring mode
  207. - \ref ARM_CAN_MODE_LOOPBACK_INTERNAL : loopback internal mode
  208. - \ref ARM_CAN_MODE_LOOPBACK_EXTERNAL : loopback external mode
  209. \return \ref execution_status
  210. \fn ARM_CAN_OBJ_CAPABILITIES ARM_CAN_ObjectGetCapabilities (uint32_t obj_idx)
  211. \brief Retrieve capabilities of an object.
  212. \param[in] obj_idx Object index
  213. \return \ref ARM_CAN_OBJ_CAPABILITIES
  214. \fn int32_t ARM_CAN_ObjectSetFilter (uint32_t obj_idx, ARM_CAN_FILTER_OPERATION operation, uint32_t id, uint32_t arg)
  215. \brief Add or remove filter for message reception.
  216. \param[in] obj_idx Object index of object that filter should be or is assigned to
  217. \param[in] operation Operation on filter
  218. - \ref ARM_CAN_FILTER_ID_EXACT_ADD : add exact id filter
  219. - \ref ARM_CAN_FILTER_ID_EXACT_REMOVE : remove exact id filter
  220. - \ref ARM_CAN_FILTER_ID_RANGE_ADD : add range id filter
  221. - \ref ARM_CAN_FILTER_ID_RANGE_REMOVE : remove range id filter
  222. - \ref ARM_CAN_FILTER_ID_MASKABLE_ADD : add maskable id filter
  223. - \ref ARM_CAN_FILTER_ID_MASKABLE_REMOVE : remove maskable id filter
  224. \param[in] id ID or start of ID range (depending on filter type)
  225. \param[in] arg Mask or end of ID range (depending on filter type)
  226. \return \ref execution_status
  227. \fn int32_t ARM_CAN_ObjectConfigure (uint32_t obj_idx, ARM_CAN_OBJ_CONFIG obj_cfg)
  228. \brief Configure object.
  229. \param[in] obj_idx Object index
  230. \param[in] obj_cfg Object configuration state
  231. - \ref ARM_CAN_OBJ_INACTIVE : deactivate object
  232. - \ref ARM_CAN_OBJ_RX : configure object for reception
  233. - \ref ARM_CAN_OBJ_TX : configure object for transmission
  234. - \ref ARM_CAN_OBJ_RX_RTR_TX_DATA : configure object that on RTR reception automatically transmits Data Frame
  235. - \ref ARM_CAN_OBJ_TX_RTR_RX_DATA : configure object that transmits RTR and automatically receives Data Frame
  236. \return \ref execution_status
  237. \fn int32_t ARM_CAN_MessageSend (uint32_t obj_idx, ARM_CAN_MSG_INFO *msg_info, const uint8_t *data, uint8_t size)
  238. \brief Send message on CAN bus.
  239. \param[in] obj_idx Object index
  240. \param[in] msg_info Pointer to CAN message information
  241. \param[in] data Pointer to data buffer
  242. \param[in] size Number of data bytes to send
  243. \return value >= 0 number of data bytes accepted to send
  244. \return value < 0 \ref execution_status
  245. \fn int32_t ARM_CAN_MessageRead (uint32_t obj_idx, ARM_CAN_MSG_INFO *msg_info, uint8_t *data, uint8_t size)
  246. \brief Read message received on CAN bus.
  247. \param[in] obj_idx Object index
  248. \param[out] msg_info Pointer to read CAN message information
  249. \param[out] data Pointer to data buffer for read data
  250. \param[in] size Maximum number of data bytes to read
  251. \return value >= 0 number of data bytes read
  252. \return value < 0 \ref execution_status
  253. \fn int32_t ARM_CAN_Control (uint32_t control, uint32_t arg)
  254. \brief Control CAN interface.
  255. \param[in] control Operation
  256. - \ref ARM_CAN_SET_FD_MODE : set FD operation mode
  257. - \ref ARM_CAN_ABORT_MESSAGE_SEND : abort sending of CAN message
  258. - \ref ARM_CAN_CONTROL_RETRANSMISSION : enable/disable automatic retransmission
  259. - \ref ARM_CAN_SET_TRANSCEIVER_DELAY : set transceiver delay
  260. \param[in] arg Argument of operation
  261. \return \ref execution_status
  262. \fn ARM_CAN_STATUS ARM_CAN_GetStatus (void)
  263. \brief Get CAN status.
  264. \return CAN status \ref ARM_CAN_STATUS
  265. \fn void ARM_CAN_SignalUnitEvent (uint32_t event)
  266. \brief Signal CAN unit event.
  267. \param[in] event \ref CAN_unit_events
  268. \return none
  269. \fn void ARM_CAN_SignalObjectEvent (uint32_t obj_idx, uint32_t event)
  270. \brief Signal CAN object event.
  271. \param[in] obj_idx Object index
  272. \param[in] event \ref CAN_events
  273. \return none
  274. */
  275. typedef void (*ARM_CAN_SignalUnitEvent_t) (uint32_t event); ///< Pointer to \ref ARM_CAN_SignalUnitEvent : Signal CAN Unit Event.
  276. typedef void (*ARM_CAN_SignalObjectEvent_t) (uint32_t obj_idx, uint32_t event); ///< Pointer to \ref ARM_CAN_SignalObjectEvent : Signal CAN Object Event.
  277. /**
  278. \brief CAN Device Driver Capabilities.
  279. */
  280. typedef struct _ARM_CAN_CAPABILITIES {
  281. uint32_t num_objects : 8; ///< Number of \ref can_objects available
  282. uint32_t reentrant_operation : 1; ///< Support for reentrant calls to \ref ARM_CAN_MessageSend, \ref ARM_CAN_MessageRead, \ref ARM_CAN_ObjectConfigure and abort message sending used by \ref ARM_CAN_Control
  283. uint32_t fd_mode : 1; ///< Support for CAN with flexible data-rate mode (CAN_FD) (set by \ref ARM_CAN_Control)
  284. uint32_t restricted_mode : 1; ///< Support for restricted operation mode (set by \ref ARM_CAN_SetMode)
  285. uint32_t monitor_mode : 1; ///< Support for bus monitoring mode (set by \ref ARM_CAN_SetMode)
  286. uint32_t internal_loopback : 1; ///< Support for internal loopback mode (set by \ref ARM_CAN_SetMode)
  287. uint32_t external_loopback : 1; ///< Support for external loopback mode (set by \ref ARM_CAN_SetMode)
  288. uint32_t reserved : 18; ///< Reserved (must be zero)
  289. } ARM_CAN_CAPABILITIES;
  290. /**
  291. \brief Access structure of the CAN Driver.
  292. */
  293. typedef struct _ARM_DRIVER_CAN {
  294. ARM_DRIVER_VERSION (*GetVersion) (void); ///< Pointer to \ref ARM_CAN_GetVersion : Get driver version.
  295. ARM_CAN_CAPABILITIES (*GetCapabilities) (void); ///< Pointer to \ref ARM_CAN_GetCapabilities : Get driver capabilities.
  296. int32_t (*Initialize) (ARM_CAN_SignalUnitEvent_t cb_unit_event,
  297. ARM_CAN_SignalObjectEvent_t cb_object_event); ///< Pointer to \ref ARM_CAN_Initialize : Initialize CAN interface.
  298. int32_t (*Uninitialize) (void); ///< Pointer to \ref ARM_CAN_Uninitialize : De-initialize CAN interface.
  299. int32_t (*PowerControl) (ARM_POWER_STATE state); ///< Pointer to \ref ARM_CAN_PowerControl : Control CAN interface power.
  300. uint32_t (*GetClock) (void); ///< Pointer to \ref ARM_CAN_GetClock : Retrieve CAN base clock frequency.
  301. int32_t (*SetBitrate) (ARM_CAN_BITRATE_SELECT select,
  302. uint32_t bitrate,
  303. uint32_t bit_segments); ///< Pointer to \ref ARM_CAN_SetBitrate : Set bitrate for CAN interface.
  304. int32_t (*SetMode) (ARM_CAN_MODE mode); ///< Pointer to \ref ARM_CAN_SetMode : Set operating mode for CAN interface.
  305. ARM_CAN_OBJ_CAPABILITIES (*ObjectGetCapabilities) (uint32_t obj_idx); ///< Pointer to \ref ARM_CAN_ObjectGetCapabilities : Retrieve capabilities of an object.
  306. int32_t (*ObjectSetFilter) (uint32_t obj_idx,
  307. ARM_CAN_FILTER_OPERATION operation,
  308. uint32_t id,
  309. uint32_t arg); ///< Pointer to \ref ARM_CAN_ObjectSetFilter : Add or remove filter for message reception.
  310. int32_t (*ObjectConfigure) (uint32_t obj_idx,
  311. ARM_CAN_OBJ_CONFIG obj_cfg); ///< Pointer to \ref ARM_CAN_ObjectConfigure : Configure object.
  312. int32_t (*MessageSend) (uint32_t obj_idx,
  313. ARM_CAN_MSG_INFO *msg_info,
  314. const uint8_t *data,
  315. uint8_t size); ///< Pointer to \ref ARM_CAN_MessageSend : Send message on CAN bus.
  316. int32_t (*MessageRead) (uint32_t obj_idx,
  317. ARM_CAN_MSG_INFO *msg_info,
  318. uint8_t *data,
  319. uint8_t size); ///< Pointer to \ref ARM_CAN_MessageRead : Read message received on CAN bus.
  320. int32_t (*Control) (uint32_t control,
  321. uint32_t arg); ///< Pointer to \ref ARM_CAN_Control : Control CAN interface.
  322. ARM_CAN_STATUS (*GetStatus) (void); ///< Pointer to \ref ARM_CAN_GetStatus : Get CAN status.
  323. } const ARM_DRIVER_CAN;
  324. #ifdef __cplusplus
  325. }
  326. #endif
  327. #endif /* DRIVER_CAN_H_ */