]> sigrok.org Git - libsigrok.git/blobdiff - hardware/openbench-logic-sniffer/api.c
ols: Fix stack clobbering at start of acquisition
[libsigrok.git] / hardware / openbench-logic-sniffer / api.c
index 634a2a570344f84f307f5a8c467a1522b9fc86fa..a744fc5a86e7d9e3dd4f0b2a21d77b1487a76f05 100644 (file)
@@ -1,7 +1,7 @@
 /*
  * This file is part of the sigrok project.
  *
- * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
+ * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
  *
  * 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
 
 #define SERIALCOMM "115200/8n1"
 
-static const int hwopts[] = {
+static const int32_t hwopts[] = {
        SR_CONF_CONN,
        SR_CONF_SERIALCOMM,
-       0,
 };
 
-static const int hwcaps[] = {
+static const int32_t hwcaps[] = {
        SR_CONF_LOGIC_ANALYZER,
        SR_CONF_SAMPLERATE,
+       SR_CONF_TRIGGER_TYPE,
        SR_CONF_CAPTURE_RATIO,
        SR_CONF_LIMIT_SAMPLES,
        SR_CONF_RLE,
-       0,
 };
 
 /* Probes are numbered 0-31 (on the PCB silkscreen). */
@@ -44,12 +43,11 @@ SR_PRIV const char *ols_probe_names[NUM_PROBES + 1] = {
        NULL,
 };
 
-/* default supported samplerates, can be overridden by device metadata */
-static const struct sr_samplerates samplerates = {
+/* Default supported samplerates, can be overridden by device metadata. */
+static const uint64_t samplerates[] = {
        SR_HZ(10),
        SR_MHZ(200),
        SR_HZ(1),
-       NULL,
 };
 
 SR_PRIV struct sr_dev_driver ols_driver_info;
@@ -57,16 +55,7 @@ static struct sr_dev_driver *di = &ols_driver_info;
 
 static int hw_init(struct sr_context *sr_ctx)
 {
-       struct drv_context *drvc;
-
-       if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
-               sr_err("Driver context malloc failed.");
-               return SR_ERR_MALLOC;
-       }
-       drvc->sr_ctx = sr_ctx;
-       di->priv = drvc;
-
-       return SR_OK;
+       return std_hw_init(sr_ctx, di, DRIVER_LOG_DOMAIN);
 }
 
 static GSList *hw_scan(GSList *options)
@@ -84,7 +73,9 @@ static GSList *hw_scan(GSList *options)
        char buf[8];
 
        (void)options;
+
        drvc = di->priv;
+
        devices = NULL;
 
        conn = serialcomm = NULL;
@@ -92,10 +83,10 @@ static GSList *hw_scan(GSList *options)
                src = l->data;
                switch (src->key) {
                case SR_CONF_CONN:
-                       conn = src->value;
+                       conn = g_variant_get_string(src->data, NULL);
                        break;
                case SR_CONF_SERIALCOMM:
-                       serialcomm = src->value;
+                       serialcomm = g_variant_get_string(src->data, NULL);
                        break;
                }
        }
@@ -157,19 +148,27 @@ static GSList *hw_scan(GSList *options)
                devc = sdi->priv;
        } else {
                /* Not an OLS -- some other board that uses the sump protocol. */
+               sr_info("Device does not support metadata.");
                sdi = sr_dev_inst_new(0, SR_ST_INACTIVE,
                                "Sump", "Logic Analyzer", "v1.0");
                sdi->driver = di;
-               devc = ols_dev_new();
                for (i = 0; i < 32; i++) {
                        if (!(probe = sr_probe_new(i, SR_PROBE_LOGIC, TRUE,
                                        ols_probe_names[i])))
                                return 0;
                        sdi->probes = g_slist_append(sdi->probes, probe);
                }
+               devc = ols_dev_new();
                sdi->priv = devc;
        }
+       /* Configure samplerate and divider. */
+       if (ols_set_samplerate(sdi, DEFAULT_SAMPLERATE) != SR_OK)
+               sr_dbg("Failed to set default samplerate (%"PRIu64").",
+                               DEFAULT_SAMPLERATE);
+       /* Clear trigger masks, values and stages. */
+       ols_configure_probes(sdi);
        devc->serial = serial;
+
        drvc->instances = g_slist_append(drvc->instances, sdi);
        devices = g_slist_append(devices, sdi);
 
@@ -180,11 +179,7 @@ static GSList *hw_scan(GSList *options)
 
 static GSList *hw_dev_list(void)
 {
-       struct drv_context *drvc;
-
-       drvc = di->priv;
-
-       return drvc->instances;
+       return ((struct drv_context *)(di->priv))->instances;
 }
 
 static int hw_dev_open(struct sr_dev_inst *sdi)
@@ -250,56 +245,58 @@ static int hw_cleanup(void)
        return ret;
 }
 
-static int config_get(int id, const void **data, const struct sr_dev_inst *sdi)
+static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi)
 {
        struct dev_context *devc;
 
+       if (!sdi)
+               return SR_ERR_ARG;
+
+       devc = sdi->priv;
        switch (id) {
-       case SR_DI_HWOPTS:
-               *data = hwopts;
-               break;
        case SR_CONF_SAMPLERATE:
-               if (sdi) {
-                       devc = sdi->priv;
-                       *data = &devc->cur_samplerate;
-               } else
-                       return SR_ERR;
+               *data = g_variant_new_uint64(devc->cur_samplerate);
+               break;
+       case SR_CONF_CAPTURE_RATIO:
+               *data = g_variant_new_uint64(devc->capture_ratio);
+               break;
+       case SR_CONF_LIMIT_SAMPLES:
+               *data = g_variant_new_uint64(devc->limit_samples);
+               break;
+       case SR_CONF_RLE:
+               *data = g_variant_new_boolean(devc->flag_reg & FLAG_RLE ? TRUE : FALSE);
                break;
        default:
-               return SR_ERR_ARG;
+               return SR_ERR_NA;
        }
 
        return SR_OK;
 }
 
-static int config_set(int id, const void *value, const struct sr_dev_inst *sdi)
+static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi)
 {
        struct dev_context *devc;
        int ret;
-       const uint64_t *tmp_u64;
+       uint64_t tmp_u64;
 
        devc = sdi->priv;
 
-       if (sdi->status != SR_ST_ACTIVE)
-               return SR_ERR;
-
        switch (id) {
        case SR_CONF_SAMPLERATE:
-               ret = ols_set_samplerate(sdi, *(const uint64_t *)value,
-                                        &samplerates);
+               tmp_u64 = g_variant_get_uint64(data);
+               if (tmp_u64 < samplerates[0] || tmp_u64 > samplerates[1])
+                       return SR_ERR_SAMPLERATE;
+               ret = ols_set_samplerate(sdi, g_variant_get_uint64(data));
                break;
        case SR_CONF_LIMIT_SAMPLES:
-               tmp_u64 = value;
-               if (*tmp_u64 < MIN_NUM_SAMPLES)
+               tmp_u64 = g_variant_get_uint64(data);
+               if (tmp_u64 < MIN_NUM_SAMPLES)
                        return SR_ERR;
-               if (*tmp_u64 > devc->max_samples)
-                       sr_err("Sample limit exceeds hardware maximum.");
-               devc->limit_samples = *tmp_u64;
-               sr_info("Sample limit is %" PRIu64 ".", devc->limit_samples);
+               devc->limit_samples = tmp_u64;
                ret = SR_OK;
                break;
        case SR_CONF_CAPTURE_RATIO:
-               devc->capture_ratio = *(const uint64_t *)value;
+               devc->capture_ratio = g_variant_get_uint64(data);
                if (devc->capture_ratio < 0 || devc->capture_ratio > 100) {
                        devc->capture_ratio = 0;
                        ret = SR_ERR;
@@ -307,36 +304,50 @@ static int config_set(int id, const void *value, const struct sr_dev_inst *sdi)
                        ret = SR_OK;
                break;
        case SR_CONF_RLE:
-               if (GPOINTER_TO_INT(value)) {
+               if (g_variant_get_boolean(data)) {
                        sr_info("Enabling RLE.");
                        devc->flag_reg |= FLAG_RLE;
+               } else {
+                       sr_info("Disabling RLE.");
+                       devc->flag_reg &= ~FLAG_RLE;
                }
                ret = SR_OK;
                break;
        default:
-               ret = SR_ERR;
+               ret = SR_ERR_NA;
        }
 
        return ret;
 }
 
-static int config_list(int key, const void **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;
 
        (void)sdi;
 
        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 = hwcaps;
+               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
+                               hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
                break;
        case SR_CONF_SAMPLERATE:
-               *data = &samplerates;
+               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}", "samplerate-steps", gvar);
+               *data = g_variant_builder_end(&gvb);
                break;
        case SR_CONF_TRIGGER_TYPE:
-               *data = (char *)TRIGGER_TYPE;
+               *data = g_variant_new_string(TRIGGER_TYPE);
                break;
        default:
-               return SR_ERR_ARG;
+               return SR_ERR_NA;
        }
 
        return SR_OK;
@@ -345,8 +356,6 @@ static int config_list(int key, const void **data, const struct sr_dev_inst *sdi
 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
                void *cb_data)
 {
-       struct sr_datafeed_packet *packet;
-       struct sr_datafeed_header *header;
        struct dev_context *devc;
        uint32_t trigger_config[4];
        uint32_t data;
@@ -386,7 +395,7 @@ static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
        readcount = MIN(devc->max_samples / num_channels, devc->limit_samples) / 4;
 
        memset(trigger_config, 0, 16);
-       trigger_config[devc->num_stages - 1] |= 0x08;
+       trigger_config[devc->num_stages] |= 0x08;
        if (devc->trigger_mask[0]) {
                delaycount = readcount * (1 - devc->capture_ratio / 100.0);
                devc->trigger_at = (readcount - delaycount) * 4 - devc->num_stages;
@@ -468,34 +477,18 @@ static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
        if (send_shortcommand(devc->serial, CMD_RUN) != SR_OK)
                return SR_ERR;
 
-       sr_source_add(devc->serial->fd, G_IO_IN, -1, ols_receive_data,
-                     cb_data);
-
-       if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
-               sr_err("Datafeed packet malloc failed.");
-               return SR_ERR_MALLOC;
-       }
-
-       if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) {
-               sr_err("Datafeed header malloc failed.");
-               g_free(packet);
-               return SR_ERR_MALLOC;
-       }
+       /* Reset all operational states. */
+       devc->num_transfers = devc->num_samples = devc->num_bytes = 0;
 
        /* Send header packet to the session bus. */
-       packet->type = SR_DF_HEADER;
-       packet->payload = (unsigned char *)header;
-       header->feed_version = 1;
-       gettimeofday(&header->starttime, NULL);
-       sr_session_send(cb_data, packet);
+       std_session_send_df_header(cb_data, DRIVER_LOG_DOMAIN);
 
-       g_free(header);
-       g_free(packet);
+       sr_source_add(devc->serial->fd, G_IO_IN, -1, ols_receive_data,
+                     cb_data);
 
        return SR_OK;
 }
 
-/* TODO: This stops acquisition on ALL devices, ignoring dev_index. */
 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 {
        /* Avoid compiler warnings. */