]> sigrok.org Git - libsigrok.git/blobdiff - hardware/asix-sigma/asix-sigma.c
Sigma: Add triggers support for 100 and 200 MHz.
[libsigrok.git] / hardware / asix-sigma / asix-sigma.c
index e6a1c17e45de198cbf8512ce1e3c7abfc9e5b2d0..c5797cf45a57b04e33889afe3ec6eef22aa71ef3 100644 (file)
 #define USB_VENDOR_NAME                        "ASIX"
 #define USB_MODEL_NAME                 "SIGMA"
 #define USB_MODEL_VERSION              ""
-#define FIRMWARE                       FIRMWARE_DIR "/asix-sigma-200.firmware"
+#define TRIGGER_TYPES                  "rf"
 
 static GSList *device_instances = NULL;
 
 // XXX These should be per device
 static struct ftdi_context ftdic;
-static uint64_t cur_samplerate = MHZ(200);
+static uint64_t cur_samplerate = 0;
 static uint32_t limit_msec = 0;
 static struct timeval start_tv;
+static int cur_firmware = -1;
+static int num_probes = 0;
+static int samples_per_event = 0;
+static int capture_ratio = 50;
+
+/* Single-pin trigger support */
+static uint8_t triggerpin = 1;
+static uint8_t triggerfall = 0;
 
 static uint64_t supported_samplerates[] = {
+       KHZ(200),
+       KHZ(250),
+       KHZ(500),
+       MHZ(1),
+       MHZ(5),
+       MHZ(10),
+       MHZ(25),
+       MHZ(50),
+       MHZ(100),
        MHZ(200),
        0,
 };
 
 static struct samplerates samplerates = {
-       MHZ(200),
+       KHZ(200),
        MHZ(200),
        0,
        supported_samplerates,
@@ -60,6 +77,8 @@ static struct samplerates samplerates = {
 static int capabilities[] = {
        HWCAP_LOGIC_ANALYZER,
        HWCAP_SAMPLERATE,
+       HWCAP_CAPTURE_RATIO,
+       HWCAP_PROBECONFIG,
 
        /* These are really implemented in the driver, not the hardware. */
        HWCAP_LIMIT_MSEC,
@@ -82,6 +101,15 @@ static uint8_t logic_mode_start[] = {
        0x2a, 0x3a, 0x40, 0x03, 0x20, 0x38,
 };
 
+static const char *firmware_files[] =
+{
+       "asix-sigma-50.fw",     /* 50 MHz, supports 8 bit fractions */
+       "asix-sigma-100.fw",    /* 100 MHz */
+       "asix-sigma-200.fw",    /* 200 MHz */
+       "asix-sigma-50sync.fw", /* Synchronous clock from pin */
+       "asix-sigma-phasor.fw", /* Frequency counter */
+};
+
 static int sigma_read(void *buf, size_t size)
 {
        int ret;
@@ -178,6 +206,13 @@ static int sigma_read_pos(uint32_t *stoppos, uint32_t *triggerpos)
        *triggerpos = result[0] | (result[1] << 8) | (result[2] << 16);
        *stoppos = result[3] | (result[4] << 8) | (result[5] << 16);
 
+       /* Not really sure why this must be done, but according to spec. */
+       if ((--*stoppos & 0x1ff) == 0x1ff)
+               stoppos -= 64;
+
+       if ((*--triggerpos & 0x1ff) == 0x1ff)
+               triggerpos -= 64;
+
        return 1;
 }
 
@@ -327,14 +362,14 @@ static int hw_init(char *deviceinfo)
        return 1;
 }
 
-static int hw_opendev(int device_index)
+static int upload_firmware(int firmware_idx)
 {
        int ret;
        unsigned char *buf;
        unsigned char pins;
        size_t buf_size;
-       struct sigrok_device_instance *sdi;
        unsigned char result[32];
+       char firmware_path[128];
 
        /* Make sure it's an ASIX SIGMA. */
        if ((ret = ftdi_usb_open_desc(&ftdic,
@@ -376,9 +411,12 @@ static int hw_opendev(int device_index)
        }
 
        /* Prepare firmware. */
-       if (-1 == bin2bitbang(FIRMWARE, &buf, &buf_size)) {
+       snprintf(firmware_path, sizeof(firmware_path), "%s/%s", FIRMWARE_DIR,
+                firmware_files[firmware_idx]);
+
+       if (-1 == bin2bitbang(firmware_path, &buf, &buf_size)) {
                g_warning("An error occured while reading the firmware: %s",
-                         FIRMWARE);
+                         firmware_path);
                return SIGROK_ERR;
        }
 
@@ -410,15 +448,98 @@ static int hw_opendev(int device_index)
                return SIGROK_ERR;
        }
 
-       /* Works like a charm... */
+       cur_firmware = firmware_idx;
+
+       return SIGROK_OK;
+}
+
+static int hw_opendev(int device_index)
+{
+       struct sigrok_device_instance *sdi;
+       int ret;
+
+       /* Make sure it's an ASIX SIGMA. */
+       if ((ret = ftdi_usb_open_desc(&ftdic,
+               USB_VENDOR, USB_PRODUCT, USB_DESCRIPTION, NULL)) < 0) {
+
+               g_warning("ftdi_usb_open failed: %s",
+                       ftdi_get_error_string(&ftdic));
+
+               return 0;
+       }
 
        if (!(sdi = get_sigrok_device_instance(device_instances, device_index)))
                return SIGROK_ERR;
 
        sdi->status = ST_ACTIVE;
 
+       return SIGROK_OK;
+}
+
+static int set_samplerate(struct sigrok_device_instance *sdi, uint64_t samplerate)
+{
+       int i, ret;
+
+       sdi = sdi;
+
+       for (i = 0; supported_samplerates[i]; i++) {
+               if (supported_samplerates[i] == samplerate)
+                       break;
+       }
+       if (supported_samplerates[i] == 0)
+               return SIGROK_ERR_SAMPLERATE;
+
+       if (samplerate <= MHZ(50)) {
+               ret = upload_firmware(0);
+               num_probes = 16;
+       }
+       if (samplerate == MHZ(100)) {
+               ret = upload_firmware(1);
+               num_probes = 8;
+       }
+       else if (samplerate == MHZ(200)) {
+               ret = upload_firmware(2);
+               num_probes = 4;
+       }
+
+       cur_samplerate = samplerate;
+       samples_per_event = 16 / num_probes;
+
        g_message("Firmware uploaded");
 
+       return ret;
+}
+
+/* Only trigger on single pin supported (in 100-200 MHz modes) */
+static int configure_probes(GSList *probes)
+{
+       struct probe *probe;
+       GSList *l;
+       int trigger_set = 0;
+
+       for (l = probes; l; l = l->next) {
+               probe = (struct probe *)l->data;
+
+               if (!probe->enabled || !probe->trigger)
+                       continue;
+
+               if (trigger_set) {
+                       g_warning("Asix Sigma only supports a single pin trigger"
+                                 " in 100 and 200 MHz mode.");
+
+                       return SIGROK_ERR;
+               }
+
+               /* Found trigger */
+               if (probe->trigger[0] == 'f')
+                       triggerfall = 1;
+               else
+                       triggerfall = 0;
+
+               triggerpin = probe->index - 1;
+               trigger_set = 1;
+       }
+
        return SIGROK_OK;
 }
 
@@ -448,13 +569,13 @@ static void *hw_get_device_info(int device_index, int device_info_id)
                info = sdi;
                break;
        case DI_NUM_PROBES:
-               info = GINT_TO_POINTER(4);
+               info = GINT_TO_POINTER(16);
                break;
        case DI_SAMPLERATES:
                info = &samplerates;
                break;
        case DI_TRIGGER_TYPES:
-               info = 0;       //TRIGGER_TYPES;
+               info = (char *)TRIGGER_TYPES;
                break;
        case DI_CUR_SAMPLERATE:
                info = &cur_samplerate;
@@ -484,20 +605,22 @@ static int hw_set_configuration(int device_index, int capability, void *value)
 {
        struct sigrok_device_instance *sdi;
        int ret;
-       uint64_t *tmp_u64;
 
        if (!(sdi = get_sigrok_device_instance(device_instances, device_index)))
                return SIGROK_ERR;
 
        if (capability == HWCAP_SAMPLERATE) {
-               tmp_u64 = (uint64_t *) value;
-               /* Only 200 MHz implemented */
-               ret = SIGROK_OK;
+               ret = set_samplerate(sdi, *(uint64_t*) value);
        } else if (capability == HWCAP_PROBECONFIG) {
-               ret = SIGROK_OK;
+               ret = configure_probes(value);
        } else if (capability == HWCAP_LIMIT_MSEC) {
                limit_msec = strtoull(value, NULL, 10);
                ret = SIGROK_OK;
+       } else if (capability == HWCAP_CAPTURE_RATIO) {
+               capture_ratio = strtoull(value, NULL, 10);
+               ret = SIGROK_OK;
+       } else if (capability == HWCAP_PROBECONFIG) {
+               ret = configure_probes((GSList *) value);
        } else {
                ret = SIGROK_ERR;
        }
@@ -508,20 +631,28 @@ static int hw_set_configuration(int device_index, int capability, void *value)
 /*
  * Decode chunk of 1024 bytes, 64 clusters, 7 events per cluster.
  * Each event is 20ns apart, and can contain multiple samples.
- * For 200 MHz, an event contains 4 samples for each channel,
- * spread 5 ns apart.
+ *
+ * For 200 MHz, events contain 4 samples for each channel, spread 5 ns apart.
+ * For 100 MHz, events contain 2 samples for each channel, spread 10 ns apart.
+ * For 50 MHz and below, events contain one sample for each channel,
+ * spread 20 ns apart.
  */
 static int decode_chunk_ts(uint8_t *buf, uint16_t *lastts,
-                          uint8_t *lastsample, void *user_data)
+                          uint16_t *lastsample, int triggerpos, void *user_data)
 {
-       const int samples_per_event = 4;
        uint16_t tsdiff, ts;
-       uint8_t samples[65536 * samples_per_event];
+       uint16_t samples[65536 * samples_per_event];
        struct datafeed_packet packet;
-       int i, j, k, numpad, tosend;
+       int i, j, k, l, numpad, tosend;
        size_t n = 0, sent = 0;
-       int clustersize = EVENTS_PER_CLUSTER * samples_per_event; /* 4 for 200 MHz */
+       int clustersize = EVENTS_PER_CLUSTER * samples_per_event;
        uint16_t *event;
+       uint16_t cur_sample;
+       int triggerts = -1;
+
+       /* Find in which cluster the trigger occured */
+       if (triggerpos != -1)
+               triggerts = (triggerpos / 7);
 
        /* For each ts */
        for (i = 0; i < 64; ++i) {
@@ -532,45 +663,84 @@ static int decode_chunk_ts(uint8_t *buf, uint16_t *lastts,
                /* Pad last sample up to current point. */
                numpad = tsdiff * samples_per_event - clustersize;
                if (numpad > 0) {
-                       memset(samples, *lastsample,
-                              tsdiff * samples_per_event - clustersize);
-                       n = tsdiff * samples_per_event - clustersize;
+                       for (j = 0; j < numpad; ++j)
+                               samples[j] = *lastsample;
+
+                       n = numpad;
                }
 
+               /* Send samples between previous and this timestamp to sigrok. */
+               sent = 0;
+               while (sent < n) {
+                       tosend = MIN(2048, n - sent);
+
+                       packet.type = DF_LOGIC16;
+                       packet.length = tosend * sizeof(uint16_t);
+                       packet.payload = samples + sent;
+                       session_bus(user_data, &packet);
+
+                       sent += tosend;
+               }
+               n = 0;
+
                event = (uint16_t *) &buf[i * 16 + 2];
+               cur_sample = 0;
 
-               /* For each sample in cluster. */
+               /* For each event in cluster. */
                for (j = 0; j < 7; ++j) {
+
+                       /* For each sample in event. */
                        for (k = 0; k < samples_per_event; ++k) {
-                               /*
-                                * Extract samples from bytestream.
-                                * Samples are packed together in a short.
-                                */
-                               samples[n++] =
-                                   ((!!(event[j] & (1 << (k + 0x0)))) << 0) |
-                                   ((!!(event[j] & (1 << (k + 0x4)))) << 1) |
-                                   ((!!(event[j] & (1 << (k + 0x8)))) << 2) |
-                                   ((!!(event[j] & (1 << (k + 0xc)))) << 3);
+                               cur_sample = 0;
+
+                               /* For each probe. */
+                               for (l = 0; l < num_probes; ++l)
+                                       cur_sample |= (!!(event[j] & (1 << (l *
+                                                     samples_per_event + k))))
+                                                     << l;
+
+                               samples[n++] = cur_sample;
                        }
                }
 
                *lastsample = samples[n - 1];
 
-               /* Send to sigrok. */
+               /* Send data up to trigger point (if triggered) */
                sent = 0;
-               while (sent < n) {
-                       tosend = MIN(4096, n - sent);
+               if (i == triggerts) {
+                       /*
+                        * Trigger is presumptively only accurate to event, i.e.
+                        * for 100 and 200 MHz, where multiple samples are coded
+                        * in a single event, the trigger does not match the
+                        * exact sample.
+                        */
+                       tosend = (triggerpos % 7) - 3;
+
+                       if (tosend > 0) {
+                               packet.type = DF_LOGIC16;
+                               packet.length = tosend * sizeof(uint16_t);
+                               packet.payload = samples;
+                               session_bus(user_data, &packet);
+
+                               sent += tosend;
+                       }
 
-                       packet.type = DF_LOGIC8;
-                       packet.length = tosend;
-                       packet.payload = samples + sent;
+                       packet.type = DF_TRIGGER;
+                       packet.length = 0;
+                       packet.payload = 0;
                        session_bus(user_data, &packet);
-
-                       sent += tosend;
                }
+
+               /* Send rest of the chunk to sigrok */
+               tosend = n - sent;
+
+               packet.type = DF_LOGIC16;
+               packet.length = tosend * sizeof(uint16_t);
+               packet.payload = samples + sent;
+               session_bus(user_data, &packet);
        }
 
-       return 0;
+       return SIGROK_OK;
 }
 
 static int receive_data(int fd, int revents, void *user_data)
@@ -582,7 +752,9 @@ static int receive_data(int fd, int revents, void *user_data)
        uint32_t triggerpos, stoppos, running_msec;
        struct timeval tv;
        uint16_t lastts = 0;
-       uint8_t lastsample = 0;
+       uint16_t lastsample = 0;
+       uint8_t modestatus;
+       int triggerchunk = -1;
 
        fd = fd;
        revents = revents;
@@ -608,6 +780,12 @@ static int receive_data(int fd, int revents, void *user_data)
        /* Get the current position. */
        sigma_read_pos(&stoppos, &triggerpos);
 
+       /* Check if trigger has fired */
+       modestatus = sigma_get_register(READ_MODE);
+       if (modestatus & 0x20) {
+               triggerchunk = triggerpos / 512;
+       }
+
        /* Download sample data. */
        for (curchunk = 0; curchunk < numchunks;) {
                newchunks = MIN(chunks_per_read, numchunks - curchunk);
@@ -623,8 +801,14 @@ static int receive_data(int fd, int revents, void *user_data)
 
                /* Decode chunks and send them to sigrok. */
                for (i = 0; i < newchunks; ++i) {
-                       decode_chunk_ts(buf + (i * CHUNK_SIZE),
-                                       &lastts, &lastsample, user_data);
+                       if (curchunk + i == triggerchunk)
+                               decode_chunk_ts(buf + (i * CHUNK_SIZE),
+                                               &lastts, &lastsample,
+                                               triggerpos & 0x1ff, user_data);
+                       else
+                               decode_chunk_ts(buf + (i * CHUNK_SIZE),
+                                               &lastts, &lastsample,
+                                               -1, user_data);
                }
 
                curchunk += newchunks;
@@ -643,7 +827,10 @@ static int hw_start_acquisition(int device_index, gpointer session_device_id)
        struct sigrok_device_instance *sdi;
        struct datafeed_packet packet;
        struct datafeed_header header;
-       uint8_t trigger_option[2] = { 0x38, 0x00 };
+       struct clockselect_50 clockselect;
+       int frac;
+       uint8_t triggerselect;
+       struct triggerinout triggerinout_conf;
 
        session_device_id = session_device_id;
 
@@ -652,31 +839,69 @@ static int hw_start_acquisition(int device_index, gpointer session_device_id)
 
        device_index = device_index;
 
-       /* Setup trigger (by trigger-in). */
+       /* If the samplerate has not been set, default to 50 MHz. */
+       if (cur_firmware == -1)
+               set_samplerate(sdi, MHZ(50));
+
+       /* Enter trigger programming mode */
        sigma_set_register(WRITE_TRIGGER_SELECT1, 0x20);
 
-       /* More trigger setup. */
-       sigma_write_register(WRITE_TRIGGER_OPTION,
-                            trigger_option, sizeof(trigger_option));
+       /* 100 and 200 MHz mode */
+       if (cur_samplerate >= MHZ(100)) {
+               sigma_set_register(WRITE_TRIGGER_SELECT1, 0x81);
+
+               triggerselect = (1 << LEDSEL1) | (triggerfall << 3) |
+                                       (triggerpin & 0x7);
 
-       /* Trigger normal (falling edge). */
-       sigma_set_register(WRITE_TRIGGER_SELECT1, 0x08);
+       /* All other modes */
+       } else if (cur_samplerate <= MHZ(50)) {
+               sigma_set_register(WRITE_TRIGGER_SELECT1, 0x20);
 
-       /* Enable pins (200 MHz, 4 pins). */
-       sigma_set_register(WRITE_CLOCK_SELECT, 0xf0);
+               triggerselect = (1 << LEDSEL1) | (1 << LEDSEL0);
+       }
+
+       /* Setup trigger in and out pins to default values */
+       memset(&triggerinout_conf, 0, sizeof(struct triggerinout));
+       triggerinout_conf.trgout_bytrigger = 1;
+       triggerinout_conf.trgout_enable = 1;
+
+       sigma_write_register(WRITE_TRIGGER_OPTION,
+                            (uint8_t *) &triggerinout_conf,
+                            sizeof(struct triggerinout));
+
+       /* Go back to normal mode */
+       sigma_set_register(WRITE_TRIGGER_SELECT1, triggerselect);
+
+       /* Set clock select register. */
+       if (cur_samplerate == MHZ(200))
+               /* Enable 4 probes. */
+               sigma_set_register(WRITE_CLOCK_SELECT, 0xf0);
+       else if (cur_samplerate == MHZ(100))
+               /* Enable 8 probes. */
+               sigma_set_register(WRITE_CLOCK_SELECT, 0x00);
+       else {
+               /*
+                * 50 MHz mode (or fraction thereof). Any fraction down to
+                * 50 MHz / 256 can be used, but is not suppoted by sigrok API.
+                */
+               frac = MHZ(50) / cur_samplerate - 1;
+
+               clockselect.async = 0;
+               clockselect.fraction = frac;
+               clockselect.disabled_probes = 0;
+
+               sigma_write_register(WRITE_CLOCK_SELECT,
+                                    (uint8_t *) &clockselect,
+                                    sizeof(clockselect));
+       }
 
        /* Setup maximum post trigger time. */
-       sigma_set_register(WRITE_POST_TRIGGER, 0xff);
+       sigma_set_register(WRITE_POST_TRIGGER, (capture_ratio * 256) / 100);
 
        /* Start acqusition (software trigger start). */
        gettimeofday(&start_tv, 0);
        sigma_set_register(WRITE_MODE, 0x0d);
 
-       /* Add capture source. */
-       source_add(0, G_IO_IN, 10, receive_data, session_device_id);
-
-       receive_data(0, 1, session_device_id);
-
        /* Send header packet to the session bus. */
        packet.type = DF_HEADER;
        packet.length = sizeof(struct datafeed_header);
@@ -685,9 +910,12 @@ static int hw_start_acquisition(int device_index, gpointer session_device_id)
        gettimeofday(&header.starttime, NULL);
        header.samplerate = cur_samplerate;
        header.protocol_id = PROTO_RAW;
-       header.num_probes = 4;
+       header.num_probes = num_probes;
        session_bus(session_device_id, &packet);
 
+       /* Add capture source. */
+       source_add(0, G_IO_IN, 10, receive_data, session_device_id);
+
        return SIGROK_OK;
 }
 
@@ -715,5 +943,5 @@ struct device_plugin asix_sigma_plugin_info = {
        hw_get_capabilities,
        hw_set_configuration,
        hw_start_acquisition,
-       hw_stop_acquisition
+       hw_stop_acquisition,
 };