canal.h

/*
MIT License
 
Copyright (c) 2000-2023 Åke Hedman, Grodans Paradis AB
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
 
// clang-format off
 
#ifndef ___CANAL_H___
#define ___CANAL_H___
 
 
// This was needed to compile as a service - Don't know why???
#ifndef EXPORT
#define EXPORT
#endif
 
 
 
#ifdef WIN32
#ifndef WINAPI
#define WINAPI __stdcall
#endif
#else
 
#endif
 
 
#define CAN_MAX_STANDARD_ID         0x7ff
#define CAN_MAX_EXTENDED_ID         0x1fffffff
 
 
// CANAL version 
// =============
// This value is steped for each new version when
// the i/f is changed. This will hopefully not
// happen but probably will.
 
#define CANAL_MAIN_VERSION                  1
#define CANAL_MINOR_VERSION                 0
#define CANAL_SUB_VERSION                  14   
 
 
// Canal Levels
#define CANAL_LEVEL_STANDARD                1
#define CANAL_LEVEL_USES_TCPIP              2
 
// VSCP daemon version information positions
#define POS_VSCPD_MAJOR_VERSION             1
#define POS_VSCPD_MINOR_VERSION             2
#define POS_VSCPD_SUB_VERSION               3
 
 
// VSCP Daemon client Open types
#define CANAL_COMMAND_OPEN_VSCP_LEVEL1      1     // VSCP Level I channel (CAN)
#define CANAL_COMMAND_OPEN_VSCP_LEVEL2      2     // VSCP Level II channel
#define CANAL_COMMAND_OPEN_VSCP_CONTROL     3     // Daemon Control channel
 
#define COMMAND_FAILURE         0
#define COMMAND_SUCCESS         1
 
 
#define PACKAGE_ACK             0
#define PACKAGE_NACK            1
 
#define PACKAGE_TIMEOUT         -1
#define PACKAGE_UNKNOWN         -1
 
#define PACKAGE_FAILURE         0
#define PACKAGE_SUCCESS         1
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
 
typedef struct structCanalMsg {
  unsigned long flags;              // CAN message flags
    unsigned long obid;                 // Used by driver for channel info etc.
    unsigned long id;                   // CAN id (11-bit or 29-bit)
    unsigned char sizeData;         // Data size 0-8
    unsigned char data[8];          // CAN Data 
    unsigned long timestamp;          // Relative time stamp for package in microseconds
} canalMsg;
 
typedef canalMsg * PCANALMSG;
 
 
typedef struct structCanalStatistics {
    unsigned long cntReceiveFrames;             // # of receive frames
    unsigned long cntTransmitFrames;            // # of transmitted frames
    unsigned long cntReceiveData;               // # of received data bytes
    unsigned long cntTransmitData;              // # of transmitted data bytes  
    unsigned long cntOverruns;                  // # of overruns
    unsigned long cntBusWarnings;               // # of bys warnings
    unsigned long cntBusOff;                    // # of bus off's
} canalStatistics;
 
typedef  canalStatistics *PCANALSTATISTICS;
 
typedef struct structCanalStatus {
    unsigned long channel_status;       // Current state for channel
    unsigned long lasterrorcode;         // Last error code
    unsigned long lasterrorsubcode;     // Last error subcode
    char lasterrorstr[80];              // Last error string
} canalStatus;
 
 
typedef  canalStatus * PCANALSTATUS;
 
 
// This is the define for the received callback method
#ifdef WIN32
typedef void ( __stdcall * LPFNDLL_CANAL_RECEIVE_CALLBACK) ( canalMsg *pMsg );
#endif
 
// CAN driver open handle
typedef long CANHANDLE;
 
 
// * * * Prototypes
 
#ifdef WIN32
long WINAPI EXPORT CanalOpen( const char *pDevice, unsigned long flags );
#else
long CanalOpen( const char *pDevice, unsigned long flags );
#endif
 
 
#ifdef WIN32
int WINAPI EXPORT CanalClose( long handle );
#else
int CanalClose( long handle );
#endif
 
#ifdef WIN32
unsigned long WINAPI EXPORT CanalGetLevel( long handle );
#else
unsigned long CanalGetLevel( long handle );
#endif
 
#ifdef WIN32
int WINAPI EXPORT CanalSend( long handle, const PCANALMSG pCanalMsg );
#else
int CanalSend( long handle, PCANALMSG pCanalMsg );
#endif
 
 
#ifdef WIN32
int WINAPI EXPORT CanalBlockingSend( long handle, PCANALMSG pCanalMsg, unsigned long timeout );
#else
int CanalBlockingSend( long handle, PCANALMSG pCanalMsg, unsigned long timeout );
#endif
 
#ifdef WIN32
int WINAPI EXPORT CanalReceive( long handle, PCANALMSG pCanalMsg );
#else
int CanalReceive( long handle, PCANALMSG pCanalMsg );
#endif
 
 
#ifdef WIN32
int WINAPI EXPORT CanalBlockingReceive( long handle, PCANALMSG pCanalMsg, unsigned long timeout );
#else
int CanalBlockingReceive( long handle, PCANALMSG pCanalMsg, unsigned long timeout );
#endif
 
#ifdef WIN32
int WINAPI EXPORT CanalDataAvailable( long handle );
#else
int CanalDataAvailable( long handle );
#endif
 
#ifdef WIN32
int WINAPI EXPORT CanalGetStatus( long handle, PCANALSTATUS pCanalStatus );
#else
int CanalGetStatus( long handle, PCANALSTATUS pCanalStatus );
#endif
 
#ifdef WIN32
int WINAPI EXPORT CanalGetStatistics( long handle, PCANALSTATISTICS pCanalStatistics  );
#else
int CanalGetStatistics( long handle, PCANALSTATISTICS pCanalStatistics  );
#endif
 
#ifdef WIN32
int WINAPI EXPORT CanalSetFilter( long handle, unsigned long filter );
#else
int CanalSetFilter( long handle, unsigned long filter );
#endif
 
#ifdef WIN32
int WINAPI EXPORT CanalSetMask( long handle, unsigned long mask );
#else
int CanalSetMask( long handle, unsigned long mask );
#endif
 
#ifdef WIN32
int WINAPI EXPORT CanalSetBaudrate( long handle, unsigned long baudrate );
#else
int CanalSetBaudrate( long handle, unsigned long baudrate );
#endif
 
#ifdef WIN32
unsigned long WINAPI EXPORT CanalGetVersion( void );
#else
unsigned long CanalGetVersion( void );
#endif
 
#ifdef WIN32
unsigned long WINAPI EXPORT CanalGetDllVersion( void );
#else
unsigned long CanalGetDllVersion( void );
#endif
 
#ifdef WIN32
const char * WINAPI EXPORT CanalGetVendorString( void );
#else
const char * CanalGetVendorString( void );
#endif
 
#ifdef WIN32
const char * WINAPI EXPORT CanalGetDriverInfo( void );
#else
const char * CanalGetDriverInfo( void );
#endif
 
// * * * * Constants * * * *
 
#define CANAL_NONBLOCK                      1           
 
 
// read/write are none blocking
 
#define CANAL_IDFLAG_STANDARD               0x00000000  // Standard message id (11-bit)
#define CANAL_IDFLAG_EXTENDED               0x00000001  // Extended message id (29-bit)
#define CANAL_IDFLAG_RTR                        0x00000002  // RTR-Frame
#define CANAL_IDFLAG_STATUS                 0x00000004  // This package is a status indication (id holds error code)
#define CANAL_IDFLAG_SEND                       0x80000000  // Reserved for use by application software to indicate send
 
#define CANAL_BAUD_USER                     0                       // User specified (In CANAL i/f DLL).
#define CANAL_BAUD_1000                     1                       //   1 Mbit
#define CANAL_BAUD_800                      2                       // 800 Kbit
#define CANAL_BAUD_500                      3                       // 500 Kbit
#define CANAL_BAUD_250                      4                       // 250 Kbit
#define CANAL_BAUD_125                      5                       // 125 Kbit
#define CANAL_BAUD_100                      6                       // 100 Kbit
#define CANAL_BAUD_50                       7                       //  50 Kbit
#define CANAL_BAUD_20                       8                       //  20 Kbit
#define CANAL_BAUD_10                       9                       //  10 Kbit         
 
#define CANAL_STATUSMSG_OK              0x00    // Normal condition. 
#define CANAL_STATUSMSG_OVERRUN     0x01    // Overrun occured when sending data to CAN bus. 
#define CANAL_STATUSMSG_BUSLIGHT    0x02    // Error counter has reached 96. 
#define CANAL_STATUSMSG_BUSHEAVY    0x03    // Error counter has reached 128. 
#define CANAL_STATUSMSG_BUSOFF      0x04    // Device is in BUSOFF. CANAL_STATUS_OK is 
                                                                                // sent when returning to operational mode.
#define CANAL_STATUSMSG_STUFF           0x20    // Stuff Error.
#define CANAL_STATUSMSG_FORM            0x21    // Form Error.
#define CANAL_STATUSMSG_ACK             0x23    // Ack Error.
#define CANAL_STATUSMSG_BIT1            0x24    // Bit1 Error.
#define CANAL_STATUSMSG_BIT0            0x25    // Bit0 Error.
#define CANAL_STATUSMSG_CRC             0x27    // CRC Error.
 
#define CANAL_STATUS_NONE                   0x00000000
#define CANAL_STATUS_ACTIVE                 0x10000000
#define CANAL_STATUS_PASSIVE                0x40000000
#define CANAL_STATUS_BUS_OFF                0x80000000
#define CANAL_STATUS_BUS_WARN               0x20000000
#define CANAL_STATUS_PHY_FAULT              0x08000000
#define CANAL_STATUS_PHY_H                  0x04000000
#define CANAL_STATUS_PHY_L                  0x02000000
#define CANAL_STATUS_SLEEPING               0x01000000
#define CANAL_STATUS_STOPPED                0x00800000
#define CANAL_STATUS_RECIVE_BUFFER_FULL     0x00400000  // Drivers buffer
#define CANAL_STATUS_TRANSMIT_BUFFER_FULL   0x00200000  // Drivers buffer
 
#define CANAL_ERROR_SUCCESS                     0       // All is OK
#define CANAL_ERROR_BAUDRATE                    1       // Baudrate error
#define CANAL_ERROR_BUS_OFF                     2       // Bus off error
#define CANAL_ERROR_BUS_PASSIVE                 3       // Bus Passive error
#define CANAL_ERROR_BUS_WARNING                 4       // Bus warning error
#define CANAL_ERROR_CAN_ID                      5       // Invalid CAN ID
#define CANAL_ERROR_CAN_MESSAGE                 6       // Invalid CAN message
#define CANAL_ERROR_CHANNEL                     7       // Invalid channel
#define CANAL_ERROR_FIFO_EMPTY                  8       // FIFO is empty
#define CANAL_ERROR_FIFO_FULL                   9       // FIFI is full
#define CANAL_ERROR_FIFO_SIZE                   10      // FIFO size error
#define CANAL_ERROR_FIFO_WAIT                   11      
#define CANAL_ERROR_GENERIC                     12      // Generic error
#define CANAL_ERROR_HARDWARE                    13      // Hardware error
#define CANAL_ERROR_INIT_FAIL                   14      // Initialization failed
#define CANAL_ERROR_INIT_MISSING                15      
#define CANAL_ERROR_INIT_READY                  16
#define CANAL_ERROR_NOT_SUPPORTED               17      // Not supported
#define CANAL_ERROR_OVERRUN                     18      // Overrun
#define CANAL_ERROR_RCV_EMPTY                   19      // Receive buffer empty
#define CANAL_ERROR_REGISTER                    20      // Register value error
#define CANAL_ERROR_TRM_FULL                    21
#define CANAL_ERROR_ERRFRM_STUFF                22      // Errorframe: stuff error detected
#define CANAL_ERROR_ERRFRM_FORM                 23      // Errorframe: form error detected
#define CANAL_ERROR_ERRFRM_ACK                  24      // Errorframe: acknowledge error
#define CANAL_ERROR_ERRFRM_BIT1                 25      // Errorframe: bit 1 error
#define CANAL_ERROR_ERRFRM_BIT0                 26      // Errorframe: bit 0 error
#define CANAL_ERROR_ERRFRM_CRC                  27      // Errorframe: CRC error
#define CANAL_ERROR_LIBRARY                     28      // Unable to load library
#define CANAL_ERROR_PROCADDRESS                 29      // Unable get library proc address
#define CANAL_ERROR_ONLY_ONE_INSTANCE           30      // Only one instance allowed
#define CANAL_ERROR_SUB_DRIVER                  31      // Problem with sub driver call
#define CANAL_ERROR_TIMEOUT                     32      // Blocking call timeout
#define CANAL_ERROR_NOT_OPEN                    33      // The device is not open.
#define CANAL_ERROR_PARAMETER                   34      // A parameter is invalid.
#define CANAL_ERROR_MEMORY                      35      // Memory exhausted.
#define CANAL_ERROR_INTERNAL                    36      // Some kind of internal program error
#define CANAL_ERROR_COMMUNICATION               37      // Some kind of communication error
#define CANAL_ERROR_USER                        38      // Login error
 
// CANAL commands sent over the pipe interface (depricated)
#define CANAL_COMMAND_NOOP                              0       // No command
#define CANAL_COMMAND_OPEN                                  1       // Open channel 
#define CANAL_COMMAND_CLOSE                                 2       // Close channel
#define CANAL_COMMAND_SEND                                  3       // Send message
#define CANAL_COMMAND_RECEIVE                               4       // Receive message
#define CANAL_COMMAND_CHECKDATA                         5       // Check if data is available
#define CANAL_COMMAND_BAUDRATE                          6       // Set Baudrate
#define CANAL_COMMAND_STATUS                                7       // Get status
#define CANAL_COMMAND_STATISTICS                        8       // Get statistics
#define CANAL_COMMAND_FILTER                                9       // Set filter
#define CANAL_COMMAND_MASK                                  10      // Set mask
#define CANAL_COMMAND_VERSION                               11      // CANAL version
#define CANAL_COMMAND_DLL_VERSION                       12      // CANAL DLL version
#define CANAL_COMMAND_VENDOR_STRING                 13      // CANAL vendor string
#define CANAL_COMMAND_LEVEL                                 14      // CANAL Level bitarray
 
// CANAL responses sent over the pipe interface (depricated)
#define CANAL_RESPONSE_NONE                                 0       // 
#define CANAL_RESPONSE_SUCCESS                          1       // OK message
#define CANAL_RESPONSE_ERROR                                2       // ERROR message
#define CANAL_RESPONSE_MESSAGE                          3       // Response to read
 
// CANAL error codes sent over the client interface 
// on error responses
#define CANAL_IFERROR_GENERAL                               128     // General error
#define CANAL_IFERROR_UNKNOWN_COMMAND               129
#define CANAL_IFERROR_CHANNEL_OPEN                  130
#define CANAL_IFERROR_CHANNEL_CLOSED                131
#define CANAL_IFERROR_SEND_SUCCESS                  132
#define CANAL_IFERROR_SEND_MSG_ALLOCATON        133
#define CANAL_IFERROR_BUFFER_EMPTY                  134
#define CANAL_IFERROR_BUFFER_FULL                       135
#define CANAL_IFERROR_READ_FAILURE                  136
#define CANAL_IFERROR_SEND_STORAGE                  137 
 
 
// * * * TCP/IP FAST mode interface constants
 
// FAST mode primary states
#define CANAL_BINARY_FRAME_TYPE_VSCP                0       // VSCP event
#define CANAL_BINARY_FRAME_TYPE_ERROR               1       // ACK/NACK/errors
#define CANAL_BINARY_FRAME_TYPE_COMMAND         2       // Command frame
#define CANAL_BINARY_FRAME_TYPE_CAN                 3       // CAN Frame
 
#define CANAL_BINARY_COMMAND_NOOP                       0       // No operation 
#define CANAL_BINARY_COMMAND_READ                       1       // Read one frame
#define CANAL_BINARY_COMMAND_CLOSE                  2       // Close communication channel
 
// FAST error codes
#define CANAL_BINARY_ERROR_NONE                         0       // OK
#define CANAL_BINARY_ERROR_GENERAL                  1       // General error
#define CANAL_BINARY_ERROR_TO_SMALL                 2       // Packet smaller then min packet
#define CANAL_BINARY_ERROR_FORMAT                       3       // Packet have bad format
#define CANAL_BINARY_ERROR_UNKNOW_FRAME         4       // Unknown frame type
#define CANAL_BINARY_ERROR_MEMORY                       5       // No room for event
#define CANAL_BINARY_ERROR_NO_DATA                  6       // No data available
#define CANAL_BINARY_ERROR_INVALID_CMD          7       // Command not recognized.
 
// Filter mask settings
#define CANUSB_ACCEPTANCE_FILTER_ALL        0x00000000
#define CANUSB_ACCEPTANCE_MASK_ALL          0xFFFFFFFF
 
#ifdef __cplusplus
}
#endif
 
 
#endif //___CANAL_H___
 
 
 
// History
// =======
//
// 2007-10-31 AKHE - Blocking and driver properties added
// 2006-05-16 AKHE - Added fastmode defines.
// 2005-08-09 AKHE - Added error info to canalStatus structure.
 
// clang-format on