Driver_CAN.h 22 KB

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