]> sigrok.org Git - libsigrok.git/blobdiff - hardware/saleae-logic16/api.c
saleae-logic16: Implemented acquisition.
[libsigrok.git] / hardware / saleae-logic16 / api.c
index 5f0fd1c09d83b8448b383741959b7eaac193abe3..f49eca193dc4ae97b3ca5332072c6861f69783ab 100644 (file)
 #define LOGIC16_PID 0x1001
 #define NUM_PROBES  16
 
+#define USB_INTERFACE          0
+#define USB_CONFIGURATION      1
+#define FX2_FIRMWARE           FIRMWARE_DIR "/saleae-logic16-fx2.fw"
+
+#define MAX_RENUM_DELAY_MS     3000
+#define NUM_SIMUL_TRANSFERS    32
+
+
 SR_PRIV struct sr_dev_driver saleae_logic16_driver_info;
 static struct sr_dev_driver *di = &saleae_logic16_driver_info;
 
@@ -38,32 +46,117 @@ static const char *probe_names[NUM_PROBES + 1] = {
        NULL,
 };
 
+static const uint64_t samplerates[] = {
+       SR_KHZ(500),
+       SR_MHZ(1),
+       SR_MHZ(2),
+       SR_MHZ(4),
+       SR_MHZ(5),
+       SR_MHZ(8),
+       SR_MHZ(10),
+       SR_KHZ(12500),
+       SR_MHZ(16),
+       SR_MHZ(25),
+       SR_MHZ(32),
+       SR_MHZ(40),
+       SR_MHZ(80),
+       SR_MHZ(100),
+};
+
 static int init(struct sr_context *sr_ctx)
 {
        return std_init(sr_ctx, di, LOG_PREFIX);
 }
 
+static gboolean check_conf_profile(libusb_device *dev)
+{
+       struct libusb_device_descriptor des;
+       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. */
+               if (libusb_get_device_descriptor(dev, &des) != 0)
+                       break;
+
+               if (libusb_open(dev, &hdl) != 0)
+                       break;
+
+               if (libusb_get_string_descriptor_ascii(hdl,
+                   des.iManufacturer, strdesc, sizeof(strdesc)) < 0)
+                       break;
+               if (strcmp((const char *)strdesc, "Saleae LLC"))
+                       break;
+
+               if (libusb_get_string_descriptor_ascii(hdl,
+                               des.iProduct, strdesc, sizeof(strdesc)) < 0)
+                       break;
+               if (strcmp((const char *)strdesc, "Logic S/16"))
+                       break;
+
+               /* If we made it here, it must be a configured Logic16. */
+               ret = TRUE;
+       }
+       if (hdl)
+               libusb_close(hdl);
+
+       return ret;
+}
+
 static GSList *scan(GSList *options)
 {
        struct drv_context *drvc;
        struct dev_context *devc;
        struct sr_dev_inst *sdi;
+       struct sr_usb_dev_inst *usb;
        struct sr_probe *probe;
+       struct sr_config *src;
+       GSList *l, *devices, *conn_devices;
        struct libusb_device_descriptor des;
        libusb_device **devlist;
-       GSList *devices;
-       int ret, devcnt, i, j;
-
-       (void)options;
+       int devcnt, ret, i, j;
+       const char *conn;
 
        drvc = di->priv;
 
+       conn = NULL;
+       for (l = options; l; l = l->next) {
+               src = l->data;
+               switch (src->key) {
+               case SR_CONF_CONN:
+                       conn = g_variant_get_string(src->data, NULL);
+                       break;
+               }
+       }
+       if (conn)
+               conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
+       else
+               conn_devices = NULL;
+
+       /* Find all Logic16 devices and upload firmware to them. */
        devices = NULL;
        libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
        for (i = 0; devlist[i]; i++) {
-               if ((ret = libusb_get_device_descriptor(devlist[i], &des)) != 0) {
-                       sr_warn("Failed to get device descriptor: %s",
-                                       libusb_error_name(ret));
+               if (conn) {
+                       usb = NULL;
+                       for (l = conn_devices; l; l = l->next) {
+                               usb = l->data;
+                               if (usb->bus == libusb_get_bus_number(devlist[i])
+                                   && usb->address == libusb_get_device_address(devlist[i]))
+                                       break;
+                       }
+                       if (!l)
+                               /* This device matched none of the ones that
+                                * matched the conn specification. */
+                               continue;
+               }
+
+               if ((ret = libusb_get_device_descriptor( devlist[i], &des)) != 0) {
+                       sr_warn("Failed to get device descriptor: %s.",
+                               libusb_error_name(ret));
                        continue;
                }
 
@@ -71,15 +164,12 @@ static GSList *scan(GSList *options)
                        continue;
 
                devcnt = g_slist_length(drvc->instances);
-               if (!(sdi = sr_dev_inst_new(devcnt, SR_ST_INACTIVE,
-                                           "Saleae", "Logic16", NULL)))
+               sdi = sr_dev_inst_new(devcnt, SR_ST_INITIALIZING,
+                                     "Saleae", "Logic16", NULL);
+               if (!sdi)
                        return NULL;
                sdi->driver = di;
 
-               if (!(devc = g_try_malloc0(sizeof(struct dev_context))))
-                       return NULL;
-               sdi->priv = devc;
-
                for (j = 0; probe_names[j]; j++) {
                        if (!(probe = sr_probe_new(j, SR_PROBE_LOGIC, TRUE,
                                                   probe_names[j])))
@@ -87,15 +177,34 @@ static GSList *scan(GSList *options)
                        sdi->probes = g_slist_append(sdi->probes, probe);
                }
 
-               if (!(sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
-                                                     libusb_get_device_address(devlist[i]), NULL)))
+               if (!(devc = g_try_malloc0(sizeof(struct dev_context))))
                        return NULL;
-               sdi->inst_type = SR_INST_USB;
-
+               sdi->priv = devc;
                drvc->instances = g_slist_append(drvc->instances, sdi);
                devices = g_slist_append(devices, sdi);
+
+               if (check_conf_profile(devlist[i])) {
+                       /* Already has the firmware, so fix the new address. */
+                       sr_dbg("Found a Logic16 device.");
+                       sdi->status = SR_ST_INACTIVE;
+                       sdi->inst_type = SR_INST_USB;
+                       sdi->conn = 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,
+                                                 FX2_FIRMWARE) == SR_OK)
+                               /* Store when this device's FW was updated. */
+                               devc->fw_updated = g_get_monotonic_time();
+                       else
+                               sr_err("Firmware upload failed for "
+                                      "device %d.", devcnt);
+                       sdi->inst_type = SR_INST_USB;
+                       sdi->conn = sr_usb_dev_inst_new (libusb_get_bus_number(devlist[i]),
+                                                        0xff, NULL);
+               }
        }
        libusb_free_device_list(devlist, 1);
+       g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
 
        return devices;
 }
@@ -114,23 +223,177 @@ static int dev_clear(void)
        return std_dev_clear(di, NULL);
 }
 
+static int logic16_dev_open(struct sr_dev_inst *sdi)
+{
+       libusb_device **devlist;
+       struct sr_usb_dev_inst *usb;
+       struct libusb_device_descriptor des;
+       struct dev_context *devc;
+       struct drv_context *drvc;
+       int ret, skip, i, device_count;
+
+       drvc = di->priv;
+       devc = sdi->priv;
+       usb = sdi->conn;
+
+       if (sdi->status == SR_ST_ACTIVE)
+               /* Device is already in use. */
+               return SR_ERR;
+
+       skip = 0;
+       device_count = libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
+       if (device_count < 0) {
+               sr_err("Failed to get device list: %s.",
+                      libusb_error_name(device_count));
+               return SR_ERR;
+       }
+
+       for (i = 0; i < device_count; i++) {
+               if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
+                       sr_err("Failed to get device descriptor: %s.",
+                              libusb_error_name(ret));
+                       continue;
+               }
+
+               if (des.idVendor != LOGIC16_VID
+                   || des.idProduct != LOGIC16_PID)
+                       continue;
+
+               if (sdi->status == SR_ST_INITIALIZING) {
+                       if (skip != sdi->index) {
+                               /* Skip devices of this type that aren't the one we want. */
+                               skip += 1;
+                               continue;
+                       }
+               } else if (sdi->status == SR_ST_INACTIVE) {
+                       /*
+                        * This device is fully enumerated, so we need to find
+                        * this device by vendor, product, bus and address.
+                        */
+                       if (libusb_get_bus_number(devlist[i]) != usb->bus
+                               || libusb_get_device_address(devlist[i]) != usb->address)
+                               /* This is not the one. */
+                               continue;
+               }
+
+               if (!(ret = libusb_open(devlist[i], &usb->devhdl))) {
+                       if (usb->address == 0xff)
+                               /*
+                                * First time we touch this device after FW
+                                * upload, so we don't know the address yet.
+                                */
+                               usb->address = libusb_get_device_address(devlist[i]);
+               } else {
+                       sr_err("Failed to open device: %s.",
+                              libusb_error_name(ret));
+                       break;
+               }
+
+               if ((ret = saleae_logic16_init_device(sdi)) != SR_OK) {
+                       sr_err("Failed to init device.");
+                       break;
+               }
+
+               sdi->status = SR_ST_ACTIVE;
+               sr_info("Opened device %d on %d.%d, "
+                       "interface %d.",
+                       sdi->index, usb->bus, usb->address,
+                       USB_INTERFACE);
+
+               break;
+       }
+       libusb_free_device_list(devlist, 1);
+
+       if (sdi->status != SR_ST_ACTIVE)
+               return SR_ERR;
+
+       return SR_OK;
+}
+
 static int dev_open(struct sr_dev_inst *sdi)
 {
-       (void)sdi;
+       struct sr_usb_dev_inst *usb;
+       struct dev_context *devc;
+       int ret;
+       int64_t timediff_us, timediff_ms;
+
+       devc = sdi->priv;
+       usb = sdi->conn;
+
+       /*
+        * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
+        * milliseconds for the FX2 to renumerate.
+        */
+       ret = SR_ERR;
+       if (devc->fw_updated > 0) {
+               sr_info("Waiting for device to reset.");
+               /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
+               g_usleep(300 * 1000);
+               timediff_ms = 0;
+               while (timediff_ms < MAX_RENUM_DELAY_MS) {
+                       if ((ret = logic16_dev_open(sdi)) == SR_OK)
+                               break;
+                       g_usleep(100 * 1000);
+
+                       timediff_us = g_get_monotonic_time() - devc->fw_updated;
+                       timediff_ms = timediff_us / 1000;
+                       sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
+               }
+               if (ret != SR_OK) {
+                       sr_err("Device failed to renumerate.");
+                       return SR_ERR;
+               }
+               sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
+       } else {
+               sr_info("Firmware upload was not needed.");
+               ret = logic16_dev_open(sdi);
+       }
+
+       if (ret != SR_OK) {
+               sr_err("Unable to open device.");
+               return SR_ERR;
+       }
 
-       /* TODO: get handle from sdi->conn and open it. */
+       ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
+       if (ret != 0) {
+               switch(ret) {
+               case LIBUSB_ERROR_BUSY:
+                       sr_err("Unable to claim USB interface. Another "
+                              "program or driver has already claimed it.");
+                       break;
+               case LIBUSB_ERROR_NO_DEVICE:
+                       sr_err("Device has been disconnected.");
+                       break;
+               default:
+                       sr_err("Unable to claim interface: %s.",
+                              libusb_error_name(ret));
+                       break;
+               }
 
-       sdi->status = SR_ST_ACTIVE;
+               return SR_ERR;
+       }
+
+       if (devc->cur_samplerate == 0) {
+               /* Samplerate hasn't been set; default to the slowest one. */
+               devc->cur_samplerate = samplerates[0];
+       }
 
        return SR_OK;
 }
 
 static int dev_close(struct sr_dev_inst *sdi)
 {
-       (void)sdi;
+       struct sr_usb_dev_inst *usb;
 
-       /* TODO: get handle from sdi->conn and close it. */
+       usb = sdi->conn;
+       if (usb->devhdl == NULL)
+               return SR_ERR;
 
+       sr_info("Closing device %d on %d.%d interface %d.",
+               sdi->index, usb->bus, usb->address, USB_INTERFACE);
+       libusb_release_interface(usb->devhdl, USB_INTERFACE);
+       libusb_close(usb->devhdl);
+       usb->devhdl = NULL;
        sdi->status = SR_ST_INACTIVE;
 
        return SR_OK;
@@ -154,6 +417,7 @@ static int cleanup(void)
 
 static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi)
 {
+       struct dev_context *devc;
        int ret;
 
        (void)sdi;
@@ -161,7 +425,12 @@ static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi)
 
        ret = SR_OK;
        switch (key) {
-       /* TODO */
+       case SR_CONF_SAMPLERATE:
+               if (!sdi)
+                       return SR_ERR;
+               devc = sdi->priv;
+               *data = g_variant_new_uint64(devc->cur_samplerate);
+               break;
        default:
                return SR_ERR_NA;
        }
@@ -171,16 +440,22 @@ static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi)
 
 static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi)
 {
+       struct dev_context *devc;
        int ret;
 
-       (void)data;
-
        if (sdi->status != SR_ST_ACTIVE)
                return SR_ERR_DEV_CLOSED;
 
+       devc = sdi->priv;
+
        ret = SR_OK;
        switch (key) {
-       /* TODO */
+       case SR_CONF_SAMPLERATE:
+               devc->cur_samplerate = g_variant_get_uint64(data);
+               break;
+       case SR_CONF_LIMIT_SAMPLES:
+               devc->limit_samples = g_variant_get_uint64(data);
+               break;
        default:
                ret = SR_ERR_NA;
        }
@@ -190,14 +465,21 @@ static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi)
 
 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
 {
+       GVariant *gvar;
+       GVariantBuilder gvb;
        int ret;
 
        (void)sdi;
-       (void)data;
 
        ret = SR_OK;
        switch (key) {
-       /* TODO */
+       case SR_CONF_SAMPLERATE:
+               g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
+               gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
+                               ARRAY_SIZE(samplerates), sizeof(uint64_t));
+               g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
+               *data = g_variant_builder_end(&gvb);
+               break;
        default:
                return SR_ERR_NA;
        }
@@ -205,31 +487,244 @@ static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
        return ret;
 }
 
+static void abort_acquisition(struct dev_context *devc)
+{
+       int i;
+
+       devc->num_samples = -1;
+
+       for (i = devc->num_transfers - 1; i >= 0; i--) {
+               if (devc->transfers[i])
+                       libusb_cancel_transfer(devc->transfers[i]);
+       }
+}
+
+static unsigned int bytes_per_ms(struct dev_context *devc)
+{
+       return devc->cur_samplerate * devc->num_channels / 8000;
+}
+
+static size_t get_buffer_size(struct dev_context *devc)
+{
+       size_t s;
+
+       /*
+        * The buffer should be large enough to hold 10ms of data and
+        * a multiple of 512.
+        */
+       s = 10 * bytes_per_ms(devc);
+       return (s + 511) & ~511;
+}
+
+static unsigned int get_number_of_transfers(struct dev_context *devc)
+{
+       unsigned int n;
+
+       /* Total buffer size should be able to hold about 500ms of data. */
+       n = 500 * bytes_per_ms(devc) / get_buffer_size(devc);
+
+       if (n > NUM_SIMUL_TRANSFERS)
+               return NUM_SIMUL_TRANSFERS;
+
+       return n;
+}
+
+static unsigned int get_timeout(struct dev_context *devc)
+{
+       size_t total_size;
+       unsigned int timeout;
+
+       total_size = get_buffer_size(devc) * get_number_of_transfers(devc);
+       timeout = total_size / bytes_per_ms(devc);
+       return timeout + timeout / 4; /* Leave a headroom of 25% percent. */
+}
+
+static int configure_probes(const struct sr_dev_inst *sdi)
+{
+       struct dev_context *devc;
+       struct sr_probe *probe;
+       GSList *l;
+       uint16_t probe_bit;
+
+       devc = sdi->priv;
+
+       devc->cur_channels = 0;
+       devc->num_channels = 0;
+       for (l = sdi->probes; l; l = l->next) {
+               probe = (struct sr_probe *)l->data;
+               if (probe->enabled == FALSE)
+                       continue;
+
+               probe_bit = 1 << (probe->index);
+
+               devc->cur_channels |= probe_bit;
+
+#ifdef WORDS_BIGENDIAN
+               /* Output logic data should be stored in little endian
+                  format.  To speed things up during conversion, do the
+                  switcharoo here instead. */
+
+               probe_bit = 1 << (probe->index ^ 8);
+#endif
+
+               devc->channel_masks[devc->num_channels ++] = probe_bit;
+       }
+
+       return SR_OK;
+}
+
+static int receive_data(int fd, int revents, void *cb_data)
+{
+       struct timeval tv;
+       struct dev_context *devc;
+       struct drv_context *drvc;
+       const struct sr_dev_inst *sdi;
+
+       (void)fd;
+       (void)revents;
+
+       sdi = cb_data;
+       drvc = di->priv;
+       devc = sdi->priv;
+
+       tv.tv_sec = tv.tv_usec = 0;
+       libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
+
+       if (devc->num_samples == -2) {
+               saleae_logic16_abort_acquisition(sdi);
+               abort_acquisition(devc);
+       }
+
+       return TRUE;
+}
+
 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
-                                   void *cb_data)
+                                void *cb_data)
 {
-       (void)sdi;
-       (void)cb_data;
+       struct dev_context *devc;
+       struct drv_context *drvc;
+       struct sr_usb_dev_inst *usb;
+       struct libusb_transfer *transfer;
+       const struct libusb_pollfd **lupfd;
+       unsigned int i, timeout, num_transfers;
+       int ret;
+       unsigned char *buf;
+       size_t size, convsize;
 
        if (sdi->status != SR_ST_ACTIVE)
                return SR_ERR_DEV_CLOSED;
 
-       /* TODO: configure hardware, reset acquisition state, set up
-        * callbacks and send header packet. */
+       drvc = di->priv;
+       devc = sdi->priv;
+       usb = sdi->conn;
+
+       /* Configures devc->cur_channels */
+       if (configure_probes(sdi) != SR_OK) {
+               sr_err("Failed to configure probes.");
+               return SR_ERR;
+       }
+
+       devc->cb_data = cb_data;
+       devc->num_samples = 0;
+       devc->empty_transfer_count = 0;
+       devc->cur_channel = 0;
+       memset(devc->channel_data, 0, sizeof(devc->channel_data));
+
+       timeout = get_timeout(devc);
+       num_transfers = get_number_of_transfers(devc);
+       size = get_buffer_size(devc);
+       convsize = (size / devc->num_channels + 2) * 16;
+       devc->submitted_transfers = 0;
+       devc->usbfd = NULL;
+
+       devc->convbuffer_size = convsize;
+       if (!(devc->convbuffer = g_try_malloc(convsize))) {
+               sr_err("Conversion buffer malloc failed.");
+               return SR_ERR_MALLOC;
+       }
+
+       devc->transfers = g_try_malloc0(sizeof(*devc->transfers) * num_transfers);
+       if (!devc->transfers) {
+               sr_err("USB transfers malloc failed.");
+               g_free(devc->convbuffer);
+               return SR_ERR_MALLOC;
+       }
+
+       if ((ret = saleae_logic16_setup_acquisition(sdi, devc->cur_samplerate,
+                                                   devc->cur_channels)) != SR_OK) {
+               g_free(devc->transfers);
+               g_free(devc->convbuffer);
+               return ret;
+       }
+
+       devc->num_transfers = num_transfers;
+       for (i = 0; i < num_transfers; i++) {
+               if (!(buf = g_try_malloc(size))) {
+                       sr_err("USB transfer buffer malloc failed.");
+                       if (devc->submitted_transfers)
+                               abort_acquisition(devc);
+                       else {
+                               g_free(devc->transfers);
+                               g_free(devc->convbuffer);
+                       }
+                       return SR_ERR_MALLOC;
+               }
+               transfer = libusb_alloc_transfer(0);
+               libusb_fill_bulk_transfer(transfer, usb->devhdl,
+                               2 | LIBUSB_ENDPOINT_IN, buf, size,
+                               saleae_logic16_receive_transfer, devc, timeout);
+               if ((ret = libusb_submit_transfer(transfer)) != 0) {
+                       sr_err("Failed to submit transfer: %s.",
+                              libusb_error_name(ret));
+                       libusb_free_transfer(transfer);
+                       g_free(buf);
+                       abort_acquisition(devc);
+                       return SR_ERR;
+               }
+               devc->transfers[i] = transfer;
+               devc->submitted_transfers++;
+       }
+
+       lupfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
+       for (i = 0; lupfd[i]; i++);
+       if (!(devc->usbfd = g_try_malloc(sizeof(struct libusb_pollfd) * (i + 1)))) {
+               abort_acquisition(devc);
+               free(lupfd);
+               return SR_ERR;
+       }
+       for (i = 0; lupfd[i]; i++) {
+               sr_source_add(lupfd[i]->fd, lupfd[i]->events,
+                             timeout, receive_data, (void *)sdi);
+               devc->usbfd[i] = lupfd[i]->fd;
+       }
+       devc->usbfd[i] = -1;
+       free(lupfd);
+
+       /* Send header packet to the session bus. */
+       std_session_send_df_header(cb_data, LOG_PREFIX);
+
+       if ((ret = saleae_logic16_start_acquisition(sdi)) != SR_OK) {
+               abort_acquisition(devc);
+               return ret;
+       }
 
        return SR_OK;
 }
 
 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 {
+       int ret;
+
        (void)cb_data;
 
        if (sdi->status != SR_ST_ACTIVE)
                return SR_ERR_DEV_CLOSED;
 
-       /* TODO: stop acquisition. */
+       ret = saleae_logic16_abort_acquisition(sdi);
 
-       return SR_OK;
+       abort_acquisition(sdi->priv);
+
+       return ret;
 }
 
 SR_PRIV struct sr_dev_driver saleae_logic16_driver_info = {