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