interfaces.h

Go to the documentation of this file.

/*============================================================================*
 * FILE:                      interfaces.h
 *============================================================================*
 *
 *                      COPYRIGHT (C) 2006  BY
 *          CONDOR ENGINEERING, INC., SANTA BARBARA, CALIFORNIA
 *          ALL RIGHTS RESERVED.
 *
 *          THIS SOFTWARE IS FURNISHED UNDER A LICENSE AND MAY BE USED AND
 *          COPIED ONLY IN ACCORDANCE WITH THE TERMS OF SUCH LICENSE AND WITH
 *          THE INCLUSION OF THE ABOVE COPYRIGHT NOTICE.  THIS SOFTWARE OR ANY
 *          OTHER COPIES THEREOF MAY NOT BE PROVIDED OR OTHERWISE MADE
 *          AVAILABLE TO ANY OTHER PERSON.  NO TITLE TO AND OWNERSHIP OF THE
 *          SOFTWARE IS HEREBY TRANSFERRED.
 *
 *          THE INFORMATION IN THIS SOFTWARE IS SUBJECT TO CHANGE WITHOUT
 *          NOTICE AND SHOULD NOT BE CONSTRUED AS A COMMITMENT BY CONDOR
 *          ENGINEERING.
 *
 *============================================================================*
 *
 * FUNCTION:    Function Descriptions that every CAN interface should have
 *
 * Author:      Christopher McKenzie
 * 
 * MAINTENANCE NOTES:
 * 
 *============================================================================*/
#ifndef _CACEINTERFACES_H_
#define _CACEINTERFACES_H_
#include"../includes/defines.h"
#include"../includes/canapi.h"
//
// Define what you have
//
#define CANBOARDXL      0
//#define CARDONE       1
//#define CARDTWO       2

#define IF_SUCCESS      0
#define IF_FAILURE      1

#define IF_DEFAULT_RXQUEUE      256
#define IF_DEFAULT_BAUD         500000

struct _if_board
{       unsigned short  boardtype;      //CANBOARDXL, BOARDONE, etc...
        unsigned int
                hwType,
                channelcount,
                
                index;  //index in the data structure

        unsigned short  //Although 11898-3 says that errors max at 256, who knows...
                txErrorCounter,
                rxErrorCounter,
                status;         //Active/passive/off

        struct _if_channel*channel[32];
};

struct _if_channel
{       struct _if_board*board; //The associated physical board
        
        unsigned char   
                name[CAN_MAXBUFFER],
                transceiverName[CAN_MAXBUFFER];
                
        int isopen,
                txerror,
                rxerror,
                baudrate,
                rxqueuesize,
                index;  //channel number in data structure
        
        struct can20bframe*previous[MAX_STACK];

        unsigned long
                hwType,
                hwIndex,        //channel number on board
                hwChannel,
                hwHandle,       //to talk to the vendor
                
                hwTransType,
                hwTransState,
                
                hwChannelIndex,
                
                capabilities,
                buscapabilities,
                bustype,

                serialNumber,
                articleNumber,

                rxqueue,
                txqueue;

        void*blockinghandle;    //if blocking is not provided
        int blocktimeout;       //block a read/write (default: true)

        unsigned int    flags;  //vendor specific stuff

        struct
        {       int     last;
                long    time;
                //other metadata
        }error;

        as_ts lastsync;

        struct
        {       unsigned long
                        code,
                        mask;
                char type;      //CAN 2.0 a or b
        }filter;
};

enum
{       d_canboardxl,
        d_cardone,
        d_cardtwo
};

struct _s_interface
{       int activecount;
        int     (*probefunction)();
        int     (*startupfunction)();
        int (*openchannelfunction)(int);
        int (*closechannelfunction)(int);
        int     (*shutdownfunction)();
        int     (*readfunction)(int,can_frame*);
        int (*writefunction)(int,can_frame*);
        int (*updatestatusfunction)(int);
        int (*changestatusfunction)(int,int,int);
};

int boardprobe();
int boardopenchannel(int);
int boardclosechannel(int);
int boardread(int,can_frame*);
int boardwrite(int,can_frame*);
int boardupdatestatus(int which);
int boardchangestatus(int,int,int);
int boardshutdown(int);

void boarddllmain();

int fakecrc(unsigned char*,int*);
#endif

---