{ "Keysight Technologies", "Keysight" },
{ "PHILIPS", "Philips" },
{ "RIGOL TECHNOLOGIES", "Rigol" },
+ { "Siglent Technologies", "Siglent" },
};
/**
#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
};
{
GSList *resources, *l, *devices;
struct sr_dev_inst *sdi;
- const char *resource = NULL;
- const char *serialcomm = NULL;
+ const char *resource, *conn;
+ const char *serialcomm, *comm;
gchar **res;
unsigned i;
- for (l = options; l; l = l->next) {
- struct sr_config *src = l->data;
- switch (src->key) {
- case SR_CONF_CONN:
- resource = g_variant_get_string(src->data, NULL);
- break;
- case SR_CONF_SERIALCOMM:
- serialcomm = g_variant_get_string(src->data, NULL);
- break;
- }
- }
+ resource = NULL;
+ serialcomm = NULL;
+ (void)sr_serial_extract_options(options, &resource, &serialcomm);
devices = NULL;
for (i = 0; i < ARRAY_SIZE(scpi_devs); i++) {
- if ((resource && strcmp(resource, scpi_devs[i]->prefix))
- || !scpi_devs[i]->scan)
+ if (resource && strcmp(resource, scpi_devs[i]->prefix) != 0)
+ continue;
+ if (!scpi_devs[i]->scan)
continue;
resources = scpi_devs[i]->scan(drvc);
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))) {
+ if (!res[0]) {
+ g_strfreev(res);
+ continue;
+ }
+ conn = res[0];
+ comm = serialcomm ? : res[1];
+ sdi = sr_scpi_scan_resource(drvc, conn, comm, probe_device);
+ if (sdi) {
devices = g_slist_append(devices, sdi);
sdi->connection_id = g_strdup(l->data);
}
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.
*
/**
* 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.
*/
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);
const char *command, int *scpi_response)
{
int ret;
+ struct sr_rational ret_rational;
char *response;
response = NULL;
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);
* 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)
float tmp;
char *response;
gchar **ptr, **tokens;
+ size_t token_count;
GArray *response_array;
- response = NULL;
- tokens = NULL;
+ *scpi_response = NULL;
+ response = NULL;
ret = sr_scpi_get_string(scpi, command, &response);
if (ret != SR_OK && !response)
return ret;
tokens = g_strsplit(response, ",", 0);
- ptr = tokens;
+ token_count = g_strv_length(tokens);
- response_array = g_array_sized_new(TRUE, FALSE, sizeof(float), 256);
+ response_array = g_array_sized_new(TRUE, FALSE,
+ sizeof(float), token_count + 1);
+ ptr = tokens;
while (*ptr) {
- if (sr_atof_ascii(*ptr, &tmp) == SR_OK)
- response_array = g_array_append_val(response_array,
- tmp);
- else
+ ret = sr_atof_ascii(*ptr, &tmp);
+ if (ret != SR_OK) {
ret = SR_ERR_DATA;
-
+ break;
+ }
+ response_array = g_array_append_val(response_array, tmp);
ptr++;
}
g_strfreev(tokens);
if (ret != SR_OK && response_array->len == 0) {
g_array_free(response_array, TRUE);
- *scpi_response = NULL;
return SR_ERR_DATA;
}
* 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)
int tmp, ret;
char *response;
gchar **ptr, **tokens;
+ size_t token_count;
GArray *response_array;
- response = NULL;
- tokens = NULL;
+ *scpi_response = NULL;
+ response = NULL;
ret = sr_scpi_get_string(scpi, command, &response);
if (ret != SR_OK && !response)
return ret;
tokens = g_strsplit(response, ",", 0);
- ptr = tokens;
+ token_count = g_strv_length(tokens);
- response_array = g_array_sized_new(TRUE, FALSE, sizeof(uint8_t), 256);
+ response_array = g_array_sized_new(TRUE, FALSE,
+ sizeof(uint8_t), token_count + 1);
+ ptr = tokens;
while (*ptr) {
- if (sr_atoi(*ptr, &tmp) == SR_OK)
- response_array = g_array_append_val(response_array,
- tmp);
- else
+ ret = sr_atoi(*ptr, &tmp);
+ if (ret != SR_OK) {
ret = SR_ERR_DATA;
-
+ break;
+ }
+ response_array = g_array_append_val(response_array, tmp);
ptr++;
}
g_strfreev(tokens);
if (response_array->len == 0) {
g_array_free(response_array, TRUE);
- *scpi_response = NULL;
return SR_ERR_DATA;
}
* 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)
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.
buf[0] = response->str[1];
buf[1] = '\0';
ret = sr_atol(buf, &llen);
- if ((ret != SR_OK) || (llen == 0)) {
+ /*
+ * The form "#0..." is legal, and does not mean "empty response",
+ * but means that the number of data bytes is not known (or was
+ * not communicated) at this time. Instead the block ends at an
+ * "END MESSAGE" termination sequence. Which translates to active
+ * EOI while a text line termination is sent (CR or LF, and this
+ * text line termination is not part of the block's data value).
+ * Since this kind of #0... response is considered rare, and
+ * depends on specific support in physical transports underneath
+ * the SCPI layer, let's flag the condition and bail out with an
+ * error here, until it's found to be a genuine issue in the field.
+ *
+ * The SCPI 1999.0 specification (see page 220 and following in
+ * the "HCOPy" description) references IEEE 488.2, especially
+ * section 8.7.9 for DEFINITE LENGTH and section 8.7.10 for
+ * INDEFINITE LENGTH ARBITRARY BLOCK RESPONSE DATA. The latter
+ * with a leading "#0" length and a trailing "NL^END" marker.
+ */
+ if (ret == SR_OK && !llen) {
+ sr_err("unsupported INDEFINITE LENGTH ARBITRARY BLOCK RESPONSE");
+ ret = SR_ERR_NA;
+ }
+ if (ret != SR_OK) {
g_mutex_unlock(&scpi->scpi_mutex);
g_string_free(response, TRUE);
return ret;
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);
* 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.
*/
struct sr_scpi_hw_info *hw_info;
gchar *idn_substr;
+ *scpi_response = NULL;
response = NULL;
tokens = NULL;
* 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));
+ hw_info = g_malloc0(sizeof(*hw_info));
idn_substr = g_strstr_len(tokens[0], -1, "IDN ");
if (idn_substr == NULL)
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);
projects / libsigrok.git / blobdiff