2 * This file is part of the sigrok project.
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>
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.
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.
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/>.
23 #include <sys/types.h>
32 #include <sys/ioctl.h>
37 #include "libsigrok.h"
38 #include "libsigrok-internal.h"
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)
49 // FIXME: Must be moved, or rather passed as function argument.
55 * Open the specified serial port.
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.
61 * If the serial structure contains a serialcomm string, it will be
62 * passed to serial_set_paramstr() after the port is opened.
64 * @return SR_OK on success, SR_ERR on failure.
66 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags)
70 DWORD desired_access = 0, flags_and_attributes = 0;
74 sr_dbg("Invalid serial port.");
78 sr_spew("Opening serial port '%s' (flags %d).", serial->port, flags);
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;
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);
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;
104 if ((serial->fd = open(serial->port, flags_local)) < 0) {
105 sr_err("Error opening serial port '%s': %s.", serial->port,
110 sr_spew("Opened serial port '%s' (fd %d).", serial->port, serial->fd);
113 if (serial->serialcomm)
114 return serial_set_paramstr(serial, serial->serialcomm);
120 * Close the specified serial port.
122 * @param serial Previously initialized serial port structure.
124 * @return SR_OK on success, SR_ERR on failure.
126 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial)
131 sr_dbg("Invalid serial port.");
135 if (serial->fd == -1) {
136 sr_dbg("Cannot close unopened serial port %s (fd %d).",
137 serial->port, serial->fd);
141 sr_spew("Closing serial port %s (fd %d).", serial->port, serial->fd);
145 /* Returns non-zero upon success, 0 upon failure. */
146 if (CloseHandle(hdl) == 0)
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),
163 * Flush serial port buffers.
165 * @param serial Previously initialized serial port structure.
167 * @return SR_OK on success, SR_ERR on failure.
169 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial)
174 sr_dbg("Invalid serial port.");
178 if (serial->fd == -1) {
179 sr_dbg("Cannot flush unopened serial port %s (fd %d).",
180 serial->port, serial->fd);
184 sr_spew("Flushing serial port %s (fd %d).", serial->port, serial->fd);
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));
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));
205 * Write a number of bytes to the specified serial port.
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.
211 * @return The number of bytes written, or -1 upon failure.
213 SR_PRIV int serial_write(struct sr_serial_dev_inst *serial,
214 const void *buf, size_t count)
219 sr_dbg("Invalid serial port.");
223 if (serial->fd == -1) {
224 sr_dbg("Cannot use unopened serial port %s (fd %d).",
225 serial->port, serial->fd);
233 /* Returns non-zero upon success, 0 upon failure. */
234 WriteFile(hdl, buf, count, &tmp, NULL);
236 /* Returns the number of bytes written, or -1 upon failure. */
237 ret = write(serial->fd, buf, count);
239 sr_err("Write error: %s.", strerror(errno));
241 sr_spew("Wrote %d/%d bytes (fd %d).", ret, count, serial->fd);
248 * Read a number of bytes from the specified serial port.
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.
254 * @return The number of bytes read, or -1 upon failure.
256 SR_PRIV int serial_read(struct sr_serial_dev_inst *serial, void *buf,
262 sr_dbg("Invalid serial port.");
266 if (serial->fd == -1) {
267 sr_dbg("Cannot use unopened serial port %s (fd %d).",
268 serial->port, serial->fd);
276 /* Returns non-zero upon success, 0 upon failure. */
277 return ReadFile(hdl, buf, count, &tmp, NULL);
279 /* Returns the number of bytes read, or -1 upon failure. */
280 ret = read(serial->fd, buf, count);
283 * Should be sr_err(), but that would yield lots of
284 * "Resource temporarily unavailable" messages.
286 sr_spew("Read error: %s (fd %d).", strerror(errno), serial->fd);
288 sr_spew("Read %d/%d bytes (fd %d).", ret, count, serial->fd);
295 * Set serial parameters for the specified serial port.
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,
305 * @return SR_OK upon success, SR_ERR upon failure.
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)
312 sr_dbg("Invalid serial port.");
316 if (serial->fd == -1) {
317 sr_dbg("Cannot configure unopened serial port %s (fd %d).",
318 serial->port, serial->fd);
322 sr_spew("Setting serial parameters on port %s (fd %d).", serial->port,
328 if (!GetCommState(hdl, &dcb))
333 * The baudrates 50/75/134/150/200/1800/230400/460800 do not seem to
334 * have documented CBR_* macros.
337 dcb.BaudRate = CBR_110;
340 dcb.BaudRate = CBR_300;
343 dcb.BaudRate = CBR_600;
346 dcb.BaudRate = CBR_1200;
349 dcb.BaudRate = CBR_2400;
352 dcb.BaudRate = CBR_4800;
355 dcb.BaudRate = CBR_9600;
358 dcb.BaudRate = CBR_14400; /* Not available on Unix? */
361 dcb.BaudRate = CBR_19200;
364 dcb.BaudRate = CBR_38400;
367 dcb.BaudRate = CBR_57600;
370 dcb.BaudRate = CBR_115200;
373 dcb.BaudRate = CBR_128000; /* Not available on Unix? */
376 dcb.BaudRate = CBR_256000; /* Not available on Unix? */
379 sr_err("Unsupported baudrate: %d.", baudrate);
382 sr_spew("Configuring baudrate to %d (%d).", baudrate, dcb.BaudRate);
385 dcb.Parity = NOPARITY; /* TODO: Don't hardcode. */
386 dcb.StopBits = ONESTOPBIT; /* TODO: Don't hardcode. */
389 sr_spew("Setting RTS %s.", rts ? "high" : "low");
391 dcb.fRtsControl = RTS_CONTROL_ENABLE;
393 dcb.fRtsControl = RTS_CONTROL_DISABLE;
397 sr_spew("Setting DTR %s.", dtr ? "high" : "low");
399 dcb.fDtrControl = DTR_CONTROL_ENABLE;
401 dcb.fDtrControl = DTR_CONTROL_DISABLE;
404 if (!SetCommState(hdl, &dcb))
409 int ret, controlbits;
411 if (tcgetattr(serial->fd, &term) < 0) {
412 sr_err("tcgetattr() error on port %s (fd %d): %s.",
413 serial->port, serial->fd, strerror(errno));
478 sr_err("Unsupported baudrate: %d.", baudrate);
482 sr_spew("Configuring output baudrate to %d (%d).", baudrate, baud);
483 if (cfsetospeed(&term, baud) < 0) {
484 sr_err("cfsetospeed() error: %s.", strerror(errno));
488 sr_spew("Configuring input baudrate to %d (%d).", baudrate, baud);
489 if (cfsetispeed(&term, baud) < 0) {
490 sr_err("cfsetispeed() error: %s.", strerror(errno));
494 sr_spew("Configuring %d data bits.", bits);
495 term.c_cflag &= ~CSIZE;
504 sr_err("Unsupported data bits number %d.", bits);
508 sr_spew("Configuring %d stop bits.", stopbits);
509 term.c_cflag &= ~CSTOPB;
512 term.c_cflag &= ~CSTOPB;
515 term.c_cflag |= CSTOPB;
518 sr_err("Unsupported stopbits number %d.", stopbits);
522 term.c_iflag &= ~(IXON | IXOFF);
523 term.c_cflag &= ~CRTSCTS;
524 switch (flowcontrol) {
526 /* No flow control. */
527 sr_spew("Configuring no flow control.");
530 sr_spew("Configuring RTS/CTS flow control.");
531 term.c_cflag |= CRTSCTS;
534 sr_spew("Configuring XON/XOFF flow control.");
535 term.c_iflag |= IXON | IXOFF;
538 sr_err("Unsupported flow control setting %d.", flowcontrol);
542 term.c_iflag &= ~IGNPAR;
543 term.c_cflag &= ~(PARODD | PARENB);
545 case SERIAL_PARITY_NONE:
546 sr_spew("Configuring no parity.");
547 term.c_iflag |= IGNPAR;
549 case SERIAL_PARITY_EVEN:
550 sr_spew("Configuring even parity.");
551 term.c_cflag |= PARENB;
553 case SERIAL_PARITY_ODD:
554 sr_spew("Configuring odd parity.");
555 term.c_cflag |= PARENB | PARODD;
558 sr_err("Unsupported parity setting %d.", parity);
562 /* Do not translate carriage return to newline on input. */
563 term.c_iflag &= ~(ICRNL);
565 /* Disable canonical mode, and don't echo input characters. */
566 term.c_lflag &= ~(ICANON | ECHO);
568 /* Write the configured settings. */
569 if (tcsetattr(serial->fd, TCSADRAIN, &term) < 0) {
570 sr_err("tcsetattr() error: %s.", strerror(errno));
575 sr_spew("Setting RTS %s.", rts ? "high" : "low");
576 controlbits = TIOCM_RTS;
577 if ((ret = ioctl(serial->fd, rts ? TIOCMBIS : TIOCMBIC,
578 &controlbits)) < 0) {
579 sr_err("Error setting RTS: %s.", strerror(errno));
585 sr_spew("Setting DTR %s.", dtr ? "high" : "low");
586 controlbits = TIOCM_DTR;
587 if ((ret = ioctl(serial->fd, dtr ? TIOCMBIS : TIOCMBIC,
588 &controlbits)) < 0) {
589 sr_err("Error setting DTR: %s.", strerror(errno));
600 * Set serial parameters for the specified serial port.
602 * @param serial Previously initialized serial port structure.
603 * @param paramstr A serial communication parameters string, in the form
604 * of <speed>/<data bits><parity><stopbits>, for example "9600/8n1" or
607 * @return SR_OK upon success, SR_ERR upon failure.
609 #define SERIAL_COMM_SPEC "^(\\d+)/([78])([neo])([12])(.*)$"
610 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
611 const char *paramstr)
615 int speed, databits, parity, stopbits, rts, dtr, i;
616 char *mstr, **opts, **kv;
618 speed = databits = parity = stopbits = 0;
620 reg = g_regex_new(SERIAL_COMM_SPEC, 0, 0, NULL);
621 if (g_regex_match(reg, paramstr, 0, &match)) {
622 if ((mstr = g_match_info_fetch(match, 1)))
623 speed = strtoul(mstr, NULL, 10);
625 if ((mstr = g_match_info_fetch(match, 2)))
626 databits = strtoul(mstr, NULL, 10);
628 if ((mstr = g_match_info_fetch(match, 3))) {
631 parity = SERIAL_PARITY_NONE;
634 parity = SERIAL_PARITY_EVEN;
637 parity = SERIAL_PARITY_ODD;
642 if ((mstr = g_match_info_fetch(match, 4)))
643 stopbits = strtoul(mstr, NULL, 10);
645 if ((mstr = g_match_info_fetch(match, 5)) && mstr[0] != '\0') {
646 if (mstr[0] != '/') {
647 sr_dbg("missing separator before extra options");
650 /* A set of "key=value" options separated by / */
651 opts = g_strsplit(mstr + 1, "/", 0);
652 for (i = 0; opts[i]; i++) {
653 kv = g_strsplit(opts[i], "=", 2);
654 if (!strncmp(kv[0], "rts", 3)) {
657 else if (kv[1][0] == '0')
660 sr_dbg("invalid value for rts: %c", kv[1][0]);
663 } else if (!strncmp(kv[0], "dtr", 3)) {
666 else if (kv[1][0] == '0')
669 sr_dbg("invalid value for dtr: %c", kv[1][0]);
680 g_match_info_unref(match);
684 return serial_set_params(serial, speed, databits, parity, stopbits,
691 * Read a line from the specified serial port.
693 * @param serial Previously initialized serial port structure.
694 * @param buf Buffer where to store the bytes that are read.
695 * @param buflen Size of the buffer.
696 * @param timeout_ms How long to wait for a line to come in.
698 * Reading stops when CR of LR is found, which is stripped from the buffer.
700 * @return SR_OK on success, SR_ERR on failure.
702 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
703 int *buflen, gint64 timeout_ms)
708 if (!serial || serial->fd == -1) {
709 sr_dbg("Invalid serial port.");
713 if (serial->fd == -1) {
714 sr_dbg("Cannot use unopened serial port %s (fd %d).",
715 serial->port, serial->fd);
720 start = g_get_monotonic_time();
725 len = maxlen - *buflen - 1;
728 len = serial_read(serial, *buf + *buflen, 1);
731 *(*buf + *buflen) = '\0';
732 if (*buflen > 0 && (*(*buf + *buflen - 1) == '\r'
733 || *(*buf + *buflen - 1) == '\n')) {
734 /* Strip CR/LF and terminate. */
735 *(*buf + --*buflen) = '\0';
739 if (g_get_monotonic_time() - start > timeout_ms)
745 sr_dbg("Received %d: '%s'.", *buflen, *buf);
751 * Try to find a valid packet in a serial data stream.
753 * @param serial Previously initialized serial port structure.
754 * @param buf Buffer containing the bytes to write.
755 * @param count Size of the buffer.
756 * @param packet_size Size, in bytes, of a valid packet.
757 * @param is_valid Callback that assesses whether the packet is valid or not.
758 * @param timeout_ms The timeout after which, if no packet is detected, to
760 * @param baudrate The baudrate of the serial port. This parameter is not
761 * critical, but it helps fine tune the serial port polling
764 * @return SR_OK if a valid packet is found within the given timeout,
765 * SR_ERR upon failure.
767 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
768 uint8_t *buf, size_t *buflen,
769 size_t packet_size, packet_valid_t is_valid,
770 uint64_t timeout_ms, int baudrate)
772 uint64_t start, time, byte_delay_us;
773 size_t ibuf, i, maxlen;
778 sr_dbg("Detecting packets on FD %d (timeout = %" PRIu64
779 "ms, baudrate = %d).", serial->fd, timeout_ms, baudrate);
781 if (maxlen < (packet_size / 2) ) {
782 sr_err("Buffer size must be at least twice the packet size.");
786 /* Assume 8n1 transmission. That is 10 bits for every byte. */
787 byte_delay_us = 10 * (1000000 / baudrate);
788 start = g_get_monotonic_time();
791 while (ibuf < maxlen) {
792 len = serial_read(serial, &buf[ibuf], 1);
795 } else if (len == 0) {
796 sr_spew("Error: Only read 0 bytes.");
798 /* Error reading byte, but continuing anyway. */
801 time = g_get_monotonic_time() - start;
804 if ((ibuf - i) >= packet_size) {
805 /* We have at least a packet's worth of data. */
806 if (is_valid(&buf[i])) {
807 sr_spew("Found valid %d-byte packet after "
808 "%" PRIu64 "ms.", (ibuf - i), time);
812 sr_spew("Got %d bytes, but not a valid "
813 "packet.", (ibuf - i));
815 /* Not a valid packet. Continue searching. */
818 if (time >= timeout_ms) {
820 sr_dbg("Detection timed out after %dms.", time);
823 g_usleep(byte_delay_us);
828 sr_err("Didn't find a valid packet (read %d bytes).", *buflen);