]> sigrok.org Git - libsigrok.git/commitdiff
la8: Cleanups, cosmetics, simplifications.
authorUwe Hermann <redacted>
Sun, 30 Mar 2014 20:40:27 +0000 (22:40 +0200)
committerUwe Hermann <redacted>
Wed, 2 Apr 2014 15:20:09 +0000 (17:20 +0200)
Also, make some LA8 references more generic in preparation of
LA16 support.

hardware/chronovu-la8/api.c
hardware/chronovu-la8/protocol.c
hardware/chronovu-la8/protocol.h

index 896ee74ae51f746a7b89c59c8ed3c43cbb7afe78..fb364502e023d290297b5de5498c6f292437178d 100644 (file)
@@ -1,7 +1,7 @@
 /*
  * This file is part of the libsigrok project.
  *
- * Copyright (C) 2011-2012 Uwe Hermann <uwe@hermann-uwe.de>
+ * Copyright (C) 2011-2014 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
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  */
 
-#include <ftdi.h>
-#include <glib.h>
-#include <string.h>
-#include "libsigrok.h"
-#include "libsigrok-internal.h"
 #include "protocol.h"
 
 SR_PRIV struct sr_dev_driver chronovu_la8_driver_info;
@@ -34,10 +29,9 @@ static struct sr_dev_driver *di = &chronovu_la8_driver_info;
  * Min: 1 sample per 0.01us -> sample time is 0.084s, samplerate 100MHz
  * Max: 1 sample per 2.55us -> sample time is 21.391s, samplerate 392.15kHz
  */
-SR_PRIV uint64_t chronovu_la8_samplerates[255] = { 0 };
+SR_PRIV uint64_t cv_samplerates[255] = { 0 };
 
-/* Note: Continuous sampling is not supported by the hardware. */
-SR_PRIV const int32_t chronovu_la8_hwcaps[] = {
+SR_PRIV const int32_t cv_hwcaps[] = {
        SR_CONF_LOGIC_ANALYZER,
        SR_CONF_SAMPLERATE,
        SR_CONF_LIMIT_MSEC, /* TODO: Not yet implemented. */
@@ -53,13 +47,12 @@ static const uint16_t usb_pids[] = {
        0x8867,
 };
 
-/* Function prototypes. */
 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data);
 
 static void clear_helper(void *priv)
 {
        struct dev_context *devc;
-       
+
        devc = priv;
 
        ftdi_free(devc->ftdic);
@@ -93,10 +86,7 @@ static GSList *scan(GSList *options)
        devices = NULL;
 
        /* Allocate memory for our private device context. */
-       if (!(devc = g_try_malloc(sizeof(struct dev_context)))) {
-               sr_err("Device context malloc failed.");
-               goto err_free_nothing;
-       }
+       devc = g_try_malloc(sizeof(struct dev_context));
 
        /* Set some sane defaults. */
        devc->ftdic = NULL;
@@ -117,13 +107,13 @@ static GSList *scan(GSList *options)
 
        /* Allocate memory where we'll store the de-mangled data. */
        if (!(devc->final_buf = g_try_malloc(SDRAM_SIZE))) {
-               sr_err("final_buf malloc failed.");
+               sr_err("Failed to allocate memory for sample buffer.");
                goto err_free_devc;
        }
 
        /* Allocate memory for the FTDI context (ftdic) and initialize it. */
        if (!(devc->ftdic = ftdi_new())) {
-               sr_err("%s: ftdi_new failed.", __func__);
+               sr_err("Failed to initialize libftdi.");
                goto err_free_final_buf;
        }
 
@@ -147,15 +137,15 @@ static GSList *scan(GSList *options)
        sdi = sr_dev_inst_new(0, SR_ST_INITIALIZING,
                        USB_VENDOR_NAME, USB_MODEL_NAME, USB_MODEL_VERSION);
        if (!sdi) {
-               sr_err("%s: sr_dev_inst_new failed.", __func__);
+               sr_err("Failed to create device instance.");
                goto err_close_ftdic;
        }
        sdi->driver = di;
        sdi->priv = devc;
 
-       for (i = 0; chronovu_la8_channel_names[i]; i++) {
+       for (i = 0; cv_channel_names[i]; i++) {
                if (!(ch = sr_channel_new(i, SR_CHANNEL_LOGIC, TRUE,
-                                          chronovu_la8_channel_names[i])))
+                                         cv_channel_names[i])))
                        return NULL;
                sdi->channels = g_slist_append(sdi->channels, ch);
        }
@@ -164,12 +154,12 @@ static GSList *scan(GSList *options)
        drvc->instances = g_slist_append(drvc->instances, sdi);
 
        /* Close device. We'll reopen it again when we need it. */
-       (void) la8_close(devc); /* Log, but ignore errors. */
+       (void) cv_close(devc); /* Log, but ignore errors. */
 
        return devices;
 
 err_close_ftdic:
-       (void) la8_close(devc); /* Log, but ignore errors. */
+       (void) cv_close(devc); /* Log, but ignore errors. */
 err_free_ftdic:
        ftdi_free(devc->ftdic); /* NOT free() or g_free()! */
 err_free_final_buf:
@@ -191,10 +181,8 @@ static int dev_open(struct sr_dev_inst *sdi)
        struct dev_context *devc;
        int ret;
 
-       if (!(devc = sdi->priv)) {
-               sr_err("%s: sdi->priv was NULL.", __func__);
+       if (!(devc = sdi->priv))
                return SR_ERR_BUG;
-       }
 
        sr_dbg("Opening LA8 device (%04x:%04x).", USB_VENDOR_ID,
               devc->usb_pid);
@@ -202,27 +190,27 @@ static int dev_open(struct sr_dev_inst *sdi)
        /* Open the device. */
        if ((ret = ftdi_usb_open_desc(devc->ftdic, USB_VENDOR_ID,
                        devc->usb_pid, USB_DESCRIPTION, NULL)) < 0) {
-               sr_err("%s: ftdi_usb_open_desc: (%d) %s",
-                      __func__, ret, ftdi_get_error_string(devc->ftdic));
-               (void) la8_close_usb_reset_sequencer(devc); /* Ignore errors. */
+               sr_err("Failed to open FTDI device (%d): %s.",
+                      ret, ftdi_get_error_string(devc->ftdic));
+               (void) cv_close_usb_reset_sequencer(devc); /* Ignore errors. */
                return SR_ERR;
        }
        sr_dbg("Device opened successfully.");
 
        /* Purge RX/TX buffers in the FTDI chip. */
        if ((ret = ftdi_usb_purge_buffers(devc->ftdic)) < 0) {
-               sr_err("%s: ftdi_usb_purge_buffers: (%d) %s",
-                      __func__, ret, ftdi_get_error_string(devc->ftdic));
-               (void) la8_close_usb_reset_sequencer(devc); /* Ignore errors. */
+               sr_err("Failed to purge FTDI buffers (%d): %s.",
+                      ret, ftdi_get_error_string(devc->ftdic));
+               (void) cv_close_usb_reset_sequencer(devc); /* Ignore errors. */
                goto err_dev_open_close_ftdic;
        }
        sr_dbg("FTDI buffers purged successfully.");
 
        /* Enable flow control in the FTDI chip. */
        if ((ret = ftdi_setflowctrl(devc->ftdic, SIO_RTS_CTS_HS)) < 0) {
-               sr_err("%s: ftdi_setflowcontrol: (%d) %s",
-                      __func__, ret, ftdi_get_error_string(devc->ftdic));
-               (void) la8_close_usb_reset_sequencer(devc); /* Ignore errors. */
+               sr_err("Failed to enable FTDI flow control (%d): %s.",
+                      ret, ftdi_get_error_string(devc->ftdic));
+               (void) cv_close_usb_reset_sequencer(devc); /* Ignore errors. */
                goto err_dev_open_close_ftdic;
        }
        sr_dbg("FTDI flow control enabled successfully.");
@@ -235,7 +223,7 @@ static int dev_open(struct sr_dev_inst *sdi)
        return SR_OK;
 
 err_dev_open_close_ftdic:
-       (void) la8_close(devc); /* Log, but ignore errors. */
+       (void) cv_close(devc); /* Log, but ignore errors. */
        return SR_ERR;
 }
 
@@ -247,7 +235,7 @@ static int dev_close(struct sr_dev_inst *sdi)
 
        if (sdi->status == SR_ST_ACTIVE) {
                sr_dbg("Status ACTIVE, closing device.");
-               (void) la8_close_usb_reset_sequencer(devc); /* Ignore errors. */
+               (void) cv_close_usb_reset_sequencer(devc); /* Ignore errors. */
        } else {
                sr_spew("Status not ACTIVE, nothing to do.");
        }
@@ -271,13 +259,9 @@ static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi,
 
        switch (id) {
        case SR_CONF_SAMPLERATE:
-               if (sdi) {
-                       devc = sdi->priv;
-                       *data = g_variant_new_uint64(devc->cur_samplerate);
-                       sr_spew("%s: Returning samplerate: %" PRIu64 "Hz.",
-                               __func__, devc->cur_samplerate);
-               } else
-                       return SR_ERR;
+               if (!sdi || !(devc = sdi->priv))
+                       return SR_ERR_BUG;
+               *data = g_variant_new_uint64(devc->cur_samplerate);
                break;
        default:
                return SR_ERR_NA;
@@ -296,34 +280,23 @@ static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
        if (sdi->status != SR_ST_ACTIVE)
                return SR_ERR_DEV_CLOSED;
 
-       if (!(devc = sdi->priv)) {
-               sr_err("%s: sdi->priv was NULL.", __func__);
+       if (!(devc = sdi->priv))
                return SR_ERR_BUG;
-       }
 
        switch (id) {
        case SR_CONF_SAMPLERATE:
-               if (set_samplerate(sdi, g_variant_get_uint64(data)) == SR_ERR) {
-                       sr_err("%s: setting samplerate failed.", __func__);
+               if (set_samplerate(sdi, g_variant_get_uint64(data)) < 0)
                        return SR_ERR;
-               }
-               sr_dbg("SAMPLERATE = %" PRIu64, devc->cur_samplerate);
                break;
        case SR_CONF_LIMIT_MSEC:
-               if (g_variant_get_uint64(data) == 0) {
-                       sr_err("%s: LIMIT_MSEC can't be 0.", __func__);
-                       return SR_ERR;
-               }
+               if (g_variant_get_uint64(data) == 0)
+                       return SR_ERR_ARG;
                devc->limit_msec = g_variant_get_uint64(data);
-               sr_dbg("LIMIT_MSEC = %" PRIu64, devc->limit_msec);
                break;
        case SR_CONF_LIMIT_SAMPLES:
-               if (g_variant_get_uint64(data) < MIN_NUM_SAMPLES) {
-                       sr_err("%s: LIMIT_SAMPLES too small.", __func__);
-                       return SR_ERR;
-               }
+               if (g_variant_get_uint64(data) == 0)
+                       return SR_ERR_ARG;
                devc->limit_samples = g_variant_get_uint64(data);
-               sr_dbg("LIMIT_SAMPLES = %" PRIu64, devc->limit_samples);
                break;
        default:
                return SR_ERR_NA;
@@ -344,16 +317,14 @@ static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
        switch (key) {
        case SR_CONF_DEVICE_OPTIONS:
                *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
-                               chronovu_la8_hwcaps,
-                               ARRAY_SIZE(chronovu_la8_hwcaps),
+                               cv_hwcaps, ARRAY_SIZE(cv_hwcaps),
                                sizeof(int32_t));
                break;
        case SR_CONF_SAMPLERATE:
-               fill_supported_samplerates_if_needed();
+               cv_fill_samplerates_if_needed();
                g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
                gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
-                               chronovu_la8_samplerates,
-                               ARRAY_SIZE(chronovu_la8_samplerates),
+                               cv_samplerates, ARRAY_SIZE(cv_samplerates),
                                sizeof(uint64_t));
                g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
                *data = g_variant_builder_end(&gvb);
@@ -383,23 +354,23 @@ static int receive_data(int fd, int revents, void *cb_data)
        (void)revents;
 
        if (!(sdi = cb_data)) {
-               sr_err("%s: cb_data was NULL.", __func__);
+               sr_err("cb_data was NULL.");
                return FALSE;
        }
 
        if (!(devc = sdi->priv)) {
-               sr_err("%s: sdi->priv was NULL.", __func__);
+               sr_err("sdi->priv was NULL.");
                return FALSE;
        }
 
        if (!devc->ftdic) {
-               sr_err("%s: devc->ftdic was NULL.", __func__);
+               sr_err("devc->ftdic was NULL.");
                return FALSE;
        }
 
        /* Get one block of data. */
-       if ((ret = la8_read_block(devc)) < 0) {
-               sr_err("%s: la8_read_block error: %d.", __func__, ret);
+       if ((ret = cv_read_block(devc)) < 0) {
+               sr_err("Failed to read data block: %d.", ret);
                dev_acquisition_stop(sdi, sdi);
                return FALSE;
        }
@@ -414,7 +385,7 @@ static int receive_data(int fd, int revents, void *cb_data)
 
        /* All data was received and demangled, send it to the session bus. */
        for (i = 0; i < NUM_BLOCKS; i++)
-               send_block_to_session_bus(devc, i);
+               cv_send_block_to_session_bus(devc, i);
 
        dev_acquisition_stop(sdi, sdi);
 
@@ -431,22 +402,22 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
                return SR_ERR_DEV_CLOSED;
 
        if (!(devc = sdi->priv)) {
-               sr_err("%s: sdi->priv was NULL.", __func__);
+               sr_err("sdi->priv was NULL.");
                return SR_ERR_BUG;
        }
 
        if (!devc->ftdic) {
-               sr_err("%s: devc->ftdic was NULL.", __func__);
+               sr_err("devc->ftdic was NULL.");
                return SR_ERR_BUG;
        }
 
-       devc->divcount = samplerate_to_divcount(devc->cur_samplerate);
+       devc->divcount = cv_samplerate_to_divcount(devc->cur_samplerate);
        if (devc->divcount == 0xff) {
-               sr_err("%s: Invalid divcount/samplerate.", __func__);
+               sr_err("Invalid divcount/samplerate.");
                return SR_ERR;
        }
 
-       if (configure_channels(sdi) != SR_OK) {
+       if (cv_configure_channels(sdi) != SR_OK) {
                sr_err("Failed to configure channels.");
                return SR_ERR;
        }
@@ -458,7 +429,7 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
        buf[3] = devc->trigger_mask;
 
        /* Start acquisition. */
-       bytes_written = la8_write(devc, buf, 4);
+       bytes_written = cv_write(devc, buf, 4);
 
        if (bytes_written < 0) {
                sr_err("Acquisition failed to start: %d.", bytes_written);
@@ -481,7 +452,7 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
        devc->block_counter = 0;
        devc->trigger_found = 0;
 
-       /* Hook up a dummy handler to receive data from the LA8. */
+       /* Hook up a dummy handler to receive data from the device. */
        sr_source_add(-1, G_IO_IN, 0, receive_data, (void *)sdi);
 
        return SR_OK;
index 6f8738bca6dd9d84eb8e599591ee9b2ea93ab320..3a50fe613104feb0643f8b4ef0b7b803500b3c15 100644 (file)
@@ -1,7 +1,7 @@
 /*
  * This file is part of the libsigrok project.
  *
- * Copyright (C) 2011-2012 Uwe Hermann <uwe@hermann-uwe.de>
+ * Copyright (C) 2011-2014 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
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  */
 
-#include <ftdi.h>
-#include <glib.h>
-#include "libsigrok.h"
-#include "libsigrok-internal.h"
 #include "protocol.h"
 
 /* Channels are numbered 0-7. */
-SR_PRIV const char *chronovu_la8_channel_names[NUM_CHANNELS + 1] = {
+SR_PRIV const char *cv_channel_names[NUM_CHANNELS + 1] = {
        "0", "1", "2", "3", "4", "5", "6", "7",
        NULL,
 };
 
-SR_PRIV void fill_supported_samplerates_if_needed(void)
+SR_PRIV void cv_fill_samplerates_if_needed(void)
 {
        int i;
 
-       if (chronovu_la8_samplerates[0] != 0)
+       if (cv_samplerates[0] != 0)
                return;
 
        for (i = 0; i < 255; i++)
-               chronovu_la8_samplerates[254 - i] = SR_MHZ(100) / (i + 1);
+               cv_samplerates[254 - i] = SR_MHZ(100) / (i + 1);
 }
 
 /**
- * Check if the given samplerate is supported by the LA8 hardware.
+ * Check if the given samplerate is supported by the hardware.
  *
  * @param samplerate The samplerate (in Hz) to check.
  * @return 1 if the samplerate is supported/valid, 0 otherwise.
  */
-SR_PRIV int is_valid_samplerate(uint64_t samplerate)
+static int is_valid_samplerate(uint64_t samplerate)
 {
        int i;
 
-       fill_supported_samplerates_if_needed();
+       cv_fill_samplerates_if_needed();
 
        for (i = 0; i < 255; i++) {
-               if (chronovu_la8_samplerates[i] == samplerate)
+               if (cv_samplerates[i] == samplerate)
                        return 1;
        }
 
@@ -64,7 +60,7 @@ SR_PRIV int is_valid_samplerate(uint64_t samplerate)
 }
 
 /**
- * Convert a samplerate (in Hz) to the 'divcount' value the LA8 wants.
+ * Convert a samplerate (in Hz) to the 'divcount' value the device wants.
  *
  * LA8 hardware: sample period = (divcount + 1) * 10ns.
  * Min. value for divcount: 0x00 (10ns sample period, 100MHz samplerate).
@@ -73,15 +69,15 @@ SR_PRIV int is_valid_samplerate(uint64_t samplerate)
  * @param samplerate The samplerate in Hz.
  * @return The divcount value as needed by the hardware, or 0xff upon errors.
  */
-SR_PRIV uint8_t samplerate_to_divcount(uint64_t samplerate)
+SR_PRIV uint8_t cv_samplerate_to_divcount(uint64_t samplerate)
 {
        if (samplerate == 0) {
-               sr_err("%s: samplerate was 0.", __func__);
+               sr_err("Can't convert invalid samplerate of 0 Hz.");
                return 0xff;
        }
 
        if (!is_valid_samplerate(samplerate)) {
-               sr_err("%s: Can't get divcount, samplerate invalid.", __func__);
+               sr_err("Can't get divcount, samplerate invalid.");
                return 0xff;
        }
 
@@ -89,85 +85,73 @@ SR_PRIV uint8_t samplerate_to_divcount(uint64_t samplerate)
 }
 
 /**
- * Write data of a certain length to the LA8's FTDI device.
+ * Write data of a certain length to the FTDI device.
  *
  * @param devc The struct containing private per-device-instance data. Must not
- *            be NULL. devc->ftdic must not be NULL either.
+ *             be NULL. devc->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.
+ * @param size The number of bytes to write. Must be > 0.
+ *
  * @return The number of bytes written, or a negative value upon errors.
  */
-SR_PRIV int la8_write(struct dev_context *devc, uint8_t *buf, int size)
+SR_PRIV int cv_write(struct dev_context *devc, uint8_t *buf, int size)
 {
        int bytes_written;
 
-       /* Note: Caller checked that devc and devc->ftdic != NULL. */
+       /* Note: Caller ensures devc/devc->ftdic/buf != NULL and size > 0. */
 
-       if (!buf) {
-               sr_err("%s: buf was NULL.", __func__);
+       if (!buf)
                return SR_ERR_ARG;
-       }
 
-       if (size < 0) {
-               sr_err("%s: size was < 0.", __func__);
+       if (size < 0)
                return SR_ERR_ARG;
-       }
 
        bytes_written = ftdi_write_data(devc->ftdic, buf, size);
 
        if (bytes_written < 0) {
-               sr_err("%s: ftdi_write_data: (%d) %s.", __func__,
+               sr_err("Failed to write data (%d): %s.",
                       bytes_written, ftdi_get_error_string(devc->ftdic));
-               (void) la8_close_usb_reset_sequencer(devc); /* Ignore errors. */
+               (void) cv_close_usb_reset_sequencer(devc); /* Ignore errors. */
        } else if (bytes_written != size) {
-               sr_err("%s: bytes to write: %d, bytes written: %d.",
-                      __func__, size, bytes_written);
-               (void) la8_close_usb_reset_sequencer(devc); /* Ignore errors. */
+               sr_err("Failed to write data, only %d/%d bytes written.",
+                      size, bytes_written);
+               (void) cv_close_usb_reset_sequencer(devc); /* Ignore errors. */
        }
 
        return bytes_written;
 }
 
 /**
- * Read a certain amount of bytes from the LA8's FTDI device.
+ * Read a certain amount of bytes from the FTDI device.
  *
  * @param devc The struct containing private per-device-instance data. Must not
- *            be NULL. devc->ftdic must not be NULL either.
+ *             be NULL. devc->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.
  */
-SR_PRIV int la8_read(struct dev_context *devc, uint8_t *buf, int size)
+static int cv_read(struct dev_context *devc, uint8_t *buf, int size)
 {
        int bytes_read;
 
-       /* Note: Caller checked that devc and devc->ftdic != NULL. */
-
-       if (!buf) {
-               sr_err("%s: buf was NULL.", __func__);
-               return SR_ERR_ARG;
-       }
-
-       if (size <= 0) {
-               sr_err("%s: size was <= 0.", __func__);
-               return SR_ERR_ARG;
-       }
+       /* Note: Caller ensures devc/devc->ftdic/buf != NULL and size > 0. */
 
        bytes_read = ftdi_read_data(devc->ftdic, buf, size);
 
        if (bytes_read < 0) {
-               sr_err("%s: ftdi_read_data: (%d) %s.", __func__,
+               sr_err("Failed to read data (%d): %s.",
                       bytes_read, ftdi_get_error_string(devc->ftdic));
        } else if (bytes_read != size) {
-               // sr_err("%s: Bytes to read: %d, bytes read: %d.",
-               //        __func__, size, bytes_read);
+               // sr_err("Failed to read data, only %d/%d bytes read.",
+               //        bytes_read, size);
        }
 
        return bytes_read;
 }
 
-SR_PRIV int la8_close(struct dev_context *devc)
+SR_PRIV int cv_close(struct dev_context *devc)
 {
        int ret;
 
@@ -190,31 +174,29 @@ SR_PRIV int la8_close(struct dev_context *devc)
 }
 
 /**
- * Close the ChronoVu LA8 USB port and reset the LA8 sequencer logic.
+ * Close the USB port and reset the sequencer logic.
  *
  * @param devc The struct containing private per-device-instance data.
  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
  */
-SR_PRIV int la8_close_usb_reset_sequencer(struct dev_context *devc)
+SR_PRIV int cv_close_usb_reset_sequencer(struct dev_context *devc)
 {
-       /* Magic sequence of bytes for resetting the LA8 sequencer logic. */
+       /* Magic sequence of bytes for resetting the sequencer logic. */
        uint8_t buf[8] = {0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01};
        int ret;
 
-       if (!devc) {
-               sr_err("%s: devc was NULL.", __func__);
+       if (!devc)
                return SR_ERR_ARG;
-       }
 
        if (!devc->ftdic) {
-               sr_err("%s: devc->ftdic was NULL.", __func__);
+               sr_err("devc->ftdic was NULL.");
                return SR_ERR_ARG;
        }
 
        if (devc->ftdic->usb_dev) {
-               /* Reset the LA8 sequencer logic, then wait 100ms. */
+               /* Reset the sequencer logic, then wait 100ms. */
                sr_dbg("Resetting sequencer logic.");
-               (void) la8_write(devc, buf, 8); /* Ignore errors. */
+               (void) cv_write(devc, buf, 8); /* Ignore errors. */
                g_usleep(100 * 1000);
 
                /* Purge FTDI buffers, then reset and close the FTDI device. */
@@ -240,14 +222,14 @@ SR_PRIV int la8_close_usb_reset_sequencer(struct dev_context *devc)
 }
 
 /**
- * Reset the ChronoVu LA8.
+ * Reset the ChronoVu device.
  *
- * The LA8 must be reset after a failed read/write operation or upon timeouts.
+ * A reset is required after a failed read/write operation or upon timeouts.
  *
  * @param devc The struct containing private per-device-instance data.
  * @return SR_OK upon success, SR_ERR upon failure.
  */
-SR_PRIV int la8_reset(struct dev_context *devc)
+static int cv_reset(struct dev_context *devc)
 {
        uint8_t buf[BS];
        time_t done, now;
@@ -271,20 +253,20 @@ SR_PRIV int la8_reset(struct dev_context *devc)
         */
        done = 20 + time(NULL);
        do {
-               /* TODO: Ignore errors? Check for < 0 at least! */
-               bytes_read = la8_read(devc, (uint8_t *)&buf, BS);
+               /* Try to read bytes until none are left (or errors occur). */
+               bytes_read = cv_read(devc, (uint8_t *)&buf, BS);
                now = time(NULL);
        } while ((done > now) && (bytes_read > 0));
 
-       /* Reset the LA8 sequencer logic and close the USB port. */
-       (void) la8_close_usb_reset_sequencer(devc); /* Ignore errors. */
+       /* Reset the sequencer logic and close the USB port. */
+       (void) cv_close_usb_reset_sequencer(devc); /* Ignore errors. */
 
        sr_dbg("Device reset finished.");
 
        return SR_OK;
 }
 
-SR_PRIV int configure_channels(const struct sr_dev_inst *sdi)
+SR_PRIV int cv_configure_channels(const struct sr_dev_inst *sdi)
 {
        struct dev_context *devc;
        const struct sr_channel *ch;
@@ -343,7 +325,7 @@ SR_PRIV int configure_channels(const struct sr_dev_inst *sdi)
        return SR_OK;
 }
 
-SR_PRIV int set_samplerate(const struct sr_dev_inst *sdi, uint64_t samplerate)
+SR_PRIV int cv_set_samplerate(const struct sr_dev_inst *sdi, uint64_t samplerate)
 {
        struct dev_context *devc;
 
@@ -353,11 +335,14 @@ SR_PRIV int set_samplerate(const struct sr_dev_inst *sdi, uint64_t samplerate)
 
        sr_spew("Trying to set samplerate to %" PRIu64 "Hz.", samplerate);
 
-       fill_supported_samplerates_if_needed();
+       cv_fill_samplerates_if_needed();
 
        /* Check if this is a samplerate supported by the hardware. */
-       if (!is_valid_samplerate(samplerate))
+       if (!is_valid_samplerate(samplerate)) {
+               sr_dbg("Failed to set invalid samplerate (%" PRIu64 "Hz).",
+                      samplerate);
                return SR_ERR;
+       }
 
        /* Set the new samplerate. */
        devc->cur_samplerate = samplerate;
@@ -368,13 +353,14 @@ SR_PRIV int set_samplerate(const struct sr_dev_inst *sdi, uint64_t samplerate)
 }
 
 /**
- * Get a block of data from the LA8.
+ * Get a block of data from the device.
  *
  * @param devc The struct containing private per-device-instance data. Must not
- *            be NULL. devc->ftdic must not be NULL either.
+ *             be NULL. devc->ftdic must not be NULL either.
+ *
  * @return SR_OK upon success, or SR_ERR upon errors.
  */
-SR_PRIV int la8_read_block(struct dev_context *devc)
+SR_PRIV int cv_read_block(struct dev_context *devc)
 {
        int i, byte_offset, m, mi, p, index, bytes_read;
        time_t now;
@@ -383,13 +369,13 @@ SR_PRIV int la8_read_block(struct dev_context *devc)
 
        sr_spew("Reading block %d.", devc->block_counter);
 
-       bytes_read = la8_read(devc, devc->mangled_buf, BS);
+       bytes_read = cv_read(devc, devc->mangled_buf, BS);
 
        /* If first block read got 0 bytes, retry until success or timeout. */
        if ((bytes_read == 0) && (devc->block_counter == 0)) {
                do {
                        sr_spew("Reading block 0 (again).");
-                       bytes_read = la8_read(devc, devc->mangled_buf, BS);
+                       bytes_read = cv_read(devc, devc->mangled_buf, BS);
                        /* TODO: How to handle read errors here? */
                        now = time(NULL);
                } while ((devc->done > now) && (bytes_read == 0));
@@ -398,7 +384,7 @@ SR_PRIV int la8_read_block(struct dev_context *devc)
        /* Check if block read was successful or a timeout occured. */
        if (bytes_read != BS) {
                sr_err("Trigger timed out. Bytes read: %d.", bytes_read);
-               (void) la8_reset(devc); /* Ignore errors. */
+               (void) cv_reset(devc); /* Ignore errors. */
                return SR_ERR;
        }
 
@@ -417,7 +403,7 @@ SR_PRIV int la8_read_block(struct dev_context *devc)
        return SR_OK;
 }
 
-SR_PRIV void send_block_to_session_bus(struct dev_context *devc, int block)
+SR_PRIV void cv_send_block_to_session_bus(struct dev_context *devc, int block)
 {
        int i;
        uint8_t sample, expected_sample;
index 5136b770f2efa0c8a9a6565d5e8fb98d5e224ff2..b44ca8165b43cbafbf2719ce895cebdbec3c4963 100644 (file)
@@ -1,7 +1,7 @@
 /*
  * This file is part of the libsigrok project.
  *
- * Copyright (C) 2011-2012 Uwe Hermann <uwe@hermann-uwe.de>
+ * Copyright (C) 2011-2014 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
@@ -38,7 +38,6 @@
 #define NUM_CHANNELS                   8
 #define TRIGGER_TYPE                   "01"
 #define SDRAM_SIZE                     (8 * 1024 * 1024)
-#define MIN_NUM_SAMPLES                        1
 #define MAX_NUM_SAMPLES                        SDRAM_SIZE
 
 #define BS                             4096 /* Block size */
@@ -91,34 +90,31 @@ struct dev_context {
        /** Tells us whether an SR_DF_TRIGGER packet was already sent. */
        int trigger_found;
 
-       /** TODO */
+       /** Used for keeping track how much time has passed. */
        time_t done;
 
        /** Counter/index for the data block to be read. */
        int block_counter;
 
-       /** The divcount value (determines the sample period) for the LA8. */
+       /** The divcount value (determines the sample period). */
        uint8_t divcount;
 
-       /** This ChronoVu LA8's USB PID (multiple versions exist). */
+       /** This ChronoVu device's USB PID. */
        uint16_t usb_pid;
 };
 
 /* protocol.c */
-extern const int32_t chronovu_la8_hwcaps[];
-extern uint64_t chronovu_la8_samplerates[];
-extern SR_PRIV const char *chronovu_la8_channel_names[];
-SR_PRIV void fill_supported_samplerates_if_needed(void);
-SR_PRIV int is_valid_samplerate(uint64_t samplerate);
-SR_PRIV uint8_t samplerate_to_divcount(uint64_t samplerate);
-SR_PRIV int la8_write(struct dev_context *devc, uint8_t *buf, int size);
-SR_PRIV int la8_read(struct dev_context *devc, uint8_t *buf, int size);
-SR_PRIV int la8_close(struct dev_context *devc);
-SR_PRIV int la8_close_usb_reset_sequencer(struct dev_context *devc);
-SR_PRIV int la8_reset(struct dev_context *devc);
-SR_PRIV int configure_channels(const struct sr_dev_inst *sdi);
-SR_PRIV int set_samplerate(const struct sr_dev_inst *sdi, uint64_t samplerate);
-SR_PRIV int la8_read_block(struct dev_context *devc);
-SR_PRIV void send_block_to_session_bus(struct dev_context *devc, int block);
+extern const int32_t cv_hwcaps[];
+extern uint64_t cv_samplerates[];
+extern SR_PRIV const char *cv_channel_names[];
+SR_PRIV void cv_fill_samplerates_if_needed(void);
+SR_PRIV uint8_t cv_samplerate_to_divcount(uint64_t samplerate);
+SR_PRIV int cv_write(struct dev_context *devc, uint8_t *buf, int size);
+SR_PRIV int cv_close(struct dev_context *devc);
+SR_PRIV int cv_close_usb_reset_sequencer(struct dev_context *devc);
+SR_PRIV int cv_configure_channels(const struct sr_dev_inst *sdi);
+SR_PRIV int cv_set_samplerate(const struct sr_dev_inst *sdi, uint64_t samplerate);
+SR_PRIV int cv_read_block(struct dev_context *devc);
+SR_PRIV void cv_send_block_to_session_bus(struct dev_context *devc, int block);
 
 #endif