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
30 * The ASIX Sigma supports arbitrary integer frequency divider in
31 * the 50MHz mode. The divider is in range 1...256 , allowing for
32 * very precise sampling rate selection. This driver supports only
33 * a subset of the sampling rates.
35 SR_PRIV const uint64_t samplerates[] = {
36 SR_KHZ(200), /* div=250 */
37 SR_KHZ(250), /* div=200 */
38 SR_KHZ(500), /* div=100 */
39 SR_MHZ(1), /* div=50 */
40 SR_MHZ(5), /* div=10 */
41 SR_MHZ(10), /* div=5 */
42 SR_MHZ(25), /* div=2 */
43 SR_MHZ(50), /* div=1 */
44 SR_MHZ(100), /* Special FW needed */
45 SR_MHZ(200), /* Special FW needed */
48 SR_PRIV const size_t samplerates_count = ARRAY_SIZE(samplerates);
50 static const char *firmware_files[] = {
51 "asix-sigma-50.fw", /* Up to 50MHz sample rate, 8bit divider. */
52 "asix-sigma-100.fw", /* 100MHz sample rate, fixed. */
53 "asix-sigma-200.fw", /* 200MHz sample rate, fixed. */
54 "asix-sigma-50sync.fw", /* Synchronous clock from external pin. */
55 "asix-sigma-phasor.fw", /* Frequency counter. */
58 #define SIGMA_FIRMWARE_SIZE_LIMIT (256 * 1024)
60 static int sigma_read(void *buf, size_t size, struct dev_context *devc)
64 ret = ftdi_read_data(&devc->ftdic, (unsigned char *)buf, size);
66 sr_err("ftdi_read_data failed: %s",
67 ftdi_get_error_string(&devc->ftdic));
73 static int sigma_write(void *buf, size_t size, struct dev_context *devc)
77 ret = ftdi_write_data(&devc->ftdic, (unsigned char *)buf, size);
79 sr_err("ftdi_write_data failed: %s",
80 ftdi_get_error_string(&devc->ftdic));
81 else if ((size_t) ret != size)
82 sr_err("ftdi_write_data did not complete write.");
88 * NOTE: We chose the buffer size to be large enough to hold any write to the
89 * device. We still print a message just in case.
91 SR_PRIV int sigma_write_register(uint8_t reg, uint8_t *data, size_t len,
92 struct dev_context *devc)
98 if ((2 * len + 2) > sizeof(buf)) {
99 sr_err("Attempted to write %zu bytes, but buffer is too small.",
104 buf[idx++] = REG_ADDR_LOW | (reg & 0xf);
105 buf[idx++] = REG_ADDR_HIGH | (reg >> 4);
107 for (i = 0; i < len; i++) {
108 buf[idx++] = REG_DATA_LOW | (data[i] & 0xf);
109 buf[idx++] = REG_DATA_HIGH_WRITE | (data[i] >> 4);
112 return sigma_write(buf, idx, devc);
115 SR_PRIV int sigma_set_register(uint8_t reg, uint8_t value, struct dev_context *devc)
117 return sigma_write_register(reg, &value, 1, devc);
120 static int sigma_read_register(uint8_t reg, uint8_t *data, size_t len,
121 struct dev_context *devc)
125 buf[0] = REG_ADDR_LOW | (reg & 0xf);
126 buf[1] = REG_ADDR_HIGH | (reg >> 4);
127 buf[2] = REG_READ_ADDR;
129 sigma_write(buf, sizeof(buf), devc);
131 return sigma_read(data, len, devc);
134 static int sigma_read_pos(uint32_t *stoppos, uint32_t *triggerpos,
135 struct dev_context *devc)
138 REG_ADDR_LOW | READ_TRIGGER_POS_LOW,
140 REG_READ_ADDR | NEXT_REG,
141 REG_READ_ADDR | NEXT_REG,
142 REG_READ_ADDR | NEXT_REG,
143 REG_READ_ADDR | NEXT_REG,
144 REG_READ_ADDR | NEXT_REG,
145 REG_READ_ADDR | NEXT_REG,
149 sigma_write(buf, sizeof(buf), devc);
151 sigma_read(result, sizeof(result), devc);
153 *triggerpos = result[0] | (result[1] << 8) | (result[2] << 16);
154 *stoppos = result[3] | (result[4] << 8) | (result[5] << 16);
157 * These "position" values point to after the event (end of
158 * capture data, trigger condition matched). This is why they
159 * get decremented here. Sample memory consists of 512-byte
160 * chunks with meta data in the upper 64 bytes. Thus when the
161 * decrements takes us into this upper part of the chunk, then
162 * further move backwards to the end of the chunk's data part.
164 if ((--*stoppos & 0x1ff) == 0x1ff)
166 if ((--*triggerpos & 0x1ff) == 0x1ff)
172 static int sigma_read_dram(uint16_t startchunk, size_t numchunks,
173 uint8_t *data, struct dev_context *devc)
179 /* Send the startchunk. Index start with 1. */
181 buf[idx++] = startchunk >> 8;
182 buf[idx++] = startchunk & 0xff;
183 sigma_write_register(WRITE_MEMROW, buf, idx, devc);
187 buf[idx++] = REG_DRAM_BLOCK;
188 buf[idx++] = REG_DRAM_WAIT_ACK;
190 for (i = 0; i < numchunks; i++) {
191 /* Alternate bit to copy from DRAM to cache. */
192 if (i != (numchunks - 1))
193 buf[idx++] = REG_DRAM_BLOCK | (((i + 1) % 2) << 4);
195 buf[idx++] = REG_DRAM_BLOCK_DATA | ((i % 2) << 4);
197 if (i != (numchunks - 1))
198 buf[idx++] = REG_DRAM_WAIT_ACK;
201 sigma_write(buf, idx, devc);
203 return sigma_read(data, numchunks * CHUNK_SIZE, devc);
206 /* Upload trigger look-up tables to Sigma. */
207 SR_PRIV int sigma_write_trigger_lut(struct triggerlut *lut, struct dev_context *devc)
213 /* Transpose the table and send to Sigma. */
214 for (i = 0; i < 16; i++) {
219 if (lut->m2d[0] & bit)
221 if (lut->m2d[1] & bit)
223 if (lut->m2d[2] & bit)
225 if (lut->m2d[3] & bit)
235 if (lut->m0d[0] & bit)
237 if (lut->m0d[1] & bit)
239 if (lut->m0d[2] & bit)
241 if (lut->m0d[3] & bit)
244 if (lut->m1d[0] & bit)
246 if (lut->m1d[1] & bit)
248 if (lut->m1d[2] & bit)
250 if (lut->m1d[3] & bit)
253 sigma_write_register(WRITE_TRIGGER_SELECT0, tmp, sizeof(tmp),
255 sigma_set_register(WRITE_TRIGGER_SELECT1, 0x30 | i, devc);
258 /* Send the parameters */
259 sigma_write_register(WRITE_TRIGGER_SELECT0, (uint8_t *) &lut->params,
260 sizeof(lut->params), devc);
266 * See Xilinx UG332 for Spartan-3 FPGA configuration. The SIGMA device
267 * uses FTDI bitbang mode for netlist download in slave serial mode.
268 * (LATER: The OMEGA device's cable contains a more capable FTDI chip
269 * and uses MPSSE mode for bitbang. -- Can we also use FT232H in FT245
270 * compatible bitbang mode? For maximum code re-use and reduced libftdi
271 * dependency? See section 3.5.5 of FT232H: D0 clk, D1 data (out), D2
272 * data (in), D3 select, D4-7 GPIOL. See section 3.5.7 for MCU FIFO.)
274 * 750kbps rate (four times the speed of sigmalogan) works well for
275 * netlist download. All pins except INIT_B are output pins during
276 * configuration download.
278 * Some pins are inverted as a byproduct of level shifting circuitry.
279 * That's why high CCLK level (from the cable's point of view) is idle
280 * from the FPGA's perspective.
282 * The vendor's literature discusses a "suicide sequence" which ends
283 * regular FPGA execution and should be sent before entering bitbang
284 * mode and sending configuration data. Set D7 and toggle D2, D3, D4
287 #define BB_PIN_CCLK (1 << 0) /* D0, CCLK */
288 #define BB_PIN_PROG (1 << 1) /* D1, PROG */
289 #define BB_PIN_D2 (1 << 2) /* D2, (part of) SUICIDE */
290 #define BB_PIN_D3 (1 << 3) /* D3, (part of) SUICIDE */
291 #define BB_PIN_D4 (1 << 4) /* D4, (part of) SUICIDE (unused?) */
292 #define BB_PIN_INIT (1 << 5) /* D5, INIT, input pin */
293 #define BB_PIN_DIN (1 << 6) /* D6, DIN */
294 #define BB_PIN_D7 (1 << 7) /* D7, (part of) SUICIDE */
296 #define BB_BITRATE (750 * 1000)
297 #define BB_PINMASK (0xff & ~BB_PIN_INIT)
300 * Initiate slave serial mode for configuration download. Which is done
301 * by pulsing PROG_B and sensing INIT_B. Make sure CCLK is idle before
302 * initiating the configuration download. Run a "suicide sequence" first
303 * to terminate the regular FPGA operation before reconfiguration.
305 static int sigma_fpga_init_bitbang(struct dev_context *devc)
307 uint8_t suicide[] = {
308 BB_PIN_D7 | BB_PIN_D2,
309 BB_PIN_D7 | BB_PIN_D2,
310 BB_PIN_D7 | BB_PIN_D3,
311 BB_PIN_D7 | BB_PIN_D2,
312 BB_PIN_D7 | BB_PIN_D3,
313 BB_PIN_D7 | BB_PIN_D2,
314 BB_PIN_D7 | BB_PIN_D3,
315 BB_PIN_D7 | BB_PIN_D2,
317 uint8_t init_array[] = {
319 BB_PIN_CCLK | BB_PIN_PROG,
320 BB_PIN_CCLK | BB_PIN_PROG,
332 /* Section 2. part 1), do the FPGA suicide. */
333 sigma_write(suicide, sizeof(suicide), devc);
334 sigma_write(suicide, sizeof(suicide), devc);
335 sigma_write(suicide, sizeof(suicide), devc);
336 sigma_write(suicide, sizeof(suicide), devc);
338 /* Section 2. part 2), pulse PROG. */
339 sigma_write(init_array, sizeof(init_array), devc);
340 ftdi_usb_purge_buffers(&devc->ftdic);
342 /* Wait until the FPGA asserts INIT_B. */
345 ret = sigma_read(&data, 1, devc);
348 if (data & BB_PIN_INIT)
353 return SR_ERR_TIMEOUT;
357 * Configure the FPGA for logic-analyzer mode.
359 static int sigma_fpga_init_la(struct dev_context *devc)
362 * TODO Construct the sequence at runtime? Such that request data
363 * and response check values will match more apparently?
365 uint8_t mode_regval = WMR_SDRAMINIT;
366 uint8_t logic_mode_start[] = {
367 /* Read ID register. */
368 REG_ADDR_LOW | (READ_ID & 0xf),
369 REG_ADDR_HIGH | (READ_ID >> 4),
372 /* Write 0x55 to scratch register, read back. */
373 REG_ADDR_LOW | (WRITE_TEST & 0xf),
375 REG_DATA_HIGH_WRITE | 0x5,
378 /* Write 0xaa to scratch register, read back. */
380 REG_DATA_HIGH_WRITE | 0xa,
383 /* Initiate SDRAM initialization in mode register. */
384 REG_ADDR_LOW | (WRITE_MODE & 0xf),
385 REG_DATA_LOW | (mode_regval & 0xf),
386 REG_DATA_HIGH_WRITE | (mode_regval >> 4),
392 * Send the command sequence which contains 3 READ requests.
393 * Expect to see the corresponding 3 response bytes.
395 sigma_write(logic_mode_start, sizeof(logic_mode_start), devc);
396 ret = sigma_read(result, ARRAY_SIZE(result), devc);
397 if (ret != ARRAY_SIZE(result))
399 if (result[0] != 0xa6 || result[1] != 0x55 || result[2] != 0xaa)
405 sr_err("Configuration failed. Invalid reply received.");
410 * Read the firmware from a file and transform it into a series of bitbang
411 * pulses used to program the FPGA. Note that the *bb_cmd must be free()'d
412 * by the caller of this function.
414 static int sigma_fw_2_bitbang(struct sr_context *ctx, const char *name,
415 uint8_t **bb_cmd, gsize *bb_cmd_size)
423 uint8_t *bb_stream, *bbs, byte, mask, v;
425 /* Retrieve the on-disk firmware file content. */
426 firmware = sr_resource_load(ctx, SR_RESOURCE_FIRMWARE, name,
427 &file_size, SIGMA_FIRMWARE_SIZE_LIMIT);
431 /* Unscramble the file content (XOR with "random" sequence). */
436 imm = (imm + 0xa853753) % 177 + (imm * 0x8034052);
441 * Generate a sequence of bitbang samples. With two samples per
442 * FPGA configuration bit, providing the level for the DIN signal
443 * as well as two edges for CCLK. See Xilinx UG332 for details
444 * ("slave serial" mode).
446 * Note that CCLK is inverted in hardware. That's why the
447 * respective bit is first set and then cleared in the bitbang
448 * sample sets. So that the DIN level will be stable when the
449 * data gets sampled at the rising CCLK edge, and the signals'
450 * setup time constraint will be met.
452 * The caller will put the FPGA into download mode, will send
453 * the bitbang samples, and release the allocated memory.
455 bb_size = file_size * 8 * 2;
456 bb_stream = g_try_malloc(bb_size);
458 sr_err("%s: Failed to allocate bitbang stream", __func__);
460 return SR_ERR_MALLOC;
469 v = (byte & mask) ? BB_PIN_DIN : 0;
471 *bbs++ = v | BB_PIN_CCLK;
477 /* The transformation completed successfully, return the result. */
479 *bb_cmd_size = bb_size;
484 static int upload_firmware(struct sr_context *ctx,
485 int firmware_idx, struct dev_context *devc)
491 const char *firmware;
493 /* Avoid downloading the same firmware multiple times. */
494 firmware = firmware_files[firmware_idx];
495 if (devc->cur_firmware == firmware_idx) {
496 sr_info("Not uploading firmware file '%s' again.", firmware);
500 /* Set the cable to bitbang mode. */
501 ret = ftdi_set_bitmode(&devc->ftdic, BB_PINMASK, BITMODE_BITBANG);
503 sr_err("ftdi_set_bitmode failed: %s",
504 ftdi_get_error_string(&devc->ftdic));
507 ret = ftdi_set_baudrate(&devc->ftdic, BB_BITRATE);
509 sr_err("ftdi_set_baudrate failed: %s",
510 ftdi_get_error_string(&devc->ftdic));
514 /* Initiate FPGA configuration mode. */
515 ret = sigma_fpga_init_bitbang(devc);
519 /* Prepare wire format of the firmware image. */
520 ret = sigma_fw_2_bitbang(ctx, firmware, &buf, &buf_size);
522 sr_err("An error occurred while reading the firmware: %s",
527 /* Write the FPGA netlist to the cable. */
528 sr_info("Uploading firmware file '%s'.", firmware);
529 sigma_write(buf, buf_size, devc);
533 /* Leave bitbang mode and discard pending input data. */
534 ret = ftdi_set_bitmode(&devc->ftdic, 0, BITMODE_RESET);
536 sr_err("ftdi_set_bitmode failed: %s",
537 ftdi_get_error_string(&devc->ftdic));
540 ftdi_usb_purge_buffers(&devc->ftdic);
541 while (sigma_read(&pins, 1, devc) == 1)
544 /* Initialize the FPGA for logic-analyzer mode. */
545 ret = sigma_fpga_init_la(devc);
549 /* Keep track of successful firmware download completion. */
550 devc->cur_firmware = firmware_idx;
551 sr_info("Firmware uploaded.");
557 * Sigma doesn't support limiting the number of samples, so we have to
558 * translate the number and the samplerate to an elapsed time.
560 * In addition we need to ensure that the last data cluster has passed
561 * the hardware pipeline, and became available to the PC side. With RLE
562 * compression up to 327ms could pass before another cluster accumulates
563 * at 200kHz samplerate when input pins don't change.
565 SR_PRIV uint64_t sigma_limit_samples_to_msec(const struct dev_context *devc,
566 uint64_t limit_samples)
569 uint64_t worst_cluster_time_ms;
571 limit_msec = limit_samples * 1000 / devc->cur_samplerate;
572 worst_cluster_time_ms = 65536 * 1000 / devc->cur_samplerate;
574 * One cluster time is not enough to flush pipeline when sampling
575 * grounded pins with 1 sample limit at 200kHz. Hence the 2* fix.
577 return limit_msec + 2 * worst_cluster_time_ms;
580 SR_PRIV int sigma_set_samplerate(const struct sr_dev_inst *sdi, uint64_t samplerate)
582 struct dev_context *devc;
583 struct drv_context *drvc;
589 drvc = sdi->driver->context;
592 /* Reject rates that are not in the list of supported rates. */
593 for (i = 0; i < samplerates_count; i++) {
594 if (samplerates[i] == samplerate)
597 if (i >= samplerates_count || samplerates[i] == 0)
598 return SR_ERR_SAMPLERATE;
601 * Depending on the samplerates of 200/100/50- MHz, specific
602 * firmware is required and higher rates might limit the set
603 * of available channels.
605 num_channels = devc->num_channels;
606 if (samplerate <= SR_MHZ(50)) {
607 ret = upload_firmware(drvc->sr_ctx, 0, devc);
609 } else if (samplerate == SR_MHZ(100)) {
610 ret = upload_firmware(drvc->sr_ctx, 1, devc);
612 } else if (samplerate == SR_MHZ(200)) {
613 ret = upload_firmware(drvc->sr_ctx, 2, devc);
618 * Derive the sample period from the sample rate as well as the
619 * number of samples that the device will communicate within
620 * an "event" (memory organization internal to the device).
623 devc->num_channels = num_channels;
624 devc->cur_samplerate = samplerate;
625 devc->samples_per_event = 16 / devc->num_channels;
626 devc->state.state = SIGMA_IDLE;
630 * Support for "limit_samples" is implemented by stopping
631 * acquisition after a corresponding period of time.
632 * Re-calculate that period of time, in case the limit is
633 * set first and the samplerate gets (re-)configured later.
635 if (ret == SR_OK && devc->limit_samples) {
637 msecs = sigma_limit_samples_to_msec(devc, devc->limit_samples);
638 devc->limit_msec = msecs;
645 * In 100 and 200 MHz mode, only a single pin rising/falling can be
646 * set as trigger. In other modes, two rising/falling triggers can be set,
647 * in addition to value/mask trigger for any number of channels.
649 * The Sigma supports complex triggers using boolean expressions, but this
650 * has not been implemented yet.
652 SR_PRIV int sigma_convert_trigger(const struct sr_dev_inst *sdi)
654 struct dev_context *devc;
655 struct sr_trigger *trigger;
656 struct sr_trigger_stage *stage;
657 struct sr_trigger_match *match;
659 int channelbit, trigger_set;
662 memset(&devc->trigger, 0, sizeof(struct sigma_trigger));
663 if (!(trigger = sr_session_trigger_get(sdi->session)))
667 for (l = trigger->stages; l; l = l->next) {
669 for (m = stage->matches; m; m = m->next) {
671 if (!match->channel->enabled)
672 /* Ignore disabled channels with a trigger. */
674 channelbit = 1 << (match->channel->index);
675 if (devc->cur_samplerate >= SR_MHZ(100)) {
676 /* Fast trigger support. */
678 sr_err("Only a single pin trigger is "
679 "supported in 100 and 200MHz mode.");
682 if (match->match == SR_TRIGGER_FALLING)
683 devc->trigger.fallingmask |= channelbit;
684 else if (match->match == SR_TRIGGER_RISING)
685 devc->trigger.risingmask |= channelbit;
687 sr_err("Only rising/falling trigger is "
688 "supported in 100 and 200MHz mode.");
694 /* Simple trigger support (event). */
695 if (match->match == SR_TRIGGER_ONE) {
696 devc->trigger.simplevalue |= channelbit;
697 devc->trigger.simplemask |= channelbit;
698 } else if (match->match == SR_TRIGGER_ZERO) {
699 devc->trigger.simplevalue &= ~channelbit;
700 devc->trigger.simplemask |= channelbit;
701 } else if (match->match == SR_TRIGGER_FALLING) {
702 devc->trigger.fallingmask |= channelbit;
704 } else if (match->match == SR_TRIGGER_RISING) {
705 devc->trigger.risingmask |= channelbit;
710 * Actually, Sigma supports 2 rising/falling triggers,
711 * but they are ORed and the current trigger syntax
712 * does not permit ORed triggers.
714 if (trigger_set > 1) {
715 sr_err("Only 1 rising/falling trigger "
726 /* Software trigger to determine exact trigger position. */
727 static int get_trigger_offset(uint8_t *samples, uint16_t last_sample,
728 struct sigma_trigger *t)
733 for (i = 0; i < 8; i++) {
735 last_sample = sample;
736 sample = samples[2 * i] | (samples[2 * i + 1] << 8);
738 /* Simple triggers. */
739 if ((sample & t->simplemask) != t->simplevalue)
743 if (((last_sample & t->risingmask) != 0) ||
744 ((sample & t->risingmask) != t->risingmask))
748 if ((last_sample & t->fallingmask) != t->fallingmask ||
749 (sample & t->fallingmask) != 0)
755 /* If we did not match, return original trigger pos. */
760 * Return the timestamp of "DRAM cluster".
762 static uint16_t sigma_dram_cluster_ts(struct sigma_dram_cluster *cluster)
764 return (cluster->timestamp_hi << 8) | cluster->timestamp_lo;
768 * Return one 16bit data entity of a DRAM cluster at the specified index.
770 static uint16_t sigma_dram_cluster_data(struct sigma_dram_cluster *cl, int idx)
775 sample |= cl->samples[idx].sample_lo << 0;
776 sample |= cl->samples[idx].sample_hi << 8;
777 sample = (sample >> 8) | (sample << 8);
782 * Deinterlace sample data that was retrieved at 100MHz samplerate.
783 * One 16bit item contains two samples of 8bits each. The bits of
784 * multiple samples are interleaved.
786 static uint16_t sigma_deinterlace_100mhz_data(uint16_t indata, int idx)
792 outdata |= (indata >> (0 * 2 - 0)) & (1 << 0);
793 outdata |= (indata >> (1 * 2 - 1)) & (1 << 1);
794 outdata |= (indata >> (2 * 2 - 2)) & (1 << 2);
795 outdata |= (indata >> (3 * 2 - 3)) & (1 << 3);
796 outdata |= (indata >> (4 * 2 - 4)) & (1 << 4);
797 outdata |= (indata >> (5 * 2 - 5)) & (1 << 5);
798 outdata |= (indata >> (6 * 2 - 6)) & (1 << 6);
799 outdata |= (indata >> (7 * 2 - 7)) & (1 << 7);
804 * Deinterlace sample data that was retrieved at 200MHz samplerate.
805 * One 16bit item contains four samples of 4bits each. The bits of
806 * multiple samples are interleaved.
808 static uint16_t sigma_deinterlace_200mhz_data(uint16_t indata, int idx)
814 outdata |= (indata >> (0 * 4 - 0)) & (1 << 0);
815 outdata |= (indata >> (1 * 4 - 1)) & (1 << 1);
816 outdata |= (indata >> (2 * 4 - 2)) & (1 << 2);
817 outdata |= (indata >> (3 * 4 - 3)) & (1 << 3);
821 static void store_sr_sample(uint8_t *samples, int idx, uint16_t data)
823 samples[2 * idx + 0] = (data >> 0) & 0xff;
824 samples[2 * idx + 1] = (data >> 8) & 0xff;
828 * Local wrapper around sr_session_send() calls. Make sure to not send
829 * more samples to the session's datafeed than what was requested by a
830 * previously configured (optional) sample count.
832 static void sigma_session_send(struct sr_dev_inst *sdi,
833 struct sr_datafeed_packet *packet)
835 struct dev_context *devc;
836 struct sr_datafeed_logic *logic;
840 if (devc->limit_samples) {
841 logic = (void *)packet->payload;
842 send_now = logic->length / logic->unitsize;
843 if (devc->sent_samples + send_now > devc->limit_samples) {
844 send_now = devc->limit_samples - devc->sent_samples;
845 logic->length = send_now * logic->unitsize;
849 devc->sent_samples += send_now;
852 sr_session_send(sdi, packet);
856 * This size translates to: event count (1K events per cluster), times
857 * the sample width (unitsize, 16bits per event), times the maximum
858 * number of samples per event.
860 #define SAMPLES_BUFFER_SIZE (1024 * 2 * 4)
862 static void sigma_decode_dram_cluster(struct sigma_dram_cluster *dram_cluster,
863 unsigned int events_in_cluster,
864 unsigned int triggered,
865 struct sr_dev_inst *sdi)
867 struct dev_context *devc = sdi->priv;
868 struct sigma_state *ss = &devc->state;
869 struct sr_datafeed_packet packet;
870 struct sr_datafeed_logic logic;
871 uint16_t tsdiff, ts, sample, item16;
872 uint8_t samples[SAMPLES_BUFFER_SIZE];
874 size_t send_count, trig_count;
878 ts = sigma_dram_cluster_ts(dram_cluster);
879 tsdiff = ts - ss->lastts;
880 ss->lastts = ts + EVENTS_PER_CLUSTER;
882 packet.type = SR_DF_LOGIC;
883 packet.payload = &logic;
885 logic.data = samples;
888 * If this cluster is not adjacent to the previously received
889 * cluster, then send the appropriate number of samples with the
890 * previous values to the sigrok session. This "decodes RLE".
892 for (ts = 0; ts < tsdiff; ts++) {
894 store_sr_sample(samples, i, ss->lastsample);
897 * If we have 1024 samples ready or we're at the
898 * end of submitting the padding samples, submit
899 * the packet to Sigrok. Since constant data is
900 * sent, duplication of data for rates above 50MHz
903 if ((i == 1023) || (ts == tsdiff - 1)) {
904 logic.length = (i + 1) * logic.unitsize;
905 for (j = 0; j < devc->samples_per_event; j++)
906 sigma_session_send(sdi, &packet);
911 * Parse the samples in current cluster and prepare them
912 * to be submitted to Sigrok. Cope with memory layouts that
913 * vary with the samplerate.
915 send_ptr = &samples[0];
918 for (i = 0; i < events_in_cluster; i++) {
919 item16 = sigma_dram_cluster_data(dram_cluster, i);
920 if (devc->cur_samplerate == SR_MHZ(200)) {
921 sample = sigma_deinterlace_200mhz_data(item16, 0);
922 store_sr_sample(samples, send_count++, sample);
923 sample = sigma_deinterlace_200mhz_data(item16, 1);
924 store_sr_sample(samples, send_count++, sample);
925 sample = sigma_deinterlace_200mhz_data(item16, 2);
926 store_sr_sample(samples, send_count++, sample);
927 sample = sigma_deinterlace_200mhz_data(item16, 3);
928 store_sr_sample(samples, send_count++, sample);
929 } else if (devc->cur_samplerate == SR_MHZ(100)) {
930 sample = sigma_deinterlace_100mhz_data(item16, 0);
931 store_sr_sample(samples, send_count++, sample);
932 sample = sigma_deinterlace_100mhz_data(item16, 1);
933 store_sr_sample(samples, send_count++, sample);
936 store_sr_sample(samples, send_count++, sample);
941 * If a trigger position applies, then provide the datafeed with
942 * the first part of data up to that position, then send the
945 int trigger_offset = 0;
948 * Trigger is not always accurate to sample because of
949 * pipeline delay. However, it always triggers before
950 * the actual event. We therefore look at the next
951 * samples to pinpoint the exact position of the trigger.
953 trigger_offset = get_trigger_offset(samples,
954 ss->lastsample, &devc->trigger);
956 if (trigger_offset > 0) {
957 trig_count = trigger_offset * devc->samples_per_event;
958 packet.type = SR_DF_LOGIC;
959 logic.length = trig_count * logic.unitsize;
960 sigma_session_send(sdi, &packet);
961 send_ptr += trig_count * logic.unitsize;
962 send_count -= trig_count;
965 /* Only send trigger if explicitly enabled. */
966 if (devc->use_triggers)
967 std_session_send_df_trigger(sdi);
971 * Send the data after the trigger, or all of the received data
972 * if no trigger position applies.
975 packet.type = SR_DF_LOGIC;
976 logic.length = send_count * logic.unitsize;
977 logic.data = send_ptr;
978 sigma_session_send(sdi, &packet);
981 ss->lastsample = sample;
985 * Decode chunk of 1024 bytes, 64 clusters, 7 events per cluster.
986 * Each event is 20ns apart, and can contain multiple samples.
988 * For 200 MHz, events contain 4 samples for each channel, spread 5 ns apart.
989 * For 100 MHz, events contain 2 samples for each channel, spread 10 ns apart.
990 * For 50 MHz and below, events contain one sample for each channel,
991 * spread 20 ns apart.
993 static int decode_chunk_ts(struct sigma_dram_line *dram_line,
994 uint16_t events_in_line,
995 uint32_t trigger_event,
996 struct sr_dev_inst *sdi)
998 struct sigma_dram_cluster *dram_cluster;
999 struct dev_context *devc;
1000 unsigned int clusters_in_line;
1001 unsigned int events_in_cluster;
1003 uint32_t trigger_cluster, triggered;
1006 clusters_in_line = events_in_line;
1007 clusters_in_line += EVENTS_PER_CLUSTER - 1;
1008 clusters_in_line /= EVENTS_PER_CLUSTER;
1009 trigger_cluster = ~0;
1012 /* Check if trigger is in this chunk. */
1013 if (trigger_event < (64 * 7)) {
1014 if (devc->cur_samplerate <= SR_MHZ(50)) {
1015 trigger_event -= MIN(EVENTS_PER_CLUSTER - 1,
1019 /* Find in which cluster the trigger occurred. */
1020 trigger_cluster = trigger_event / EVENTS_PER_CLUSTER;
1023 /* For each full DRAM cluster. */
1024 for (i = 0; i < clusters_in_line; i++) {
1025 dram_cluster = &dram_line->cluster[i];
1027 /* The last cluster might not be full. */
1028 if ((i == clusters_in_line - 1) &&
1029 (events_in_line % EVENTS_PER_CLUSTER)) {
1030 events_in_cluster = events_in_line % EVENTS_PER_CLUSTER;
1032 events_in_cluster = EVENTS_PER_CLUSTER;
1035 triggered = (i == trigger_cluster);
1036 sigma_decode_dram_cluster(dram_cluster, events_in_cluster,
1043 static int download_capture(struct sr_dev_inst *sdi)
1045 const uint32_t chunks_per_read = 32;
1047 struct dev_context *devc;
1048 struct sigma_dram_line *dram_line;
1050 uint32_t stoppos, triggerpos;
1053 uint32_t dl_lines_total, dl_lines_curr, dl_lines_done;
1054 uint32_t dl_first_line, dl_line;
1055 uint32_t dl_events_in_line;
1056 uint32_t trg_line, trg_event;
1059 dl_events_in_line = 64 * 7;
1061 sr_info("Downloading sample data.");
1062 devc->state.state = SIGMA_DOWNLOAD;
1065 * Ask the hardware to stop data acquisition. Reception of the
1066 * FORCESTOP request makes the hardware "disable RLE" (store
1067 * clusters to DRAM regardless of whether pin state changes) and
1068 * raise the POSTTRIGGERED flag.
1070 sigma_set_register(WRITE_MODE, WMR_FORCESTOP | WMR_SDRAMWRITEEN, devc);
1072 if (sigma_read_register(READ_MODE, &modestatus, 1, devc) != 1) {
1073 sr_err("failed while waiting for RMR_POSTTRIGGERED bit");
1076 } while (!(modestatus & RMR_POSTTRIGGERED));
1078 /* Set SDRAM Read Enable. */
1079 sigma_set_register(WRITE_MODE, WMR_SDRAMREADEN, devc);
1081 /* Get the current position. */
1082 sigma_read_pos(&stoppos, &triggerpos, devc);
1084 /* Check if trigger has fired. */
1085 if (sigma_read_register(READ_MODE, &modestatus, 1, devc) != 1) {
1086 sr_err("failed to read READ_MODE register");
1091 if (modestatus & RMR_TRIGGERED) {
1092 trg_line = triggerpos >> 9;
1093 trg_event = triggerpos & 0x1ff;
1096 devc->sent_samples = 0;
1099 * Determine how many "DRAM lines" of 1024 bytes each we need to
1100 * retrieve from the Sigma hardware, so that we have a complete
1101 * set of samples. Note that the last line need not contain 64
1102 * clusters, it might be partially filled only.
1104 * When RMR_ROUND is set, the circular buffer in DRAM has wrapped
1105 * around. Since the status of the very next line is uncertain in
1106 * that case, we skip it and start reading from the next line. The
1107 * circular buffer has 32K lines (0x8000).
1109 dl_lines_total = (stoppos >> 9) + 1;
1110 if (modestatus & RMR_ROUND) {
1111 dl_first_line = dl_lines_total + 1;
1112 dl_lines_total = 0x8000 - 2;
1116 dram_line = g_try_malloc0(chunks_per_read * sizeof(*dram_line));
1120 while (dl_lines_total > dl_lines_done) {
1121 /* We can download only up-to 32 DRAM lines in one go! */
1122 dl_lines_curr = MIN(chunks_per_read, dl_lines_total - dl_lines_done);
1124 dl_line = dl_first_line + dl_lines_done;
1126 bufsz = sigma_read_dram(dl_line, dl_lines_curr,
1127 (uint8_t *)dram_line, devc);
1128 /* TODO: Check bufsz. For now, just avoid compiler warnings. */
1131 /* This is the first DRAM line, so find the initial timestamp. */
1132 if (dl_lines_done == 0) {
1133 devc->state.lastts =
1134 sigma_dram_cluster_ts(&dram_line[0].cluster[0]);
1135 devc->state.lastsample = 0;
1138 for (i = 0; i < dl_lines_curr; i++) {
1139 uint32_t trigger_event = ~0;
1140 /* The last "DRAM line" can be only partially full. */
1141 if (dl_lines_done + i == dl_lines_total - 1)
1142 dl_events_in_line = stoppos & 0x1ff;
1144 /* Test if the trigger happened on this line. */
1145 if (dl_lines_done + i == trg_line)
1146 trigger_event = trg_event;
1148 decode_chunk_ts(dram_line + i, dl_events_in_line,
1149 trigger_event, sdi);
1152 dl_lines_done += dl_lines_curr;
1156 std_session_send_df_end(sdi);
1158 devc->state.state = SIGMA_IDLE;
1159 sr_dev_acquisition_stop(sdi);
1165 * Periodically check the Sigma status when in CAPTURE mode. This routine
1166 * checks whether the configured sample count or sample time have passed,
1167 * and will stop acquisition and download the acquired samples.
1169 static int sigma_capture_mode(struct sr_dev_inst *sdi)
1171 struct dev_context *devc;
1172 uint64_t running_msec;
1173 uint64_t current_time;
1178 * Check if the selected sampling duration passed. Sample count
1179 * limits are covered by this enforced timeout as well.
1181 current_time = g_get_monotonic_time();
1182 running_msec = (current_time - devc->start_time) / 1000;
1183 if (running_msec >= devc->limit_msec)
1184 return download_capture(sdi);
1189 SR_PRIV int sigma_receive_data(int fd, int revents, void *cb_data)
1191 struct sr_dev_inst *sdi;
1192 struct dev_context *devc;
1200 if (devc->state.state == SIGMA_IDLE)
1204 * When the application has requested to stop the acquisition,
1205 * then immediately start downloading sample data. Otherwise
1206 * keep checking configured limits which will terminate the
1207 * acquisition and initiate download.
1209 if (devc->state.state == SIGMA_STOPPING)
1210 return download_capture(sdi);
1211 if (devc->state.state == SIGMA_CAPTURE)
1212 return sigma_capture_mode(sdi);
1217 /* Build a LUT entry used by the trigger functions. */
1218 static void build_lut_entry(uint16_t value, uint16_t mask, uint16_t *entry)
1222 /* For each quad channel. */
1223 for (i = 0; i < 4; i++) {
1226 /* For each bit in LUT. */
1227 for (j = 0; j < 16; j++)
1229 /* For each channel in quad. */
1230 for (k = 0; k < 4; k++) {
1231 bit = 1 << (i * 4 + k);
1233 /* Set bit in entry */
1234 if ((mask & bit) && ((!(value & bit)) !=
1236 entry[i] &= ~(1 << j);
1241 /* Add a logical function to LUT mask. */
1242 static void add_trigger_function(enum triggerop oper, enum triggerfunc func,
1243 int index, int neg, uint16_t *mask)
1246 int x[2][2], tmp, a, b, aset, bset, rset;
1248 memset(x, 0, 4 * sizeof(int));
1250 /* Trigger detect condition. */
1280 case OP_NOTRISEFALL:
1286 /* Transpose if neg is set. */
1288 for (i = 0; i < 2; i++) {
1289 for (j = 0; j < 2; j++) {
1291 x[i][j] = x[1 - i][1 - j];
1292 x[1 - i][1 - j] = tmp;
1297 /* Update mask with function. */
1298 for (i = 0; i < 16; i++) {
1299 a = (i >> (2 * index + 0)) & 1;
1300 b = (i >> (2 * index + 1)) & 1;
1302 aset = (*mask >> i) & 1;
1306 if (func == FUNC_AND || func == FUNC_NAND)
1308 else if (func == FUNC_OR || func == FUNC_NOR)
1310 else if (func == FUNC_XOR || func == FUNC_NXOR)
1313 if (func == FUNC_NAND || func == FUNC_NOR || func == FUNC_NXOR)
1324 * Build trigger LUTs used by 50 MHz and lower sample rates for supporting
1325 * simple pin change and state triggers. Only two transitions (rise/fall) can be
1326 * set at any time, but a full mask and value can be set (0/1).
1328 SR_PRIV int sigma_build_basic_trigger(struct triggerlut *lut, struct dev_context *devc)
1331 uint16_t masks[2] = { 0, 0 };
1333 memset(lut, 0, sizeof(struct triggerlut));
1335 /* Constant for simple triggers. */
1338 /* Value/mask trigger support. */
1339 build_lut_entry(devc->trigger.simplevalue, devc->trigger.simplemask,
1342 /* Rise/fall trigger support. */
1343 for (i = 0, j = 0; i < 16; i++) {
1344 if (devc->trigger.risingmask & (1 << i) ||
1345 devc->trigger.fallingmask & (1 << i))
1346 masks[j++] = 1 << i;
1349 build_lut_entry(masks[0], masks[0], lut->m0d);
1350 build_lut_entry(masks[1], masks[1], lut->m1d);
1352 /* Add glue logic */
1353 if (masks[0] || masks[1]) {
1354 /* Transition trigger. */
1355 if (masks[0] & devc->trigger.risingmask)
1356 add_trigger_function(OP_RISE, FUNC_OR, 0, 0, &lut->m3);
1357 if (masks[0] & devc->trigger.fallingmask)
1358 add_trigger_function(OP_FALL, FUNC_OR, 0, 0, &lut->m3);
1359 if (masks[1] & devc->trigger.risingmask)
1360 add_trigger_function(OP_RISE, FUNC_OR, 1, 0, &lut->m3);
1361 if (masks[1] & devc->trigger.fallingmask)
1362 add_trigger_function(OP_FALL, FUNC_OR, 1, 0, &lut->m3);
1364 /* Only value/mask trigger. */
1368 /* Triggertype: event. */
1369 lut->params.selres = 3;