kvmlib.h

Go to the documentation of this file.

/*
*             Copyright 2017 by Kvaser AB, Molndal, Sweden
*                         http://www.kvaser.com
*
* This software is dual licensed under the following two licenses:
* BSD-new and GPLv2. You may use either one. See the included
* COPYING file for details.
*
* License: BSD-new
* ==============================================================================
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*     * Redistributions of source code must retain the above copyright
*       notice, this list of conditions and the following disclaimer.
*     * Redistributions in binary form must reproduce the above copyright
*       notice, this list of conditions and the following disclaimer in the
*       documentation and/or other materials provided with the distribution.
*     * Neither the name of the <organization> nor the
*       names of its contributors may be used to endorse or promote products
*       derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
* BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
* IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
*
* License: GPLv2
* ==============================================================================
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
*
*
* IMPORTANT NOTICE:
* ==============================================================================
* This source code is made available for free, as an open license, by Kvaser AB,
* for use with its applications. Kvaser AB does not accept any liability
* whatsoever for any third party patent or other immaterial property rights
* violations that may result from any usage of this source code, regardless of
* the combination of source code and various applications that it can be used
* in, or with.
*
* -----------------------------------------------------------------------------
*/

#ifndef KVMLIB_H
#define KVMLIB_H

#define WINAPI
#define INVALID_HANDLE_VALUE NULL
typedef void*     HANDLE;
#include <stdint.h>
#include <stdio.h>

typedef int8_t      int8;
typedef uint8_t     uint8;
typedef int16_t     int16;
typedef uint16_t    uint16;
typedef int32_t     int32;
typedef uint32_t    uint32;
typedef int64_t     int64;


#ifdef __cplusplus
extern "C" {
#endif

#define kvmDEVICE_MHYDRA     0      
#define kvmDEVICE_MHYDRA_EXT 1      

#define kvmLDF_MAJOR_CAN     3  
#define kvmLDF_MAJOR_CAN64   5  

typedef HANDLE kmeFileHandle;

#define kvmFS_FAT16   0      
#define kvmFS_FAT32   1      

#define kvmFILE_KME24   0      
#define kvmFILE_KME25   1      
#define kvmFILE_KME40   2      
#define kvmFILE_KME50   3      
#define kvmFILE_KME60   4      

typedef HANDLE kvmHandle;


  // If you change here, remember to also change kvmlib.cpp and kvmlibtest...
typedef enum {
  kvmOK                      =  0,  
  kvmFail                    = -1,  
  kvmERR_PARAM               = -3,  
  kvmERR_LOGFILEOPEN         = -8,  
  kvmERR_NOSTARTTIME         = -9,  
  kvmERR_NOLOGMSG            = -10,  
  kvmERR_LOGFILEWRITE        = -11,  
  kvmEOF                     = -12,  
  kvmERR_NO_DISK             = -13,  
  kvmERR_LOGFILEREAD         = -14,  
  kvmERR_QUEUE_FULL          = -20,  
  kvmERR_CRC_ERROR           = -21,  
  kvmERR_SECTOR_ERASED       = -22,  
  kvmERR_FILE_ERROR          = -23,  
  kvmERR_DISK_ERROR          = -24,  
  kvmERR_DISKFULL_DIR        = -25,  
  kvmERR_DISKFULL_DATA       = -26,  
  kvmERR_SEQ_ERROR           = -27,  
  kvmERR_FILE_SYSTEM_CORRUPT = -28,  
  kvmERR_UNSUPPORTED_VERSION = -29,  
  kvmERR_NOT_IMPLEMENTED     = -30,  
  kvmERR_FATAL_ERROR         = -31,  
  kvmERR_ILLEGAL_REQUEST     = -32,  
  kvmERR_FILE_NOT_FOUND      = -33,  
  kvmERR_NOT_FORMATTED       = -34,  
  kvmERR_WRONG_DISK_TYPE     = -35,  
  kvmERR_TIMEOUT             = -36,  
  kvmERR_DEVICE_COMM_ERROR   = -37,  
  kvmERR_OCCUPIED            = -38,  
  kvmERR_USER_CANCEL         = -39,  
  kvmERR_FIRMWARE            = -40,  
  kvmERR_CONFIG_ERROR        = -41,  
  kvmERR_WRITE_PROT          = -42,  
  kvmERR_RESULT_TOO_BIG      = -43,  

} kvmStatus;
#define kvmLogFileType_ERR   0  
#define kvmLogFileType_ALL   1  

#define kvm_SWINFO_KVMLIB                   1  
#define kvm_SWINFO_DRIVER                   2  
#define kvm_SWINFO_FIRMWARE                 3  
#define kvm_SWINFO_DRIVER_PRODUCT           4  
#define kvm_SWINFO_CONFIG_VERSION_NEEDED    5  
#define kvm_SWINFO_CPLD_VERSION             6  

#pragma pack(push, 1)

#ifndef canMSG_RTR

#  define canMSG_RTR            0x0001      
#  define canMSG_STD            0x0002      
#  define canMSG_EXT            0x0004      
#  define canMSG_ERROR_FRAME    0x0020      
#  define canMSG_TXACK          0x0040      
#  define canMSG_TXRQ           0x0080      
#  define canMSGERR_OVERRUN     0x0600      
#  define canFDMSG_EDL          0x010000    
#  define canFDMSG_FDF          0x010000    
#  define canFDMSG_BRS          0x020000    
#  define canFDMSG_ESI          0x040000    

#endif

#ifndef LIN_TX

#  define LIN_TX           1    
#  define LIN_RX           2    
#  define LIN_WAKEUP_FRAME 4    
#  define LIN_NODATA       8    
#  define LIN_CSUM_ERROR   16   
#  define LIN_PARITY_ERROR 32   
#  define LIN_SYNCH_ERROR  64   
#  define LIN_BIT_ERROR    128  

#endif

#define TRIGVAR_TYPE_MSG_ID         0       
#define TRIGVAR_TYPE_MSG_DLC        1       
#define TRIGVAR_TYPE_MSG_FLAG       2       
#define TRIGVAR_TYPE_SIGVAL         3       
#define TRIGVAR_TYPE_EXTERNAL       4       
#define TRIGVAR_TYPE_TIMER          5       
#define TRIGVAR_TYPE_DISK_FULL      6       
#define TRIGVAR_TYPE_STARTUP        9       

typedef struct {
  uint32 id;            
  int64  timeStamp;     
  uint32 channel;       
  uint32 dlc;           
  uint32 flags;         
  uint8  data[64];      
} kvmLogMsgEx;

typedef struct {
  uint32 calendarTime;   
  int64  timeStamp;      
} kvmLogRtcClockEx;


typedef struct {
  int32   type;           
  int32   preTrigger;     
  int32   postTrigger;    
  uint32  trigMask;       
  int64   timeStamp;      
} kvmLogTriggerEx;

typedef struct
{
  uint32 lioMajor;     // Lio major version
  uint32 lioMinor;     // Lio minor version
  uint32 fwMajor;      // Firmware major version
  uint32 fwMinor;      // Firmware major version
  uint32 fwBuild;      // Firmware build version
  uint32 serialNumber; // Serial number
  uint32 eanHi;        // EAN high bytes
  uint32 eanLo;        // EAN low bytes
} kvmLogVersionEx;


#define kvmLOG_TYPE_INVALID    0 
#define kvmLOG_TYPE_CLOCK      1 
#define kvmLOG_TYPE_MSG        2 
#define kvmLOG_TYPE_TRIGGER    3 
#define kvmLOG_TYPE_VERSION    4 
#define kvmLOG_TYPE_LINMSG     5 

typedef struct {
  uint32               type;    
  union {
    kvmLogMsgEx        msg;     
    kvmLogRtcClockEx   rtc;     
    kvmLogTriggerEx    trig;    
    kvmLogVersionEx    ver;     
    uint8              raw[128]; 
  } eventUnion;
} kvmLogEventEx;

#pragma pack(pop)

void WINAPI kvmInitialize(void);

kvmStatus WINAPI kvmGetVersion(int *major, int *minor, int *build);

kvmStatus WINAPI kvmGetErrorText(kvmStatus error, char *buf, size_t len);

kvmStatus WINAPI kvmClose(kvmHandle h);

kvmHandle    WINAPI kvmDeviceOpen(int32 cardNr,
                                     kvmStatus *status,
                                     int32 deviceType);

kvmStatus WINAPI kvmDeviceMountKmf(kvmHandle h);

kvmStatus WINAPI kvmDeviceMountKmfEx(kvmHandle h, int *ldfMajor, int *ldfMinor);

kvmHandle    WINAPI kvmKmfOpen(const char *filename,
                                 kvmStatus *status,
                                 int32 deviceType);

kvmHandle    WINAPI kvmKmfOpenEx(const char *filename,
                                 kvmStatus *status,
                                 int32 deviceType,
                                 int *ldfMajor,
                                 int *ldfMinor);

kvmStatus WINAPI kvmKmfValidate(kvmHandle h);

kvmStatus WINAPI kvmDeviceFormatDisk(kvmHandle h,
                                   int fileSystem,
                                   uint32 reserveSpace,
                                   uint32 dbaseSpace);

kvmStatus WINAPI kvmLogFileGetCount(kvmHandle h, uint32 *fileCount);

kvmStatus WINAPI kvmLogFileGetType(kvmHandle h, uint32 fileIndx, int32 *logFileType);

kvmStatus WINAPI kvmLogFileMount(kvmHandle h, uint32 fileIndx,
                                    uint32 *eventCount);

kvmStatus WINAPI kvmLogFileMountEx(kvmHandle h, uint32 fileIndx,
                                    int64 *eventCount);

kvmStatus WINAPI kvmLogFileDismount(kvmHandle h);

kvmStatus WINAPI kvmLogFileGetStartTime (kvmHandle h,
                                         uint32 *startTime);

kvmStatus WINAPI kvmLogFileGetEndTime (kvmHandle h,
                                       uint32 *endTime);

kvmStatus WINAPI kvmLogFileGetCreatorSerial(kvmHandle h,
                                         uint32 *serialNumber);

kvmStatus WINAPI kvmLogFileReadEvent(kvmHandle h, kvmLogEventEx *e);


kvmStatus WINAPI kvmLogFileDeleteAll(kvmHandle h);

kvmStatus WINAPI kvmDeviceDiskStatus(kvmHandle h, int *present);

kvmStatus WINAPI kvmKmfGetUsage(kvmHandle h,
                                           uint32 *totalSectorCount,
                                           uint32 *usedSectorCount);

kvmStatus WINAPI kvmDeviceDiskSize(kvmHandle h, uint32 *diskSize);

kvmStatus WINAPI kvmDeviceGetSerialNumber(kvmHandle h, unsigned int *serial);

kvmStatus WINAPI kvmDeviceGetSoftwareInfo(kvmHandle h,
                                               int32 itemCode,
                                               unsigned int *major,
                                               unsigned int *minor,
                                               unsigned int *build,
                                               unsigned int *flags);
kvmStatus WINAPI kvmDeviceFlashLeds(kvmHandle h);


kvmStatus WINAPI kvmDeviceGetRTC(kvmHandle h, uint32 *t);

kvmStatus WINAPI kvmDeviceSetRTC(kvmHandle h, uint32 t);

kvmStatus WINAPI kvmKmfReadConfig(kvmHandle h, void *buf,
                                    size_t buflen, size_t *actual_len);

kvmStatus WINAPI kvmKmfWriteConfig(kvmHandle h, void *buf, size_t buflen);


kvmStatus WINAPI kvmKmfGetDbaseFile(kvmHandle h, char *path, char *filenamebuf, size_t buflen);

kvmStatus WINAPI kvmKmfPutDbaseFile(kvmHandle h, char *filename);

kvmStatus WINAPI kvmKmfEraseDbaseFile(kvmHandle h);

kmeFileHandle    WINAPI kvmKmeOpenFile (const char *filename,
                                    kvmStatus *status,
                                    int32 fileType);

kvmStatus    WINAPI kvmKmeScanFileType (const char *filename,
                                        int32 *fileType);

kmeFileHandle    WINAPI kvmKmeCreateFile (const char *filename,
                                      kvmStatus *status,
                                      int32 fileType);

kvmStatus    WINAPI kvmKmeReadEvent (kmeFileHandle h, kvmLogEventEx *e);

kvmStatus    WINAPI kvmKmeWriteEvent (kmeFileHandle h, kvmLogEventEx *e);

kvmStatus    WINAPI kvmKmeCountEvents(kmeFileHandle h, uint32 *eventCount);

kvmStatus    WINAPI kvmKmeCountEventsEx(kmeFileHandle h, int64 *eventCount);

kvmStatus    WINAPI kvmKmeCloseFile (kmeFileHandle h);

#ifdef __cplusplus
}
#endif

#endif //KVMLIB_H