2 * This file is part of the libsigrok project.
4 * Copyright (C) 2017-2019 Gerhard Sittig <gerhard.sittig@gmx.net>
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.
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.
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/>.
25 #include <libsigrok/libsigrok.h>
26 #include "libsigrok-internal.h"
27 #include "serial_hid.h"
31 #include <windows.h> /* for HANDLE */
34 #define LOG_PREFIX "serial-hid"
36 #ifdef HAVE_SERIAL_COMM
41 * Serial port handling, HIDAPI library specific support code.
45 * @defgroup grp_serial_hid Serial port handling, HID group
47 * Make serial-over-HID communication appear like a regular serial port.
53 /* {{{ helper routines */
55 /* Strip off parity bits for "odd" data bit counts like in 7e1 frames. */
56 static void ser_hid_mask_databits(struct sr_serial_dev_inst *serial,
57 uint8_t *data, size_t len)
63 if ((serial->comm_params.data_bits % 8) == 0)
66 mask32 = (1UL << serial->comm_params.data_bits) - 1;
68 for (idx = 0; idx < len; idx++)
73 /* {{{ open/close/list/find HIDAPI connection, exchange HID requests and data */
75 #define IOKIT_PATH_PREFIX "IOService:"
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.
82 * Since conn= is passed with -d where multiple options (among them conn=)
83 * are separated by colons, port names themselves cannot contain colons.
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.
92 static char *get_hidapi_path_copy(const char *path)
94 static const char *accept = "0123456789abcdefABCDEF:";
95 static const char *keep = "0123456789abcdefABCDEF";
99 const char *parse, *remain;
103 has_colon = strchr(parse, ':') != NULL;
104 is_hex_colon = strspn(parse, accept) == strlen(parse);
106 /* All hex digits and colon only. Simple substitution. */
107 copy = g_strdup_printf("%s%s", SER_HID_USB_PREFIX, parse);
108 g_strcanon(copy + strlen(SER_HID_USB_PREFIX), keep, '.');
112 /* "Something raw" and no colon. Add raw= prefix. */
113 copy = g_strdup_printf("%s%s", SER_HID_RAW_PREFIX, parse);
116 if (g_str_has_prefix(parse, IOKIT_PATH_PREFIX)) do {
118 * Path starts with Mac IOKit literal which contains the
119 * colon. Drop that literal from the start of the path,
120 * and check whether any colon remains which we cannot
121 * deal with. Fall though to other approaches which could
122 * be more generic, or to the error path.
124 remain = &parse[strlen(IOKIT_PATH_PREFIX)];
125 if (strchr(remain, ':'))
127 copy = g_strdup_printf("%s%s", SER_HID_IOKIT_PREFIX, remain);
132 * Consider adding support for more of the currently unhandled
133 * cases. When we get here, the HIDAPI path could be arbitrarily
134 * complex, none of the above "straight" approaches took effect.
135 * Proper escaping or other transformations could get applied,
136 * though they decrease usability the more they obfuscate the
137 * resulting port name. Ideally users remain able to recognize
138 * their device or cable or port after the manipulation.
140 sr_err("Unsupported HIDAPI path format: %s", path);
145 * Undo the port name construction that was done during scan. Extract
146 * the HIDAPI path from a conn= input spec (the part after the hid/
147 * prefix and chip type).
149 * Strip off the "raw" prefix, or undo colon substitution. See @ref
150 * get_hidapi_path_copy() for details.
152 static char *extract_hidapi_path(const char *copy)
154 static const char *keep = "0123456789abcdefABCDEF:";
163 if (g_str_has_prefix(p, SER_HID_IOKIT_PREFIX)) {
164 p += strlen(SER_HID_IOKIT_PREFIX);
165 path = g_strdup_printf("%s%s", IOKIT_PATH_PREFIX, p);
168 if (g_str_has_prefix(p, SER_HID_RAW_PREFIX)) {
169 p += strlen(SER_HID_RAW_PREFIX);
173 if (g_str_has_prefix(p, SER_HID_USB_PREFIX)) {
174 p += strlen(SER_HID_USB_PREFIX);
176 g_strcanon(path, keep, ':');
184 * Enumerate all devices (no VID:PID is involved). Invoke an 'append'
185 * callback with "path" and "name". Exclusively list connections that
186 * involve supported chip types, because mice and keyboards etc are not
187 * too useful to communicate to measurement equipment.
189 static GSList *ser_hid_hidapi_list(GSList *list, sr_ser_list_append_t append)
191 struct hid_device_info *devs, *curdev;
192 const char *chipname;
194 wchar_t *manuf, *prod, *serno;
198 devs = hid_enumerate(0x0000, 0x0000);
199 for (curdev = devs; curdev; curdev = curdev->next) {
201 * Determine the chip name from VID:PID. Exlusively list
202 * supported connection types (known chips).
204 vid = curdev->vendor_id;
205 pid = curdev->product_id;
206 chipname = ser_hid_chip_find_name_vid_pid(vid, pid);
211 * Prefix port names such that open() calls with this
212 * conn= spec will end up here and contain all details
213 * that are essential for processing.
215 path = get_hidapi_path_copy(curdev->path);
218 name = g_strdup_printf("%s/%s/%s",
219 SER_HID_CONN_PREFIX, chipname, path);
223 * Print whatever information was available. Construct
224 * the description text from pieces. Absence of fields
225 * is not fatal, we have seen perfectly usable cables
226 * that only had a VID and PID (permissions were not an
229 manuf = curdev->manufacturer_string;
230 prod = curdev->product_string;
231 serno = curdev->serial_number;
232 vid = curdev->vendor_id;
233 pid = curdev->product_id;
234 desc = g_string_sized_new(128);
235 g_string_append_printf(desc, "HID");
236 if (manuf && wcslen(manuf) != 0)
237 g_string_append_printf(desc, " %ls", manuf);
238 if (prod && wcslen(prod) != 0)
239 g_string_append_printf(desc, " %ls", prod);
240 if (serno && wcslen(serno) != 0)
241 g_string_append_printf(desc, " %ls", serno);
243 g_string_append_printf(desc, " [%04hx.%04hx]", vid, pid);
244 list = append(list, name, desc->str);
245 g_string_free(desc, TRUE);
248 hid_free_enumeration(devs);
254 * Enumerate devices for the specified VID:PID pair. Invoke an "append"
255 * callback with 'path' for found devices. Exclusively finds supported
256 * chip types, skips unknown VID:PID pairs (even if caller specified).
258 static GSList *ser_hid_hidapi_find_usb(GSList *list, sr_ser_find_append_t append,
259 uint16_t vendor_id, uint16_t product_id)
261 const char *caller_chip;
262 const char *dev_chip;
263 struct hid_device_info *devs, *curdev;
267 caller_chip = ser_hid_chip_find_name_vid_pid(vendor_id, product_id);
269 devs = hid_enumerate(vendor_id, product_id);
270 for (curdev = devs; curdev; curdev = curdev->next) {
271 dev_chip = caller_chip;
273 dev_chip = ser_hid_chip_find_name_vid_pid(
274 curdev->vendor_id, curdev->product_id);
278 path = get_hidapi_path_copy(curdev->path);
281 name = g_strdup_printf("%s/%s/%s",
282 SER_HID_CONN_PREFIX, dev_chip, path);
284 list = append(list, name);
286 hid_free_enumeration(devs);
291 /* Get the serial number of a device specified by path. */
292 static int ser_hid_hidapi_get_serno(const char *path, char *buf, size_t blen)
301 hidpath = extract_hidapi_path(path);
302 dev = hidpath ? hid_open_path(hidpath) : NULL;
307 serno_wch = g_malloc0(blen * sizeof(*serno_wch));
308 rc = hid_get_serial_number_string(dev, serno_wch, blen - 1);
315 snprintf(buf, blen, "%ls", serno_wch);
321 /* Get the VID and PID of a device specified by path. */
322 static int ser_hid_hidapi_get_vid_pid(const char *path,
323 uint16_t *vid, uint16_t *pid)
327 * Bummer! It would have been most reliable to just open the
328 * device by the specified path, and grab its VID:PID. But
329 * there is no way to get these parameters, neither in the
330 * HIDAPI itself, nor when cheating and reaching behind the API
331 * and accessing the libusb handle in dirty ways. :(
337 dev = hid_open_path(path);
341 *vid = dev->vendor_id;
343 *pid = dev->product_id;
349 * The fallback approach. Enumerate all devices, compare the
350 * enumerated USB path, and grab the VID:PID. Unfortunately the
351 * caller can provide path specs that differ from enumerated
352 * paths yet mean the same (address the same device). This needs
353 * more attention. Though the specific format of the path and
354 * its meaning are said to be OS specific, which is why we may
355 * not assume anything about it...
358 struct hid_device_info *devs, *dev;
361 hidpath = extract_hidapi_path(path);
365 devs = hid_enumerate(0x0000, 0x0000);
367 for (dev = devs; dev; dev = dev->next) {
368 if (strcmp(dev->path, hidpath) != 0)
371 *vid = dev->vendor_id;
373 *pid = dev->product_id;
377 hid_free_enumeration(devs);
380 return found ? SR_OK : SR_ERR_NA;
384 static int ser_hid_hidapi_open_dev(struct sr_serial_dev_inst *serial)
388 if (!serial->usb_path || !*serial->usb_path)
392 * A path is available, assume that either a GUI or a
393 * user has copied what a previous listing has provided.
394 * Or a scan determined a matching device's USB path.
396 if (!serial->hid_path)
397 serial->hid_path = extract_hidapi_path(serial->usb_path);
398 hid_dev = hid_open_path(serial->hid_path);
400 g_free((void *)serial->hid_path);
401 serial->hid_path = NULL;
405 serial->hid_dev = hid_dev;
406 hid_set_nonblocking(hid_dev, 1);
411 static void ser_hid_hidapi_close_dev(struct sr_serial_dev_inst *serial)
413 if (serial->hid_dev) {
414 hid_close(serial->hid_dev);
415 serial->hid_dev = NULL;
416 g_free((void *)serial->hid_path);
417 serial->hid_path = NULL;
419 g_slist_free_full(serial->hid_source_args, g_free);
420 serial->hid_source_args = NULL;
423 struct hidapi_source_args_t {
424 /* Application callback. */
425 sr_receive_data_callback cb;
427 /* The serial device, to store RX data. */
428 struct sr_serial_dev_inst *serial;
432 * Gets periodically invoked by the glib main loop. "Drives" (checks)
433 * progress of USB communication, and invokes the application's callback
434 * which processes RX data (when some has become available), as well as
435 * handles application level timeouts.
437 static int hidapi_source_cb(int fd, int revents, void *cb_data)
439 struct hidapi_source_args_t *args;
440 uint8_t rx_buf[SER_HID_CHUNK_SIZE];
446 * Drain receive data which the chip might have pending. This is
447 * "a copy" of the "background part" of ser_hid_read(), without
448 * the timeout support code, and not knowing how much data the
449 * application is expecting.
452 rc = args->serial->hid_chip_funcs->read_bytes(args->serial,
453 rx_buf, sizeof(rx_buf), 0);
455 ser_hid_mask_databits(args->serial, rx_buf, rc);
456 sr_ser_queue_rx_data(args->serial, rx_buf, rc);
461 * When RX data became available (now or earlier), pass this
462 * condition to the application callback. Always periodically
463 * run the application callback, since it handles timeouts and
464 * might carry out other tasks as well like signalling progress.
466 if (sr_ser_has_queued_data(args->serial))
468 rc = args->cb(fd, revents, args->cb_data);
473 #define WITH_MAXIMUM_TIMEOUT_VALUE 10
474 static int ser_hid_hidapi_setup_source_add(struct sr_session *session,
475 struct sr_serial_dev_inst *serial, int events, int timeout,
476 sr_receive_data_callback cb, void *cb_data)
478 struct hidapi_source_args_t *args;
483 /* Optionally enforce a minimum poll period. */
484 if (WITH_MAXIMUM_TIMEOUT_VALUE && timeout > WITH_MAXIMUM_TIMEOUT_VALUE)
485 timeout = WITH_MAXIMUM_TIMEOUT_VALUE;
487 /* Allocate status container for background data reception. */
488 args = g_malloc0(sizeof(*args));
490 args->cb_data = cb_data;
491 args->serial = serial;
494 * Have a periodic timer installed. Register the allocated block
495 * with the serial device, since the GSource's finalizer won't
496 * free the memory, and we haven't bothered to create a custom
497 * HIDAPI specific GSource.
499 rc = sr_session_source_add(session, -1, events, timeout,
500 hidapi_source_cb, args);
505 serial->hid_source_args = g_slist_append(serial->hid_source_args, args);
510 static int ser_hid_hidapi_setup_source_remove(struct sr_session *session,
511 struct sr_serial_dev_inst *serial)
515 (void)sr_session_source_remove(session, -1);
517 * Release callback args here already? Can there be more than
518 * one source registered at any time, given that we pass fd -1
519 * which is used as the key for the session?
525 SR_PRIV int ser_hid_hidapi_get_report(struct sr_serial_dev_inst *serial,
526 uint8_t *data, size_t len)
530 rc = hid_get_feature_report(serial->hid_dev, data, len);
537 SR_PRIV int ser_hid_hidapi_set_report(struct sr_serial_dev_inst *serial,
538 const uint8_t *data, size_t len)
541 const wchar_t *err_text;
543 rc = hid_send_feature_report(serial->hid_dev, data, len);
545 err_text = hid_error(serial->hid_dev);
546 sr_dbg("%s() hidapi error: %ls", __func__, err_text);
553 SR_PRIV int ser_hid_hidapi_get_data(struct sr_serial_dev_inst *serial,
554 uint8_t ep, uint8_t *data, size_t len, int timeout)
561 rc = hid_read_timeout(serial->hid_dev, data, len, timeout);
563 rc = hid_read(serial->hid_dev, data, len);
572 SR_PRIV int ser_hid_hidapi_set_data(struct sr_serial_dev_inst *serial,
573 uint8_t ep, const uint8_t *data, size_t len, int timeout)
580 rc = hid_write(serial->hid_dev, data, len);
588 /* {{{ support for serial-over-HID chips */
590 static struct ser_hid_chip_functions **chips[SER_HID_CHIP_LAST] = {
591 [SER_HID_CHIP_UNKNOWN] = NULL,
592 [SER_HID_CHIP_BTC_BU86X] = &ser_hid_chip_funcs_bu86x,
593 [SER_HID_CHIP_SIL_CP2110] = &ser_hid_chip_funcs_cp2110,
594 [SER_HID_CHIP_VICTOR_DMM] = &ser_hid_chip_funcs_victor,
595 [SER_HID_CHIP_WCH_CH9325] = &ser_hid_chip_funcs_ch9325,
598 static struct ser_hid_chip_functions *get_hid_chip_funcs(enum ser_hid_chip_t chip)
600 struct ser_hid_chip_functions *funcs;
602 if (chip >= ARRAY_SIZE(chips))
606 funcs = *chips[chip];
613 static int ser_hid_setup_funcs(struct sr_serial_dev_inst *serial)
619 if (serial->hid_chip && !serial->hid_chip_funcs) {
620 serial->hid_chip_funcs = get_hid_chip_funcs(serial->hid_chip);
621 if (!serial->hid_chip_funcs)
629 * Takes a pointer to the chip spec with potentially trailing data,
630 * returns the chip index and advances the spec pointer upon match,
631 * returns SER_HID_CHIP_UNKNOWN upon mismatch.
633 static enum ser_hid_chip_t ser_hid_chip_find_enum(const char **spec_p)
636 enum ser_hid_chip_t idx;
637 struct ser_hid_chip_functions *desc;
639 if (!spec_p || !*spec_p)
640 return SER_HID_CHIP_UNKNOWN;
643 return SER_HID_CHIP_UNKNOWN;
644 for (idx = 0; idx < SER_HID_CHIP_LAST; idx++) {
645 desc = get_hid_chip_funcs(idx);
650 if (!g_str_has_prefix(spec, desc->chipname))
652 spec += strlen(desc->chipname);
657 return SER_HID_CHIP_UNKNOWN;
660 /* See if we can find a chip name for a VID:PID spec. */
661 SR_PRIV const char *ser_hid_chip_find_name_vid_pid(uint16_t vid, uint16_t pid)
664 struct ser_hid_chip_functions *desc;
665 const struct vid_pid_item *vid_pids;
667 for (chip_idx = 0; chip_idx < SER_HID_CHIP_LAST; chip_idx++) {
668 desc = get_hid_chip_funcs(chip_idx);
673 vid_pids = desc->vid_pid_items;
676 while (vid_pids->vid) {
677 if (vid_pids->vid == vid && vid_pids->pid == pid)
678 return desc->chipname;
687 * See if a text string is a valid USB path for a HID device.
688 * @param[in] serial The serial port that is about to get opened.
689 * @param[in] path The (assumed) USB path specification.
690 * @return SR_OK upon success, SR_ERR* upon failure.
692 static int try_open_path(struct sr_serial_dev_inst *serial, const char *path)
696 serial->usb_path = g_strdup(path);
697 rc = ser_hid_hidapi_open_dev(serial);
698 ser_hid_hidapi_close_dev(serial);
699 g_free(serial->usb_path);
700 serial->usb_path = NULL;
706 * Parse conn= specs for serial over HID communication.
708 * @param[in] serial The serial port that is about to get opened.
709 * @param[in] spec The caller provided conn= specification.
710 * @param[out] chip_ref Pointer to a chip type (enum).
711 * @param[out] path_ref Pointer to a USB path (text string).
712 * @param[out] serno_ref Pointer to a serial number (text string).
714 * @return 0 upon success, non-zero upon failure. Fills the *_ref output
717 * Summary of parsing rules as they are implemented:
718 * - Insist on the "hid" prefix. Accept "hid" alone without any other
720 * - The first field that follows can be a chip spec, yet is optional.
721 * - Any other field is assumed to be either a USB path or a serial
722 * number. There is no point in specifying both of these, as either
723 * of them uniquely identifies a device.
725 * Supported formats resulting from these rules:
727 * hid[/<chip>]/usb=<bus>.<dev>[.<if>]
728 * hid[/<chip>]/raw=<path> (may contain slashes!)
729 * hid[/<chip>]/sn=serno
731 * This routine just parses the conn= spec, which either was provided by
732 * a user, or may reflect (cite) an item of a previously gathered listing
733 * (clipboard provided by CLI clients, or selected from a GUI form).
734 * Another routine will fill in the blanks, and do the cable selection
735 * when a filter was specified.
737 * Users will want to use short forms when they need to come up with the
738 * specs by themselves. The "verbose" or seemingly redundant forms (chip
739 * _and_ path/serno spec) are useful when the cable uses non-standard or
740 * not-yet-supported VID:PID items when automatic chip detection fails.
742 static int ser_hid_parse_conn_spec(
743 struct sr_serial_dev_inst *serial, const char *spec,
744 enum ser_hid_chip_t *chip_ref, char **path_ref, char **serno_ref)
747 enum ser_hid_chip_t chip;
752 *chip_ref = SER_HID_CHIP_UNKNOWN;
757 chip = SER_HID_CHIP_UNKNOWN;
760 if (!serial || !spec || !*spec)
764 /* The "hid" prefix is mandatory. */
765 if (!g_str_has_prefix(p, SER_HID_CONN_PREFIX))
767 p += strlen(SER_HID_CONN_PREFIX);
770 * Check for prefixed fields, assume chip type spec otherwise.
771 * Paths and serial numbers "are greedy" (span to the end of
772 * the input spec). Chip types are optional, and cannot repeat
780 if (g_str_has_prefix(p, SER_HID_USB_PREFIX)) {
781 rc = try_open_path(serial, p);
786 } else if (g_str_has_prefix(p, SER_HID_IOKIT_PREFIX)) {
787 rc = try_open_path(serial, p);
792 } else if (g_str_has_prefix(p, SER_HID_RAW_PREFIX)) {
793 rc = try_open_path(serial, p);
798 } else if (g_str_has_prefix(p, SER_HID_SNR_PREFIX)) {
799 p += strlen(SER_HID_SNR_PREFIX);
807 chip = ser_hid_chip_find_enum(&endptr);
815 sr_err("unsupported conn= spec %s, error at %s", spec, p);
826 if (path_ref && path)
828 if (serno_ref && serno)
834 /* Get and compare serial number. Boolean return value. */
835 static int check_serno(const char *path, const char *serno_want)
841 hid_path = extract_hidapi_path(path);
842 rc = ser_hid_hidapi_get_serno(hid_path, serno_got, sizeof(serno_got));
845 sr_dbg("DBG: %s(), could not get serial number", __func__);
849 return strcmp(serno_got, serno_want) == 0;
852 static GSList *append_find(GSList *devs, const char *path)
859 copy = g_strdup(path);
860 devs = g_slist_append(devs, copy);
865 static GSList *list_paths_for_vids_pids(const struct vid_pid_item *vid_pids)
872 for (idx = 0; /* EMPTY */; idx++) {
875 } else if (!vid_pids[idx].vid) {
878 vid = vid_pids[idx].vid;
879 pid = vid_pids[idx].pid;
881 list = ser_hid_hidapi_find_usb(list, append_find, vid, pid);
890 * Search for a matching USB device for HID communication.
892 * @param[inout] chip The HID chip type (enum).
893 * @param[inout] usbpath The USB path for the device (string).
894 * @param[in] serno The serial number to search for.
896 * @retval SR_OK upon success
897 * @retval SR_ERR_* upon failure.
899 * This routine fills in blanks which the conn= spec parser left open.
900 * When not specified yet, the HID chip type gets determined. When a
901 * serial number was specified, then search the corresponding device.
902 * Upon completion, the chip type and USB path for the device shall be
903 * known, as these are essential for subsequent operation.
905 static int ser_hid_chip_search(enum ser_hid_chip_t *chip_ref,
906 char **path_ref, const char *serno)
908 enum ser_hid_chip_t chip;
910 int have_chip, have_path, have_serno;
911 struct ser_hid_chip_functions *chip_funcs;
916 const struct vid_pid_item *vid_pids;
917 GSList *list, *matched, *matched2, *tmplist;
927 * Simplify the more complex conditions somewhat by assigning
928 * to local variables. Handle the easiest conditions first.
929 * - Either path or serial number can be specified, but not both
931 * - When a USB path is given, immediately see which HID chip
932 * the device has, without the need for enumeration.
933 * - When a serial number is given, enumerate the devices and
934 * search for that number. Either enumerate all devices of the
935 * specified HID chip type (try the VID:PID pairs that we are
936 * aware of), or try all HID devices for unknown chip types.
937 * Not finding the serial number is fatal.
938 * - When no path was found yet, enumerate the devices and pick
939 * one of them. Try known VID:PID pairs for a HID chip, or all
940 * devices for unknown chips. Make sure to pick a device of a
941 * supported chip type if the chip was not specified.
942 * - Determine the chip type if not yet known. There should be
943 * a USB path by now, determined in one of the above blocks.
945 have_chip = (chip != SER_HID_CHIP_UNKNOWN) ? 1 : 0;
946 have_path = (path && *path) ? 1 : 0;
947 have_serno = (serno && *serno) ? 1 : 0;
948 if (have_path && have_serno) {
949 sr_err("Unsupported combination of USB path and serno");
952 chip_funcs = have_chip ? get_hid_chip_funcs(chip) : NULL;
953 if (have_chip && !chip_funcs)
955 if (have_chip && !chip_funcs->vid_pid_items)
957 if (have_path && !have_chip) {
959 rc = ser_hid_hidapi_get_vid_pid(path, &vid, &pid);
962 name = ser_hid_chip_find_name_vid_pid(vid, pid);
965 chip = ser_hid_chip_find_enum(&name);
966 if (chip == SER_HID_CHIP_UNKNOWN)
971 vid_pids = have_chip ? chip_funcs->vid_pid_items : NULL;
972 list = list_paths_for_vids_pids(vid_pids);
976 for (tmplist = list; tmplist; tmplist = tmplist->next) {
977 path = get_hidapi_path_copy(tmplist->data);
978 serno_matched = check_serno(path, serno);
987 path = g_strdup(matched->data);
989 g_slist_free_full(list, g_free);
992 vid_pids = have_chip ? chip_funcs->vid_pid_items : NULL;
993 list = list_paths_for_vids_pids(vid_pids);
996 matched = matched2 = NULL;
998 /* List already only contains specified chip. */
1000 matched2 = list->next;
1002 /* Works for lists with one or multiple chips. Saves indentation. */
1003 for (tmplist = list; tmplist; tmplist = tmplist->next) {
1006 path = tmplist->data;
1007 rc = ser_hid_hidapi_get_vid_pid(path, &vid, &pid);
1008 if (rc || !ser_hid_chip_find_name_vid_pid(vid, pid))
1020 g_slist_free_full(list, g_free);
1024 * TODO Optionally fail harder, expect users to provide
1025 * unambiguous cable specs.
1028 sr_info("More than one cable matches, random pick.");
1029 path = get_hidapi_path_copy(matched->data);
1031 g_slist_free_full(list, g_free);
1033 if (have_path && !have_chip) {
1035 rc = ser_hid_hidapi_get_vid_pid(path, &vid, &pid);
1038 name = ser_hid_chip_find_name_vid_pid(vid, pid);
1039 if (!name || !*name)
1041 chip = ser_hid_chip_find_enum(&name);
1042 if (chip == SER_HID_CHIP_UNKNOWN)
1057 /* {{{ transport methods called by the common serial.c code */
1059 /* See if a serial port's name refers to an HID type. */
1060 SR_PRIV int ser_name_is_hid(struct sr_serial_dev_inst *serial)
1067 if (!serial->port || !*serial->port)
1070 /* Accept either "hid" alone, or "hid/" as a prefix. */
1071 if (!g_str_has_prefix(serial->port, SER_HID_CONN_PREFIX))
1073 off = strlen(SER_HID_CONN_PREFIX);
1074 sep = serial->port[off];
1075 if (sep != '\0' && sep != '/')
1081 static int ser_hid_open(struct sr_serial_dev_inst *serial, int flags)
1083 enum ser_hid_chip_t chip;
1084 char *usbpath, *serno;
1089 if (ser_hid_setup_funcs(serial) != 0) {
1090 sr_err("Cannot determine HID communication library.");
1094 rc = ser_hid_parse_conn_spec(serial, serial->port,
1095 &chip, &usbpath, &serno);
1100 * When a serial number was specified, or when the chip type or
1101 * the USB path were not specified, do a search to determine the
1102 * device's USB path.
1104 if (!chip || !usbpath || serno) {
1105 rc = ser_hid_chip_search(&chip, &usbpath, serno);
1111 * Open the HID device. Only store chip type and device handle
1112 * when open completes successfully.
1114 serial->hid_chip = chip;
1115 if (ser_hid_setup_funcs(serial) != 0) {
1116 sr_err("Cannot determine HID chip specific routines.");
1119 if (usbpath && *usbpath)
1120 serial->usb_path = usbpath;
1121 if (serno && *serno)
1122 serial->usb_serno = serno;
1124 rc = ser_hid_hidapi_open_dev(serial);
1126 sr_err("Failed to open HID device.");
1127 serial->hid_chip = 0;
1128 g_free(serial->usb_path);
1129 serial->usb_path = NULL;
1130 g_free(serial->usb_serno);
1131 serial->usb_serno = NULL;
1135 if (!serial->rcv_buffer)
1136 serial->rcv_buffer = g_string_sized_new(SER_HID_CHUNK_SIZE);
1141 static int ser_hid_close(struct sr_serial_dev_inst *serial)
1143 ser_hid_hidapi_close_dev(serial);
1148 static int ser_hid_set_params(struct sr_serial_dev_inst *serial,
1149 int baudrate, int bits, int parity, int stopbits,
1150 int flowcontrol, int rts, int dtr)
1152 if (ser_hid_setup_funcs(serial) != 0)
1154 if (!serial->hid_chip_funcs || !serial->hid_chip_funcs->set_params)
1157 return serial->hid_chip_funcs->set_params(serial,
1158 baudrate, bits, parity, stopbits,
1159 flowcontrol, rts, dtr);
1162 static int ser_hid_setup_source_add(struct sr_session *session,
1163 struct sr_serial_dev_inst *serial, int events, int timeout,
1164 sr_receive_data_callback cb, void *cb_data)
1166 return ser_hid_hidapi_setup_source_add(session, serial,
1167 events, timeout, cb, cb_data);
1170 static int ser_hid_setup_source_remove(struct sr_session *session,
1171 struct sr_serial_dev_inst *serial)
1173 return ser_hid_hidapi_setup_source_remove(session, serial);
1176 static GSList *ser_hid_list(GSList *list, sr_ser_list_append_t append)
1178 return ser_hid_hidapi_list(list, append);
1181 static GSList *ser_hid_find_usb(GSList *list, sr_ser_find_append_t append,
1182 uint16_t vendor_id, uint16_t product_id)
1184 return ser_hid_hidapi_find_usb(list, append, vendor_id, product_id);
1187 static int ser_hid_flush(struct sr_serial_dev_inst *serial)
1189 if (!serial->hid_chip_funcs || !serial->hid_chip_funcs->flush)
1192 return serial->hid_chip_funcs->flush(serial);
1195 static int ser_hid_drain(struct sr_serial_dev_inst *serial)
1197 if (!serial->hid_chip_funcs || !serial->hid_chip_funcs->drain)
1200 return serial->hid_chip_funcs->drain(serial);
1203 static int ser_hid_write(struct sr_serial_dev_inst *serial,
1204 const void *buf, size_t count,
1205 int nonblocking, unsigned int timeout_ms)
1207 int total, max_chunk, chunk_len;
1210 if (!serial->hid_chip_funcs || !serial->hid_chip_funcs->write_bytes)
1212 if (!serial->hid_chip_funcs->max_bytes_per_request)
1216 max_chunk = serial->hid_chip_funcs->max_bytes_per_request;
1219 if (max_chunk && chunk_len > max_chunk)
1220 chunk_len = max_chunk;
1221 rc = serial->hid_chip_funcs->write_bytes(serial, buf, chunk_len);
1223 sr_err("Error sending transmit data to HID device.");
1226 if (rc != chunk_len) {
1227 sr_warn("Short transmission to HID device (%d/%d bytes)?",
1235 * Need we wait here? For data to drain through the slow
1236 * UART. Not all UART-over-HID chips will have FIFOs.
1247 static int ser_hid_read(struct sr_serial_dev_inst *serial,
1248 void *buf, size_t count,
1249 int nonblocking, unsigned int timeout_ms)
1251 gint64 deadline_us, now_us;
1252 uint8_t buffer[SER_HID_CHUNK_SIZE];
1256 if (!serial->hid_chip_funcs || !serial->hid_chip_funcs->read_bytes)
1258 if (!serial->hid_chip_funcs->max_bytes_per_request)
1262 * Immediately satisfy the caller's request from the RX buffer
1263 * if the requested amount of data is available already.
1265 if (sr_ser_has_queued_data(serial) >= count)
1266 return sr_ser_unqueue_rx_data(serial, buf, count);
1269 * When a timeout was specified, then determine the deadline
1270 * where to stop reception.
1273 now_us = 0; /* Silence a (false) compiler warning. */
1275 now_us = g_get_monotonic_time();
1276 deadline_us = now_us + timeout_ms * 1000;
1280 * Keep receiving from the port until the caller's requested
1281 * amount of data has become available, or the timeout has
1282 * expired. In the absence of a timeout, stop reading when an
1283 * attempt no longer yields receive data.
1285 * This implementation assumes that applications will call the
1286 * read routine often enough, or that reception continues in
1287 * background, such that data is not lost and hardware and
1288 * software buffers won't overrun.
1292 * Determine the timeout (in milliseconds) for this
1293 * iteration. The 'now_us' timestamp was initially
1294 * determined above, and gets updated at the bottom of
1298 timeout_ms = (deadline_us - now_us) / 1000;
1301 } else if (nonblocking) {
1308 * Check the HID transport for the availability of more
1311 rc = serial->hid_chip_funcs->read_bytes(serial,
1312 buffer, sizeof(buffer), timeout_ms);
1314 sr_dbg("DBG: %s() read error %d.", __func__, rc);
1318 ser_hid_mask_databits(serial, buffer, rc);
1319 sr_ser_queue_rx_data(serial, buffer, rc);
1321 got = sr_ser_has_queued_data(serial);
1324 * Stop reading when the requested amount is available,
1325 * or when the timeout has expired.
1327 * TODO Consider whether grabbing all RX data is more
1328 * desirable. Implementing this approach requires a cheap
1329 * check for the availability of more data on the USB level.
1333 if (nonblocking && !rc)
1336 now_us = g_get_monotonic_time();
1337 if (now_us >= deadline_us) {
1338 sr_dbg("DBG: %s() read loop timeout.", __func__);
1345 * Satisfy the caller's demand for receive data from previously
1346 * queued incoming data.
1351 return sr_ser_unqueue_rx_data(serial, buf, count);
1354 static struct ser_lib_functions serlib_hid = {
1355 .open = ser_hid_open,
1356 .close = ser_hid_close,
1357 .flush = ser_hid_flush,
1358 .drain = ser_hid_drain,
1359 .write = ser_hid_write,
1360 .read = ser_hid_read,
1361 .set_params = ser_hid_set_params,
1362 .set_handshake = std_dummy_set_handshake,
1363 .setup_source_add = ser_hid_setup_source_add,
1364 .setup_source_remove = ser_hid_setup_source_remove,
1365 .list = ser_hid_list,
1366 .find_usb = ser_hid_find_usb,
1367 .get_frame_format = NULL,
1369 SR_PRIV struct ser_lib_functions *ser_lib_funcs_hid = &serlib_hid;
1374 SR_PRIV int ser_name_is_hid(struct sr_serial_dev_inst *serial)
1381 SR_PRIV struct ser_lib_functions *ser_lib_funcs_hid = NULL;