]> sigrok.org Git - libsigrok.git/blobdiff - src/hardware/asix-sigma/api.c
asix-sigma: rephrase firmware dependent param upload at acquisition start
[libsigrok.git] / src / hardware / asix-sigma / api.c
index 0a829794754157b9b28653d998a5f6dfac31437e..2cc5061108139e8519f2480b058dceff4e769162 100644 (file)
@@ -4,6 +4,7 @@
  * Copyright (C) 2010-2012 Håvard Espeland <gus@ping.uio.no>,
  * Copyright (C) 2010 Martin Stensgård <mastensg@ping.uio.no>
  * Copyright (C) 2010 Carl Henrik Lunde <chlunde@ping.uio.no>
+ * Copyright (C) 2020 Gerhard Sittig <gerhard.sittig@gmx.net>
  *
  * 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
@@ -62,7 +63,7 @@ static const int32_t trigger_matches[] = {
 
 static void clear_helper(struct dev_context *devc)
 {
-       ftdi_deinit(&devc->ftdic);
+       (void)sigma_force_close(devc);
 }
 
 static int dev_clear(const struct sr_dev_driver *di)
@@ -238,11 +239,13 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
                devc->id.serno = serno_num;
                devc->id.prefix = serno_pre;
                devc->id.type = dev_type;
-               devc->samplerate = samplerates[0];
                sr_sw_limits_init(&devc->cfg_limits);
-               devc->firmware_idx = SIGMA_FW_NONE;
                devc->capture_ratio = 50;
                devc->use_triggers = 0;
+
+               /* TODO Retrieve some of this state from hardware? */
+               devc->firmware_idx = SIGMA_FW_NONE;
+               devc->samplerate = sigma_get_samplerate(sdi);
        }
        libusb_free_device_list(devlist, 1);
        g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
@@ -253,9 +256,6 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
 static int dev_open(struct sr_dev_inst *sdi)
 {
        struct dev_context *devc;
-       long vid, pid;
-       const char *serno;
-       int ret;
 
        devc = sdi->priv;
 
@@ -263,37 +263,17 @@ static int dev_open(struct sr_dev_inst *sdi)
                sr_err("OMEGA support is not implemented yet.");
                return SR_ERR_NA;
        }
-       vid = devc->id.vid;
-       pid = devc->id.pid;
-       serno = sdi->serial_num;
-
-       ret = ftdi_init(&devc->ftdic);
-       if (ret < 0) {
-               sr_err("Cannot initialize FTDI context (%d): %s.",
-                       ret, ftdi_get_error_string(&devc->ftdic));
-               return SR_ERR_IO;
-       }
-       ret = ftdi_usb_open_desc_index(&devc->ftdic, vid, pid, NULL, serno, 0);
-       if (ret < 0) {
-               sr_err("Cannot open device (%d): %s.",
-                       ret, ftdi_get_error_string(&devc->ftdic));
-               return SR_ERR_IO;
-       }
 
-       return SR_OK;
+       return sigma_force_open(sdi);
 }
 
 static int dev_close(struct sr_dev_inst *sdi)
 {
        struct dev_context *devc;
-       int ret;
 
        devc = sdi->priv;
 
-       ret = ftdi_usb_close(&devc->ftdic);
-       ftdi_deinit(&devc->ftdic);
-
-       return (ret == 0) ? SR_OK : SR_ERR;
+       return sigma_force_close(devc);
 }
 
 static int config_get(uint32_t key, GVariant **data,
@@ -383,7 +363,7 @@ static int config_list(uint32_t key, GVariant **data,
                return STD_CONFIG_LIST(key, data, sdi, cg,
                        scanopts, drvopts, devopts);
        case SR_CONF_SAMPLERATE:
-               *data = std_gvar_samplerates(samplerates, samplerates_count);
+               *data = sigma_get_samplerates_list();
                break;
 #if ASIX_SIGMA_WITH_TRIGGER
        case SR_CONF_TRIGGER_MATCH:
@@ -400,9 +380,10 @@ static int config_list(uint32_t key, GVariant **data,
 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 {
        struct dev_context *devc;
-       struct clockselect_50 clockselect;
+       uint16_t pindis_mask;
+       uint8_t async, div;
        int triggerpin, ret;
-       uint8_t triggerselect;
+       uint8_t trigsel2;
        struct triggerinout triggerinout_conf;
        struct triggerlut lut;
        uint8_t regval, trgconf_bytes[2], clock_bytes[4], *wrptr;
@@ -426,18 +407,24 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi)
        if (ret != SR_OK)
                return ret;
 
-       if (sigma_convert_trigger(sdi) != SR_OK) {
-               sr_err("Failed to configure triggers.");
-               return SR_ERR;
+       ret = sigma_convert_trigger(sdi);
+       if (ret != SR_OK) {
+               sr_err("Could not configure triggers.");
+               return ret;
        }
 
        /* Enter trigger programming mode. */
-       sigma_set_register(devc, WRITE_TRIGGER_SELECT2, 0x20);
+       ret = sigma_set_register(devc, WRITE_TRIGGER_SELECT2, 0x20);
+       if (ret != SR_OK)
+               return ret;
 
-       triggerselect = 0;
+       trigsel2 = 0;
        if (devc->samplerate >= SR_MHZ(100)) {
                /* 100 and 200 MHz mode. */
-               sigma_set_register(devc, WRITE_TRIGGER_SELECT2, 0x81);
+               /* TODO Decipher the 0x81 magic number's purpose. */
+               ret = sigma_set_register(devc, WRITE_TRIGGER_SELECT2, 0x81);
+               if (ret != SR_OK)
+                       return ret;
 
                /* Find which pin to trigger on from mask. */
                for (triggerpin = 0; triggerpin < 8; triggerpin++) {
@@ -448,23 +435,32 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi)
                }
 
                /* Set trigger pin and light LED on trigger. */
-               triggerselect = TRGSEL2_LEDSEL1 | (triggerpin & 0x7);
+               trigsel2 = triggerpin & TRGSEL2_PINS_MASK;
+               trigsel2 |= TRGSEL2_LEDSEL1;
 
                /* Default rising edge. */
+               /* TODO Documentation disagrees, bit set means _rising_ edge. */
                if (devc->trigger.fallingmask)
-                       triggerselect |= 1 << 3;
+                       trigsel2 |= TRGSEL2_PINPOL_RISE;
 
        } else if (devc->samplerate <= SR_MHZ(50)) {
-               /* All other modes. */
-               sigma_build_basic_trigger(devc, &lut);
+               /* 50MHz firmware modes. */
 
-               sigma_write_trigger_lut(devc, &lut);
+               /* Translate application specs to hardware perspective. */
+               ret = sigma_build_basic_trigger(devc, &lut);
+               if (ret != SR_OK)
+                       return ret;
+
+               /* Communicate resulting register values to the device. */
+               ret = sigma_write_trigger_lut(devc, &lut);
+               if (ret != SR_OK)
+                       return ret;
 
-               triggerselect = TRGSEL2_LEDSEL1 | TRGSEL2_LEDSEL0;
+               trigsel2 = TRGSEL2_LEDSEL1 | TRGSEL2_LEDSEL0;
        }
 
        /* Setup trigger in and out pins to default values. */
-       memset(&triggerinout_conf, 0, sizeof(struct triggerinout));
+       memset(&triggerinout_conf, 0, sizeof(triggerinout_conf));
        triggerinout_conf.trgout_bytrigger = 1;
        triggerinout_conf.trgout_enable = 1;
        /* TODO
@@ -486,54 +482,75 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi)
                regval |= TRGOPT_TRGOEN;
        write_u8_inc(&wrptr, regval);
        count = wrptr - trgconf_bytes;
-       sigma_write_register(devc, WRITE_TRIGGER_OPTION, trgconf_bytes, count);
+       ret = sigma_write_register(devc, WRITE_TRIGGER_OPTION,
+               trgconf_bytes, count);
+       if (ret != SR_OK)
+               return ret;
 
        /* Leave trigger programming mode. */
-       sigma_set_register(devc, WRITE_TRIGGER_SELECT2, triggerselect);
-
-       /* Set clock select register. */
-       clockselect.async = 0;
-       clockselect.fraction = 1;               /* Divider 1. */
-       clockselect.disabled_channels = 0x0000; /* All channels enabled. */
-       if (devc->samplerate == SR_MHZ(200)) {
-               /* Enable 4 channels. */
-               clockselect.disabled_channels = 0xfff0;
-       } else if (devc->samplerate == SR_MHZ(100)) {
-               /* Enable 8 channels. */
-               clockselect.disabled_channels = 0xff00;
+       ret = sigma_set_register(devc, WRITE_TRIGGER_SELECT2, trigsel2);
+       if (ret != SR_OK)
+               return ret;
+
+       /*
+        * Samplerate dependent clock and channels configuration. Some
+        * channels by design are not available at higher clock rates.
+        * Register layout differs between firmware variants (depth 1
+        * with LSB channel mask above 50MHz, depth 4 with more details
+        * up to 50MHz).
+        *
+        * Derive a mask where bits are set for unavailable channels.
+        * Either send the single byte, or the full byte sequence.
+        */
+       pindis_mask = ~((1UL << devc->num_channels) - 1);
+       if (devc->samplerate > SR_MHZ(50)) {
+               ret = sigma_set_register(devc, WRITE_CLOCK_SELECT,
+                       pindis_mask & 0xff);
        } else {
+               wrptr = clock_bytes;
+               /* Select 50MHz base clock, and divider. */
+               async = 0;
+               div = SR_MHZ(50) / devc->samplerate - 1;
                /*
-                * 50 MHz mode, or fraction thereof. The 50MHz reference
-                * can get divided by any integer in the range 1 to 256.
-                * Divider minus 1 gets written to the hardware.
-                * (The driver lists a discrete set of sample rates, but
-                * all of them fit the above description.)
+                * TODO Optionally use external clock.
+                * async[0] = 1 to enable external clock
+                * div[5] = 1 to select falling edge
+                * div[4] = 1 to select rising edge
+                * div[3:0] = 1..16 to select clock pin
                 */
-               clockselect.fraction = SR_MHZ(50) / devc->samplerate;
+               write_u8_inc(&wrptr, async);
+               write_u8_inc(&wrptr, div);
+               write_u16be_inc(&wrptr, pindis_mask);
+               ret = sigma_write_register(devc, WRITE_CLOCK_SELECT,
+                       clock_bytes, wrptr - clock_bytes);
        }
-       wrptr = clock_bytes;
-       write_u8_inc(&wrptr, clockselect.async);
-       write_u8_inc(&wrptr, clockselect.fraction - 1);
-       write_u16be_inc(&wrptr, clockselect.disabled_channels);
-       count = wrptr - clock_bytes;
-       sigma_write_register(devc, WRITE_CLOCK_SELECT, clock_bytes, count);
+       if (ret != SR_OK)
+               return ret;
 
        /* Setup maximum post trigger time. */
-       sigma_set_register(devc, WRITE_POST_TRIGGER,
+       ret = sigma_set_register(devc, WRITE_POST_TRIGGER,
                (devc->capture_ratio * 255) / 100);
+       if (ret != SR_OK)
+               return ret;
 
        /* Start acqusition. */
        regval = WMR_TRGRES | WMR_SDRAMWRITEEN;
 #if ASIX_SIGMA_WITH_TRIGGER
        regval |= WMR_TRGEN;
 #endif
-       sigma_set_register(devc, WRITE_MODE, regval);
+       ret = sigma_set_register(devc, WRITE_MODE, regval);
+       if (ret != SR_OK)
+               return ret;
 
-       std_session_send_df_header(sdi);
+       ret = std_session_send_df_header(sdi);
+       if (ret != SR_OK)
+               return ret;
 
        /* Add capture source. */
-       sr_session_source_add(sdi->session, -1, 0, 10,
+       ret = sr_session_source_add(sdi->session, -1, 0, 10,
                sigma_receive_data, (void *)sdi);
+       if (ret != SR_OK)
+               return ret;
 
        devc->state.state = SIGMA_CAPTURE;
 
@@ -557,7 +574,7 @@ static int dev_acquisition_stop(struct sr_dev_inst *sdi)
                devc->state.state = SIGMA_STOPPING;
        } else {
                devc->state.state = SIGMA_IDLE;
-               sr_session_source_remove(sdi->session, -1);
+               (void)sr_session_source_remove(sdi->session, -1);
        }
 
        return SR_OK;