canlib.h

Go to the documentation of this file.

/*
 *             Copyright 2023 by Kvaser AB, Molndal, Sweden
 *                         http://www.kvaser.com
 *
 * This software is dual licensed under the following two licenses:
 * BSD-new and GPLv2. You may use either one. See the included
 * COPYING file for details.
 *
 * License: BSD-new
 * ==============================================================================
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the <organization> nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 *
 * License: GPLv2
 * ==============================================================================
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 *
 *
 * IMPORTANT NOTICE:
 * ==============================================================================
 * This source code is made available for free, as an open license, by Kvaser AB,
 * for use with its applications. Kvaser AB does not accept any liability
 * whatsoever for any third party patent or other immaterial property rights
 * violations that may result from any usage of this source code, regardless of
 * the combination of source code and various applications that it can be used
 * in, or with.
 *
 * -----------------------------------------------------------------------------
 */

#ifndef _CANLIB_H_
#define _CANLIB_H_

#include <stdlib.h>

#include <stdint.h>

#include "canstat.h"

typedef int canHandle;

#define canINVALID_HANDLE (-1) 


typedef canHandle CanHandle;

typedef struct canNotifyData {
    void *tag;
    int eventType;
    union {
        struct {
            unsigned long time;
        } busErr;
        struct {
            long id;
            unsigned long time;
        } rx;
        struct {
            long id;
            unsigned long time;
        } tx;
        struct {
            unsigned char busStatus;
            unsigned char txErrorCounter;
            unsigned char rxErrorCounter;
            unsigned long time;
        } status;
    } info;
} canNotifyData;


// The canWANT_xxx names are also obsolete, use canOPEN_xxx instead for new developments.
#define canWANT_EXCLUSIVE               0x0008
#define canWANT_EXTENDED                0x0010
#define canWANT_VIRTUAL                 0x0020

#define canOPEN_EXCLUSIVE               0x0008

#define canOPEN_REQUIRE_EXTENDED        0x0010

#define canOPEN_ACCEPT_VIRTUAL         0x0020

#define canOPEN_OVERRIDE_EXCLUSIVE     0x0040

#define canOPEN_REQUIRE_INIT_ACCESS    0x0080

#define canOPEN_NO_INIT_ACCESS         0x0100

#define canOPEN_ACCEPT_LARGE_DLC       0x0200 // DLC can be greater than 8

#define canOPEN_CAN_FD                 0x0400

#define canOPEN_CAN_FD_NONISO          0x0800


#define canOPEN_INTERNAL_L                 0x1000

#define canFILTER_ACCEPT        1
#define canFILTER_REJECT        2

#define canFILTER_SET_CODE_STD  3

#define canFILTER_SET_MASK_STD  4

#define canFILTER_SET_CODE_EXT  5

#define canFILTER_SET_MASK_EXT  6

#define canFILTER_NULL_MASK     0L

#define canDRIVER_NORMAL           4

#define canDRIVER_SILENT           1

#define canDRIVER_SELFRECEPTION    8

#define canDRIVER_OFF              0

#define canBITRATE_1M        (-1)

#define canBITRATE_500K      (-2)

#define canBITRATE_250K      (-3)

#define canBITRATE_125K      (-4)

#define canBITRATE_100K      (-5)

#define canBITRATE_62K       (-6)

#define canBITRATE_50K       (-7)

#define canBITRATE_83K       (-8)

#define canBITRATE_10K       (-9)

// CAN FD Bit Rates
#define canFD_BITRATE_500K_80P     (-1000)

#define canFD_BITRATE_1M_80P       (-1001)

#define canFD_BITRATE_2M_80P       (-1002)

#define canFD_BITRATE_2M_60P       (-1007)

#define canFD_BITRATE_4M_80P       (-1003)

#define canFD_BITRATE_8M_60P       (-1004)

#define canFD_BITRATE_8M_80P       (-1005)

#define canFD_BITRATE_8M_70P       (-1006)

#define BAUD_1M              (-1)

#define BAUD_500K            (-2)

#define BAUD_250K            (-3)

#define BAUD_125K            (-4)

#define BAUD_100K            (-5)

#define BAUD_62K             (-6)

#define BAUD_50K             (-7)

#define BAUD_83K             (-8)

//
// Define CANLIBAPI unless it's done already.
// (canlib.c provides its own definitions of CANLIBAPI, DLLIMPORT
// and DLLEXPORT before including this file.)
//
#ifndef CANLIBAPI
#define CANLIBAPI
#endif /* CANLIBAPI */


#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

void CANLIBAPI canInitializeLibrary(void);

canStatus CANLIBAPI canEnumHardwareEx(int *channelCount);

canStatus CANLIBAPI canClose(const CanHandle hnd);

canStatus CANLIBAPI canBusOn(const CanHandle hnd);

canStatus CANLIBAPI canBusOff(const CanHandle hnd);

canStatus CANLIBAPI canSetBusParams(const CanHandle hnd,
                                    long freq,
                                    unsigned int tseg1,
                                    unsigned int tseg2,
                                    unsigned int sjw,
                                    unsigned int noSamp,
                                    unsigned int syncmode);

typedef struct kvBusParamsTq {
    int tq;        
    int phase1;    
    int phase2;    
    int sjw;       
    int prop;      
    int prescaler; 
} kvBusParamsTq;

 canStatus CANLIBAPI canSetBusParamsTq(const CanHandle hnd,
                                       const kvBusParamsTq nominal);

canStatus CANLIBAPI canSetBusParamsFd(const CanHandle hnd,
                                      long freq_brs,
                                      unsigned int tseg1_brs,
                                      unsigned int tseg2_brs,
                                      unsigned int sjw_brs);

canStatus CANLIBAPI canSetBusParamsFdTq(const CanHandle     hnd,
                                        const kvBusParamsTq arbitration,
                                        const kvBusParamsTq data);


canStatus CANLIBAPI canGetBusParams(const CanHandle hnd,
                                    long  *freq,
                                    unsigned int *tseg1,
                                    unsigned int *tseg2,
                                    unsigned int *sjw,
                                    unsigned int *noSamp,
                                    unsigned int *syncmode);

canStatus CANLIBAPI canGetBusParamsTq(const CanHandle hnd,
                                      kvBusParamsTq *nominal);

canStatus CANLIBAPI canGetBusParamsFd(const CanHandle hnd,
                                      long  *freq_brs,
                                      unsigned int *tseg1_brs,
                                      unsigned int *tseg2_brs,
                                      unsigned int *sjw_brs);

canStatus CANLIBAPI canGetBusParamsFdTq(const CanHandle hnd,
                                        kvBusParamsTq *nominal,
                                        kvBusParamsTq *data);

canStatus CANLIBAPI canSetBusOutputControl(const CanHandle hnd,
                                           const unsigned int drivertype);

canStatus CANLIBAPI canGetBusOutputControl(const CanHandle hnd,
                                           unsigned int *drivertype);

canStatus CANLIBAPI canAccept(const CanHandle hnd,
                              const long envelope,
                              const unsigned int flag);

canStatus CANLIBAPI canReadStatus(const CanHandle hnd,
                                  unsigned long *const flags);

canStatus CANLIBAPI canReadErrorCounters(const CanHandle hnd,
                                         unsigned int *txErr,
                                         unsigned int *rxErr,
                                         unsigned int *ovErr);

canStatus CANLIBAPI canWrite(const CanHandle hnd,
                             long id,
                             void *msg,
                             unsigned int dlc,
                             unsigned int flag);

canStatus CANLIBAPI canWriteSync(const CanHandle hnd, unsigned long timeout);

canStatus CANLIBAPI canRead(const CanHandle hnd,
                            long *id,
                            void *msg,
                            unsigned int *dlc,
                            unsigned int *flag,
                            unsigned long *time);
canStatus CANLIBAPI canReadWait(const CanHandle hnd,
                                long *id,
                                void *msg,
                                unsigned int  *dlc,
                                unsigned int  *flag,
                                unsigned long *time,
                                unsigned long timeout);

canStatus CANLIBAPI canReadSpecific(const CanHandle hnd, long id, void *msg,
                                    unsigned int *dlc, unsigned int *flag,
                                    unsigned long *time);

canStatus CANLIBAPI canReadSync(const CanHandle hnd, unsigned long timeout);

canStatus CANLIBAPI canReadSyncSpecific(const CanHandle hnd,
                                        long id,
                                        unsigned long timeout);

canStatus CANLIBAPI canReadSpecificSkip(const CanHandle hnd,
                                        long id,
                                        void *msg,
                                        unsigned int *dlc,
                                        unsigned int *flag,
                                        unsigned long *time);

canStatus CANLIBAPI canSetNotify(const CanHandle hnd,
                                 void (*callback)(canNotifyData *),
                                 unsigned int notifyFlags,
                                 void *tag);

canStatus CANLIBAPI canGetRawHandle(const CanHandle hnd, void *pvFd);

canStatus CANLIBAPI canTranslateBaud(long *const freq,
                                     unsigned int *const tseg1,
                                     unsigned int *const tseg2,
                                     unsigned int *const sjw,
                                     unsigned int *const nosamp,
                                     unsigned int *const syncMode);

canStatus CANLIBAPI kvBitrateToBusParamsTq(const canHandle hnd,
                                           int freq,
                                           kvBusParamsTq *nominal);

canStatus CANLIBAPI kvBitrateToBusParamsFdTq(const canHandle hnd,
                                             int freqA,
                                             int freqD,
                                             kvBusParamsTq *arbitration,
                                             kvBusParamsTq *data);

canStatus CANLIBAPI canGetErrorText(canStatus err, char *buf, unsigned int bufsiz);

unsigned short CANLIBAPI canGetVersion(void);

canStatus CANLIBAPI canIoCtl(const CanHandle hnd,
                             unsigned int func,
                             void *buf,
                             unsigned int buflen);


canStatus CANLIBAPI canReadTimer(const CanHandle hnd, unsigned long *time);

CanHandle CANLIBAPI canOpenChannel(int channel, int flags);

canStatus CANLIBAPI canGetNumberOfChannels(int *channelCount);


#define kvREMOTE_TYPE_NOT_REMOTE  0 
#define kvREMOTE_TYPE_WLAN        1 
#define kvREMOTE_TYPE_LAN         2 

#define kvLOGGER_TYPE_NOT_A_LOGGER  0 
#define kvLOGGER_TYPE_V1            1 
#define kvLOGGER_TYPE_V2            2 

canStatus CANLIBAPI canGetChannelData(int channel,
                                      int item,
                                      void *buffer,
                                      size_t bufsize);

#define canCHANNELDATA_CHANNEL_CAP                1

#define canCHANNELDATA_TRANS_CAP                  2

#define canCHANNELDATA_CHANNEL_FLAGS              3   // available, etc

#define canCHANNELDATA_CARD_TYPE                  4

#define canCHANNELDATA_CARD_NUMBER                5

#define canCHANNELDATA_CHAN_NO_ON_CARD            6

#define canCHANNELDATA_CARD_SERIAL_NO             7

#define canCHANNELDATA_TRANS_SERIAL_NO            8

#define canCHANNELDATA_CARD_FIRMWARE_REV          9

#define canCHANNELDATA_CARD_HARDWARE_REV          10

#define canCHANNELDATA_CARD_UPC_NO                11

#define canCHANNELDATA_TRANS_UPC_NO               12

#define canCHANNELDATA_CHANNEL_NAME               13

#define canCHANNELDATA_DLL_FILE_VERSION          14

#define canCHANNELDATA_DLL_PRODUCT_VERSION       15

#define canCHANNELDATA_DLL_FILETYPE              16

#define canCHANNELDATA_TRANS_TYPE                17

#define canCHANNELDATA_DEVICE_PHYSICAL_POSITION  18

#define canCHANNELDATA_UI_NUMBER                 19

#define canCHANNELDATA_TIMESYNC_ENABLED          20

#define canCHANNELDATA_DRIVER_FILE_VERSION       21

#define canCHANNELDATA_DRIVER_PRODUCT_VERSION    22

#define canCHANNELDATA_MFGNAME_UNICODE           23

#define canCHANNELDATA_MFGNAME_ASCII             24

#define canCHANNELDATA_DEVDESCR_UNICODE          25

#define canCHANNELDATA_DEVDESCR_ASCII            26

#define canCHANNELDATA_DRIVER_NAME               27

#define canCHANNELDATA_CHANNEL_QUALITY           28

#define canCHANNELDATA_ROUNDTRIP_TIME            29

#define canCHANNELDATA_BUS_TYPE                  30

#define canCHANNELDATA_DEVNAME_ASCII             31

#define canCHANNELDATA_TIME_SINCE_LAST_SEEN      32

#define canCHANNELDATA_REMOTE_OPERATIONAL_MODE   33

#define canCHANNELDATA_REMOTE_PROFILE_NAME   34

#define canCHANNELDATA_REMOTE_HOST_NAME   35

#define canCHANNELDATA_REMOTE_MAC   36

#define canCHANNELDATA_MAX_BITRATE   37

#define canCHANNELDATA_CHANNEL_CAP_MASK  38

#define canCHANNELDATA_CUST_CHANNEL_NAME  39

#define canCHANNELDATA_IS_REMOTE  40

#define canCHANNELDATA_REMOTE_TYPE  41

#define canCHANNELDATA_LOGGER_TYPE  42

#define canCHANNELDATA_HW_STATUS  43

#define canCHANNELDATA_FEATURE_EAN  44

#define canCHANNELDATA_BUS_PARAM_LIMITS  45

#define canCHANNELDATA_CLOCK_INFO  46

#define canCHANNELDATA_CHANNEL_CAP_EX                47

typedef struct kvClockInfo {
    int version;      
    int numerator;    
    int denominator;  
    int power_of_ten; 
    int accuracy_ppm; 
}kvClockInfo;

typedef struct kvBusParamLimits {
    int version;   
    kvBusParamsTq arbitration_min;
    kvBusParamsTq arbitration_max;
    kvBusParamsTq data_min;
    kvBusParamsTq data_max;
}kvBusParamLimits;

#define canCHANNEL_IS_EXCLUSIVE         0x0001

#define canCHANNEL_IS_OPEN              0x0002

#define canCHANNEL_IS_CANFD             0x0004

//#define canCHANNEL_IS_CANFD_NON_ISO          0x0008 Reserved for when needed

#define canCHANNEL_IS_LIN               0x0010

#define canCHANNEL_IS_LIN_MASTER        0x0020

#define canCHANNEL_IS_LIN_SLAVE         0x0040


#define canHWTYPE_NONE                0 
#define canHWTYPE_VIRTUAL             1 
#define canHWTYPE_LAPCAN              2 
#define canHWTYPE_CANPARI             3 
#define canHWTYPE_PCCAN               8 
#define canHWTYPE_PCICAN              9 
#define canHWTYPE_USBCAN             11 
#define canHWTYPE_PCICAN_II          40 
#define canHWTYPE_USBCAN_II          42 
#define canHWTYPE_SIMULATED          44 
#define canHWTYPE_ACQUISITOR         46 
#define canHWTYPE_LEAF               48 
#define canHWTYPE_PC104_PLUS         50 
#define canHWTYPE_PCICANX_II         52 
#define canHWTYPE_MEMORATOR_II       54 
#define canHWTYPE_MEMORATOR_PRO      54 
#define canHWTYPE_USBCAN_PRO         56 
#define canHWTYPE_IRIS               58 
#define canHWTYPE_BLACKBIRD          58 
#define canHWTYPE_MEMORATOR_LIGHT    60 
#define canHWTYPE_MINIHYDRA          62 
#define canHWTYPE_EAGLE              62 
#define canHWTYPE_BAGEL              64 
#define canHWTYPE_BLACKBIRD_V2       64 
#define canHWTYPE_MINIPCIE           66 
#define canHWTYPE_USBCAN_KLINE       68 
#define canHWTYPE_ETHERCAN           70 
#define canHWTYPE_USBCAN_LIGHT       72 
#define canHWTYPE_USBCAN_PRO2        74 
#define canHWTYPE_PCIE_V2            76 
#define canHWTYPE_MEMORATOR_PRO2     78 
#define canHWTYPE_LEAF2              80 
#define canHWTYPE_MEMORATOR_V2       82 
#define canHWTYPE_CANLINHYBRID       84 
#define canHWTYPE_DINRAIL            86 
#define canHWTYPE_U100               88 
#define canHWTYPE_LEAF3              90 


#define canCHANNEL_CAP_EXTENDED_CAN      0x00000001L 
#define canCHANNEL_CAP_BUS_STATISTICS    0x00000002L 
#define canCHANNEL_CAP_ERROR_COUNTERS    0x00000004L 
#define canCHANNEL_CAP_RESERVED_2        0x00000008L 
#define canCHANNEL_CAP_GENERATE_ERROR    0x00000010L 
#define canCHANNEL_CAP_GENERATE_OVERLOAD 0x00000020L 
#define canCHANNEL_CAP_TXREQUEST         0x00000040L 
#define canCHANNEL_CAP_TXACKNOWLEDGE     0x00000080L 
#define canCHANNEL_CAP_VIRTUAL           0x00010000L 
#define canCHANNEL_CAP_SIMULATED         0x00020000L 
#define canCHANNEL_CAP_RESERVED_1        0x00040000L 
#define canCHANNEL_CAP_CAN_FD            0x00080000L 
#define canCHANNEL_CAP_CAN_FD_NONISO     0x00100000L 
#define canCHANNEL_CAP_SILENT_MODE       0x00200000L 
#define canCHANNEL_CAP_SINGLE_SHOT       0x00400000L 
#define canCHANNEL_CAP_LOGGER            0x00800000L 
#define canCHANNEL_CAP_REMOTE_ACCESS     0x01000000L 
#define canCHANNEL_CAP_SCRIPT            0x02000000L 
#define canCHANNEL_CAP_LIN_HYBRID        0x04000000L 
#define canCHANNEL_CAP_IO_API            0x08000000L 
#define canCHANNEL_CAP_CANTEGRITY        0x10000000L 


#define canCHANNEL_CAP_EX_BUSPARAMS_TQ    0x0000000000000001L
#define canCHANNEL_CAP_EX_ERRORFRAME_DATA 0x0000000000000002L
#define canCHANNEL_CAP_EX_CAN             0x0000000000000004L
#define canCHANNEL_CAP_EX_LIN             0x0000000000000008L

#define canCHANNEL_OPMODE_NONE                 1

#define canCHANNEL_OPMODE_INFRASTRUCTURE       2

#define canCHANNEL_OPMODE_RESERVED             3

#define canCHANNEL_OPMODE_ADHOC                4

#define canDRIVER_CAP_HIGHSPEED             0x00000001L

#define canIOCTL_PREFER_EXT             1

#define canIOCTL_PREFER_STD             2

#define canIOCTL_CLEAR_ERROR_COUNTERS   5

#define canIOCTL_SET_TIMER_SCALE        6

#define canIOCTL_SET_TXACK              7

#define canIOCTL_GET_RX_BUFFER_LEVEL              8

#define canIOCTL_GET_TX_BUFFER_LEVEL              9

#define canIOCTL_FLUSH_RX_BUFFER                  10

#define canIOCTL_FLUSH_TX_BUFFER                  11

#define canIOCTL_GET_TIMER_SCALE                  12

#define canIOCTL_SET_TXRQ                         13


#define canIOCTL_SET_BYPASS_MODE                  15

#define canIOCTL_SET_WAKEUP                       16

#define canIOCTL_GET_DRIVERHANDLE                17

#define canIOCTL_MAP_RXQUEUE                     18

#define canIOCTL_GET_WAKEUP                      19

#define canIOCTL_SET_REPORT_ACCESS_ERRORS        20

#define canIOCTL_GET_REPORT_ACCESS_ERRORS        21

#define canIOCTL_CONNECT_TO_VIRTUAL_BUS          22

#define canIOCTL_DISCONNECT_FROM_VIRTUAL_BUS     23

#define canIOCTL_SET_USER_IOPORT                 24

#define canIOCTL_GET_USER_IOPORT                 25

#define canIOCTL_SET_BUFFER_WRAPAROUND_MODE      26

#define canIOCTL_SET_RX_QUEUE_SIZE               27

#define canIOCTL_SET_USB_THROTTLE                28

#define canIOCTL_GET_USB_THROTTLE                29

#define canIOCTL_SET_BUSON_TIME_AUTO_RESET       30

#define canIOCTL_GET_TXACK                       31

#define canIOCTL_SET_LOCAL_TXECHO                32

#define canIOCTL_SET_ERROR_FRAMES_REPORTING      33

#define canIOCTL_GET_CHANNEL_QUALITY             34

#define canIOCTL_GET_ROUNDTRIP_TIME              35

#define canIOCTL_GET_BUS_TYPE                    36

#define canIOCTL_GET_DEVNAME_ASCII               37

#define canIOCTL_GET_TIME_SINCE_LAST_SEEN        38

#define canIOCTL_GET_TREF_LIST                   39

#define canIOCTL_TX_INTERVAL                     40

#define canIOCTL_SET_BRLIMIT                            43

#define canIOCTL_SET_USB_THROTTLE_SCALED                41

#define canIOCTL_SET_THROTTLE_SCALED                    41

#define canIOCTL_GET_USB_THROTTLE_SCALED                42

#define canIOCTL_GET_THROTTLE_SCALED                    42

#define canIOCTL_RESET_OVERRUN_COUNT                          44

#define canIOCTL_LIN_MODE                               45


#define canIOCTL_SET_LOCAL_TXACK                     46

#define canIOCTL_SET_NATIVE_TICK_RESOLUTION             47

#define canIOCTL_GET_NATIVE_TICK_RESOLUTION             48

typedef struct {
    unsigned int portNo;     
    unsigned int portValue;  
} canUserIoPortData;


canStatus CANLIBAPI canSetBusParamsC200(const CanHandle hnd, unsigned char btr0, unsigned char btr1);



canStatus CANLIBAPI canSetDriverMode(const CanHandle hnd, int lineMode, int resNet);

canStatus CANLIBAPI canGetDriverMode(const CanHandle hnd, int *lineMode, int *resNet);

#define canVERSION_CANLIB32_VERSION     0

#define canVERSION_CANLIB32_PRODVER     1

#define canVERSION_CANLIB32_PRODVER32   2

#define canVERSION_CANLIB32_BETA        3


unsigned int CANLIBAPI canGetVersionEx(unsigned int itemCode);


canStatus CANLIBAPI canObjBufFreeAll(const CanHandle hnd);

canStatus CANLIBAPI canObjBufAllocate(const CanHandle hnd, int type);

#define canOBJBUF_TYPE_AUTO_RESPONSE            0x01 
#define canOBJBUF_TYPE_PERIODIC_TX              0x02 

canStatus CANLIBAPI canObjBufFree(const CanHandle hnd, int idx);

// Writes CAN data to the object buffer with the specified index.

canStatus CANLIBAPI canObjBufWrite(const CanHandle hnd,
                                   int idx,
                                   int id,
                                   void *msg,
                                   unsigned int dlc,
                                   unsigned int flags);

canStatus CANLIBAPI canObjBufSetFilter(const CanHandle hnd,
                                       int idx,
                                       unsigned int code,
                                       unsigned int mask);

canStatus CANLIBAPI canObjBufSetFlags(const CanHandle hnd,
                                      int idx,
                                      unsigned int flags);

#define canOBJBUF_AUTO_RESPONSE_RTR_ONLY        0x01

canStatus CANLIBAPI canObjBufSetPeriod(const CanHandle hnd,
                                       int idx,
                                       unsigned int period);

canStatus CANLIBAPI canObjBufSetMsgCount(const CanHandle hnd,
                                         int idx,
                                         unsigned int count);

canStatus CANLIBAPI canObjBufEnable(const CanHandle hnd, int idx);

canStatus CANLIBAPI canObjBufDisable(const CanHandle hnd, int idx);

canStatus CANLIBAPI canObjBufSendBurst(const CanHandle hnd,
                                       int idx,
                                       unsigned int burstlen);


canStatus CANLIBAPI canResetBus(const CanHandle hnd);

canStatus CANLIBAPI canWriteWait(const CanHandle hnd,
                                 long id,
                                 void *msg,
                                 unsigned int dlc,
                                 unsigned int flag,
                                 unsigned long timeout);


canStatus CANLIBAPI canUnloadLibrary(void);

canStatus CANLIBAPI canSetAcceptanceFilter(const CanHandle hnd,
                                           unsigned int code,
                                           unsigned int mask,
                                           int is_extended);
canStatus CANLIBAPI canFlushReceiveQueue(const CanHandle hnd);

canStatus CANLIBAPI canFlushTransmitQueue(const CanHandle hnd);


#define kvLED_ACTION_ALL_LEDS_ON   0 
#define kvLED_ACTION_ALL_LEDS_OFF  1 
#define kvLED_ACTION_LED_0_ON      2 
#define kvLED_ACTION_LED_0_OFF     3 
#define kvLED_ACTION_LED_1_ON      4 
#define kvLED_ACTION_LED_1_OFF     5 
#define kvLED_ACTION_LED_2_ON      6 
#define kvLED_ACTION_LED_2_OFF     7 
#define kvLED_ACTION_LED_3_ON      8 
#define kvLED_ACTION_LED_3_OFF     9 
#define kvLED_ACTION_LED_4_ON     10 
#define kvLED_ACTION_LED_4_OFF    11 
#define kvLED_ACTION_LED_5_ON     12 
#define kvLED_ACTION_LED_5_OFF    13 
#define kvLED_ACTION_LED_6_ON     14 
#define kvLED_ACTION_LED_6_OFF    15 
#define kvLED_ACTION_LED_7_ON     16 
#define kvLED_ACTION_LED_7_OFF    17 
#define kvLED_ACTION_LED_8_ON     18 
#define kvLED_ACTION_LED_8_OFF    19 
#define kvLED_ACTION_LED_9_ON     20 
#define kvLED_ACTION_LED_9_OFF    21 
#define kvLED_ACTION_LED_10_ON    22 
#define kvLED_ACTION_LED_10_OFF   23 
#define kvLED_ACTION_LED_11_ON    24 
#define kvLED_ACTION_LED_11_OFF   25 


canStatus CANLIBAPI kvFlashLeds (const CanHandle hnd, int action, int timeout);

canStatus CANLIBAPI canRequestChipStatus(const CanHandle hnd);

canStatus CANLIBAPI canRequestBusStatistics (const CanHandle hnd);

typedef struct canBusStatistics_s {
    unsigned long stdData;   
    unsigned long stdRemote; 
    unsigned long extData;   
    unsigned long extRemote; 
    unsigned long errFrame;  

    unsigned long busLoad;
    unsigned long overruns;  
} canBusStatistics;

canStatus CANLIBAPI canGetBusStatistics(const CanHandle hnd,
                                        canBusStatistics *stat,
                                        size_t bufsiz);


canStatus CANLIBAPI kvAnnounceIdentityEx(const CanHandle hnd,
                                         int type,
                                         void *buf,
                                         size_t bufsiz);

canStatus CANLIBAPI canGetHandleData(const CanHandle hnd,
                                     int item,
                                     void *buffer,
                                     size_t bufsize);

typedef void *kvTimeDomain;

typedef canStatus kvStatus;

typedef struct kvTimeDomainData_s {
    int nMagiSyncGroups;       
    int nMagiSyncedMembers;    
    int nNonMagiSyncCards;     
    int nNonMagiSyncedMembers; 
} kvTimeDomainData;

kvStatus CANLIBAPI kvTimeDomainCreate(kvTimeDomain *domain);

kvStatus CANLIBAPI kvTimeDomainDelete(kvTimeDomain domain);

kvStatus CANLIBAPI kvTimeDomainResetTime(kvTimeDomain domain);

kvStatus CANLIBAPI kvTimeDomainGetData(kvTimeDomain domain,
                                       kvTimeDomainData *data,
                                       size_t bufsiz);

kvStatus CANLIBAPI kvTimeDomainAddHandle(kvTimeDomain domain,
                                         const CanHandle hnd);

kvStatus CANLIBAPI kvTimeDomainRemoveHandle(kvTimeDomain domain,
                                            const CanHandle hnd);

typedef void(CANLIBAPI *kvCallback_t)(CanHandle hnd, void *context, unsigned int notifyEvent);
kvStatus CANLIBAPI kvSetNotifyCallback(const CanHandle hnd,
                                       kvCallback_t callback,
                                       void *context,
                                       unsigned int notifyFlags);

#define kvBUSTYPE_NONE          0

#define kvBUSTYPE_PCI           1

#define kvBUSTYPE_PCMCIA        2

#define kvBUSTYPE_USB           3

#define kvBUSTYPE_WLAN          4

#define kvBUSTYPE_PCI_EXPRESS   5

#define kvBUSTYPE_ISA           6

#define kvBUSTYPE_VIRTUAL       7

#define kvBUSTYPE_PC104_PLUS    8

#define kvBUSTYPE_LAN           9

#define kvBUSTYPE_GROUP_VIRTUAL  1

#define kvBUSTYPE_GROUP_LOCAL    2

#define kvBUSTYPE_GROUP_REMOTE   3

#define kvBUSTYPE_GROUP_INTERNAL 4

kvStatus CANLIBAPI kvGetSupportedInterfaceInfo(int index,
                                               char *hwName,
                                               size_t nameLen,
                                               int *hwType,
                                               int *hwBusType);

kvStatus CANLIBAPI kvReadDeviceCustomerData(const CanHandle hnd,
                                            int userNumber,
                                            int itemNumber,
                                            void *data,
                                            size_t bufsiz);

#define kvENVVAR_TYPE_INT       1

#define kvENVVAR_TYPE_FLOAT     2

#define kvENVVAR_TYPE_STRING    3

#define kvEVENT_TYPE_KEY        1

typedef int64_t kvEnvHandle;

kvStatus CANLIBAPI kvScriptStart(const CanHandle hnd, int slotNo);

#define kvSCRIPT_STOP_NORMAL         0 
#define kvSCRIPT_STOP_FORCED        -9 
kvStatus CANLIBAPI kvScriptStop(const CanHandle hnd, int slotNo, int mode);

kvStatus CANLIBAPI kvScriptUnload(const CanHandle hnd, int slotNo);

kvStatus CANLIBAPI kvScriptSendEvent(const CanHandle hnd,
                                     int slotNo,
                                     int eventType,
                                     int eventNo,
                                     unsigned int data);

kvEnvHandle CANLIBAPI kvScriptEnvvarOpen(const CanHandle hnd,
                                         const char *envvarName,
                                         int *envvarType,
                                         int *envvarSize); // returns scriptHandle

kvStatus CANLIBAPI kvScriptEnvvarClose(kvEnvHandle eHnd);

kvStatus CANLIBAPI kvScriptEnvvarSetInt(kvEnvHandle eHnd, int val);

kvStatus CANLIBAPI kvScriptEnvvarGetInt(kvEnvHandle eHnd, int *val);

kvStatus CANLIBAPI kvScriptEnvvarSetFloat(kvEnvHandle eHnd, float val);

kvStatus CANLIBAPI kvScriptEnvvarGetFloat(kvEnvHandle eHnd, float *val);

kvStatus CANLIBAPI kvScriptEnvvarSetData(kvEnvHandle eHnd,
                                         const void *buf,
                                         int start_index,
                                         int data_len);

kvStatus CANLIBAPI kvScriptEnvvarGetData(kvEnvHandle eHnd,
                                         void *buf,
                                         int start_index,
                                         int data_len);

kvStatus CANLIBAPI kvScriptLoadFileOnDevice(const CanHandle hnd,
                                            int slotNo,
                                            char *localFile);

kvStatus CANLIBAPI kvScriptLoadFile(const CanHandle hnd,
                                    int slotNo,
                                    char *filePathOnPC);


#define kvSCRIPT_REQUEST_TEXT_UNSUBSCRIBE  1

#define kvSCRIPT_REQUEST_TEXT_SUBSCRIBE    2

#define kvSCRIPT_REQUEST_TEXT_ALL_SLOTS    255

kvStatus CANLIBAPI kvScriptRequestText(const CanHandle hnd,
                                       unsigned int slot,
                                       unsigned int request);



kvStatus CANLIBAPI kvScriptGetText(const CanHandle hnd,
                                        int  *slot,
                                        unsigned long *time,
                                        unsigned int  *flags,
                                        char *buf,
                                        size_t bufsize);

#define kvSCRIPT_STATUS_LOADED      1 
#define kvSCRIPT_STATUS_RUNNING     2 
kvStatus CANLIBAPI kvScriptStatus(const CanHandle hnd,
                                  int  slot,
                                  unsigned int *status);


kvStatus CANLIBAPI kvScriptGetMaxEnvvarSize(int hnd, int *envvarSize);

kvStatus CANLIBAPI kvScriptTxeGetData(const char *filePathOnPC,
                                      int item,
                                      void *buffer,
                                      unsigned int *bufsize);

#define canTXEDATA_FILE_VERSION               1

#define canTXEDATA_COMPILER_VERSION      2

#define canTXEDATA_DATE                  3

#define canTXEDATA_DESCRIPTION           4

#define canTXEDATA_SOURCE               5

#define canTXEDATA_SIZE_OF_CODE          6

#define canTXEDATA_IS_ENCRYPTED           7


kvStatus CANLIBAPI kvFileCopyToDevice(const CanHandle hnd,
                                      char *hostFileName,
                                      char *deviceFileName);

kvStatus CANLIBAPI kvFileCopyFromDevice(const CanHandle hnd,
                                        char *deviceFileName,
                                        char *hostFileName);

kvStatus CANLIBAPI kvFileDelete(const CanHandle hnd, char *deviceFileName);

kvStatus CANLIBAPI kvFileGetName(const CanHandle hnd,
                                 int fileNo,
                                 char *name,
                                 int namelen);

kvStatus CANLIBAPI kvFileGetCount(const CanHandle hnd, int *count);

kvStatus CANLIBAPI kvFileGetSystemData(const CanHandle hnd,
                                       int itemCode,
                                       int *result);

kvStatus CANLIBAPI kvFileDiskFormat(const CanHandle hnd);

#define kvDEVICE_MODE_INTERFACE      0x00

#define kvDEVICE_MODE_LOGGER      0x01

kvStatus CANLIBAPI kvDeviceSetMode(const CanHandle hnd, int mode);

kvStatus CANLIBAPI kvDeviceGetMode(const CanHandle hnd, int *result);


kvStatus CANLIBAPI kvReadTimer(const CanHandle hnd, unsigned int *time);
kvStatus CANLIBAPI kvReadTimer64(const CanHandle hnd, uint64_t *time);

#define kvIO_INFO_GET_MODULE_TYPE                1

#define kvIO_INFO_GET_DIRECTION                     2

#define kvIO_INFO_GET_PIN_TYPE                      4

#define kvIO_INFO_GET_NUMBER_OF_BITS                5

#define kvIO_INFO_GET_RANGE_MIN                     6

#define kvIO_INFO_GET_RANGE_MAX                     7

#define kvIO_INFO_GET_DI_LOW_HIGH_FILTER            8

#define kvIO_INFO_GET_DI_HIGH_LOW_FILTER            9

#define kvIO_INFO_GET_AI_LP_FILTER_ORDER           10

#define kvIO_INFO_GET_AI_HYSTERESIS                11

#define kvIO_INFO_GET_MODULE_NUMBER                14

#define kvIO_INFO_GET_SERIAL_NUMBER                15

#define kvIO_INFO_GET_FW_VERSION                   16

#define kvIO_INFO_SET_DI_LOW_HIGH_FILTER            8

#define kvIO_INFO_SET_DI_HIGH_LOW_FILTER            9

#define kvIO_INFO_SET_AI_LP_FILTER_ORDER           10

#define kvIO_INFO_SET_AI_HYSTERESIS                11

#define kvIO_MODULE_TYPE_DIGITAL        1

#define kvIO_MODULE_TYPE_ANALOG         2

#define kvIO_MODULE_TYPE_RELAY          3

#define kvIO_MODULE_TYPE_INTERNAL       4

#define kvIO_PIN_TYPE_DIGITAL           1

#define kvIO_PIN_TYPE_ANALOG            2

#define kvIO_PIN_TYPE_RELAY             3

#define kvIO_PIN_DIRECTION_IN           4

#define kvIO_PIN_DIRECTION_OUT          8

canStatus CANLIBAPI kvIoGetNumberOfPins(const CanHandle hnd, unsigned int *pinCount);

canStatus CANLIBAPI kvIoConfirmConfig(const CanHandle hnd);

canStatus CANLIBAPI kvIoPinGetInfo(const CanHandle hnd, unsigned int pin, int item, void *buffer, const unsigned int bufsize);

canStatus CANLIBAPI kvIoPinSetInfo(const CanHandle hnd, unsigned int pin, int item, const void *buffer, const unsigned int bufsize);

canStatus CANLIBAPI kvIoPinSetDigital(const CanHandle hnd, unsigned int pin, unsigned int value);

canStatus CANLIBAPI kvIoPinGetDigital(const CanHandle hnd, unsigned int pin, unsigned int *value);

canStatus CANLIBAPI kvIoPinGetOutputDigital(const CanHandle hnd, unsigned int pin, unsigned int *value);

canStatus CANLIBAPI kvIoPinSetRelay(const CanHandle hnd, unsigned int pin, unsigned int value);

canStatus CANLIBAPI kvIoPinGetOutputRelay(const CanHandle hnd, unsigned int pin, unsigned int *value);

canStatus CANLIBAPI kvIoPinSetAnalog(const CanHandle hnd, unsigned int pin, float value);

canStatus CANLIBAPI kvIoPinGetAnalog(const CanHandle hnd, unsigned int pin, float *value);

canStatus CANLIBAPI kvIoPinGetOutputAnalog(const CanHandle hnd, unsigned int pin, float *value);

typedef struct {
    int type; 
    unsigned char DO1 : 1; 
    unsigned char DO2 : 1; 
    unsigned char DO3 : 1; 
    unsigned char DO4 : 1; 
    unsigned char DO5 : 1; 
    unsigned char DO6 : 1; 
    unsigned char DO7 : 1; 
    unsigned char DO8 : 1; 
    unsigned char DO9 : 1; 
    unsigned char DO10: 1; 
    unsigned char DO11: 1; 
    unsigned char DO12: 1; 
    unsigned char DO13: 1; 
    unsigned char DO14: 1; 
    unsigned char DO15: 1; 
    unsigned char DO16: 1; 
    unsigned char DI1 : 1; 
    unsigned char DI2 : 1; 
    unsigned char DI3 : 1; 
    unsigned char DI4 : 1; 
    unsigned char DI5 : 1; 
    unsigned char DI6 : 1; 
    unsigned char DI7 : 1; 
    unsigned char DI8 : 1; 
    unsigned char DI9 : 1; 
    unsigned char DI10: 1; 
    unsigned char DI11: 1; 
    unsigned char DI12: 1; 
    unsigned char DI13: 1; 
    unsigned char DI14: 1; 
    unsigned char DI15: 1; 
    unsigned char DI16: 1; 
} kvIoModuleDigital;


typedef struct {
    int type; 
    unsigned char DO: 1; 
    unsigned char DI: 1; 
} kvIoModuleInternal;


typedef struct {
    int type; 
    unsigned char RO1 : 1; 
    unsigned char RO2 : 1; 
    unsigned char RO3 : 1; 
    unsigned char RO4 : 1; 
    unsigned char RO5 : 1; 
    unsigned char RO6 : 1; 
    unsigned char RO7 : 1; 
    unsigned char RO8 : 1; 
    unsigned char DI1 : 1; 
    unsigned char DI2 : 1; 
    unsigned char DI3 : 1; 
    unsigned char DI4 : 1; 
    unsigned char DI5 : 1; 
    unsigned char DI6 : 1; 
    unsigned char DI7 : 1; 
    unsigned char DI8 : 1; 
} kvIoModuleRelay;

typedef struct {
    int type; 
    float AO1; 
    float AO2; 
    float AO3; 
    float AO4; 
    float AI1; 
    float AI2; 
    float AI3; 
    float AI4; 
} kvIoModuleAnalog;


canStatus CANLIBAPI kvIoGetModulePins(const CanHandle hnd, unsigned int module, void *buffer, const unsigned int bufsize);


canStatus CANLIBAPI kvIoSetModulePins(const CanHandle hnd, unsigned int module, const void *buffer, const unsigned int bufsize);


#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /*  _CANLIB_H_ */