Obsolete API Reference

Definitions which are retained for compatibility. More...

Data Structures

struct  tagCanHWDescr
 
struct  tagCanSWDescr
 
struct  canSWDescriptorEx
 

Macros

#define canCIRCUIT_ANY   -1
 Any circuit will do. More...
 
#define canCARD_ANY   -1
 Any card will do. More...
 
#define canCHANNEL_ANY   -1
 Any channel will do. More...
 
#define CANID_METAMSG   (-1L)
 Like msgs containing bus status changes. More...
 
#define CANID_WILDCARD   (-2L)
 We don't care or don't know. More...
 
#define canSTAT_INACTIVE   canSTAT_RESERVED_1
 The circuit is not active (removed from the sw bus) More...
 

Typedefs

typedef void *(* canMemoryAllocator) (size_t size)
 
typedef void(* canMemoryDeallocator) (void *p)
 
typedef struct tagCanHWDescr canHWDescr
 
typedef struct tagCanSWDescr canSWDescr
 

Functions

unsigned long canReadTimer (const int hnd)
 
canStatus canLocateHardware (void)
 
int canOpen (const canHWDescr *const hwdescr, const canSWDescr *const swdescr, const unsigned int flags)
 
canStatus canGetCircuits (int *context, char *name, char *vendor, char *version, unsigned int *cardtype, unsigned int *circtype, unsigned int *channel)
 
canStatus canInstallAction (int handle, long id, int(*fn)())
 
canStatus canUninstallAction (int handle, long id)
 
canStatus canInstallOwnBuffer (int handle, long id, unsigned int len, void *buf)
 
canStatus canUninstallOwnBuffer (int handle, long id)
 

Some obsolete codes; they are not used nowadays.

Warning
Obsolete!
#define canERR_BUFOFL   canERR_RESERVED_3
 "Buffer overflow" More...
 
#define canERR_REINIT   canERR_RESERVED_4
 "Reinitialization failed" More...
 
#define canERR_MSGLOST   canERR_RESERVED_5
 "Message lost by CAN-chip" More...
 
#define canERR_OVERRUN   canERR_RESERVED_6
 "Receive buffer overrun" More...
 
#define canERR_CARDCOMMFAILED   canERR_RESERVED_7
 "Can't communicate with the card" More...
 

Circuit status flags, retained for compatibility

Warning
Obsolete!
#define canCIRCSTAT_ERROR_PASSIVE   0x0001
 Error passive. More...
 
#define canCIRCSTAT_BUS_OFF   0x0002
 Bus off. More...
 
#define canCIRCSTAT_ERROR_WARNING   0x0004
 Error counter > 96. More...
 

retained for compatibility

Warning
Obsolete!
#define canCHANNEL_CAP_CAN_DIAGNOSTICS   canCHANNEL_CAP_RESERVED_2
 Obsolete, can report CAN diagnostics. Only used by LAPcan driver. More...
 
#define canCHANNEL_CAP_REMOTE   canCHANNEL_CAP_RESERVED_1
 Obsolete, use canCHANNEL_CAP_REMOTE_ACCESS or canCHANNELDATA_IS_REMOTE. More...
 

Sticky status flags

Warning
Obsolete!
#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
 

Flags for canOpen

Warning
Obsolete! Use canOPEN_xxx instead.
#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
 

Circuit types.

Warning
Obsolete!
#define PCCAN_PHILIPS   1
 82C200 on PCCAN 1.0 More...
 
#define PCCAN_INTEL526   2
 Not supported. More...
 
#define PCCAN_INTEL527   3
 82527 on PCCAN 1.0 More...
 
#define CANCARD_NEC72005   4
 NEC72005 on CANCard. More...
 
#define CIRC_VIRTUAL   5
 
#define CIRC_SJA1000   6
 

Card types.

Warning
Obsolete!
#define canCARD_PCCAN   1
 PCCAN ver 1.x (KVASER) More...
 
#define canCARD_CANCARD   2
 CANCard (Softing) More...
 
#define canCARD_AC2   3
 CAN-AC2 (Softing) More...
 
#define canCARD_LAPCAN   4
 
#define canCARD_ISACAN   5
 
#define canCARD_PCCAN_OEM   6
 Special for OEM PCcan cards. More...
 

The canFlgXXX are left for compatibility.

Warning
Obsolete!
#define canFlgACCEPT   1
 
#define canFlgREJECT   2
 
#define canFlgCODE   3
 
#define canFlgMASK   4
 

Flags for action routines

Warning
Obsolete!
#define canDISCARD_MESSAGE   3
 
#define canRETAIN_MESSAGE   4
 

For busParams - sync on rising edge only or both rising and falling edge

(Not supported)

Warning
Obsolete!
#define canSLOW_MODE   0x01
 Sync on rising and falling edge. More...
 

CAN driver types; these constants are retained for compatibility.

(Not supported)

Warning
Obsolete!
#define canOFF   0
 
#define canTRISTATE   1
 
#define canPULLUP   2
 
#define canPULLDOWN   3
 
#define canPUSHPULL   4
 This is the usual setting. More...
 
#define canINVPULLUP   5
 
#define canINVPULLDOWN   6
 
#define canINVPUSHPULL   7
 

These were never implemented.

(Not supported)

Warning
Obsolete!
#define canIOCTL_LOCAL_ECHO_ON   3
 
#define canIOCTL_LOCAL_ECHO_OFF   4
 
#define canMSG_STATUS   0x0008
 

Detailed Description

Definitions which are retained for compatibility.

Macro Definition Documentation

◆ canCARD_AC2

#define canCARD_AC2   3

CAN-AC2 (Softing)

Warning
Obsolete!

◆ canCARD_ANY

#define canCARD_ANY   -1

Any card will do.

Warning
Obsolete!

◆ canCARD_CANCARD

#define canCARD_CANCARD   2

CANCard (Softing)

Warning
Obsolete!

◆ canCARD_ISACAN

#define canCARD_ISACAN   5
Warning
Obsolete!

◆ canCARD_LAPCAN

#define canCARD_LAPCAN   4
Warning
Obsolete!

◆ CANCARD_NEC72005

#define CANCARD_NEC72005   4

NEC72005 on CANCard.

Warning
Obsolete!

◆ canCARD_PCCAN

#define canCARD_PCCAN   1

PCCAN ver 1.x (KVASER)

Warning
Obsolete!

◆ canCARD_PCCAN_OEM

#define canCARD_PCCAN_OEM   6

Special for OEM PCcan cards.

Warning
Obsolete!

◆ canCHANNEL_ANY

#define canCHANNEL_ANY   -1

Any channel will do.

Warning
Obsolete!

◆ canCHANNEL_CAP_CAN_DIAGNOSTICS

#define canCHANNEL_CAP_CAN_DIAGNOSTICS   canCHANNEL_CAP_RESERVED_2

Obsolete, can report CAN diagnostics. Only used by LAPcan driver.

Examples:
example/c/channeldata.c.

◆ canCHANNEL_CAP_REMOTE

#define canCHANNEL_CAP_REMOTE   canCHANNEL_CAP_RESERVED_1

◆ canCIRCSTAT_BUS_OFF

#define canCIRCSTAT_BUS_OFF   0x0002

Bus off.

Warning
Obsolete!

◆ canCIRCSTAT_ERROR_PASSIVE

#define canCIRCSTAT_ERROR_PASSIVE   0x0001

Error passive.

Warning
Obsolete!

◆ canCIRCSTAT_ERROR_WARNING

#define canCIRCSTAT_ERROR_WARNING   0x0004

Error counter > 96.

Warning
Obsolete!

◆ canCIRCUIT_ANY

#define canCIRCUIT_ANY   -1

Any circuit will do.

Warning
Obsolete!

◆ canDISCARD_MESSAGE

#define canDISCARD_MESSAGE   3
Warning
Obsolete!

◆ canERR_BUFOFL

#define canERR_BUFOFL   canERR_RESERVED_3

"Buffer overflow"

Warning
Obsolete!

◆ canERR_CARDCOMMFAILED

#define canERR_CARDCOMMFAILED   canERR_RESERVED_7

"Can't communicate with the card"

Warning
Obsolete!

◆ canERR_MSGLOST

#define canERR_MSGLOST   canERR_RESERVED_5

"Message lost by CAN-chip"

Warning
Obsolete!

◆ canERR_OVERRUN

#define canERR_OVERRUN   canERR_RESERVED_6

"Receive buffer overrun"

Warning
Obsolete!

◆ canERR_REINIT

#define canERR_REINIT   canERR_RESERVED_4

"Reinitialization failed"

Warning
Obsolete!

◆ canFlgACCEPT

#define canFlgACCEPT   1
Warning
Obsolete!

◆ canFlgCODE

#define canFlgCODE   3
Warning
Obsolete!

◆ canFlgMASK

#define canFlgMASK   4
Warning
Obsolete!

◆ canFlgREJECT

#define canFlgREJECT   2
Warning
Obsolete!

◆ CANID_METAMSG

#define CANID_METAMSG   (-1L)

Like msgs containing bus status changes.

Warning
Obsolete!

◆ CANID_WILDCARD

#define CANID_WILDCARD   (-2L)

We don't care or don't know.

Warning
Obsolete!

◆ canINVPULLDOWN

#define canINVPULLDOWN   6
Warning
Obsolete!

◆ canINVPULLUP

#define canINVPULLUP   5
Warning
Obsolete!

◆ canINVPUSHPULL

#define canINVPUSHPULL   7
Warning
Obsolete!

◆ canIOCTL_LOCAL_ECHO_OFF

#define canIOCTL_LOCAL_ECHO_OFF   4
Warning
Obsolete!

◆ canIOCTL_LOCAL_ECHO_ON

#define canIOCTL_LOCAL_ECHO_ON   3
Warning
Obsolete!

◆ canMSG_STATUS

#define canMSG_STATUS   0x0008
Warning
Obsolete!

◆ canOFF

#define canOFF   0
Warning
Obsolete!

◆ canPULLDOWN

#define canPULLDOWN   3
Warning
Obsolete!

◆ canPULLUP

#define canPULLUP   2
Warning
Obsolete!

◆ canPUSHPULL

#define canPUSHPULL   4

This is the usual setting.

Warning
Obsolete!

◆ canRETAIN_MESSAGE

#define canRETAIN_MESSAGE   4
Warning
Obsolete!

◆ canSLOW_MODE

#define canSLOW_MODE   0x01

Sync on rising and falling edge.

Warning
Obsolete!

◆ canSTAT_INACTIVE

#define canSTAT_INACTIVE   canSTAT_RESERVED_1

The circuit is not active (removed from the sw bus)

Warning
Obsolete!

◆ canSTICKY_ACK_ERROR

#define canSTICKY_ACK_ERROR   0x80000801
Warning
Obsolete!

◆ canSTICKY_BIT0_ERROR

#define canSTICKY_BIT0_ERROR   0x80000010
Warning
Obsolete!

◆ canSTICKY_BIT1_ERROR

#define canSTICKY_BIT1_ERROR   0x80000020
Warning
Obsolete!

◆ canSTICKY_CRC_ERROR

#define canSTICKY_CRC_ERROR   0x80000008
Warning
Obsolete!

◆ canSTICKY_FORM_ERROR

#define canSTICKY_FORM_ERROR   0x80000002
Warning
Obsolete!

◆ canSTICKY_HW_OVERRUN

#define canSTICKY_HW_OVERRUN   0x80000040
Warning
Obsolete!

◆ canSTICKY_STUFF_ERROR

#define canSTICKY_STUFF_ERROR   0x80000004
Warning
Obsolete!

◆ canSTICKY_SW_OVERRUN

#define canSTICKY_SW_OVERRUN   0x80000080
Warning
Obsolete!

◆ canTRISTATE

#define canTRISTATE   1
Warning
Obsolete!

◆ canWANT_ACTIONS

#define canWANT_ACTIONS   0x01
Warning
Obsolete!

◆ canWANT_ERROR_COUNTERS

#define canWANT_ERROR_COUNTERS   0x04
Warning
Obsolete!

◆ canWANT_EXCLUSIVE

#define canWANT_EXCLUSIVE   0x08
Warning
Obsolete! Use canOPEN_xxx instead.

◆ canWANT_EXTENDED

#define canWANT_EXTENDED   0x10
Warning
Obsolete! Use canOPEN_xxx instead.

◆ canWANT_OWN_BUFFERS

#define canWANT_OWN_BUFFERS   0x02
Warning
Obsolete!

◆ canWANT_VIRTUAL

#define canWANT_VIRTUAL   0x20
Warning
Obsolete! Use canOPEN_xxx instead.

◆ CIRC_SJA1000

#define CIRC_SJA1000   6
Warning
Obsolete!

◆ CIRC_VIRTUAL

#define CIRC_VIRTUAL   5
Warning
Obsolete!

◆ PCCAN_INTEL526

#define PCCAN_INTEL526   2

Not supported.

Warning
Obsolete!

◆ PCCAN_INTEL527

#define PCCAN_INTEL527   3

82527 on PCCAN 1.0

Warning
Obsolete!

◆ PCCAN_PHILIPS

#define PCCAN_PHILIPS   1

82C200 on PCCAN 1.0

Warning
Obsolete!

Typedef Documentation

◆ canHWDescr

typedef struct tagCanHWDescr canHWDescr
Warning
Obsolete!

◆ canMemoryAllocator

typedef void*(* canMemoryAllocator) (size_t size)

Retained for compatibility.

Warning
Obsolete!

◆ canMemoryDeallocator

typedef void(* canMemoryDeallocator) (void *p)
Warning
Obsolete!

◆ canSWDescr

typedef struct tagCanSWDescr canSWDescr
Warning
Obsolete!

Function Documentation

◆ canGetCircuits()

canStatus canGetCircuits ( int *  context,
char *  name,
char *  vendor,
char *  version,
unsigned int *  cardtype,
unsigned int *  circtype,
unsigned int *  channel 
)
Warning
Obsolete!

◆ canInstallAction()

canStatus canInstallAction ( int  handle,
long  id,
int(*)()  fn 
)
Warning
Obsolete!

◆ canInstallOwnBuffer()

canStatus canInstallOwnBuffer ( int  handle,
long  id,
unsigned int  len,
void *  buf 
)
Warning
Obsolete!

◆ canLocateHardware()

canStatus canLocateHardware ( void  )
Warning
Obsolete!

◆ canOpen()

int canOpen ( const canHWDescr *const  hwdescr,
const canSWDescr *const  swdescr,
const unsigned int  flags 
)
Warning
Obsolete!

◆ canReadTimer()

unsigned long canReadTimer ( const int  hnd)
Delphi
function canReadTimer(handle: canHandle): Longint;
Warning
Obsolete! kvReadTimer() should be used instead.
Examples:
example/c/candump.c, and example/cpp/candemo/candemo.cpp.

◆ canUninstallAction()

canStatus canUninstallAction ( int  handle,
long  id 
)
Warning
Obsolete!

◆ canUninstallOwnBuffer()

canStatus canUninstallOwnBuffer ( int  handle,
long  id 
)
Warning
Obsolete!