obsolete.h

Go to the documentation of this file.

/*
 *                   Copyright 1998-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 _OBSOLETE_H_
#define _OBSOLETE_H_


#define canCIRCUIT_ANY          -1   
#define canCARD_ANY             -1   
#define canCHANNEL_ANY          -1   

#define CANID_METAMSG  (-1L)        
#define CANID_WILDCARD (-2L)        


typedef void* (*canMemoryAllocator)  (size_t size);

typedef void  (*canMemoryDeallocator)(void* p);

typedef struct tagCanHWDescr {
    int                    circuitType;
    int                    cardType;
    int                    channel;
} canHWDescr;

typedef struct tagCanSWDescr {
    unsigned int           rxBufSize;
    unsigned int           txBufSize;
    canMemoryAllocator     alloc;
    canMemoryDeallocator   deAlloc;
} canSWDescr;

typedef struct {
    unsigned int size;
    unsigned int rxBufSize;
    unsigned int txBufSize;
} canSWDescriptorEx;

canStatus CANLIBAPI canLocateHardware(void);

int CANLIBAPI canOpen(const canHWDescr * const hwdescr,
                      const canSWDescr * const swdescr,
                      const unsigned int flags);

canStatus CANLIBAPI canGetCircuits(int * context,
                                   char * name,
                                   char * vendor,
                                   char * version,
                                   unsigned int * cardtype,
                                   unsigned int * circtype,
                                   unsigned int * channel);

#define canERR_BUFOFL           canERR_RESERVED_3   
#define canERR_REINIT           canERR_RESERVED_4   
#define canERR_MSGLOST          canERR_RESERVED_5   
#define canERR_OVERRUN          canERR_RESERVED_6   
#define canERR_CARDCOMMFAILED   canERR_RESERVED_7   

#define canCIRCSTAT_ERROR_PASSIVE 0x0001    
#define canCIRCSTAT_BUS_OFF       0x0002    
#define canCIRCSTAT_ERROR_WARNING 0x0004    

#define canCHANNEL_CAP_DIAGNOSTICS      0x10000000L               
#define canCHANNEL_CAP_CAN_DIAGNOSTICS  canCHANNEL_CAP_RESERVED_2 
#define canCHANNEL_CAP_REMOTE           canCHANNEL_CAP_RESERVED_1 

#define canSTICKY_ACK_ERROR       0x80000801 
#define canSTICKY_FORM_ERROR      0x80000002 
#define canSTICKY_STUFF_ERROR     0x80000004 
#define canSTICKY_CRC_ERROR       0x80000008 
#define canSTICKY_BIT0_ERROR      0x80000010 
#define canSTICKY_BIT1_ERROR      0x80000020 
#define canSTICKY_HW_OVERRUN      0x80000040 
#define canSTICKY_SW_OVERRUN      0x80000080 

#define canSTAT_INACTIVE          canSTAT_RESERVED_1    

/*
#define canCIRCSTAT_TXERR       0x0001      // TX error has occurred
#define canCIRCSTAT_RXERR       0x0002      // Receive error has occurred
#define canCIRCSTAT_OVERRUN     0x0004      // Receiver overrun
#define canCIRCSTAT_WAKEUP      0x0008      // Wakeup has occurred
#define canCIRCSTAT_INT         0x0010      // ??
#define canCIRCSTAT_ACK         0x0020      // ACK error
#define canCIRCSTAT_BIT         0x0040      // Bit error
*/
/*
More apocryphs.
#define canCIRCSTAT_OVERRUN     0x0004      // Receiver overrun
#define canCIRCSTAT_WAKEUP      0x0008      // Wakeup has occurred
#define canCIRCSTAT_ACK         0x0010      // ACK error
#define canCIRCSTAT_BIT0        0x0020      // Bit error
#define canCIRCSTAT_BIT1        0x0040      // Bit error
#define canCIRCSTAT_BOFF        0x0080      // Chip went Bus Off
*/
/*
Even more.
#define canCIRCSTAT_BOFF_HW     0x10000L      // Chip is Bus Off
#define canCIRCSTAT_BOFF_SW     0x20000L      // We are Bus Off
*/


#define canWANT_ACTIONS         0x01  
#define canWANT_OWN_BUFFERS     0x02  
#define canWANT_ERROR_COUNTERS  0x04  
#define canWANT_EXCLUSIVE       0x08  
#define canWANT_EXTENDED        0x10  
#define canWANT_VIRTUAL         0x20  


// No circuit                   0
#define PCCAN_PHILIPS           1     
#define PCCAN_INTEL526          2     
#define PCCAN_INTEL527          3     
#define CANCARD_NEC72005        4     
#define CIRC_VIRTUAL            5     
#define CIRC_SJA1000            6     

#define canCARD_PCCAN           1     
#define canCARD_CANCARD         2     
#define canCARD_AC2             3     
#define canCARD_LAPCAN          4     
#define canCARD_ISACAN          5     
#define canCARD_PCCAN_OEM       6     

#define canFlgACCEPT            1     
#define canFlgREJECT            2     
#define canFlgCODE              3     
#define canFlgMASK              4     

#define canDISCARD_MESSAGE      3     
#define canRETAIN_MESSAGE       4     

#define canSLOW_MODE            0x01  

#define canOFF                  0     
#define canTRISTATE             1     
#define canPULLUP               2     
#define canPULLDOWN             3     
#define canPUSHPULL             4     
#define canINVPULLUP            5     
#define canINVPULLDOWN          6     
#define canINVPUSHPULL          7     

#define canIOCTL_LOCAL_ECHO_ON  3     
#define canIOCTL_LOCAL_ECHO_OFF 4     

#define canMSG_STATUS 0x0008

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

canStatus CANLIBAPI canInstallAction(int handle, long id, int (*fn)());

canStatus CANLIBAPI canUninstallAction(int handle, long id);

canStatus CANLIBAPI canInstallOwnBuffer(int handle, long id, unsigned int len,
                                        void * buf);

canStatus CANLIBAPI canUninstallOwnBuffer(int handle, long id);
#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* _OBSOLETE_H_ */