canstat.h

Go to the documentation of this file.

/*
 *                   Copyright 1994-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.
 *
 * \note MATLAB users on Windows: if you define WIN32_LEAN_AND_MEAN before
 * including this file, you will see a lot less warnings.
 *
 */

#ifndef _CANSTAT_H_
#define _CANSTAT_H_

//
// Don't forget to update canGetErrorText in canlib.c if this is changed!
//
typedef enum {
    canOK                  = 0,
    canERR_PARAM           = -1,
    canERR_NOMSG           = -2,
    canERR_NOTFOUND        = -3,
    canERR_NOMEM           = -4,
    canERR_NOCHANNELS      = -5,

    canERR_INTERRUPTED     = -6, 

    canERR_TIMEOUT         = -7,
    canERR_NOTINITIALIZED  = -8,
    canERR_NOHANDLES       = -9,
    canERR_INVHANDLE       = -10,
    canERR_INIFILE         = -11, 

    canERR_DRIVER          = -12,
    canERR_TXBUFOFL        = -13,
    canERR_RESERVED_1      = -14, 

    canERR_HARDWARE        = -15,
    canERR_DYNALOAD        = -16,
    canERR_DYNALIB         = -17,
    canERR_DYNAINIT        = -18,
    canERR_NOT_SUPPORTED   = -19, 
    canERR_RESERVED_5      = -20, 
    canERR_RESERVED_6      = -21, 
    canERR_RESERVED_2      = -22, 

    canERR_DRIVERLOAD      = -23,
    canERR_DRIVERFAILED    = -24,
    canERR_NOCONFIGMGR     = -25, 
    canERR_NOCARD          = -26, 
    canERR_RESERVED_7      = -27, 

    canERR_REGISTRY        = -28,
    canERR_LICENSE         = -29, 

    canERR_INTERNAL        = -30,
    canERR_NO_ACCESS       = -31,
    canERR_NOT_IMPLEMENTED = -32,
    canERR_DEVICE_FILE     = -33,
    canERR_HOST_FILE       = -34,
    canERR_DISK            = -35,
    canERR_CRC             = -36,
    canERR_CONFIG          = -37,
    canERR_MEMO_FAIL       = -38,
    canERR_SCRIPT_FAIL     = -39,

    canERR_SCRIPT_WRONG_VERSION = -40,

    canERR_SCRIPT_TXE_CONTAINER_VERSION = -41,

    canERR_SCRIPT_TXE_CONTAINER_FORMAT = -42,

    canERR_BUFFER_TOO_SMALL = -43,

    canERR_IO_WRONG_PIN_TYPE = -44,

    canERR_IO_NOT_CONFIRMED = -45,

    canERR_IO_CONFIG_CHANGED = -46,

    canERR_IO_PENDING = -47,

    canERR_IO_NO_VALID_CONFIG = -48,

    // The last entry - a dummy so we know where NOT to place a comma.
    canERR__RESERVED       = -49    
} canStatus;
#define CANSTATUS_SUCCESS(X) ((X) == canOK)
#define CANSTATUS_FAILURE(X) ((X) != canOK)

#define canEVENT_RX             32000 
#define canEVENT_TX             32001 
#define canEVENT_ERROR          32002 
#define canEVENT_STATUS         32003 

#define canEVENT_ENVVAR         32004
#define canEVENT_BUSONOFF       32005 
#define canEVENT_REMOVED        32006 

#define canNOTIFY_NONE          0      
#define canNOTIFY_RX            0x0001 
#define canNOTIFY_TX            0x0002 
#define canNOTIFY_ERROR         0x0004 
#define canNOTIFY_STATUS        0x0008 
#define canNOTIFY_ENVVAR        0x0010 

#define canNOTIFY_BUSONOFF      0x0020 
#define canNOTIFY_REMOVED       0x0040 

#define canSTAT_ERROR_PASSIVE   0x00000001 
#define canSTAT_BUS_OFF         0x00000002 
#define canSTAT_ERROR_WARNING   0x00000004 
#define canSTAT_ERROR_ACTIVE    0x00000008 
#define canSTAT_TX_PENDING      0x00000010 
#define canSTAT_RX_PENDING      0x00000020 
#define canSTAT_RESERVED_1      0x00000040
#define canSTAT_TXERR           0x00000080 
#define canSTAT_RXERR           0x00000100 
#define canSTAT_HW_OVERRUN      0x00000200 
#define canSTAT_SW_OVERRUN      0x00000400 
#define canSTAT_OVERRUN         (canSTAT_HW_OVERRUN | canSTAT_SW_OVERRUN) 

#define canMSG_MASK             0x00ff 
#define canMSG_RTR              0x0001 


#define canMSG_STD      0x0002 
#define canMSG_EXT      0x0004 
#define canMSG_WAKEUP   0x0008 


#define canMSG_NERR             0x0010 
#define canMSG_ERROR_FRAME      0x0020 
#define canMSG_TXACK            0x0040 
#define canMSG_TXRQ             0x0080 
#define canMSG_DELAY_MSG        0x0100 

#define canMSG_LOCAL_TXACK  0x10000000 

// single shot flags:
#define canMSG_SINGLE_SHOT      0x1000000 
#define canMSG_TXNACK           0x2000000 
#define canMSG_ABL              0x4000000 


#define canFDMSG_MASK            0xff0000
#define canFDMSG_EDL             0x010000 
#define canFDMSG_FDF             0x010000 
#define canFDMSG_BRS             0x020000 
#define canFDMSG_ESI             0x040000 

#define canMSGERR_MASK          0xff00 
// 0x0100 reserved
#define canMSGERR_HW_OVERRUN    0x0200 
#define canMSGERR_SW_OVERRUN    0x0400 
#define canMSGERR_STUFF         0x0800 
#define canMSGERR_FORM          0x1000 
#define canMSGERR_CRC           0x2000 
#define canMSGERR_BIT0          0x4000 
#define canMSGERR_BIT1          0x8000 

// Convenience values for the message error flags.
#define canMSGERR_OVERRUN       0x0600 
#define canMSGERR_BIT           0xC000 
#define canMSGERR_BUSERR        0xF800 


#define canMSG_RESERVED_FOR_EXTENDING  0x80000000 


#define canTRANSCEIVER_LINEMODE_NA         0 
#define canTRANSCEIVER_LINEMODE_SWC_SLEEP  4 
#define canTRANSCEIVER_LINEMODE_SWC_NORMAL 5 
#define canTRANSCEIVER_LINEMODE_SWC_FAST   6 
#define canTRANSCEIVER_LINEMODE_SWC_WAKEUP 7 
#define canTRANSCEIVER_LINEMODE_SLEEP      8 
#define canTRANSCEIVER_LINEMODE_NORMAL     9 
#define canTRANSCEIVER_LINEMODE_STDBY      10 
#define canTRANSCEIVER_LINEMODE_TT_CAN_H   11 
#define canTRANSCEIVER_LINEMODE_TT_CAN_L   12 
#define canTRANSCEIVER_LINEMODE_OEM1       13 
#define canTRANSCEIVER_LINEMODE_OEM2       14 
#define canTRANSCEIVER_LINEMODE_OEM3       15 
#define canTRANSCEIVER_LINEMODE_OEM4       16 


#define canTRANSCEIVER_RESNET_NA          0
#define canTRANSCEIVER_RESNET_MASTER      1
#define canTRANSCEIVER_RESNET_MASTER_STBY 2
#define canTRANSCEIVER_RESNET_SLAVE       3

// Also see src\include\hwnames.h and registered document 048.
#define canTRANSCEIVER_TYPE_UNKNOWN    0 
#define canTRANSCEIVER_TYPE_251        1 
#define canTRANSCEIVER_TYPE_252        2 
#define canTRANSCEIVER_TYPE_DNOPTO     3 
#define canTRANSCEIVER_TYPE_W210       4 
#define canTRANSCEIVER_TYPE_SWC_PROTO  5 
#define canTRANSCEIVER_TYPE_SWC        6 
#define canTRANSCEIVER_TYPE_EVA        7 
#define canTRANSCEIVER_TYPE_FIBER      8 
#define canTRANSCEIVER_TYPE_K251       9 
#define canTRANSCEIVER_TYPE_K          10 
#define canTRANSCEIVER_TYPE_1054_OPTO  11 
#define canTRANSCEIVER_TYPE_SWC_OPTO   12 
#define canTRANSCEIVER_TYPE_TT         13 
#define canTRANSCEIVER_TYPE_1050       14 
#define canTRANSCEIVER_TYPE_1050_OPTO  15 
#define canTRANSCEIVER_TYPE_1041       16 
#define canTRANSCEIVER_TYPE_1041_OPTO  17 
#define canTRANSCEIVER_TYPE_RS485      18 
#define canTRANSCEIVER_TYPE_LIN        19 
#define canTRANSCEIVER_TYPE_KONE       20 
#define canTRANSCEIVER_TYPE_CANFD      22 
#define canTRANSCEIVER_TYPE_CANFD_LIN  24 
#define canTRANSCEIVER_TYPE_CANFD_SIC  26 
#define canTRANSCEIVER_TYPE_LINX_LIN   64
#define canTRANSCEIVER_TYPE_LINX_J1708 66
#define canTRANSCEIVER_TYPE_LINX_K     68
#define canTRANSCEIVER_TYPE_LINX_SWC   70
#define canTRANSCEIVER_TYPE_LINX_LS    72

#endif