]> sigrok.org Git - libsigrok.git/blobdiff - hardware/fx2lafw/fx2lafw.c
fx2lafw: use iManufacturer/iProduct fields to identify our firmware
[libsigrok.git] / hardware / fx2lafw / fx2lafw.c
index 4d8c889b32a46f33f52af25dd1d4b96668673a36..2b62e7e01b87f246e1531e0620639b23f85d9903 100644 (file)
@@ -19,6 +19,7 @@
 
 #include <stdio.h>
 #include <stdlib.h>
+#include <string.h>
 #include <inttypes.h>
 #include <glib.h>
 #include <libusb.h>
@@ -50,10 +51,16 @@ static const struct fx2lafw_profile supported_fx2[] = {
        { 0x0925, 0x3881, "Saleae", "Logic", NULL,
                FIRMWARE_DIR "/fx2lafw-saleae-logic.fw", 8 },
 
+       /*
+        * Default Cypress FX2 without EEPROM
+        */
+       { 0x04B4, 0x8613, "Cypress", "FX2", NULL,
+               FIRMWARE_DIR "/fx2lafw-cypress-fx2.fw", 8 },
+
        { 0, 0, 0, 0, 0, 0, 0 }
 };
 
-static int fx2lafw_capabilities[] = {
+static int hwcaps[] = {
        SR_HWCAP_LOGIC_ANALYZER,
        SR_HWCAP_SAMPLERATE,
 
@@ -63,7 +70,10 @@ static int fx2lafw_capabilities[] = {
        0,
 };
 
-static const char *fx2lafw_probe_names[] = {
+/*
+ * TODO: Different probe_names[] for each supported device.
+ */
+static const char *probe_names[] = {
        "0",
        "1",
        "2",
@@ -76,6 +86,9 @@ static const char *fx2lafw_probe_names[] = {
 };
 
 static uint64_t supported_samplerates[] = {
+       SR_KHZ(200),
+       SR_KHZ(250),
+       SR_KHZ(500),
        SR_MHZ(1),
        SR_MHZ(2),
        SR_MHZ(3),
@@ -85,6 +98,7 @@ static uint64_t supported_samplerates[] = {
        SR_MHZ(12),
        SR_MHZ(16),
        SR_MHZ(24),
+       0,
 };
 
 static struct sr_samplerates samplerates = {
@@ -98,7 +112,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.
@@ -109,60 +123,48 @@ 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. */
+               if (libusb_open(dev, &hdl) != 0)
                        break;
 
-               if (libusb_get_config_descriptor(dev, 0, &conf_dsc) != 0)
+               if (libusb_get_string_descriptor_ascii(hdl,
+                               des.iManufacturer, strdesc, sizeof(strdesc)) < 0)
                        break;
-
-               if (conf_dsc->bNumInterfaces != 1)
-                       /* Need exactly 1 interface. */
-                       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;
 
        if (!(sdi = sr_dev_inst_get(dev_insts, dev_index)))
@@ -174,8 +176,14 @@ 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);
@@ -210,16 +218,32 @@ 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);
+                       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;
+               }
+
+               if (vi.major != FX2LAFW_VERSION_MAJOR ||
+                   vi.minor != FX2LAFW_VERSION_MINOR) {
+                       sr_err("fx2lafw: Expected firmware version %d.%02d "
+                              "got %d.%02d.", FX2LAFW_VERSION_MAJOR,
+                              FX2LAFW_VERSION_MINOR, vi.major, vi.minor);
+                       break;
+               }
+
+               sdi->status = SR_ST_ACTIVE;
+               sr_info("fx2lafw: Opened device %d on %d.%d "
+                       "interface %d, firmware version %d.%02d",
+                       sdi->index, ctx->usb->bus, ctx->usb->address,
+                       USB_INTERFACE, vi.major, vi.minor);
+
                break;
        }
        libusb_free_device_list(devlist, 1);
@@ -291,7 +315,7 @@ 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;
 
@@ -309,11 +333,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;
@@ -321,7 +345,7 @@ 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("fx2lafw: Failed to initialize libusb.");
@@ -338,26 +362,25 @@ static int hw_init(const char *deviceinfo)
                        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);
+                       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);
 
@@ -370,7 +393,7 @@ static int hw_init(const char *deviceinfo)
                             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);
                        else
@@ -399,8 +422,8 @@ static int hw_dev_open(int dev_index)
        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
+        * for the FX2 to renumerate.
         */
        ret = 0;
        if (GTV_TO_MSEC(ctx->fw_updated) > 0) {
@@ -409,7 +432,7 @@ static int hw_dev_open(int dev_index)
                g_usleep(300 * 1000);
                timediff = 0;
                while (timediff < MAX_RENUM_DELAY) {
-                       if ((ret = fx2lafw_open_dev(dev_index)) == SR_OK)
+                       if ((ret = fx2lafw_dev_open(dev_index)) == SR_OK)
                                break;
                        g_usleep(100 * 1000);
                        g_get_current_time(&cur_time);
@@ -417,7 +440,7 @@ static int hw_dev_open(int dev_index)
                }
                sr_info("fx2lafw: Device came back after %d ms.", timediff);
        } else {
-               ret = fx2lafw_open_dev(dev_index);
+               ret = fx2lafw_dev_open(dev_index);
        }
 
        if (ret != SR_OK) {
@@ -509,7 +532,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:
@@ -534,7 +557,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)