]> sigrok.org Git - libsigrok.git/blobdiff - src/hardware/kingst-la2016/protocol.c
kingst-la2016: Eliminate non-portable packed structs for USB transfer layout
[libsigrok.git] / src / hardware / kingst-la2016 / protocol.c
index 37ac3d291b6cc25564d00bca6e9f53f21e008018..72cf89541c2e60f43fe4a9f9d1e2ee049a0a4cba 100644 (file)
@@ -28,6 +28,7 @@
 #include <stdio.h>
 #include <errno.h>
 #include <math.h>
+#include <inttypes.h>
 #include <libsigrok/libsigrok.h>
 #include "libsigrok-internal.h"
 #include "protocol.h"
@@ -96,15 +97,20 @@ static int ctrl_out(const struct sr_dev_inst *sdi,
 
 static int upload_fpga_bitstream(const struct sr_dev_inst *sdi)
 {
+       struct dev_context *devc;
        struct drv_context *drvc;
        struct sr_usb_dev_inst *usb;
        struct sr_resource bitstream;
-       uint32_t cmd;
+       uint8_t buffer[sizeof(uint32_t)];
+       uint8_t *wrptr;
        uint8_t cmd_resp;
        uint8_t block[4096];
-       int pos, len, act_len;
+       int len, act_len;
+       unsigned int pos;
        int ret;
+       unsigned int zero_pad_to = 0x2c000;
 
+       devc = sdi->priv;
        drvc = sdi->driver->context;
        usb = sdi->conn;
 
@@ -116,8 +122,10 @@ static int upload_fpga_bitstream(const struct sr_dev_inst *sdi)
                return ret;
        }
 
-       WL32(&cmd, 0x2b602);
-       if ((ret = ctrl_out(sdi, 80, 0x00, 0, &cmd, sizeof(cmd))) != SR_OK) {
+       devc->bitstream_size = (uint32_t)bitstream.size;
+       wrptr = buffer;
+       write_u32le_inc(&wrptr, devc->bitstream_size);
+       if ((ret = ctrl_out(sdi, 80, 0x00, 0, buffer, wrptr - buffer)) != SR_OK) {
                sr_err("failed to give upload init command");
                sr_resource_close(drvc->sr_ctx, &bitstream);
                return ret;
@@ -125,11 +133,19 @@ static int upload_fpga_bitstream(const struct sr_dev_inst *sdi)
 
        pos = 0;
        while (1) {
-               len = (int)sr_resource_read(drvc->sr_ctx, &bitstream, &block, sizeof(block));
-               if (len < 0) {
-                       sr_err("failed to read from fpga bitstream!");
-                       sr_resource_close(drvc->sr_ctx, &bitstream);
-                       return SR_ERR;
+               if (pos < bitstream.size) {
+                       len = (int)sr_resource_read(drvc->sr_ctx, &bitstream, &block, sizeof(block));
+                       if (len < 0) {
+                               sr_err("failed to read from fpga bitstream!");
+                               sr_resource_close(drvc->sr_ctx, &bitstream);
+                               return SR_ERR;
+                       }
+               } else {
+                       // fill with zero's until zero_pad_to
+                       len = zero_pad_to - pos;
+                       if ((unsigned)len > sizeof(block))
+                               len = sizeof(block);
+                       memset(&block, 0, len);
                }
                if (len == 0)
                        break;
@@ -150,20 +166,25 @@ static int upload_fpga_bitstream(const struct sr_dev_inst *sdi)
        sr_resource_close(drvc->sr_ctx, &bitstream);
        if (ret != 0)
                return ret;
-       sr_info("FPGA bitstream upload (%d bytes) done.", pos);
+       sr_info("FPGA bitstream upload (%" PRIu64 " bytes) done.", bitstream.size);
 
        if ((ret = ctrl_in(sdi, 80, 0x00, 0, &cmd_resp, sizeof(cmd_resp))) != SR_OK) {
                sr_err("failed to read response after FPGA bitstream upload");
                return ret;
        }
-       if (cmd_resp != 0)
-               sr_warn("after fpga bitstream upload command response is 0x%02x, expect 0", cmd_resp);
+       if (cmd_resp != 0) {
+               sr_err("after fpga bitstream upload command response is 0x%02x, expect 0!", cmd_resp);
+               return SR_ERR;
+       }
+
+       g_usleep(30000);
 
        if ((ret = ctrl_out(sdi, 16, 0x01, 0, NULL, 0)) != SR_OK) {
                sr_err("failed enable fpga");
                return ret;
        }
 
+       g_usleep(40000);
        return SR_OK;
 }
 
@@ -171,19 +192,25 @@ static int set_threshold_voltage(const struct sr_dev_inst *sdi, float voltage)
 {
        struct dev_context *devc;
        float o1, o2, v1, v2, f;
-       uint32_t cfg;
+       uint32_t cfgval;
+       uint8_t buffer[sizeof(uint32_t)];
+       uint8_t *wrptr;
        int ret;
 
        devc = sdi->priv;
        o1 = 15859969; v1 = 0.45;
        o2 = 15860333; v2 = 1.65;
        f = (o2 - o1) / (v2 - v1);
-       WL32(&cfg, (uint32_t)(o1 + (voltage - v1) * f));
+       cfgval = (uint32_t)(o1 + (voltage - v1) * f);
+       sr_dbg("set threshold voltage %.2fV, raw value 0x%lx",
+               voltage, (unsigned long)cfgval);
 
-       sr_dbg("set threshold voltage %.2fV", voltage);
-       ret = ctrl_out(sdi, 32, CTRL_THRESHOLD, 0, &cfg, sizeof(cfg));
+       wrptr = buffer;
+       write_u32le_inc(&wrptr, cfgval);
+       ret = ctrl_out(sdi, 32, CTRL_THRESHOLD, 0, buffer, wrptr - buffer);
        if (ret != SR_OK) {
-               sr_err("error setting new threshold voltage of %.2fV (%d)", voltage, RL16(&cfg));
+               sr_err("Error setting %.2fV threshold voltage (%d)",
+                       voltage, ret);
                return ret;
        }
        devc->threshold_voltage = voltage;
@@ -222,6 +249,8 @@ static int set_pwm(const struct sr_dev_inst *sdi, uint8_t which, float freq, flo
        pwm_setting_dev_t cfg;
        pwm_setting_t *setting;
        int ret;
+       uint8_t buf[2 * sizeof(uint32_t)];
+       uint8_t *wrptr;
 
        devc = sdi->priv;
 
@@ -242,8 +271,10 @@ static int set_pwm(const struct sr_dev_inst *sdi, uint8_t which, float freq, flo
        cfg.duty = (uint32_t)(0.5f + (cfg.period * duty / 100.));
        sr_dbg("set pwm%d period %d, duty %d", which, cfg.period, cfg.duty);
 
-       pwm_setting_dev_le(cfg);
-       ret = ctrl_out(sdi, 32, CTRL_PWM[which - 1], 0, &cfg, sizeof(cfg));
+       wrptr = buf;
+       write_u32le_inc(&wrptr, cfg.period);
+       write_u32le_inc(&wrptr, cfg.duty);
+       ret = ctrl_out(sdi, 32, CTRL_PWM[which - 1], 0, buf, wrptr - buf);
        if (ret != SR_OK) {
                sr_err("error setting new pwm%d config %d %d", which, cfg.period, cfg.duty);
                return ret;
@@ -251,7 +282,6 @@ static int set_pwm(const struct sr_dev_inst *sdi, uint8_t which, float freq, flo
        setting = &devc->pwm_setting[which - 1];
        setting->freq = freq;
        setting->duty = duty;
-       setting->dev = cfg;
 
        return SR_OK;
 }
@@ -302,6 +332,8 @@ static int set_trigger_config(const struct sr_dev_inst *sdi)
        struct sr_trigger_match *match;
        uint16_t ch_mask;
        int ret;
+       uint8_t buf[4 * sizeof(uint32_t)];
+       uint8_t *wrptr;
 
        devc = sdi->priv;
        trigger = sr_session_trigger_get(sdi->session);
@@ -362,8 +394,12 @@ static int set_trigger_config(const struct sr_dev_inst *sdi)
 
        devc->had_triggers_configured = cfg.enabled != 0;
 
-       trigger_cfg_le(cfg);
-       ret = ctrl_out(sdi, 32, CTRL_TRIGGER, 16, &cfg, sizeof(cfg));
+       wrptr = buf;
+       write_u32le_inc(&wrptr, cfg.channels);
+       write_u32le_inc(&wrptr, cfg.enabled);
+       write_u32le_inc(&wrptr, cfg.level);
+       write_u32le_inc(&wrptr, cfg.high_or_falling);
+       ret = ctrl_out(sdi, 32, CTRL_TRIGGER, 16, buf, wrptr - buf);
        if (ret != SR_OK) {
                sr_err("error setting trigger config!");
                return ret;
@@ -375,11 +411,13 @@ static int set_trigger_config(const struct sr_dev_inst *sdi)
 static int set_sample_config(const struct sr_dev_inst *sdi)
 {
        struct dev_context *devc;
-       sample_config_t cfg;
        double clock_divisor;
        uint64_t psa;
        uint64_t total;
        int ret;
+       uint16_t divisor;
+       uint8_t buf[2 * sizeof(uint32_t) + 48 / 8 + sizeof(uint16_t)];
+       uint8_t *wrptr;
 
        devc = sdi->priv;
        total = 128 * 1024 * 1024;
@@ -392,27 +430,27 @@ static int set_sample_config(const struct sr_dev_inst *sdi)
        clock_divisor = MAX_SAMPLE_RATE / (double)devc->cur_samplerate;
        if (clock_divisor > 0xffff)
                clock_divisor = 0xffff;
-       cfg.clock_divisor = (uint16_t)(clock_divisor + 0.5);
-       devc->cur_samplerate = MAX_SAMPLE_RATE / cfg.clock_divisor;
+       divisor = (uint16_t)(clock_divisor + 0.5);
+       devc->cur_samplerate = MAX_SAMPLE_RATE / divisor;
 
        if (devc->limit_samples > MAX_SAMPLE_DEPTH) {
                sr_err("too high sample depth: %" PRIu64, devc->limit_samples);
                return SR_ERR;
        }
-       cfg.sample_depth = devc->limit_samples;
 
        devc->pre_trigger_size = (devc->capture_ratio * devc->limit_samples) / 100;
 
-       psa = devc->pre_trigger_size * 256;
-       cfg.psa = (uint32_t)(psa & 0xffffffff);
-       cfg.u1  = (uint16_t)((psa >> 32) & 0xffff);
-       cfg.u2 = (uint32_t)((total * devc->capture_ratio) / 100);
-
        sr_dbg("set sampling configuration %.0fkHz, %d samples, trigger-pos %d%%",
-              devc->cur_samplerate/1e3, (unsigned int)cfg.sample_depth, (unsigned int)devc->capture_ratio);
+              devc->cur_samplerate/1e3, (unsigned int)devc->limit_samples, (unsigned int)devc->capture_ratio);
 
-       sample_config_le(cfg);
-       ret = ctrl_out(sdi, 32, CTRL_SAMPLING, 0, &cfg, sizeof(cfg));
+       psa = devc->pre_trigger_size * 256;
+       wrptr = buf;
+       write_u32le_inc(&wrptr, devc->limit_samples);
+       write_u48le_inc(&wrptr, psa);
+       write_u32le_inc(&wrptr, (total * devc->capture_ratio) / 100);
+       write_u16le_inc(&wrptr, clock_divisor);
+
+       ret = ctrl_out(sdi, 32, CTRL_SAMPLING, 0, buf, wrptr - buf);
        if (ret != SR_OK) {
                sr_err("error setting sample config!");
                return ret;
@@ -459,14 +497,20 @@ static int get_capture_info(const struct sr_dev_inst *sdi)
 {
        struct dev_context *devc;
        int ret;
+       uint8_t buf[3 * sizeof(uint32_t)];
+       const uint8_t *rdptr;
 
        devc = sdi->priv;
 
-       if ((ret = ctrl_in(sdi, 32, CTRL_BULK, 0, &devc->info, sizeof(devc->info))) != SR_OK) {
+       if ((ret = ctrl_in(sdi, 32, CTRL_BULK, 0, buf, sizeof(buf))) != SR_OK) {
                sr_err("failed to read capture info!");
                return ret;
        }
-       capture_info_host(devc->info);
+
+       rdptr = buf;
+       devc->info.n_rep_packets = read_u32le_inc(&rdptr);
+       devc->info.n_rep_packets_before_trigger = read_u32le_inc(&rdptr);
+       devc->info.write_pos = read_u32le_inc(&rdptr);
 
        sr_dbg("capture info: n_rep_packets: 0x%08x/%d, before_trigger: 0x%08x/%d, write_pos: 0x%08x%d",
               devc->info.n_rep_packets, devc->info.n_rep_packets,
@@ -483,7 +527,7 @@ SR_PRIV int la2016_upload_firmware(struct sr_context *sr_ctx, libusb_device *dev
 {
        char fw_file[1024];
        snprintf(fw_file, sizeof(fw_file) - 1, UC_FIRMWARE, product_id);
-       return ezusb_upload_firmware(sr_ctx, dev, 0, fw_file);
+       return ezusb_upload_firmware(sr_ctx, dev, USB_CONFIGURATION, fw_file);
 }
 
 SR_PRIV int la2016_setup_acquisition(const struct sr_dev_inst *sdi)
@@ -544,7 +588,8 @@ SR_PRIV int la2016_start_retrieval(const struct sr_dev_inst *sdi, libusb_transfe
        struct dev_context *devc;
        struct sr_usb_dev_inst *usb;
        int ret;
-       uint32_t bulk_cfg[2];
+       uint8_t wrbuf[2 * sizeof(uint32_t)];
+       uint8_t *wrptr;
        uint32_t to_read;
        uint8_t *buffer;
 
@@ -554,8 +599,8 @@ SR_PRIV int la2016_start_retrieval(const struct sr_dev_inst *sdi, libusb_transfe
        if ((ret = get_capture_info(sdi)) != SR_OK)
                return ret;
 
-       devc->n_transfer_packets_to_read = devc->info.n_rep_packets / 5;
-       devc->n_bytes_to_read = devc->n_transfer_packets_to_read * sizeof(transfer_packet_t);
+       devc->n_transfer_packets_to_read = devc->info.n_rep_packets / NUM_PACKETS_IN_CHUNK;
+       devc->n_bytes_to_read = devc->n_transfer_packets_to_read * TRANSFER_PACKET_LENGTH;
        devc->read_pos = devc->info.write_pos - devc->n_bytes_to_read;
        devc->n_reps_until_trigger = devc->info.n_rep_packets_before_trigger;
 
@@ -566,10 +611,11 @@ SR_PRIV int la2016_start_retrieval(const struct sr_dev_inst *sdi, libusb_transfe
                sr_err("failed to reset bulk state");
                return ret;
        }
-       WL32(&bulk_cfg[0], devc->read_pos);
-       WL32(&bulk_cfg[1], devc->n_bytes_to_read);
        sr_dbg("will read from 0x%08x, 0x%08x bytes", devc->read_pos, devc->n_bytes_to_read);
-       if ((ret = ctrl_out(sdi, 32, CTRL_BULK, 0, &bulk_cfg, sizeof(bulk_cfg))) != SR_OK) {
+       wrptr = wrbuf;
+       write_u32le_inc(&wrptr, devc->read_pos);
+       write_u32le_inc(&wrptr, devc->n_bytes_to_read);
+       if ((ret = ctrl_out(sdi, 32, CTRL_BULK, 0, wrbuf, wrptr - wrbuf)) != SR_OK) {
                sr_err("failed to send bulk config");
                return ret;
        }
@@ -607,19 +653,27 @@ SR_PRIV int la2016_start_retrieval(const struct sr_dev_inst *sdi, libusb_transfe
 
 SR_PRIV int la2016_init_device(const struct sr_dev_inst *sdi)
 {
+       struct dev_context *devc;
        int ret;
        uint32_t i1;
        uint32_t i2[2];
        uint16_t state;
 
-       uint8_t unknown_cmd1[] = { 0xa3, 0x09, 0xc9, 0x8d, 0xe7, 0xad, 0x7a, 0x62, 0xb6, 0xd1, 0xbf };
-       uint8_t expected_unknown_resp1[] = { 0xa3, 0x10, 0xda, 0x66, 0x6b, 0x93, 0x5c, 0x55, 0x38, 0x50, 0x39, 0x51, 0x98, 0x86, 0x5d, 0x06, 0x7c, 0xea };
-       uint8_t unknown_resp1[sizeof(expected_unknown_resp1)];
+       /* this unknown_cmd1 seems to depend on the FPGA bitstream */
+       uint8_t unknown_cmd1_340[] = { 0xa3, 0x09, 0xc9, 0x8d, 0xe7, 0xad, 0x7a, 0x62, 0xb6, 0xd1, 0xbf };
+       uint8_t unknown_cmd1_342[] = { 0xa3, 0x09, 0xc9, 0xf4, 0x32, 0x4c, 0x4d, 0xee, 0xab, 0xa0, 0xdd };
+       uint8_t expected_unknown_resp1_340[] = { 0xa3, 0x10, 0xda, 0x66, 0x6b, 0x93, 0x5c, 0x55, 0x38, 0x50, 0x39, 0x51, 0x98, 0x86, 0x5d, 0x06, 0x7c, 0xea };
+       uint8_t expected_unknown_resp1_342[] = { 0xa3, 0x10, 0xb3, 0x92, 0x7b, 0xd8, 0x6b, 0xca, 0xa5, 0xab, 0x42, 0x6e, 0xda, 0xcd, 0x9d, 0xf1, 0x31, 0x2f };
+       uint8_t unknown_resp1[sizeof(expected_unknown_resp1_340)];
+       uint8_t *expected_unknown_resp1;
+       uint8_t *unknown_cmd1;
 
        uint8_t unknown_cmd2[] = { 0xa3, 0x01, 0xca };
        uint8_t expected_unknown_resp2[] = { 0xa3, 0x08, 0x06, 0x83, 0x96, 0x29, 0x15, 0xe1, 0x92, 0x74, 0x00, 0x00 };
        uint8_t unknown_resp2[sizeof(expected_unknown_resp2)];
 
+       devc = sdi->priv;
+
        if ((ret = ctrl_in(sdi, 162, 0x20, 0, &i1, sizeof(i1))) != SR_OK) {
                sr_err("failed to read i1");
                return ret;
@@ -637,9 +691,23 @@ SR_PRIV int la2016_init_device(const struct sr_dev_inst *sdi)
                return ret;
        }
 
-       run_state(sdi);
+       if (run_state(sdi) == 0xffff) {
+               sr_err("run_state after fpga bitstream upload is 0xffff!");
+               return SR_ERR;
+       }
 
-       if ((ret = ctrl_out(sdi, 96, 0x00, 0, unknown_cmd1, sizeof(unknown_cmd1))) != SR_OK) {
+       if (devc->bitstream_size == 0x2b602) {
+               // v3.4.0
+               unknown_cmd1 = unknown_cmd1_340;
+               expected_unknown_resp1 = expected_unknown_resp1_340;
+       } else {
+               // v3.4.2
+               if (devc->bitstream_size != 0x2b839)
+                       sr_warn("the FPGA bitstream size %d is unknown. tested bistreams from vendor's version 3.4.0 and 3.4.2\n", devc->bitstream_size);
+               unknown_cmd1 = unknown_cmd1_342;
+               expected_unknown_resp1 = expected_unknown_resp1_342;
+       }
+       if ((ret = ctrl_out(sdi, 96, 0x00, 0, unknown_cmd1, sizeof(unknown_cmd1_340))) != SR_OK) {
                sr_err("failed to send unknown_cmd1");
                return ret;
        }
@@ -649,7 +717,7 @@ SR_PRIV int la2016_init_device(const struct sr_dev_inst *sdi)
                return ret;
        }
        if (memcmp(unknown_resp1, expected_unknown_resp1, sizeof(unknown_resp1)))
-               sr_dbg("unknown_cmd1 response is not as expected!");
+               sr_dbg("unknown_cmd1 response is not as expected, this is to be expected...");
 
        state = run_state(sdi);
        if (state != 0x85e9)