AGHAF 4.5.7
Annecy electronique Generic Hardware Access Framework
Loading...
Searching...
No Matches
aghaf_eth.h
Go to the documentation of this file.
1// Copyright (c) 2019 by ANNECY ELECTRONIQUE, Chavanod, France
2
6
7#ifndef EXXOTEST_AGHAF_ETHERNET_H
8#define EXXOTEST_AGHAF_ETHERNET_H
9
10#include <ghap/aghaf_eth_enums.h>
11
12#include "aghaf_global.h"
13
14#ifdef __cplusplus
15extern "C" {
16#endif
17
20
21#define AGHAF_ETH_ALEN 6
22
24typedef void *AGHAF_EthBus;
25
30
31AGHAF_PUBLIC_FUNCTION(AGHAF_EthBus, AGHAF_ETH_getBus,
32 (AGHAF_Device device, uint8_t index));
33AGHAF_PUBLIC_FUNCTION(uint8_t, AGHAF_ETH_getBusIndex, (AGHAF_EthBus ethernet));
34AGHAF_PUBLIC_FUNCTION(uint8_t, AGHAF_ETH_getBusCount, (AGHAF_Device device));
35
36AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_ETH_activate,
37 (AGHAF_EthBus ethernet));
38AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_ETH_deactivate,
39 (AGHAF_EthBus ethernet));
40AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_ETH_isActivated,
41 (AGHAF_EthBus ethernet, AGHAF_BOOL *isActivated));
42
43AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_ETH_getParam,
44 (AGHAF_EthBus ethernet, AGHAF_ETH_Param param,
45 uint32_t *value));
46AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_ETH_setParam,
47 (AGHAF_EthBus ethernet, AGHAF_ETH_Param param,
48 uint32_t value));
49
50AGHAF_PUBLIC_FUNCTION(void, AGHAF_ETH_getFriendlyNameEthCard,
51 (AGHAF_EthBus ethernet, char **name));
52AGHAF_PUBLIC_FUNCTION(void, AGHAF_ETH_freeFriendlyName, (char *friendlyName));
53AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_ETH_getMacAddress,
54 (AGHAF_EthBus ethernet,
55 AGHAF_ETH_MacAddress *macAddress));
56
58 (AGHAF_EthBus ethernet, AGHAF_BOOL active));
59
61
62#ifdef __cplusplus
63}
64#endif
65
66#endif // EXXOTEST_AGHAF_ETHERNET_H
#define AGHAF_ETH_ALEN
size of a MAC address
Definition aghaf_eth.h:21
AGHAF_Status AGHAF_ETH_setParam(AGHAF_EthBus ethernet, AGHAF_ETH_Param param, uint32_t value)
set a parameter from an ethernet card
Definition aghaf_eth.cpp:104
AGHAF_Status AGHAF_ETH_deactivate(AGHAF_EthBus ethernet)
stop the communication with the Ethernet
Definition aghaf_eth.cpp:58
void AGHAF_ETH_freeFriendlyName(char *friendlyName)
Free the memory allocated with AGHAF_Device_getFriendlyNameEthCard.
Definition aghaf_eth.cpp:127
AGHAF_Status AGHAF_ETH_isActivated(AGHAF_EthBus ethernet, AGHAF_BOOL *isActivated)
allow to know if the communication on the Ethernet is started or not
Definition aghaf_eth.cpp:71
AGHAF_Status AGHAF_ETH_setEthernetDiagLineState(AGHAF_EthBus ethernet, AGHAF_BOOL active)
AGHAF_ETH_setEthernetDiagLineState.
Definition aghaf_eth.cpp:161
void * AGHAF_EthBus
Handle on a ethernet object.
Definition aghaf_eth.h:24
AGHAF_Status AGHAF_ETH_activate(AGHAF_EthBus ethernet)
start the communication with the Ethernet
Definition aghaf_eth.cpp:46
AGHAF_Status AGHAF_ETH_getParam(AGHAF_EthBus ethernet, AGHAF_ETH_Param param, uint32_t *value)
get a parameter from an ethernet card
Definition aghaf_eth.cpp:89
AGHAF_EthBus AGHAF_ETH_getBus(AGHAF_Device device, uint8_t index)
return the Ethernet bus at index in parameter
Definition aghaf_eth.cpp:15
uint8_t AGHAF_ETH_getBusCount(AGHAF_Device device)
return the number of CAN bus from a device
Definition aghaf_eth.cpp:35
AGHAF_Status AGHAF_ETH_getMacAddress(AGHAF_EthBus ethernet, AGHAF_ETH_MacAddress *macAddress)
return the Ethernet mac address on device "device", and channel "index"
Definition aghaf_eth.cpp:138
uint8_t AGHAF_ETH_getBusIndex(AGHAF_EthBus ethernet)
return the index from a Ethernet
Definition aghaf_eth.cpp:25
void AGHAF_ETH_getFriendlyNameEthCard(AGHAF_EthBus ethernet, char **name)
Provide the friendly name associated to the network card.
Definition aghaf_eth.cpp:118
AGHAF_Status
enumerator to define the error type in aghaf functions
Definition aghaf_global.h:120
AGHAF_BOOL
enumerator to get a bool definition
Definition aghaf_global.h:114
void * AGHAF_Device
handle on an exxotest device
Definition aghaf_global.h:175
contains a MAC address
Definition aghaf_eth.h:27
uint8_t data[6]
MAC addres from a card.
Definition aghaf_eth.h:28