src/serial.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   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  *
   9  * This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  */
  22
  23 #include <config.h>
  24 #include <string.h>
  25 #include <stdlib.h>
  26 #include <glib.h>
  27 #include <glib/gstdio.h>
  28 #include <libserialport.h>
  29 #include <libsigrok/libsigrok.h>
  30 #include "libsigrok-internal.h"
  31 #ifdef _WIN32
  32 #include <windows.h> /* for HANDLE */
  33 #endif
  34
  35 /** @cond PRIVATE */
  36 #define LOG_PREFIX "serial"
  37 /** @endcond */
  38
  39 /**
  40  * @file
  41  *
  42  * Serial port handling.
  43  */
  44
  45 /**
  46  * @defgroup grp_serial Serial port handling
  47  *
  48  * Serial port handling functions.
  49  *
  50  * @{
  51  */
  52
  53 /* See if a (assumed opened) serial port is of any supported type. */
  54 static int dev_is_supported(struct sr_serial_dev_inst *serial)
  55 {
  56         if (!serial)
  57                 return 0;
  58         if (!serial->lib_funcs)
  59                 return 0;
  60
  61         return 1;
  62 }
  63
  64 /**
  65  * Open the specified serial port.
  66  *
  67  * @param serial Previously initialized serial port structure.
  68  * @param[in] flags Flags to use when opening the serial port. Possible flags
  69  *                  include SERIAL_RDWR, SERIAL_RDONLY.
  70  *
  71  * If the serial structure contains a serialcomm string, it will be
  72  * passed to serial_set_paramstr() after the port is opened.
  73  *
  74  * @retval SR_OK Success.
  75  * @retval SR_ERR Failure.
  76  *
  77  * @private
  78  */
  79 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags)
  80 {
  81         int ret;
  82
  83         if (!serial) {
  84                 sr_dbg("Invalid serial port.");
  85                 return SR_ERR;
  86         }
  87
  88         sr_spew("Opening serial port '%s' (flags %d).", serial->port, flags);
  89
  90         /* Default to the libserialport transport layer. */
  91         serial->lib_funcs = ser_lib_funcs_libsp;
  92         if (!serial->lib_funcs)
  93                 return SR_ERR_NA;
  94
  95         /*
  96          * Run the transport's open routine. Setup the bitrate and the
  97          * UART frame format.
  98          */
  99         if (!serial->lib_funcs->open)
 100                 return SR_ERR_NA;
 101         ret = serial->lib_funcs->open(serial, flags);
 102         if (ret != SR_OK)
 103                 return ret;
 104
 105         if (serial->serialcomm)
 106                 return serial_set_paramstr(serial, serial->serialcomm);
 107         else
 108                 return SR_OK;
 109 }
 110
 111 /**
 112  * Close the specified serial port.
 113  *
 114  * @param serial Previously initialized serial port structure.
 115  *
 116  * @retval SR_OK Success.
 117  * @retval SR_ERR Failure.
 118  *
 119  * @private
 120  */
 121 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial)
 122 {
 123         if (!serial) {
 124                 sr_dbg("Invalid serial port.");
 125                 return SR_ERR;
 126         }
 127
 128         sr_spew("Closing serial port %s.", serial->port);
 129
 130         if (!serial->lib_funcs || !serial->lib_funcs->close)
 131                 return SR_ERR_NA;
 132
 133         return serial->lib_funcs->close(serial);
 134 }
 135
 136 /**
 137  * Flush serial port buffers. Empty buffers, discard pending RX and TX data.
 138  *
 139  * @param serial Previously initialized serial port structure.
 140  *
 141  * @retval SR_OK Success.
 142  * @retval SR_ERR Failure.
 143  *
 144  * @private
 145  */
 146 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial)
 147 {
 148         if (!serial) {
 149                 sr_dbg("Invalid serial port.");
 150                 return SR_ERR;
 151         }
 152
 153         sr_spew("Flushing serial port %s.", serial->port);
 154
 155         if (!serial->lib_funcs || !serial->lib_funcs->flush)
 156                 return SR_ERR_NA;
 157
 158         return serial->lib_funcs->flush(serial);
 159 }
 160
 161 /**
 162  * Drain serial port buffers. Wait for pending TX data to be sent.
 163  *
 164  * @param serial Previously initialized serial port structure.
 165  *
 166  * @retval SR_OK Success.
 167  * @retval SR_ERR Failure.
 168  *
 169  * @private
 170  */
 171 SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial)
 172 {
 173         if (!serial) {
 174                 sr_dbg("Invalid serial port.");
 175                 return SR_ERR;
 176         }
 177
 178         sr_spew("Draining serial port %s.", serial->port);
 179
 180         if (!serial->lib_funcs || !serial->lib_funcs->drain)
 181                 return SR_ERR_NA;
 182
 183         return serial->lib_funcs->drain(serial);
 184 }
 185
 186 /**
 187  * Check for available receive data.
 188  *
 189  * @param[in] serial Previously opened serial port instance.
 190  *
 191  * @returns The number of (known) available RX data bytes.
 192  *
 193  * Returns 0 if no receive data is available, or if the amount of
 194  * available receive data cannot get determined.
 195  */
 196 SR_PRIV size_t serial_has_receive_data(struct sr_serial_dev_inst *serial)
 197 {
 198         size_t lib_count;
 199
 200         if (!serial)
 201                 return 0;
 202
 203         lib_count = 0;
 204         if (serial->lib_funcs && serial->lib_funcs->get_rx_avail)
 205                 lib_count = serial->lib_funcs->get_rx_avail(serial);
 206
 207         return lib_count;
 208 }
 209
 210 static int _serial_write(struct sr_serial_dev_inst *serial,
 211         const void *buf, size_t count,
 212         int nonblocking, unsigned int timeout_ms)
 213 {
 214         ssize_t ret;
 215
 216         if (!serial) {
 217                 sr_dbg("Invalid serial port.");
 218                 return SR_ERR;
 219         }
 220
 221         if (!serial->lib_funcs || !serial->lib_funcs->write)
 222                 return SR_ERR_NA;
 223         ret = serial->lib_funcs->write(serial, buf, count,
 224                 nonblocking, timeout_ms);
 225         sr_spew("Wrote %zd/%zu bytes.", ret, count);
 226
 227         return ret;
 228 }
 229
 230 /**
 231  * Write a number of bytes to the specified serial port, blocking until finished.
 232  *
 233  * @param serial Previously initialized serial port structure.
 234  * @param[in] buf Buffer containing the bytes to write.
 235  * @param[in] count Number of bytes to write.
 236  * @param[in] timeout_ms Timeout in ms, or 0 for no timeout.
 237  *
 238  * @retval SR_ERR_ARG Invalid argument.
 239  * @retval SR_ERR Other error.
 240  * @retval other The number of bytes written. If this is less than the number
 241  * specified in the call, the timeout was reached.
 242  *
 243  * @private
 244  */
 245 SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
 246         const void *buf, size_t count, unsigned int timeout_ms)
 247 {
 248         return _serial_write(serial, buf, count, 0, timeout_ms);
 249 }
 250
 251 /**
 252  * Write a number of bytes to the specified serial port, return immediately.
 253  *
 254  * @param serial Previously initialized serial port structure.
 255  * @param[in] buf Buffer containing the bytes to write.
 256  * @param[in] count Number of bytes to write.
 257  *
 258  * @retval SR_ERR_ARG Invalid argument.
 259  * @retval SR_ERR Other error.
 260  * @retval other The number of bytes written.
 261  *
 262  * @private
 263  */
 264 SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial,
 265         const void *buf, size_t count)
 266 {
 267         return _serial_write(serial, buf, count, 1, 0);
 268 }
 269
 270 static int _serial_read(struct sr_serial_dev_inst *serial,
 271         void *buf, size_t count, int nonblocking, unsigned int timeout_ms)
 272 {
 273         ssize_t ret;
 274
 275         if (!serial) {
 276                 sr_dbg("Invalid serial port.");
 277                 return SR_ERR;
 278         }
 279
 280         if (!serial->lib_funcs || !serial->lib_funcs->read)
 281                 return SR_ERR_NA;
 282         ret = serial->lib_funcs->read(serial, buf, count,
 283                 nonblocking, timeout_ms);
 284         if (ret > 0)
 285                 sr_spew("Read %zd/%zu bytes.", ret, count);
 286
 287         return ret;
 288 }
 289
 290 /**
 291  * Read a number of bytes from the specified serial port, block until finished.
 292  *
 293  * @param serial Previously initialized serial port structure.
 294  * @param buf Buffer where to store the bytes that are read.
 295  * @param[in] count The number of bytes to read.
 296  * @param[in] timeout_ms Timeout in ms, or 0 for no timeout.
 297  *
 298  * @retval SR_ERR_ARG Invalid argument.
 299  * @retval SR_ERR Other error.
 300  * @retval other The number of bytes read. If this is less than the number
 301  * requested, the timeout was reached.
 302  *
 303  * @private
 304  */
 305 SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial,
 306         void *buf, size_t count, unsigned int timeout_ms)
 307 {
 308         return _serial_read(serial, buf, count, 0, timeout_ms);
 309 }
 310
 311 /**
 312  * Try to read up to @a count bytes from the specified serial port, return
 313  * immediately with what's available.
 314  *
 315  * @param serial Previously initialized serial port structure.
 316  * @param buf Buffer where to store the bytes that are read.
 317  * @param[in] count The number of bytes to read.
 318  *
 319  * @retval SR_ERR_ARG Invalid argument.
 320  * @retval SR_ERR Other error.
 321  * @retval other The number of bytes read.
 322  *
 323  * @private
 324  */
 325 SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial,
 326         void *buf, size_t count)
 327 {
 328         return _serial_read(serial, buf, count, 1, 0);
 329 }
 330
 331 /**
 332  * Set serial parameters for the specified serial port.
 333  *
 334  * @param serial Previously initialized serial port structure.
 335  * @param[in] baudrate The baudrate to set.
 336  * @param[in] bits The number of data bits to use (5, 6, 7 or 8).
 337  * @param[in] parity The parity setting to use (0 = none, 1 = even, 2 = odd).
 338  * @param[in] stopbits The number of stop bits to use (1 or 2).
 339  * @param[in] flowcontrol The flow control settings to use (0 = none,
 340  *                        1 = RTS/CTS, 2 = XON/XOFF).
 341  * @param[in] rts Status of RTS line (0 or 1; required by some interfaces).
 342  * @param[in] dtr Status of DTR line (0 or 1; required by some interfaces).
 343  *
 344  * @retval SR_OK Success.
 345  * @retval SR_ERR Failure.
 346  *
 347  * @private
 348  */
 349 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial,
 350         int baudrate, int bits, int parity, int stopbits,
 351         int flowcontrol, int rts, int dtr)
 352 {
 353         int ret;
 354
 355         if (!serial) {
 356                 sr_dbg("Invalid serial port.");
 357                 return SR_ERR;
 358         }
 359
 360         sr_spew("Setting serial parameters on port %s.", serial->port);
 361
 362         if (!serial->lib_funcs || !serial->lib_funcs->set_params)
 363                 return SR_ERR_NA;
 364         ret = serial->lib_funcs->set_params(serial,
 365                 baudrate, bits, parity, stopbits,
 366                 flowcontrol, rts, dtr);
 367         if (ret == SR_OK) {
 368                 serial->comm_params.bit_rate = baudrate;
 369                 serial->comm_params.data_bits = bits;
 370                 serial->comm_params.parity_bits = parity ? 1 : 0;
 371                 serial->comm_params.stop_bits = stopbits;
 372                 sr_dbg("DBG: %s() rate %d, %d%s%d", __func__,
 373                                 baudrate, bits,
 374                                 (parity == 0) ? "n" : "x",
 375                                 stopbits);
 376         }
 377
 378         return ret;
 379 }
 380
 381 /**
 382  * Set serial parameters for the specified serial port from parameter string.
 383  *
 384  * @param serial Previously initialized serial port structure.
 385  * @param[in] paramstr A serial communication parameters string of the form
 386  * "<baudrate>/<bits><parity><stopbits>{/<option>}".\n
 387  * Examples: "9600/8n1", "600/7o2/dtr=1/rts=0" or "460800/8n1/flow=2".\n
 388  * \<baudrate\>=integer Baud rate.\n
 389  * \<bits\>=5|6|7|8 Number of data bits.\n
 390  * \<parity\>=n|e|o None, even, odd.\n
 391  * \<stopbits\>=1|2 One or two stop bits.\n
 392  * Options:\n
 393  * dtr=0|1 Set DTR off resp. on.\n
 394  * flow=0|1|2 Flow control. 0 for none, 1 for RTS/CTS, 2 for XON/XOFF.\n
 395  * rts=0|1 Set RTS off resp. on.\n
 396  * Please note that values and combinations of these parameters must be
 397  * supported by the concrete serial interface hardware and the drivers for it.
 398  *
 399  * @retval SR_OK Success.
 400  * @retval SR_ERR Failure.
 401  *
 402  * @private
 403  */
 404 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
 405         const char *paramstr)
 406 {
 407 /** @cond PRIVATE */
 408 #define SERIAL_COMM_SPEC "^(\\d+)/([5678])([neo])([12])(.*)$"
 409 /** @endcond */
 410
 411         GRegex *reg;
 412         GMatchInfo *match;
 413         int speed, databits, parity, stopbits, flow, rts, dtr, i;
 414         char *mstr, **opts, **kv;
 415
 416         speed = databits = parity = stopbits = flow = 0;
 417         rts = dtr = -1;
 418         sr_spew("Parsing parameters from \"%s\".", paramstr);
 419         reg = g_regex_new(SERIAL_COMM_SPEC, 0, 0, NULL);
 420         if (g_regex_match(reg, paramstr, 0, &match)) {
 421                 if ((mstr = g_match_info_fetch(match, 1)))
 422                         speed = strtoul(mstr, NULL, 10);
 423                 g_free(mstr);
 424                 if ((mstr = g_match_info_fetch(match, 2)))
 425                         databits = strtoul(mstr, NULL, 10);
 426                 g_free(mstr);
 427                 if ((mstr = g_match_info_fetch(match, 3))) {
 428                         switch (mstr[0]) {
 429                         case 'n':
 430                                 parity = SP_PARITY_NONE;
 431                                 break;
 432                         case 'e':
 433                                 parity = SP_PARITY_EVEN;
 434                                 break;
 435                         case 'o':
 436                                 parity = SP_PARITY_ODD;
 437                                 break;
 438                         }
 439                 }
 440                 g_free(mstr);
 441                 if ((mstr = g_match_info_fetch(match, 4)))
 442                         stopbits = strtoul(mstr, NULL, 10);
 443                 g_free(mstr);
 444                 if ((mstr = g_match_info_fetch(match, 5)) && mstr[0] != '\0') {
 445                         if (mstr[0] != '/') {
 446                                 sr_dbg("missing separator before extra options");
 447                                 speed = 0;
 448                         } else {
 449                                 /* A set of "key=value" options separated by / */
 450                                 opts = g_strsplit(mstr + 1, "/", 0);
 451                                 for (i = 0; opts[i]; i++) {
 452                                         kv = g_strsplit(opts[i], "=", 2);
 453                                         if (!strncmp(kv[0], "rts", 3)) {
 454                                                 if (kv[1][0] == '1')
 455                                                         rts = 1;
 456                                                 else if (kv[1][0] == '0')
 457                                                         rts = 0;
 458                                                 else {
 459                                                         sr_dbg("invalid value for rts: %c", kv[1][0]);
 460                                                         speed = 0;
 461                                                 }
 462                                         } else if (!strncmp(kv[0], "dtr", 3)) {
 463                                                 if (kv[1][0] == '1')
 464                                                         dtr = 1;
 465                                                 else if (kv[1][0] == '0')
 466                                                         dtr = 0;
 467                                                 else {
 468                                                         sr_dbg("invalid value for dtr: %c", kv[1][0]);
 469                                                         speed = 0;
 470                                                 }
 471                                         } else if (!strncmp(kv[0], "flow", 4)) {
 472                                                 if (kv[1][0] == '0')
 473                                                         flow = 0;
 474                                                 else if (kv[1][0] == '1')
 475                                                         flow = 1;
 476                                                 else if (kv[1][0] == '2')
 477                                                         flow = 2;
 478                                                 else {
 479                                                         sr_dbg("invalid value for flow: %c", kv[1][0]);
 480                                                         speed = 0;
 481                                                 }
 482                                         }
 483                                         g_strfreev(kv);
 484                                 }
 485                                 g_strfreev(opts);
 486                         }
 487                 }
 488                 g_free(mstr);
 489         }
 490         g_match_info_unref(match);
 491         g_regex_unref(reg);
 492
 493         if (speed) {
 494                 return serial_set_params(serial, speed, databits, parity,
 495                                          stopbits, flow, rts, dtr);
 496         } else {
 497                 sr_dbg("Could not infer speed from parameter string.");
 498                 return SR_ERR_ARG;
 499         }
 500 }
 501
 502 /**
 503  * Read a line from the specified serial port.
 504  *
 505  * @param[in] serial Previously initialized serial port structure.
 506  * @param[out] buf Buffer where to store the bytes that are read.
 507  * @param[in] buflen Size of the buffer.
 508  * @param[in] timeout_ms How long to wait for a line to come in.
 509  *
 510  * Reading stops when CR or LF is found, which is stripped from the buffer.
 511  *
 512  * @retval SR_OK Success.
 513  * @retval SR_ERR Failure.
 514  *
 515  * @private
 516  */
 517 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial,
 518         char **buf, int *buflen, gint64 timeout_ms)
 519 {
 520         gint64 start, remaining;
 521         int maxlen, len;
 522
 523         if (!serial) {
 524                 sr_dbg("Invalid serial port.");
 525                 return SR_ERR;
 526         }
 527
 528         if (!dev_is_supported(serial)) {
 529                 sr_dbg("Cannot use unopened serial port %s.", serial->port);
 530                 return -1;
 531         }
 532
 533         start = g_get_monotonic_time();
 534         remaining = timeout_ms;
 535
 536         maxlen = *buflen;
 537         *buflen = len = 0;
 538         while (1) {
 539                 len = maxlen - *buflen - 1;
 540                 if (len < 1)
 541                         break;
 542                 len = serial_read_blocking(serial, *buf + *buflen, 1, remaining);
 543                 if (len > 0) {
 544                         *buflen += len;
 545                         *(*buf + *buflen) = '\0';
 546                         if (*buflen > 0 && (*(*buf + *buflen - 1) == '\r'
 547                                         || *(*buf + *buflen - 1) == '\n')) {
 548                                 /* Strip CR/LF and terminate. */
 549                                 *(*buf + --*buflen) = '\0';
 550                                 break;
 551                         }
 552                 }
 553                 /* Reduce timeout by time elapsed. */
 554                 remaining = timeout_ms - ((g_get_monotonic_time() - start) / 1000);
 555                 if (remaining <= 0)
 556                         /* Timeout */
 557                         break;
 558                 if (len < 1)
 559                         g_usleep(2000);
 560         }
 561         if (*buflen)
 562                 sr_dbg("Received %d: '%s'.", *buflen, *buf);
 563
 564         return SR_OK;
 565 }
 566
 567 /**
 568  * Try to find a valid packet in a serial data stream.
 569  *
 570  * @param serial Previously initialized serial port structure.
 571  * @param buf Buffer containing the bytes to write.
 572  * @param buflen Size of the buffer.
 573  * @param[in] packet_size Size, in bytes, of a valid packet.
 574  * @param is_valid Callback that assesses whether the packet is valid or not.
 575  * @param[in] timeout_ms The timeout after which, if no packet is detected, to
 576  *                       abort scanning.
 577  * @param[in] baudrate The baudrate of the serial port. This parameter is not
 578  *                     critical, but it helps fine tune the serial port polling
 579  *                     delay.
 580  *
 581  * @retval SR_OK Valid packet was found within the given timeout.
 582  * @retval SR_ERR Failure.
 583  *
 584  * @private
 585  */
 586 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
 587         uint8_t *buf, size_t *buflen,
 588         size_t packet_size,
 589         packet_valid_callback is_valid,
 590         uint64_t timeout_ms, int baudrate)
 591 {
 592         uint64_t start, time, byte_delay_us;
 593         size_t ibuf, i, maxlen;
 594         ssize_t len;
 595
 596         maxlen = *buflen;
 597
 598         sr_dbg("Detecting packets on %s (timeout = %" PRIu64
 599                "ms, baudrate = %d).", serial->port, timeout_ms, baudrate);
 600
 601         if (maxlen < (packet_size / 2) ) {
 602                 sr_err("Buffer size must be at least twice the packet size.");
 603                 return SR_ERR;
 604         }
 605
 606         /* Assume 8n1 transmission. That is 10 bits for every byte. */
 607         byte_delay_us = 10 * ((1000 * 1000) / baudrate);
 608         start = g_get_monotonic_time();
 609
 610         i = ibuf = len = 0;
 611         while (ibuf < maxlen) {
 612                 len = serial_read_nonblocking(serial, &buf[ibuf], 1);
 613                 if (len > 0) {
 614                         ibuf += len;
 615                 } else if (len == 0) {
 616                         /* No logging, already done in serial_read(). */
 617                 } else {
 618                         /* Error reading byte, but continuing anyway. */
 619                 }
 620
 621                 time = g_get_monotonic_time() - start;
 622                 time /= 1000;
 623
 624                 if ((ibuf - i) >= packet_size) {
 625                         GString *text;
 626                         /* We have at least a packet's worth of data. */
 627                         text = sr_hexdump_new(&buf[i], packet_size);
 628                         sr_spew("Trying packet: %s", text->str);
 629                         sr_hexdump_free(text);
 630                         if (is_valid(&buf[i])) {
 631                                 sr_spew("Found valid %zu-byte packet after "
 632                                         "%" PRIu64 "ms.", (ibuf - i), time);
 633                                 *buflen = ibuf;
 634                                 return SR_OK;
 635                         } else {
 636                                 sr_spew("Got %zu bytes, but not a valid "
 637                                         "packet.", (ibuf - i));
 638                         }
 639                         /* Not a valid packet. Continue searching. */
 640                         i++;
 641                 }
 642                 if (time >= timeout_ms) {
 643                         /* Timeout */
 644                         sr_dbg("Detection timed out after %" PRIu64 "ms.", time);
 645                         break;
 646                 }
 647                 if (len < 1)
 648                         g_usleep(byte_delay_us);
 649         }
 650
 651         *buflen = ibuf;
 652
 653         sr_err("Didn't find a valid packet (read %zu bytes).", *buflen);
 654
 655         return SR_ERR;
 656 }
 657
 658 /**
 659  * Extract the serial device and options from the options linked list.
 660  *
 661  * @param options List of options passed from the command line.
 662  * @param serial_device Pointer where to store the extracted serial device.
 663  * @param serial_options Pointer where to store the optional extracted serial
 664  * options.
 665  *
 666  * @return SR_OK if a serial_device is found, SR_ERR if no device is found. The
 667  * returned string should not be freed by the caller.
 668  *
 669  * @private
 670  */
 671 SR_PRIV int sr_serial_extract_options(GSList *options,
 672         const char **serial_device, const char **serial_options)
 673 {
 674         GSList *l;
 675         struct sr_config *src;
 676
 677         *serial_device = NULL;
 678
 679         for (l = options; l; l = l->next) {
 680                 src = l->data;
 681                 switch (src->key) {
 682                 case SR_CONF_CONN:
 683                         *serial_device = g_variant_get_string(src->data, NULL);
 684                         sr_dbg("Parsed serial device: %s.", *serial_device);
 685                         break;
 686                 case SR_CONF_SERIALCOMM:
 687                         *serial_options = g_variant_get_string(src->data, NULL);
 688                         sr_dbg("Parsed serial options: %s.", *serial_options);
 689                         break;
 690                 }
 691         }
 692
 693         if (!*serial_device) {
 694                 sr_dbg("No serial device specified.");
 695                 return SR_ERR;
 696         }
 697
 698         return SR_OK;
 699 }
 700
 701 /** @private */
 702 SR_PRIV int serial_source_add(struct sr_session *session,
 703         struct sr_serial_dev_inst *serial, int events, int timeout,
 704         sr_receive_data_callback cb, void *cb_data)
 705 {
 706         if ((events & (G_IO_IN | G_IO_ERR)) && (events & G_IO_OUT)) {
 707                 sr_err("Cannot poll input/error and output simultaneously.");
 708                 return SR_ERR_ARG;
 709         }
 710
 711         if (!dev_is_supported(serial)) {
 712                 sr_err("Invalid serial port.");
 713                 return SR_ERR_ARG;
 714         }
 715
 716         if (!serial->lib_funcs || !serial->lib_funcs->setup_source_add)
 717                 return SR_ERR_NA;
 718
 719         return serial->lib_funcs->setup_source_add(session, serial,
 720                 events, timeout, cb, cb_data);
 721 }
 722
 723 /** @private */
 724 SR_PRIV int serial_source_remove(struct sr_session *session,
 725         struct sr_serial_dev_inst *serial)
 726 {
 727         if (!dev_is_supported(serial)) {
 728                 sr_err("Invalid serial port.");
 729                 return SR_ERR_ARG;
 730         }
 731
 732         if (!serial->lib_funcs || !serial->lib_funcs->setup_source_remove)
 733                 return SR_ERR_NA;
 734
 735         return serial->lib_funcs->setup_source_remove(session, serial);
 736 }
 737
 738 /**
 739  * Create/allocate a new sr_serial_port structure.
 740  *
 741  * @param name The OS dependent name of the serial port. Must not be NULL.
 742  * @param description An end user friendly description for the serial port.
 743  *                    Can be NULL (in that case the empty string is used
 744  *                    as description).
 745  *
 746  * @return The newly allocated sr_serial_port struct.
 747  */
 748 static struct sr_serial_port *sr_serial_new(const char *name,
 749         const char *description)
 750 {
 751         struct sr_serial_port *serial;
 752
 753         if (!name)
 754                 return NULL;
 755
 756         serial = g_malloc0(sizeof(*serial));
 757         serial->name = g_strdup(name);
 758         serial->description = g_strdup(description ? description : "");
 759
 760         return serial;
 761 }
 762
 763 /**
 764  * Free a previously allocated sr_serial_port structure.
 765  *
 766  * @param serial The sr_serial_port struct to free. Must not be NULL.
 767  */
 768 SR_API void sr_serial_free(struct sr_serial_port *serial)
 769 {
 770         if (!serial)
 771                 return;
 772         g_free(serial->name);
 773         g_free(serial->description);
 774         g_free(serial);
 775 }
 776
 777 static GSList *append_port_list(GSList *devs, const char *name, const char *desc)
 778 {
 779         return g_slist_append(devs, sr_serial_new(name, desc));
 780 }
 781
 782 /**
 783  * List available serial devices.
 784  *
 785  * @return A GSList of strings containing the path of the serial devices or
 786  *         NULL if no serial device is found. The returned list must be freed
 787  *         by the caller.
 788  */
 789 SR_API GSList *sr_serial_list(const struct sr_dev_driver *driver)
 790 {
 791         GSList *tty_devs;
 792         GSList *(*list_func)(GSList *list, sr_ser_list_append_t append);
 793
 794         /* Currently unused, but will be used by some drivers later on. */
 795         (void)driver;
 796
 797         tty_devs = NULL;
 798         if (ser_lib_funcs_libsp && ser_lib_funcs_libsp->list) {
 799                 list_func = ser_lib_funcs_libsp->list;
 800                 tty_devs = list_func(tty_devs, append_port_list);
 801         }
 802
 803         return tty_devs;
 804 }
 805
 806 static GSList *append_port_find(GSList *devs, const char *name)
 807 {
 808         if (!name || !*name)
 809                 return devs;
 810
 811         return g_slist_append(devs, g_strdup(name));
 812 }
 813
 814 /**
 815  * Find USB serial devices via the USB vendor ID and product ID.
 816  *
 817  * @param[in] vendor_id Vendor ID of the USB device.
 818  * @param[in] product_id Product ID of the USB device.
 819  *
 820  * @return A GSList of strings containing the path of the serial device or
 821  *         NULL if no serial device is found. The returned list must be freed
 822  *         by the caller.
 823  *
 824  * @private
 825  */
 826 SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id)
 827 {
 828         GSList *tty_devs;
 829         GSList *(*find_func)(GSList *list, sr_ser_find_append_t append,
 830                         uint16_t vid, uint16_t pid);
 831
 832         tty_devs = NULL;
 833         if (ser_lib_funcs_libsp && ser_lib_funcs_libsp->find_usb) {
 834                 find_func = ser_lib_funcs_libsp->find_usb;
 835                 tty_devs = find_func(tty_devs, append_port_find,
 836                         vendor_id, product_id);
 837         }
 838
 839         return tty_devs;
 840 }
 841
 842 /** @private */
 843 SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes)
 844 {
 845         int bits, baud;
 846         int ret;
 847         int timeout_ms;
 848
 849         /* Get the bitrate and frame length. */
 850         bits = baud = 0;
 851         if (port->lib_funcs && port->lib_funcs->get_frame_format) {
 852                 ret = port->lib_funcs->get_frame_format(port, &baud, &bits);
 853                 if (ret != SR_OK)
 854                         bits = baud = 0;
 855         } else {
 856                 baud = port->comm_params.bit_rate;
 857                 bits = 1 + port->comm_params.data_bits +
 858                         port->comm_params.parity_bits +
 859                         port->comm_params.stop_bits;
 860         }
 861
 862         /* Derive the timeout. Default to 1s. */
 863         timeout_ms = 1000;
 864         if (bits && baud) {
 865                 /* Throw in 10ms for misc OS overhead. */
 866                 timeout_ms = 10;
 867                 timeout_ms += ((1000.0 / baud) * bits) * num_bytes;
 868         }
 869
 870         return timeout_ms;
 871 }
 872
 873 /** @} */