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