]> sigrok.org Git - libsigrok.git/blobdiff - src/hardware/saleae-logic16/api.c
output/csv: use intermediate time_t var, silence compiler warning
[libsigrok.git] / src / hardware / saleae-logic16 / api.c
index c30900b2ccdea4abe111d61c8bee27de0aa763dc..99916e44e1343cbfedaffc961dba3250178b80bc 100644 (file)
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+#include <config.h>
 #include <glib.h>
 #include <libusb.h>
 #include <stdlib.h>
 #include <string.h>
 #include <math.h>
-#include "libsigrok.h"
+#include <libsigrok/libsigrok.h>
 #include "libsigrok-internal.h"
 #include "protocol.h"
 
 
 #define USB_INTERFACE          0
 #define USB_CONFIGURATION      1
-#define FX2_FIRMWARE           FIRMWARE_DIR "/saleae-logic16-fx2.fw"
+#define FX2_FIRMWARE           "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;
-
 static const uint32_t scanopts[] = {
        SR_CONF_CONN,
 };
 
-static const uint32_t devopts[] = {
+static const uint32_t drvopts[] = {
        SR_CONF_LOGIC_ANALYZER,
+};
+
+static const uint32_t devopts[] = {
        SR_CONF_CONTINUOUS,
        SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
        SR_CONF_CONN | SR_CONF_GET,
        SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
        SR_CONF_VOLTAGE_THRESHOLD | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
        SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
+       SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
 };
 
-static const int32_t soft_trigger_matches[] = {
+static const int32_t trigger_matches[] = {
        SR_TRIGGER_ZERO,
        SR_TRIGGER_ONE,
        SR_TRIGGER_RISING,
@@ -66,16 +68,18 @@ static const int32_t soft_trigger_matches[] = {
 static const char *channel_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 },
+} thresholds_ranges[] = {
+       { VOLTAGE_RANGE_18_33_V, },
+       { VOLTAGE_RANGE_5_V, },
+};
+
+static const double thresholds[][2] = {
+       { 0.7, 1.4 },
+       { 1.4, 3.6 },
 };
 
 static const uint64_t samplerates[] = {
@@ -88,18 +92,15 @@ static const uint64_t samplerates[] = {
        SR_MHZ(10),
        SR_KHZ(12500),
        SR_MHZ(16),
+       SR_MHZ(20),
        SR_MHZ(25),
        SR_MHZ(32),
        SR_MHZ(40),
+       SR_MHZ(50),
        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;
@@ -111,8 +112,7 @@ static gboolean check_conf_profile(libusb_device *dev)
        ret = FALSE;
        while (!ret) {
                /* Assume the FW has not been loaded, unless proven wrong. */
-               if (libusb_get_device_descriptor(dev, &des) != 0)
-                       break;
+               libusb_get_device_descriptor(dev, &des);
 
                if (libusb_open(dev, &hdl) != 0)
                        break;
@@ -138,22 +138,21 @@ static gboolean check_conf_profile(libusb_device *dev)
        return ret;
 }
 
-static GSList *scan(GSList *options)
+static GSList *scan(struct sr_dev_driver *di, GSList *options)
 {
        struct drv_context *drvc;
        struct dev_context *devc;
        struct sr_dev_inst *sdi;
        struct sr_usb_dev_inst *usb;
-       struct sr_channel *ch;
        struct sr_config *src;
        GSList *l, *devices, *conn_devices;
        struct libusb_device_descriptor des;
        libusb_device **devlist;
-       int ret, i, j;
+       unsigned int i, j;
        const char *conn;
        char connection_id[64];
 
-       drvc = di->priv;
+       drvc = di->context;
 
        conn = NULL;
        for (l = options; l; l = l->next) {
@@ -187,13 +186,10 @@ static GSList *scan(GSList *options)
                                continue;
                }
 
-               if ((ret = libusb_get_device_descriptor(devlist[i], &des)) != 0) {
-                       sr_warn("Failed to get device descriptor: %s.",
-                               libusb_error_name(ret));
-                       continue;
-               }
+               libusb_get_device_descriptor(devlist[i], &des);
 
-               usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
+               if (usb_get_port_path(devlist[i], connection_id, sizeof(connection_id)) < 0)
+                       continue;
 
                if (des.idVendor != LOGIC16_VID || des.idProduct != LOGIC16_PID)
                        continue;
@@ -202,19 +198,15 @@ static GSList *scan(GSList *options)
                sdi->status = SR_ST_INITIALIZING;
                sdi->vendor = g_strdup("Saleae");
                sdi->model = g_strdup("Logic16");
-               sdi->driver = di;
                sdi->connection_id = g_strdup(connection_id);
 
-               for (j = 0; channel_names[j]; j++) {
-                       ch = sr_channel_new(j, SR_CHANNEL_LOGIC, TRUE,
-                                           channel_names[j]);
-                       sdi->channels = g_slist_append(sdi->channels, ch);
-               }
+               for (j = 0; j < ARRAY_SIZE(channel_names); j++)
+                       sr_channel_new(sdi, j, SR_CHANNEL_LOGIC, TRUE,
+                                       channel_names[j]);
 
                devc = g_malloc0(sizeof(struct dev_context));
                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);
 
                if (check_conf_profile(devlist[i])) {
@@ -226,12 +218,13 @@ static GSList *scan(GSList *options)
                                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)
+                       if (ezusb_upload_firmware(drvc->sr_ctx, 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.");
+                       } else {
+                               sr_err("Firmware upload failed, name %s.", FX2_FIRMWARE);
+                       }
                        sdi->inst_type = SR_INST_USB;
                        sdi->conn = sr_usb_dev_inst_new(
                                libusb_get_bus_number(devlist[i]), 0xff, NULL);
@@ -240,30 +233,23 @@ static GSList *scan(GSList *options)
        libusb_free_device_list(devlist, 1);
        g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
 
-       return devices;
-}
-
-static GSList *dev_list(void)
-{
-       return ((struct drv_context *)(di->priv))->instances;
+       return std_scan_complete(di, devices);
 }
 
 static int logic16_dev_open(struct sr_dev_inst *sdi)
 {
+       struct sr_dev_driver *di;
        libusb_device **devlist;
        struct sr_usb_dev_inst *usb;
        struct libusb_device_descriptor des;
        struct drv_context *drvc;
-       int ret, i, device_count;
+       int ret = SR_ERR, i, device_count;
        char connection_id[64];
 
-       drvc = di->priv;
+       di = sdi->driver;
+       drvc = di->context;
        usb = sdi->conn;
 
-       if (sdi->status == SR_ST_ACTIVE)
-               /* Device is already in use. */
-               return SR_ERR;
-
        device_count = libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
        if (device_count < 0) {
                sr_err("Failed to get device list: %s.",
@@ -272,11 +258,7 @@ static int logic16_dev_open(struct sr_dev_inst *sdi)
        }
 
        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;
-               }
+               libusb_get_device_descriptor(devlist[i], &des);
 
                if (des.idVendor != LOGIC16_VID || des.idProduct != LOGIC16_PID)
                        continue;
@@ -286,7 +268,9 @@ static int logic16_dev_open(struct sr_dev_inst *sdi)
                        /*
                         * Check device by its physical USB bus/port address.
                         */
-                       usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
+                       if (usb_get_port_path(devlist[i], connection_id, sizeof(connection_id)) < 0)
+                               continue;
+
                        if (strcmp(sdi->connection_id, connection_id))
                                /* This is not the one. */
                                continue;
@@ -302,6 +286,7 @@ static int logic16_dev_open(struct sr_dev_inst *sdi)
                } else {
                        sr_err("Failed to open device: %s.",
                               libusb_error_name(ret));
+                       ret = SR_ERR;
                        break;
                }
 
@@ -309,13 +294,16 @@ static int logic16_dev_open(struct sr_dev_inst *sdi)
                if (ret == LIBUSB_ERROR_BUSY) {
                        sr_err("Unable to claim USB interface. Another "
                               "program or driver has already claimed it.");
+                       ret = SR_ERR;
                        break;
                } else if (ret == LIBUSB_ERROR_NO_DEVICE) {
                        sr_err("Device has been disconnected.");
+                       ret = SR_ERR;
                        break;
                } else if (ret != 0) {
                        sr_err("Unable to claim interface: %s.",
                               libusb_error_name(ret));
+                       ret = SR_ERR;
                        break;
                }
 
@@ -324,15 +312,17 @@ static int logic16_dev_open(struct sr_dev_inst *sdi)
                        break;
                }
 
-               sdi->status = SR_ST_ACTIVE;
                sr_info("Opened device on %d.%d (logical) / %s (physical), interface %d.",
                        usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
 
+               ret = SR_OK;
+
                break;
        }
+
        libusb_free_device_list(devlist, 1);
 
-       if (sdi->status != SR_ST_ACTIVE) {
+       if (ret != SR_OK) {
                if (usb->devhdl) {
                        libusb_release_interface(usb->devhdl, USB_INTERFACE);
                        libusb_close(usb->devhdl);
@@ -399,48 +389,28 @@ static int dev_close(struct sr_dev_inst *sdi)
        struct sr_usb_dev_inst *usb;
 
        usb = sdi->conn;
-       if (usb->devhdl == NULL)
-               return SR_ERR;
+
+       if (!usb->devhdl)
+               return SR_ERR_BUG;
 
        sr_info("Closing device on %d.%d (logical) / %s (physical) interface %d.",
                usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
        libusb_release_interface(usb->devhdl, USB_INTERFACE);
        libusb_close(usb->devhdl);
        usb->devhdl = NULL;
-       sdi->status = SR_ST_INACTIVE;
 
        return SR_OK;
 }
 
-static int cleanup(void)
-{
-       int ret;
-       struct drv_context *drvc;
-
-       if (!(drvc = di->priv))
-               /* Can get called on an unused driver, doesn't matter. */
-               return SR_OK;
-
-       ret = std_dev_clear(di, NULL);
-       g_free(drvc);
-       di->priv = NULL;
-
-       return ret;
-}
-
-static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
-               const struct sr_channel_group *cg)
+static int config_get(uint32_t key, GVariant **data,
+       const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 {
        struct dev_context *devc;
        struct sr_usb_dev_inst *usb;
-       GVariant *range[2];
-       char str[128];
-       int ret;
        unsigned int i;
 
        (void)cg;
 
-       ret = SR_OK;
        switch (key) {
        case SR_CONF_CONN:
                if (!sdi || !sdi->conn)
@@ -450,8 +420,7 @@ static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *s
                        /* 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);
+               *data = g_variant_new_printf("%d.%d", usb->bus, usb->address);
                break;
        case SR_CONF_SAMPLERATE:
                if (!sdi)
@@ -459,45 +428,40 @@ static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *s
                devc = sdi->priv;
                *data = g_variant_new_uint64(devc->cur_samplerate);
                break;
+       case SR_CONF_CAPTURE_RATIO:
+               if (!sdi)
+                       return SR_ERR;
+               devc = sdi->priv;
+               *data = g_variant_new_uint64(devc->capture_ratio);
+               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)
+               for (i = 0; i < ARRAY_SIZE(thresholds); i++) {
+                       if (devc->selected_voltage_range != thresholds_ranges[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;
+                       *data = std_gvar_tuple_double(thresholds[i][0], thresholds[i][1]);
+                       return SR_OK;
                }
-               break;
+               return SR_ERR;
        default:
                return SR_ERR_NA;
        }
 
-       return ret;
+       return SR_OK;
 }
 
-static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
-               const struct sr_channel_group *cg)
+static int config_set(uint32_t key, GVariant *data,
+       const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 {
        struct dev_context *devc;
-       gdouble low, high;
-       int ret;
-       unsigned int i;
+       int idx;
 
        (void)cg;
 
-       if (sdi->status != SR_ST_ACTIVE)
-               return SR_ERR_DEV_CLOSED;
-
        devc = sdi->priv;
 
-       ret = SR_OK;
        switch (key) {
        case SR_CONF_SAMPLERATE:
                devc->cur_samplerate = g_variant_get_uint64(data);
@@ -505,74 +469,42 @@ static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sd
        case SR_CONF_LIMIT_SAMPLES:
                devc->limit_samples = g_variant_get_uint64(data);
                break;
+       case SR_CONF_CAPTURE_RATIO:
+               devc->capture_ratio = 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;
-                       }
-               }
+               if ((idx = std_double_tuple_idx(data, ARRAY_AND_SIZE(thresholds))) < 0)
+                       return SR_ERR_ARG;
+               devc->selected_voltage_range = thresholds_ranges[idx].range;
                break;
        default:
-               ret = SR_ERR_NA;
+               return SR_ERR_NA;
        }
 
-       return ret;
+       return SR_OK;
 }
 
-static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
-               const struct sr_channel_group *cg)
+static int config_list(uint32_t key, GVariant **data,
+       const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 {
-       GVariant *gvar, *range[2];
-       GVariantBuilder gvb;
-       int ret;
-       unsigned int i;
-
-       (void)sdi;
-       (void)cg;
-
-       ret = SR_OK;
        switch (key) {
        case SR_CONF_SCAN_OPTIONS:
-               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
-                               scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
-               break;
        case SR_CONF_DEVICE_OPTIONS:
-               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
-                               devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
-               break;
+               return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
        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);
+               *data = std_gvar_samplerates(ARRAY_AND_SIZE(samplerates));
                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);
+               *data = std_gvar_thresholds(ARRAY_AND_SIZE(thresholds));
                break;
        case SR_CONF_TRIGGER_MATCH:
-               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
-                               soft_trigger_matches, ARRAY_SIZE(soft_trigger_matches),
-                               sizeof(int32_t));
+               *data = std_gvar_array_i32(ARRAY_AND_SIZE(trigger_matches));
                break;
        default:
                return SR_ERR_NA;
        }
 
-       return ret;
+       return SR_OK;
 }
 
 static void abort_acquisition(struct dev_context *devc)
@@ -668,12 +600,14 @@ static int receive_data(int fd, int revents, void *cb_data)
        struct dev_context *devc;
        struct drv_context *drvc;
        const struct sr_dev_inst *sdi;
+       struct sr_dev_driver *di;
 
        (void)fd;
        (void)revents;
 
        sdi = cb_data;
-       drvc = di->priv;
+       di = sdi->driver;
+       drvc = di->context;
        devc = sdi->priv;
 
        tv.tv_sec = tv.tv_usec = 0;
@@ -687,8 +621,9 @@ static int receive_data(int fd, int revents, void *cb_data)
        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)
 {
+       struct sr_dev_driver *di = sdi->driver;
        struct dev_context *devc;
        struct drv_context *drvc;
        struct sr_usb_dev_inst *usb;
@@ -699,10 +634,7 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
        unsigned char *buf;
        size_t size, convsize;
 
-       if (sdi->status != SR_ST_ACTIVE)
-               return SR_ERR_DEV_CLOSED;
-
-       drvc = di->priv;
+       drvc = di->context;
        devc = sdi->priv;
        usb = sdi->conn;
 
@@ -712,14 +644,18 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
                return SR_ERR;
        }
 
-       devc->cb_data = cb_data;
        devc->sent_samples = 0;
        devc->empty_transfer_count = 0;
        devc->cur_channel = 0;
        memset(devc->channel_data, 0, sizeof(devc->channel_data));
 
        if ((trigger = sr_session_trigger_get(sdi->session))) {
-               devc->stl = soft_trigger_logic_new(sdi, trigger);
+               int pre_trigger_samples = 0;
+               if (devc->limit_samples > 0)
+                       pre_trigger_samples = (devc->capture_ratio * devc->limit_samples) / 100;
+               devc->stl = soft_trigger_logic_new(sdi, trigger, pre_trigger_samples);
+               if (!devc->stl)
+                       return SR_ERR_MALLOC;
                devc->trigger_fired = FALSE;
        } else
                devc->trigger_fired = TRUE;
@@ -782,8 +718,7 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
 
        usb_source_add(sdi->session, devc->ctx, timeout, receive_data, (void *)sdi);
 
-       /* Send header packet to the session bus. */
-       std_session_send_df_header(cb_data, LOG_PREFIX);
+       std_session_send_df_header(sdi);
 
        if ((ret = logic16_start_acquisition(sdi)) != SR_OK) {
                abort_acquisition(devc);
@@ -793,15 +728,10 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
        return SR_OK;
 }
 
-static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
+static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 {
        int ret;
 
-       (void)cb_data;
-
-       if (sdi->status != SR_ST_ACTIVE)
-               return SR_ERR_DEV_CLOSED;
-
        ret = logic16_abort_acquisition(sdi);
 
        abort_acquisition(sdi->priv);
@@ -809,15 +739,15 @@ static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
        return ret;
 }
 
-SR_PRIV struct sr_dev_driver saleae_logic16_driver_info = {
+static struct sr_dev_driver saleae_logic16_driver_info = {
        .name = "saleae-logic16",
        .longname = "Saleae Logic16",
        .api_version = 1,
-       .init = init,
-       .cleanup = cleanup,
+       .init = std_init,
+       .cleanup = std_cleanup,
        .scan = scan,
-       .dev_list = dev_list,
-       .dev_clear = NULL,
+       .dev_list = std_dev_list,
+       .dev_clear = std_dev_clear,
        .config_get = config_get,
        .config_set = config_set,
        .config_list = config_list,
@@ -825,5 +755,6 @@ SR_PRIV struct sr_dev_driver saleae_logic16_driver_info = {
        .dev_close = dev_close,
        .dev_acquisition_start = dev_acquisition_start,
        .dev_acquisition_stop = dev_acquisition_stop,
-       .priv = NULL,
+       .context = NULL,
 };
+SR_REGISTER_DEV_DRIVER(saleae_logic16_driver_info);