src/serial_hid.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2017-2019 Gerhard Sittig <gerhard.sittig@gmx.net>
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #include "config.h"
  21 #include <glib.h>
  22 #ifdef HAVE_LIBHIDAPI
  23 #include <hidapi.h>
  24 #endif
  25 #include <libsigrok/libsigrok.h>
  26 #include "libsigrok-internal.h"
  27 #include "serial_hid.h"
  28 #include <stdlib.h>
  29 #include <string.h>
  30 #ifdef G_OS_WIN32
  31 #include <windows.h> /* for HANDLE */
  32 #endif
  33
  34 /** @cond PRIVATE */
  35 #define LOG_PREFIX "serial-hid"
  36 /** @endcond */
  37
  38 #ifdef HAVE_SERIAL_COMM
  39
  40 /**
  41  * @file
  42  *
  43  * Serial port handling, HIDAPI library specific support code.
  44  */
  45
  46 /**
  47  * @defgroup grp_serial_hid Serial port handling, HID group
  48  *
  49  * Make serial-over-HID communication appear like a regular serial port.
  50  *
  51  * @{
  52  */
  53
  54 #ifdef HAVE_LIBHIDAPI
  55 /* {{{ helper routines */
  56
  57 /* Strip off parity bits for "odd" data bit counts like in 7e1 frames. */
  58 static void ser_hid_mask_databits(struct sr_serial_dev_inst *serial,
  59         uint8_t *data, size_t len)
  60 {
  61         uint32_t mask32;
  62         uint8_t mask;
  63         size_t idx;
  64
  65         if ((serial->comm_params.data_bits % 8) == 0)
  66                 return;
  67
  68         mask32 = (1UL << serial->comm_params.data_bits) - 1;
  69         mask = mask32 & 0xff;
  70         for (idx = 0; idx < len; idx++)
  71                 data[idx] &= mask;
  72 }
  73
  74 /* }}} */
  75 /* {{{ open/close/list/find HIDAPI connection, exchange HID requests and data */
  76
  77 /*
  78  * Convert a HIDAPI path (which depends on the target platform, and may
  79  * depend on one of several available API variants on that platform) to
  80  * something that is usable as a "port name" in conn= specs.
  81  *
  82  * Since conn= is passed with -d where multiple options (among them conn=)
  83  * are separated by colons, port names themselves cannot contain colons.
  84  *
  85  * Just replace colons by a period in the simple case (Linux platform,
  86  * hidapi-libusb implementation, bus/address/interface). Prefix the
  87  * HIDAPI path in the complex cases (Linux hidapi-hidraw, Windows, Mac).
  88  * Paths with colons outside of libusb based implementations are unhandled
  89  * here, but were not yet seen on any sigrok supported platform either.
  90  * So just reject them.
  91  */
  92 static char *get_hidapi_path_copy(const char *path)
  93 {
  94         static const char *accept = "0123456789abcdefABCDEF:";
  95         static const char *keep = "0123456789abcdefABCDEF";
  96
  97         int has_colon;
  98         int is_hex_colon;
  99         char *name;
 100
 101         has_colon = strchr(path, ':') != NULL;
 102         is_hex_colon = strspn(path, accept) == strlen(path);
 103         if (has_colon && !is_hex_colon) {
 104                 sr_err("Unsupported HIDAPI path format: %s", path);
 105                 return NULL;
 106         }
 107         if (is_hex_colon) {
 108                 name = g_strdup_printf("%s%s", SER_HID_USB_PREFIX, path);
 109                 g_strcanon(name + strlen(SER_HID_USB_PREFIX), keep, '.');
 110         } else {
 111                 name = g_strdup_printf("%s%s", SER_HID_RAW_PREFIX, path);
 112         }
 113
 114         return name;
 115 }
 116
 117 /*
 118  * Undo the port name construction that was done during scan. Extract
 119  * the HIDAPI path from a conn= input spec (the part after the hid/
 120  * prefix and chip type).
 121  *
 122  * Strip off the "raw" prefix, or undo colon substitution. See @ref
 123  * get_hidapi_path_copy() for details.
 124  */
 125 static const char *extract_hidapi_path(char *buffer)
 126 {
 127         static const char *keep = "0123456789abcdefABCDEF:";
 128
 129         const char *p;
 130
 131         p = buffer;
 132         if (!p || !*p)
 133                 return NULL;
 134
 135         if (strncmp(p, SER_HID_RAW_PREFIX, strlen(SER_HID_RAW_PREFIX)) == 0) {
 136                 p += strlen(SER_HID_RAW_PREFIX);
 137                 return p;
 138         }
 139         if (strncmp(p, SER_HID_USB_PREFIX, strlen(SER_HID_USB_PREFIX)) == 0) {
 140                 p += strlen(SER_HID_USB_PREFIX);
 141                 g_strcanon(buffer, keep, ':');
 142                 return p;
 143         }
 144
 145         return NULL;
 146 }
 147
 148 /*
 149  * The HIDAPI specific list() callback, invoked by common serial.c code.
 150  * Enumerate all devices (no VID:PID is involved).
 151  * Invoke an 'append' callback with "path" and "name".
 152  */
 153 static GSList *ser_hid_hidapi_list(GSList *list, sr_ser_list_append_t append)
 154 {
 155         struct hid_device_info *devs, *curdev;
 156         const char *chipname;
 157         char *path, *name;
 158         wchar_t *manuf, *prod, *serno;
 159         uint16_t vid, pid;
 160         GString *desc;
 161
 162         devs = hid_enumerate(0x0000, 0x0000);
 163         for (curdev = devs; curdev; curdev = curdev->next) {
 164                 /*
 165                  * Determine the chip name from VID:PID (if it's one of
 166                  * the supported types with an ID known to us).
 167                  */
 168                 vid = curdev->vendor_id;
 169                 pid = curdev->product_id;
 170                 sr_dbg("DIAG: hidapi enum, vid:pid %04x:%04x, path %s\n",
 171                         curdev->vendor_id, curdev->product_id, curdev->path);
 172                 chipname = ser_hid_chip_find_name_vid_pid(vid, pid);
 173                 if (!chipname)
 174                         chipname = "<chip>";
 175
 176                 /*
 177                  * Prefix port names such that open() calls with this
 178                  * conn= spec will end up here and contain all details
 179                  * that are essential for processing.
 180                  */
 181                 path = get_hidapi_path_copy(curdev->path);
 182                 if (!path)
 183                         continue;
 184                 name = g_strdup_printf("%s/%s/%s",
 185                         SER_HID_CONN_PREFIX, chipname, path);
 186                 g_free(path);
 187
 188                 /*
 189                  * Print whatever information was available. Construct
 190                  * the description text from pieces. Absence of fields
 191                  * is not fatal, we have seen perfectly usable cables
 192                  * that only had a VID and PID (permissions were not an
 193                  * issue).
 194                  */
 195                 manuf = curdev->manufacturer_string;
 196                 prod = curdev->product_string;
 197                 serno = curdev->serial_number;
 198                 vid = curdev->vendor_id;
 199                 pid = curdev->product_id;
 200                 desc = g_string_sized_new(128);
 201                 g_string_append_printf(desc, "HID");
 202                 if (manuf)
 203                         g_string_append_printf(desc, " %ls", manuf);
 204                 if (prod)
 205                         g_string_append_printf(desc, " %ls", prod);
 206                 if (serno)
 207                         g_string_append_printf(desc, " %ls", serno);
 208                 if (vid && pid)
 209                         g_string_append_printf(desc, " %04hx:%04hx", vid, pid);
 210                 list = append(list, name, desc->str);
 211                 g_string_free(desc, TRUE);
 212                 g_free(name);
 213         }
 214         hid_free_enumeration(devs);
 215
 216         return list;
 217 }
 218
 219 /*
 220  * The HIDAPI specific find_usb() callback, invoked by common serial.c code.
 221  * Enumerate devices for the specified VID:PID pair.
 222  * Invoke an "append" callback with 'path' for the device.
 223  */
 224 static GSList *ser_hid_hidapi_find_usb(GSList *list, sr_ser_find_append_t append,
 225                 uint16_t vendor_id, uint16_t product_id)
 226 {
 227         struct hid_device_info *devs, *curdev;
 228         const char *name;
 229
 230         devs = hid_enumerate(vendor_id, product_id);
 231         for (curdev = devs; curdev; curdev = curdev->next) {
 232                 name = curdev->path;
 233                 list = append(list, name);
 234         }
 235         hid_free_enumeration(devs);
 236
 237         return list;
 238 }
 239
 240 /* Get the serial number of a device specified by path. */
 241 static int ser_hid_hidapi_get_serno(const char *path, char *buf, size_t blen)
 242 {
 243         char *usbpath;
 244         const char *hidpath;
 245         hid_device *dev;
 246         wchar_t *serno_wch;
 247         int rc;
 248
 249         if (!path || !*path)
 250                 return SR_ERR_ARG;
 251         usbpath = g_strdup(path);
 252         hidpath = extract_hidapi_path(usbpath);
 253         dev = hidpath ? hid_open_path(hidpath) : NULL;
 254         g_free(usbpath);
 255         if (!dev)
 256                 return SR_ERR_IO;
 257
 258         serno_wch = g_malloc0(blen * sizeof(*serno_wch));
 259         rc = hid_get_serial_number_string(dev, serno_wch, blen - 1);
 260         hid_close(dev);
 261         if (rc != 0) {
 262                 g_free(serno_wch);
 263                 return SR_ERR_IO;
 264         }
 265
 266         snprintf(buf, blen, "%ls", serno_wch);
 267         g_free(serno_wch);
 268
 269         return SR_OK;
 270 }
 271
 272 /* Get the VID and PID of a device specified by path. */
 273 static int ser_hid_hidapi_get_vid_pid(const char *path,
 274         uint16_t *vid, uint16_t *pid)
 275 {
 276 #if 0
 277         /*
 278          * Bummer! It would have been most reliable to just open the
 279          * device by the specified path, and grab its VID:PID. But
 280          * there is no way to get these parameters, neither in the
 281          * HIDAPI itself, nor when cheating and reaching behind the API
 282          * and accessing the libusb handle in dirty ways. :(
 283          */
 284         hid_device *dev;
 285
 286         if (!path || !*path)
 287                 return SR_ERR_ARG;
 288         dev = hid_open_path(path);
 289         if (!dev)
 290                 return SR_ERR_IO;
 291         if (vid)
 292                 *vid = dev->vendor_id;
 293         if (pid)
 294                 *pid = dev->product_id;
 295         hid_close(dev);
 296
 297         return SR_OK;
 298 #else
 299         /*
 300          * The fallback approach. Enumerate all devices, compare the
 301          * enumerated USB path, and grab the VID:PID. Unfortunately the
 302          * caller can provide path specs that differ from enumerated
 303          * paths yet mean the same (address the same device). This needs
 304          * more attention. Though the specific format of the path and
 305          * its meaning are said to be OS specific, which is why we may
 306          * not assume anything about it...
 307          */
 308         char *usbpath;
 309         const char *hidpath;
 310         struct hid_device_info *devs, *dev;
 311         int found;
 312
 313         usbpath = g_strdup(path);
 314         hidpath = extract_hidapi_path(usbpath);
 315         if (!hidpath) {
 316                 g_free(usbpath);
 317                 return SR_ERR_NA;
 318         }
 319
 320         devs = hid_enumerate(0x0000, 0x0000);
 321         found = 0;
 322         for (dev = devs; dev; dev = dev->next) {
 323                 if (strcmp(dev->path, hidpath) != 0)
 324                         continue;
 325                 if (vid)
 326                         *vid = dev->vendor_id;
 327                 if (pid)
 328                         *pid = dev->product_id;
 329                 found = 1;
 330                 break;
 331         }
 332         hid_free_enumeration(devs);
 333         g_free(usbpath);
 334
 335         return found ? SR_OK : SR_ERR_NA;
 336 #endif
 337 }
 338
 339 static int ser_hid_hidapi_open_dev(struct sr_serial_dev_inst *serial)
 340 {
 341         hid_device *hid_dev;
 342
 343         if (!serial->usb_path || !*serial->usb_path)
 344                 return SR_ERR_ARG;
 345
 346         /*
 347          * A path is available, assume that either a GUI or a
 348          * user has copied what a previous listing has provided.
 349          * Or a scan determined a matching device's USB path.
 350          */
 351         if (!serial->hid_path)
 352                 serial->hid_path = extract_hidapi_path(serial->usb_path);
 353         hid_dev = hid_open_path(serial->hid_path);
 354         sr_dbg("DBG: %s(), hid_open_path(\"%s\") => %p", __func__,
 355                         serial->hid_path, hid_dev);
 356         if (!hid_dev) {
 357                 serial->hid_path = NULL;
 358                 return SR_ERR_IO;
 359         }
 360
 361         serial->hid_dev = hid_dev;
 362         hid_set_nonblocking(hid_dev, 1);
 363
 364         return SR_OK;
 365 }
 366
 367 static void ser_hid_hidapi_close_dev(struct sr_serial_dev_inst *serial)
 368 {
 369         if (serial->hid_dev) {
 370                 hid_close(serial->hid_dev);
 371                 serial->hid_dev = NULL;
 372                 serial->hid_path = NULL;
 373         }
 374         g_slist_free_full(serial->hid_source_args, g_free);
 375         serial->hid_source_args = NULL;
 376 }
 377
 378 struct hidapi_source_args_t {
 379         /* Application callback. */
 380         sr_receive_data_callback cb;
 381         void *cb_data;
 382         /* The serial device, to store RX data. */
 383         struct sr_serial_dev_inst *serial;
 384 };
 385
 386 /*
 387  * Gets periodically invoked by the glib main loop. "Drives" (checks)
 388  * progress of USB communication, and invokes the application's callback
 389  * which processes RX data (when some has become available), as well as
 390  * handles application level timeouts.
 391  */
 392 static int hidapi_source_cb(int fd, int revents, void *cb_data)
 393 {
 394         struct hidapi_source_args_t *args;
 395         uint8_t rx_buf[SER_HID_CHUNK_SIZE];
 396         int rc;
 397
 398         sr_dbg("DBG: %s() fd %d, evt 0x%x, data %p.", __func__, fd, revents, cb_data);
 399         args = cb_data;
 400
 401         /*
 402          * Drain receive data which the chip might have pending. This is
 403          * "a copy" of the "background part" of ser_hid_read(), without
 404          * the timeout support code, and not knowing how much data the
 405          * application is expecting.
 406          */
 407         do {
 408                 rc = args->serial->hid_chip_funcs->read_bytes(args->serial,
 409                                 rx_buf, sizeof(rx_buf), 0);
 410                 if (rc > 0) {
 411                         sr_dbg("DBG: %s() queueing %d bytes.", __func__, rc);
 412                         ser_hid_mask_databits(args->serial, rx_buf, rc);
 413                         sr_ser_queue_rx_data(args->serial, rx_buf, rc);
 414                 }
 415         } while (rc > 0);
 416
 417         /*
 418          * When RX data became available (now or earlier), pass this
 419          * condition to the application callback. Always periodically
 420          * run the application callback, since it handles timeouts and
 421          * might carry out other tasks as well like signalling progress.
 422          */
 423         if (sr_ser_has_queued_data(args->serial))
 424                 revents |= G_IO_IN;
 425         rc = args->cb(fd, revents, args->cb_data);
 426         sr_dbg("DBG: %s() rc %d.", __func__, rc);
 427
 428         return rc;
 429 }
 430
 431 #define WITH_MAXIMUM_TIMEOUT_VALUE      10
 432 static int ser_hid_hidapi_setup_source_add(struct sr_session *session,
 433         struct sr_serial_dev_inst *serial, int events, int timeout,
 434         sr_receive_data_callback cb, void *cb_data)
 435 {
 436         struct hidapi_source_args_t *args;
 437         int rc;
 438
 439         sr_dbg("DBG: %s() evt 0x%x, to %d.", __func__, events, timeout);
 440         (void)events;
 441
 442         /* Optionally enforce a minimum poll period. */
 443         if (WITH_MAXIMUM_TIMEOUT_VALUE && timeout > WITH_MAXIMUM_TIMEOUT_VALUE)
 444                 timeout = WITH_MAXIMUM_TIMEOUT_VALUE;
 445
 446         /* Allocate status container for background data reception. */
 447         args = g_malloc0(sizeof(*args));
 448         args->cb = cb;
 449         args->cb_data = cb_data;
 450         args->serial = serial;
 451
 452         /*
 453          * Have a periodic timer installed. Register the allocated block
 454          * with the serial device, since the GSource's finalizer won't
 455          * free the memory, and we haven't bothered to create a custom
 456          * HIDAPI specific GSource.
 457          */
 458         rc = sr_session_source_add(session, -1, events, timeout,
 459                         hidapi_source_cb, args);
 460         sr_dbg("DBG: %s() added, rc %d.", __func__, rc);
 461         if (rc != SR_OK) {
 462                 g_free(args);
 463                 return rc;
 464         }
 465         serial->hid_source_args = g_slist_append(serial->hid_source_args, args);
 466
 467         return SR_OK;
 468 }
 469
 470 static int ser_hid_hidapi_setup_source_remove(struct sr_session *session,
 471         struct sr_serial_dev_inst *serial)
 472 {
 473         (void)serial;
 474
 475         sr_dbg("DBG: %s().", __func__);
 476         (void)sr_session_source_remove(session, -1);
 477         /*
 478          * Release callback args here already? Can there be more than
 479          * one source registered at any time, given that we pass fd -1
 480          * which is used as the key for the session?
 481          */
 482
 483         return SR_OK;
 484 }
 485
 486 SR_PRIV int ser_hid_hidapi_get_report(struct sr_serial_dev_inst *serial,
 487         uint8_t *data, size_t len)
 488 {
 489         int rc;
 490
 491         rc = hid_get_feature_report(serial->hid_dev, data, len);
 492         if (rc < 0)
 493                 return SR_ERR_IO;
 494
 495         return rc;
 496 }
 497
 498 SR_PRIV int ser_hid_hidapi_set_report(struct sr_serial_dev_inst *serial,
 499         const uint8_t *data, size_t len)
 500 {
 501         int rc;
 502         const wchar_t *err_text;
 503
 504         rc = hid_send_feature_report(serial->hid_dev, data, len);
 505         if (rc < 0) {
 506                 err_text = hid_error(serial->hid_dev);
 507                 sr_dbg("%s() hidapi error: %ls", __func__, err_text);
 508                 return SR_ERR_IO;
 509         }
 510
 511         return rc;
 512 }
 513
 514 SR_PRIV int ser_hid_hidapi_get_data(struct sr_serial_dev_inst *serial,
 515         uint8_t ep, uint8_t *data, size_t len, int timeout)
 516 {
 517         int rc;
 518
 519         (void)ep;
 520
 521         if (timeout)
 522                 rc = hid_read_timeout(serial->hid_dev, data, len, timeout);
 523         else
 524                 rc = hid_read(serial->hid_dev, data, len);
 525         if (rc < 0)
 526                 return SR_ERR_IO;
 527         if (rc == 0)
 528                 return 0;
 529
 530         return rc;
 531 }
 532
 533 SR_PRIV int ser_hid_hidapi_set_data(struct sr_serial_dev_inst *serial,
 534         uint8_t ep, const uint8_t *data, size_t len, int timeout)
 535 {
 536         int rc;
 537
 538         (void)ep;
 539         (void)timeout;
 540
 541         rc = hid_write(serial->hid_dev, data, len);
 542         if (rc < 0)
 543                 return SR_ERR_IO;
 544
 545         return rc;
 546 }
 547
 548 /* }}} */
 549 /* {{{ support for serial-over-HID chips */
 550
 551 static struct ser_hid_chip_functions **chips[SER_HID_CHIP_LAST] = {
 552         [SER_HID_CHIP_UNKNOWN] = NULL,
 553 };
 554
 555 static struct ser_hid_chip_functions *get_hid_chip_funcs(enum ser_hid_chip_t chip)
 556 {
 557         struct ser_hid_chip_functions *funcs;
 558
 559         if (chip >= ARRAY_SIZE(chips))
 560                 return NULL;
 561         if (!chips[chip])
 562                 return NULL;
 563         funcs = *chips[chip];
 564         if (!funcs)
 565                 return NULL;
 566
 567         return funcs;
 568 }
 569
 570 static int ser_hid_setup_funcs(struct sr_serial_dev_inst *serial)
 571 {
 572
 573         if (!serial)
 574                 return -1;
 575
 576         if (serial->hid_chip && !serial->hid_chip_funcs) {
 577                 serial->hid_chip_funcs = get_hid_chip_funcs(serial->hid_chip);
 578                 if (!serial->hid_chip_funcs)
 579                         return -1;
 580         }
 581
 582         return 0;
 583 }
 584
 585 /*
 586  * Takes a pointer to the chip spec with potentially trailing data,
 587  * returns the chip index and advances the spec pointer upon match,
 588  * returns SER_HID_CHIP_UNKNOWN upon mismatch.
 589  */
 590 static enum ser_hid_chip_t ser_hid_chip_find_enum(char **spec_p)
 591 {
 592         gchar *spec;
 593         enum ser_hid_chip_t idx;
 594         struct ser_hid_chip_functions *desc;
 595
 596         if (!spec_p || !*spec_p)
 597                 return SER_HID_CHIP_UNKNOWN;
 598         spec = *spec_p;
 599         if (!*spec)
 600                 return SER_HID_CHIP_UNKNOWN;
 601         for (idx = 0; idx < SER_HID_CHIP_LAST; idx++) {
 602                 desc = get_hid_chip_funcs(idx);
 603                 if (!desc)
 604                         continue;
 605                 if (!desc->chipname)
 606                         continue;
 607                 if (!g_str_has_prefix(spec, desc->chipname))
 608                         continue;
 609                 spec += strlen(desc->chipname);
 610                 *spec_p = spec;
 611                 return idx;
 612         }
 613
 614         return SER_HID_CHIP_UNKNOWN;
 615 }
 616
 617 /* See if we can find a chip name for a VID:PID spec. */
 618 SR_PRIV const char *ser_hid_chip_find_name_vid_pid(uint16_t vid, uint16_t pid)
 619 {
 620         size_t chip_idx;
 621         struct ser_hid_chip_functions *desc;
 622         const struct vid_pid_item *vid_pids;
 623
 624         for (chip_idx = 0; chip_idx < SER_HID_CHIP_LAST; chip_idx++) {
 625                 desc = get_hid_chip_funcs(chip_idx);
 626                 if (!desc)
 627                         continue;
 628                 if (!desc->chipname)
 629                         continue;
 630                 vid_pids = desc->vid_pid_items;
 631                 if (!vid_pids)
 632                         continue;
 633                 while (vid_pids->vid) {
 634                         if (vid_pids->vid == vid && vid_pids->pid == pid) {
 635                                 return desc->chipname;
 636                         }
 637                         vid_pids++;
 638                 }
 639         }
 640
 641         return NULL;
 642 }
 643
 644 static const char *ser_hid_chip_get_text(enum ser_hid_chip_t idx)
 645 {
 646         struct ser_hid_chip_functions *desc;
 647
 648         desc = get_hid_chip_funcs(idx);
 649         if (!desc)
 650                 return NULL;
 651
 652         return desc->chipdesc;
 653 }
 654
 655 /**
 656  * See if a text string is a valid USB path for a HID device.
 657  * @param[in] serial The serial port that is about to get opened.
 658  * @param[in] path The (assumed) USB path specification.
 659  * @return SR_OK upon success, SR_ERR* upon failure.
 660  */
 661 static int try_open_path(struct sr_serial_dev_inst *serial, const char *path)
 662 {
 663         int rc;
 664
 665         serial->usb_path = g_strdup(path);
 666         rc = ser_hid_hidapi_open_dev(serial);
 667         ser_hid_hidapi_close_dev(serial);
 668         g_free(serial->usb_path);
 669         serial->usb_path = NULL;
 670
 671         return rc;
 672 }
 673
 674 /**
 675  * Parse conn= specs for serial over HID communication.
 676  *
 677  * @param[in] serial The serial port that is about to get opened.
 678  * @param[in] spec The caller provided conn= specification.
 679  * @param[out] chip_ref Pointer to a chip type (enum).
 680  * @param[out] path_ref Pointer to a USB path (text string).
 681  * @param[out] serno_ref Pointer to a serial number (text string).
 682  *
 683  * @return 0 upon success, non-zero upon failure. Fills the *_ref output
 684  * values.
 685  *
 686  * @internal
 687  *
 688  * Summary of parsing rules as they are implemented:
 689  * - Insist on the "hid" prefix. Accept "hid" alone without any other
 690  *   additional field.
 691  * - The first field that follows can be a chip spec, yet is optional.
 692  * - Any other field is assumed to be either a USB path or a serial
 693  *   number. There is no point in specifying both of these, as either
 694  *   of them uniquely identifies a device.
 695  *
 696  * Supported formats resulting from these rules:
 697  *   hid[/<chip>]
 698  *   hid[/<chip>]/usb=<bus>.<dev>[.<if>]
 699  *   hid[/<chip>]/raw=<path>    (may contain slashes!)
 700  *   hid[/<chip>]/sn=serno
 701  *
 702  * This routine just parses the conn= spec, which either was provided by
 703  * a user, or may reflect (cite) an item of a previously gathered listing
 704  * (clipboard provided by CLI clients, or selected from a GUI form).
 705  * Another routine will fill in the blanks, and do the cable selection
 706  * when a filter was specified.
 707  *
 708  * Users will want to use short forms when they need to come up with the
 709  * specs by themselves. The "verbose" or seemingly redundant forms (chip
 710  * _and_ path/serno spec) are useful when the cable uses non-standard or
 711  * not-yet-supported VID:PID items when automatic chip detection fails.
 712  */
 713 static int ser_hid_parse_conn_spec(
 714         struct sr_serial_dev_inst *serial, const char *spec,
 715         enum ser_hid_chip_t *chip_ref, char **path_ref, char **serno_ref)
 716 {
 717         const char *p;
 718         enum ser_hid_chip_t chip;
 719         char *path, *serno;
 720         int rc;
 721
 722         if (chip_ref)
 723                 *chip_ref = SER_HID_CHIP_UNKNOWN;
 724         if (path_ref)
 725                 *path_ref = NULL;
 726         if (serno_ref)
 727                 *serno_ref = NULL;
 728         chip = SER_HID_CHIP_UNKNOWN;
 729         path = serno = NULL;
 730
 731         if (!serial || !spec || !*spec)
 732                 return SR_ERR_ARG;
 733         sr_dbg("DBG: %s(), input spec: %s", __func__, spec);
 734         p = spec;
 735
 736         /* The "hid" prefix is mandatory. */
 737         if (!g_str_has_prefix(p, SER_HID_CONN_PREFIX)) {
 738                 sr_dbg("DBG: %s(), not a HID port", __func__);
 739                 return SR_ERR_ARG;
 740         }
 741         p += strlen(SER_HID_CONN_PREFIX);
 742
 743         /*
 744          * Check for prefixed fields, assume chip type spec otherwise.
 745          * Paths and serial numbers "are greedy" (span to the end of
 746          * the input spec). Chip types are optional, and cannot repeat
 747          * multiple times.
 748          */
 749         while (*p) {
 750                 if (*p == '/')
 751                         p++;
 752                 if (!*p)
 753                         break;
 754                 if (g_str_has_prefix(p, SER_HID_USB_PREFIX)) {
 755                         rc = try_open_path(serial, p);
 756                         sr_dbg("DBG: %s(), open usb path %s => rc %d", __func__, p, rc);
 757                         if (rc != SR_OK)
 758                                 return rc;
 759                         path = g_strdup(p);
 760                         p += strlen(p);
 761                 } else if (g_str_has_prefix(p, SER_HID_RAW_PREFIX)) {
 762                         rc = try_open_path(serial, p);
 763                         sr_dbg("DBG: %s(), open raw path %s => rc %d", __func__, p, rc);
 764                         if (rc != SR_OK)
 765                                 return rc;
 766                         path = g_strdup(p);
 767                         p += strlen(p);
 768                 } else if (g_str_has_prefix(p, SER_HID_SNR_PREFIX)) {
 769                         p += strlen(SER_HID_SNR_PREFIX);
 770                         sr_dbg("DBG: %s(), snr %s", __func__, p);
 771                         serno = g_strdup(p);
 772                         p += strlen(p);
 773                 } else if (!chip) {
 774                         char *copy, *endptr;
 775                         const char *name;
 776                         copy = g_strdup(p);
 777                         endptr = copy;
 778                         chip = ser_hid_chip_find_enum(&endptr);
 779                         sr_dbg("DBG: %s(), chip search, %s => %u", __func__, p, chip);
 780                         if (!chip) {
 781                                 g_free(copy);
 782                                 return SR_ERR_ARG;
 783                         }
 784                         p += endptr - copy;
 785                         g_free(copy);
 786                         name = ser_hid_chip_get_text(chip);
 787                         sr_dbg("DBG: %s(), chip %s", __func__, name);
 788                 } else {
 789                         sr_err("unsupported conn= spec %s, error at %s", spec, p);
 790                         return SR_ERR_ARG;
 791                 }
 792                 if (*p == '/')
 793                         p++;
 794                 if (path || serno)
 795                         break;
 796         }
 797
 798         sr_dbg("DBG: %s() done, chip %d, path %s, serno %s", __func__, chip, path, serno);
 799         if (chip_ref)
 800                 *chip_ref = chip;
 801         if (path_ref && path)
 802                 *path_ref = path;
 803         if (serno_ref && serno)
 804                 *serno_ref = serno;
 805
 806         return SR_OK;
 807 }
 808
 809 /* Get and compare serial number. Boolean return value. */
 810 static int check_serno(const char *path, const char *serno_want)
 811 {
 812         char *usb_path;
 813         const char *hid_path;
 814         char serno_got[128];
 815         int rc;
 816
 817         sr_dbg("DBG: %s(\"%s\", \"%s\")", __func__, path, serno_want);
 818
 819         usb_path = g_strdup(path);
 820         hid_path = extract_hidapi_path(usb_path);
 821         rc = ser_hid_hidapi_get_serno(hid_path, serno_got, sizeof(serno_got));
 822         sr_dbg("DBG: %s(), usb %s, hidapi %s => rc %d", __func__, usb_path, hid_path, rc);
 823         g_free(usb_path);
 824         if (rc) {
 825                 sr_dbg("DBG: %s(), could not get serial number", __func__);
 826                 return 0;
 827         }
 828         sr_dbg("DBG: %s(), got serno \"%s\"", __func__, serno_got);
 829
 830         rc = strcmp(serno_got, serno_want) == 0;
 831         sr_dbg("DBG: %s(), return %d", __func__, rc);
 832
 833         return rc;
 834 }
 835
 836 static GSList *append_find(GSList *devs, const char *path)
 837 {
 838         char *copy;
 839
 840         if (!path || !*path)
 841                 return devs;
 842
 843         copy = g_strdup(path);
 844         devs = g_slist_append(devs, copy);
 845
 846         return devs;
 847 }
 848
 849 static GSList *list_paths_for_vids_pids(const struct vid_pid_item *vid_pids)
 850 {
 851         GSList *list;
 852         size_t idx;
 853         uint16_t vid, pid;
 854
 855         list = NULL;
 856         for (idx = 0; /* EMPTY */; idx++) {
 857                 if (!vid_pids) {
 858                         vid = pid = 0;
 859                 } else if (!vid_pids[idx].vid) {
 860                         break;
 861                 } else {
 862                         vid = vid_pids[idx].vid;
 863                         pid = vid_pids[idx].pid;
 864                 }
 865                 sr_dbg("DBG: %s(), searching VID:PID %04hx:%04hx",
 866                                 __func__, vid, pid);
 867                 list = ser_hid_hidapi_find_usb(list, append_find, vid, pid);
 868                 if (!vid_pids)
 869                         break;
 870         }
 871
 872         return list;
 873 }
 874
 875 /**
 876  * Search for a matching USB device for HID communication.
 877  *
 878  * @param[inout] chip The HID chip type (enum).
 879  * @param[inout] usbpath The USB path for the device (string).
 880  * @param[in] serno The serial number to search for.
 881  *
 882  * @retval SR_OK upon success
 883  * @retval SR_ERR_* upon failure.
 884  *
 885  * @internal
 886  *
 887  * This routine fills in blanks which the conn= spec parser left open.
 888  * When not specified yet, the HID chip type gets determined. When a
 889  * serial number was specified, then search the corresponding device.
 890  * Upon completion, the chip type and USB path for the device shall be
 891  * known, as these are essential for subsequent operation.
 892  */
 893 static int ser_hid_chip_search(enum ser_hid_chip_t *chip_ref,
 894         char **path_ref, const char *serno)
 895 {
 896         enum ser_hid_chip_t chip;
 897         char *path;
 898         int have_chip, have_path, have_serno;
 899         struct ser_hid_chip_functions *chip_funcs;
 900         int rc;
 901         int serno_matched;
 902         uint16_t vid, pid;
 903         const char *name;
 904         const struct vid_pid_item *vid_pids;
 905         GSList *list, *matched, *matched2, *tmplist;
 906
 907         if (!chip_ref)
 908                 return SR_ERR_ARG;
 909         chip = *chip_ref;
 910         if (!path_ref)
 911                 return SR_ERR_ARG;
 912         path = *path_ref;
 913         sr_dbg("DBG: %s() enter, chip %d, path %s, serno %s", __func__,
 914                         chip, path, serno ? serno : "<none>");
 915
 916         /*
 917          * Simplify the more complex conditions somewhat by assigning
 918          * to local variables. Handle the easiest conditions first.
 919          * - Either path or serial number can be specified, but not both
 920          *   at the same time.
 921          * - When a USB path is given, immediately see which HID chip
 922          *   the device has, without the need for enumeration.
 923          * - When a serial number is given, enumerate the devices and
 924          *   search for that number. Either enumerate all devices of the
 925          *   specified HID chip type (try the VID:PID pairs that we are
 926          *   aware of), or try all HID devices for unknown chip types.
 927          *   Not finding the serial number is fatal.
 928          * - When no path was found yet, enumerate the devices and pick
 929          *   one of them. Try known VID:PID pairs for a HID chip, or all
 930          *   devices for unknown chips. Make sure to pick a device of a
 931          *   supported chip type if the chip was not specified.
 932          * - Determine the chip type if not yet known. There should be
 933          *   a USB path by now, determined in one of the above blocks.
 934          */
 935         have_chip = (chip != SER_HID_CHIP_UNKNOWN) ? 1 : 0;
 936         have_path = (path && *path) ? 1 : 0;
 937         have_serno = (serno && *serno) ? 1 : 0;
 938         sr_dbg("DBG: %s(), have chip %d, path %d, serno %d", __func__,
 939                         have_chip, have_path, have_serno);
 940         if (have_path && have_serno) {
 941                 sr_err("Unsupported combination of USB path and serno");
 942                 return SR_ERR_ARG;
 943         }
 944         chip_funcs = have_chip ? get_hid_chip_funcs(chip) : NULL;
 945         if (have_chip && !chip_funcs)
 946                 return SR_ERR_NA;
 947         if (have_chip && !chip_funcs->vid_pid_items)
 948                 return SR_ERR_NA;
 949         if (have_path && !have_chip) {
 950                 sr_dbg("DBG: %s(), searching chip for path %s", __func__, path);
 951                 vid = pid = 0;
 952                 rc = ser_hid_hidapi_get_vid_pid(path, &vid, &pid);
 953                 sr_dbg("DBG: %s(), rc %d, VID:PID %04x:%04x", __func__, rc, vid, pid);
 954                 if (rc != SR_OK)
 955                         return rc;
 956                 name = ser_hid_chip_find_name_vid_pid(vid, pid);
 957                 sr_dbg("DBG: %s(), name %s", __func__, name);
 958                 if (!name || !*name)
 959                         return SR_ERR_NA;
 960                 chip = ser_hid_chip_find_enum((char **)&name);
 961                 sr_dbg("DBG: %s(), chip %d", __func__, chip);
 962                 if (chip == SER_HID_CHIP_UNKNOWN)
 963                         return SR_ERR_NA;
 964                 have_chip = 1;
 965         }
 966         if (have_serno) {
 967                 sr_dbg("DBG: %s(), searching path for serno %s", __func__, serno);
 968                 vid_pids = have_chip ? chip_funcs->vid_pid_items : NULL;
 969                 list = list_paths_for_vids_pids(vid_pids);
 970                 sr_dbg("DBG: %s(), vid/pid list for chip type %p", __func__, list);
 971                 if (!list)
 972                         return SR_ERR_NA;
 973                 matched = NULL;
 974                 for (tmplist = list; tmplist; tmplist = tmplist->next) {
 975                         path = get_hidapi_path_copy(tmplist->data);
 976                         sr_dbg("DBG: %s(), checking %s", __func__, path);
 977                         serno_matched = check_serno(path, serno);
 978                         g_free(path);
 979                         if (!serno_matched)
 980                                 continue;
 981                         matched = tmplist;
 982                         break;
 983                 }
 984                 if (!matched)
 985                         return SR_ERR_NA;
 986                 path = g_strdup(matched->data);
 987                 sr_dbg("DBG: %s(), match, path %s", __func__, path);
 988                 have_path = 1;
 989                 g_slist_free_full(list, g_free);
 990         }
 991         if (!have_path) {
 992                 sr_dbg("DBG: %s(), searching path, chip %d", __func__, chip);
 993                 vid_pids = have_chip ? chip_funcs->vid_pid_items : NULL;
 994                 list = list_paths_for_vids_pids(vid_pids);
 995                 if (!list)
 996                         return SR_ERR_NA;
 997                 for (tmplist = list; tmplist; tmplist = tmplist->next) {
 998                         path = tmplist->data;
 999                         sr_dbg("DBG: %s(), path %s", __func__, path);
1000                 }
1001                 matched = matched2 = NULL;
1002                 if (have_chip) {
1003                         /* List already only contains specified chip. */
1004                         matched = list;
1005                         path = matched->data;
1006                         sr_dbg("DBG: %s(), match 1 %s", __func__, path);
1007                         matched2 = list->next;
1008                         if (matched2) {
1009                                 path = matched2->data;
1010                                 sr_dbg("DBG: %s(), match 2 %s", __func__, path);
1011                         }
1012                 }
1013                 /* Works for lists with one or multiple chips. Saves indentation. */
1014                 for (tmplist = list; tmplist; tmplist = tmplist->next) {
1015                         if (have_chip)
1016                                 break;
1017                         path = tmplist->data;
1018                         rc = ser_hid_hidapi_get_vid_pid(path, &vid, &pid);
1019                         if (rc || !ser_hid_chip_find_name_vid_pid(vid, pid))
1020                                 continue;
1021                         if (!matched) {
1022                                 matched = tmplist;
1023                                 sr_dbg("DBG: %s(), match 1 %s", __func__, path);
1024                                 continue;
1025                         }
1026                         if (!matched2) {
1027                                 matched2 = tmplist;
1028                                 sr_dbg("DBG: %s(), match 2 %s", __func__, path);
1029                                 break;
1030                         }
1031                 }
1032                 if (!matched) {
1033                         g_slist_free_full(list, g_free);
1034                         return SR_ERR_NA;
1035                 }
1036                 /*
1037                  * TODO Optionally fail harder, expect users to provide
1038                  * unambiguous cable specs.
1039                  */
1040                 if (matched2)
1041                         sr_info("More than one cable matches, random pick.");
1042                 path = get_hidapi_path_copy(matched->data);
1043                 sr_dbg("DBG: %s(), match, path %s", __func__, path);
1044                 have_path = 1;
1045                 g_slist_free_full(list, g_free);
1046         }
1047         if (have_path && !have_chip) {
1048                 sr_dbg("DBG: %s(), searching chip for path %s", __func__, path);
1049                 vid = pid = 0;
1050                 rc = ser_hid_hidapi_get_vid_pid(path, &vid, &pid);
1051                 sr_dbg("DBG: %s(), rc %d, VID:PID %04x:%04x", __func__, rc, vid, pid);
1052                 if (rc != SR_OK)
1053                         return rc;
1054                 name = ser_hid_chip_find_name_vid_pid(vid, pid);
1055                 sr_dbg("DBG: %s(), name %s", __func__, name);
1056                 if (!name || !*name)
1057                         return SR_ERR_NA;
1058                 chip = ser_hid_chip_find_enum((char **)&name);
1059                 sr_dbg("DBG: %s(), chip %d", __func__, chip);
1060                 if (chip == SER_HID_CHIP_UNKNOWN)
1061                         return SR_ERR_NA;
1062                 have_chip = 1;
1063         }
1064
1065         sr_dbg("DBG: %s() leave, chip %d, path %s", __func__, chip, path);
1066         if (chip_ref)
1067                 *chip_ref = chip;
1068         if (path_ref)
1069                 *path_ref = path;
1070
1071         return SR_OK;
1072 }
1073
1074 /* }}} */
1075 /* {{{ transport methods called by the common serial.c code */
1076
1077 /* See if a serial port's name refers to an HID type. */
1078 SR_PRIV int ser_name_is_hid(struct sr_serial_dev_inst *serial)
1079 {
1080         size_t off;
1081         char sep;
1082
1083         if (!serial)
1084                 return 0;
1085         if (!serial->port || !*serial->port)
1086                 return 0;
1087
1088         /* Accept either "hid" alone, or "hid/" as a prefix. */
1089         if (!g_str_has_prefix(serial->port, SER_HID_CONN_PREFIX))
1090                 return 0;
1091         off = strlen(SER_HID_CONN_PREFIX);
1092         sep = serial->port[off];
1093         if (sep != '\0' && sep != '/')
1094                 return 0;
1095
1096         return 1;
1097 }
1098
1099 static int ser_hid_open(struct sr_serial_dev_inst *serial, int flags)
1100 {
1101         enum ser_hid_chip_t chip;
1102         char *usbpath, *serno;
1103         int rc;
1104
1105         (void)flags;
1106
1107         if (ser_hid_setup_funcs(serial) != 0) {
1108                 sr_err("Cannot determine HID communication library.");
1109                 return SR_ERR_NA;
1110         }
1111
1112         rc = ser_hid_parse_conn_spec(serial, serial->port,
1113                         &chip, &usbpath, &serno);
1114         if (rc != SR_OK)
1115                 return SR_ERR_ARG;
1116
1117         /*
1118          * When a serial number was specified, or when the chip type or
1119          * the USB path were not specified, do a search to determine the
1120          * device's USB path.
1121          */
1122         if (!chip || !usbpath || serno) {
1123                 sr_dbg("DBG: %s(), searching ...", __func__);
1124                 rc = ser_hid_chip_search(&chip, &usbpath, serno);
1125                 if (rc != 0)
1126                         return SR_ERR_NA;
1127         }
1128
1129         /*
1130          * Open the HID device. Only store chip type and device handle
1131          * when open completes successfully.
1132          */
1133         serial->hid_chip = chip;
1134         if (ser_hid_setup_funcs(serial) != 0) {
1135                 sr_err("Cannot determine HID chip specific routines.");
1136                 return SR_ERR_NA;
1137         }
1138         if (usbpath && *usbpath)
1139                 serial->usb_path = usbpath;
1140         if (serno && *serno)
1141                 serial->usb_serno = serno;
1142
1143         rc = ser_hid_hidapi_open_dev(serial);
1144         if (rc) {
1145                 sr_err("Failed to open HID device.");
1146                 serial->hid_chip = 0;
1147                 g_free(serial->usb_path);
1148                 serial->usb_path = NULL;
1149                 g_free(serial->usb_serno);
1150                 serial->usb_serno = NULL;
1151                 return SR_ERR_IO;
1152         }
1153         sr_dbg("DBG: %s() done, OK", __func__);
1154
1155         if (!serial->rcv_buffer)
1156                 serial->rcv_buffer = g_string_sized_new(SER_HID_CHUNK_SIZE);
1157
1158         return SR_OK;
1159 }
1160
1161 static int ser_hid_close(struct sr_serial_dev_inst *serial)
1162 {
1163         sr_dbg("DBG: %s()", __func__);
1164         ser_hid_hidapi_close_dev(serial);
1165
1166         return SR_OK;
1167 }
1168
1169 static int ser_hid_set_params(struct sr_serial_dev_inst *serial,
1170         int baudrate, int bits, int parity, int stopbits,
1171         int flowcontrol, int rts, int dtr)
1172 {
1173         int rc;
1174
1175         sr_dbg("DBG: %s() enter", __func__);
1176         if (ser_hid_setup_funcs(serial) != 0)
1177                 return SR_ERR_NA;
1178         sr_dbg("DBG: %s() chip funcs set", __func__);
1179         if (!serial->hid_chip_funcs || !serial->hid_chip_funcs->set_params)
1180                 return SR_ERR_NA;
1181         sr_dbg("DBG: %s() set params avail", __func__);
1182         rc = serial->hid_chip_funcs->set_params(serial,
1183                 baudrate, bits, parity, stopbits,
1184                 flowcontrol, rts, dtr);
1185         sr_dbg("DBG: %s() set params rc %d", __func__, rc);
1186
1187         return rc;
1188 }
1189
1190 static int ser_hid_setup_source_add(struct sr_session *session,
1191         struct sr_serial_dev_inst *serial, int events, int timeout,
1192         sr_receive_data_callback cb, void *cb_data)
1193 {
1194         return ser_hid_hidapi_setup_source_add(session, serial,
1195                 events, timeout, cb, cb_data);
1196 }
1197
1198 static int ser_hid_setup_source_remove(struct sr_session *session,
1199         struct sr_serial_dev_inst *serial)
1200 {
1201         return ser_hid_hidapi_setup_source_remove(session, serial);
1202 }
1203
1204 static GSList *ser_hid_list(GSList *list, sr_ser_list_append_t append)
1205 {
1206         return ser_hid_hidapi_list(list, append);
1207 }
1208
1209 static GSList *ser_hid_find_usb(GSList *list, sr_ser_find_append_t append,
1210         uint16_t vendor_id, uint16_t product_id)
1211 {
1212         return ser_hid_hidapi_find_usb(list, append, vendor_id, product_id);
1213 }
1214
1215 static int ser_hid_flush(struct sr_serial_dev_inst *serial)
1216 {
1217         if (!serial->hid_chip_funcs || !serial->hid_chip_funcs->flush)
1218                 return SR_ERR_NA;
1219
1220         return serial->hid_chip_funcs->flush(serial);
1221 }
1222
1223 static int ser_hid_drain(struct sr_serial_dev_inst *serial)
1224 {
1225         if (!serial->hid_chip_funcs || !serial->hid_chip_funcs->drain)
1226                 return SR_ERR_NA;
1227
1228         return serial->hid_chip_funcs->drain(serial);
1229 }
1230
1231 static int ser_hid_write(struct sr_serial_dev_inst *serial,
1232         const void *buf, size_t count,
1233         int nonblocking, unsigned int timeout_ms)
1234 {
1235         int total, max_chunk, chunk_len;
1236         int rc;
1237
1238         if (!serial->hid_chip_funcs || !serial->hid_chip_funcs->write_bytes)
1239                 return SR_ERR_NA;
1240         if (!serial->hid_chip_funcs->max_bytes_per_request)
1241                 return SR_ERR_NA;
1242
1243         sr_dbg("DBG: %s() shall send %zu bytes TX data.", __func__, count);
1244         total = 0;
1245         max_chunk = serial->hid_chip_funcs->max_bytes_per_request;
1246         while (count > 0) {
1247                 chunk_len = count;
1248                 if (max_chunk && chunk_len > max_chunk)
1249                         chunk_len = max_chunk;
1250                 rc = serial->hid_chip_funcs->write_bytes(serial, buf, chunk_len);
1251                 if (rc < 0) {
1252                         sr_err("Error sending transmit data to HID device.");
1253                         return total;
1254                 }
1255                 if (rc != chunk_len) {
1256                         sr_warn("Short transmission to HID device (%d/%d bytes)?",
1257                                         rc, chunk_len);
1258                         return total;
1259                 }
1260                 buf += chunk_len;
1261                 count -= chunk_len;
1262                 total += chunk_len;
1263                 /* TODO
1264                  * Need we wait here? For data to drain through the slow
1265                  * UART. Not all UART-over-HID chips will have FIFOs.
1266                  */
1267                 if (!nonblocking) {
1268                         (void)timeout_ms;
1269                         /* TODO */
1270                 }
1271         }
1272
1273         return total;
1274 }
1275
1276 static int ser_hid_read(struct sr_serial_dev_inst *serial,
1277         void *buf, size_t count,
1278         int nonblocking, unsigned int timeout_ms)
1279 {
1280         gint64 deadline_us, now_us;
1281         uint8_t buffer[SER_HID_CHUNK_SIZE];
1282         int rc;
1283         unsigned int got;
1284
1285         sr_dbg("DBG: %s() count %zd, block %d, to %u", __func__,
1286                         count, !nonblocking, timeout_ms);
1287
1288         if (!serial->hid_chip_funcs || !serial->hid_chip_funcs->read_bytes)
1289                 return SR_ERR_NA;
1290         if (!serial->hid_chip_funcs->max_bytes_per_request)
1291                 return SR_ERR_NA;
1292
1293         /*
1294          * Immediately satisfy the caller's request from the RX buffer
1295          * if the requested amount of data is available already.
1296          */
1297         if (sr_ser_has_queued_data(serial) >= count) {
1298                 rc = sr_ser_unqueue_rx_data(serial, buf, count);
1299                 return rc;
1300         }
1301
1302         /*
1303          * When a timeout was specified, then determine the deadline
1304          * where to stop reception.
1305          */
1306         deadline_us = 0;
1307         now_us = 0;             /* Silence a (false) compiler warning. */
1308         if (timeout_ms) {
1309                 now_us = g_get_monotonic_time();
1310                 deadline_us = now_us + timeout_ms * 1000;
1311         }
1312
1313         /*
1314          * Keep receiving from the port until the caller's requested
1315          * amount of data has become available, or the timeout has
1316          * expired. In the absence of a timeout, stop reading when an
1317          * attempt no longer yields receive data.
1318          *
1319          * This implementation assumes that applications will call the
1320          * read routine often enough, or that reception continues in
1321          * background, such that data is not lost and hardware and
1322          * software buffers won't overrun.
1323          */
1324         while (TRUE) {
1325                 /*
1326                  * Determine the timeout (in milliseconds) for this
1327                  * iteration. The 'now_us' timestamp was initially
1328                  * determined above, and gets updated at the bottom of
1329                  * the loop.
1330                  */
1331                 if (deadline_us) {
1332                         timeout_ms = (deadline_us - now_us) / 1000;
1333                         if (!timeout_ms)
1334                                 timeout_ms = 1;
1335                 } else if (nonblocking) {
1336                         timeout_ms = 10;
1337                 } else {
1338                         timeout_ms = 0;
1339                 }
1340
1341                 /*
1342                  * Check the HID transport for the availability of more
1343                  * receive data.
1344                  */
1345                 rc = serial->hid_chip_funcs->read_bytes(serial,
1346                                 buffer, sizeof(buffer), timeout_ms);
1347                 if (rc < 0) {
1348                         sr_dbg("DBG: %s() read error %d.", __func__, rc);
1349                         return SR_ERR;
1350                 }
1351                 if (rc) {
1352                         sr_dbg("DBG: %s() queueing %d bytes.", __func__, rc);
1353                         ser_hid_mask_databits(serial, buffer, rc);
1354                         sr_ser_queue_rx_data(serial, buffer, rc);
1355                 }
1356                 got = sr_ser_has_queued_data(serial);
1357
1358                 /*
1359                  * Stop reading when the requested amount is available,
1360                  * or when the timeout has expired.
1361                  *
1362                  * TODO Consider whether grabbing all RX data is more
1363                  * desirable. Implementing this approach requires a cheap
1364                  * check for the availability of more data on the USB level.
1365                  */
1366                 if (got >= count)
1367                         break;
1368                 if (nonblocking && !rc)
1369                         break;
1370                 if (deadline_us) {
1371                         now_us = g_get_monotonic_time();
1372                         if (now_us >= deadline_us) {
1373                                 sr_dbg("DBG: %s() read loop timeout.", __func__);
1374                                 break;
1375                         }
1376                 }
1377         }
1378
1379         /*
1380          * Satisfy the caller's demand for receive data from previously
1381          * queued incoming data.
1382          */
1383         if (got > count)
1384                 got = count;
1385         sr_dbg("DBG: %s() passing %d bytes.", __func__, got);
1386         rc = sr_ser_unqueue_rx_data(serial, buf, count);
1387
1388         return rc;
1389 }
1390
1391 static struct ser_lib_functions serlib_hid = {
1392         .open = ser_hid_open,
1393         .close = ser_hid_close,
1394         .flush = ser_hid_flush,
1395         .drain = ser_hid_drain,
1396         .write = ser_hid_write,
1397         .read = ser_hid_read,
1398         .set_params = ser_hid_set_params,
1399         .setup_source_add = ser_hid_setup_source_add,
1400         .setup_source_remove = ser_hid_setup_source_remove,
1401         .list = ser_hid_list,
1402         .find_usb = ser_hid_find_usb,
1403         .get_frame_format = NULL,
1404 };
1405 SR_PRIV struct ser_lib_functions *ser_lib_funcs_hid = &serlib_hid;
1406
1407 /* }}} */
1408 #else
1409
1410 SR_PRIV int ser_name_is_hid(struct sr_serial_dev_inst *serial)
1411 {
1412         (void)serial;
1413
1414         return 0;
1415 }
1416
1417 SR_PRIV struct ser_lib_functions *ser_lib_funcs_hid = NULL;
1418
1419 #endif
1420 #endif
1421 /** @} */