2 * This file is part of the libsigrok project.
4 * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
5 * Copyright (C) 2010-2012 Uwe Hermann <uwe@hermann-uwe.de>
6 * Copyright (C) 2012 Alexandru Gagniuc <mr.nuke.me@gmail.com>
7 * Copyright (C) 2014 Uffe Jakobsen <uffe@uffe.org>
8 * Copyright (C) 2017-2019 Gerhard Sittig <gerhard.sittig@gmx.net>
10 * This program is free software: you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation, either version 3 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program. If not, see <http://www.gnu.org/licenses/>.
28 #include <glib/gstdio.h>
29 #ifdef HAVE_LIBSERIALPORT
30 #include <libserialport.h>
32 #include <libsigrok/libsigrok.h>
33 #include "libsigrok-internal.h"
35 #include <windows.h> /* for HANDLE */
39 #define LOG_PREFIX "serial"
45 * Serial port handling.
49 * @defgroup grp_serial Serial port handling
51 * Serial port handling functions.
56 #ifdef HAVE_SERIAL_COMM
58 /* See if an (assumed opened) serial port is of any supported type. */
59 static int dev_is_supported(struct sr_serial_dev_inst *serial)
61 if (!serial || !serial->lib_funcs)
68 * Open the specified serial port.
70 * @param serial Previously initialized serial port structure.
71 * @param[in] flags Flags to use when opening the serial port. Possible flags
72 * include SERIAL_RDWR, SERIAL_RDONLY.
74 * If the serial structure contains a serialcomm string, it will be
75 * passed to serial_set_paramstr() after the port is opened.
77 * @retval SR_OK Success.
78 * @retval SR_ERR Failure.
82 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags)
87 sr_dbg("Invalid serial port.");
91 sr_spew("Opening serial port '%s' (flags %d).", serial->port, flags);
94 * Determine which serial transport library to use. Derive the
95 * variant from the serial port's name. Default to libserialport
96 * for backwards compatibility.
98 if (ser_name_is_hid(serial))
99 serial->lib_funcs = ser_lib_funcs_hid;
100 else if (ser_name_is_bt(serial))
101 serial->lib_funcs = ser_lib_funcs_bt;
103 serial->lib_funcs = ser_lib_funcs_libsp;
104 if (!serial->lib_funcs)
108 * Note that use of the 'rcv_buffer' is optional, and the buffer's
109 * size heavily depends on the specific transport. That's why the
110 * buffer's content gets accessed and the buffer is released here in
111 * common code, but the buffer gets allocated in libraries' open()
116 * Run the transport's open routine. Setup the bitrate and the
119 if (!serial->lib_funcs->open)
121 ret = serial->lib_funcs->open(serial, flags);
125 if (serial->serialcomm) {
126 ret = serial_set_paramstr(serial, serial->serialcomm);
131 return serial_flush(serial);
135 * Close the specified serial port.
137 * @param serial Previously initialized serial port structure.
139 * @retval SR_OK Success.
140 * @retval SR_ERR Failure.
144 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial)
149 sr_dbg("Invalid serial port.");
153 sr_spew("Closing serial port %s.", serial->port);
155 if (!serial->lib_funcs || !serial->lib_funcs->close)
158 rc = serial->lib_funcs->close(serial);
159 if (rc == SR_OK && serial->rcv_buffer) {
160 g_string_free(serial->rcv_buffer, TRUE);
161 serial->rcv_buffer = NULL;
168 * Flush serial port buffers. Empty buffers, discard pending RX and TX data.
170 * @param serial Previously initialized serial port structure.
172 * @retval SR_OK Success.
173 * @retval SR_ERR Failure.
177 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial)
180 sr_dbg("Invalid serial port.");
184 sr_spew("Flushing serial port %s.", serial->port);
186 sr_ser_discard_queued_data(serial);
188 if (!serial->lib_funcs || !serial->lib_funcs->flush)
191 return serial->lib_funcs->flush(serial);
195 * Drain serial port buffers. Wait for pending TX data to be sent.
197 * @param serial Previously initialized serial port structure.
199 * @retval SR_OK Success.
200 * @retval SR_ERR Failure.
204 SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial)
207 sr_dbg("Invalid serial port.");
211 sr_spew("Draining serial port %s.", serial->port);
213 if (!serial->lib_funcs || !serial->lib_funcs->drain)
216 return serial->lib_funcs->drain(serial);
220 * Provide an internal RX data buffer for the serial port. This is not
221 * supposed to be used directly by applications. Instead optional and
222 * alternative transports for serial communication can use this buffer
223 * if their progress is driven from background activity, and is not
224 * (directly) driven by external API calls.
226 * BEWARE! This implementation assumes that data which gets communicated
227 * via UART can get stored in a GString (which is a char array). Since
228 * the API hides this detail, we can address this issue later when needed.
229 * Callers use the API which communicates bytes.
231 * Applications optionally can register a "per RX chunk" callback, when
232 * they depend on the frame boundaries of the respective physical layer.
233 * Most callers just want the stream of RX data, and can use the buffer.
235 * The availability of RX chunks to callbacks, as well as the capability
236 * to pass on exact frames as chunks or potential re-assembly of chunks
237 * to a single data block, depend on each transport's implementation.
241 * Register application callback for RX data chunks.
243 * @param[in] serial Previously initialized serial port instance.
244 * @param[in] cb Routine to call as RX data becomes available.
245 * @param[in] cb_data User data to pass to the callback in addition to RX data.
247 * @retval SR_ERR_ARG Invalid parameters.
248 * @retval SR_OK Successful registration.
250 * Callbacks get unregistered by specifying NULL for the 'cb' parameter.
254 SR_PRIV int serial_set_read_chunk_cb(struct sr_serial_dev_inst *serial,
255 serial_rx_chunk_callback cb, void *cb_data)
260 serial->rx_chunk_cb_func = cb;
261 serial->rx_chunk_cb_data = cb_data;
267 * Discard previously queued RX data. Internal to the serial subsystem,
268 * coordination between common and transport specific support code.
270 * @param[in] serial Previously opened serial port instance.
274 SR_PRIV void sr_ser_discard_queued_data(struct sr_serial_dev_inst *serial)
276 if (!serial || !serial->rcv_buffer)
279 g_string_truncate(serial->rcv_buffer, 0);
283 * Get amount of queued RX data. Internal to the serial subsystem,
284 * coordination between common and transport specific support code.
286 * @param[in] serial Previously opened serial port instance.
290 SR_PRIV size_t sr_ser_has_queued_data(struct sr_serial_dev_inst *serial)
292 if (!serial || !serial->rcv_buffer)
295 return serial->rcv_buffer->len;
299 * Queue received data. Internal to the serial subsystem, coordination
300 * between common and transport specific support code.
302 * @param[in] serial Previously opened serial port instance.
303 * @param[in] data Pointer to data bytes to queue.
304 * @param[in] len Number of data bytes to queue.
308 SR_PRIV void sr_ser_queue_rx_data(struct sr_serial_dev_inst *serial,
309 const uint8_t *data, size_t len)
311 if (!serial || !data || !len)
314 if (serial->rx_chunk_cb_func)
315 serial->rx_chunk_cb_func(serial, serial->rx_chunk_cb_data, data, len);
316 else if (serial->rcv_buffer)
317 g_string_append_len(serial->rcv_buffer, (const gchar *)data, len);
321 * Retrieve previously queued RX data. Internal to the serial subsystem,
322 * coordination between common and transport specific support code.
324 * @param[in] serial Previously opened serial port instance.
325 * @param[out] data Pointer to store retrieved data bytes into.
326 * @param[in] len Number of data bytes to retrieve.
330 SR_PRIV size_t sr_ser_unqueue_rx_data(struct sr_serial_dev_inst *serial,
331 uint8_t *data, size_t len)
336 if (!serial || !data || !len)
339 qlen = sr_ser_has_queued_data(serial);
343 buf = serial->rcv_buffer;
347 memcpy(data, buf->str, len);
348 g_string_erase(buf, 0, len);
355 * Check for available receive data.
357 * @param[in] serial Previously opened serial port instance.
359 * @returns The number of (known) available RX data bytes.
361 * Returns 0 if no receive data is available, or if the amount of
362 * available receive data cannot get determined.
366 SR_PRIV size_t serial_has_receive_data(struct sr_serial_dev_inst *serial)
368 size_t lib_count, buf_count;
374 if (serial->lib_funcs && serial->lib_funcs->get_rx_avail)
375 lib_count = serial->lib_funcs->get_rx_avail(serial);
377 buf_count = sr_ser_has_queued_data(serial);
379 return lib_count + buf_count;
382 static int _serial_write(struct sr_serial_dev_inst *serial,
383 const void *buf, size_t count,
384 int nonblocking, unsigned int timeout_ms)
389 sr_dbg("Invalid serial port.");
393 if (!serial->lib_funcs || !serial->lib_funcs->write)
395 ret = serial->lib_funcs->write(serial, buf, count,
396 nonblocking, timeout_ms);
397 sr_spew("Wrote %zd/%zu bytes.", ret, count);
403 * Write a number of bytes to the specified serial port, blocking until finished.
405 * @param serial Previously initialized serial port structure.
406 * @param[in] buf Buffer containing the bytes to write.
407 * @param[in] count Number of bytes to write.
408 * @param[in] timeout_ms Timeout in ms, or 0 for no timeout.
410 * @retval SR_ERR_ARG Invalid argument.
411 * @retval SR_ERR Other error.
412 * @retval other The number of bytes written. If this is less than the number
413 * specified in the call, the timeout was reached.
417 SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
418 const void *buf, size_t count, unsigned int timeout_ms)
420 return _serial_write(serial, buf, count, 0, timeout_ms);
424 * Write a number of bytes to the specified serial port, return immediately.
426 * @param serial Previously initialized serial port structure.
427 * @param[in] buf Buffer containing the bytes to write.
428 * @param[in] count Number of bytes to write.
430 * @retval SR_ERR_ARG Invalid argument.
431 * @retval SR_ERR Other error.
432 * @retval other The number of bytes written.
436 SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial,
437 const void *buf, size_t count)
439 return _serial_write(serial, buf, count, 1, 0);
442 static int _serial_read(struct sr_serial_dev_inst *serial,
443 void *buf, size_t count, int nonblocking, unsigned int timeout_ms)
448 sr_dbg("Invalid serial port.");
452 if (!serial->lib_funcs || !serial->lib_funcs->read)
454 ret = serial->lib_funcs->read(serial, buf, count,
455 nonblocking, timeout_ms);
457 sr_spew("Read %zd/%zu bytes.", ret, count);
463 * Read a number of bytes from the specified serial port, block until finished.
465 * @param serial Previously initialized serial port structure.
466 * @param buf Buffer where to store the bytes that are read.
467 * @param[in] count The number of bytes to read.
468 * @param[in] timeout_ms Timeout in ms, or 0 for no timeout.
470 * @retval SR_ERR_ARG Invalid argument.
471 * @retval SR_ERR Other error.
472 * @retval other The number of bytes read. If this is less than the number
473 * requested, the timeout was reached.
477 SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial,
478 void *buf, size_t count, unsigned int timeout_ms)
480 return _serial_read(serial, buf, count, 0, timeout_ms);
484 * Try to read up to @a count bytes from the specified serial port, return
485 * immediately with what's available.
487 * @param serial Previously initialized serial port structure.
488 * @param buf Buffer where to store the bytes that are read.
489 * @param[in] count The number of bytes to read.
491 * @retval SR_ERR_ARG Invalid argument.
492 * @retval SR_ERR Other error.
493 * @retval other The number of bytes read.
497 SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial,
498 void *buf, size_t count)
500 return _serial_read(serial, buf, count, 1, 0);
504 * Set serial parameters for the specified serial port.
506 * @param serial Previously initialized serial port structure.
507 * @param[in] baudrate The baudrate to set.
508 * @param[in] bits The number of data bits to use (5, 6, 7 or 8).
509 * @param[in] parity The parity setting to use (0 = none, 1 = even, 2 = odd).
510 * @param[in] stopbits The number of stop bits to use (1 or 2).
511 * @param[in] flowcontrol The flow control settings to use (0 = none,
512 * 1 = RTS/CTS, 2 = XON/XOFF).
513 * @param[in] rts Status of RTS line (0 or 1; required by some interfaces).
514 * @param[in] dtr Status of DTR line (0 or 1; required by some interfaces).
516 * @retval SR_OK Success.
517 * @retval SR_ERR Failure.
521 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial,
522 int baudrate, int bits, int parity, int stopbits,
523 int flowcontrol, int rts, int dtr)
528 sr_dbg("Invalid serial port.");
532 sr_spew("Setting serial parameters on port %s.", serial->port);
534 if (!serial->lib_funcs || !serial->lib_funcs->set_params)
536 ret = serial->lib_funcs->set_params(serial,
537 baudrate, bits, parity, stopbits,
538 flowcontrol, rts, dtr);
540 serial->comm_params.bit_rate = baudrate;
541 serial->comm_params.data_bits = bits;
542 serial->comm_params.parity_bits = parity ? 1 : 0;
543 serial->comm_params.stop_bits = stopbits;
544 sr_dbg("DBG: %s() rate %d, %d%s%d", __func__,
546 (parity == 0) ? "n" : "x",
554 * Set serial parameters for the specified serial port from parameter string.
556 * @param serial Previously initialized serial port structure.
557 * @param[in] paramstr A serial communication parameters string of the form
558 * "<baudrate>/<bits><parity><stopbits>{/<option>}".\n
559 * Examples: "9600/8n1", "600/7o2/dtr=1/rts=0" or "460800/8n1/flow=2".\n
560 * \<baudrate\>=integer Baud rate.\n
561 * \<bits\>=5|6|7|8 Number of data bits.\n
562 * \<parity\>=n|e|o None, even, odd.\n
563 * \<stopbits\>=1|2 One or two stop bits.\n
565 * dtr=0|1 Set DTR off resp. on.\n
566 * flow=0|1|2 Flow control. 0 for none, 1 for RTS/CTS, 2 for XON/XOFF.\n
567 * rts=0|1 Set RTS off resp. on.\n
568 * Please note that values and combinations of these parameters must be
569 * supported by the concrete serial interface hardware and the drivers for it.
571 * @retval SR_OK Success.
572 * @retval SR_ERR Failure.
576 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
577 const char *paramstr)
580 #define SERIAL_COMM_SPEC "^(\\d+)(/([5678])([neo])([12]))?(.*)$"
585 int speed, databits, parity, stopbits, flow, rts, dtr, i;
586 char *mstr, **opts, **kv;
590 parity = SP_PARITY_NONE;
593 sr_spew("Parsing parameters from \"%s\".", paramstr);
594 reg = g_regex_new(SERIAL_COMM_SPEC, 0, 0, NULL);
595 if (g_regex_match(reg, paramstr, 0, &match)) {
596 if ((mstr = g_match_info_fetch(match, 1)))
597 speed = strtoul(mstr, NULL, 10);
599 if ((mstr = g_match_info_fetch(match, 3)) && mstr[0])
600 databits = strtoul(mstr, NULL, 10);
602 if ((mstr = g_match_info_fetch(match, 4)) && mstr[0]) {
605 parity = SP_PARITY_NONE;
608 parity = SP_PARITY_EVEN;
611 parity = SP_PARITY_ODD;
616 if ((mstr = g_match_info_fetch(match, 5)) && mstr[0])
617 stopbits = strtoul(mstr, NULL, 10);
619 if ((mstr = g_match_info_fetch(match, 6)) && mstr[0] != '\0') {
620 if (mstr[0] != '/') {
621 sr_dbg("missing separator before extra options");
624 /* A set of "key=value" options separated by / */
625 opts = g_strsplit(mstr + 1, "/", 0);
626 for (i = 0; opts[i]; i++) {
627 kv = g_strsplit(opts[i], "=", 2);
628 if (!strncmp(kv[0], "rts", 3)) {
631 else if (kv[1][0] == '0')
634 sr_dbg("invalid value for rts: %c", kv[1][0]);
637 } else if (!strncmp(kv[0], "dtr", 3)) {
640 else if (kv[1][0] == '0')
643 sr_dbg("invalid value for dtr: %c", kv[1][0]);
646 } else if (!strncmp(kv[0], "flow", 4)) {
649 else if (kv[1][0] == '1')
651 else if (kv[1][0] == '2')
654 sr_dbg("invalid value for flow: %c", kv[1][0]);
665 g_match_info_unref(match);
667 sr_spew("Got params: rate %d, frame %d/%d/%d, flow %d, rts %d, dtr %d.",
668 speed, databits, parity, stopbits, flow, rts, dtr);
671 return serial_set_params(serial, speed, databits, parity,
672 stopbits, flow, rts, dtr);
674 sr_dbg("Could not infer speed from parameter string.");
680 * Read a line from the specified serial port.
682 * @param[in] serial Previously initialized serial port structure.
683 * @param[out] buf Buffer where to store the bytes that are read.
684 * @param[in] buflen Size of the buffer.
685 * @param[in] timeout_ms How long to wait for a line to come in.
687 * Reading stops when CR or LF is found, which is stripped from the buffer.
689 * @retval SR_OK Success.
690 * @retval SR_ERR Failure.
694 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial,
695 char **buf, int *buflen, gint64 timeout_ms)
697 gint64 start, remaining;
701 sr_dbg("Invalid serial port.");
705 if (!dev_is_supported(serial)) {
706 sr_dbg("Cannot use unopened serial port %s.", serial->port);
710 start = g_get_monotonic_time();
711 remaining = timeout_ms;
716 len = maxlen - *buflen - 1;
719 len = serial_read_blocking(serial, *buf + *buflen, 1, remaining);
722 *(*buf + *buflen) = '\0';
723 if (*buflen > 0 && (*(*buf + *buflen - 1) == '\r'
724 || *(*buf + *buflen - 1) == '\n')) {
725 /* Strip CR/LF and terminate. */
726 *(*buf + --*buflen) = '\0';
730 /* Reduce timeout by time elapsed. */
731 remaining = timeout_ms - ((g_get_monotonic_time() - start) / 1000);
739 sr_dbg("Received %d: '%s'.", *buflen, *buf);
745 * Try to find a valid packet in a serial data stream.
747 * @param serial Previously initialized serial port structure.
748 * @param buf Buffer containing the bytes to write.
749 * @param buflen Size of the buffer.
750 * @param[in] packet_size Size, in bytes, of a valid packet.
751 * @param is_valid Callback that assesses whether the packet is valid or not.
752 * @param[in] timeout_ms The timeout after which, if no packet is detected, to
755 * @retval SR_OK Valid packet was found within the given timeout.
756 * @retval SR_ERR Failure.
760 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
761 uint8_t *buf, size_t *buflen,
763 packet_valid_callback is_valid,
766 uint64_t start, time, byte_delay_us;
767 size_t ibuf, i, maxlen;
772 sr_dbg("Detecting packets on %s (timeout = %" PRIu64 "ms).",
773 serial->port, timeout_ms);
775 if (maxlen < (packet_size * 2) ) {
776 sr_err("Buffer size must be at least twice the packet size.");
780 /* Assume 8n1 transmission. That is 10 bits for every byte. */
781 byte_delay_us = serial_timeout(serial, 1) * 1000;
782 start = g_get_monotonic_time();
785 while (ibuf < maxlen) {
786 len = serial_read_nonblocking(serial, &buf[ibuf], 1);
789 } else if (len == 0) {
790 /* No logging, already done in serial_read(). */
792 /* Error reading byte, but continuing anyway. */
795 time = g_get_monotonic_time() - start;
798 if ((ibuf - i) >= packet_size) {
800 /* We have at least a packet's worth of data. */
801 text = sr_hexdump_new(&buf[i], packet_size);
802 sr_spew("Trying packet: %s", text->str);
803 sr_hexdump_free(text);
804 if (is_valid(&buf[i])) {
805 sr_spew("Found valid %zu-byte packet after "
806 "%" PRIu64 "ms.", (ibuf - i), time);
810 sr_spew("Got %zu bytes, but not a valid "
811 "packet.", (ibuf - i));
813 /* Not a valid packet. Continue searching. */
816 if (time >= timeout_ms) {
818 sr_dbg("Detection timed out after %" PRIu64 "ms.", time);
822 g_usleep(byte_delay_us);
827 sr_err("Didn't find a valid packet (read %zu bytes).", *buflen);
833 * Extract the serial device and options from the options linked list.
835 * @param options List of options passed from the command line.
836 * @param serial_device Pointer where to store the extracted serial device.
837 * @param serial_options Pointer where to store the optional extracted serial
840 * @return SR_OK if a serial_device is found, SR_ERR if no device is found. The
841 * returned string should not be freed by the caller.
845 SR_PRIV int sr_serial_extract_options(GSList *options,
846 const char **serial_device, const char **serial_options)
849 struct sr_config *src;
851 *serial_device = NULL;
853 for (l = options; l; l = l->next) {
857 *serial_device = g_variant_get_string(src->data, NULL);
858 sr_dbg("Parsed serial device: %s.", *serial_device);
860 case SR_CONF_SERIALCOMM:
861 *serial_options = g_variant_get_string(src->data, NULL);
862 sr_dbg("Parsed serial options: %s.", *serial_options);
867 if (!*serial_device) {
868 sr_dbg("No serial device specified.");
876 SR_PRIV int serial_source_add(struct sr_session *session,
877 struct sr_serial_dev_inst *serial, int events, int timeout,
878 sr_receive_data_callback cb, void *cb_data)
880 if ((events & (G_IO_IN | G_IO_ERR)) && (events & G_IO_OUT)) {
881 sr_err("Cannot poll input/error and output simultaneously.");
885 if (!dev_is_supported(serial)) {
886 sr_err("Invalid serial port.");
890 if (!serial->lib_funcs || !serial->lib_funcs->setup_source_add)
893 return serial->lib_funcs->setup_source_add(session, serial,
894 events, timeout, cb, cb_data);
898 SR_PRIV int serial_source_remove(struct sr_session *session,
899 struct sr_serial_dev_inst *serial)
901 if (!dev_is_supported(serial)) {
902 sr_err("Invalid serial port.");
906 if (!serial->lib_funcs || !serial->lib_funcs->setup_source_remove)
909 return serial->lib_funcs->setup_source_remove(session, serial);
913 * Create/allocate a new sr_serial_port structure.
915 * @param name The OS dependent name of the serial port. Must not be NULL.
916 * @param description An end user friendly description for the serial port.
917 * Can be NULL (in that case the empty string is used
920 * @return The newly allocated sr_serial_port struct.
922 static struct sr_serial_port *sr_serial_new(const char *name,
923 const char *description)
925 struct sr_serial_port *serial;
930 serial = g_malloc0(sizeof(*serial));
931 serial->name = g_strdup(name);
932 serial->description = g_strdup(description ? description : "");
938 * Free a previously allocated sr_serial_port structure.
940 * @param serial The sr_serial_port struct to free. Must not be NULL.
942 SR_API void sr_serial_free(struct sr_serial_port *serial)
946 g_free(serial->name);
947 g_free(serial->description);
951 static GSList *append_port_list(GSList *devs, const char *name, const char *desc)
953 return g_slist_append(devs, sr_serial_new(name, desc));
957 * List available serial devices.
959 * @return A GSList of strings containing the path of the serial devices or
960 * NULL if no serial device is found. The returned list must be freed
963 SR_API GSList *sr_serial_list(const struct sr_dev_driver *driver)
966 GSList *(*list_func)(GSList *list, sr_ser_list_append_t append);
968 /* Currently unused, but will be used by some drivers later on. */
972 if (ser_lib_funcs_libsp && ser_lib_funcs_libsp->list) {
973 list_func = ser_lib_funcs_libsp->list;
974 tty_devs = list_func(tty_devs, append_port_list);
976 if (ser_lib_funcs_hid && ser_lib_funcs_hid->list) {
977 list_func = ser_lib_funcs_hid->list;
978 tty_devs = list_func(tty_devs, append_port_list);
980 if (ser_lib_funcs_bt && ser_lib_funcs_bt->list) {
981 list_func = ser_lib_funcs_bt->list;
982 tty_devs = list_func(tty_devs, append_port_list);
988 static GSList *append_port_find(GSList *devs, const char *name)
993 return g_slist_append(devs, g_strdup(name));
997 * Find USB serial devices via the USB vendor ID and product ID.
999 * @param[in] vendor_id Vendor ID of the USB device.
1000 * @param[in] product_id Product ID of the USB device.
1002 * @return A GSList of strings containing the path of the serial device or
1003 * NULL if no serial device is found. The returned list must be freed
1008 SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id)
1011 GSList *(*find_func)(GSList *list, sr_ser_find_append_t append,
1012 uint16_t vid, uint16_t pid);
1015 if (ser_lib_funcs_libsp && ser_lib_funcs_libsp->find_usb) {
1016 find_func = ser_lib_funcs_libsp->find_usb;
1017 tty_devs = find_func(tty_devs, append_port_find,
1018 vendor_id, product_id);
1020 if (ser_lib_funcs_hid && ser_lib_funcs_hid->find_usb) {
1021 find_func = ser_lib_funcs_hid->find_usb;
1022 tty_devs = find_func(tty_devs, append_port_find,
1023 vendor_id, product_id);
1030 SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes)
1032 int bits, baud, ret, timeout_ms;
1034 /* Get the bitrate and frame length. */
1036 if (port->lib_funcs && port->lib_funcs->get_frame_format) {
1037 ret = port->lib_funcs->get_frame_format(port, &baud, &bits);
1041 baud = port->comm_params.bit_rate;
1042 bits = 1 + port->comm_params.data_bits +
1043 port->comm_params.parity_bits +
1044 port->comm_params.stop_bits;
1047 /* Derive the timeout. Default to 1s. */
1050 /* Throw in 10ms for misc OS overhead. */
1052 timeout_ms += ((1000.0 / baud) * bits) * num_bytes;
1060 /* TODO Put fallback.c content here? */