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  * Copyright (C) 2017-2019 Gerhard Sittig <gerhard.sittig@gmx.net>
   9  *
  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.
  14  *
  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.
  19  *
  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/>.
  22  */
  23
  24 #include <config.h>
  25 #include <string.h>
  26 #include <stdlib.h>
  27 #include <glib.h>
  28 #include <glib/gstdio.h>
  29 #ifdef HAVE_LIBSERIALPORT
  30 #include <libserialport.h>
  31 #endif
  32 #include <libsigrok/libsigrok.h>
  33 #include "libsigrok-internal.h"
  34 #ifdef _WIN32
  35 #include <windows.h> /* for HANDLE */
  36 #endif
  37
  38 /** @cond PRIVATE */
  39 #define LOG_PREFIX "serial"
  40 /** @endcond */
  41
  42 /**
  43  * @file
  44  *
  45  * Serial port handling.
  46  */
  47
  48 /**
  49  * @defgroup grp_serial Serial port handling
  50  *
  51  * Serial port handling functions.
  52  *
  53  * @{
  54  */
  55
  56 #ifdef HAVE_SERIAL_COMM
  57
  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)
  60 {
  61         if (!serial || !serial->lib_funcs)
  62                 return 0;
  63
  64         return 1;
  65 }
  66
  67 /**
  68  * Open the specified serial port.
  69  *
  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.
  73  *
  74  * If the serial structure contains a serialcomm string, it will be
  75  * passed to serial_set_paramstr() after the port is opened.
  76  *
  77  * @retval SR_OK Success.
  78  * @retval SR_ERR Failure.
  79  *
  80  * @private
  81  */
  82 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags)
  83 {
  84         int ret;
  85
  86         if (!serial) {
  87                 sr_dbg("Invalid serial port.");
  88                 return SR_ERR;
  89         }
  90
  91         sr_spew("Opening serial port '%s' (flags %d).", serial->port, flags);
  92
  93         /*
  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.
  97          */
  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
 103                 serial->lib_funcs = ser_lib_funcs_libsp;
 104         if (!serial->lib_funcs)
 105                 return SR_ERR_NA;
 106
 107         /*
 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()
 112          * routines.
 113          */
 114
 115         /*
 116          * Run the transport's open routine. Setup the bitrate and the
 117          * UART frame format.
 118          */
 119         if (!serial->lib_funcs->open)
 120                 return SR_ERR_NA;
 121         ret = serial->lib_funcs->open(serial, flags);
 122         if (ret != SR_OK)
 123                 return ret;
 124
 125         if (serial->serialcomm) {
 126                 ret = serial_set_paramstr(serial, serial->serialcomm);
 127                 if (ret != SR_OK)
 128                         return ret;
 129         }
 130
 131         /*
 132          * Flush potentially dangling RX data. Availability of the
 133          * flush primitive depends on the transport/cable, absense
 134          * is non-fatal.
 135          */
 136         ret = serial_flush(serial);
 137         if (ret == SR_ERR_NA)
 138                 ret = SR_OK;
 139         if (ret != SR_OK)
 140                 return ret;
 141
 142         return SR_OK;
 143 }
 144
 145 /**
 146  * Close the specified serial port.
 147  *
 148  * @param serial Previously initialized serial port structure.
 149  *
 150  * @retval SR_OK Success.
 151  * @retval SR_ERR Failure.
 152  *
 153  * @private
 154  */
 155 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial)
 156 {
 157         int rc;
 158
 159         if (!serial) {
 160                 sr_dbg("Invalid serial port.");
 161                 return SR_ERR;
 162         }
 163
 164         sr_spew("Closing serial port %s.", serial->port);
 165
 166         if (!serial->lib_funcs || !serial->lib_funcs->close)
 167                 return SR_ERR_NA;
 168
 169         rc = serial->lib_funcs->close(serial);
 170         if (rc == SR_OK && serial->rcv_buffer) {
 171                 g_string_free(serial->rcv_buffer, TRUE);
 172                 serial->rcv_buffer = NULL;
 173         }
 174
 175         return rc;
 176 }
 177
 178 /**
 179  * Flush serial port buffers. Empty buffers, discard pending RX and TX data.
 180  *
 181  * @param serial Previously initialized serial port structure.
 182  *
 183  * @retval SR_OK Success.
 184  * @retval SR_ERR Failure.
 185  *
 186  * @private
 187  */
 188 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial)
 189 {
 190         if (!serial) {
 191                 sr_dbg("Invalid serial port.");
 192                 return SR_ERR;
 193         }
 194
 195         sr_spew("Flushing serial port %s.", serial->port);
 196
 197         sr_ser_discard_queued_data(serial);
 198
 199         if (!serial->lib_funcs || !serial->lib_funcs->flush)
 200                 return SR_ERR_NA;
 201
 202         return serial->lib_funcs->flush(serial);
 203 }
 204
 205 /**
 206  * Drain serial port buffers. Wait for pending TX data to be sent.
 207  *
 208  * @param serial Previously initialized serial port structure.
 209  *
 210  * @retval SR_OK Success.
 211  * @retval SR_ERR Failure.
 212  *
 213  * @private
 214  */
 215 SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial)
 216 {
 217         if (!serial) {
 218                 sr_dbg("Invalid serial port.");
 219                 return SR_ERR;
 220         }
 221
 222         sr_spew("Draining serial port %s.", serial->port);
 223
 224         if (!serial->lib_funcs || !serial->lib_funcs->drain)
 225                 return SR_ERR_NA;
 226
 227         return serial->lib_funcs->drain(serial);
 228 }
 229
 230 /*
 231  * Provide an internal RX data buffer for the serial port. This is not
 232  * supposed to be used directly by applications. Instead optional and
 233  * alternative transports for serial communication can use this buffer
 234  * if their progress is driven from background activity, and is not
 235  * (directly) driven by external API calls.
 236  *
 237  * BEWARE! This implementation assumes that data which gets communicated
 238  * via UART can get stored in a GString (which is a char array). Since
 239  * the API hides this detail, we can address this issue later when needed.
 240  * Callers use the API which communicates bytes.
 241  *
 242  * Applications optionally can register a "per RX chunk" callback, when
 243  * they depend on the frame boundaries of the respective physical layer.
 244  * Most callers just want the stream of RX data, and can use the buffer.
 245  *
 246  * The availability of RX chunks to callbacks, as well as the capability
 247  * to pass on exact frames as chunks or potential re-assembly of chunks
 248  * to a single data block, depend on each transport's implementation.
 249  */
 250
 251 /**
 252  * Register application callback for RX data chunks.
 253  *
 254  * @param[in] serial Previously initialized serial port instance.
 255  * @param[in] cb Routine to call as RX data becomes available.
 256  * @param[in] cb_data User data to pass to the callback in addition to RX data.
 257  *
 258  * @retval SR_ERR_ARG Invalid parameters.
 259  * @retval SR_OK Successful registration.
 260  *
 261  * Callbacks get unregistered by specifying NULL for the 'cb' parameter.
 262  *
 263  * @private
 264  */
 265 SR_PRIV int serial_set_read_chunk_cb(struct sr_serial_dev_inst *serial,
 266         serial_rx_chunk_callback cb, void *cb_data)
 267 {
 268         if (!serial)
 269                 return SR_ERR_ARG;
 270
 271         serial->rx_chunk_cb_func = cb;
 272         serial->rx_chunk_cb_data = cb_data;
 273
 274         return SR_OK;
 275 }
 276
 277 /**
 278  * Discard previously queued RX data. Internal to the serial subsystem,
 279  * coordination between common and transport specific support code.
 280  *
 281  * @param[in] serial Previously opened serial port instance.
 282  *
 283  * @private
 284  */
 285 SR_PRIV void sr_ser_discard_queued_data(struct sr_serial_dev_inst *serial)
 286 {
 287         if (!serial || !serial->rcv_buffer)
 288                 return;
 289
 290         g_string_truncate(serial->rcv_buffer, 0);
 291 }
 292
 293 /**
 294  * Get amount of queued RX data. Internal to the serial subsystem,
 295  * coordination between common and transport specific support code.
 296  *
 297  * @param[in] serial Previously opened serial port instance.
 298  *
 299  * @private
 300  */
 301 SR_PRIV size_t sr_ser_has_queued_data(struct sr_serial_dev_inst *serial)
 302 {
 303         if (!serial || !serial->rcv_buffer)
 304                 return 0;
 305
 306         return serial->rcv_buffer->len;
 307 }
 308
 309 /**
 310  * Queue received data. Internal to the serial subsystem, coordination
 311  * between common and transport specific support code.
 312  *
 313  * @param[in] serial Previously opened serial port instance.
 314  * @param[in] data Pointer to data bytes to queue.
 315  * @param[in] len Number of data bytes to queue.
 316  *
 317  * @private
 318  */
 319 SR_PRIV void sr_ser_queue_rx_data(struct sr_serial_dev_inst *serial,
 320         const uint8_t *data, size_t len)
 321 {
 322         if (!serial || !data || !len)
 323                 return;
 324
 325         if (serial->rx_chunk_cb_func)
 326                 serial->rx_chunk_cb_func(serial, serial->rx_chunk_cb_data, data, len);
 327         else if (serial->rcv_buffer)
 328                 g_string_append_len(serial->rcv_buffer, (const gchar *)data, len);
 329 }
 330
 331 /**
 332  * Retrieve previously queued RX data. Internal to the serial subsystem,
 333  * coordination between common and transport specific support code.
 334  *
 335  * @param[in] serial Previously opened serial port instance.
 336  * @param[out] data Pointer to store retrieved data bytes into.
 337  * @param[in] len Number of data bytes to retrieve.
 338  *
 339  * @private
 340  */
 341 SR_PRIV size_t sr_ser_unqueue_rx_data(struct sr_serial_dev_inst *serial,
 342         uint8_t *data, size_t len)
 343 {
 344         size_t qlen;
 345         GString *buf;
 346
 347         if (!serial || !data || !len)
 348                 return 0;
 349
 350         qlen = sr_ser_has_queued_data(serial);
 351         if (!qlen)
 352                 return 0;
 353
 354         buf = serial->rcv_buffer;
 355         if (len > buf->len)
 356                 len = buf->len;
 357         if (len) {
 358                 memcpy(data, buf->str, len);
 359                 g_string_erase(buf, 0, len);
 360         }
 361
 362         return len;
 363 }
 364
 365 /**
 366  * Check for available receive data.
 367  *
 368  * @param[in] serial Previously opened serial port instance.
 369  *
 370  * @returns The number of (known) available RX data bytes.
 371  *
 372  * Returns 0 if no receive data is available, or if the amount of
 373  * available receive data cannot get determined.
 374  *
 375  * @private
 376  */
 377 SR_PRIV size_t serial_has_receive_data(struct sr_serial_dev_inst *serial)
 378 {
 379         size_t lib_count, buf_count;
 380
 381         if (!serial)
 382                 return 0;
 383
 384         lib_count = 0;
 385         if (serial->lib_funcs && serial->lib_funcs->get_rx_avail)
 386                 lib_count = serial->lib_funcs->get_rx_avail(serial);
 387
 388         buf_count = sr_ser_has_queued_data(serial);
 389
 390         return lib_count + buf_count;
 391 }
 392
 393 static int _serial_write(struct sr_serial_dev_inst *serial,
 394         const void *buf, size_t count,
 395         int nonblocking, unsigned int timeout_ms)
 396 {
 397         ssize_t ret;
 398
 399         if (!serial) {
 400                 sr_dbg("Invalid serial port.");
 401                 return SR_ERR;
 402         }
 403
 404         if (!serial->lib_funcs || !serial->lib_funcs->write)
 405                 return SR_ERR_NA;
 406         ret = serial->lib_funcs->write(serial, buf, count,
 407                 nonblocking, timeout_ms);
 408         sr_spew("Wrote %zd/%zu bytes.", ret, count);
 409
 410         return ret;
 411 }
 412
 413 /**
 414  * Write a number of bytes to the specified serial port, blocking until finished.
 415  *
 416  * @param serial Previously initialized serial port structure.
 417  * @param[in] buf Buffer containing the bytes to write.
 418  * @param[in] count Number of bytes to write.
 419  * @param[in] timeout_ms Timeout in ms, or 0 for no timeout.
 420  *
 421  * @retval SR_ERR_ARG Invalid argument.
 422  * @retval SR_ERR Other error.
 423  * @retval other The number of bytes written. If this is less than the number
 424  * specified in the call, the timeout was reached.
 425  *
 426  * @private
 427  */
 428 SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
 429         const void *buf, size_t count, unsigned int timeout_ms)
 430 {
 431         return _serial_write(serial, buf, count, 0, timeout_ms);
 432 }
 433
 434 /**
 435  * Write a number of bytes to the specified serial port, return immediately.
 436  *
 437  * @param serial Previously initialized serial port structure.
 438  * @param[in] buf Buffer containing the bytes to write.
 439  * @param[in] count Number of bytes to write.
 440  *
 441  * @retval SR_ERR_ARG Invalid argument.
 442  * @retval SR_ERR Other error.
 443  * @retval other The number of bytes written.
 444  *
 445  * @private
 446  */
 447 SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial,
 448         const void *buf, size_t count)
 449 {
 450         return _serial_write(serial, buf, count, 1, 0);
 451 }
 452
 453 static int _serial_read(struct sr_serial_dev_inst *serial,
 454         void *buf, size_t count, int nonblocking, unsigned int timeout_ms)
 455 {
 456         ssize_t ret;
 457
 458         if (!serial) {
 459                 sr_dbg("Invalid serial port.");
 460                 return SR_ERR;
 461         }
 462
 463         if (!serial->lib_funcs || !serial->lib_funcs->read)
 464                 return SR_ERR_NA;
 465         ret = serial->lib_funcs->read(serial, buf, count,
 466                 nonblocking, timeout_ms);
 467         if (ret > 0)
 468                 sr_spew("Read %zd/%zu bytes.", ret, count);
 469
 470         return ret;
 471 }
 472
 473 /**
 474  * Read a number of bytes from the specified serial port, block until finished.
 475  *
 476  * @param serial Previously initialized serial port structure.
 477  * @param buf Buffer where to store the bytes that are read.
 478  * @param[in] count The number of bytes to read.
 479  * @param[in] timeout_ms Timeout in ms, or 0 for no timeout.
 480  *
 481  * @retval SR_ERR_ARG Invalid argument.
 482  * @retval SR_ERR Other error.
 483  * @retval other The number of bytes read. If this is less than the number
 484  * requested, the timeout was reached.
 485  *
 486  * @private
 487  */
 488 SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial,
 489         void *buf, size_t count, unsigned int timeout_ms)
 490 {
 491         return _serial_read(serial, buf, count, 0, timeout_ms);
 492 }
 493
 494 /**
 495  * Try to read up to @a count bytes from the specified serial port, return
 496  * immediately with what's available.
 497  *
 498  * @param serial Previously initialized serial port structure.
 499  * @param buf Buffer where to store the bytes that are read.
 500  * @param[in] count The number of bytes to read.
 501  *
 502  * @retval SR_ERR_ARG Invalid argument.
 503  * @retval SR_ERR Other error.
 504  * @retval other The number of bytes read.
 505  *
 506  * @private
 507  */
 508 SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial,
 509         void *buf, size_t count)
 510 {
 511         return _serial_read(serial, buf, count, 1, 0);
 512 }
 513
 514 /**
 515  * Set serial parameters for the specified serial port.
 516  *
 517  * @param serial Previously initialized serial port structure.
 518  * @param[in] baudrate The baudrate to set.
 519  * @param[in] bits The number of data bits to use (5, 6, 7 or 8).
 520  * @param[in] parity The parity setting to use (0 = none, 1 = even, 2 = odd).
 521  * @param[in] stopbits The number of stop bits to use (1 or 2).
 522  * @param[in] flowcontrol The flow control settings to use (0 = none,
 523  *                        1 = RTS/CTS, 2 = XON/XOFF).
 524  * @param[in] rts Status of RTS line (0 or 1; required by some interfaces).
 525  * @param[in] dtr Status of DTR line (0 or 1; required by some interfaces).
 526  *
 527  * @retval SR_OK Success.
 528  * @retval SR_ERR Failure.
 529  *
 530  * @private
 531  */
 532 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial,
 533         int baudrate, int bits, int parity, int stopbits,
 534         int flowcontrol, int rts, int dtr)
 535 {
 536         int ret;
 537
 538         if (!serial) {
 539                 sr_dbg("Invalid serial port.");
 540                 return SR_ERR;
 541         }
 542
 543         sr_spew("Setting serial parameters on port %s.", serial->port);
 544
 545         if (!serial->lib_funcs || !serial->lib_funcs->set_params)
 546                 return SR_ERR_NA;
 547         ret = serial->lib_funcs->set_params(serial,
 548                 baudrate, bits, parity, stopbits,
 549                 flowcontrol, rts, dtr);
 550         if (ret == SR_OK) {
 551                 serial->comm_params.bit_rate = baudrate;
 552                 serial->comm_params.data_bits = bits;
 553                 serial->comm_params.parity_bits = parity ? 1 : 0;
 554                 serial->comm_params.stop_bits = stopbits;
 555                 sr_dbg("DBG: %s() rate %d, %d%s%d", __func__,
 556                                 baudrate, bits,
 557                                 (parity == 0) ? "n" : "x",
 558                                 stopbits);
 559         }
 560
 561         return ret;
 562 }
 563
 564 /**
 565  * Manipulate handshake state for the specified serial port.
 566  *
 567  * @param serial Previously initialized serial port structure.
 568  * @param[in] rts Status of RTS line (0 or 1; or -1 to ignore).
 569  * @param[in] dtr Status of DTR line (0 or 1; or -1 to ignore).
 570  *
 571  * @retval SR_OK Success.
 572  * @retval SR_ERR Failure.
 573  *
 574  * @private
 575  */
 576 SR_PRIV int serial_set_handshake(struct sr_serial_dev_inst *serial,
 577         int rts, int dtr)
 578 {
 579         int ret;
 580
 581         if (!serial) {
 582                 sr_dbg("Invalid serial port.");
 583                 return SR_ERR;
 584         }
 585
 586         sr_spew("Modifying serial parameters on port %s.", serial->port);
 587
 588         if (!serial->lib_funcs || !serial->lib_funcs->set_handshake)
 589                 return SR_ERR_NA;
 590         ret = serial->lib_funcs->set_handshake(serial, rts, dtr);
 591
 592         return ret;
 593 }
 594
 595 /**
 596  * Set serial parameters for the specified serial port from parameter string.
 597  *
 598  * @param serial Previously initialized serial port structure.
 599  * @param[in] paramstr A serial communication parameters string of the form
 600  * "<baudrate>/<bits><parity><stopbits>{/<option>}".\n
 601  * Examples: "9600/8n1", "600/7o2/dtr=1/rts=0" or "460800/8n1/flow=2".\n
 602  * \<baudrate\>=integer Baud rate.\n
 603  * \<bits\>=5|6|7|8 Number of data bits.\n
 604  * \<parity\>=n|e|o None, even, odd.\n
 605  * \<stopbits\>=1|2 One or two stop bits.\n
 606  * Options:\n
 607  * dtr=0|1 Set DTR off resp. on.\n
 608  * flow=0|1|2 Flow control. 0 for none, 1 for RTS/CTS, 2 for XON/XOFF.\n
 609  * rts=0|1 Set RTS off resp. on.\n
 610  * Please note that values and combinations of these parameters must be
 611  * supported by the concrete serial interface hardware and the drivers for it.
 612  *
 613  * @retval SR_OK Success.
 614  * @retval SR_ERR Failure.
 615  *
 616  * @private
 617  */
 618 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
 619         const char *paramstr)
 620 {
 621 /** @cond PRIVATE */
 622 #define SERIAL_COMM_SPEC "^(\\d+)(/([5678])([neo])([12]))?(.*)$"
 623 /** @endcond */
 624
 625         GRegex *reg;
 626         GMatchInfo *match;
 627         int speed, databits, parity, stopbits, flow, rts, dtr, i;
 628         char *mstr, **opts, **kv;
 629
 630         speed = flow = 0;
 631         databits = 8;
 632         parity = SP_PARITY_NONE;
 633         stopbits = 1;
 634         rts = dtr = -1;
 635         sr_spew("Parsing parameters from \"%s\".", paramstr);
 636         reg = g_regex_new(SERIAL_COMM_SPEC, 0, 0, NULL);
 637         if (g_regex_match(reg, paramstr, 0, &match)) {
 638                 if ((mstr = g_match_info_fetch(match, 1)))
 639                         speed = strtoul(mstr, NULL, 10);
 640                 g_free(mstr);
 641                 if ((mstr = g_match_info_fetch(match, 3)) && mstr[0])
 642                         databits = strtoul(mstr, NULL, 10);
 643                 g_free(mstr);
 644                 if ((mstr = g_match_info_fetch(match, 4)) && mstr[0]) {
 645                         switch (mstr[0]) {
 646                         case 'n':
 647                                 parity = SP_PARITY_NONE;
 648                                 break;
 649                         case 'e':
 650                                 parity = SP_PARITY_EVEN;
 651                                 break;
 652                         case 'o':
 653                                 parity = SP_PARITY_ODD;
 654                                 break;
 655                         }
 656                 }
 657                 g_free(mstr);
 658                 if ((mstr = g_match_info_fetch(match, 5)) && mstr[0])
 659                         stopbits = strtoul(mstr, NULL, 10);
 660                 g_free(mstr);
 661                 if ((mstr = g_match_info_fetch(match, 6)) && mstr[0] != '\0') {
 662                         if (mstr[0] != '/') {
 663                                 sr_dbg("missing separator before extra options");
 664                                 speed = 0;
 665                         } else {
 666                                 /* A set of "key=value" options separated by / */
 667                                 opts = g_strsplit(mstr + 1, "/", 0);
 668                                 for (i = 0; opts[i]; i++) {
 669                                         kv = g_strsplit(opts[i], "=", 2);
 670                                         if (!strncmp(kv[0], "rts", 3)) {
 671                                                 if (kv[1][0] == '1')
 672                                                         rts = 1;
 673                                                 else if (kv[1][0] == '0')
 674                                                         rts = 0;
 675                                                 else {
 676                                                         sr_dbg("invalid value for rts: %c", kv[1][0]);
 677                                                         speed = 0;
 678                                                 }
 679                                         } else if (!strncmp(kv[0], "dtr", 3)) {
 680                                                 if (kv[1][0] == '1')
 681                                                         dtr = 1;
 682                                                 else if (kv[1][0] == '0')
 683                                                         dtr = 0;
 684                                                 else {
 685                                                         sr_dbg("invalid value for dtr: %c", kv[1][0]);
 686                                                         speed = 0;
 687                                                 }
 688                                         } else if (!strncmp(kv[0], "flow", 4)) {
 689                                                 if (kv[1][0] == '0')
 690                                                         flow = 0;
 691                                                 else if (kv[1][0] == '1')
 692                                                         flow = 1;
 693                                                 else if (kv[1][0] == '2')
 694                                                         flow = 2;
 695                                                 else {
 696                                                         sr_dbg("invalid value for flow: %c", kv[1][0]);
 697                                                         speed = 0;
 698                                                 }
 699                                         }
 700                                         g_strfreev(kv);
 701                                 }
 702                                 g_strfreev(opts);
 703                         }
 704                 }
 705                 g_free(mstr);
 706         }
 707         g_match_info_unref(match);
 708         g_regex_unref(reg);
 709         sr_spew("Got params: rate %d, frame %d/%d/%d, flow %d, rts %d, dtr %d.",
 710                 speed, databits, parity, stopbits, flow, rts, dtr);
 711
 712         if (!speed) {
 713                 sr_dbg("Could not infer speed from parameter string.");
 714                 return SR_ERR_ARG;
 715         }
 716
 717         return serial_set_params(serial, speed,
 718                         databits, parity, stopbits,
 719                         flow, rts, dtr);
 720 }
 721
 722 /**
 723  * Read a line from the specified serial port.
 724  *
 725  * @param[in] serial Previously initialized serial port structure.
 726  * @param[out] buf Buffer where to store the bytes that are read.
 727  * @param[in] buflen Size of the buffer.
 728  * @param[in] timeout_ms How long to wait for a line to come in.
 729  *
 730  * Reading stops when CR or LF is found, which is stripped from the buffer.
 731  *
 732  * @retval SR_OK Success.
 733  * @retval SR_ERR Failure.
 734  *
 735  * @private
 736  */
 737 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial,
 738         char **buf, int *buflen, gint64 timeout_ms)
 739 {
 740         gint64 start, remaining;
 741         int maxlen, len;
 742
 743         if (!serial) {
 744                 sr_dbg("Invalid serial port.");
 745                 return SR_ERR;
 746         }
 747
 748         if (!dev_is_supported(serial)) {
 749                 sr_dbg("Cannot use unopened serial port %s.", serial->port);
 750                 return -1;
 751         }
 752
 753         start = g_get_monotonic_time();
 754         remaining = timeout_ms;
 755
 756         maxlen = *buflen;
 757         *buflen = len = 0;
 758         while (1) {
 759                 len = maxlen - *buflen - 1;
 760                 if (len < 1)
 761                         break;
 762                 len = serial_read_blocking(serial, *buf + *buflen, 1, remaining);
 763                 if (len > 0) {
 764                         *buflen += len;
 765                         *(*buf + *buflen) = '\0';
 766                         if (*buflen > 0 && (*(*buf + *buflen - 1) == '\r'
 767                                         || *(*buf + *buflen - 1) == '\n')) {
 768                                 /* Strip CR/LF and terminate. */
 769                                 *(*buf + --*buflen) = '\0';
 770                                 break;
 771                         }
 772                 }
 773                 /* Reduce timeout by time elapsed. */
 774                 remaining = timeout_ms - ((g_get_monotonic_time() - start) / 1000);
 775                 if (remaining <= 0)
 776                         /* Timeout */
 777                         break;
 778                 if (len < 1)
 779                         g_usleep(2000);
 780         }
 781         if (*buflen)
 782                 sr_dbg("Received %d: '%s'.", *buflen, *buf);
 783
 784         return SR_OK;
 785 }
 786
 787 /**
 788  * Try to find a valid packet in a serial data stream.
 789  *
 790  * @param[in] serial Previously initialized serial port structure.
 791  * @param[in] buf Buffer containing the bytes to write.
 792  * @param[in] buflen Size of the buffer.
 793  * @param[in] packet_size Size, in bytes, of a valid packet.
 794  * @param[in] is_valid Callback that assesses whether the packet is valid or not.
 795  * @param[in] is_valid_len Callback which checks a variable length packet.
 796  * @param[out] return_size Detected packet size in case of successful match.
 797  * @param[in] timeout_ms The timeout after which, if no packet is detected, to
 798  *                       abort scanning.
 799  *
 800  * Data is received from the serial port and into the caller provided
 801  * buffer, until the buffer is exhausted, or the timeout has expired,
 802  * or a valid packet was found. Receive data is passed to the caller
 803  * provided validity check routine, assuming either fixed size packets
 804  * (#is_valid parameter, exact match to the #packet_size length) or
 805  * packets of variable length (#is_valid_len parameter, minimum length
 806  * #packet_size required for first invocation).
 807  *
 808  * @retval SR_OK Valid packet was found within the given timeout.
 809  * @retval SR_ERR Failure.
 810  *
 811  * @private
 812  */
 813 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
 814         uint8_t *buf, size_t *buflen,
 815         size_t packet_size, packet_valid_callback is_valid,
 816         packet_valid_len_callback is_valid_len, size_t *return_size,
 817         uint64_t timeout_ms)
 818 {
 819         uint64_t start_us, elapsed_ms, byte_delay_us;
 820         size_t fill_idx, check_idx, max_fill_idx;
 821         ssize_t recv_len;
 822         const uint8_t *check_ptr;
 823         size_t check_len, pkt_len;
 824         gboolean do_dump;
 825         int ret;
 826
 827         sr_dbg("Detecting packets on %s (timeout = %" PRIu64 "ms).",
 828                 serial->port, timeout_ms);
 829
 830         max_fill_idx = *buflen;
 831         if (max_fill_idx < 2 * packet_size) {
 832                 /*
 833                  * The heuristics in this check is only useful for fixed
 834                  * packet length scenarios, but for variable length setups
 835                  * we don't know the packets' sizes up front.
 836                  */
 837                 sr_err("Small stream detect RX buffer, want 2x packet size.");
 838                 return SR_ERR_ARG;
 839         }
 840
 841         byte_delay_us = serial_timeout(serial, 1) * 1000;
 842         start_us = g_get_monotonic_time();
 843
 844         check_idx = fill_idx = 0;
 845         while (fill_idx < max_fill_idx) {
 846                 /*
 847                  * Read bytes individually. Lets callers continue to
 848                  * successfully process next RX data after first match.
 849                  * Run full loop bodies for empty or failed reception
 850                  * in an iteration, to have timeouts checked.
 851                  */
 852                 recv_len = serial_read_nonblocking(serial, &buf[fill_idx], 1);
 853                 if (recv_len > 0)
 854                         fill_idx += recv_len;
 855
 856                 /* Dump receive data when (a minimum) size is reached. */
 857                 check_ptr = &buf[check_idx];
 858                 check_len = fill_idx - check_idx;
 859                 do_dump = check_len >= packet_size;
 860                 do_dump &= sr_log_loglevel_get() >= SR_LOG_SPEW;
 861                 if (do_dump) {
 862                         GString *text;
 863
 864                         text = sr_hexdump_new(check_ptr, check_len);
 865                         sr_spew("Trying packet: len %zu, bytes %s",
 866                                 check_len, text->str);
 867                         sr_hexdump_free(text);
 868                 }
 869
 870                 /* A packet's (minimum) length was received, check its data. */
 871                 elapsed_ms = g_get_monotonic_time() - start_us;
 872                 elapsed_ms /= 1000;
 873                 if (is_valid_len && check_len >= packet_size) {
 874                         pkt_len = packet_size;
 875                         ret = is_valid_len(NULL, check_ptr, check_len, &pkt_len);
 876                         if (ret == SR_PACKET_VALID) {
 877                                 /* Exact match. Terminate with success. */
 878                                 sr_spew("Valid packet after %" PRIu64 "ms.",
 879                                         elapsed_ms);
 880                                 sr_spew("RX count %zu, packet len %zu.",
 881                                         fill_idx, pkt_len);
 882                                 *buflen = fill_idx;
 883                                 if (return_size)
 884                                         *return_size = pkt_len;
 885                                 return SR_OK;
 886                         }
 887                         if (ret == SR_PACKET_NEED_RX) {
 888                                 /* Incomplete, keep accumulating RX data. */
 889                                 sr_spew("Checker needs more RX data.");
 890                         } else {
 891                                 /* Not a valid packet. Continue searching. */
 892                                 sr_spew("Invalid packet, advancing read pos.");
 893                                 check_idx++;
 894                         }
 895                 }
 896                 if (is_valid && check_len >= packet_size) {
 897                         if (is_valid(check_ptr)) {
 898                                 /* Exact match. Terminate with success. */
 899                                 sr_spew("Valid packet after %" PRIu64 "ms.",
 900                                         elapsed_ms);
 901                                 sr_spew("RX count %zu, packet len %zu.",
 902                                         fill_idx, packet_size);
 903                                 *buflen = fill_idx;
 904                                 if (return_size)
 905                                         *return_size = packet_size;
 906                                 return SR_OK;
 907                         }
 908                         /* Not a valid packet. Continue searching. */
 909                         sr_spew("Invalid packet, advancing read pointer.");
 910                         check_idx++;
 911                 }
 912
 913                 /* Check for packet search timeout. */
 914                 if (elapsed_ms >= timeout_ms) {
 915                         sr_dbg("Detection timed out after %" PRIu64 "ms.",
 916                                 elapsed_ms);
 917                         break;
 918                 }
 919                 if (recv_len < 1)
 920                         g_usleep(byte_delay_us);
 921         }
 922         sr_info("Didn't find a valid packet (read %zu bytes).", fill_idx);
 923         *buflen = fill_idx;
 924
 925         return SR_ERR;
 926 }
 927
 928 /**
 929  * Extract the serial device and options from the options linked list.
 930  *
 931  * The caller's passed in references get updated when the list of options
 932  * contains one of the desired parameters. This lets callers pre-assign
 933  * default values which take effect in the absence of user specifications.
 934  * Either reference is optional, passing #NULL is acceptable.
 935  *
 936  * Callers must not free returned strings. These shall be considered
 937  * read-only handles to data that is managed elsewhere.
 938  *
 939  * @param[in] options List of options passed from the command line.
 940  * @param[out] serial_device Pointer where to store the extracted serial device.
 941  * @param[out] serial_options Pointer where to store the optional extracted serial
 942  * options.
 943  *
 944  * @return SR_OK if a serial_device is found, SR_ERR if no device is found.
 945  *
 946  * @private
 947  */
 948 SR_PRIV int sr_serial_extract_options(GSList *options,
 949         const char **serial_device, const char **serial_options)
 950 {
 951         GSList *l;
 952         struct sr_config *src;
 953
 954         for (l = options; l; l = l->next) {
 955                 src = l->data;
 956                 switch (src->key) {
 957                 case SR_CONF_CONN:
 958                         if (!serial_device)
 959                                 break;
 960                         *serial_device = g_variant_get_string(src->data, NULL);
 961                         sr_dbg("Parsed serial device: %s.", *serial_device);
 962                         break;
 963                 case SR_CONF_SERIALCOMM:
 964                         if (!serial_options)
 965                                 break;
 966                         *serial_options = g_variant_get_string(src->data, NULL);
 967                         sr_dbg("Parsed serial options: %s.", *serial_options);
 968                         break;
 969                 }
 970         }
 971
 972         if (serial_device && !*serial_device) {
 973                 sr_dbg("No serial device specified.");
 974                 return SR_ERR;
 975         }
 976
 977         return SR_OK;
 978 }
 979
 980 /** @private */
 981 SR_PRIV int serial_source_add(struct sr_session *session,
 982         struct sr_serial_dev_inst *serial, int events, int timeout,
 983         sr_receive_data_callback cb, void *cb_data)
 984 {
 985         if ((events & (G_IO_IN | G_IO_ERR)) && (events & G_IO_OUT)) {
 986                 sr_err("Cannot poll input/error and output simultaneously.");
 987                 return SR_ERR_ARG;
 988         }
 989
 990         if (!dev_is_supported(serial)) {
 991                 sr_err("Invalid serial port.");
 992                 return SR_ERR_ARG;
 993         }
 994
 995         if (!serial->lib_funcs || !serial->lib_funcs->setup_source_add)
 996                 return SR_ERR_NA;
 997
 998         return serial->lib_funcs->setup_source_add(session, serial,
 999                 events, timeout, cb, cb_data);
1000 }
1001
1002 /** @private */
1003 SR_PRIV int serial_source_remove(struct sr_session *session,
1004         struct sr_serial_dev_inst *serial)
1005 {
1006         if (!dev_is_supported(serial)) {
1007                 sr_err("Invalid serial port.");
1008                 return SR_ERR_ARG;
1009         }
1010
1011         if (!serial->lib_funcs || !serial->lib_funcs->setup_source_remove)
1012                 return SR_ERR_NA;
1013
1014         return serial->lib_funcs->setup_source_remove(session, serial);
1015 }
1016
1017 /**
1018  * Create/allocate a new sr_serial_port structure.
1019  *
1020  * @param name The OS dependent name of the serial port. Must not be NULL.
1021  * @param description An end user friendly description for the serial port.
1022  *                    Can be NULL (in that case the empty string is used
1023  *                    as description).
1024  *
1025  * @return The newly allocated sr_serial_port struct.
1026  */
1027 static struct sr_serial_port *sr_serial_new(const char *name,
1028         const char *description)
1029 {
1030         struct sr_serial_port *serial;
1031
1032         if (!name)
1033                 return NULL;
1034
1035         serial = g_malloc0(sizeof(*serial));
1036         serial->name = g_strdup(name);
1037         serial->description = g_strdup(description ? description : "");
1038
1039         return serial;
1040 }
1041
1042 /**
1043  * Free a previously allocated sr_serial_port structure.
1044  *
1045  * @param serial The sr_serial_port struct to free. Must not be NULL.
1046  */
1047 SR_API void sr_serial_free(struct sr_serial_port *serial)
1048 {
1049         if (!serial)
1050                 return;
1051         g_free(serial->name);
1052         g_free(serial->description);
1053         g_free(serial);
1054 }
1055
1056 static GSList *append_port_list(GSList *devs, const char *name, const char *desc)
1057 {
1058         return g_slist_append(devs, sr_serial_new(name, desc));
1059 }
1060
1061 /**
1062  * List available serial devices.
1063  *
1064  * @return A GSList of strings containing the path of the serial devices or
1065  *         NULL if no serial device is found. The returned list must be freed
1066  *         by the caller.
1067  */
1068 SR_API GSList *sr_serial_list(const struct sr_dev_driver *driver)
1069 {
1070         GSList *tty_devs;
1071         GSList *(*list_func)(GSList *list, sr_ser_list_append_t append);
1072
1073         /* Currently unused, but will be used by some drivers later on. */
1074         (void)driver;
1075
1076         tty_devs = NULL;
1077         if (ser_lib_funcs_libsp && ser_lib_funcs_libsp->list) {
1078                 list_func = ser_lib_funcs_libsp->list;
1079                 tty_devs = list_func(tty_devs, append_port_list);
1080         }
1081         if (ser_lib_funcs_hid && ser_lib_funcs_hid->list) {
1082                 list_func = ser_lib_funcs_hid->list;
1083                 tty_devs = list_func(tty_devs, append_port_list);
1084         }
1085         if (ser_lib_funcs_bt && ser_lib_funcs_bt->list) {
1086                 list_func = ser_lib_funcs_bt->list;
1087                 tty_devs = list_func(tty_devs, append_port_list);
1088         }
1089
1090         return tty_devs;
1091 }
1092
1093 static GSList *append_port_find(GSList *devs, const char *name)
1094 {
1095         if (!name || !*name)
1096                 return devs;
1097
1098         return g_slist_append(devs, g_strdup(name));
1099 }
1100
1101 /**
1102  * Find USB serial devices via the USB vendor ID and product ID.
1103  *
1104  * @param[in] vendor_id Vendor ID of the USB device.
1105  * @param[in] product_id Product ID of the USB device.
1106  *
1107  * @return A GSList of strings containing the path of the serial device or
1108  *         NULL if no serial device is found. The returned list must be freed
1109  *         by the caller.
1110  *
1111  * @private
1112  */
1113 SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id)
1114 {
1115         GSList *tty_devs;
1116         GSList *(*find_func)(GSList *list, sr_ser_find_append_t append,
1117                         uint16_t vid, uint16_t pid);
1118
1119         tty_devs = NULL;
1120         if (ser_lib_funcs_libsp && ser_lib_funcs_libsp->find_usb) {
1121                 find_func = ser_lib_funcs_libsp->find_usb;
1122                 tty_devs = find_func(tty_devs, append_port_find,
1123                         vendor_id, product_id);
1124         }
1125         if (ser_lib_funcs_hid && ser_lib_funcs_hid->find_usb) {
1126                 find_func = ser_lib_funcs_hid->find_usb;
1127                 tty_devs = find_func(tty_devs, append_port_find,
1128                         vendor_id, product_id);
1129         }
1130
1131         return tty_devs;
1132 }
1133
1134 /** @private */
1135 SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes)
1136 {
1137         int bits, baud, ret, timeout_ms;
1138
1139         /* Get the bitrate and frame length. */
1140         bits = baud = 0;
1141         if (port->lib_funcs && port->lib_funcs->get_frame_format) {
1142                 ret = port->lib_funcs->get_frame_format(port, &baud, &bits);
1143                 if (ret != SR_OK)
1144                         bits = baud = 0;
1145         } else {
1146                 baud = port->comm_params.bit_rate;
1147                 bits = 1 + port->comm_params.data_bits +
1148                         port->comm_params.parity_bits +
1149                         port->comm_params.stop_bits;
1150         }
1151
1152         /* Derive the timeout. Default to 1s. */
1153         timeout_ms = 1000;
1154         if (bits && baud) {
1155                 /* Throw in 10ms for misc OS overhead. */
1156                 timeout_ms = 10;
1157                 timeout_ms += ((1000.0 / baud) * bits) * num_bytes;
1158         }
1159
1160         return timeout_ms;
1161 }
1162
1163 #else
1164
1165 /* TODO Put fallback.c content here? */
1166
1167 #endif
1168
1169 /** @} */