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         [SER_HID_CHIP_SIL_CP2110] = &ser_hid_chip_funcs_cp2110,
 554         [SER_HID_CHIP_WCH_CH9325] = &ser_hid_chip_funcs_ch9325,
 555 };
 556
 557 static struct ser_hid_chip_functions *get_hid_chip_funcs(enum ser_hid_chip_t chip)
 558 {
 559         struct ser_hid_chip_functions *funcs;
 560
 561         if (chip >= ARRAY_SIZE(chips))
 562                 return NULL;
 563         if (!chips[chip])
 564                 return NULL;
 565         funcs = *chips[chip];
 566         if (!funcs)
 567                 return NULL;
 568
 569         return funcs;
 570 }
 571
 572 static int ser_hid_setup_funcs(struct sr_serial_dev_inst *serial)
 573 {
 574
 575         if (!serial)
 576                 return -1;
 577
 578         if (serial->hid_chip && !serial->hid_chip_funcs) {
 579                 serial->hid_chip_funcs = get_hid_chip_funcs(serial->hid_chip);
 580                 if (!serial->hid_chip_funcs)
 581                         return -1;
 582         }
 583
 584         return 0;
 585 }
 586
 587 /*
 588  * Takes a pointer to the chip spec with potentially trailing data,
 589  * returns the chip index and advances the spec pointer upon match,
 590  * returns SER_HID_CHIP_UNKNOWN upon mismatch.
 591  */
 592 static enum ser_hid_chip_t ser_hid_chip_find_enum(char **spec_p)
 593 {
 594         gchar *spec;
 595         enum ser_hid_chip_t idx;
 596         struct ser_hid_chip_functions *desc;
 597
 598         if (!spec_p || !*spec_p)
 599                 return SER_HID_CHIP_UNKNOWN;
 600         spec = *spec_p;
 601         if (!*spec)
 602                 return SER_HID_CHIP_UNKNOWN;
 603         for (idx = 0; idx < SER_HID_CHIP_LAST; idx++) {
 604                 desc = get_hid_chip_funcs(idx);
 605                 if (!desc)
 606                         continue;
 607                 if (!desc->chipname)
 608                         continue;
 609                 if (!g_str_has_prefix(spec, desc->chipname))
 610                         continue;
 611                 spec += strlen(desc->chipname);
 612                 *spec_p = spec;
 613                 return idx;
 614         }
 615
 616         return SER_HID_CHIP_UNKNOWN;
 617 }
 618
 619 /* See if we can find a chip name for a VID:PID spec. */
 620 SR_PRIV const char *ser_hid_chip_find_name_vid_pid(uint16_t vid, uint16_t pid)
 621 {
 622         size_t chip_idx;
 623         struct ser_hid_chip_functions *desc;
 624         const struct vid_pid_item *vid_pids;
 625
 626         for (chip_idx = 0; chip_idx < SER_HID_CHIP_LAST; chip_idx++) {
 627                 desc = get_hid_chip_funcs(chip_idx);
 628                 if (!desc)
 629                         continue;
 630                 if (!desc->chipname)
 631                         continue;
 632                 vid_pids = desc->vid_pid_items;
 633                 if (!vid_pids)
 634                         continue;
 635                 while (vid_pids->vid) {
 636                         if (vid_pids->vid == vid && vid_pids->pid == pid) {
 637                                 return desc->chipname;
 638                         }
 639                         vid_pids++;
 640                 }
 641         }
 642
 643         return NULL;
 644 }
 645
 646 static const char *ser_hid_chip_get_text(enum ser_hid_chip_t idx)
 647 {
 648         struct ser_hid_chip_functions *desc;
 649
 650         desc = get_hid_chip_funcs(idx);
 651         if (!desc)
 652                 return NULL;
 653
 654         return desc->chipdesc;
 655 }
 656
 657 /**
 658  * See if a text string is a valid USB path for a HID device.
 659  * @param[in] serial The serial port that is about to get opened.
 660  * @param[in] path The (assumed) USB path specification.
 661  * @return SR_OK upon success, SR_ERR* upon failure.
 662  */
 663 static int try_open_path(struct sr_serial_dev_inst *serial, const char *path)
 664 {
 665         int rc;
 666
 667         serial->usb_path = g_strdup(path);
 668         rc = ser_hid_hidapi_open_dev(serial);
 669         ser_hid_hidapi_close_dev(serial);
 670         g_free(serial->usb_path);
 671         serial->usb_path = NULL;
 672
 673         return rc;
 674 }
 675
 676 /**
 677  * Parse conn= specs for serial over HID communication.
 678  *
 679  * @param[in] serial The serial port that is about to get opened.
 680  * @param[in] spec The caller provided conn= specification.
 681  * @param[out] chip_ref Pointer to a chip type (enum).
 682  * @param[out] path_ref Pointer to a USB path (text string).
 683  * @param[out] serno_ref Pointer to a serial number (text string).
 684  *
 685  * @return 0 upon success, non-zero upon failure. Fills the *_ref output
 686  * values.
 687  *
 688  * @internal
 689  *
 690  * Summary of parsing rules as they are implemented:
 691  * - Insist on the "hid" prefix. Accept "hid" alone without any other
 692  *   additional field.
 693  * - The first field that follows can be a chip spec, yet is optional.
 694  * - Any other field is assumed to be either a USB path or a serial
 695  *   number. There is no point in specifying both of these, as either
 696  *   of them uniquely identifies a device.
 697  *
 698  * Supported formats resulting from these rules:
 699  *   hid[/<chip>]
 700  *   hid[/<chip>]/usb=<bus>.<dev>[.<if>]
 701  *   hid[/<chip>]/raw=<path>    (may contain slashes!)
 702  *   hid[/<chip>]/sn=serno
 703  *
 704  * This routine just parses the conn= spec, which either was provided by
 705  * a user, or may reflect (cite) an item of a previously gathered listing
 706  * (clipboard provided by CLI clients, or selected from a GUI form).
 707  * Another routine will fill in the blanks, and do the cable selection
 708  * when a filter was specified.
 709  *
 710  * Users will want to use short forms when they need to come up with the
 711  * specs by themselves. The "verbose" or seemingly redundant forms (chip
 712  * _and_ path/serno spec) are useful when the cable uses non-standard or
 713  * not-yet-supported VID:PID items when automatic chip detection fails.
 714  */
 715 static int ser_hid_parse_conn_spec(
 716         struct sr_serial_dev_inst *serial, const char *spec,
 717         enum ser_hid_chip_t *chip_ref, char **path_ref, char **serno_ref)
 718 {
 719         const char *p;
 720         enum ser_hid_chip_t chip;
 721         char *path, *serno;
 722         int rc;
 723
 724         if (chip_ref)
 725                 *chip_ref = SER_HID_CHIP_UNKNOWN;
 726         if (path_ref)
 727                 *path_ref = NULL;
 728         if (serno_ref)
 729                 *serno_ref = NULL;
 730         chip = SER_HID_CHIP_UNKNOWN;
 731         path = serno = NULL;
 732
 733         if (!serial || !spec || !*spec)
 734                 return SR_ERR_ARG;
 735         sr_dbg("DBG: %s(), input spec: %s", __func__, spec);
 736         p = spec;
 737
 738         /* The "hid" prefix is mandatory. */
 739         if (!g_str_has_prefix(p, SER_HID_CONN_PREFIX)) {
 740                 sr_dbg("DBG: %s(), not a HID port", __func__);
 741                 return SR_ERR_ARG;
 742         }
 743         p += strlen(SER_HID_CONN_PREFIX);
 744
 745         /*
 746          * Check for prefixed fields, assume chip type spec otherwise.
 747          * Paths and serial numbers "are greedy" (span to the end of
 748          * the input spec). Chip types are optional, and cannot repeat
 749          * multiple times.
 750          */
 751         while (*p) {
 752                 if (*p == '/')
 753                         p++;
 754                 if (!*p)
 755                         break;
 756                 if (g_str_has_prefix(p, SER_HID_USB_PREFIX)) {
 757                         rc = try_open_path(serial, p);
 758                         sr_dbg("DBG: %s(), open usb path %s => rc %d", __func__, p, rc);
 759                         if (rc != SR_OK)
 760                                 return rc;
 761                         path = g_strdup(p);
 762                         p += strlen(p);
 763                 } else if (g_str_has_prefix(p, SER_HID_RAW_PREFIX)) {
 764                         rc = try_open_path(serial, p);
 765                         sr_dbg("DBG: %s(), open raw path %s => rc %d", __func__, p, rc);
 766                         if (rc != SR_OK)
 767                                 return rc;
 768                         path = g_strdup(p);
 769                         p += strlen(p);
 770                 } else if (g_str_has_prefix(p, SER_HID_SNR_PREFIX)) {
 771                         p += strlen(SER_HID_SNR_PREFIX);
 772                         sr_dbg("DBG: %s(), snr %s", __func__, p);
 773                         serno = g_strdup(p);
 774                         p += strlen(p);
 775                 } else if (!chip) {
 776                         char *copy, *endptr;
 777                         const char *name;
 778                         copy = g_strdup(p);
 779                         endptr = copy;
 780                         chip = ser_hid_chip_find_enum(&endptr);
 781                         sr_dbg("DBG: %s(), chip search, %s => %u", __func__, p, chip);
 782                         if (!chip) {
 783                                 g_free(copy);
 784                                 return SR_ERR_ARG;
 785                         }
 786                         p += endptr - copy;
 787                         g_free(copy);
 788                         name = ser_hid_chip_get_text(chip);
 789                         sr_dbg("DBG: %s(), chip %s", __func__, name);
 790                 } else {
 791                         sr_err("unsupported conn= spec %s, error at %s", spec, p);
 792                         return SR_ERR_ARG;
 793                 }
 794                 if (*p == '/')
 795                         p++;
 796                 if (path || serno)
 797                         break;
 798         }
 799
 800         sr_dbg("DBG: %s() done, chip %d, path %s, serno %s", __func__, chip, path, serno);
 801         if (chip_ref)
 802                 *chip_ref = chip;
 803         if (path_ref && path)
 804                 *path_ref = path;
 805         if (serno_ref && serno)
 806                 *serno_ref = serno;
 807
 808         return SR_OK;
 809 }
 810
 811 /* Get and compare serial number. Boolean return value. */
 812 static int check_serno(const char *path, const char *serno_want)
 813 {
 814         char *usb_path;
 815         const char *hid_path;
 816         char serno_got[128];
 817         int rc;
 818
 819         sr_dbg("DBG: %s(\"%s\", \"%s\")", __func__, path, serno_want);
 820
 821         usb_path = g_strdup(path);
 822         hid_path = extract_hidapi_path(usb_path);
 823         rc = ser_hid_hidapi_get_serno(hid_path, serno_got, sizeof(serno_got));
 824         sr_dbg("DBG: %s(), usb %s, hidapi %s => rc %d", __func__, usb_path, hid_path, rc);
 825         g_free(usb_path);
 826         if (rc) {
 827                 sr_dbg("DBG: %s(), could not get serial number", __func__);
 828                 return 0;
 829         }
 830         sr_dbg("DBG: %s(), got serno \"%s\"", __func__, serno_got);
 831
 832         rc = strcmp(serno_got, serno_want) == 0;
 833         sr_dbg("DBG: %s(), return %d", __func__, rc);
 834
 835         return rc;
 836 }
 837
 838 static GSList *append_find(GSList *devs, const char *path)
 839 {
 840         char *copy;
 841
 842         if (!path || !*path)
 843                 return devs;
 844
 845         copy = g_strdup(path);
 846         devs = g_slist_append(devs, copy);
 847
 848         return devs;
 849 }
 850
 851 static GSList *list_paths_for_vids_pids(const struct vid_pid_item *vid_pids)
 852 {
 853         GSList *list;
 854         size_t idx;
 855         uint16_t vid, pid;
 856
 857         list = NULL;
 858         for (idx = 0; /* EMPTY */; idx++) {
 859                 if (!vid_pids) {
 860                         vid = pid = 0;
 861                 } else if (!vid_pids[idx].vid) {
 862                         break;
 863                 } else {
 864                         vid = vid_pids[idx].vid;
 865                         pid = vid_pids[idx].pid;
 866                 }
 867                 sr_dbg("DBG: %s(), searching VID:PID %04hx:%04hx",
 868                                 __func__, vid, pid);
 869                 list = ser_hid_hidapi_find_usb(list, append_find, vid, pid);
 870                 if (!vid_pids)
 871                         break;
 872         }
 873
 874         return list;
 875 }
 876
 877 /**
 878  * Search for a matching USB device for HID communication.
 879  *
 880  * @param[inout] chip The HID chip type (enum).
 881  * @param[inout] usbpath The USB path for the device (string).
 882  * @param[in] serno The serial number to search for.
 883  *
 884  * @retval SR_OK upon success
 885  * @retval SR_ERR_* upon failure.
 886  *
 887  * @internal
 888  *
 889  * This routine fills in blanks which the conn= spec parser left open.
 890  * When not specified yet, the HID chip type gets determined. When a
 891  * serial number was specified, then search the corresponding device.
 892  * Upon completion, the chip type and USB path for the device shall be
 893  * known, as these are essential for subsequent operation.
 894  */
 895 static int ser_hid_chip_search(enum ser_hid_chip_t *chip_ref,
 896         char **path_ref, const char *serno)
 897 {
 898         enum ser_hid_chip_t chip;
 899         char *path;
 900         int have_chip, have_path, have_serno;
 901         struct ser_hid_chip_functions *chip_funcs;
 902         int rc;
 903         int serno_matched;
 904         uint16_t vid, pid;
 905         const char *name;
 906         const struct vid_pid_item *vid_pids;
 907         GSList *list, *matched, *matched2, *tmplist;
 908
 909         if (!chip_ref)
 910                 return SR_ERR_ARG;
 911         chip = *chip_ref;
 912         if (!path_ref)
 913                 return SR_ERR_ARG;
 914         path = *path_ref;
 915         sr_dbg("DBG: %s() enter, chip %d, path %s, serno %s", __func__,
 916                         chip, path, serno ? serno : "<none>");
 917
 918         /*
 919          * Simplify the more complex conditions somewhat by assigning
 920          * to local variables. Handle the easiest conditions first.
 921          * - Either path or serial number can be specified, but not both
 922          *   at the same time.
 923          * - When a USB path is given, immediately see which HID chip
 924          *   the device has, without the need for enumeration.
 925          * - When a serial number is given, enumerate the devices and
 926          *   search for that number. Either enumerate all devices of the
 927          *   specified HID chip type (try the VID:PID pairs that we are
 928          *   aware of), or try all HID devices for unknown chip types.
 929          *   Not finding the serial number is fatal.
 930          * - When no path was found yet, enumerate the devices and pick
 931          *   one of them. Try known VID:PID pairs for a HID chip, or all
 932          *   devices for unknown chips. Make sure to pick a device of a
 933          *   supported chip type if the chip was not specified.
 934          * - Determine the chip type if not yet known. There should be
 935          *   a USB path by now, determined in one of the above blocks.
 936          */
 937         have_chip = (chip != SER_HID_CHIP_UNKNOWN) ? 1 : 0;
 938         have_path = (path && *path) ? 1 : 0;
 939         have_serno = (serno && *serno) ? 1 : 0;
 940         sr_dbg("DBG: %s(), have chip %d, path %d, serno %d", __func__,
 941                         have_chip, have_path, have_serno);
 942         if (have_path && have_serno) {
 943                 sr_err("Unsupported combination of USB path and serno");
 944                 return SR_ERR_ARG;
 945         }
 946         chip_funcs = have_chip ? get_hid_chip_funcs(chip) : NULL;
 947         if (have_chip && !chip_funcs)
 948                 return SR_ERR_NA;
 949         if (have_chip && !chip_funcs->vid_pid_items)
 950                 return SR_ERR_NA;
 951         if (have_path && !have_chip) {
 952                 sr_dbg("DBG: %s(), searching chip for path %s", __func__, path);
 953                 vid = pid = 0;
 954                 rc = ser_hid_hidapi_get_vid_pid(path, &vid, &pid);
 955                 sr_dbg("DBG: %s(), rc %d, VID:PID %04x:%04x", __func__, rc, vid, pid);
 956                 if (rc != SR_OK)
 957                         return rc;
 958                 name = ser_hid_chip_find_name_vid_pid(vid, pid);
 959                 sr_dbg("DBG: %s(), name %s", __func__, name);
 960                 if (!name || !*name)
 961                         return SR_ERR_NA;
 962                 chip = ser_hid_chip_find_enum((char **)&name);
 963                 sr_dbg("DBG: %s(), chip %d", __func__, chip);
 964                 if (chip == SER_HID_CHIP_UNKNOWN)
 965                         return SR_ERR_NA;
 966                 have_chip = 1;
 967         }
 968         if (have_serno) {
 969                 sr_dbg("DBG: %s(), searching path for serno %s", __func__, serno);
 970                 vid_pids = have_chip ? chip_funcs->vid_pid_items : NULL;
 971                 list = list_paths_for_vids_pids(vid_pids);
 972                 sr_dbg("DBG: %s(), vid/pid list for chip type %p", __func__, list);
 973                 if (!list)
 974                         return SR_ERR_NA;
 975                 matched = NULL;
 976                 for (tmplist = list; tmplist; tmplist = tmplist->next) {
 977                         path = get_hidapi_path_copy(tmplist->data);
 978                         sr_dbg("DBG: %s(), checking %s", __func__, path);
 979                         serno_matched = check_serno(path, serno);
 980                         g_free(path);
 981                         if (!serno_matched)
 982                                 continue;
 983                         matched = tmplist;
 984                         break;
 985                 }
 986                 if (!matched)
 987                         return SR_ERR_NA;
 988                 path = g_strdup(matched->data);
 989                 sr_dbg("DBG: %s(), match, path %s", __func__, path);
 990                 have_path = 1;
 991                 g_slist_free_full(list, g_free);
 992         }
 993         if (!have_path) {
 994                 sr_dbg("DBG: %s(), searching path, chip %d", __func__, chip);
 995                 vid_pids = have_chip ? chip_funcs->vid_pid_items : NULL;
 996                 list = list_paths_for_vids_pids(vid_pids);
 997                 if (!list)
 998                         return SR_ERR_NA;
 999                 for (tmplist = list; tmplist; tmplist = tmplist->next) {
1000                         path = tmplist->data;
1001                         sr_dbg("DBG: %s(), path %s", __func__, path);
1002                 }
1003                 matched = matched2 = NULL;
1004                 if (have_chip) {
1005                         /* List already only contains specified chip. */
1006                         matched = list;
1007                         path = matched->data;
1008                         sr_dbg("DBG: %s(), match 1 %s", __func__, path);
1009                         matched2 = list->next;
1010                         if (matched2) {
1011                                 path = matched2->data;
1012                                 sr_dbg("DBG: %s(), match 2 %s", __func__, path);
1013                         }
1014                 }
1015                 /* Works for lists with one or multiple chips. Saves indentation. */
1016                 for (tmplist = list; tmplist; tmplist = tmplist->next) {
1017                         if (have_chip)
1018                                 break;
1019                         path = tmplist->data;
1020                         rc = ser_hid_hidapi_get_vid_pid(path, &vid, &pid);
1021                         if (rc || !ser_hid_chip_find_name_vid_pid(vid, pid))
1022                                 continue;
1023                         if (!matched) {
1024                                 matched = tmplist;
1025                                 sr_dbg("DBG: %s(), match 1 %s", __func__, path);
1026                                 continue;
1027                         }
1028                         if (!matched2) {
1029                                 matched2 = tmplist;
1030                                 sr_dbg("DBG: %s(), match 2 %s", __func__, path);
1031                                 break;
1032                         }
1033                 }
1034                 if (!matched) {
1035                         g_slist_free_full(list, g_free);
1036                         return SR_ERR_NA;
1037                 }
1038                 /*
1039                  * TODO Optionally fail harder, expect users to provide
1040                  * unambiguous cable specs.
1041                  */
1042                 if (matched2)
1043                         sr_info("More than one cable matches, random pick.");
1044                 path = get_hidapi_path_copy(matched->data);
1045                 sr_dbg("DBG: %s(), match, path %s", __func__, path);
1046                 have_path = 1;
1047                 g_slist_free_full(list, g_free);
1048         }
1049         if (have_path && !have_chip) {
1050                 sr_dbg("DBG: %s(), searching chip for path %s", __func__, path);
1051                 vid = pid = 0;
1052                 rc = ser_hid_hidapi_get_vid_pid(path, &vid, &pid);
1053                 sr_dbg("DBG: %s(), rc %d, VID:PID %04x:%04x", __func__, rc, vid, pid);
1054                 if (rc != SR_OK)
1055                         return rc;
1056                 name = ser_hid_chip_find_name_vid_pid(vid, pid);
1057                 sr_dbg("DBG: %s(), name %s", __func__, name);
1058                 if (!name || !*name)
1059                         return SR_ERR_NA;
1060                 chip = ser_hid_chip_find_enum((char **)&name);
1061                 sr_dbg("DBG: %s(), chip %d", __func__, chip);
1062                 if (chip == SER_HID_CHIP_UNKNOWN)
1063                         return SR_ERR_NA;
1064                 have_chip = 1;
1065         }
1066
1067         sr_dbg("DBG: %s() leave, chip %d, path %s", __func__, chip, path);
1068         if (chip_ref)
1069                 *chip_ref = chip;
1070         if (path_ref)
1071                 *path_ref = path;
1072
1073         return SR_OK;
1074 }
1075
1076 /* }}} */
1077 /* {{{ transport methods called by the common serial.c code */
1078
1079 /* See if a serial port's name refers to an HID type. */
1080 SR_PRIV int ser_name_is_hid(struct sr_serial_dev_inst *serial)
1081 {
1082         size_t off;
1083         char sep;
1084
1085         if (!serial)
1086                 return 0;
1087         if (!serial->port || !*serial->port)
1088                 return 0;
1089
1090         /* Accept either "hid" alone, or "hid/" as a prefix. */
1091         if (!g_str_has_prefix(serial->port, SER_HID_CONN_PREFIX))
1092                 return 0;
1093         off = strlen(SER_HID_CONN_PREFIX);
1094         sep = serial->port[off];
1095         if (sep != '\0' && sep != '/')
1096                 return 0;
1097
1098         return 1;
1099 }
1100
1101 static int ser_hid_open(struct sr_serial_dev_inst *serial, int flags)
1102 {
1103         enum ser_hid_chip_t chip;
1104         char *usbpath, *serno;
1105         int rc;
1106
1107         (void)flags;
1108
1109         if (ser_hid_setup_funcs(serial) != 0) {
1110                 sr_err("Cannot determine HID communication library.");
1111                 return SR_ERR_NA;
1112         }
1113
1114         rc = ser_hid_parse_conn_spec(serial, serial->port,
1115                         &chip, &usbpath, &serno);
1116         if (rc != SR_OK)
1117                 return SR_ERR_ARG;
1118
1119         /*
1120          * When a serial number was specified, or when the chip type or
1121          * the USB path were not specified, do a search to determine the
1122          * device's USB path.
1123          */
1124         if (!chip || !usbpath || serno) {
1125                 sr_dbg("DBG: %s(), searching ...", __func__);
1126                 rc = ser_hid_chip_search(&chip, &usbpath, serno);
1127                 if (rc != 0)
1128                         return SR_ERR_NA;
1129         }
1130
1131         /*
1132          * Open the HID device. Only store chip type and device handle
1133          * when open completes successfully.
1134          */
1135         serial->hid_chip = chip;
1136         if (ser_hid_setup_funcs(serial) != 0) {
1137                 sr_err("Cannot determine HID chip specific routines.");
1138                 return SR_ERR_NA;
1139         }
1140         if (usbpath && *usbpath)
1141                 serial->usb_path = usbpath;
1142         if (serno && *serno)
1143                 serial->usb_serno = serno;
1144
1145         rc = ser_hid_hidapi_open_dev(serial);
1146         if (rc) {
1147                 sr_err("Failed to open HID device.");
1148                 serial->hid_chip = 0;
1149                 g_free(serial->usb_path);
1150                 serial->usb_path = NULL;
1151                 g_free(serial->usb_serno);
1152                 serial->usb_serno = NULL;
1153                 return SR_ERR_IO;
1154         }
1155         sr_dbg("DBG: %s() done, OK", __func__);
1156
1157         if (!serial->rcv_buffer)
1158                 serial->rcv_buffer = g_string_sized_new(SER_HID_CHUNK_SIZE);
1159
1160         return SR_OK;
1161 }
1162
1163 static int ser_hid_close(struct sr_serial_dev_inst *serial)
1164 {
1165         sr_dbg("DBG: %s()", __func__);
1166         ser_hid_hidapi_close_dev(serial);
1167
1168         return SR_OK;
1169 }
1170
1171 static int ser_hid_set_params(struct sr_serial_dev_inst *serial,
1172         int baudrate, int bits, int parity, int stopbits,
1173         int flowcontrol, int rts, int dtr)
1174 {
1175         int rc;
1176
1177         sr_dbg("DBG: %s() enter", __func__);
1178         if (ser_hid_setup_funcs(serial) != 0)
1179                 return SR_ERR_NA;
1180         sr_dbg("DBG: %s() chip funcs set", __func__);
1181         if (!serial->hid_chip_funcs || !serial->hid_chip_funcs->set_params)
1182                 return SR_ERR_NA;
1183         sr_dbg("DBG: %s() set params avail", __func__);
1184         rc = serial->hid_chip_funcs->set_params(serial,
1185                 baudrate, bits, parity, stopbits,
1186                 flowcontrol, rts, dtr);
1187         sr_dbg("DBG: %s() set params rc %d", __func__, rc);
1188
1189         return rc;
1190 }
1191
1192 static int ser_hid_setup_source_add(struct sr_session *session,
1193         struct sr_serial_dev_inst *serial, int events, int timeout,
1194         sr_receive_data_callback cb, void *cb_data)
1195 {
1196         return ser_hid_hidapi_setup_source_add(session, serial,
1197                 events, timeout, cb, cb_data);
1198 }
1199
1200 static int ser_hid_setup_source_remove(struct sr_session *session,
1201         struct sr_serial_dev_inst *serial)
1202 {
1203         return ser_hid_hidapi_setup_source_remove(session, serial);
1204 }
1205
1206 static GSList *ser_hid_list(GSList *list, sr_ser_list_append_t append)
1207 {
1208         return ser_hid_hidapi_list(list, append);
1209 }
1210
1211 static GSList *ser_hid_find_usb(GSList *list, sr_ser_find_append_t append,
1212         uint16_t vendor_id, uint16_t product_id)
1213 {
1214         return ser_hid_hidapi_find_usb(list, append, vendor_id, product_id);
1215 }
1216
1217 static int ser_hid_flush(struct sr_serial_dev_inst *serial)
1218 {
1219         if (!serial->hid_chip_funcs || !serial->hid_chip_funcs->flush)
1220                 return SR_ERR_NA;
1221
1222         return serial->hid_chip_funcs->flush(serial);
1223 }
1224
1225 static int ser_hid_drain(struct sr_serial_dev_inst *serial)
1226 {
1227         if (!serial->hid_chip_funcs || !serial->hid_chip_funcs->drain)
1228                 return SR_ERR_NA;
1229
1230         return serial->hid_chip_funcs->drain(serial);
1231 }
1232
1233 static int ser_hid_write(struct sr_serial_dev_inst *serial,
1234         const void *buf, size_t count,
1235         int nonblocking, unsigned int timeout_ms)
1236 {
1237         int total, max_chunk, chunk_len;
1238         int rc;
1239
1240         if (!serial->hid_chip_funcs || !serial->hid_chip_funcs->write_bytes)
1241                 return SR_ERR_NA;
1242         if (!serial->hid_chip_funcs->max_bytes_per_request)
1243                 return SR_ERR_NA;
1244
1245         sr_dbg("DBG: %s() shall send %zu bytes TX data.", __func__, count);
1246         total = 0;
1247         max_chunk = serial->hid_chip_funcs->max_bytes_per_request;
1248         while (count > 0) {
1249                 chunk_len = count;
1250                 if (max_chunk && chunk_len > max_chunk)
1251                         chunk_len = max_chunk;
1252                 rc = serial->hid_chip_funcs->write_bytes(serial, buf, chunk_len);
1253                 if (rc < 0) {
1254                         sr_err("Error sending transmit data to HID device.");
1255                         return total;
1256                 }
1257                 if (rc != chunk_len) {
1258                         sr_warn("Short transmission to HID device (%d/%d bytes)?",
1259                                         rc, chunk_len);
1260                         return total;
1261                 }
1262                 buf += chunk_len;
1263                 count -= chunk_len;
1264                 total += chunk_len;
1265                 /* TODO
1266                  * Need we wait here? For data to drain through the slow
1267                  * UART. Not all UART-over-HID chips will have FIFOs.
1268                  */
1269                 if (!nonblocking) {
1270                         (void)timeout_ms;
1271                         /* TODO */
1272                 }
1273         }
1274
1275         return total;
1276 }
1277
1278 static int ser_hid_read(struct sr_serial_dev_inst *serial,
1279         void *buf, size_t count,
1280         int nonblocking, unsigned int timeout_ms)
1281 {
1282         gint64 deadline_us, now_us;
1283         uint8_t buffer[SER_HID_CHUNK_SIZE];
1284         int rc;
1285         unsigned int got;
1286
1287         sr_dbg("DBG: %s() count %zd, block %d, to %u", __func__,
1288                         count, !nonblocking, timeout_ms);
1289
1290         if (!serial->hid_chip_funcs || !serial->hid_chip_funcs->read_bytes)
1291                 return SR_ERR_NA;
1292         if (!serial->hid_chip_funcs->max_bytes_per_request)
1293                 return SR_ERR_NA;
1294
1295         /*
1296          * Immediately satisfy the caller's request from the RX buffer
1297          * if the requested amount of data is available already.
1298          */
1299         if (sr_ser_has_queued_data(serial) >= count) {
1300                 rc = sr_ser_unqueue_rx_data(serial, buf, count);
1301                 return rc;
1302         }
1303
1304         /*
1305          * When a timeout was specified, then determine the deadline
1306          * where to stop reception.
1307          */
1308         deadline_us = 0;
1309         now_us = 0;             /* Silence a (false) compiler warning. */
1310         if (timeout_ms) {
1311                 now_us = g_get_monotonic_time();
1312                 deadline_us = now_us + timeout_ms * 1000;
1313         }
1314
1315         /*
1316          * Keep receiving from the port until the caller's requested
1317          * amount of data has become available, or the timeout has
1318          * expired. In the absence of a timeout, stop reading when an
1319          * attempt no longer yields receive data.
1320          *
1321          * This implementation assumes that applications will call the
1322          * read routine often enough, or that reception continues in
1323          * background, such that data is not lost and hardware and
1324          * software buffers won't overrun.
1325          */
1326         while (TRUE) {
1327                 /*
1328                  * Determine the timeout (in milliseconds) for this
1329                  * iteration. The 'now_us' timestamp was initially
1330                  * determined above, and gets updated at the bottom of
1331                  * the loop.
1332                  */
1333                 if (deadline_us) {
1334                         timeout_ms = (deadline_us - now_us) / 1000;
1335                         if (!timeout_ms)
1336                                 timeout_ms = 1;
1337                 } else if (nonblocking) {
1338                         timeout_ms = 10;
1339                 } else {
1340                         timeout_ms = 0;
1341                 }
1342
1343                 /*
1344                  * Check the HID transport for the availability of more
1345                  * receive data.
1346                  */
1347                 rc = serial->hid_chip_funcs->read_bytes(serial,
1348                                 buffer, sizeof(buffer), timeout_ms);
1349                 if (rc < 0) {
1350                         sr_dbg("DBG: %s() read error %d.", __func__, rc);
1351                         return SR_ERR;
1352                 }
1353                 if (rc) {
1354                         sr_dbg("DBG: %s() queueing %d bytes.", __func__, rc);
1355                         ser_hid_mask_databits(serial, buffer, rc);
1356                         sr_ser_queue_rx_data(serial, buffer, rc);
1357                 }
1358                 got = sr_ser_has_queued_data(serial);
1359
1360                 /*
1361                  * Stop reading when the requested amount is available,
1362                  * or when the timeout has expired.
1363                  *
1364                  * TODO Consider whether grabbing all RX data is more
1365                  * desirable. Implementing this approach requires a cheap
1366                  * check for the availability of more data on the USB level.
1367                  */
1368                 if (got >= count)
1369                         break;
1370                 if (nonblocking && !rc)
1371                         break;
1372                 if (deadline_us) {
1373                         now_us = g_get_monotonic_time();
1374                         if (now_us >= deadline_us) {
1375                                 sr_dbg("DBG: %s() read loop timeout.", __func__);
1376                                 break;
1377                         }
1378                 }
1379         }
1380
1381         /*
1382          * Satisfy the caller's demand for receive data from previously
1383          * queued incoming data.
1384          */
1385         if (got > count)
1386                 got = count;
1387         sr_dbg("DBG: %s() passing %d bytes.", __func__, got);
1388         rc = sr_ser_unqueue_rx_data(serial, buf, count);
1389
1390         return rc;
1391 }
1392
1393 static struct ser_lib_functions serlib_hid = {
1394         .open = ser_hid_open,
1395         .close = ser_hid_close,
1396         .flush = ser_hid_flush,
1397         .drain = ser_hid_drain,
1398         .write = ser_hid_write,
1399         .read = ser_hid_read,
1400         .set_params = ser_hid_set_params,
1401         .setup_source_add = ser_hid_setup_source_add,
1402         .setup_source_remove = ser_hid_setup_source_remove,
1403         .list = ser_hid_list,
1404         .find_usb = ser_hid_find_usb,
1405         .get_frame_format = NULL,
1406 };
1407 SR_PRIV struct ser_lib_functions *ser_lib_funcs_hid = &serlib_hid;
1408
1409 /* }}} */
1410 #else
1411
1412 SR_PRIV int ser_name_is_hid(struct sr_serial_dev_inst *serial)
1413 {
1414         (void)serial;
1415
1416         return 0;
1417 }
1418
1419 SR_PRIV struct ser_lib_functions *ser_lib_funcs_hid = NULL;
1420
1421 #endif
1422 #endif
1423 /** @} */