kvj1939lib_types.h

Go to the documentation of this file.

#ifndef KVJ1939LIB_TYPES_H
#define KVJ1939LIB_TYPES_H
 
/* API type definitions */
#include <stdbool.h>
#include <stdint.h>
 
typedef enum J1939Result {
    J1939_STATUS_OK = 0,
    J1939_STATUS_ERROR = -1,
    J1939_STATUS_INVALID_CHANNEL = -2,
    J1939_STATUS_INVALID_PARAMS = -3,
    J1939_STATUS_NOT_SUPPORTED = -4,
    J1939_STATUS_TIMEOUT = -5,
    J1939_STATUS_TX_BUFFER_FULL = -6,
    J1939_STATUS_ADDRESS_CLAIM_LOST = -7,
    J1939_STATUS_BUFFER_TOO_SMALL = -8,
    J1939_STATUS_ERROR_FRAME = -9,
} J1939Result;
 
typedef enum J1939ChannelOption {
    J1939_OPTION_TX_ECHO,
    J1939_OPTION_TP_PASSTHROUGH_MODE,
    J1939_OPTION_TP_BAM_INTERPACKET_TIME,
    J1939_OPTION_TP_MAX_PACKETS_IN_RTS,
    J1939_OPTION_TP_MAX_PACKETS_IN_CTS,
    J1939_OPTION_TP_T1_TIMEOUT,
    J1939_OPTION_TP_T2_TIMEOUT,
    J1939_OPTION_TP_T3_TIMEOUT,
    J1939_OPTION_TP_T4_TIMEOUT,
} J1939ChannelOption;
 
typedef uint32_t J1939ChannelHandle;
 
typedef struct J1939ChannelParams {
    uint32_t channel;
    bool support_virtual;
    uint32_t bit_rate;
} J1939ChannelParams;
 
typedef struct J1939ChannelResult {
    J1939Result result;
    J1939ChannelHandle hnd;
} J1939ChannelResult;
 
typedef struct J1939Identifier {
    uint32_t pgn;
    uint8_t priority;
    uint8_t src_addr;
    uint8_t dest_addr;
} J1939Identifier;
 
typedef struct J1939WriteParams {
    struct J1939Identifier id;
    const uint8_t* payload;
    uint32_t payload_length;
    uint32_t request_handle;
} J1939WriteParams;
 
typedef struct J1939ReadResult {
    J1939Result result;
    J1939Identifier id;
    uint64_t timestamp;
    uint32_t payload_length;
} J1939ReadResult;
 
typedef struct J1939ChannelOptionResult {
    J1939Result result;
    uint32_t value;
} J1939ChannelOptionResult;
 
typedef void (*J1939RxCallback)(J1939ChannelHandle hnd, void* context, J1939Identifier id,
                                uint64_t timestamp, const uint8_t* payload, uint32_t payload_length,
                                bool error);
 
typedef void (*J1939TxCallback)(J1939ChannelHandle hnd, void* context, uint32_t request_handle,
                                J1939Identifier id, uint64_t timestamp, bool error);
 
typedef void (*J1939AcCallback)(J1939ChannelHandle hnd, void* context, uint8_t address, bool valid);
 
#endif /* KVJ1939LIB_TYPES_H */