]> sigrok.org Git - libsigrok.git/blobdiff - hardware/chronovu-la8/chronovu-la8.c
LA8: Eliminate magic numbers.
[libsigrok.git] / hardware / chronovu-la8 / chronovu-la8.c
index 44ab838421269995cf3a93c0724c130041efd0a7..e9dae510a273e9dd6c45d1e62f2aba214aed5f81 100644 (file)
@@ -20,6 +20,7 @@
 
 #include <ftdi.h>
 #include <glib.h>
+#include <string.h>
 #include <sigrok.h>
 #include <sigrok-internal.h>
 
@@ -35,6 +36,9 @@
 #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;
 
 struct la8 {
@@ -50,17 +54,14 @@ struct la8 {
        /** The current sampling limit (in number of samples). */
        uint64_t limit_samples;
 
-       /** The number of probes. */
-       int num_probes;
-
        /** TODO */
        gpointer session_id;
 
        /**
-        * An 8MB buffer containing the (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;
+       uint8_t mangled_buf[BS];
 
        /**
         * An 8MB buffer where we'll store the de-mangled samples.
@@ -84,10 +85,13 @@ struct la8 {
        /** 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. */
@@ -362,7 +366,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;
 
@@ -385,7 +389,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));
 
@@ -477,29 +481,22 @@ static int hw_init(const char *deviceinfo)
        la8->cur_samplerate = SR_MHZ(100); /* 100MHz == max. samplerate */
        la8->limit_msec = 0;
        la8->limit_samples = 0;
-       la8->num_probes = NUM_PROBES;
        la8->session_id = NULL;
-       la8->mangled_buf = NULL;
+       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 for the raw (mangled) data from the LA8. */
-       if (!(la8->mangled_buf = g_try_malloc(SDRAM_SIZE))) {
-               sr_err("la8: %s: mangled_buf malloc failed", __func__);
-               ret = SR_ERR_MALLOC;
-               goto err_free_la8;
-       }
-
        /* 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_mangled_buf;
+               goto err_free_la8;
        }
 
        /* Allocate memory for the FTDI context (ftdic) and initialize it. */
@@ -547,8 +544,6 @@ err_free_ftdic:
        free(la8->ftdic); /* NOT g_free()! */
 err_free_final_buf:
        g_free(la8->final_buf);
-err_free_mangled_buf:
-       g_free(la8->mangled_buf);
 err_free_la8:
        g_free(la8);
 err_free_nothing:
@@ -644,25 +639,26 @@ static int set_samplerate(struct sr_device_instance *sdi, uint64_t samplerate)
        return SR_OK;
 }
 
-static void hw_closedev(int device_index)
+static int hw_closedev(int device_index)
 {
        struct sr_device_instance *sdi;
        struct la8 *la8;
 
        if (!(sdi = sr_get_device_instance(device_instances, device_index))) {
                sr_err("la8: %s: sdi was NULL", __func__);
-               return;
+               return SR_ERR; /* TODO: SR_ERR_ARG? */
        }
 
        if (!(la8 = sdi->priv)) {
                sr_err("la8: %s: sdi->priv was NULL", __func__);
-               return;
+               return SR_ERR; /* TODO: SR_ERR_ARG? */
        }
 
        sr_dbg("la8: closing device");
 
        if (sdi->status == SR_ST_ACTIVE) {
                sr_dbg("la8: %s: status ACTIVE, closing device", __func__);
+               /* 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__);
@@ -671,8 +667,9 @@ static void hw_closedev(int device_index)
        sdi->status = SR_ST_INACTIVE;
 
        sr_dbg("la8: %s: freeing sample buffers", __func__);
-       free(la8->mangled_buf);
-       free(la8->final_buf);
+       g_free(la8->final_buf);
+
+       return SR_OK;
 }
 
 static void hw_cleanup(void)
@@ -821,7 +818,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.
@@ -843,20 +840,20 @@ static int la8_read_block(struct la8 *la8)
 
        // sr_dbg("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);
+                       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;
@@ -864,10 +861,10 @@ static int la8_read_block(struct la8 *la8)
 
        /* De-mangle the data. */
        // sr_dbg("la8: de-mangling samples of block %d", la8->block_counter);
-       byte_offset = la8->block_counter * 4096;
+       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);
@@ -877,11 +874,93 @@ static int la8_read_block(struct la8 *la8)
        return SR_OK;
 }
 
+static void send_block_to_session_bus(struct la8 *la8, int block)
+{
+       int i;
+       uint8_t sample, expected_sample;
+       struct sr_datafeed_packet packet;
+       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;
+
+               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_dbg("la8: %s: sending SR_DF_LOGIC packet", __func__);
+               packet.type = SR_DF_LOGIC;
+               packet.length = BS;
+               packet.unitsize = 1;
+               packet.payload = 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_dbg("la8: %s: sending pre-trigger SR_DF_LOGIC packet, ",
+                      "start = %" PRIu64 ", length = %d", __func__,
+                      block * BS, trigger_point);
+               packet.type = SR_DF_LOGIC;
+               packet.length = trigger_point;
+               packet.unitsize = 1;
+               packet.payload = 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 * BS) + trigger_point);
+       packet.type = SR_DF_TRIGGER;
+       packet.length = 0;
+       packet.unitsize = 0;
+       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_dbg("la8: %s: sending post-trigger SR_DF_LOGIC packet, ",
+                      "start = %" PRIu64 ", length = %d", __func__,
+                      (block * BS) + trigger_point, (BS - 1) - trigger_point);
+               packet.type = SR_DF_LOGIC;
+               packet.length = (BS - 1) - trigger_point;
+               packet.unitsize = 1;
+               packet.payload = 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)
 {
        int i, ret;
        struct sr_device_instance *sdi;
-       struct sr_datafeed_packet packet;
        struct la8 *la8;
 
        /* Avoid compiler errors. */
@@ -898,15 +977,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);
                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;
        }
@@ -914,15 +993,8 @@ 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++) {
-               /* 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);
 
@@ -993,7 +1065,7 @@ static int hw_start_acquisition(int device_index, gpointer session_device_id)
        gettimeofday(&header.starttime, NULL);
        header.samplerate = la8->cur_samplerate;
        header.protocol_id = SR_PROTO_RAW;
-       header.num_logic_probes = la8->num_probes;
+       header.num_logic_probes = NUM_PROBES;
        header.num_analog_probes = 0;
        sr_session_bus(session_device_id, &packet);
 
@@ -1001,6 +1073,7 @@ static int hw_start_acquisition(int device_index, gpointer session_device_id)
        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);
@@ -1041,8 +1114,8 @@ struct sr_device_plugin chronovu_la8_plugin_info = {
        .api_version = 1,
        .init = hw_init,
        .cleanup = hw_cleanup,
-       .open = hw_opendev,
-       .close = hw_closedev,
+       .opendev = hw_opendev,
+       .closedev = hw_closedev,
        .get_device_info = hw_get_device_info,
        .get_status = hw_get_status,
        .get_capabilities = hw_get_capabilities,