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