]> sigrok.org Git - libsigrok.git/blobdiff - hardware/chronovu-la8/api.c
la8: Cleanups, cosmetics, simplifications.
[libsigrok.git] / hardware / chronovu-la8 / api.c
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;