API to use DoCAN on exxotest devices. More...
Detailed Description
API to use DoCAN on exxotest devices.
Usage Example
Call order and priority
below, the description of channel state management:
- When you call AGHAF_DoCAN_Channel_start, the channel goes in "Start" state.
- When you call AGHAF_DoCAN_Channel_stop, the channel goes in "Stop" state.
| Symbol | Description |
|---|---|
| Forbidden |
| Authorized |
| Next state |
| Function | Stop | Start |
|---|---|---|
| AGHAF_DoCAN_Channel_setParam | 
| 
|
| AGHAF_DoCAN_Channel_getParam |
|
|
| AGHAF_DoCAN_Channel_start |
|
|
| AGHAF_DoCAN_Channel_stop |
|
|
| AGHAF_DoCAN_Channel_send |
|
|
Performances
This table presents the results obtained during a test in ko.s-1. The rate corresponds to the transmission rate on the whole bus. For this test, there was 32 channels and 10 messages exchanged on each channel. The CAN baudrate was 1Mb/s and FD baudrate was 5Mb/s. The message size is in bytes. Datas are exchanged between two MuxDiag 3.
| Message Size | Classic CAN | TxDL 8 | TxDL 12 | TXDL 16 | TxDL 20 | TxDL 24 | TxDL 32 | TxDL 48 | TxDL 64 |
|---|---|---|---|---|---|---|---|---|---|
| 12 | 19 | 28 | 32 | 32 | 28 | 29 | 31 | 32 | 30 |
| 100 | 42 | 85 | 102 | 129 | 134 | 159 | 167 | 173 | 173 |
| 1000 | 47 | 93 | 134 | 165 | 189 | 213 | 257 | 301 | 340 |
| 10000 | 48 | 96 | 137 | 172 | 200 | 224 | 266 | 323 | 362 |
Typedef Documentation
◆ AGHAF_DoCAN_Callback
| AGHAF_DoCAN_Callback |
Callback function type to recieve DoCAN events.
- Parameters
-
event Handle to the event. userContext Same parameter as the one passed to AGHAF_DoCAN_registerCallback().
- Returns
- void
- Note
- Do not delete the event within the body of a callback function.
Enumeration Type Documentation
◆ AGHAF_DoCAN_AddrMode
| enum AGHAF_DoCAN_AddrMode |
◆ AGHAF_DoCAN_ChannelDirection
◆ AGHAF_DoCAN_ChannelParam
List of parameters used to configure a DoCAN channel.
- Warning
- The set of AGHAF_DoCAN_CHANNEL_PARAM_RESP_ID_xxx must be unique for all channels.
With the exception of functional addressing Tx channel, that don't need a response ID.
| Enumerator | |
|---|---|
| AGHAF_DoCAN_CHANNEL_PARAM_DIRECTION | Set channel direction. |
| AGHAF_DoCAN_CHANNEL_PARAM_TXDL | Define TX_DL and identitify if CAN FD or Classic CAN is to be used. |
| AGHAF_DoCAN_CHANNEL_PARAM_PAD_HANDLING | Enable padding handling. |
| AGHAF_DoCAN_CHANNEL_PARAM_PAD_VALUE | Padding value to use when padding handling is enabled. |
| AGHAF_DoCAN_CHANNEL_PARAM_ADDRMODE | Addressing mode used by the channel |
| AGHAF_DoCAN_CHANNEL_PARAM_TIMING_AS | As - Time for transmission of the CAN frame (any N_PDU) on the sender side. |
| AGHAF_DoCAN_CHANNEL_PARAM_TIMING_AR | Ar - Time for transmission of the CAN frame (any N_PDU) on the receiver side. |
| AGHAF_DoCAN_CHANNEL_PARAM_TIMING_BS | Bs - Timeout until reception of the next FlowControl N_PDU. |
| AGHAF_DoCAN_CHANNEL_PARAM_TIMING_BR | Br - Performance requirement (not used). |
| AGHAF_DoCAN_CHANNEL_PARAM_TIMING_CS | Cs - Performance requirement (not used). |
| AGHAF_DoCAN_CHANNEL_PARAM_TIMING_CR | Cr - Timeout until reception of the next ConsecutiveFrame. |
| AGHAF_DoCAN_CHANNEL_PARAM_TIMING_STMIN | STmin - Separation time (Receiver only). |
| AGHAF_DoCAN_CHANNEL_PARAM_REQ_ID_FMT | CAN ID format used to transmit data. |
| AGHAF_DoCAN_CHANNEL_PARAM_REQ_ID_VALUE | CAN ID used to transmit data. |
| AGHAF_DoCAN_CHANNEL_PARAM_REQ_ID_AE | Address extension used to transmit data. |
| AGHAF_DoCAN_CHANNEL_PARAM_RESP_ID_FMT | CAN ID format used to receive data. |
| AGHAF_DoCAN_CHANNEL_PARAM_RESP_ID_VALUE | CAN ID used to receive data. |
| AGHAF_DoCAN_CHANNEL_PARAM_RESP_ID_AE | Address extension used to receive data. |
| AGHAF_DoCAN_CHANNEL_PARAM_WAITFRAME | Maximum number of WAIT flow control frames allowed during a multi-segment transfer. |
| AGHAF_DoCAN_CHANNEL_PARAM_BLOCKSIZE | Block Size (Receiver only). |
| AGHAF_DoCAN_CHANNEL_PARAM_MAXDATALEN | Maximum byte length of received segmented message (Receiver only). |
| AGHAF_DoCAN_CHANNEL_PARAM_PAD_NOCHECK | If enable, doesn't check padding of response against the AGHAF_DoCAN_CHANNEL_PARAM_PAD_HANDLING setting. |
| AGHAF_DoCAN_CHANNEL_PARAM_CANFD_BRS | Manage Bit Rate Switch when sending frame. |
| AGHAF_DoCAN_CHANNEL_PARAM_TIMING_STMIN_OVRD | STmin Override - Separation time (Sender only). |
| AGHAF_DoCAN_CHANNEL_PARAM_BS_OVRD | Block Size Override (Sender only). |
◆ AGHAF_DoCan_Error
| enum AGHAF_DoCan_Error |
enumerator to describe the error on the bus
◆ AGHAF_DoCAN_EventType
◆ AGHAF_DoCAN_IdFormat
| enum AGHAF_DoCAN_IdFormat |
Flags to configure DoCAN identifier format.
- Enable extended CAN identifer
- Enable address extension
◆ AGHAF_DoCAN_PadHandling
Enable or disable padding handling.
- Note
- In CAN FD, even if padding is disabled, transmitted frames are still padded up to the nearest valid length.
- Warning
- When enabled, if response frames do not use padding they will be rejected.
| Enumerator | |
|---|---|
| AGHAF_DoCAN_PAD_DISABLE | Disable padding handling. |
| AGHAF_DoCAN_PAD_ENABLE | Enable padding handling. |
◆ AGHAF_DoCAN_TxDL
| enum AGHAF_DoCAN_TxDL |
Possible TX_DL for DoCAN transmissions.
- Note
- This parameter is also used to enable or disable the use of CAN FD.
Function Documentation
◆ AGHAF_DoCAN_Channel_activateTrace()
| void AGHAF_DoCAN_Channel_activateTrace | ( | AGHAF_DoCAN_Channel | channel, |
| AGHAF_BOOL | value | ||
| ) |
Activate the CAN trace.
- Parameters
-
channel handle on the channel value AGHAF_TRUE ? activate : deactivate
◆ AGHAF_DoCAN_Channel_getIndex()
| uint8_t AGHAF_DoCAN_Channel_getIndex | ( | AGHAF_DoCAN_Channel | channel | ) |
Return the intern index from the channel.
- Parameters
-
channel
- Returns
- index from the channel
◆ AGHAF_DoCAN_Channel_getParam()
| AGHAF_Status AGHAF_DoCAN_Channel_getParam | ( | AGHAF_DoCAN_Channel | channel, |
| AGHAF_DoCAN_ChannelParam | param, | ||
| uint32_t * | value | ||
| ) |
Provide the value from a channel parameter.
- Parameters
-
channel handle on the channel param parameter to get value value to get
- Returns
- status request information
◆ AGHAF_DoCAN_Channel_send()
| AGHAF_Status AGHAF_DoCAN_Channel_send | ( | AGHAF_DoCAN_Channel | channel, |
| uint32_t | dataLen, | ||
| uint8_t const * | data | ||
| ) |
Send on the DoCAN channel in parameter.
- Parameters
-
channel handle on the channel dataLen length from the datas data pointer on data
- Returns
- status request information
- Examples
- DoCan_FD/main.cpp.
◆ AGHAF_DoCAN_Channel_setParam()
| AGHAF_Status AGHAF_DoCAN_Channel_setParam | ( | AGHAF_DoCAN_Channel | channel, |
| AGHAF_DoCAN_ChannelParam | param, | ||
| uint32_t | value | ||
| ) |
Set the parameter from a channel.
- Parameters
-
channel handle on the channel param parameter to set value value to set
- Returns
- status request information
- Examples
- DoCan_FD/main.cpp.
◆ AGHAF_DoCAN_Channel_start()
| AGHAF_Status AGHAF_DoCAN_Channel_start | ( | AGHAF_DoCAN_Channel | channel | ) |
Start a channel.
- Parameters
-
channel handle on the channel
- Returns
- status request information
- Examples
- DoCan_FD/main.cpp.
◆ AGHAF_DoCAN_Channel_stop()
| AGHAF_Status AGHAF_DoCAN_Channel_stop | ( | AGHAF_DoCAN_Channel | channel | ) |
Stop a channel.
- Parameters
-
channel handle on the channel
- Returns
- status request information
- Examples
- DoCan_FD/main.cpp.
◆ AGHAF_DoCAN_createChannel()
| AGHAF_DoCAN_Channel AGHAF_DoCAN_createChannel | ( | AGHAF_DoCAN_Bus | bus | ) |
Create a channel.
- Parameters
-
bus handle on the bus
- Returns
- handle on the channel created
- Examples
- DoCan_FD/main.cpp.
◆ AGHAF_DoCAN_deregisterCallback()
| void AGHAF_DoCAN_deregisterCallback | ( | AGHAF_DoCAN_Bus | bus, |
| AGHAF_DoCAN_Callback | callback | ||
| ) |
deregister a callback
- Parameters
-
bus handle on the bus callback function pointer to remove
- Examples
- DoCan_FD/main.cpp.
◆ AGHAF_DoCAN_Event_getBusIndex()
| uint8_t AGHAF_DoCAN_Event_getBusIndex | ( | AGHAF_DoCAN_Event | event | ) |
return the index from the bus on which occured the event
- Parameters
-
event handle on an event
- Returns
- index from bus
◆ AGHAF_DoCAN_Event_getChannel()
| AGHAF_DoCAN_Channel AGHAF_DoCAN_Event_getChannel | ( | AGHAF_DoCAN_Event | event | ) |
Return the channel on which occured the event.
- Parameters
-
event handle on the event
- Returns
- handle on the channel
- Examples
- DoCan_FD/main.cpp.
◆ AGHAF_DoCAN_Event_getData()
| AGHAF_Status AGHAF_DoCAN_Event_getData | ( | AGHAF_DoCAN_Event | event, |
| uint8_t * | data, | ||
| uint32_t * | size | ||
| ) |
Provide the datas received in the event.
- Parameters
-
event handle on the event data array to fill with the data size [in] data array size [out] size of copied data
- Returns
- status request information
- Examples
- DoCan_FD/main.cpp.
◆ AGHAF_DoCAN_Event_getDataSize()
| uint32_t AGHAF_DoCAN_Event_getDataSize | ( | AGHAF_DoCAN_Event | event | ) |
return the size from the datas in the event
- Parameters
-
event
- Returns
- size from the datas
- Examples
- DoCan_FD/main.cpp.
◆ AGHAF_DoCAN_Event_getError()
| uint8_t AGHAF_DoCAN_Event_getError | ( | AGHAF_DoCAN_Event | event | ) |
Return the error value from the event.
- Parameters
-
event handle on the event
- Returns
- corresponds to AGHAF_DoCan_Error enumerator
- Examples
- DoCan_FD/main.cpp.
◆ AGHAF_DoCAN_Event_getId()
| AGHAF_CAN_Identifier AGHAF_DoCAN_Event_getId | ( | AGHAF_DoCAN_Event | event | ) |
Return the CAN identifier from the event.
- Parameters
-
event handle on the event
- Returns
- CAN identifier from the event
◆ AGHAF_DoCAN_Event_type()
| AGHAF_DoCAN_EventType AGHAF_DoCAN_Event_type | ( | AGHAF_EventInfo | event | ) |
return the type from the event
- Parameters
-
event
- Returns
- type from the event
- Examples
- DoCan_FD/main.cpp.
◆ AGHAF_DoCAN_getBus()
| AGHAF_DoCAN_Bus AGHAF_DoCAN_getBus | ( | AGHAF_Device | device, |
| uint8_t | index | ||
| ) |
return the DoCAN bus at index in parameter
- Parameters
-
device device handle from the desired DoCAN bus index index from the bus
- Returns
- Handle on a DoCAN bus
- Examples
- DoCan_FD/main.cpp.
◆ AGHAF_DoCAN_getBusCount()
| uint32_t AGHAF_DoCAN_getBusCount | ( | AGHAF_Device | device | ) |
return the number of DoCAN bus from a device
- Parameters
-
device handle from the device
- Returns
- Number of DoCAN bus on the device
◆ AGHAF_DoCAN_getChannelByIndex()
| AGHAF_DoCAN_Channel AGHAF_DoCAN_getChannelByIndex | ( | AGHAF_DoCAN_Bus | bus, |
| uint8_t | index | ||
| ) |
return the index corrsponding to the index in parameter (nullptr if the index is not found)
- Parameters
-
bus bus on which is the channel index index from the channel
- Returns
- handle on a channel
◆ AGHAF_DoCAN_getChannelCount()
| AGHAF_Status AGHAF_DoCAN_getChannelCount | ( | AGHAF_DoCAN_Bus | bus, |
| uint8_t * | count | ||
| ) |
Provide the number of channels available on the bus.
- Parameters
-
bus handle on the bus count pointer to fill with the data
- Returns
- status request information
◆ AGHAF_DoCAN_getFreeChannelCount()
| AGHAF_Status AGHAF_DoCAN_getFreeChannelCount | ( | AGHAF_DoCAN_Bus | bus, |
| uint8_t * | count | ||
| ) |
Return the number of free channels still available.
- Parameters
-
bus handle on the bus count number of free channels still available
- Returns
- status request information
◆ AGHAF_DoCAN_registerCallback()
| void AGHAF_DoCAN_registerCallback | ( | AGHAF_DoCAN_Bus | bus, |
| AGHAF_DoCAN_Callback | callback, | ||
| void * | userContext | ||
| ) |
Register a callback for the DoCAN events from a bus.
- Parameters
-
bus handle on the bus callback function pointer to call on an event userContext
- Examples
- DoCan_FD/main.cpp.
◆ AGHAF_DoCAN_releaseChannel()
| AGHAF_Status AGHAF_DoCAN_releaseChannel | ( | AGHAF_DoCAN_Channel | channel | ) |
Release the channel.
- Parameters
-
channel handle on the channel to release
- Returns
- status request information
- Examples
- DoCan_FD/main.cpp.
