2 * This file is part of the libsigrok project.
4 * Copyright (C) 2020 Florian Schmidt <schmidt_florian@gmx.de>
5 * Copyright (C) 2013 Marcus Comstedt <marcus@mc.pp.se>
6 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
7 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
9 * This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation, either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
27 #include <glib/gstdio.h>
32 #include <libsigrok/libsigrok.h>
33 #include "libsigrok-internal.h"
36 #define UC_FIRMWARE "kingst-la-%04x.fw"
37 #define FPGA_FW_LA2016 "kingst-la2016-fpga.bitstream"
38 #define FPGA_FW_LA2016A "kingst-la2016a1-fpga.bitstream"
39 #define FPGA_FW_LA1016 "kingst-la1016-fpga.bitstream"
40 #define FPGA_FW_LA1016A "kingst-la1016a1-fpga.bitstream"
42 #define MAX_SAMPLE_RATE_LA2016 SR_MHZ(200)
43 #define MAX_SAMPLE_RATE_LA1016 SR_MHZ(100)
44 #define MAX_SAMPLE_DEPTH 10e9
45 #define MAX_PWM_FREQ SR_MHZ(20)
46 #define PWM_CLOCK SR_MHZ(200) /* this is 200MHz for both the LA2016 and LA1016 */
48 /* usb vendor class control requests to the cypress FX2 microcontroller */
49 #define CMD_EEPROM 0xa2 /* ctrl_in reads, ctrl_out writes */
50 #define CMD_FPGA_INIT 0x50 /* used before and after FPGA bitstream loading */
51 #define CMD_FPGA_SPI 0x20 /* access registers in the FPGA over SPI bus, ctrl_in reads, ctrl_out writes */
52 #define CMD_FPGA_ENABLE 0x10
53 #define CMD_BULK_RESET 0x38 /* flush FX2 usb endpoint 6 IN fifos */
54 #define CMD_BULK_START 0x30 /* begin transfer of capture data via usb endpoint 6 IN */
55 #define CMD_KAUTH 0x60 /* communicate with authentication ic U10, not used */
58 * fpga spi register addresses for control request CMD_FPGA_SPI:
59 * There are around 60 byte-wide registers within the fpga and
60 * these are the base addresses used for accessing them.
61 * On the spi bus, the msb of the address byte is set for read
62 * and cleared for write, but that is handled by the fx2 mcu
63 * as appropriate. In this driver code just use IN transactions
64 * to read, OUT to write.
66 #define REG_RUN 0x00 /* read capture status, write capture start */
67 #define REG_PWM_EN 0x02 /* user pwm channels on/off */
68 #define REG_CAPT_MODE 0x03 /* set to 0x00 for capture to sdram, 0x01 bypass sdram for streaming */
69 #define REG_BULK 0x08 /* write start address and number of bytes for capture data bulk upload */
70 #define REG_SAMPLING 0x10 /* write capture config, read capture data location in sdram */
71 #define REG_TRIGGER 0x20 /* write level and edge trigger config */
72 #define REG_THRESHOLD 0x68 /* write two pwm configs to control input threshold dac */
73 #define REG_PWM1 0x70 /* write config for user pwm1 */
74 #define REG_PWM2 0x78 /* write config for user pwm2 */
76 static int ctrl_in(const struct sr_dev_inst *sdi,
77 uint8_t bRequest, uint16_t wValue, uint16_t wIndex,
78 void *data, uint16_t wLength)
80 struct sr_usb_dev_inst *usb;
85 if ((ret = libusb_control_transfer(
86 usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_ENDPOINT_IN,
87 bRequest, wValue, wIndex, (unsigned char *)data, wLength,
88 DEFAULT_TIMEOUT_MS)) != wLength) {
89 sr_err("failed to read %d bytes via ctrl-in %d %#x, %d: %s.",
90 wLength, bRequest, wValue, wIndex,
91 libusb_error_name(ret));
98 static int ctrl_out(const struct sr_dev_inst *sdi,
99 uint8_t bRequest, uint16_t wValue, uint16_t wIndex,
100 void *data, uint16_t wLength)
102 struct sr_usb_dev_inst *usb;
107 if ((ret = libusb_control_transfer(
108 usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_ENDPOINT_OUT,
109 bRequest, wValue, wIndex, (unsigned char*)data, wLength,
110 DEFAULT_TIMEOUT_MS)) != wLength) {
111 sr_err("failed to write %d bytes via ctrl-out %d %#x, %d: %s.",
112 wLength, bRequest, wValue, wIndex,
113 libusb_error_name(ret));
120 static int upload_fpga_bitstream(const struct sr_dev_inst *sdi, const char *bitstream_fname)
122 struct dev_context *devc;
123 struct drv_context *drvc;
124 struct sr_usb_dev_inst *usb;
125 struct sr_resource bitstream;
126 uint8_t buffer[sizeof(uint32_t)];
133 unsigned int zero_pad_to = 0x2c000;
136 drvc = sdi->driver->context;
139 sr_info("Uploading FPGA bitstream '%s'.", bitstream_fname);
141 ret = sr_resource_open(drvc->sr_ctx, &bitstream, SR_RESOURCE_FIRMWARE, bitstream_fname);
143 sr_err("could not find fpga firmware %s!", bitstream_fname);
147 devc->bitstream_size = (uint32_t)bitstream.size;
149 write_u32le_inc(&wrptr, devc->bitstream_size);
150 if ((ret = ctrl_out(sdi, CMD_FPGA_INIT, 0x00, 0, buffer, wrptr - buffer)) != SR_OK) {
151 sr_err("failed to give upload init command");
152 sr_resource_close(drvc->sr_ctx, &bitstream);
158 if (pos < bitstream.size) {
159 len = (int)sr_resource_read(drvc->sr_ctx, &bitstream, &block, sizeof(block));
161 sr_err("failed to read from fpga bitstream!");
162 sr_resource_close(drvc->sr_ctx, &bitstream);
166 // fill with zero's until zero_pad_to
167 len = zero_pad_to - pos;
168 if ((unsigned)len > sizeof(block))
170 memset(&block, 0, len);
175 ret = libusb_bulk_transfer(usb->devhdl, 2, (unsigned char*)&block[0], len, &act_len, DEFAULT_TIMEOUT_MS);
177 sr_dbg("failed to write fpga bitstream block at %#x len %d: %s.", pos, (int)len, libusb_error_name(ret));
181 if (act_len != len) {
182 sr_dbg("failed to write fpga bitstream block at %#x len %d: act_len is %d.", pos, (int)len, act_len);
188 sr_resource_close(drvc->sr_ctx, &bitstream);
191 sr_info("FPGA bitstream upload (%" PRIu64 " bytes) done.", bitstream.size);
193 if ((ret = ctrl_in(sdi, CMD_FPGA_INIT, 0x00, 0, &cmd_resp, sizeof(cmd_resp))) != SR_OK) {
194 sr_err("failed to read response after FPGA bitstream upload");
198 sr_err("after fpga bitstream upload command response is 0x%02x, expect 0!", cmd_resp);
204 if ((ret = ctrl_out(sdi, CMD_FPGA_ENABLE, 0x01, 0, NULL, 0)) != SR_OK) {
205 sr_err("failed enable fpga");
213 static int set_threshold_voltage(const struct sr_dev_inst *sdi, float voltage)
215 struct dev_context *devc;
220 uint16_t duty_R79,duty_R56;
221 uint8_t buf[2 * sizeof(uint16_t)];
224 /* clamp threshold setting within valid range for LA2016 */
228 else if (voltage < -4.0) {
233 * The fpga has two programmable pwm outputs which feed a dac that
234 * is used to adjust input offset. The dac changes the input
235 * swing around the fixed fpga input threshold.
236 * The two pwm outputs can be seen on R79 and R56 respectvely.
237 * Frequency is fixed at 100kHz and duty is varied.
238 * The R79 pwm uses just three settings.
239 * The R56 pwm varies with required threshold and its behaviour
240 * also changes depending on the setting of R79 PWM.
244 * calculate required pwm duty register values from requested threshold voltage
245 * see last page of schematic (on wiki) for an explanation of these numbers
247 if (voltage >= 2.9) {
248 duty_R79 = 0; /* this pwm is off (0V)*/
249 duty_R56 = (uint16_t)(302 * voltage - 363);
251 else if (voltage <= -0.4) {
252 duty_R79 = 0x02D7; /* 72% duty */
253 duty_R56 = (uint16_t)(302 * voltage + 1090);
256 duty_R79 = 0x00f2; /* 25% duty */
257 duty_R56 = (uint16_t)(302 * voltage + 121);
260 /* clamp duty register values at sensible limits */
264 else if (duty_R56 > 1100) {
268 sr_dbg("set threshold voltage %.2fV", voltage);
269 sr_dbg("duty_R56=0x%04x, duty_R79=0x%04x", duty_R56, duty_R79);
272 write_u16le_inc(&wrptr, duty_R56);
273 write_u16le_inc(&wrptr, duty_R79);
275 ret = ctrl_out(sdi, CMD_FPGA_SPI, REG_THRESHOLD, 0, buf, wrptr - buf);
277 sr_err("error setting new threshold voltage of %.2fV", voltage);
280 devc->threshold_voltage = voltage;
285 static int enable_pwm(const struct sr_dev_inst *sdi, uint8_t p1, uint8_t p2)
287 struct dev_context *devc;
294 if (p1) cfg |= 1 << 0;
295 if (p2) cfg |= 1 << 1;
297 sr_dbg("set pwm enable %d %d", p1, p2);
298 ret = ctrl_out(sdi, CMD_FPGA_SPI, REG_PWM_EN, 0, &cfg, sizeof(cfg));
300 sr_err("error setting new pwm enable 0x%02x", cfg);
303 devc->pwm_setting[0].enabled = (p1) ? 1 : 0;
304 devc->pwm_setting[1].enabled = (p2) ? 1 : 0;
309 static int set_pwm(const struct sr_dev_inst *sdi, uint8_t which, float freq, float duty)
311 int CTRL_PWM[] = { REG_PWM1, REG_PWM2 };
312 struct dev_context *devc;
313 pwm_setting_dev_t cfg;
314 pwm_setting_t *setting;
316 uint8_t buf[2 * sizeof(uint32_t)];
321 if (which < 1 || which > 2) {
322 sr_err("invalid pwm channel: %d", which);
325 if (freq > MAX_PWM_FREQ) {
326 sr_err("pwm frequency too high: %.1f", freq);
329 if (duty > 100 || duty < 0) {
330 sr_err("invalid pwm percentage: %f", duty);
334 cfg.period = (uint32_t)(PWM_CLOCK / freq);
335 cfg.duty = (uint32_t)(0.5f + (cfg.period * duty / 100.));
336 sr_dbg("set pwm%d period %d, duty %d", which, cfg.period, cfg.duty);
339 write_u32le_inc(&wrptr, cfg.period);
340 write_u32le_inc(&wrptr, cfg.duty);
341 ret = ctrl_out(sdi, CMD_FPGA_SPI, CTRL_PWM[which - 1], 0, buf, wrptr - buf);
343 sr_err("error setting new pwm%d config %d %d", which, cfg.period, cfg.duty);
346 setting = &devc->pwm_setting[which - 1];
347 setting->freq = freq;
348 setting->duty = duty;
353 static int set_defaults(const struct sr_dev_inst *sdi)
355 struct dev_context *devc;
360 devc->capture_ratio = 5; /* percent */
361 devc->cur_channels = 0xffff;
362 devc->limit_samples = 5000000;
363 devc->cur_samplerate = SR_MHZ(100);
365 ret = set_threshold_voltage(sdi, devc->threshold_voltage);
369 ret = enable_pwm(sdi, 0, 0);
373 ret = set_pwm(sdi, 1, 1e3, 50);
377 ret = set_pwm(sdi, 2, 100e3, 50);
381 ret = enable_pwm(sdi, 1, 1);
388 static int set_trigger_config(const struct sr_dev_inst *sdi)
390 struct dev_context *devc;
391 struct sr_trigger *trigger;
395 struct sr_trigger_stage *stage1;
396 struct sr_trigger_match *match;
399 uint8_t buf[4 * sizeof(uint32_t)];
403 trigger = sr_session_trigger_get(sdi->session);
405 memset(&cfg, 0, sizeof(cfg));
407 cfg.channels = devc->cur_channels;
409 if (trigger && trigger->stages) {
410 stages = trigger->stages;
411 stage1 = stages->data;
413 sr_err("Only one trigger stage supported for now.");
416 channel = stage1->matches;
418 match = channel->data;
419 ch_mask = 1 << match->channel->index;
421 switch (match->match) {
422 case SR_TRIGGER_ZERO:
423 cfg.level |= ch_mask;
424 cfg.high_or_falling &= ~ch_mask;
427 cfg.level |= ch_mask;
428 cfg.high_or_falling |= ch_mask;
430 case SR_TRIGGER_RISING:
431 if ((cfg.enabled & ~cfg.level)) {
432 sr_err("Only one trigger signal with falling-/rising-edge allowed.");
435 cfg.level &= ~ch_mask;
436 cfg.high_or_falling &= ~ch_mask;
438 case SR_TRIGGER_FALLING:
439 if ((cfg.enabled & ~cfg.level)) {
440 sr_err("Only one trigger signal with falling-/rising-edge allowed.");
443 cfg.level &= ~ch_mask;
444 cfg.high_or_falling |= ch_mask;
447 sr_err("Unknown trigger value.");
450 cfg.enabled |= ch_mask;
451 channel = channel->next;
454 sr_dbg("set trigger configuration channels: 0x%04x, "
455 "trigger-enabled 0x%04x, level-triggered 0x%04x, "
456 "high/falling 0x%04x", cfg.channels, cfg.enabled, cfg.level,
457 cfg.high_or_falling);
459 devc->had_triggers_configured = cfg.enabled != 0;
462 write_u32le_inc(&wrptr, cfg.channels);
463 write_u32le_inc(&wrptr, cfg.enabled);
464 write_u32le_inc(&wrptr, cfg.level);
465 write_u32le_inc(&wrptr, cfg.high_or_falling);
466 ret = ctrl_out(sdi, CMD_FPGA_SPI, REG_TRIGGER, 16, buf, wrptr - buf);
468 sr_err("error setting trigger config!");
475 static int set_sample_config(const struct sr_dev_inst *sdi)
477 struct dev_context *devc;
478 double clock_divisor;
482 uint8_t buf[2 * sizeof(uint32_t) + 48 / 8 + sizeof(uint16_t)];
486 total = 128 * 1024 * 1024;
488 if (devc->cur_samplerate > devc->max_samplerate) {
489 sr_err("too high sample rate: %" PRIu64, devc->cur_samplerate);
493 clock_divisor = devc->max_samplerate / (double)devc->cur_samplerate;
494 if (clock_divisor > 0xffff)
495 clock_divisor = 0xffff;
496 divisor = (uint16_t)(clock_divisor + 0.5);
497 devc->cur_samplerate = devc->max_samplerate / divisor;
499 if (devc->limit_samples > MAX_SAMPLE_DEPTH) {
500 sr_err("too high sample depth: %" PRIu64, devc->limit_samples);
504 devc->pre_trigger_size = (devc->capture_ratio * devc->limit_samples) / 100;
506 sr_dbg("set sampling configuration %.0fkHz, %d samples, trigger-pos %d%%",
507 devc->cur_samplerate / 1e3, (unsigned int)devc->limit_samples, (unsigned int)devc->capture_ratio);
510 write_u32le_inc(&wrptr, devc->limit_samples);
511 write_u8_inc(&wrptr, 0);
512 write_u32le_inc(&wrptr, devc->pre_trigger_size);
513 write_u32le_inc(&wrptr, ((total * devc->capture_ratio) / 100) & 0xFFFFFF00 );
514 write_u16le_inc(&wrptr, divisor);
515 write_u8_inc(&wrptr, 0);
517 ret = ctrl_out(sdi, CMD_FPGA_SPI, REG_SAMPLING, 0, buf, wrptr - buf);
519 sr_err("error setting sample config!");
526 /* The run state is read from FPGA registers 1[hi-byte] and 0[lo-byte]
527 * and the bits are interpreted as follows:
531 * bit1 1= writing to sdram
532 * bit2 0= waiting_for_trigger 1=been_triggered
533 * bit3 0= pretrigger_sampling 1=posttrigger_sampling
536 * meaning of bits unknown (but vendor software reads this, so just do the same)
538 * The run state values occur in this order:
539 * 0x85E2: pre-sampling (for samples before trigger position, capture ratio > 0%)
540 * 0x85EA: pre-sampling complete, now waiting for trigger (whilst sampling continuously)
544 static uint16_t run_state(const struct sr_dev_inst *sdi)
547 static uint16_t previous_state=0;
550 if ((ret = ctrl_in(sdi, CMD_FPGA_SPI, REG_RUN, 0, &state, sizeof(state))) != SR_OK) {
551 sr_err("failed to read run state!");
555 /* This function is called about every 50ms.
556 * To avoid filling the log file with redundant information during long captures,
557 * just print a log message if status has changed.
560 if(state != previous_state) {
561 previous_state = state;
562 if((state & 0x0003)==1) {
563 sr_dbg("run_state: 0x%04x (%s)", state, "idle");
565 else if((state & 0x000f)==2) {
566 sr_dbg("run_state: 0x%04x (%s)", state, "pre-trigger sampling");
568 else if((state & 0x000f)==0x0a) {
569 sr_dbg("run_state: 0x%04x (%s)", state, "sampling, waiting for trigger");
571 else if((state & 0x000f)==0x0e) {
572 sr_dbg("run_state: 0x%04x (%s)", state, "post-trigger sampling");
575 sr_dbg("run_state: 0x%04x", state);
582 static int set_run_mode(const struct sr_dev_inst *sdi, uint8_t fast_blinking)
586 if ((ret = ctrl_out(sdi, CMD_FPGA_SPI, REG_RUN, 0, &fast_blinking, sizeof(fast_blinking))) != SR_OK) {
587 sr_err("failed to send set-run-mode command %d", fast_blinking);
594 static int get_capture_info(const struct sr_dev_inst *sdi)
596 struct dev_context *devc;
598 uint8_t buf[3 * sizeof(uint32_t)];
599 const uint8_t *rdptr;
603 if ((ret = ctrl_in(sdi, CMD_FPGA_SPI, REG_SAMPLING, 0, buf, sizeof(buf))) != SR_OK) {
604 sr_err("failed to read capture info!");
609 devc->info.n_rep_packets = read_u32le_inc(&rdptr);
610 devc->info.n_rep_packets_before_trigger = read_u32le_inc(&rdptr);
611 devc->info.write_pos = read_u32le_inc(&rdptr);
613 sr_dbg("capture info: n_rep_packets: 0x%08x/%d, before_trigger: 0x%08x/%d, write_pos: 0x%08x%d",
614 devc->info.n_rep_packets, devc->info.n_rep_packets,
615 devc->info.n_rep_packets_before_trigger, devc->info.n_rep_packets_before_trigger,
616 devc->info.write_pos, devc->info.write_pos);
618 if (devc->info.n_rep_packets % 5)
619 sr_warn("number of packets is not as expected multiples of 5: %d", devc->info.n_rep_packets);
624 SR_PRIV int la2016_upload_firmware(struct sr_context *sr_ctx, libusb_device *dev, uint16_t product_id)
627 snprintf(fw_file, sizeof(fw_file) - 1, UC_FIRMWARE, product_id);
628 return ezusb_upload_firmware(sr_ctx, dev, USB_CONFIGURATION, fw_file);
631 SR_PRIV int la2016_setup_acquisition(const struct sr_dev_inst *sdi)
633 struct dev_context *devc;
639 ret = set_threshold_voltage(sdi, devc->threshold_voltage);
644 if ((ret = ctrl_out(sdi, CMD_FPGA_SPI, REG_CAPT_MODE, 0, &cmd, sizeof(cmd))) != SR_OK) {
645 sr_err("failed to send stop sampling command");
649 ret = set_trigger_config(sdi);
653 ret = set_sample_config(sdi);
660 SR_PRIV int la2016_start_acquisition(const struct sr_dev_inst *sdi)
662 return set_run_mode(sdi, 3);
665 SR_PRIV int la2016_stop_acquisition(const struct sr_dev_inst *sdi)
667 return set_run_mode(sdi, 0);
670 SR_PRIV int la2016_abort_acquisition(const struct sr_dev_inst *sdi)
672 return la2016_stop_acquisition(sdi);
675 SR_PRIV int la2016_has_triggered(const struct sr_dev_inst *sdi)
679 state = run_state(sdi);
681 return (state & 0x3) == 1;
684 SR_PRIV int la2016_start_retrieval(const struct sr_dev_inst *sdi, libusb_transfer_cb_fn cb)
686 struct dev_context *devc;
687 struct sr_usb_dev_inst *usb;
689 uint8_t wrbuf[2 * sizeof(uint32_t)];
697 if ((ret = get_capture_info(sdi)) != SR_OK)
700 devc->n_transfer_packets_to_read = devc->info.n_rep_packets / NUM_PACKETS_IN_CHUNK;
701 devc->n_bytes_to_read = devc->n_transfer_packets_to_read * TRANSFER_PACKET_LENGTH;
702 devc->read_pos = devc->info.write_pos - devc->n_bytes_to_read;
703 devc->n_reps_until_trigger = devc->info.n_rep_packets_before_trigger;
705 sr_dbg("want to read %d tfer-packets starting from pos %d",
706 devc->n_transfer_packets_to_read, devc->read_pos);
708 if ((ret = ctrl_out(sdi, CMD_BULK_RESET, 0x00, 0, NULL, 0)) != SR_OK) {
709 sr_err("failed to reset bulk state");
712 sr_dbg("will read from 0x%08x, 0x%08x bytes", devc->read_pos, devc->n_bytes_to_read);
714 write_u32le_inc(&wrptr, devc->read_pos);
715 write_u32le_inc(&wrptr, devc->n_bytes_to_read);
716 if ((ret = ctrl_out(sdi, CMD_FPGA_SPI, REG_BULK, 0, wrbuf, wrptr - wrbuf)) != SR_OK) {
717 sr_err("failed to send bulk config");
720 if ((ret = ctrl_out(sdi, CMD_BULK_START, 0x00, 0, NULL, 0)) != SR_OK) {
721 sr_err("failed to unblock bulk transfers");
725 to_read = devc->n_bytes_to_read;
726 if (to_read > LA2016_BULK_MAX)
727 to_read = LA2016_BULK_MAX;
729 buffer = g_try_malloc(to_read);
731 sr_err("Failed to allocate %d bytes for bulk transfer", to_read);
732 return SR_ERR_MALLOC;
735 devc->transfer = libusb_alloc_transfer(0);
736 libusb_fill_bulk_transfer(
737 devc->transfer, usb->devhdl,
738 0x86, buffer, to_read,
739 cb, (void *)sdi, DEFAULT_TIMEOUT_MS);
741 if ((ret = libusb_submit_transfer(devc->transfer)) != 0) {
742 sr_err("Failed to submit transfer: %s.", libusb_error_name(ret));
743 libusb_free_transfer(devc->transfer);
744 devc->transfer = NULL;
752 SR_PRIV int la2016_init_device(const struct sr_dev_inst *sdi)
754 struct dev_context *devc;
757 int16_t purchase_date_bcd[2];
763 /* Four bytes of eeprom at 0x20 are purchase year & month in BCD format, with 16bit
764 * complemented checksum; e.g. 2004DFFB = 2020-April.
765 * This helps to identify the age of devices if unknown magic numbers occur.
767 if ((ret = ctrl_in(sdi, CMD_EEPROM, 0x20, 0, purchase_date_bcd, sizeof(purchase_date_bcd))) != SR_OK) {
768 sr_err("failed to read eeprom purchase_date_bcd");
771 sr_dbg("purchase date: 20%02hx-%02hx", (purchase_date_bcd[0]) & 0x00ff, (purchase_date_bcd[0] >> 8) & 0x00ff);
772 if( purchase_date_bcd[0] != (0x0ffff & ~purchase_date_bcd[1]) ) {
773 sr_err("purchase date: checksum failure");
778 * There are four known kingst logic analyser devices which use this same usb vid and pid:
779 * LA2016, LA1016 and the older revision of each of these. They all use the same hardware
780 * and the same FX2 mcu firmware but each requires a different fpga bitstream. They are
781 * differentiated by a 'magic' byte within the 8 bytes of EEPROM from address 0x08.
792 * It seems that only these magic bytes are used, other bytes shown above are 'don't care'.
793 * Changing the magic byte on newer device to older magic causes OEM software to load
794 * the older fpga bitstream. The device then functions but has channels out of order.
795 * It's likely the bitstreams were changed to move input channel pins due to PCB changes.
797 * magic 9 == LA1016a using "kingst-la1016a1-fpga.bitstream" (latest v1.3.0 PCB, perhaps others)
798 * magic 8 == LA2016a using "kingst-la2016a1-fpga.bitstream" (latest v1.3.0 PCB, perhaps others)
799 * magic 3 == LA1016 using "kingst-la1016-fpga.bitstream"
800 * magic 2 == LA2016 using "kingst-la2016-fpga.bitstream"
802 * This was all determined by altering the eeprom contents of an LA2016 and LA1016 and observing
803 * the vendor software actions, either raising errors or loading specific bitstreams.
806 * An LA1016 cannot be converted to an LA2016 by changing the magic number - the bitstream
807 * will not authenticate with ic U10, which has different security coding for each device type.
810 if ((ret = ctrl_in(sdi, CMD_EEPROM, 0x08, 0, &buf, sizeof(buf))) != SR_OK) {
811 sr_err("failed to read eeprom device identifier bytes");
816 if (buf[0] == (0x0ff & ~buf[1])) {
817 /* primary copy of magic passes complement check */
820 else if (buf[4] == (0x0ff & ~buf[5])) {
821 /* backup copy of magic passes complement check */
822 sr_dbg("device_type: using backup copy of magic number");
826 sr_dbg("device_type: magic number is %hhu", magic);
828 /* select the correct fpga bitstream for this device */
831 ret = upload_fpga_bitstream(sdi, FPGA_FW_LA2016);
832 devc->max_samplerate = MAX_SAMPLE_RATE_LA2016;
835 ret = upload_fpga_bitstream(sdi, FPGA_FW_LA1016);
836 devc->max_samplerate = MAX_SAMPLE_RATE_LA1016;
839 ret = upload_fpga_bitstream(sdi, FPGA_FW_LA2016A);
840 devc->max_samplerate = MAX_SAMPLE_RATE_LA2016;
843 ret = upload_fpga_bitstream(sdi, FPGA_FW_LA1016A);
844 devc->max_samplerate = MAX_SAMPLE_RATE_LA1016;
847 sr_err("device_type: device not supported; magic number indicates this is not a LA2016 or LA1016");
852 sr_err("failed to upload fpga bitstream");
856 state = run_state(sdi);
857 if (state != 0x85e9) {
858 sr_warn("expect run state to be 0x85e9, but it reads 0x%04x", state);
861 if ((ret = ctrl_out(sdi, CMD_BULK_RESET, 0x00, 0, NULL, 0)) != SR_OK) {
862 sr_err("failed to send CMD_BULK_RESET");
866 sr_dbg("device should be initialized");
868 return set_defaults(sdi);
871 SR_PRIV int la2016_deinit_device(const struct sr_dev_inst *sdi)
875 if ((ret = ctrl_out(sdi, CMD_FPGA_ENABLE, 0x00, 0, NULL, 0)) != SR_OK) {
876 sr_err("failed to send deinit command");