]> sigrok.org Git - libsigrok.git/blobdiff - hardware/chronovu-la8/protocol.c
la8: Add support for the ChronoVu LA16.
[libsigrok.git] / hardware / chronovu-la8 / protocol.c
index 3a50fe613104feb0643f8b4ef0b7b803500b3c15..28ac15bee0853f2e3f581ff4caf89b374914f324 100644 (file)
 
 #include "protocol.h"
 
-/* Channels are numbered 0-7. */
-SR_PRIV const char *cv_channel_names[NUM_CHANNELS + 1] = {
+SR_PRIV const struct cv_profile cv_profiles[] = {
+       { CHRONOVU_LA8,  "LA8",  "ChronoVu LA8",  8,  SR_MHZ(100), "01",
+         0.8388608 },
+       { CHRONOVU_LA16, "LA16", "ChronoVu LA16", 16, SR_MHZ(200), "01rf",
+         0.042 },
+       { 0, NULL, NULL, 0, 0, NULL, 0.0 },
+};
+
+/* LA8: channels are numbered 0-7. LA16: channels are numbered 0-15. */
+SR_PRIV const char *cv_channel_names[] = {
        "0", "1", "2", "3", "4", "5", "6", "7",
-       NULL,
+       "8", "9", "10", "11", "12", "13", "14", "15",
 };
 
-SR_PRIV void cv_fill_samplerates_if_needed(void)
+static int close_usb_reset_sequencer(struct dev_context *devc);
+
+SR_PRIV void cv_fill_samplerates_if_needed(const struct sr_dev_inst *sdi)
 {
        int i;
+       struct dev_context *devc;
+
+       devc = sdi->priv;
 
-       if (cv_samplerates[0] != 0)
+       if (devc->samplerates[0] != 0)
                return;
 
        for (i = 0; i < 255; i++)
-               cv_samplerates[254 - i] = SR_MHZ(100) / (i + 1);
+               devc->samplerates[254 - i] = devc->prof->max_samplerate / (i + 1);
 }
 
 /**
  * Check if the given samplerate is supported by the hardware.
  *
+ * @param sdi Device instance.
  * @param samplerate The samplerate (in Hz) to check.
+ *
  * @return 1 if the samplerate is supported/valid, 0 otherwise.
  */
-static int is_valid_samplerate(uint64_t samplerate)
+static int is_valid_samplerate(const struct sr_dev_inst *sdi,
+                              uint64_t samplerate)
 {
        int i;
+       struct dev_context *devc;
+
+       devc = sdi->priv;
 
-       cv_fill_samplerates_if_needed();
+       cv_fill_samplerates_if_needed(sdi);
 
        for (i = 0; i < 255; i++) {
-               if (cv_samplerates[i] == samplerate)
+               if (devc->samplerates[i] == samplerate)
                        return 1;
        }
 
@@ -62,26 +81,41 @@ static int is_valid_samplerate(uint64_t samplerate)
 /**
  * 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).
- * Max. value for divcount: 0xfe (2550ns sample period, 392.15kHz samplerate).
+ * The divcount value can be 0x00 - 0xfe (0xff is not valid).
+ *
+ * LA8:
+ * sample period = (divcount + 1) * 10ns.
+ * divcount = 0x00: 10ns period, 100MHz samplerate.
+ * divcount = 0xfe: 2550ns period, 392.15kHz samplerate.
+ *
+ * LA16:
+ * sample period = (divcount + 1) * 5ns.
+ * divcount = 0x00: 5ns period, 200MHz samplerate.
+ * divcount = 0xfe: 1275ns period, ~784.31kHz samplerate.
  *
+ * @param sdi Device instance.
  * @param samplerate The samplerate in Hz.
+ *
  * @return The divcount value as needed by the hardware, or 0xff upon errors.
  */
-SR_PRIV uint8_t cv_samplerate_to_divcount(uint64_t samplerate)
+SR_PRIV uint8_t cv_samplerate_to_divcount(const struct sr_dev_inst *sdi,
+                                         uint64_t samplerate)
 {
+       struct dev_context *devc;
+
+       devc = sdi->priv;
+
        if (samplerate == 0) {
                sr_err("Can't convert invalid samplerate of 0 Hz.");
                return 0xff;
        }
 
-       if (!is_valid_samplerate(samplerate)) {
+       if (!is_valid_samplerate(sdi, samplerate)) {
                sr_err("Can't get divcount, samplerate invalid.");
                return 0xff;
        }
 
-       return (SR_MHZ(100) / samplerate) - 1;
+       return (devc->prof->max_samplerate / samplerate) - 1;
 }
 
 /**
@@ -100,22 +134,16 @@ SR_PRIV int cv_write(struct dev_context *devc, uint8_t *buf, int size)
 
        /* Note: Caller ensures devc/devc->ftdic/buf != NULL and size > 0. */
 
-       if (!buf)
-               return SR_ERR_ARG;
-
-       if (size < 0)
-               return SR_ERR_ARG;
-
        bytes_written = ftdi_write_data(devc->ftdic, buf, size);
 
        if (bytes_written < 0) {
                sr_err("Failed to write data (%d): %s.",
                       bytes_written, ftdi_get_error_string(devc->ftdic));
-               (void) cv_close_usb_reset_sequencer(devc); /* Ignore errors. */
+               (void) close_usb_reset_sequencer(devc); /* Ignore errors. */
        } else if (bytes_written != size) {
                sr_err("Failed to write data, only %d/%d bytes written.",
                       size, bytes_written);
-               (void) cv_close_usb_reset_sequencer(devc); /* Ignore errors. */
+               (void) close_usb_reset_sequencer(devc); /* Ignore errors. */
        }
 
        return bytes_written;
@@ -151,47 +179,20 @@ static int cv_read(struct dev_context *devc, uint8_t *buf, int size)
        return bytes_read;
 }
 
-SR_PRIV int cv_close(struct dev_context *devc)
-{
-       int ret;
-
-       if (!devc) {
-               sr_err("%s: devc was NULL.", __func__);
-               return SR_ERR_ARG;
-       }
-
-       if (!devc->ftdic) {
-               sr_err("%s: devc->ftdic was NULL.", __func__);
-               return SR_ERR_ARG;
-       }
-
-       if ((ret = ftdi_usb_close(devc->ftdic)) < 0) {
-               sr_err("%s: ftdi_usb_close: (%d) %s.",
-                      __func__, ret, ftdi_get_error_string(devc->ftdic));
-       }
-
-       return ret;
-}
-
 /**
  * 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 cv_close_usb_reset_sequencer(struct dev_context *devc)
+static int close_usb_reset_sequencer(struct dev_context *devc)
 {
        /* 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)
-               return SR_ERR_ARG;
-
-       if (!devc->ftdic) {
-               sr_err("devc->ftdic was NULL.");
-               return SR_ERR_ARG;
-       }
+       /* Note: Caller checked that devc and devc->ftdic != NULL. */
 
        if (devc->ftdic->usb_dev) {
                /* Reset the sequencer logic, then wait 100ms. */
@@ -204,18 +205,18 @@ SR_PRIV int cv_close_usb_reset_sequencer(struct dev_context *devc)
 
                /* Log errors, but ignore them (i.e., don't abort). */
                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));
+                       sr_err("Failed to purge FTDI buffers (%d): %s.",
+                              ret, ftdi_get_error_string(devc->ftdic));
                if ((ret = ftdi_usb_reset(devc->ftdic)) < 0)
-                       sr_err("%s: ftdi_usb_reset: (%d) %s.", __func__,
+                       sr_err("Failed to reset FTDI device (%d): %s.",
                               ret, ftdi_get_error_string(devc->ftdic));
                if ((ret = ftdi_usb_close(devc->ftdic)) < 0)
-                       sr_err("%s: ftdi_usb_close: (%d) %s.", __func__,
+                       sr_err("Failed to close FTDI device (%d): %s.",
                               ret, ftdi_get_error_string(devc->ftdic));
        }
 
        /* Close USB device, deinitialize and free the FTDI context. */
-       ftdi_free(devc->ftdic); /* Returns void. */
+       ftdi_free(devc->ftdic);
        devc->ftdic = NULL;
 
        return SR_OK;
@@ -227,23 +228,16 @@ SR_PRIV int cv_close_usb_reset_sequencer(struct dev_context *devc)
  * 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.
  */
-static int cv_reset(struct dev_context *devc)
+static int reset_device(struct dev_context *devc)
 {
        uint8_t buf[BS];
-       time_t done, now;
+       gint64 done, now;
        int bytes_read;
 
-       if (!devc) {
-               sr_err("%s: devc was NULL.", __func__);
-               return SR_ERR_ARG;
-       }
-
-       if (!devc->ftdic) {
-               sr_err("%s: devc->ftdic was NULL.", __func__);
-               return SR_ERR_ARG;
-       }
+       /* Note: Caller checked that devc and devc->ftdic != NULL. */
 
        sr_dbg("Resetting the device.");
 
@@ -251,15 +245,15 @@ static int cv_reset(struct dev_context *devc)
         * Purge pending read data from the FTDI hardware FIFO until
         * no more data is left, or a timeout occurs (after 20s).
         */
-       done = 20 + time(NULL);
+       done = (20 * G_TIME_SPAN_SECOND) + g_get_monotonic_time();
        do {
                /* Try to read bytes until none are left (or errors occur). */
                bytes_read = cv_read(devc, (uint8_t *)&buf, BS);
-               now = time(NULL);
+               now = g_get_monotonic_time();
        } while ((done > now) && (bytes_read > 0));
 
        /* Reset the sequencer logic and close the USB port. */
-       (void) cv_close_usb_reset_sequencer(devc); /* Ignore errors. */
+       (void) close_usb_reset_sequencer(devc); /* Ignore errors. */
 
        sr_dbg("Device reset finished.");
 
@@ -271,12 +265,13 @@ SR_PRIV int cv_configure_channels(const struct sr_dev_inst *sdi)
        struct dev_context *devc;
        const struct sr_channel *ch;
        const GSList *l;
-       uint8_t channel_bit;
+       uint16_t channel_bit;
        char *tc;
 
        devc = sdi->priv;
-       devc->trigger_pattern = 0;
-       devc->trigger_mask = 0; /* Default to "don't care" for all channels. */
+       devc->trigger_pattern = 0x0000; /* Default to "low" trigger. */
+       devc->trigger_mask = 0x0000; /* Default to "don't care". */
+       devc->trigger_edgemask = 0x0000; /* Default to "state triggered". */
 
        for (l = sdi->channels; l; l = l->next) {
                ch = (struct sr_channel *)l->data;
@@ -295,32 +290,43 @@ SR_PRIV int cv_configure_channels(const struct sr_dev_inst *sdi)
                        continue;
 
                /* Note: Must only be run if ch->trigger != NULL. */
-               if (ch->index < 0 || ch->index > 7) {
-                       sr_err("%s: Invalid channel index %d, must be "
-                              "between 0 and 7.", __func__, ch->index);
+               if (ch->index < 0 || ch->index > (int)devc->prof->num_channels - 1) {
+                       sr_err("Invalid channel index %d, must be "
+                              "between 0 and %d.", ch->index,
+                              devc->prof->num_channels - 1);
                        return SR_ERR;
                }
 
                channel_bit = (1 << (ch->index));
 
-               /* Configure the channel's trigger mask and trigger pattern. */
+               /* Configure the channel's trigger pattern/mask/edgemask. */
                for (tc = ch->trigger; tc && *tc; tc++) {
                        devc->trigger_mask |= channel_bit;
 
                        /* Sanity check, LA8 only supports low/high trigger. */
-                       if (*tc != '0' && *tc != '1') {
-                               sr_err("%s: Invalid trigger '%c', only "
-                                      "'0'/'1' supported.", __func__, *tc);
+                       if ((devc->prof->model == CHRONOVU_LA8) &&
+                           (*tc != '0' && *tc != '1')) {
+                               sr_err("Invalid trigger '%c', only "
+                                      "'0'/'1' supported.", *tc);
                                return SR_ERR;
                        }
 
-                       if (*tc == '1')
+                       /* state: 1 == high, edge: 1 == rising edge. */
+                       if (*tc == '1' || *tc == 'r')
                                devc->trigger_pattern |= channel_bit;
+
+                       /* LA16 (but not LA8) supports edge triggering. */
+                       if ((devc->prof->model == CHRONOVU_LA16)) {
+                               if (*tc == 'r' || *tc == 'f')
+                                       devc->trigger_edgemask |= channel_bit;
+                       }
+
                }
        }
 
-       sr_dbg("Trigger mask = 0x%x, trigger pattern = 0x%x.",
-              devc->trigger_mask, devc->trigger_pattern);
+       sr_dbg("Trigger pattern/mask/edgemask = 0x%04x / 0x%04x / 0x%04x.",
+              devc->trigger_pattern, devc->trigger_mask,
+              devc->trigger_edgemask);
 
        return SR_OK;
 }
@@ -335,16 +341,15 @@ SR_PRIV int cv_set_samplerate(const struct sr_dev_inst *sdi, uint64_t samplerate
 
        sr_spew("Trying to set samplerate to %" PRIu64 "Hz.", samplerate);
 
-       cv_fill_samplerates_if_needed();
+       cv_fill_samplerates_if_needed(sdi);
 
        /* Check if this is a samplerate supported by the hardware. */
-       if (!is_valid_samplerate(samplerate)) {
+       if (!is_valid_samplerate(sdi, samplerate)) {
                sr_dbg("Failed to set invalid samplerate (%" PRIu64 "Hz).",
                       samplerate);
                return SR_ERR;
        }
 
-       /* Set the new samplerate. */
        devc->cur_samplerate = samplerate;
 
        sr_dbg("Samplerate set to %" PRIu64 "Hz.", devc->cur_samplerate);
@@ -362,8 +367,8 @@ 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)
 {
-       int i, byte_offset, m, mi, p, index, bytes_read;
-       time_t now;
+       int i, byte_offset, m, mi, p, q, index, bytes_read;
+       gint64 now;
 
        /* Note: Caller checked that devc and devc->ftdic != NULL. */
 
@@ -375,16 +380,16 @@ SR_PRIV int cv_read_block(struct dev_context *devc)
        if ((bytes_read == 0) && (devc->block_counter == 0)) {
                do {
                        sr_spew("Reading block 0 (again).");
+                       /* Note: If bytes_read < 0 cv_read() will log errors. */
                        bytes_read = cv_read(devc, devc->mangled_buf, BS);
-                       /* TODO: How to handle read errors here? */
-                       now = time(NULL);
+                       now = g_get_monotonic_time();
                } while ((devc->done > now) && (bytes_read == 0));
        }
 
        /* 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) cv_reset(devc); /* Ignore errors. */
+               (void) reset_device(devc); /* Ignore errors. */
                return SR_ERR;
        }
 
@@ -394,9 +399,16 @@ SR_PRIV int cv_read_block(struct dev_context *devc)
        m = byte_offset / (1024 * 1024);
        mi = m * (1024 * 1024);
        for (i = 0; i < BS; i++) {
-               p = i & (1 << 0);
-               index = m * 2 + (((byte_offset + i) - mi) / 2) * 16;
-               index += (devc->divcount == 0) ? p : (1 - p);
+               if (devc->prof->model == CHRONOVU_LA8) {
+                       p = i & (1 << 0);
+                       index = m * 2 + (((byte_offset + i) - mi) / 2) * 16;
+                       index += (devc->divcount == 0) ? p : (1 - p);
+               } else {
+                       p = i & (1 << 0);
+                       q = i & (1 << 1);
+                       index = m * 4 + (((byte_offset + i) - mi) / 4) * 32;
+                       index += q + (1 - p);
+               }
                devc->final_buf[index] = devc->mangled_buf[i];
        }
 
@@ -411,7 +423,9 @@ SR_PRIV void cv_send_block_to_session_bus(struct dev_context *devc, int block)
        struct sr_datafeed_logic logic;
        int trigger_point; /* Relative trigger point (in this block). */
 
-       /* Note: No sanity checks on devc/block, caller is responsible. */
+       /* Note: Caller ensures devc/devc->ftdic != NULL and block > 0. */
+
+       /* TODO: Implement/test proper trigger support for the LA16. */
 
        /* Check if we can find the trigger condition in this block. */
        trigger_point = -1;
@@ -426,7 +440,7 @@ SR_PRIV void cv_send_block_to_session_bus(struct dev_context *devc, int block)
                 * 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 (devc->trigger_mask == 0x00)
+               if (devc->trigger_mask == 0x0000)
                        break;
 
                sample = *(devc->final_buf + (block * BS) + i);
@@ -446,7 +460,7 @@ SR_PRIV void cv_send_block_to_session_bus(struct dev_context *devc, int block)
                packet.type = SR_DF_LOGIC;
                packet.payload = &logic;
                logic.length = BS;
-               logic.unitsize = 1;
+               logic.unitsize = devc->prof->num_channels / 8;
                logic.data = devc->final_buf + (block * BS);
                sr_session_send(devc->cb_data, &packet);
                return;
@@ -469,7 +483,7 @@ SR_PRIV void cv_send_block_to_session_bus(struct dev_context *devc, int block)
                packet.type = SR_DF_LOGIC;
                packet.payload = &logic;
                logic.length = trigger_point;
-               logic.unitsize = 1;
+               logic.unitsize = devc->prof->num_channels / 8;
                logic.data = devc->final_buf + (block * BS);
                sr_session_send(devc->cb_data, &packet);
        }
@@ -490,7 +504,7 @@ SR_PRIV void cv_send_block_to_session_bus(struct dev_context *devc, int block)
                packet.type = SR_DF_LOGIC;
                packet.payload = &logic;
                logic.length = BS - trigger_point;
-               logic.unitsize = 1;
+               logic.unitsize = devc->prof->num_channels / 8;
                logic.data = devc->final_buf + (block * BS) + trigger_point;
                sr_session_send(devc->cb_data, &packet);
        }