X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=hardware%2Fcommon%2Fserial.c;h=a18ad0b494073962f1bc7fb182b4e1c95db3b2e3;hb=a53da08254a5adcc15c925014eb1083fb067f3b6;hp=84d8f380c68d7a260738c1526e1e7c0c44afa2b4;hpb=4da1a800df3ce7776b3a533308dabf484fae9a34;p=libsigrok.git diff --git a/hardware/common/serial.c b/hardware/common/serial.c index 84d8f380..a18ad0b4 100644 --- a/hardware/common/serial.c +++ b/hardware/common/serial.c @@ -3,6 +3,7 @@ * * Copyright (C) 2010-2012 Bert Vermeulen * Copyright (C) 2010-2012 Uwe Hermann + * Copyright (C) 2012 Alexandru Gagniuc * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -28,6 +29,7 @@ #else #include #include +#include #endif #include #include @@ -53,8 +55,8 @@ static HANDLE hdl; * 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. @@ -63,6 +65,10 @@ static HANDLE hdl; */ 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."); @@ -72,19 +78,36 @@ SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags) 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) @@ -282,9 +305,9 @@ SR_PRIV int serial_read(struct sr_serial_dev_inst *serial, void *buf, * @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; @@ -292,54 +315,136 @@ SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate, 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; + int ret, controlbits; if (tcgetattr(serial->fd, &term) < 0) { sr_err("tcgetattr() error on port %s (fd %d): %s.", @@ -408,7 +513,7 @@ SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate, break; #endif default: - sr_err("Unsupported baudrate %d.", baudrate); + sr_err("Unsupported baudrate: %d.", baudrate); return SR_ERR; } @@ -503,6 +608,27 @@ SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate, 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; @@ -518,16 +644,17 @@ SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate, * * @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, rts, dtr, i; + char *mstr, **opts, **kv; speed = databits = parity = stopbits = 0; + rts = dtr = -1; 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))) @@ -553,12 +680,47 @@ SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial, 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; + } + } + 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); + return serial_set_params(serial, speed, databits, parity, stopbits, + 0, rts, dtr); else return SR_ERR_ARG; } @@ -622,3 +784,86 @@ SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf, return SR_OK; } + +/** + * Try to find a valid packet in a serial data stream. + * + * @param serial Previously initialized serial port structure. + * @param buf Buffer containing the bytes to write. + * @param count Size of the buffer. + * @param packet_size Size, in bytes, of a valid packet. + * @param is_valid Callback that assesses whether the packet is valid or not. + * @param timeout_ms The timeout after which, if no packet is detected, to + * abort scanning. + * @param baudrate The baudrate of the serial port. This parameter is not + * critical, but it helps fine tune the serial port polling + * delay. + * + * @return SR_OK if a valid packet is found within the given timeout, + * SR_ERR upon failure. + */ +SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial, + uint8_t *buf, size_t *buflen, + size_t packet_size, packet_valid_t is_valid, + uint64_t timeout_ms, int baudrate) +{ + uint64_t start, time, byte_delay_us; + size_t ibuf, i, maxlen; + int len; + + maxlen = *buflen; + + sr_dbg("Detecting packets on FD %d (timeout = %" PRIu64 + "ms, baudrate = %d).", serial->fd, timeout_ms, baudrate); + + if (maxlen < (packet_size / 2) ) { + sr_err("Buffer size must be at least twice the packet size."); + return SR_ERR; + } + + /* Assume 8n1 transmission. That is 10 bits for every byte. */ + byte_delay_us = 10 * (1000000 / baudrate); + start = g_get_monotonic_time(); + + i = ibuf = len = 0; + while (ibuf < maxlen) { + len = serial_read(serial, &buf[ibuf], 1); + if (len > 0) { + ibuf += len; + } else if (len == 0) { + sr_spew("Error: Only read 0 bytes."); + } 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])) { + sr_spew("Found valid %d-byte packet after " + "%" PRIu64 "ms.", (ibuf - i), time); + *buflen = ibuf; + return SR_OK; + } else { + sr_spew("Got %d bytes, but not a valid " + "packet.", (ibuf - i)); + } + /* Not a valid packet. Continue searching. */ + i++; + } + if (time >= timeout_ms) { + /* Timeout */ + sr_dbg("Detection timed out after %dms.", time); + break; + } + g_usleep(byte_delay_us); + } + + *buflen = ibuf; + + sr_err("Didn't find a valid packet (read %d bytes).", *buflen); + + return SR_ERR; +}