canstat.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 _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 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 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 CAN_ERR_FLAG 0x20000000U /* error message frame,  */
#define ERRORFRAME_TYPE_INDEX 2;
#define ERRORFRAME_LOCATION_INDEX 3;

#define CAN_ERR_DLC 8 /* dlc for error message frames */

/* error class (mask) in can_id */
#define CAN_ERR_TX_TIMEOUT   0x00000001U /* TX timeout (by netdevice driver) */
#define CAN_ERR_LOSTARB      0x00000002U /* lost arbitration    / data[0]    */
#define CAN_ERR_CRTL         0x00000004U /* controller problems / data[1]    */
#define CAN_ERR_PROT         0x00000008U /* protocol violations / data[2..3] */
#define CAN_ERR_TRX          0x00000010U /* transceiver status  / data[4]    */
#define CAN_ERR_ACK          0x00000020U /* received no ACK on transmission */
#define CAN_ERR_BUSOFF       0x00000040U /* bus off */
#define CAN_ERR_BUSERROR     0x00000080U /* bus error (may flood!) */
#define CAN_ERR_RESTARTED    0x00000100U /* controller restarted */
#define CAN_ERR_CNT          0x00000200U /* TX error counter / data[6] */
                                         /* RX error counter / data[7] */

/* arbitration lost in bit ... / data[0] */
#define CAN_ERR_LOSTARB_UNSPEC   0x00 /* unspecified */
                                      /* else bit number in bitstream */

/* error status of CAN-controller / data[1] */
#define CAN_ERR_CRTL_UNSPEC      0x00 /* unspecified */
#define CAN_ERR_CRTL_RX_OVERFLOW 0x01 /* RX buffer overflow */
#define CAN_ERR_CRTL_TX_OVERFLOW 0x02 /* TX buffer overflow */
#define CAN_ERR_CRTL_RX_WARNING  0x04 /* reached warning level for RX errors */
#define CAN_ERR_CRTL_TX_WARNING  0x08 /* reached warning level for TX errors */
#define CAN_ERR_CRTL_RX_PASSIVE  0x10 /* reached error passive status RX */
#define CAN_ERR_CRTL_TX_PASSIVE  0x20 /* reached error passive status TX */
                                      /* (at least one error counter exceeds */
                                      /* the protocol-defined level of 127)  */
#define CAN_ERR_CRTL_ACTIVE      0x40 /* recovered to error active state */

/* error in CAN protocol (type) / data[2] */
#define CAN_ERR_PROT_UNSPEC      0x00 /* unspecified */
#define CAN_ERR_PROT_BIT         0x01 /* single bit error */
#define CAN_ERR_PROT_FORM        0x02 /* frame format error */
#define CAN_ERR_PROT_STUFF       0x04 /* bit stuffing error */
#define CAN_ERR_PROT_BIT0        0x08 /* unable to send dominant bit */
#define CAN_ERR_PROT_BIT1        0x10 /* unable to send recessive bit */
#define CAN_ERR_PROT_OVERLOAD    0x20 /* bus overload */
#define CAN_ERR_PROT_ACTIVE      0x40 /* active error announcement */
#define CAN_ERR_PROT_TX          0x80 /* error occurred on transmission */

/* error in CAN protocol (location) / data[3] */
#define CAN_ERR_PROT_LOC_UNSPEC  0x00 /* unspecified */
#define CAN_ERR_PROT_LOC_SOF     0x03 /* start of frame */
#define CAN_ERR_PROT_LOC_ID28_21 0x02 /* ID bits 28 - 21 (SFF: 10 - 3) */
#define CAN_ERR_PROT_LOC_ID20_18 0x06 /* ID bits 20 - 18 (SFF: 2 - 0 )*/
#define CAN_ERR_PROT_LOC_SRTR    0x04 /* substitute RTR (SFF: RTR) */
#define CAN_ERR_PROT_LOC_IDE     0x05 /* identifier extension */
#define CAN_ERR_PROT_LOC_ID17_13 0x07 /* ID bits 17-13 */
#define CAN_ERR_PROT_LOC_ID12_05 0x0F /* ID bits 12-5 */
#define CAN_ERR_PROT_LOC_ID04_00 0x0E /* ID bits 4-0 */
#define CAN_ERR_PROT_LOC_RTR     0x0C /* RTR */
#define CAN_ERR_PROT_LOC_RES1    0x0D /* reserved bit 1 */
#define CAN_ERR_PROT_LOC_RES0    0x09 /* reserved bit 0 */
#define CAN_ERR_PROT_LOC_DLC     0x0B /* data length code */
#define CAN_ERR_PROT_LOC_DATA    0x0A /* data section */
#define CAN_ERR_PROT_LOC_CRC_SEQ 0x08 /* CRC sequence */
#define CAN_ERR_PROT_LOC_CRC_DEL 0x18 /* CRC delimiter */
#define CAN_ERR_PROT_LOC_ACK     0x19 /* ACK slot */
#define CAN_ERR_PROT_LOC_ACK_DEL 0x1B /* ACK delimiter */
#define CAN_ERR_PROT_LOC_EOF     0x1A /* end of frame */
#define CAN_ERR_PROT_LOC_INTERM  0x12 /* intermission */

/* error status of CAN-transceiver / data[4] */
/*                                             CANH CANL */
#define CAN_ERR_TRX_UNSPEC             0x00 /* 0000 0000 */
#define CAN_ERR_TRX_CANH_NO_WIRE       0x04 /* 0000 0100 */
#define CAN_ERR_TRX_CANH_SHORT_TO_BAT  0x05 /* 0000 0101 */
#define CAN_ERR_TRX_CANH_SHORT_TO_VCC  0x06 /* 0000 0110 */
#define CAN_ERR_TRX_CANH_SHORT_TO_GND  0x07 /* 0000 0111 */
#define CAN_ERR_TRX_CANL_NO_WIRE       0x40 /* 0100 0000 */
#define CAN_ERR_TRX_CANL_SHORT_TO_BAT  0x50 /* 0101 0000 */
#define CAN_ERR_TRX_CANL_SHORT_TO_VCC  0x60 /* 0110 0000 */
#define CAN_ERR_TRX_CANL_SHORT_TO_GND  0x70 /* 0111 0000 */
#define CAN_ERR_TRX_CANL_SHORT_TO_CANH 0x80 /* 1000 0000 */

/* data[5] is reserved (do not use) */

/* TX error counter / data[6] */
/* RX error counter / data[7] */

#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