]> sigrok.org Git - libsigrok.git/blobdiff - src/scpi/scpi.c
scpi: document callers' responsibility to free getters' allocated memory
[libsigrok.git] / src / scpi / scpi.c
index 603b15b13cd3e46687bc044160fd232cb0338df0..0f767f2a2de1c6862b61620d6e2dc0b9178c2f7d 100644 (file)
 #define SCPI_READ_RETRY_TIMEOUT_US (10 * 1000)
 
 static const char *scpi_vendors[][2] = {
-       { "HEWLETT-PACKARD", "HP" },
        { "Agilent Technologies", "Agilent" },
-       { "RIGOL TECHNOLOGIES", "Rigol" },
-       { "PHILIPS", "Philips" },
        { "CHROMA", "Chroma" },
        { "Chroma ATE", "Chroma" },
+       { "HEWLETT-PACKARD", "HP" },
+       { "Keysight Technologies", "Keysight" },
+       { "PHILIPS", "Philips" },
+       { "RIGOL TECHNOLOGIES", "Rigol" },
 };
 
 /**
@@ -99,7 +100,7 @@ static const struct sr_scpi_dev_inst *scpi_devs[] = {
 #ifdef HAVE_LIBGPIB
        &scpi_libgpib_dev,
 #endif
-#ifdef HAVE_LIBSERIALPORT
+#ifdef HAVE_SERIAL_COMM
        &scpi_serial_dev, /* Must be last as it matches any resource. */
 #endif
 };
@@ -406,6 +407,23 @@ SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi)
        return scpi->open(scpi);
 }
 
+/**
+ * Get the connection ID of the SCPI device.
+ *
+ * Callers must free the allocated memory regardless of the routine's
+ * return code. See @ref g_free().
+ *
+ * @param[in] scpi Previously initialized SCPI device structure.
+ * @param[out] connection_id Pointer where to store the connection ID.
+ *
+ * @return SR_OK on success, SR_ERR on failure.
+ */
+SR_PRIV int sr_scpi_connection_id(struct sr_scpi_dev_inst *scpi,
+               char **connection_id)
+{
+       return scpi->connection_id(scpi, connection_id);
+}
+
 /**
  * Add an event source for an SCPI device.
  *
@@ -594,9 +612,12 @@ SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi)
 /**
  * Send a SCPI command, receive the reply and store the reply 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 SCPI response.
+ * Callers must free the allocated memory regardless of the routine's
+ * return code. See @ref g_free().
+ *
+ * @param[in] scpi Previously initialised SCPI device structure.
+ * @param[in] command The SCPI command to send to the device (can be NULL).
+ * @param[out] scpi_response Pointer where to store the SCPI response.
  *
  * @return SR_OK on success, SR_ERR* on failure.
  */
@@ -604,8 +625,10 @@ SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
                               const char *command, char **scpi_response)
 {
        GString *response;
-       response = g_string_sized_new(1024);
 
+       *scpi_response = NULL;
+
+       response = g_string_sized_new(1024);
        if (sr_scpi_get_data(scpi, command, &response) != SR_OK) {
                if (response)
                        g_string_free(response, TRUE);
@@ -708,6 +731,7 @@ SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
                            const char *command, int *scpi_response)
 {
        int ret;
+       struct sr_rational ret_rational;
        char *response;
 
        response = NULL;
@@ -716,10 +740,14 @@ SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
        if (ret != SR_OK && !response)
                return ret;
 
-       if (sr_atoi(response, scpi_response) == SR_OK)
-               ret = SR_OK;
-       else
+       ret = sr_parse_rational(response, &ret_rational);
+       if (ret == SR_OK && (ret_rational.p % ret_rational.q) == 0) {
+               *scpi_response = ret_rational.p / ret_rational.q;
+       } else {
+               sr_dbg("get_int: non-integer rational=%" PRId64 "/%" PRIu64,
+                       ret_rational.p, ret_rational.q);
                ret = SR_ERR_DATA;
+       }
 
        g_free(response);
 
@@ -818,14 +846,15 @@ SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi)
  * Send a SCPI command, read the reply, parse it as comma separated list of
  * floats 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.
+ * Callers must free the allocated memory (unless it's NULL) regardless of
+ * the routine's return code. See @ref g_array_free().
+ *
+ * @param[in] scpi Previously initialised SCPI device structure.
+ * @param[in] command The SCPI command to send to the device (can be NULL).
+ * @param[out] 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.
+ *         error or upon no response.
  */
 SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
                               const char *command, GArray **scpi_response)
@@ -836,6 +865,7 @@ SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
        gchar **ptr, **tokens;
        GArray *response_array;
 
+       *scpi_response = NULL;
        response = NULL;
        tokens = NULL;
 
@@ -862,7 +892,6 @@ SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
 
        if (ret != SR_OK && response_array->len == 0) {
                g_array_free(response_array, TRUE);
-               *scpi_response = NULL;
                return SR_ERR_DATA;
        }
 
@@ -875,14 +904,15 @@ SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
  * Send a SCPI command, read the reply, parse it as comma separated list of
  * unsigned 8 bit integers 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.
+ * Callers must free the allocated memory (unless it's NULL) regardless of
+ * the routine's return code. See @ref g_array_free().
+ *
+ * @param[in] scpi Previously initialised SCPI device structure.
+ * @param[in] command The SCPI command to send to the device (can be NULL).
+ * @param[out] 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.
+ *         error or upon no response.
  */
 SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
                               const char *command, GArray **scpi_response)
@@ -892,6 +922,7 @@ SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
        gchar **ptr, **tokens;
        GArray *response_array;
 
+       *scpi_response = NULL;
        response = NULL;
        tokens = NULL;
 
@@ -918,7 +949,6 @@ 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_DATA;
        }
 
@@ -931,25 +961,29 @@ SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
  * 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.
+ * Callers must free the allocated memory (unless it's NULL) regardless of
+ * the routine's return code. See @ref g_byte_array_free().
+ *
+ * @param[in] scpi Previously initialised SCPI device structure.
+ * @param[in] command The SCPI command to send to the device (can be NULL).
+ * @param[out] 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.
+ *         error or upon no response.
  */
 SR_PRIV int sr_scpi_get_block(struct sr_scpi_dev_inst *scpi,
                               const char *command, GByteArray **scpi_response)
 {
        int ret;
        GString* response;
+       gsize oldlen;
        char buf[10];
        long llen;
        long datalen;
        gint64 timeout;
 
+       *scpi_response = NULL;
+
        g_mutex_lock(&scpi->scpi_mutex);
 
        if (command)
@@ -971,17 +1005,15 @@ SR_PRIV int sr_scpi_get_block(struct sr_scpi_dev_inst *scpi,
 
        timeout = g_get_monotonic_time() + scpi->read_timeout_us;
 
-       *scpi_response = NULL;
-
        /* Get (the first chunk of) the response. */
-       while (response->len < 2) {
+       do {
                ret = scpi_read_response(scpi, response, timeout);
                if (ret < 0) {
                        g_mutex_unlock(&scpi->scpi_mutex);
                        g_string_free(response, TRUE);
                        return ret;
                }
-       }
+       } while (response->len < 2);
 
        /*
         * SCPI protocol data blocks are preceeded with a length spec.
@@ -1028,25 +1060,33 @@ SR_PRIV int sr_scpi_get_block(struct sr_scpi_dev_inst *scpi,
        g_string_erase(response, 0, 2 + llen);
 
        /*
-        * If the initially assumed length does not cover the data block
-        * length, then re-allocate the buffer size to the now known
-        * length, and keep reading more chunks of response data.
+        * Re-allocate the buffer size to the now known length
+        * and keep reading more chunks of response data.
         */
-       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)) {
-               ret = scpi_read_response(scpi, response, timeout);
-               if (ret < 0) {
-                       g_mutex_unlock(&scpi->scpi_mutex);
-                       g_string_free(response, TRUE);
-                       return ret;
-               }
-               if (ret > 0)
-                       timeout = g_get_monotonic_time() + scpi->read_timeout_us;
+       oldlen = response->len;
+       g_string_set_size(response, datalen);
+       g_string_set_size(response, oldlen);
+
+       if (oldlen < (unsigned long)(datalen)) {
+               do {
+                       oldlen = response->len;
+                       ret = scpi_read_response(scpi, response, timeout);
+
+                       /* On timeout truncate the buffer and send the partial response
+                        * instead of getting stuck on timeouts...
+                        */
+                       if (ret == SR_ERR_TIMEOUT) {
+                               datalen = oldlen;
+                               break;
+                       }
+                       if (ret < 0) {
+                               g_mutex_unlock(&scpi->scpi_mutex);
+                               g_string_free(response, TRUE);
+                               return ret;
+                       }
+                       if (ret > 0)
+                               timeout = g_get_monotonic_time() + scpi->read_timeout_us;
+               } while (response->len < (unsigned long)(datalen));
        }
 
        g_mutex_unlock(&scpi->scpi_mutex);
@@ -1062,10 +1102,11 @@ SR_PRIV int sr_scpi_get_block(struct sr_scpi_dev_inst *scpi,
  * Send the *IDN? SCPI command, receive the reply, parse it and store the
  * reply as a sr_scpi_hw_info structure in the supplied scpi_response pointer.
  *
- * The hw_info structure must be freed by the caller via sr_scpi_hw_info_free().
+ * Callers must free the allocated memory regardless of the routine's
+ * return code. See @ref sr_scpi_hw_info_free().
  *
- * @param scpi Previously initialised SCPI device structure.
- * @param scpi_response Pointer where to store the hw_info structure.
+ * @param[in] scpi Previously initialised SCPI device structure.
+ * @param[out] scpi_response Pointer where to store the hw_info structure.
  *
  * @return SR_OK upon success, SR_ERR* on failure.
  */
@@ -1078,6 +1119,7 @@ SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
        struct sr_scpi_hw_info *hw_info;
        gchar *idn_substr;
 
+       *scpi_response = NULL;
        response = NULL;
        tokens = NULL;
 
@@ -1089,15 +1131,24 @@ SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
         * The response to a '*IDN?' is specified by the SCPI spec. It contains
         * a comma-separated list containing the manufacturer name, instrument
         * model, serial number of the instrument and the firmware version.
+        *
+        * BEWARE! Although strictly speaking a smaller field count is invalid,
+        * this implementation also accepts IDN responses with one field less,
+        * and assumes that the serial number is missing. Some GWInstek DMMs
+        * were found to do this. Keep warning about this condition, which may
+        * need more consideration later.
         */
        tokens = g_strsplit(response, ",", 0);
        num_tokens = g_strv_length(tokens);
-       if (num_tokens < 4) {
-               sr_dbg("IDN response not according to spec: %80.s.", response);
+       if (num_tokens < 3) {
+               sr_dbg("IDN response not according to spec: '%s'", response);
                g_strfreev(tokens);
                g_free(response);
                return SR_ERR_DATA;
        }
+       if (num_tokens < 4) {
+               sr_warn("Short IDN response, assume missing serial number.");
+       }
        g_free(response);
 
        hw_info = g_malloc0(sizeof(struct sr_scpi_hw_info));
@@ -1109,8 +1160,13 @@ SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
                hw_info->manufacturer = g_strstrip(g_strdup(idn_substr + 4));
 
        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]));
+       if (num_tokens < 4) {
+               hw_info->serial_number = g_strdup("Unknown");
+               hw_info->firmware_version = g_strstrip(g_strdup(tokens[2]));
+       } else {
+               hw_info->serial_number = g_strstrip(g_strdup(tokens[2]));
+               hw_info->firmware_version = g_strstrip(g_strdup(tokens[3]));
+       }
 
        g_strfreev(tokens);