Main Page | Modules | Data Structures | Directories | File List | Data Fields | Globals

canapi.h File Reference

Go to the source code of this file.

Data Structures

struct  can20bframe
 Representation of CAN 2.0B frame format. More...
struct  _as_ts
 Representation of the last associated time. More...

Defines

#define CAN_MAXCHANNELS   1024
 Maximum number of channels that can be opened simultaneously.
#define CAN_MAXBUFFER   256
 GLOBAL maximum size of a char buffer.

Typedefs

typedef unsigned char uchar
typedef unsigned int uint
typedef unsigned short ushort
typedef unsigned long ulong
typedef can20bframe can_frame
 Representation of CAN 2.0B frame format.
typedef _as_ts as_ts
 Representation of the last associated time.
typedef char can_list [CAN_MAXCHANNELS][CAN_MAXBUFFER]

Enumerations

enum  {
  S_TYPE_ERROR = 0x8001, S_TYPE_OVER = 0x8002, S_TYPE_REMOTE = 0x8004, S_TYPE_WAKEUP = 0x8008,
  S_TYPE_SYNC = 0x8010, S_ERR_OVERRUN = 0x8020, S_ERR_LINE = 0x8040, S_ERR_VOLTAGE = 0x8080,
  S_COMPLETE = 0x8100, S_QUEUED = 0x8200, S_BOARD_OFF = 0x01, S_BOARD_PASSIVE = 0x02,
  S_BOARD_WARNING = 0x04, S_BOARD_ACTIVE = 0x08, S_MSG_TRANSMIT, S_MSG_REMOTE,
  S_MSG_ERROR
}
enum  {
  S_SUCCESS = 0, S_PENDING, S_ERR_QUEUE_IS_EMPTY, S_ERR_QUEUE_IS_FULL,
  S_ERR_TX_NOT_POSSIBLE, S_ERR_TWICE_REGISTER, S_ERR_INVALID_CHAN_INDEX, S_ERR_INVALID_ACCESS,
  S_ERR_PORT_IS_OFFLINE, S_ERR_CHAN_IS_ONLINE, S_ERR_INVALID_PORT, S_ERR_HW_NOT_READY,
  S_ERR_CMD_TIMEOUT, S_ERR_HW_NOT_PRESENT, S_ERR_NOTIFY_ALREADY_ACTIVE, S_ERR_NO_RESOURCES,
  S_ERR_CANNOT_OPEN_DRIVER, S_ERR_NOT_IMPLEMENTED, S_ERR_INV_HANDLE, S_ERR_INVARG1,
  S_ERR_INVARG2, S_ERR_INVARG3, S_ERR_INVARGS, S_ERR_OOB,
  S_ERR_UNKNOWN, S__MAX
}
enum  {
  FAKED_SOF = 0x0001, FAKED_ID = 0x0002, FAKED_SRR = 0x0004, FAKED_IDE = 0x0008,
  FAKED_EXT = 0x0010, FAKED_RTR = 0x0020, FAKED_RES = 0x0040, FAKED_DLC = 0x0080,
  FAKED_DATA = 0x0100, FAKED_CRC = 0x0200, FAKED_ACK = 0x0400, FAKED_EOF = 0x0800,
  C_TXERROR = 0, C_RXERROR, C_BAUDRATE, C_MASK,
  C_CODE, C_RXQUEUE, C_TXQUEUE, C_HIDEERRORS,
  C_HIDECHIP, C_BLOCKTIMEOUT, C_BOARDSTATE, C__MAX
}
enum  { B_CAN_GATEWAY, B_CAN_GROUP, B_CAN_MESSAGE, B_CAN_STATUS }

Functions

int can_probebus (can_list list, char *errbuf)
 The function is used to probe the bus for CAN cards.
int can_openchannel (char *device, char *errbuf)
 This functions is used to open a CAN channel for reading and writing.
int can_readchannel (int handle, can_frame *frame)
 This functions is used to read a can_frame from a channel.
int can_writechannel (int handle, can_frame *frame)
 This functions is used to write a can_frame to a channel.
int can_closechannel (int handle)
 This functions is used to close a channel opened with can_openchannel.
int can_setchanneloptions (int handle, int option, int status)
 This functions is used to manually set an option on an underlying adapter.
int can_getchanneloptions (int handle, int option, int *status)
 This functions is used to manually get an option from an underlying adapter.
int can_can2raw (can_frame *frame, uchar *raw)
 This functions is used to convert a formatted can_frame to a raw bitpacked CAN 2.0 B frame.
int can_raw2can (uchar *raw, can_frame *frame)
 This functions is used to convert a raw bitpacked CAN 2.0 B frame to a formatted can_frame.
int can_getlasterror (int handle, char *errbuf)
 This functions is used to get the character string of the last error associated with a handle.
int can_getlastassoc (int handle, as_ts *timestamp)
 This functions is used to get the last IRIG time sync association.
int can_getfield (can_frame *frame, int type, int *ret)
 This functions is used to extract fields for use in the Analyzer.


Typedef Documentation

typedef char can_list[CAN_MAXCHANNELS][CAN_MAXBUFFER]
 

Definition at line 417 of file canapi.h.

typedef unsigned char uchar
 

Definition at line 78 of file canapi.h.

typedef unsigned int uint
 

Definition at line 79 of file canapi.h.

typedef unsigned long ulong
 

Definition at line 81 of file canapi.h.

typedef unsigned short ushort
 

Definition at line 80 of file canapi.h.


Generated on Wed Feb 22 13:31:26 2006 for CANapi by  doxygen 1.4.4