]> sigrok.org Git - libsigrok.git/blobdiff - src/hardware/pipistrello-ols/api.c
Drop unneeded std_session_send_df_header() comments.
[libsigrok.git] / src / hardware / pipistrello-ols / api.c
index 1a58d71860ea286d6944ad38d9d713ccc5455890..d015d7d572d25d1b7e0e7c9a49f72a680e30334c 100644 (file)
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+#include <config.h>
 #include "protocol.h"
 
-static const int32_t hwcaps[] = {
+static const uint32_t devopts[] = {
        SR_CONF_LOGIC_ANALYZER,
-       SR_CONF_SAMPLERATE,
-       SR_CONF_TRIGGER_TYPE,
-       SR_CONF_CAPTURE_RATIO,
-       SR_CONF_LIMIT_SAMPLES,
-       SR_CONF_PATTERN_MODE,
-       SR_CONF_EXTERNAL_CLOCK,
-       SR_CONF_SWAP,
-       SR_CONF_RLE,
+       SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
+       SR_CONF_SAMPLERATE | 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,
+       SR_CONF_PATTERN_MODE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
+       SR_CONF_EXTERNAL_CLOCK | SR_CONF_GET | SR_CONF_SET,
+       SR_CONF_SWAP | SR_CONF_SET,
+       SR_CONF_RLE | SR_CONF_GET | SR_CONF_SET,
+};
+
+static const int32_t trigger_matches[] = {
+       SR_TRIGGER_ZERO,
+       SR_TRIGGER_ONE,
+       SR_TRIGGER_RISING,
+       SR_TRIGGER_FALLING,
 };
 
 #define STR_PATTERN_NONE     "None"
@@ -54,11 +62,10 @@ static const char *patterns[] = {
 };
 
 /* Channels are numbered 0-31 (on the PCB silkscreen). */
-SR_PRIV const char *p_ols_channel_names[NUM_CHANNELS + 1] = {
+SR_PRIV const char *p_ols_channel_names[] = {
        "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12",
        "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23",
        "24", "25", "26", "27", "28", "29", "30", "31",
-       NULL,
 };
 
 /* Default supported samplerates, can be overridden by device metadata. */
@@ -69,14 +76,13 @@ static const uint64_t samplerates[] = {
 };
 
 SR_PRIV struct sr_dev_driver p_ols_driver_info;
-static struct sr_dev_driver *di = &p_ols_driver_info;
 
-static int init(struct sr_context *sr_ctx)
+static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
 {
        return std_init(sr_ctx, di, LOG_PREFIX);
 }
 
-static GSList *scan(GSList *options)
+static GSList *scan(struct sr_dev_driver *di, GSList *options)
 {
        struct sr_dev_inst *sdi;
        struct drv_context *drvc;
@@ -88,15 +94,12 @@ static GSList *scan(GSList *options)
 
        (void)options;
 
-       drvc = di->priv;
+       drvc = di->context;
 
        devices = NULL;
 
        /* Allocate memory for our private device context. */
-       if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
-               sr_err("Device context malloc failed.");
-               goto err_free_nothing;
-       }
+       devc = g_malloc0(sizeof(struct dev_context));
 
        /* Device-specific settings */
        devc->max_samplebytes = devc->max_samplerate = devc->protocol_version = 0;
@@ -108,10 +111,7 @@ static GSList *scan(GSList *options)
        devc->flag_reg = 0;
 
        /* Allocate memory for the incoming ftdi data. */
-       if (!(devc->ftdi_buf = g_try_malloc0(FTDI_BUF_SIZE))) {
-               sr_err("ftdi_buf malloc failed.");
-               goto err_free_devc;
-       }
+       devc->ftdi_buf = g_malloc0(FTDI_BUF_SIZE);
 
        /* Allocate memory for the FTDI context (ftdic) and initialize it. */
        if (!(devc->ftdic = ftdi_new())) {
@@ -178,14 +178,11 @@ static GSList *scan(GSList *options)
 
        /* Parse the metadata. */
        sdi = p_ols_get_metadata((uint8_t *)buf, bytes_read, devc);
-       sdi->index = 0;
 
        /* Configure samplerate and divider. */
        if (p_ols_set_samplerate(sdi, DEFAULT_SAMPLERATE) != SR_OK)
                sr_dbg("Failed to set default samplerate (%"PRIu64").",
                                DEFAULT_SAMPLERATE);
-       /* Clear trigger masks, values and stages. */
-       p_ols_configure_channels(sdi);
 
        drvc->instances = g_slist_append(drvc->instances, sdi);
        devices = g_slist_append(devices, sdi);
@@ -198,16 +195,14 @@ err_free_ftdic:
        ftdi_free(devc->ftdic); /* NOT free() or g_free()! */
 err_free_ftdi_buf:
        g_free(devc->ftdi_buf);
-err_free_devc:
        g_free(devc);
-err_free_nothing:
 
        return NULL;
 }
 
-static GSList *dev_list(void)
+static GSList *dev_list(const struct sr_dev_driver *di)
 {
-       return ((struct drv_context *)(di->priv))->instances;
+       return ((struct drv_context *)(di->context))->instances;
 }
 
 static void clear_helper(void *priv)
@@ -220,18 +215,17 @@ static void clear_helper(void *priv)
        g_free(devc->ftdi_buf);
 }
 
-static int dev_clear(void)
+static int dev_clear(const struct sr_dev_driver *di)
 {
        return std_dev_clear(di, clear_helper);
 }
 
-static int cleanup(void)
+static int cleanup(const struct sr_dev_driver *di)
 {
-       return dev_clear();
+       return dev_clear(di);
 }
 
-
-static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi,
+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;
@@ -242,7 +236,7 @@ static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi,
                return SR_ERR_ARG;
 
        devc = sdi->priv;
-       switch (id) {
+       switch (key) {
        case SR_CONF_SAMPLERATE:
                *data = g_variant_new_uint64(devc->cur_samplerate);
                break;
@@ -273,7 +267,7 @@ static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi,
        return SR_OK;
 }
 
-static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
+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;
@@ -289,7 +283,7 @@ static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
 
        devc = sdi->priv;
 
-       switch (id) {
+       switch (key) {
        case SR_CONF_SAMPLERATE:
                tmp_u64 = g_variant_get_uint64(data);
                if (tmp_u64 < samplerates[0] || tmp_u64 > samplerates[1])
@@ -305,10 +299,9 @@ static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
                break;
        case SR_CONF_CAPTURE_RATIO:
                devc->capture_ratio = g_variant_get_uint64(data);
-               if (devc->capture_ratio < 0 || devc->capture_ratio > 100) {
-                       devc->capture_ratio = 0;
+               if (devc->capture_ratio < 0 || devc->capture_ratio > 100)
                        ret = SR_ERR;
-               else
+               else
                        ret = SR_OK;
                break;
        case SR_CONF_EXTERNAL_CLOCK:
@@ -370,20 +363,20 @@ static int config_set(int id, 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(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
                const struct sr_channel_group *cg)
 {
        struct dev_context *devc;
        GVariant *gvar, *grange[2];
        GVariantBuilder gvb;
-       int num_channels, i;
+       int num_pols_changrp, i;
 
        (void)cg;
 
        switch (key) {
        case SR_CONF_DEVICE_OPTIONS:
-               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
-                               hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
+               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
+                               devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
                break;
        case SR_CONF_SAMPLERATE:
                g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
@@ -392,8 +385,10 @@ static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
                g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
                *data = g_variant_builder_end(&gvb);
                break;
-       case SR_CONF_TRIGGER_TYPE:
-               *data = g_variant_new_string(TRIGGER_TYPE);
+       case SR_CONF_TRIGGER_MATCH:
+               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
+                               trigger_matches, ARRAY_SIZE(trigger_matches),
+                               sizeof(int32_t));
                break;
        case SR_CONF_PATTERN_MODE:
                *data = g_variant_new_strv(patterns, ARRAY_SIZE(patterns));
@@ -411,23 +406,20 @@ static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
                 * Channel groups are turned off if no channels in that group are
                 * enabled, making more room for samples for the enabled group.
                */
-               p_ols_configure_channels(sdi);
-               num_channels = 0;
+               pols_channel_mask(sdi);
+               num_pols_changrp = 0;
                for (i = 0; i < 4; i++) {
                        if (devc->channel_mask & (0xff << (i * 8)))
-                               num_channels++;
-               }
-               if (num_channels == 0) {
-                       /* This can happen, but shouldn't cause too much drama.
-                        * However we can't continue because the code below would
-                        * divide by zero. */
-                       break;
+                               num_pols_changrp++;
                }
                /* 3 channel groups takes as many bytes as 4 channel groups */
-               if (num_channels == 3)
-                       num_channels = 4;
+               if (num_pols_changrp == 3)
+                       num_pols_changrp = 4;
                grange[0] = g_variant_new_uint64(MIN_NUM_SAMPLES);
-               grange[1] = g_variant_new_uint64(devc->max_samplebytes / num_channels);
+               if (num_pols_changrp)
+                       grange[1] = g_variant_new_uint64(devc->max_samplebytes / num_pols_changrp);
+               else
+                       grange[1] = g_variant_new_uint64(MIN_NUM_SAMPLES);
                *data = g_variant_new_tuple(grange, 2);
                break;
        default:
@@ -446,7 +438,7 @@ static int dev_open(struct sr_dev_inst *sdi)
        if (p_ols_open(devc) != SR_OK) {
                return SR_ERR;
        } else {
-         sdi->status = SR_ST_ACTIVE;
+               sdi->status = SR_ST_ACTIVE;
                return SR_OK;
        }
 }
@@ -471,7 +463,6 @@ static int dev_close(struct sr_dev_inst *sdi)
        return ret;
 }
 
-
 static int set_trigger(const struct sr_dev_inst *sdi, int stage)
 {
        struct dev_context *devc;
@@ -515,14 +506,43 @@ static int set_trigger(const struct sr_dev_inst *sdi, int stage)
        return SR_OK;
 }
 
+static int disable_trigger(const struct sr_dev_inst *sdi, int stage)
+{
+       struct dev_context *devc;
+       uint8_t cmd, arg[4];
+
+       devc = sdi->priv;
+
+       cmd = CMD_SET_TRIGGER_MASK + stage * 4;
+       arg[0] = arg[1] = arg[2] = arg[3] = 0x00;
+       if (write_longcommand(devc, cmd, arg) != SR_OK)
+               return SR_ERR;
+
+       cmd = CMD_SET_TRIGGER_VALUE + stage * 4;
+       if (write_longcommand(devc, cmd, arg) != SR_OK)
+               return SR_ERR;
+
+       cmd = CMD_SET_TRIGGER_CONFIG + stage * 4;
+       arg[2] = 0x03;
+       if (write_longcommand(devc, cmd, arg) != SR_OK)
+               return SR_ERR;
+
+       cmd = CMD_SET_TRIGGER_EDGE + stage * 4;
+       arg[2] = 0x00;
+       if (write_longcommand(devc, cmd, arg) != SR_OK)
+               return SR_ERR;
+
+       return SR_OK;
+}
+
 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
                void *cb_data)
 {
        struct dev_context *devc;
        uint32_t samplecount, readcount, delaycount;
-       uint8_t changrp_mask, arg[4];
+       uint8_t pols_changrp_mask, arg[4];
        uint16_t flag_tmp;
-       int num_channels, samplespercount;
+       int num_pols_changrp, samplespercount;
        int ret, i;
 
        if (sdi->status != SR_ST_ACTIVE)
@@ -530,36 +550,33 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi,
 
        devc = sdi->priv;
 
-       if (p_ols_configure_channels(sdi) != SR_OK) {
-               sr_err("Failed to configure channels.");
-               return SR_ERR;
-       }
+       pols_channel_mask(sdi);
 
        /*
         * Enable/disable channel groups in the flag register according to the
-        * channel mask. Calculate this here, because num_channels is needed
-        * to limit readcount.
+        * channel mask. Calculate this here, because num_pols_changrp is
+        * needed to limit readcount.
         */
-       changrp_mask = 0;
-       num_channels = 0;
+       pols_changrp_mask = 0;
+       num_pols_changrp = 0;
        for (i = 0; i < 4; i++) {
                if (devc->channel_mask & (0xff << (i * 8))) {
-                       changrp_mask |= (1 << i);
-                       num_channels++;
+                       pols_changrp_mask |= (1 << i);
+                       num_pols_changrp++;
                }
        }
        /* 3 channel groups takes as many bytes as 4 channel groups */
-       if (num_channels == 3)
-               num_channels = 4;
+       if (num_pols_changrp == 3)
+               num_pols_changrp = 4;
        /* maximum number of samples (or RLE counts) the buffer memory can hold */
-       devc->max_samples = devc->max_samplebytes / num_channels;
+       devc->max_samples = devc->max_samplebytes / num_pols_changrp;
 
        /*
         * Limit readcount to prevent reading past the end of the hardware
         * buffer.
         */
        sr_dbg("max_samples = %d", devc->max_samples);
-       sr_dbg("limit_samples = %d", devc->limit_samples);
+       sr_dbg("limit_samples = %" PRIu64, devc->limit_samples);
        samplecount = MIN(devc->max_samples, devc->limit_samples);
        sr_dbg("Samplecount = %d", samplecount);
 
@@ -578,14 +595,25 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi,
                readcount++;
 
        /* Basic triggers. */
-       if (devc->trigger_mask[0] != 0x00000000) {
-               /* At least one channel has a trigger on it. */
+       if (pols_convert_trigger(sdi) != SR_OK) {
+               sr_err("Failed to configure channels.");
+               return SR_ERR;
+       }
+
+       if (devc->num_stages > 0) {
                delaycount = readcount * (1 - devc->capture_ratio / 100.0);
                devc->trigger_at = (readcount - delaycount) * samplespercount - devc->num_stages;
-               for (i = 0; i <= devc->num_stages; i++) {
-                       sr_dbg("Setting stage %d trigger.", i);
-                       if ((ret = set_trigger(sdi, i)) != SR_OK)
-                               return ret;
+               for (i = 0; i < NUM_TRIGGER_STAGES; i++) {
+                       if (i <= devc->num_stages) {
+                               sr_dbg("Setting p-ols stage %d trigger.", i);
+                               if ((ret = set_trigger(sdi, i)) != SR_OK)
+                                       return ret;
+                       }
+                       else {
+                               sr_dbg("Disabling p-ols stage %d trigger.", i);
+                               if ((ret = disable_trigger(sdi, i)) != SR_OK)
+                                       return ret;
+                       }
                }
        } else {
                /* No triggers configured, force trigger on first stage. */
@@ -604,6 +632,7 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi,
        arg[3] = 0x00;
        if (write_longcommand(devc, CMD_SET_DIVIDER, arg) != SR_OK)
                return SR_ERR;
+
        /* Send extended sample limit and pre/post-trigger capture ratio. */
        arg[0] = ((readcount - 1) & 0xff);
        arg[1] = ((readcount - 1) & 0xff00) >> 8;
@@ -617,6 +646,7 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi,
        arg[3] = ((delaycount - 1) & 0xff000000) >> 24;
        if (write_longcommand(devc, CMD_CAPTURE_COUNT, arg) != SR_OK)
                return SR_ERR;
+
        /* Flag register. */
        sr_dbg("Setting intpat %s, extpat %s, RLE %s, noise_filter %s, demux %s",
                        devc->flag_reg & FLAG_INTERNAL_TEST_MODE ? "on": "off",
@@ -630,7 +660,7 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi,
        * to the channel mask. 1 means "disable channel".
        */
        devc->flag_reg &= ~0x3c;
-       devc->flag_reg |= ~(changrp_mask << 2) & 0x3c;
+       devc->flag_reg |= ~(pols_changrp_mask << 2) & 0x3c;
        sr_dbg("flag_reg = %x", devc->flag_reg);
 
        /*
@@ -641,7 +671,7 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi,
        flag_tmp = devc->flag_reg;
        if (devc->flag_reg & FLAG_DEMUX) {
                flag_tmp &= ~0x30;
-               flag_tmp |= ~(changrp_mask << 4) & 0x30;
+               flag_tmp |= ~(pols_changrp_mask << 4) & 0x30;
        }
        arg[0] = flag_tmp & 0xff;
        arg[1] = flag_tmp >> 8;
@@ -659,21 +689,18 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi,
        devc->cnt_bytes = devc->cnt_samples = devc->cnt_samples_rle = 0;
        memset(devc->sample, 0, 4);
 
-       /* Send header packet to the session bus. */
        std_session_send_df_header(cb_data, LOG_PREFIX);
 
        /* Hook up a dummy handler to receive data from the device. */
-       sr_source_add(-1, G_IO_IN, 0, p_ols_receive_data, (void *)sdi);
+       sr_session_source_add(sdi->session, -1, 0, 10, p_ols_receive_data,
+                       cb_data);
 
        return SR_OK;
 }
 
-
-
 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 {
        struct dev_context *devc;
-       struct sr_datafeed_packet packet;
 
        devc = sdi->priv;
 
@@ -684,18 +711,15 @@ static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
        write_shortcommand(devc, CMD_RESET);
        write_shortcommand(devc, CMD_RESET);
 
-       sr_source_remove(-1);
+       sr_session_source_remove(sdi->session, -1);
 
-       /* Send end packet to the session bus. */
-       sr_dbg("Sending SR_DF_END.");
-       packet.type = SR_DF_END;
-       sr_session_send(cb_data, &packet);
+       std_session_send_df_end(cb_data, LOG_PREFIX);
 
        return SR_OK;
 }
 
 SR_PRIV struct sr_dev_driver p_ols_driver_info = {
-       .name = "p_ols",
+       .name = "p-ols",
        .longname = "Pipistrello OLS",
        .api_version = 1,
        .init = init,
@@ -710,5 +734,5 @@ SR_PRIV struct sr_dev_driver p_ols_driver_info = {
        .dev_close = dev_close,
        .dev_acquisition_start = dev_acquisition_start,
        .dev_acquisition_stop = dev_acquisition_stop,
-       .priv = NULL,
+       .context = NULL,
 };