X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=src%2Fscpi%2Fscpi.c;h=e54427ff0b3445c107a0e46ee24cb1cb2fb4ac97;hb=bee2b0168c087676c1b365861d8c2d4714afa9b9;hp=7604411384a9fcec385cffad37ec9b18673c37c7;hpb=91219afc75c9aa1d0c5e2da5c03343c1e43eb6df;p=libsigrok.git

diff --git a/src/scpi/scpi.c b/src/scpi/scpi.c
index 76044113..e54427ff 100644
--- a/src/scpi/scpi.c
+++ b/src/scpi/scpi.c
@@ -17,16 +17,17 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#include "libsigrok.h"
-#include "libsigrok-internal.h"
-
+#include <config.h>
 #include <glib.h>
 #include <string.h>
+#include <libsigrok/libsigrok.h>
+#include "libsigrok-internal.h"
+#include "scpi.h"
 
 #define LOG_PREFIX "scpi"
 
 #define SCPI_READ_RETRIES 100
-#define SCPI_READ_RETRY_TIMEOUT 10000
+#define SCPI_READ_RETRY_TIMEOUT_US (10 * 1000)
 
 /**
  * Parse a string representation of a boolean-like value into a gboolean.
@@ -109,12 +110,16 @@ static struct sr_dev_inst *sr_scpi_scan_resource(struct drv_context *drvc,
 		return NULL;
 	};
 
-	if ((sdi = probe_device(scpi)))
-		return sdi;
+	sdi = probe_device(scpi);
 
 	sr_scpi_close(scpi);
-	sr_scpi_free(scpi);
-	return NULL;
+
+	if (sdi)
+		sdi->status = SR_ST_INACTIVE;
+	else
+		sr_scpi_free(scpi);
+
+	return sdi;
 }
 
 SR_PRIV GSList *sr_scpi_scan(struct drv_context *drvc, GSList *options,
@@ -209,7 +214,7 @@ SR_PRIV struct sr_scpi_dev_inst *scpi_dev_inst_new(struct drv_context *drvc,
  */
 SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi)
 {
-	return scpi->open(scpi->priv);
+	return scpi->open(scpi);
 }
 
 /**
@@ -291,8 +296,10 @@ SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
 	va_end(args_copy);
 
 	/* Allocate buffer and write out command. */
-	buf = g_malloc(len + 1);
+	buf = g_malloc0(len + 2);
 	vsprintf(buf, format, args);
+	if (buf[len - 1] != '\n')
+		buf[len] = '\n';
 
 	/* Send command. */
 	ret = scpi->send(scpi->priv, buf);
@@ -351,7 +358,7 @@ SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi)
  */
 SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi)
 {
-	return scpi->close(scpi->priv);
+	return scpi->close(scpi);
 }
 
 /**
@@ -375,16 +382,45 @@ SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi)
  * @param command The SCPI command to send to the device (can be NULL).
  * @param scpi_response Pointer where to store the SCPI response.
  *
- * @return SR_OK on success, SR_ERR on failure.
+ * @return SR_OK on success, SR_ERR* on failure.
  */
 SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
 			       const char *command, char **scpi_response)
 {
-	char buf[256];
+	GString *response;
+	response = g_string_sized_new(1024);
+
+	if (sr_scpi_get_data(scpi, command, &response) != SR_OK) {
+		if (response)
+			g_string_free(response, TRUE);
+		return SR_ERR;
+	}
+
+	/* Get rid of trailing linefeed if present */
+	if (response->len >= 1 && response->str[response->len - 1] == '\n')
+		g_string_truncate(response, response->len - 1);
+
+	/* Get rid of trailing carriage return if present */
+	if (response->len >= 1 && response->str[response->len - 1] == '\r')
+		g_string_truncate(response, response->len - 1);
+
+	sr_spew("Got response: '%.70s', length %" G_GSIZE_FORMAT ".",
+		response->str, response->len);
+
+	*scpi_response = g_string_free(response, FALSE);
+
+	return SR_OK;
+}
+
+SR_PRIV int sr_scpi_get_data(struct sr_scpi_dev_inst *scpi,
+			     const char *command, GString **scpi_response)
+{
 	int len;
 	GString *response;
-	gint64 start;
+	gint64 laststart;
 	unsigned int elapsed_ms;
+	unsigned int offset = 0;
+	int space;
 
 	if (command)
 		if (sr_scpi_send(scpi, command) != SR_OK)
@@ -393,41 +429,34 @@ SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
 	if (sr_scpi_read_begin(scpi) != SR_OK)
 		return SR_ERR;
 
-	start = g_get_monotonic_time();
+	laststart = g_get_monotonic_time();
 
-	response = g_string_new("");
+	response = *scpi_response;
 
-	*scpi_response = NULL;
+	offset = response->len;
 
 	while (!sr_scpi_read_complete(scpi)) {
-		len = sr_scpi_read_data(scpi, buf, sizeof(buf));
+		space = response->allocated_len - response->len;
+		if (space < 128) {
+			g_string_set_size(response, response->len + 1024);
+			space = response->allocated_len - response->len;
+		}
+		len = sr_scpi_read_data(scpi, &response->str[offset], space);
 		if (len < 0) {
-			g_string_free(response, TRUE);
+			sr_err("Incompletely read SCPI response.");
 			return SR_ERR;
+		} else if (len > 0) {
+		        laststart = g_get_monotonic_time();
 		}
-		g_string_append_len(response, buf, len);
-		elapsed_ms = (g_get_monotonic_time() - start) / 1000;
-		if (elapsed_ms >= scpi->read_timeout_ms)
-		{
+		offset += len;
+		g_string_set_size(response, offset);
+		elapsed_ms = (g_get_monotonic_time() - laststart) / 1000;
+		if (elapsed_ms >= scpi->read_timeout_ms) {
 			sr_err("Timed out waiting for SCPI response.");
-			g_string_free(response, TRUE);
 			return SR_ERR;
 		}
 	}
 
-	/* Get rid of trailing linefeed if present */
-	if (response->len >= 1 && response->str[response->len - 1] == '\n')
-		g_string_truncate(response, response->len - 1);
-
-	/* Get rid of trailing carriage return if present */
-	if (response->len >= 1 && response->str[response->len - 1] == '\r')
-		g_string_truncate(response, response->len - 1);
-
-	*scpi_response = response->str;
-	g_string_free(response, FALSE);
-
-	sr_spew("Got response: '%.70s'.", *scpi_response);
-
 	return SR_OK;
 }
 
@@ -439,7 +468,7 @@ SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
  * @param command The SCPI command to send to the device (can be NULL).
  * @param scpi_response Pointer where to store the parsed result.
  *
- * @return SR_OK on success, SR_ERR on failure.
+ * @return SR_OK on success, SR_ERR* on failure.
  */
 SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
 			     const char *command, gboolean *scpi_response)
@@ -449,14 +478,14 @@ SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
 
 	response = NULL;
 
-	if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
-		if (!response)
-			return SR_ERR;
+	ret = sr_scpi_get_string(scpi, command, &response);
+	if (ret != SR_OK && !response)
+		return ret;
 
 	if (parse_strict_bool(response, scpi_response) == SR_OK)
 		ret = SR_OK;
 	else
-		ret = SR_ERR;
+		ret = SR_ERR_DATA;
 
 	g_free(response);
 
@@ -471,7 +500,7 @@ SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
  * @param command The SCPI command to send to the device (can be NULL).
  * @param scpi_response Pointer where to store the parsed result.
  *
- * @return SR_OK on success, SR_ERR on failure.
+ * @return SR_OK on success, SR_ERR* on failure.
  */
 SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
 			    const char *command, int *scpi_response)
@@ -481,14 +510,14 @@ SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
 
 	response = NULL;
 
-	if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
-		if (!response)
-			return SR_ERR;
+	ret = sr_scpi_get_string(scpi, command, &response);
+	if (ret != SR_OK && !response)
+		return ret;
 
 	if (sr_atoi(response, scpi_response) == SR_OK)
 		ret = SR_OK;
 	else
-		ret = SR_ERR;
+		ret = SR_ERR_DATA;
 
 	g_free(response);
 
@@ -503,7 +532,7 @@ SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
  * @param command The SCPI command to send to the device (can be NULL).
  * @param scpi_response Pointer where to store the parsed result.
  *
- * @return SR_OK on success, SR_ERR on failure.
+ * @return SR_OK on success, SR_ERR* on failure.
  */
 SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
 			      const char *command, float *scpi_response)
@@ -513,14 +542,14 @@ SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
 
 	response = NULL;
 
-	if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
-		if (!response)
-			return SR_ERR;
+	ret = sr_scpi_get_string(scpi, command, &response);
+	if (ret != SR_OK && !response)
+		return ret;
 
 	if (sr_atof_ascii(response, scpi_response) == SR_OK)
 		ret = SR_OK;
 	else
-		ret = SR_ERR;
+		ret = SR_ERR_DATA;
 
 	g_free(response);
 
@@ -535,7 +564,7 @@ SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
  * @param command The SCPI command to send to the device (can be NULL).
  * @param scpi_response Pointer where to store the parsed result.
  *
- * @return SR_OK on success, SR_ERR on failure.
+ * @return SR_OK on success, SR_ERR* on failure.
  */
 SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
 			       const char *command, double *scpi_response)
@@ -545,14 +574,14 @@ SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
 
 	response = NULL;
 
-	if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
-		if (!response)
-			return SR_ERR;
+	ret = sr_scpi_get_string(scpi, command, &response);
+	if (ret != SR_OK && !response)
+		return ret;
 
 	if (sr_atod(response, scpi_response) == SR_OK)
 		ret = SR_OK;
 	else
-		ret = SR_ERR;
+		ret = SR_ERR_DATA;
 
 	g_free(response);
 
@@ -565,18 +594,18 @@ SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
  *
  * @param scpi Previously initialised SCPI device structure.
  *
- * @return SR_OK on success, SR_ERR on failure.
+ * @return SR_OK on success, SR_ERR* on failure.
  */
 SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi)
 {
 	unsigned int i;
 	gboolean opc;
 
-	for (i = 0; i < SCPI_READ_RETRIES; ++i) {
+	for (i = 0; i < SCPI_READ_RETRIES; i++) {
 		sr_scpi_get_bool(scpi, SCPI_CMD_OPC, &opc);
 		if (opc)
 			return SR_OK;
-		g_usleep(SCPI_READ_RETRY_TIMEOUT);
+		g_usleep(SCPI_READ_RETRY_TIMEOUT_US);
 	}
 
 	return SR_ERR;
@@ -590,7 +619,7 @@ SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi)
  * @param command The SCPI command to send to the device (can be NULL).
  * @param scpi_response Pointer where to store the parsed result.
  *
- * @return SR_OK upon successfully parsing all values, SR_ERR upon a parsing
+ * @return SR_OK upon successfully parsing all values, SR_ERR* upon a parsing
  *         error or upon no response. The allocated response must be freed by
  *         the caller in the case of an SR_OK as well as in the case of
  *         parsing error.
@@ -604,13 +633,12 @@ SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
 	gchar **ptr, **tokens;
 	GArray *response_array;
 
-	ret = SR_OK;
 	response = NULL;
 	tokens = NULL;
 
-	if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
-		if (!response)
-			return SR_ERR;
+	ret = sr_scpi_get_string(scpi, command, &response);
+	if (ret != SR_OK && !response)
+		return ret;
 
 	tokens = g_strsplit(response, ",", 0);
 	ptr = tokens;
@@ -622,17 +650,17 @@ SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
 			response_array = g_array_append_val(response_array,
 							    tmp);
 		else
-			ret = SR_ERR;
+			ret = SR_ERR_DATA;
 
 		ptr++;
 	}
 	g_strfreev(tokens);
 	g_free(response);
 
-	if (ret == SR_ERR && response_array->len == 0) {
+	if (ret != SR_OK && response_array->len == 0) {
 		g_array_free(response_array, TRUE);
 		*scpi_response = NULL;
-		return SR_ERR;
+		return SR_ERR_DATA;
 	}
 
 	*scpi_response = response_array;
@@ -648,7 +676,7 @@ SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
  * @param command The SCPI command to send to the device (can be NULL).
  * @param scpi_response Pointer where to store the parsed result.
  *
- * @return SR_OK upon successfully parsing all values, SR_ERR upon a parsing
+ * @return SR_OK upon successfully parsing all values, SR_ERR* upon a parsing
  *         error or upon no response. The allocated response must be freed by
  *         the caller in the case of an SR_OK as well as in the case of
  *         parsing error.
@@ -661,13 +689,12 @@ SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
 	gchar **ptr, **tokens;
 	GArray *response_array;
 
-	ret = SR_OK;
 	response = NULL;
 	tokens = NULL;
 
-	if (sr_scpi_get_string(scpi, command, &response) != SR_OK)
-		if (!response)
-			return SR_ERR;
+	ret = sr_scpi_get_string(scpi, command, &response);
+	if (ret != SR_OK && !response)
+		return ret;
 
 	tokens = g_strsplit(response, ",", 0);
 	ptr = tokens;
@@ -679,7 +706,7 @@ SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
 			response_array = g_array_append_val(response_array,
 							    tmp);
 		else
-			ret = SR_ERR;
+			ret = SR_ERR_DATA;
 
 		ptr++;
 	}
@@ -689,13 +716,86 @@ SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
 	if (response_array->len == 0) {
 		g_array_free(response_array, TRUE);
 		*scpi_response = NULL;
-		return SR_ERR;
+		return SR_ERR_DATA;
 	}
 
 	*scpi_response = response_array;
 
 	return ret;
 }
+/**
+ * Send a SCPI command, read the reply, parse it as binary data with a
+ * "definite length block" header and store the as an result in scpi_response.
+ *
+ * @param scpi Previously initialised SCPI device structure.
+ * @param command The SCPI command to send to the device (can be NULL).
+ * @param scpi_response Pointer where to store the parsed result.
+ *
+ * @return SR_OK upon successfully parsing all values, SR_ERR* upon a parsing
+ *         error or upon no response. The allocated response must be freed by
+ *         the caller in the case of an SR_OK as well as in the case of
+ *         parsing error.
+ */
+SR_PRIV int sr_scpi_get_block(struct sr_scpi_dev_inst *scpi,
+			       const char *command, GByteArray **scpi_response)
+{
+	int ret;
+	GString* response;
+
+	char buf[10] = { 0 };
+	long llen;
+	long datalen;
+
+	response = g_string_sized_new(1024);
+	*scpi_response = NULL;
+
+	ret = sr_scpi_get_data(scpi, command, &response);
+	if (ret != SR_OK) {
+		g_string_free(response, TRUE);
+		return ret;
+	}
+
+	if (response->str[0] != '#') {
+		g_string_free(response, TRUE);
+		return SR_ERR_DATA;
+	}
+
+	buf[0] = response->str[1];
+	ret = sr_atol(buf, &llen);
+	if ((ret != SR_OK) || (llen == 0)) {
+		g_string_free(response, TRUE);
+		return ret;
+	}
+
+	memcpy(buf, &response->str[2], llen);
+	ret = sr_atol(buf, &datalen);
+	if ((ret != SR_OK) || (datalen == 0)) {
+		g_string_free(response, TRUE);
+		return ret;
+	}
+
+	// strip header
+	g_string_erase(response, 0, 2 + llen);
+
+	if (response->len < (unsigned long)(datalen)) {
+		int oldlen = response->len;
+		g_string_set_size(response, datalen);
+		g_string_set_size(response, oldlen);
+	}
+
+	while (response->len < (unsigned long)(datalen)) {
+		if (sr_scpi_get_data(scpi, NULL, &response) != SR_OK) {
+			g_string_free(response, TRUE);
+			return ret;
+		}
+	}
+
+	*scpi_response = g_byte_array_new_take(
+		(guint8*)g_string_free(response, FALSE), datalen);
+
+	return ret;
+}
+
 
 /**
  * Send the *IDN? SCPI command, receive the reply, parse it and store the
@@ -706,12 +806,12 @@ SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
  * @param scpi Previously initialised SCPI device structure.
  * @param scpi_response Pointer where to store the hw_info structure.
  *
- * @return SR_OK upon success, SR_ERR on failure.
+ * @return SR_OK upon success, SR_ERR* on failure.
  */
 SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
 			      struct sr_scpi_hw_info **scpi_response)
 {
-	int num_tokens;
+	int num_tokens, ret;
 	char *response;
 	gchar **tokens;
 	struct sr_scpi_hw_info *hw_info;
@@ -719,9 +819,9 @@ SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
 	response = NULL;
 	tokens = NULL;
 
-	if (sr_scpi_get_string(scpi, SCPI_CMD_IDN, &response) != SR_OK)
-		if (!response)
-			return SR_ERR;
+	ret = sr_scpi_get_string(scpi, SCPI_CMD_IDN, &response);
+	if (ret != SR_OK && !response)
+		return ret;
 
 	sr_info("Got IDN string: '%s'", response);
 
@@ -734,19 +834,19 @@ SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
 
 	for (num_tokens = 0; tokens[num_tokens] != NULL; num_tokens++);
 
-	if (num_tokens != 4) {
+	if (num_tokens < 4) {
 		sr_dbg("IDN response not according to spec: %80.s.", response);
 		g_strfreev(tokens);
 		g_free(response);
-		return SR_ERR;
+		return SR_ERR_DATA;
 	}
 	g_free(response);
 
 	hw_info = g_malloc0(sizeof(struct sr_scpi_hw_info));
-	hw_info->manufacturer = g_strdup(tokens[0]);
-	hw_info->model = g_strdup(tokens[1]);
-	hw_info->serial_number = g_strdup(tokens[2]);
-	hw_info->firmware_version = g_strdup(tokens[3]);
+	hw_info->manufacturer = g_strstrip(g_strdup(tokens[0]));
+	hw_info->model = g_strstrip(g_strdup(tokens[1]));
+	hw_info->serial_number = g_strstrip(g_strdup(tokens[2]));
+	hw_info->firmware_version = g_strstrip(g_strdup(tokens[3]));
 
 	g_strfreev(tokens);