diff options
author | Denis Shienkov <denis.shienkov@gmail.com> | 2016-05-11 19:00:05 +0300 |
---|---|---|
committer | Denis Shienkov <denis.shienkov@gmail.com> | 2016-07-01 12:31:53 +0000 |
commit | 5b9eb2bed65d97fd74f73012697d58c2e6d932d8 (patch) | |
tree | d900520f9ba1370ca6bcd8a77883021a0c8d6e7b /src/plugins/canbus/vectorcan | |
parent | b9a300b214f1c79dfed382403ae31f4bc0a8d52a (diff) |
CAN: Add base support for the Vector CAN devices
Current features and restrictions:
* The Vector CAN API supports the CAN FD feature, but it is not implemented yet in this backend.
* Seems, the Vector CAN API provides only for Windows.
* This backend implements only the BitRate configurations yet.
Detailed information can be found on http://vector.com/.
Tested on Windows with the USB Vector CANcaseXL adapter with pair of
the USB TinyCAN adapter.
Change-Id: I86ebd7c6436badff8317356f47957cfe06b67387
Reviewed-by: André Hartmann <aha_1980@gmx.de>
Reviewed-by: Alex Blasche <alexander.blasche@theqtcompany.com>
Diffstat (limited to 'src/plugins/canbus/vectorcan')
-rw-r--r-- | src/plugins/canbus/vectorcan/main.cpp | 69 | ||||
-rw-r--r-- | src/plugins/canbus/vectorcan/plugin.json | 3 | ||||
-rw-r--r-- | src/plugins/canbus/vectorcan/vectorcan.pro | 19 | ||||
-rw-r--r-- | src/plugins/canbus/vectorcan/vectorcan_symbols_p.h | 495 | ||||
-rw-r--r-- | src/plugins/canbus/vectorcan/vectorcanbackend.cpp | 492 | ||||
-rw-r--r-- | src/plugins/canbus/vectorcan/vectorcanbackend.h | 77 | ||||
-rw-r--r-- | src/plugins/canbus/vectorcan/vectorcanbackend_p.h | 94 |
7 files changed, 1249 insertions, 0 deletions
diff --git a/src/plugins/canbus/vectorcan/main.cpp b/src/plugins/canbus/vectorcan/main.cpp new file mode 100644 index 0000000..fd54d86 --- /dev/null +++ b/src/plugins/canbus/vectorcan/main.cpp @@ -0,0 +1,69 @@ +/**************************************************************************** +** +** Copyright (C) 2016 Denis Shienkov <denis.shienkov@gmail.com> +** Contact: http://www.qt.io/licensing/ +** +** This file is part of the QtSerialBus module of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL3$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see http://www.qt.io/terms-conditions. For further +** information use the contact form at http://www.qt.io/contact-us. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 3 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPLv3 included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 3 requirements +** will be met: https://www.gnu.org/licenses/lgpl.html. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 2.0 or later as published by the Free +** Software Foundation and appearing in the file LICENSE.GPL included in +** the packaging of this file. Please review the following information to +** ensure the GNU General Public License version 2.0 requirements will be +** met: http://www.gnu.org/licenses/gpl-2.0.html. +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#include "vectorcanbackend.h" + +#include <QtSerialBus/qcanbus.h> +#include <QtSerialBus/qcanbusdevice.h> +#include <QtSerialBus/qcanbusfactory.h> + +QT_BEGIN_NAMESPACE + +class VectorCanBusPlugin : public QObject, public QCanBusFactory +{ + Q_OBJECT + Q_PLUGIN_METADATA(IID "org.qt-project.Qt.QCanBusFactory" FILE "plugin.json") + Q_INTERFACES(QCanBusFactory) + +public: + QCanBusDevice *createDevice(const QString &interfaceName, QString *errorMessage) const + { + QString errorReason; + if (!VectorCanBackend::canCreate(&errorReason)) { + qWarning("%s", qPrintable(errorReason)); + if (errorMessage) + *errorMessage = errorReason; + return nullptr; + } + + auto device = new VectorCanBackend(interfaceName); + return device; + } +}; + +QT_END_NAMESPACE + +#include "main.moc" diff --git a/src/plugins/canbus/vectorcan/plugin.json b/src/plugins/canbus/vectorcan/plugin.json new file mode 100644 index 0000000..de0002c --- /dev/null +++ b/src/plugins/canbus/vectorcan/plugin.json @@ -0,0 +1,3 @@ +{ + "Key": "vectorcan" +} diff --git a/src/plugins/canbus/vectorcan/vectorcan.pro b/src/plugins/canbus/vectorcan/vectorcan.pro new file mode 100644 index 0000000..a43c061 --- /dev/null +++ b/src/plugins/canbus/vectorcan/vectorcan.pro @@ -0,0 +1,19 @@ +TARGET = qtvectorcanbus + +QT = core-private serialbus + +HEADERS += \ + vectorcanbackend.h \ + vectorcanbackend_p.h \ + vectorcan_symbols_p.h + +SOURCES += \ + main.cpp \ + vectorcanbackend.cpp + +DISTFILES = plugin.json + +PLUGIN_TYPE = canbus +PLUGIN_EXTENDS = serialbus +PLUGIN_CLASS_NAME = VectorCanBusPlugin +load(qt_plugin) diff --git a/src/plugins/canbus/vectorcan/vectorcan_symbols_p.h b/src/plugins/canbus/vectorcan/vectorcan_symbols_p.h new file mode 100644 index 0000000..6f548b0 --- /dev/null +++ b/src/plugins/canbus/vectorcan/vectorcan_symbols_p.h @@ -0,0 +1,495 @@ +/**************************************************************************** +** +** Copyright (C) 2016 Denis Shienkov <denis.shienkov@gmail.com> +** Contact: http://www.qt.io/licensing/ +** +** This file is part of the QtSerialBus module of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL3$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see http://www.qt.io/terms-conditions. For further +** information use the contact form at http://www.qt.io/contact-us. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 3 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPLv3 included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 3 requirements +** will be met: https://www.gnu.org/licenses/lgpl.html. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 2.0 or later as published by the Free +** Software Foundation and appearing in the file LICENSE.GPL included in +** the packaging of this file. Please review the following information to +** ensure the GNU General Public License version 2.0 requirements will be +** met: http://www.gnu.org/licenses/gpl-2.0.html. +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#ifndef VECTORCAN_SYMBOLS_P_H +#define VECTORCAN_SYMBOLS_P_H + +// +// W A R N I N G +// ------------- +// +// This file is not part of the Qt API. It exists purely as an +// implementation detail. This header file may change from version to +// version without notice, or even be removed. +// +// We mean it. +// + +#ifdef LINK_LIBVECTORCAN + +extern "C" +{ +#include <vxlapi.h> +} + +#else + +#include <QtCore/qlibrary.h> +#include <QtCore/qstring.h> +#include <QtCore/qdebug.h> + +#ifdef Q_OS_WIN32 +# include <windows.h> +#else +# error "Unsupported platform" +#endif + +// transceiver types: CAN Cab +#define XL_TRANSCEIVER_TYPE_NONE 0x0000 +#define XL_TRANSCEIVER_TYPE_CAN_251 0x0001 +#define XL_TRANSCEIVER_TYPE_CAN_252 0x0002 +#define XL_TRANSCEIVER_TYPE_CAN_DNOPTO 0x0003 +#define XL_TRANSCEIVER_TYPE_CAN_SWC_PROTO 0x0005 // Prototype. Driver may latch-up. +#define XL_TRANSCEIVER_TYPE_CAN_SWC 0x0006 +#define XL_TRANSCEIVER_TYPE_CAN_EVA 0x0007 +#define XL_TRANSCEIVER_TYPE_CAN_FIBER 0x0008 +#define XL_TRANSCEIVER_TYPE_CAN_1054_OPTO 0x000B // 1054 with optical isolation +#define XL_TRANSCEIVER_TYPE_CAN_SWC_OPTO 0x000C // SWC with optical isolation +#define XL_TRANSCEIVER_TYPE_CAN_B10011S 0x000D // B10011S truck-and-trailer +#define XL_TRANSCEIVER_TYPE_CAN_1050 0x000E // 1050 +#define XL_TRANSCEIVER_TYPE_CAN_1050_OPTO 0x000F // 1050 with optical isolation +#define XL_TRANSCEIVER_TYPE_CAN_1041 0x0010 // 1041 +#define XL_TRANSCEIVER_TYPE_CAN_1041_OPTO 0x0011 // 1041 with optical isolation +#define XL_TRANSCEIVER_TYPE_LIN_6258_OPTO 0x0017 // Vector LINcab 6258opto with transceiver Infineon TLE6258 +#define XL_TRANSCEIVER_TYPE_LIN_6259_OPTO 0x0019 // Vector LINcab 6259opto with transceiver Infineon TLE6259 +#define XL_TRANSCEIVER_TYPE_DAIO_8444_OPTO 0x001D // Vector IOcab 8444 (8 dig.Inp.; 4 dig.Outp.; 4 ana.Inp.; 4 ana.Outp.) +#define XL_TRANSCEIVER_TYPE_CAN_1041A_OPTO 0x0021 // 1041A with optical isolation +#define XL_TRANSCEIVER_TYPE_LIN_6259_MAG 0x0023 // LIN transceiver 6259, with transceiver Infineon TLE6259, magnetically isolated, stress functionality +#define XL_TRANSCEIVER_TYPE_LIN_7259_MAG 0x0025 // LIN transceiver 7259, with transceiver Infineon TLE7259, magnetically isolated, stress functionality +#define XL_TRANSCEIVER_TYPE_LIN_7269_MAG 0x0027 // LIN transceiver 7269, with transceiver Infineon TLE7269, magnetically isolated, stress functionality +#define XL_TRANSCEIVER_TYPE_CAN_1054_MAG 0x0033 // TJA1054, magnetically isolated, with selectable termination resistor (via 4th IO line) +#define XL_TRANSCEIVER_TYPE_CAN_251_MAG 0x0035 // 82C250/251 or equivalent, magnetically isolated +#define XL_TRANSCEIVER_TYPE_CAN_1050_MAG 0x0037 // TJA1050, magnetically isolated +#define XL_TRANSCEIVER_TYPE_CAN_1040_MAG 0x0039 // TJA1040, magnetically isolated +#define XL_TRANSCEIVER_TYPE_CAN_1041A_MAG 0x003B // TJA1041A, magnetically isolated +#define XL_TRANSCEIVER_TYPE_TWIN_CAN_1041A_MAG 0x0080 // TWINcab with two TJA1041, magnetically isolated +#define XL_TRANSCEIVER_TYPE_TWIN_LIN_7269_MAG 0x0081 // TWINcab with two 7259, Infineon TLE7259, magnetically isolated, stress functionality +#define XL_TRANSCEIVER_TYPE_TWIN_CAN_1041AV2_MAG 0x0082 // TWINcab with two TJA1041, magnetically isolated +#define XL_TRANSCEIVER_TYPE_TWIN_CAN_1054_1041A_MAG 0x0083 // TWINcab with TJA1054A and TJA1041A with magnetic isolation +// transceiver types: CAN PiggyBack +#define XL_TRANSCEIVER_TYPE_PB_CAN_251 0x0101 +#define XL_TRANSCEIVER_TYPE_PB_CAN_1054 0x0103 +#define XL_TRANSCEIVER_TYPE_PB_CAN_251_OPTO 0x0105 +#define XL_TRANSCEIVER_TYPE_PB_CAN_SWC 0x010B +// 0x010D not supported, 0x010F, 0x0111, 0x0113 reserved for future use!! +#define XL_TRANSCEIVER_TYPE_PB_CAN_1054_OPTO 0x0115 +#define XL_TRANSCEIVER_TYPE_PB_CAN_SWC_OPTO 0x0117 +#define XL_TRANSCEIVER_TYPE_PB_CAN_TT_OPTO 0x0119 +#define XL_TRANSCEIVER_TYPE_PB_CAN_1050 0x011B +#define XL_TRANSCEIVER_TYPE_PB_CAN_1050_OPTO 0x011D +#define XL_TRANSCEIVER_TYPE_PB_CAN_1041 0x011F +#define XL_TRANSCEIVER_TYPE_PB_CAN_1041_OPTO 0x0121 +#define XL_TRANSCEIVER_TYPE_PB_LIN_6258_OPTO 0x0129 // LIN piggy back with transceiver Infineon TLE6258 +#define XL_TRANSCEIVER_TYPE_PB_LIN_6259_OPTO 0x012B // LIN piggy back with transceiver Infineon TLE6259 +#define XL_TRANSCEIVER_TYPE_PB_LIN_6259_MAG 0x012D // LIN piggy back with transceiver Infineon TLE6259, magnetically isolated, stress functionality +#define XL_TRANSCEIVER_TYPE_PB_CAN_1041A_OPTO 0x012F // CAN transceiver 1041A +#define XL_TRANSCEIVER_TYPE_PB_LIN_7259_MAG 0x0131 // LIN piggy back with transceiver Infineon TLE7259, magnetically isolated, stress functionality +#define XL_TRANSCEIVER_TYPE_PB_LIN_7269_MAG 0x0133 // LIN piggy back with transceiver Infineon TLE7269, magnetically isolated, stress functionality +#define XL_TRANSCEIVER_TYPE_PB_CAN_251_MAG 0x0135 // 82C250/251 or compatible, magnetically isolated +#define XL_TRANSCEIVER_TYPE_PB_CAN_1050_MAG 0x0136 // TJA 1050, magnetically isolated +#define XL_TRANSCEIVER_TYPE_PB_CAN_1040_MAG 0x0137 // TJA 1040, magnetically isolated +#define XL_TRANSCEIVER_TYPE_PB_CAN_1041A_MAG 0x0138 // TJA 1041A, magnetically isolated +#define XL_TRANSCEIVER_TYPE_PB_DAIO_8444_OPTO 0x0139 // optically isolated IO piggy +#define XL_TRANSCEIVER_TYPE_PB_CAN_1054_MAG 0x013B // TJA1054, magnetically isolated, with selectable termination resistor (via 4th IO line) +#define XL_TRANSCEIVER_TYPE_CAN_1051_CAP_FIX 0x013C // TJA1051 - fixed transceiver on e.g. 16xx/8970 +#define XL_TRANSCEIVER_TYPE_DAIO_1021_FIX 0x013D // Onboard IO of VN1630/VN1640 +#define XL_TRANSCEIVER_TYPE_LIN_7269_CAP_FIX 0x013E // TLE7269 - fixed transceiver on 1611 +#define XL_TRANSCEIVER_TYPE_PB_CAN_1051_CAP 0x013F // TJA 1051, capacitive isolated +#define XL_TRANSCEIVER_TYPE_PB_CAN_SWC_7356_CAP 0x0140 // Single Wire NCV7356, capacitive isolated +#define XL_TRANSCEIVER_TYPE_PB_CAN_1055_CAP 0x0141 // TJA1055, capacitive isolated, with selectable termination resistor (via 4th IO line) +#define XL_TRANSCEIVER_TYPE_PB_CAN_1057_CAP 0x0142 // TJA 1057, capacitive isolated +// transceiver types: FlexRay PiggyBacks +#define XL_TRANSCEIVER_TYPE_PB_FR_1080 0x0201 // TJA 1080 +#define XL_TRANSCEIVER_TYPE_PB_FR_1080_MAG 0x0202 // TJA 1080 magnetically isolated piggy +#define XL_TRANSCEIVER_TYPE_PB_FR_1080A_MAG 0x0203 // TJA 1080A magnetically isolated piggy +#define XL_TRANSCEIVER_TYPE_PB_FR_1082_CAP 0x0204 // TJA 1082 capacitive isolated piggy +#define XL_TRANSCEIVER_TYPE_PB_FRC_1082_CAP 0x0205 // TJA 1082 capacitive isolated piggy with CANpiggy form factor + +#define XL_TRANSCEIVER_TYPE_ETH_BCM54810_FIX 0x0230 // Onboard Broadcom PHY on VN5610 + +// IOpiggy 8642 +#define XL_TRANSCEIVER_TYPE_PB_DAIO_8642 0x0280 // Iopiggy for VN8900 + +// transceiver Operation Modes +#define XL_TRANSCEIVER_LINEMODE_NA ((quint32)0x0000) +#define XL_TRANSCEIVER_LINEMODE_TWO_LINE ((quint32)0x0001) +#define XL_TRANSCEIVER_LINEMODE_CAN_H ((quint32)0x0002) +#define XL_TRANSCEIVER_LINEMODE_CAN_L ((quint32)0x0003) +#define XL_TRANSCEIVER_LINEMODE_SWC_SLEEP ((quint32)0x0004) // SWC Sleep Mode. +#define XL_TRANSCEIVER_LINEMODE_SWC_NORMAL ((quint32)0x0005) // SWC Normal Mode. +#define XL_TRANSCEIVER_LINEMODE_SWC_FAST ((quint32)0x0006) // SWC High-Speed Mode. +#define XL_TRANSCEIVER_LINEMODE_SWC_WAKEUP ((quint32)0x0007) // SWC Wakeup Mode. +#define XL_TRANSCEIVER_LINEMODE_SLEEP ((quint32)0x0008) +#define XL_TRANSCEIVER_LINEMODE_NORMAL ((quint32)0x0009) +#define XL_TRANSCEIVER_LINEMODE_STDBY ((quint32)0x000a) // Standby for those who support it +#define XL_TRANSCEIVER_LINEMODE_TT_CAN_H ((quint32)0x000b) // truck & trailer: operating mode single wire using CAN high +#define XL_TRANSCEIVER_LINEMODE_TT_CAN_L ((quint32)0x000c) // truck & trailer: operating mode single wire using CAN low +#define XL_TRANSCEIVER_LINEMODE_EVA_00 ((quint32)0x000d) // CANcab Eva +#define XL_TRANSCEIVER_LINEMODE_EVA_01 ((quint32)0x000e) // CANcab Eva +#define XL_TRANSCEIVER_LINEMODE_EVA_10 ((quint32)0x000f) // CANcab Eva +#define XL_TRANSCEIVER_LINEMODE_EVA_11 ((quint32)0x0010) // CANcab Eva + +// transceiver Status Flags (not all used, but for compatibility reasons) +#define XL_TRANSCEIVER_STATUS_PRESENT ((quint32)0x0001) +#define XL_TRANSCEIVER_STATUS_POWER ((quint32)0x0002) +#define XL_TRANSCEIVER_STATUS_MEMBLANK ((quint32)0x0004) +#define XL_TRANSCEIVER_STATUS_MEMCORRUPT ((quint32)0x0008) +#define XL_TRANSCEIVER_STATUS_POWER_GOOD ((quint32)0x0010) +#define XL_TRANSCEIVER_STATUS_EXT_POWER_GOOD ((quint32)0x0020) +#define XL_TRANSCEIVER_STATUS_NOT_SUPPORTED ((quint32)0x0040) + +// common event tags +#define XL_RECEIVE_MSG ((quint16)0x0001) +#define XL_CHIP_STATE ((quint16)0x0004) +#define XL_TRANSCEIVER_INFO ((quint16)0x0006) +#define XL_TRANSCEIVER (XL_TRANSCEIVER_INFO) +#define XL_TIMER_EVENT ((quint16)0x0008) +#define XL_TIMER (XL_TIMER_EVENT) +#define XL_TRANSMIT_MSG ((quint16)0x000A) +#define XL_SYNC_PULSE ((quint16)0x000B) +#define XL_APPLICATION_NOTIFICATION ((quint16)0x000F) + +// CAN/CAN-FD event tags Rx +#define XL_CAN_EV_TAG_RX_OK ((quint16)0x0400) +#define XL_CAN_EV_TAG_RX_ERROR ((quint16)0x0401) +#define XL_CAN_EV_TAG_TX_ERROR ((quint16)0x0402) +#define XL_CAN_EV_TAG_TX_REQUEST ((quint16)0x0403) +#define XL_CAN_EV_TAG_TX_OK ((quint16)0x0404) +#define XL_CAN_EV_TAG_CHIP_STATE ((quint16)0x0409) + +// CAN/CAN-FD event tags Tx +#define XL_CAN_EV_TAG_TX_MSG ((quint16)0x0440) +#define XL_CAN_EV_TAG_TX_ERRFR ((quint16)0x0441) + +// Bus types +#define XL_BUS_TYPE_NONE 0x00000000 +#define XL_BUS_TYPE_CAN 0x00000001 + +#include <pshpack1.h> +typedef quint64 XLaccess; +typedef HANDLE XLhandle; + +// message flags +#ifndef MAX_MSG_LEN +#define MAX_MSG_LEN 8 +#endif + +// interface version for our events +#define XL_INTERFACE_VERSION_V2 2 +#define XL_INTERFACE_VERSION_V3 3 +#define XL_INTERFACE_VERSION_V4 4 +//current version +#define XL_INTERFACE_VERSION XL_INTERFACE_VERSION_V3 + +#define XL_CAN_EXT_MSG_ID 0x80000000 + +#define XL_CAN_MSG_FLAG_ERROR_FRAME 0x01 +#define XL_CAN_MSG_FLAG_OVERRUN 0x02 // Overrun in Driver or CAN Controller, previous msgs have been lost. +#define XL_CAN_MSG_FLAG_NERR 0x04 // Line Error on Lowspeed +#define XL_CAN_MSG_FLAG_WAKEUP 0x08 // High Voltage Message on Single Wire CAN +#define XL_CAN_MSG_FLAG_REMOTE_FRAME 0x10 +#define XL_CAN_MSG_FLAG_RESERVED_1 0x20 +#define XL_CAN_MSG_FLAG_TX_COMPLETED 0x40 // Message Transmitted +#define XL_CAN_MSG_FLAG_TX_REQUEST 0x80 // Transmit Message stored into Controller +#define XL_CAN_MSG_FLAG_SRR_BIT_DOM 0x0200 // SRR bit in CAN message is dominant + +#define XL_EVENT_FLAG_OVERRUN 0x01 // Used in XLevent.flags + +// structure for XL_RECEIVE_MSG, XL_TRANSMIT_MSG (32 bytes) +struct s_xl_can_msg { + unsigned long id; + quint16 flags; + quint16 dlc; + quint64 res1; + quint8 data[MAX_MSG_LEN]; + quint64 res2; +}; +static_assert(sizeof(s_xl_can_msg) == 32, "Invalid size of s_xl_can_msg structure"); + +// defines for SET_OUTPUT_MODE +#define XL_OUTPUT_MODE_SILENT 0 // switch CAN trx into default silent mode +#define XL_OUTPUT_MODE_NORMAL 1 // switch CAN trx into normal mode +#define XL_OUTPUT_MODE_TX_OFF 2 // switch CAN trx into silent mode with tx pin off +#define XL_OUTPUT_MODE_SJA_1000_SILENT 3 // switch CAN trx into SJA1000 silent mode + +// Transceiver modes +#define XL_TRANSCEIVER_EVENT_ERROR 1 +#define XL_TRANSCEIVER_EVENT_CHANGED 2 + +// basic bus message structure +union s_xl_tag_data { + struct s_xl_can_msg msg; +}; + +// event type definition (48 bytes) +typedef struct s_xl_event { + quint8 tag; + quint8 chanIndex; + quint16 transId; + quint16 portHandle; + quint8 flags; // e.g. XL_EVENT_FLAG_OVERRUN + quint8 reserved; + quint64 timeStamp; + union s_xl_tag_data tagData; // 32 bytes +} XLevent; +static_assert(sizeof(s_xl_event) == 48, "Invalid size of s_xl_event structure"); + +// build a channels mask from the channels index +#define XL_CHANNEL_MASK(x) (quint64(1) << (x)) + +#define XL_MAX_APPNAME 32 + +// driver status +typedef qint16 XLstatus; + +#define XL_SUCCESS 0 +#define XL_PENDING 1 + +#define XL_ERR_QUEUE_IS_EMPTY 10 +#define XL_ERR_QUEUE_IS_FULL 11 +#define XL_ERR_TX_NOT_POSSIBLE 12 +#define XL_ERR_NO_LICENSE 14 +#define XL_ERR_WRONG_PARAMETER 101 +#define XL_ERR_TWICE_REGISTER 110 +#define XL_ERR_INVALID_CHAN_INDEX 111 +#define XL_ERR_INVALID_ACCESS 112 +#define XL_ERR_PORT_IS_OFFLINE 113 +#define XL_ERR_CHAN_IS_ONLINE 116 +#define XL_ERR_NOT_IMPLEMENTED 117 +#define XL_ERR_INVALID_PORT 118 +#define XL_ERR_HW_NOT_READY 120 +#define XL_ERR_CMD_TIMEOUT 121 +#define XL_ERR_HW_NOT_PRESENT 129 +#define XL_ERR_NOTIFY_ALREADY_ACTIVE 131 +#define XL_ERR_NO_RESOURCES 152 +#define XL_ERR_WRONG_CHIP_TYPE 153 +#define XL_ERR_WRONG_COMMAND 154 +#define XL_ERR_INVALID_HANDLE 155 +#define XL_ERR_RESERVED_NOT_ZERO 157 +#define XL_ERR_INIT_ACCESS_MISSING 158 +#define XL_ERR_CANNOT_OPEN_DRIVER 201 +#define XL_ERR_WRONG_BUS_TYPE 202 +#define XL_ERR_DLL_NOT_FOUND 203 +#define XL_ERR_INVALID_CHANNEL_MASK 204 +#define XL_ERR_NOT_SUPPORTED 205 +// special stream defines +#define XL_ERR_CONNECTION_BROKEN 210 +#define XL_ERR_CONNECTION_CLOSED 211 +#define XL_ERR_INVALID_STREAM_NAME 212 +#define XL_ERR_CONNECTION_FAILED 213 +#define XL_ERR_STREAM_NOT_FOUND 214 +#define XL_ERR_STREAM_NOT_CONNECTED 215 +#define XL_ERR_QUEUE_OVERRUN 216 +#define XL_ERROR 255 + +// defines for xlGetDriverConfig structures +#define XL_MAX_LENGTH 31 +#define XL_CONFIG_MAX_CHANNELS 64 + +// flags for channelCapabilities +#define XL_CHANNEL_FLAG_TIME_SYNC_RUNNING 0x00000001 +#define XL_CHANNEL_FLAG_CANFD_SUPPORT 0x20000000 + +// activate - channel flags +#define XL_ACTIVATE_NONE 0 +#define XL_ACTIVATE_RESET_CLOCK 8 + +#define XL_BUS_COMPATIBLE_CAN XL_BUS_TYPE_CAN + +// the following bus types can be used with the current cab / piggy +#define XL_BUS_ACTIVE_CAP_CAN (XL_BUS_COMPATIBLE_CAN << 16) + +// acceptance filter +#define XL_CAN_STD 01 // flag for standard ID's +#define XL_CAN_EXT 02 // flag for extended ID's + +typedef struct { + quint32 busType; + union { + struct { + quint32 bitRate; + quint8 sjw; + quint8 tseg1; + quint8 tseg2; + quint8 sam; + quint8 outputMode; + } can; + quint8 raw[32]; + } data; +} XLbusParams; + +// porthandle +#define XL_INVALID_PORTHANDLE (-1) +typedef long XLportHandle, *pXLportHandle; + +// defines for FPGA core types (fpgaCoreCapabilities) +#define XL_FPGA_CORE_TYPE_NONE 0 +#define XL_FPGA_CORE_TYPE_CAN 1 + +// defines for special DeviceStatus +#define XL_SPECIAL_DEVICE_STAT_FPGA_UPDATE_DONE 0x01 // automatic driver FPGA flashing done + +typedef struct s_xl_channel_config { + char name[XL_MAX_LENGTH + 1]; + quint8 hwType; // HWTYPE_xxxx (see above) + quint8 hwIndex; // Index of the hardware (same type) (0,1,...) + quint8 hwChannel; // Index of the channel (same hardware) (0,1,...) + quint16 transceiverType; // TRANSCEIVER_TYPE_xxxx (see above) + quint16 transceiverState; // transceiver state (XL_TRANSCEIVER_STATUS...) + quint16 configError; // XL_CHANNEL_CONFIG_ERROR_XXX (see above) + quint8 channelIndex; // Global channel index (0,1,...) + quint64 channelMask; // Global channel mask (=1<<channelIndex) + quint32 channelCapabilities; // capabilities which are supported (e.g CHANNEL_FLAG_XXX) + quint32 channelBusCapabilities; // what buses are supported and which are possible to be activated (e.g. XXX_BUS_ACTIVE_CAP_CAN) + + // channel + quint8 isOnBus; // The channel is on bus + quint32 connectedBusType; // currently selected bus + XLbusParams busParams; + + quint32 driverVersion; + quint32 interfaceVersion; // version of interface with driver + quint32 raw_data[10]; + + quint32 serialNumber; + quint32 articleNumber; + + char transceiverName[XL_MAX_LENGTH + 1]; // name for CANcab or another transceiver + + quint32 specialCabFlags; // XL_SPECIAL_CAB_LIN_RECESSIVE_STRESS, XL_SPECIAL_CAB_LIN_DOMINANT_TIMEOUT flags + quint32 dominantTimeout; // Dominant Timeout in us. + quint8 dominantRecessiveDelay; // Delay in us. + quint8 recessiveDominantDelay; // Delay in us. + quint8 connectionInfo; // XL_CONNECTION_INFO_XXX + quint8 currentlyAvailableTimestamps; // XL_CURRENTLY_AVAILABLE_TIMESTAMP... + quint16 minimalSupplyVoltage; // Minimal Supply Voltage of the Cab/Piggy in 1/100 V + quint16 maximalSupplyVoltage; // Maximal Supply Voltage of the Cab/Piggy in 1/100 V + quint32 maximalBaudrate; // Maximal supported LIN baudrate + quint8 fpgaCoreCapabilities; // e.g.: XL_FPGA_CORE_TYPE_XXX + quint8 specialDeviceStatus; // e.g.: XL_SPECIAL_DEVICE_STAT_XXX + quint16 channelBusActiveCapabilities; // like channelBusCapabilities (but without core dependencies) + quint16 breakOffset; // compensation for edge asymmetry in ns + quint16 delimiterOffset; // compensation for edgdfde asymmetry in ns + quint32 reserved[3]; +} XLchannelConfig, *pXLchannelConfig; + +typedef struct s_xl_driver_config { + quint32 dllVersion; + quint32 channelCount; // total number of channels + quint32 reserved[10]; + XLchannelConfig channel[XL_CONFIG_MAX_CHANNELS]; // [channelCount] +} XLdriverConfig, *pXLdriverConfig; + +// structure for the acceptance filter +typedef struct _XLacc_filt { + quint8 isSet; + unsigned long code; + unsigned long mask; // relevant = 1 +} XLaccFilt; + +// structure for the acceptance filter of one CAN chip +typedef struct _XLacceptance { + XLaccFilt std; + XLaccFilt xtd; +} XLacceptance; + +// defines for xlSetGlobalTimeSync +#define XL_SET_TIMESYNC_NO_CHANGE ((unsigned long)0) +#define XL_SET_TIMESYNC_ON ((unsigned long)1) +#define XL_SET_TIMESYNC_OFF ((unsigned long)2) + +#include <poppack.h> + +#define GENERATE_SYMBOL_VARIABLE(returnType, symbolName, ...) \ + typedef returnType (WINAPI *fp_##symbolName)(__VA_ARGS__); \ + static fp_##symbolName symbolName; + +#define RESOLVE_SYMBOL(symbolName) \ + symbolName = (fp_##symbolName)resolveSymbol(vectorcanLibrary, #symbolName); \ + if (!symbolName) \ + return false; + +GENERATE_SYMBOL_VARIABLE(XLstatus, xlOpenDriver, void) +GENERATE_SYMBOL_VARIABLE(XLstatus, xlCloseDriver, void) +GENERATE_SYMBOL_VARIABLE(XLstatus, xlGetDriverConfig, XLdriverConfig *) +GENERATE_SYMBOL_VARIABLE(XLstatus, xlOpenPort, XLportHandle *, char *, XLaccess, XLaccess *, quint32, quint32, quint32) +GENERATE_SYMBOL_VARIABLE(XLstatus, xlClosePort, XLportHandle) +GENERATE_SYMBOL_VARIABLE(XLstatus, xlActivateChannel, XLportHandle, XLaccess, quint32, quint32) +GENERATE_SYMBOL_VARIABLE(XLstatus, xlDeactivateChannel, XLportHandle, XLaccess) +GENERATE_SYMBOL_VARIABLE(XLstatus, xlCanSetChannelBitrate, XLportHandle, XLaccess, quint32) +GENERATE_SYMBOL_VARIABLE(XLstatus, xlCanTransmit, XLportHandle, XLaccess, quint32 *, void *) +GENERATE_SYMBOL_VARIABLE(XLstatus, xlReceive, XLportHandle, quint32 *, XLevent *) +GENERATE_SYMBOL_VARIABLE(XLstatus, xlSetNotification, XLportHandle, XLhandle *, int) +GENERATE_SYMBOL_VARIABLE(char *, xlGetErrorString, XLstatus) + +inline QFunctionPointer resolveSymbol(QLibrary *vectorcanLibrary, const char *symbolName) +{ + QFunctionPointer symbolFunctionPointer = vectorcanLibrary->resolve(symbolName); + if (!symbolFunctionPointer) + qWarning("Failed to resolve the vxlapi symbol: %s", symbolName); + + return symbolFunctionPointer; +} + +inline bool resolveSymbols(QLibrary *vectorcanLibrary) +{ + if (!vectorcanLibrary->isLoaded()) { + vectorcanLibrary->setFileName(QStringLiteral("vxlapi")); + if (!vectorcanLibrary->load()) { + qWarning("Failed to load the library: %s", qPrintable(vectorcanLibrary->fileName())); + return false; + } + } + + RESOLVE_SYMBOL(xlOpenDriver) + RESOLVE_SYMBOL(xlCloseDriver) + RESOLVE_SYMBOL(xlGetDriverConfig) + RESOLVE_SYMBOL(xlOpenPort) + RESOLVE_SYMBOL(xlClosePort) + RESOLVE_SYMBOL(xlActivateChannel) + RESOLVE_SYMBOL(xlDeactivateChannel) + RESOLVE_SYMBOL(xlCanSetChannelBitrate) + RESOLVE_SYMBOL(xlCanTransmit) + RESOLVE_SYMBOL(xlReceive) + RESOLVE_SYMBOL(xlSetNotification) + RESOLVE_SYMBOL(xlGetErrorString) + + return true; +} + +#endif + +#endif // VECTORCAN_SYMBOLS_P_H diff --git a/src/plugins/canbus/vectorcan/vectorcanbackend.cpp b/src/plugins/canbus/vectorcan/vectorcanbackend.cpp new file mode 100644 index 0000000..210a6a8 --- /dev/null +++ b/src/plugins/canbus/vectorcan/vectorcanbackend.cpp @@ -0,0 +1,492 @@ +/**************************************************************************** +** +** Copyright (C) 2016 Denis Shienkov <denis.shienkov@gmail.com> +** Contact: http://www.qt.io/licensing/ +** +** This file is part of the QtSerialBus module of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL3$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see http://www.qt.io/terms-conditions. For further +** information use the contact form at http://www.qt.io/contact-us. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 3 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPLv3 included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 3 requirements +** will be met: https://www.gnu.org/licenses/lgpl.html. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 2.0 or later as published by the Free +** Software Foundation and appearing in the file LICENSE.GPL included in +** the packaging of this file. Please review the following information to +** ensure the GNU General Public License version 2.0 requirements will be +** met: http://www.gnu.org/licenses/gpl-2.0.html. +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#include "vectorcanbackend.h" +#include "vectorcanbackend_p.h" +#include "vectorcan_symbols_p.h" + +#include <QtSerialBus/qcanbusdevice.h> + +#include <QtCore/qtimer.h> +#include <QtCore/qcoreevent.h> +#include <QtCore/qwineventnotifier.h> +#include <QtCore/qcoreapplication.h> + +#include <algorithm> + +QT_BEGIN_NAMESPACE + +#ifndef LINK_LIBVECTORCAN +Q_GLOBAL_STATIC(QLibrary, vectorcanLibrary) +#endif + +bool VectorCanBackend::canCreate(QString *errorReason) +{ +#ifdef LINK_LIBVECTORCAN + return true; +#else + static bool symbolsResolved = resolveSymbols(vectorcanLibrary()); + if (!symbolsResolved) { + *errorReason = tr("The Vector CAN runtime library is not found"); + return false; + } + return true; +#endif +} + +static int driverRefCount = 0; + +class ReadNotifier : public QWinEventNotifier +{ + // no Q_OBJECT macro! +public: + explicit ReadNotifier(VectorCanBackendPrivate *d, QObject *parent) + : QWinEventNotifier(parent) + , dptr(d) + { + setHandle(dptr->readHandle); + } + +protected: + bool event(QEvent *e) override + { + if (e->type() == QEvent::WinEventAct) { + dptr->startRead(); + return true; + } + return QWinEventNotifier::event(e); + } + +private: + VectorCanBackendPrivate *dptr; +}; + +class WriteNotifier : public QTimer +{ + // no Q_OBJECT macro! +public: + WriteNotifier(VectorCanBackendPrivate *d, QObject *parent) + : QTimer(parent) + , dptr(d) + { + setInterval(0); + } + +protected: + void timerEvent(QTimerEvent *e) override + { + if (e->timerId() == timerId()) { + dptr->startWrite(); + return; + } + QTimer::timerEvent(e); + } + +private: + VectorCanBackendPrivate *dptr; +}; + + +VectorCanBackendPrivate::VectorCanBackendPrivate(VectorCanBackend *q) + : q_ptr(q) + , portHandle(XL_INVALID_PORTHANDLE) +{ + startupDriver(); +} + +VectorCanBackendPrivate::~VectorCanBackendPrivate() +{ + cleanupDriver(); +} + +bool VectorCanBackendPrivate::open() +{ + Q_Q(VectorCanBackend); + + XLaccess permissionMask = channelMask; + const quint32 queueSize = 256; + if (const XLstatus status = ::xlOpenPort( + &portHandle, + const_cast<char *>(qPrintable(qApp->applicationName())), + channelMask, + &permissionMask, + queueSize, + XL_INTERFACE_VERSION, + XL_BUS_TYPE_CAN) != XL_SUCCESS + || portHandle == XL_INVALID_PORTHANDLE) { + q->setError(systemErrorString(status), + QCanBusDevice::ConnectionError); + return false; + } + + if (const XLstatus status = ::xlActivateChannel( + portHandle, + channelMask, + XL_BUS_TYPE_CAN, + XL_ACTIVATE_RESET_CLOCK) != XL_SUCCESS) { + q->setError(systemErrorString(status), + QCanBusDevice::CanBusError::ConnectionError); + return false; + } + + const int queueLevel = 1; + if (const XLstatus status = ::xlSetNotification( + portHandle, + &readHandle, + queueLevel) != XL_SUCCESS) { + q->setError(systemErrorString(status), + QCanBusDevice::ConnectionError); + return false; + } + + readNotifier = new ReadNotifier(this, q); + readNotifier->setEnabled(true); + + writeNotifier = new WriteNotifier(this, q); + + return true; +} + +void VectorCanBackendPrivate::close() +{ + Q_Q(VectorCanBackend); + + delete readNotifier; + readNotifier = nullptr; + + delete writeNotifier; + writeNotifier = nullptr; + + if (const XLstatus status = ::xlDeactivateChannel( + portHandle, + channelMask) != XL_SUCCESS) { + q->setError(systemErrorString(status), + QCanBusDevice::CanBusError::ConfigurationError); + } + + if (const XLstatus status = ::xlClosePort(portHandle) != XL_SUCCESS) { + q->setError(systemErrorString(status), + QCanBusDevice::ConnectionError); + } + + portHandle = XL_INVALID_PORTHANDLE; +} + +bool VectorCanBackendPrivate::setConfigurationParameter(int key, const QVariant &value) +{ + Q_Q(VectorCanBackend); + + switch (key) { + case QCanBusDevice::BitRateKey: + return setBitRate(value.toUInt()); + default: + q->setError(VectorCanBackend::tr("Unsupported configuration key"), + QCanBusDevice::ConfigurationError); + return false; + } +} + +void VectorCanBackendPrivate::setupChannel(const QString &interfaceName) +{ + if (interfaceName.startsWith(QStringLiteral("channel"))) { + const QStringRef ref = interfaceName.midRef(7); + bool ok = false; + const int channelIndex = ref.toInt(&ok); + if (ok && (channelIndex >= 0 && channelIndex < XL_CONFIG_MAX_CHANNELS)) { + channelMask = XL_CHANNEL_MASK((channelIndex)); + return; + } + } + + qCritical() << "Unable to parse the channel from an interface"; +} + +void VectorCanBackendPrivate::setupDefaultConfigurations() +{ + Q_Q(VectorCanBackend); + + q->setConfigurationParameter(QCanBusDevice::BitRateKey, 500000); +} + +QString VectorCanBackendPrivate::systemErrorString(int errorCode) const +{ + if (const char *string = ::xlGetErrorString(errorCode)) + return QString::fromUtf8(string); + return VectorCanBackend::tr("Unable to retrieve an error string"); +} + +void VectorCanBackendPrivate::startWrite() +{ + Q_Q(VectorCanBackend); + + if (!q->hasOutgoingFrames()) { + writeNotifier->stop(); + return; + } + + const QCanBusFrame frame = q->dequeueOutgoingFrame(); + const QByteArray payload = frame.payload(); + + XLevent event; + ::memset(&event, 0, sizeof(event)); + + event.tag = XL_TRANSMIT_MSG; + + s_xl_can_msg &msg = event.tagData.msg; + + msg.id = frame.frameId(); + if (frame.hasExtendedFrameFormat()) + msg.id |= XL_CAN_EXT_MSG_ID; + + msg.dlc = payload.size(); + + if (frame.frameType() == QCanBusFrame::RemoteRequestFrame) + msg.flags |= XL_CAN_MSG_FLAG_REMOTE_FRAME; // we do not care about the payload + else if (frame.frameType() == QCanBusFrame::ErrorFrame) + msg.flags |= XL_CAN_MSG_FLAG_ERROR_FRAME; // we do not care about the payload + else + ::memcpy(msg.data, payload.constData(), sizeof(msg.data)); + + quint32 eventCount = 1; + if (const XLstatus status = ::xlCanTransmit( + portHandle, + channelMask, + &eventCount, &event) != XL_SUCCESS) { + q->setError(systemErrorString(status), + QCanBusDevice::WriteError); + } else { + emit q->framesWritten(qint64(eventCount)); + } + + if (q->hasOutgoingFrames()) + writeNotifier->start(); +} + +void VectorCanBackendPrivate::startRead() +{ + Q_Q(VectorCanBackend); + + QVector<QCanBusFrame> newFrames; + + for (;;) { + quint32 eventCount = 1; + XLevent event; + ::memset(&event, 0, sizeof(event)); + + if (const XLstatus status = ::xlReceive( + portHandle, + &eventCount, + &event) != XL_SUCCESS) { + qDebug() << "status:" << status; + if (status != XL_ERR_QUEUE_IS_EMPTY) { + q->setError(systemErrorString(status), + QCanBusDevice::ReadError); + } + break; + } + + if (event.tag != XL_RECEIVE_MSG || event.portHandle != portHandle) + continue; + + const s_xl_can_msg &msg = event.tagData.msg; + + QCanBusFrame frame(msg.id, QByteArray(reinterpret_cast<const char *>(msg.data), + int(msg.dlc))); + frame.setTimeStamp(QCanBusFrame::TimeStamp(0, event.timeStamp)); + frame.setExtendedFrameFormat(msg.id & XL_CAN_EXT_MSG_ID); + frame.setFrameType((msg.flags & XL_CAN_MSG_FLAG_REMOTE_FRAME) + ? QCanBusFrame::RemoteRequestFrame + : (msg.flags & XL_CAN_MSG_FLAG_ERROR_FRAME) + ? QCanBusFrame::ErrorFrame + : QCanBusFrame::DataFrame); + + newFrames.append(frame); + } + + q->enqueueReceivedFrames(newFrames); +} + +void VectorCanBackendPrivate::startupDriver() +{ + Q_Q(VectorCanBackend); + + if (driverRefCount == 0) { + if (const XLstatus status = ::xlOpenDriver() != XL_SUCCESS) { + q->setError(systemErrorString(status), + QCanBusDevice::CanBusError::ConnectionError); + return; + } + } else if (driverRefCount < 0) { + qCritical("Wrong reference counter: %d", driverRefCount); + return; + } + + ++driverRefCount; +} + +void VectorCanBackendPrivate::cleanupDriver() +{ + --driverRefCount; + + if (driverRefCount < 0) { + qCritical("Wrong reference counter: %d", driverRefCount); + driverRefCount = 0; + } else if (driverRefCount == 0) { + ::xlCloseDriver(); + } +} + +bool VectorCanBackendPrivate::setBitRate(quint32 bitrate) +{ + Q_Q(VectorCanBackend); + + if (q->state() != QCanBusDevice::UnconnectedState) { + if (const XLstatus status = ::xlCanSetChannelBitrate( + portHandle, + channelMask, + bitrate) != XL_SUCCESS) { + q->setError(systemErrorString(status), + QCanBusDevice::CanBusError::ConfigurationError); + return false; + } + } + + return true; +} + +VectorCanBackend::VectorCanBackend(const QString &name, QObject *parent) + : QCanBusDevice(parent) + , d_ptr(new VectorCanBackendPrivate(this)) +{ + Q_D(VectorCanBackend); + + d->setupChannel(name); + d->setupDefaultConfigurations(); +} + +VectorCanBackend::~VectorCanBackend() +{ + if (state() == ConnectedState) + close(); + + delete d_ptr; +} + +bool VectorCanBackend::open() +{ + Q_D(VectorCanBackend); + + if (!d->open()) { + close(); // sets UnconnectedState + return false; + } + + const auto keys = configurationKeys(); + for (int key : keys) { + const QVariant param = configurationParameter(key); + const bool success = d->setConfigurationParameter(key, param); + if (!success) { + qWarning() << "Cannot apply parameter:" << key + << "with value:" << param; + } + } + + setState(QCanBusDevice::ConnectedState); + return true; +} + +void VectorCanBackend::close() +{ + Q_D(VectorCanBackend); + + d->close(); + + setState(QCanBusDevice::UnconnectedState); +} + +void VectorCanBackend::setConfigurationParameter(int key, const QVariant &value) +{ + Q_D(VectorCanBackend); + + if (d->setConfigurationParameter(key, value)) + QCanBusDevice::setConfigurationParameter(key, value); +} + +bool VectorCanBackend::writeFrame(const QCanBusFrame &newData) +{ + Q_D(VectorCanBackend); + + if (state() != QCanBusDevice::ConnectedState) + return false; + + if (!newData.isValid()) { + setError(tr("Cannot write invalid QCanBusFrame"), + QCanBusDevice::WriteError); + return false; + } + + if (newData.frameType() != QCanBusFrame::DataFrame + && newData.frameType() != QCanBusFrame::RemoteRequestFrame + && newData.frameType() != QCanBusFrame::ErrorFrame) { + setError(tr("Unable to write a frame with unacceptable type"), + QCanBusDevice::WriteError); + return false; + } + + // CAN FD frame format not implemented at this stage + if (newData.payload().size() > MAX_MSG_LEN) { + setError(tr("CAN FD frame format not supported."), + QCanBusDevice::WriteError); + return false; + } + + enqueueOutgoingFrame(newData); + + if (!d->writeNotifier->isActive()) + d->writeNotifier->start(); + + return true; +} + +// TODO: Implement me +QString VectorCanBackend::interpretErrorFrame(const QCanBusFrame &errorFrame) +{ + Q_UNUSED(errorFrame); + + return QString(); +} + +QT_END_NAMESPACE diff --git a/src/plugins/canbus/vectorcan/vectorcanbackend.h b/src/plugins/canbus/vectorcan/vectorcanbackend.h new file mode 100644 index 0000000..89966ed --- /dev/null +++ b/src/plugins/canbus/vectorcan/vectorcanbackend.h @@ -0,0 +1,77 @@ +/**************************************************************************** +** +** Copyright (C) 2016 Denis Shienkov <denis.shienkov@gmail.com> +** Contact: http://www.qt.io/licensing/ +** +** This file is part of the QtSerialBus module of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL3$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see http://www.qt.io/terms-conditions. For further +** information use the contact form at http://www.qt.io/contact-us. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 3 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPLv3 included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 3 requirements +** will be met: https://www.gnu.org/licenses/lgpl.html. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 2.0 or later as published by the Free +** Software Foundation and appearing in the file LICENSE.GPL included in +** the packaging of this file. Please review the following information to +** ensure the GNU General Public License version 2.0 requirements will be +** met: http://www.gnu.org/licenses/gpl-2.0.html. +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#ifndef VECTORCANBACKEND_H +#define VECTORCANBACKEND_H + +#include <QtSerialBus/qcanbusframe.h> +#include <QtSerialBus/qcanbusdevice.h> + +#include <QtCore/qvariant.h> +#include <QtCore/qvector.h> +#include <QtCore/qlist.h> + +QT_BEGIN_NAMESPACE + +class VectorCanBackendPrivate; + +class VectorCanBackend : public QCanBusDevice +{ + Q_OBJECT + Q_DECLARE_PRIVATE(VectorCanBackend) + Q_DISABLE_COPY(VectorCanBackend) +public: + explicit VectorCanBackend(const QString &name, QObject *parent = nullptr); + ~VectorCanBackend() override; + + bool open() override; + void close() override; + + void setConfigurationParameter(int key, const QVariant &value) override; + + bool writeFrame(const QCanBusFrame &newData) override; + + QString interpretErrorFrame(const QCanBusFrame &errorFrame) override; + + static bool canCreate(QString *errorReason); + +private: + VectorCanBackendPrivate * const d_ptr; +}; + +QT_END_NAMESPACE + +#endif // VECTORCANBACKEND_H diff --git a/src/plugins/canbus/vectorcan/vectorcanbackend_p.h b/src/plugins/canbus/vectorcan/vectorcanbackend_p.h new file mode 100644 index 0000000..dbb3903 --- /dev/null +++ b/src/plugins/canbus/vectorcan/vectorcanbackend_p.h @@ -0,0 +1,94 @@ +/**************************************************************************** +** +** Copyright (C) 2016 Denis Shienkov <denis.shienkov@gmail.com> +** Contact: http://www.qt.io/licensing/ +** +** This file is part of the QtSerialBus module of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL3$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see http://www.qt.io/terms-conditions. For further +** information use the contact form at http://www.qt.io/contact-us. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 3 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPLv3 included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 3 requirements +** will be met: https://www.gnu.org/licenses/lgpl.html. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 2.0 or later as published by the Free +** Software Foundation and appearing in the file LICENSE.GPL included in +** the packaging of this file. Please review the following information to +** ensure the GNU General Public License version 2.0 requirements will be +** met: http://www.gnu.org/licenses/gpl-2.0.html. +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#ifndef VECTORCANBACKEND_P_H +#define VECTORCANBACKEND_P_H + +#include "vectorcanbackend.h" + +#if defined(Q_OS_WIN32) +# include <qt_windows.h> +#else +# error "Unsupported platform" // other stuff +#endif + +// +// W A R N I N G +// ------------- +// +// This file is not part of the Qt API. It exists purely as an +// implementation detail. This header file may change from version to +// version without notice, or even be removed. +// +// We mean it. +// + +QT_BEGIN_NAMESPACE + +class QWinEventNotifier; +class QTimer; + +class VectorCanBackendPrivate +{ + Q_DECLARE_PUBLIC(VectorCanBackend) +public: + VectorCanBackendPrivate(VectorCanBackend *q); + ~VectorCanBackendPrivate(); + + bool open(); + void close(); + bool setConfigurationParameter(int key, const QVariant &value); + void setupChannel(const QString &interfaceName); + void setupDefaultConfigurations(); + QString systemErrorString(int errorCode) const; + void startWrite(); + void startRead(); + void startupDriver(); + void cleanupDriver(); + bool setBitRate(quint32 bitrate); + + VectorCanBackend * const q_ptr; + + long portHandle; + quint64 channelMask = 0; + HANDLE readHandle = INVALID_HANDLE_VALUE; + QTimer *writeNotifier = nullptr; + QWinEventNotifier *readNotifier = nullptr; +}; + +QT_END_NAMESPACE + +#endif // VECTORCANBACKEND_P_H |