X-Git-Url: https://sigrok.org/gitweb/?p=libsigrok.git;a=blobdiff_plain;f=hardware%2Fhantek-dso%2Fapi.c;h=c948e4216a8260ea591f207a5ebaf9d62feeb375;hp=c1828b44a732bc72d776aabe90f5eff16a39f144;hb=43cd4637285833706f8a404ca027bcf0ee75b9ae;hpb=014359e3293ef0cdc61fbde4f63dc0a9da98179d diff --git a/hardware/hantek-dso/api.c b/hardware/hantek-dso/api.c index c1828b44..c948e421 100644 --- a/hardware/hantek-dso/api.c +++ b/hardware/hantek-dso/api.c @@ -1,5 +1,5 @@ /* - * This file is part of the sigrok project. + * This file is part of the libsigrok project. * * Copyright (C) 2012 Bert Vermeulen * @@ -31,62 +31,75 @@ #include #include "libsigrok.h" #include "libsigrok-internal.h" -#include "config.h" #include "dso.h" - /* Max time in ms before we want to check on USB events */ /* TODO tune this properly */ -#define TICK 1 - -static const int hwcaps[] = { - SR_HWCAP_OSCILLOSCOPE, - SR_HWCAP_LIMIT_SAMPLES, - SR_HWCAP_CONTINUOUS, - SR_HWCAP_TIMEBASE, - SR_HWCAP_BUFFERSIZE, - SR_HWCAP_TRIGGER_SOURCE, - SR_HWCAP_TRIGGER_SLOPE, - SR_HWCAP_HORIZ_TRIGGERPOS, - SR_HWCAP_FILTER, - SR_HWCAP_VDIV, - SR_HWCAP_COUPLING, - 0, +#define TICK 1 + +#define NUM_TIMEBASE 10 +#define NUM_VDIV 8 + +static const int32_t scanopts[] = { + SR_CONF_CONN, }; -static const char *probe_names[] = { - "CH1", - "CH2", +static const int32_t devopts[] = { + SR_CONF_OSCILLOSCOPE, + SR_CONF_LIMIT_FRAMES, + SR_CONF_CONTINUOUS, + SR_CONF_TIMEBASE, + SR_CONF_BUFFERSIZE, + SR_CONF_TRIGGER_SOURCE, + SR_CONF_TRIGGER_SLOPE, + SR_CONF_HORIZ_TRIGGERPOS, + SR_CONF_FILTER, + SR_CONF_VDIV, + SR_CONF_COUPLING, + SR_CONF_NUM_TIMEBASE, + SR_CONF_NUM_VDIV, +}; + +static const char *channel_names[] = { + "CH1", "CH2", NULL, }; +static const uint64_t buffersizes_32k[] = { + 10240, 32768, +}; +static const uint64_t buffersizes_512k[] = { + 10240, 524288, +}; +static const uint64_t buffersizes_14k[] = { + 10240, 14336, +}; + static const struct dso_profile dev_profiles[] = { { 0x04b4, 0x2090, 0x04b5, 0x2090, "Hantek", "DSO-2090", - FIRMWARE_DIR "/hantek-dso-2xxx.fw" }, + buffersizes_32k, + FIRMWARE_DIR "/hantek-dso-2090.fw" }, { 0x04b4, 0x2150, 0x04b5, 0x2150, "Hantek", "DSO-2150", - FIRMWARE_DIR "/hantek-dso-2xxx.fw" }, + buffersizes_32k, + FIRMWARE_DIR "/hantek-dso-2150.fw" }, { 0x04b4, 0x2250, 0x04b5, 0x2250, "Hantek", "DSO-2250", - FIRMWARE_DIR "/hantek-dso-2xxx.fw" }, + buffersizes_512k, + FIRMWARE_DIR "/hantek-dso-2250.fw" }, { 0x04b4, 0x5200, 0x04b5, 0x5200, "Hantek", "DSO-5200", - FIRMWARE_DIR "/hantek-dso-5xxx.fw" }, + buffersizes_14k, + FIRMWARE_DIR "/hantek-dso-5200.fw" }, { 0x04b4, 0x520a, 0x04b5, 0x520a, "Hantek", "DSO-5200A", - FIRMWARE_DIR "/hantek-dso-5xxx.fw" }, - { 0, 0, 0, 0, 0, 0, 0 }, + buffersizes_512k, + FIRMWARE_DIR "/hantek-dso-5200A.fw" }, + { 0, 0, 0, 0, 0, 0, 0, 0 }, }; -static const uint64_t buffersizes[] = { - 10240, - 32768, - /* TODO: 65535 */ - 0, -}; - -static const struct sr_rational timebases[] = { +static const uint64_t timebases[][2] = { /* microseconds */ { 10, 1000000 }, { 20, 1000000 }, @@ -104,10 +117,9 @@ static const struct sr_rational timebases[] = { { 100, 1000 }, { 200, 1000 }, { 400, 1000 }, - { 0, 0}, }; -static const struct sr_rational vdivs[] = { +static const uint64_t vdivs[][2] = { /* millivolts */ { 10, 1000 }, { 20, 1000 }, @@ -119,7 +131,6 @@ static const struct sr_rational vdivs[] = { { 1, 1 }, { 2, 1 }, { 5, 1 }, - { 0, 0 }, }; static const char *trigger_sources[] = { @@ -127,32 +138,29 @@ static const char *trigger_sources[] = { "CH2", "EXT", /* TODO: forced */ - NULL, }; static const char *filter_targets[] = { "CH1", "CH2", /* TODO: "TRIGGER", */ - NULL, }; static const char *coupling[] = { "AC", "DC", "GND", - NULL, }; SR_PRIV struct sr_dev_driver hantek_dso_driver_info; -static struct sr_dev_driver *hdi = &hantek_dso_driver_info; -static int hw_dev_acquisition_stop(const struct sr_dev_inst *sdi, - void *cb_data); +static struct sr_dev_driver *di = &hantek_dso_driver_info; + +static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data); static struct sr_dev_inst *dso_dev_new(int index, const struct dso_profile *prof) { struct sr_dev_inst *sdi; - struct sr_probe *probe; + struct sr_channel *ch; struct drv_context *drvc; struct dev_context *devc; int i; @@ -161,22 +169,24 @@ static struct sr_dev_inst *dso_dev_new(int index, const struct dso_profile *prof prof->vendor, prof->model, NULL); if (!sdi) return NULL; - sdi->driver = hdi; + sdi->driver = di; - /* Add only the real probes -- EXT isn't a source of data, only + /* + * Add only the real channels -- EXT isn't a source of data, only * a trigger source internal to the device. */ - for (i = 0; probe_names[i]; i++) { - if (!(probe = sr_probe_new(i, SR_PROBE_ANALOG, TRUE, - probe_names[i]))) + for (i = 0; channel_names[i]; i++) { + if (!(ch = sr_channel_new(i, SR_CHANNEL_ANALOG, TRUE, + channel_names[i]))) return NULL; - sdi->probes = g_slist_append(sdi->probes, probe); + sdi->channels = g_slist_append(sdi->channels, ch); } if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) { - sr_err("hantek-dso: devc malloc failed"); + sr_err("Device context malloc failed."); return NULL; } + devc->profile = prof; devc->dev_state = IDLE; devc->timebase = DEFAULT_TIMEBASE; @@ -194,108 +204,108 @@ static struct sr_dev_inst *dso_dev_new(int index, const struct dso_profile *prof devc->triggersource = g_strdup(DEFAULT_TRIGGER_SOURCE); devc->triggerposition = DEFAULT_HORIZ_TRIGGERPOS; sdi->priv = devc; - drvc = hdi->priv; + drvc = di->priv; drvc->instances = g_slist_append(drvc->instances, sdi); return sdi; } -static int configure_probes(const struct sr_dev_inst *sdi) +static int configure_channels(const struct sr_dev_inst *sdi) { struct dev_context *devc; - const struct sr_probe *probe; + struct sr_channel *ch; const GSList *l; + int p; devc = sdi->priv; + g_slist_free(devc->enabled_channels); devc->ch1_enabled = devc->ch2_enabled = FALSE; - for (l = sdi->probes; l; l = l->next) { - probe = (struct sr_probe *)l->data; - if (probe->index == 0) - devc->ch1_enabled = probe->enabled; - else if (probe->index == 1) - devc->ch2_enabled = probe->enabled; + for (l = sdi->channels, p = 0; l; l = l->next, p++) { + ch = l->data; + if (p == 0) + devc->ch1_enabled = ch->enabled; + else + devc->ch2_enabled = ch->enabled; + if (ch->enabled) + devc->enabled_channels = g_slist_append(devc->enabled_channels, ch); } return SR_OK; } -/* Properly close and free all devices. */ -static void clear_instances(void) +static void clear_dev_context(void *priv) { - struct sr_dev_inst *sdi; - struct drv_context *drvc; struct dev_context *devc; - GSList *l; - - drvc = hdi->priv; - for (l = drvc->instances; l; l = l->next) { - if (!(sdi = l->data)) { - /* Log error, but continue cleaning up the rest. */ - sr_err("hantek-dso: %s: sdi was NULL, continuing", __func__); - continue; - } - if (!(devc = sdi->priv)) { - /* Log error, but continue cleaning up the rest. */ - sr_err("hantek-dso: %s: sdi->priv was NULL, continuing", __func__); - continue; - } - dso_close(sdi); - sr_usb_dev_inst_free(devc->usb); - g_free(devc->triggersource); - - sr_dev_inst_free(sdi); - } - g_slist_free(drvc->instances); - drvc->instances = NULL; + devc = priv; + g_free(devc->triggersource); + g_slist_free(devc->enabled_channels); } -static int hw_init(void) +static int dev_clear(void) { - struct drv_context *drvc; - - if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) { - sr_err("hantek-dso: driver context malloc failed."); - return SR_ERR; - } - - if (libusb_init(&drvc->usb_context) != 0) { - g_free(drvc); - sr_err("hantek-dso: Failed to initialize USB."); - return SR_ERR; - } - - hdi->priv = drvc; + return std_dev_clear(di, clear_dev_context); +} - return SR_OK; +static int init(struct sr_context *sr_ctx) +{ + return std_init(sr_ctx, di, LOG_PREFIX); } -static GSList *hw_scan(GSList *options) +static GSList *scan(GSList *options) { - struct sr_dev_inst *sdi; - const struct dso_profile *prof; struct drv_context *drvc; struct dev_context *devc; - GSList *devices; + struct sr_dev_inst *sdi; + struct sr_usb_dev_inst *usb; + struct sr_config *src; + const struct dso_profile *prof; + GSList *l, *devices, *conn_devices; struct libusb_device_descriptor des; libusb_device **devlist; int devcnt, ret, i, j; + const char *conn; + + drvc = di->priv; - (void)options; devcnt = 0; devices = 0; - drvc = hdi->priv; - drvc->instances = NULL; - clear_instances(); + conn = NULL; + for (l = options; l; l = l->next) { + src = l->data; + if (src->key == SR_CONF_CONN) { + conn = g_variant_get_string(src->data, NULL); + break; + } + } + if (conn) + conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn); + else + conn_devices = NULL; /* Find all Hantek DSO devices and upload firmware to all of them. */ - libusb_get_device_list(drvc->usb_context, &devlist); + libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist); for (i = 0; devlist[i]; i++) { + if (conn) { + usb = NULL; + 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])) + break; + } + if (!l) + /* This device matched none of the ones that + * matched the conn specification. */ + continue; + } + if ((ret = libusb_get_device_descriptor(devlist[i], &des))) { - sr_err("hantek-dso: failed to get device descriptor: %d", ret); + sr_err("Failed to get device descriptor: %s.", + libusb_error_name(ret)); continue; } @@ -305,7 +315,7 @@ static GSList *hw_scan(GSList *options) && des.idProduct == dev_profiles[j].orig_pid) { /* Device matches the pre-firmware profile. */ prof = &dev_profiles[j]; - sr_dbg("hantek-dso: Found a %s %s.", prof->vendor, prof->model); + sr_dbg("Found a %s %s.", prof->vendor, prof->model); sdi = dso_dev_new(devcnt, prof); devices = g_slist_append(devices, sdi); devc = sdi->priv; @@ -314,10 +324,10 @@ static GSList *hw_scan(GSList *options) /* Remember when the firmware on this device was updated */ devc->fw_updated = g_get_monotonic_time(); else - sr_err("hantek-dso: firmware upload failed for " - "device %d", devcnt); + sr_err("Firmware upload failed for " + "device %d.", devcnt); /* Dummy USB address of 0xff will get overwritten later. */ - devc->usb = sr_usb_dev_inst_new( + sdi->conn = sr_usb_dev_inst_new( libusb_get_bus_number(devlist[i]), 0xff, NULL); devcnt++; break; @@ -325,12 +335,13 @@ static GSList *hw_scan(GSList *options) && des.idProduct == dev_profiles[j].fw_pid) { /* Device matches the post-firmware profile. */ prof = &dev_profiles[j]; - sr_dbg("hantek-dso: Found a %s %s.", prof->vendor, prof->model); + sr_dbg("Found a %s %s.", prof->vendor, prof->model); sdi = dso_dev_new(devcnt, prof); sdi->status = SR_ST_INACTIVE; devices = g_slist_append(devices, sdi); devc = sdi->priv; - devc->usb = sr_usb_dev_inst_new( + sdi->inst_type = SR_INST_USB; + sdi->conn = sr_usb_dev_inst_new( libusb_get_bus_number(devlist[i]), libusb_get_device_address(devlist[i]), NULL); devcnt++; @@ -346,22 +357,29 @@ static GSList *hw_scan(GSList *options) return devices; } -static int hw_dev_open(struct sr_dev_inst *sdi) +static GSList *dev_list(void) +{ + return ((struct drv_context *)(di->priv))->instances; +} + +static int dev_open(struct sr_dev_inst *sdi) { struct dev_context *devc; + struct sr_usb_dev_inst *usb; int64_t timediff_us, timediff_ms; int err; devc = sdi->priv; + usb = sdi->conn; /* - * if the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS - * for the FX2 to renumerate + * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS + * for the FX2 to renumerate. */ err = SR_ERR; if (devc->fw_updated > 0) { - sr_info("hantek-dso: waiting for device to reset"); - /* takes at least 300ms for the FX2 to be gone from the USB bus */ + sr_info("Waiting for device to reset."); + /* Takes >= 300ms for the FX2 to be gone from the USB bus. */ g_usleep(300 * 1000); timediff_ms = 0; while (timediff_ms < MAX_RENUM_DELAY_MS) { @@ -370,166 +388,150 @@ static int hw_dev_open(struct sr_dev_inst *sdi) g_usleep(100 * 1000); timediff_us = g_get_monotonic_time() - devc->fw_updated; timediff_ms = timediff_us / 1000; - sr_spew("hantek-dso: waited %" PRIi64 " ms", timediff_ms); + sr_spew("Waited %" PRIi64 " ms.", timediff_ms); } - sr_info("hantek-dso: device came back after %d ms", timediff_ms); + sr_info("Device came back after %d ms.", timediff_ms); } else { err = dso_open(sdi); } if (err != SR_OK) { - sr_err("hantek-dso: unable to open device"); + sr_err("Unable to open device."); return SR_ERR; } - err = libusb_claim_interface(devc->usb->devhdl, USB_INTERFACE); + err = libusb_claim_interface(usb->devhdl, USB_INTERFACE); if (err != 0) { - sr_err("hantek-dso: Unable to claim interface: %d", err); + sr_err("Unable to claim interface: %s.", + libusb_error_name(err)); return SR_ERR; } return SR_OK; } -static int hw_dev_close(struct sr_dev_inst *sdi) +static int dev_close(struct sr_dev_inst *sdi) { - dso_close(sdi); return SR_OK; } -static int hw_cleanup(void) +static int cleanup(void) { - struct drv_context *drvc; - - if (!(drvc = hdi->priv)) - return SR_OK; - - clear_instances(); - - if (drvc->usb_context) - libusb_exit(drvc->usb_context); - drvc->usb_context = NULL; - - return SR_OK; + return dev_clear(); } -static int hw_info_get(int info_id, const void **data, - const struct sr_dev_inst *sdi) +static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi, + const struct sr_channel_group *cg) { - uint64_t tmp; - - (void)sdi; - - switch (info_id) { - case SR_DI_HWCAPS: - *data = hwcaps; - break; - case SR_DI_NUM_PROBES: - *data = GINT_TO_POINTER(NUM_PROBES); - break; - case SR_DI_PROBE_NAMES: - *data = probe_names; - break; - case SR_DI_BUFFERSIZES: - *data = buffersizes; - break; - case SR_DI_TIMEBASES: - *data = timebases; - break; - case SR_DI_TRIGGER_SOURCES: - *data = trigger_sources; - break; - case SR_DI_FILTERS: - *data = filter_targets; - break; - case SR_DI_VDIVS: - *data = vdivs; + struct sr_usb_dev_inst *usb; + char str[128]; + + (void)cg; + + switch (id) { + case SR_CONF_CONN: + if (!sdi || !sdi->conn) + return SR_ERR_ARG; + usb = sdi->conn; + if (usb->address == 255) + /* 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); break; - case SR_DI_COUPLING: - *data = coupling; + case SR_CONF_NUM_TIMEBASE: + *data = g_variant_new_int32(NUM_TIMEBASE); break; - /* TODO remove this */ - case SR_DI_CUR_SAMPLERATE: - *data = &tmp; + case SR_CONF_NUM_VDIV: + *data = g_variant_new_int32(NUM_VDIV); break; default: - return SR_ERR_ARG; + return SR_ERR_NA; } return SR_OK; } -static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap, - const void *value) +static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi, + const struct sr_channel_group *cg) { struct dev_context *devc; - struct sr_rational tmp_rat; - float tmp_float; - uint64_t tmp_u64; - int ret, i; + double tmp_double; + uint64_t tmp_u64, p, q; + int tmp_int, ret; + unsigned int i; + const char *tmp_str; char **targets; + (void)cg; + if (sdi->status != SR_ST_ACTIVE) - return SR_ERR; + return SR_ERR_DEV_CLOSED; ret = SR_OK; devc = sdi->priv; - switch (hwcap) { - case SR_HWCAP_LIMIT_FRAMES: - devc->limit_frames = *(const uint64_t *)value; + switch (id) { + case SR_CONF_LIMIT_FRAMES: + devc->limit_frames = g_variant_get_uint64(data); break; - case SR_HWCAP_TRIGGER_SLOPE: - tmp_u64 = *(const int *)value; - if (tmp_u64 != SLOPE_NEGATIVE && tmp_u64 != SLOPE_POSITIVE) - ret = SR_ERR_ARG; - devc->triggerslope = tmp_u64; + case SR_CONF_TRIGGER_SLOPE: + tmp_str = g_variant_get_string(data, NULL); + if (!tmp_str || !(tmp_str[0] == 'f' || tmp_str[0] == 'r')) + return SR_ERR_ARG; + devc->triggerslope = (tmp_str[0] == 'r') + ? SLOPE_POSITIVE : SLOPE_NEGATIVE; break; - case SR_HWCAP_HORIZ_TRIGGERPOS: - tmp_float = *(const float *)value; - if (tmp_float < 0.0 || tmp_float > 1.0) { - sr_err("hantek-dso: trigger position should be between 0.0 and 1.0"); + case SR_CONF_HORIZ_TRIGGERPOS: + tmp_double = g_variant_get_double(data); + if (tmp_double < 0.0 || tmp_double > 1.0) { + sr_err("Trigger position should be between 0.0 and 1.0."); ret = SR_ERR_ARG; } else - devc->triggerposition = tmp_float; + devc->triggerposition = tmp_double; break; - case SR_HWCAP_BUFFERSIZE: - tmp_u64 = *(const int *)value; - for (i = 0; buffersizes[i]; i++) { - if (buffersizes[i] == tmp_u64) { + case SR_CONF_BUFFERSIZE: + tmp_u64 = g_variant_get_uint64(data); + for (i = 0; i < 2; i++) { + if (devc->profile->buffersizes[i] == tmp_u64) { devc->framesize = tmp_u64; break; } } - if (buffersizes[i] == 0) + if (i == 2) ret = SR_ERR_ARG; break; - case SR_HWCAP_TIMEBASE: - tmp_rat = *(const struct sr_rational *)value; - for (i = 0; timebases[i].p && timebases[i].q; i++) { - if (timebases[i].p == tmp_rat.p - && timebases[i].q == tmp_rat.q) { - devc->timebase = i; + case SR_CONF_TIMEBASE: + g_variant_get(data, "(tt)", &p, &q); + tmp_int = -1; + for (i = 0; i < ARRAY_SIZE(timebases); i++) { + if (timebases[i][0] == p && timebases[i][1] == q) { + tmp_int = i; break; } } - if (timebases[i].p == 0 && timebases[i].q == 0) + if (tmp_int >= 0) + devc->timebase = tmp_int; + else ret = SR_ERR_ARG; break; - case SR_HWCAP_TRIGGER_SOURCE: + case SR_CONF_TRIGGER_SOURCE: + tmp_str = g_variant_get_string(data, NULL); for (i = 0; trigger_sources[i]; i++) { - if (!strcmp(value, trigger_sources[i])) { - devc->triggersource = g_strdup(value); + if (!strcmp(tmp_str, trigger_sources[i])) { + devc->triggersource = g_strdup(tmp_str); break; } } if (trigger_sources[i] == 0) ret = SR_ERR_ARG; break; - case SR_HWCAP_FILTER: + case SR_CONF_FILTER: + tmp_str = g_variant_get_string(data, NULL); devc->filter_ch1 = devc->filter_ch2 = devc->filter_trigger = 0; - targets = g_strsplit(value, ",", 0); + targets = g_strsplit(tmp_str, ",", 0); for (i = 0; targets[i]; i++) { if (targets[i] == '\0') /* Empty filter string can be used to clear them all. */ @@ -541,30 +543,33 @@ static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap, else if (!strcmp(targets[i], "TRIGGER")) devc->filter_trigger = TRUE; else { - sr_err("invalid filter target %s", targets[i]); + sr_err("Invalid filter target %s.", targets[i]); ret = SR_ERR_ARG; } } g_strfreev(targets); break; - case SR_HWCAP_VDIV: - /* TODO not supporting vdiv per channel yet */ - tmp_rat = *(const struct sr_rational *)value; - for (i = 0; vdivs[i].p && vdivs[i].q; i++) { - if (vdivs[i].p == tmp_rat.p - && vdivs[i].q == tmp_rat.q) { - devc->voltage_ch1 = i; - devc->voltage_ch2 = i; + case SR_CONF_VDIV: + /* TODO: Not supporting vdiv per channel yet. */ + 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 (vdivs[i].p == 0 && vdivs[i].q == 0) + if (tmp_int >= 0) { + devc->voltage_ch1 = tmp_int; + devc->voltage_ch2 = tmp_int; + } else ret = SR_ERR_ARG; break; - case SR_HWCAP_COUPLING: - /* TODO not supporting coupling per channel yet */ + case SR_CONF_COUPLING: + tmp_str = g_variant_get_string(data, NULL); + /* TODO: Not supporting coupling per channel yet. */ for (i = 0; coupling[i]; i++) { - if (!strcmp(value, coupling[i])) { + if (!strcmp(tmp_str, coupling[i])) { devc->coupling_ch1 = i; devc->coupling_ch2 = i; break; @@ -574,72 +579,146 @@ static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap, ret = SR_ERR_ARG; break; default: - ret = SR_ERR_ARG; + ret = SR_ERR_NA; + break; } return ret; } -static void send_chunk(struct dev_context *devc, unsigned char *buf, +static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi, + const struct sr_channel_group *cg) +{ + struct dev_context *devc; + GVariant *tuple, *rational[2]; + GVariantBuilder gvb; + unsigned int i; + + (void)cg; + + switch (key) { + case SR_CONF_SCAN_OPTIONS: + *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32, + scanopts, ARRAY_SIZE(scanopts), sizeof(int32_t)); + break; + case SR_CONF_DEVICE_OPTIONS: + *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32, + devopts, ARRAY_SIZE(devopts), sizeof(int32_t)); + break; + case SR_CONF_BUFFERSIZE: + if (!sdi) + return SR_ERR_ARG; + devc = sdi->priv; + *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT64, + devc->profile->buffersizes, 2, sizeof(uint64_t)); + break; + case SR_CONF_COUPLING: + *data = g_variant_new_strv(coupling, ARRAY_SIZE(coupling)); + 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); + break; + case SR_CONF_FILTER: + *data = g_variant_new_strv(filter_targets, + ARRAY_SIZE(filter_targets)); + break; + case SR_CONF_TIMEBASE: + g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY); + for (i = 0; i < ARRAY_SIZE(timebases); i++) { + rational[0] = g_variant_new_uint64(timebases[i][0]); + rational[1] = g_variant_new_uint64(timebases[i][1]); + tuple = g_variant_new_tuple(rational, 2); + g_variant_builder_add_value(&gvb, tuple); + } + *data = g_variant_builder_end(&gvb); + break; + case SR_CONF_TRIGGER_SOURCE: + *data = g_variant_new_strv(trigger_sources, + ARRAY_SIZE(trigger_sources)); + break; + default: + return SR_ERR_NA; + } + + return SR_OK; +} + +static void send_chunk(struct sr_dev_inst *sdi, unsigned char *buf, int num_samples) { struct sr_datafeed_packet packet; struct sr_datafeed_analog analog; + struct dev_context *devc; float ch1, ch2, range; - int num_probes, data_offset, i; + int num_channels, data_offset, i; - num_probes = (devc->ch1_enabled && devc->ch2_enabled) ? 2 : 1; + devc = sdi->priv; + num_channels = (devc->ch1_enabled && devc->ch2_enabled) ? 2 : 1; packet.type = SR_DF_ANALOG; packet.payload = &analog; /* TODO: support for 5xxx series 9-bit samples */ + analog.channels = devc->enabled_channels; analog.num_samples = num_samples; analog.mq = SR_MQ_VOLTAGE; analog.unit = SR_UNIT_VOLT; - analog.data = g_try_malloc(analog.num_samples * sizeof(float) * num_probes); + /* TODO: Check malloc return value. */ + analog.data = g_try_malloc(analog.num_samples * sizeof(float) * num_channels); data_offset = 0; for (i = 0; i < analog.num_samples; i++) { - /* The device always sends data for both channels. If a channel + /* + * 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. + * data. However, we only send the requested channels to + * the bus. * - * Voltage values are encoded as a value 0-255 (0-512 on the 5200*), - * where the value is a point in the range represented by the vdiv - * setting. There are 8 vertical divs, so e.g. 500mV/div represents - * 4V peak-to-peak where 0 = -2V and 255 = +2V. + * Voltage values are encoded as a value 0-255 (0-512 on the + * DSO-5200*), where the value is a point in the range + * represented by the vdiv setting. There are 8 vertical divs, + * so e.g. 500mV/div represents 4V peak-to-peak where 0 = -2V + * and 255 = +2V. */ - /* TODO: support for 5xxx series 9-bit samples */ + /* TODO: Support for DSO-5xxx series 9-bit samples. */ if (devc->ch1_enabled) { - range = ((float)vdivs[devc->voltage_ch1].p / vdivs[devc->voltage_ch1].q) * 8; + range = ((float)vdivs[devc->voltage_ch1][0] / vdivs[devc->voltage_ch1][1]) * 8; ch1 = range / 255 * *(buf + i * 2 + 1); /* Value is centered around 0V. */ ch1 -= range / 2; analog.data[data_offset++] = ch1; } if (devc->ch2_enabled) { - range = ((float)vdivs[devc->voltage_ch2].p / vdivs[devc->voltage_ch2].q) * 8; + range = ((float)vdivs[devc->voltage_ch2][0] / vdivs[devc->voltage_ch2][1]) * 8; ch2 = range / 255 * *(buf + i * 2); ch2 -= range / 2; analog.data[data_offset++] = ch2; } } sr_session_send(devc->cb_data, &packet); - } -/* Called by libusb (as triggered by handle_event()) when a transfer comes in. +/* + * Called by libusb (as triggered by handle_event()) when a transfer comes in. * Only channel data comes in asynchronously, and all transfers for this are - * queued up beforehand, so this just needs so chuck the incoming data onto + * queued up beforehand, so this just needs to chuck the incoming data onto * the libsigrok session bus. */ static void receive_transfer(struct libusb_transfer *transfer) { struct sr_datafeed_packet packet; + struct sr_dev_inst *sdi; struct dev_context *devc; int num_samples, pre; - devc = transfer->user_data; - sr_dbg("hantek-dso: receive_transfer(): status %d received %d bytes", - transfer->status, transfer->actual_length); + sdi = transfer->user_data; + devc = sdi->priv; + sr_spew("receive_transfer(): status %d received %d bytes.", + transfer->status, transfer->actual_length); if (transfer->actual_length == 0) /* Nothing to send to the bus. */ @@ -647,15 +726,17 @@ static void receive_transfer(struct libusb_transfer *transfer) num_samples = transfer->actual_length / 2; - sr_dbg("hantek-dso: got %d-%d/%d samples in frame", devc->samp_received + 1, - devc->samp_received + num_samples, devc->framesize); + sr_spew("Got %d-%d/%d samples in frame.", devc->samp_received + 1, + devc->samp_received + num_samples, devc->framesize); - /* The device always sends a full frame, but the beginning of the frame + /* + * The device always sends a full frame, but the beginning of the frame * doesn't represent the trigger point. The offset at which the trigger * happened came in with the capture state, so we need to start sending - * from there up the session bus. The samples in the frame buffer before - * that trigger point came after the end of the device's frame buffer was - * reached, and it wrapped around to overwrite up until the trigger point. + * from there up the session bus. The samples in the frame buffer + * before that trigger point came after the end of the device's frame + * buffer was reached, and it wrapped around to overwrite up until the + * trigger point. */ if (devc->samp_received < devc->trigger_offset) { /* Trigger point not yet reached. */ @@ -665,27 +746,29 @@ static void receive_transfer(struct libusb_transfer *transfer) transfer->buffer, num_samples * 2); devc->samp_buffered += num_samples; } else { - /* This chunk hits or overruns the trigger point. + /* + * This chunk hits or overruns the trigger point. * Store the part before the trigger fired, and - * send the rest up to the session bus. */ + * send the rest up to the session bus. + */ pre = devc->trigger_offset - devc->samp_received; memcpy(devc->framebuf + devc->samp_buffered * 2, transfer->buffer, pre * 2); devc->samp_buffered += pre; /* The rest of this chunk starts with the trigger point. */ - sr_dbg("hantek-dso: reached trigger point, %d samples buffered", - devc->samp_buffered); + sr_dbg("Reached trigger point, %d samples buffered.", + devc->samp_buffered); /* Avoid the corner case where the chunk ended at * exactly the trigger point. */ if (num_samples > pre) - send_chunk(devc, transfer->buffer + pre * 2, + send_chunk(sdi, transfer->buffer + pre * 2, num_samples - pre); } } else { /* Already past the trigger point, just send it all out. */ - send_chunk(devc, transfer->buffer, + send_chunk(sdi, transfer->buffer, num_samples); } @@ -699,9 +782,9 @@ static void receive_transfer(struct libusb_transfer *transfer) if (devc->samp_received >= devc->framesize) { /* That was the last chunk in this frame. Send the buffered * pre-trigger samples out now, in one big chunk. */ - sr_dbg("hantek-dso: end of frame, sending %d pre-trigger buffered samples", - devc->samp_buffered); - send_chunk(devc, devc->framebuf, devc->samp_buffered); + sr_dbg("End of frame, sending %d pre-trigger buffered samples.", + devc->samp_buffered); + send_chunk(sdi, devc->framebuf, devc->samp_buffered); /* Mark the end of this frame. */ packet.type = SR_DF_FRAME_END; @@ -714,7 +797,6 @@ static void receive_transfer(struct libusb_transfer *transfer) devc->dev_state = NEW_CAPTURE; } } - } static int handle_event(int fd, int revents, void *cb_data) @@ -722,29 +804,25 @@ static int handle_event(int fd, int revents, void *cb_data) const struct sr_dev_inst *sdi; struct sr_datafeed_packet packet; struct timeval tv; - struct drv_context *drvc; struct dev_context *devc; - const struct libusb_pollfd **lupfd; - int num_probes, i; + struct drv_context *drvc = di->priv; + int num_channels; uint32_t trigger_offset; uint8_t capturestate; - /* Avoid compiler warnings. */ (void)fd; (void)revents; - drvc = hdi->priv; sdi = cb_data; devc = sdi->priv; if (devc->dev_state == STOPPING) { /* We've been told to wind up the acquisition. */ - sr_dbg("hantek-dso: stopping acquisition"); - /* TODO: doesn't really cancel pending transfers so they might - * come in after SR_DF_END is sent. */ - lupfd = libusb_get_pollfds(drvc->usb_context); - for (i = 0; lupfd[i]; i++) - sr_source_remove(lupfd[i]->fd); - free(lupfd); + sr_dbg("Stopping acquisition."); + /* + * TODO: Doesn't really cancel pending transfers so they might + * come in after SR_DF_END is sent. + */ + usb_source_remove(sdi->session, drvc->sr_ctx); packet.type = SR_DF_END; sr_session_send(sdi, &packet); @@ -756,57 +834,59 @@ static int handle_event(int fd, int revents, void *cb_data) /* Always handle pending libusb events. */ tv.tv_sec = tv.tv_usec = 0; - libusb_handle_events_timeout(drvc->usb_context, &tv); + libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv); /* TODO: ugh */ if (devc->dev_state == NEW_CAPTURE) { - if (dso_capture_start(devc) != SR_OK) + if (dso_capture_start(sdi) != SR_OK) return TRUE; - if (dso_enable_trigger(devc) != SR_OK) + if (dso_enable_trigger(sdi) != SR_OK) return TRUE; -// if (dso_force_trigger(devc) != SR_OK) +// if (dso_force_trigger(sdi) != SR_OK) // return TRUE; - sr_dbg("hantek-dso: successfully requested next chunk"); + sr_dbg("Successfully requested next chunk."); devc->dev_state = CAPTURE; return TRUE; } if (devc->dev_state != CAPTURE) return TRUE; - if ((dso_get_capturestate(devc, &capturestate, &trigger_offset)) != SR_OK) + if ((dso_get_capturestate(sdi, &capturestate, &trigger_offset)) != SR_OK) return TRUE; - sr_dbg("hantek-dso: capturestate %d", capturestate); - sr_dbg("hantek-dso: trigger offset 0x%.6x", trigger_offset); + sr_dbg("Capturestate %d.", capturestate); + sr_dbg("Trigger offset 0x%.6x.", trigger_offset); switch (capturestate) { case CAPTURE_EMPTY: if (++devc->capture_empty_count >= MAX_CAPTURE_EMPTY) { devc->capture_empty_count = 0; - if (dso_capture_start(devc) != SR_OK) + if (dso_capture_start(sdi) != SR_OK) break; - if (dso_enable_trigger(devc) != SR_OK) + if (dso_enable_trigger(sdi) != SR_OK) break; -// if (dso_force_trigger(devc) != SR_OK) +// if (dso_force_trigger(sdi) != SR_OK) // break; - sr_dbg("hantek-dso: successfully requested next chunk"); + sr_dbg("Successfully requested next chunk."); } break; case CAPTURE_FILLING: - /* no data yet */ + /* No data yet. */ break; case CAPTURE_READY_8BIT: /* Remember where in the captured frame the trigger is. */ devc->trigger_offset = trigger_offset; - num_probes = (devc->ch1_enabled && devc->ch2_enabled) ? 2 : 1; - devc->framebuf = g_try_malloc(devc->framesize * num_probes * 2); + num_channels = (devc->ch1_enabled && devc->ch2_enabled) ? 2 : 1; + /* TODO: Check malloc return value. */ + devc->framebuf = g_try_malloc(devc->framesize * num_channels * 2); devc->samp_buffered = devc->samp_received = 0; /* Tell the scope to send us the first frame. */ - if (dso_get_channeldata(devc, receive_transfer) != SR_OK) + if (dso_get_channeldata(sdi, receive_transfer) != SR_OK) break; - /* Don't hit the state machine again until we're done fetching + /* + * Don't hit the state machine again until we're done fetching * the data we just told the scope to send. */ devc->dev_state = FETCH_DATA; @@ -817,72 +897,51 @@ static int handle_event(int fd, int revents, void *cb_data) break; case CAPTURE_READY_9BIT: /* TODO */ - sr_err("not yet supported"); + sr_err("Not yet supported."); break; case CAPTURE_TIMEOUT: /* Doesn't matter, we'll try again next time. */ break; default: - sr_dbg("unknown capture state"); + sr_dbg("Unknown capture state: %d.", capturestate); + break; } return TRUE; } -static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi, - void *cb_data) +static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data) { - const struct libusb_pollfd **lupfd; - struct sr_datafeed_packet packet; - struct sr_datafeed_header header; - struct sr_datafeed_meta_analog meta; - struct drv_context *drvc; struct dev_context *devc; - int i; + struct drv_context *drvc = di->priv; - drvc = hdi->priv; if (sdi->status != SR_ST_ACTIVE) - return SR_ERR; + return SR_ERR_DEV_CLOSED; devc = sdi->priv; devc->cb_data = cb_data; - if (configure_probes(sdi) != SR_OK) { - sr_err("hantek-dso: failed to configured probes"); + if (configure_channels(sdi) != SR_OK) { + sr_err("Failed to configure channels."); return SR_ERR; } - if (dso_init(devc) != SR_OK) + if (dso_init(sdi) != SR_OK) return SR_ERR; - if (dso_capture_start(devc) != SR_OK) + if (dso_capture_start(sdi) != SR_OK) return SR_ERR; devc->dev_state = CAPTURE; - lupfd = libusb_get_pollfds(drvc->usb_context); - for (i = 0; lupfd[i]; i++) - sr_source_add(lupfd[i]->fd, lupfd[i]->events, TICK, handle_event, - (void *)sdi); - free(lupfd); + usb_source_add(sdi->session, drvc->sr_ctx, TICK, handle_event, (void *)sdi); /* Send header packet to the session bus. */ - packet.type = SR_DF_HEADER; - packet.payload = (unsigned char *)&header; - header.feed_version = 1; - gettimeofday(&header.starttime, NULL); - sr_session_send(cb_data, &packet); - - /* Send metadata about the SR_DF_ANALOG packets to come. */ - packet.type = SR_DF_META_ANALOG; - packet.payload = &meta; - meta.num_probes = NUM_PROBES; - sr_session_send(cb_data, &packet); + std_session_send_df_header(cb_data, LOG_PREFIX); return SR_OK; } -static int hw_dev_acquisition_stop(const struct sr_dev_inst *sdi, - void *cb_data) +static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data) { struct dev_context *devc; @@ -901,14 +960,17 @@ SR_PRIV struct sr_dev_driver hantek_dso_driver_info = { .name = "hantek-dso", .longname = "Hantek DSO", .api_version = 1, - .init = hw_init, - .cleanup = hw_cleanup, - .scan = hw_scan, - .dev_open = hw_dev_open, - .dev_close = hw_dev_close, - .info_get = hw_info_get, - .dev_config_set = hw_dev_config_set, - .dev_acquisition_start = hw_dev_acquisition_start, - .dev_acquisition_stop = hw_dev_acquisition_stop, + .init = init, + .cleanup = cleanup, + .scan = scan, + .dev_list = dev_list, + .dev_clear = dev_clear, + .config_get = config_get, + .config_set = config_set, + .config_list = config_list, + .dev_open = dev_open, + .dev_close = dev_close, + .dev_acquisition_start = dev_acquisition_start, + .dev_acquisition_stop = dev_acquisition_stop, .priv = NULL, };