]> sigrok.org Git - libsigrok.git/blobdiff - src/hardware/openbench-logic-sniffer/api.c
ols: Detect Demon Core, use its canonic command names
[libsigrok.git] / src / hardware / openbench-logic-sniffer / api.c
index db454a9f1a9577f6d627e3dca40c800d68d35238..8e4efb9407a88ba725d936dc95c8ac5018504eab 100644 (file)
@@ -83,7 +83,7 @@ static const uint64_t samplerates[] = {
        SR_HZ(1),
 };
 
-#define RESPONSE_DELAY_US (10 * 1000)
+#define RESPONSE_DELAY_US (20 * 1000)
 
 static GSList *scan(struct sr_dev_driver *di, GSList *options)
 {
@@ -91,10 +91,10 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
        struct sr_dev_inst *sdi;
        struct sr_serial_dev_inst *serial;
        GSList *l;
-       int ret;
+       int num_read;
        unsigned int i;
        const char *conn, *serialcomm;
-       char buf[8];
+       char buf[4] = { 0, 0, 0, 0 };
 
        conn = serialcomm = NULL;
        for (l = options; l; l = l->next) {
@@ -135,20 +135,23 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
 
        g_usleep(RESPONSE_DELAY_US);
 
-       if (sp_input_waiting(serial->data) == 0) {
-               sr_dbg("Didn't get any reply.");
+       if (serial_has_receive_data(serial) == 0) {
+               sr_dbg("Didn't get any ID reply.");
                return NULL;
        }
 
-       ret = serial_read_blocking(serial, buf, 4, serial_timeout(serial, 4));
-       if (ret != 4) {
-               sr_err("Invalid reply (expected 4 bytes, got %d).", ret);
+       num_read = serial_read_blocking(serial, buf, 4, serial_timeout(serial, 4));
+       if (num_read < 0) {
+               sr_err("Getting ID reply failed (%d).", num_read);
                return NULL;
        }
 
        if (strncmp(buf, "1SLO", 4) && strncmp(buf, "1ALS", 4)) {
-               sr_err("Invalid reply (expected '1SLO' or '1ALS', got "
-                      "'%c%c%c%c').", buf[0], buf[1], buf[2], buf[3]);
+               GString *id = sr_hexdump_new((uint8_t *)buf, num_read);
+
+               sr_err("Invalid ID reply (got %s).", id->str);
+
+               sr_hexdump_free(id);
                return NULL;
        }
 
@@ -159,7 +162,7 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
 
        g_usleep(RESPONSE_DELAY_US);
 
-       if (sp_input_waiting(serial->data) != 0) {
+       if (serial_has_receive_data(serial) != 0) {
                /* Got metadata. */
                sdi = get_metadata(serial);
        } else {
@@ -198,6 +201,7 @@ static int config_get(uint32_t key, GVariant **data,
                return SR_ERR_ARG;
 
        devc = sdi->priv;
+
        switch (key) {
        case SR_CONF_SAMPLERATE:
                *data = g_variant_new_uint64(devc->cur_samplerate);
@@ -209,15 +213,15 @@ static int config_get(uint32_t key, GVariant **data,
                *data = g_variant_new_uint64(devc->limit_samples);
                break;
        case SR_CONF_PATTERN_MODE:
-               if (devc->flag_reg & FLAG_EXTERNAL_TEST_MODE)
+               if (devc->capture_flags & CAPTURE_FLAG_EXTERNAL_TEST_MODE)
                        *data = g_variant_new_string(STR_PATTERN_EXTERNAL);
-               else if (devc->flag_reg & FLAG_INTERNAL_TEST_MODE)
+               else if (devc->capture_flags & CAPTURE_FLAG_INTERNAL_TEST_MODE)
                        *data = g_variant_new_string(STR_PATTERN_INTERNAL);
                else
                        *data = g_variant_new_string(STR_PATTERN_NONE);
                break;
        case SR_CONF_RLE:
-               *data = g_variant_new_boolean(devc->flag_reg & FLAG_RLE ? TRUE : FALSE);
+               *data = g_variant_new_boolean(devc->capture_flags & CAPTURE_FLAG_RLE ? TRUE : FALSE);
                break;
        default:
                return SR_ERR_NA;
@@ -232,7 +236,6 @@ static int config_set(uint32_t key, GVariant *data,
        struct dev_context *devc;
        uint16_t flag;
        uint64_t tmp_u64;
-       int ret;
        const char *stropt;
 
        (void)cg;
@@ -244,79 +247,66 @@ static int config_set(uint32_t key, GVariant *data,
                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;
+               return ols_set_samplerate(sdi, g_variant_get_uint64(data));
        case SR_CONF_LIMIT_SAMPLES:
                tmp_u64 = g_variant_get_uint64(data);
                if (tmp_u64 < MIN_NUM_SAMPLES)
                        return SR_ERR;
                devc->limit_samples = tmp_u64;
-               ret = SR_OK;
                break;
        case SR_CONF_CAPTURE_RATIO:
                devc->capture_ratio = g_variant_get_uint64(data);
-               if (devc->capture_ratio < 0 || devc->capture_ratio > 100)
-                       ret = SR_ERR;
-               else
-                       ret = SR_OK;
                break;
        case SR_CONF_EXTERNAL_CLOCK:
                if (g_variant_get_boolean(data)) {
                        sr_info("Enabling external clock.");
-                       devc->flag_reg |= FLAG_CLOCK_EXTERNAL;
+                       devc->capture_flags |= CAPTURE_FLAG_CLOCK_EXTERNAL;
                } else {
                        sr_info("Disabled external clock.");
-                       devc->flag_reg &= ~FLAG_CLOCK_EXTERNAL;
+                       devc->capture_flags &= ~CAPTURE_FLAG_CLOCK_EXTERNAL;
                }
-               ret = SR_OK;
                break;
        case SR_CONF_PATTERN_MODE:
                stropt = g_variant_get_string(data, NULL);
-               ret = SR_OK;
-               flag = 0xffff;
                if (!strcmp(stropt, STR_PATTERN_NONE)) {
                        sr_info("Disabling test modes.");
                        flag = 0x0000;
-               }else if (!strcmp(stropt, STR_PATTERN_INTERNAL)) {
+               } else if (!strcmp(stropt, STR_PATTERN_INTERNAL)) {
                        sr_info("Enabling internal test mode.");
-                       flag = FLAG_INTERNAL_TEST_MODE;
+                       flag = CAPTURE_FLAG_INTERNAL_TEST_MODE;
                } else if (!strcmp(stropt, STR_PATTERN_EXTERNAL)) {
                        sr_info("Enabling external test mode.");
-                       flag = FLAG_EXTERNAL_TEST_MODE;
+                       flag = CAPTURE_FLAG_EXTERNAL_TEST_MODE;
                } else {
-                       ret = SR_ERR;
-               }
-               if (flag != 0xffff) {
-                       devc->flag_reg &= ~(FLAG_INTERNAL_TEST_MODE | FLAG_EXTERNAL_TEST_MODE);
-                       devc->flag_reg |= flag;
+                       return SR_ERR;
                }
+               devc->capture_flags &= ~CAPTURE_FLAG_INTERNAL_TEST_MODE;
+               devc->capture_flags &= ~CAPTURE_FLAG_EXTERNAL_TEST_MODE;
+               devc->capture_flags |= flag;
                break;
        case SR_CONF_SWAP:
                if (g_variant_get_boolean(data)) {
                        sr_info("Enabling channel swapping.");
-                       devc->flag_reg |= FLAG_SWAP_CHANNELS;
+                       devc->capture_flags |= CAPTURE_FLAG_SWAP_CHANNELS;
                } else {
                        sr_info("Disabling channel swapping.");
-                       devc->flag_reg &= ~FLAG_SWAP_CHANNELS;
+                       devc->capture_flags &= ~CAPTURE_FLAG_SWAP_CHANNELS;
                }
-               ret = SR_OK;
                break;
-
        case SR_CONF_RLE:
                if (g_variant_get_boolean(data)) {
                        sr_info("Enabling RLE.");
-                       devc->flag_reg |= FLAG_RLE;
+                       devc->capture_flags |= CAPTURE_FLAG_RLE;
                } else {
                        sr_info("Disabling RLE.");
-                       devc->flag_reg &= ~FLAG_RLE;
+                       devc->capture_flags &= ~CAPTURE_FLAG_RLE;
                }
-               ret = SR_OK;
                break;
        default:
-               ret = SR_ERR_NA;
+               return SR_ERR_NA;
        }
 
-       return ret;
+       return SR_OK;
 }
 
 static int config_list(uint32_t key, GVariant **data,
@@ -342,7 +332,7 @@ static int config_list(uint32_t key, GVariant **data,
                if (!sdi)
                        return SR_ERR_ARG;
                devc = sdi->priv;
-               if (devc->flag_reg & FLAG_RLE)
+               if (devc->capture_flags & CAPTURE_FLAG_RLE)
                        return SR_ERR_NA;
                if (devc->max_samples == 0)
                        /* Device didn't specify sample memory size in metadata. */
@@ -368,7 +358,7 @@ static int config_list(uint32_t key, GVariant **data,
        return SR_OK;
 }
 
-static int set_trigger(const struct sr_dev_inst *sdi, int stage)
+static int set_basic_trigger(const struct sr_dev_inst *sdi, int stage)
 {
        struct dev_context *devc;
        struct sr_serial_dev_inst *serial;
@@ -377,7 +367,7 @@ static int set_trigger(const struct sr_dev_inst *sdi, int stage)
        devc = sdi->priv;
        serial = sdi->conn;
 
-       cmd = CMD_SET_TRIGGER_MASK + stage * 4;
+       cmd = CMD_SET_BASIC_TRIGGER_MASK0 + stage * 4;
        arg[0] = devc->trigger_mask[stage] & 0xff;
        arg[1] = (devc->trigger_mask[stage] >> 8) & 0xff;
        arg[2] = (devc->trigger_mask[stage] >> 16) & 0xff;
@@ -385,7 +375,7 @@ static int set_trigger(const struct sr_dev_inst *sdi, int stage)
        if (send_longcommand(serial, cmd, arg) != SR_OK)
                return SR_ERR;
 
-       cmd = CMD_SET_TRIGGER_VALUE + stage * 4;
+       cmd = CMD_SET_BASIC_TRIGGER_VALUE0 + stage * 4;
        arg[0] = devc->trigger_value[stage] & 0xff;
        arg[1] = (devc->trigger_value[stage] >> 8) & 0xff;
        arg[2] = (devc->trigger_value[stage] >> 16) & 0xff;
@@ -393,7 +383,7 @@ static int set_trigger(const struct sr_dev_inst *sdi, int stage)
        if (send_longcommand(serial, cmd, arg) != SR_OK)
                return SR_ERR;
 
-       cmd = CMD_SET_TRIGGER_CONFIG + stage * 4;
+       cmd = CMD_SET_BASIC_TRIGGER_CONFIG0 + stage * 4;
        arg[0] = arg[1] = arg[3] = 0x00;
        arg[2] = stage;
        if (stage == devc->num_stages)
@@ -409,7 +399,7 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 {
        struct dev_context *devc;
        struct sr_serial_dev_inst *serial;
-       uint16_t samplecount, readcount, delaycount;
+       uint32_t samplecount, readcount, delaycount;
        uint8_t ols_changrp_mask, arg[4];
        int num_ols_changrp;
        int ret, i;
@@ -430,14 +420,10 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 
        /*
         * Limit readcount to prevent reading past the end of the hardware
-        * buffer.
+        * buffer. Rather read too many samples than too few.
         */
        samplecount = MIN(devc->max_samples / num_ols_changrp, devc->limit_samples);
-       readcount = samplecount / 4;
-
-       /* Rather read too many samples than too few. */
-       if (samplecount % 4 != 0)
-               readcount++;
+       readcount = (samplecount + 3) / 4;
 
        /* Basic triggers. */
        if (ols_convert_trigger(sdi) != SR_OK) {
@@ -454,16 +440,16 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi)
                        return SR_ERR;
 
                delaycount = readcount * (1 - devc->capture_ratio / 100.0);
-               devc->trigger_at = (readcount - delaycount) * 4 - devc->num_stages;
+               devc->trigger_at_smpl = (readcount - delaycount) * 4 - devc->num_stages;
                for (i = 0; i <= devc->num_stages; i++) {
                        sr_dbg("Setting OLS stage %d trigger.", i);
-                       if ((ret = set_trigger(sdi, i)) != SR_OK)
+                       if ((ret = set_basic_trigger(sdi, i)) != SR_OK)
                                return ret;
                }
        } else {
                /* No triggers configured, force trigger on first stage. */
                sr_dbg("Forcing trigger at stage 0.");
-               if ((ret = set_trigger(sdi, 0)) != SR_OK)
+               if ((ret = set_basic_trigger(sdi, 0)) != SR_OK)
                        return ret;
                delaycount = readcount;
        }
@@ -481,33 +467,52 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi)
        /* Send sample limit and pre/post-trigger capture ratio. */
        sr_dbg("Setting sample limit %d, trigger point at %d",
                        (readcount - 1) * 4, (delaycount - 1) * 4);
-       arg[0] = ((readcount - 1) & 0xff);
-       arg[1] = ((readcount - 1) & 0xff00) >> 8;
-       arg[2] = ((delaycount - 1) & 0xff);
-       arg[3] = ((delaycount - 1) & 0xff00) >> 8;
-       if (send_longcommand(serial, CMD_CAPTURE_SIZE, arg) != SR_OK)
-               return SR_ERR;
+
+       if (devc->max_samples > 256 * 1024) {
+               arg[0] = ((readcount - 1) & 0xff);
+               arg[1] = ((readcount - 1) & 0xff00) >> 8;
+               arg[2] = ((readcount - 1) & 0xff0000) >> 16;
+               arg[3] = ((readcount - 1) & 0xff000000) >> 24;
+               if (send_longcommand(serial, CMD_CAPTURE_READCOUNT, arg) != SR_OK)
+                       return SR_ERR;
+               arg[0] = ((delaycount - 1) & 0xff);
+               arg[1] = ((delaycount - 1) & 0xff00) >> 8;
+               arg[2] = ((delaycount - 1) & 0xff0000) >> 16;
+               arg[3] = ((delaycount - 1) & 0xff000000) >> 24;
+               if (send_longcommand(serial, CMD_CAPTURE_DELAYCOUNT, arg) != SR_OK)
+                       return SR_ERR;
+       } else {
+               arg[0] = ((readcount - 1) & 0xff);
+               arg[1] = ((readcount - 1) & 0xff00) >> 8;
+               arg[2] = ((delaycount - 1) & 0xff);
+               arg[3] = ((delaycount - 1) & 0xff00) >> 8;
+               if (send_longcommand(serial, CMD_CAPTURE_SIZE, 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",
-                       devc->flag_reg & FLAG_EXTERNAL_TEST_MODE ? "on": "off",
-                       devc->flag_reg & FLAG_RLE ? "on" : "off",
-                       devc->flag_reg & FLAG_FILTER ? "on": "off",
-                       devc->flag_reg & FLAG_DEMUX ? "on" : "off");
+                       devc->capture_flags & CAPTURE_FLAG_INTERNAL_TEST_MODE ? "on": "off",
+                       devc->capture_flags & CAPTURE_FLAG_EXTERNAL_TEST_MODE ? "on": "off",
+                       devc->capture_flags & CAPTURE_FLAG_RLE ? "on" : "off",
+                       devc->capture_flags & CAPTURE_FLAG_NOISE_FILTER ? "on": "off",
+                       devc->capture_flags & CAPTURE_FLAG_DEMUX ? "on" : "off");
        /*
         * Enable/disable OLS channel groups in the flag register according
         * to the channel mask. 1 means "disable channel".
         */
-       devc->flag_reg |= ~(ols_changrp_mask << 2) & 0x3c;
-       arg[0] = devc->flag_reg & 0xff;
-       arg[1] = devc->flag_reg >> 8;
+       devc->capture_flags |= ~(ols_changrp_mask << 2) & 0x3c;
+
+       /* RLE mode is always zero, for now. */
+
+       arg[0] = devc->capture_flags & 0xff;
+       arg[1] = devc->capture_flags >> 8;
        arg[2] = arg[3] = 0x00;
        if (send_longcommand(serial, CMD_SET_FLAGS, arg) != SR_OK)
                return SR_ERR;
 
        /* Start acquisition on the device. */
-       if (send_shortcommand(serial, CMD_RUN) != SR_OK)
+       if (send_shortcommand(serial, CMD_ARM_BASIC_TRIGGER) != SR_OK)
                return SR_ERR;
 
        /* Reset all operational states. */
@@ -536,7 +541,7 @@ static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 
 static struct sr_dev_driver ols_driver_info = {
        .name = "ols",
-       .longname = "Openbench Logic Sniffer",
+       .longname = "Openbench Logic Sniffer & SUMP compatibles",
        .api_version = 1,
        .init = std_init,
        .cleanup = std_cleanup,