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  *
   8  * This program is free software: you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation, either version 3 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22 #include <string.h>
  23 #include <stdlib.h>
  24 #include <glib.h>
  25 #include <glib/gstdio.h>
  26 #include <libserialport.h>
  27 #include "libsigrok.h"
  28 #include "libsigrok-internal.h"
  29
  30 #define LOG_PREFIX "serial"
  31
  32 /**
  33  * Open the specified serial port.
  34  *
  35  * @param serial Previously initialized serial port structure.
  36  * @param[in] flags Flags to use when opening the serial port. Possible flags
  37  *              include SERIAL_RDWR, SERIAL_RDONLY.
  38  *
  39  * If the serial structure contains a serialcomm string, it will be
  40  * passed to serial_set_paramstr() after the port is opened.
  41  *
  42  * @retval SR_OK Success.
  43  * @retval SR_ERR Failure.
  44  */
  45 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags)
  46 {
  47         int ret;
  48         char *error;
  49         int sp_flags = 0;
  50
  51         if (!serial) {
  52                 sr_dbg("Invalid serial port.");
  53                 return SR_ERR;
  54         }
  55
  56         sr_spew("Opening serial port '%s' (flags %d).", serial->port, flags);
  57
  58         sp_get_port_by_name(serial->port, &serial->data);
  59
  60         if (flags & SERIAL_RDWR)
  61                 sp_flags = (SP_MODE_READ | SP_MODE_WRITE);
  62         else if (flags & SERIAL_RDONLY)
  63                 sp_flags = SP_MODE_READ;
  64
  65         ret = sp_open(serial->data, sp_flags);
  66
  67         switch (ret) {
  68         case SP_ERR_ARG:
  69                 sr_err("Attempt to open serial port with invalid parameters.");
  70                 return SR_ERR_ARG;
  71         case SP_ERR_FAIL:
  72                 error = sp_last_error_message();
  73                 sr_err("Error opening port (%d): %s.",
  74                         sp_last_error_code(), error);
  75                 sp_free_error_message(error);
  76                 return SR_ERR;
  77         }
  78
  79         if (serial->serialcomm)
  80                 return serial_set_paramstr(serial, serial->serialcomm);
  81         else
  82                 return SR_OK;
  83 }
  84
  85 /**
  86  * Close the specified serial port.
  87  *
  88  * @param serial Previously initialized serial port structure.
  89  *
  90  * @retval SR_OK Success.
  91  * @retval SR_ERR Failure.
  92  */
  93 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial)
  94 {
  95         int ret;
  96         char *error;
  97
  98         if (!serial) {
  99                 sr_dbg("Invalid serial port.");
 100                 return SR_ERR;
 101         }
 102
 103         if (!serial->data) {
 104                 sr_dbg("Cannot close unopened serial port %s.", serial->port);
 105                 return SR_ERR;
 106         }
 107
 108         sr_spew("Closing serial port %s.", serial->port);
 109
 110         ret = sp_close(serial->data);
 111
 112         switch (ret) {
 113         case SP_ERR_ARG:
 114                 sr_err("Attempt to close an invalid serial port.");
 115                 return SR_ERR_ARG;
 116         case SP_ERR_FAIL:
 117                 error = sp_last_error_message();
 118                 sr_err("Error closing port (%d): %s.",
 119                         sp_last_error_code(), error);
 120                 sp_free_error_message(error);
 121                 return SR_ERR;
 122         }
 123
 124         sp_free_port(serial->data);
 125         serial->data = NULL;
 126
 127         return SR_OK;
 128 }
 129
 130 /**
 131  * Flush serial port buffers.
 132  *
 133  * @param serial Previously initialized serial port structure.
 134  *
 135  * @retval SR_OK Success.
 136  * @retval SR_ERR Failure.
 137  */
 138 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial)
 139 {
 140         int ret;
 141         char *error;
 142
 143         if (!serial) {
 144                 sr_dbg("Invalid serial port.");
 145                 return SR_ERR;
 146         }
 147
 148         if (!serial->data) {
 149                 sr_dbg("Cannot flush unopened serial port %s.", serial->port);
 150                 return SR_ERR;
 151         }
 152
 153         sr_spew("Flushing serial port %s.", serial->port);
 154
 155         ret = sp_flush(serial->data, SP_BUF_BOTH);
 156
 157         switch (ret) {
 158         case SP_ERR_ARG:
 159                 sr_err("Attempt to flush an invalid serial port.");
 160                 return SR_ERR_ARG;
 161         case SP_ERR_FAIL:
 162                 error = sp_last_error_message();
 163                 sr_err("Error flushing port (%d): %s.",
 164                         sp_last_error_code(), error);
 165                 sp_free_error_message(error);
 166                 return SR_ERR;
 167         }
 168
 169         return SR_OK;
 170 }
 171
 172 static int _serial_write(struct sr_serial_dev_inst *serial,
 173                 const void *buf, size_t count, int nonblocking)
 174 {
 175         ssize_t ret;
 176         char *error;
 177
 178         if (!serial) {
 179                 sr_dbg("Invalid serial port.");
 180                 return SR_ERR;
 181         }
 182
 183         if (!serial->data) {
 184                 sr_dbg("Cannot use unopened serial port %s.", serial->port);
 185                 return SR_ERR;
 186         }
 187
 188         if (nonblocking)
 189                 ret = sp_nonblocking_write(serial->data, buf, count);
 190         else
 191                 ret = sp_blocking_write(serial->data, buf, count, 0);
 192
 193         switch (ret) {
 194         case SP_ERR_ARG:
 195                 sr_err("Attempted serial port write with invalid arguments.");
 196                 return SR_ERR_ARG;
 197         case SP_ERR_FAIL:
 198                 error = sp_last_error_message();
 199                 sr_err("Write error (%d): %s.", sp_last_error_code(), error);
 200                 sp_free_error_message(error);
 201                 return SR_ERR;
 202         }
 203
 204         sr_spew("Wrote %d/%d bytes.", ret, count);
 205
 206         return ret;
 207 }
 208
 209 /**
 210  * Write a number of bytes to the specified serial port, blocking until finished.
 211  *
 212  * @param serial Previously initialized serial port structure.
 213  * @param[in] buf Buffer containing the bytes to write.
 214  * @param[in] count Number of bytes to write.
 215  *
 216  * @retval SR_ERR_ARG Invalid argument.
 217  * @retval SR_ERR Other error.
 218  * @retval other The number of bytes written.
 219  */
 220 SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
 221                 const void *buf, size_t count)
 222 {
 223         return _serial_write(serial, buf, count, 0);
 224 }
 225
 226 /**
 227  * Write a number of bytes to the specified serial port, return immediately.
 228  *
 229  * @param serial Previously initialized serial port structure.
 230  * @param[in] buf Buffer containing the bytes to write.
 231  * @param[in] count Number of bytes to write.
 232  *
 233  * @retval SR_ERR_ARG Invalid argument.
 234  * @retval SR_ERR Other error.
 235  * @retval other The number of bytes written.
 236 */
 237 SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial,
 238                 const void *buf, size_t count)
 239 {
 240         return _serial_write(serial, buf, count, 1);
 241 }
 242
 243 static int _serial_read(struct sr_serial_dev_inst *serial, void *buf,
 244                 size_t count, int nonblocking)
 245 {
 246         ssize_t ret;
 247         char *error;
 248
 249         if (!serial) {
 250                 sr_dbg("Invalid serial port.");
 251                 return SR_ERR;
 252         }
 253
 254         if (!serial->data) {
 255                 sr_dbg("Cannot use unopened serial port %s.", serial->port);
 256                 return SR_ERR;
 257         }
 258
 259         if (nonblocking)
 260                 ret = sp_nonblocking_read(serial->data, buf, count);
 261         else
 262                 ret = sp_blocking_read(serial->data, buf, count, 0);
 263
 264         switch (ret) {
 265         case SP_ERR_ARG:
 266                 sr_err("Attempted serial port read with invalid arguments.");
 267                 return SR_ERR_ARG;
 268         case SP_ERR_FAIL:
 269                 error = sp_last_error_message();
 270                 sr_err("Read error (%d): %s.", sp_last_error_code(), error);
 271                 sp_free_error_message(error);
 272                 return SR_ERR;
 273         }
 274
 275         if (ret > 0)
 276                 sr_spew("Read %d/%d bytes.", ret, count);
 277
 278         return ret;
 279 }
 280
 281 /**
 282  * Read a number of bytes from the specified serial port, block until finished.
 283  *
 284  * @param serial Previously initialized serial port structure.
 285  * @param buf Buffer where to store the bytes that are read.
 286  * @param[in] count The number of bytes to read.
 287  *
 288  * @retval SR_ERR_ARG Invalid argument.
 289  * @retval SR_ERR     Other error.
 290  * @retval other      The number of bytes read.
 291  */
 292 SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf,
 293                 size_t count)
 294 {
 295         return _serial_read(serial, buf, count, 0);
 296 }
 297
 298 /**
 299  * Try to read up to @a count bytes from the specified serial port, return
 300  * immediately with what's available.
 301  *
 302  * @param serial Previously initialized serial port structure.
 303  * @param buf Buffer where to store the bytes that are read.
 304  * @param[in] count The number of bytes to read.
 305  *
 306  * @retval SR_ERR_ARG Invalid argument.
 307  * @retval SR_ERR     Other error.
 308  * @retval other      The number of bytes read.
 309  */
 310 SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf,
 311                 size_t count)
 312 {
 313         return _serial_read(serial, buf, count, 1);
 314 }
 315
 316 /**
 317  * Set serial parameters for the specified serial port.
 318  *
 319  * @param serial Previously initialized serial port structure.
 320  * @param[in] baudrate The baudrate to set.
 321  * @param[in] bits The number of data bits to use (5, 6, 7 or 8).
 322  * @param[in] parity The parity setting to use (0 = none, 1 = even, 2 = odd).
 323  * @param[in] stopbits The number of stop bits to use (1 or 2).
 324  * @param[in] flowcontrol The flow control settings to use (0 = none,
 325  *                      1 = RTS/CTS, 2 = XON/XOFF).
 326  * @param[in] rts Status of RTS line (0 or 1; required by some interfaces).
 327  * @param[in] dtr Status of DTR line (0 or 1; required by some interfaces).
 328  *
 329  * @retval SR_OK Success.
 330  * @retval SR_ERR Failure.
 331  */
 332 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
 333                               int bits, int parity, int stopbits,
 334                               int flowcontrol, int rts, int dtr)
 335 {
 336         int ret;
 337         char *error;
 338         struct sp_port_config *config;
 339
 340         if (!serial) {
 341                 sr_dbg("Invalid serial port.");
 342                 return SR_ERR;
 343         }
 344
 345         if (!serial->data) {
 346                 sr_dbg("Cannot configure unopened serial port %s.", serial->port);
 347                 return SR_ERR;
 348         }
 349
 350         sr_spew("Setting serial parameters on port %s.", serial->port);
 351
 352         sp_new_config(&config);
 353         sp_set_config_baudrate(config, baudrate);
 354         sp_set_config_bits(config, bits);
 355         switch (parity) {
 356         case 0:
 357                 sp_set_config_parity(config, SP_PARITY_NONE);
 358                 break;
 359         case 1:
 360                 sp_set_config_parity(config, SP_PARITY_EVEN);
 361                 break;
 362         case 2:
 363                 sp_set_config_parity(config, SP_PARITY_ODD);
 364                 break;
 365         default:
 366                 return SR_ERR_ARG;
 367         }
 368         sp_set_config_stopbits(config, stopbits);
 369         sp_set_config_rts(config, flowcontrol == 1 ? SP_RTS_FLOW_CONTROL : rts);
 370         sp_set_config_cts(config, flowcontrol == 1 ? SP_CTS_FLOW_CONTROL : SP_CTS_IGNORE);
 371         sp_set_config_dtr(config, dtr);
 372         sp_set_config_dsr(config, SP_DSR_IGNORE);
 373         sp_set_config_xon_xoff(config, flowcontrol == 2 ? SP_XONXOFF_INOUT : SP_XONXOFF_DISABLED);
 374
 375         ret = sp_set_config(serial->data, config);
 376         sp_free_config(config);
 377
 378         switch (ret) {
 379         case SP_ERR_ARG:
 380                 sr_err("Invalid arguments for setting serial port parameters.");
 381                 return SR_ERR_ARG;
 382         case SP_ERR_FAIL:
 383                 error = sp_last_error_message();
 384                 sr_err("Error setting serial port parameters (%d): %s.",
 385                         sp_last_error_code(), error);
 386                 sp_free_error_message(error);
 387                 return SR_ERR;
 388         }
 389
 390         return SR_OK;
 391 }
 392
 393 /**
 394  * Set serial parameters for the specified serial port from parameter string.
 395  *
 396  * @param serial Previously initialized serial port structure.
 397  * @param[in] paramstr A serial communication parameters string of the form
 398  * "<baudrate>/<bits><parity><stopbits>{/<option>}".\n
 399  *  Examples: "9600/8n1", "600/7o2/dtr=1/rts=0" or "460800/8n1/flow=2".\n
 400  * \<baudrate\>=integer Baud rate.\n
 401  * \<bits\>=5|6|7|8 Number of data bits.\n
 402  * \<parity\>=n|e|o None, even, odd.\n
 403  * \<stopbits\>=1|2 One or two stop bits.\n
 404  * Options:\n
 405  * dtr=0|1 Set DTR off resp. on.\n
 406  * flow=0|1|2 Flow control. 0 for none, 1 for RTS/CTS, 2 for XON/XOFF.\n
 407  * rts=0|1 Set RTS off resp. on.\n
 408  * Please note that values and combinations of these parameters must be
 409  * supported by the concrete serial interface hardware and the drivers for it.
 410  * @retval SR_OK Success.
 411  * @retval SR_ERR Failure.
 412  */
 413 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
 414                 const char *paramstr)
 415 {
 416 #define SERIAL_COMM_SPEC "^(\\d+)/([5678])([neo])([12])(.*)$"
 417
 418         GRegex *reg;
 419         GMatchInfo *match;
 420         int speed, databits, parity, stopbits, flow, rts, dtr, i;
 421         char *mstr, **opts, **kv;
 422
 423         speed = databits = parity = stopbits = flow = 0;
 424         rts = dtr = -1;
 425         sr_spew("Parsing parameters from \"%s\".", paramstr);
 426         reg = g_regex_new(SERIAL_COMM_SPEC, 0, 0, NULL);
 427         if (g_regex_match(reg, paramstr, 0, &match)) {
 428                 if ((mstr = g_match_info_fetch(match, 1)))
 429                         speed = strtoul(mstr, NULL, 10);
 430                 g_free(mstr);
 431                 if ((mstr = g_match_info_fetch(match, 2)))
 432                         databits = strtoul(mstr, NULL, 10);
 433                 g_free(mstr);
 434                 if ((mstr = g_match_info_fetch(match, 3))) {
 435                         switch (mstr[0]) {
 436                         case 'n':
 437                                 parity = SERIAL_PARITY_NONE;
 438                                 break;
 439                         case 'e':
 440                                 parity = SERIAL_PARITY_EVEN;
 441                                 break;
 442                         case 'o':
 443                                 parity = SERIAL_PARITY_ODD;
 444                                 break;
 445                         }
 446                 }
 447                 g_free(mstr);
 448                 if ((mstr = g_match_info_fetch(match, 4)))
 449                         stopbits = strtoul(mstr, NULL, 10);
 450                 g_free(mstr);
 451                 if ((mstr = g_match_info_fetch(match, 5)) && mstr[0] != '\0') {
 452                         if (mstr[0] != '/') {
 453                                 sr_dbg("missing separator before extra options");
 454                                 speed = 0;
 455                         } else {
 456                                 /* A set of "key=value" options separated by / */
 457                                 opts = g_strsplit(mstr + 1, "/", 0);
 458                                 for (i = 0; opts[i]; i++) {
 459                                         kv = g_strsplit(opts[i], "=", 2);
 460                                         if (!strncmp(kv[0], "rts", 3)) {
 461                                                 if (kv[1][0] == '1')
 462                                                         rts = 1;
 463                                                 else if (kv[1][0] == '0')
 464                                                         rts = 0;
 465                                                 else {
 466                                                         sr_dbg("invalid value for rts: %c", kv[1][0]);
 467                                                         speed = 0;
 468                                                 }
 469                                         } else if (!strncmp(kv[0], "dtr", 3)) {
 470                                                 if (kv[1][0] == '1')
 471                                                         dtr = 1;
 472                                                 else if (kv[1][0] == '0')
 473                                                         dtr = 0;
 474                                                 else {
 475                                                         sr_dbg("invalid value for dtr: %c", kv[1][0]);
 476                                                         speed = 0;
 477                                                 }
 478                                         } else if (!strncmp(kv[0], "flow", 4)) {
 479                                                 if (kv[1][0] == '0')
 480                                                         flow = 0;
 481                                                 else if (kv[1][0] == '1')
 482                                                         flow = 1;
 483                                                 else if (kv[1][0] == '2')
 484                                                         flow = 2;
 485                                                 else {
 486                                                         sr_dbg("invalid value for flow: %c", kv[1][0]);
 487                                                         speed = 0;
 488                                                 }
 489                                         }
 490                                         g_strfreev(kv);
 491                                 }
 492                                 g_strfreev(opts);
 493                         }
 494                 }
 495                 g_free(mstr);
 496         }
 497         g_match_info_unref(match);
 498         g_regex_unref(reg);
 499
 500         if (speed) {
 501                 return serial_set_params(serial, speed, databits, parity,
 502                                          stopbits, flow, rts, dtr);
 503         } else {
 504                 sr_dbg("Could not infer speed from parameter string.");
 505                 return SR_ERR_ARG;
 506         }
 507 }
 508
 509 /**
 510  * Read a line from the specified serial port.
 511  *
 512  * @param serial Previously initialized serial port structure.
 513  * @param buf Buffer where to store the bytes that are read.
 514  * @param buflen Size of the buffer.
 515  * @param[in] timeout_ms How long to wait for a line to come in.
 516  *
 517  * Reading stops when CR of LR is found, which is stripped from the buffer.
 518  *
 519  * @retval SR_OK Success.
 520  * @retval SR_ERR Failure.
 521  */
 522 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
 523                 int *buflen, gint64 timeout_ms)
 524 {
 525         gint64 start, remaining;
 526         int maxlen, len;
 527
 528         if (!serial) {
 529                 sr_dbg("Invalid serial port.");
 530                 return SR_ERR;
 531         }
 532
 533         if (!serial->data) {
 534                 sr_dbg("Cannot use unopened serial port %s.", serial->port);
 535                 return -1;
 536         }
 537
 538         start = g_get_monotonic_time();
 539         remaining = timeout_ms;
 540
 541         maxlen = *buflen;
 542         *buflen = len = 0;
 543         while(1) {
 544                 len = maxlen - *buflen - 1;
 545                 if (len < 1)
 546                         break;
 547                 len = sp_blocking_read(serial->data, *buf + *buflen, 1, remaining);
 548                 if (len > 0) {
 549                         *buflen += len;
 550                         *(*buf + *buflen) = '\0';
 551                         if (*buflen > 0 && (*(*buf + *buflen - 1) == '\r'
 552                                         || *(*buf + *buflen - 1) == '\n')) {
 553                                 /* Strip CR/LF and terminate. */
 554                                 *(*buf + --*buflen) = '\0';
 555                                 break;
 556                         }
 557                 }
 558                 /* Reduce timeout by time elapsed. */
 559                 remaining = timeout_ms - ((g_get_monotonic_time() - start) / 1000);
 560                 if (remaining <= 0)
 561                         /* Timeout */
 562                         break;
 563                 if (len < 1)
 564                         g_usleep(2000);
 565         }
 566         if (*buflen)
 567                 sr_dbg("Received %d: '%s'.", *buflen, *buf);
 568
 569         return SR_OK;
 570 }
 571
 572 /**
 573  * Try to find a valid packet in a serial data stream.
 574  *
 575  * @param serial Previously initialized serial port structure.
 576  * @param buf Buffer containing the bytes to write.
 577  * @param buflen Size of the buffer.
 578  * @param[in] packet_size Size, in bytes, of a valid packet.
 579  * @param is_valid Callback that assesses whether the packet is valid or not.
 580  * @param[in] timeout_ms The timeout after which, if no packet is detected, to
 581  *                   abort scanning.
 582  * @param[in] baudrate The baudrate of the serial port. This parameter is not
 583  *                 critical, but it helps fine tune the serial port polling
 584  *                 delay.
 585  *
 586  * @retval SR_OK Valid packet was found within the given timeout.
 587  * @retval SR_ERR Failure.
 588  */
 589 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
 590                                  uint8_t *buf, size_t *buflen,
 591                                  size_t packet_size,
 592                                  packet_valid_callback is_valid,
 593                                  uint64_t timeout_ms, int baudrate)
 594 {
 595         uint64_t start, time, byte_delay_us;
 596         size_t ibuf, i, maxlen;
 597         int len;
 598
 599         maxlen = *buflen;
 600
 601         sr_dbg("Detecting packets on %s (timeout = %" PRIu64
 602                "ms, baudrate = %d).", serial->port, timeout_ms, baudrate);
 603
 604         if (maxlen < (packet_size / 2) ) {
 605                 sr_err("Buffer size must be at least twice the packet size.");
 606                 return SR_ERR;
 607         }
 608
 609         /* Assume 8n1 transmission. That is 10 bits for every byte. */
 610         byte_delay_us = 10 * (1000000 / baudrate);
 611         start = g_get_monotonic_time();
 612
 613         i = ibuf = len = 0;
 614         while (ibuf < maxlen) {
 615                 len = serial_read_nonblocking(serial, &buf[ibuf], 1);
 616                 if (len > 0) {
 617                         ibuf += len;
 618                 } else if (len == 0) {
 619                         /* No logging, already done in serial_read(). */
 620                 } else {
 621                         /* Error reading byte, but continuing anyway. */
 622                 }
 623
 624                 time = g_get_monotonic_time() - start;
 625                 time /= 1000;
 626
 627                 if ((ibuf - i) >= packet_size) {
 628                         /* We have at least a packet's worth of data. */
 629                         if (is_valid(&buf[i])) {
 630                                 sr_spew("Found valid %d-byte packet after "
 631                                         "%" PRIu64 "ms.", (ibuf - i), time);
 632                                 *buflen = ibuf;
 633                                 return SR_OK;
 634                         } else {
 635                                 sr_spew("Got %d bytes, but not a valid "
 636                                         "packet.", (ibuf - i));
 637                         }
 638                         /* Not a valid packet. Continue searching. */
 639                         i++;
 640                 }
 641                 if (time >= timeout_ms) {
 642                         /* Timeout */
 643                         sr_dbg("Detection timed out after %dms.", time);
 644                         break;
 645                 }
 646                 if (len < 1)
 647                         g_usleep(byte_delay_us);
 648         }
 649
 650         *buflen = ibuf;
 651
 652         sr_err("Didn't find a valid packet (read %d bytes).", *buflen);
 653
 654         return SR_ERR;
 655 }
 656
 657 /**
 658  * Extract the serial device and options from the options linked list.
 659  *
 660  * @param options List of options passed from the command line.
 661  * @param serial_device Pointer where to store the exctracted serial device.
 662  * @param serial_options Pointer where to store the optional extracted serial
 663  * options.
 664  *
 665  * @return SR_OK if a serial_device is found, SR_ERR if no device is found. The
 666  * returned string should not be freed by the caller.
 667  */
 668 SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
 669                                       const char **serial_options)
 670 {
 671         GSList *l;
 672         struct sr_config *src;
 673
 674         *serial_device = NULL;
 675
 676         for (l = options; l; l = l->next) {
 677                 src = l->data;
 678                 switch (src->key) {
 679                 case SR_CONF_CONN:
 680                         *serial_device = g_variant_get_string(src->data, NULL);
 681                         sr_dbg("Parsed serial device: %s", *serial_device);
 682                         break;
 683
 684                 case SR_CONF_SERIALCOMM:
 685                         *serial_options = g_variant_get_string(src->data, NULL);
 686                         sr_dbg("Parsed serial options: %s", *serial_options);
 687                         break;
 688                 }
 689         }
 690
 691         if (!*serial_device) {
 692                 sr_dbg("No serial device specified");
 693                 return SR_ERR;
 694         }
 695
 696         return SR_OK;
 697 }
 698
 699 #ifdef _WIN32
 700 typedef HANDLE event_handle;
 701 #else
 702 typedef int event_handle;
 703 #endif
 704
 705 SR_PRIV int serial_source_add(struct sr_session *session,
 706                 struct sr_serial_dev_inst *serial, int events, int timeout,
 707                 sr_receive_data_callback cb, void *cb_data)
 708 {
 709         enum sp_event mask = 0;
 710         unsigned int i;
 711
 712         if (sp_new_event_set(&serial->event_set) != SP_OK)
 713                 return SR_ERR;
 714
 715         if (events & G_IO_IN)
 716                 mask |= SP_EVENT_RX_READY;
 717         if (events & G_IO_OUT)
 718                 mask |= SP_EVENT_TX_READY;
 719         if (events & G_IO_ERR)
 720                 mask |= SP_EVENT_ERROR;
 721
 722         if (sp_add_port_events(serial->event_set, serial->data, mask) != SP_OK) {
 723                 sp_free_event_set(serial->event_set);
 724                 return SR_ERR;
 725         }
 726
 727         serial->pollfds = (GPollFD *) g_malloc0(sizeof(GPollFD) * serial->event_set->count);
 728
 729         for (i = 0; i < serial->event_set->count; i++) {
 730
 731                 serial->pollfds[i].fd = ((event_handle *) serial->event_set->handles)[i];
 732
 733                 mask = serial->event_set->masks[i];
 734
 735                 if (mask & SP_EVENT_RX_READY)
 736                         serial->pollfds[i].events |= G_IO_IN;
 737                 if (mask & SP_EVENT_TX_READY)
 738                         serial->pollfds[i].events |= G_IO_OUT;
 739                 if (mask & SP_EVENT_ERROR)
 740                         serial->pollfds[i].events |= G_IO_ERR;
 741
 742                 if (sr_session_source_add_pollfd(session, &serial->pollfds[i],
 743                                         timeout, cb, cb_data) != SR_OK)
 744                         return SR_ERR;
 745         }
 746
 747         return SR_OK;
 748 }
 749
 750 SR_PRIV int serial_source_remove(struct sr_session *session,
 751                 struct sr_serial_dev_inst *serial)
 752 {
 753         unsigned int i;
 754
 755         for (i = 0; i < serial->event_set->count; i++)
 756                 if (sr_session_source_remove_pollfd(session, &serial->pollfds[i]) != SR_OK)
 757                         return SR_ERR;
 758
 759         g_free(serial->pollfds);
 760         sp_free_event_set(serial->event_set);
 761
 762         serial->pollfds = NULL;
 763         serial->event_set = NULL;
 764
 765         return SR_OK;
 766 }
 767
 768 /**
 769  * Find USB serial devices via the USB vendor ID and product ID.
 770  *
 771  * @param[in] vendor_id Vendor ID of the USB device.
 772  * @param[in] product_id Product ID of the USB device.
 773  *
 774  * @return A GSList of strings containing the path of the serial device or
 775  *         NULL if no serial device is found. The returned list must be freed
 776  *         by the caller.
 777  */
 778 SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id)
 779 {
 780         GSList *tty_devs = NULL;
 781         struct sp_port **ports;
 782         int i, vid, pid;
 783
 784         if (sp_list_ports(&ports) != SP_OK)
 785                 return NULL;
 786
 787         for (i=0; ports[i]; i++)
 788                 if (sp_get_port_transport(ports[i]) == SP_TRANSPORT_USB &&
 789                     sp_get_port_usb_vid_pid(ports[i], &vid, &pid) == SP_OK &&
 790                     vid == vendor_id && pid == product_id)
 791                         tty_devs = g_slist_prepend(tty_devs,
 792                                                    g_strdup(sp_get_port_name(ports[i])));
 793
 794         sp_free_port_list(ports);
 795         return tty_devs;
 796 }