]> sigrok.org Git - libsigrok.git/blobdiff - src/hardware/hantek-6xxx/api.c
drivers: Factor out std_*_idx*().
[libsigrok.git] / src / hardware / hantek-6xxx / api.c
index 1bc0dbff776e4b129084d4e3c665d80a975dc4c8..8d0d280d6ab2434e0f9ec49deeecc900715aa450 100644 (file)
@@ -18,6 +18,7 @@
  */
 
 #include <config.h>
+#include <math.h>
 #include "protocol.h"
 
 /* Max time in ms before we want to check on USB events */
@@ -35,10 +36,10 @@ static const uint32_t drvopts[] = {
 
 static const uint32_t devopts[] = {
        SR_CONF_CONN | SR_CONF_GET,
-       SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
-       SR_CONF_NUM_VDIV | SR_CONF_GET,
        SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
        SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
+       SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
+       SR_CONF_NUM_VDIV | SR_CONF_GET,
 };
 
 static const uint32_t devopts_cg[] = {
@@ -50,18 +51,29 @@ static const char *channel_names[] = {
        "CH1", "CH2",
 };
 
-static const char *coupling[] = {
+static const char *dc_coupling[] = {
+       "DC",
+};
+
+static const char *acdc_coupling[] = {
        "AC", "DC",
 };
 
 static const struct hantek_6xxx_profile dev_profiles[] = {
        {
-               0x04b4, 0x6022, 0x04b5, 0x6022,
-               "Hantek", "6022BE", "hantek-6022be.fw",
+               0x04b4, 0x6022, 0x1d50, 0x608e, 0x0001,
+               "Hantek", "6022BE", "fx2lafw-hantek-6022be.fw",
+               ARRAY_AND_SIZE(dc_coupling), FALSE,
        },
        {
-               0x8102, 0x8102, 0x1D50, 0x608E,
-               "Sainsmart", "DDS120", "sainsmart-dds120.fw",
+               0x8102, 0x8102, 0x1d50, 0x608e, 0x0002,
+               "Sainsmart", "DDS120", "fx2lafw-sainsmart-dds120.fw",
+               ARRAY_AND_SIZE(acdc_coupling), TRUE,
+       },
+       {
+               0x04b4, 0x602a, 0x1d50, 0x608e, 0x0003,
+               "Hantek", "6022BL", "fx2lafw-hantek-6022bl.fw",
+               ARRAY_AND_SIZE(dc_coupling), FALSE,
        },
        ALL_ZERO
 };
@@ -74,18 +86,13 @@ static const uint64_t vdivs[][2] = {
        VDIV_VALUES
 };
 
-SR_PRIV struct sr_dev_driver hantek_6xxx_driver_info;
-
 static int read_channel(const struct sr_dev_inst *sdi, uint32_t amount);
 
-static int dev_acquisition_stop(struct sr_dev_inst *sdi);
-
 static struct sr_dev_inst *hantek_6xxx_dev_new(const struct hantek_6xxx_profile *prof)
 {
        struct sr_dev_inst *sdi;
        struct sr_channel *ch;
        struct sr_channel_group *cg;
-       struct drv_context *drvc;
        struct dev_context *devc;
        unsigned int i;
 
@@ -93,7 +100,6 @@ static struct sr_dev_inst *hantek_6xxx_dev_new(const struct hantek_6xxx_profile
        sdi->status = SR_ST_INITIALIZING;
        sdi->vendor = g_strdup(prof->vendor);
        sdi->model = g_strdup(prof->model);
-       sdi->driver = &hantek_6xxx_driver_info;
 
        for (i = 0; i < ARRAY_SIZE(channel_names); i++) {
                ch = sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, TRUE, channel_names[i]);
@@ -110,6 +116,9 @@ static struct sr_dev_inst *hantek_6xxx_dev_new(const struct hantek_6xxx_profile
                devc->voltage[i] = DEFAULT_VOLTAGE;
                devc->coupling[i] = DEFAULT_COUPLING;
        }
+       devc->coupling_vals = prof->coupling_vals;
+       devc->coupling_tab_size = prof->coupling_tab_size;
+       devc->has_coupling = prof->has_coupling;
 
        devc->sample_buf = NULL;
        devc->sample_buf_write = 0;
@@ -120,8 +129,6 @@ static struct sr_dev_inst *hantek_6xxx_dev_new(const struct hantek_6xxx_profile
        devc->samplerate = DEFAULT_SAMPLERATE;
 
        sdi->priv = devc;
-       drvc = sdi->driver->context;
-       drvc->instances = g_slist_append(drvc->instances, sdi);
 
        return sdi;
 }
@@ -149,18 +156,14 @@ static int configure_channels(const struct sr_dev_inst *sdi)
        return SR_OK;
 }
 
-static void clear_dev_context(void *priv)
+static void clear_helper(struct dev_context *devc)
 {
-       struct dev_context *devc;
-
-       devc = priv;
        g_slist_free(devc->enabled_channels);
-       g_free(devc);
 }
 
 static int dev_clear(const struct sr_dev_driver *di)
 {
-       return std_dev_clear(di, clear_dev_context);
+       return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper);
 }
 
 static GSList *scan(struct sr_dev_driver *di, GSList *options)
@@ -217,7 +220,7 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
                usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
 
                prof = NULL;
-               for (j = 0; j < (int)ARRAY_SIZE(dev_profiles); j++) {
+               for (j = 0; dev_profiles[j].orig_vid; j++) {
                        if (des.idVendor == dev_profiles[j].orig_vid
                                && des.idProduct == dev_profiles[j].orig_pid) {
                                /* Device matches the pre-firmware profile. */
@@ -238,7 +241,8 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
                                                libusb_get_bus_number(devlist[i]), 0xff, NULL);
                                break;
                        } else if (des.idVendor == dev_profiles[j].fw_vid
-                               && des.idProduct == dev_profiles[j].fw_pid) {
+                               && des.idProduct == dev_profiles[j].fw_pid
+                               && des.bcdDevice == dev_profiles[j].fw_prod_ver) {
                                /* Device matches the post-firmware profile. */
                                prof = &dev_profiles[j];
                                sr_dbg("Found a %s %s.", prof->vendor, prof->model);
@@ -259,7 +263,7 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
        }
        libusb_free_device_list(devlist, 1);
 
-       return devices;
+       return std_scan_complete(di, devices);
 }
 
 static int dev_open(struct sr_dev_inst *sdi)
@@ -304,7 +308,7 @@ static int dev_open(struct sr_dev_inst *sdi)
        err = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
        if (err != 0) {
                sr_err("Unable to claim interface: %s.",
-                          libusb_error_name(err));
+                       libusb_error_name(err));
                return SR_ERR;
        }
 
@@ -318,12 +322,11 @@ static int dev_close(struct sr_dev_inst *sdi)
        return SR_OK;
 }
 
-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];
        const uint64_t *vdiv;
        int ch_idx;
 
@@ -356,8 +359,7 @@ static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *s
                                /* Device still needs to re-enumerate after firmware
                                 * upload, so we don't know its (future) address. */
                                return SR_ERR;
-                       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;
                default:
                        return SR_ERR_NA;
@@ -375,7 +377,8 @@ static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *s
                        *data = g_variant_new("(tt)", vdiv[0], vdiv[1]);
                        break;
                case SR_CONF_COUPLING:
-                       *data = g_variant_new_string(coupling[devc->coupling[ch_idx]]);
+                       *data = g_variant_new_string((devc->coupling[ch_idx] \
+                                       == COUPLING_DC) ? "DC" : "AC");
                        break;
                }
        }
@@ -383,19 +386,12 @@ 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;
-       uint64_t p, q;
-       int tmp_int, ch_idx, ret;
-       unsigned int i;
-       const char *tmp_str;
-
-       if (sdi->status != SR_ST_ACTIVE)
-               return SR_ERR_DEV_CLOSED;
+       int ch_idx, idx;
 
-       ret = SR_OK;
        devc = sdi->priv;
        if (!cg) {
                switch (key) {
@@ -410,8 +406,7 @@ static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sd
                        devc->limit_samples = g_variant_get_uint64(data);
                        break;
                default:
-                       ret = SR_ERR_NA;
-                       break;
+                       return SR_ERR_NA;
                }
        } else {
                if (sdi->channel_groups->data == cg)
@@ -422,74 +417,39 @@ static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sd
                        return SR_ERR_ARG;
                switch (key) {
                case SR_CONF_VDIV:
-                       g_variant_get(data, "(tt)", &p, &q);
-                       tmp_int = -1;
-                       for (i = 0; i < ARRAY_SIZE(vdivs); i++) {
-                               if (vdivs[i][0] == p && vdivs[i][1] == q) {
-                                       tmp_int = i;
-                                       break;
-                               }
-                       }
-                       if (tmp_int >= 0) {
-                               devc->voltage[ch_idx] = tmp_int;
-                               hantek_6xxx_update_vdiv(sdi);
-                       } else
-                               ret = SR_ERR_ARG;
+                       if ((idx = std_u64_tuple_idx(data, ARRAY_AND_SIZE(vdivs))) < 0)
+                               return SR_ERR_ARG;
+                       devc->voltage[ch_idx] = idx;
+                       hantek_6xxx_update_vdiv(sdi);
                        break;
                case SR_CONF_COUPLING:
-                       tmp_str = g_variant_get_string(data, NULL);
-                       for (i = 0; coupling[i]; i++) {
-                               if (!strcmp(tmp_str, coupling[i])) {
-                                       devc->coupling[ch_idx] = i;
-                                       break;
-                               }
-                       }
-                       if (coupling[i] == 0)
-                               ret = SR_ERR_ARG;
+                       if ((idx = std_str_idx(data, devc->coupling_vals,
+                                               devc->coupling_tab_size)) < 0)
+                               return SR_ERR_ARG;
+                       devc->coupling[ch_idx] = idx;
                        break;
                default:
-                       ret = SR_ERR_NA;
-                       break;
+                       return SR_ERR_NA;
                }
        }
 
-       return ret;
+       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 *tuple, *rational[2];
-       GVariantBuilder gvb;
-       unsigned int i;
-       GVariant *gvar;
-
-       if (key == SR_CONF_SCAN_OPTIONS) {
-               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
-                       scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
-               return SR_OK;
-       } else if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
-               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
-                       drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
-               return SR_OK;
-       }
+       struct dev_context *devc;
 
-       if (!sdi)
-               return SR_ERR_ARG;
+       devc = (sdi) ? sdi->priv : NULL;
 
        if (!cg) {
                switch (key) {
+               case SR_CONF_SCAN_OPTIONS:
                case SR_CONF_DEVICE_OPTIONS:
-                       *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:
-                       g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
-                       gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
-                               samplerates, ARRAY_SIZE(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(samplerates));
                        break;
                default:
                        return SR_ERR_NA;
@@ -497,21 +457,13 @@ static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *
        } else {
                switch (key) {
                case SR_CONF_DEVICE_OPTIONS:
-                       *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
-                               devopts_cg, ARRAY_SIZE(devopts_cg), sizeof(uint32_t));
+                       *data = std_gvar_array_u32(ARRAY_AND_SIZE(devopts_cg));
                        break;
                case SR_CONF_COUPLING:
-                       *data = g_variant_new_strv(coupling, ARRAY_SIZE(coupling));
+                       *data = g_variant_new_strv(devc->coupling_vals, devc->coupling_tab_size);
                        break;
                case SR_CONF_VDIV:
-                       g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
-                       for (i = 0; i < ARRAY_SIZE(vdivs); i++) {
-                               rational[0] = g_variant_new_uint64(vdivs[i][0]);
-                               rational[1] = g_variant_new_uint64(vdivs[i][1]);
-                               tuple = g_variant_new_tuple(rational, 2);
-                               g_variant_builder_add_value(&gvb, tuple);
-                       }
-                       *data = g_variant_builder_end(&gvb);
+                       *data = std_gvar_tuple_array(ARRAY_AND_SIZE(vdivs));
                        break;
                default:
                        return SR_ERR_NA;
@@ -525,7 +477,7 @@ static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *
 static uint32_t data_amount(const struct sr_dev_inst *sdi)
 {
        struct dev_context *devc = sdi->priv;
-       uint32_t data_left;
+       uint32_t data_left, data_left_2, i;
        int32_t time_left;
 
        if (devc->limit_msec) {
@@ -537,66 +489,77 @@ static uint32_t data_amount(const struct sr_dev_inst *sdi)
                data_left = devc->samplerate * NUM_CHANNELS;
        }
 
-       data_left += MIN_PACKET_SIZE; /* Driver does not handle small buffers. */
+       /* Round up to nearest power of two. */
+       for (i = MIN_PACKET_SIZE; i < data_left; i *= 2)
+               ;
+       data_left_2 = i;
 
-       sr_spew("data_amount %u", data_left);
+       sr_spew("data_amount: %u (rounded to power of 2: %u)", data_left, data_left_2);
 
-       return data_left;
+       return data_left_2;
 }
 
 static void send_chunk(struct sr_dev_inst *sdi, unsigned char *buf,
                int num_samples)
 {
        struct sr_datafeed_packet packet;
-       struct sr_datafeed_analog_old analog;
+       struct sr_datafeed_analog analog;
+       struct sr_analog_encoding encoding;
+       struct sr_analog_meaning meaning;
+       struct sr_analog_spec spec;
        struct dev_context *devc = sdi->priv;
-       int num_channels, data_offset, i;
+       GSList *channels = devc->enabled_channels;
 
-       const float ch1_bit = RANGE(0) / 255;
-       const float ch2_bit = RANGE(1) / 255;
-       const float ch1_center = RANGE(0) / 2;
-       const float ch2_center = RANGE(1) / 2;
+       const float ch_bit[] = { RANGE(0) / 255, RANGE(1) / 255 };
+       const float ch_center[] = { RANGE(0) / 2, RANGE(1) / 2 };
 
-       const gboolean ch1_ena = !!devc->ch_enabled[0];
-       const gboolean ch2_ena = !!devc->ch_enabled[1];
+       sr_analog_init(&analog, &encoding, &meaning, &spec, 0);
 
-       num_channels = (ch1_ena && ch2_ena) ? 2 : 1;
-       packet.type = SR_DF_ANALOG_OLD;
+       packet.type = SR_DF_ANALOG;
        packet.payload = &analog;
 
-       analog.channels = devc->enabled_channels;
        analog.num_samples = num_samples;
-       analog.mq = SR_MQ_VOLTAGE;
-       analog.unit = SR_UNIT_VOLT;
-       analog.mqflags = 0;
+       analog.meaning->mq = SR_MQ_VOLTAGE;
+       analog.meaning->unit = SR_UNIT_VOLT;
+       analog.meaning->mqflags = 0;
 
-       analog.data = g_try_malloc(analog.num_samples * sizeof(float) * num_channels);
+       analog.data = g_try_malloc(num_samples * sizeof(float));
        if (!analog.data) {
                sr_err("Analog data buffer malloc failed.");
                devc->dev_state = STOPPING;
                return;
        }
 
-       data_offset = 0;
-       for (i = 0; i < num_samples; i++) {
-               /*
-                * The device always sends data for both channels. If a channel
-                * is disabled, it contains a copy of the enabled channel's
-                * data. However, we only send the requested channels to
-                * the bus.
-                *
-                * Voltage values are encoded as a value 0-255, where the
-                * value is a point in the range represented by the vdiv
-                * setting. There are 10 vertical divs, so e.g. 500mV/div
-                * represents 5V peak-to-peak where 0 = -2.5V and 255 = +2.5V.
-                */
-               if (ch1_ena)
-                       analog.data[data_offset++] = (ch1_bit * *(buf + i * 2) - ch1_center);
-               if (ch2_ena)
-                       analog.data[data_offset++] = (ch2_bit * *(buf + i * 2 + 1) - ch2_center);
-       }
+       for (int ch = 0; ch < 2; ch++) {
+               if (!devc->ch_enabled[ch])
+                       continue;
+
+               float vdivlog = log10f(ch_bit[ch]);
+               int digits = -(int)vdivlog + (vdivlog < 0.0);
+               analog.encoding->digits = digits;
+               analog.spec->spec_digits = digits;
+               analog.meaning->channels = g_slist_append(NULL, channels->data);
+
+               for (int i = 0; i < num_samples; i++) {
+                       /*
+                        * The device always sends data for both channels. If a channel
+                        * is disabled, it contains a copy of the enabled channel's
+                        * data. However, we only send the requested channels to
+                        * the bus.
+                        *
+                        * Voltage values are encoded as a value 0-255, where the
+                        * value is a point in the range represented by the vdiv
+                        * setting. There are 10 vertical divs, so e.g. 500mV/div
+                        * represents 5V peak-to-peak where 0 = -2.5V and 255 = +2.5V.
+                        */
+                       ((float *)analog.data)[i] = ch_bit[ch] * *(buf + i * 2 + ch) - ch_center[ch];
+               }
+
+               sr_session_send(sdi, &packet);
+               g_slist_free(analog.meaning->channels);
 
-       sr_session_send(sdi, &packet);
+               channels = channels->next;
+       }
        g_free(analog.data);
 }
 
@@ -684,7 +647,7 @@ static void LIBUSB_CALL receive_transfer(struct libusb_transfer *transfer)
                        PRIu64 " <= %" PRIu64, devc->limit_samples,
                        devc->samp_received);
                send_data(sdi, devc->sample_buf, devc->limit_samples);
-               sdi->driver->dev_acquisition_stop(sdi);
+               sr_dev_acquisition_stop(sdi);
        } else if (devc->limit_msec && (g_get_monotonic_time() -
                        devc->aq_started) / 1000 >= devc->limit_msec) {
                sr_info("Requested time limit reached, stopping. %d <= %d",
@@ -693,7 +656,7 @@ static void LIBUSB_CALL receive_transfer(struct libusb_transfer *transfer)
                send_data(sdi, devc->sample_buf, devc->samp_received);
                g_free(devc->sample_buf);
                devc->sample_buf = NULL;
-               sdi->driver->dev_acquisition_stop(sdi);
+               sr_dev_acquisition_stop(sdi);
        } else {
                read_channel(sdi, data_amount(sdi));
        }
@@ -745,7 +708,7 @@ static int handle_event(int fd, int revents, void *cb_data)
                 */
                usb_source_remove(sdi->session, drvc->sr_ctx);
 
-               std_session_send_df_end(sdi, LOG_PREFIX);
+               std_session_send_df_end(sdi);
 
                devc->dev_state = IDLE;
 
@@ -761,9 +724,6 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi)
        struct sr_dev_driver *di = sdi->driver;
        struct drv_context *drvc = di->context;
 
-       if (sdi->status != SR_ST_ACTIVE)
-               return SR_ERR_DEV_CLOSED;
-
        devc = sdi->priv;
 
        if (configure_channels(sdi) != SR_OK) {
@@ -774,7 +734,7 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi)
        if (hantek_6xxx_init(sdi) != SR_OK)
                return SR_ERR;
 
-       std_session_send_df_header(sdi, LOG_PREFIX);
+       std_session_send_df_header(sdi);
 
        devc->samp_received = 0;
        devc->dev_state = FLUSH;
@@ -793,18 +753,16 @@ static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 {
        struct dev_context *devc;
 
-       if (sdi->status != SR_ST_ACTIVE)
-               return SR_ERR;
-
        devc = sdi->priv;
        devc->dev_state = STOPPING;
 
-       g_free(devc->sample_buf); devc->sample_buf = NULL;
+       g_free(devc->sample_buf);
+       devc->sample_buf = NULL;
 
        return SR_OK;
 }
 
-SR_PRIV struct sr_dev_driver hantek_6xxx_driver_info = {
+static struct sr_dev_driver hantek_6xxx_driver_info = {
        .name = "hantek-6xxx",
        .longname = "Hantek 6xxx",
        .api_version = 1,
@@ -822,3 +780,4 @@ SR_PRIV struct sr_dev_driver hantek_6xxx_driver_info = {
        .dev_acquisition_stop = dev_acquisition_stop,
        .context = NULL,
 };
+SR_REGISTER_DEV_DRIVER(hantek_6xxx_driver_info);