aghaf_can.h

Go to the documentation of this file.

// Copyright (c) 2019 by ANNECY ELECTRONIQUE, Chavanod, France
 
 
#ifndef EXXOTEST_AGHAF_CAN_H
#define EXXOTEST_AGHAF_CAN_H
 
#include "aghaf_global.h"
#include <ghap/aghaf_can_enums.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
typedef enum
{
    AGHAF_CAN_IdStd, 
    AGHAF_CAN_IdXtd 
} AGHAF_CAN_IdentifierType;
 
typedef enum
{
    AGHAF_CAN_DataFrame = 0, 
    AGHAF_CAN_RemoteFrame = 1 
} AGHAF_CAN_FrameType;
 
typedef enum
{
    AGHAF_CAN_BUS_UNKNOW        = 0,    
    AGHAF_CAN_BUS_ACTIVE        ,       
    AGHAF_CAN_BUS_PASSIVE       ,       
    AGHAF_CAN_BUS_BUSOFF                
} AGHAF_CAN_BusState;
 
typedef enum {
    AGHAF_CAN_EVENT_UNKNOW      = 0,        
    AGHAF_CAN_EVENT_MSGTX       = 1,        
    AGHAF_CAN_EVENT_MSGRX       = 2,        
    AGHAF_CAN_EVENT_ERROR       = 3,        
    AGHAF_CAN_EVENT_BUSCHANGE   = 4,        
    AGHAF_CAN_EVENT_BUSLOAD     = 5,        
} AGHAF_CAN_EventType;
 
typedef enum {
    AGHAF_CAN_REJECT_ALL = 0, 
    AGHAF_CAN_REJECT_STD = 1, 
    AGHAF_CAN_REJECT_EXT = 2, 
    AGHAF_CAN_REJECT_NONE = 3 
} AGHAF_CAN_RejectType;
 
typedef enum {
    AGHAF_CAN_FILTER_ID_STD = 0, 
    AGHAF_CAN_FILTER_ID_XTD = 1 
} AGHAF_CAN_FilterId;
 
typedef enum {
    AGHAF_CAN_FILTER_MODE_ACCEPT = 0, 
    AGHAF_CAN_FILTER_MODE_REJECT = 1 
} AGHAF_CAN_FilterMode;
 
typedef enum {
    AGHAF_CAN_FILTER_TYPE_CLASSIC = 0, 
    AGHAF_CAN_FILTER_TYPE_SINGLE = 1, 
    AGHAF_CAN_FILTER_TYPE_DUAL = 2, 
    AGHAF_CAN_FILTER_TYPE_RANGE = 3 
} AGHAF_CAN_FILTER_Type;
 
typedef void * AGHAF_CAN_Bus; 
 
typedef void * AGHAF_CAN_Frame; 
 
typedef void * AGHAF_CAN_Event;
 
typedef void const* AGHAF_CAN_Event_busInfo;
 
typedef void (*AGHAF_CAN_Callback)(AGHAF_CAN_Event event, void *userContext);
 
/* Structures */
#pragma pack(push, 1)
 
typedef struct AGHAF_CAN_Identifier
{
    AGHAF_CAN_IdentifierType type; 
    union {
        uint16_t std: 11; 
        uint32_t xtd: 29; 
    } id; 
} AGHAF_CAN_Identifier;
 
#pragma pack(pop)
 
typedef struct AGHAF_CAN_FilterDesc
{
    uint16_t caps;
    uint16_t count; 
} AGHAF_CAN_FilterDesc;
 
/* Accessing bus */
AGHAF_PUBLIC_FUNCTION(AGHAF_CAN_Bus, AGHAF_CAN_getBus, (AGHAF_Device device, uint8_t index));
AGHAF_PUBLIC_FUNCTION(uint8_t, AGHAF_CAN_getBusIndex, (AGHAF_CAN_Bus bus));
AGHAF_PUBLIC_FUNCTION(uint8_t, AGHAF_CAN_getBusCount, (AGHAF_Device device));
 
/* Event handling */
AGHAF_PUBLIC_FUNCTION(void, AGHAF_CAN_registerCallback, (AGHAF_CAN_Bus bus, AGHAF_CAN_Callback callback, void *userContext));
AGHAF_PUBLIC_FUNCTION(void, AGHAF_CAN_deregisterCallback, (AGHAF_CAN_Bus bus, AGHAF_CAN_Callback callback));
 
AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_CAN_Bus_getParam, (AGHAF_CAN_Bus bus, AGHAF_CAN_Param param, uint32_t *value));
AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_CAN_Bus_setParam, (AGHAF_CAN_Bus bus, AGHAF_CAN_Param param, uint32_t value));
 
/* Functions for bus configuration */
AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_CAN_Bus_supportedModes, (AGHAF_CAN_Bus bus, AGHAF_CAN_Mode **modes, uint8_t *nbModes));
AGHAF_PUBLIC_FUNCTION(void, AGHAF_CAN_Bus_freeSupportedModes, (AGHAF_CAN_Mode *modes));
 
AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_CAN_Bus_state, (AGHAF_CAN_Bus bus, AGHAF_CAN_BusState* canBusState));
AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_CAN_Bus_BusOn, (AGHAF_CAN_Bus bus));
AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_CAN_Bus_activate, (AGHAF_CAN_Bus bus));
AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_CAN_Bus_deactivate, (AGHAF_CAN_Bus bus));
AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_CAN_Bus_isActivated, (AGHAF_CAN_Bus bus, AGHAF_BOOL *isActivated));
 
AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_CAN_Bus_supportedTerminations, (AGHAF_CAN_Bus bus, uint32_t **terminations, uint32_t *nbTerminations));
AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_CAN_Bus_supportedTerminationsLs, (AGHAF_CAN_Bus bus, uint32_t **terminations, uint32_t *nbTerminations));
AGHAF_PUBLIC_FUNCTION(void, AGHAF_CAN_Bus_freeSupportedTerminations, (uint32_t *terminations));
 
/* Functions for perdiodic frames */
AGHAF_PUBLIC_FUNCTION(uint8_t, AGHAF_CAN_Bus_getPeriodicCount, (AGHAF_CAN_Bus bus));
AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_CAN_Bus_sendPeriodic, (AGHAF_CAN_Bus bus, AGHAF_CAN_Frame frame, uint8_t index, uint8_t flags, uint32_t period));
 
/* Functions for filters */
AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_CAN_Bus_addFilter, (AGHAF_CAN_Bus bus, AGHAF_CAN_FilterId idType, AGHAF_CAN_FILTER_Type type, AGHAF_CAN_FilterMode mode, uint32_t id1, uint32_t id2));
AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_CAN_Bus_clearFilters, (AGHAF_CAN_Bus bus));
AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_CAN_Bus_filtersCount, (AGHAF_CAN_Bus bus, AGHAF_CAN_FilterId idType, uint16_t *count));
AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_CAN_Bus_supportedFilters, (AGHAF_CAN_Bus bus, uint16_t *globalFilterCaps, AGHAF_CAN_FilterDesc **values, uint16_t *size));
AGHAF_PUBLIC_FUNCTION(void, AGHAF_CAN_Bus_freeSupportedFilters, (AGHAF_CAN_FilterDesc *values));
AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_CAN_Bus_reject, (AGHAF_CAN_Bus bus, AGHAF_CAN_RejectType rejectType, AGHAF_BOOL rtr));
 
/* Functions for CAN frames */
AGHAF_PUBLIC_FUNCTION(AGHAF_CAN_Frame, AGHAF_CAN_Frame_new, (void));
AGHAF_PUBLIC_FUNCTION(void, AGHAF_CAN_Frame_delete, (AGHAF_CAN_Frame frame));
AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_CAN_Frame_setId, (AGHAF_CAN_Frame frame, AGHAF_CAN_Identifier *identifier));
AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_CAN_Frame_id, (AGHAF_CAN_Frame frame, AGHAF_CAN_Identifier *identifier));
AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_CAN_Frame_setFrameType, (AGHAF_CAN_Frame frame, AGHAF_CAN_FrameType type));
AGHAF_PUBLIC_FUNCTION(AGHAF_CAN_FrameType, AGHAF_CAN_Frame_frameType, (AGHAF_CAN_Frame frame) );
AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_CAN_Frame_setFDF, (AGHAF_CAN_Frame frame, AGHAF_BOOL fdf, AGHAF_BOOL esi, AGHAF_BOOL brs));
AGHAF_PUBLIC_FUNCTION(AGHAF_BOOL, AGHAF_CAN_Frame_fdf, (AGHAF_CAN_Frame frame));
AGHAF_PUBLIC_FUNCTION(AGHAF_BOOL, AGHAF_CAN_Frame_esi, (AGHAF_CAN_Frame frame));
AGHAF_PUBLIC_FUNCTION(AGHAF_BOOL, AGHAF_CAN_Frame_brs, (AGHAF_CAN_Frame frame));
AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_CAN_Frame_setData, (AGHAF_CAN_Frame frame, const void *data, int64_t size));
AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_CAN_Frame_data, (AGHAF_CAN_Frame frame, void *data, int64_t size));
AGHAF_PUBLIC_FUNCTION(int64_t, AGHAF_CAN_Frame_dataSize, (AGHAF_CAN_Frame frame));
 
AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_CAN_sendFrame, (AGHAF_CAN_Bus bus, AGHAF_CAN_Frame frame));
AGHAF_PUBLIC_FUNCTION(AGHAF_Status, AGHAF_CAN_sendMessage, (AGHAF_CAN_Bus bus, uint32_t ident, uint8_t flags, uint16_t dataLen, uint8_t const* data));
 
/* Event functions */
AGHAF_PUBLIC_FUNCTION(AGHAF_CAN_Frame, AGHAF_CAN_Event_frame, (AGHAF_CAN_Event event));
AGHAF_PUBLIC_FUNCTION(AGHAF_CAN_EventType, AGHAF_CAN_typeEvent, (AGHAF_EventInfo event));
AGHAF_PUBLIC_FUNCTION(AGHAF_CAN_Event_busInfo, AGHAF_CAN_getEventBusInfo, (AGHAF_CAN_Event event));
AGHAF_PUBLIC_FUNCTION(uint8_t, AGHAF_CAN_getEventBusIndex, (AGHAF_CAN_Event event));
AGHAF_PUBLIC_FUNCTION(uint32_t, AGHAF_CAN_Event_chipState, (AGHAF_CAN_Event_busInfo busState));
AGHAF_PUBLIC_FUNCTION(uint32_t, AGHAF_CAN_Event_busLoad, (AGHAF_CAN_Event_busInfo busState));
AGHAF_PUBLIC_FUNCTION(uint32_t, AGHAF_CAN_Event_busError, (AGHAF_CAN_Event_busInfo busState));
 
/* asynchronous API */
typedef void (*AGHAF_CAN_asyncSendFrame_Callback)(AGHAF_Status status, uint32_t id, void *userContext);
AGHAF_PUBLIC_FUNCTION(void, AGHAF_CAN_asyncSendFrame_registerCallback, (AGHAF_CAN_Bus bus, AGHAF_CAN_asyncSendFrame_Callback callback, void *userContext));
AGHAF_PUBLIC_FUNCTION(void, AGHAF_CAN_asyncSendFrame_deregisterCallback, (AGHAF_CAN_Bus bus, AGHAF_CAN_asyncSendFrame_Callback callback));
AGHAF_PUBLIC_FUNCTION(void, AGHAF_CAN_asyncSendFrame, (AGHAF_CAN_Bus bus, AGHAF_CAN_Frame frame, uint32_t *id));
 
 
#ifdef __cplusplus
}
#endif
 
#endif