From d5876cfb4a51140e449e37e35937795ad43368f7 Mon Sep 17 00:00:00 2001 From: Aurelien Jacobs Date: Thu, 9 Jan 2014 23:44:35 +0100 Subject: [PATCH] scpi: add VXI transport support --- configure.ac | 12 ++ hardware/common/Makefile.am | 4 + hardware/common/scpi_vxi.c | 223 +++++++++++++++++++++++++++++++++++ hardware/rigol-ds/api.c | 17 ++- hardware/rigol-ds/protocol.c | 2 +- libsigrok-internal.h | 5 + 6 files changed, 261 insertions(+), 2 deletions(-) create mode 100644 hardware/common/scpi_vxi.c diff --git a/configure.ac b/configure.ac index 3fc1cdc4..240e7e35 100644 --- a/configure.ac +++ b/configure.ac @@ -266,6 +266,18 @@ SR_PKGLIBS="" # libm (the standard math library) is always needed. AC_SEARCH_LIBS([pow], [m]) +# RPC is only needed for VXI support +AC_MSG_CHECKING([for RPC support]) +AC_LINK_IFELSE([AC_LANG_PROGRAM([#include ], + [CLIENT *rpc_test(void)], + [{ return clnt_create("", 0, 0, ""); }])], + [AC_MSG_RESULT([yes]); have_rpc=1], + [AC_MSG_RESULT([no]); have_rpc=0]) +# Define HAVE_RPC in config.h if we found RPC support. +AC_DEFINE_UNQUOTED(HAVE_RPC, [$have_rpc],[Specifies whether we have RPC support.]) +# VXI support is only compiled if RPC support was found. +AM_CONDITIONAL(NEED_RPC, test "x$have_rpc" != x0) + # libglib-2.0 is always needed. Abort if it's not found. # Note: glib-2.0 is part of the libsigrok API (hard pkg-config requirement). # We require at least 2.32.0 due to e.g. g_variant_new_fixed_array(). diff --git a/hardware/common/Makefile.am b/hardware/common/Makefile.am index 64e685e8..7e9258cb 100644 --- a/hardware/common/Makefile.am +++ b/hardware/common/Makefile.am @@ -24,6 +24,10 @@ noinst_LTLIBRARIES = libsigrok_hw_common.la libsigrok_hw_common_la_SOURCES = scpi.c scpi_tcp.c +if NEED_RPC +libsigrok_hw_common_la_SOURCES += scpi_vxi.c vxi_clnt.c vxi_xdr.c +endif + if NEED_SERIAL libsigrok_hw_common_la_SOURCES += serial.c scpi_serial.c scpi_usbtmc.c endif diff --git a/hardware/common/scpi_vxi.c b/hardware/common/scpi_vxi.c new file mode 100644 index 00000000..7648f3e7 --- /dev/null +++ b/hardware/common/scpi_vxi.c @@ -0,0 +1,223 @@ +/* + * This file is part of the libsigrok project. + * + * Copyright (C) 2014 Aurelien Jacobs + * + * Inspired by the VXI11 Ethernet Protocol for Linux: + * http://optics.eee.nottingham.ac.uk/vxi11/ + * + * 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 + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +#include +#include "vxi.h" +#include "libsigrok.h" +#include "libsigrok-internal.h" + +#define LOG_PREFIX "scpi_vxi" +#define VXI_DEFAULT_TIMEOUT 2000 /* in ms */ + +struct scpi_vxi { + char *address; + char *instrument; + CLIENT *client; + Device_Link link; + unsigned int max_send_size; + unsigned int read_complete; +}; + +static int scpi_vxi_open(void *priv) +{ + struct scpi_vxi *vxi = priv; + Create_LinkParms link_parms; + Create_LinkResp *link_resp; + + vxi->client = clnt_create(vxi->address, DEVICE_CORE, DEVICE_CORE_VERSION, "tcp"); + if (vxi->client == NULL) { + sr_err("Client creation failed for %s", vxi->address); + return SR_ERR; + } + + /* Set link parameters */ + link_parms.clientId = (long) vxi->client; + link_parms.lockDevice = 0; + link_parms.lock_timeout = VXI_DEFAULT_TIMEOUT; + link_parms.device = "inst0"; + + if (!(link_resp = create_link_1(&link_parms, vxi->client))) { + sr_err("Link creation failed for %s", vxi->address); + return SR_ERR; + } + vxi->link = link_resp->lid; + vxi->max_send_size = link_resp->maxRecvSize; + + /* Set a default maxRecvSize for devices which do not specify it */ + if (vxi->max_send_size <= 0) + vxi->max_send_size = 4096; + + return SR_OK; +} + +static int scpi_vxi_source_add(void *priv, int events, int timeout, + sr_receive_data_callback_t cb, void *cb_data) +{ + (void)priv; + + /* Hook up a dummy handler to receive data from the device. */ + return sr_source_add(-1, events, timeout, cb, cb_data); +} + +static int scpi_vxi_source_remove(void *priv) +{ + (void)priv; + + return sr_source_remove(-1); +} + +/* Operation Flags */ +#define DF_WAITLOCK 0x01 /* wait if the operation is locked by another link */ +#define DF_END 0x08 /* an END indicator is sent with last byte of buffer */ +#define DF_TERM 0x80 /* a termination char is set during a read */ + +static int scpi_vxi_send(void *priv, const char *command) +{ + struct scpi_vxi *vxi = priv; + Device_WriteResp *write_resp; + Device_WriteParms write_parms; + char *terminated_command; + unsigned int len; + + terminated_command = g_strdup_printf("%s\r\n", command); + len = strlen(terminated_command); + + write_parms.lid = vxi->link; + write_parms.io_timeout = VXI_DEFAULT_TIMEOUT; + write_parms.lock_timeout = VXI_DEFAULT_TIMEOUT; + write_parms.flags = DF_END; + write_parms.data.data_len = MIN(len, vxi->max_send_size); + write_parms.data.data_val = terminated_command; + + if (!(write_resp = device_write_1(&write_parms, vxi->client)) + || write_resp->error) { + sr_err("Device write failed for %s with error %d", + vxi->address, write_resp->error); + return SR_ERR; + } + + g_free(terminated_command); + + if (write_resp->size < len) + sr_dbg("Only sent %d/%d bytes of SCPI command: '%s'.", + write_resp->size, len, command); + else + sr_spew("Successfully sent SCPI command: '%s'.", command); + + return SR_OK; +} + +static int scpi_vxi_read_begin(void *priv) +{ + struct scpi_vxi *vxi = priv; + + vxi->read_complete = 0; + + return SR_OK; +} + +/* Read Response Reason Flags */ +#define RRR_SIZE 0x01 /* requestSize bytes have been transferred */ +#define RRR_TERM 0x02 /* a termination char has been read */ +#define RRR_END 0x04 /* an END indicator has been read */ + +static int scpi_vxi_read_data(void *priv, char *buf, int maxlen) +{ + struct scpi_vxi *vxi = priv; + Device_ReadParms read_parms; + Device_ReadResp *read_resp; + + read_parms.lid = vxi->link; + read_parms.io_timeout = VXI_DEFAULT_TIMEOUT; + read_parms.lock_timeout = VXI_DEFAULT_TIMEOUT; + read_parms.flags = 0; + read_parms.termChar = 0; + read_parms.requestSize = maxlen; + + if (!(read_resp = device_read_1(&read_parms, vxi->client)) + || read_resp->error) { + sr_err("Device read failed for %s with error %d", + vxi->address, read_resp->error); + return SR_ERR; + } + + memcpy(buf, read_resp->data.data_val, read_resp->data.data_len); + vxi->read_complete = read_resp->reason & (RRR_SIZE | RRR_TERM | RRR_END); + return read_resp->data.data_len; /* actual number of bytes received */ +} + +static int scpi_vxi_read_complete(void *priv) +{ + struct scpi_vxi *vxi = priv; + + return vxi->read_complete; +} + +static int scpi_vxi_close(void *priv) +{ + struct scpi_vxi *vxi = priv; + Device_Error *dev_error; + + if (!(dev_error = destroy_link_1(&vxi->link, vxi->client))) { + sr_err("Link destruction failed for %s", vxi->address); + return SR_ERR; + } + + clnt_destroy(vxi->client); + + return SR_OK; +} + +static void scpi_vxi_free(void *priv) +{ + struct scpi_vxi *vxi = priv; + + g_free(vxi->address); + g_free(vxi->instrument); + g_free(vxi); +} + +SR_PRIV struct sr_scpi_dev_inst *scpi_vxi_dev_inst_new(const char *address, + const char *instrument) +{ + struct sr_scpi_dev_inst *scpi; + struct scpi_vxi *vxi; + + scpi = g_malloc(sizeof(struct sr_scpi_dev_inst)); + vxi = g_malloc0(sizeof(struct scpi_vxi)); + + vxi->address = g_strdup(address); + vxi->instrument = g_strdup(instrument ? instrument : "inst0"); + + scpi->open = scpi_vxi_open; + scpi->source_add = scpi_vxi_source_add; + scpi->source_remove = scpi_vxi_source_remove; + scpi->send = scpi_vxi_send; + scpi->read_begin = scpi_vxi_read_begin; + scpi->read_data = scpi_vxi_read_data; + scpi->read_complete = scpi_vxi_read_complete; + scpi->close = scpi_vxi_close; + scpi->free = scpi_vxi_free; + scpi->priv = vxi; + + return scpi; +} diff --git a/hardware/rigol-ds/api.c b/hardware/rigol-ds/api.c index 220c29d4..9007ea18 100644 --- a/hardware/rigol-ds/api.c +++ b/hardware/rigol-ds/api.c @@ -248,7 +248,8 @@ static int probe_port(const char *resource, const char *serialcomm, GSList **dev struct sr_dev_inst *sdi; const char *usbtmc_prefix = "/dev/usbtmc"; const char *tcp_prefix = "tcp/"; - gchar **tokens, *address, *port; + const char *vxi_prefix = "vxi/"; + gchar **tokens, *address, *port, *instrument; struct sr_scpi_dev_inst *scpi; struct sr_scpi_hw_info *hw_info; struct sr_probe *probe; @@ -276,6 +277,20 @@ static int probe_port(const char *resource, const char *serialcomm, GSList **dev g_strfreev(tokens); if (!scpi) return SR_ERR_MALLOC; + } else if (HAVE_RPC && !strncmp(resource, vxi_prefix, strlen(vxi_prefix))) { + sr_dbg("Opening VXI connection %s.", resource); + tokens = g_strsplit(resource + strlen(tcp_prefix), "/", 0); + address = tokens[0]; + instrument = tokens[1]; + if (!address) { + sr_err("Invalid parameters."); + g_strfreev(tokens); + return SR_ERR_ARG; + } + scpi = scpi_vxi_dev_inst_new(address, instrument); + g_strfreev(tokens); + if (!scpi) + return SR_ERR_MALLOC; } else { sr_dbg("Opening serial device %s.", resource); if (!(scpi = scpi_serial_dev_inst_new(resource, serialcomm))) diff --git a/hardware/rigol-ds/protocol.c b/hardware/rigol-ds/protocol.c index eefed074..9952e2a4 100644 --- a/hardware/rigol-ds/protocol.c +++ b/hardware/rigol-ds/protocol.c @@ -423,7 +423,7 @@ SR_PRIV int rigol_ds_receive(int fd, int revents, void *cb_data) scpi = sdi->conn; - if (revents == G_IO_IN) { + if (revents == G_IO_IN || revents == 0) { if (devc->model->protocol == PROTOCOL_IEEE488_2) { switch(devc->wait_event) { case WAIT_NONE: diff --git a/libsigrok-internal.h b/libsigrok-internal.h index 2577fd0d..e99e5473 100644 --- a/libsigrok-internal.h +++ b/libsigrok-internal.h @@ -420,6 +420,11 @@ SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi, struct sr_scpi_hw_info **scpi_response); SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info); +/*--- hardware/common/scpi_vxi.c --------------------------------------------*/ + +SR_PRIV struct sr_scpi_dev_inst *scpi_vxi_dev_inst_new(const char *address, + const char *instrument); + /*--- hardware/common/scpi_serial.c -----------------------------------------*/ #ifdef HAVE_LIBSERIALPORT