/*
- * This file is part of the sigrok project.
+ * This file is part of the libsigrok project.
*
* Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
* Copyright (C) 2010-2012 Uwe Hermann <uwe@hermann-uwe.de>
#ifdef _WIN32
#include <windows.h>
#else
-#include <glob.h>
#include <termios.h>
+#include <sys/ioctl.h>
#endif
#include <stdlib.h>
#include <errno.h>
#include "libsigrok.h"
#include "libsigrok-internal.h"
-/* Message logging helpers with driver-specific prefix string. */
-#define DRIVER_LOG_DOMAIN "serial: "
-#define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args)
-#define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args)
-#define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args)
-#define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args)
-#define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args)
-#define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args)
+/* Message logging helpers with subsystem-specific prefix string. */
+#define LOG_PREFIX "serial: "
+#define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
+#define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
+#define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
+#define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
+#define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
+#define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)
// FIXME: Must be moved, or rather passed as function argument.
#ifdef _WIN32
* Open the specified serial port.
*
* @param serial Previously initialized serial port structure.
- * @param flags Flags to use when opening the serial port.
- * TODO: Abstract 'flags', currently they're OS-specific!
+ * @param flags Flags to use when opening the serial port. Possible flags
+ * include SERIAL_RDWR, SERIAL_RDONLY, SERIAL_NONBLOCK.
*
* If the serial structure contains a serialcomm string, it will be
* passed to serial_set_paramstr() after the port is opened.
*/
SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags)
{
+ int flags_local = 0;
+#ifdef _WIN32
+ DWORD desired_access = 0, flags_and_attributes = 0;
+#endif
if (!serial) {
sr_dbg("Invalid serial port.");
sr_spew("Opening serial port '%s' (flags %d).", serial->port, flags);
#ifdef _WIN32
- hdl = CreateFile(serial->port, GENERIC_READ | GENERIC_WRITE, 0, 0,
- OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, 0);
+ /* Map 'flags' to the OS-specific settings. */
+ desired_access |= GENERIC_READ;
+ flags_and_attributes = FILE_ATTRIBUTE_NORMAL;
+ if (flags & SERIAL_RDWR)
+ desired_access |= GENERIC_WRITE;
+ if (flags & SERIAL_NONBLOCK)
+ flags_and_attributes |= FILE_FLAG_OVERLAPPED;
+
+ hdl = CreateFile(serial->port, desired_access, 0, 0,
+ OPEN_EXISTING, flags_and_attributes, 0);
if (hdl == INVALID_HANDLE_VALUE) {
sr_err("Error opening serial port '%s'.", serial->port);
return SR_ERR;
}
#else
- if ((serial->fd = open(serial->port, flags)) < 0) {
+ /* Map 'flags' to the OS-specific settings. */
+ if (flags & SERIAL_RDWR)
+ flags_local |= O_RDWR;
+ if (flags & SERIAL_RDONLY)
+ flags_local |= O_RDONLY;
+ if (flags & SERIAL_NONBLOCK)
+ flags_local |= O_NONBLOCK;
+
+ if ((serial->fd = open(serial->port, flags_local)) < 0) {
sr_err("Error opening serial port '%s': %s.", serial->port,
strerror(errno));
return SR_ERR;
- } else
- sr_spew("Opened serial port '%s' (fd %d).", serial->port, serial->fd);
+ }
+
+ sr_spew("Opened serial port '%s' (fd %d).", serial->port, serial->fd);
#endif
if (serial->serialcomm)
#else
/* Returns the number of bytes read, or -1 upon failure. */
ret = read(serial->fd, buf, count);
- if (ret < 0)
- /*
- * Should be sr_err(), but that would yield lots of
- * "Resource temporarily unavailable" messages.
- */
- sr_spew("Read error: %s (fd %d).", strerror(errno), serial->fd);
- else
- sr_spew("Read %d/%d bytes (fd %d).", ret, count, serial->fd);
#endif
return ret;
* @return SR_OK upon success, SR_ERR upon failure.
*/
SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
- int bits, int parity, int stopbits, int flowcontrol)
+ int bits, int parity, int stopbits,
+ int flowcontrol, int rts, int dtr)
{
-
if (!serial) {
sr_dbg("Invalid serial port.");
return SR_ERR;
if (serial->fd == -1) {
sr_dbg("Cannot configure unopened serial port %s (fd %d).",
- serial->port, serial->fd);
+ serial->port, serial->fd);
return SR_ERR;
}
sr_spew("Setting serial parameters on port %s (fd %d).", serial->port,
- serial->fd);
+ serial->fd);
#ifdef _WIN32
DCB dcb;
- if (!GetCommState(hdl, &dcb))
+ if (!GetCommState(hdl, &dcb)) {
+ sr_err("Failed to get comm state on port %s (fd %d): %d.",
+ serial->port, serial->fd, GetLastError());
return SR_ERR;
+ }
switch (baudrate) {
- case 115200:
- dcb.BaudRate = CBR_115200;
+ /*
+ * The baudrates 50/75/134/150/200/1800/230400/460800 do not seem to
+ * have documented CBR_* macros.
+ */
+ case 110:
+ dcb.BaudRate = CBR_110;
break;
- case 57600:
- dcb.BaudRate = CBR_57600;
+ case 300:
+ dcb.BaudRate = CBR_300;
break;
- case 38400:
- dcb.BaudRate = CBR_38400;
+ case 600:
+ dcb.BaudRate = CBR_600;
break;
- case 19200:
- dcb.BaudRate = CBR_19200;
+ case 1200:
+ dcb.BaudRate = CBR_1200;
break;
- case 9600:
- dcb.BaudRate = CBR_9600;
+ case 2400:
+ dcb.BaudRate = CBR_2400;
break;
case 4800:
dcb.BaudRate = CBR_4800;
break;
- case 2400:
- dcb.BaudRate = CBR_2400;
+ case 9600:
+ dcb.BaudRate = CBR_9600;
+ break;
+ case 14400:
+ dcb.BaudRate = CBR_14400; /* Not available on Unix? */
+ break;
+ case 19200:
+ dcb.BaudRate = CBR_19200;
+ break;
+ case 38400:
+ dcb.BaudRate = CBR_38400;
+ break;
+ case 57600:
+ dcb.BaudRate = CBR_57600;
+ break;
+ case 115200:
+ dcb.BaudRate = CBR_115200;
+ break;
+ case 128000:
+ dcb.BaudRate = CBR_128000; /* Not available on Unix? */
+ break;
+ case 256000:
+ dcb.BaudRate = CBR_256000; /* Not available on Unix? */
break;
default:
- sr_err("Unsupported baudrate %d.", baudrate);
+ sr_err("Unsupported baudrate: %d.", baudrate);
return SR_ERR;
}
+ sr_spew("Configuring baudrate to %d (%d).", baudrate, dcb.BaudRate);
+
+ sr_spew("Configuring %d data bits.", bits);
dcb.ByteSize = bits;
- dcb.Parity = NOPARITY; /* TODO: Don't hardcode. */
- dcb.StopBits = ONESTOPBIT; /* TODO: Don't hardcode. */
- if (!SetCommState(hdl, &dcb))
+ sr_spew("Configuring %d stop bits.", stopbits);
+ switch (stopbits) {
+ /* Note: There's also ONE5STOPBITS == 1.5 (unneeded so far). */
+ case 1:
+ dcb.StopBits = ONESTOPBIT;
+ break;
+ case 2:
+ dcb.StopBits = TWOSTOPBITS;
+ break;
+ default:
+ sr_err("Unsupported stopbits number: %d.", stopbits);
+ return SR_ERR;
+ }
+
+ switch (parity) {
+ /* Note: There's also SPACEPARITY, MARKPARITY (unneeded so far). */
+ case SERIAL_PARITY_NONE:
+ sr_spew("Configuring no parity.");
+ dcb.Parity = NOPARITY;
+ break;
+ case SERIAL_PARITY_EVEN:
+ sr_spew("Configuring even parity.");
+ dcb.Parity = EVENPARITY;
+ break;
+ case SERIAL_PARITY_ODD:
+ sr_spew("Configuring odd parity.");
+ dcb.Parity = ODDPARITY;
+ break;
+ default:
+ sr_err("Unsupported parity setting: %d.", parity);
+ return SR_ERR;
+ }
+
+ if (rts != -1) {
+ sr_spew("Setting RTS %s.", rts ? "high" : "low");
+ if (rts)
+ dcb.fRtsControl = RTS_CONTROL_ENABLE;
+ else
+ dcb.fRtsControl = RTS_CONTROL_DISABLE;
+ }
+
+ if (dtr != -1) {
+ sr_spew("Setting DTR %s.", dtr ? "high" : "low");
+ if (dtr)
+ dcb.fDtrControl = DTR_CONTROL_ENABLE;
+ else
+ dcb.fDtrControl = DTR_CONTROL_DISABLE;
+ }
+
+ if (!SetCommState(hdl, &dcb)) {
+ sr_err("Failed to set comm state on port %s (fd %d): %d.",
+ serial->port, serial->fd, GetLastError());
return SR_ERR;
+ }
#else
struct termios term;
speed_t baud;
+ int ret, controlbits;
if (tcgetattr(serial->fd, &term) < 0) {
sr_err("tcgetattr() error on port %s (fd %d): %s.",
case 230400:
baud = B230400;
break;
-#ifndef __APPLE__
+#if !defined(__APPLE__) && !defined(__OpenBSD__)
case 460800:
baud = B460800;
break;
#endif
default:
- sr_err("Unsupported baudrate %d.", baudrate);
+ sr_err("Unsupported baudrate: %d.", baudrate);
return SR_ERR;
}
return SR_ERR;
}
- term.c_iflag &= ~(IXON | IXOFF);
+ term.c_iflag &= ~(IXON | IXOFF | IXANY);
term.c_cflag &= ~CRTSCTS;
switch (flowcontrol) {
case 0:
break;
case 2:
sr_spew("Configuring XON/XOFF flow control.");
- term.c_iflag |= IXON | IXOFF;
+ term.c_iflag |= (IXON | IXOFF | IXANY);
break;
default:
sr_err("Unsupported flow control setting %d.", flowcontrol);
}
term.c_iflag &= ~IGNPAR;
- term.c_cflag &= ~(PARODD | PARENB);
+ term.c_cflag &= ~(PARENB | PARODD);
switch (parity) {
case SERIAL_PARITY_NONE:
sr_spew("Configuring no parity.");
return SR_ERR;
}
- /* Do not translate carriage return to newline on input. */
- term.c_iflag &= ~(ICRNL);
+ /* Turn off all serial port cooking. */
+ term.c_iflag &= ~(ISTRIP | INLCR | ICRNL);
+ term.c_oflag &= ~(ONLCR | OCRNL | ONOCR);
+#if !defined(__FreeBSD__) && !defined(__OpenBSD__) && !defined(__NetBSD__)
+ term.c_oflag &= ~OFILL;
+#endif
/* Disable canonical mode, and don't echo input characters. */
term.c_lflag &= ~(ICANON | ECHO);
+ /* Ignore modem status lines; enable receiver */
+ term.c_cflag |= (CLOCAL | CREAD);
+
/* Write the configured settings. */
if (tcsetattr(serial->fd, TCSADRAIN, &term) < 0) {
sr_err("tcsetattr() error: %s.", strerror(errno));
return SR_ERR;
}
+
+ if (rts != -1) {
+ sr_spew("Setting RTS %s.", rts ? "high" : "low");
+ controlbits = TIOCM_RTS;
+ if ((ret = ioctl(serial->fd, rts ? TIOCMBIS : TIOCMBIC,
+ &controlbits)) < 0) {
+ sr_err("Error setting RTS: %s.", strerror(errno));
+ return SR_ERR;
+ }
+ }
+
+ if (dtr != -1) {
+ sr_spew("Setting DTR %s.", dtr ? "high" : "low");
+ controlbits = TIOCM_DTR;
+ if ((ret = ioctl(serial->fd, dtr ? TIOCMBIS : TIOCMBIC,
+ &controlbits)) < 0) {
+ sr_err("Error setting DTR: %s.", strerror(errno));
+ return SR_ERR;
+ }
+ }
+
#endif
return SR_OK;
*
* @param serial Previously initialized serial port structure.
* @param paramstr A serial communication parameters string, in the form
- * of <speed>/<data bits><parity><stopbits>, for example "9600/8n1" or
- * "600/7o2".
+ * of <speed>/<data bits><parity><stopbits><flow>, for example "9600/8n1" or
+ * "600/7o2" or "460800/8n1/flow=2" where flow is 0 for none, 1 for rts/cts and 2 for xon/xoff.
*
* @return SR_OK upon success, SR_ERR upon failure.
*/
-#define SERIAL_COMM_SPEC "^(\\d+)/([78])([neo])([12])$"
+#define SERIAL_COMM_SPEC "^(\\d+)/([78])([neo])([12])(.*)$"
SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
const char *paramstr)
{
GRegex *reg;
GMatchInfo *match;
- int speed, databits, parity, stopbits;
- char *mstr;
+ int speed, databits, parity, stopbits, flow, rts, dtr, i;
+ char *mstr, **opts, **kv;
- speed = databits = parity = stopbits = 0;
+ speed = databits = parity = stopbits = flow = 0;
+ rts = dtr = -1;
+ sr_spew("Parsing parameters from \"%s\".", paramstr);
reg = g_regex_new(SERIAL_COMM_SPEC, 0, 0, NULL);
if (g_regex_match(reg, paramstr, 0, &match)) {
if ((mstr = g_match_info_fetch(match, 1)))
if ((mstr = g_match_info_fetch(match, 4)))
stopbits = strtoul(mstr, NULL, 10);
g_free(mstr);
+ if ((mstr = g_match_info_fetch(match, 5)) && mstr[0] != '\0') {
+ if (mstr[0] != '/') {
+ sr_dbg("missing separator before extra options");
+ speed = 0;
+ } else {
+ /* A set of "key=value" options separated by / */
+ opts = g_strsplit(mstr + 1, "/", 0);
+ for (i = 0; opts[i]; i++) {
+ kv = g_strsplit(opts[i], "=", 2);
+ if (!strncmp(kv[0], "rts", 3)) {
+ if (kv[1][0] == '1')
+ rts = 1;
+ else if (kv[1][0] == '0')
+ rts = 0;
+ else {
+ sr_dbg("invalid value for rts: %c", kv[1][0]);
+ speed = 0;
+ }
+ } else if (!strncmp(kv[0], "dtr", 3)) {
+ if (kv[1][0] == '1')
+ dtr = 1;
+ else if (kv[1][0] == '0')
+ dtr = 0;
+ else {
+ sr_dbg("invalid value for dtr: %c", kv[1][0]);
+ speed = 0;
+ }
+ } else if (!strncmp(kv[0], "flow", 4)) {
+ if (kv[1][0] == '0')
+ flow = 0;
+ else if (kv[1][0] == '1')
+ flow = 1;
+ else if (kv[1][0] == '2')
+ flow = 2;
+ else {
+ sr_dbg("invalid value for flow: %c", kv[1][0]);
+ speed = 0;
+ }
+ }
+ g_strfreev(kv);
+ }
+ g_strfreev(opts);
+ }
+ }
+ g_free(mstr);
}
g_match_info_unref(match);
g_regex_unref(reg);
- if (speed)
- return serial_set_params(serial, speed, databits, parity, stopbits, 0);
- else
+ if (speed) {
+ return serial_set_params(serial, speed, databits, parity,
+ stopbits, flow, rts, dtr);
+ } else {
+ sr_dbg("Could not infer speed from parameter string.");
return SR_ERR_ARG;
+ }
}
/**
if (g_get_monotonic_time() - start > timeout_ms)
/* Timeout */
break;
- g_usleep(2000);
+ if (len < 1)
+ g_usleep(2000);
}
if (*buflen)
sr_dbg("Received %d: '%s'.", *buflen, *buf);
return SR_ERR;
}
- timeout_ms *= 1000;
-
/* Assume 8n1 transmission. That is 10 bits for every byte. */
byte_delay_us = 10 * (1000000 / baudrate);
start = g_get_monotonic_time();
if (len > 0) {
ibuf += len;
} else if (len == 0) {
- sr_spew("Error: Only read 0 bytes.");
+ /* No logging, already done in serial_read(). */
} else {
/* Error reading byte, but continuing anyway. */
}
+
+ time = g_get_monotonic_time() - start;
+ time /= 1000;
+
if ((ibuf - i) >= packet_size) {
/* We have at least a packet's worth of data. */
if (is_valid(&buf[i])) {
- time = g_get_monotonic_time() - start;
- time /= 1000;
sr_spew("Found valid %d-byte packet after "
"%" PRIu64 "ms.", (ibuf - i), time);
*buflen = ibuf;
/* Not a valid packet. Continue searching. */
i++;
}
- if (g_get_monotonic_time() - start > timeout_ms) {
+ if (time >= timeout_ms) {
/* Timeout */
- sr_dbg("Detection timed out after %dms.", timeout_ms);
+ sr_dbg("Detection timed out after %dms.", time);
break;
}
- g_usleep(byte_delay_us);
+ if (len < 1)
+ g_usleep(byte_delay_us);
}
*buflen = ibuf;
projects / libsigrok.git / blobdiff