linlib.h

Go to the documentation of this file.

/*
 *                   Copyright 2003-2017 by KVASER AB, SWEDEN
 *                        WWW: http://www.kvaser.com
 *
 * This software is furnished under a license and may be used and copied
 * only in accordance with the terms of such license.
 */

#ifndef __LINLIB_H
#define __LINLIB_H

#include <stddef.h>

typedef int LinHandle;

#define linINVALID_HANDLE ((LinHandle)(-1))


typedef enum {
    linOK                  = 0, 
    linERR_NOMSG           = -1, 

    linERR_NOTRUNNING      = -3,

    linERR_RUNNING         = -4,

    linERR_MASTERONLY      = -5,

    linERR_SLAVEONLY       = -6,


    linERR_PARAM           = -7, 
    linERR_NOTFOUND        = -8, 
    linERR_NOMEM           = -9, 
    linERR_NOCHANNELS      = -10, 
    linERR_TIMEOUT         = -11, 
    linERR_NOTINITIALIZED  = -12, 
    linERR_NOHANDLES       = -13, 
    linERR_INVHANDLE       = -14, 
    linERR_CANERROR        = -15, 
    linERR_ERRRESP         = -16, 
    linERR_WRONGRESP       = -17, 
    linERR_DRIVER          = -18, 
    linERR_DRIVERFAILED    = -19, 
    linERR_NOCARD          = -20, 
    linERR_LICENSE         = -21, 
    linERR_INTERNAL        = -22, 
    linERR_NO_ACCESS       = -23, 
    linERR_VERSION         = -24, 
    linERR_NO_REF_POWER    = -25, 
    linERR_NOT_IMPLEMENTED = -26  
} LinStatus;
// sizeof(LinMessageInfo) should be 68 for correct alignment
#include <pshpack1.h>

typedef struct {
    unsigned long timestamp;

    unsigned long synchBreakLength;

    unsigned long frameLength;

    unsigned long bitrate;

    unsigned char checkSum;

    unsigned char idPar;

    unsigned short z; 

    unsigned long synchEdgeTime[4];

     unsigned long byteTime[8];
} LinMessageInfo;

#include <poppack.h>


#define LIN_TX           1 
#define LIN_RX           2 
#define LIN_WAKEUP_FRAME 4 
#define LIN_NODATA       8 
#define LIN_CSUM_ERROR   16 
#define LIN_PARITY_ERROR 32 
#define LIN_SYNCH_ERROR  64 
#define LIN_BIT_ERROR    128 

#define linCHANNELDATA_CARD_FIRMWARE_REV 9

#define LINERROR(f) ((f) & (LIN_NODATA | LIN_CSUM_ERROR | LIN_SYNCH_ERROR | LIN_BIT_ERROR))


// Define LINLIBAPI unless it's done already.
// (linlib.c provides its own definition of LINLIBAPI before including this file.)
//
#ifndef LINLIBAPI
#   if defined(__BORLANDC__)
#      define LINLIBAPI __stdcall
#   elif defined(_MSC_VER) || defined(__MWERKS__) || defined(__GNUC__)
#      define LINLIBAPI __stdcall
#   endif
#endif

#ifdef __cplusplus
extern "C" {
#endif

void LINLIBAPI linInitializeLibrary(void);

void LINLIBAPI linUnloadLibrary(void);


LinStatus LINLIBAPI linGetTransceiverData(int channel, unsigned char eanNo[8],
                                          unsigned char serNo[8], int *ttype);

LinHandle LINLIBAPI linOpenChannel(int channel, int flags);


#define LIN_MASTER 1 
#define LIN_SLAVE  2 

LinStatus LINLIBAPI linClose(LinHandle h);


LinStatus LINLIBAPI linGetVersion(int *major, int *minor, int *build);


LinStatus LINLIBAPI linGetFirmwareVersion(LinHandle h,
                                          unsigned char *bootVerMajor,
                                          unsigned char *bootVerMinor,
                                          unsigned char *bootVerBuild,
                                          unsigned char *appVerMajor,
                                          unsigned char *appVerMinor,
                                          unsigned char *appVerBuild);



LinStatus LINLIBAPI linGetChannelData(int channel, int item, void *buffer, size_t bufsize);

LinStatus LINLIBAPI linSetBitrate(LinHandle h, unsigned int bps);

LinStatus LINLIBAPI linBusOn(LinHandle h);

LinStatus LINLIBAPI linBusOff(LinHandle h);

unsigned long LINLIBAPI linReadTimer(LinHandle h);

LinStatus LINLIBAPI linWriteMessage(LinHandle h, unsigned int id, const void *msg,
                                    unsigned int dlc);

LinStatus LINLIBAPI linRequestMessage(LinHandle h, unsigned int id);

LinStatus LINLIBAPI linReadMessage(LinHandle h, unsigned int *id, void *msg,
                                   unsigned int *dlc, unsigned int *flags,
                                   LinMessageInfo *msgInfo);

LinStatus LINLIBAPI linReadMessageWait(LinHandle h, unsigned int *id, void *msg,
                                       unsigned int *dlc, unsigned int *flags,
                                       LinMessageInfo *msgInfo, unsigned long timeout);

LinStatus LINLIBAPI linUpdateMessage(LinHandle h, unsigned int id, const void *msg,
                                     unsigned int dlc);


LinStatus LINLIBAPI linSetupIllegalMessage(LinHandle h, unsigned int id,
                                           unsigned int cFlags, unsigned int delay);

#define LIN_MSG_DISTURB_CSUM   1

#define LIN_MSG_DISTURB_PARITY 2

#define LIN_MSG_USE_STANDARD_PARITY 0x04

#define LIN_MSG_USE_ENHANCED_PARITY 0x08

LinStatus LINLIBAPI linSetupLIN(LinHandle h, unsigned int lFlags, unsigned int bps);


#define LIN_ENHANCED_CHECKSUM  1

#define LIN_VARIABLE_DLC       2

LinStatus LINLIBAPI linWriteWakeup(LinHandle h, unsigned int count,
                                   unsigned int interval);


LinStatus LINLIBAPI linClearMessage(LinHandle h, unsigned int id);

LinStatus LINLIBAPI linWriteSync(LinHandle h, unsigned long timeout);

LinStatus LINLIBAPI linGetCanHandle(LinHandle h, unsigned int *canHandle);

#ifdef __cplusplus
}
#endif

#endif // __LINLIB_H