usbdevice.h

Go to the documentation of this file.

// SPDX-License-Identifier: GPL-2.0+

#pragma once

#include <QObject>
#include <QStringList>
#ifdef __FreeBSD__
  #include <libusb.h>
#else
  #include <libusb-1.0/libusb.h>
#endif
#include <memory>

#include "usbdevicedefinitions.h"

class DSOModel;

typedef uint64_t UniqueUSBid;


QString libUsbErrorString(int error);

class USBDevice : public QObject {
    Q_OBJECT

  public:
    explicit USBDevice(DSOModel* model, libusb_device *device, unsigned findIteration = 0);
    USBDevice(const USBDevice&) = delete;
    ~USBDevice();
    bool connectDevice(QString &errorMessage);
    void disconnectFromDevice();

    bool isConnected();

    bool needsFirmware();

    inline unsigned int getFwVersion() const { return this->descriptor.bcdDevice; }

    inline void setFindIteration(unsigned iteration) { findIteration = iteration; }
    inline unsigned getFindIteration() const { return findIteration; }

    int bulkTransfer(unsigned char endpoint, const unsigned char *data, unsigned int length, int attempts = HANTEK_ATTEMPTS,
                     unsigned int timeout = HANTEK_TIMEOUT);

    inline int bulkWrite(const unsigned char *data, unsigned int length, int attempts = HANTEK_ATTEMPTS) {
         return bulkTransfer(HANTEK_EP_OUT, data, length, attempts);
    }

    template<class T>
    inline int bulkRead(const T *command, int attempts = HANTEK_ATTEMPTS) {
        return bulkTransfer(HANTEK_EP_IN, command->data(), command->size(), attempts);
    }

    int bulkReadMulti(unsigned char *data, unsigned length, int attempts = HANTEK_ATTEMPTS_MULTI);

    int controlTransfer(unsigned char type, unsigned char request, unsigned char *data, unsigned int length, int value,
                        int index, int attempts = HANTEK_ATTEMPTS);

    template<class T>
    inline int controlWrite(const T *command) {
        return controlTransfer(LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_ENDPOINT_OUT, uint8_t(command->code),
                               const_cast<unsigned char *>(command->data()), unsigned(command->size()), command->value, 0,
                               HANTEK_ATTEMPTS);
    }

    template<class T>
    inline int controlRead(const T *command) {
        return controlTransfer(LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_ENDPOINT_IN, uint8_t(command->code),
                               const_cast<unsigned char *>(command->data()), unsigned(command->size()), command->value, 0,
                               HANTEK_ATTEMPTS);
    }

    inline libusb_device *getRawDevice() const { return device; }

    inline UniqueUSBid getUniqueUSBDeviceID() const { return uniqueUSBdeviceID; }
    static UniqueUSBid computeUSBdeviceID( libusb_device *device );

    inline const DSOModel *getModel() const { return model; }
    inline void overwriteInPacketLength(unsigned len) { inPacketLength = len; }

  protected:
//     int claimInterface(const libusb_interface_descriptor *interfaceDescriptor, int endpointOut, int endPointIn);
//     int claimInterface(const libusb_interface_descriptor *interfaceDescriptor, int endPointIn);
    int claimInterface( const libusb_interface_descriptor *interfaceDescriptor );

    // Device model data
    DSOModel* model;

    // Libusb specific variables
    struct libusb_device_descriptor descriptor;
    libusb_device *device; 
    libusb_device_handle *handle = nullptr;
    unsigned findIteration;
    const UniqueUSBid uniqueUSBdeviceID;
    int nInterface;
    unsigned outPacketLength; 
    unsigned inPacketLength;  

  signals:
    void deviceDisconnected(); 
};