#else
#include <glob.h>
#include <termios.h>
+#include <sys/ioctl.h>
#endif
#include <stdlib.h>
#include <errno.h>
-#include <sys/ioctl.h>
#include <glib.h>
#include "libsigrok.h"
#include "libsigrok-internal.h"
* 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
+ if (ret >= 0)
sr_spew("Read %d/%d bytes (fd %d).", ret, count, serial->fd);
#endif
* @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 rts, int dtr)
+ int bits, int parity, int stopbits,
+ int flowcontrol, int rts, int dtr)
{
if (!serial) {
sr_dbg("Invalid serial port.");
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 (rts)
+ 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;
break;
#endif
default:
- sr_err("Unsupported baudrate %d.", baudrate);
+ sr_err("Unsupported baudrate: %d.", baudrate);
return SR_ERR;
}
speed = databits = parity = stopbits = 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)))
g_match_info_unref(match);
g_regex_unref(reg);
- if (speed)
- return serial_set_params(serial, speed, databits, parity, stopbits,
- 0, rts, dtr);
- else
+ if (speed) {
+ return serial_set_params(serial, speed, databits, parity,
+ stopbits, 0, rts, dtr);
+ } else {
+ sr_dbg("Could not infer speed from parameter string.");
return SR_ERR_ARG;
+ }
}
/**
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. */
}