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