src/serial.c

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