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                 /*
 283                  * Should be sr_err(), but that would yield lots of
 284                  * "Resource temporarily unavailable" messages.
 285                  */
 286                 sr_spew("Read error: %s (fd %d).", strerror(errno), serial->fd);
 287         else
 288                 sr_spew("Read %d/%d bytes (fd %d).", ret, count, serial->fd);
 289 #endif
 290
 291         return ret;
 292 }
 293
 294 /**
 295  * Set serial parameters for the specified serial port.
 296  *
 297  * @param serial Previously initialized serial port structure.
 298  * @param baudrate The baudrate to set.
 299  * @param bits The number of data bits to use.
 300  * @param parity The parity setting to use (0 = none, 1 = even, 2 = odd).
 301  * @param stopbits The number of stop bits to use (1 or 2).
 302  * @param flowcontrol The flow control settings to use (0 = none, 1 = RTS/CTS,
 303  *                    2 = XON/XOFF).
 304  *
 305  * @return SR_OK upon success, SR_ERR upon failure.
 306  */
 307 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
 308                               int bits, int parity, int stopbits,
 309                               int flowcontrol, int rts, int dtr)
 310 {
 311         if (!serial) {
 312                 sr_dbg("Invalid serial port.");
 313                 return SR_ERR;
 314         }
 315
 316         if (serial->fd == -1) {
 317                 sr_dbg("Cannot configure unopened serial port %s (fd %d).",
 318                        serial->port, serial->fd);
 319                 return SR_ERR;
 320         }
 321
 322         sr_spew("Setting serial parameters on port %s (fd %d).", serial->port,
 323                 serial->fd);
 324
 325 #ifdef _WIN32
 326         DCB dcb;
 327
 328         if (!GetCommState(hdl, &dcb))
 329                 return SR_ERR;
 330
 331         switch (baudrate) {
 332         case 115200:
 333                 dcb.BaudRate = CBR_115200;
 334                 break;
 335         case 57600:
 336                 dcb.BaudRate = CBR_57600;
 337                 break;
 338         case 38400:
 339                 dcb.BaudRate = CBR_38400;
 340                 break;
 341         case 19200:
 342                 dcb.BaudRate = CBR_19200;
 343                 break;
 344         case 9600:
 345                 dcb.BaudRate = CBR_9600;
 346                 break;
 347         case 4800:
 348                 dcb.BaudRate = CBR_4800;
 349                 break;
 350         case 2400:
 351                 dcb.BaudRate = CBR_2400;
 352                 break;
 353         default:
 354                 sr_err("Unsupported baudrate %d.", baudrate);
 355                 return SR_ERR;
 356         }
 357         dcb.ByteSize = bits;
 358         dcb.Parity = NOPARITY; /* TODO: Don't hardcode. */
 359         dcb.StopBits = ONESTOPBIT; /* TODO: Don't hardcode. */
 360
 361         if (rts != -1) {
 362                 sr_spew("Setting RTS %s.", rts ? "high" : "low");
 363                 if (rts)
 364                         dcb.fRtsControl = RTS_CONTROL_ENABLE;
 365                 else
 366                         dcb.fRtsControl = RTS_CONTROL_DISABLE;
 367         }
 368
 369         if (dtr != -1) {
 370                 sr_spew("Setting DTR %s.", dtr ? "high" : "low");
 371                 if (rts)
 372                         dcb.fDtrControl = DTR_CONTROL_ENABLE;
 373                 else
 374                         dcb.fDtrControl = DTR_CONTROL_DISABLE;
 375         }
 376
 377         if (!SetCommState(hdl, &dcb))
 378                 return SR_ERR;
 379 #else
 380         struct termios term;
 381         speed_t baud;
 382         int ret, controlbits;
 383
 384         if (tcgetattr(serial->fd, &term) < 0) {
 385                 sr_err("tcgetattr() error on port %s (fd %d): %s.",
 386                                 serial->port, serial->fd, strerror(errno));
 387                 return SR_ERR;
 388         }
 389
 390         switch (baudrate) {
 391         case 50:
 392                 baud = B50;
 393                 break;
 394         case 75:
 395                 baud = B75;
 396                 break;
 397         case 110:
 398                 baud = B110;
 399                 break;
 400         case 134:
 401                 baud = B134;
 402                 break;
 403         case 150:
 404                 baud = B150;
 405                 break;
 406         case 200:
 407                 baud = B200;
 408                 break;
 409         case 300:
 410                 baud = B300;
 411                 break;
 412         case 600:
 413                 baud = B600;
 414                 break;
 415         case 1200:
 416                 baud = B1200;
 417                 break;
 418         case 1800:
 419                 baud = B1800;
 420                 break;
 421         case 2400:
 422                 baud = B2400;
 423                 break;
 424         case 4800:
 425                 baud = B4800;
 426                 break;
 427         case 9600:
 428                 baud = B9600;
 429                 break;
 430         case 19200:
 431                 baud = B19200;
 432                 break;
 433         case 38400:
 434                 baud = B38400;
 435                 break;
 436         case 57600:
 437                 baud = B57600;
 438                 break;
 439         case 115200:
 440                 baud = B115200;
 441                 break;
 442         case 230400:
 443                 baud = B230400;
 444                 break;
 445 #ifndef __APPLE__
 446         case 460800:
 447                 baud = B460800;
 448                 break;
 449 #endif
 450         default:
 451                 sr_err("Unsupported baudrate %d.", baudrate);
 452                 return SR_ERR;
 453         }
 454
 455         sr_spew("Configuring output baudrate to %d (%d).", baudrate, baud);
 456         if (cfsetospeed(&term, baud) < 0) {
 457                 sr_err("cfsetospeed() error: %s.", strerror(errno));
 458                 return SR_ERR;
 459         }
 460
 461         sr_spew("Configuring input baudrate to %d (%d).", baudrate, baud);
 462         if (cfsetispeed(&term, baud) < 0) {
 463                 sr_err("cfsetispeed() error: %s.", strerror(errno));
 464                 return SR_ERR;
 465         }
 466
 467         sr_spew("Configuring %d data bits.", bits);
 468         term.c_cflag &= ~CSIZE;
 469         switch (bits) {
 470         case 8:
 471                 term.c_cflag |= CS8;
 472                 break;
 473         case 7:
 474                 term.c_cflag |= CS7;
 475                 break;
 476         default:
 477                 sr_err("Unsupported data bits number %d.", bits);
 478                 return SR_ERR;
 479         }
 480
 481         sr_spew("Configuring %d stop bits.", stopbits);
 482         term.c_cflag &= ~CSTOPB;
 483         switch (stopbits) {
 484         case 1:
 485                 term.c_cflag &= ~CSTOPB;
 486                 break;
 487         case 2:
 488                 term.c_cflag |= CSTOPB;
 489                 break;
 490         default:
 491                 sr_err("Unsupported stopbits number %d.", stopbits);
 492                 return SR_ERR;
 493         }
 494
 495         term.c_iflag &= ~(IXON | IXOFF);
 496         term.c_cflag &= ~CRTSCTS;
 497         switch (flowcontrol) {
 498         case 0:
 499                 /* No flow control. */
 500                 sr_spew("Configuring no flow control.");
 501                 break;
 502         case 1:
 503                 sr_spew("Configuring RTS/CTS flow control.");
 504                 term.c_cflag |= CRTSCTS;
 505                 break;
 506         case 2:
 507                 sr_spew("Configuring XON/XOFF flow control.");
 508                 term.c_iflag |= IXON | IXOFF;
 509                 break;
 510         default:
 511                 sr_err("Unsupported flow control setting %d.", flowcontrol);
 512                 return SR_ERR;
 513         }
 514
 515         term.c_iflag &= ~IGNPAR;
 516         term.c_cflag &= ~(PARODD | PARENB);
 517         switch (parity) {
 518         case SERIAL_PARITY_NONE:
 519                 sr_spew("Configuring no parity.");
 520                 term.c_iflag |= IGNPAR;
 521                 break;
 522         case SERIAL_PARITY_EVEN:
 523                 sr_spew("Configuring even parity.");
 524                 term.c_cflag |= PARENB;
 525                 break;
 526         case SERIAL_PARITY_ODD:
 527                 sr_spew("Configuring odd parity.");
 528                 term.c_cflag |= PARENB | PARODD;
 529                 break;
 530         default:
 531                 sr_err("Unsupported parity setting %d.", parity);
 532                 return SR_ERR;
 533         }
 534
 535         /* Do not translate carriage return to newline on input. */
 536         term.c_iflag &= ~(ICRNL);
 537
 538         /* Disable canonical mode, and don't echo input characters. */
 539         term.c_lflag &= ~(ICANON | ECHO);
 540
 541         /* Write the configured settings. */
 542         if (tcsetattr(serial->fd, TCSADRAIN, &term) < 0) {
 543                 sr_err("tcsetattr() error: %s.", strerror(errno));
 544                 return SR_ERR;
 545         }
 546
 547         if (rts != -1) {
 548                 sr_spew("Setting RTS %s.", rts ? "high" : "low");
 549                 controlbits = TIOCM_RTS;
 550                 if ((ret = ioctl(serial->fd, rts ? TIOCMBIS : TIOCMBIC,
 551                                 &controlbits)) < 0) {
 552                         sr_err("Error setting RTS: %s.", strerror(errno));
 553                         return SR_ERR;
 554                 }
 555         }
 556
 557         if (dtr != -1) {
 558                 sr_spew("Setting DTR %s.", dtr ? "high" : "low");
 559                 controlbits = TIOCM_DTR;
 560                 if ((ret = ioctl(serial->fd, dtr ? TIOCMBIS : TIOCMBIC,
 561                                 &controlbits)) < 0) {
 562                         sr_err("Error setting DTR: %s.", strerror(errno));
 563                         return SR_ERR;
 564                 }
 565         }
 566
 567 #endif
 568
 569         return SR_OK;
 570 }
 571
 572 /**
 573  * Set serial parameters for the specified serial port.
 574  *
 575  * @param serial Previously initialized serial port structure.
 576  * @param paramstr A serial communication parameters string, in the form
 577  * of <speed>/<data bits><parity><stopbits>, for example "9600/8n1" or
 578  * "600/7o2".
 579  *
 580  * @return SR_OK upon success, SR_ERR upon failure.
 581  */
 582 #define SERIAL_COMM_SPEC "^(\\d+)/([78])([neo])([12])(.*)$"
 583 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
 584                 const char *paramstr)
 585 {
 586         GRegex *reg;
 587         GMatchInfo *match;
 588         int speed, databits, parity, stopbits, rts, dtr, i;
 589         char *mstr, **opts, **kv;
 590
 591         speed = databits = parity = stopbits = 0;
 592         rts = dtr = -1;
 593         reg = g_regex_new(SERIAL_COMM_SPEC, 0, 0, NULL);
 594         if (g_regex_match(reg, paramstr, 0, &match)) {
 595                 if ((mstr = g_match_info_fetch(match, 1)))
 596                         speed = strtoul(mstr, NULL, 10);
 597                 g_free(mstr);
 598                 if ((mstr = g_match_info_fetch(match, 2)))
 599                         databits = strtoul(mstr, NULL, 10);
 600                 g_free(mstr);
 601                 if ((mstr = g_match_info_fetch(match, 3))) {
 602                         switch (mstr[0]) {
 603                         case 'n':
 604                                 parity = SERIAL_PARITY_NONE;
 605                                 break;
 606                         case 'e':
 607                                 parity = SERIAL_PARITY_EVEN;
 608                                 break;
 609                         case 'o':
 610                                 parity = SERIAL_PARITY_ODD;
 611                                 break;
 612                         }
 613                 }
 614                 g_free(mstr);
 615                 if ((mstr = g_match_info_fetch(match, 4)))
 616                         stopbits = strtoul(mstr, NULL, 10);
 617                 g_free(mstr);
 618                 if ((mstr = g_match_info_fetch(match, 5)) && mstr[0] != '\0') {
 619                         if (mstr[0] != '/') {
 620                                 sr_dbg("missing separator before extra options");
 621                                 speed = 0;
 622                         } else {
 623                                 /* A set of "key=value" options separated by / */
 624                                 opts = g_strsplit(mstr + 1, "/", 0);
 625                                 for (i = 0; opts[i]; i++) {
 626                                         kv = g_strsplit(opts[i], "=", 2);
 627                                         if (!strncmp(kv[0], "rts", 3)) {
 628                                                 if (kv[1][0] == '1')
 629                                                         rts = 1;
 630                                                 else if (kv[1][0] == '0')
 631                                                         rts = 0;
 632                                                 else {
 633                                                         sr_dbg("invalid value for rts: %c", kv[1][0]);
 634                                                         speed = 0;
 635                                                 }
 636                                         } else if (!strncmp(kv[0], "dtr", 3)) {
 637                                                 if (kv[1][0] == '1')
 638                                                         dtr = 1;
 639                                                 else if (kv[1][0] == '0')
 640                                                         dtr = 0;
 641                                                 else {
 642                                                         sr_dbg("invalid value for dtr: %c", kv[1][0]);
 643                                                         speed = 0;
 644                                                 }
 645                                         }
 646                                         g_strfreev(kv);
 647                                 }
 648                                 g_strfreev(opts);
 649                         }
 650                 }
 651                 g_free(mstr);
 652         }
 653         g_match_info_unref(match);
 654         g_regex_unref(reg);
 655
 656         if (speed)
 657                 return serial_set_params(serial, speed, databits, parity, stopbits,
 658                                 0, rts, dtr);
 659         else
 660                 return SR_ERR_ARG;
 661 }
 662
 663 /**
 664  * Read a line from the specified serial port.
 665  *
 666  * @param serial Previously initialized serial port structure.
 667  * @param buf Buffer where to store the bytes that are read.
 668  * @param buflen Size of the buffer.
 669  * @param timeout_ms How long to wait for a line to come in.
 670  *
 671  * Reading stops when CR of LR is found, which is stripped from the buffer.
 672  *
 673  * @return SR_OK on success, SR_ERR on failure.
 674  */
 675 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
 676                 int *buflen, gint64 timeout_ms)
 677 {
 678         gint64 start;
 679         int maxlen, len;
 680
 681         if (!serial || serial->fd == -1) {
 682                 sr_dbg("Invalid serial port.");
 683                 return SR_ERR;
 684         }
 685
 686         if (serial->fd == -1) {
 687                 sr_dbg("Cannot use unopened serial port %s (fd %d).",
 688                                 serial->port, serial->fd);
 689                 return -1;
 690         }
 691
 692         timeout_ms *= 1000;
 693         start = g_get_monotonic_time();
 694
 695         maxlen = *buflen;
 696         *buflen = len = 0;
 697         while(1) {
 698                 len = maxlen - *buflen - 1;
 699                 if (len < 1)
 700                         break;
 701                 len = serial_read(serial, *buf + *buflen, 1);
 702                 if (len > 0) {
 703                         *buflen += len;
 704                         *(*buf + *buflen) = '\0';
 705                         if (*buflen > 0 && (*(*buf + *buflen - 1) == '\r'
 706                                         || *(*buf + *buflen - 1) == '\n')) {
 707                                 /* Strip CR/LF and terminate. */
 708                                 *(*buf + --*buflen) = '\0';
 709                                 break;
 710                         }
 711                 }
 712                 if (g_get_monotonic_time() - start > timeout_ms)
 713                         /* Timeout */
 714                         break;
 715                 g_usleep(2000);
 716         }
 717         if (*buflen)
 718                 sr_dbg("Received %d: '%s'.", *buflen, *buf);
 719
 720         return SR_OK;
 721 }
 722
 723 /**
 724  * Try to find a valid packet in a serial data stream.
 725  *
 726  * @param serial Previously initialized serial port structure.
 727  * @param buf Buffer containing the bytes to write.
 728  * @param count Size of the buffer.
 729  * @param packet_size Size, in bytes, of a valid packet.
 730  * @param is_valid Callback that assesses whether the packet is valid or not.
 731  * @param timeout_ms The timeout after which, if no packet is detected, to
 732  *                   abort scanning.
 733  * @param baudrate The baudrate of the serial port. This parameter is not
 734  *                 critical, but it helps fine tune the serial port polling
 735  *                 delay.
 736  *
 737  * @return SR_OK if a valid packet is found within the given timeout,
 738  *         SR_ERR upon failure.
 739  */
 740 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
 741                                  uint8_t *buf, size_t *buflen,
 742                                  size_t packet_size, packet_valid_t is_valid,
 743                                  uint64_t timeout_ms, int baudrate)
 744 {
 745         uint64_t start, time, byte_delay_us;
 746         size_t ibuf, i, maxlen;
 747         int len;
 748
 749         maxlen = *buflen;
 750
 751         sr_dbg("Detecting packets on FD %d (timeout = %" PRIu64
 752                "ms, baudrate = %d).", serial->fd, timeout_ms, baudrate);
 753
 754         if (maxlen < (packet_size / 2) ) {
 755                 sr_err("Buffer size must be at least twice the packet size.");
 756                 return SR_ERR;
 757         }
 758
 759         /* Assume 8n1 transmission. That is 10 bits for every byte. */
 760         byte_delay_us = 10 * (1000000 / baudrate);
 761         start = g_get_monotonic_time();
 762
 763         i = ibuf = len = 0;
 764         while (ibuf < maxlen) {
 765                 len = serial_read(serial, &buf[ibuf], 1);
 766                 if (len > 0) {
 767                         ibuf += len;
 768                 } else if (len == 0) {
 769                         sr_spew("Error: Only read 0 bytes.");
 770                 } else {
 771                         /* Error reading byte, but continuing anyway. */
 772                 }
 773
 774                 time = g_get_monotonic_time() - start;
 775                 time /= 1000;
 776
 777                 if ((ibuf - i) >= packet_size) {
 778                         /* We have at least a packet's worth of data. */
 779                         if (is_valid(&buf[i])) {
 780                                 sr_spew("Found valid %d-byte packet after "
 781                                         "%" PRIu64 "ms.", (ibuf - i), time);
 782                                 *buflen = ibuf;
 783                                 return SR_OK;
 784                         } else {
 785                                 sr_spew("Got %d bytes, but not a valid "
 786                                         "packet.", (ibuf - i));
 787                         }
 788                         /* Not a valid packet. Continue searching. */
 789                         i++;
 790                 }
 791                 if (time >= timeout_ms) {
 792                         /* Timeout */
 793                         sr_dbg("Detection timed out after %dms.", time);
 794                         break;
 795                 }
 796                 g_usleep(byte_delay_us);
 797         }
 798
 799         *buflen = ibuf;
 800
 801         sr_err("Didn't find a valid packet (read %d bytes).", *buflen);
 802
 803         return SR_ERR;
 804 }