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 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320
|
// SPDX-License-Identifier: BSD-3-Clause
#include <sys/types.h>
#include <errno.h>
#include <fcntl.h>
#include <stdbool.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <libusb.h>
#include "oscompat.h"
#include "qdl.h"
#define DEFAULT_OUT_CHUNK_SIZE (1024 * 1024)
struct qdl_device_usb {
struct qdl_device base;
struct libusb_device_handle *usb_handle;
int in_ep;
int out_ep;
size_t in_maxpktsize;
size_t out_maxpktsize;
size_t out_chunk_size;
};
/*
* libusb commit f0cce43f882d ("core: Fix definition and use of enum
* libusb_transfer_type") split transfer type and endpoint transfer types.
* Provide an alias in order to make the code compile with the old (non-split)
* definition.
*/
#ifndef LIBUSB_ENDPOINT_TRANSFER_TYPE_BULK
#define LIBUSB_ENDPOINT_TRANSFER_TYPE_BULK LIBUSB_TRANSFER_TYPE_BULK
#endif
static bool usb_match_usb_serial(struct libusb_device_handle *handle, const char *serial,
const struct libusb_device_descriptor *desc)
{
char buf[128];
char *p;
int ret;
/* If no serial is requested, consider everything a match */
if (!serial)
return true;
ret = libusb_get_string_descriptor_ascii(handle, desc->iProduct, (unsigned char *)buf, sizeof(buf));
if (ret < 0) {
warnx("failed to read iProduct descriptor: %s", libusb_strerror(ret));
return false;
}
p = strstr(buf, "_SN:");
if (!p)
return false;
p += strlen("_SN:");
p[strcspn(p, " _")] = '\0';
return strcmp(p, serial) == 0;
}
static int usb_try_open(libusb_device *dev, struct qdl_device_usb *qdl, const char *serial)
{
const struct libusb_endpoint_descriptor *endpoint;
const struct libusb_interface_descriptor *ifc;
struct libusb_config_descriptor *config;
struct libusb_device_descriptor desc;
struct libusb_device_handle *handle;
size_t out_size;
size_t in_size;
uint8_t type;
int ret;
int out;
int in;
int k;
int l;
ret = libusb_get_device_descriptor(dev, &desc);
if (ret < 0) {
warnx("failed to get USB device descriptor");
return -1;
}
/* Consider only devices with vid 0x0506 and known product id */
if (desc.idVendor != 0x05c6)
return 0;
if (desc.idProduct != 0x9008 && desc.idProduct != 0x900e && desc.idProduct != 0x901d)
return 0;
ret = libusb_get_active_config_descriptor(dev, &config);
if (ret < 0) {
warnx("failed to acquire USB device's active config descriptor");
return -1;
}
for (k = 0; k < config->bNumInterfaces; k++) {
ifc = config->interface[k].altsetting;
in = -1;
out = -1;
in_size = 0;
out_size = 0;
for (l = 0; l < ifc->bNumEndpoints; l++) {
endpoint = &ifc->endpoint[l];
type = endpoint->bmAttributes & LIBUSB_TRANSFER_TYPE_MASK;
if (type != LIBUSB_ENDPOINT_TRANSFER_TYPE_BULK)
continue;
if (endpoint->bEndpointAddress & LIBUSB_ENDPOINT_IN) {
in = endpoint->bEndpointAddress;
in_size = endpoint->wMaxPacketSize;
} else {
out = endpoint->bEndpointAddress;
out_size = endpoint->wMaxPacketSize;
}
}
if (ifc->bInterfaceClass != 0xff)
continue;
if (ifc->bInterfaceSubClass != 0xff)
continue;
/* bInterfaceProtocol of 0xff, 0x10 and 0x11 has been seen */
if (ifc->bInterfaceProtocol != 0xff &&
ifc->bInterfaceProtocol != 16 &&
ifc->bInterfaceProtocol != 17)
continue;
ret = libusb_open(dev, &handle);
if (ret < 0) {
warnx("unable to open USB device");
continue;
}
if (!usb_match_usb_serial(handle, serial, &desc)) {
libusb_close(handle);
continue;
}
libusb_detach_kernel_driver(handle, ifc->bInterfaceNumber);
ret = libusb_claim_interface(handle, ifc->bInterfaceNumber);
if (ret < 0) {
warnx("failed to claim USB interface");
libusb_close(handle);
continue;
}
qdl->usb_handle = handle;
qdl->in_ep = in;
qdl->out_ep = out;
qdl->in_maxpktsize = in_size;
qdl->out_maxpktsize = out_size;
if (qdl->out_chunk_size && qdl->out_chunk_size % out_size) {
ux_err("WARNING: requested out-chunk-size must be multiple of the device's wMaxPacketSize %ld, using %ld\n",
out_size, out_size);
qdl->out_chunk_size = out_size;
} else if (!qdl->out_chunk_size) {
qdl->out_chunk_size = DEFAULT_OUT_CHUNK_SIZE;
}
ux_debug("USB: using out-chunk-size of %ld\n", qdl->out_chunk_size);
break;
}
libusb_free_config_descriptor(config);
return !!qdl->usb_handle;
}
static int usb_open(struct qdl_device *qdl, const char *serial)
{
struct libusb_device **devs;
struct libusb_device *dev;
struct qdl_device_usb *qdl_usb = container_of(qdl, struct qdl_device_usb, base);
bool wait_printed = false;
bool found = false;
ssize_t n;
int ret;
int i;
ret = libusb_init(NULL);
if (ret < 0)
err(1, "failed to initialize libusb");
for (;;) {
n = libusb_get_device_list(NULL, &devs);
if (n < 0)
err(1, "failed to list USB devices");
for (i = 0; devs[i]; i++) {
dev = devs[i];
ret = usb_try_open(dev, qdl_usb, serial);
if (ret == 1) {
found = true;
break;
}
}
libusb_free_device_list(devs, 1);
if (found)
return 0;
if (!wait_printed) {
ux_info("Waiting for EDL device\n");
wait_printed = true;
}
usleep(250000);
}
return -1;
}
static void usb_close(struct qdl_device *qdl)
{
struct qdl_device_usb *qdl_usb = container_of(qdl, struct qdl_device_usb, base);
libusb_close(qdl_usb->usb_handle);
libusb_exit(NULL);
}
static int usb_read(struct qdl_device *qdl, void *buf, size_t len, unsigned int timeout)
{
struct qdl_device_usb *qdl_usb = container_of(qdl, struct qdl_device_usb, base);
int actual;
int ret;
ret = libusb_bulk_transfer(qdl_usb->usb_handle, qdl_usb->in_ep, buf, len, &actual, timeout);
if (ret != 0 && ret != LIBUSB_ERROR_TIMEOUT)
return -EIO;
if (ret == LIBUSB_ERROR_TIMEOUT && actual == 0)
return -ETIMEDOUT;
/* If what we read equals the endpoint's Max Packet Size, consume the ZLP explicitly */
if (len == actual && !(actual % qdl_usb->in_maxpktsize)) {
ret = libusb_bulk_transfer(qdl_usb->usb_handle, qdl_usb->in_ep,
NULL, 0, NULL, timeout);
if (ret)
warnx("Unable to read ZLP: %s", libusb_strerror(ret));
}
return actual;
}
static int usb_write(struct qdl_device *qdl, const void *buf, size_t len, unsigned int timeout)
{
unsigned char *data = (unsigned char *)buf;
struct qdl_device_usb *qdl_usb = container_of(qdl, struct qdl_device_usb, base);
unsigned int count = 0;
size_t len_orig = len;
int actual;
int xfer;
int ret;
while (len > 0) {
xfer = (len > qdl_usb->out_chunk_size) ? qdl_usb->out_chunk_size : len;
ret = libusb_bulk_transfer(qdl_usb->usb_handle, qdl_usb->out_ep, data,
xfer, &actual, timeout);
if (ret != 0 && ret != LIBUSB_ERROR_TIMEOUT) {
warnx("bulk write failed: %s", libusb_strerror(ret));
return -EIO;
}
if (ret == LIBUSB_ERROR_TIMEOUT && actual == 0)
return -ETIMEDOUT;
count += actual;
len -= actual;
data += actual;
}
if (len_orig % qdl_usb->out_maxpktsize == 0) {
ret = libusb_bulk_transfer(qdl_usb->usb_handle, qdl_usb->out_ep, NULL,
0, &actual, timeout);
if (ret < 0)
return -EIO;
}
return count;
}
static void usb_set_out_chunk_size(struct qdl_device *qdl, long size)
{
struct qdl_device_usb *qdl_usb = container_of(qdl, struct qdl_device_usb, base);
qdl_usb->out_chunk_size = size;
}
struct qdl_device *usb_init(void)
{
struct qdl_device *qdl = malloc(sizeof(struct qdl_device_usb));
if (!qdl)
return NULL;
memset(qdl, 0, sizeof(struct qdl_device_usb));
qdl->dev_type = QDL_DEVICE_USB;
qdl->open = usb_open;
qdl->read = usb_read;
qdl->write = usb_write;
qdl->close = usb_close;
qdl->set_out_chunk_size = usb_set_out_chunk_size;
qdl->max_payload_size = 1048576;
return qdl;
}
|