File: usbdevicedetector.cpp

package info (click to toggle)
qflipper 1.3.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 12,320 kB
  • sloc: cpp: 18,500; sh: 247; ansic: 191; xml: 38; python: 14; makefile: 5
file content (225 lines) | stat: -rw-r--r-- 7,068 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
#include "usbdevicedetector.h"

#include <libusb.h>

#include <QDebug>
#include <QTimer>
#include <QThread>
#include <QLoggingCategory>

Q_LOGGING_CATEGORY(LOG_DETECTOR, "USB")

static int libusbHotplugCallback(libusb_context *ctx, libusb_device *dev, libusb_hotplug_event event, void *user_data);
#if defined(LIBUSB_API_VERSION) && (LIBUSB_API_VERSION >= 0x01000107)
static void libusbLogCallback(libusb_context *ctx, libusb_log_level logLevel, const char *text);
#endif

USBDeviceDetector::USBDeviceDetector(QObject *parent):
    QObject(parent),
    m_timer(new QTimer(this))
{
    connect(m_timer, &QTimer::timeout, this, &USBDeviceDetector::processEvents);
    libusb_init(nullptr);
#if defined(LIBUSB_API_VERSION) && (LIBUSB_API_VERSION >= 0x01000107)
    libusb_set_log_cb(nullptr, libusbLogCallback, LIBUSB_LOG_CB_GLOBAL);
#endif
}

USBDeviceDetector::~USBDeviceDetector()
{
    libusb_exit(nullptr);
}

void USBDeviceDetector::setLogLevel(int logLevel)
{
#if defined(LIBUSB_API_VERSION) && (LIBUSB_API_VERSION >= 0x01000107)
    if(logLevel> LIBUSB_LOG_LEVEL_DEBUG) {
        qCDebug(LOG_DETECTOR) << "Invalid log level:" << logLevel;
        return;
    }

    libusb_set_option(nullptr, LIBUSB_OPTION_LOG_LEVEL, logLevel);
#else
    Q_UNUSED(logLevel)
    qCDebug(LOG_DETECTOR) << "Setting log level is supported with libusb >= 1.0.23";
#endif
}

bool USBDeviceDetector::setWantedDevices(const QList<USBDeviceInfo> &wantedList)
{
    if(!libusb_has_capability(LIBUSB_CAP_HAS_HOTPLUG)) {
        qCDebug(LOG_DETECTOR) << "Failed to get device descriptor";
        return false;
    }

    m_timer->stop();

    for(const auto &info : wantedList) {
        const auto events = libusb_hotplug_event(LIBUSB_HOTPLUG_EVENT_DEVICE_ARRIVED | LIBUSB_HOTPLUG_EVENT_DEVICE_LEFT);
        const auto err = libusb_hotplug_register_callback(nullptr, events, LIBUSB_HOTPLUG_ENUMERATE, info.vendorID(),
                                                          info.productID(), LIBUSB_HOTPLUG_MATCH_ANY, libusbHotplugCallback, this, nullptr);
        if(err) {
            qCDebug(LOG_DETECTOR) << "Failed to register hotplug callback";
            return false;
        }
    }

    m_timer->start(100);
    return true;
}

void USBDeviceDetector::registerDevice(const USBDeviceInfo &deviceInfo)
{
    QTimer::singleShot(0, this, [=]() {
        if(m_devices.contains(deviceInfo)) {
            return;
        }

        m_devices.append(fillDeviceInfo(deviceInfo));
        emit devicePluggedIn(m_devices.last());
    });
}

void USBDeviceDetector::unregisterDevice(const USBDeviceInfo &deviceInfo)
{
    if(!m_devices.contains(deviceInfo)) {
        return;
    }

    m_devices.removeOne(deviceInfo);
    emit deviceUnplugged(deviceInfo);
}

void USBDeviceDetector::processEvents()
{
    struct timeval timeout = {0, 10000};
    libusb_handle_events_timeout_completed(nullptr, &timeout, nullptr);
}

USBDeviceInfo USBDeviceDetector::fillDeviceInfo(const USBDeviceInfo &deviceInfo)
{
    auto numRetries = 20;
    auto *dev = (libusb_device*)deviceInfo.backendData().value<void*>();

    USBDeviceInfo newinfo = deviceInfo;

    do {
        libusb_device_descriptor desc = {};
        struct libusb_device_handle *handle = nullptr;
        unsigned char buf[1024];
        int status;

        do {
            status = libusb_get_device_descriptor(dev, &desc);
            if(status != LIBUSB_SUCCESS) {
                qCDebug(LOG_DETECTOR) << "Failed to get device descriptor:" << libusb_strerror((libusb_error)status);
                break;
            }

            status = libusb_open(dev, &handle);
            if(status != LIBUSB_SUCCESS) {
                qCDebug(LOG_DETECTOR) << "Failed to open device:" << libusb_strerror((libusb_error)status);
                break;
            }

            status = libusb_get_string_descriptor_ascii(handle, desc.iManufacturer, buf, sizeof(buf));
            if(status < 0) {
                qCDebug(LOG_DETECTOR) << "Failed to get manufacturer string descriptor:" << libusb_strerror((libusb_error)status);
                break;
            }

            newinfo.setManufacturer(QString::fromLocal8Bit((const char*)buf));

            status = libusb_get_string_descriptor_ascii(handle, desc.iProduct, buf, sizeof(buf));
            if(status < 0) {
                qCDebug(LOG_DETECTOR) << "Failed to get product string descriptor:" << libusb_strerror((libusb_error)status);
                break;
            }

            newinfo.setProductDescription(QString::fromLocal8Bit((const char*)buf));

            status = libusb_get_string_descriptor_ascii(handle, desc.iSerialNumber, buf, sizeof(buf));
            if(status < 0) {
                qCDebug(LOG_DETECTOR) << "Failed to get device serial number:" << libusb_strerror((libusb_error)status);
                break;
            }

            newinfo.setSerialNumber(QString::fromLocal8Bit((const char*)buf));
        } while(false);

        if(handle) {
            libusb_close(handle);
        }

        if(status >= 0) {
            break;
        }

        QThread::msleep(20);

    } while(--numRetries);

    return newinfo;
}

static int libusbHotplugCallback(libusb_context *ctx, libusb_device *dev, libusb_hotplug_event event, void *user_data) {
    Q_UNUSED(ctx)

    auto numRetries = 20;
    auto *detector = (USBDeviceDetector*)user_data;

    libusb_device_descriptor desc = {};
    int status;

    do {
        status = libusb_get_device_descriptor(dev, &desc);
        if((status == LIBUSB_SUCCESS) && (desc.idVendor != 0) && (desc.idProduct != 0)) {
            break;
        }

        QThread::msleep(20);

    } while(--numRetries);

    if(numRetries == 0) {
        if(status != LIBUSB_SUCCESS) {
            qCDebug(LOG_DETECTOR) << "Failed to get device descriptor:" << libusb_strerror((libusb_error)status);
        } else {
            qCDebug(LOG_DETECTOR) << "Device descriptor received, but is invalid";
        }
        return 0;
    }

    const auto info = USBDeviceInfo(desc.idVendor, desc.idProduct).withBackendData(QVariant::fromValue((void*)dev));

    if(event == LIBUSB_HOTPLUG_EVENT_DEVICE_ARRIVED) {
        detector->registerDevice(info);
    } else if(event == LIBUSB_HOTPLUG_EVENT_DEVICE_LEFT) {
        detector->unregisterDevice(info);
    } else {
        qCDebug(LOG_DETECTOR) << "Unhandled libusb event";
    }

    return 0;
}

#if defined(LIBUSB_API_VERSION) && (LIBUSB_API_VERSION >= 0x01000107)
static void libusbLogCallback(libusb_context *ctx, libusb_log_level logLevel, const char *text) {
    Q_UNUSED(ctx)

    static const QStringList logPrefix = {
        QStringLiteral("NONE"),
        QStringLiteral("ERR"),
        QStringLiteral("WRN"),
        QStringLiteral("INF"),
        QStringLiteral("DBG"),
    };

    if(logLevel >= logPrefix.size()) {
        qCDebug(LOG_DETECTOR) << "Invalid log level:" << logLevel;
        return;
    }

    qCDebug(LOG_DETECTOR).noquote() << QStringLiteral("[%1]").arg(logPrefix[logLevel]) << QString::fromLatin1(text, strlen(text) - 1);
}
#endif