]> sigrok.org Git - libsigrok.git/blobdiff - hardware/saleae-logic16/api.c
probe_groups: API changes required to implement probe groups.
[libsigrok.git] / hardware / saleae-logic16 / api.c
index f49eca193dc4ae97b3ca5332072c6861f69783ab..e399729e9b09d9d5a9dae883cc42ca744c0135f6 100644 (file)
@@ -2,6 +2,8 @@
  * This file is part of the libsigrok project.
  *
  * Copyright (C) 2013 Marcus Comstedt <marcus@mc.pp.se>
+ * Copyright (C) 2013 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
  * it under the terms of the GNU General Public License as published by
 #include <libusb.h>
 #include <stdlib.h>
 #include <string.h>
+#include <math.h>
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 #include "protocol.h"
 
-#define LOGIC16_VID 0x21a9
-#define LOGIC16_PID 0x1001
-#define NUM_PROBES  16
+#define LOGIC16_VID            0x21a9
+#define LOGIC16_PID            0x1001
 
 #define USB_INTERFACE          0
 #define USB_CONFIGURATION      1
 #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;
 
-static const char *probe_names[NUM_PROBES + 1] = {
+static const int32_t hwopts[] = {
+       SR_CONF_CONN,
+};
+
+static const int32_t hwcaps[] = {
+       SR_CONF_LOGIC_ANALYZER,
+       SR_CONF_SAMPLERATE,
+       SR_CONF_VOLTAGE_THRESHOLD,
+
+       /* These are really implemented in the driver, not the hardware. */
+       SR_CONF_LIMIT_SAMPLES,
+       SR_CONF_CONTINUOUS,
+};
+
+static const char *probe_names[] = {
        "0", "1", "2", "3", "4", "5", "6", "7", "8",
        "9", "10", "11", "12", "13", "14", "15",
        NULL,
 };
 
+static const struct {
+       enum voltage_range range;
+       gdouble low;
+       gdouble high;
+} volt_thresholds[] = {
+       { VOLTAGE_RANGE_18_33_V, 0.7, 1.4 },
+       { VOLTAGE_RANGE_5_V,     1.4, 3.6 },
+};
+
 static const uint64_t samplerates[] = {
        SR_KHZ(500),
        SR_MHZ(1),
@@ -92,7 +116,7 @@ static gboolean check_conf_profile(libusb_device *dev)
                        break;
 
                if (libusb_get_string_descriptor_ascii(hdl,
-                               des.iProduct, strdesc, sizeof(strdesc)) < 0)
+                   des.iProduct, strdesc, sizeof(strdesc)) < 0)
                        break;
                if (strcmp((const char *)strdesc, "Logic S/16"))
                        break;
@@ -154,7 +178,7 @@ static GSList *scan(GSList *options)
                                continue;
                }
 
-               if ((ret = libusb_get_device_descriptor( devlist[i], &des)) != 0) {
+               if ((ret = libusb_get_device_descriptor(devlist[i], &des)) != 0) {
                        sr_warn("Failed to get device descriptor: %s.",
                                libusb_error_name(ret));
                        continue;
@@ -179,6 +203,7 @@ static GSList *scan(GSList *options)
 
                if (!(devc = g_try_malloc0(sizeof(struct dev_context))))
                        return NULL;
+               devc->selected_voltage_range = VOLTAGE_RANGE_18_33_V;
                sdi->priv = devc;
                drvc->instances = g_slist_append(drvc->instances, sdi);
                devices = g_slist_append(devices, sdi);
@@ -188,8 +213,9 @@ static GSList *scan(GSList *options)
                        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);
+                       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)
@@ -199,8 +225,8 @@ static GSList *scan(GSList *options)
                                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);
+                       sdi->conn = sr_usb_dev_inst_new(
+                               libusb_get_bus_number(devlist[i]), 0xff, NULL);
                }
        }
        libusb_free_device_list(devlist, 1);
@@ -211,11 +237,7 @@ static GSList *scan(GSList *options)
 
 static GSList *dev_list(void)
 {
-       struct drv_context *drvc;
-
-       drvc = di->priv;
-
-       return drvc->instances;
+       return ((struct drv_context *)(di->priv))->instances;
 }
 
 static int dev_clear(void)
@@ -228,12 +250,10 @@ 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)
@@ -255,8 +275,7 @@ static int logic16_dev_open(struct sr_dev_inst *sdi)
                        continue;
                }
 
-               if (des.idVendor != LOGIC16_VID
-                   || des.idProduct != LOGIC16_PID)
+               if (des.idVendor != LOGIC16_VID || des.idProduct != LOGIC16_PID)
                        continue;
 
                if (sdi->status == SR_ST_INITIALIZING) {
@@ -271,7 +290,7 @@ static int logic16_dev_open(struct sr_dev_inst *sdi)
                         * 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)
+                           || libusb_get_device_address(devlist[i]) != usb->address)
                                /* This is not the one. */
                                continue;
                }
@@ -289,36 +308,52 @@ static int logic16_dev_open(struct sr_dev_inst *sdi)
                        break;
                }
 
-               if ((ret = saleae_logic16_init_device(sdi)) != SR_OK) {
+               ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
+               if (ret == LIBUSB_ERROR_BUSY) {
+                       sr_err("Unable to claim USB interface. Another "
+                              "program or driver has already claimed it.");
+                       break;
+               } else if (ret == LIBUSB_ERROR_NO_DEVICE) {
+                       sr_err("Device has been disconnected.");
+                       break;
+               } else if (ret != 0) {
+                       sr_err("Unable to claim interface: %s.",
+                              libusb_error_name(ret));
+                       break;
+               }
+
+               if ((ret = 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);
+               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)
+       if (sdi->status != SR_ST_ACTIVE) {
+               if (usb->devhdl) {
+                       libusb_release_interface(usb->devhdl, USB_INTERFACE);
+                       libusb_close(usb->devhdl);
+                       usb->devhdl = NULL;
+               }
                return SR_ERR;
+       }
 
        return SR_OK;
 }
 
 static int dev_open(struct sr_dev_inst *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
@@ -354,25 +389,6 @@ static int dev_open(struct sr_dev_inst *sdi)
                return SR_ERR;
        }
 
-       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;
-               }
-
-               return SR_ERR;
-       }
-
        if (devc->cur_samplerate == 0) {
                /* Samplerate hasn't been set; default to the slowest one. */
                devc->cur_samplerate = samplerates[0];
@@ -415,22 +431,53 @@ static int cleanup(void)
        return ret;
 }
 
-static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi)
+static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi,
+               const struct sr_probe_group *probe_group)
 {
        struct dev_context *devc;
+       struct sr_usb_dev_inst *usb;
+       GVariant *range[2];
+       char str[128];
        int ret;
+       unsigned int i;
 
-       (void)sdi;
-       (void)data;
+       (void)probe_group;
 
        ret = SR_OK;
        switch (key) {
+       case SR_CONF_CONN:
+               if (!sdi || !sdi->conn)
+                       return SR_ERR_ARG;
+               usb = sdi->conn;
+               if (usb->address == 255)
+                       /* Device still needs to re-enumerate after firmware
+                        * upload, so we don't know its (future) address. */
+                       return SR_ERR;
+               snprintf(str, 128, "%d.%d", usb->bus, usb->address);
+               *data = g_variant_new_string(str);
+               break;
        case SR_CONF_SAMPLERATE:
                if (!sdi)
                        return SR_ERR;
                devc = sdi->priv;
                *data = g_variant_new_uint64(devc->cur_samplerate);
                break;
+       case SR_CONF_VOLTAGE_THRESHOLD:
+               if (!sdi)
+                       return SR_ERR;
+               devc = sdi->priv;
+               ret = SR_ERR;
+               for (i = 0; i < ARRAY_SIZE(volt_thresholds); i++) {
+                       if (devc->selected_voltage_range !=
+                           volt_thresholds[i].range)
+                               continue;
+                       range[0] = g_variant_new_double(volt_thresholds[i].low);
+                       range[1] = g_variant_new_double(volt_thresholds[i].high);
+                       *data = g_variant_new_tuple(range, 2);
+                       ret = SR_OK;
+                       break;
+               }
+               break;
        default:
                return SR_ERR_NA;
        }
@@ -438,10 +485,15 @@ static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi)
        return ret;
 }
 
-static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi)
+static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi,
+               const struct sr_probe_group *probe_group)
 {
        struct dev_context *devc;
+       gdouble low, high;
        int ret;
+       unsigned int i;
+
+       (void)probe_group;
 
        if (sdi->status != SR_ST_ACTIVE)
                return SR_ERR_DEV_CLOSED;
@@ -456,6 +508,19 @@ static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi)
        case SR_CONF_LIMIT_SAMPLES:
                devc->limit_samples = g_variant_get_uint64(data);
                break;
+       case SR_CONF_VOLTAGE_THRESHOLD:
+               g_variant_get(data, "(dd)", &low, &high);
+               ret = SR_ERR_ARG;
+               for (i = 0; i < ARRAY_SIZE(volt_thresholds); i++) {
+                       if (fabs(volt_thresholds[i].low - low) < 0.1 &&
+                           fabs(volt_thresholds[i].high - high) < 0.1) {
+                               devc->selected_voltage_range =
+                                       volt_thresholds[i].range;
+                               ret = SR_OK;
+                               break;
+                       }
+               }
+               break;
        default:
                ret = SR_ERR_NA;
        }
@@ -463,23 +528,44 @@ static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi)
        return ret;
 }
 
-static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
+static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
+               const struct sr_probe_group *probe_group)
 {
-       GVariant *gvar;
+       GVariant *gvar, *range[2];
        GVariantBuilder gvb;
        int ret;
+       unsigned int i;
 
        (void)sdi;
+       (void)probe_group;
 
        ret = SR_OK;
        switch (key) {
+       case SR_CONF_SCAN_OPTIONS:
+               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
+                               hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
+               break;
+       case SR_CONF_DEVICE_OPTIONS:
+               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
+                               hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
+               break;
        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));
+               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;
+       case SR_CONF_VOLTAGE_THRESHOLD:
+               g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
+               for (i = 0; i < ARRAY_SIZE(volt_thresholds); i++) {
+                       range[0] = g_variant_new_double(volt_thresholds[i].low);
+                       range[1] = g_variant_new_double(volt_thresholds[i].high);
+                       gvar = g_variant_new_tuple(range, 2);
+                       g_variant_builder_add_value(&gvb, gvar);
+               }
+               *data = g_variant_builder_end(&gvb);
+               break;
        default:
                return SR_ERR_NA;
        }
@@ -560,14 +646,15 @@ static int configure_probes(const struct sr_dev_inst *sdi)
                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. */
-
+               /*
+                * 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;
+               devc->channel_masks[devc->num_channels++] = probe_bit;
        }
 
        return SR_OK;
@@ -591,15 +678,14 @@ static int receive_data(int fd, int revents, void *cb_data)
        libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
 
        if (devc->num_samples == -2) {
-               saleae_logic16_abort_acquisition(sdi);
+               logic16_abort_acquisition(sdi);
                abort_acquisition(devc);
        }
 
        return TRUE;
 }
 
-static int dev_acquisition_start(const struct sr_dev_inst *sdi,
-                                void *cb_data)
+static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
 {
        struct dev_context *devc;
        struct drv_context *drvc;
@@ -618,7 +704,7 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi,
        devc = sdi->priv;
        usb = sdi->conn;
 
-       /* Configures devc->cur_channels */
+       /* Configures devc->cur_channels. */
        if (configure_probes(sdi) != SR_OK) {
                sr_err("Failed to configure probes.");
                return SR_ERR;
@@ -650,8 +736,8 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi,
                return SR_ERR_MALLOC;
        }
 
-       if ((ret = saleae_logic16_setup_acquisition(sdi, devc->cur_samplerate,
-                                                   devc->cur_channels)) != SR_OK) {
+       if ((ret = logic16_setup_acquisition(sdi, devc->cur_samplerate,
+                                            devc->cur_channels)) != SR_OK) {
                g_free(devc->transfers);
                g_free(devc->convbuffer);
                return ret;
@@ -672,7 +758,7 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi,
                transfer = libusb_alloc_transfer(0);
                libusb_fill_bulk_transfer(transfer, usb->devhdl,
                                2 | LIBUSB_ENDPOINT_IN, buf, size,
-                               saleae_logic16_receive_transfer, devc, timeout);
+                               logic16_receive_transfer, devc, timeout);
                if ((ret = libusb_submit_transfer(transfer)) != 0) {
                        sr_err("Failed to submit transfer: %s.",
                               libusb_error_name(ret));
@@ -687,7 +773,8 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi,
 
        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)))) {
+       devc->usbfd = g_try_malloc(sizeof(struct libusb_pollfd) * (i + 1));
+       if (!devc->usbfd) {
                abort_acquisition(devc);
                free(lupfd);
                return SR_ERR;
@@ -703,7 +790,7 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi,
        /* 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) {
+       if ((ret = logic16_start_acquisition(sdi)) != SR_OK) {
                abort_acquisition(devc);
                return ret;
        }
@@ -720,7 +807,7 @@ static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
        if (sdi->status != SR_ST_ACTIVE)
                return SR_ERR_DEV_CLOSED;
 
-       ret = saleae_logic16_abort_acquisition(sdi);
+       ret = logic16_abort_acquisition(sdi);
 
        abort_acquisition(sdi->priv);