]> sigrok.org Git - libsigrok.git/blobdiff - hardware/chronovu-la8/chronovu-la8.c
Move the probe naming to the creator of the device, and let each driver name its...
[libsigrok.git] / hardware / chronovu-la8 / chronovu-la8.c
index 8962e01ea9e436508905fe1d925976a9f33f8a7f..d2a88922c28fcf7f8e6381d82b9b5dd33f108797 100644 (file)
@@ -21,8 +21,8 @@
 #include <ftdi.h>
 #include <glib.h>
 #include <string.h>
-#include <sigrok.h>
-#include <sigrok-internal.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;
@@ -45,6 +60,9 @@ struct la8 {
        /** The currently configured samplerate of the device. */
        uint64_t cur_samplerate;
 
+       /** period in picoseconds corresponding to the samplerate */
+       uint64_t period_ps;
+
        /** The current sampling limit (in ms). */
        uint64_t limit_msec;
 
@@ -55,10 +73,10 @@ struct la8 {
        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.
@@ -88,7 +106,7 @@ struct la8 {
        /** 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. */
@@ -120,7 +138,7 @@ static int capabilities[] = {
 
 /* 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 void hw_stop_acquisition(int device_index, gpointer session_data);
 static int la8_reset(struct la8 *la8);
 
 static void fill_supported_samplerates_if_needed(void)
@@ -312,7 +330,7 @@ static int la8_close_usb_reset_sequencer(struct la8 *la8)
        uint8_t buf[8] = {0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01};
        int ret;
 
-       sr_dbg("la8: entering %s", __func__);
+       sr_spew("la8: entering %s", __func__);
 
        if (!la8) {
                sr_err("la8: %s: la8 was NULL", __func__);
@@ -344,7 +362,7 @@ static int la8_close_usb_reset_sequencer(struct la8 *la8)
                        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_spew("la8: %s: usb_dev was NULL, nothing to do", __func__);
        }
 
        ftdi_free(la8->ftdic); /* Returns void. */
@@ -363,7 +381,7 @@ static int la8_close_usb_reset_sequencer(struct la8 *la8)
  */
 static int la8_reset(struct la8 *la8)
 {
-       uint8_t buf[4096];
+       uint8_t buf[BS];
        time_t done, now;
        int bytes_read;
 
@@ -386,7 +404,7 @@ static int la8_reset(struct la8 *la8)
        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));
 
@@ -461,25 +479,25 @@ static int hw_init(const char *deviceinfo)
        struct sr_device_instance *sdi;
        struct la8 *la8;
 
-       sr_dbg("la8: entering %s", __func__);
+       sr_spew("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;
        }
 
        /* Set some sane defaults. */
        la8->ftdic = NULL;
        la8->cur_samplerate = SR_MHZ(100); /* 100MHz == max. samplerate */
+       la8->period_ps = 10000;
        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". */
@@ -492,24 +510,21 @@ static int hw_init(const char *deviceinfo)
        /* 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",
+               sr_dbg("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");
@@ -519,7 +534,6 @@ static int hw_init(const char *deviceinfo)
                        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;
        }
 
@@ -527,12 +541,11 @@ static int hw_init(const char *deviceinfo)
 
        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:
@@ -544,7 +557,7 @@ err_free_final_buf:
 err_free_la8:
        g_free(la8);
 err_free_nothing:
-       // return ret; /* TODO */
+
        return 0;
 }
 
@@ -620,7 +633,7 @@ static int set_samplerate(struct sr_device_instance *sdi, uint64_t samplerate)
                return SR_ERR_ARG;
        }
 
-       sr_dbg("la8: setting samplerate");
+       sr_spew("la8: setting samplerate");
 
        fill_supported_samplerates_if_needed();
 
@@ -630,6 +643,7 @@ static int set_samplerate(struct sr_device_instance *sdi, uint64_t samplerate)
 
        /* Set the new samplerate. */
        la8->cur_samplerate = samplerate;
+       la8->period_ps = 1000000000000 / samplerate;
 
        sr_dbg("la8: samplerate set to %" PRIu64 "Hz", la8->cur_samplerate);
 
@@ -658,7 +672,7 @@ static int hw_closedev(int device_index)
                /* 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;
@@ -674,7 +688,7 @@ static void hw_cleanup(void)
        GSList *l;
        struct sr_device_instance *sdi;
 
-       sr_dbg("la8: entering %s", __func__);
+       sr_spew("la8: entering %s", __func__);
 
        /* Properly close all devices. */
        for (l = device_instances; l; l = l->next) {
@@ -682,11 +696,17 @@ static void hw_cleanup(void)
                        sr_warn("la8: %s: sdi was NULL, continuing", __func__);
                        continue;
                }
+#if 0
+               /*
+                * Fixes a segfault as it's free()d elsewhere already.
+                * TODO: Document who is supposed to free this, and when.
+                */
                if (sdi->priv != NULL)
                        free(sdi->priv);
                else
                        sr_warn("la8: %s: sdi->priv was NULL, nothing "
                                "to do", __func__);
+#endif
                sr_device_instance_free(sdi); /* Returns void. */
        }
        g_slist_free(device_instances); /* Returns void. */
@@ -699,7 +719,7 @@ 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))) {
                sr_err("la8: %s: sdi was NULL", __func__);
@@ -718,6 +738,9 @@ static void *hw_get_device_info(int device_index, int device_info_id)
        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;
@@ -754,7 +777,7 @@ static int hw_get_status(int device_index)
 
 static int *hw_get_capabilities(void)
 {
-       sr_dbg("la8: entering %s", __func__);
+       sr_spew("la8: entering %s", __func__);
 
        return capabilities;
 }
@@ -764,7 +787,7 @@ static int hw_set_configuration(int device_index, int capability, void *value)
        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))) {
                sr_err("la8: %s: sdi was NULL", __func__);
@@ -815,7 +838,7 @@ static int hw_set_configuration(int device_index, int capability, void *value)
 }
 
 /**
- * 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.
@@ -835,33 +858,33 @@ static int la8_read_block(struct la8 *la8)
                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) {
+       if (bytes_read != BS) {
                sr_warn("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);
@@ -876,6 +899,7 @@ 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. */
@@ -883,12 +907,20 @@ static void send_block_to_session_bus(struct la8 *la8, int block)
        /* 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 < 4096; i++) {
+       for (i = 0; i < BS; i++) {
                /* Don't continue if the trigger was found previously. */
                if (la8->trigger_found)
                        break;
 
-               sample = *(la8->final_buf + (block * 4096) + i);
+               /*
+                * 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;
@@ -899,12 +931,16 @@ static void send_block_to_session_bus(struct la8 *la8, int block)
 
        /* If no trigger was found, send one SR_DF_LOGIC packet. */
        if (trigger_point == -1) {
-               /* Send a 4096 byte SR_DF_LOGIC packet to the session bus. */
-               // sr_dbg("la8: %s: sending SR_DF_LOGIC packet", __func__);
+               /* 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.length = 4096;
-               packet.unitsize = 1;
-               packet.payload = la8->final_buf + (block * 4096);
+               packet.timeoffset = block * BS * la8->period_ps;
+               packet.duration = BS * la8->period_ps;
+               packet.payload = &logic;
+               logic.length = BS;
+               logic.unitsize = 1;
+               logic.data = la8->final_buf + (block * BS);
                sr_session_bus(la8->session_id, &packet);
                return;
        }
@@ -921,52 +957,55 @@ static void send_block_to_session_bus(struct la8 *la8, int block)
        /* 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_dbg("la8: %s: sending pre-trigger SR_DF_LOGIC packet, ",
-                      "start = %" PRIu64 ", length = %d", __func__,
-                      block * 4096, trigger_point);
+               sr_spew("la8: sending pre-trigger SR_DF_LOGIC packet, "
+                       "start = %d, length = %d", block * BS, trigger_point);
                packet.type = SR_DF_LOGIC;
-               packet.length = trigger_point;
-               packet.unitsize = 1;
-               packet.payload = la8->final_buf + (block * 4096);
+               packet.timeoffset = block * BS * la8->period_ps;
+               packet.duration = trigger_point * la8->period_ps;
+               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_dbg("la8: %s: sending SR_DF_TRIGGER packet, sample = %" PRIu64,
-              __func__, (block * 4096) + trigger_point);
+       sr_spew("la8: sending SR_DF_TRIGGER packet, sample = %d",
+               (block * BS) + trigger_point);
        packet.type = SR_DF_TRIGGER;
-       packet.length = 0;
-       packet.unitsize = 0;
+       packet.timeoffset = (block * BS + trigger_point) * la8->period_ps;
+       packet.duration = 0;
        packet.payload = NULL;
        sr_session_bus(la8->session_id, &packet);
 
        /* If at least one sample is located after the trigger... */
-       if (trigger_point < (4096 - 1)) {
+       if (trigger_point < (BS - 1)) {
                /* Send post-trigger SR_DF_LOGIC packet to the session bus. */
-               sr_dbg("la8: %s: sending post-trigger SR_DF_LOGIC packet, ",
-                      "start = %" PRIu64 ", length = %d", __func__,
-                      (block * 4096) + trigger_point,
-                      (4096 - 1) - trigger_point);
+               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.length = (4096 - 1) - trigger_point;
-               packet.unitsize = 1;
-               packet.payload = la8->final_buf + (block * 4096)
-                                + trigger_point;
+               packet.timeoffset = (block * BS + trigger_point) * la8->period_ps;
+               packet.duration = (BS - trigger_point) * la8->period_ps;
+               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 *user_data)
+static int receive_data(int fd, int revents, void *session_data)
 {
        int i, ret;
        struct sr_device_instance *sdi;
        struct la8 *la8;
 
        /* Avoid compiler errors. */
-       fd = fd;
-       revents = revents;
+       (void)fd;
+       (void)revents;
 
-       if (!(sdi = user_data)) {
+       if (!(sdi = session_data)) {
                sr_err("la8: %s: user_data was NULL", __func__);
                return FALSE;
        }
@@ -976,15 +1015,15 @@ static int receive_data(int fd, int revents, void *user_data)
                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;
        }
@@ -992,16 +1031,16 @@ static int receive_data(int fd, int revents, void *user_data)
        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++)
+       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;
@@ -1010,7 +1049,7 @@ static int hw_start_acquisition(int device_index, gpointer session_device_id)
        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))) {
                sr_err("la8: %s: sdi was NULL", __func__);
@@ -1052,21 +1091,18 @@ static int hw_start_acquisition(int device_index, gpointer session_device_id)
 
        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)
@@ -1080,7 +1116,7 @@ static int hw_start_acquisition(int device_index, gpointer session_device_id)
        return SR_OK;
 }
 
-static void hw_stop_acquisition(int device_index, gpointer session_device_id)
+static void hw_stop_acquisition(int device_index, gpointer session_data)
 {
        struct sr_device_instance *sdi;
        struct la8 *la8;
@@ -1101,10 +1137,7 @@ static void hw_stop_acquisition(int device_index, gpointer session_device_id)
        /* 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);
 }
 
 struct sr_device_plugin chronovu_la8_plugin_info = {