aghaf_global.h

Go to the documentation of this file.

// Copyright (c) 2019 by ANNECY ELECTRONIQUE, Chavanod, France
 
 
#ifndef EXXOTEST_AGHAF_GLOBAL_H
#define EXXOTEST_AGHAF_GLOBAL_H
 
#if (defined(WIN64) || defined(_WIN64) || defined(__WIN64__))
#  define AGHAF_OS_WIN
#  define AGHAF_OS_WIN32
#  define AGHAF_OS_WIN64
#elif (defined(WIN32) || defined(_WIN32) || defined(__WIN32__) || defined(__NT__))
#  define AGHAF_OS_WIN
#  define AGHAF_OS_WIN32
#elif defined(__ANDROID__) || defined(ANDROID)
#  define AGHAF_OS_ANDROID
#  define AGHAF_OS_LINUX
#elif (defined(__linux__) || defined(__linux))
#  define AGHAF_OS_LINUX
#endif
 
# if (defined(__aarch64__) || defined(__aarch64__) || defined(__amd64) || defined(__amd64__) || defined(__x86_64) || defined(__x86_64__) || defined(_M_X64) || defined(_M_AMD64))
#  define AGHAF_PTR_SIZE 8
#else
#  define AGHAF_PTR_SIZE 4
#endif
 
#if ((defined(__SUNPRO_C) && __SUNPRO_C >= 0x570) || (defined(_MSC_VER) && _MSC_VER >= 1600) || (defined(__STDC__) && __STDC__ && defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L) || (defined (__WATCOMC__) && (defined (_STDINT_H_INCLUDED) || __WATCOMC__ >= 1250)) || (defined(__GNUC__) && (__GNUC__ > 3 || defined(_STDINT_H) || defined(_STDINT_H_) || defined (__UINT_FAST64_TYPE__)) ))
#  include <stdint.h>
#else
    typedef unsigned char uint8_t;
    typedef unsigned short uint16_t;
    typedef unsigned int uint32_t;
    typedef unsigned long long uint64_t;
#  ifndef __BORLANDC__
      typedef signed char int8_t;
#  endif
    typedef short int16_t;
    typedef int int32_t;
    typedef long long int64_t;
#  if AGHAF_PTR_SIZE == 8
      typedef uint64_t  uintptr_t;
      typedef int64_t  intptr_t;
#  elif AGHAF_PTR_SIZE == 4
      typedef uint32_t uintptr_t;
      typedef int32_t intptr_t;
#  else
#    error Unsupported pointer size
#  endif
#endif
 
#if defined(AGHAF_OS_WIN32) && !defined(AGHAF_OS_WIN64)
#  define AGHAF_API __cdecl
#else
#  define AGHAF_API
#endif
 
//  Macros used to declare public functions
#define AGHAF_PUBLIC_FUNCTION(ret, name, params ) AGHAF_IMPORTEXPORT ret AGHAF_API name params
 
#if defined(AGHAF_OS_WIN)
#  ifdef AGHAF_LIBRARY
#    define AGHAF_IMPORTEXPORT __declspec(dllexport)
#  else
#    ifdef AGHAF_DYNAMIC_LIBRARY
#      ifdef AGHAF_DYNAMIC_LIBRARY_INIT
#        define AGHAF_DYNAMIC_EXTERN
#        define AGHAF_DYNAMIC_NULL = NULL
#      else
#        define AGHAF_DYNAMIC_EXTERN extern
#        define AGHAF_DYNAMIC_NULL
#      endif
#      define AGHAF_IMPORTEXPORT typedef
#      undef AGHAF_PUBLIC_FUNCTION
#      define AGHAF_PUBLIC_FUNCTION(ret, name, params) AGHAF_IMPORTEXPORT ret(AGHAF_API * t ## name) params; AGHAF_DYNAMIC_EXTERN t ## name name AGHAF_DYNAMIC_NULL
#    else
#      define AGHAF_IMPORTEXPORT __declspec(dllimport)
#    endif
#  endif
#else
#  define AGHAF_IMPORTEXPORT
#endif
 
#if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5)
#define AGHAF_DEPRECATED_FOR(f) \
  __attribute__((deprecated(#f "is deprecated.")))
#else
#define AGHAF_DEPRECATED_FOR(f)
#endif /* __GNUC__ */
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
typedef enum
{
    AGHAF_FALSE = 0, 
    AGHAF_TRUE = 1   
} AGHAF_BOOL;
 
typedef enum
{
    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 
} AGHAF_Status;
 
typedef enum
{
    AGHAF_OFFLINE, 
    AGHAF_USB,     
    AGHAF_ETH      
} AGHAF_ConnectionMode;
 
 
typedef void * AGHAF_Device;
 
typedef void * AGHAF_Event;
 
typedef void (*AGHAF_Callback)(AGHAF_Event event, void *userContext);
 
typedef enum
{
    AGHAF_Device_noEvent,   
    AGHAF_Device_Arrival,   
    AGHAF_Device_Leave,     
    AGHAF_Device_Present    
} AGHAF_DeviceEvent;
 
typedef enum
{
    AGHAF_TypeNoEvent,        
    AGHAF_TypeDeviceEvent,    
    AGHAF_TypeEthernetEvent,  
    AGHAF_TypeCanEvent,       
    AGHAF_TypeDoCanEvent      
} AGHAF_TypeEvent;
 
typedef enum AGHAF_DeviceState
{
    AGHAF_DeviceState_error = 0, 
    AGHAF_DeviceState_boot, 
    AGHAF_DeviceState_ready 
} AGHAF_DeviceState;
 
typedef struct AGHAF_DeviceInfo
{
    char name[64]; 
    char productNo[64]; 
    char serialNo[64]; 
    uint16_t bootVersion; 
    uint16_t firmwareVersion; 
    char hardwareVersion[64]; 
    AGHAF_DeviceState deviceState; 
    uint8_t hardwareUniqueID[16]; 
} AGHAF_DeviceInfo;
 
typedef struct AGHAF_EventInfo
{
    AGHAF_TypeEvent type;        
    uint32_t event;              
    uint64_t timestamp;          
    uint32_t timestampPrecision; 
    AGHAF_BOOL absolute;         
} AGHAF_EventInfo;
 
AGHAF_PUBLIC_FUNCTION(uint32_t, AGHAF_getVersion, (void));
AGHAF_PUBLIC_FUNCTION(const char*, AGHAF_getVersionString, (void));
AGHAF_PUBLIC_FUNCTION(uint32_t, AGHAF_getServiceVersion, (void));
AGHAF_PUBLIC_FUNCTION(AGHAF_BOOL, AGHAF_isServiceRunning, (void));
 
AGHAF_PUBLIC_FUNCTION(char const*, AGHAF_DeviceEvent_getProductName, (AGHAF_Event event));
AGHAF_PUBLIC_FUNCTION(char const*, AGHAF_DeviceEvent_getProductNumber, (AGHAF_Event event));
AGHAF_PUBLIC_FUNCTION(char const*, AGHAF_DeviceEvent_getSerialNumber, (AGHAF_Event event));
AGHAF_PUBLIC_FUNCTION(uint8_t const*, AGHAF_DeviceEvent_getHardwareUniqueId, (AGHAF_Event event));
 
AGHAF_PUBLIC_FUNCTION(uint32_t, AGHAF_getDeviceCount, (void));
AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_getDeviceList, (AGHAF_DeviceInfo **devices, uint32_t *size));
AGHAF_PUBLIC_FUNCTION(void, AGHAF_freeDeviceList, (AGHAF_DeviceInfo *devices));
AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_refreshDeviceList, (void));
AGHAF_PUBLIC_FUNCTION(AGHAF_Device, AGHAF_getDeviceBySN, (const char *productNumber, const char *serialNumber));
AGHAF_PUBLIC_FUNCTION(AGHAF_Device, AGHAF_getDeviceByHardID, (uint8_t const* hardwareID));
AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_getDeviceInfo, (AGHAF_Device device, AGHAF_DeviceInfo *deviceInfo));
 
AGHAF_PUBLIC_FUNCTION(AGHAF_ConnectionMode, AGHAF_Device_getConnectionMode, (AGHAF_Device device));
AGHAF_PUBLIC_FUNCTION(void, AGHAF_Device_getFriendlyNameEthCard, (AGHAF_Device device, char **name));
AGHAF_PUBLIC_FUNCTION(void, AGHAF_Device_freeFriendlyName, (char *friendlyName));
AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_Device_getUsbInfo, (AGHAF_Device device, uint16_t *vid, uint16_t *pid, uint16_t *rev));
 
AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_openDevice, (AGHAF_Device device));
AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_closeDevice, (AGHAF_Device device));
AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_Device_getTimestamp, (AGHAF_Device device, uint64_t *timestamp));
AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_Event_getInfo, (AGHAF_Event event, AGHAF_EventInfo *info));
AGHAF_PUBLIC_FUNCTION(void, AGHAF_registerCallback, (AGHAF_Callback callback, void * userContext));
AGHAF_PUBLIC_FUNCTION(void, AGHAF_deregisterCallback, (AGHAF_Callback callback));
 
 
#ifdef __cplusplus
}
#endif
 
 
#endif // EXXOTEST_AGHAF_GLOBAL_H