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[NUM_CHANNELS + 1] = {
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",
71 /* Default supported samplerates, can be overridden by device metadata. */
72 static const uint64_t samplerates[] = {
78 SR_PRIV struct sr_dev_driver p_ols_driver_info;
80 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
82 return std_init(sr_ctx, di, LOG_PREFIX);
85 static GSList *scan(struct sr_dev_driver *di, GSList *options)
87 struct sr_dev_inst *sdi;
88 struct drv_context *drvc;
89 struct dev_context *devc;
101 /* Allocate memory for our private device context. */
102 devc = g_malloc0(sizeof(struct dev_context));
104 /* Device-specific settings */
105 devc->max_samplebytes = devc->max_samplerate = devc->protocol_version = 0;
107 /* Acquisition settings */
108 devc->limit_samples = devc->capture_ratio = 0;
109 devc->trigger_at = -1;
110 devc->channel_mask = 0xffffffff;
113 /* Allocate memory for the incoming ftdi data. */
114 if (!(devc->ftdi_buf = g_try_malloc0(FTDI_BUF_SIZE))) {
115 sr_err("ftdi_buf malloc failed.");
119 /* Allocate memory for the FTDI context (ftdic) and initialize it. */
120 if (!(devc->ftdic = ftdi_new())) {
121 sr_err("Failed to initialize libftdi.");
122 goto err_free_ftdi_buf;;
125 /* Try to open the FTDI device */
126 if (p_ols_open(devc) != SR_OK) {
130 /* The discovery procedure is like this: first send the Reset
131 * command (0x00) 5 times, since the device could be anywhere
132 * in a 5-byte command. Then send the ID command (0x02).
133 * If the device responds with 4 bytes ("OLS1" or "SLA1"), we
138 for (i = 0; i < 5; i++) {
139 if ((ret = write_shortcommand(devc, CMD_RESET)) != SR_OK) {
144 sr_err("Could not reset device. Quitting.");
145 goto err_close_ftdic;
147 write_shortcommand(devc, CMD_ID);
149 /* Read the response data. */
150 bytes_read = ftdi_read_data(devc->ftdic, (uint8_t *)buf, 4);
151 if (bytes_read < 0) {
152 sr_err("Failed to read FTDI data (%d): %s.",
153 bytes_read, ftdi_get_error_string(devc->ftdic));
154 goto err_close_ftdic;
156 if (bytes_read == 0) {
157 goto err_close_ftdic;
160 if (strncmp(buf, "1SLO", 4) && strncmp(buf, "1ALS", 4))
161 goto err_close_ftdic;
163 /* Definitely using the OLS protocol, check if it supports
164 * the metadata command.
166 write_shortcommand(devc, CMD_METADATA);
168 /* Read the metadata. */
169 bytes_read = ftdi_read_data(devc->ftdic, (uint8_t *)buf, 64);
170 if (bytes_read < 0) {
171 sr_err("Failed to read FTDI data (%d): %s.",
172 bytes_read, ftdi_get_error_string(devc->ftdic));
173 goto err_close_ftdic;
175 if (bytes_read == 0) {
176 goto err_close_ftdic;
179 /* Close device. We'll reopen it again when we need it. */
182 /* Parse the metadata. */
183 sdi = p_ols_get_metadata((uint8_t *)buf, bytes_read, devc);
185 /* Configure samplerate and divider. */
186 if (p_ols_set_samplerate(sdi, DEFAULT_SAMPLERATE) != SR_OK)
187 sr_dbg("Failed to set default samplerate (%"PRIu64").",
190 drvc->instances = g_slist_append(drvc->instances, sdi);
191 devices = g_slist_append(devices, sdi);
198 ftdi_free(devc->ftdic); /* NOT free() or g_free()! */
200 g_free(devc->ftdi_buf);
207 static GSList *dev_list(const struct sr_dev_driver *di)
209 return ((struct drv_context *)(di->priv))->instances;
212 static void clear_helper(void *priv)
214 struct dev_context *devc;
218 ftdi_free(devc->ftdic);
219 g_free(devc->ftdi_buf);
222 static int dev_clear(const struct sr_dev_driver *di)
224 return std_dev_clear(di, clear_helper);
227 static int cleanup(const struct sr_dev_driver *di)
229 return dev_clear(di);
233 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
234 const struct sr_channel_group *cg)
236 struct dev_context *devc;
245 case SR_CONF_SAMPLERATE:
246 *data = g_variant_new_uint64(devc->cur_samplerate);
248 case SR_CONF_CAPTURE_RATIO:
249 *data = g_variant_new_uint64(devc->capture_ratio);
251 case SR_CONF_LIMIT_SAMPLES:
252 *data = g_variant_new_uint64(devc->limit_samples);
254 case SR_CONF_PATTERN_MODE:
255 if (devc->flag_reg & FLAG_EXTERNAL_TEST_MODE)
256 *data = g_variant_new_string(STR_PATTERN_EXTERNAL);
257 else if (devc->flag_reg & FLAG_INTERNAL_TEST_MODE)
258 *data = g_variant_new_string(STR_PATTERN_INTERNAL);
260 *data = g_variant_new_string(STR_PATTERN_NONE);
263 *data = g_variant_new_boolean(devc->flag_reg & FLAG_RLE ? TRUE : FALSE);
265 case SR_CONF_EXTERNAL_CLOCK:
266 *data = g_variant_new_boolean(devc->flag_reg & FLAG_CLOCK_EXTERNAL ? TRUE : FALSE);
275 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
276 const struct sr_channel_group *cg)
278 struct dev_context *devc;
286 if (sdi->status != SR_ST_ACTIVE)
287 return SR_ERR_DEV_CLOSED;
292 case SR_CONF_SAMPLERATE:
293 tmp_u64 = g_variant_get_uint64(data);
294 if (tmp_u64 < samplerates[0] || tmp_u64 > samplerates[1])
295 return SR_ERR_SAMPLERATE;
296 ret = p_ols_set_samplerate(sdi, g_variant_get_uint64(data));
298 case SR_CONF_LIMIT_SAMPLES:
299 tmp_u64 = g_variant_get_uint64(data);
300 if (tmp_u64 < MIN_NUM_SAMPLES)
302 devc->limit_samples = tmp_u64;
305 case SR_CONF_CAPTURE_RATIO:
306 devc->capture_ratio = g_variant_get_uint64(data);
307 if (devc->capture_ratio < 0 || devc->capture_ratio > 100) {
308 devc->capture_ratio = 0;
313 case SR_CONF_EXTERNAL_CLOCK:
314 if (g_variant_get_boolean(data)) {
315 sr_info("Enabling external clock.");
316 devc->flag_reg |= FLAG_CLOCK_EXTERNAL;
318 sr_info("Disabled external clock.");
319 devc->flag_reg &= ~FLAG_CLOCK_EXTERNAL;
323 case SR_CONF_PATTERN_MODE:
324 stropt = g_variant_get_string(data, NULL);
327 if (!strcmp(stropt, STR_PATTERN_NONE)) {
328 sr_info("Disabling test modes.");
330 }else if (!strcmp(stropt, STR_PATTERN_INTERNAL)) {
331 sr_info("Enabling internal test mode.");
332 flag = FLAG_INTERNAL_TEST_MODE;
333 } else if (!strcmp(stropt, STR_PATTERN_EXTERNAL)) {
334 sr_info("Enabling external test mode.");
335 flag = FLAG_EXTERNAL_TEST_MODE;
339 if (flag != 0xffff) {
340 devc->flag_reg &= ~(FLAG_INTERNAL_TEST_MODE | FLAG_EXTERNAL_TEST_MODE);
341 devc->flag_reg |= flag;
345 if (g_variant_get_boolean(data)) {
346 sr_info("Enabling channel swapping.");
347 devc->flag_reg |= FLAG_SWAP_CHANNELS;
349 sr_info("Disabling channel swapping.");
350 devc->flag_reg &= ~FLAG_SWAP_CHANNELS;
356 if (g_variant_get_boolean(data)) {
357 sr_info("Enabling RLE.");
358 devc->flag_reg |= FLAG_RLE;
360 sr_info("Disabling RLE.");
361 devc->flag_reg &= ~FLAG_RLE;
372 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
373 const struct sr_channel_group *cg)
375 struct dev_context *devc;
376 GVariant *gvar, *grange[2];
378 int num_pols_changrp, i;
383 case SR_CONF_DEVICE_OPTIONS:
384 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
385 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
387 case SR_CONF_SAMPLERATE:
388 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
389 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
390 ARRAY_SIZE(samplerates), sizeof(uint64_t));
391 g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
392 *data = g_variant_builder_end(&gvb);
394 case SR_CONF_TRIGGER_MATCH:
395 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
396 trigger_matches, ARRAY_SIZE(trigger_matches),
399 case SR_CONF_PATTERN_MODE:
400 *data = g_variant_new_strv(patterns, ARRAY_SIZE(patterns));
402 case SR_CONF_LIMIT_SAMPLES:
406 if (devc->flag_reg & FLAG_RLE)
408 if (devc->max_samplebytes == 0)
409 /* Device didn't specify sample memory size in metadata. */
412 * Channel groups are turned off if no channels in that group are
413 * enabled, making more room for samples for the enabled group.
415 pols_channel_mask(sdi);
416 num_pols_changrp = 0;
417 for (i = 0; i < 4; i++) {
418 if (devc->channel_mask & (0xff << (i * 8)))
421 /* 3 channel groups takes as many bytes as 4 channel groups */
422 if (num_pols_changrp == 3)
423 num_pols_changrp = 4;
424 grange[0] = g_variant_new_uint64(MIN_NUM_SAMPLES);
425 if (num_pols_changrp)
426 grange[1] = g_variant_new_uint64(devc->max_samplebytes / num_pols_changrp);
428 grange[1] = g_variant_new_uint64(MIN_NUM_SAMPLES);
429 *data = g_variant_new_tuple(grange, 2);
438 static int dev_open(struct sr_dev_inst *sdi)
440 struct dev_context *devc;
444 if (p_ols_open(devc) != SR_OK) {
447 sdi->status = SR_ST_ACTIVE;
452 static int dev_close(struct sr_dev_inst *sdi)
455 struct dev_context *devc;
460 if (sdi->status == SR_ST_ACTIVE) {
461 sr_dbg("Status ACTIVE, closing device.");
462 ret = p_ols_close(devc);
464 sr_spew("Status not ACTIVE, nothing to do.");
467 sdi->status = SR_ST_INACTIVE;
473 static int set_trigger(const struct sr_dev_inst *sdi, int stage)
475 struct dev_context *devc;
480 cmd = CMD_SET_TRIGGER_MASK + stage * 4;
481 arg[0] = devc->trigger_mask[stage] & 0xff;
482 arg[1] = (devc->trigger_mask[stage] >> 8) & 0xff;
483 arg[2] = (devc->trigger_mask[stage] >> 16) & 0xff;
484 arg[3] = (devc->trigger_mask[stage] >> 24) & 0xff;
485 if (write_longcommand(devc, cmd, arg) != SR_OK)
488 cmd = CMD_SET_TRIGGER_VALUE + stage * 4;
489 arg[0] = devc->trigger_value[stage] & 0xff;
490 arg[1] = (devc->trigger_value[stage] >> 8) & 0xff;
491 arg[2] = (devc->trigger_value[stage] >> 16) & 0xff;
492 arg[3] = (devc->trigger_value[stage] >> 24) & 0xff;
493 if (write_longcommand(devc, cmd, arg) != SR_OK)
496 cmd = CMD_SET_TRIGGER_CONFIG + stage * 4;
497 arg[0] = arg[1] = arg[3] = 0x00;
499 if (stage == devc->num_stages)
500 /* Last stage, fire when this one matches. */
501 arg[3] |= TRIGGER_START;
502 if (write_longcommand(devc, cmd, arg) != SR_OK)
505 cmd = CMD_SET_TRIGGER_EDGE + stage * 4;
506 arg[0] = devc->trigger_edge[stage] & 0xff;
507 arg[1] = (devc->trigger_edge[stage] >> 8) & 0xff;
508 arg[2] = (devc->trigger_edge[stage] >> 16) & 0xff;
509 arg[3] = (devc->trigger_edge[stage] >> 24) & 0xff;
510 if (write_longcommand(devc, cmd, arg) != SR_OK)
516 static int disable_trigger(const struct sr_dev_inst *sdi, int stage)
518 struct dev_context *devc;
523 cmd = CMD_SET_TRIGGER_MASK + stage * 4;
524 arg[0] = arg[1] = arg[2] = arg[3] = 0x00;
525 if (write_longcommand(devc, cmd, arg) != SR_OK)
528 cmd = CMD_SET_TRIGGER_VALUE + stage * 4;
529 if (write_longcommand(devc, cmd, arg) != SR_OK)
532 cmd = CMD_SET_TRIGGER_CONFIG + stage * 4;
534 if (write_longcommand(devc, cmd, arg) != SR_OK)
537 cmd = CMD_SET_TRIGGER_EDGE + stage * 4;
539 if (write_longcommand(devc, cmd, arg) != SR_OK)
545 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
548 struct dev_context *devc;
549 uint32_t samplecount, readcount, delaycount;
550 uint8_t pols_changrp_mask, arg[4];
552 int num_pols_changrp, samplespercount;
555 if (sdi->status != SR_ST_ACTIVE)
556 return SR_ERR_DEV_CLOSED;
560 pols_channel_mask(sdi);
563 * Enable/disable channel groups in the flag register according to the
564 * channel mask. Calculate this here, because num_pols_changrp is
565 * needed to limit readcount.
567 pols_changrp_mask = 0;
568 num_pols_changrp = 0;
569 for (i = 0; i < 4; i++) {
570 if (devc->channel_mask & (0xff << (i * 8))) {
571 pols_changrp_mask |= (1 << i);
575 /* 3 channel groups takes as many bytes as 4 channel groups */
576 if (num_pols_changrp == 3)
577 num_pols_changrp = 4;
578 /* maximum number of samples (or RLE counts) the buffer memory can hold */
579 devc->max_samples = devc->max_samplebytes / num_pols_changrp;
582 * Limit readcount to prevent reading past the end of the hardware
585 sr_dbg("max_samples = %d", devc->max_samples);
586 sr_dbg("limit_samples = %d", devc->limit_samples);
587 samplecount = MIN(devc->max_samples, devc->limit_samples);
588 sr_dbg("Samplecount = %d", samplecount);
590 /* In demux mode the OLS is processing two samples per clock */
591 if (devc->flag_reg & FLAG_DEMUX) {
598 readcount = samplecount / samplespercount;
600 /* Rather read too many samples than too few. */
601 if (samplecount % samplespercount != 0)
604 /* Basic triggers. */
605 if (pols_convert_trigger(sdi) != SR_OK) {
606 sr_err("Failed to configure channels.");
610 if (devc->num_stages > 0) {
611 delaycount = readcount * (1 - devc->capture_ratio / 100.0);
612 devc->trigger_at = (readcount - delaycount) * samplespercount - devc->num_stages;
613 for (i = 0; i < NUM_TRIGGER_STAGES; i++) {
614 if (i <= devc->num_stages) {
615 sr_dbg("Setting p-ols stage %d trigger.", i);
616 if ((ret = set_trigger(sdi, i)) != SR_OK)
620 sr_dbg("Disabling p-ols stage %d trigger.", i);
621 if ((ret = disable_trigger(sdi, i)) != SR_OK)
626 /* No triggers configured, force trigger on first stage. */
627 sr_dbg("Forcing trigger at stage 0.");
628 if ((ret = set_trigger(sdi, 0)) != SR_OK)
630 delaycount = readcount;
634 sr_dbg("Setting samplerate to %" PRIu64 "Hz (divider %u)",
635 devc->cur_samplerate, devc->cur_samplerate_divider);
636 arg[0] = devc->cur_samplerate_divider & 0xff;
637 arg[1] = (devc->cur_samplerate_divider & 0xff00) >> 8;
638 arg[2] = (devc->cur_samplerate_divider & 0xff0000) >> 16;
640 if (write_longcommand(devc, CMD_SET_DIVIDER, arg) != SR_OK)
643 /* Send extended sample limit and pre/post-trigger capture ratio. */
644 arg[0] = ((readcount - 1) & 0xff);
645 arg[1] = ((readcount - 1) & 0xff00) >> 8;
646 arg[2] = ((readcount - 1) & 0xff0000) >> 16;
647 arg[3] = ((readcount - 1) & 0xff000000) >> 24;
648 if (write_longcommand(devc, CMD_CAPTURE_DELAY, arg) != SR_OK)
650 arg[0] = ((delaycount - 1) & 0xff);
651 arg[1] = ((delaycount - 1) & 0xff00) >> 8;
652 arg[2] = ((delaycount - 1) & 0xff0000) >> 16;
653 arg[3] = ((delaycount - 1) & 0xff000000) >> 24;
654 if (write_longcommand(devc, CMD_CAPTURE_COUNT, arg) != SR_OK)
658 sr_dbg("Setting intpat %s, extpat %s, RLE %s, noise_filter %s, demux %s",
659 devc->flag_reg & FLAG_INTERNAL_TEST_MODE ? "on": "off",
660 devc->flag_reg & FLAG_EXTERNAL_TEST_MODE ? "on": "off",
661 devc->flag_reg & FLAG_RLE ? "on" : "off",
662 devc->flag_reg & FLAG_FILTER ? "on": "off",
663 devc->flag_reg & FLAG_DEMUX ? "on" : "off");
666 * Enable/disable OLS channel groups in the flag register according
667 * to the channel mask. 1 means "disable channel".
669 devc->flag_reg &= ~0x3c;
670 devc->flag_reg |= ~(pols_changrp_mask << 2) & 0x3c;
671 sr_dbg("flag_reg = %x", devc->flag_reg);
674 * In demux mode the OLS is processing two 8-bit or 16-bit samples
675 * in parallel and for this to work the lower two bits of the four
676 * "channel_disable" bits must be replicated to the upper two bits.
678 flag_tmp = devc->flag_reg;
679 if (devc->flag_reg & FLAG_DEMUX) {
681 flag_tmp |= ~(pols_changrp_mask << 4) & 0x30;
683 arg[0] = flag_tmp & 0xff;
684 arg[1] = flag_tmp >> 8;
685 arg[2] = arg[3] = 0x00;
686 if (write_longcommand(devc, CMD_SET_FLAGS, arg) != SR_OK)
689 /* Start acquisition on the device. */
690 if (write_shortcommand(devc, CMD_RUN) != SR_OK)
693 /* Reset all operational states. */
694 devc->rle_count = devc->num_transfers = 0;
695 devc->num_samples = devc->num_bytes = 0;
696 devc->cnt_bytes = devc->cnt_samples = devc->cnt_samples_rle = 0;
697 memset(devc->sample, 0, 4);
699 /* Send header packet to the session bus. */
700 std_session_send_df_header(cb_data, LOG_PREFIX);
702 /* Hook up a dummy handler to receive data from the device. */
703 sr_session_source_add(sdi->session, 0, G_IO_IN, 10, p_ols_receive_data,
711 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
713 struct dev_context *devc;
714 struct sr_datafeed_packet packet;
718 sr_dbg("Stopping acquisition.");
719 write_shortcommand(devc, CMD_RESET);
720 write_shortcommand(devc, CMD_RESET);
721 write_shortcommand(devc, CMD_RESET);
722 write_shortcommand(devc, CMD_RESET);
723 write_shortcommand(devc, CMD_RESET);
725 sr_session_source_remove(sdi->session, 0);
727 /* Send end packet to the session bus. */
728 sr_dbg("Sending SR_DF_END.");
729 packet.type = SR_DF_END;
730 sr_session_send(cb_data, &packet);
735 SR_PRIV struct sr_dev_driver p_ols_driver_info = {
737 .longname = "Pipistrello OLS",
742 .dev_list = dev_list,
743 .dev_clear = dev_clear,
744 .config_get = config_get,
745 .config_set = config_set,
746 .config_list = config_list,
747 .dev_open = dev_open,
748 .dev_close = dev_close,
749 .dev_acquisition_start = dev_acquisition_start,
750 .dev_acquisition_stop = dev_acquisition_stop,