]> sigrok.org Git - libsigrok.git/blobdiff - hardware/fx2lafw/fx2lafw.c
sr: s/err/ret/ for consistency.
[libsigrok.git] / hardware / fx2lafw / fx2lafw.c
index 3efcdb434bff292cba0fa390d2727ab6ca95b5fb..ddf2f0dc2cdd70996aed382395d882a7ccd883a3 100644 (file)
 
 #include <stdio.h>
 #include <stdlib.h>
-#include <stdbool.h>
 #include <inttypes.h>
 #include <glib.h>
 #include <libusb.h>
-
 #include "config.h"
 #include "sigrok.h"
 #include "sigrok-internal.h"
 #include "fx2lafw.h"
+#include "command.h"
+
+static const struct fx2lafw_profile supported_fx2[] = {
+       /* CWAV USBee AX
+        * EE Electronics ESLA201A
+        */
+       { 0x08a9, 0x0014, "CWAV", "USBee AX", NULL,
+               FIRMWARE_DIR "/fx2lafw-cwav-usbeeax.fw", 8 },
+
+       /* CWAV USBee SX
+        */
+       { 0x08a9, 0x0009, "CWAV", "USBee SX", NULL,
+               FIRMWARE_DIR "/fx2lafw-cwav-usbeesx.fw", 8 },
+
+       /* Saleae Logic
+        * EE Electronics ESLA100
+        * Robomotic MiniLogic
+        */
+       { 0x0925, 0x3881, "Saleae", "Logic", NULL,
+               FIRMWARE_DIR "/fx2lafw-saleae-logic.fw", 8 },
 
-static struct fx2lafw_profile supported_fx2[] = {
-       /* USBee AX */
-       { 0x08a9, 0x0014, "CWAV", "USBee AX", NULL, 8 },
-       { 0, 0, 0, 0, 0, 0 }
+       { 0, 0, 0, 0, 0, 0, 0 }
 };
 
 static int fx2lafw_capabilities[] = {
@@ -42,7 +57,7 @@ static int fx2lafw_capabilities[] = {
        /* These are really implemented in the driver, not the hardware. */
        SR_HWCAP_LIMIT_SAMPLES,
        SR_HWCAP_CONTINUOUS,
-       0
+       0,
 };
 
 static const char *fx2lafw_probe_names[] = {
@@ -54,7 +69,7 @@ static const char *fx2lafw_probe_names[] = {
        "D5",
        "D6",
        "D7",
-       NULL
+       NULL,
 };
 
 static uint64_t fx2lafw_supported_samplerates[] = {
@@ -66,34 +81,37 @@ static uint64_t fx2lafw_supported_samplerates[] = {
        SR_MHZ(8),
        SR_MHZ(12),
        SR_MHZ(16),
-       SR_MHZ(24)
+       SR_MHZ(24),
 };
 
 static struct sr_samplerates fx2lafw_samplerates = {
        SR_MHZ(1),
        SR_MHZ(24),
        SR_HZ(0),
-       fx2lafw_supported_samplerates
+       fx2lafw_supported_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_acquisition_stop(int dev_index, void *session_dev_id);
+
 /**
  * Check the USB configuration to determine if this is an fx2lafw device.
  *
- * @return true if the device's configuration profile match fx2lafw
- *         configuration, flase otherwise.
+ * @return TRUE if the device's configuration profile match fx2lafw
+ *         configuration, FALSE otherwise.
  */
-static bool check_conf_profile(libusb_device *dev)
+static gboolean check_conf_profile(libusb_device *dev)
 {
        struct libusb_device_descriptor des;
        struct libusb_config_descriptor *conf_dsc = NULL;
        const struct libusb_interface_descriptor *intf_dsc;
-       bool ret = false;
+       gboolean ret = FALSE;
 
        while (!ret) {
-               /* Assume it's not a Saleae Logic unless proven wrong. */
+               /* Assume the firmware has not been loaded, unless proven wrong. */
                ret = 0;
 
                if (libusb_get_device_descriptor(dev, &des) != 0)
@@ -115,24 +133,19 @@ static bool check_conf_profile(libusb_device *dev)
                        break;
 
                intf_dsc = &(conf_dsc->interface[0].altsetting[0]);
-               if (intf_dsc->bNumEndpoints != 3)
-                       /* Need exactly 3 end points. */
+               if (intf_dsc->bNumEndpoints != 2)
+                       /* Need exactly 2 end points. */
                        break;
 
                if ((intf_dsc->endpoint[0].bEndpointAddress & 0x8f) !=
-                   (1 | LIBUSB_ENDPOINT_OUT))
-                       /* The first endpoint should be 1 (outbound). */
-                       break;
-
-               if ((intf_dsc->endpoint[1].bEndpointAddress & 0x8f) !=
-                   (2 | LIBUSB_ENDPOINT_IN))
-                       /* The second endpoint should be 2 (inbound). */
+                   (2 | LIBUSB_ENDPOINT_IN)) // 0x82
+                       /* The first endpoint should be 2 (inbound). */
                        break;
 
                /* TODO: Check the debug channel... */
 
                /* If we made it here, it must be an fx2lafw. */
-               ret = true;
+               ret = TRUE;
        }
 
        if (conf_dsc)
@@ -146,8 +159,8 @@ static int fx2lafw_open_dev(int dev_index)
        libusb_device **devlist;
        struct libusb_device_descriptor des;
        struct sr_dev_inst *sdi;
-       struct fx2lafw_device *ctx;
-       int err, skip, i;
+       struct context *ctx;
+       int ret, skip, i;
 
        if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
                return SR_ERR;
@@ -160,13 +173,13 @@ static int fx2lafw_open_dev(int dev_index)
        skip = 0;
        libusb_get_device_list(usb_context, &devlist);
        for (i = 0; devlist[i]; i++) {
-               if ((err = libusb_get_device_descriptor(devlist[i], &des))) {
-                       sr_err("fx2lafw: failed to get device descriptor: %d", err);
+               if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
+                       sr_err("fx2lafw: failed to get device descriptor: %d", ret);
                        continue;
                }
 
-               if (des.idVendor != FIRMWARE_VID
-                   || des.idProduct != FIRMWARE_PID)
+               if (des.idVendor != ctx->profile->vid
+                   || des.idProduct != ctx->profile->pid)
                        continue;
 
                if (sdi->status == SR_ST_INITIALIZING) {
@@ -186,7 +199,7 @@ static int fx2lafw_open_dev(int dev_index)
                                continue;
                }
 
-               if (!(err = libusb_open(devlist[i], &ctx->usb->devhdl))) {
+               if (!(ret = libusb_open(devlist[i], &ctx->usb->devhdl))) {
                        if (ctx->usb->address == 0xff)
                                /*
                                 * first time we touch this device after firmware upload,
@@ -199,7 +212,7 @@ static int fx2lafw_open_dev(int dev_index)
                                sdi->index, ctx->usb->bus,
                                ctx->usb->address, USB_INTERFACE);
                } else {
-                       sr_err("fx2lafw: failed to open device: %d", err);
+                       sr_err("fx2lafw: failed to open device: %d", ret);
                }
 
                /* if we made it here, we handled the device one way or another */
@@ -213,16 +226,33 @@ static int fx2lafw_open_dev(int dev_index)
        return SR_OK;
 }
 
-static struct fx2lafw_device* fx2lafw_device_new(void)
+static void close_dev(struct sr_dev_inst *sdi)
+{
+       struct context *ctx;
+
+       ctx = sdi->priv;
+
+       if (ctx->usb->devhdl == NULL)
+               return;
+
+       sr_info("fx2lafw: closing device %d on %d.%d interface %d", sdi->index,
+               ctx->usb->bus, ctx->usb->address, USB_INTERFACE);
+       libusb_release_interface(ctx->usb->devhdl, USB_INTERFACE);
+       libusb_close(ctx->usb->devhdl);
+       ctx->usb->devhdl = NULL;
+       sdi->status = SR_ST_INACTIVE;
+}
+
+static struct context *fx2lafw_device_new(void)
 {
-       struct fx2lafw_device *fx2lafw;
+       struct context *ctx;
 
-       if (!(fx2lafw = g_try_malloc0(sizeof(struct fx2lafw_device)))) {
-               sr_err("fx2lafw: %s: fx2lafw_device malloc failed", __func__);
+       if (!(ctx = g_try_malloc0(sizeof(struct context)))) {
+               sr_err("fx2lafw: %s: ctx malloc failed", __func__);
                return NULL;
        }
 
-       return fx2lafw;
+       return ctx;
 }
 
 /*
@@ -233,10 +263,10 @@ static int hw_init(const char *deviceinfo)
 {
        struct sr_dev_inst *sdi;
        struct libusb_device_descriptor des;
-       struct fx2lafw_profile *fx2lafw_prof;
-       struct fx2lafw_device *ctx;
+       const struct fx2lafw_profile *fx2lafw_prof;
+       struct context *ctx;
        libusb_device **devlist;
-       int err;
+       int ret;
        int devcnt = 0;
        int i, j;
 
@@ -252,9 +282,9 @@ static int hw_init(const char *deviceinfo)
        libusb_get_device_list(usb_context, &devlist);
        for (i = 0; devlist[i]; i++) {
 
-               if ((err = libusb_get_device_descriptor(
+               if ((ret = libusb_get_device_descriptor(
                        devlist[i], &des)) != 0) {
-                       sr_warn("failed to get device descriptor: %d", err);
+                       sr_warn("failed to get device descriptor: %d", ret);
                        continue;
                }
 
@@ -279,7 +309,7 @@ static int hw_init(const char *deviceinfo)
                ctx = fx2lafw_device_new();
                ctx->profile = fx2lafw_prof;
                sdi->priv = ctx;
-               device_instances = g_slist_append(dev_insts, sdi);
+               dev_insts = g_slist_append(dev_insts, sdi);
 
                if (check_conf_profile(devlist[i])) {
                        /* Already has the firmware, so fix the new address. */
@@ -289,7 +319,8 @@ static int hw_init(const char *deviceinfo)
                            (libusb_get_bus_number(devlist[i]),
                             libusb_get_device_address(devlist[i]), NULL);
                } else {
-                       if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION, FIRMWARE) == SR_OK)
+                       if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
+                               fx2lafw_prof->firmware) == SR_OK)
                                /* Remember when the firmware on this device was updated */
                                g_get_current_time(&ctx->fw_updated);
                        else
@@ -306,14 +337,14 @@ static int hw_init(const char *deviceinfo)
        return devcnt;
 }
 
-static int hw_dev_open(int device_index)
+static int hw_dev_open(int dev_index)
 {
        GTimeVal cur_time;
        struct sr_dev_inst *sdi;
-       struct fx2lafw_device *ctx;
-       int timediff, err;
+       struct context *ctx;
+       int timediff, ret;
 
-       if (!(sdi = sr_dev_inst_get(dev_insts, device_index)))
+       if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
                return SR_ERR;
        ctx = sdi->priv;
 
@@ -321,14 +352,14 @@ static int hw_dev_open(int device_index)
         * if the firmware was recently uploaded, wait up to MAX_RENUM_DELAY ms
         * for the FX2 to renumerate
         */
-       err = 0;
+       ret = 0;
        if (GTV_TO_MSEC(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 */
                g_usleep(300 * 1000);
                timediff = 0;
                while (timediff < MAX_RENUM_DELAY) {
-                       if ((err = fx2lafw_open_dev(device_index)) == SR_OK)
+                       if ((ret = fx2lafw_open_dev(dev_index)) == SR_OK)
                                break;
                        g_usleep(100 * 1000);
                        g_get_current_time(&cur_time);
@@ -336,27 +367,43 @@ static int hw_dev_open(int device_index)
                }
                sr_info("fx2lafw: device came back after %d ms", timediff);
        } else {
-               err = fx2lafw_open_dev(device_index);
+               ret = fx2lafw_open_dev(dev_index);
        }
 
-       if (err != SR_OK) {
+       if (ret != SR_OK) {
                sr_err("fx2lafw: unable to open device");
                return SR_ERR;
        }
        ctx = sdi->priv;
 
-       err = libusb_claim_interface(ctx->usb->devhdl, USB_INTERFACE);
-       if (err != 0) {
-               sr_err("fx2lafw: Unable to claim interface: %d", err);
+       ret = libusb_claim_interface(ctx->usb->devhdl, USB_INTERFACE);
+       if (ret != 0) {
+               sr_err("fx2lafw: Unable to claim interface: %d", ret);
                return SR_ERR;
        }
 
+       if (ctx->cur_samplerate == 0) {
+               /* Samplerate hasn't been set; default to the slowest one. */
+               if (hw_dev_config_set(dev_index, SR_HWCAP_SAMPLERATE,
+                   &fx2lafw_supported_samplerates[0]) == SR_ERR)
+                       return SR_ERR;
+       }
+
        return SR_OK;
 }
 
-static int hw_dev_close(int device_index)
+static int hw_dev_close(int dev_index)
 {
-       (void)device_index;
+       struct sr_dev_inst *sdi;
+
+       if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) {
+               sr_err("fx2lafw: %s: sdi was NULL", __func__);
+               return SR_ERR_BUG;
+       }
+
+       /* TODO */
+       close_dev(sdi);
+
        return SR_OK;
 }
 
@@ -364,32 +411,48 @@ static int hw_cleanup(void)
 {
        GSList *l;
        struct sr_dev_inst *sdi;
-
-       for(l = device_instances; l; l = l->next) {
+       struct context *ctx;
+       int ret = SR_OK;
+
+       for(l = dev_insts; l; l = l->next) {
+               if (!(sdi = l->data)) {
+                       /* Log error, but continue cleaning up the rest. */
+                       sr_err("fx2lafw: %s: sdi was NULL, continuing", __func__);
+                       ret = SR_ERR_BUG;
+                       continue;
+               }
+               if (!(ctx = sdi->priv)) {
+                       /* Log error, but continue cleaning up the rest. */
+                       sr_err("fx2lafw: %s: sdi->priv was NULL, continuing",
+                              __func__);
+                       ret = SR_ERR_BUG;
+                       continue;
+               }
+               close_dev(sdi);
                sdi = l->data;
                sr_dev_inst_free(sdi);
        }
 
-       g_slist_free(device_instances);
-       device_instances = NULL;
+       g_slist_free(dev_insts);
+       dev_insts = NULL;
 
        if(usb_context)
                libusb_exit(usb_context);
        usb_context = NULL;
 
-       return SR_OK;
+       return ret;
 }
 
-static void *hw_dev_info_get(int device_index, int device_info_id)
+static void *hw_dev_info_get(int dev_index, int dev_info_id)
 {
        struct sr_dev_inst *sdi;
-       struct fx2lafw_device *ctx;
+       struct context *ctx;
 
-       if (!(sdi = sr_dev_inst_get(dev_insts, device_index)))
+       if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
                return NULL;
        ctx = sdi->priv;
 
-       switch (device_info_id) {
+       switch (dev_info_id) {
        case SR_DI_INST:
                return sdi;
        case SR_DI_NUM_PROBES:
@@ -400,15 +463,17 @@ static void *hw_dev_info_get(int device_index, int device_info_id)
                return &fx2lafw_samplerates;
        case SR_DI_TRIGGER_TYPES:
                return TRIGGER_TYPES;
+       case SR_DI_CUR_SAMPLERATE:
+               return &ctx->cur_samplerate;
        }
 
        return NULL;
 }
 
-static int hw_dev_status_get(int device_index)
+static int hw_dev_status_get(int dev_index)
 {
        const struct sr_dev_inst *const sdi =
-               sr_dev_inst_get(dev_insts, device_index);
+               sr_dev_inst_get(dev_insts, dev_index);
 
        if (!sdi)
                return SR_ST_NOT_FOUND;
@@ -421,30 +486,218 @@ static int *hw_hwcap_get_all(void)
        return fx2lafw_capabilities;
 }
 
-static int hw_dev_config_set(int dev_index, int capability, void *value)
+static int hw_dev_config_set(int dev_index, int hwcap, void *value)
 {
-       (void)dev_index;
-       (void)capability;
-       (void)value;
-       return SR_OK;
+       struct sr_dev_inst *sdi;
+       struct context *ctx;
+       int ret;
+
+       if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
+               return SR_ERR;
+       ctx = sdi->priv;
+
+       if (hwcap == SR_HWCAP_SAMPLERATE) {
+               ctx->cur_samplerate = *(uint64_t *)value;
+               ret = SR_OK;
+       } else if (hwcap == SR_HWCAP_PROBECONFIG) {
+               ret = SR_OK;
+       } else if (hwcap == SR_HWCAP_LIMIT_SAMPLES) {
+               ctx->limit_samples = *(uint64_t *)value;
+               ret = SR_OK;
+       } else {
+               ret = SR_ERR;
+       }
+
+       return ret;
 }
 
-static int hw_dev_acquisition_start(int dev_index, gpointer session_data)
+static int receive_data(int fd, int revents, void *cb_data)
 {
-       (void)dev_index;
-       (void)session_data;
+       struct timeval tv;
+
+       /* Avoid compiler warnings. */
+       (void)fd;
+       (void)revents;
+       (void)cb_data;
+
+       tv.tv_sec = tv.tv_usec = 0;
+       libusb_handle_events_timeout(usb_context, &tv);
+
+       return TRUE;
+}
+
+static void abort_acquisition(struct context *ctx)
+{
+       struct sr_datafeed_packet packet;
+
+       packet.type = SR_DF_END;
+       sr_session_send(ctx->session_dev_id, &packet);
+
+       ctx->num_samples = -1;
+
+       /* TODO: Need to cancel and free any queued up transfers. */
+}
+
+static void receive_transfer(struct libusb_transfer *transfer)
+{
+       /* TODO: These statics have to move to the ctx struct. */
+       static int empty_transfer_count = 0;
+       struct sr_datafeed_packet packet;
+       struct sr_datafeed_logic logic;
+       struct context *ctx = transfer->user_data;
+       int cur_buflen;
+       unsigned char *cur_buf, *new_buf;
+
+       /*
+        * 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);
+               return;
+       }
+
+       sr_info("fx2lafw: receive_transfer(): status %d received %d bytes",
+               transfer->status, transfer->actual_length);
+
+       /* Save incoming transfer before reusing the transfer struct. */
+       cur_buf = transfer->buffer;
+       cur_buflen = transfer->actual_length;
+       ctx = transfer->user_data;
+
+       /* 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__);
+       }
+
+       if (cur_buflen == 0) {
+               empty_transfer_count++;
+               if (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);
+               }
+               return;
+       } else {
+               empty_transfer_count = 0;
+       }
+
+       /* Send the incoming transfer to the session bus. */
+       packet.type = SR_DF_LOGIC;
+       packet.payload = &logic;
+       logic.length = cur_buflen;
+       logic.unitsize = 1;
+       logic.data = cur_buf;
+       sr_session_send(ctx->session_dev_id, &packet);
+       g_free(cur_buf);
+
+       ctx->num_samples += cur_buflen;
+       if (ctx->limit_samples &&
+               (unsigned int) ctx->num_samples > ctx->limit_samples) {
+               abort_acquisition(ctx);
+       }
+}
+
+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 context *ctx;
+       struct libusb_transfer *transfer;
+       const struct libusb_pollfd **lupfd;
+       int ret, size, i;
+       unsigned char *buf;
+
+       if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
+               return SR_ERR;
+       ctx = sdi->priv;
+       ctx->session_dev_id = cb_data;
+       ctx->num_samples = 0;
+
+       if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
+               sr_err("fx2lafw: %s: packet malloc failed", __func__);
+               return SR_ERR_MALLOC;
+       }
+
+       if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) {
+               sr_err("fx2lafw: %s: header malloc failed", __func__);
+               return SR_ERR_MALLOC;
+       }
+
+       /* Start with 2K transfer, subsequently increased to 4K. */
+       size = 2048;
+       for (i = 0; i < NUM_SIMUL_TRANSFERS; i++) {
+               if (!(buf = g_try_malloc(size))) {
+                       sr_err("fx2lafw: %s: buf malloc failed", __func__);
+                       return SR_ERR_MALLOC;
+               }
+               transfer = libusb_alloc_transfer(0);
+               libusb_fill_bulk_transfer(transfer, ctx->usb->devhdl,
+                               2 | LIBUSB_ENDPOINT_IN, buf, size,
+                               receive_transfer, ctx, 40);
+               if (libusb_submit_transfer(transfer) != 0) {
+                       /* TODO: Free them all. */
+                       libusb_free_transfer(transfer);
+                       g_free(buf);
+                       return SR_ERR;
+               }
+               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);
+       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);
+
+       if ((ret = command_start_acquisition (ctx->usb->devhdl,
+               ctx->cur_samplerate)) != SR_OK) {
+               return ret;
+       }
+
        return SR_OK;
 }
 
-/* This stops acquisition on ALL devices, ignoring device_index. */
-static int hw_dev_acquisition_stop(int dev_index, gpointer session_data)
+/* TODO: This stops acquisition on ALL devices, ignoring dev_index. */
+static int hw_dev_acquisition_stop(int dev_index, void *cb_data)
 {
-       (void)dev_index;
-       (void)session_data;
+       struct sr_dev_inst *sdi;
+
+       /* unused parameter */
+       (void)cb_data;
+
+       if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
+               return SR_ERR;
+       abort_acquisition(sdi->priv);
+
        return SR_OK;
 }
 
-SR_PRIV struct sr_dev_plugin fx2lafw_plugin_info = {
+SR_PRIV struct sr_dev_driver fx2lafw_driver_info = {
        .name = "fx2lafw",
        .longname = "fx2lafw",
        .api_version = 1,