scpi: document callers' responsibility to free getters' allocated memory

[libsigrok.git] / src / scpi / scpi_vxi.c

diff --git a/src/scpi/scpi_vxi.c b/src/scpi/scpi_vxi.c
index 62bf8c61bcdab6d9ea6c4582fed60c272318e086..774b8b52ca2f43db2e0d2bc807820ed9bdf049b0 100644 (file)
--- a/src/scpi/scpi_vxi.c
+++ b/src/scpi/scpi_vxi.c
@@ -20,15 +20,16 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+#include <config.h>
+#include "vxi.h"
 #include <rpc/rpc.h>
 #include <string.h>
-
-#include "vxi.h"
-#include "libsigrok.h"
+#include <libsigrok/libsigrok.h>
 #include "libsigrok-internal.h"
+#include "scpi.h"
 
 #define LOG_PREFIX "scpi_vxi"
-#define VXI_DEFAULT_TIMEOUT  2000  /* in ms */
+#define VXI_DEFAULT_TIMEOUT_MS 2000
 
 struct scpi_vxi {
        char *address;
@@ -59,14 +60,14 @@ static int scpi_vxi_dev_inst_new(void *priv, struct drv_context *drvc,
        return SR_OK;
 }
 
-static int scpi_vxi_open(void *priv)
+static int scpi_vxi_open(struct sr_scpi_dev_inst *scpi)
 {
-       struct scpi_vxi *vxi = priv;
+       struct scpi_vxi *vxi = scpi->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) {
+       if (!vxi->client) {
                sr_err("Client creation failed for %s", vxi->address);
                return SR_ERR;
        }
@@ -74,8 +75,8 @@ static int scpi_vxi_open(void *priv)
        /* Set link parameters */
        link_parms.clientId = (long) vxi->client;
        link_parms.lockDevice = 0;
-       link_parms.lock_timeout = VXI_DEFAULT_TIMEOUT;
-       link_parms.device = "inst0";
+       link_parms.lock_timeout = VXI_DEFAULT_TIMEOUT_MS;
+       link_parms.device = (char *)"inst0";
 
        if (!(link_resp = create_link_1(&link_parms, vxi->client))) {
                sr_err("Link creation failed for %s", vxi->address);
@@ -91,6 +92,16 @@ static int scpi_vxi_open(void *priv)
        return SR_OK;
 }
 
+static int scpi_vxi_connection_id(struct sr_scpi_dev_inst *scpi,
+               char **connection_id)
+{
+       struct scpi_vxi *vxi = scpi->priv;
+
+       *connection_id = g_strdup_printf("%s/%s", scpi->prefix, vxi->address);
+
+       return SR_OK;
+}
+
 static int scpi_vxi_source_add(struct sr_session *session, void *priv,
                int events, int timeout, sr_receive_data_callback cb, void *cb_data)
 {
@@ -117,30 +128,26 @@ 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;
+       unsigned long len;
 
-       terminated_command = g_strdup_printf("%s\r\n", command);
-       len = strlen(terminated_command);
+       len = strlen(command);
 
        write_parms.lid           = vxi->link;
-       write_parms.io_timeout    = VXI_DEFAULT_TIMEOUT;
-       write_parms.lock_timeout  = VXI_DEFAULT_TIMEOUT;
+       write_parms.io_timeout    = VXI_DEFAULT_TIMEOUT_MS;
+       write_parms.lock_timeout  = VXI_DEFAULT_TIMEOUT_MS;
        write_parms.flags         = DF_END;
        write_parms.data.data_len = MIN(len, vxi->max_send_size);
-       write_parms.data.data_val = terminated_command;
+       write_parms.data.data_val = (char *)command;
 
        if (!(write_resp = device_write_1(&write_parms, vxi->client))
            || write_resp->error) {
-               sr_err("Device write failed for %s with error %d",
+               sr_err("Device write failed for %s with error %ld",
                       vxi->address, write_resp ? write_resp->error : 0);
                return SR_ERR;
        }
 
-       g_free(terminated_command);
-
        if (write_resp->size < len)
-               sr_dbg("Only sent %d/%d bytes of SCPI command: '%s'.",
+               sr_dbg("Only sent %lu/%lu bytes of SCPI command: '%s'.",
                       write_resp->size, len, command);
        else
                sr_spew("Successfully sent SCPI command: '%s'.", command);
@@ -169,21 +176,21 @@ static int scpi_vxi_read_data(void *priv, char *buf, int maxlen)
        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.io_timeout   = VXI_DEFAULT_TIMEOUT_MS;
+       read_parms.lock_timeout = VXI_DEFAULT_TIMEOUT_MS;
        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",
+               sr_err("Device read failed for %s with error %ld",
                       vxi->address, read_resp ? read_resp->error : 0);
                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);
+       vxi->read_complete = read_resp->reason & (RRR_TERM | RRR_END);
        return read_resp->data.data_len;  /* actual number of bytes received */
 }
 
@@ -194,9 +201,9 @@ static int scpi_vxi_read_complete(void *priv)
        return vxi->read_complete;
 }
 
-static int scpi_vxi_close(void *priv)
+static int scpi_vxi_close(struct sr_scpi_dev_inst *scpi)
 {
-       struct scpi_vxi *vxi = priv;
+       struct scpi_vxi *vxi = scpi->priv;
        Device_Error *dev_error;
 
        if (!vxi->client)
@@ -224,9 +231,11 @@ static void scpi_vxi_free(void *priv)
 SR_PRIV const struct sr_scpi_dev_inst scpi_vxi_dev = {
        .name          = "VXI",
        .prefix        = "vxi",
+       .transport     = SCPI_TRANSPORT_VXI,
        .priv_size     = sizeof(struct scpi_vxi),
        .dev_inst_new  = scpi_vxi_dev_inst_new,
        .open          = scpi_vxi_open,
+       .connection_id = scpi_vxi_connection_id,
        .source_add    = scpi_vxi_source_add,
        .source_remove = scpi_vxi_source_remove,
        .send          = scpi_vxi_send,