]> sigrok.org Git - libsigrok.git/blobdiff - hardware/fx2lafw/fx2lafw.c
hantek-dso: Update to constified libsigrok API.
[libsigrok.git] / hardware / fx2lafw / fx2lafw.c
index ab5dfb5b4b1f6a10fa8bc2c833d1e0c42ad2b7a5..2c0c6360164a70f37a59aedd93950a154dec298a 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"
@@ -32,28 +33,49 @@ static const struct fx2lafw_profile supported_fx2[] = {
        /*
         * 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
         * EE Electronics ESLA100
         * Robomotic MiniLogic
+        * 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.:
+        * Lcsoft Mini Board
+        * Braintechnology USB Interface V2.x
+        */
+       { 0x04B4, 0x8613, "Cypress", "FX2", NULL,
+               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",
+               DEV_CAPS_16BIT },
 
        { 0, 0, 0, 0, 0, 0, 0 }
 };
 
-static int hwcaps[] = {
+static const int hwcaps[] = {
        SR_HWCAP_LOGIC_ANALYZER,
        SR_HWCAP_SAMPLERATE,
 
@@ -75,10 +97,25 @@ 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),
+       SR_KHZ(100),
+       SR_KHZ(200),
+       SR_KHZ(250),
+       SR_KHZ(500),
        SR_MHZ(1),
        SR_MHZ(2),
        SR_MHZ(3),
@@ -88,9 +125,10 @@ static uint64_t supported_samplerates[] = {
        SR_MHZ(12),
        SR_MHZ(16),
        SR_MHZ(24),
+       0,
 };
 
-static struct sr_samplerates samplerates = {
+static const struct sr_samplerates samplerates = {
        0,
        0,
        0,
@@ -100,7 +138,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);
 
 /**
@@ -112,48 +150,37 @@ static int hw_dev_acquisition_stop(int dev_index, void *cb_data);
 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 FW has not been loaded, unless proven wrong. */
-               ret = FALSE;
-
                if (libusb_get_device_descriptor(dev, &des) != 0)
                        break;
 
-               /* Need exactly 1 configuration. */
-               if (des.bNumConfigurations != 1)
+               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;
-
-               /* Need exactly 1 interface. */
-               if (conf_dsc->bNumInterfaces != 1)
+               if (strncmp((const char *)strdesc, "sigrok", 6))
                        break;
 
-               /* Need just one alternate setting. */
-               if (conf_dsc->interface[0].num_altsetting != 1)
+               if (libusb_get_string_descriptor_ascii(hdl,
+                               des.iProduct, strdesc, sizeof(strdesc)) < 0)
                        break;
-
-               /* Need exactly 2 endpoints. */
-               intf_dsc = &(conf_dsc->interface[0].altsetting[0]);
-               if (intf_dsc->bNumEndpoints != 2)
-                       break;
-
-               /* The first endpoint should be 2 (inbound). */
-               if ((intf_dsc->endpoint[0].bEndpointAddress & 0x8f) !=
-                   (2 | LIBUSB_ENDPOINT_IN))
+               if (strncmp((const char *)strdesc, "fx2lafw", 7))
                        break;
 
                /* 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;
 }
@@ -166,6 +193,7 @@ static int fx2lafw_dev_open(int dev_index)
        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;
@@ -230,19 +258,29 @@ 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.%02d "
-                              "got %d.%02d.", FX2LAFW_VERSION_MAJOR,
-                              FX2LAFW_VERSION_MINOR, vi.major, vi.minor);
+               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 version %d.%02d",
+                       "interface %d, firmware %d.%d, REVID %d.",
                        sdi->index, ctx->usb->bus, ctx->usb->address,
-                       USB_INTERFACE, vi.major, vi.minor);
+                       USB_INTERFACE, vi.major, vi.minor, revid);
 
                break;
        }
@@ -288,6 +326,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;
@@ -352,7 +394,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++) {
 
@@ -395,7 +437,7 @@ static int hw_init(const char *devinfo)
                        if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
                                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);
@@ -412,33 +454,37 @@ static int hw_init(const char *devinfo)
 
 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) {
+
+       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) {
+               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_dev_open(dev_index);
        }
@@ -517,7 +563,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;
@@ -530,7 +576,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:
@@ -555,12 +603,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;
@@ -571,12 +619,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;
@@ -629,8 +677,8 @@ static void receive_transfer(struct libusb_transfer *transfer)
        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;
+       uint8_t *new_buf;
 
        /*
         * If acquisition has already ended, just free any queued up
@@ -651,8 +699,9 @@ 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;
+       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;
 
        /* Fire off a new request. */
        if (!(new_buf = g_try_malloc(4096))) {
@@ -668,7 +717,7 @@ static void receive_transfer(struct libusb_transfer *transfer)
                sr_err("fx2lafw: %s: libusb_submit_transfer error.", __func__);
        }
 
-       if (cur_buflen == 0) {
+       if (transfer->actual_length == 0) {
                empty_transfer_count++;
                if (empty_transfer_count > MAX_EMPTY_TRANSFERS) {
                        /*
@@ -684,14 +733,20 @@ static void receive_transfer(struct libusb_transfer *transfer)
 
        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;
 
@@ -739,15 +794,16 @@ static void receive_transfer(struct libusb_transfer *transfer)
 
        if (ctx->trigger_stage == TRIGGER_FIRED) {
                /* Send the incoming transfer to the session bus. */
+               const 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);
@@ -765,6 +821,7 @@ 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_meta_logic meta;
        struct context *ctx;
        struct libusb_transfer *transfer;
        const struct libusb_pollfd **lupfd;
@@ -819,14 +876,20 @@ static int hw_dev_acquisition_start(int dev_index, void *cb_data)
        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);
+
+       /* 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);
+
        g_free(header);
        g_free(packet);
 
        if ((ret = command_start_acquisition (ctx->usb->devhdl,
-               ctx->cur_samplerate)) != SR_OK) {
+               ctx->cur_samplerate, ctx->sample_wide)) != SR_OK) {
                return ret;
        }