]> sigrok.org Git - libsigrok.git/blobdiff - hardware/fx2lafw/fx2lafw.c
sr: fx2lafw: Add basic support for USBee DX and clones
[libsigrok.git] / hardware / fx2lafw / fx2lafw.c
index 63a4f9f9b87847eb0c4d64bf06deb51fd1d2c77b..7142a35de7037f9070bc651f0798b1935bf50d76 100644 (file)
@@ -1,6 +1,7 @@
 /*
  * This file is part of the sigrok project.
  *
+ * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
  * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
  *
  * This program is free software: you can redistribute it and/or modify
 #include <inttypes.h>
 #include <libusb.h>
 #include "config.h"
-#include "sigrok.h"
-#include "sigrok-internal.h"
+#include "libsigrok.h"
+#include "libsigrok-internal.h"
 #include "fx2lafw.h"
 #include "command.h"
 
 static const struct fx2lafw_profile supported_fx2[] = {
+       /*
+        * CWAV USBee DX
+        * XZL Studio DX
+        */
+       { 0x08a9, 0x0015, "CWAV", "USBee DX", NULL,
+               FIRMWARE_DIR "/fx2lafw-cwav-usbeedx.fw",
+               0 },
        /*
         * CWAV USBee AX
         * EE Electronics ESLA201A
         * ARMFLY AX-Pro
         */
        { 0x08a9, 0x0014, "CWAV", "USBee AX", NULL,
-               FIRMWARE_DIR "/fx2lafw-cwav-usbeeax.fw", 8 },
+               FIRMWARE_DIR "/fx2lafw-cwav-usbeeax.fw",
+               0 },
 
        /*
         * CWAV USBee SX
         */
        { 0x08a9, 0x0009, "CWAV", "USBee SX", NULL,
-               FIRMWARE_DIR "/fx2lafw-cwav-usbeesx.fw", 8 },
+               FIRMWARE_DIR "/fx2lafw-cwav-usbeesx.fw",
+               0 },
 
        /*
         * Saleae Logic
@@ -50,7 +60,8 @@ static const struct fx2lafw_profile supported_fx2[] = {
         * Robomotic BugLogic 3
         */
        { 0x0925, 0x3881, "Saleae", "Logic", NULL,
-               FIRMWARE_DIR "/fx2lafw-saleae-logic.fw", 8 },
+               FIRMWARE_DIR "/fx2lafw-saleae-logic.fw",
+               0 },
 
        /*
         * Default Cypress FX2 without EEPROM, e.g.:
@@ -58,18 +69,20 @@ static const struct fx2lafw_profile supported_fx2[] = {
         * Braintechnology USB Interface V2.x
         */
        { 0x04B4, 0x8613, "Cypress", "FX2", NULL,
-               FIRMWARE_DIR "/fx2lafw-cypress-fx2.fw", 8 },
+               FIRMWARE_DIR "/fx2lafw-cypress-fx2.fw",
+               DEV_CAPS_16BIT },
 
        /*
         * Braintechnology USB-LPS
         */
        { 0x16d0, 0x0498, "Braintechnology", "USB-LPS", NULL,
-               FIRMWARE_DIR "/fx2lafw-braintechnology-usb-lps.fw", 8 },
+               FIRMWARE_DIR "/fx2lafw-braintechnology-usb-lps.fw",
+               DEV_CAPS_16BIT },
 
        { 0, 0, 0, 0, 0, 0, 0 }
 };
 
-static int hwcaps[] = {
+static const int hwcaps[] = {
        SR_HWCAP_LOGIC_ANALYZER,
        SR_HWCAP_SAMPLERATE,
 
@@ -91,10 +104,18 @@ static const char *probe_names[] = {
        "5",
        "6",
        "7",
+       "8",
+       "9",
+       "10",
+       "11",
+       "12",
+       "13",
+       "14",
+       "15",
        NULL,
 };
 
-static uint64_t supported_samplerates[] = {
+static const uint64_t supported_samplerates[] = {
        SR_KHZ(20),
        SR_KHZ(25),
        SR_KHZ(50),
@@ -114,7 +135,7 @@ static uint64_t supported_samplerates[] = {
        0,
 };
 
-static struct sr_samplerates samplerates = {
+static const struct sr_samplerates samplerates = {
        0,
        0,
        0,
@@ -124,7 +145,7 @@ static struct sr_samplerates samplerates = {
 static GSList *dev_insts = NULL;
 static libusb_context *usb_context = NULL;
 
-static int hw_dev_config_set(int dev_index, int hwcap, void *value);
+static int hw_dev_config_set(int dev_index, int hwcap, const void *value);
 static int hw_dev_acquisition_stop(int dev_index, void *cb_data);
 
 /**
@@ -250,11 +271,15 @@ static int fx2lafw_dev_open(int dev_index)
                        break;
                }
 
-               if (vi.major != FX2LAFW_VERSION_MAJOR ||
-                   vi.minor != FX2LAFW_VERSION_MINOR) {
-                       sr_err("fx2lafw: Expected firmware version %d.%d "
-                              "got %d.%d.", FX2LAFW_VERSION_MAJOR,
-                              FX2LAFW_VERSION_MINOR, vi.major, vi.minor);
+               /*
+                * Changes in major version mean incompatible/API changes, so
+                * bail out if we encounter an incompatible version.
+                * Different minor versions are OK, they should be compatible.
+                */
+               if (vi.major != FX2LAFW_REQUIRED_VERSION_MAJOR) {
+                       sr_err("fx2lafw: Expected firmware version %d.x, "
+                              "got %d.%d.", FX2LAFW_REQUIRED_VERSION_MAJOR,
+                              vi.major, vi.minor);
                        break;
                }
 
@@ -308,6 +333,10 @@ static int configure_probes(struct context *ctx, GSList *probes)
                probe = (struct sr_probe *)l->data;
                if (probe->enabled == FALSE)
                        continue;
+
+               if (probe->index > 8)
+                       ctx->sample_wide = TRUE;
+
                probe_bit = 1 << (probe->index - 1);
                if (!(probe->trigger))
                        continue;
@@ -372,7 +401,7 @@ static int hw_init(const char *devinfo)
                return 0;
        }
 
-       /* Find all fx2lafw compatible devices and upload firware to them. */
+       /* Find all fx2lafw compatible devices and upload firmware to them. */
        libusb_get_device_list(usb_context, &devlist);
        for (i = 0; devlist[i]; i++) {
 
@@ -445,8 +474,7 @@ static int hw_dev_open(int dev_index)
         * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
         * milliseconds for the FX2 to renumerate.
         */
-       ret = 0;
-
+       ret = SR_ERR;
        if (ctx->fw_updated > 0) {
                sr_info("fx2lafw: Waiting for device to reset.");
                /* takes at least 300ms for the FX2 to be gone from the USB bus */
@@ -458,9 +486,8 @@ static int hw_dev_open(int dev_index)
                        g_usleep(100 * 1000);
 
                        timediff_us = g_get_monotonic_time() - ctx->fw_updated;
-                       timediff_ms = timediff_us / G_USEC_PER_SEC;
-                       sr_spew("fx2lafw: timediff: %" PRIi64 " us.",
-                               timediff_us);
+                       timediff_ms = timediff_us / 1000;
+                       sr_spew("fx2lafw: waited %" PRIi64 " ms", timediff_ms);
                }
                sr_info("fx2lafw: Device came back after %d ms.", timediff_ms);
        } else {
@@ -475,7 +502,21 @@ static int hw_dev_open(int dev_index)
 
        ret = libusb_claim_interface(ctx->usb->devhdl, USB_INTERFACE);
        if (ret != 0) {
-               sr_err("fx2lafw: Unable to claim interface: %d.", ret);
+               switch(ret) {
+               case LIBUSB_ERROR_BUSY:
+                       sr_err("fx2lafw: Unable to claim USB interface. Another "
+                               "program or driver has already claimed it.");
+                       break;
+
+               case LIBUSB_ERROR_NO_DEVICE:
+                       sr_err("fx2lafw: Device has been disconnected.");
+                       break;
+
+               default:
+                       sr_err("fx2lafw: Unable to claim interface: %d.", ret);
+                       break;
+               }
+
                return SR_ERR;
        }
 
@@ -541,7 +582,7 @@ static int hw_cleanup(void)
        return ret;
 }
 
-static void *hw_dev_info_get(int dev_index, int dev_info_id)
+static const void *hw_dev_info_get(int dev_index, int dev_info_id)
 {
        struct sr_dev_inst *sdi;
        struct context *ctx;
@@ -554,7 +595,9 @@ static void *hw_dev_info_get(int dev_index, int dev_info_id)
        case SR_DI_INST:
                return sdi;
        case SR_DI_NUM_PROBES:
-               return GINT_TO_POINTER(ctx->profile->num_probes);
+               return GINT_TO_POINTER(
+                       (ctx->profile->dev_caps & DEV_CAPS_16BIT) ?
+                       16 : 8);
        case SR_DI_PROBE_NAMES:
                return probe_names;
        case SR_DI_SAMPLERATES:
@@ -579,12 +622,12 @@ static int hw_dev_status_get(int dev_index)
        return sdi->status;
 }
 
-static int *hw_hwcap_get_all(void)
+static const int *hw_hwcap_get_all(void)
 {
        return hwcaps;
 }
 
-static int hw_dev_config_set(int dev_index, int hwcap, void *value)
+static int hw_dev_config_set(int dev_index, int hwcap, const void *value)
 {
        struct sr_dev_inst *sdi;
        struct context *ctx;
@@ -595,12 +638,12 @@ static int hw_dev_config_set(int dev_index, int hwcap, void *value)
        ctx = sdi->priv;
 
        if (hwcap == SR_HWCAP_SAMPLERATE) {
-               ctx->cur_samplerate = *(uint64_t *)value;
+               ctx->cur_samplerate = *(const uint64_t *)value;
                ret = SR_OK;
        } else if (hwcap == SR_HWCAP_PROBECONFIG) {
                ret = configure_probes(ctx, (GSList *) value);
        } else if (hwcap == SR_HWCAP_LIMIT_SAMPLES) {
-               ctx->limit_samples = *(uint64_t *)value;
+               ctx->limit_samples = *(const uint64_t *)value;
                ret = SR_OK;
        } else {
                ret = SR_ERR;
@@ -626,7 +669,14 @@ static int receive_data(int fd, int revents, void *cb_data)
 
 static void abort_acquisition(struct context *ctx)
 {
+       int i;
+
        ctx->num_samples = -1;
+
+       for (i = ctx->num_transfers - 1; i >= 0; i--) {
+               if (ctx->transfers[i])
+                       libusb_cancel_transfer(ctx->transfers[i]);
+       }
 }
 
 static void finish_acquisition(struct context *ctx)
@@ -644,30 +694,57 @@ static void finish_acquisition(struct context *ctx)
        for (i = 0; lupfd[i]; i++)
                sr_source_remove(lupfd[i]->fd);
        free(lupfd); /* NOT g_free()! */
+
+       ctx->num_transfers = 0;
+       g_free(ctx->transfers);
+}
+
+static void free_transfer(struct libusb_transfer *transfer)
+{
+       struct context *ctx = transfer->user_data;
+       unsigned int i;
+
+       g_free(transfer->buffer);
+       transfer->buffer = NULL;
+       libusb_free_transfer(transfer);
+
+       for (i = 0; i < ctx->num_transfers; i++) {
+               if (ctx->transfers[i] == transfer) {
+                       ctx->transfers[i] = NULL;
+                       break;
+               }
+       }
+
+       ctx->submitted_transfers--;
+       if (ctx->submitted_transfers == 0)
+               finish_acquisition(ctx);
+
+}
+
+static void resubmit_transfer(struct libusb_transfer *transfer)
+{
+       if (libusb_submit_transfer(transfer) != 0) {
+               free_transfer(transfer);
+               /* TODO: Stop session? */
+               /* TODO: Better error message. */
+               sr_err("fx2lafw: %s: libusb_submit_transfer error.", __func__);
+       }
 }
 
 static void receive_transfer(struct libusb_transfer *transfer)
 {
-       /* TODO: These statics have to move to the ctx struct. */
-       static int empty_transfer_count = 0;
+       gboolean packet_has_error = FALSE;
        struct sr_datafeed_packet packet;
        struct sr_datafeed_logic logic;
        struct context *ctx = transfer->user_data;
-       int cur_buflen, trigger_offset, i;
-       unsigned char *cur_buf, *new_buf;
+       int trigger_offset, i;
 
        /*
         * If acquisition has already ended, just free any queued up
         * transfer that come in.
         */
        if (ctx->num_samples == -1) {
-               if (transfer)
-                       libusb_free_transfer(transfer);
-
-               ctx->submitted_transfers--;
-               if (ctx->submitted_transfers == 0)
-                       finish_acquisition(ctx);
-
+               free_transfer(transfer);
                return;
        }
 
@@ -675,47 +752,56 @@ static void receive_transfer(struct libusb_transfer *transfer)
                transfer->status, transfer->actual_length);
 
        /* Save incoming transfer before reusing the transfer struct. */
-       cur_buf = transfer->buffer;
-       cur_buflen = transfer->actual_length;
-
-       /* Fire off a new request. */
-       if (!(new_buf = g_try_malloc(4096))) {
-               sr_err("fx2lafw: %s: new_buf malloc failed.", __func__);
-               return; /* TODO: SR_ERR_MALLOC */
-       }
-
-       transfer->buffer = new_buf;
-       transfer->length = 4096;
-       if (libusb_submit_transfer(transfer) != 0) {
-               /* TODO: Stop session? */
-               /* TODO: Better error message. */
-               sr_err("fx2lafw: %s: libusb_submit_transfer error.", __func__);
+       uint8_t *const cur_buf = transfer->buffer;
+       const int sample_width = ctx->sample_wide ? 2 : 1;
+       const int cur_sample_count = transfer->actual_length / sample_width;
+
+       switch (transfer->status) {
+       case LIBUSB_TRANSFER_NO_DEVICE:
+               abort_acquisition(ctx);
+               free_transfer(transfer);
+               return;
+       case LIBUSB_TRANSFER_COMPLETED:
+       case LIBUSB_TRANSFER_TIMED_OUT: /* We may have received some data though */
+               break;
+       default:
+               packet_has_error = TRUE;
+               break;
        }
 
-       if (cur_buflen == 0) {
-               empty_transfer_count++;
-               if (empty_transfer_count > MAX_EMPTY_TRANSFERS) {
+       if (transfer->actual_length == 0 || packet_has_error) {
+               ctx->empty_transfer_count++;
+               if (ctx->empty_transfer_count > MAX_EMPTY_TRANSFERS) {
                        /*
                         * The FX2 gave up. End the acquisition, the frontend
                         * will work out that the samplecount is short.
                         */
                        abort_acquisition(ctx);
+                       free_transfer(transfer);
+               } else {
+                       resubmit_transfer(transfer);
                }
                return;
        } else {
-               empty_transfer_count = 0;
+               ctx->empty_transfer_count = 0;
        }
 
        trigger_offset = 0;
        if (ctx->trigger_stage >= 0) {
-               for (i = 0; i < cur_buflen; i++) {
+               for (i = 0; i < cur_sample_count; i++) {
+
+                       const uint16_t cur_sample = ctx->sample_wide ?
+                               *((const uint16_t*)cur_buf + i) :
+                               *((const uint8_t*)cur_buf + i);
 
-                       if ((cur_buf[i] & ctx->trigger_mask[ctx->trigger_stage]) == ctx->trigger_value[ctx->trigger_stage]) {
+                       if ((cur_sample & ctx->trigger_mask[ctx->trigger_stage]) ==
+                               ctx->trigger_value[ctx->trigger_stage]) {
                                /* Match on this trigger stage. */
-                               ctx->trigger_buffer[ctx->trigger_stage] = cur_buf[i];
+                               ctx->trigger_buffer[ctx->trigger_stage] = cur_sample;
                                ctx->trigger_stage++;
 
-                               if (ctx->trigger_stage == NUM_TRIGGER_STAGES || ctx->trigger_mask[ctx->trigger_stage] == 0) {
+                               if (ctx->trigger_stage == NUM_TRIGGER_STAGES ||
+                                       ctx->trigger_mask[ctx->trigger_stage] == 0) {
                                        /* Match on all trigger stages, we're done. */
                                        trigger_offset = i + 1;
 
@@ -733,25 +819,22 @@ static void receive_transfer(struct libusb_transfer *transfer)
                                         */
                                        packet.type = SR_DF_LOGIC;
                                        packet.payload = &logic;
-                                       logic.length = ctx->trigger_stage;
-                                       logic.unitsize = 1;
+                                       logic.unitsize = sizeof(*ctx->trigger_buffer);
+                                       logic.length = ctx->trigger_stage * logic.unitsize;
                                        logic.data = ctx->trigger_buffer;
                                        sr_session_send(ctx->session_dev_id, &packet);
 
                                        ctx->trigger_stage = TRIGGER_FIRED;
                                        break;
                                }
-                               return;
-                       }
-
-                       /*
-                        * We had a match before, but not in the next sample. However, we may
-                        * have a match on this stage in the next bit -- trigger on 0001 will
-                        * fail on seeing 00001, so we need to go back to stage 0 -- but at
-                        * the next sample from the one that matched originally, which the
-                        * counter increment at the end of the loop takes care of.
-                        */
-                       if (ctx->trigger_stage > 0) {
+                       } else if (ctx->trigger_stage > 0) {
+                               /*
+                                * We had a match before, but not in the next sample. However, we may
+                                * have a match on this stage in the next bit -- trigger on 0001 will
+                                * fail on seeing 00001, so we need to go back to stage 0 -- but at
+                                * the next sample from the one that matched originally, which the
+                                * counter increment at the end of the loop takes care of.
+                                */
                                i -= ctx->trigger_stage;
                                if (i < -1)
                                        i = -1; /* Oops, went back past this buffer. */
@@ -763,18 +846,20 @@ static void receive_transfer(struct libusb_transfer *transfer)
 
        if (ctx->trigger_stage == TRIGGER_FIRED) {
                /* Send the incoming transfer to the session bus. */
+               const int trigger_offset_bytes = trigger_offset * sample_width;
                packet.type = SR_DF_LOGIC;
                packet.payload = &logic;
-               logic.length = cur_buflen - trigger_offset;
-               logic.unitsize = 1;
-               logic.data = cur_buf + trigger_offset;
+               logic.length = transfer->actual_length - trigger_offset_bytes;
+               logic.unitsize = sample_width;
+               logic.data = cur_buf + trigger_offset_bytes;
                sr_session_send(ctx->session_dev_id, &packet);
-               g_free(cur_buf);
 
-               ctx->num_samples += cur_buflen;
+               ctx->num_samples += cur_sample_count;
                if (ctx->limit_samples &&
                        (unsigned int)ctx->num_samples > ctx->limit_samples) {
                        abort_acquisition(ctx);
+                       free_transfer(transfer);
+                       return;
                }
        } else {
                /*
@@ -782,38 +867,83 @@ static void receive_transfer(struct libusb_transfer *transfer)
                 * ratio-sized buffer.
                 */
        }
+
+       resubmit_transfer(transfer);
+}
+
+static unsigned int to_bytes_per_ms(unsigned int samplerate)
+{
+       return samplerate / 1000;
+}
+
+static size_t get_buffer_size(struct context *ctx)
+{
+       size_t s;
+
+       /* The buffer should be large enough to hold 10ms of data and a multiple
+        * of 512. */
+       s = 10 * to_bytes_per_ms(ctx->cur_samplerate);
+       return (s + 511) & ~511;
+}
+
+static unsigned int get_number_of_transfers(struct context *ctx)
+{
+       unsigned int n;
+
+       /* Total buffer size should be able to hold about 500ms of data */
+       n = 500 * to_bytes_per_ms(ctx->cur_samplerate) / get_buffer_size(ctx);
+
+       if (n > NUM_SIMUL_TRANSFERS)
+               return NUM_SIMUL_TRANSFERS;
+
+       return n;
+}
+
+static unsigned int get_timeout(struct context *ctx)
+{
+       size_t total_size;
+       unsigned int timeout;
+
+       total_size = get_buffer_size(ctx) * get_number_of_transfers(ctx);
+       timeout = total_size / to_bytes_per_ms(ctx->cur_samplerate);
+       return timeout + timeout / 4; /* Leave a headroom of 25% percent */
 }
 
 static int hw_dev_acquisition_start(int dev_index, void *cb_data)
 {
        struct sr_dev_inst *sdi;
-       struct sr_datafeed_packet *packet;
-       struct sr_datafeed_header *header;
+       struct sr_datafeed_packet packet;
+       struct sr_datafeed_header header;
+       struct sr_datafeed_meta_logic meta;
        struct context *ctx;
        struct libusb_transfer *transfer;
        const struct libusb_pollfd **lupfd;
-       int ret, size, i;
+       unsigned int i;
+       int ret;
        unsigned char *buf;
 
        if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
                return SR_ERR;
        ctx = sdi->priv;
+
+       if (ctx->submitted_transfers != 0)
+               return SR_ERR;
+
        ctx->session_dev_id = cb_data;
        ctx->num_samples = 0;
+       ctx->empty_transfer_count = 0;
 
-       if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
-               sr_err("fx2lafw: %s: packet malloc failed.", __func__);
-               return SR_ERR_MALLOC;
-       }
+       const unsigned int timeout = get_timeout(ctx);
+       const unsigned int num_transfers = get_number_of_transfers(ctx);
+       const size_t size = get_buffer_size(ctx);
 
-       if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) {
-               sr_err("fx2lafw: %s: header malloc failed.", __func__);
-               return SR_ERR_MALLOC;
-       }
+       ctx->transfers = g_try_malloc0(sizeof(*ctx->transfers) * num_transfers);
+       if (!ctx->transfers)
+               return SR_ERR;
+
+       ctx->num_transfers = num_transfers;
 
-       /* Start with 2K transfer, subsequently increased to 4K. */
-       size = 2048;
-       for (i = 0; i < NUM_SIMUL_TRANSFERS; i++) {
+       for (i = 0; i < num_transfers; i++) {
                if (!(buf = g_try_malloc(size))) {
                        sr_err("fx2lafw: %s: buf malloc failed.", __func__);
                        return SR_ERR_MALLOC;
@@ -821,36 +951,39 @@ static int hw_dev_acquisition_start(int dev_index, void *cb_data)
                transfer = libusb_alloc_transfer(0);
                libusb_fill_bulk_transfer(transfer, ctx->usb->devhdl,
                                2 | LIBUSB_ENDPOINT_IN, buf, size,
-                               receive_transfer, ctx, 40);
+                               receive_transfer, ctx, timeout);
                if (libusb_submit_transfer(transfer) != 0) {
-                       /* TODO: Free them all. */
                        libusb_free_transfer(transfer);
                        g_free(buf);
+                       abort_acquisition(ctx);
                        return SR_ERR;
                }
-
+               ctx->transfers[i] = transfer;
                ctx->submitted_transfers++;
-               size = 4096;
        }
 
        lupfd = libusb_get_pollfds(usb_context);
        for (i = 0; lupfd[i]; i++)
                sr_source_add(lupfd[i]->fd, lupfd[i]->events,
-                             40, receive_data, NULL);
+                             timeout, receive_data, NULL);
        free(lupfd); /* NOT g_free()! */
 
-       packet->type = SR_DF_HEADER;
-       packet->payload = header;
-       header->feed_version = 1;
-       gettimeofday(&header->starttime, NULL);
-       header->samplerate = ctx->cur_samplerate;
-       header->num_logic_probes = ctx->profile->num_probes;
-       sr_session_send(cb_data, packet);
-       g_free(header);
-       g_free(packet);
+       packet.type = SR_DF_HEADER;
+       packet.payload = &header;
+       header.feed_version = 1;
+       gettimeofday(&header.starttime, NULL);
+       sr_session_send(cb_data, &packet);
+
+       /* Send metadata about the SR_DF_LOGIC packets to come. */
+       packet.type = SR_DF_META_LOGIC;
+       packet.payload = &meta;
+       meta.samplerate = ctx->cur_samplerate;
+       meta.num_probes = ctx->sample_wide ? 16 : 8;
+       sr_session_send(cb_data, &packet);
 
        if ((ret = command_start_acquisition (ctx->usb->devhdl,
-               ctx->cur_samplerate)) != SR_OK) {
+               ctx->cur_samplerate, ctx->sample_wide)) != SR_OK) {
+               abort_acquisition(ctx);
                return ret;
        }