scpi_vxi: readability nits in the SCPI via VXI source code

Address style nits to improve readablity and future maintenance.
Move system header includes before application level includes. Move
assignments out of variable declaration blocks. Separate function calls
and assignments from error checks and flow control. Break a long line.
Add braces around conditional multi line statements.

All these adjustments are cosmetical. Behaviour does not change.
This commit is contained in:
Gerhard Sittig 2021-06-06 16:06:51 +02:00
parent 1b7d49db64
commit 7414fb55cb
1 changed files with 30 additions and 18 deletions

View File

@ -21,12 +21,12 @@
*/ */
#include <config.h> #include <config.h>
#include "vxi.h"
#include <rpc/rpc.h> #include <rpc/rpc.h>
#include <string.h> #include <string.h>
#include <libsigrok/libsigrok.h> #include <libsigrok/libsigrok.h>
#include "libsigrok-internal.h" #include "libsigrok-internal.h"
#include "scpi.h" #include "scpi.h"
#include "vxi.h"
#define LOG_PREFIX "scpi_vxi" #define LOG_PREFIX "scpi_vxi"
#define VXI_DEFAULT_TIMEOUT_MS 2000 #define VXI_DEFAULT_TIMEOUT_MS 2000
@ -43,7 +43,7 @@ struct scpi_vxi {
static int scpi_vxi_dev_inst_new(void *priv, struct drv_context *drvc, static int scpi_vxi_dev_inst_new(void *priv, struct drv_context *drvc,
const char *resource, char **params, const char *serialcomm) const char *resource, char **params, const char *serialcomm)
{ {
struct scpi_vxi *vxi = priv; struct scpi_vxi *vxi;
(void)drvc; (void)drvc;
(void)resource; (void)resource;
@ -54,6 +54,7 @@ static int scpi_vxi_dev_inst_new(void *priv, struct drv_context *drvc,
return SR_ERR; return SR_ERR;
} }
vxi = priv;
vxi->address = g_strdup(params[1]); vxi->address = g_strdup(params[1]);
vxi->instrument = g_strdup(params[2] ? params[2] : "inst0"); vxi->instrument = g_strdup(params[2] ? params[2] : "inst0");
@ -62,11 +63,13 @@ static int scpi_vxi_dev_inst_new(void *priv, struct drv_context *drvc,
static int scpi_vxi_open(struct sr_scpi_dev_inst *scpi) static int scpi_vxi_open(struct sr_scpi_dev_inst *scpi)
{ {
struct scpi_vxi *vxi = scpi->priv; struct scpi_vxi *vxi;
Create_LinkParms link_parms; Create_LinkParms link_parms;
Create_LinkResp *link_resp; Create_LinkResp *link_resp;
vxi->client = clnt_create(vxi->address, DEVICE_CORE, DEVICE_CORE_VERSION, "tcp"); vxi = scpi->priv;
vxi->client = clnt_create(vxi->address,
DEVICE_CORE, DEVICE_CORE_VERSION, "tcp");
if (!vxi->client) { if (!vxi->client) {
sr_err("Client creation failed for %s", vxi->address); sr_err("Client creation failed for %s", vxi->address);
return SR_ERR; return SR_ERR;
@ -78,7 +81,8 @@ static int scpi_vxi_open(struct sr_scpi_dev_inst *scpi)
link_parms.lock_timeout = VXI_DEFAULT_TIMEOUT_MS; link_parms.lock_timeout = VXI_DEFAULT_TIMEOUT_MS;
link_parms.device = (char *)"inst0"; link_parms.device = (char *)"inst0";
if (!(link_resp = create_link_1(&link_parms, vxi->client))) { link_resp = create_link_1(&link_parms, vxi->client);
if (!link_resp) {
sr_err("Link creation failed for %s", vxi->address); sr_err("Link creation failed for %s", vxi->address);
return SR_ERR; return SR_ERR;
} }
@ -95,8 +99,9 @@ static int scpi_vxi_open(struct sr_scpi_dev_inst *scpi)
static int scpi_vxi_connection_id(struct sr_scpi_dev_inst *scpi, static int scpi_vxi_connection_id(struct sr_scpi_dev_inst *scpi,
char **connection_id) char **connection_id)
{ {
struct scpi_vxi *vxi = scpi->priv; struct scpi_vxi *vxi;
vxi = scpi->priv;
*connection_id = g_strdup_printf("%s/%s", scpi->prefix, vxi->address); *connection_id = g_strdup_printf("%s/%s", scpi->prefix, vxi->address);
return SR_OK; return SR_OK;
@ -125,13 +130,14 @@ static int scpi_vxi_source_remove(struct sr_session *session, void *priv)
static int scpi_vxi_send(void *priv, const char *command) static int scpi_vxi_send(void *priv, const char *command)
{ {
struct scpi_vxi *vxi = priv; struct scpi_vxi *vxi;
Device_WriteResp *write_resp; Device_WriteResp *write_resp;
Device_WriteParms write_parms; Device_WriteParms write_parms;
unsigned long len; unsigned long len;
len = strlen(command); len = strlen(command);
vxi = priv;
write_parms.lid = vxi->link; write_parms.lid = vxi->link;
write_parms.io_timeout = VXI_DEFAULT_TIMEOUT_MS; write_parms.io_timeout = VXI_DEFAULT_TIMEOUT_MS;
write_parms.lock_timeout = VXI_DEFAULT_TIMEOUT_MS; write_parms.lock_timeout = VXI_DEFAULT_TIMEOUT_MS;
@ -139,26 +145,28 @@ static int scpi_vxi_send(void *priv, const char *command)
write_parms.data.data_len = MIN(len, vxi->max_send_size); write_parms.data.data_len = MIN(len, vxi->max_send_size);
write_parms.data.data_val = (char *)command; write_parms.data.data_val = (char *)command;
if (!(write_resp = device_write_1(&write_parms, vxi->client)) write_resp = device_write_1(&write_parms, vxi->client);
|| write_resp->error) { if (!write_resp || write_resp->error) {
sr_err("Device write failed for %s with error %ld", sr_err("Device write failed for %s with error %ld",
vxi->address, write_resp ? write_resp->error : 0); vxi->address, write_resp ? write_resp->error : 0);
return SR_ERR; return SR_ERR;
} }
if (write_resp->size < len) if (write_resp->size < len) {
sr_dbg("Only sent %lu/%lu bytes of SCPI command: '%s'.", sr_dbg("Only sent %lu/%lu bytes of SCPI command: '%s'.",
write_resp->size, len, command); write_resp->size, len, command);
else } else {
sr_spew("Successfully sent SCPI command: '%s'.", command); sr_spew("Successfully sent SCPI command: '%s'.", command);
}
return SR_OK; return SR_OK;
} }
static int scpi_vxi_read_begin(void *priv) static int scpi_vxi_read_begin(void *priv)
{ {
struct scpi_vxi *vxi = priv; struct scpi_vxi *vxi;
vxi = priv;
vxi->read_complete = 0; vxi->read_complete = 0;
return SR_OK; return SR_OK;
@ -171,10 +179,11 @@ static int scpi_vxi_read_begin(void *priv)
static int scpi_vxi_read_data(void *priv, char *buf, int maxlen) static int scpi_vxi_read_data(void *priv, char *buf, int maxlen)
{ {
struct scpi_vxi *vxi = priv; struct scpi_vxi *vxi;
Device_ReadParms read_parms; Device_ReadParms read_parms;
Device_ReadResp *read_resp; Device_ReadResp *read_resp;
vxi = priv;
read_parms.lid = vxi->link; read_parms.lid = vxi->link;
read_parms.io_timeout = VXI_DEFAULT_TIMEOUT_MS; read_parms.io_timeout = VXI_DEFAULT_TIMEOUT_MS;
read_parms.lock_timeout = VXI_DEFAULT_TIMEOUT_MS; read_parms.lock_timeout = VXI_DEFAULT_TIMEOUT_MS;
@ -182,8 +191,8 @@ static int scpi_vxi_read_data(void *priv, char *buf, int maxlen)
read_parms.termChar = 0; read_parms.termChar = 0;
read_parms.requestSize = maxlen; read_parms.requestSize = maxlen;
if (!(read_resp = device_read_1(&read_parms, vxi->client)) read_resp = device_read_1(&read_parms, vxi->client);
|| read_resp->error) { if (!read_resp || read_resp->error) {
sr_err("Device read failed for %s with error %ld", sr_err("Device read failed for %s with error %ld",
vxi->address, read_resp ? read_resp->error : 0); vxi->address, read_resp ? read_resp->error : 0);
return SR_ERR; return SR_ERR;
@ -203,13 +212,15 @@ static int scpi_vxi_read_complete(void *priv)
static int scpi_vxi_close(struct sr_scpi_dev_inst *scpi) static int scpi_vxi_close(struct sr_scpi_dev_inst *scpi)
{ {
struct scpi_vxi *vxi = scpi->priv; struct scpi_vxi *vxi;
Device_Error *dev_error; Device_Error *dev_error;
vxi = scpi->priv;
if (!vxi->client) if (!vxi->client)
return SR_ERR; return SR_ERR;
if (!(dev_error = destroy_link_1(&vxi->link, vxi->client))) { dev_error = destroy_link_1(&vxi->link, vxi->client);
if (!dev_error) {
sr_err("Link destruction failed for %s", vxi->address); sr_err("Link destruction failed for %s", vxi->address);
return SR_ERR; return SR_ERR;
} }
@ -222,8 +233,9 @@ static int scpi_vxi_close(struct sr_scpi_dev_inst *scpi)
static void scpi_vxi_free(void *priv) static void scpi_vxi_free(void *priv)
{ {
struct scpi_vxi *vxi = priv; struct scpi_vxi *vxi;
vxi = priv;
g_free(vxi->address); g_free(vxi->address);
g_free(vxi->instrument); g_free(vxi->instrument);
} }