Skip to content

Commit

Permalink
Merge pull request rbei-etas#748 from yegorich/dll-update
Browse files Browse the repository at this point in the history 
CAN_VSCOM: bump API to 1.7.1
  • Loading branch information
@etas-lorenz
etas-lorenz committed Aug 25, 2014
2 parents 623daaf + 10da1b7 commit d968a71
Show file tree
Hide file tree
Showing 7 changed files with 221 additions and 218 deletions.
Binary file modified Sources/BIN/Libs/Release/vs_can_api.lib
View file
Binary file not shown.
Binary file modified Sources/BIN/Libs/busmaster_debug/vs_can_api.lib
View file
Binary file not shown.
Binary file modified Sources/BIN/Release/vs_can_api.dll
View file
Binary file not shown.
Binary file modified Sources/BIN/busmaster_debug/vs_can_api.dll
View file
Binary file not shown.
223 changes: 113 additions & 110 deletions Sources/CAN_VSCOM/EXTERNAL/vs_can_api.h
View file
Original file line number Diff line number Diff line change
@@ -1,19 +1,20 @@
/*!
* @file
* \file
*
* \version
* 1.6
* 1.7.1
*
* @brief
* \brief
* VSCAN API implementation (header file)
*
* This is the implementation of the VSCAN API - a wrapper for the specialized ASCII command set.
* The library is available for Windows and Linux.
*
* Copyright (c) 2011 by VScom
*
* Copyright (c) 2014 by VScom
*/
#ifndef _VS_CAN_API_H_
#define _VS_CAN_API_H_

#pragma once

#ifdef WIN32
#include <windows.h>
Expand All @@ -29,13 +30,13 @@ typedef unsigned long ULONG;


#ifndef UINT8
#define UINT8 UCHAR
#define UINT8 UCHAR
#endif
#ifndef UINT16
#define UINT16 USHORT
#define UINT16 USHORT
#endif
#ifndef UINT32
#define UINT32 ULONG
#define UINT32 ULONG
#endif


Expand All @@ -45,167 +46,169 @@ typedef int VSCAN_STATUS;
// Hardware Parameter Structure
typedef struct
{
UINT32 SerialNr;
UINT8 HwVersion;
UINT8 SwVersion;
UINT8 HwType;
UINT32 SerialNr;
UINT8 HwVersion;
UINT8 SwVersion;
UINT8 HwType;
} VSCAN_HWPARAM;

// Message Structure
typedef struct
{
UINT32 Id;
UINT8 Size;
UINT8 Data[8];
UINT8 Flags;
UINT16 Timestamp;
UINT32 Id;
UINT8 Size;
UINT8 Data[8];
UINT8 Flags;
UINT16 Timestamp;
} VSCAN_MSG;

// Bit Timing Register Structure
typedef struct
{
UINT8 Btr0;
UINT8 Btr1;
UINT8 Btr1;
} VSCAN_BTR;

// Acceptance Code and Mask Structure
typedef struct
{
UINT32 Code;
UINT32 Mask;
UINT32 Mask;
} VSCAN_CODE_MASK;

// API Version Structure
typedef struct
{
UINT8 Major;
UINT8 Minor;
UINT8 SubMinor;
UINT8 Major;
UINT8 Minor;
UINT8 SubMinor;
} VSCAN_API_VERSION;


#define VSCAN_FIRST_FOUND NULL
#define VSCAN_FIRST_FOUND NULL

// Debug Mode
#define VSCAN_DEBUG_MODE_CONSOLE (void*)1
#define VSCAN_DEBUG_MODE_FILE (void*)2
#define VSCAN_DEBUG_MODE_CONSOLE (void*)1
#define VSCAN_DEBUG_MODE_FILE (void*)2
// Debug Level
#define VSCAN_DEBUG_NONE (void*)0
#define VSCAN_DEBUG_LOW (void*)-1
#define VSCAN_DEBUG_MID (void*)-51
#define VSCAN_DEBUG_HIGH (void*)-101
#define VSCAN_DEBUG_NONE (void*)0
#define VSCAN_DEBUG_LOW (void*)-1
#define VSCAN_DEBUG_MID (void*)-51
#define VSCAN_DEBUG_HIGH (void*)-101

// Status / Errors
#define VSCAN_ERR_OK 0
#define VSCAN_ERR_ERR ((int)VSCAN_DEBUG_LOW) // Debug Level Low
#define VSCAN_ERR_NO_DEVICE_FOUND ((int)VSCAN_DEBUG_LOW - 1)
#define VSCAN_ERR_SUBAPI ((int)VSCAN_DEBUG_LOW - 2)
#define VSCAN_ERR_NOT_ENOUGH_MEMORY ((int)VSCAN_DEBUG_LOW - 3)
#define VSCAN_ERR_NO_ELEMENT_FOUND ((int)VSCAN_DEBUG_LOW - 4)
#define VSCAN_ERR_INVALID_HANDLE ((int)VSCAN_DEBUG_LOW - 5)
#define VSCAN_ERR_IOCTL ((int)VSCAN_DEBUG_LOW - 6)
#define VSCAN_ERR_MUTEX ((int)VSCAN_DEBUG_LOW - 7)
#define VSCAN_ERR_CMD ((int)VSCAN_DEBUG_LOW - 8)
#define VSCAN_ERR_LISTEN_ONLY ((int)VSCAN_DEBUG_LOW - 9)
#define VSCAN_ERR_NOT_SUPPORTED ((int)VSCAN_DEBUG_LOW - 10)
#define VSCAN_ERR_GOTO_ERROR ((int)VSCAN_DEBUG_HIGH) // Debug Level High
#define VSCAN_ERR_OK 0
#define VSCAN_ERR_ERR ((int)VSCAN_DEBUG_LOW) // Debug Level Low
#define VSCAN_ERR_NO_DEVICE_FOUND ((int)VSCAN_DEBUG_LOW - 1)
#define VSCAN_ERR_SUBAPI ((int)VSCAN_DEBUG_LOW - 2)
#define VSCAN_ERR_NOT_ENOUGH_MEMORY ((int)VSCAN_DEBUG_LOW - 3)
#define VSCAN_ERR_NO_ELEMENT_FOUND ((int)VSCAN_DEBUG_LOW - 4)
#define VSCAN_ERR_INVALID_HANDLE ((int)VSCAN_DEBUG_LOW - 5)
#define VSCAN_ERR_IOCTL ((int)VSCAN_DEBUG_LOW - 6)
#define VSCAN_ERR_MUTEX ((int)VSCAN_DEBUG_LOW - 7)
#define VSCAN_ERR_CMD ((int)VSCAN_DEBUG_LOW - 8)
#define VSCAN_ERR_LISTEN_ONLY ((int)VSCAN_DEBUG_LOW - 9)
#define VSCAN_ERR_NOT_SUPPORTED ((int)VSCAN_DEBUG_LOW - 10)
#define VSCAN_ERR_GOTO_ERROR ((int)VSCAN_DEBUG_HIGH) // Debug Level High

// Mode
#define VSCAN_MODE_NORMAL 0
#define VSCAN_MODE_LISTEN_ONLY 1
#define VSCAN_MODE_SELF_RECEPTION 2
#define VSCAN_MODE_NORMAL 0
#define VSCAN_MODE_LISTEN_ONLY 1
#define VSCAN_MODE_SELF_RECEPTION 2

// Speed
#define VSCAN_SPEED_1M (void*)8
#define VSCAN_SPEED_800K (void*)7
#define VSCAN_SPEED_500K (void*)6
#define VSCAN_SPEED_250K (void*)5
#define VSCAN_SPEED_125K (void*)4
#define VSCAN_SPEED_100K (void*)3
#define VSCAN_SPEED_50K (void*)2
#define VSCAN_SPEED_20K (void*)1
#define VSCAN_SPEED_1M (void*)8
#define VSCAN_SPEED_800K (void*)7
#define VSCAN_SPEED_500K (void*)6
#define VSCAN_SPEED_250K (void*)5
#define VSCAN_SPEED_125K (void*)4
#define VSCAN_SPEED_100K (void*)3
#define VSCAN_SPEED_50K (void*)2
#define VSCAN_SPEED_20K (void*)1
// generally not possible with the TJA1050
//#define VSCAN_SPEED_10K (void*)0
//#define VSCAN_SPEED_10K (void*)0

// Device Types
#define VSCAN_HWTYPE_UNKNOWN 0
#define VSCAN_HWTYPE_SERIAL 1
#define VSCAN_HWTYPE_USB 2
#define VSCAN_HWTYPE_NET 3
#define VSCAN_HWTYPE_BUS 4
#define VSCAN_HWTYPE_UNKNOWN 0
#define VSCAN_HWTYPE_SERIAL 1
#define VSCAN_HWTYPE_USB 2
#define VSCAN_HWTYPE_NET 3
#define VSCAN_HWTYPE_BUS 4

#define VSCAN_IOCTL_OFF (void*)0
#define VSCAN_IOCTL_ON (void*)1
#define VSCAN_IOCTL_OFF (void*)0
#define VSCAN_IOCTL_ON (void*)1

// Timestamp
#define VSCAN_TIMESTAMP_OFF VSCAN_IOCTL_OFF
#define VSCAN_TIMESTAMP_ON VSCAN_IOCTL_ON
#define VSCAN_TIMESTAMP_OFF VSCAN_IOCTL_OFF
#define VSCAN_TIMESTAMP_ON VSCAN_IOCTL_ON

// Filter Mode
#define VSCAN_FILTER_MODE_SINGLE (void*)1
#define VSCAN_FILTER_MODE_DUAL (void*)2
#define VSCAN_FILTER_MODE_SINGLE (void*)1
#define VSCAN_FILTER_MODE_DUAL (void*)2

// Ioctls
#define VSCAN_IOCTL_SET_DEBUG 1
#define VSCAN_IOCTL_GET_HWPARAM 2
#define VSCAN_IOCTL_SET_SPEED 3
#define VSCAN_IOCTL_SET_BTR 4
#define VSCAN_IOCTL_GET_FLAGS 5
#define VSCAN_IOCTL_SET_ACC_CODE_MASK 6
#define VSCAN_IOCTL_SET_TIMESTAMP 7
#define VSCAN_IOCTL_SET_DEBUG_MODE 8
#define VSCAN_IOCTL_SET_BLOCKING_READ 9
#define VSCAN_IOCTL_SET_FILTER_MODE 10
#define VSCAN_IOCTL_GET_API_VERSION 11
#define VSCAN_IOCTL_SET_DEBUG 1
#define VSCAN_IOCTL_GET_HWPARAM 2
#define VSCAN_IOCTL_SET_SPEED 3
#define VSCAN_IOCTL_SET_BTR 4
#define VSCAN_IOCTL_GET_FLAGS 5
#define VSCAN_IOCTL_SET_ACC_CODE_MASK 6
#define VSCAN_IOCTL_SET_TIMESTAMP 7
#define VSCAN_IOCTL_SET_DEBUG_MODE 8
#define VSCAN_IOCTL_SET_BLOCKING_READ 9
#define VSCAN_IOCTL_SET_FILTER_MODE 10
#define VSCAN_IOCTL_GET_API_VERSION 11

// Bits for VSCAN_IOCTL_GET_FLAGS
#define VSCAN_IOCTL_FLAG_RX_FIFO_FULL (1 << 0)
#define VSCAN_IOCTL_FLAG_TX_FIFO_FULL (1 << 1)
#define VSCAN_IOCTL_FLAG_ERR_WARNING (1 << 2)
#define VSCAN_IOCTL_FLAG_DATA_OVERRUN (1 << 3)
#define VSCAN_IOCTL_FLAG_UNUSED (1 << 4)
#define VSCAN_IOCTL_FLAG_ERR_PASSIVE (1 << 5)
#define VSCAN_IOCTL_FLAG_ARBIT_LOST (1 << 6)
#define VSCAN_IOCTL_FLAG_BUS_ERROR (1 << 7)
#define VSCAN_IOCTL_FLAG_API_RX_FIFO_FULL (1 << 16)
#define VSCAN_IOCTL_FLAG_RX_FIFO_FULL (1 << 0)
#define VSCAN_IOCTL_FLAG_TX_FIFO_FULL (1 << 1)
#define VSCAN_IOCTL_FLAG_ERR_WARNING (1 << 2)
#define VSCAN_IOCTL_FLAG_DATA_OVERRUN (1 << 3)
#define VSCAN_IOCTL_FLAG_UNUSED (1 << 4)
#define VSCAN_IOCTL_FLAG_ERR_PASSIVE (1 << 5)
#define VSCAN_IOCTL_FLAG_ARBIT_LOST (1 << 6)
#define VSCAN_IOCTL_FLAG_BUS_ERROR (1 << 7)
#define VSCAN_IOCTL_FLAG_API_RX_FIFO_FULL (1 << 16)

// Masks for VSCAN_IOCTL_SET_ACC_CODE_MASK
#define VSCAN_IOCTL_ACC_CODE_ALL 0x00000000
#define VSCAN_IOCTL_ACC_MASK_ALL 0xFFFFFFFF
#define VSCAN_IOCTL_ACC_CODE_ALL 0x00000000
#define VSCAN_IOCTL_ACC_MASK_ALL 0xFFFFFFFF

// Flags
#define VSCAN_FLAGS_STANDARD (1 << 0)
#define VSCAN_FLAGS_EXTENDED (1 << 1)
#define VSCAN_FLAGS_REMOTE (1 << 2)
#define VSCAN_FLAGS_TIMESTAMP (1 << 3)
#define VSCAN_FLAGS_STANDARD (1 << 0)
#define VSCAN_FLAGS_EXTENDED (1 << 1)
#define VSCAN_FLAGS_REMOTE (1 << 2)
#define VSCAN_FLAGS_TIMESTAMP (1 << 3)


#ifdef __cplusplus
extern "C" {
#endif

// If the function succeeds, the return value is greater zero (handle)
// If the function fails, the return value is one of VSCAN_STATUS
VSCAN_HANDLE VSCAN_Open(CHAR* SerialNrORComPortORNet, DWORD Mode);
// The return value is one of VSCAN_STATUS
VSCAN_STATUS VSCAN_Close(VSCAN_HANDLE Handle);
// The return value is one of VSCAN_STATUS
VSCAN_STATUS VSCAN_Ioctl(VSCAN_HANDLE Handle, DWORD Ioctl, VOID* Param);
// The return value is one of VSCAN_STATUS
VSCAN_STATUS VSCAN_Flush(VSCAN_HANDLE Handle);
// The return value is one of VSCAN_STATUS
VSCAN_STATUS VSCAN_Write(VSCAN_HANDLE Handle, VSCAN_MSG* Buf, DWORD Size, DWORD* Written);
// The return value is one of VSCAN_STATUS
VSCAN_STATUS VSCAN_Read(VSCAN_HANDLE Handle, VSCAN_MSG* Buf, DWORD Size, DWORD* Read);
// The return value is one of VSCAN_STATUS
// If the function succeeds, the return value is greater zero (handle)
// If the function fails, the return value is one of VSCAN_STATUS
VSCAN_HANDLE VSCAN_Open(CHAR *SerialNrORComPortORNet, DWORD Mode);
// The return value is one of VSCAN_STATUS
VSCAN_STATUS VSCAN_Close(VSCAN_HANDLE Handle);
// The return value is one of VSCAN_STATUS
VSCAN_STATUS VSCAN_Ioctl(VSCAN_HANDLE Handle, DWORD Ioctl, VOID *Param);
// The return value is one of VSCAN_STATUS
VSCAN_STATUS VSCAN_Flush(VSCAN_HANDLE Handle);
// The return value is one of VSCAN_STATUS
VSCAN_STATUS VSCAN_Write(VSCAN_HANDLE Handle, VSCAN_MSG *Buf, DWORD Size, DWORD *Written);
// The return value is one of VSCAN_STATUS
VSCAN_STATUS VSCAN_Read(VSCAN_HANDLE Handle, VSCAN_MSG *Buf, DWORD Size, DWORD *Read);
// The return value is one of VSCAN_STATUS
#ifdef WIN32
VSCAN_STATUS VSCAN_SetRcvEvent(VSCAN_HANDLE Handle, HANDLE Event);
VSCAN_STATUS VSCAN_SetRcvEvent(VSCAN_HANDLE Handle, HANDLE Event);
#else
VSCAN_STATUS VSCAN_SetRcvEvent(VSCAN_HANDLE Handle, sem_t* Event);
VSCAN_STATUS VSCAN_SetRcvEvent(VSCAN_HANDLE Handle, sem_t *Event);
#endif
// No return value for this function
VOID VSCAN_GetErrorString(VSCAN_STATUS Status, CHAR* String, DWORD MaxLen);
// No return value for this function
VOID VSCAN_GetErrorString(VSCAN_STATUS Status, CHAR *String, DWORD MaxLen);

#ifdef __cplusplus
}
#endif

#endif
Binary file modified Sources/CAN_VSCOM/EXTERNAL/vs_can_api.lib
View file
Binary file not shown.
Loading

0 comments on commit d968a71

Please sign in to comment.