]> sigrok.org Git - libsigrok.git/blobdiff - src/hardware/chronovu-la/api.c
output/csv: use intermediate time_t var, silence compiler warning
[libsigrok.git] / src / hardware / chronovu-la / api.c
index 0c94b398586629a57659310720cdfa5acc0b4e7e..d5ca278b728d999557576d291f9720bbfe491b75 100644 (file)
 #include <config.h>
 #include "protocol.h"
 
-static const uint32_t drvopts[] = {
-       SR_CONF_LOGIC_ANALYZER,
-};
+#define SCAN_EXPECTED_VENDOR 0x0403
 
 static const uint32_t scanopts[] = {
        SR_CONF_CONN,
 };
 
+static const uint32_t drvopts[] = {
+       SR_CONF_LOGIC_ANALYZER,
+};
+
 static const uint32_t devopts[] = {
        SR_CONF_LIMIT_MSEC | SR_CONF_SET,
        SR_CONF_LIMIT_SAMPLES | SR_CONF_SET | SR_CONF_LIST,
@@ -43,19 +45,15 @@ static const int32_t trigger_matches[] = {
        SR_TRIGGER_FALLING,
 };
 
-static void clear_helper(void *priv)
+static void clear_helper(struct dev_context *devc)
 {
-       struct dev_context *devc;
-
-       devc = priv;
-
        ftdi_free(devc->ftdic);
        g_free(devc->final_buf);
 }
 
 static int dev_clear(const struct sr_dev_driver *di)
 {
-       return std_dev_clear(di, clear_helper);
+       return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper);
 }
 
 static int add_device(int model, struct libusb_device_descriptor *des,
@@ -69,7 +67,6 @@ static int add_device(int model, struct libusb_device_descriptor *des,
 
        ret = SR_OK;
 
-       /* Allocate memory for our private device context. */
        devc = g_malloc0(sizeof(struct dev_context));
 
        /* Set some sane defaults. */
@@ -101,7 +98,6 @@ static int add_device(int model, struct libusb_device_descriptor *des,
        /* We now know the device, set its max. samplerate as default. */
        devc->cur_samplerate = devc->prof->max_samplerate;
 
-       /* Register the device with libsigrok. */
        sdi = g_malloc0(sizeof(struct sr_dev_inst));
        sdi->status = SR_ST_INACTIVE;
        sdi->vendor = g_strdup("ChronoVu");
@@ -129,52 +125,62 @@ err_free_devc:
 
 static GSList *scan(struct sr_dev_driver *di, GSList *options)
 {
-       int i, ret, model;
        struct drv_context *drvc;
-       GSList *devices, *conn_devices, *l;
+       GSList *devices;
+       const char *conn;
+       int ret;
+       GSList *conn_devices, *l;
+       size_t i;
        struct sr_usb_dev_inst *usb;
-       struct sr_config *src;
+       uint8_t bus, addr;
        struct libusb_device_descriptor des;
        libusb_device **devlist;
        struct libusb_device_handle *hdl;
-       const char *conn;
        char product[64], serial_num[64], connection_id[64];
+       int model;
 
        drvc = di->context;
+       devices = NULL;
 
        conn = NULL;
-       for (l = options; l; l = l->next) {
-               src = l->data;
-               switch (src->key) {
-               case SR_CONF_CONN:
-                       conn = g_variant_get_string(src->data, NULL);
-                       break;
-               }
-       }
+       (void)sr_serial_extract_options(options, &conn, NULL);
+       conn_devices = NULL;
        if (conn)
                conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
-       else
-               conn_devices = NULL;
 
-       devices = NULL;
        libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
-
        for (i = 0; devlist[i]; i++) {
+               bus = libusb_get_bus_number(devlist[i]);
+               addr = libusb_get_device_address(devlist[i]);
                if (conn) {
+                       /* Check if the connection matches the user spec. */
                        for (l = conn_devices; l; l = l->next) {
                                usb = l->data;
-                               if (usb->bus == libusb_get_bus_number(devlist[i])
-                                       && usb->address == libusb_get_device_address(devlist[i]))
+                               if (usb->bus == bus && usb->address == addr)
                                        break;
                        }
                        if (!l)
-                               /* This device matched none of the ones that
-                                * matched the conn specification. */
                                continue;
                }
 
                libusb_get_device_descriptor(devlist[i], &des);
 
+               /*
+                * In theory we'd accept any USB device with a matching
+                * product string. In practice the enumeration takes a
+                * shortcut and only inspects devices when their USB VID
+                * matches the expectation. This avoids access to flaky
+                * devices which are unrelated to measurement purposes
+                * yet cause trouble when accessed including segfaults,
+                * while libusb won't transparently handle their flaws.
+                *
+                * See https://sigrok.org/bugzilla/show_bug.cgi?id=1115
+                * and https://github.com/sigrokproject/libsigrok/pull/166
+                * for a discussion.
+                */
+               if (des.idVendor != SCAN_EXPECTED_VENDOR)
+                       continue;
+
                if ((ret = libusb_open(devlist[i], &hdl)) < 0)
                        continue;
 
@@ -198,18 +204,17 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
                        continue;
                }
 
-               usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
-
                libusb_close(hdl);
 
-               if (!strcmp(product, "ChronoVu LA8")) {
+               if (usb_get_port_path(devlist[i], connection_id, sizeof(connection_id)) < 0)
+                       continue;
+
+               if (!strcmp(product, "ChronoVu LA8"))
                        model = 0;
-               } else if (!strcmp(product, "ChronoVu LA16")) {
+               else if (!strcmp(product, "ChronoVu LA16"))
                        model = 1;
-               } else {
-                       sr_spew("Unknown iProduct string '%s'.", product);
-                       continue;
-               }
+               else
+                       continue; /* Unknown iProduct string, ignore. */
 
                sr_dbg("Found %s (%04x:%04x, %d.%d, %s).",
                       product, des.idVendor, des.idProduct,
@@ -221,7 +226,6 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
                        sr_dbg("Failed to add device: %d.", ret);
                }
        }
-
        libusb_free_device_list(devlist, 1);
        g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
 
@@ -235,7 +239,6 @@ static int dev_open(struct sr_dev_inst *sdi)
 
        devc = sdi->priv;
 
-       /* Allocate memory for the FTDI context and initialize it. */
        if (!(devc->ftdic = ftdi_new())) {
                sr_err("Failed to initialize libftdi.");
                return SR_ERR;
@@ -244,32 +247,25 @@ static int dev_open(struct sr_dev_inst *sdi)
        sr_dbg("Opening %s device (%04x:%04x).", devc->prof->modelname,
               devc->usb_vid, devc->usb_pid);
 
-       /* Open the device. */
        if ((ret = ftdi_usb_open_desc(devc->ftdic, devc->usb_vid,
                        devc->usb_pid, devc->prof->iproduct, NULL)) < 0) {
                sr_err("Failed to open FTDI device (%d): %s.",
                       ret, ftdi_get_error_string(devc->ftdic));
                goto err_ftdi_free;
        }
-       sr_dbg("Device opened successfully.");
 
-       /* Purge RX/TX buffers in the FTDI chip. */
-       if ((ret = ftdi_usb_purge_buffers(devc->ftdic)) < 0) {
+       if ((ret = PURGE_FTDI_BOTH(devc->ftdic)) < 0) {
                sr_err("Failed to purge FTDI buffers (%d): %s.",
                       ret, ftdi_get_error_string(devc->ftdic));
                goto err_ftdi_free;
        }
-       sr_dbg("FTDI buffers purged successfully.");
 
-       /* Enable flow control in the FTDI chip. */
        if ((ret = ftdi_setflowctrl(devc->ftdic, SIO_RTS_CTS_HS)) < 0) {
                sr_err("Failed to enable FTDI flow control (%d): %s.",
                       ret, ftdi_get_error_string(devc->ftdic));
                goto err_ftdi_free;
        }
-       sr_dbg("FTDI flow control enabled successfully.");
 
-       /* Wait 100ms. */
        g_usleep(100 * 1000);
 
        return SR_OK;
@@ -297,12 +293,11 @@ static int dev_close(struct sr_dev_inst *sdi)
        return (ret == 0) ? SR_OK : SR_ERR;
 }
 
-static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
-               const struct sr_channel_group *cg)
+static int config_get(uint32_t key, GVariant **data,
+       const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 {
        struct dev_context *devc;
        struct sr_usb_dev_inst *usb;
-       char str[128];
 
        (void)cg;
 
@@ -310,8 +305,7 @@ static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *s
        case SR_CONF_CONN:
                if (!sdi || !(usb = sdi->conn))
                        return SR_ERR_ARG;
-               snprintf(str, 128, "%d.%d", usb->bus, usb->address);
-               *data = g_variant_new_string(str);
+               *data = g_variant_new_printf("%d.%d", usb->bus, usb->address);
                break;
        case SR_CONF_SAMPLERATE:
                if (!sdi)
@@ -326,8 +320,8 @@ static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *s
        return SR_OK;
 }
 
-static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
-               const struct sr_channel_group *cg)
+static int config_set(uint32_t key, GVariant *data,
+       const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 {
        struct dev_context *devc;
 
@@ -341,13 +335,9 @@ static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sd
                        return SR_ERR;
                break;
        case SR_CONF_LIMIT_MSEC:
-               if (g_variant_get_uint64(data) == 0)
-                       return SR_ERR_ARG;
                devc->limit_msec = g_variant_get_uint64(data);
                break;
        case SR_CONF_LIMIT_SAMPLES:
-               if (g_variant_get_uint64(data) == 0)
-                       return SR_ERR_ARG;
                devc->limit_samples = g_variant_get_uint64(data);
                break;
        default:
@@ -357,57 +347,30 @@ static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sd
        return SR_OK;
 }
 
-static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
-               const struct sr_channel_group *cg)
+static int config_list(uint32_t key, GVariant **data,
+       const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 {
-       GVariant *gvar, *grange[2];
-       GVariantBuilder gvb;
        struct dev_context *devc;
 
-       (void)cg;
+       devc = (sdi) ? sdi->priv : NULL;
 
        switch (key) {
        case SR_CONF_SCAN_OPTIONS:
-               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
-                               scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
-               break;
        case SR_CONF_DEVICE_OPTIONS:
-               if (!sdi)
-                       *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
-                                       drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
-               else
-                       *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
-                                       devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
-               break;
+               return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
        case SR_CONF_SAMPLERATE:
-               if (!sdi)
-                       return SR_ERR_BUG;
-               devc = sdi->priv;
                cv_fill_samplerates_if_needed(sdi);
-               g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
-               gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
-                               devc->samplerates,
-                               ARRAY_SIZE(devc->samplerates),
-                               sizeof(uint64_t));
-               g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
-               *data = g_variant_builder_end(&gvb);
+               *data = std_gvar_samplerates(ARRAY_AND_SIZE(devc->samplerates));
                break;
        case SR_CONF_LIMIT_SAMPLES:
-               if (!sdi || !sdi->priv || !(devc = sdi->priv) || !devc->prof)
+               if (!devc || !devc->prof)
                        return SR_ERR_BUG;
-               grange[0] = g_variant_new_uint64(0);
-               if (devc->prof->model == CHRONOVU_LA8)
-                       grange[1] = g_variant_new_uint64(MAX_NUM_SAMPLES);
-               else
-                       grange[1] = g_variant_new_uint64(MAX_NUM_SAMPLES / 2);
-               *data = g_variant_new_tuple(grange, 2);
+               *data = std_gvar_tuple_u64(0, (devc->prof->model == CHRONOVU_LA8) ? MAX_NUM_SAMPLES : MAX_NUM_SAMPLES / 2);
                break;
        case SR_CONF_TRIGGER_MATCH:
-               if (!sdi || !sdi->priv || !(devc = sdi->priv) || !devc->prof)
+               if (!devc || !devc->prof)
                        return SR_ERR_BUG;
-               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
-                               trigger_matches, devc->prof->num_trigger_matches,
-                               sizeof(int32_t));
+               *data = std_gvar_array_i32(trigger_matches, devc->prof->num_trigger_matches);
                break;
        default:
                return SR_ERR_NA;
@@ -522,8 +485,6 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi)
                return SR_ERR;
        }
 
-       sr_dbg("Hardware acquisition started successfully.");
-
        std_session_send_df_header(sdi);
 
        /* Time when we should be done (for detecting trigger timeouts). */