hardware/common/serial.c

   1 /*
   2  * This file is part of the sigrok 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 <sys/types.h>
  24 #include <sys/stat.h>
  25 #include <fcntl.h>
  26 #include <unistd.h>
  27 #ifdef _WIN32
  28 #include <windows.h>
  29 #else
  30 #include <glob.h>
  31 #include <termios.h>
  32 #include <sys/ioctl.h>
  33 #endif
  34 #include <stdlib.h>
  35 #include <errno.h>
  36 #include <glib.h>
  37 #include "libsigrok.h"
  38 #include "libsigrok-internal.h"
  39
  40 /* Message logging helpers with driver-specific prefix string. */
  41 #define DRIVER_LOG_DOMAIN "serial: "
  42 #define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args)
  43 #define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args)
  44 #define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args)
  45 #define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args)
  46 #define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args)
  47 #define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args)
  48
  49 // FIXME: Must be moved, or rather passed as function argument.
  50 #ifdef _WIN32
  51 static HANDLE hdl;
  52 #endif
  53
  54 /**
  55  * Open the specified serial port.
  56  *
  57  * @param serial Previously initialized serial port structure.
  58  * @param flags Flags to use when opening the serial port. Possible flags
  59  *              include SERIAL_RDWR, SERIAL_RDONLY, SERIAL_NONBLOCK.
  60  *
  61  * If the serial structure contains a serialcomm string, it will be
  62  * passed to serial_set_paramstr() after the port is opened.
  63  *
  64  * @return SR_OK on success, SR_ERR on failure.
  65  */
  66 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags)
  67 {
  68         int flags_local = 0;
  69 #ifdef _WIN32
  70         DWORD desired_access = 0, flags_and_attributes = 0;
  71 #endif
  72
  73         if (!serial) {
  74                 sr_dbg("Invalid serial port.");
  75                 return SR_ERR;
  76         }
  77
  78         sr_spew("Opening serial port '%s' (flags %d).", serial->port, flags);
  79
  80 #ifdef _WIN32
  81         /* Map 'flags' to the OS-specific settings. */
  82         desired_access |= GENERIC_READ;
  83         flags_and_attributes = FILE_ATTRIBUTE_NORMAL;
  84         if (flags & SERIAL_RDWR)
  85                 desired_access |= GENERIC_WRITE;
  86         if (flags & SERIAL_NONBLOCK)
  87                 flags_and_attributes |= FILE_FLAG_OVERLAPPED;
  88
  89         hdl = CreateFile(serial->port, desired_access, 0, 0,
  90                          OPEN_EXISTING, flags_and_attributes, 0);
  91         if (hdl == INVALID_HANDLE_VALUE) {
  92                 sr_err("Error opening serial port '%s'.", serial->port);
  93                 return SR_ERR;
  94         }
  95 #else
  96         /* Map 'flags' to the OS-specific settings. */
  97         if (flags & SERIAL_RDWR)
  98                 flags_local |= O_RDWR;
  99         if (flags & SERIAL_RDONLY)
 100                 flags_local |= O_RDONLY;
 101         if (flags & SERIAL_NONBLOCK)
 102                 flags_local |= O_NONBLOCK;
 103
 104         if ((serial->fd = open(serial->port, flags_local)) < 0) {
 105                 sr_err("Error opening serial port '%s': %s.", serial->port,
 106                        strerror(errno));
 107                 return SR_ERR;
 108         }
 109
 110         sr_spew("Opened serial port '%s' (fd %d).", serial->port, serial->fd);
 111 #endif
 112
 113         if (serial->serialcomm)
 114                 return serial_set_paramstr(serial, serial->serialcomm);
 115         else
 116                 return SR_OK;
 117 }
 118
 119 /**
 120  * Close the specified serial port.
 121  *
 122  * @param serial Previously initialized serial port structure.
 123  *
 124  * @return SR_OK on success, SR_ERR on failure.
 125  */
 126 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial)
 127 {
 128         int ret;
 129
 130         if (!serial) {
 131                 sr_dbg("Invalid serial port.");
 132                 return SR_ERR;
 133         }
 134
 135         if (serial->fd == -1) {
 136                 sr_dbg("Cannot close unopened serial port %s (fd %d).",
 137                                 serial->port, serial->fd);
 138                 return SR_ERR;
 139         }
 140
 141         sr_spew("Closing serial port %s (fd %d).", serial->port, serial->fd);
 142         ret = SR_OK;
 143
 144 #ifdef _WIN32
 145         /* Returns non-zero upon success, 0 upon failure. */
 146         if (CloseHandle(hdl) == 0)
 147                 ret = SR_ERR;
 148 #else
 149         /* Returns 0 upon success, -1 upon failure. */
 150         if (close(serial->fd) < 0) {
 151                 sr_err("Error closing serial port: %s (fd %d).", strerror(errno),
 152                                 serial->fd);
 153                 ret = SR_ERR;
 154         }
 155 #endif
 156
 157         serial->fd = -1;
 158
 159         return ret;
 160 }
 161
 162 /**
 163  * Flush serial port buffers.
 164  *
 165  * @param serial Previously initialized serial port structure.
 166  *
 167  * @return SR_OK on success, SR_ERR on failure.
 168  */
 169 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial)
 170 {
 171         int ret;
 172
 173         if (!serial) {
 174                 sr_dbg("Invalid serial port.");
 175                 return SR_ERR;
 176         }
 177
 178         if (serial->fd == -1) {
 179                 sr_dbg("Cannot flush unopened serial port %s (fd %d).",
 180                                 serial->port, serial->fd);
 181                 return SR_ERR;
 182         }
 183
 184         sr_spew("Flushing serial port %s (fd %d).", serial->port, serial->fd);
 185         ret = SR_OK;
 186
 187 #ifdef _WIN32
 188         /* Returns non-zero upon success, 0 upon failure. */
 189         if (PurgeComm(hdl, PURGE_RXCLEAR | PURGE_TXCLEAR) == 0) {
 190                 sr_err("Error flushing serial port: %s.", strerror(errno));
 191                 ret = SR_ERR;
 192         }
 193 #else
 194         /* Returns 0 upon success, -1 upon failure. */
 195         if (tcflush(serial->fd, TCIOFLUSH) < 0) {
 196                 sr_err("Error flushing serial port: %s.", strerror(errno));
 197                 ret = SR_ERR;
 198         }
 199
 200         return ret;
 201 #endif
 202 }
 203
 204 /**
 205  * Write a number of bytes to the specified serial port.
 206  *
 207  * @param serial Previously initialized serial port structure.
 208  * @param buf Buffer containing the bytes to write.
 209  * @param count Number of bytes to write.
 210  *
 211  * @return The number of bytes written, or -1 upon failure.
 212  */
 213 SR_PRIV int serial_write(struct sr_serial_dev_inst *serial,
 214                 const void *buf, size_t count)
 215 {
 216         ssize_t ret;
 217
 218         if (!serial) {
 219                 sr_dbg("Invalid serial port.");
 220                 return -1;
 221         }
 222
 223         if (serial->fd == -1) {
 224                 sr_dbg("Cannot use unopened serial port %s (fd %d).",
 225                                 serial->port, serial->fd);
 226                 return -1;
 227         }
 228
 229 #ifdef _WIN32
 230         DWORD tmp = 0;
 231
 232         /* FIXME */
 233         /* Returns non-zero upon success, 0 upon failure. */
 234         WriteFile(hdl, buf, count, &tmp, NULL);
 235 #else
 236         /* Returns the number of bytes written, or -1 upon failure. */
 237         ret = write(serial->fd, buf, count);
 238         if (ret < 0)
 239                 sr_err("Write error: %s.", strerror(errno));
 240         else
 241                 sr_spew("Wrote %d/%d bytes (fd %d).", ret, count, serial->fd);
 242 #endif
 243
 244         return ret;
 245 }
 246
 247 /**
 248  * Read a number of bytes from the specified serial port.
 249  *
 250  * @param serial Previously initialized serial port structure.
 251  * @param buf Buffer where to store the bytes that are read.
 252  * @param count The number of bytes to read.
 253  *
 254  * @return The number of bytes read, or -1 upon failure.
 255  */
 256 SR_PRIV int serial_read(struct sr_serial_dev_inst *serial, void *buf,
 257                 size_t count)
 258 {
 259         ssize_t ret;
 260
 261         if (!serial) {
 262                 sr_dbg("Invalid serial port.");
 263                 return -1;
 264         }
 265
 266         if (serial->fd == -1) {
 267                 sr_dbg("Cannot use unopened serial port %s (fd %d).",
 268                                 serial->port, serial->fd);
 269                 return -1;
 270         }
 271
 272 #ifdef _WIN32
 273         DWORD tmp = 0;
 274
 275         /* FIXME */
 276         /* Returns non-zero upon success, 0 upon failure. */
 277         return ReadFile(hdl, buf, count, &tmp, NULL);
 278 #else
 279         /* Returns the number of bytes read, or -1 upon failure. */
 280         ret = read(serial->fd, buf, count);
 281         if (ret >= 0)
 282                 sr_spew("Read %d/%d bytes (fd %d).", ret, count, serial->fd);
 283 #endif
 284
 285         return ret;
 286 }
 287
 288 /**
 289  * Set serial parameters for the specified serial port.
 290  *
 291  * @param serial Previously initialized serial port structure.
 292  * @param baudrate The baudrate to set.
 293  * @param bits The number of data bits to use.
 294  * @param parity The parity setting to use (0 = none, 1 = even, 2 = odd).
 295  * @param stopbits The number of stop bits to use (1 or 2).
 296  * @param flowcontrol The flow control settings to use (0 = none, 1 = RTS/CTS,
 297  *                    2 = XON/XOFF).
 298  *
 299  * @return SR_OK upon success, SR_ERR upon failure.
 300  */
 301 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
 302                               int bits, int parity, int stopbits,
 303                               int flowcontrol, int rts, int dtr)
 304 {
 305         if (!serial) {
 306                 sr_dbg("Invalid serial port.");
 307                 return SR_ERR;
 308         }
 309
 310         if (serial->fd == -1) {
 311                 sr_dbg("Cannot configure unopened serial port %s (fd %d).",
 312                        serial->port, serial->fd);
 313                 return SR_ERR;
 314         }
 315
 316         sr_spew("Setting serial parameters on port %s (fd %d).", serial->port,
 317                 serial->fd);
 318
 319 #ifdef _WIN32
 320         DCB dcb;
 321
 322         if (!GetCommState(hdl, &dcb)) {
 323                 sr_err("Failed to get comm state on port %s (fd %d): %d.",
 324                        serial->port, serial->fd, GetLastError());
 325                 return SR_ERR;
 326         }
 327
 328         switch (baudrate) {
 329         /*
 330          * The baudrates 50/75/134/150/200/1800/230400/460800 do not seem to
 331          * have documented CBR_* macros.
 332          */
 333         case 110:
 334                 dcb.BaudRate = CBR_110;
 335                 break;
 336         case 300:
 337                 dcb.BaudRate = CBR_300;
 338                 break;
 339         case 600:
 340                 dcb.BaudRate = CBR_600;
 341                 break;
 342         case 1200:
 343                 dcb.BaudRate = CBR_1200;
 344                 break;
 345         case 2400:
 346                 dcb.BaudRate = CBR_2400;
 347                 break;
 348         case 4800:
 349                 dcb.BaudRate = CBR_4800;
 350                 break;
 351         case 9600:
 352                 dcb.BaudRate = CBR_9600;
 353                 break;
 354         case 14400:
 355                 dcb.BaudRate = CBR_14400; /* Not available on Unix? */
 356                 break;
 357         case 19200:
 358                 dcb.BaudRate = CBR_19200;
 359                 break;
 360         case 38400:
 361                 dcb.BaudRate = CBR_38400;
 362                 break;
 363         case 57600:
 364                 dcb.BaudRate = CBR_57600;
 365                 break;
 366         case 115200:
 367                 dcb.BaudRate = CBR_115200;
 368                 break;
 369         case 128000:
 370                 dcb.BaudRate = CBR_128000; /* Not available on Unix? */
 371                 break;
 372         case 256000:
 373                 dcb.BaudRate = CBR_256000; /* Not available on Unix? */
 374                 break;
 375         default:
 376                 sr_err("Unsupported baudrate: %d.", baudrate);
 377                 return SR_ERR;
 378         }
 379         sr_spew("Configuring baudrate to %d (%d).", baudrate, dcb.BaudRate);
 380
 381         sr_spew("Configuring %d data bits.", bits);
 382         dcb.ByteSize = bits;
 383
 384         sr_spew("Configuring %d stop bits.", stopbits);
 385         switch (stopbits) {
 386         /* Note: There's also ONE5STOPBITS == 1.5 (unneeded so far). */
 387         case 1:
 388                 dcb.StopBits = ONESTOPBIT;
 389                 break;
 390         case 2:
 391                 dcb.StopBits = TWOSTOPBITS;
 392                 break;
 393         default:
 394                 sr_err("Unsupported stopbits number: %d.", stopbits);
 395                 return SR_ERR;
 396         }
 397
 398         switch (parity) {
 399         /* Note: There's also SPACEPARITY, MARKPARITY (unneeded so far). */
 400         case SERIAL_PARITY_NONE:
 401                 sr_spew("Configuring no parity.");
 402                 dcb.Parity = NOPARITY;
 403                 break;
 404         case SERIAL_PARITY_EVEN:
 405                 sr_spew("Configuring even parity.");
 406                 dcb.Parity = EVENPARITY;
 407                 break;
 408         case SERIAL_PARITY_ODD:
 409                 sr_spew("Configuring odd parity.");
 410                 dcb.Parity = ODDPARITY;
 411                 break;
 412         default:
 413                 sr_err("Unsupported parity setting: %d.", parity);
 414                 return SR_ERR;
 415         }
 416
 417         if (rts != -1) {
 418                 sr_spew("Setting RTS %s.", rts ? "high" : "low");
 419                 if (rts)
 420                         dcb.fRtsControl = RTS_CONTROL_ENABLE;
 421                 else
 422                         dcb.fRtsControl = RTS_CONTROL_DISABLE;
 423         }
 424
 425         if (dtr != -1) {
 426                 sr_spew("Setting DTR %s.", dtr ? "high" : "low");
 427                 if (rts)
 428                         dcb.fDtrControl = DTR_CONTROL_ENABLE;
 429                 else
 430                         dcb.fDtrControl = DTR_CONTROL_DISABLE;
 431         }
 432
 433         if (!SetCommState(hdl, &dcb)) {
 434                 sr_err("Failed to set comm state on port %s (fd %d): %d.",
 435                        serial->port, serial->fd, GetLastError());
 436                 return SR_ERR;
 437         }
 438 #else
 439         struct termios term;
 440         speed_t baud;
 441         int ret, controlbits;
 442
 443         if (tcgetattr(serial->fd, &term) < 0) {
 444                 sr_err("tcgetattr() error on port %s (fd %d): %s.",
 445                                 serial->port, serial->fd, strerror(errno));
 446                 return SR_ERR;
 447         }
 448
 449         switch (baudrate) {
 450         case 50:
 451                 baud = B50;
 452                 break;
 453         case 75:
 454                 baud = B75;
 455                 break;
 456         case 110:
 457                 baud = B110;
 458                 break;
 459         case 134:
 460                 baud = B134;
 461                 break;
 462         case 150:
 463                 baud = B150;
 464                 break;
 465         case 200:
 466                 baud = B200;
 467                 break;
 468         case 300:
 469                 baud = B300;
 470                 break;
 471         case 600:
 472                 baud = B600;
 473                 break;
 474         case 1200:
 475                 baud = B1200;
 476                 break;
 477         case 1800:
 478                 baud = B1800;
 479                 break;
 480         case 2400:
 481                 baud = B2400;
 482                 break;
 483         case 4800:
 484                 baud = B4800;
 485                 break;
 486         case 9600:
 487                 baud = B9600;
 488                 break;
 489         case 19200:
 490                 baud = B19200;
 491                 break;
 492         case 38400:
 493                 baud = B38400;
 494                 break;
 495         case 57600:
 496                 baud = B57600;
 497                 break;
 498         case 115200:
 499                 baud = B115200;
 500                 break;
 501         case 230400:
 502                 baud = B230400;
 503                 break;
 504 #ifndef __APPLE__
 505         case 460800:
 506                 baud = B460800;
 507                 break;
 508 #endif
 509         default:
 510                 sr_err("Unsupported baudrate: %d.", baudrate);
 511                 return SR_ERR;
 512         }
 513
 514         sr_spew("Configuring output baudrate to %d (%d).", baudrate, baud);
 515         if (cfsetospeed(&term, baud) < 0) {
 516                 sr_err("cfsetospeed() error: %s.", strerror(errno));
 517                 return SR_ERR;
 518         }
 519
 520         sr_spew("Configuring input baudrate to %d (%d).", baudrate, baud);
 521         if (cfsetispeed(&term, baud) < 0) {
 522                 sr_err("cfsetispeed() error: %s.", strerror(errno));
 523                 return SR_ERR;
 524         }
 525
 526         sr_spew("Configuring %d data bits.", bits);
 527         term.c_cflag &= ~CSIZE;
 528         switch (bits) {
 529         case 8:
 530                 term.c_cflag |= CS8;
 531                 break;
 532         case 7:
 533                 term.c_cflag |= CS7;
 534                 break;
 535         default:
 536                 sr_err("Unsupported data bits number %d.", bits);
 537                 return SR_ERR;
 538         }
 539
 540         sr_spew("Configuring %d stop bits.", stopbits);
 541         term.c_cflag &= ~CSTOPB;
 542         switch (stopbits) {
 543         case 1:
 544                 term.c_cflag &= ~CSTOPB;
 545                 break;
 546         case 2:
 547                 term.c_cflag |= CSTOPB;
 548                 break;
 549         default:
 550                 sr_err("Unsupported stopbits number %d.", stopbits);
 551                 return SR_ERR;
 552         }
 553
 554         term.c_iflag &= ~(IXON | IXOFF);
 555         term.c_cflag &= ~CRTSCTS;
 556         switch (flowcontrol) {
 557         case 0:
 558                 /* No flow control. */
 559                 sr_spew("Configuring no flow control.");
 560                 break;
 561         case 1:
 562                 sr_spew("Configuring RTS/CTS flow control.");
 563                 term.c_cflag |= CRTSCTS;
 564                 break;
 565         case 2:
 566                 sr_spew("Configuring XON/XOFF flow control.");
 567                 term.c_iflag |= IXON | IXOFF;
 568                 break;
 569         default:
 570                 sr_err("Unsupported flow control setting %d.", flowcontrol);
 571                 return SR_ERR;
 572         }
 573
 574         term.c_iflag &= ~IGNPAR;
 575         term.c_cflag &= ~(PARODD | PARENB);
 576         switch (parity) {
 577         case SERIAL_PARITY_NONE:
 578                 sr_spew("Configuring no parity.");
 579                 term.c_iflag |= IGNPAR;
 580                 break;
 581         case SERIAL_PARITY_EVEN:
 582                 sr_spew("Configuring even parity.");
 583                 term.c_cflag |= PARENB;
 584                 break;
 585         case SERIAL_PARITY_ODD:
 586                 sr_spew("Configuring odd parity.");
 587                 term.c_cflag |= PARENB | PARODD;
 588                 break;
 589         default:
 590                 sr_err("Unsupported parity setting %d.", parity);
 591                 return SR_ERR;
 592         }
 593
 594         /* Do not translate carriage return to newline on input. */
 595         term.c_iflag &= ~(ICRNL);
 596
 597         /* Disable canonical mode, and don't echo input characters. */
 598         term.c_lflag &= ~(ICANON | ECHO);
 599
 600         /* Write the configured settings. */
 601         if (tcsetattr(serial->fd, TCSADRAIN, &term) < 0) {
 602                 sr_err("tcsetattr() error: %s.", strerror(errno));
 603                 return SR_ERR;
 604         }
 605
 606         if (rts != -1) {
 607                 sr_spew("Setting RTS %s.", rts ? "high" : "low");
 608                 controlbits = TIOCM_RTS;
 609                 if ((ret = ioctl(serial->fd, rts ? TIOCMBIS : TIOCMBIC,
 610                                 &controlbits)) < 0) {
 611                         sr_err("Error setting RTS: %s.", strerror(errno));
 612                         return SR_ERR;
 613                 }
 614         }
 615
 616         if (dtr != -1) {
 617                 sr_spew("Setting DTR %s.", dtr ? "high" : "low");
 618                 controlbits = TIOCM_DTR;
 619                 if ((ret = ioctl(serial->fd, dtr ? TIOCMBIS : TIOCMBIC,
 620                                 &controlbits)) < 0) {
 621                         sr_err("Error setting DTR: %s.", strerror(errno));
 622                         return SR_ERR;
 623                 }
 624         }
 625
 626 #endif
 627
 628         return SR_OK;
 629 }
 630
 631 /**
 632  * Set serial parameters for the specified serial port.
 633  *
 634  * @param serial Previously initialized serial port structure.
 635  * @param paramstr A serial communication parameters string, in the form
 636  * of <speed>/<data bits><parity><stopbits>, for example "9600/8n1" or
 637  * "600/7o2".
 638  *
 639  * @return SR_OK upon success, SR_ERR upon failure.
 640  */
 641 #define SERIAL_COMM_SPEC "^(\\d+)/([78])([neo])([12])(.*)$"
 642 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
 643                 const char *paramstr)
 644 {
 645         GRegex *reg;
 646         GMatchInfo *match;
 647         int speed, databits, parity, stopbits, rts, dtr, i;
 648         char *mstr, **opts, **kv;
 649
 650         speed = databits = parity = stopbits = 0;
 651         rts = dtr = -1;
 652         sr_spew("Parsing parameters from \"%s\".", paramstr);
 653         reg = g_regex_new(SERIAL_COMM_SPEC, 0, 0, NULL);
 654         if (g_regex_match(reg, paramstr, 0, &match)) {
 655                 if ((mstr = g_match_info_fetch(match, 1)))
 656                         speed = strtoul(mstr, NULL, 10);
 657                 g_free(mstr);
 658                 if ((mstr = g_match_info_fetch(match, 2)))
 659                         databits = strtoul(mstr, NULL, 10);
 660                 g_free(mstr);
 661                 if ((mstr = g_match_info_fetch(match, 3))) {
 662                         switch (mstr[0]) {
 663                         case 'n':
 664                                 parity = SERIAL_PARITY_NONE;
 665                                 break;
 666                         case 'e':
 667                                 parity = SERIAL_PARITY_EVEN;
 668                                 break;
 669                         case 'o':
 670                                 parity = SERIAL_PARITY_ODD;
 671                                 break;
 672                         }
 673                 }
 674                 g_free(mstr);
 675                 if ((mstr = g_match_info_fetch(match, 4)))
 676                         stopbits = strtoul(mstr, NULL, 10);
 677                 g_free(mstr);
 678                 if ((mstr = g_match_info_fetch(match, 5)) && mstr[0] != '\0') {
 679                         if (mstr[0] != '/') {
 680                                 sr_dbg("missing separator before extra options");
 681                                 speed = 0;
 682                         } else {
 683                                 /* A set of "key=value" options separated by / */
 684                                 opts = g_strsplit(mstr + 1, "/", 0);
 685                                 for (i = 0; opts[i]; i++) {
 686                                         kv = g_strsplit(opts[i], "=", 2);
 687                                         if (!strncmp(kv[0], "rts", 3)) {
 688                                                 if (kv[1][0] == '1')
 689                                                         rts = 1;
 690                                                 else if (kv[1][0] == '0')
 691                                                         rts = 0;
 692                                                 else {
 693                                                         sr_dbg("invalid value for rts: %c", kv[1][0]);
 694                                                         speed = 0;
 695                                                 }
 696                                         } else if (!strncmp(kv[0], "dtr", 3)) {
 697                                                 if (kv[1][0] == '1')
 698                                                         dtr = 1;
 699                                                 else if (kv[1][0] == '0')
 700                                                         dtr = 0;
 701                                                 else {
 702                                                         sr_dbg("invalid value for dtr: %c", kv[1][0]);
 703                                                         speed = 0;
 704                                                 }
 705                                         }
 706                                         g_strfreev(kv);
 707                                 }
 708                                 g_strfreev(opts);
 709                         }
 710                 }
 711                 g_free(mstr);
 712         }
 713         g_match_info_unref(match);
 714         g_regex_unref(reg);
 715
 716         if (speed) {
 717                 return serial_set_params(serial, speed, databits, parity,
 718                                          stopbits, 0, rts, dtr);
 719         } else {
 720                 sr_dbg("Could not infer speed from parameter string.");
 721                 return SR_ERR_ARG;
 722         }
 723 }
 724
 725 /**
 726  * Read a line from the specified serial port.
 727  *
 728  * @param serial Previously initialized serial port structure.
 729  * @param buf Buffer where to store the bytes that are read.
 730  * @param buflen Size of the buffer.
 731  * @param timeout_ms How long to wait for a line to come in.
 732  *
 733  * Reading stops when CR of LR is found, which is stripped from the buffer.
 734  *
 735  * @return SR_OK on success, SR_ERR on failure.
 736  */
 737 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
 738                 int *buflen, gint64 timeout_ms)
 739 {
 740         gint64 start;
 741         int maxlen, len;
 742
 743         if (!serial || serial->fd == -1) {
 744                 sr_dbg("Invalid serial port.");
 745                 return SR_ERR;
 746         }
 747
 748         if (serial->fd == -1) {
 749                 sr_dbg("Cannot use unopened serial port %s (fd %d).",
 750                                 serial->port, serial->fd);
 751                 return -1;
 752         }
 753
 754         timeout_ms *= 1000;
 755         start = g_get_monotonic_time();
 756
 757         maxlen = *buflen;
 758         *buflen = len = 0;
 759         while(1) {
 760                 len = maxlen - *buflen - 1;
 761                 if (len < 1)
 762                         break;
 763                 len = serial_read(serial, *buf + *buflen, 1);
 764                 if (len > 0) {
 765                         *buflen += len;
 766                         *(*buf + *buflen) = '\0';
 767                         if (*buflen > 0 && (*(*buf + *buflen - 1) == '\r'
 768                                         || *(*buf + *buflen - 1) == '\n')) {
 769                                 /* Strip CR/LF and terminate. */
 770                                 *(*buf + --*buflen) = '\0';
 771                                 break;
 772                         }
 773                 }
 774                 if (g_get_monotonic_time() - start > timeout_ms)
 775                         /* Timeout */
 776                         break;
 777                 g_usleep(2000);
 778         }
 779         if (*buflen)
 780                 sr_dbg("Received %d: '%s'.", *buflen, *buf);
 781
 782         return SR_OK;
 783 }
 784
 785 /**
 786  * Try to find a valid packet in a serial data stream.
 787  *
 788  * @param serial Previously initialized serial port structure.
 789  * @param buf Buffer containing the bytes to write.
 790  * @param count Size of the buffer.
 791  * @param packet_size Size, in bytes, of a valid packet.
 792  * @param is_valid Callback that assesses whether the packet is valid or not.
 793  * @param timeout_ms The timeout after which, if no packet is detected, to
 794  *                   abort scanning.
 795  * @param baudrate The baudrate of the serial port. This parameter is not
 796  *                 critical, but it helps fine tune the serial port polling
 797  *                 delay.
 798  *
 799  * @return SR_OK if a valid packet is found within the given timeout,
 800  *         SR_ERR upon failure.
 801  */
 802 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
 803                                  uint8_t *buf, size_t *buflen,
 804                                  size_t packet_size, packet_valid_t is_valid,
 805                                  uint64_t timeout_ms, int baudrate)
 806 {
 807         uint64_t start, time, byte_delay_us;
 808         size_t ibuf, i, maxlen;
 809         int len;
 810
 811         maxlen = *buflen;
 812
 813         sr_dbg("Detecting packets on FD %d (timeout = %" PRIu64
 814                "ms, baudrate = %d).", serial->fd, timeout_ms, baudrate);
 815
 816         if (maxlen < (packet_size / 2) ) {
 817                 sr_err("Buffer size must be at least twice the packet size.");
 818                 return SR_ERR;
 819         }
 820
 821         /* Assume 8n1 transmission. That is 10 bits for every byte. */
 822         byte_delay_us = 10 * (1000000 / baudrate);
 823         start = g_get_monotonic_time();
 824
 825         i = ibuf = len = 0;
 826         while (ibuf < maxlen) {
 827                 len = serial_read(serial, &buf[ibuf], 1);
 828                 if (len > 0) {
 829                         ibuf += len;
 830                 } else if (len == 0) {
 831                         /* No logging, already done in serial_read(). */
 832                 } else {
 833                         /* Error reading byte, but continuing anyway. */
 834                 }
 835
 836                 time = g_get_monotonic_time() - start;
 837                 time /= 1000;
 838
 839                 if ((ibuf - i) >= packet_size) {
 840                         /* We have at least a packet's worth of data. */
 841                         if (is_valid(&buf[i])) {
 842                                 sr_spew("Found valid %d-byte packet after "
 843                                         "%" PRIu64 "ms.", (ibuf - i), time);
 844                                 *buflen = ibuf;
 845                                 return SR_OK;
 846                         } else {
 847                                 sr_spew("Got %d bytes, but not a valid "
 848                                         "packet.", (ibuf - i));
 849                         }
 850                         /* Not a valid packet. Continue searching. */
 851                         i++;
 852                 }
 853                 if (time >= timeout_ms) {
 854                         /* Timeout */
 855                         sr_dbg("Detection timed out after %dms.", time);
 856                         break;
 857                 }
 858                 g_usleep(byte_delay_us);
 859         }
 860
 861         *buflen = ibuf;
 862
 863         sr_err("Didn't find a valid packet (read %d bytes).", *buflen);
 864
 865         return SR_ERR;
 866 }