1/****************************************************************************
2**
3** Copyright (C) 2017 Ford Motor Company.
4** Contact: http://www.qt.io/licensing/
5**
6** This file is part of the QtSerialBus module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL3$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see http://www.qt.io/terms-conditions. For further
15** information use the contact form at http://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPLv3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or later as published by the Free
28** Software Foundation and appearing in the file LICENSE.GPL included in
29** the packaging of this file. Please review the following information to
30** ensure the GNU General Public License version 2.0 requirements will be
31** met: http://www.gnu.org/licenses/gpl-2.0.html.
32**
33** $QT_END_LICENSE$
34**
35****************************************************************************/
36
37#ifndef PASSTHRUCAN_PASSTHRUCANIO_H
38#define PASSTHRUCAN_PASSTHRUCANIO_H
39
40#include "j2534passthru.h"
41
42#include <QtSerialBus/qcanbusdevice.h>
43#include <QtSerialBus/qcanbusframe.h>
44#include <QByteArray>
45#include <QList>
46#include <QMutex>
47#include <QObject>
48#include <QString>
49#include <QTimer>
50#include <QVariant>
51#include <QVector>
52
53QT_BEGIN_NAMESPACE
54
55class PassThruCanIO : public QObject
56{
57 Q_OBJECT
58 Q_DISABLE_COPY(PassThruCanIO)
59public:
60 static const uint pollTimeout = 100; // ms
61
62 explicit PassThruCanIO(QObject *parent = nullptr);
63 virtual ~PassThruCanIO();
64
65 Q_INVOKABLE void open(const QString &library, const QByteArray &subDev, uint bitRate);
66 Q_INVOKABLE void close();
67 Q_INVOKABLE void applyConfig(int key, const QVariant &value);
68 Q_INVOKABLE void listen();
69
70 // Internally locked; safe to call directly from any thread.
71 bool enqueueMessage(const QCanBusFrame &frame);
72
73Q_SIGNALS:
74 void errorOccurred(const QString &description, QCanBusDevice::CanBusError error);
75 void messagesReceived(QVector<QCanBusFrame> frames);
76 void messagesSent(qint64 count);
77 void openFinished(bool success);
78 void closeFinished();
79
80private:
81 bool setMessageFilters(const QList<QCanBusDevice::Filter> &filters);
82 bool setConfigValue(J2534::Config::Parameter param, ulong value);
83 void pollForMessages();
84 bool writeMessages();
85 void readMessages(bool writePending);
86
87 J2534::PassThru * m_passThru = nullptr;
88 J2534::PassThru::Handle m_deviceId = 0;
89 J2534::PassThru::Handle m_channelId = 0;
90 QTimer * m_idleNotifier = nullptr;
91 QVector<J2534::Message> m_ioBuffer;
92 QMutex m_writeGuard;
93 QList<QCanBusFrame> m_writeQueue;
94};
95
96QT_END_NAMESPACE
97
98#endif // PASSTHRUCAN_PASSTHRUCANIO_H
99

source code of qtserialbus/src/plugins/canbus/passthrucan/passthrucanio.h