#include <ftdi.h>
#include <glib.h>
#include <string.h>
-#include <sigrok.h>
-#include <sigrok-internal.h>
+#include <stdlib.h>
+#include "sigrok.h"
+#include "sigrok-internal.h"
#define USB_VENDOR_ID 0x0403
#define USB_PRODUCT_ID 0x6001
#define SDRAM_SIZE (8 * 1024 * 1024)
#define MIN_NUM_SAMPLES 1
+#define BS 4096 /* Block size */
+#define NUM_BLOCKS 2048 /* Number of blocks */
+
static GSList *device_instances = NULL;
+static const char *probe_names[NUM_PROBES + 1] = {
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5",
+ "6",
+ "7",
+ NULL,
+};
+
struct la8 {
/** FTDI device context (used by libftdi). */
struct ftdi_context *ftdic;
gpointer session_id;
/**
- * An 4KB buffer containing some (mangled) samples from the device.
+ * A buffer containing some (mangled) samples from the device.
* Format: Pretty mangled-up (due to hardware reasons), see code.
*/
- uint8_t mangled_buf[4096];
+ uint8_t mangled_buf[BS];
/**
* An 8MB buffer where we'll store the de-mangled samples.
/** Time (in seconds) before the trigger times out. */
uint64_t trigger_timeout;
+ /** Tells us whether an SR_DF_TRIGGER packet was already sent. */
+ int trigger_found;
+
/** TODO */
time_t done;
- /** Counter/index for the data block (0..2047) to be read. */
+ /** Counter/index for the data block to be read. */
int block_counter;
/** The divcount value (determines the sample period) for the LA8. */
/* Function prototypes. */
static int la8_close_usb_reset_sequencer(struct la8 *la8);
-static void hw_stop_acquisition(int device_index, gpointer session_device_id);
+static int hw_stop_acquisition(int device_index, gpointer session_data);
static int la8_reset(struct la8 *la8);
static void fill_supported_samplerates_if_needed(void)
return 1;
}
- sr_warn("la8: %s: invalid samplerate (%" PRIu64 "Hz)",
- __func__, samplerate);
+ sr_err("la8: %s: invalid samplerate (%" PRIu64 "Hz)",
+ __func__, samplerate);
return 0;
}
bytes_written = ftdi_write_data(la8->ftdic, buf, size);
if (bytes_written < 0) {
- sr_warn("la8: %s: ftdi_write_data: (%d) %s", __func__,
- bytes_written, ftdi_get_error_string(la8->ftdic));
+ sr_err("la8: %s: ftdi_write_data: (%d) %s", __func__,
+ bytes_written, ftdi_get_error_string(la8->ftdic));
(void) la8_close_usb_reset_sequencer(la8); /* Ignore errors. */
} else if (bytes_written != size) {
- sr_warn("la8: %s: bytes to write: %d, bytes written: %d",
- __func__, size, bytes_written);
+ sr_err("la8: %s: bytes to write: %d, bytes written: %d",
+ __func__, size, bytes_written);
(void) la8_close_usb_reset_sequencer(la8); /* Ignore errors. */
}
bytes_read = ftdi_read_data(la8->ftdic, buf, size);
if (bytes_read < 0) {
- sr_warn("la8: %s: ftdi_read_data: (%d) %s", __func__,
- bytes_read, ftdi_get_error_string(la8->ftdic));
+ sr_err("la8: %s: ftdi_read_data: (%d) %s", __func__,
+ bytes_read, ftdi_get_error_string(la8->ftdic));
} else if (bytes_read != size) {
- // sr_warn("la8: %s: bytes to read: %d, bytes read: %d",
- // __func__, size, bytes_read);
+ // sr_err("la8: %s: bytes to read: %d, bytes read: %d",
+ // __func__, size, bytes_read);
}
return bytes_read;
}
if ((ret = ftdi_usb_close(la8->ftdic)) < 0) {
- sr_warn("la8: %s: ftdi_usb_close: (%d) %s",
- __func__, ret, ftdi_get_error_string(la8->ftdic));
+ sr_err("la8: %s: ftdi_usb_close: (%d) %s",
+ __func__, ret, ftdi_get_error_string(la8->ftdic));
}
return ret;
uint8_t buf[8] = {0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01};
int ret;
- sr_dbg("la8: entering %s", __func__);
-
if (!la8) {
sr_err("la8: %s: la8 was NULL", __func__);
return SR_ERR_ARG;
/* Log errors, but ignore them (i.e., don't abort). */
if ((ret = ftdi_usb_purge_buffers(la8->ftdic)) < 0)
- sr_warn("la8: %s: ftdi_usb_purge_buffers: (%d) %s",
+ sr_err("la8: %s: ftdi_usb_purge_buffers: (%d) %s",
__func__, ret, ftdi_get_error_string(la8->ftdic));
if ((ret = ftdi_usb_reset(la8->ftdic)) < 0)
- sr_warn("la8: %s: ftdi_usb_reset: (%d) %s", __func__,
- ret, ftdi_get_error_string(la8->ftdic));
+ sr_err("la8: %s: ftdi_usb_reset: (%d) %s", __func__,
+ ret, ftdi_get_error_string(la8->ftdic));
if ((ret = ftdi_usb_close(la8->ftdic)) < 0)
- sr_warn("la8: %s: ftdi_usb_close: (%d) %s", __func__,
- ret, ftdi_get_error_string(la8->ftdic));
- } else {
- sr_dbg("la8: %s: usb_dev was NULL, nothing to do", __func__);
+ sr_err("la8: %s: ftdi_usb_close: (%d) %s", __func__,
+ ret, ftdi_get_error_string(la8->ftdic));
}
ftdi_free(la8->ftdic); /* Returns void. */
*/
static int la8_reset(struct la8 *la8)
{
- uint8_t buf[4096];
+ uint8_t buf[BS];
time_t done, now;
int bytes_read;
done = 20 + time(NULL);
do {
/* TODO: Ignore errors? Check for < 0 at least! */
- bytes_read = la8_read(la8, (uint8_t *)&buf, 4096);
+ bytes_read = la8_read(la8, (uint8_t *)&buf, BS);
now = time(NULL);
} while ((done > now) && (bytes_read > 0));
struct sr_device_instance *sdi;
struct la8 *la8;
- sr_dbg("la8: entering %s", __func__);
-
/* Avoid compiler errors. */
- deviceinfo = deviceinfo;
+ (void)deviceinfo;
/* Allocate memory for our private driver context. */
if (!(la8 = g_try_malloc(sizeof(struct la8)))) {
sr_err("la8: %s: struct la8 malloc failed", __func__);
- ret = SR_ERR_MALLOC;
goto err_free_nothing;
}
la8->limit_msec = 0;
la8->limit_samples = 0;
la8->session_id = NULL;
- memset(la8->mangled_buf, 0, 4096);
+ memset(la8->mangled_buf, 0, BS);
la8->final_buf = NULL;
la8->trigger_pattern = 0x00; /* Value irrelevant, see trigger_mask. */
la8->trigger_mask = 0x00; /* All probes are "don't care". */
la8->trigger_timeout = 10; /* Default to 10s trigger timeout. */
+ la8->trigger_found = 0;
la8->done = 0;
la8->block_counter = 0;
la8->divcount = 0; /* 10ns sample period == 100MHz samplerate */
/* Allocate memory where we'll store the de-mangled data. */
if (!(la8->final_buf = g_try_malloc(SDRAM_SIZE))) {
sr_err("la8: %s: final_buf malloc failed", __func__);
- ret = SR_ERR_MALLOC;
goto err_free_la8;
}
/* Allocate memory for the FTDI context (ftdic) and initialize it. */
if (!(la8->ftdic = ftdi_new())) {
sr_err("la8: %s: ftdi_new failed", __func__);
- ret = SR_ERR; /* TODO: More specific error? */
goto err_free_final_buf;
}
/* Check for the device and temporarily open it. */
if ((ret = ftdi_usb_open_desc(la8->ftdic, USB_VENDOR_ID,
USB_PRODUCT_ID, USB_DESCRIPTION, NULL)) < 0) {
- sr_err("la8: %s: ftdi_usb_open_desc: (%d) %s",
- __func__, ret, ftdi_get_error_string(la8->ftdic));
(void) la8_close_usb_reset_sequencer(la8); /* Ignore errors. */
- ret = SR_ERR; /* TODO: More specific error? */
goto err_free_ftdic;
}
sr_dbg("la8: found device");
/* Register the device with libsigrok. */
- sdi = sr_device_instance_new(0, SR_ST_INITIALIZING,
+ sdi = sr_dev_inst_new(0, SR_ST_INITIALIZING,
USB_VENDOR_NAME, USB_MODEL_NAME, USB_MODEL_VERSION);
if (!sdi) {
sr_err("la8: %s: sr_device_instance_new failed", __func__);
- ret = SR_ERR; /* TODO: More specific error? */
goto err_close_ftdic;
}
device_instances = g_slist_append(device_instances, sdi);
- sr_dbg("la8: %s finished successfully", __func__);
+ sr_spew("la8: %s finished successfully", __func__);
/* Close device. We'll reopen it again when we need it. */
(void) la8_close(la8); /* Log, but ignore errors. */
- // return SR_OK; /* TODO */
return 1;
err_close_ftdic:
err_free_la8:
g_free(la8);
err_free_nothing:
- // return ret; /* TODO */
+
return 0;
}
struct sr_device_instance *sdi;
struct la8 *la8;
- if (!(sdi = sr_get_device_instance(device_instances, device_index))) {
+ if (!(sdi = sr_dev_inst_get(device_instances, device_index))) {
sr_err("la8: %s: sdi was NULL", __func__);
return SR_ERR; /* TODO: SR_ERR_ARG? */
}
return SR_ERR_ARG;
}
- sr_dbg("la8: setting samplerate");
+ sr_spew("la8: setting samplerate");
fill_supported_samplerates_if_needed();
struct sr_device_instance *sdi;
struct la8 *la8;
- if (!(sdi = sr_get_device_instance(device_instances, device_index))) {
+ if (!(sdi = sr_dev_inst_get(device_instances, device_index))) {
sr_err("la8: %s: sdi was NULL", __func__);
return SR_ERR; /* TODO: SR_ERR_ARG? */
}
/* TODO: Really ignore errors here, or return SR_ERR? */
(void) la8_close_usb_reset_sequencer(la8); /* Ignore errors. */
} else {
- sr_dbg("la8: %s: status not ACTIVE, nothing to do", __func__);
+ sr_spew("la8: %s: status not ACTIVE, nothing to do", __func__);
}
sdi->status = SR_ST_INACTIVE;
return SR_OK;
}
-static void hw_cleanup(void)
+static int hw_cleanup(void)
{
GSList *l;
struct sr_device_instance *sdi;
-
- sr_dbg("la8: entering %s", __func__);
+ int ret = SR_OK;
/* Properly close all devices. */
for (l = device_instances; l; l = l->next) {
- if ((sdi = l->data) == NULL) {
- sr_warn("la8: %s: sdi was NULL, continuing", __func__);
+ if (!(sdi = l->data)) {
+ /* Log error, but continue cleaning up the rest. */
+ sr_err("la8: %s: sdi was NULL, continuing", __func__);
+ ret = SR_ERR_BUG;
continue;
}
- if (sdi->priv != NULL)
- free(sdi->priv);
- else
- sr_warn("la8: %s: sdi->priv was NULL, nothing "
- "to do", __func__);
- sr_device_instance_free(sdi); /* Returns void. */
+ sr_dev_inst_free(sdi); /* Returns void. */
}
g_slist_free(device_instances); /* Returns void. */
device_instances = NULL;
+
+ return ret;
}
static void *hw_get_device_info(int device_index, int device_info_id)
struct la8 *la8;
void *info;
- sr_dbg("la8: entering %s", __func__);
+ sr_spew("la8: entering %s", __func__);
- if (!(sdi = sr_get_device_instance(device_instances, device_index))) {
+ if (!(sdi = sr_dev_inst_get(device_instances, device_index))) {
sr_err("la8: %s: sdi was NULL", __func__);
return NULL;
}
case SR_DI_NUM_PROBES:
info = GINT_TO_POINTER(NUM_PROBES);
break;
+ case SR_DI_PROBE_NAMES:
+ info = probe_names;
+ break;
case SR_DI_SAMPLERATES:
fill_supported_samplerates_if_needed();
info = &samplerates;
{
struct sr_device_instance *sdi;
- if (!(sdi = sr_get_device_instance(device_instances, device_index))) {
- sr_warn("la8: %s: sdi was NULL, device not found", __func__);
+ if (!(sdi = sr_dev_inst_get(device_instances, device_index))) {
+ sr_err("la8: %s: sdi was NULL, device not found", __func__);
return SR_ST_NOT_FOUND;
}
static int *hw_get_capabilities(void)
{
- sr_dbg("la8: entering %s", __func__);
+ sr_spew("la8: entering %s", __func__);
return capabilities;
}
struct sr_device_instance *sdi;
struct la8 *la8;
- sr_dbg("la8: entering %s", __func__);
+ sr_spew("la8: entering %s", __func__);
- if (!(sdi = sr_get_device_instance(device_instances, device_index))) {
+ if (!(sdi = sr_dev_inst_get(device_instances, device_index))) {
sr_err("la8: %s: sdi was NULL", __func__);
return SR_ERR; /* TODO: SR_ERR_ARG? */
}
}
/**
- * Get a block of 4096 bytes of data from the LA8.
+ * Get a block of data from the LA8.
*
* @param la8 The LA8 struct containing private per-device-instance data.
* @return SR_OK upon success, or SR_ERR upon errors.
return SR_ERR_ARG;
}
- // sr_dbg("la8: %s: reading block %d", __func__, la8->block_counter);
+ sr_spew("la8: %s: reading block %d", __func__, la8->block_counter);
- bytes_read = la8_read(la8, la8->mangled_buf, 4096);
+ bytes_read = la8_read(la8, la8->mangled_buf, BS);
/* If first block read got 0 bytes, retry until success or timeout. */
if ((bytes_read == 0) && (la8->block_counter == 0)) {
do {
- // sr_dbg("la8: %s: reading block 0 again", __func__);
- bytes_read = la8_read(la8, la8->mangled_buf, 4096);
+ sr_spew("la8: %s: reading block 0 again", __func__);
+ bytes_read = la8_read(la8, la8->mangled_buf, BS);
/* TODO: How to handle read errors here? */
now = time(NULL);
} while ((la8->done > now) && (bytes_read == 0));
}
/* Check if block read was successful or a timeout occured. */
- if (bytes_read != 4096) {
- sr_warn("la8: %s: trigger timed out", __func__);
+ if (bytes_read != BS) {
+ sr_err("la8: %s: trigger timed out", __func__);
(void) la8_reset(la8); /* Ignore errors. */
return SR_ERR;
}
/* De-mangle the data. */
- // sr_dbg("la8: de-mangling samples of block %d", la8->block_counter);
- byte_offset = la8->block_counter * 4096;
+ sr_spew("la8: de-mangling samples of block %d", la8->block_counter);
+ byte_offset = la8->block_counter * BS;
m = byte_offset / (1024 * 1024);
mi = m * (1024 * 1024);
- for (i = 0; i < 4096; i++) {
+ for (i = 0; i < BS; i++) {
p = i & (1 << 0);
index = m * 2 + (((byte_offset + i) - mi) / 2) * 16;
index += (la8->divcount == 0) ? p : (1 - p);
return SR_OK;
}
-static int receive_data(int fd, int revents, void *user_data)
+static void send_block_to_session_bus(struct la8 *la8, int block)
+{
+ int i;
+ uint8_t sample, expected_sample;
+ struct sr_datafeed_packet packet;
+ struct sr_datafeed_logic logic;
+ int trigger_point; /* Relative trigger point (in this block). */
+
+ /* Note: No sanity checks on la8/block, caller is responsible. */
+
+ /* Check if we can find the trigger condition in this block. */
+ trigger_point = -1;
+ expected_sample = la8->trigger_pattern & la8->trigger_mask;
+ for (i = 0; i < BS; i++) {
+ /* Don't continue if the trigger was found previously. */
+ if (la8->trigger_found)
+ break;
+
+ /*
+ * Also, don't continue if triggers are "don't care", i.e. if
+ * no trigger conditions were specified by the user. In that
+ * case we don't want to send an SR_DF_TRIGGER packet at all.
+ */
+ if (la8->trigger_mask == 0x00)
+ break;
+
+ sample = *(la8->final_buf + (block * BS) + i);
+
+ if ((sample & la8->trigger_mask) == expected_sample) {
+ trigger_point = i;
+ la8->trigger_found = 1;
+ break;
+ }
+ }
+
+ /* If no trigger was found, send one SR_DF_LOGIC packet. */
+ if (trigger_point == -1) {
+ /* Send an SR_DF_LOGIC packet to the session bus. */
+ sr_spew("la8: sending SR_DF_LOGIC packet (%d bytes) for "
+ "block %d", BS, block);
+ packet.type = SR_DF_LOGIC;
+ packet.payload = &logic;
+ logic.length = BS;
+ logic.unitsize = 1;
+ logic.data = la8->final_buf + (block * BS);
+ sr_session_bus(la8->session_id, &packet);
+ return;
+ }
+
+ /*
+ * We found the trigger, so some special handling is needed. We have
+ * to send an SR_DF_LOGIC packet with the samples before the trigger
+ * (if any), then the SD_DF_TRIGGER packet itself, then another
+ * SR_DF_LOGIC packet with the samples after the trigger (if any).
+ */
+
+ /* TODO: Send SR_DF_TRIGGER packet before or after the actual sample? */
+
+ /* If at least one sample is located before the trigger... */
+ if (trigger_point > 0) {
+ /* Send pre-trigger SR_DF_LOGIC packet to the session bus. */
+ sr_spew("la8: sending pre-trigger SR_DF_LOGIC packet, "
+ "start = %d, length = %d", block * BS, trigger_point);
+ packet.type = SR_DF_LOGIC;
+ packet.payload = &logic;
+ logic.length = trigger_point;
+ logic.unitsize = 1;
+ logic.data = la8->final_buf + (block * BS);
+ sr_session_bus(la8->session_id, &packet);
+ }
+
+ /* Send the SR_DF_TRIGGER packet to the session bus. */
+ sr_spew("la8: sending SR_DF_TRIGGER packet, sample = %d",
+ (block * BS) + trigger_point);
+ packet.type = SR_DF_TRIGGER;
+ packet.payload = NULL;
+ sr_session_bus(la8->session_id, &packet);
+
+ /* If at least one sample is located after the trigger... */
+ if (trigger_point < (BS - 1)) {
+ /* Send post-trigger SR_DF_LOGIC packet to the session bus. */
+ sr_spew("la8: sending post-trigger SR_DF_LOGIC packet, "
+ "start = %d, length = %d",
+ (block * BS) + trigger_point, BS - trigger_point);
+ packet.type = SR_DF_LOGIC;
+ packet.payload = &logic;
+ logic.length = BS - trigger_point;
+ logic.unitsize = 1;
+ logic.data = la8->final_buf + (block * BS) + trigger_point;
+ sr_session_bus(la8->session_id, &packet);
+ }
+}
+
+static int receive_data(int fd, int revents, void *session_data)
{
int i, ret;
struct sr_device_instance *sdi;
- struct sr_datafeed_packet packet;
struct la8 *la8;
/* Avoid compiler errors. */
- fd = fd;
- revents = revents;
+ (void)fd;
+ (void)revents;
- if (!(sdi = user_data)) {
- sr_err("la8: %s: user_data was NULL", __func__);
+ if (!(sdi = session_data)) {
+ sr_err("la8: %s: session_data was NULL", __func__);
return FALSE;
}
return FALSE;
}
- /* Get one block of data (4096 bytes). */
+ /* Get one block of data. */
if ((ret = la8_read_block(la8)) < 0) {
sr_err("la8: %s: la8_read_block error: %d", __func__, ret);
- hw_stop_acquisition(sdi->index, user_data);
+ hw_stop_acquisition(sdi->index, session_data);
return FALSE;
}
- /* We need to get exactly 2048 blocks (i.e. 8MB) of data. */
- if (la8->block_counter != 2047) {
+ /* We need to get exactly NUM_BLOCKS blocks (i.e. 8MB) of data. */
+ if (la8->block_counter != (NUM_BLOCKS - 1)) {
la8->block_counter++;
return TRUE;
}
sr_dbg("la8: sampling finished, sending data to session bus now");
/* All data was received and demangled, send it to the session bus. */
- for (i = 0; i < 2048; i++) {
- /* Send a 4096 byte SR_DF_LOGIC packet to the session bus. */
- // sr_dbg("la8: %s: sending SR_DF_LOGIC packet", __func__);
- packet.type = SR_DF_LOGIC;
- packet.length = 4096;
- packet.unitsize = 1;
- packet.payload = la8->final_buf + (i * 4096);
- sr_session_bus(la8->session_id, &packet);
- }
+ for (i = 0; i < NUM_BLOCKS; i++)
+ send_block_to_session_bus(la8, i);
- hw_stop_acquisition(sdi->index, user_data);
+ hw_stop_acquisition(sdi->index, session_data);
// return FALSE; /* FIXME? */
return TRUE;
}
-static int hw_start_acquisition(int device_index, gpointer session_device_id)
+static int hw_start_acquisition(int device_index, gpointer session_data)
{
struct sr_device_instance *sdi;
struct la8 *la8;
uint8_t buf[4];
int bytes_written;
- sr_dbg("la8: entering %s", __func__);
+ sr_spew("la8: entering %s", __func__);
- if (!(sdi = sr_get_device_instance(device_instances, device_index))) {
+ if (!(sdi = sr_dev_inst_get(device_instances, device_index))) {
sr_err("la8: %s: sdi was NULL", __func__);
return SR_ERR; /* TODO: SR_ERR_ARG? */
}
sr_dbg("la8: acquisition started successfully");
- la8->session_id = session_device_id;
+ la8->session_id = session_data;
/* Send header packet to the session bus. */
sr_dbg("la8: %s: sending SR_DF_HEADER", __func__);
packet.type = SR_DF_HEADER;
- packet.length = sizeof(struct sr_datafeed_header);
- packet.unitsize = 0;
packet.payload = &header;
header.feed_version = 1;
gettimeofday(&header.starttime, NULL);
header.samplerate = la8->cur_samplerate;
- header.protocol_id = SR_PROTO_RAW;
header.num_logic_probes = NUM_PROBES;
- header.num_analog_probes = 0;
- sr_session_bus(session_device_id, &packet);
+ sr_session_bus(session_data, &packet);
/* Time when we should be done (for detecting trigger timeouts). */
la8->done = (la8->divcount + 1) * 0.08388608 + time(NULL)
+ la8->trigger_timeout;
la8->block_counter = 0;
+ la8->trigger_found = 0;
/* Hook up a dummy handler to receive data from the LA8. */
sr_source_add(-1, G_IO_IN, 0, receive_data, sdi);
return SR_OK;
}
-static void hw_stop_acquisition(int device_index, gpointer session_device_id)
+static int hw_stop_acquisition(int device_index, gpointer session_data)
{
struct sr_device_instance *sdi;
struct la8 *la8;
sr_dbg("la8: stopping acquisition");
- if (!(sdi = sr_get_device_instance(device_instances, device_index))) {
+ if (!(sdi = sr_dev_inst_get(device_instances, device_index))) {
sr_err("la8: %s: sdi was NULL", __func__);
- return;
+ return SR_ERR_BUG;
}
if (!(la8 = sdi->priv)) {
sr_err("la8: %s: sdi->priv was NULL", __func__);
- return;
+ return SR_ERR_BUG;
}
/* Send end packet to the session bus. */
sr_dbg("la8: %s: sending SR_DF_END", __func__);
packet.type = SR_DF_END;
- packet.length = 0;
- packet.unitsize = 0;
- packet.payload = NULL;
- sr_session_bus(session_device_id, &packet);
+ sr_session_bus(session_data, &packet);
+
+ return SR_OK;
}
-struct sr_device_plugin chronovu_la8_plugin_info = {
+SR_PRIV struct sr_device_plugin chronovu_la8_plugin_info = {
.name = "chronovu-la8",
.longname = "ChronoVu LA8",
.api_version = 1,