AGHAF  4.5.1
Annecy electronique Generic Hardware Access Framework
aghaf_global.h File Reference
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  AGHAF_DeviceInfo
 structure containing the informtions about a device More...
 
struct  AGHAF_EventInfo
 generic stucture to read an event in a callback More...
 

Macros

#define AGHAF_API
 
#define AGHAF_DEPRECATED_FOR(f)
 
#define AGHAF_IMPORTEXPORT
 
#define AGHAF_PTR_SIZE   4
 
#define AGHAF_PUBLIC_FUNCTION(ret, name, params)   AGHAF_IMPORTEXPORT ret AGHAF_API name params
 

Typedefs

typedef short int16_t
 
typedef int int32_t
 
typedef long long int64_t
 
typedef signed char int8_t
 
typedef int32_t intptr_t
 
typedef unsigned short uint16_t
 
typedef unsigned int uint32_t
 
typedef unsigned long long uint64_t
 
typedef unsigned char uint8_t
 
typedef uint32_t uintptr_t
 
enum  AGHAF_BOOL { AGHAF_FALSE = 0 , AGHAF_TRUE = 1 }
 enumerator to get a bool definition More...
 
typedef void(* AGHAF_Callback) (AGHAF_Event event, void *userContext)
 callback for the devices hotplug management More...
 
AGHAF_Status AGHAF_closeDevice (AGHAF_Device device)
 close the device More...
 
enum  AGHAF_ConnectionMode { AGHAF_OFFLINE , AGHAF_USB , AGHAF_ETH }
 deprecated More...
 
void AGHAF_deregisterCallback (AGHAF_Callback callback)
 Deregister a callback. More...
 
typedef void * AGHAF_Device
 handle on an exxotest device
 
void AGHAF_Device_freeFriendlyName (char *friendlyName)
 Free the memory allocated with AGHAF_Device_getFriendlyNameEthCard. More...
 
AGHAF_ConnectionMode AGHAF_Device_getConnectionMode (AGHAF_Device device)
 AGHAF_Device_getConnectionMode. More...
 
void AGHAF_Device_getFriendlyNameEthCard (AGHAF_Device device, char **name)
 AGHAF_Device_getFriendlyNameEthCard. More...
 
AGHAF_Status AGHAF_Device_getTimestamp (AGHAF_Device device, uint64_t *timestamp)
 Return the current timestamp on the device. More...
 
AGHAF_Status AGHAF_Device_getUsbInfo (AGHAF_Device device, uint16_t *vid, uint16_t *pid, uint16_t *rev)
 AGHAF_Device_getUsbInfo. More...
 
enum  AGHAF_DeviceEvent { AGHAF_Device_noEvent , AGHAF_Device_Arrival , AGHAF_Device_Leave , AGHAF_Device_Present }
 device event fot hotplug management More...
 
uint8_t const * AGHAF_DeviceEvent_getHardwareUniqueId (AGHAF_Event event)
 return the hardware unique id from the device which emitted the device event More...
 
char const * AGHAF_DeviceEvent_getProductName (AGHAF_Event event)
 return the product name from the device which emitted the device event More...
 
char const * AGHAF_DeviceEvent_getProductNumber (AGHAF_Event event)
 return the product number from the device which emitted the device event More...
 
char const * AGHAF_DeviceEvent_getSerialNumber (AGHAF_Event event)
 return the serial number from the device which emitted the device event More...
 
typedef struct AGHAF_DeviceInfo AGHAF_DeviceInfo
 structure containing the informtions about a device
 
enum  AGHAF_DeviceState { AGHAF_DeviceState_error = 0 , AGHAF_DeviceState_boot , AGHAF_DeviceState_ready }
 current state of the device (in the boot or in the application part of the firmware) More...
 
typedef enum AGHAF_DeviceState AGHAF_DeviceState
 current state of the device (in the boot or in the application part of the firmware)
 
typedef void * AGHAF_Event
 Typedef of a native event handle that can be used to wait for events.
 
AGHAF_Status AGHAF_Event_getInfo (AGHAF_Event event, AGHAF_EventInfo *info)
 AGHAF_Event_getInfo. More...
 
typedef struct AGHAF_EventInfo AGHAF_EventInfo
 generic stucture to read an event in a callback
 
void AGHAF_freeDeviceList (AGHAF_DeviceInfo *devices)
 Free the memory allocated with AGHAF_getDeviceList. More...
 
AGHAF_Device AGHAF_getDeviceByHardID (uint8_t const *hardwareID)
 AGHAF_getDeviceByHardID. More...
 
AGHAF_Device AGHAF_getDeviceBySN (const char *productNumber, const char *serialNumber)
 Return the handle on the specified device. More...
 
uint32_t AGHAF_getDeviceCount (void)
 Return the number of devices onnected. More...
 
AGHAF_Status AGHAF_getDeviceInfo (AGHAF_Device device, AGHAF_DeviceInfo *deviceInfo)
 Return the informations from a device. More...
 
AGHAF_Status AGHAF_getDeviceList (AGHAF_DeviceInfo **devices, uint32_t *size)
 Provide the list of devices connected. More...
 
uint32_t AGHAF_getServiceVersion (void)
 Return the version from aeds. More...
 
uint32_t AGHAF_getVersion (void)
 Return the version from Aghaf. More...
 
const char * AGHAF_getVersionString (void)
 Return the version from Aghaf. More...
 
AGHAF_BOOL AGHAF_isServiceRunning (void)
 Inform if ghaston is running or not. More...
 
AGHAF_Status AGHAF_openDevice (AGHAF_Device device)
 Open a device. More...
 
AGHAF_Status AGHAF_refreshDeviceList (void)
 Call the device event callbacks with the devices connected. More...
 
void AGHAF_registerCallback (AGHAF_Callback callback, void *userContext)
 Register a callback for the device event. More...
 
enum  AGHAF_Status {
  AGHAF_STATUS_OK = 0 , AGHAF_ERROR_PARAM , AGHAF_ERROR_NOT_ENOUGH_MEMORY , AGHAF_ERROR_OUT_OF_MEMORY ,
  AGHAF_ERROR_NOT_IMPLEMENTED , AGHAF_ERROR_END_REACHED , AGHAF_INTERNAL_ERROR , AGHAF_ERROR_CONNECTION ,
  AGHAF_ERROR_BUS_NOT_FOUND , AGHAF_ERROR_PENDING , AGHAF_ERROR_WRONG_STATE , AGHAF_ERROR_NOT_ENOUGH_BUS ,
  AGHAF_WRONG_SERVICE_VERSION , AGHAF_TIMEOUT_COM , AGHAF_DEPRECATED , AGHAF_ERROR_SEQUENCE ,
  AGHAF_ERROR_FIFOFULL , AGHAF_ERROR_ALREADY_OPEN , AGHAF_ERROR_BUSY , AGHAF_ERROR_NOMORECHANNEL ,
  AGHAF_ERROR_UNKNOWN , AGHAF_ERROR_WRONG_SESSION_TYPE , AGHAF_ERROR_NO_DATA = 0xff
}
 enumerator to define the error type in aghaf functions More...
 
enum  AGHAF_TypeEvent {
  AGHAF_TypeNoEvent , AGHAF_TypeDeviceEvent , AGHAF_TypeEthernetEvent , AGHAF_TypeCanEvent ,
  AGHAF_TypeDoCanEvent
}
 type of event received in a callback More...