]> sigrok.org Git - libsigrok.git/blobdiff - src/hardware/kingst-la2016/api.c
kingst-la2016: add my copyright for recent improvements
[libsigrok.git] / src / hardware / kingst-la2016 / api.c
index 2d90a9f9caf6029b38d7b1ff87ce069a50761374..93bc4d668132c2452ebbdbf9ed4e2178926ab807 100644 (file)
@@ -1,6 +1,7 @@
 /*
  * This file is part of the libsigrok project.
  *
+ * Copyright (C) 2022 Gerhard Sittig <gerhard.sittig@gmx.net>
  * Copyright (C) 2020 Florian Schmidt <schmidt_florian@gmx.de>
  * Copyright (C) 2013 Marcus Comstedt <marcus@mc.pp.se>
  * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
@@ -48,13 +49,19 @@ static const uint32_t devopts[] = {
        SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
        SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
        SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
+#if WITH_THRESHOLD_DEVCFG
        SR_CONF_VOLTAGE_THRESHOLD | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
-       SR_CONF_LOGIC_THRESHOLD | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
-       SR_CONF_LOGIC_THRESHOLD_CUSTOM | SR_CONF_GET | SR_CONF_SET,
+#endif
        SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
        SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
 };
 
+static const uint32_t devopts_cg_logic[] = {
+#if !WITH_THRESHOLD_DEVCFG
+       SR_CONF_VOLTAGE_THRESHOLD | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
+#endif
+};
+
 static const uint32_t devopts_cg_pwm[] = {
        SR_CONF_ENABLED | SR_CONF_GET | SR_CONF_SET,
        SR_CONF_OUTPUT_FREQUENCY | SR_CONF_GET | SR_CONF_SET,
@@ -143,32 +150,38 @@ static const uint64_t rates_100mhz[] = {
        SR_MHZ(100),
 };
 
-static const float logic_threshold_value[] = {
-       1.58,
-       2.5,
-       1.165,
-       1.5,
-       1.25,
-       0.9,
-       0.75,
-       0.60,
-       0.45,
+/*
+ * Only list a few discrete voltages, to form a useful set which covers
+ * most logic families. Too many choices can make some applications use
+ * a slider again. Which may lack a scale for the current value, and
+ * leave users without feedback what the currently used value might be.
+ */
+static const double threshold_ranges[][2] = {
+       { 0.4, 0.4, },
+       { 0.6, 0.6, },
+       { 0.9, 0.9, },
+       { 1.2, 1.2, },
+       { 1.4, 1.4, }, /* Default, 1.4V, index 4. */
+       { 2.0, 2.0, },
+       { 2.5, 2.5, },
+       { 4.0, 4.0, },
 };
+#define LOGIC_THRESHOLD_IDX_DFLT       4
 
-static const char *logic_threshold[] = {
-       "TTL 5V",
-       "CMOS 5V",
-       "CMOS 3.3V",
-       "CMOS 3.0V",
-       "CMOS 2.5V",
-       "CMOS 1.8V",
-       "CMOS 1.5V",
-       "CMOS 1.2V",
-       "CMOS 0.9V",
-       "USER",
-};
+static double threshold_voltage(const struct sr_dev_inst *sdi, double *high)
+{
+       struct dev_context *devc;
+       size_t idx;
+       double voltage;
 
-#define LOGIC_THRESHOLD_IDX_USER       (ARRAY_SIZE(logic_threshold) - 1)
+       devc = sdi->priv;
+       idx = devc->threshold_voltage_idx;
+       voltage = threshold_ranges[idx][0];
+       if (high)
+               *high = threshold_ranges[idx][1];
+
+       return voltage;
+}
 
 /* Convenience. Release an allocated devc from error paths. */
 static void kingst_la2016_free_devc(struct dev_context *devc)
@@ -505,9 +518,10 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
                 * this device.
                 */
                devc->fw_uploaded = 0;
+               devc->usb_pid = pid;
                if (des.iProduct != LA2016_IPRODUCT_INDEX) {
                        sr_info("Uploading MCU firmware to '%s'.", conn_id);
-                       ret = la2016_upload_firmware(sdi, ctx, dev, pid);
+                       ret = la2016_upload_firmware(sdi, ctx, dev, FALSE);
                        if (ret != SR_OK) {
                                sr_err("MCU firmware upload failed.");
                                kingst_la2016_free_sdi(sdi);
@@ -517,6 +531,13 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
                        usb->address = 0xff;
                        renum_devices = g_slist_append(renum_devices, sdi);
                        continue;
+               } else {
+                       ret = la2016_upload_firmware(sdi, NULL, NULL, TRUE);
+                       if (ret != SR_OK) {
+                               sr_err("MCU firmware filename check failed.");
+                               kingst_la2016_free_sdi(sdi);
+                               continue;
+                       }
                }
 
                /*
@@ -605,9 +626,8 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
                sr_sw_limits_init(&devc->sw_limits);
                devc->sw_limits.limit_samples = 0;
                devc->capture_ratio = 50;
-               devc->cur_samplerate = devc->model->samplerate;
-               devc->threshold_voltage_idx = 0;
-               devc->threshold_voltage = logic_threshold_value[devc->threshold_voltage_idx];
+               devc->samplerate = devc->model->samplerate;
+               devc->threshold_voltage_idx = LOGIC_THRESHOLD_IDX_DFLT;
                if  (ARRAY_SIZE(devc->pwm_setting) >= 1) {
                        devc->pwm_setting[0].enabled = FALSE;
                        devc->pwm_setting[0].freq = SR_KHZ(1);
@@ -660,7 +680,8 @@ static int dev_close(struct sr_dev_inst *sdi)
        if (!usb->devhdl)
                return SR_ERR_BUG;
 
-       la2016_deinit_hardware(sdi);
+       if (WITH_DEINIT_IN_CLOSE)
+               la2016_deinit_hardware(sdi);
 
        sr_info("Closing device on %d.%d (logical) / %s (physical) interface %d.",
                usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
@@ -731,8 +752,10 @@ static int config_get(uint32_t key, GVariant **data,
        size_t logic_idx, analog_idx;
        struct pwm_setting *pwm;
        struct sr_usb_dev_inst *usb;
-       double rounded;
-       const char *label;
+       double voltage, rounded;
+
+       (void)rounded;
+       (void)voltage;
 
        if (!sdi)
                return SR_ERR_ARG;
@@ -745,8 +768,17 @@ static int config_get(uint32_t key, GVariant **data,
 
        /* Handle requests for the "Logic" channel group. */
        if (cg && cg_type == SR_CHANNEL_LOGIC) {
-               /* TODO */
-               return SR_ERR_NA;
+               switch (key) {
+#if !WITH_THRESHOLD_DEVCFG
+               case SR_CONF_VOLTAGE_THRESHOLD:
+                       voltage = threshold_voltage(sdi, NULL);
+                       *data = std_gvar_tuple_double(voltage, voltage);
+                       break;
+#endif /* WITH_THRESHOLD_DEVCFG */
+               default:
+                       return SR_ERR_NA;
+               }
+               return SR_OK;
        }
 
        /* Handle requests for the "PWMx" channel groups. */
@@ -774,7 +806,7 @@ static int config_get(uint32_t key, GVariant **data,
                *data = g_variant_new_printf("%d.%d", usb->bus, usb->address);
                break;
        case SR_CONF_SAMPLERATE:
-               *data = g_variant_new_uint64(devc->cur_samplerate);
+               *data = g_variant_new_uint64(devc->samplerate);
                break;
        case SR_CONF_LIMIT_SAMPLES:
        case SR_CONF_LIMIT_MSEC:
@@ -782,18 +814,12 @@ static int config_get(uint32_t key, GVariant **data,
        case SR_CONF_CAPTURE_RATIO:
                *data = g_variant_new_uint64(devc->capture_ratio);
                break;
+#if WITH_THRESHOLD_DEVCFG
        case SR_CONF_VOLTAGE_THRESHOLD:
-               rounded = (int)(devc->threshold_voltage / 0.1) * 0.1;
-               *data = std_gvar_tuple_double(rounded, rounded + 0.1);
-               return SR_OK;
-       case SR_CONF_LOGIC_THRESHOLD:
-               label = logic_threshold[devc->threshold_voltage_idx];
-               *data = g_variant_new_string(label);
-               break;
-       case SR_CONF_LOGIC_THRESHOLD_CUSTOM:
-               *data = g_variant_new_double(devc->threshold_voltage);
+               voltage = threshold_voltage(sdi, NULL);
+               *data = std_gvar_tuple_double(voltage, voltage);
                break;
-
+#endif /* WITH_THRESHOLD_DEVCFG */
        default:
                return SR_ERR_NA;
        }
@@ -809,7 +835,6 @@ static int config_set(uint32_t key, GVariant *data,
        size_t logic_idx, analog_idx;
        struct pwm_setting *pwm;
        double value_f;
-       double low, high;
        int idx;
 
        devc = sdi->priv;
@@ -821,8 +846,20 @@ static int config_set(uint32_t key, GVariant *data,
 
        /* Handle requests for the "Logic" channel group. */
        if (cg && cg_type == SR_CHANNEL_LOGIC) {
-               /* TODO */
-               return SR_ERR_NA;
+               switch (key) {
+#if !WITH_THRESHOLD_DEVCFG
+               case SR_CONF_LOGIC_THRESHOLD:
+                       idx = std_double_tuple_idx(data,
+                               ARRAY_AND_SIZE(threshold_ranges));
+                       if (idx < 0)
+                               return SR_ERR_ARG;
+                       devc->threshold_voltage_idx = idx;
+                       break;
+#endif /* WITH_THRESHOLD_DEVCFG */
+               default:
+                       return SR_ERR_NA;
+               }
+               return SR_OK;
        }
 
        /* Handle requests for the "PWMx" channel groups. */
@@ -861,7 +898,7 @@ static int config_set(uint32_t key, GVariant *data,
 
        switch (key) {
        case SR_CONF_SAMPLERATE:
-               devc->cur_samplerate = g_variant_get_uint64(data);
+               devc->samplerate = g_variant_get_uint64(data);
                break;
        case SR_CONF_LIMIT_SAMPLES:
        case SR_CONF_LIMIT_MSEC:
@@ -869,24 +906,15 @@ static int config_set(uint32_t key, GVariant *data,
        case SR_CONF_CAPTURE_RATIO:
                devc->capture_ratio = g_variant_get_uint64(data);
                break;
+#if WITH_THRESHOLD_DEVCFG
        case SR_CONF_VOLTAGE_THRESHOLD:
-               g_variant_get(data, "(dd)", &low, &high);
-               devc->threshold_voltage = (low + high) / 2.0;
-               devc->threshold_voltage_idx = LOGIC_THRESHOLD_IDX_USER;
-               break;
-       case SR_CONF_LOGIC_THRESHOLD: {
-               idx = std_str_idx(data, ARRAY_AND_SIZE(logic_threshold));
+               idx = std_double_tuple_idx(data,
+                       ARRAY_AND_SIZE(threshold_ranges));
                if (idx < 0)
                        return SR_ERR_ARG;
-               if (idx != LOGIC_THRESHOLD_IDX_USER) {
-                       devc->threshold_voltage = logic_threshold_value[idx];
-               }
                devc->threshold_voltage_idx = idx;
                break;
-       }
-       case SR_CONF_LOGIC_THRESHOLD_CUSTOM:
-               devc->threshold_voltage = g_variant_get_double(data);
-               break;
+#endif /* WITH_THRESHOLD_DEVCFG */
        default:
                return SR_ERR_NA;
        }
@@ -910,8 +938,23 @@ static int config_list(uint32_t key, GVariant **data,
 
        /* Handle requests for the "Logic" channel group. */
        if (cg && cg_type == SR_CHANNEL_LOGIC) {
-               /* TODO */
-               return SR_ERR_NA;
+               switch (key) {
+               case SR_CONF_DEVICE_OPTIONS:
+                       if (ARRAY_SIZE(devopts_cg_logic) == 0)
+                               return SR_ERR_NA;
+                       *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
+                               devopts_cg_logic, ARRAY_SIZE(devopts_cg_logic),
+                               sizeof(devopts_cg_logic[0]));
+                       break;
+#if !WITH_THRESHOLD_DEVCFG
+               case SR_CONF_VOLTAGE_THRESHOLD:
+                       *data = std_gvar_thresholds(ARRAY_AND_SIZE(threshold_ranges));
+                       break;
+#endif /* WITH_THRESHOLD_DEVCFG */
+               default:
+                       return SR_ERR_NA;
+               }
+               return SR_OK;
        }
 
        /* Handle requests for the "PWMx" channel groups. */
@@ -940,23 +983,22 @@ static int config_list(uint32_t key, GVariant **data,
                        *data = std_gvar_samplerates(ARRAY_AND_SIZE(rates_500mhz));
                else if (devc->model->samplerate == SR_MHZ(200))
                        *data = std_gvar_samplerates(ARRAY_AND_SIZE(rates_200mhz));
-               else
+               else if (devc->model->samplerate == SR_MHZ(100))
                        *data = std_gvar_samplerates(ARRAY_AND_SIZE(rates_100mhz));
+               else
+                       return SR_ERR_BUG;
                break;
        case SR_CONF_LIMIT_SAMPLES:
                *data = std_gvar_tuple_u64(0, LA2016_NUM_SAMPLES_MAX);
                break;
+#if WITH_THRESHOLD_DEVCFG
        case SR_CONF_VOLTAGE_THRESHOLD:
-               *data = std_gvar_min_max_step_thresholds(
-                       LA2016_THR_VOLTAGE_MIN,
-                       LA2016_THR_VOLTAGE_MAX, 0.1);
+               *data = std_gvar_thresholds(ARRAY_AND_SIZE(threshold_ranges));
                break;
+#endif /* WITH_THRESHOLD_DEVCFG */
        case SR_CONF_TRIGGER_MATCH:
                *data = std_gvar_array_i32(ARRAY_AND_SIZE(trigger_matches));
                break;
-       case SR_CONF_LOGIC_THRESHOLD:
-               *data = g_variant_new_strv(ARRAY_AND_SIZE(logic_threshold));
-               break;
        default:
                return SR_ERR_NA;
        }
@@ -970,6 +1012,8 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi)
        struct drv_context *drvc;
        struct sr_context *ctx;
        struct dev_context *devc;
+       size_t unitsize;
+       double voltage;
        int ret;
 
        di = sdi->driver;
@@ -978,17 +1022,27 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi)
        devc = sdi->priv;
 
        if (!devc->feed_queue) {
+               if (devc->model->channel_count == 32)
+                       unitsize = sizeof(uint32_t);
+               else if (devc->model->channel_count == 16)
+                       unitsize = sizeof(uint16_t);
+               else
+                       return SR_ERR_ARG;
                devc->feed_queue = feed_queue_logic_alloc(sdi,
-                       LA2016_CONVBUFFER_SIZE, sizeof(uint16_t));
+                       LA2016_CONVBUFFER_SIZE, unitsize);
                if (!devc->feed_queue) {
                        sr_err("Cannot allocate buffer for session feed.");
                        return SR_ERR_MALLOC;
                }
+               devc->packets_per_chunk = TRANSFER_PACKET_LENGTH;
+               devc->packets_per_chunk--;
+               devc->packets_per_chunk /= unitsize + sizeof(uint8_t);
        }
 
        sr_sw_limits_acquisition_start(&devc->sw_limits);
 
-       ret = la2016_setup_acquisition(sdi);
+       voltage = threshold_voltage(sdi, NULL);
+       ret = la2016_setup_acquisition(sdi, voltage);
        if (ret != SR_OK) {
                feed_queue_logic_free(devc->feed_queue);
                devc->feed_queue = NULL;