2 * This file is part of the libsigrok project.
4 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
22 #define USB_VENDOR_ID 0x0403
23 #define USB_DEVICE_ID 0x6010
24 #define USB_VENDOR_NAME "Saanlima"
25 #define USB_IPRODUCT "Pipistrello LX45"
27 static const int32_t hwcaps[] = {
28 SR_CONF_LOGIC_ANALYZER,
31 SR_CONF_CAPTURE_RATIO,
32 SR_CONF_LIMIT_SAMPLES,
34 SR_CONF_EXTERNAL_CLOCK,
39 #define STR_PATTERN_NONE "None"
40 #define STR_PATTERN_EXTERNAL "External"
41 #define STR_PATTERN_INTERNAL "Internal"
43 /* Supported methods of test pattern outputs */
46 * Capture pins 31:16 (unbuffered wing) output a test pattern
47 * that can captured on pins 0:15.
51 /** Route test pattern internally to capture buffer. */
55 static const char *patterns[] = {
61 /* Channels are numbered 0-31 (on the PCB silkscreen). */
62 SR_PRIV const char *p_ols_channel_names[NUM_CHANNELS + 1] = {
63 "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12",
64 "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23",
65 "24", "25", "26", "27", "28", "29", "30", "31",
69 /* Default supported samplerates, can be overridden by device metadata. */
70 static const uint64_t samplerates[] = {
76 SR_PRIV struct sr_dev_driver p_ols_driver_info;
77 static struct sr_dev_driver *di = &p_ols_driver_info;
79 static int init(struct sr_context *sr_ctx)
81 return std_init(sr_ctx, di, LOG_PREFIX);
84 static GSList *scan(GSList *options)
86 struct sr_dev_inst *sdi;
87 struct drv_context *drvc;
88 struct dev_context *devc;
100 /* Allocate memory for our private device context. */
101 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
102 sr_err("Device context malloc failed.");
103 goto err_free_nothing;
106 /* Device-specific settings */
107 devc->max_samples = devc->max_samplerate = devc->protocol_version = 0;
109 /* Acquisition settings */
110 devc->limit_samples = devc->capture_ratio = 0;
111 devc->trigger_at = -1;
112 devc->channel_mask = 0xffffffff;
115 /* Allocate memory for the incoming ftdi data. */
116 if (!(devc->ftdi_buf = g_try_malloc0(FTDI_BUF_SIZE))) {
117 sr_err("ftdi_buf malloc failed.");
121 /* Allocate memory for the FTDI context (ftdic) and initialize it. */
122 if (!(devc->ftdic = ftdi_new())) {
123 sr_err("Failed to initialize libftdi.");
124 goto err_free_ftdi_buf;;
127 /* Try to open the FTDI device */
128 if (p_ols_open(devc) != SR_OK) {
132 /* The discovery procedure is like this: first send the Reset
133 * command (0x00) 5 times, since the device could be anywhere
134 * in a 5-byte command. Then send the ID command (0x02).
135 * If the device responds with 4 bytes ("OLS1" or "SLA1"), we
140 for (i = 0; i < 5; i++) {
141 if ((ret = write_shortcommand(devc, CMD_RESET)) != SR_OK) {
146 sr_err("Could not reset device. Quitting.");
147 goto err_close_ftdic;
149 write_shortcommand(devc, CMD_ID);
151 /* Read the response data. */
152 bytes_read = ftdi_read_data(devc->ftdic, (uint8_t *)buf, 4);
153 if (bytes_read < 0) {
154 sr_err("Failed to read FTDI data (%d): %s.",
155 bytes_read, ftdi_get_error_string(devc->ftdic));
156 goto err_close_ftdic;
158 if (bytes_read == 0) {
159 goto err_close_ftdic;
162 if (strncmp(buf, "1SLO", 4) && strncmp(buf, "1ALS", 4))
163 goto err_close_ftdic;
165 /* Definitely using the OLS protocol, check if it supports
166 * the metadata command.
168 write_shortcommand(devc, CMD_METADATA);
170 /* Read the metadata. */
171 bytes_read = ftdi_read_data(devc->ftdic, (uint8_t *)buf, 64);
172 if (bytes_read < 0) {
173 sr_err("Failed to read FTDI data (%d): %s.",
174 bytes_read, ftdi_get_error_string(devc->ftdic));
175 goto err_close_ftdic;
177 if (bytes_read == 0) {
178 goto err_close_ftdic;
181 /* Close device. We'll reopen it again when we need it. */
184 /* Parse the metadata. */
185 sdi = p_ols_get_metadata((uint8_t *)buf, bytes_read, devc);
188 /* Configure samplerate and divider. */
189 if (p_ols_set_samplerate(sdi, DEFAULT_SAMPLERATE) != SR_OK)
190 sr_dbg("Failed to set default samplerate (%"PRIu64").",
192 /* Clear trigger masks, values and stages. */
193 p_ols_configure_channels(sdi);
195 drvc->instances = g_slist_append(drvc->instances, sdi);
196 devices = g_slist_append(devices, sdi);
203 ftdi_free(devc->ftdic); /* NOT free() or g_free()! */
205 g_free(devc->ftdi_buf);
213 static GSList *dev_list(void)
215 return ((struct drv_context *)(di->priv))->instances;
218 static void clear_helper(void *priv)
220 struct dev_context *devc;
224 ftdi_free(devc->ftdic);
225 g_free(devc->ftdi_buf);
228 static int dev_clear(void)
230 return std_dev_clear(di, clear_helper);
233 static int cleanup(void)
239 static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi,
240 const struct sr_channel_group *cg)
242 struct dev_context *devc;
251 case SR_CONF_SAMPLERATE:
252 *data = g_variant_new_uint64(devc->cur_samplerate);
254 case SR_CONF_CAPTURE_RATIO:
255 *data = g_variant_new_uint64(devc->capture_ratio);
257 case SR_CONF_LIMIT_SAMPLES:
258 *data = g_variant_new_uint64(devc->limit_samples);
260 case SR_CONF_PATTERN_MODE:
261 if (devc->flag_reg & FLAG_EXTERNAL_TEST_MODE)
262 *data = g_variant_new_string(STR_PATTERN_EXTERNAL);
263 else if (devc->flag_reg & FLAG_INTERNAL_TEST_MODE)
264 *data = g_variant_new_string(STR_PATTERN_INTERNAL);
266 *data = g_variant_new_string(STR_PATTERN_NONE);
269 *data = g_variant_new_boolean(devc->flag_reg & FLAG_RLE ? TRUE : FALSE);
271 case SR_CONF_EXTERNAL_CLOCK:
272 *data = g_variant_new_boolean(devc->flag_reg & FLAG_CLOCK_EXTERNAL ? TRUE : FALSE);
281 static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
282 const struct sr_channel_group *cg)
284 struct dev_context *devc;
292 if (sdi->status != SR_ST_ACTIVE)
293 return SR_ERR_DEV_CLOSED;
298 case SR_CONF_SAMPLERATE:
299 tmp_u64 = g_variant_get_uint64(data);
300 if (tmp_u64 < samplerates[0] || tmp_u64 > samplerates[1])
301 return SR_ERR_SAMPLERATE;
302 ret = p_ols_set_samplerate(sdi, g_variant_get_uint64(data));
304 case SR_CONF_LIMIT_SAMPLES:
305 tmp_u64 = g_variant_get_uint64(data);
306 if (tmp_u64 < MIN_NUM_SAMPLES)
308 devc->limit_samples = tmp_u64;
311 case SR_CONF_CAPTURE_RATIO:
312 devc->capture_ratio = g_variant_get_uint64(data);
313 if (devc->capture_ratio < 0 || devc->capture_ratio > 100) {
314 devc->capture_ratio = 0;
319 case SR_CONF_EXTERNAL_CLOCK:
320 if (g_variant_get_boolean(data)) {
321 sr_info("Enabling external clock.");
322 devc->flag_reg |= FLAG_CLOCK_EXTERNAL;
324 sr_info("Disabled external clock.");
325 devc->flag_reg &= ~FLAG_CLOCK_EXTERNAL;
329 case SR_CONF_PATTERN_MODE:
330 stropt = g_variant_get_string(data, NULL);
333 if (!strcmp(stropt, STR_PATTERN_NONE)) {
334 sr_info("Disabling test modes.");
336 }else if (!strcmp(stropt, STR_PATTERN_INTERNAL)) {
337 sr_info("Enabling internal test mode.");
338 flag = FLAG_INTERNAL_TEST_MODE;
339 } else if (!strcmp(stropt, STR_PATTERN_EXTERNAL)) {
340 sr_info("Enabling external test mode.");
341 flag = FLAG_EXTERNAL_TEST_MODE;
345 if (flag != 0xffff) {
346 devc->flag_reg &= ~(FLAG_INTERNAL_TEST_MODE | FLAG_EXTERNAL_TEST_MODE);
347 devc->flag_reg |= flag;
351 if (g_variant_get_boolean(data)) {
352 sr_info("Enabling channel swapping.");
353 devc->flag_reg |= FLAG_SWAP_CHANNELS;
355 sr_info("Disabling channel swapping.");
356 devc->flag_reg &= ~FLAG_SWAP_CHANNELS;
362 if (g_variant_get_boolean(data)) {
363 sr_info("Enabling RLE.");
364 devc->flag_reg |= FLAG_RLE;
366 sr_info("Disabling RLE.");
367 devc->flag_reg &= ~FLAG_RLE;
378 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
379 const struct sr_channel_group *cg)
381 struct dev_context *devc;
382 GVariant *gvar, *grange[2];
389 case SR_CONF_DEVICE_OPTIONS:
390 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
391 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
393 case SR_CONF_SAMPLERATE:
394 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
395 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
396 ARRAY_SIZE(samplerates), sizeof(uint64_t));
397 g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
398 *data = g_variant_builder_end(&gvb);
400 case SR_CONF_TRIGGER_TYPE:
401 *data = g_variant_new_string(TRIGGER_TYPE);
403 case SR_CONF_PATTERN_MODE:
404 *data = g_variant_new_strv(patterns, ARRAY_SIZE(patterns));
406 case SR_CONF_LIMIT_SAMPLES:
410 if (devc->flag_reg & FLAG_RLE)
412 if (devc->max_samples == 0)
413 /* Device didn't specify sample memory size in metadata. */
416 * Channel groups are turned off if no channels in that group are
417 * enabled, making more room for samples for the enabled group.
419 p_ols_configure_channels(sdi);
421 for (i = 0; i < 4; i++) {
422 if (devc->channel_mask & (0xff << (i * 8)))
425 if (num_channels == 0) {
426 /* This can happen, but shouldn't cause too much drama.
427 * However we can't continue because the code below would
431 grange[0] = g_variant_new_uint64(MIN_NUM_SAMPLES);
432 grange[1] = g_variant_new_uint64(devc->max_samples / num_channels);
433 *data = g_variant_new_tuple(grange, 2);
442 static int dev_open(struct sr_dev_inst *sdi)
444 struct dev_context *devc;
449 if (p_ols_open(devc) != SR_OK) {
452 sdi->status = SR_ST_ACTIVE;
457 static int dev_close(struct sr_dev_inst *sdi)
460 struct dev_context *devc;
465 if (sdi->status == SR_ST_ACTIVE) {
466 sr_dbg("Status ACTIVE, closing device.");
467 ret = p_ols_close(devc);
469 sr_spew("Status not ACTIVE, nothing to do.");
472 sdi->status = SR_ST_INACTIVE;
478 static int set_trigger(const struct sr_dev_inst *sdi, int stage)
480 struct dev_context *devc;
485 cmd = CMD_SET_TRIGGER_MASK + stage * 4;
486 arg[0] = devc->trigger_mask[stage] & 0xff;
487 arg[1] = (devc->trigger_mask[stage] >> 8) & 0xff;
488 arg[2] = (devc->trigger_mask[stage] >> 16) & 0xff;
489 arg[3] = (devc->trigger_mask[stage] >> 24) & 0xff;
490 if (write_longcommand(devc, cmd, arg) != SR_OK)
493 cmd = CMD_SET_TRIGGER_VALUE + stage * 4;
494 arg[0] = devc->trigger_value[stage] & 0xff;
495 arg[1] = (devc->trigger_value[stage] >> 8) & 0xff;
496 arg[2] = (devc->trigger_value[stage] >> 16) & 0xff;
497 arg[3] = (devc->trigger_value[stage] >> 24) & 0xff;
498 if (write_longcommand(devc, cmd, arg) != SR_OK)
501 cmd = CMD_SET_TRIGGER_CONFIG + stage * 4;
502 arg[0] = arg[1] = arg[3] = 0x00;
504 if (stage == devc->num_stages)
505 /* Last stage, fire when this one matches. */
506 arg[3] |= TRIGGER_START;
507 if (write_longcommand(devc, cmd, arg) != SR_OK)
513 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
516 struct dev_context *devc;
517 uint32_t samplecount, readcount, delaycount;
518 uint8_t changrp_mask, arg[4];
522 if (sdi->status != SR_ST_ACTIVE)
523 return SR_ERR_DEV_CLOSED;
527 if (p_ols_configure_channels(sdi) != SR_OK) {
528 sr_err("Failed to configure channels.");
533 * Enable/disable channel groups in the flag register according to the
534 * channel mask. Calculate this here, because num_channels is needed
535 * to limit readcount.
539 for (i = 0; i < 4; i++) {
540 if (devc->channel_mask & (0xff << (i * 8))) {
541 changrp_mask |= (1 << i);
547 * Limit readcount to prevent reading past the end of the hardware
550 sr_dbg("max_samples = %d", devc->max_samples);
551 sr_dbg("limit_samples = %d", devc->limit_samples);
552 samplecount = MIN(devc->max_samples / num_channels, devc->limit_samples);
553 readcount = samplecount / 4;
554 sr_dbg("Samplecount = %d", samplecount);
556 /* Rather read too many samples than too few. */
557 if (samplecount % 4 != 0)
560 /* Basic triggers. */
561 if (devc->trigger_mask[0] != 0x00000000) {
562 /* At least one channel has a trigger on it. */
563 delaycount = readcount * (1 - devc->capture_ratio / 100.0);
564 devc->trigger_at = (readcount - delaycount) * 4 - devc->num_stages;
565 for (i = 0; i <= devc->num_stages; i++) {
566 sr_dbg("Setting stage %d trigger.", i);
567 if ((ret = set_trigger(sdi, i)) != SR_OK)
571 /* No triggers configured, force trigger on first stage. */
572 sr_dbg("Forcing trigger at stage 0.");
573 if ((ret = set_trigger(sdi, 0)) != SR_OK)
575 delaycount = readcount;
579 sr_dbg("Setting samplerate to %" PRIu64 "Hz (divider %u)",
580 devc->cur_samplerate, devc->cur_samplerate_divider);
581 arg[0] = devc->cur_samplerate_divider & 0xff;
582 arg[1] = (devc->cur_samplerate_divider & 0xff00) >> 8;
583 arg[2] = (devc->cur_samplerate_divider & 0xff0000) >> 16;
585 if (write_longcommand(devc, CMD_SET_DIVIDER, arg) != SR_OK)
587 /* Send extended sample limit and pre/post-trigger capture ratio. */
588 arg[0] = ((readcount - 1) & 0xff);
589 arg[1] = ((readcount - 1) & 0xff00) >> 8;
590 arg[2] = ((readcount - 1) & 0xff0000) >> 16;
591 arg[3] = ((readcount - 1) & 0xff000000) >> 24;
592 if (write_longcommand(devc, CMD_CAPTURE_COUNT, arg) != SR_OK)
594 arg[0] = ((delaycount - 1) & 0xff);
595 arg[1] = ((delaycount - 1) & 0xff00) >> 8;
596 arg[2] = ((delaycount - 1) & 0xff0000) >> 16;
597 arg[3] = ((delaycount - 1) & 0xff000000) >> 24;
598 if (write_longcommand(devc, CMD_CAPTURE_DELAY, arg) != SR_OK)
601 sr_dbg("Setting intpat %s, extpat %s, RLE %s, noise_filter %s, demux %s",
602 devc->flag_reg & FLAG_INTERNAL_TEST_MODE ? "on": "off",
603 devc->flag_reg & FLAG_EXTERNAL_TEST_MODE ? "on": "off",
604 devc->flag_reg & FLAG_RLE ? "on" : "off",
605 devc->flag_reg & FLAG_FILTER ? "on": "off",
606 devc->flag_reg & FLAG_DEMUX ? "on" : "off");
608 /* 1 means "disable channel". */
609 devc->flag_reg |= ~(changrp_mask << 2) & 0x3c;
610 arg[0] = devc->flag_reg & 0xff;
611 arg[1] = devc->flag_reg >> 8;
612 arg[2] = arg[3] = 0x00;
613 if (write_longcommand(devc, CMD_SET_FLAGS, arg) != SR_OK)
616 /* Start acquisition on the device. */
617 if (write_shortcommand(devc, CMD_RUN) != SR_OK)
620 /* Reset all operational states. */
621 devc->rle_count = devc->num_transfers = 0;
622 devc->num_samples = devc->num_bytes = 0;
623 devc->cnt_bytes = devc->cnt_samples = devc->cnt_samples_rle = 0;
624 memset(devc->sample, 0, 4);
626 /* Send header packet to the session bus. */
627 std_session_send_df_header(cb_data, LOG_PREFIX);
629 /* Hook up a dummy handler to receive data from the device. */
630 sr_source_add(-1, G_IO_IN, 0, p_ols_receive_data, (void *)sdi);
637 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
639 struct dev_context *devc;
640 struct sr_datafeed_packet packet;
644 sr_dbg("Stopping acquisition.");
645 write_shortcommand(devc, CMD_RESET);
646 write_shortcommand(devc, CMD_RESET);
647 write_shortcommand(devc, CMD_RESET);
648 write_shortcommand(devc, CMD_RESET);
649 write_shortcommand(devc, CMD_RESET);
651 sr_source_remove(-1);
653 /* Send end packet to the session bus. */
654 sr_dbg("Sending SR_DF_END.");
655 packet.type = SR_DF_END;
656 sr_session_send(cb_data, &packet);
661 SR_PRIV struct sr_dev_driver p_ols_driver_info = {
663 .longname = "Pipistrello OLS",
668 .dev_list = dev_list,
669 .dev_clear = dev_clear,
670 .config_get = config_get,
671 .config_set = config_set,
672 .config_list = config_list,
673 .dev_open = dev_open,
674 .dev_close = dev_close,
675 .dev_acquisition_start = dev_acquisition_start,
676 .dev_acquisition_stop = dev_acquisition_stop,