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>
30 #include "libsigrok.h"
31 #include "libsigrok-internal.h"
32 #include "asix-sigma.h"
34 #define USB_VENDOR 0xa600
35 #define USB_PRODUCT 0xa000
36 #define USB_DESCRIPTION "ASIX SIGMA"
37 #define USB_VENDOR_NAME "ASIX"
38 #define USB_MODEL_NAME "SIGMA"
39 #define TRIGGER_TYPE "rf10"
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 int32_t hwcaps[] = {
75 SR_CONF_LOGIC_ANALYZER,
78 SR_CONF_CAPTURE_RATIO,
82 static const char *sigma_firmware_files[] = {
83 /* 50 MHz, supports 8 bit fractions */
84 FIRMWARE_DIR "/asix-sigma-50.fw",
86 FIRMWARE_DIR "/asix-sigma-100.fw",
88 FIRMWARE_DIR "/asix-sigma-200.fw",
89 /* Synchronous clock from pin */
90 FIRMWARE_DIR "/asix-sigma-50sync.fw",
91 /* Frequency counter */
92 FIRMWARE_DIR "/asix-sigma-phasor.fw",
95 static int sigma_read(void *buf, size_t size, struct dev_context *devc)
99 ret = ftdi_read_data(&devc->ftdic, (unsigned char *)buf, size);
101 sr_err("ftdi_read_data failed: %s",
102 ftdi_get_error_string(&devc->ftdic));
108 static int sigma_write(void *buf, size_t size, struct dev_context *devc)
112 ret = ftdi_write_data(&devc->ftdic, (unsigned char *)buf, size);
114 sr_err("ftdi_write_data failed: %s",
115 ftdi_get_error_string(&devc->ftdic));
116 } else if ((size_t) ret != size) {
117 sr_err("ftdi_write_data did not complete write.");
123 static int sigma_write_register(uint8_t reg, uint8_t *data, size_t len,
124 struct dev_context *devc)
127 uint8_t buf[len + 2];
130 buf[idx++] = REG_ADDR_LOW | (reg & 0xf);
131 buf[idx++] = REG_ADDR_HIGH | (reg >> 4);
133 for (i = 0; i < len; ++i) {
134 buf[idx++] = REG_DATA_LOW | (data[i] & 0xf);
135 buf[idx++] = REG_DATA_HIGH_WRITE | (data[i] >> 4);
138 return sigma_write(buf, idx, devc);
141 static int sigma_set_register(uint8_t reg, uint8_t value, struct dev_context *devc)
143 return sigma_write_register(reg, &value, 1, devc);
146 static int sigma_read_register(uint8_t reg, uint8_t *data, size_t len,
147 struct dev_context *devc)
151 buf[0] = REG_ADDR_LOW | (reg & 0xf);
152 buf[1] = REG_ADDR_HIGH | (reg >> 4);
153 buf[2] = REG_READ_ADDR;
155 sigma_write(buf, sizeof(buf), devc);
157 return sigma_read(data, len, devc);
160 static uint8_t sigma_get_register(uint8_t reg, struct dev_context *devc)
164 if (1 != sigma_read_register(reg, &value, 1, devc)) {
165 sr_err("sigma_get_register: 1 byte expected");
172 static int sigma_read_pos(uint32_t *stoppos, uint32_t *triggerpos,
173 struct dev_context *devc)
176 REG_ADDR_LOW | READ_TRIGGER_POS_LOW,
178 REG_READ_ADDR | NEXT_REG,
179 REG_READ_ADDR | NEXT_REG,
180 REG_READ_ADDR | NEXT_REG,
181 REG_READ_ADDR | NEXT_REG,
182 REG_READ_ADDR | NEXT_REG,
183 REG_READ_ADDR | NEXT_REG,
187 sigma_write(buf, sizeof(buf), devc);
189 sigma_read(result, sizeof(result), devc);
191 *triggerpos = result[0] | (result[1] << 8) | (result[2] << 16);
192 *stoppos = result[3] | (result[4] << 8) | (result[5] << 16);
194 /* Not really sure why this must be done, but according to spec. */
195 if ((--*stoppos & 0x1ff) == 0x1ff)
198 if ((*--triggerpos & 0x1ff) == 0x1ff)
204 static int sigma_read_dram(uint16_t startchunk, size_t numchunks,
205 uint8_t *data, struct dev_context *devc)
211 /* Send the startchunk. Index start with 1. */
212 buf[0] = startchunk >> 8;
213 buf[1] = startchunk & 0xff;
214 sigma_write_register(WRITE_MEMROW, buf, 2, devc);
217 buf[idx++] = REG_DRAM_BLOCK;
218 buf[idx++] = REG_DRAM_WAIT_ACK;
220 for (i = 0; i < numchunks; ++i) {
221 /* Alternate bit to copy from DRAM to cache. */
222 if (i != (numchunks - 1))
223 buf[idx++] = REG_DRAM_BLOCK | (((i + 1) % 2) << 4);
225 buf[idx++] = REG_DRAM_BLOCK_DATA | ((i % 2) << 4);
227 if (i != (numchunks - 1))
228 buf[idx++] = REG_DRAM_WAIT_ACK;
231 sigma_write(buf, idx, devc);
233 return sigma_read(data, numchunks * CHUNK_SIZE, devc);
236 /* Upload trigger look-up tables to Sigma. */
237 static int sigma_write_trigger_lut(struct triggerlut *lut, struct dev_context *devc)
243 /* Transpose the table and send to Sigma. */
244 for (i = 0; i < 16; ++i) {
249 if (lut->m2d[0] & bit)
251 if (lut->m2d[1] & bit)
253 if (lut->m2d[2] & bit)
255 if (lut->m2d[3] & bit)
265 if (lut->m0d[0] & bit)
267 if (lut->m0d[1] & bit)
269 if (lut->m0d[2] & bit)
271 if (lut->m0d[3] & bit)
274 if (lut->m1d[0] & bit)
276 if (lut->m1d[1] & bit)
278 if (lut->m1d[2] & bit)
280 if (lut->m1d[3] & bit)
283 sigma_write_register(WRITE_TRIGGER_SELECT0, tmp, sizeof(tmp),
285 sigma_set_register(WRITE_TRIGGER_SELECT1, 0x30 | i, devc);
288 /* Send the parameters */
289 sigma_write_register(WRITE_TRIGGER_SELECT0, (uint8_t *) &lut->params,
290 sizeof(lut->params), devc);
295 static void clear_helper(void *priv)
297 struct dev_context *devc;
301 ftdi_deinit(&devc->ftdic);
304 static int dev_clear(void)
306 return std_dev_clear(di, clear_helper);
309 static int init(struct sr_context *sr_ctx)
311 return std_init(sr_ctx, di, LOG_PREFIX);
314 static GSList *scan(GSList *options)
316 struct sr_dev_inst *sdi;
317 struct sr_channel *ch;
318 struct drv_context *drvc;
319 struct dev_context *devc;
321 struct ftdi_device_list *devlist;
333 if (!(devc = g_try_malloc(sizeof(struct dev_context)))) {
334 sr_err("%s: devc malloc failed", __func__);
338 ftdi_init(&devc->ftdic);
340 /* Look for SIGMAs. */
342 if ((ret = ftdi_usb_find_all(&devc->ftdic, &devlist,
343 USB_VENDOR, USB_PRODUCT)) <= 0) {
345 sr_err("ftdi_usb_find_all(): %d", ret);
349 /* Make sure it's a version 1 or 2 SIGMA. */
350 ftdi_usb_get_strings(&devc->ftdic, devlist->dev, NULL, 0, NULL, 0,
351 serial_txt, sizeof(serial_txt));
352 sscanf(serial_txt, "%x", &serial);
354 if (serial < 0xa6010000 || serial > 0xa602ffff) {
355 sr_err("Only SIGMA and SIGMA2 are supported "
356 "in this version of libsigrok.");
360 sr_info("Found ASIX SIGMA - Serial: %s", serial_txt);
362 devc->cur_samplerate = samplerates[0];
364 devc->limit_msec = 0;
365 devc->cur_firmware = -1;
366 devc->num_channels = 0;
367 devc->samples_per_event = 0;
368 devc->capture_ratio = 50;
369 devc->use_triggers = 0;
371 /* Register SIGMA device. */
372 if (!(sdi = sr_dev_inst_new(0, SR_ST_INITIALIZING, USB_VENDOR_NAME,
373 USB_MODEL_NAME, NULL))) {
374 sr_err("%s: sdi was NULL", __func__);
379 for (i = 0; i < ARRAY_SIZE(channel_names); i++) {
380 ch = sr_channel_new(i, SR_CHANNEL_LOGIC, TRUE,
384 sdi->channels = g_slist_append(sdi->channels, ch);
387 devices = g_slist_append(devices, sdi);
388 drvc->instances = g_slist_append(drvc->instances, sdi);
391 /* We will open the device again when we need it. */
392 ftdi_list_free(&devlist);
397 ftdi_deinit(&devc->ftdic);
402 static GSList *dev_list(void)
404 return ((struct drv_context *)(di->priv))->instances;
408 * Configure the FPGA for bitbang mode.
409 * This sequence is documented in section 2. of the ASIX Sigma programming
410 * manual. This sequence is necessary to configure the FPGA in the Sigma
411 * into Bitbang mode, in which it can be programmed with the firmware.
413 static int sigma_fpga_init_bitbang(struct dev_context *devc)
415 uint8_t suicide[] = {
416 0x84, 0x84, 0x88, 0x84, 0x88, 0x84, 0x88, 0x84,
418 uint8_t init_array[] = {
419 0x01, 0x03, 0x03, 0x01, 0x01, 0x01, 0x01, 0x01,
422 int i, ret, timeout = 10000;
425 /* Section 2. part 1), do the FPGA suicide. */
426 sigma_write(suicide, sizeof(suicide), devc);
427 sigma_write(suicide, sizeof(suicide), devc);
428 sigma_write(suicide, sizeof(suicide), devc);
429 sigma_write(suicide, sizeof(suicide), devc);
431 /* Section 2. part 2), do pulse on D1. */
432 sigma_write(init_array, sizeof(init_array), devc);
433 ftdi_usb_purge_buffers(&devc->ftdic);
435 /* Wait until the FPGA asserts D6/INIT_B. */
436 for (i = 0; i < timeout; i++) {
437 ret = sigma_read(&data, 1, devc);
440 /* Test if pin D6 got asserted. */
443 /* The D6 was not asserted yet, wait a bit. */
447 return SR_ERR_TIMEOUT;
451 * Configure the FPGA for logic-analyzer mode.
453 static int sigma_fpga_init_la(struct dev_context *devc)
455 /* Initialize the logic analyzer mode. */
456 uint8_t logic_mode_start[] = {
457 REG_ADDR_LOW | (READ_ID & 0xf),
458 REG_ADDR_HIGH | (READ_ID >> 8),
459 REG_READ_ADDR, /* Read ID register. */
461 REG_ADDR_LOW | (WRITE_TEST & 0xf),
463 REG_DATA_HIGH_WRITE | 0x5,
464 REG_READ_ADDR, /* Read scratch register. */
467 REG_DATA_HIGH_WRITE | 0xa,
468 REG_READ_ADDR, /* Read scratch register. */
470 REG_ADDR_LOW | (WRITE_MODE & 0xf),
472 REG_DATA_HIGH_WRITE | 0x8,
478 /* Initialize the logic analyzer mode. */
479 sigma_write(logic_mode_start, sizeof(logic_mode_start), devc);
481 /* Expect a 3 byte reply since we issued three READ requests. */
482 ret = sigma_read(result, 3, devc);
486 if (result[0] != 0xa6 || result[1] != 0x55 || result[2] != 0xaa)
491 sr_err("Configuration failed. Invalid reply received.");
496 * Read the firmware from a file and transform it into a series of bitbang
497 * pulses used to program the FPGA. Note that the *bb_cmd must be free()'d
498 * by the caller of this function.
500 static int sigma_fw_2_bitbang(const char *filename,
501 uint8_t **bb_cmd, gsize *bb_cmd_size)
505 gsize i, file_size, bb_size;
507 uint8_t *bb_stream, *bbs;
513 * Map the file and make the mapped buffer writable.
514 * NOTE: Using writable=TRUE does _NOT_ mean that file that is mapped
515 * will be modified. It will not be modified until someone uses
516 * g_file_set_contents() on it.
519 file = g_mapped_file_new(filename, TRUE, &error);
520 g_assert_no_error(error);
522 file_size = g_mapped_file_get_length(file);
523 firmware = g_mapped_file_get_contents(file);
526 /* Weird magic transformation below, I have no idea what it does. */
528 for (i = 0; i < file_size; i++) {
529 imm = (imm + 0xa853753) % 177 + (imm * 0x8034052);
530 firmware[i] ^= imm & 0xff;
534 * Now that the firmware is "transformed", we will transcribe the
535 * firmware blob into a sequence of toggles of the Dx wires. This
536 * sequence will be fed directly into the Sigma, which must be in
537 * the FPGA bitbang programming mode.
540 /* Each bit of firmware is transcribed as two toggles of Dx wires. */
541 bb_size = file_size * 8 * 2;
542 bb_stream = (uint8_t *)g_try_malloc(bb_size);
544 sr_err("%s: Failed to allocate bitbang stream", __func__);
550 for (i = 0; i < file_size; i++) {
551 for (bit = 7; bit >= 0; bit--) {
552 v = (firmware[i] & (1 << bit)) ? 0x40 : 0x00;
558 /* The transformation completed successfully, return the result. */
560 *bb_cmd_size = bb_size;
563 g_mapped_file_unref(file);
567 static int upload_firmware(int firmware_idx, struct dev_context *devc)
573 const char *firmware = sigma_firmware_files[firmware_idx];
574 struct ftdi_context *ftdic = &devc->ftdic;
576 /* Make sure it's an ASIX SIGMA. */
577 ret = ftdi_usb_open_desc(ftdic, USB_VENDOR, USB_PRODUCT,
578 USB_DESCRIPTION, NULL);
580 sr_err("ftdi_usb_open failed: %s",
581 ftdi_get_error_string(ftdic));
585 ret = ftdi_set_bitmode(ftdic, 0xdf, BITMODE_BITBANG);
587 sr_err("ftdi_set_bitmode failed: %s",
588 ftdi_get_error_string(ftdic));
592 /* Four times the speed of sigmalogan - Works well. */
593 ret = ftdi_set_baudrate(ftdic, 750000);
595 sr_err("ftdi_set_baudrate failed: %s",
596 ftdi_get_error_string(ftdic));
600 /* Initialize the FPGA for firmware upload. */
601 ret = sigma_fpga_init_bitbang(devc);
605 /* Prepare firmware. */
606 ret = sigma_fw_2_bitbang(firmware, &buf, &buf_size);
608 sr_err("An error occured while reading the firmware: %s",
613 /* Upload firmare. */
614 sr_info("Uploading firmware file '%s'.", firmware);
615 sigma_write(buf, buf_size, devc);
619 ret = ftdi_set_bitmode(ftdic, 0x00, BITMODE_RESET);
621 sr_err("ftdi_set_bitmode failed: %s",
622 ftdi_get_error_string(ftdic));
626 ftdi_usb_purge_buffers(ftdic);
628 /* Discard garbage. */
629 while (sigma_read(&pins, 1, devc) == 1)
632 /* Initialize the FPGA for logic-analyzer mode. */
633 ret = sigma_fpga_init_la(devc);
637 devc->cur_firmware = firmware_idx;
639 sr_info("Firmware uploaded.");
644 static int dev_open(struct sr_dev_inst *sdi)
646 struct dev_context *devc;
651 /* Make sure it's an ASIX SIGMA. */
652 if ((ret = ftdi_usb_open_desc(&devc->ftdic,
653 USB_VENDOR, USB_PRODUCT, USB_DESCRIPTION, NULL)) < 0) {
655 sr_err("ftdi_usb_open failed: %s",
656 ftdi_get_error_string(&devc->ftdic));
661 sdi->status = SR_ST_ACTIVE;
666 static int set_samplerate(const struct sr_dev_inst *sdi, uint64_t samplerate)
668 struct dev_context *devc;
675 for (i = 0; i < ARRAY_SIZE(samplerates); i++) {
676 if (samplerates[i] == samplerate)
679 if (samplerates[i] == 0)
680 return SR_ERR_SAMPLERATE;
682 if (samplerate <= SR_MHZ(50)) {
683 ret = upload_firmware(0, devc);
684 devc->num_channels = 16;
685 } else if (samplerate == SR_MHZ(100)) {
686 ret = upload_firmware(1, devc);
687 devc->num_channels = 8;
688 } else if (samplerate == SR_MHZ(200)) {
689 ret = upload_firmware(2, devc);
690 devc->num_channels = 4;
694 devc->cur_samplerate = samplerate;
695 devc->period_ps = 1000000000000ULL / samplerate;
696 devc->samples_per_event = 16 / devc->num_channels;
697 devc->state.state = SIGMA_IDLE;
704 * In 100 and 200 MHz mode, only a single pin rising/falling can be
705 * set as trigger. In other modes, two rising/falling triggers can be set,
706 * in addition to value/mask trigger for any number of channels.
708 * The Sigma supports complex triggers using boolean expressions, but this
709 * has not been implemented yet.
711 static int configure_channels(const struct sr_dev_inst *sdi)
713 struct dev_context *devc = sdi->priv;
714 const struct sr_channel *ch;
719 memset(&devc->trigger, 0, sizeof(struct sigma_trigger));
721 for (l = sdi->channels; l; l = l->next) {
722 ch = (struct sr_channel *)l->data;
723 channelbit = 1 << (ch->index);
725 if (!ch->enabled || !ch->trigger)
728 if (devc->cur_samplerate >= SR_MHZ(100)) {
729 /* Fast trigger support. */
731 sr_err("Only a single pin trigger in 100 and "
732 "200MHz mode is supported.");
735 if (ch->trigger[0] == 'f')
736 devc->trigger.fallingmask |= channelbit;
737 else if (ch->trigger[0] == 'r')
738 devc->trigger.risingmask |= channelbit;
740 sr_err("Only rising/falling trigger in 100 "
741 "and 200MHz mode is supported.");
747 /* Simple trigger support (event). */
748 if (ch->trigger[0] == '1') {
749 devc->trigger.simplevalue |= channelbit;
750 devc->trigger.simplemask |= channelbit;
752 else if (ch->trigger[0] == '0') {
753 devc->trigger.simplevalue &= ~channelbit;
754 devc->trigger.simplemask |= channelbit;
756 else if (ch->trigger[0] == 'f') {
757 devc->trigger.fallingmask |= channelbit;
760 else if (ch->trigger[0] == 'r') {
761 devc->trigger.risingmask |= channelbit;
766 * Actually, Sigma supports 2 rising/falling triggers,
767 * but they are ORed and the current trigger syntax
768 * does not permit ORed triggers.
770 if (trigger_set > 1) {
771 sr_err("Only 1 rising/falling trigger "
778 devc->use_triggers = 1;
784 static int dev_close(struct sr_dev_inst *sdi)
786 struct dev_context *devc;
791 if (sdi->status == SR_ST_ACTIVE)
792 ftdi_usb_close(&devc->ftdic);
794 sdi->status = SR_ST_INACTIVE;
799 static int cleanup(void)
804 static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi,
805 const struct sr_channel_group *cg)
807 struct dev_context *devc;
816 case SR_CONF_SAMPLERATE:
817 *data = g_variant_new_uint64(devc->cur_samplerate);
819 case SR_CONF_LIMIT_MSEC:
820 *data = g_variant_new_uint64(devc->limit_msec);
822 case SR_CONF_CAPTURE_RATIO:
823 *data = g_variant_new_uint64(devc->capture_ratio);
832 static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
833 const struct sr_channel_group *cg)
835 struct dev_context *devc;
841 if (sdi->status != SR_ST_ACTIVE)
842 return SR_ERR_DEV_CLOSED;
848 case SR_CONF_SAMPLERATE:
849 ret = set_samplerate(sdi, g_variant_get_uint64(data));
851 case SR_CONF_LIMIT_MSEC:
852 tmp = g_variant_get_uint64(data);
854 devc->limit_msec = g_variant_get_uint64(data);
858 case SR_CONF_LIMIT_SAMPLES:
859 tmp = g_variant_get_uint64(data);
860 devc->limit_msec = tmp * 1000 / devc->cur_samplerate;
862 case SR_CONF_CAPTURE_RATIO:
863 tmp = g_variant_get_uint64(data);
865 devc->capture_ratio = tmp;
876 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
877 const struct sr_channel_group *cg)
886 case SR_CONF_DEVICE_OPTIONS:
887 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
888 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
890 case SR_CONF_SAMPLERATE:
891 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
892 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
893 ARRAY_SIZE(samplerates), sizeof(uint64_t));
894 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
895 *data = g_variant_builder_end(&gvb);
897 case SR_CONF_TRIGGER_TYPE:
898 *data = g_variant_new_string(TRIGGER_TYPE);
907 /* Software trigger to determine exact trigger position. */
908 static int get_trigger_offset(uint8_t *samples, uint16_t last_sample,
909 struct sigma_trigger *t)
914 for (i = 0; i < 8; ++i) {
916 last_sample = sample;
917 sample = samples[2 * i] | (samples[2 * i + 1] << 8);
919 /* Simple triggers. */
920 if ((sample & t->simplemask) != t->simplevalue)
924 if (((last_sample & t->risingmask) != 0) ||
925 ((sample & t->risingmask) != t->risingmask))
929 if ((last_sample & t->fallingmask) != t->fallingmask ||
930 (sample & t->fallingmask) != 0)
936 /* If we did not match, return original trigger pos. */
942 * Return the timestamp of "DRAM cluster".
944 static uint16_t sigma_dram_cluster_ts(struct sigma_dram_cluster *cluster)
946 return (cluster->timestamp_hi << 8) | cluster->timestamp_lo;
949 static void sigma_decode_dram_cluster(struct sigma_dram_cluster *dram_cluster,
950 unsigned int events_in_cluster,
951 unsigned int triggered,
952 struct sr_dev_inst *sdi)
954 struct dev_context *devc = sdi->priv;
955 struct sigma_state *ss = &devc->state;
956 struct sr_datafeed_packet packet;
957 struct sr_datafeed_logic logic;
959 uint8_t samples[2048];
962 ts = sigma_dram_cluster_ts(dram_cluster);
963 tsdiff = ts - ss->lastts;
966 packet.type = SR_DF_LOGIC;
967 packet.payload = &logic;
969 logic.data = samples;
972 * First of all, send Sigrok a copy of the last sample from
973 * previous cluster as many times as needed to make up for
974 * the differential characteristics of data we get from the
975 * Sigma. Sigrok needs one sample of data per period.
977 * One DRAM cluster contains a timestamp and seven samples,
978 * the units of timestamp are "devc->period_ps" , the first
979 * sample in the cluster happens at the time of the timestamp
980 * and the remaining samples happen at timestamp +1...+6 .
982 for (ts = 0; ts < tsdiff - (EVENTS_PER_CLUSTER - 1); ts++) {
984 samples[2 * i + 0] = ss->lastsample & 0xff;
985 samples[2 * i + 1] = ss->lastsample >> 8;
988 * If we have 1024 samples ready or we're at the
989 * end of submitting the padding samples, submit
990 * the packet to Sigrok.
992 if ((i == 1023) || (ts == (tsdiff - EVENTS_PER_CLUSTER))) {
993 logic.length = (i + 1) * logic.unitsize;
994 sr_session_send(devc->cb_data, &packet);
999 * Parse the samples in current cluster and prepare them
1000 * to be submitted to Sigrok.
1002 for (i = 0; i < events_in_cluster; i++) {
1003 samples[2 * i + 1] = dram_cluster->samples[i].sample_lo;
1004 samples[2 * i + 0] = dram_cluster->samples[i].sample_hi;
1007 /* Send data up to trigger point (if triggered). */
1008 int trigger_offset = 0;
1011 * Trigger is not always accurate to sample because of
1012 * pipeline delay. However, it always triggers before
1013 * the actual event. We therefore look at the next
1014 * samples to pinpoint the exact position of the trigger.
1016 trigger_offset = get_trigger_offset(samples,
1017 ss->lastsample, &devc->trigger);
1019 if (trigger_offset > 0) {
1020 packet.type = SR_DF_LOGIC;
1021 logic.length = trigger_offset * logic.unitsize;
1022 sr_session_send(devc->cb_data, &packet);
1023 events_in_cluster -= trigger_offset;
1026 /* Only send trigger if explicitly enabled. */
1027 if (devc->use_triggers) {
1028 packet.type = SR_DF_TRIGGER;
1029 sr_session_send(devc->cb_data, &packet);
1033 if (events_in_cluster > 0) {
1034 packet.type = SR_DF_LOGIC;
1035 logic.length = events_in_cluster * logic.unitsize;
1036 logic.data = samples + (trigger_offset * logic.unitsize);
1037 sr_session_send(devc->cb_data, &packet);
1041 samples[2 * (events_in_cluster - 1) + 0] |
1042 (samples[2 * (events_in_cluster - 1) + 1] << 8);
1047 * Decode chunk of 1024 bytes, 64 clusters, 7 events per cluster.
1048 * Each event is 20ns apart, and can contain multiple samples.
1050 * For 200 MHz, events contain 4 samples for each channel, spread 5 ns apart.
1051 * For 100 MHz, events contain 2 samples for each channel, spread 10 ns apart.
1052 * For 50 MHz and below, events contain one sample for each channel,
1053 * spread 20 ns apart.
1055 static int decode_chunk_ts(struct sigma_dram_line *dram_line,
1056 uint16_t events_in_line,
1057 uint32_t trigger_event,
1060 struct sigma_dram_cluster *dram_cluster;
1061 struct sr_dev_inst *sdi = cb_data;
1062 struct dev_context *devc = sdi->priv;
1063 unsigned int clusters_in_line =
1064 (events_in_line + (EVENTS_PER_CLUSTER - 1)) / EVENTS_PER_CLUSTER;
1065 unsigned int events_in_cluster;
1067 uint32_t trigger_cluster = ~0, triggered = 0;
1069 /* Check if trigger is in this chunk. */
1070 if (trigger_event < (64 * 7)) {
1071 if (devc->cur_samplerate <= SR_MHZ(50)) {
1072 trigger_event -= MIN(EVENTS_PER_CLUSTER - 1,
1076 /* Find in which cluster the trigger occured. */
1077 trigger_cluster = trigger_event / EVENTS_PER_CLUSTER;
1080 /* For each full DRAM cluster. */
1081 for (i = 0; i < clusters_in_line; i++) {
1082 dram_cluster = &dram_line->cluster[i];
1084 /* The last cluster might not be full. */
1085 if ((i == clusters_in_line - 1) &&
1086 (events_in_line % EVENTS_PER_CLUSTER)) {
1087 events_in_cluster = events_in_line % EVENTS_PER_CLUSTER;
1089 events_in_cluster = EVENTS_PER_CLUSTER;
1092 triggered = (i == trigger_cluster);
1093 sigma_decode_dram_cluster(dram_cluster, events_in_cluster,
1100 static int download_capture(struct sr_dev_inst *sdi)
1102 struct dev_context *devc = sdi->priv;
1103 const int chunks_per_read = 32;
1104 struct sigma_dram_line *dram_line;
1106 uint32_t stoppos, triggerpos;
1107 struct sr_datafeed_packet packet;
1111 uint32_t dl_lines_total, dl_lines_curr, dl_lines_done;
1112 uint32_t dl_events_in_line = 64 * 7;
1113 uint32_t trg_line = ~0, trg_event = ~0;
1115 dram_line = g_try_malloc0(chunks_per_read * sizeof(*dram_line));
1119 sr_info("Downloading sample data.");
1121 /* Stop acquisition. */
1122 sigma_set_register(WRITE_MODE, 0x11, devc);
1124 /* Set SDRAM Read Enable. */
1125 sigma_set_register(WRITE_MODE, 0x02, devc);
1127 /* Get the current position. */
1128 sigma_read_pos(&stoppos, &triggerpos, devc);
1130 /* Check if trigger has fired. */
1131 modestatus = sigma_get_register(READ_MODE, devc);
1132 if (modestatus & 0x20) {
1133 trg_line = triggerpos >> 9;
1134 trg_event = triggerpos & 0x1ff;
1138 * Determine how many 1024b "DRAM lines" do we need to read from the
1139 * Sigma so we have a complete set of samples. Note that the last
1140 * line can be only partial, containing less than 64 clusters.
1142 dl_lines_total = (stoppos >> 9) + 1;
1146 while (dl_lines_total > dl_lines_done) {
1147 /* We can download only up-to 32 DRAM lines in one go! */
1148 dl_lines_curr = MIN(chunks_per_read, dl_lines_total);
1150 bufsz = sigma_read_dram(dl_lines_done, dl_lines_curr,
1151 (uint8_t *)dram_line, devc);
1152 /* TODO: Check bufsz. For now, just avoid compiler warnings. */
1155 /* This is the first DRAM line, so find the initial timestamp. */
1156 if (dl_lines_done == 0) {
1157 devc->state.lastts =
1158 sigma_dram_cluster_ts(&dram_line[0].cluster[0]);
1159 devc->state.lastsample = 0;
1162 for (i = 0; i < dl_lines_curr; i++) {
1163 uint32_t trigger_event = ~0;
1164 /* The last "DRAM line" can be only partially full. */
1165 if (dl_lines_done + i == dl_lines_total - 1)
1166 dl_events_in_line = stoppos & 0x1ff;
1168 /* Test if the trigger happened on this line. */
1169 if (dl_lines_done + i == trg_line)
1170 trigger_event = trg_event;
1172 decode_chunk_ts(dram_line + i, dl_events_in_line,
1173 trigger_event, sdi);
1176 dl_lines_done += dl_lines_curr;
1180 packet.type = SR_DF_END;
1181 sr_session_send(sdi, &packet);
1183 dev_acquisition_stop(sdi, sdi);
1191 * Handle the Sigma when in CAPTURE mode. This function checks:
1192 * - Sampling time ended
1193 * - DRAM capacity overflow
1194 * This function triggers download of the samples from Sigma
1195 * in case either of the above conditions is true.
1197 static int sigma_capture_mode(struct sr_dev_inst *sdi)
1199 struct dev_context *devc = sdi->priv;
1201 uint64_t running_msec;
1204 uint32_t stoppos, triggerpos;
1206 /* Check if the selected sampling duration passed. */
1207 gettimeofday(&tv, 0);
1208 running_msec = (tv.tv_sec - devc->start_tv.tv_sec) * 1000 +
1209 (tv.tv_usec - devc->start_tv.tv_usec) / 1000;
1210 if (running_msec >= devc->limit_msec)
1211 return download_capture(sdi);
1213 /* Get the position in DRAM to which the FPGA is writing now. */
1214 sigma_read_pos(&stoppos, &triggerpos, devc);
1215 /* Test if DRAM is full and if so, download the data. */
1216 if ((stoppos >> 9) == 32767)
1217 return download_capture(sdi);
1222 static int receive_data(int fd, int revents, void *cb_data)
1224 struct sr_dev_inst *sdi;
1225 struct dev_context *devc;
1233 if (devc->state.state == SIGMA_IDLE)
1236 if (devc->state.state == SIGMA_CAPTURE)
1237 return sigma_capture_mode(sdi);
1242 /* Build a LUT entry used by the trigger functions. */
1243 static void build_lut_entry(uint16_t value, uint16_t mask, uint16_t *entry)
1247 /* For each quad channel. */
1248 for (i = 0; i < 4; ++i) {
1251 /* For each bit in LUT. */
1252 for (j = 0; j < 16; ++j)
1254 /* For each channel in quad. */
1255 for (k = 0; k < 4; ++k) {
1256 bit = 1 << (i * 4 + k);
1258 /* Set bit in entry */
1260 ((!(value & bit)) !=
1262 entry[i] &= ~(1 << j);
1267 /* Add a logical function to LUT mask. */
1268 static void add_trigger_function(enum triggerop oper, enum triggerfunc func,
1269 int index, int neg, uint16_t *mask)
1272 int x[2][2], tmp, a, b, aset, bset, rset;
1274 memset(x, 0, 4 * sizeof(int));
1276 /* Trigger detect condition. */
1306 case OP_NOTRISEFALL:
1312 /* Transpose if neg is set. */
1314 for (i = 0; i < 2; ++i) {
1315 for (j = 0; j < 2; ++j) {
1317 x[i][j] = x[1-i][1-j];
1323 /* Update mask with function. */
1324 for (i = 0; i < 16; ++i) {
1325 a = (i >> (2 * index + 0)) & 1;
1326 b = (i >> (2 * index + 1)) & 1;
1328 aset = (*mask >> i) & 1;
1331 if (func == FUNC_AND || func == FUNC_NAND)
1333 else if (func == FUNC_OR || func == FUNC_NOR)
1335 else if (func == FUNC_XOR || func == FUNC_NXOR)
1338 if (func == FUNC_NAND || func == FUNC_NOR || func == FUNC_NXOR)
1349 * Build trigger LUTs used by 50 MHz and lower sample rates for supporting
1350 * simple pin change and state triggers. Only two transitions (rise/fall) can be
1351 * set at any time, but a full mask and value can be set (0/1).
1353 static int build_basic_trigger(struct triggerlut *lut, struct dev_context *devc)
1356 uint16_t masks[2] = { 0, 0 };
1358 memset(lut, 0, sizeof(struct triggerlut));
1360 /* Contant for simple triggers. */
1363 /* Value/mask trigger support. */
1364 build_lut_entry(devc->trigger.simplevalue, devc->trigger.simplemask,
1367 /* Rise/fall trigger support. */
1368 for (i = 0, j = 0; i < 16; ++i) {
1369 if (devc->trigger.risingmask & (1 << i) ||
1370 devc->trigger.fallingmask & (1 << i))
1371 masks[j++] = 1 << i;
1374 build_lut_entry(masks[0], masks[0], lut->m0d);
1375 build_lut_entry(masks[1], masks[1], lut->m1d);
1377 /* Add glue logic */
1378 if (masks[0] || masks[1]) {
1379 /* Transition trigger. */
1380 if (masks[0] & devc->trigger.risingmask)
1381 add_trigger_function(OP_RISE, FUNC_OR, 0, 0, &lut->m3);
1382 if (masks[0] & devc->trigger.fallingmask)
1383 add_trigger_function(OP_FALL, FUNC_OR, 0, 0, &lut->m3);
1384 if (masks[1] & devc->trigger.risingmask)
1385 add_trigger_function(OP_RISE, FUNC_OR, 1, 0, &lut->m3);
1386 if (masks[1] & devc->trigger.fallingmask)
1387 add_trigger_function(OP_FALL, FUNC_OR, 1, 0, &lut->m3);
1389 /* Only value/mask trigger. */
1393 /* Triggertype: event. */
1394 lut->params.selres = 3;
1399 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
1401 struct dev_context *devc;
1402 struct clockselect_50 clockselect;
1403 int frac, triggerpin, ret;
1404 uint8_t triggerselect = 0;
1405 struct triggerinout triggerinout_conf;
1406 struct triggerlut lut;
1408 if (sdi->status != SR_ST_ACTIVE)
1409 return SR_ERR_DEV_CLOSED;
1413 if (configure_channels(sdi) != SR_OK) {
1414 sr_err("Failed to configure channels.");
1418 /* If the samplerate has not been set, default to 200 kHz. */
1419 if (devc->cur_firmware == -1) {
1420 if ((ret = set_samplerate(sdi, SR_KHZ(200))) != SR_OK)
1424 /* Enter trigger programming mode. */
1425 sigma_set_register(WRITE_TRIGGER_SELECT1, 0x20, devc);
1427 /* 100 and 200 MHz mode. */
1428 if (devc->cur_samplerate >= SR_MHZ(100)) {
1429 sigma_set_register(WRITE_TRIGGER_SELECT1, 0x81, devc);
1431 /* Find which pin to trigger on from mask. */
1432 for (triggerpin = 0; triggerpin < 8; ++triggerpin)
1433 if ((devc->trigger.risingmask | devc->trigger.fallingmask) &
1437 /* Set trigger pin and light LED on trigger. */
1438 triggerselect = (1 << LEDSEL1) | (triggerpin & 0x7);
1440 /* Default rising edge. */
1441 if (devc->trigger.fallingmask)
1442 triggerselect |= 1 << 3;
1444 /* All other modes. */
1445 } else if (devc->cur_samplerate <= SR_MHZ(50)) {
1446 build_basic_trigger(&lut, devc);
1448 sigma_write_trigger_lut(&lut, devc);
1450 triggerselect = (1 << LEDSEL1) | (1 << LEDSEL0);
1453 /* Setup trigger in and out pins to default values. */
1454 memset(&triggerinout_conf, 0, sizeof(struct triggerinout));
1455 triggerinout_conf.trgout_bytrigger = 1;
1456 triggerinout_conf.trgout_enable = 1;
1458 sigma_write_register(WRITE_TRIGGER_OPTION,
1459 (uint8_t *) &triggerinout_conf,
1460 sizeof(struct triggerinout), devc);
1462 /* Go back to normal mode. */
1463 sigma_set_register(WRITE_TRIGGER_SELECT1, triggerselect, devc);
1465 /* Set clock select register. */
1466 if (devc->cur_samplerate == SR_MHZ(200))
1467 /* Enable 4 channels. */
1468 sigma_set_register(WRITE_CLOCK_SELECT, 0xf0, devc);
1469 else if (devc->cur_samplerate == SR_MHZ(100))
1470 /* Enable 8 channels. */
1471 sigma_set_register(WRITE_CLOCK_SELECT, 0x00, devc);
1474 * 50 MHz mode (or fraction thereof). Any fraction down to
1475 * 50 MHz / 256 can be used, but is not supported by sigrok API.
1477 frac = SR_MHZ(50) / devc->cur_samplerate - 1;
1479 clockselect.async = 0;
1480 clockselect.fraction = frac;
1481 clockselect.disabled_channels = 0;
1483 sigma_write_register(WRITE_CLOCK_SELECT,
1484 (uint8_t *) &clockselect,
1485 sizeof(clockselect), devc);
1488 /* Setup maximum post trigger time. */
1489 sigma_set_register(WRITE_POST_TRIGGER,
1490 (devc->capture_ratio * 255) / 100, devc);
1492 /* Start acqusition. */
1493 gettimeofday(&devc->start_tv, 0);
1494 sigma_set_register(WRITE_MODE, 0x0d, devc);
1496 devc->cb_data = cb_data;
1498 /* Send header packet to the session bus. */
1499 std_session_send_df_header(cb_data, LOG_PREFIX);
1501 /* Add capture source. */
1502 sr_source_add(0, G_IO_IN, 10, receive_data, (void *)sdi);
1504 devc->state.state = SIGMA_CAPTURE;
1509 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
1511 struct dev_context *devc;
1516 devc->state.state = SIGMA_IDLE;
1518 sr_source_remove(0);
1523 SR_PRIV struct sr_dev_driver asix_sigma_driver_info = {
1524 .name = "asix-sigma",
1525 .longname = "ASIX SIGMA/SIGMA2",
1530 .dev_list = dev_list,
1531 .dev_clear = dev_clear,
1532 .config_get = config_get,
1533 .config_set = config_set,
1534 .config_list = config_list,
1535 .dev_open = dev_open,
1536 .dev_close = dev_close,
1537 .dev_acquisition_start = dev_acquisition_start,
1538 .dev_acquisition_stop = dev_acquisition_stop,