2 * This file is part of the libsigrok project.
4 * Copyright (C) 2013 Marcus Comstedt <marcus@mc.pp.se>
5 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
6 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
8 * This program is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation, either version 3 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
27 #include <glib/gstdio.h>
31 #include "libsigrok.h"
32 #include "libsigrok-internal.h"
34 #define FPGA_FIRMWARE_18 FIRMWARE_DIR"/saleae-logic16-fpga-18.bitstream"
35 #define FPGA_FIRMWARE_33 FIRMWARE_DIR"/saleae-logic16-fpga-33.bitstream"
37 #define MAX_SAMPLE_RATE SR_MHZ(100)
38 #define MAX_4CH_SAMPLE_RATE SR_MHZ(50)
39 #define MAX_7CH_SAMPLE_RATE SR_MHZ(40)
40 #define MAX_8CH_SAMPLE_RATE SR_MHZ(32)
41 #define MAX_10CH_SAMPLE_RATE SR_MHZ(25)
42 #define MAX_13CH_SAMPLE_RATE SR_MHZ(16)
44 #define BASE_CLOCK_0_FREQ SR_MHZ(100)
45 #define BASE_CLOCK_1_FREQ SR_MHZ(160)
47 #define COMMAND_START_ACQUISITION 1
48 #define COMMAND_ABORT_ACQUISITION_ASYNC 2
49 #define COMMAND_WRITE_EEPROM 6
50 #define COMMAND_READ_EEPROM 7
51 #define COMMAND_WRITE_LED_TABLE 0x7a
52 #define COMMAND_SET_LED_MODE 0x7b
53 #define COMMAND_RETURN_TO_BOOTLOADER 0x7c
54 #define COMMAND_ABORT_ACQUISITION_SYNC 0x7d
55 #define COMMAND_FPGA_UPLOAD_INIT 0x7e
56 #define COMMAND_FPGA_UPLOAD_SEND_DATA 0x7f
57 #define COMMAND_FPGA_WRITE_REGISTER 0x80
58 #define COMMAND_FPGA_READ_REGISTER 0x81
59 #define COMMAND_GET_REVID 0x82
61 #define WRITE_EEPROM_COOKIE1 0x42
62 #define WRITE_EEPROM_COOKIE2 0x55
63 #define READ_EEPROM_COOKIE1 0x33
64 #define READ_EEPROM_COOKIE2 0x81
65 #define ABORT_ACQUISITION_SYNC_PATTERN 0x55
67 #define MAX_EMPTY_TRANSFERS 64
70 static void encrypt(uint8_t *dest, const uint8_t *src, uint8_t cnt)
72 uint8_t state1 = 0x9b, state2 = 0x54;
75 for (i=0; i<cnt; i++) {
76 uint8_t t, v = src[i];
77 t = (((v ^ state2 ^ 0x2b) - 0x05) ^ 0x35) - 0x39;
78 t = (((t ^ state1 ^ 0x5a) - 0xb0) ^ 0x38) - 0x45;
84 static void decrypt(uint8_t *dest, const uint8_t *src, uint8_t cnt)
86 uint8_t state1 = 0x9b, state2 = 0x54;
88 for (i=0; i<cnt; i++) {
89 uint8_t t, v = src[i];
90 t = (((v + 0x45) ^ 0x38) + 0xb0) ^ 0x5a ^ state1;
91 t = (((t + 0x39) ^ 0x35) + 0x05) ^ 0x2b ^ state2;
97 static int do_ep1_command(const struct sr_dev_inst *sdi,
98 const uint8_t *command, uint8_t cmd_len,
99 uint8_t *reply, uint8_t reply_len)
102 struct sr_usb_dev_inst *usb;
107 if (cmd_len < 1 || cmd_len > 64 || reply_len > 64 ||
108 command == NULL || (reply_len > 0 && reply == NULL))
111 encrypt(buf, command, cmd_len);
113 ret = libusb_bulk_transfer(usb->devhdl, 1, buf, cmd_len, &xfer, 1000);
115 sr_dbg("Failed to send EP1 command 0x%02x: %s",
116 command[0], libusb_error_name(ret));
119 if (xfer != cmd_len) {
120 sr_dbg("Failed to send EP1 command 0x%02x: incorrect length %d != %d",
128 ret = libusb_bulk_transfer(usb->devhdl, 0x80 | 1, buf, reply_len, &xfer, 1000);
130 sr_dbg("Failed to receive reply to EP1 command 0x%02x: %s",
131 command[0], libusb_error_name(ret));
134 if (xfer != reply_len) {
135 sr_dbg("Failed to receive reply to EP1 command 0x%02x: incorrect length %d != %d",
140 decrypt(reply, buf, reply_len);
145 static int read_eeprom(const struct sr_dev_inst *sdi,
146 uint8_t address, uint8_t length, uint8_t *buf)
148 uint8_t command[5] = {
156 return do_ep1_command(sdi, command, 5, buf, length);
159 static int upload_led_table(const struct sr_dev_inst *sdi,
160 const uint8_t *table, uint8_t offset, uint8_t cnt)
165 if (cnt < 1 || cnt+offset > 64 || table == NULL)
169 uint8_t chunk = (cnt > 32? 32 : cnt);
171 command[0] = COMMAND_WRITE_LED_TABLE;
174 memcpy(command+3, table, chunk);
176 if ((ret = do_ep1_command(sdi, command, 3+chunk, NULL, 0)) != SR_OK)
187 static int set_led_mode(const struct sr_dev_inst *sdi,
188 uint8_t animate, uint16_t t2reload, uint8_t div,
191 uint8_t command[6] = {
192 COMMAND_SET_LED_MODE,
200 return do_ep1_command(sdi, command, 6, NULL, 0);
203 static int read_fpga_register(const struct sr_dev_inst *sdi,
204 uint8_t address, uint8_t *value)
206 uint8_t command[3] = {
207 COMMAND_FPGA_READ_REGISTER,
212 return do_ep1_command(sdi, command, 3, value, 1);
215 static int write_fpga_registers(const struct sr_dev_inst *sdi,
216 uint8_t (*regs)[2], uint8_t cnt)
221 if (cnt < 1 || cnt > 31)
224 command[0] = COMMAND_FPGA_WRITE_REGISTER;
226 for (i=0; i<cnt; i++) {
227 command[2+2*i] = regs[i][0];
228 command[3+2*i] = regs[i][1];
231 return do_ep1_command(sdi, command, 2*(cnt+1), NULL, 0);
234 static int write_fpga_register(const struct sr_dev_inst *sdi,
235 uint8_t address, uint8_t value)
237 uint8_t regs[2] = { address, value };
238 return write_fpga_registers(sdi, ®s, 1);
242 static uint8_t map_eeprom_data(uint8_t v)
244 return (((v ^ 0x80) + 0x44) ^ 0xd5) + 0x69;
247 static int prime_fpga(const struct sr_dev_inst *sdi)
249 uint8_t eeprom_data[16];
250 uint8_t old_reg_10, version;
251 uint8_t regs[8][2] = {
263 if ((ret = read_eeprom(sdi, 16, 16, eeprom_data)) != SR_OK)
266 if ((ret = read_fpga_register(sdi, 10, &old_reg_10)) != SR_OK)
269 regs[0][1] = (old_reg_10 &= 0x7f);
270 regs[1][1] |= old_reg_10;
271 regs[3][1] |= old_reg_10;
272 regs[4][1] |= old_reg_10;
274 for (i=0; i<16; i++) {
275 regs[2][1] = eeprom_data[i];
276 regs[5][1] = map_eeprom_data(eeprom_data[i]);
278 ret = write_fpga_registers(sdi, ®s[2], 6);
280 ret = write_fpga_registers(sdi, ®s[0], 8);
285 if ((ret = write_fpga_register(sdi, 10, old_reg_10)) != SR_OK)
288 if ((ret = read_fpga_register(sdi, 0, &version)) != SR_OK)
291 if (version != 0x10) {
292 sr_err("Invalid FPGA bitstream version: 0x%02x != 0x10", version);
299 static void make_heartbeat(uint8_t *table, int len)
303 memset(table, 0, len);
306 for (j=0; j<len; j++)
307 *table++ = sin(j*M_PI/len)*255;
310 static int configure_led(const struct sr_dev_inst *sdi)
315 make_heartbeat(table, 64);
316 if ((ret = upload_led_table(sdi, table, 0, 64)) != SR_OK)
319 return set_led_mode(sdi, 1, 6250, 0, 1);
322 static int upload_fpga_bitstream(const struct sr_dev_inst *sdi,
323 enum voltage_range vrange)
325 struct dev_context *devc;
326 int offset, chunksize, ret;
327 const char *filename;
329 unsigned char buf[256*62];
333 if (devc->cur_voltage_range == vrange)
337 case VOLTAGE_RANGE_18_33_V:
338 filename = FPGA_FIRMWARE_18;
340 case VOLTAGE_RANGE_5_V:
341 filename = FPGA_FIRMWARE_33;
344 sr_err("Unsupported voltage range");
348 sr_info("Uploading FPGA bitstream at %s", filename);
349 if ((fw = g_fopen(filename, "rb")) == NULL) {
350 sr_err("Unable to open bitstream file %s for reading: %s",
351 filename, strerror(errno));
355 buf[0] = COMMAND_FPGA_UPLOAD_INIT;
356 if ((ret = do_ep1_command(sdi, buf, 1, NULL, 0)) != SR_OK) {
362 chunksize = fread(buf, 1, sizeof(buf), fw);
366 for (offset = 0; offset < chunksize; offset += 62) {
368 uint8_t len = (offset + 62 > chunksize?
369 chunksize - offset : 62);
370 command[0] = COMMAND_FPGA_UPLOAD_SEND_DATA;
372 memcpy(command+2, buf+offset, len);
373 if ((ret = do_ep1_command(sdi, command, len+2, NULL, 0)) != SR_OK) {
379 sr_info("Uploaded %d bytes", chunksize);
382 sr_info("FPGA bitstream upload done");
384 if ((ret = prime_fpga(sdi)) != SR_OK)
387 if ((ret = configure_led(sdi)) != SR_OK)
390 devc->cur_voltage_range = vrange;
394 static int abort_acquisition_sync(const struct sr_dev_inst *sdi)
396 static const uint8_t command[2] = {
397 COMMAND_ABORT_ACQUISITION_SYNC,
398 ABORT_ACQUISITION_SYNC_PATTERN,
400 uint8_t reply, expected_reply;
403 if ((ret = do_ep1_command(sdi, command, 2, &reply, 1)) != SR_OK)
406 expected_reply = ~command[1];
407 if (reply != expected_reply) {
408 sr_err("Invalid response for abort acquisition command: "
409 "0x%02x != 0x%02x", reply, expected_reply);
416 SR_PRIV int saleae_logic16_setup_acquisition(const struct sr_dev_inst *sdi,
420 uint8_t clock_select, reg1, reg10;
422 int i, ret, nchan = 0;
423 struct dev_context *devc;
427 if (samplerate == 0 || samplerate > MAX_SAMPLE_RATE) {
428 sr_err("Unable to sample at %" PRIu64 "Hz.", samplerate);
432 if (BASE_CLOCK_0_FREQ % samplerate == 0 &&
433 (div = BASE_CLOCK_0_FREQ / samplerate) <= 256) {
435 } else if (BASE_CLOCK_1_FREQ % samplerate == 0 &&
436 (div = BASE_CLOCK_1_FREQ / samplerate) <= 256) {
439 sr_err("Unable to sample at %" PRIu64 "Hz.", samplerate);
444 if (channels & (1U<<i))
447 if ((nchan >= 13 && samplerate > MAX_13CH_SAMPLE_RATE) ||
448 (nchan >= 10 && samplerate > MAX_10CH_SAMPLE_RATE) ||
449 (nchan >= 8 && samplerate > MAX_8CH_SAMPLE_RATE) ||
450 (nchan >= 7 && samplerate > MAX_7CH_SAMPLE_RATE) ||
451 (nchan >= 4 && samplerate > MAX_4CH_SAMPLE_RATE)) {
452 sr_err("Unable to sample at %" PRIu64 "Hz "
453 "with this many channels.", samplerate);
457 if ((ret = upload_fpga_bitstream(sdi, devc->selected_voltage_range)) != SR_OK)
460 if ((ret = read_fpga_register(sdi, 1, ®1)) != SR_OK)
464 sr_dbg("Invalid state at acquisition setup: 0x%02x != 0x08", reg1);
468 if ((ret = write_fpga_register(sdi, 1, 0x40)) != SR_OK)
471 if ((ret = write_fpga_register(sdi, 10, clock_select)) != SR_OK)
474 if ((ret = write_fpga_register(sdi, 4, (uint8_t)(div-1))) != SR_OK)
477 if ((ret = write_fpga_register(sdi, 2, (uint8_t)(channels & 0xff))) != SR_OK)
480 if ((ret = write_fpga_register(sdi, 3, (uint8_t)(channels >> 8))) != SR_OK)
483 if ((ret = write_fpga_register(sdi, 1, 0x42)) != SR_OK)
486 if ((ret = write_fpga_register(sdi, 1, 0x40)) != SR_OK)
489 if ((ret = read_fpga_register(sdi, 1, ®1)) != SR_OK)
493 sr_dbg("Invalid state at acquisition setup: 0x%02x != 0x48", reg1);
497 if ((ret = read_fpga_register(sdi, 10, ®10)) != SR_OK)
500 if (reg10 != clock_select) {
501 sr_dbg("Invalid state at acquisition setup: 0x%02x != 0x%02x",
502 reg10, (unsigned)clock_select);
509 SR_PRIV int saleae_logic16_start_acquisition(const struct sr_dev_inst *sdi)
511 static const uint8_t command[1] = {
512 COMMAND_START_ACQUISITION,
516 if ((ret = do_ep1_command(sdi, command, 1, NULL, 0)) != SR_OK)
519 return write_fpga_register(sdi, 1, 0x41);
522 SR_PRIV int saleae_logic16_abort_acquisition(const struct sr_dev_inst *sdi)
524 static const uint8_t command[1] = {
525 COMMAND_ABORT_ACQUISITION_ASYNC,
528 uint8_t reg1, reg8, reg9;
530 if ((ret = do_ep1_command(sdi, command, 1, NULL, 0)) != SR_OK)
533 if ((ret = write_fpga_register(sdi, 1, 0x00)) != SR_OK)
536 if ((ret = read_fpga_register(sdi, 1, ®1)) != SR_OK)
540 sr_dbg("Invalid state at acquisition stop: 0x%02x != 0x08", reg1);
544 if ((ret = read_fpga_register(sdi, 8, ®8)) != SR_OK)
547 if ((ret = read_fpga_register(sdi, 9, ®9)) != SR_OK)
553 SR_PRIV int saleae_logic16_init_device(const struct sr_dev_inst *sdi)
555 struct dev_context *devc;
560 devc->cur_voltage_range = VOLTAGE_RANGE_UNKNOWN;
562 if ((ret = abort_acquisition_sync(sdi)) != SR_OK)
565 if ((ret = read_eeprom(sdi, 8, 8, devc->eeprom_data)) != SR_OK)
568 if ((ret = upload_fpga_bitstream(sdi, devc->selected_voltage_range)) != SR_OK)
574 static void finish_acquisition(struct dev_context *devc)
576 struct sr_datafeed_packet packet;
579 /* Terminate session. */
580 packet.type = SR_DF_END;
581 sr_session_send(devc->cb_data, &packet);
583 /* Remove fds from polling. */
584 if (devc->usbfd != NULL) {
585 for (i = 0; devc->usbfd[i] != -1; i++)
586 sr_source_remove(devc->usbfd[i]);
590 devc->num_transfers = 0;
591 g_free(devc->transfers);
592 g_free(devc->convbuffer);
595 static void free_transfer(struct libusb_transfer *transfer)
597 struct dev_context *devc;
600 devc = transfer->user_data;
602 g_free(transfer->buffer);
603 transfer->buffer = NULL;
604 libusb_free_transfer(transfer);
606 for (i = 0; i < devc->num_transfers; i++) {
607 if (devc->transfers[i] == transfer) {
608 devc->transfers[i] = NULL;
613 devc->submitted_transfers--;
614 if (devc->submitted_transfers == 0)
615 finish_acquisition(devc);
618 static void resubmit_transfer(struct libusb_transfer *transfer)
622 if ((ret = libusb_submit_transfer(transfer)) == LIBUSB_SUCCESS)
625 free_transfer(transfer);
626 /* TODO: Stop session? */
628 sr_err("%s: %s", __func__, libusb_error_name(ret));
631 static size_t convert_sample_data(struct dev_context *devc,
632 uint8_t *dest, size_t destcnt,
633 const uint8_t *src, size_t srccnt)
635 uint16_t *channel_data;
641 channel_data = devc->channel_data;
642 cur_channel = devc->cur_channel;
645 uint16_t sample, channel_mask;
647 sample = src[0] | (src[1] << 8);
650 channel_mask = devc->channel_masks[cur_channel];
652 for (i=15; i>=0; --i, sample >>= 1)
654 channel_data[i] |= channel_mask;
656 if (++cur_channel == devc->num_channels) {
658 if (destcnt < 16*2) {
659 sr_err("Conversion buffer too small!");
662 memcpy(dest, channel_data, 16*2);
663 memset(channel_data, 0, 16*2);
670 devc->cur_channel = cur_channel;
675 SR_PRIV void saleae_logic16_receive_transfer(struct libusb_transfer *transfer)
677 gboolean packet_has_error = FALSE;
678 struct sr_datafeed_packet packet;
679 struct sr_datafeed_logic logic;
680 struct dev_context *devc;
681 size_t converted_length;
683 devc = transfer->user_data;
686 * If acquisition has already ended, just free any queued up
687 * transfer that come in.
689 if (devc->num_samples < 0) {
690 free_transfer(transfer);
694 sr_info("receive_transfer(): status %d received %d bytes.",
695 transfer->status, transfer->actual_length);
697 switch (transfer->status) {
698 case LIBUSB_TRANSFER_NO_DEVICE:
699 devc->num_samples = -2;
700 free_transfer(transfer);
702 case LIBUSB_TRANSFER_COMPLETED:
703 case LIBUSB_TRANSFER_TIMED_OUT: /* We may have received some data though. */
706 packet_has_error = TRUE;
710 if (transfer->actual_length & 1) {
711 sr_err("Got an odd number of bytes from the device. This should not happen.");
712 /* Bail out right away */
713 packet_has_error = TRUE;
714 devc->empty_transfer_count = MAX_EMPTY_TRANSFERS;
717 if (transfer->actual_length == 0 || packet_has_error) {
718 devc->empty_transfer_count++;
719 if (devc->empty_transfer_count > MAX_EMPTY_TRANSFERS) {
721 * The FX2 gave up. End the acquisition, the frontend
722 * will work out that the samplecount is short.
724 devc->num_samples = -2;
725 free_transfer(transfer);
727 resubmit_transfer(transfer);
731 devc->empty_transfer_count = 0;
735 convert_sample_data(devc,
736 devc->convbuffer, devc->convbuffer_size,
737 transfer->buffer, transfer->actual_length);
739 if (converted_length > 0) {
740 /* Send the incoming transfer to the session bus. */
741 packet.type = SR_DF_LOGIC;
742 packet.payload = &logic;
743 logic.length = converted_length;
745 logic.data = devc->convbuffer;
746 sr_session_send(devc->cb_data, &packet);
748 devc->num_samples += converted_length / 2;
749 if (devc->limit_samples &&
750 (uint64_t)devc->num_samples > devc->limit_samples) {
751 devc->num_samples = -2;
752 free_transfer(transfer);
757 resubmit_transfer(transfer);