2 * This file is part of the sigrok project.
4 * Copyright (C) 2011 Uwe Hermann <uwe@hermann-uwe.de>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25 #include "sigrok-internal.h"
27 #define USB_VENDOR_ID 0x0403
28 #define USB_PRODUCT_ID 0x6001
29 #define USB_DESCRIPTION "ChronoVu LA8"
30 #define USB_VENDOR_NAME "ChronoVu"
31 #define USB_MODEL_NAME "LA8"
32 #define USB_MODEL_VERSION ""
35 #define TRIGGER_TYPES "01"
36 #define SDRAM_SIZE (8 * 1024 * 1024)
37 #define MIN_NUM_SAMPLES 1
39 #define BS 4096 /* Block size */
40 #define NUM_BLOCKS 2048 /* Number of blocks */
42 static GSList *device_instances = NULL;
44 static const char *probe_names[NUM_PROBES + 1] = {
57 /** FTDI device context (used by libftdi). */
58 struct ftdi_context *ftdic;
60 /** The currently configured samplerate of the device. */
61 uint64_t cur_samplerate;
63 /** period in picoseconds corresponding to the samplerate */
66 /** The current sampling limit (in ms). */
69 /** The current sampling limit (in number of samples). */
70 uint64_t limit_samples;
76 * A buffer containing some (mangled) samples from the device.
77 * Format: Pretty mangled-up (due to hardware reasons), see code.
79 uint8_t mangled_buf[BS];
82 * An 8MB buffer where we'll store the de-mangled samples.
83 * Format: Each sample is 1 byte, MSB is channel 7, LSB is channel 0.
88 * Trigger pattern (MSB = channel 7, LSB = channel 0).
89 * A 1 bit matches a high signal, 0 matches a low signal on a probe.
90 * Only low/high triggers (but not e.g. rising/falling) are supported.
92 uint8_t trigger_pattern;
95 * Trigger mask (MSB = channel 7, LSB = channel 0).
96 * A 1 bit means "must match trigger_pattern", 0 means "don't care".
100 /** Time (in seconds) before the trigger times out. */
101 uint64_t trigger_timeout;
103 /** Tells us whether an SR_DF_TRIGGER packet was already sent. */
109 /** Counter/index for the data block to be read. */
112 /** The divcount value (determines the sample period) for the LA8. */
116 /* This will be initialized via hw_get_device_info()/SR_DI_SAMPLERATES. */
117 static uint64_t supported_samplerates[255 + 1] = { 0 };
120 * Min: 1 sample per 0.01us -> sample time is 0.084s, samplerate 100MHz
121 * Max: 1 sample per 2.55us -> sample time is 21.391s, samplerate 392.15kHz
123 static struct sr_samplerates samplerates = {
127 .list = supported_samplerates,
130 /* Note: Continuous sampling is not supported by the hardware. */
131 static int capabilities[] = {
132 SR_HWCAP_LOGIC_ANALYZER,
134 SR_HWCAP_LIMIT_MSEC, /* TODO: Not yet implemented. */
135 SR_HWCAP_LIMIT_SAMPLES, /* TODO: Not yet implemented. */
139 /* Function prototypes. */
140 static int la8_close_usb_reset_sequencer(struct la8 *la8);
141 static void hw_stop_acquisition(int device_index, gpointer session_data);
142 static int la8_reset(struct la8 *la8);
144 static void fill_supported_samplerates_if_needed(void)
148 /* Do nothing if supported_samplerates[] is already filled. */
149 if (supported_samplerates[0] != 0)
152 /* Fill supported_samplerates[] with the proper values. */
153 for (i = 0; i < 255; i++)
154 supported_samplerates[254 - i] = SR_MHZ(100) / (i + 1);
155 supported_samplerates[255] = 0;
159 * Check if the given samplerate is supported by the LA8 hardware.
161 * @param samplerate The samplerate (in Hz) to check.
162 * @return 1 if the samplerate is supported/valid, 0 otherwise.
164 static int is_valid_samplerate(uint64_t samplerate)
168 fill_supported_samplerates_if_needed();
170 for (i = 0; i < 255; i++) {
171 if (supported_samplerates[i] == samplerate)
175 sr_warn("la8: %s: invalid samplerate (%" PRIu64 "Hz)",
176 __func__, samplerate);
182 * Convert a samplerate (in Hz) to the 'divcount' value the LA8 wants.
184 * LA8 hardware: sample period = (divcount + 1) * 10ns.
185 * Min. value for divcount: 0x00 (10ns sample period, 100MHz samplerate).
186 * Max. value for divcount: 0xfe (2550ns sample period, 392.15kHz samplerate).
188 * @param samplerate The samplerate in Hz.
189 * @return The divcount value as needed by the hardware, or 0xff upon errors.
191 static uint8_t samplerate_to_divcount(uint64_t samplerate)
193 if (samplerate == 0) {
194 sr_err("la8: %s: samplerate was 0", __func__);
198 if (!is_valid_samplerate(samplerate)) {
199 sr_err("la8: %s: can't get divcount, samplerate invalid",
204 return (SR_MHZ(100) / samplerate) - 1;
208 * Write data of a certain length to the LA8's FTDI device.
210 * @param la8 The LA8 struct containing private per-device-instance data.
211 * @param buf The buffer containing the data to write.
212 * @param size The number of bytes to write.
213 * @return The number of bytes written, or a negative value upon errors.
215 static int la8_write(struct la8 *la8, uint8_t *buf, int size)
220 sr_err("la8: %s: la8 was NULL", __func__);
225 sr_err("la8: %s: la8->ftdic was NULL", __func__);
230 sr_err("la8: %s: buf was NULL", __func__);
235 sr_err("la8: %s: size was < 0", __func__);
239 bytes_written = ftdi_write_data(la8->ftdic, buf, size);
241 if (bytes_written < 0) {
242 sr_warn("la8: %s: ftdi_write_data: (%d) %s", __func__,
243 bytes_written, ftdi_get_error_string(la8->ftdic));
244 (void) la8_close_usb_reset_sequencer(la8); /* Ignore errors. */
245 } else if (bytes_written != size) {
246 sr_warn("la8: %s: bytes to write: %d, bytes written: %d",
247 __func__, size, bytes_written);
248 (void) la8_close_usb_reset_sequencer(la8); /* Ignore errors. */
251 return bytes_written;
255 * Read a certain amount of bytes from the LA8's FTDI device.
257 * @param la8 The LA8 struct containing private per-device-instance data.
258 * @param buf The buffer where the received data will be stored.
259 * @param size The number of bytes to read.
260 * @return The number of bytes read, or a negative value upon errors.
262 static int la8_read(struct la8 *la8, uint8_t *buf, int size)
267 sr_err("la8: %s: la8 was NULL", __func__);
272 sr_err("la8: %s: la8->ftdic was NULL", __func__);
277 sr_err("la8: %s: buf was NULL", __func__);
282 sr_err("la8: %s: size was <= 0", __func__);
286 bytes_read = ftdi_read_data(la8->ftdic, buf, size);
288 if (bytes_read < 0) {
289 sr_warn("la8: %s: ftdi_read_data: (%d) %s", __func__,
290 bytes_read, ftdi_get_error_string(la8->ftdic));
291 } else if (bytes_read != size) {
292 // sr_warn("la8: %s: bytes to read: %d, bytes read: %d",
293 // __func__, size, bytes_read);
299 static int la8_close(struct la8 *la8)
304 sr_err("la8: %s: la8 was NULL", __func__);
309 sr_err("la8: %s: la8->ftdic was NULL", __func__);
313 if ((ret = ftdi_usb_close(la8->ftdic)) < 0) {
314 sr_warn("la8: %s: ftdi_usb_close: (%d) %s",
315 __func__, ret, ftdi_get_error_string(la8->ftdic));
322 * Close the ChronoVu LA8 USB port and reset the LA8 sequencer logic.
324 * @param la8 The LA8 struct containing private per-device-instance data.
325 * @return SR_OK upon success, SR_ERR upon failure.
327 static int la8_close_usb_reset_sequencer(struct la8 *la8)
329 /* Magic sequence of bytes for resetting the LA8 sequencer logic. */
330 uint8_t buf[8] = {0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01};
333 sr_spew("la8: entering %s", __func__);
336 sr_err("la8: %s: la8 was NULL", __func__);
341 sr_err("la8: %s: la8->ftdic was NULL", __func__);
345 if (la8->ftdic->usb_dev) {
346 /* Reset the LA8 sequencer logic, then wait 100ms. */
347 sr_dbg("la8: resetting sequencer logic");
348 (void) la8_write(la8, buf, 8); /* Ignore errors. */
349 g_usleep(100 * 1000);
351 /* Purge FTDI buffers, then reset and close the FTDI device. */
352 sr_dbg("la8: purging buffers, resetting+closing FTDI device");
354 /* Log errors, but ignore them (i.e., don't abort). */
355 if ((ret = ftdi_usb_purge_buffers(la8->ftdic)) < 0)
356 sr_warn("la8: %s: ftdi_usb_purge_buffers: (%d) %s",
357 __func__, ret, ftdi_get_error_string(la8->ftdic));
358 if ((ret = ftdi_usb_reset(la8->ftdic)) < 0)
359 sr_warn("la8: %s: ftdi_usb_reset: (%d) %s", __func__,
360 ret, ftdi_get_error_string(la8->ftdic));
361 if ((ret = ftdi_usb_close(la8->ftdic)) < 0)
362 sr_warn("la8: %s: ftdi_usb_close: (%d) %s", __func__,
363 ret, ftdi_get_error_string(la8->ftdic));
365 sr_spew("la8: %s: usb_dev was NULL, nothing to do", __func__);
368 ftdi_free(la8->ftdic); /* Returns void. */
375 * Reset the ChronoVu LA8.
377 * The LA8 must be reset after a failed read/write operation or upon timeouts.
379 * @param la8 The LA8 struct containing private per-device-instance data.
380 * @return SR_OK upon success, SR_ERR upon failure.
382 static int la8_reset(struct la8 *la8)
389 sr_err("la8: %s: la8 was NULL", __func__);
394 sr_err("la8: %s: la8->ftdic was NULL", __func__);
398 sr_dbg("la8: resetting the device");
401 * Purge pending read data from the FTDI hardware FIFO until
402 * no more data is left, or a timeout occurs (after 20s).
404 done = 20 + time(NULL);
406 /* TODO: Ignore errors? Check for < 0 at least! */
407 bytes_read = la8_read(la8, (uint8_t *)&buf, BS);
409 } while ((done > now) && (bytes_read > 0));
411 /* Reset the LA8 sequencer logic and close the USB port. */
412 (void) la8_close_usb_reset_sequencer(la8); /* Ignore errors. */
414 sr_dbg("la8: device reset finished");
419 static int configure_probes(struct la8 *la8, GSList *probes)
421 struct sr_probe *probe;
426 la8->trigger_pattern = 0;
427 la8->trigger_mask = 0; /* Default to "don't care" for all probes. */
429 for (l = probes; l; l = l->next) {
430 probe = (struct sr_probe *)l->data;
433 sr_err("la8: %s: probe was NULL", __func__);
437 /* Skip disabled probes. */
441 /* Skip (enabled) probes with no configured trigger. */
445 /* Note: Must only be run if probe->trigger != NULL. */
446 if (probe->index < 0 || probe->index > 7) {
447 sr_err("la8: %s: invalid probe index %d, must be "
448 "between 0 and 7", __func__, probe->index);
452 probe_bit = (1 << (probe->index - 1));
454 /* Configure the probe's trigger mask and trigger pattern. */
455 for (tc = probe->trigger; tc && *tc; tc++) {
456 la8->trigger_mask |= probe_bit;
458 /* Sanity check, LA8 only supports low/high trigger. */
459 if (*tc != '0' && *tc != '1') {
460 sr_err("la8: %s: invalid trigger '%c', only "
461 "'0'/'1' supported", __func__, *tc);
466 la8->trigger_pattern |= probe_bit;
470 sr_dbg("la8: %s: trigger_mask = 0x%x, trigger_pattern = 0x%x",
471 __func__, la8->trigger_mask, la8->trigger_pattern);
476 static int hw_init(const char *deviceinfo)
479 struct sr_device_instance *sdi;
482 sr_spew("la8: entering %s", __func__);
484 /* Avoid compiler errors. */
487 /* Allocate memory for our private driver context. */
488 if (!(la8 = g_try_malloc(sizeof(struct la8)))) {
489 sr_err("la8: %s: struct la8 malloc failed", __func__);
490 goto err_free_nothing;
493 /* Set some sane defaults. */
495 la8->cur_samplerate = SR_MHZ(100); /* 100MHz == max. samplerate */
496 la8->period_ps = 10000;
498 la8->limit_samples = 0;
499 la8->session_id = NULL;
500 memset(la8->mangled_buf, 0, BS);
501 la8->final_buf = NULL;
502 la8->trigger_pattern = 0x00; /* Value irrelevant, see trigger_mask. */
503 la8->trigger_mask = 0x00; /* All probes are "don't care". */
504 la8->trigger_timeout = 10; /* Default to 10s trigger timeout. */
505 la8->trigger_found = 0;
507 la8->block_counter = 0;
508 la8->divcount = 0; /* 10ns sample period == 100MHz samplerate */
510 /* Allocate memory where we'll store the de-mangled data. */
511 if (!(la8->final_buf = g_try_malloc(SDRAM_SIZE))) {
512 sr_err("la8: %s: final_buf malloc failed", __func__);
516 /* Allocate memory for the FTDI context (ftdic) and initialize it. */
517 if (!(la8->ftdic = ftdi_new())) {
518 sr_err("la8: %s: ftdi_new failed", __func__);
519 goto err_free_final_buf;
522 /* Check for the device and temporarily open it. */
523 if ((ret = ftdi_usb_open_desc(la8->ftdic, USB_VENDOR_ID,
524 USB_PRODUCT_ID, USB_DESCRIPTION, NULL)) < 0) {
525 sr_dbg("la8: %s: ftdi_usb_open_desc: (%d) %s",
526 __func__, ret, ftdi_get_error_string(la8->ftdic));
527 (void) la8_close_usb_reset_sequencer(la8); /* Ignore errors. */
530 sr_dbg("la8: found device");
532 /* Register the device with libsigrok. */
533 sdi = sr_device_instance_new(0, SR_ST_INITIALIZING,
534 USB_VENDOR_NAME, USB_MODEL_NAME, USB_MODEL_VERSION);
536 sr_err("la8: %s: sr_device_instance_new failed", __func__);
537 goto err_close_ftdic;
542 device_instances = g_slist_append(device_instances, sdi);
544 sr_spew("la8: %s finished successfully", __func__);
546 /* Close device. We'll reopen it again when we need it. */
547 (void) la8_close(la8); /* Log, but ignore errors. */
552 (void) la8_close(la8); /* Log, but ignore errors. */
554 free(la8->ftdic); /* NOT g_free()! */
556 g_free(la8->final_buf);
564 static int hw_opendev(int device_index)
567 struct sr_device_instance *sdi;
570 if (!(sdi = sr_get_device_instance(device_instances, device_index))) {
571 sr_err("la8: %s: sdi was NULL", __func__);
572 return SR_ERR; /* TODO: SR_ERR_ARG? */
575 if (!(la8 = sdi->priv)) {
576 sr_err("la8: %s: sdi->priv was NULL", __func__);
577 return SR_ERR; /* TODO: SR_ERR_ARG? */
580 sr_dbg("la8: opening device");
582 /* Open the device. */
583 if ((ret = ftdi_usb_open_desc(la8->ftdic, USB_VENDOR_ID,
584 USB_PRODUCT_ID, USB_DESCRIPTION, NULL)) < 0) {
585 sr_err("la8: %s: ftdi_usb_open_desc: (%d) %s",
586 __func__, ret, ftdi_get_error_string(la8->ftdic));
587 (void) la8_close_usb_reset_sequencer(la8); /* Ignore errors. */
590 sr_dbg("la8: device opened successfully");
592 /* Purge RX/TX buffers in the FTDI chip. */
593 if ((ret = ftdi_usb_purge_buffers(la8->ftdic)) < 0) {
594 sr_err("la8: %s: ftdi_usb_purge_buffers: (%d) %s",
595 __func__, ret, ftdi_get_error_string(la8->ftdic));
596 (void) la8_close_usb_reset_sequencer(la8); /* Ignore errors. */
597 goto err_opendev_close_ftdic;
599 sr_dbg("la8: FTDI buffers purged successfully");
601 /* Enable flow control in the FTDI chip. */
602 if ((ret = ftdi_setflowctrl(la8->ftdic, SIO_RTS_CTS_HS)) < 0) {
603 sr_err("la8: %s: ftdi_setflowcontrol: (%d) %s",
604 __func__, ret, ftdi_get_error_string(la8->ftdic));
605 (void) la8_close_usb_reset_sequencer(la8); /* Ignore errors. */
606 goto err_opendev_close_ftdic;
608 sr_dbg("la8: FTDI flow control enabled successfully");
611 g_usleep(100 * 1000);
613 sdi->status = SR_ST_ACTIVE;
617 err_opendev_close_ftdic:
618 (void) la8_close(la8); /* Log, but ignore errors. */
622 static int set_samplerate(struct sr_device_instance *sdi, uint64_t samplerate)
627 sr_err("la8: %s: sdi was NULL", __func__);
631 if (!(la8 = sdi->priv)) {
632 sr_err("la8: %s: sdi->priv was NULL", __func__);
636 sr_spew("la8: setting samplerate");
638 fill_supported_samplerates_if_needed();
640 /* Check if this is a samplerate supported by the hardware. */
641 if (!is_valid_samplerate(samplerate))
644 /* Set the new samplerate. */
645 la8->cur_samplerate = samplerate;
646 la8->period_ps = 1000000000000 / samplerate;
648 sr_dbg("la8: samplerate set to %" PRIu64 "Hz", la8->cur_samplerate);
653 static int hw_closedev(int device_index)
655 struct sr_device_instance *sdi;
658 if (!(sdi = sr_get_device_instance(device_instances, device_index))) {
659 sr_err("la8: %s: sdi was NULL", __func__);
660 return SR_ERR; /* TODO: SR_ERR_ARG? */
663 if (!(la8 = sdi->priv)) {
664 sr_err("la8: %s: sdi->priv was NULL", __func__);
665 return SR_ERR; /* TODO: SR_ERR_ARG? */
668 sr_dbg("la8: closing device");
670 if (sdi->status == SR_ST_ACTIVE) {
671 sr_dbg("la8: %s: status ACTIVE, closing device", __func__);
672 /* TODO: Really ignore errors here, or return SR_ERR? */
673 (void) la8_close_usb_reset_sequencer(la8); /* Ignore errors. */
675 sr_spew("la8: %s: status not ACTIVE, nothing to do", __func__);
678 sdi->status = SR_ST_INACTIVE;
680 sr_dbg("la8: %s: freeing sample buffers", __func__);
681 g_free(la8->final_buf);
686 static void hw_cleanup(void)
689 struct sr_device_instance *sdi;
691 sr_spew("la8: entering %s", __func__);
693 /* Properly close all devices. */
694 for (l = device_instances; l; l = l->next) {
695 if ((sdi = l->data) == NULL) {
696 sr_warn("la8: %s: sdi was NULL, continuing", __func__);
701 * Fixes a segfault as it's free()d elsewhere already.
702 * TODO: Document who is supposed to free this, and when.
704 if (sdi->priv != NULL)
707 sr_warn("la8: %s: sdi->priv was NULL, nothing "
710 sr_device_instance_free(sdi); /* Returns void. */
712 g_slist_free(device_instances); /* Returns void. */
713 device_instances = NULL;
716 static void *hw_get_device_info(int device_index, int device_info_id)
718 struct sr_device_instance *sdi;
722 sr_spew("la8: entering %s", __func__);
724 if (!(sdi = sr_get_device_instance(device_instances, device_index))) {
725 sr_err("la8: %s: sdi was NULL", __func__);
729 if (!(la8 = sdi->priv)) {
730 sr_err("la8: %s: sdi->priv was NULL", __func__);
734 switch (device_info_id) {
738 case SR_DI_NUM_PROBES:
739 info = GINT_TO_POINTER(NUM_PROBES);
741 case SR_DI_PROBE_NAMES:
744 case SR_DI_SAMPLERATES:
745 fill_supported_samplerates_if_needed();
748 case SR_DI_TRIGGER_TYPES:
749 info = (char *)TRIGGER_TYPES;
751 case SR_DI_CUR_SAMPLERATE:
752 info = &la8->cur_samplerate;
755 /* Unknown device info ID, return NULL. */
756 sr_err("la8: %s: Unknown device info ID", __func__);
764 static int hw_get_status(int device_index)
766 struct sr_device_instance *sdi;
768 if (!(sdi = sr_get_device_instance(device_instances, device_index))) {
769 sr_warn("la8: %s: sdi was NULL, device not found", __func__);
770 return SR_ST_NOT_FOUND;
773 sr_dbg("la8: %s: returning status %d", __func__, sdi->status);
778 static int *hw_get_capabilities(void)
780 sr_spew("la8: entering %s", __func__);
785 static int hw_set_configuration(int device_index, int capability, void *value)
787 struct sr_device_instance *sdi;
790 sr_spew("la8: entering %s", __func__);
792 if (!(sdi = sr_get_device_instance(device_instances, device_index))) {
793 sr_err("la8: %s: sdi was NULL", __func__);
794 return SR_ERR; /* TODO: SR_ERR_ARG? */
797 if (!(la8 = sdi->priv)) {
798 sr_err("la8: %s: sdi->priv was NULL", __func__);
799 return SR_ERR; /* TODO: SR_ERR_ARG? */
802 switch (capability) {
803 case SR_HWCAP_SAMPLERATE:
804 if (set_samplerate(sdi, *(uint64_t *)value) == SR_ERR)
806 sr_dbg("la8: SAMPLERATE = %" PRIu64, la8->cur_samplerate);
808 case SR_HWCAP_PROBECONFIG:
809 if (configure_probes(la8, (GSList *)value) != SR_OK) {
810 sr_err("la8: %s: probe config failed", __func__);
814 case SR_HWCAP_LIMIT_MSEC:
815 if (*(uint64_t *)value == 0) {
816 sr_err("la8: %s: LIMIT_MSEC can't be 0", __func__);
819 la8->limit_msec = *(uint64_t *)value;
820 sr_dbg("la8: LIMIT_MSEC = %" PRIu64, la8->limit_msec);
822 case SR_HWCAP_LIMIT_SAMPLES:
823 if (*(uint64_t *)value < MIN_NUM_SAMPLES) {
824 sr_err("la8: %s: LIMIT_SAMPLES too small", __func__);
827 la8->limit_samples = *(uint64_t *)value;
828 sr_dbg("la8: LIMIT_SAMPLES = %" PRIu64, la8->limit_samples);
831 /* Unknown capability, return SR_ERR. */
832 sr_err("la8: %s: Unknown capability", __func__);
841 * Get a block of data from the LA8.
843 * @param la8 The LA8 struct containing private per-device-instance data.
844 * @return SR_OK upon success, or SR_ERR upon errors.
846 static int la8_read_block(struct la8 *la8)
848 int i, byte_offset, m, mi, p, index, bytes_read;
852 sr_err("la8: %s: la8 was NULL", __func__);
857 sr_err("la8: %s: la8->ftdic was NULL", __func__);
861 sr_spew("la8: %s: reading block %d", __func__, la8->block_counter);
863 bytes_read = la8_read(la8, la8->mangled_buf, BS);
865 /* If first block read got 0 bytes, retry until success or timeout. */
866 if ((bytes_read == 0) && (la8->block_counter == 0)) {
868 sr_spew("la8: %s: reading block 0 again", __func__);
869 bytes_read = la8_read(la8, la8->mangled_buf, BS);
870 /* TODO: How to handle read errors here? */
872 } while ((la8->done > now) && (bytes_read == 0));
875 /* Check if block read was successful or a timeout occured. */
876 if (bytes_read != BS) {
877 sr_warn("la8: %s: trigger timed out", __func__);
878 (void) la8_reset(la8); /* Ignore errors. */
882 /* De-mangle the data. */
883 sr_spew("la8: de-mangling samples of block %d", la8->block_counter);
884 byte_offset = la8->block_counter * BS;
885 m = byte_offset / (1024 * 1024);
886 mi = m * (1024 * 1024);
887 for (i = 0; i < BS; i++) {
889 index = m * 2 + (((byte_offset + i) - mi) / 2) * 16;
890 index += (la8->divcount == 0) ? p : (1 - p);
891 la8->final_buf[index] = la8->mangled_buf[i];
897 static void send_block_to_session_bus(struct la8 *la8, int block)
900 uint8_t sample, expected_sample;
901 struct sr_datafeed_packet packet;
902 struct sr_datafeed_logic logic;
903 int trigger_point; /* Relative trigger point (in this block). */
905 /* Note: No sanity checks on la8/block, caller is responsible. */
907 /* Check if we can find the trigger condition in this block. */
909 expected_sample = la8->trigger_pattern & la8->trigger_mask;
910 for (i = 0; i < BS; i++) {
911 /* Don't continue if the trigger was found previously. */
912 if (la8->trigger_found)
916 * Also, don't continue if triggers are "don't care", i.e. if
917 * no trigger conditions were specified by the user. In that
918 * case we don't want to send an SR_DF_TRIGGER packet at all.
920 if (la8->trigger_mask == 0x00)
923 sample = *(la8->final_buf + (block * BS) + i);
925 if ((sample & la8->trigger_mask) == expected_sample) {
927 la8->trigger_found = 1;
932 /* If no trigger was found, send one SR_DF_LOGIC packet. */
933 if (trigger_point == -1) {
934 /* Send an SR_DF_LOGIC packet to the session bus. */
935 sr_spew("la8: sending SR_DF_LOGIC packet (%d bytes) for "
936 "block %d", BS, block);
937 packet.type = SR_DF_LOGIC;
938 packet.timeoffset = block * BS * la8->period_ps;
939 packet.duration = BS * la8->period_ps;
940 packet.payload = &logic;
943 logic.data = la8->final_buf + (block * BS);
944 sr_session_bus(la8->session_id, &packet);
949 * We found the trigger, so some special handling is needed. We have
950 * to send an SR_DF_LOGIC packet with the samples before the trigger
951 * (if any), then the SD_DF_TRIGGER packet itself, then another
952 * SR_DF_LOGIC packet with the samples after the trigger (if any).
955 /* TODO: Send SR_DF_TRIGGER packet before or after the actual sample? */
957 /* If at least one sample is located before the trigger... */
958 if (trigger_point > 0) {
959 /* Send pre-trigger SR_DF_LOGIC packet to the session bus. */
960 sr_spew("la8: sending pre-trigger SR_DF_LOGIC packet, "
961 "start = %d, length = %d", block * BS, trigger_point);
962 packet.type = SR_DF_LOGIC;
963 packet.timeoffset = block * BS * la8->period_ps;
964 packet.duration = trigger_point * la8->period_ps;
965 packet.payload = &logic;
966 logic.length = trigger_point;
968 logic.data = la8->final_buf + (block * BS);
969 sr_session_bus(la8->session_id, &packet);
972 /* Send the SR_DF_TRIGGER packet to the session bus. */
973 sr_spew("la8: sending SR_DF_TRIGGER packet, sample = %d",
974 (block * BS) + trigger_point);
975 packet.type = SR_DF_TRIGGER;
976 packet.timeoffset = (block * BS + trigger_point) * la8->period_ps;
978 packet.payload = NULL;
979 sr_session_bus(la8->session_id, &packet);
981 /* If at least one sample is located after the trigger... */
982 if (trigger_point < (BS - 1)) {
983 /* Send post-trigger SR_DF_LOGIC packet to the session bus. */
984 sr_spew("la8: sending post-trigger SR_DF_LOGIC packet, "
985 "start = %d, length = %d",
986 (block * BS) + trigger_point, BS - trigger_point);
987 packet.type = SR_DF_LOGIC;
988 packet.timeoffset = (block * BS + trigger_point) * la8->period_ps;
989 packet.duration = (BS - trigger_point) * la8->period_ps;
990 packet.payload = &logic;
991 logic.length = BS - trigger_point;
993 logic.data = la8->final_buf + (block * BS) + trigger_point;
994 sr_session_bus(la8->session_id, &packet);
998 static int receive_data(int fd, int revents, void *session_data)
1001 struct sr_device_instance *sdi;
1004 /* Avoid compiler errors. */
1008 if (!(sdi = session_data)) {
1009 sr_err("la8: %s: user_data was NULL", __func__);
1013 if (!(la8 = sdi->priv)) {
1014 sr_err("la8: %s: sdi->priv was NULL", __func__);
1018 /* Get one block of data. */
1019 if ((ret = la8_read_block(la8)) < 0) {
1020 sr_err("la8: %s: la8_read_block error: %d", __func__, ret);
1021 hw_stop_acquisition(sdi->index, session_data);
1025 /* We need to get exactly NUM_BLOCKS blocks (i.e. 8MB) of data. */
1026 if (la8->block_counter != (NUM_BLOCKS - 1)) {
1027 la8->block_counter++;
1031 sr_dbg("la8: sampling finished, sending data to session bus now");
1033 /* All data was received and demangled, send it to the session bus. */
1034 for (i = 0; i < NUM_BLOCKS; i++)
1035 send_block_to_session_bus(la8, i);
1037 hw_stop_acquisition(sdi->index, session_data);
1039 // return FALSE; /* FIXME? */
1043 static int hw_start_acquisition(int device_index, gpointer session_data)
1045 struct sr_device_instance *sdi;
1047 struct sr_datafeed_packet packet;
1048 struct sr_datafeed_header header;
1052 sr_spew("la8: entering %s", __func__);
1054 if (!(sdi = sr_get_device_instance(device_instances, device_index))) {
1055 sr_err("la8: %s: sdi was NULL", __func__);
1056 return SR_ERR; /* TODO: SR_ERR_ARG? */
1059 if (!(la8 = sdi->priv)) {
1060 sr_err("la8: %s: sdi->priv was NULL", __func__);
1061 return SR_ERR; /* TODO: SR_ERR_ARG? */
1065 sr_err("la8: %s: la8->ftdic was NULL", __func__);
1069 la8->divcount = samplerate_to_divcount(la8->cur_samplerate);
1070 if (la8->divcount == 0xff) {
1071 sr_err("la8: %s: invalid divcount/samplerate", __func__);
1075 /* Fill acquisition parameters into buf[]. */
1076 buf[0] = la8->divcount;
1077 buf[1] = 0xff; /* This byte must always be 0xff. */
1078 buf[2] = la8->trigger_pattern;
1079 buf[3] = la8->trigger_mask;
1081 /* Start acquisition. */
1082 bytes_written = la8_write(la8, buf, 4);
1084 if (bytes_written < 0) {
1085 sr_err("la8: acquisition failed to start");
1087 } else if (bytes_written != 4) {
1088 sr_err("la8: acquisition failed to start");
1089 return SR_ERR; /* TODO: Other error and return code? */
1092 sr_dbg("la8: acquisition started successfully");
1094 la8->session_id = session_data;
1096 /* Send header packet to the session bus. */
1097 sr_dbg("la8: %s: sending SR_DF_HEADER", __func__);
1098 packet.type = SR_DF_HEADER;
1099 packet.payload = &header;
1100 header.feed_version = 1;
1101 gettimeofday(&header.starttime, NULL);
1102 header.samplerate = la8->cur_samplerate;
1103 header.num_logic_probes = NUM_PROBES;
1104 header.num_analog_probes = 0;
1105 sr_session_bus(session_data, &packet);
1107 /* Time when we should be done (for detecting trigger timeouts). */
1108 la8->done = (la8->divcount + 1) * 0.08388608 + time(NULL)
1109 + la8->trigger_timeout;
1110 la8->block_counter = 0;
1111 la8->trigger_found = 0;
1113 /* Hook up a dummy handler to receive data from the LA8. */
1114 sr_source_add(-1, G_IO_IN, 0, receive_data, sdi);
1119 static void hw_stop_acquisition(int device_index, gpointer session_data)
1121 struct sr_device_instance *sdi;
1123 struct sr_datafeed_packet packet;
1125 sr_dbg("la8: stopping acquisition");
1127 if (!(sdi = sr_get_device_instance(device_instances, device_index))) {
1128 sr_err("la8: %s: sdi was NULL", __func__);
1132 if (!(la8 = sdi->priv)) {
1133 sr_err("la8: %s: sdi->priv was NULL", __func__);
1137 /* Send end packet to the session bus. */
1138 sr_dbg("la8: %s: sending SR_DF_END", __func__);
1139 packet.type = SR_DF_END;
1140 sr_session_bus(session_data, &packet);
1143 struct sr_device_plugin chronovu_la8_plugin_info = {
1144 .name = "chronovu-la8",
1145 .longname = "ChronoVu LA8",
1148 .cleanup = hw_cleanup,
1149 .opendev = hw_opendev,
1150 .closedev = hw_closedev,
1151 .get_device_info = hw_get_device_info,
1152 .get_status = hw_get_status,
1153 .get_capabilities = hw_get_capabilities,
1154 .set_configuration = hw_set_configuration,
1155 .start_acquisition = hw_start_acquisition,
1156 .stop_acquisition = hw_stop_acquisition,