API to use DoCAN on exxotest devices. More...

typedef void *	AGHAF_DoCAN_v2_Channel
	Handle to a DoCAN channel.

typedef void(*	AGHAF_DoCAN_onMessageTx) (uint64_t timestamp, uint32_t canIdent, uint8_t canFlags, uint32_t dataLen, uint8_t const data, void userContext)
	callback function called when a message is transmitted on a DoCAN channel

typedef void(*	AGHAF_DoCAN_onMessageTxError) (uint64_t timestamp, AGHAF_DoCan_Error error, void *userContext)
	callback function called when an error happens on the transmission from a DoCAN channel

typedef void(*	AGHAF_DoCAN_onMessageRx) (uint64_t timestamp, uint32_t canIdent, uint8_t canFlags, uint32_t dataLen, uint8_t const data, void userContext)
	callback function called when a message is received on a DoCAN channel

typedef void(*	AGHAF_DoCAN_onMessageRxFF) (uint64_t timestamp, uint32_t canIdent, uint8_t canFlags, void *userContext)
	callback function called when a first frame is received on a DoCAN channel

typedef void(*	AGHAF_DoCAN_onMessageRxError) (uint64_t timestamp, AGHAF_DoCan_Error error, void *userContext)
	callback function called when an error happens on the reception from a DoCAN channel

void	AGHAF_DoCAN_v2_setOnMessageTxCallback (AGHAF_DoCAN_v2_Channel channel, AGHAF_DoCAN_onMessageTx callback, void *userContext)
	set the callback called on a transmission event

void	AGHAF_DoCAN_v2_setOnMessageTxErrorCallback (AGHAF_DoCAN_v2_Channel channel, AGHAF_DoCAN_onMessageTxError callback, void *userContext)
	set the callback called on a transmission error event

void	AGHAF_DoCAN_v2_setOnMessageRxCallback (AGHAF_DoCAN_v2_Channel channel, AGHAF_DoCAN_onMessageRx callback, void *userContext)
	set the callback called on a reception event

void	AGHAF_DoCAN_v2_setOnMessageRxFFCallback (AGHAF_DoCAN_v2_Channel channel, AGHAF_DoCAN_onMessageRxFF callback, void *userContext)
	set the callback called on the reception from a first frame event

void	AGHAF_DoCAN_v2_setOnMessageRxErrorCallback (AGHAF_DoCAN_v2_Channel channel, AGHAF_DoCAN_onMessageRxError callback, void *userContext)
	set the callback called on a reception error event

AGHAF_Status	AGHAF_DoCAN_v2_getChannelCount (AGHAF_CAN can, uint8_t *count)
	Provide the number of channels available on the bus.

AGHAF_Status	AGHAF_DoCAN_v2_getFreeChannelCount (AGHAF_CAN can, uint8_t *count)
	Return the number of free channels still available.

AGHAF_DoCAN_v2_Channel	AGHAF_DoCAN_v2_createChannel (AGHAF_CAN can)
	Create a channel.

AGHAF_Status	AGHAF_DoCAN_v2_releaseChannel (AGHAF_DoCAN_v2_Channel channel)
	Release the channel.

AGHAF_DoCAN_Channel	AGHAF_DoCAN_v2_getChannelByIndex (AGHAF_CAN can, uint8_t index)
	return the index corrsponding to the index in parameter (nullptr if the index is not found)

uint8_t	AGHAF_DoCAN_v2_Channel_getIndex (AGHAF_DoCAN_v2_Channel channel)
	Return the intern index from the channel.

AGHAF_Status	AGHAF_DoCAN_v2_Channel_setParam (AGHAF_DoCAN_v2_Channel channel, AGHAF_DoCAN_ChannelParam param, uint32_t value)
	Set the parameter from a channel.

AGHAF_Status	AGHAF_DoCAN_v2_Channel_getParam (AGHAF_DoCAN_v2_Channel channel, AGHAF_DoCAN_ChannelParam param, uint32_t *value)
	Provide the value from a channel parameter.

AGHAF_Status	AGHAF_DoCAN_v2_Channel_start (AGHAF_DoCAN_v2_Channel channel)
	Start a channel.

AGHAF_Status	AGHAF_DoCAN_v2_Channel_stop (AGHAF_DoCAN_v2_Channel channel)
	Stop a channel.

AGHAF_Status	AGHAF_DoCAN_v2_Channel_send (AGHAF_DoCAN_v2_Channel channel, uint32_t dataLen, uint8_t const *data)
	Send on the DoCAN channel in parameter.

void	AGHAF_DoCAN_v2_Channel_activateTrace (AGHAF_DoCAN_v2_Channel channel, AGHAF_BOOL value)
	Activate the CAN trace.

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_v2_Channel_start, the channel goes in "Start" state.
When you call AGHAF_DoCAN_v2_Channel_stop, the channel goes in "Stop" state.

Symbol	Description
	Forbidden
	Authorized
	Next state

Function	Stop	Start
AGHAF_DoCAN_v2_setOnMessageTxCallback
AGHAF_DoCAN_v2_setOnMessageTxErrorCallback
AGHAF_DoCAN_v2_setOnMessageRxCallback
AGHAF_DoCAN_v2_setOnMessageRxFFCallback
AGHAF_DoCAN_v2_setOnMessageRxErrorCallback
AGHAF_DoCAN_v2_Channel_setParam
AGHAF_DoCAN_v2_Channel_getParam
AGHAF_DoCAN_v2_Channel_start
AGHAF_DoCAN_v2_Channel_stop
AGHAF_DoCAN_v2_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_onMessageRx

typedef void(* AGHAF_DoCAN_onMessageRx) (uint64_t timestamp, uint32_t canIdent, uint8_t canFlags, uint32_t dataLen, uint8_t const *data, void *userContext)

callback function called when a message is received on a DoCAN channel

Parameters

timestamp	timestamp of the event
canIdent	can identifier
canFlags	corresponding to AGHAF_CAN_MSG_FLAGS
dataLen	length of the datas received
data	datas received
userContext	context given when setting the callabck in the system

◆ AGHAF_DoCAN_onMessageRxError

typedef void(* AGHAF_DoCAN_onMessageRxError) (uint64_t timestamp, AGHAF_DoCan_Error error, void *userContext)

callback function called when an error happens on the reception from a DoCAN channel

Parameters

timestamp	timestamp of the event
error	value of the error
userContext	context given when setting the callabck in the system

◆ AGHAF_DoCAN_onMessageRxFF

typedef void(* AGHAF_DoCAN_onMessageRxFF) (uint64_t timestamp, uint32_t canIdent, uint8_t canFlags, void *userContext)

callback function called when a first frame is received on a DoCAN channel

Parameters

timestamp	timestamp of the event
canIdent	can identifier
canFlags	corresponding to AGHAF_CAN_MSG_FLAGS
userContext	context given when setting the callabck in the system

◆ AGHAF_DoCAN_onMessageTx

typedef void(* AGHAF_DoCAN_onMessageTx) (uint64_t timestamp, uint32_t canIdent, uint8_t canFlags, uint32_t dataLen, uint8_t const *data, void *userContext)

callback function called when a message is transmitted on a DoCAN channel

Parameters

timestamp	timestamp of the event
canIdent	can identifier
canFlags	corresponding to AGHAF_CAN_MSG_FLAGS
dataLen	length of the datas transmitted
data	datas transmitted
userContext	context given when setting the callabck in the system

◆ AGHAF_DoCAN_onMessageTxError

typedef void(* AGHAF_DoCAN_onMessageTxError) (uint64_t timestamp, AGHAF_DoCan_Error error, void *userContext)

callback function called when an error happens on the transmission from a DoCAN channel

Parameters

timestamp	timestamp of the event
error	value of the error
userContext	context given when setting the callabck in the system

Function Documentation

◆ AGHAF_DoCAN_v2_Channel_activateTrace()

void AGHAF_DoCAN_v2_Channel_activateTrace	(	AGHAF_DoCAN_v2_Channel	channel,
		AGHAF_BOOL	value
	)

Activate the CAN trace.

Parameters

channel	handle on the channel
value	AGHAF_TRUE ? activate : deactivate

◆ AGHAF_DoCAN_v2_Channel_getIndex()

uint8_t AGHAF_DoCAN_v2_Channel_getIndex ( AGHAF_DoCAN_v2_Channel channel )

Return the intern index from the channel.

Parameters

channel

Returns: index from the channel

◆ AGHAF_DoCAN_v2_Channel_getParam()

AGHAF_Status AGHAF_DoCAN_v2_Channel_getParam	(	AGHAF_DoCAN_v2_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_v2_Channel_send()

AGHAF_Status AGHAF_DoCAN_v2_Channel_send	(	AGHAF_DoCAN_v2_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_v2_FD/main.cpp.

◆ AGHAF_DoCAN_v2_Channel_setParam()

AGHAF_Status AGHAF_DoCAN_v2_Channel_setParam	(	AGHAF_DoCAN_v2_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_v2_FD/main.cpp.

◆ AGHAF_DoCAN_v2_Channel_start()

AGHAF_Status AGHAF_DoCAN_v2_Channel_start ( AGHAF_DoCAN_v2_Channel channel )

Start a channel.

Parameters

channel handle on the channel

Returns: status request information

Examples: DoCan_v2_FD/main.cpp.

◆ AGHAF_DoCAN_v2_Channel_stop()

AGHAF_Status AGHAF_DoCAN_v2_Channel_stop ( AGHAF_DoCAN_v2_Channel channel )

Stop a channel.

Parameters

channel handle on the channel

Returns: status request information

Examples: DoCan_v2_FD/main.cpp.

◆ AGHAF_DoCAN_v2_createChannel()

AGHAF_DoCAN_v2_Channel AGHAF_DoCAN_v2_createChannel ( AGHAF_CAN can )

Create a channel.

Parameters

can	handle on the bus

Returns: handle on the channel created

◆ AGHAF_DoCAN_v2_getChannelByIndex()

AGHAF_DoCAN_Channel AGHAF_DoCAN_v2_getChannelByIndex	(	AGHAF_CAN	can,
		uint8_t	index
	)

return the index corrsponding to the index in parameter (nullptr if the index is not found)

Parameters

can	bus on which is the channel
index	index from the channel

Returns: handle on a channel

◆ AGHAF_DoCAN_v2_getChannelCount()

AGHAF_Status AGHAF_DoCAN_v2_getChannelCount	(	AGHAF_CAN	can,
		uint8_t *	count
	)

Provide the number of channels available on the bus.

Parameters

can	handle on the bus
count	pointer to fill with the data

Returns: status request information

◆ AGHAF_DoCAN_v2_getFreeChannelCount()

AGHAF_Status AGHAF_DoCAN_v2_getFreeChannelCount	(	AGHAF_CAN	can,
		uint8_t *	count
	)

Return the number of free channels still available.

Parameters

can	handle on the bus
count	number of free channels still available

Returns: status request information

◆ AGHAF_DoCAN_v2_releaseChannel()

AGHAF_Status AGHAF_DoCAN_v2_releaseChannel ( AGHAF_DoCAN_v2_Channel channel )

Release the channel.

Parameters

channel handle on the channel to release

Returns: status request information

Examples: DoCan_v2_FD/main.cpp.

◆ AGHAF_DoCAN_v2_setOnMessageRxCallback()

void AGHAF_DoCAN_v2_setOnMessageRxCallback	(	AGHAF_DoCAN_v2_Channel	channel,
		AGHAF_DoCAN_onMessageRx	callback,
		void *	userContext
	)

set the callback called on a reception event

Parameters

channel	handle on the channel
callback	callback to be used for the event
userContext	context provided by the user for custom datas

Examples: DoCan_v2_FD/main.cpp.

◆ AGHAF_DoCAN_v2_setOnMessageRxErrorCallback()

void AGHAF_DoCAN_v2_setOnMessageRxErrorCallback	(	AGHAF_DoCAN_v2_Channel	channel,
		AGHAF_DoCAN_onMessageRxError	callback,
		void *	userContext
	)

set the callback called on a reception error event

Parameters

channel	handle on the channel
callback	callback to be used for the event
userContext	context provided by the user for custom datas

Examples: DoCan_v2_FD/main.cpp.

◆ AGHAF_DoCAN_v2_setOnMessageRxFFCallback()

void AGHAF_DoCAN_v2_setOnMessageRxFFCallback	(	AGHAF_DoCAN_v2_Channel	channel,
		AGHAF_DoCAN_onMessageRxFF	callback,
		void *	userContext
	)

set the callback called on the reception from a first frame event

Parameters

channel	handle on the channel
callback	callback to be used for the event
userContext	context provided by the user for custom datas

Examples: DoCan_v2_FD/main.cpp.

◆ AGHAF_DoCAN_v2_setOnMessageTxCallback()

void AGHAF_DoCAN_v2_setOnMessageTxCallback	(	AGHAF_DoCAN_v2_Channel	channel,
		AGHAF_DoCAN_onMessageTx	callback,
		void *	userContext
	)

set the callback called on a transmission event

Parameters

channel	handle on the channel
callback	callback to be used for the event
userContext	context provided by the user for custom datas

Examples: DoCan_v2_FD/main.cpp.

◆ AGHAF_DoCAN_v2_setOnMessageTxErrorCallback()

void AGHAF_DoCAN_v2_setOnMessageTxErrorCallback	(	AGHAF_DoCAN_v2_Channel	channel,
		AGHAF_DoCAN_onMessageTxError	callback,
		void *	userContext
	)

set the callback called on a transmission error event

Parameters

channel	handle on the channel
callback	callback to be used for the event
userContext	context provided by the user for custom datas

Examples: DoCan_v2_FD/main.cpp.