]> sigrok.org Git - libsigrok.git/blobdiff - hardware/common/scpi.c
build: Portability fixes.
[libsigrok.git] / hardware / common / scpi.c
index 78a06fd1918eed01475f66f14fdd8874ab81467c..829a4c8cf1828bb141ce13c159767173cc12c151 100644 (file)
@@ -65,6 +65,133 @@ static int parse_strict_bool(const char *str, gboolean *ret)
        return SR_ERR;
 }
 
+SR_PRIV extern const struct sr_scpi_dev_inst scpi_serial_dev;
+SR_PRIV extern const struct sr_scpi_dev_inst scpi_tcp_raw_dev;
+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;
+
+static const struct sr_scpi_dev_inst *scpi_devs[] = {
+       &scpi_tcp_raw_dev,
+       &scpi_tcp_rigol_dev,
+#ifdef HAVE_LIBUSB_1_0
+       &scpi_usbtmc_libusb_dev,
+#endif
+#if HAVE_RPC
+       &scpi_vxi_dev,
+#endif
+#ifdef HAVE_LIBREVISA
+       &scpi_visa_dev,
+#endif
+#ifdef HAVE_LIBSERIALPORT
+       &scpi_serial_dev,  /* must be last as it matches any resource */
+#endif
+};
+
+static struct sr_dev_inst *sr_scpi_scan_resource(struct drv_context *drvc,
+               const char *resource, const char *serialcomm,
+               struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi))
+{
+       struct sr_scpi_dev_inst *scpi;
+       struct sr_dev_inst *sdi;
+
+       if (!(scpi = scpi_dev_inst_new(drvc, resource, serialcomm)))
+               return NULL;
+
+       if (sr_scpi_open(scpi) != SR_OK) {
+               sr_info("Couldn't open SCPI device.");
+               sr_scpi_free(scpi);
+               return NULL;
+       };
+
+       if ((sdi = probe_device(scpi)))
+               return sdi;
+
+       sr_scpi_close(scpi);
+       sr_scpi_free(scpi);
+       return NULL;
+}
+
+SR_PRIV GSList *sr_scpi_scan(struct drv_context *drvc, GSList *options,
+               struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi))
+{
+       GSList *resources, *l, *devices;
+       struct sr_dev_inst *sdi;
+       const char *resource = NULL;
+       const char *serialcomm = NULL;
+       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;
+               }
+       }
+
+       devices = NULL;
+       for (i = 0; i < ARRAY_SIZE(scpi_devs); i++) {
+               if ((resource && strcmp(resource, scpi_devs[i]->prefix))
+                   || !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)))
+                               devices = g_slist_append(devices, sdi);
+                       g_strfreev(res);
+               }
+               g_slist_free_full(resources, g_free);
+       }
+
+       if (!devices && resource) {
+               sdi = sr_scpi_scan_resource(drvc, resource, serialcomm, probe_device);
+               devices = g_slist_append(NULL, sdi);
+       }
+
+       /* Tack a copy of the newly found devices onto the driver list. */
+       if (devices)
+               drvc->instances = g_slist_concat(drvc->instances, g_slist_copy(devices));
+
+       return devices;
+}
+
+SR_PRIV struct sr_scpi_dev_inst *scpi_dev_inst_new(struct drv_context *drvc,
+               const char *resource, const char *serialcomm)
+{
+       struct sr_scpi_dev_inst *scpi = NULL;
+       const struct sr_scpi_dev_inst *scpi_dev;
+       gchar **params;
+       unsigned i;
+
+       for (i = 0; i < ARRAY_SIZE(scpi_devs); i++) {
+               scpi_dev = scpi_devs[i];
+               if (!strncmp(resource, scpi_dev->prefix, strlen(scpi_dev->prefix))) {
+                       sr_dbg("Opening %s device %s.", scpi_dev->name, resource);
+                       scpi = g_malloc(sizeof(*scpi));
+                       *scpi = *scpi_dev;
+                       scpi->priv = g_malloc0(scpi->priv_size);
+                       params = g_strsplit(resource, "/", 0);
+                       if (scpi->dev_inst_new(scpi->priv, drvc, resource,
+                                              params, serialcomm) != SR_OK) {
+                               sr_scpi_free(scpi);
+                               scpi = NULL;
+                       }
+                       g_strfreev(params);
+                       break;
+               }
+       }
+
+       return scpi;
+}
+
 /**
  * Open SCPI device.
  *
@@ -89,10 +216,11 @@ SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi)
  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
  *         SR_ERR_MALLOC upon memory allocation errors.
  */
-SR_PRIV int sr_scpi_source_add(struct sr_scpi_dev_inst *scpi, int events,
-               int timeout, sr_receive_data_callback_t cb, void *cb_data)
+SR_PRIV int sr_scpi_source_add(struct sr_session *session,
+               struct sr_scpi_dev_inst *scpi, int events, int timeout,
+               sr_receive_data_callback cb, void *cb_data)
 {
-       return scpi->source_add(scpi->priv, events, timeout, cb, cb_data);
+       return scpi->source_add(session, scpi->priv, events, timeout, cb, cb_data);
 }
 
 /**
@@ -104,9 +232,10 @@ SR_PRIV int sr_scpi_source_add(struct sr_scpi_dev_inst *scpi, int events,
  *         SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
  *         internal errors.
  */
-SR_PRIV int sr_scpi_source_remove(struct sr_scpi_dev_inst *scpi)
+SR_PRIV int sr_scpi_source_remove(struct sr_session *session,
+               struct sr_scpi_dev_inst *scpi)
 {
-       return scpi->source_remove(scpi->priv);
+       return scpi->source_remove(session, scpi->priv);
 }
 
 /**
@@ -165,20 +294,15 @@ SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
 }
 
 /**
- * Receive an SCPI reply and store the reply in scpi_response.
+ * Begin receiving an SCPI reply.
  *
  * @param scpi Previously initialised SCPI device structure.
- * @param scpi_response Pointer where to store the SCPI response.
  *
- * @return SR_OK upon fetching a full SCPI response, SR_ERR upon fetching an
- *         incomplete or no response. The allocated response must be freed by
- *         the caller in the case of a full response as well in the case of
- *         an incomplete.
+ * @return SR_OK on success, SR_ERR on failure.
  */
-SR_PRIV int sr_scpi_receive(struct sr_scpi_dev_inst *scpi,
-                       char **scpi_response)
+SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi)
 {
-       return scpi->receive(scpi->priv, scpi_response);
+       return scpi->read_begin(scpi->priv);
 }
 
 /**
@@ -190,10 +314,22 @@ SR_PRIV int sr_scpi_receive(struct sr_scpi_dev_inst *scpi,
  *
  * @return Number of bytes read, or SR_ERR upon failure.
  */
-SR_PRIV int sr_scpi_read(struct sr_scpi_dev_inst *scpi,
+SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst *scpi,
                        char *buf, int maxlen)
 {
-       return scpi->read(scpi->priv, buf, maxlen);
+       return scpi->read_data(scpi->priv, buf, maxlen);
+}
+
+/**
+ * Check whether a complete SCPI response has been received.
+ *
+ * @param scpi Previously initialised SCPI device structure.
+ *
+ * @return 1 if complete, 0 otherwise.
+ */
+SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi)
+{
+       return scpi->read_complete(scpi->priv);
 }
 
 /**
@@ -218,6 +354,7 @@ SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi)
 SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi)
 {
        scpi->free(scpi->priv);
+       g_free(scpi->priv);
        g_free(scpi);
 }
 
@@ -228,19 +365,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 upon fetching a full SCPI response, SR_ERR upon fetching an
- *         incomplete or no response. The allocated response must be freed by
- *         the caller in the case of a full response as well in the case of
- *         an incomplete.
+ * @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];
+       int len;
+       GString *response;
+
        if (command)
                if (sr_scpi_send(scpi, command) != SR_OK)
                        return SR_ERR;
 
-       return sr_scpi_receive(scpi, scpi_response);
+       if (sr_scpi_read_begin(scpi) != SR_OK)
+               return SR_ERR;
+
+       response = g_string_new("");
+
+       *scpi_response = NULL;
+
+       while (!sr_scpi_read_complete(scpi)) {
+               len = sr_scpi_read_data(scpi, buf, sizeof(buf));
+               if (len < 0) {
+                       g_string_free(response, TRUE);
+                       return SR_ERR;
+               }
+               g_string_append_len(response, buf, len);
+       }
+
+       /* 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);
+
+       sr_spew("Got response: '%.70s'.", *scpi_response);
+
+       return SR_OK;
 }
 
 /**
@@ -329,7 +492,7 @@ SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
                if (!response)
                        return SR_ERR;
 
-       if (sr_atof(response, scpi_response) == SR_OK)
+       if (sr_atof_ascii(response, scpi_response) == SR_OK)
                ret = SR_OK;
        else
                ret = SR_ERR;
@@ -430,7 +593,7 @@ SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
        response_array = g_array_sized_new(TRUE, FALSE, sizeof(float), 256);
 
        while (*ptr) {
-               if (sr_atof(*ptr, &tmp) == SR_OK)
+               if (sr_atof_ascii(*ptr, &tmp) == SR_OK)
                        response_array = g_array_append_val(response_array,
                                                            tmp);
                else
@@ -535,6 +698,8 @@ SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
                if (!response)
                        return SR_ERR;
 
+       sr_info("Got IDN string: '%s'", response);
+
        /*
         * The response to a '*IDN?' is specified by the SCPI spec. It contains
         * a comma-separated list containing the manufacturer name, instrument