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;
102 else if (ser_name_is_tcpraw(serial))
103 serial->lib_funcs = ser_lib_funcs_tcpraw;
105 serial->lib_funcs = ser_lib_funcs_libsp;
106 if (!serial->lib_funcs)
110 * Note that use of the 'rcv_buffer' is optional, and the buffer's
111 * size heavily depends on the specific transport. That's why the
112 * buffer's content gets accessed and the buffer is released here in
113 * common code, but the buffer gets allocated in libraries' open()
118 * Run the transport's open routine. Setup the bitrate and the
121 if (!serial->lib_funcs->open)
123 ret = serial->lib_funcs->open(serial, flags);
127 if (serial->serialcomm) {
128 ret = serial_set_paramstr(serial, serial->serialcomm);
134 * Flush potentially dangling RX data. Availability of the
135 * flush primitive depends on the transport/cable, absense
138 ret = serial_flush(serial);
139 if (ret == SR_ERR_NA)
148 * Close the specified serial port.
150 * @param serial Previously initialized serial port structure.
152 * @retval SR_OK Success.
153 * @retval SR_ERR Failure.
157 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial)
162 sr_dbg("Invalid serial port.");
166 sr_spew("Closing serial port %s.", serial->port);
168 if (!serial->lib_funcs || !serial->lib_funcs->close)
171 rc = serial->lib_funcs->close(serial);
172 if (rc == SR_OK && serial->rcv_buffer) {
173 g_string_free(serial->rcv_buffer, TRUE);
174 serial->rcv_buffer = NULL;
181 * Flush serial port buffers. Empty buffers, discard pending RX and TX data.
183 * @param serial Previously initialized serial port structure.
185 * @retval SR_OK Success.
186 * @retval SR_ERR Failure.
190 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial)
193 sr_dbg("Invalid serial port.");
197 sr_spew("Flushing serial port %s.", serial->port);
199 sr_ser_discard_queued_data(serial);
201 if (!serial->lib_funcs || !serial->lib_funcs->flush)
204 return serial->lib_funcs->flush(serial);
208 * Drain serial port buffers. Wait for pending TX data to be sent.
210 * @param serial Previously initialized serial port structure.
212 * @retval SR_OK Success.
213 * @retval SR_ERR Failure.
217 SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial)
220 sr_dbg("Invalid serial port.");
224 sr_spew("Draining serial port %s.", serial->port);
226 if (!serial->lib_funcs || !serial->lib_funcs->drain)
229 return serial->lib_funcs->drain(serial);
233 * Provide an internal RX data buffer for the serial port. This is not
234 * supposed to be used directly by applications. Instead optional and
235 * alternative transports for serial communication can use this buffer
236 * if their progress is driven from background activity, and is not
237 * (directly) driven by external API calls.
239 * BEWARE! This implementation assumes that data which gets communicated
240 * via UART can get stored in a GString (which is a char array). Since
241 * the API hides this detail, we can address this issue later when needed.
242 * Callers use the API which communicates bytes.
244 * Applications optionally can register a "per RX chunk" callback, when
245 * they depend on the frame boundaries of the respective physical layer.
246 * Most callers just want the stream of RX data, and can use the buffer.
248 * The availability of RX chunks to callbacks, as well as the capability
249 * to pass on exact frames as chunks or potential re-assembly of chunks
250 * to a single data block, depend on each transport's implementation.
254 * Register application callback for RX data chunks.
256 * @param[in] serial Previously initialized serial port instance.
257 * @param[in] cb Routine to call as RX data becomes available.
258 * @param[in] cb_data User data to pass to the callback in addition to RX data.
260 * @retval SR_ERR_ARG Invalid parameters.
261 * @retval SR_OK Successful registration.
263 * Callbacks get unregistered by specifying NULL for the 'cb' parameter.
267 SR_PRIV int serial_set_read_chunk_cb(struct sr_serial_dev_inst *serial,
268 serial_rx_chunk_callback cb, void *cb_data)
273 serial->rx_chunk_cb_func = cb;
274 serial->rx_chunk_cb_data = cb_data;
280 * Discard previously queued RX data. Internal to the serial subsystem,
281 * coordination between common and transport specific support code.
283 * @param[in] serial Previously opened serial port instance.
287 SR_PRIV void sr_ser_discard_queued_data(struct sr_serial_dev_inst *serial)
289 if (!serial || !serial->rcv_buffer)
292 g_string_truncate(serial->rcv_buffer, 0);
296 * Get amount of queued RX data. Internal to the serial subsystem,
297 * coordination between common and transport specific support code.
299 * @param[in] serial Previously opened serial port instance.
303 SR_PRIV size_t sr_ser_has_queued_data(struct sr_serial_dev_inst *serial)
305 if (!serial || !serial->rcv_buffer)
308 return serial->rcv_buffer->len;
312 * Queue received data. Internal to the serial subsystem, coordination
313 * between common and transport specific support code.
315 * @param[in] serial Previously opened serial port instance.
316 * @param[in] data Pointer to data bytes to queue.
317 * @param[in] len Number of data bytes to queue.
321 SR_PRIV void sr_ser_queue_rx_data(struct sr_serial_dev_inst *serial,
322 const uint8_t *data, size_t len)
324 if (!serial || !data || !len)
327 if (serial->rx_chunk_cb_func)
328 serial->rx_chunk_cb_func(serial, serial->rx_chunk_cb_data, data, len);
329 else if (serial->rcv_buffer)
330 g_string_append_len(serial->rcv_buffer, (const gchar *)data, len);
334 * Retrieve previously queued RX data. Internal to the serial subsystem,
335 * coordination between common and transport specific support code.
337 * @param[in] serial Previously opened serial port instance.
338 * @param[out] data Pointer to store retrieved data bytes into.
339 * @param[in] len Number of data bytes to retrieve.
343 SR_PRIV size_t sr_ser_unqueue_rx_data(struct sr_serial_dev_inst *serial,
344 uint8_t *data, size_t len)
349 if (!serial || !data || !len)
352 qlen = sr_ser_has_queued_data(serial);
356 buf = serial->rcv_buffer;
360 memcpy(data, buf->str, len);
361 g_string_erase(buf, 0, len);
368 * Check for available receive data.
370 * @param[in] serial Previously opened serial port instance.
372 * @returns The number of (known) available RX data bytes.
374 * Returns 0 if no receive data is available, or if the amount of
375 * available receive data cannot get determined.
379 SR_PRIV size_t serial_has_receive_data(struct sr_serial_dev_inst *serial)
381 size_t lib_count, buf_count;
387 if (serial->lib_funcs && serial->lib_funcs->get_rx_avail)
388 lib_count = serial->lib_funcs->get_rx_avail(serial);
390 buf_count = sr_ser_has_queued_data(serial);
392 return lib_count + buf_count;
395 static int _serial_write(struct sr_serial_dev_inst *serial,
396 const void *buf, size_t count,
397 int nonblocking, unsigned int timeout_ms)
402 sr_dbg("Invalid serial port.");
406 if (!serial->lib_funcs || !serial->lib_funcs->write)
408 ret = serial->lib_funcs->write(serial, buf, count,
409 nonblocking, timeout_ms);
410 sr_spew("Wrote %zd/%zu bytes.", ret, count);
416 * Write a number of bytes to the specified serial port, blocking until finished.
418 * @param serial Previously initialized serial port structure.
419 * @param[in] buf Buffer containing the bytes to write.
420 * @param[in] count Number of bytes to write.
421 * @param[in] timeout_ms Timeout in ms, or 0 for no timeout.
423 * @retval SR_ERR_ARG Invalid argument.
424 * @retval SR_ERR Other error.
425 * @retval other The number of bytes written. If this is less than the number
426 * specified in the call, the timeout was reached.
430 SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
431 const void *buf, size_t count, unsigned int timeout_ms)
433 return _serial_write(serial, buf, count, 0, timeout_ms);
437 * Write a number of bytes to the specified serial port, return immediately.
439 * @param serial Previously initialized serial port structure.
440 * @param[in] buf Buffer containing the bytes to write.
441 * @param[in] count Number of bytes to write.
443 * @retval SR_ERR_ARG Invalid argument.
444 * @retval SR_ERR Other error.
445 * @retval other The number of bytes written.
449 SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial,
450 const void *buf, size_t count)
452 return _serial_write(serial, buf, count, 1, 0);
455 static int _serial_read(struct sr_serial_dev_inst *serial,
456 void *buf, size_t count, int nonblocking, unsigned int timeout_ms)
461 sr_dbg("Invalid serial port.");
465 if (!serial->lib_funcs || !serial->lib_funcs->read)
467 ret = serial->lib_funcs->read(serial, buf, count,
468 nonblocking, timeout_ms);
470 sr_spew("Read %zd/%zu bytes.", ret, count);
476 * Read a number of bytes from the specified serial port, block until finished.
478 * @param serial Previously initialized serial port structure.
479 * @param buf Buffer where to store the bytes that are read.
480 * @param[in] count The number of bytes to read.
481 * @param[in] timeout_ms Timeout in ms, or 0 for no timeout.
483 * @retval SR_ERR_ARG Invalid argument.
484 * @retval SR_ERR Other error.
485 * @retval other The number of bytes read. If this is less than the number
486 * requested, the timeout was reached.
490 SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial,
491 void *buf, size_t count, unsigned int timeout_ms)
493 return _serial_read(serial, buf, count, 0, timeout_ms);
497 * Try to read up to @a count bytes from the specified serial port, return
498 * immediately with what's available.
500 * @param serial Previously initialized serial port structure.
501 * @param buf Buffer where to store the bytes that are read.
502 * @param[in] count The number of bytes to read.
504 * @retval SR_ERR_ARG Invalid argument.
505 * @retval SR_ERR Other error.
506 * @retval other The number of bytes read.
510 SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial,
511 void *buf, size_t count)
513 return _serial_read(serial, buf, count, 1, 0);
517 * Set serial parameters for the specified serial port.
519 * @param serial Previously initialized serial port structure.
520 * @param[in] baudrate The baudrate to set.
521 * @param[in] bits The number of data bits to use (5, 6, 7 or 8).
522 * @param[in] parity The parity setting to use (0 = none, 1 = even, 2 = odd).
523 * @param[in] stopbits The number of stop bits to use (1 or 2).
524 * @param[in] flowcontrol The flow control settings to use (0 = none,
525 * 1 = RTS/CTS, 2 = XON/XOFF).
526 * @param[in] rts Status of RTS line (0 or 1; required by some interfaces).
527 * @param[in] dtr Status of DTR line (0 or 1; required by some interfaces).
529 * @retval SR_OK Success.
530 * @retval SR_ERR Failure.
534 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial,
535 int baudrate, int bits, int parity, int stopbits,
536 int flowcontrol, int rts, int dtr)
541 sr_dbg("Invalid serial port.");
545 sr_spew("Setting serial parameters on port %s.", serial->port);
547 if (!serial->lib_funcs || !serial->lib_funcs->set_params)
549 ret = serial->lib_funcs->set_params(serial,
550 baudrate, bits, parity, stopbits,
551 flowcontrol, rts, dtr);
553 serial->comm_params.bit_rate = baudrate;
554 serial->comm_params.data_bits = bits;
555 serial->comm_params.parity_bits = parity ? 1 : 0;
556 serial->comm_params.stop_bits = stopbits;
557 sr_dbg("DBG: %s() rate %d, %d%s%d", __func__,
559 (parity == 0) ? "n" : "x",
567 * Manipulate handshake state for the specified serial port.
569 * @param serial Previously initialized serial port structure.
570 * @param[in] rts Status of RTS line (0 or 1; or -1 to ignore).
571 * @param[in] dtr Status of DTR line (0 or 1; or -1 to ignore).
573 * @retval SR_OK Success.
574 * @retval SR_ERR Failure.
578 SR_PRIV int serial_set_handshake(struct sr_serial_dev_inst *serial,
584 sr_dbg("Invalid serial port.");
588 sr_spew("Modifying serial parameters on port %s.", serial->port);
590 if (!serial->lib_funcs || !serial->lib_funcs->set_handshake)
592 ret = serial->lib_funcs->set_handshake(serial, rts, dtr);
598 * Set serial parameters for the specified serial port from parameter string.
600 * @param serial Previously initialized serial port structure.
601 * @param[in] paramstr A serial communication parameters string of the form
602 * "<baudrate>/<bits><parity><stopbits>{/<option>}".\n
603 * Examples: "9600/8n1", "600/7o2/dtr=1/rts=0" or "460800/8n1/flow=2".\n
604 * \<baudrate\>=integer Baud rate.\n
605 * \<bits\>=5|6|7|8 Number of data bits.\n
606 * \<parity\>=n|e|o None, even, odd.\n
607 * \<stopbits\>=1|2 One or two stop bits.\n
609 * dtr=0|1 Set DTR off resp. on.\n
610 * flow=0|1|2 Flow control. 0 for none, 1 for RTS/CTS, 2 for XON/XOFF.\n
611 * rts=0|1 Set RTS off resp. on.\n
612 * Please note that values and combinations of these parameters must be
613 * supported by the concrete serial interface hardware and the drivers for it.
615 * @retval SR_OK Success.
616 * @retval SR_ERR Failure.
620 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
621 const char *paramstr)
624 #define SERIAL_COMM_SPEC "^(\\d+)(/([5678])([neo])([12]))?(.*)$"
629 int speed, databits, parity, stopbits, flow, rts, dtr, i;
630 char *mstr, **opts, **kv;
634 parity = SP_PARITY_NONE;
637 sr_spew("Parsing parameters from \"%s\".", paramstr);
638 reg = g_regex_new(SERIAL_COMM_SPEC, 0, 0, NULL);
639 if (g_regex_match(reg, paramstr, 0, &match)) {
640 if ((mstr = g_match_info_fetch(match, 1)))
641 speed = strtoul(mstr, NULL, 10);
643 if ((mstr = g_match_info_fetch(match, 3)) && mstr[0])
644 databits = strtoul(mstr, NULL, 10);
646 if ((mstr = g_match_info_fetch(match, 4)) && mstr[0]) {
649 parity = SP_PARITY_NONE;
652 parity = SP_PARITY_EVEN;
655 parity = SP_PARITY_ODD;
660 if ((mstr = g_match_info_fetch(match, 5)) && mstr[0])
661 stopbits = strtoul(mstr, NULL, 10);
663 if ((mstr = g_match_info_fetch(match, 6)) && mstr[0] != '\0') {
664 if (mstr[0] != '/') {
665 sr_dbg("missing separator before extra options");
668 /* A set of "key=value" options separated by / */
669 opts = g_strsplit(mstr + 1, "/", 0);
670 for (i = 0; opts[i]; i++) {
671 kv = g_strsplit(opts[i], "=", 2);
672 if (!strncmp(kv[0], "rts", 3)) {
675 else if (kv[1][0] == '0')
678 sr_dbg("invalid value for rts: %c", kv[1][0]);
681 } else if (!strncmp(kv[0], "dtr", 3)) {
684 else if (kv[1][0] == '0')
687 sr_dbg("invalid value for dtr: %c", kv[1][0]);
690 } else if (!strncmp(kv[0], "flow", 4)) {
693 else if (kv[1][0] == '1')
695 else if (kv[1][0] == '2')
698 sr_dbg("invalid value for flow: %c", kv[1][0]);
709 g_match_info_unref(match);
711 sr_spew("Got params: rate %d, frame %d/%d/%d, flow %d, rts %d, dtr %d.",
712 speed, databits, parity, stopbits, flow, rts, dtr);
715 sr_dbg("Could not infer speed from parameter string.");
719 return serial_set_params(serial, speed,
720 databits, parity, stopbits,
725 * Read a line from the specified serial port.
727 * @param[in] serial Previously initialized serial port structure.
728 * @param[out] buf Buffer where to store the bytes that are read.
729 * @param[in] buflen Size of the buffer.
730 * @param[in] timeout_ms How long to wait for a line to come in.
732 * Reading stops when CR or LF is found, which is stripped from the buffer.
734 * @retval SR_OK Success.
735 * @retval SR_ERR Failure.
739 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial,
740 char **buf, int *buflen, gint64 timeout_ms)
742 gint64 start, remaining;
746 sr_dbg("Invalid serial port.");
750 if (!dev_is_supported(serial)) {
751 sr_dbg("Cannot use unopened serial port %s.", serial->port);
755 start = g_get_monotonic_time();
756 remaining = timeout_ms;
761 len = maxlen - *buflen - 1;
764 len = serial_read_blocking(serial, *buf + *buflen, 1, remaining);
767 *(*buf + *buflen) = '\0';
768 if (*buflen > 0 && (*(*buf + *buflen - 1) == '\r'
769 || *(*buf + *buflen - 1) == '\n')) {
770 /* Strip CR/LF and terminate. */
771 *(*buf + --*buflen) = '\0';
775 /* Reduce timeout by time elapsed. */
776 remaining = timeout_ms - ((g_get_monotonic_time() - start) / 1000);
784 sr_dbg("Received %d: '%s'.", *buflen, *buf);
790 * Try to find a valid packet in a serial data stream.
792 * @param[in] serial Previously initialized serial port structure.
793 * @param[in] buf Buffer containing the bytes to write.
794 * @param[in] buflen Size of the buffer.
795 * @param[in] packet_size Size, in bytes, of a valid packet.
796 * @param[in] is_valid Callback that assesses whether the packet is valid or not.
797 * @param[in] is_valid_len Callback which checks a variable length packet.
798 * @param[out] return_size Detected packet size in case of successful match.
799 * @param[in] timeout_ms The timeout after which, if no packet is detected, to
802 * Data is received from the serial port and into the caller provided
803 * buffer, until the buffer is exhausted, or the timeout has expired,
804 * or a valid packet was found. Receive data is passed to the caller
805 * provided validity check routine, assuming either fixed size packets
806 * (#is_valid parameter, exact match to the #packet_size length) or
807 * packets of variable length (#is_valid_len parameter, minimum length
808 * #packet_size required for first invocation).
810 * @retval SR_OK Valid packet was found within the given timeout.
811 * @retval SR_ERR Failure.
815 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
816 uint8_t *buf, size_t *buflen,
817 size_t packet_size, packet_valid_callback is_valid,
818 packet_valid_len_callback is_valid_len, size_t *return_size,
821 uint64_t start_us, elapsed_ms, byte_delay_us;
822 size_t fill_idx, check_idx, max_fill_idx;
824 const uint8_t *check_ptr;
825 size_t check_len, pkt_len;
829 sr_dbg("Detecting packets on %s (timeout = %" PRIu64 "ms).",
830 serial->port, timeout_ms);
832 max_fill_idx = *buflen;
833 if (max_fill_idx < 2 * packet_size) {
835 * The heuristics in this check is only useful for fixed
836 * packet length scenarios, but for variable length setups
837 * we don't know the packets' sizes up front.
839 sr_err("Small stream detect RX buffer, want 2x packet size.");
843 byte_delay_us = serial_timeout(serial, 1) * 1000;
844 start_us = g_get_monotonic_time();
846 check_idx = fill_idx = 0;
847 while (fill_idx < max_fill_idx) {
849 * Read bytes individually. Lets callers continue to
850 * successfully process next RX data after first match.
851 * Run full loop bodies for empty or failed reception
852 * in an iteration, to have timeouts checked.
854 recv_len = serial_read_nonblocking(serial, &buf[fill_idx], 1);
856 fill_idx += recv_len;
858 /* Dump receive data when (a minimum) size is reached. */
859 check_ptr = &buf[check_idx];
860 check_len = fill_idx - check_idx;
861 do_dump = check_len >= packet_size;
862 do_dump &= sr_log_loglevel_get() >= SR_LOG_SPEW;
866 text = sr_hexdump_new(check_ptr, check_len);
867 sr_spew("Trying packet: len %zu, bytes %s",
868 check_len, text->str);
869 sr_hexdump_free(text);
872 /* A packet's (minimum) length was received, check its data. */
873 elapsed_ms = g_get_monotonic_time() - start_us;
875 if (is_valid_len && check_len >= packet_size) {
876 pkt_len = packet_size;
877 ret = is_valid_len(NULL, check_ptr, check_len, &pkt_len);
878 if (ret == SR_PACKET_VALID) {
879 /* Exact match. Terminate with success. */
880 sr_spew("Valid packet after %" PRIu64 "ms.",
882 sr_spew("RX count %zu, packet len %zu.",
886 *return_size = pkt_len;
889 if (ret == SR_PACKET_NEED_RX) {
890 /* Incomplete, keep accumulating RX data. */
891 sr_spew("Checker needs more RX data.");
893 /* Not a valid packet. Continue searching. */
894 sr_spew("Invalid packet, advancing read pos.");
898 if (is_valid && check_len >= packet_size) {
899 if (is_valid(check_ptr)) {
900 /* Exact match. Terminate with success. */
901 sr_spew("Valid packet after %" PRIu64 "ms.",
903 sr_spew("RX count %zu, packet len %zu.",
904 fill_idx, packet_size);
907 *return_size = packet_size;
910 /* Not a valid packet. Continue searching. */
911 sr_spew("Invalid packet, advancing read pointer.");
915 /* Check for packet search timeout. */
916 if (elapsed_ms >= timeout_ms) {
917 sr_dbg("Detection timed out after %" PRIu64 "ms.",
922 g_usleep(byte_delay_us);
924 sr_info("Didn't find a valid packet (read %zu bytes).", fill_idx);
933 * Extract the serial device and options from the options linked list.
935 * The caller's passed in references get updated when the list of options
936 * contains one of the desired parameters. This lets callers pre-assign
937 * default values which take effect in the absence of user specifications.
938 * Either reference is optional, passing #NULL is acceptable.
940 * Callers must not free returned strings. These shall be considered
941 * read-only handles to data that is managed elsewhere.
943 * @param[in] options List of options passed from the command line.
944 * @param[out] serial_device Pointer where to store the extracted serial device.
945 * @param[out] serial_options Pointer where to store the optional extracted serial
948 * @return SR_OK if a serial_device is found, SR_ERR if no device is found.
952 SR_PRIV int sr_serial_extract_options(GSList *options,
953 const char **serial_device, const char **serial_options)
956 struct sr_config *src;
958 for (l = options; l; l = l->next) {
964 *serial_device = g_variant_get_string(src->data, NULL);
965 sr_dbg("Parsed serial device: %s.", *serial_device);
967 case SR_CONF_SERIALCOMM:
970 *serial_options = g_variant_get_string(src->data, NULL);
971 sr_dbg("Parsed serial options: %s.", *serial_options);
976 if (serial_device && !*serial_device) {
977 sr_dbg("No serial device specified.");
984 #ifdef HAVE_SERIAL_COMM
987 SR_PRIV int serial_source_add(struct sr_session *session,
988 struct sr_serial_dev_inst *serial, int events, int timeout,
989 sr_receive_data_callback cb, void *cb_data)
991 if ((events & (G_IO_IN | G_IO_ERR)) && (events & G_IO_OUT)) {
992 sr_err("Cannot poll input/error and output simultaneously.");
996 if (!dev_is_supported(serial)) {
997 sr_err("Invalid serial port.");
1001 if (!serial->lib_funcs || !serial->lib_funcs->setup_source_add)
1004 return serial->lib_funcs->setup_source_add(session, serial,
1005 events, timeout, cb, cb_data);
1009 SR_PRIV int serial_source_remove(struct sr_session *session,
1010 struct sr_serial_dev_inst *serial)
1012 if (!dev_is_supported(serial)) {
1013 sr_err("Invalid serial port.");
1017 if (!serial->lib_funcs || !serial->lib_funcs->setup_source_remove)
1020 return serial->lib_funcs->setup_source_remove(session, serial);
1024 * Create/allocate a new sr_serial_port structure.
1026 * @param name The OS dependent name of the serial port. Must not be NULL.
1027 * @param description An end user friendly description for the serial port.
1028 * Can be NULL (in that case the empty string is used
1031 * @return The newly allocated sr_serial_port struct.
1033 static struct sr_serial_port *sr_serial_new(const char *name,
1034 const char *description)
1036 struct sr_serial_port *serial;
1041 serial = g_malloc0(sizeof(*serial));
1042 serial->name = g_strdup(name);
1043 serial->description = g_strdup(description ? description : "");
1049 * Free a previously allocated sr_serial_port structure.
1051 * @param serial The sr_serial_port struct to free. Must not be NULL.
1053 SR_API void sr_serial_free(struct sr_serial_port *serial)
1057 g_free(serial->name);
1058 g_free(serial->description);
1062 static GSList *append_port_list(GSList *devs, const char *name, const char *desc)
1064 return g_slist_append(devs, sr_serial_new(name, desc));
1068 * List available serial devices.
1070 * @return A GSList of strings containing the path of the serial devices or
1071 * NULL if no serial device is found. The returned list must be freed
1074 SR_API GSList *sr_serial_list(const struct sr_dev_driver *driver)
1077 GSList *(*list_func)(GSList *list, sr_ser_list_append_t append);
1079 /* Currently unused, but will be used by some drivers later on. */
1083 if (ser_lib_funcs_libsp && ser_lib_funcs_libsp->list) {
1084 list_func = ser_lib_funcs_libsp->list;
1085 tty_devs = list_func(tty_devs, append_port_list);
1087 if (ser_lib_funcs_hid && ser_lib_funcs_hid->list) {
1088 list_func = ser_lib_funcs_hid->list;
1089 tty_devs = list_func(tty_devs, append_port_list);
1091 if (ser_lib_funcs_bt && ser_lib_funcs_bt->list) {
1092 list_func = ser_lib_funcs_bt->list;
1093 tty_devs = list_func(tty_devs, append_port_list);
1099 static GSList *append_port_find(GSList *devs, const char *name)
1101 if (!name || !*name)
1104 return g_slist_append(devs, g_strdup(name));
1108 * Find USB serial devices via the USB vendor ID and product ID.
1110 * @param[in] vendor_id Vendor ID of the USB device.
1111 * @param[in] product_id Product ID of the USB device.
1113 * @return A GSList of strings containing the path of the serial device or
1114 * NULL if no serial device is found. The returned list must be freed
1119 SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id)
1122 GSList *(*find_func)(GSList *list, sr_ser_find_append_t append,
1123 uint16_t vid, uint16_t pid);
1126 if (ser_lib_funcs_libsp && ser_lib_funcs_libsp->find_usb) {
1127 find_func = ser_lib_funcs_libsp->find_usb;
1128 tty_devs = find_func(tty_devs, append_port_find,
1129 vendor_id, product_id);
1131 if (ser_lib_funcs_hid && ser_lib_funcs_hid->find_usb) {
1132 find_func = ser_lib_funcs_hid->find_usb;
1133 tty_devs = find_func(tty_devs, append_port_find,
1134 vendor_id, product_id);
1141 SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes)
1143 int bits, baud, ret, timeout_ms;
1145 /* Get the bitrate and frame length. */
1147 if (port->lib_funcs && port->lib_funcs->get_frame_format) {
1148 ret = port->lib_funcs->get_frame_format(port, &baud, &bits);
1152 baud = port->comm_params.bit_rate;
1153 bits = 1 + port->comm_params.data_bits +
1154 port->comm_params.parity_bits +
1155 port->comm_params.stop_bits;
1158 /* Derive the timeout. Default to 1s. */
1161 /* Throw in 10ms for misc OS overhead. */
1163 timeout_ms += ((1000.0 / baud) * bits) * num_bytes;
1171 /* TODO Put fallback.c content here? */