aghaf_docan.h

Go to the documentation of this file.

// Copyright (c) 2019 by ANNECY ELECTRONIQUE, Chavanod, France
 
 
#ifndef EXXOTEST_AGHAF_DOCAN_H
#define EXXOTEST_AGHAF_DOCAN_H
 
#include <ghap/aghaf_docan_enums.h>
 
#include "aghaf_can.h"
#include "aghaf_global.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
typedef enum {
  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,  
} AGHAF_DoCAN_EventType;
 
typedef void *AGHAF_DoCAN_Bus;
 
typedef void *AGHAF_DoCAN_Event;
 
typedef void *AGHAF_DoCAN_Channel;
 
typedef void (*AGHAF_DoCAN_Callback)(AGHAF_DoCAN_Event event,
                                     void *userContext);
 
/* Accessing bus */
AGHAF_PUBLIC_FUNCTION(AGHAF_DoCAN_Bus, AGHAF_DoCAN_getBus,
                      (AGHAF_Device device, uint8_t index));
AGHAF_PUBLIC_FUNCTION(uint32_t, AGHAF_DoCAN_getBusCount, (AGHAF_Device device));
 
AGHAF_PUBLIC_FUNCTION(void, AGHAF_DoCAN_registerCallback,
                      (AGHAF_DoCAN_Bus bus, AGHAF_DoCAN_Callback callback,
                       void *userContext));
AGHAF_PUBLIC_FUNCTION(void, AGHAF_DoCAN_deregisterCallback,
                      (AGHAF_DoCAN_Bus bus, AGHAF_DoCAN_Callback callback));
AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_DoCAN_getChannelCount,
                      (AGHAF_DoCAN_Bus bus, uint8_t *count));
AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_DoCAN_getFreeChannelCount,
                      (AGHAF_DoCAN_Bus bus, uint8_t *count));
AGHAF_PUBLIC_FUNCTION(AGHAF_DoCAN_Channel, AGHAF_DoCAN_createChannel,
                      (AGHAF_DoCAN_Bus bus));
AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_DoCAN_releaseChannel,
                      (AGHAF_DoCAN_Channel channel));
 
AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_DoCAN_Channel_setParam,
                      (AGHAF_DoCAN_Channel channel,
                       AGHAF_DoCAN_ChannelParam param, uint32_t value));
AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_DoCAN_Channel_getParam,
                      (AGHAF_DoCAN_Channel channel,
                       AGHAF_DoCAN_ChannelParam param, uint32_t *value));
AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_DoCAN_Channel_start,
                      (AGHAF_DoCAN_Channel channel));
AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_DoCAN_Channel_stop,
                      (AGHAF_DoCAN_Channel channel));
AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_DoCAN_Channel_send,
                      (AGHAF_DoCAN_Channel channel, uint32_t dataLen,
                       uint8_t const *data));
AGHAF_PUBLIC_FUNCTION(void, AGHAF_DoCAN_Channel_activateTrace,
                      (AGHAF_DoCAN_Channel channel, AGHAF_BOOL value));
 
/* Event functions */
AGHAF_PUBLIC_FUNCTION(AGHAF_DoCAN_EventType, AGHAF_DoCAN_Event_type,
                      (AGHAF_EventInfo event));
AGHAF_PUBLIC_FUNCTION(uint8_t, AGHAF_DoCAN_Event_getBusIndex,
                      (AGHAF_DoCAN_Event event));
AGHAF_PUBLIC_FUNCTION(uint32_t, AGHAF_DoCAN_Event_getDataSize,
                      (AGHAF_DoCAN_Event event));
AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_DoCAN_Event_getData,
                      (AGHAF_DoCAN_Event event, uint8_t *data, uint32_t *size));
AGHAF_PUBLIC_FUNCTION(AGHAF_CAN_Identifier, AGHAF_DoCAN_Event_getId,
                      (AGHAF_DoCAN_Event event));
AGHAF_PUBLIC_FUNCTION(uint8_t, AGHAF_DoCAN_Event_getError,
                      (AGHAF_DoCAN_Event event));
AGHAF_PUBLIC_FUNCTION(AGHAF_DoCAN_Channel, AGHAF_DoCAN_Event_getChannel,
                      (AGHAF_DoCAN_Event event));
 
 
#ifdef __cplusplus
}
#endif
 
#endif  // EXXOTEST_AGHAF_DOCAN_H