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 sigma_firmware_files[][24] = {
51 /* 50 MHz, supports 8 bit fractions */
57 /* Synchronous clock from pin */
58 "asix-sigma-50sync.fw",
59 /* Frequency counter */
60 "asix-sigma-phasor.fw",
63 static int sigma_read(void *buf, size_t size, struct dev_context *devc)
67 ret = ftdi_read_data(&devc->ftdic, (unsigned char *)buf, size);
69 sr_err("ftdi_read_data failed: %s",
70 ftdi_get_error_string(&devc->ftdic));
76 static int sigma_write(void *buf, size_t size, struct dev_context *devc)
80 ret = ftdi_write_data(&devc->ftdic, (unsigned char *)buf, size);
82 sr_err("ftdi_write_data failed: %s",
83 ftdi_get_error_string(&devc->ftdic));
84 } else if ((size_t) ret != size) {
85 sr_err("ftdi_write_data did not complete write.");
92 * NOTE: We chose the buffer size to be large enough to hold any write to the
93 * device. We still print a message just in case.
95 SR_PRIV int sigma_write_register(uint8_t reg, uint8_t *data, size_t len,
96 struct dev_context *devc)
102 if ((2 * len + 2) > sizeof(buf)) {
103 sr_err("Attempted to write %zu bytes, but buffer is too small.",
108 buf[idx++] = REG_ADDR_LOW | (reg & 0xf);
109 buf[idx++] = REG_ADDR_HIGH | (reg >> 4);
111 for (i = 0; i < len; i++) {
112 buf[idx++] = REG_DATA_LOW | (data[i] & 0xf);
113 buf[idx++] = REG_DATA_HIGH_WRITE | (data[i] >> 4);
116 return sigma_write(buf, idx, devc);
119 SR_PRIV int sigma_set_register(uint8_t reg, uint8_t value, struct dev_context *devc)
121 return sigma_write_register(reg, &value, 1, devc);
124 static int sigma_read_register(uint8_t reg, uint8_t *data, size_t len,
125 struct dev_context *devc)
129 buf[0] = REG_ADDR_LOW | (reg & 0xf);
130 buf[1] = REG_ADDR_HIGH | (reg >> 4);
131 buf[2] = REG_READ_ADDR;
133 sigma_write(buf, sizeof(buf), devc);
135 return sigma_read(data, len, devc);
138 static uint8_t sigma_get_register(uint8_t reg, struct dev_context *devc)
142 if (1 != sigma_read_register(reg, &value, 1, devc)) {
143 sr_err("sigma_get_register: 1 byte expected");
150 static int sigma_read_pos(uint32_t *stoppos, uint32_t *triggerpos,
151 struct dev_context *devc)
154 REG_ADDR_LOW | READ_TRIGGER_POS_LOW,
156 REG_READ_ADDR | NEXT_REG,
157 REG_READ_ADDR | NEXT_REG,
158 REG_READ_ADDR | NEXT_REG,
159 REG_READ_ADDR | NEXT_REG,
160 REG_READ_ADDR | NEXT_REG,
161 REG_READ_ADDR | NEXT_REG,
165 sigma_write(buf, sizeof(buf), devc);
167 sigma_read(result, sizeof(result), devc);
169 *triggerpos = result[0] | (result[1] << 8) | (result[2] << 16);
170 *stoppos = result[3] | (result[4] << 8) | (result[5] << 16);
172 /* Not really sure why this must be done, but according to spec. */
173 if ((--*stoppos & 0x1ff) == 0x1ff)
176 if ((*--triggerpos & 0x1ff) == 0x1ff)
182 static int sigma_read_dram(uint16_t startchunk, size_t numchunks,
183 uint8_t *data, struct dev_context *devc)
189 /* Send the startchunk. Index start with 1. */
191 buf[idx++] = startchunk >> 8;
192 buf[idx++] = startchunk & 0xff;
193 sigma_write_register(WRITE_MEMROW, buf, idx, devc);
197 buf[idx++] = REG_DRAM_BLOCK;
198 buf[idx++] = REG_DRAM_WAIT_ACK;
200 for (i = 0; i < numchunks; i++) {
201 /* Alternate bit to copy from DRAM to cache. */
202 if (i != (numchunks - 1))
203 buf[idx++] = REG_DRAM_BLOCK | (((i + 1) % 2) << 4);
205 buf[idx++] = REG_DRAM_BLOCK_DATA | ((i % 2) << 4);
207 if (i != (numchunks - 1))
208 buf[idx++] = REG_DRAM_WAIT_ACK;
211 sigma_write(buf, idx, devc);
213 return sigma_read(data, numchunks * CHUNK_SIZE, devc);
216 /* Upload trigger look-up tables to Sigma. */
217 SR_PRIV int sigma_write_trigger_lut(struct triggerlut *lut, struct dev_context *devc)
223 /* Transpose the table and send to Sigma. */
224 for (i = 0; i < 16; i++) {
229 if (lut->m2d[0] & bit)
231 if (lut->m2d[1] & bit)
233 if (lut->m2d[2] & bit)
235 if (lut->m2d[3] & bit)
245 if (lut->m0d[0] & bit)
247 if (lut->m0d[1] & bit)
249 if (lut->m0d[2] & bit)
251 if (lut->m0d[3] & bit)
254 if (lut->m1d[0] & bit)
256 if (lut->m1d[1] & bit)
258 if (lut->m1d[2] & bit)
260 if (lut->m1d[3] & bit)
263 sigma_write_register(WRITE_TRIGGER_SELECT0, tmp, sizeof(tmp),
265 sigma_set_register(WRITE_TRIGGER_SELECT1, 0x30 | i, devc);
268 /* Send the parameters */
269 sigma_write_register(WRITE_TRIGGER_SELECT0, (uint8_t *) &lut->params,
270 sizeof(lut->params), devc);
275 SR_PRIV void sigma_clear_helper(void *priv)
277 struct dev_context *devc;
281 ftdi_deinit(&devc->ftdic);
285 * Configure the FPGA for bitbang mode.
286 * This sequence is documented in section 2. of the ASIX Sigma programming
287 * manual. This sequence is necessary to configure the FPGA in the Sigma
288 * into Bitbang mode, in which it can be programmed with the firmware.
290 static int sigma_fpga_init_bitbang(struct dev_context *devc)
292 uint8_t suicide[] = {
293 0x84, 0x84, 0x88, 0x84, 0x88, 0x84, 0x88, 0x84,
295 uint8_t init_array[] = {
296 0x01, 0x03, 0x03, 0x01, 0x01, 0x01, 0x01, 0x01,
299 int i, ret, timeout = (10 * 1000);
302 /* Section 2. part 1), do the FPGA suicide. */
303 sigma_write(suicide, sizeof(suicide), devc);
304 sigma_write(suicide, sizeof(suicide), devc);
305 sigma_write(suicide, sizeof(suicide), devc);
306 sigma_write(suicide, sizeof(suicide), devc);
308 /* Section 2. part 2), do pulse on D1. */
309 sigma_write(init_array, sizeof(init_array), devc);
310 ftdi_usb_purge_buffers(&devc->ftdic);
312 /* Wait until the FPGA asserts D6/INIT_B. */
313 for (i = 0; i < timeout; i++) {
314 ret = sigma_read(&data, 1, devc);
317 /* Test if pin D6 got asserted. */
320 /* The D6 was not asserted yet, wait a bit. */
324 return SR_ERR_TIMEOUT;
328 * Configure the FPGA for logic-analyzer mode.
330 static int sigma_fpga_init_la(struct dev_context *devc)
332 /* Initialize the logic analyzer mode. */
333 uint8_t mode_regval = WMR_SDRAMINIT;
334 uint8_t logic_mode_start[] = {
335 REG_ADDR_LOW | (READ_ID & 0xf),
336 REG_ADDR_HIGH | (READ_ID >> 4),
337 REG_READ_ADDR, /* Read ID register. */
339 REG_ADDR_LOW | (WRITE_TEST & 0xf),
341 REG_DATA_HIGH_WRITE | 0x5,
342 REG_READ_ADDR, /* Read scratch register. */
345 REG_DATA_HIGH_WRITE | 0xa,
346 REG_READ_ADDR, /* Read scratch register. */
348 REG_ADDR_LOW | (WRITE_MODE & 0xf),
349 REG_DATA_LOW | (mode_regval & 0xf),
350 REG_DATA_HIGH_WRITE | (mode_regval >> 4),
356 /* Initialize the logic analyzer mode. */
357 sigma_write(logic_mode_start, sizeof(logic_mode_start), devc);
359 /* Expect a 3 byte reply since we issued three READ requests. */
360 ret = sigma_read(result, 3, devc);
364 if (result[0] != 0xa6 || result[1] != 0x55 || result[2] != 0xaa)
369 sr_err("Configuration failed. Invalid reply received.");
374 * Read the firmware from a file and transform it into a series of bitbang
375 * pulses used to program the FPGA. Note that the *bb_cmd must be free()'d
376 * by the caller of this function.
378 static int sigma_fw_2_bitbang(struct sr_context *ctx, const char *name,
379 uint8_t **bb_cmd, gsize *bb_cmd_size)
381 size_t i, file_size, bb_size;
383 uint8_t *bb_stream, *bbs;
388 /* Retrieve the on-disk firmware file content. */
389 firmware = sr_resource_load(ctx, SR_RESOURCE_FIRMWARE,
390 name, &file_size, 256 * 1024);
394 /* Unscramble the file content (XOR with "random" sequence). */
396 for (i = 0; i < file_size; i++) {
397 imm = (imm + 0xa853753) % 177 + (imm * 0x8034052);
398 firmware[i] ^= imm & 0xff;
402 * Generate a sequence of bitbang samples. With two samples per
403 * FPGA configuration bit, providing the level for the DIN signal
404 * as well as two edges for CCLK. See Xilinx UG332 for details
405 * ("slave serial" mode).
407 * Note that CCLK is inverted in hardware. That's why the
408 * respective bit is first set and then cleared in the bitbang
409 * sample sets. So that the DIN level will be stable when the
410 * data gets sampled at the rising CCLK edge, and the signals'
411 * setup time constraint will be met.
413 * The caller will put the FPGA into download mode, will send
414 * the bitbang samples, and release the allocated memory.
416 bb_size = file_size * 8 * 2;
417 bb_stream = (uint8_t *)g_try_malloc(bb_size);
419 sr_err("%s: Failed to allocate bitbang stream", __func__);
424 for (i = 0; i < file_size; i++) {
425 for (bit = 7; bit >= 0; bit--) {
426 v = (firmware[i] & (1 << bit)) ? 0x40 : 0x00;
432 /* The transformation completed successfully, return the result. */
434 *bb_cmd_size = bb_size;
441 static int upload_firmware(struct sr_context *ctx,
442 int firmware_idx, struct dev_context *devc)
448 const char *firmware;
449 struct ftdi_context *ftdic;
451 /* Avoid downloading the same firmware multiple times. */
452 firmware = sigma_firmware_files[firmware_idx];
453 if (devc->cur_firmware == firmware_idx) {
454 sr_info("Not uploading firmware file '%s' again.", firmware);
458 /* Make sure it's an ASIX SIGMA. */
459 ftdic = &devc->ftdic;
460 ret = ftdi_usb_open_desc(ftdic, USB_VENDOR, USB_PRODUCT,
461 USB_DESCRIPTION, NULL);
463 sr_err("ftdi_usb_open failed: %s",
464 ftdi_get_error_string(ftdic));
468 ret = ftdi_set_bitmode(ftdic, 0xdf, BITMODE_BITBANG);
470 sr_err("ftdi_set_bitmode failed: %s",
471 ftdi_get_error_string(ftdic));
475 /* Four times the speed of sigmalogan - Works well. */
476 ret = ftdi_set_baudrate(ftdic, 750 * 1000);
478 sr_err("ftdi_set_baudrate failed: %s",
479 ftdi_get_error_string(ftdic));
483 /* Initialize the FPGA for firmware upload. */
484 ret = sigma_fpga_init_bitbang(devc);
488 /* Prepare firmware. */
489 ret = sigma_fw_2_bitbang(ctx, firmware, &buf, &buf_size);
491 sr_err("An error occurred while reading the firmware: %s",
496 /* Upload firmware. */
497 sr_info("Uploading firmware file '%s'.", firmware);
498 sigma_write(buf, buf_size, devc);
502 ret = ftdi_set_bitmode(ftdic, 0x00, BITMODE_RESET);
504 sr_err("ftdi_set_bitmode failed: %s",
505 ftdi_get_error_string(ftdic));
509 ftdi_usb_purge_buffers(ftdic);
511 /* Discard garbage. */
512 while (sigma_read(&pins, 1, devc) == 1)
515 /* Initialize the FPGA for logic-analyzer mode. */
516 ret = sigma_fpga_init_la(devc);
520 devc->cur_firmware = firmware_idx;
522 sr_info("Firmware uploaded.");
528 * Sigma doesn't support limiting the number of samples, so we have to
529 * translate the number and the samplerate to an elapsed time.
531 * In addition we need to ensure that the last data cluster has passed
532 * the hardware pipeline, and became available to the PC side. With RLE
533 * compression up to 327ms could pass before another cluster accumulates
534 * at 200kHz samplerate when input pins don't change.
536 SR_PRIV uint64_t sigma_limit_samples_to_msec(const struct dev_context *devc,
537 uint64_t limit_samples)
540 uint64_t worst_cluster_time_ms;
542 limit_msec = limit_samples * 1000 / devc->cur_samplerate;
543 worst_cluster_time_ms = 65536 * 1000 / devc->cur_samplerate;
545 * One cluster time is not enough to flush pipeline when sampling
546 * grounded pins with 1 sample limit at 200kHz. Hence the 2* fix.
548 return limit_msec + 2 * worst_cluster_time_ms;
551 SR_PRIV int sigma_set_samplerate(const struct sr_dev_inst *sdi, uint64_t samplerate)
553 struct dev_context *devc;
554 struct drv_context *drvc;
560 drvc = sdi->driver->context;
563 /* Reject rates that are not in the list of supported rates. */
564 for (i = 0; i < samplerates_count; i++) {
565 if (samplerates[i] == samplerate)
568 if (i >= samplerates_count || samplerates[i] == 0)
569 return SR_ERR_SAMPLERATE;
572 * Depending on the samplerates of 200/100/50- MHz, specific
573 * firmware is required and higher rates might limit the set
574 * of available channels.
576 num_channels = devc->num_channels;
577 if (samplerate <= SR_MHZ(50)) {
578 ret = upload_firmware(drvc->sr_ctx, 0, devc);
580 } else if (samplerate == SR_MHZ(100)) {
581 ret = upload_firmware(drvc->sr_ctx, 1, devc);
583 } else if (samplerate == SR_MHZ(200)) {
584 ret = upload_firmware(drvc->sr_ctx, 2, devc);
589 * Derive the sample period from the sample rate as well as the
590 * number of samples that the device will communicate within
591 * an "event" (memory organization internal to the device).
594 devc->num_channels = num_channels;
595 devc->cur_samplerate = samplerate;
596 devc->samples_per_event = 16 / devc->num_channels;
597 devc->state.state = SIGMA_IDLE;
601 * Support for "limit_samples" is implemented by stopping
602 * acquisition after a corresponding period of time.
603 * Re-calculate that period of time, in case the limit is
604 * set first and the samplerate gets (re-)configured later.
606 if (ret == SR_OK && devc->limit_samples) {
608 msecs = sigma_limit_samples_to_msec(devc, devc->limit_samples);
609 devc->limit_msec = msecs;
616 * In 100 and 200 MHz mode, only a single pin rising/falling can be
617 * set as trigger. In other modes, two rising/falling triggers can be set,
618 * in addition to value/mask trigger for any number of channels.
620 * The Sigma supports complex triggers using boolean expressions, but this
621 * has not been implemented yet.
623 SR_PRIV int sigma_convert_trigger(const struct sr_dev_inst *sdi)
625 struct dev_context *devc;
626 struct sr_trigger *trigger;
627 struct sr_trigger_stage *stage;
628 struct sr_trigger_match *match;
630 int channelbit, trigger_set;
633 memset(&devc->trigger, 0, sizeof(struct sigma_trigger));
634 if (!(trigger = sr_session_trigger_get(sdi->session)))
638 for (l = trigger->stages; l; l = l->next) {
640 for (m = stage->matches; m; m = m->next) {
642 if (!match->channel->enabled)
643 /* Ignore disabled channels with a trigger. */
645 channelbit = 1 << (match->channel->index);
646 if (devc->cur_samplerate >= SR_MHZ(100)) {
647 /* Fast trigger support. */
649 sr_err("Only a single pin trigger is "
650 "supported in 100 and 200MHz mode.");
653 if (match->match == SR_TRIGGER_FALLING)
654 devc->trigger.fallingmask |= channelbit;
655 else if (match->match == SR_TRIGGER_RISING)
656 devc->trigger.risingmask |= channelbit;
658 sr_err("Only rising/falling trigger is "
659 "supported in 100 and 200MHz mode.");
665 /* Simple trigger support (event). */
666 if (match->match == SR_TRIGGER_ONE) {
667 devc->trigger.simplevalue |= channelbit;
668 devc->trigger.simplemask |= channelbit;
670 else if (match->match == SR_TRIGGER_ZERO) {
671 devc->trigger.simplevalue &= ~channelbit;
672 devc->trigger.simplemask |= channelbit;
674 else if (match->match == SR_TRIGGER_FALLING) {
675 devc->trigger.fallingmask |= channelbit;
678 else if (match->match == SR_TRIGGER_RISING) {
679 devc->trigger.risingmask |= channelbit;
684 * Actually, Sigma supports 2 rising/falling triggers,
685 * but they are ORed and the current trigger syntax
686 * does not permit ORed triggers.
688 if (trigger_set > 1) {
689 sr_err("Only 1 rising/falling trigger "
701 /* Software trigger to determine exact trigger position. */
702 static int get_trigger_offset(uint8_t *samples, uint16_t last_sample,
703 struct sigma_trigger *t)
708 for (i = 0; i < 8; i++) {
710 last_sample = sample;
711 sample = samples[2 * i] | (samples[2 * i + 1] << 8);
713 /* Simple triggers. */
714 if ((sample & t->simplemask) != t->simplevalue)
718 if (((last_sample & t->risingmask) != 0) ||
719 ((sample & t->risingmask) != t->risingmask))
723 if ((last_sample & t->fallingmask) != t->fallingmask ||
724 (sample & t->fallingmask) != 0)
730 /* If we did not match, return original trigger pos. */
735 * Return the timestamp of "DRAM cluster".
737 static uint16_t sigma_dram_cluster_ts(struct sigma_dram_cluster *cluster)
739 return (cluster->timestamp_hi << 8) | cluster->timestamp_lo;
743 * Return one 16bit data entity of a DRAM cluster at the specified index.
745 static uint16_t sigma_dram_cluster_data(struct sigma_dram_cluster *cl, int idx)
750 sample |= cl->samples[idx].sample_lo << 0;
751 sample |= cl->samples[idx].sample_hi << 8;
752 sample = (sample >> 8) | (sample << 8);
757 * Deinterlace sample data that was retrieved at 100MHz samplerate.
758 * One 16bit item contains two samples of 8bits each. The bits of
759 * multiple samples are interleaved.
761 static uint16_t sigma_deinterlace_100mhz_data(uint16_t indata, int idx)
767 outdata |= (indata >> (0 * 2 - 0)) & (1 << 0);
768 outdata |= (indata >> (1 * 2 - 1)) & (1 << 1);
769 outdata |= (indata >> (2 * 2 - 2)) & (1 << 2);
770 outdata |= (indata >> (3 * 2 - 3)) & (1 << 3);
771 outdata |= (indata >> (4 * 2 - 4)) & (1 << 4);
772 outdata |= (indata >> (5 * 2 - 5)) & (1 << 5);
773 outdata |= (indata >> (6 * 2 - 6)) & (1 << 6);
774 outdata |= (indata >> (7 * 2 - 7)) & (1 << 7);
779 * Deinterlace sample data that was retrieved at 200MHz samplerate.
780 * One 16bit item contains four samples of 4bits each. The bits of
781 * multiple samples are interleaved.
783 static uint16_t sigma_deinterlace_200mhz_data(uint16_t indata, int idx)
789 outdata |= (indata >> (0 * 4 - 0)) & (1 << 0);
790 outdata |= (indata >> (1 * 4 - 1)) & (1 << 1);
791 outdata |= (indata >> (2 * 4 - 2)) & (1 << 2);
792 outdata |= (indata >> (3 * 4 - 3)) & (1 << 3);
796 static void store_sr_sample(uint8_t *samples, int idx, uint16_t data)
798 samples[2 * idx + 0] = (data >> 0) & 0xff;
799 samples[2 * idx + 1] = (data >> 8) & 0xff;
803 * Local wrapper around sr_session_send() calls. Make sure to not send
804 * more samples to the session's datafeed than what was requested by a
805 * previously configured (optional) sample count.
807 static void sigma_session_send(struct sr_dev_inst *sdi,
808 struct sr_datafeed_packet *packet)
810 struct dev_context *devc;
811 struct sr_datafeed_logic *logic;
815 if (devc->limit_samples) {
816 logic = (void *)packet->payload;
817 send_now = logic->length / logic->unitsize;
818 if (devc->sent_samples + send_now > devc->limit_samples) {
819 send_now = devc->limit_samples - devc->sent_samples;
820 logic->length = send_now * logic->unitsize;
824 devc->sent_samples += send_now;
827 sr_session_send(sdi, packet);
831 * This size translates to: event count (1K events per cluster), times
832 * the sample width (unitsize, 16bits per event), times the maximum
833 * number of samples per event.
835 #define SAMPLES_BUFFER_SIZE (1024 * 2 * 4)
837 static void sigma_decode_dram_cluster(struct sigma_dram_cluster *dram_cluster,
838 unsigned int events_in_cluster,
839 unsigned int triggered,
840 struct sr_dev_inst *sdi)
842 struct dev_context *devc = sdi->priv;
843 struct sigma_state *ss = &devc->state;
844 struct sr_datafeed_packet packet;
845 struct sr_datafeed_logic logic;
846 uint16_t tsdiff, ts, sample, item16;
847 uint8_t samples[SAMPLES_BUFFER_SIZE];
849 size_t send_count, trig_count;
853 ts = sigma_dram_cluster_ts(dram_cluster);
854 tsdiff = ts - ss->lastts;
855 ss->lastts = ts + EVENTS_PER_CLUSTER;
857 packet.type = SR_DF_LOGIC;
858 packet.payload = &logic;
860 logic.data = samples;
863 * If this cluster is not adjacent to the previously received
864 * cluster, then send the appropriate number of samples with the
865 * previous values to the sigrok session. This "decodes RLE".
867 for (ts = 0; ts < tsdiff; ts++) {
869 store_sr_sample(samples, i, ss->lastsample);
872 * If we have 1024 samples ready or we're at the
873 * end of submitting the padding samples, submit
874 * the packet to Sigrok. Since constant data is
875 * sent, duplication of data for rates above 50MHz
878 if ((i == 1023) || (ts == tsdiff - 1)) {
879 logic.length = (i + 1) * logic.unitsize;
880 for (j = 0; j < devc->samples_per_event; j++)
881 sigma_session_send(sdi, &packet);
886 * Parse the samples in current cluster and prepare them
887 * to be submitted to Sigrok. Cope with memory layouts that
888 * vary with the samplerate.
890 send_ptr = &samples[0];
893 for (i = 0; i < events_in_cluster; i++) {
894 item16 = sigma_dram_cluster_data(dram_cluster, i);
895 if (devc->cur_samplerate == SR_MHZ(200)) {
896 sample = sigma_deinterlace_200mhz_data(item16, 0);
897 store_sr_sample(samples, send_count++, sample);
898 sample = sigma_deinterlace_200mhz_data(item16, 1);
899 store_sr_sample(samples, send_count++, sample);
900 sample = sigma_deinterlace_200mhz_data(item16, 2);
901 store_sr_sample(samples, send_count++, sample);
902 sample = sigma_deinterlace_200mhz_data(item16, 3);
903 store_sr_sample(samples, send_count++, sample);
904 } else if (devc->cur_samplerate == SR_MHZ(100)) {
905 sample = sigma_deinterlace_100mhz_data(item16, 0);
906 store_sr_sample(samples, send_count++, sample);
907 sample = sigma_deinterlace_100mhz_data(item16, 1);
908 store_sr_sample(samples, send_count++, sample);
911 store_sr_sample(samples, send_count++, sample);
916 * If a trigger position applies, then provide the datafeed with
917 * the first part of data up to that position, then send the
920 int trigger_offset = 0;
923 * Trigger is not always accurate to sample because of
924 * pipeline delay. However, it always triggers before
925 * the actual event. We therefore look at the next
926 * samples to pinpoint the exact position of the trigger.
928 trigger_offset = get_trigger_offset(samples,
929 ss->lastsample, &devc->trigger);
931 if (trigger_offset > 0) {
932 trig_count = trigger_offset * devc->samples_per_event;
933 packet.type = SR_DF_LOGIC;
934 logic.length = trig_count * logic.unitsize;
935 sigma_session_send(sdi, &packet);
936 send_ptr += trig_count * logic.unitsize;
937 send_count -= trig_count;
940 /* Only send trigger if explicitly enabled. */
941 if (devc->use_triggers) {
942 packet.type = SR_DF_TRIGGER;
943 sr_session_send(sdi, &packet);
948 * Send the data after the trigger, or all of the received data
949 * if no trigger position applies.
952 packet.type = SR_DF_LOGIC;
953 logic.length = send_count * logic.unitsize;
954 logic.data = send_ptr;
955 sigma_session_send(sdi, &packet);
958 ss->lastsample = sample;
962 * Decode chunk of 1024 bytes, 64 clusters, 7 events per cluster.
963 * Each event is 20ns apart, and can contain multiple samples.
965 * For 200 MHz, events contain 4 samples for each channel, spread 5 ns apart.
966 * For 100 MHz, events contain 2 samples for each channel, spread 10 ns apart.
967 * For 50 MHz and below, events contain one sample for each channel,
968 * spread 20 ns apart.
970 static int decode_chunk_ts(struct sigma_dram_line *dram_line,
971 uint16_t events_in_line,
972 uint32_t trigger_event,
973 struct sr_dev_inst *sdi)
975 struct sigma_dram_cluster *dram_cluster;
976 struct dev_context *devc;
977 unsigned int clusters_in_line;
978 unsigned int events_in_cluster;
980 uint32_t trigger_cluster, triggered;
983 clusters_in_line = events_in_line;
984 clusters_in_line += EVENTS_PER_CLUSTER - 1;
985 clusters_in_line /= EVENTS_PER_CLUSTER;
986 trigger_cluster = ~0;
989 /* Check if trigger is in this chunk. */
990 if (trigger_event < (64 * 7)) {
991 if (devc->cur_samplerate <= SR_MHZ(50)) {
992 trigger_event -= MIN(EVENTS_PER_CLUSTER - 1,
996 /* Find in which cluster the trigger occurred. */
997 trigger_cluster = trigger_event / EVENTS_PER_CLUSTER;
1000 /* For each full DRAM cluster. */
1001 for (i = 0; i < clusters_in_line; i++) {
1002 dram_cluster = &dram_line->cluster[i];
1004 /* The last cluster might not be full. */
1005 if ((i == clusters_in_line - 1) &&
1006 (events_in_line % EVENTS_PER_CLUSTER)) {
1007 events_in_cluster = events_in_line % EVENTS_PER_CLUSTER;
1009 events_in_cluster = EVENTS_PER_CLUSTER;
1012 triggered = (i == trigger_cluster);
1013 sigma_decode_dram_cluster(dram_cluster, events_in_cluster,
1020 static int download_capture(struct sr_dev_inst *sdi)
1022 const uint32_t chunks_per_read = 32;
1024 struct dev_context *devc;
1025 struct sigma_dram_line *dram_line;
1027 uint32_t stoppos, triggerpos;
1030 uint32_t dl_lines_total, dl_lines_curr, dl_lines_done;
1031 uint32_t dl_first_line, dl_line;
1032 uint32_t dl_events_in_line;
1033 uint32_t trg_line, trg_event;
1036 dl_events_in_line = 64 * 7;
1040 dram_line = g_try_malloc0(chunks_per_read * sizeof(*dram_line));
1044 sr_info("Downloading sample data.");
1047 * Ask the hardware to stop data acquisition. Reception of the
1048 * FORCESTOP request makes the hardware "disable RLE" (store
1049 * clusters to DRAM regardless of whether pin state changes) and
1050 * raise the POSTTRIGGERED flag.
1052 sigma_set_register(WRITE_MODE, WMR_FORCESTOP | WMR_SDRAMWRITEEN, devc);
1054 modestatus = sigma_get_register(READ_MODE, devc);
1055 } while (!(modestatus & RMR_POSTTRIGGERED));
1057 /* Set SDRAM Read Enable. */
1058 sigma_set_register(WRITE_MODE, WMR_SDRAMREADEN, devc);
1060 /* Get the current position. */
1061 sigma_read_pos(&stoppos, &triggerpos, devc);
1063 /* Check if trigger has fired. */
1064 modestatus = sigma_get_register(READ_MODE, devc);
1065 if (modestatus & RMR_TRIGGERED) {
1066 trg_line = triggerpos >> 9;
1067 trg_event = triggerpos & 0x1ff;
1070 devc->sent_samples = 0;
1073 * Determine how many "DRAM lines" of 1024 bytes each we need to
1074 * retrieve from the Sigma hardware, so that we have a complete
1075 * set of samples. Note that the last line need not contain 64
1076 * clusters, it might be partially filled only.
1078 * When RMR_ROUND is set, the circular buffer in DRAM has wrapped
1079 * around. Since the status of the very next line is uncertain in
1080 * that case, we skip it and start reading from the next line. The
1081 * circular buffer has 32K lines (0x8000).
1083 dl_lines_total = (stoppos >> 9) + 1;
1084 if (modestatus & RMR_ROUND) {
1085 dl_first_line = dl_lines_total + 1;
1086 dl_lines_total = 0x8000 - 2;
1091 while (dl_lines_total > dl_lines_done) {
1092 /* We can download only up-to 32 DRAM lines in one go! */
1093 dl_lines_curr = MIN(chunks_per_read, dl_lines_total - dl_lines_done);
1095 dl_line = dl_first_line + dl_lines_done;
1097 bufsz = sigma_read_dram(dl_line, dl_lines_curr,
1098 (uint8_t *)dram_line, devc);
1099 /* TODO: Check bufsz. For now, just avoid compiler warnings. */
1102 /* This is the first DRAM line, so find the initial timestamp. */
1103 if (dl_lines_done == 0) {
1104 devc->state.lastts =
1105 sigma_dram_cluster_ts(&dram_line[0].cluster[0]);
1106 devc->state.lastsample = 0;
1109 for (i = 0; i < dl_lines_curr; i++) {
1110 uint32_t trigger_event = ~0;
1111 /* The last "DRAM line" can be only partially full. */
1112 if (dl_lines_done + i == dl_lines_total - 1)
1113 dl_events_in_line = stoppos & 0x1ff;
1115 /* Test if the trigger happened on this line. */
1116 if (dl_lines_done + i == trg_line)
1117 trigger_event = trg_event;
1119 decode_chunk_ts(dram_line + i, dl_events_in_line,
1120 trigger_event, sdi);
1123 dl_lines_done += dl_lines_curr;
1126 std_session_send_df_end(sdi);
1128 sdi->driver->dev_acquisition_stop(sdi);
1136 * Periodically check the Sigma status when in CAPTURE mode. This routine
1137 * checks whether the configured sample count or sample time have passed,
1138 * and will stop acquisition and download the acquired samples.
1140 static int sigma_capture_mode(struct sr_dev_inst *sdi)
1142 struct dev_context *devc;
1143 uint64_t running_msec;
1144 uint64_t current_time;
1149 * Check if the selected sampling duration passed. Sample count
1150 * limits are covered by this enforced timeout as well.
1152 current_time = g_get_monotonic_time();
1153 running_msec = (current_time - devc->start_time) / 1000;
1154 if (running_msec >= devc->limit_msec)
1155 return download_capture(sdi);
1160 SR_PRIV int sigma_receive_data(int fd, int revents, void *cb_data)
1162 struct sr_dev_inst *sdi;
1163 struct dev_context *devc;
1171 if (devc->state.state == SIGMA_IDLE)
1174 if (devc->state.state == SIGMA_CAPTURE)
1175 return sigma_capture_mode(sdi);
1180 /* Build a LUT entry used by the trigger functions. */
1181 static void build_lut_entry(uint16_t value, uint16_t mask, uint16_t *entry)
1185 /* For each quad channel. */
1186 for (i = 0; i < 4; i++) {
1189 /* For each bit in LUT. */
1190 for (j = 0; j < 16; j++)
1192 /* For each channel in quad. */
1193 for (k = 0; k < 4; k++) {
1194 bit = 1 << (i * 4 + k);
1196 /* Set bit in entry */
1197 if ((mask & bit) && ((!(value & bit)) !=
1199 entry[i] &= ~(1 << j);
1204 /* Add a logical function to LUT mask. */
1205 static void add_trigger_function(enum triggerop oper, enum triggerfunc func,
1206 int index, int neg, uint16_t *mask)
1209 int x[2][2], tmp, a, b, aset, bset, rset;
1211 memset(x, 0, 4 * sizeof(int));
1213 /* Trigger detect condition. */
1243 case OP_NOTRISEFALL:
1249 /* Transpose if neg is set. */
1251 for (i = 0; i < 2; i++) {
1252 for (j = 0; j < 2; j++) {
1254 x[i][j] = x[1 - i][1 - j];
1255 x[1 - i][1 - j] = tmp;
1260 /* Update mask with function. */
1261 for (i = 0; i < 16; i++) {
1262 a = (i >> (2 * index + 0)) & 1;
1263 b = (i >> (2 * index + 1)) & 1;
1265 aset = (*mask >> i) & 1;
1269 if (func == FUNC_AND || func == FUNC_NAND)
1271 else if (func == FUNC_OR || func == FUNC_NOR)
1273 else if (func == FUNC_XOR || func == FUNC_NXOR)
1276 if (func == FUNC_NAND || func == FUNC_NOR || func == FUNC_NXOR)
1287 * Build trigger LUTs used by 50 MHz and lower sample rates for supporting
1288 * simple pin change and state triggers. Only two transitions (rise/fall) can be
1289 * set at any time, but a full mask and value can be set (0/1).
1291 SR_PRIV int sigma_build_basic_trigger(struct triggerlut *lut, struct dev_context *devc)
1294 uint16_t masks[2] = { 0, 0 };
1296 memset(lut, 0, sizeof(struct triggerlut));
1298 /* Constant for simple triggers. */
1301 /* Value/mask trigger support. */
1302 build_lut_entry(devc->trigger.simplevalue, devc->trigger.simplemask,
1305 /* Rise/fall trigger support. */
1306 for (i = 0, j = 0; i < 16; i++) {
1307 if (devc->trigger.risingmask & (1 << i) ||
1308 devc->trigger.fallingmask & (1 << i))
1309 masks[j++] = 1 << i;
1312 build_lut_entry(masks[0], masks[0], lut->m0d);
1313 build_lut_entry(masks[1], masks[1], lut->m1d);
1315 /* Add glue logic */
1316 if (masks[0] || masks[1]) {
1317 /* Transition trigger. */
1318 if (masks[0] & devc->trigger.risingmask)
1319 add_trigger_function(OP_RISE, FUNC_OR, 0, 0, &lut->m3);
1320 if (masks[0] & devc->trigger.fallingmask)
1321 add_trigger_function(OP_FALL, FUNC_OR, 0, 0, &lut->m3);
1322 if (masks[1] & devc->trigger.risingmask)
1323 add_trigger_function(OP_RISE, FUNC_OR, 1, 0, &lut->m3);
1324 if (masks[1] & devc->trigger.fallingmask)
1325 add_trigger_function(OP_FALL, FUNC_OR, 1, 0, &lut->m3);
1327 /* Only value/mask trigger. */
1331 /* Triggertype: event. */
1332 lut->params.selres = 3;