/*
* This file is part of the sigrok project.
*
- * Copyright (C) 2011 Uwe Hermann <uwe@hermann-uwe.de>
+ * Copyright (C) 2011-2012 Uwe Hermann <uwe@hermann-uwe.de>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
static GSList *dev_insts = NULL;
+/* Probes are numbered 0-7. */
static const char *probe_names[NUM_PROBES + 1] = {
"0",
"1",
uint64_t limit_samples;
/** TODO */
- gpointer session_id;
+ void *session_dev_id;
/**
* A buffer containing some (mangled) samples from the device.
/* Function prototypes. */
static int la8_close_usb_reset_sequencer(struct context *ctx);
-static int hw_dev_acquisition_stop(int dev_index, gpointer session_data);
+static int hw_dev_acquisition_stop(int dev_index, void *cb_data);
static int la8_reset(struct context *ctx);
static void fill_supported_samplerates_if_needed(void)
/**
* Write data of a certain length to the LA8's FTDI device.
*
- * @param ctx The struct containing private per-device-instance data.
- * @param buf The buffer containing the data to write.
- * @param size The number of bytes to write.
+ * @param ctx The struct containing private per-device-instance data. Must not
+ * be NULL. ctx->ftdic must not be NULL either.
+ * @param buf The buffer containing the data to write. Must not be NULL.
+ * @param size The number of bytes to write. Must be >= 0.
* @return The number of bytes written, or a negative value upon errors.
*/
static int la8_write(struct context *ctx, uint8_t *buf, int size)
{
int bytes_written;
- if (!ctx) {
- sr_err("la8: %s: ctx was NULL", __func__);
- return SR_ERR_ARG;
- }
-
- if (!ctx->ftdic) {
- sr_err("la8: %s: ctx->ftdic was NULL", __func__);
- return SR_ERR_ARG;
- }
+ /* Note: Caller checked that ctx and ctx->ftdic != NULL. */
if (!buf) {
sr_err("la8: %s: buf was NULL", __func__);
/**
* Read a certain amount of bytes from the LA8's FTDI device.
*
- * @param ctx The struct containing private per-device-instance data.
- * @param buf The buffer where the received data will be stored.
- * @param size The number of bytes to read.
+ * @param ctx The struct containing private per-device-instance data. Must not
+ * be NULL. ctx->ftdic must not be NULL either.
+ * @param buf The buffer where the received data will be stored. Must not
+ * be NULL.
+ * @param size The number of bytes to read. Must be >= 1.
* @return The number of bytes read, or a negative value upon errors.
*/
static int la8_read(struct context *ctx, uint8_t *buf, int size)
{
int bytes_read;
- if (!ctx) {
- sr_err("la8: %s: ctx was NULL", __func__);
- return SR_ERR_ARG;
- }
-
- if (!ctx->ftdic) {
- sr_err("la8: %s: ctx->ftdic was NULL", __func__);
- return SR_ERR_ARG;
- }
+ /* Note: Caller checked that ctx and ctx->ftdic != NULL. */
if (!buf) {
sr_err("la8: %s: buf was NULL", __func__);
* Close the ChronoVu LA8 USB port and reset the LA8 sequencer logic.
*
* @param ctx The struct containing private per-device-instance data.
- * @return SR_OK upon success, SR_ERR upon failure.
+ * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
*/
static int la8_close_usb_reset_sequencer(struct context *ctx)
{
if (ctx->ftdic->usb_dev) {
/* Reset the LA8 sequencer logic, then wait 100ms. */
- sr_dbg("la8: resetting sequencer logic");
+ sr_dbg("la8: Resetting sequencer logic.");
(void) la8_write(ctx, buf, 8); /* Ignore errors. */
g_usleep(100 * 1000);
/* Purge FTDI buffers, then reset and close the FTDI device. */
- sr_dbg("la8: purging buffers, resetting+closing FTDI device");
+ sr_dbg("la8: Purging buffers, resetting+closing FTDI device.");
/* Log errors, but ignore them (i.e., don't abort). */
if ((ret = ftdi_usb_purge_buffers(ctx->ftdic)) < 0)
ret, ftdi_get_error_string(ctx->ftdic));
}
+ /* Close USB device, deinitialize and free the FTDI context. */
ftdi_free(ctx->ftdic); /* Returns void. */
ctx->ftdic = NULL;
return SR_ERR_ARG;
}
- sr_dbg("la8: resetting the device");
+ sr_dbg("la8: Resetting the device.");
/*
* Purge pending read data from the FTDI hardware FIFO until
/* Reset the LA8 sequencer logic and close the USB port. */
(void) la8_close_usb_reset_sequencer(ctx); /* Ignore errors. */
- sr_dbg("la8: device reset finished");
+ sr_dbg("la8: Device reset finished.");
return SR_OK;
}
uint8_t probe_bit;
char *tc;
+ /* Note: Caller checked that ctx != NULL. */
+
ctx->trigger_pattern = 0;
ctx->trigger_mask = 0; /* Default to "don't care" for all probes. */
}
}
- sr_dbg("la8: %s: trigger_mask = 0x%x, trigger_pattern = 0x%x",
- __func__, ctx->trigger_mask, ctx->trigger_pattern);
+ sr_dbg("la8: trigger_mask = 0x%x, trigger_pattern = 0x%x",
+ ctx->trigger_mask, ctx->trigger_pattern);
return SR_OK;
}
ctx->cur_samplerate = SR_MHZ(100); /* 100MHz == max. samplerate */
ctx->limit_msec = 0;
ctx->limit_samples = 0;
- ctx->session_id = NULL;
+ ctx->session_dev_id = NULL;
memset(ctx->mangled_buf, 0, BS);
ctx->final_buf = NULL;
ctx->trigger_pattern = 0x00; /* Value irrelevant, see trigger_mask. */
(void) la8_close_usb_reset_sequencer(ctx); /* Ignore errors. */
goto err_free_ftdic;
}
- sr_dbg("la8: found device");
+ sr_dbg("la8: Found LA8 device (%04x:%04x).", USB_VENDOR_ID,
+ USB_PRODUCT_ID);
/* Register the device with libsigrok. */
sdi = sr_dev_inst_new(0, SR_ST_INITIALIZING,
dev_insts = g_slist_append(dev_insts, sdi);
- sr_spew("la8: %s finished successfully", __func__);
+ sr_spew("la8: Device init successful.");
/* Close device. We'll reopen it again when we need it. */
(void) la8_close(ctx); /* Log, but ignore errors. */
if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) {
sr_err("la8: %s: sdi was NULL", __func__);
- return SR_ERR; /* TODO: SR_ERR_ARG? */
+ return SR_ERR_BUG;
}
if (!(ctx = sdi->priv)) {
sr_err("la8: %s: sdi->priv was NULL", __func__);
- return SR_ERR; /* TODO: SR_ERR_ARG? */
+ return SR_ERR_BUG;
}
- sr_dbg("la8: opening device");
+ sr_dbg("la8: Opening LA8 device (%04x:%04x).", USB_VENDOR_ID,
+ USB_PRODUCT_ID);
/* Open the device. */
if ((ret = ftdi_usb_open_desc(ctx->ftdic, USB_VENDOR_ID,
(void) la8_close_usb_reset_sequencer(ctx); /* Ignore errors. */
return SR_ERR;
}
- sr_dbg("la8: device opened successfully");
+ sr_dbg("la8: Device opened successfully.");
/* Purge RX/TX buffers in the FTDI chip. */
if ((ret = ftdi_usb_purge_buffers(ctx->ftdic)) < 0) {
(void) la8_close_usb_reset_sequencer(ctx); /* Ignore errors. */
goto err_dev_open_close_ftdic;
}
- sr_dbg("la8: FTDI buffers purged successfully");
+ sr_dbg("la8: FTDI buffers purged successfully.");
/* Enable flow control in the FTDI chip. */
if ((ret = ftdi_setflowctrl(ctx->ftdic, SIO_RTS_CTS_HS)) < 0) {
(void) la8_close_usb_reset_sequencer(ctx); /* Ignore errors. */
goto err_dev_open_close_ftdic;
}
- sr_dbg("la8: FTDI flow control enabled successfully");
+ sr_dbg("la8: FTDI flow control enabled successfully.");
/* Wait 100ms. */
g_usleep(100 * 1000);
{
struct context *ctx;
- if (!sdi) {
- sr_err("la8: %s: sdi was NULL", __func__);
- return SR_ERR_ARG;
- }
+ /* Note: Caller checked that sdi and sdi->priv != NULL. */
- if (!(ctx = sdi->priv)) {
- sr_err("la8: %s: sdi->priv was NULL", __func__);
- return SR_ERR_ARG;
- }
+ ctx = sdi->priv;
- sr_spew("la8: setting samplerate");
+ sr_spew("la8: Trying to set samplerate to %" PRIu64 "Hz.", samplerate);
fill_supported_samplerates_if_needed();
/* Set the new samplerate. */
ctx->cur_samplerate = samplerate;
- sr_dbg("la8: samplerate set to %" PRIu64 "Hz", ctx->cur_samplerate);
+ sr_dbg("la8: Samplerate set to %" PRIu64 "Hz.", ctx->cur_samplerate);
return SR_OK;
}
if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) {
sr_err("la8: %s: sdi was NULL", __func__);
- return SR_ERR; /* TODO: SR_ERR_ARG? */
+ return SR_ERR_BUG;
}
if (!(ctx = sdi->priv)) {
sr_err("la8: %s: sdi->priv was NULL", __func__);
- return SR_ERR; /* TODO: SR_ERR_ARG? */
+ return SR_ERR_BUG;
}
- sr_dbg("la8: closing device");
+ sr_dbg("la8: Closing device.");
if (sdi->status == SR_ST_ACTIVE) {
- sr_dbg("la8: %s: status ACTIVE, closing device", __func__);
+ sr_dbg("la8: Status ACTIVE, closing device.");
/* TODO: Really ignore errors here, or return SR_ERR? */
(void) la8_close_usb_reset_sequencer(ctx); /* Ignore errors. */
} else {
- sr_spew("la8: %s: status not ACTIVE, nothing to do", __func__);
+ sr_spew("la8: Status not ACTIVE, nothing to do.");
}
sdi->status = SR_ST_INACTIVE;
- sr_dbg("la8: %s: freeing sample buffers", __func__);
+ sr_dbg("la8: Freeing sample buffer.");
g_free(ctx->final_buf);
return SR_OK;
struct context *ctx;
void *info;
- sr_spew("la8: entering %s", __func__);
-
if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) {
sr_err("la8: %s: sdi was NULL", __func__);
return NULL;
return NULL;
}
+ sr_spew("la8: %s: dev_index %d, dev_info_id %d.", __func__,
+ dev_index, dev_info_id);
+
switch (dev_info_id) {
case SR_DI_INST:
info = sdi;
+ sr_spew("la8: %s: Returning sdi.", __func__);
break;
case SR_DI_NUM_PROBES:
info = GINT_TO_POINTER(NUM_PROBES);
+ sr_spew("la8: %s: Returning number of probes: %d.", __func__,
+ NUM_PROBES);
break;
case SR_DI_PROBE_NAMES:
info = probe_names;
+ sr_spew("la8: %s: Returning probenames.", __func__);
break;
case SR_DI_SAMPLERATES:
fill_supported_samplerates_if_needed();
info = &samplerates;
+ sr_spew("la8: %s: Returning samplerates.", __func__);
break;
case SR_DI_TRIGGER_TYPES:
info = (char *)TRIGGER_TYPES;
+ sr_spew("la8: %s: Returning trigger types: %s.", __func__,
+ TRIGGER_TYPES);
break;
case SR_DI_CUR_SAMPLERATE:
info = &ctx->cur_samplerate;
+ sr_spew("la8: %s: Returning samplerate: %" PRIu64 "Hz.",
+ __func__, ctx->cur_samplerate);
break;
default:
/* Unknown device info ID, return NULL. */
return SR_ST_NOT_FOUND;
}
- sr_dbg("la8: %s: returning status %d", __func__, sdi->status);
+ sr_dbg("la8: Returning status: %d.", sdi->status);
return sdi->status;
}
static int *hw_hwcap_get_all(void)
{
- sr_spew("la8: entering %s", __func__);
+ sr_spew("la8: Returning list of device capabilities.");
return hwcaps;
}
struct sr_dev_inst *sdi;
struct context *ctx;
- sr_spew("la8: entering %s", __func__);
-
if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) {
sr_err("la8: %s: sdi was NULL", __func__);
- return SR_ERR; /* TODO: SR_ERR_ARG? */
+ return SR_ERR_BUG;
}
if (!(ctx = sdi->priv)) {
sr_err("la8: %s: sdi->priv was NULL", __func__);
- return SR_ERR; /* TODO: SR_ERR_ARG? */
+ return SR_ERR_BUG;
}
+ sr_spew("la8: %s: dev_index %d, hwcap %d", __func__, dev_index, hwcap);
+
switch (hwcap) {
case SR_HWCAP_SAMPLERATE:
- if (set_samplerate(sdi, *(uint64_t *)value) == SR_ERR)
+ if (set_samplerate(sdi, *(uint64_t *)value) == SR_ERR) {
+ sr_err("la8: %s: setting samplerate failed.", __func__);
return SR_ERR;
+ }
sr_dbg("la8: SAMPLERATE = %" PRIu64, ctx->cur_samplerate);
break;
case SR_HWCAP_PROBECONFIG:
if (configure_probes(ctx, (GSList *)value) != SR_OK) {
- sr_err("la8: %s: probe config failed", __func__);
+ sr_err("la8: %s: probe config failed.", __func__);
return SR_ERR;
}
break;
case SR_HWCAP_LIMIT_MSEC:
if (*(uint64_t *)value == 0) {
- sr_err("la8: %s: LIMIT_MSEC can't be 0", __func__);
+ sr_err("la8: %s: LIMIT_MSEC can't be 0.", __func__);
return SR_ERR;
}
ctx->limit_msec = *(uint64_t *)value;
break;
case SR_HWCAP_LIMIT_SAMPLES:
if (*(uint64_t *)value < MIN_NUM_SAMPLES) {
- sr_err("la8: %s: LIMIT_SAMPLES too small", __func__);
+ sr_err("la8: %s: LIMIT_SAMPLES too small.", __func__);
return SR_ERR;
}
ctx->limit_samples = *(uint64_t *)value;
break;
default:
/* Unknown capability, return SR_ERR. */
- sr_err("la8: %s: Unknown capability", __func__);
+ sr_err("la8: %s: Unknown capability.", __func__);
return SR_ERR;
break;
}
/**
* Get a block of data from the LA8.
*
- * @param ctx The struct containing private per-device-instance data.
+ * @param ctx The struct containing private per-device-instance data. Must not
+ * be NULL. ctx->ftdic must not be NULL either.
* @return SR_OK upon success, or SR_ERR upon errors.
*/
static int la8_read_block(struct context *ctx)
int i, byte_offset, m, mi, p, index, bytes_read;
time_t now;
- if (!ctx) {
- sr_err("la8: %s: ctx was NULL", __func__);
- return SR_ERR_ARG;
- }
+ /* Note: Caller checked that ctx and ctx->ftdic != NULL. */
- if (!ctx->ftdic) {
- sr_err("la8: %s: ctx->ftdic was NULL", __func__);
- return SR_ERR_ARG;
- }
-
- sr_spew("la8: %s: reading block %d", __func__, ctx->block_counter);
+ sr_spew("la8: Reading block %d.", ctx->block_counter);
bytes_read = la8_read(ctx, ctx->mangled_buf, BS);
/* If first block read got 0 bytes, retry until success or timeout. */
if ((bytes_read == 0) && (ctx->block_counter == 0)) {
do {
- sr_spew("la8: %s: reading block 0 again", __func__);
+ sr_spew("la8: Reading block 0 (again).");
bytes_read = la8_read(ctx, ctx->mangled_buf, BS);
/* TODO: How to handle read errors here? */
now = time(NULL);
/* Check if block read was successful or a timeout occured. */
if (bytes_read != BS) {
- sr_err("la8: %s: trigger timed out", __func__);
+ sr_err("la8: Trigger timed out. Bytes read: %d.", bytes_read);
(void) la8_reset(ctx); /* Ignore errors. */
return SR_ERR;
}
/* De-mangle the data. */
- sr_spew("la8: de-mangling samples of block %d", ctx->block_counter);
+ sr_spew("la8: Demangling block %d.", ctx->block_counter);
byte_offset = ctx->block_counter * BS;
m = byte_offset / (1024 * 1024);
mi = m * (1024 * 1024);
logic.length = BS;
logic.unitsize = 1;
logic.data = ctx->final_buf + (block * BS);
- sr_session_bus(ctx->session_id, &packet);
+ sr_session_send(ctx->session_dev_id, &packet);
return;
}
logic.length = trigger_point;
logic.unitsize = 1;
logic.data = ctx->final_buf + (block * BS);
- sr_session_bus(ctx->session_id, &packet);
+ sr_session_send(ctx->session_dev_id, &packet);
}
/* Send the SR_DF_TRIGGER packet to the session bus. */
(block * BS) + trigger_point);
packet.type = SR_DF_TRIGGER;
packet.payload = NULL;
- sr_session_bus(ctx->session_id, &packet);
+ sr_session_send(ctx->session_dev_id, &packet);
/* If at least one sample is located after the trigger... */
if (trigger_point < (BS - 1)) {
logic.length = BS - trigger_point;
logic.unitsize = 1;
logic.data = ctx->final_buf + (block * BS) + trigger_point;
- sr_session_bus(ctx->session_id, &packet);
+ sr_session_send(ctx->session_dev_id, &packet);
}
}
-static int receive_data(int fd, int revents, void *session_data)
+static int receive_data(int fd, int revents, void *cb_data)
{
int i, ret;
struct sr_dev_inst *sdi;
(void)fd;
(void)revents;
- if (!(sdi = session_data)) {
- sr_err("la8: %s: session_data was NULL", __func__);
+ if (!(sdi = cb_data)) {
+ sr_err("la8: %s: cb_data was NULL", __func__);
return FALSE;
}
return FALSE;
}
+ if (!ctx->ftdic) {
+ sr_err("la8: %s: ctx->ftdic was NULL", __func__);
+ return FALSE;
+ }
+
/* Get one block of data. */
if ((ret = la8_read_block(ctx)) < 0) {
sr_err("la8: %s: la8_read_block error: %d", __func__, ret);
- hw_dev_acquisition_stop(sdi->index, session_data);
+ hw_dev_acquisition_stop(sdi->index, sdi);
return FALSE;
}
return TRUE;
}
- sr_dbg("la8: sampling finished, sending data to session bus now");
+ 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 < NUM_BLOCKS; i++)
send_block_to_session_bus(ctx, i);
- hw_dev_acquisition_stop(sdi->index, session_data);
+ hw_dev_acquisition_stop(sdi->index, sdi);
// return FALSE; /* FIXME? */
return TRUE;
}
-static int hw_dev_acquisition_start(int dev_index, gpointer session_data)
+static int hw_dev_acquisition_start(int dev_index, void *cb_data)
{
struct sr_dev_inst *sdi;
struct context *ctx;
struct sr_datafeed_packet packet;
struct sr_datafeed_header header;
+ struct sr_datafeed_meta_logic meta;
uint8_t buf[4];
int bytes_written;
- sr_spew("la8: entering %s", __func__);
-
if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) {
sr_err("la8: %s: sdi was NULL", __func__);
- return SR_ERR; /* TODO: SR_ERR_ARG? */
+ return SR_ERR_BUG;
}
if (!(ctx = sdi->priv)) {
sr_err("la8: %s: sdi->priv was NULL", __func__);
- return SR_ERR; /* TODO: SR_ERR_ARG? */
+ return SR_ERR_BUG;
}
if (!ctx->ftdic) {
sr_err("la8: %s: ctx->ftdic was NULL", __func__);
- return SR_ERR_ARG;
+ return SR_ERR_BUG;
}
ctx->divcount = samplerate_to_divcount(ctx->cur_samplerate);
return SR_ERR;
}
+ sr_dbg("la8: Starting acquisition.");
+
/* Fill acquisition parameters into buf[]. */
buf[0] = ctx->divcount;
buf[1] = 0xff; /* This byte must always be 0xff. */
bytes_written = la8_write(ctx, buf, 4);
if (bytes_written < 0) {
- sr_err("la8: acquisition failed to start");
+ sr_err("la8: Acquisition failed to start.");
return SR_ERR;
} else if (bytes_written != 4) {
- sr_err("la8: acquisition failed to start");
+ sr_err("la8: Acquisition failed to start.");
return SR_ERR; /* TODO: Other error and return code? */
}
- sr_dbg("la8: acquisition started successfully");
+ sr_dbg("la8: Acquisition started successfully.");
- ctx->session_id = session_data;
+ ctx->session_dev_id = cb_data;
/* Send header packet to the session bus. */
- sr_dbg("la8: %s: sending SR_DF_HEADER", __func__);
+ sr_dbg("la8: Sending SR_DF_HEADER.");
packet.type = SR_DF_HEADER;
packet.payload = &header;
header.feed_version = 1;
gettimeofday(&header.starttime, NULL);
- header.samplerate = ctx->cur_samplerate;
- header.num_logic_probes = NUM_PROBES;
- sr_session_bus(session_data, &packet);
+ sr_session_send(ctx->session_dev_id, &packet);
+
+ /* Send metadata about the SR_DF_LOGIC packets to come. */
+ packet.type = SR_DF_META_LOGIC;
+ packet.payload = &meta;
+ meta.samplerate = ctx->cur_samplerate;
+ meta.num_probes = NUM_PROBES;
+ sr_session_send(ctx->session_dev_id, &packet);
/* Time when we should be done (for detecting trigger timeouts). */
ctx->done = (ctx->divcount + 1) * 0.08388608 + time(NULL)
return SR_OK;
}
-static int hw_dev_acquisition_stop(int dev_index, gpointer session_data)
+static int hw_dev_acquisition_stop(int dev_index, void *cb_data)
{
struct sr_dev_inst *sdi;
struct context *ctx;
struct sr_datafeed_packet packet;
- sr_dbg("la8: stopping acquisition");
+ sr_dbg("la8: Stopping acquisition.");
if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) {
sr_err("la8: %s: sdi was NULL", __func__);
}
/* Send end packet to the session bus. */
- sr_dbg("la8: %s: sending SR_DF_END", __func__);
+ sr_dbg("la8: Sending SR_DF_END.");
packet.type = SR_DF_END;
- sr_session_bus(session_data, &packet);
+ sr_session_send(cb_data, &packet);
return SR_OK;
}
-SR_PRIV struct sr_dev_plugin chronovu_la8_plugin_info = {
+SR_PRIV struct sr_dev_driver chronovu_la8_driver_info = {
.name = "chronovu-la8",
.longname = "ChronoVu LA8",
.api_version = 1,
projects / libsigrok.git / blobdiff