X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=src%2Fscpi%2Fscpi_serial.c;h=067838adce5f04bc19e379b0a6e13412da2870f3;hb=ed787682255cdecbb3ba8cefc87c20182b97ce7b;hp=4f6e067887c9135298b6512837cdf9f4abb33d09;hpb=406e0c79cfbc5893635bbdece6f5c8b2ca9c9b25;p=libsigrok.git diff --git a/src/scpi/scpi_serial.c b/src/scpi/scpi_serial.c index 4f6e0678..067838ad 100644 --- a/src/scpi/scpi_serial.c +++ b/src/scpi/scpi_serial.c @@ -18,31 +18,36 @@ * along with this program. If not, see . */ -#include "libsigrok.h" -#include "libsigrok-internal.h" - +#include #include #include #include +#include +#include "libsigrok-internal.h" +#include "scpi.h" #define LOG_PREFIX "scpi_serial" -#define BUFFER_SIZE 1024 +#ifdef HAVE_SERIAL_COMM struct scpi_serial { struct sr_serial_dev_inst *serial; - char buffer[BUFFER_SIZE]; - size_t count; - size_t read; + gboolean got_newline; }; -static struct { +/* Default serial port options for some known USB devices */ +static const struct { uint16_t vendor_id; uint16_t product_id; const char *serialcomm; } scpi_serial_usb_ids[] = { { 0x0403, 0xed72, "115200/8n1/flow=1" }, /* Hameg HO720 */ { 0x0403, 0xed73, "115200/8n1/flow=1" }, /* Hameg HO730 */ + { 0x0aad, 0x0117, "115200/8n1" }, /* R&S HMO series, previously branded as Hameg HMO */ + { 0x0aad, 0x0118, "115200/8n1" }, /* R&S HMO series, previously branded as Hameg HMO */ + { 0x0aad, 0x0119, "115200/8n1" }, /* R&S HMO series, previously branded as Hameg HMO */ + { 0x2184, 0x0030, "115200/8n1" }, /* GW-Instek GDM-8341 (VCP, SiLabs CP210x) */ + { 0x2184, 0x0058, "115200/8n1" }, /* GW-Instek GDM-9061 (USBCDC mode) */ }; static GSList *scpi_serial_scan(struct drv_context *drvc) @@ -54,8 +59,8 @@ static GSList *scpi_serial_scan(struct drv_context *drvc) (void)drvc; for (i = 0; i < ARRAY_SIZE(scpi_serial_usb_ids); i++) { - if ((l = sr_serial_find_usb(scpi_serial_usb_ids[i].vendor_id, - scpi_serial_usb_ids[i].product_id)) == NULL) + if (!(l = sr_serial_find_usb(scpi_serial_usb_ids[i].vendor_id, + scpi_serial_usb_ids[i].product_id))) continue; for (r = l; r; r = r->next) { if (scpi_serial_usb_ids[i].serialcomm) @@ -74,30 +79,55 @@ static GSList *scpi_serial_scan(struct drv_context *drvc) static int scpi_serial_dev_inst_new(void *priv, struct drv_context *drvc, const char *resource, char **params, const char *serialcomm) { + GSList *l, *r; + unsigned i; struct scpi_serial *sscpi = priv; (void)drvc; (void)params; - if (!(sscpi->serial = sr_serial_dev_inst_new(resource, serialcomm))) - return SR_ERR; + /* If no serial port option is specified on the command-line using the + * "serialcomm" driver option, but the device is connected through USB + * and it requires a known default serial port option, then used it in + * order to avoid data corruption or even worse problems. + */ + if (!serialcomm) { + for (i = 0; i < ARRAY_SIZE(scpi_serial_usb_ids); i++) { + if (!(l = sr_serial_find_usb(scpi_serial_usb_ids[i].vendor_id, + scpi_serial_usb_ids[i].product_id))) + continue; + for (r = l; r; r = r->next) + if (!strcmp(resource, r->data) && scpi_serial_usb_ids[i].serialcomm) + serialcomm = scpi_serial_usb_ids[i].serialcomm; + g_slist_free_full(l, g_free); + } + } + + sscpi->serial = sr_serial_dev_inst_new(resource, serialcomm); return SR_OK; } -static int scpi_serial_open(void *priv) +static int scpi_serial_open(struct sr_scpi_dev_inst *scpi) { - struct scpi_serial *sscpi = priv; + struct scpi_serial *sscpi = scpi->priv; struct sr_serial_dev_inst *serial = sscpi->serial; if (serial_open(serial, SERIAL_RDWR) != SR_OK) return SR_ERR; - if (serial_flush(serial) != SR_OK) - return SR_ERR; + sscpi->got_newline = FALSE; + + return SR_OK; +} + +static int scpi_serial_connection_id(struct sr_scpi_dev_inst *scpi, + char **connection_id) +{ + struct scpi_serial *sscpi = scpi->priv; + struct sr_serial_dev_inst *serial = sscpi->serial; - sscpi->count = 0; - sscpi->read = 0; + *connection_id = g_strdup(serial->port); return SR_OK; } @@ -121,27 +151,17 @@ static int scpi_serial_source_remove(struct sr_session *session, void *priv) static int scpi_serial_send(void *priv, const char *command) { - int len, result, written; - gchar *terminated_command; + int result; struct scpi_serial *sscpi = priv; struct sr_serial_dev_inst *serial = sscpi->serial; - terminated_command = g_strconcat(command, "\n", NULL); - len = strlen(terminated_command); - written = 0; - while (written < len) { - result = serial_write_nonblocking(serial, - terminated_command + written, len - written); - if (result < 0) { - sr_err("Error while sending SCPI command: '%s'.", command); - g_free(terminated_command); - return SR_ERR; - } - written += result; + result = serial_write_blocking(serial, command, strlen(command), 0); + if (result < 0) { + sr_err("Error while sending SCPI command '%s': %d.", + command, result); + return SR_ERR; } - g_free(terminated_command); - sr_spew("Successfully sent SCPI command: '%s'.", command); return SR_OK; @@ -149,7 +169,8 @@ static int scpi_serial_send(void *priv, const char *command) static int scpi_serial_read_begin(void *priv) { - (void) priv; + struct scpi_serial *sscpi = priv; + sscpi->got_newline = FALSE; return SR_OK; } @@ -157,61 +178,41 @@ static int scpi_serial_read_begin(void *priv) static int scpi_serial_read_data(void *priv, char *buf, int maxlen) { struct scpi_serial *sscpi = priv; - int len, ret; - - len = BUFFER_SIZE - sscpi->count; - - /* Try to read new data into the buffer if there is space. */ - if (len > 0) { - ret = serial_read_nonblocking(sscpi->serial, sscpi->buffer + sscpi->read, - BUFFER_SIZE - sscpi->count); - - if (ret < 0) - return ret; - - sscpi->count += ret; - - if (ret > 0) - sr_spew("Read %d bytes into buffer.", ret); - } - - /* Return as many bytes as possible from buffer, excluding any trailing newline. */ - if (sscpi->read < sscpi->count) { - len = sscpi->count - sscpi->read; - if (len > maxlen) - len = maxlen; - if (sscpi->buffer[sscpi->read + len - 1] == '\n') - len--; - sr_spew("Returning %d bytes from buffer.", len); - memcpy(buf, sscpi->buffer + sscpi->read, len); - sscpi->read += len; - if (sscpi->read == BUFFER_SIZE) { - sr_spew("Resetting buffer."); - sscpi->count = 0; - sscpi->read = 0; - } - return len; + int ret; + + /* Try to read new data into the buffer. */ + ret = serial_read_nonblocking(sscpi->serial, buf, maxlen); + if (ret < 0) + return ret; + + /* + * Check for line termination at the end of the receive data. + * Handle the usual case of NL, as well as the unusual NL+CR + * combination (some GWInstek DMMs were found to do this). + */ + sscpi->got_newline = FALSE; + if (ret >= 1 && buf[ret - 1] == '\n') { + sscpi->got_newline = TRUE; + sr_spew("Received NL terminator"); + } else if (ret >= 2 && buf[ret - 2] == '\n' && buf[ret - 1] == '\r') { + ret--; + sscpi->got_newline = TRUE; + sr_spew("Received NL+CR terminator"); } - return 0; + return ret; } static int scpi_serial_read_complete(void *priv) { struct scpi_serial *sscpi = priv; - /* If the next character is a newline, discard it and report complete. */ - if (sscpi->read < sscpi->count && sscpi->buffer[sscpi->read] == '\n') { - sscpi->read++; - return 1; - } else { - return 0; - } + return sscpi->got_newline; } -static int scpi_serial_close(void *priv) +static int scpi_serial_close(struct sr_scpi_dev_inst *scpi) { - struct scpi_serial *sscpi = priv; + struct scpi_serial *sscpi = scpi->priv; return serial_close(sscpi->serial); } @@ -226,10 +227,12 @@ static void scpi_serial_free(void *priv) SR_PRIV const struct sr_scpi_dev_inst scpi_serial_dev = { .name = "serial", .prefix = "", + .transport = SCPI_TRANSPORT_SERIAL, .priv_size = sizeof(struct scpi_serial), .scan = scpi_serial_scan, .dev_inst_new = scpi_serial_dev_inst_new, .open = scpi_serial_open, + .connection_id = scpi_serial_connection_id, .source_add = scpi_serial_source_add, .source_remove = scpi_serial_source_remove, .send = scpi_serial_send, @@ -239,3 +242,5 @@ SR_PRIV const struct sr_scpi_dev_inst scpi_serial_dev = { .close = scpi_serial_close, .free = scpi_serial_free, }; + +#endif