aghaf_docan.h File Reference

#include <ghap/aghaf_docan_enums.h>
#include "aghaf_can.h"
#include "aghaf_global.h"

Include dependency graph for aghaf_docan.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

typedef void *	AGHAF_DoCAN_Bus
	Handle to a DoCAN bus.
typedef void(*	AGHAF_DoCAN_Callback) (AGHAF_DoCAN_Event event, void *userContext)
typedef void *	AGHAF_DoCAN_Channel
	Handle to a DoCAN channel.
void	AGHAF_DoCAN_Channel_activateTrace (AGHAF_DoCAN_Channel channel, AGHAF_BOOL value)
	Activate the CAN trace.
AGHAF_Status	AGHAF_DoCAN_Channel_getParam (AGHAF_DoCAN_Channel channel, AGHAF_DoCAN_ChannelParam param, uint32_t *value)
	Provide the value from a channel parameter.
AGHAF_Status	AGHAF_DoCAN_Channel_send (AGHAF_DoCAN_Channel channel, uint32_t dataLen, uint8_t const *data)
	Send on the DoCAN channel in parameter.
AGHAF_Status	AGHAF_DoCAN_Channel_setParam (AGHAF_DoCAN_Channel channel, AGHAF_DoCAN_ChannelParam param, uint32_t value)
	Set the parameter from a channel.
AGHAF_Status	AGHAF_DoCAN_Channel_start (AGHAF_DoCAN_Channel channel)
	Start a channel.
AGHAF_Status	AGHAF_DoCAN_Channel_stop (AGHAF_DoCAN_Channel channel)
	Stop a channel.
AGHAF_DoCAN_Channel	AGHAF_DoCAN_createChannel (AGHAF_DoCAN_Bus bus)
	Create a channel.
void	AGHAF_DoCAN_deregisterCallback (AGHAF_DoCAN_Bus bus, AGHAF_DoCAN_Callback callback)
	deregister a callback
typedef void *	AGHAF_DoCAN_Event
	Handle to a DoCAN event.
uint8_t	AGHAF_DoCAN_Event_getBusIndex (AGHAF_DoCAN_Event event)
	return the index from the bus on which occured the event
AGHAF_DoCAN_Channel	AGHAF_DoCAN_Event_getChannel (AGHAF_DoCAN_Event event)
	Return the channel on which occured the event.
AGHAF_Status	AGHAF_DoCAN_Event_getData (AGHAF_DoCAN_Event event, uint8_t *data, uint32_t *size)
	Provide the datas received in the event.
uint32_t	AGHAF_DoCAN_Event_getDataSize (AGHAF_DoCAN_Event event)
	return the size from the datas in the event
uint8_t	AGHAF_DoCAN_Event_getError (AGHAF_DoCAN_Event event)
	Return the error value from the event.
AGHAF_CAN_Identifier	AGHAF_DoCAN_Event_getId (AGHAF_DoCAN_Event event)
	Return the CAN identifier from the event.
AGHAF_DoCAN_EventType	AGHAF_DoCAN_Event_type (AGHAF_EventInfo event)
	return the type from the event
enum	AGHAF_DoCAN_EventType {   AGHAF_DoCAN_EVENT_MSGTX = 0 , AGHAF_DoCAN_EVENT_MSGTXERR = 1 , AGHAF_DoCAN_EVENT_MSGRX = 2 , AGHAF_DoCAN_EVENT_MSGRXFF = 3 ,   AGHAF_DoCAN_EVENT_MSGRXERR = 4 }
	enumerator to tell the type of the event More...
AGHAF_DoCAN_Bus	AGHAF_DoCAN_getBus (AGHAF_Device device, uint8_t index)
	return the DoCAN bus at index in parameter
uint32_t	AGHAF_DoCAN_getBusCount (AGHAF_Device device)
	return the number of DoCAN bus from a device
AGHAF_Status	AGHAF_DoCAN_getChannelCount (AGHAF_DoCAN_Bus bus, uint8_t *count)
	Provide the number of channels available on the bus.
AGHAF_Status	AGHAF_DoCAN_getFreeChannelCount (AGHAF_DoCAN_Bus bus, uint8_t *count)
	Return the number of free channels still available.
void	AGHAF_DoCAN_registerCallback (AGHAF_DoCAN_Bus bus, AGHAF_DoCAN_Callback callback, void *userContext)
	Register a callback for the DoCAN events from a bus.
AGHAF_Status	AGHAF_DoCAN_releaseChannel (AGHAF_DoCAN_Channel channel)
	Release the channel.