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 static const uint32_t devopts[] = {
23 SR_CONF_LOGIC_ANALYZER,
24 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
25 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
26 SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
27 SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
28 SR_CONF_PATTERN_MODE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
29 SR_CONF_EXTERNAL_CLOCK | SR_CONF_GET | SR_CONF_SET,
30 SR_CONF_SWAP | SR_CONF_SET,
31 SR_CONF_RLE | SR_CONF_GET | SR_CONF_SET,
34 static const int32_t trigger_matches[] = {
41 #define STR_PATTERN_NONE "None"
42 #define STR_PATTERN_EXTERNAL "External"
43 #define STR_PATTERN_INTERNAL "Internal"
45 /* Supported methods of test pattern outputs */
48 * Capture pins 31:16 (unbuffered wing) output a test pattern
49 * that can captured on pins 0:15.
53 /** Route test pattern internally to capture buffer. */
57 static const char *patterns[] = {
63 /* Channels are numbered 0-31 (on the PCB silkscreen). */
64 SR_PRIV const char *p_ols_channel_names[] = {
65 "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12",
66 "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23",
67 "24", "25", "26", "27", "28", "29", "30", "31",
70 /* Default supported samplerates, can be overridden by device metadata. */
71 static const uint64_t samplerates[] = {
77 SR_PRIV struct sr_dev_driver p_ols_driver_info;
79 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
81 return std_init(sr_ctx, di, LOG_PREFIX);
84 static GSList *scan(struct sr_dev_driver *di, 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 devc = g_malloc0(sizeof(struct dev_context));
103 /* Device-specific settings */
104 devc->max_samplebytes = devc->max_samplerate = devc->protocol_version = 0;
106 /* Acquisition settings */
107 devc->limit_samples = devc->capture_ratio = 0;
108 devc->trigger_at = -1;
109 devc->channel_mask = 0xffffffff;
112 /* Allocate memory for the incoming ftdi data. */
113 if (!(devc->ftdi_buf = g_try_malloc0(FTDI_BUF_SIZE))) {
114 sr_err("ftdi_buf malloc failed.");
118 /* Allocate memory for the FTDI context (ftdic) and initialize it. */
119 if (!(devc->ftdic = ftdi_new())) {
120 sr_err("Failed to initialize libftdi.");
121 goto err_free_ftdi_buf;;
124 /* Try to open the FTDI device */
125 if (p_ols_open(devc) != SR_OK) {
129 /* The discovery procedure is like this: first send the Reset
130 * command (0x00) 5 times, since the device could be anywhere
131 * in a 5-byte command. Then send the ID command (0x02).
132 * If the device responds with 4 bytes ("OLS1" or "SLA1"), we
137 for (i = 0; i < 5; i++) {
138 if ((ret = write_shortcommand(devc, CMD_RESET)) != SR_OK) {
143 sr_err("Could not reset device. Quitting.");
144 goto err_close_ftdic;
146 write_shortcommand(devc, CMD_ID);
148 /* Read the response data. */
149 bytes_read = ftdi_read_data(devc->ftdic, (uint8_t *)buf, 4);
150 if (bytes_read < 0) {
151 sr_err("Failed to read FTDI data (%d): %s.",
152 bytes_read, ftdi_get_error_string(devc->ftdic));
153 goto err_close_ftdic;
155 if (bytes_read == 0) {
156 goto err_close_ftdic;
159 if (strncmp(buf, "1SLO", 4) && strncmp(buf, "1ALS", 4))
160 goto err_close_ftdic;
162 /* Definitely using the OLS protocol, check if it supports
163 * the metadata command.
165 write_shortcommand(devc, CMD_METADATA);
167 /* Read the metadata. */
168 bytes_read = ftdi_read_data(devc->ftdic, (uint8_t *)buf, 64);
169 if (bytes_read < 0) {
170 sr_err("Failed to read FTDI data (%d): %s.",
171 bytes_read, ftdi_get_error_string(devc->ftdic));
172 goto err_close_ftdic;
174 if (bytes_read == 0) {
175 goto err_close_ftdic;
178 /* Close device. We'll reopen it again when we need it. */
181 /* Parse the metadata. */
182 sdi = p_ols_get_metadata((uint8_t *)buf, bytes_read, devc);
184 /* Configure samplerate and divider. */
185 if (p_ols_set_samplerate(sdi, DEFAULT_SAMPLERATE) != SR_OK)
186 sr_dbg("Failed to set default samplerate (%"PRIu64").",
189 drvc->instances = g_slist_append(drvc->instances, sdi);
190 devices = g_slist_append(devices, sdi);
197 ftdi_free(devc->ftdic); /* NOT free() or g_free()! */
199 g_free(devc->ftdi_buf);
206 static GSList *dev_list(const struct sr_dev_driver *di)
208 return ((struct drv_context *)(di->priv))->instances;
211 static void clear_helper(void *priv)
213 struct dev_context *devc;
217 ftdi_free(devc->ftdic);
218 g_free(devc->ftdi_buf);
221 static int dev_clear(const struct sr_dev_driver *di)
223 return std_dev_clear(di, clear_helper);
226 static int cleanup(const struct sr_dev_driver *di)
228 return dev_clear(di);
231 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
232 const struct sr_channel_group *cg)
234 struct dev_context *devc;
243 case SR_CONF_SAMPLERATE:
244 *data = g_variant_new_uint64(devc->cur_samplerate);
246 case SR_CONF_CAPTURE_RATIO:
247 *data = g_variant_new_uint64(devc->capture_ratio);
249 case SR_CONF_LIMIT_SAMPLES:
250 *data = g_variant_new_uint64(devc->limit_samples);
252 case SR_CONF_PATTERN_MODE:
253 if (devc->flag_reg & FLAG_EXTERNAL_TEST_MODE)
254 *data = g_variant_new_string(STR_PATTERN_EXTERNAL);
255 else if (devc->flag_reg & FLAG_INTERNAL_TEST_MODE)
256 *data = g_variant_new_string(STR_PATTERN_INTERNAL);
258 *data = g_variant_new_string(STR_PATTERN_NONE);
261 *data = g_variant_new_boolean(devc->flag_reg & FLAG_RLE ? TRUE : FALSE);
263 case SR_CONF_EXTERNAL_CLOCK:
264 *data = g_variant_new_boolean(devc->flag_reg & FLAG_CLOCK_EXTERNAL ? TRUE : FALSE);
273 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
274 const struct sr_channel_group *cg)
276 struct dev_context *devc;
284 if (sdi->status != SR_ST_ACTIVE)
285 return SR_ERR_DEV_CLOSED;
290 case SR_CONF_SAMPLERATE:
291 tmp_u64 = g_variant_get_uint64(data);
292 if (tmp_u64 < samplerates[0] || tmp_u64 > samplerates[1])
293 return SR_ERR_SAMPLERATE;
294 ret = p_ols_set_samplerate(sdi, g_variant_get_uint64(data));
296 case SR_CONF_LIMIT_SAMPLES:
297 tmp_u64 = g_variant_get_uint64(data);
298 if (tmp_u64 < MIN_NUM_SAMPLES)
300 devc->limit_samples = tmp_u64;
303 case SR_CONF_CAPTURE_RATIO:
304 devc->capture_ratio = g_variant_get_uint64(data);
305 if (devc->capture_ratio < 0 || devc->capture_ratio > 100) {
306 devc->capture_ratio = 0;
311 case SR_CONF_EXTERNAL_CLOCK:
312 if (g_variant_get_boolean(data)) {
313 sr_info("Enabling external clock.");
314 devc->flag_reg |= FLAG_CLOCK_EXTERNAL;
316 sr_info("Disabled external clock.");
317 devc->flag_reg &= ~FLAG_CLOCK_EXTERNAL;
321 case SR_CONF_PATTERN_MODE:
322 stropt = g_variant_get_string(data, NULL);
325 if (!strcmp(stropt, STR_PATTERN_NONE)) {
326 sr_info("Disabling test modes.");
328 }else if (!strcmp(stropt, STR_PATTERN_INTERNAL)) {
329 sr_info("Enabling internal test mode.");
330 flag = FLAG_INTERNAL_TEST_MODE;
331 } else if (!strcmp(stropt, STR_PATTERN_EXTERNAL)) {
332 sr_info("Enabling external test mode.");
333 flag = FLAG_EXTERNAL_TEST_MODE;
337 if (flag != 0xffff) {
338 devc->flag_reg &= ~(FLAG_INTERNAL_TEST_MODE | FLAG_EXTERNAL_TEST_MODE);
339 devc->flag_reg |= flag;
343 if (g_variant_get_boolean(data)) {
344 sr_info("Enabling channel swapping.");
345 devc->flag_reg |= FLAG_SWAP_CHANNELS;
347 sr_info("Disabling channel swapping.");
348 devc->flag_reg &= ~FLAG_SWAP_CHANNELS;
354 if (g_variant_get_boolean(data)) {
355 sr_info("Enabling RLE.");
356 devc->flag_reg |= FLAG_RLE;
358 sr_info("Disabling RLE.");
359 devc->flag_reg &= ~FLAG_RLE;
370 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
371 const struct sr_channel_group *cg)
373 struct dev_context *devc;
374 GVariant *gvar, *grange[2];
376 int num_pols_changrp, i;
381 case SR_CONF_DEVICE_OPTIONS:
382 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
383 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
385 case SR_CONF_SAMPLERATE:
386 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
387 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
388 ARRAY_SIZE(samplerates), sizeof(uint64_t));
389 g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
390 *data = g_variant_builder_end(&gvb);
392 case SR_CONF_TRIGGER_MATCH:
393 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
394 trigger_matches, ARRAY_SIZE(trigger_matches),
397 case SR_CONF_PATTERN_MODE:
398 *data = g_variant_new_strv(patterns, ARRAY_SIZE(patterns));
400 case SR_CONF_LIMIT_SAMPLES:
404 if (devc->flag_reg & FLAG_RLE)
406 if (devc->max_samplebytes == 0)
407 /* Device didn't specify sample memory size in metadata. */
410 * Channel groups are turned off if no channels in that group are
411 * enabled, making more room for samples for the enabled group.
413 pols_channel_mask(sdi);
414 num_pols_changrp = 0;
415 for (i = 0; i < 4; i++) {
416 if (devc->channel_mask & (0xff << (i * 8)))
419 /* 3 channel groups takes as many bytes as 4 channel groups */
420 if (num_pols_changrp == 3)
421 num_pols_changrp = 4;
422 grange[0] = g_variant_new_uint64(MIN_NUM_SAMPLES);
423 if (num_pols_changrp)
424 grange[1] = g_variant_new_uint64(devc->max_samplebytes / num_pols_changrp);
426 grange[1] = g_variant_new_uint64(MIN_NUM_SAMPLES);
427 *data = g_variant_new_tuple(grange, 2);
436 static int dev_open(struct sr_dev_inst *sdi)
438 struct dev_context *devc;
442 if (p_ols_open(devc) != SR_OK) {
445 sdi->status = SR_ST_ACTIVE;
450 static int dev_close(struct sr_dev_inst *sdi)
453 struct dev_context *devc;
458 if (sdi->status == SR_ST_ACTIVE) {
459 sr_dbg("Status ACTIVE, closing device.");
460 ret = p_ols_close(devc);
462 sr_spew("Status not ACTIVE, nothing to do.");
465 sdi->status = SR_ST_INACTIVE;
470 static int set_trigger(const struct sr_dev_inst *sdi, int stage)
472 struct dev_context *devc;
477 cmd = CMD_SET_TRIGGER_MASK + stage * 4;
478 arg[0] = devc->trigger_mask[stage] & 0xff;
479 arg[1] = (devc->trigger_mask[stage] >> 8) & 0xff;
480 arg[2] = (devc->trigger_mask[stage] >> 16) & 0xff;
481 arg[3] = (devc->trigger_mask[stage] >> 24) & 0xff;
482 if (write_longcommand(devc, cmd, arg) != SR_OK)
485 cmd = CMD_SET_TRIGGER_VALUE + stage * 4;
486 arg[0] = devc->trigger_value[stage] & 0xff;
487 arg[1] = (devc->trigger_value[stage] >> 8) & 0xff;
488 arg[2] = (devc->trigger_value[stage] >> 16) & 0xff;
489 arg[3] = (devc->trigger_value[stage] >> 24) & 0xff;
490 if (write_longcommand(devc, cmd, arg) != SR_OK)
493 cmd = CMD_SET_TRIGGER_CONFIG + stage * 4;
494 arg[0] = arg[1] = arg[3] = 0x00;
496 if (stage == devc->num_stages)
497 /* Last stage, fire when this one matches. */
498 arg[3] |= TRIGGER_START;
499 if (write_longcommand(devc, cmd, arg) != SR_OK)
502 cmd = CMD_SET_TRIGGER_EDGE + stage * 4;
503 arg[0] = devc->trigger_edge[stage] & 0xff;
504 arg[1] = (devc->trigger_edge[stage] >> 8) & 0xff;
505 arg[2] = (devc->trigger_edge[stage] >> 16) & 0xff;
506 arg[3] = (devc->trigger_edge[stage] >> 24) & 0xff;
507 if (write_longcommand(devc, cmd, arg) != SR_OK)
513 static int disable_trigger(const struct sr_dev_inst *sdi, int stage)
515 struct dev_context *devc;
520 cmd = CMD_SET_TRIGGER_MASK + stage * 4;
521 arg[0] = arg[1] = arg[2] = arg[3] = 0x00;
522 if (write_longcommand(devc, cmd, arg) != SR_OK)
525 cmd = CMD_SET_TRIGGER_VALUE + stage * 4;
526 if (write_longcommand(devc, cmd, arg) != SR_OK)
529 cmd = CMD_SET_TRIGGER_CONFIG + stage * 4;
531 if (write_longcommand(devc, cmd, arg) != SR_OK)
534 cmd = CMD_SET_TRIGGER_EDGE + stage * 4;
536 if (write_longcommand(devc, cmd, arg) != SR_OK)
542 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
545 struct dev_context *devc;
546 uint32_t samplecount, readcount, delaycount;
547 uint8_t pols_changrp_mask, arg[4];
549 int num_pols_changrp, samplespercount;
552 if (sdi->status != SR_ST_ACTIVE)
553 return SR_ERR_DEV_CLOSED;
557 pols_channel_mask(sdi);
560 * Enable/disable channel groups in the flag register according to the
561 * channel mask. Calculate this here, because num_pols_changrp is
562 * needed to limit readcount.
564 pols_changrp_mask = 0;
565 num_pols_changrp = 0;
566 for (i = 0; i < 4; i++) {
567 if (devc->channel_mask & (0xff << (i * 8))) {
568 pols_changrp_mask |= (1 << i);
572 /* 3 channel groups takes as many bytes as 4 channel groups */
573 if (num_pols_changrp == 3)
574 num_pols_changrp = 4;
575 /* maximum number of samples (or RLE counts) the buffer memory can hold */
576 devc->max_samples = devc->max_samplebytes / num_pols_changrp;
579 * Limit readcount to prevent reading past the end of the hardware
582 sr_dbg("max_samples = %d", devc->max_samples);
583 sr_dbg("limit_samples = %d", devc->limit_samples);
584 samplecount = MIN(devc->max_samples, devc->limit_samples);
585 sr_dbg("Samplecount = %d", samplecount);
587 /* In demux mode the OLS is processing two samples per clock */
588 if (devc->flag_reg & FLAG_DEMUX) {
595 readcount = samplecount / samplespercount;
597 /* Rather read too many samples than too few. */
598 if (samplecount % samplespercount != 0)
601 /* Basic triggers. */
602 if (pols_convert_trigger(sdi) != SR_OK) {
603 sr_err("Failed to configure channels.");
607 if (devc->num_stages > 0) {
608 delaycount = readcount * (1 - devc->capture_ratio / 100.0);
609 devc->trigger_at = (readcount - delaycount) * samplespercount - devc->num_stages;
610 for (i = 0; i < NUM_TRIGGER_STAGES; i++) {
611 if (i <= devc->num_stages) {
612 sr_dbg("Setting p-ols stage %d trigger.", i);
613 if ((ret = set_trigger(sdi, i)) != SR_OK)
617 sr_dbg("Disabling p-ols stage %d trigger.", i);
618 if ((ret = disable_trigger(sdi, i)) != SR_OK)
623 /* No triggers configured, force trigger on first stage. */
624 sr_dbg("Forcing trigger at stage 0.");
625 if ((ret = set_trigger(sdi, 0)) != SR_OK)
627 delaycount = readcount;
631 sr_dbg("Setting samplerate to %" PRIu64 "Hz (divider %u)",
632 devc->cur_samplerate, devc->cur_samplerate_divider);
633 arg[0] = devc->cur_samplerate_divider & 0xff;
634 arg[1] = (devc->cur_samplerate_divider & 0xff00) >> 8;
635 arg[2] = (devc->cur_samplerate_divider & 0xff0000) >> 16;
637 if (write_longcommand(devc, CMD_SET_DIVIDER, arg) != SR_OK)
640 /* Send extended sample limit and pre/post-trigger capture ratio. */
641 arg[0] = ((readcount - 1) & 0xff);
642 arg[1] = ((readcount - 1) & 0xff00) >> 8;
643 arg[2] = ((readcount - 1) & 0xff0000) >> 16;
644 arg[3] = ((readcount - 1) & 0xff000000) >> 24;
645 if (write_longcommand(devc, CMD_CAPTURE_DELAY, arg) != SR_OK)
647 arg[0] = ((delaycount - 1) & 0xff);
648 arg[1] = ((delaycount - 1) & 0xff00) >> 8;
649 arg[2] = ((delaycount - 1) & 0xff0000) >> 16;
650 arg[3] = ((delaycount - 1) & 0xff000000) >> 24;
651 if (write_longcommand(devc, CMD_CAPTURE_COUNT, arg) != SR_OK)
655 sr_dbg("Setting intpat %s, extpat %s, RLE %s, noise_filter %s, demux %s",
656 devc->flag_reg & FLAG_INTERNAL_TEST_MODE ? "on": "off",
657 devc->flag_reg & FLAG_EXTERNAL_TEST_MODE ? "on": "off",
658 devc->flag_reg & FLAG_RLE ? "on" : "off",
659 devc->flag_reg & FLAG_FILTER ? "on": "off",
660 devc->flag_reg & FLAG_DEMUX ? "on" : "off");
663 * Enable/disable OLS channel groups in the flag register according
664 * to the channel mask. 1 means "disable channel".
666 devc->flag_reg &= ~0x3c;
667 devc->flag_reg |= ~(pols_changrp_mask << 2) & 0x3c;
668 sr_dbg("flag_reg = %x", devc->flag_reg);
671 * In demux mode the OLS is processing two 8-bit or 16-bit samples
672 * in parallel and for this to work the lower two bits of the four
673 * "channel_disable" bits must be replicated to the upper two bits.
675 flag_tmp = devc->flag_reg;
676 if (devc->flag_reg & FLAG_DEMUX) {
678 flag_tmp |= ~(pols_changrp_mask << 4) & 0x30;
680 arg[0] = flag_tmp & 0xff;
681 arg[1] = flag_tmp >> 8;
682 arg[2] = arg[3] = 0x00;
683 if (write_longcommand(devc, CMD_SET_FLAGS, arg) != SR_OK)
686 /* Start acquisition on the device. */
687 if (write_shortcommand(devc, CMD_RUN) != SR_OK)
690 /* Reset all operational states. */
691 devc->rle_count = devc->num_transfers = 0;
692 devc->num_samples = devc->num_bytes = 0;
693 devc->cnt_bytes = devc->cnt_samples = devc->cnt_samples_rle = 0;
694 memset(devc->sample, 0, 4);
696 /* Send header packet to the session bus. */
697 std_session_send_df_header(cb_data, LOG_PREFIX);
699 /* Hook up a dummy handler to receive data from the device. */
700 sr_session_source_add(sdi->session, 0, G_IO_IN, 10, p_ols_receive_data,
706 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
708 struct dev_context *devc;
709 struct sr_datafeed_packet packet;
713 sr_dbg("Stopping acquisition.");
714 write_shortcommand(devc, CMD_RESET);
715 write_shortcommand(devc, CMD_RESET);
716 write_shortcommand(devc, CMD_RESET);
717 write_shortcommand(devc, CMD_RESET);
718 write_shortcommand(devc, CMD_RESET);
720 sr_session_source_remove(sdi->session, 0);
722 /* Send end packet to the session bus. */
723 sr_dbg("Sending SR_DF_END.");
724 packet.type = SR_DF_END;
725 sr_session_send(cb_data, &packet);
730 SR_PRIV struct sr_dev_driver p_ols_driver_info = {
732 .longname = "Pipistrello OLS",
737 .dev_list = dev_list,
738 .dev_clear = dev_clear,
739 .config_get = config_get,
740 .config_set = config_set,
741 .config_list = config_list,
742 .dev_open = dev_open,
743 .dev_close = dev_close,
744 .dev_acquisition_start = dev_acquisition_start,
745 .dev_acquisition_stop = dev_acquisition_stop,