2 * This file is part of the libsigrok project.
4 * Copyright (C) 2015 Daniel Elstner <daniel.kitta@gmail.com>
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 /* Number of logic channels.
26 #define NUM_CHANNELS 16
28 /* Unit size for the sigrok logic datafeed.
30 #define UNIT_SIZE ((NUM_CHANNELS + 7) / 8)
32 /* Size of the acquisition buffer in device memory units.
34 #define MEMORY_DEPTH (256 * 1024) /* 256k x 32 bit */
36 /* Capture memory read start address.
38 #define READ_START_ADDR 2
40 /* Number of device memory units (32 bit) to read at a time.
42 #define READ_CHUNK_LEN 250
44 /** LWLA1016 register addresses.
47 REG_CHAN_MASK = 0x1000, /* bit mask of enabled channels */
49 REG_DURATION = 0x1010, /* capture duration in ms */
51 REG_MEM_WR_PTR = 0x1070,
52 REG_MEM_RD_PTR = 0x1074,
53 REG_MEM_DATA = 0x1078,
54 REG_MEM_CTRL = 0x107C,
56 REG_CAP_COUNT = 0x10B0,
58 REG_TEST_ID = 0x10B4, /* read */
59 REG_TRG_SEL = 0x10B4, /* write */
61 REG_CAP_CTRL = 0x10B8,
63 REG_CAP_TOTAL = 0x10BC, /* read */
64 REG_DIV_COUNT = 0x10BC, /* write */
67 /** Flag bits for REG_MEM_CTRL.
70 MEM_CTRL_RESET = 1 << 0,
71 MEM_CTRL_WRITE = 1 << 1,
74 /** Flag bits for REG_CAP_CTRL.
77 CAP_CTRL_FIFO32_FULL = 1 << 0, /* "fifo32_ful" bit */
78 CAP_CTRL_FIFO64_FULL = 1 << 1, /* "fifo64_ful" bit */
79 CAP_CTRL_TRG_EN = 1 << 2, /* "trg_en" bit */
80 CAP_CTRL_CLR_TIMEBASE = 1 << 3, /* "do_clr_timebase" bit */
81 CAP_CTRL_FIFO_EMPTY = 1 << 4, /* "fifo_empty" bit */
82 CAP_CTRL_SAMPLE_EN = 1 << 5, /* "sample_en" bit */
83 CAP_CTRL_CNTR_NOT_ENDR = 1 << 6, /* "cntr_not_endr" bit */
86 /* Available FPGA configurations.
89 FPGA_100 = 0, /* 100 MS/s, no compression */
90 FPGA_100_TS, /* 100 MS/s, timing-state mode */
93 /* FPGA bitstream resource filenames.
95 static const char bitstream_map[][32] = {
96 [FPGA_100] = "sysclk-lwla1016-100.rbf",
97 [FPGA_100_TS] = "sysclk-lwla1016-100-ts.rbf",
100 /* Demangle incoming sample data from the transfer buffer.
102 static void read_response(struct acquisition_state *acq)
104 uint32_t *in_p, *out_p;
105 unsigned int words_left, num_words;
106 unsigned int max_samples, run_samples;
109 words_left = MIN(acq->mem_addr_next, acq->mem_addr_stop)
110 - acq->mem_addr_done;
111 /* Calculate number of samples to write into packet. */
112 max_samples = MIN(acq->samples_max - acq->samples_done,
113 PACKET_SIZE / UNIT_SIZE - acq->out_index);
114 run_samples = MIN(max_samples, 2 * words_left);
116 /* Round up in case the samples limit is an odd number. */
117 num_words = (run_samples + 1) / 2;
119 * Without RLE the output index will always be a multiple of two
120 * samples (at least before reaching the samples limit), thus 32-bit
121 * alignment is guaranteed.
123 out_p = (uint32_t *)&acq->out_packet[acq->out_index * UNIT_SIZE];
124 in_p = &acq->xfer_buf_in[acq->in_index];
126 * Transfer two samples at a time, taking care to swap the 16-bit
127 * halves of each input word but keeping the samples themselves in
128 * the original Little Endian order.
130 for (i = 0; i < num_words; i++)
131 out_p[i] = LROTATE(in_p[i], 16);
133 acq->in_index += num_words;
134 acq->mem_addr_done += num_words;
135 acq->out_index += run_samples;
136 acq->samples_done += run_samples;
139 /* Demangle and decompress incoming sample data from the transfer buffer.
141 static void read_response_rle(struct acquisition_state *acq)
145 unsigned int words_left;
146 unsigned int max_samples, run_samples;
151 words_left = MIN(acq->mem_addr_next, acq->mem_addr_stop)
152 - acq->mem_addr_done;
153 in_p = &acq->xfer_buf_in[acq->in_index];
155 for (wi = 0;; wi++) {
156 /* Calculate number of samples to write into packet. */
157 max_samples = MIN(acq->samples_max - acq->samples_done,
158 PACKET_SIZE / UNIT_SIZE - acq->out_index);
159 run_samples = MIN(max_samples, acq->run_len);
161 /* Expand run-length samples into session packet. */
162 sample = GUINT16_TO_LE(acq->sample);
163 out_p = &((uint16_t *)acq->out_packet)[acq->out_index];
165 for (ri = 0; ri < run_samples; ri++)
168 acq->run_len -= run_samples;
169 acq->out_index += run_samples;
170 acq->samples_done += run_samples;
172 if (run_samples == max_samples)
173 break; /* packet full or sample limit reached */
174 if (wi >= words_left)
175 break; /* done with current transfer */
177 word = GUINT32_FROM_LE(in_p[wi]);
178 acq->sample = word >> 16;
179 acq->run_len = (word & 0xFFFF) + 1;
182 acq->mem_addr_done += wi;
185 /* Check whether we can receive responses of more than 64 bytes.
186 * The FX2 firmware of the LWLA1016 has a bug in the reset logic which
187 * sometimes causes the response endpoint to be limited to transfers of
188 * 64 bytes at a time, instead of the expected 2*512 bytes. The problem
189 * can be worked around by never requesting more than 64 bytes.
190 * This quirk manifests itself only under certain conditions, and some
191 * users seem to see it more frequently than others. Detect it here in
192 * order to avoid paying the penalty unnecessarily.
194 static int test_read_memory(const struct sr_dev_inst *sdi,
195 unsigned int start, unsigned int count)
197 struct dev_context *devc;
198 struct sr_usb_dev_inst *usb;
203 unsigned char reply[512];
208 command[0] = LWLA_WORD(CMD_READ_MEM32);
209 command[1] = LWLA_WORD_0(start);
210 command[2] = LWLA_WORD_1(start);
211 command[3] = LWLA_WORD_0(count);
212 command[4] = LWLA_WORD_1(count);
214 ret = lwla_send_command(usb, command, ARRAY_SIZE(command));
218 ret = lwla_receive_reply(usb, reply, sizeof(reply), &xfer_len);
222 devc->short_transfer_quirk = (xfer_len == 64);
224 for (i = xfer_len; i < 4 * count && xfer_len == 64; i += xfer_len) {
225 ret = lwla_receive_reply(usb, reply, sizeof(reply), &xfer_len);
229 if (i != 4 * count) {
230 sr_err("Invalid read response of unexpected length %d.",
237 /* Select and transfer FPGA bitstream for the current configuration.
239 static int apply_fpga_config(const struct sr_dev_inst *sdi)
241 struct dev_context *devc;
242 struct drv_context *drvc;
247 drvc = sdi->driver->context;
249 if (sdi->status == SR_ST_INACTIVE)
250 return SR_OK; /* the LWLA1016 has no off state */
252 config = (devc->cfg_rle) ? FPGA_100_TS : FPGA_100;
254 if (config == devc->active_fpga_config)
255 return SR_OK; /* no change */
257 ret = lwla_send_bitstream(drvc->sr_ctx, sdi->conn,
258 bitstream_map[config]);
259 devc->active_fpga_config = (ret == SR_OK) ? config : FPGA_NOCONF;
264 /* Perform initialization self test.
266 static int device_init_check(const struct sr_dev_inst *sdi)
268 static const struct regval mem_reset[] = {
269 {REG_MEM_CTRL, MEM_CTRL_RESET},
275 const unsigned int test_count = 24;
277 lwla_read_reg(sdi->conn, REG_TEST_ID, &value);
279 /* Ignore the value returned by the first read. */
280 ret = lwla_read_reg(sdi->conn, REG_TEST_ID, &value);
284 if (value != 0x12345678) {
285 sr_err("Received invalid test word 0x%08X.", value);
289 ret = lwla_write_regs(sdi->conn, mem_reset, ARRAY_SIZE(mem_reset));
293 ret = test_read_memory(sdi, 0, test_count);
297 * Issue another read request or the device will stall, for whatever
298 * reason. This happens both with and without the short transfer quirk.
300 return test_read_memory(sdi, test_count, test_count);
303 static int setup_acquisition(const struct sr_dev_inst *sdi)
305 static const struct regval capture_init[] = {
308 {REG_MEM_CTRL, MEM_CTRL_RESET},
310 {REG_MEM_CTRL, MEM_CTRL_WRITE},
311 {REG_CAP_CTRL, CAP_CTRL_FIFO32_FULL | CAP_CTRL_FIFO64_FULL},
312 {REG_CAP_CTRL, CAP_CTRL_FIFO_EMPTY},
314 {REG_CAP_COUNT, MEMORY_DEPTH - 5},
316 struct dev_context *devc;
317 struct sr_usb_dev_inst *usb;
318 uint32_t divider_count, trigger_setup;
324 ret = lwla_write_reg(usb, REG_CHAN_MASK, devc->channel_mask);
328 if (devc->samplerate > 0 && devc->samplerate < SR_MHZ(100))
329 divider_count = SR_MHZ(100) / devc->samplerate - 1;
333 ret = lwla_write_reg(usb, REG_DIV_COUNT, divider_count);
337 ret = lwla_write_regs(usb, capture_init, ARRAY_SIZE(capture_init));
341 trigger_setup = ((devc->trigger_edge_mask & 0xFFFF) << 16)
342 | (devc->trigger_values & 0xFFFF);
344 return lwla_write_reg(usb, REG_TRG_SEL, trigger_setup);
347 static int prepare_request(const struct sr_dev_inst *sdi)
349 struct dev_context *devc;
350 struct acquisition_state *acq;
351 unsigned int chunk_len, count;
354 acq = devc->acquisition;
356 acq->xfer_out->length = 0;
357 acq->reg_seq_pos = 0;
358 acq->reg_seq_len = 0;
360 switch (devc->state) {
361 case STATE_START_CAPTURE:
362 lwla_queue_regval(acq, REG_CAP_CTRL, CAP_CTRL_TRG_EN
363 | ((devc->trigger_mask & 0xFFFF) << 16));
365 case STATE_STOP_CAPTURE:
366 lwla_queue_regval(acq, REG_CAP_CTRL, 0);
367 lwla_queue_regval(acq, REG_DIV_COUNT, 0);
369 case STATE_READ_PREPARE:
370 lwla_queue_regval(acq, REG_MEM_CTRL, 0);
372 case STATE_READ_FINISH:
373 lwla_queue_regval(acq, REG_MEM_CTRL, MEM_CTRL_RESET);
374 lwla_queue_regval(acq, REG_MEM_CTRL, 0);
376 case STATE_STATUS_REQUEST:
377 lwla_queue_regval(acq, REG_CAP_CTRL, 0);
378 lwla_queue_regval(acq, REG_MEM_WR_PTR, 0);
379 lwla_queue_regval(acq, REG_DURATION, 0);
381 case STATE_LENGTH_REQUEST:
382 lwla_queue_regval(acq, REG_CAP_COUNT, 0);
384 case STATE_READ_REQUEST:
385 /* Limit reads to 16 device words (64 bytes) at a time if the
386 * device firmware has the short transfer quirk. */
387 chunk_len = (devc->short_transfer_quirk) ? 16 : READ_CHUNK_LEN;
388 count = MIN(chunk_len, acq->mem_addr_stop - acq->mem_addr_next);
390 acq->xfer_buf_out[0] = LWLA_WORD(CMD_READ_MEM32);
391 acq->xfer_buf_out[1] = LWLA_WORD_0(acq->mem_addr_next);
392 acq->xfer_buf_out[2] = LWLA_WORD_1(acq->mem_addr_next);
393 acq->xfer_buf_out[3] = LWLA_WORD_0(count);
394 acq->xfer_buf_out[4] = LWLA_WORD_1(count);
395 acq->xfer_out->length = 5 * sizeof(acq->xfer_buf_out[0]);
397 acq->mem_addr_next += count;
400 sr_err("BUG: unhandled request state %d.", devc->state);
407 static int handle_response(const struct sr_dev_inst *sdi)
409 struct dev_context *devc;
410 struct acquisition_state *acq;
414 acq = devc->acquisition;
416 switch (devc->state) {
417 case STATE_STATUS_REQUEST:
418 acq->status = acq->reg_sequence[0].val & 0x7F;
419 acq->mem_addr_fill = acq->reg_sequence[1].val;
420 acq->duration_now = acq->reg_sequence[2].val;
422 case STATE_LENGTH_REQUEST:
423 acq->mem_addr_next = READ_START_ADDR;
424 acq->mem_addr_stop = acq->reg_sequence[0].val + READ_START_ADDR - 1;
426 case STATE_READ_REQUEST:
427 expect_len = (acq->mem_addr_next - acq->mem_addr_done
428 + acq->in_index) * sizeof(acq->xfer_buf_in[0]);
429 if (acq->xfer_in->actual_length != expect_len) {
430 sr_err("Received size %d does not match expected size %d.",
431 acq->xfer_in->actual_length, expect_len);
432 devc->transfer_error = TRUE;
435 if (acq->rle_enabled)
436 read_response_rle(acq);
441 sr_err("BUG: unhandled response state %d.", devc->state);
448 /* Model descriptor for the LWLA1016.
450 SR_PRIV const struct model_info lwla1016_info = {
452 .num_channels = NUM_CHANNELS,
456 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
457 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
458 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
459 SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
460 SR_CONF_RLE | SR_CONF_GET | SR_CONF_SET,
462 .num_samplerates = 19,
465 SR_MHZ(50), SR_MHZ(20), SR_MHZ(10),
466 SR_MHZ(5), SR_MHZ(2), SR_MHZ(1),
467 SR_KHZ(500), SR_KHZ(200), SR_KHZ(100),
468 SR_KHZ(50), SR_KHZ(20), SR_KHZ(10),
469 SR_KHZ(5), SR_KHZ(2), SR_KHZ(1),
470 SR_HZ(500), SR_HZ(200), SR_HZ(100),
473 .apply_fpga_config = &apply_fpga_config,
474 .device_init_check = &device_init_check,
475 .setup_acquisition = &setup_acquisition,
477 .prepare_request = &prepare_request,
478 .handle_response = &handle_response,