rawhid.h

Go to the documentation of this file.

/*
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
 * for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, see <http://www.gnu.org/licenses/>
 */

#ifndef RAWHID_H
#define RAWHID_H

#include "rawhid_global.h"

#include <QByteArray>
#include <QIODevice>
#include <QMutex>
#include <QThread>
#include <QWaitCondition>

#include <coreplugin/iconnection.h>

#include "hidapi/hidapi.h"
#include "usbmonitor.h"
#include "usbdevice.h"

//#define RAW_HID_DEBUG
#ifdef RAW_HID_DEBUG
#define RAW_HID_QXTLOG_DEBUG(...) qDebug() << __VA_ARGS__
#else // RAW_HID_DEBUG
#define RAW_HID_QXTLOG_DEBUG(...)
#endif // RAW_HID_DEBUG

class RawHIDReadThread : public QThread
{
    Q_OBJECT

public:
    RawHIDReadThread(hid_device *device);
    virtual ~RawHIDReadThread();

    int getReadData(char *data, int size);

    qint64 getBytesAvailable();

    void stop() { m_running = false; }

signals:
    void readyToRead();

protected:
    void run();

    QByteArray m_readBuffer;

    QMutex m_readBufMtx;

    hid_device *m_handle;

    bool m_running;
};

// *********************************************************************************

class RawHIDWriteThread : public QThread
{
    Q_OBJECT

public:
    RawHIDWriteThread(hid_device *device);
    virtual ~RawHIDWriteThread();

    int pushDataToWrite(const char *data, int size);

    qint64 getBytesToWrite();

    void stop();

protected:
    void run();

    QByteArray m_writeBuffer;

    QMutex m_writeBufMtx;

    QWaitCondition m_newDataToWrite;

    hid_device *m_handle;

    bool m_running;
};

// *********************************************************************************

class RAWHID_EXPORT RawHID : public QIODevice
{
    Q_OBJECT

public:
    RawHID();
    RawHID(USBDevice *deviceName);
    virtual ~RawHID();

    virtual bool open(OpenMode mode);
    virtual void close();
    virtual bool isSequential() const;

private slots:
    void sendReadyRead();

protected:
    virtual qint64 readData(char *data, qint64 maxSize);
    virtual qint64 writeData(const char *data, qint64 maxSize);
    virtual qint64 bytesAvailable() const;
    virtual qint64 bytesToWrite() const;

    USBDevice *m_deviceInfo;
    hid_device *m_handle;

    RawHIDReadThread *m_readThread;
    RawHIDWriteThread *m_writeThread;
};

#endif // RAWHID_H