2 * This file is part of the libsigrok project.
4 * Copyright (C) 2010-2012 Håvard Espeland <gus@ping.uio.no>,
5 * Copyright (C) 2010 Martin Stensgård <mastensg@ping.uio.no>
6 * Copyright (C) 2010 Carl Henrik Lunde <chlunde@ping.uio.no>
8 * This program is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation, either version 3 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
23 * ASIX SIGMA/SIGMA2 logic analyzer driver
27 #include <glib/gstdio.h>
31 #include "libsigrok.h"
32 #include "libsigrok-internal.h"
33 #include "asix-sigma.h"
35 #define USB_VENDOR 0xa600
36 #define USB_PRODUCT 0xa000
37 #define USB_DESCRIPTION "ASIX SIGMA"
38 #define USB_VENDOR_NAME "ASIX"
39 #define USB_MODEL_NAME "SIGMA"
41 SR_PRIV struct sr_dev_driver asix_sigma_driver_info;
42 static struct sr_dev_driver *di = &asix_sigma_driver_info;
43 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data);
46 * The ASIX Sigma supports arbitrary integer frequency divider in
47 * the 50MHz mode. The divider is in range 1...256 , allowing for
48 * very precise sampling rate selection. This driver supports only
49 * a subset of the sampling rates.
51 static const uint64_t samplerates[] = {
52 SR_KHZ(200), /* div=250 */
53 SR_KHZ(250), /* div=200 */
54 SR_KHZ(500), /* div=100 */
55 SR_MHZ(1), /* div=50 */
56 SR_MHZ(5), /* div=10 */
57 SR_MHZ(10), /* div=5 */
58 SR_MHZ(25), /* div=2 */
59 SR_MHZ(50), /* div=1 */
60 SR_MHZ(100), /* Special FW needed */
61 SR_MHZ(200), /* Special FW needed */
65 * Channel numbers seem to go from 1-16, according to this image:
66 * http://tools.asix.net/img/sigma_sigmacab_pins_720.jpg
67 * (the cable has two additional GND pins, and a TI and TO pin)
69 static const char *channel_names[] = {
70 "1", "2", "3", "4", "5", "6", "7", "8",
71 "9", "10", "11", "12", "13", "14", "15", "16",
74 static const uint32_t devopts[] = {
75 SR_CONF_LOGIC_ANALYZER,
76 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
77 SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
78 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
79 SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
80 SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
83 static const int32_t trigger_matches[] = {
90 static const char *sigma_firmware_files[] = {
91 /* 50 MHz, supports 8 bit fractions */
92 FIRMWARE_DIR "/asix-sigma-50.fw",
94 FIRMWARE_DIR "/asix-sigma-100.fw",
96 FIRMWARE_DIR "/asix-sigma-200.fw",
97 /* Synchronous clock from pin */
98 FIRMWARE_DIR "/asix-sigma-50sync.fw",
99 /* Frequency counter */
100 FIRMWARE_DIR "/asix-sigma-phasor.fw",
103 static int sigma_read(void *buf, size_t size, struct dev_context *devc)
107 ret = ftdi_read_data(&devc->ftdic, (unsigned char *)buf, size);
109 sr_err("ftdi_read_data failed: %s",
110 ftdi_get_error_string(&devc->ftdic));
116 static int sigma_write(void *buf, size_t size, struct dev_context *devc)
120 ret = ftdi_write_data(&devc->ftdic, (unsigned char *)buf, size);
122 sr_err("ftdi_write_data failed: %s",
123 ftdi_get_error_string(&devc->ftdic));
124 } else if ((size_t) ret != size) {
125 sr_err("ftdi_write_data did not complete write.");
131 static int sigma_write_register(uint8_t reg, uint8_t *data, size_t len,
132 struct dev_context *devc)
135 uint8_t buf[len + 2];
138 buf[idx++] = REG_ADDR_LOW | (reg & 0xf);
139 buf[idx++] = REG_ADDR_HIGH | (reg >> 4);
141 for (i = 0; i < len; ++i) {
142 buf[idx++] = REG_DATA_LOW | (data[i] & 0xf);
143 buf[idx++] = REG_DATA_HIGH_WRITE | (data[i] >> 4);
146 return sigma_write(buf, idx, devc);
149 static int sigma_set_register(uint8_t reg, uint8_t value, struct dev_context *devc)
151 return sigma_write_register(reg, &value, 1, devc);
154 static int sigma_read_register(uint8_t reg, uint8_t *data, size_t len,
155 struct dev_context *devc)
159 buf[0] = REG_ADDR_LOW | (reg & 0xf);
160 buf[1] = REG_ADDR_HIGH | (reg >> 4);
161 buf[2] = REG_READ_ADDR;
163 sigma_write(buf, sizeof(buf), devc);
165 return sigma_read(data, len, devc);
168 static uint8_t sigma_get_register(uint8_t reg, struct dev_context *devc)
172 if (1 != sigma_read_register(reg, &value, 1, devc)) {
173 sr_err("sigma_get_register: 1 byte expected");
180 static int sigma_read_pos(uint32_t *stoppos, uint32_t *triggerpos,
181 struct dev_context *devc)
184 REG_ADDR_LOW | READ_TRIGGER_POS_LOW,
186 REG_READ_ADDR | NEXT_REG,
187 REG_READ_ADDR | NEXT_REG,
188 REG_READ_ADDR | NEXT_REG,
189 REG_READ_ADDR | NEXT_REG,
190 REG_READ_ADDR | NEXT_REG,
191 REG_READ_ADDR | NEXT_REG,
195 sigma_write(buf, sizeof(buf), devc);
197 sigma_read(result, sizeof(result), devc);
199 *triggerpos = result[0] | (result[1] << 8) | (result[2] << 16);
200 *stoppos = result[3] | (result[4] << 8) | (result[5] << 16);
202 /* Not really sure why this must be done, but according to spec. */
203 if ((--*stoppos & 0x1ff) == 0x1ff)
206 if ((*--triggerpos & 0x1ff) == 0x1ff)
212 static int sigma_read_dram(uint16_t startchunk, size_t numchunks,
213 uint8_t *data, struct dev_context *devc)
219 /* Send the startchunk. Index start with 1. */
220 buf[0] = startchunk >> 8;
221 buf[1] = startchunk & 0xff;
222 sigma_write_register(WRITE_MEMROW, buf, 2, devc);
225 buf[idx++] = REG_DRAM_BLOCK;
226 buf[idx++] = REG_DRAM_WAIT_ACK;
228 for (i = 0; i < numchunks; ++i) {
229 /* Alternate bit to copy from DRAM to cache. */
230 if (i != (numchunks - 1))
231 buf[idx++] = REG_DRAM_BLOCK | (((i + 1) % 2) << 4);
233 buf[idx++] = REG_DRAM_BLOCK_DATA | ((i % 2) << 4);
235 if (i != (numchunks - 1))
236 buf[idx++] = REG_DRAM_WAIT_ACK;
239 sigma_write(buf, idx, devc);
241 return sigma_read(data, numchunks * CHUNK_SIZE, devc);
244 /* Upload trigger look-up tables to Sigma. */
245 static int sigma_write_trigger_lut(struct triggerlut *lut, struct dev_context *devc)
251 /* Transpose the table and send to Sigma. */
252 for (i = 0; i < 16; ++i) {
257 if (lut->m2d[0] & bit)
259 if (lut->m2d[1] & bit)
261 if (lut->m2d[2] & bit)
263 if (lut->m2d[3] & bit)
273 if (lut->m0d[0] & bit)
275 if (lut->m0d[1] & bit)
277 if (lut->m0d[2] & bit)
279 if (lut->m0d[3] & bit)
282 if (lut->m1d[0] & bit)
284 if (lut->m1d[1] & bit)
286 if (lut->m1d[2] & bit)
288 if (lut->m1d[3] & bit)
291 sigma_write_register(WRITE_TRIGGER_SELECT0, tmp, sizeof(tmp),
293 sigma_set_register(WRITE_TRIGGER_SELECT1, 0x30 | i, devc);
296 /* Send the parameters */
297 sigma_write_register(WRITE_TRIGGER_SELECT0, (uint8_t *) &lut->params,
298 sizeof(lut->params), devc);
303 static void clear_helper(void *priv)
305 struct dev_context *devc;
309 ftdi_deinit(&devc->ftdic);
312 static int dev_clear(void)
314 return std_dev_clear(di, clear_helper);
317 static int init(struct sr_context *sr_ctx)
319 return std_init(sr_ctx, di, LOG_PREFIX);
322 static GSList *scan(GSList *options)
324 struct sr_dev_inst *sdi;
325 struct sr_channel *ch;
326 struct drv_context *drvc;
327 struct dev_context *devc;
329 struct ftdi_device_list *devlist;
341 if (!(devc = g_try_malloc(sizeof(struct dev_context)))) {
342 sr_err("%s: devc malloc failed", __func__);
346 ftdi_init(&devc->ftdic);
348 /* Look for SIGMAs. */
350 if ((ret = ftdi_usb_find_all(&devc->ftdic, &devlist,
351 USB_VENDOR, USB_PRODUCT)) <= 0) {
353 sr_err("ftdi_usb_find_all(): %d", ret);
357 /* Make sure it's a version 1 or 2 SIGMA. */
358 ftdi_usb_get_strings(&devc->ftdic, devlist->dev, NULL, 0, NULL, 0,
359 serial_txt, sizeof(serial_txt));
360 sscanf(serial_txt, "%x", &serial);
362 if (serial < 0xa6010000 || serial > 0xa602ffff) {
363 sr_err("Only SIGMA and SIGMA2 are supported "
364 "in this version of libsigrok.");
368 sr_info("Found ASIX SIGMA - Serial: %s", serial_txt);
370 devc->cur_samplerate = samplerates[0];
372 devc->limit_msec = 0;
373 devc->cur_firmware = -1;
374 devc->num_channels = 0;
375 devc->samples_per_event = 0;
376 devc->capture_ratio = 50;
377 devc->use_triggers = 0;
379 /* Register SIGMA device. */
380 if (!(sdi = sr_dev_inst_new(SR_ST_INITIALIZING, USB_VENDOR_NAME,
381 USB_MODEL_NAME, NULL))) {
382 sr_err("%s: sdi was NULL", __func__);
387 for (i = 0; i < ARRAY_SIZE(channel_names); i++) {
388 ch = sr_channel_new(i, SR_CHANNEL_LOGIC, TRUE,
392 sdi->channels = g_slist_append(sdi->channels, ch);
395 devices = g_slist_append(devices, sdi);
396 drvc->instances = g_slist_append(drvc->instances, sdi);
399 /* We will open the device again when we need it. */
400 ftdi_list_free(&devlist);
405 ftdi_deinit(&devc->ftdic);
410 static GSList *dev_list(void)
412 return ((struct drv_context *)(di->priv))->instances;
416 * Configure the FPGA for bitbang mode.
417 * This sequence is documented in section 2. of the ASIX Sigma programming
418 * manual. This sequence is necessary to configure the FPGA in the Sigma
419 * into Bitbang mode, in which it can be programmed with the firmware.
421 static int sigma_fpga_init_bitbang(struct dev_context *devc)
423 uint8_t suicide[] = {
424 0x84, 0x84, 0x88, 0x84, 0x88, 0x84, 0x88, 0x84,
426 uint8_t init_array[] = {
427 0x01, 0x03, 0x03, 0x01, 0x01, 0x01, 0x01, 0x01,
430 int i, ret, timeout = 10000;
433 /* Section 2. part 1), do the FPGA suicide. */
434 sigma_write(suicide, sizeof(suicide), devc);
435 sigma_write(suicide, sizeof(suicide), devc);
436 sigma_write(suicide, sizeof(suicide), devc);
437 sigma_write(suicide, sizeof(suicide), devc);
439 /* Section 2. part 2), do pulse on D1. */
440 sigma_write(init_array, sizeof(init_array), devc);
441 ftdi_usb_purge_buffers(&devc->ftdic);
443 /* Wait until the FPGA asserts D6/INIT_B. */
444 for (i = 0; i < timeout; i++) {
445 ret = sigma_read(&data, 1, devc);
448 /* Test if pin D6 got asserted. */
451 /* The D6 was not asserted yet, wait a bit. */
455 return SR_ERR_TIMEOUT;
459 * Configure the FPGA for logic-analyzer mode.
461 static int sigma_fpga_init_la(struct dev_context *devc)
463 /* Initialize the logic analyzer mode. */
464 uint8_t logic_mode_start[] = {
465 REG_ADDR_LOW | (READ_ID & 0xf),
466 REG_ADDR_HIGH | (READ_ID >> 8),
467 REG_READ_ADDR, /* Read ID register. */
469 REG_ADDR_LOW | (WRITE_TEST & 0xf),
471 REG_DATA_HIGH_WRITE | 0x5,
472 REG_READ_ADDR, /* Read scratch register. */
475 REG_DATA_HIGH_WRITE | 0xa,
476 REG_READ_ADDR, /* Read scratch register. */
478 REG_ADDR_LOW | (WRITE_MODE & 0xf),
480 REG_DATA_HIGH_WRITE | 0x8,
486 /* Initialize the logic analyzer mode. */
487 sigma_write(logic_mode_start, sizeof(logic_mode_start), devc);
489 /* Expect a 3 byte reply since we issued three READ requests. */
490 ret = sigma_read(result, 3, devc);
494 if (result[0] != 0xa6 || result[1] != 0x55 || result[2] != 0xaa)
499 sr_err("Configuration failed. Invalid reply received.");
504 * Read the firmware from a file and transform it into a series of bitbang
505 * pulses used to program the FPGA. Note that the *bb_cmd must be free()'d
506 * by the caller of this function.
508 static int sigma_fw_2_bitbang(const char *filename,
509 uint8_t **bb_cmd, gsize *bb_cmd_size)
513 gsize i, file_size, bb_size;
515 uint8_t *bb_stream, *bbs;
521 * Map the file and make the mapped buffer writable.
522 * NOTE: Using writable=TRUE does _NOT_ mean that file that is mapped
523 * will be modified. It will not be modified until someone uses
524 * g_file_set_contents() on it.
527 file = g_mapped_file_new(filename, TRUE, &error);
528 g_assert_no_error(error);
530 file_size = g_mapped_file_get_length(file);
531 firmware = g_mapped_file_get_contents(file);
534 /* Weird magic transformation below, I have no idea what it does. */
536 for (i = 0; i < file_size; i++) {
537 imm = (imm + 0xa853753) % 177 + (imm * 0x8034052);
538 firmware[i] ^= imm & 0xff;
542 * Now that the firmware is "transformed", we will transcribe the
543 * firmware blob into a sequence of toggles of the Dx wires. This
544 * sequence will be fed directly into the Sigma, which must be in
545 * the FPGA bitbang programming mode.
548 /* Each bit of firmware is transcribed as two toggles of Dx wires. */
549 bb_size = file_size * 8 * 2;
550 bb_stream = (uint8_t *)g_try_malloc(bb_size);
552 sr_err("%s: Failed to allocate bitbang stream", __func__);
558 for (i = 0; i < file_size; i++) {
559 for (bit = 7; bit >= 0; bit--) {
560 v = (firmware[i] & (1 << bit)) ? 0x40 : 0x00;
566 /* The transformation completed successfully, return the result. */
568 *bb_cmd_size = bb_size;
571 g_mapped_file_unref(file);
575 static int upload_firmware(int firmware_idx, struct dev_context *devc)
581 const char *firmware = sigma_firmware_files[firmware_idx];
582 struct ftdi_context *ftdic = &devc->ftdic;
584 /* Make sure it's an ASIX SIGMA. */
585 ret = ftdi_usb_open_desc(ftdic, USB_VENDOR, USB_PRODUCT,
586 USB_DESCRIPTION, NULL);
588 sr_err("ftdi_usb_open failed: %s",
589 ftdi_get_error_string(ftdic));
593 ret = ftdi_set_bitmode(ftdic, 0xdf, BITMODE_BITBANG);
595 sr_err("ftdi_set_bitmode failed: %s",
596 ftdi_get_error_string(ftdic));
600 /* Four times the speed of sigmalogan - Works well. */
601 ret = ftdi_set_baudrate(ftdic, 750000);
603 sr_err("ftdi_set_baudrate failed: %s",
604 ftdi_get_error_string(ftdic));
608 /* Initialize the FPGA for firmware upload. */
609 ret = sigma_fpga_init_bitbang(devc);
613 /* Prepare firmware. */
614 ret = sigma_fw_2_bitbang(firmware, &buf, &buf_size);
616 sr_err("An error occured while reading the firmware: %s",
621 /* Upload firmare. */
622 sr_info("Uploading firmware file '%s'.", firmware);
623 sigma_write(buf, buf_size, devc);
627 ret = ftdi_set_bitmode(ftdic, 0x00, BITMODE_RESET);
629 sr_err("ftdi_set_bitmode failed: %s",
630 ftdi_get_error_string(ftdic));
634 ftdi_usb_purge_buffers(ftdic);
636 /* Discard garbage. */
637 while (sigma_read(&pins, 1, devc) == 1)
640 /* Initialize the FPGA for logic-analyzer mode. */
641 ret = sigma_fpga_init_la(devc);
645 devc->cur_firmware = firmware_idx;
647 sr_info("Firmware uploaded.");
652 static int dev_open(struct sr_dev_inst *sdi)
654 struct dev_context *devc;
659 /* Make sure it's an ASIX SIGMA. */
660 if ((ret = ftdi_usb_open_desc(&devc->ftdic,
661 USB_VENDOR, USB_PRODUCT, USB_DESCRIPTION, NULL)) < 0) {
663 sr_err("ftdi_usb_open failed: %s",
664 ftdi_get_error_string(&devc->ftdic));
669 sdi->status = SR_ST_ACTIVE;
674 static int set_samplerate(const struct sr_dev_inst *sdi, uint64_t samplerate)
676 struct dev_context *devc;
683 for (i = 0; i < ARRAY_SIZE(samplerates); i++) {
684 if (samplerates[i] == samplerate)
687 if (samplerates[i] == 0)
688 return SR_ERR_SAMPLERATE;
690 if (samplerate <= SR_MHZ(50)) {
691 ret = upload_firmware(0, devc);
692 devc->num_channels = 16;
693 } else if (samplerate == SR_MHZ(100)) {
694 ret = upload_firmware(1, devc);
695 devc->num_channels = 8;
696 } else if (samplerate == SR_MHZ(200)) {
697 ret = upload_firmware(2, devc);
698 devc->num_channels = 4;
702 devc->cur_samplerate = samplerate;
703 devc->period_ps = 1000000000000ULL / samplerate;
704 devc->samples_per_event = 16 / devc->num_channels;
705 devc->state.state = SIGMA_IDLE;
712 * In 100 and 200 MHz mode, only a single pin rising/falling can be
713 * set as trigger. In other modes, two rising/falling triggers can be set,
714 * in addition to value/mask trigger for any number of channels.
716 * The Sigma supports complex triggers using boolean expressions, but this
717 * has not been implemented yet.
719 static int convert_trigger(const struct sr_dev_inst *sdi)
721 struct dev_context *devc;
722 struct sr_trigger *trigger;
723 struct sr_trigger_stage *stage;
724 struct sr_trigger_match *match;
726 int channelbit, trigger_set;
729 memset(&devc->trigger, 0, sizeof(struct sigma_trigger));
730 if (!(trigger = sr_session_trigger_get(sdi->session)))
734 for (l = trigger->stages; l; l = l->next) {
736 for (m = stage->matches; m; m = m->next) {
738 if (!match->channel->enabled)
739 /* Ignore disabled channels with a trigger. */
741 channelbit = 1 << (match->channel->index);
742 if (devc->cur_samplerate >= SR_MHZ(100)) {
743 /* Fast trigger support. */
745 sr_err("Only a single pin trigger is "
746 "supported in 100 and 200MHz mode.");
749 if (match->match == SR_TRIGGER_FALLING)
750 devc->trigger.fallingmask |= channelbit;
751 else if (match->match == SR_TRIGGER_RISING)
752 devc->trigger.risingmask |= channelbit;
754 sr_err("Only rising/falling trigger is "
755 "supported in 100 and 200MHz mode.");
761 /* Simple trigger support (event). */
762 if (match->match == SR_TRIGGER_ONE) {
763 devc->trigger.simplevalue |= channelbit;
764 devc->trigger.simplemask |= channelbit;
766 else if (match->match == SR_TRIGGER_ZERO) {
767 devc->trigger.simplevalue &= ~channelbit;
768 devc->trigger.simplemask |= channelbit;
770 else if (match->match == SR_TRIGGER_FALLING) {
771 devc->trigger.fallingmask |= channelbit;
774 else if (match->match == SR_TRIGGER_RISING) {
775 devc->trigger.risingmask |= channelbit;
780 * Actually, Sigma supports 2 rising/falling triggers,
781 * but they are ORed and the current trigger syntax
782 * does not permit ORed triggers.
784 if (trigger_set > 1) {
785 sr_err("Only 1 rising/falling trigger "
797 static int dev_close(struct sr_dev_inst *sdi)
799 struct dev_context *devc;
804 if (sdi->status == SR_ST_ACTIVE)
805 ftdi_usb_close(&devc->ftdic);
807 sdi->status = SR_ST_INACTIVE;
812 static int cleanup(void)
817 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
818 const struct sr_channel_group *cg)
820 struct dev_context *devc;
829 case SR_CONF_SAMPLERATE:
830 *data = g_variant_new_uint64(devc->cur_samplerate);
832 case SR_CONF_LIMIT_MSEC:
833 *data = g_variant_new_uint64(devc->limit_msec);
835 case SR_CONF_CAPTURE_RATIO:
836 *data = g_variant_new_uint64(devc->capture_ratio);
845 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
846 const struct sr_channel_group *cg)
848 struct dev_context *devc;
854 if (sdi->status != SR_ST_ACTIVE)
855 return SR_ERR_DEV_CLOSED;
861 case SR_CONF_SAMPLERATE:
862 ret = set_samplerate(sdi, g_variant_get_uint64(data));
864 case SR_CONF_LIMIT_MSEC:
865 tmp = g_variant_get_uint64(data);
867 devc->limit_msec = g_variant_get_uint64(data);
871 case SR_CONF_LIMIT_SAMPLES:
872 tmp = g_variant_get_uint64(data);
873 devc->limit_msec = tmp * 1000 / devc->cur_samplerate;
875 case SR_CONF_CAPTURE_RATIO:
876 tmp = g_variant_get_uint64(data);
878 devc->capture_ratio = tmp;
889 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
890 const struct sr_channel_group *cg)
899 case SR_CONF_DEVICE_OPTIONS:
900 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
901 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
903 case SR_CONF_SAMPLERATE:
904 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
905 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
906 ARRAY_SIZE(samplerates), sizeof(uint64_t));
907 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
908 *data = g_variant_builder_end(&gvb);
910 case SR_CONF_TRIGGER_MATCH:
911 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
912 trigger_matches, ARRAY_SIZE(trigger_matches),
922 /* Software trigger to determine exact trigger position. */
923 static int get_trigger_offset(uint8_t *samples, uint16_t last_sample,
924 struct sigma_trigger *t)
929 for (i = 0; i < 8; ++i) {
931 last_sample = sample;
932 sample = samples[2 * i] | (samples[2 * i + 1] << 8);
934 /* Simple triggers. */
935 if ((sample & t->simplemask) != t->simplevalue)
939 if (((last_sample & t->risingmask) != 0) ||
940 ((sample & t->risingmask) != t->risingmask))
944 if ((last_sample & t->fallingmask) != t->fallingmask ||
945 (sample & t->fallingmask) != 0)
951 /* If we did not match, return original trigger pos. */
957 * Return the timestamp of "DRAM cluster".
959 static uint16_t sigma_dram_cluster_ts(struct sigma_dram_cluster *cluster)
961 return (cluster->timestamp_hi << 8) | cluster->timestamp_lo;
964 static void sigma_decode_dram_cluster(struct sigma_dram_cluster *dram_cluster,
965 unsigned int events_in_cluster,
966 unsigned int triggered,
967 struct sr_dev_inst *sdi)
969 struct dev_context *devc = sdi->priv;
970 struct sigma_state *ss = &devc->state;
971 struct sr_datafeed_packet packet;
972 struct sr_datafeed_logic logic;
974 uint8_t samples[2048];
977 ts = sigma_dram_cluster_ts(dram_cluster);
978 tsdiff = ts - ss->lastts;
981 packet.type = SR_DF_LOGIC;
982 packet.payload = &logic;
984 logic.data = samples;
987 * First of all, send Sigrok a copy of the last sample from
988 * previous cluster as many times as needed to make up for
989 * the differential characteristics of data we get from the
990 * Sigma. Sigrok needs one sample of data per period.
992 * One DRAM cluster contains a timestamp and seven samples,
993 * the units of timestamp are "devc->period_ps" , the first
994 * sample in the cluster happens at the time of the timestamp
995 * and the remaining samples happen at timestamp +1...+6 .
997 for (ts = 0; ts < tsdiff - (EVENTS_PER_CLUSTER - 1); ts++) {
999 samples[2 * i + 0] = ss->lastsample & 0xff;
1000 samples[2 * i + 1] = ss->lastsample >> 8;
1003 * If we have 1024 samples ready or we're at the
1004 * end of submitting the padding samples, submit
1005 * the packet to Sigrok.
1007 if ((i == 1023) || (ts == (tsdiff - EVENTS_PER_CLUSTER))) {
1008 logic.length = (i + 1) * logic.unitsize;
1009 sr_session_send(sdi, &packet);
1014 * Parse the samples in current cluster and prepare them
1015 * to be submitted to Sigrok.
1017 for (i = 0; i < events_in_cluster; i++) {
1018 samples[2 * i + 1] = dram_cluster->samples[i].sample_lo;
1019 samples[2 * i + 0] = dram_cluster->samples[i].sample_hi;
1022 /* Send data up to trigger point (if triggered). */
1023 int trigger_offset = 0;
1026 * Trigger is not always accurate to sample because of
1027 * pipeline delay. However, it always triggers before
1028 * the actual event. We therefore look at the next
1029 * samples to pinpoint the exact position of the trigger.
1031 trigger_offset = get_trigger_offset(samples,
1032 ss->lastsample, &devc->trigger);
1034 if (trigger_offset > 0) {
1035 packet.type = SR_DF_LOGIC;
1036 logic.length = trigger_offset * logic.unitsize;
1037 sr_session_send(sdi, &packet);
1038 events_in_cluster -= trigger_offset;
1041 /* Only send trigger if explicitly enabled. */
1042 if (devc->use_triggers) {
1043 packet.type = SR_DF_TRIGGER;
1044 sr_session_send(sdi, &packet);
1048 if (events_in_cluster > 0) {
1049 packet.type = SR_DF_LOGIC;
1050 logic.length = events_in_cluster * logic.unitsize;
1051 logic.data = samples + (trigger_offset * logic.unitsize);
1052 sr_session_send(sdi, &packet);
1056 samples[2 * (events_in_cluster - 1) + 0] |
1057 (samples[2 * (events_in_cluster - 1) + 1] << 8);
1062 * Decode chunk of 1024 bytes, 64 clusters, 7 events per cluster.
1063 * Each event is 20ns apart, and can contain multiple samples.
1065 * For 200 MHz, events contain 4 samples for each channel, spread 5 ns apart.
1066 * For 100 MHz, events contain 2 samples for each channel, spread 10 ns apart.
1067 * For 50 MHz and below, events contain one sample for each channel,
1068 * spread 20 ns apart.
1070 static int decode_chunk_ts(struct sigma_dram_line *dram_line,
1071 uint16_t events_in_line,
1072 uint32_t trigger_event,
1073 struct sr_dev_inst *sdi)
1075 struct sigma_dram_cluster *dram_cluster;
1076 struct dev_context *devc = sdi->priv;
1077 unsigned int clusters_in_line =
1078 (events_in_line + (EVENTS_PER_CLUSTER - 1)) / EVENTS_PER_CLUSTER;
1079 unsigned int events_in_cluster;
1081 uint32_t trigger_cluster = ~0, triggered = 0;
1083 /* Check if trigger is in this chunk. */
1084 if (trigger_event < (64 * 7)) {
1085 if (devc->cur_samplerate <= SR_MHZ(50)) {
1086 trigger_event -= MIN(EVENTS_PER_CLUSTER - 1,
1090 /* Find in which cluster the trigger occured. */
1091 trigger_cluster = trigger_event / EVENTS_PER_CLUSTER;
1094 /* For each full DRAM cluster. */
1095 for (i = 0; i < clusters_in_line; i++) {
1096 dram_cluster = &dram_line->cluster[i];
1098 /* The last cluster might not be full. */
1099 if ((i == clusters_in_line - 1) &&
1100 (events_in_line % EVENTS_PER_CLUSTER)) {
1101 events_in_cluster = events_in_line % EVENTS_PER_CLUSTER;
1103 events_in_cluster = EVENTS_PER_CLUSTER;
1106 triggered = (i == trigger_cluster);
1107 sigma_decode_dram_cluster(dram_cluster, events_in_cluster,
1114 static int download_capture(struct sr_dev_inst *sdi)
1116 struct dev_context *devc = sdi->priv;
1117 const uint32_t chunks_per_read = 32;
1118 struct sigma_dram_line *dram_line;
1120 uint32_t stoppos, triggerpos;
1121 struct sr_datafeed_packet packet;
1125 uint32_t dl_lines_total, dl_lines_curr, dl_lines_done;
1126 uint32_t dl_events_in_line = 64 * 7;
1127 uint32_t trg_line = ~0, trg_event = ~0;
1129 dram_line = g_try_malloc0(chunks_per_read * sizeof(*dram_line));
1133 sr_info("Downloading sample data.");
1135 /* Stop acquisition. */
1136 sigma_set_register(WRITE_MODE, 0x11, devc);
1138 /* Set SDRAM Read Enable. */
1139 sigma_set_register(WRITE_MODE, 0x02, devc);
1141 /* Get the current position. */
1142 sigma_read_pos(&stoppos, &triggerpos, devc);
1144 /* Check if trigger has fired. */
1145 modestatus = sigma_get_register(READ_MODE, devc);
1146 if (modestatus & 0x20) {
1147 trg_line = triggerpos >> 9;
1148 trg_event = triggerpos & 0x1ff;
1152 * Determine how many 1024b "DRAM lines" do we need to read from the
1153 * Sigma so we have a complete set of samples. Note that the last
1154 * line can be only partial, containing less than 64 clusters.
1156 dl_lines_total = (stoppos >> 9) + 1;
1160 while (dl_lines_total > dl_lines_done) {
1161 /* We can download only up-to 32 DRAM lines in one go! */
1162 dl_lines_curr = MIN(chunks_per_read, dl_lines_total);
1164 bufsz = sigma_read_dram(dl_lines_done, dl_lines_curr,
1165 (uint8_t *)dram_line, devc);
1166 /* TODO: Check bufsz. For now, just avoid compiler warnings. */
1169 /* This is the first DRAM line, so find the initial timestamp. */
1170 if (dl_lines_done == 0) {
1171 devc->state.lastts =
1172 sigma_dram_cluster_ts(&dram_line[0].cluster[0]);
1173 devc->state.lastsample = 0;
1176 for (i = 0; i < dl_lines_curr; i++) {
1177 uint32_t trigger_event = ~0;
1178 /* The last "DRAM line" can be only partially full. */
1179 if (dl_lines_done + i == dl_lines_total - 1)
1180 dl_events_in_line = stoppos & 0x1ff;
1182 /* Test if the trigger happened on this line. */
1183 if (dl_lines_done + i == trg_line)
1184 trigger_event = trg_event;
1186 decode_chunk_ts(dram_line + i, dl_events_in_line,
1187 trigger_event, sdi);
1190 dl_lines_done += dl_lines_curr;
1194 packet.type = SR_DF_END;
1195 sr_session_send(sdi, &packet);
1197 dev_acquisition_stop(sdi, sdi);
1205 * Handle the Sigma when in CAPTURE mode. This function checks:
1206 * - Sampling time ended
1207 * - DRAM capacity overflow
1208 * This function triggers download of the samples from Sigma
1209 * in case either of the above conditions is true.
1211 static int sigma_capture_mode(struct sr_dev_inst *sdi)
1213 struct dev_context *devc = sdi->priv;
1215 uint64_t running_msec;
1218 uint32_t stoppos, triggerpos;
1220 /* Check if the selected sampling duration passed. */
1221 gettimeofday(&tv, 0);
1222 running_msec = (tv.tv_sec - devc->start_tv.tv_sec) * 1000 +
1223 (tv.tv_usec - devc->start_tv.tv_usec) / 1000;
1224 if (running_msec >= devc->limit_msec)
1225 return download_capture(sdi);
1227 /* Get the position in DRAM to which the FPGA is writing now. */
1228 sigma_read_pos(&stoppos, &triggerpos, devc);
1229 /* Test if DRAM is full and if so, download the data. */
1230 if ((stoppos >> 9) == 32767)
1231 return download_capture(sdi);
1236 static int receive_data(int fd, int revents, void *cb_data)
1238 struct sr_dev_inst *sdi;
1239 struct dev_context *devc;
1247 if (devc->state.state == SIGMA_IDLE)
1250 if (devc->state.state == SIGMA_CAPTURE)
1251 return sigma_capture_mode(sdi);
1256 /* Build a LUT entry used by the trigger functions. */
1257 static void build_lut_entry(uint16_t value, uint16_t mask, uint16_t *entry)
1261 /* For each quad channel. */
1262 for (i = 0; i < 4; ++i) {
1265 /* For each bit in LUT. */
1266 for (j = 0; j < 16; ++j)
1268 /* For each channel in quad. */
1269 for (k = 0; k < 4; ++k) {
1270 bit = 1 << (i * 4 + k);
1272 /* Set bit in entry */
1274 ((!(value & bit)) !=
1276 entry[i] &= ~(1 << j);
1281 /* Add a logical function to LUT mask. */
1282 static void add_trigger_function(enum triggerop oper, enum triggerfunc func,
1283 int index, int neg, uint16_t *mask)
1286 int x[2][2], tmp, a, b, aset, bset, rset;
1288 memset(x, 0, 4 * sizeof(int));
1290 /* Trigger detect condition. */
1320 case OP_NOTRISEFALL:
1326 /* Transpose if neg is set. */
1328 for (i = 0; i < 2; ++i) {
1329 for (j = 0; j < 2; ++j) {
1331 x[i][j] = x[1-i][1-j];
1337 /* Update mask with function. */
1338 for (i = 0; i < 16; ++i) {
1339 a = (i >> (2 * index + 0)) & 1;
1340 b = (i >> (2 * index + 1)) & 1;
1342 aset = (*mask >> i) & 1;
1346 if (func == FUNC_AND || func == FUNC_NAND)
1348 else if (func == FUNC_OR || func == FUNC_NOR)
1350 else if (func == FUNC_XOR || func == FUNC_NXOR)
1353 if (func == FUNC_NAND || func == FUNC_NOR || func == FUNC_NXOR)
1364 * Build trigger LUTs used by 50 MHz and lower sample rates for supporting
1365 * simple pin change and state triggers. Only two transitions (rise/fall) can be
1366 * set at any time, but a full mask and value can be set (0/1).
1368 static int build_basic_trigger(struct triggerlut *lut, struct dev_context *devc)
1371 uint16_t masks[2] = { 0, 0 };
1373 memset(lut, 0, sizeof(struct triggerlut));
1375 /* Contant for simple triggers. */
1378 /* Value/mask trigger support. */
1379 build_lut_entry(devc->trigger.simplevalue, devc->trigger.simplemask,
1382 /* Rise/fall trigger support. */
1383 for (i = 0, j = 0; i < 16; ++i) {
1384 if (devc->trigger.risingmask & (1 << i) ||
1385 devc->trigger.fallingmask & (1 << i))
1386 masks[j++] = 1 << i;
1389 build_lut_entry(masks[0], masks[0], lut->m0d);
1390 build_lut_entry(masks[1], masks[1], lut->m1d);
1392 /* Add glue logic */
1393 if (masks[0] || masks[1]) {
1394 /* Transition trigger. */
1395 if (masks[0] & devc->trigger.risingmask)
1396 add_trigger_function(OP_RISE, FUNC_OR, 0, 0, &lut->m3);
1397 if (masks[0] & devc->trigger.fallingmask)
1398 add_trigger_function(OP_FALL, FUNC_OR, 0, 0, &lut->m3);
1399 if (masks[1] & devc->trigger.risingmask)
1400 add_trigger_function(OP_RISE, FUNC_OR, 1, 0, &lut->m3);
1401 if (masks[1] & devc->trigger.fallingmask)
1402 add_trigger_function(OP_FALL, FUNC_OR, 1, 0, &lut->m3);
1404 /* Only value/mask trigger. */
1408 /* Triggertype: event. */
1409 lut->params.selres = 3;
1414 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
1416 struct dev_context *devc;
1417 struct clockselect_50 clockselect;
1418 int frac, triggerpin, ret;
1419 uint8_t triggerselect = 0;
1420 struct triggerinout triggerinout_conf;
1421 struct triggerlut lut;
1423 if (sdi->status != SR_ST_ACTIVE)
1424 return SR_ERR_DEV_CLOSED;
1428 if (convert_trigger(sdi) != SR_OK) {
1429 sr_err("Failed to configure triggers.");
1433 /* If the samplerate has not been set, default to 200 kHz. */
1434 if (devc->cur_firmware == -1) {
1435 if ((ret = set_samplerate(sdi, SR_KHZ(200))) != SR_OK)
1439 /* Enter trigger programming mode. */
1440 sigma_set_register(WRITE_TRIGGER_SELECT1, 0x20, devc);
1442 /* 100 and 200 MHz mode. */
1443 if (devc->cur_samplerate >= SR_MHZ(100)) {
1444 sigma_set_register(WRITE_TRIGGER_SELECT1, 0x81, devc);
1446 /* Find which pin to trigger on from mask. */
1447 for (triggerpin = 0; triggerpin < 8; ++triggerpin)
1448 if ((devc->trigger.risingmask | devc->trigger.fallingmask) &
1452 /* Set trigger pin and light LED on trigger. */
1453 triggerselect = (1 << LEDSEL1) | (triggerpin & 0x7);
1455 /* Default rising edge. */
1456 if (devc->trigger.fallingmask)
1457 triggerselect |= 1 << 3;
1459 /* All other modes. */
1460 } else if (devc->cur_samplerate <= SR_MHZ(50)) {
1461 build_basic_trigger(&lut, devc);
1463 sigma_write_trigger_lut(&lut, devc);
1465 triggerselect = (1 << LEDSEL1) | (1 << LEDSEL0);
1468 /* Setup trigger in and out pins to default values. */
1469 memset(&triggerinout_conf, 0, sizeof(struct triggerinout));
1470 triggerinout_conf.trgout_bytrigger = 1;
1471 triggerinout_conf.trgout_enable = 1;
1473 sigma_write_register(WRITE_TRIGGER_OPTION,
1474 (uint8_t *) &triggerinout_conf,
1475 sizeof(struct triggerinout), devc);
1477 /* Go back to normal mode. */
1478 sigma_set_register(WRITE_TRIGGER_SELECT1, triggerselect, devc);
1480 /* Set clock select register. */
1481 if (devc->cur_samplerate == SR_MHZ(200))
1482 /* Enable 4 channels. */
1483 sigma_set_register(WRITE_CLOCK_SELECT, 0xf0, devc);
1484 else if (devc->cur_samplerate == SR_MHZ(100))
1485 /* Enable 8 channels. */
1486 sigma_set_register(WRITE_CLOCK_SELECT, 0x00, devc);
1489 * 50 MHz mode (or fraction thereof). Any fraction down to
1490 * 50 MHz / 256 can be used, but is not supported by sigrok API.
1492 frac = SR_MHZ(50) / devc->cur_samplerate - 1;
1494 clockselect.async = 0;
1495 clockselect.fraction = frac;
1496 clockselect.disabled_channels = 0;
1498 sigma_write_register(WRITE_CLOCK_SELECT,
1499 (uint8_t *) &clockselect,
1500 sizeof(clockselect), devc);
1503 /* Setup maximum post trigger time. */
1504 sigma_set_register(WRITE_POST_TRIGGER,
1505 (devc->capture_ratio * 255) / 100, devc);
1507 /* Start acqusition. */
1508 gettimeofday(&devc->start_tv, 0);
1509 sigma_set_register(WRITE_MODE, 0x0d, devc);
1511 devc->cb_data = cb_data;
1513 /* Send header packet to the session bus. */
1514 std_session_send_df_header(sdi, LOG_PREFIX);
1516 /* Add capture source. */
1517 sr_session_source_add(sdi->session, 0, G_IO_IN, 10, receive_data, (void *)sdi);
1519 devc->state.state = SIGMA_CAPTURE;
1524 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
1526 struct dev_context *devc;
1531 devc->state.state = SIGMA_IDLE;
1533 sr_session_source_remove(sdi->session, 0);
1538 SR_PRIV struct sr_dev_driver asix_sigma_driver_info = {
1539 .name = "asix-sigma",
1540 .longname = "ASIX SIGMA/SIGMA2",
1545 .dev_list = dev_list,
1546 .dev_clear = dev_clear,
1547 .config_get = config_get,
1548 .config_set = config_set,
1549 .config_list = config_list,
1550 .dev_open = dev_open,
1551 .dev_close = dev_close,
1552 .dev_acquisition_start = dev_acquisition_start,
1553 .dev_acquisition_stop = dev_acquisition_stop,