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

AGHAF_EthBus	AGHAF_ETH_getBus (AGHAF_Device device, uint8_t index)
	return the Ethernet bus at index in parameter More...

uint8_t	AGHAF_ETH_getBusIndex (AGHAF_EthBus ethernet)
	return the index from a Ethernet More...

uint8_t	AGHAF_ETH_getBusCount (AGHAF_Device device)
	return the number of CAN bus from a device More...

AGHAF_Status	AGHAF_ETH_activate (AGHAF_EthBus ethernet)
	start the communication with the Ethernet More...

AGHAF_Status	AGHAF_ETH_deactivate (AGHAF_EthBus ethernet)
	stop the communication with the Ethernet More...

AGHAF_Status	AGHAF_ETH_isActivated (AGHAF_EthBus ethernet, AGHAF_BOOL *isActivated)
	allow to know if the communication on the Ethernet is started or not More...

AGHAF_Status	AGHAF_ETH_getParam (AGHAF_EthBus ethernet, AGHAF_ETH_Param param, uint32_t *value)
	get a parameter from an ethernet card More...

AGHAF_Status	AGHAF_ETH_setParam (AGHAF_EthBus ethernet, AGHAF_ETH_Param param, uint32_t value)
	set a parameter from an ethernet card More...

void	AGHAF_ETH_getFriendlyNameEthCard (AGHAF_EthBus ethernet, char **name)
	Provide the friendly name associated to the network card. More...

void	AGHAF_ETH_freeFriendlyName (char *friendlyName)
	Free the memory allocated with AGHAF_Device_getFriendlyNameEthCard. More...

AGHAF_Status	AGHAF_ETH_getMacAddress (AGHAF_EthBus ethernet, AGHAF_ETH_MacAddress *macAddress)
	return the Ethernet mac address on device "device", and channel "index" More...

AGHAF_BOOL	AGHAF_ETH_getEthernetDiagLineState (AGHAF_EthBus ethernet)

AGHAF_Status	AGHAF_ETH_setEthernetDiagLineState (AGHAF_EthBus ethernet, AGHAF_BOOL active)
	AGHAF_ETH_setEthernetDiagLineState. More...

#define	AGHAF_ETH_ALEN 6
	size of a MAC address

typedef void *	AGHAF_EthBus
	Handle on a ethernet object.

typedef struct AGHAF_ETH_MacAddress	AGHAF_ETH_MacAddress
	contains a MAC address

Detailed Description

API to use ethernet on exxotest devices.

Function Documentation

◆ AGHAF_ETH_activate()

AGHAF_Status AGHAF_ETH_activate ( AGHAF_EthBus ethernet )

start the communication with the Ethernet

Parameters

ethernet handle on the Ethernet

Returns: status request information

◆ AGHAF_ETH_deactivate()

AGHAF_Status AGHAF_ETH_deactivate ( AGHAF_EthBus ethernet )

stop the communication with the Ethernet

Parameters

ethernet handle on the Ethernet

Returns: status request information

◆ AGHAF_ETH_freeFriendlyName()

void AGHAF_ETH_freeFriendlyName ( char * friendlyName )

Free the memory allocated with AGHAF_Device_getFriendlyNameEthCard.

Parameters

friendlyName name to free

◆ AGHAF_ETH_getBus()

AGHAF_EthBus AGHAF_ETH_getBus	(	AGHAF_Device	device,
		uint8_t	index
	)

return the Ethernet bus at index in parameter

Parameters

device	device handle from the desired Ethernet bus
index	index from the bus

Returns: Handle on a Ethernet bus

◆ AGHAF_ETH_getBusCount()

uint8_t AGHAF_ETH_getBusCount ( AGHAF_Device device )

return the number of CAN bus from a device

Parameters

device handle from the device

Returns: Number of CAN bus on the device

◆ AGHAF_ETH_getBusIndex()

uint8_t AGHAF_ETH_getBusIndex ( AGHAF_EthBus ethernet )

return the index from a Ethernet

Parameters

ethernet handle from the Ethernet

Returns: index from the bus

◆ AGHAF_ETH_getFriendlyNameEthCard()

void AGHAF_ETH_getFriendlyNameEthCard	(	AGHAF_EthBus	ethernet,
		char **	name
	)

Provide the friendly name associated to the network card.

Parameters

ethernet	handle from the desired Ethernet bus
name	pointer on the string name

Warning: the memory allocated in terminations must freed with AGHAF_CAN_Bus_freeSupportedTerminations

◆ AGHAF_ETH_getMacAddress()

AGHAF_Status AGHAF_ETH_getMacAddress	(	AGHAF_EthBus	ethernet,
		AGHAF_ETH_MacAddress *	macAddress
	)

return the Ethernet mac address on device "device", and channel "index"

Parameters

ethernet	handle from the desired Ethernet bus
macAddress	string of size 13 of uint8_t

Returns: status request information

◆ AGHAF_ETH_getParam()

AGHAF_Status AGHAF_ETH_getParam	(	AGHAF_EthBus	ethernet,
		AGHAF_ETH_Param	param,
		uint32_t *	value
	)

get a parameter from an ethernet card

Parameters

ethernet	handle on the Ethernet
param	parameter to get
value	value to get

Returns: status request information

◆ AGHAF_ETH_isActivated()

AGHAF_Status AGHAF_ETH_isActivated	(	AGHAF_EthBus	ethernet,
		AGHAF_BOOL *	isActivated
	)

allow to know if the communication on the Ethernet is started or not

Parameters

ethernet	handle on the Ethernet
isActivated	boolean to know if the communication is started or not

Returns: status request information

◆ AGHAF_ETH_setEthernetDiagLineState()

AGHAF_Status AGHAF_ETH_setEthernetDiagLineState	(	AGHAF_EthBus	ethernet,
		AGHAF_BOOL	active
	)

AGHAF_ETH_setEthernetDiagLineState.

Parameters

ethernet	handle on the Ethernet bus
active	AGHAF_TRUE ? activate : deactivate

Returns: status request information

◆ AGHAF_ETH_setParam()

AGHAF_Status AGHAF_ETH_setParam	(	AGHAF_EthBus	ethernet,
		AGHAF_ETH_Param	param,
		uint32_t	value
	)

set a parameter from an ethernet card

Parameters

ethernet	handle on the Ethernet
param	parameter to set
value	value to set

Returns: status request information