X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=src%2Fscpi%2Fscpi.c;h=0efde8bab7b9c11f8d2cec00ee48f1afd0ecac4f;hb=e57057aee778e723da572a6b5e2bd01526cc7beb;hp=84db9daca358ea793fdb4b438504da0a4932083c;hpb=bb2a4ed407fe2986dce404244b4f2096536e2dac;p=libsigrok.git diff --git a/src/scpi/scpi.c b/src/scpi/scpi.c index 84db9dac..0efde8ba 100644 --- a/src/scpi/scpi.c +++ b/src/scpi/scpi.c @@ -17,16 +17,17 @@ * along with this program. If not, see . */ -#include "libsigrok.h" -#include "libsigrok-internal.h" - +#include #include #include +#include +#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. @@ -71,7 +72,7 @@ SR_PRIV extern const struct sr_scpi_dev_inst scpi_tcp_rigol_dev; SR_PRIV extern const struct sr_scpi_dev_inst scpi_usbtmc_libusb_dev; SR_PRIV extern const struct sr_scpi_dev_inst scpi_vxi_dev; SR_PRIV extern const struct sr_scpi_dev_inst scpi_visa_dev; -SR_PRIV extern const struct sr_scpi_dev_inst scpi_gpib_dev; +SR_PRIV extern const struct sr_scpi_dev_inst scpi_libgpib_dev; static const struct sr_scpi_dev_inst *scpi_devs[] = { &scpi_tcp_raw_dev, @@ -86,7 +87,7 @@ static const struct sr_scpi_dev_inst *scpi_devs[] = { &scpi_visa_dev, #endif #ifdef HAVE_LIBGPIB - &scpi_gpib_dev, + &scpi_libgpib_dev, #endif #ifdef HAVE_LIBSERIALPORT &scpi_serial_dev, /* must be last as it matches any resource */ @@ -148,8 +149,10 @@ SR_PRIV GSList *sr_scpi_scan(struct drv_context *drvc, GSList *options, for (l = resources; l; l = l->next) { res = g_strsplit(l->data, ":", 2); if (res[0] && (sdi = sr_scpi_scan_resource(drvc, res[0], - serialcomm ? serialcomm : res[1], probe_device))) + serialcomm ? serialcomm : res[1], probe_device))) { devices = g_slist_append(devices, sdi); + sdi->connection_id = g_strdup(l->data); + } g_strfreev(res); } g_slist_free_full(resources, g_free); @@ -157,7 +160,8 @@ SR_PRIV GSList *sr_scpi_scan(struct drv_context *drvc, GSList *options, if (!devices && resource) { sdi = sr_scpi_scan_resource(drvc, resource, serialcomm, probe_device); - devices = g_slist_append(NULL, sdi); + if (sdi) + devices = g_slist_append(NULL, sdi); } /* Tack a copy of the newly found devices onto the driver list. */ @@ -182,6 +186,7 @@ SR_PRIV struct sr_scpi_dev_inst *scpi_dev_inst_new(struct drv_context *drvc, scpi = g_malloc(sizeof(*scpi)); *scpi = *scpi_dev; scpi->priv = g_malloc0(scpi->priv_size); + scpi->read_timeout_ms = 1000; params = g_strsplit(resource, "/", 0); if (scpi->dev_inst_new(scpi->priv, drvc, resource, params, serialcomm) != SR_OK) { @@ -205,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); } /** @@ -347,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); } /** @@ -371,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) @@ -379,6 +384,8 @@ SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi, char buf[256]; int len; GString *response; + gint64 laststart; + unsigned int elapsed_ms; if (command) if (sr_scpi_send(scpi, command) != SR_OK) @@ -387,6 +394,8 @@ SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi, if (sr_scpi_read_begin(scpi) != SR_OK) return SR_ERR; + laststart = g_get_monotonic_time(); + response = g_string_new(""); *scpi_response = NULL; @@ -394,20 +403,33 @@ 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() - 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); - *scpi_response = response->str; - g_string_free(response, FALSE); + /* 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); - sr_spew("Got response: '%.70s'.", *scpi_response); + *scpi_response = g_string_free(response, FALSE); return SR_OK; } @@ -420,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) @@ -430,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); @@ -452,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) @@ -462,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); @@ -484,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) @@ -494,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); @@ -516,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) @@ -526,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); @@ -546,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) { @@ -557,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; @@ -571,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. @@ -585,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; @@ -603,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; @@ -629,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. @@ -642,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; @@ -660,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++; } @@ -670,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; @@ -687,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; @@ -700,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); @@ -715,24 +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_try_malloc(sizeof(struct sr_scpi_hw_info)); - if (!hw_info) { - g_strfreev(tokens); - return SR_ERR_MALLOC; - } - - 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 = g_malloc0(sizeof(struct sr_scpi_hw_info)); + 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);