PCBUSB.h

Go to the documentation of this file.

/* -- $HeadURL: https://svn.uv-software.net/MacCAN/PCANUSB/Library/trunk/drv/pcan_api.h $ --
 *
 *  project   :  CAN - Controller Area Network
 *
 *  purpose   :  PCAN Application Programming Interface
 *
 *  copyright :  (C) 2012-2024 by UV Software, Berlin
 *
 *  compiler  :  Apple clang version 15.0.0 (clang-1500.3.9.4)
 *
 *  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 (item no. IPEH-002021/002022)
 *  - PCAN-USB FD (item no. IPEH-004022)
 *  Up to 8 channel handles are supported.
 *
 *  Version of PCAN API:
 *  - Based on PEAK's version of 2024-01-26
 */
 
#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
 
/* Currently defined and supported PCAN channels
 */
#define PCAN_NONEBUS             0x00U  
 
#define PCAN_USBBUS1             0x51U  
#define PCAN_USBBUS2             0x52U  
#define PCAN_USBBUS3             0x53U  
#define PCAN_USBBUS4             0x54U  
#define PCAN_USBBUS5             0x55U  
#define PCAN_USBBUS6             0x56U  
#define PCAN_USBBUS7             0x57U  
#define PCAN_USBBUS8             0x58U  
#ifndef __APPLE__
#define PCAN_USBBUS9             0x509U 
#define PCAN_USBBUS10            0x50AU 
#define PCAN_USBBUS11            0x50BU 
#define PCAN_USBBUS12            0x50CU 
#define PCAN_USBBUS13            0x50DU 
#define PCAN_USBBUS14            0x50EU 
#define PCAN_USBBUS15            0x50FU 
#define PCAN_USBBUS16            0x510U 
#endif
 
 
/* Represent the PCAN error and status codes
 */
#define PCAN_ERROR_OK            0x00000U  
#define PCAN_ERROR_XMTFULL       0x00001U  
#define PCAN_ERROR_OVERRUN       0x00002U  
#define PCAN_ERROR_BUSLIGHT      0x00004U  
#define PCAN_ERROR_BUSHEAVY      0x00008U  
#define PCAN_ERROR_BUSWARNING    PCAN_ERROR_BUSHEAVY 
#define PCAN_ERROR_BUSPASSIVE    0x40000U  
#define PCAN_ERROR_BUSOFF        0x00010U  
#define PCAN_ERROR_ANYBUSERR     (PCAN_ERROR_BUSWARNING | PCAN_ERROR_BUSLIGHT | PCAN_ERROR_BUSHEAVY | PCAN_ERROR_BUSOFF | PCAN_ERROR_BUSPASSIVE) 
#define PCAN_ERROR_QRCVEMPTY     0x00020U  
#define PCAN_ERROR_QOVERRUN      0x00040U  
#define PCAN_ERROR_QXMTFULL      0x00080U  
#define PCAN_ERROR_REGTEST       0x00100U  
#define PCAN_ERROR_NODRIVER      0x00200U  
#define PCAN_ERROR_HWINUSE       0x00400U  
#define PCAN_ERROR_NETINUSE      0x00800U  
#define PCAN_ERROR_ILLHW         0x01400U  
#define PCAN_ERROR_ILLNET        0x01800U  
#define PCAN_ERROR_ILLCLIENT     0x01C00U  
#define PCAN_ERROR_ILLHANDLE     (PCAN_ERROR_ILLHW | PCAN_ERROR_ILLNET | PCAN_ERROR_ILLCLIENT)  
#define PCAN_ERROR_RESOURCE      0x02000U  
#define PCAN_ERROR_ILLPARAMTYPE  0x04000U  
#define PCAN_ERROR_ILLPARAMVAL   0x08000U  
#define PCAN_ERROR_UNKNOWN       0x10000U  
#define PCAN_ERROR_ILLDATA       0x20000U  
#define PCAN_ERROR_ILLMODE       0x80000U  
#define PCAN_ERROR_CAUTION       0x2000000U  
#define PCAN_ERROR_INITIALIZE    0x4000000U  
#define PCAN_ERROR_ILLOPERATION  0x8000000U  
 
/* PCAN devices
 */
#define PCAN_NONE                0x00U  
#define PCAN_PEAKCAN             0x01U  
#define PCAN_ISA                 0x02U  
#define PCAN_DNG                 0x03U  
#define PCAN_PCI                 0x04U  
#define PCAN_USB                 0x05U  
#define PCAN_PCC                 0x06U  
#define PCAN_VIRTUAL             0x07U  
#define PCAN_LAN                 0x08U  
 
/* PCAN parameters
 */
#define PCAN_DEVICE_ID           0x01U  
#define PCAN_5VOLTS_POWER        0x02U  
#define PCAN_RECEIVE_EVENT       0x03U  
#define PCAN_MESSAGE_FILTER      0x04U  
#define PCAN_API_VERSION         0x05U  
#define PCAN_CHANNEL_VERSION     0x06U  
#define PCAN_BUSOFF_AUTORESET    0x07U  
#define PCAN_LISTEN_ONLY         0x08U  
#define PCAN_LOG_LOCATION        0x09U  
#define PCAN_LOG_STATUS          0x0AU  
#define PCAN_LOG_CONFIGURE       0x0BU  
#define PCAN_LOG_TEXT            0x0CU  
#define PCAN_CHANNEL_CONDITION   0x0DU  
#define PCAN_HARDWARE_NAME       0x0EU  
#define PCAN_RECEIVE_STATUS      0x0FU  
#define PCAN_CONTROLLER_NUMBER   0x10U  
#define PCAN_TRACE_LOCATION      0x11U  
#define PCAN_TRACE_STATUS        0x12U  
#define PCAN_TRACE_SIZE          0x13U  
#define PCAN_TRACE_CONFIGURE     0x14U  
#define PCAN_CHANNEL_IDENTIFYING 0x15U  
#define PCAN_CHANNEL_FEATURES    0x16U  
#define PCAN_BITRATE_ADAPTING    0x17U  
#define PCAN_BITRATE_INFO        0x18U  
#define PCAN_BITRATE_INFO_FD     0x19U  
#define PCAN_BUSSPEED_NOMINAL    0x1AU  
#define PCAN_BUSSPEED_DATA       0x1BU  
#define PCAN_IP_ADDRESS          0x1CU  
#define PCAN_LAN_SERVICE_STATUS  0x1DU  
#define PCAN_ALLOW_STATUS_FRAMES 0x1EU  
#define PCAN_ALLOW_RTR_FRAMES    0x1FU  
#define PCAN_ALLOW_ERROR_FRAMES  0x20U  
#define PCAN_INTERFRAME_DELAY    0x21U  
#define PCAN_ACCEPTANCE_FILTER_11BIT 0x22U  
#define PCAN_ACCEPTANCE_FILTER_29BIT 0x23U  
#define PCAN_IO_DIGITAL_CONFIGURATION 0x24U 
#define PCAN_IO_DIGITAL_VALUE         0x25U 
#define PCAN_IO_DIGITAL_SET           0x26U 
#define PCAN_IO_DIGITAL_CLEAR         0x27U 
#define PCAN_IO_ANALOG_VALUE          0x28U 
#define PCAN_FIRMWARE_VERSION         0x29U 
#define PCAN_ATTACHED_CHANNELS_COUNT  0x2AU 
#define PCAN_ATTACHED_CHANNELS        0x2BU 
#define PCAN_ALLOW_ECHO_FRAMES        0x2CU 
#define PCAN_DEVICE_PART_NUMBER       0x2DU 
#define PCAN_HARD_RESET_STATUS        0x2EU 
#define PCAN_LAN_CHANNEL_DIRECTION    0x2FU 
#define PCAN_EXT_BTR0BTR1        0x80U  
#define PCAN_EXT_TX_COUNTER      0x81U  
#define PCAN_EXT_RX_COUNTER      0x82U  
#define PCAN_EXT_ERR_COUNTER     0x83U  
#define PCAN_EXT_RX_QUE_OVERRUN  0x84U  
#define PCAN_EXT_HARDWARE_VERSION 0x85U 
#define PCAN_EXT_SOFTWARE_VERSION 0x86U 
#define PCAN_EXT_RECEIVE_CALLBACK 0x87U 
#define PCAN_EXT_LOG_USB         0x8FU  
 
/* DEPRECATED parameters
 */
#define PCAN_DEVICE_NUMBER       PCAN_DEVICE_ID  
 
/* PCAN parameter values
 */
#define PCAN_PARAMETER_OFF       0x00U  
#define PCAN_PARAMETER_ON        0x01U  
#define PCAN_FILTER_CLOSE        0x00U  
#define PCAN_FILTER_OPEN         0x01U  
#define PCAN_FILTER_CUSTOM       0x02U  
#define PCAN_CHANNEL_UNAVAILABLE 0x00U  
#define PCAN_CHANNEL_AVAILABLE   0x01U  
#define PCAN_CHANNEL_OCCUPIED    0x02U  
#define PCAN_CHANNEL_PCANVIEW    (PCAN_CHANNEL_AVAILABLE |  PCAN_CHANNEL_OCCUPIED) 
 
#define LOG_FUNCTION_DEFAULT     0x00U    
#define LOG_FUNCTION_ENTRY       0x01U    
#define LOG_FUNCTION_PARAMETERS  0x02U    
#define LOG_FUNCTION_LEAVE       0x04U    
#define LOG_FUNCTION_WRITE       0x08U    
#define LOG_FUNCTION_READ        0x10U    
#define LOG_FUNCTION_ALL         0xFFFFU  
 
#define TRACE_FILE_SINGLE        0x00U  
#define TRACE_FILE_SEGMENTED     0x01U  
#define TRACE_FILE_DATE          0x02U  
#define TRACE_FILE_TIME          0x04U  
#define TRACE_FILE_OVERWRITE     0x80U  
#define TRACE_FILE_DATA_LENGTH   0x100U 
 
#define FEATURE_FD_CAPABLE       0x01U  
#define FEATURE_DELAY_CAPABLE    0x02U  
#define FEATURE_IO_CAPABLE       0x04U  
 
#define SERVICE_STATUS_STOPPED   0x01U  
#define SERVICE_STATUS_RUNNING   0x04U  
 
#define LAN_DIRECTION_READ       0x01U  
#define LAN_DIRECTION_WRITE      0x02U  
#define LAN_DIRECTION_READ_WRITE (LAN_DIRECTION_READ | LAN_DIRECTION_WRITE) // The PCAN-Channel communication is bidirectional 
 
/* Other constants
 */
#define MAX_LENGTH_HARDWARE_NAME   33   
#define MAX_LENGTH_VERSION_STRING  256  
 
/* PCAN message types
 */
#define PCAN_MESSAGE_STANDARD    0x00U  
#define PCAN_MESSAGE_RTR         0x01U  
#define PCAN_MESSAGE_EXTENDED    0x02U  
#define PCAN_MESSAGE_FD          0x04U  
#define PCAN_MESSAGE_BRS         0x08U  
#define PCAN_MESSAGE_ESI         0x10U  
#define PCAN_MESSAGE_ECHO        0x20U  
#define PCAN_MESSAGE_ERRFRAME    0x40U  
#define PCAN_MESSAGE_STATUS      0x80U  
 
/* LookUp Parameters
 */
#define LOOKUP_DEVICE_TYPE        __T("devicetype")       
#define LOOKUP_DEVICE_ID          __T("deviceid")         
#define LOOKUP_CONTROLLER_NUMBER  __T("controllernumber") 
#define LOOKUP_IP_ADDRESS         __T("ipaddress")        
 
/* 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  
#define PCAN_BAUD_800K           0x0016U  
#define PCAN_BAUD_500K           0x001CU  
#define PCAN_BAUD_250K           0x011CU  
#define PCAN_BAUD_125K           0x031CU  
#define PCAN_BAUD_100K           0x432FU  
#define PCAN_BAUD_95K            0xC34EU  
#define PCAN_BAUD_83K            0x852BU  
#define PCAN_BAUD_50K            0x472FU  
#define PCAN_BAUD_47K            0x1414U  
#define PCAN_BAUD_33K            0x8B2FU  
#define PCAN_BAUD_20K            0x532FU  
#define PCAN_BAUD_10K            0x672FU  
#define PCAN_BAUD_5K             0x7F7FU  
 
/* 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  
#define TPCANStatus              DWORD 
#define TPCANParameter           BYTE  
#define TPCANDevice              BYTE  
#define TPCANMessageType         BYTE  
#define TPCANType                BYTE  
#define TPCANMode                BYTE  
#define TPCANBaudrate            WORD  
#define TPCANBitrateFD           LPSTR 
#define TPCANTimestampFD         UINT64
 
 
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/
 */