]> sigrok.org Git - libsigrok.git/blobdiff - hardware/fx2lafw/fx2lafw.c
sr: fx2lafw: Only check for correct major FW version.
[libsigrok.git] / hardware / fx2lafw / fx2lafw.c
index ed95fd2b879c17382d89d82a558f513d9537a223..0ea4030d7b1fcffb2f81f191275f43fa3a17fab8 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
@@ -19,8 +20,8 @@
 
 #include <stdio.h>
 #include <stdlib.h>
+#include <string.h>
 #include <inttypes.h>
-#include <glib.h>
 #include <libusb.h>
 #include "config.h"
 #include "sigrok.h"
 #include "command.h"
 
 static const struct fx2lafw_profile supported_fx2[] = {
-       /* CWAV USBee AX
+       /*
+        * CWAV USBee AX
         * EE Electronics ESLA201A
+        * ARMFLY AX-Pro
         */
        { 0x08a9, 0x0014, "CWAV", "USBee AX", NULL,
                FIRMWARE_DIR "/fx2lafw-cwav-usbeeax.fw", 8 },
 
-       /* CWAV USBee SX
+       /*
+        * CWAV USBee SX
         */
        { 0x08a9, 0x0009, "CWAV", "USBee SX", NULL,
                FIRMWARE_DIR "/fx2lafw-cwav-usbeesx.fw", 8 },
 
-       /* Saleae Logic
+       /*
+        * Saleae Logic
         * EE Electronics ESLA100
         * Robomotic MiniLogic
+        * Robomotic BugLogic 3
         */
        { 0x0925, 0x3881, "Saleae", "Logic", NULL,
                FIRMWARE_DIR "/fx2lafw-saleae-logic.fw", 8 },
 
+       /*
+        * Default Cypress FX2 without EEPROM, e.g.:
+        * Lcsoft Mini Board
+        * Braintechnology USB Interface V2.x
+        */
+       { 0x04B4, 0x8613, "Cypress", "FX2", NULL,
+               FIRMWARE_DIR "/fx2lafw-cypress-fx2.fw", 8 },
+
+       /*
+        * Braintechnology USB-LPS
+        */
+       { 0x16d0, 0x0498, "Braintechnology", "USB-LPS", NULL,
+               FIRMWARE_DIR "/fx2lafw-braintechnology-usb-lps.fw", 8 },
+
        { 0, 0, 0, 0, 0, 0, 0 }
 };
 
-static int fx2lafw_capabilities[] = {
+static int hwcaps[] = {
        SR_HWCAP_LOGIC_ANALYZER,
        SR_HWCAP_SAMPLERATE,
 
@@ -60,19 +80,29 @@ static int fx2lafw_capabilities[] = {
        0,
 };
 
-static const char *fx2lafw_probe_names[] = {
-       "D0",
-       "D1",
-       "D2",
-       "D3",
-       "D4",
-       "D5",
-       "D6",
-       "D7",
+/*
+ * TODO: Different probe_names[] for each supported device.
+ */
+static const char *probe_names[] = {
+       "0",
+       "1",
+       "2",
+       "3",
+       "4",
+       "5",
+       "6",
+       "7",
        NULL,
 };
 
 static uint64_t supported_samplerates[] = {
+       SR_KHZ(20),
+       SR_KHZ(25),
+       SR_KHZ(50),
+       SR_KHZ(100),
+       SR_KHZ(200),
+       SR_KHZ(250),
+       SR_KHZ(500),
        SR_MHZ(1),
        SR_MHZ(2),
        SR_MHZ(3),
@@ -82,6 +112,7 @@ static uint64_t supported_samplerates[] = {
        SR_MHZ(12),
        SR_MHZ(16),
        SR_MHZ(24),
+       0,
 };
 
 static struct sr_samplerates samplerates = {
@@ -95,7 +126,7 @@ 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);
+static int hw_dev_acquisition_stop(int dev_index, void *cb_data);
 
 /**
  * Check the USB configuration to determine if this is an fx2lafw device.
@@ -106,61 +137,50 @@ static int hw_dev_acquisition_stop(int dev_index, void *session_dev_id);
 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;
-       gboolean ret = FALSE;
+       struct libusb_device_handle *hdl;
+       gboolean ret;
+       unsigned char strdesc[64];
 
+       hdl = NULL;
+       ret = FALSE;
        while (!ret) {
-               /* Assume the firmware has not been loaded, unless proven wrong. */
-               ret = 0;
-
+               /* Assume the FW has not been loaded, unless proven wrong. */
                if (libusb_get_device_descriptor(dev, &des) != 0)
                        break;
 
-               if (des.bNumConfigurations != 1)
-                       /* Need exactly 1 configuration. */
-                       break;
-
-               if (libusb_get_config_descriptor(dev, 0, &conf_dsc) != 0)
+               if (libusb_open(dev, &hdl) != 0)
                        break;
 
-               if (conf_dsc->bNumInterfaces != 1)
-                       /* Need exactly 1 interface. */
+               if (libusb_get_string_descriptor_ascii(hdl,
+                               des.iManufacturer, strdesc, sizeof(strdesc)) < 0)
                        break;
-
-               if (conf_dsc->interface[0].num_altsetting != 1)
-                       /* Need just one alternate setting. */
+               if (strncmp((const char *)strdesc, "sigrok", 6))
                        break;
 
-               intf_dsc = &(conf_dsc->interface[0].altsetting[0]);
-               if (intf_dsc->bNumEndpoints != 2)
-                       /* Need exactly 2 end points. */
+               if (libusb_get_string_descriptor_ascii(hdl,
+                               des.iProduct, strdesc, sizeof(strdesc)) < 0)
                        break;
-
-               if ((intf_dsc->endpoint[0].bEndpointAddress & 0x8f) !=
-                   (2 | LIBUSB_ENDPOINT_IN)) // 0x82
-                       /* The first endpoint should be 2 (inbound). */
+               if (strncmp((const char *)strdesc, "fx2lafw", 7))
                        break;
 
-               /* TODO: Check the debug channel... */
-
                /* If we made it here, it must be an fx2lafw. */
                ret = TRUE;
        }
-
-       if (conf_dsc)
-               libusb_free_config_descriptor(conf_dsc);
+       if (hdl)
+               libusb_close(hdl);
 
        return ret;
 }
 
-static int fx2lafw_open_dev(int dev_index)
+static int fx2lafw_dev_open(int dev_index)
 {
        libusb_device **devlist;
        struct libusb_device_descriptor des;
        struct sr_dev_inst *sdi;
        struct context *ctx;
+       struct version_info vi;
        int ret, skip, i;
+       uint8_t revid;
 
        if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
                return SR_ERR;
@@ -171,10 +191,17 @@ static int fx2lafw_open_dev(int dev_index)
                return SR_ERR;
 
        skip = 0;
-       libusb_get_device_list(usb_context, &devlist);
-       for (i = 0; devlist[i]; i++) {
+       const int device_count = libusb_get_device_list(usb_context, &devlist);
+       if (device_count < 0) {
+               sr_err("fx2lafw: Failed to retrieve device list (%d)",
+                       device_count);
+               return SR_ERR;
+       }
+
+       for (i = 0; i < device_count; i++) {
                if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
-                       sr_err("fx2lafw: failed to get device descriptor: %d", ret);
+                       sr_err("fx2lafw: Failed to get device descriptor: %d.",
+                              ret);
                        continue;
                }
 
@@ -206,16 +233,42 @@ static int fx2lafw_open_dev(int dev_index)
                                 * so we don't know the address yet.
                                 */
                                ctx->usb->address = libusb_get_device_address(devlist[i]);
-
-                       sdi->status = SR_ST_ACTIVE;
-                       sr_info("fx2lafw: opened device %d on %d.%d interface %d",
-                               sdi->index, ctx->usb->bus,
-                               ctx->usb->address, USB_INTERFACE);
                } else {
-                       sr_err("fx2lafw: failed to open device: %d", ret);
+                       sr_err("fx2lafw: Failed to open device: %d.", ret);
+                       break;
                }
 
-               /* if we made it here, we handled the device one way or another */
+               ret = command_get_fw_version(ctx->usb->devhdl, &vi);
+               if (ret != SR_OK) {
+                       sr_err("fx2lafw: Failed to retrieve "
+                              "firmware version information.");
+                       break;
+               }
+
+               ret = command_get_revid_version(ctx->usb->devhdl, &revid);
+               if (ret != SR_OK) {
+                       sr_err("fx2lafw: Failed to retrieve REVID.");
+                       break;
+               }
+
+               /*
+                * 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;
+               }
+
+               sdi->status = SR_ST_ACTIVE;
+               sr_info("fx2lafw: Opened device %d on %d.%d "
+                       "interface %d, firmware %d.%d, REVID %d.",
+                       sdi->index, ctx->usb->bus, ctx->usb->address,
+                       USB_INTERFACE, vi.major, vi.minor, revid);
+
                break;
        }
        libusb_free_device_list(devlist, 1);
@@ -235,8 +288,8 @@ static void close_dev(struct sr_dev_inst *sdi)
        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);
+       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;
@@ -287,12 +340,12 @@ static int configure_probes(struct context *ctx, GSList *probes)
        return SR_OK;
 }
 
-static struct context *fx2lafw_device_new(void)
+static struct context *fx2lafw_dev_new(void)
 {
        struct context *ctx;
 
        if (!(ctx = g_try_malloc0(sizeof(struct context)))) {
-               sr_err("fx2lafw: %s: ctx malloc failed", __func__);
+               sr_err("fx2lafw: %s: ctx malloc failed.", __func__);
                return NULL;
        }
 
@@ -305,11 +358,11 @@ static struct context *fx2lafw_device_new(void)
  * API callbacks
  */
 
-static int hw_init(const char *deviceinfo)
+static int hw_init(const char *devinfo)
 {
        struct sr_dev_inst *sdi;
        struct libusb_device_descriptor des;
-       const struct fx2lafw_profile *fx2lafw_prof;
+       const struct fx2lafw_profile *prof;
        struct context *ctx;
        libusb_device **devlist;
        int ret;
@@ -317,61 +370,60 @@ static int hw_init(const char *deviceinfo)
        int i, j;
 
        /* Avoid compiler warnings. */
-       (void)deviceinfo;
+       (void)devinfo;
 
        if (libusb_init(&usb_context) != 0) {
-               sr_warn("Failed to initialize USB.");
+               sr_warn("fx2lafw: Failed to initialize libusb.");
                return 0;
        }
 
-       /* Find all fx2lafw compatible devices and upload firware to all of them. */
+       /* Find all fx2lafw compatible devices and upload firmware to them. */
        libusb_get_device_list(usb_context, &devlist);
        for (i = 0; devlist[i]; i++) {
 
                if ((ret = libusb_get_device_descriptor(
-                       devlist[i], &des)) != 0) {
-                       sr_warn("failed to get device descriptor: %d", ret);
+                    devlist[i], &des)) != 0) {
+                       sr_warn("fx2lafw: Failed to get device descriptor: %d.", ret);
                        continue;
                }
 
-               fx2lafw_prof = NULL;
+               prof = NULL;
                for (j = 0; supported_fx2[j].vid; j++) {
                        if (des.idVendor == supported_fx2[j].vid &&
                                des.idProduct == supported_fx2[j].pid) {
-                               fx2lafw_prof = &supported_fx2[j];
+                               prof = &supported_fx2[j];
                        }
                }
 
                /* Skip if the device was not found */
-               if(!fx2lafw_prof)
+               if (!prof)
                        continue;
 
                sdi = sr_dev_inst_new(devcnt, SR_ST_INITIALIZING,
-                       fx2lafw_prof->vendor, fx2lafw_prof->model,
-                       fx2lafw_prof->model_version);
-               if(!sdi)
+                       prof->vendor, prof->model, prof->model_version);
+               if (!sdi)
                        return 0;
 
-               ctx = fx2lafw_device_new();
-               ctx->profile = fx2lafw_prof;
+               ctx = fx2lafw_dev_new();
+               ctx->profile = prof;
                sdi->priv = ctx;
                dev_insts = g_slist_append(dev_insts, sdi);
 
                if (check_conf_profile(devlist[i])) {
                        /* Already has the firmware, so fix the new address. */
-                       sr_dbg("fx2lafw: Found a fx2lafw device.");
+                       sr_dbg("fx2lafw: Found an fx2lafw device.");
                        sdi->status = SR_ST_INACTIVE;
                        ctx->usb = sr_usb_dev_inst_new
                            (libusb_get_bus_number(devlist[i]),
                             libusb_get_device_address(devlist[i]), NULL);
                } else {
                        if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
-                               fx2lafw_prof->firmware) == SR_OK)
+                               prof->firmware) == SR_OK)
                                /* Remember when the firmware on this device was updated */
-                               g_get_current_time(&ctx->fw_updated);
+                               ctx->fw_updated = g_get_monotonic_time();
                        else
-                               sr_err("fx2lafw: firmware upload failed for "
-                                      "device %d", devcnt);
+                               sr_err("fx2lafw: Firmware upload failed for "
+                                      "device %d.", devcnt);
                        ctx->usb = sr_usb_dev_inst_new
                                (libusb_get_bus_number(devlist[i]), 0xff, NULL);
                }
@@ -385,46 +437,50 @@ static int hw_init(const char *deviceinfo)
 
 static int hw_dev_open(int dev_index)
 {
-       GTimeVal cur_time;
        struct sr_dev_inst *sdi;
        struct context *ctx;
-       int timediff, ret;
+       int ret;
+       int64_t timediff_us, timediff_ms;
 
        if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
                return SR_ERR;
        ctx = sdi->priv;
 
        /*
-        * 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
+        * milliseconds for the FX2 to renumerate.
         */
        ret = 0;
-       if (GTV_TO_MSEC(ctx->fw_updated) > 0) {
-               sr_info("fx2lafw: waiting for device to reset");
+
+       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 */
                g_usleep(300 * 1000);
-               timediff = 0;
-               while (timediff < MAX_RENUM_DELAY) {
-                       if ((ret = fx2lafw_open_dev(dev_index)) == SR_OK)
+               timediff_ms = 0;
+               while (timediff_ms < MAX_RENUM_DELAY_MS) {
+                       if ((ret = fx2lafw_dev_open(dev_index)) == SR_OK)
                                break;
                        g_usleep(100 * 1000);
-                       g_get_current_time(&cur_time);
-                       timediff = GTV_TO_MSEC(cur_time) - GTV_TO_MSEC(ctx->fw_updated);
+
+                       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);
                }
-               sr_info("fx2lafw: device came back after %d ms", timediff);
+               sr_info("fx2lafw: Device came back after %d ms.", timediff_ms);
        } else {
-               ret = fx2lafw_open_dev(dev_index);
+               ret = fx2lafw_dev_open(dev_index);
        }
 
        if (ret != SR_OK) {
-               sr_err("fx2lafw: unable to open device");
+               sr_err("fx2lafw: Unable to open device.");
                return SR_ERR;
        }
        ctx = sdi->priv;
 
        ret = libusb_claim_interface(ctx->usb->devhdl, USB_INTERFACE);
        if (ret != 0) {
-               sr_err("fx2lafw: Unable to claim interface: %d", ret);
+               sr_err("fx2lafw: Unable to claim interface: %d.", ret);
                return SR_ERR;
        }
 
@@ -443,7 +499,7 @@ static int hw_dev_close(int dev_index)
        struct sr_dev_inst *sdi;
 
        if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) {
-               sr_err("fx2lafw: %s: sdi was NULL", __func__);
+               sr_err("fx2lafw: %s: sdi was NULL.", __func__);
                return SR_ERR_BUG;
        }
 
@@ -460,10 +516,11 @@ static int hw_cleanup(void)
        struct context *ctx;
        int ret = SR_OK;
 
-       for(l = dev_insts; l; l = l->next) {
+       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__);
+                       sr_err("fx2lafw: %s: sdi was NULL, continuing.",
+                              __func__);
                        ret = SR_ERR_BUG;
                        continue;
                }
@@ -482,7 +539,7 @@ static int hw_cleanup(void)
        g_slist_free(dev_insts);
        dev_insts = NULL;
 
-       if(usb_context)
+       if (usb_context)
                libusb_exit(usb_context);
        usb_context = NULL;
 
@@ -504,7 +561,7 @@ static void *hw_dev_info_get(int dev_index, int dev_info_id)
        case SR_DI_NUM_PROBES:
                return GINT_TO_POINTER(ctx->profile->num_probes);
        case SR_DI_PROBE_NAMES:
-               return fx2lafw_probe_names;
+               return probe_names;
        case SR_DI_SAMPLERATES:
                return &samplerates;
        case SR_DI_TRIGGER_TYPES:
@@ -529,7 +586,7 @@ static int hw_dev_status_get(int dev_index)
 
 static int *hw_hwcap_get_all(void)
 {
-       return fx2lafw_capabilities;
+       return hwcaps;
 }
 
 static int hw_dev_config_set(int dev_index, int hwcap, void *value)
@@ -619,7 +676,7 @@ static void receive_transfer(struct libusb_transfer *transfer)
                return;
        }
 
-       sr_info("fx2lafw: receive_transfer(): status %d received %d bytes",
+       sr_info("fx2lafw: receive_transfer(): status %d received %d bytes.",
                transfer->status, transfer->actual_length);
 
        /* Save incoming transfer before reusing the transfer struct. */
@@ -628,7 +685,7 @@ static void receive_transfer(struct libusb_transfer *transfer)
 
        /* Fire off a new request. */
        if (!(new_buf = g_try_malloc(4096))) {
-               sr_err("fx2lafw: %s: new_buf malloc failed", __func__);
+               sr_err("fx2lafw: %s: new_buf malloc failed.", __func__);
                return; /* TODO: SR_ERR_MALLOC */
        }
 
@@ -637,7 +694,7 @@ static void receive_transfer(struct libusb_transfer *transfer)
        if (libusb_submit_transfer(transfer) != 0) {
                /* TODO: Stop session? */
                /* TODO: Better error message. */
-               sr_err("fx2lafw: %s: libusb_submit_transfer error", __func__);
+               sr_err("fx2lafw: %s: libusb_submit_transfer error.", __func__);
        }
 
        if (cur_buflen == 0) {
@@ -750,12 +807,12 @@ static int hw_dev_acquisition_start(int dev_index, void *cb_data)
        ctx->num_samples = 0;
 
        if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
-               sr_err("fx2lafw: %s: packet malloc failed", __func__);
+               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__);
+               sr_err("fx2lafw: %s: header malloc failed.", __func__);
                return SR_ERR_MALLOC;
        }
 
@@ -763,7 +820,7 @@ static int hw_dev_acquisition_start(int dev_index, void *cb_data)
        size = 2048;
        for (i = 0; i < NUM_SIMUL_TRANSFERS; i++) {
                if (!(buf = g_try_malloc(size))) {
-                       sr_err("fx2lafw: %s: buf malloc failed", __func__);
+                       sr_err("fx2lafw: %s: buf malloc failed.", __func__);
                        return SR_ERR_MALLOC;
                }
                transfer = libusb_alloc_transfer(0);
@@ -810,7 +867,7 @@ static int hw_dev_acquisition_stop(int dev_index, void *cb_data)
 {
        struct sr_dev_inst *sdi;
 
-       /* unused parameter */
+       /* Avoid compiler warnings. */
        (void)cb_data;
 
        if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))