hardware/common/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 <libserialport.h>
  26 #include "libsigrok.h"
  27 #include "libsigrok-internal.h"
  28
  29 /* Message logging helpers with subsystem-specific prefix string. */
  30 #define LOG_PREFIX "serial: "
  31 #define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
  32 #define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
  33 #define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
  34 #define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
  35 #define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
  36 #define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)
  37
  38 /**
  39  * Open the specified serial port.
  40  *
  41  * @param serial Previously initialized serial port structure.
  42  * @param flags Flags to use when opening the serial port. Possible flags
  43  *              include SERIAL_RDWR, SERIAL_RDONLY, SERIAL_NONBLOCK.
  44  *
  45  * If the serial structure contains a serialcomm string, it will be
  46  * passed to serial_set_paramstr() after the port is opened.
  47  *
  48  * @return SR_OK on success, SR_ERR on failure.
  49  */
  50 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags)
  51 {
  52         int ret;
  53         char *error;
  54         int sp_flags = 0;
  55
  56         if (!serial) {
  57                 sr_dbg("Invalid serial port.");
  58                 return SR_ERR;
  59         }
  60
  61         sr_spew("Opening serial port '%s' (flags %d).", serial->port, flags);
  62
  63         sp_get_port_by_name(serial->port, &serial->data);
  64
  65         if (flags & SERIAL_RDWR)
  66                 sp_flags = (SP_MODE_READ | SP_MODE_WRITE);
  67         else if (flags & SERIAL_RDONLY)
  68                 sp_flags = SP_MODE_READ;
  69
  70         serial->nonblocking = (flags & SERIAL_NONBLOCK) ? 1 : 0;
  71
  72         ret = sp_open(serial->data, sp_flags);
  73
  74         switch (ret) {
  75         case SP_ERR_ARG:
  76                 sr_err("Attempt to open serial port with invalid parameters.");
  77                 return SR_ERR_ARG;
  78         case SP_ERR_FAIL:
  79                 error = sp_last_error_message();
  80                 sr_err("Error opening port: %s.", error);
  81                 sp_free_error_message(error);
  82                 return SR_ERR;
  83         }
  84
  85 #ifndef _WIN32
  86         sp_get_port_handle(serial->data, &serial->fd);
  87 #endif
  88
  89         if (serial->serialcomm)
  90                 return serial_set_paramstr(serial, serial->serialcomm);
  91         else
  92                 return SR_OK;
  93 }
  94
  95 /**
  96  * Close the specified serial port.
  97  *
  98  * @param serial Previously initialized serial port structure.
  99  *
 100  * @return SR_OK on success, SR_ERR on failure.
 101  */
 102 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial)
 103 {
 104         int ret;
 105         char *error;
 106
 107         if (!serial) {
 108                 sr_dbg("Invalid serial port.");
 109                 return SR_ERR;
 110         }
 111
 112         if (serial->fd == -1) {
 113                 sr_dbg("Cannot close unopened serial port %s (fd %d).",
 114                                 serial->port, serial->fd);
 115                 return SR_ERR;
 116         }
 117
 118         sr_spew("Closing serial port %s (fd %d).", serial->port, serial->fd);
 119
 120         ret = sp_close(serial->data);
 121         sp_free_port(serial->data);
 122
 123         switch (ret) {
 124         case SP_ERR_ARG:
 125                 sr_err("Attempt to close an invalid serial port.");
 126                 return SR_ERR_ARG;
 127         case SP_ERR_FAIL:
 128                 error = sp_last_error_message();
 129                 sr_err("Error closing port: %s.", error);
 130                 sp_free_error_message(error);
 131                 return SR_ERR;
 132         }
 133
 134         serial->fd = -1;
 135
 136         return SR_OK;
 137 }
 138
 139 /**
 140  * Flush serial port buffers.
 141  *
 142  * @param serial Previously initialized serial port structure.
 143  *
 144  * @return SR_OK on success, SR_ERR on failure.
 145  */
 146 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial)
 147 {
 148         int ret;
 149         char *error;
 150
 151         if (!serial) {
 152                 sr_dbg("Invalid serial port.");
 153                 return SR_ERR;
 154         }
 155
 156         if (serial->fd == -1) {
 157                 sr_dbg("Cannot flush unopened serial port %s (fd %d).",
 158                                 serial->port, serial->fd);
 159                 return SR_ERR;
 160         }
 161
 162         sr_spew("Flushing serial port %s (fd %d).", serial->port, serial->fd);
 163
 164         ret = sp_flush(serial->data, SP_BUF_BOTH);
 165
 166         switch (ret) {
 167         case SP_ERR_ARG:
 168                 sr_err("Attempt to flush an invalid serial port.");
 169                 return SR_ERR_ARG;
 170         case SP_ERR_FAIL:
 171                 error = sp_last_error_message();
 172                 sr_err("Error flushing port: %s.", error);
 173                 sp_free_error_message(error);
 174                 return SR_ERR;
 175         }
 176
 177         return SR_OK;
 178 }
 179
 180 /**
 181  * Write a number of bytes to the specified serial port.
 182  *
 183  * @param serial Previously initialized serial port structure.
 184  * @param buf Buffer containing the bytes to write.
 185  * @param count Number of bytes to write.
 186  *
 187  * @return The number of bytes written, or a negative error code upon failure.
 188  */
 189 SR_PRIV int serial_write(struct sr_serial_dev_inst *serial,
 190                 const void *buf, size_t count)
 191 {
 192         ssize_t ret;
 193         char *error;
 194
 195         if (!serial) {
 196                 sr_dbg("Invalid serial port.");
 197                 return SR_ERR;
 198         }
 199
 200         if (serial->fd == -1) {
 201                 sr_dbg("Cannot use unopened serial port %s (fd %d).",
 202                                 serial->port, serial->fd);
 203                 return SR_ERR;
 204         }
 205
 206         if (serial->nonblocking)
 207                 ret = sp_nonblocking_write(serial->data, buf, count);
 208         else
 209                 ret = sp_blocking_write(serial->data, buf, count, 0);
 210
 211         switch (ret) {
 212         case SP_ERR_ARG:
 213                 sr_err("Attempted serial port write with invalid arguments.");
 214                 return SR_ERR_ARG;
 215         case SP_ERR_FAIL:
 216                 error = sp_last_error_message();
 217                 sr_err("Write error: %s.", error);
 218                 sp_free_error_message(error);
 219                 return SR_ERR;
 220         }
 221
 222         sr_spew("Wrote %d/%d bytes (fd %d).", ret, count, serial->fd);
 223
 224         return ret;
 225 }
 226
 227 /**
 228  * Read a number of bytes from the specified serial port.
 229  *
 230  * @param serial Previously initialized serial port structure.
 231  * @param buf Buffer where to store the bytes that are read.
 232  * @param count The number of bytes to read.
 233  *
 234  * @return The number of bytes read, or a negative error code upon failure.
 235  */
 236 SR_PRIV int serial_read(struct sr_serial_dev_inst *serial, void *buf,
 237                 size_t count)
 238 {
 239         ssize_t ret;
 240         char *error;
 241
 242         if (!serial) {
 243                 sr_dbg("Invalid serial port.");
 244                 return SR_ERR;
 245         }
 246
 247         if (serial->fd == -1) {
 248                 sr_dbg("Cannot use unopened serial port %s (fd %d).",
 249                                 serial->port, serial->fd);
 250                 return SR_ERR;
 251         }
 252
 253         if (serial->nonblocking)
 254                 ret = sp_nonblocking_read(serial->data, buf, count);
 255         else
 256                 ret = sp_blocking_read(serial->data, buf, count, 0);
 257
 258         switch (ret) {
 259         case SP_ERR_ARG:
 260                 sr_err("Attempted serial port read with invalid arguments.");
 261                 return SR_ERR_ARG;
 262         case SP_ERR_FAIL:
 263                 error = sp_last_error_message();
 264                 sr_err("Read error: %s.", error);
 265                 sp_free_error_message(error);
 266                 return SR_ERR;
 267         }
 268
 269         if (ret > 0)
 270                 sr_spew("Read %d/%d bytes (fd %d).", ret, count, serial->fd);
 271
 272         return ret;
 273 }
 274
 275 /**
 276  * Set serial parameters for the specified serial port.
 277  *
 278  * @param serial Previously initialized serial port structure.
 279  * @param baudrate The baudrate to set.
 280  * @param bits The number of data bits to use.
 281  * @param parity The parity setting to use (0 = none, 1 = even, 2 = odd).
 282  * @param stopbits The number of stop bits to use (1 or 2).
 283  * @param flowcontrol The flow control settings to use (0 = none, 1 = RTS/CTS,
 284  *                    2 = XON/XOFF).
 285  *
 286  * @return SR_OK upon success, SR_ERR upon failure.
 287  */
 288 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
 289                               int bits, int parity, int stopbits,
 290                               int flowcontrol, int rts, int dtr)
 291 {
 292         int ret;
 293         char *error;
 294         struct sp_port_config *config;
 295
 296         if (!serial) {
 297                 sr_dbg("Invalid serial port.");
 298                 return SR_ERR;
 299         }
 300
 301         if (serial->fd == -1) {
 302                 sr_dbg("Cannot configure unopened serial port %s (fd %d).",
 303                        serial->port, serial->fd);
 304                 return SR_ERR;
 305         }
 306
 307         sr_spew("Setting serial parameters on port %s (fd %d).", serial->port,
 308                 serial->fd);
 309
 310         sp_new_config(&config);
 311         sp_set_config_baudrate(config, baudrate);
 312         sp_set_config_bits(config, bits);
 313         switch (parity) {
 314         case 0:
 315                 sp_set_config_parity(config, SP_PARITY_NONE);
 316                 break;
 317         case 1:
 318                 sp_set_config_parity(config, SP_PARITY_EVEN);
 319                 break;
 320         case 2:
 321                 sp_set_config_parity(config, SP_PARITY_ODD);
 322                 break;
 323         default:
 324                 return SR_ERR_ARG;
 325         }
 326         sp_set_config_stopbits(config, stopbits);
 327         sp_set_config_rts(config, flowcontrol == 1 ? SP_RTS_FLOW_CONTROL : rts);
 328         sp_set_config_cts(config, flowcontrol == 1 ? SP_CTS_FLOW_CONTROL : SP_CTS_IGNORE);
 329         sp_set_config_dtr(config, dtr);
 330         sp_set_config_dsr(config, SP_DSR_IGNORE);
 331         sp_set_config_xon_xoff(config, flowcontrol == 2 ? SP_XONXOFF_INOUT : SP_XONXOFF_DISABLED);
 332
 333         ret = sp_set_config(serial->data, config);
 334         sp_free_config(config);
 335
 336         switch (ret) {
 337         case SP_ERR_ARG:
 338                 sr_err("Invalid arguments for setting serial port parameters.");
 339                 return SR_ERR_ARG;
 340         case SP_ERR_FAIL:
 341                 error = sp_last_error_message();
 342                 sr_err("Error setting serial port parameters: %s.", error);
 343                 sp_free_error_message(error);
 344                 return SR_ERR;
 345         }
 346
 347         return SR_OK;
 348 }
 349
 350 /**
 351  * Set serial parameters for the specified serial port.
 352  *
 353  * @param serial Previously initialized serial port structure.
 354  * @param paramstr A serial communication parameters string, in the form
 355  * of <speed>/<data bits><parity><stopbits><flow>, for example "9600/8n1" or
 356  * "600/7o2" or "460800/8n1/flow=2" where flow is 0 for none, 1 for rts/cts and 2 for xon/xoff.
 357  *
 358  * @return SR_OK upon success, SR_ERR upon failure.
 359  */
 360 #define SERIAL_COMM_SPEC "^(\\d+)/([5678])([neo])([12])(.*)$"
 361 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
 362                 const char *paramstr)
 363 {
 364         GRegex *reg;
 365         GMatchInfo *match;
 366         int speed, databits, parity, stopbits, flow, rts, dtr, i;
 367         char *mstr, **opts, **kv;
 368
 369         speed = databits = parity = stopbits = flow = 0;
 370         rts = dtr = -1;
 371         sr_spew("Parsing parameters from \"%s\".", paramstr);
 372         reg = g_regex_new(SERIAL_COMM_SPEC, 0, 0, NULL);
 373         if (g_regex_match(reg, paramstr, 0, &match)) {
 374                 if ((mstr = g_match_info_fetch(match, 1)))
 375                         speed = strtoul(mstr, NULL, 10);
 376                 g_free(mstr);
 377                 if ((mstr = g_match_info_fetch(match, 2)))
 378                         databits = strtoul(mstr, NULL, 10);
 379                 g_free(mstr);
 380                 if ((mstr = g_match_info_fetch(match, 3))) {
 381                         switch (mstr[0]) {
 382                         case 'n':
 383                                 parity = SERIAL_PARITY_NONE;
 384                                 break;
 385                         case 'e':
 386                                 parity = SERIAL_PARITY_EVEN;
 387                                 break;
 388                         case 'o':
 389                                 parity = SERIAL_PARITY_ODD;
 390                                 break;
 391                         }
 392                 }
 393                 g_free(mstr);
 394                 if ((mstr = g_match_info_fetch(match, 4)))
 395                         stopbits = strtoul(mstr, NULL, 10);
 396                 g_free(mstr);
 397                 if ((mstr = g_match_info_fetch(match, 5)) && mstr[0] != '\0') {
 398                         if (mstr[0] != '/') {
 399                                 sr_dbg("missing separator before extra options");
 400                                 speed = 0;
 401                         } else {
 402                                 /* A set of "key=value" options separated by / */
 403                                 opts = g_strsplit(mstr + 1, "/", 0);
 404                                 for (i = 0; opts[i]; i++) {
 405                                         kv = g_strsplit(opts[i], "=", 2);
 406                                         if (!strncmp(kv[0], "rts", 3)) {
 407                                                 if (kv[1][0] == '1')
 408                                                         rts = 1;
 409                                                 else if (kv[1][0] == '0')
 410                                                         rts = 0;
 411                                                 else {
 412                                                         sr_dbg("invalid value for rts: %c", kv[1][0]);
 413                                                         speed = 0;
 414                                                 }
 415                                         } else if (!strncmp(kv[0], "dtr", 3)) {
 416                                                 if (kv[1][0] == '1')
 417                                                         dtr = 1;
 418                                                 else if (kv[1][0] == '0')
 419                                                         dtr = 0;
 420                                                 else {
 421                                                         sr_dbg("invalid value for dtr: %c", kv[1][0]);
 422                                                         speed = 0;
 423                                                 }
 424                                         } else if (!strncmp(kv[0], "flow", 4)) {
 425                                                 if (kv[1][0] == '0')
 426                                                         flow = 0;
 427                                                 else if (kv[1][0] == '1')
 428                                                         flow = 1;
 429                                                 else if (kv[1][0] == '2')
 430                                                         flow = 2;
 431                                                 else {
 432                                                         sr_dbg("invalid value for flow: %c", kv[1][0]);
 433                                                         speed = 0;
 434                                                 }
 435                                         }
 436                                         g_strfreev(kv);
 437                                 }
 438                                 g_strfreev(opts);
 439                         }
 440                 }
 441                 g_free(mstr);
 442         }
 443         g_match_info_unref(match);
 444         g_regex_unref(reg);
 445
 446         if (speed) {
 447                 return serial_set_params(serial, speed, databits, parity,
 448                                          stopbits, flow, rts, dtr);
 449         } else {
 450                 sr_dbg("Could not infer speed from parameter string.");
 451                 return SR_ERR_ARG;
 452         }
 453 }
 454
 455 /**
 456  * Read a line from the specified serial port.
 457  *
 458  * @param serial Previously initialized serial port structure.
 459  * @param buf Buffer where to store the bytes that are read.
 460  * @param buflen Size of the buffer.
 461  * @param timeout_ms How long to wait for a line to come in.
 462  *
 463  * Reading stops when CR of LR is found, which is stripped from the buffer.
 464  *
 465  * @return SR_OK on success, SR_ERR on failure.
 466  */
 467 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
 468                 int *buflen, gint64 timeout_ms)
 469 {
 470         gint64 start;
 471         int maxlen, len;
 472
 473         if (!serial || serial->fd == -1) {
 474                 sr_dbg("Invalid serial port.");
 475                 return SR_ERR;
 476         }
 477
 478         if (serial->fd == -1) {
 479                 sr_dbg("Cannot use unopened serial port %s (fd %d).",
 480                                 serial->port, serial->fd);
 481                 return -1;
 482         }
 483
 484         timeout_ms *= 1000;
 485         start = g_get_monotonic_time();
 486
 487         maxlen = *buflen;
 488         *buflen = len = 0;
 489         while(1) {
 490                 len = maxlen - *buflen - 1;
 491                 if (len < 1)
 492                         break;
 493                 len = serial_read(serial, *buf + *buflen, 1);
 494                 if (len > 0) {
 495                         *buflen += len;
 496                         *(*buf + *buflen) = '\0';
 497                         if (*buflen > 0 && (*(*buf + *buflen - 1) == '\r'
 498                                         || *(*buf + *buflen - 1) == '\n')) {
 499                                 /* Strip CR/LF and terminate. */
 500                                 *(*buf + --*buflen) = '\0';
 501                                 break;
 502                         }
 503                 }
 504                 if (g_get_monotonic_time() - start > timeout_ms)
 505                         /* Timeout */
 506                         break;
 507                 if (len < 1)
 508                         g_usleep(2000);
 509         }
 510         if (*buflen)
 511                 sr_dbg("Received %d: '%s'.", *buflen, *buf);
 512
 513         return SR_OK;
 514 }
 515
 516 /**
 517  * Try to find a valid packet in a serial data stream.
 518  *
 519  * @param serial Previously initialized serial port structure.
 520  * @param buf Buffer containing the bytes to write.
 521  * @param count Size of the buffer.
 522  * @param packet_size Size, in bytes, of a valid packet.
 523  * @param is_valid Callback that assesses whether the packet is valid or not.
 524  * @param timeout_ms The timeout after which, if no packet is detected, to
 525  *                   abort scanning.
 526  * @param baudrate The baudrate of the serial port. This parameter is not
 527  *                 critical, but it helps fine tune the serial port polling
 528  *                 delay.
 529  *
 530  * @return SR_OK if a valid packet is found within the given timeout,
 531  *         SR_ERR upon failure.
 532  */
 533 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
 534                                  uint8_t *buf, size_t *buflen,
 535                                  size_t packet_size, packet_valid_t is_valid,
 536                                  uint64_t timeout_ms, int baudrate)
 537 {
 538         uint64_t start, time, byte_delay_us;
 539         size_t ibuf, i, maxlen;
 540         int len;
 541
 542         maxlen = *buflen;
 543
 544         sr_dbg("Detecting packets on FD %d (timeout = %" PRIu64
 545                "ms, baudrate = %d).", serial->fd, timeout_ms, baudrate);
 546
 547         if (maxlen < (packet_size / 2) ) {
 548                 sr_err("Buffer size must be at least twice the packet size.");
 549                 return SR_ERR;
 550         }
 551
 552         /* Assume 8n1 transmission. That is 10 bits for every byte. */
 553         byte_delay_us = 10 * (1000000 / baudrate);
 554         start = g_get_monotonic_time();
 555
 556         i = ibuf = len = 0;
 557         while (ibuf < maxlen) {
 558                 len = serial_read(serial, &buf[ibuf], 1);
 559                 if (len > 0) {
 560                         ibuf += len;
 561                 } else if (len == 0) {
 562                         /* No logging, already done in serial_read(). */
 563                 } else {
 564                         /* Error reading byte, but continuing anyway. */
 565                 }
 566
 567                 time = g_get_monotonic_time() - start;
 568                 time /= 1000;
 569
 570                 if ((ibuf - i) >= packet_size) {
 571                         /* We have at least a packet's worth of data. */
 572                         if (is_valid(&buf[i])) {
 573                                 sr_spew("Found valid %d-byte packet after "
 574                                         "%" PRIu64 "ms.", (ibuf - i), time);
 575                                 *buflen = ibuf;
 576                                 return SR_OK;
 577                         } else {
 578                                 sr_spew("Got %d bytes, but not a valid "
 579                                         "packet.", (ibuf - i));
 580                         }
 581                         /* Not a valid packet. Continue searching. */
 582                         i++;
 583                 }
 584                 if (time >= timeout_ms) {
 585                         /* Timeout */
 586                         sr_dbg("Detection timed out after %dms.", time);
 587                         break;
 588                 }
 589                 if (len < 1)
 590                         g_usleep(byte_delay_us);
 591         }
 592
 593         *buflen = ibuf;
 594
 595         sr_err("Didn't find a valid packet (read %d bytes).", *buflen);
 596
 597         return SR_ERR;
 598 }
 599
 600 /**
 601  * Extract the serial device and options from the options linked list.
 602  *
 603  * @param options List of options passed from the command line.
 604  * @param serial_device Pointer where to store the exctracted serial device.
 605  * @param serial_options Pointer where to store the optional extracted serial
 606  * options.
 607  *
 608  * @return SR_OK if a serial_device is found, SR_ERR if no device is found. The
 609  * returned string should not be freed by the caller.
 610  */
 611 SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
 612                                       const char **serial_options)
 613 {
 614         GSList *l;
 615         struct sr_config *src;
 616
 617         *serial_device = NULL;
 618
 619         for (l = options; l; l = l->next) {
 620                 src = l->data;
 621                 switch (src->key) {
 622                 case SR_CONF_CONN:
 623                         *serial_device = g_variant_get_string(src->data, NULL);
 624                         sr_dbg("Parsed serial device: %s", *serial_device);
 625                         break;
 626
 627                 case SR_CONF_SERIALCOMM:
 628                         *serial_options = g_variant_get_string(src->data, NULL);
 629                         sr_dbg("Parsed serial options: %s", *serial_options);
 630                         break;
 631                 }
 632         }
 633
 634         if (!*serial_device) {
 635                 sr_dbg("No serial device specified");
 636                 return SR_ERR;
 637         }
 638
 639         return SR_OK;
 640 }