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

diff --git a/src/scpi/scpi.c b/src/scpi/scpi.c
index 76044113..0efde8ba 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.
@@ -209,7 +210,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);
 }
 
 /**
@@ -351,7 +352,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,7 +376,7 @@ 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)
@@ -383,7 +384,7 @@ SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
 	char buf[256];
 	int len;
 	GString *response;
-	gint64 start;
+	gint64 laststart;
 	unsigned int elapsed_ms;
 
 	if (command)
@@ -393,7 +394,7 @@ 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("");
 
@@ -402,13 +403,15 @@ SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
 	while (!sr_scpi_read_complete(scpi)) {
 		len = sr_scpi_read_data(scpi, buf, sizeof(buf));
 		if (len < 0) {
+			sr_err("Incompletely read SCPI response.");
 			g_string_free(response, TRUE);
 			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)
-		{
+		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;
@@ -423,10 +426,10 @@ SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
 	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', length %" G_GSIZE_FORMAT ".",
+		response->str, response->len);
 
-	sr_spew("Got response: '%.70s'.", *scpi_response);
+	*scpi_response = g_string_free(response, FALSE);
 
 	return SR_OK;
 }
@@ -439,7 +442,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 +452,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 +474,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 +484,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 +506,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 +516,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 +538,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 +548,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,7 +568,7 @@ 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)
 {
@@ -576,7 +579,7 @@ SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi)
 		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 +593,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 +607,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 +624,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 +650,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 +663,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 +680,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,7 +690,7 @@ 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;
@@ -706,12 +707,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 +720,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 +735,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);