begriffs open source - cmsis/blob - CMSIS/Driver/Include/Driver_CAN.h

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