PCBUSB.h

Go to the documentation of this file.

/* -- $HeadURL: https://uv-software.net/MacCAN/PCANUSB/Library/trunk/drv/pcan_api.h $ --
 *
 *  project   :  CAN - Controller Area Network
 *
 *  purpose   :  PCAN Application Programming Interface
 *
 *  copyright :  (C) 2012-2023 by UV Software, Berlin
 *
 *  compiler  :  Apple clang version 14.0.0 (clang-1400.0.29.202)
 *
 *  export    :  TPCANStatus CAN_Initialize(TPCANHandle Channel, TPCANBaudrate Btr0Btr1, TPCANType HwType, DWORD IOPort, WORD Interrupt);
 *               TPCANStatus CAN_Uninitialize(TPCANHandle Channel);
 *               TPCANStatus CAN_Reset(TPCANHandle Channel);
 *               TPCANStatus CAN_GetStatus(TPCANHandle Channel);
 *               TPCANStatus CAN_Read(TPCANHandle Channel, TPCANMsg* MessageBuffer, TPCANTimestamp* TimestampBuffer);
 *               TPCANStatus CAN_Write(TPCANHandle Channel, TPCANMsg* MessageBuffer);
 *               TPCANStatus CAN_FilterMessages(TPCANHandle Channel, DWORD FromID, DWORD ToID, TPCANMode Mode);
 *               TPCANStatus CAN_GetValue(TPCANHandle Channel, TPCANParameter Parameter, void* Buffer, DWORD BufferLength);
 *               TPCANStatus CAN_SetValue(TPCANHandle Channel, TPCANParameter Parameter, void* Buffer, DWORD BufferLength);
 *               TPCANStatus CAN_GetErrorText(TPCANStatus Error, WORD Language, LPSTR Buffer);
 *               *** CAN FD capable devices ***
 *               TPCANStatus CAN_InitializeFD(TPCANHandle Channel, TPCANBitrateFD BitrateFD);
 *               TPCANStatus CAN_ReadFD(TPCANHandle Channel, TPCANMsgFD* MessageBuffer, TPCANTimestampFD* TimestampBuffer);
 *               TPCANStatus CAN_WriteFD(TPCANHandle Channel, TPCANMsgFD* MessageBuffer);
 *
 *  includes  :  (none)
 *
 *  author    :  Uwe Vogt, UV Software
 *
 *  e-mail    :  uwe.vogt@uv-software.de
 *
 *
 *  -----------  description  --------------------------------------------
 *
 *  PCAN API  -  PEAK CAN Application Programming Interface
 *
 *  This Application Programming Interface (API) is an almost compatible
 *  implementation of the PEAK PCANBasic DLL on macOS (x86_64 and arm64).
 *
 *  Supported CAN Interfaces:
 *  - PCAN-USB
 *  - PCAN-USB FD
 *  Up to 8 devices are supported.
 *
 *  Version of PCAN API:
 *  - Based on PEAK's version of 2022-07-06
 */

#ifndef PCAN_API_H_INCLUDED
#define PCAN_API_H_INCLUDED

/*  -----------  includes  -----------------------------------------------
 */

#ifdef __APPLE__
#include <MacTypes.h>                   // To map Windows integer types
#endif

/*  -----------  defines  ------------------------------------------------
 */

#ifdef __APPLE__
#ifndef BYTE
#define BYTE    UInt8
#endif
#ifndef WORD
#define WORD    UInt16
#endif
#ifndef DWORD
#define DWORD   UInt32
#endif
#ifndef UINT64
#define UINT64  UInt64
#endif
#ifndef LPSTR
#define LPSTR   char*
#endif
#define __T(s)  s
#endif

/* Defined and supported PCAN channels
 */
#define PCAN_NONEBUS             0x00U  //!< Undefined/default value for a PCAN bus

#define PCAN_USBBUS1             0x51U  //!< PCAN-USB interface, channel 1
#define PCAN_USBBUS2             0x52U  //!< PCAN-USB interface, channel 2
#define PCAN_USBBUS3             0x53U  //!< PCAN-USB interface, channel 3
#define PCAN_USBBUS4             0x54U  //!< PCAN-USB interface, channel 4
#define PCAN_USBBUS5             0x55U  //!< PCAN-USB interface, channel 5
#define PCAN_USBBUS6             0x56U  //!< PCAN-USB interface, channel 6
#define PCAN_USBBUS7             0x57U  //!< PCAN-USB interface, channel 7
#define PCAN_USBBUS8             0x58U  //!< PCAN-USB interface, channel 8
#ifndef __APPLE__
#define PCAN_USBBUS9             0x509U //!< PCAN-USB interface, channel 9
#define PCAN_USBBUS10            0x50AU //!< PCAN-USB interface, channel 10
#define PCAN_USBBUS11            0x50BU //!< PCAN-USB interface, channel 11
#define PCAN_USBBUS12            0x50CU //!< PCAN-USB interface, channel 12
#define PCAN_USBBUS13            0x50DU //!< PCAN-USB interface, channel 13
#define PCAN_USBBUS14            0x50EU //!< PCAN-USB interface, channel 14
#define PCAN_USBBUS15            0x50FU //!< PCAN-USB interface, channel 15
#define PCAN_USBBUS16            0x510U //!< PCAN-USB interface, channel 16
#endif


/* PCAN error and status codes
 */
#define PCAN_ERROR_OK            0x00000U  //!< No error
#define PCAN_ERROR_XMTFULL       0x00001U  //!< Transmit buffer in CAN controller is full
#define PCAN_ERROR_OVERRUN       0x00002U  //!< CAN controller was read too late
#define PCAN_ERROR_BUSLIGHT      0x00004U  //!< Bus error: an error counter reached the 'light' limit
#define PCAN_ERROR_BUSHEAVY      0x00008U  //!< Bus error: an error counter reached the 'heavy' limit
#define PCAN_ERROR_BUSWARNING    PCAN_ERROR_BUSHEAVY //!< Bus error: an error counter reached the 'warning' limit
#define PCAN_ERROR_BUSPASSIVE    0x40000U  //!< Bus error: the CAN controller is error passive
#define PCAN_ERROR_BUSOFF        0x00010U  //!< Bus error: the CAN controller is in bus-off state
#define PCAN_ERROR_ANYBUSERR     (PCAN_ERROR_BUSWARNING | PCAN_ERROR_BUSLIGHT | PCAN_ERROR_BUSHEAVY | PCAN_ERROR_BUSOFF | PCAN_ERROR_BUSPASSIVE) //!< Mask for all bus errors
#define PCAN_ERROR_QRCVEMPTY     0x00020U  //!< Receive queue is empty
#define PCAN_ERROR_QOVERRUN      0x00040U  //!< Receive queue was read too late
#define PCAN_ERROR_QXMTFULL      0x00080U  //!< Transmit queue is full
#define PCAN_ERROR_REGTEST       0x00100U  //!< Test of the CAN controller hardware registers failed (no hardware found)
#define PCAN_ERROR_NODRIVER      0x00200U  //!< Driver not loaded
#define PCAN_ERROR_HWINUSE       0x00400U  //!< Hardware already in use by a Net
#define PCAN_ERROR_NETINUSE      0x00800U  //!< A Client is already connected to the Net
#define PCAN_ERROR_ILLHW         0x01400U  //!< Hardware handle is invalid
#define PCAN_ERROR_ILLNET        0x01800U  //!< Net handle is invalid
#define PCAN_ERROR_ILLCLIENT     0x01C00U  //!< Client handle is invalid
#define PCAN_ERROR_ILLHANDLE     (PCAN_ERROR_ILLHW | PCAN_ERROR_ILLNET | PCAN_ERROR_ILLCLIENT)  //!< Mask for all handle errors
#define PCAN_ERROR_RESOURCE      0x02000U  //!< Resource (FIFO, Client, timeout) cannot be created
#define PCAN_ERROR_ILLPARAMTYPE  0x04000U  //!< Invalid parameter
#define PCAN_ERROR_ILLPARAMVAL   0x08000U  //!< Invalid parameter value
#define PCAN_ERROR_UNKNOWN       0x10000U  //!< Unknown error
#define PCAN_ERROR_ILLDATA       0x20000U  //!< Invalid data, function, or action
#define PCAN_ERROR_ILLMODE       0x80000U  //!< Driver object state is wrong for the attempted operation
#define PCAN_ERROR_CAUTION       0x2000000U  //!< An operation was successfully carried out, however, irregularities were registered
#define PCAN_ERROR_INITIALIZE    0x4000000U  //!< Channel is not initialized [Value was changed from 0x40000 to 0x4000000]
#define PCAN_ERROR_ILLOPERATION  0x8000000U  //!< Invalid operation [Value was changed from 0x80000 to 0x8000000]

/* PCAN devices
 */
#define PCAN_NONE                0x00U  //!< Undefined, unknown or not selected PCAN device value
#define PCAN_PEAKCAN             0x01U  //!< PCAN Non-PnP devices. NOT USED WITHIN PCAN-Basic API
#define PCAN_ISA                 0x02U  //!< PCAN-ISA, PCAN-PC/104, and PCAN-PC/104-Plus
#define PCAN_DNG                 0x03U  //!< PCAN-Dongle
#define PCAN_PCI                 0x04U  //!< PCAN-PCI, PCAN-cPCI, PCAN-miniPCI, and PCAN-PCI Express
#define PCAN_USB                 0x05U  //!< PCAN-USB and PCAN-USB Pro
#define PCAN_PCC                 0x06U  //!< PCAN-PC Card
#define PCAN_VIRTUAL             0x07U  //!< PCAN Virtual hardware. NOT USED WITHIN PCAN-Basic API
#define PCAN_LAN                 0x08U  //!< PCAN Gateway devices

/* PCAN parameters
 */
#define PCAN_DEVICE_ID           0x01U  //!< Device identifier parameter
#define PCAN_5VOLTS_POWER        0x02U  //!< 5-Volt power parameter
#define PCAN_RECEIVE_EVENT       0x03U  //!< PCAN receive event handler parameter
#define PCAN_MESSAGE_FILTER      0x04U  //!< PCAN message filter parameter
#define PCAN_API_VERSION         0x05U  //!< PCAN-Basic API version parameter
#define PCAN_CHANNEL_VERSION     0x06U  //!< PCAN device channel version parameter
#define PCAN_BUSOFF_AUTORESET    0x07U  //!< PCAN Reset-On-Busoff parameter
#define PCAN_LISTEN_ONLY         0x08U  //!< PCAN Listen-Only parameter
#define PCAN_LOG_LOCATION        0x09U  //!< Directory path for log files
#define PCAN_LOG_STATUS          0x0AU  //!< Debug-Log activation status
#define PCAN_LOG_CONFIGURE       0x0BU  //!< Configuration of the debugged information (LOG_FUNCTION_***)
#define PCAN_LOG_TEXT            0x0CU  //!< Custom insertion of text into the log file
#define PCAN_CHANNEL_CONDITION   0x0DU  //!< Availability status of a PCAN-Channel
#define PCAN_HARDWARE_NAME       0x0EU  //!< PCAN hardware name parameter
#define PCAN_RECEIVE_STATUS      0x0FU  //!< Message reception status of a PCAN-Channel
#define PCAN_CONTROLLER_NUMBER   0x10U  //!< CAN-Controller number of a PCAN-Channel
#define PCAN_TRACE_LOCATION      0x11U  //!< Directory path for PCAN trace files
#define PCAN_TRACE_STATUS        0x12U  //!< CAN tracing activation status
#define PCAN_TRACE_SIZE          0x13U  //!< Configuration of the maximum file size of a CAN trace
#define PCAN_TRACE_CONFIGURE     0x14U  //!< Configuration of the trace file storing mode (TRACE_FILE_***)
#define PCAN_CHANNEL_IDENTIFYING 0x15U  //!< Physical identification of a USB based PCAN-Channel by blinking its associated LED
#define PCAN_CHANNEL_FEATURES    0x16U  //!< Capabilities of a PCAN device (FEATURE_***)
#define PCAN_BITRATE_ADAPTING    0x17U  //!< Using of an existing bit rate (PCAN-View connected to a channel)
#define PCAN_BITRATE_INFO        0x18U  //!< Configured bit rate as Btr0Btr1 value
#define PCAN_BITRATE_INFO_FD     0x19U  //!< Configured bit rate as TPCANBitrateFD string
#define PCAN_BUSSPEED_NOMINAL    0x1AU  //!< Configured nominal CAN Bus speed as Bits per seconds
#define PCAN_BUSSPEED_DATA       0x1BU  //!< Configured CAN data speed as Bits per seconds
#define PCAN_IP_ADDRESS          0x1CU  //!< Remote address of a LAN channel as string in IPv4 format
#define PCAN_LAN_SERVICE_STATUS  0x1DU  //!< Status of the Virtual PCAN-Gateway Service
#define PCAN_ALLOW_STATUS_FRAMES 0x1EU  //!< Status messages reception status within a PCAN-Channel
#define PCAN_ALLOW_RTR_FRAMES    0x1FU  //!< RTR messages reception status within a PCAN-Channel
#define PCAN_ALLOW_ERROR_FRAMES  0x20U  //!< Error messages reception status within a PCAN-Channel
#define PCAN_INTERFRAME_DELAY    0x21U  //!< Delay, in microseconds, between sending frames
#define PCAN_ACCEPTANCE_FILTER_11BIT 0x22U  //!< Filter over code and mask patterns for 11-Bit messages
#define PCAN_ACCEPTANCE_FILTER_29BIT 0x23U  //!< Filter over code and mask patterns for 29-Bit messages
#define PCAN_IO_DIGITAL_CONFIGURATION 0x24U //!< Output mode of 32 digital I/O pin of a PCAN-USB Chip. 1: Output-Active 0 : Output Inactive
#define PCAN_IO_DIGITAL_VALUE         0x25U //!< Value assigned to a 32 digital I/O pins of a PCAN-USB Chip
#define PCAN_IO_DIGITAL_SET           0x26U //!< Value assigned to a 32 digital I/O pins of a PCAN-USB Chip - Multiple digital I/O pins to 1 = High
#define PCAN_IO_DIGITAL_CLEAR         0x27U //!< Clear multiple digital I/O pins to 0
#define PCAN_IO_ANALOG_VALUE          0x28U //!< Get value of a single analog input pin
#define PCAN_FIRMWARE_VERSION         0x29U //!< Get the version of the firmware used by the device associated with a PCAN-Channel
#define PCAN_ATTACHED_CHANNELS_COUNT  0x2AU //!< Get the amount of PCAN channels attached to a system
#define PCAN_ATTACHED_CHANNELS        0x2BU //!< Get information about PCAN channels attached to a system
#define PCAN_ALLOW_ECHO_FRAMES        0x2CU //!< Echo messages reception status within a PCAN-Channel
#define PCAN_DEVICE_PART_NUMBER       0x2DU //!< Get the part number associated to a device
#define PCAN_EXT_BTR0BTR1        0x80U  //!< UVS: bit-timing register
#define PCAN_EXT_TX_COUNTER      0x81U  //!< UVS: number of transmitted frames
#define PCAN_EXT_RX_COUNTER      0x82U  //!< UVS: number of received frames
#define PCAN_EXT_ERR_COUNTER     0x83U  //!< UVS: number of error frames
#define PCAN_EXT_RX_QUE_OVERRUN  0x84U  //!< UVS: receive queue overrun counter
#define PCAN_EXT_HARDWARE_VERSION 0x85U //!< UVS: version number of the interface firmware
#define PCAN_EXT_SOFTWARE_VERSION 0x86U //!< UVS: version number of the driver respectively library
#define PCAN_EXT_RECEIVE_CALLBACK 0x87U //!< UVS: callback function called on the reception of an URB
#define PCAN_EXT_LOG_USB         0x8FU  //!< UVS: Log USB communication (URB buffer <==> CAN messages)

/* DEPRECATED parameters
 */
#define PCAN_DEVICE_NUMBER       PCAN_DEVICE_ID  //!< Deprecated parameter. Use PCAN_DEVICE_ID instead

/* PCAN parameter values
 */
#define PCAN_PARAMETER_OFF       0x00U  //!< The PCAN parameter is not set (inactive)
#define PCAN_PARAMETER_ON        0x01U  //!< The PCAN parameter is set (active)
#define PCAN_FILTER_CLOSE        0x00U  //!< The PCAN filter is closed. No messages will be received
#define PCAN_FILTER_OPEN         0x01U  //!< The PCAN filter is fully opened. All messages will be received
#define PCAN_FILTER_CUSTOM       0x02U  //!< The PCAN filter is custom configured. Only registered messages will be received
#define PCAN_CHANNEL_UNAVAILABLE 0x00U  //!< The PCAN-Channel handle is illegal, or its associated hardware is not available
#define PCAN_CHANNEL_AVAILABLE   0x01U  //!< The PCAN-Channel handle is available to be connected (PnP Hardware: it means furthermore that the hardware is plugged-in)
#define PCAN_CHANNEL_OCCUPIED    0x02U  //!< The PCAN-Channel handle is valid, and is already being used
#define PCAN_CHANNEL_PCANVIEW    (PCAN_CHANNEL_AVAILABLE |  PCAN_CHANNEL_OCCUPIED) //!< The PCAN-Channel handle is already being used by a PCAN-View application, but is available to connect

#define LOG_FUNCTION_DEFAULT     0x00U    //!< Logs system exceptions / errors
#define LOG_FUNCTION_ENTRY       0x01U    //!< Logs the entries to the PCAN-Basic API functions
#define LOG_FUNCTION_PARAMETERS  0x02U    //!< Logs the parameters passed to the PCAN-Basic API functions
#define LOG_FUNCTION_LEAVE       0x04U    //!< Logs the exits from the PCAN-Basic API functions
#define LOG_FUNCTION_WRITE       0x08U    //!< Logs the CAN messages passed to the CAN_Write function
#define LOG_FUNCTION_READ        0x10U    //!< Logs the CAN messages received within the CAN_Read function
#define LOG_FUNCTION_ALL         0xFFFFU  //!< Logs all possible information within the PCAN-Basic API functions

#define TRACE_FILE_SINGLE        0x00U  //!< A single file is written until it size reaches PAN_TRACE_SIZE
#define TRACE_FILE_SEGMENTED     0x01U  //!< Traced data is distributed in several files with size PAN_TRACE_SIZE
#define TRACE_FILE_DATE          0x02U  //!< Includes the date into the name of the trace file
#define TRACE_FILE_TIME          0x04U  //!< Includes the start time into the name of the trace file
#define TRACE_FILE_OVERWRITE     0x80U  //!< Causes the overwriting of available traces (same name)

#define FEATURE_FD_CAPABLE       0x01U  //!< Device supports flexible data-rate (CAN-FD)
#define FEATURE_DELAY_CAPABLE    0x02U  //!< Device supports a delay between sending frames (FPGA based USB devices)
#define FEATURE_IO_CAPABLE       0x04U  //!< Device supports I/O functionality for electronic circuits (USB-Chip devices)

#define SERVICE_STATUS_STOPPED   0x01U  //!< The service is not running
#define SERVICE_STATUS_RUNNING   0x04U  //!< The service is running

/* Other constants
 */
#define MAX_LENGTH_HARDWARE_NAME   33   //!< Maximum length of the name of a device: 32 characters + terminator
#define MAX_LENGTH_VERSION_STRING  256  //!< Maximum length of a version string: 17 characters + terminator

/* PCAN message types
 */
#define PCAN_MESSAGE_STANDARD    0x00U  //!< The PCAN message is a CAN Standard Frame (11-bit identifier)
#define PCAN_MESSAGE_RTR         0x01U  //!< The PCAN message is a CAN Remote-Transfer-Request Frame
#define PCAN_MESSAGE_EXTENDED    0x02U  //!< The PCAN message is a CAN Extended Frame (29-bit identifier)
#define PCAN_MESSAGE_FD          0x04U  //!< The PCAN message represents a FD frame in terms of CiA Specs
#define PCAN_MESSAGE_BRS         0x08U  //!< The PCAN message represents a FD bit rate switch (CAN data at a higher bit rate)
#define PCAN_MESSAGE_ESI         0x10U  //!< The PCAN message represents a FD error state indicator(CAN FD transmitter was error active)
#define PCAN_MESSAGE_ECHO        0x20U  //!< The PCAN message represents an echo CAN Frame
#define PCAN_MESSAGE_ERRFRAME    0x40U  //!< The PCAN message represents an error frame
#define PCAN_MESSAGE_STATUS      0x80U  //!< The PCAN message represents a PCAN status message

/* LookUp Parameters
 */
#define LOOKUP_DEVICE_TYPE        __T("devicetype")       //!< Lookup channel by Device type (see PCAN devices e.g. PCAN_USB)
#define LOOKUP_DEVICE_ID          __T("deviceid")         //!< Lookup channel by device id
#define LOOKUP_CONTROLLER_NUMBER  __T("controllernumber") //!< Lookup channel by CAN controller 0-based index
#define LOOKUP_IP_ADDRESS         __T("ipaddress")        //!< Lookup channel by IP address (LAN channels only)

/* Frame Type / Initialization Mode
 */
#define PCAN_MODE_STANDARD       PCAN_MESSAGE_STANDARD
#define PCAN_MODE_EXTENDED       PCAN_MESSAGE_EXTENDED

/* Baud rate codes = BTR0/BTR1 register values for the CAN controller.
 * You can define your own Baud rate with the BTROBTR1 register.
 * Take a look at www.peak-system.com for their free software "BAUDTOOL"
 * to calculate the BTROBTR1 register for every bit rate and sample point.
 */
#define PCAN_BAUD_1M             0x0014U  //!<   1 MBit/s
#define PCAN_BAUD_800K           0x0016U  //!< 800 kBit/s
#define PCAN_BAUD_500K           0x001CU  //!< 500 kBit/s
#define PCAN_BAUD_250K           0x011CU  //!< 250 kBit/s
#define PCAN_BAUD_125K           0x031CU  //!< 125 kBit/s
#define PCAN_BAUD_100K           0x432FU  //!< 100 kBit/s
#define PCAN_BAUD_95K            0xC34EU  //!<  95,238 kBit/s
#define PCAN_BAUD_83K            0x852BU  //!<  83,333 kBit/s
#define PCAN_BAUD_50K            0x472FU  //!<  50 kBit/s
#define PCAN_BAUD_47K            0x1414U  //!<  47,619 kBit/s
#define PCAN_BAUD_33K            0x8B2FU  //!<  33,333 kBit/s
#define PCAN_BAUD_20K            0x532FU  //!<  20 kBit/s
#define PCAN_BAUD_10K            0x672FU  //!<  10 kBit/s
#define PCAN_BAUD_5K             0x7F7FU  //!<   5 kBit/s

/* Represents the configuration for a CAN bit rate
 * Note:
 *    * Each parameter and its value must be separated with a '='.
 *    * Each pair of parameter/value must be separated using ','.
 *
 * Example:
 *    f_clock=80000000,nom_brp=10,nom_tseg1=5,nom_tseg2=2,nom_sjw=1,data_brp=4,data_tseg1=7,data_tseg2=2,data_sjw=1
 */
#define PCAN_BR_CLOCK            __T("f_clock")
#define PCAN_BR_CLOCK_MHZ        __T("f_clock_mhz")
#define PCAN_BR_NOM_BRP          __T("nom_brp")
#define PCAN_BR_NOM_TSEG1        __T("nom_tseg1")
#define PCAN_BR_NOM_TSEG2        __T("nom_tseg2")
#define PCAN_BR_NOM_SJW          __T("nom_sjw")
#define PCAN_BR_NOM_SAMPLE       __T("nom_sam")
#define PCAN_BR_DATA_BRP         __T("data_brp")
#define PCAN_BR_DATA_TSEG1       __T("data_tseg1")
#define PCAN_BR_DATA_TSEG2       __T("data_tseg2")
#define PCAN_BR_DATA_SJW         __T("data_sjw")
#define PCAN_BR_DATA_SAMPLE      __T("data_ssp_offset")

/*  -----------  types  --------------------------------------------------
 */

#define TPCANHandle              WORD  //!< PCAN hardware channel handle
#define TPCANStatus              DWORD //!< PCAN status/error code (ATTENTION: changed from 64-bit to 32-bit)
#define TPCANParameter           BYTE  //!< PCAN parameter to be read or set
#define TPCANDevice              BYTE  //!< PCAN device
#define TPCANMessageType         BYTE  //!< The type of a PCAN message
#define TPCANType                BYTE  //!< The type of PCAN hardware to be initialized
#define TPCANMode                BYTE  //!< PCAN filter mode
#define TPCANBaudrate            WORD  //!< PCAN Baud rate register value
#define TPCANBitrateFD           LPSTR //!< PCAN-FD bit rate string
#define TPCANTimestampFD         UINT64//!< timestamp of a received PCAN FD message

typedef struct tagTPCANMsg
{
    DWORD             ID;      
    TPCANMessageType  MSGTYPE; 
    BYTE              LEN;     
    BYTE              DATA[8]; 
} TPCANMsg;

typedef struct tagTPCANTimestamp
{
    DWORD  millis;             
    WORD   millis_overflow;    
    WORD   micros;             
} TPCANTimestamp;

typedef struct tagTPCANMsgFD
{
    DWORD             ID;      
    TPCANMessageType  MSGTYPE; 
    BYTE              DLC;     
    BYTE              DATA[64];
} TPCANMsgFD;

typedef struct tagTPCANChannelInformation
{
    TPCANHandle channel_handle;                 
    TPCANDevice device_type;                    
    BYTE controller_number;                     
    DWORD device_features;                      
    char device_name[MAX_LENGTH_HARDWARE_NAME]; 
    DWORD device_id;                            
    DWORD channel_condition;                    
}TPCANChannelInformation;


/*  -----------  variables  ----------------------------------------------
 */


/*  -----------  prototypes  ---------------------------------------------
 */

#ifdef __cplusplus
extern "C" {
#define _DEF_ARG =0
#else
#define _DEF_ARG
#endif

TPCANStatus CAN_Initialize(
        TPCANHandle Channel,
        TPCANBaudrate Btr0Btr1,
        TPCANType HwType _DEF_ARG,
        DWORD IOPort _DEF_ARG,
        WORD Interrupt _DEF_ARG);

TPCANStatus CAN_InitializeFD(
        TPCANHandle Channel,
        TPCANBitrateFD BitrateFD);

TPCANStatus CAN_Uninitialize(
        TPCANHandle Channel);

TPCANStatus CAN_Reset(
        TPCANHandle Channel);

TPCANStatus CAN_GetStatus(
        TPCANHandle Channel);

TPCANStatus CAN_Read(
        TPCANHandle Channel,
        TPCANMsg* MessageBuffer,
        TPCANTimestamp* TimestampBuffer);

TPCANStatus CAN_ReadFD(
        TPCANHandle Channel,
        TPCANMsgFD* MessageBuffer,
        TPCANTimestampFD* TimestampBuffer);

TPCANStatus CAN_Write(
        TPCANHandle Channel,
        TPCANMsg* MessageBuffer);

TPCANStatus CAN_WriteFD(
        TPCANHandle Channel,
        TPCANMsgFD* MessageBuffer);

TPCANStatus CAN_FilterMessages(
        TPCANHandle Channel,
        DWORD FromID,
        DWORD ToID,
        TPCANMode Mode);

TPCANStatus CAN_GetValue(
        TPCANHandle Channel,
        TPCANParameter Parameter,
        void* Buffer,
        DWORD BufferLength);


TPCANStatus CAN_SetValue(
        TPCANHandle Channel,
        TPCANParameter Parameter,
        void* Buffer,
        DWORD BufferLength);

TPCANStatus CAN_GetErrorText(
        TPCANStatus Error,
        WORD Language,
        LPSTR Buffer);

TPCANStatus CAN_LookUpChannel(
        LPSTR Parameters,
        TPCANHandle* FoundChannel);

#ifdef __cplusplus
}
#endif
#endif  /* PCAN_API_H_INCLUDED */

/*  ----------------------------------------------------------------------
 *  Uwe Vogt,  UV Software,  Chausseestrasse 33 A,  10115 Berlin,  Germany
 *  Tel.: +49-30-46799872,  Fax: +49-30-46799873,  Mobile: +49-170-3801903
 *  E-Mail: uwe.vogt@uv-software.de,  Homepage: http://www.uv-software.de/
 */